docs/dyn/vision_v1.projects.locations.products.referenceImages.html

<html><body>
<style>

body, h1, h2, h3, div, span, p, pre, a {
  margin: 0;
  padding: 0;
  border: 0;
  font-weight: inherit;
  font-style: inherit;
  font-size: 100%;
  font-family: inherit;
  vertical-align: baseline;
}

body {
  font-size: 13px;
  padding: 1em;
}

h1 {
  font-size: 26px;
  margin-bottom: 1em;
}

h2 {
  font-size: 24px;
  margin-bottom: 1em;
}

h3 {
  font-size: 20px;
  margin-bottom: 1em;
  margin-top: 1em;
}

pre, code {
  line-height: 1.5;
  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}

pre {
  margin-top: 0.5em;
}

h1, h2, h3, p {
  font-family: Arial, sans serif;
}

h1, h2, h3 {
  border-bottom: solid #CCC 1px;
}

.toc_element {
  margin-top: 0.5em;
}

.firstline {
  margin-left: 2 em;
}

.method  {
  margin-top: 1em;
  border: solid 1px #CCC;
  padding: 1em;
  background: #EEE;
}

.details {
  font-weight: bold;
  font-size: 14px;
}

</style>

<h1><a href="vision_v1.html">Cloud Vision API</a> . <a href="vision_v1.projects.html">projects</a> . <a href="vision_v1.projects.locations.html">locations</a> . <a href="vision_v1.projects.locations.products.html">products</a> . <a href="vision_v1.projects.locations.products.referenceImages.html">referenceImages</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="#create">create(parent, body, referenceImageId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates and returns a new ReferenceImage resource.</p>
<p class="toc_element">
  <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Permanently deletes a reference image.</p>
<p class="toc_element">
  <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets information associated with a ReferenceImage.</p>
<p class="toc_element">
  <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists reference images.</p>
<p class="toc_element">
  <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="create">create(parent, body, referenceImageId=None, x__xgafv=None)</code>
  <pre>Creates and returns a new ReferenceImage resource.

The `bounding_poly` field is optional. If `bounding_poly` is not specified,
the system will try to detect regions of interest in the image that are
compatible with the product_category on the parent product. If it is
specified, detection is ALWAYS skipped. The system converts polygons into
non-rotated rectangles.

Note that the pipeline will resize the image if the image resolution is too
large to process (above 50MP).

Possible errors:

* Returns INVALID_ARGUMENT if the image_uri is missing or longer than 4096
  characters.
* Returns INVALID_ARGUMENT if the product does not exist.
* Returns INVALID_ARGUMENT if bounding_poly is not provided, and nothing
  compatible with the parent product's product_category is detected.
* Returns INVALID_ARGUMENT if bounding_poly contains more than 10 polygons.

Args:
  parent: string, Resource name of the product in which to create the reference image.

Format is
`projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A `ReferenceImage` represents a product image and its associated metadata,
      # such as bounding boxes.
    "boundingPolys": [ # 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).
      { # A bounding polygon for the detected image annotation.
        "normalizedVertices": [ # The bounding polygon normalized vertices.
          { # 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.
            "y": 3.14, # Y coordinate.
            "x": 3.14, # X coordinate.
          },
        ],
        "vertices": [ # The bounding polygon vertices.
          { # A vertex represents a 2D point in the image.
              # NOTE: the vertex coordinates are in the same scale as the original image.
            "y": 42, # Y coordinate.
            "x": 42, # X coordinate.
          },
        ],
      },
    ],
    "name": "A 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": "A String", # The Google Cloud Storage URI of the reference image.
        #
        # The URI must start with `gs://`.
        #
        # Required.
  }

  referenceImageId: string, A user-supplied resource id for the ReferenceImage to be added. If set,
the server will attempt to use this value as the resource id. If it is
already in use, an error is returned with code ALREADY_EXISTS. Must be at
most 128 characters long. It cannot contain the character `/`.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A `ReferenceImage` represents a product image and its associated metadata,
        # such as bounding boxes.
      "boundingPolys": [ # 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).
        { # A bounding polygon for the detected image annotation.
          "normalizedVertices": [ # The bounding polygon normalized vertices.
            { # 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.
              "y": 3.14, # Y coordinate.
              "x": 3.14, # X coordinate.
            },
          ],
          "vertices": [ # The bounding polygon vertices.
            { # A vertex represents a 2D point in the image.
                # NOTE: the vertex coordinates are in the same scale as the original image.
              "y": 42, # Y coordinate.
              "x": 42, # X coordinate.
            },
          ],
        },
      ],
      "name": "A 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": "A String", # The Google Cloud Storage URI of the reference image.
          #
          # The URI must start with `gs://`.
          #
          # Required.
    }</pre>
