Skip to main content Link Search Menu Expand Document (external link)

AmazonBedrockClient.ts overview

Since v1.0.0


Exports Grouped by Category


Constructors

make

Signature

declare const make: (options: {
  readonly apiUrl?: string | undefined
  readonly accessKeyId: string
  readonly secretAccessKey: Redacted.Redacted<string>
  readonly sessionToken?: Redacted.Redacted<string> | undefined
  readonly region?: string | undefined
  readonly transformClient?: (client: HttpClient.HttpClient) => HttpClient.HttpClient
}) => Effect.Effect<Service, never, HttpClient.HttpClient | Scope>

Source

Since v1.0.0

Context

AmazonBedrockClient (class)

Signature

declare class AmazonBedrockClient

Source

Since v1.0.0

Models

Service (interface)

Signature

export interface Service {
  readonly client: Client

  readonly streamRequest: <A, I, R>(
    request: HttpClientRequest.HttpClientRequest,
    schema: Schema.Schema<A, I, R>
  ) => Stream.Stream<A, AiError.AiError, R>

  readonly converse: (options: {
    readonly params?: { "anthropic-beta"?: string | undefined } | undefined
    readonly payload: typeof ConverseRequest.Encoded
  }) => Effect.Effect<ConverseResponse, AiError.AiError>

  readonly converseStream: (options: {
    readonly params?: { "anthropic-beta"?: string | undefined } | undefined
    readonly payload: typeof ConverseRequest.Encoded
  }) => Stream.Stream<ConverseResponseStreamEvent, AiError.AiError>
}

Source

Since v1.0.0

layers

layer

Signature

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

Source

Since v1.0.0

layerConfig

Signature

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

Source

Since v1.0.0

models

Client (interface)

Signature

export interface Client {
  readonly converse: (options: {
    readonly params?: { "anthropic-beta"?: string | undefined }
    readonly payload: typeof ConverseRequest.Encoded
  }) => Effect.Effect<typeof ConverseResponse.Type, HttpClientError.HttpClientError | ParseError>
}

Source

Since v1.0.0