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 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 secrets streaming streaming_connectors upload user webhooks API Classes API Inputs Documentation Chat Bot API Search How to

Method

describeImage POST

Copy POST

Describe the similarity between an image and a list of categories.

Arguments:

REQUIRED	KEY	TYPE	DESCRIPTION
Yes	deploymentToken	str	Authentication token to access created deployments. This token is only authorized to predict on deployments in the current project, and can be safely embedded in an application or website.
Yes	deploymentId	str	Unique identifier of a deployment created under the project.
Yes	image	bytes	Image to describe.
Yes	categories	list	List of candidate categories to compare with the image.
No	topN	int	Return the N most similar categories.

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: