scorecard-ai 0.5.4 → 0.6.0

package/reference.md

@@ -1,1568 +1,1685 @@
-## Testset
+# Reference
 
-<details><summary> <code>scorecard.testset.<a href="./src/api/resources/testset/client/Client.ts">get</a>(testsetId) -> Scorecard.Testset</code> </summary>
+## Testset
 
+<details><summary><code>client.testset.<a href="/src/api/resources/testset/client/Client.ts">get</a>(testsetId) -> Scorecard.Testset</code></summary>
 <dl>
-
 <dd>
 
 #### 📝 Description
 
 <dl>
-
 <dd>
 
 <dl>
-
 <dd>
 
 Retrieve Testset metadata without Testcase data
 
 </dd>
-
 </dl>
-
 </dd>
-
 </dl>
 
 #### 🔌 Usage
 
 <dl>
-
 <dd>
 
 <dl>
-
 <dd>
 
-```ts
-await scorecard.testset.get(1);
+```typescript
+await client.testset.get(1);
 ```
 
 </dd>
-
 </dl>
-
 </dd>
-
 </dl>
 
 #### ⚙️ Parameters
 
 <dl>
-
 <dd>
 
 <dl>
-
 <dd>
 
-**testsetId: `number`** — The ID of the Testset to retrieve.
+**testsetId:** `number` — The ID of the Testset to retrieve.
 
 </dd>
-
 </dl>
 
 <dl>
-
 <dd>
 
-**requestOptions: `Testset.RequestOptions`**
+**requestOptions:** `Testset.RequestOptions`
 
 </dd>
-
 </dl>
-
 </dd>
-
 </dl>
 
 </dd>
-
 </dl>
 </details>
 
-<details><summary> <code>scorecard.testset.<a href="./src/api/resources/testset/client/Client.ts">delete</a>(testsetId) -> Scorecard.Testset</code> </summary>
-
+<details><summary><code>client.testset.<a href="/src/api/resources/testset/client/Client.ts">delete</a>(testsetId) -> Scorecard.Testset</code></summary>
 <dl>
-
 <dd>
 
 #### 📝 Description
 
 <dl>
-
 <dd>
 
 <dl>
-
 <dd>
 
 Delete a Testset
 
 </dd>
-
 </dl>
-
 </dd>
-
 </dl>
 
 #### 🔌 Usage
 
 <dl>
-
 <dd>
 
 <dl>
-
 <dd>
 
-```ts
-await scorecard.testset.delete(1);
+```typescript
+await client.testset.delete(1);
 ```
 
 </dd>
-
 </dl>
-
 </dd>
-
 </dl>
 
 #### ⚙️ Parameters
 
 <dl>
-
 <dd>
 
 <dl>
-
 <dd>
 
-**testsetId: `number`** — The ID of the Testset to delete.
+**testsetId:** `number` — The ID of the Testset to delete.
 
 </dd>
-
 </dl>
 
 <dl>
-
 <dd>
 
-**requestOptions: `Testset.RequestOptions`**
+**requestOptions:** `Testset.RequestOptions`
 
 </dd>
-
 </dl>
-
 </dd>
-
 </dl>
 
 </dd>
-
 </dl>
 </details>
 
-<details><summary> <code>scorecard.testset.<a href="./src/api/resources/testset/client/Client.ts">create</a>({ ...params }) -> Scorecard.Testset</code> </summary>
-
+<details><summary><code>client.testset.<a href="/src/api/resources/testset/client/Client.ts">update</a>(testsetId, { ...params }) -> Scorecard.Testset</code></summary>
 <dl>
-
 <dd>
 
 #### 📝 Description
 
 <dl>
-
 <dd>
 
 <dl>
-
 <dd>
 
-Create a new Testset
+Update a Testset.
 
 </dd>
-
 </dl>
-
 </dd>
-
 </dl>
 
 #### 🔌 Usage
 
 <dl>
-
 <dd>
 
 <dl>
-
 <dd>
 
-```ts
-await scorecard.testset.create({
-    name: "name",
-});
+```typescript
+await client.testset.update(1);
 ```
 
 </dd>
-
 </dl>
-
 </dd>
-
 </dl>
 
 #### ⚙️ Parameters
 
 <dl>
-
 <dd>
 
 <dl>
-
 <dd>
 
-**request: `Scorecard.TestsetCreateParams`**
+**testsetId:** `number` — The ID of the Testset to update.
 
 </dd>
-
 </dl>
 
 <dl>
-
 <dd>
 
-**requestOptions: `Testset.RequestOptions`**
+**request:** `Scorecard.TestsetUpdateParams`
 
 </dd>
-
 </dl>
 
-</dd>
+<dl>
+<dd>
 
-</dl>
+**requestOptions:** `Testset.RequestOptions`
 
 </dd>
+</dl>
+</dd>
+</dl>
 
+</dd>
 </dl>
 </details>
 
-<details><summary> <code>scorecard.testset.<a href="./src/api/resources/testset/client/Client.ts">readSchema</a>(testsetId) -> Scorecard.CustomSchema</code> </summary>
-
+<details><summary><code>client.testset.<a href="/src/api/resources/testset/client/Client.ts">create</a>({ ...params }) -> Scorecard.Testset</code></summary>
 <dl>
-
 <dd>
 
 #### 📝 Description
 
 <dl>
-
 <dd>
 
 <dl>
-
 <dd>
 
-Read the schema of a Testset
+Create a new Testset
 
 </dd>
-
 </dl>
-
 </dd>
-
 </dl>
 
 #### 🔌 Usage
 
 <dl>
-
 <dd>
 
 <dl>
-
 <dd>
 
-```ts
-await scorecard.testset.readSchema(1);
+```typescript
+await client.testset.create({
+    name: "name",
+});
 ```
 
 </dd>
