embedJobs

Create an Embed Job

This API launches an async Embed job for a Dataset of type embed-input. The result of a completed embed job is new Dataset of type embed-output, which contains the original text entries and the corresponding embeddings.

post/v1/embed-jobs

Request

  • Base URL: https://api.cohere.com
  • URL: https://api.cohere.com/v1/embed-jobs
  • Auth: HTTP bearer

Headers

X-Client-Namestring

The name of the project that is making the request.

Request body

modelstring string required

ID of the embedding model.

Available models and corresponding embedding dimensions:

  • embed-english-v3.0 : 1024
  • embed-multilingual-v3.0 : 1024
  • embed-english-light-v3.0 : 384
  • embed-multilingual-light-v3.0 : 384
dataset_idstring required

ID of a Dataset. The Dataset must be of type embed-input and must have a validation status Validated

input_type'search_document' | 'search_query' | 'classification' | 'clustering' | 'image' required

Specifies the type of input passed to the model. Required for embedding models v3 and higher.

  • "search_document": Used for embeddings stored in a vector database for search use-cases.
  • "search_query": Used for embeddings of search queries run against a vector DB to find relevant documents.
  • "classification": Used for embeddings passed through a text classifier.
  • "clustering": Used for the embeddings run through a clustering algorithm.
  • "image": Used for embeddings with image input.
namestring

The name of the embed job.

embedding_typesEmbeddingType[]

Specifies the types of embeddings you want to get back. Not required and default is None, which returns the Embed Floats response type. Can be one or more of the following types.

  • "float": Use this when you want to get back the default float embeddings. Valid for all models.
  • "int8": Use this when you want to get back signed int8 embeddings. Valid for v3 and newer model versions.
  • "uint8": Use this when you want to get back unsigned int8 embeddings. Valid for v3 and newer model versions.
  • "binary": Use this when you want to get back signed binary embeddings. Valid for v3 and newer model versions.
  • "ubinary": Use this when you want to get back unsigned binary embeddings. Valid for v3 and newer model versions.
truncate'START' | 'END'

One of START|END to specify how the API will handle inputs longer than the maximum token length.

Passing START will discard the start of the input. END will discard the end of the input. In both cases, input is discarded until the remaining input is exactly the maximum input token length for the model.

Response

OK

job_idstring required

Changes

No recorded changes to this operation across all 1 revision of this API.