@wmaurer/effect-ai-amazon-bedrock 0.2.0 → 0.4.0

package/dist/AmazonBedrockSchema.d.ts

@@ -22,14 +22,35 @@ import * as Schema from "effect/Schema";
  * @since 0.1.0
  */
 export declare const IntZeroOrGreater: Schema.Int;
+/**
+ * The stop reasons that the Smithy model of the Converse API names.
+ *
+ * @stability unstable
+ * @category schemas
+ * @since 0.3.0
+ */
+export declare const KnownStopReason: Schema.Literals<readonly ["end_turn", "tool_use", "max_tokens", "stop_sequence", "guardrail_intervened", "content_filtered", "malformed_model_output", "malformed_tool_use", "model_context_window_exceeded"]>;
+/**
+ * The type of {@link KnownStopReason}.
+ *
+ * @stability unstable
+ * @category schemas
+ * @since 0.3.0
+ */
+export type KnownStopReason = typeof KnownStopReason.Type;
 /**
  * The reason the model stopped generating a response.
  *
+ * **Details**
+ *
+ * Any string decodes, so a reason that Bedrock adds later, or that a model
+ * returns outside the Smithy model, does not fail the response.
+ *
  * @stability unstable
  * @category schemas
  * @since 0.1.0
  */
-export declare const StopReason: Schema.Literals<readonly ["end_turn", "tool_use", "max_tokens", "stop_sequence", "guardrail_intervened", "content_filtered", "malformed_model_output", "malformed_tool_use", "model_context_window_exceeded"]>;
+export declare const StopReason: Schema.Union<readonly [Schema.Literals<readonly ["end_turn", "tool_use", "max_tokens", "stop_sequence", "guardrail_intervened", "content_filtered", "malformed_model_output", "malformed_tool_use", "model_context_window_exceeded"]>, Schema.StringForLiteralAutocomplete]>;
 /**
  * The type of {@link StopReason}.
  *
@@ -355,6 +376,77 @@ declare const CitationsContentBlock_base: Schema.Class<CitationsContentBlock, Sc
  */
 export declare class CitationsContentBlock extends CitationsContentBlock_base {
 }
