Skip to content

AmazonBedrockClient

6 exports Added in v1.0.0 Source

Constructors

make

Added in v1.0.0 Source

Signature

declare function make(options: {
  readonly accessKeyId: string;
  readonly apiUrl?: string;
  readonly region?: string;
  readonly secretAccessKey: Redacted<string>;
  readonly sessionToken?: Redacted<string>;
  readonly transformClient?: (client: HttpClient) => HttpClient;
}): Effect<any, unknown, unknown>;

Context

Signature

declare class AmazonBedrockClient extends any {
  constructor();
}

Layers

layer

Added in v1.0.0 Source

Signature

declare function layer(options: {
  readonly accessKeyId: string;
  readonly apiUrl?: string;
  readonly region?: string;
  readonly secretAccessKey: Redacted<string>;
  readonly sessionToken?: Redacted<string>;
  readonly transformClient?: (client: HttpClient) => HttpClient;
}): Layer<AmazonBedrockClient, never, HttpClient>;

layerConfig

Added in v1.0.0 Source

Signature

declare function layerConfig(options: {
  readonly accessKeyId: Config<string>;
  readonly apiUrl?: Config<string>;
  readonly region?: Config<string>;
  readonly secretAccessKey: Config<Redacted<string>>;
  readonly sessionToken?: Config<Redacted<string>>;
  readonly transformClient?: (client: HttpClient) => HttpClient;
}): Layer<AmazonBedrockClient, ConfigError, HttpClient>;

Models

Client interface

Added in v1.0.0 Source

Signature

interface Client {
  readonly converse: (options: {
    readonly params?: {
      "anthropic-beta"?: string;
    };
    readonly payload: {
      readonly additionalModelRequestFields?: {
        [key: string]: unknown;
        [key: number]: unknown;
        [key: symbol]: unknown;
      };
      readonly additionalModelResponseFieldPaths?: undefined;
      readonly guardrailConfig?: {
        readonly guardrailIdentifier: unknown;
        readonly guardrailVersion: unknown;
        readonly trace?: "enabled";
      };
      readonly inferenceConfig?: {
        readonly maxTokens?: undefined;
        readonly stopSequences?: undefined;
        readonly temperature?: undefined;
        readonly topP?: undefined;
      };
      readonly messages: readonly Array<ReadonlySide<{
        readonly content: $Array<Constraint>;
        readonly role: Literal<"user">;
      }, "Encoded">>;
      readonly modelId: string;
      readonly performanceConfig?: {
        readonly latency?: "standard";
      };
      readonly promptVariables?: {
        [key: string]: unknown;
        [key: number]: unknown;
        [key: symbol]: unknown;
      };
      readonly requestMetadata?: {
        [key: string]: unknown;
        [key: number]: unknown;
        [key: symbol]: unknown;
      };
      readonly system?: readonly Array<unknown>;
      readonly toolConfig?: {
        readonly toolChoice?: unknown;
        readonly tools: unknown;
      };
    };
  }) => Effect<ConverseResponse, any>;
}

Models

Service interface

Added in v1.0.0 Source

Signature

interface Service {
  readonly client: Client;
  readonly converse: (options: {
    readonly params?: {
      "anthropic-beta"?: string;
    };
    readonly payload: {
      readonly additionalModelRequestFields?: {
        [key: string]: unknown;
        [key: number]: unknown;
        [key: symbol]: unknown;
      };
      readonly additionalModelResponseFieldPaths?: undefined;
      readonly guardrailConfig?: {
        readonly guardrailIdentifier: unknown;
        readonly guardrailVersion: unknown;
        readonly trace?: "enabled";
      };
      readonly inferenceConfig?: {
        readonly maxTokens?: undefined;
        readonly stopSequences?: undefined;
        readonly temperature?: undefined;
        readonly topP?: undefined;
      };
      readonly messages: readonly Array<ReadonlySide<{
        readonly content: $Array<Constraint>;
        readonly role: Literal<"user">;
      }, "Encoded">>;
      readonly modelId: string;
      readonly performanceConfig?: {
        readonly latency?: "standard";
      };
      readonly promptVariables?: {
        [key: string]: unknown;
        [key: number]: unknown;
        [key: symbol]: unknown;
      };
      readonly requestMetadata?: {
        [key: string]: unknown;
        [key: number]: unknown;
        [key: symbol]: unknown;
      };
      readonly system?: readonly Array<unknown>;
      readonly toolConfig?: {
        readonly toolChoice?: unknown;
        readonly tools: unknown;
      };
    };
  }) => Effect<ConverseResponse, AiError>;
  readonly converseStream: (options: {
    readonly params?: {
      "anthropic-beta"?: string;
    };
    readonly payload: {
      readonly additionalModelRequestFields?: {
        [key: string]: unknown;
        [key: number]: unknown;
        [key: symbol]: unknown;
      };
      readonly additionalModelResponseFieldPaths?: undefined;
      readonly guardrailConfig?: {
        readonly guardrailIdentifier: unknown;
        readonly guardrailVersion: unknown;
        readonly trace?: "enabled";
      };
      readonly inferenceConfig?: {
        readonly maxTokens?: undefined;
        readonly stopSequences?: undefined;
        readonly temperature?: undefined;
        readonly topP?: undefined;
      };
      readonly messages: readonly Array<ReadonlySide<{
        readonly content: $Array<Constraint>;
        readonly role: Literal<"user">;
      }, "Encoded">>;
      readonly modelId: string;
      readonly performanceConfig?: {
        readonly latency?: "standard";
      };
      readonly promptVariables?: {
        [key: string]: unknown;
        [key: number]: unknown;
        [key: symbol]: unknown;
      };
      readonly requestMetadata?: {
        [key: string]: unknown;
        [key: number]: unknown;
        [key: symbol]: unknown;
      };
      readonly system?: readonly Array<unknown>;
      readonly toolConfig?: {
        readonly toolChoice?: unknown;
        readonly tools: unknown;
      };
    };
  }) => Stream<any, AiError>;
  readonly streamRequest: <A, I, R>(request: HttpClientRequest, schema: any) => Stream<A, AiError, R>;
}