feature: update to 0.6.2 version

.openapi-generator/FILES

@@ -18,7 +18,7 @@ docs/ChunkGroup.md
 docs/ChunkGroupAndFile.md
 docs/ChunkGroupApi.md
 docs/ChunkMetadata.md
-docs/ChunkMetadataWithFileData.md
+docs/ChunkMetadataWithScore.md
 docs/ClientDatasetConfiguration.md
 docs/CreateChunkData.md
 docs/CreateChunkGroupData.md
@@ -46,8 +46,8 @@ docs/GenerateChunksRequest.md
 docs/GetEventsData.md
 docs/GetGroupsForChunksData.md
 docs/GroupData.md
-docs/GroupScoreChunkDTO.md
-docs/GroupSlimChunksDTO.md
+docs/GroupScoreChunk.md
+docs/GroupScoreSlimChunks.md
 docs/HealthApi.md
 docs/InvitationApi.md
 docs/InvitationData.md
@@ -60,29 +60,25 @@ docs/OrganizationUsageCount.md
 docs/Range.md
 docs/RangeCondition.md
 docs/RecommendChunksRequest.md
-docs/RecommendChunksResponseTypes.md
-docs/RecommendGroupChunkResponseTypes.md
 docs/RecommendGroupChunksRequest.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/SearchOverGroupsResults.md
+docs/SearchOverGroupsSlimResults.md
 docs/SearchSlimChunkQueryResponseBody.md
 docs/SearchWithinGroupData.md
-docs/SearchWithinGroupResponseTypes.md
+docs/SearchWithinGroupResults.md
+docs/SearchWithinGroupSlimResults.md
 docs/SetUserApiKeyRequest.md
 docs/SetUserApiKeyResponse.md
 docs/SingleQueuedChunkResponse.md
 docs/SlimChunkMetadata.md
+docs/SlimChunkMetadataWithScore.md
 docs/SlimGroup.md
 docs/SlimUser.md
 docs/StripeApi.md
@@ -110,7 +106,6 @@ setup.cfg
 setup.py
 test-requirements.txt
 test/__init__.py
-test/test_recommend_group_chunks_request.py
 tox.ini
 trieve_py_client/__init__.py
 trieve_py_client/api/__init__.py
@@ -144,7 +139,7 @@ trieve_py_client/models/chunk_filter.py
 trieve_py_client/models/chunk_group.py
 trieve_py_client/models/chunk_group_and_file.py
 trieve_py_client/models/chunk_metadata.py
-trieve_py_client/models/chunk_metadata_with_file_data.py
+trieve_py_client/models/chunk_metadata_with_score.py
 trieve_py_client/models/client_dataset_configuration.py
 trieve_py_client/models/create_chunk_data.py
 trieve_py_client/models/create_chunk_group_data.py
@@ -169,8 +164,8 @@ trieve_py_client/models/generate_chunks_request.py
 trieve_py_client/models/get_events_data.py
 trieve_py_client/models/get_groups_for_chunks_data.py
 trieve_py_client/models/group_data.py
-trieve_py_client/models/group_score_chunk_dto.py
-trieve_py_client/models/group_slim_chunks_dto.py
+trieve_py_client/models/group_score_chunk.py
+trieve_py_client/models/group_score_slim_chunks.py
 trieve_py_client/models/invitation_data.py
 trieve_py_client/models/match_condition.py
 trieve_py_client/models/message.py
@@ -179,29 +174,25 @@ trieve_py_client/models/organization_usage_count.py
 trieve_py_client/models/range.py
 trieve_py_client/models/range_condition.py
 trieve_py_client/models/recommend_chunks_request.py
-trieve_py_client/models/recommend_chunks_response_types.py
-trieve_py_client/models/recommend_group_chunk_response_types.py
 trieve_py_client/models/recommend_group_chunks_request.py
 trieve_py_client/models/regenerate_message_data.py
 trieve_py_client/models/return_queued_chunk.py
 trieve_py_client/models/score_chunk_dto.py
 trieve_py_client/models/score_slim_chunks.py
 trieve_py_client/models/search_chunk_data.py
 trieve_py_client/models/search_chunk_query_response_body.py
-trieve_py_client/models/search_chunk_response_types.py
-trieve_py_client/models/search_group_slim_chunks_result.py
-trieve_py_client/models/search_groups_result.py
 trieve_py_client/models/search_over_groups_data.py
