Class FineTuningEndpoint

Namespace

OpenAI.FineTuning

Assembly

OpenAI-DotNet.dll

Manage fine-tuning jobs to tailor a model to your specific training data.
https://platform.openai.com/docs/guides/fine-tuning
https://platform.openai.com/docs/api-reference/fine-tuning

public sealed class FineTuningEndpoint : OpenAIBaseEndpoint

Inheritance

object

OpenAIBaseEndpoint

FineTuningEndpoint

Inherited Members

OpenAIBaseEndpoint.EnableDebug

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

FineTuningEndpoint(OpenAIClient)

public FineTuningEndpoint(OpenAIClient client)

Parameters

client OpenAIClient

Properties

Root

The root endpoint address.

protected override string Root { get; }

Property Value

string

Methods

CancelJobAsync(string, CancellationToken)

Immediately cancel a fine-tune job.

public Task<bool> CancelJobAsync(string jobId, CancellationToken cancellationToken = default)

Parameters

jobId string

Id to cancel.

cancellationToken CancellationToken

Optional, CancellationToken.

Returns

Task<bool>

FineTuneJobResponse.

CreateJobAsync(CreateFineTuneJobRequest, CancellationToken)

Creates a job that fine-tunes a specified model from a given dataset. Response includes details of the queued job including job status and the name of the fine-tuned models once complete.

public Task<FineTuneJobResponse> CreateJobAsync(CreateFineTuneJobRequest jobRequest, CancellationToken cancellationToken = default)

Parameters

jobRequest CreateFineTuneJobRequest

CreateFineTuneJobRequest.

cancellationToken CancellationToken

Optional, CancellationToken.

Returns

Task<FineTuneJobResponse>

FineTuneJobResponse.

GetJobInfoAsync(string, CancellationToken)

Gets info about the fine-tune job.

public Task<FineTuneJobResponse> GetJobInfoAsync(string jobId, CancellationToken cancellationToken = default)

Parameters

jobId string

Id.

cancellationToken CancellationToken

Optional, CancellationToken.

Returns

Task<FineTuneJobResponse>

FineTuneJobResponse.

ListJobEventsAsync(string, ListQuery, CancellationToken)

Get fine-grained status updates for a fine-tune job.

public Task<ListResponse<EventResponse>> ListJobEventsAsync(string jobId, ListQuery query = null, CancellationToken cancellationToken = default)

Parameters

jobId string

Id.

query ListQuery

ListQuery.

cancellationToken CancellationToken

Optional, CancellationToken.

Returns

Task<ListResponse<EventResponse>>

List of events for FineTuneJobResponse.

ListJobsAsync(ListQuery, CancellationToken)

List your organization's fine-tuning jobs.

public Task<ListResponse<FineTuneJobResponse>> ListJobsAsync(ListQuery query = null, CancellationToken cancellationToken = default)

Parameters

query ListQuery

ListQuery.

cancellationToken CancellationToken

Optional, CancellationToken.

Returns

Task<ListResponse<FineTuneJobResponse>>

List of FineTuneJobResponses.