List Autogenerated Draft Test Cases

GET /v4/evaluation-datasets/{evaluation_dataset_id}/autogenerated-draft-test-cases

Python

Python

import os
from scale_gp import SGPClient

client = SGPClient(
    api_key=os.environ.get("SGP_API_KEY"),  # This is the default and can be omitted
)
page = client.evaluation_datasets.autogenerated_draft_test_cases.list(
    evaluation_dataset_id="evaluation_dataset_id",
)
page = page.items[0]
print(page.id)

200

{
  "items": [
    {
      "evaluation_dataset_id": "<string>",
      "test_case_data": {
        "input": "<string>",
        "artifact_ids_filter": [
          "<string>"
        ],
        "expected_output": "<string>",
        "expected_extra_info": {
          "chunks": [
            {
              "text": "<string>",
              "metadata": {}
            }
          ],
          "schema_type": "CHUNKS"
        }
      },
      "approved": true,
      "content_metadata": {},
      "id": "<string>",
      "account_id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "created_by_user_id": "<string>",
      "topic_str": "<string>",
      "missing_chunks": [
        {
          "chunk_text": "<string>",
          "artifact_id": "<string>",
          "artifact_name": "<string>",
          "artifact_content_modification_identifier": "<string>"
        }
      ]
    }
  ],
  "total_item_count": 123,
  "current_page": 123,
  "items_per_page": 123
}

Path Parameters

evaluation_dataset_id · string · required

Query Parameters

check_missing_chunks · boolean · default: false

Check if test cases are based on missing chunks

page · integer · default: 1

Page number for pagination to be returned by the given endpoint. Starts at page 1

Required range: x >= 1

limit · integer · default: 100

Maximum number of artifacts to be returned by the given endpoint. Defaults to 100 and cannot be greater than 10k.

Required range: 1 <= x <= 10000

Response

200

application/json

Successful Response

items · AutoGeneratedDraftTestCaseWithChunkInfoResponse · object[] · required

The data returned for the current page.

Show child attributes

total_item_count · integer · required

The total number of items of the query

current_page · integer · required

The current page number.

items_per_page · integer · required

The number of items per page.