trieve_ruby_client 0.3.4

data/docs/ChunkMetadata.md

@@ -0,0 +1,42 @@
+# TrieveRubyClient::ChunkMetadata
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **chunk_html** | **String** |  | [optional] |
+| **content** | **String** |  |  |
+| **created_at** | **Time** |  |  |
+| **dataset_id** | **String** |  |  |
+| **id** | **String** |  |  |
+| **link** | **String** |  | [optional] |
+| **metadata** | **Object** |  | [optional] |
+| **qdrant_point_id** | **String** |  | [optional] |
+| **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::ChunkMetadata.new(
+  chunk_html: null,
+  content: null,
+  created_at: null,
+  dataset_id: null,
+  id: null,
+  link: null,
+  metadata: null,
+  qdrant_point_id: null,
+  tag_set: null,
+  time_stamp: null,
+  tracking_id: null,
+  updated_at: null,
+  weight: null
+)
+```
+

data/docs/ChunkMetadataWithFileData.md

@@ -0,0 +1,44 @@
+# TrieveRubyClient::ChunkMetadataWithFileData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **chunk_html** | **String** |  | [optional] |
+| **content** | **String** |  |  |
+| **created_at** | **Time** |  |  |
+| **file_id** | **String** |  | [optional] |
+| **file_name** | **String** |  | [optional] |
+| **id** | **String** |  |  |
+| **link** | **String** |  | [optional] |
+| **metadata** | **Object** |  | [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::ChunkMetadataWithFileData.new(
+  chunk_html: null,
+  content: null,
+  created_at: null,
+  file_id: null,
+  file_name: null,
+  id: null,
+  link: null,
+  metadata: null,
+  qdrant_point_id: null,
+  tag_set: null,
+  time_stamp: null,
+  tracking_id: null,
+  updated_at: null,
+  weight: null
+)
+```
+

data/docs/ClientDatasetConfiguration.md

@@ -0,0 +1,38 @@
+# TrieveRubyClient::ClientDatasetConfiguration
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **create_chunk_feature** | **Boolean** |  | [optional] |
+| **date_range_value** | **String** |  | [optional] |
+| **document_upload_feature** | **Boolean** |  | [optional] |
+| **file_name_key** | **String** |  |  |
+| **filter_items** | **Object** |  | [optional] |
+| **frontmatter_vals** | **String** |  | [optional] |
+| **image_range_end_key** | **String** |  | [optional] |
+| **image_range_start_key** | **String** |  | [optional] |
+| **lines_before_show_more** | **Integer** |  | [optional] |
+| **search_queries** | **String** |  | [optional] |
+| **suggested_queries** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'trieve_ruby_client'
+
+instance = TrieveRubyClient::ClientDatasetConfiguration.new(
+  create_chunk_feature: null,
+  date_range_value: null,
+  document_upload_feature: null,
+  file_name_key: null,
+  filter_items: null,
+  frontmatter_vals: null,
+  image_range_end_key: null,
+  image_range_start_key: null,
+  lines_before_show_more: null,
+  search_queries: null,
+  suggested_queries: null
+)
+```
+

data/docs/CreateChunkData.md

@@ -0,0 +1,42 @@
+# TrieveRubyClient::CreateChunkData
+
+## Properties
+
+| 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. | [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] |
+| **file_id** | **String** | 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** | **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] |
+| **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] |
+| **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] |
+| **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::CreateChunkData.new(
+  chunk_html: null,
+  chunk_vector: null,
+  file_id: null,
+  group_ids: null,
+  group_tracking_ids: null,
+  link: null,
+  metadata: null,
+  split_avg: null,
+  tag_set: null,
+  time_stamp: null,
+  tracking_id: null,
+  upsert_by_tracking_id: null,
+  weight: null
+)
+```
+

data/docs/CreateChunkGroupData.md

@@ -0,0 +1,22 @@
+# TrieveRubyClient::CreateChunkGroupData
+
+## 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. |  |
+| **name** | **String** | Name to assign to the chunk_group. Does not need to be unique. |  |
+| **tracking_id** | **String** | Optional tracking id to assign to the chunk_group. This is a unique identifier for the chunk_group. | [optional] |
+
+## Example
+
+```ruby
+require 'trieve_ruby_client'
+
+instance = TrieveRubyClient::CreateChunkGroupData.new(
+  description: null,
+  name: null,
+  tracking_id: null
+)
+```
+

data/docs/CreateDatasetRequest.md

