Sign in
Engine

Partial update engine

Update part of an engine object.

patch/api/v1/engines/{engineID}

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.

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"
  }
}

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.

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"
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.