Skip to main content

Connect an external source to Studio and pull training data from it.​

Connect an external source to Studio and pull training data from it.

Path Parameters
  • project_id integer required

    ID of the project

Request Body required
  • credential_id number required

    ID of the credential to be used to connect to the external source.

  • source string required

    A string that identifies the source

  • parameters object

    Parameters to filter the data returned by the external source.

Responses

External source has been connected.

Schema
  • created date-time

    When the session was started.

  • finished date-time

    When the session was finished.

  • document_count integer

    Total of documents

  • document_group_id integer

    ID of the document group related to the session, if any

  • organization_id integer

    ID of the organization to which the session belongs.

  • user_id integer

    ID of the user to which the session belongs.

  • project_id integer

    ID of the project to which the session belongs.

  • uuid uuid

    The unique ID of the session.

  • id integer

    The ID of the session.

  • name string

    The session's name.

  • progress float

    The session's progress.

  • model_id integer

    The ID of the model used by that session. This property only makes sense for correction sessions

  • status string

    Possible values: [CREATED, STARTED, ANNOTATING, FAILED, FINISHED, SAMPLING, PREDICTING, DELETING]

    The session's status.

  • mode string

    Possible values: [ANNOTATION, CORRECTION]

    The session's mode.

  • type string

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

    The session's classification type.

  • description string

    The session's description.

  • classes string[]

    All classes that belong to the session

  • labels string[]

    All labels that belong to the session

Loading...