Class ImageAnnotatorClient (3.4.4)

ImageAnnotatorClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.vision_v1.services.image_annotator.transports.base.ImageAnnotatorTransport]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Serviço que executa tarefas de deteção da Google Cloud Vision API em imagens do cliente, como deteção de caras, pontos de referência, logótipos, etiquetas e texto. O serviço ImageAnnotator devolve entidades detetadas das imagens.

Propriedades

transportes

Devolve o transporte usado pela instância do cliente.

Devoluções
Tipo	Descrição
`ImageAnnotatorTransport`	O transporte usado pela instância do cliente.

Métodos

ImageAnnotatorClient

ImageAnnotatorClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.vision_v1.services.image_annotator.transports.base.ImageAnnotatorTransport]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Instancia o cliente do anotador de imagens.

Parâmetros
Nome	Descrição
`credentials`	`Optional[google.auth.credentials.Credentials]` As credenciais de autorização a anexar aos pedidos. Estas credenciais identificam a aplicação junto do serviço. Se não forem especificadas, o cliente tenta determinar as credenciais a partir do ambiente.
`transport`	`Union[str, ImageAnnotatorTransport]` O transporte a usar. Se estiver definido como Nenhum, é escolhido um transporte automaticamente.
`client_options`	`Optional[Union[google.api_core.client_options.ClientOptions, dict]]` Opções personalizadas para o cliente. Não tem efeito se for fornecida uma instância de `transport`. (1) A propriedade `api_endpoint` pode ser usada para substituir o ponto final predefinido fornecido pelo cliente. A variável de ambiente GOOGLE_API_USE_MTLS_ENDPOINT também pode ser usada para substituir o ponto final: "always" (usar sempre o ponto final mTLS predefinido), "never" (usar sempre o ponto final normal predefinido) e "auto" (mudar automaticamente para o ponto final mTLS predefinido se o certificado do cliente estiver presente. Este é o valor predefinido). No entanto, a propriedade `api_endpoint` tem prioridade se for fornecida. (2) Se a variável de ambiente GOOGLE_API_USE_CLIENT_CERTIFICATE for "true", a propriedade `client_cert_source` pode ser usada para fornecer o certificado de cliente para o transporte TLS mútuo. Se não for fornecido, é usado o certificado de cliente SSL predefinido, se estiver presente. Se GOOGLE_API_USE_CLIENT_CERTIFICATE for "false" ou não estiver definido, não é usado nenhum certificado de cliente.
`client_info`	`google.api_core.gapic_v1.client_info.ClientInfo` As informações do cliente usadas para enviar uma string do agente do utilizador juntamente com os pedidos de API. Se `None`, são usadas as informações predefinidas. Geralmente, só precisa de definir esta opção se estiver a desenvolver a sua própria biblioteca de cliente.

Exceções
Tipo	Descrição
`google.auth.exceptions.MutualTLSChannelError`	Se a criação do transporte TLS mútuo falhou por algum motivo.

exit

__exit__(type, value, traceback)

Liberta os recursos de transporte subjacentes.

async_batch_annotate_files

