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

Hierarchy

Implemented by

Properties

apiKey?: string

The API key to use for the TogetherAI API.

Default

{process.env.TOGETHER_AI_API_KEY}
batchSize?: number

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

Default

{512}
maxConcurrency?: number

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

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.

modelName?: string

Model name to use

Default

{"togethercomputer/m2-bert-80M-8k-retrieval"}
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.

stripNewLines?: boolean

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

Default

{false}
timeout?: number

Timeout to use when making requests to TogetherAI.

Default

{undefined}

Generated using TypeDoc