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

getKNearest POST

Copy POST

Returns the k nearest neighbors for the provided embedding vector.

Arguments:

REQUIRED	KEY	TYPE	DESCRIPTION
Yes	deploymentToken	str	The deployment token 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	The unique identifier to a deployment created under the project.
Yes	vector	List[float]	Input vector to perform the k nearest neighbors with.
No	k	int	Overrideable number of items to return.
No	distance	str	Specify the distance function to use. Options include “dot“, “cosine“, “euclidean“, and “manhattan“. Default = “dot“
No	includeScore	bool	If True, will return the score alongside the resulting embedding value.
No	catalogId	str	An optional parameter honored only for embeddings that provide a catalog id

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[dict]

Exceptions:

TYPE	WHEN
DataNotFoundError	`deploymentId` is not found.
DataNotFoundError	`catalogId` is not found.

Language: