Content Analyzers - Create Or Replace

서비스:: Azure AI Services

API 버전:: 2025-11-01

비동기식으로 새 분석기를 생성하세요.

PUT {endpoint}/contentunderstanding/analyzers/{analyzerId}?api-version=2025-11-01

선택적 매개 변수:

PUT {endpoint}/contentunderstanding/analyzers/{analyzerId}?api-version=2025-11-01&allowReplace={allowReplace}

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
analyzerId	path	True	string minLength: 1 maxLength: 64 pattern: ^[a-zA-Z0-9._-]{1,64}$	분석기의 고유 식별자입니다.
endpoint	path	True	string (uri)	콘텐츠 이해 서비스 엔드포인트.
api-version	query	True	string minLength: 1	이 작업에 사용할 API 버전입니다.
allowReplace	query		boolean	기존 자원을 대체할 수 있도록 허용하세요.

요청 헤더

Name	필수	형식	Description
x-ms-client-request-id		string (uuid)	요청에 대한 불투명하고 전역적으로 고유한 클라이언트 생성 문자열 식별자입니다.

요청 본문

Name	형식	Description
baseAnalyzerId	string minLength: 1 maxLength: 64 pattern: ^[a-zA-Z0-9._-]{1,64}$	분석기를 점진적으로 학습할 수 있습니다.
config	ContentAnalyzerConfig	분석기 설정 설정.
description	string	분석기 설명입니다.
dynamicFieldSchema	boolean	결과에 정의된 스키마 외의 추가 필드가 포함될 수 있는지 여부를 나타냅니다.
fieldSchema	ContentFieldSchema	추출할 필드 스키마.
knowledgeSources	KnowledgeSource[]: LabeledDataKnowledgeSource[]	분석기를 향상시키기 위해 사용되는 추가 지식 출처.
models	object	모델 역할을 특정 모델명에 매핑하는 것. 예: { "완성": "gpt-4.1", "embedding": "text-embedding-3-large" }.
processingLocation	ProcessingLocation	데이터가 처리될 수 있는 장소입니다. 기본값은 전역으로 설정됩니다.
tags	object	분석기와 연관된 태그들.

응답

Name	형식	Description
200 OK	ContentAnalyzer	요청이 성공했습니다. 헤더 Operation-Location: string x-ms-client-request-id: string
201 Created	ContentAnalyzer	요청이 성공했고 결과적으로 새 리소스가 생성되었습니다. 헤더 Operation-Location: string x-ms-client-request-id: string
Other Status Codes	Azure.Core.Foundations.ErrorResponse	예기치 않은 오류 응답입니다. 헤더 x-ms-error-code: string

Name

형식

Description

200 OK

ContentAnalyzer

요청이 성공했습니다.

헤더

Operation-Location: string
x-ms-client-request-id: string

201 Created

ContentAnalyzer

요청이 성공했고 결과적으로 새 리소스가 생성되었습니다.

헤더

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

Azure 리소스의 접근 키를 이용한 키 기반 인증.

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

EntraIdToken

Microsoft Entra ID OAuth2 인증 접근 토큰을 사용했습니다.

형식: 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

예제

Create or Replace Analyzer

샘플 요청

HTTP

PUT {endpoint}/contentunderstanding/analyzers/myAnalyzer?api-version=2025-11-01

{
  "description": "My analyzer",
  "tags": {
    "createdBy": "John"
  },
  "baseAnalyzerId": "prebuilt-document",
  "config": {
    "enableFormula": false,
    "returnDetails": true
  },
  "fieldSchema": {
    "name": "MyForm",
    "description": "My form",
    "fields": {
      "Company": {
        "type": "string",
        "description": "Name of company."
      }
    },
    "definitions": {}
  },
  "knowledgeSources": [
    {
      "kind": "labeledData",
      "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer",
      "prefix": "trainingData",
      "fileListPath": "trainingData/fileList.jsonl"
    }
  ]
}

샘플 응답

상태 코드:: 200

Operation-Location: https://myendpoint.cognitiveservices.azure.com/contentunderstanding/analyzers/myAnalyzer/operations/3b31320d-8bab-4f88-b19c-2322a7f11034?api-version=2025-11-01

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

상태 코드:: 201

Operation-Location: https://myendpoint.cognitiveservices.azure.com/contentunderstanding/analyzers/myAnalyzer/operations/3b31320d-8bab-4f88-b19c-2322a7f11034?api-version=2025-11-01

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

정의

Name	Description
AnnotationFormat	분석 결과 마크다운에서 주석의 표현 형식.
Azure.Core.Foundations.Error	오류 개체입니다.
Azure.Core.Foundations.ErrorResponse	오류 세부 정보가 포함된 응답입니다.
Azure.Core.Foundations.InnerError	오류에 대한 보다 구체적인 정보를 포함하는 개체입니다. Azure REST API 지침에 따라 - https://aka.ms/AzureRestApiGuidelines#handling-errors.
ChartFormat	분석 결과 마크다운에서 차트의 표현 형식.
ContentAnalyzer	멀티모달 문서에서 내용과 필드를 추출하는 분석기입니다.
ContentAnalyzerConfig	분석기 설정 설정.
ContentAnalyzerStatus	자원의 상태.
ContentCategoryDefinition	콘텐츠 카테고리 정의.
ContentFieldDefinition	JSON 스키마와 같은 문법을 사용한 필드 정의.
ContentFieldSchema	문서에서 추출할 필드 스키마.
ContentFieldType	필드 값의 의미 체계 데이터 형식입니다.
GenerationMethod	생성 방식.
KnowledgeSourceKind	지식 원단 종류.
LabeledDataKnowledgeSource	데이터 지식 소스로 라벨링되어 있습니다.
ProcessingLocation	데이터가 처리될 수 있는 장소입니다. 기본값은 전역으로 설정됩니다.
SupportedModels	분석기가 지원하는 채팅 완성 및 임베딩 모델.
TableFormat	분석 결과 마크다운에서 표의 표현 형식.

AnnotationFormat

열거형

분석 결과 마크다운에서 주석의 표현 형식.

값	Description
none	주석을 나타내지 마세요.
markdown	기본 주석 정보를 마크다운 서식으로 표현하세요.

Azure.Core.Foundations.Error

Object

오류 개체입니다.

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

Azure.Core.Foundations.ErrorResponse

Object

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

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

Azure.Core.Foundations.InnerError

Object

오류에 대한 보다 구체적인 정보를 포함하는 개체입니다. Azure REST API 지침에 따라 - https://aka.ms/AzureRestApiGuidelines#handling-errors.

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

ChartFormat

열거형

분석 결과 마크다운에서 차트의 표현 형식.

값	Description
chartJs	차트를 코드 블록으로 표현Chart.js.
markdown	차트를 마크다운 테이블로 표현하세요.