-
 </dl>
-
 </dd>
-
 </dl>
 
 #### ⚙️ Parameters
 
 <dl>
-
 <dd>
 
 <dl>
-
 <dd>
 
-**testsetId: `number`** — The ID of the Testset to retrieve the schema from.
+**request:** `Scorecard.TestsetCreateParams`
 
 </dd>
-
 </dl>
 
 <dl>
-
 <dd>
 
-**requestOptions: `Testset.RequestOptions`**
+**requestOptions:** `Testset.RequestOptions`
 
 </dd>
-
 </dl>
-
 </dd>
-
 </dl>
 
 </dd>
-
 </dl>
 </details>
 
-<details><summary> <code>scorecard.testset.<a href="./src/api/resources/testset/client/Client.ts">getTestcases</a>(testsetId, { ...params }) -> Scorecard.PaginatedTestcaseResponse</code> </summary>
-
+<details><summary><code>client.testset.<a href="/src/api/resources/testset/client/Client.ts">readSchema</a>(testsetId) -> Scorecard.CustomSchema</code></summary>
 <dl>
-
 <dd>
 
 #### 📝 Description
 
 <dl>
-
 <dd>
 
 <dl>
-
 <dd>
 
-Retrieve all Testcases from a Testset
+Read the schema of a Testset
 
 </dd>
-
 </dl>
-
 </dd>
-
 </dl>
 
 #### 🔌 Usage
 
 <dl>
-
 <dd>
 
 <dl>
-
 <dd>
 
-```ts
-await scorecard.testset.getTestcases(1);
+```typescript
+await client.testset.readSchema(1);
 ```
 
 </dd>
-
 </dl>
-
 </dd>
-
 </dl>
 
 #### ⚙️ Parameters
 
 <dl>
-
-<dd>
-
-<dl>
-
 <dd>
 
-**testsetId: `number`** — The Testset ID to retrieve testcases from.
-
-</dd>
-
-</dl>
-
 <dl>
-
 <dd>
 
-**request: `Scorecard.TestsetGetTestcasesRequest`**
+**testsetId:** `number` — The ID of the Testset to retrieve the schema from.
 
 </dd>
-
 </dl>
 
 <dl>
-
 <dd>
 
-**requestOptions: `Testset.RequestOptions`**
+**requestOptions:** `Testset.RequestOptions`
 
 </dd>
-
 </dl>
-
 </dd>
-
 </dl>
 
 </dd>
-
 </dl>
 </details>
 
-## Testcase
-
-<details><summary> <code>scorecard.testcase.<a href="./src/api/resources/testcase/client/Client.ts">create</a>(testsetId, { ...params }) -> Scorecard.TestCase</code> </summary>
-
+<details><summary><code>client.testset.<a href="/src/api/resources/testset/client/Client.ts">getTestcases</a>(testsetId, { ...params }) -> Scorecard.PaginatedTestcaseResponse</code></summary>
 <dl>
-
 <dd>
 
 #### 📝 Description
 
 <dl>
-
 <dd>
 
 <dl>
-
 <dd>
 
-Create a new Testcase
+Retrieve all Testcases from a Testset
 
 </dd>
-
 </dl>
-
 </dd>
-
 </dl>
 
 #### 🔌 Usage
 
 <dl>
-
 <dd>
 
 <dl>
-
 <dd>
 
-```ts
-await scorecard.testcase.create(1);
+```typescript
+await client.testset.getTestcases(1);
 ```
 
 </dd>
-
 </dl>
-
 </dd>
-
 </dl>
 
 #### ⚙️ Parameters
 
 <dl>
-
 <dd>
 
 <dl>
-
 <dd>
 
-**testsetId: `number`** — The ID of the Testset to create the Testcase in.
+**testsetId:** `number` — The Testset ID to retrieve testcases from.
 
 </dd>
-
 </dl>
 
 <dl>
-
 <dd>
 
-**request: `Scorecard.TestcaseCreateParams`**
+**request:** `Scorecard.TestsetGetTestcasesRequest`
 
 </dd>
-
 </dl>
 
 <dl>
-
 <dd>
 
-**requestOptions: `Testcase.RequestOptions`**
+**requestOptions:** `Testset.RequestOptions`
 
 </dd>
-
 </dl>
-
 </dd>
-
 </dl>
 
 </dd>
-
 </dl>
 </details>
 
-<details><summary> <code>scorecard.testcase.<a href="./src/api/resources/testcase/client/Client.ts">get</a>(testcaseId, testsetId) -> Scorecard.TestCase</code> </summary>
+## Testcase
 
+<details><summary><code>client.testcase.<a href="/src/api/resources/testcase/client/Client.ts">create</a>(testsetId, { ...params }) -> Scorecard.TestCase</code></summary>
 <dl>
-
 <dd>
 
 #### 📝 Description
 
 <dl>
-
 <dd>
 
 <dl>
-
 <dd>
 
-Retrieve Testcase data
+Create a new Testcase
 
 </dd>
-
 </dl>
-
 </dd>
-
 </dl>
 
 #### 🔌 Usage
 
 <dl>
-
 <dd>
 
 <dl>
-
 <dd>
 
