Cette page explique comment fournir au mieux un contexte rédigé à vos agents de données de l'API Conversational Analytics en écrivant des prompts efficaces via des instructions système et, pour certaines sources de données, en fournissant également un contexte structuré. Bien que la fourniture d'un contexte créé soit facultative, un contexte créé bien structuré peut améliorer la justesse et la pertinence des réponses fournies par l'API.
Qu'est-ce que le contexte créé ?
Le contexte créé correspond aux consignes que les développeurs peuvent fournir pour façonner le comportement d'un agent de données et affiner les réponses de l'API. Ces instructions incluent des instructions système de forme libre et, pour certaines sources de données, des champs de contexte structurés contenant des informations telles que des descriptions de tables et des exemples de requêtes. Pour répondre aux questions, l'agent combine ce contexte créé avec les informations provenant de sources de données (telles que des tables BigQuery, des explorations Looker, Data Studio et des sources de données de base de données) et avec l'historique des conversations (pour les conversations multitours).
En fournissant des instructions claires via des champs contextuels structurés et des instructions système de forme libre, vous pouvez améliorer la capacité de l'agent à interpréter les questions des utilisateurs et à générer des réponses utiles et précises. Un contexte bien défini est particulièrement utile si vous vous connectez à des données telles que des tables BigQuery. Par exemple, vous pouvez utiliser le contexte créé pour fournir les types de consignes suivants à un agent :
- Logique spécifique à l'entreprise : définis comme "fidèle" un client qui a effectué plus de cinq achats au cours d'une période donnée.
- Mise en forme des réponses : résume toutes les réponses de l'agent de données en 20 mots ou moins pour faire gagner du temps aux utilisateurs.
- Présentation des données : mets en forme tous les nombres pour qu'ils correspondent au guide de style de l'entreprise.
Fournir un contexte rédigé
Les informations spécifiques que vous pouvez fournir dépendent de votre source de données. Pour les données BigQuery, les données Looker et les données de base de données, vous pouvez définir à la fois un contexte structuré et des instructions système. Pour de meilleurs résultats, fournissez d'abord du contexte à l'agent via les champs structurés disponibles. Vous pouvez ensuite fournir des conseils supplémentaires en définissant des instructions système.
Vous fournissez un contexte structuré dans les champs de l'API pour des détails tels que les descriptions de tables et les exemples de requêtes. Vous fournissez des instructions système sous la forme d'une chaîne au format YAML à l'aide du paramètre system_instruction.
Après avoir défini votre contexte créé, vous pouvez le fournir à l'API dans l'un des appels suivants :
- Créer un agent de données persistant : incluez le contexte créé dans l'objet
published_contextdu corps de la requête pour configurer un comportement d'agent qui persiste sur plusieurs conversations. Pour en savoir plus, consultez Créer un agent de données (HTTP) ou Configurer le contexte pour un chat avec ou sans état (SDK Python). - Envoyer une requête sans état : fournissez un contexte créé dans l'objet
inline_contextd'une requête de chat pour définir le comportement de l'agent pour cet appel d'API spécifique. Pour en savoir plus, consultez Créer une conversation multitours sans état (HTTP) ou Utiliser l'API pour poser des questions (SDK Python). - Envoyer une requête de données : pour les sources de données de base de données, fournissez l'ID de l'ensemble de contextes du contexte créé dans l'objet
agent_context_referencede la requête de données. Pour en savoir plus, consultez Définir le contexte de l'agent de données pour les sources de données de base de données.
Bonne pratique pour créer des agents : utiliser le contrôle des versions pour le contexte créé
Utilisez les champs stagingContext, publishedContext et lastPublishedContext pour contrôler les versions de contexte lors de la création d'agents avec l'API Conversational Analytics. Le cas d'utilisation suivant illustre comment utiliser ces champs pour créer une version de préproduction et une version en production du contexte de l'agent.
Supposons que vous utilisiez un agent existant avec le champ publishedContext, mais que vous deviez mettre à jour l'agent (par exemple, pour que tous les graphiques soient verts au lieu de bleus).
Pour apporter des modifications et les tester avant de les publier, procédez comme suit :
- Apportez les modifications à l'agent dans le champ
stagingContext, puis testez l'agent avec les modifications. - Lorsque les modifications sont prêtes, mettez à jour le champ
publishedContextavec les modifications destagingContext. - Si nécessaire, vous pouvez revenir à l'ancien agent en remplaçant
publishedContextparlastPublishedContext.
Ressources associées
- Créer un agent de données à l'aide de HTTP et Python
- Créer un agent de données à l'aide du SDK Python
- Définir le contexte de l'agent de données pour les sources de données BigQuery
- Définir le contexte de l'agent de données pour les sources de données Looker
- Définir le contexte de l'agent de données pour les sources de données de base de données