diff --git a/.openapi-generator/FILES b/.openapi-generator/FILES index 5558422..40ee8f1 100644 --- a/.openapi-generator/FILES +++ b/.openapi-generator/FILES @@ -1,7 +1,6 @@ .github/workflows/python.yml .gitignore .gitlab-ci.yml -.openapi-generator-ignore .travis.yml README.md docs/AddChunkToGroupData.md @@ -49,6 +48,7 @@ docs/GetEventsData.md docs/GetGroupsForChunksData.md docs/GroupData.md docs/GroupScoreChunkDTO.md +docs/GroupSlimChunksDTO.md docs/HealthApi.md docs/InvitationApi.md docs/InvitationData.md @@ -61,18 +61,28 @@ docs/OrganizationUsageCount.md docs/Range.md docs/ReccomendGroupChunksRequest.md docs/RecommendChunksRequest.md +docs/RecommendChunksResponseTypes.md +docs/RecommendGroupChunkResponseTypes.md docs/RegenerateMessageData.md docs/ReturnQueuedChunk.md docs/ScoreChunkDTO.md +docs/ScoreSlimChunks.md docs/SearchChunkData.md docs/SearchChunkQueryResponseBody.md +docs/SearchChunkResponseTypes.md +docs/SearchGroupSlimChunksResult.md docs/SearchGroupsResult.md docs/SearchOverGroupsData.md docs/SearchOverGroupsResponseBody.md +docs/SearchOverGroupsResponseTypes.md +docs/SearchOverGroupsSlimChunksResponseBody.md +docs/SearchSlimChunkQueryResponseBody.md docs/SearchWithinGroupData.md +docs/SearchWithinGroupResponseTypes.md docs/SetUserApiKeyRequest.md docs/SetUserApiKeyResponse.md docs/SingleQueuedChunkResponse.md +docs/SlimChunkMetadata.md docs/SlimGroup.md docs/SlimUser.md docs/StripeApi.md @@ -100,95 +110,6 @@ setup.cfg setup.py test-requirements.txt test/__init__.py -test/test_add_chunk_to_group_data.py -test/test_api_key_dto.py -test/test_auth_api.py -test/test_auth_query.py -test/test_batch_queued_chunk_response.py -test/test_bookmark_data.py -test/test_bookmark_group_result.py -test/test_chat_message_proxy.py -test/test_chunk_api.py -test/test_chunk_data.py -test/test_chunk_filter.py -test/test_chunk_group.py -test/test_chunk_group_and_file.py -test/test_chunk_group_api.py -test/test_chunk_metadata.py -test/test_chunk_metadata_with_file_data.py -test/test_client_dataset_configuration.py -test/test_create_chunk_data.py -test/test_create_chunk_group_data.py -test/test_create_dataset_request.py -test/test_create_message_data.py -test/test_create_organization_data.py -test/test_create_topic_data.py -test/test_dataset.py -test/test_dataset_and_usage.py -test/test_dataset_api.py -test/test_dataset_dto.py -test/test_dataset_usage_count.py -test/test_delete_dataset_request.py -test/test_delete_topic_data.py -test/test_delete_user_api_key_request.py -test/test_edit_message_data.py -test/test_error_response_body.py -test/test_event.py -test/test_event_return.py -test/test_events_api.py -test/test_field_condition.py -test/test_file.py -test/test_file_api.py -test/test_file_dto.py -test/test_generate_chunks_request.py -test/test_get_events_data.py -test/test_get_groups_for_chunks_data.py -test/test_group_data.py -test/test_group_score_chunk_dto.py -test/test_health_api.py -test/test_invitation_api.py -test/test_invitation_data.py -test/test_match_condition.py -test/test_message.py -test/test_message_api.py -test/test_organization.py -test/test_organization_api.py -test/test_organization_usage_count.py -test/test_range.py -test/test_reccomend_group_chunks_request.py -test/test_recommend_chunks_request.py -test/test_regenerate_message_data.py -test/test_return_queued_chunk.py -test/test_score_chunk_dto.py -test/test_search_chunk_data.py -test/test_search_chunk_query_response_body.py -test/test_search_groups_result.py -test/test_search_over_groups_data.py -test/test_search_over_groups_response_body.py -test/test_search_within_group_data.py -test/test_set_user_api_key_request.py -test/test_set_user_api_key_response.py -test/test_single_queued_chunk_response.py -test/test_slim_group.py -test/test_slim_user.py -test/test_stripe_api.py -test/test_stripe_plan.py -test/test_suggested_queries_request.py -test/test_suggested_queries_response.py -test/test_topic.py -test/test_topic_api.py -test/test_update_chunk_by_tracking_id_data.py -test/test_update_chunk_data.py -test/test_update_chunk_group_data.py -test/test_update_dataset_request.py -test/test_update_group_by_tracking_id_data.py -test/test_update_organization_data.py -test/test_update_topic_data.py -test/test_update_user_data.py -test/test_upload_file_data.py -test/test_upload_file_result.py -test/test_user_api.py -test/test_user_organization.py tox.ini trieve_python_client/__init__.py trieve_python_client/api/__init__.py @@ -249,6 +170,7 @@ trieve_python_client/models/get_events_data.py trieve_python_client/models/get_groups_for_chunks_data.py trieve_python_client/models/group_data.py trieve_python_client/models/group_score_chunk_dto.py +trieve_python_client/models/group_slim_chunks_dto.py trieve_python_client/models/invitation_data.py trieve_python_client/models/match_condition.py trieve_python_client/models/message.py @@ -257,18 +179,28 @@ trieve_python_client/models/organization_usage_count.py trieve_python_client/models/range.py trieve_python_client/models/reccomend_group_chunks_request.py trieve_python_client/models/recommend_chunks_request.py +trieve_python_client/models/recommend_chunks_response_types.py +trieve_python_client/models/recommend_group_chunk_response_types.py trieve_python_client/models/regenerate_message_data.py trieve_python_client/models/return_queued_chunk.py trieve_python_client/models/score_chunk_dto.py +trieve_python_client/models/score_slim_chunks.py trieve_python_client/models/search_chunk_data.py trieve_python_client/models/search_chunk_query_response_body.py +trieve_python_client/models/search_chunk_response_types.py +trieve_python_client/models/search_group_slim_chunks_result.py trieve_python_client/models/search_groups_result.py trieve_python_client/models/search_over_groups_data.py trieve_python_client/models/search_over_groups_response_body.py +trieve_python_client/models/search_over_groups_response_types.py +trieve_python_client/models/search_over_groups_slim_chunks_response_body.py +trieve_python_client/models/search_slim_chunk_query_response_body.py trieve_python_client/models/search_within_group_data.py +trieve_python_client/models/search_within_group_response_types.py trieve_python_client/models/set_user_api_key_request.py trieve_python_client/models/set_user_api_key_response.py trieve_python_client/models/single_queued_chunk_response.py +trieve_python_client/models/slim_chunk_metadata.py trieve_python_client/models/slim_group.py trieve_python_client/models/slim_user.py trieve_python_client/models/stripe_plan.py diff --git a/README.md b/README.md index 9bdef31..f7256d0 100644 --- a/README.md +++ b/README.md @@ -3,8 +3,8 @@ Trieve OpenAPI Specification. This document describes all of the operations avai This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project: -- API version: 0.5.0 -- Package version: 0.5.0 +- API version: 0.5.5 +- Package version: 0.5.5 - Generator version: 7.4.0 - Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit [https://trieve.ai](https://trieve.ai) @@ -56,10 +56,10 @@ 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:8090 +# Defining the host is optional and defaults to https://api.trieve.ai # See configuration.py for a list of all supported configuration parameters. configuration = trieve_python_client.Configuration( - host = "http://localhost:8090" + host = "https://api.trieve.ai" ) @@ -81,7 +81,7 @@ with trieve_python_client.ApiClient(configuration) as api_client: ## Documentation for API Endpoints -All URIs are relative to *http://localhost:8090* +All URIs are relative to *https://api.trieve.ai* Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- @@ -194,6 +194,7 @@ Class | Method | HTTP request | Description - [GetGroupsForChunksData](docs/GetGroupsForChunksData.md) - [GroupData](docs/GroupData.md) - [GroupScoreChunkDTO](docs/GroupScoreChunkDTO.md) + - [GroupSlimChunksDTO](docs/GroupSlimChunksDTO.md) - [InvitationData](docs/InvitationData.md) - [MatchCondition](docs/MatchCondition.md) - [Message](docs/Message.md) @@ -202,18 +203,28 @@ Class | Method | HTTP request | Description - [Range](docs/Range.md) - [ReccomendGroupChunksRequest](docs/ReccomendGroupChunksRequest.md) - [RecommendChunksRequest](docs/RecommendChunksRequest.md) + - [RecommendChunksResponseTypes](docs/RecommendChunksResponseTypes.md) + - [RecommendGroupChunkResponseTypes](docs/RecommendGroupChunkResponseTypes.md) - [RegenerateMessageData](docs/RegenerateMessageData.md) - [ReturnQueuedChunk](docs/ReturnQueuedChunk.md) - [ScoreChunkDTO](docs/ScoreChunkDTO.md) + - [ScoreSlimChunks](docs/ScoreSlimChunks.md) - [SearchChunkData](docs/SearchChunkData.md) - [SearchChunkQueryResponseBody](docs/SearchChunkQueryResponseBody.md) + - [SearchChunkResponseTypes](docs/SearchChunkResponseTypes.md) + - [SearchGroupSlimChunksResult](docs/SearchGroupSlimChunksResult.md) - [SearchGroupsResult](docs/SearchGroupsResult.md) - [SearchOverGroupsData](docs/SearchOverGroupsData.md) - [SearchOverGroupsResponseBody](docs/SearchOverGroupsResponseBody.md) + - [SearchOverGroupsResponseTypes](docs/SearchOverGroupsResponseTypes.md) + - [SearchOverGroupsSlimChunksResponseBody](docs/SearchOverGroupsSlimChunksResponseBody.md) + - [SearchSlimChunkQueryResponseBody](docs/SearchSlimChunkQueryResponseBody.md) - [SearchWithinGroupData](docs/SearchWithinGroupData.md) + - [SearchWithinGroupResponseTypes](docs/SearchWithinGroupResponseTypes.md) - [SetUserApiKeyRequest](docs/SetUserApiKeyRequest.md) - [SetUserApiKeyResponse](docs/SetUserApiKeyResponse.md) - [SingleQueuedChunkResponse](docs/SingleQueuedChunkResponse.md) + - [SlimChunkMetadata](docs/SlimChunkMetadata.md) - [SlimGroup](docs/SlimGroup.md) - [SlimUser](docs/SlimUser.md) - [StripePlan](docs/StripePlan.md) diff --git a/docs/AuthApi.md b/docs/AuthApi.md index 2cd12ce..5d3fabb 100644 --- a/docs/AuthApi.md +++ b/docs/AuthApi.md @@ -1,6 +1,6 @@ # trieve_python_client.AuthApi -All URIs are relative to *http://localhost:8090* +All URIs are relative to *https://api.trieve.ai* Method | HTTP request | Description ------------- | ------------- | ------------- @@ -26,10 +26,10 @@ from trieve_python_client.models.slim_user import SlimUser from trieve_python_client.rest import ApiException from pprint import pprint -# Defining the host is optional and defaults to http://localhost:8090 +# Defining the host is optional and defaults to https://api.trieve.ai # See configuration.py for a list of all supported configuration parameters. configuration = trieve_python_client.Configuration( - host = "http://localhost:8090" + host = "https://api.trieve.ai" ) @@ -92,10 +92,10 @@ from trieve_python_client.models.slim_user import SlimUser from trieve_python_client.rest import ApiException from pprint import pprint -# Defining the host is optional and defaults to http://localhost:8090 +# Defining the host is optional and defaults to https://api.trieve.ai # See configuration.py for a list of all supported configuration parameters. configuration = trieve_python_client.Configuration( - host = "http://localhost:8090" + host = "https://api.trieve.ai" ) # The client must configure the authentication and authorization parameters @@ -167,10 +167,10 @@ from trieve_python_client.models.auth_query import AuthQuery from trieve_python_client.rest import ApiException from pprint import pprint -# Defining the host is optional and defaults to http://localhost:8090 +# Defining the host is optional and defaults to https://api.trieve.ai # See configuration.py for a list of all supported configuration parameters. configuration = trieve_python_client.Configuration( - host = "http://localhost:8090" + host = "https://api.trieve.ai" ) @@ -233,10 +233,10 @@ 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:8090 +# Defining the host is optional and defaults to https://api.trieve.ai # See configuration.py for a list of all supported configuration parameters. configuration = trieve_python_client.Configuration( - host = "http://localhost:8090" + host = "https://api.trieve.ai" ) diff --git a/docs/ChunkApi.md b/docs/ChunkApi.md index 7f9b665..1c8fc0e 100644 --- a/docs/ChunkApi.md +++ b/docs/ChunkApi.md @@ -1,6 +1,6 @@ # trieve_python_client.ChunkApi -All URIs are relative to *http://localhost:8090* +All URIs are relative to *https://api.trieve.ai* Method | HTTP request | Description ------------- | ------------- | ------------- @@ -35,10 +35,10 @@ from trieve_python_client.models.return_queued_chunk import ReturnQueuedChunk from trieve_python_client.rest import ApiException from pprint import pprint -# Defining the host is optional and defaults to http://localhost:8090 +# Defining the host is optional and defaults to https://api.trieve.ai # See configuration.py for a list of all supported configuration parameters. configuration = trieve_python_client.Configuration( - host = "http://localhost:8090" + host = "https://api.trieve.ai" ) # The client must configure the authentication and authorization parameters @@ -119,10 +119,10 @@ from trieve_python_client.models.suggested_queries_response import SuggestedQuer from trieve_python_client.rest import ApiException from pprint import pprint -# Defining the host is optional and defaults to http://localhost:8090 +# Defining the host is optional and defaults to https://api.trieve.ai # See configuration.py for a list of all supported configuration parameters. configuration = trieve_python_client.Configuration( - host = "http://localhost:8090" + host = "https://api.trieve.ai" ) # The client must configure the authentication and authorization parameters @@ -200,10 +200,10 @@ 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:8090 +# Defining the host is optional and defaults to https://api.trieve.ai # See configuration.py for a list of all supported configuration parameters. configuration = trieve_python_client.Configuration( - host = "http://localhost:8090" + host = "https://api.trieve.ai" ) # The client must configure the authentication and authorization parameters @@ -279,10 +279,10 @@ 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:8090 +# Defining the host is optional and defaults to https://api.trieve.ai # See configuration.py for a list of all supported configuration parameters. configuration = trieve_python_client.Configuration( - host = "http://localhost:8090" + host = "https://api.trieve.ai" ) # The client must configure the authentication and authorization parameters @@ -359,10 +359,10 @@ from trieve_python_client.models.generate_chunks_request import GenerateChunksRe from trieve_python_client.rest import ApiException from pprint import pprint -# Defining the host is optional and defaults to http://localhost:8090 +# Defining the host is optional and defaults to https://api.trieve.ai # See configuration.py for a list of all supported configuration parameters. configuration = trieve_python_client.Configuration( - host = "http://localhost:8090" + host = "https://api.trieve.ai" ) # The client must configure the authentication and authorization parameters @@ -441,10 +441,10 @@ from trieve_python_client.models.chunk_metadata import ChunkMetadata from trieve_python_client.rest import ApiException from pprint import pprint -# Defining the host is optional and defaults to http://localhost:8090 +# Defining the host is optional and defaults to https://api.trieve.ai # See configuration.py for a list of all supported configuration parameters. configuration = trieve_python_client.Configuration( - host = "http://localhost:8090" + host = "https://api.trieve.ai" ) # The client must configure the authentication and authorization parameters @@ -523,10 +523,10 @@ from trieve_python_client.models.chunk_metadata import ChunkMetadata from trieve_python_client.rest import ApiException from pprint import pprint -# Defining the host is optional and defaults to http://localhost:8090 +# Defining the host is optional and defaults to https://api.trieve.ai # See configuration.py for a list of all supported configuration parameters. configuration = trieve_python_client.Configuration( - host = "http://localhost:8090" + host = "https://api.trieve.ai" ) # The client must configure the authentication and authorization parameters @@ -589,7 +589,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_recommended_chunks** -> List[ChunkMetadataWithFileData] get_recommended_chunks(tr_dataset, recommend_chunks_request) +> RecommendChunksResponseTypes get_recommended_chunks(tr_dataset, recommend_chunks_request) Get Recommended Chunks @@ -601,15 +601,15 @@ Get Recommended Chunks Get recommendations of chunks similar to the chunks in t ```python import trieve_python_client -from trieve_python_client.models.chunk_metadata_with_file_data import ChunkMetadataWithFileData from trieve_python_client.models.recommend_chunks_request import RecommendChunksRequest +from trieve_python_client.models.recommend_chunks_response_types import RecommendChunksResponseTypes from trieve_python_client.rest import ApiException from pprint import pprint -# Defining the host is optional and defaults to http://localhost:8090 +# Defining the host is optional and defaults to https://api.trieve.ai # See configuration.py for a list of all supported configuration parameters. configuration = trieve_python_client.Configuration( - host = "http://localhost:8090" + host = "https://api.trieve.ai" ) # The client must configure the authentication and authorization parameters @@ -651,7 +651,7 @@ Name | Type | Description | Notes ### Return type -[**List[ChunkMetadataWithFileData]**](ChunkMetadataWithFileData.md) +[**RecommendChunksResponseTypes**](RecommendChunksResponseTypes.md) ### Authorization @@ -666,13 +666,13 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | JSON response payload containing chunks with scores which are similar to those in the request body | - | +**200** | Chunks with embedding vectors which are similar to those in the request body | - | **400** | Service error relating to to getting similar chunks | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **search_chunk** -> SearchChunkQueryResponseBody search_chunk(tr_dataset, search_chunk_data) +> SearchChunkResponseTypes search_chunk(tr_dataset, search_chunk_data) Search @@ -685,14 +685,14 @@ Search This route provides the primary search functionality for the API. It can ```python import trieve_python_client from trieve_python_client.models.search_chunk_data import SearchChunkData -from trieve_python_client.models.search_chunk_query_response_body import SearchChunkQueryResponseBody +from trieve_python_client.models.search_chunk_response_types import SearchChunkResponseTypes from trieve_python_client.rest import ApiException from pprint import pprint -# Defining the host is optional and defaults to http://localhost:8090 +# Defining the host is optional and defaults to https://api.trieve.ai # See configuration.py for a list of all supported configuration parameters. configuration = trieve_python_client.Configuration( - host = "http://localhost:8090" + host = "https://api.trieve.ai" ) # The client must configure the authentication and authorization parameters @@ -734,7 +734,7 @@ Name | Type | Description | Notes ### Return type -[**SearchChunkQueryResponseBody**](SearchChunkQueryResponseBody.md) +[**SearchChunkResponseTypes**](SearchChunkResponseTypes.md) ### Authorization @@ -749,7 +749,7 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | chunks which are similar to the embedding vector of the search query | - | +**200** | Chunks with embedding vectors which are similar to those in the request body | - | **400** | Service error relating to searching | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) @@ -771,10 +771,10 @@ from trieve_python_client.models.update_chunk_data import UpdateChunkData from trieve_python_client.rest import ApiException from pprint import pprint -# Defining the host is optional and defaults to http://localhost:8090 +# Defining the host is optional and defaults to https://api.trieve.ai # See configuration.py for a list of all supported configuration parameters. configuration = trieve_python_client.Configuration( - host = "http://localhost:8090" + host = "https://api.trieve.ai" ) # The client must configure the authentication and authorization parameters @@ -851,10 +851,10 @@ from trieve_python_client.models.update_chunk_by_tracking_id_data import UpdateC from trieve_python_client.rest import ApiException from pprint import pprint -# Defining the host is optional and defaults to http://localhost:8090 +# Defining the host is optional and defaults to https://api.trieve.ai # See configuration.py for a list of all supported configuration parameters. configuration = trieve_python_client.Configuration( - host = "http://localhost:8090" + host = "https://api.trieve.ai" ) # The client must configure the authentication and authorization parameters diff --git a/docs/ChunkGroupApi.md b/docs/ChunkGroupApi.md index 1b0bd67..cb210ce 100644 --- a/docs/ChunkGroupApi.md +++ b/docs/ChunkGroupApi.md @@ -1,6 +1,6 @@ # trieve_python_client.ChunkGroupApi -All URIs are relative to *http://localhost:8090* +All URIs are relative to *https://api.trieve.ai* Method | HTTP request | Description ------------- | ------------- | ------------- @@ -40,10 +40,10 @@ from trieve_python_client.models.add_chunk_to_group_data import AddChunkToGroupD from trieve_python_client.rest import ApiException from pprint import pprint -# Defining the host is optional and defaults to http://localhost:8090 +# Defining the host is optional and defaults to https://api.trieve.ai # See configuration.py for a list of all supported configuration parameters. configuration = trieve_python_client.Configuration( - host = "http://localhost:8090" + host = "https://api.trieve.ai" ) # The client must configure the authentication and authorization parameters @@ -122,10 +122,10 @@ from trieve_python_client.models.add_chunk_to_group_data import AddChunkToGroupD from trieve_python_client.rest import ApiException from pprint import pprint -# Defining the host is optional and defaults to http://localhost:8090 +# Defining the host is optional and defaults to https://api.trieve.ai # See configuration.py for a list of all supported configuration parameters. configuration = trieve_python_client.Configuration( - host = "http://localhost:8090" + host = "https://api.trieve.ai" ) # The client must configure the authentication and authorization parameters @@ -205,10 +205,10 @@ from trieve_python_client.models.create_chunk_group_data import CreateChunkGroup from trieve_python_client.rest import ApiException from pprint import pprint -# Defining the host is optional and defaults to http://localhost:8090 +# Defining the host is optional and defaults to https://api.trieve.ai # See configuration.py for a list of all supported configuration parameters. configuration = trieve_python_client.Configuration( - host = "http://localhost:8090" + host = "https://api.trieve.ai" ) # The client must configure the authentication and authorization parameters @@ -286,10 +286,10 @@ 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:8090 +# Defining the host is optional and defaults to https://api.trieve.ai # See configuration.py for a list of all supported configuration parameters. configuration = trieve_python_client.Configuration( - host = "http://localhost:8090" + host = "https://api.trieve.ai" ) # The client must configure the authentication and authorization parameters @@ -367,10 +367,10 @@ 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:8090 +# Defining the host is optional and defaults to https://api.trieve.ai # See configuration.py for a list of all supported configuration parameters. configuration = trieve_python_client.Configuration( - host = "http://localhost:8090" + host = "https://api.trieve.ai" ) # The client must configure the authentication and authorization parameters @@ -447,10 +447,10 @@ from trieve_python_client.models.chunk_group import ChunkGroup from trieve_python_client.rest import ApiException from pprint import pprint -# Defining the host is optional and defaults to http://localhost:8090 +# Defining the host is optional and defaults to https://api.trieve.ai # See configuration.py for a list of all supported configuration parameters. configuration = trieve_python_client.Configuration( - host = "http://localhost:8090" + host = "https://api.trieve.ai" ) # The client must configure the authentication and authorization parameters @@ -529,10 +529,10 @@ from trieve_python_client.models.bookmark_data import BookmarkData from trieve_python_client.rest import ApiException from pprint import pprint -# Defining the host is optional and defaults to http://localhost:8090 +# Defining the host is optional and defaults to https://api.trieve.ai # See configuration.py for a list of all supported configuration parameters. configuration = trieve_python_client.Configuration( - host = "http://localhost:8090" + host = "https://api.trieve.ai" ) # The client must configure the authentication and authorization parameters @@ -613,10 +613,10 @@ from trieve_python_client.models.bookmark_data import BookmarkData from trieve_python_client.rest import ApiException from pprint import pprint -# Defining the host is optional and defaults to http://localhost:8090 +# Defining the host is optional and defaults to https://api.trieve.ai # See configuration.py for a list of all supported configuration parameters. configuration = trieve_python_client.Configuration( - host = "http://localhost:8090" + host = "https://api.trieve.ai" ) # The client must configure the authentication and authorization parameters @@ -697,10 +697,10 @@ from trieve_python_client.models.chunk_group import ChunkGroup from trieve_python_client.rest import ApiException from pprint import pprint -# Defining the host is optional and defaults to http://localhost:8090 +# Defining the host is optional and defaults to https://api.trieve.ai # See configuration.py for a list of all supported configuration parameters. configuration = trieve_python_client.Configuration( - host = "http://localhost:8090" + host = "https://api.trieve.ai" ) # The client must configure the authentication and authorization parameters @@ -780,10 +780,10 @@ from trieve_python_client.models.get_groups_for_chunks_data import GetGroupsForC from trieve_python_client.rest import ApiException from pprint import pprint -# Defining the host is optional and defaults to http://localhost:8090 +# Defining the host is optional and defaults to https://api.trieve.ai # See configuration.py for a list of all supported configuration parameters. configuration = trieve_python_client.Configuration( - host = "http://localhost:8090" + host = "https://api.trieve.ai" ) # The client must configure the authentication and authorization parameters @@ -846,7 +846,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_recommended_groups** -> List[GroupScoreChunkDTO] get_recommended_groups(tr_dataset, reccomend_group_chunks_request) +> RecommendGroupChunkResponseTypes get_recommended_groups(tr_dataset, reccomend_group_chunks_request) Get Recommended Groups @@ -858,15 +858,15 @@ Get Recommended Groups Route to get recommended groups. This route will return ```python import trieve_python_client -from trieve_python_client.models.group_score_chunk_dto import GroupScoreChunkDTO from trieve_python_client.models.reccomend_group_chunks_request import ReccomendGroupChunksRequest +from trieve_python_client.models.recommend_group_chunk_response_types import RecommendGroupChunkResponseTypes from trieve_python_client.rest import ApiException from pprint import pprint -# Defining the host is optional and defaults to http://localhost:8090 +# Defining the host is optional and defaults to https://api.trieve.ai # See configuration.py for a list of all supported configuration parameters. configuration = trieve_python_client.Configuration( - host = "http://localhost:8090" + host = "https://api.trieve.ai" ) # The client must configure the authentication and authorization parameters @@ -908,7 +908,7 @@ Name | Type | Description | Notes ### Return type -[**List[GroupScoreChunkDTO]**](GroupScoreChunkDTO.md) +[**RecommendGroupChunkResponseTypes**](RecommendGroupChunkResponseTypes.md) ### Authorization @@ -923,7 +923,7 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | JSON response payload containing chunks with scores which are similar to those in the request body | - | +**200** | JSON body representing the groups which are similar to the groups in the request | - | **400** | Service error relating to to getting similar chunks | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) @@ -945,10 +945,10 @@ from trieve_python_client.models.group_data import GroupData from trieve_python_client.rest import ApiException from pprint import pprint -# Defining the host is optional and defaults to http://localhost:8090 +# Defining the host is optional and defaults to https://api.trieve.ai # See configuration.py for a list of all supported configuration parameters. configuration = trieve_python_client.Configuration( - host = "http://localhost:8090" + host = "https://api.trieve.ai" ) # The client must configure the authentication and authorization parameters @@ -1029,10 +1029,10 @@ from trieve_python_client.models.create_chunk_group_data import CreateChunkGroup from trieve_python_client.rest import ApiException from pprint import pprint -# Defining the host is optional and defaults to http://localhost:8090 +# Defining the host is optional and defaults to https://api.trieve.ai # See configuration.py for a list of all supported configuration parameters. configuration = trieve_python_client.Configuration( - host = "http://localhost:8090" + host = "https://api.trieve.ai" ) # The client must configure the authentication and authorization parameters @@ -1095,7 +1095,7 @@ void (empty response body) [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **search_over_groups** -> SearchOverGroupsResponseBody search_over_groups(search_over_groups_data) +> SearchOverGroupsResponseTypes search_over_groups(tr_dataset, search_over_groups_data) Search Over Groups @@ -1103,30 +1103,42 @@ Search Over Groups This route allows you to get groups as results instead of ch ### Example +* Api Key Authentication (ApiKey): ```python import trieve_python_client from trieve_python_client.models.search_over_groups_data import SearchOverGroupsData -from trieve_python_client.models.search_over_groups_response_body import SearchOverGroupsResponseBody +from trieve_python_client.models.search_over_groups_response_types import SearchOverGroupsResponseTypes from trieve_python_client.rest import ApiException from pprint import pprint -# Defining the host is optional and defaults to http://localhost:8090 +# Defining the host is optional and defaults to https://api.trieve.ai # See configuration.py for a list of all supported configuration parameters. configuration = trieve_python_client.Configuration( - host = "http://localhost:8090" + host = "https://api.trieve.ai" ) +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: ApiKey +configuration.api_key['ApiKey'] = os.environ["API_KEY"] + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['ApiKey'] = 'Bearer' # 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.ChunkGroupApi(api_client) + tr_dataset = 'tr_dataset_example' # str | The dataset id to use for the request search_over_groups_data = trieve_python_client.SearchOverGroupsData() # SearchOverGroupsData | JSON request payload to semantically search over groups try: # Search Over Groups - api_response = api_instance.search_over_groups(search_over_groups_data) + api_response = api_instance.search_over_groups(tr_dataset, search_over_groups_data) print("The response of ChunkGroupApi->search_over_groups:\n") pprint(api_response) except Exception as e: @@ -1140,15 +1152,16 @@ with trieve_python_client.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- + **tr_dataset** | **str**| The dataset id to use for the request | **search_over_groups_data** | [**SearchOverGroupsData**](SearchOverGroupsData.md)| JSON request payload to semantically search over groups | ### Return type -[**SearchOverGroupsResponseBody**](SearchOverGroupsResponseBody.md) +[**SearchOverGroupsResponseTypes**](SearchOverGroupsResponseTypes.md) ### Authorization -No authorization required +[ApiKey](../README.md#ApiKey) ### HTTP request headers @@ -1165,7 +1178,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **search_within_group** -> SearchGroupsResult search_within_group(tr_dataset, search_within_group_data) +> SearchWithinGroupResponseTypes search_within_group(tr_dataset, search_within_group_data) Search Within Group @@ -1177,15 +1190,15 @@ Search Within Group This route allows you to search only within a group. This i ```python import trieve_python_client -from trieve_python_client.models.search_groups_result import SearchGroupsResult from trieve_python_client.models.search_within_group_data import SearchWithinGroupData +from trieve_python_client.models.search_within_group_response_types import SearchWithinGroupResponseTypes from trieve_python_client.rest import ApiException from pprint import pprint -# Defining the host is optional and defaults to http://localhost:8090 +# Defining the host is optional and defaults to https://api.trieve.ai # See configuration.py for a list of all supported configuration parameters. configuration = trieve_python_client.Configuration( - host = "http://localhost:8090" + host = "https://api.trieve.ai" ) # The client must configure the authentication and authorization parameters @@ -1227,7 +1240,7 @@ Name | Type | Description | Notes ### Return type -[**SearchGroupsResult**](SearchGroupsResult.md) +[**SearchWithinGroupResponseTypes**](SearchWithinGroupResponseTypes.md) ### Authorization @@ -1264,10 +1277,10 @@ from trieve_python_client.models.update_chunk_group_data import UpdateChunkGroup from trieve_python_client.rest import ApiException from pprint import pprint -# Defining the host is optional and defaults to http://localhost:8090 +# Defining the host is optional and defaults to https://api.trieve.ai # See configuration.py for a list of all supported configuration parameters. configuration = trieve_python_client.Configuration( - host = "http://localhost:8090" + host = "https://api.trieve.ai" ) # The client must configure the authentication and authorization parameters @@ -1344,10 +1357,10 @@ from trieve_python_client.models.update_group_by_tracking_id_data import UpdateG from trieve_python_client.rest import ApiException from pprint import pprint -# Defining the host is optional and defaults to http://localhost:8090 +# Defining the host is optional and defaults to https://api.trieve.ai # See configuration.py for a list of all supported configuration parameters. configuration = trieve_python_client.Configuration( - host = "http://localhost:8090" + host = "https://api.trieve.ai" ) # The client must configure the authentication and authorization parameters diff --git a/docs/DatasetApi.md b/docs/DatasetApi.md index 5bf529d..1cd32df 100644 --- a/docs/DatasetApi.md +++ b/docs/DatasetApi.md @@ -1,6 +1,6 @@ # trieve_python_client.DatasetApi -All URIs are relative to *http://localhost:8090* +All URIs are relative to *https://api.trieve.ai* Method | HTTP request | Description ------------- | ------------- | ------------- @@ -30,10 +30,10 @@ from trieve_python_client.models.dataset import Dataset from trieve_python_client.rest import ApiException from pprint import pprint -# Defining the host is optional and defaults to http://localhost:8090 +# Defining the host is optional and defaults to https://api.trieve.ai # See configuration.py for a list of all supported configuration parameters. configuration = trieve_python_client.Configuration( - host = "http://localhost:8090" + host = "https://api.trieve.ai" ) # The client must configure the authentication and authorization parameters @@ -112,10 +112,10 @@ from trieve_python_client.models.delete_dataset_request import DeleteDatasetRequ from trieve_python_client.rest import ApiException from pprint import pprint -# Defining the host is optional and defaults to http://localhost:8090 +# Defining the host is optional and defaults to https://api.trieve.ai # See configuration.py for a list of all supported configuration parameters. configuration = trieve_python_client.Configuration( - host = "http://localhost:8090" + host = "https://api.trieve.ai" ) # The client must configure the authentication and authorization parameters @@ -192,10 +192,10 @@ from trieve_python_client.models.client_dataset_configuration import ClientDatas from trieve_python_client.rest import ApiException from pprint import pprint -# Defining the host is optional and defaults to http://localhost:8090 +# Defining the host is optional and defaults to https://api.trieve.ai # See configuration.py for a list of all supported configuration parameters. configuration = trieve_python_client.Configuration( - host = "http://localhost:8090" + host = "https://api.trieve.ai" ) # The client must configure the authentication and authorization parameters @@ -272,10 +272,10 @@ from trieve_python_client.models.dataset import Dataset from trieve_python_client.rest import ApiException from pprint import pprint -# Defining the host is optional and defaults to http://localhost:8090 +# Defining the host is optional and defaults to https://api.trieve.ai # See configuration.py for a list of all supported configuration parameters. configuration = trieve_python_client.Configuration( - host = "http://localhost:8090" + host = "https://api.trieve.ai" ) # The client must configure the authentication and authorization parameters @@ -356,10 +356,10 @@ from trieve_python_client.models.dataset_and_usage import DatasetAndUsage from trieve_python_client.rest import ApiException from pprint import pprint -# Defining the host is optional and defaults to http://localhost:8090 +# Defining the host is optional and defaults to https://api.trieve.ai # See configuration.py for a list of all supported configuration parameters. configuration = trieve_python_client.Configuration( - host = "http://localhost:8090" + host = "https://api.trieve.ai" ) # The client must configure the authentication and authorization parameters @@ -439,10 +439,10 @@ from trieve_python_client.models.update_dataset_request import UpdateDatasetRequ from trieve_python_client.rest import ApiException from pprint import pprint -# Defining the host is optional and defaults to http://localhost:8090 +# Defining the host is optional and defaults to https://api.trieve.ai # See configuration.py for a list of all supported configuration parameters. configuration = trieve_python_client.Configuration( - host = "http://localhost:8090" + host = "https://api.trieve.ai" ) # The client must configure the authentication and authorization parameters diff --git a/docs/EventsApi.md b/docs/EventsApi.md index c46245f..4c407a7 100644 --- a/docs/EventsApi.md +++ b/docs/EventsApi.md @@ -1,6 +1,6 @@ # trieve_python_client.EventsApi -All URIs are relative to *http://localhost:8090* +All URIs are relative to *https://api.trieve.ai* Method | HTTP request | Description ------------- | ------------- | ------------- @@ -25,10 +25,10 @@ from trieve_python_client.models.get_events_data import GetEventsData from trieve_python_client.rest import ApiException from pprint import pprint -# Defining the host is optional and defaults to http://localhost:8090 +# Defining the host is optional and defaults to https://api.trieve.ai # See configuration.py for a list of all supported configuration parameters. configuration = trieve_python_client.Configuration( - host = "http://localhost:8090" + host = "https://api.trieve.ai" ) # The client must configure the authentication and authorization parameters diff --git a/docs/FileApi.md b/docs/FileApi.md index 6b08c24..25c4c00 100644 --- a/docs/FileApi.md +++ b/docs/FileApi.md @@ -1,6 +1,6 @@ # trieve_python_client.FileApi -All URIs are relative to *http://localhost:8090* +All URIs are relative to *https://api.trieve.ai* Method | HTTP request | Description ------------- | ------------- | ------------- @@ -26,10 +26,10 @@ 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:8090 +# Defining the host is optional and defaults to https://api.trieve.ai # See configuration.py for a list of all supported configuration parameters. configuration = trieve_python_client.Configuration( - host = "http://localhost:8090" + host = "https://api.trieve.ai" ) # The client must configure the authentication and authorization parameters @@ -108,10 +108,10 @@ from trieve_python_client.models.file import File from trieve_python_client.rest import ApiException from pprint import pprint -# Defining the host is optional and defaults to http://localhost:8090 +# Defining the host is optional and defaults to https://api.trieve.ai # See configuration.py for a list of all supported configuration parameters. configuration = trieve_python_client.Configuration( - host = "http://localhost:8090" + host = "https://api.trieve.ai" ) # The client must configure the authentication and authorization parameters @@ -192,10 +192,10 @@ from trieve_python_client.models.file_dto import FileDTO from trieve_python_client.rest import ApiException from pprint import pprint -# Defining the host is optional and defaults to http://localhost:8090 +# Defining the host is optional and defaults to https://api.trieve.ai # See configuration.py for a list of all supported configuration parameters. configuration = trieve_python_client.Configuration( - host = "http://localhost:8090" + host = "https://api.trieve.ai" ) # The client must configure the authentication and authorization parameters @@ -275,10 +275,10 @@ from trieve_python_client.models.upload_file_result import UploadFileResult from trieve_python_client.rest import ApiException from pprint import pprint -# Defining the host is optional and defaults to http://localhost:8090 +# Defining the host is optional and defaults to https://api.trieve.ai # See configuration.py for a list of all supported configuration parameters. configuration = trieve_python_client.Configuration( - host = "http://localhost:8090" + host = "https://api.trieve.ai" ) # The client must configure the authentication and authorization parameters diff --git a/docs/GroupScoreChunkDTO.md b/docs/GroupScoreChunkDTO.md index a9bb5f9..31023c0 100644 --- a/docs/GroupScoreChunkDTO.md +++ b/docs/GroupScoreChunkDTO.md @@ -6,6 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **group_id** | **str** | | +**group_tracking_id** | **str** | | [optional] **metadata** | [**List[ScoreChunkDTO]**](ScoreChunkDTO.md) | | ## Example diff --git a/docs/HealthApi.md b/docs/HealthApi.md index 4b8c946..5c03e46 100644 --- a/docs/HealthApi.md +++ b/docs/HealthApi.md @@ -1,6 +1,6 @@ # trieve_python_client.HealthApi -All URIs are relative to *http://localhost:8090* +All URIs are relative to *https://api.trieve.ai* Method | HTTP request | Description ------------- | ------------- | ------------- @@ -22,10 +22,10 @@ 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:8090 +# Defining the host is optional and defaults to https://api.trieve.ai # See configuration.py for a list of all supported configuration parameters. configuration = trieve_python_client.Configuration( - host = "http://localhost:8090" + host = "https://api.trieve.ai" ) diff --git a/docs/InvitationApi.md b/docs/InvitationApi.md index 25ceb52..6a04cab 100644 --- a/docs/InvitationApi.md +++ b/docs/InvitationApi.md @@ -1,6 +1,6 @@ # trieve_python_client.InvitationApi -All URIs are relative to *http://localhost:8090* +All URIs are relative to *https://api.trieve.ai* Method | HTTP request | Description ------------- | ------------- | ------------- @@ -24,10 +24,10 @@ from trieve_python_client.models.invitation_data import InvitationData from trieve_python_client.rest import ApiException from pprint import pprint -# Defining the host is optional and defaults to http://localhost:8090 +# Defining the host is optional and defaults to https://api.trieve.ai # See configuration.py for a list of all supported configuration parameters. configuration = trieve_python_client.Configuration( - host = "http://localhost:8090" + host = "https://api.trieve.ai" ) # The client must configure the authentication and authorization parameters diff --git a/docs/MessageApi.md b/docs/MessageApi.md index 1a42ca9..01adc52 100644 --- a/docs/MessageApi.md +++ b/docs/MessageApi.md @@ -1,6 +1,6 @@ # trieve_python_client.MessageApi -All URIs are relative to *http://localhost:8090* +All URIs are relative to *https://api.trieve.ai* Method | HTTP request | Description ------------- | ------------- | ------------- @@ -27,10 +27,10 @@ from trieve_python_client.models.create_message_data import CreateMessageData from trieve_python_client.rest import ApiException from pprint import pprint -# Defining the host is optional and defaults to http://localhost:8090 +# Defining the host is optional and defaults to https://api.trieve.ai # See configuration.py for a list of all supported configuration parameters. configuration = trieve_python_client.Configuration( - host = "http://localhost:8090" + host = "https://api.trieve.ai" ) # The client must configure the authentication and authorization parameters @@ -109,10 +109,10 @@ from trieve_python_client.models.edit_message_data import EditMessageData from trieve_python_client.rest import ApiException from pprint import pprint -# Defining the host is optional and defaults to http://localhost:8090 +# Defining the host is optional and defaults to https://api.trieve.ai # See configuration.py for a list of all supported configuration parameters. configuration = trieve_python_client.Configuration( - host = "http://localhost:8090" + host = "https://api.trieve.ai" ) # The client must configure the authentication and authorization parameters @@ -189,10 +189,10 @@ from trieve_python_client.models.message import Message from trieve_python_client.rest import ApiException from pprint import pprint -# Defining the host is optional and defaults to http://localhost:8090 +# Defining the host is optional and defaults to https://api.trieve.ai # See configuration.py for a list of all supported configuration parameters. configuration = trieve_python_client.Configuration( - host = "http://localhost:8090" + host = "https://api.trieve.ai" ) # The client must configure the authentication and authorization parameters @@ -271,10 +271,10 @@ from trieve_python_client.models.regenerate_message_data import RegenerateMessag from trieve_python_client.rest import ApiException from pprint import pprint -# Defining the host is optional and defaults to http://localhost:8090 +# Defining the host is optional and defaults to https://api.trieve.ai # See configuration.py for a list of all supported configuration parameters. configuration = trieve_python_client.Configuration( - host = "http://localhost:8090" + host = "https://api.trieve.ai" ) # The client must configure the authentication and authorization parameters diff --git a/docs/OrganizationApi.md b/docs/OrganizationApi.md index d4b357d..f63503e 100644 --- a/docs/OrganizationApi.md +++ b/docs/OrganizationApi.md @@ -1,6 +1,6 @@ # trieve_python_client.OrganizationApi -All URIs are relative to *http://localhost:8090* +All URIs are relative to *https://api.trieve.ai* Method | HTTP request | Description ------------- | ------------- | ------------- @@ -30,10 +30,10 @@ from trieve_python_client.models.organization import Organization from trieve_python_client.rest import ApiException from pprint import pprint -# Defining the host is optional and defaults to http://localhost:8090 +# Defining the host is optional and defaults to https://api.trieve.ai # See configuration.py for a list of all supported configuration parameters. configuration = trieve_python_client.Configuration( - host = "http://localhost:8090" + host = "https://api.trieve.ai" ) # The client must configure the authentication and authorization parameters @@ -110,10 +110,10 @@ from trieve_python_client.models.organization import Organization from trieve_python_client.rest import ApiException from pprint import pprint -# Defining the host is optional and defaults to http://localhost:8090 +# Defining the host is optional and defaults to https://api.trieve.ai # See configuration.py for a list of all supported configuration parameters. configuration = trieve_python_client.Configuration( - host = "http://localhost:8090" + host = "https://api.trieve.ai" ) # The client must configure the authentication and authorization parameters @@ -192,10 +192,10 @@ from trieve_python_client.models.organization import Organization from trieve_python_client.rest import ApiException from pprint import pprint -# Defining the host is optional and defaults to http://localhost:8090 +# Defining the host is optional and defaults to https://api.trieve.ai # See configuration.py for a list of all supported configuration parameters. configuration = trieve_python_client.Configuration( - host = "http://localhost:8090" + host = "https://api.trieve.ai" ) # The client must configure the authentication and authorization parameters @@ -274,10 +274,10 @@ from trieve_python_client.models.organization_usage_count import OrganizationUsa from trieve_python_client.rest import ApiException from pprint import pprint -# Defining the host is optional and defaults to http://localhost:8090 +# Defining the host is optional and defaults to https://api.trieve.ai # See configuration.py for a list of all supported configuration parameters. configuration = trieve_python_client.Configuration( - host = "http://localhost:8090" + host = "https://api.trieve.ai" ) # The client must configure the authentication and authorization parameters @@ -356,10 +356,10 @@ from trieve_python_client.models.slim_user import SlimUser from trieve_python_client.rest import ApiException from pprint import pprint -# Defining the host is optional and defaults to http://localhost:8090 +# Defining the host is optional and defaults to https://api.trieve.ai # See configuration.py for a list of all supported configuration parameters. configuration = trieve_python_client.Configuration( - host = "http://localhost:8090" + host = "https://api.trieve.ai" ) # The client must configure the authentication and authorization parameters @@ -439,10 +439,10 @@ from trieve_python_client.models.update_organization_data import UpdateOrganizat from trieve_python_client.rest import ApiException from pprint import pprint -# Defining the host is optional and defaults to http://localhost:8090 +# Defining the host is optional and defaults to https://api.trieve.ai # See configuration.py for a list of all supported configuration parameters. configuration = trieve_python_client.Configuration( - host = "http://localhost:8090" + host = "https://api.trieve.ai" ) # The client must configure the authentication and authorization parameters diff --git a/docs/ReccomendGroupChunksRequest.md b/docs/ReccomendGroupChunksRequest.md index a30d347..6f5b3ca 100644 --- a/docs/ReccomendGroupChunksRequest.md +++ b/docs/ReccomendGroupChunksRequest.md @@ -12,6 +12,7 @@ Name | Type | Description | Notes **negative_group_tracking_ids** | **List[str]** | The ids of the groups to be used as negative examples for the recommendation. The groups in this array will be used to filter out similar groups. | [optional] **positive_group_ids** | **List[str]** | The ids of the groups to be used as positive examples for the recommendation. The groups in this array will be used to find similar groups. | [optional] **positive_group_tracking_ids** | **List[str]** | The ids of the groups to be used as positive examples for the recommendation. The groups in this array will be used to find similar groups. | [optional] +**slim_chunks** | **bool** | Set slim_chunks to true to avoid returning the content and chunk_html of the chunks. This is useful for when you want to reduce amount of data over the wire for latency improvement. Default is false. | [optional] ## Example diff --git a/docs/RecommendChunksRequest.md b/docs/RecommendChunksRequest.md index 38bb93f..5252134 100644 --- a/docs/RecommendChunksRequest.md +++ b/docs/RecommendChunksRequest.md @@ -11,6 +11,7 @@ Name | Type | Description | Notes **negative_tracking_ids** | **List[str]** | The tracking_ids of the chunks to be used as negative examples for the recommendation. The chunks in this array will be used to filter out similar chunks. | [optional] **positive_chunk_ids** | **List[str]** | The ids of the chunks to be used as positive examples for the recommendation. The chunks in this array will be used to find similar chunks. | [optional] **positive_tracking_ids** | **List[str]** | The tracking_ids of the chunks to be used as positive examples for the recommendation. The chunks in this array will be used to find similar chunks. | [optional] +**slim_chunks** | **bool** | Set slim_chunks to true to avoid returning the content and chunk_html of the chunks. This is useful for when you want to reduce amount of data over the wire for latency improvement. Default is false. | [optional] ## Example diff --git a/docs/SearchChunkData.md b/docs/SearchChunkData.md index a6aedfa..6b80688 100644 --- a/docs/SearchChunkData.md +++ b/docs/SearchChunkData.md @@ -13,8 +13,10 @@ Name | Type | Description | Notes **page** | **int** | Page of chunks to fetch. Each page is 10 chunks. Support for custom page size is coming soon. | [optional] **page_size** | **int** | Page size is the number of chunks to fetch. This can be used to fetch more than 10 chunks at a time. | [optional] **query** | **str** | Query is the search query. This can be any string. The query will be used to create an embedding vector and/or SPLADE vector which will be used to find the result set. | +**quote_negated_words** | **bool** | Turn on quote words and negated words to search for exact phrases and exclude words from the search results. Default is false. | [optional] **score_threshold** | **float** | Set score_threshold to a float to filter out chunks with a score below the threshold. | [optional] **search_type** | **str** | Can be either \"semantic\", \"fulltext\", or \"hybrid\". \"hybrid\" will pull in one page (10 chunks) of both semantic and full-text results then re-rank them using BAAI/bge-reranker-large. \"semantic\" will pull in one page (10 chunks) of the nearest cosine distant vectors. \"fulltext\" will pull in one page (10 chunks) of full-text results based on SPLADE. | +**slim_chunks** | **bool** | Set slim_chunks to true to avoid returning the content and chunk_html of the chunks. This is useful for when you want to reduce amount of data over the wire for latency improvement. Default is false. | [optional] **use_weights** | **bool** | Set use_weights to true to use the weights of the chunks in the result set in order to sort them. If not specified, this defaults to true. | [optional] ## Example diff --git a/docs/SearchOverGroupsData.md b/docs/SearchOverGroupsData.md index cd60f2f..0cd30a7 100644 --- a/docs/SearchOverGroupsData.md +++ b/docs/SearchOverGroupsData.md @@ -13,8 +13,10 @@ Name | Type | Description | Notes **page** | **int** | Page of chunks to fetch. Each page is 10 chunks. Support for custom page size is coming soon. | [optional] **page_size** | **int** | Page size is the number of chunks to fetch. This can be used to fetch more than 10 chunks at a time. | [optional] **query** | **str** | Query is the search query. This can be any string. The query will be used to create an embedding vector and/or SPLADE vector which will be used to find the result set. | +**quote_negated_words** | **bool** | Turn on quote words and negated words to search for exact phrases and exclude words from the search results. Default is false. | [optional] **score_threshold** | **float** | Set score_threshold to a float to filter out chunks with a score below the threshold. | [optional] **search_type** | **str** | Can be either \"semantic\", \"fulltext\", or \"hybrid\". \"hybrid\" will pull in one page (10 chunks) of both semantic and full-text results then re-rank them using BAAI/bge-reranker-large. \"semantic\" will pull in one page (10 chunks) of the nearest cosine distant vectors. \"fulltext\" will pull in one page (10 chunks) of full-text results based on SPLADE. | +**slim_chunks** | **bool** | Set slim_chunks to true to avoid returning the content and chunk_html of the chunks. This is useful for when you want to reduce amount of data over the wire for latency improvement. Default is false. | [optional] ## Example diff --git a/docs/SearchWithinGroupData.md b/docs/SearchWithinGroupData.md index 73eda43..4dd2f02 100644 --- a/docs/SearchWithinGroupData.md +++ b/docs/SearchWithinGroupData.md @@ -14,8 +14,10 @@ Name | Type | Description | Notes **page** | **int** | The page of chunks to fetch. Each page is 10 chunks. Support for custom page size is coming soon. | [optional] **page_size** | **int** | The page size is the number of chunks to fetch. This can be used to fetch more than 10 chunks at a time. | [optional] **query** | **str** | The query is the search query. This can be any string. The query will be used to create an embedding vector and/or SPLADE vector which will be used to find the result set. | +**quote_negated_words** | **bool** | Turn on quote words and negated words to search for exact phrases and exclude words from the search results. Default is false. | [optional] **score_threshold** | **float** | Set score_threshold to a float to filter out chunks with a score below the threshold. | [optional] **search_type** | **str** | Search_type can be either \"semantic\", \"fulltext\", or \"hybrid\". \"hybrid\" will pull in one page (10 chunks) of both semantic and full-text results then re-rank them using BAAI/bge-reranker-large. \"semantic\" will pull in one page (10 chunks) of the nearest cosine distant vectors. \"fulltext\" will pull in one page (10 chunks) of full-text results based on SPLADE. | +**slim_chunks** | **bool** | Set slim_chunks to true to avoid returning the content and chunk_html of the chunks. This is useful for when you want to reduce amount of data over the wire for latency improvement. Default is false. | [optional] **use_weights** | **bool** | Set use_weights to true to use the weights of the chunks in the result set in order to sort them. If not specified, this defaults to true. | [optional] ## Example diff --git a/docs/SlimUser.md b/docs/SlimUser.md index 9ab1092..91cb0fe 100644 --- a/docs/SlimUser.md +++ b/docs/SlimUser.md @@ -10,9 +10,6 @@ Name | Type | Description | Notes **name** | **str** | | [optional] **orgs** | [**List[Organization]**](Organization.md) | | **user_orgs** | [**List[UserOrganization]**](UserOrganization.md) | | -**username** | **str** | | [optional] -**visible_email** | **bool** | | -**website** | **str** | | [optional] ## Example diff --git a/docs/StripeApi.md b/docs/StripeApi.md index 5f5fef1..3e926ec 100644 --- a/docs/StripeApi.md +++ b/docs/StripeApi.md @@ -1,6 +1,6 @@ # trieve_python_client.StripeApi -All URIs are relative to *http://localhost:8090* +All URIs are relative to *https://api.trieve.ai* Method | HTTP request | Description ------------- | ------------- | ------------- @@ -26,10 +26,10 @@ 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:8090 +# Defining the host is optional and defaults to https://api.trieve.ai # See configuration.py for a list of all supported configuration parameters. configuration = trieve_python_client.Configuration( - host = "http://localhost:8090" + host = "https://api.trieve.ai" ) # The client must configure the authentication and authorization parameters @@ -104,10 +104,10 @@ 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:8090 +# Defining the host is optional and defaults to https://api.trieve.ai # See configuration.py for a list of all supported configuration parameters. configuration = trieve_python_client.Configuration( - host = "http://localhost:8090" + host = "https://api.trieve.ai" ) @@ -173,10 +173,10 @@ from trieve_python_client.models.stripe_plan import StripePlan from trieve_python_client.rest import ApiException from pprint import pprint -# Defining the host is optional and defaults to http://localhost:8090 +# Defining the host is optional and defaults to https://api.trieve.ai # See configuration.py for a list of all supported configuration parameters. configuration = trieve_python_client.Configuration( - host = "http://localhost:8090" + host = "https://api.trieve.ai" ) @@ -238,10 +238,10 @@ 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:8090 +# Defining the host is optional and defaults to https://api.trieve.ai # See configuration.py for a list of all supported configuration parameters. configuration = trieve_python_client.Configuration( - host = "http://localhost:8090" + host = "https://api.trieve.ai" ) # The client must configure the authentication and authorization parameters diff --git a/docs/TopicApi.md b/docs/TopicApi.md index 3f34f75..a5d7c14 100644 --- a/docs/TopicApi.md +++ b/docs/TopicApi.md @@ -1,6 +1,6 @@ # trieve_python_client.TopicApi -All URIs are relative to *http://localhost:8090* +All URIs are relative to *https://api.trieve.ai* Method | HTTP request | Description ------------- | ------------- | ------------- @@ -28,10 +28,10 @@ from trieve_python_client.models.topic import Topic from trieve_python_client.rest import ApiException from pprint import pprint -# Defining the host is optional and defaults to http://localhost:8090 +# Defining the host is optional and defaults to https://api.trieve.ai # See configuration.py for a list of all supported configuration parameters. configuration = trieve_python_client.Configuration( - host = "http://localhost:8090" + host = "https://api.trieve.ai" ) # The client must configure the authentication and authorization parameters @@ -110,10 +110,10 @@ from trieve_python_client.models.delete_topic_data import DeleteTopicData from trieve_python_client.rest import ApiException from pprint import pprint -# Defining the host is optional and defaults to http://localhost:8090 +# Defining the host is optional and defaults to https://api.trieve.ai # See configuration.py for a list of all supported configuration parameters. configuration = trieve_python_client.Configuration( - host = "http://localhost:8090" + host = "https://api.trieve.ai" ) # The client must configure the authentication and authorization parameters @@ -190,10 +190,10 @@ from trieve_python_client.models.topic import Topic from trieve_python_client.rest import ApiException from pprint import pprint -# Defining the host is optional and defaults to http://localhost:8090 +# Defining the host is optional and defaults to https://api.trieve.ai # See configuration.py for a list of all supported configuration parameters. configuration = trieve_python_client.Configuration( - host = "http://localhost:8090" + host = "https://api.trieve.ai" ) # The client must configure the authentication and authorization parameters @@ -272,10 +272,10 @@ from trieve_python_client.models.update_topic_data import UpdateTopicData from trieve_python_client.rest import ApiException from pprint import pprint -# Defining the host is optional and defaults to http://localhost:8090 +# Defining the host is optional and defaults to https://api.trieve.ai # See configuration.py for a list of all supported configuration parameters. configuration = trieve_python_client.Configuration( - host = "http://localhost:8090" + host = "https://api.trieve.ai" ) # The client must configure the authentication and authorization parameters diff --git a/docs/UpdateChunkData.md b/docs/UpdateChunkData.md index 317d0ee..470acdd 100644 --- a/docs/UpdateChunkData.md +++ b/docs/UpdateChunkData.md @@ -11,6 +11,7 @@ Name | Type | Description | Notes **group_tracking_ids** | **List[str]** | Group tracking_ids are the tracking_ids of the groups that the chunk should be placed into. This is useful for when you want to update a chunk and add it to a group or multiple groups in one request. | [optional] **link** | **str** | Link of the chunk you want to update. This can also be any string. Frequently, this is a link to the source of the chunk. The link value will not affect the embedding creation. If no link is provided, the existing link will be used. | [optional] **metadata** | **object** | The metadata is a JSON object which can be used to filter chunks. This is useful for when you want to filter chunks by arbitrary metadata. Unlike with tag filtering, there is a performance hit for filtering on metadata. If no metadata is provided, the existing metadata will be used. | [optional] +**tag_set** | **List[str]** | Tag set is a list of tags. This can be used to filter chunks by tag. Unlike with metadata filtering, HNSW indices will exist for each tag such that there is not a performance hit for filtering on them. If no tag_set is provided, the existing tag_set will be used. | [optional] **time_stamp** | **str** | Time_stamp should be an ISO 8601 combined date and time without timezone. It is used for time window filtering and recency-biasing search results. If no time_stamp is provided, the existing time_stamp will be used. | [optional] **tracking_id** | **str** | Tracking_id of the chunk you want to update. This is required to match an existing chunk. | [optional] **weight** | **float** | Weight is a float which can be used to bias search results. This is useful for when you want to bias search results for a chunk. The magnitude only matters relative to other chunks in the chunk's dataset dataset. If no weight is provided, the existing weight will be used. | [optional] diff --git a/docs/UpdateUserData.md b/docs/UpdateUserData.md index 50d08b3..f30b093 100644 --- a/docs/UpdateUserData.md +++ b/docs/UpdateUserData.md @@ -9,9 +9,6 @@ Name | Type | Description | Notes **organization_id** | **str** | The id of the organization to update the user for. | **role** | **int** | Either 0 (user), 1 (admin), or 2 (owner). If not provided, the current role will be used. The auth'ed user must have a role greater than or equal to the role being assigned. | [optional] **user_id** | **str** | The id of the user to update, if not provided, the auth'ed user will be updated. If provided, the auth'ed user must be an admin (1) or owner (2) of the organization. | [optional] -**username** | **str** | The new username to assign to the user, if not provided, the current username will be used. | [optional] -**visible_email** | **bool** | Determines if the user's email is visible to other users, if not provided, the current value will be used. | [optional] -**website** | **str** | The new website to assign to the user, if not provided, the current website will be used. Used for linking to the user's personal or company website. | [optional] ## Example diff --git a/docs/UserApi.md b/docs/UserApi.md index 3c25647..be032c6 100644 --- a/docs/UserApi.md +++ b/docs/UserApi.md @@ -1,6 +1,6 @@ # trieve_python_client.UserApi -All URIs are relative to *http://localhost:8090* +All URIs are relative to *https://api.trieve.ai* Method | HTTP request | Description ------------- | ------------- | ------------- @@ -27,10 +27,10 @@ from trieve_python_client.models.delete_user_api_key_request import DeleteUserAp from trieve_python_client.rest import ApiException from pprint import pprint -# Defining the host is optional and defaults to http://localhost:8090 +# Defining the host is optional and defaults to https://api.trieve.ai # See configuration.py for a list of all supported configuration parameters. configuration = trieve_python_client.Configuration( - host = "http://localhost:8090" + host = "https://api.trieve.ai" ) # The client must configure the authentication and authorization parameters @@ -108,10 +108,10 @@ from trieve_python_client.models.set_user_api_key_response import SetUserApiKeyR from trieve_python_client.rest import ApiException from pprint import pprint -# Defining the host is optional and defaults to http://localhost:8090 +# Defining the host is optional and defaults to https://api.trieve.ai # See configuration.py for a list of all supported configuration parameters. configuration = trieve_python_client.Configuration( - host = "http://localhost:8090" + host = "https://api.trieve.ai" ) # The client must configure the authentication and authorization parameters @@ -189,10 +189,10 @@ from trieve_python_client.models.update_user_data import UpdateUserData from trieve_python_client.rest import ApiException from pprint import pprint -# Defining the host is optional and defaults to http://localhost:8090 +# Defining the host is optional and defaults to https://api.trieve.ai # See configuration.py for a list of all supported configuration parameters. configuration = trieve_python_client.Configuration( - host = "http://localhost:8090" + host = "https://api.trieve.ai" ) # The client must configure the authentication and authorization parameters diff --git a/openapi-generator.yaml b/openapi-generator.yaml index b209a16..ac7c182 100644 --- a/openapi-generator.yaml +++ b/openapi-generator.yaml @@ -1,7 +1,7 @@ generatorName: python outputDir: ./generated-code/python-client packageName: trieve_python_client -packageVersion: 0.5.0 +packageVersion: 0.5.5 additionalProperties: projectName: trieve_python_client @@ -10,4 +10,4 @@ additionalProperties: packageDescription: "Python client for Trieve API generated from its OpenAPI specification using openapi-generator." packageAuthor: "Trieve" packageAuthorEmail: "developers@trieve.ai" - packageVersion: "0.5.0" \ No newline at end of file + packageVersion: "0.5.5" \ No newline at end of file diff --git a/openapi.json b/openapi.json index b97cbb6..c53c651 100644 --- a/openapi.json +++ b/openapi.json @@ -12,16 +12,16 @@ "name": "BSL", "url": "https://github.com/devflowinc/trieve/blob/main/LICENSE.txt" }, - "version": "0.5.0" + "version": "0.5.5" }, "servers": [ - { - "url": "http://localhost:8090", - "description": "Local development server" - }, { "url": "https://api.trieve.ai", "description": "Production server" + }, + { + "url": "http://localhost:8090", + "description": "Local development server" } ], "paths": { @@ -422,14 +422,11 @@ }, "responses": { "200": { - "description": "JSON response payload containing chunks with scores which are similar to those in the request body", + "description": "Chunks with embedding vectors which are similar to those in the request body", "content": { "application/json": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ChunkMetadataWithFileData" - } + "$ref": "#/components/schemas/RecommendChunksResponseTypes" } } } @@ -486,11 +483,11 @@ }, "responses": { "200": { - "description": "chunks which are similar to the embedding vector of the search query", + "description": "Chunks with embedding vectors which are similar to those in the request body", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SearchChunkQueryResponseBody" + "$ref": "#/components/schemas/SearchChunkResponseTypes" } } } @@ -1100,6 +1097,17 @@ "summary": "Search Over Groups", "description": "Search Over Groups\n\nThis route allows you to get groups as results instead of chunks. Each group returned will have the matching chunks sorted by similarity within the group. This is useful for when you want to get groups of chunks which are similar to the search query. If choosing hybrid search, the results will be re-ranked using BAAI/bge-reranker-large. Compatible with semantic, fulltext, or hybrid search modes.", "operationId": "search_over_groups", + "parameters": [ + { + "name": "TR-Dataset", + "in": "header", + "description": "The dataset id to use for the request", + "required": true, + "schema": { + "type": "string" + } + } + ], "requestBody": { "description": "JSON request payload to semantically search over groups", "content": { @@ -1117,7 +1125,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SearchOverGroupsResponseBody" + "$ref": "#/components/schemas/SearchOverGroupsResponseTypes" } } } @@ -1132,7 +1140,14 @@ } } } - } + }, + "security": [ + { + "ApiKey": [ + "readonly" + ] + } + ] } }, "/api/chunk_group/recommend": { @@ -1167,14 +1182,11 @@ }, "responses": { "200": { - "description": "JSON response payload containing chunks with scores which are similar to those in the request body", + "description": "JSON body representing the groups which are similar to the groups in the request", "content": { "application/json": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GroupScoreChunkDTO" - } + "$ref": "#/components/schemas/RecommendGroupChunkResponseTypes" } } } @@ -1235,7 +1247,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SearchGroupsResult" + "$ref": "#/components/schemas/SearchWithinGroupResponseTypes" } } } @@ -5286,12 +5298,81 @@ "type": "string", "format": "uuid" }, + "group_tracking_id": { + "type": "string", + "nullable": true + }, "metadata": { "type": "array", "items": { "$ref": "#/components/schemas/ScoreChunkDTO" } } + }, + "example": { + "group_id": "e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3", + "metadata": [ + { + "metadata": [ + { + "content": "This is a test content", + "id": "e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3", + "link": "https://www.google.com", + "metadata": { + "key": "value" + }, + "tag_set": "test", + "time_stamp": "2021-01-01T00:00:00Z", + "tracking_id": "e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3", + "weight": 1 + } + ], + "score": 0.5 + } + ] + } + }, + "GroupSlimChunksDTO": { + "type": "object", + "required": [ + "group_id", + "metadata" + ], + "properties": { + "group_id": { + "type": "string", + "format": "uuid" + }, + "metadata": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ScoreSlimChunks" + } + } + }, + "example": { + "group_id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3", + "metadata": [ + { + "metadata": [ + { + "created_at": "2021-01-01T00:00:00", + "id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3", + "link": "https://trieve.ai", + "metadata": { + "key": "value" + }, + "qdrant_point_id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3", + "tag_set": "tag1,tag2", + "time_stamp": "2021-01-01T00:00:00", + "tracking_id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3", + "updated_at": "2021-01-01T00:00:00", + "weight": 0.5 + } + ], + "score": 0.5 + } + ] } }, "InvitationData": { @@ -5582,6 +5663,11 @@ }, "description": "The ids of the groups to be used as positive examples for the recommendation. The groups in this array will be used to find similar groups.", "nullable": true + }, + "slim_chunks": { + "type": "boolean", + "description": "Set slim_chunks to true to avoid returning the content and chunk_html of the chunks. This is useful for when you want to reduce amount of data over the wire for latency improvement. Default is false.", + "nullable": true } } }, @@ -5636,9 +5722,127 @@ }, "description": "The tracking_ids of the chunks to be used as positive examples for the recommendation. The chunks in this array will be used to find similar chunks.", "nullable": true + }, + "slim_chunks": { + "type": "boolean", + "description": "Set slim_chunks to true to avoid returning the content and chunk_html of the chunks. This is useful for when you want to reduce amount of data over the wire for latency improvement. Default is false.", + "nullable": true } } }, + "RecommendChunksResponseTypes": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/ChunkMetadata" + }, + "example": [ + { + "chunk_html": "

Hello, world!

", + "content": "Hello, world!", + "created_at": "2021-01-01T00:00:00", + "dataset_id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3", + "id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3", + "link": "https://trieve.ai", + "metadata": { + "key": "value" + }, + "qdrant_point_id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3", + "tag_set": "tag1,tag2", + "time_stamp": "2021-01-01T00:00:00", + "tracking_id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3", + "updated_at": "2021-01-01T00:00:00", + "weight": 0.5 + } + ] + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/SlimChunkMetadata" + }, + "example": [ + { + "created_at": "2021-01-01T00:00:00", + "dataset_id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3", + "id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3", + "link": "https://trieve.ai", + "metadata": { + "key": "value" + }, + "qdrant_point_id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3", + "tag_set": "tag1,tag2", + "time_stamp": "2021-01-01T00:00:00", + "tracking_id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3", + "updated_at": "2021-01-01T00:00:00", + "weight": 0.5 + } + ] + } + ] + }, + "RecommendGroupChunkResponseTypes": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/GroupSlimChunksDTO" + }, + "example": [ + { + "group_id": "e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3", + "metadata": [ + { + "metadata": [ + { + "content": "This is a test content", + "id": "e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3", + "link": "https://www.google.com", + "metadata": { + "key": "value" + }, + "tag_set": "test", + "time_stamp": "2021-01-01T00:00:00Z", + "tracking_id": "e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3", + "weight": 1 + } + ], + "score": 0.5 + } + ] + } + ] + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/GroupScoreChunkDTO" + }, + "example": { + "group_id": "e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3", + "metadata": [ + { + "metadata": [ + { + "id": "e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3", + "link": "https://www.google.com", + "metadata": { + "key": "value" + }, + "tag_set": "test", + "time_stamp": "2021-01-01T00:00:00Z", + "tracking_id": "e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3", + "weight": 1 + } + ], + "score": 0.5 + } + ] + } + } + ] + }, "RegenerateMessageData": { "type": "object", "required": [ @@ -5721,6 +5925,44 @@ "score": 0.5 } }, + "ScoreSlimChunks": { + "type": "object", + "required": [ + "metadata", + "score" + ], + "properties": { + "metadata": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SlimChunkMetadata" + } + }, + "score": { + "type": "number", + "format": "double" + } + }, + "example": { + "metadata": [ + { + "created_at": "2021-01-01T00:00:00", + "id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3", + "link": "https://trieve.ai", + "metadata": { + "key": "value" + }, + "qdrant_point_id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3", + "tag_set": "tag1,tag2", + "time_stamp": "2021-01-01T00:00:00", + "tracking_id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3", + "updated_at": "2021-01-01T00:00:00", + "weight": 0.5 + } + ], + "score": 0.5 + } + }, "SearchChunkData": { "type": "object", "required": [ @@ -5777,6 +6019,11 @@ "type": "string", "description": "Query is the search query. This can be any string. The query will be used to create an embedding vector and/or SPLADE vector which will be used to find the result set." }, + "quote_negated_words": { + "type": "boolean", + "description": "Turn on quote words and negated words to search for exact phrases and exclude words from the search results. Default is false.", + "nullable": true + }, "score_threshold": { "type": "number", "format": "float", @@ -5787,6 +6034,11 @@ "type": "string", "description": "Can be either \"semantic\", \"fulltext\", or \"hybrid\". \"hybrid\" will pull in one page (10 chunks) of both semantic and full-text results then re-rank them using BAAI/bge-reranker-large. \"semantic\" will pull in one page (10 chunks) of the nearest cosine distant vectors. \"fulltext\" will pull in one page (10 chunks) of full-text results based on SPLADE." }, + "slim_chunks": { + "type": "boolean", + "description": "Set slim_chunks to true to avoid returning the content and chunk_html of the chunks. This is useful for when you want to reduce amount of data over the wire for latency improvement. Default is false.", + "nullable": true + }, "use_weights": { "type": "boolean", "description": "Set use_weights to true to use the weights of the chunks in the result set in order to sort them. If not specified, this defaults to true.", @@ -5877,6 +6129,39 @@ } } }, + "SearchChunkResponseTypes": { + "oneOf": [ + { + "$ref": "#/components/schemas/SearchSlimChunkQueryResponseBody" + }, + { + "$ref": "#/components/schemas/SearchChunkQueryResponseBody" + } + ] + }, + "SearchGroupSlimChunksResult": { + "type": "object", + "required": [ + "bookmarks", + "group", + "total_pages" + ], + "properties": { + "bookmarks": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ScoreSlimChunks" + } + }, + "group": { + "$ref": "#/components/schemas/ChunkGroup" + }, + "total_pages": { + "type": "integer", + "format": "int64" + } + } + }, "SearchGroupsResult": { "type": "object", "required": [ @@ -5957,6 +6242,11 @@ "type": "string", "description": "Query is the search query. This can be any string. The query will be used to create an embedding vector and/or SPLADE vector which will be used to find the result set." }, + "quote_negated_words": { + "type": "boolean", + "description": "Turn on quote words and negated words to search for exact phrases and exclude words from the search results. Default is false.", + "nullable": true + }, "score_threshold": { "type": "number", "format": "float", @@ -5966,6 +6256,11 @@ "search_type": { "type": "string", "description": "Can be either \"semantic\", \"fulltext\", or \"hybrid\". \"hybrid\" will pull in one page (10 chunks) of both semantic and full-text results then re-rank them using BAAI/bge-reranker-large. \"semantic\" will pull in one page (10 chunks) of the nearest cosine distant vectors. \"fulltext\" will pull in one page (10 chunks) of full-text results based on SPLADE." + }, + "slim_chunks": { + "type": "boolean", + "description": "Set slim_chunks to true to avoid returning the content and chunk_html of the chunks. This is useful for when you want to reduce amount of data over the wire for latency improvement. Default is false.", + "nullable": true } } }, @@ -5988,6 +6283,54 @@ } } }, + "SearchOverGroupsResponseTypes": { + "oneOf": [ + { + "$ref": "#/components/schemas/SearchOverGroupsResponseBody" + }, + { + "$ref": "#/components/schemas/SearchOverGroupsSlimChunksResponseBody" + } + ] + }, + "SearchOverGroupsSlimChunksResponseBody": { + "type": "object", + "required": [ + "group_chunks", + "total_chunk_pages" + ], + "properties": { + "group_chunks": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GroupSlimChunksDTO" + } + }, + "total_chunk_pages": { + "type": "integer", + "format": "int64" + } + } + }, + "SearchSlimChunkQueryResponseBody": { + "type": "object", + "required": [ + "score_chunks", + "total_chunk_pages" + ], + "properties": { + "score_chunks": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ScoreSlimChunks" + } + }, + "total_chunk_pages": { + "type": "integer", + "format": "int64" + } + } + }, "SearchWithinGroupData": { "type": "object", "required": [ @@ -6050,6 +6393,11 @@ "type": "string", "description": "The query is the search query. This can be any string. The query will be used to create an embedding vector and/or SPLADE vector which will be used to find the result set." }, + "quote_negated_words": { + "type": "boolean", + "description": "Turn on quote words and negated words to search for exact phrases and exclude words from the search results. Default is false.", + "nullable": true + }, "score_threshold": { "type": "number", "format": "float", @@ -6060,6 +6408,11 @@ "type": "string", "description": "Search_type can be either \"semantic\", \"fulltext\", or \"hybrid\". \"hybrid\" will pull in one page (10 chunks) of both semantic and full-text results then re-rank them using BAAI/bge-reranker-large. \"semantic\" will pull in one page (10 chunks) of the nearest cosine distant vectors. \"fulltext\" will pull in one page (10 chunks) of full-text results based on SPLADE." }, + "slim_chunks": { + "type": "boolean", + "description": "Set slim_chunks to true to avoid returning the content and chunk_html of the chunks. This is useful for when you want to reduce amount of data over the wire for latency improvement. Default is false.", + "nullable": true + }, "use_weights": { "type": "boolean", "description": "Set use_weights to true to use the weights of the chunks in the result set in order to sort them. If not specified, this defaults to true.", @@ -6067,6 +6420,16 @@ } } }, + "SearchWithinGroupResponseTypes": { + "oneOf": [ + { + "$ref": "#/components/schemas/SearchGroupsResult" + }, + { + "$ref": "#/components/schemas/SearchGroupSlimChunksResult" + } + ] + }, "SetUserApiKeyRequest": { "type": "object", "required": [ @@ -6140,6 +6503,73 @@ "pos_in_queue": 1 } }, + "SlimChunkMetadata": { + "type": "object", + "required": [ + "id", + "created_at", + "updated_at", + "weight" + ], + "properties": { + "created_at": { + "type": "string", + "format": "date-time" + }, + "id": { + "type": "string", + "format": "uuid" + }, + "link": { + "type": "string", + "nullable": true + }, + "metadata": { + "nullable": true + }, + "qdrant_point_id": { + "type": "string", + "format": "uuid", + "nullable": true + }, + "tag_set": { + "type": "string", + "nullable": true + }, + "time_stamp": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "tracking_id": { + "type": "string", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "weight": { + "type": "number", + "format": "double" + } + }, + "example": { + "created_at": "2021-01-01T00:00:00", + "dataset_id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3", + "id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3", + "link": "https://trieve.ai", + "metadata": { + "key": "value" + }, + "qdrant_point_id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3", + "tag_set": "tag1,tag2", + "time_stamp": "2021-01-01T00:00:00", + "tracking_id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3", + "updated_at": "2021-01-01T00:00:00", + "weight": 0.5 + } + }, "SlimGroup": { "type": "object", "required": [ @@ -6176,7 +6606,6 @@ "required": [ "id", "email", - "visible_email", "user_orgs", "orgs" ], @@ -6203,17 +6632,6 @@ "items": { "$ref": "#/components/schemas/UserOrganization" } - }, - "username": { - "type": "string", - "nullable": true - }, - "visible_email": { - "type": "boolean" - }, - "website": { - "type": "string", - "nullable": true } }, "example": { @@ -6238,10 +6656,7 @@ "updated_at": "2021-01-01T00:00:00", "user_id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3" } - ], - "username": "trieve", - "visible_email": true, - "website": "https://trieve.ai" + ] } }, "StripePlan": { @@ -6486,6 +6901,14 @@ "description": "The metadata is a JSON object which can be used to filter chunks. This is useful for when you want to filter chunks by arbitrary metadata. Unlike with tag filtering, there is a performance hit for filtering on metadata. If no metadata is provided, the existing metadata will be used.", "nullable": true }, + "tag_set": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Tag set is a list of tags. This can be used to filter chunks by tag. Unlike with metadata filtering, HNSW indices will exist for each tag such that there is not a performance hit for filtering on them. If no tag_set is provided, the existing tag_set will be used.", + "nullable": true + }, "time_stamp": { "type": "string", "description": "Time_stamp should be an ISO 8601 combined date and time without timezone. It is used for time window filtering and recency-biasing search results. If no time_stamp is provided, the existing time_stamp will be used.", @@ -6661,21 +7084,6 @@ "format": "uuid", "description": "The id of the user to update, if not provided, the auth'ed user will be updated. If provided, the auth'ed user must be an admin (1) or owner (2) of the organization.", "nullable": true - }, - "username": { - "type": "string", - "description": "The new username to assign to the user, if not provided, the current username will be used.", - "nullable": true - }, - "visible_email": { - "type": "boolean", - "description": "Determines if the user's email is visible to other users, if not provided, the current value will be used.", - "nullable": true - }, - "website": { - "type": "string", - "description": "The new website to assign to the user, if not provided, the current website will be used. Used for linking to the user's personal or company website.", - "nullable": true } } }, diff --git a/pyproject.toml b/pyproject.toml index 8180dcb..da56d8b 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "trieve_python_client" -version = "0.5.0" +version = "0.5.5" description = "Trieve API" authors = ["Trieve Team "] license = "BSL" diff --git a/setup.py b/setup.py index a55fe20..9963d7b 100644 --- a/setup.py +++ b/setup.py @@ -5,7 +5,7 @@ Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API. - The version of the OpenAPI document: 0.5.0 + The version of the OpenAPI document: 0.5.5 Contact: developers@trieve.ai Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -22,7 +22,7 @@ # prerequisite: setuptools # http://pypi.python.org/pypi/setuptools NAME = "trieve_python_client" -VERSION = "0.5.0" +VERSION = "0.5.5" PYTHON_REQUIRES = ">=3.7" REQUIRES = [ "urllib3 >= 1.25.3, < 2.1.0", diff --git a/trieve_python_client/__init__.py b/trieve_python_client/__init__.py index ae139e2..aef1215 100644 --- a/trieve_python_client/__init__.py +++ b/trieve_python_client/__init__.py @@ -7,7 +7,7 @@ Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API. - The version of the OpenAPI document: 0.5.0 + The version of the OpenAPI document: 0.5.5 Contact: developers@trieve.ai Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -15,7 +15,7 @@ """ # noqa: E501 -__version__ = "0.5.0" +__version__ = "0.5.5" # import apis into sdk package from trieve_python_client.api.auth_api import AuthApi @@ -83,6 +83,7 @@ from trieve_python_client.models.get_groups_for_chunks_data import GetGroupsForChunksData from trieve_python_client.models.group_data import GroupData from trieve_python_client.models.group_score_chunk_dto import GroupScoreChunkDTO +from trieve_python_client.models.group_slim_chunks_dto import GroupSlimChunksDTO from trieve_python_client.models.invitation_data import InvitationData from trieve_python_client.models.match_condition import MatchCondition from trieve_python_client.models.message import Message @@ -91,18 +92,28 @@ from trieve_python_client.models.range import Range from trieve_python_client.models.reccomend_group_chunks_request import ReccomendGroupChunksRequest from trieve_python_client.models.recommend_chunks_request import RecommendChunksRequest +from trieve_python_client.models.recommend_chunks_response_types import RecommendChunksResponseTypes +from trieve_python_client.models.recommend_group_chunk_response_types import RecommendGroupChunkResponseTypes from trieve_python_client.models.regenerate_message_data import RegenerateMessageData from trieve_python_client.models.return_queued_chunk import ReturnQueuedChunk from trieve_python_client.models.score_chunk_dto import ScoreChunkDTO +from trieve_python_client.models.score_slim_chunks import ScoreSlimChunks from trieve_python_client.models.search_chunk_data import SearchChunkData from trieve_python_client.models.search_chunk_query_response_body import SearchChunkQueryResponseBody +from trieve_python_client.models.search_chunk_response_types import SearchChunkResponseTypes +from trieve_python_client.models.search_group_slim_chunks_result import SearchGroupSlimChunksResult from trieve_python_client.models.search_groups_result import SearchGroupsResult from trieve_python_client.models.search_over_groups_data import SearchOverGroupsData from trieve_python_client.models.search_over_groups_response_body import SearchOverGroupsResponseBody +from trieve_python_client.models.search_over_groups_response_types import SearchOverGroupsResponseTypes +from trieve_python_client.models.search_over_groups_slim_chunks_response_body import SearchOverGroupsSlimChunksResponseBody +from trieve_python_client.models.search_slim_chunk_query_response_body import SearchSlimChunkQueryResponseBody from trieve_python_client.models.search_within_group_data import SearchWithinGroupData +from trieve_python_client.models.search_within_group_response_types import SearchWithinGroupResponseTypes from trieve_python_client.models.set_user_api_key_request import SetUserApiKeyRequest from trieve_python_client.models.set_user_api_key_response import SetUserApiKeyResponse from trieve_python_client.models.single_queued_chunk_response import SingleQueuedChunkResponse +from trieve_python_client.models.slim_chunk_metadata import SlimChunkMetadata from trieve_python_client.models.slim_group import SlimGroup from trieve_python_client.models.slim_user import SlimUser from trieve_python_client.models.stripe_plan import StripePlan diff --git a/trieve_python_client/api/auth_api.py b/trieve_python_client/api/auth_api.py index a0f3ffd..65fa9c6 100644 --- a/trieve_python_client/api/auth_api.py +++ b/trieve_python_client/api/auth_api.py @@ -5,7 +5,7 @@ Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API. - The version of the OpenAPI document: 0.5.0 + The version of the OpenAPI document: 0.5.5 Contact: developers@trieve.ai Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/trieve_python_client/api/chunk_api.py b/trieve_python_client/api/chunk_api.py index b1fbe13..2953307 100644 --- a/trieve_python_client/api/chunk_api.py +++ b/trieve_python_client/api/chunk_api.py @@ -5,7 +5,7 @@ Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API. - The version of the OpenAPI document: 0.5.0 + The version of the OpenAPI document: 0.5.5 Contact: developers@trieve.ai Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -20,13 +20,13 @@ from pydantic import Field, StrictStr from typing_extensions import Annotated from trieve_python_client.models.chunk_metadata import ChunkMetadata -from trieve_python_client.models.chunk_metadata_with_file_data import ChunkMetadataWithFileData from trieve_python_client.models.create_chunk_data import CreateChunkData from trieve_python_client.models.generate_chunks_request import GenerateChunksRequest from trieve_python_client.models.recommend_chunks_request import RecommendChunksRequest +from trieve_python_client.models.recommend_chunks_response_types import RecommendChunksResponseTypes from trieve_python_client.models.return_queued_chunk import ReturnQueuedChunk from trieve_python_client.models.search_chunk_data import SearchChunkData -from trieve_python_client.models.search_chunk_query_response_body import SearchChunkQueryResponseBody +from trieve_python_client.models.search_chunk_response_types import SearchChunkResponseTypes from trieve_python_client.models.suggested_queries_request import SuggestedQueriesRequest from trieve_python_client.models.suggested_queries_response import SuggestedQueriesResponse from trieve_python_client.models.update_chunk_by_tracking_id_data import UpdateChunkByTrackingIdData @@ -2042,7 +2042,7 @@ def get_recommended_chunks( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> List[ChunkMetadataWithFileData]: + ) -> RecommendChunksResponseTypes: """Get Recommended Chunks Get Recommended Chunks Get recommendations of chunks similar to the chunks in the request. Think about this as a feature similar to the \"add to playlist\" recommendation feature on Spotify. This request pairs especially well with our groups endpoint. @@ -2083,7 +2083,7 @@ def get_recommended_chunks( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "List[ChunkMetadataWithFileData]", + '200': "RecommendChunksResponseTypes", '400': "ErrorResponseBody", } response_data = self.api_client.call_api( @@ -2114,7 +2114,7 @@ def get_recommended_chunks_with_http_info( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> ApiResponse[List[ChunkMetadataWithFileData]]: + ) -> ApiResponse[RecommendChunksResponseTypes]: """Get Recommended Chunks Get Recommended Chunks Get recommendations of chunks similar to the chunks in the request. Think about this as a feature similar to the \"add to playlist\" recommendation feature on Spotify. This request pairs especially well with our groups endpoint. @@ -2155,7 +2155,7 @@ def get_recommended_chunks_with_http_info( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "List[ChunkMetadataWithFileData]", + '200': "RecommendChunksResponseTypes", '400': "ErrorResponseBody", } response_data = self.api_client.call_api( @@ -2227,7 +2227,7 @@ def get_recommended_chunks_without_preload_content( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "List[ChunkMetadataWithFileData]", + '200': "RecommendChunksResponseTypes", '400': "ErrorResponseBody", } response_data = self.api_client.call_api( @@ -2331,7 +2331,7 @@ def search_chunk( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> SearchChunkQueryResponseBody: + ) -> SearchChunkResponseTypes: """Search Search This route provides the primary search functionality for the API. It can be used to search for chunks by semantic similarity, full-text similarity, or a combination of both. Results' `chunk_html` values will be modified with `` tags for sub-sentence highlighting. @@ -2372,7 +2372,7 @@ def search_chunk( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "SearchChunkQueryResponseBody", + '200': "SearchChunkResponseTypes", '400': "ErrorResponseBody", } response_data = self.api_client.call_api( @@ -2403,7 +2403,7 @@ def search_chunk_with_http_info( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> ApiResponse[SearchChunkQueryResponseBody]: + ) -> ApiResponse[SearchChunkResponseTypes]: """Search Search This route provides the primary search functionality for the API. It can be used to search for chunks by semantic similarity, full-text similarity, or a combination of both. Results' `chunk_html` values will be modified with `` tags for sub-sentence highlighting. @@ -2444,7 +2444,7 @@ def search_chunk_with_http_info( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "SearchChunkQueryResponseBody", + '200': "SearchChunkResponseTypes", '400': "ErrorResponseBody", } response_data = self.api_client.call_api( @@ -2516,7 +2516,7 @@ def search_chunk_without_preload_content( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "SearchChunkQueryResponseBody", + '200': "SearchChunkResponseTypes", '400': "ErrorResponseBody", } response_data = self.api_client.call_api( diff --git a/trieve_python_client/api/chunk_group_api.py b/trieve_python_client/api/chunk_group_api.py index 537ab69..1557b63 100644 --- a/trieve_python_client/api/chunk_group_api.py +++ b/trieve_python_client/api/chunk_group_api.py @@ -5,7 +5,7 @@ Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API. - The version of the OpenAPI document: 0.5.0 + The version of the OpenAPI document: 0.5.5 Contact: developers@trieve.ai Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -27,12 +27,12 @@ from trieve_python_client.models.create_chunk_group_data import CreateChunkGroupData from trieve_python_client.models.get_groups_for_chunks_data import GetGroupsForChunksData from trieve_python_client.models.group_data import GroupData -from trieve_python_client.models.group_score_chunk_dto import GroupScoreChunkDTO from trieve_python_client.models.reccomend_group_chunks_request import ReccomendGroupChunksRequest -from trieve_python_client.models.search_groups_result import SearchGroupsResult +from trieve_python_client.models.recommend_group_chunk_response_types import RecommendGroupChunkResponseTypes from trieve_python_client.models.search_over_groups_data import SearchOverGroupsData -from trieve_python_client.models.search_over_groups_response_body import SearchOverGroupsResponseBody +from trieve_python_client.models.search_over_groups_response_types import SearchOverGroupsResponseTypes from trieve_python_client.models.search_within_group_data import SearchWithinGroupData +from trieve_python_client.models.search_within_group_response_types import SearchWithinGroupResponseTypes from trieve_python_client.models.update_chunk_group_data import UpdateChunkGroupData from trieve_python_client.models.update_group_by_tracking_id_data import UpdateGroupByTrackingIDData @@ -2960,7 +2960,7 @@ def get_recommended_groups( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> List[GroupScoreChunkDTO]: + ) -> RecommendGroupChunkResponseTypes: """Get Recommended Groups Get Recommended Groups Route to get recommended groups. This route will return groups which are similar to the groups in the request body. @@ -3001,7 +3001,7 @@ def get_recommended_groups( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "List[GroupScoreChunkDTO]", + '200': "RecommendGroupChunkResponseTypes", '400': "ErrorResponseBody", } response_data = self.api_client.call_api( @@ -3032,7 +3032,7 @@ def get_recommended_groups_with_http_info( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> ApiResponse[List[GroupScoreChunkDTO]]: + ) -> ApiResponse[RecommendGroupChunkResponseTypes]: """Get Recommended Groups Get Recommended Groups Route to get recommended groups. This route will return groups which are similar to the groups in the request body. @@ -3073,7 +3073,7 @@ def get_recommended_groups_with_http_info( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "List[GroupScoreChunkDTO]", + '200': "RecommendGroupChunkResponseTypes", '400': "ErrorResponseBody", } response_data = self.api_client.call_api( @@ -3145,7 +3145,7 @@ def get_recommended_groups_without_preload_content( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "List[GroupScoreChunkDTO]", + '200': "RecommendGroupChunkResponseTypes", '400': "ErrorResponseBody", } response_data = self.api_client.call_api( @@ -3830,6 +3830,7 @@ def _remove_chunk_from_group_serialize( @validate_call def search_over_groups( self, + tr_dataset: Annotated[StrictStr, Field(description="The dataset id to use for the request")], search_over_groups_data: Annotated[SearchOverGroupsData, Field(description="JSON request payload to semantically search over groups")], _request_timeout: Union[ None, @@ -3843,11 +3844,13 @@ def search_over_groups( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> SearchOverGroupsResponseBody: + ) -> SearchOverGroupsResponseTypes: """Search Over Groups Search Over Groups This route allows you to get groups as results instead of chunks. Each group returned will have the matching chunks sorted by similarity within the group. This is useful for when you want to get groups of chunks which are similar to the search query. If choosing hybrid search, the results will be re-ranked using BAAI/bge-reranker-large. Compatible with semantic, fulltext, or hybrid search modes. + :param tr_dataset: The dataset id to use for the request (required) + :type tr_dataset: str :param search_over_groups_data: JSON request payload to semantically search over groups (required) :type search_over_groups_data: SearchOverGroupsData :param _request_timeout: timeout setting for this request. If one @@ -3873,6 +3876,7 @@ def search_over_groups( """ # noqa: E501 _param = self._search_over_groups_serialize( + tr_dataset=tr_dataset, search_over_groups_data=search_over_groups_data, _request_auth=_request_auth, _content_type=_content_type, @@ -3881,7 +3885,7 @@ def search_over_groups( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "SearchOverGroupsResponseBody", + '200': "SearchOverGroupsResponseTypes", '400': "ErrorResponseBody", } response_data = self.api_client.call_api( @@ -3898,6 +3902,7 @@ def search_over_groups( @validate_call def search_over_groups_with_http_info( self, + tr_dataset: Annotated[StrictStr, Field(description="The dataset id to use for the request")], search_over_groups_data: Annotated[SearchOverGroupsData, Field(description="JSON request payload to semantically search over groups")], _request_timeout: Union[ None, @@ -3911,11 +3916,13 @@ def search_over_groups_with_http_info( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> ApiResponse[SearchOverGroupsResponseBody]: + ) -> ApiResponse[SearchOverGroupsResponseTypes]: """Search Over Groups Search Over Groups This route allows you to get groups as results instead of chunks. Each group returned will have the matching chunks sorted by similarity within the group. This is useful for when you want to get groups of chunks which are similar to the search query. If choosing hybrid search, the results will be re-ranked using BAAI/bge-reranker-large. Compatible with semantic, fulltext, or hybrid search modes. + :param tr_dataset: The dataset id to use for the request (required) + :type tr_dataset: str :param search_over_groups_data: JSON request payload to semantically search over groups (required) :type search_over_groups_data: SearchOverGroupsData :param _request_timeout: timeout setting for this request. If one @@ -3941,6 +3948,7 @@ def search_over_groups_with_http_info( """ # noqa: E501 _param = self._search_over_groups_serialize( + tr_dataset=tr_dataset, search_over_groups_data=search_over_groups_data, _request_auth=_request_auth, _content_type=_content_type, @@ -3949,7 +3957,7 @@ def search_over_groups_with_http_info( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "SearchOverGroupsResponseBody", + '200': "SearchOverGroupsResponseTypes", '400': "ErrorResponseBody", } response_data = self.api_client.call_api( @@ -3966,6 +3974,7 @@ def search_over_groups_with_http_info( @validate_call def search_over_groups_without_preload_content( self, + tr_dataset: Annotated[StrictStr, Field(description="The dataset id to use for the request")], search_over_groups_data: Annotated[SearchOverGroupsData, Field(description="JSON request payload to semantically search over groups")], _request_timeout: Union[ None, @@ -3984,6 +3993,8 @@ def search_over_groups_without_preload_content( Search Over Groups This route allows you to get groups as results instead of chunks. Each group returned will have the matching chunks sorted by similarity within the group. This is useful for when you want to get groups of chunks which are similar to the search query. If choosing hybrid search, the results will be re-ranked using BAAI/bge-reranker-large. Compatible with semantic, fulltext, or hybrid search modes. + :param tr_dataset: The dataset id to use for the request (required) + :type tr_dataset: str :param search_over_groups_data: JSON request payload to semantically search over groups (required) :type search_over_groups_data: SearchOverGroupsData :param _request_timeout: timeout setting for this request. If one @@ -4009,6 +4020,7 @@ def search_over_groups_without_preload_content( """ # noqa: E501 _param = self._search_over_groups_serialize( + tr_dataset=tr_dataset, search_over_groups_data=search_over_groups_data, _request_auth=_request_auth, _content_type=_content_type, @@ -4017,7 +4029,7 @@ def search_over_groups_without_preload_content( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "SearchOverGroupsResponseBody", + '200': "SearchOverGroupsResponseTypes", '400': "ErrorResponseBody", } response_data = self.api_client.call_api( @@ -4029,6 +4041,7 @@ def search_over_groups_without_preload_content( def _search_over_groups_serialize( self, + tr_dataset, search_over_groups_data, _request_auth, _content_type, @@ -4051,6 +4064,8 @@ def _search_over_groups_serialize( # process the path parameters # process the query parameters # process the header parameters + if tr_dataset is not None: + _header_params['TR-Dataset'] = tr_dataset # process the form parameters # process the body parameter if search_over_groups_data is not None: @@ -4080,6 +4095,7 @@ def _search_over_groups_serialize( # authentication setting _auth_settings: List[str] = [ + 'ApiKey' ] return self.api_client.param_serialize( @@ -4117,7 +4133,7 @@ def search_within_group( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> SearchGroupsResult: + ) -> SearchWithinGroupResponseTypes: """Search Within Group Search Within Group This route allows you to search only within a group. This is useful for when you only want search results to contain chunks which are members of a specific group. If choosing hybrid search, the results will be re-ranked using BAAI/bge-reranker-large. @@ -4158,7 +4174,7 @@ def search_within_group( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "SearchGroupsResult", + '200': "SearchWithinGroupResponseTypes", '400': "ErrorResponseBody", } response_data = self.api_client.call_api( @@ -4189,7 +4205,7 @@ def search_within_group_with_http_info( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> ApiResponse[SearchGroupsResult]: + ) -> ApiResponse[SearchWithinGroupResponseTypes]: """Search Within Group Search Within Group This route allows you to search only within a group. This is useful for when you only want search results to contain chunks which are members of a specific group. If choosing hybrid search, the results will be re-ranked using BAAI/bge-reranker-large. @@ -4230,7 +4246,7 @@ def search_within_group_with_http_info( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "SearchGroupsResult", + '200': "SearchWithinGroupResponseTypes", '400': "ErrorResponseBody", } response_data = self.api_client.call_api( @@ -4302,7 +4318,7 @@ def search_within_group_without_preload_content( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "SearchGroupsResult", + '200': "SearchWithinGroupResponseTypes", '400': "ErrorResponseBody", } response_data = self.api_client.call_api( diff --git a/trieve_python_client/api/dataset_api.py b/trieve_python_client/api/dataset_api.py index 808a512..73057d4 100644 --- a/trieve_python_client/api/dataset_api.py +++ b/trieve_python_client/api/dataset_api.py @@ -5,7 +5,7 @@ Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API. - The version of the OpenAPI document: 0.5.0 + The version of the OpenAPI document: 0.5.5 Contact: developers@trieve.ai Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/trieve_python_client/api/events_api.py b/trieve_python_client/api/events_api.py index 85daf10..8bb5f1b 100644 --- a/trieve_python_client/api/events_api.py +++ b/trieve_python_client/api/events_api.py @@ -5,7 +5,7 @@ Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API. - The version of the OpenAPI document: 0.5.0 + The version of the OpenAPI document: 0.5.5 Contact: developers@trieve.ai Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/trieve_python_client/api/file_api.py b/trieve_python_client/api/file_api.py index 537d7b1..54c4cf3 100644 --- a/trieve_python_client/api/file_api.py +++ b/trieve_python_client/api/file_api.py @@ -5,7 +5,7 @@ Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API. - The version of the OpenAPI document: 0.5.0 + The version of the OpenAPI document: 0.5.5 Contact: developers@trieve.ai Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/trieve_python_client/api/health_api.py b/trieve_python_client/api/health_api.py index a41a1ad..ab0cb77 100644 --- a/trieve_python_client/api/health_api.py +++ b/trieve_python_client/api/health_api.py @@ -5,7 +5,7 @@ Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API. - The version of the OpenAPI document: 0.5.0 + The version of the OpenAPI document: 0.5.5 Contact: developers@trieve.ai Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/trieve_python_client/api/invitation_api.py b/trieve_python_client/api/invitation_api.py index c35754c..432a6b1 100644 --- a/trieve_python_client/api/invitation_api.py +++ b/trieve_python_client/api/invitation_api.py @@ -5,7 +5,7 @@ Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API. - The version of the OpenAPI document: 0.5.0 + The version of the OpenAPI document: 0.5.5 Contact: developers@trieve.ai Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/trieve_python_client/api/message_api.py b/trieve_python_client/api/message_api.py index abde566..97e4d29 100644 --- a/trieve_python_client/api/message_api.py +++ b/trieve_python_client/api/message_api.py @@ -5,7 +5,7 @@ Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API. - The version of the OpenAPI document: 0.5.0 + The version of the OpenAPI document: 0.5.5 Contact: developers@trieve.ai Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/trieve_python_client/api/organization_api.py b/trieve_python_client/api/organization_api.py index 2a41ef2..367115e 100644 --- a/trieve_python_client/api/organization_api.py +++ b/trieve_python_client/api/organization_api.py @@ -5,7 +5,7 @@ Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API. - The version of the OpenAPI document: 0.5.0 + The version of the OpenAPI document: 0.5.5 Contact: developers@trieve.ai Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/trieve_python_client/api/stripe_api.py b/trieve_python_client/api/stripe_api.py index 00ee9e1..7632696 100644 --- a/trieve_python_client/api/stripe_api.py +++ b/trieve_python_client/api/stripe_api.py @@ -5,7 +5,7 @@ Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API. - The version of the OpenAPI document: 0.5.0 + The version of the OpenAPI document: 0.5.5 Contact: developers@trieve.ai Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/trieve_python_client/api/topic_api.py b/trieve_python_client/api/topic_api.py index 41f7f86..9b8262b 100644 --- a/trieve_python_client/api/topic_api.py +++ b/trieve_python_client/api/topic_api.py @@ -5,7 +5,7 @@ Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API. - The version of the OpenAPI document: 0.5.0 + The version of the OpenAPI document: 0.5.5 Contact: developers@trieve.ai Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/trieve_python_client/api/user_api.py b/trieve_python_client/api/user_api.py index bd23e18..4ed720b 100644 --- a/trieve_python_client/api/user_api.py +++ b/trieve_python_client/api/user_api.py @@ -5,7 +5,7 @@ Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API. - The version of the OpenAPI document: 0.5.0 + The version of the OpenAPI document: 0.5.5 Contact: developers@trieve.ai Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/trieve_python_client/api_client.py b/trieve_python_client/api_client.py index a71e8a6..a64b74b 100644 --- a/trieve_python_client/api_client.py +++ b/trieve_python_client/api_client.py @@ -5,7 +5,7 @@ Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API. - The version of the OpenAPI document: 0.5.0 + The version of the OpenAPI document: 0.5.5 Contact: developers@trieve.ai Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -88,7 +88,7 @@ def __init__( self.default_headers[header_name] = header_value self.cookie = cookie # Set default User-Agent. - self.user_agent = 'OpenAPI-Generator/0.5.0/python' + self.user_agent = 'OpenAPI-Generator/0.5.5/python' self.client_side_validation = configuration.client_side_validation def __enter__(self): diff --git a/trieve_python_client/configuration.py b/trieve_python_client/configuration.py index 12e6151..8ce00a0 100644 --- a/trieve_python_client/configuration.py +++ b/trieve_python_client/configuration.py @@ -5,7 +5,7 @@ Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API. - The version of the OpenAPI document: 0.5.0 + The version of the OpenAPI document: 0.5.5 Contact: developers@trieve.ai Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -90,7 +90,7 @@ def __init__(self, host=None, ) -> None: """Constructor """ - self._base_path = "http://localhost:8090" if host is None else host + self._base_path = "https://api.trieve.ai" if host is None else host """Default Base url """ self.server_index = 0 if server_index is None and host is None else server_index @@ -399,8 +399,8 @@ def to_debug_report(self): return "Python SDK Debug Report:\n"\ "OS: {env}\n"\ "Python Version: {pyversion}\n"\ - "Version of the API: 0.5.0\n"\ - "SDK Package Version: 0.5.0".\ + "Version of the API: 0.5.5\n"\ + "SDK Package Version: 0.5.5".\ format(env=sys.platform, pyversion=sys.version) def get_host_settings(self): @@ -409,13 +409,13 @@ def get_host_settings(self): :return: An array of host settings """ return [ - { - 'url': "http://localhost:8090", - 'description': "Local development server", - }, { 'url': "https://api.trieve.ai", 'description': "Production server", + }, + { + 'url': "http://localhost:8090", + 'description': "Local development server", } ] diff --git a/trieve_python_client/exceptions.py b/trieve_python_client/exceptions.py index 12bd6d0..9cd103d 100644 --- a/trieve_python_client/exceptions.py +++ b/trieve_python_client/exceptions.py @@ -5,7 +5,7 @@ Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API. - The version of the OpenAPI document: 0.5.0 + The version of the OpenAPI document: 0.5.5 Contact: developers@trieve.ai Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/trieve_python_client/models/__init__.py b/trieve_python_client/models/__init__.py index 8ec7881..7792d1e 100644 --- a/trieve_python_client/models/__init__.py +++ b/trieve_python_client/models/__init__.py @@ -6,7 +6,7 @@ Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API. - The version of the OpenAPI document: 0.5.0 + The version of the OpenAPI document: 0.5.5 Contact: developers@trieve.ai Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -54,6 +54,7 @@ from trieve_python_client.models.get_groups_for_chunks_data import GetGroupsForChunksData from trieve_python_client.models.group_data import GroupData from trieve_python_client.models.group_score_chunk_dto import GroupScoreChunkDTO +from trieve_python_client.models.group_slim_chunks_dto import GroupSlimChunksDTO from trieve_python_client.models.invitation_data import InvitationData from trieve_python_client.models.match_condition import MatchCondition from trieve_python_client.models.message import Message @@ -62,18 +63,28 @@ from trieve_python_client.models.range import Range from trieve_python_client.models.reccomend_group_chunks_request import ReccomendGroupChunksRequest from trieve_python_client.models.recommend_chunks_request import RecommendChunksRequest +from trieve_python_client.models.recommend_chunks_response_types import RecommendChunksResponseTypes +from trieve_python_client.models.recommend_group_chunk_response_types import RecommendGroupChunkResponseTypes from trieve_python_client.models.regenerate_message_data import RegenerateMessageData from trieve_python_client.models.return_queued_chunk import ReturnQueuedChunk from trieve_python_client.models.score_chunk_dto import ScoreChunkDTO +from trieve_python_client.models.score_slim_chunks import ScoreSlimChunks from trieve_python_client.models.search_chunk_data import SearchChunkData from trieve_python_client.models.search_chunk_query_response_body import SearchChunkQueryResponseBody +from trieve_python_client.models.search_chunk_response_types import SearchChunkResponseTypes +from trieve_python_client.models.search_group_slim_chunks_result import SearchGroupSlimChunksResult from trieve_python_client.models.search_groups_result import SearchGroupsResult from trieve_python_client.models.search_over_groups_data import SearchOverGroupsData from trieve_python_client.models.search_over_groups_response_body import SearchOverGroupsResponseBody +from trieve_python_client.models.search_over_groups_response_types import SearchOverGroupsResponseTypes +from trieve_python_client.models.search_over_groups_slim_chunks_response_body import SearchOverGroupsSlimChunksResponseBody +from trieve_python_client.models.search_slim_chunk_query_response_body import SearchSlimChunkQueryResponseBody from trieve_python_client.models.search_within_group_data import SearchWithinGroupData +from trieve_python_client.models.search_within_group_response_types import SearchWithinGroupResponseTypes from trieve_python_client.models.set_user_api_key_request import SetUserApiKeyRequest from trieve_python_client.models.set_user_api_key_response import SetUserApiKeyResponse from trieve_python_client.models.single_queued_chunk_response import SingleQueuedChunkResponse +from trieve_python_client.models.slim_chunk_metadata import SlimChunkMetadata from trieve_python_client.models.slim_group import SlimGroup from trieve_python_client.models.slim_user import SlimUser from trieve_python_client.models.stripe_plan import StripePlan diff --git a/trieve_python_client/models/add_chunk_to_group_data.py b/trieve_python_client/models/add_chunk_to_group_data.py index a3baf60..5d13456 100644 --- a/trieve_python_client/models/add_chunk_to_group_data.py +++ b/trieve_python_client/models/add_chunk_to_group_data.py @@ -5,7 +5,7 @@ Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API. - The version of the OpenAPI document: 0.5.0 + The version of the OpenAPI document: 0.5.5 Contact: developers@trieve.ai Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/trieve_python_client/models/api_key_dto.py b/trieve_python_client/models/api_key_dto.py index dbd7a26..47777dd 100644 --- a/trieve_python_client/models/api_key_dto.py +++ b/trieve_python_client/models/api_key_dto.py @@ -5,7 +5,7 @@ Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API. - The version of the OpenAPI document: 0.5.0 + The version of the OpenAPI document: 0.5.5 Contact: developers@trieve.ai Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/trieve_python_client/models/auth_query.py b/trieve_python_client/models/auth_query.py index 2aa068b..85a53ae 100644 --- a/trieve_python_client/models/auth_query.py +++ b/trieve_python_client/models/auth_query.py @@ -5,7 +5,7 @@ Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API. - The version of the OpenAPI document: 0.5.0 + The version of the OpenAPI document: 0.5.5 Contact: developers@trieve.ai Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/trieve_python_client/models/batch_queued_chunk_response.py b/trieve_python_client/models/batch_queued_chunk_response.py index 3f8391b..db6a4f1 100644 --- a/trieve_python_client/models/batch_queued_chunk_response.py +++ b/trieve_python_client/models/batch_queued_chunk_response.py @@ -5,7 +5,7 @@ Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API. - The version of the OpenAPI document: 0.5.0 + The version of the OpenAPI document: 0.5.5 Contact: developers@trieve.ai Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/trieve_python_client/models/bookmark_data.py b/trieve_python_client/models/bookmark_data.py index 1601a80..a126fb5 100644 --- a/trieve_python_client/models/bookmark_data.py +++ b/trieve_python_client/models/bookmark_data.py @@ -5,7 +5,7 @@ Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API. - The version of the OpenAPI document: 0.5.0 + The version of the OpenAPI document: 0.5.5 Contact: developers@trieve.ai Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/trieve_python_client/models/bookmark_group_result.py b/trieve_python_client/models/bookmark_group_result.py index 3350ac9..fb1b12f 100644 --- a/trieve_python_client/models/bookmark_group_result.py +++ b/trieve_python_client/models/bookmark_group_result.py @@ -5,7 +5,7 @@ Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API. - The version of the OpenAPI document: 0.5.0 + The version of the OpenAPI document: 0.5.5 Contact: developers@trieve.ai Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/trieve_python_client/models/chat_message_proxy.py b/trieve_python_client/models/chat_message_proxy.py index 5664bd9..0126a76 100644 --- a/trieve_python_client/models/chat_message_proxy.py +++ b/trieve_python_client/models/chat_message_proxy.py @@ -5,7 +5,7 @@ Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API. - The version of the OpenAPI document: 0.5.0 + The version of the OpenAPI document: 0.5.5 Contact: developers@trieve.ai Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/trieve_python_client/models/chunk_data.py b/trieve_python_client/models/chunk_data.py index 1d63c79..34bfae9 100644 --- a/trieve_python_client/models/chunk_data.py +++ b/trieve_python_client/models/chunk_data.py @@ -5,7 +5,7 @@ Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API. - The version of the OpenAPI document: 0.5.0 + The version of the OpenAPI document: 0.5.5 Contact: developers@trieve.ai Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/trieve_python_client/models/chunk_filter.py b/trieve_python_client/models/chunk_filter.py index 61156b3..3da51db 100644 --- a/trieve_python_client/models/chunk_filter.py +++ b/trieve_python_client/models/chunk_filter.py @@ -5,7 +5,7 @@ Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API. - The version of the OpenAPI document: 0.5.0 + The version of the OpenAPI document: 0.5.5 Contact: developers@trieve.ai Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/trieve_python_client/models/chunk_group.py b/trieve_python_client/models/chunk_group.py index 4d99e67..6561f41 100644 --- a/trieve_python_client/models/chunk_group.py +++ b/trieve_python_client/models/chunk_group.py @@ -5,7 +5,7 @@ Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API. - The version of the OpenAPI document: 0.5.0 + The version of the OpenAPI document: 0.5.5 Contact: developers@trieve.ai Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/trieve_python_client/models/chunk_group_and_file.py b/trieve_python_client/models/chunk_group_and_file.py index 5919b9d..d6e767f 100644 --- a/trieve_python_client/models/chunk_group_and_file.py +++ b/trieve_python_client/models/chunk_group_and_file.py @@ -5,7 +5,7 @@ Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API. - The version of the OpenAPI document: 0.5.0 + The version of the OpenAPI document: 0.5.5 Contact: developers@trieve.ai Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/trieve_python_client/models/chunk_metadata.py b/trieve_python_client/models/chunk_metadata.py index 1251fd3..09c357d 100644 --- a/trieve_python_client/models/chunk_metadata.py +++ b/trieve_python_client/models/chunk_metadata.py @@ -5,7 +5,7 @@ Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API. - The version of the OpenAPI document: 0.5.0 + The version of the OpenAPI document: 0.5.5 Contact: developers@trieve.ai Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/trieve_python_client/models/chunk_metadata_with_file_data.py b/trieve_python_client/models/chunk_metadata_with_file_data.py index 739ca47..b5a7653 100644 --- a/trieve_python_client/models/chunk_metadata_with_file_data.py +++ b/trieve_python_client/models/chunk_metadata_with_file_data.py @@ -5,7 +5,7 @@ Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API. - The version of the OpenAPI document: 0.5.0 + The version of the OpenAPI document: 0.5.5 Contact: developers@trieve.ai Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/trieve_python_client/models/client_dataset_configuration.py b/trieve_python_client/models/client_dataset_configuration.py index 3590238..ae5d8ce 100644 --- a/trieve_python_client/models/client_dataset_configuration.py +++ b/trieve_python_client/models/client_dataset_configuration.py @@ -5,7 +5,7 @@ Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API. - The version of the OpenAPI document: 0.5.0 + The version of the OpenAPI document: 0.5.5 Contact: developers@trieve.ai Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/trieve_python_client/models/create_chunk_data.py b/trieve_python_client/models/create_chunk_data.py index 3d47acc..59aeccb 100644 --- a/trieve_python_client/models/create_chunk_data.py +++ b/trieve_python_client/models/create_chunk_data.py @@ -5,7 +5,7 @@ Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API. - The version of the OpenAPI document: 0.5.0 + The version of the OpenAPI document: 0.5.5 Contact: developers@trieve.ai Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/trieve_python_client/models/create_chunk_group_data.py b/trieve_python_client/models/create_chunk_group_data.py index 1341daf..af3cbe6 100644 --- a/trieve_python_client/models/create_chunk_group_data.py +++ b/trieve_python_client/models/create_chunk_group_data.py @@ -5,7 +5,7 @@ Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API. - The version of the OpenAPI document: 0.5.0 + The version of the OpenAPI document: 0.5.5 Contact: developers@trieve.ai Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/trieve_python_client/models/create_dataset_request.py b/trieve_python_client/models/create_dataset_request.py index 3caded3..8883ffe 100644 --- a/trieve_python_client/models/create_dataset_request.py +++ b/trieve_python_client/models/create_dataset_request.py @@ -5,7 +5,7 @@ Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API. - The version of the OpenAPI document: 0.5.0 + The version of the OpenAPI document: 0.5.5 Contact: developers@trieve.ai Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/trieve_python_client/models/create_message_data.py b/trieve_python_client/models/create_message_data.py index a49948e..a6baa0f 100644 --- a/trieve_python_client/models/create_message_data.py +++ b/trieve_python_client/models/create_message_data.py @@ -5,7 +5,7 @@ Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API. - The version of the OpenAPI document: 0.5.0 + The version of the OpenAPI document: 0.5.5 Contact: developers@trieve.ai Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/trieve_python_client/models/create_organization_data.py b/trieve_python_client/models/create_organization_data.py index 4c58907..81aef5f 100644 --- a/trieve_python_client/models/create_organization_data.py +++ b/trieve_python_client/models/create_organization_data.py @@ -5,7 +5,7 @@ Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API. - The version of the OpenAPI document: 0.5.0 + The version of the OpenAPI document: 0.5.5 Contact: developers@trieve.ai Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/trieve_python_client/models/create_topic_data.py b/trieve_python_client/models/create_topic_data.py index adcf0d8..13a03e5 100644 --- a/trieve_python_client/models/create_topic_data.py +++ b/trieve_python_client/models/create_topic_data.py @@ -5,7 +5,7 @@ Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API. - The version of the OpenAPI document: 0.5.0 + The version of the OpenAPI document: 0.5.5 Contact: developers@trieve.ai Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/trieve_python_client/models/dataset.py b/trieve_python_client/models/dataset.py index 3d10689..da2cfd1 100644 --- a/trieve_python_client/models/dataset.py +++ b/trieve_python_client/models/dataset.py @@ -5,7 +5,7 @@ Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API. - The version of the OpenAPI document: 0.5.0 + The version of the OpenAPI document: 0.5.5 Contact: developers@trieve.ai Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/trieve_python_client/models/dataset_and_usage.py b/trieve_python_client/models/dataset_and_usage.py index 3b61d12..4d38c99 100644 --- a/trieve_python_client/models/dataset_and_usage.py +++ b/trieve_python_client/models/dataset_and_usage.py @@ -5,7 +5,7 @@ Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API. - The version of the OpenAPI document: 0.5.0 + The version of the OpenAPI document: 0.5.5 Contact: developers@trieve.ai Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/trieve_python_client/models/dataset_dto.py b/trieve_python_client/models/dataset_dto.py index ba76c49..b8f4326 100644 --- a/trieve_python_client/models/dataset_dto.py +++ b/trieve_python_client/models/dataset_dto.py @@ -5,7 +5,7 @@ Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API. - The version of the OpenAPI document: 0.5.0 + The version of the OpenAPI document: 0.5.5 Contact: developers@trieve.ai Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/trieve_python_client/models/dataset_usage_count.py b/trieve_python_client/models/dataset_usage_count.py index 0e2452a..0813ce4 100644 --- a/trieve_python_client/models/dataset_usage_count.py +++ b/trieve_python_client/models/dataset_usage_count.py @@ -5,7 +5,7 @@ Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API. - The version of the OpenAPI document: 0.5.0 + The version of the OpenAPI document: 0.5.5 Contact: developers@trieve.ai Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/trieve_python_client/models/delete_dataset_request.py b/trieve_python_client/models/delete_dataset_request.py index e2a04d2..03e24c8 100644 --- a/trieve_python_client/models/delete_dataset_request.py +++ b/trieve_python_client/models/delete_dataset_request.py @@ -5,7 +5,7 @@ Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API. - The version of the OpenAPI document: 0.5.0 + The version of the OpenAPI document: 0.5.5 Contact: developers@trieve.ai Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/trieve_python_client/models/delete_topic_data.py b/trieve_python_client/models/delete_topic_data.py index a5eba76..3e3adb9 100644 --- a/trieve_python_client/models/delete_topic_data.py +++ b/trieve_python_client/models/delete_topic_data.py @@ -5,7 +5,7 @@ Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API. - The version of the OpenAPI document: 0.5.0 + The version of the OpenAPI document: 0.5.5 Contact: developers@trieve.ai Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/trieve_python_client/models/delete_user_api_key_request.py b/trieve_python_client/models/delete_user_api_key_request.py index 76933a7..a90ffaa 100644 --- a/trieve_python_client/models/delete_user_api_key_request.py +++ b/trieve_python_client/models/delete_user_api_key_request.py @@ -5,7 +5,7 @@ Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API. - The version of the OpenAPI document: 0.5.0 + The version of the OpenAPI document: 0.5.5 Contact: developers@trieve.ai Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/trieve_python_client/models/edit_message_data.py b/trieve_python_client/models/edit_message_data.py index fdc9ba3..e915a2f 100644 --- a/trieve_python_client/models/edit_message_data.py +++ b/trieve_python_client/models/edit_message_data.py @@ -5,7 +5,7 @@ Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API. - The version of the OpenAPI document: 0.5.0 + The version of the OpenAPI document: 0.5.5 Contact: developers@trieve.ai Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/trieve_python_client/models/error_response_body.py b/trieve_python_client/models/error_response_body.py index 469b523..560b97f 100644 --- a/trieve_python_client/models/error_response_body.py +++ b/trieve_python_client/models/error_response_body.py @@ -5,7 +5,7 @@ Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API. - The version of the OpenAPI document: 0.5.0 + The version of the OpenAPI document: 0.5.5 Contact: developers@trieve.ai Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/trieve_python_client/models/event.py b/trieve_python_client/models/event.py index 4648837..4a6a158 100644 --- a/trieve_python_client/models/event.py +++ b/trieve_python_client/models/event.py @@ -5,7 +5,7 @@ Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API. - The version of the OpenAPI document: 0.5.0 + The version of the OpenAPI document: 0.5.5 Contact: developers@trieve.ai Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/trieve_python_client/models/event_return.py b/trieve_python_client/models/event_return.py index 34f7be6..82286c0 100644 --- a/trieve_python_client/models/event_return.py +++ b/trieve_python_client/models/event_return.py @@ -5,7 +5,7 @@ Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API. - The version of the OpenAPI document: 0.5.0 + The version of the OpenAPI document: 0.5.5 Contact: developers@trieve.ai Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/trieve_python_client/models/field_condition.py b/trieve_python_client/models/field_condition.py index 11fd3ca..bb4276d 100644 --- a/trieve_python_client/models/field_condition.py +++ b/trieve_python_client/models/field_condition.py @@ -5,7 +5,7 @@ Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API. - The version of the OpenAPI document: 0.5.0 + The version of the OpenAPI document: 0.5.5 Contact: developers@trieve.ai Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/trieve_python_client/models/file.py b/trieve_python_client/models/file.py index 8260e26..8c11ef3 100644 --- a/trieve_python_client/models/file.py +++ b/trieve_python_client/models/file.py @@ -5,7 +5,7 @@ Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API. - The version of the OpenAPI document: 0.5.0 + The version of the OpenAPI document: 0.5.5 Contact: developers@trieve.ai Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/trieve_python_client/models/file_dto.py b/trieve_python_client/models/file_dto.py index c61163f..1dd4ac5 100644 --- a/trieve_python_client/models/file_dto.py +++ b/trieve_python_client/models/file_dto.py @@ -5,7 +5,7 @@ Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API. - The version of the OpenAPI document: 0.5.0 + The version of the OpenAPI document: 0.5.5 Contact: developers@trieve.ai Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/trieve_python_client/models/generate_chunks_request.py b/trieve_python_client/models/generate_chunks_request.py index db3236e..052e873 100644 --- a/trieve_python_client/models/generate_chunks_request.py +++ b/trieve_python_client/models/generate_chunks_request.py @@ -5,7 +5,7 @@ Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API. - The version of the OpenAPI document: 0.5.0 + The version of the OpenAPI document: 0.5.5 Contact: developers@trieve.ai Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/trieve_python_client/models/get_events_data.py b/trieve_python_client/models/get_events_data.py index 0d36909..02b6aaa 100644 --- a/trieve_python_client/models/get_events_data.py +++ b/trieve_python_client/models/get_events_data.py @@ -5,7 +5,7 @@ Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API. - The version of the OpenAPI document: 0.5.0 + The version of the OpenAPI document: 0.5.5 Contact: developers@trieve.ai Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/trieve_python_client/models/get_groups_for_chunks_data.py b/trieve_python_client/models/get_groups_for_chunks_data.py index ff41d34..152fd8f 100644 --- a/trieve_python_client/models/get_groups_for_chunks_data.py +++ b/trieve_python_client/models/get_groups_for_chunks_data.py @@ -5,7 +5,7 @@ Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API. - The version of the OpenAPI document: 0.5.0 + The version of the OpenAPI document: 0.5.5 Contact: developers@trieve.ai Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/trieve_python_client/models/group_data.py b/trieve_python_client/models/group_data.py index 53259c7..d644971 100644 --- a/trieve_python_client/models/group_data.py +++ b/trieve_python_client/models/group_data.py @@ -5,7 +5,7 @@ Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API. - The version of the OpenAPI document: 0.5.0 + The version of the OpenAPI document: 0.5.5 Contact: developers@trieve.ai Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/trieve_python_client/models/group_score_chunk_dto.py b/trieve_python_client/models/group_score_chunk_dto.py index 952e274..854c2d4 100644 --- a/trieve_python_client/models/group_score_chunk_dto.py +++ b/trieve_python_client/models/group_score_chunk_dto.py @@ -5,7 +5,7 @@ Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API. - The version of the OpenAPI document: 0.5.0 + The version of the OpenAPI document: 0.5.5 Contact: developers@trieve.ai Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -19,7 +19,7 @@ import json from pydantic import BaseModel, ConfigDict, StrictStr -from typing import Any, ClassVar, Dict, List +from typing import Any, ClassVar, Dict, List, Optional from trieve_python_client.models.score_chunk_dto import ScoreChunkDTO from typing import Optional, Set from typing_extensions import Self @@ -29,8 +29,9 @@ class GroupScoreChunkDTO(BaseModel): GroupScoreChunkDTO """ # noqa: E501 group_id: StrictStr + group_tracking_id: Optional[StrictStr] = None metadata: List[ScoreChunkDTO] - __properties: ClassVar[List[str]] = ["group_id", "metadata"] + __properties: ClassVar[List[str]] = ["group_id", "group_tracking_id", "metadata"] model_config = ConfigDict( populate_by_name=True, @@ -78,6 +79,11 @@ def to_dict(self) -> Dict[str, Any]: if _item: _items.append(_item.to_dict()) _dict['metadata'] = _items + # set to None if group_tracking_id (nullable) is None + # and model_fields_set contains the field + if self.group_tracking_id is None and "group_tracking_id" in self.model_fields_set: + _dict['group_tracking_id'] = None + return _dict @classmethod @@ -91,6 +97,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: _obj = cls.model_validate({ "group_id": obj.get("group_id"), + "group_tracking_id": obj.get("group_tracking_id"), "metadata": [ScoreChunkDTO.from_dict(_item) for _item in obj["metadata"]] if obj.get("metadata") is not None else None }) return _obj diff --git a/trieve_python_client/models/invitation_data.py b/trieve_python_client/models/invitation_data.py index 31dee12..2e1ab76 100644 --- a/trieve_python_client/models/invitation_data.py +++ b/trieve_python_client/models/invitation_data.py @@ -5,7 +5,7 @@ Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API. - The version of the OpenAPI document: 0.5.0 + The version of the OpenAPI document: 0.5.5 Contact: developers@trieve.ai Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/trieve_python_client/models/match_condition.py b/trieve_python_client/models/match_condition.py index 6f79e64..4d69edf 100644 --- a/trieve_python_client/models/match_condition.py +++ b/trieve_python_client/models/match_condition.py @@ -5,7 +5,7 @@ Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API. - The version of the OpenAPI document: 0.5.0 + The version of the OpenAPI document: 0.5.5 Contact: developers@trieve.ai Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/trieve_python_client/models/message.py b/trieve_python_client/models/message.py index a347dea..22816fc 100644 --- a/trieve_python_client/models/message.py +++ b/trieve_python_client/models/message.py @@ -5,7 +5,7 @@ Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API. - The version of the OpenAPI document: 0.5.0 + The version of the OpenAPI document: 0.5.5 Contact: developers@trieve.ai Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/trieve_python_client/models/organization.py b/trieve_python_client/models/organization.py index cba6b46..2fed851 100644 --- a/trieve_python_client/models/organization.py +++ b/trieve_python_client/models/organization.py @@ -5,7 +5,7 @@ Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API. - The version of the OpenAPI document: 0.5.0 + The version of the OpenAPI document: 0.5.5 Contact: developers@trieve.ai Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/trieve_python_client/models/organization_usage_count.py b/trieve_python_client/models/organization_usage_count.py index 49c9d71..2425d99 100644 --- a/trieve_python_client/models/organization_usage_count.py +++ b/trieve_python_client/models/organization_usage_count.py @@ -5,7 +5,7 @@ Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API. - The version of the OpenAPI document: 0.5.0 + The version of the OpenAPI document: 0.5.5 Contact: developers@trieve.ai Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/trieve_python_client/models/range.py b/trieve_python_client/models/range.py index a73b4f3..dde1c9c 100644 --- a/trieve_python_client/models/range.py +++ b/trieve_python_client/models/range.py @@ -5,7 +5,7 @@ Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API. - The version of the OpenAPI document: 0.5.0 + The version of the OpenAPI document: 0.5.5 Contact: developers@trieve.ai Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/trieve_python_client/models/reccomend_group_chunks_request.py b/trieve_python_client/models/reccomend_group_chunks_request.py index 35423f7..d1ac764 100644 --- a/trieve_python_client/models/reccomend_group_chunks_request.py +++ b/trieve_python_client/models/reccomend_group_chunks_request.py @@ -5,7 +5,7 @@ Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API. - The version of the OpenAPI document: 0.5.0 + The version of the OpenAPI document: 0.5.5 Contact: developers@trieve.ai Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -18,7 +18,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict, Field, StrictStr +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr from typing import Any, ClassVar, Dict, List, Optional from typing_extensions import Annotated from trieve_python_client.models.chunk_filter import ChunkFilter @@ -36,7 +36,8 @@ class ReccomendGroupChunksRequest(BaseModel): negative_group_tracking_ids: Optional[List[StrictStr]] = Field(default=None, description="The ids of the groups to be used as negative examples for the recommendation. The groups in this array will be used to filter out similar groups.") positive_group_ids: Optional[List[StrictStr]] = Field(default=None, description="The ids of the groups to be used as positive examples for the recommendation. The groups in this array will be used to find similar groups.") positive_group_tracking_ids: Optional[List[StrictStr]] = Field(default=None, description="The ids of the groups to be used as positive examples for the recommendation. The groups in this array will be used to find similar groups.") - __properties: ClassVar[List[str]] = ["filters", "group_size", "limit", "negative_group_ids", "negative_group_tracking_ids", "positive_group_ids", "positive_group_tracking_ids"] + slim_chunks: Optional[StrictBool] = Field(default=None, description="Set slim_chunks to true to avoid returning the content and chunk_html of the chunks. This is useful for when you want to reduce amount of data over the wire for latency improvement. Default is false.") + __properties: ClassVar[List[str]] = ["filters", "group_size", "limit", "negative_group_ids", "negative_group_tracking_ids", "positive_group_ids", "positive_group_tracking_ids", "slim_chunks"] model_config = ConfigDict( populate_by_name=True, @@ -115,6 +116,11 @@ def to_dict(self) -> Dict[str, Any]: if self.positive_group_tracking_ids is None and "positive_group_tracking_ids" in self.model_fields_set: _dict['positive_group_tracking_ids'] = None + # set to None if slim_chunks (nullable) is None + # and model_fields_set contains the field + if self.slim_chunks is None and "slim_chunks" in self.model_fields_set: + _dict['slim_chunks'] = None + return _dict @classmethod @@ -133,7 +139,8 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: "negative_group_ids": obj.get("negative_group_ids"), "negative_group_tracking_ids": obj.get("negative_group_tracking_ids"), "positive_group_ids": obj.get("positive_group_ids"), - "positive_group_tracking_ids": obj.get("positive_group_tracking_ids") + "positive_group_tracking_ids": obj.get("positive_group_tracking_ids"), + "slim_chunks": obj.get("slim_chunks") }) return _obj diff --git a/trieve_python_client/models/recommend_chunks_request.py b/trieve_python_client/models/recommend_chunks_request.py index 800a1ab..ac639f4 100644 --- a/trieve_python_client/models/recommend_chunks_request.py +++ b/trieve_python_client/models/recommend_chunks_request.py @@ -5,7 +5,7 @@ Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API. - The version of the OpenAPI document: 0.5.0 + The version of the OpenAPI document: 0.5.5 Contact: developers@trieve.ai Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -18,7 +18,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict, Field, StrictStr +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr from typing import Any, ClassVar, Dict, List, Optional from typing_extensions import Annotated from trieve_python_client.models.chunk_filter import ChunkFilter @@ -35,7 +35,8 @@ class RecommendChunksRequest(BaseModel): negative_tracking_ids: Optional[List[StrictStr]] = Field(default=None, description="The tracking_ids of the chunks to be used as negative examples for the recommendation. The chunks in this array will be used to filter out similar chunks.") positive_chunk_ids: Optional[List[StrictStr]] = Field(default=None, description="The ids of the chunks to be used as positive examples for the recommendation. The chunks in this array will be used to find similar chunks.") positive_tracking_ids: Optional[List[StrictStr]] = Field(default=None, description="The tracking_ids of the chunks to be used as positive examples for the recommendation. The chunks in this array will be used to find similar chunks.") - __properties: ClassVar[List[str]] = ["filters", "limit", "negative_chunk_ids", "negative_tracking_ids", "positive_chunk_ids", "positive_tracking_ids"] + slim_chunks: Optional[StrictBool] = Field(default=None, description="Set slim_chunks to true to avoid returning the content and chunk_html of the chunks. This is useful for when you want to reduce amount of data over the wire for latency improvement. Default is false.") + __properties: ClassVar[List[str]] = ["filters", "limit", "negative_chunk_ids", "negative_tracking_ids", "positive_chunk_ids", "positive_tracking_ids", "slim_chunks"] model_config = ConfigDict( populate_by_name=True, @@ -109,6 +110,11 @@ def to_dict(self) -> Dict[str, Any]: if self.positive_tracking_ids is None and "positive_tracking_ids" in self.model_fields_set: _dict['positive_tracking_ids'] = None + # set to None if slim_chunks (nullable) is None + # and model_fields_set contains the field + if self.slim_chunks is None and "slim_chunks" in self.model_fields_set: + _dict['slim_chunks'] = None + return _dict @classmethod @@ -126,7 +132,8 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: "negative_chunk_ids": obj.get("negative_chunk_ids"), "negative_tracking_ids": obj.get("negative_tracking_ids"), "positive_chunk_ids": obj.get("positive_chunk_ids"), - "positive_tracking_ids": obj.get("positive_tracking_ids") + "positive_tracking_ids": obj.get("positive_tracking_ids"), + "slim_chunks": obj.get("slim_chunks") }) return _obj diff --git a/trieve_python_client/models/regenerate_message_data.py b/trieve_python_client/models/regenerate_message_data.py index 23da239..082e8db 100644 --- a/trieve_python_client/models/regenerate_message_data.py +++ b/trieve_python_client/models/regenerate_message_data.py @@ -5,7 +5,7 @@ Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API. - The version of the OpenAPI document: 0.5.0 + The version of the OpenAPI document: 0.5.5 Contact: developers@trieve.ai Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/trieve_python_client/models/return_queued_chunk.py b/trieve_python_client/models/return_queued_chunk.py index cb74844..e87e2dd 100644 --- a/trieve_python_client/models/return_queued_chunk.py +++ b/trieve_python_client/models/return_queued_chunk.py @@ -5,7 +5,7 @@ Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API. - The version of the OpenAPI document: 0.5.0 + The version of the OpenAPI document: 0.5.5 Contact: developers@trieve.ai Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/trieve_python_client/models/score_chunk_dto.py b/trieve_python_client/models/score_chunk_dto.py index 83cadb6..e53979c 100644 --- a/trieve_python_client/models/score_chunk_dto.py +++ b/trieve_python_client/models/score_chunk_dto.py @@ -5,7 +5,7 @@ Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API. - The version of the OpenAPI document: 0.5.0 + The version of the OpenAPI document: 0.5.5 Contact: developers@trieve.ai Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/trieve_python_client/models/search_chunk_data.py b/trieve_python_client/models/search_chunk_data.py index 78acb18..aab5185 100644 --- a/trieve_python_client/models/search_chunk_data.py +++ b/trieve_python_client/models/search_chunk_data.py @@ -5,7 +5,7 @@ Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API. - The version of the OpenAPI document: 0.5.0 + The version of the OpenAPI document: 0.5.5 Contact: developers@trieve.ai Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -37,10 +37,12 @@ class SearchChunkData(BaseModel): page: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="Page of chunks to fetch. Each page is 10 chunks. Support for custom page size is coming soon.") page_size: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="Page size is the number of chunks to fetch. This can be used to fetch more than 10 chunks at a time.") query: StrictStr = Field(description="Query is the search query. This can be any string. The query will be used to create an embedding vector and/or SPLADE vector which will be used to find the result set.") + quote_negated_words: Optional[StrictBool] = Field(default=None, description="Turn on quote words and negated words to search for exact phrases and exclude words from the search results. Default is false.") score_threshold: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Set score_threshold to a float to filter out chunks with a score below the threshold.") search_type: StrictStr = Field(description="Can be either \"semantic\", \"fulltext\", or \"hybrid\". \"hybrid\" will pull in one page (10 chunks) of both semantic and full-text results then re-rank them using BAAI/bge-reranker-large. \"semantic\" will pull in one page (10 chunks) of the nearest cosine distant vectors. \"fulltext\" will pull in one page (10 chunks) of full-text results based on SPLADE.") + slim_chunks: Optional[StrictBool] = Field(default=None, description="Set slim_chunks to true to avoid returning the content and chunk_html of the chunks. This is useful for when you want to reduce amount of data over the wire for latency improvement. Default is false.") use_weights: Optional[StrictBool] = Field(default=None, description="Set use_weights to true to use the weights of the chunks in the result set in order to sort them. If not specified, this defaults to true.") - __properties: ClassVar[List[str]] = ["date_bias", "filters", "get_collisions", "highlight_delimiters", "highlight_results", "page", "page_size", "query", "score_threshold", "search_type", "use_weights"] + __properties: ClassVar[List[str]] = ["date_bias", "filters", "get_collisions", "highlight_delimiters", "highlight_results", "page", "page_size", "query", "quote_negated_words", "score_threshold", "search_type", "slim_chunks", "use_weights"] model_config = ConfigDict( populate_by_name=True, @@ -119,11 +121,21 @@ def to_dict(self) -> Dict[str, Any]: if self.page_size is None and "page_size" in self.model_fields_set: _dict['page_size'] = None + # set to None if quote_negated_words (nullable) is None + # and model_fields_set contains the field + if self.quote_negated_words is None and "quote_negated_words" in self.model_fields_set: + _dict['quote_negated_words'] = None + # set to None if score_threshold (nullable) is None # and model_fields_set contains the field if self.score_threshold is None and "score_threshold" in self.model_fields_set: _dict['score_threshold'] = None + # set to None if slim_chunks (nullable) is None + # and model_fields_set contains the field + if self.slim_chunks is None and "slim_chunks" in self.model_fields_set: + _dict['slim_chunks'] = None + # set to None if use_weights (nullable) is None # and model_fields_set contains the field if self.use_weights is None and "use_weights" in self.model_fields_set: @@ -149,8 +161,10 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: "page": obj.get("page"), "page_size": obj.get("page_size"), "query": obj.get("query"), + "quote_negated_words": obj.get("quote_negated_words"), "score_threshold": obj.get("score_threshold"), "search_type": obj.get("search_type"), + "slim_chunks": obj.get("slim_chunks"), "use_weights": obj.get("use_weights") }) return _obj diff --git a/trieve_python_client/models/search_chunk_query_response_body.py b/trieve_python_client/models/search_chunk_query_response_body.py index ae78007..215baa0 100644 --- a/trieve_python_client/models/search_chunk_query_response_body.py +++ b/trieve_python_client/models/search_chunk_query_response_body.py @@ -5,7 +5,7 @@ Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API. - The version of the OpenAPI document: 0.5.0 + The version of the OpenAPI document: 0.5.5 Contact: developers@trieve.ai Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/trieve_python_client/models/search_groups_result.py b/trieve_python_client/models/search_groups_result.py index 8e7e3d4..a79fe91 100644 --- a/trieve_python_client/models/search_groups_result.py +++ b/trieve_python_client/models/search_groups_result.py @@ -5,7 +5,7 @@ Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API. - The version of the OpenAPI document: 0.5.0 + The version of the OpenAPI document: 0.5.5 Contact: developers@trieve.ai Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/trieve_python_client/models/search_over_groups_data.py b/trieve_python_client/models/search_over_groups_data.py index 0767748..f54bfa8 100644 --- a/trieve_python_client/models/search_over_groups_data.py +++ b/trieve_python_client/models/search_over_groups_data.py @@ -5,7 +5,7 @@ Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API. - The version of the OpenAPI document: 0.5.0 + The version of the OpenAPI document: 0.5.5 Contact: developers@trieve.ai Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -37,9 +37,11 @@ class SearchOverGroupsData(BaseModel): page: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="Page of chunks to fetch. Each page is 10 chunks. Support for custom page size is coming soon.") page_size: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="Page size is the number of chunks to fetch. This can be used to fetch more than 10 chunks at a time.") query: StrictStr = Field(description="Query is the search query. This can be any string. The query will be used to create an embedding vector and/or SPLADE vector which will be used to find the result set.") + quote_negated_words: Optional[StrictBool] = Field(default=None, description="Turn on quote words and negated words to search for exact phrases and exclude words from the search results. Default is false.") score_threshold: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Set score_threshold to a float to filter out chunks with a score below the threshold.") search_type: StrictStr = Field(description="Can be either \"semantic\", \"fulltext\", or \"hybrid\". \"hybrid\" will pull in one page (10 chunks) of both semantic and full-text results then re-rank them using BAAI/bge-reranker-large. \"semantic\" will pull in one page (10 chunks) of the nearest cosine distant vectors. \"fulltext\" will pull in one page (10 chunks) of full-text results based on SPLADE.") - __properties: ClassVar[List[str]] = ["filters", "get_collisions", "group_size", "highlight_delimiters", "highlight_results", "page", "page_size", "query", "score_threshold", "search_type"] + slim_chunks: Optional[StrictBool] = Field(default=None, description="Set slim_chunks to true to avoid returning the content and chunk_html of the chunks. This is useful for when you want to reduce amount of data over the wire for latency improvement. Default is false.") + __properties: ClassVar[List[str]] = ["filters", "get_collisions", "group_size", "highlight_delimiters", "highlight_results", "page", "page_size", "query", "quote_negated_words", "score_threshold", "search_type", "slim_chunks"] model_config = ConfigDict( populate_by_name=True, @@ -118,11 +120,21 @@ def to_dict(self) -> Dict[str, Any]: if self.page_size is None and "page_size" in self.model_fields_set: _dict['page_size'] = None + # set to None if quote_negated_words (nullable) is None + # and model_fields_set contains the field + if self.quote_negated_words is None and "quote_negated_words" in self.model_fields_set: + _dict['quote_negated_words'] = None + # set to None if score_threshold (nullable) is None # and model_fields_set contains the field if self.score_threshold is None and "score_threshold" in self.model_fields_set: _dict['score_threshold'] = None + # set to None if slim_chunks (nullable) is None + # and model_fields_set contains the field + if self.slim_chunks is None and "slim_chunks" in self.model_fields_set: + _dict['slim_chunks'] = None + return _dict @classmethod @@ -143,8 +155,10 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: "page": obj.get("page"), "page_size": obj.get("page_size"), "query": obj.get("query"), + "quote_negated_words": obj.get("quote_negated_words"), "score_threshold": obj.get("score_threshold"), - "search_type": obj.get("search_type") + "search_type": obj.get("search_type"), + "slim_chunks": obj.get("slim_chunks") }) return _obj diff --git a/trieve_python_client/models/search_over_groups_response_body.py b/trieve_python_client/models/search_over_groups_response_body.py index 9bd8510..4a2832b 100644 --- a/trieve_python_client/models/search_over_groups_response_body.py +++ b/trieve_python_client/models/search_over_groups_response_body.py @@ -5,7 +5,7 @@ Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API. - The version of the OpenAPI document: 0.5.0 + The version of the OpenAPI document: 0.5.5 Contact: developers@trieve.ai Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/trieve_python_client/models/search_within_group_data.py b/trieve_python_client/models/search_within_group_data.py index 68074f0..7ff20b5 100644 --- a/trieve_python_client/models/search_within_group_data.py +++ b/trieve_python_client/models/search_within_group_data.py @@ -5,7 +5,7 @@ Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API. - The version of the OpenAPI document: 0.5.0 + The version of the OpenAPI document: 0.5.5 Contact: developers@trieve.ai Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -38,10 +38,12 @@ class SearchWithinGroupData(BaseModel): page: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The page of chunks to fetch. Each page is 10 chunks. Support for custom page size is coming soon.") page_size: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The page size is the number of chunks to fetch. This can be used to fetch more than 10 chunks at a time.") query: StrictStr = Field(description="The query is the search query. This can be any string. The query will be used to create an embedding vector and/or SPLADE vector which will be used to find the result set.") + quote_negated_words: Optional[StrictBool] = Field(default=None, description="Turn on quote words and negated words to search for exact phrases and exclude words from the search results. Default is false.") score_threshold: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Set score_threshold to a float to filter out chunks with a score below the threshold.") search_type: StrictStr = Field(description="Search_type can be either \"semantic\", \"fulltext\", or \"hybrid\". \"hybrid\" will pull in one page (10 chunks) of both semantic and full-text results then re-rank them using BAAI/bge-reranker-large. \"semantic\" will pull in one page (10 chunks) of the nearest cosine distant vectors. \"fulltext\" will pull in one page (10 chunks) of full-text results based on SPLADE.") + slim_chunks: Optional[StrictBool] = Field(default=None, description="Set slim_chunks to true to avoid returning the content and chunk_html of the chunks. This is useful for when you want to reduce amount of data over the wire for latency improvement. Default is false.") use_weights: Optional[StrictBool] = Field(default=None, description="Set use_weights to true to use the weights of the chunks in the result set in order to sort them. If not specified, this defaults to true.") - __properties: ClassVar[List[str]] = ["date_bias", "filters", "group_id", "group_tracking_id", "highlight_delimiters", "highlight_results", "page", "page_size", "query", "score_threshold", "search_type", "use_weights"] + __properties: ClassVar[List[str]] = ["date_bias", "filters", "group_id", "group_tracking_id", "highlight_delimiters", "highlight_results", "page", "page_size", "query", "quote_negated_words", "score_threshold", "search_type", "slim_chunks", "use_weights"] model_config = ConfigDict( populate_by_name=True, @@ -125,11 +127,21 @@ def to_dict(self) -> Dict[str, Any]: if self.page_size is None and "page_size" in self.model_fields_set: _dict['page_size'] = None + # set to None if quote_negated_words (nullable) is None + # and model_fields_set contains the field + if self.quote_negated_words is None and "quote_negated_words" in self.model_fields_set: + _dict['quote_negated_words'] = None + # set to None if score_threshold (nullable) is None # and model_fields_set contains the field if self.score_threshold is None and "score_threshold" in self.model_fields_set: _dict['score_threshold'] = None + # set to None if slim_chunks (nullable) is None + # and model_fields_set contains the field + if self.slim_chunks is None and "slim_chunks" in self.model_fields_set: + _dict['slim_chunks'] = None + # set to None if use_weights (nullable) is None # and model_fields_set contains the field if self.use_weights is None and "use_weights" in self.model_fields_set: @@ -156,8 +168,10 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: "page": obj.get("page"), "page_size": obj.get("page_size"), "query": obj.get("query"), + "quote_negated_words": obj.get("quote_negated_words"), "score_threshold": obj.get("score_threshold"), "search_type": obj.get("search_type"), + "slim_chunks": obj.get("slim_chunks"), "use_weights": obj.get("use_weights") }) return _obj diff --git a/trieve_python_client/models/set_user_api_key_request.py b/trieve_python_client/models/set_user_api_key_request.py index 2fc1031..4174e77 100644 --- a/trieve_python_client/models/set_user_api_key_request.py +++ b/trieve_python_client/models/set_user_api_key_request.py @@ -5,7 +5,7 @@ Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API. - The version of the OpenAPI document: 0.5.0 + The version of the OpenAPI document: 0.5.5 Contact: developers@trieve.ai Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/trieve_python_client/models/set_user_api_key_response.py b/trieve_python_client/models/set_user_api_key_response.py index 84da19d..b078377 100644 --- a/trieve_python_client/models/set_user_api_key_response.py +++ b/trieve_python_client/models/set_user_api_key_response.py @@ -5,7 +5,7 @@ Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API. - The version of the OpenAPI document: 0.5.0 + The version of the OpenAPI document: 0.5.5 Contact: developers@trieve.ai Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/trieve_python_client/models/single_queued_chunk_response.py b/trieve_python_client/models/single_queued_chunk_response.py index a1d7295..d77d535 100644 --- a/trieve_python_client/models/single_queued_chunk_response.py +++ b/trieve_python_client/models/single_queued_chunk_response.py @@ -5,7 +5,7 @@ Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API. - The version of the OpenAPI document: 0.5.0 + The version of the OpenAPI document: 0.5.5 Contact: developers@trieve.ai Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/trieve_python_client/models/slim_group.py b/trieve_python_client/models/slim_group.py index 4a7197c..bac8cc1 100644 --- a/trieve_python_client/models/slim_group.py +++ b/trieve_python_client/models/slim_group.py @@ -5,7 +5,7 @@ Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API. - The version of the OpenAPI document: 0.5.0 + The version of the OpenAPI document: 0.5.5 Contact: developers@trieve.ai Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/trieve_python_client/models/slim_user.py b/trieve_python_client/models/slim_user.py index 91095b0..68b89e8 100644 --- a/trieve_python_client/models/slim_user.py +++ b/trieve_python_client/models/slim_user.py @@ -5,7 +5,7 @@ Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API. - The version of the OpenAPI document: 0.5.0 + The version of the OpenAPI document: 0.5.5 Contact: developers@trieve.ai Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -18,7 +18,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict, StrictBool, StrictStr +from pydantic import BaseModel, ConfigDict, StrictStr from typing import Any, ClassVar, Dict, List, Optional from trieve_python_client.models.organization import Organization from trieve_python_client.models.user_organization import UserOrganization @@ -34,10 +34,7 @@ class SlimUser(BaseModel): name: Optional[StrictStr] = None orgs: List[Organization] user_orgs: List[UserOrganization] - username: Optional[StrictStr] = None - visible_email: StrictBool - website: Optional[StrictStr] = None - __properties: ClassVar[List[str]] = ["email", "id", "name", "orgs", "user_orgs", "username", "visible_email", "website"] + __properties: ClassVar[List[str]] = ["email", "id", "name", "orgs", "user_orgs"] model_config = ConfigDict( populate_by_name=True, @@ -97,16 +94,6 @@ def to_dict(self) -> Dict[str, Any]: if self.name is None and "name" in self.model_fields_set: _dict['name'] = None - # set to None if username (nullable) is None - # and model_fields_set contains the field - if self.username is None and "username" in self.model_fields_set: - _dict['username'] = None - - # set to None if website (nullable) is None - # and model_fields_set contains the field - if self.website is None and "website" in self.model_fields_set: - _dict['website'] = None - return _dict @classmethod @@ -123,10 +110,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: "id": obj.get("id"), "name": obj.get("name"), "orgs": [Organization.from_dict(_item) for _item in obj["orgs"]] if obj.get("orgs") is not None else None, - "user_orgs": [UserOrganization.from_dict(_item) for _item in obj["user_orgs"]] if obj.get("user_orgs") is not None else None, - "username": obj.get("username"), - "visible_email": obj.get("visible_email"), - "website": obj.get("website") + "user_orgs": [UserOrganization.from_dict(_item) for _item in obj["user_orgs"]] if obj.get("user_orgs") is not None else None }) return _obj diff --git a/trieve_python_client/models/stripe_plan.py b/trieve_python_client/models/stripe_plan.py index 1cd2937..c4b81f0 100644 --- a/trieve_python_client/models/stripe_plan.py +++ b/trieve_python_client/models/stripe_plan.py @@ -5,7 +5,7 @@ Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API. - The version of the OpenAPI document: 0.5.0 + The version of the OpenAPI document: 0.5.5 Contact: developers@trieve.ai Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/trieve_python_client/models/suggested_queries_request.py b/trieve_python_client/models/suggested_queries_request.py index e0d7daf..ac908ac 100644 --- a/trieve_python_client/models/suggested_queries_request.py +++ b/trieve_python_client/models/suggested_queries_request.py @@ -5,7 +5,7 @@ Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API. - The version of the OpenAPI document: 0.5.0 + The version of the OpenAPI document: 0.5.5 Contact: developers@trieve.ai Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/trieve_python_client/models/suggested_queries_response.py b/trieve_python_client/models/suggested_queries_response.py index cce569a..de8d919 100644 --- a/trieve_python_client/models/suggested_queries_response.py +++ b/trieve_python_client/models/suggested_queries_response.py @@ -5,7 +5,7 @@ Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API. - The version of the OpenAPI document: 0.5.0 + The version of the OpenAPI document: 0.5.5 Contact: developers@trieve.ai Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/trieve_python_client/models/topic.py b/trieve_python_client/models/topic.py index f0ba3f0..50634c8 100644 --- a/trieve_python_client/models/topic.py +++ b/trieve_python_client/models/topic.py @@ -5,7 +5,7 @@ Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API. - The version of the OpenAPI document: 0.5.0 + The version of the OpenAPI document: 0.5.5 Contact: developers@trieve.ai Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/trieve_python_client/models/update_chunk_by_tracking_id_data.py b/trieve_python_client/models/update_chunk_by_tracking_id_data.py index 76e64b7..150e8ef 100644 --- a/trieve_python_client/models/update_chunk_by_tracking_id_data.py +++ b/trieve_python_client/models/update_chunk_by_tracking_id_data.py @@ -5,7 +5,7 @@ Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API. - The version of the OpenAPI document: 0.5.0 + The version of the OpenAPI document: 0.5.5 Contact: developers@trieve.ai Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/trieve_python_client/models/update_chunk_data.py b/trieve_python_client/models/update_chunk_data.py index b771b9f..fdaa49c 100644 --- a/trieve_python_client/models/update_chunk_data.py +++ b/trieve_python_client/models/update_chunk_data.py @@ -5,7 +5,7 @@ Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API. - The version of the OpenAPI document: 0.5.0 + The version of the OpenAPI document: 0.5.5 Contact: developers@trieve.ai Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -33,10 +33,11 @@ class UpdateChunkData(BaseModel): group_tracking_ids: Optional[List[StrictStr]] = Field(default=None, description="Group tracking_ids are the tracking_ids of the groups that the chunk should be placed into. This is useful for when you want to update a chunk and add it to a group or multiple groups in one request.") link: Optional[StrictStr] = Field(default=None, description="Link of the chunk you want to update. This can also be any string. Frequently, this is a link to the source of the chunk. The link value will not affect the embedding creation. If no link is provided, the existing link will be used.") metadata: Optional[Any] = Field(default=None, description="The metadata is a JSON object which can be used to filter chunks. This is useful for when you want to filter chunks by arbitrary metadata. Unlike with tag filtering, there is a performance hit for filtering on metadata. If no metadata is provided, the existing metadata will be used.") + tag_set: Optional[List[StrictStr]] = Field(default=None, description="Tag set is a list of tags. This can be used to filter chunks by tag. Unlike with metadata filtering, HNSW indices will exist for each tag such that there is not a performance hit for filtering on them. If no tag_set is provided, the existing tag_set will be used.") time_stamp: Optional[StrictStr] = Field(default=None, description="Time_stamp should be an ISO 8601 combined date and time without timezone. It is used for time window filtering and recency-biasing search results. If no time_stamp is provided, the existing time_stamp will be used.") tracking_id: Optional[StrictStr] = Field(default=None, description="Tracking_id of the chunk you want to update. This is required to match an existing chunk.") weight: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Weight is a float which can be used to bias search results. This is useful for when you want to bias search results for a chunk. The magnitude only matters relative to other chunks in the chunk's dataset dataset. If no weight is provided, the existing weight will be used.") - __properties: ClassVar[List[str]] = ["chunk_html", "chunk_id", "group_ids", "group_tracking_ids", "link", "metadata", "time_stamp", "tracking_id", "weight"] + __properties: ClassVar[List[str]] = ["chunk_html", "chunk_id", "group_ids", "group_tracking_ids", "link", "metadata", "tag_set", "time_stamp", "tracking_id", "weight"] model_config = ConfigDict( populate_by_name=True, @@ -107,6 +108,11 @@ def to_dict(self) -> Dict[str, Any]: if self.metadata is None and "metadata" in self.model_fields_set: _dict['metadata'] = None + # set to None if tag_set (nullable) is None + # and model_fields_set contains the field + if self.tag_set is None and "tag_set" in self.model_fields_set: + _dict['tag_set'] = None + # set to None if time_stamp (nullable) is None # and model_fields_set contains the field if self.time_stamp is None and "time_stamp" in self.model_fields_set: @@ -140,6 +146,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: "group_tracking_ids": obj.get("group_tracking_ids"), "link": obj.get("link"), "metadata": obj.get("metadata"), + "tag_set": obj.get("tag_set"), "time_stamp": obj.get("time_stamp"), "tracking_id": obj.get("tracking_id"), "weight": obj.get("weight") diff --git a/trieve_python_client/models/update_chunk_group_data.py b/trieve_python_client/models/update_chunk_group_data.py index 91adfa5..ee45961 100644 --- a/trieve_python_client/models/update_chunk_group_data.py +++ b/trieve_python_client/models/update_chunk_group_data.py @@ -5,7 +5,7 @@ Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API. - The version of the OpenAPI document: 0.5.0 + The version of the OpenAPI document: 0.5.5 Contact: developers@trieve.ai Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/trieve_python_client/models/update_dataset_request.py b/trieve_python_client/models/update_dataset_request.py index adf532c..0fd6f13 100644 --- a/trieve_python_client/models/update_dataset_request.py +++ b/trieve_python_client/models/update_dataset_request.py @@ -5,7 +5,7 @@ Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API. - The version of the OpenAPI document: 0.5.0 + The version of the OpenAPI document: 0.5.5 Contact: developers@trieve.ai Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/trieve_python_client/models/update_group_by_tracking_id_data.py b/trieve_python_client/models/update_group_by_tracking_id_data.py index bff2cc8..a24fe48 100644 --- a/trieve_python_client/models/update_group_by_tracking_id_data.py +++ b/trieve_python_client/models/update_group_by_tracking_id_data.py @@ -5,7 +5,7 @@ Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API. - The version of the OpenAPI document: 0.5.0 + The version of the OpenAPI document: 0.5.5 Contact: developers@trieve.ai Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/trieve_python_client/models/update_organization_data.py b/trieve_python_client/models/update_organization_data.py index 56fb1f8..e515cae 100644 --- a/trieve_python_client/models/update_organization_data.py +++ b/trieve_python_client/models/update_organization_data.py @@ -5,7 +5,7 @@ Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API. - The version of the OpenAPI document: 0.5.0 + The version of the OpenAPI document: 0.5.5 Contact: developers@trieve.ai Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/trieve_python_client/models/update_topic_data.py b/trieve_python_client/models/update_topic_data.py index f3c12a1..d525a2f 100644 --- a/trieve_python_client/models/update_topic_data.py +++ b/trieve_python_client/models/update_topic_data.py @@ -5,7 +5,7 @@ Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API. - The version of the OpenAPI document: 0.5.0 + The version of the OpenAPI document: 0.5.5 Contact: developers@trieve.ai Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/trieve_python_client/models/update_user_data.py b/trieve_python_client/models/update_user_data.py index 09b5dd6..fb00913 100644 --- a/trieve_python_client/models/update_user_data.py +++ b/trieve_python_client/models/update_user_data.py @@ -5,7 +5,7 @@ Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API. - The version of the OpenAPI document: 0.5.0 + The version of the OpenAPI document: 0.5.5 Contact: developers@trieve.ai Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -18,7 +18,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt, StrictStr +from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr from typing import Any, ClassVar, Dict, List, Optional from typing import Optional, Set from typing_extensions import Self @@ -31,10 +31,7 @@ class UpdateUserData(BaseModel): organization_id: StrictStr = Field(description="The id of the organization to update the user for.") role: Optional[StrictInt] = Field(default=None, description="Either 0 (user), 1 (admin), or 2 (owner). If not provided, the current role will be used. The auth'ed user must have a role greater than or equal to the role being assigned.") user_id: Optional[StrictStr] = Field(default=None, description="The id of the user to update, if not provided, the auth'ed user will be updated. If provided, the auth'ed user must be an admin (1) or owner (2) of the organization.") - username: Optional[StrictStr] = Field(default=None, description="The new username to assign to the user, if not provided, the current username will be used.") - visible_email: Optional[StrictBool] = Field(default=None, description="Determines if the user's email is visible to other users, if not provided, the current value will be used.") - website: Optional[StrictStr] = Field(default=None, description="The new website to assign to the user, if not provided, the current website will be used. Used for linking to the user's personal or company website.") - __properties: ClassVar[List[str]] = ["name", "organization_id", "role", "user_id", "username", "visible_email", "website"] + __properties: ClassVar[List[str]] = ["name", "organization_id", "role", "user_id"] model_config = ConfigDict( populate_by_name=True, @@ -90,21 +87,6 @@ def to_dict(self) -> Dict[str, Any]: if self.user_id is None and "user_id" in self.model_fields_set: _dict['user_id'] = None - # set to None if username (nullable) is None - # and model_fields_set contains the field - if self.username is None and "username" in self.model_fields_set: - _dict['username'] = None - - # set to None if visible_email (nullable) is None - # and model_fields_set contains the field - if self.visible_email is None and "visible_email" in self.model_fields_set: - _dict['visible_email'] = None - - # set to None if website (nullable) is None - # and model_fields_set contains the field - if self.website is None and "website" in self.model_fields_set: - _dict['website'] = None - return _dict @classmethod @@ -120,10 +102,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: "name": obj.get("name"), "organization_id": obj.get("organization_id"), "role": obj.get("role"), - "user_id": obj.get("user_id"), - "username": obj.get("username"), - "visible_email": obj.get("visible_email"), - "website": obj.get("website") + "user_id": obj.get("user_id") }) return _obj diff --git a/trieve_python_client/models/upload_file_data.py b/trieve_python_client/models/upload_file_data.py index c95a59c..99edef2 100644 --- a/trieve_python_client/models/upload_file_data.py +++ b/trieve_python_client/models/upload_file_data.py @@ -5,7 +5,7 @@ Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API. - The version of the OpenAPI document: 0.5.0 + The version of the OpenAPI document: 0.5.5 Contact: developers@trieve.ai Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/trieve_python_client/models/upload_file_result.py b/trieve_python_client/models/upload_file_result.py index 310b1e2..9bd893c 100644 --- a/trieve_python_client/models/upload_file_result.py +++ b/trieve_python_client/models/upload_file_result.py @@ -5,7 +5,7 @@ Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API. - The version of the OpenAPI document: 0.5.0 + The version of the OpenAPI document: 0.5.5 Contact: developers@trieve.ai Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/trieve_python_client/models/user_organization.py b/trieve_python_client/models/user_organization.py index 250f723..e3b87aa 100644 --- a/trieve_python_client/models/user_organization.py +++ b/trieve_python_client/models/user_organization.py @@ -5,7 +5,7 @@ Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API. - The version of the OpenAPI document: 0.5.0 + The version of the OpenAPI document: 0.5.5 Contact: developers@trieve.ai Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/trieve_python_client/rest.py b/trieve_python_client/rest.py index 1c54b2a..315bc36 100644 --- a/trieve_python_client/rest.py +++ b/trieve_python_client/rest.py @@ -5,7 +5,7 @@ Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API. - The version of the OpenAPI document: 0.5.0 + The version of the OpenAPI document: 0.5.5 Contact: developers@trieve.ai Generated by OpenAPI Generator (https://openapi-generator.tech)