-```ts
-await scorecard.testcase.get(1, 1);
+```typescript
+await client.testcase.create(1);
 ```
 
 </dd>
-
 </dl>
-
 </dd>
-
 </dl>
 
 #### ⚙️ Parameters
 
 <dl>
-
 <dd>
 
 <dl>
-
 <dd>
 
-**testcaseId: `number`** — The ID of the Testcase to retrieve.
+**testsetId:** `number` — The ID of the Testset to create the Testcase in.
 
 </dd>
-
 </dl>
 
 <dl>
-
 <dd>
 
-**testsetId: `number`** — The ID of the Testset to retrieve the Testcase from.
+**request:** `Scorecard.TestcaseCreateParams`
 
 </dd>
-
 </dl>
 
 <dl>
-
 <dd>
 
-**requestOptions: `Testcase.RequestOptions`**
+**requestOptions:** `Testcase.RequestOptions`
 
 </dd>
-
 </dl>
-
 </dd>
-
 </dl>
 
 </dd>
-
 </dl>
 </details>
 
-<details><summary> <code>scorecard.testcase.<a href="./src/api/resources/testcase/client/Client.ts">delete</a>(testcaseId, testsetId) -> Scorecard.TestcaseDeletionResponse</code> </summary>
-
+<details><summary><code>client.testcase.<a href="/src/api/resources/testcase/client/Client.ts">get</a>(testcaseId, testsetId) -> Scorecard.TestCase</code></summary>
 <dl>
-
 <dd>
 
 #### 📝 Description
 
 <dl>
-
 <dd>
 
 <dl>
-
 <dd>
 
-Delete a Testcase
+Retrieve Testcase data
 
 </dd>
-
 </dl>
-
 </dd>
-
 </dl>
 
 #### 🔌 Usage
 
 <dl>
-
 <dd>
 
 <dl>
-
 <dd>
 
-```ts
-await scorecard.testcase.delete(1, 1);
+```typescript
+await client.testcase.get(1, 1);
 ```
 
 </dd>
-
 </dl>
-
 </dd>
-
 </dl>
 
 #### ⚙️ Parameters
 
 <dl>
-
 <dd>
 
 <dl>
-
 <dd>
 
-**testcaseId: `number`** — The ID of the Testcase to delete.
+**testcaseId:** `number` — The ID of the Testcase to retrieve.
 
 </dd>
-
 </dl>
 
 <dl>
-
 <dd>
 
-**testsetId: `number`** — The ID of the Testset to delete the Testcase from.
+**testsetId:** `number` — The ID of the Testset to retrieve the Testcase from.
 
 </dd>
-
 </dl>
 
 <dl>
-
 <dd>
 
-**requestOptions: `Testcase.RequestOptions`**
+**requestOptions:** `Testcase.RequestOptions`
 
 </dd>
-
 </dl>
-
 </dd>
-
 </dl>
 
 </dd>
-
 </dl>
 </details>
 
-## Testrecord
-
-<details><summary> <code>scorecard.testrecord.<a href="./src/api/resources/testrecord/client/Client.ts">get</a>(testrecordId, runId) -> Scorecard.Testrecord</code> </summary>
-
+<details><summary><code>client.testcase.<a href="/src/api/resources/testcase/client/Client.ts">delete</a>(testcaseId, testsetId) -> Scorecard.TestcaseDeletionResponse</code></summary>
 <dl>
-
 <dd>
 
 #### 📝 Description
 
 <dl>
-
 <dd>
 
 <dl>
-
 <dd>
 
-Retrieve Testrecord metadata
+Delete a Testcase
 
 </dd>
-
 </dl>
-
 </dd>
-
 </dl>
 
 #### 🔌 Usage
 
 <dl>
-
 <dd>
 
 <dl>
-
 <dd>
 
-```ts
-await scorecard.testrecord.get(1, 1);
+```typescript
+await client.testcase.delete(1, 1);
 ```
 
 </dd>
-
 </dl>
-
 </dd>
-
 </dl>
 
 #### ⚙️ Parameters
 
 <dl>
-
 <dd>
 
 <dl>
-
 <dd>
 
-**testrecordId: `number`**
+**testcaseId:** `number` — The ID of the Testcase to delete.
 
 </dd>
-
 </dl>
 
 <dl>
-
 <dd>
 
-**runId: `number`**
+**testsetId:** `number` — The ID of the Testset to delete the Testcase from.
 
 </dd>
-
 </dl>
 
 <dl>
-
 <dd>
 
-**requestOptions: `Testrecord.RequestOptions`**
+**requestOptions:** `Testcase.RequestOptions`
 
 </dd>
-
 </dl>
-
 </dd>
-
 </dl>
 
 </dd>
-
 </dl>
 </details>
 
-<details><summary> <code>scorecard.testrecord.<a href="./src/api/resources/testrecord/client/Client.ts">create</a>(runId, { ...params }) -> Scorecard.Testrecord</code> </summary>
-
+<details><summary><code>client.testcase.<a href="/src/api/resources/testcase/client/Client.ts">update</a>(testcaseId, testsetId, { ...params }) -> Scorecard.TestCase</code></summary>
 <dl>
-
 <dd>
 
 #### 📝 Description
 
 <dl>
-
 <dd>
 
 <dl>
-
 <dd>
 
-Create a new Testrecord
+Update a Testcase.
 
 </dd>
-
 </dl>
-
 </dd>
-
 </dl>
 
 #### 🔌 Usage
 
 <dl>
-
 <dd>
 
 <dl>
-
 <dd>
 
-```ts
-await scorecard.testrecord.create(1);
+```typescript
+await client.testcase.update(1, 1);
 ```
 
 </dd>
-
 </dl>
-
 </dd>
-
 </dl>
 
 #### ⚙️ Parameters
 
 <dl>
-
 <dd>
 
 <dl>
-
 <dd>
 
-**runId: `number`** — The ID of the Run to create the Testrecord in.
+**testcaseId:** `number` — The ID of the Testcase to update.
 
 </dd>
