Models
Resource for operations related to models.
Class: Models
Resource for operations related to models.
Extends
Constructors
Constructor
new Models(
api):Models
Create a new resource.
Parameters
api
API client instance used to communicate with WriftAI's API.
Returns
Models
Inherited from
Methods
create()
create(
options,signal?):Promise<ModelWithDetails>
Create a model.
Parameters
options
Parameters for creating a model.
signal?
AbortSignal
Optional AbortSignal to cancel the request.
Returns
Promise<ModelWithDetails>
The new model.
delete()
delete(
owner,name,signal?):Promise<void>
Delete a model.
Parameters
owner
string
Username of the model's owner.
name
string
Name of the model.
signal?
AbortSignal
Optional AbortSignal to cancel the request.
Returns
Promise<void>
get()
get(
owner,name,signal?):Promise<ModelWithDetails>
Get a model.
Parameters
owner
string
Username of the model's owner.
name
string
Name of the model.
signal?
AbortSignal
Optional AbortSignal to cancel the request.
Returns
Promise<ModelWithDetails>
A model object.
list()
list(
options?,owner?,signal?):Promise<PaginatedResponse<Model>>
List models.
Parameters
options?
Optional settings to control pagination behavior.
owner?
string
Optional username of the model's owner to fetch models for. If not passed, all models are fetched.
signal?
AbortSignal
Optional AbortSignal to cancel the request.
Returns
Promise<PaginatedResponse<Model>>
Paginated response containing models and navigation metadata.
search()
search(
q,options?,signal?):Promise<PaginatedResponse<Model>>
Search models.
Parameters
q
string
The search query.
options?
Optional settings to control pagination behavior.
signal?
AbortSignal
Optional AbortSignal to cancel the request.
Returns
Promise<PaginatedResponse<Model>>
Paginated response containing models and navigation metadata.
update()
update(
owner,name,params,signal?):Promise<ModelWithDetails>
Update a model.
Parameters
owner
string
Username of the model's owner.
name
string
Name of the model.
params
The fields to update.
signal?
AbortSignal
Optional AbortSignal to cancel the request.
Returns
Promise<ModelWithDetails>
The updated model.