Classe ImageAnnotatorClient (3.4.4)

3.15.0 (latest) 3.14.0 3.13.0 3.12.1 3.11.0 3.10.2 3.9.0 3.8.1 3.7.4 3.6.0 3.5.0 3.4.5 3.3.1 3.2.0 3.1.4 3.0.0 2.8.0 2.7.3 2.6.3 2.5.0 2.4.4 2.3.2 2.2.0 2.1.0 2.0.0 1.0.2 0.42.0 0.41.0 0.40.0 0.39.0 0.38.1

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 detecção da Google Cloud Vision API em imagens de clientes, como detecção de rosto, ponto de referência, logotipo, marcador e texto. O serviço ImageAnnotator retorna as entidades detectadas das imagens.

Propriedades

transport

Retorna o transporte usado pela instância do cliente.

Retorna
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 de anotação de imagem.

Parâmetros
Nome	Descrição
credentials	Optional[google.auth.credentials.Credentials] As credenciais de autorização a serem anexadas às solicitações. Essas credenciais identificam o aplicativo para o serviço. Se nenhuma for especificada, o cliente tentará determinar as credenciais do ambiente.
transport	Union[str, ImageAnnotatorTransport] O transporte a ser usado. Se definido como "None", um transporte será escolhido automaticamente.
client_options	Optional[Union[google.api_core.client_options.ClientOptions, dict]] Opções personalizadas para o cliente. Ele não vai entrar em vigor se uma instância transport for fornecida. (1) A propriedade api_endpoint pode ser usada para substituir o endpoint padrão fornecido pelo cliente. A variável de ambiente GOOGLE_API_USE_MTLS_ENDPOINT também pode ser usada para substituir o endpoint: "always" (sempre use o endpoint mTLS padrão), "never" (sempre use o endpoint regular padrão) e "auto" (mude automaticamente para o endpoint mTLS padrão se o certificado do cliente estiver presente, esse é o valor padrão). No entanto, a propriedade api_endpoint tem precedência se for fornecida. (2) Se a variável de ambiente GOOGLE_API_USE_CLIENT_CERTIFICATE for "true", a propriedade client_cert_source poderá ser usada para fornecer o certificado do cliente para o transporte TLS mútuo. Se não for fornecido, o certificado de cliente SSL padrão será usado, se estiver presente. Se GOOGLE_API_USE_CLIENT_CERTIFICATE for "false" ou não estiver definido, nenhum certificado de cliente será usado.
client_info	google.api_core.gapic_v1.client_info.ClientInfo As informações do cliente usadas para enviar uma string de user agent com solicitações de API. Se for None, as informações padrão serão usadas. Em geral, só é necessário definir isso se você estiver desenvolvendo sua própria biblioteca de cliente.

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

__exit__

__exit__(type, value, traceback)

Libera os recursos de transporte subjacentes.

Aviso:use APENAS como um gerenciador de contexto se o transporte NÃO for compartilhado com outros clientes. Sair do bloco "with" FECHA o transporte e pode causar erros em outros clientes!

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 detecção e anotação de imagens para um lote de arquivos. Agora, somente "application/pdf", "image/tiff" e "image/gif" são compatíveis. Esse serviço extrairá no máximo 5 (clientes podem especificar quais cinco em frames do AnnotateFileRequest.pages) (gif) ou páginas (pdf ou tiff) de cada arquivo fornecido e realizar a detecção e anotação para 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 solicitação. Uma lista de solicitações para fazer anotações em arquivos usando a API BatchAnnotateFiles.
requests	MutableSequence[google.cloud.vision_v1.types.AnnotateFileRequest] Obrigatório. A lista de solicitações de anotação de arquivo. Agora, oferecemos suporte apenas a um AnnotateFileRequest em BatchAnnotateFilesRequest. Isso corresponde ao campo requests na instância request. Se request for fornecido, esse campo não poderá ser definido.
retry	google.api_core.retry.Retry Designação de quais erros, se houver, devem ser repetidos.
timeout	float O tempo limite desta solicitação.
metadata	Sequence[Tuple[str, str]] Strings que precisam ser enviadas com a solicitação como metadados.

