airflow.providers.google.cloud.hooks.automl

此模組包含 Google AutoML Hook。

模組內容

類別

CloudAutoMLHook

Google Cloud AutoML Hook。
class airflow.providers.google.cloud.hooks.automl.CloudAutoMLHook(gcp_conn_id='google_cloud_default', impersonation_chain=None, **kwargs)[原始碼]

基底類別： airflow.providers.google.common.hooks.base_google.GoogleBaseHook

Google Cloud AutoML Hook。

Hook 中所有使用 project_id 的方法都必須使用關鍵字引數而非位置引數來呼叫。

static extract_object_id(obj)[原始碼]

傳回物件的唯一 ID。

get_conn()[原始碼]

擷取與 AutoML 的連線。

返回

Google Cloud AutoML 用戶端物件。

返回類型

google.cloud.automl_v1beta1.AutoMlClient

wait_for_operation(operation, timeout=None)[原始碼]

等待長時間運行的操作完成。

prediction_client()[原始碼]

建立 PredictionServiceClient。

返回

Google Cloud AutoML PredictionServiceClient 用戶端物件。

返回類型

google.cloud.automl_v1beta1.PredictionServiceClient

create_model(model, location, project_id=PROVIDE_PROJECT_ID, timeout=None, metadata=(), retry=DEFAULT)[原始碼]

建立 model_id 並在完成時於 response 欄位中傳回 Model。

當您建立模型時，會為其建立數個模型評估：全域評估，以及每個註解規格的一個評估。

參數

  • model (dict | google.cloud.automl_v1beta1.Model) – 要建立的 model_id。如果提供 dict，則其格式必須與 protobuf 訊息 google.cloud.automl_v1beta1.types.Model 相同

  • project_id (str) – 要在其中建立模型的 Google Cloud 專案 ID，如果為 None，則會使用預設 project_id。

  • location (str) – 專案的位置。

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – 用於重試請求的重試物件。如果指定 None，則不會重試請求。

  • timeout (float | None) – 等待請求完成的秒數。請注意，如果指定 retry，則逾時適用於每個個別嘗試。

  • metadata (collections.abc.Sequence[tuple[str, str]]) – 提供給方法的其他中繼資料。

返回

google.cloud.automl_v1beta1.types._OperationFuture 執行個體

返回類型

google.api_core.operation.Operation

batch_predict(model_id, input_config, output_config, location, project_id=PROVIDE_PROJECT_ID, params=None, retry=DEFAULT, timeout=None, metadata=())[原始碼]

執行批次預測並傳回長時間運行的操作物件。

與線上 Predict 不同，批次預測結果不會立即在回應中提供。而是會傳回長時間運行的操作物件。

參數

  • model_id (str) – 要求用於提供批次預測的 model_id 名稱。

  • input_config (dict | google.cloud.automl_v1beta1.BatchPredictInputConfig) – 必要。批次預測的輸入設定。如果提供 dict，則其格式必須與 protobuf 訊息 google.cloud.automl_v1beta1.types.BatchPredictInputConfig 相同

  • output_config (dict | google.cloud.automl_v1beta1.BatchPredictOutputConfig) – 必要。指定應在何處寫入輸出預測的組態。如果提供 dict，則其格式必須與 protobuf 訊息 google.cloud.automl_v1beta1.types.BatchPredictOutputConfig 相同

  • params (dict[str, str] | None) – 預測的其他網域特定參數，任何字串長度都必須在 25000 個字元以內。

  • project_id (str) – 模型所在的 Google Cloud 專案 ID，如果為 None，則會使用預設 project_id。

  • location (str) – 專案的位置。

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – 用於重試請求的重試物件。如果指定 None，則不會重試請求。

  • timeout (float | None) – 等待請求完成的秒數。請注意，如果指定 retry，則逾時適用於每個個別嘗試。

  • metadata (collections.abc.Sequence[tuple[str, str]]) – 提供給方法的其他中繼資料。

返回

google.cloud.automl_v1beta1.types._OperationFuture 執行個體

返回類型

google.api_core.operation.Operation

predict(model_id, payload, location, project_id=PROVIDE_PROJECT_ID, params=None, retry=DEFAULT, timeout=None, metadata=())[原始碼]

執行線上預測並在回應中傳回預測結果。

