Add Prompt Caching support to Converse and ConverseStream APIs

Author: aws-sdk-dotnet-automation

generator/ServiceModels/bedrock-runtime/bedrock-runtime-2023-09-30.api.json

@@ -316,6 +316,17 @@
       "min":0,
       "sensitive":true
     },
+    "CachePointBlock":{
+      "type":"structure",
+      "required":["type"],
+      "members":{
+        "type":{"shape":"CachePointType"}
+      }
+    },
+    "CachePointType":{
+      "type":"string",
+      "enum":["default"]
+    },
     "ConflictException":{
       "type":"structure",
       "members":{
@@ -337,6 +348,7 @@
         "toolUse":{"shape":"ToolUseBlock"},
         "toolResult":{"shape":"ToolResultBlock"},
         "guardContent":{"shape":"GuardrailConverseContentBlock"},
+        "cachePoint":{"shape":"CachePointBlock"},
         "reasoningContent":{"shape":"ReasoningContentBlock"}
       },
       "union":true
@@ -1845,7 +1857,8 @@
       "type":"structure",
       "members":{
         "text":{"shape":"NonEmptyString"},
-        "guardContent":{"shape":"GuardrailConverseContentBlock"}
+        "guardContent":{"shape":"GuardrailConverseContentBlock"},
+        "cachePoint":{"shape":"CachePointBlock"}
       },
       "union":true
     },
@@ -1915,9 +1928,21 @@
       "members":{
         "inputTokens":{"shape":"TokenUsageInputTokensInteger"},
         "outputTokens":{"shape":"TokenUsageOutputTokensInteger"},
-        "totalTokens":{"shape":"TokenUsageTotalTokensInteger"}
+        "totalTokens":{"shape":"TokenUsageTotalTokensInteger"},
+        "cacheReadInputTokens":{"shape":"TokenUsageCacheReadInputTokensInteger"},
+        "cacheWriteInputTokens":{"shape":"TokenUsageCacheWriteInputTokensInteger"}
       }
     },
+    "TokenUsageCacheReadInputTokensInteger":{
+      "type":"integer",
+      "box":true,
+      "min":0
+    },
+    "TokenUsageCacheWriteInputTokensInteger":{
+      "type":"integer",
+      "box":true,
+      "min":0
+    },
     "TokenUsageInputTokensInteger":{
       "type":"integer",
       "box":true,
@@ -1936,7 +1961,8 @@
     "Tool":{
       "type":"structure",
       "members":{
-        "toolSpec":{"shape":"ToolSpecification"}
+        "toolSpec":{"shape":"ToolSpecification"},
+        "cachePoint":{"shape":"CachePointBlock"}
       },
       "union":true
     },

generator/ServiceModels/bedrock-runtime/bedrock-runtime-2023-09-30.docs.json

@@ -123,6 +123,20 @@
         "InvokeModelWithResponseStreamRequest$body": "<p>The prompt and inference parameters in the format specified in the <code>contentType</code> in the header. You must provide the body in JSON format. To see the format and content of the request and response bodies for different models, refer to <a href=\"https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html\">Inference parameters</a>. For more information, see <a href=\"https://docs.aws.amazon.com/bedrock/latest/userguide/api-methods-run.html\">Run inference</a> in the Bedrock User Guide.</p>"
       }
     },
+    "CachePointBlock": {
+      "base": "<p>Defines a section of content to be cached for reuse in subsequent API calls.</p>",
+      "refs": {
+        "ContentBlock$cachePoint": "<p>CachePoint to include in the message.</p>",
+        "SystemContentBlock$cachePoint": "<p>CachePoint to include in the system prompt.</p>",
+        "Tool$cachePoint": "<p>CachePoint to include in the tool configuration.</p>"
+      }
+    },
+    "CachePointType": {
+      "base": null,
+      "refs": {
+        "CachePointBlock$type": "<p>Specifies the type of cache point within the CachePointBlock.</p>"
+      }
+    },
     "ConflictException": {
       "base": "<p>Error occurred because of a conflict while performing an operation.</p>",
       "refs": {
@@ -1343,6 +1357,18 @@
         "ConverseStreamMetadataEvent$usage": "<p>Usage information for the conversation stream event.</p>"
       }
     },
+    "TokenUsageCacheReadInputTokensInteger": {
+      "base": null,
+      "refs": {
+        "TokenUsage$cacheReadInputTokens": "<p>The number of input tokens read from the cache for the request.</p>"
+      }
+    },
+    "TokenUsageCacheWriteInputTokensInteger": {
+      "base": null,
+      "refs": {
+        "TokenUsage$cacheWriteInputTokens": "<p>The number of input tokens written to the cache for the request.</p>"
+      }
+    },
     "TokenUsageInputTokensInteger": {
       "base": null,
       "refs": {

generator/ServiceModels/bedrock-runtime/bedrock-runtime-2023-09-30.normal.json

@@ -392,6 +392,21 @@
       "min":0,
       "sensitive":true
     },
+    "CachePointBlock":{
+      "type":"structure",
+      "required":["type"],
+      "members":{
+        "type":{
+          "shape":"CachePointType",
+          "documentation":"<p>Specifies the type of cache point within the CachePointBlock.</p>"
+        }
+      },
+      "documentation":"<p>Defines a section of content to be cached for reuse in subsequent API calls.</p>"
+    },
+    "CachePointType":{
+      "type":"string",
+      "enum":["default"]
+    },
     "ConflictException":{
       "type":"structure",
       "members":{
@@ -435,6 +450,10 @@
           "shape":"GuardrailConverseContentBlock",
           "documentation":"<p>Contains the content to assess with the guardrail. If you don't specify <code>guardContent</code> in a call to the Converse API, the guardrail (if passed in the Converse API) assesses the entire message.</p> <p>For more information, see <i>Use a guardrail with the Converse API</i> in the <i>Amazon Bedrock User Guide</i>. <pre><code> &lt;/p&gt; </code></pre>"
         },
+        "cachePoint":{
+          "shape":"CachePointBlock",
+          "documentation":"<p>CachePoint to include in the message.</p>"
+        },
         "reasoningContent":{
           "shape":"ReasoningContentBlock",
           "documentation":"<p>Contains content regarding the reasoning that is carried out by the model. Reasoning refers to a Chain of Thought (CoT) that the model generates to enhance the accuracy of its final response.</p>"
@@ -2641,6 +2660,10 @@
         "guardContent":{
           "shape":"GuardrailConverseContentBlock",
           "documentation":"<p>A content block to assess with the guardrail. Use with the <a href=\"https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_Converse.html\">Converse</a> or <a href=\"https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_ConverseStream.html\">ConverseStream</a> API operations. </p> <p>For more information, see <i>Use a guardrail with the Converse API</i> in the <i>Amazon Bedrock User Guide</i>.</p>"
+        },
+        "cachePoint":{
+          "shape":"CachePointBlock",
+          "documentation":"<p>CachePoint to include in the system prompt.</p>"
         }
       },
       "documentation":"<p>A system content block.</p>",
@@ -2729,10 +2752,28 @@
         "totalTokens":{
           "shape":"TokenUsageTotalTokensInteger",
           "documentation":"<p>The total of input tokens and tokens generated by the model.</p>"
+        },
+        "cacheReadInputTokens":{
+          "shape":"TokenUsageCacheReadInputTokensInteger",
+          "documentation":"<p>The number of input tokens read from the cache for the request.</p>"
+        },
+        "cacheWriteInputTokens":{
+          "shape":"TokenUsageCacheWriteInputTokensInteger",
+          "documentation":"<p>The number of input tokens written to the cache for the request.</p>"
         }
       },
       "documentation":"<p>The tokens used in a message API inference call. </p>"
     },
+    "TokenUsageCacheReadInputTokensInteger":{
+      "type":"integer",
+      "box":true,
+      "min":0
+    },
+    "TokenUsageCacheWriteInputTokensInteger":{
+      "type":"integer",
+      "box":true,
+      "min":0
+    },
     "TokenUsageInputTokensInteger":{
       "type":"integer",
       "box":true,
@@ -2754,6 +2795,10 @@
         "toolSpec":{
           "shape":"ToolSpecification",
           "documentation":"<p>The specfication for the tool.</p>"
+        },
+        "cachePoint":{
+          "shape":"CachePointBlock",
+          "documentation":"<p>CachePoint to include in the tool configuration.</p>"
         }
       },
       "documentation":"<p>Information about a tool that you can use with the Converse API. For more information, see <a href=\"https://docs.aws.amazon.com/bedrock/latest/userguide/tool-use.html\">Tool use (function calling)</a> in the Amazon Bedrock User Guide.</p>",

sdk/code-analysis/ServiceAnalysis/BedrockRuntime/Generated/PropertyValueRules.xml

@@ -308,6 +308,14 @@
     <max>256</max>
     <pattern>[a-zA-Z0-9\s._:/=+@-]*</pattern>
   </property-value-rule>
+  <property-value-rule>
+    <property>Amazon.BedrockRuntime.Model.TokenUsage.CacheReadInputTokens</property>
+    <min>0</min>
+  </property-value-rule>
+  <property-value-rule>
+    <property>Amazon.BedrockRuntime.Model.TokenUsage.CacheWriteInputTokens</property>
+    <min>0</min>
+  </property-value-rule>
   <property-value-rule>
     <property>Amazon.BedrockRuntime.Model.TokenUsage.InputTokens</property>
     <min>0</min>

sdk/src/Services/BedrockRuntime/Generated/Model/CachePointBlock.cs

@@ -0,0 +1,59 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * 
+ * Licensed under the Apache License, Version 2.0 (the "License").
+ * You may not use this file except in compliance with the License.
+ * A copy of the License is located at
+ * 
+ *  http://aws.amazon.com/apache2.0
+ * 
+ * or in the "license" file accompanying this file. This file is distributed
+ * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+ * express or implied. See the License for the specific language governing
+ * permissions and limitations under the License.
+ */
+
+/*
+ * Do not modify this file. This file is generated from the bedrock-runtime-2023-09-30.normal.json service model.
+ */
+using System;
+using System.Collections.Generic;
+using System.Xml.Serialization;
+using System.Text;
+using System.IO;
+using System.Net;
+
+using Amazon.Runtime;
+using Amazon.Runtime.Internal;
+
+#pragma warning disable CS0612,CS0618,CS1570
+namespace Amazon.BedrockRuntime.Model
+{
+    /// <summary>
+    /// Defines a section of content to be cached for reuse in subsequent API calls.
+    /// </summary>
+    public partial class CachePointBlock
+    {
+        private CachePointType _type;
+
+        /// <summary>
+        /// Gets and sets the property Type. 
+        /// <para>
+        /// Specifies the type of cache point within the CachePointBlock.
+        /// </para>
+        /// </summary>
+        [AWSProperty(Required=true)]
+        public CachePointType Type
+        {
+            get { return this._type; }
+            set { this._type = value; }
+        }
+
+        // Check to see if Type property is set
+        internal bool IsSetType()
+        {
+            return this._type != null;
+        }
+
+    }
+}

sdk/src/Services/BedrockRuntime/Generated/Model/ContentBlock.cs

@@ -37,6 +37,7 @@ namespace Amazon.BedrockRuntime.Model
     /// </summary>
     public partial class ContentBlock
     {
+        private CachePointBlock _cachePoint;
         private DocumentBlock _document;
         private GuardrailConverseContentBlock _guardContent;
         private ImageBlock _image;
@@ -46,6 +47,24 @@ public partial class ContentBlock
         private ToolUseBlock _toolUse;
         private VideoBlock _video;
 
+        /// <summary>
+        /// Gets and sets the property CachePoint. 
+        /// <para>
+        /// CachePoint to include in the message.
+        /// </para>
+        /// </summary>
+        public CachePointBlock CachePoint
+        {
+            get { return this._cachePoint; }
+            set { this._cachePoint = value; }
+        }
+
+        // Check to see if CachePoint property is set
+        internal bool IsSetCachePoint()
+        {
+            return this._cachePoint != null;
+        }
+
         /// <summary>
         /// Gets and sets the property Document. 
         /// <para>

sdk/src/Services/BedrockRuntime/Generated/Model/Internal/MarshallTransformations/CachePointBlockMarshaller.cs

@@ -0,0 +1,65 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * 
+ * Licensed under the Apache License, Version 2.0 (the "License").
+ * You may not use this file except in compliance with the License.
+ * A copy of the License is located at
+ * 
+ *  http://aws.amazon.com/apache2.0
+ * 
+ * or in the "license" file accompanying this file. This file is distributed
+ * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+ * express or implied. See the License for the specific language governing
+ * permissions and limitations under the License.
+ */
+
+/*
+ * Do not modify this file. This file is generated from the bedrock-runtime-2023-09-30.normal.json service model.
+ */
+using System;
+using System.Collections.Generic;
+using System.Globalization;
+using System.IO;
+using System.Text;
+using System.Xml.Serialization;
+
+using Amazon.BedrockRuntime.Model;
+using Amazon.Runtime;
+using Amazon.Runtime.Internal;
+using Amazon.Runtime.Internal.Transform;
+using Amazon.Runtime.Internal.Util;
+using ThirdParty.Json.LitJson;
+
+#pragma warning disable CS0612,CS0618
+namespace Amazon.BedrockRuntime.Model.Internal.MarshallTransformations
+{
+    /// <summary>
+    /// CachePointBlock Marshaller
+    /// </summary>
+    public class CachePointBlockMarshaller : IRequestMarshaller<CachePointBlock, JsonMarshallerContext> 
+    {
+        /// <summary>
+        /// Unmarshaller the response from the service to the response class.
+        /// </summary>  
+        /// <param name="requestObject"></param>
+        /// <param name="context"></param>
+        /// <returns></returns>
+        public void Marshall(CachePointBlock requestObject, JsonMarshallerContext context)
+        {
+            if(requestObject == null)
+                return;
+            if(requestObject.IsSetType())
+            {
+                context.Writer.WritePropertyName("type");
+                context.Writer.Write(requestObject.Type);
+            }
+
+        }
+
+        /// <summary>
+        /// Singleton Marshaller.
+        /// </summary>
+        public readonly static CachePointBlockMarshaller Instance = new CachePointBlockMarshaller();
+
+    }
+}