Retrieves a list of reference images for a product.

## Explore further


For detailed documentation that includes this code sample, see the following:

- [Getting and listing resources](https://docs.cloud.google.com/vision/product-search/docs/get-list-resources)
- [List reference images for product](https://docs.cloud.google.com/vision/product-search/docs/samples/vision-product-search-list-reference-images)

## Code sample

### Go


Before trying this sample, follow the Go setup instructions in the
[Vision quickstart using
client libraries](https://docs.cloud.google.com/vision/docs/quickstart-client-libraries).


For more information, see the
[Vision Go API
reference documentation](https://godoc.org/cloud.google.com/go/vision/apiv1).


To authenticate to Vision, set up Application Default Credentials.
For more information, see

[Set up authentication for a local development environment](https://docs.cloud.google.com/docs/authentication/set-up-adc-local-dev-environment).


    import (
    	"context"
    	"fmt"
    	"io"

    	vision "cloud.google.com/go/vision/apiv1"
    	"cloud.google.com/go/vision/v2/apiv1/visionpb"
    	"google.golang.org/api/iterator"
    )

    // listReferenceImages lists reference images of a product.
    func listReferenceImages(w io.Writer, projectID string, location string, productID string) error {
    	ctx := context.Background()
    	c, err := vision.NewProductSearchClient(ctx)
    	if err != nil {
    		return fmt.Errorf("NewProductSearchClient: %w", err)
    	}
    	defer c.Close()

    	req := &visionpb.https://docs.cloud.google.com/go/docs/reference/cloud.google.com/go/vision/v2/latest/apiv1/visionpb.html#cloud_google_com_go_vision_v2_apiv1_visionpb_ListReferenceImagesRequest{
    		Parent: fmt.Sprintf("projects/%s/locations/%s/products/%s", projectID, location, productID),
    	}

    	it := c.ListReferenceImages(ctx, req)
    	for {
    		resp, err := it.Next()
    		if err == iterator.Done {
    			break
    		}
    		if err != nil {
    			return fmt.Errorf("Next: %w", err)
    		}

    		fmt.Fprintf(w, "Reference image name: %s\n", resp.Name)
    		fmt.Fprintf(w, "Reference image uri: %s\n", resp.Uri)
    		fmt.Fprintf(w, "Reference image bounding polygons: %s\n", resp.BoundingPolys)
    	}

    	return nil
    }

### Java


Before trying this sample, follow the Java setup instructions in the
[Vision quickstart using
client libraries](https://docs.cloud.google.com/vision/docs/quickstart-client-libraries).


For more information, see the
[Vision Java API
reference documentation](https://docs.cloud.google.com/java/docs/reference/google-cloud-vision/latest/overview).


To authenticate to Vision, set up Application Default Credentials.
For more information, see

[Set up authentication for a local development environment](https://docs.cloud.google.com/docs/authentication/set-up-adc-local-dev-environment).

    /**
     * List all images in a product.
     *
     * @param projectId - Id of the project.
     * @param computeRegion - Region name.
     * @param productId - Id of the product.
     * @throws IOException - on I/O errors.
     */
    public static void listReferenceImagesOfProduct(
        String projectId, String computeRegion, String productId) throws IOException {
      try (ProductSearchClient client = ProductSearchClient.create()) {

        // Get the full path of the product.
        String formattedParent = ProductName.format(projectId, computeRegion, productId);
        for (ReferenceImage image : client.listReferenceImages(formattedParent).iterateAll()) {
          // Display the reference image information.
          System.out.println(String.format("Reference image name: %s", image.getName()));
          System.out.println(
              String.format(
                  "Reference image id: %s",
                  image.getName().substring(image.getName().lastIndexOf('/') + 1)));
          System.out.println(String.format("Reference image uri: %s", image.getUri()));
          System.out.println(
              String.format(
                  "Reference image bounding polygons: %s \n",
                  image.getBoundingPolysList().toString()));
        }
      }
    }

### Node.js


Before trying this sample, follow the Node.js setup instructions in the
[Vision quickstart using
client libraries](https://docs.cloud.google.com/vision/docs/quickstart-client-libraries).


For more information, see the
[Vision Node.js API
reference documentation](https://googleapis.dev/nodejs/vision/latest).


To authenticate to Vision, set up Application Default Credentials.
For more information, see

[Set up authentication for a local development environment](https://docs.cloud.google.com/docs/authentication/set-up-adc-local-dev-environment).

    const vision = require('https://docs.cloud.google.com/nodejs/docs/reference/vision/latest/overview.html');

    const client = new vision.https://docs.cloud.google.com/nodejs/docs/reference/vision/latest/overview.html();

    async function listReferenceImage() {
      /**
       * TODO(developer): Uncomment the following line before running the sample.
       */
      // const projectId = 'Your Google Cloud project Id';

      // const formattedParent = client.productPath(projectId, location, productId);
      // const location = 'A compute region name';
      // const productId = 'Id of the product';
      const formattedParent = client.productPath(projectId, location, productId);
      const request = {
        parent: formattedParent,
      };

      const [response] = await client.listReferenceImages(request);
      response.forEach(image => {
        console.log(`image.name: ${image.name}`);
        console.log(`image.uri: ${image.uri}`);
      });
    }
    listReferenceImage();

### Python


Before trying this sample, follow the Python setup instructions in the
[Vision quickstart using
client libraries](https://docs.cloud.google.com/vision/docs/quickstart-client-libraries).


For more information, see the
[Vision Python API
reference documentation](https://docs.cloud.google.com/python/docs/reference/vision/latest).


To authenticate to Vision, set up Application Default Credentials.
For more information, see

[Set up authentication for a local development environment](https://docs.cloud.google.com/docs/authentication/set-up-adc-local-dev-environment).

    from google.cloud import vision

    def list_reference_images(project_id, location, product_id):
        """List all images in a product.
        Args:
            project_id: Id of the project.
            location: A compute region name.
            product_id: Id of the product.
        """
        client = vision.https://docs.cloud.google.com/python/docs/reference/vision/latest/google.cloud.vision_v1.services.product_search.ProductSearchClient.html()

        # Get the full path of the product.
        product_path = client.https://docs.cloud.google.com/python/docs/reference/vision/latest/google.cloud.vision_v1.services.product_search.ProductSearchClient.html#google_cloud_vision_v1_services_product_search_ProductSearchClient_product_path(
            project=project_id, location=location, product=product_id
        )

        # List all the reference images available in the product.
        reference_images = client.https://docs.cloud.google.com/python/docs/reference/vision/latest/google.cloud.vision_v1.services.product_search.ProductSearchClient.html#google_cloud_vision_v1_services_product_search_ProductSearchClient_list_reference_images(parent=product_path)

        # Display the reference image information.
        for image in reference_images:
            print(f"Reference image name: {image.name}")
            print("Reference image id: {}".format(image.name.split("/")[-1]))
            print(f"Reference image uri: {image.uri}")
            print("Reference image bounding polygons: {}".format(image.bounding_polys))


## What's next


To search and filter code samples for other Google Cloud products, see the
[Google Cloud sample browser](https://docs.cloud.google.com/docs/samples?product=cloudvision).