Class BedrockChat

Example

const model = new BedrockChat({
  model: "anthropic.claude-v2",
  region: "us-east-1",
});
const res = await model.invoke([{ content: "Tell me a joke" }]);
console.log(res);

Hierarchy (view full)

Constructors

constructor

Properties

codec credentials fetchFn guardrailIdentifier guardrailVersion model region streaming usesMessagesApi endpointHost? guardrailConfig? maxTokens? modelKwargs? stopSequences? temperature? trace?

Methods

bindTools getLsParams invocationParams

Constructors

constructor

Properties

codec

codec: EventStreamCodec = ...

credentials

credentials: CredentialType

fetchFn

fetchFn: {
    (input, init?): Promise<Response>;
    (input, init?): Promise<Response>;
}

Type declaration

    • (input, init?): Promise<Response>

    • MDN Reference

      Parameters

      • input: string | URL | Request
      • Optional init: RequestInit

      Returns Promise<Response>

    • (input, init?): Promise<Response>

    • Parameters

      • input: RequestInfo
      • Optional init: RequestInit

      Returns Promise<Response>

guardrailIdentifier

guardrailIdentifier: string = ""

guardrailVersion

guardrailVersion: string = ""

model

model: string = "amazon.titan-tg1-large"

region

region: string

streaming

streaming: boolean = false

usesMessagesApi

usesMessagesApi: boolean = false

Optional endpointHost

endpointHost?: string

Optional guardrailConfig

guardrailConfig?: {
    streamProcessingMode: "SYNCHRONOUS" | "ASYNCHRONOUS";
    tagSuffix: string;
}

Type declaration

  • streamProcessingMode: "SYNCHRONOUS" | "ASYNCHRONOUS"
  • tagSuffix: string

Optional maxTokens

maxTokens?: number = undefined

Optional modelKwargs

modelKwargs?: Record<string, unknown>

Optional stopSequences

stopSequences?: string[]

⚠️ Deprecated ⚠️

Use as a call option using .bind() instead.

This feature is deprecated and will be removed in the future.

It is not recommended for use.

Optional temperature

temperature?: number = undefined

Optional trace

trace?: "ENABLED" | "DISABLED"

Methods

bindTools

getLsParams

invocationParams

  • invocationParams(options?): {
        guardrailConfig: undefined | {
            streamProcessingMode: "SYNCHRONOUS" | "ASYNCHRONOUS";
            tagSuffix: string;
        };
        max_tokens: undefined | number;
        modelKwargs: undefined | Record<string, unknown>;
        stop: any;
        temperature: undefined | number;
        tools: AnthropicTool[];
    }

  • Parameters

    • Optional options: unknown

    Returns {
        guardrailConfig: undefined | {
            streamProcessingMode: "SYNCHRONOUS" | "ASYNCHRONOUS";
            tagSuffix: string;
        };
        max_tokens: undefined | number;
        modelKwargs: undefined | Record<string, unknown>;
        stop: any;
        temperature: undefined | number;
        tools: AnthropicTool[];
    }

    • guardrailConfig: undefined | {
          streamProcessingMode: "SYNCHRONOUS" | "ASYNCHRONOUS";
          tagSuffix: string;
      }
    • max_tokens: undefined | number
    • modelKwargs: undefined | Record<string, unknown>
    • stop: any
    • temperature: undefined | number
    • tools: AnthropicTool[]

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc