Sign in

v1

latestSwagger 2.0raw.githubusercontent.com2022-07-014922.4 KB
Intent

Get description of a model, model can still be in training and not available for predictions

Retrieves the dataset for the given dataset ID. It only displays the metadata corresponding to the dataset. If you want to view the individual intent phrases that you have added, you can use the dataset section of the dashboard.

get/api/v1/datasets/{datasetId}

Path parameters

datasetIdstring required

Unique ID for the dataset. You can obtain the IDs either from the dataset section in the dashboard or by listing the datasets with the Intent API.

Response

A successful response.

datasetIdstring uuid

The unique ID for the dataset.

intentsstring[]

The collection of intents that were added to this dataset.

isTemplateboolean

Describes if this dataset is a template dataset or not. Template datasets are used as examples and can be found under the Templates tab in the dataset overview of the dashboard. You can clone such datasets to kickstart the creation of a dataset that is tailored to your use-case.

namestring

The name of the dataset. You can configure the name once creating a dataset in the dashboard.

createdAtstring timestamp

The timestamp of dataset creation. Uses the ISO-8601 standard.

updatedAtstring timestamp

The timestamp of last update. Uses the ISO-8601 standard.

descriptionstring

The optional description of the dataset.

lastTrainedAtstring timestamp

The timestamp of last model that completed training. Uses the ISO-8601 standard. If there is not a model trained already, this field will not be populated.

Example response

{
  "createdAt": "2021-08-24T12:04:32Z",
  "datasetId": "dde4eeae-7652-4bc8-8be1-1cd6ac898dc7",
  "description": "This dataset is clearly some awesome dataset.",
  "intents": [
    "order",
    "reservation"
  ],
  "isTemplate": false,
  "lastTrainedAt": "2021-08-24T12:04:32Z",
  "name": "My awesome dataset",
  "updatedAt": "2021-08-24T12:04:32Z"
}