ROrossum
Engine

Partial update engine

Changed on

Update part of an engine object.

patch/api/v1/engines/{engineID}

Request

Path parameters

engineIDinteger required

ID of the engine

Request body

idinteger

Engine object ID.

urlstring uri

Engine object URL.

namestring

Name of the engine.

type'extractor' | 'splitter'

Type of the engine. Allowed values are:

  • extractor: Engine used for data extraction
  • splitter: Engine used for splitting of documents
learning_enabledboolean

Whether is the engine learning from the attached queues.

descriptionstring

Description of the engine.

agenda_idstring

Unique identifier of the engine.

organizationstring uri

Organization URL.

training_queuesstring[] nullable

Queues that are used for training the engine. Queues that become assigned to the engine are added to the list automatically.

created_bystring uri nullable

User that created the object.

created_atstring date-time

Timestamp of object's creation.

modified_bystring uri nullable

User that last modified the object.

modified_atstring date-time nullable

Timestamp of last modification.

Example request

{
  "id": 3,
  "url": "https://example.rossum.app/api/v1/engines/8",
  "name": "Engine name",
  "type": "extractor",
  "learning_enabled": true,
  "description": "AI engine trained to recognize data for the specific data capture requirement",
  "agenda_id": "ross_a9d9vkl1",
  "organization": "https://example.rossum.app/api/v1/organizations/406",
  "training_queues": [
    "https://example.rossum.app/api/v1/queues/8199",
    "https://example.rossum.app/api/v1/queues/8236"
  ],
  "settings": {
    "use_case": "generic_ap"
  },
  "created_by": "https://example.rossum.app/api/v1/users/10775",
  "created_at": "2021-04-26T10:08:03.856648Z",
  "modified_by": "https://example.rossum.app/api/v1/users/10775",
  "modified_at": "2021-04-26T10:08:03.856648Z"
}

Response

OK

idinteger required

Engine object ID.

urlstring uri required

Engine object URL.

namestring required

Name of the engine.

type'extractor' | 'splitter' required

Type of the engine. Allowed values are:

  • extractor: Engine used for data extraction
  • splitter: Engine used for splitting of documents
learning_enabledboolean required

Whether is the engine learning from the attached queues.

descriptionstring required

Description of the engine.

agenda_idstring required

Unique identifier of the engine.

organizationstring uri required

Organization URL.

training_queuesstring[] nullable required

Queues that are used for training the engine. Queues that become assigned to the engine are added to the list automatically.

created_bystring uri nullable required

User that created the object.

created_atstring date-time required

Timestamp of object's creation.

modified_bystring uri nullable required

User that last modified the object.

modified_atstring date-time nullable required

Timestamp of last modification.

Example response

{
  "id": 3,
  "url": "https://example.rossum.app/api/v1/engines/8",
  "name": "Engine name",
  "type": "extractor",
  "learning_enabled": true,
  "description": "AI engine trained to recognize data for the specific data capture requirement",
  "agenda_id": "ross_a9d9vkl1",
  "organization": "https://example.rossum.app/api/v1/organizations/406",
  "training_queues": [
    "https://example.rossum.app/api/v1/queues/8199",
    "https://example.rossum.app/api/v1/queues/8236"
  ],
  "settings": {
    "use_case": "generic_ap"
  },
  "created_by": "https://example.rossum.app/api/v1/users/10775",
  "created_at": "2021-04-26T10:08:03.856648Z",
  "modified_by": "https://example.rossum.app/api/v1/users/10775",
  "modified_at": "2021-04-26T10:08:03.856648Z"
}

Changes

  • a32108736fa5Revision changes
    • info

      the request property default value changed from {} to {"use_case":"generic_ap"}

    • info

      the response's property default value changed from {} to {"use_case":"generic_ap"} for the status

  • e050e5c8602cRevision changes
    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status