Image Analysis - Analyze Image
Przeanalizuj obraz wejściowy. Żą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?api-version=2023-04-01-preview
POST /imageanalysis:analyze?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 |
Żądane funkcje wizualne: tagi, obiekty, podpis, 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 włączanie podpisów neutralnych 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 generowania danych wyjściowych. Jeśli ten parametr nie zostanie określony, wartość domyślna to "en". Zobacz https://aka.ms/cv-languages listę obsługiwanych języków. |
|
model-name
|
query |
string |
Nazwa niestandardowego wytrenowanego modelu. Ten parametr należy określić, jeśli nie określono parametru "features". |
|
smartcrops-aspect-ratios
|
query |
string |
Lista współczynników proporcji do użycia dla funkcji smartCrops. Współczynniki proporcji są obliczane przez podzielenie docelowej szerokości przycinania o wysokość. 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 będzie widoczny w zakresie od 0,5 do 2,0 (włącznie). |
Treść żądania
Nazwa | Wymagane | Typ | Opis |
---|---|---|---|
url | True |
string |
Publiczny adres URL obrazu. |
Odpowiedzi
Nazwa | Typ | Opis |
---|---|---|
200 OK |
Powodzenie |
|
Other Status Codes |
Błąd Nagłówki x-ms-error-code: string |
Przykłady
AnalyzeImage_CustomModel
Przykładowe żądanie
POST /imageanalysis:analyze?model-name=my_model_name&api-version=2023-04-01-preview
{
"url": "https://example.com/image.jpg"
}
Przykładowa odpowiedź
{
"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
}
]
}
]
}
},
"modelVersion": "2023-04-01-preview",
"metadata": {
"width": 660,
"height": 495
}
}
Definicje
Nazwa | Opis |
---|---|
Adult |
Obiekt opisujący dopasowanie zawartości dla dorosłych. |
Adult |
Obiekt opisujący, czy obraz zawiera zawartość zorientowaną na dorosłych i/lub jest rasistą. |
Bounding |
Pole ograniczenia obszaru wewnątrz obrazu. |
Caption |
Krótki opis obrazu. |
Crop |
Region zidentyfikowany na potrzeby inteligentnego przycinania. Dla każdego żądanego współczynnika proporcji zostanie zwrócony jeden region. |
Dense |
Krótki opis obrazu. |
Dense |
Lista podpisów. |
Detected |
Opisuje wykryty obiekt na obrazie. |
Detected |
Osoba wykryta na obrazie. |
Document |
Obiekt wiersza zawartości składający się z sąsiedniej sekwencji elementów zawartości, takich jak wyrazy i znaczniki zaznaczenia. |
Document |
Elementy zawartości i układu wyodrębnione ze strony z danych wejściowych. |
Document |
Ciągły region połączonej właściwości zawartości określony jako przesunięcie i długość. |
Document |
Obiekt reprezentujący obserwowane style tekstu. |
Document |
Obiekt wyrazu składający się z ciągłej sekwencji znaków. W przypadku języków rozdzielonych spacjami, takich jak chiński, japoński i koreański, każdy znak jest reprezentowany jako własny wyraz. |
Error |
Odpowiedź zwrócona po wystąpieniu błędu. |
Error |
Informacje o błędzie. |
Error |
Szczegółowy błąd. |
Image |
Opisz połączone wyniki różnych typów analizy obrazów. |
Image |
Informacje o metadanych obrazu, takie jak wysokość i szerokość. |
Image |
Opisuje wynik przewidywania obrazu. |
Image |
Dokument JSON z adresem URL wskazującym obraz, który ma zostać przeanalizowany. |
Objects |
Opisuje wykryte obiekty na obrazie. |
People |
Obiekt opisujący, czy obraz zawiera osoby. |
Read |
Wyniki operacji odczytu. |
Smart |
Inteligentny wynik przycinania. |
Tag |
Obserwacja jednostki na obrazie wraz z wynikiem ufności. |
Tags |
Lista tagów z poziomem ufności. |
Visual |
Żądane funkcje wizualne: tagi, obiekty, podpis, gęsteCaptions, odczyt, smartCrops, osoby. Ten parametr należy określić, jeśli nie określono parametru "nazwa-modelu". |
AdultMatch
Obiekt opisujący dopasowanie zawartości dla dorosłych.
Nazwa | Typ | Opis |
---|---|---|
confidence |
number |
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
Obiekt opisujący, czy obraz zawiera zawartość zorientowaną na dorosłych i/lub jest rasistą.
Nazwa | Typ | Opis |
---|---|---|
adult |
Obiekt opisujący dopasowanie zawartości dla dorosłych. |
|
gore |
Obiekt opisujący dopasowanie zawartości dla dorosłych. |
|
racy |
Obiekt opisujący dopasowanie zawartości dla dorosłych. |
BoundingBox
Pole ograniczenia obszaru wewnątrz obrazu.
Nazwa | Typ | Opis |
---|---|---|
h |
integer |
Wysokość mierzona od lewego górnego punktu obszaru w pikselach. |
w |
integer |
Szerokość mierzona od lewego górnego punktu obszaru w pikselach. |
x |
integer |
Współrzędna lewa w lewym górnym punkcie obszaru w pikselach. |
y |
integer |
Górna współrzędna lewego górnego punktu obszaru w pikselach. |
CaptionResult
Krótki opis obrazu.
Nazwa | Typ | Opis |
---|---|---|
confidence |
number |
Poziom pewności, jaki usługa ma w podpisie. |
text |
string |
Tekst podpisu. |
CropRegion
Region zidentyfikowany na potrzeby inteligentnego przycinania. Dla każdego żądanego współczynnika proporcji zostanie zwrócony jeden region.
Nazwa | Typ | Opis |
---|---|---|
aspectRatio |
number |
Współczynnik proporcji regionu przycinania. |
boundingBox |
Pole ograniczenia obszaru wewnątrz obrazu. |
DenseCaption
Krótki opis obrazu.
Nazwa | Typ | Opis |
---|---|---|
boundingBox |
Pole ograniczenia obszaru wewnątrz obrazu. |
|
confidence |
number |
Poziom pewności, jaki usługa ma w podpisie. |
text |
string |
Tekst podpisu. |
DenseCaptionsResult
Lista podpisów.
Nazwa | Typ | Opis |
---|---|---|
values |
Lista podpisów. |
DetectedObject
Opisuje wykryty obiekt na obrazie.
Nazwa | Typ | Opis |
---|---|---|
boundingBox |
Pole ograniczenia obszaru wewnątrz obrazu. |
|
id |
string |
Identyfikator wykrytego obiektu. |
tags |
Tag[] |
Zaufania klasyfikacji wykrytego obiektu. |
DetectedPerson
Osoba wykryta na obrazie.
Nazwa | Typ | Opis |
---|---|---|
boundingBox |
Pole ograniczenia obszaru wewnątrz obrazu. |
|
confidence |
number |
Wskaźnik ufności obserwowania osoby na obrazie jako wartość z zakresu od 0 do 1. |
DocumentLine
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[] |
Pole ograniczenia linii. |
content |
string |
Połączona zawartość zawartych elementów w kolejności odczytu. |
spans |
Lokalizacja wiersza w kolejności odczytu łączy zawartość. |
DocumentPage
Elementy zawartości i układu wyodrębnione ze strony z danych wejściowych.
Nazwa | Typ | Opis |
---|---|---|
angle |
number |
Ogólna orientacja zawartości w kierunku zegara mierzona w stopniach między (-180, 180). |
height |
number |
Wysokość obrazu/pliku PDF w pikselach/calach, odpowiednio. |
lines |
Wyodrębnione wiersze ze strony, potencjalnie zawierające zarówno elementy tekstowe, jak i wizualne. |
|
pageNumber |
integer |
Numer strony 1 w dokumencie wejściowym. |
spans |
Lokalizacja strony w kolejności odczytu łączy zawartość. |
|
width |
number |
Szerokość obrazu/formatu PDF w pikselach/calach, odpowiednio. |
words |
Wyodrębnione wyrazy ze strony. |
DocumentSpan
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 |
Liczba znaków w zawartości reprezentowanej przez zakres. |
offset |
integer |
Zero oparty na indeksie zawartości reprezentowanej przez zakres. |
DocumentStyle
Obiekt reprezentujący obserwowane style tekstu.
Nazwa | Typ | Opis |
---|---|---|
confidence |
number |
Pewność prawidłowego identyfikowania stylu. |
isHandwritten |
boolean |
To zawartość odręczna lub nie. |
spans |
Lokalizacja elementów tekstowych w powiązanej zawartości, do których ma zastosowanie styl. |
DocumentWord
Obiekt wyrazu składający się z ciągłej sekwencji znaków. W przypadku języków rozdzielonych spacjami, takich jak chiński, japoński i koreański, każdy znak jest reprezentowany jako własny wyraz.
Nazwa | Typ | Opis |
---|---|---|
boundingBox |
number[] |
Pole ograniczenia wyrazu. |
confidence |
number |
Pewność prawidłowego wyodrębnienia wyrazu. |
content |
string |
Zawartość tekstowa wyrazu. |
span |
Ciągły region połączonej właściwości zawartości określony jako przesunięcie i długość. |
ErrorResponse
Odpowiedź zwrócona po wystąpieniu błędu.
Nazwa | Typ | Opis |
---|---|---|
error |
Informacje o błędzie. |
ErrorResponseDetails
Informacje o błędzie.
Nazwa | Typ | Opis |
---|---|---|
code |
string |
Kod błędu. |
details |
Lista szczegółowych błędów. |
|
innererror |
Szczegółowy błąd. |
|
message |
string |
Komunikat o błędzie. |
target |
string |
Element docelowy błędu. |
ErrorResponseInnerError
Szczegółowy błąd.
Nazwa | Typ | Opis |
---|---|---|
code |
string |
Kod błędu. |
innererror |
Szczegółowy błąd. |
|
message |
string |
Komunikat o błędzie. |
ImageAnalysisResult
Opisz połączone wyniki różnych typów analizy obrazów.
Nazwa | Typ | Opis |
---|---|---|
adultResult |
Obiekt opisujący, czy obraz zawiera zawartość zorientowaną na dorosłych i/lub jest rasistą. |
|
captionResult |
Krótki opis obrazu. |
|
customModelResult |
Opisuje wynik przewidywania obrazu. |
|
denseCaptionsResult |
Lista podpisów. |
|
metadata |
Informacje o metadanych obrazu, takie jak wysokość i szerokość. |
|
modelVersion |
string |
Wersja modelu. |
objectsResult |
Opisuje wykryte obiekty na obrazie. |
|
peopleResult |
Obiekt opisujący, czy obraz zawiera osoby. |
|
readResult |
Wyniki operacji odczytu. |
|
smartCropsResult |
Inteligentny wynik przycinania. |
|
tagsResult |
Lista tagów z poziomem ufności. |
ImageMetadataApiModel
Informacje o metadanych obrazu, takie jak wysokość i szerokość.
Nazwa | Typ | Opis |
---|---|---|
height |
integer |
Wysokość obrazu w pikselach. |
width |
integer |
Szerokość obrazu w pikselach. |
ImagePredictionResult
Opisuje wynik przewidywania obrazu.
Nazwa | Typ | Opis |
---|---|---|
objectsResult |
Opisuje wykryte obiekty na obrazie. |
|
tagsResult |
Lista tagów z poziomem ufności. |
ImageUrl
Dokument JSON z adresem URL wskazującym obraz, który ma zostać przeanalizowany.
Nazwa | Typ | Opis |
---|---|---|
url |
string |
Publiczny adres URL obrazu. |
ObjectsResult
Opisuje wykryte obiekty na obrazie.
Nazwa | Typ | Opis |
---|---|---|
values |
Tablica wykrytych obiektów. |
PeopleResult
Obiekt opisujący, czy obraz zawiera osoby.
Nazwa | Typ | Opis |
---|---|---|
values |
Tablica wykrytych osób. |
ReadResult
Wyniki operacji odczytu.
Nazwa | Typ | Opis |
---|---|---|
content |
string |
Połącz reprezentację ciągu ze wszystkimi elementami tekstowymi i wizualnymi w kolejności odczytu. |
pages |
Lista analizowanych stron. |
|
stringIndexType |
string |
Metoda używana do obliczania przesunięcia i długości ciągu, możliwe wartości to: "textElements", "unicodeCodePoint", "utf16CodeUnit" itp. |
styles |
Wyodrębnione style czcionek. |
SmartCropsResult
Inteligentny wynik przycinania.
Nazwa | Typ | Opis |
---|---|---|
values |
Zalecane regiony do przycinania obrazu. |
Tag
Obserwacja jednostki na obrazie wraz z wynikiem ufności.
Nazwa | Typ | Opis |
---|---|---|
confidence |
number |
Poziom pewności, że zaobserwowano jednostkę. |
name |
string |
Nazwa jednostki. |
TagsResult
Lista tagów z poziomem ufności.
Nazwa | Typ | Opis |
---|---|---|
values |
Tag[] |
Lista tagów z poziomem ufności. |
VisualFeature
Żądane funkcje wizualne: tagi, obiekty, podpis, gęsteCaptions, odczyt, smartCrops, osoby. Ten parametr należy określić, jeśli nie określono parametru "nazwa-modelu".
Nazwa | Typ | Opis |
---|---|---|
caption |
string |
|
denseCaptions |
string |
|
objects |
string |
|
people |
string |
|
read |
string |
|
smartCrops |
string |
|
tags |
string |