Image Analysis - Analyze Stream

Usługa:: Azure AI Services

Wersja interfejsu API:: 2023-04-01-preview

Analizowanie obrazu wejściowego. Żądanie zawiera strumień obrazu z dowolnym typem zawartości ['image/*', 'application/octet-stream'] lub ładunkiem JSON, który zawiera właściwość adresu URL, która ma być używana do pobierania strumienia obrazu.

POST /imageanalysis:analyze?overload=stream&api-version=2023-04-01-preview

Z parametrami opcjonalnymi:

POST /imageanalysis:analyze?overload=stream&features={features}&model-name={model-name}&language={language}&smartcrops-aspect-ratios={smartcrops-aspect-ratios}&gender-neutral-caption={gender-neutral-caption}&api-version=2023-04-01-preview

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
api-version	query	True	string	Żądana wersja interfejsu API.
features	query		VisualFeature[]	Żądane funkcje wizualne: tagi, obiekty, podpisy, gęsteCaptions, odczyt, smartCrops, osoby. Ten parametr należy określić, jeśli nie określono parametru "nazwa-modelu".
gender-neutral-caption	query		boolean	Flaga logiczna umożliwiająca podpisy neutralne pod względem płci dla podpisów i funkcji gęstychCaptions. Jeśli ten parametr nie zostanie określony, wartość domyślna to "false".
language	query		string	Żądany język do generowania danych wyjściowych. Jeśli ten parametr nie zostanie określony, wartość domyślna to "en". Aby uzyskać listę obsługiwanych języków, zobacz https://aka.ms/cv-languages.
model-name	query		string	Nazwa niestandardowego wytrenowanego modelu. Ten parametr należy określić, jeśli parametr "features" nie został określony.
smartcrops-aspect-ratios	query		string	Lista współczynników proporcji do użycia w funkcji smartCrops. Współczynniki proporcji są obliczane przez podzielenie docelowej szerokości przycinania według wysokości. Obsługiwane wartości to od 0,75 do 1,8 (włącznie). Wiele wartości powinno być rozdzielonych przecinkami. Jeśli ten parametr nie zostanie określony, usługa zwróci jedną sugestię przycinania z współczynnikiem proporcji, który zobaczy w zakresie od 0,5 do 2,0 (włącznie).

Treść żądania

Media Types: "application/octet-stream", "image/jpeg", "image/gif", "image/tiff", "image/bmp", "image/png"

Nazwa	Typ	Opis
body	string (byte)	Strumień obrazu.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	ImageAnalysisResult	Powodzenie
Other Status Codes	ErrorResponse	Błąd Nagłówki x-ms-error-code: string

Nazwa

Typ

Opis

200 OK

ImageAnalysisResult

Powodzenie

Other Status Codes

ErrorResponse

Błąd

Nagłówki

x-ms-error-code: string

Przykłady

AnalyzeImageFromImageStream_CustomModel

Przykładowe żądanie

HTTP

POST /imageanalysis:analyze?overload=stream&model-name=my_model_name&api-version=2023-04-01-preview

"Ynl0ZXM="

Przykładowa odpowiedź

Kod stanu:: 200

{
  "modelVersion": "2023-04-01-preview",
  "customModelResult": {
    "objectsResult": {
      "values": [
        {
          "id": "1",
          "boundingBox": {
            "x": 197,
            "y": 68,
            "w": 356,
            "h": 394
          },
          "tags": [
            {
              "name": "class1",
              "confidence": 0.92431640625
            }
          ]
        },
        {
          "id": "2",
          "boundingBox": {
            "x": 0,
            "y": 77,
            "w": 241,
            "h": 359
          },
          "tags": [
            {
              "name": "class1",
              "confidence": 0.87890625
            }
          ]
        }
      ]
    }
  },
  "metadata": {
    "width": 660,
    "height": 495
  }
}

Definicje

