Content Analyzers - Create Or Replace

Hizmet:: Azure AI Services

API Sürümü:: 2025-11-01

Yeni bir analizör asenkron olarak oluşturun.

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

İsteğe bağlı parametrelerle:

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
analyzerId	path	True	string minLength: 1 maxLength: 64 pattern: ^[a-zA-Z0-9._-]{1,64}$	Analizörün benzersiz tanımlayıcısı.
endpoint	path	True	string (uri)	İçerik Anlama Hizmet Uç Noktası.
api-version	query	True	string minLength: 1	Bu işlem için kullanılacak API sürümü.
allowReplace	query		boolean	İşlemin mevcut bir kaynağı değiştirmesine izin verin.

İstek Başlığı

Name	Gerekli	Tür	Description
x-ms-client-request-id		string (uuid)	İstek için opak, genel olarak benzersiz, istemci tarafından oluşturulan bir dize tanımlayıcısı.

İstek Gövdesi

Name	Tür	Description
baseAnalyzerId	string minLength: 1 maxLength: 64 pattern: ^[a-zA-Z0-9._-]{1,64}$	Aşamalı olarak eğitim alabileceğiniz analizör.
config	ContentAnalyzerConfig	Analizör yapılandırma ayarları.
description	string	Analizörün tanımı.
dynamicFieldSchema	boolean	Sonucun tanımlanmış şema dışında ek alanlar içerip içermeyeceğini gösterir.
fieldSchema	ContentFieldSchema	Alanlar şeması çıkarılmış.
knowledgeSources	KnowledgeSource[]: LabeledDataKnowledgeSource[]	Analizörü geliştirmek için kullanılan ek bilgi kaynakları.
models	object	Model rollerinin belirli model isimlerine eşlenmesi. Örneğin { "completion": "gpt-4.1", "embedding": "metin gömme-3-büyük" }.
processingLocation	ProcessingLocation	Verilerin işlenebileceği yer. Varsayılan olarak küresel.
tags	object	Analizörle ilişkili etiketler.

Yanıtlar

Name	Tür	Description
200 OK	ContentAnalyzer	İstek başarılı oldu. Üst Bilgiler Operation-Location: string x-ms-client-request-id: string
201 Created	ContentAnalyzer	İstek başarılı oldu ve sonuç olarak yeni bir kaynak oluşturuldu. Üst Bilgiler Operation-Location: string x-ms-client-request-id: string
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Beklenmeyen bir hata yanıtı. Üst Bilgiler x-ms-error-code: string

Name

Tür

Description

200 OK

ContentAnalyzer

İstek başarılı oldu.

Üst Bilgiler

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

201 Created

ContentAnalyzer

İstek başarılı oldu ve sonuç olarak yeni bir kaynak oluşturuldu.

Üst Bilgiler

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

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Beklenmeyen bir hata yanıtı.

Üst Bilgiler

x-ms-error-code: string

Güvenlik

Ocp-Apim-Subscription-Key

Azure kaynağının erişim anahtarı kullanılarak anahtar tabanlı kimlik doğrulama.

Tür: apiKey
İçinde: header

EntraIdToken

Microsoft Entra ID OAuth2 kimlik doğrulaması erişim tokenı kullanarak.

Tür: oauth2
Akış: accessCode
Yetkilendirme URL’si: https://login.microsoftonline.com/common/oauth2/authorize
Belirteç URL'si: https://login.microsoftonline.com/common/oauth2/token

Kapsamlar

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

Örnekler

Create or Replace Analyzer

Örnek isteği

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"
    }
  ]
}

Örnek yanıt

Durum kodu:: 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"
    }
  ]
}

Durum kodu:: 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"
    }
  ]
}

Tanımlar

Name	Description
AnnotationFormat	Sonuç markdown'da açıklamaların temsil biçimi.
Azure.Core.Foundations.Error	Hata nesnesi.
Azure.Core.Foundations.ErrorResponse	Hata ayrıntılarını içeren bir yanıt.
Azure.Core.Foundations.InnerError	Hata hakkında daha ayrıntılı bilgi içeren bir nesne. Azure REST API yönergelerine göre - https://aka.ms/AzureRestApiGuidelines#handling-errors.
ChartFormat	Analiz sonucu markdown'da grafiklerin temsil biçimi.
ContentAnalyzer	Multimodal belgelerden içerik ve alanlar çıkaran analizör.
ContentAnalyzerConfig	Bir analizör için yapılandırma ayarları.
ContentAnalyzerStatus	Bir kaynağın durumu.
ContentCategoryDefinition	İçerik kategorisi tanımı.
ContentFieldDefinition	JSON şeması benzeri bir söz dizimiyle alanın tanımı.
ContentFieldSchema	Belgelerden çıkarılacak alanlar şeması.
ContentFieldType	Alan değerinin anlamsal veri türü.
GenerationMethod	Üretim yöntemi.
KnowledgeSourceKind	Bilgi kaynağı türü.
LabeledDataKnowledgeSource	Etiketlenmiş veri bilgi kaynağı.
ProcessingLocation	Verilerin işlenebileceği yer. Varsayılan olarak küresel.
SupportedModels	Analizör tarafından desteklenen sohbet tamamlama ve göme modelleri.
TableFormat	Analiz sonucu markdown'da tabloların temsil biçimi.

AnnotationFormat

Numaralandırma

Sonuç markdown'da açıklamaların temsil biçimi.

Değer	Description
none	Açıklamaları temsil etmeyin.
markdown	Temel annotasyon bilgilerini markdown formatlamasıyla temsil edin.

Azure.Core.Foundations.Error

Nesne

Hata nesnesi.

Name	Tür	Description
code	string	Sunucu tanımlı hata kodları kümesinden biri.
details	Azure.Core.Foundations.Error[]	Bu bildirilen hataya yol açan belirli hatalar hakkında bir dizi ayrıntı.
innererror	Azure.Core.Foundations.InnerError	Hatayla ilgili geçerli nesneden daha belirli bilgiler içeren bir nesne.
message	string	Hatanın insan tarafından okunabilir bir gösterimi.
target	string	Hatanın hedefi.

Azure.Core.Foundations.ErrorResponse

Nesne

Hata ayrıntılarını içeren bir yanıt.

Name	Tür	Description
error	Azure.Core.Foundations.Error	Hata nesnesi.

Azure.Core.Foundations.InnerError

Nesne

Hata hakkında daha ayrıntılı bilgi içeren bir nesne. Azure REST API yönergelerine göre - https://aka.ms/AzureRestApiGuidelines#handling-errors.

Name	Tür	Description
code	string	Sunucu tanımlı hata kodları kümesinden biri.
innererror	Azure.Core.Foundations.InnerError	İç hata.

ChartFormat

Numaralandırma

Analiz sonucu markdown'da grafiklerin temsil biçimi.

Değer	Description
chartJs	Grafikleri Chart.js kod bloğu olarak temsil edin.
markdown	Grafikleri markdown tabloları olarak gösterin.