Application configurations

An application configuration associates an app ID with the Mix.asr, Mix.nlu, and Mix.dialog resources deployed in a runtime environment.

An application with configurations that include dialog builds is a bot.

For more information, see Create and deploy applications.

Get list of application configurations

GET /v4/apps/{applicationId}/app-configs

Retrieve the list of application configurations available in the Mix application specified.

Responses

Status	Meaning	Description	Schema
200	OK	List of application configurations	mix.api.ListApplicationConfigsResponse
401	Unauthorized	Request could not be authorized	Inline
404	Not Found	No content found	Inline
500	Internal Server Error	Internal server error	Inline
default	Default	An unexpected error response.	grpc.gateway.runtime.Error

Example responses

200 response

{
  "configs": [
    {
      "id": "670",
      "tag": "A35_C670",
      "deployments": [
        {
          "id": "38",
          "status": "DEPLOYED",
          "envGeographyDeployments": [
            {
              "id": "645",
              "envGeography": {
                "id": "37",
                "geography": {
                  "id": "1",
                  "displayName": "US"
                },
                "envType": "SANDBOX",
                "envHost": "api.nuance.com",
                "envName": "Sandbox"
              },
              "status": "DEPLOYED",
              "deploymentResult": "success",
              "isOverridden": false,
              "dataHosts": []
            }
          ]
        }
      ],
      "parentId": "",
      "deploymentFlowId": 38,
      "builds": {
        "asr": {
          "builds": [
            {
              "locale": "fr-FR",
              "buildVersion": "1",
              "buildLabel": "ASR_17100_1",
              "createTime": "2020-07-16T20:40:15Z"
            },
            {
              "locale": "en-US",
              "buildVersion": "2",
              "buildLabel": "ASR_17100_2",
              "createTime": "2020-07-16T20:40:25Z"
            }
          ],
          "projectId": "17100"
        },
        "nlu": {
          "builds": [
            {
              "locale": "fr-FR",
              "buildVersion": "1",
              "buildLabel": "NLU_17100_1",
              "createTime": "2020-07-16T20:40:11Z"
            },
            {
              "locale": "en-US",
              "buildVersion": "2",
              "buildLabel": "NLU_17100_2",
              "createTime": "2020-07-16T20:40:20Z"
            }
          ],
          "projectId": "17100"
        }
      },
      "projectDetails": {
        "projectId": "17100",
        "projectName": "CoffeeApp MultiLang",
        "isChildDataCompliant": true,
        "projectDescription": ""
      },
      "createTime": "2020-07-20T18:38:22Z"
    }
  ],
  "totalSize": 1
}

Create an application configuration

POST /v4/apps/{applicationId}/app-configs

Create a new application configuration.

Parameters

Name	In	Type	Description
applicationId	path	string	ID of Mix application under which the configuration will be created.
useLatestFromProject	query	string	Specify a project ID to use the latest models that were built for this project. If useLatestFromProject is specified, the models set in the body field will be ignored.
buildTypes	query	array[string]	Use only the build types specified. Applies only when useLatestFromProject is set.
locales	query	array[string]	Use only the build locales specified, where applicable. Applies only when useLatestFromProject is set.
useProjectDefault	query	boolean	When set to true, the default data hosts will be used, where applicable.
body	body	mix.api.ApplicationConfigContent	Application configuration to create.

Detailed descriptions

buildTypes: Use only the build types specified. Applies only when useLatestFromProject is set.

NLU: NLU build
ASR: ASR build
DIALOG: Dialog build

Body parameter