</div>

<div class="method">
    <code class="details" id="delete">delete(name, x__xgafv=None)</code>
  <pre>Permanently deletes a reference image.

The image metadata will be deleted right away, but search queries
against ProductSets containing the image may still work until all related
caches are refreshed.

The actual image files are not deleted from Google Cloud Storage.

Args:
  name: string, The resource name of the reference image to delete.

Format is:

`projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated
      # empty messages in your APIs. A typical example is to use it as the request
      # or the response type of an API method. For instance:
      #
      #     service Foo {
      #       rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
      #     }
      #
      # The JSON representation for `Empty` is empty JSON object `{}`.
  }</pre>
</div>

<div class="method">
    <code class="details" id="get">get(name, x__xgafv=None)</code>
  <pre>Gets information associated with a ReferenceImage.

Possible errors:

* Returns NOT_FOUND if the specified image does not exist.

Args:
  name: string, The resource name of the ReferenceImage to get.

Format is:

`projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A `ReferenceImage` represents a product image and its associated metadata,
        # such as bounding boxes.
      "boundingPolys": [ # 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).
        { # A bounding polygon for the detected image annotation.
          "normalizedVertices": [ # The bounding polygon normalized vertices.
            { # 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.
              "y": 3.14, # Y coordinate.
              "x": 3.14, # X coordinate.
            },
          ],
          "vertices": [ # The bounding polygon vertices.
            { # A vertex represents a 2D point in the image.
                # NOTE: the vertex coordinates are in the same scale as the original image.
              "y": 42, # Y coordinate.
              "x": 42, # X coordinate.
            },
          ],
        },
      ],
      "name": "A 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": "A String", # The Google Cloud Storage URI of the reference image.
          #
          # The URI must start with `gs://`.
          #
          # Required.
    }</pre>
</div>

<div class="method">
    <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
  <pre>Lists reference images.

Possible errors:

* Returns NOT_FOUND if the parent product does not exist.
* Returns INVALID_ARGUMENT if the page_size is greater than 100, or less
  than 1.

Args:
  parent: string, Resource name of the product containing the reference images.

Format is
`projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. (required)
  pageSize: integer, The maximum number of items to return. Default 10, maximum 100.
  pageToken: string, A token identifying a page of results to be returned. This is the value
of `nextPageToken` returned in a previous reference image list request.

Defaults to the first page if not specified.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for the `ListReferenceImages` method.
    "nextPageToken": "A String", # The next_page_token returned from a previous List request, if any.
    "pageSize": 42, # The maximum number of items to return. Default 10, maximum 100.
    "referenceImages": [ # The list of reference images.
      { # A `ReferenceImage` represents a product image and its associated metadata,
            # such as bounding boxes.
          "boundingPolys": [ # 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).
            { # A bounding polygon for the detected image annotation.
              "normalizedVertices": [ # The bounding polygon normalized vertices.
                { # 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.
                  "y": 3.14, # Y coordinate.
                  "x": 3.14, # X coordinate.
                },
              ],
              "vertices": [ # The bounding polygon vertices.
                { # A vertex represents a 2D point in the image.
                    # NOTE: the vertex coordinates are in the same scale as the original image.
                  "y": 42, # Y coordinate.
                  "x": 42, # X coordinate.
                },
              ],
            },
          ],
          "name": "A 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": "A String", # The Google Cloud Storage URI of the reference image.
              #
              # The URI must start with `gs://`.
              #
              # Required.
        },
    ],
  }</pre>
</div>

<div class="method">
    <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
  <pre>Retrieves the next page of results.

Args:
  previous_request: The request for the previous page. (required)
  previous_response: The response from the request for the previous page. (required)

Returns:
  A request object that you can call 'execute()' on to request the next
  page. Returns None if there are no more items in the collection.
    </pre>
</div>

</body></html>