async_batch_annotate_files(
    request: typing.Optional[
        typing.Union[
            google.cloud.vision_v1.types.image_annotator.AsyncBatchAnnotateFilesRequest,
            dict,
        ]
    ] = None,
    *,
    requests: typing.Optional[
        typing.MutableSequence[
            google.cloud.vision_v1.types.image_annotator.AsyncAnnotateFileRequest
        ]
    ] = None,
    retry: typing.Union[
        google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation

Execute a deteção e a anotação de imagens assíncronas para uma lista de ficheiros genéricos, como ficheiros PDF, que podem conter várias páginas e várias imagens por página. O progresso e os resultados podem ser obtidos através da interface.google.longrunning.Operations Operation.metadata contém OperationMetadata (metadados). Operation.response contém AsyncBatchAnnotateFilesResponse (resultados).

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import vision_v1

def sample_async_batch_annotate_files():
    # Create a client
    client = vision_v1.ImageAnnotatorClient()

    # Initialize request argument(s)
    request = vision_v1.AsyncBatchAnnotateFilesRequest(
    )

    # Make the request
    operation = client.async_batch_annotate_files(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parâmetros
Nome	Descrição
`request`	`Union[google.cloud.vision_v1.types.AsyncBatchAnnotateFilesRequest, dict]` O objeto de pedido. Vários pedidos de anotação de ficheiros assíncronos são processados em lote numa única chamada de serviço.
`requests`	`MutableSequence[google.cloud.vision_v1.types.AsyncAnnotateFileRequest]` Obrigatório. Pedidos de anotação de ficheiros assíncronos individuais para este lote. Corresponde ao campo `requests` na instância `request`. Se `request` for fornecido, este campo não deve ser definido.
`retry`	`google.api_core.retry.Retry` Designação dos erros, se existirem, que devem ser repetidos.
`timeout`	`float` O tempo limite para este pedido.
`metadata`	`Sequence[Tuple[str, str]]` Strings que devem ser enviadas juntamente com o pedido como metadados.

Devoluções
Tipo	Descrição
`google.api_core.operation.Operation`	Um objeto que representa uma operação de longa duração. O tipo de resultado da operação será AsyncBatchAnnotateFilesResponse. Resposta a um pedido de anotação de ficheiros em lote assíncrono.

batch_annotate_files

batch_annotate_files(
    request: typing.Optional[
        typing.Union[
            google.cloud.vision_v1.types.image_annotator.BatchAnnotateFilesRequest, dict
        ]
    ] = None,
    *,
    requests: typing.Optional[
        typing.MutableSequence[
            google.cloud.vision_v1.types.image_annotator.AnnotateFileRequest
        ]
    ] = None,
    retry: typing.Union[
        google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.vision_v1.types.image_annotator.BatchAnnotateFilesResponse

Serviço que realiza a deteção e a anotação de imagens para um lote de ficheiros. Agora, apenas são suportados os tipos "application/pdf", "image/tiff" e "image/gif". Este serviço extrai, no máximo, 5 frames (os clientes podem especificar quais 5 em AnnotateFileRequest.pages) (GIF) ou páginas (PDF ou TIFF) de cada ficheiro fornecido e realiza a deteção e a anotação de cada imagem extraída.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import vision_v1

def sample_batch_annotate_files():
    # Create a client
    client = vision_v1.ImageAnnotatorClient()

    # Initialize request argument(s)
    request = vision_v1.BatchAnnotateFilesRequest(
    )

    # Make the request
    response = client.batch_annotate_files(request=request)

    # Handle the response
    print(response)

Parâmetros
Nome	Descrição
`request`	`Union[google.cloud.vision_v1.types.BatchAnnotateFilesRequest, dict]` O objeto de pedido. Uma lista de pedidos para anotar ficheiros através da API BatchAnnotateFiles.
`requests`	`MutableSequence[google.cloud.vision_v1.types.AnnotateFileRequest]` Obrigatório. A lista de pedidos de anotação de ficheiros. Atualmente, só suportamos um AnnotateFileRequest em BatchAnnotateFilesRequest. Corresponde ao campo `requests` na instância `request`. Se `request` for fornecido, este campo não deve ser definido.
`retry`	`google.api_core.retry.Retry` Designação dos erros, se existirem, que devem ser repetidos.
`timeout`	`float` O tempo limite para este pedido.
`metadata`	`Sequence[Tuple[str, str]]` Strings que devem ser enviadas juntamente com o pedido como metadados.

Devoluções
Tipo	Descrição
`google.cloud.vision_v1.types.BatchAnnotateFilesResponse`	Uma lista de respostas de anotações de ficheiros.

batch_annotate_images

batch_annotate_images(
    request: typing.Optional[
        typing.Union[
            google.cloud.vision_v1.types.image_annotator.BatchAnnotateImagesRequest,
            dict,
        ]
    ] = None,
    *,
    requests: typing.Optional[
        typing.MutableSequence[
            google.cloud.vision_v1.types.image_annotator.AnnotateImageRequest
        ]
    ] = None,
    retry: typing.Union[
        google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.vision_v1.types.image_annotator.BatchAnnotateImagesResponse

Execute a deteção e a anotação de imagens para um lote de imagens.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import vision_v1

def sample_batch_annotate_images():
    # Create a client
    client = vision_v1.ImageAnnotatorClient()

    # Initialize request argument(s)
    request = vision_v1.BatchAnnotateImagesRequest(
    )

    # Make the request
    response = client.batch_annotate_images(request=request)

    # Handle the response
    print(response)

Parâmetros
Nome	Descrição
`request`	`Union[google.cloud.vision_v1.types.BatchAnnotateImagesRequest, dict]` O objeto de pedido. Vários pedidos de anotação de imagens são processados em lote numa única chamada de serviço.
`requests`	`MutableSequence[google.cloud.vision_v1.types.AnnotateImageRequest]` Obrigatório. Pedidos de anotação de imagens individuais para este lote. Corresponde ao campo `requests` na instância `request`. Se `request` for fornecido, este campo não deve ser definido.
`retry`	`google.api_core.retry.Retry` Designação dos erros, se existirem, que devem ser repetidos.
`timeout`	`float` O tempo limite para este pedido.
`metadata`	`Sequence[Tuple[str, str]]` Strings que devem ser enviadas juntamente com o pedido como metadados.

Devoluções
Tipo	Descrição
`google.cloud.vision_v1.types.BatchAnnotateImagesResponse`	Resposta a um pedido de anotação de imagens em lote.

common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Devolve uma string billing_account totalmente qualificada.

common_folder_path

common_folder_path(folder: str) -> str

Devolve uma string de pasta totalmente qualificada.

common_location_path

common_location_path(project: str, location: str) -> str

Devolve uma string de localização totalmente qualificada.

common_organization_path

common_organization_path(organization: str) -> str

Devolve uma string de organização totalmente qualificada.

common_project_path

common_project_path(project: str) -> str

Devolve uma string de projeto totalmente qualificada.

from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Cria uma instância deste cliente com o ficheiro de credenciais fornecido.

Parâmetro
Nome	Descrição
`filename`	`str` O caminho para o ficheiro JSON da chave privada da conta de serviço.

Devoluções
Tipo	Descrição
`ImageAnnotatorClient`	O cliente construído.

from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

Cria uma instância deste cliente com as informações de credenciais fornecidas.

Parâmetro
Nome	Descrição
`info`	`dict` As informações da chave privada da conta de serviço.

Devoluções
Tipo	Descrição
`ImageAnnotatorClient`	O cliente construído.

from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Cria uma instância deste cliente com o ficheiro de credenciais fornecido.

Parâmetro
Nome	Descrição
`filename`	`str` O caminho para o ficheiro JSON da chave privada da conta de serviço.

Devoluções
Tipo	Descrição
`ImageAnnotatorClient`	O cliente construído.

get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Devolva o ponto final da API e a origem do certificado de cliente para o TLS mútuo.

A origem do certificado do cliente é determinada pela seguinte ordem: (1) Se a variável do ambiente GOOGLE_API_USE_CLIENT_CERTIFICATE não for "true", a origem do certificado do cliente é None. (2) Se client_options.client_cert_source for fornecido, use o fornecido. Se a origem do certificado do cliente predefinido existir, use a predefinida. Caso contrário, a origem do certificado do cliente é None.

O ponto final da API é determinado pela seguinte ordem: (1) Se client_options.api_endpoint for fornecido, use o fornecido. (2) Se a variável de ambiente GOOGLE_API_USE_CLIENT_CERTIFICATE for "always", use o ponto final mTLS predefinido; se a variável de ambiente for "never", use o ponto final da API predefinido; caso contrário, se existir uma origem do certificado de cliente, use o ponto final mTLS predefinido; caso contrário, use o ponto final da API predefinido.

Pode encontrar mais detalhes em https://google.aip.dev/auth/4114.

Parâmetro
Nome	Descrição
`client_options`	`google.api_core.client_options.ClientOptions` Opções personalizadas para o cliente. Só é possível usar as propriedades `api_endpoint` e `client_cert_source` neste método.

Exceções
Tipo	Descrição
`google.auth.exceptions.MutualTLSChannelError`	Se ocorrerem erros.

Devoluções
Tipo	Descrição
`Tuple[str, Callable[[], Tuple[bytes, bytes]]]`	devolve o ponto final da API e a origem do certificado do cliente a usar.

parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Analisa um caminho billing_account nos respetivos segmentos de componentes.

parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Analisa um caminho de pasta nos respetivos segmentos de componentes.

parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Analisa um caminho de localização nos respetivos segmentos de componentes.

parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Analisa um caminho da organização nos respetivos segmentos de componentes.

parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Analisa um caminho do projeto nos respetivos segmentos de componentes.

parse_product_path

parse_product_path(path: str) -> typing.Dict[str, str]

Analisa um caminho de produto nos respetivos segmentos de componentes.

parse_product_set_path

parse_product_set_path(path: str) -> typing.Dict[str, str]

Analisa um caminho product_set nos respetivos segmentos de componentes.

product_path

product_path(project: str, location: str, product: str) -> str

Devolve uma string de produto totalmente qualificada.

product_set_path

product_set_path(project: str, location: str, product_set: str) -> str

Devolve uma string product_set totalmente qualificada.