Module topic_api

Source

Enums§

CreateTopicError
struct for typed errors of method create_topic
DeleteTopicError
struct for typed errors of method delete_topic
GetAllTopicsForOwnerIdError
struct for typed errors of method get_all_topics_for_owner_id
UpdateTopicError
struct for typed errors of method update_topic

Functions§

create_topic
Create a new chat topic. Topics are attached to a owner_id’s and act as a coordinator for conversation message history of gen-AI chat sessions. Auth’ed user or api key must have an admin or owner role for the specified dataset’s organization.
delete_topic
Delete an existing chat topic. When a topic is deleted, all associated chat messages are also deleted. Auth’ed user or api key must have an admin or owner role for the specified dataset’s organization.
get_all_topics_for_owner_id
Get all topics belonging to an arbitary owner_id. This is useful for managing message history and chat sessions. It is common to use a browser fingerprint or your user’s id as the owner_id. Auth’ed user or api key must have an admin or owner role for the specified dataset’s organization.
update_topic
Update an existing chat topic. Currently, only the name of the topic can be updated. Auth’ed user or api key must have an admin or owner role for the specified dataset’s organization.