@aws-sdk/client-bedrock-runtime 3.582.0 → 3.587.0

package/dist-types/ts3.4/models/models_0.d.ts

@@ -1,4 +1,5 @@
 import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
+import { DocumentType as __DocumentType } from "@smithy/types";
 import { BedrockRuntimeServiceException as __BaseException } from "./BedrockRuntimeServiceException";
 export declare class AccessDeniedException extends __BaseException {
   readonly name: "AccessDeniedException";
@@ -7,6 +8,308 @@ export declare class AccessDeniedException extends __BaseException {
     opts: __ExceptionOptionType<AccessDeniedException, __BaseException>
   );
 }
+export interface InferenceConfiguration {
+  maxTokens?: number;
+  temperature?: number;
+  topP?: number;
+  stopSequences?: string[];
+}
+export declare const ImageFormat: {
+  readonly GIF: "gif";
+  readonly JPEG: "jpeg";
+  readonly PNG: "png";
+  readonly WEBP: "webp";
+};
+export type ImageFormat = (typeof ImageFormat)[keyof typeof ImageFormat];
+export type ImageSource = ImageSource.BytesMember | ImageSource.$UnknownMember;
+export declare namespace ImageSource {
+  interface BytesMember {
+    bytes: Uint8Array;
+    $unknown?: never;
+  }
+  interface $UnknownMember {
+    bytes?: never;
+    $unknown: [string, any];
+  }
+  interface Visitor<T> {
+    bytes: (value: Uint8Array) => T;
+    _: (name: string, value: any) => T;
+  }
+  const visit: <T>(value: ImageSource, visitor: Visitor<T>) => T;
+}
+export interface ImageBlock {
+  format: ImageFormat | undefined;
+  source: ImageSource | undefined;
+}
+export type ToolResultContentBlock =
+  | ToolResultContentBlock.ImageMember
+  | ToolResultContentBlock.JsonMember
+  | ToolResultContentBlock.TextMember
+  | ToolResultContentBlock.$UnknownMember;
+export declare namespace ToolResultContentBlock {
+  interface JsonMember {
+    json: __DocumentType;
+    text?: never;
+    image?: never;
+    $unknown?: never;
+  }
+  interface TextMember {
+    json?: never;
+    text: string;
+    image?: never;
+    $unknown?: never;
+  }
+  interface ImageMember {
+    json?: never;
+    text?: never;
+    image: ImageBlock;
+    $unknown?: never;
+  }
+  interface $UnknownMember {
+    json?: never;
+    text?: never;
+    image?: never;
+    $unknown: [string, any];
+  }
+  interface Visitor<T> {
+    json: (value: __DocumentType) => T;
+    text: (value: string) => T;
+    image: (value: ImageBlock) => T;
+    _: (name: string, value: any) => T;
+  }
+  const visit: <T>(value: ToolResultContentBlock, visitor: Visitor<T>) => T;
+}
+export declare const ToolResultStatus: {
+  readonly ERROR: "error";
+  readonly SUCCESS: "success";
+};
+export type ToolResultStatus =
+  (typeof ToolResultStatus)[keyof typeof ToolResultStatus];
+export interface ToolResultBlock {
+  toolUseId: string | undefined;
+  content: ToolResultContentBlock[] | undefined;
+  status?: ToolResultStatus;
+}
+export interface ToolUseBlock {
+  toolUseId: string | undefined;
+  name: string | undefined;
+  input: __DocumentType | undefined;
+}
+export type ContentBlock =
+  | ContentBlock.ImageMember
+  | ContentBlock.TextMember
+  | ContentBlock.ToolResultMember
+  | ContentBlock.ToolUseMember
+  | ContentBlock.$UnknownMember;
+export declare namespace ContentBlock {
+  interface TextMember {
+    text: string;
+    image?: never;
+    toolUse?: never;
+    toolResult?: never;
+    $unknown?: never;
+  }
+  interface ImageMember {
+    text?: never;
+    image: ImageBlock;
+    toolUse?: never;
+    toolResult?: never;
+    $unknown?: never;
+  }
+  interface ToolUseMember {
+    text?: never;
+    image?: never;
+    toolUse: ToolUseBlock;
+    toolResult?: never;
+    $unknown?: never;
+  }
+  interface ToolResultMember {
+    text?: never;
+    image?: never;
+    toolUse?: never;
+    toolResult: ToolResultBlock;
+    $unknown?: never;
+  }
+  interface $UnknownMember {
+    text?: never;
+    image?: never;
+    toolUse?: never;
+    toolResult?: never;
+    $unknown: [string, any];
+  }
+  interface Visitor<T> {
+    text: (value: string) => T;
+    image: (value: ImageBlock) => T;
+    toolUse: (value: ToolUseBlock) => T;
+    toolResult: (value: ToolResultBlock) => T;
+    _: (name: string, value: any) => T;
+  }
+  const visit: <T>(value: ContentBlock, visitor: Visitor<T>) => T;
+}
+export declare const ConversationRole: {
+  readonly ASSISTANT: "assistant";
+  readonly USER: "user";
+};
+export type ConversationRole =
+  (typeof ConversationRole)[keyof typeof ConversationRole];
+export interface Message {
+  role: ConversationRole | undefined;
+  content: ContentBlock[] | undefined;
+}
+export type SystemContentBlock =
+  | SystemContentBlock.TextMember
+  | SystemContentBlock.$UnknownMember;
+export declare namespace SystemContentBlock {
+  interface TextMember {
+    text: string;
+    $unknown?: never;
+  }
+  interface $UnknownMember {
+    text?: never;
+    $unknown: [string, any];
+  }
+  interface Visitor<T> {
+    text: (value: string) => T;
+    _: (name: string, value: any) => T;
+  }
+  const visit: <T>(value: SystemContentBlock, visitor: Visitor<T>) => T;
+}
+export interface AnyToolChoice {}
+export interface AutoToolChoice {}
+export interface SpecificToolChoice {
+  name: string | undefined;
+}
+export type ToolChoice =
+  | ToolChoice.AnyMember
+  | ToolChoice.AutoMember
+  | ToolChoice.ToolMember
+  | ToolChoice.$UnknownMember;
+export declare namespace ToolChoice {
+  interface AutoMember {
+    auto: AutoToolChoice;
+    any?: never;
+    tool?: never;
+    $unknown?: never;
+  }
+  interface AnyMember {
+    auto?: never;
+    any: AnyToolChoice;
+    tool?: never;
+    $unknown?: never;
+  }
+  interface ToolMember {
+    auto?: never;
+    any?: never;
+    tool: SpecificToolChoice;
+    $unknown?: never;
+  }
+  interface $UnknownMember {
+    auto?: never;
+    any?: never;
+    tool?: never;
+    $unknown: [string, any];
+  }
+  interface Visitor<T> {
+    auto: (value: AutoToolChoice) => T;
+    any: (value: AnyToolChoice) => T;
+    tool: (value: SpecificToolChoice) => T;
+    _: (name: string, value: any) => T;
+  }
+  const visit: <T>(value: ToolChoice, visitor: Visitor<T>) => T;
+}
+export type ToolInputSchema =
+  | ToolInputSchema.JsonMember
+  | ToolInputSchema.$UnknownMember;
+export declare namespace ToolInputSchema {
+  interface JsonMember {
+    json: __DocumentType;
+    $unknown?: never;
+  }
+  interface $UnknownMember {
+    json?: never;
+    $unknown: [string, any];
+  }
+  interface Visitor<T> {
+    json: (value: __DocumentType) => T;
+    _: (name: string, value: any) => T;
+  }
+  const visit: <T>(value: ToolInputSchema, visitor: Visitor<T>) => T;
+}
+export interface ToolSpecification {
+  name: string | undefined;
+  description?: string;
+  inputSchema: ToolInputSchema | undefined;
+}
+export type Tool = Tool.ToolSpecMember | Tool.$UnknownMember;
+export declare namespace Tool {
+  interface ToolSpecMember {
+    toolSpec: ToolSpecification;
+    $unknown?: never;
+  }
+  interface $UnknownMember {
+    toolSpec?: never;
+    $unknown: [string, any];
+  }
+  interface Visitor<T> {
+    toolSpec: (value: ToolSpecification) => T;
+    _: (name: string, value: any) => T;
+  }
+  const visit: <T>(value: Tool, visitor: Visitor<T>) => T;
+}
+export interface ToolConfiguration {
+  tools: Tool[] | undefined;
+  toolChoice?: ToolChoice;
+}
+export interface ConverseRequest {
+  modelId: string | undefined;
+  messages: Message[] | undefined;
+  system?: SystemContentBlock[];
+  inferenceConfig?: InferenceConfiguration;
+  toolConfig?: ToolConfiguration;
+  additionalModelRequestFields?: __DocumentType;
+  additionalModelResponseFieldPaths?: string[];
+}
+export interface ConverseMetrics {
+  latencyMs: number | undefined;
+}
+export type ConverseOutput =
+  | ConverseOutput.MessageMember
+  | ConverseOutput.$UnknownMember;
+export declare namespace ConverseOutput {
+  interface MessageMember {
+    message: Message;
+    $unknown?: never;
+  }
+  interface $UnknownMember {
+    message?: never;
+    $unknown: [string, any];
+  }
+  interface Visitor<T> {
+    message: (value: Message) => T;
+    _: (name: string, value: any) => T;
+  }
+  const visit: <T>(value: ConverseOutput, visitor: Visitor<T>) => T;
+}
+export declare const StopReason: {
+  readonly CONTENT_FILTERED: "content_filtered";
+  readonly END_TURN: "end_turn";
+  readonly MAX_TOKENS: "max_tokens";
+  readonly STOP_SEQUENCE: "stop_sequence";
+  readonly TOOL_USE: "tool_use";
+};
+export type StopReason = (typeof StopReason)[keyof typeof StopReason];
+export interface TokenUsage {
+  inputTokens: number | undefined;
+  outputTokens: number | undefined;
+  totalTokens: number | undefined;
+}
+export interface ConverseResponse {
+  output: ConverseOutput | undefined;
+  stopReason: StopReason | undefined;
+  usage: TokenUsage | undefined;
+  metrics: ConverseMetrics | undefined;
+  additionalModelResponseFields?: __DocumentType;
+}
 export declare class InternalServerException extends __BaseException {
   readonly name: "InternalServerException";
   readonly $fault: "server";
@@ -14,24 +317,6 @@ export declare class InternalServerException extends __BaseException {
     opts: __ExceptionOptionType<InternalServerException, __BaseException>
   );
 }
