From e398438eb16cf3ae1f767570cd827e8a557173ba Mon Sep 17 00:00:00 2001 From: Chris Chudzicki Date: Mon, 16 Dec 2024 14:05:29 -0500 Subject: [PATCH] a few more comments --- src/components/AiChat/AiChat.mdx | 2 ++ src/components/AiChat/AiChat.stories.tsx | 4 ++++ 2 files changed, 6 insertions(+) diff --git a/src/components/AiChat/AiChat.mdx b/src/components/AiChat/AiChat.mdx index 05e066c..b9cab15 100644 --- 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. + ## Inputs diff --git a/src/components/AiChat/AiChat.stories.tsx b/src/components/AiChat/AiChat.stories.tsx index 29fd2b5..f994526 100644 --- a/src/components/AiChat/AiChat.stories.tsx +++ b/src/components/AiChat/AiChat.stories.tsx @@ -73,6 +73,10 @@ type Story = StoryObj 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 },