-trieve_py_client/models/search_over_groups_response_body.py
-trieve_py_client/models/search_over_groups_response_types.py
-trieve_py_client/models/search_over_groups_slim_chunks_response_body.py
+trieve_py_client/models/search_over_groups_results.py
+trieve_py_client/models/search_over_groups_slim_results.py
 trieve_py_client/models/search_slim_chunk_query_response_body.py
 trieve_py_client/models/search_within_group_data.py
-trieve_py_client/models/search_within_group_response_types.py
+trieve_py_client/models/search_within_group_results.py
+trieve_py_client/models/search_within_group_slim_results.py
 trieve_py_client/models/set_user_api_key_request.py
 trieve_py_client/models/set_user_api_key_response.py
 trieve_py_client/models/single_queued_chunk_response.py
 trieve_py_client/models/slim_chunk_metadata.py
+trieve_py_client/models/slim_chunk_metadata_with_score.py
 trieve_py_client/models/slim_group.py
 trieve_py_client/models/slim_user.py
 trieve_py_client/models/stripe_plan.py

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.6.0
-- Package version: 0.6.0
+- API version: 0.6.2
+- Package version: 0.6.2
 - Generator version: 7.4.0
 - Build package: org.openapitools.codegen.languages.PythonClientCodegen
 For more information, please visit [https://trieve.ai](https://trieve.ai)
@@ -148,8 +148,8 @@ Class | Method | HTTP request | Description
 *TopicApi* | [**delete_topic**](docs/TopicApi.md#delete_topic) | **DELETE** /api/topic/{topic_id} | Delete Topic
 *TopicApi* | [**get_all_topics_for_user**](docs/TopicApi.md#get_all_topics_for_user) | **GET** /api/topic/user/{user_id} | Get All Topics for User
 *TopicApi* | [**update_topic**](docs/TopicApi.md#update_topic) | **PUT** /api/topic | Update Topic
-*UserApi* | [**delete_user_api_key**](docs/UserApi.md#delete_user_api_key) | **DELETE** /api/user/delete_api_key/{api_key_id} | Delete User Api Key
-*UserApi* | [**set_user_api_key**](docs/UserApi.md#set_user_api_key) | **POST** /api/user/set_api_key | Set User Api Key
+*UserApi* | [**delete_user_api_key**](docs/UserApi.md#delete_user_api_key) | **DELETE** /api/user/api_key/{api_key_id} | Delete User Api Key
+*UserApi* | [**set_user_api_key**](docs/UserApi.md#set_user_api_key) | **POST** /api/user/api_key | Set User Api Key
 *UserApi* | [**update_user**](docs/UserApi.md#update_user) | **PUT** /api/user | Update User
 
 
@@ -167,7 +167,7 @@ Class | Method | HTTP request | Description
  - [ChunkGroup](docs/ChunkGroup.md)
  - [ChunkGroupAndFile](docs/ChunkGroupAndFile.md)
  - [ChunkMetadata](docs/ChunkMetadata.md)
- - [ChunkMetadataWithFileData](docs/ChunkMetadataWithFileData.md)
+ - [ChunkMetadataWithScore](docs/ChunkMetadataWithScore.md)
  - [ClientDatasetConfiguration](docs/ClientDatasetConfiguration.md)
  - [CreateChunkData](docs/CreateChunkData.md)
  - [CreateChunkGroupData](docs/CreateChunkGroupData.md)
@@ -192,8 +192,8 @@ Class | Method | HTTP request | Description
  - [GetEventsData](docs/GetEventsData.md)
  - [GetGroupsForChunksData](docs/GetGroupsForChunksData.md)
  - [GroupData](docs/GroupData.md)
- - [GroupScoreChunkDTO](docs/GroupScoreChunkDTO.md)
- - [GroupSlimChunksDTO](docs/GroupSlimChunksDTO.md)
+ - [GroupScoreChunk](docs/GroupScoreChunk.md)
+ - [GroupScoreSlimChunks](docs/GroupScoreSlimChunks.md)
  - [InvitationData](docs/InvitationData.md)
  - [MatchCondition](docs/MatchCondition.md)
  - [Message](docs/Message.md)
@@ -202,29 +202,25 @@ Class | Method | HTTP request | Description
  - [Range](docs/Range.md)
  - [RangeCondition](docs/RangeCondition.md)
  - [RecommendChunksRequest](docs/RecommendChunksRequest.md)
- - [RecommendChunksResponseTypes](docs/RecommendChunksResponseTypes.md)
- - [RecommendGroupChunkResponseTypes](docs/RecommendGroupChunkResponseTypes.md)
  - [RecommendGroupChunksRequest](docs/RecommendGroupChunksRequest.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)
+ - [SearchOverGroupsResults](docs/SearchOverGroupsResults.md)
+ - [SearchOverGroupsSlimResults](docs/SearchOverGroupsSlimResults.md)
  - [SearchSlimChunkQueryResponseBody](docs/SearchSlimChunkQueryResponseBody.md)
  - [SearchWithinGroupData](docs/SearchWithinGroupData.md)
- - [SearchWithinGroupResponseTypes](docs/SearchWithinGroupResponseTypes.md)
+ - [SearchWithinGroupResults](docs/SearchWithinGroupResults.md)
+ - [SearchWithinGroupSlimResults](docs/SearchWithinGroupSlimResults.md)
  - [SetUserApiKeyRequest](docs/SetUserApiKeyRequest.md)
  - [SetUserApiKeyResponse](docs/SetUserApiKeyResponse.md)
  - [SingleQueuedChunkResponse](docs/SingleQueuedChunkResponse.md)
  - [SlimChunkMetadata](docs/SlimChunkMetadata.md)
+ - [SlimChunkMetadataWithScore](docs/SlimChunkMetadataWithScore.md)
  - [SlimGroup](docs/SlimGroup.md)
  - [SlimUser](docs/SlimUser.md)
  - [StripePlan](docs/StripePlan.md)

docs/BookmarkData.md

@@ -5,7 +5,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**chunks** | [**List[ChunkMetadataWithFileData]**](ChunkMetadataWithFileData.md) |  | 
+**chunks** | [**List[ChunkMetadata]**](ChunkMetadata.md) |  | 
 **group** | [**ChunkGroup**](ChunkGroup.md) |  | 
 **total_pages** | **int** |  | 
 

docs/ChunkApi.md

@@ -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**
-> RecommendChunksResponseTypes get_recommended_chunks(tr_dataset, recommend_chunks_request)
+> List[ChunkMetadataWithScore] get_recommended_chunks(tr_dataset, recommend_chunks_request)
 
 Get Recommended Chunks
 
@@ -601,8 +601,8 @@ Get Recommended Chunks  Get recommendations of chunks similar to the chunks in t
 
 ```python
 import trieve_py_client
+from trieve_py_client.models.chunk_metadata_with_score import ChunkMetadataWithScore
 from trieve_py_client.models.recommend_chunks_request import RecommendChunksRequest
-from trieve_py_client.models.recommend_chunks_response_types import RecommendChunksResponseTypes
 from trieve_py_client.rest import ApiException
 from pprint import pprint
 
@@ -651,7 +651,7 @@ Name | Type | Description  | Notes
 
 ### Return type
 
-[**RecommendChunksResponseTypes**](RecommendChunksResponseTypes.md)
+[**List[ChunkMetadataWithScore]**](ChunkMetadataWithScore.md)
 
 ### Authorization
 
@@ -666,13 +666,14 @@ Name | Type | Description  | Notes
 
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
-**200** | Chunks with embedding vectors which are similar to those in the request body |  -  |
+**200** | Chunks with embedding vectors which are similar to positives and dissimilar to negatives if slim_chunks is false in the request |  -  |
+**206** | Chunks with embedding vectors which are similar to positives and dissimilar to negatives if slim_chunks is true 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)
 
 # **search_chunk**
-> SearchChunkResponseTypes search_chunk(tr_dataset, search_chunk_data)
+> SearchChunkQueryResponseBody search_chunk(tr_dataset, search_chunk_data)
 
 Search
 
@@ -685,7 +686,7 @@ Search  This route provides the primary search functionality for the API. It can
 ```python
 import trieve_py_client
 from trieve_py_client.models.search_chunk_data import SearchChunkData
-from trieve_py_client.models.search_chunk_response_types import SearchChunkResponseTypes
+from trieve_py_client.models.search_chunk_query_response_body import SearchChunkQueryResponseBody
 from trieve_py_client.rest import ApiException
 from pprint import pprint
 
@@ -734,7 +735,7 @@ Name | Type | Description  | Notes
 
 ### Return type
 
-[**SearchChunkResponseTypes**](SearchChunkResponseTypes.md)
+[**SearchChunkQueryResponseBody**](SearchChunkQueryResponseBody.md)
 
 ### Authorization
 
@@ -749,7 +750,8 @@ Name | Type | Description  | Notes
 
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
-**200** | Chunks with embedding vectors which are similar to those in the request body |  -  |
+**200** | Chunks with embedding vectors which are similar to those in the request body if slim_chunks is false or not specified in the request body |  -  |
+**206** | Chunks with embedding vectors which are similar to those in the request body if slim_chunks is true 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)

docs/ChunkGroupApi.md

@@ -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**
-> RecommendGroupChunkResponseTypes get_recommended_groups(tr_dataset, recommend_group_chunks_request)
+> List[GroupScoreChunk] get_recommended_groups(tr_dataset, recommend_group_chunks_request)
 
 Get Recommended Groups
 
@@ -858,7 +858,7 @@ Get Recommended Groups  Route to get recommended groups. This route will return
 
 ```python
 import trieve_py_client
-from trieve_py_client.models.recommend_group_chunk_response_types import RecommendGroupChunkResponseTypes
+from trieve_py_client.models.group_score_chunk import GroupScoreChunk
 from trieve_py_client.models.recommend_group_chunks_request import RecommendGroupChunksRequest
 from trieve_py_client.rest import ApiException
 from pprint import pprint
@@ -908,7 +908,7 @@ Name | Type | Description  | Notes
 
 ### Return type
 
-[**RecommendGroupChunkResponseTypes**](RecommendGroupChunkResponseTypes.md)
+[**List[GroupScoreChunk]**](GroupScoreChunk.md)
 
 ### Authorization
 
@@ -923,7 +923,8 @@ Name | Type | Description  | Notes
 
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
-**200** | JSON body representing the groups which are similar to the groups in the request |  -  |
+**200** | JSON body representing the groups which are similar to the positive groups and dissimilar to the negative ones if slim_chunks is false in the request |  -  |
+**206** | JSON body representing the groups which are similar to the positive groups and dissimilar to the negative ones if slim_chunks is false 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)
@@ -1095,7 +1096,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**
-> SearchOverGroupsResponseTypes search_over_groups(tr_dataset, search_over_groups_data)
+> SearchOverGroupsResults search_over_groups(tr_dataset, search_over_groups_data)
 
 Search Over Groups
 
@@ -1108,7 +1109,7 @@ Search Over Groups  This route allows you to get groups as results instead of ch
 ```python
 import trieve_py_client
 from trieve_py_client.models.search_over_groups_data import SearchOverGroupsData
-from trieve_py_client.models.search_over_groups_response_types import SearchOverGroupsResponseTypes
+from trieve_py_client.models.search_over_groups_results import SearchOverGroupsResults
 from trieve_py_client.rest import ApiException
 from pprint import pprint
 
@@ -1157,7 +1158,7 @@ Name | Type | Description  | Notes
 
 ### Return type
 
-[**SearchOverGroupsResponseTypes**](SearchOverGroupsResponseTypes.md)
+[**SearchOverGroupsResults**](SearchOverGroupsResults.md)
 
 ### Authorization
 
@@ -1172,13 +1173,14 @@ Name | Type | Description  | Notes
 
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
-**200** | Group chunks which are similar to the embedding vector of the search query |  -  |
-**400** | Service error relating to getting the groups that the chunk is in |  -  |
+**200** | Group chunks which are similar to the embedding vector of the search query if slim_chunks is false or unspecified in the request body |  -  |
+**206** | Group chunks which are similar to the embedding vector of the search query if slim_chunks is true in the request body |  -  |
+**400** | Service error relating to searching over groups |  -  |
 
 [[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**
-> SearchWithinGroupResponseTypes search_within_group(tr_dataset, search_within_group_data)
+> SearchWithinGroupResults search_within_group(tr_dataset, search_within_group_data)
 
 Search Within Group
 
@@ -1191,7 +1193,7 @@ Search Within Group  This route allows you to search only within a group. This i
 ```python
 import trieve_py_client
 from trieve_py_client.models.search_within_group_data import SearchWithinGroupData
-from trieve_py_client.models.search_within_group_response_types import SearchWithinGroupResponseTypes
+from trieve_py_client.models.search_within_group_results import SearchWithinGroupResults
 from trieve_py_client.rest import ApiException
 from pprint import pprint
 
@@ -1240,7 +1242,7 @@ Name | Type | Description  | Notes
 
 ### Return type
 
-[**SearchWithinGroupResponseTypes**](SearchWithinGroupResponseTypes.md)
+[**SearchWithinGroupResults**](SearchWithinGroupResults.md)
 
 ### Authorization
 
@@ -1255,7 +1257,8 @@ Name | Type | Description  | Notes
 
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
-**200** | Group chunks which are similar to the embedding vector of the search query |  -  |
+**200** | Group chunks which are similar to the embedding vector of the search query if slim_chunks is false in the request |  -  |
+**206** | Group chunks which are similar to the embedding vector of the search query if slim_chunks is true in the request |  -  |
 **400** | Service error relating to getting the groups that the chunk is in |  -  |
 
 [[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)