Skip to content

Commit

Permalink
deploy: 635fabc
Browse files Browse the repository at this point in the history
  • Loading branch information
@jackmpcollins
jackmpcollins committed Jan 6, 2025
1 parent e963b68 commit 3b54a9f
Show file tree
Hide file tree
Showing 6 changed files with 117 additions and 55 deletions.
4 changes: 2 additions & 2 deletions chat-prompting/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -890,7 +890,7 @@ <h3 id="escape_braces">escape_braces<a class="headerlink" href="#escape_braces"
<span class="c1"># &#39;Curly braces {example} will be filled in!&#39;</span>
</code></pre></div>
<h2 id="placeholder">Placeholder<a class="headerlink" href="#placeholder" title="Permanent link">&para;</a></h2>
<p>The <code>Placeholder</code> class enables templating of <code>AssistantMessage</code> content within the <code>@chatprompt</code> decorator. This allows dynamic changing of the messages used to prompt the model based on the arguments provided when the function is called.</p>
<p>The <code>Placeholder</code> class enables templating of message content within the <code>@chatprompt</code> decorator. This allows dynamic changing of the messages used to prompt the model based on the arguments provided when the function is called.</p>
<div class="language-python highlight"><pre><span></span><code><span class="kn">from</span> <span class="nn">magentic</span> <span class="kn">import</span> <span class="n">chatprompt</span><span class="p">,</span> <span class="n">AssistantMessage</span><span class="p">,</span> <span class="n">Placeholder</span><span class="p">,</span> <span class="n">UserMessage</span>
<span class="kn">from</span> <span class="nn">pydantic</span> <span class="kn">import</span> <span class="n">BaseModel</span>

