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 |
|---|---|
|
(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. |
|
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. |
|
(Obrigatório) Identificador do agente. |
Cabeçalhos de solicitação¶
Cabeçalho |
Descrição |
|---|---|
|
Token de autorização (obrigatório). Para obter mais informações, consulte Autenticação. |
|
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 |
|---|---|---|
|
string |
ID da solicitação associado ao feedback. |
|
booleano |
Se a resposta foi boa ( |
|
string |
O texto da mensagem de feedback detalhada. |
|
matriz de strings |
Lista de categorias para o feedback. Cada categoria é uma string que representa uma categoria específica de feedback. |
|
inteiro |
O ID da thread. |
Exemplo de corpo de solicitação¶
{
"categories": [
"Something worked well"
],
"feedback_message": "this is fantastic!",
"positive": true
}
Resposta¶
Uma resposta bem-sucedida retorna uma mensagem de confirmação.
Cabeçalhos de resposta¶
Cabeçalho |
Descrição |
|---|---|
|
ID único da solicitação da API. |
Corpo da resposta¶
{
"status": "Feedback submitted successfully"
}