-
 </dl>
 
 <dl>
-
 <dd>
 
-**request: `Scorecard.TestrecordCreateParams`**
+**testsetId:** `number` — The ID of the Testset to retrieve the Testcase from.
 
 </dd>
-
 </dl>
 
 <dl>
-
 <dd>
 
-**requestOptions: `Testrecord.RequestOptions`**
+**request:** `Scorecard.TestcaseUpdateParams`
 
 </dd>
-
 </dl>
 
-</dd>
+<dl>
+<dd>
 
-</dl>
+**requestOptions:** `Testcase.RequestOptions`
 
 </dd>
+</dl>
+</dd>
+</dl>
 
+</dd>
 </dl>
 </details>
 
-## Run
-
-<details><summary> <code>scorecard.run.<a href="./src/api/resources/run/client/Client.ts">create</a>({ ...params }) -> Scorecard.Run</code> </summary>
-
+<details><summary><code>client.testcase.<a href="/src/api/resources/testcase/client/Client.ts">batchCopy</a>(testsetId, { ...params }) -> Scorecard.TestCase</code></summary>
 <dl>
-
 <dd>
 
 #### 📝 Description
 
 <dl>
-
 <dd>
 
 <dl>
-
 <dd>
 
-Create a new Run
+Batch copy Testcases
 
 </dd>
-
 </dl>
-
 </dd>
-
 </dl>
 
 #### 🔌 Usage
 
 <dl>
-
 <dd>
 
 <dl>
-
 <dd>
 
-```ts
-await scorecard.run.create();
+```typescript
+await client.testcase.batchCopy(1);
 ```
 
 </dd>
-
 </dl>
-
 </dd>
-
 </dl>
 
 #### ⚙️ Parameters
 
 <dl>
+<dd>
 
+<dl>
 <dd>
 
+**testsetId:** `number` — The ID of the Testset to create the Testcase in.
+
+</dd>
+</dl>
+
 <dl>
+<dd>
+
+**request:** `Scorecard.TestcaseBatchCopyParams`
 
+</dd>
+</dl>
+
+<dl>
 <dd>
 
-**request: `Scorecard.RunCreateParams`**
+**requestOptions:** `Testcase.RequestOptions`
 
 </dd>
+</dl>
+</dd>
+</dl>
 
+</dd>
 </dl>
+</details>
 
+<details><summary><code>client.testcase.<a href="/src/api/resources/testcase/client/Client.ts">batchDelete</a>(testsetId, { ...params }) -> Scorecard.TestcaseBatchDeletionResponse</code></summary>
 <dl>
+<dd>
 
+#### 📝 Description
+
+<dl>
 <dd>
 
-**requestOptions: `Run.RequestOptions`**
+<dl>
+<dd>
+
+Batch delete Testcases
 
 </dd>
+</dl>
+</dd>
+</dl>
 
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.testcase.batchDelete(1);
+```
+
+</dd>
+</dl>
+</dd>
 </dl>
 
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**testsetId:** `number` — The ID of the Testset from which the Testcases will be deleted.
+
 </dd>
+</dl>
+
+<dl>
+<dd>
 
+**request:** `Scorecard.TestcaseBatchDeleteParams`
+
+</dd>
 </dl>
 
+<dl>
+<dd>
+
+**requestOptions:** `Testcase.RequestOptions`
+
 </dd>
+</dl>
+</dd>
+</dl>
 
+</dd>
 </dl>
 </details>
 
-<details><summary> <code>scorecard.run.<a href="./src/api/resources/run/client/Client.ts">get</a>(runId) -> Scorecard.Run</code> </summary>
+## Testrecord
 
+<details><summary><code>client.testrecord.<a href="/src/api/resources/testrecord/client/Client.ts">get</a>(testrecordId, runId) -> Scorecard.Testrecord</code></summary>
 <dl>
-
 <dd>
 
 #### 📝 Description
 
 <dl>
-
 <dd>
 
 <dl>
-
 <dd>
 
-Retrieve a Run metadata
+Retrieve Testrecord metadata
 
 </dd>
-
 </dl>
-
 </dd>
-
 </dl>
 
 #### 🔌 Usage
 
 <dl>
-
 <dd>
 
 <dl>
-
 <dd>
 
