a few more comments

mitodl · Dec 16, 2024 · e398438 · e398438
1 parent f81b7f7
commit e398438
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/src/components/AiChat/AiChat.mdx b/src/components/AiChat/AiChat.mdx
@@ -10,6 +10,8 @@ import { gitLink } from "../../story-utils"
 Exported from `smoot-design/ai`, the AiChat component is a chat interface
 for use with AI services. It can be used with text-streaming or JSON APIs.
 
+This demo shows the AiChat component with a simple text-streaming API.
+
 <Primary />
 
 ## Inputs

diff --git a/src/components/AiChat/AiChat.stories.tsx b/src/components/AiChat/AiChat.stories.tsx
@@ -73,6 +73,10 @@ type Story = StoryObj<typeof AiChat>
 
 export const StreamingResponses: Story = {}
 
+/**
+ * Here `AiChat` is used with a non-streaming JSON API. The JSON is converted
+ * to text via `parseContent`.
+ */
 export const JsonResponses: Story = {
   args: {
     requestOpts: { apiUrl: TEST_API_JSON },