プロセッサの作成と管理
処理するドキュメントを送信する前に、まずプロセッサの独自のインスタンスを作成する必要があります。このページでは、プロセッサの作成と管理の詳細について説明します。
使用可能なプロセッサ
API を使用してプロセッサ インスタンスを作成するには、各プロセッサ タイプの名前を知る必要があります。アクセス権が変更される可能性があるため、このリストは(次のコードを使用して)動的に取得してください。
一般公開されているプロセッサのタイプは次のとおりです。
プロセッサをデジタル化
OCR_PROCESSOR
FORM_PARSER_PROCESSOR
LAYOUT_PARSER_PROCESSOR
事前トレーニング済みプロセッサ
BANK_STATEMENT_PROCESSOR
EXPENSE_PROCESSOR
FORM_W2_PROCESSOR
ID_PROOFING_PROCESSOR
INVOICE_PROCESSOR
PAYSTUB_PROCESSOR
US_DRIVER_LICENSE_PROCESSOR
US_PASSPORT_PROCESSOR
UTILITY_PROCESSOR
抽出 / 分類 / 分割プロセッサ
CUSTOM_EXTRACTION_PROCESSOR
CUSTOM_CLASSIFICATION_PROCESSOR
CUSTOM_SPLITTING_PROCESSOR
SUMMARIZER_PROCESSOR
プロセッサの種類を一覧表示する
ウェブ UI
Google Cloud コンソールの Document AI セクションで、[プロセッサ ギャラリー] ページに移動します。
プロセッサ タイプのリストを表示または検索します。
REST
このサンプルは、fetchProcessorTypes
メソッドを使用して、プロジェクトで使用可能なプロセッサ タイプを一覧表示する方法を示しています。
リクエストのデータを使用する前に、次のように置き換えます。
- LOCATION: プロセッサのロケーション(例:
us
- 米国eu
- 欧州連合
- PROJECT_ID: 実際の Google Cloud プロジェクト ID。
HTTP メソッドと URL:
GET https://LOCATION-documentai.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION:fetchProcessorTypes
リクエストを送信するには、次のいずれかのオプションを選択します。
curl
次のコマンドを実行します。
curl -X GET \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
"https://LOCATION-documentai.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION:fetchProcessorTypes"
PowerShell
次のコマンドを実行します。
$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }
Invoke-WebRequest `
-Method GET `
-Headers $headers `
-Uri "https://LOCATION-documentai.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION:fetchProcessorTypes" | Select-Object -Expand Content
レスポンスは ProcessorType
のリストで、使用可能なプロセッサ タイプ、カテゴリ、使用可能なロケーションが表示されます。
{ "processorTypes": [ [ ... { "name": "projects/PROJECT_ID/locations/LOCATION/processorTypes/FORM_PARSER_PROCESSOR", "type": "FORM_PARSER_PROCESSOR", "category": "GENERAL", "availableLocations": [ { "locationId": "eu" }, { "locationId": "us" } ], "allowCreation": true, "launchStage": "GA" }, { "name": "projects/PROJECT_ID/locations/LOCATION/processorTypes/OCR_PROCESSOR", "type": "OCR_PROCESSOR", "category": "GENERAL", "availableLocations": [ { "locationId": "eu" }, { "locationId": "us" } ], "allowCreation": true, "launchStage": "GA" }, { "name": "projects/PROJECT_ID/locations/LOCATION/processorTypes/INVOICE_PROCESSOR", "type": "INVOICE_PROCESSOR", "category": "SPECIALIZED", "availableLocations": [ { "locationId": "eu" }, { "locationId": "us" } ], "allowCreation": true, "launchStage": "GA" }, { "name": "projects/PROJECT_ID/locations/LOCATION/processorTypes/US_DRIVER_LICENSE_PROCESSOR", "type": "US_DRIVER_LICENSE_PROCESSOR", "category": "SPECIALIZED", "availableLocations": [ { "locationId": "us" }, { "locationId": "eu" } ], "allowCreation": true, "launchStage": "GA" }, ... ] }
Python
詳細については、Document AI Python API のリファレンス ドキュメントをご覧ください。
Document AI に対する認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
Go
詳細については、Document AI Go API のリファレンス ドキュメントをご覧ください。
Document AI に対する認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
Java
詳細については、Document AI Java API のリファレンス ドキュメントをご覧ください。
Document AI に対する認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
Ruby
詳細については、Document AI Ruby API のリファレンス ドキュメントをご覧ください。
Document AI に対する認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
C#
詳細については、Document AI C# API のリファレンス ドキュメントをご覧ください。
Document AI に対する認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
プロセッサの作成
ウェブ UI
REST
このサンプルは、processors.create
メソッドを使用して新しい processor
を作成する方法を示しています。
リクエストのデータを使用する前に、次のように置き換えます。
- LOCATION: プロセッサのロケーション(例:
us
- 米国eu
- 欧州連合
- PROJECT_ID: 実際の Google Cloud プロジェクト ID。
- PROCESSOR_TYPE: プロセッサのタイプ(例:
OCR_PROCESSOR
FORM_PARSER_PROCESSOR
INVOICE_PROCESSOR
US_DRIVER_LICENSE_PROCESSOR
- DISPLAY_NAME: プロセッサの表示名。
HTTP メソッドと URL:
POST https://LOCATION-documentai.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/processors
リクエストの本文(JSON):
{ "type": "PROCESSOR_TYPE", "displayName": "DISPLAY_NAME" }
リクエストを送信するには、次のいずれかのオプションを選択します。
curl
リクエスト本文を request.json
という名前のファイルに保存して、次のコマンドを実行します。
curl -X POST \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json; charset=utf-8" \
-d @request.json \
"https://LOCATION-documentai.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/processors"
PowerShell
リクエスト本文を request.json
という名前のファイルに保存して、次のコマンドを実行します。
$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }
Invoke-WebRequest `
-Method POST `
-Headers $headers `
-ContentType: "application/json; charset=utf-8" `
-InFile request.json `
-Uri "https://LOCATION-documentai.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/processors" | Select-Object -Expand Content
リクエストが成功すると、サーバーは 200 OK
HTTP ステータス コードと JSON 形式のレスポンスを返します。レスポンスには、processEndpoint
やプロセッサの完全な名前など、新しく作成されたプロセッサに関する情報が含まれます。これらの文字列には、リクエストの送信に必要な一意のプロセッサ ID(aa22ec60216f6ccc
など)が含まれています。
{ "name": "projects/PROJECT_ID/locations/LOCATION/processors/PROCESSOR_ID", "type": "PROCESSOR_TYPE", "displayName": "DISPLAY_NAME", "state": "ENABLED", "processEndpoint": "https://LOCATION-documentai.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/processors/PROCESSOR_ID:process", "createTime": "2022-03-02T22:50:31.395849Z", "defaultProcessorVersion": "projects/PROJECT_ID/locations/LOCATION/processors/PROCESSOR_ID/processorVersions/pretrained" }
Python
詳細については、Document AI Python API のリファレンス ドキュメントをご覧ください。
Document AI に対する認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
Go
詳細については、Document AI Go API のリファレンス ドキュメントをご覧ください。
Document AI に対する認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
Java
詳細については、Document AI Java API のリファレンス ドキュメントをご覧ください。
Document AI に対する認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
Ruby
詳細については、Document AI Ruby API のリファレンス ドキュメントをご覧ください。
Document AI に対する認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
C#
詳細については、Document AI C# API のリファレンス ドキュメントをご覧ください。
Document AI に対する認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
決済代行業者のリストを取得する
ウェブ UI
Google Cloud コンソールの Document AI セクションで、[プロセッサ] ページに移動します。
[プロセッサ] ページには、すべてのプロセッサと、その名前、ステータス、リージョン、タイプが表示されます。
REST
このサンプルは、processors.list
メソッドを使用して既存の processors
を一覧表示する方法を示しています。
リクエストのデータを使用する前に、次のように置き換えます。
- LOCATION: プロセッサのロケーション(例:
us
- 米国eu
- 欧州連合
- PROJECT_ID: 実際の Google Cloud プロジェクト ID。
HTTP メソッドと URL:
GET https://LOCATION-documentai.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/processors
リクエストを送信するには、次のいずれかのオプションを選択します。
curl
次のコマンドを実行します。
curl -X GET \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
"https://LOCATION-documentai.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/processors"
PowerShell
次のコマンドを実行します。
$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }
Invoke-WebRequest `
-Method GET `
-Headers $headers `
-Uri "https://LOCATION-documentai.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/processors" | Select-Object -Expand Content
レスポンスは Processors
のリストです。これには、name
、type
、state
などの各プロセッサに関する詳細情報が含まれます。
{ "processors": [ { "name": "projects/PROJECT_ID/locations/LOCATION/processors/PROCESSOR_ID", "type": "FORM_PARSER_PROCESSOR", "displayName": "DISPLAY_NAME", "state": "ENABLED", "processEndpoint": "https://LOCATION-documentai.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/processors/PROCESSOR_ID:process", "createTime": "2022-03-02T22:33:54.938593Z", "defaultProcessorVersion": "projects/PROJECT_ID/locations/LOCATION/processors/PROCESSOR_ID/processorVersions/pretrained" } ] }
Python
詳細については、Document AI Python API のリファレンス ドキュメントをご覧ください。
Document AI に対する認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
Go
詳細については、Document AI Go API のリファレンス ドキュメントをご覧ください。
Document AI に対する認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
Java
詳細については、Document AI Java API のリファレンス ドキュメントをご覧ください。
Document AI に対する認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
Ruby
詳細については、Document AI Ruby API のリファレンス ドキュメントをご覧ください。
Document AI に対する認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
C#
詳細については、Document AI C# API のリファレンス ドキュメントをご覧ください。
Document AI に対する認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
プロセッサの詳細を表示する
ウェブ UI
Google Cloud コンソールの Document AI セクションで、[プロセッサ] ページに移動します。
プロセッサのリストで、詳細を確認するプロセッサの名前をクリックします。
プロセッサの [概要] タブが表示されます。このタブには、名前、ID、タイプ、予測エンドポイントなどの情報が表示されます。
REST
このサンプルでは、processors.get
メソッドを使用して既存の Processor
の詳細を取得する方法を示します。
リクエストのデータを使用する前に、次のように置き換えます。
- LOCATION: プロセッサのロケーション(例:
us
- 米国eu
- 欧州連合
- PROJECT_ID: 実際の Google Cloud プロジェクト ID。
- PROCESSOR_ID: カスタム プロセッサの ID。
HTTP メソッドと URL:
GET https://LOCATION-documentai.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/processors/PROCESSOR_ID
リクエストを送信するには、次のいずれかのオプションを選択します。
curl
次のコマンドを実行します。
curl -X GET \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
"https://LOCATION-documentai.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/processors/PROCESSOR_ID"
PowerShell
次のコマンドを実行します。
$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }
Invoke-WebRequest `
-Method GET `
-Headers $headers `
-Uri "https://LOCATION-documentai.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/processors/PROCESSOR_ID" | Select-Object -Expand Content
レスポンスは Processor
で、name
、type
、state
などのプロセッサに関する詳細情報が含まれます。
{ "processors": [ { "name": "projects/PROJECT_ID/locations/LOCATION/processors/PROCESSOR_ID", "type": "OCR_PROCESSOR", "displayName": "DISPLAY_NAME", "state": "ENABLED", "processEndpoint": "https://LOCATION-documentai.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/processors/PROCESSOR_ID:process", "createTime": "2022-03-02T22:33:54.938593Z", "defaultProcessorVersion": "projects/PROJECT_ID/locations/LOCATION/processors/PROCESSOR_ID/processorVersions/pretrained" } ] }
Python
詳細については、Document AI Python API のリファレンス ドキュメントをご覧ください。
Document AI に対する認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
Go
詳細については、Document AI Go API のリファレンス ドキュメントをご覧ください。
Document AI に対する認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
Java
詳細については、Document AI Java API のリファレンス ドキュメントをご覧ください。
Document AI に対する認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
Ruby
詳細については、Document AI Ruby API のリファレンス ドキュメントをご覧ください。
Document AI に対する認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
C#
詳細については、Document AI C# API のリファレンス ドキュメントをご覧ください。
Document AI に対する認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
プロセッサを有効にする
ウェブ UI
Google Cloud コンソールの Document AI セクションで、[プロセッサ] ページに移動します。
プロセッサの横にあるアクション メニュー
で、[プロセッサを有効にする] をクリックします。
REST
このサンプルは、processors.enable
メソッドを使用して既存の Processor
を有効にする方法を示しています。
リクエストのデータを使用する前に、次のように置き換えます。
- LOCATION: プロセッサのロケーション(例:
us
- 米国eu
- 欧州連合
- PROJECT_ID: 実際の Google Cloud プロジェクト ID。
- PROCESSOR_ID: カスタム プロセッサの ID。
HTTP メソッドと URL:
POST https://LOCATION-documentai.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/processors/PROCESSOR_ID:enable
リクエストを送信するには、次のいずれかのオプションを選択します。
curl
次のコマンドを実行します。
curl -X POST \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json; charset=utf-8" \
-d "" \
"https://LOCATION-documentai.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/processors/PROCESSOR_ID:enable"
PowerShell
次のコマンドを実行します。
$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }
Invoke-WebRequest `
-Method POST `
-Headers $headers `
-Uri "https://LOCATION-documentai.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/processors/PROCESSOR_ID:enable" | Select-Object -Expand Content
レスポンスは長時間実行オペレーションです。
{ "name": "projects/PROJECT_ID/locations/LOCATION/operations/OPERATION", "metadata": { "@type": "type.googleapis.com/google.cloud.documentai.v1.EnableProcessorMetadata", "commonMetadata": { "state": "RUNNING", "createTime": "2022-03-02T22:52:49.957096Z", "updateTime": "2022-03-02T22:52:50.175976Z", "resource": "projects/PROJECT_ID/locations/LOCATION/processors/PROCESSOR_ID" } } }
長時間実行オペレーションをポーリングするには、operations.get を呼び出します。
curl -X GET https://documentai.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/operations/OPERATION \ -H "Authorization: Bearer "$(gcloud auth print-access-token) \ -H "X-Goog-User-Project: PROJECT_ID"
レスポンスの
EnableProcessorMetadata
は、オペレーションのステータスを示します。{ "name": "projects/<project_id>/locations/<location>/operations/<operation>", "metadata": { "@type": "type.googleapis.com/google.cloud.documentai.v1.EnableProcessorMetadata", "commonMetadata": { "state": "SUCCEEDED", "createTime": "2022-03-02T22:52:49.957096Z", "updateTime": "2022-03-02T22:52:50.175976Z", "resource": "projects/<project_id>/locations/<location>/processors/<processor_id>" } }, "done": true, "response": { "@type": "type.googleapis.com/google.cloud.documentai.v1.EnableProcessorResponse" } }
Python
詳細については、Document AI Python API のリファレンス ドキュメントをご覧ください。
Document AI に対する認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
Go
詳細については、Document AI Go API のリファレンス ドキュメントをご覧ください。
Document AI に対する認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
Java
詳細については、Document AI Java API のリファレンス ドキュメントをご覧ください。
Document AI に対する認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
Ruby
詳細については、Document AI Ruby API のリファレンス ドキュメントをご覧ください。
Document AI に対する認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
C#
詳細については、Document AI C# API のリファレンス ドキュメントをご覧ください。
Document AI に対する認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
プロセッサを無効にする
ウェブ UI
Google Cloud コンソールの Document AI セクションで、[プロセッサ] ページに移動します。
- プロセッサの横にあるアクション メニュー で、[プロセッサを無効にする] をクリックします。
REST
このサンプルは、processors.disable
メソッドを使用して既存の Processor
を無効にする方法を示しています。
リクエストのデータを使用する前に、次のように置き換えます。
- LOCATION: プロセッサのロケーション(例:
us
- 米国eu
- 欧州連合
- PROJECT_ID: 実際の Google Cloud プロジェクト ID。
- PROCESSOR_ID: カスタム プロセッサの ID。
HTTP メソッドと URL:
POST https://LOCATION-documentai.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/processors/PROCESSOR_ID:disable
リクエストを送信するには、次のいずれかのオプションを選択します。
curl
次のコマンドを実行します。
curl -X POST \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json; charset=utf-8" \
-d "" \
"https://LOCATION-documentai.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/processors/PROCESSOR_ID:disable"
PowerShell
次のコマンドを実行します。
$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }
Invoke-WebRequest `
-Method POST `
-Headers $headers `
-Uri "https://LOCATION-documentai.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/processors/PROCESSOR_ID:disable" | Select-Object -Expand Content
レスポンスは長時間実行オペレーションです。
{ "name": "projects/PROJECT_ID/locations/LOCATION/operations/OPERATION", "metadata": { "@type": "type.googleapis.com/google.cloud.documentai.v1.DisableProcessorMetadata", "commonMetadata": { "state": "RUNNING", "createTime": "2022-03-02T22:52:49.957096Z", "updateTime": "2022-03-02T22:52:50.175976Z", "resource": "projects/PROJECT_ID/locations/LOCATION/processors/PROCESSOR_ID" } } }
長時間実行オペレーションをポーリングするには、operations.get を呼び出します。
curl -X GET https://documentai.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/operations/OPERATION \ -H "Authorization: Bearer "$(gcloud auth print-access-token) \ -H "X-Goog-User-Project: PROJECT_ID"
レスポンスの
DisableProcessorMetadata
は、オペレーションのステータスを示します。{ "name": "projects/<project_id>/locations/<location>/operations/<operation>", "metadata": { "@type": "type.googleapis.com/google.cloud.documentai.v1.DisableProcessorMetadata", "commonMetadata": { "state": "SUCCEEDED", "createTime": "2022-03-02T22:52:49.957096Z", "updateTime": "2022-03-02T22:52:50.175976Z", "resource": "projects/<project_id>/locations/<location>/processors/<processor_id>" } }, "done": true, "response": { "@type": "type.googleapis.com/google.cloud.documentai.v1.DisableProcessorResponse" } }
Python
詳細については、Document AI Python API のリファレンス ドキュメントをご覧ください。
Document AI に対する認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
Go
詳細については、Document AI Go API のリファレンス ドキュメントをご覧ください。
Document AI に対する認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
Java
詳細については、Document AI Java API のリファレンス ドキュメントをご覧ください。
Document AI に対する認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
Ruby
詳細については、Document AI Ruby API のリファレンス ドキュメントをご覧ください。
Document AI に対する認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
C#
詳細については、Document AI C# API のリファレンス ドキュメントをご覧ください。
Document AI に対する認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
プロセッサを削除する
ウェブ UI
Google Cloud コンソールの Document AI セクションで、[プロセッサ] ページに移動します。
- プロセッサの横にあるアクション メニュー で、[プロセッサを削除] をクリックします。
REST
このサンプルは、processors.delete
メソッドを使用して既存の Processor
を削除する方法を示しています。
リクエストのデータを使用する前に、次のように置き換えます。
- LOCATION: プロセッサのロケーション(例:
us
- 米国eu
- 欧州連合
- PROJECT_ID: 実際の Google Cloud プロジェクト ID。
- PROCESSOR_ID: カスタム プロセッサの ID。
HTTP メソッドと URL:
DELETE https://LOCATION-documentai.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/processors/PROCESSOR_ID
リクエストを送信するには、次のいずれかのオプションを選択します。
curl
次のコマンドを実行します。
curl -X DELETE \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
"https://LOCATION-documentai.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/processors/PROCESSOR_ID"
PowerShell
次のコマンドを実行します。
$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }
Invoke-WebRequest `
-Method DELETE `
-Headers $headers `
-Uri "https://LOCATION-documentai.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/processors/PROCESSOR_ID" | Select-Object -Expand Content
レスポンスは長時間実行オペレーションです。
{ "name": "projects/PROJECT_ID/locations/LOCATION/operations/OPERATION", "metadata": { "@type": "type.googleapis.com/google.cloud.documentai.v1.DeleteProcessorMetadata", "commonMetadata": { "state": "RUNNING", "createTime": "2022-03-02T22:52:49.957096Z", "updateTime": "2022-03-02T22:52:50.175976Z", "resource": "projects/PROJECT_ID/locations/LOCATION/processors/PROCESSOR_ID" } } }
長時間実行オペレーションをポーリングするには、operations.get を呼び出します。
curl -X GET https://documentai.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/operations/OPERATION \ -H "Authorization: Bearer "$(gcloud auth print-access-token) \ -H "X-Goog-User-Project: PROJECT_ID"
レスポンスの
DeleteProcessorMetadata
は、オペレーションのステータスを示します。{ "name": "projects/<project_id>/locations/<location>/operations/<operation>", "metadata": { "@type": "type.googleapis.com/google.cloud.documentai.v1.DeleteProcessorMetadata", "commonMetadata": { "state": "SUCCEEDED", "createTime": "2022-03-02T22:52:49.957096Z", "updateTime": "2022-03-02T22:52:50.175976Z", "resource": "projects/<project_id>/locations/<location>/processors/<processor_id>" } }, "done": true, "response": { "@type": "type.googleapis.com/google.protobuf.Empty" } }
Python
詳細については、Document AI Python API のリファレンス ドキュメントをご覧ください。
Document AI に対する認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
Go
詳細については、Document AI Go API のリファレンス ドキュメントをご覧ください。
Document AI に対する認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
Java
詳細については、Document AI Java API のリファレンス ドキュメントをご覧ください。
Document AI に対する認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
Ruby
詳細については、Document AI Ruby API のリファレンス ドキュメントをご覧ください。
Document AI に対する認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
C#
詳細については、Document AI C# API のリファレンス ドキュメントをご覧ください。
Document AI に対する認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。