-export declare const Trace: {
-  readonly DISABLED: "DISABLED";
-  readonly ENABLED: "ENABLED";
-};
-export type Trace = (typeof Trace)[keyof typeof Trace];
-export interface InvokeModelRequest {
-  body: Uint8Array | undefined;
-  contentType?: string;
-  accept?: string;
-  modelId: string | undefined;
-  trace?: Trace;
-  guardrailIdentifier?: string;
-  guardrailVersion?: string;
-}
-export interface InvokeModelResponse {
-  body: Uint8Array | undefined;
-  contentType: string | undefined;
-}
 export declare class ModelErrorException extends __BaseException {
   readonly name: "ModelErrorException";
   readonly $fault: "client";
@@ -62,13 +347,6 @@ export declare class ResourceNotFoundException extends __BaseException {
     opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>
   );
 }
-export declare class ServiceQuotaExceededException extends __BaseException {
-  readonly name: "ServiceQuotaExceededException";
-  readonly $fault: "client";
-  constructor(
-    opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>
-  );
-}
 export declare class ThrottlingException extends __BaseException {
   readonly name: "ThrottlingException";
   readonly $fault: "client";
@@ -83,7 +361,281 @@ export declare class ValidationException extends __BaseException {
     opts: __ExceptionOptionType<ValidationException, __BaseException>
   );
 }
