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 model model_monitoring module natural_language_explanation organization pipelines predict checkConstraints classifyImage classifyPDF describeImage executeAgent executeAgentWithBinaryData executeConversationAgent generateImage getAlternativeAssignments getAnomalies getAssignments getChatResponse getChatResponseWithBinaryData getClassification getCluster getCompletion getConversationResponse getConversationResponseWithBinaryData getEntailment getEntitiesFromPDF getEventAnomalyScore getForecast getKNearest getLabels getMatrixAgentSchema getMultipleKNearest getObjectsFromImage 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 secrets streaming streaming_connectors upload user webhooks API Classes API Inputs Documentation Chat Bot API Search How to

Method

predict POST

Copy POST

Returns a prediction for Predictive Modeling

Arguments:

REQUIRED	KEY	TYPE	DESCRIPTION
Yes	deploymentToken	str	A deployment token used to authenticate access to created deployments. This token is only authorized to predict on deployments in this project, and is safe to embed in an application or website.
Yes	deploymentId	str	A unique identifier for a deployment created under the project.
Yes	queryData	dict	A dictionary where the key is the column name (e.g. a column with name 'user_id' in the dataset) mapped to the column mapping USER_ID that uniquely identifies the entity against which a prediction is performed, and the value is the unique value of the same entity.
No	kwargs	dict	Additional usecase specific keyword arguments to be passed. Example - explain_predictions for regression models.

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
	Prediction

Exceptions:

TYPE	WHEN
DataNotFoundError	`deploymentId` is not found.

Language: