feat: ENG-82904 - chore: update ReplicaEvent schema

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%2Ftogetherai-9d21c718836b00960cf34f6a1c14648ebcb1e747fc1a02006c56eaa571e0e261.yml
-openapi_spec_hash: b60875195a5f6dd59a2d7c6c75a23a43
-config_hash: 66b14e6bbf15a00f288e60f03ef44c4a
+configured_endpoints: 83
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/togetherai%2Ftogetherai-dc45695614158674dec4da8ae843a7564905f24d2ce577e8e6e5246b4a7b0f61.yml
+openapi_spec_hash: 46a91a84c8c270792676ee863b33ab99
+config_hash: 419603b503b8f5b6147b585b6d778b27

MIGRATION.md

@@ -38,6 +38,25 @@ Readable.fromWeb(res.body).pipe(process.stdout);
 
 Additionally, the `headers` property on `APIError` objects is now an instance of the Web [Headers](https://developer.mozilla.org/en-US/docs/Web/API/Headers) class. It was previously defined as `Record<string, string | null | undefined>`.
 
+### Named path parameters
+
+Methods that take multiple path parameters typically now use named instead of positional arguments for better clarity and to prevent a footgun where it was easy to accidentally pass arguments in the incorrect order.
+
+For example, for a method that would call an endpoint at `/v1/parents/{parent_id}/children/{child_id}`, only the _last_ path parameter is positional and the rest must be passed as named arguments.
+
+```ts
+// Before
+client.parents.children.retrieve('p_123', 'c_456');
+
+// After
+client.parents.children.retrieve('c_456', { parent_id: 'p_123' });
+```
+
+This affects the following methods:
+
+- `client.rl.trainingSessions.operations.retrieveForwardBackward()`
+- `client.rl.trainingSessions.operations.retrieveOptimStep()`
+
 ### URI encoded path parameters
 
 Path params are now properly encoded by default. If you were manually encoding path parameters before giving them to the SDK, you must now stop doing that and pass the
@@ -73,6 +92,7 @@ This affects the following methods:
 - `client.endpoints.list()`
 - `client.endpoints.listHardware()`
 - `client.evals.list()`
+- `client.rl.trainingSessions.list()`
 
 ### Removed `httpAgent` in favor of `fetchOptions`
 

api.md

@@ -364,3 +364,23 @@ Methods:
 - <code title="get /evaluation/{id}">client.evals.<a href="./src/resources/evals.ts">retrieve</a>(id) -> EvaluationJob</code>
 - <code title="get /evaluation">client.evals.<a href="./src/resources/evals.ts">list</a>({ ...params }) -> EvalListResponse</code>
 - <code title="get /evaluation/{id}/status">client.evals.<a href="./src/resources/evals.ts">status</a>(id) -> EvalStatusResponse</code>
+
+# Rl
+
+## TrainingSessions
+
+Methods:
+
+- <code title="post /rl/training-sessions">client.rl.trainingSessions.<a href="./src/resources/rl/training-sessions/training-sessions.ts">create</a>({ ...params }) -> void</code>
+- <code title="get /rl/training-sessions/{session_id}">client.rl.trainingSessions.<a href="./src/resources/rl/training-sessions/training-sessions.ts">retrieve</a>(sessionID) -> void</code>
+- <code title="get /rl/training-sessions">client.rl.trainingSessions.<a href="./src/resources/rl/training-sessions/training-sessions.ts">list</a>({ ...params }) -> void</code>
+- <code title="post /rl/training-sessions/{session_id}:forward-backward">client.rl.trainingSessions.<a href="./src/resources/rl/training-sessions/training-sessions.ts">forwardBackward</a>(sessionID, { ...params }) -> void</code>
+- <code title="post /rl/training-sessions/{session_id}:optim-step">client.rl.trainingSessions.<a href="./src/resources/rl/training-sessions/training-sessions.ts">optimStep</a>(sessionID, { ...params }) -> void</code>
+- <code title="post /rl/training-sessions/{session_id}:stop">client.rl.trainingSessions.<a href="./src/resources/rl/training-sessions/training-sessions.ts">stop</a>(sessionID) -> void</code>
+
+### Operations
+
+Methods:
+
+- <code title="get /rl/training-sessions/{session_id}/operations/forward-backward/{operation_id}">client.rl.trainingSessions.operations.<a href="./src/resources/rl/training-sessions/operations.ts">retrieveForwardBackward</a>(operationID, { ...params }) -> void</code>
+- <code title="get /rl/training-sessions/{session_id}/operations/optim-step/{operation_id}">client.rl.trainingSessions.operations.<a href="./src/resources/rl/training-sessions/operations.ts">retrieveOptimStep</a>(operationID, { ...params }) -> void</code>

bin/migration-config.json

@@ -2,5 +2,72 @@
   "pkg": "together-ai",
   "githubRepo": "https://github.com/togethercomputer/together-typescript",
   "clientClass": "Together",
-  "methods": []
+  "methods": [
+    {
+      "base": "rl.trainingSessions.operations",
+      "name": "retrieveForwardBackward",
+      "params": [
+        {
+          "type": "param",
+          "key": "operation_id",
+          "location": "path"
+        },
+        {
+          "type": "params",
+          "maybeOverload": false
+        },
+        {
+          "type": "options"
+        }
+      ],
+      "oldParams": [
+        {
+          "type": "param",
+          "key": "session_id",
+          "location": "path"
+        },
+        {
+          "type": "param",
+          "key": "operation_id",
+          "location": "path"
+        },
+        {
+          "type": "options"
+        }
+      ]
+    },
+    {
+      "base": "rl.trainingSessions.operations",
+      "name": "retrieveOptimStep",
+      "params": [
+        {
+          "type": "param",
+          "key": "operation_id",
+          "location": "path"
+        },
+        {
+          "type": "params",
+          "maybeOverload": false
+        },
+        {
+          "type": "options"
+        }
+      ],
+      "oldParams": [
+        {
+          "type": "param",
+          "key": "session_id",
+          "location": "path"
+        },
+        {
+          "type": "param",
+          "key": "operation_id",
+          "location": "path"
+        },
+        {
+          "type": "options"
+        }
+      ]
+    }
+  ]
 }