參數

  • model_id (str) – 要求用於提供預測的 model_id 名稱。

  • payload (dict | google.cloud.automl_v1beta1.ExamplePayload) – 必要。要執行預測的酬載。酬載必須符合模型訓練來解決的問題類型。如果提供 dict，則其格式必須與 protobuf 訊息 google.cloud.automl_v1beta1.types.ExamplePayload 相同

  • params (dict[str, str] | None) – 其他網域特定參數，任何字串長度都必須在 25000 個字元以內。

  • project_id (str) – 模型所在的 Google Cloud 專案 ID，如果為 None，則會使用預設 project_id。

  • location (str) – 專案的位置。

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – 用於重試請求的重試物件。如果指定 None，則不會重試請求。

  • timeout (float | None) – 等待請求完成的秒數。請注意，如果指定 retry，則逾時適用於每個個別嘗試。

  • metadata (collections.abc.Sequence[tuple[str, str]]) – 提供給方法的其他中繼資料。

返回

google.cloud.automl_v1beta1.types.PredictResponse 執行個體

返回類型

google.cloud.automl_v1beta1.PredictResponse

create_dataset(dataset, location, project_id=PROVIDE_PROJECT_ID, retry=DEFAULT, timeout=None, metadata=())[原始碼]

建立資料集。

參數

  • dataset (dict | google.cloud.automl_v1beta1.Dataset) – 要建立的資料集。如果提供 dict，則其格式必須與 protobuf 訊息 Dataset 相同。

  • project_id (str) – 資料集所在的 Google Cloud 專案 ID，如果為 None，則會使用預設 project_id。

  • location (str) – 專案的位置。

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – 用於重試請求的重試物件。如果指定 None，則不會重試請求。

  • timeout (float | None) – 等待請求完成的秒數。請注意，如果指定 retry，則逾時適用於每個個別嘗試。

  • metadata (collections.abc.Sequence[tuple[str, str]]) – 提供給方法的其他中繼資料。

返回

google.cloud.automl_v1beta1.types.Dataset 執行個體。

返回類型

google.cloud.automl_v1beta1.Dataset

import_data(dataset_id, location, input_config, project_id=PROVIDE_PROJECT_ID, retry=DEFAULT, timeout=None, metadata=())[原始碼]

將資料匯入資料集。對於表格，此方法只能在空的資料集上呼叫。

參數

  • dataset_id (str) – AutoML 資料集的名稱。

  • input_config (dict | google.cloud.automl_v1beta1.InputConfig) – 所需的輸入位置及其網域特定的語意 (如果有的話)。如果提供 dict，則其格式必須與 protobuf 訊息 InputConfig 相同。

  • project_id (str) – 資料集所在的 Google Cloud 專案 ID，如果為 None，則會使用預設 project_id。

  • location (str) – 專案的位置。

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – 用於重試請求的重試物件。如果指定 None，則不會重試請求。

  • timeout (float | None) – 等待請求完成的秒數。請注意，如果指定 retry，則逾時適用於每個個別嘗試。

  • metadata (collections.abc.Sequence[tuple[str, str]]) – 提供給方法的其他中繼資料。

返回

google.cloud.automl_v1beta1.types._OperationFuture 執行個體

返回類型

google.api_core.operation.Operation

list_column_specs(dataset_id, table_spec_id, location, project_id=PROVIDE_PROJECT_ID, field_mask=None, filter_=None, page_size=None, retry=DEFAULT, timeout=None, metadata=())[原始碼]

列出表格規格中的欄位規格。

參數

  • dataset_id (str) – AutoML 資料集的名稱。

  • table_spec_id (str) – 路徑建構器的 table_spec_id。

  • field_mask (dict | google.protobuf.field_mask_pb2.FieldMask | None) – 指定要讀取欄位的遮罩。如果提供 dict，則其格式必須與 protobuf 訊息 google.cloud.automl_v1beta1.types.FieldMask 相同

  • filter – 篩選條件運算式，請參閱 go/filtering。

  • page_size (int | None) – 基礎 API 回應中包含的資源最大數量。如果每個資源執行頁面串流，則此參數不會影響傳回值。如果每個頁面執行頁面串流，則這會決定頁面中資源的最大數量。

  • project_id (str) – 資料集所在的 Google Cloud 專案 ID，如果為 None，則會使用預設 project_id。

  • location (str) – 專案的位置。

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – 用於重試請求的重試物件。如果指定 None，則不會重試請求。

  • timeout (float | None) – 等待請求完成的秒數。請注意，如果指定 retry，則逾時適用於每個個別嘗試。

  • metadata (collections.abc.Sequence[tuple[str, str]]) – 提供給方法的其他中繼資料。

