trieve_ruby_client 0.8.2 → 0.11.0

data/docs/ChunkData.md

@@ -4,11 +4,12 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **chunk_html** | **String** | 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. |  |
+| **chunk_html** | **String** | 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** | **Array<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** | **Boolean** | 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** | **Array<String>** | 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** | **Array<String>** | 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] |
+| **image_urls** | **Array<String>** | Image urls are a list of urls to images that are associated with the chunk. This is useful for when you want to associate images with a chunk. | [optional] |
 | **link** | **String** | Link to the chunk. 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. | [optional] |
 | **location** | [**GeoInfo**](GeoInfo.md) |  | [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. | [optional] |
@@ -30,6 +31,7 @@ instance = TrieveRubyClient::ChunkData.new(
   convert_html_to_text: null,
   group_ids: null,
   group_tracking_ids: null,
+  image_urls: null,
   link: null,
   location: null,
   metadata: null,

data/docs/ChunkFilter.md

@@ -4,9 +4,10 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **must** | [**Array<FieldCondition>**](FieldCondition.md) | All of these field conditions have to match for the chunk to be included in the result set. | [optional] |
-| **must_not** | [**Array<FieldCondition>**](FieldCondition.md) | None of these field conditions can match for the chunk to be included in the result set. | [optional] |
-| **should** | [**Array<FieldCondition>**](FieldCondition.md) | Only one of these field conditions has to match for the chunk to be included in the result set. | [optional] |
+| **jsonb_prefilter** | **Boolean** | JOSNB prefilter tells the server to perform a full scan over the metadata JSONB column instead of using the filtered HNSW. Datasets on the enterprise plan with custom metadata indices will perform better with the filtered HNSW instead. When false, the server will use the filtered HNSW index to filter chunks. When true, the server will perform a full scan over the metadata JSONB column to filter chunks. Default is true. | [optional] |
+| **must** | [**Array<ConditionType>**](ConditionType.md) | All of these field conditions have to match for the chunk to be included in the result set. | [optional] |
+| **must_not** | [**Array<ConditionType>**](ConditionType.md) | None of these field conditions can match for the chunk to be included in the result set. | [optional] |
+| **should** | [**Array<ConditionType>**](ConditionType.md) | Only one of these field conditions has to match for the chunk to be included in the result set. | [optional] |
 
 ## Example
 
@@ -14,6 +15,7 @@
 require 'trieve_ruby_client'
 
 instance = TrieveRubyClient::ChunkFilter.new(
+  jsonb_prefilter: null,
   must: null,
   must_not: null,
   should: null

data/docs/ChunkGroup.md

@@ -10,7 +10,7 @@
 | **id** | **String** |  |  |
 | **metadata** | **Object** |  | [optional] |
 | **name** | **String** |  |  |
-| **tag_set** | **String** |  | [optional] |
+| **tag_set** | **Array<String>** |  | [optional] |
 | **tracking_id** | **String** |  | [optional] |
 | **updated_at** | **Time** |  |  |
 

data/docs/ChunkGroupAndFileId.md

@@ -0,0 +1,36 @@
+# TrieveRubyClient::ChunkGroupAndFileId
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **created_at** | **Time** |  |  |
+| **dataset_id** | **String** |  |  |
+| **description** | **String** |  |  |
+| **file_id** | **String** |  | [optional] |
+| **id** | **String** |  |  |
+| **metadata** | **Object** |  | [optional] |
+| **name** | **String** |  |  |
+| **tag_set** | **Array<String>** |  | [optional] |
+| **tracking_id** | **String** |  | [optional] |
+| **updated_at** | **Time** |  |  |
+
+## Example
+
+```ruby
+require 'trieve_ruby_client'
+
+instance = TrieveRubyClient::ChunkGroupAndFileId.new(
+  created_at: null,
+  dataset_id: null,
+  description: null,
+  file_id: null,
+  id: null,
+  metadata: null,
+  name: null,
+  tag_set: null,
+  tracking_id: null,
+  updated_at: null
+)
+```
+