Package: trieve_python_client
trieve-python-clientTrieve REST API OpenAPI DocumentationThis Python package is automatically generated by theOpenAPI Generatorproject:API version: 1.0.0Package version: 1.0.0Build package: org.openapitools.codegen.languages.PythonClientCodegenRequirements.Python 3.7+Installation & Usagepip installIf the python package is hosted on a repository, you can install directly using:pipinstallgit+https://github.com/GIT_USER_ID/GIT_REPO_ID.git(you may need to runpipwith root permission:sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)Then import the package:importtrieve_python_clientSetuptoolsInstall viaSetuptools.pythonsetup.pyinstall--user(orsudo python setup.py installto install the package for all users)Then import the package:importtrieve_python_clientTestsExecutepytestto run the tests.Getting StartedPlease follow theinstallation procedureand then run the following:importtrieve_python_clientfromtrieve_python_client.restimportApiExceptionfrompprintimportpprint# Defining the host is optional and defaults to http://localhost# See configuration.py for a list of all supported configuration parameters.configuration=trieve_python_client.Configuration(host="http://localhost")# Enter a context with an instance of the API clientwithtrieve_python_client.ApiClient(configuration)asapi_client:# Create an instance of the API classapi_instance=trieve_python_client.AuthApi(api_client)try:# openid_callbackapi_response=api_instance.callback()print("The response of AuthApi->callback:\n")pprint(api_response)exceptApiExceptionase:print("Exception when calling AuthApi->callback:%s\n"%e)Documentation for API EndpointsAll URIs are relative tohttp://localhostClassMethodHTTP requestDescriptionAuthApicallbackGET/api/auth/callbackopenid_callbackAuthApiget_meGET/api/auth/meget_meAuthApiloginGET/api/authloginAuthApilogoutDELETE/api/authlogoutChunkApicreate_chunkPOST/api/chunkcreate_chunkChunkApicreate_suggested_queries_handlerPOST/api/chunk/gen_suggestionsget_suggested_queriesChunkApidelete_chunkDELETE/api/chunk/{chunk_id}delete_chunkChunkApidelete_chunk_by_tracking_idDELETE/api/chunk/tracking_id/{tracking_id}delete_chunk_by_tracking_idChunkApigenerate_off_chunksPOST/api/chunk/generategenerate_off_chunksChunkApiget_chunk_by_idGET/api/chunk/{chunk_id}get_chunkChunkApiget_chunk_by_tracking_idGET/api/chunk/tracking_id/{tracking_id}get_chunk_by_tracking_idChunkApiget_recommended_chunksPOST/api/chunk/recommendget_recommended_chunksChunkApisearch_chunkPOST/api/chunk/searchsearchChunkApiupdate_chunkPUT/api/chunk/updateupdate_chunkChunkApiupdate_chunk_by_tracking_idPUT/api/chunk/tracking_id/updateupdate_chunk_by_tracking_idChunkCollectionApiadd_bookmarkPOST/api/chunk_collection/{collection_id}add_bookmarkChunkCollectionApicreate_chunk_collectionPOST/api/chunk_collectioncreate_chunk_collectionChunkCollectionApidelete_bookmarkDELETE/api/bookmark/{collection_id}/{bookmark_id}delete_bookmarkChunkCollectionApidelete_chunk_collectionDELETE/api/chunk_collection/{collection_id}delete_chunk_collectionChunkCollectionApiget_all_bookmarksGET/api/chunk_collection/{collection_id}/{page}get_all_bookmarksChunkCollectionApiget_collections_chunk_is_inPOST/api/chunk_collection/bookmarkChunkCollectionApiget_logged_in_user_chunk_collectionsGET/api/chunk_collection/{page}get_current_user_collectionsChunkCollectionApiget_specific_user_chunk_collectionsGET/api/user/collections/{user_id}/{page}get_user_collectionsChunkCollectionApisearch_collectionsPOST/api/chunk_collection/searchcollection_searchChunkCollectionApiupdate_chunk_collectionPUT/api/chunk_collectionupdate_chunk_collectionDatasetApicreate_datasetPOST/api/datasetcreate_datasetDatasetApidelete_datasetDELETE/api/datasetdelete_datasetDatasetApiget_client_dataset_configGET/api/dataset/envsget_client_dataset_configDatasetApiget_datasetGET/api/dataset/{dataset_id}get_datasetDatasetApiget_datasets_from_organizationGET/api/dataset/organization/{organization_id}get_organization_datasetsDatasetApiupdate_datasetPUT/api/datasetupdate_datasetFileApidelete_file_handlerDELETE/api/file/{file_id}delete_fileFileApiget_file_handlerGET/api/file/{file_id}get_fileFileApiget_image_fileGET/api/image/{file_name}get_image_fileFileApiupload_file_handlerPOST/api/fileupload_fileHealthApihealth_checkGET/api/healthInvitationApipost_invitationPOST/api/invitationsend_invitationMessageApicreate_message_completion_handlerPOST/api/messagecreate_messageMessageApiedit_message_handlerPUT/api/messageedit_messageMessageApiget_all_topic_messagesGET/api/messages/{messages_topic_id}get_all_messagesMessageApiregenerate_message_handlerDELETE/api/messageregenerate_messageNotificationsApiget_notificationsGET/api/notifications/{page}get_notificationsNotificationsApimark_all_notifications_as_readPUT/api/notifications_readallmark_all_readNotificationsApimark_notification_as_readPUT/api/notificationsmark_readOrganizationApicreate_organizationPOST/api/organizationcreate_organizationOrganizationApiget_organization_by_idGET/api/organization/{organization_id}get_organizationOrganizationApiget_organization_usageGET/api/organization/usage/{organization_id}get_organization_usageOrganizationApiget_organization_usersGET/api/organization/users/{organization_id}get_organization_usersOrganizationApiupdate_organizationPUT/api/organizationupdate_organizationStripeApicancel_subscriptionDELETE/api/stripe/subscription/{subscription_id}StripeApidirect_to_payment_linkGET/api/stripe/payment_link/{plan_id}/{organization_id}StripeApiget_all_plansGET/api/stripe/plansStripeApiupdate_subscription_planPATCH/api/stripe/subscription_plan/{subscription_id}/{plan_id}TopicApicreate_topicPOST/api/topiccreate_topicTopicApidelete_topicDELETE/api/topicdelete_topicTopicApiget_all_topicsGET/api/topicget_all_topicsTopicApiupdate_topicPUT/api/topicupdate_topicUserApidelete_user_api_keyDELETE/api/user/delete_api_keydelete_user_api_keyUserApiget_user_files_handlerGET/api/user/files/{user_id}get_user_filesUserApiget_user_with_chunks_by_idGET/api/user/{user_id}/{page}get_user_chunksUserApiset_user_api_keyPOST/api/user/set_api_keyset_user_api_keyUserApiupdate_userPUT/api/userupdate_userDocumentation For ModelsAddChunkToCollectionDataApiKeyDTOAuthDataBookmarkChunksBookmarkCollectionResultBookmarkDataChatMessageProxyChunkCollectionChunkCollectionAndFileChunkMetadataChunkMetadataWithFileDataClientDatasetConfigurationCollectionDataCreateChunkCollectionDataCreateChunkDataCreateDatasetRequestCreateMessageDataCreateOrganizationDataCreateTopicDataDatasetDatasetAndOrgWithSubAndPlanDatasetAndUsageDatasetDTODatasetUsageCountDefaultErrorDeleteBookmarkPathDataDeleteCollectionDataDeleteDatasetRequestDeleteTopicDataDeleteUserApiKeyRequestEditMessageDataFileFileDTOFileUploadCompletedNotificationWithNameGenerateChunksRequestGenerateOffCollectionDataGetAllBookmarksDataGetCollectionsForChunksDataGetDirectPaymentLinkDataGetUserWithChunksDataInvitationDataMessageNotificationNotificationIdNotificationReturnOrganizationOrganizationUsageCountOrganizationWithSubAndPlanRecommendChunksRequestRegenerateMessageDataReturnCreatedChunkScoreChunkDTOSearchChunkDataSearchChunkDataTimeRangeInnerSearchChunkDataWeightsInnerSearchChunkQueryResponseBodySearchCollectionsDataSearchCollectionsResultSetUserApiKeyRequestSetUserApiKeyResponseSlimCollectionSlimUserStripePlanStripeSubscriptionSuggestedQueriesRequestSuggestedQueriesResponseTopicUpdateChunkByTrackingIdDataUpdateChunkCollectionDataUpdateChunkDataUpdateDatasetRequestUpdateOrganizationDataUpdateSubscriptionDataUpdateTopicDataUpdateUserDataUploadFileDataUploadFileResultUserCollectionQueryUserDTOUserDTOWithChunksUserOrganizationUserRoleDocumentation For AuthorizationEndpoints do not require authorization.Author