返回

google.cloud.automl_v1beta1.types.ColumnSpec 執行個體。

返回類型

google.cloud.automl_v1beta1.services.auto_ml.pagers.ListColumnSpecsPager

get_model(model_id, location, project_id=PROVIDE_PROJECT_ID, retry=DEFAULT, timeout=None, metadata=())[原始碼]

取得 AutoML 模型。

參數

  • model_id (str) – 模型的名稱。

  • project_id (str) – 模型所在的 Google Cloud 專案 ID，如果為 None，則會使用預設 project_id。

  • location (str) – 專案的位置。

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – 用於重試請求的重試物件。如果指定 None，則不會重試請求。

  • timeout (float | None) – 等待請求完成的秒數。請注意，如果指定 retry，則逾時適用於每個個別嘗試。

  • metadata (collections.abc.Sequence[tuple[str, str]]) – 提供給方法的其他中繼資料。

返回

google.cloud.automl_v1beta1.types.Model 執行個體。

返回類型

google.cloud.automl_v1beta1.Model

delete_model(model_id, location, project_id=PROVIDE_PROJECT_ID, retry=DEFAULT, timeout=None, metadata=())[原始碼]

刪除 AutoML 模型。

參數

  • model_id (str) – 模型的名稱。

  • project_id (str) – 模型所在的 Google Cloud 專案 ID，如果為 None，則會使用預設 project_id。

  • location (str) – 專案的位置。

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – 用於重試請求的重試物件。如果指定 None，則不會重試請求。

  • timeout (float | None) – 等待請求完成的秒數。請注意，如果指定 retry，則逾時適用於每個個別嘗試。

  • metadata (collections.abc.Sequence[tuple[str, str]]) – 提供給方法的其他中繼資料。

返回

google.cloud.automl_v1beta1.types._OperationFuture 執行個體。

返回類型

google.api_core.operation.Operation

update_dataset(dataset, update_mask=None, retry=DEFAULT, timeout=None, metadata=())[原始碼]

更新資料集。

參數

  • dataset (dict | google.cloud.automl_v1beta1.Dataset) – 取代伺服器上資源的資料集。如果提供 dict，則其格式必須與 protobuf 訊息 Dataset 相同。

  • update_mask (dict | google.protobuf.field_mask_pb2.FieldMask | None) – 更新遮罩適用於資源。如果提供 dict，則其格式必須與 protobuf 訊息 FieldMask 相同。

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – 用於重試請求的重試物件。如果指定 None，則不會重試請求。

  • timeout (float | None) – 等待請求完成的秒數。請注意，如果指定 retry，則逾時適用於每個個別嘗試。

  • metadata (collections.abc.Sequence[tuple[str, str]]) – 提供給方法的其他中繼資料。

返回

google.cloud.automl_v1beta1.types.Dataset 執行個體。

返回類型

google.cloud.automl_v1beta1.Dataset

deploy_model(model_id, location, project_id=PROVIDE_PROJECT_ID, image_detection_metadata=None, retry=DEFAULT, timeout=None, metadata=())[原始碼]

部署模型。

如果模型已部署，則使用相同參數部署模型沒有任何作用。使用不同參數 (例如，變更 node_number) 進行部署將會重設部署狀態，而不會暫停 model_id 的可用性。

僅適用於文字分類、影像物件偵測和表格；所有其他網域都會自動管理部署。

參數

  • model_id (str) – 要求用於提供預測的模型的名稱。

  • image_detection_metadata (google.cloud.automl_v1beta1.ImageObjectDetectionModelDeploymentMetadata | dict | None) – 模型部署中繼資料，特定於影像物件偵測。如果提供 dict，則其格式必須與 protobuf 訊息 ImageObjectDetectionModelDeploymentMetadata 相同

  • project_id (str) – 要在其中建立模型的 Google Cloud 專案 ID，如果為 None，則會使用預設 project_id。

  • location (str) – 專案的位置。

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – 用於重試請求的重試物件。如果指定 None，則不會重試請求。

  • timeout (float | None) – 等待請求完成的秒數。請注意，如果指定 retry，則逾時適用於每個個別嘗試。

  • metadata (collections.abc.Sequence[tuple[str, str]]) – 提供給方法的其他中繼資料。

