Question Answering Projects - Update Sources

서비스:

Azure AI Services

API 버전:

2023-04-01

프로젝트의 원본을 업데이트합니다.

PATCH {Endpoint}/language/authoring/query-knowledgebases/projects/{projectName}/sources?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	UpdateSourceRecord[]	프로젝트의 소스 매개변수를 업데이트합니다.

응답

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

샘플 요청

HTTP

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

[
  {
    "op": "add",
    "value": {
      "displayName": "source3",
      "source": "https://docs.microsoft.com/en-us/azure/cognitive-services/cognitive-services-support-options?context=/azure/cognitive-services/qnamaker/context/context",
      "sourceKind": "url",
      "sourceUri": "https://docs.microsoft.com/en-us/azure/cognitive-services/cognitive-services-support-options?context=/azure/cognitive-services/qnamaker/context/context"
    }
  },
  {
    "op": "replace",
    "value": {
      "displayName": "source1",
      "refresh": true,
      "source": "https://docs.microsoft.com/en-us/azure/cognitive-services/qnamaker/overview/overview",
      "sourceKind": "url",
      "sourceUri": "https://docs.microsoft.com/en-us/azure/cognitive-services/qnamaker/overview/overview"
    }
  },
  {
    "op": "delete",
    "value": {
      "displayName": "source2",
      "source": "surface-guide.pdf",
      "sourceKind": "file",
      "sourceUri": "https://download.microsoft.com/download/2/9/B/29B20383-302C-4517-A006-B0186F04BE28/surface-pro-4-user-guide-EN.pdf"
    }
  }
]

샘플 응답

상태 코드:

202

Operation-Location: https:///language/authoring/query-knowledgebases/projects/proj1/sources/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.
sourceContentStructureKind	소스에 대한 콘텐츠 구조 유형입니다.
sourceKind	지원되는 소스 유형입니다.
updateOperationKind	자산에 대한 작업 유형을 업데이트합니다.
UpdateQnaSourceRecord	원본 레코드를 업데이트합니다.
UpdateSourceRecord	업데이트할 소스입니다.

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	오류 대상입니다.

sourceContentStructureKind

열거형

소스에 대한 콘텐츠 구조 유형입니다.

값	Description
unstructured	구조화 되지 않은.

sourceKind

열거형

지원되는 소스 유형입니다.

값	Description
file	파일 소스.
url	URI 원본.

updateOperationKind

열거형

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

값	Description
add	작업을 추가합니다.
delete	삭제 작업.
replace	교체 작업.

UpdateQnaSourceRecord

Object

원본 레코드를 업데이트합니다.

Name	형식	Default value	Description
contentStructureKind	sourceContentStructureKind	unstructured	소스에 대한 콘텐츠 구조 유형입니다.
displayName	string minLength: 1 maxLength: 200		원본의 이름입니다.
refresh	boolean		소스에서 데이터를 새로 고치는 데 사용되는 부울 플래그입니다.
source	string		고유한 소스 식별자입니다. '파일' 소스인 경우 파일 이름; 그렇지 않으면 'url' 소스인 경우 전체 URL입니다.
sourceKind	sourceKind		지원되는 소스 유형입니다.
sourceUri	string (uri)		파일 또는 URL의 URI 위치입니다.

UpdateSourceRecord

Object

업데이트할 소스입니다.

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