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 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 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 webhooks API Classes API Inputs Documentation Chat Bot API Search Video Tutorials ChatLLM

Method

getSearchResults POST

Copy POST

Return the most relevant search results to the search query from the uploaded documents.

Arguments:

REQUIRED	KEY	TYPE	DESCRIPTION
Yes	deploymentToken	str	A token used to authenticate access to created deployments. This token is only authorized to predict on deployments in this project, so it can be securely embedded in an application or website.
Yes	deploymentId	str	A unique identifier of a deployment created under the project.
Yes	queryData	dict	A dictionary where the key is "Content" and the value is the text from which entities are to be extracted.
No	num	int	Number of search results to return.

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
	List[NlpSearchPrediction]

Exceptions:

TYPE	WHEN
DataNotFoundError	`deploymentId` is not found.

Language: