> ## Documentation Index
> Fetch the complete documentation index at: https://docs.orq.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Human Review Sets SDK Reference

> Manage human review sets with the Node.js and Python SDKs: create, list, retrieve, update, and delete review sets for LLM output annotation.

## Human Review Sets

### List Human Review Sets

Get all human review sets

<CodeGroup>
  ```python Python theme={"theme":{"light":"github-light","dark":"github-dark"}}
  from 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)

  ```

  ```typescript Node.js theme={"theme":{"light":"github-light","dark":"github-dark"}}
  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();
  ```
</CodeGroup>

<Expandable title="Parameters">
  <CodeGroup>
    ```python Python theme={"theme":{"light":"github-light","dark":"github-dark"}}
    {
        "project_id": Optional[str],
    }
    ```

    ```typescript Node.js theme={"theme":{"light":"github-light","dark":"github-dark"}}
    {
      projectId?: string;
    }
    ```
  </CodeGroup>
</Expandable>

### Create a Human Review Set

Create a human review set

<CodeGroup>
  ```python Python theme={"theme":{"light":"github-light","dark":"github-dark"}}
  from 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)

  ```

  ```typescript Node.js theme={"theme":{"light":"github-light","dark":"github-dark"}}
  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();

    console.log(result);
  }

  run();
  ```
</CodeGroup>

<Expandable title="Parameters">
  <CodeGroup>
    ```python Python theme={"theme":{"light":"github-light","dark":"github-dark"}}
    {
        "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
    }
    ```

    ```typescript Node.js theme={"theme":{"light":"github-light","dark":"github-dark"}}
    {
      displayName: string;  // required
      description?: string;
      humanEvalIds: string[];  // required
      projectId?: string;
      filterType: "span_type";  // required
      filterValues: string[];  // required
    }
    ```
  </CodeGroup>
</Expandable>

<Expandable title="Response">
  <CodeGroup>
    ```python Python theme={"theme":{"light":"github-light","dark":"github-dark"}}
    {
        "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],
    }
    ```

    ```typescript Node.js theme={"theme":{"light":"github-light","dark":"github-dark"}}
    {
      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[];
    }
    ```
  </CodeGroup>
</Expandable>

### Retrieve a Human Review Set

Get a human review set by ID

<CodeGroup>
  ```python Python theme={"theme":{"light":"github-light","dark":"github-dark"}}
  from 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)

  ```

  ```typescript Node.js theme={"theme":{"light":"github-light","dark":"github-dark"}}
  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();
  ```
</CodeGroup>

<Expandable title="Parameters">
  <CodeGroup>
    ```python Python theme={"theme":{"light":"github-light","dark":"github-dark"}}
    {
        "id": str,  # required
    }
    ```

    ```typescript Node.js theme={"theme":{"light":"github-light","dark":"github-dark"}}
    {
      id: string;  // required
    }
    ```
  </CodeGroup>
</Expandable>

<Expandable title="Response">
  <CodeGroup>
    ```python Python theme={"theme":{"light":"github-light","dark":"github-dark"}}
    {
        "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],
    }
    ```

    ```typescript Node.js theme={"theme":{"light":"github-light","dark":"github-dark"}}
    {
      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[];
    }
    ```
  </CodeGroup>
</Expandable>

### Update a Human Review Set

Update a human review set

<CodeGroup>
  ```python Python theme={"theme":{"light":"github-light","dark":"github-dark"}}
  from 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)

  ```

  ```typescript Node.js theme={"theme":{"light":"github-light","dark":"github-dark"}}
  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({
      id: "<id>",
    });

    console.log(result);
  }

  run();
  ```
</CodeGroup>

<Expandable title="Parameters">
  <CodeGroup>
    ```python Python theme={"theme":{"light":"github-light","dark":"github-dark"}}
    {
        "id": str,  # required
        "request_body": Union[PatchV2HumanEvalSetsIDRequestBody1, PatchV2HumanEvalSetsIDRequestBody2],  # optional
    }
    ```

    ```typescript Node.js theme={"theme":{"light":"github-light","dark":"github-dark"}}
    {
      id: string;  // required
      requestBody?: PatchV2HumanEvalSetsIdRequestBody1 | PatchV2HumanEvalSetsIdRequestBody2;
    }
    ```
  </CodeGroup>
</Expandable>

<Expandable title="Response">
  <CodeGroup>
    ```python Python theme={"theme":{"light":"github-light","dark":"github-dark"}}
    {
        "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],
    }
    ```

    ```typescript Node.js theme={"theme":{"light":"github-light","dark":"github-dark"}}
    {
      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[];
    }
    ```
  </CodeGroup>
</Expandable>

### Delete a Human Review Set

Delete a human review set

<CodeGroup>
  ```python Python theme={"theme":{"light":"github-light","dark":"github-dark"}}
  from 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 ...

  ```

  ```typescript Node.js theme={"theme":{"light":"github-light","dark":"github-dark"}}
  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();
  ```
</CodeGroup>

<Expandable title="Parameters">
  <CodeGroup>
    ```python Python theme={"theme":{"light":"github-light","dark":"github-dark"}}
    {
        "id": str,  # required
    }
    ```

    ```typescript Node.js theme={"theme":{"light":"github-light","dark":"github-dark"}}
    {
      id: string;  // required
    }
    ```
  </CodeGroup>
</Expandable>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.