Provide Message Feedback

POST/v0/copilots/provideMessageFeedbackProvide Message Feedback

Request body

application/json

object

agentIdstring · uuidrequired

Credal-generated Agent ID to specify which agent to route the request to.

messageFeedbackobjectrequired

Show child attributes

descriptiveFeedbackstring

feedbackstringrequired

one of "POSITIVE", "NEGATIVE"

suggestedAnswerstring

messageIdstring · uuidrequired

The message ID for which feedback is being provided.

userEmailstringrequired

The user profile you want to use when providing feedback.

Example request

{
  "agentId": "00000000-0000-0000-0000-000000000000",
  "messageFeedback": {
    "descriptiveFeedback": "string",
    "feedback": "NEGATIVE",
    "suggestedAnswer": "string"
  },
  "messageId": "00000000-0000-0000-0000-000000000000",
  "userEmail": "string"
}

Responses

Examples

curl -X POST 'https://api.credal.ai/api/v0/copilots/provideMessageFeedback' \
  -H 'Content-Type: application/json' \
  -d '{"agentId":"00000000-0000-0000-0000-000000000000","messageFeedback":{"descriptiveFeedback":"string","feedback":"NEGATIVE","suggestedAnswer":"string"},"messageId":"00000000-0000-0000-0000-000000000000","userEmail":"string"}'

const response = await fetch('https://api.credal.ai/api/v0/copilots/provideMessageFeedback', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"agentId":"00000000-0000-0000-0000-000000000000","messageFeedback":{"descriptiveFeedback":"string","feedback":"NEGATIVE","suggestedAnswer":"string"},"messageId":"00000000-0000-0000-0000-000000000000","userEmail":"string"}),
});
const data = await response.json();

const response = await fetch('https://api.credal.ai/api/v0/copilots/provideMessageFeedback', { method: 'POST', headers: { 'Content-Type': 'application/json' }, body: "{\"agentId\":\"00000000-0000-0000-0000-000000000000\",\"messageFeedback\":{\"descriptiveFeedback\":\"string\",\"feedback\":\"NEGATIVE\",\"suggestedAnswer\":\"string\"},\"messageId\":\"00000000-0000-0000-0000-000000000000\",\"userEmail\":\"string\"}" });
console.log(await response.json());

import requests

response = requests.request(
    "POST",
    "https://api.credal.ai/api/v0/copilots/provideMessageFeedback",
    headers={"Content-Type": "application/json"},
    data='{"agentId":"00000000-0000-0000-0000-000000000000","messageFeedback":{"descriptiveFeedback":"string","feedback":"NEGATIVE","suggestedAnswer":"string"},"messageId":"00000000-0000-0000-0000-000000000000","userEmail":"string"}',
)
print(response.json())

package main

import (
	"context"
	"net/http"
	"strings"
)

func main() {
	ctx := context.Background()
	body := strings.NewReader(`{"agentId":"00000000-0000-0000-0000-000000000000","messageFeedback":{"descriptiveFeedback":"string","feedback":"NEGATIVE","suggestedAnswer":"string"},"messageId":"00000000-0000-0000-0000-000000000000","userEmail":"string"}`)
	req, err := http.NewRequestWithContext(ctx, "POST", "https://api.credal.ai/api/v0/copilots/provideMessageFeedback", body)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
}

<?php
$request = curl_init("https://api.credal.ai/api/v0/copilots/provideMessageFeedback");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($request, CURLOPT_POSTFIELDS, "{\"agentId\":\"00000000-0000-0000-0000-000000000000\",\"messageFeedback\":{\"descriptiveFeedback\":\"string\",\"feedback\":\"NEGATIVE\",\"suggestedAnswer\":\"string\"},\"messageId\":\"00000000-0000-0000-0000-000000000000\",\"userEmail\":\"string\"}");
curl_setopt($request, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
$response = curl_exec($request);
curl_close($request);

var request = HttpRequest.newBuilder(URI.create("https://api.credal.ai/api/v0/copilots/provideMessageFeedback"))
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\"agentId\":\"00000000-0000-0000-0000-000000000000\",\"messageFeedback\":{\"descriptiveFeedback\":\"string\",\"feedback\":\"NEGATIVE\",\"suggestedAnswer\":\"string\"},\"messageId\":\"00000000-0000-0000-0000-000000000000\",\"userEmail\":\"string\"}"))
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("https://api.credal.ai/api/v0/copilots/provideMessageFeedback")
request = Net::HTTPGenericRequest.new("POST", true, true, uri)
request['Content-Type'] = 'application/json'
request.body = "{\"agentId\":\"00000000-0000-0000-0000-000000000000\",\"messageFeedback\":{\"descriptiveFeedback\":\"string\",\"feedback\":\"NEGATIVE\",\"suggestedAnswer\":\"string\"},\"messageId\":\"00000000-0000-0000-0000-000000000000\",\"userEmail\":\"string\"}"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Post, "https://api.credal.ai/api/v0/copilots/provideMessageFeedback");
request.Content = new StringContent("{\"agentId\":\"00000000-0000-0000-0000-000000000000\",\"messageFeedback\":{\"descriptiveFeedback\":\"string\",\"feedback\":\"NEGATIVE\",\"suggestedAnswer\":\"string\"},\"messageId\":\"00000000-0000-0000-0000-000000000000\",\"userEmail\":\"string\"}", Encoding.UTF8, "application/json");
using var response = await client.SendAsync(request);

(no response body — HTTP 200)

Search documentation

copilots

documentCatalog

documentCollections

search

users