返回

google.cloud.automl_v1beta1.types._OperationFuture 執行個體。

返回類型

google.api_core.operation.Operation

list_table_specs(dataset_id, location, project_id=PROVIDE_PROJECT_ID, filter_=None, page_size=None, retry=DEFAULT, timeout=None, metadata=())[原始碼]

列出 dataset_id 中的表格規格。

參數

  • dataset_id (str) – 資料集的名稱。

  • filter – 篩選條件運算式，請參閱 go/filtering。

  • page_size (int | None) – 基礎 API 回應中包含的資源最大數量。如果每個資源執行頁面串流，則此參數不會影響傳回值。如果每個頁面執行頁面串流，則這會決定頁面中資源的最大數量。

  • project_id (str) – 資料集所在的 Google Cloud 專案 ID，如果為 None，則會使用預設 project_id。

  • location (str) – 專案的位置。

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – 用於重試請求的重試物件。如果指定 None，則不會重試請求。

  • timeout (float | None) – 等待請求完成的秒數。請注意，如果指定 retry，則逾時適用於每個個別嘗試。

  • metadata (collections.abc.Sequence[tuple[str, str]]) – 提供給方法的其他中繼資料。

返回

google.gax.PageIterator 執行個體。預設情況下，這是 google.cloud.automl_v1beta1.types.TableSpec 執行個體的疊代器。此物件也可以設定為透過 options 參數疊代回應的頁面。

返回類型

google.cloud.automl_v1beta1.services.auto_ml.pagers.ListTableSpecsPager

list_datasets(location, project_id, retry=DEFAULT, timeout=None, metadata=())[原始碼]

列出專案中的資料集。

參數

  • project_id (str) – 資料集所在的 Google Cloud 專案 ID，如果為 None，則會使用預設 project_id。

  • location (str) – 專案的位置。

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – 用於重試請求的重試物件。如果指定 None，則不會重試請求。

  • timeout (float | None) – 等待請求完成的秒數。請注意，如果指定 retry，則逾時適用於每個個別嘗試。

  • metadata (collections.abc.Sequence[tuple[str, str]]) – 提供給方法的其他中繼資料。

返回

google.gax.PageIterator 執行個體。預設情況下，這是 google.cloud.automl_v1beta1.types.Dataset 執行個體的疊代器。此物件也可以設定為透過 options 參數疊代回應的頁面。

返回類型

google.cloud.automl_v1beta1.services.auto_ml.pagers.ListDatasetsPager

delete_dataset(dataset_id, location, project_id, retry=DEFAULT, timeout=None, metadata=())[原始碼]

刪除資料集及其所有內容。

參數

  • dataset_id (str) – 要刪除的資料集 ID。

  • project_id (str) – 資料集所在的 Google Cloud 專案 ID，如果為 None，則會使用預設 project_id。

  • location (str) – 專案的位置。

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – 用於重試請求的重試物件。如果指定 None，則不會重試請求。

  • timeout (float | None) – 等待請求完成的秒數。請注意，如果指定 retry，則逾時適用於每個個別嘗試。

  • metadata (collections.abc.Sequence[tuple[str, str]]) – 提供給方法的其他中繼資料。

返回

google.cloud.automl_v1beta1.types._OperationFuture 執行個體

返回類型

google.api_core.operation.Operation

get_dataset(dataset_id, location, project_id, retry=DEFAULT, timeout=None, metadata=())[原始碼]

檢索給定 dataset_id 的資料集。

參數

  • dataset_id (str) – 要檢索的資料集 ID。

  • location (str) – 專案的位置。

  • project_id (str) – 資料集所在的 Google Cloud 專案 ID，如果為 None，則會使用預設 project_id。

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – 用於重試請求的重試物件。如果指定 None，則不會重試請求。

  • timeout (float | None) – 等待請求完成的秒數。請注意，如果指定 retry，則逾時適用於每個個別嘗試。

  • metadata (collections.abc.Sequence[tuple[str, str]]) – 提供給方法的其他中繼資料。

返回

google.cloud.automl_v1beta1.types.dataset.Dataset 執行個體。

返回類型

google.cloud.automl_v1beta1.Dataset

這個條目有幫助嗎？