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 Cloud Vision de Google en imágenes de clientes, como la detección de caras, puntos de referencia, logotipos, etiquetas y texto. El servicio ImageAnnotator devuelve las entidades detectadas en las imágenes.

Propiedades

transporte

Devuelve el transporte usado por la instancia del cliente.

Devoluciones
Tipo	Descripción
`ImageAnnotatorTransport`	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 de anotador de imágenes.

Parámetros
Nombre	Descripción
`credentials`	`Optional[google.auth.credentials.Credentials]` Las credenciales de autorización que se adjuntarán a las solicitudes. Estas credenciales identifican la aplicación en el servicio. Si no se especifica ninguna, el cliente intentará obtener las credenciales del entorno.
`transport`	`Union[str, ImageAnnotatorTransport]` El transporte que se va a usar. Si se define como None, se elige un transporte automáticamente.
`client_options`	`Optional[Union[google.api_core.client_options.ClientOptions, dict]]` 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 endpoint predeterminado proporcionado por el cliente. La variable de entorno GOOGLE_API_USE_MTLS_ENDPOINT también se puede usar para anular el endpoint: "always" (usar siempre el endpoint mTLS predeterminado), "never" (usar siempre el endpoint normal predeterminado) y "auto" (cambiar automáticamente al endpoint 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 TLS mutuo. Si no se proporciona, se usará el certificado de cliente SSL predeterminado, si está presente. Si GOOGLE_API_USE_CLIENT_CERTIFICATE tiene el valor "false" o no se ha definido, no se usará ningún certificado de cliente.
`client_info`	`google.api_core.gapic_v1.client_info.ClientInfo` La información del cliente que se usa para enviar una cadena user-agent junto con las solicitudes de API. Si `None`, se usará la información predeterminada. Por lo general, solo tienes que definirlo si estás desarrollando tu propia biblioteca de cliente.

Excepciones
Tipo	Descripción
`google.auth.exceptions.MutualTLSChannelError`	Si no se ha podido crear el transporte TLS mutuo por algún motivo.

exit

__exit__(type, value, traceback)

Libera los recursos del transporte subyacente.

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 la anotación de imágenes asíncronas para 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 obtener 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]` El objeto de solicitud. Varias solicitudes asíncronas de anotación de archivos se agrupan en una sola llamada de servicio.
`requests`	`MutableSequence[google.cloud.vision_v1.types.AsyncAnnotateFileRequest]` Obligatorio. Solicitudes individuales de anotación de archivos asíncronas de este lote. Corresponde al campo `requests` de la instancia `request`. Si se proporciona `request`, no se debe definir este valor.
`retry`	`google.api_core.retry.Retry` Designación de los errores que se deben reintentar (si los hay).
`timeout`	`float` Tiempo de espera de esta solicitud.
`metadata`	`Sequence[Tuple[str, str]]` Cadenas que se deben enviar junto con la solicitud como metadatos.

Devoluciones
Tipo	Descripción
`google.api_core.operation.Operation`	Objeto que representa una operación de larga duración. El tipo de resultado de la operación será AsyncBatchAnnotateFilesResponse. Respuesta a una solicitud asíncrona de anotación de archivos por lotes.

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 la anotación de imágenes en un lote de archivos. Ahora solo se admiten "application/pdf", "image/tiff" e "image/gif". Este servicio extraerá un máximo de 5 fotogramas (gif) o páginas (pdf o tiff) de cada archivo proporcionado y realizará la detección y la anotación de cada imagen extraída. Los clientes pueden especificar qué 5 fotogramas o páginas quieren extraer en AnnotateFileRequest.pages.

# 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]` El objeto de solicitud. Lista de solicitudes para anotar archivos mediante la API BatchAnnotateFiles.
`requests`	`MutableSequence[google.cloud.vision_v1.types.AnnotateFileRequest]` Obligatorio. Lista de solicitudes de anotación de archivos. Por el momento, solo admitimos un AnnotateFileRequest en BatchAnnotateFilesRequest. Corresponde al campo `requests` de la instancia `request`. Si se proporciona `request`, no se debe definir este valor.
`retry`	`google.api_core.retry.Retry` Designación de los errores que se deben reintentar (si los hay).
`timeout`	`float` Tiempo de espera de esta solicitud.
`metadata`	`Sequence[Tuple[str, str]]` Cadenas que se deben enviar junto con la solicitud como metadatos.

Devoluciones
Tipo	Descripción
`google.cloud.vision_v1.types.BatchAnnotateFilesResponse`	Lista de respuestas de anotaciones 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 la anotación de imágenes en 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]` El objeto de solicitud. Varias solicitudes de anotación 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 de este lote. Corresponde al campo `requests` de la instancia `request`. Si se proporciona `request`, no se debe definir este valor.
`retry`	`google.api_core.retry.Retry` Designación de los errores que se deben reintentar (si los hay).
`timeout`	`float` Tiempo de espera de esta solicitud.
`metadata`	`Sequence[Tuple[str, str]]` Cadenas que se deben enviar junto con la solicitud como metadatos.

Devoluciones
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 completa.

common_folder_path

common_folder_path(folder: str) -> str

Devuelve una cadena de carpeta completa.

common_location_path

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

Devuelve una cadena de ubicación completa.

common_organization_path

common_organization_path(organization: str) -> str

Devuelve una cadena de organización completa.

common_project_path

common_project_path(project: str) -> str

Devuelve una cadena de proyecto completa.

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` Ruta al archivo JSON de la clave privada de la cuenta de servicio.

Devoluciones
Tipo	Descripción
`ImageAnnotatorClient`	El cliente creado.

from_service_account_info

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

Crea una instancia de este cliente con la información de las credenciales proporcionadas. info.

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

Devoluciones
Tipo	Descripción
`ImageAnnotatorClient`	El cliente creado.

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` Ruta al archivo JSON de la clave privada de la cuenta de servicio.

Devoluciones
Tipo	Descripción
`ImageAnnotatorClient`	El cliente creado.

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 endpoint de la API y la fuente del certificado de cliente para TLS mutuo.

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, se usa el proporcionado. Si existe la fuente predeterminada del certificado de cliente, se usa esa. De lo contrario, la fuente del certificado de cliente es None.

El endpoint de la 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 endpoint mTLS predeterminado. Si la variable de entorno es "never", usa el endpoint de la API predeterminado. De lo contrario, si existe la fuente del certificado de cliente, usa el endpoint mTLS predeterminado. Si no, usa el endpoint de la API predeterminado.

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

Parámetro
Nombre	Descripción
`client_options`	`google.api_core.client_options.ClientOptions` 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.

Devoluciones
Tipo	Descripción
`Tuple[str, Callable[[], Tuple[bytes, bytes]]]`	Devuelve el endpoint de la API y el origen del certificado de cliente que se va a usar.

parse_common_billing_account_path

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

Analiza una ruta de 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 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 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 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.