Expand All @@ -914,7 +914,7 @@ <h2 id="placeholder">Placeholder<a class="headerlink" href="#placeholder" title=
<span class="p">)</span>
<span class="c1"># Quote(quote=&#39;The Force will be with you, always.&#39;, character=&#39;Obi-Wan Kenobi&#39;)</span>
</code></pre></div>
<p><code>Placeholder</code> can also be utilized in the <code>format</code> method of custom <code>Message</code> subclasses to provide an explicit way of inserting values from the function arguments. For example, see <code>UserImageMessage</code> in (TODO: link to GPT-vision page).</p>
<p><code>Placeholder</code> can also be used in <code>UserMessage</code> to allow inserting <code>ImageBytes</code>, <code>ImageUrl</code>, or other content blocks from function arguments. For more information see <a href="../vision/">Vision</a>.</p>
<h2 id="functioncall">FunctionCall<a class="headerlink" href="#functioncall" title="Permanent link">&para;</a></h2>
<p>The content of an <code>AssistantMessage</code> can be a <code>FunctionCall</code>. This can be used to demonstrate to the LLM when/how it should call a function.</p>
<div class="language-python highlight"><pre><span></span><code><span class="kn">from</span> <span class="nn">magentic</span> <span class="kn">import</span> <span class="p">(</span>
Expand Down
22 changes: 14 additions & 8 deletions examples/vision_renaming_screenshots/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1322,26 +1322,32 @@ <h1 id="renaming-screenshots-with-gpt-vision">Renaming Screenshots with GPT Visi
</div>
<div class="highlight-ipynb hl-python"><pre><span></span><span class="c1"># Create a prompt-function to return details given an image</span>

<span class="kn">from</span> <span class="nn">magentic</span> <span class="kn">import</span> <span class="n">OpenaiChatModel</span><span class="p">,</span> <span class="n">Placeholder</span><span class="p">,</span> <span class="n">UserMessage</span><span class="p">,</span> <span class="n">chatprompt</span>
<span class="kn">from</span> <span class="nn">magentic.vision</span> <span class="kn">import</span> <span class="n">UserImageMessage</span>
<span class="kn">from</span> <span class="nn">magentic</span> <span class="kn">import</span> <span class="n">ImageBytes</span><span class="p">,</span> <span class="n">OpenaiChatModel</span><span class="p">,</span> <span class="n">Placeholder</span><span class="p">,</span> <span class="n">UserMessage</span><span class="p">,</span> <span class="n">chatprompt</span>


<span class="nd">@chatprompt</span><span class="p">(</span>
<span class="n">UserMessage</span><span class="p">(</span><span class="s2">"Describe the screenshot, then provide a suitable file name."</span><span class="p">),</span>
<span class="n">UserImageMessage</span><span class="p">(</span><span class="n">Placeholder</span><span class="p">(</span><span class="nb">bytes</span><span class="p">,</span> <span class="s2">"image"</span><span class="p">)),</span>
<span class="n">UserMessage</span><span class="p">(</span>
<span class="p">[</span>
<span class="s2">"Describe the screenshot, then provide a suitable file name."</span><span class="p">,</span>
<span class="n">Placeholder</span><span class="p">(</span><span class="n">ImageBytes</span><span class="p">,</span> <span class="s2">"image"</span><span class="p">),</span>
<span class="p">]</span>
<span class="p">),</span>
<span class="n">model</span><span class="o">=</span><span class="n">OpenaiChatModel</span><span class="p">(</span><span class="s2">"gpt-4-turbo"</span><span class="p">),</span>
<span class="p">)</span>
<span class="k">def</span> <span class="nf">describe_image</span><span class="p">(</span><span class="n">image</span><span class="p">:</span> <span class="nb">bytes</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">ScreenshotDetails</span><span class="p">:</span> <span class="o">...</span>
</pre></div>
<div class="clipboard-copy-txt" id="cell-4"># Create a prompt-function to return details given an image

from magentic import OpenaiChatModel, Placeholder, UserMessage, chatprompt
from magentic.vision import UserImageMessage
from magentic import ImageBytes, OpenaiChatModel, Placeholder, UserMessage, chatprompt


@chatprompt(
UserMessage("Describe the screenshot, then provide a suitable file name."),
UserImageMessage(Placeholder(bytes, "image")),
UserMessage(
[
"Describe the screenshot, then provide a suitable file name.",
Placeholder(ImageBytes, "image"),
]
),
model=OpenaiChatModel("gpt-4-turbo"),
)
def describe_image(image: bytes) -&gt; ScreenshotDetails: ...</div>
Expand Down
2 changes: 1 addition & 1 deletion search/search_index.json
View file

Large diffs are not rendered by default.

32 changes: 16 additions & 16 deletions sitemap.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,66 +2,66 @@
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
<url>
<loc>https://magentic.dev/</loc>
<lastmod>2024-12-01</lastmod>
<lastmod>2025-01-06</lastmod>
</url>
<url>
<loc>https://magentic.dev/asyncio/</loc>
<lastmod>2024-12-01</lastmod>
<lastmod>2025-01-06</lastmod>
</url>
<url>
<loc>https://magentic.dev/chat-prompting/</loc>
<lastmod>2024-12-01</lastmod>
<lastmod>2025-01-06</lastmod>
</url>
<url>
<loc>https://magentic.dev/configuration/</loc>
<lastmod>2024-12-01</lastmod>
<lastmod>2025-01-06</lastmod>
</url>
<url>
<loc>https://magentic.dev/formatting/</loc>
<lastmod>2024-12-01</lastmod>
<lastmod>2025-01-06</lastmod>
</url>
<url>
<loc>https://magentic.dev/function-calling/</loc>
<lastmod>2024-12-01</lastmod>
<lastmod>2025-01-06</lastmod>
</url>
<url>
<loc>https://magentic.dev/logging-and-tracing/</loc>
<lastmod>2024-12-01</lastmod>
<lastmod>2025-01-06</lastmod>
</url>
<url>
<loc>https://magentic.dev/retrying/</loc>
<lastmod>2024-12-01</lastmod>
<lastmod>2025-01-06</lastmod>
</url>
<url>
<loc>https://magentic.dev/streaming/</loc>
<lastmod>2024-12-01</lastmod>
<lastmod>2025-01-06</lastmod>
</url>
<url>
<loc>https://magentic.dev/structured-outputs/</loc>
<lastmod>2024-12-01</lastmod>
<lastmod>2025-01-06</lastmod>
</url>
<url>
<loc>https://magentic.dev/type-checking/</loc>
<lastmod>2024-12-01</lastmod>
<lastmod>2025-01-06</lastmod>
</url>
<url>
<loc>https://magentic.dev/vision/</loc>
<lastmod>2024-12-01</lastmod>
<lastmod>2025-01-06</lastmod>
</url>
<url>
<loc>https://magentic.dev/examples/chain_of_verification/</loc>
<lastmod>2024-12-01</lastmod>
<lastmod>2025-01-06</lastmod>
</url>
<url>
<loc>https://magentic.dev/examples/rag_github/</loc>
<lastmod>2024-12-01</lastmod>
<lastmod>2025-01-06</lastmod>
</url>
<url>
<loc>https://magentic.dev/examples/registering_custom_type/</loc>
<lastmod>2024-12-01</lastmod>
<lastmod>2025-01-06</lastmod>
</url>
<url>
<loc>https://magentic.dev/examples/vision_renaming_screenshots/</loc>
<lastmod>2024-12-01</lastmod>
<lastmod>2025-01-06</lastmod>
</url>
</urlset>
Binary file modified sitemap.xml.gz
View file
Binary file not shown.
Loading

0 comments on commit 3b54a9f

Please sign in to comment.