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

Dienst, der Google Cloud Vision API-Erkennungsaufgaben für Kundenbilder durchführt, z. B. Gesichts-, Landmark-, Logo-, Label- und Texterkennung. Der ImageAnnotator-Dienst liefert erkannte Entitäten aus den Bildern.

Eigenschaften

transport

Gibt den von der Client-Instanz verwendeten Transport zurück.

Rückgabe
Typ	Beschreibung
`ImageAnnotatorTransport`	Der von der Clientinstanz verwendete Transport.

Methoden

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

Instanziiert den Image Annotator-Client.

Parameter
Name	Beschreibung
`credentials`	`Optional[google.auth.credentials.Credentials]` Die Autorisierungsanmeldedaten, die an Anfragen angehängt werden sollen. Mit diesen Anmeldedaten wird die Anwendung für den Dienst identifiziert. Wenn keine angegeben sind, versucht der Client, die Anmeldedaten aus der Umgebung zu ermitteln.
`transport`	`Union[str, ImageAnnotatorTransport]` Der zu verwendende Transport. Wenn „None“ festgelegt ist, wird automatisch ein Transport ausgewählt.
`client_options`	`Optional[Union[google.api_core.client_options.ClientOptions, dict]]` Benutzerdefinierte Optionen für den Client. Sie wird nicht angewendet, wenn eine `transport`-Instanz angegeben ist. 1. Mit der Property `api_endpoint` kann der vom Client bereitgestellte Standardendpunkt überschrieben werden. Mit der Umgebungsvariable GOOGLE_API_USE_MTLS_ENDPOINT kann der Endpunkt auch überschrieben werden: „always“ (immer den standardmäßigen mTLS-Endpunkt verwenden), „never“ (immer den standardmäßigen regulären Endpunkt verwenden) und „auto“ (automatisch zum standardmäßigen mTLS-Endpunkt wechseln, wenn ein Clientzertifikat vorhanden ist; dies ist der Standardwert). Die Property `api_endpoint` hat jedoch Vorrang, sofern sie angegeben wird. (2) Wenn die Umgebungsvariable GOOGLE_API_USE_CLIENT_CERTIFICATE auf „true“ gesetzt ist, kann die Eigenschaft `client_cert_source` verwendet werden, um ein Clientzertifikat für den gegenseitigen TLS-Transport bereitzustellen. Wenn nicht angegeben, wird das standardmäßige SSL-Clientzertifikat verwendet, sofern vorhanden. Wenn GOOGLE_API_USE_CLIENT_CERTIFICATE auf „false“ gesetzt oder nicht festgelegt ist, wird kein Clientzertifikat verwendet.
`client_info`	`google.api_core.gapic_v1.client_info.ClientInfo` Die Clientinformationen, die zum Senden eines User-Agent-Strings zusammen mit API-Anfragen verwendet werden. Wenn `None`, werden Standardinformationen verwendet. Normalerweise müssen Sie diese Einstellung nur festlegen, wenn Sie eine eigene Clientbibliothek entwickeln.

Ausnahmen
Typ	Beschreibung
`google.auth.exceptions.MutualTLSChannelError`	Wenn die Erstellung des gegenseitigen TLS-Transports aus irgendeinem Grund fehlgeschlagen ist.

exit

__exit__(type, value, traceback)

Gibt die Ressourcen des zugrunde liegenden Transports frei.

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

Führen Sie die asynchrone Bilderkennung und -annotation für eine Liste allgemeiner Dateien aus, z. B. PDF-Dateien, die mehrere Seiten und mehrere Bilder pro Seite enthalten können. Fortschritt und Ergebnisse können über die google.longrunning.Operations-Schnittstelle abgerufen werden. Operation.metadata enthält OperationMetadata (Metadaten). Operation.response enthält AsyncBatchAnnotateFilesResponse (Ergebnisse).

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

