Knowledgebase - Replace

참조

Service:: Cognitive Services - QnA Maker

API Version:: v5.0-preview.2

기술 자료 콘텐츠를 대체합니다.

PUT {Endpoint}/qnamaker/v5.0-preview.2/knowledgebases/{kbId}

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
Endpoint	path	True	string	지원되는 Cognitive Services 엔드포인트(예: qnamaker-resource-name >.api.cognitiveservices.azure.com< https://).
kbId	path	True	string	기술 자료 ID입니다.

요청 헤더

Name	필수	형식	Description
Ocp-Apim-Subscription-Key	True	string

요청 본문

Name	필수	형식	Description
qnAList	True	QnADTO[]	기술 자료에 추가할 QnADTO(QnADTO) 목록입니다. Q-A ID는 서비스에서 할당되며 생략해야 합니다.

응답

Name	형식	Description
204 No Content		HTTP 204 콘텐츠가 없습니다.
Other Status Codes	ErrorResponse	오류 응답입니다.

보안

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

예제

Successful query

Sample Request

HTTP

PUT {Endpoint}/qnamaker/v5.0-preview.2/knowledgebases/9d091697-fb8c-4ed5-9ac0-35bf8273bfff


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

Sample Response

Status code:: 204

정의

Name	Description
Context	업데이트할 Qna와 연결된 컨텍스트입니다.
Error	Error 개체. Microsoft One API 지침에 따라 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
ErrorCodeType	서버 정의 오류 코드 집합 중 하나입니다.
ErrorResponse	오류 응답입니다. Microsoft One API 지침에 따라 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
InnerErrorModel	오류에 대한 보다 구체적인 정보를 포함하는 개체입니다. Microsoft One API 지침에 따라 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
MetadataDTO	이름 - 메타데이터의 값 쌍입니다.
PromptDTO	답변을 묻는 메시지를 표시합니다.
Qna	QnADTO - QnaId 또는 QnADTO가 PromptDTO 개체에 있어야 합니다.
QnADTO	Q-A 개체입니다.
ReplaceKbDTO	KB 바꾸기 작업에 대한 사후 본문 스키마입니다.

Context

업데이트할 Qna와 연결된 컨텍스트입니다.

Name	형식	Description
isContextOnly	boolean	프롬프트가 이전 질문과만 관련이 있는지 여부를 표시합니다. true - 컨텍스트 false가 없는 쿼리에 대한 검색 결과로 이 QnA를 포함하지 마세요. 컨텍스트를 무시하고 검색 결과에 이 QnA를 포함합니다.
promptsToAdd	PromptDTO[]	qna에 추가할 프롬프트 목록입니다.
promptsToDelete	integer[]	삭제할 qna와 연결된 프롬프트 목록

Error

Error 개체. Microsoft One API 지침에 따라 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	형식	Description
code	ErrorCodeType	서버 정의 오류 코드 집합 중 하나입니다.
details	Error[]	이 보고된 오류로 이어진 특정 오류에 대한 세부 정보 배열입니다.
innerError	InnerErrorModel	오류에 대한 현재 개체보다 더 구체적인 정보를 포함하는 개체입니다.
message	string	사람이 읽을 수 있는 오류 표현입니다.
target	string	오류의 대상입니다.

ErrorCodeType

서버 정의 오류 코드 집합 중 하나입니다.

Name	형식	Description
BadArgument	string
EndpointKeysError	string
ExtractionFailure	string
Forbidden	string
KbNotFound	string
NotFound	string
OperationNotFound	string
QnaRuntimeError	string
QuotaExceeded	string
SKULimitExceeded	string
ServiceError	string
Unauthorized	string
Unspecified	string
ValidationFailure	string

ErrorResponse

오류 응답입니다. Microsoft One API 지침에 따라 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	형식	Description
error	Error	Error 개체.

InnerErrorModel

오류에 대한 보다 구체적인 정보를 포함하는 개체입니다. Microsoft One API 지침에 따라 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	형식	Description
code	string	포함하는 오류에서 제공한 것보다 더 구체적인 오류 코드입니다.
innerError	InnerErrorModel	오류에 대한 현재 개체보다 더 구체적인 정보를 포함하는 개체입니다.

MetadataDTO

이름 - 메타데이터의 값 쌍입니다.

Name	형식	Description
name	string	메타데이터 이름입니다.
value	string	메타데이터 값입니다.

PromptDTO

답변을 묻는 메시지를 표시합니다.

Name	형식	Description
displayOrder	integer	프롬프트의 인덱스 - 프롬프트 순서에 사용됨
displayText	string	후속 질문 프롬프트를 나타내기 위해 표시되는 텍스트
qna	Qna	QnADTO - QnaId 또는 QnADTO가 PromptDTO 개체에 있어야 합니다.
qnaId	integer	프롬프트에 해당하는 Qna ID - QnaId가 있으면 QnADTO 개체가 무시됩니다.

Qna

QnADTO - QnaId 또는 QnADTO가 PromptDTO 개체에 있어야 합니다.

Name	형식	Description
answer	string	대답 텍스트
context	Context	QnA 컨텍스트
id	integer	Q-A의 고유 ID입니다.
lastUpdatedTimestamp	string	QnA가 마지막으로 업데이트된 타임스탬프입니다.
metadata	MetadataDTO[]	답변과 연결된 메타데이터 목록입니다.
questions	string[]	답변과 관련된 질문 목록입니다.
source	string	Q-A가 인덱싱된 원본입니다. 예. https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs

QnADTO

Q-A 개체입니다.

Name	형식	Description
answer	string	대답 텍스트
context	Context	QnA 컨텍스트
id	integer	Q-A의 고유 ID입니다.
lastUpdatedTimestamp	string	QnA가 마지막으로 업데이트된 타임스탬프입니다.
metadata	MetadataDTO[]	답변과 연결된 메타데이터 목록입니다.
questions	string[]	답변과 관련된 질문 목록입니다.
source	string	Q-A가 인덱싱된 원본입니다. 예. https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs

ReplaceKbDTO

KB 바꾸기 작업에 대한 사후 본문 스키마입니다.

Name	형식	Description
qnAList	QnADTO[]	기술 자료에 추가할 QnADTO(QnADTO) 목록입니다. Q-A ID는 서비스에서 할당되며 생략해야 합니다.

다음을 통해 공유