Edit

AutoML plugins

AutoML plugins allow interacting with AutoML services from Bot Tasks.

Train flow

automl-train-start

The plugin sends a request to start training to AutoML services and contains the following attributes:

Name	Required	Description
version	Yes	Plugin version: 1 for IA Cloud Enterprise version 10.x.
timeout	No	Request a connection and read timeout in milliseconds. If not defined, request without a timeout.
model-id	Yes	Provide an ID used as a trained model ID.
model-artifact-id	Yes	Model identification in the following format: <model-code>:<model-version>.
fields	Yes	Trained fields as JSON. See FieldInfo for more information.
parameters	No	Additional parameters in the <parameter name, parameter value> format mapped as JSON.

The response contains a stringified JSON with the following attributes:

• status: request status code

• body: response message

Response example

<?xml version="1.0" encoding="UTF-8"?>
<config>
...
<var-def name='startTrainResult'>
    <automl-train-start version='1'
                        model-id='${experimentGroup}'
                        model-artifact-id='${modelArtifactId}'
                        fields='${fieldInfosJson}'
                        parameters='${parameters}'
    />
</var-def>
...
</config>

automl-train-status

The plugin sends a request to get training status from AutoML services and contains the following attributes:

Name	Required	Description
version	Yes	Plugin version: 1 for IA Cloud Enterprise version 10.x.
timeout	No	Request a connection and read timeout in milliseconds. If not defined, request without a timeout.
model-id	Yes	Provide an ID of the checked trained model.
parameters	No	Additional parameters in the <parameter name, parameter value> format mapped as JSON.

The response contains the stringified JSON with the following attributes:

• status: request status code
• body: model training status
  • body.state
  • body.message

Example

<?xml version="1.0" encoding="UTF-8"?>
<config>
...
<var-def name='trainStatusResult'>
    <automl-status version='1'
                   model-id='${experimentGroup}'
    />
</var-def>
...
</config>

Execute flow

automl-execute

warning

The automl-execute plugin is deprecated. Instead, for the same purposes, it is recommended to use the OOTB AutoML Bridge step.

The plugin sends a request to execute the model to AutoML services and contains the following attributes:

Name	Required	Description
version	Yes	Plugin version: 1 for IA Cloud Enterprise version 10.x.
timeout	No	Request a connection and read timeout in milliseconds. If not defined, request without a timeout.
model-id	Yes	Provide an ID of the trained model used for execution.
document	Yes	Document to extract.
parameters	No	Additional parameters in the <parameter name, parameter value> format mapped as JSON.

The response contains the stringified JSON with the following attributes:

• status: request status code
• body
  • body.result: model execution result

Example

<?xml version="1.0" encoding="UTF-8"?>
<config>
...
<var-def name='modelExecuteResult'>
    <automl-execute version='1'
                    model-id='${item.wrappedObject.run.automationInfo.experimentGroup}'
                    document='${documentJson}'
    />
</var-def>
...
</config>