Image Analysis - Analyze Image

Reference

Služba:: Azure AI Services

Verze rozhraní API:: 2023-04-01-preview

Analyzujte vstupní obrázek. Požadavek buď obsahuje datový proud obrázku s libovolným typem obsahu ['image/*', 'application/octet-stream'], nebo datovou část JSON, která obsahuje vlastnost url, která se má použít k načtení streamu obrázku.

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

S volitelnými parametry:

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 identifikátoru URI

Name	V	Vyžadováno	Typ	Description
api-version	query	True	string	Požadovaná verze rozhraní API
features	query		VisualFeature[]	Požadované funkce vizuálu: značky, objekty, titulky, denseCaptions, čtení, smartCrops, lidé. Tento parametr je potřeba zadat, pokud není zadaný parametr "název_modelu".
gender-neutral-caption	query		boolean	Logický příznak pro povolení genderově neutrálních titulků pro funkce titulků a funkce denseCaptions Pokud tento parametr není zadaný, výchozí hodnota je "false".
language	query		string	Požadovaný jazyk pro generování výstupu. Pokud tento parametr není zadaný, výchozí hodnota je "en". Podívejte https://aka.ms/cv-languages se na seznam podporovaných jazyků.
model-name	query		string	Název vlastního vytrénovaného modelu. Tento parametr je potřeba zadat, pokud není zadaný parametr "features".
smartcrops-aspect-ratios	query		string	Seznam poměrů stran, které se mají použít pro funkci smartCrops. Poměry stran se počítají vydělením cílové šířky oříznutí výškou. Podporované hodnoty jsou mezi 0,75 a 1,8 (včetně). Více hodnot by mělo být oddělené čárkami. Pokud tento parametr není zadaný, služba vrátí jeden návrh oříznutí s poměrem stran, který je podle ní vhodný od 0,5 do 2,0 (včetně).

Text požadavku

Name	Vyžadováno	Typ	Description
url	True	string	Veřejně dostupná adresa URL obrázku

Odpovědi

Name	Typ	Description
200 OK	ImageAnalysisResult	Success
Other Status Codes	ErrorResponse	Chybová Hlavičky x-ms-error-code: string

Name

Typ

Description

200 OK

ImageAnalysisResult

Success

Other Status Codes

ErrorResponse

Chybová

Hlavičky

x-ms-error-code: string

Příklady

AnalyzeImage_CustomModel

Ukázkový požadavek

HTTP

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

{
  "url": "https://example.com/image.jpg"
}

Ukázková odpověď

Stavový kód:: 200

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

Definice

Name	Description
AdultMatch	Objekt popisující shodu obsahu pro dospělé.
AdultResult	Objekt popisující, zda obrázek obsahuje obsah orientovaný na dospělé nebo zda je nesměšný.
BoundingBox	Ohraničující rámeček pro oblast uvnitř obrázku.
CaptionResult	Stručný popis toho, co obrázek znázorňuje.
CropRegion	Oblast určená pro inteligentní oříznutí. Pro každý požadovaný poměr stran se vrátí jedna oblast.
DenseCaption	Stručný popis toho, co obrázek znázorňuje.
DenseCaptionsResult	Seznam titulků.
DetectedObject	Popisuje zjištěný objekt na obrázku.
DetectedPerson	Osoba detekovaná na obrázku.
DocumentLine	Objekt řádku obsahu, který se skládá ze sousední posloupnosti prvků obsahu, jako jsou slova a značky výběru.
DocumentPage	Prvky obsahu a rozložení extrahované ze stránky ze vstupu
DocumentSpan	Souvislá oblast vlastnosti zřetězeného obsahu zadaná jako posun a délka.
DocumentStyle	Objekt představující pozorované styly textu.
DocumentWord	Objekt slova, který se skládá z souvislé posloupnosti znaků. U jazyků, které nejsou oddělené mezerami, jako je čínština, japonština a korejština, je každý znak reprezentován jako vlastní slovo.
ErrorResponse	Odpověď vrácená, když dojde k chybě.
ErrorResponseDetails	Informace o chybě.
ErrorResponseInnerError	Podrobná chyba
ImageAnalysisResult	Popište kombinované výsledky různých typů analýzy obrázků.
ImageMetadataApiModel	Informace o metadatech obrázku, jako je výška a šířka.
ImagePredictionResult	Popisuje výsledek předpovědi obrázku.
ImageUrl	Dokument JSON s adresou URL odkazující na obrázek, který se má analyzovat.
ObjectsResult	Popisuje zjištěné objekty na obrázku.
PeopleResult	Objekt popisující, jestli obrázek obsahuje osoby.
ReadResult	Výsledky operace čtení.
SmartCropsResult	Výsledek inteligentního oříznutí.
Tag	Pozorování entity na obrázku spolu se skóre spolehlivosti.
TagsResult	Seznam značek s úrovní spolehlivosti
VisualFeature	Požadované funkce vizuálu: značky, objekty, titulky, denseCaptions, čtení, smartCrops, lidé. Tento parametr je potřeba zadat, pokud není zadaný parametr "název_modelu".

