Skip to content

Commit

Permalink
docs(api): update docstrings (#286)
Browse files Browse the repository at this point in the history
  • Loading branch information
stainless-bot committed Sep 6, 2023
1 parent 5095cf3 commit 664e953
Show file tree
Hide file tree
Showing 7 changed files with 17 additions and 16 deletions.
8 changes: 4 additions & 4 deletions src/resources/chat/completions.ts
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ export interface ChatCompletion {
choices: Array<ChatCompletion.Choice>;

/**
* A unix timestamp of when the chat completion was created.
* The Unix timestamp (in seconds) of when the chat completion was created.
*/
created: number;

Expand Down Expand Up @@ -109,7 +109,7 @@ export interface ChatCompletionChunk {
choices: Array<ChatCompletionChunk.Choice>;

/**
* A unix timestamp of when the chat completion chunk was created.
* The Unix timestamp (in seconds) of when the chat completion chunk was created.
*/
created: number;

Expand Down Expand Up @@ -321,7 +321,7 @@ export interface ChatCompletionCreateParamsBase {
* existing frequency in the text so far, decreasing the model's likelihood to
* repeat the same line verbatim.
*
* [See more information about frequency and presence penalties.](/docs/api-reference/parameter-details)
* [See more information about frequency and presence penalties.](/docs/guides/gpt/parameter-details)
*/
frequency_penalty?: number | null;

Expand Down Expand Up @@ -372,7 +372,7 @@ export interface ChatCompletionCreateParamsBase {
* whether they appear in the text so far, increasing the model's likelihood to
* talk about new topics.
*
* [See more information about frequency and presence penalties.](/docs/api-reference/parameter-details)
* [See more information about frequency and presence penalties.](/docs/guides/gpt/parameter-details)
*/
presence_penalty?: number | null;

Expand Down
6 changes: 3 additions & 3 deletions src/resources/completions.ts
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ export interface Completion {
choices: Array<CompletionChoice>;

/**
* The Unix timestamp of when the completion was created.
* The Unix timestamp (in seconds) of when the completion was created.
*/
created: number;

Expand Down Expand Up @@ -166,7 +166,7 @@ export interface CompletionCreateParamsBase {
* existing frequency in the text so far, decreasing the model's likelihood to
* repeat the same line verbatim.
*
* [See more information about frequency and presence penalties.](/docs/api-reference/parameter-details)
* [See more information about frequency and presence penalties.](/docs/guides/gpt/parameter-details)
*/
frequency_penalty?: number | null;

Expand Down Expand Up @@ -221,7 +221,7 @@ export interface CompletionCreateParamsBase {
* whether they appear in the text so far, increasing the model's likelihood to
* talk about new topics.
*
* [See more information about frequency and presence penalties.](/docs/api-reference/parameter-details)
* [See more information about frequency and presence penalties.](/docs/guides/gpt/parameter-details)
*/
presence_penalty?: number | null;

Expand Down
2 changes: 1 addition & 1 deletion src/resources/edits.ts
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ export interface Edit {
choices: Array<Edit.Choice>;

/**
* A unix timestamp of when the edit was created.
* The Unix timestamp (in seconds) of when the edit was created.
*/
created: number;

Expand Down
2 changes: 1 addition & 1 deletion src/resources/files.ts
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ export interface FileObject {
bytes: number;

/**
* The unix timestamp for when the file was created.
* The Unix timestamp (in seconds) for when the file was created.
*/
created_at: number;

Expand Down
4 changes: 2 additions & 2 deletions src/resources/fine-tunes.ts
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ export interface FineTune {
id: string;

/**
* The unix timestamp for when the fine-tuning job was created.
* The Unix timestamp (in seconds) for when the fine-tuning job was created.
*/
created_at: number;

Expand Down Expand Up @@ -142,7 +142,7 @@ export interface FineTune {
training_files: Array<Files.FileObject>;

/**
* The unix timestamp for when the fine-tuning job was last updated.
* The Unix timestamp (in seconds) for when the fine-tuning job was last updated.
*/
updated_at: number;

Expand Down
6 changes: 3 additions & 3 deletions src/resources/fine-tuning/jobs.ts
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ export interface FineTuningJob {
id: string;

/**
* The unix timestamp for when the fine-tuning job was created.
* The Unix timestamp (in seconds) for when the fine-tuning job was created.
*/
created_at: number;

Expand Down Expand Up @@ -154,10 +154,10 @@ export interface FineTuningJob {
/**
* The file ID used for validation.
*/
validation_file: string;
validation_file: string | null;

/**
* The unix timestamp for when the fine-tuning job was finished.
* The Unix timestamp (in seconds) for when the fine-tuning job was finished.
*/
finished_at?: number;
}
Expand Down
5 changes: 3 additions & 2 deletions src/resources/models.ts
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,8 @@ export class Models extends APIResource {
}

/**
* Delete a fine-tuned model. You must have the Owner role in your organization.
* Delete a fine-tuned model. You must have the Owner role in your organization to
* delete a model.
*/
del(model: string, options?: Core.RequestOptions): Core.APIPromise<ModelDeleted> {
return this.delete(`/models/${model}`, options);
Expand All @@ -47,7 +48,7 @@ export interface Model {
id: string;

/**
* The date and time when the model was created.
* The Unix timestamp (in seconds) when the model was created.
*/
created: number;

Expand Down

0 comments on commit 664e953

Please sign in to comment.