Feedback
Remove a Feedback Evaluation [deprecated]
from orq_ai_sdk import Orq
import os
with Orq(
api_key=os.getenv("ORQ_API_KEY", ""),
) as orq:
orq.feedback.remove_evaluation(request={"id": "<id>", "trace_id": "<trace_id>"})
# Use the SDK ...
import { Orq } from "@orq-ai/node";
const orq = new Orq({
apiKey: process.env["ORQ_API_KEY"] ?? "",
});
async function run() {
await orq.feedback.removeEvaluation({
id: "<id>",
traceId: "<trace_id>",
});
}
run();
Show Parameters
Show Parameters
{
"id": str, # required
"trace_id": str, # required
}
{
id: string; // required
traceId: string; // required
}
Create a Feedback Evaluation [deprecated]
from orq_ai_sdk import Orq
import os
with Orq(
api_key=os.getenv("ORQ_API_KEY", ""),
) as orq:
orq.feedback.create_evaluation(request={"id": "<id>", "evaluation_type": "human_review", "type": "string", "value": "good", "trace_id": "<trace_id>"})
# Use the SDK ...
import { Orq } from "@orq-ai/node";
const orq = new Orq({
apiKey: process.env["ORQ_API_KEY"] ?? "",
});
async function run() {
await orq.feedback.createEvaluation({
id: "<id>",
evaluationType: "human_review",
type: "string",
value: "good",
traceId: "<trace_id>",
});
}
run();
Show Parameters
Show Parameters
{
# one of: RequestBody1, RequestBody2, RequestBody3, RequestBody4
"id": str, # required
"evaluation_type": Literal["human_review"], # required
"human_review_id": Optional[str],
"source": Optional[Literal["orq", "external"]],
"explanation": Optional[str],
"reviewed_at": str, # optional
"type": Union[Union[Union[Literal["string"], Literal["number"]], Literal["boolean"]], Literal["string_array"]], # required
"value": Union[Union[str, float], bool], # required (variant-specific)
"trace_id": str, # required
"values": List[str], # required (variant-specific)
}
{
// one of: RequestBody1, RequestBody2, RequestBody3, RequestBody4
id: string; // required
evaluationType: "human_review"; // required
humanReviewId?: string;
source?: "orq" | "external";
explanation?: string;
reviewedAt?: Date;
type: "string" | "number" | "boolean" | "string_array"; // required
value: string | number | boolean; // required (variant-specific)
traceId: string; // required
values: string[]; // required (variant-specific)
}
Create Feedback
from orq_ai_sdk import Orq
import os
with Orq(
api_key=os.getenv("ORQ_API_KEY", ""),
) as orq:
res = orq.feedback.create(request={"field": "accuracy", "value": "good", "trace_id": "<trace_id>"})
# Handle response
print(res)
import { Orq } from "@orq-ai/node";
const orq = new Orq({
apiKey: process.env["ORQ_API_KEY"] ?? "",
});
async function run() {
const result = await orq.feedback.create({
field: "accuracy",
value: "good",
traceId: "<trace_id>",
});
console.log(result);
}
run();
Show Parameters
Show Parameters
{
"id": Optional[str],
"field": str, # required
"value": Union[str, float, List[str]], # required
"trace_id": str, # required
"product": Optional[Literal["remoteconfigs", "deployments", "experiments", "playgrounds", "spreadsheets", "spreadsheet_run", "llm_evaluator", "knowledge", "router", "workflows", "external_events", "agents", "memory-stores", "generic", "evaluators", "otel", "ai-chat", "mcp_gateway"]],
}
{
id?: string;
field: string; // required
value: string | number | string[]; // required
traceId: string; // required
product?: "remoteconfigs" | "deployments" | "experiments" | "playgrounds" | "spreadsheets" | "spreadsheet_run" | "llm_evaluator" | "knowledge" | "router" | "workflows" | "external_events" | "agents" | "memory-stores" | "generic" | "evaluators" | "otel" | "ai-chat" | "mcp_gateway";
}
Show Response
Show Response
{
"id": Optional[str],
"property": str,
"value": Union[str, float, List[str]],
"trace_id": str,
"product": Optional[Literal["remoteconfigs", "deployments", "experiments", "playgrounds", "spreadsheets", "spreadsheet_run", "llm_evaluator", "knowledge", "router", "workflows", "external_events", "agents", "memory-stores", "generic", "evaluators", "otel", "ai-chat", "mcp_gateway"]],
}
{
id?: string;
property: string;
value: string | number | string[];
traceId: string;
product?: "remoteconfigs" | "deployments" | "experiments" | "playgrounds" | "spreadsheets" | "spreadsheet_run" | "llm_evaluator" | "knowledge" | "router" | "workflows" | "external_events" | "agents" | "memory-stores" | "generic" | "evaluators" | "otel" | "ai-chat" | "mcp_gateway";
}
Remove Feedback
from orq_ai_sdk import Orq
import os
with Orq(
api_key=os.getenv("ORQ_API_KEY", ""),
) as orq:
res = orq.feedback.remove(request={"id": "<id>", "trace_id": "<trace_id>", "product": "deployments"})
# Handle response
print(res)
import { Orq } from "@orq-ai/node";
const orq = new Orq({
apiKey: process.env["ORQ_API_KEY"] ?? "",
});
async function run() {
const result = await orq.feedback.remove({
id: "<id>",
traceId: "<trace_id>",
product: "deployments",
});
console.log(result);
}
run();
Show Parameters
Show Parameters
{
"id": str, # required
"trace_id": str, # required
"product": Literal["remoteconfigs", "deployments", "experiments", "playgrounds", "spreadsheets", "spreadsheet_run", "llm_evaluator", "knowledge", "router", "workflows", "external_events", "agents", "memory-stores", "generic", "evaluators", "otel", "ai-chat", "mcp_gateway"], # required
}
{
id: string; // required
traceId: string; // required
product: "remoteconfigs" | "deployments" | "experiments" | "playgrounds" | "spreadsheets" | "spreadsheet_run" | "llm_evaluator" | "knowledge" | "router" | "workflows" | "external_events" | "agents" | "memory-stores" | "generic" | "evaluators" | "otel" | "ai-chat" | "mcp_gateway"; // required
}
Show Response
Show Response
{
"id": str,
"trace_id": str,
"product": Literal["remoteconfigs", "deployments", "experiments", "playgrounds", "spreadsheets", "spreadsheet_run", "llm_evaluator", "knowledge", "router", "workflows", "external_events", "agents", "memory-stores", "generic", "evaluators", "otel", "ai-chat", "mcp_gateway"],
}
{
id: string;
traceId: string;
product: "remoteconfigs" | "deployments" | "experiments" | "playgrounds" | "spreadsheets" | "spreadsheet_run" | "llm_evaluator" | "knowledge" | "router" | "workflows" | "external_events" | "agents" | "memory-stores" | "generic" | "evaluators" | "otel" | "ai-chat" | "mcp_gateway";
}
Submit a Feedback
Report problems or request features for Orq.ai APIs, MCP tools, SDKs, and documentation.from orq_ai_sdk import Orq
import os
with Orq(
api_key=os.getenv("ORQ_API_KEY", ""),
) as orq:
res = orq.feedback.submit(message="<value>", category="<value>")
# Handle response
print(res)
import { Orq } from "@orq-ai/node";
const orq = new Orq({
apiKey: process.env["ORQ_API_KEY"] ?? "",
});
async function run() {
const result = await orq.feedback.submit({
message: "<value>",
category: "<value>",
});
console.log(result);
}
run();
Show Parameters
Show Parameters
{
"message": str, # required
"category": str, # required
"request_id": Optional[str],
"url": Optional[str],
}
{
message: string; // required
category: string; // required
requestId?: string;
url?: string;
}
Show Response
Show Response
{
"feedback_id": str,
}
{
feedbackId: string;
}