{
  "dataHosts": [
    {
      "id": "string",
      "alias": "string",
      "environmentId": "string",
      "environmentGeographyId": "string",
      "value": "string"
    }
  ],
  "deploymentFlowId": "string",
  "tag": "string",
  "requestBuilds": {
    "asr": [
      {
        "buildLabel": "string",
        "locale": "string"
      }
    ],
    "nlu": [
      {
        "buildLabel": "string",
        "locale": "string"
      }
    ],
    "dialog": {
      "buildLabel": "string"
    }
  },
  "environmentConfigurations": [
    {
      "label": "ECL_UNSPECIFIED",
      "value": "string",
      "environmentId": "string",
      "environmentGeographyId": "string"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	Application configuration successfully created	mix.api.CreateApplicationConfigResponse
400	Bad Request	Request contains invalid arguments	Inline
401	Unauthorized	Request could not be authorized	Inline
404	Not Found	Application not found	Inline
500	Internal Server Error	Internal server error	Inline
default	Default	An unexpected error response.	grpc.gateway.runtime.Error

Example responses

200 response

Get application configuration

GET /v4/app-configs/{configId}

Retrieve an application configuration.

Responses

Status	Meaning	Description	Schema
200	OK	Application configuration	mix.api.GetApplicationConfigResponse
401	Unauthorized	Request could not be authorized	Inline
404	Not Found	No content found	Inline
500	Internal Server Error	Internal server error	Inline
default	Default	An unexpected error response.	grpc.gateway.runtime.Error

Example responses

200 response

Delete an application configuration

DELETE /v4/app-configs/{configId}

Delete an application configuration.

Responses

Status	Meaning	Description	Schema
200	OK	Application configuration successfully deleted	google.rpc.Status
401	Unauthorized	Request could not be authorized	Inline
404	Not Found	Application configuration not found	Inline
500	Internal Server Error	Internal server error	Inline
default	Default	An unexpected error response.	grpc.gateway.runtime.Error

Example responses

200 response

Update an application configuration

PUT /v4/app-configs/{configId}

Add/reset the builds and data hosts in the specified application configuration. Only allowed when the application configuration is not deployed.

Parameters

Name	In	Type	Description
configId	path	string	ID of application configuration to update.
body	body	mix.api.UpdateApplicationConfigContent	Content that will be updated in the application configuration.

Body parameter

{
  "dataHosts": [
    {
      "id": "string",
      "alias": "string",
      "environmentId": "string",
      "environmentGeographyId": "string",
      "value": "string"
    }
  ],
  "requestModels": {
    "asr": [
      {
        "buildLabel": "string",
        "locale": "string"
      }
    ],
    "nlu": [
      {
        "buildLabel": "string",
        "locale": "string"
      }
    ],
    "dialog": {
      "buildLabel": "string"
    }
  },
  "environmentConfigurations": [
    {
      "label": "ECL_UNSPECIFIED",
      "value": "string",
      "environmentId": "string",
      "environmentGeographyId": "string"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	Application configuration successfully updated	mix.api.UpdateApplicationConfigResponse
400	Bad Request	Bad request	Inline
401	Unauthorized	Request could not be authorized	Inline
404	Not Found	Application configuration not found	Inline
500	Internal Server Error	Internal server error	Inline
501	Not Implemented	Feature is not yet enabled	Inline
default	Default	An unexpected error response.	grpc.gateway.runtime.Error

Example responses

200 response

Override an existing application configuration

POST /v4/app-configs/{configId}/.override

Override an existing application configuration.

Parameters

Name	In	Type	Description
configId	path	string	ID of application configuration to override.
latest	query	boolean	When set to true, use the latest models from the project associated with the existing configuration or from the project specified in useLatestFromProject. If latest is specified, the models set in the body field will be ignored.
buildTypes	query	array[string]	Use only the build types specified. Applies only when latest is set to true.
locales	query	array[string]	Use only the build locales specified, where applicable. Applies only when latest is set to true.
useLatestFromProject	query	string	Specify a project ID to use the latest models that were built for this project. Applies only when latest is set to true.
useProjectDefault	query	boolean	When set to true, use the default data hosts, where applicable.
body	body	mix.api.OverrideApplicationConfigContent	Content that will override the existing application configuration.

Detailed descriptions

buildTypes: Use only the build types specified. Applies only when latest is set to true.

NLU: NLU build
ASR: ASR build
DIALOG: Dialog build

Body parameter

{
  "dataHosts": [
    {
      "id": "string",
      "alias": "string",
      "environmentId": "string",
      "environmentGeographyId": "string",
      "value": "string"
    }
  ],
  "requestModels": {
    "asr": [
      {
        "buildLabel": "string",
        "locale": "string"
      }
    ],
    "nlu": [
      {
        "buildLabel": "string",
        "locale": "string"
      }
    ],
    "dialog": {
      "buildLabel": "string"
    }
  },
  "environmentConfigurations": [
    {
      "label": "ECL_UNSPECIFIED",
      "value": "string",
      "environmentId": "string",
      "environmentGeographyId": "string"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	Application configuration successfully overridden	mix.api.OverrideApplicationConfigResponse
400	Bad Request	Request contains invalid arguments	Inline
401	Unauthorized	Request could not be authorized	Inline
404	Not Found	Application configuration not found	Inline
500	Internal Server Error	Internal server error	Inline
default	Default	An unexpected error response.	grpc.gateway.runtime.Error

Example responses

200 response

Download an application configuration

GET /v4/app-configs/{configId}/.download

Download the contents of an application configuration that is currently deployed in an environment.

Responses

Status	Meaning	Description	Schema
200	OK	Application configuration (zip file, with application/octet-stream content-type)	Inline
401	Unauthorized	Request could not be authorized	Inline
404	Not Found	Build not found	Inline
500	Internal Server Error	Internal server error	Inline
default	Default	An unexpected error response.	grpc.gateway.runtime.Error

Deploy an application configuration

PUT /v4/app-configs/{configId}/.deploy

Deploy an application configuration.

Parameters

Name	In	Type	Description
configId	path	string	ID of application configuration to deploy.
environmentGeographyIds	query	array[string]	List of environment geography IDs where to deploy the configuration.
body	body	object	Leave this body empty.

Responses

Status	Meaning	Description	Schema
200	OK	Application configuration successfully deployed	mix.api.DeployApplicationConfigResponse
401	Unauthorized	Request could not be authorized	Inline
404	Not Found	Build not found	Inline
500	Internal Server Error	Internal server error	Inline
default	Default	An unexpected error response.	grpc.gateway.runtime.Error

Example responses

200 response

Undeploy application configuration

PUT /v4/app-configs/{configId}/.undeploy

Undeploy an application configuration.

Parameters

Name	In	Type	Description
configId	path	string	ID of application configuration to undeploy.
environmentGeographyIds	query	array[string]	List of environment geography IDs from which to undeploy the configuration.
body	body	object	Leave this body empty.

Responses

Status	Meaning	Description	Schema
200	OK	Application configuration undeployment status	mix.api.UndeployApplicationConfigResponse
401	Unauthorized	Request could not be authorized	Inline
404	Not Found	Build not found	Inline
500	Internal Server Error	Internal server error	Inline
default	Default	An unexpected error response.	grpc.gateway.runtime.Error

Example responses

200 response

Feedback

Was this page helpful?

Glad to hear it! Please tell us how we can improve.

Sorry to hear that. Please tell us how we can improve.