Parameter
Name	Beschreibung
`request`	`Union[google.cloud.vision_v1.types.AsyncBatchAnnotateFilesRequest, dict]` Das Anfrageobjekt. Mehrere Anfragen für asynchrone Dateiannotationen werden in einem einzigen Dienstaufruf zusammengefasst.
`requests`	`MutableSequence[google.cloud.vision_v1.types.AsyncAnnotateFileRequest]` Erforderlich. Individuelle asynchrone Dateiannotationsanfragen für diesen Batch. Dies entspricht dem Feld `requests` in der `request`-Instanz. Wenn `request` angegeben ist, sollte dies nicht festgelegt werden.
`retry`	`google.api_core.retry.Retry` Angabe, welche Fehler (falls vorhanden) wiederholt werden sollen.
`timeout`	`float` Das Zeitlimit für diese Anfrage.
`metadata`	`Sequence[Tuple[str, str]]` Strings, die zusammen mit der Anfrage als Metadaten gesendet werden sollen.

Rückgabe
Typ	Beschreibung
`google.api_core.operation.Operation`	Ein Objekt, das einen Vorgang mit langer Ausführungszeit darstellt. Der Ergebnistyp für den Vorgang ist AsyncBatchAnnotateFilesResponse. Antwort auf eine asynchrone Batchanfrage zur Annotation von Batchdateien.

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

Dienst, der für einen Batch von Dateien Bilderkennung und -annotation ausführt. Jetzt werden nur „application/pdf“, „image/tiff“ und „image/gif“ unterstützt. Dieser Dienst extrahiert maximal fünf (Kunden können angeben, welche fünf in AnnotateFileRequest.pages) Frames (gif) oder Seiten (PDF oder TIFF) aus jeder bereitgestellten Datei. Für jedes extrahierte Bild werden Erkennung und Annotation durchgeführt.

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

Parameter
Name	Beschreibung
`request`	`Union[google.cloud.vision_v1.types.BatchAnnotateFilesRequest, dict]` Das Anfrageobjekt. Eine Liste mit Anfragen zum Annotieren von Dateien mithilfe der BatchAnnotateFiles API.
`requests`	`MutableSequence[google.cloud.vision_v1.types.AnnotateFileRequest]` Erforderlich. Die Liste der Anfrageanmerkungsanfragen Derzeit unterstützen wir in BatchAnnotateFilesRequest nur eine AnnotateFileRequest. Dies entspricht dem Feld `requests` in der `request`-Instanz. Wenn `request` angegeben ist, sollte dies nicht festgelegt werden.
`retry`	`google.api_core.retry.Retry` Angabe, welche Fehler (falls vorhanden) wiederholt werden sollen.
`timeout`	`float` Das Zeitlimit für diese Anfrage.
`metadata`	`Sequence[Tuple[str, str]]` Strings, die zusammen mit der Anfrage als Metadaten gesendet werden sollen.

Rückgabe
Typ	Beschreibung
`google.cloud.vision_v1.types.BatchAnnotateFilesResponse`	Eine Liste von Antworten zu Dateiannotationen.

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

Führen Sie Bilderkennung und ‑anmerkung für einen Batch von Bildern aus.

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

Parameter
Name	Beschreibung
`request`	`Union[google.cloud.vision_v1.types.BatchAnnotateImagesRequest, dict]` Das Anfrageobjekt. Mehrere Bildanmerkungsanfragen werden in einem einzelnen Dienstaufruf zusammengefasst.
`requests`	`MutableSequence[google.cloud.vision_v1.types.AnnotateImageRequest]` Erforderlich. Individuelle Bildanmerkungsanfragen für diesen Satz Dies entspricht dem Feld `requests` in der `request`-Instanz. Wenn `request` angegeben ist, sollte dies nicht festgelegt werden.
`retry`	`google.api_core.retry.Retry` Angabe, welche Fehler (falls vorhanden) wiederholt werden sollen.
`timeout`	`float` Das Zeitlimit für diese Anfrage.
`metadata`	`Sequence[Tuple[str, str]]` Strings, die zusammen mit der Anfrage als Metadaten gesendet werden sollen.

Rückgabe
Typ	Beschreibung
`google.cloud.vision_v1.types.BatchAnnotateImagesResponse`	Antwort auf eine Anmerkungsanfrage für Sätze von Bildern

common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Gibt einen vollständig qualifizierten billing_account-String zurück.

common_folder_path

common_folder_path(folder: str) -> str

Gibt einen vollständig qualifizierten Ordnerstring zurück.

common_location_path

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

Gibt einen voll qualifizierten Standortstring zurück.

