@ralphschuler.ai function caller.index.<internal>.OpenAI.FineTunes

Class: FineTunes

<internal>.OpenAI.FineTunes

Hierarchy

• APIResource

  ↳ FineTunes

Table of contents

Constructors

• constructor

Properties

• _client

Methods

• cancel
• create
• list
• listEvents
• retrieve

Constructors

constructor

• new FineTunes(client): FineTunes

Parameters

Name	Type
client	OpenAI

Returns

FineTunes

Inherited from

APIResource.constructor

Defined in

node_modules/openai/resource.d.ts:4

Properties

_client

• Protected _client: OpenAI

Inherited from

APIResource._client

Defined in

node_modules/openai/resource.d.ts:3

Methods

cancel

▸ cancel(fineTuneId, options?): APIPromise<FineTune>

Immediately cancel a fine-tune job.

Parameters

Name	Type
fineTuneId	string
options?	RequestOptions<Readable | Record<string, unknown>>

Returns

APIPromise<FineTune>

Defined in

node_modules/openai/resources/fine-tunes.d.ts:31

---

create

▸ create(body, options?): APIPromise<FineTune>

Creates a job that fine-tunes a specified model from a given dataset.

Response includes details of the enqueued job including job status and the name of the fine-tuned models once complete.

Learn more about fine-tuning

Parameters

Name	Type
body	FineTuneCreateParams
options?	RequestOptions<Readable | Record<string, unknown>>

Returns

APIPromise<FineTune>

Defined in

node_modules/openai/resources/fine-tunes.d.ts:17

---

list

▸ list(options?): PagePromise<FineTunesPage, FineTune>

List your organization's fine-tuning jobs

Parameters

Name	Type
options?	RequestOptions<Readable | Record<string, unknown>>

Returns

PagePromise<FineTunesPage, FineTune>

Defined in

node_modules/openai/resources/fine-tunes.d.ts:27

---

listEvents

▸ listEvents(fineTuneId, query?, options?): APIPromise<FineTuneEventsListResponse>

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

Parameters

Name	Type
fineTuneId	string
query?	FineTuneListEventsParamsNonStreaming
options?	RequestOptions<Readable | Record<string, unknown>>

Returns

APIPromise<FineTuneEventsListResponse>

Defined in

node_modules/openai/resources/fine-tunes.d.ts:35

▸ listEvents(fineTuneId, query, options?): APIPromise<Stream<FineTuneEvent>>

Parameters

Name	Type
fineTuneId	string
query	FineTuneListEventsParamsStreaming
options?	RequestOptions<Readable | Record<string, unknown>>

Returns

APIPromise<Stream<FineTuneEvent>>

Defined in

node_modules/openai/resources/fine-tunes.d.ts:36

▸ listEvents(fineTuneId, query?, options?): APIPromise<FineTuneEventsListResponse | Stream<FineTuneEvent>>

Parameters

Name	Type
fineTuneId	string
query?	FineTuneListEventsParamsBase
options?	RequestOptions<Readable | Record<string, unknown>>

Returns

APIPromise<FineTuneEventsListResponse | Stream<FineTuneEvent>>

Defined in

node_modules/openai/resources/fine-tunes.d.ts:37

---

retrieve

▸ retrieve(fineTuneId, options?): APIPromise<FineTune>

Gets info about the fine-tune job.

Learn more about fine-tuning

Parameters

Name	Type
fineTuneId	string
options?	RequestOptions<Readable | Record<string, unknown>>

Returns

APIPromise<FineTune>

Defined in

node_modules/openai/resources/fine-tunes.d.ts:23