AdultMatch

Objekt popisující shodu obsahu pro dospělé.

Name	Typ	Description
confidence	number	Hodnota označující úroveň spolehlivosti odpovídajícího obsahu pro dospělé.
isMatch	boolean	Hodnota označující, jestli se obrázek shoduje s obsahem pro dospělé.

AdultResult

Objekt popisující, zda obrázek obsahuje obsah orientovaný na dospělé nebo zda je nesměšný.

Name	Typ	Description
adult	AdultMatch	Objekt popisující shodu obsahu pro dospělé.
gore	AdultMatch	Objekt popisující shodu obsahu pro dospělé.
racy	AdultMatch	Objekt popisující shodu obsahu pro dospělé.

BoundingBox

Ohraničující rámeček pro oblast uvnitř obrázku.

Name	Typ	Description
h	integer	Výška měřená od levého horního bodu oblasti v pixelech.
w	integer	Šířka měřená od levého horního bodu oblasti v pixelech.
x	integer	Levá souřadnice levého horního bodu oblasti v pixelech
y	integer	Souřadnice horního levého horního bodu oblasti v pixelech

CaptionResult

Stručný popis toho, co obrázek znázorňuje.

Name	Typ	Description
confidence	number	Úroveň spolehlivosti, které má služba v titulku.
text	string	Text titulku.

CropRegion

Oblast určená pro inteligentní oříznutí. Pro každý požadovaný poměr stran se vrátí jedna oblast.

Name	Typ	Description
aspectRatio	number	Poměr stran oblasti oříznutí.
boundingBox	BoundingBox	Ohraničující rámeček pro oblast uvnitř obrázku.

DenseCaption

Stručný popis toho, co obrázek znázorňuje.

Name	Typ	Description
boundingBox	BoundingBox	Ohraničující rámeček pro oblast uvnitř obrázku.
confidence	number	Úroveň spolehlivosti, které má služba v titulku.
text	string	Text titulku.

DenseCaptionsResult

Seznam titulků.

Name	Typ	Description
values	DenseCaption[]	Seznam titulků.

DetectedObject

Popisuje zjištěný objekt na obrázku.

Name	Typ	Description
boundingBox	BoundingBox	Ohraničující rámeček pro oblast uvnitř obrázku.
id	string	ID zjištěného objektu.
tags	Tag[]	Klasifikace spolehlivosti zjištěného objektu.

DetectedPerson

Osoba detekovaná na obrázku.

Name	Typ	Description
boundingBox	BoundingBox	Ohraničující rámeček pro oblast uvnitř obrázku.
confidence	number	Skóre spolehlivosti pozorování osoby na obrázku v rozsahu od 0 do 1.

DocumentLine

Objekt řádku obsahu, který se skládá ze sousední posloupnosti prvků obsahu, jako jsou slova a značky výběru.

Name	Typ	Description
boundingBox	number[]	Ohraničující rámeček čáry.
content	string	Zřetězený obsah obsažených prvků v pořadí čtení.
spans	DocumentSpan[]	Umístění řádku v obsahu zřetězení pořadí čtení

DocumentPage

Prvky obsahu a rozložení extrahované ze stránky ze vstupu

Name	Typ	Description
angle	number	Obecná orientace obsahu ve směru hodinových ručiček měřená ve stupních mezi (-180, 180).
height	number	Výška obrázku nebo PDF v pixelech nebo palcích
lines	DocumentLine[]	Extrahované čáry ze stránky, které mohou obsahovat textové i vizuální prvky.
pageNumber	integer	Číslo stránky založené na 1 ve vstupním dokumentu.
spans	DocumentSpan[]	Umístění stránky v obsahu zřetězení pořadí čtení.
width	number	Šířka obrázku nebo PDF v pixelech/palcích.
words	DocumentWord[]	Extrahovaná slova ze stránky

DocumentSpan

Souvislá oblast vlastnosti zřetězeného obsahu zadaná jako posun a délka.

Name	Typ	Description
length	integer	Počet znaků v obsahu reprezentovaných rozsahem
offset	integer	Index obsahu reprezentovaný rozsahem od nuly.

DocumentStyle

Objekt představující pozorované styly textu.

Name	Typ	Description
confidence	number	Jistota správné identifikace stylu
isHandwritten	boolean	Je obsah psaný rukou nebo ne.
spans	DocumentSpan[]	Umístění textových prvků ve zřetězené obsahu, na který se styl vztahuje.

DocumentWord

Objekt slova, který se skládá z souvislé posloupnosti znaků. U jazyků, které nejsou oddělené mezerami, jako je čínština, japonština a korejština, je každý znak reprezentován jako vlastní slovo.

Name	Typ	Description
boundingBox	number[]	Ohraničující rámeček slova.
confidence	number	Spolehlivost správného extrahování slova
content	string	Textový obsah slova.
span	DocumentSpan	Souvislá oblast vlastnosti zřetězeného obsahu zadaná jako posun a délka.

