Interface TogetherAIEmbeddingsParams

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

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

Hierarchy

  • EmbeddingsParams
    • TogetherAIEmbeddingsParams

Implemented by

Properties

apiKey? batchSize? maxConcurrency? maxRetries? model? modelName? onFailedAttempt? stripNewLines? timeout?

Properties

OptionalapiKey

apiKey?: string

The API key to use for the TogetherAI API.

Default

{process.env.TOGETHER_AI_API_KEY}

OptionalbatchSize

batchSize?: number

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

Default

{512}

OptionalmaxConcurrency

maxConcurrency?: number

The maximum number of concurrent calls that can be made. Defaults to Infinity, which means no limit.

OptionalmaxRetries

maxRetries?: number

The maximum number of retries that can be made for a single call, with an exponential backoff between each attempt. Defaults to 6.

Optionalmodel

model?: string

Model name to use

Default

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

OptionalmodelName

modelName?: string

Model name to use Alias for model

Default

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

OptionalonFailedAttempt

onFailedAttempt?: FailedAttemptHandler

Custom handler to handle failed attempts. Takes the originally thrown error object as input, and should itself throw an error if the input error is not retryable.

OptionalstripNewLines

stripNewLines?: boolean

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

Default

{false}

Optionaltimeout

timeout?: number

Timeout to use when making requests to TogetherAI.

Default

{undefined}

Settings

Member Visibility

On This Page

Properties