Interface WatsonxAIParams

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

interface WatsonxAIParams {
    endpoint?: string;
    ibmCloudApiKey?: string;
    modelId?: string;
    modelParameters?: Record<string, unknown>;
    projectId?: string;
    region?: string;
    version?: string;
}

Hierarchy (view full)

Properties

endpoint? ibmCloudApiKey? modelId? modelParameters? projectId? region? version?

Properties

Optional endpoint

endpoint?: string

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

Optional ibmCloudApiKey

ibmCloudApiKey?: string

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

Optional modelId

modelId?: string

WatsonX AI Model ID.

Optional modelParameters

modelParameters?: Record<string, unknown>

Parameters accepted by the WatsonX AI Endpoint.

Optional projectId

projectId?: string

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

Optional region

region?: string

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

Optional version

version?: string

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

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc