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

Question Answering Projects - Import

参考

服务:: Cognitive Services - Language

API 版本:: 2023-04-01

导入项目资产。

POST {Endpoint}/language/authoring/query-knowledgebases/projects/{projectName}/:import?api-version=2023-04-01

具有可选参数:

POST {Endpoint}/language/authoring/query-knowledgebases/projects/{projectName}/:import?api-version=2023-04-01&format={format}&assetKind={assetKind}

URI 参数

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

请求正文

名称	类型	说明
assets	Assets	此项目的所有资产。
fileUri	string	导入数据文件 URI。
metadata	CreateProjectOptions	创建项目所需的参数。

响应

名称	类型	说明
202 Accepted		带有用于检查作业状态的 Operation-Location 标头的成功调用结果。标头 Operation-Location: string
Other Status Codes	ErrorResponse	错误响应。

名称

类型

说明

202 Accepted

带有用于检查作业状态的 Operation-Location 标头的成功调用结果。

标头

Operation-Location: string

Other Status Codes

ErrorResponse

错误响应。

安全性

AADToken

这些是 Azure Active Directory OAuth2 流。与 Azure 基于角色的访问控制配对时，它可用于控制对Azure Maps REST API 的访问。 Azure 基于角色的访问控制用于指定对一个或多个Azure Maps资源帐户或子资源的访问权限。可以通过内置角色或由一个或多个权限组成的自定义角色授予任何用户、组或服务主体的访问权限，以Azure Maps REST API。

若要实现方案，建议查看身份验证概念。总之，此安全定义提供了一种解决方案，用于通过能够对特定 API 和作用域进行访问控制的对象对应用程序 () 建模。

备注

此安全定义需要使用x-ms-client-id 标头来指示应用程序请求访问的Azure Maps资源。这可以从地图管理 API 获取。

Authorization URL特定于 Azure 公有云实例。主权云具有唯一的授权 URL 和 Azure Active Directory 配置。 * Azure 基于角色的访问控制是通过 Azure 门户、PowerShell、CLI、Azure SDK 或 REST API 从 Azure 管理平面配置的。 * 使用 Azure Maps Web SDK 允许针对多个用例对应用程序进行基于配置的设置。

目前，Azure Active Directory v1.0 或 v2.0 支持工作、学校和来宾，但不支持个人帐户。

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

作用域

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

Ocp-Apim-Subscription-Key

语言服务资源的订阅密钥。

类型: apiKey
在: header

示例

Successful query

示例请求

HTTP

POST {Endpoint}/language/authoring/query-knowledgebases/projects/proj1/:import?api-version=2023-04-01

{
  "assets": {
    "synonyms": [
      {
        "alterations": [
          "wa",
          "washington",
          "washington state"
        ]
      },
      {
        "alterations": [
          "U.S",
          "usa",
          "united states of america"
        ]
      }
    ],
    "qnas": [
      {
        "lastUpdatedDateTime": "2021-05-01T17:21:14Z",
        "id": 1,
        "answer": "ans1",
        "source": "source1",
        "questions": [
          "question 1.1",
          "question 1.2"
        ],
        "metadata": {
          "k1": "v1",
          "k2": "v2"
        },
        "dialog": {
          "isContextOnly": false,
          "prompts": [
            {
              "displayOrder": 1,
              "qnaId": 2,
              "displayText": "prompt 1.1"
            }
          ]
        }
      },
      {
        "lastUpdatedDateTime": "2021-05-01T17:21:14Z",
        "id": 2,
        "answer": "ans2",
        "source": "source2",
        "questions": [
          "question 2.1",
          "question 2.2"
        ]
      }
    ]
  }
}

示例响应

状态代码:: 202

Operation-Location: https:///language/authoring/query-knowledgebases/projects/proj1/import/jobs/job1?api-version=2023-04-01

定义

名称	说明
Assets	此项目的所有资产。
CreateProjectOptions	创建项目所需的参数。
Error	错误对象。
ErrorCode	用户可读的错误代码。
ErrorResponse	错误响应。
format	知识库导入或导出格式。
ImportJobOptions	需要导入的项目资产。
ImportQnaRecord	导入 QnA 记录。
InnerErrorCode	用户可读的错误代码。
InnerErrorModel	包含有关错误的更具体信息的对象。根据 Microsoft One API 指南 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。
ProjectSettings	项目的可配置设置。
QnaDialog	与 QnA 记录关联的对话框。
QnaPrompt	提示输入答案。
QnaRecord	QnA 记录。
SuggestedQuestion	主动学习功能建议的问题。
SuggestedQuestionsCluster	主动学习建议的问题群集详细信息。
WordAlterations	单词更改的集合。

