Edit

Automation plugins

Automation plugins provide a capability to interact with VDS services from Bot Tasks.

automation-start-eval

The plugin sends the request to the Gateway service to start a new evaluation.

The properties below should be defined as follows:

tableau.db.url=jdbc:postgresql://host:5432/%db_name%
tableau.db.user=%user%
tableau.db.password=%password%

The attributes are as follows:

Name	Required	Description
model-name	Yes	Name (code) of the model to evaluate
model-version	Yes	Version of the model to be evaluated
egid	Yes	experimentGroup UUID used to upload input or output to S3 and then for extraction
parameters	No	Additional parameters if any required by the model sent as a stringified JSON
advanced-calibration-required	No	Include advanced calibration for Tableau. Not recommended to use.

The response contains the stringified JSON with two attributes:

• responseStatus: an HTTP status of the request.
• responseBody: a response string from the Gateway service.

Example:

<?xml version="1.0" encoding="UTF-8"?>
<config>

    ...
    <var-def name='startEvalResult'>
        <automation-start-eval model-name='${_sys_automation_tags}' model-version='${_sys_model_version}' egid='${experimentGroup}' parameters='${answersJson}'/>
    </var-def>
</config>

automation-get-eval-result

The plugin gets the DUCC job status from the Gateway service.

The attributes are as follows:

Name	Required	Description
egid	Yes	The experimentGroup UUID of the running evaluation

The response contains the stringified JSON with 2 attributes:

• responseStatus: HTTP status of request
• responseBody: response string from Gateway service

Example:

<?xml version="1.0" encoding="UTF-8"?>
<config>

    ...
    <var-def name='getEvalResult'>
        <automation-get-eval-result egid='${experimentGroup}'/>
    </var-def>
</config>

automation-extract

The plugin sends the extract request to the Gateway service.

The attributes are as follows:

Name	Required	Description
model-name	Yes	Name (code) of the model to be evaluated
model-version	Yes	Version of the model to be evaluated
egid	Yes	experimentGroup UUID to identify what trained model to use
experiment-id	Yes	The best experiment ID from the evaluation
document	Yes	Document to extract
api-version	No	Plugin version to choose the correct the vds-gateway-service API. Available values: 1 (default): Calls VDS Gateway Service REST API Extract v1 2: Calls VDS Gateway Service REST API Extract v1
parameters	No	Additional parameters provided to vds-gateway-service. Passed as a JSON containing a map with a string key and an object value.

The response contains the stringified JSON with two attributes:

• responseStatus: HTTP status of request
• responseBody: response string from Gateway service

Example:

<?xml version="1.0" encoding="UTF-8"?>
<config>

    ...
    <var-def name='extractResult'>
        <automation-extract model-name='${automationInfo.modelType}' model-version='${automationInfo.modelVersion}' egid='${automationInfo.experimentGroup}' experiment-id='${automationInfo.experimentId}' document='${documentJson}'/>
    </var-def>
</config>

note

If any exceptions are thrown in plugins, responseStatus is 502.