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

Layanan yang menjalankan tugas deteksi Google Cloud Vision API pada gambar klien, seperti deteksi wajah, tempat terkenal, logo, label, dan teks. Layanan ImageAnnotator menampilkan entity yang terdeteksi dari gambar.

Properti

{i>transport<i}

Menampilkan transport yang digunakan oleh instance klien.

Menampilkan
JenisDeskripsi
ImageAnnotatorTransportTransportasi yang digunakan oleh instance klien.

Metode

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

Membuat instance klien anotasi gambar.

Parameter
NamaDeskripsi
credentials Optional[google.auth.credentials.Credentials]

Kredensial otorisasi yang akan dilampirkan ke permintaan. Kredensial ini mengidentifikasi aplikasi ke layanan; jika tidak ada yang ditentukan, klien akan mencoba memastikan kredensial dari lingkungan.

transport Union[str, ImageAnnotatorTransport]

Transportasi yang akan digunakan. Jika disetel ke None, transportasi akan dipilih secara otomatis.

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

Opsi kustom untuk klien. Tindakan ini tidak akan berlaku jika instance transport diberikan. (1) Properti api_endpoint dapat digunakan untuk mengganti endpoint default yang disediakan oleh klien. Variabel lingkungan GOOGLE_API_USE_MTLS_ENDPOINT juga dapat digunakan untuk mengganti endpoint: "always" (selalu menggunakan endpoint mTLS default), "never" (selalu menggunakan endpoint reguler default), dan "auto" (beralih secara otomatis ke endpoint mTLS default jika ada sertifikat klien, ini adalah nilai default). Namun, properti api_endpoint akan diprioritaskan jika diberikan. (2) Jika variabel lingkungan GOOGLE_API_USE_CLIENT_CERTIFICATE adalah "true", properti client_cert_source dapat digunakan untuk memberikan sertifikat klien untuk transportasi TLS bersama. Jika tidak diberikan, sertifikat klien SSL default akan digunakan jika ada. Jika GOOGLE_API_USE_CLIENT_CERTIFICATE adalah "false" atau tidak disetel, tidak ada sertifikat klien yang akan digunakan.

client_info google.api_core.gapic_v1.client_info.ClientInfo

Info klien yang digunakan untuk mengirim string agen pengguna bersama dengan permintaan API. Jika None, info default akan digunakan. Umumnya, Anda hanya perlu menyetel ini jika Anda mengembangkan library klien Anda sendiri.

Pengecualian
JenisDeskripsi
google.auth.exceptions.MutualTLSChannelErrorJika pembuatan transport TLS bersama gagal karena alasan apa pun.

__exit__

__exit__(type, value, traceback)

Melepaskan resource transportasi yang mendasarinya.

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

Menjalankan anotasi dan deteksi gambar asinkron untuk daftar file umum, seperti file PDF, yang dapat berisi beberapa halaman dan beberapa gambar per halaman. Progres dan hasil dapat diambil melalui antarmuka google.longrunning.Operations. Operation.metadata berisi OperationMetadata (metadata). Operation.response berisi AsyncBatchAnnotateFilesResponse (hasil).

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

Objek permintaan. Beberapa permintaan anotasi file asinkron dikelompokkan menjadi satu panggilan layanan.

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

Wajib. Permintaan anotasi file asinkron individual untuk batch ini. Ini sesuai dengan kolom requests pada instance request; jika request diberikan, ini tidak boleh ditetapkan.

retry google.api_core.retry.Retry

Penetapan error yang harus dicoba lagi, jika ada.

timeout float

Waktu tunggu untuk permintaan ini.

metadata Sequence[Tuple[str, str]]

String yang harus dikirim bersama permintaan sebagai metadata.

Menampilkan
JenisDeskripsi
google.api_core.operation.OperationObjek yang merepresentasikan operasi yang berjalan lama. Jenis hasil untuk operasi ini adalah AsyncBatchAnnotateFilesResponse Respons terhadap permintaan anotasi file batch asinkron.

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

Layanan yang menjalankan deteksi dan anotasi gambar untuk batch file. Sekarang hanya "application/pdf", "image/tiff", dan "image/gif" yang didukung. Layanan ini akan mengekstrak maksimal 5 (pelanggan dapat menentukan 5 dalam AnnotateFileRequest.pages) frame (gif) atau halaman (pdf atau tiff) dari setiap file yang disediakan dan melakukan deteksi serta anotasi untuk setiap gambar yang diekstrak.

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

Objek permintaan. Daftar permintaan untuk memberi anotasi file menggunakan BatchAnnotateFiles API.

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

Wajib. Daftar permintaan anotasi file. Saat ini kami hanya mendukung satu AnnotateFileRequest di BatchAnnotateFilesRequest. Ini sesuai dengan kolom requests pada instance request; jika request diberikan, ini tidak boleh ditetapkan.

retry google.api_core.retry.Retry

Penetapan error yang harus dicoba lagi, jika ada.

timeout float

Waktu tunggu untuk permintaan ini.

