Clase 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>)

Servicio que realiza tareas de detección de la API de Google Cloud Vision en imágenes de clientes, como detección de rostros, puntos de referencia, logotipos, etiquetas y texto. El servicio ImageAnnotator devuelve las entidades detectadas en las imágenes.

Propiedades

transporte

Devuelve el transporte que usa la instancia del cliente.

Qué muestra
Tipo	Descripción
`ImageAnnotatorTransport`	Es el transporte que usa la instancia del 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>)

Crea una instancia del cliente del anotador de imágenes.

Parámetros
Nombre	Descripción
`credentials`	`Optional[google.auth.credentials.Credentials]` Son las credenciales de autorización que se adjuntan a las solicitudes. Estas credenciales identifican la aplicación ante el servicio. Si no se especifica ninguna, el cliente intentará determinar las credenciales del entorno.
`transport`	`Union[str, ImageAnnotatorTransport]` Es el transporte que se usará. Si se configura como None, se elige un transporte automáticamente.
`client_options`	`Optional[Union[google.api_core.client_options.ClientOptions, dict]]` Son opciones personalizadas para el cliente. No tendrá efecto si se proporciona una instancia de `transport`. (1) La propiedad `api_endpoint` se puede usar para anular el extremo predeterminado que proporciona el cliente. La variable de entorno GOOGLE_API_USE_MTLS_ENDPOINT también se puede usar para anular el extremo: "always" (siempre usa el extremo mTLS predeterminado), "never" (siempre usa el extremo regular predeterminado) y "auto" (cambia automáticamente al extremo mTLS predeterminado si hay un certificado de cliente presente; este es el valor predeterminado). Sin embargo, la propiedad `api_endpoint` tiene prioridad si se proporciona. (2) Si la variable de entorno GOOGLE_API_USE_CLIENT_CERTIFICATE es "true", se puede usar la propiedad `client_cert_source` para proporcionar el certificado de cliente para el transporte de TLS mutuo. Si no se proporciona, se usará el certificado de cliente SSL predeterminado, si está presente. Si GOOGLE_API_USE_CLIENT_CERTIFICATE es "false" o no está configurado, no se usará ningún certificado de cliente.
`client_info`	`google.api_core.gapic_v1.client_info.ClientInfo` Es la información del cliente que se usa para enviar una cadena de usuario-agente junto con las solicitudes a la API. Si es `None`, se usará la información predeterminada. Por lo general, solo necesitas configurar este parámetro si desarrollas tu propia biblioteca cliente.

Excepciones
Tipo	Descripción
`google.auth.exceptions.MutualTLSChannelError`	Si falló la creación del transporte de TLS mutuo por algún motivo.

exit

__exit__(type, value, traceback)

Libera los recursos de transporte subyacentes.

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

Ejecuta la detección y anotación asíncrona de imágenes para obtener una lista de archivos genéricos, como archivos PDF, que pueden contener varias páginas y varias imágenes por página. El progreso y los resultados se pueden recuperar a través de la interfaz google.longrunning.Operations. Operation.metadata contiene OperationMetadata (metadatos). Operation.response contiene 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
Nombre	Descripción
`request`	`Union[google.cloud.vision_v1.types.AsyncBatchAnnotateFilesRequest, dict]` Objeto de solicitud. Las distintas solicitudes de anotación de archivos asíncronos se agrupan en una sola llamada de servicio.
`requests`	`MutableSequence[google.cloud.vision_v1.types.AsyncAnnotateFileRequest]` Obligatorio. Solicitudes de anotaciones de archivos asíncronos individuales para este lote. Esto corresponde al campo `requests` en la instancia de `request`. Si se proporciona `request`, no se debe configurar este campo.
`retry`	`google.api_core.retry.Retry` Es la designación de qué errores, si los hay, se deben volver a intentar.
`timeout`	`float` Es el tiempo de espera de esta solicitud.
`metadata`	`Sequence[Tuple[str, str]]` Son cadenas que se deben enviar junto con la solicitud como metadatos.

Qué muestra
Tipo	Descripción
`google.api_core.operation.Operation`	Es un objeto que representa una operación de larga duración. El tipo de resultado de la operación será AsyncBatchAnnotateFilesResponse, que es la respuesta a una solicitud de anotación de archivos por lotes asíncrona.

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

Servicio que realiza la detección y anotación de imágenes para un lote de archivos. Ahora solo se admiten "application/pdf", "image/tiff" y "image/gif". Este servicio extraerá como máximo 5 marcos (gif) o páginas (pdf o tiff) (los clientes pueden especificar los 5 en AnnotateFileRequest.pages) de cada archivo proporcionado y realizará la detección y anotación para cada imagen 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
Nombre	Descripción
`request`	`Union[google.cloud.vision_v1.types.BatchAnnotateFilesRequest, dict]` Objeto de solicitud. Una lista de solicitudes para anotar archivos mediante la API de BatchAnnotateFiles.
`requests`	`MutableSequence[google.cloud.vision_v1.types.AnnotateFileRequest]` Obligatorio. La lista de solicitudes de anotación de archivos. En este momento, solo se admite una AnnotateFileRequest en BatchAnnotateFilesRequest. Esto corresponde al campo `requests` en la instancia de `request`. Si se proporciona `request`, no se debe configurar este campo.
`retry`	`google.api_core.retry.Retry` Es la designación de qué errores, si los hay, se deben volver a intentar.
`timeout`	`float` Es el tiempo de espera de esta solicitud.
`metadata`	`Sequence[Tuple[str, str]]` Son cadenas que se deben enviar junto con la solicitud como metadatos.