Assets

此项目的所有资产。

名称	类型	说明
qnas	ImportQnaRecord[]	要导入的 QnA 记录的列表。
synonyms	WordAlterations[]	同义词的集合。

CreateProjectOptions

创建项目所需的参数。

名称	类型	说明
description	string	项目的说明。
language	string	文本记录的语言。这是语言的 BCP-47 表示形式。例如，将“en”用于英语;西班牙语等的“es”。如果未设置，则默认使用英语的“en”。
multilingualResource	boolean	设置为 true 可启用为同一资源创建不同语言的知识库。
settings	ProjectSettings	项目的可配置设置。

Error

错误对象。

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

ErrorCode

用户可读的错误代码。

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

format

知识库导入或导出格式。

名称	类型	说明
excel	string	导出或导入知识库副本 (replica) 包括 Tsv 格式的所有资产和元数据。
json	string	以 JSON 格式导出或导入 QnA 资产。
tsv	string	导出或导入知识库副本 (replica) 包括 Excel 格式的所有资产和元数据。

ImportJobOptions

需要导入的项目资产。

名称	类型	说明
assets	Assets	此项目的所有资产。
fileUri	string	导入数据文件 URI。
metadata	CreateProjectOptions	创建项目所需的参数。

ImportQnaRecord

导入 QnA 记录。

名称	类型	说明
activeLearningSuggestions	SuggestedQuestionsCluster[]	QnA 的主动学习建议列表。
answer	string	回答文本。
dialog	QnaDialog	QnA 的上下文。
id	integer	QnA 的唯一 ID。
lastUpdatedDateTime	string	上次更新 QnA 的日期时间。
metadata	object	与答案关联的元数据，可用于对问题答案进行分类或筛选。
questions	string[]	与答案关联的问题列表。
source	string	从中为 QnA 编制索引的源，例如 https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs 。
sourceDisplayName	string	源的友好名称。

InnerErrorCode

用户可读的错误代码。

名称	类型	说明
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

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

ProjectSettings

项目的可配置设置。

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

QnaDialog

与 QnA 记录关联的对话框。

名称	类型	说明
isContextOnly	boolean	标记提示是否仅与上一个问题相关。如果为 true，则对于没有上下文的查询，请不要将此 QnA 作为答案;否则，将忽略上下文并在答案中包含此 QnA。
prompts	QnaPrompt[]	与答案关联的提示列表。

QnaPrompt

提示输入答案。

名称	类型	说明
displayOrder	integer	提示的索引。它用于对提示进行排序。
displayText	string	显示的文本表示跟进问题提示。
qna	QnaRecord	QnA 记录。 QnAId 或 QnA 记录需要出现在提示中。
qnaId	integer	与提示对应的 QnA 的 ID。

QnaRecord

QnA 记录。

名称	类型	说明
activeLearningSuggestions	SuggestedQuestionsCluster[]	QnA 的主动学习建议列表。
answer	string	回答文本。
dialog	QnaDialog	QnA 的上下文。
id	integer	QnA 的唯一 ID。
metadata	object	与答案关联的元数据，可用于对问题答案进行分类或筛选。
questions	string[]	与答案关联的问题列表。
source	string	从中为 QnA 编制索引的源，例如 https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs 。

SuggestedQuestion

主动学习功能建议的问题。

名称	类型	说明
autoSuggestedCount	integer	主动学习算法自动建议问题的次数。
question	string	主动学习功能建议的问题。
userSuggestedCount	integer	用户明确建议问题的次数。

SuggestedQuestionsCluster

主动学习建议的问题群集详细信息。

名称	类型	说明
clusterHead	string	由主动学习聚类分析算法选择为建议问题群集的头的问题。
suggestedQuestions	SuggestedQuestion[]	QnA 的所有建议问题的列表。

WordAlterations

单词更改的集合。

名称	类型	说明
alterations	string[]	单词更改的集合。

通过

Question Answering Projects - Import

URI 参数

请求正文

响应

安全性

AADToken

备注

作用域

Ocp-Apim-Subscription-Key

示例

Successful query

示例请求

示例响应

定义

Assets

CreateProjectOptions

Error

ErrorCode

ErrorResponse

format

ImportJobOptions

ImportQnaRecord

InnerErrorCode

InnerErrorModel

ProjectSettings

QnaDialog

QnaPrompt

QnaRecord

SuggestedQuestion

SuggestedQuestionsCluster

WordAlterations

其他资源