Tutorial de deteção da Web

Público-alvo

O objetivo deste tutorial é ajudar a desenvolver aplicações com a funcionalidade de deteção na Web da API Vision. Parte do princípio de que tem conhecimentos básicos de programação e técnicas, mas mesmo que seja um programador iniciante, deve conseguir acompanhar e executar este tutorial sem dificuldade e, em seguida, usar a documentação de referência da API Vision para criar aplicações básicas.

Este tutorial explica passo a passo uma aplicação da API Vision, mostrando-lhe como fazer uma chamada à API Vision para usar a respetiva funcionalidade de deteção na Web.

Pré-requisitos

Python

Vista geral

Este tutorial explica passo a passo uma aplicação básica da API Vision que usa um Web detection pedido. Uma Web detection resposta anota a imagem enviada no pedido com:

  • etiquetas obtidas da Web
  • URLs de sites que têm imagens correspondentes
  • URLs de imagens da Web que correspondem parcial ou totalmente à imagem no pedido
  • URLs de imagens visualmente semelhantes

Lista de códigos

À medida que lê o código, recomendamos que o acompanhe consultando a referência da API Vision Python.

import argparse

from google.cloud import vision



def annotate(path: str) -> vision.WebDetection:
    """Returns web annotations given the path to an image.

    Args:
        path: path to the input image.

    Returns:
        An WebDetection object with relevant information of the
        image from the internet (i.e., the annotations).
    """
    client = vision.ImageAnnotatorClient()

    if path.startswith("http") or path.startswith("gs:"):
        image = vision.Image()
        image.source.image_uri = path

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

        image = vision.Image(content=content)

    web_detection = client.web_detection(image=image).web_detection

    return web_detection


def report(annotations: vision.WebDetection) -> None:
    """Prints detected features in the provided web annotations.

    Args:
        annotations: The web annotations (WebDetection object) from which
        the features should be parsed and printed.
    """
    if annotations.pages_with_matching_images:
        print(
            f"\n{len(annotations.pages_with_matching_images)} Pages with matching images retrieved"
        )

        for page in annotations.pages_with_matching_images:
            print(f"Url   : {page.url}")

    if annotations.full_matching_images:
        print(f"\n{len(annotations.full_matching_images)} Full Matches found: ")

        for image in annotations.full_matching_images:
            print(f"Url  : {image.url}")

    if annotations.partial_matching_images:
        print(f"\n{len(annotations.partial_matching_images)} Partial Matches found: ")

        for image in annotations.partial_matching_images:
            print(f"Url  : {image.url}")

    if annotations.web_entities:
        print(f"\n{len(annotations.web_entities)} Web entities found: ")

        for entity in annotations.web_entities:
            print(f"Score      : {entity.score}")
            print(f"Description: {entity.description}")


if __name__ == "__main__":
    parser = argparse.ArgumentParser(
        description=__doc__,
        formatter_class=argparse.RawDescriptionHelpFormatter,
    )
    path_help = str(
        "The image to detect, can be web URI, "
        "Google Cloud Storage, or path to local file."
    )
    parser.add_argument("image_url", help=path_help)
    args = parser.parse_args()

    report(annotate(args.image_url))

Esta aplicação simples realiza as seguintes tarefas:

  • Importa as bibliotecas necessárias para executar a aplicação
  • Usa um caminho de imagem como argumento e transmite-o para a função main()
  • Usa o cliente da API Google Cloud para realizar a deteção na Web
  • Itera a resposta e imprime os resultados
  • Imprime uma lista de entidades Web com descrição e classificação
  • Imprime uma lista de páginas correspondentes
  • Imprime uma lista de imagens com correspondência parcial
  • Imprime uma lista de imagens totalmente correspondentes

Uma visão mais detalhada

Importar bibliotecas

import argparse

from google.cloud import vision

Importamos bibliotecas padrão:

  • argparse para permitir que a aplicação aceite nomes de ficheiros de entrada como argumentos
  • io para ler a partir de ficheiros

Outras importações:

  • A classe ImageAnnotatorClient na biblioteca google.cloud.vision para aceder à API Vision.
  • O módulo types na biblioteca google.cloud.vision para criar pedidos.

Executar a aplicação

parser = argparse.ArgumentParser(
    description=__doc__,
    formatter_class=argparse.RawDescriptionHelpFormatter,
)
path_help = str(
    "The image to detect, can be web URI, "
    "Google Cloud Storage, or path to local file."
)
parser.add_argument("image_url", help=path_help)
args = parser.parse_args()

report(annotate(args.image_url))

Aqui, analisamos simplesmente o argumento transmitido que especifica o URL da imagem da Web e transmitimo-lo à função main().

Autenticação na API

Antes de comunicar com o serviço da API Vision, tem de autenticar o seu serviço através de credenciais adquiridas anteriormente. Numa aplicação, a forma mais simples de obter credenciais é usar as Credenciais padrão da aplicação (ADC). A biblioteca de cliente obtém as credenciais automaticamente. Por predefinição, isto é feito através da obtenção de credenciais da variável de ambiente GOOGLE_APPLICATION_CREDENTIALS, que deve ser definida para apontar para o ficheiro de chave JSON da sua conta de serviço (consulte Configure uma conta de serviço para mais informações).

A construir o pedido

client = vision.ImageAnnotatorClient()

if path.startswith("http") or path.startswith("gs:"):
    image = vision.Image()
    image.source.image_uri = path

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

    image = vision.Image(content=content)

web_detection = client.web_detection(image=image).web_detection

Agora que o nosso serviço Vision API está pronto, podemos criar um pedido para o serviço.

Este fragmento do código realiza as seguintes tarefas:

  1. Cria uma instância ImageAnnotatorClient como cliente.
  2. Constrói um objeto Image a partir de um ficheiro local ou de um URI.
  3. Transmite o objeto Image ao método web_detection do cliente.
  4. Devolve as anotações.

Imprimir a resposta

if annotations.pages_with_matching_images:
    print(
        f"\n{len(annotations.pages_with_matching_images)} Pages with matching images retrieved"