Create Surface Feedback

CreateSurfaceFeedback submits feedback for a surface with a snapshot.

POST /api/v1/a2ui/surfaces/{surface_id}/feedback

CreateSurfaceFeedback

Go

package main

import(
	"context"
	"github.com/conductorone/conductorone-sdk-go/pkg/models/shared"
	conductoronesdkgo "github.com/conductorone/conductorone-sdk-go"
	"github.com/conductorone/conductorone-sdk-go/pkg/models/operations"
	"log"
)

func main() {
    ctx := context.Background()

    s := conductoronesdkgo.New(
        conductoronesdkgo.WithSecurity(shared.Security{
            BearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
            Oauth: "<YOUR_OAUTH_HERE>",
        }),
    )

    res, err := s.A2UI.CreateSurfaceFeedback(ctx, operations.C1APIA2uiV1A2UIServiceCreateSurfaceFeedbackRequest{
        SurfaceID: "<id>",
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.A2UIServiceCreateSurfaceFeedbackResponse != nil {
        // handle response
    }
}

import { ConductoroneSDKTypescript } from "conductorone-sdk-typescript";

const conductoroneSDKTypescript = new ConductoroneSDKTypescript({
  security: {
    bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
    oauth: "<YOUR_OAUTH_HERE>",
  },
});

async function run() {
  const result = await conductoroneSDKTypescript.a2Ui.createSurfaceFeedback({
    surfaceId: "<id>",
  });

  console.log(result);
}

run();

curl --request POST \
  --url https://{tenantDomain}.conductor.one/api/v1/a2ui/surfaces/{surface_id}/feedback \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "conversationId": "<string>",
  "text": "<string>"
}
'

import requests

url = "https://{tenantDomain}.conductor.one/api/v1/a2ui/surfaces/{surface_id}/feedback"

payload = {
    "conversationId": "<string>",
    "text": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({conversationId: '<string>', text: '<string>'})
};

fetch('https://{tenantDomain}.conductor.one/api/v1/a2ui/surfaces/{surface_id}/feedback', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenantDomain}.conductor.one/api/v1/a2ui/surfaces/{surface_id}/feedback",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'conversationId' => '<string>',
    'text' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

HttpResponse<String> response = Unirest.post("https://{tenantDomain}.conductor.one/api/v1/a2ui/surfaces/{surface_id}/feedback")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"conversationId\": \"<string>\",\n  \"text\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenantDomain}.conductor.one/api/v1/a2ui/surfaces/{surface_id}/feedback")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"conversationId\": \"<string>\",\n  \"text\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

200

{
  "feedback": {
    "actionName": "<string>",
    "componentsSnapshot": "<string>",
    "conversationId": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "dataModelSnapshot": "<string>",
    "id": "<string>",
    "schemaVersion": "<string>",
    "surfaceId": "<string>",
    "text": "<string>"
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Authorization · string · header · required

This API uses OAuth2 with the Client Credential flow. Client Credentials must be sent in the BODY, not the headers. For an example of how to implement this, refer to the c1TokenSource.Token() function.

Path Parameters

surface_id · string · required

The surfaceId field.

Body

application/json

A2UIServiceCreateSurfaceFeedbackRequest creates feedback for a surface.

conversationId · string | null

The conversationId field.

sentiment · enum<string> | null

The sentiment field.

Available options: A2UI_SURFACE_FEEDBACK_SENTIMENT_UNSPECIFIED, A2UI_SURFACE_FEEDBACK_SENTIMENT_POSITIVE, A2UI_SURFACE_FEEDBACK_SENTIMENT_NEGATIVE

text · string | null

The text field.

Response

200 - application/json

A2UIServiceCreateSurfaceFeedbackResponse returns the created feedback.

A2UIServiceCreateSurfaceFeedbackResponse returns the created feedback.

feedback · A 2 Ui Surface Feedback · object | null

A2UISurfaceFeedback represents user feedback for a surface.

Show child attributes