POST
/
v4
/
evaluation-datasets
/
{evaluation_dataset_id}
/
autogenerated-draft-test-cases
import SGPClient from 'sgp';

const client = new SGPClient({
  apiKey: process.env['SGP_API_KEY'], // This is the default and can be omitted
});

async function main() {
  const autoGeneratedDraftTestCase = await client.evaluationDatasets.autogeneratedDraftTestCases.create(
    'evaluation_dataset_id',
    {
      account_id: 'account_id',
      approved: true,
      test_case_data: { artifact_ids_filter: ['string'], input: 'input' },
    },
  );

  console.log(autoGeneratedDraftTestCase.id);
}

main();
{
  "evaluation_dataset_id": "<string>",
  "schema_type": "GENERATION",
  "test_case_data": {
    "input": "<string>",
    "expected_output": "<string>",
    "expected_extra_info": {
      "schema_type": "CHUNKS",
      "chunks": [
        {
          "text": "<string>",
          "metadata": {}
        }
      ]
    },
    "artifact_ids_filter": [
      "<string>"
    ]
  },
  "approved": true,
  "topic_str": "<string>",
  "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>"
}

Authorizations

x-api-key
string
header
required

Headers

x-selected-account-id
string | null

Path Parameters

evaluation_dataset_id
string
required

Body

application/json
test_case_data
object
required

The data for the test case in a format matching the provided schema_type

approved
boolean
required

Boolean to track whether or not the draft test case is approved

account_id
string
required

The ID of the account that owns the given entity.

schema_type
enum<string>
default:
GENERATION
Available options:
GENERATION
topic_str
string

Response

200
application/json
Successful Response
evaluation_dataset_id
string
required

The ID of the associated evaluation dataset.

test_case_data
object
required

The data for the test case in a format matching the provided schema_type

approved
boolean
required

Boolean to track whether or not the draft test case is approved

content_metadata
object
required

Metadata for the chunks and artifacts that were used to generate this draft test case.

id
string
required

The unique identifier of the entity.

account_id
string
required

The ID of the account that owns the given entity.

created_at
string
required

The date and time when the entity was created in ISO format.

updated_at
string
required

The date and time when the entity was last updated in ISO format.

created_by_user_id
string
required

The user who originally created the entity.

schema_type
enum<string>
default:
GENERATION
Available options:
GENERATION
topic_str
string