+/**
+ * The role a guarded text block plays in a contextual grounding check.
+ *
+ * **Details**
+ *
+ * `grounding_source` marks the documents an answer must be grounded in,
+ * `query` marks the question, and `guard_content` marks text the guardrail
+ * evaluates without a grounding role.
+ *
+ * @stability unstable
+ * @category schemas
+ * @since 0.4.0
+ */
+export declare const GuardrailConverseContentQualifier: Schema.Literals<readonly ["grounding_source", "query", "guard_content"]>;
+declare const GuardrailConverseTextBlock_base: Schema.Class<GuardrailConverseTextBlock, Schema.Struct<{
+    readonly text: Schema.String;
+    readonly qualifiers: Schema.optionalKey<Schema.$Array<Schema.Literals<readonly ["grounding_source", "query", "guard_content"]>>>;
+}>, {}>;
+/**
+ * Text that the guardrail evaluates.
+ *
+ * **Details**
+ *
+ * `qualifiers` uses `optionalKey` for the same reason as
+ * `CachePointBlock.ttl`: the block is built from `Prompt` provider options,
+ * whose values must satisfy `Schema.Json`.
+ *
+ * @stability unstable
+ * @category schemas
+ * @since 0.4.0
+ */
+export declare class GuardrailConverseTextBlock extends GuardrailConverseTextBlock_base {
+}
+declare const GuardrailConverseImageBlock_base: Schema.Class<GuardrailConverseImageBlock, Schema.Struct<{
+    readonly format: Schema.Literals<readonly ["png", "jpeg"]>;
+    readonly source: Schema.Struct<{
+        readonly bytes: Schema.String;
+    }>;
+}>, {}>;
+/**
+ * An image that the guardrail evaluates.
+ *
+ * **Details**
+ *
+ * The Smithy model allows only png and jpeg, and only `bytes` as the source.
+ * `bytes` is a Smithy blob, which the JSON protocol carries as a base64
+ * string.
+ *
+ * @stability unstable
+ * @category schemas
+ * @since 0.4.0
+ */
+export declare class GuardrailConverseImageBlock extends GuardrailConverseImageBlock_base {
+}
+/**
+ * Content that the guardrail evaluates, in a message or in the system prompt.
+ *
+ * **Details**
+ *
+ * AWS models `GuardrailConverseContentBlock` as a UNION, so both members are
+ * optional here. Once a request holds one `guardContent` block, the guardrail
+ * evaluates only the guarded blocks. The model still reads every block.
+ *
+ * @stability unstable
+ * @category schemas
+ * @since 0.4.0
+ */
+export declare const GuardrailConverseContentBlock: Schema.Struct<{
+    readonly text: Schema.optional<typeof GuardrailConverseTextBlock>;
+    readonly image: Schema.optional<typeof GuardrailConverseImageBlock>;
+}>;
 /**
  * A text content block within a Converse message.
  *
@@ -383,6 +475,10 @@ export declare const ContentBlock: Schema.Struct<{
     readonly document: Schema.optional<typeof DocumentBlock>;
     readonly cachePoint: Schema.optional<typeof CachePointBlock>;
     readonly citationsContent: Schema.optional<typeof CitationsContentBlock>;
+    readonly guardContent: Schema.optional<Schema.Struct<{
+        readonly text: Schema.optional<typeof GuardrailConverseTextBlock>;
+        readonly image: Schema.optional<typeof GuardrailConverseImageBlock>;
+    }>>;
 }>;
 declare const Message_base: Schema.Class<Message, Schema.Struct<{
     readonly role: Schema.Literals<readonly ["user", "assistant"]>;
@@ -399,6 +495,10 @@ declare const Message_base: Schema.Class<Message, Schema.Struct<{
         readonly document: Schema.optional<typeof DocumentBlock>;
         readonly cachePoint: Schema.optional<typeof CachePointBlock>;
         readonly citationsContent: Schema.optional<typeof CitationsContentBlock>;
+        readonly guardContent: Schema.optional<Schema.Struct<{
+            readonly text: Schema.optional<typeof GuardrailConverseTextBlock>;
+            readonly image: Schema.optional<typeof GuardrailConverseImageBlock>;
+        }>>;
     }>>;
 }>, {}>;
 /**
@@ -415,8 +515,9 @@ export declare class Message extends Message_base {
  *
  * **Details**
  *
- * AWS models `SystemContentBlock` as a UNION, so both members are optional; a
- * block carries either the system text or a cache point.
+ * AWS models `SystemContentBlock` as a UNION, so every member is optional; a
+ * block carries the system text, guarded system text, or a cache point. The
+ * guardrail evaluates the system prompt only where it is guarded.
  *
  * @stability unstable
  * @category schemas
@@ -425,6 +526,10 @@ export declare class Message extends Message_base {
 export declare const SystemContentBlock: Schema.Struct<{
     readonly text: Schema.optional<Schema.String>;
     readonly cachePoint: Schema.optional<typeof CachePointBlock>;
+    readonly guardContent: Schema.optional<Schema.Struct<{
+        readonly text: Schema.optional<typeof GuardrailConverseTextBlock>;
+        readonly image: Schema.optional<typeof GuardrailConverseImageBlock>;
+    }>>;
 }>;
 declare const InferenceConfiguration_base: Schema.Class<InferenceConfiguration, Schema.Struct<{
     readonly maxTokens: Schema.optional<Schema.Int>;
@@ -597,12 +702,81 @@ export declare const OutputConfig: Schema.Struct<{
     }>>;
     readonly effort: Schema.optionalKey<Schema.String>;
 }>;
+/**
+ * Whether Bedrock returns the guardrail trace.
+ *
+ * **Details**
+ *
+ * Bedrock's default is `disabled`. The trace holds the text that a policy
+ * matched, unmasked. `enabled_full` is in the Smithy model, and AWS does not
+ * document it.
+ *
+ * @stability unstable
+ * @category schemas
+ * @since 0.4.0
+ */
+export declare const GuardrailTrace: Schema.Literals<readonly ["enabled", "disabled", "enabled_full"]>;
+/**
+ * How ConverseStream applies a guardrail to the streamed output.
+ *
+ * **Details**
+ *
+ * `sync`, Bedrock's default, holds back each chunk until the guardrail has
+ * evaluated it. `async` sends chunks at once, so text that the guardrail
+ * later blocks can reach the caller, and masking does not apply.
+ *
+ * @stability unstable
+ * @category schemas
+ * @since 0.4.0
+ */
+export declare const GuardrailStreamProcessingMode: Schema.Literals<readonly ["sync", "async"]>;
+declare const GuardrailConfiguration_base: Schema.Class<GuardrailConfiguration, Schema.Struct<{
+    readonly guardrailIdentifier: Schema.String;
+    readonly guardrailVersion: Schema.String;
+    readonly trace: Schema.optionalKey<Schema.Literals<readonly ["enabled", "disabled", "enabled_full"]>>;
+    readonly streamProcessingMode: Schema.optionalKey<Schema.Never>;
+}>, {}>;
+/**
+ * The guardrail of a Converse request.
+ *
+ * **Details**
+ *
+ * `guardrailIdentifier` is the guardrail's ID or ARN, and `guardrailVersion`
+ * is a version number or `DRAFT`. Converse has no `streamProcessingMode`, so
+ * the member is typed `never`: a ConverseStream request does not fit Converse
+ * until the mode is removed.
+ *
+ * @stability unstable
+ * @category schemas
+ * @since 0.4.0
+ */
+export declare class GuardrailConfiguration extends GuardrailConfiguration_base {
+}
+declare const GuardrailStreamConfiguration_base: Schema.Class<GuardrailStreamConfiguration, Schema.Struct<{
+    readonly guardrailIdentifier: Schema.String;
+    readonly guardrailVersion: Schema.String;
+    readonly trace: Schema.optionalKey<Schema.Literals<readonly ["enabled", "disabled", "enabled_full"]>>;
+    readonly streamProcessingMode: Schema.optionalKey<Schema.Literals<readonly ["sync", "async"]>>;
+}>, {}>;
+/**
+ * The guardrail of a ConverseStream request.
+ *
+ * @stability unstable
+ * @category schemas
+ * @since 0.4.0
+ */
+export declare class GuardrailStreamConfiguration extends GuardrailStreamConfiguration_base {
+}
 declare const ConverseRequest_base: Schema.Class<ConverseRequest, Schema.Struct<{
     readonly modelId: Schema.String;
     readonly messages: Schema.$Array<typeof Message>;
     readonly system: Schema.optional<Schema.$Array<Schema.Struct<{
         readonly text: Schema.optional<Schema.String>;
         readonly cachePoint: Schema.optional<typeof CachePointBlock>;
+        readonly guardContent: Schema.optional<Schema.Struct<{
+            readonly text: Schema.optional<typeof GuardrailConverseTextBlock>;
+            readonly image: Schema.optional<typeof GuardrailConverseImageBlock>;
+        }>>;
     }>>>;
     readonly toolConfig: Schema.optionalKey<typeof ToolConfiguration>;
     readonly inferenceConfig: Schema.optional<typeof InferenceConfiguration>;
@@ -620,9 +794,10 @@ declare const ConverseRequest_base: Schema.Class<ConverseRequest, Schema.Struct<
         readonly effort: Schema.optionalKey<Schema.String>;
     }>>;
     readonly additionalModelRequestFields: Schema.optional<Schema.$Record<Schema.String, Schema.Unknown>>;
