Question Answering Projects - Deploy Project
Deploy project to production.
PUT {Endpoint}/language/authoring/query-knowledgebases/projects/{projectName}/deployments/{deploymentName}?api-version=2023-04-15-previewURI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
|
deployment
|
path | True |
string |
The name of the specific deployment of the project to use. |
|
project
|
path | True |
string |
The name of the project to use. |
|
api-version
|
query | True |
string |
Client API version. |
Responses
| Name | Type | Description |
|---|---|---|
| 202 Accepted |
A successful call results with an Operation-Location header used to check the status of the job. Headers Operation-Location: string |
|
| Other Status Codes |
Error response. |
Security
AADToken
These are the Azure Active Directory OAuth2 Flows. When paired with Azure role-based access control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.
To implement scenarios, we recommend viewing authentication concepts. In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.
Notes
- This security definition requires the use of the
x-ms-client-idheader to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the Maps management API.
The Authorization URL is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations.
*
The Azure role-based access control is configured from the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.
*
Usage of the Azure Maps Web SDK allows for configuration based setup of an application for multiple use cases.
- Currently, Azure Active Directory v1.0 or v2.0 supports Work, School, and Guests but does not support Personal accounts.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
| Name | Description |
|---|---|
| https://cognitiveservices.azure.com/.default | https://cognitiveservices.azure.com/.default |
Ocp-Apim-Subscription-Key
A subscription key for a Language service resource.
Type:
apiKey
In:
header
Examples
Successful query
Sample request
PUT {Endpoint}/language/authoring/query-knowledgebases/projects/proj1/deployments/production?api-version=2023-04-15-preview
Sample response
Operation-Location: https:///language/authoring/query-knowledgebases/projects/proj1/deployments/production/jobs/job1?api-version=2023-04-15-preview Definitions
| Name | Description |
|---|---|
| Error |
The error object. |
|
Error |
Human-readable error code. |
|
Error |
Error response. |
|
Inner |
Human-readable error code. |
|
Inner |
An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses. |
Error
The error object.
| Name | Type | Description |
|---|---|---|
| code |
One of a server-defined set of error codes. |
|
| details |
Error[] |
An array of details about specific errors that led to this reported error. |
| innererror |
An object containing more specific information than the current object about the error. |
|
| message |
string |
A human-readable representation of the error. |
| target |
string |
The target of the error. |
ErrorCode
Human-readable error code.
| Name | Type | Description |
|---|---|---|
| AzureCognitiveSearchIndexLimitReached |
string |
|
| AzureCognitiveSearchIndexNotFound |
string |
|
| AzureCognitiveSearchNotFound |
string |
|
| AzureCognitiveSearchThrottling |
string |
|
| Conflict |
string |
|
| Forbidden |
string |
|
| InternalServerError |
string |
|
| InvalidArgument |
string |
|
| InvalidRequest |
string |
|
| NotFound |
string |
|
| OperationNotFound |
string |
|
| ProjectNotFound |
string |
|
| QuotaExceeded |
string |
|
| ServiceUnavailable |
string |
|
| Timeout |
string |
|
| TooManyRequests |
string |
|
| Unauthorized |
string |
|
| Warning |
string |
ErrorResponse
Error response.
| Name | Type | Description |
|---|---|---|
| error |
The error object. |
InnerErrorCode
Human-readable error code.
| Name | Type | Description |
|---|---|---|
| AzureCognitiveSearchNotFound |
string |
|
| AzureCognitiveSearchThrottling |
string |
|
| EmptyRequest |
string |
|
| ExtractionFailure |
string |
|
| InvalidCountryHint |
string |
|
| InvalidDocument |
string |
|
| InvalidDocumentBatch |
string |
|
| InvalidParameterValue |
string |
|
| InvalidRequest |
string |
|
| InvalidRequestBodyFormat |
string |
|
| KnowledgeBaseNotFound |
string |
|
| MissingInputDocuments |
string |
|
| ModelVersionIncorrect |
string |
|
| UnsupportedLanguageCode |
string |
InnerErrorModel
An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
| Name | Type | Description |
|---|---|---|
| code |
One of a server-defined set of error codes. |
|
| details |
object |
Error details. |
| innererror |
An object containing more specific information than the current object about the error. |
|
| message |
string |
Error message. |
| target |
string |
Error target. |