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

Servizio che esegue attività di rilevamento dell'API Google Cloud Vision su immagini client, come rilevamento di volti, punti di riferimento, loghi, etichette e testo. Il servizio ImageAnnotator restituisce le entità rilevate dalle immagini.

Proprietà

trasporto

Restituisce il trasporto utilizzato dall'istanza client.

Restituisce
TipoDescrizione
ImageAnnotatorTransportIl trasporto utilizzato dall'istanza client.

Metodi

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 un'istanza del client di annotazione delle immagini.

Parametri
NomeDescrizione
credentials Optional[google.auth.credentials.Credentials]

Le credenziali di autorizzazione da allegare alle richieste. Queste credenziali identificano l'applicazione per il servizio. Se non ne vengono specificate, il client tenterà di determinare le credenziali dall'ambiente.

transport Union[str, ImageAnnotatorTransport]

Il trasporto da utilizzare. Se impostato su Nessuno, viene scelto automaticamente un trasporto.

client_options Optional[Union[google.api_core.client_options.ClientOptions, dict]]

Opzioni personalizzate per il cliente. Non avrà effetto se viene fornita un'istanza transport. (1) La proprietà api_endpoint può essere utilizzata per eseguire l'override dell'endpoint predefinito fornito dal client. La variabile di ambiente GOOGLE_API_USE_MTLS_ENDPOINT può essere utilizzata anche per eseguire l'override dell'endpoint: "always" (utilizza sempre l'endpoint mTLS predefinito), "never" (utilizza sempre l'endpoint regolare predefinito) e "auto" (passa automaticamente all'endpoint mTLS predefinito se è presente il certificato client, questo è il valore predefinito). Tuttavia, la proprietà api_endpoint ha la precedenza se fornita. (2) Se la variabile di ambiente GOOGLE_API_USE_CLIENT_CERTIFICATE è "true", la proprietà client_cert_source può essere utilizzata per fornire il certificato client per il trasporto TLS reciproco. Se non viene fornito, verrà utilizzato il certificato client SSL predefinito, se presente. Se GOOGLE_API_USE_CLIENT_CERTIFICATE è "false" o non è impostato, non verrà utilizzato alcun certificato client.

client_info google.api_core.gapic_v1.client_info.ClientInfo

Le informazioni del client utilizzate per inviare una stringa user agent insieme alle richieste API. Se None, verranno utilizzate le informazioni predefinite. In genere, devi impostare questo valore solo se stai sviluppando una libreria client personalizzata.

Eccezioni
TipoDescrizione
google.auth.exceptions.MutualTLSChannelErrorSe la creazione del trasporto TLS reciproco non è riuscita per qualsiasi motivo.

__exit__

__exit__(type, value, traceback)

Rilascia le risorse del trasporto sottostante.

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

Esegui il rilevamento e l'annotazione asincroni delle immagini per un elenco di file generici, come i file PDF, che possono contenere più pagine e più immagini per pagina. I progressi e i risultati possono essere recuperati tramite l'interfaccia google.longrunning.Operations. Operation.metadata contiene OperationMetadata (metadati). Operation.response contiene AsyncBatchAnnotateFilesResponse (risultati).

# 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)
Parametri
NomeDescrizione
request Union[google.cloud.vision_v1.types.AsyncBatchAnnotateFilesRequest, dict]

L'oggetto richiesta. Più richieste di annotazione asincrona dei file vengono raggruppate in una singola chiamata di servizio.

requests MutableSequence[google.cloud.vision_v1.types.AsyncAnnotateFileRequest]

Obbligatorio. Singole richieste asincrone di annotazione dei file per questo batch. Corrisponde al campo requests nell'istanza request; se viene fornito request, questo campo non deve essere impostato.

retry google.api_core.retry.Retry

Indicazione degli errori, se presenti, per cui deve essere eseguito un nuovo tentativo.

timeout float

Il timeout per questa richiesta.

metadata Sequence[Tuple[str, str]]

Stringhe da inviare insieme alla richiesta come metadati.

Restituisce
TipoDescrizione
google.api_core.operation.OperationUn oggetto che rappresenta un'operazione a lunga esecuzione. Il tipo di risultato per l'operazione sarà AsyncBatchAnnotateFilesResponse Response to an async batch file annotation request.

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

Servizio che esegue il rilevamento e l'annotazione delle immagini per un batch di file. Ora sono supportati solo "application/pdf", "image/tiff" e "image/gif". Questo servizio estrae al massimo 5 (i clienti possono specificare quali 5 in AnnotateFileRequest.pages) frame (GIF) o pagine (PDF o TIFF) da ogni file fornito ed esegue il rilevamento e l'annotazione per ogni immagine estratta.

# 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)
Parametri
NomeDescrizione
request Union[google.cloud.vision_v1.types.BatchAnnotateFilesRequest, dict]

L'oggetto richiesta. Un elenco di richieste per annotare i file utilizzando l'API BatchAnnotateFiles.

requests MutableSequence[google.cloud.vision_v1.types.AnnotateFileRequest]

Obbligatorio. L'elenco delle richieste di annotazione dei file. Al momento supportiamo solo una richiesta AnnotateFileRequest in BatchAnnotateFilesRequest. Corrisponde al campo requests nell'istanza request; se viene fornito request, questo campo non deve essere impostato.