common_organization_path

common_organization_path(organization: str) -> str

Gibt einen voll qualifizierten Organisationsstring zurück.

common_project_path

common_project_path(project: str) -> str

Gibt einen vollständig qualifizierten Projektstring zurück.

from_service_account_file

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

Erstellt eine Instanz dieses Clients mit der angegebenen Datei mit Anmeldedaten.

Parameter
Name	Beschreibung
`filename`	`str` Der Pfad zur JSON-Datei mit dem privaten Schlüssel des Dienstkontos.

Rückgabe
Typ	Beschreibung
`ImageAnnotatorClient`	Der erstellte Client.

from_service_account_info

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

Erstellt eine Instanz dieses Clients mit den angegebenen Anmeldedaten.

Parameter
Name	Beschreibung
`info`	`dict` Informationen zum privaten Schlüssel des Dienstkontos.

Rückgabe
Typ	Beschreibung
`ImageAnnotatorClient`	Der erstellte Client.

from_service_account_json

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

Erstellt eine Instanz dieses Clients mit der angegebenen Datei mit Anmeldedaten.

Parameter
Name	Beschreibung
`filename`	`str` Der Pfad zur JSON-Datei mit dem privaten Schlüssel des Dienstkontos.

Rückgabe
Typ	Beschreibung
`ImageAnnotatorClient`	Der erstellte Client.

get_mtls_endpoint_and_cert_source

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

Gibt den API-Endpunkt und die Clientzertifikatsquelle für die gegenseitige TLS zurück.

Die Quelle des Clientzertifikats wird in der folgenden Reihenfolge bestimmt: (1) Wenn die Umgebungsvariable GOOGLE_API_USE_CLIENT_CERTIFICATE nicht „true“ ist, ist die Quelle des Clientzertifikats „None“. (2) Wenn client_options.client_cert_source angegeben ist, wird diese verwendet. Wenn die Standardquelle für das Clientzertifikat vorhanden ist, wird diese verwendet. Andernfalls ist die Quelle für das Clientzertifikat „None“.

Der API-Endpunkt wird in der folgenden Reihenfolge bestimmt: (1) Wenn client_options.api_endpoint angegeben ist, wird dieser verwendet. (2) Wenn die Umgebungsvariable GOOGLE_API_USE_CLIENT_CERTIFICATE „always“ ist, verwenden Sie den Standard-mTLS-Endpunkt. Wenn die Umgebungsvariable „never“ ist, verwenden Sie den Standard-API-Endpunkt. Andernfalls verwenden Sie den Standard-mTLS-Endpunkt, sofern eine Clientzertifikatsquelle vorhanden ist. Andernfalls verwenden Sie den Standard-API-Endpunkt.

Weitere Informationen finden Sie unter https://google.aip.dev/auth/4114.

Parameter
Name	Beschreibung
`client_options`	`google.api_core.client_options.ClientOptions` Benutzerdefinierte Optionen für den Client. In dieser Methode dürfen nur die Attribute `api_endpoint` und `client_cert_source` verwendet werden.

Ausnahmen
Typ	Beschreibung
`google.auth.exceptions.MutualTLSChannelError`	Wenn Fehler auftreten.

Rückgabe
Typ	Beschreibung
`Tuple[str, Callable[[], Tuple[bytes, bytes]]]`	Gibt den zu verwendenden API-Endpunkt und die Clientzertifikatsquelle zurück.

parse_common_billing_account_path

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

Analysiert einen „billing_account“-Pfad in seine Komponentensegmente.

parse_common_folder_path

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

Analysiert einen Ordnerpfad in seine Komponenten.

parse_common_location_path

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

Analysiert einen Speicherortpfad in seine Komponenten.

parse_common_organization_path

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

Analysiert einen Organisationspfad in seine Komponentensegmente.

parse_common_project_path

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

Analysiert einen Projektpfad in seine Komponentensegmente.

parse_product_path

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

Parst einen Produktpfad in seine Komponentensegmente.

parse_product_set_path

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

Parst einen „product_set“-Pfad in seine Komponenten.

product_path

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

Gibt einen vollständig qualifizierten Produktstring zurück.

product_set_path

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

Gibt einen vollständig qualifizierten product_set-String zurück.