Interface TogetherAIEmbeddingsParams

Interface for TogetherAIEmbeddingsParams parameters. Extends EmbeddingsParams and defines additional parameters specific to the TogetherAIEmbeddings class.

interface TogetherAIEmbeddingsParams {
    apiKey?: string;
    batchSize?: number;
    model?: string;
    modelName?: string;
    stripNewLines?: boolean;
    timeout?: number;
}

Hierarchy

  • EmbeddingsParams
    • TogetherAIEmbeddingsParams

Implemented by

Properties

apiKey? batchSize? model? modelName? stripNewLines? timeout?

Properties

Optional apiKey

apiKey?: string

The API key to use for the TogetherAI API.

Default

{process.env.TOGETHER_AI_API_KEY}

Optional batchSize

batchSize?: number

The maximum number of documents to embed in a single request.

Default

{512}

Optional model

model?: string

Model name to use

Default

{"togethercomputer/m2-bert-80M-8k-retrieval"}

Optional modelName

modelName?: string

Model name to use Alias for model

Default

{"togethercomputer/m2-bert-80M-8k-retrieval"}

Optional stripNewLines

stripNewLines?: boolean

Whether to strip new lines from the input text. May not be suitable for all use cases.

Default

{false}

Optional timeout

timeout?: number

Timeout to use when making requests to TogetherAI.

Default

{undefined}

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc