Analyzers - Analyze

서비스:

Azure AI Services

API 버전:

2024-12-01-preview

입력에서 콘텐츠 및 필드를 추출합니다.

POST {endpoint}/contentunderstanding/analyzers/{analyzerId}:analyze?api-version=2024-12-01-preview

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
analyzerId	path	True	string	분석기의 고유 식별자입니다. regex 패턴: ^[a-zA-Z0-9._-]{1,64}$
endpoint	path	True	string uri	Content Understanding 서비스 엔드포인트.
api-version	query	True	string	이 작업에 사용할 API 버전입니다.

요청 헤더

Name	필수	형식	Description
Operation-Id		string	장기 실행 작업을 식별하는 클라이언트 제공 GUID입니다.
x-ms-client-request-id		string uuid	요청에 대한 불투명하고 전역적으로 고유한 클라이언트 생성 문자열 식별자입니다.

요청 본문

Name	형식	Description
url	string	분석할 문서의 URL입니다.

응답

Name	형식	Description
202 Accepted		처리를 위해 요청이 수락되었지만 처리가 아직 완료되지 않았습니다. 헤더 Operation-Id: string Operation-Location: string x-ms-client-request-id: string
Other Status Codes	Azure.Core.Foundations.ErrorResponse	예기치 않은 오류 응답입니다. 헤더 x-ms-error-code: string

보안

Ocp-Apim-Subscription-Key

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

OAuth2Auth

형식: oauth2
Flow: accessCode
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize
토큰 URL: https://login.microsoftonline.com/common/oauth2/token

범위

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

예제

Analyze URL

샘플 요청

HTTP

POST {endpoint}/contentunderstanding/analyzers/myAnalyzer:analyze?api-version=2024-12-01-preview


{
  "url": "https://host.com/doc.pdf"
}

샘플 응답

상태 코드:

202

Operation-Id: 3b31320d-8bab-4f88-b19c-2322a7f11034
Operation-Location: https://myendpoint.cognitiveservices.azure.com/contentunderstanding/analyzers/myAnalyzer/results/3b31320d-8bab-4f88-b19c-2322a7f11034?api-version=2024-12-01-preview

{
  "id": "3b31320d-8bab-4f88-b19c-2322a7f11034",
  "status": "NotStarted"
}

정의

Name	Description
AnalyzeRequest	작업 요청을 분석합니다.
Azure.Core.Foundations.Error	오류 개체입니다.
Azure.Core.Foundations.ErrorResponse	오류 세부 정보가 포함된 응답입니다.
Azure.Core.Foundations.InnerError	오류에 대한 보다 구체적인 정보를 포함하는 개체입니다. Microsoft One API 지침에 따라 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

AnalyzeRequest

작업 요청을 분석합니다.

Name	형식	Description
url	string	분석할 문서의 URL입니다.

Azure.Core.Foundations.Error

오류 개체입니다.

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

Azure.Core.Foundations.ErrorResponse

오류 세부 정보가 포함된 응답입니다.

Name	형식	Description
error	Azure.Core.Foundations.Error	오류 개체입니다.

Azure.Core.Foundations.InnerError

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

Name	형식	Description
code	string	서버에서 정의한 오류 코드 집합 중 하나입니다.
innererror	Azure.Core.Foundations.InnerError	내부 오류입니다.