Feedback REST API¶

Use essa API para coletar feedback sobre os Cortex Agents dos usuários finais.

Coleta de feedback sobre um Cortex Agent¶

POST /api/v2/databases/{database}/schemas/{schema}/agents/{name}:feedback

Cria um evento de feedback para uma resposta do Cortex Agent.

Solicitação¶

Parâmetros de caminho¶

Parâmetro	Descrição
`database`	(Obrigatório) Identificador do banco de dados ao qual o recurso pertence. Você pode usar a solicitação /api/v2/databases GET para obter uma lista de bancos de dados disponíveis.
`schema`	Identificador (obrigatório) do esquema ao qual o recurso pertence. É possível usar a solicitação /api/v2/databases/{database}/schemas GET para obter uma lista de esquemas disponíveis para o banco de dados especificado.
`name`	(Obrigatório) Identificador do agente.

Cabeçalhos de solicitação¶

Cabeçalho	Descrição
`Authorization`	Token de autorização (obrigatório). Para obter mais informações, consulte Autenticação.
`Content-Type`	Aplicativo/json (obrigatório)

Corpo da solicitação¶

O corpo da solicitação contém os detalhes do feedback para a resposta do agente.

Campo	Tipo	Descrição
`orig_request_id`	string	ID da solicitação para a mensagem associada ao feedback. Se esse valor não for definido, o feedback será registrado para o agente.
`positive`	booleano	Se a resposta foi boa (`true`) ou ruim (`false`).
`feedback_message`	string	O texto da mensagem de feedback detalhada.
`categories`	matriz de strings	Lista de categorias para o feedback. Cada categoria é uma string que representa uma categoria específica de feedback.
`thread_id`	inteiro	O ID da thread.

Example request body for agent-level feedback¶

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

Copy

Exemplo de corpo de solicitação para feedback no nível de solicitação¶

{
  "orig_request_id": "aa123456-789a-a1-2a34-a1a234a56789",
  "categories": [
    "Something worked well"
  ],
  "feedback_message": "this is fantastic!",
  "positive": true
}

Copy

Resposta¶

Uma resposta bem-sucedida retorna uma mensagem de confirmação.

Cabeçalhos de resposta¶

Cabeçalho	Descrição
`X-Snowflake-Request-ID`	ID único da solicitação da API.

Corpo da resposta¶

{
  "status": "Feedback submitted successfully"
}

Copy

View feedback for Cortex Agents¶

Para obter informações sobre os privilégios necessários e como consultar eventos de feedback (incluindo um SQL de exemplo), consulte Visualizar o feedback fornecido pelos usuários.