Perform web annotation detection on a local file using geo tagging.

## Explore further


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

- [Use geo tagging to detect web annotations on local file](https://docs.cloud.google.com/vision/docs/samples/vision-web-detection-include-geo)

## Code sample

### Go


To learn how to install and use the client library for Vision API Product Search, see
[Vision API Product Search client libraries](https://docs.cloud.google.com/vision/product-search/docs/libraries).


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


To authenticate to Vision API Product Search, 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).


    // detectWebGeo detects geographic metadata from the Vision API for an image at the given file path.
    func detectWebGeo(w io.Writer, file string) error {
    	ctx := context.Background()

    	client, err := vision.NewImageAnnotatorClient(ctx)
    	if err != nil {
    		return err
    	}

    	f, err := os.Open(file)
    	if err != nil {
    		return err
    	}
    	defer f.Close()

    	image, err := vision.NewImageFromReader(f)
    	if err != nil {
    		return err
    	}
    	imageContext := &visionpb.ImageContext{
    		WebDetectionParams: &visionpb.WebDetectionParams{
    			IncludeGeoResults: true,
    		},
    	}
    	web, err := client.DetectWeb(ctx, image, imageContext)
    	if err != nil {
    		return err
    	}

    	if len(web.WebEntities) != 0 {
    		fmt.Fprintln(w, "Entities:")
    		fmt.Fprintln(w, "\tEntity\t\tScore\tDescription")
    		for _, entity := range web.WebEntities {
    			fmt.Fprintf(w, "\t%-14s\t%-2.4f\t%s\n", entity.EntityId, entity.Score, entity.Description)
    		}
    	}

    	return nil
    }

### Java


To learn how to install and use the client library for Vision API Product Search, see
[Vision API Product Search client libraries](https://docs.cloud.google.com/vision/product-search/docs/libraries).


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


To authenticate to Vision API Product Search, 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 com.google.cloud.vision.v1.https://docs.cloud.google.com/java/docs/reference/google-cloud-vision/latest/com.google.cloud.vision.v1.AnnotateImageRequest.html;
    import com.google.cloud.vision.v1.https://docs.cloud.google.com/java/docs/reference/google-cloud-vision/latest/com.google.cloud.vision.v1.BatchAnnotateImagesResponse.html;
    import com.google.cloud.vision.v1.https://docs.cloud.google.com/java/docs/reference/google-cloud-vision/latest/com.google.cloud.vision.v1.Feature.html;
    import com.google.cloud.vision.v1.https://docs.cloud.google.com/java/docs/reference/google-cloud-vision/latest/com.google.cloud.vision.v1.Feature.html.https://docs.cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.Type.html;
    import com.google.cloud.vision.v1.https://docs.cloud.google.com/java/docs/reference/google-cloud-vision/latest/com.google.cloud.vision.v1.Image.html;
    import com.google.cloud.vision.v1.https://docs.cloud.google.com/java/docs/reference/google-cloud-vision/latest/com.google.cloud.vision.v1.ImageAnnotatorClient.html;
    import com.google.cloud.vision.v1.https://docs.cloud.google.com/java/docs/reference/google-cloud-vision/latest/com.google.cloud.vision.v1.ImageContext.html;
    import com.google.cloud.vision.v1.https://docs.cloud.google.com/java/docs/reference/google-cloud-vision/latest/com.google.cloud.vision.v1.WebDetectionParams.html;
    import com.google.protobuf.https://docs.cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.ByteString.html;
    import java.io.FileInputStream;
    import java.io.IOException;
    import java.util.Arrays;

    public class DetectWebEntitiesIncludeGeoResults {

      public static void detectWebEntitiesIncludeGeoResults() throws IOException {
        // TODO(developer): Replace these variables before running the sample.
        String filePath = "path/to/your/image/file.jpg";
        detectWebEntitiesIncludeGeoResults(filePath);
      }

      // Find web entities given a local image.
      public static void detectWebEntitiesIncludeGeoResults(String filePath) throws IOException {

        // Initialize client that will be used to send requests. This client only needs to be created
        // once, and can be reused for multiple requests. After completing all of your requests, call
        // the "close" method on the client to safely clean up any remaining background resources.
        try (https://docs.cloud.google.com/java/docs/reference/google-cloud-vision/latest/com.google.cloud.vision.v1.ImageAnnotatorClient.html client = https://docs.cloud.google.com/java/docs/reference/google-cloud-vision/latest/com.google.cloud.vision.v1.ImageAnnotatorClient.html.create()) {
          // Read in the local image
          https://docs.cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.ByteString.html contents = https://docs.cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.ByteString.html.https://docs.cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.ByteString.html#com_google_protobuf_ByteString_readFrom_java_io_InputStream_(new FileInputStream(filePath));

          // Build the image
          https://docs.cloud.google.com/java/docs/reference/google-cloud-vision/latest/com.google.cloud.vision.v1.Image.html image = https://docs.cloud.google.com/java/docs/reference/google-cloud-vision/latest/com.google.cloud.vision.v1.Image.html.newBuilder().setContent(contents).build();

          // Enable `IncludeGeoResults`
          https://docs.cloud.google.com/java/docs/reference/google-cloud-vision/latest/com.google.cloud.vision.v1.WebDetectionParams.html webDetectionParams =
              https://docs.cloud.google.com/java/docs/reference/google-cloud-vision/latest/com.google.cloud.vision.v1.WebDetectionParams.html.newBuilder().https://docs.cloud.google.com/java/docs/reference/google-cloud-vision/latest/com.google.cloud.vision.v1.WebDetectionParams.Builder.html#com_google_cloud_vision_v1_WebDetectionParams_Builder_setIncludeGeoResults_boolean_(true).build();

          // Set the parameters for the image
          https://docs.cloud.google.com/java/docs/reference/google-cloud-vision/latest/com.google.cloud.vision.v1.ImageContext.html imageContext =
              https://docs.cloud.google.com/java/docs/reference/google-cloud-vision/latest/com.google.cloud.vision.v1.ImageContext.html.newBuilder().https://docs.cloud.google.com/java/docs/reference/google-cloud-vision/latest/com.google.cloud.vision.v1.ImageContext.Builder.html#com_google_cloud_vision_v1_ImageContext_Builder_setWebDetectionParams_com_google_cloud_vision_v1_WebDetectionParams_(webDetectionParams).build();

          // Create the request with the image, imageContext, and the specified feature: web detection
          https://docs.cloud.google.com/java/docs/reference/google-cloud-vision/latest/com.google.cloud.vision.v1.AnnotateImageRequest.html request =
              https://docs.cloud.google.com/java/docs/reference/google-cloud-vision/latest/com.google.cloud.vision.v1.AnnotateImageRequest.html.newBuilder()
                  .addFeatures(https://docs.cloud.google.com/java/docs/reference/google-cloud-vision/latest/com.google.cloud.vision.v1.Feature.html.newBuilder().setType(https://docs.cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.Type.html.WEB_DETECTION))
                  .setImage(image)
                  .setImageContext(imageContext)
                  .build();

          // Perform the request
          https://docs.cloud.google.com/java/docs/reference/google-cloud-vision/latest/com.google.cloud.vision.v1.BatchAnnotateImagesResponse.html response = client.batchAnnotateImages(Arrays.asList(request));

          // Display the results
          response.https://docs.cloud.google.com/java/docs/reference/google-cloud-vision/latest/com.google.cloud.vision.v1.BatchAnnotateImagesResponse.html#com_google_cloud_vision_v1_BatchAnnotateImagesResponse_getResponsesList__().stream()
              .forEach(
                  r ->
                      r.getWebDetection().getWebEntitiesList().stream()
                          .forEach(
                              entity -> {
                                System.out.format("Description: %s%n", entity.getDescription());
                                System.out.format("Score: %f%n", entity.getScore());
                              }));
        }
      }
    }

### Node.js


To learn how to install and use the client library for Vision API Product Search, see
[Vision API Product Search client libraries](https://docs.cloud.google.com/vision/product-search/docs/libraries).


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


To authenticate to Vision API Product Search, 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).

    // Imports the Google Cloud client library
    const vision = require('https://docs.cloud.google.com/nodejs/docs/reference/vision/latest/overview.html');

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

    /**
     * TODO(developer): Uncomment the following line before running the sample.
     */
    // const fileName = 'Local image file, e.g. /path/to/image.png';

    const request = {
      image: {
        source: {
          filename: fileName,
        },
      },
      imageContext: {
        webDetectionParams: {
          includeGeoResults: true,
        },
      },
    };

    // Detect similar images on the web to a local file
    const [result] = await client.webDetection(request);
    const webDetection = https://docs.cloud.google.com/nodejs/docs/reference/vision/latest/vision/protos.google.longrunning.operation.html.webDetection;
    webDetection.webEntities.forEach(entity => {
      console.log(`Score: ${entity.score}`);
      console.log(`Description: ${entity.description}`);
    });

### PHP


To learn how to install and use the client library for Vision API Product Search, see
[Vision API Product Search client libraries](https://docs.cloud.google.com/vision/product-search/docs/libraries).


To authenticate to Vision API Product Search, 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).

    namespace Google\Cloud\Samples\Vision;

    use Google\Cloud\Vision\V1\Client\ImageAnnotatorClient;
    use Google\Cloud\Vision\V1\ImageContext;
    use Google\Cloud\Vision\V1\WebDetectionParams;

    /**
     * Detect web entities on an image and include the image's geo metadata
     * to improve the quality of the detection.
     *
     * @param string $path Path to the image, e.g. "path/to/your/image.jpg"
     */
    function detect_web_with_geo_metadata(string $path)
    {
        $imageAnnotator = new ImageAnnotatorClient();

        # enable include geo results
        $params = new WebDetectionParams();
        $params->setIncludeGeoResults(true);
        $imageContext = new ImageContext();
        $imageContext-> setWebDetectionParams($params);

        # annotate the image
        $image = file_get_contents($path);
        $response = $imageAnnotator->webDetection($image, ['imageContext' => $imageContext]);
        $web = $response->getWebDetection();

        if ($web && $web->getWebEntities()->count()) {
            printf('%d web entities found:' . PHP_EOL,
                count($web->getWebEntities()));
            foreach ($web->getWebEntities() as $entity) {
                printf('Description: %s ' . PHP_EOL, $entity->getDescription());
                printf('Score: %f' . PHP_EOL, $entity->getScore());
                print(PHP_EOL);
            }
        }

        $imageAnnotator->close();
    }

### Python


To learn how to install and use the client library for Vision API Product Search, see
[Vision API Product Search client libraries](https://docs.cloud.google.com/vision/product-search/docs/libraries).


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


To authenticate to Vision API Product Search, 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).

    def web_entities_include_geo_results(path):
        """Detects web annotations given an image, using the geotag metadata
        in the image to detect web entities."""
        from google.cloud import vision

        client = vision.https://docs.cloud.google.com/python/docs/reference/vision/latest/google.cloud.vision_v1.services.image_annotator.ImageAnnotatorClient.html()

        with open(path, "rb") as image_file:
            content = image_file.read()

        image = vision.https://docs.cloud.google.com/python/docs/reference/vision/latest/google.cloud.vision_v1.types.Image.html(content=content)

        web_detection_params = vision.https://docs.cloud.google.com/python/docs/reference/vision/latest/google.cloud.vision_v1.types.WebDetectionParams.html(include_geo_results=True)
        image_context = vision.https://docs.cloud.google.com/python/docs/reference/vision/latest/google.cloud.vision_v1.types.ImageContext.html(web_detection_params=web_detection_params)

        response = client.web_detection(image=image, image_context=image_context)

        for entity in response.web_detection.web_entities:
            print(f"\n\tScore      : {entity.score}")
            print(f"\tDescription: {entity.description}")

        if response.error.message:
            raise Exception(
                "{}\nFor more info on error messages, check: "
                "https://cloud.google.com/apis/design/errors".format(response.error.message)
            )

## 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).