Embeddings API Reference

Get a vector representation of a given input so that the machine learning models and algorithms can easily consume.

Creates an embedding vector that represents the input text. i

POST https://api.core42.ai/openai/deployments/{deployment-id}/embeddings

Name	In	Required	Type	Description
deployment-id	template	true	string	Model ID of the model to use for this request. The available model is text-embedding-3-large.

Request

POST https://api.core42.ai/v1/embeddings

Request Parameters

Name	Required	Type	Description
model	true	string	ID of the model to use for this request. The available model is text-embedding-3-large.
input	true	string, array	Text to embed, encoded as a string. To embed multiple inputs in a single request, pass an array of strings. The maximum length of input text for our latest embedding models is 8192 tokens. You should verify that your inputs don't exceed this limit before making a request. If sending an array of inputs in a single embedding request, the maximum array size is 2048. Note: Unless you are embedding code, it is suggested to replace newlines (\n) in your input with a single space, as inferior results are observed when newlines are present.
dimensions	false	integer	The number of dimensions the resulting output embeddings should have. Note: This parameter is only supported in text-embedding-3-large and later models.
user	false	string	A unique identifier represents your end-user.
input_type	false	string	The input type used for embedding searches.
ts	false	string	Timestamp of the request. For example, 2024-03-18T05:40:18.264Z.
encoding_format	false	string	The format to return the embeddings in. Values can be either float or base64. The default value is float.