REST Resource: projects.locations.products.referenceImages

Resource: ReferenceImage

A ReferenceImage represents a product image and its associated metadata, such as bounding boxes.

JSON representation
{
  "name": string,
  "uri": string,
  "boundingPolys": [
    {
      object(BoundingPoly)
    }
  ]
}
Fields
name

string

The resource name of the reference image.

Format is:

projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID.

This field is ignored when creating a reference image.

uri

string

The Google Cloud Storage URI of the reference image.

The URI must start with gs://.

Required.

boundingPolys[]

object(BoundingPoly)

Bounding polygons around the areas of interest in the reference image. Optional. If this field is empty, the system will try to detect regions of interest. At most 10 bounding polygons will be used.

The provided shape is converted into a non-rotated rectangle. Once converted, the small edge of the rectangle must be greater than or equal to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 is not).

BoundingPoly

A bounding polygon for the detected image annotation.

JSON representation
{
  "vertices": [
    {
      object(Vertex)
    }
  ],
  "normalizedVertices": [
    {
      object(NormalizedVertex)
    }
  ]
}
Fields
vertices[]

object(Vertex)

The bounding polygon vertices.

normalizedVertices[]

object(NormalizedVertex)

The bounding polygon normalized vertices.

Vertex

A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.

JSON representation
{
  "x": number,
  "y": number
}
Fields
x

number

X coordinate.

y

number

Y coordinate.

Coordenadas com valores zero


O formato geral dos polígonos delimitadores na resposta JSON, quando detectados, é uma matriz de quatro objetos de vértices:
  • [{"x": 63,"y": 18},{"x": 123,"y": 18},{"x": 123,"y": 38},{"x": 63,"y": 38}]
Quando a API detecta um valor de 0 para uma coordenada ("x" ou "y"), ela é omitida na resposta JSON. Por exemplo, uma resposta pode ter a seguinte forma: [{},{"x": 28}, {"x": 28,"y": 43},{"y": 43}]. Essa resposta mostra todas as três possibilidades de representação:
  • {}: um objeto vazio quando "x":0 e "y":0.
  • {"x": 28} and {"y": 43} - um objeto com um único par de chave-valor quando uma coordenada é 0, mas a outra é um valor diferente de zero.
  • {"x": 28,"y": 43} - um objeto com os dois pares de chave-valor quando ambas as coordenadas têm um valor diferente de zero.

NormalizedVertex

A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.

JSON representation
{
  "x": number,
  "y": number
}
Fields
x

number

X coordinate.

y

number

Y coordinate.

Coordenadas com valores zero


O formato geral dos polígonos delimitadores na resposta JSON, quando detectados, é uma matriz de quatro objetos de vértices:
  • [{"x": 0.063,"y": 0.018},{"x": 0.123,"y": 0.018},{"x": 0.123,"y": 0.038},{"x": 0.063,"y": 0.038}]
Quando a API detecta um valor de 0 para uma coordenada ("x" ou "y"), ela é omitida na resposta JSON. Por exemplo, uma resposta pode ter a seguinte forma: [{},{"x": 0.028}, {"x": 0.028,"y": 0.043},{"y": 0.043}]. Essa resposta mostra todas as três possibilidades de representação:
  • {}: um objeto vazio quando "x":0.0 e "y":0.0.
  • {"x": 0.028} e {"y": 0.043} - um objeto com um único par de chave-valor quando uma coordenada é 0, mas a outra é um valor diferente de zero.
  • {"x": 0.028,"y": 0.043} - um objeto com os dois pares de chave-valor quando ambas as coordenadas têm um valor diferente de zero.

Methods

create

Creates and returns a new ReferenceImage resource.

delete

Permanently deletes a reference image.

get

Gets information associated with a ReferenceImage.

list

Lists reference images.