Resource: ProcessorVersion
A processor version is an implementation of a processor. Each processor can have multiple versions, pretrained by Google internally or uptrained by the customer. A processor can only have one default version at a time. Its document-processing behavior is defined by that version.
JSON representation |
---|
{ "name": string, "displayName": string, "documentSchema": { object ( |
Fields | |
---|---|
name |
The resource name of the processor version. Format: |
displayName |
The display name of the processor version. |
documentSchema |
The schema of the processor version. Describes the output. |
state |
The state of the processor version. |
createTime |
The time the processor version was created. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
latestEvaluation |
The most recently invoked evaluation for the processor version. |
kmsKeyName |
The KMS key name used for encryption. |
kmsKeyVersionName |
The KMS key version with which data is encrypted. |
googleManaged |
Output only. Denotes that this |
deprecationInfo |
If set, information about the eventual deprecation of this version. |
DocumentSchema
The schema defines the output of the processed document by a processor.
JSON representation |
---|
{ "displayName": string, "description": string, "entityTypes": [ { object ( |
Fields | |
---|---|
displayName |
Display name to show to users. |
description |
Description of the schema. |
entityTypes[] |
Entity types of the schema. |
metadata |
Metadata of the schema. |
EntityType
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.
JSON representation |
---|
{ "displayName": string, "name": string, "baseTypes": [ string ], "properties": [ { object ( |
Fields | |
---|---|
displayName |
User defined name for the type. |
name |
Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used:
|
baseTypes[] |
The entity type that this type is derived from. For now, one and only one should be set. |
properties[] |
Description the nested structure, or composition of an entity. |
entityTypeMetadata |
Metadata for the entity type. |
Union field
|
|
enumValues |
If specified, lists all the possible values for this entity. This should not be more than a handful of values. If the number of values is >10 or could change frequently use the |
EnumValues
Defines the a list of enum values.
JSON representation |
---|
{ "values": [ string ] } |
Fields | |
---|---|
values[] |
The individual values that this enum values type can include. |
Property
Defines properties that can be part of the entity type.
JSON representation |
---|
{ "name": string, "valueType": string, "occurrenceType": enum ( |
Fields | |
---|---|
name |
The name of the property. Follows the same guidelines as the EntityType name. |
valueType |
A reference to the value type of the property. This type is subject to the same conventions as the |
occurrenceType |
Occurrence type limits the number of instances an entity type appears in the document. |
propertyMetadata |
Any additional metadata about the property can be added here. |
OccurrenceType
Types of occurrences of the entity type in the document. This represents the number of instances of instances of an entity, not number of mentions of an entity. For example, a bank statement may only have one account_number
, but this account number may be mentioned in several places on the document. In this case the 'account_number' would be considered a REQUIRED_ONCE
entity type. If, on the other hand, we expect a bank statement to contain the status of multiple different accounts for the customers, the occurrence type will be set to REQUIRED_MULTIPLE
.
Enums | |
---|---|
OCCURRENCE_TYPE_UNSPECIFIED |
Unspecified occurrence type. |
OPTIONAL_ONCE |
There will be zero or one instance of this entity type. The same entity instance may be mentioned multiple times. |
OPTIONAL_MULTIPLE |
The entity type will appear zero or multiple times. |
REQUIRED_ONCE |
The entity type will only appear exactly once. The same entity instance may be mentioned multiple times. |
REQUIRED_MULTIPLE |
The entity type will appear once or more times. |
PropertyMetadata
Metadata about a property.
JSON representation |
---|
{
"inactive": boolean,
"fieldExtractionMetadata": {
object ( |
Fields | |
---|---|
inactive |
Whether the property should be considered as "inactive". |
fieldExtractionMetadata |
Field extraction metadata on the property. |
FieldExtractionMetadata
Metadata for how this field value is extracted.
JSON representation |
---|
{
"summaryOptions": {
object ( |
Fields | |
---|---|
summaryOptions |
Summary options config. |
SummaryOptions
Metadata for document summarization.
JSON representation |
---|
{ "length": enum ( |
Fields | |
---|---|
length |
How long the summary should be. |
format |
The format the summary should be in. |
Length
The Length enum.
Enums | |
---|---|
LENGTH_UNSPECIFIED |
Default. |
BRIEF |
A brief summary of one or two sentences. |
MODERATE |
A paragraph-length summary. |
COMPREHENSIVE |
The longest option available. |
Format
The Format enum.
Enums | |
---|---|
FORMAT_UNSPECIFIED |
Default. |
PARAGRAPH |
Format the output in paragraphs. |
BULLETS |
Format the output in bullets. |
EntityTypeMetadata
Metadata about an entity type.
JSON representation |
---|
{ "inactive": boolean } |
Fields | |
---|---|
inactive |
Whether the entity type should be considered inactive. |
Metadata
Metadata for global schema behavior.
JSON representation |
---|
{ "documentSplitter": boolean, "documentAllowMultipleLabels": boolean, "prefixedNamingOnProperties": boolean, "skipNamingValidation": boolean } |
Fields | |
---|---|
documentSplitter |
If true, a |
documentAllowMultipleLabels |
If true, on a given page, there can be multiple |
prefixedNamingOnProperties |
If set, all the nested entities must be prefixed with the parents. |
skipNamingValidation |
If set, we will skip the naming format validation in the schema. So the string values in |
State
The possible states of the processor version.
Enums | |
---|---|
STATE_UNSPECIFIED |
The processor version is in an unspecified state. |
DEPLOYED |
The processor version is deployed and can be used for processing. |
DEPLOYING |
The processor version is being deployed. |
UNDEPLOYED |
The processor version is not deployed and cannot be used for processing. |
UNDEPLOYING |
The processor version is being undeployed. |
CREATING |
The processor version is being created. |
DELETING |
The processor version is being deleted. |
FAILED |
The processor version failed and is in an indeterminate state. |
IMPORTING |
The processor version is being imported. |
EvaluationReference
Gives a short summary of an evaluation, and links to the evaluation itself.
JSON representation |
---|
{ "operation": string, "evaluation": string, "aggregateMetrics": { object ( |
Fields | |
---|---|
operation |
The resource name of the Long Running Operation for the evaluation. |
evaluation |
The resource name of the evaluation. |
aggregateMetrics |
An aggregate of the statistics for the evaluation with fuzzy matching on. |
aggregateMetricsExact |
An aggregate of the statistics for the evaluation with fuzzy matching off. |
DeprecationInfo
Information about the upcoming deprecation of this processor version.
JSON representation |
---|
{ "deprecationTime": string, "replacementProcessorVersion": string } |
Fields | |
---|---|
deprecationTime |
The time at which this processor version will be deprecated. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
replacementProcessorVersion |
If set, the processor version that will be used as a replacement. |
Methods |
|
---|---|
|
LRO endpoint to batch process many documents. |
|
Deletes the processor version, all artifacts under the processor version will be deleted. |
|
Deploys the processor version. |
|
Evaluates a ProcessorVersion against annotated documents, producing an Evaluation. |
|
Gets a processor version detail. |
|
Imports a processor version from source processor version. |
|
Lists all versions of a processor. |
|
Processes a single document. |
|
Trains a new processor version. |
|
Undeploys the processor version. |