Method
createChatSession POST
Copy POST

Creates a chat session with Data Science Co-pilot.

Arguments:

REQUIRED KEY TYPE DESCRIPTION
No projectId str The unique project identifier this chat session belongs to
No name str The name of the chat session. Defaults to the project name.
Note: The arguments for the API methods follow camelCase but for Python SDK underscore_case is followed.

Response:

KEY TYPE DESCRIPTION
success Boolean true if the call succeeded, false if there was an error
result ChatSession
KEY TYPE Description
answer str The response from the chatbot
chatSessionId str The chat session id
projectId str The project id associated with the chat session
name str The name of the chat session
createdAt str The timestamp at which the chat session was created
status str The status of the chat sessions
aiBuildingInProgress bool Whether the AI building is in progress or not
notification str A warn/info message about the chat session. For example, a suggestion to create a new session if the current one is too old
whiteboard str A set of whiteboard notes associated with the chat session
chatHistory ChatMessage The chat history for the conversation
KEY TYPE Description
role str The role of the message sender
text List[dict] A list of text segments for the message
timestamp str The timestamp at which the message was sent
isUseful bool Whether this message was marked as useful or not
feedback str The feedback provided for the message
docIds List[str] A list of IDs of the uploaded document if the message has
hotkeyTitle str The title of the hotkey prompt if the message has one
tasks List[str] The list of spawned tasks, if the message was broken down into smaller sub-tasks.
keywordArguments dict A dict of kwargs used to generate the response.
nextAiBuildingTask AiBuildingTask The next AI building task for the chat session
KEY TYPE Description
task str The task to be performed
taskType str The type of task

Exceptions:

TYPE WHEN
DataNotFoundError

projectId is not found.
Language:

© Copyright