Nazwa	Opis
AdultMatch	Obiekt opisujący dopasowanie zawartości dla dorosłych.
AdultResult	Obiekt opisujący, czy obraz zawiera zawartość zorientowaną dla dorosłych i/lub jest rasistą.
BoundingBox	Pole ograniczenia obszaru wewnątrz obrazu.
CaptionResult	Krótki opis obrazu.
CropRegion	Region zidentyfikowany na potrzeby inteligentnego przycinania. Dla każdego żądanego współczynnika proporcji zostanie zwrócony jeden region.
DenseCaption	Krótki opis obrazu.
DenseCaptionsResult	Lista podpisów.
DetectedObject	Opisuje wykryty obiekt na obrazie.
DetectedPerson	Osoba wykryta na obrazie.
DocumentLine	Obiekt wiersza zawartości składający się z sąsiedniej sekwencji elementów zawartości, takich jak wyrazy i znaczniki zaznaczenia.
DocumentPage	Elementy zawartości i układu wyodrębnione ze strony z danych wejściowych.
DocumentSpan	Ciągły region połączonej właściwości zawartości określony jako przesunięcie i długość.
DocumentStyle	Obiekt reprezentujący obserwowane style tekstu.
DocumentWord	Obiekt wyrazu składający się z ciągłej sekwencji znaków. W przypadku języków rozdzielanych spacjami, takich jak chiński, japoński i koreański, każdy znak jest reprezentowany jako własny wyraz.
ErrorResponse	Odpowiedź zwrócona po wystąpieniu błędu.
ErrorResponseDetails	Informacje o błędzie.
ErrorResponseInnerError	Szczegółowy błąd.
ImageAnalysisResult	Opisz połączone wyniki różnych typów analizy obrazów.
ImageMetadataApiModel	Informacje o metadanych obrazu, takie jak wysokość i szerokość.
ImagePredictionResult	Opisuje wynik przewidywania obrazu.
ObjectsResult	Opisuje wykryte obiekty na obrazie.
PeopleResult	Obiekt opisujący, czy obraz zawiera osoby.
ReadResult	Wyniki operacji odczytu.
SmartCropsResult	Wynik inteligentnego przycinania.
Tag	Obserwacja jednostki na obrazie wraz z współczynnikiem ufności.
TagsResult	Lista tagów z poziomem ufności.
VisualFeature	Żądane funkcje wizualne: tagi, obiekty, podpisy, gęsteCaptions, odczyt, smartCrops, osoby. Ten parametr należy określić, jeśli nie określono parametru "nazwa-modelu".

AdultMatch

Objekt

Obiekt opisujący dopasowanie zawartości dla dorosłych.

Nazwa	Typ	Opis
confidence	number (double) minimum: 0 maximum: 1	Wartość wskazująca poziom ufności dopasowanej zawartości dla dorosłych.
isMatch	boolean	Wartość wskazująca, czy obraz jest zgodny z zawartością dla dorosłych.

AdultResult

Objekt

Obiekt opisujący, czy obraz zawiera zawartość zorientowaną dla dorosłych i/lub jest rasistą.

Nazwa	Typ	Opis
adult	AdultMatch	Obiekt opisujący dopasowanie zawartości dla dorosłych.
gore	AdultMatch	Obiekt opisujący dopasowanie zawartości dla dorosłych.
racy	AdultMatch	Obiekt opisujący dopasowanie zawartości dla dorosłych.

BoundingBox

Objekt

Pole ograniczenia obszaru wewnątrz obrazu.

Nazwa	Typ	Opis
h	integer (int32) minimum: 1	Wysokość mierzona od lewego górnego punktu obszaru w pikselach.
w	integer (int32) minimum: 1	Szerokość mierzona od lewego górnego punktu obszaru w pikselach.
x	integer (int32) minimum: 0	Współrzędna lewa górna lewa część obszaru w pikselach.
y	integer (int32) minimum: 0	Górna współrzędna lewego górnego punktu obszaru w pikselach.

CaptionResult

Objekt

Krótki opis obrazu.

Nazwa	Typ	Opis
confidence	number (double) minimum: 0 maximum: 1	Poziom pewności, jaki usługa ma w podpisie.
text	string minLength: 1	Tekst podpisu.

CropRegion

Objekt

Region zidentyfikowany na potrzeby inteligentnego przycinania. Dla każdego żądanego współczynnika proporcji zostanie zwrócony jeden region.

Nazwa	Typ	Opis
aspectRatio	number (double)	Współczynnik proporcji regionu przycinania.
boundingBox	BoundingBox	Pole ograniczenia obszaru wewnątrz obrazu.