-```ts
-await scorecard.run.get(1);
+```typescript
+await client.testrecord.get(1, 1);
 ```
 
 </dd>
-
 </dl>
-
 </dd>
-
 </dl>
 
 #### ⚙️ Parameters
 
 <dl>
+<dd>
 
+<dl>
 <dd>
 
+**testrecordId:** `number`
+
+</dd>
+</dl>
+
 <dl>
+<dd>
 
+**runId:** `number`
+
+</dd>
+</dl>
+
+<dl>
 <dd>
 
-**runId: `number`** — The id of the run to retrieve.
+**requestOptions:** `Testrecord.RequestOptions`
 
 </dd>
+</dl>
+</dd>
+</dl>
 
+</dd>
 </dl>
+</details>
 
+<details><summary><code>client.testrecord.<a href="/src/api/resources/testrecord/client/Client.ts">create</a>(runId, { ...params }) -> Scorecard.Testrecord</code></summary>
 <dl>
+<dd>
+
+#### 📝 Description
 
+<dl>
+<dd>
+
+<dl>
 <dd>
 
-**requestOptions: `Run.RequestOptions`**
+Create a new Testrecord
 
 </dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
 
+<dl>
+<dd>
+
+```typescript
+await client.testrecord.create(1);
+```
+
+</dd>
 </dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**runId:** `number` — The ID of the Run to create the Testrecord in.
 
 </dd>
+</dl>
 
+<dl>
+<dd>
+
+**request:** `Scorecard.TestrecordCreateParams`
+
+</dd>
 </dl>
 
+<dl>
+<dd>
+
+**requestOptions:** `Testrecord.RequestOptions`
+
+</dd>
+</dl>
 </dd>
+</dl>
 
+</dd>
 </dl>
 </details>
 
-<details><summary> <code>scorecard.run.<a href="./src/api/resources/run/client/Client.ts">updateStatus</a>(runId, { ...params }) -> Scorecard.Run</code> </summary>
+## Run
 
+<details><summary><code>client.run.<a href="/src/api/resources/run/client/Client.ts">create</a>({ ...params }) -> Scorecard.Run</code></summary>
 <dl>
-
 <dd>
 
 #### 📝 Description
 
 <dl>
+<dd>
 
+<dl>
 <dd>
 
+Create a new Run
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
 <dl>
+<dd>
 
+<dl>
 <dd>
 
-Update the status of a run.
+```typescript
+await client.run.create();
+```
 
 </dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
 
+<dl>
+<dd>
+
+**request:** `Scorecard.RunCreateParams`
+
+</dd>
 </dl>
 
+<dl>
+<dd>
+
+**requestOptions:** `Run.RequestOptions`
+
+</dd>
+</dl>
 </dd>
+</dl>
 
+</dd>
 </dl>
+</details>
 
-#### 🔌 Usage
+<details><summary><code>client.run.<a href="/src/api/resources/run/client/Client.ts">get</a>(runId) -> Scorecard.Run</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
 
 <dl>
+<dd>
 
+<dl>
 <dd>
 
+Retrieve a Run metadata
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
 <dl>
+<dd>
 
+<dl>
 <dd>
 
-```ts
-await scorecard.run.updateStatus(1);
+```typescript
+await client.run.get(1);
 ```
 
 </dd>
-
 </dl>
-
 </dd>
-
 </dl>
 
 #### ⚙️ Parameters
 
 <dl>
-
 <dd>
 
 <dl>
+<dd>
+
+**runId:** `number` — The id of the run to retrieve.
 
+</dd>
+</dl>
+
+<dl>
 <dd>
 
-**runId: `number`** — The id of the run to update.
+**requestOptions:** `Run.RequestOptions`
 
 </dd>
+</dl>
+</dd>
+</dl>
 
+</dd>
 </dl>
+</details>
 
+<details><summary><code>client.run.<a href="/src/api/resources/run/client/Client.ts">updateStatus</a>(runId, { ...params }) -> Scorecard.Run</code></summary>
 <dl>
+<dd>
 
+#### 📝 Description
+
+<dl>
 <dd>
 
-**request: `Scorecard.UpdateStatusParams`**
+<dl>
+<dd>
 
-</dd>
+Update the status of a run.
 
+</dd>
+</dl>
+</dd>
 </dl>
 
+#### 🔌 Usage
+
 <dl>
+<dd>
 
+<dl>
 <dd>
 
-**requestOptions: `Run.RequestOptions`**
+```typescript
+await client.run.updateStatus(1);
+```
 
 </dd>
-
 </dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**runId:** `number` — The id of the run to update.
 
 </dd>
+</dl>
 
+<dl>
+<dd>
+
+**request:** `Scorecard.UpdateStatusParams`
+
+</dd>
 </dl>
 
+<dl>
+<dd>
+
+**requestOptions:** `Run.RequestOptions`
+
+</dd>
+</dl>
 </dd>
+</dl>
 
+</dd>
 </dl>
 </details>
 
 ## Score
 
-<details><summary> <code>scorecard.score.<a href="./src/api/resources/score/client/Client.ts">create</a>(runId, testrecordId, { ...params }) -> Scorecard.Grade</code> </summary>
+<details><summary><code>client.score.<a href="/src/api/resources/score/client/Client.ts">create</a>(runId, testrecordId, { ...params }) -> Scorecard.Grade</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
 
 <dl>
+<dd>
 
+<dl>
 <dd>
 
-#### 📝 Description
+Create a score
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
 
 <dl>
+<dd>
 
+<dl>
 <dd>
 
+```typescript
+await client.score.create(1, 1, {
+    metricId: 1,
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
 <dl>
+<dd>
 
+<dl>
 <dd>
 
-Create a score
+**runId:** `number` — The ID of the run that created the testrecord to be scored.
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**testrecordId:** `number` — The ID of the testrecord to be scored.
 
 </dd>
+</dl>
 
+<dl>
+<dd>
+
+**request:** `Scorecard.ScoreCreateParams`
+
+</dd>
 </dl>
 
+<dl>
+<dd>
+
+**requestOptions:** `Score.RequestOptions`
+
+</dd>
+</dl>
 </dd>
+</dl>
 
+</dd>
 </dl>
+</details>
 
-#### 🔌 Usage
+<details><summary><code>client.score.<a href="/src/api/resources/score/client/Client.ts">update</a>(runId, testrecordId, scoreId, { ...params }) -> Scorecard.Grade</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
 
 <dl>
+<dd>
 
+<dl>
 <dd>
 
+Update a score
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
 <dl>
+<dd>
 
+<dl>
 <dd>
 
-```ts
-await scorecard.score.create(1, 1, {
-    metricId: 1,
-});
+```typescript
+await client.score.update(1, 1, 1);
 ```
 
 </dd>
-
 </dl>
-
 </dd>
-
 </dl>
 
 #### ⚙️ Parameters
 
 <dl>
+<dd>
 
+<dl>
 <dd>
 
+**runId:** `number` — The run ID that created the test record to be scored.
+
+</dd>
+</dl>
+
 <dl>