Retorna
Tipo	Descrição
google.cloud.vision_v1.types.BatchAnnotateFilesResponse	Uma lista de respostas de anotações de arquivos.

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

Executar detecção e anotação de imagem 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 solicitação. Várias solicitações de anotação de imagem são agrupadas em uma única chamada de serviço.
requests	MutableSequence[google.cloud.vision_v1.types.AnnotateImageRequest] Obrigatório. Solicitações individuais de anotação de imagem para este lote. Isso corresponde ao campo requests na instância request. Se request for fornecido, esse campo não poderá ser definido.
retry	google.api_core.retry.Retry Designação de quais erros, se houver, devem ser repetidos.
timeout	float O tempo limite desta solicitação.
metadata	Sequence[Tuple[str, str]] Strings que precisam ser enviadas com a solicitação como metadados.

Retorna
Tipo	Descrição
google.cloud.vision_v1.types.BatchAnnotateImagesResponse	Resposta a uma solicitação de anotação de imagem em lote.

common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Retorna uma string billing_account totalmente qualificada.

common_folder_path

common_folder_path(folder: str) -> str

Retorna uma string de pasta totalmente qualificada.

common_location_path

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

Retorna uma string de local totalmente qualificada.

common_organization_path

common_organization_path(organization: str) -> str

Retorna uma string de organização totalmente qualificada.

common_project_path

common_project_path(project: str) -> str

Retorna uma string de projeto totalmente qualificada.

from_service_account_file

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

Cria uma instância desse cliente usando o arquivo de credenciais fornecido.

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

Retorna
Tipo	Descrição
ImageAnnotatorClient	O cliente construído.

from_service_account_info

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

Cria uma instância desse cliente usando as informações de credenciais fornecidas.

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

Retorna
Tipo	Descrição
ImageAnnotatorClient	O cliente construído.

from_service_account_json

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

Cria uma instância desse cliente usando o arquivo de credenciais fornecido.

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

Retorna
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,
)

Retorna o endpoint de API e a origem do certificado do cliente para TLS mútuo.

A origem do certificado do cliente é determinada na seguinte ordem: (1) se a variável de ambiente GOOGLE_API_USE_CLIENT_CERTIFICATE não for "true", a origem do certificado do cliente será "None". (2) se client_options.client_cert_source for fornecido, use o fornecido; se a origem do certificado do cliente padrão existir, use a padrão; caso contrário, a origem do certificado do cliente será "None".

O endpoint de API é determinado na 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 endpoint mTLS padrão. Se a variável de ambiente for "never", use o endpoint da API padrão. Caso contrário, se a origem do certificado do cliente existir, use o endpoint mTLS padrão. Caso contrário, use o endpoint da API padrão.

Mais detalhes estão disponíveis 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. Apenas as propriedades api_endpoint e client_cert_source podem ser usadas nesse método.

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

Retorna
Tipo	Descrição
Tuple[str, Callable[[], Tuple[bytes, bytes]]]	retorna o endpoint de API e a origem do certificado do cliente a serem usados.

parse_common_billing_account_path

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

Analisa um caminho billing_account nos segmentos de componentes dele.

parse_common_folder_path

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

Analisa um caminho de pasta nos segmentos de componentes.

parse_common_location_path

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

Analisa um caminho de local nos segmentos componentes dele.

parse_common_organization_path

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

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

parse_common_project_path

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

Analisa um caminho de projeto nos segmentos de componentes dele.

parse_product_path

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

Analisa um caminho de produto nos segmentos componentes dele.

parse_product_set_path

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

Analisa um caminho "product_set" nos segmentos de componentes dele.

product_path

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

Retorna uma string de produto totalmente qualificada.

product_set_path

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

Retorna uma string "product_set" totalmente qualificada.