Assistant message

Generates a response message from the assistant for the specified domain.

​

与 useChat 集成

将 AI 助手 API 集成到你的应用中的推荐方式是使用 Vercel 的 AI SDK 提供的 useChat 钩子。

Mintlify AI 助手 API 与 AI SDK v4 兼容。如果你使用 AI SDK v5 或更高版本，则必须配置自定义传输方式。

1. 安装 AI SDK v4

   npm i ai@^4.1.15
   
2. 使用该钩子

   import { useChat } from 'ai/react';
   
   function MyComponent({ domain }) {
     const { messages, input, handleInputChange, handleSubmit, isLoading } = useChat({
       api: `https://api-dsc.mintlify.com/v1/assistant/${domain}/message`,
       headers: {
         'Authorization': `Bearer ${process.env.MINTLIFY_TOKEN}`,
       },
       body: {
         fp: 'anonymous',
         retrievalPageSize: 5,
       },
       streamProtocol: 'data',
       sendExtraMessageFields: true,
     });
   
     return (
       <div>
         {messages.map((message) => (
           <div key={message.id}>
             {message.role === 'user' ? 'User: ' : 'Assistant: '}
             {message.content}
           </div>
         ))}
         <form onSubmit={handleSubmit}>
           <input value={input} onChange={handleInputChange} />
           <button type="submit">Send</button>
         </form>
       </div>
     );
   }
   

   Mintlify 的必备配置：

   • streamProtocol: 'data' - 流式响应所必需。
   • sendExtraMessageFields: true - 发送消息 metadata 所必需。
   • body.fp - 指纹标识符（使用 'anonymous' 或某个用户标识符）。
   • body.retrievalPageSize - 要使用的搜索结果数量（推荐：5）。

在 AI SDK 文档中查看 useChat 以了解更多详情。

​

速率限制

AI 助手 API 的限制如下：

• 每个 key 每月最多使用 10,000 次
• 每个 Mintlify 组织每小时最多 10,000 次请求
• 每个 IP 每日最多 10,000 次请求