+<dd>
+
+**testrecordId:** `number` — The ID of the testrecord whose score will be updated.
+
+</dd>
+</dl>
 
+<dl>
 <dd>
 
-**runId: `number`** — The ID of the run that created the testrecord to be scored.
+**scoreId:** `number` — The ID of the score to be updated.
 
 </dd>
+</dl>
+
+<dl>
+<dd>
 
+**request:** `Scorecard.ScoreUpdateParams`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Score.RequestOptions`
+
+</dd>
 </dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+## RunMetric
+
+<details><summary><code>client.runMetric.<a href="/src/api/resources/runMetric/client/Client.ts">get</a>(runId) -> Scorecard.RunMetric[]</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
 
 <dl>
+<dd>
 
+<dl>
 <dd>
 
-**testrecordId: `number`** — The ID of the testrecord to be scored.
+Retrieve metrics associated with a run
 
 </dd>
+</dl>
+</dd>
+</dl>
 
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.runMetric.get(1);
+```
+
+</dd>
+</dl>
+</dd>
 </dl>
 
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
 <dl>
-
 <dd>
 
-**request: `Scorecard.ScoreCreateParams`**
+**runId:** `number` — The id of the run to retrieve.
 
 </dd>
-
 </dl>
 
 <dl>
-
 <dd>
 
-**requestOptions: `Score.RequestOptions`**
+**requestOptions:** `RunMetric.RequestOptions`
 
 </dd>
-
 </dl>
-
 </dd>
-
 </dl>
 
 </dd>
-
 </dl>
 </details>
 
-<details><summary> <code>scorecard.score.<a href="./src/api/resources/score/client/Client.ts">update</a>(runId, testrecordId, scoreId, { ...params }) -> Scorecard.Grade</code> </summary>
+## Tracing
 
+<details><summary><code>client.tracing.<a href="/src/api/resources/tracing/client/Client.ts">traces</a>() -> Scorecard.Trace[]</code></summary>
 <dl>
-
 <dd>
 
 #### 📝 Description
 
 <dl>
-
 <dd>
 
 <dl>
-
 <dd>
 
-Update a score
+Retrieve traces
 
 </dd>
-
 </dl>
-
 </dd>
-
 </dl>
 
 #### 🔌 Usage
 
 <dl>
-
 <dd>
 
 <dl>
-
 <dd>
 
-```ts
-await scorecard.score.update(1, 1, 1);
+```typescript
+await client.tracing.traces();
 ```
 
 </dd>
-
 </dl>
-
 </dd>
-
 </dl>
 
 #### ⚙️ Parameters
 
 <dl>
-
 <dd>
 
 <dl>
-
 <dd>
 
-**runId: `number`** — The run ID that created the test record to be scored.
+**requestOptions:** `Tracing.RequestOptions`
 
 </dd>
+</dl>
+</dd>
+</dl>
 
+</dd>
 </dl>
+</details>
+
+<details><summary><code>client.tracing.<a href="/src/api/resources/tracing/client/Client.ts">trace</a>(traceId) -> Scorecard.Trace</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
 
 <dl>
+<dd>
 
+<dl>
 <dd>
 
-**testrecordId: `number`** — The ID of the testrecord whose score will be updated.
+Retrieve specified trace
 
 </dd>
-
+</dl>
+</dd>
 </dl>
 
+#### 🔌 Usage
+
 <dl>
+<dd>
 
+<dl>
 <dd>
 
-**scoreId: `number`** — The ID of the score to be updated.
+```typescript
+await client.tracing.trace("trace_id");
+```
 
 </dd>
-
+</dl>
+</dd>
 </dl>
 
+#### ⚙️ Parameters
+
 <dl>
+<dd>
 
+<dl>
 <dd>
 
-**request: `Scorecard.ScoreUpdateParams`**
+**traceId:** `string` — The ID of the trace to retrieve spans from.
 
 </dd>
-
 </dl>
 
 <dl>
-
 <dd>
 
-**requestOptions: `Score.RequestOptions`**
+**requestOptions:** `Tracing.RequestOptions`
 
 </dd>
-
 </dl>
-
 </dd>
-
 </dl>
 
 </dd>
-
 </dl>
 </details>
 
-## RunMetric
-
-<details><summary> <code>scorecard.runMetric.<a href="./src/api/resources/runMetric/client/Client.ts">get</a>(runId) -> Scorecard.RunMetric[]</code> </summary>
-
+<details><summary><code>client.tracing.<a href="/src/api/resources/tracing/client/Client.ts">span</a>(traceId, spanId) -> Scorecard.Span</code></summary>
 <dl>
-
 <dd>
 
 #### 📝 Description
 
 <dl>
-
 <dd>
 
 <dl>
-
 <dd>
 
-Retrieve metrics associated with a run
+Retrieve specified span
 
 </dd>
-
 </dl>
-
 </dd>
-
 </dl>
 
 #### 🔌 Usage
 
 <dl>
-
 <dd>
 
 <dl>
-
 <dd>
 
-```ts
-await scorecard.runMetric.get(1);
+```typescript
+await client.tracing.span("trace_id", "span_id");
 ```
 
 </dd>
-
 </dl>
-
 </dd>
-
 </dl>
 
 #### ⚙️ Parameters
 
 <dl>
-
 <dd>
 
 <dl>
-
 <dd>
 
-**runId: `number`** — The id of the run to retrieve.
+**traceId:** `string` — The ID of the trace which the span is a part of.
 
 </dd>
-
 </dl>
 
 <dl>
-
 <dd>
 
-**requestOptions: `RunMetric.RequestOptions`**
+**spanId:** `string` — The ID of the span to retrieve.
 
 </dd>
-
 </dl>
 
