@maxim_mazurok/gapi.client.documentai-v1 0.1.20260118 → 0.1.20260203
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/index.d.ts +55 -44
- package/package.json +1 -1
package/index.d.ts
CHANGED
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
// This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
|
|
10
10
|
// In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
|
|
11
11
|
// Generated from: https://documentai.googleapis.com/$discovery/rest?version=v1
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20260203
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -29,7 +29,7 @@ declare namespace gapi.client {
|
|
|
29
29
|
}
|
|
30
30
|
interface CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRule {
|
|
31
31
|
childAlignmentRule?: CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleChildAlignmentRule;
|
|
32
|
-
/** Description of the validation rule. This has no use but for documentation */
|
|
32
|
+
/** Description of the validation rule. This has no use but for documentation. */
|
|
33
33
|
description?: string;
|
|
34
34
|
entityAlignmentRule?: CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleEntityAlignmentRule;
|
|
35
35
|
fieldOccurrences?: CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleFieldOccurrences;
|
|
@@ -216,7 +216,7 @@ declare namespace gapi.client {
|
|
|
216
216
|
interface GoogleCloudDocumentaiUiv1beta3DocumentSchema {
|
|
217
217
|
/** Description of the schema. */
|
|
218
218
|
description?: string;
|
|
219
|
-
/** Display name to show
|
|
219
|
+
/** Display name to show users. */
|
|
220
220
|
displayName?: string;
|
|
221
221
|
/** 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. */
|
|
222
222
|
documentPrompt?: string;
|
|
@@ -234,9 +234,9 @@ declare namespace gapi.client {
|
|
|
234
234
|
displayName?: string;
|
|
235
235
|
/** Metadata for the entity type. */
|
|
236
236
|
entityTypeMetadata?: GoogleCloudDocumentaiUiv1beta3EntityTypeMetadata;
|
|
237
|
-
/** 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. */
|
|
237
|
+
/** 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. */
|
|
238
238
|
enumValues?: GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityTypeEnumValues;
|
|
239
|
-
/** 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
|
|
239
|
+
/** 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. */
|
|
240
240
|
name?: string;
|
|
241
241
|
/** Description the nested structure, or composition of an entity. */
|
|
242
242
|
properties?: GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityTypeProperty[];
|
|
@@ -268,7 +268,7 @@ declare namespace gapi.client {
|
|
|
268
268
|
documentSplitter?: boolean;
|
|
269
269
|
/** If set, all the nested entities must be prefixed with the parents. */
|
|
270
270
|
prefixedNamingOnProperties?: boolean;
|
|
271
|
-
/** If set,
|
|
271
|
+
/** If set, this 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. */
|
|
272
272
|
skipNamingValidation?: boolean;
|
|
273
273
|
}
|
|
274
274
|
interface GoogleCloudDocumentaiUiv1beta3EnableProcessorMetadata {
|
|
@@ -299,7 +299,7 @@ declare namespace gapi.client {
|
|
|
299
299
|
evaluation?: string;
|
|
300
300
|
}
|
|
301
301
|
interface GoogleCloudDocumentaiUiv1beta3EvaluationMetrics {
|
|
302
|
-
/** The calculated
|
|
302
|
+
/** The calculated F1 score. */
|
|
303
303
|
f1Score?: number;
|
|
304
304
|
/** The amount of false negatives. */
|
|
305
305
|
falseNegativesCount?: number;
|
|
@@ -507,9 +507,9 @@ declare namespace gapi.client {
|
|
|
507
507
|
customModelType?: string;
|
|
508
508
|
}
|
|
509
509
|
interface GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo {
|
|
510
|
-
/** Whether
|
|
510
|
+
/** Whether fine tuning is allowed for this base processor version. */
|
|
511
511
|
finetuningAllowed?: boolean;
|
|
512
|
-
/** The minimum number of labeled documents in the training dataset required for
|
|
512
|
+
/** The minimum number of labeled documents in the training dataset required for fine tuning. */
|
|
513
513
|
minTrainLabeledDocuments?: number;
|
|
514
514
|
}
|
|
515
515
|
interface GoogleCloudDocumentaiUiv1beta3PropertyMetadata {
|
|
@@ -578,7 +578,7 @@ declare namespace gapi.client {
|
|
|
578
578
|
interface GoogleCloudDocumentaiUiv1beta3Schema {
|
|
579
579
|
/** Description of the schema. */
|
|
580
580
|
description?: string;
|
|
581
|
-
/** Display name to show
|
|
581
|
+
/** Display name to show users. */
|
|
582
582
|
displayName?: string;
|
|
583
583
|
/** Entity types of the schema. */
|
|
584
584
|
entityTypes?: GoogleCloudDocumentaiUiv1beta3SchemaEntityType[];
|
|
@@ -780,8 +780,6 @@ declare namespace gapi.client {
|
|
|
780
780
|
satisfiesPzi?: boolean;
|
|
781
781
|
/** Output only. Reserved for future use. */
|
|
782
782
|
satisfiesPzs?: boolean;
|
|
783
|
-
/** Optional. A lightweight indexing source with low latency and high reliability, but lacking advanced features like CMEK and content-based search. */
|
|
784
|
-
spannerIndexingConfig?: any;
|
|
785
783
|
/** Required. State of the dataset. Ignored when updating dataset. */
|
|
786
784
|
state?: string;
|
|
787
785
|
/** Optional. Unmanaged dataset configuration. Use this configuration if the dataset documents are managed by the document service internally (not user-managed). */
|
|
@@ -797,7 +795,6 @@ declare namespace gapi.client {
|
|
|
797
795
|
/** Required. The Cloud Storage URI (a directory) where the documents belonging to the dataset must be stored. */
|
|
798
796
|
gcsPrefix?: GoogleCloudDocumentaiV1beta3GcsPrefix;
|
|
799
797
|
}
|
|
800
|
-
interface GoogleCloudDocumentaiV1beta3DatasetSpannerIndexingConfig {}
|
|
801
798
|
interface GoogleCloudDocumentaiV1beta3DatasetUnmanagedDatasetConfig {}
|
|
802
799
|
interface GoogleCloudDocumentaiV1beta3DeleteProcessorMetadata {
|
|
803
800
|
/** The basic metadata of the long-running operation. */
|
|
@@ -838,7 +835,7 @@ declare namespace gapi.client {
|
|
|
838
835
|
interface GoogleCloudDocumentaiV1beta3DocumentSchema {
|
|
839
836
|
/** Description of the schema. */
|
|
840
837
|
description?: string;
|
|
841
|
-
/** Display name to show
|
|
838
|
+
/** Display name to show users. */
|
|
842
839
|
displayName?: string;
|
|
843
840
|
/** 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. */
|
|
844
841
|
documentPrompt?: string;
|
|
@@ -856,9 +853,9 @@ declare namespace gapi.client {
|
|
|
856
853
|
displayName?: string;
|
|
857
854
|
/** Metadata for the entity type. */
|
|
858
855
|
entityTypeMetadata?: GoogleCloudDocumentaiV1beta3EntityTypeMetadata;
|
|
859
|
-
/** 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. */
|
|
856
|
+
/** 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. */
|
|
860
857
|
enumValues?: GoogleCloudDocumentaiV1beta3DocumentSchemaEntityTypeEnumValues;
|
|
861
|
-
/** 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
|
|
858
|
+
/** 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. */
|
|
862
859
|
name?: string;
|
|
863
860
|
/** Description the nested structure, or composition of an entity. */
|
|
864
861
|
properties?: GoogleCloudDocumentaiV1beta3DocumentSchemaEntityTypeProperty[];
|
|
@@ -890,7 +887,7 @@ declare namespace gapi.client {
|
|
|
890
887
|
documentSplitter?: boolean;
|
|
891
888
|
/** If set, all the nested entities must be prefixed with the parents. */
|
|
892
889
|
prefixedNamingOnProperties?: boolean;
|
|
893
|
-
/** If set,
|
|
890
|
+
/** If set, this 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. */
|
|
894
891
|
skipNamingValidation?: boolean;
|
|
895
892
|
}
|
|
896
893
|
interface GoogleCloudDocumentaiV1beta3EnableProcessorMetadata {
|
|
@@ -911,7 +908,7 @@ declare namespace gapi.client {
|
|
|
911
908
|
evaluation?: string;
|
|
912
909
|
}
|
|
913
910
|
interface GoogleCloudDocumentaiV1beta3EvaluationMetrics {
|
|
914
|
-
/** The calculated
|
|
911
|
+
/** The calculated F1 score. */
|
|
915
912
|
f1Score?: number;
|
|
916
913
|
/** The amount of false negatives. */
|
|
917
914
|
falseNegativesCount?: number;
|
|
@@ -1074,9 +1071,9 @@ declare namespace gapi.client {
|
|
|
1074
1071
|
customModelType?: string;
|
|
1075
1072
|
}
|
|
1076
1073
|
interface GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo {
|
|
1077
|
-
/** Whether
|
|
1074
|
+
/** Whether fine tuning is allowed for this base processor version. */
|
|
1078
1075
|
finetuningAllowed?: boolean;
|
|
1079
|
-
/** The minimum number of labeled documents in the training dataset required for
|
|
1076
|
+
/** The minimum number of labeled documents in the training dataset required for fine tuning. */
|
|
1080
1077
|
minTrainLabeledDocuments?: number;
|
|
1081
1078
|
}
|
|
1082
1079
|
interface GoogleCloudDocumentaiV1beta3PropertyMetadata {
|
|
@@ -1210,7 +1207,7 @@ declare namespace gapi.client {
|
|
|
1210
1207
|
documentLayout?: GoogleCloudDocumentaiV1DocumentDocumentLayout;
|
|
1211
1208
|
/** A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries. */
|
|
1212
1209
|
entities?: GoogleCloudDocumentaiV1DocumentEntity[];
|
|
1213
|
-
/** The entity revision
|
|
1210
|
+
/** The entity revision ID that `document.entities` field is based on. If this field is set and `entities_revisions` is not empty, the entities in `document.entities` field are the entities in the entity revision with this id and `document.entity_validation_output` field is the `entity_validation_output` field in this entity revision. */
|
|
1214
1211
|
entitiesRevisionId?: string;
|
|
1215
1212
|
/** A list of entity revisions. The entity revisions are appended to the document in the processing order. This field can be used for comparing the entity extraction results at different stages of the processing. */
|
|
1216
1213
|
entitiesRevisions?: GoogleCloudDocumentaiV1DocumentEntitiesRevision[];
|
|
@@ -1352,11 +1349,11 @@ declare namespace gapi.client {
|
|
|
1352
1349
|
id?: string;
|
|
1353
1350
|
/** Optional. Deprecated. Use `id` field instead. */
|
|
1354
1351
|
mentionId?: string;
|
|
1355
|
-
/** Optional. Text value of the entity
|
|
1352
|
+
/** Optional. Text value of the entity, for example, `1600 Amphitheatre Pkwy`. */
|
|
1356
1353
|
mentionText?: string;
|
|
1357
1354
|
/** Optional. Specifies how the entity's value is obtained. */
|
|
1358
1355
|
method?: string;
|
|
1359
|
-
/** Optional. Normalized entity value. Absent if the extracted value could not be converted or the type (
|
|
1356
|
+
/** Optional. Normalized entity value. Absent if the extracted value could not be converted or the type (for example, address) is not supported for certain parsers. This field is also only populated for certain supported document types. */
|
|
1360
1357
|
normalizedValue?: GoogleCloudDocumentaiV1DocumentEntityNormalizedValue;
|
|
1361
1358
|
/** Optional. Represents the provenance of this entity wrt. the location on the page where it was found. */
|
|
1362
1359
|
pageAnchor?: GoogleCloudDocumentaiV1DocumentPageAnchor;
|
|
@@ -1368,7 +1365,7 @@ declare namespace gapi.client {
|
|
|
1368
1365
|
redacted?: boolean;
|
|
1369
1366
|
/** Optional. Provenance of the entity. Text anchor indexing into the Document.text. */
|
|
1370
1367
|
textAnchor?: GoogleCloudDocumentaiV1DocumentTextAnchor;
|
|
1371
|
-
/** Required. Entity type from a schema
|
|
1368
|
+
/** Required. Entity type from a schema, for example, `Address`. */
|
|
1372
1369
|
type?: string;
|
|
1373
1370
|
}
|
|
1374
1371
|
interface GoogleCloudDocumentaiV1DocumentEntityNormalizedValue {
|
|
@@ -1468,7 +1465,7 @@ declare namespace gapi.client {
|
|
|
1468
1465
|
tokens?: GoogleCloudDocumentaiV1DocumentPageToken[];
|
|
1469
1466
|
/** Transformation matrices that were applied to the original document image to produce Page.image. */
|
|
1470
1467
|
transforms?: GoogleCloudDocumentaiV1DocumentPageMatrix[];
|
|
1471
|
-
/** A list of detected non-text visual elements
|
|
1468
|
+
/** A list of detected non-text visual elements, for example, checkbox, signature etc. on the page. */
|
|
1472
1469
|
visualElements?: GoogleCloudDocumentaiV1DocumentPageVisualElement[];
|
|
1473
1470
|
}
|
|
1474
1471
|
interface GoogleCloudDocumentaiV1DocumentPageAnchor {
|
|
@@ -1520,7 +1517,7 @@ declare namespace gapi.client {
|
|
|
1520
1517
|
correctedKeyText?: string;
|
|
1521
1518
|
/** Created for Labeling UI to export value text. If corrections were made to the text identified by the `field_value.text_anchor`, this field will contain the correction. */
|
|
1522
1519
|
correctedValueText?: string;
|
|
1523
|
-
/** Layout for the FormField name.
|
|
1520
|
+
/** Layout for the FormField name. For example, `Address`, `Email`, `Grand total`, `Phone number`, etc. */
|
|
1524
1521
|
fieldName?: GoogleCloudDocumentaiV1DocumentPageLayout;
|
|
1525
1522
|
/** Layout for the FormField value. */
|
|
1526
1523
|
fieldValue?: GoogleCloudDocumentaiV1DocumentPageLayout;
|
|
@@ -1558,7 +1555,7 @@ declare namespace gapi.client {
|
|
|
1558
1555
|
interface GoogleCloudDocumentaiV1DocumentPageLayout {
|
|
1559
1556
|
/** The bounding polygon for the Layout. */
|
|
1560
1557
|
boundingPoly?: GoogleCloudDocumentaiV1BoundingPoly;
|
|
1561
|
-
/** Confidence of the current Layout within context of the object this layout is for.
|
|
1558
|
+
/** Confidence of the current Layout within context of the object this layout is for. For example, confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`. */
|
|
1562
1559
|
confidence?: number;
|
|
1563
1560
|
/** Detected orientation for the Layout. */
|
|
1564
1561
|
orientation?: string;
|
|
@@ -1714,7 +1711,7 @@ declare namespace gapi.client {
|
|
|
1714
1711
|
processor?: string;
|
|
1715
1712
|
}
|
|
1716
1713
|
interface GoogleCloudDocumentaiV1DocumentRevisionHumanReview {
|
|
1717
|
-
/** Human review state.
|
|
1714
|
+
/** Human review state. For example, `requested`, `succeeded`, `rejected`. */
|
|
1718
1715
|
state?: string;
|
|
1719
1716
|
/** A message providing more details about the current state of processing. For example, the rejection reason when the state is `rejected`. */
|
|
1720
1717
|
stateMessage?: string;
|
|
@@ -1726,7 +1723,7 @@ declare namespace gapi.client {
|
|
|
1726
1723
|
interface GoogleCloudDocumentaiV1DocumentSchema {
|
|
1727
1724
|
/** Description of the schema. */
|
|
1728
1725
|
description?: string;
|
|
1729
|
-
/** Display name to show
|
|
1726
|
+
/** Display name to show users. */
|
|
1730
1727
|
displayName?: string;
|
|
1731
1728
|
/** 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. */
|
|
1732
1729
|
documentPrompt?: string;
|
|
@@ -1740,9 +1737,9 @@ declare namespace gapi.client {
|
|
|
1740
1737
|
baseTypes?: string[];
|
|
1741
1738
|
/** User defined name for the type. */
|
|
1742
1739
|
displayName?: string;
|
|
1743
|
-
/** 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. */
|
|
1740
|
+
/** 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. */
|
|
1744
1741
|
enumValues?: GoogleCloudDocumentaiV1DocumentSchemaEntityTypeEnumValues;
|
|
1745
|
-
/** 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
|
|
1742
|
+
/** 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. */
|
|
1746
1743
|
name?: string;
|
|
1747
1744
|
/** Description the nested structure, or composition of an entity. */
|
|
1748
1745
|
properties?: GoogleCloudDocumentaiV1DocumentSchemaEntityTypeProperty[];
|
|
@@ -1770,7 +1767,7 @@ declare namespace gapi.client {
|
|
|
1770
1767
|
documentSplitter?: boolean;
|
|
1771
1768
|
/** If set, all the nested entities must be prefixed with the parents. */
|
|
1772
1769
|
prefixedNamingOnProperties?: boolean;
|
|
1773
|
-
/** If set,
|
|
1770
|
+
/** If set, this 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. */
|
|
1774
1771
|
skipNamingValidation?: boolean;
|
|
1775
1772
|
}
|
|
1776
1773
|
interface GoogleCloudDocumentaiV1DocumentShardInfo {
|
|
@@ -1860,6 +1857,8 @@ declare namespace gapi.client {
|
|
|
1860
1857
|
kmsKeyVersionName?: string;
|
|
1861
1858
|
/** The resource name of the evaluation. Format: `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}/evaluations/{evaluation}` */
|
|
1862
1859
|
name?: string;
|
|
1860
|
+
/** Contains all revisions of the evaluation, excluding the latest one. */
|
|
1861
|
+
revisions?: GoogleCloudDocumentaiV1EvaluationEvaluationRevision[];
|
|
1863
1862
|
}
|
|
1864
1863
|
interface GoogleCloudDocumentaiV1EvaluationConfidenceLevelMetrics {
|
|
1865
1864
|
/** The confidence level. */
|
|
@@ -1877,8 +1876,20 @@ declare namespace gapi.client {
|
|
|
1877
1876
|
/** How many documents were not included in the evaluation as they didn't pass validation. */
|
|
1878
1877
|
invalidDocumentsCount?: number;
|
|
1879
1878
|
}
|
|
1879
|
+
interface GoogleCloudDocumentaiV1EvaluationEvaluationRevision {
|
|
1880
|
+
/** Output only. Metrics for all the entities in aggregate. */
|
|
1881
|
+
allEntitiesMetrics?: GoogleCloudDocumentaiV1EvaluationMultiConfidenceMetrics;
|
|
1882
|
+
/** Output only. Counters for the documents used in the evaluation. */
|
|
1883
|
+
documentCounters?: GoogleCloudDocumentaiV1EvaluationCounters;
|
|
1884
|
+
/** Output only. Metrics across confidence levels, for different entities. */
|
|
1885
|
+
entityMetrics?: {
|
|
1886
|
+
[P in string]: GoogleCloudDocumentaiV1EvaluationMultiConfidenceMetrics;
|
|
1887
|
+
};
|
|
1888
|
+
/** Output only. The revision ID of the evaluation. */
|
|
1889
|
+
revisionId?: string;
|
|
1890
|
+
}
|
|
1880
1891
|
interface GoogleCloudDocumentaiV1EvaluationMetrics {
|
|
1881
|
-
/** The calculated
|
|
1892
|
+
/** The calculated F1 score. */
|
|
1882
1893
|
f1Score?: number;
|
|
1883
1894
|
/** The amount of false negatives. */
|
|
1884
1895
|
falseNegativesCount?: number;
|
|
@@ -2018,7 +2029,7 @@ declare namespace gapi.client {
|
|
|
2018
2029
|
createTime?: string;
|
|
2019
2030
|
/** Required. The user-defined name of the Schema. */
|
|
2020
2031
|
displayName?: string;
|
|
2021
|
-
/** Optional. The
|
|
2032
|
+
/** Optional. The {{gcp_name_short}} labels for the Schema. */
|
|
2022
2033
|
labels?: {[P in string]: string};
|
|
2023
2034
|
/** Identifier. The resource name of the Schema. Format: `projects/{project}/locations/{location}/schemas/{schema}` */
|
|
2024
2035
|
name?: string;
|
|
@@ -2198,9 +2209,9 @@ declare namespace gapi.client {
|
|
|
2198
2209
|
customModelType?: string;
|
|
2199
2210
|
}
|
|
2200
2211
|
interface GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo {
|
|
2201
|
-
/** Whether
|
|
2212
|
+
/** Whether fine tuning is allowed for this base processor version. */
|
|
2202
2213
|
finetuningAllowed?: boolean;
|
|
2203
|
-
/** The minimum number of labeled documents in the training dataset required for
|
|
2214
|
+
/** The minimum number of labeled documents in the training dataset required for fine tuning. */
|
|
2204
2215
|
minTrainLabeledDocuments?: number;
|
|
2205
2216
|
}
|
|
2206
2217
|
interface GoogleCloudDocumentaiV1ProcessRequest {
|
|
@@ -2280,7 +2291,7 @@ declare namespace gapi.client {
|
|
|
2280
2291
|
createTime?: string;
|
|
2281
2292
|
/** Required. The user-defined name of the SchemaVersion. */
|
|
2282
2293
|
displayName?: string;
|
|
2283
|
-
/** Optional. The
|
|
2294
|
+
/** Optional. The {{gcp_name_short}} labels for the SchemaVersion. */
|
|
2284
2295
|
labels?: {[P in string]: string};
|
|
2285
2296
|
/** Identifier. The resource name of the SchemaVersion. Format: `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}` */
|
|
2286
2297
|
name?: string;
|
|
@@ -3845,7 +3856,7 @@ declare namespace gapi.client {
|
|
|
3845
3856
|
oauth_token?: string;
|
|
3846
3857
|
/** Optional. The maximum number of SchemaVersion to return. If unspecified, at most `10` SchemaVersion will be returned. The maximum value is `20`. Values above `20` will be coerced to `20`. */
|
|
3847
3858
|
pageSize?: number;
|
|
3848
|
-
/** Optional.
|
|
3859
|
+
/** Optional. Returns the SchemaVersion sorted by creation time. The page token will point to the next SchemaVersion. */
|
|
3849
3860
|
pageToken?: string;
|
|
3850
3861
|
/** Required. Format: `projects/{project}/locations/{location}/schemas/{schema}` */
|
|
3851
3862
|
parent: string;
|
|
@@ -3880,7 +3891,7 @@ declare namespace gapi.client {
|
|
|
3880
3891
|
prettyPrint?: boolean;
|
|
3881
3892
|
/** 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. */
|
|
3882
3893
|
quotaUser?: string;
|
|
3883
|
-
/** Optional. The update mask to apply to the resource. **Note:** Only the following fields can be updated: - display_name
|
|
3894
|
+
/** Optional. The update mask to apply to the resource. **Note:** Only the following fields can be updated: - `display_name` - `labels` */
|
|
3884
3895
|
updateMask?: string;
|
|
3885
3896
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3886
3897
|
upload_protocol?: string;
|
|
@@ -3911,7 +3922,7 @@ declare namespace gapi.client {
|
|
|
3911
3922
|
prettyPrint?: boolean;
|
|
3912
3923
|
/** 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. */
|
|
3913
3924
|
quotaUser?: string;
|
|
3914
|
-
/** Optional. The update mask to apply to the resource. **Note:** Only the following fields can be updated: - display_name
|
|
3925
|
+
/** Optional. The update mask to apply to the resource. **Note:** Only the following fields can be updated: - `display_name` - `labels` */
|
|
3915
3926
|
updateMask?: string;
|
|
3916
3927
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3917
3928
|
upload_protocol?: string;
|
|
@@ -4054,7 +4065,7 @@ declare namespace gapi.client {
|
|
|
4054
4065
|
oauth_token?: string;
|
|
4055
4066
|
/** Optional. The maximum number of schema groups to return. If unspecified, at most `10` Schema will be returned. The maximum value is `20`. Values above `20` will be coerced to `20`. */
|
|
4056
4067
|
pageSize?: number;
|
|
4057
|
-
/** Optional.
|
|
4068
|
+
/** Optional. Returns the schema groups sorted by creation time. The page token will point to the next Schema. */
|
|
4058
4069
|
pageToken?: string;
|
|
4059
4070
|
/** Required. Format: `projects/{project}/locations/{location}` */
|
|
4060
4071
|
parent: string;
|
|
@@ -4089,7 +4100,7 @@ declare namespace gapi.client {
|
|
|
4089
4100
|
prettyPrint?: boolean;
|
|
4090
4101
|
/** 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. */
|
|
4091
4102
|
quotaUser?: string;
|
|
4092
|
-
/** Optional. The update mask to apply to the resource. **Note:** Only the following fields can be updated: - display_name
|
|
4103
|
+
/** Optional. The update mask to apply to the resource. **Note:** Only the following fields can be updated: - `display_name` - `labels` */
|
|
4093
4104
|
updateMask?: string;
|
|
4094
4105
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
4095
4106
|
upload_protocol?: string;
|
|
@@ -4120,7 +4131,7 @@ declare namespace gapi.client {
|
|
|
4120
4131
|
prettyPrint?: boolean;
|
|
4121
4132
|
/** 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. */
|
|
4122
4133
|
quotaUser?: string;
|
|
4123
|
-
/** Optional. The update mask to apply to the resource. **Note:** Only the following fields can be updated: - display_name
|
|
4134
|
+
/** Optional. The update mask to apply to the resource. **Note:** Only the following fields can be updated: - `display_name` - `labels` */
|
|
4124
4135
|
updateMask?: string;
|
|
4125
4136
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
4126
4137
|
upload_protocol?: string;
|
|
@@ -4186,7 +4197,7 @@ declare namespace gapi.client {
|
|
|
4186
4197
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4187
4198
|
uploadType?: string;
|
|
4188
4199
|
}): Request<GoogleCloudLocationLocation>;
|
|
4189
|
-
/** Lists information about the supported locations for this service. */
|
|
4200
|
+
/** Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project. */
|
|
4190
4201
|
list(request?: {
|
|
4191
4202
|
/** V1 error format. */
|
|
4192
4203
|
'$.xgafv'?: string;
|