创建和管理处理器

您必须先创建自己的处理器实例,然后才能发送文档进行处理。本页面详细介绍了如何创建和管理处理器。

可用的处理器

如需使用 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

列出处理器类型

网页界面

  1. 在 Google Cloud 控制台的 Document AI 部分,前往处理器库页面。

    前往处理器库

  2. 查看或搜索处理器类型列表。

REST

此示例展示了如何使用 fetchProcessorTypes 方法列出项目的可用处理器类型。

在使用任何请求数据之前,请先进行以下替换:

  • LOCATION:处理器的位置,例如:
    • us - 美国
    • eu - 欧盟
  • PROJECT_ID:您的 Google Cloud 项目 ID。

HTTP 方法和网址:

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 进行身份验证,请设置应用默认凭据。 如需了解详情,请参阅为本地开发环境设置身份验证

 from google.api_core.client_options import ClientOptions from google.cloud import documentai  # type: ignore  # TODO(developer): Uncomment these variables before running the sample. # project_id = 'YOUR_PROJECT_ID' # location = 'YOUR_PROCESSOR_LOCATION' # Format is 'us' or 'eu'   def fetch_processor_types_sample(project_id: str, location: str) -> None:     # You must set the api_endpoint if you use a location other than 'us'.     opts = ClientOptions(api_endpoint=f"{location}-documentai.googleapis.com")      client = documentai.DocumentProcessorServiceClient(client_options=opts)      # The full resource name of the location     # e.g.: projects/project_id/locations/location     parent = client.common_location_path(project_id, location)      # Fetch all processor types     response = client.fetch_processor_types(parent=parent)      print("Processor types:")     # Print the available processor types     for processor_type in response.processor_types:         if processor_type.allow_creation:             print(processor_type.type_)  

Go

如需了解详情,请参阅 Document AI Go API 参考文档

