API REST Commentaires¶
Utilisez cette API pour recueillir les commentaires des utilisateurs finaux sur les Agents Cortex.
Recueillir des commentaires sur un Agent Cortex¶
POST /api/v2/databases/{database}/schemas/{schema}/agents/{name}:feedback
Crée un événement de commentaire pour une réponse d’Agent Cortex.
Requête¶
Paramètres de chemin¶
Paramètre |
Description |
|---|---|
|
(Obligatoire) Identificateur de la base de données à laquelle appartient la ressource. Vous pouvez utiliser la requête GET/api/v2/databases pour obtenir une liste des bases de données disponibles. |
|
(Obligatoire) Identificateur du schéma auquel appartient la ressource . Vous pouvez utiliser la requête GET/api/v2/databases/{database}/schemas pour obtenir une liste des schémas disponibles pour la base de données spécifiée. |
|
(Obligatoire) Identificateur de l’agent. |
En-têtes de requête¶
En-tête |
Description |
|---|---|
|
(Obligatoire) Jeton d’autorisation. Pour plus d’informations, voir Authentification. |
|
(Obligatoire) application/json |
Corps de requête¶
Le corps de la requête contient les détails du commentaire de la réponse de l’agent.
Champ |
Type |
Description |
|---|---|---|
|
string |
ID de la requête associé au commentaire. |
|
booléen |
Si la réponse a été bonne ( |
|
string |
Le texte du message de commentaire détaillé. |
|
array of strings |
Liste des catégories pour le commentaire. Chaque catégorie est une chaîne qui représente une catégorie spécifique de commentaires. |
|
entier |
ID du thread. |
Exemple de corps de requête¶
{
"categories": [
"Something worked well"
],
"feedback_message": "this is fantastic!",
"positive": true
}
Réponse¶
Une réponse réussie renvoie un message de confirmation.
En-têtes de réponse¶
En-tête |
Description |
|---|---|
|
ID unique de la requête API. |
Corps de réponse¶
{
"status": "Feedback submitted successfully"
}