Google uses AI technology to translate content into your preferred language. AI translations can contain errors.

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

Service effectuant des tâches de détection de l'API Google Cloud Vision sur les images client, telles que la détection de visages, de points de repère, de logos, de thèmes et de texte. Le service ImageAnnotator renvoie les entités détectées dans les images.

Propriétés

transport

Renvoie le transport utilisé par l'instance cliente.

Renvoie
Type	Description
`ImageAnnotatorTransport`	Transport utilisé par l'instance cliente.

Méthodes

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

Instancie le client d'annotation d'images.

Paramètres
Nom	Description
`credentials`	`Optional[google.auth.credentials.Credentials]` Identifiants d'autorisation à joindre aux requêtes. Ces identifiants permettent d'identifier l'application auprès du service. Si aucun n'est spécifié, le client tentera de déterminer les identifiants à partir de l'environnement.
`transport`	`Union[str, ImageAnnotatorTransport]` Transport à utiliser. Si la valeur est définie sur "None", un transport est choisi automatiquement.
`client_options`	`Optional[Union[google.api_core.client_options.ClientOptions, dict]]` Options personnalisées pour le client. Il ne prendra pas effet si une instance `transport` est fournie. (1) La propriété `api_endpoint` peut être utilisée pour remplacer le point de terminaison par défaut fourni par le client. Variable d'environnement GOOGLE_API_USE_MTLS_ENDPOINT peut également être utilisée pour remplacer le point de terminaison : "always" (toujours utiliser le point de terminaison mTLS par défaut), "never" (toujours utiliser le point de terminaison standard par défaut) et "auto" (basculer automatiquement vers le point de terminaison mTLS par défaut si le certificat client est présent, il s'agit de la valeur par défaut). Toutefois, la propriété `api_endpoint` est prioritaire si elle est fournie. (2) Si la variable d'environnement GOOGLE_API_USE_CLIENT_CERTIFICATE est définie sur "true", la propriété `client_cert_source` peut être utilisée pour fournir un certificat client pour le transport TLS mutuel. Si aucune valeur n'est fournie, le certificat client SSL par défaut est utilisé, le cas échéant. Si GOOGLE_API_USE_CLIENT_CERTIFICATE est défini sur "false" ou n'est pas défini, aucun certificat client ne sera utilisé.
`client_info`	`google.api_core.gapic_v1.client_info.ClientInfo` Informations sur le client utilisées pour envoyer une chaîne user-agent avec les requêtes API. Si la valeur est `None`, les informations par défaut seront utilisées. En règle générale, vous n'avez besoin de définir cette option que si vous développez votre propre bibliothèque cliente.

Exceptions
Type	Description
`google.auth.exceptions.MutualTLSChannelError`	Si la création du transport TLS mutuel a échoué pour une raison quelconque.

exit

__exit__(type, value, traceback)

Libère les ressources de transport sous-jacentes.

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

Détecte et annote de manière asynchrone les images d'une liste de fichiers génériques, tels que des fichiers PDF, qui peuvent contenir plusieurs pages et plusieurs images par page. La progression et les résultats peuvent être récupérés via l'interface google.longrunning.Operations. Operation.metadata contient OperationMetadata (métadonnées). Operation.response contient AsyncBatchAnnotateFilesResponse (résultats).

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

Paramètres
Nom	Description
`request`	`Union[google.cloud.vision_v1.types.AsyncBatchAnnotateFilesRequest, dict]` Objet de la requête. Plusieurs requêtes d'annotation de fichiers asynchrones sont regroupées dans un seul appel de service.
`requests`	`MutableSequence[google.cloud.vision_v1.types.AsyncAnnotateFileRequest]` Obligatoire. Requêtes d'annotation de fichiers asynchrones individuelles du lot. Cela correspond au champ `requests` de l'instance `request`. Si `request` est fourni, ce champ ne doit pas être défini.
`retry`	`google.api_core.retry.Retry` Indique les erreurs (le cas échéant) qui doivent être réessayées.
`timeout`	`float` Délai d'expiration pour cette requête.
`metadata`	`Sequence[Tuple[str, str]]` Chaînes à envoyer avec la requête en tant que métadonnées.

Renvoie
Type	Description
`google.api_core.operation.Operation`	Objet représentant une opération de longue durée. Le type de résultat de l'opération sera AsyncBatchAnnotateFilesResponse, qui correspond à la réponse à une requête d'annotation de fichier par lot asynchrone.

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

Service qui détecte et annote les images d'un lot de fichiers. Actuellement, seuls les fichiers "application/pdf", "image/tiff" et "image/gif" sont acceptés. Ce service extrait au maximum cinq frames GIF (les clients peuvent les spécifier dans les requêtes AnnotateFileRequest.pages) ou pages (PDF ou TIFF) de chaque fichier fourni, et détecte et annote chaque image extraite.

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

Paramètres
Nom	Description
`request`	`Union[google.cloud.vision_v1.types.BatchAnnotateFilesRequest, dict]` Objet de la requête. Liste des requêtes permettant d'annoter des fichiers à l'aide de l'API BatchAnnotateFiles.
`requests`	`MutableSequence[google.cloud.vision_v1.types.AnnotateFileRequest]` Obligatoire. Liste des requêtes d'annotation de fichiers. À l'heure actuelle, nous n'acceptons qu'une seule requête AnnotateFileRequest dans la liste BatchAnnotateFilesRequest. Cela correspond au champ `requests` de l'instance `request`. Si `request` est fourni, ce champ ne doit pas être défini.
`retry`	`google.api_core.retry.Retry` Indique les erreurs (le cas échéant) qui doivent être réessayées.
`timeout`	`float` Délai d'expiration pour cette requête.
`metadata`	`Sequence[Tuple[str, str]]` Chaînes à envoyer avec la requête en tant que métadonnées.

