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.
No	arguments	list	Positional arguments to the agent execute function.
No	keywordArguments	dict	A dictionary where each 'key' represents the parameter name and its corresponding 'value' represents the value of that parameter for the agent execute function.
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.
No	blobs	dict	A dictionary of binary data to use as inputs to the agent execute function.

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

AgentDataExecutionResult

KEY

TYPE

Description

response

str

The result of agent conversation execution.

deploymentConversationId

The unique identifier of the deployment conversation.

docInfos

AgentDataDocumentInfo

A list of dict containing information on documents uploaded to agent.

KEY	TYPE	Description
docId	str	The docstore Document ID of the document.
filename	str	The file name of the uploaded document.
mimeType	str	The mime type of the uploaded document.
size	int	The total size of the uploaded document.
pageCount	int	The total number of pages in the uploaded document.

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

Language: