Overview Use Cases Connectors Authentication Getting Started with the Python SDK API 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 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 mcp_server_connections model model_monitoring module natural_language_explanation organization pipelines predict checkConstraints classifyImage classifyPDF describeImage executeAgentWithBinaryData generateImage getAlternativeAssignments getAnomalies getAssignments getAssignmentsOnlineWithNewSerializedInputs getChatResponse getChatResponseWithBinaryData getClassification getCluster getCompletion getConversationResponse getConversationResponseWithBinaryData getEntailment getEntitiesFromPDF getEventAnomalyScore getForecast getKNearest getLabels getMatrixAgentSchema getMultipleKNearest getObjectsFromImage getOptimizationInputsFromSerialized getPersonalizedRanking getRankedItems getRecommendations getRelatedItems getSearchResults getSentiment getStreamingChatResponse getStreamingConversationResponse getSummary getTextFromDocument getTimeseriesAnomalies isAnomaly lookupFeatures lookupMatches pauseAutonomousAgent predict predictChurn predictClass predictFraud predictFromDatasets predictLanguage predictLead predictMultiple predictTakeover predictTarget predictWithBinaryData scoreImage startAutonomousAgent transcribeAudio transferStyle prediction_operator project python_function refresh routellm secrets streaming streaming_connectors upload user webhooks API Classes API Inputs Documentation Chat Bot API Search How to

Method

getMatrixAgentSchema POST

Copy POST

Executes a deployed AI agent function using the arguments as keyword arguments to the agent execute function.

Arguments:

REQUIRED	KEY	TYPE	DESCRIPTION
Yes	deploymentToken	str	The deployment token used to authenticate access to created deployments. This token is only authorized to predict on deployments in this project, so it is safe to embed this model inside of an application or website.
Yes	deploymentId	str	A unique string identifier for the deployment created under the project.
Yes	query	str	User input query to initialize the matrix computation.
No	docInfos	list	An optional list of documents use for constructing the matrix. A keyword 'doc_id' is expected to be present in each document for retrieving contents from docstore.
No	deploymentConversationId	str	A unique string identifier for the deployment conversation used for the conversation.
No	externalSessionId	str	A unique string identifier for the session used for the conversation. If both deployment_conversation_id and external_session_id are not provided, a new session will be created.

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
deploymentConversationId	Unique String Identifier
matrixAgentSchema	MatrixAgentSchema

Exceptions:

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

Language: