Get All Models

Returns all models for the specified dataset.

Response Body

Name

Type

Description

Available Version

data

array

Array of model objects. If the dataset has no models, the array is empty.

2.0

object

string

Object returned; in this case, list.

2.0

Training Response Body

Name

Type

Description

Available Version

algorithm

string

Algorithm used to create the model. Returned only when the modelType is text-intent.

2.0

createdAt

date

Date and time that the model was created.

2.0

datasetId

long

ID of the dataset trained to create the model.

2.0

datasetVersionId

int

N/A

2.0

failureMsg

string

Reason the dataset training failed. Returned only if the training status is FAILED.

2.0

language

string

Model language inherited from the dataset language. Default is en_US.

2.0

modelId

string

ID of the model. Contains letters and numbers.

2.0

modelType

string

Type of data from which the model was created. Valid values are:

  • text-intent
  • text-sentiment

2.0

name

string

Name of the model.

2.0

object

string

Object returned; in this case, model.

2.0

progress

float

How far the dataset training has progressed. Values are between 0–1.

2.0

status

string

Status of the model. Valid values are:

  • QUEUED—The training job is in the queue.
  • RUNNING—The training job is running.
  • SUCCEEDED—The training job succeeded, and you can use the model.
  • FAILED—The training job failed.

2.0

updatedAt

date

Date and time that the model was last updated.

2.0

Page Through Models

By default, this call returns 100 models. If you want to page through your models, use the offset and count query parameters.

Name

Type

Description

Available Version

count

int

Number of models to return. Maximum valid value is 100. If you specify a number greater than 100, the call returns 100 models. Optional.

1.0

offset

int

Index of the dataset from which you want to start paging. Optional.

1.0

Here's an example of these query parameters. If you omit the offset parameter, paging starts at 0.

curl -X GET -H "Authorization: Bearer <TOKEN>" -H "Cache-Control: no-cache" "https://api.einstein.ai/v2/language/datasets/<DATASET_ID>/models?offset=5&count=5"
Language