Type Alias ChunkReqPayload

ChunkReqPayload: {
    chunk_html?: string | null;
    convert_html_to_text?: boolean | null;
    fulltext_boost?: FullTextBoost | null;
    group_ids?: string[] | null;
    group_tracking_ids?: string[] | null;
    image_urls?: string[] | null;
    link?: string | null;
    location?: GeoInfo | null;
    metadata?: unknown;
    num_value?: number | null;
    semantic_boost?: SemanticBoost | null;
    semantic_content?: string | null;
    split_avg?: boolean | null;
    tag_set?: string[] | null;
    time_stamp?: string | null;
    tracking_id?: string | null;
    upsert_by_tracking_id?: boolean | null;
    weight?: number | null;
}

Type declaration

  • Optionalchunk_html?: string | null

    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.

  • Optionalconvert_html_to_text?: boolean | null

    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.

  • Optionalfulltext_boost?: FullTextBoost | null
  • Optionalgroup_ids?: string[] | null

    Group ids are the Trieve generated 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. Groups with these Trieve generated ids must be created first, it cannot be arbitrarily created through this route.

  • Optionalgroup_tracking_ids?: string[] | null

    Group tracking_ids are the user-assigned 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. If a group with the tracking_id does not exist, it will be created.

  • Optionalimage_urls?: string[] | null

    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.

  • Optionallink?: string | null

    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.

  • Optionallocation?: GeoInfo | null
  • Optionalmetadata?: unknown

    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.

  • Optionalnum_value?: number | null

    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.

  • Optionalsemantic_boost?: SemanticBoost | null
  • Optionalsemantic_content?: string | null

    If semantic_content is present, it will be used for creating semantic embeddings instead of the innerText chunk_html. chunk_html will still be the only thing stored and always used for fulltext functionality.

  • Optionalsplit_avg?: boolean | null

    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.

  • Optionaltag_set?: string[] | null

    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.

  • Optionaltime_stamp?: string | null

    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.

  • Optionaltracking_id?: string | null

    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.

  • Optionalupsert_by_tracking_id?: boolean | null

    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.

  • Optionalweight?: number | null

    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.

Settings

Member Visibility