Qué muestra
Tipo	Descripción
`google.cloud.vision_v1.types.BatchAnnotateFilesResponse`	Una lista de respuestas de anotación de archivos.

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

Ejecuta la detección y anotación de imágenes para un lote de imágenes.

# 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
Nombre	Descripción
`request`	`Union[google.cloud.vision_v1.types.BatchAnnotateImagesRequest, dict]` Objeto de solicitud. Las solicitudes de anotaciones de imágenes se agrupan en una sola llamada de servicio.
`requests`	`MutableSequence[google.cloud.vision_v1.types.AnnotateImageRequest]` Obligatorio. Solicitudes de anotación de imágenes individuales para este lote. Esto corresponde al campo `requests` en la instancia de `request`. Si se proporciona `request`, no se debe configurar este campo.
`retry`	`google.api_core.retry.Retry` Es la designación de qué errores, si los hay, se deben volver a intentar.
`timeout`	`float` Es el tiempo de espera de esta solicitud.
`metadata`	`Sequence[Tuple[str, str]]` Son cadenas que se deben enviar junto con la solicitud como metadatos.

Qué muestra
Tipo	Descripción
`google.cloud.vision_v1.types.BatchAnnotateImagesResponse`	Respuesta a una solicitud de anotación de imágenes por lotes.

common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Devuelve una cadena billing_account completamente calificada.

common_folder_path

common_folder_path(folder: str) -> str

Devuelve una cadena de carpeta completamente calificada.

common_location_path

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

Devuelve una cadena de ubicación completamente calificada.

common_organization_path

common_organization_path(organization: str) -> str

Devuelve una cadena de organización completamente calificada.

common_project_path

common_project_path(project: str) -> str

Devuelve una cadena de proyecto completamente calificada.

from_service_account_file

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

Crea una instancia de este cliente con el archivo de credenciales proporcionado.

Parámetro
Nombre	Descripción
`filename`	`str` Es la ruta de acceso al archivo JSON de la clave privada de la cuenta de servicio.

Qué muestra
Tipo	Descripción
`ImageAnnotatorClient`	Es el cliente construido.

from_service_account_info

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

Crea una instancia de este cliente con la información de credenciales proporcionada.

Parámetro
Nombre	Descripción
`info`	`dict` Es la información de la clave privada de la cuenta de servicio.

Qué muestra
Tipo	Descripción
`ImageAnnotatorClient`	Es el cliente construido.

from_service_account_json

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

Crea una instancia de este cliente con el archivo de credenciales proporcionado.

Parámetro
Nombre	Descripción
`filename`	`str` Es la ruta de acceso al archivo JSON de la clave privada de la cuenta de servicio.

Qué muestra
Tipo	Descripción
`ImageAnnotatorClient`	Es el cliente construido.

get_mtls_endpoint_and_cert_source

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

Devuelve el extremo de API y la fuente del certificado del cliente para TLS mutua.

La fuente del certificado de cliente se determina en el siguiente orden: (1) Si la variable de entorno GOOGLE_API_USE_CLIENT_CERTIFICATE no es "true", la fuente del certificado de cliente es None. (2) Si se proporciona client_options.client_cert_source, usa el proporcionado; si existe la fuente predeterminada del certificado de cliente, usa la predeterminada; de lo contrario, la fuente del certificado de cliente es None.

El extremo de API se determina en el siguiente orden: (1) Si se proporciona client_options.api_endpoint, se usa el proporcionado. (2) Si la variable de entorno GOOGLE_API_USE_CLIENT_CERTIFICATE es "always", usa el extremo mTLS predeterminado; si la variable de entorno es "never", usa el extremo de la API predeterminado; de lo contrario, si existe la fuente del certificado del cliente, usa el extremo mTLS predeterminado; de lo contrario, usa el extremo de la API predeterminado.

Puedes encontrar más detalles en https://google.aip.dev/auth/4114.

Parámetro
Nombre	Descripción
`client_options`	`google.api_core.client_options.ClientOptions` Son opciones personalizadas para el cliente. En este método, solo se pueden usar las propiedades `api_endpoint` y `client_cert_source`.

Excepciones
Tipo	Descripción
`google.auth.exceptions.MutualTLSChannelError`	Si se produce algún error

Qué muestra
Tipo	Descripción
`Tuple[str, Callable[[], Tuple[bytes, bytes]]]`	Devuelve el extremo de API y la fuente del certificado del cliente que se usarán.

parse_common_billing_account_path

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

Analiza una ruta de acceso a billing_account en sus segmentos de componentes.

parse_common_folder_path

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

Analiza una ruta de acceso a una carpeta en sus segmentos de componentes.

parse_common_location_path

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

Analiza una ruta de ubicación en sus segmentos de componentes.

parse_common_organization_path

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

Analiza una ruta de organización en sus segmentos de componentes.

parse_common_project_path

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

Analiza una ruta de acceso del proyecto en sus segmentos de componentes.

parse_product_path

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

Analiza una ruta de producto en sus segmentos de componentes.

parse_product_set_path

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

Analiza una ruta de acceso a product_set en sus segmentos de componentes.

product_path

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

Devuelve una cadena de producto completa.

product_set_path

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

Devuelve una cadena product_set completa.