+    readonly guardrailConfig: Schema.optional<typeof GuardrailConfiguration>;
 }>, {}>;
 /**
- * The request payload for the Converse and ConverseStream operations.
+ * The request payload for the Converse operation.
  *
  * **Details**
  *
@@ -641,6 +816,50 @@ declare const ConverseRequest_base: Schema.Class<ConverseRequest, Schema.Struct<
  */
 export declare class ConverseRequest extends ConverseRequest_base {
 }
+declare const ConverseStreamRequest_base: Schema.Class<ConverseStreamRequest, Schema.Struct<{
+    readonly modelId: Schema.String;
+    readonly messages: Schema.$Array<typeof Message>;
+    readonly system: Schema.optional<Schema.$Array<Schema.Struct<{
+        readonly text: Schema.optional<Schema.String>;
+        readonly cachePoint: Schema.optional<typeof CachePointBlock>;
+        readonly guardContent: Schema.optional<Schema.Struct<{
+            readonly text: Schema.optional<typeof GuardrailConverseTextBlock>;
+            readonly image: Schema.optional<typeof GuardrailConverseImageBlock>;
+        }>>;
+    }>>>;
+    readonly toolConfig: Schema.optionalKey<typeof ToolConfiguration>;
+    readonly inferenceConfig: Schema.optional<typeof InferenceConfiguration>;
+    readonly outputConfig: Schema.optionalKey<Schema.Struct<{
+        readonly textFormat: Schema.optionalKey<Schema.Struct<{
+            readonly type: Schema.Literal<"json_schema">;
+            readonly structure: Schema.Struct<{
+                readonly jsonSchema: Schema.Struct<{
+                    readonly schema: Schema.String;
+                    readonly name: Schema.optionalKey<Schema.String>;
+                    readonly description: Schema.optionalKey<Schema.String>;
+                }>;
+            }>;
+        }>>;
+        readonly effort: Schema.optionalKey<Schema.String>;
+    }>>;
+    readonly additionalModelRequestFields: Schema.optional<Schema.$Record<Schema.String, Schema.Unknown>>;
+    readonly guardrailConfig: Schema.optional<typeof GuardrailStreamConfiguration>;
+}>, {}>;
+/**
+ * The request payload for the ConverseStream operation.
+ *
+ * **Details**
+ *
+ * The members of `ConverseRequest`, with the guardrail of a stream, which
+ * adds `streamProcessingMode`. That member is the only difference between the
+ * two operations.
+ *
+ * @stability unstable
+ * @category schemas
+ * @since 0.4.0
+ */
+export declare class ConverseStreamRequest extends ConverseStreamRequest_base {
+}
 declare const ConverseOutput_base: Schema.Class<ConverseOutput, Schema.Struct<{
     readonly message: typeof Message;
 }>, {}>;
