docs: add examples to tsdocs

Author: stainless-app[bot]

src/resources/inference-pipelines/data.ts

@@ -6,6 +6,26 @@ import * as Core from '../../core';
 export class Data extends APIResource {
   /**
    * Publish an inference data point to an inference pipeline.
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.inferencePipelines.data.stream(
+   *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *     {
+   *       config: { outputColumnName: 'output' },
+   *       rows: [
+   *         {
+   *           user_query: 'bar',
+   *           output: 'bar',
+   *           tokens: 'bar',
+   *           cost: 'bar',
+   *           timestamp: 'bar',
+   *         },
+   *       ],
+   *     },
+   *   );
+   * ```
    */
   stream(
     inferencePipelineId: string,

src/resources/inference-pipelines/inference-pipelines.ts

@@ -17,6 +17,14 @@ export class InferencePipelines extends APIResource {
 
   /**
    * Retrieve inference pipeline.
+   *
+   * @example
+   * ```ts
+   * const inferencePipeline =
+   *   await client.inferencePipelines.retrieve(
+   *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *   );
+   * ```
    */
   retrieve(
     inferencePipelineId: string,
@@ -40,6 +48,14 @@ export class InferencePipelines extends APIResource {
 
   /**
    * Update inference pipeline.
+   *
+   * @example
+   * ```ts
+   * const inferencePipeline =
+   *   await client.inferencePipelines.update(
+   *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *   );
+   * ```
    */
   update(
     inferencePipelineId: string,
@@ -63,6 +79,13 @@ export class InferencePipelines extends APIResource {
 
   /**
    * Delete inference pipeline.
+   *
+   * @example
+   * ```ts
+   * await client.inferencePipelines.delete(
+   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   * );
+   * ```
    */
   delete(inferencePipelineId: string, options?: Core.RequestOptions): Core.APIPromise<void> {
     return this._client.delete(`/inference-pipelines/${inferencePipelineId}`, {

src/resources/inference-pipelines/rows.ts

@@ -6,6 +6,14 @@ import * as Core from '../../core';
 export class Rows extends APIResource {
   /**
    * Update an inference data point in an inference pipeline.
+   *
+   * @example
+   * ```ts
+   * const row = await client.inferencePipelines.rows.update(
+   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *   { inferenceId: 'inferenceId', row: {} },
+   * );
+   * ```
    */
   update(
     inferencePipelineId: string,

src/resources/inference-pipelines/test-results.ts

@@ -7,6 +7,14 @@ import * as Core from '../../core';
 export class TestResults extends APIResource {
   /**
    * List the latest test results for an inference pipeline.
+   *
+   * @example
+   * ```ts
+   * const testResults =
+   *   await client.inferencePipelines.testResults.list(
+   *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *   );
+   * ```
    */
   list(
     inferencePipelineId: string,

src/resources/projects/commits.ts

@@ -7,6 +7,17 @@ import * as Core from '../../core';
 export class Commits extends APIResource {
   /**
    * Create a new commit (project version) in a project.
+   *
+   * @example
+   * ```ts
+   * const commit = await client.projects.commits.create(
+   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *   {
+   *     commit: { message: 'Updated the prompt.' },
+   *     storageUri: 's3://...',
+   *   },
+   * );
+   * ```
    */
   create(
     projectId: string,
@@ -18,6 +29,13 @@ export class Commits extends APIResource {
 
   /**
    * List the commits (project versions) in a project.
+   *
+   * @example
+   * ```ts
+   * const commits = await client.projects.commits.list(
+   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   * );
+   * ```
    */
   list(
     projectId: string,

src/resources/projects/inference-pipelines.ts

@@ -7,6 +7,18 @@ import * as Core from '../../core';
 export class InferencePipelines extends APIResource {
   /**
    * Create an inference pipeline in a project.
+   *
+   * @example
+   * ```ts
+   * const inferencePipeline =
+   *   await client.projects.inferencePipelines.create(
+   *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *     {
+   *       description: 'This pipeline is used for production.',
+   *       name: 'production',
+   *     },
+   *   );
+   * ```
    */
   create(
     projectId: string,
@@ -18,6 +30,14 @@ export class InferencePipelines extends APIResource {
 
   /**
    * List the inference pipelines in a project.
+   *
+   * @example
+   * ```ts
+   * const inferencePipelines =
+   *   await client.projects.inferencePipelines.list(
+   *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *   );
+   * ```
    */
   list(
     projectId: string,

src/resources/projects/projects.ts

@@ -39,13 +39,26 @@ export class Projects extends APIResource {
 
   /**
    * Create a project in your workspace.
+   *
+   * @example
+   * ```ts
+   * const project = await client.projects.create({
+   *   name: 'My Project',
+   *   taskType: 'llm-base',
+   * });
+   * ```
    */
   create(body: ProjectCreateParams, options?: Core.RequestOptions): Core.APIPromise<ProjectCreateResponse> {
     return this._client.post('/projects', { body, ...options });
   }
 
   /**
    * List your workspace's projects.
+   *
+   * @example
+   * ```ts
+   * const projects = await client.projects.list();
+   * ```
    */
   list(query?: ProjectListParams, options?: Core.RequestOptions): Core.APIPromise<ProjectListResponse>;
   list(options?: Core.RequestOptions): Core.APIPromise<ProjectListResponse>;

src/resources/projects/tests.ts

@@ -7,6 +7,21 @@ import * as Core from '../../core';
 export class Tests extends APIResource {
   /**
    * Create a test.
+   *
+   * @example
+   * ```ts
+   * const test = await client.projects.tests.create(
+   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *   {
+   *     description:
+   *       'This test checks for duplicate rows in the dataset.',
+   *     name: 'No duplicate rows',
+   *     subtype: 'duplicateRowCount',
+   *     thresholds: [{}],
+   *     type: 'integrity',
+   *   },
+   * );
+   * ```
    */
   create(
     projectId: string,
@@ -18,6 +33,18 @@ export class Tests extends APIResource {
 
   /**
    * Update tests.
+   *
+   * @example
+   * ```ts
+   * const test = await client.projects.tests.update(
+   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *   {
+   *     payloads: [
+   *       { id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' },
+   *     ],
+   *   },
+   * );
+   * ```
    */
   update(
     projectId: string,
@@ -29,6 +56,13 @@ export class Tests extends APIResource {
 
   /**
    * List tests under a project.
+   *
+   * @example
+   * ```ts
+   * const tests = await client.projects.tests.list(
+   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   * );
+   * ```
    */
   list(
     projectId: string,