feat(api): Integrate fine_tuning.list_metrics from stainless

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
-configured_endpoints: 75
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/togetherai/togetherai-14a2d0f040bf287858da867ea3528581fb012d790d7e65b70f2b87f407efc7c7.yml
+configured_endpoints: 76
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/togetherai/togetherai-5f05c9669c67c3f4b0ebfe2317d2768cd96317424965ebb2acf06a7757a7d0ca.yml
 openapi_spec_hash: 84f45151f4d0eed68551b5ffda61595a
-config_hash: 6c214c91fad5ead4849be777fd9e8108
+config_hash: ec427df08d61d8888138f15cd53c6454

MIGRATION.md

@@ -69,6 +69,7 @@ This affects the following methods:
 
 - `client.beta.jig.retrieveLogs()`
 - `client.fineTuning.delete()`
+- `client.fineTuning.listMetrics()`
 - `client.models.list()`
 - `client.endpoints.list()`
 - `client.endpoints.listHardware()`

api.md

@@ -182,6 +182,7 @@ Types:
 - <code><a href="./src/resources/fine-tuning.ts">FineTuningEstimatePriceResponse</a></code>
 - <code><a href="./src/resources/fine-tuning.ts">FineTuningListCheckpointsResponse</a></code>
 - <code><a href="./src/resources/fine-tuning.ts">FineTuningListEventsResponse</a></code>
+- <code><a href="./src/resources/fine-tuning.ts">FineTuningListMetricsResponse</a></code>
 
 Methods:
 
@@ -194,6 +195,7 @@ Methods:
 - <code title="post /fine-tunes/estimate-price">client.fineTuning.<a href="./src/resources/fine-tuning.ts">estimatePrice</a>({ ...params }) -> FineTuningEstimatePriceResponse</code>
 - <code title="get /fine-tunes/{id}/checkpoints">client.fineTuning.<a href="./src/resources/fine-tuning.ts">listCheckpoints</a>(id) -> FineTuningListCheckpointsResponse</code>
 - <code title="get /fine-tunes/{id}/events">client.fineTuning.<a href="./src/resources/fine-tuning.ts">listEvents</a>(id) -> FineTuningListEventsResponse</code>
+- <code title="get /fine-tunes/{id}/metrics">client.fineTuning.<a href="./src/resources/fine-tuning.ts">listMetrics</a>(id, { ...params }) -> FineTuningListMetricsResponse</code>
 
 # CodeInterpreter
 

src/client.ts