src/client.ts

@@ -101,6 +101,7 @@ import {
   ModelUploadResponse,
   Models,
 } from './resources/models/models';
+import { Rl } from './resources/rl/rl';
 import { type Fetch } from './internal/builtin-types';
 import { HeadersLike, NullableHeaders, buildHeaders } from './internal/headers';
 import { FinalRequestOptions, RequestOptions } from './internal/request-options';
@@ -815,6 +816,7 @@ export class Together {
   rerank: API.Rerank = new API.Rerank(this);
   batches: API.Batches = new API.Batches(this);
   evals: API.Evals = new API.Evals(this);
+  rl: API.Rl = new API.Rl(this);
 }
 
 Together.Beta = Beta;
@@ -832,6 +834,7 @@ Together.Endpoints = Endpoints;
 Together.Rerank = Rerank;
 Together.Batches = Batches;
 Together.Evals = Evals;
+Together.Rl = Rl;
 
 export declare namespace Together {
   export type RequestOptions = Opts.RequestOptions;
@@ -953,4 +956,6 @@ export declare namespace Together {
     type EvalCreateParams as EvalCreateParams,
     type EvalListParams as EvalListParams,
   };
+
+  export { Rl as Rl };
 }

src/resources/beta/jig/jig.ts

@@ -243,27 +243,9 @@ export namespace Deployment {
 
   export interface ReplicaEvents {
     /**
-     * ContainerStatus provides detailed status information about the container within
-     * this replica
+     * Image is the container image used for this replica
      */
-    container_status?: ReplicaEvents.ContainerStatus;
-
-    /**
-     * Events is a list of Kubernetes events related to this replica for
-     * troubleshooting
-     */
-    events?: Array<ReplicaEvents.Event>;
-
-    /**
-     * ReplicaCompletedAt is the timestamp when the replica finished execution
-     */
-    replica_completed_at?: string;
-
-    /**
-     * ReplicaMarkedForTerminationAt is the timestamp when the replica was marked for
-     * termination
-     */
-    replica_marked_for_termination_at?: string;
+    image?: string;
 
     /**
      * ReplicaReadySince is the timestamp when the replica became ready to serve
@@ -272,18 +254,8 @@ export namespace Deployment {
     replica_ready_since?: string;
 
     /**
-     * ReplicaRunningSince is the timestamp when the replica entered the running state
-     */
-    replica_running_since?: string;
-
-    /**
-     * ReplicaStartedAt is the timestamp when the replica was created
-     */
-    replica_started_at?: string;
-
-    /**
-     * ReplicaStatus is the current status of the replica (e.g., "Running", "Pending",
-     * "Failed")
+     * ReplicaStatus is the current status of the replica (e.g., "Running", "Waiting",
+     * "Terminated")
      */
     replica_status?: string;
 
@@ -300,84 +272,25 @@ export namespace Deployment {
     replica_status_reason?: string;
 
     /**
-     * ScheduledOnCluster identifies which cluster this replica is scheduled on
+     * RevisionID is the deployment revision ID associated with this replica
      */
-    scheduled_on_cluster?: string;
-  }
+    revision_id?: string;
+
+    /**
+     * VolumePreloadCompletedAt is the timestamp when the volume preload completed
+     */
+    volume_preload_completed_at?: string;
+
+    /**
+     * VolumePreloadStartedAt is the timestamp when the volume preload started
+     */
+    volume_preload_started_at?: string;
 
-  export namespace ReplicaEvents {
     /**
-     * ContainerStatus provides detailed status information about the container within
-     * this replica
+     * VolumePreloadStatus is the status of the volume preload (e.g., "InProgress",
+     * "Completed", "Failed")
      */
-    export interface ContainerStatus {
-      /**
-       * FinishedAt is the timestamp when the container finished execution (if
-       * terminated)
-       */
-      finishedAt?: string;
-
-      /**
-       * Message provides a human-readable message with details about the container's
-       * status
-       */
-      message?: string;
-
-      /**
-       * Name is the name of the container
-       */
-      name?: string;
-
-      /**
-       * Reason provides a brief machine-readable reason for the container's current
-       * status
-       */
-      reason?: string;
-
-      /**
-       * StartedAt is the timestamp when the container started execution
-       */
-      startedAt?: string;
-
-      /**
-       * Status is the current state of the container (e.g., "Running", "Terminated",
-       * "Waiting")
-       */
-      status?: string;
-    }
-
-    export interface Event {
-      /**
-       * Action is the action taken or reported by this event
-       */
-      action?: string;
-
-      /**
-       * Count is the number of times this event has occurred
-       */
-      count?: number;
-
-      /**
-       * FirstSeen is the timestamp when this event was first observed
-       */
-      first_seen?: string;
-
-      /**
-       * LastSeen is the timestamp when this event was last observed
-       */
-      last_seen?: string;
-
-      /**
-       * Message is a human-readable description of the event
-       */
-      message?: string;
-
-      /**
-       * Reason is a brief machine-readable reason for this event (e.g., "Pulling",
-       * "Started", "Failed")
-       */
-      reason?: string;
-    }
+    volume_preload_status?: string;
   }
 
   export interface Volume {

src/resources/index.ts

@@ -90,4 +90,5 @@ export {
   type ModelUploadParams,
 } from './models/models';
 export { Rerank, type RerankCreateResponse, type RerankCreateParams } from './rerank';
+export { Rl } from './rl/rl';
 export { Videos, type VideoJob, type VideoCreateParams } from './videos';

src/resources/rl.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './rl/index';

src/resources/rl/index.ts

@@ -0,0 +1,10 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export { Rl } from './rl';
+export {
+  TrainingSessions,
+  type TrainingSessionCreateParams,
+  type TrainingSessionListParams,
+  type TrainingSessionForwardBackwardParams,
+  type TrainingSessionOptimStepParams,
+} from './training-sessions/index';

src/resources/rl/rl.ts

@@ -0,0 +1,29 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as TrainingSessionsAPI from './training-sessions/training-sessions';
+import {
+  TrainingSessionCreateParams,
+  TrainingSessionForwardBackwardParams,
+  TrainingSessionListParams,
+  TrainingSessionOptimStepParams,
+  TrainingSessions,
+} from './training-sessions/training-sessions';
+
+export class Rl extends APIResource {
+  trainingSessions: TrainingSessionsAPI.TrainingSessions = new TrainingSessionsAPI.TrainingSessions(
+    this._client,
+  );
+}
+
+Rl.TrainingSessions = TrainingSessions;
+
+export declare namespace Rl {
+  export {
+    TrainingSessions as TrainingSessions,
+    type TrainingSessionCreateParams as TrainingSessionCreateParams,
+    type TrainingSessionListParams as TrainingSessionListParams,
+    type TrainingSessionForwardBackwardParams as TrainingSessionForwardBackwardParams,
+    type TrainingSessionOptimStepParams as TrainingSessionOptimStepParams,
+  };
+}