@@ -668,12 +887,19 @@ export declare class ConverseMetrics extends ConverseMetrics_base {
 declare const ConverseResponse_base: Schema.Class<ConverseResponse, Schema.Struct<{
     readonly output: typeof ConverseOutput;
     readonly usage: typeof TokenUsage;
-    readonly stopReason: Schema.Literals<readonly ["end_turn", "tool_use", "max_tokens", "stop_sequence", "guardrail_intervened", "content_filtered", "malformed_model_output", "malformed_tool_use", "model_context_window_exceeded"]>;
+    readonly stopReason: Schema.Union<readonly [Schema.Literals<readonly ["end_turn", "tool_use", "max_tokens", "stop_sequence", "guardrail_intervened", "content_filtered", "malformed_model_output", "malformed_tool_use", "model_context_window_exceeded"]>, Schema.StringForLiteralAutocomplete]>;
     readonly metrics: Schema.optional<typeof ConverseMetrics>;
+    readonly trace: Schema.optional<Schema.Codec<Schema.MutableJson, Schema.MutableJson, never, never>>;
 }>, {}>;
 /**
  * The response from a successful Converse call.
  *
+ * **Details**
+ *
+ * `trace` is kept as the JSON Bedrock sent. Its Smithy tree has about 90
+ * shapes that AWS still extends, and a struct would drop every member added
+ * later.
+ *
  * @stability unstable
  * @category schemas
  * @since 0.1.0
@@ -864,7 +1090,7 @@ declare const ContentBlockStartEvent_base: Schema.Class<ContentBlockStartEvent,
 export declare class ContentBlockStartEvent extends ContentBlockStartEvent_base {
 }
 declare const MessageStopEvent_base: Schema.Class<MessageStopEvent, Schema.Struct<{
-    readonly stopReason: Schema.Literals<readonly ["end_turn", "tool_use", "max_tokens", "stop_sequence", "guardrail_intervened", "content_filtered", "malformed_model_output", "malformed_tool_use", "model_context_window_exceeded"]>;
+    readonly stopReason: Schema.Union<readonly [Schema.Literals<readonly ["end_turn", "tool_use", "max_tokens", "stop_sequence", "guardrail_intervened", "content_filtered", "malformed_model_output", "malformed_tool_use", "model_context_window_exceeded"]>, Schema.StringForLiteralAutocomplete]>;
 }>, {}>;
 /**
  * The stop event for a streamed message.
@@ -878,9 +1104,16 @@ export declare class MessageStopEvent extends MessageStopEvent_base {
 declare const ConverseStreamMetadataEvent_base: Schema.Class<ConverseStreamMetadataEvent, Schema.Struct<{
     readonly usage: typeof TokenUsage;
     readonly metrics: Schema.optional<typeof ConverseMetrics>;
+    readonly trace: Schema.optional<Schema.Codec<Schema.MutableJson, Schema.MutableJson, never, never>>;
 }>, {}>;
 /**
- * The trailing metadata event for a Converse stream, carrying usage and metrics.
+ * The trailing metadata event for a Converse stream, carrying usage, metrics,
+ * and the trace.
+ *
+ * **Details**
+ *
+ * This is the only stream event that carries the trace. It is kept as JSON,
+ * as in `ConverseResponse`.
  *
  * @stability unstable
  * @category schemas

package/dist/AmazonBedrockSchema.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"AmazonBedrockSchema.d.ts","sourceRoot":"","sources":["../src/AmazonBedrockSchema.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AACH,OAAO,KAAK,MAAM,MAAM,eAAe,CAAA;AAMvC;;;;;;GAMG;AACH,eAAO,MAAM,gBAAgB,YAAqD,CAAA;AAElF;;;;;;GAMG;AACH,eAAO,MAAM,UAAU,gNAUrB,CAAA;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,UAAU,GAAG,OAAO,UAAU,CAAC,IAAI,CAAA;;;;;;;;AAE/C;;;;;;GAMG;AACH,qBAAa,UAAW,SAAQ,eAM9B;CAAG;;;;;;AAML;;;;;;GAMG;AACH,qBAAa,YAAa,SAAQ,iBAIhC;CAAG;;;;;;;AAEL;;;;;;;GAOG;AACH,qBAAa,eAAgB,SAAQ,oBAGnC;CAAG;;;;;AAEL;;;;;;;;;;;;GAYG;AACH,qBAAa,kBAAmB,SAAQ,uBAGtC;CAAG;AAEL;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,qBAAqB;;;EAGhC,CAAA;;;;;AAEF;;;;;;;;;;;;;;;;;;GAkBG;AACH,qBAAa,eAAgB,SAAQ,oBAGnC;CAAG;;;;;AAEL;;;;;;GAMG;AACH,qBAAa,UAAW,SAAQ,eAG9B;CAAG;AAEL;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,WAAW;;;EAGtB,CAAA;AAEF;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,cAAc;;;;EAGzB,CAAA;;;;;;;;AAEF;;;;;;GAMG;AACH,qBAAa,UAAW,SAAQ,eAG9B;CAAG;;;;AAEL;;;;;;;;;;;GAWG;AACH,qBAAa,eAAgB,SAAQ,oBAEnC;CAAG;;;;;;;;;;;;AAEL;;;;;;;;;;;;;;;;GAgBG;AACH,qBAAa,aAAc,SAAQ,kBAMjC;CAAG;;;;;;AAEL;;;;;;;;;;;;;GAaG;AACH,qBAAa,gBAAiB,SAAQ,qBAIpC;CAAG;AAEL;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,gBAAgB;;;;EAI3B,CAAA;AAEF;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,mBAAmB;;EAE9B,CAAA;;;;;;;;;;;;;AAEF;;;;;;GAMG;AACH,qBAAa,QAAS,SAAQ,aAK5B;CAAG;;;;;;;AAEL;;;;;;;;;;;GAWG;AACH,qBAAa,qBAAsB,SAAQ,0BAKzC;CAAG;AAEL;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,YAAY;;;;;;;;;;;;;EAUvB,CAAA;;;;;;;;;;;;;;;;;;AAEF;;;;;;GAMG;AACH,qBAAa,OAAQ,SAAQ,YAG3B;CAAG;AAEL;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,kBAAkB;;;EAG7B,CAAA;;;;;;;AAEF;;;;;;GAMG;AACH,qBAAa,sBAAuB,SAAQ,2BAO1C;CAAG;;;;;;;;AAEL;;;;;;GAMG;AACH,qBAAa,iBAAkB,SAAQ,sBAMrC;CAAG;;;;;AAEL;;;;;;;;;;;;;;;;GAgBG;AACH,qBAAa,IAAK,SAAQ,SAGxB;CAAG;AAEL;;;;;;;GAOG;AACH,eAAO,MAAM,UAAU;;;;;;;;IAIrB,CAAA;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,UAAU,GAAG,OAAO,UAAU,CAAC,IAAI,CAAA;;;;;;;;;;;;;AAE/C;;;;;;GAMG;AACH,qBAAa,iBAAkB,SAAQ,sBAGrC;CAAG;AAEL;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,oBAAoB;;;;EAI/B,CAAA;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,qBAAqB;;;;;;EAEhC,CAAA;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,YAAY;;;;;;;;;EAGvB,CAAA;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,YAAY;;;;;;;;;;;;EAGvB,CAAA;;;;;;;;;;;;;;;;;;;;;;;;;AAEF;;;;;;;;;;;;;;;;;GAiBG;AACH,qBAAa,eAAgB,SAAQ,oBAQnC;CAAG;;;;AAML;;;;;;GAMG;AACH,qBAAa,cAAe,SAAQ,mBAElC;CAAG;;;;AAEL;;;;;;GAMG;AACH,qBAAa,eAAgB,SAAQ,oBAEnC;CAAG;;;;;;;AAEL;;;;;;GAMG;AACH,qBAAa,gBAAiB,SAAQ,qBAKpC;CAAG;;;;AAML;;;;;;GAMG;AACH,qBAAa,iBAAkB,SAAQ,sBAIrC;CAAG;AAEL;;;;;;;;GAQG;AACH,eAAO,MAAM,iBAAiB;;EAE5B,CAAA;AAEF;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,0BAA0B;;;;EAIrC,CAAA;;;;;;;;;;;;;AAEF;;;;;;;;;;;GAWG;AACH,qBAAa,cAAe,SAAQ,mBAKlC;CAAG;AAEL;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,iBAAiB;;;;;;;;;;;EAK5B,CAAA;;;;;;;;;;;;;;;;AAEF;;;;;;GAMG;AACH,qBAAa,sBAAuB,SAAQ,2BAK1C;CAAG;;;;AAEL;;;;;;GAMG;AACH,qBAAa,qBAAsB,SAAQ,0BAIzC;CAAG;AAEL;;;;;;;GAOG;AACH,eAAO,MAAM,iBAAiB;;;EAG5B,CAAA;AAEF;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,iBAAiB;;;;;EAE5B,CAAA;;;;;;;;;;AAEF;;;;;;;;;GASG;AACH,qBAAa,sBAAuB,SAAQ,2BAK1C;CAAG;;;;AAEL;;;;;;GAMG;AACH,qBAAa,gBAAiB,SAAQ,qBAIpC;CAAG;;;;;AAEL;;;;;;GAMG;AACH,qBAAa,2BAA4B,SAAQ,gCAK/C;CAAG;AAML;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,2BAA2B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IA6CtC,CAAA;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,2BAA2B,GAAG,OAAO,2BAA2B,CAAC,IAAI,CAAA"}
+{"version":3,"file":"AmazonBedrockSchema.d.ts","sourceRoot":"","sources":["../src/AmazonBedrockSchema.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AACH,OAAO,KAAK,MAAM,MAAM,eAAe,CAAA;AAMvC;;;;;;GAMG;AACH,eAAO,MAAM,gBAAgB,YAAqD,CAAA;AAElF;;;;;;GAMG;AACH,eAAO,MAAM,eAAe,gNAU1B,CAAA;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,eAAe,GAAG,OAAO,eAAe,CAAC,IAAI,CAAA;AAEzD;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,UAAU,8QAAuE,CAAA;AAE9F;;;;;;GAMG;AACH,MAAM,MAAM,UAAU,GAAG,OAAO,UAAU,CAAC,IAAI,CAAA;;;;;;;;AAE/C;;;;;;GAMG;AACH,qBAAa,UAAW,SAAQ,eAM9B;CAAG;;;;;;AAML;;;;;;GAMG;AACH,qBAAa,YAAa,SAAQ,iBAIhC;CAAG;;;;;;;AAEL;;;;;;;GAOG;AACH,qBAAa,eAAgB,SAAQ,oBAGnC;CAAG;;;;;AAEL;;;;;;;;;;;;GAYG;AACH,qBAAa,kBAAmB,SAAQ,uBAGtC;CAAG;AAEL;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,qBAAqB;;;EAGhC,CAAA;;;;;AAEF;;;;;;;;;;;;;;;;;;GAkBG;AACH,qBAAa,eAAgB,SAAQ,oBAGnC;CAAG;;;;;AAEL;;;;;;GAMG;AACH,qBAAa,UAAW,SAAQ,eAG9B;CAAG;AAEL;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,WAAW;;;EAGtB,CAAA;AAEF;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,cAAc;;;;EAGzB,CAAA;;;;;;;;AAEF;;;;;;GAMG;AACH,qBAAa,UAAW,SAAQ,eAG9B;CAAG;;;;AAEL;;;;;;;;;;;GAWG;AACH,qBAAa,eAAgB,SAAQ,oBAEnC;CAAG;;;;;;;;;;;;AAEL;;;;;;;;;;;;;;;;GAgBG;AACH,qBAAa,aAAc,SAAQ,kBAMjC;CAAG;;;;;;AAEL;;;;;;;;;;;;;GAaG;AACH,qBAAa,gBAAiB,SAAQ,qBAIpC;CAAG;AAEL;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,gBAAgB;;;;EAI3B,CAAA;AAEF;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,mBAAmB;;EAE9B,CAAA;;;;;;;;;;;;;AAEF;;;;;;GAMG;AACH,qBAAa,QAAS,SAAQ,aAK5B;CAAG;;;;;;;AAEL;;;;;;;;;;;GAWG;AACH,qBAAa,qBAAsB,SAAQ,0BAKzC;CAAG;AAEL;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,iCAAiC,0EAAkE,CAAA;;;;;AAEhH;;;;;;;;;;;;GAYG;AACH,qBAAa,0BAA2B,SAAQ,+BAK9C;CAAG;;;;;;;AAEL;;;;;;;;;;;;GAYG;AACH,qBAAa,2BAA4B,SAAQ,gCAK/C;CAAG;AAEL;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,6BAA6B;;;EAGxC,CAAA;AAEF;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,YAAY;;;;;;;;;;;;;;;;;EAWvB,CAAA;;;;;;;;;;;;;;;;;;;;;;AAEF;;;;;;GAMG;AACH,qBAAa,OAAQ,SAAQ,YAG3B;CAAG;AAEL;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,kBAAkB;;;;;;;EAI7B,CAAA;;;;;;;AAEF;;;;;;GAMG;AACH,qBAAa,sBAAuB,SAAQ,2BAO1C;CAAG;;;;;;;;AAEL;;;;;;GAMG;AACH,qBAAa,iBAAkB,SAAQ,sBAMrC;CAAG;;;;;AAEL;;;;;;;;;;;;;;;;GAgBG;AACH,qBAAa,IAAK,SAAQ,SAGxB;CAAG;AAEL;;;;;;;GAOG;AACH,eAAO,MAAM,UAAU;;;;;;;;IAIrB,CAAA;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,UAAU,GAAG,OAAO,UAAU,CAAC,IAAI,CAAA;;;;;;;;;;;;;AAE/C;;;;;;GAMG;AACH,qBAAa,iBAAkB,SAAQ,sBAGrC;CAAG;AAEL;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,oBAAoB;;;;EAI/B,CAAA;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,qBAAqB;;;;;;EAEhC,CAAA;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,YAAY;;;;;;;;;EAGvB,CAAA;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,YAAY;;;;;;;;;;;;EAGvB,CAAA;AAEF;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,cAAc,mEAA2D,CAAA;AAEtF;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,6BAA6B,6CAAqC,CAAA;;;;;;;AAU/E;;;;;;;;;;;;;GAaG;AACH,qBAAa,sBAAuB,SAAQ,2BAK1C;CAAG;;;;;;;AAEL;;;;;;GAMG;AACH,qBAAa,4BAA6B,SAAQ,iCAKhD;CAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEL;;;;;;;;;;;;;;;;;GAiBG;AACH,qBAAa,eAAgB,SAAQ,oBASnC;CAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEL;;;;;;;;;;;;GAYG;AACH,qBAAa,qBACX,SAAQ,0BAGN;CACF;;;;AAMF;;;;;;GAMG;AACH,qBAAa,cAAe,SAAQ,mBAElC;CAAG;;;;AAEL;;;;;;GAMG;AACH,qBAAa,eAAgB,SAAQ,oBAEnC;CAAG;;;;;;;;AAEL;;;;;;;;;;;;GAYG;AACH,qBAAa,gBAAiB,SAAQ,qBAMpC;CAAG;;;;AAML;;;;;;GAMG;AACH,qBAAa,iBAAkB,SAAQ,sBAIrC;CAAG;AAEL;;;;;;;;GAQG;AACH,eAAO,MAAM,iBAAiB;;EAE5B,CAAA;AAEF;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,0BAA0B;;;;EAIrC,CAAA;;;;;;;;;;;;;AAEF;;;;;;;;;;;GAWG;AACH,qBAAa,cAAe,SAAQ,mBAKlC;CAAG;AAEL;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,iBAAiB;;;;;;;;;;;EAK5B,CAAA;;;;;;;;;;;;;;;;AAEF;;;;;;GAMG;AACH,qBAAa,sBAAuB,SAAQ,2BAK1C;CAAG;;;;AAEL;;;;;;GAMG;AACH,qBAAa,qBAAsB,SAAQ,0BAIzC;CAAG;AAEL;;;;;;;GAOG;AACH,eAAO,MAAM,iBAAiB;;;EAG5B,CAAA;AAEF;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,iBAAiB;;;;;EAE5B,CAAA;;;;;;;;;;AAEF;;;;;;;;;GASG;AACH,qBAAa,sBAAuB,SAAQ,2BAK1C;CAAG;;;;AAEL;;;;;;GAMG;AACH,qBAAa,gBAAiB,SAAQ,qBAIpC;CAAG;;;;;;AAEL;;;;;;;;;;;;GAYG;AACH,qBAAa,2BAA4B,SAAQ,gCAM/C;CAAG;AAML;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,2BAA2B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IA6CtC,CAAA;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,2BAA2B,GAAG,OAAO,2BAA2B,CAAC,IAAI,CAAA"}

package/dist/AmazonBedrockSchema.js

@@ -24,14 +24,27 @@ const makeIdentifier = name => `${prefix}/${name}`;
  * @since 0.1.0
  */
 export const IntZeroOrGreater = /*#__PURE__*/Schema.Int.check(/*#__PURE__*/Schema.isGreaterThanOrEqualTo(0));
+/**
+ * The stop reasons that the Smithy model of the Converse API names.
+ *
+ * @stability unstable
+ * @category schemas
+ * @since 0.3.0
+ */
+export const KnownStopReason = /*#__PURE__*/Schema.Literals(["end_turn", "tool_use", "max_tokens", "stop_sequence", "guardrail_intervened", "content_filtered", "malformed_model_output", "malformed_tool_use", "model_context_window_exceeded"]);
 /**
  * The reason the model stopped generating a response.
  *
+ * **Details**
+ *
+ * Any string decodes, so a reason that Bedrock adds later, or that a model
+ * returns outside the Smithy model, does not fail the response.
+ *
  * @stability unstable
  * @category schemas
  * @since 0.1.0
  */
-export const StopReason = /*#__PURE__*/Schema.Literals(["end_turn", "tool_use", "max_tokens", "stop_sequence", "guardrail_intervened", "content_filtered", "malformed_model_output", "malformed_tool_use", "model_context_window_exceeded"]);
+export const StopReason = /*#__PURE__*/Schema.Union([KnownStopReason, Schema.StringForLiteralAutocomplete]);
 /**
  * Token usage statistics returned by the Converse API.
  *
@@ -312,6 +325,73 @@ export class CitationsContentBlock extends /*#__PURE__*/Schema.Class(makeIdentif
   content: /*#__PURE__*/Schema.optional(/*#__PURE__*/Schema.Array(CitationTextContent)),
   citations: /*#__PURE__*/Schema.optional(/*#__PURE__*/Schema.Array(Citation))
 }) {}
