Skip to main content

Retrieve models user is authorized to see.​

Parameters can be combined to filter models.

Path Parameters
  • organization string required

    organization name

Query Parameters
  • collection_id integer

    The collection ID of the model

  • public boolean

    if model is public or not

  • starred boolean

    if model is starred or not

  • type string

    Possible values: [ABSA, CLASS, LABEL, CLASSLABEL]

    model type

  • offset integer

    An offset is simply the number of records you wish to skip before selecting records.

  • limit integer

    Limit of entries that should be returned.

Responses

OK

Schema
  • models object[]

    array of objects that represent the models.

  • base string

    the name of the model used to create the modal that's being changed

  • created date-time

    creation date

  • display_name string

    a friendly name.

  • uuid uuid

    model unique identifier. Should be a UUID value

  • id integer

    Possible values: >= 1

    The ID of the model

  • language string

    Possible values: [en, de, ar]

  • long_description string

    a longer description which proper describes the model

  • name string

    internal name. It should be unique for a workspace

  • owner string
  • progress float
  • project_id integer

    The ID of the project

  • score float

    model score. As this is a result of a training session, this value shouldn't be touched

  • short_description string

    a short description to help users quickly identify the model

  • status string

    Possible values: [CREATED, QUEUED, TRAINING, FAILED, READY, ACTIVE, PUBLISHED]

    the model status

  • type string

    Possible values: [ABSA, CLASS, LABEL, CLASSLABEL]

    model type (1: BASE, 2: ABSA, 3: LABEL, 4: CLASS, 5: CLASSLABEL))

  • has_more boolean

    indicates if a new request with a different offset should be done to get more models.

  • offset integer

    An offset is simply the number of records you wish to skip before selecting records.

  • limit integer

    Limit of entries that should be returned.

  • count integer

    Number of objects returned

Loading...