Renvoie
Type	Description
`google.cloud.vision_v1.types.BatchAnnotateFilesResponse`	Liste des résultats de l'annotation de fichiers.

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

Détecte et annote un lot d'images.

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

Paramètres
Nom	Description
`request`	`Union[google.cloud.vision_v1.types.BatchAnnotateImagesRequest, dict]` Objet de la requête. Plusieurs requêtes d'annotation d'images asynchrones sont regroupées dans un seul appel de service.
`requests`	`MutableSequence[google.cloud.vision_v1.types.AnnotateImageRequest]` Obligatoire. Requêtes d'annotation d'images individuelles du lot. Cela correspond au champ `requests` de l'instance `request`. Si `request` est fourni, ce champ ne doit pas être défini.
`retry`	`google.api_core.retry.Retry` Indique les erreurs (le cas échéant) qui doivent être réessayées.
`timeout`	`float` Délai d'expiration pour cette requête.
`metadata`	`Sequence[Tuple[str, str]]` Chaînes à envoyer avec la requête en tant que métadonnées.

Renvoie
Type	Description
`google.cloud.vision_v1.types.BatchAnnotateImagesResponse`	Réponse à une requête d'annotation d'image par lot.

common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Renvoie une chaîne billing_account complète.

common_folder_path

common_folder_path(folder: str) -> str

Renvoie une chaîne de dossier complète.

common_location_path

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

Renvoie une chaîne d'emplacement complète.

common_organization_path

common_organization_path(organization: str) -> str

Renvoie une chaîne d'organisation complète.

common_project_path

common_project_path(project: str) -> str

Renvoie une chaîne de projet complète.

from_service_account_file

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

Crée une instance de ce client à l'aide du fichier d'identifiants fourni.

Paramètre
Nom	Description
`filename`	`str` Chemin d'accès au fichier JSON de clé privée du compte de service.

Renvoie
Type	Description
`ImageAnnotatorClient`	Client construit.

from_service_account_info

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

Crée une instance de ce client à l'aide des informations d'identification fournies.

Paramètre
Nom	Description
`info`	`dict` Informations sur la clé privée du compte de service.

Renvoie
Type	Description
`ImageAnnotatorClient`	Client construit.

from_service_account_json

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

Crée une instance de ce client à l'aide du fichier d'identifiants fourni.

Paramètre
Nom	Description
`filename`	`str` Chemin d'accès au fichier JSON de clé privée du compte de service.

Renvoie
Type	Description
`ImageAnnotatorClient`	Client construit.

get_mtls_endpoint_and_cert_source

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

Renvoie le point de terminaison de l'API et la source du certificat client pour le protocole TLS mutuel.

La source du certificat client est déterminée dans l'ordre suivant : (1) si la variable d'environnement GOOGLE_API_USE_CLIENT_CERTIFICATE n'est pas définie sur "true", la source du certificat client est "None". (2) Si client_options.client_cert_source est fourni, utilisez celui-ci. Si la source du certificat client par défaut existe, utilisez celle-ci. Sinon, la source du certificat client est définie sur "None".

Le point de terminaison de l'API est déterminé dans l'ordre suivant : (1) si client_options.api_endpoint est fourni, utilisez celui-ci. (2) Si la variable d'environnement GOOGLE_API_USE_CLIENT_CERTIFICATE est définie sur "always" (toujours), utilisez le point de terminaison mTLS par défaut. Si elle est définie sur "never" (jamais), utilisez le point de terminaison de l'API par défaut. Sinon, si la source du certificat client existe, utilisez le point de terminaison mTLS par défaut. Dans le cas contraire, utilisez le point de terminaison de l'API par défaut.

Pour en savoir plus, consultez https://google.aip.dev/auth/4114.

Paramètre
Nom	Description
`client_options`	`google.api_core.client_options.ClientOptions` Options personnalisées pour le client. Seules les propriétés `api_endpoint` et `client_cert_source` peuvent être utilisées dans cette méthode.

Exceptions
Type	Description
`google.auth.exceptions.MutualTLSChannelError`	en cas d'erreur.

Renvoie
Type	Description
`Tuple[str, Callable[[], Tuple[bytes, bytes]]]`	renvoie le point de terminaison de l'API et la source du certificat client à utiliser.

parse_common_billing_account_path

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

Analysez un chemin billing_account dans ses segments de composants.

parse_common_folder_path

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

Analysez un chemin d'accès à un dossier dans ses segments de composants.

parse_common_location_path

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

Analysez un chemin d'accès à un emplacement dans ses segments de composants.

parse_common_organization_path

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

Analysez un chemin d'accès à une organisation en segments de composants.

parse_common_project_path

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

Analysez un chemin de projet en segments de composants.

parse_product_path

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

Analyse un chemin de produit dans ses segments de composants.

parse_product_set_path

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

Analyse un chemin d'ensemble de produits en segments de composants.

product_path

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

Renvoie une chaîne de produit complète.

product_set_path

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

Renvoie une chaîne product_set complète.