Builds
You create a build for your Mix.asr, Mix.nlu, and Mix.dialog resources so that you can use them in your runtime application.
A build is identified by a buildLabel
, which has the following pattern:
service_projectId_buildVersion
Where:
- service is one of
ASR
,NLU
, orDIALOG
- projectId is the ID of the project for which the builds were created
- buildVersion is the version of the build
For example:
- NLU_11624_2
- DIALOG_525_2
For more information about builds, see Create resources.
Start a build
POST /v4/projects/{projectId}/.build
Start ASR, NLU, and/or dialog builds for a project.
Parameters
Name | In | Type | Description |
---|---|---|---|
projectId | path | string | ID of the project. |
body | body | mix.api.BuildProjectModelBody | Message that defines the builds to start. |
Body parameter
{
"asr": {
"notes": "string",
"dataSources": [
{
"locale": "string",
"names": [
"string"
]
}
]
},
"dialog": {
"notes": "string"
},
"nlu": {
"notes": "string",
"settings": {
"modelType": "LEGACY"
},
"dataSources": [
{
"locale": "string",
"names": [
"string"
]
}
]
},
"locales": [
"string"
]
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Job successfully created | mix.api.JobResponse |
400 | Bad Request | Bad request | Inline |
401 | Unauthorized | Request could not be authorized | Inline |
404 | Not Found | Project not found | Inline |
500 | Internal Server Error | Internal server error | Inline |
default | Default | An unexpected error response. | grpc.gateway.runtime.Error |
Example responses
Get builds
GET /v4/projects/{projectId}/builds
Retrieve the list of all ASR, NLU, or dialog builds for a project.
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | List of builds | mix.api.ListBuildsResponse |
401 | Unauthorized | Request could not be authorized | Inline |
404 | Not Found | Not found | Inline |
500 | Internal Server Error | Internal server error | Inline |
default | Default | An unexpected error response. | grpc.gateway.runtime.Error |
Example responses
Get latest builds
GET /v4/projects/{projectId}/builds/.latest
Retrieve the latest ASR, NLU, and dialog builds for a project.
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Latest builds for a project | mix.api.ListLatestBuildsResponse |
401 | Unauthorized | Request could not be authorized | Inline |
404 | Not Found | Not found | Inline |
500 | Internal Server Error | Internal server error | Inline |
default | Default | An unexpected error response. | grpc.gateway.runtime.Error |
Example responses
Get build details
GET /v4/builds/{buildLabel}
Retrieve the details of a build.
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Build details | mix.api.GetBuildResponse |
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
Delete a build
DELETE /v4/builds/{buildLabel}
Delete a build.
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Build successfully deleted | google.rpc.Status |
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
Download a build
GET /v4/builds/{buildLabel}/.download
Download the build resources.
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Build resource | 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 |
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.