ErrorResponse

Odpověď vrácená, když dojde k chybě.

Name	Typ	Description
error	ErrorResponseDetails	Informace o chybě.

ErrorResponseDetails

Informace o chybě.

Name	Typ	Description
code	string	Kód chyby
details	ErrorResponseDetails[]	Seznam podrobných chyb
innererror	ErrorResponseInnerError	Podrobná chyba
message	string	Chybová zpráva.
target	string	Cíl chyby.

ErrorResponseInnerError

Podrobná chyba

Name	Typ	Description
code	string	Kód chyby
innererror	ErrorResponseInnerError	Podrobná chyba
message	string	Chybová zpráva.

ImageAnalysisResult

Popište kombinované výsledky různých typů analýzy obrázků.

Name	Typ	Description
adultResult	AdultResult	Objekt popisující, zda obrázek obsahuje obsah orientovaný na dospělé nebo zda je nesměšný.
captionResult	CaptionResult	Stručný popis toho, co obrázek znázorňuje.
customModelResult	ImagePredictionResult	Popisuje výsledek předpovědi obrázku.
denseCaptionsResult	DenseCaptionsResult	Seznam titulků.
metadata	ImageMetadataApiModel	Informace o metadatech obrázku, jako je výška a šířka.
modelVersion	string	Verze modelu.
objectsResult	ObjectsResult	Popisuje zjištěné objekty na obrázku.
peopleResult	PeopleResult	Objekt popisující, jestli obrázek obsahuje osoby.
readResult	ReadResult	Výsledky operace čtení.
smartCropsResult	SmartCropsResult	Výsledek inteligentního oříznutí.
tagsResult	TagsResult	Seznam značek s úrovní spolehlivosti

ImageMetadataApiModel

Informace o metadatech obrázku, jako je výška a šířka.

Name	Typ	Description
height	integer	Výška obrázku v pixelech
width	integer	Šířka obrázku v pixelech.

ImagePredictionResult

Popisuje výsledek předpovědi obrázku.

Name	Typ	Description
objectsResult	ObjectsResult	Popisuje zjištěné objekty na obrázku.
tagsResult	TagsResult	Seznam značek s úrovní spolehlivosti

ImageUrl

Dokument JSON s adresou URL odkazující na obrázek, který se má analyzovat.

Name	Typ	Description
url	string	Veřejně dostupná adresa URL obrázku

ObjectsResult

Popisuje zjištěné objekty na obrázku.

Name	Typ	Description
values	DetectedObject[]	Pole zjištěných objektů.

PeopleResult

Objekt popisující, jestli obrázek obsahuje osoby.

Name	Typ	Description
values	DetectedPerson[]	Pole zjištěných lidí.

ReadResult

Výsledky operace čtení.

Name	Typ	Description
content	string	Zřetězení řetězcové reprezentace všech textových a vizuálních prvků v pořadí čtení
pages	DocumentPage[]	Seznam analyzovaných stránek.
stringIndexType	string	Metoda používaná k výpočtu posunu a délky řetězce, mezi možné hodnoty patří: textElements, unicodeCodePoint, utf16CodeUnit atd.
styles	DocumentStyle[]	Extrahované styly písma.

SmartCropsResult

Výsledek inteligentního oříznutí.

Name	Typ	Description
values	CropRegion[]	Doporučené oblasti pro oříznutí obrázku

Tag

Pozorování entity na obrázku spolu se skóre spolehlivosti.

Name	Typ	Description
confidence	number	Úroveň spolehlivosti, kterou entita zaznamenala.
name	string	Název entity.

TagsResult

Seznam značek s úrovní spolehlivosti

Name	Typ	Description
values	Tag[]	Seznam značek s úrovní spolehlivosti

VisualFeature

Požadované funkce vizuálu: značky, objekty, titulky, denseCaptions, čtení, smartCrops, lidé. Tento parametr je potřeba zadat, pokud není zadaný parametr "název_modelu".

Name	Typ	Description
caption	string
denseCaptions	string
objects	string
people	string
read	string
smartCrops	string
tags	string

Sdílet prostřednictvím

Image Analysis - Analyze Image

Parametry identifikátoru URI

Text požadavku

Odpovědi

Příklady

AnalyzeImage_CustomModel

Ukázkový požadavek

Ukázková odpověď

Definice

AdultMatch

AdultResult

BoundingBox

CaptionResult

CropRegion

DenseCaption

DenseCaptionsResult

DetectedObject

DetectedPerson

DocumentLine

DocumentPage

DocumentSpan

DocumentStyle

DocumentWord

ErrorResponse

ErrorResponseDetails

ErrorResponseInnerError

ImageAnalysisResult

ImageMetadataApiModel

ImagePredictionResult

ImageUrl

ObjectsResult

PeopleResult

ReadResult

SmartCropsResult

Tag

TagsResult

VisualFeature

Další materiály