agsamantha/node_modules/openai/resources/models.d.ts

58 lines
1.8 KiB
TypeScript
Raw Permalink Normal View History

2024-10-02 15:15:21 -05:00
import { APIResource } from "../resource.js";
import * as Core from "../core.js";
import * as ModelsAPI from "./models.js";
import { Page } from "../pagination.js";
export declare class Models extends APIResource {
/**
* Retrieves a model instance, providing basic information about the model such as
* the owner and permissioning.
*/
retrieve(model: string, options?: Core.RequestOptions): Core.APIPromise<Model>;
/**
* Lists the currently available models, and provides basic information about each
* one such as the owner and availability.
*/
list(options?: Core.RequestOptions): Core.PagePromise<ModelsPage, Model>;
/**
* 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>;
}
/**
* Note: no pagination actually occurs yet, this is for forwards-compatibility.
*/
export declare class ModelsPage extends Page<Model> {
}
/**
* Describes an OpenAI model offering that can be used with the API.
*/
export interface Model {
/**
* The model identifier, which can be referenced in the API endpoints.
*/
id: string;
/**
* The Unix timestamp (in seconds) when the model was created.
*/
created: number;
/**
* The object type, which is always "model".
*/
object: 'model';
/**
* The organization that owns the model.
*/
owned_by: string;
}
export interface ModelDeleted {
id: string;
deleted: boolean;
object: string;
}
export declare namespace Models {
export import Model = ModelsAPI.Model;
export import ModelDeleted = ModelsAPI.ModelDeleted;
export import ModelsPage = ModelsAPI.ModelsPage;
}
//# sourceMappingURL=models.d.ts.map