Créer un message de l’Assistant (v1)
Obsolète
Le point de terminaison assistant message v1 est compatible avec AI SDK v4. Si vous utilisez AI SDK v5 ou une version ultérieure, utilisez plutôt le point de terminaison assistant message v2.
Le hook useChat du SDK AI de Vercel est la méthode recommandée pour intégrer l’API de l’Assistant à votre application.
Installer le SDK AI v4
npm i ai@^4.1.15Utiliser le hook
import { useChat } from 'ai/react';
function MyComponent({ domain }) {
const { messages, input, handleInputChange, handleSubmit, isLoading } = useChat({
api: `https://api.mintlify.com/discovery/v1/assistant/${domain}/message`,
headers: {
'Authorization': `Bearer ${process.env.PUBLIC_MINTLIFY_ASSISTANT_KEY}`,
},
body: {
fp: 'anonymous',
retrievalPageSize: 5,
context: [
{
type: 'code',
value: 'const example = "code snippet";',
elementId: 'code-block-1',
},
],
},
streamProtocol: 'data',
sendExtraMessageFields: true,
});
return (
<div>
{messages.map((message) => (
<div key={message.id}>
{message.role === 'user' ? 'Utilisateur : ' : 'Assistant : '}
{message.content}
</div>
))}
<form onSubmit={handleSubmit}>
<input value={input} onChange={handleInputChange} />
<button type="submit">Envoyer</button>
</form>
</div>
);
}Configuration requise pour Mintlify :
streamProtocol: 'data'- Requis pour les réponses en streaming.sendExtraMessageFields: true- Requis pour envoyer les métadonnées des messages.body.fp- Identifiant d’empreinte (utilisez ‘anonymous’ ou un identifiant utilisateur).body.retrievalPageSize- Nombre de résultats de recherche à utiliser (recommandé : 5).
Configuration optionnelle :
body.context- Tableau d’informations contextuelles à fournir à l’Assistant. Chaque objet de contexte contient :type- Soit'code'soit'textSelection'.value- L’extrait de code ou le texte sélectionné.elementId(optionnel) - Identifiant de l’élément d’interface contenant le contexte.
body.currentPath- Le chemin de la page actuellement consultée par l’utilisateur. Lorsqu’il est fourni, l’Assistant utilise ce contexte pour donner des réponses plus pertinentes. Longueur maximale : 200 caractères.
Consultez useChat dans la documentation du SDK AI pour en savoir plus.
L’API de l’Assistant applique les limites suivantes :
- 10 000 requêtes par organisation Mintlify et par heure
- 10 000 requêtes par adresse IP et par jour
Was this page helpful?Suggest editsRaise issue