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.