list(parent, pageSize=None, pageToken=None, x__xgafv=None)

Lists the processor types that exist.

Args:
  parent: string, Required. The location of processor type to list. The available processor types may depend on the allow-listing on projects. Format: `projects/{project}/locations/{location}` (required)
  pageSize: integer, The maximum number of processor types to return. If unspecified, at most 100 processor types will be returned. The maximum value is 500; values above 500 will be coerced to 500.
  pageToken: string, Used to retrieve the next page of results, empty if at the end of the list.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for list processor types.
  "nextPageToken": "A String", # Points to the next page, otherwise empty.
  "processorTypes": [ # The processor types.
    { # A processor type is responsible for performing a certain document understanding task on a certain type of document.
      "allowCreation": True or False, # Whether the processor type allows creation. If true, users can create a processor of this processor type. Otherwise, users need to request access.
      "availableLocations": [ # The locations in which this processor is available.
        { # The location information about where the processor is available.
          "locationId": "A String", # The location id, currently must be one of [us, eu].
        },
      ],
      "category": "A String", # The processor category, used by UI to group processor types.
      "launchStage": "A String", # Launch stage of the processor type
      "name": "A String", # The resource name of the processor type. Format: projects/{project}/processorTypes/{processor_type}
      "type": "A String", # The type of the processor, e.g., "invoice_parsing".
    },
  ],
}

list_next()

Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.

Cloud Document AI API . projects . locations . processorTypes

Instance Methods

Method Details