Question Answering Projects - Update Qnas

참조

서비스:: Cognitive Services - Language

API 버전:: 2023-04-01

프로젝트의 QnA를 업데이트.

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

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
Endpoint	path	True	string	지원되는 Cognitive Services 엔드포인트(예: https://.api.cognitiveservices.azure.com).
projectName	path	True	string	사용할 프로젝트의 이름입니다.
api-version	query	True	string	클라이언트 API 버전입니다.

요청 본문

Name	형식	Description
body	UpdateQnaRecord[]	프로젝트의 QnAs 매개 변수를 업데이트합니다.

응답

Name	형식	Description
202 Accepted		작업의 상태를 확인하는 데 사용되는 Operation-Location 헤더가 포함된 성공적인 호출 결과. 헤더 Operation-Location: string
Other Status Codes	ErrorResponse	오류 응답입니다.

Name

형식

Description

202 Accepted

작업의 상태를 확인하는 데 사용되는 Operation-Location 헤더가 포함된 성공적인 호출 결과.

헤더

Operation-Location: string

Other Status Codes

ErrorResponse

오류 응답입니다.

보안

AADToken

Azure Active Directory OAuth2 흐름입니다. Azure 역할 기반 액세스 제어와 쌍을 이루는 경우 Azure Maps REST API에 대한 액세스를 제어하는 데 사용할 수 있습니다. Azure 역할 기반 액세스 제어는 하나 이상의 Azure Maps 리소스 계정 또는 하위 리소스에 대한 액세스를 지정하는 데 사용됩니다. 모든 사용자, 그룹 또는 서비스 주체는 기본 제공 역할 또는 REST API를 Azure Maps 하나 이상의 권한으로 구성된 사용자 지정 역할을 통해 액세스 권한을 부여할 수 있습니다.

시나리오를 구현하려면 인증 개념을 보는 것이 좋습니다. 요약하자면, 이 보안 정의는 특정 API 및 범위에 대한 액세스 제어가 가능한 개체를 통해 애플리케이션을 모델링하기 위한 솔루션을 제공합니다.

참고

이 보안 정의에서는 헤더를 사용하여 애플리케이션이 x-ms-client-id 액세스를 요청하는 Azure Maps 리소스를 나타내야 합니다. 이는 Maps 관리 API에서 가져올 수 있습니다.

Authorization URL 은 Azure 퍼블릭 클라우드 instance 관련됩니다. 소버린 클라우드에는 고유한 권한 부여 URL 및 Azure Active Directory 구성이 있습니다. * Azure 역할 기반 액세스 제어는 Azure Portal, PowerShell, CLI, Azure SDK 또는 REST API를 통해 Azure 관리 평면에서 구성됩니다. * Azure Maps 웹 SDK를 사용하면 여러 사용 사례에 대한 애플리케이션의 구성 기반 설정을 허용합니다.

현재 Azure Active Directory v1.0 또는 v2.0 은 회사, 학교 및 게스트를 지원하지만 개인 계정은 지원하지 않습니다.

형식: oauth2
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize

범위

Name	Description
https://cognitiveservices.azure.com/.default	https://cognitiveservices.azure.com/.default

Ocp-Apim-Subscription-Key

언어 서비스 리소스에 대한 구독 키입니다.

형식: apiKey
In(다음 안에): header

예제

Successful query

샘플 요청

HTTP

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

[
  {
    "op": "add",
    "value": {
      "id": 3,
      "answer": "ans3",
      "source": "source1",
      "questions": [
        "question 3.1",
        "question 3.2"
      ],
      "metadata": {
        "k1": "v1",
        "k2": "v2"
      },
      "dialog": {
        "isContextOnly": false,
        "prompts": [
          {
            "displayOrder": 1,
            "qnaId": 11,
            "displayText": "prompt 3.1"
          },
          {
            "displayOrder": 2,
            "qnaId": 21,
            "displayText": "prompt 3.2"
          }
        ]
      }
    }
  },
  {
    "op": "replace",
    "value": {
      "id": 1,
      "answer": "ans4",
      "source": "source1",
      "questions": [
        "question 4.1",
        "question 4.2"
      ]
    }
  },
  {
    "op": "delete",
    "value": {
      "id": 2,
      "answer": "ans2",
      "source": "source1",
      "questions": [
        "question 2.1",
        "question 2.2"
      ]
    }
  }
]

샘플 응답

상태 코드:: 202

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

정의

Name	Description
Error	Error 개체.
ErrorCode	사람이 읽을 수 있는 오류 코드입니다.
ErrorResponse	오류 응답입니다.
InnerErrorCode	사람이 읽을 수 있는 오류 코드입니다.
InnerErrorModel	오류에 대한 보다 구체적인 정보를 포함하는 개체입니다. Microsoft One API 지침에 따라 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
QnaDialog	QnA 레코드와 연결된 대화 상자
QnaPrompt	답변을 묻는 메시지를 표시합니다.
QnaRecord	QnA 레코드.
SuggestedQuestion	활성 학습 기능에서 제안한 질문입니다.
SuggestedQuestionsCluster	Active Learning은 클러스터 세부 정보에 대한 질문을 제안했습니다.
updateOperationKind	자산에 대한 작업 유형을 업데이트합니다.
UpdateQnaRecord	업데이트할 QnA 레코드입니다.

Error

Error 개체.

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

ErrorCode

사람이 읽을 수 있는 오류 코드입니다.

Name	형식	Description
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

오류 응답입니다.

Name	형식	Description
error	Error	Error 개체.

InnerErrorCode

사람이 읽을 수 있는 오류 코드입니다.

Name	형식	Description
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.

Name	형식	Description
code	InnerErrorCode	서버 정의 오류 코드 집합 중 하나입니다.
details	object	오류 세부 정보입니다.
innererror	InnerErrorModel	오류에 대한 현재 개체보다 더 구체적인 정보를 포함하는 개체입니다.
message	string	오류 메시지입니다.
target	string	오류 대상입니다.

QnaDialog

QnA 레코드와 연결된 대화 상자

Name	형식	Description
isContextOnly	boolean	프롬프트가 이전 질문과만 관련이 있는지 여부를 표시합니다. true이면 컨텍스트가 없는 쿼리에 대한 답변으로 이 QnA를 포함하지 마세요. 그렇지 않으면 컨텍스트를 무시하고 이 QnA를 답변에 포함합니다.
prompts	QnaPrompt[]	답변과 연결된 프롬프트 목록입니다.

QnaPrompt

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

Name	형식	Description
displayOrder	integer	프롬프트의 인덱스입니다. 프롬프트 순서 지정에 사용됩니다.
displayText	string	후속 질문 프롬프트를 나타내기 위해 표시되는 텍스트입니다.
qna	QnaRecord	QnA 레코드. QnAId 또는 QnA 레코드는 프롬프트에 있어야 합니다.
qnaId	integer	프롬프트에 해당하는 QnA의 ID입니다.

QnaRecord

QnA 레코드.

Name	형식	Description
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

활성 학습 기능에서 제안한 질문입니다.

Name	형식	Description
autoSuggestedCount	integer	Active Learning 알고리즘에 의해 질문이 자동으로 제안된 횟수입니다.
question	string	활성 학습 기능에서 제안한 질문입니다.
userSuggestedCount	integer	사용자가 질문을 명시적으로 제안한 횟수입니다.

SuggestedQuestionsCluster

Active Learning은 클러스터 세부 정보에 대한 질문을 제안했습니다.

Name	형식	Description
clusterHead	string	Active Learning 클러스터링 알고리즘에서 제안된 질문 클러스터의 수장으로 선택한 질문입니다.
suggestedQuestions	SuggestedQuestion[]	QnA에 대해 제안된 모든 질문 목록입니다.

updateOperationKind

자산에 대한 작업 유형을 업데이트합니다.

Name	형식	Description
add	string
delete	string
replace	string

UpdateQnaRecord

업데이트할 QnA 레코드입니다.

Name	형식	Description
op	updateOperationKind	자산에 대한 작업 유형을 업데이트합니다.
value	QnaRecord	QnA 레코드.

다음을 통해 공유

Question Answering Projects - Update Qnas

URI 매개 변수

요청 본문

응답

보안

AADToken

참고

범위

Ocp-Apim-Subscription-Key

예제

Successful query

샘플 요청

샘플 응답

정의

Error

ErrorCode

ErrorResponse

InnerErrorCode

InnerErrorModel

QnaDialog

QnaPrompt

QnaRecord

SuggestedQuestion

SuggestedQuestionsCluster

updateOperationKind

UpdateQnaRecord

추가 리소스