Skip to content

Commit

Permalink
feature: update version to 0.8.0
Browse files Browse the repository at this point in the history
  • Loading branch information
skeptrunedev committed May 8, 2024
1 parent 8d10e22 commit 6cf5003
Show file tree
Hide file tree
Showing 122 changed files with 312 additions and 153 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.7.6
- Package version: 0.7.6
- API version: 0.8.0
- Package version: 0.8.0
- Generator version: 7.4.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
For more information, please visit [https://trieve.ai](https://trieve.ai)
Expand Down
2 changes: 2 additions & 0 deletions docs/ChunkApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -672,6 +672,7 @@ Name | Type | Description | Notes
|-------------|-------------|------------------|
**200** | chunks with the id that you were searching for | - |
**400** | Service error relating to fidning a chunk by tracking_id | - |
**404** | Any one of the specified chunks not found | - |

[[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)

Expand Down Expand Up @@ -755,6 +756,7 @@ Name | Type | Description | Notes
|-------------|-------------|------------------|
**200** | chunk with the id that you were searching for | - |
**400** | Service error relating to fidning a chunk by tracking_id | - |
**404** | Any one of the specified chunks not found | - |

[[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)

Expand Down
1 change: 1 addition & 0 deletions docs/CreateChunkGroupData.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ Name | Type | Description | Notes
**name** | **str** | Name to assign to the chunk_group. Does not need to be unique. |
**tag_set** | **List[str]** | Optional tags to assign to the chunk_group. This is a list of strings that can be used to categorize the chunks inside the chunk_group. | [optional]
**tracking_id** | **str** | Optional tracking id to assign to the chunk_group. This is a unique identifier for the chunk_group. | [optional]
**upsert_by_tracking_id** | **bool** | Upsert when a chunk_group with the same tracking_id exists. By default this is false, and the request will fail if a chunk_group with the same tracking_id exists. If this is true, the chunk_group will be updated if a chunk_group with the same tracking_id exists. | [optional]

## Example

Expand Down
1 change: 1 addition & 0 deletions docs/FileApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -252,6 +252,7 @@ Name | Type | Description | Notes
|-------------|-------------|------------------|
**200** | The signed s3 url corresponding to the file_id requested | - |
**400** | Service error relating to finding the file | - |
**404** | File not found | - |

[[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)

Expand Down
1 change: 1 addition & 0 deletions docs/OrganizationApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -254,6 +254,7 @@ Name | Type | Description | Notes
|-------------|-------------|------------------|
**200** | Organization with the id that was requested | - |
**400** | Service error relating to finding the organization by id | - |
**404** | Organization not found | - |

[[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)

Expand Down
1 change: 1 addition & 0 deletions docs/OrganizationUsageCount.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**chunk_count** | **int** | |
**dataset_count** | **int** | |
**file_storage** | **int** | |
**id** | **str** | |
Expand Down
1 change: 1 addition & 0 deletions docs/SearchChunkData.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ Name | Type | Description | Notes
**date_bias** | **bool** | Set date_bias to true to bias search results towards more recent chunks. This will work best in hybrid search mode. | [optional]
**filters** | [**ChunkFilter**](ChunkFilter.md) | | [optional]
**get_collisions** | **bool** | Set get_collisions to true to get the collisions for each chunk. This will only apply if environment variable COLLISIONS_ENABLED is set to true. | [optional]
**get_total_pages** | **bool** | Get total page count for the query accounting for the applied filters. Defaults to true, but can be set to false to reduce latency in edge cases performance. | [optional]
**highlight_delimiters** | **List[str]** | Set highlight_delimiters to a list of strings to use as delimiters for highlighting. If not specified, this defaults to [\"?\", \",\", \".\", \"!\"]. | [optional]
**highlight_results** | **bool** | Set highlight_results to true to highlight the results. If not specified, this defaults to true. | [optional]
**page** | **int** | Page of chunks to fetch. Page is 1-indexed. | [optional]
Expand Down
1 change: 1 addition & 0 deletions docs/SearchOverGroupsData.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**filters** | [**ChunkFilter**](ChunkFilter.md) | | [optional]
**get_collisions** | **bool** | Set get_collisions to true to get the collisions for each chunk. This will only apply if environment variable COLLISIONS_ENABLED is set to true. | [optional]
**get_total_pages** | **bool** | Get total page count for the query accounting for the applied filters. Defaults to true, but can be set to false to reduce latency in edge cases performance. | [optional]
**group_size** | **int** | Group_size is the number of chunks to fetch for each group. The default is 3. If a group has less than group_size chunks, all chunks will be returned. If this is set to a large number, we recommend setting slim_chunks to true to avoid returning the content and chunk_html of the chunks so as to lower the amount of time required for content download and serialization. | [optional]
**highlight_delimiters** | **List[str]** | Set highlight_delimiters to a list of strings to use as delimiters for highlighting. If not specified, this defaults to [\"?\", \",\", \".\", \"!\"]. | [optional]
**highlight_results** | **bool** | Set highlight_results to true to highlight the results. If not specified, this defaults to true. | [optional]
Expand Down
1 change: 1 addition & 0 deletions docs/SearchWithinGroupData.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**date_bias** | **bool** | Set date_bias to true to bias search results towards more recent chunks. This will work best in hybrid search mode. | [optional]
**filters** | [**ChunkFilter**](ChunkFilter.md) | | [optional]
**get_total_pages** | **bool** | Get total page count for the query accounting for the applied filters. Defaults to true, but can be set to false to reduce latency in edge cases performance. | [optional]
**group_id** | **str** | Group specifies the group to search within. Results will only consist of chunks which are bookmarks within the specified group. | [optional]
**group_tracking_id** | **str** | Group_tracking_id specifies the group to search within by tracking id. Results will only consist of chunks which are bookmarks within the specified group. If both group_id and group_tracking_id are provided, group_id will be used. | [optional]
**highlight_delimiters** | **List[str]** | Set highlight_delimiters to a list of strings to use as delimiters for highlighting. If not specified, this defaults to [\"?\", \",\", \".\", \"!\"]. | [optional]
Expand Down
4 changes: 2 additions & 2 deletions openapi-generator.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
generatorName: python
outputDir: ./generated-code/python-client
packageName: trieve_py_client
packageVersion: 0.7.6
packageVersion: 0.8.0

additionalProperties:
projectName: trieve_py_client
Expand All @@ -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.7.6"
packageVersion: "0.8.0"
124 changes: 116 additions & 8 deletions openapi.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
"name": "BSL",
"url": "https://github.com/devflowinc/trieve/blob/main/LICENSE.txt"
},
"version": "0.7.6"
"version": "0.8.0"
},
"servers": [
{
Expand Down Expand Up @@ -666,7 +666,14 @@
}
},
"404": {
"description": "Chunk not found"
"description": "Chunk not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseBody"
}
}
}
}
},
"security": [
Expand Down Expand Up @@ -779,7 +786,14 @@
}
},
"404": {
"description": "Chunk not found"
"description": "Chunk not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseBody"
}
}
}
}
},
"security": [
Expand Down Expand Up @@ -1425,7 +1439,14 @@
}
},
"404": {
"description": "Group not found"
"description": "Group not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseBody"
}
}
}
}
},
"security": [
Expand Down Expand Up @@ -1487,7 +1508,14 @@
}
},
"404": {
"description": "Group not found"
"description": "Group not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseBody"
}
}
}
}
},
"security": [
Expand Down Expand Up @@ -1725,7 +1753,14 @@
}
},
"404": {
"description": "Group not found"
"description": "Group not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseBody"
}
}
}
}
},
"security": [
Expand Down Expand Up @@ -1860,7 +1895,14 @@
}
},
"404": {
"description": "Group not found"
"description": "Group not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseBody"
}
}
}
}
},
"security": [
Expand Down Expand Up @@ -1925,6 +1967,16 @@
}
}
}
},
"404": {
"description": "Any one of the specified chunks not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseBody"
}
}
}
}
},
"security": [
Expand Down Expand Up @@ -1986,6 +2038,16 @@
}
}
}
},
"404": {
"description": "Any one of the specified chunks not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseBody"
}
}
}
}
},
"security": [
Expand Down Expand Up @@ -2665,6 +2727,16 @@
}
}
}
},
"404": {
"description": "File not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseBody"
}
}
}
}
},
"security": [
Expand Down Expand Up @@ -3322,6 +3394,16 @@
}
}
}
},
"404": {
"description": "Organization not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseBody"
}
}
}
}
},
"security": [
Expand Down Expand Up @@ -4841,6 +4923,11 @@
"type": "string",
"description": "Optional tracking id to assign to the chunk_group. This is a unique identifier for the chunk_group.",
"nullable": true
},
"upsert_by_tracking_id": {
"type": "boolean",
"description": "Upsert when a chunk_group with the same tracking_id exists. By default this is false, and the request will fail if a chunk_group with the same tracking_id exists. If this is true, the chunk_group will be updated if a chunk_group with the same tracking_id exists.",
"nullable": true
}
}
},
Expand Down Expand Up @@ -5923,9 +6010,14 @@
"dataset_count",
"user_count",
"file_storage",
"message_count"
"message_count",
"chunk_count"
],
"properties": {
"chunk_count": {
"type": "integer",
"format": "int32"
},
"dataset_count": {
"type": "integer",
"format": "int32"
Expand All @@ -5952,6 +6044,7 @@
}
},
"example": {
"chunk_count": 1000,
"dataset_count": 1,
"file_storage": 512,
"id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
Expand Down Expand Up @@ -6303,6 +6396,11 @@
"description": "Set get_collisions to true to get the collisions for each chunk. This will only apply if environment variable COLLISIONS_ENABLED is set to true.",
"nullable": true
},
"get_total_pages": {
"type": "boolean",
"description": "Get total page count for the query accounting for the applied filters. Defaults to true, but can be set to false to reduce latency in edge cases performance.",
"nullable": true
},
"highlight_delimiters": {
"type": "array",
"items": {
Expand Down Expand Up @@ -6459,6 +6557,11 @@
"description": "Set get_collisions to true to get the collisions for each chunk. This will only apply if environment variable COLLISIONS_ENABLED is set to true.",
"nullable": true
},
"get_total_pages": {
"type": "boolean",
"description": "Get total page count for the query accounting for the applied filters. Defaults to true, but can be set to false to reduce latency in edge cases performance.",
"nullable": true
},
"group_size": {
"type": "integer",
"format": "int32",
Expand Down Expand Up @@ -6591,6 +6694,11 @@
],
"nullable": true
},
"get_total_pages": {
"type": "boolean",
"description": "Get total page count for the query accounting for the applied filters. Defaults to true, but can be set to false to reduce latency in edge cases performance.",
"nullable": true
},
"group_id": {
"type": "string",
"format": "uuid",
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[tool.poetry]
name = "trieve_py_client"
version = "0.7.6"
version = "0.8.0"
description = "Trieve API"
authors = ["Trieve Team <developers@trieve.ai>"]
license = "BSL"
Expand Down
4 changes: 2 additions & 2 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.7.6
The version of the OpenAPI document: 0.8.0
Contact: developers@trieve.ai
Generated by OpenAPI Generator (https://openapi-generator.tech)
Expand All @@ -22,7 +22,7 @@
# prerequisite: setuptools
# http://pypi.python.org/pypi/setuptools
NAME = "trieve_py_client"
VERSION = "0.7.6"
VERSION = "0.8.0"
PYTHON_REQUIRES = ">=3.7"
REQUIRES = [
"urllib3 >= 1.25.3, < 2.1.0",
Expand Down
4 changes: 2 additions & 2 deletions trieve_py_client/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,15 @@
Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API.
The version of the OpenAPI document: 0.7.6
The version of the OpenAPI document: 0.8.0
Contact: developers@trieve.ai
Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
""" # noqa: E501


__version__ = "0.7.6"
__version__ = "0.8.0"

# import apis into sdk package
from trieve_py_client.api.auth_api import AuthApi
Expand Down
2 changes: 1 addition & 1 deletion trieve_py_client/api/auth_api.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.7.6
The version of the OpenAPI document: 0.8.0
Contact: developers@trieve.ai
Generated by OpenAPI Generator (https://openapi-generator.tech)
Expand Down
Loading

0 comments on commit 6cf5003

Please sign in to comment.