Content Analyzers - Create Or Replace

Usługa:: Azure AI Services

Wersja interfejsu API:: 2025-11-01

Stwórz nowy analizator asynchronicznie.

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

Z parametrami opcjonalnymi:

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
analyzerId	path	True	string minLength: 1 maxLength: 64 pattern: ^[a-zA-Z0-9._-]{1,64}$	Unikalny identyfikator analizatora.
endpoint	path	True	string (uri)	Endpoint usługi Zrozumienie treści.
api-version	query	True	string minLength: 1	Wersja interfejsu API do użycia dla tej operacji.
allowReplace	query		boolean	Pozwól operacji zastąpić istniejący zasób.

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
x-ms-client-request-id		string (uuid)	Nieprzezroczystym, globalnie unikatowym identyfikatorem ciągu generowanego przez klienta dla żądania.

Treść żądania

Nazwa	Typ	Opis
baseAnalyzerId	string minLength: 1 maxLength: 64 pattern: ^[a-zA-Z0-9._-]{1,64}$	Analizator, z którego można stopniowo trenować.
config	ContentAnalyzerConfig	Ustawienia konfiguracji analizatora.
description	string	Opis analizatora.
dynamicFieldSchema	boolean	Wskazuje, czy wynik może zawierać dodatkowe pola poza zdefiniowanym schematem.
fieldSchema	ContentFieldSchema	Schemat pól do wydobycia.
knowledgeSources	KnowledgeSource[]: LabeledDataKnowledgeSource[]	Dodatkowe źródła wiedzy wykorzystane do ulepszania analizatora.
models	object	Mapowanie ról modeli na konkretne nazwy modeli. Np. { "completion": "gpt-4.1", "embedding": "text-embedding-3-large" }.
processingLocation	ProcessingLocation	Miejsce, gdzie dane mogą być przetwarzane. Domyślnie jest globalny.
tags	object	Tagi powiązane z analizatorem.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	ContentAnalyzer	Żądanie zakończyło się pomyślnie. Nagłówki Operation-Location: string x-ms-client-request-id: string
201 Created	ContentAnalyzer	Żądanie zakończyło się pomyślnie i w rezultacie został utworzony nowy zasób. Nagłówki Operation-Location: string x-ms-client-request-id: string
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Nieoczekiwana odpowiedź na błąd. Nagłówki x-ms-error-code: string

Nazwa

Typ

Opis

200 OK

ContentAnalyzer

Żądanie zakończyło się pomyślnie.

Nagłówki

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

201 Created

ContentAnalyzer

Żądanie zakończyło się pomyślnie i w rezultacie został utworzony nowy zasób.

Nagłówki

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

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Nieoczekiwana odpowiedź na błąd.

Nagłówki

x-ms-error-code: string

Zabezpieczenia

Ocp-Apim-Subscription-Key

Uwierzytelnianie oparte na kluczu z wykorzystaniem klucza dostępu zasobu Azure.

Typ: apiKey
W: header

EntraIdToken

Uwierzytelnianie Microsoft Entra ID OAuth2 za pomocą tokena dostępu.

Typ: oauth2
Flow: accessCode
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize
Adres URL tokenu: https://login.microsoftonline.com/common/oauth2/token

Zakresy

Nazwa	Opis
https://cognitiveservices.azure.com/.default

Przykłady

Create or Replace Analyzer

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:: 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"
    }
  ]
}

Kod stanu:: 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"
    }
  ]
}

Definicje

Nazwa	Opis
AnnotationFormat	Format reprezentacji adnotacji w analizie wyników w znaczeniu wyników.
Azure.Core.Foundations.Error	Obiekt błędu.
Azure.Core.Foundations.ErrorResponse	Odpowiedź zawierająca szczegółowe informacje o błędzie.
Azure.Core.Foundations.InnerError	Obiekt zawierający bardziej szczegółowe informacje o błędzie. Zgodnie z wytycznymi dotyczącymi interfejsu API REST platformy Azure — https://aka.ms/AzureRestApiGuidelines#handling-errors.
ChartFormat	Format reprezentacji wykresów w analizie wyników w znaczeniu wyników.
ContentAnalyzer	Analizator, który wyodrębnia zawartość i pola z dokumentów multimodalnych.
ContentAnalyzerConfig	Ustawienia konfiguracji analizatora.
ContentAnalyzerStatus	Status zasobu.
ContentCategoryDefinition	Definicja kategorii treści.
ContentFieldDefinition	Definicja pola za pomocą składni podobnej do schematu JSON.
ContentFieldSchema	Schemat pól do wyodrębnienia z dokumentów.
ContentFieldType	Semantyczny typ danych wartości pola.
GenerationMethod	Metoda generowania.
KnowledgeSourceKind	Źródło wiedzy.
LabeledDataKnowledgeSource	Oznaczone źródło wiedzy o danych.
ProcessingLocation	Miejsce, gdzie dane mogą być przetwarzane. Domyślnie jest globalny.
SupportedModels	Modele uzupełniania czatu i osadzania obsługiwane przez analizator.
TableFormat	Format reprezentacji tabel w analizie wyników w znaczeniu wyników.

AnnotationFormat

Wyliczenie

Format reprezentacji adnotacji w analizie wyników w znaczeniu wyników.

Wartość	Opis
none	Nie reprezentuj adnotacji.
markdown	Reprezentuj podstawowe informacje adnotacyjne za pomocą formatowania markdown.

Azure.Core.Foundations.Error

Objekt

Obiekt błędu.

Nazwa	Typ	Opis
code	string	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.
details	Azure.Core.Foundations.Error[]	Tablica szczegółów dotyczących określonych błędów, które doprowadziły do tego zgłoszonego błędu.
innererror	Azure.Core.Foundations.InnerError	Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie.
message	string	Czytelna dla człowieka reprezentacja błędu.
target	string	Element docelowy błędu.

Azure.Core.Foundations.ErrorResponse

Objekt

Odpowiedź zawierająca szczegółowe informacje o błędzie.

Nazwa	Typ	Opis
error	Azure.Core.Foundations.Error	Obiekt błędu.

Azure.Core.Foundations.InnerError

Objekt

Obiekt zawierający bardziej szczegółowe informacje o błędzie. Zgodnie z wytycznymi dotyczącymi interfejsu API REST platformy Azure — https://aka.ms/AzureRestApiGuidelines#handling-errors.

Nazwa	Typ	Opis
code	string	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.
innererror	Azure.Core.Foundations.InnerError	Błąd wewnętrzny.

ChartFormat

Wyliczenie

Format reprezentacji wykresów w analizie wyników w znaczeniu wyników.

Wartość	Opis
chartJs	Reprezentuj wykresy jako Chart.js bloki kodu.
markdown	Reprezentuj wykresy jako tabele z obniżaniem cen.