Module chunk_group_api

Enums

AddChunkToGroupByTrackingIdError

struct for typed errors of method add_chunk_to_group_by_tracking_id

AddChunkToGroupError

struct for typed errors of method add_chunk_to_group

CreateChunkGroupError

struct for typed errors of method create_chunk_group

DeleteChunkGroupError

struct for typed errors of method delete_chunk_group

DeleteGroupByTrackingIdError

struct for typed errors of method delete_group_by_tracking_id

GetChunkGroupError

struct for typed errors of method get_chunk_group

GetChunksInGroupByTrackingIdError

struct for typed errors of method get_chunks_in_group_by_tracking_id

GetChunksInGroupError

struct for typed errors of method get_chunks_in_group

GetGroupByTrackingIdError

struct for typed errors of method get_group_by_tracking_id

GetGroupsForChunksError

struct for typed errors of method get_groups_for_chunks

GetGroupsForDatasetError

struct for typed errors of method get_groups_for_dataset

GetRecommendedGroupsError

struct for typed errors of method get_recommended_groups

RemoveChunkFromGroupError

struct for typed errors of method remove_chunk_from_group

SearchOverGroupsError

struct for typed errors of method search_over_groups

SearchWithinGroupError

struct for typed errors of method search_within_group

UpdateChunkGroupError

struct for typed errors of method update_chunk_group

UpdateGroupByTrackingIdError

struct for typed errors of method update_group_by_tracking_id

Functions

add_chunk_to_group

Route to add a chunk to a group. One of chunk_id or chunk_tracking_id must be provided. Auth’ed user or api key must have an admin or owner role for the specified dataset’s organization.

add_chunk_to_group_by_tracking_id

Route to add a chunk to a group by tracking id. One of chunk_id or chunk_tracking_id must be provided. Auth’ed user or api key must have an admin or owner role for the specified dataset’s organization.

create_chunk_group

Create new chunk_group(s). This is a way to group chunks together. If you try to create a chunk_group with the same tracking_id as an existing chunk_group, this operation will fail. Only 1000 chunk groups can be created at a time. Auth’ed user or api key must have an admin or owner role for the specified dataset’s organization.

delete_chunk_group

This will delete a chunk_group. If you set delete_chunks to true, it will also delete the chunks within the group. Auth’ed user or api key must have an admin or owner role for the specified dataset’s organization.

delete_group_by_tracking_id

Delete a chunk_group with the given tracking id. Auth’ed user or api key must have an admin or owner role for the specified dataset’s organization.

get_chunk_group

Fetch the group with the given id. get_group

get_chunks_in_group

Route to get all chunks for a group. The response is paginated, with each page containing 10 chunks. Page is 1-indexed.

get_chunks_in_group_by_tracking_id

Route to get all chunks for a group. The response is paginated, with each page containing 10 chunks. Support for custom page size is coming soon. Page is 1-indexed.

get_group_by_tracking_id

Fetch the group with the given tracking id. get_group_by_tracking_id

get_groups_for_chunks

Route to get the groups that a chunk is in.

get_groups_for_dataset

Fetch the groups which belong to a dataset specified by its id.

get_recommended_groups

Route to get recommended groups. This route will return groups which are similar to the groups in the request body. You must provide at least one positive group id or group tracking id.

remove_chunk_from_group

Route to remove a chunk from a group. Auth’ed user or api key must be an admin or owner of the dataset’s organization to remove a chunk from a group.

search_over_groups

This route allows you to get groups as results instead of chunks. Each group returned will have the matching chunks sorted by similarity within the group. This is useful for when you want to get groups of chunks which are similar to the search query. If choosing hybrid search, the results will be re-ranked using scores from a cross encoder model. Compatible with semantic, fulltext, or hybrid search modes.

search_within_group

This route allows you to search only within a group. This is useful for when you only want search results to contain chunks which are members of a specific group. If choosing hybrid search, the results will be re-ranked using scores from a cross encoder model.

update_chunk_group

Update a chunk_group. One of group_id or tracking_id must be provided. If you try to change the tracking_id to one that already exists, this operation will fail. Auth’ed user or api key must have an admin or owner role for the specified dataset’s organization.

update_group_by_tracking_id

Update a chunk_group with the given tracking id. Auth’ed user or api key must have an admin or owner role for the specified dataset’s organization.