Question Answering Projects - Update Sources

참조

서비스:: Cognitive Services - Language

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	지원되는 Cognitive Services 엔드포인트(예: https://.api.cognitiveservices.azure.com).
projectName	path	True	string	사용할 프로젝트의 이름입니다.
api-version	query	True	string	클라이언트 API 버전입니다.

요청 본문

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

응답

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 리소스를 나타내기 위해 헤더를 사용해야 합니다. 이는 지도 관리 API에서 가져올 수 있습니다.

Authorization URL 은 Azure 퍼블릭 클라우드 instance 관련됩니다. 소버린 클라우드에는 고유한 권한 부여 URL 및 Azure Active Directory 구성이 있습니다. * Azure 역할 기반 액세스 제어는 Azure Portal, PowerShell, CLI, Azure SDK 또는 REST API를 통해 Azure 관리 평면에서 구성됩니다. * Azure Maps Web 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/sources?api-version=2023-04-01

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

샘플 응답

상태 코드:: 202

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

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

sourceContentStructureKind

원본에 대한 콘텐츠 구조 형식입니다.

Name	형식	Description
unstructured	string

sourceKind

지원되는 원본 유형입니다.

Name	형식	Description
file	string
url	string

updateOperationKind

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

Name	형식	Description
add	string
delete	string
replace	string

UpdateQnaSourceRecord

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

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

UpdateSourceRecord

업데이트할 원본입니다.

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

다음을 통해 공유

Question Answering Projects - Update Sources

URI 매개 변수

요청 본문

응답

보안

AADToken

참고

범위

Ocp-Apim-Subscription-Key

예제

Successful query

샘플 요청

샘플 응답

정의

Error

ErrorCode

ErrorResponse

InnerErrorCode

InnerErrorModel

sourceContentStructureKind

sourceKind

updateOperationKind

UpdateQnaSourceRecord

UpdateSourceRecord

추가 리소스