Feedback

Feedbacks in Portkey provide a simple way to get weighted feedback from customers on any request you served, at any stage in your app.

You can capture this feedback on a generation or conversation level and analyze it based on custom tags by adding meta data to the relevant request.

POST /feedback

Create new feedback

This endpoint allows users to submit feedback for a particular interaction or response.

POSThttps://api.portkey.ai/v1/feedback

Authorization

apiKeyAuth

Body

application/json

trace_id*string

Unique identifier for the request trace.

value*integer

Feedback value, an integer between -10 and 10.

weightnumber (float)

Weight of the feedback, a float between 0 and 1. Default is 1.0.

metadataobject

Additional metadata for the feedback.

Response

200

Feedback successfully saved

Body

application/json

statusstring

success or failure

messagestring

Confirmation message indicating successful feedback submission.

feedback_idsarray of string

Ids of Feedbacks created returned in the same order as input

Request

JavaScriptCurl

const response = await fetch('https://api.portkey.ai/v1/feedback', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "trace_id": "REQUEST_TRACE_ID",
      "value": 1
    }),
});
const data = await response.json();

Response

{
  "status": "text",
  "message": "text",
  "feedback_ids": [
    "text"
  ]
}

The Feedback API allows you to gather weighted feedback from users on any generation or conversation at any stage within your app. By incorporating custom metadata, you can tag and analyze feedback more effectively.

SDK Usage

The feedback.create method in the Portkey SDK provides a way to capture user feedback programmatically.

Method Signature

NodeJS

portkey.feedback.create(feedbackParams);

Python

portkey.feedback.create(feedbackParams);

Parameters

• feedbackParams (Object): Parameters for the feedback request, including trace_id, value, weight, and metadata.

Example Usage

NodeJS

import Portkey from 'portkey-ai';

// Initialize the Portkey client
const portkey = new Portkey({
    apiKey: "PORTKEY_API_KEY"  // Replace with your Portkey API key
});

// Send feedback
const sendFeedback = async () => {
    await portkey.feedback.create({
        traceID: "REQUEST_TRACE_ID",
        value: 1  // For thumbs up
    });
}
await sendFeedback();

Python

from portkey import Portkey

# Initialize the Portkey client
portkey = Portkey(
    api_key="PORTKEY_API_KEY"  # Replace with your Portkey API key
)

# Send feedback
def send_feedback():
    portkey.feedback.create(
        'trace_id'= 'REQUEST_TRACE_ID',
        'value'= 0  # For thumbs down
    )

send_feedback()

PUT /feedback/{id}

Updates existing feedback

This endpoint allows users to update existing feedback .

PUThttps://api.portkey.ai/v1/feedback/{id}

Authorization

apiKeyAuth

Path parameters

id*string (uuid)

Feedback ID

Body

application/json

value*integer

Feedback value, an integer between -10 and 10.

weightnumber (float)

Weight of the feedback, a float between 0 and 1. Default is 1.0.

metadataobject

Additional metadata for the feedback.

Response

200

Feedback successfully updated

Body

application/json

statusstring

success or failure

messagestring

Confirmation message indicating successful feedback submission.

feedback_idsarray of string

Ids of Feedbacks created returned in the same order as input

Request

JavaScriptCurl

const response = await fetch('https://api.portkey.ai/v1/feedback/{id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "value": 1
    }),
});
const data = await response.json();

Response

{
  "status": "text",
  "message": "text",
  "feedback_ids": [
    "text"
  ]
}

The Update Feedback API allows you to update existing feedback details