Enable a processor
Stay organized with collections
Save and categorize content based on your preferences.
Enables a processor
Explore further
For detailed documentation that includes this code sample, see the following:
Code sample
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],[],[[["\u003cp\u003eThis content provides instructions and a code sample for enabling a Document AI processor using the Python API.\u003c/p\u003e\n"],["\u003cp\u003eThe code requires setting up Application Default Credentials for authentication and specifies how to use different processor locations.\u003c/p\u003e\n"],["\u003cp\u003eA sample Python code snippet demonstrates how to enable a processor using the \u003ccode\u003eenable_processor_sample\u003c/code\u003e function, which includes handling potential \u003ccode\u003eFailedPrecondition\u003c/code\u003e exceptions.\u003c/p\u003e\n"],["\u003cp\u003eFurther resources are linked, including the Document AI Python API reference documentation, creating and managing processors documentation, and the Google Cloud sample browser.\u003c/p\u003e\n"]]],[],null,["# Enable a processor\n\nEnables a processor\n\nExplore further\n---------------\n\n\nFor detailed documentation that includes this code sample, see the following:\n\n- [Creating and managing processors](/document-ai/docs/create-processor)\n\nCode sample\n-----------\n\n### Python\n\n\nFor more information, see the\n[Document AI Python API\nreference documentation](/python/docs/reference/documentai/latest).\n\n\nTo authenticate to Document AI, set up Application Default Credentials.\nFor more information, see\n\n[Set up authentication for a local development environment](/docs/authentication/set-up-adc-local-dev-environment).\n\n\n from google.api_core.client_options import ClientOptions\n from google.api_core.exceptions import FailedPrecondition\n from google.cloud import documentai # type: ignore\n\n # TODO(developer): Uncomment these variables before running the sample.\n # project_id = 'YOUR_PROJECT_ID'\n # location = 'YOUR_PROCESSOR_LOCATION' # Format is 'us' or 'eu'\n # processor_id = 'YOUR_PROCESSOR_ID'\n\n\n def enable_processor_sample(project_id: str, location: str, processor_id: str) -\u003e None:\n # You must set the api_endpoint if you use a location other than 'us'.\n opts = ClientOptions(api_endpoint=f\"{location}-documentai.googleapis.com\")\n\n client = documentai.https://cloud.google.com/python/docs/reference/documentai/latest/google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceClient.html(client_options=opts)\n\n # The full resource name of the location\n # e.g.: projects/project_id/locations/location/processors/processor_id\n processor_name = client.https://cloud.google.com/python/docs/reference/documentai/latest/google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceClient.html#google_cloud_documentai_v1_services_document_processor_service_DocumentProcessorServiceClient_processor_path(project_id, location, processor_id)\n request = documentai.https://cloud.google.com/python/docs/reference/documentai/latest/google.cloud.documentai_v1.types.EnableProcessorRequest.html(name=processor_name)\n\n # Make EnableProcessor request\n try:\n operation = client.https://cloud.google.com/python/docs/reference/documentai/latest/google.cloud.documentai_v1.services.document_processor_service.DocumentProcessorServiceClient.html#google_cloud_documentai_v1_services_document_processor_service_DocumentProcessorServiceClient_enable_processor(request=request)\n\n # Print operation name\n print(operation.operation.name)\n # Wait for operation to complete\n operation.result()\n # Cannot enable a processor that is already enabled\n except FailedPrecondition as e:\n print(e.message)\n\nWhat's next\n-----------\n\n\nTo search and filter code samples for other Google Cloud products, see the\n[Google Cloud sample browser](/docs/samples?product=documentai)."]]