Question Answering Projects - List Projects

服务:

Azure AI Services

API 版本:

2023-04-01

获取用户的所有项目。

GET {Endpoint}/language/authoring/query-knowledgebases/projects?api-version=2023-04-01

具有可选参数:

GET {Endpoint}/language/authoring/query-knowledgebases/projects?api-version=2023-04-01&top={top}&skip={skip}&maxpagesize={maxpagesize}

URI 参数

名称	在	必需	类型	说明
Endpoint	path	True	string (uri)	支持的认知服务终结点（例如，https://< resource-name.api.cognitiveservices.azure.com>）。
api-version	query	True	string minLength: 1	要用于此操作的 API 版本。
maxpagesize	query		integer (int32)	单个响应中要包含的最大资源数。
skip	query		integer (int32)	要返回的第一个资源的集合中的偏移量。
top	query		integer (int32)	要从集合返回的最大资源数。

响应

名称	类型	说明
200 OK	PagedQuestionAnsweringProjectMetadata	请求已成功。
Other Status Codes	ErrorResponse	意外错误响应。 标头 x-ms-error-code: string

安全性

Ocp-Apim-Subscription-Key

类型: apiKey
在: header

OAuth2Auth

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
https://cognitiveservices.azure.com/.default

示例

Successful query

示例请求

HTTP

GET {Endpoint}/language/authoring/query-knowledgebases/projects?api-version=2023-04-01

示例响应

状态代码:

200

{
  "value": [
    {
      "description": "proj1 is a test project.",
      "createdDateTime": "2021-05-01T15:13:22Z",
      "lastDeployedDateTime": "2021-05-01T15:13:22Z",
      "lastModifiedDateTime": "2021-05-01T15:13:22Z",
      "multilingualResource": true,
      "projectName": "proj1",
      "language": "en"
    },
    {
      "description": "proj2 is a test project.",
      "createdDateTime": "2021-05-01T15:13:22Z",
      "lastDeployedDateTime": "2021-05-01T15:13:22Z",
      "lastModifiedDateTime": "2021-05-01T15:13:22Z",
      "multilingualResource": true,
      "projectName": "proj2",
      "language": "fr"
    }
  ]
}

定义

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

Error

Object

错误对象。

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

ErrorCode

枚举

人工可读错误代码。

值	说明
InvalidRequest	请求错误无效
InvalidArgument	参数错误无效
Unauthorized	未经授权的访问错误
Forbidden	禁止访问错误
NotFound	找不到错误
ProjectNotFound	项目找不到错误
OperationNotFound	找不到操作错误
AzureCognitiveSearchNotFound	Azure 认知搜索找不到错误
AzureCognitiveSearchIndexNotFound	Azure 认知搜索索引找不到错误
TooManyRequests	请求过多错误
AzureCognitiveSearchThrottling	Azure 认知搜索限制错误
AzureCognitiveSearchIndexLimitReached	Azure 认知搜索索引限制达到错误
InternalServerError	内部服务器错误
ServiceUnavailable	服务不可用错误
Timeout	超时错误
QuotaExceeded	超出配额错误
Conflict	冲突错误
Warning	警告错误

ErrorResponse

Object

错误响应。

名称	类型	说明
error	Error	错误对象。

InnerErrorCode

枚举

人工可读错误代码。

值	说明
InvalidRequest	请求错误无效
InvalidParameterValue	参数值错误无效
KnowledgeBaseNotFound	知识库找不到错误
AzureCognitiveSearchNotFound	Azure 认知搜索找不到错误
AzureCognitiveSearchThrottling	Azure 认知搜索限制错误
ExtractionFailure	提取失败错误
InvalidRequestBodyFormat	请求正文格式错误无效
EmptyRequest	空请求错误
MissingInputDocuments	缺少输入文档错误
InvalidDocument	文档错误无效
ModelVersionIncorrect	模型版本错误错误
InvalidDocumentBatch	文档批处理错误无效
UnsupportedLanguageCode	不支持的语言代码错误
InvalidCountryHint	国家/地区提示错误无效

InnerErrorModel

Object

包含有关错误的更具体信息的对象。 根据Microsoft一个 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	错误目标。

PagedQuestionAnsweringProjectMetadata

Object

QuestionAnsweringProjectMetadata 项的分页集合

名称	类型	说明
nextLink	string (uri)	指向下一页项的链接
value	QuestionAnsweringProjectMetadata[]	此页上的 QuestionAnsweringProjectMetadata 项

ProjectSettings

Object

项目的可配置设置。

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

QuestionAnsweringProjectMetadata

Object

表示项目。

名称	类型	说明
createdDateTime	string (date-time)	项目创建日期时间。
description	string	项目的说明。
language	string	文本记录的语言。 这是语言的 BCP-47 表示形式。 例如，将“en”用于英语;西班牙语等的“es”。如果未设置，请将“en”用于英语作为默认值。
lastDeployedDateTime	string (date-time)	表示上次部署日期时间的项目。
lastModifiedDateTime	string (date-time)	表示上次修改的日期时间的项目。
multilingualResource	boolean	为跨项目启用多种语言的资源。
projectName	string maxLength: 100 pattern: ^(?=[a-zA-Z0-9])[a-zA-Z0-9-]{0,98}[a-zA-Z0-9]$	项目名称。
settings	ProjectSettings	项目的可配置设置。