trieve_ruby_client 0.8.2 → 0.11.0

data/docs/ChunkMetadata.md

@@ -8,11 +8,13 @@
 | **created_at** | **Time** |  |  |
 | **dataset_id** | **String** |  |  |
 | **id** | **String** |  |  |
+| **image_urls** | **Array<String>** |  | [optional] |
 | **link** | **String** |  | [optional] |
 | **location** | [**GeoInfo**](GeoInfo.md) |  | [optional] |
 | **metadata** | **Object** |  | [optional] |
-| **qdrant_point_id** | **String** |  | [optional] |
-| **tag_set** | **String** |  | [optional] |
+| **num_value** | **Float** |  | [optional] |
+| **qdrant_point_id** | **String** |  |  |
+| **tag_set** | **Array<String>** |  | [optional] |
 | **time_stamp** | **Time** |  | [optional] |
 | **tracking_id** | **String** |  | [optional] |
 | **updated_at** | **Time** |  |  |
@@ -28,9 +30,11 @@ instance = TrieveRubyClient::ChunkMetadata.new(
   created_at: null,
   dataset_id: null,
   id: null,
+  image_urls: null,
   link: null,
   location: null,
   metadata: null,
+  num_value: null,
   qdrant_point_id: null,
   tag_set: null,
   time_stamp: null,

data/docs/ChunkMetadataStringTagSet.md

@@ -0,0 +1,46 @@
+# TrieveRubyClient::ChunkMetadataStringTagSet
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **chunk_html** | **String** |  | [optional] |
+| **created_at** | **Time** |  |  |
+| **dataset_id** | **String** |  |  |
+| **id** | **String** |  |  |
+| **image_urls** | **Array<String>** |  | [optional] |
+| **link** | **String** |  | [optional] |
+| **location** | [**GeoInfo**](GeoInfo.md) |  | [optional] |
+| **metadata** | **Object** |  | [optional] |
+| **num_value** | **Float** |  | [optional] |
+| **qdrant_point_id** | **String** |  |  |
+| **tag_set** | **String** |  | [optional] |
+| **time_stamp** | **Time** |  | [optional] |
+| **tracking_id** | **String** |  | [optional] |
+| **updated_at** | **Time** |  |  |
+| **weight** | **Float** |  |  |
+
+## Example
+
+```ruby
+require 'trieve_ruby_client'
+
+instance = TrieveRubyClient::ChunkMetadataStringTagSet.new(
+  chunk_html: null,
+  created_at: null,
+  dataset_id: null,
+  id: null,
+  image_urls: null,
+  link: null,
+  location: null,
+  metadata: null,
+  num_value: null,
+  qdrant_point_id: null,
+  tag_set: null,
+  time_stamp: null,
+  tracking_id: null,
+  updated_at: null,
+  weight: null
+)
+```
+

data/docs/ChunkMetadataTypes.md

@@ -0,0 +1,51 @@
+# TrieveRubyClient::ChunkMetadataTypes
+
+## Class instance methods
+
+### `openapi_one_of`
+
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'trieve_ruby_client'
+
+TrieveRubyClient::ChunkMetadataTypes.openapi_one_of
+# =>
+# [
+#   :'ChunkMetadataStringTagSet',
+#   :'ContentChunkMetadata',
+#   :'SlimChunkMetadata'
+# ]
+```
+
+### build
+
+Find the appropriate object from the `openapi_one_of` list and casts the data into it.
+
+#### Example
+
+```ruby
+require 'trieve_ruby_client'
+
+TrieveRubyClient::ChunkMetadataTypes.build(data)
+# => #<ChunkMetadataStringTagSet:0x00007fdd4aab02a0>
+
+TrieveRubyClient::ChunkMetadataTypes.build(data_that_doesnt_match)
+# => nil
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| **data** | **Mixed** | data to be matched against the list of oneOf items |
+
+#### Return type
+
+- `ChunkMetadataStringTagSet`
+- `ContentChunkMetadata`
+- `SlimChunkMetadata`
+- `nil` (if no type matches)
+

data/docs/ChunkMetadataWithScore.md

@@ -10,7 +10,7 @@
 | **id** | **String** |  |  |
 | **link** | **String** |  | [optional] |
 | **metadata** | **Object** |  | [optional] |
-| **qdrant_point_id** | **String** |  | [optional] |
+| **qdrant_point_id** | **String** |  |  |
 | **score** | **Float** |  |  |
 | **tag_set** | **String** |  | [optional] |
 | **time_stamp** | **Time** |  | [optional] |

data/docs/ChunkReqPayload.md

@@ -0,0 +1,50 @@
+# TrieveRubyClient::ChunkReqPayload
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **boost_phrase** | [**BoostPhrase**](BoostPhrase.md) |  | [optional] |
+| **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] |
+| **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] |
+| **distance_phrase** | [**DistancePhrase**](DistancePhrase.md) |  | [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] |
+| **num_value** | **Float** | Num value is an arbitrary numerical value that can be used to filter chunks. This is useful for when you want to filter chunks by numerical value. There is no performance hit for filtering on num_value. | [optional] |
+| **split_avg** | **Boolean** | Split avg is a boolean which tells the server to split the text in the chunk_html into smaller chunks and average their resulting vectors. This is useful for when you want to create a chunk from a large piece of text and want to split it into smaller chunks to create a more fuzzy average dense vector. The sparse vector will be generated normally with no averaging. By default this is false. | [optional] |
+| **tag_set** | **Array<String>** | 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. | [optional] |
+| **time_stamp** | **String** | 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. | [optional] |
+| **tracking_id** | **String** | Tracking_id is a string which can be used to identify a chunk. This is useful for when you are coordinating with an external system and want to use the tracking_id to identify the chunk. | [optional] |
+| **upsert_by_tracking_id** | **Boolean** | Upsert when a chunk with the same tracking_id exists. By default this is false, and the request will fail if a chunk with the same tracking_id exists. If this is true, the chunk will be updated if a chunk with the same tracking_id exists. | [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. | [optional] |
+
+## Example
+
+```ruby
+require 'trieve_ruby_client'
+
+instance = TrieveRubyClient::ChunkReqPayload.new(
+  boost_phrase: null,
+  chunk_html: null,
+  convert_html_to_text: null,
+  distance_phrase: null,
+  group_ids: null,
+  group_tracking_ids: null,
+  image_urls: null,
+  link: null,
+  location: null,
+  metadata: null,
+  num_value: null,
+  split_avg: null,
+  tag_set: null,
+  time_stamp: null,
+  tracking_id: null,
+  upsert_by_tracking_id: null,
+  weight: null
+)
+```
+

data/docs/ChunkReturnTypes.md

@@ -0,0 +1,49 @@
+# TrieveRubyClient::ChunkReturnTypes
+
+## Class instance methods
+
+### `openapi_one_of`
+
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'trieve_ruby_client'
+
+TrieveRubyClient::ChunkReturnTypes.openapi_one_of
+# =>
+# [
+#   :'ChunkMetadata',
+#   :'ChunkMetadataStringTagSet'
+# ]
+```
+
+### build
+
+Find the appropriate object from the `openapi_one_of` list and casts the data into it.
+
+#### Example
+
+```ruby
+require 'trieve_ruby_client'
+
+TrieveRubyClient::ChunkReturnTypes.build(data)
+# => #<ChunkMetadata:0x00007fdd4aab02a0>
+
+TrieveRubyClient::ChunkReturnTypes.build(data_that_doesnt_match)
+# => nil
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| **data** | **Mixed** | data to be matched against the list of oneOf items |
+
+#### Return type
+
+- `ChunkMetadata`
+- `ChunkMetadataStringTagSet`
+- `nil` (if no type matches)
+

data/docs/ClientDatasetConfiguration.md

@@ -10,7 +10,6 @@
 | **file_name_key** | **String** |  |  |
 | **filter_items** | **Object** |  | [optional] |
 | **frontmatter_vals** | **String** |  | [optional] |
-| **image_metadata_key** | **String** |  |  |
 | **image_range_end_key** | **String** |  | [optional] |
 | **image_range_start_key** | **String** |  | [optional] |
 | **lines_before_show_more** | **Integer** |  | [optional] |
@@ -29,7 +28,6 @@ instance = TrieveRubyClient::ClientDatasetConfiguration.new(
   file_name_key: null,
   filter_items: null,
   frontmatter_vals: null,
-  image_metadata_key: null,
   image_range_end_key: null,
   image_range_start_key: null,
   lines_before_show_more: null,

data/docs/ClusterAnalytics.md

@@ -0,0 +1,63 @@
+# TrieveRubyClient::ClusterAnalytics
+
+## Class instance methods
+
+### `openapi_one_of`
+
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'trieve_ruby_client'
+
+TrieveRubyClient::ClusterAnalytics.openapi_one_of
+# =>
+# [
+#   :'ClusterQueries',
+#   :'ClusterTopics'
+# ]
+```
+
+### `openapi_discriminator_name`
+
+Returns the discriminator's property name.
+
+#### Example
+
+```ruby
+require 'trieve_ruby_client'
+
+TrieveRubyClient::ClusterAnalytics.openapi_discriminator_name
+# => :'type'
+```
+```
+
+### build
+
+Find the appropriate object from the `openapi_one_of` list and casts the data into it.
+
+#### Example
+
+```ruby
+require 'trieve_ruby_client'
+
+TrieveRubyClient::ClusterAnalytics.build(data)
+# => #<ClusterQueries:0x00007fdd4aab02a0>
+
+TrieveRubyClient::ClusterAnalytics.build(data_that_doesnt_match)
+# => nil
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| **data** | **Mixed** | data to be matched against the list of oneOf items |
+
+#### Return type
+
+- `ClusterQueries`
+- `ClusterTopics`
+- `nil` (if no type matches)
+

data/docs/ClusterAnalyticsFilter.md

@@ -0,0 +1,18 @@
+# TrieveRubyClient::ClusterAnalyticsFilter
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **date_range** | [**DateRange**](DateRange.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'trieve_ruby_client'
+
+instance = TrieveRubyClient::ClusterAnalyticsFilter.new(
+  date_range: null
+)
+```
+

data/docs/ClusterAnalyticsResponse.md

@@ -0,0 +1,49 @@
+# TrieveRubyClient::ClusterAnalyticsResponse
+
+## Class instance methods
+
+### `openapi_one_of`
+
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'trieve_ruby_client'
+
+TrieveRubyClient::ClusterAnalyticsResponse.openapi_one_of
+# =>
+# [
+#   :'SearchClusterResponse',
+#   :'SearchQueryResponse'
+# ]
+```
+
+### build
+
+Find the appropriate object from the `openapi_one_of` list and casts the data into it.
+
+#### Example
+
+```ruby
+require 'trieve_ruby_client'
+
+TrieveRubyClient::ClusterAnalyticsResponse.build(data)
+# => #<SearchClusterResponse:0x00007fdd4aab02a0>
+
+TrieveRubyClient::ClusterAnalyticsResponse.build(data_that_doesnt_match)
+# => nil
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| **data** | **Mixed** | data to be matched against the list of oneOf items |
+
+#### Return type
+
+- `SearchClusterResponse`
+- `SearchQueryResponse`
+- `nil` (if no type matches)
+

data/docs/ClusterQueries.md

@@ -0,0 +1,22 @@
+# TrieveRubyClient::ClusterQueries
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **cluster_id** | **String** |  |  |
+| **page** | **Integer** |  | [optional] |
+| **type** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'trieve_ruby_client'
+
+instance = TrieveRubyClient::ClusterQueries.new(
+  cluster_id: null,
+  page: null,
+  type: null
+)
+```
+

data/docs/ClusterTopics.md

@@ -0,0 +1,20 @@
+# TrieveRubyClient::ClusterTopics
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **filter** | [**ClusterAnalyticsFilter**](ClusterAnalyticsFilter.md) |  | [optional] |
+| **type** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'trieve_ruby_client'
+
+instance = TrieveRubyClient::ClusterTopics.new(
+  filter: null,
+  type: null
+)
+```
+

data/docs/ConditionType.md

@@ -0,0 +1,49 @@
+# TrieveRubyClient::ConditionType
+
+## Class instance methods
+
+### `openapi_one_of`
+
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'trieve_ruby_client'
+
+TrieveRubyClient::ConditionType.openapi_one_of
+# =>
+# [
+#   :'FieldCondition',
+#   :'HasIDCondition'
+# ]
+```
+
+### build
+
+Find the appropriate object from the `openapi_one_of` list and casts the data into it.
+
+#### Example
+
+```ruby
+require 'trieve_ruby_client'
+
+TrieveRubyClient::ConditionType.build(data)
+# => #<FieldCondition:0x00007fdd4aab02a0>
+
+TrieveRubyClient::ConditionType.build(data_that_doesnt_match)
+# => nil
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| **data** | **Mixed** | data to be matched against the list of oneOf items |
+
+#### Return type
+
+- `FieldCondition`
+- `HasIDCondition`
+- `nil` (if no type matches)
+

data/docs/ContentChunkMetadata.md

@@ -0,0 +1,32 @@
+# TrieveRubyClient::ContentChunkMetadata
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **chunk_html** | **String** |  | [optional] |
+| **id** | **String** |  |  |
+| **image_urls** | **Array<String>** |  | [optional] |
+| **num_value** | **Float** |  | [optional] |
+| **qdrant_point_id** | **String** |  |  |
+| **time_stamp** | **Time** |  | [optional] |
+| **tracking_id** | **String** |  | [optional] |
+| **weight** | **Float** |  |  |
+
+## Example
+
+```ruby
+require 'trieve_ruby_client'
+
+instance = TrieveRubyClient::ContentChunkMetadata.new(
+  chunk_html: null,
+  id: null,
+  image_urls: null,
+  num_value: null,
+  qdrant_point_id: null,
+  time_stamp: null,
+  tracking_id: null,
+  weight: null
+)
+```
+

data/docs/CountChunkQueryResponseBody.md

@@ -0,0 +1,18 @@
+# TrieveRubyClient::CountChunkQueryResponseBody
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **count** | **Integer** |  |  |
+
+## Example
+
+```ruby
+require 'trieve_ruby_client'
+
+instance = TrieveRubyClient::CountChunkQueryResponseBody.new(
+  count: null
+)
+```
+

data/docs/CountChunksReqPayload.md

@@ -0,0 +1,26 @@
+# TrieveRubyClient::CountChunksReqPayload
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **filters** | [**ChunkFilter**](ChunkFilter.md) |  | [optional] |
+| **limit** | **Integer** | Set limit to restrict the maximum number of chunks to count. This is useful for when you want to reduce the latency of the count operation. By default the limit will be the number of chunks in the dataset. | [optional] |
+| **query** | **String** | 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. |  |
+| **score_threshold** | **Float** | Set score_threshold to a float to filter out chunks with a score below the threshold. This threshold applies before weight and bias modifications. If not specified, this defaults to 0.0. | [optional] |
+| **search_type** | [**SearchMethod**](SearchMethod.md) |  |  |
+
+## Example
+
+```ruby
+require 'trieve_ruby_client'
+
+instance = TrieveRubyClient::CountChunksReqPayload.new(
+  filters: null,
+  limit: null,
+  query: null,
+  score_threshold: null,
+  search_type: null
+)
+```
+

data/docs/CountQueries.md

@@ -0,0 +1,20 @@
+# TrieveRubyClient::CountQueries
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **filter** | [**SearchAnalyticsFilter**](SearchAnalyticsFilter.md) |  | [optional] |
+| **type** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'trieve_ruby_client'
+
+instance = TrieveRubyClient::CountQueries.new(
+  filter: null,
+  type: null
+)
+```
+

data/docs/CreateChunkGroupReqPayload.md

@@ -0,0 +1,28 @@
+# TrieveRubyClient::CreateChunkGroupReqPayload
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **description** | **String** | Description to assign to the chunk_group. Convenience field for you to avoid having to remember what the group is for. | [optional] |
+| **metadata** | **Object** | Optional metadata to assign to the chunk_group. This is a JSON object that can store any additional information you want to associate with the chunks inside of the chunk_group. | [optional] |
+| **name** | **String** | Name to assign to the chunk_group. Does not need to be unique. | [optional] |
+| **tag_set** | **Array<String>** | 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** | **String** | Optional tracking id to assign to the chunk_group. This is a unique identifier for the chunk_group. | [optional] |
+| **upsert_by_tracking_id** | **Boolean** | 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
+
+```ruby
+require 'trieve_ruby_client'
+
+instance = TrieveRubyClient::CreateChunkGroupReqPayload.new(
+  description: null,
+  metadata: null,
+  name: null,
+  tag_set: null,
+  tracking_id: null,
+  upsert_by_tracking_id: null
+)
+```
+

data/docs/CreateChunkReqPayloadEnum.md

@@ -0,0 +1,49 @@
+# TrieveRubyClient::CreateChunkReqPayloadEnum
+
+## Class instance methods
+
+### `openapi_one_of`
+
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'trieve_ruby_client'
+
+TrieveRubyClient::CreateChunkReqPayloadEnum.openapi_one_of
+# =>
+# [
+#   :'Array<ChunkReqPayload>',
+#   :'ChunkReqPayload'
+# ]
+```
+
+### build
+
+Find the appropriate object from the `openapi_one_of` list and casts the data into it.
+
+#### Example
+
+```ruby
+require 'trieve_ruby_client'
+
+TrieveRubyClient::CreateChunkReqPayloadEnum.build(data)
+# => #<Array<ChunkReqPayload>:0x00007fdd4aab02a0>
+
+TrieveRubyClient::CreateChunkReqPayloadEnum.build(data_that_doesnt_match)
+# => nil
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| **data** | **Mixed** | data to be matched against the list of oneOf items |
+
+#### Return type
+
+- `Array<ChunkReqPayload>`
+- `ChunkReqPayload`
+- `nil` (if no type matches)
+

data/docs/CreateDatasetRequest.md

@@ -5,10 +5,10 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **client_configuration** | **Object** | Client configuration for the dataset, can be arbitrary JSON. We recommend setting to `{}` to start. See docs.trieve.ai for more information or adjust with the admin dashboard. |  |
-| **dataset_name** | **String** | Name of the dataset. Must be unique within the organization. |  |
+| **dataset_name** | **String** | Name of the dataset. |  |
 | **organization_id** | **String** | Organization ID that the dataset will belong to. |  |
 | **server_configuration** | **Object** | Server configuration for the dataset, can be arbitrary JSON. We recommend setting to `{}` to start. See docs.trieve.ai for more information or adjust with the admin dashboard. |  |
-| **tracking_id** | **String** | Optional tracking ID for the dataset. Can be used to track the dataset in external systems. | [optional] |
+| **tracking_id** | **String** | Optional tracking ID for the dataset. Can be used to track the dataset in external systems. Must be unique within the organization. | [optional] |
 
 ## Example