你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Question Answering Projects - Get Project Details

Service:

Cognitive Services

API Version:

2021-10-01

获取请求的项目元数据。

GET {Endpoint}/language/query-knowledgebases/projects/{projectName}?api-version=2021-10-01

URI 参数

名称	在	必需	类型	说明
Endpoint	path	True	string	支持的认知服务终结点 (例如 https://.api.cognitiveservices.azure.com).
projectName	path	True	string	要使用的项目的名称。
api-version	query	True	string	客户端 API 版本。

请求头

名称	必需	类型	说明
Ocp-Apim-Subscription-Key	True	string

响应

名称	类型	说明
200 OK	ProjectMetadata	指定项目的元数据。
Other Status Codes	ErrorResponse	错误响应。

安全性

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

示例

Successful query

Sample Request

HTTP

GET {Endpoint}/language/query-knowledgebases/projects/proj1?api-version=2021-10-01

Sample Response

Status code:

200

{
  "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"
}

定义

名称	说明
Error	错误对象。
ErrorCode	人类可读的错误代码。
ErrorResponse	错误响应。
InnerErrorCode	人类可读的错误代码。
InnerErrorModel	包含有关错误的更具体信息的对象。 根据 Microsoft One API 指南 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。
ProjectMetadata	表示项目。
ProjectSettings	项目的可配置设置。

Error

错误对象。

名称	类型	说明
code	ErrorCode	服务器定义的一组错误代码中的一个。
details	Error[]	有关导致此项报告错误的特定错误的详细信息数组。
innererror	InnerErrorModel	一个 对象，该对象包含比当前对象更具体的错误信息。
message	string	错误的用户可读表示形式。
target	string	错误的目标。

ErrorCode

人类可读的错误代码。

名称	类型	说明
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	Error	错误对象。

InnerErrorCode

人类可读的错误代码。

名称	类型	说明
AzureCognitiveSearchNotFound	string
AzureCognitiveSearchThrottling	string
ExtractionFailure	string
InvalidParameterValue	string
InvalidRequest	string
KnowledgeBaseNotFound	string

InnerErrorModel

包含有关错误的更具体信息的对象。 根据 Microsoft One API 指南 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。

名称	类型	说明
code	InnerErrorCode	服务器定义的一组错误代码中的一个。
details	object	错误详细信息。
innererror	InnerErrorModel	一个 对象，该对象包含比当前对象更具体的错误信息。
message	string	错误消息。
target	string	错误目标。

ProjectMetadata

表示项目。

名称	类型	说明
createdDateTime	string	项目创建日期时间。
description	string	项目的说明。
language	string	文本记录的语言。 这是语言的 BCP-47 表示形式。 例如，对英语使用“en”;西班牙语等的“es”。如果未设置，则默认使用英语的“en”。
lastDeployedDateTime	string	表示项目上次部署日期时间。
lastModifiedDateTime	string	表示项目上次修改的日期时间。
multilingualResource	boolean	是否跨项目启用了多种语言的资源。
projectName	string	项目名称。
settings	ProjectSettings	项目的可配置设置。

ProjectSettings

项目的可配置设置。

名称	类型	说明
defaultAnswer	string	在知识库中找不到良好匹配项时的默认应答响应。