Content Analyzers - Analyze

Usługa:

Azure AI Services

Wersja interfejsu API:

2025-05-01-preview

Wyodrębnianie zawartości i pól z danych wejściowych.

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

Z parametrami opcjonalnymi:

POST {endpoint}/contentunderstanding/analyzers/{analyzerId}:analyze?api-version=2025-05-01-preview&stringEncoding={stringEncoding}&processingLocation={processingLocation}

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
analyzerId	path	True	string pattern: ^[a-zA-Z0-9._-]{1,64}$	Unikatowy identyfikator analizatora.
endpoint	path	True	string (uri)	Punkt końcowy usługi Content Understanding.
api-version	query	True	string minLength: 1	Wersja interfejsu API do użycia dla tej operacji.
processingLocation	query		ProcessingLocation	Miejsce, w którym dane mogą być przetwarzane.
stringEncoding	query		StringEncoding	Format kodowania zawartości rozciąga się w odpowiedzi.

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
data	string (byte)	Zawartość binarna zakodowana w formacie Base64 podstawowego sygnału wejściowego do analizy. Należy podać tylko jeden z adresów URL lub danych.
inputs	AnalyzeInput[]	Dodatkowe dane wejściowe do analizy. Obsługiwane tylko w analizatorach z mode=pro.
url	string (uri)	Adres URL podstawowych danych wejściowych do analizy. Należy podać tylko jeden z adresów URL lub danych.

Odpowiedzi

Nazwa	Typ	Opis
202 Accepted		Żądanie zostało zaakceptowane do przetwarzania, ale przetwarzanie nie zostało jeszcze ukończone. 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

Typ: apiKey
W: header

OAuth2Auth

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

Analyze URL

Przykładowe żądanie

HTTP

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

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

Przykładowa odpowiedź

Kod stanu:

202

Operation-Location: https://myendpoint.cognitiveservices.azure.com/contentunderstanding/analyzerResults/3b31320d-8bab-4f88-b19c-2322a7f11034?api-version=2025-05-01-preview

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

Definicje

Nazwa	Opis
AnalyzeInput	Dodatkowe dane wejściowe do analizy.
AnalyzeRequest	Analizowanie żądania operacji.
Azure.Core.Foundations.Error	Obiekt błędu.
Azure.Core.Foundations.ErrorResponse	Odpowiedź zawierająca szczegóły błędu.
Azure.Core.Foundations.InnerError	Obiekt zawierający bardziej szczegółowe informacje o błędzie. Zgodnie z wytycznymi dotyczącymi interfejsu MICROSOFT One API — https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.
ProcessingLocation	Miejsce, w którym dane mogą być przetwarzane.
StringEncoding	Kodowanie ciągów używane dla zakresów zawartości.

AnalyzeInput

Objekt

Dodatkowe dane wejściowe do analizy.

Nazwa	Typ	Opis
data	string (byte)	Zakodowana w formacie Base64 zawartość binarna danych wejściowych do analizy. Należy podać tylko jeden z adresów URL lub danych.
name	string	Nazwa danych wejściowych.
url	string (uri)	Adres URL danych wejściowych do analizy. Należy podać tylko jeden z adresów URL lub danych.

AnalyzeRequest

Objekt

Analizowanie żądania operacji.

Nazwa	Typ	Opis
data	string (byte)	Zawartość binarna zakodowana w formacie Base64 podstawowego sygnału wejściowego do analizy. Należy podać tylko jeden z adresów URL lub danych.
inputs	AnalyzeInput[]	Dodatkowe dane wejściowe do analizy. Obsługiwane tylko w analizatorach z mode=pro.
url	string (uri)	Adres URL podstawowych danych wejściowych do analizy. Należy podać tylko jeden z adresów URL lub danych.

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óły błędu.

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 MICROSOFT One API — https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#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.

ProcessingLocation

Wyliczanie

Miejsce, w którym dane mogą być przetwarzane.

Wartość	Opis
dataZone	Dane mogą być przetwarzane w tej samej strefie danych co zasób.
geography	Dane mogą być przetwarzane w tej samej lokalizacji geograficznej co zasób.
global	Dane mogą być przetwarzane w dowolnym centrum danych platformy Azure na całym świecie.

StringEncoding

Wyliczanie

Kodowanie ciągów używane dla zakresów zawartości.

Wartość	Opis
codePoint	Kodowanie punktów kodowych Unicode (UTF-32), używane przez języki takie jak Python itp.
utf16	Kodowanie UTF-16, używane przez języki takie jak C#, JavaScript, Java itp.
utf8	Kodowanie UTF-8, używane przez języki takie jak Go, Rust, Ruby, PHP itp.