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

database

(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.

schema

(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.

name

(Obligatoire) Identificateur de l’agent.

En-têtes de requête

En-tête

Description

Authorization

(Obligatoire) Jeton d’autorisation. Pour plus d’informations, voir Authentification.

Content-Type

(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

request_id

string

ID de la requête associé au commentaire.

positive

booléen

Si la réponse a été bonne (true) ou mauvaise (false).

feedback_message

string

Le texte du message de commentaire détaillé.

categories

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.

thread_id

entier

ID du thread.

Exemple de corps de requête

{
  "categories": [
    "Something worked well"
  ],
  "feedback_message": "this is fantastic!",
  "positive": true
}
Copy

Réponse

Une réponse réussie renvoie un message de confirmation.

En-têtes de réponse

En-tête

Description

X-Snowflake-Request-ID

ID unique de la requête API.

Corps de réponse

{
  "status": "Feedback submitted successfully"
}
Copy