feature: bump version to 0.6.7

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.2
-- Package version: 0.6.2
+- API version: 0.6.7
+- Package version: 0.6.7
 - Generator version: 7.4.0
 - Build package: org.openapitools.codegen.languages.PythonClientCodegen
 For more information, please visit [https://trieve.ai](https://trieve.ai)

commands.txt

@@ -1,4 +1,5 @@
 PYTHON COMMAND
 
 npx @openapitools/openapi-generator-cli generate -i openapi.json -g python -c ./openapi-generator.yaml -o ./ --skip-validate-spec
-
+python -m build
+twine upload dist/*

docs/ChunkApi.md

@@ -677,7 +677,7 @@ Name | Type | Description  | Notes
 
 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 `<b>` tags for sub-sentence highlighting.
+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 `<b><mark>` tags for sub-sentence highlighting.
 
 ### Example
 

docs/ChunkData.md

@@ -7,6 +7,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **chunk_html** | **str** | HTML content of the chunk. This can also be plaintext. The innerText of the HTML will be used to create the embedding vector. The point of using HTML is for convienience, as some users have applications where users submit HTML content. | [optional] 
 **chunk_vector** | **List[float]** | Chunk_vector is a vector of floats which can be used instead of generating a new embedding. This is useful for when you are using a pre-embedded dataset. If this is not provided, the innerText of the chunk_html will be used to create the embedding. | [optional] 
+**convert_html_to_text** | **bool** | Convert HTML to raw text before processing to avoid adding noise to the vector embeddings. By default this is true. If you are using HTML content that you want to be included in the vector embeddings, set this to false. | [optional] 
 **file_id** | **str** | File_uuid is the uuid of the file that the chunk is associated with. This is used to associate chunks with files. This is useful for when you want to delete a file and all of its associated chunks. | [optional] 
 **group_ids** | **List[str]** | Group ids are the ids of the groups that the chunk should be placed into. This is useful for when you want to create a chunk and add it to a group or multiple groups in one request. Necessary because this route queues the chunk for ingestion and the chunk may not exist yet immediately after response. | [optional] 
 **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 create a chunk and add it to a group or multiple groups in one request. Necessary because this route queues the chunk for ingestion and the chunk may not exist yet immediately after response. | [optional] 

docs/CreateChunkData.md

@@ -7,6 +7,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **chunk_html** | **str** | HTML content of the chunk. This can also be plaintext. The innerText of the HTML will be used to create the embedding vector. The point of using HTML is for convienience, as some users have applications where users submit HTML content. | [optional] 
 **chunk_vector** | **List[float]** | Chunk_vector is a vector of floats which can be used instead of generating a new embedding. This is useful for when you are using a pre-embedded dataset. If this is not provided, the innerText of the chunk_html will be used to create the embedding. | [optional] 
+**convert_html_to_text** | **bool** | Convert HTML to raw text before processing to avoid adding noise to the vector embeddings. By default this is true. If you are using HTML content that you want to be included in the vector embeddings, set this to false. | [optional] 
 **file_id** | **str** | File_uuid is the uuid of the file that the chunk is associated with. This is used to associate chunks with files. This is useful for when you want to delete a file and all of its associated chunks. | [optional] 
 **group_ids** | **List[str]** | Group ids are the ids of the groups that the chunk should be placed into. This is useful for when you want to create a chunk and add it to a group or multiple groups in one request. Necessary because this route queues the chunk for ingestion and the chunk may not exist yet immediately after response. | [optional] 
 **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 create a chunk and add it to a group or multiple groups in one request. Necessary because this route queues the chunk for ingestion and the chunk may not exist yet immediately after response. | [optional] 

docs/GroupScoreChunk.md

@@ -6,6 +6,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **group_id** | **str** |  | 
+**group_name** | **str** |  | [optional] 
 **group_tracking_id** | **str** |  | [optional] 
 **metadata** | [**List[ScoreChunkDTO]**](ScoreChunkDTO.md) |  | 
 

docs/UpdateChunkByTrackingIdData.md

@@ -6,6 +6,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **chunk_html** | **str** | HTML content of the chunk you want to update. This can also be plaintext. The innerText of the HTML will be used to create the embedding vector. The point of using HTML is for convienience, as some users have applications where users submit HTML content. If no chunk_html is provided, the existing chunk_html will be used. | [optional] 
+**convert_html_to_text** | **bool** | Convert HTML to raw text before processing to avoid adding noise to the vector embeddings. By default this is true. If you are using HTML content that you want to be included in the vector embeddings, set this to false. | [optional] 
 **group_ids** | **List[str]** | Group ids are the 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] 
 **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] 

docs/UpdateChunkData.md

@@ -7,6 +7,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **chunk_html** | **str** | HTML content of the chunk you want to update. This can also be plaintext. The innerText of the HTML will be used to create the embedding vector. The point of using HTML is for convienience, as some users have applications where users submit HTML content. If no chunk_html is provided, the existing chunk_html will be used. | [optional] 
 **chunk_id** | **str** | Id of the chunk you want to update. You can provide either the chunk_id or the tracking_id. If both are provided, the chunk_id will be used. | [optional] 
+**convert_html_to_text** | **bool** | Convert HTML to raw text before processing to avoid adding noise to the vector embeddings. By default this is true. If you are using HTML content that you want to be included in the vector embeddings, set this to false. | [optional] 
 **group_ids** | **List[str]** | Group ids are the 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] 
 **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] 

docs/UploadFileData.md

@@ -8,8 +8,8 @@ Name | Type | Description | Notes
 **base64_file** | **str** | Base64 encoded file. Convert + to -, / to _, and remove the ending = if present. This is the standard base64url encoding. | 
 **create_chunks** | **bool** | Create chunks is a boolean which determines whether or not to create chunks from the file. If false, you can manually chunk the file and send the chunks to the create_chunk endpoint with the file_id to associate chunks with the file. Meant mostly for advanced users. | [optional] 
 **description** | **str** | Description is an optional convience field so you do not have to remember what the file contains or is about. It will be included on the group resulting from the file which will hold its chunk. | [optional] 
-**file_mime_type** | **str** | MIME type of the file being uploaded. | 
 **file_name** | **str** | Name of the file being uploaded, including the extension. | 
+**group_tracking_id** | **str** | Group tracking id is an optional field which allows you to specify the tracking id of the group that is created from the file. Chunks created will be created with the tracking id of `group_tracking_id|<index of chunk>` | [optional] 
 **link** | **str** | Link to the file. This can also be any string. This can be used to filter when searching for the file's resulting chunks. The link value will not affect embedding creation. | [optional] 
 **metadata** | **object** | 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. Will be passed down to the file's chunks. | [optional] 
 **tag_set** | **List[str]** | Tag set is a comma separated list of tags which will be passed down to the chunks made from the file. Tags are used to filter chunks when searching. HNSW indices are created for each tag such that there is no performance loss when filtering on them. | [optional] 

openapi-generator.yaml

@@ -1,7 +1,7 @@
 generatorName: python
 outputDir: ./generated-code/python-client
 packageName: trieve_py_client
-packageVersion: 0.6.2
+packageVersion: 0.6.7
 
 additionalProperties:
   projectName: trieve_py_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.6.2"
+  packageVersion: "0.6.7"

openapi.json

@@ -12,7 +12,7 @@
       "name": "BSL",
       "url": "https://github.com/devflowinc/trieve/blob/main/LICENSE.txt"
     },
-    "version": "0.6.2"
+    "version": "0.6.7"
   },
   "servers": [
     {
@@ -496,7 +496,7 @@
           "chunk"
         ],
         "summary": "Search",
-        "description": "Search\n\nThis 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 `<b>` tags for sub-sentence highlighting.",
+        "description": "Search\n\nThis 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 `<b><mark>` tags for sub-sentence highlighting.",
         "operationId": "search_chunk",
         "parameters": [
           {
@@ -4073,6 +4073,11 @@
             "description": "Chunk_vector is a vector of floats which can be used instead of generating a new embedding. This is useful for when you are using a pre-embedded dataset. If this is not provided, the innerText of the chunk_html will be used to create the embedding.",
             "nullable": true
           },
+          "convert_html_to_text": {
+            "type": "boolean",
+            "description": "Convert HTML to raw text before processing to avoid adding noise to the vector embeddings. By default this is true. If you are using HTML content that you want to be included in the vector embeddings, set this to false.",
+            "nullable": true
+          },
           "file_id": {
             "type": "string",
             "format": "uuid",
@@ -5397,6 +5402,10 @@
             "type": "string",
             "format": "uuid"
           },
+          "group_name": {
+            "type": "string",
+            "nullable": true
+          },
           "group_tracking_id": {
             "type": "string",
             "nullable": true
@@ -6866,6 +6875,11 @@
             "description": "HTML content of the chunk you want to update. This can also be plaintext. The innerText of the HTML will be used to create the embedding vector. The point of using HTML is for convienience, as some users have applications where users submit HTML content. If no chunk_html is provided, the existing chunk_html will be used.",
             "nullable": true
           },
+          "convert_html_to_text": {
+            "type": "boolean",
+            "description": "Convert HTML to raw text before processing to avoid adding noise to the vector embeddings. By default this is true. If you are using HTML content that you want to be included in the vector embeddings, set this to false.",
+            "nullable": true
+          },
           "group_ids": {
             "type": "array",
             "items": {
@@ -6923,6 +6937,11 @@
             "description": "Id of the chunk you want to update. You can provide either the chunk_id or the tracking_id. If both are provided, the chunk_id will be used.",
             "nullable": true
           },
+          "convert_html_to_text": {
+            "type": "boolean",
+            "description": "Convert HTML to raw text before processing to avoid adding noise to the vector embeddings. By default this is true. If you are using HTML content that you want to be included in the vector embeddings, set this to false.",
+            "nullable": true
+          },
           "group_ids": {
             "type": "array",
             "items": {
@@ -7163,8 +7182,7 @@
         "type": "object",
         "required": [
           "base64_file",
-          "file_name",
-          "file_mime_type"
+          "file_name"
         ],
         "properties": {
           "base64_file": {
@@ -7181,14 +7199,15 @@
             "description": "Description is an optional convience field so you do not have to remember what the file contains or is about. It will be included on the group resulting from the file which will hold its chunk.",
             "nullable": true
           },
-          "file_mime_type": {
-            "type": "string",
-            "description": "MIME type of the file being uploaded."
-          },
           "file_name": {
             "type": "string",
             "description": "Name of the file being uploaded, including the extension."
           },
+          "group_tracking_id": {
+            "type": "string",
+            "description": "Group tracking id is an optional field which allows you to specify the tracking id of the group that is created from the file. Chunks created will be created with the tracking id of `group_tracking_id|<index of chunk>`",
+            "nullable": true
+          },
           "link": {
             "type": "string",
             "description": "Link to the file. This can also be any string. This can be used to filter when searching for the file's resulting chunks. The link value will not affect embedding creation.",

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "trieve_py_client"
-version = "0.6.2"
+version = "0.6.7"
 description = "Trieve API"
 authors = ["Trieve Team <developers@trieve.ai>"]
 license = "BSL"

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.6.2
+    The version of the OpenAPI document: 0.6.7
     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_py_client"
-VERSION = "0.6.2"
+VERSION = "0.6.7"
 PYTHON_REQUIRES = ">=3.7"
 REQUIRES = [
     "urllib3 >= 1.25.3, < 2.1.0",

trieve_py_client/__init__.py

@@ -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.6.2
+    The version of the OpenAPI document: 0.6.7
     Contact: developers@trieve.ai
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 
     Do not edit the class manually.
 """  # noqa: E501
 
 
-__version__ = "0.6.2"
+__version__ = "0.6.7"
 
 # import apis into sdk package
 from trieve_py_client.api.auth_api import AuthApi

trieve_py_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.6.2
+    The version of the OpenAPI document: 0.6.7
     Contact: developers@trieve.ai
     Generated by OpenAPI Generator (https://openapi-generator.tech)