HumanReviewSets
List HumanReviewSets
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)
Show Parameters
Show Parameters
{
"project_id": Optional[str],
}
Create a HumanReviewSet
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()
# Handle response
print(res)
Show Parameters
Show Parameters
{
"display_name": str, # required
"description": Optional[str],
"human_eval_ids": List[str], # required
"project_id": Optional[str],
"filter_type": Literal["span_type"], # required
"filter_values": List[str], # 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": date,
"updated": date,
"filter_type": Literal["span_type"],
"filter_values": List[str],
}
Retrieve a HumanReviewSet
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)
Show Parameters
Show Parameters
{
"id": str, # 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": date,
"updated": date,
"filter_type": Literal["span_type"],
"filter_values": List[str],
}
Update a HumanReviewSet
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>")
# Handle response
print(res)
Show Parameters
Show Parameters
{
"id": str, # required
"request_body": Union[PatchV2HumanEvalSetsIDRequestBody1, PatchV2HumanEvalSetsIDRequestBody2],
}
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": date,
"updated": date,
"filter_type": Literal["span_type"],
"filter_values": List[str],
}
Delete a HumanReviewSet
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 ...
Show Parameters
Show Parameters
{
"id": str, # required
}