Skip to content

Commit

Permalink
Built site for gh-pages
Browse files Browse the repository at this point in the history
  • Loading branch information
Quarto GHA Workflow Runner committed Dec 3, 2024
1 parent 24cca76 commit e40558d
Show file tree
Hide file tree
Showing 48 changed files with 4,379 additions and 1,300 deletions.
2 changes: 1 addition & 1 deletion .nojekyll
Original file line number Diff line number Diff line change
@@ -1 +1 @@
091cea7e
bae661c0
4 changes: 2 additions & 2 deletions get-started.html
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@
</li>
<li>
<a class="dropdown-item" href="./web-apps.html">
<span class="dropdown-text">Web applications</span></a>
<span class="dropdown-text">Build a chatbot</span></a>
</li>
</ul>
</li>
Expand Down Expand Up @@ -205,7 +205,7 @@ <h2 class="anchored" data-anchor-id="example-uses">Example uses</h2>
<p>Now that you’ve got the basic vocab under your belt, I’m going to just fire a bunch of interesting potential use cases at you. For many of these examples there are often special purpose tools that will be faster and cheaper. But using an LLM allows you to rapidly prototype an idea on a small subset of the full problem to determine if it’s worth investing more time and effort.</p>
<section id="chatbots" class="level3">
<h3 class="anchored" data-anchor-id="chatbots">Chatbots</h3>
<p>Great place to start is building a chatbot with a custom prompt. Chatbots are familiar interface and easy to create via <a href="./web-apps.html">web application</a> framework like Shiny or Streamlit.</p>
<p>Great place to start is <a href="./web-apps.html">building a chatbot</a> with a custom prompt. Chatbots are familiar interface and easy to create via web application framework like Shiny or Streamlit.</p>
<p>You could create a chat bot to answer questions on a specific topic by filling the prompt with related content. For example, maybe you want to help people use your new package. The default prompt won’t work because LLMs don’t know anything about your package. You can get surprisingly far by preloading the prompt with your README and other vignettes. This is how the <a href="https://github.com/jcheng5/elmer-assistant">elmer assistant</a> works.</p>
<p>An even more complicated chat bot is <a href="https://shiny.posit.co/blog/posts/shiny-assistant/">shiny assistant</a> which helps you build shiny apps (either in Python or R). It combines a <a href="https://github.com/posit-dev/shiny-assistant/blob/main/shinyapp/app_prompt.md">prompt</a> that gives general advice with a language specific prompt for <a href="https://github.com/posit-dev/shiny-assistant/blob/main/shinyapp/app_prompt_python.md">Python</a> or <a href="https://github.com/posit-dev/shiny-assistant/blob/main/shinyapp/app_prompt_r.md">R</a>. The python prompt is very detailed because there’s much less information about Shiny for Python on the internet because it’s a much newer package.</p>
<p>Another direction is to give the chat bot additional context about your current environment. For example, <a href="https://github.com/cpsievert/aidea">aidea</a> allows the user to interactively explore a dataset with the help of the LLM. It adds summary statistics about the dataset to the <a href="https://github.com/cpsievert/aidea/blob/main/inst/app/prompt.md">prompt</a> so that the LLM has context about the dataset. If you were working on a chatbot to help the user read in data, you could imagine include all the files in the current directory along with their first few lines.</p>
Expand Down
55 changes: 25 additions & 30 deletions index.html

Large diffs are not rendered by default.

4 changes: 4 additions & 0 deletions objects.txt
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,10 @@ chatlas.content_image_plot py:function 1 reference/content_image_plot.html#chatl
chatlas._content_image.content_image_plot py:function 1 reference/content_image_plot.html#chatlas.content_image_plot chatlas.content_image_plot
chatlas.content_image_url py:function 1 reference/content_image_url.html#chatlas.content_image_url -
chatlas._content_image.content_image_url py:function 1 reference/content_image_url.html#chatlas.content_image_url chatlas.content_image_url
chatlas.interpolate py:function 1 reference/interpolate.html#chatlas.interpolate -
chatlas._interpolate.interpolate py:function 1 reference/interpolate.html#chatlas.interpolate chatlas.interpolate
chatlas.interpolate_file py:function 1 reference/interpolate_file.html#chatlas.interpolate_file -
chatlas._interpolate.interpolate_file py:function 1 reference/interpolate_file.html#chatlas.interpolate_file chatlas.interpolate_file
chatlas.Tool py:class 1 reference/Tool.html#chatlas.Tool -
chatlas._tools.Tool py:class 1 reference/Tool.html#chatlas.Tool chatlas.Tool
chatlas.Turn py:class 1 reference/Turn.html#chatlas.Turn -
Expand Down
559 changes: 344 additions & 215 deletions prompt-design.html

Large diffs are not rendered by default.