-</dd>
+<dl>
+<dd>
 
-</dl>
+**requestOptions:** `Tracing.RequestOptions`
 
 </dd>
+</dl>
+</dd>
+</dl>
 
+</dd>
 </dl>
 </details>
 
-## Traces
-
-<details><summary> <code>scorecard.traces.<a href="./src/api/resources/traces/client/Client.ts">get</a>(traceId) -> Scorecard.Span[]</code> </summary>
+## Prompt
 
+<details><summary><code>client.prompt.<a href="/src/api/resources/prompt/client/Client.ts">getByName</a>({ ...params }) -> Scorecard.Prompt</code></summary>
 <dl>
-
 <dd>
 
 #### 📝 Description
 
 <dl>
-
 <dd>
 
 <dl>
-
 <dd>
 
-Retrieve trace spans
+Retrieve a prod prompt by name
 
 </dd>
-
 </dl>
-
 </dd>
-
 </dl>
 
 #### 🔌 Usage
 
 <dl>
-
 <dd>
 
 <dl>
-
 <dd>
 
-```ts
-await scorecard.traces.get("trace_id");
+```typescript
+await client.prompt.getByName({
+    name: "name",
+});
 ```
 
 </dd>
-
 </dl>
-
 </dd>
-
 </dl>
 
 #### ⚙️ Parameters
 
 <dl>
-
 <dd>
 
 <dl>
-
 <dd>
 
-**traceId: `string`** — The ID of the trace to retrieve spans from.
+**request:** `Scorecard.PromptGetByNameRequest`
 
 </dd>
-
 </dl>
 
 <dl>
-
 <dd>
 
-**requestOptions: `Traces.RequestOptions`**
+**requestOptions:** `Prompt.RequestOptions`
 
 </dd>
-
 </dl>
-
 </dd>
-
 </dl>
 
 </dd>
-
 </dl>
 </details>
 
-## Prompt
-
-<details><summary> <code>scorecard.prompt.<a href="./src/api/resources/prompt/client/Client.ts">create</a>({ ...params }) -> Scorecard.Prompt</code> </summary>
-
+<details><summary><code>client.prompt.<a href="/src/api/resources/prompt/client/Client.ts">create</a>({ ...params }) -> Scorecard.Prompt</code></summary>
 <dl>
-
 <dd>
 
 #### 📝 Description
 
 <dl>
-
 <dd>
 
 <dl>
-
 <dd>
 
 Two types of prompts can be created - a root prompt or a child prompt (aka Prompt Version in app).
@@ -1572,25 +1689,20 @@ Two types of prompts can be created - a root prompt or a child prompt (aka Promp
         A child prompt can be created by providing the `parent_id` param. Note that the `name` param in this case will be ignored as all descendents from a root prompt would share the root's name. `is_prod` can also be provided to configure whether a child should be tagged as prod.
 
 </dd>
-
 </dl>
-
 </dd>
-
 </dl>
 
 #### 🔌 Usage
 
 <dl>
-
 <dd>
 
 <dl>
-
 <dd>
 
-```ts
-await scorecard.prompt.create({
+```typescript
+await client.prompt.create({
     promptTemplate:
         "<system>\nYou are a helpful assistant. Use the provided context to answer the user's query.\n\nContext: {context}\n</system>\n\n<user>\n{user_query}\n</user>",
     name: "Prompt Name",
@@ -1605,228 +1717,173 @@ await scorecard.prompt.create({
 ```
 
 </dd>
-
 </dl>
-
 </dd>
-
 </dl>
 
 #### ⚙️ Parameters
 
 <dl>
-
 <dd>
 
 <dl>
-
 <dd>
 
-**request: `Scorecard.PromptCreateParams`**
+**request:** `Scorecard.PromptCreateParams`
 
 </dd>
-
 </dl>
 
 <dl>
-
 <dd>
 
-**requestOptions: `Prompt.RequestOptions`**
+**requestOptions:** `Prompt.RequestOptions`
 
 </dd>
-
 </dl>
-
 </dd>
-
 </dl>
 
 </dd>
-
 </dl>
 </details>
 
-<details><summary> <code>scorecard.prompt.<a href="./src/api/resources/prompt/client/Client.ts">get</a>(id) -> Scorecard.Prompt</code> </summary>
-
+<details><summary><code>client.prompt.<a href="/src/api/resources/prompt/client/Client.ts">get</a>(id) -> Scorecard.Prompt</code></summary>
 <dl>
-
 <dd>
 
 #### 📝 Description
 
 <dl>
-
 <dd>
 
 <dl>
-
 <dd>
 
 Retrieve a prompt by id
 
 </dd>
-
 </dl>
-
 </dd>
-
 </dl>
 
 #### 🔌 Usage
 
 <dl>
-
 <dd>
 
 <dl>
-
 <dd>
 
-```ts
-await scorecard.prompt.get("id");
+```typescript
+await client.prompt.get("id");
 ```
 
 </dd>
-
 </dl>
-
 </dd>
-
 </dl>
 
 #### ⚙️ Parameters
 
 <dl>
-
 <dd>
 
 <dl>
-
 <dd>
 
-**id: `string`** — The id of the prompt to get.
+**id:** `string` — The id of the prompt to get.
 
 </dd>
-
 </dl>
 
 <dl>
-
 <dd>
 
-**requestOptions: `Prompt.RequestOptions`**
+**requestOptions:** `Prompt.RequestOptions`
 
 </dd>
-
 </dl>
-
 </dd>
-
 </dl>
 
 </dd>
-
 </dl>
 </details>
 
-<details><summary> <code>scorecard.prompt.<a href="./src/api/resources/prompt/client/Client.ts">delete</a>(id) -> unknown</code> </summary>
-
+<details><summary><code>client.prompt.<a href="/src/api/resources/prompt/client/Client.ts">delete</a>(id) -> unknown</code></summary>
 <dl>
-
 <dd>
 
 #### 📝 Description
 
 <dl>
-
 <dd>
 
 <dl>
-
 <dd>
 
-Delete a root prompt and all of its children.
+Delete a scoring config.
 
 </dd>
-
 </dl>
-
 </dd>
-
 </dl>
 
 #### 🔌 Usage
 
 <dl>
-
 <dd>
 
 <dl>
-
 <dd>
 
-```ts
-await scorecard.prompt.delete("id");
+```typescript
+await client.prompt.delete("id");
 ```
 
 </dd>
-
 </dl>
-
 </dd>
-
 </dl>
 
 #### ⚙️ Parameters
 
 <dl>
-
 <dd>
 
 <dl>
-
 <dd>
 
-**id: `string`** — The id of the root prompt to delete.
+**id:** `string` — The id of the scoring config to delete.
 
 </dd>
-
 </dl>
 
 <dl>
-
 <dd>
 
-**requestOptions: `Prompt.RequestOptions`**
+**requestOptions:** `Prompt.RequestOptions`
 
 </dd>
-
 </dl>
-
 </dd>
-
 </dl>
 
 </dd>
-
 </dl>
 </details>
 
-<details><summary> <code>scorecard.prompt.<a href="./src/api/resources/prompt/client/Client.ts">update</a>(id, { ...params }) -> Scorecard.Prompt</code> </summary>
-
+<details><summary><code>client.prompt.<a href="/src/api/resources/prompt/client/Client.ts">update</a>(id, { ...params }) -> Scorecard.Prompt</code></summary>
 <dl>
-
 <dd>
 
 #### 📝 Description
 
 <dl>
-
 <dd>
 
 <dl>
-
 <dd>
 
 Update a prompt.
@@ -1834,161 +1891,192 @@ Update a prompt.
         `is_prod` tags the provided prompt as the production prompt within the prompt graph.
 
 </dd>
-
 </dl>
-
 </dd>
-
 </dl>
 
 #### 🔌 Usage
 
 <dl>
-
 <dd>
 
 <dl>
-
 <dd>
 
-```ts
-await scorecard.prompt.update("id", {
+```typescript
+await client.prompt.update("id", {
     isProd: true,
 });
 ```
 
 </dd>
-
 </dl>
-
 </dd>
-
 </dl>
 
 #### ⚙️ Parameters
 
 <dl>
-
 <dd>
 
 <dl>
-
 <dd>
 
-**id: `string`** — The id of the prompt to update.
+**id:** `string` — The id of the prompt to update.
 
 </dd>
-
 </dl>
 
 <dl>
-
 <dd>
 
-**request: `Scorecard.PromptUpdateParams`**
+**request:** `Scorecard.PromptUpdateParams`
 
 </dd>
-
 </dl>
 
 <dl>
-
 <dd>
 
-**requestOptions: `Prompt.RequestOptions`**
+**requestOptions:** `Prompt.RequestOptions`
 
 </dd>
-
 </dl>
-
 </dd>
-
 </dl>
 
 </dd>
-
 </dl>
 </details>
 
-<details><summary> <code>scorecard.prompt.<a href="./src/api/resources/prompt/client/Client.ts">getByName</a>(name) -> Scorecard.Prompt</code> </summary>
+## ScoringConfig
 
+<details><summary><code>client.scoringConfig.<a href="/src/api/resources/scoringConfig/client/Client.ts">create</a>({ ...params }) -> Scorecard.ScoringConfig</code></summary>
 <dl>
-
 <dd>
 
 #### 📝 Description
 
 <dl>
-
 <dd>
 
 <dl>
-
 <dd>
 
-Retrieve a prod prompt by name
+Create a new scoring config.
 
 </dd>
-
 </dl>
-
 </dd>
-
 </dl>
 
 #### 🔌 Usage
 
 <dl>
-
 <dd>
 
 <dl>
-
 <dd>
 
-```ts
-await scorecard.prompt.getByName("name");
+```typescript
+await client.scoringConfig.create({
+    name: "Scoring Config Name",
+    description: "Description of the scoring config",
+    metrics: [1, 2, 3],
+});
 ```
 
 </dd>
-
 </dl>
-
 </dd>
-
 </dl>
 
 #### ⚙️ Parameters
 
 <dl>
-
 <dd>
 
 <dl>
+<dd>
+
+**request:** `Scorecard.ScoringConfigCreateParams`
+
+</dd>
+</dl>
 
+<dl>
 <dd>
 
-**name: `string`** — Name of the prompt.
+**requestOptions:** `ScoringConfig.RequestOptions`
 
 </dd>
+</dl>
+</dd>
+</dl>
 
+</dd>
 </dl>
+</details>
+
+<details><summary><code>client.scoringConfig.<a href="/src/api/resources/scoringConfig/client/Client.ts">get</a>(id) -> Scorecard.ScoringConfig</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
 
 <dl>
+<dd>
 
+<dl>
 <dd>
 
-**requestOptions: `Prompt.RequestOptions`**
+Retrieve a scoring config by id
 
 </dd>
-
 </dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.scoringConfig.get("id");
+```
 
 </dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
 
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**id:** `string` — The id of the scoring config to get.
+
+</dd>
 </dl>
 
+<dl>
+<dd>
+
+**requestOptions:** `ScoringConfig.RequestOptions`
+
 </dd>
+</dl>
+</dd>
+</dl>
 
+</dd>
 </dl>
 </details>