+/**
+ * The role a guarded text block plays in a contextual grounding check.
+ *
+ * **Details**
+ *
+ * `grounding_source` marks the documents an answer must be grounded in,
+ * `query` marks the question, and `guard_content` marks text the guardrail
+ * evaluates without a grounding role.
+ *
+ * @stability unstable
+ * @category schemas
+ * @since 0.4.0
+ */
+export const GuardrailConverseContentQualifier = /*#__PURE__*/Schema.Literals(["grounding_source", "query", "guard_content"]);
+/**
+ * Text that the guardrail evaluates.
+ *
+ * **Details**
+ *
+ * `qualifiers` uses `optionalKey` for the same reason as
+ * `CachePointBlock.ttl`: the block is built from `Prompt` provider options,
+ * whose values must satisfy `Schema.Json`.
+ *
+ * @stability unstable
+ * @category schemas
+ * @since 0.4.0
+ */
+export class GuardrailConverseTextBlock extends /*#__PURE__*/Schema.Class(makeIdentifier("GuardrailConverseTextBlock"))({
+  text: Schema.String,
+  qualifiers: /*#__PURE__*/Schema.optionalKey(/*#__PURE__*/Schema.Array(GuardrailConverseContentQualifier))
+}) {}
+/**
+ * An image that the guardrail evaluates.
+ *
+ * **Details**
+ *
+ * The Smithy model allows only png and jpeg, and only `bytes` as the source.
+ * `bytes` is a Smithy blob, which the JSON protocol carries as a base64
+ * string.
+ *
+ * @stability unstable
+ * @category schemas
+ * @since 0.4.0
+ */
+export class GuardrailConverseImageBlock extends /*#__PURE__*/Schema.Class(makeIdentifier("GuardrailConverseImageBlock"))({
+  format: /*#__PURE__*/Schema.Literals(["png", "jpeg"]),
+  source: /*#__PURE__*/Schema.Struct({
+    bytes: Schema.String
+  })
+}) {}
+/**
+ * Content that the guardrail evaluates, in a message or in the system prompt.
+ *
+ * **Details**
+ *
+ * AWS models `GuardrailConverseContentBlock` as a UNION, so both members are
+ * optional here. Once a request holds one `guardContent` block, the guardrail
+ * evaluates only the guarded blocks. The model still reads every block.
+ *
+ * @stability unstable
+ * @category schemas
+ * @since 0.4.0
+ */
+export const GuardrailConverseContentBlock = /*#__PURE__*/Schema.Struct({
+  text: /*#__PURE__*/Schema.optional(GuardrailConverseTextBlock),
+  image: /*#__PURE__*/Schema.optional(GuardrailConverseImageBlock)
+});
 /**
  * A text content block within a Converse message.
  *
@@ -336,7 +416,8 @@ export const ContentBlock = /*#__PURE__*/Schema.Struct({
   image: /*#__PURE__*/Schema.optional(ImageBlock),
   document: /*#__PURE__*/Schema.optional(DocumentBlock),
   cachePoint: /*#__PURE__*/Schema.optional(CachePointBlock),
-  citationsContent: /*#__PURE__*/Schema.optional(CitationsContentBlock)
+  citationsContent: /*#__PURE__*/Schema.optional(CitationsContentBlock),
+  guardContent: /*#__PURE__*/Schema.optional(GuardrailConverseContentBlock)
 });
 /**
  * A message within a Converse conversation.
@@ -354,8 +435,9 @@ export class Message extends /*#__PURE__*/Schema.Class(makeIdentifier("Message")
  *
  * **Details**
  *
- * AWS models `SystemContentBlock` as a UNION, so both members are optional; a
- * block carries either the system text or a cache point.
+ * AWS models `SystemContentBlock` as a UNION, so every member is optional; a
+ * block carries the system text, guarded system text, or a cache point. The
+ * guardrail evaluates the system prompt only where it is guarded.
  *
  * @stability unstable
  * @category schemas
@@ -363,7 +445,8 @@ export class Message extends /*#__PURE__*/Schema.Class(makeIdentifier("Message")
  */
 export const SystemContentBlock = /*#__PURE__*/Schema.Struct({
   text: /*#__PURE__*/Schema.optional(Schema.String),
-  cachePoint: /*#__PURE__*/Schema.optional(CachePointBlock)
+  cachePoint: /*#__PURE__*/Schema.optional(CachePointBlock),
+  guardContent: /*#__PURE__*/Schema.optional(GuardrailConverseContentBlock)
 });
 /**
  * Base inference parameters to pass to a model in a Converse call.
@@ -494,7 +577,71 @@ export const OutputConfig = /*#__PURE__*/Schema.Struct({
   effort: /*#__PURE__*/Schema.optionalKey(Schema.String)
 });
 /**
- * The request payload for the Converse and ConverseStream operations.
+ * Whether Bedrock returns the guardrail trace.
+ *
+ * **Details**
+ *
+ * Bedrock's default is `disabled`. The trace holds the text that a policy
+ * matched, unmasked. `enabled_full` is in the Smithy model, and AWS does not
+ * document it.
+ *
+ * @stability unstable
+ * @category schemas
+ * @since 0.4.0
+ */
+export const GuardrailTrace = /*#__PURE__*/Schema.Literals(["enabled", "disabled", "enabled_full"]);
+/**
+ * How ConverseStream applies a guardrail to the streamed output.
+ *
+ * **Details**
+ *
+ * `sync`, Bedrock's default, holds back each chunk until the guardrail has
+ * evaluated it. `async` sends chunks at once, so text that the guardrail
+ * later blocks can reach the caller, and masking does not apply.
+ *
+ * @stability unstable
+ * @category schemas
+ * @since 0.4.0
+ */
+export const GuardrailStreamProcessingMode = /*#__PURE__*/Schema.Literals(["sync", "async"]);
+// Smithy gives the identifier and the version `default: ""`, and Bedrock cannot
+// apply a guardrail without them, so both are required here.
+const guardrailFields = {
+  guardrailIdentifier: Schema.String,
+  guardrailVersion: Schema.String,
+  trace: /*#__PURE__*/Schema.optionalKey(GuardrailTrace)
+};
+/**
+ * The guardrail of a Converse request.
+ *
+ * **Details**
+ *
+ * `guardrailIdentifier` is the guardrail's ID or ARN, and `guardrailVersion`
+ * is a version number or `DRAFT`. Converse has no `streamProcessingMode`, so
+ * the member is typed `never`: a ConverseStream request does not fit Converse
+ * until the mode is removed.
+ *
+ * @stability unstable
+ * @category schemas
+ * @since 0.4.0
+ */
+export class GuardrailConfiguration extends /*#__PURE__*/Schema.Class(makeIdentifier("GuardrailConfiguration"))({
+  ...guardrailFields,
+  streamProcessingMode: /*#__PURE__*/Schema.optionalKey(Schema.Never)
+}) {}
+/**
+ * The guardrail of a ConverseStream request.
+ *
+ * @stability unstable
+ * @category schemas
+ * @since 0.4.0
+ */
+export class GuardrailStreamConfiguration extends /*#__PURE__*/Schema.Class(makeIdentifier("GuardrailStreamConfiguration"))({
+  ...guardrailFields,
+  streamProcessingMode: /*#__PURE__*/Schema.optionalKey(GuardrailStreamProcessingMode)
+}) {}
+/**
+ * The request payload for the Converse operation.
  *
  * **Details**
  *
@@ -518,7 +665,25 @@ export class ConverseRequest extends /*#__PURE__*/Schema.Class(makeIdentifier("C
   toolConfig: /*#__PURE__*/Schema.optionalKey(ToolConfiguration),
   inferenceConfig: /*#__PURE__*/Schema.optional(InferenceConfiguration),
   outputConfig: /*#__PURE__*/Schema.optionalKey(OutputConfig),
-  additionalModelRequestFields: /*#__PURE__*/Schema.optional(/*#__PURE__*/Schema.Record(Schema.String, Schema.Unknown))
+  additionalModelRequestFields: /*#__PURE__*/Schema.optional(/*#__PURE__*/Schema.Record(Schema.String, Schema.Unknown)),
+  guardrailConfig: /*#__PURE__*/Schema.optional(GuardrailConfiguration)
+}) {}
+/**
+ * The request payload for the ConverseStream operation.
+ *
+ * **Details**
+ *
+ * The members of `ConverseRequest`, with the guardrail of a stream, which
+ * adds `streamProcessingMode`. That member is the only difference between the
+ * two operations.
+ *
+ * @stability unstable
+ * @category schemas
+ * @since 0.4.0
+ */
+export class ConverseStreamRequest extends /*#__PURE__*/Schema.Class(makeIdentifier("ConverseStreamRequest"))({
+  ...ConverseRequest.fields,
+  guardrailConfig: /*#__PURE__*/Schema.optional(GuardrailStreamConfiguration)
 }) {}
 // =============================================================================
 // Response
@@ -546,6 +711,12 @@ export class ConverseMetrics extends /*#__PURE__*/Schema.Class(makeIdentifier("C
 /**
  * The response from a successful Converse call.
  *
+ * **Details**
+ *
+ * `trace` is kept as the JSON Bedrock sent. Its Smithy tree has about 90
+ * shapes that AWS still extends, and a struct would drop every member added
+ * later.
+ *
  * @stability unstable
  * @category schemas
  * @since 0.1.0
@@ -554,7 +725,8 @@ export class ConverseResponse extends /*#__PURE__*/Schema.Class(makeIdentifier("
   output: ConverseOutput,
   usage: TokenUsage,
   stopReason: StopReason,
-  metrics: /*#__PURE__*/Schema.optional(ConverseMetrics)
+  metrics: /*#__PURE__*/Schema.optional(ConverseMetrics),
+  trace: /*#__PURE__*/Schema.optional(Schema.MutableJson)
 }) {}
 // =============================================================================
 // Converse Stream Events
@@ -712,7 +884,13 @@ export class MessageStopEvent extends /*#__PURE__*/Schema.Class(makeIdentifier("
   stopReason: StopReason
 }) {}
 /**
- * The trailing metadata event for a Converse stream, carrying usage and metrics.
+ * The trailing metadata event for a Converse stream, carrying usage, metrics,
+ * and the trace.
+ *
+ * **Details**
+ *
+ * This is the only stream event that carries the trace. It is kept as JSON,
+ * as in `ConverseResponse`.
  *
  * @stability unstable
  * @category schemas
@@ -720,7 +898,8 @@ export class MessageStopEvent extends /*#__PURE__*/Schema.Class(makeIdentifier("
  */
 export class ConverseStreamMetadataEvent extends /*#__PURE__*/Schema.Class(makeIdentifier("ConverseStreamMetadataEvent"))({
   usage: TokenUsage,
-  metrics: /*#__PURE__*/Schema.optional(ConverseMetrics)
+  metrics: /*#__PURE__*/Schema.optional(ConverseMetrics),
+  trace: /*#__PURE__*/Schema.optional(Schema.MutableJson)
 }) {}
 const ExceptionBody = /*#__PURE__*/Schema.Struct({
   message: /*#__PURE__*/Schema.optional(Schema.String)