Overview Use Cases Connectors Authentication Getting Started with the Python SDK API Reference ai_agents ai_chat algorithm annotations application_connectors batch_prediction code_completion custom_loss_function custom_metric database_connectors dataset deployment deployment_conversations clearDeploymentConversation createDeploymentConversation deleteDeploymentConversation exportDeploymentConversation getDeploymentConversation listDeploymentConversations renameDeploymentConversation setDeploymentConversationFeedback docstore document_retrievers documentation eda external_app feature_drift feature_group feature_group_row_process feature_group_template file_connectors graph_dashboard holdout_analysis llm_apps model model_monitoring module natural_language_explanation organization pipelines predict prediction_operator project python_function refresh secrets streaming streaming_connectors upload webhooks API Classes API Inputs Documentation Chat Bot API Search Video Tutorials ChatLLM

Method

clearDeploymentConversation POST

Copy POST

Clear the message history of a Deployment Conversation.

Arguments:

REQUIRED	KEY	TYPE	DESCRIPTION
No	deploymentConversationId	str	A unique string identifier associated with the deployment conversation.
No	externalSessionId	str	The external session id associated with the deployment conversation.
No	deploymentId	str	The deployment this conversation belongs to. This is required if not logged in.
No	userMessageIndices	list	Optional list of user message indices to clear. The associated bot response will also be cleared. If not provided, all messages will be cleared.

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

Exceptions:

TYPE	WHEN
DataNotFoundError	`deploymentConversationId` is not found.
DataNotFoundError	`externalSessionId` is not found.
DataNotFoundError	`deploymentId` is not found.

Language: