Interface CohereEmbeddingsParams

Interface that extends EmbeddingsParams and defines additional parameters specific to the CohereEmbeddings class.

interface CohereEmbeddingsParams {
    model: string;
    batchSize?: number;
    inputType?: string;
}

Hierarchy

  • EmbeddingsParams
    • CohereEmbeddingsParams

Implemented by

Properties

model batchSize? inputType?

Properties

model

model: string

Optional batchSize

batchSize?: number

The maximum number of documents to embed in a single request. This is limited by the Cohere API to a maximum of 96.

Optional inputType

inputType?: string

Specifies the type of input you're giving to the model. Not required for older versions of the embedding models (i.e. anything lower than v3), but is required for more recent versions (i.e. anything bigger than v2).

  • search_document - Use this when you encode documents for embeddings that you store in a vector database for search use-cases.
  • search_query - Use this when you query your vector DB to find relevant documents.
  • classification - Use this when you use the embeddings as an input to a text classifier.
  • clustering - Use this when you want to cluster the embeddings.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc