Skip to content

Commit 9496119

Browse files
authored
Update BedrockRuntime.html
1 parent 99bc456 commit 9496119

1 file changed

Lines changed: 29 additions & 25 deletions

File tree

Documentation/html/BedrockRuntime.html

Lines changed: 29 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,22 @@
1+
2+
13
<!DOCTYPE html>
2-
<html class="writer-html5" lang="en" >
4+
<html class="writer-html5" lang="en" data-content_root="./">
35
<head>
4-
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
6+
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
57

68
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
79
<title>☁️ 6.2 Bedrock Runtime &mdash; MATLAB Interface for Amazon Web Services documentation</title>
8-
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
9-
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
10-
<link rel="stylesheet" href="_static/css/mathworks.css" type="text/css" />
11-
<!--[if lt IE 9]>
12-
<script src="_static/js/html5shiv.min.js"></script>
13-
<![endif]-->
10+
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b86133f3" />
11+
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
12+
<link rel="stylesheet" type="text/css" href="_static/css/mathworks.css?v=985a5e33" />
13+
1414

15-
<script src="_static/jquery.js"></script>
16-
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
17-
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
18-
<script src="_static/doctools.js"></script>
19-
<script src="_static/sphinx_highlight.js"></script>
15+
<script src="_static/jquery.js?v=5d32c60e"></script>
16+
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
17+
<script src="_static/documentation_options.js?v=5929fcd5"></script>
18+
<script src="_static/doctools.js?v=9bcbadda"></script>
19+
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
2020
<script src="_static/js/theme.js"></script>
2121
<link rel="index" title="Index" href="genindex.html" />
2222
<link rel="search" title="Search" href="search.html" />
@@ -122,7 +122,7 @@
122122
<div itemprop="articleBody">
123123

124124
<section id="bedrock-runtime">
125-
<h1>☁️ 6.2 Bedrock Runtime<a class="headerlink" href="#bedrock-runtime" title="Permalink to this heading"></a></h1>
125+
<h1>☁️ 6.2 Bedrock Runtime<a class="headerlink" href="#bedrock-runtime" title="Link to this heading"></a></h1>
126126
<p>A MATLAB client for the Amazon Bedrock Runtime service. It provides API operations for running inference against Bedrock foundation models.</p>
127127
<div class="highlight-matlab notranslate"><div class="highlight"><pre><span></span><span class="n">bedrock</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="n">aws</span><span class="p">.</span><span class="n">bedrock</span><span class="p">.</span><span class="n">runtime</span><span class="p">.</span><span class="n">Client</span><span class="p">(</span><span class="s">&#39;region&#39;</span><span class="p">,</span><span class="w"> </span><span class="s">&#39;us-east-1&#39;</span><span class="p">);</span>
128128
</pre></div>
@@ -132,16 +132,16 @@ <h1>☁️ 6.2 Bedrock Runtime<a class="headerlink" href="#bedrock-runtime" titl
132132
<p>Bedrock Runtime is not available in some default regions (e.g., <code class="docutils literal notranslate"><span class="pre">us-west-1</span></code>). Use a supported region such as <code class="docutils literal notranslate"><span class="pre">us-east-1</span></code>.</p>
133133
</div>
134134
<section id="list-of-available-methods">
135-
<h2>🔧 6.2.1 List of Available Methods<a class="headerlink" href="#list-of-available-methods" title="Permalink to this heading"></a></h2>
135+
<h2>🔧 6.2.1 List of Available Methods<a class="headerlink" href="#list-of-available-methods" title="Link to this heading"></a></h2>
136136
<ul class="simple">
137137
<li><p><a class="reference internal" href="AWSSDKAPI.html#awsbedrockruntimeclientconverse"><span class="std std-ref">converse</span></a></p></li>
138138
<li><p><a class="reference internal" href="AWSSDKAPI.html#awsbedrockruntimeclientinvokemodel"><span class="std std-ref">invokeModel</span></a></p></li>
139139
</ul>
140140
</section>
141141
<section id="examples">
142-
<h2>🧩 6.2.2 Examples<a class="headerlink" href="#examples" title="Permalink to this heading"></a></h2>
142+
<h2>🧩 6.2.2 Examples<a class="headerlink" href="#examples" title="Link to this heading"></a></h2>
143143
<section id="invoke-a-model-text-generation">
144-
<h3>🔸 Invoke a Model (Text Generation)<a class="headerlink" href="#invoke-a-model-text-generation" title="Permalink to this heading"></a></h3>
144+
<h3>🔸 Invoke a Model (Text Generation)<a class="headerlink" href="#invoke-a-model-text-generation" title="Link to this heading"></a></h3>
145145
<div class="highlight-matlab notranslate"><div class="highlight"><pre><span></span><span class="n">textPrompt</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="s">&quot;What is your name?&quot;</span><span class="p">;</span>
146146

147147
<span class="n">response</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="n">bedrock</span><span class="p">.</span><span class="n">invokeModel</span><span class="p">(</span><span class="w"> </span><span class="k">...</span>
@@ -151,17 +151,21 @@ <h3>🔸 Invoke a Model (Text Generation)<a class="headerlink" href="#invoke-a-m
151151
<span class="nb">disp</span><span class="p">(</span><span class="n">response</span><span class="p">.</span><span class="n">outputText</span><span class="p">);</span>
152152
</pre></div>
153153
</div>
154+
<div class="admonition note">
155+
<p class="admonition-title">Note</p>
156+
<p>Some models provided in the example might have reached end of life. Use the updated model_id in case of errors like “This model version has reached the end of its life”.</p>
157+
</div>
154158
</section>
155159
<section id="invoke-a-model-image-generation">
156-
<h3>🔸 Invoke a Model (Image Generation)<a class="headerlink" href="#invoke-a-model-image-generation" title="Permalink to this heading"></a></h3>
160+
<h3>🔸 Invoke a Model (Image Generation)<a class="headerlink" href="#invoke-a-model-image-generation" title="Link to this heading"></a></h3>
157161
<div class="highlight-matlab notranslate"><div class="highlight"><pre><span></span><span class="n">spec</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="nb">struct</span><span class="p">(</span><span class="nb">text</span><span class="p">=</span><span class="s">&quot;Neon skyline at dusk&quot;</span><span class="p">,</span><span class="w"> </span><span class="n">seed</span><span class="p">=</span><span class="mi">42</span><span class="p">,</span><span class="w"> </span><span class="n">style</span><span class="p">=</span><span class="s">&quot;photographic&quot;</span><span class="p">);</span>
158162
<span class="n">resp</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="n">bedrock</span><span class="p">.</span><span class="n">invokeModel</span><span class="p">(</span><span class="n">modelId</span><span class="p">=</span><span class="s">&quot;amazon.titan-image-generator-v1&quot;</span><span class="p">,</span><span class="w"> </span><span class="n">body</span><span class="p">=</span><span class="n">spec</span><span class="p">);</span>
159163
<span class="nb">disp</span><span class="p">(</span><span class="n">resp</span><span class="p">.</span><span class="n">responseBody</span><span class="p">);</span>
160164
</pre></div>
161165
</div>
162166
</section>
163167
<section id="stateful-conversation-multi-turn-text">
164-
<h3>🔸 Stateful Conversation (Multi-Turn; Text)<a class="headerlink" href="#stateful-conversation-multi-turn-text" title="Permalink to this heading"></a></h3>
168+
<h3>🔸 Stateful Conversation (Multi-Turn; Text)<a class="headerlink" href="#stateful-conversation-multi-turn-text" title="Link to this heading"></a></h3>
165169
<div class="highlight-matlab notranslate"><div class="highlight"><pre><span></span><span class="n">firstPrompt</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="s">&quot;Tell me about yourself in 50 words?&quot;</span><span class="p">;</span>
166170
<span class="n">message1</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="n">aws</span><span class="p">.</span><span class="n">bedrock</span><span class="p">.</span><span class="n">runtime</span><span class="p">.</span><span class="n">model</span><span class="p">.</span><span class="n">Message</span><span class="p">(</span><span class="nb">text</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="n">firstPrompt</span><span class="p">,</span><span class="w"> </span><span class="n">role</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="s">&quot;user&quot;</span><span class="p">);</span>
167171

@@ -188,7 +192,7 @@ <h3>🔸 Stateful Conversation (Multi-Turn; Text)<a class="headerlink" href="#st
188192
</div>
189193
</section>
190194
<section id="converse-with-image-vision-models-only">
191-
<h3>🔸 Converse with Image (Vision Models Only)<a class="headerlink" href="#converse-with-image-vision-models-only" title="Permalink to this heading"></a></h3>
195+
<h3>🔸 Converse with Image (Vision Models Only)<a class="headerlink" href="#converse-with-image-vision-models-only" title="Link to this heading"></a></h3>
192196
<div class="highlight-matlab notranslate"><div class="highlight"><pre><span></span><span class="n">imgMsg</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="n">aws</span><span class="p">.</span><span class="n">bedrock</span><span class="p">.</span><span class="n">runtime</span><span class="p">.</span><span class="n">model</span><span class="p">.</span><span class="n">Message</span><span class="p">(</span><span class="n">imageData</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="n">imageArray</span><span class="p">);</span><span class="w"> </span><span class="c">% numeric image</span>
193197

194198
<span class="n">resp</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="n">bedrock</span><span class="p">.</span><span class="n">converse</span><span class="p">(</span><span class="w"> </span><span class="k">...</span>
@@ -201,9 +205,9 @@ <h3>🔸 Converse with Image (Vision Models Only)<a class="headerlink" href="#co
201205
</section>
202206
</section>
203207
<section id="method-reference-summary">
204-
<h2>📘 6.2.3 Method Reference (Summary)<a class="headerlink" href="#method-reference-summary" title="Permalink to this heading"></a></h2>
208+
<h2>📘 6.2.3 Method Reference (Summary)<a class="headerlink" href="#method-reference-summary" title="Link to this heading"></a></h2>
205209
<section id="invokemodel">
206-
<h3>🔸 <code class="docutils literal notranslate"><span class="pre">invokeModel</span></code><a class="headerlink" href="#invokemodel" title="Permalink to this heading"></a></h3>
210+
<h3>🔸 <code class="docutils literal notranslate"><span class="pre">invokeModel</span></code><a class="headerlink" href="#invokemodel" title="Link to this heading"></a></h3>
207211
<div class="highlight-matlab notranslate"><div class="highlight"><pre><span></span><span class="n">response</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="n">bedrock</span><span class="p">.</span><span class="n">invokeModel</span><span class="p">(</span><span class="n">modelId</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="s">&quot;&lt;model-id&gt;&quot;</span><span class="p">,</span><span class="w"> </span><span class="n">body</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="o">&lt;</span><span class="nb">string</span><span class="o">&gt;</span><span class="p">);</span>
208212
</pre></div>
209213
</div>
@@ -216,7 +220,7 @@ <h3>🔸 <code class="docutils literal notranslate"><span class="pre">invokeMode
216220
</ul>
217221
</section>
218222
<section id="converse">
219-
<h3>🔸 <code class="docutils literal notranslate"><span class="pre">converse</span></code><a class="headerlink" href="#converse" title="Permalink to this heading"></a></h3>
223+
<h3>🔸 <code class="docutils literal notranslate"><span class="pre">converse</span></code><a class="headerlink" href="#converse" title="Link to this heading"></a></h3>
220224
<div class="highlight-matlab notranslate"><div class="highlight"><pre><span></span><span class="n">response</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="n">bedrock</span><span class="p">.</span><span class="n">converse</span><span class="p">(</span><span class="w"> </span><span class="k">...</span>
221225
<span class="w"> </span><span class="n">modelId</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="s">&quot;&lt;model-id&gt;&quot;</span><span class="p">,</span><span class="w"> </span><span class="k">...</span>
222226
<span class="w"> </span><span class="n">messages</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="o">&lt;</span><span class="n">Message</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">Message</span><span class="p">[]</span><span class="o">&gt;</span><span class="p">,</span><span class="w"> </span><span class="k">...</span>
@@ -233,7 +237,7 @@ <h3>🔸 <code class="docutils literal notranslate"><span class="pre">converse</
233237
</section>
234238
</section>
235239
<section id="notes-best-practices">
236-
<h2>💡 Notes &amp; Best Practices<a class="headerlink" href="#notes-best-practices" title="Permalink to this heading"></a></h2>
240+
<h2>💡 Notes &amp; Best Practices<a class="headerlink" href="#notes-best-practices" title="Link to this heading"></a></h2>
237241
<ul class="simple">
238242
<li><p>Prefer name-value argument style for clarity and forward compatibility.</p></li>
239243
<li><p>Maintain the conversation array by appending both user and assistant turns to preserve context.</p></li>
@@ -285,4 +289,4 @@ <h2>💡 Notes &amp; Best Practices<a class="headerlink" href="#notes-best-pract
285289
</script>
286290

287291
</body>
288-
</html>
292+
</html>

0 commit comments

Comments
 (0)