feat(client-bedrock-agent-runtime): This change is to deprecate the e…

…xisting citation field under RetrieveAndGenerateStream API response in lieu of GeneratedResponsePart and RetrievedReferences
aws · Jan 31, 2025 · c7b79b5 · c7b79b5
1 parent 423ede1
commit c7b79b5
Show file tree

Hide file tree

Showing 4 changed files with 93 additions and 0 deletions.
diff --git a/clients/client-bedrock-agent-runtime/src/commands/RetrieveAndGenerateStreamCommand.ts b/clients/client-bedrock-agent-runtime/src/commands/RetrieveAndGenerateStreamCommand.ts
@@ -314,6 +314,61 @@ export interface RetrieveAndGenerateStreamCommandOutput extends RetrieveAndGener
  * //           },
  * //         ],
  * //       },
+ * //       generatedResponsePart: {
+ * //         textResponsePart: {
+ * //           text: "STRING_VALUE",
+ * //           span: {
+ * //             start: Number("int"),
+ * //             end: Number("int"),
+ * //           },
+ * //         },
+ * //       },
+ * //       retrievedReferences: [
+ * //         {
+ * //           content: {
+ * //             type: "TEXT" || "IMAGE" || "ROW",
+ * //             text: "STRING_VALUE",
+ * //             byteContent: "STRING_VALUE",
+ * //             row: [
+ * //               {
+ * //                 columnName: "STRING_VALUE",
+ * //                 columnValue: "STRING_VALUE",
+ * //                 type: "BLOB" || "BOOLEAN" || "DOUBLE" || "NULL" || "LONG" || "STRING",
+ * //               },
+ * //             ],
+ * //           },
+ * //           location: {
+ * //             type: "S3" || "WEB" || "CONFLUENCE" || "SALESFORCE" || "SHAREPOINT" || "CUSTOM" || "KENDRA" || "SQL", // required
+ * //             s3Location: {
+ * //               uri: "STRING_VALUE",
+ * //             },
+ * //             webLocation: {
+ * //               url: "STRING_VALUE",
+ * //             },
+ * //             confluenceLocation: {
+ * //               url: "STRING_VALUE",
+ * //             },
+ * //             salesforceLocation: {
+ * //               url: "STRING_VALUE",
+ * //             },
+ * //             sharePointLocation: {
+ * //               url: "STRING_VALUE",
+ * //             },
+ * //             customDocumentLocation: {
+ * //               id: "STRING_VALUE",
+ * //             },
+ * //             kendraDocumentLocation: {
+ * //               uri: "STRING_VALUE",
+ * //             },
+ * //             sqlLocation: {
+ * //               query: "STRING_VALUE",
+ * //             },
+ * //           },
+ * //           metadata: {
+ * //             "<keys>": "DOCUMENT_VALUE",
+ * //           },
+ * //         },
+ * //       ],
  * //     },
  * //     guardrail: { // GuardrailEvent
  * //       action: "INTERVENED" || "NONE",

diff --git a/clients/client-bedrock-agent-runtime/src/models/models_0.ts b/clients/client-bedrock-agent-runtime/src/models/models_0.ts
@@ -7556,10 +7556,24 @@ export interface RetrieveAndGenerateResponse {
  */
 export interface CitationEvent {
   /**
+   * @deprecated
+   *
    * <p>The citation.</p>
    * @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;
 }
 
 /**
@@ -10222,6 +10236,12 @@ export const RetrieveAndGenerateResponseFilterSensitiveLog = (obj: RetrieveAndGe
 export const CitationEventFilterSensitiveLog = (obj: CitationEvent): any => ({
   ...obj,
   ...(obj.citation && { citation: CitationFilterSensitiveLog(obj.citation) }),
+  ...(obj.generatedResponsePart && {
+    generatedResponsePart: GeneratedResponsePartFilterSensitiveLog(obj.generatedResponsePart),
+  }),
+  ...(obj.retrievedReferences && {
+    retrievedReferences: obj.retrievedReferences.map((item) => RetrievedReferenceFilterSensitiveLog(item)),
+  }),
 });
 
 /**

diff --git a/clients/client-bedrock-agent-runtime/src/protocols/Aws_restJson1.ts b/clients/client-bedrock-agent-runtime/src/protocols/Aws_restJson1.ts
@@ -2255,6 +2255,8 @@ const de_Citation = (output: any, context: __SerdeContext): Citation => {
 const de_CitationEvent = (output: any, context: __SerdeContext): CitationEvent => {
   return take(output, {
     citation: (_: any) => de_Citation(_, context),
+    generatedResponsePart: _json,
+    retrievedReferences: (_: any) => de_RetrievedReferences(_, context),
   }) as any;
 };
 

diff --git a/codegen/sdk-codegen/aws-models/bedrock-agent-runtime.json b/codegen/sdk-codegen/aws-models/bedrock-agent-runtime.json
@@ -1567,8 +1567,24 @@
         "citation": {
           "target": "com.amazonaws.bedrockagentruntime#Citation",
           "traits": {
+            "smithy.api#deprecated": {
+              "since": "2024-12-17",
+              "message": "Citation is deprecated. Please use GeneratedResponsePart and RetrievedReferences for citation event."
+            },
             "smithy.api#documentation": "<p>The citation.</p>"
           }
+        },
+        "generatedResponsePart": {
+          "target": "com.amazonaws.bedrockagentruntime#GeneratedResponsePart",
+          "traits": {
+            "smithy.api#documentation": "<p>The generated response to the citation event.</p>"
+          }
+        },
+        "retrievedReferences": {
+          "target": "com.amazonaws.bedrockagentruntime#RetrievedReferences",
+          "traits": {
+            "smithy.api#documentation": "<p>The retrieved references of the citation event.</p>"
+          }
         }
       },
       "traits": {