You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/dyn/documentai_v1.projects.locations.processors.processorVersions.html
-68Lines changed: 0 additions & 68 deletions
Original file line number
Diff line number
Diff line change
@@ -260,41 +260,7 @@ <h3>Method Details</h3>
260
260
{ # A processor version is an implementation of a processor. Each processor can have multiple versions, pre-trained by Google internally or up-trained by the customer. At a time, a processor can only have one default version version. So the processor's behavior (when processing documents) is defined by a default version.
261
261
"createTime": "A String", # The time the processor version was created.
262
262
"displayName": "A String", # The display name of the processor version.
263
-
"latestEvaluation": { # Gives a short summary of an evaluation, and links to the evaluation itself. # The most recently invoked evaluation for the processor version.
264
-
"aggregateMetrics": { # Evaluation metrics, either in aggregate or about a specific entity. # An aggregate of the statistics for the evaluation.
265
-
"f1Score": 3.14, # The calculated f1 score.
266
-
"falseNegativesCount": 42, # The amount of false negatives.
267
-
"falsePositivesCount": 42, # The amount of false positives.
268
-
"groundTruthOccurrencesCount": 42, # The amount of occurrences in ground truth documents.
269
-
"precision": 3.14, # The calculated precision.
270
-
"predictedOccurrencesCount": 42, # The amount of occurrences in predicted documents.
271
-
"recall": 3.14, # The calculated recall.
272
-
"totalDocumentsCount": 42, # The amount of documents that had an occurrence of this label.
273
-
"truePositivesCount": 42, # The amount of true positives.
274
-
},
275
-
"evaluation": "A String", # The resource name of the evaluation.
276
-
"operation": "A String", # The resource name of the Long Running Operation for the evaluation.
277
-
},
278
263
"name": "A String", # The resource name of the processor version. Format: projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}
279
-
"schema": { # The schema defines the output of the processed document by a processor. # The schema of the processor version. Describes the output.
280
-
"description": "A String", # Description of the schema.
281
-
"displayName": "A String", # Display name to show to users.
282
-
"entityTypes": [ # Entity types of the schema.
283
-
{ # 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.
284
-
"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. `duration` - the entity is a duration.
285
-
"description": "A String", # Description of the entity type.
286
-
"enumValues": [ # If specified, lists all the possible values for this entity.
287
-
"A String",
288
-
],
289
-
"occurrenceType": "A String", # Occurrence type limits the number of times an entity type appears in the document.
290
-
"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.
291
-
# Object with schema name: GoogleCloudDocumentaiV1SchemaEntityType
292
-
],
293
-
"source": "A String", # Source of this entity type.
294
-
"type": "A String", # Name of the type. It must satisfy the following constraints: 1. Must be unique within the set of same level types (with case-insensitive match). 2. Maximum 50 characters. 3. Must start with a letter. 4. Allowed characters: ASCII letters [a-zA-Z], ASCII digits [0-9], or one of the following punctuation characters: * underscore '_' (recommended) * hyphen '-' (allowed, not recommended) * colon ':' (allowed, not recommended) NOTE: Whitespace characters are not allowed. 5. Cannot end with a punctuation character. 6. Cannot contain the following restricted strings: "google", "DocumentAI" (case-insensitive match). 7. A slash character '/' is reserved as a separator in flattened representations of nested entity types (e.g., "line_item/amount") in which case each part (e.g., "line_item", "amount") must comply with the rules defined above. We recommend using the snake case ("snake_case") in entity type names.
295
-
},
296
-
],
297
-
},
298
264
"state": "A String", # The state of the processor version.
299
265
}</pre>
300
266
</div>
@@ -321,41 +287,7 @@ <h3>Method Details</h3>
321
287
{ # A processor version is an implementation of a processor. Each processor can have multiple versions, pre-trained by Google internally or up-trained by the customer. At a time, a processor can only have one default version version. So the processor's behavior (when processing documents) is defined by a default version.
322
288
"createTime": "A String", # The time the processor version was created.
323
289
"displayName": "A String", # The display name of the processor version.
324
-
"latestEvaluation": { # Gives a short summary of an evaluation, and links to the evaluation itself. # The most recently invoked evaluation for the processor version.
325
-
"aggregateMetrics": { # Evaluation metrics, either in aggregate or about a specific entity. # An aggregate of the statistics for the evaluation.
326
-
"f1Score": 3.14, # The calculated f1 score.
327
-
"falseNegativesCount": 42, # The amount of false negatives.
328
-
"falsePositivesCount": 42, # The amount of false positives.
329
-
"groundTruthOccurrencesCount": 42, # The amount of occurrences in ground truth documents.
330
-
"precision": 3.14, # The calculated precision.
331
-
"predictedOccurrencesCount": 42, # The amount of occurrences in predicted documents.
332
-
"recall": 3.14, # The calculated recall.
333
-
"totalDocumentsCount": 42, # The amount of documents that had an occurrence of this label.
334
-
"truePositivesCount": 42, # The amount of true positives.
335
-
},
336
-
"evaluation": "A String", # The resource name of the evaluation.
337
-
"operation": "A String", # The resource name of the Long Running Operation for the evaluation.
338
-
},
339
290
"name": "A String", # The resource name of the processor version. Format: projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}
340
-
"schema": { # The schema defines the output of the processed document by a processor. # The schema of the processor version. Describes the output.
341
-
"description": "A String", # Description of the schema.
342
-
"displayName": "A String", # Display name to show to users.
343
-
"entityTypes": [ # Entity types of the schema.
344
-
{ # 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.
345
-
"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. `duration` - the entity is a duration.
346
-
"description": "A String", # Description of the entity type.
347
-
"enumValues": [ # If specified, lists all the possible values for this entity.
348
-
"A String",
349
-
],
350
-
"occurrenceType": "A String", # Occurrence type limits the number of times an entity type appears in the document.
351
-
"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.
352
-
# Object with schema name: GoogleCloudDocumentaiV1SchemaEntityType
353
-
],
354
-
"source": "A String", # Source of this entity type.
355
-
"type": "A String", # Name of the type. It must satisfy the following constraints: 1. Must be unique within the set of same level types (with case-insensitive match). 2. Maximum 50 characters. 3. Must start with a letter. 4. Allowed characters: ASCII letters [a-zA-Z], ASCII digits [0-9], or one of the following punctuation characters: * underscore '_' (recommended) * hyphen '-' (allowed, not recommended) * colon ':' (allowed, not recommended) NOTE: Whitespace characters are not allowed. 5. Cannot end with a punctuation character. 6. Cannot contain the following restricted strings: "google", "DocumentAI" (case-insensitive match). 7. A slash character '/' is reserved as a separator in flattened representations of nested entity types (e.g., "line_item/amount") in which case each part (e.g., "line_item", "amount") must comply with the rules defined above. We recommend using the snake case ("snake_case") in entity type names.
356
-
},
357
-
],
358
-
},
359
291
"state": "A String", # The state of the processor version.
0 commit comments