DenseCaption

Objekt

Krótki opis obrazu.

Nazwa	Typ	Opis
boundingBox	BoundingBox	Pole ograniczenia obszaru wewnątrz obrazu.
confidence	number (double) minimum: 0 maximum: 1	Poziom pewności, jaki usługa ma w podpisie.
text	string minLength: 1	Tekst podpisu.

DenseCaptionsResult

Objekt

Lista podpisów.

Nazwa	Typ	Opis
values	DenseCaption[]	Lista podpisów.

DetectedObject

Objekt

Opisuje wykryty obiekt na obrazie.

Nazwa	Typ	Opis
boundingBox	BoundingBox	Pole ograniczenia obszaru wewnątrz obrazu.
id	string minLength: 1	Identyfikator wykrytego obiektu.
tags	Tag[]	Klasyfikacja ufności wykrytego obiektu.

DetectedPerson

Objekt

Osoba wykryta na obrazie.

Nazwa	Typ	Opis
boundingBox	BoundingBox	Pole ograniczenia obszaru wewnątrz obrazu.
confidence	number (double) minimum: 0 maximum: 1	Wskaźnik ufności obserwowanego osoby na obrazie jako wartość z zakresu od 0 do 1.

DocumentLine

Objekt

Obiekt wiersza zawartości składający się z sąsiedniej sekwencji elementów zawartości, takich jak wyrazy i znaczniki zaznaczenia.

Nazwa	Typ	Opis
boundingBox	number[] (double)	Pole ograniczenia linii.
content	string minLength: 1	Połączona zawartość zawartych elementów w kolejności odczytu.
spans	DocumentSpan[]	Lokalizacja wiersza w kolejności odczytu łączy zawartość.

DocumentPage

Objekt

Elementy zawartości i układu wyodrębnione ze strony z danych wejściowych.

Nazwa	Typ	Opis
angle	number (double)	Ogólna orientacja zawartości w kierunku wskazówek zegara mierzona w stopniach między (-180, 180).
height	number (double)	Wysokość obrazu/PLIKU PDF w pikselach/calach, odpowiednio.
lines	DocumentLine[]	Wyodrębnione wiersze ze strony, potencjalnie zawierające zarówno elementy tekstowe, jak i wizualne.
pageNumber	integer (int32)	Numer strony opartej na 1 w dokumencie wejściowym.
spans	DocumentSpan[]	Lokalizacja strony w kolejności odczytu łączy zawartość.
width	number (double)	Szerokość obrazu/pliku PDF odpowiednio w pikselach/calach.
words	DocumentWord[]	Wyodrębnione wyrazy ze strony.

DocumentSpan

Objekt

Ciągły region połączonej właściwości zawartości określony jako przesunięcie i długość.

Nazwa	Typ	Opis
length	integer (int32)	Liczba znaków w zawartości reprezentowanej przez zakres.
offset	integer (int32)	Indeks na podstawie zera zawartości reprezentowanej przez zakres.

DocumentStyle

Objekt

Obiekt reprezentujący obserwowane style tekstu.

Nazwa	Typ	Opis
confidence	number (double)	Pewność prawidłowego identyfikowania stylu.
isHandwritten	boolean	Czy zawartość jest odręczna, czy nie.
spans	DocumentSpan[]	Lokalizacja elementów tekstowych w łączonej zawartości, do których ma zastosowanie styl.

DocumentWord

Objekt

Obiekt wyrazu składający się z ciągłej sekwencji znaków. W przypadku języków rozdzielanych spacjami, takich jak chiński, japoński i koreański, każdy znak jest reprezentowany jako własny wyraz.

Nazwa	Typ	Opis
boundingBox	number[] (double)	Pole ograniczenia wyrazu.
confidence	number (double)	Pewność poprawnego wyodrębnienia wyrazu.
content	string minLength: 1	Zawartość tekstowa wyrazu.
span	DocumentSpan	Ciągły region połączonej właściwości zawartości określony jako przesunięcie i długość.

ErrorResponse

Objekt

Odpowiedź zwrócona po wystąpieniu błędu.

