-
Notifications
You must be signed in to change notification settings - Fork 0
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: Adding fern python documentation #100
base: main
Are you sure you want to change the base?
Conversation
e850014
to
5e595d7
Compare
65fbe90
to
2619c60
Compare
2619c60
to
85c74a3
Compare
27a3d57
to
f993f16
Compare
f993f16
to
0ae6f7d
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice. For sake of uniformity with the other examples I would pass cli arguments instead of env variables but this way works too.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added several comments.
Also, the source code of the package is under compass_sdk_examples
(which is the name of the package), so I would move the fern_documentation
folder under it.
5b7e779
to
80ed1cd
Compare
80ed1cd
to
d9b6825
Compare
Super valuable work here @ankush-cohere - thank you for putting in the work for all these examples!! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A few suggestions - but wouldn't block! Would like to hear if there's a good reason on the os.getenv usage though.
4cfa57b
7fade43
to
4cfa57b
Compare
4172cad
to
843bcaf
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice changes, ty!
This PR introduces new Python scripts for various operations related to the Compass SDK. The scripts are added to the
examples/fern_documentation/python/core
directory and cover a range of functionalities, including creating and deleting indexes, searching documents, and managing document assets.Changes:
add_metadata.py
: Adds metadata to documents using theCompassClient
andDocumentAttributes
classes.create_index.py
: Creates a new index using theCompassClient
class.delete_doc.py
: Deletes a document using theCompassClient
class.delete_index.py
: Deletes an index using theCompassClient
class.direct_search_index.py
: Performs a direct search within an index, returning a list ofRetrievedChunkExtended
objects.get_doc_asset.py
: Retrieves a document asset using theCompassClient
class.get_document.py
: Retrieves a document using theCompassClient
class.list_index.py
: Lists all indexes and their details using theCompassClient
class.put_doc_into_index.py
: Inserts documents into an index using theCompassClient
andCompassParserClient
classes.refresh_index.py
: Refreshes an index using theCompassClient
class.search_chunks.py
: Searches for chunks within an index using theCompassClient
class.search_doc.py
: Searches for documents within an index using theCompassClient
class.update_group_auth.py
: Updates group authorization for documents using theCompassClient
andGroupAuthorizationInput
classes.upload_files.py
: Uploads files to an index using theCompassClient
andDocumentAttributes
classes.import argparse
statement insearch_documents.py
is now indented.