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<AmazonBedrockClient.Service, never, HttpClient.HttpClient | Scope>

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: Config.Config.Wrap<{
    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, ConfigError, HttpClient.HttpClient>

Source

Since v1.0.0

models

StreamChunk (class)

Signature

declare class StreamChunk

Source

Since v1.0.0

StreamChunkPart (type alias)

Signature

type StreamChunkPart = any

Source

Since v1.0.0

tags

AmazonBedrockClient (class)

Signature

declare class AmazonBedrockClient

Source

Since v1.0.0

utils

AmazonBedrockClient (namespace)

Source

Since v1.0.0

Service (interface)

Signature

export interface Service {
  readonly client: Client
  readonly streamRequest: (
    request: typeof ConverseRequest.Encoded
  ) => Stream.Stream<ConverseStreamResponse, HttpClientError.HttpClientError | ParseError>
  readonly stream: (
    request: typeof ConverseRequest.Encoded
  ) => Stream.Stream<AiResponse.AiResponse, HttpClientError.HttpClientError | ParseError>
}

Source

Since v1.0.0

Client (interface)

Signature

export interface Client {
  readonly converse: (
    options: typeof ConverseRequest.Encoded
  ) => Effect.Effect<typeof ConverseResponse.Type, HttpClientError.HttpClientError | ParseError>
  readonly converseStream: (
    options: typeof ConverseRequest.Encoded
  ) => Effect.Effect<HttpClientResponse.HttpClientResponse, HttpClientError.HttpClientError | ParseError>
}

Source

Since v1.0.0