51 changes: 37 additions & 14 deletions reference/Chat.html
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@
</li>
<li>
<a class="dropdown-item" href="../web-apps.html">
<span class="dropdown-text">Web applications</span></a>
<span class="dropdown-text">Build a chatbot</span></a>
</li>
</ul>
</li>
Expand Down Expand Up @@ -306,82 +306,105 @@
<li class="sidebar-item sidebar-item-section">
<div class="sidebar-item-container">
<a class="sidebar-item-text sidebar-link text-start" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-4" role="navigation" aria-expanded="true">
<span class="menu-text">Tool calling</span></a>
<span class="menu-text">Prompt interpolation</span></a>
<a class="sidebar-item-toggle text-start" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-4" role="navigation" aria-expanded="true" aria-label="Toggle section">
<i class="bi bi-chevron-right ms-2"></i>
</a>
</div>
<ul id="quarto-sidebar-section-4" class="collapse list-unstyled sidebar-section depth1 show">
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../reference/Tool.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Tool</span></a>
<a href="../reference/interpolate.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">interpolate</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../reference/interpolate_file.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">interpolate_file</span></a>
</div>
</li>
</ul>
</li>
<li class="sidebar-item sidebar-item-section">
<div class="sidebar-item-container">
<a class="sidebar-item-text sidebar-link text-start" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-5" role="navigation" aria-expanded="true">
<span class="menu-text">Turns</span></a>
<span class="menu-text">Tool calling</span></a>
<a class="sidebar-item-toggle text-start" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-5" role="navigation" aria-expanded="true" aria-label="Toggle section">
<i class="bi bi-chevron-right ms-2"></i>
</a>
</div>
<ul id="quarto-sidebar-section-5" class="collapse list-unstyled sidebar-section depth1 show">
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../reference/Turn.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Turn</span></a>
<a href="../reference/Tool.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Tool</span></a>
</div>
</li>
</ul>
</li>
<li class="sidebar-item sidebar-item-section">
<div class="sidebar-item-container">
<a class="sidebar-item-text sidebar-link text-start" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-6" role="navigation" aria-expanded="true">
<span class="menu-text">Query token usage</span></a>
<span class="menu-text">Turns</span></a>
<a class="sidebar-item-toggle text-start" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-6" role="navigation" aria-expanded="true" aria-label="Toggle section">
<i class="bi bi-chevron-right ms-2"></i>
</a>
</div>
<ul id="quarto-sidebar-section-6" class="collapse list-unstyled sidebar-section depth1 show">
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../reference/token_usage.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">token_usage</span></a>
<a href="../reference/Turn.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Turn</span></a>
</div>
</li>
</ul>
</li>
<li class="sidebar-item sidebar-item-section">
<div class="sidebar-item-container">
<a class="sidebar-item-text sidebar-link text-start" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-7" role="navigation" aria-expanded="true">
<span class="menu-text">Implement a model provider</span></a>
<span class="menu-text">Query token usage</span></a>
<a class="sidebar-item-toggle text-start" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-7" role="navigation" aria-expanded="true" aria-label="Toggle section">
<i class="bi bi-chevron-right ms-2"></i>
</a>
</div>
<ul id="quarto-sidebar-section-7" class="collapse list-unstyled sidebar-section depth1 show">
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../reference/Provider.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Provider</span></a>
<a href="../reference/token_usage.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">token_usage</span></a>
</div>
</li>
</ul>
</li>
<li class="sidebar-item sidebar-item-section">
<div class="sidebar-item-container">
<a class="sidebar-item-text sidebar-link text-start" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-8" role="navigation" aria-expanded="true">
<span class="menu-text">User-facing types</span></a>
<span class="menu-text">Implement a model provider</span></a>
<a class="sidebar-item-toggle text-start" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-8" role="navigation" aria-expanded="true" aria-label="Toggle section">
<i class="bi bi-chevron-right ms-2"></i>
</a>
</div>
<ul id="quarto-sidebar-section-8" class="collapse list-unstyled sidebar-section depth1 show">
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../reference/Provider.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Provider</span></a>
</div>
</li>
</ul>
</li>
<li class="sidebar-item sidebar-item-section">
<div class="sidebar-item-container">
<a class="sidebar-item-text sidebar-link text-start" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-9" role="navigation" aria-expanded="true">
<span class="menu-text">User-facing types</span></a>
<a class="sidebar-item-toggle text-start" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-9" role="navigation" aria-expanded="true" aria-label="Toggle section">
<i class="bi bi-chevron-right ms-2"></i>
</a>
</div>
<ul id="quarto-sidebar-section-9" class="collapse list-unstyled sidebar-section depth1 show">
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../reference/types.Content.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">types.Content</span></a>
</div>
Expand Down
51 changes: 37 additions & 14 deletions reference/ChatAnthropic.html
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@
</li>
<li>
<a class="dropdown-item" href="../web-apps.html">
<span class="dropdown-text">Web applications</span></a>
<span class="dropdown-text">Build a chatbot</span></a>
</li>
</ul>
</li>
Expand Down Expand Up @@ -306,82 +306,105 @@
<li class="sidebar-item sidebar-item-section">
<div class="sidebar-item-container">
<a class="sidebar-item-text sidebar-link text-start" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-4" role="navigation" aria-expanded="true">
<span class="menu-text">Tool calling</span></a>
<span class="menu-text">Prompt interpolation</span></a>
<a class="sidebar-item-toggle text-start" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-4" role="navigation" aria-expanded="true" aria-label="Toggle section">
<i class="bi bi-chevron-right ms-2"></i>
</a>
</div>
<ul id="quarto-sidebar-section-4" class="collapse list-unstyled sidebar-section depth1 show">
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../reference/Tool.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Tool</span></a>
<a href="../reference/interpolate.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">interpolate</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../reference/interpolate_file.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">interpolate_file</span></a>
</div>
</li>
</ul>
</li>
<li class="sidebar-item sidebar-item-section">
<div class="sidebar-item-container">
<a class="sidebar-item-text sidebar-link text-start" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-5" role="navigation" aria-expanded="true">
<span class="menu-text">Turns</span></a>
<span class="menu-text">Tool calling</span></a>
<a class="sidebar-item-toggle text-start" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-5" role="navigation" aria-expanded="true" aria-label="Toggle section">
<i class="bi bi-chevron-right ms-2"></i>
</a>
</div>
<ul id="quarto-sidebar-section-5" class="collapse list-unstyled sidebar-section depth1 show">
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../reference/Turn.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Turn</span></a>
<a href="../reference/Tool.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Tool</span></a>
</div>
</li>
</ul>
</li>
<li class="sidebar-item sidebar-item-section">
<div class="sidebar-item-container">
<a class="sidebar-item-text sidebar-link text-start" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-6" role="navigation" aria-expanded="true">
<span class="menu-text">Query token usage</span></a>
<span class="menu-text">Turns</span></a>
<a class="sidebar-item-toggle text-start" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-6" role="navigation" aria-expanded="true" aria-label="Toggle section">
<i class="bi bi-chevron-right ms-2"></i>
</a>
</div>
<ul id="quarto-sidebar-section-6" class="collapse list-unstyled sidebar-section depth1 show">
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../reference/token_usage.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">token_usage</span></a>
<a href="../reference/Turn.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Turn</span></a>
</div>
</li>
</ul>
</li>
<li class="sidebar-item sidebar-item-section">
<div class="sidebar-item-container">
<a class="sidebar-item-text sidebar-link text-start" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-7" role="navigation" aria-expanded="true">
<span class="menu-text">Implement a model provider</span></a>
<span class="menu-text">Query token usage</span></a>
<a class="sidebar-item-toggle text-start" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-7" role="navigation" aria-expanded="true" aria-label="Toggle section">
<i class="bi bi-chevron-right ms-2"></i>
</a>
</div>
<ul id="quarto-sidebar-section-7" class="collapse list-unstyled sidebar-section depth1 show">
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../reference/Provider.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Provider</span></a>
<a href="../reference/token_usage.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">token_usage</span></a>
</div>
</li>
</ul>
</li>
<li class="sidebar-item sidebar-item-section">
<div class="sidebar-item-container">
<a class="sidebar-item-text sidebar-link text-start" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-8" role="navigation" aria-expanded="true">
<span class="menu-text">User-facing types</span></a>
<span class="menu-text">Implement a model provider</span></a>
<a class="sidebar-item-toggle text-start" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-8" role="navigation" aria-expanded="true" aria-label="Toggle section">
<i class="bi bi-chevron-right ms-2"></i>
</a>
</div>
<ul id="quarto-sidebar-section-8" class="collapse list-unstyled sidebar-section depth1 show">
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../reference/Provider.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Provider</span></a>
</div>
</li>
</ul>
</li>
<li class="sidebar-item sidebar-item-section">
<div class="sidebar-item-container">
<a class="sidebar-item-text sidebar-link text-start" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-9" role="navigation" aria-expanded="true">
<span class="menu-text">User-facing types</span></a>
<a class="sidebar-item-toggle text-start" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-9" role="navigation" aria-expanded="true" aria-label="Toggle section">
<i class="bi bi-chevron-right ms-2"></i>
</a>
</div>
<ul id="quarto-sidebar-section-9" class="collapse list-unstyled sidebar-section depth1 show">
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../reference/types.Content.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">types.Content</span></a>
</div>
Expand Down
Loading

0 comments on commit e40558d

Please sign in to comment.