Class Tunings

Hierarchy

BaseModule
- Tunings

Index

Constructors

Methods

cancel get list tune

Constructors

constructor

new Tunings(apiClient: ApiClient): Tunings
Parameters
- apiClient: ApiClient
Returns Tunings
Overrides BaseModule.constructor
- Defined in src/tunings.ts:17

Methods

cancel

cancel(params: CancelTuningJobParameters): Promise<void>
Cancels a tuning job.
Parameters
- params: CancelTuningJobParameters
  The parameters for the cancel request.
Returns Promise<void>
The empty response returned by the API.
Example
```
await ai.tunings.cancel({name: '...'}); // The server-generated resource name.
```
- Defined in src/tunings.ts:283

get

get(params: GetTuningJobParameters): Promise<TuningJob>
Experimental
Gets a TuningJob.
Parameters
- params: GetTuningJobParameters
Returns Promise<TuningJob>
- A TuningJob object.
- The SDK's tuning implementation is experimental, and may change in future versions.
- Defined in src/tunings.ts:30

list

list(params?: ListTuningJobsParameters): Promise<Pager<TuningJob>>
Experimental
Lists tuning jobs.
Parameters
- params: ListTuningJobsParameters = {}
Returns Promise<Pager<TuningJob>>
- A list of tuning jobs.
- The SDK's tuning implementation is experimental, and may change in future versions.
- Defined in src/tunings.ts:45

tune

tune(params: CreateTuningJobParameters): Promise<TuningJob>
Experimental
Creates a supervised fine-tuning job.
Parameters
- params: CreateTuningJobParameters
  The parameters for the tuning job.
Returns Promise<TuningJob>
- A TuningJob operation.
- The SDK's tuning implementation is experimental, and may change in future versions.
- Defined in src/tunings.ts:65