airflow.providers.google.cloud.operators.vision¶
此模块包含一个 Google Cloud Vision 操作符。
属性¶
类¶
创建一个新的 ProductSet 资源。 |
|
获取与 ProductSet 相关的信息。 |
|
更改 ProductSet 资源。 |
|
永久删除一个 |
|
创建并返回一个新的 Product 资源。 |
|
获取与 |
|
更改 Product 资源。 |
|
永久删除一个产品及其参考图像。 |
|
对一张或一批图像运行图像检测和标注。 |
|
创建并返回一个新的 ReferenceImage ID 资源。 |
|
删除一个 ReferenceImage ID 资源。 |
|
将一个 Product 添加到指定的 ProductSet。 |
|
从指定的 ProductSet 中移除一个 Product。 |
|
检测图像中的文本。 |
|
检测图像中的文档文本。 |
|
检测图像中的文档文本。 |
|
检测图像中的文档文本。 |
函数¶
|
为 |
模块内容¶
- class airflow.providers.google.cloud.operators.vision.CloudVisionCreateProductSetOperator(*, product_set, location, project_id=PROVIDE_PROJECT_ID, product_set_id=None, retry=DEFAULT, timeout=None, metadata=(), gcp_conn_id='google_cloud_default', impersonation_chain=None, **kwargs)[源码]¶
基类:
airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator
创建一个新的 ProductSet 资源。
另请参见
有关如何使用此操作符的更多信息,请参阅指南:CloudVisionProductSetCreateOperator
- 参数:
product_set (dict | google.cloud.vision_v1.ProductSet) – (必需) 要创建的 ProductSet。如果提供的是字典,则其格式必须与 protobuf 消息 ProductSet 相同。
location (str) – (必需) 应创建 ProductSet 的区域。有效区域(截至 2019-02-05)包括:us-east1, us-west1, europe-west1, asia-east1
project_id (str) – (可选) 应创建 ProductSet 的项目。如果设置为 None 或缺失,则使用 Google Cloud 连接中的默认 project_id。
product_set_id (str | None) – (可选) 用户为此 ProductSet 提供的资源 ID。如果设置,服务器将尝试使用此值作为资源 ID。如果已被占用,则返回带有代码 ALREADY_EXISTS 的错误。长度最多为 128 个字符。不能包含字符 /。
retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – (可选) 用于重试请求的重试对象。如果指定为 None,则不重试请求。
timeout (float | None) – (可选) 等待请求完成的时间(秒)。请注意,如果指定了 retry,则超时适用于每次单独的尝试。
metadata (MetaData) – (可选) 提供给方法的附加元数据。
gcp_conn_id (str) – (可选) 用于连接 Google Cloud 的连接 ID。
impersonation_chain (str | collections.abc.Sequence[str] | None) – 可选的服务账号,用于使用短期凭据进行模拟,或所需的账号链,以获取列表中最后一个账号的 access_token,该 token 将用于请求模拟。如果设置为字符串,则该账号必须授予源账号 Service Account Token Creator IAM 角色。如果设置为序列,则列表中的身份必须授予直接前置身份 Service Account Token Creator IAM 角色,列表中的第一个账号将此角色授予源账号(模板化)。
- template_fields: collections.abc.Sequence[str] = ('location', 'project_id', 'product_set_id', 'gcp_conn_id', 'impersonation_chain')[源码]¶
- class airflow.providers.google.cloud.operators.vision.CloudVisionGetProductSetOperator(*, location, product_set_id, project_id=PROVIDE_PROJECT_ID, retry=DEFAULT, timeout=None, metadata=(), gcp_conn_id='google_cloud_default', impersonation_chain=None, **kwargs)[源码]¶
基类:
airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator
获取与 ProductSet 相关的信息。
另请参见
有关如何使用此操作符的更多信息,请参阅指南:CloudVisionGetProductSetOperator
- 参数:
location (str) – (必需) ProductSet 所在的区域。有效区域(截至 2019-02-05)包括:us-east1, us-west1, europe-west1, asia-east1
product_set_id (str) – (必需) 此 ProductSet 的资源 ID。
project_id (str) – (可选) ProductSet 所在的项目。如果设置为 None 或缺失,则使用 Google Cloud 连接中的默认 project_id。
retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – (可选) 用于重试请求的重试对象。如果指定为 None,则不重试请求。
timeout (float | None) – (可选) 等待请求完成的时间(秒)。请注意,如果指定了 retry,则超时适用于每次单独的尝试。
metadata (MetaData) – (可选) 提供给方法的附加元数据。
gcp_conn_id (str) – (可选) 用于连接 Google Cloud 的连接 ID。
impersonation_chain (str | collections.abc.Sequence[str] | None) – 可选的服务账号,用于使用短期凭据进行模拟,或所需的账号链,以获取列表中最后一个账号的 access_token,该 token 将用于请求模拟。如果设置为字符串,则该账号必须授予源账号 Service Account Token Creator IAM 角色。如果设置为序列,则列表中的身份必须授予直接前置身份 Service Account Token Creator IAM 角色,列表中的第一个账号将此角色授予源账号(模板化)。
- template_fields: collections.abc.Sequence[str] = ('location', 'project_id', 'product_set_id', 'gcp_conn_id', 'impersonation_chain')[源码]¶
- class airflow.providers.google.cloud.operators.vision.CloudVisionUpdateProductSetOperator(*, product_set, location=None, product_set_id=None, project_id=PROVIDE_PROJECT_ID, update_mask=None, retry=DEFAULT, timeout=None, metadata=(), gcp_conn_id='google_cloud_default', impersonation_chain=None, **kwargs)[源码]¶
基类:
airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator
更改 ProductSet 资源。
目前只能更新
display_name
。注意
要找到
ProductSet
资源,其name
必须采用 projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID 的形式。您可以将
name` 直接作为 ``product_set
对象的属性提供。您也可以将其留空,在这种情况下,name
将由操作符根据location
和product_set_id
创建(可选project_id
;如果不存在,将使用连接默认值)。此机制是为了方便您,允许将
project_id
留空并让 Airflow 使用连接默认值。另请参见
有关如何使用此操作符的更多信息,请参阅指南:CloudVisionUpdateProductSetOperator
- 参数:
product_set (dict | google.cloud.vision_v1.ProductSet) – (必需) 替换服务器上资源的 ProductSet 资源。如果提供的是字典,则其格式必须与 protobuf 消息 ProductSet 相同。
location (str | None) – (可选) ProductSet 所在的区域。有效区域(截至 2019-02-05)包括:us-east1, us-west1, europe-west1, asia-east1
product_set_id (str | None) – (可选) 此 ProductSet 的资源 ID。
project_id (str) – (可选) 应创建 ProductSet 的项目。如果设置为 None 或缺失,则使用 Google Cloud 连接中的默认 project_id。
update_mask (dict | google.protobuf.field_mask_pb2.FieldMask | None) – (可选) 指定要更新哪些字段的 FieldMask。如果未指定 update_mask,则更新所有可变字段。有效的掩码路径是 display_name。如果提供的是字典,则其格式必须与 protobuf 消息 FieldMask 相同。
retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – (可选) 用于重试请求的重试对象。如果指定为 None,则不重试请求。
timeout (float | None) – (可选) 等待请求完成的时间(秒)。请注意,如果指定了 retry,则超时适用于每次单独的尝试。
metadata (MetaData) – (可选) 提供给方法的附加元数据。
gcp_conn_id (str) – (可选) 用于连接 Google Cloud 的连接 ID。
impersonation_chain (str | collections.abc.Sequence[str] | None) – 可选的服务账号,用于使用短期凭据进行模拟,或所需的账号链,以获取列表中最后一个账号的 access_token,该 token 将用于请求模拟。如果设置为字符串,则该账号必须授予源账号 Service Account Token Creator IAM 角色。如果设置为序列,则列表中的身份必须授予直接前置身份 Service Account Token Creator IAM 角色,列表中的第一个账号将此角色授予源账号(模板化)。
- template_fields: collections.abc.Sequence[str] = ('location', 'project_id', 'product_set_id', 'gcp_conn_id', 'impersonation_chain')[源码]¶
- 类 airflow.providers.google.cloud.operators.vision.CloudVisionDeleteProductSetOperator(*, location, product_set_id, project_id=PROVIDE_PROJECT_ID, retry=DEFAULT, timeout=None, metadata=(), gcp_conn_id='google_cloud_default', impersonation_chain=None, **kwargs)[source]¶
基类:
airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator
永久删除一个
ProductSet
。产品
和参考图像
在产品集
中不会被删除。实际的图像文件不会从 Google Cloud Storage 中删除。另请参见
有关如何使用此 Operator 的更多信息,请参阅指南: CloudVisionDeleteProductSetOperator
- 参数:
location (str) – (必需) ProductSet 所在的区域。有效区域(截至 2019-02-05)包括:us-east1, us-west1, europe-west1, asia-east1
product_set_id (str) – (必需) 此 ProductSet 的资源 ID。
project_id (str) – (可选) 应创建 ProductSet 的项目。如果设置为 None 或缺失,则使用 Google Cloud 连接中的默认 project_id。
retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – (可选) 用于重试请求的重试对象。如果指定为 None,则不重试请求。
timeout (float | None) – (可选) 等待请求完成的时间(秒)。请注意,如果指定了 retry,则超时适用于每次单独的尝试。
metadata (MetaData) – (可选) 提供给方法的附加元数据。
gcp_conn_id (str) – (可选) 用于连接 Google Cloud 的连接 ID。
impersonation_chain (str | collections.abc.Sequence[str] | None) – 可选的服务账号,用于使用短期凭据进行模拟,或所需的账号链,以获取列表中最后一个账号的 access_token,该 token 将用于请求模拟。如果设置为字符串,则该账号必须授予源账号 Service Account Token Creator IAM 角色。如果设置为序列,则列表中的身份必须授予直接前置身份 Service Account Token Creator IAM 角色,列表中的第一个账号将此角色授予源账号(模板化)。
- template_fields: collections.abc.Sequence[str] = ('location', 'project_id', 'product_set_id', 'gcp_conn_id', 'impersonation_chain')[source]¶
- 类 airflow.providers.google.cloud.operators.vision.CloudVisionCreateProductOperator(*, location, product, project_id=PROVIDE_PROJECT_ID, product_id=None, retry=DEFAULT, timeout=None, metadata=(), gcp_conn_id='google_cloud_default', impersonation_chain=None, **kwargs)[source]¶
基类:
airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator
创建并返回一个新的 Product 资源。
关于提供的
产品
对象的可能错误如果
display_name
缺失或长度超过 4096 个字符,则返回INVALID_ARGUMENT
。如果
description
长度超过 4096 个字符,则返回INVALID_ARGUMENT
。如果
product_category
缺失或无效,则返回INVALID_ARGUMENT
。
另请参见
有关如何使用此 Operator 的更多信息,请参阅指南: CloudVisionCreateProductOperator
- 参数:
location (str) – (必需) 应创建产品的区域。有效区域(截至 2019-02-05)包括:us-east1, us-west1, europe-west1, asia-east1
product (str) – (必需) 要创建的产品。如果提供的是字典,其形式必须与 protobuf 消息 产品 的形式相同。
project_id (str) – (可选) 应创建产品的项目。如果设置为 None 或缺失,则使用 Google Cloud 连接中的默认 project_id。
product_id (str | None) – (可选) 用户为此产品提供的资源 ID。如果设置,服务器将尝试使用此值作为资源 ID。如果该 ID 已被使用,将返回代码为 ALREADY_EXISTS 的错误。长度必须最多为 128 个字符,且不能包含字符 /。
retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – (可选) 用于重试请求的重试对象。如果指定为 None,则不重试请求。
timeout (float | None) – (可选) 等待请求完成的时间(秒)。请注意,如果指定了 retry,则超时适用于每次单独的尝试。
metadata (MetaData) – (可选) 提供给方法的附加元数据。
gcp_conn_id (str) – (可选) 用于连接 Google Cloud 的连接 ID。
impersonation_chain (str | collections.abc.Sequence[str] | None) – 可选的服务账号,用于使用短期凭据进行模拟,或所需的账号链,以获取列表中最后一个账号的 access_token,该 token 将用于请求模拟。如果设置为字符串,则该账号必须授予源账号 Service Account Token Creator IAM 角色。如果设置为序列,则列表中的身份必须授予直接前置身份 Service Account Token Creator IAM 角色,列表中的第一个账号将此角色授予源账号(模板化)。
- template_fields: collections.abc.Sequence[str] = ('location', 'project_id', 'product_id', 'gcp_conn_id', 'impersonation_chain')[source]¶
- 类 airflow.providers.google.cloud.operators.vision.CloudVisionGetProductOperator(*, location, product_id, project_id=PROVIDE_PROJECT_ID, retry=DEFAULT, timeout=None, metadata=(), gcp_conn_id='google_cloud_default', impersonation_chain=None, **kwargs)[source]¶
基类:
airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator
获取与
Product
相关的信息。可能的错误
如果 产品 不存在,则返回 NOT_FOUND。
另请参见
有关如何使用此 Operator 的更多信息,请参阅指南: CloudVisionGetProductOperator
- 参数:
location (str) – (必需) 产品所在的区域。有效区域(截至 2019-02-05)包括:us-east1, us-west1, europe-west1, asia-east1
product_id (str) – (必需) 此产品的资源 ID。
project_id (str) – (可选) 产品所在的项目。如果设置为 None 或缺失,则使用 Google Cloud 连接中的默认 project_id。
retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – (可选) 用于重试请求的重试对象。如果指定为 None,则不重试请求。
timeout (float | None) – (可选) 等待请求完成的时间(秒)。请注意,如果指定了 retry,则超时适用于每次单独的尝试。
metadata (MetaData) – (可选) 提供给方法的附加元数据。
gcp_conn_id (str) – (可选) 用于连接 Google Cloud 的连接 ID。
impersonation_chain (str | collections.abc.Sequence[str] | None) – 可选的服务账号,用于使用短期凭据进行模拟,或所需的账号链,以获取列表中最后一个账号的 access_token,该 token 将用于请求模拟。如果设置为字符串,则该账号必须授予源账号 Service Account Token Creator IAM 角色。如果设置为序列,则列表中的身份必须授予直接前置身份 Service Account Token Creator IAM 角色,列表中的第一个账号将此角色授予源账号(模板化)。
- template_fields: collections.abc.Sequence[str] = ('location', 'project_id', 'product_id', 'gcp_conn_id', 'impersonation_chain')[source]¶
- 类 airflow.providers.google.cloud.operators.vision.CloudVisionUpdateProductOperator(*, product, location=None, product_id=None, project_id=PROVIDE_PROJECT_ID, update_mask=None, retry=DEFAULT, timeout=None, metadata=(), gcp_conn_id='google_cloud_default', impersonation_chain=None, **kwargs)[source]¶
基类:
airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator
更改 Product 资源。
目前只能更新 display_name、description 和 labels 字段。
如果更新 labels,更改直到下一次索引时才会反映在查询中。
注意
要找到 产品 资源,需要其 name,格式为 projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID。
你可以直接将 name 作为 product 对象的属性提供。但是,你也可以将其留空,改为提供 location 和 product_id(以及可选的 project_id - 如果未提供,则使用连接默认值),name 将由 Operator 本身创建。
这种机制是为了方便你,允许你将 project_id 留空,并让 Airflow 使用连接的默认 project_id。
与提供的 产品 相关的可能错误
如果产品不存在,则返回 NOT_FOUND。
- 如果 display_name 存在于 update_mask 中但请求中缺失
或长度超过 4096 个字符,则返回 INVALID_ARGUMENT。
- 如果 description 存在于 update_mask 中但长度超过 4096 个
字符,则返回 INVALID_ARGUMENT。
如果 product_category 存在于 update_mask 中,则返回 INVALID_ARGUMENT。
另请参见
有关如何使用此 Operator 的更多信息,请参阅指南: CloudVisionUpdateProductOperator
- 参数:
product (dict | google.cloud.vision_v1.Product) – (必需) 将替换服务器上产品资源的 Product 资源。product.name 是不可变的。如果提供字典,其形式必须与 protobuf 消息 产品 的形式相同。
location (str | None) – (可选) 产品所在的区域。有效区域(截至 2019-02-05)包括:us-east1, us-west1, europe-west1, asia-east1
product_id (str | None) – (可选) 此产品的资源 ID。
project_id (str) – (可选) 产品所在的项目。如果设置为 None 或缺失,则使用 Google Cloud 连接中的默认 project_id。
update_mask (dict | google.protobuf.field_mask_pb2.FieldMask | None) – (可选) 指定要更新哪些字段的 FieldMask。如果未指定 update_mask,则更新所有可变字段。有效的掩码路径包括 product_labels、display_name 和 description。如果提供字典,其形式必须与 protobuf 消息 FieldMask 的形式相同。
retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – (可选) 用于重试请求的重试对象。如果指定为 None,则不重试请求。
timeout (float | None) – (可选) 等待请求完成的时间(秒)。请注意,如果指定了 retry,则超时适用于每次单独的尝试。
metadata (MetaData) – (可选) 提供给方法的附加元数据。
gcp_conn_id (str) – (可选) 用于连接 Google Cloud 的连接 ID。
impersonation_chain (str | collections.abc.Sequence[str] | None) – 可选的服务账号,用于使用短期凭据进行模拟,或所需的账号链,以获取列表中最后一个账号的 access_token,该 token 将用于请求模拟。如果设置为字符串,则该账号必须授予源账号 Service Account Token Creator IAM 角色。如果设置为序列,则列表中的身份必须授予直接前置身份 Service Account Token Creator IAM 角色,列表中的第一个账号将此角色授予源账号(模板化)。
- template_fields: collections.abc.Sequence[str] = ('location', 'project_id', 'product_id', 'gcp_conn_id', 'impersonation_chain')[source]¶
- 类 airflow.providers.google.cloud.operators.vision.CloudVisionDeleteProductOperator(*, location, product_id, project_id=PROVIDE_PROJECT_ID, retry=DEFAULT, timeout=None, metadata=(), gcp_conn_id='google_cloud_default', impersonation_chain=None, **kwargs)[source]¶
基类:
airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator
永久删除一个产品及其参考图像。
产品及其所有图像的元数据将立即删除,但针对包含该产品的产品集的搜索查询可能仍然有效,直到所有相关缓存刷新为止。
可能的错误
如果产品不存在,则返回 NOT_FOUND。
另请参见
有关如何使用此 Operator 的更多信息,请参阅指南: CloudVisionDeleteProductOperator
- 参数:
location (str) – (必需) 产品所在的区域。有效区域(截至 2019-02-05)包括:us-east1, us-west1, europe-west1, asia-east1
product_id (str) – (必需) 此产品的资源 ID。
project_id (str) – (可选) 产品所在的项目。如果设置为 None 或缺失,则使用 Google Cloud 连接中的默认 project_id。
retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – (可选) 用于重试请求的重试对象。如果指定为 None,则不重试请求。
timeout (float | None) – (可选) 等待请求完成的时间(秒)。请注意,如果指定了 retry,则超时适用于每次单独的尝试。
metadata (MetaData) – (可选) 提供给方法的附加元数据。
gcp_conn_id (str) – (可选) 用于连接 Google Cloud 的连接 ID。
impersonation_chain (str | collections.abc.Sequence[str] | None) – 可选的服务账号,用于使用短期凭据进行模拟,或所需的账号链,以获取列表中最后一个账号的 access_token,该 token 将用于请求模拟。如果设置为字符串,则该账号必须授予源账号 Service Account Token Creator IAM 角色。如果设置为序列,则列表中的身份必须授予直接前置身份 Service Account Token Creator IAM 角色,列表中的第一个账号将此角色授予源账号(模板化)。
- template_fields: collections.abc.Sequence[str] = ('location', 'project_id', 'product_id', 'gcp_conn_id', 'impersonation_chain')[source]¶
- class airflow.providers.google.cloud.operators.vision.CloudVisionImageAnnotateOperator(*, request, retry=DEFAULT, timeout=None, gcp_conn_id='google_cloud_default', impersonation_chain=None, **kwargs)[source]¶
基类:
airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator
对一张或一批图像运行图像检测和标注。
另请参见
有关如何使用此 Operator 的更多信息,请参阅指南: CloudVisionImageAnnotateOperator
- 参数:
request (dict | google.cloud.vision_v1.AnnotateImageRequest) – (必需)图像或批次的标注请求。 如果提供 dict,则其形式必须与以下 protobuf 消息类相同:google.cloud.vision_v1.types.AnnotateImageRequest
retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – (可选) 用于重试请求的重试对象。如果指定为 None,则不重试请求。
timeout (float | None) – (可选) 等待请求完成的时间(秒)。请注意,如果指定了 retry,则超时适用于每次单独的尝试。
gcp_conn_id (str) – (可选) 用于连接 Google Cloud 的连接 ID。
impersonation_chain (str | collections.abc.Sequence[str] | None) – 可选的服务账号,用于使用短期凭据进行模拟,或所需的账号链,以获取列表中最后一个账号的 access_token,该 token 将用于请求模拟。如果设置为字符串,则该账号必须授予源账号 Service Account Token Creator IAM 角色。如果设置为序列,则列表中的身份必须授予直接前置身份 Service Account Token Creator IAM 角色,列表中的第一个账号将此角色授予源账号(模板化)。
- template_fields: collections.abc.Sequence[str] = ('request', 'gcp_conn_id', 'impersonation_chain')[source]¶
- class airflow.providers.google.cloud.operators.vision.CloudVisionCreateReferenceImageOperator(*, location, reference_image, product_id, reference_image_id=None, project_id=PROVIDE_PROJECT_ID, retry=DEFAULT, timeout=None, metadata=(), gcp_conn_id='google_cloud_default', impersonation_chain=None, **kwargs)[source]¶
基类:
airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator
创建并返回一个新的 ReferenceImage ID 资源。
另请参见
有关如何使用此 Operator 的更多信息,请参阅指南: CloudVisionCreateReferenceImageOperator
- 参数:
location (str) – (必需) 产品所在的区域。有效区域(截至 2019-02-05)包括:us-east1, us-west1, europe-west1, asia-east1
reference_image (dict | google.cloud.vision_v1.ReferenceImage) – (必需)要创建的参考图片。 如果指定了图片 ID,则会被忽略。 如果提供 dict,则其形式必须与以下 protobuf 消息
google.cloud.vision_v1.types.ReferenceImage
相同reference_image_id (str | None) – (可选)要添加的 ReferenceImage 的用户提供的资源 ID。 如果设置此项,服务器将尝试使用此值作为资源 ID。 如果此 ID 已在使用,则返回带有 ALREADY_EXISTS 错误代码的错误。 长度必须不超过 128 个字符。 不能包含字符 /。
product_id (str) – (可选)此 Product 的资源 ID。
project_id (str) – (可选) 产品所在的项目。如果设置为 None 或缺失,则使用 Google Cloud 连接中的默认 project_id。
retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – (可选) 用于重试请求的重试对象。如果指定为 None,则不重试请求。
timeout (float | None) – (可选) 等待请求完成的时间(秒)。请注意,如果指定了 retry,则超时适用于每次单独的尝试。
metadata (MetaData) – (可选) 提供给方法的附加元数据。
gcp_conn_id (str) – (可选) 用于连接 Google Cloud 的连接 ID。
impersonation_chain (str | collections.abc.Sequence[str] | None) – 可选的服务账号,用于使用短期凭据进行模拟,或所需的账号链,以获取列表中最后一个账号的 access_token,该 token 将用于请求模拟。如果设置为字符串,则该账号必须授予源账号 Service Account Token Creator IAM 角色。如果设置为序列,则列表中的身份必须授予直接前置身份 Service Account Token Creator IAM 角色,列表中的第一个账号将此角色授予源账号(模板化)。
- template_fields: collections.abc.Sequence[str] = ('location', 'reference_image', 'product_id', 'reference_image_id', 'project_id', 'gcp_conn_id',...[source]¶
- class airflow.providers.google.cloud.operators.vision.CloudVisionDeleteReferenceImageOperator(*, location, product_id, reference_image_id, project_id=PROVIDE_PROJECT_ID, retry=DEFAULT, timeout=None, metadata=(), gcp_conn_id='google_cloud_default', impersonation_chain=None, **kwargs)[source]¶
基类:
airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator
删除一个 ReferenceImage ID 资源。
另请参见
有关如何使用此 Operator 的更多信息,请参阅指南: CloudVisionDeleteReferenceImageOperator
- 参数:
location (str) – (必需) 产品所在的区域。有效区域(截至 2019-02-05)包括:us-east1, us-west1, europe-west1, asia-east1
reference_image_id (str) – (可选)要添加的 ReferenceImage 的用户提供的资源 ID。 如果设置此项,服务器将尝试使用此值作为资源 ID。 如果此 ID 已在使用,则返回带有 ALREADY_EXISTS 错误代码的错误。 长度必须不超过 128 个字符。 不能包含字符 /。
product_id (str) – (可选)此 Product 的资源 ID。
project_id (str) – (可选) 产品所在的项目。如果设置为 None 或缺失,则使用 Google Cloud 连接中的默认 project_id。
retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – (可选) 用于重试请求的重试对象。如果指定为 None,则不重试请求。
timeout (float | None) – (可选) 等待请求完成的时间(秒)。请注意,如果指定了 retry,则超时适用于每次单独的尝试。
metadata (MetaData) – (可选) 提供给方法的附加元数据。
gcp_conn_id (str) – (可选) 用于连接 Google Cloud 的连接 ID。
impersonation_chain (str | collections.abc.Sequence[str] | None) – 可选的服务账号,用于使用短期凭据进行模拟,或所需的账号链,以获取列表中最后一个账号的 access_token,该 token 将用于请求模拟。如果设置为字符串,则该账号必须授予源账号 Service Account Token Creator IAM 角色。如果设置为序列,则列表中的身份必须授予直接前置身份 Service Account Token Creator IAM 角色,列表中的第一个账号将此角色授予源账号(模板化)。
- template_fields: collections.abc.Sequence[str] = ('location', 'product_id', 'reference_image_id', 'project_id', 'gcp_conn_id', 'impersonation_chain')[source]¶
- class airflow.providers.google.cloud.operators.vision.CloudVisionAddProductToProductSetOperator(*, product_set_id, product_id, location, project_id=PROVIDE_PROJECT_ID, retry=DEFAULT, timeout=None, metadata=(), gcp_conn_id='google_cloud_default', impersonation_chain=None, **kwargs)[source]¶
基类:
airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator
将一个 Product 添加到指定的 ProductSet。
如果 Product 已存在,则不会进行任何更改。一个 Product 最多可添加到 100 个 ProductSet。
可能的错误
如果 Product 或 ProductSet 不存在,则返回 NOT_FOUND。
另请参见
有关如何使用此 Operator 的更多信息,请参阅指南: CloudVisionAddProductToProductSetOperator
- 参数:
product_set_id (str) – (必需)要修改的 ProductSet 的资源 ID。
product_id (str) – (必需) 此产品的资源 ID。
location (str) – (必需) ProductSet 所在的区域。有效区域(截至 2019-02-05)包括:us-east1, us-west1, europe-west1, asia-east1
project_id (str) – (可选) 产品所在的项目。如果设置为 None 或缺失,则使用 Google Cloud 连接中的默认 project_id。
retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – (可选) 用于重试请求的重试对象。如果指定为 None,则不重试请求。
timeout (float | None) – (可选) 等待请求完成的时间(秒)。请注意,如果指定了 retry,则超时适用于每次单独的尝试。
metadata (MetaData) – (可选) 提供给方法的附加元数据。
gcp_conn_id (str) – (可选) 用于连接 Google Cloud 的连接 ID。
impersonation_chain (str | collections.abc.Sequence[str] | None) – 可选的服务账号,用于使用短期凭据进行模拟,或所需的账号链,以获取列表中最后一个账号的 access_token,该 token 将用于请求模拟。如果设置为字符串,则该账号必须授予源账号 Service Account Token Creator IAM 角色。如果设置为序列,则列表中的身份必须授予直接前置身份 Service Account Token Creator IAM 角色,列表中的第一个账号将此角色授予源账号(模板化)。
- template_fields: collections.abc.Sequence[str] = ('location', 'product_set_id', 'product_id', 'project_id', 'gcp_conn_id', 'impersonation_chain')[source]¶
- class airflow.providers.google.cloud.operators.vision.CloudVisionRemoveProductFromProductSetOperator(*, product_set_id, product_id, location, project_id=PROVIDE_PROJECT_ID, retry=DEFAULT, timeout=None, metadata=(), gcp_conn_id='google_cloud_default', impersonation_chain=None, **kwargs)[source]¶
基类:
airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator
从指定的 ProductSet 中移除一个 Product。
另请参见
有关如何使用此 Operator 的更多信息,请参阅指南:CloudVisionRemoveProductFromProductSetOperator
- 参数:
product_set_id (str) – (必需)要修改的 ProductSet 的资源 ID。
product_id (str) – (必需) 此产品的资源 ID。
location (str) – (必需) ProductSet 所在的区域。有效区域(截至 2019-02-05)包括:us-east1, us-west1, europe-west1, asia-east1
project_id (str) – (可选) 产品所在的项目。如果设置为 None 或缺失,则使用 Google Cloud 连接中的默认 project_id。
retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – (可选) 用于重试请求的重试对象。如果指定为 None,则不重试请求。
timeout (float | None) – (可选) 等待请求完成的时间(秒)。请注意,如果指定了 retry,则超时适用于每次单独的尝试。
metadata (MetaData) – (可选) 提供给方法的附加元数据。
gcp_conn_id (str) – (可选) 用于连接 Google Cloud 的连接 ID。
impersonation_chain (str | collections.abc.Sequence[str] | None) – 可选的服务账号,用于使用短期凭据进行模拟,或所需的账号链,以获取列表中最后一个账号的 access_token,该 token 将用于请求模拟。如果设置为字符串,则该账号必须授予源账号 Service Account Token Creator IAM 角色。如果设置为序列,则列表中的身份必须授予直接前置身份 Service Account Token Creator IAM 角色,列表中的第一个账号将此角色授予源账号(模板化)。
- template_fields: collections.abc.Sequence[str] = ('location', 'product_set_id', 'product_id', 'project_id', 'gcp_conn_id', 'impersonation_chain')[source]¶
- class airflow.providers.google.cloud.operators.vision.CloudVisionDetectTextOperator(image, max_results=None, retry=DEFAULT, timeout=None, language_hints=None, web_detection_params=None, additional_properties=None, gcp_conn_id='google_cloud_default', impersonation_chain=None, **kwargs)[source]¶
基类:
airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator
检测图像中的文本。
另请参见
有关如何使用此 Operator 的更多信息,请参阅指南:CloudVisionDetectTextOperator
- 参数:
image (dict | google.cloud.vision_v1.Image) – (必需) 要分析的图像。更多信息请参阅:https://googleapis.github.io/google-cloud-python/latest/vision/gapic/v1/types.html#google.cloud.vision_v1.types.Image
max_results (int | None) – (可选) 要返回的结果数量。
retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – (可选) 用于重试请求的重试对象。如果指定为 None,则不重试请求。
timeout (float | None) – 超时前的秒数。
language_hints (str | list[str] | None) – 用于 TEXT_DETECTION 的语言列表。在大多数情况下,空值会产生最佳结果,因为它会启用自动语言检测。对于基于拉丁字母的语言,无需设置 language_hints。
web_detection_params (dict | None) – 网页检测参数。
additional_properties (dict | None) – 要在 AnnotateImageRequest 上设置的附加属性。更多信息请参阅:
google.cloud.vision_v1.types.AnnotateImageRequest
gcp_conn_id (str) – (可选) 用于连接 Google Cloud 的连接 ID。
impersonation_chain (str | collections.abc.Sequence[str] | None) – 可选的服务账号,用于使用短期凭据进行模拟,或所需的账号链,以获取列表中最后一个账号的 access_token,该 token 将用于请求模拟。如果设置为字符串,则该账号必须授予源账号 Service Account Token Creator IAM 角色。如果设置为序列,则列表中的身份必须授予直接前置身份 Service Account Token Creator IAM 角色,列表中的第一个账号将此角色授予源账号(模板化)。
- template_fields: collections.abc.Sequence[str] = ('image', 'max_results', 'timeout', 'gcp_conn_id', 'impersonation_chain')[source]¶
- class airflow.providers.google.cloud.operators.vision.CloudVisionTextDetectOperator(image, max_results=None, retry=DEFAULT, timeout=None, language_hints=None, web_detection_params=None, additional_properties=None, gcp_conn_id='google_cloud_default', impersonation_chain=None, **kwargs)[source]¶
基类:
airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator
检测图像中的文档文本。
另请参见
有关如何使用此 Operator 的更多信息,请参阅指南:CloudVisionTextDetectOperator
- 参数:
image (dict | google.cloud.vision_v1.Image) – (必需) 要分析的图像。更多信息请参阅:https://googleapis.github.io/google-cloud-python/latest/vision/gapic/v1/types.html#google.cloud.vision_v1.types.Image
max_results (int | None) – 要返回的结果数量。
retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – (可选) 用于重试请求的重试对象。如果指定为 None,则不重试请求。
timeout (float | None) – 超时前的秒数。
language_hints (str | list[str] | None) – 用于 TEXT_DETECTION 的语言列表。在大多数情况下,空值会产生最佳结果,因为它会启用自动语言检测。对于基于拉丁字母的语言,无需设置 language_hints。
web_detection_params (dict | None) – 网页检测参数。
additional_properties (dict | None) – 要在 AnnotateImageRequest 上设置的附加属性。更多信息请参阅:https://googleapis.github.io/google-cloud-python/latest/vision/gapic/v1/types.html#google.cloud.vision_v1.types.AnnotateImageRequest
gcp_conn_id (str) – (可选) 用于连接 Google Cloud 的连接 ID。
impersonation_chain (str | collections.abc.Sequence[str] | None) – 可选的服务账号,用于使用短期凭据进行模拟,或所需的账号链,以获取列表中最后一个账号的 access_token,该 token 将用于请求模拟。如果设置为字符串,则该账号必须授予源账号 Service Account Token Creator IAM 角色。如果设置为序列,则列表中的身份必须授予直接前置身份 Service Account Token Creator IAM 角色,列表中的第一个账号将此角色授予源账号(模板化)。
- template_fields: collections.abc.Sequence[str] = ('image', 'max_results', 'timeout', 'gcp_conn_id', 'impersonation_chain')[source]¶
- class airflow.providers.google.cloud.operators.vision.CloudVisionDetectImageLabelsOperator(image, max_results=None, retry=DEFAULT, timeout=None, additional_properties=None, gcp_conn_id='google_cloud_default', impersonation_chain=None, **kwargs)[source]¶
基类:
airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator
检测图像中的文档文本。
另请参见
有关如何使用此 Operator 的更多信息,请参阅指南:CloudVisionDetectImageLabelsOperator
- 参数:
image (dict | google.cloud.vision_v1.Image) – (必需) 要分析的图像。更多信息请参阅:https://googleapis.github.io/google-cloud-python/latest/vision/gapic/v1/types.html#google.cloud.vision_v1.types.Image
max_results (int | None) – 要返回的结果数量。
retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – (可选) 用于重试请求的重试对象。如果指定为 None,则不重试请求。
timeout (float | None) – 超时前的秒数。
additional_properties (dict | None) – 要在 AnnotateImageRequest 上设置的附加属性。更多信息请参阅:https://googleapis.github.io/google-cloud-python/latest/vision/gapic/v1/types.html#google.cloud.vision_v1.types.AnnotateImageRequest
gcp_conn_id (str) – (可选) 用于连接 Google Cloud 的连接 ID。
impersonation_chain (str | collections.abc.Sequence[str] | None) – 可选的服务账号,用于使用短期凭据进行模拟,或所需的账号链,以获取列表中最后一个账号的 access_token,该 token 将用于请求模拟。如果设置为字符串,则该账号必须授予源账号 Service Account Token Creator IAM 角色。如果设置为序列,则列表中的身份必须授予直接前置身份 Service Account Token Creator IAM 角色,列表中的第一个账号将此角色授予源账号(模板化)。
- template_fields: collections.abc.Sequence[str] = ('image', 'max_results', 'timeout', 'gcp_conn_id', 'impersonation_chain')[source]¶
- class airflow.providers.google.cloud.operators.vision.CloudVisionDetectImageSafeSearchOperator(image, max_results=None, retry=DEFAULT, timeout=None, additional_properties=None, gcp_conn_id='google_cloud_default', impersonation_chain=None, **kwargs)[source]¶
基类:
airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator
检测图像中的文档文本。
另请参见
有关如何使用此 Operator 的更多信息,请参阅指南:CloudVisionDetectImageSafeSearchOperator
- 参数:
image (dict | google.cloud.vision_v1.Image) – (必需) 要分析的图像。更多信息请参阅:https://googleapis.github.io/google-cloud-python/latest/vision/gapic/v1/types.html#google.cloud.vision_v1.types.Image
max_results (int | None) – 要返回的结果数量。
retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – (可选) 用于重试请求的重试对象。如果指定为 None,则不重试请求。
timeout (float | None) – 超时前的秒数。
additional_properties (dict | None) – 要在 AnnotateImageRequest 上设置的附加属性。更多信息请参阅:https://googleapis.github.io/google-cloud-python/latest/vision/gapic/v1/types.html#google.cloud.vision_v1.types.AnnotateImageRequest
gcp_conn_id (str) – (可选) 用于连接 Google Cloud 的连接 ID。
impersonation_chain (str | collections.abc.Sequence[str] | None) – 可选的服务账号,用于使用短期凭据进行模拟,或所需的账号链,以获取列表中最后一个账号的 access_token,该 token 将用于请求模拟。如果设置为字符串,则该账号必须授予源账号 Service Account Token Creator IAM 角色。如果设置为序列,则列表中的身份必须授予直接前置身份 Service Account Token Creator IAM 角色,列表中的第一个账号将此角色授予源账号(模板化)。
- template_fields: collections.abc.Sequence[str] = ('image', 'max_results', 'timeout', 'gcp_conn_id', 'impersonation_chain')[source]¶