Deprecated: Human Review Sets are replaced by project-level Annotations and will be removed in release 4.18.
Human Review Sets
List Human Review Sets [deprecated]
Get all human review setsfrom orq_ai_sdk import Orq
import os
with Orq(
api_key=os.getenv("ORQ_API_KEY", ""),
) as orq:
res = orq.human_review_sets.list()
# 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.humanReviewSets.list();
console.log(result);
}
run();
Show Parameters
Show Parameters
{
"project_id": Optional[str],
}
{
projectId?: string;
}
Create a Human Review Set [deprecated]
Create a human review setfrom orq_ai_sdk import Orq
import os
with Orq(
api_key=os.getenv("ORQ_API_KEY", ""),
) as orq:
res = orq.human_review_sets.create(request={"display_name": "<value>", "human_eval_ids": ["<value>"], "filter_type": "span_type", "filter_values": ["<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.humanReviewSets.create({
displayName: "<value>",
humanEvalIds: ["<value>"],
filterType: "span_type",
filterValues: ["<value>"],
});
console.log(result);
}
run();
Show Parameters
Show Parameters
{
# one of: PostV2HumanEvalSetsRequestBody1, PostV2HumanEvalSetsRequestBody2
"display_name": str, # required
"description": Optional[str],
"human_eval_ids": List[str], # required
"project_id": Optional[str],
"filter_type": Union[Literal["span_type"], Literal["name"]], # required
"filter_values": List[str], # required (variant-specific)
"filter_value": str, # required (variant-specific)
}
{
// one of: PostV2HumanEvalSetsRequestBody1, PostV2HumanEvalSetsRequestBody2
displayName: string; // required
description?: string;
humanEvalIds: string[]; // required
projectId?: string;
filterType: "span_type" | "name"; // required
filterValues: string[]; // required (variant-specific)
filterValue: string; // required (variant-specific)
}
Show Response
Show Response
{
"id": str,
"display_name": str,
"description": Optional[str],
"human_eval_ids": List[str],
"workspace_id": str,
"project_id": Optional[str],
"created_by_id": Optional[str],
"updated_by_id": Optional[str],
"created": str, # optional
"updated": str, # optional
"filter_type": Literal["span_type"],
"filter_values": List[str],
}
{
id: string;
displayName: string;
description?: string;
humanEvalIds: string[];
workspaceId: string;
projectId?: string;
createdById?: string;
updatedById?: string;
created?: Date;
updated?: Date;
filterType: "span_type";
filterValues: string[];
}
Retrieve a Human Review Set [deprecated]
Get a human review set by IDfrom orq_ai_sdk import Orq
import os
with Orq(
api_key=os.getenv("ORQ_API_KEY", ""),
) as orq:
res = orq.human_review_sets.get(id="<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.humanReviewSets.get({
id: "<id>",
});
console.log(result);
}
run();
Show Parameters
Show Parameters
{
"id": str, # required
}
{
id: string; // required
}
Show Response
Show Response
{
"id": str,
"display_name": str,
"description": Optional[str],
"human_eval_ids": List[str],
"workspace_id": str,
"project_id": Optional[str],
"created_by_id": Optional[str],
"updated_by_id": Optional[str],
"created": str, # optional
"updated": str, # optional
"filter_type": Literal["span_type"],
"filter_values": List[str],
}
{
id: string;
displayName: string;
description?: string;
humanEvalIds: string[];
workspaceId: string;
projectId?: string;
createdById?: string;
updatedById?: string;
created?: Date;
updated?: Date;
filterType: "span_type";
filterValues: string[];
}
Update a Human Review Set [deprecated]
Update a human review setfrom orq_ai_sdk import Orq
import os
with Orq(
api_key=os.getenv("ORQ_API_KEY", ""),
) as orq:
res = orq.human_review_sets.update(id="<id>", request_body={"display_name": "<value>", "human_eval_ids": ["<value>"], "filter_type": "span_type", "filter_values": ["<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.humanReviewSets.update({
requestBody: {
displayName: "<value>",
humanEvalIds: ["<value>"],
filterType: "span_type",
filterValues: ["<value>"],
},
id: "<id>",
});
console.log(result);
}
run();
Show Parameters
Show Parameters
{
"id": str, # required
"request_body": { # optional
# one of: PatchV2HumanEvalSetsIDRequestBody1, PatchV2HumanEvalSetsIDRequestBody2
"display_name": str, # required
"description": Optional[str],
"human_eval_ids": List[str], # required
"project_id": Optional[str],
"filter_type": Union[Literal["span_type"], Literal["name"]], # required
"filter_values": List[str], # required (variant-specific)
"filter_value": str, # required (variant-specific)
},
}
{
id: string; // required
requestBody?: {
// one of: PatchV2HumanEvalSetsIdRequestBody1, PatchV2HumanEvalSetsIdRequestBody2
displayName: string; // required
description?: string;
humanEvalIds: string[]; // required
projectId?: string;
filterType: "span_type" | "name"; // required
filterValues: string[]; // required (variant-specific)
filterValue: string; // required (variant-specific)
};
}
Show Response
Show Response
{
"id": str,
"display_name": str,
"description": Optional[str],
"human_eval_ids": List[str],
"workspace_id": str,
"project_id": Optional[str],
"created_by_id": Optional[str],
"updated_by_id": Optional[str],
"created": str, # optional
"updated": str, # optional
"filter_type": Literal["span_type"],
"filter_values": List[str],
}
{
id: string;
displayName: string;
description?: string;
humanEvalIds: string[];
workspaceId: string;
projectId?: string;
createdById?: string;
updatedById?: string;
created?: Date;
updated?: Date;
filterType: "span_type";
filterValues: string[];
}
Delete a Human Review Set [deprecated]
Delete a human review setfrom orq_ai_sdk import Orq
import os
with Orq(
api_key=os.getenv("ORQ_API_KEY", ""),
) as orq:
orq.human_review_sets.delete(id="<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.humanReviewSets.delete({
id: "<id>",
});
}
run();
Show Parameters
Show Parameters
{
"id": str, # required
}
{
id: string; // required
}