@@ -0,0 +1,24 @@
+# TrieveRubyClient::CreateDatasetRequest
+
+## Properties
+
+| 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. |  |
+| **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. |  |
+
+## Example
+
+```ruby
+require 'trieve_ruby_client'
+
+instance = TrieveRubyClient::CreateDatasetRequest.new(
+  client_configuration: null,
+  dataset_name: null,
+  organization_id: null,
+  server_configuration: null
+)
+```
+

data/docs/CreateMessageData.md

@@ -0,0 +1,28 @@
+# TrieveRubyClient::CreateMessageData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **highlight_citations** | **Boolean** | Whether or not to highlight the citations in the response. If this is set to true or not included, the citations will be highlighted. If this is set to false, the citations will not be highlighted. Default is true. | [optional] |
+| **highlight_delimiters** | **Array<String>** | The delimiters to use for highlighting the citations. If this is not included, the default delimiters will be used. Default is `[\".\", \"!\", \"?\", \"\\n\", \"\\t\", \",\"]`. | [optional] |
+| **model** | **String** | The model to use for the assistant's messages. This can be any model from the openrouter model list. If no model is provided, gpt-3.5-turbo will be used. | [optional] |
+| **new_message_content** | **String** | The content of the user message to attach to the topic and then generate an assistant message in response to. |  |
+| **stream_response** | **Boolean** | Whether or not to stream the response. If this is set to true or not included, the response will be a stream. If this is set to false, the response will be a normal JSON response. Default is true. | [optional] |
+| **topic_id** | **String** | The ID of the topic to attach the message to. |  |
+
+## Example
+
+```ruby
+require 'trieve_ruby_client'
+
+instance = TrieveRubyClient::CreateMessageData.new(
+  highlight_citations: null,
+  highlight_delimiters: null,
+  model: null,
+  new_message_content: null,
+  stream_response: null,
+  topic_id: null
+)
+```
+

data/docs/CreateOrganizationData.md

@@ -0,0 +1,18 @@
+# TrieveRubyClient::CreateOrganizationData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | The arbitrary name which will be used to identify the organization. This name must be unique. |  |
+
+## Example
+
+```ruby
+require 'trieve_ruby_client'
+
+instance = TrieveRubyClient::CreateOrganizationData.new(
+  name: null
+)
+```
+

data/docs/CreateTopicData.md

@@ -0,0 +1,22 @@
+# TrieveRubyClient::CreateTopicData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **first_user_message** | **String** | The first message which will belong to the topic. The topic name is generated based on this message similar to how it works in the OpenAI chat UX if a name is not explicitly provided on the name request body key. | [optional] |
+| **model** | **String** | The model to use for the assistant's messages. This can be any model from the openrouter model list. If no model is provided, the gpt-3.5-turbo will be used. | [optional] |
+| **name** | **String** | The name of the topic. If this is not provided, the topic name is generated from the first_user_message. | [optional] |
+
+## Example
+
+```ruby
+require 'trieve_ruby_client'
+
+instance = TrieveRubyClient::CreateTopicData.new(
+  first_user_message: null,
+  model: null,
+  name: null
+)
+```
+

data/docs/Dataset.md

@@ -0,0 +1,30 @@
+# TrieveRubyClient::Dataset
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **client_configuration** | **Object** |  |  |
+| **created_at** | **Time** |  |  |
+| **id** | **String** |  |  |
+| **name** | **String** |  |  |
+| **organization_id** | **String** |  |  |
+| **server_configuration** | **Object** |  |  |
+| **updated_at** | **Time** |  |  |
+
+## Example
+
+```ruby
+require 'trieve_ruby_client'
+
+instance = TrieveRubyClient::Dataset.new(
+  client_configuration: null,
+  created_at: null,
+  id: null,
+  name: null,
+  organization_id: null,
+  server_configuration: null,
+  updated_at: null
+)
+```
+

data/docs/DatasetAndUsage.md

@@ -0,0 +1,20 @@
+# TrieveRubyClient::DatasetAndUsage
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **dataset** | [**DatasetDTO**](DatasetDTO.md) |  |  |
+| **dataset_usage** | [**DatasetUsageCount**](DatasetUsageCount.md) |  |  |
+
+## Example
+
+```ruby
+require 'trieve_ruby_client'
+
+instance = TrieveRubyClient::DatasetAndUsage.new(
+  dataset: null,
+  dataset_usage: null
+)
+```
+