Question Answering Projects - Update Qnas

서비스:
Azure AI Services
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 (uri)

지원되는 Cognitive Services 엔드포인트(예: https://< resource-name.api.cognitiveservices.azure.com>).
projectName
 path True

string

maxLength: 100
pattern: ^(?=[a-zA-Z0-9])[a-zA-Z0-9-]{0,98}[a-zA-Z0-9]$

사용할 프로젝트의 이름입니다.
api-version
 query True

string

minLength: 1

이 작업에 사용할 API 버전입니다.

요청 본문

Name 형식 Description
body

UpdateQnaRecord[]

프로젝트의 QnAs 매개 변수를 업데이트합니다.

응답

Name 형식 Description
202 Accepted

처리를 위해 요청이 수락되었지만 처리가 아직 완료되지 않았습니다.

헤더

Operation-Location: string
Other Status Codes

ErrorResponse

예기치 않은 오류 응답입니다.

헤더

x-ms-error-code: string

보안

Ocp-Apim-Subscription-Key

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

OAuth2Auth

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

범위

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

예제

Successful query

샘플 요청

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

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

샘플 응답

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

정의

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

Active Learning 기능에서 제안하는 질문입니다.
SuggestedQuestionsCluster

Active Learning은 클러스터 세부 정보를 제안했습니다.
updateOperationKind

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

QnA 레코드가 업데이트됩니다.

Error

Object

오류 개체입니다.

Name 형식 Description
code

ErrorCode

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

Error[]

이 보고된 오류로 이어진 특정 오류에 대한 세부 정보 배열입니다.
innererror

InnerErrorModel

오류에 대한 현재 개체보다 더 구체적인 정보를 포함하는 개체입니다.
message

string

사람이 읽을 수 있는 오류 표현입니다.
target

string

오류의 대상입니다.

ErrorCode

열거형

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

값 Description
InvalidRequest

잘못된 요청 오류
InvalidArgument

잘못된 인수 오류
Unauthorized

권한 없는 액세스 오류
Forbidden

사용할 수 없는 액세스 오류
NotFound

찾을 수 없음 오류
ProjectNotFound

프로젝트를 찾을 수 없음 오류
OperationNotFound

작업을 찾을 수 없음 오류
AzureCognitiveSearchNotFound

Azure Cognitive Search를 찾을 수 없음 오류
AzureCognitiveSearchIndexNotFound

Azure Cognitive Search 인덱스 찾을 수 없음 오류
TooManyRequests

요청이 너무 많음 오류
AzureCognitiveSearchThrottling

Azure Cognitive Search 제한 오류
AzureCognitiveSearchIndexLimitReached

Azure Cognitive Search 인덱스 제한에 도달한 오류
InternalServerError

내부 서버 오류
ServiceUnavailable

서비스를 사용할 수 없음 오류
Timeout

시간 제한 오류
QuotaExceeded

할당량 초과 오류
Conflict

충돌 오류
Warning

경고 오류

ErrorResponse

Object

오류 응답입니다.

Name 형식 Description
error

Error

오류 개체입니다.

InnerErrorCode

열거형

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

값 Description
InvalidRequest

잘못된 요청 오류
InvalidParameterValue

잘못된 매개 변수 값 오류
KnowledgeBaseNotFound

기술 자료를 찾을 수 없음 오류
AzureCognitiveSearchNotFound

Azure Cognitive Search를 찾을 수 없음 오류
AzureCognitiveSearchThrottling

Azure Cognitive Search 제한 오류
ExtractionFailure

추출 실패 오류
InvalidRequestBodyFormat

잘못된 요청 본문 형식 오류
EmptyRequest

빈 요청 오류
MissingInputDocuments

입력 문서 누락 오류
InvalidDocument

잘못된 문서 오류
ModelVersionIncorrect

모델 버전 잘못된 오류
InvalidDocumentBatch

잘못된 문서 일괄 처리 오류
UnsupportedLanguageCode

지원되지 않는 언어 코드 오류
InvalidCountryHint

잘못된 국가 힌트 오류

InnerErrorModel

Object

오류에 대한 보다 구체적인 정보를 포함하는 개체입니다. 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

Object

QnA 레코드와 연결된 대화 상자입니다.

Name 형식 Description
isContextOnly

boolean

프롬프트가 이전 질문과만 관련이 있는지 여부를 표시합니다. true이면 컨텍스트가 없는 쿼리에 대한 답변으로 이 QnA를 포함하지 마세요. 그렇지 않으면 컨텍스트를 무시하고 답변에 이 QnA를 포함합니다.
prompts

QnaPrompt[]

답변과 연결된 프롬프트 목록입니다.

QnaPrompt

Object

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

Name 형식 Description
displayOrder

integer (int32)

프롬프트의 인덱스입니다. 프롬프트 순서 지정에 사용됩니다.
displayText

string

maxLength: 200

후속 질문 프롬프트를 나타내기 위해 표시되는 텍스트입니다.
qna

QnaRecord

QnA 레코드입니다. QnAId 또는 QnA 레코드는 프롬프트에 있어야 합니다.
qnaId

integer (int32)

프롬프트에 해당하는 QnA의 ID입니다.

QnaRecord

Object

QnA 레코드입니다.

Name 형식 Description
activeLearningSuggestions

SuggestedQuestionsCluster[]

QnA에 대한 활성 학습 제안 목록입니다.
answer

string

minLength: 1
maxLength: 25000

텍스트에 응답합니다.
dialog

QnaDialog

QnA의 컨텍스트입니다.
id

integer (int32)

QnA의 고유 ID입니다.
metadata

object

답변과 연결된 메타데이터로, 질문 답변을 분류하거나 필터링하는 데 유용합니다.
questions

string[]

답변과 관련된 질문 목록입니다.
source

string

maxLength: 300

QnA가 인덱싱된 원본(예: https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs.)

SuggestedQuestion

Object

Active Learning 기능에서 제안하는 질문입니다.

Name 형식 Description
autoSuggestedCount

integer (int32)

Active Learning 알고리즘에 의해 질문이 자동으로 제안된 횟수입니다.
question

string

Active Learning 기능에서 제안하는 질문입니다.
userSuggestedCount

integer (int32)

사용자가 질문을 명시적으로 제안한 횟수입니다.

SuggestedQuestionsCluster

Object

Active Learning은 클러스터 세부 정보를 제안했습니다.

Name 형식 Description
clusterHead

string

Active Learning 클러스터링 알고리즘에서 제안된 질문 클러스터의 수장으로 선택한 질문입니다.
suggestedQuestions

SuggestedQuestion[]

QnA에 대해 제안된 모든 질문 목록입니다.

updateOperationKind

열거형

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

값 Description
add

작업을 추가합니다.
delete

삭제 작업.
replace

교체 작업.

UpdateQnaRecord

Object

QnA 레코드가 업데이트됩니다.

Name 형식 Description
op

updateOperationKind

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

QnaRecord

QnA 레코드입니다.