Type Alias UpdateChunkGroupReqPayload

UpdateChunkGroupReqPayload: {
    description?: string | null;
    group_id?: string | null;
    metadata?: unknown;
    name?: string | null;
    tag_set?: string[] | null;
    tracking_id?: string | null;
    update_chunks?: 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. If not provided, the description will not be updated.

  • Optionalgroup_id?: string | null

    Id of the chunk_group to update.

  • 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. If not provided, the name will not be updated.

  • 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

    Tracking Id of the chunk_group to update.

  • Optionalupdate_chunks?: boolean | null

    Flag to update the chunks in the group. If true, each chunk in the group will be updated by appending the group's tags to the chunk's tags. Default is false.

Settings

Member Visibility