@maxim_mazurok/gapi.client.documentai-v1beta3 0.0.20250117 → 0.0.20250128

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.
Files changed (3) hide show
  1. package/index.d.ts +26 -22
  2. package/package.json +1 -1
  3. package/readme.md +2 -2
package/index.d.ts CHANGED
@@ -9,14 +9,14 @@
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=v1beta3
12
- // Revision: 20250117
12
+ // Revision: 20250128
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
16
16
  declare namespace gapi.client {
17
17
  /** Load Cloud Document AI API v1beta3 */
18
18
  function load(
19
- urlOrObject: 'https://documentai.googleapis.com/$discovery/rest?version=v1beta3'
19
+ urlOrObject: 'https://documentai.googleapis.com/$discovery/rest?version=v1beta3',
20
20
  ): Promise<void>;
21
21
  /** @deprecated Please load APIs with discovery documents. */
22
22
  function load(name: 'documentai', version: 'v1beta3'): Promise<void>;
@@ -24,7 +24,7 @@ declare namespace gapi.client {
24
24
  function load(
25
25
  name: 'documentai',
26
26
  version: 'v1beta3',
27
- callback: () => any
27
+ callback: () => any,
28
28
  ): void;
29
29
 
30
30
  namespace documentai {
@@ -1428,6 +1428,10 @@ declare namespace gapi.client {
1428
1428
  interface GoogleCloudDocumentaiV1beta3ProcessOptionsLayoutConfig {
1429
1429
  /** Optional. Config for chunking in layout parser processor. */
1430
1430
  chunkingConfig?: GoogleCloudDocumentaiV1beta3ProcessOptionsLayoutConfigChunkingConfig;
1431
+ /** Optional. Whether to include bounding boxes in layout parser processor response. */
1432
+ returnBoundingBoxes?: boolean;
1433
+ /** Optional. Whether to include images in layout parser processor response. */
1434
+ returnImages?: boolean;
1431
1435
  }
1432
1436
  interface GoogleCloudDocumentaiV1beta3ProcessOptionsLayoutConfigChunkingConfig {
1433
1437
  /** Optional. The percentile of cosine dissimilarity that must be exceeded between a group of tokens and the next. The smaller this number is, the more chunks will be generated. */
@@ -2074,7 +2078,7 @@ declare namespace gapi.client {
2074
2078
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2075
2079
  uploadType?: string;
2076
2080
  },
2077
- body: GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsRequest
2081
+ body: GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsRequest,
2078
2082
  ): Request<GoogleLongrunningOperation>;
2079
2083
  /** Gets the `DatasetSchema` of a `Dataset`. */
2080
2084
  getDatasetSchema(request?: {
@@ -2206,7 +2210,7 @@ declare namespace gapi.client {
2206
2210
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2207
2211
  uploadType?: string;
2208
2212
  },
2209
- body: GoogleCloudDocumentaiV1beta3ImportDocumentsRequest
2213
+ body: GoogleCloudDocumentaiV1beta3ImportDocumentsRequest,
2210
2214
  ): Request<GoogleLongrunningOperation>;
2211
2215
  /** Returns a list of documents present in the dataset. */
2212
2216
  listDocuments(request: {
@@ -2264,7 +2268,7 @@ declare namespace gapi.client {
2264
2268
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2265
2269
  uploadType?: string;
2266
2270
  },
2267
- body: GoogleCloudDocumentaiV1beta3ListDocumentsRequest
2271
+ body: GoogleCloudDocumentaiV1beta3ListDocumentsRequest,
2268
2272
  ): Request<GoogleCloudDocumentaiV1beta3ListDocumentsResponse>;
2269
2273
  /** Updates a `DatasetSchema`. */
2270
2274
  updateDatasetSchema(request: {
@@ -2326,7 +2330,7 @@ declare namespace gapi.client {
2326
2330
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2327
2331
  uploadType?: string;
2328
2332
  },
2329
- body: GoogleCloudDocumentaiV1beta3DatasetSchema
2333
+ body: GoogleCloudDocumentaiV1beta3DatasetSchema,
2330
2334
  ): Request<GoogleCloudDocumentaiV1beta3DatasetSchema>;
2331
2335
  }
2332
2336
  interface HumanReviewConfigResource {
@@ -2386,7 +2390,7 @@ declare namespace gapi.client {
2386
2390
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2387
2391
  uploadType?: string;
2388
2392
  },
2389
- body: GoogleCloudDocumentaiV1beta3ReviewDocumentRequest
2393
+ body: GoogleCloudDocumentaiV1beta3ReviewDocumentRequest,
2390
2394
  ): Request<GoogleLongrunningOperation>;
2391
2395
  }
2392
2396
  interface EvaluationsResource {
@@ -2506,7 +2510,7 @@ declare namespace gapi.client {
2506
2510
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2507
2511
  uploadType?: string;
2508
2512
  },
2509
- body: GoogleCloudDocumentaiV1beta3BatchProcessRequest
2513
+ body: GoogleCloudDocumentaiV1beta3BatchProcessRequest,
2510
2514
  ): Request<GoogleLongrunningOperation>;
2511
2515
  /** Deletes the processor version, all artifacts under the processor version will be deleted. */
2512
2516
  delete(request?: {
@@ -2591,7 +2595,7 @@ declare namespace gapi.client {
2591
2595
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2592
2596
  uploadType?: string;
2593
2597
  },
2594
- body: GoogleCloudDocumentaiV1beta3DeployProcessorVersionRequest
2598
+ body: GoogleCloudDocumentaiV1beta3DeployProcessorVersionRequest,
2595
2599
  ): Request<GoogleLongrunningOperation>;
2596
2600
  /** Evaluates a ProcessorVersion against annotated documents, producing an Evaluation. */
2597
2601
  evaluateProcessorVersion(request: {
@@ -2649,7 +2653,7 @@ declare namespace gapi.client {
2649
2653
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2650
2654
  uploadType?: string;
2651
2655
  },
2652
- body: GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionRequest
2656
+ body: GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionRequest,
2653
2657
  ): Request<GoogleLongrunningOperation>;
2654
2658
  /** Gets a processor version detail. */
2655
2659
  get(request?: {
@@ -2734,7 +2738,7 @@ declare namespace gapi.client {
2734
2738
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2735
2739
  uploadType?: string;
2736
2740
  },
2737
- body: GoogleCloudDocumentaiV1beta3ImportProcessorVersionRequest
2741
+ body: GoogleCloudDocumentaiV1beta3ImportProcessorVersionRequest,
2738
2742
  ): Request<GoogleLongrunningOperation>;
2739
2743
  /** Lists all versions of a processor. */
2740
2744
  list(request?: {
@@ -2823,7 +2827,7 @@ declare namespace gapi.client {
2823
2827
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2824
2828
  uploadType?: string;
2825
2829
  },
2826
- body: GoogleCloudDocumentaiV1beta3ProcessRequest
2830
+ body: GoogleCloudDocumentaiV1beta3ProcessRequest,
2827
2831
  ): Request<GoogleCloudDocumentaiV1beta3ProcessResponse>;
2828
2832
  /** Trains a new processor version. Operation metadata is returned as TrainProcessorVersionMetadata. */
2829
2833
  train(request: {
@@ -2881,7 +2885,7 @@ declare namespace gapi.client {
2881
2885
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2882
2886
  uploadType?: string;
2883
2887
  },
2884
- body: GoogleCloudDocumentaiV1beta3TrainProcessorVersionRequest
2888
+ body: GoogleCloudDocumentaiV1beta3TrainProcessorVersionRequest,
2885
2889
  ): Request<GoogleLongrunningOperation>;
2886
2890
  /** Undeploys the processor version. */
2887
2891
  undeploy(request: {
@@ -2939,7 +2943,7 @@ declare namespace gapi.client {
2939
2943
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2940
2944
  uploadType?: string;
2941
2945
  },
2942
- body: GoogleCloudDocumentaiV1beta3UndeployProcessorVersionRequest
2946
+ body: GoogleCloudDocumentaiV1beta3UndeployProcessorVersionRequest,
2943
2947
  ): Request<GoogleLongrunningOperation>;
2944
2948
  evaluations: EvaluationsResource;
2945
2949
  }
@@ -3000,7 +3004,7 @@ declare namespace gapi.client {
3000
3004
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3001
3005
  uploadType?: string;
3002
3006
  },
3003
- body: GoogleCloudDocumentaiV1beta3BatchProcessRequest
3007
+ body: GoogleCloudDocumentaiV1beta3BatchProcessRequest,
3004
3008
  ): Request<GoogleLongrunningOperation>;
3005
3009
  /** Creates a processor from the ProcessorType provided. The processor will be at `ENABLED` state by default after its creation. Note that this method requires the `documentai.processors.create` permission on the project, which is highly privileged. A user or service account with this permission can create new processors that can interact with any gcs bucket in your project. */
3006
3010
  create(request: {
@@ -3058,7 +3062,7 @@ declare namespace gapi.client {
3058
3062
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3059
3063
  uploadType?: string;
3060
3064
  },
3061
- body: GoogleCloudDocumentaiV1beta3Processor
3065
+ body: GoogleCloudDocumentaiV1beta3Processor,
3062
3066
  ): Request<GoogleCloudDocumentaiV1beta3Processor>;
3063
3067
  /** Deletes the processor, unloads all deployed model artifacts if it was enabled and then deletes all artifacts associated with this processor. */
3064
3068
  delete(request?: {
@@ -3143,7 +3147,7 @@ declare namespace gapi.client {
3143
3147
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3144
3148
  uploadType?: string;
3145
3149
  },
3146
- body: GoogleCloudDocumentaiV1beta3DisableProcessorRequest
3150
+ body: GoogleCloudDocumentaiV1beta3DisableProcessorRequest,
3147
3151
  ): Request<GoogleLongrunningOperation>;
3148
3152
  /** Enables a processor */
3149
3153
  enable(request: {
@@ -3201,7 +3205,7 @@ declare namespace gapi.client {
3201
3205
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3202
3206
  uploadType?: string;
3203
3207
  },
3204
- body: GoogleCloudDocumentaiV1beta3EnableProcessorRequest
3208
+ body: GoogleCloudDocumentaiV1beta3EnableProcessorRequest,
3205
3209
  ): Request<GoogleLongrunningOperation>;
3206
3210
  /** Gets a processor detail. */
3207
3211
  get(request?: {
@@ -3317,7 +3321,7 @@ declare namespace gapi.client {
3317
3321
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3318
3322
  uploadType?: string;
3319
3323
  },
3320
- body: GoogleCloudDocumentaiV1beta3ProcessRequest
3324
+ body: GoogleCloudDocumentaiV1beta3ProcessRequest,
3321
3325
  ): Request<GoogleCloudDocumentaiV1beta3ProcessResponse>;
3322
3326
  /** Set the default (active) version of a Processor that will be used in ProcessDocument and BatchProcessDocuments. */
3323
3327
  setDefaultProcessorVersion(request: {
@@ -3375,7 +3379,7 @@ declare namespace gapi.client {
3375
3379
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3376
3380
  uploadType?: string;
3377
3381
  },
3378
- body: GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionRequest
3382
+ body: GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionRequest,
3379
3383
  ): Request<GoogleLongrunningOperation>;
3380
3384
  /** Updates metadata associated with a dataset. Note that this method requires the `documentai.googleapis.com/datasets.update` permission on the project, which is highly privileged. A user or service account with this permission can create new processors that can interact with any gcs bucket in your project. */
3381
3385
  updateDataset(request: {
@@ -3437,7 +3441,7 @@ declare namespace gapi.client {
3437
3441
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3438
3442
  uploadType?: string;
3439
3443
  },
3440
- body: GoogleCloudDocumentaiV1beta3Dataset
3444
+ body: GoogleCloudDocumentaiV1beta3Dataset,
3441
3445
  ): Request<GoogleLongrunningOperation>;
3442
3446
  dataset: DatasetResource;
3443
3447
  humanReviewConfig: HumanReviewConfigResource;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.documentai-v1beta3",
3
- "version": "0.0.20250117",
3
+ "version": "0.0.20250128",
4
4
  "description": "TypeScript typings for Cloud Document AI API v1beta3",
5
5
  "repository": {
6
6
  "type": "git",
package/readme.md CHANGED
@@ -30,7 +30,7 @@ gapi.client.load(
30
30
  () => {
31
31
  // now we can use:
32
32
  // gapi.client.documentai
33
- }
33
+ },
34
34
  );
35
35
  ```
36
36
 
@@ -62,7 +62,7 @@ gapi.auth.authorize(
62
62
  } else {
63
63
  /* handle authorization error */
64
64
  }
65
- }
65
+ },
66
66
  );
67
67
  ```
68
68