Type Alias CreateSingleChunkGroupReqPayload

CreateSingleChunkGroupReqPayload: {
    description?: string | null;
    metadata?: unknown;
    name?: string | null;
    tag_set?: string[] | null;
    tracking_id?: string | null;
    upsert_by_tracking_id?: boolean | null;
}

Type declaration

  • Optionaldescription?: string | null

    Description to assign to the chunk_group. Convenience field for you to avoid having to remember what the group is for.

  • Optionalmetadata?: unknown

    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.

  • Optionalname?: string | null

    Name to assign to the chunk_group. Does not need to be unique.

  • Optionaltag_set?: string[] | null

    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.

  • Optionaltracking_id?: string | null

    Optional tracking id to assign to the chunk_group. This is a unique identifier for the chunk_group.

  • Optionalupsert_by_tracking_id?: boolean | null

    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.