Type Alias CreatePresignedUrlForCsvJsonlReqPayload

CreatePresignedUrlForCsvJsonlReqPayload: {
    description?: string | null;
    file_name: string;
    fulltext_boost_factor?: number | null;
    group_tracking_id?: string | null;
    link?: string | null;
    mappings?: ChunkReqPayloadMappings | null;
    metadata?: unknown;
    semantic_boost_factor?: number | null;
    tag_set?: string[] | null;
    time_stamp?: string | null;
    upsert_by_tracking_id?: boolean | null;
}

Type declaration

  • Optionaldescription?: string | null

    Description is an optional convience field so you do not have to remember what the file contains or is about. It will be included on the group resulting from the file which will hold its chunk.

  • file_name: string

    Name of the file being uploaded, including the extension. Will be used to determine CSV or JSONL for processing.

  • Optionalfulltext_boost_factor?: number | null

    Amount to multiplicatevly increase the frequency of the tokens in the boost phrase for each row's chunk by. Applies to fulltext (SPLADE) and keyword (BM25) search.

  • Optionalgroup_tracking_id?: string | null

    Group tracking id is an optional field which allows you to specify the tracking id of the group that is created from the file. Chunks created will be created with the tracking id of group_tracking_id|<index of chunk>

  • Optionallink?: string | null

    Link to the file. This can also be any string. This can be used to filter when searching for the file's resulting chunks. The link value will not affect embedding creation.

  • Optionalmappings?: ChunkReqPayloadMappings | 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. Will be passed down to the file's chunks.

  • Optionalsemantic_boost_factor?: number | null

    Arbitrary float (positive or negative) specifying the multiplicate factor to apply before summing the phrase vector with the chunk_html embedding vector. Applies to semantic (embedding model) search.

  • Optionaltag_set?: string[] | null

    Tag set is a comma separated list of tags which will be passed down to the chunks made from the file. Each tag will be joined with what's creatd per row of the CSV or JSONL file.

  • Optionaltime_stamp?: string | null

    Time stamp should be an ISO 8601 combined date and time without timezone. Time_stamp is used for time window filtering and recency-biasing search results. Will be passed down to the file's chunks.

  • Optionalupsert_by_tracking_id?: boolean | null

    Upsert by tracking_id. If true, chunks will be upserted by tracking_id. If false, chunks with the same tracking_id as another already existing chunk will be ignored. Defaults to true.

Settings

Member Visibility