| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, h1, h2, h3, div, span, p, pre, a { |
| 5 | margin: 0; |
| 6 | padding: 0; |
| 7 | border: 0; |
| 8 | font-weight: inherit; |
| 9 | font-style: inherit; |
| 10 | font-size: 100%; |
| 11 | font-family: inherit; |
| 12 | vertical-align: baseline; |
| 13 | } |
| 14 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, h2, h3 { |
| 50 | border-bottom: solid #CCC 1px; |
| 51 | } |
| 52 | |
| 53 | .toc_element { |
| 54 | margin-top: 0.5em; |
| 55 | } |
| 56 | |
| 57 | .firstline { |
| 58 | margin-left: 2 em; |
| 59 | } |
| 60 | |
| 61 | .method { |
| 62 | margin-top: 1em; |
| 63 | border: solid 1px #CCC; |
| 64 | padding: 1em; |
| 65 | background: #EEE; |
| 66 | } |
| 67 | |
| 68 | .details { |
| 69 | font-weight: bold; |
| 70 | font-size: 14px; |
| 71 | } |
| 72 | |
| 73 | </style> |
| 74 | |
| 75 | <h1><a href="documentai_v1beta3.html">Cloud Document AI API</a> . <a href="documentai_v1beta3.projects.html">projects</a> . <a href="documentai_v1beta3.projects.locations.html">locations</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| 78 | <code><a href="documentai_v1beta3.projects.locations.operations.html">operations()</a></code> |
| 79 | </p> |
| 80 | <p class="firstline">Returns the operations Resource.</p> |
| 81 | |
| 82 | <p class="toc_element"> |
| 83 | <code><a href="documentai_v1beta3.projects.locations.processors.html">processors()</a></code> |
| 84 | </p> |
| 85 | <p class="firstline">Returns the processors Resource.</p> |
| 86 | |
| 87 | <p class="toc_element"> |
| 88 | <code><a href="#close">close()</a></code></p> |
| 89 | <p class="firstline">Close httplib2 connections.</p> |
| 90 | <p class="toc_element"> |
| yoshi-code-bot | 3fd11cb | 2021-04-28 05:44:03 -0700 | [diff] [blame] | 91 | <code><a href="#fetchProcessorTypes">fetchProcessorTypes(parent, x__xgafv=None)</a></code></p> |
| 92 | <p class="firstline">Fetches processor types.</p> |
| 93 | <p class="toc_element"> |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 94 | <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| 95 | <p class="firstline">Gets information about a location.</p> |
| 96 | <p class="toc_element"> |
| 97 | <code><a href="#list">list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> |
| 98 | <p class="firstline">Lists information about the supported locations for this service.</p> |
| 99 | <p class="toc_element"> |
| 100 | <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| 101 | <p class="firstline">Retrieves the next page of results.</p> |
| 102 | <h3>Method Details</h3> |
| 103 | <div class="method"> |
| 104 | <code class="details" id="close">close()</code> |
| 105 | <pre>Close httplib2 connections.</pre> |
| 106 | </div> |
| 107 | |
| 108 | <div class="method"> |
| yoshi-code-bot | 3fd11cb | 2021-04-28 05:44:03 -0700 | [diff] [blame] | 109 | <code class="details" id="fetchProcessorTypes">fetchProcessorTypes(parent, x__xgafv=None)</code> |
| 110 | <pre>Fetches processor types. |
| 111 | |
| 112 | Args: |
| 113 | parent: string, Required. The project of processor type to list. The available processor types may depend on the whitelisting on projects. Format: projects/{project}/locations/{location} (required) |
| 114 | x__xgafv: string, V1 error format. |
| 115 | Allowed values |
| 116 | 1 - v1 error format |
| 117 | 2 - v2 error format |
| 118 | |
| 119 | Returns: |
| 120 | An object of the form: |
| 121 | |
| 122 | { # Response message for fetch processor types. |
| 123 | "processorTypes": [ # The list of processor types. |
| yoshi-code-bot | 3e4b5db | 2021-08-10 00:22:29 -0700 | [diff] [blame] | 124 | { # A processor type is responsible for performing a certain document understanding task on a certain type of document. All processor types are created by the documentai service internally. User will only list all available processor types via UI. For different users (projects), the available processor types may be different since we'll expose the access of some types via EAP whitelisting. We make the ProcessorType a resource under location so we have a unified API and keep the possibility that UI will load different available processor types from different regions. But for alpha the behavior is that the user will always get the union of all available processor types among all regions no matter which regionalized endpoint is called, and then we use the 'available_locations' field to show under which regions a processor type is available. For example, users can call either the 'US' or 'EU' endpoint to feach processor types. In the return, we will have an 'invoice parsing' processor with 'available_locations' field only containing 'US'. So the user can try to create an 'invoice parsing' processor under the location 'US'. Such attempt of creating under the location 'EU' will fail. Next ID: 8. |
| yoshi-code-bot | 3fd11cb | 2021-04-28 05:44:03 -0700 | [diff] [blame] | 125 | "allowCreation": True or False, # Whether the processor type allows creation. If yes, user can create a processor of this processor type. Otherwise, user needs to require for whitelisting. |
| 126 | "availableLocations": [ # The locations in which this processor is available. |
| 127 | { # The location information about where the processor is available. |
| 128 | "locationId": "A String", # The location id, currently must be one of [us, eu]. |
| 129 | }, |
| 130 | ], |
| 131 | "category": "A String", # The processor category, used by UI to group processor types. |
| 132 | "name": "A String", # The resource name of the processor type. Format: projects/{project}/processorTypes/{processor_type} |
| yoshi-code-bot | 3fd11cb | 2021-04-28 05:44:03 -0700 | [diff] [blame] | 133 | "type": "A String", # The type of the processor, e.g, "invoice_parsing". |
| 134 | }, |
| 135 | ], |
| 136 | }</pre> |
| 137 | </div> |
| 138 | |
| 139 | <div class="method"> |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 140 | <code class="details" id="get">get(name, x__xgafv=None)</code> |
| 141 | <pre>Gets information about a location. |
| 142 | |
| 143 | Args: |
| 144 | name: string, Resource name for the location. (required) |
| 145 | x__xgafv: string, V1 error format. |
| 146 | Allowed values |
| 147 | 1 - v1 error format |
| 148 | 2 - v2 error format |
| 149 | |
| 150 | Returns: |
| 151 | An object of the form: |
| 152 | |
| 153 | { # A resource that represents Google Cloud Platform location. |
| 154 | "displayName": "A String", # The friendly name for this location, typically a nearby city name. For example, "Tokyo". |
| 155 | "labels": { # Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} |
| 156 | "a_key": "A String", |
| 157 | }, |
| 158 | "locationId": "A String", # The canonical id for this location. For example: `"us-east1"`. |
| 159 | "metadata": { # Service-specific metadata. For example the available capacity at the given location. |
| 160 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 161 | }, |
| 162 | "name": "A String", # Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` |
| 163 | }</pre> |
| 164 | </div> |
| 165 | |
| 166 | <div class="method"> |
| 167 | <code class="details" id="list">list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code> |
| 168 | <pre>Lists information about the supported locations for this service. |
| 169 | |
| 170 | Args: |
| 171 | name: string, The resource that owns the locations collection, if applicable. (required) |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 172 | filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in [AIP-160](https://google.aip.dev/160). |
| yoshi-code-bot | 3dd1527 | 2021-04-21 15:07:48 -0700 | [diff] [blame] | 173 | pageSize: integer, The maximum number of results to return. If not set, the service selects a default. |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 174 | pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 175 | x__xgafv: string, V1 error format. |
| 176 | Allowed values |
| 177 | 1 - v1 error format |
| 178 | 2 - v2 error format |
| 179 | |
| 180 | Returns: |
| 181 | An object of the form: |
| 182 | |
| 183 | { # The response message for Locations.ListLocations. |
| 184 | "locations": [ # A list of locations that matches the specified filter in the request. |
| 185 | { # A resource that represents Google Cloud Platform location. |
| 186 | "displayName": "A String", # The friendly name for this location, typically a nearby city name. For example, "Tokyo". |
| 187 | "labels": { # Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} |
| 188 | "a_key": "A String", |
| 189 | }, |
| 190 | "locationId": "A String", # The canonical id for this location. For example: `"us-east1"`. |
| 191 | "metadata": { # Service-specific metadata. For example the available capacity at the given location. |
| 192 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 193 | }, |
| 194 | "name": "A String", # Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` |
| 195 | }, |
| 196 | ], |
| 197 | "nextPageToken": "A String", # The standard List next-page token. |
| 198 | }</pre> |
| 199 | </div> |
| 200 | |
| 201 | <div class="method"> |
| 202 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 203 | <pre>Retrieves the next page of results. |
| 204 | |
| 205 | Args: |
| 206 | previous_request: The request for the previous page. (required) |
| 207 | previous_response: The response from the request for the previous page. (required) |
| 208 | |
| 209 | Returns: |
| 210 | A request object that you can call 'execute()' on to request the next |
| 211 | page. Returns None if there are no more items in the collection. |
| 212 | </pre> |
| 213 | </div> |
| 214 | |
| 215 | </body></html> |