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

Knowledgebase - Create

参考

服务:: Azure AI Services

API 版本:: v5.0-preview.2

用于创建新知识库的异步操作。

POST {Endpoint}/qnamaker/v5.0-preview.2/knowledgebases/create

URI 参数

名称	在	必需	类型	说明
Endpoint	path	True	string	支持的认知服务终结点（例如，https://< qnamaker-resource-name >.api.cognitiveservices.azure.com）。

请求头

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

请求正文

名称	必需	类型	说明
name	True	string minLength: 1 maxLength: 100	知识库的友好名称。
defaultAnswer		string minLength: 1 maxLength: 300	如果未在 KB 中找到匹配项，则向用户发送的默认答案。
defaultAnswerUsedForExtraction		string minLength: 1 maxLength: 300	要用作任何 Q-A 中的答案的文本字符串，其中没有从文档中提取答案，但具有层次结构。当 EnableHierarchicalExtraction 字段设置为 True 时必需。
enableHierarchicalExtraction		boolean	启用从文件和 URL 对 Q-A 进行分层提取。如果此字段不存在，则将其视为 False 的值。
enableMultipleLanguages		boolean	设置为 true，以便为同一资源使用不同的语言创建 KB。
files		FileDTO[]	要从中提取 Q-A 的文件列表。
language		string minLength: 1 maxLength: 100	知识库的语言。请在此处找到支持的语言列表。
qnaList		QnADTO[]	要添加到知识库的 Q-A（QnADTO）列表。 Q-A ID 由服务分配，应省略。
urls		string[]	用于提取 Q-A 的 URL 列表。

响应

名称	类型	说明
202 Accepted	Operation	异步作的详细信息。
Other Status Codes	ErrorResponse	错误响应。

安全性

Ocp-Apim-Subscription-Key

类型: apiKey
在: header

示例

Successful query

示例请求

HTTP

POST {Endpoint}/qnamaker/v5.0-preview.2/knowledgebases/create


{
  "name": "QnA Maker FAQ",
  "qnaList": [
    {
      "id": 0,
      "answer": "You can change the default message if you use the QnAMakerDialog. See this for details: https://docs.botframework.com/en-us/azure-bot-service/templates/qnamaker/#navtitle",
      "source": "Custom Editorial",
      "questions": [
        "How can I change the default message from QnA Maker?"
      ],
      "metadata": []
    },
    {
      "id": 0,
      "answer": "You can use our REST apis to create a KB. See here for details: https://docs.microsoft.com/en-us/rest/api/cognitiveservices/qnamaker/knowledgebase/create",
      "source": "Custom Editorial",
      "questions": [
        "How do I programmatically create a KB?"
      ],
      "metadata": [
        {
          "name": "category",
          "value": "api"
        }
      ],
      "context": {
        "isContextOnly": false,
        "prompts": [
          {
            "displayOrder": 1,
            "displayText": "Update KB",
            "qna": {
              "answer": "You can use our REST apis to update your KB. See here for details: https://docs.microsoft.com/en-us/rest/api/cognitiveservices/qnamaker/knowledgebase/update",
              "questions": [
                "How do I programmatically update my KB?"
              ],
              "metadata": [
                {
                  "name": "category",
                  "value": "api"
                }
              ],
              "context": {
                "isContextOnly": false,
                "prompts": [
                  {
                    "displayOrder": 1,
                    "displayText": "Refresh Endpoint Keys",
                    "qna": {
                      "answer": "You can use our REST apis to refresh endpoint keys. See here for details: https://docs.microsoft.com/en-us/rest/api/cognitiveservices/qnamaker/endpointkeys/refreshkeys",
                      "questions": [
                        "How do I programmatically refresh endpoint keys?"
                      ]
                    }
                  }
                ]
              }
            }
          }
        ]
      }
    }
  ],
  "urls": [
    "https://docs.microsoft.com/en-in/azure/cognitive-services/qnamaker/faqs",
    "https://docs.microsoft.com/en-us/bot-framework/resources-bot-framework-faq"
  ],
  "files": [
    {
      "fileName": "SurfaceManual.pdf",
      "fileUri": "https://download.microsoft.com/download/2/9/B/29B20383-302C-4517-A006-B0186F04BE28/surface-pro-4-user-guide-EN.pdf"
    }
  ]
}

示例响应

状态代码:: 202

{
  "operationState": "NotStarted",
  "createdTimestamp": "2018-03-19T07:38:46Z",
  "lastActionTimestamp": "2018-03-19T07:39:29Z",
  "userId": "86bb8390-56c0-42c2-9f81-3de161981191",
  "operationId": "03a4f4ce-30a6-4ec6-b436-02bcdf6153e1"
}

定义

名称	说明
Context	与要更新的 Qna 关联的上下文。
CreateKbDTO	创建Kb作的后正文架构。
Error	错误对象。根据Microsoft一个 API 指南 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。
ErrorCodeType	服务器定义的错误代码集之一。
ErrorResponse	错误响应。根据Microsoft一个 API 指南 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。
FileDTO	用于保存上传文件的详细信息的 DTO。
InnerErrorModel	包含有关错误的更具体信息的对象。根据Microsoft一个 API 指南 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。
MetadataDTO	名称 - 元数据值对。
Operation	记录以跟踪长时间运行的作。
OperationStateType	作状态。
PromptDTO	提示输入答案。
Qna	QnADTO - QnaId 或 QnADTO 需要存在于 PromptDTO 对象中
QnADTO	Q-A 对象。

