Analyzers - Get

서비스:

Azure AI Services

API 버전:

2024-12-01-preview

분석기 속성을 가져옵니다.

GET {endpoint}/contentunderstanding/analyzers/{analyzerId}?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
x-ms-client-request-id		string uuid	요청에 대한 불투명하고 전역적으로 고유한 클라이언트 생성 문자열 식별자입니다.

응답

Name	형식	Description
200 OK	ContentAnalyzer	요청이 성공했습니다. 헤더 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

예제

Get Analyzer

샘플 요청

HTTP

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

샘플 응답

상태 코드:

200

{
  "analyzerId": "myAnalyzer",
  "description": "My custom analyzer",
  "tags": {
    "createdBy": "John"
  },
  "status": "succeeded",
  "createdAt": "2024-10-14T18:46:36.051Z",
  "lastModifiedAt": "2024-10-14T18:46:36.051Z",
  "baseAnalyzerId": "prebuilt-document",
  "config": {
    "locales": null,
    "enableFace": false,
    "enableOcr": true,
    "enableLayout": true,
    "enableBarcode": true,
    "enableFormula": false,
    "returnDetails": true
  },
  "fieldSchema": {
    "name": "MyForm",
    "description": "My custom form",
    "fields": {
      "Company": {
        "type": "string",
        "description": "Name of company."
      }
    },
    "definitions": {}
  },
  "trainingData": {
    "kind": "blob",
    "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer",
    "prefix": "trainingData",
    "fileListPath": "trainingData/fileList.jsonl"
  }
}

정의

Name	Description
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.
BlobDataSource	Blob Storage 데이터 원본입니다.
ContentAnalyzer	멀티모달 문서에서 콘텐츠 및 필드를 추출하는 분석기입니다.
ContentAnalyzerConfig	분석기 구성 설정입니다.
DataSourceKind	데이터 원본 종류입니다.
FieldDefinition	구문과 같은 JSON 스키마를 사용하는 필드의 정의입니다.
FieldSchema	문서에서 추출할 필드의 스키마입니다.
FieldType	필드 값의 의미 체계 데이터 형식입니다.
GenerationMethod	생성 메서드입니다.
ResourceStatus	리소스의 상태입니다.

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	내부 오류입니다.

BlobDataSource

Blob Storage 데이터 원본입니다.

Name	형식	Description
containerUrl	string	Blob 컨테이너의 URL입니다.
fileListPath	string	포함할 특정 Blob을 나열하는 파일의 선택적 경로입니다.
kind	string: blob	데이터 원본의 종류입니다.
prefix	string	컨테이너 내에서 Blob을 필터링하는 선택적 접두사입니다.

ContentAnalyzer

멀티모달 문서에서 콘텐츠 및 필드를 추출하는 분석기입니다.

Name	형식	Description
analyzerId	string	분석기의 고유 식별자입니다.
baseAnalyzerId	string	증분 학습할 분석기입니다.
config	ContentAnalyzerConfig	분석기 구성 설정입니다.
createdAt	string	분석기를 만든 날짜 및 시간입니다.
description	string	분석기의 설명입니다.
fieldSchema	FieldSchema	추출할 필드의 스키마입니다.
lastModifiedAt	string	분석기가 마지막으로 수정된 날짜 및 시간입니다.
scenario	string	분석기가 최적화된 시나리오입니다.
status	ResourceStatus	분석기의 상태입니다.
tags	object	분석기와 연결된 태그입니다.
trainingData	DataSource: BlobDataSource	분석기 학습 데이터를 포함하는 데이터 원본입니다.
warnings	Azure.Core.Foundations.Error[]	분석기를 만드는 동안 발생한 경고입니다.

ContentAnalyzerConfig

분석기 구성 설정입니다.

Name	형식	Description
enableBarcode	boolean	바코드 검색을 사용하도록 설정합니다.
enableFace	boolean	얼굴 감지를 사용하도록 설정합니다.
enableFormula	boolean	수식 검색을 사용하도록 설정합니다.
enableLayout	boolean	레이아웃 분석을 사용하도록 설정합니다.
enableOcr	boolean	OCR(광학 문자 인식)을 사용하도록 설정합니다.
locales	string[]	음성 전사에 대한 로캘 힌트 목록입니다.
returnDetails	boolean	모든 콘텐츠 세부 정보를 반환합니다.

DataSourceKind

데이터 원본 종류입니다.

Name	형식	Description
blob	string	Blob Storage 데이터 원본입니다.

FieldDefinition

구문과 같은 JSON 스키마를 사용하는 필드의 정의입니다.

Name	형식	Default value	Description
$ref	string		다른 필드 정의에 대한 참조입니다.
description	string		필드 설명입니다.
enum	string[]		가능한 필드 값의 열거형입니다.
enumDescriptions	object		각 열거형 값에 대한 설명입니다.
examples	string[]		필드 값의 예입니다.
items	FieldDefinition		형식이 배열인 경우 각 배열 요소의 필드 형식 스키마입니다.
method	GenerationMethod	generate	생성 메서드입니다.
properties	<string,  FieldDefinition>		type이 개체인 경우 명명된 하위 필드입니다.
type	FieldType		필드 값의 의미 체계 데이터 형식입니다.

FieldSchema

문서에서 추출할 필드의 스키마입니다.

Name	형식	Description
definitions	<string,  FieldDefinition>	스키마의 필드에서 참조하는 추가 정의입니다.
description	string	필드 스키마에 대한 설명입니다.
fields	<string,  FieldDefinition>	스키마에 정의된 필드입니다.
name	string	필드 스키마의 이름입니다.

FieldType

필드 값의 의미 체계 데이터 형식입니다.

Name	형식	Description
array	string	동일한 형식의 하위 필드 목록입니다.
boolean	string	부울 값입니다.
date	string	ISO 8601(YYYY-MM-DD) 형식으로 정규화된 날짜입니다.
integer	string	64비트 부가 정수인 정수입니다.
number	string	배정밀도 부동 소수점의 숫자입니다.
object	string	하위 필드의 명명된 목록입니다.
string	string	일반 텍스트입니다.
time	string	ISO 8601(hh:mm:ss) 형식으로 정규화된 시간입니다.

GenerationMethod

생성 메서드입니다.

Name	형식	Description
classify	string	값은 미리 정의된 범주 집합에 대해 분류됩니다.
extract	string	값은 콘텐츠에 표시될 때 추출됩니다.
generate	string	값은 콘텐츠에 따라 자유롭게 생성됩니다.

ResourceStatus

리소스의 상태입니다.

Name	형식	Description
creating	string	리소스가 만들어지고 있습니다.
deleting	string	리소스가 삭제되고 있습니다.
failed	string	리소스를 만드는 동안 실패했습니다.
ready	string	리소스가 준비되었습니다.