-export interface InvokeModelWithResponseStreamRequest {
+export interface ConverseStreamRequest {
+  modelId: string | undefined;
+  messages: Message[] | undefined;
+  system?: SystemContentBlock[];
+  inferenceConfig?: InferenceConfiguration;
+  toolConfig?: ToolConfiguration;
+  additionalModelRequestFields?: __DocumentType;
+  additionalModelResponseFieldPaths?: string[];
+}
+export interface ToolUseBlockDelta {
+  input: string | undefined;
+}
+export type ContentBlockDelta =
+  | ContentBlockDelta.TextMember
+  | ContentBlockDelta.ToolUseMember
+  | ContentBlockDelta.$UnknownMember;
+export declare namespace ContentBlockDelta {
+  interface TextMember {
+    text: string;
+    toolUse?: never;
+    $unknown?: never;
+  }
+  interface ToolUseMember {
+    text?: never;
+    toolUse: ToolUseBlockDelta;
+    $unknown?: never;
+  }
+  interface $UnknownMember {
+    text?: never;
+    toolUse?: never;
+    $unknown: [string, any];
+  }
+  interface Visitor<T> {
+    text: (value: string) => T;
+    toolUse: (value: ToolUseBlockDelta) => T;
+    _: (name: string, value: any) => T;
+  }
+  const visit: <T>(value: ContentBlockDelta, visitor: Visitor<T>) => T;
+}
+export interface ContentBlockDeltaEvent {
+  delta: ContentBlockDelta | undefined;
+  contentBlockIndex: number | undefined;
+}
+export interface ToolUseBlockStart {
+  toolUseId: string | undefined;
+  name: string | undefined;
+}
+export type ContentBlockStart =
+  | ContentBlockStart.ToolUseMember
+  | ContentBlockStart.$UnknownMember;
+export declare namespace ContentBlockStart {
+  interface ToolUseMember {
+    toolUse: ToolUseBlockStart;
+    $unknown?: never;
+  }
+  interface $UnknownMember {
+    toolUse?: never;
+    $unknown: [string, any];
+  }
+  interface Visitor<T> {
+    toolUse: (value: ToolUseBlockStart) => T;
+    _: (name: string, value: any) => T;
+  }
+  const visit: <T>(value: ContentBlockStart, visitor: Visitor<T>) => T;
+}
+export interface ContentBlockStartEvent {
+  start: ContentBlockStart | undefined;
+  contentBlockIndex: number | undefined;
+}
+export interface ContentBlockStopEvent {
+  contentBlockIndex: number | undefined;
+}
+export interface MessageStartEvent {
+  role: ConversationRole | undefined;
+}
+export interface MessageStopEvent {
+  stopReason: StopReason | undefined;
+  additionalModelResponseFields?: __DocumentType;
+}
+export interface ConverseStreamMetrics {
+  latencyMs: number | undefined;
+}
+export interface ConverseStreamMetadataEvent {
+  usage: TokenUsage | undefined;
+  metrics: ConverseStreamMetrics | undefined;
+}
+export declare class ModelStreamErrorException extends __BaseException {
+  readonly name: "ModelStreamErrorException";
+  readonly $fault: "client";
+  originalStatusCode?: number;
+  originalMessage?: string;
+  constructor(
+    opts: __ExceptionOptionType<ModelStreamErrorException, __BaseException>
+  );
+}
+export type ConverseStreamOutput =
+  | ConverseStreamOutput.ContentBlockDeltaMember
+  | ConverseStreamOutput.ContentBlockStartMember
+  | ConverseStreamOutput.ContentBlockStopMember
+  | ConverseStreamOutput.InternalServerExceptionMember
+  | ConverseStreamOutput.MessageStartMember
+  | ConverseStreamOutput.MessageStopMember
+  | ConverseStreamOutput.MetadataMember
+  | ConverseStreamOutput.ModelStreamErrorExceptionMember
+  | ConverseStreamOutput.ThrottlingExceptionMember
+  | ConverseStreamOutput.ValidationExceptionMember
+  | ConverseStreamOutput.$UnknownMember;
+export declare namespace ConverseStreamOutput {
+  interface MessageStartMember {
+    messageStart: MessageStartEvent;
+    contentBlockStart?: never;
+    contentBlockDelta?: never;
+    contentBlockStop?: never;
+    messageStop?: never;
+    metadata?: never;
+    internalServerException?: never;
+    modelStreamErrorException?: never;
+    validationException?: never;
+    throttlingException?: never;
+    $unknown?: never;
+  }
+  interface ContentBlockStartMember {
+    messageStart?: never;
+    contentBlockStart: ContentBlockStartEvent;
+    contentBlockDelta?: never;
+    contentBlockStop?: never;
+    messageStop?: never;
+    metadata?: never;
+    internalServerException?: never;
+    modelStreamErrorException?: never;
+    validationException?: never;
+    throttlingException?: never;
+    $unknown?: never;
+  }
+  interface ContentBlockDeltaMember {
+    messageStart?: never;
+    contentBlockStart?: never;
+    contentBlockDelta: ContentBlockDeltaEvent;
+    contentBlockStop?: never;
+    messageStop?: never;
+    metadata?: never;
+    internalServerException?: never;
+    modelStreamErrorException?: never;
+    validationException?: never;
+    throttlingException?: never;
+    $unknown?: never;
+  }
+  interface ContentBlockStopMember {
+    messageStart?: never;
+    contentBlockStart?: never;
+    contentBlockDelta?: never;
+    contentBlockStop: ContentBlockStopEvent;
+    messageStop?: never;
+    metadata?: never;
+    internalServerException?: never;
+    modelStreamErrorException?: never;
+    validationException?: never;
+    throttlingException?: never;
+    $unknown?: never;
+  }
+  interface MessageStopMember {
+    messageStart?: never;
+    contentBlockStart?: never;
+    contentBlockDelta?: never;
+    contentBlockStop?: never;
+    messageStop: MessageStopEvent;
+    metadata?: never;
+    internalServerException?: never;
+    modelStreamErrorException?: never;
+    validationException?: never;
+    throttlingException?: never;
+    $unknown?: never;
+  }
+  interface MetadataMember {
+    messageStart?: never;
+    contentBlockStart?: never;
+    contentBlockDelta?: never;
+    contentBlockStop?: never;
+    messageStop?: never;
+    metadata: ConverseStreamMetadataEvent;
+    internalServerException?: never;
+    modelStreamErrorException?: never;
+    validationException?: never;
+    throttlingException?: never;
+    $unknown?: never;
+  }
+  interface InternalServerExceptionMember {
+    messageStart?: never;
+    contentBlockStart?: never;
+    contentBlockDelta?: never;
+    contentBlockStop?: never;
+    messageStop?: never;
+    metadata?: never;
+    internalServerException: InternalServerException;
+    modelStreamErrorException?: never;
+    validationException?: never;
+    throttlingException?: never;
+    $unknown?: never;
+  }
+  interface ModelStreamErrorExceptionMember {
+    messageStart?: never;
+    contentBlockStart?: never;
+    contentBlockDelta?: never;
+    contentBlockStop?: never;
+    messageStop?: never;
+    metadata?: never;
+    internalServerException?: never;
+    modelStreamErrorException: ModelStreamErrorException;
+    validationException?: never;
+    throttlingException?: never;
+    $unknown?: never;
+  }
+  interface ValidationExceptionMember {
+    messageStart?: never;
+    contentBlockStart?: never;
+    contentBlockDelta?: never;
+    contentBlockStop?: never;
+    messageStop?: never;
+    metadata?: never;
+    internalServerException?: never;
+    modelStreamErrorException?: never;
+    validationException: ValidationException;
+    throttlingException?: never;
+    $unknown?: never;
+  }
+  interface ThrottlingExceptionMember {
+    messageStart?: never;
+    contentBlockStart?: never;
+    contentBlockDelta?: never;
+    contentBlockStop?: never;
+    messageStop?: never;
+    metadata?: never;
+    internalServerException?: never;
+    modelStreamErrorException?: never;
+    validationException?: never;
+    throttlingException: ThrottlingException;
+    $unknown?: never;
+  }
+  interface $UnknownMember {
+    messageStart?: never;
+    contentBlockStart?: never;
+    contentBlockDelta?: never;
+    contentBlockStop?: never;
+    messageStop?: never;
+    metadata?: never;
+    internalServerException?: never;
+    modelStreamErrorException?: never;
+    validationException?: never;
+    throttlingException?: never;
+    $unknown: [string, any];
+  }
+  interface Visitor<T> {
+    messageStart: (value: MessageStartEvent) => T;
+    contentBlockStart: (value: ContentBlockStartEvent) => T;
+    contentBlockDelta: (value: ContentBlockDeltaEvent) => T;
+    contentBlockStop: (value: ContentBlockStopEvent) => T;
+    messageStop: (value: MessageStopEvent) => T;
+    metadata: (value: ConverseStreamMetadataEvent) => T;
+    internalServerException: (value: InternalServerException) => T;
+    modelStreamErrorException: (value: ModelStreamErrorException) => T;
+    validationException: (value: ValidationException) => T;
+    throttlingException: (value: ThrottlingException) => T;
+    _: (name: string, value: any) => T;
+  }
+  const visit: <T>(value: ConverseStreamOutput, visitor: Visitor<T>) => T;
+}
+export interface ConverseStreamResponse {
+  stream?: AsyncIterable<ConverseStreamOutput>;
+}
+export declare const Trace: {
+  readonly DISABLED: "DISABLED";
+  readonly ENABLED: "ENABLED";
+};
+export type Trace = (typeof Trace)[keyof typeof Trace];
+export interface InvokeModelRequest {
   body: Uint8Array | undefined;
   contentType?: string;
   accept?: string;
@@ -92,18 +644,29 @@ export interface InvokeModelWithResponseStreamRequest {
   guardrailIdentifier?: string;
   guardrailVersion?: string;
 }
-export interface PayloadPart {
-  bytes?: Uint8Array;
+export interface InvokeModelResponse {
+  body: Uint8Array | undefined;
+  contentType: string | undefined;
 }
-export declare class ModelStreamErrorException extends __BaseException {
-  readonly name: "ModelStreamErrorException";
+export declare class ServiceQuotaExceededException extends __BaseException {
+  readonly name: "ServiceQuotaExceededException";
   readonly $fault: "client";
-  originalStatusCode?: number;
-  originalMessage?: string;
   constructor(
-    opts: __ExceptionOptionType<ModelStreamErrorException, __BaseException>
+    opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>
   );
 }
+export interface InvokeModelWithResponseStreamRequest {
+  body: Uint8Array | undefined;
+  contentType?: string;
+  accept?: string;
+  modelId: string | undefined;
+  trace?: Trace;
+  guardrailIdentifier?: string;
+  guardrailVersion?: string;
+}
+export interface PayloadPart {
+  bytes?: Uint8Array;
+}
 export type ResponseStream =
   | ResponseStream.ChunkMember
   | ResponseStream.InternalServerExceptionMember
@@ -191,6 +754,12 @@ export interface InvokeModelWithResponseStreamResponse {
   body: AsyncIterable<ResponseStream> | undefined;
   contentType: string | undefined;
 }
+export declare const ConverseStreamOutputFilterSensitiveLog: (
+  obj: ConverseStreamOutput
+) => any;
+export declare const ConverseStreamResponseFilterSensitiveLog: (
+  obj: ConverseStreamResponse
+) => any;
 export declare const InvokeModelRequestFilterSensitiveLog: (
   obj: InvokeModelRequest
 ) => any;