Question Answering Projects - Get Project Details
Get the requested project metadata.
GET {Endpoint}/language/query-knowledgebases/projects/{projectName}?api-version=2021-10-01URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
|
Endpoint
|
path | True |
string |
Supported Cognitive Services endpoint (e.g., https://.api.cognitiveservices.azure.com). |
|
project
|
path | True |
string |
The name of the project to use. |
|
api-version
|
query | True |
string |
Client API version. |
Request Header
| Name | Required | Type | Description |
|---|---|---|---|
| Ocp-Apim-Subscription-Key | True |
string |
Responses
| Name | Type | Description |
|---|---|---|
| 200 OK |
The metadata for the specified project. |
|
| Other Status Codes |
Error response. |
Security
Ocp-Apim-Subscription-Key
Type:
apiKey
In:
header
Examples
Successful query
Sample request
GET {Endpoint}/language/query-knowledgebases/projects/proj1?api-version=2021-10-01
Sample response
{
"projectName": "proj1",
"description": "proj1 is a test project.",
"language": "en",
"settings": {
"defaultAnswer": "No good match found for your question in the Knowledgebase."
},
"createdDateTime": "2021-05-01T15:13:22Z",
"lastModifiedDateTime": "2021-05-01T15:13:22Z",
"lastDeployedDateTime": "2021-05-01T15:13:22Z"
}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. |
|
Project |
Represents the project. |
|
Project |
Configurable settings of the Project. |
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 |
|
| Forbidden |
string |
|
| InternalServerError |
string |
|
| InvalidArgument |
string |
|
| InvalidRequest |
string |
|
| NotFound |
string |
|
| OperationNotFound |
string |
|
| ProjectNotFound |
string |
|
| ServiceUnavailable |
string |
|
| TooManyRequests |
string |
|
| Unauthorized |
string |
ErrorResponse
Error response.
| Name | Type | Description |
|---|---|---|
| error |
The error object. |
InnerErrorCode
Human-readable error code.
| Name | Type | Description |
|---|---|---|
| AzureCognitiveSearchNotFound |
string |
|
| AzureCognitiveSearchThrottling |
string |
|
| ExtractionFailure |
string |
|
| InvalidParameterValue |
string |
|
| InvalidRequest |
string |
|
| KnowledgeBaseNotFound |
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. |
ProjectMetadata
Represents the project.
| Name | Type | Description |
|---|---|---|
| createdDateTime |
string |
Project creation date-time. |
| description |
string |
Description of the project. |
| language |
string |
Language of the text records. This is BCP-47 representation of a language. For example, use "en" for English; "es" for Spanish etc. If not set, use "en" for English as default. |
| lastDeployedDateTime |
string |
Represents the project last deployment date-time. |
| lastModifiedDateTime |
string |
Represents the project last modified date-time. |
| multilingualResource |
boolean |
Resource enabled for multiple languages across projects or not. |
| projectName |
string |
Name of the project. |
| settings |
Configurable settings of the Project. |
ProjectSettings
Configurable settings of the Project.
| Name | Type | Description |
|---|---|---|
| defaultAnswer |
string |
Default Answer response when no good match is found in the knowledge base. |