Get Area Of Interest - Get Area Of Interest

Referens

Tjänst:: Azure AI Services

API-version:: 3.2

Den här åtgärden returnerar en avgränsningsruta runt bildens viktigaste område. Ett lyckat svar returneras i JSON. Om begäran misslyckades innehåller svaret en felkod och ett meddelande för att avgöra vad som gick fel. Vid fel returneras felkoden och ett felmeddelande. Felkoden kan vara en av InvalidImageUrl, InvalidImageFormat, InvalidImageSize, NotSupportedImage, FailedToProcess, Timeout eller InternalServerError.

POST {Endpoint}/vision/v3.2/areaOfInterest

Med valfria parametrar:

POST {Endpoint}/vision/v3.2/areaOfInterest?model-version={model-version}

URI-parametrar

Name I Obligatorisk Typ Description

Name	I	Obligatorisk	Typ	Description
Endpoint	path	True	string	Cognitive Services-slutpunkter som stöds.
model-version	query		string	Valfri parameter för att ange versionen av AI-modellen. Godkända värden är: "senaste", "2021-04-01", "2021-05-01". Standardvärdet är "senaste". Reguljärt uttrycksmönster: `^(latest\|\d{4}-\d{2}-\d{2})(-preview)?$`

Endpoint

path

True

string

Cognitive Services-slutpunkter som stöds.

model-version

query

string

Valfri parameter för att ange versionen av AI-modellen. Godkända värden är: "senaste", "2021-04-01", "2021-05-01". Standardvärdet är "senaste".

Reguljärt uttrycksmönster: ^(latest|\d{4}-\d{2}-\d{2})(-preview)?$

Begärandehuvud

Name	Obligatorisk	Typ	Description
Ocp-Apim-Subscription-Key	True	string

Begärandetext

Name	Obligatorisk	Typ	Description
url	True	string	Offentligt nåbar URL för en bild.

Svar

Name	Typ	Description
200 OK	AreaOfInterestResult	Svaret innehåller det extraherade intresseområdet i JSON-format.
Other Status Codes	ComputerVisionErrorResponse	Felsvar.

Säkerhet

Ocp-Apim-Subscription-Key

Typ: apiKey
I: header

Exempel

Successful GetAreaOfInterest request

Exempelbegäran

HTTP

POST https://westus.api.cognitive.microsoft.com/vision/v3.2/areaOfInterest


{
  "url": "{url}"
}

Exempelsvar

Statuskod:: 200

{
  "areaOfInterest": {
    "h": 951,
    "w": 950,
    "x": 160,
    "y": 0
  },
  "requestId": "ed2de1c6-fb55-4686-b0da-4da6e05d283f",
  "metadata": {
    "format": "Jpeg",
    "height": 951,
    "width": 1378
  },
  "modelVersion": "2021-04-01"
}

Definitioner

Name	Description
AreaOfInterestResult	Resultatet av areaOfInterest-åtgärden.
BoundingRect	En avgränsningsruta för ett område inuti en bild.
ComputerVisionError	API-begärandefelet.
ComputerVisionErrorCodes	Felkoden.
ComputerVisionErrorResponse	API-felsvaret.
ComputerVisionInnerError	Information om API-begärandefelet.
ComputerVisionInnerErrorCodeValue	Felkoden.
ImageMetadata	Bildmetadata.
ImageUrl

AreaOfInterestResult

Resultatet av areaOfInterest-åtgärden.

Name	Typ	Description
areaOfInterest	BoundingRect	En avgränsningsruta för ett intresseområde i en bild.
metadata	ImageMetadata	Bildmetadata.
modelVersion	string	Version av AI-modellen.
requestId	string	ID för REST API-begäran.

BoundingRect

En avgränsningsruta för ett område inuti en bild.

Name	Typ	Description
h	integer	Höjd mätt från områdets övre vänstra punkt, i bildpunkter.
w	integer	Bredd mätt från områdets övre vänstra punkt, i bildpunkter.
x	integer	X-koordinat för områdets övre vänstra punkt, i bildpunkter.
y	integer	Y-koordinat för områdets övre vänstra punkt, i bildpunkter.

ComputerVisionError

API-begärandefelet.

Name	Typ	Description
code	ComputerVisionErrorCodes	Felkoden.
innererror	ComputerVisionInnerError	Inre fel innehåller mer specifik information.
message	string	Ett meddelande som förklarar felet som rapporterats av tjänsten.

ComputerVisionErrorCodes

Felkoden.

Name	Typ	Description
InternalServerError	string
InvalidArgument	string
InvalidRequest	string
ServiceUnavailable	string

ComputerVisionErrorResponse

API-felsvaret.

Name	Typ	Description
error	ComputerVisionError	Felinnehåll.

ComputerVisionInnerError

Information om API-begärandefelet.

Name	Typ	Description
code	ComputerVisionInnerErrorCodeValue	Felkoden.
message	string	Felmeddelande.

ComputerVisionInnerErrorCodeValue