Skip to content

Latest commit

 

History

History
34 lines (28 loc) · 2.85 KB

UpdateChunkByTrackingIdData.md

File metadata and controls

34 lines (28 loc) · 2.85 KB
Raw

TrieveRubyClient::UpdateChunkByTrackingIdData

Properties

Name Type Description Notes
chunk_html String 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 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 update a chunk and add it to a group or multiple groups in one request. [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 update a chunk and add it to a group or multiple groups in one request. [optional]
link String 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]
metadata Object The 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. If no metadata is provided, the existing metadata will be used. [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. If no time_stamp is provided, the existing time_stamp will be used. [optional]
tracking_id String Tracking_id of the chunk you want to update. This is required to match an existing chunk.
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. If no weight is provided, the existing weight will be used. [optional]

Example

require 'trieve_ruby_client'

instance = TrieveRubyClient::UpdateChunkByTrackingIdData.new(
  chunk_html: null,
  convert_html_to_text: null,
  group_ids: null,
  group_tracking_ids: null,
  link: null,
  metadata: null,
  time_stamp: null,
  tracking_id: null,
  weight: null
)