retry google.api_core.retry.Retry

Indicazione degli errori, se presenti, per cui deve essere eseguito un nuovo tentativo.

timeout float

Il timeout per questa richiesta.

metadata Sequence[Tuple[str, str]]

Stringhe da inviare insieme alla richiesta come metadati.

Restituisce
TipoDescrizione
google.cloud.vision_v1.types.BatchAnnotateFilesResponseUn elenco di risposte alle annotazioni dei file.

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

Esegui il rilevamento e l'annotazione delle immagini per un batch di immagini.

# 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)
Parametri
NomeDescrizione
request Union[google.cloud.vision_v1.types.BatchAnnotateImagesRequest, dict]

L'oggetto richiesta. Più richieste di annotazione di immagini vengono raggruppate in una singola chiamata di servizio.

requests MutableSequence[google.cloud.vision_v1.types.AnnotateImageRequest]

Obbligatorio. Singole richieste di annotazione per le immagini di questo batch. Corrisponde al campo requests nell'istanza request; se viene fornito request, questo campo non deve essere impostato.

retry google.api_core.retry.Retry

Indicazione degli errori, se presenti, per cui deve essere eseguito un nuovo tentativo.

timeout float

Il timeout per questa richiesta.

metadata Sequence[Tuple[str, str]]

Stringhe da inviare insieme alla richiesta come metadati.

Restituisce
TipoDescrizione
google.cloud.vision_v1.types.BatchAnnotateImagesResponseRisposta a una richiesta di annotazione di immagini batch.

common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Restituisce una stringa billing_account completa.

common_folder_path

common_folder_path(folder: str) -> str

Restituisce una stringa di cartella completa.

common_location_path

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

Restituisce una stringa di posizione completa.

common_organization_path

common_organization_path(organization: str) -> str

Restituisce una stringa dell'organizzazione completa.

common_project_path

common_project_path(project: str) -> str

Restituisce una stringa di progetto completa.

from_service_account_file

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

Crea un'istanza di questo client utilizzando il file delle credenziali fornito.

Parametro
NomeDescrizione
filename str

Il percorso del file JSON della chiave privata del account di servizio.

Restituisce
TipoDescrizione
ImageAnnotatorClientIl client creato.

from_service_account_info

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

Crea un'istanza di questo client utilizzando le informazioni sulle credenziali fornite.

Parametro
NomeDescrizione
info dict

Le informazioni sulla chiave privata del account di servizio.

Restituisce
TipoDescrizione
ImageAnnotatorClientIl client creato.

from_service_account_json

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

Crea un'istanza di questo client utilizzando il file delle credenziali fornito.

Parametro
NomeDescrizione
filename str

Il percorso del file JSON della chiave privata del account di servizio.

Restituisce
TipoDescrizione
ImageAnnotatorClientIl client creato.

get_mtls_endpoint_and_cert_source

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

Restituisci l'endpoint API e l'origine del certificato client per mutual TLS.

L'origine del certificato client viene determinata nel seguente ordine: (1) se la variabile di ambiente GOOGLE_API_USE_CLIENT_CERTIFICATE non è "true", l'origine del certificato client è Nessuna. (2) se viene fornito client_options.client_cert_source, utilizza quello fornito; se esiste l'origine del certificato client predefinito, utilizza quello predefinito; altrimenti l'origine del certificato client è None.

L'endpoint API viene determinato nel seguente ordine: (1) se client_options.api_endpoint viene fornito, utilizza quello fornito. (2) se la variabile di ambiente GOOGLE_API_USE_CLIENT_CERTIFICATE è "always", utilizza l'endpoint mTLS predefinito; se la variabile di ambiente è "never", utilizza l'endpoint API predefinito; altrimenti, se esiste l'origine del certificato client, utilizza l'endpoint mTLS predefinito, altrimenti utilizza l'endpoint API predefinito.

Per ulteriori dettagli, visita la pagina https://google.aip.dev/auth/4114.

Parametro
NomeDescrizione
client_options google.api_core.client_options.ClientOptions

Opzioni personalizzate per il cliente. In questo metodo possono essere utilizzate solo le proprietà api_endpoint e client_cert_source.

Eccezioni
TipoDescrizione
google.auth.exceptions.MutualTLSChannelErrorSe si verificano errori.
Restituisce
TipoDescrizione
Tuple[str, Callable[[], Tuple[bytes, bytes]]]restituisce l'endpoint API e l'origine del certificato client da utilizzare.

parse_common_billing_account_path

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

Analizza un percorso billing_account nei relativi segmenti componenti.

parse_common_folder_path

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

Analizza un percorso di cartella nei relativi segmenti componenti.

parse_common_location_path

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

Analizza un percorso della posizione nei suoi segmenti componenti.

parse_common_organization_path

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

Analizza un percorso dell'organizzazione nei suoi segmenti componenti.

parse_common_project_path

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

Analizza un percorso di progetto nei suoi segmenti componenti.

parse_product_path

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

Analizza un percorso del prodotto nei relativi segmenti componenti.

parse_product_set_path

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

Analizza un percorso product_set nei relativi segmenti componenti.

product_path

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

Restituisce una stringa del prodotto completa.

product_set_path

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

Restituisce una stringa product_set completa.