googleapis
Version:
Google APIs Client Library for Node.js
1,240 lines • 435 kB
TypeScript
import { OAuth2Client, JWT, Compute, UserRefreshClient, BaseExternalAccountClient, GaxiosResponseWithHTTP2, GoogleConfigurable, MethodOptions, StreamMethodOptions, GlobalOptions, GoogleAuth, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
import { Readable } from 'stream';
export declare namespace documentai_v1beta3 {
export interface Options extends GlobalOptions {
version: 'v1beta3';
}
interface StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient | BaseExternalAccountClient | GoogleAuth;
/**
* V1 error format.
*/
'$.xgafv'?: string;
/**
* OAuth access token.
*/
access_token?: string;
/**
* Data format for response.
*/
alt?: string;
/**
* JSONP
*/
callback?: string;
/**
* Selector specifying which fields to include in a partial response.
*/
fields?: string;
/**
* API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
*/
key?: string;
/**
* OAuth 2.0 token for the current user.
*/
oauth_token?: string;
/**
* Returns response with indentations and line breaks.
*/
prettyPrint?: boolean;
/**
* Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
*/
quotaUser?: string;
/**
* Legacy upload protocol for media (e.g. "media", "multipart").
*/
uploadType?: string;
/**
* Upload protocol for media (e.g. "raw", "multipart").
*/
upload_protocol?: string;
}
/**
* Cloud Document AI API
*
* Service to parse structured information from unstructured or semi-structured documents using state-of-the-art Google AI such as natural language, computer vision, translation, and AutoML.
*
* @example
* ```js
* const {google} = require('googleapis');
* const documentai = google.documentai('v1beta3');
* ```
*/
export class Documentai {
context: APIRequestContext;
projects: Resource$Projects;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* Definition of the validation rules. Those are the input to the validator logic and they are used to validate a document. Next ID: 3
*/
export interface Schema$CloudAiDocumentaiLabHifiaToolsValidationValidatorInput {
validationRules?: Schema$CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRule[];
}
/**
* Next ID: 9
*/
export interface Schema$CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRule {
childAlignmentRule?: Schema$CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleChildAlignmentRule;
/**
* Description of the validation rule. This has no use but for documentation
*/
description?: string | null;
entityAlignmentRule?: Schema$CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleEntityAlignmentRule;
fieldOccurrences?: Schema$CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleFieldOccurrences;
fieldRegex?: Schema$CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleFieldRegex;
formValidation?: Schema$CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleFormValidation;
/**
* Name of the validation rule.
*/
name?: string | null;
/**
* Unique identifier of the rule. Optional.
*/
ruleId?: string | null;
}
/**
* A rule for checking field alignment. Horizontal alignment checks if fields are on the same row by comparing y-coordinates of bounding box centers, while vertical alignment checks if fields are on the same column by comparing x-coordinates of bounding box centers.
*/
export interface Schema$CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleAlignmentRule {
alignmentType?: string | null;
/**
* The tolerance to use when comparing coordinates.
*/
tolerance?: number | null;
}
/**
* A rule that aligns specified child fields with a parent field.
*/
export interface Schema$CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleChildAlignmentRule {
/**
* The alignment rule to apply to the child fields.
*/
alignmentRule?: Schema$CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleAlignmentRule;
/**
* The child fields to be aligned within the parent field.
*/
childFields?: Schema$CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleField[];
/**
* The full path of the parent field.
*/
parentField?: Schema$CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleField;
}
/**
* The constant value used in the validation rules.
*/
export interface Schema$CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleConstant {
floatValue?: number | null;
}
/**
* A rule that aligns specified fields with each other.
*/
export interface Schema$CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleEntityAlignmentRule {
/**
* The alignment rule to apply to the fields.
*/
alignmentRule?: Schema$CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleAlignmentRule;
/**
* The fields to be aligned.
*/
fields?: Schema$CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleField[];
}
export interface Schema$CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleField {
/**
* Default value to use if the field is not present. If the field is missing and the default value is not set, the validation run as if the field is not present in the validation logic.
*/
defaultValue?: Schema$CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleConstant;
/**
* The field name to validate. This can be a simple field name or a nested field one using the ':' (meant as an aggregator) or '*' (meant as foreach) operators.
*/
fieldName?: string | null;
}
export interface Schema$CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleFieldOccurrences {
field?: Schema$CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleField;
maxOccurrences?: number | null;
/**
* Min and max occurrences of the field. If not set, there is limit set. The defined interval is a closed-closed interval, i.e. [min, max].
*/
minOccurrences?: number | null;
}
export interface Schema$CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleFieldRegex {
field?: Schema$CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleField;
/**
* Python regex to validate the field values.
*/
pattern?: string | null;
}
export interface Schema$CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleFormValidation {
leftOperand?: Schema$CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleFormValidationOperation;
rightOperand?: Schema$CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleFormValidationOperation;
/**
* The relational operator to be applied to the operands.
*/
validationOperator?: string | null;
}
export interface Schema$CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleFormValidationOperation {
/**
* A list of constants to be used as operands.
*/
constants?: Schema$CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleConstant[];
/**
* A list of fields to be used as operands.
*/
fields?: Schema$CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleField[];
/**
* A list of recursive operations to be used as operands.
*/
operations?: Schema$CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleFormValidationOperation[];
/**
* The operation type to be applied to all the operands.
*/
operationType?: string | null;
}
/**
* Metadata of the auto-labeling documents operation.
*/
export interface Schema$GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadata {
/**
* The basic metadata of the long-running operation.
*/
commonMetadata?: Schema$GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata;
/**
* The list of individual auto-labeling statuses of the dataset documents.
*/
individualAutoLabelStatuses?: Schema$GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadataIndividualAutoLabelStatus[];
/**
* Total number of the auto-labeling documents.
*/
totalDocumentCount?: number | null;
}
/**
* The status of individual documents in the auto-labeling process.
*/
export interface Schema$GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadataIndividualAutoLabelStatus {
/**
* The document id of the auto-labeled document. This will replace the gcs_uri.
*/
documentId?: Schema$GoogleCloudDocumentaiUiv1beta3DocumentId;
/**
* The status of the document auto-labeling.
*/
status?: Schema$GoogleRpcStatus;
}
/**
* The response proto of AutoLabelDocuments method.
*/
export interface Schema$GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsResponse {
}
export interface Schema$GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadata {
/**
* The basic metadata of the long-running operation.
*/
commonMetadata?: Schema$GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata;
/**
* Total number of documents that failed to be deleted in storage.
*/
errorDocumentCount?: number | null;
/**
* The list of response details of each document.
*/
individualBatchDeleteStatuses?: Schema$GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus[];
/**
* Total number of documents deleting from dataset.
*/
totalDocumentCount?: number | null;
}
/**
* The status of each individual document in the batch delete process.
*/
export interface Schema$GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus {
/**
* The document id of the document.
*/
documentId?: Schema$GoogleCloudDocumentaiUiv1beta3DocumentId;
/**
* The status of deleting the document in storage.
*/
status?: Schema$GoogleRpcStatus;
}
/**
* Response of the delete documents operation.
*/
export interface Schema$GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsResponse {
}
export interface Schema$GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsMetadata {
/**
* The basic metadata of the long-running operation.
*/
commonMetadata?: Schema$GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata;
/**
* The destination dataset split type.
*/
destDatasetType?: string | null;
/**
* The destination dataset split type.
*/
destSplitType?: string | null;
/**
* The list of response details of each document.
*/
individualBatchMoveStatuses?: Schema$GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsMetadataIndividualBatchMoveStatus[];
}
/**
* The status of each individual document in the batch move process.
*/
export interface Schema$GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsMetadataIndividualBatchMoveStatus {
/**
* The document id of the document.
*/
documentId?: Schema$GoogleCloudDocumentaiUiv1beta3DocumentId;
/**
* The status of moving the document.
*/
status?: Schema$GoogleRpcStatus;
}
/**
* Response of the batch move documents operation.
*/
export interface Schema$GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsResponse {
}
export interface Schema$GoogleCloudDocumentaiUiv1beta3BatchUpdateDocumentsMetadata {
/**
* The basic metadata of the long-running operation.
*/
commonMetadata?: Schema$GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata;
/**
* The list of response details of each document.
*/
individualBatchUpdateStatuses?: Schema$GoogleCloudDocumentaiUiv1beta3BatchUpdateDocumentsMetadataIndividualBatchUpdateStatus[];
}
/**
* The status of each individual document in the batch update process.
*/
export interface Schema$GoogleCloudDocumentaiUiv1beta3BatchUpdateDocumentsMetadataIndividualBatchUpdateStatus {
/**
* The document id of the document.
*/
documentId?: Schema$GoogleCloudDocumentaiUiv1beta3DocumentId;
/**
* The status of updating the document in storage.
*/
status?: Schema$GoogleRpcStatus;
}
/**
* Response of the batch update documents operation.
*/
export interface Schema$GoogleCloudDocumentaiUiv1beta3BatchUpdateDocumentsResponse {
}
/**
* The common metadata for long running operations.
*/
export interface Schema$GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata {
/**
* The creation time of the operation.
*/
createTime?: string | null;
/**
* A related resource to this operation.
*/
resource?: string | null;
/**
* The state of the operation.
*/
state?: string | null;
/**
* A message providing more details about the current state of processing.
*/
stateMessage?: string | null;
/**
* The last update time of the operation.
*/
updateTime?: string | null;
}
/**
* The long-running operation metadata for the CreateLabelerPool method.
*/
export interface Schema$GoogleCloudDocumentaiUiv1beta3CreateLabelerPoolOperationMetadata {
/**
* The basic metadata of the long-running operation.
*/
commonMetadata?: Schema$GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata;
}
/**
* The long-running operation metadata for DeleteLabelerPool.
*/
export interface Schema$GoogleCloudDocumentaiUiv1beta3DeleteLabelerPoolOperationMetadata {
/**
* The basic metadata of the long-running operation.
*/
commonMetadata?: Schema$GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata;
}
/**
* The long-running operation metadata for the DeleteProcessor method.
*/
export interface Schema$GoogleCloudDocumentaiUiv1beta3DeleteProcessorMetadata {
/**
* The basic metadata of the long-running operation.
*/
commonMetadata?: Schema$GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata;
}
/**
* The long-running operation metadata for the DeleteProcessorVersion method.
*/
export interface Schema$GoogleCloudDocumentaiUiv1beta3DeleteProcessorVersionMetadata {
/**
* The basic metadata of the long-running operation.
*/
commonMetadata?: Schema$GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata;
}
/**
* The long-running operation metadata for the DeployProcessorVersion method.
*/
export interface Schema$GoogleCloudDocumentaiUiv1beta3DeployProcessorVersionMetadata {
/**
* The basic metadata of the long-running operation.
*/
commonMetadata?: Schema$GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata;
}
/**
* Response message for the DeployProcessorVersion method.
*/
export interface Schema$GoogleCloudDocumentaiUiv1beta3DeployProcessorVersionResponse {
}
/**
* The long-running operation metadata for the DisableProcessor method.
*/
export interface Schema$GoogleCloudDocumentaiUiv1beta3DisableProcessorMetadata {
/**
* The basic metadata of the long-running operation.
*/
commonMetadata?: Schema$GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata;
}
/**
* Response message for the DisableProcessor method. Intentionally empty proto for adding fields in future.
*/
export interface Schema$GoogleCloudDocumentaiUiv1beta3DisableProcessorResponse {
}
/**
* Document Identifier.
*/
export interface Schema$GoogleCloudDocumentaiUiv1beta3DocumentId {
/**
* A document id within user-managed Cloud Storage.
*/
gcsManagedDocId?: Schema$GoogleCloudDocumentaiUiv1beta3DocumentIdGCSManagedDocumentId;
/**
* Points to a specific revision of the document if set.
*/
revisionRef?: Schema$GoogleCloudDocumentaiUiv1beta3RevisionRef;
/**
* A document id within unmanaged dataset.
*/
unmanagedDocId?: Schema$GoogleCloudDocumentaiUiv1beta3DocumentIdUnmanagedDocumentId;
}
/**
* Identifies a document uniquely within the scope of a dataset in the user-managed Cloud Storage option.
*/
export interface Schema$GoogleCloudDocumentaiUiv1beta3DocumentIdGCSManagedDocumentId {
/**
* Id of the document (indexed) managed by Content Warehouse.
*/
cwDocId?: string | null;
/**
* Required. The Cloud Storage URI where the actual document is stored.
*/
gcsUri?: string | null;
}
/**
* Identifies a document uniquely within the scope of a dataset in unmanaged option.
*/
export interface Schema$GoogleCloudDocumentaiUiv1beta3DocumentIdUnmanagedDocumentId {
/**
* Required. The id of the document.
*/
docId?: string | null;
}
/**
* The schema defines the output of the processed document by a processor.
*/
export interface Schema$GoogleCloudDocumentaiUiv1beta3DocumentSchema {
/**
* Description of the schema.
*/
description?: string | null;
/**
* Display name to show to users.
*/
displayName?: string | null;
/**
* Optional. Document level prompt provided by the user. This custom text is injected into the AI model's prompt to provide extra, document-wide guidance for processing.
*/
documentPrompt?: string | null;
/**
* Entity types of the schema.
*/
entityTypes?: Schema$GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityType[];
/**
* Metadata of the schema.
*/
metadata?: Schema$GoogleCloudDocumentaiUiv1beta3DocumentSchemaMetadata;
}
/**
* 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.
*/
export interface Schema$GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityType {
/**
* The entity type that this type is derived from. For now, one and only one should be set.
*/
baseTypes?: string[] | null;
/**
* The description of the entity type. Could be used to provide more information about the entity type for model calls.
*/
description?: string | null;
/**
* User defined name for the type.
*/
displayName?: string | null;
/**
* Metadata for the entity type.
*/
entityTypeMetadata?: Schema$GoogleCloudDocumentaiUiv1beta3EntityTypeMetadata;
/**
* 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 `EntityType.value_ontology` field and specify a list of all possible values in a value ontology file.
*/
enumValues?: Schema$GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityTypeEnumValues;
/**
* Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility internal infrastructure and tooling can handle any ascii character.) - The `/` is sometimes used to denote a property of a type. For example `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility.
*/
name?: string | null;
/**
* Description the nested structure, or composition of an entity.
*/
properties?: Schema$GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityTypeProperty[];
}
/**
* Defines the a list of enum values.
*/
export interface Schema$GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityTypeEnumValues {
/**
* The individual values that this enum values type can include.
*/
values?: string[] | null;
}
/**
* Defines properties that can be part of the entity type.
*/
export interface Schema$GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityTypeProperty {
/**
* The description of the property. Could be used to provide more information about the property for model calls.
*/
description?: string | null;
/**
* User defined name for the property.
*/
displayName?: string | null;
/**
* Specifies how the entity's value is obtained.
*/
method?: string | null;
/**
* The name of the property. Follows the same guidelines as the EntityType name.
*/
name?: string | null;
/**
* Occurrence type limits the number of instances an entity type appears in the document.
*/
occurrenceType?: string | null;
/**
* Any additional metadata about the property can be added here.
*/
propertyMetadata?: Schema$GoogleCloudDocumentaiUiv1beta3PropertyMetadata;
/**
* A reference to the value type of the property. This type is subject to the same conventions as the `Entity.base_types` field.
*/
valueType?: string | null;
}
/**
* Metadata for global schema behavior.
*/
export interface Schema$GoogleCloudDocumentaiUiv1beta3DocumentSchemaMetadata {
/**
* If true, on a given page, there can be multiple `document` annotations covering it.
*/
documentAllowMultipleLabels?: boolean | null;
/**
* If true, a `document` entity type can be applied to subdocument (splitting). Otherwise, it can only be applied to the entire document (classification).
*/
documentSplitter?: boolean | null;
/**
* If set, all the nested entities must be prefixed with the parents.
*/
prefixedNamingOnProperties?: boolean | null;
/**
* If set, we will skip the naming format validation in the schema. So the string values in `DocumentSchema.EntityType.name` and `DocumentSchema.EntityType.Property.name` will not be checked.
*/
skipNamingValidation?: boolean | null;
}
/**
* The long-running operation metadata for the EnableProcessor method.
*/
export interface Schema$GoogleCloudDocumentaiUiv1beta3EnableProcessorMetadata {
/**
* The basic metadata of the long-running operation.
*/
commonMetadata?: Schema$GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata;
}
/**
* Response message for the EnableProcessor method. Intentionally empty proto for adding fields in future.
*/
export interface Schema$GoogleCloudDocumentaiUiv1beta3EnableProcessorResponse {
}
/**
* Metadata about an entity type.
*/
export interface Schema$GoogleCloudDocumentaiUiv1beta3EntityTypeMetadata {
/**
* Field tier metadata on the property
*/
fieldTierMetadata?: Schema$GoogleCloudDocumentaiUiv1beta3FieldTierMetadata;
/**
* Human review labeling config on the entity.
*/
humanReviewLabelingMetadata?: Schema$GoogleCloudDocumentaiUiv1beta3HumanReviewLabelingMetadata;
/**
* Human review config on the entity.
*/
humanReviewMetadata?: Schema$GoogleCloudDocumentaiUiv1beta3HumanReviewValidationMetadata;
/**
* Whether the entity type should be considered inactive.
*/
inactive?: boolean | null;
/**
* Schema editability metadata on the entity.
*/
schemaEditabilityMetadata?: Schema$GoogleCloudDocumentaiUiv1beta3SchemaEditabilityMetadata;
/**
* Schema inference metadata on the entity.
*/
schemaInferenceMetadata?: Schema$GoogleCloudDocumentaiUiv1beta3SchemaInferenceMetadata;
}
/**
* Metadata of the EvaluateProcessorVersion method.
*/
export interface Schema$GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionMetadata {
/**
* The basic metadata of the long-running operation.
*/
commonMetadata?: Schema$GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata;
}
/**
* Response of the EvaluateProcessorVersion method.
*/
export interface Schema$GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionResponse {
/**
* The resource name of the created evaluation.
*/
evaluation?: string | null;
}
/**
* Evaluation metrics, either in aggregate or about a specific entity.
*/
export interface Schema$GoogleCloudDocumentaiUiv1beta3EvaluationMetrics {
/**
* The calculated f1 score.
*/
f1Score?: number | null;
/**
* The amount of false negatives.
*/
falseNegativesCount?: number | null;
/**
* The amount of false positives.
*/
falsePositivesCount?: number | null;
/**
* The amount of documents with a ground truth occurrence.
*/
groundTruthDocumentCount?: number | null;
/**
* The amount of occurrences in ground truth documents.
*/
groundTruthOccurrencesCount?: number | null;
/**
* The calculated precision.
*/
precision?: number | null;
/**
* The amount of documents with a predicted occurrence.
*/
predictedDocumentCount?: number | null;
/**
* The amount of occurrences in predicted documents.
*/
predictedOccurrencesCount?: number | null;
/**
* The calculated recall.
*/
recall?: number | null;
/**
* The amount of documents that had an occurrence of this label.
*/
totalDocumentsCount?: number | null;
/**
* The amount of true positives.
*/
truePositivesCount?: number | null;
}
/**
* Gives a short summary of an evaluation, and links to the evaluation itself.
*/
export interface Schema$GoogleCloudDocumentaiUiv1beta3EvaluationReference {
/**
* An aggregate of the statistics for the evaluation with fuzzy matching on.
*/
aggregateMetrics?: Schema$GoogleCloudDocumentaiUiv1beta3EvaluationMetrics;
/**
* An aggregate of the statistics for the evaluation with fuzzy matching off.
*/
aggregateMetricsExact?: Schema$GoogleCloudDocumentaiUiv1beta3EvaluationMetrics;
/**
* The resource name of the evaluation.
*/
evaluation?: string | null;
/**
* The resource name of the Long Running Operation for the evaluation.
*/
operation?: string | null;
}
/**
* Metadata of the batch export documents operation.
*/
export interface Schema$GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadata {
/**
* The basic metadata of the long-running operation.
*/
commonMetadata?: Schema$GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata;
/**
* The list of response details of each document.
*/
individualExportStatuses?: Schema$GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadataIndividualExportStatus[];
/**
* The list of statistics for each dataset split type.
*/
splitExportStats?: Schema$GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadataSplitExportStat[];
}
/**
* The status of each individual document in the export process.
*/
export interface Schema$GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadataIndividualExportStatus {
/**
* The path to source docproto of the document.
*/
documentId?: Schema$GoogleCloudDocumentaiUiv1beta3DocumentId;
/**
* The output_gcs_destination of the exported document if it was successful, otherwise empty.
*/
outputGcsDestination?: string | null;
/**
* The status of the exporting of the document.
*/
status?: Schema$GoogleRpcStatus;
}
/**
* The statistic representing a dataset split type for this export.
*/
export interface Schema$GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadataSplitExportStat {
/**
* The dataset split type.
*/
splitType?: string | null;
/**
* Total number of documents with the given dataset split type to be exported.
*/
totalDocumentCount?: number | null;
}
/**
* The response proto of ExportDocuments method.
*/
export interface Schema$GoogleCloudDocumentaiUiv1beta3ExportDocumentsResponse {
}
/**
* Metadata message associated with the ExportProcessorVersion operation.
*/
export interface Schema$GoogleCloudDocumentaiUiv1beta3ExportProcessorVersionMetadata {
/**
* The common metadata about the operation.
*/
commonMetadata?: Schema$GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata;
}
/**
* Response message associated with the ExportProcessorVersion operation.
*/
export interface Schema$GoogleCloudDocumentaiUiv1beta3ExportProcessorVersionResponse {
/**
* The Cloud Storage URI containing the output artifacts.
*/
gcsUri?: string | null;
}
/**
* Metadata for how this field value is extracted.
*/
export interface Schema$GoogleCloudDocumentaiUiv1beta3FieldExtractionMetadata {
/**
* Entity query config.
*/
entityQuery?: Schema$GoogleCloudDocumentaiUiv1beta3FieldExtractionMetadataEntityQuery;
/**
* Summary options config.
*/
summaryOptions?: Schema$GoogleCloudDocumentaiUiv1beta3SummaryOptions;
}
/**
* Message for entity query.
*/
export interface Schema$GoogleCloudDocumentaiUiv1beta3FieldExtractionMetadataEntityQuery {
/**
* The original entity query inputed by the user.
*/
userEntityQuery?: string | null;
}
/**
* Metadata for the field tier of a property.
*/
export interface Schema$GoogleCloudDocumentaiUiv1beta3FieldTierMetadata {
/**
* Integer that indicates the tier of a property. e.g. Invoice has entities that are classified as tier 1 which is the most important, while tier 2 and tier 3 less so. This attribute can be used to filter schema attributes before running eval. e.g. compute F1 score for only tier 1 entities. If not present this attribute should be inferred as 1.
*/
tierLevel?: number | null;
}
/**
* Metadata for human review labeling config.
*/
export interface Schema$GoogleCloudDocumentaiUiv1beta3HumanReviewLabelingMetadata {
/**
* Whether to enable normalization editing.
*/
enableNormalizationEditing?: boolean | null;
}
/**
* Metadata for Human Review config.
*/
export interface Schema$GoogleCloudDocumentaiUiv1beta3HumanReviewValidationMetadata {
/**
* The confidence threshold if human review validation is enabled.
*/
confidenceThreshold?: number | null;
/**
* Whether to enable human review validation.
*/
enableValidation?: boolean | null;
}
/**
* Metadata of the import document operation.
*/
export interface Schema$GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadata {
/**
* The basic metadata of the long-running operation.
*/
commonMetadata?: Schema$GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata;
/**
* Validation statuses of the batch documents import config.
*/
importConfigValidationResults?: Schema$GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataImportConfigValidationResult[];
/**
* The list of response details of each document.
*/
individualImportStatuses?: Schema$GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataIndividualImportStatus[];
/**
* Total number of the documents that are qualified for importing.
*/
totalDocumentCount?: number | null;
}
/**
* The validation status of each import config. Status is set to an error if there are no documents to import in the `import_config`, or `OK` if the operation will try to proceed with at least one document.
*/
export interface Schema$GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataImportConfigValidationResult {
/**
* The source Cloud Storage URI specified in the import config.
*/
inputGcsSource?: string | null;
/**
* The validation status of import config.
*/
status?: Schema$GoogleRpcStatus;
}
/**
* The status of each individual document in the import process.
*/
export interface Schema$GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataIndividualImportStatus {
/**
* The source Cloud Storage URI of the document.
*/
inputGcsSource?: string | null;
/**
* The document id of imported document if it was successful, otherwise empty.
*/
outputDocumentId?: Schema$GoogleCloudDocumentaiUiv1beta3DocumentId;
/**
* The output_gcs_destination of the processed document if it was successful, otherwise empty.
*/
outputGcsDestination?: string | null;
/**
* The status of the importing of the document.
*/
status?: Schema$GoogleRpcStatus;
}
/**
* Response of the import document operation.
*/
export interface Schema$GoogleCloudDocumentaiUiv1beta3ImportDocumentsResponse {
}
/**
* The long-running operation metadata for the ImportProcessorVersion method.
*/
export interface Schema$GoogleCloudDocumentaiUiv1beta3ImportProcessorVersionMetadata {
/**
* The basic metadata for the long-running operation.
*/
commonMetadata?: Schema$GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata;
}
/**
* The response message for the ImportProcessorVersion method.
*/
export interface Schema$GoogleCloudDocumentaiUiv1beta3ImportProcessorVersionResponse {
/**
* The destination processor version name.
*/
processorVersion?: string | null;
}
/**
* The first-class citizen for Document AI. Each processor defines how to extract structural information from a document.
*/
export interface Schema$GoogleCloudDocumentaiUiv1beta3Processor {
/**
* Optional. SchemaVersion used by the Processor. It is the same as Processor's DatasetSchema.schema_version Format is `projects/{project\}/locations/{location\}/schemas/{schema\}/schemaVersions/{schema_version\}
*/
activeSchemaVersion?: string | null;
/**
* Output only. The time the processor was created.
*/
createTime?: string | null;
/**
* The default processor version.
*/
defaultProcessorVersion?: string | null;
/**
* The display name of the processor.
*/
displayName?: string | null;
/**
* The [KMS key](https://cloud.google.com/security-key-management) used for encryption and decryption in CMEK scenarios.
*/
kmsKeyName?: string | null;
/**
* Output only. Immutable. The resource name of the processor. Format: `projects/{project\}/locations/{location\}/processors/{processor\}`
*/
name?: string | null;
/**
* Output only. Immutable. The http endpoint that can be called to invoke processing.
*/
processEndpoint?: string | null;
/**
* Output only. The processor version aliases.
*/
processorVersionAliases?: Schema$GoogleCloudDocumentaiUiv1beta3ProcessorVersionAlias[];
/**
* Output only. Reserved for future use.
*/
satisfiesPzi?: boolean | null;
/**
* Output only. Reserved for future use.
*/
satisfiesPzs?: boolean | null;
/**
* Output only. The state of the processor.
*/
state?: string | null;
/**
* The processor type, such as: `OCR_PROCESSOR`, `INVOICE_PROCESSOR`. To get a list of processor types, see FetchProcessorTypes.
*/
type?: string | null;
}
/**
* 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.
*/
export interface Schema$GoogleCloudDocumentaiUiv1beta3ProcessorVersion {
/**
* Output only. The time the processor version was created.
*/
createTime?: string | null;
/**
* Output only. Denotes that this `ProcessorVersion` can be deployed and undeployed.
*/
deploymentAllowed?: boolean | null;
/**
* Output only. If set, information about the eventual deprecation of this version.
*/
deprecationInfo?: Schema$GoogleCloudDocumentaiUiv1beta3ProcessorVersionDeprecationInfo;
/**
* The display name of the processor version.
*/
displayName?: string | null;
/**
* Output only. The schema of the processor version. Describes the output.
*/
documentSchema?: Schema$GoogleCloudDocumentaiUiv1beta3DocumentSchema;
/**
* Output only. Information about Generative AI model-based processor versions.
*/
genAiModelInfo?: Schema$GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfo;
/**
* Output only. Denotes that this `ProcessorVersion` is managed by Google.
*/
googleManaged?: boolean | null;
/**
* Output only. The KMS key name used for encryption.
*/
kmsKeyName?: string | null;
/**
* Output only. The KMS key version with which data is encrypted.
*/
kmsKeyVersionName?: string | null;
/**
* Output only. The most recently invoked evaluation for the processor version.
*/
latestEvaluation?: Schema$GoogleCloudDocumentaiUiv1beta3EvaluationReference;
/**
* Output only. The model type of this processor version.
*/
modelType?: string | null;
/**
* Identifier. The resource name of the processor version. Format: `projects/{project\}/locations/{location\}/processors/{processor\}/processorVersions/{processor_version\}`
*/
name?: string | null;
/**
* Output only. Reserved for future use.
*/
satisfiesPzi?: boolean | null;
/**
* Output only. Reserved for future use.
*/
satisfiesPzs?: boolean | null;
/**
* The schema of the processor version. Describes the output.
*/
schema?: Schema$GoogleCloudDocumentaiUiv1beta3Schema;
/**
* Output only. The state of the processor version.
*/
state?: string | null;
}
/**
* Contains the alias and the aliased resource name of processor version.
*/
export interface Schema$GoogleCloudDocumentaiUiv1beta3ProcessorVersionAlias {
/**
* The alias in the form of `processor_version` resource name.
*/
alias?: string | null;
/**
* The resource name of aliased processor version.
*/
processorVersion?: string | null;
}
/**
* Information about the upcoming deprecation of this processor version.
*/
export interface Schema$GoogleCloudDocumentaiUiv1beta3ProcessorVersionDeprecationInfo {
/**
* The time at which this processor version will be deprecated.
*/
deprecationTime?: string | null;
/**
* If set, the processor version that will be used as a replacement.
*/
replacementProcessorVersion?: string | null;
}
/**
* Information about Generative AI model-based processor versions.
*/
export interface Schema$GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfo {
/**
* Information for a custom Generative AI model created by the user.
*/
customGenAiModelInfo?: Schema$GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfoCustomGenAiModelInfo;
/**
* Information for a pretrained Google-managed foundation model.
*/
foundationGenAiModelInfo?: Schema$GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo;
}
/**
* Information for a custom Generative AI model created by the user. These are created with `Create New Version` in either the `Call foundation model` or `Fine tuning` tabs.
*/
export interface Schema$GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfoCustomGenAiModelInfo {
/**
* The base processor version ID for the custom model.
*/
baseProcessorVersionId?: string | null;
/**
* The type of custom model created by the user.
*/
customModelType?: string | null;
}
/**
* Information for a pretrained Google-managed foundation model.
*/
export interface Schema$GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo {
/**
* Whether finetuning is allowed for this base processor version.
*/
finetuningAllowed?: boolean | null;
/**
* The minimum number of labeled documents in the training dataset required for finetuning.
*/
minTrainLabeledDocuments?: number | null;
}
/**
* Metadata about a property.
*/
export interface Schema$GoogleCloudDocumentaiUiv1beta3PropertyMetadata {
/**
* Field extraction metadata on the property.
*/
fieldExtractionMetadata?: Schema$GoogleCloudDocumentaiUiv1beta3FieldExtractionMetadata;
/**
* Field tier metadata on the property
*/
fieldTierMetadata?: Schema$GoogleCloudDocumentaiUiv1beta3FieldTierMetadata;
/**
* Human review labeling config on the property.
*/
humanReviewLabelingMetadata?: Schema$GoogleCloudDocumentaiUiv1beta3HumanReviewLabelingMetadata;
/**
* Human review validation config on the property.
*/
humanReviewMetadata?: Schema$GoogleCloudDocumentaiUiv1beta3HumanReviewValidationMetadata;
/**
* Whether the property should be considered as "inactive".
*/
inactive?: boolean | null;
/**
* Schema editability metadata on the property.
*/
schemaEditabilityMetadata?: Schema$GoogleCloudDocumentaiUiv1beta3SchemaEditabilityMetadata;
/**
* Schema inference metadata on the property.
*/
schemaInferenceMetadata?: Schema$GoogleCloudDocumentaiUiv1beta3SchemaInferenceMetadata;
}
/**
* The metadata proto of `ResyncDataset` method.
*/
export interface Schema$GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadata {
/**
* The basic metadata of the long-running operation.
*/
commonMetadata?: Schema$GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata;
/**
* The list of dataset resync statuses. Not checked when ResyncDatasetRequest.dataset_documents is specified.
*/
datasetResyncStatuses?: Schema$GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataDatasetResyncStatus[];
/**
* The list of document resync statuses. The same document could have multiple `individual_document_resync_statuses` if it has multiple inconsistencies.
*/
individualDocumentResyncStatuses?: Schema$GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataIndividualDocumentResyncStatus[];
}
/**
* Resync status against inconsistency types on the dataset level.
*/
export interface Schema$GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataDatasetResyncStatus {
/**
* The type of the inconsistency of the dataset.
*/
datasetInconsistencyType?: string | null;
/**
* The status of resyncing the dataset with regards to the detected inconsistency. Empty if ResyncDatasetRequest.validate_only is `true`.
*/
status?: Schema$GoogleRpcStatus;
}
/**
* Resync status for each document per inconsistency type.
*/
export interface Schema$GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataIndividualDocumentResyncStatus {
/**
* The document identifier.
*/
documentId?: Schema$GoogleCloudDocumentaiUiv1beta3DocumentId;
/**
* The type of document inconsistency.
*/
documentInconsistencyType?: string | null;
/**
* The status of resyncing the document with regards to the detected inconsistency. Empty if ResyncDatasetRequest.validate_only is `true`.
*/
status?: Schema$GoogleRpcStatus;
}
/**
* The response proto of ResyncDataset method.
*/
export interface Schema$GoogleCloudDocumentaiUiv1beta3ResyncDatasetResponse {
}
/**
* The revision reference specifies which revision on the document to read.
*/
export interface Schema$GoogleCloudDocumentaiUiv1beta3RevisionRef {
/**
* Reads the revision generated by the processor version. The format takes the full resource name of processor version. `projects/{project\}/locations/{location\}/processors/{processor\}/processorVersions/{processorVersion\}`
*/
latestProcessorVersion?: string | null;
/**
* Reads the revision by the predefined case.
*/
revisionCase?: string | null;
/**
* Reads the revision given by the id.
*/
revisionId?: string | null;
}
/**
* Metadata of the sample documents operation.
*/
export interface Schema$GoogleCloudDocumentaiUiv1beta3SampleDocumentsMetadata {
/**
* The basic metadata of the long-running operation.
*/
commonMetadata?: Schema$GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata;
}
/**
* Response of the sample documents operation.
*/
export interface Schema$GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponse {
/**
* The status of sampling documents in test split.
*/
sampleTestStatus?: Schema$GoogleRpcStatus;
/**
* The status of sampling documents in training split.
*/
sampleTrainingStatus?: Schema$GoogleRpcStatus;
/**
* The result of the sampling process.
*/
selectedDocuments?: Schema$GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponseSelectedDocument[];
}
export interface Schema$GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponseSelectedDocument {
/**
* An internal identifier for document.
*/
documentId?: string | null;
}
/**
* The schema defines the output of the processed document by a processor.
*/
export interface Schema$GoogleCloudDocumentaiUiv1beta3Schema {
/**
* Description of th