@@ -70,6 +70,8 @@ import {
   FineTuningEstimatePriceResponse,
   FineTuningListCheckpointsResponse,
   FineTuningListEventsResponse,
+  FineTuningListMetricsParams,
+  FineTuningListMetricsResponse,
   FineTuningListResponse,
   FinetuneEvent,
   FinetuneEventType,
@@ -886,10 +888,12 @@ export declare namespace Together {
     type FineTuningEstimatePriceResponse as FineTuningEstimatePriceResponse,
     type FineTuningListCheckpointsResponse as FineTuningListCheckpointsResponse,
     type FineTuningListEventsResponse as FineTuningListEventsResponse,
+    type FineTuningListMetricsResponse as FineTuningListMetricsResponse,
     type FineTuningCreateParams as FineTuningCreateParams,
     type FineTuningDeleteParams as FineTuningDeleteParams,
     type FineTuningContentParams as FineTuningContentParams,
     type FineTuningEstimatePriceParams as FineTuningEstimatePriceParams,
+    type FineTuningListMetricsParams as FineTuningListMetricsParams,
   };
 
   export {

src/resources/fine-tuning.ts

@@ -144,6 +144,23 @@ export class FineTuning extends APIResource {
   listEvents(id: string, options?: RequestOptions): APIPromise<FineTuningListEventsResponse> {
     return this._client.get(path`/fine-tunes/${id}/events`, options);
   }
+
+  /**
+   * Retrieves recorded training metrics for a fine-tuning job in chronological
+   * order. All query parameters are optional: omit them to retrieve all metrics.
+   *
+   * @example
+   * ```ts
+   * const response = await client.fineTuning.listMetrics('id');
+   * ```
+   */
+  listMetrics(
+    id: string,
+    query: FineTuningListMetricsParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<FineTuningListMetricsResponse> {
+    return this._client.get(path`/fine-tunes/${id}/metrics`, { query, ...options });
+  }
 }
 
 export interface FinetuneEvent {
@@ -1269,6 +1286,10 @@ export interface FineTuningListEventsResponse {
   data: Array<FinetuneEvent>;
 }
 
+export interface FineTuningListMetricsResponse {
+  metrics?: Array<{ [key: string]: number }>;
+}
+
 export interface FineTuningCreateParams {
   /**
    * Name of the base model to run fine-tune job on
@@ -1646,6 +1667,33 @@ export namespace FineTuningEstimatePriceParams {
   }
 }
 
+export interface FineTuningListMetricsParams {
+  /**
+   * Return only metrics with global_step >= this value.
+   */
+  global_step_from?: number;
+
+  /**
+   * Return only metrics with global_step <= this value.
+   */
+  global_step_to?: number;
+
+  /**
+   * Return only metrics logged at or after this ISO-8601 timestamp.
+   */
+  logged_at_from?: string;
+
+  /**
+   * Return only metrics logged at or before this ISO-8601 timestamp.
+   */
+  logged_at_to?: string;
+
+  /**
+   * Number of (uniformly sampled) train metrics to return.
+   */
+  resolution?: number;
+}
+
 export declare namespace FineTuning {
   export {
     type FinetuneEvent as FinetuneEvent,
@@ -1658,9 +1706,11 @@ export declare namespace FineTuning {
     type FineTuningEstimatePriceResponse as FineTuningEstimatePriceResponse,
     type FineTuningListCheckpointsResponse as FineTuningListCheckpointsResponse,
     type FineTuningListEventsResponse as FineTuningListEventsResponse,
+    type FineTuningListMetricsResponse as FineTuningListMetricsResponse,
     type FineTuningCreateParams as FineTuningCreateParams,
     type FineTuningDeleteParams as FineTuningDeleteParams,
     type FineTuningContentParams as FineTuningContentParams,
     type FineTuningEstimatePriceParams as FineTuningEstimatePriceParams,
+    type FineTuningListMetricsParams as FineTuningListMetricsParams,
   };
 }

src/resources/index.ts

@@ -68,10 +68,12 @@ export {
   type FineTuningEstimatePriceResponse,
   type FineTuningListCheckpointsResponse,
   type FineTuningListEventsResponse,
+  type FineTuningListMetricsResponse,
   type FineTuningCreateParams,
   type FineTuningDeleteParams,
   type FineTuningContentParams,
   type FineTuningEstimatePriceParams,
+  type FineTuningListMetricsParams,
 } from './fine-tuning';
 export {
   Images,

tests/api-resources/fine-tuning.test.ts

@@ -162,4 +162,32 @@ describe('resource fineTuning', () => {
     expect(dataAndResponse.data).toBe(response);
     expect(dataAndResponse.response).toBe(rawResponse);
   });
+
+  test('listMetrics', async () => {
+    const responsePromise = client.fineTuning.listMetrics('id');
+    const rawResponse = await responsePromise.asResponse();
+    expect(rawResponse).toBeInstanceOf(Response);
+    const response = await responsePromise;
+    expect(response).not.toBeInstanceOf(Response);
+    const dataAndResponse = await responsePromise.withResponse();
+    expect(dataAndResponse.data).toBe(response);
+    expect(dataAndResponse.response).toBe(rawResponse);
+  });
+
+  test('listMetrics: request options and params are passed correctly', async () => {
+    // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error
+    await expect(
+      client.fineTuning.listMetrics(
+        'id',
+        {
+          global_step_from: 0,
+          global_step_to: 0,
+          logged_at_from: '2019-12-27T18:11:19.117Z',
+          logged_at_to: '2019-12-27T18:11:19.117Z',
+          resolution: 0,
+        },
+        { path: '/_stainless_unknown_path' },
+      ),
+    ).rejects.toThrow(Together.NotFoundError);
+  });
 });