Interface GradientEmbeddingsParams

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

interface GradientEmbeddingsParams {
    gradientAccessKey?: string;
    maxConcurrency?: number;
    maxRetries?: number;
    onFailedAttempt?: FailedAttemptHandler;
    workspaceId?: string;
}

Hierarchy

  • EmbeddingsParams
    • GradientEmbeddingsParams

Implemented by

Properties

gradientAccessKey? maxConcurrency? maxRetries? onFailedAttempt? workspaceId?

Properties

OptionalgradientAccessKey

gradientAccessKey?: string

Gradient AI Access Token. Provide Access Token if you do not wish to automatically pull from env.

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.

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.

OptionalworkspaceId

workspaceId?: string

Gradient Workspace Id. Provide workspace id if you do not wish to automatically pull from env.

Settings

Member Visibility

On This Page

Properties