Context

Object

与要更新的 Qna 关联的上下文。

名称	类型	说明
isContextOnly	boolean	如果提示仅与前面的问题相关，则进行标记。 true - 请勿将此 QnA 作为没有上下文 false 的查询的搜索结果包含 - 忽略上下文并在搜索结果中包含此 QnA
promptsToAdd	PromptDTO[]	要添加到 qna 的提示列表。
promptsToDelete	integer[] (int32)	要删除的 qna 关联的提示列表

CreateKbDTO

Object

创建Kb作的后正文架构。

名称	类型	说明
defaultAnswer	string minLength: 1 maxLength: 300	如果未在 KB 中找到匹配项，则向用户发送的默认答案。
defaultAnswerUsedForExtraction	string minLength: 1 maxLength: 300	要用作任何 Q-A 中的答案的文本字符串，其中没有从文档中提取答案，但具有层次结构。当 EnableHierarchicalExtraction 字段设置为 True 时必需。
enableHierarchicalExtraction	boolean	启用从文件和 URL 对 Q-A 进行分层提取。如果此字段不存在，则将其视为 False 的值。
enableMultipleLanguages	boolean	设置为 true，以便为同一资源使用不同的语言创建 KB。
files	FileDTO[]	要从中提取 Q-A 的文件列表。
language	string minLength: 1 maxLength: 100	知识库的语言。请在此处找到支持的语言列表。
name	string minLength: 1 maxLength: 100	知识库的友好名称。
qnaList	QnADTO[]	要添加到知识库的 Q-A（QnADTO）列表。 Q-A ID 由服务分配，应省略。
urls	string[]	用于提取 Q-A 的 URL 列表。

Error

Object

错误对象。根据Microsoft一个 API 指南 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。

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

ErrorCodeType

枚举

服务器定义的错误代码集之一。

值	说明
BadArgument
EndpointKeysError
ExtractionFailure
Forbidden
KbNotFound
NotFound
OperationNotFound
QnaRuntimeError
QuotaExceeded
SKULimitExceeded
ServiceError
Unauthorized
Unspecified
ValidationFailure

ErrorResponse

Object

错误响应。根据Microsoft一个 API 指南 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。

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

FileDTO

Object

用于保存上传文件的详细信息的 DTO。

名称	类型	说明
fileName	string minLength: 1 maxLength: 200	文件名。支持的文件类型为“.tsv”、“.pdf”、“.txt”、“.docx”、“.xlsx”。
fileUri	string	文件的公共 URI。
isUnstructured	boolean	可选标志，用于指定给定文件是否为非结构化文件。

InnerErrorModel

Object

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

名称	类型	说明
code	string	比包含的错误提供的错误代码更具体。
innerError	InnerErrorModel	包含与当前对象有关错误的更具体信息的对象。

MetadataDTO

Object

名称 - 元数据值对。

名称	类型	说明
name	string minLength: 1 maxLength: 100	元数据名称。
value	string minLength: 1 maxLength: 500	元数据值。

Operation

Object

记录以跟踪长时间运行的作。

名称	类型	说明
createdTimestamp	string	创建作时的时间戳。
errorResponse	ErrorResponse	失败时的错误详细信息。
lastActionTimestamp	string	输入当前状态时的时间戳。
operationId	string	作 ID。
operationState	OperationStateType	作状态。
resourceLocation	string	已完成资源的目标资源位置的相对 URI。
userId	string	用户 ID

OperationStateType

枚举

作状态。

值	说明
Failed
NotStarted
Running
Succeeded

PromptDTO

Object

提示输入答案。

名称	类型	说明
displayOrder	integer (int32)	提示的索引 - 用于提示排序
displayText	string maxLength: 200	显示以表示后续问题提示的文本
qna	Qna	QnADTO - QnaId 或 QnADTO 需要存在于 PromptDTO 对象中
qnaId	integer (int32)	与提示对应的 Qna ID - 如果 QnaId 存在，则忽略 QnADTO 对象。

Qna

Object

QnADTO - QnaId 或 QnADTO 需要存在于 PromptDTO 对象中

名称	类型	说明
answer	string minLength: 1 maxLength: 25000	应答文本
context	Context	QnA 的上下文
id	integer (int32)	Q-A 的唯一 ID。
lastUpdatedTimestamp	string maxLength: 300	上次更新 QnA 时的时间戳。
metadata	MetadataDTO[]	与答案关联的元数据列表。
questions	string[]	与答案关联的问题列表。
source	string maxLength: 300	从中为 Q-A 编制索引的源。例如https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs

QnADTO

Object

Q-A 对象。

名称	类型	说明
answer	string minLength: 1 maxLength: 25000	应答文本
context	Context	QnA 的上下文
id	integer (int32)	Q-A 的唯一 ID。
lastUpdatedTimestamp	string maxLength: 300	上次更新 QnA 时的时间戳。
metadata	MetadataDTO[]	与答案关联的元数据列表。
questions	string[]	与答案关联的问题列表。
source	string maxLength: 300	从中为 Q-A 编制索引的源。例如https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs

通过

Knowledgebase - Create

URI 参数

请求头

请求正文

响应

安全性

Ocp-Apim-Subscription-Key

示例

Successful query

示例请求

示例响应

定义

Context

CreateKbDTO

Error

ErrorCodeType

ErrorResponse

FileDTO

InnerErrorModel

MetadataDTO

Operation

OperationStateType

PromptDTO

Qna

QnADTO

其他资源