Nazwa	Typ	Opis
error	ErrorResponseDetails	Informacje o błędzie.

ErrorResponseDetails

Objekt

Informacje o błędzie.

Nazwa	Typ	Opis
code	string	Kod błędu.
details	ErrorResponseDetails[]	Lista szczegółowych błędów.
innererror	ErrorResponseInnerError	Szczegółowy błąd.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

ErrorResponseInnerError

Objekt

Szczegółowy błąd.

Nazwa	Typ	Opis
code	string	Kod błędu.
innererror	ErrorResponseInnerError	Szczegółowy błąd.
message	string	Komunikat o błędzie.

ImageAnalysisResult

Objekt

Opisz połączone wyniki różnych typów analizy obrazów.

Nazwa	Typ	Opis
adultResult	AdultResult	Obiekt opisujący, czy obraz zawiera zawartość zorientowaną dla dorosłych i/lub jest rasistą.
captionResult	CaptionResult	Krótki opis obrazu.
customModelResult	ImagePredictionResult	Opisuje wynik przewidywania obrazu.
denseCaptionsResult	DenseCaptionsResult	Lista podpisów.
metadata	ImageMetadataApiModel	Informacje o metadanych obrazu, takie jak wysokość i szerokość.
modelVersion	string minLength: 1	Wersja modelu.
objectsResult	ObjectsResult	Opisuje wykryte obiekty na obrazie.
peopleResult	PeopleResult	Obiekt opisujący, czy obraz zawiera osoby.
readResult	ReadResult	Wyniki operacji odczytu.
smartCropsResult	SmartCropsResult	Wynik inteligentnego przycinania.
tagsResult	TagsResult	Lista tagów z poziomem ufności.

ImageMetadataApiModel

Objekt

Informacje o metadanych obrazu, takie jak wysokość i szerokość.

Nazwa	Typ	Opis
height	integer (int32) minimum: 1	Wysokość obrazu w pikselach.
width	integer (int32) minimum: 1	Szerokość obrazu w pikselach.

ImagePredictionResult

Objekt

Opisuje wynik przewidywania obrazu.

Nazwa	Typ	Opis
objectsResult	ObjectsResult	Opisuje wykryte obiekty na obrazie.
tagsResult	TagsResult	Lista tagów z poziomem ufności.

ObjectsResult

Objekt

Opisuje wykryte obiekty na obrazie.

Nazwa	Typ	Opis
values	DetectedObject[]	Tablica wykrytych obiektów.

PeopleResult

Objekt

Obiekt opisujący, czy obraz zawiera osoby.

Nazwa	Typ	Opis
values	DetectedPerson[]	Tablica wykrytych osób.

ReadResult

Objekt

Wyniki operacji odczytu.

Nazwa	Typ	Opis
content	string minLength: 1	Połącz reprezentację ciągu wszystkich elementów tekstowych i wizualnych w kolejności odczytu.
pages	DocumentPage[]	Lista analizowanych stron.
stringIndexType	string minLength: 1	Metoda używana do obliczania przesunięcia i długości ciągu, możliwe wartości obejmują: "textElements", "unicodeCodePoint", "utf16CodeUnit" itp.
styles	DocumentStyle[]	Wyodrębnione style czcionek.

SmartCropsResult

Objekt

Wynik inteligentnego przycinania.

Nazwa	Typ	Opis
values	CropRegion[]	Zalecane regiony do przycinania obrazu.

Tag

Objekt

Obserwacja jednostki na obrazie wraz z współczynnikiem ufności.

Nazwa	Typ	Opis
confidence	number (double) minimum: 0 maximum: 1	Poziom pewności, że jednostka została zaobserwowana.
name	string minLength: 1	Nazwa jednostki.

TagsResult

Objekt

Lista tagów z poziomem ufności.

Nazwa	Typ	Opis
values	Tag[]	Lista tagów z poziomem ufności.

VisualFeature

Wyliczanie

Żądane funkcje wizualne: tagi, obiekty, podpisy, gęsteCaptions, odczyt, smartCrops, osoby. Ten parametr należy określić, jeśli nie określono parametru "nazwa-modelu".

Wartość	Opis
tags
caption
denseCaptions
objects
read
smartCrops
people