如需向 Document AI 进行身份验证,请设置应用默认凭据。 如需了解详情,请参阅为本地开发环境设置身份验证

 package main  import ( 	"context"  	documentai "cloud.google.com/go/documentai/apiv1" 	documentaipb "cloud.google.com/go/documentai/apiv1/documentaipb" )  func main() { 	ctx := context.Background() 	// 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://pkg.go.dev/cloud.google.com/go#hdr-Client_Options 	c, err := documentai.NewDocumentProcessorClient(ctx) 	if err != nil { 		// TODO: Handle error. 	} 	defer c.Close()  	req := &documentaipb.FetchProcessorTypesRequest{ 		// TODO: Fill request struct fields. 		// See https://pkg.go.dev/cloud.google.com/go/documentai/apiv1/documentaipb#FetchProcessorTypesRequest. 	} 	resp, err := c.FetchProcessorTypes(ctx, req) 	if err != nil { 		// TODO: Handle error. 	} 	// TODO: Use resp. 	_ = resp } 

Java

如需了解详情,请参阅 Document AI Java API 参考文档

如需向 Document AI 进行身份验证,请设置应用默认凭据。 如需了解详情,请参阅为本地开发环境设置身份验证

import com.google.cloud.documentai.v1.DocumentProcessorServiceClient; import com.google.cloud.documentai.v1.FetchProcessorTypesRequest; import com.google.cloud.documentai.v1.FetchProcessorTypesResponse; import com.google.cloud.documentai.v1.LocationName;  public class SyncFetchProcessorTypes {    public static void main(String[] args) throws Exception {     syncFetchProcessorTypes();   }    public static void syncFetchProcessorTypes() throws Exception {     // 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library     try (DocumentProcessorServiceClient documentProcessorServiceClient =         DocumentProcessorServiceClient.create()) {       FetchProcessorTypesRequest request =           FetchProcessorTypesRequest.newBuilder()               .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())               .build();       FetchProcessorTypesResponse response =           documentProcessorServiceClient.fetchProcessorTypes(request);     }   } }

Ruby

如需了解详情,请参阅 Document AI Ruby API 参考文档

如需向 Document AI 进行身份验证,请设置应用默认凭据。 如需了解详情,请参阅为本地开发环境设置身份验证

require "google/cloud/document_ai/v1"  ## # Snippet for the fetch_processor_types call in the DocumentProcessorService service # # 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://cloud.google.com/ruby/docs/reference. # # This is an auto-generated example demonstrating basic usage of # Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#fetch_processor_types. # def fetch_processor_types   # Create a client object. The client can be reused for multiple calls.   client = Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client.new    # Create a request. To set request fields, pass in keyword arguments.   request = Google::Cloud::DocumentAI::V1::FetchProcessorTypesRequest.new    # Call the fetch_processor_types method.   result = client.fetch_processor_types request    # The returned object is of type Google::Cloud::DocumentAI::V1::FetchProcessorTypesResponse.   p result end

C#

如需了解详情,请参阅 Document AI C# API 参考文档

如需向 Document AI 进行身份验证,请设置应用默认凭据。 如需了解详情,请参阅为本地开发环境设置身份验证

using Google.Api.Gax.ResourceNames; using Google.Cloud.DocumentAI.V1;  public sealed partial class GeneratedDocumentProcessorServiceClientSnippets {     /// <summary>Snippet for FetchProcessorTypes</summary>     /// <remarks>     /// 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://cloud.google.com/dotnet/docs/reference/help/client-configuration#endpoint.     /// </remarks>     public void FetchProcessorTypesRequestObject()     {         // Create client         DocumentProcessorServiceClient documentProcessorServiceClient = DocumentProcessorServiceClient.Create();         // Initialize request argument(s)         FetchProcessorTypesRequest request = new FetchProcessorTypesRequest         {             ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),         };         // Make the request         FetchProcessorTypesResponse response = documentProcessorServiceClient.FetchProcessorTypes(request);     } }

创建处理器

网页界面

  1. 在 Google Cloud 控制台的 Document AI 部分,前往处理器库页面。

    前往处理器库

  2. 查看或搜索处理器库,找到要创建的处理器。

  3. 在列表中点击要创建的处理器类型。

  4. 在侧边创建处理器窗口中,指定处理器名称。

  5. 从列表中选择您的地区

  6. 点击创建以创建处理器。

    系统会将您转到处理器的概览标签页,其中包含名称ID类型预测端点等信息。 使用此端点发送请求

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 方法和网址:

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 进行身份验证,请设置应用默认凭据。 如需了解详情,请参阅为本地开发环境设置身份验证

 from google.api_core.client_options import ClientOptions from google.cloud import documentai  # type: ignore  # TODO(developer): Uncomment these variables before running the sample. # project_id = 'YOUR_PROJECT_ID' # location = 'YOUR_PROCESSOR_LOCATION' # Format is 'us' or 'eu' # processor_display_name = 'YOUR_PROCESSOR_DISPLAY_NAME' # Must be unique per project, e.g.: 'My Processor' # processor_type = 'YOUR_PROCESSOR_TYPE' # Use fetch_processor_types to get available processor types   def create_processor_sample(     project_id: str, location: str, processor_display_name: str, processor_type: str ) -> None:     # You must set the api_endpoint if you use a location other than 'us'.     opts = ClientOptions(api_endpoint=f"{location}-documentai.googleapis.com")      client = documentai.DocumentProcessorServiceClient(client_options=opts)      # The full resource name of the location     # e.g.: projects/project_id/locations/location     parent = client.common_location_path(project_id, location)      # Create a processor     processor = client.create_processor(         parent=parent,         processor=documentai.Processor(             display_name=processor_display_name, type_=processor_type         ),     )      # Print the processor information     print(f"Processor Name: {processor.name}")     print(f"Processor Display Name: {processor.display_name}")     print(f"Processor Type: {processor.type_}")  

Go

如需了解详情,请参阅 Document AI Go API 参考文档

如需向 Document AI 进行身份验证,请设置应用默认凭据。 如需了解详情,请参阅为本地开发环境设置身份验证

 package main  import ( 	"context"  	documentai "cloud.google.com/go/documentai/apiv1" 	documentaipb "cloud.google.com/go/documentai/apiv1/documentaipb" )  func main() { 	ctx := context.Background() 	// 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://pkg.go.dev/cloud.google.com/go#hdr-Client_Options 	c, err := documentai.NewDocumentProcessorClient(ctx) 	if err != nil { 		// TODO: Handle error. 	} 	defer c.Close()  	req := &documentaipb.CreateProcessorRequest{ 		// TODO: Fill request struct fields. 		// See https://pkg.go.dev/cloud.google.com/go/documentai/apiv1/documentaipb#CreateProcessorRequest. 	} 	resp, err := c.CreateProcessor(ctx, req) 	if err != nil { 		// TODO: Handle error. 	} 	// TODO: Use resp. 	_ = resp } 

Java

如需了解详情,请参阅 Document AI Java API 参考文档

如需向 Document AI 进行身份验证,请设置应用默认凭据。 如需了解详情,请参阅为本地开发环境设置身份验证

import com.google.cloud.documentai.v1.CreateProcessorRequest; import com.google.cloud.documentai.v1.DocumentProcessorServiceClient; import com.google.cloud.documentai.v1.LocationName; import com.google.cloud.documentai.v1.Processor;  public class SyncCreateProcessor {    public static void main(String[] args) throws Exception {     syncCreateProcessor();   }    public static void syncCreateProcessor() throws Exception {     // 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library     try (DocumentProcessorServiceClient documentProcessorServiceClient =         DocumentProcessorServiceClient.create()) {       CreateProcessorRequest request =           CreateProcessorRequest.newBuilder()               .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())               .setProcessor(Processor.newBuilder().build())               .build();       Processor response = documentProcessorServiceClient.createProcessor(request);     }   } }

Ruby

如需了解详情,请参阅 Document AI Ruby API 参考文档

如需向 Document AI 进行身份验证,请设置应用默认凭据。 如需了解详情,请参阅为本地开发环境设置身份验证

require "google/cloud/document_ai/v1"  ## # Snippet for the create_processor call in the DocumentProcessorService service # # 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://cloud.google.com/ruby/docs/reference. # # This is an auto-generated example demonstrating basic usage of # Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#create_processor. # def create_processor   # Create a client object. The client can be reused for multiple calls.   client = Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client.new    # Create a request. To set request fields, pass in keyword arguments.   request = Google::Cloud::DocumentAI::V1::CreateProcessorRequest.new    # Call the create_processor method.   result = client.create_processor request    # The returned object is of type Google::Cloud::DocumentAI::V1::Processor.   p result end

C#

如需了解详情,请参阅 Document AI C# API 参考文档

如需向 Document AI 进行身份验证,请设置应用默认凭据。 如需了解详情,请参阅为本地开发环境设置身份验证

using Google.Api.Gax.ResourceNames; using Google.Cloud.DocumentAI.V1;  public sealed partial class GeneratedDocumentProcessorServiceClientSnippets {     /// <summary>Snippet for CreateProcessor</summary>     /// <remarks>     /// 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://cloud.google.com/dotnet/docs/reference/help/client-configuration#endpoint.     /// </remarks>     public void CreateProcessorRequestObject()     {         // Create client         DocumentProcessorServiceClient documentProcessorServiceClient = DocumentProcessorServiceClient.Create();         // Initialize request argument(s)         CreateProcessorRequest request = new CreateProcessorRequest         {             ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),             Processor = new Processor(),         };         // Make the request         Processor response = documentProcessorServiceClient.CreateProcessor(request);     } }

获取处理器列表

网页界面

  1. 在 Google Cloud 控制台的 Document AI 部分,前往处理器页面。

    前往“处理器”页面

    处理器页面会列出所有处理器及其名称状态地区类型

REST

此示例展示了如何使用 processors.list 方法列出现有 processors

在使用任何请求数据之前,请先进行以下替换:

  • LOCATION:处理器的位置,例如:
    • us - 美国
    • eu - 欧盟
  • PROJECT_ID:您的 Google Cloud 项目 ID。

HTTP 方法和网址:

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 的列表,其中包含有关每个处理器的信息,例如其 nametypestate 和其他详细信息。

 {   "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 进行身份验证,请设置应用默认凭据。 如需了解详情,请参阅为本地开发环境设置身份验证

 from google.api_core.client_options import ClientOptions from google.cloud import documentai  # type: ignore  # TODO(developer): Uncomment these variables before running the sample. # project_id = 'YOUR_PROJECT_ID' # location = 'YOUR_PROCESSOR_LOCATION' # Format is 'us' or 'eu'   def list_processors_sample(project_id: str, location: str) -> None:     # You must set the api_endpoint if you use a location other than 'us'.     opts = ClientOptions(api_endpoint=f"{location}-documentai.googleapis.com")      client = documentai.DocumentProcessorServiceClient(client_options=opts)      # The full resource name of the location     # e.g.: projects/project_id/locations/location     parent = client.common_location_path(project_id, location)      # Make ListProcessors request     processor_list = client.list_processors(parent=parent)      # Print the processor information     for processor in processor_list:         print(f"Processor Name: {processor.name}")         print(f"Processor Display Name: {processor.display_name}")         print(f"Processor Type: {processor.type_}")         print("")  

Go

如需了解详情,请参阅 Document AI Go API 参考文档

如需向 Document AI 进行身份验证,请设置应用默认凭据。 如需了解详情,请参阅为本地开发环境设置身份验证

 package main  import ( 	"context"  	documentai "cloud.google.com/go/documentai/apiv1" 	documentaipb "cloud.google.com/go/documentai/apiv1/documentaipb" 	"google.golang.org/api/iterator" )  func main() { 	ctx := context.Background() 	// 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://pkg.go.dev/cloud.google.com/go#hdr-Client_Options 	c, err := documentai.NewDocumentProcessorClient(ctx) 	if err != nil { 		// TODO: Handle error. 	} 	defer c.Close()  	req := &documentaipb.ListProcessorsRequest{ 		// TODO: Fill request struct fields. 		// See https://pkg.go.dev/cloud.google.com/go/documentai/apiv1/documentaipb#ListProcessorsRequest. 	} 	it := c.ListProcessors(ctx, req) 	for { 		resp, err := it.Next() 		if err == iterator.Done { 			break 		} 		if err != nil { 			// TODO: Handle error. 		} 		// TODO: Use resp. 		_ = resp  		// If you need to access the underlying RPC response, 		// you can do so by casting the `Response` as below. 		// Otherwise, remove this line. Only populated after 		// first call to Next(). Not safe for concurrent access. 		_ = it.Response.(*documentaipb.ListProcessorsResponse) 	} } 

Java

如需了解详情,请参阅 Document AI Java API 参考文档

如需向 Document AI 进行身份验证,请设置应用默认凭据。 如需了解详情,请参阅为本地开发环境设置身份验证

import com.google.cloud.documentai.v1.DocumentProcessorServiceClient; import com.google.cloud.documentai.v1.ListProcessorsRequest; import com.google.cloud.documentai.v1.LocationName; import com.google.cloud.documentai.v1.Processor;  public class SyncListProcessors {    public static void main(String[] args) throws Exception {     syncListProcessors();   }    public static void syncListProcessors() throws Exception {     // 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library     try (DocumentProcessorServiceClient documentProcessorServiceClient =         DocumentProcessorServiceClient.create()) {       ListProcessorsRequest request =           ListProcessorsRequest.newBuilder()               .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())               .setPageSize(883849137)               .setPageToken("pageToken873572522")               .build();       for (Processor element :           documentProcessorServiceClient.listProcessors(request).iterateAll()) {         // doThingsWith(element);       }     }   } }

Ruby

如需了解详情,请参阅 Document AI Ruby API 参考文档

如需向 Document AI 进行身份验证,请设置应用默认凭据。 如需了解详情,请参阅为本地开发环境设置身份验证

require "google/cloud/document_ai/v1"  ## # Snippet for the list_processors call in the DocumentProcessorService service # # 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://cloud.google.com/ruby/docs/reference. # # This is an auto-generated example demonstrating basic usage of # Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#list_processors. # def list_processors   # Create a client object. The client can be reused for multiple calls.   client = Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client.new    # Create a request. To set request fields, pass in keyword arguments.   request = Google::Cloud::DocumentAI::V1::ListProcessorsRequest.new    # Call the list_processors method.   result = client.list_processors request    # The returned object is of type Gapic::PagedEnumerable. You can iterate   # over elements, and API calls will be issued to fetch pages as needed.   result.each do |item|     # Each element is of type ::Google::Cloud::DocumentAI::V1::Processor.     p item   end end

C#

如需了解详情,请参阅 Document AI C# API 参考文档

如需向 Document AI 进行身份验证,请设置应用默认凭据。 如需了解详情,请参阅为本地开发环境设置身份验证

using Google.Api.Gax; using Google.Api.Gax.ResourceNames; using Google.Cloud.DocumentAI.V1; using System;  public sealed partial class GeneratedDocumentProcessorServiceClientSnippets {     /// <summary>Snippet for ListProcessors</summary>     /// <remarks>     /// 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://cloud.google.com/dotnet/docs/reference/help/client-configuration#endpoint.     /// </remarks>     public void ListProcessorsRequestObject()     {         // Create client         DocumentProcessorServiceClient documentProcessorServiceClient = DocumentProcessorServiceClient.Create();         // Initialize request argument(s)         ListProcessorsRequest request = new ListProcessorsRequest         {             ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),         };         // Make the request         PagedEnumerable<ListProcessorsResponse, Processor> response = documentProcessorServiceClient.ListProcessors(request);          // Iterate over all response items, lazily performing RPCs as required         foreach (Processor item in response)         {             // Do something with each item             Console.WriteLine(item);         }          // Or iterate over pages (of server-defined size), performing one RPC per page         foreach (ListProcessorsResponse page in response.AsRawResponses())         {             // Do something with each page of items             Console.WriteLine("A page of results:");             foreach (Processor item in page)             {                 // Do something with each item                 Console.WriteLine(item);             }         }          // Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required         int pageSize = 10;         Page<Processor> singlePage = response.ReadPage(pageSize);         // Do something with the page of items         Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");         foreach (Processor item in singlePage)         {             // Do something with each item             Console.WriteLine(item);         }         // Store the pageToken, for when the next page is required.         string nextPageToken = singlePage.NextPageToken;     } }

查看处理器的详细信息

网页界面

  1. 在 Google Cloud 控制台的 Document AI 部分,前往处理器页面。

    前往“处理器”页面

  2. 在处理器列表中,点击要查看其详细信息的处理器的名称。

    系统会将您转到处理器的概览标签页,其中包含名称ID类型预测端点等信息。

REST

此示例展示了如何使用 processors.get 方法获取有关现有 Processor 的详细信息。

在使用任何请求数据之前,请先进行以下替换:

  • LOCATION:处理器的位置,例如:
    • us - 美国
    • eu - 欧盟
  • PROJECT_ID:您的 Google Cloud 项目 ID。
  • PROCESSOR_ID:自定义处理器的 ID。

HTTP 方法和网址:

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,其中包含有关处理器的信息,例如其 nametypestate 和其他详细信息。

 {   "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 进行身份验证,请设置应用默认凭据。 如需了解详情,请参阅为本地开发环境设置身份验证

 from google.api_core.client_options import ClientOptions from google.cloud import documentai  # type: ignore  # TODO(developer): Uncomment these variables before running the sample. # project_id = 'YOUR_PROJECT_ID' # location = 'YOUR_PROCESSOR_LOCATION' # Format is 'us' or 'eu' # processor_id = 'YOUR_PROCESSOR_ID'   def get_processor_sample(project_id: str, location: str, processor_id: str) -> None:     # You must set the api_endpoint if you use a location other than 'us'.     opts = ClientOptions(api_endpoint=f"{location}-documentai.googleapis.com")      client = documentai.DocumentProcessorServiceClient(client_options=opts)      # The full resource name of the processor, e.g.:     # projects/{project_id}/locations/{location}/processors/{processor_id}     name = client.processor_path(project_id, location, processor_id)      # Make GetProcessor request     processor = client.get_processor(name=name)      # Print the processor information     print(f"Processor Name: {processor.name}")     print(f"Processor Display Name: {processor.display_name}")     print(f"Processor Type: {processor.type_}")  

Go

如需了解详情,请参阅 Document AI Go API 参考文档

如需向 Document AI 进行身份验证,请设置应用默认凭据。 如需了解详情,请参阅为本地开发环境设置身份验证

 package main  import ( 	"context"  	documentai "cloud.google.com/go/documentai/apiv1" 	documentaipb "cloud.google.com/go/documentai/apiv1/documentaipb" )  func main() { 	ctx := context.Background() 	// 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://pkg.go.dev/cloud.google.com/go#hdr-Client_Options 	c, err := documentai.NewDocumentProcessorClient(ctx) 	if err != nil { 		// TODO: Handle error. 	} 	defer c.Close()  	req := &documentaipb.GetProcessorRequest{ 		// TODO: Fill request struct fields. 		// See https://pkg.go.dev/cloud.google.com/go/documentai/apiv1/documentaipb#GetProcessorRequest. 	} 	resp, err := c.GetProcessor(ctx, req) 	if err != nil { 		// TODO: Handle error. 	} 	// TODO: Use resp. 	_ = resp } 

Java

如需了解详情,请参阅 Document AI Java API 参考文档

如需向 Document AI 进行身份验证,请设置应用默认凭据。 如需了解详情,请参阅为本地开发环境设置身份验证

import com.google.cloud.documentai.v1.DocumentProcessorServiceClient; import com.google.cloud.documentai.v1.GetProcessorRequest; import com.google.cloud.documentai.v1.Processor; import com.google.cloud.documentai.v1.ProcessorName;  public class SyncGetProcessor {    public static void main(String[] args) throws Exception {     syncGetProcessor();   }    public static void syncGetProcessor() throws Exception {     // 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library     try (DocumentProcessorServiceClient documentProcessorServiceClient =         DocumentProcessorServiceClient.create()) {       GetProcessorRequest request =           GetProcessorRequest.newBuilder()               .setName(ProcessorName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]").toString())               .build();       Processor response = documentProcessorServiceClient.getProcessor(request);     }   } }

Ruby

如需了解详情,请参阅 Document AI Ruby API 参考文档

如需向 Document AI 进行身份验证,请设置应用默认凭据。 如需了解详情,请参阅为本地开发环境设置身份验证

require "google/cloud/document_ai/v1"  ## # Snippet for the get_processor call in the DocumentProcessorService service # # 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://cloud.google.com/ruby/docs/reference. # # This is an auto-generated example demonstrating basic usage of # Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#get_processor. # def get_processor   # Create a client object. The client can be reused for multiple calls.   client = Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client.new    # Create a request. To set request fields, pass in keyword arguments.   request = Google::Cloud::DocumentAI::V1::GetProcessorRequest.new    # Call the get_processor method.   result = client.get_processor request    # The returned object is of type Google::Cloud::DocumentAI::V1::Processor.   p result end

C#

如需了解详情,请参阅 Document AI C# API 参考文档

如需向 Document AI 进行身份验证,请设置应用默认凭据。 如需了解详情,请参阅为本地开发环境设置身份验证

using Google.Cloud.DocumentAI.V1;  public sealed partial class GeneratedDocumentProcessorServiceClientSnippets {     /// <summary>Snippet for GetProcessor</summary>     /// <remarks>     /// 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://cloud.google.com/dotnet/docs/reference/help/client-configuration#endpoint.     /// </remarks>     public void GetProcessorRequestObject()     {         // Create client         DocumentProcessorServiceClient documentProcessorServiceClient = DocumentProcessorServiceClient.Create();         // Initialize request argument(s)         GetProcessorRequest request = new GetProcessorRequest         {             ProcessorName = ProcessorName.FromProjectLocationProcessor("[PROJECT]", "[LOCATION]", "[PROCESSOR]"),         };         // Make the request         Processor response = documentProcessorServiceClient.GetProcessor(request);     } }

启用处理器

网页界面

  1. 在 Google Cloud 控制台的 Document AI 部分,前往处理器页面。

    前往“处理器”页面

  2. 在处理器旁边的操作菜单 中,点击启用处理器

REST

此示例展示了如何使用 processors.enable 方法启用现有的 Processor

在使用任何请求数据之前,请先进行以下替换:

  • LOCATION:处理器的位置,例如:
    • us - 美国
    • eu - 欧盟
  • PROJECT_ID:您的 Google Cloud 项目 ID。
  • PROCESSOR_ID:自定义处理器的 ID。

HTTP 方法和网址:

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"     }   } } 
  1. 如需轮询长时间运行的操作,请调用 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"
  2. 响应中的 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 进行身份验证,请设置应用默认凭据。 如需了解详情,请参阅为本地开发环境设置身份验证

 from google.api_core.client_options import ClientOptions from google.api_core.exceptions import FailedPrecondition from google.cloud import documentai  # type: ignore  # TODO(developer): Uncomment these variables before running the sample. # project_id = 'YOUR_PROJECT_ID' # location = 'YOUR_PROCESSOR_LOCATION' # Format is 'us' or 'eu' # processor_id = 'YOUR_PROCESSOR_ID'   def enable_processor_sample(project_id: str, location: str, processor_id: str) -> None:     # You must set the api_endpoint if you use a location other than 'us'.     opts = ClientOptions(api_endpoint=f"{location}-documentai.googleapis.com")      client = documentai.DocumentProcessorServiceClient(client_options=opts)      # The full resource name of the location     # e.g.: projects/project_id/locations/location/processors/processor_id     processor_name = client.processor_path(project_id, location, processor_id)     request = documentai.EnableProcessorRequest(name=processor_name)      # Make EnableProcessor request     try:         operation = client.enable_processor(request=request)          # Print operation name         print(operation.operation.name)         # Wait for operation to complete         operation.result()     # Cannot enable a processor that is already enabled     except FailedPrecondition as e:         print(e.message)  

Go

如需了解详情,请参阅 Document AI Go API 参考文档

如需向 Document AI 进行身份验证,请设置应用默认凭据。 如需了解详情,请参阅为本地开发环境设置身份验证

 package main  import ( 	"context"  	documentai "cloud.google.com/go/documentai/apiv1" 	documentaipb "cloud.google.com/go/documentai/apiv1/documentaipb" )  func main() { 	ctx := context.Background() 	// 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://pkg.go.dev/cloud.google.com/go#hdr-Client_Options 	c, err := documentai.NewDocumentProcessorClient(ctx) 	if err != nil { 		// TODO: Handle error. 	} 	defer c.Close()  	req := &documentaipb.EnableProcessorRequest{ 		// TODO: Fill request struct fields. 		// See https://pkg.go.dev/cloud.google.com/go/documentai/apiv1/documentaipb#EnableProcessorRequest. 	} 	op, err := c.EnableProcessor(ctx, req) 	if err != nil { 		// TODO: Handle error. 	}  	resp, err := op.Wait(ctx) 	if err != nil { 		// TODO: Handle error. 	} 	// TODO: Use resp. 	_ = resp } 

Java

如需了解详情,请参阅 Document AI Java API 参考文档

如需向 Document AI 进行身份验证,请设置应用默认凭据。 如需了解详情,请参阅为本地开发环境设置身份验证

import com.google.cloud.documentai.v1.DocumentProcessorServiceClient; import com.google.cloud.documentai.v1.EnableProcessorRequest; import com.google.cloud.documentai.v1.EnableProcessorResponse; import com.google.cloud.documentai.v1.ProcessorName;  public class SyncEnableProcessor {    public static void main(String[] args) throws Exception {     syncEnableProcessor();   }    public static void syncEnableProcessor() throws Exception {     // 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library     try (DocumentProcessorServiceClient documentProcessorServiceClient =         DocumentProcessorServiceClient.create()) {       EnableProcessorRequest request =           EnableProcessorRequest.newBuilder()               .setName(ProcessorName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]").toString())               .build();       EnableProcessorResponse response =           documentProcessorServiceClient.enableProcessorAsync(request).get();     }   } }

Ruby

如需了解详情,请参阅 Document AI Ruby API 参考文档

如需向 Document AI 进行身份验证,请设置应用默认凭据。 如需了解详情,请参阅为本地开发环境设置身份验证

require "google/cloud/document_ai/v1"  ## # Snippet for the enable_processor call in the DocumentProcessorService service # # 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://cloud.google.com/ruby/docs/reference. # # This is an auto-generated example demonstrating basic usage of # Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#enable_processor. # def enable_processor   # Create a client object. The client can be reused for multiple calls.   client = Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client.new    # Create a request. To set request fields, pass in keyword arguments.   request = Google::Cloud::DocumentAI::V1::EnableProcessorRequest.new    # Call the enable_processor method.   result = client.enable_processor request    # The returned object is of type Gapic::Operation. You can use it to   # check the status of an operation, cancel it, or wait for results.   # Here is how to wait for a response.   result.wait_until_done! timeout: 60   if result.response?     p result.response   else     puts "No response received."   end end

C#

如需了解详情,请参阅 Document AI C# API 参考文档

如需向 Document AI 进行身份验证,请设置应用默认凭据。 如需了解详情,请参阅为本地开发环境设置身份验证

using Google.Cloud.DocumentAI.V1; using Google.LongRunning;  public sealed partial class GeneratedDocumentProcessorServiceClientSnippets {     /// <summary>Snippet for EnableProcessor</summary>     /// <remarks>     /// 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://cloud.google.com/dotnet/docs/reference/help/client-configuration#endpoint.     /// </remarks>     public void EnableProcessorRequestObject()     {         // Create client         DocumentProcessorServiceClient documentProcessorServiceClient = DocumentProcessorServiceClient.Create();         // Initialize request argument(s)         EnableProcessorRequest request = new EnableProcessorRequest         {             ProcessorName = ProcessorName.FromProjectLocationProcessor("[PROJECT]", "[LOCATION]", "[PROCESSOR]"),         };         // Make the request         Operation<EnableProcessorResponse, EnableProcessorMetadata> response = documentProcessorServiceClient.EnableProcessor(request);          // Poll until the returned long-running operation is complete         Operation<EnableProcessorResponse, EnableProcessorMetadata> completedResponse = response.PollUntilCompleted();         // Retrieve the operation result         EnableProcessorResponse result = completedResponse.Result;          // Or get the name of the operation         string operationName = response.Name;         // This name can be stored, then the long-running operation retrieved later by name         Operation<EnableProcessorResponse, EnableProcessorMetadata> retrievedResponse = documentProcessorServiceClient.PollOnceEnableProcessor(operationName);         // Check if the retrieved long-running operation has completed         if (retrievedResponse.IsCompleted)         {             // If it has completed, then access the result             EnableProcessorResponse retrievedResult = retrievedResponse.Result;         }     } }

停用处理器

网页界面

  1. 在 Google Cloud 控制台的 Document AI 部分,前往处理器页面。

    前往“处理器”页面

    1. 操作菜单 中,点击处理器旁边的停用处理器

REST

此示例展示了如何使用 processors.disable 方法停用现有的 Processor

在使用任何请求数据之前,请先进行以下替换:

  • LOCATION:处理器的位置,例如:
    • us - 美国
    • eu - 欧盟
  • PROJECT_ID:您的 Google Cloud 项目 ID。
  • PROCESSOR_ID:自定义处理器的 ID。

HTTP 方法和网址:

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"     }   } } 
  1. 如需轮询长时间运行的操作,请调用 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"
    1. 响应中的 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 进行身份验证,请设置应用默认凭据。 如需了解详情,请参阅为本地开发环境设置身份验证

 from google.api_core.client_options import ClientOptions from google.api_core.exceptions import FailedPrecondition from google.cloud import documentai  # type: ignore  # TODO(developer): Uncomment these variables before running the sample. # project_id = 'YOUR_PROJECT_ID' # location = 'YOUR_PROCESSOR_LOCATION' # Format is 'us' or 'eu' # processor_id = 'YOUR_PROCESSOR_ID'   def disable_processor_sample(project_id: str, location: str, processor_id: str) -> None:     # You must set the api_endpoint if you use a location other than 'us'.     opts = ClientOptions(api_endpoint=f"{location}-documentai.googleapis.com")      client = documentai.DocumentProcessorServiceClient(client_options=opts)      # The full resource name of the processor     # e.g.: projects/project_id/locations/location/processors/processor_id     processor_name = client.processor_path(project_id, location, processor_id)     request = documentai.DisableProcessorRequest(name=processor_name)      # Make DisableProcessor request     try:         operation = client.disable_processor(request=request)          # Print operation name         print(operation.operation.name)         # Wait for operation to complete         operation.result()     # Cannot disable a processor that is already disabled     except FailedPrecondition as e:         print(e.message)  

Go

如需了解详情,请参阅 Document AI Go API 参考文档

如需向 Document AI 进行身份验证,请设置应用默认凭据。 如需了解详情,请参阅为本地开发环境设置身份验证

 package main  import ( 	"context"  	documentai "cloud.google.com/go/documentai/apiv1" 	documentaipb "cloud.google.com/go/documentai/apiv1/documentaipb" )  func main() { 	ctx := context.Background() 	// 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://pkg.go.dev/cloud.google.com/go#hdr-Client_Options 	c, err := documentai.NewDocumentProcessorClient(ctx) 	if err != nil { 		// TODO: Handle error. 	} 	defer c.Close()  	req := &documentaipb.DisableProcessorRequest{ 		// TODO: Fill request struct fields. 		// See https://pkg.go.dev/cloud.google.com/go/documentai/apiv1/documentaipb#DisableProcessorRequest. 	} 	op, err := c.DisableProcessor(ctx, req) 	if err != nil { 		// TODO: Handle error. 	}  	resp, err := op.Wait(ctx) 	if err != nil { 		// TODO: Handle error. 	} 	// TODO: Use resp. 	_ = resp } 

Java

如需了解详情,请参阅 Document AI Java API 参考文档

如需向 Document AI 进行身份验证,请设置应用默认凭据。 如需了解详情,请参阅为本地开发环境设置身份验证

import com.google.cloud.documentai.v1.DisableProcessorRequest; import com.google.cloud.documentai.v1.DisableProcessorResponse; import com.google.cloud.documentai.v1.DocumentProcessorServiceClient; import com.google.cloud.documentai.v1.ProcessorName;  public class SyncDisableProcessor {    public static void main(String[] args) throws Exception {     syncDisableProcessor();   }    public static void syncDisableProcessor() throws Exception {     // 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library     try (DocumentProcessorServiceClient documentProcessorServiceClient =         DocumentProcessorServiceClient.create()) {       DisableProcessorRequest request =           DisableProcessorRequest.newBuilder()               .setName(ProcessorName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]").toString())               .build();       DisableProcessorResponse response =           documentProcessorServiceClient.disableProcessorAsync(request).get();     }   } }

Ruby

如需了解详情,请参阅 Document AI Ruby API 参考文档

如需向 Document AI 进行身份验证,请设置应用默认凭据。 如需了解详情,请参阅为本地开发环境设置身份验证

require "google/cloud/document_ai/v1"  ## # Snippet for the disable_processor call in the DocumentProcessorService service # # 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://cloud.google.com/ruby/docs/reference. # # This is an auto-generated example demonstrating basic usage of # Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#disable_processor. # def disable_processor   # Create a client object. The client can be reused for multiple calls.   client = Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client.new    # Create a request. To set request fields, pass in keyword arguments.   request = Google::Cloud::DocumentAI::V1::DisableProcessorRequest.new    # Call the disable_processor method.   result = client.disable_processor request    # The returned object is of type Gapic::Operation. You can use it to   # check the status of an operation, cancel it, or wait for results.   # Here is how to wait for a response.   result.wait_until_done! timeout: 60   if result.response?     p result.response   else     puts "No response received."   end end

C#

如需了解详情,请参阅 Document AI C# API 参考文档

如需向 Document AI 进行身份验证,请设置应用默认凭据。 如需了解详情,请参阅为本地开发环境设置身份验证

using Google.Cloud.DocumentAI.V1; using Google.LongRunning;  public sealed partial class GeneratedDocumentProcessorServiceClientSnippets {     /// <summary>Snippet for DisableProcessor</summary>     /// <remarks>     /// 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://cloud.google.com/dotnet/docs/reference/help/client-configuration#endpoint.     /// </remarks>     public void DisableProcessorRequestObject()     {         // Create client         DocumentProcessorServiceClient documentProcessorServiceClient = DocumentProcessorServiceClient.Create();         // Initialize request argument(s)         DisableProcessorRequest request = new DisableProcessorRequest         {             ProcessorName = ProcessorName.FromProjectLocationProcessor("[PROJECT]", "[LOCATION]", "[PROCESSOR]"),         };         // Make the request         Operation<DisableProcessorResponse, DisableProcessorMetadata> response = documentProcessorServiceClient.DisableProcessor(request);          // Poll until the returned long-running operation is complete         Operation<DisableProcessorResponse, DisableProcessorMetadata> completedResponse = response.PollUntilCompleted();         // Retrieve the operation result         DisableProcessorResponse result = completedResponse.Result;          // Or get the name of the operation         string operationName = response.Name;         // This name can be stored, then the long-running operation retrieved later by name         Operation<DisableProcessorResponse, DisableProcessorMetadata> retrievedResponse = documentProcessorServiceClient.PollOnceDisableProcessor(operationName);         // Check if the retrieved long-running operation has completed         if (retrievedResponse.IsCompleted)         {             // If it has completed, then access the result             DisableProcessorResponse retrievedResult = retrievedResponse.Result;         }     } }

删除处理器

网页界面

  1. 在 Google Cloud 控制台的 Document AI 部分,前往处理器页面。

    前往“处理器”页面

    1. 在处理器旁边的操作菜单 中,点击删除处理器

REST

此示例展示了如何使用 processors.delete 方法删除现有 Processor

在使用任何请求数据之前,请先进行以下替换:

  • LOCATION:处理器的位置,例如:
    • us - 美国
    • eu - 欧盟
  • PROJECT_ID:您的 Google Cloud 项目 ID。
  • PROCESSOR_ID:自定义处理器的 ID。

HTTP 方法和网址:

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"     }   } } 
  1. 如需轮询长时间运行的操作,请调用 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"
  2. 响应中的 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 进行身份验证,请设置应用默认凭据。 如需了解详情,请参阅为本地开发环境设置身份验证

 from google.api_core.client_options import ClientOptions from google.api_core.exceptions import NotFound from google.cloud import documentai  # type: ignore  # TODO(developer): Uncomment these variables before running the sample. # project_id = 'YOUR_PROJECT_ID' # location = 'YOUR_PROCESSOR_LOCATION' # Format is 'us' or 'eu' # processor_id = 'YOUR_PROCESSOR_ID'   def delete_processor_sample(project_id: str, location: str, processor_id: str) -> None:     # You must set the api_endpoint if you use a location other than 'us'.     opts = ClientOptions(api_endpoint=f"{location}-documentai.googleapis.com")      client = documentai.DocumentProcessorServiceClient(client_options=opts)      # The full resource name of the processor     # e.g.: projects/project_id/locations/location/processors/processor_id     processor_name = client.processor_path(project_id, location, processor_id)      # Delete a processor     try:         operation = client.delete_processor(name=processor_name)         # Print operation details         print(operation.operation.name)         # Wait for operation to complete         operation.result()     except NotFound as e:         print(e.message)  

Go

如需了解详情,请参阅 Document AI Go API 参考文档

如需向 Document AI 进行身份验证,请设置应用默认凭据。 如需了解详情,请参阅为本地开发环境设置身份验证

 package main  import ( 	"context"  	documentai "cloud.google.com/go/documentai/apiv1" 	documentaipb "cloud.google.com/go/documentai/apiv1/documentaipb" )  func main() { 	ctx := context.Background() 	// 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://pkg.go.dev/cloud.google.com/go#hdr-Client_Options 	c, err := documentai.NewDocumentProcessorClient(ctx) 	if err != nil { 		// TODO: Handle error. 	} 	defer c.Close()  	req := &documentaipb.DeleteProcessorRequest{ 		// TODO: Fill request struct fields. 		// See https://pkg.go.dev/cloud.google.com/go/documentai/apiv1/documentaipb#DeleteProcessorRequest. 	} 	op, err := c.DeleteProcessor(ctx, req) 	if err != nil { 		// TODO: Handle error. 	}  	err = op.Wait(ctx) 	if err != nil { 		// TODO: Handle error. 	} } 

Java

如需了解详情,请参阅 Document AI Java API 参考文档

如需向 Document AI 进行身份验证,请设置应用默认凭据。 如需了解详情,请参阅为本地开发环境设置身份验证

import com.google.cloud.documentai.v1.DeleteProcessorRequest; import com.google.cloud.documentai.v1.DocumentProcessorServiceClient; import com.google.cloud.documentai.v1.ProcessorName; import com.google.protobuf.Empty;  public class SyncDeleteProcessor {    public static void main(String[] args) throws Exception {     syncDeleteProcessor();   }    public static void syncDeleteProcessor() throws Exception {     // 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library     try (DocumentProcessorServiceClient documentProcessorServiceClient =         DocumentProcessorServiceClient.create()) {       DeleteProcessorRequest request =           DeleteProcessorRequest.newBuilder()               .setName(ProcessorName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]").toString())               .build();       documentProcessorServiceClient.deleteProcessorAsync(request).get();     }   } }

Ruby

如需了解详情,请参阅 Document AI Ruby API 参考文档

如需向 Document AI 进行身份验证,请设置应用默认凭据。 如需了解详情,请参阅为本地开发环境设置身份验证

require "google/cloud/document_ai/v1"  ## # Snippet for the delete_processor call in the DocumentProcessorService service # # 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://cloud.google.com/ruby/docs/reference. # # This is an auto-generated example demonstrating basic usage of # Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#delete_processor. # def delete_processor   # Create a client object. The client can be reused for multiple calls.   client = Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client.new    # Create a request. To set request fields, pass in keyword arguments.   request = Google::Cloud::DocumentAI::V1::DeleteProcessorRequest.new    # Call the delete_processor method.   result = client.delete_processor request    # The returned object is of type Gapic::Operation. You can use it to   # check the status of an operation, cancel it, or wait for results.   # Here is how to wait for a response.   result.wait_until_done! timeout: 60   if result.response?     p result.response   else     puts "No response received."   end end

C#

如需了解详情,请参阅 Document AI C# API 参考文档

如需向 Document AI 进行身份验证,请设置应用默认凭据。 如需了解详情,请参阅为本地开发环境设置身份验证

using Google.Cloud.DocumentAI.V1; using Google.LongRunning; using Google.Protobuf.WellKnownTypes;  public sealed partial class GeneratedDocumentProcessorServiceClientSnippets {     /// <summary>Snippet for DeleteProcessor</summary>     /// <remarks>     /// 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://cloud.google.com/dotnet/docs/reference/help/client-configuration#endpoint.     /// </remarks>     public void DeleteProcessorRequestObject()     {         // Create client         DocumentProcessorServiceClient documentProcessorServiceClient = DocumentProcessorServiceClient.Create();         // Initialize request argument(s)         DeleteProcessorRequest request = new DeleteProcessorRequest         {             ProcessorName = ProcessorName.FromProjectLocationProcessor("[PROJECT]", "[LOCATION]", "[PROCESSOR]"),         };         // Make the request         Operation<Empty, DeleteProcessorMetadata> response = documentProcessorServiceClient.DeleteProcessor(request);          // Poll until the returned long-running operation is complete         Operation<Empty, DeleteProcessorMetadata> completedResponse = response.PollUntilCompleted();         // Retrieve the operation result         Empty result = completedResponse.Result;          // Or get the name of the operation         string operationName = response.Name;         // This name can be stored, then the long-running operation retrieved later by name         Operation<Empty, DeleteProcessorMetadata> retrievedResponse = documentProcessorServiceClient.PollOnceDeleteProcessor(operationName);         // Check if the retrieved long-running operation has completed         if (retrievedResponse.IsCompleted)         {             // If it has completed, then access the result             Empty retrievedResult = retrievedResponse.Result;         }     } }