Interface WatsonxAIParams

The WatsonxAIParams interface defines the input parameters for the WatsonxAI class.

interface WatsonxAIParams {
    cache?: boolean | BaseCache<Generation[]>;
    callbackManager?: CallbackManager;
    callbacks?: Callbacks;
    concurrency?: number;
    endpoint?: string;
    ibmCloudApiKey?: string;
    maxConcurrency?: number;
    maxRetries?: number;
    metadata?: Record<string, unknown>;
    modelId?: string;
    modelParameters?: Record<string, unknown>;
    onFailedAttempt?: FailedAttemptHandler;
    projectId?: string;
    region?: string;
    tags?: string[];
    verbose?: boolean;
    version?: string;
}

Hierarchy

  • BaseLLMParams
    • WatsonxAIParams

Properties

cache? callbackManager? callbacks? concurrency? endpoint? ibmCloudApiKey? maxConcurrency? maxRetries? metadata? modelId? modelParameters? onFailedAttempt? projectId? region? tags? verbose? version?

Properties

Optionalcache

cache?: boolean | BaseCache<Generation[]>

OptionalcallbackManager

callbackManager?: CallbackManager

Deprecated

Use callbacks instead

Optionalcallbacks

callbacks?: Callbacks

Optionalconcurrency

concurrency?: number

Deprecated

Use maxConcurrency instead

Optionalendpoint

endpoint?: string

WatsonX AI Complete Endpoint. Can be used if you want a fully custom endpoint.

OptionalibmCloudApiKey

ibmCloudApiKey?: string

WatsonX AI Key. Provide API Key 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.

Optionalmetadata

metadata?: Record<string, unknown>

OptionalmodelId

modelId?: string

WatsonX AI Model ID.

OptionalmodelParameters

modelParameters?: Record<string, unknown>

Parameters accepted by the WatsonX AI Endpoint.

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.

OptionalprojectId

projectId?: string

WatsonX AI Key. Provide API Key if you do not wish to automatically pull from env.

Optionalregion

region?: string

IBM Cloud Compute Region. eg. us-south, us-east, etc.

Optionaltags

tags?: string[]

Optionalverbose

verbose?: boolean

Optionalversion

version?: string

WatsonX AI Version. Date representing the WatsonX AI Version. eg. 2023-05-29

Settings

Member Visibility

On This Page

Properties