Blame - docs/dyn/documentai_v1beta3.projects.locations.html - platform/external/python/google-api-python-client

<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

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

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

88

<code><a href="#close">close()</a></code></p>

89

<p class="firstline">Close httplib2 connections.</p>

90

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

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

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

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

104

<code class="details" id="close">close()</code>

105

<pre>Close httplib2 connections.</pre>

</div>

yoshi-code-bot

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.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

121

122

{ # Response message for fetch processor types.

123

"processorTypes": [ # The list of processor types.

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: 7.

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}

133

"schema": { # The schema defines the output of the processed document by a processor. # The schema of the default version of this processor type.

134

"description": "A String", # Description of the schema.

135

"displayName": "A String", # Display name to show to users.

136

"entityTypes": [ # Entity types of the schema.

137

{ # EntityType is the wrapper of a label of the corresponding model with detailed attributes and limitations for entity-based processors. Multiple types can also compose a dependency tree to represent nested types.

138

"baseType": "A String", # Type of the entity. It must be one of the following: `document` - the entity represents a classification of a logical document. `object` - if the entity has properties it is likely an object (or or a document.) `datetime` - the entity is a date or time value. `money` - the entity represents a money value amount. `number` - the entity is a number - integer or floating point. `string` - the entity is a string value. `boolean` - the entity is a boolean value. `address` - the entity is a location address.

139

"description": "A String", # Description of the entity type.

140

"enumValues": [ # For some entity types there are only a few possible values. They can be specified here.

141

"A String",

142

],

143

"occurrenceType": "A String", # Occurrence type limits the number of times an entity type appears in the document.

144

"properties": [ # Describing the nested structure of an entity. An EntityType may consist of several other EntityTypes. For example, in a document there can be an EntityType 'ID', which consists of EntityType 'name' and 'address', with corresponding attributes, such as TEXT for both types and ONCE for occurrence types.

145

# Object with schema name: GoogleCloudDocumentaiV1beta3SchemaEntityType

146

],

147

"source": "A String", # Source of this entity type.

148

"type": "A String", # Name of the type. It must be unique within the set of same level types.

},

],

},

"type": "A String", # The type of the processor, e.g, "invoice_parsing".

},

],

}</pre>

</div>

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

159

<code class="details" id="get">get(name, x__xgafv=None)</code>

160

<pre>Gets information about a location.

161

162

Args:

163

name: string, Resource name for the location. (required)

164

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

171

172

{ # A resource that represents Google Cloud Platform location.

173

"displayName": "A String", # The friendly name for this location, typically a nearby city name. For example, "Tokyo".

174

"labels": { # Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"}

175

"a_key": "A String",

176

},

177

"locationId": "A String", # The canonical id for this location. For example: `"us-east1"`.

178

"metadata": { # Service-specific metadata. For example the available capacity at the given location.

179

"a_key": "", # Properties of the object. Contains field @type with type URL.

180

},

181

"name": "A String", # Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"`

}</pre>

</div>

<code class="details" id="list">list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>

187

<pre>Lists information about the supported locations for this service.

188

189

Args:

190

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]

191

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]

192

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]

193

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]

194

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

201

202

{ # The response message for Locations.ListLocations.

203

"locations": [ # A list of locations that matches the specified filter in the request.

204

{ # A resource that represents Google Cloud Platform location.

205

"displayName": "A String", # The friendly name for this location, typically a nearby city name. For example, "Tokyo".

206

"labels": { # Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"}

207

"a_key": "A String",

208

},

209

"locationId": "A String", # The canonical id for this location. For example: `"us-east1"`.

210

"metadata": { # Service-specific metadata. For example the available capacity at the given location.

211

"a_key": "", # Properties of the object. Contains field @type with type URL.

212

},

213

"name": "A String", # Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"`

214

},

215

],

216

"nextPageToken": "A String", # The standard List next-page token.

}</pre>

</div>