@aws-sdk/client-bedrock-agent-runtime 3.895.0 → 3.898.0

package/dist-types/models/models_1.d.ts

@@ -1,5 +1,248 @@
 import { DocumentType as __DocumentType } from "@smithy/types";
-import { AccessDeniedException, AgentActionGroup, AgentCollaboration, BadGatewayException, BedrockModelConfigurations, CitationEvent, CollaboratorConfiguration, ConflictException, ConversationHistory, CustomOrchestration, DependencyFailedException, ExternalSourcesRetrieveAndGenerateConfiguration, FilterAttribute, GenerationConfiguration, GuadrailAction, GuardrailConfiguration, GuardrailConfigurationWithArn, GuardrailEvent, ImplicitFilterConfiguration, InlineBedrockModelConfigurations, InlineSessionState, InputFile, InternalServerException, InvocationResultMember, OrchestrationConfiguration, OrchestrationType, PromptCreationConfigurations, PromptOverrideConfiguration, ResourceNotFoundException, RetrievalResultContent, RetrievalResultLocation, RetrieveAndGenerateInput, RetrieveAndGenerateSessionConfiguration, RetrieveAndGenerateType, SearchType, ServiceQuotaExceededException, StreamingConfigurations, ThrottlingException, ValidationException, VectorSearchRerankingConfiguration } from "./models_0";
+import { AccessDeniedException, AgentActionGroup, AgentCollaboration, BadGatewayException, BedrockModelConfigurations, ByteContentDoc, Citation, CollaboratorConfiguration, ConflictException, ConversationHistory, CustomOrchestration, DependencyFailedException, ExternalSourcesGenerationConfiguration, FilterAttribute, GeneratedResponsePart, GuardrailConfiguration, GuardrailConfigurationWithArn, ImplicitFilterConfiguration, InferenceConfig, InlineBedrockModelConfigurations, InlineSessionState, InputFile, InternalServerException, InvocationResultMember, OrchestrationType, PerformanceConfiguration, PromptCreationConfigurations, PromptOverrideConfiguration, PromptTemplate, ResourceNotFoundException, RetrievalResultContent, RetrievalResultLocation, RetrieveAndGenerateInput, RetrievedReference, S3ObjectDoc, SearchType, ServiceQuotaExceededException, StreamingConfigurations, ThrottlingException, ValidationException, VectorSearchRerankingConfiguration } from "./models_0";
+/**
+ * @public
+ * @enum
+ */
+export declare const ExternalSourceType: {
+    readonly BYTE_CONTENT: "BYTE_CONTENT";
+    readonly S3: "S3";
+};
+/**
+ * @public
+ */
+export type ExternalSourceType = (typeof ExternalSourceType)[keyof typeof ExternalSourceType];
+/**
+ * <p>The unique external source of the content contained in the wrapper object.</p>
+ * @public
+ */
+export interface ExternalSource {
+    /**
+     * <p>The source type of the external source wrapper object.</p>
+     * @public
+     */
+    sourceType: ExternalSourceType | undefined;
+    /**
+     * <p>The S3 location of the external source wrapper object.</p>
+     * @public
+     */
+    s3Location?: S3ObjectDoc | undefined;
+    /**
+     * <p>The identifier, contentType, and data of the external source wrapper object.</p>
+     * @public
+     */
+    byteContent?: ByteContentDoc | undefined;
+}
+/**
+ * <p>The configurations of the external source wrapper object in the <code>retrieveAndGenerate</code> function.</p>
+ * @public
+ */
+export interface ExternalSourcesRetrieveAndGenerateConfiguration {
+    /**
+     * <p>The model Amazon Resource Name (ARN) for the external source wrapper object in the <code>retrieveAndGenerate</code> function.</p>
+     * @public
+     */
+    modelArn: string | undefined;
+    /**
+     * <p>The document for the external source wrapper object in the <code>retrieveAndGenerate</code> function.</p>
+     * @public
+     */
+    sources: ExternalSource[] | undefined;
+    /**
+     * <p>The prompt used with the external source wrapper object with the <code>retrieveAndGenerate</code> function.</p>
+     * @public
+     */
+    generationConfiguration?: ExternalSourcesGenerationConfiguration | undefined;
+}
+/**
+ * <p>Contains configurations for response generation based on the knowledge base query results.</p> <p>This data type is used in the following API operations:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_RequestSyntax">RetrieveAndGenerate request</a> </p> </li> </ul>
+ * @public
+ */
+export interface GenerationConfiguration {
+    /**
+     * <p>Contains the template for the prompt that's sent to the model for response generation. Generation prompts must include the <code>$search_results$</code> variable. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-placeholders.html">Use placeholder variables</a> in the user guide.</p>
+     * @public
+     */
+    promptTemplate?: PromptTemplate | undefined;
+    /**
+     * <p>The configuration details for the guardrail.</p>
+     * @public
+     */
+    guardrailConfiguration?: GuardrailConfiguration | undefined;
+    /**
+     * <p> Configuration settings for inference when using RetrieveAndGenerate to generate responses while using a knowledge base as a source. </p>
+     * @public
+     */
+    inferenceConfig?: InferenceConfig | undefined;
+    /**
+     * <p> Additional model parameters and corresponding values not included in the textInferenceConfig structure for a knowledge base. This allows users to provide custom model parameters specific to the language model being used. </p>
+     * @public
+     */
+    additionalModelRequestFields?: Record<string, __DocumentType> | undefined;
+    /**
+     * <p>The latency configuration for the model.</p>
+     * @public
+     */
+    performanceConfig?: PerformanceConfiguration | undefined;
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const QueryTransformationType: {
+    readonly QUERY_DECOMPOSITION: "QUERY_DECOMPOSITION";
+};
+/**
+ * @public
+ */
+export type QueryTransformationType = (typeof QueryTransformationType)[keyof typeof QueryTransformationType];
+/**
+ * <p>To split up the prompt and retrieve multiple sources, set the transformation type to <code>QUERY_DECOMPOSITION</code>.</p>
+ * @public
+ */
+export interface QueryTransformationConfiguration {
+    /**
+     * <p>The type of transformation to apply to the prompt.</p>
+     * @public
+     */
+    type: QueryTransformationType | undefined;
+}
+/**
+ * <p>Settings for how the model processes the prompt prior to retrieval and generation.</p>
+ * @public
+ */
+export interface OrchestrationConfiguration {
+    /**
+     * <p>Contains the template for the prompt that's sent to the model. Orchestration prompts must include the <code>$conversation_history$</code> and <code>$output_format_instructions$</code> variables. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-placeholders.html">Use placeholder variables</a> in the user guide.</p>
+     * @public
+     */
+    promptTemplate?: PromptTemplate | undefined;
+    /**
+     * <p> Configuration settings for inference when using RetrieveAndGenerate to generate responses while using a knowledge base as a source. </p>
+     * @public
+     */
+    inferenceConfig?: InferenceConfig | undefined;
+    /**
+     * <p> Additional model parameters and corresponding values not included in the textInferenceConfig structure for a knowledge base. This allows users to provide custom model parameters specific to the language model being used. </p>
+     * @public
+     */
+    additionalModelRequestFields?: Record<string, __DocumentType> | undefined;
+    /**
+     * <p>To split up the prompt and retrieve multiple sources, set the transformation type to <code>QUERY_DECOMPOSITION</code>.</p>
+     * @public
+     */
+    queryTransformationConfiguration?: QueryTransformationConfiguration | undefined;
+    /**
+     * <p>The latency configuration for the model.</p>
+     * @public
+     */
+    performanceConfig?: PerformanceConfiguration | undefined;
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const RetrieveAndGenerateType: {
+    readonly EXTERNAL_SOURCES: "EXTERNAL_SOURCES";
+    readonly KNOWLEDGE_BASE: "KNOWLEDGE_BASE";
+};
+/**
+ * @public
+ */
+export type RetrieveAndGenerateType = (typeof RetrieveAndGenerateType)[keyof typeof RetrieveAndGenerateType];
+/**
+ * <p>Contains configuration about the session with the knowledge base.</p> <p>This data type is used in the following API operations:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_RequestSyntax">RetrieveAndGenerate request</a> – in the <code>sessionConfiguration</code> field</p> </li> </ul>
+ * @public
+ */
+export interface RetrieveAndGenerateSessionConfiguration {
+    /**
+     * <p>The ARN of the KMS key encrypting the session.</p>
+     * @public
+     */
+    kmsKeyArn: string | undefined;
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const GuadrailAction: {
+    readonly INTERVENED: "INTERVENED";
+    readonly NONE: "NONE";
+};
+/**
+ * @public
+ */
+export type GuadrailAction = (typeof GuadrailAction)[keyof typeof GuadrailAction];
+/**
+ * <p>Contains the response generated from querying the knowledge base.</p> <p>This data type is used in the following API operations:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_ResponseSyntax">RetrieveAndGenerate response</a> – in the <code>output</code> field</p> </li> </ul>
+ * @public
+ */
+export interface RetrieveAndGenerateOutput {
+    /**
+     * <p>The response generated from querying the knowledge base.</p>
+     * @public
+     */
+    text: string | undefined;
+}
+/**
+ * @public
+ */
+export interface RetrieveAndGenerateResponse {
+    /**
+     * <p>The unique identifier of the session. When you first make a <code>RetrieveAndGenerate</code> request, Amazon Bedrock automatically generates this value. You must reuse this value for all subsequent requests in the same conversational session. This value allows Amazon Bedrock to maintain context and knowledge from previous interactions. You can't explicitly set the <code>sessionId</code> yourself.</p>
+     * @public
+     */
+    sessionId: string | undefined;
+    /**
+     * <p>Contains the response generated from querying the knowledge base.</p>
+     * @public
+     */
+    output: RetrieveAndGenerateOutput | undefined;
+    /**
+     * <p>A list of segments of the generated response that are based on sources in the knowledge base, alongside information about the sources.</p>
+     * @public
+     */
+    citations?: Citation[] | undefined;
+    /**
+     * <p>Specifies if there is a guardrail intervention in the response.</p>
+     * @public
+     */
+    guardrailAction?: GuadrailAction | undefined;
+}
+/**
+ * <p>A citation event.</p>
+ * @public
+ */
+export interface CitationEvent {
+    /**
+     * <p>The citation.</p>
+     *
+     * @deprecated
+     * @public
+     */
+    citation?: Citation | undefined;
+    /**
+     * <p>The generated response to the citation event.</p>
+     * @public
+     */
+    generatedResponsePart?: GeneratedResponsePart | undefined;
+    /**
+     * <p>The retrieved references of the citation event.</p>
+     * @public
+     */
+    retrievedReferences?: RetrievedReference[] | undefined;
+}
+/**
+ * <p>A guardrail event.</p>
+ * @public
+ */
+export interface GuardrailEvent {
+    /**
+     * <p>The guardrail action.</p>
+     * @public
+     */
+    action?: GuadrailAction | undefined;
+}
 /**
  * <p>A retrieve and generate output event.</p>
  * @public
@@ -1891,6 +2134,34 @@ export interface InvokeInlineAgentRequest {
      */
     customOrchestration?: CustomOrchestration | undefined;
 }
+/**
+ * @internal
+ */
+export declare const ExternalSourceFilterSensitiveLog: (obj: ExternalSource) => any;
+/**
+ * @internal
+ */
+export declare const ExternalSourcesRetrieveAndGenerateConfigurationFilterSensitiveLog: (obj: ExternalSourcesRetrieveAndGenerateConfiguration) => any;
+/**
+ * @internal
+ */
+export declare const GenerationConfigurationFilterSensitiveLog: (obj: GenerationConfiguration) => any;
+/**
+ * @internal
+ */
+export declare const OrchestrationConfigurationFilterSensitiveLog: (obj: OrchestrationConfiguration) => any;
+/**
+ * @internal
+ */
+export declare const RetrieveAndGenerateOutputFilterSensitiveLog: (obj: RetrieveAndGenerateOutput) => any;
+/**
+ * @internal
+ */
+export declare const RetrieveAndGenerateResponseFilterSensitiveLog: (obj: RetrieveAndGenerateResponse) => any;
+/**
+ * @internal
+ */
+export declare const CitationEventFilterSensitiveLog: (obj: CitationEvent) => any;
 /**
  * @internal
  */

package/dist-types/ts3.4/commands/RetrieveAndGenerateCommand.d.ts

@@ -5,8 +5,10 @@ import {
   ServiceInputTypes,
   ServiceOutputTypes,
 } from "../BedrockAgentRuntimeClient";
-import { RetrieveAndGenerateResponse } from "../models/models_0";
-import { RetrieveAndGenerateRequest } from "../models/models_1";
+import {
+  RetrieveAndGenerateRequest,
+  RetrieveAndGenerateResponse,
+} from "../models/models_1";
 export { __MetadataBearer };
 export { $Command };
 export interface RetrieveAndGenerateCommandInput