trieve_python_client 1.0.0

trieve-server

trieve-python-client

Trieve REST API OpenAPI Documentation

This Python package is automatically generated by the OpenAPI Generator project:

• API version: 1.0.0
• Package version: 1.0.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.7+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import trieve_python_client

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import trieve_python_client

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import trieve_python_client
from trieve_python_client.rest import ApiException
from pprint import pprint

# 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 client
with trieve_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = trieve_python_client.AuthApi(api_client)

    try:
        # openid_callback
        api_response = api_instance.callback()
        print("The response of AuthApi->callback:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AuthApi->callback: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
AuthApi	callback	GET /api/auth/callback	openid_callback
AuthApi	get_me	GET /api/auth/me	get_me
AuthApi	login	GET /api/auth	login
AuthApi	logout	DELETE /api/auth	logout
ChunkApi	create_chunk	POST /api/chunk	create_chunk
ChunkApi	create_suggested_queries_handler	POST /api/chunk/gen_suggestions	get_suggested_queries
ChunkApi	delete_chunk	DELETE /api/chunk/{chunk_id}	delete_chunk
ChunkApi	delete_chunk_by_tracking_id	DELETE /api/chunk/tracking_id/{tracking_id}	delete_chunk_by_tracking_id
ChunkApi	generate_off_chunks	POST /api/chunk/generate	generate_off_chunks
ChunkApi	get_chunk_by_id	GET /api/chunk/{chunk_id}	get_chunk
ChunkApi	get_chunk_by_tracking_id	GET /api/chunk/tracking_id/{tracking_id}	get_chunk_by_tracking_id
ChunkApi	get_recommended_chunks	POST /api/chunk/recommend	get_recommended_chunks
ChunkApi	search_chunk	POST /api/chunk/search	search
ChunkApi	update_chunk	PUT /api/chunk/update	update_chunk
ChunkApi	update_chunk_by_tracking_id	PUT /api/chunk/tracking_id/update	update_chunk_by_tracking_id
ChunkCollectionApi	add_bookmark	POST /api/chunk_collection/{collection_id}	add_bookmark
ChunkCollectionApi	create_chunk_collection	POST /api/chunk_collection	create_chunk_collection
ChunkCollectionApi	delete_bookmark	DELETE /api/bookmark/{collection_id}/{bookmark_id}	delete_bookmark
ChunkCollectionApi	delete_chunk_collection	DELETE /api/chunk_collection/{collection_id}	delete_chunk_collection
ChunkCollectionApi	get_all_bookmarks	GET /api/chunk_collection/{collection_id}/{page}	get_all_bookmarks
ChunkCollectionApi	get_collections_chunk_is_in	POST /api/chunk_collection/bookmark
ChunkCollectionApi	get_logged_in_user_chunk_collections	GET /api/chunk_collection/{page}	get_current_user_collections
ChunkCollectionApi	get_specific_user_chunk_collections	GET /api/user/collections/{user_id}/{page}	get_user_collections
ChunkCollectionApi	search_collections	POST /api/chunk_collection/search	collection_search
ChunkCollectionApi	update_chunk_collection	PUT /api/chunk_collection	update_chunk_collection
DatasetApi	create_dataset	POST /api/dataset	create_dataset
DatasetApi	delete_dataset	DELETE /api/dataset	delete_dataset
DatasetApi	get_client_dataset_config	GET /api/dataset/envs	get_client_dataset_config
DatasetApi	get_dataset	GET /api/dataset/{dataset_id}	get_dataset
DatasetApi	get_datasets_from_organization	GET /api/dataset/organization/{organization_id}	get_organization_datasets
DatasetApi	update_dataset	PUT /api/dataset	update_dataset
FileApi	delete_file_handler	DELETE /api/file/{file_id}	delete_file
FileApi	get_file_handler	GET /api/file/{file_id}	get_file
FileApi	get_image_file	GET /api/image/{file_name}	get_image_file
FileApi	upload_file_handler	POST /api/file	upload_file
HealthApi	health_check	GET /api/health
InvitationApi	post_invitation	POST /api/invitation	send_invitation
MessageApi	create_message_completion_handler	POST /api/message	create_message
MessageApi	edit_message_handler	PUT /api/message	edit_message
MessageApi	get_all_topic_messages	GET /api/messages/{messages_topic_id}	get_all_messages
MessageApi	regenerate_message_handler	DELETE /api/message	regenerate_message
NotificationsApi	get_notifications	GET /api/notifications/{page}	get_notifications
NotificationsApi	mark_all_notifications_as_read	PUT /api/notifications_readall	mark_all_read
NotificationsApi	mark_notification_as_read	PUT /api/notifications	mark_read
OrganizationApi	create_organization	POST /api/organization	create_organization
OrganizationApi	get_organization_by_id	GET /api/organization/{organization_id}	get_organization
OrganizationApi	get_organization_usage	GET /api/organization/usage/{organization_id}	get_organization_usage
OrganizationApi	get_organization_users	GET /api/organization/users/{organization_id}	get_organization_users
OrganizationApi	update_organization	PUT /api/organization	update_organization
StripeApi	cancel_subscription	DELETE /api/stripe/subscription/{subscription_id}
StripeApi	direct_to_payment_link	GET /api/stripe/payment_link/{plan_id}/{organization_id}
StripeApi	get_all_plans	GET /api/stripe/plans
StripeApi	update_subscription_plan	PATCH /api/stripe/subscription_plan/{subscription_id}/{plan_id}
TopicApi	create_topic	POST /api/topic	create_topic
TopicApi	delete_topic	DELETE /api/topic	delete_topic
TopicApi	get_all_topics	GET /api/topic	get_all_topics
TopicApi	update_topic	PUT /api/topic	update_topic
UserApi	delete_user_api_key	DELETE /api/user/delete_api_key	delete_user_api_key
UserApi	get_user_files_handler	GET /api/user/files/{user_id}	get_user_files
UserApi	get_user_with_chunks_by_id	GET /api/user/{user_id}/{page}	get_user_chunks
UserApi	set_user_api_key	POST /api/user/set_api_key	set_user_api_key
UserApi	update_user	PUT /api/user	update_user

Documentation For Models

• AddChunkToCollectionData
• ApiKeyDTO
• AuthData
• BookmarkChunks
• BookmarkCollectionResult
• BookmarkData
• ChatMessageProxy
• ChunkCollection
• ChunkCollectionAndFile
• ChunkMetadata
• ChunkMetadataWithFileData
• ClientDatasetConfiguration
• CollectionData
• CreateChunkCollectionData
• CreateChunkData
• CreateDatasetRequest
• CreateMessageData
• CreateOrganizationData
• CreateTopicData
• Dataset
• DatasetAndOrgWithSubAndPlan
• DatasetAndUsage
• DatasetDTO
• DatasetUsageCount
• DefaultError
• DeleteBookmarkPathData
• DeleteCollectionData
• DeleteDatasetRequest
• DeleteTopicData
• DeleteUserApiKeyRequest
• EditMessageData
• File
• FileDTO
• FileUploadCompletedNotificationWithName
• GenerateChunksRequest
• GenerateOffCollectionData
• GetAllBookmarksData
• GetCollectionsForChunksData
• GetDirectPaymentLinkData
• GetUserWithChunksData
• InvitationData
• Message
• Notification
• NotificationId
• NotificationReturn
• Organization
• OrganizationUsageCount
• OrganizationWithSubAndPlan
• RecommendChunksRequest
• RegenerateMessageData
• ReturnCreatedChunk
• ScoreChunkDTO
• SearchChunkData
• SearchChunkDataTimeRangeInner
• SearchChunkDataWeightsInner
• SearchChunkQueryResponseBody
• SearchCollectionsData
• SearchCollectionsResult
• SetUserApiKeyRequest
• SetUserApiKeyResponse
• SlimCollection
• SlimUser
• StripePlan
• StripeSubscription
• SuggestedQueriesRequest
• SuggestedQueriesResponse
• Topic
• UpdateChunkByTrackingIdData
• UpdateChunkCollectionData
• UpdateChunkData
• UpdateDatasetRequest
• UpdateOrganizationData
• UpdateSubscriptionData
• UpdateTopicData
• UpdateUserData
• UploadFileData
• UploadFileResult
• UserCollectionQuery
• UserDTO
• UserDTOWithChunks
• UserOrganization
• UserRole

Documentation For Authorization

Endpoints do not require authorization.

Author