metadata Sequence[Tuple[str, str]]

String yang harus dikirim bersama permintaan sebagai metadata.

Menampilkan
JenisDeskripsi
google.cloud.vision_v1.types.BatchAnnotateFilesResponseDaftar respons anotasi 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

Menjalankan deteksi dan anotasi gambar untuk sekumpulan gambar.

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

Objek permintaan. Beberapa permintaan anotasi gambar dikelompokkan menjadi satu panggilan layanan.

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

Wajib. Permintaan anotasi gambar individual untuk batch ini. Ini sesuai dengan kolom requests pada instance request; jika request diberikan, ini tidak boleh ditetapkan.

retry google.api_core.retry.Retry

Penetapan error yang harus dicoba lagi, jika ada.

timeout float

Waktu tunggu untuk permintaan ini.

metadata Sequence[Tuple[str, str]]

String yang harus dikirim bersama permintaan sebagai metadata.

Menampilkan
JenisDeskripsi
google.cloud.vision_v1.types.BatchAnnotateImagesResponseRespons terhadap permintaan anotasi gambar batch.

common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Menampilkan string billing_account yang sepenuhnya memenuhi syarat.

common_folder_path

common_folder_path(folder: str) -> str

Menampilkan string folder yang sepenuhnya memenuhi syarat.

common_location_path

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

Menampilkan string lokasi yang sepenuhnya memenuhi syarat.

common_organization_path

common_organization_path(organization: str) -> str

Menampilkan string organisasi yang sepenuhnya memenuhi syarat.

common_project_path

common_project_path(project: str) -> str

Menampilkan string project yang sepenuhnya memenuhi syarat.

from_service_account_file

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

Membuat instance klien ini menggunakan file kredensial yang disediakan.

Parameter
NamaDeskripsi
filename str

Jalur ke file json kunci pribadi akun layanan.

Menampilkan
JenisDeskripsi
ImageAnnotatorClientKlien yang dibuat.

from_service_account_info

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

Membuat instance klien ini menggunakan info kredensial yang diberikan.

Parameter
NamaDeskripsi
info dict

Info kunci pribadi akun layanan.

Menampilkan
JenisDeskripsi
ImageAnnotatorClientKlien yang dibuat.

from_service_account_json

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

Membuat instance klien ini menggunakan file kredensial yang disediakan.

Parameter
NamaDeskripsi
filename str

Jalur ke file json kunci pribadi akun layanan.

Menampilkan
JenisDeskripsi
ImageAnnotatorClientKlien yang dibuat.

get_mtls_endpoint_and_cert_source

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

Menampilkan endpoint API dan sumber sertifikat klien untuk TLS bersama.

Sumber sertifikat klien ditentukan dalam urutan berikut: (1) Jika variabel lingkungan GOOGLE_API_USE_CLIENT_CERTIFICATE bukan "true", sumber sertifikat klien adalah None. (2) jika client_options.client_cert_source diberikan, gunakan yang diberikan; jika sumber sertifikat klien default ada, gunakan yang default; jika tidak, sumber sertifikat klien adalah None.

Endpoint API ditentukan dalam urutan berikut: (1) jika client_options.api_endpoint diberikan, gunakan yang diberikan. (2) jika variabel lingkungan GOOGLE_API_USE_CLIENT_CERTIFICATE adalah "always", gunakan endpoint mTLS default; jika variabel lingkungan adalah "never", gunakan endpoint API default; jika tidak, jika sumber sertifikat klien ada, gunakan endpoint mTLS default, jika tidak, gunakan endpoint API default.

Detail selengkapnya dapat ditemukan di https://google.aip.dev/auth/4114.

Parameter
NamaDeskripsi
client_options google.api_core.client_options.ClientOptions

Opsi kustom untuk klien. Hanya properti api_endpoint dan client_cert_source yang dapat digunakan dalam metode ini.

Pengecualian
JenisDeskripsi
google.auth.exceptions.MutualTLSChannelErrorJika terjadi error.
Menampilkan
JenisDeskripsi
Tuple[str, Callable[[], Tuple[bytes, bytes]]]menampilkan endpoint API dan sumber sertifikat klien yang akan digunakan.

parse_common_billing_account_path

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

Mengurai jalur billing_account ke dalam segmen komponennya.

parse_common_folder_path

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

Mengurai jalur folder ke dalam segmen komponennya.

parse_common_location_path

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

Mengurai jalur lokasi ke dalam segmen komponennya.

parse_common_organization_path

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

Mengurai jalur organisasi ke dalam segmen komponennya.

parse_common_project_path

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

Mengurai jalur project ke dalam segmen komponennya.

parse_product_path

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

Mengurai jalur produk ke dalam segmen komponennya.

parse_product_set_path

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

Mengurai jalur product_set ke dalam segmen komponennya.

product_path

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

Menampilkan string produk yang sepenuhnya memenuhi syarat.

product_set_path

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

Menampilkan string product_set yang sepenuhnya memenuhi syarat.