@maxim_mazurok/gapi.client.aiplatform-v1beta1 0.0.20231024 → 0.0.20231101

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 +148 -1
  2. package/package.json +1 -1
  3. package/tests.ts +146 -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://aiplatform.googleapis.com/$discovery/rest?version=v1beta1
12
- // Revision: 20231024
12
+ // Revision: 20231101
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -337,6 +337,14 @@ declare namespace gapi.client {
337
337
  startingReplicaCount?:
338
338
  number;
339
339
  }
340
+ interface GoogleCloudAiplatformV1beta1BatchDeletePipelineJobsRequest {
341
+ /**
342
+ * Required. The names of the PipelineJobs to delete. A maximum of 32 PipelineJobs can be deleted in a batch. Format:
343
+ * `projects/{project}/locations/{location}/pipelineJobs/{pipelineJob}`
344
+ */
345
+ names?:
346
+ string[];
347
+ }
340
348
  interface GoogleCloudAiplatformV1beta1BatchImportEvaluatedAnnotationsRequest {
341
349
  /** Required. Evaluated annotations resource to be imported. */
342
350
  evaluatedAnnotations?:
@@ -2067,6 +2075,12 @@ declare namespace gapi.client {
2067
2075
  string;
2068
2076
  }
2069
2077
  interface GoogleCloudAiplatformV1beta1ExplainRequest {
2078
+ /**
2079
+ * Optional. This field is the same as the one above, but supports multiple explanations to occur in parallel. The key can be any string. Each override will be run against the model,
2080
+ * then its explanations will be grouped together. Note - these explanations are run **In Addition** to the default Explanation in the deployed model.
2081
+ */
2082
+ concurrentExplanationSpecOverride?:
2083
+ { [P in string]: GoogleCloudAiplatformV1beta1ExplanationSpecOverride };
2070
2084
  /** If specified, this ExplainRequest will be served by the chosen DeployedModel, overriding Endpoint.traffic_split. */
2071
2085
  deployedModelId?:
2072
2086
  string;
@@ -2089,6 +2103,9 @@ declare namespace gapi.client {
2089
2103
  any;
2090
2104
  }
2091
2105
  interface GoogleCloudAiplatformV1beta1ExplainResponse {
2106
+ /** This field stores the results of the explanations run in parallel with The default explanation strategy/method. */
2107
+ concurrentExplanations?:
2108
+ { [P in string]: GoogleCloudAiplatformV1beta1ExplainResponseConcurrentExplanation };
2092
2109
  /** ID of the Endpoint's DeployedModel that served this explanation. */
2093
2110
  deployedModelId?:
2094
2111
  string;
@@ -2099,6 +2116,11 @@ declare namespace gapi.client {
2099
2116
  predictions?:
2100
2117
  any[];
2101
2118
  }
2119
+ interface GoogleCloudAiplatformV1beta1ExplainResponseConcurrentExplanation {
2120
+ /** The explanations of the Model's PredictResponse.predictions. It has the same number of elements as instances to be explained. */
2121
+ explanations?:
2122
+ GoogleCloudAiplatformV1beta1Explanation[];
2123
+ }
2102
2124
  interface GoogleCloudAiplatformV1beta1Explanation {
2103
2125
  /**
2104
2126
  * Output only. Feature attributions grouped by predicted outputs. For Models that predict only one output, such as regression Models that predict only one score, there is only one
@@ -2569,6 +2591,9 @@ declare namespace gapi.client {
2569
2591
  /** Immutable. Only applicable for Vertex AI Feature Store (Legacy). Type of Feature value. */
2570
2592
  valueType?:
2571
2593
  string;
2594
+ /** Only applicable for Vertex AI Feature Store. The name of the BigQuery Table/View columnn hosting data for this version. If no value is provided, will use feature_id. */
2595
+ versionColumnName?:
2596
+ string;
2572
2597
  }
2573
2598
  interface GoogleCloudAiplatformV1beta1FeatureGroup {
2574
2599
  /**
@@ -2660,6 +2685,12 @@ declare namespace gapi.client {
2660
2685
  /** Output only. Name of the FeatureOnlineStore. Format: `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}` */
2661
2686
  name?:
2662
2687
  string;
2688
+ /**
2689
+ * Contains settings for the Optimized store that will be created to serve featureValues for all FeatureViews under this FeatureOnlineStore. When choose Optimized storage type, need to
2690
+ * set PrivateServiceConnectConfig.enable_private_service_connect to use private endpoint. Otherwise will use public endpoint by default.
2691
+ */
2692
+ optimized?:
2693
+ any;
2663
2694
  /** Output only. State of the featureOnlineStore. */
2664
2695
  state?:
2665
2696
  string;
@@ -2687,15 +2718,27 @@ declare namespace gapi.client {
2687
2718
  number;
2688
2719
  }
2689
2720
  interface GoogleCloudAiplatformV1beta1FeatureOnlineStoreDedicatedServingEndpoint {
2721
+ /**
2722
+ * Optional. Private service connect config. If PrivateServiceConnectConfig.enable_private_service_connect set to true, customers will use private service connection to send request.
2723
+ * Otherwise, the connection will set to public endpoint.
2724
+ */
2725
+ privateServiceConnectConfig?:
2726
+ GoogleCloudAiplatformV1beta1PrivateServiceConnectConfig;
2690
2727
  /** Output only. This field will be populated with the domain name to use for this FeatureOnlineStore */
2691
2728
  publicEndpointDomainName?:
2692
2729
  string;
2730
+ /** Output only. The name of the service attachment resource. Populated if private service connect is enabled and after FeatureViewSync is created. */
2731
+ serviceAttachment?:
2732
+ string;
2693
2733
  }
2694
2734
  interface GoogleCloudAiplatformV1beta1FeatureOnlineStoreEmbeddingManagement {
2695
2735
  /** Optional. Immutable. Whether to enable embedding management in this FeatureOnlineStore. It's immutable after creation to ensure the FeatureOnlineStore availability. */
2696
2736
  enabled?:
2697
2737
  boolean;
2698
2738
  }
2739
+ // tslint:disable-next-line:no-empty-interface
2740
+ interface GoogleCloudAiplatformV1beta1FeatureOnlineStoreOptimized {
2741
+ }
2699
2742
  interface GoogleCloudAiplatformV1beta1FeatureSelector {
2700
2743
  /** Required. Matches Features based on ID. */
2701
2744
  idMatcher?:
@@ -3500,6 +3543,12 @@ declare namespace gapi.client {
3500
3543
  /** Required. Feature embedding vector. An array of numbers with the length of [NearestNeighborSearchConfig.dimensions]. */
3501
3544
  featureVector?:
3502
3545
  number[];
3546
+ /**
3547
+ * Optional. List of Restrict of the datapoint, used to perform "restricted searches" where boolean rule are used to filter the subset of the database eligible for matching. This uses
3548
+ * numeric comparisons.
3549
+ */
3550
+ numericRestricts?:
3551
+ GoogleCloudAiplatformV1beta1IndexDatapointNumericRestriction[];
3503
3552
  /**
3504
3553
  * Optional. List of Restrict of the datapoint, used to perform "restricted searches" where boolean rule are used to filter the subset of the database eligible for matching. This uses
3505
3554
  * categorical tokens. See: https://cloud.google.com/vertex-ai/docs/matching-engine/filtering
@@ -3515,6 +3564,23 @@ declare namespace gapi.client {
3515
3564
  crowdingAttribute?:
3516
3565
  string;
3517
3566
  }
3567
+ interface GoogleCloudAiplatformV1beta1IndexDatapointNumericRestriction {
3568
+ /** The namespace of this restriction. e.g.: cost. */
3569
+ namespace?:
3570
+ string;
3571
+ /** This MUST be specified for queries and must NOT be specified for datapoints. */
3572
+ op?:
3573
+ string;
3574
+ /** Represents 64 bit float. */
3575
+ valueDouble?:
3576
+ number;
3577
+ /** Represents 32 bit float. */
3578
+ valueFloat?:
3579
+ number;
3580
+ /** Represents 64 bit integer. */
3581
+ valueInt?:
3582
+ string;
3583
+ }
3518
3584
  interface GoogleCloudAiplatformV1beta1IndexDatapointRestriction {
3519
3585
  /** The attributes to allow in this namespace. e.g.: 'red' */
3520
3586
  allowList?:
@@ -31692,6 +31758,87 @@ declare namespace gapi.client {
31692
31758
  }): Request<GoogleLongrunningOperation>;
31693
31759
  }
31694
31760
  interface PipelineJobsResource {
31761
+ /** Batch deletes PipelineJobs The Operation is atomic. If it fails, none of the PipelineJobs are deleted. If it succeeds, all of the PipelineJobs are deleted. */
31762
+ batchDelete(request: {
31763
+ /** V1 error format. */
31764
+ "$.xgafv"?:
31765
+ string;
31766
+ /** OAuth access token. */
31767
+ access_token?:
31768
+ string;
31769
+ /** Data format for response. */
31770
+ alt?:
31771
+ string;
31772
+ /** JSONP */
31773
+ callback?:
31774
+ string;
31775
+ /** Selector specifying which fields to include in a partial response. */
31776
+ fields?:
31777
+ string;
31778
+ /** 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. */
31779
+ key?:
31780
+ string;
31781
+ /** OAuth 2.0 token for the current user. */
31782
+ oauth_token?:
31783
+ string;
31784
+ /** Required. The name of the PipelineJobs' parent resource. Format: `projects/{project}/locations/{location}` */
31785
+ parent:
31786
+ string;
31787
+ /** Returns response with indentations and line breaks. */
31788
+ prettyPrint?:
31789
+ boolean;
31790
+ /** 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. */
31791
+ quotaUser?:
31792
+ string;
31793
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
31794
+ upload_protocol?:
31795
+ string;
31796
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
31797
+ uploadType?:
31798
+ string;
31799
+ /** Request body */
31800
+ resource:
31801
+ GoogleCloudAiplatformV1beta1BatchDeletePipelineJobsRequest;
31802
+ }): Request<GoogleLongrunningOperation>;
31803
+ batchDelete(request: {
31804
+ /** V1 error format. */
31805
+ "$.xgafv"?:
31806
+ string;
31807
+ /** OAuth access token. */
31808
+ access_token?:
31809
+ string;
31810
+ /** Data format for response. */
31811
+ alt?:
31812
+ string;
31813
+ /** JSONP */
31814
+ callback?:
31815
+ string;
31816
+ /** Selector specifying which fields to include in a partial response. */
31817
+ fields?:
31818
+ string;
31819
+ /** 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. */
31820
+ key?:
31821
+ string;
31822
+ /** OAuth 2.0 token for the current user. */
31823
+ oauth_token?:
31824
+ string;
31825
+ /** Required. The name of the PipelineJobs' parent resource. Format: `projects/{project}/locations/{location}` */
31826
+ parent:
31827
+ string;
31828
+ /** Returns response with indentations and line breaks. */
31829
+ prettyPrint?:
31830
+ boolean;
31831
+ /** 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. */
31832
+ quotaUser?:
31833
+ string;
31834
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
31835
+ upload_protocol?:
31836
+ string;
31837
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
31838
+ uploadType?:
31839
+ string;
31840
+ },
31841
+ body: GoogleCloudAiplatformV1beta1BatchDeletePipelineJobsRequest): Request<GoogleLongrunningOperation>;
31695
31842
  /**
31696
31843
  * Cancels a PipelineJob. Starts asynchronous cancellation on the PipelineJob. The server makes a best effort to cancel the pipeline, but success is not guaranteed. Clients can use
31697
31844
  * PipelineService.GetPipelineJob or other methods to check whether the cancellation succeeded or whether the pipeline completed despite cancellation. On successful cancellation, the
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.aiplatform-v1beta1",
3
- "version": "0.0.20231024",
3
+ "version": "0.0.20231101",
4
4
  "description": "TypeScript typings for Vertex AI API v1beta1",
5
5
  "license": "MIT",
6
6
  "author": {
package/tests.ts CHANGED
@@ -3,7 +3,7 @@
3
3
  // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
4
4
  // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
5
5
 
6
- // Revision: 20231024
6
+ // Revision: 20231101
7
7
 
8
8
  gapi.load('client', async () => {
9
9
  /** now we can use gapi.client */
@@ -1596,6 +1596,102 @@ gapi.load('client', async () => {
1596
1596
  await gapi.client.aiplatform.projects.locations.endpoints.explain({
1597
1597
  endpoint: "Test string",
1598
1598
  }, {
1599
+ concurrentExplanationSpecOverride: {
1600
+ A: {
1601
+ examplesOverride: {
1602
+ crowdingCount: 42,
1603
+ dataFormat: "Test string",
1604
+ neighborCount: 42,
1605
+ restrictions: [
1606
+ {
1607
+ allow: [
1608
+ "Test string"
1609
+ ],
1610
+ deny: [
1611
+ "Test string"
1612
+ ],
1613
+ namespaceName: "Test string",
1614
+ }
1615
+ ],
1616
+ returnEmbeddings: true,
1617
+ },
1618
+ metadata: {
1619
+ inputs: {
1620
+ A: {
1621
+ inputBaselines: [
1622
+ 42
1623
+ ],
1624
+ }
1625
+ },
1626
+ },
1627
+ parameters: {
1628
+ examples: {
1629
+ exampleGcsSource: {
1630
+ dataFormat: "Test string",
1631
+ gcsSource: {
1632
+ uris: [
1633
+ "Test string"
1634
+ ],
1635
+ },
1636
+ },
1637
+ gcsSource: {
1638
+ uris: [
1639
+ "Test string"
1640
+ ],
1641
+ },
1642
+ nearestNeighborSearchConfig: 42,
1643
+ neighborCount: 42,
1644
+ presets: {
1645
+ modality: "Test string",
1646
+ query: "Test string",
1647
+ },
1648
+ },
1649
+ integratedGradientsAttribution: {
1650
+ blurBaselineConfig: {
1651
+ maxBlurSigma: 42,
1652
+ },
1653
+ smoothGradConfig: {
1654
+ featureNoiseSigma: {
1655
+ noiseSigma: [
1656
+ {
1657
+ name: "Test string",
1658
+ sigma: 42,
1659
+ }
1660
+ ],
1661
+ },
1662
+ noiseSigma: 42,
1663
+ noisySampleCount: 42,
1664
+ },
1665
+ stepCount: 42,
1666
+ },
1667
+ outputIndices: [
1668
+ 42
1669
+ ],
1670
+ sampledShapleyAttribution: {
1671
+ pathCount: 42,
1672
+ },
1673
+ topK: 42,
1674
+ xraiAttribution: {
1675
+ blurBaselineConfig: {
1676
+ maxBlurSigma: 42,
1677
+ },
1678
+ smoothGradConfig: {
1679
+ featureNoiseSigma: {
1680
+ noiseSigma: [
1681
+ {
1682
+ name: "Test string",
1683
+ sigma: 42,
1684
+ }
1685
+ ],
1686
+ },
1687
+ noiseSigma: 42,
1688
+ noisySampleCount: 42,
1689
+ },
1690
+ stepCount: 42,
1691
+ },
1692
+ },
1693
+ }
1694
+ },
1599
1695
  deployedModelId: "Test string",
1600
1696
  explanationSpecOverride: {
1601
1697
  examplesOverride: {
@@ -2469,6 +2565,7 @@ gapi.load('client', async () => {
2469
2565
  name: "Test string",
2470
2566
  updateTime: "Test string",
2471
2567
  valueType: "Test string",
2568
+ versionColumnName: "Test string",
2472
2569
  });
2473
2570
  /** Deletes a single Feature. */
2474
2571
  await gapi.client.aiplatform.projects.locations.featureGroups.features.delete({
@@ -2546,6 +2643,7 @@ gapi.load('client', async () => {
2546
2643
  name: "Test string",
2547
2644
  updateTime: "Test string",
2548
2645
  valueType: "Test string",
2646
+ versionColumnName: "Test string",
2549
2647
  });
2550
2648
  /**
2551
2649
  * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support
@@ -2617,7 +2715,14 @@ gapi.load('client', async () => {
2617
2715
  },
2618
2716
  createTime: "Test string",
2619
2717
  dedicatedServingEndpoint: {
2718
+ privateServiceConnectConfig: {
2719
+ enablePrivateServiceConnect: true,
2720
+ projectAllowlist: [
2721
+ "Test string"
2722
+ ],
2723
+ },
2620
2724
  publicEndpointDomainName: "Test string",
2725
+ serviceAttachment: "Test string",
2621
2726
  },
2622
2727
  embeddingManagement: {
2623
2728
  enabled: true,
@@ -2627,6 +2732,8 @@ gapi.load('client', async () => {
2627
2732
  A: "Test string"
2628
2733
  },
2629
2734
  name: "Test string",
2735
+ optimized: {
2736
+ },
2630
2737
  state: "Test string",
2631
2738
  updateTime: "Test string",
2632
2739
  });
@@ -2661,7 +2768,14 @@ gapi.load('client', async () => {
2661
2768
  },
2662
2769
  createTime: "Test string",
2663
2770
  dedicatedServingEndpoint: {
2771
+ privateServiceConnectConfig: {
2772
+ enablePrivateServiceConnect: true,
2773
+ projectAllowlist: [
2774
+ "Test string"
2775
+ ],
2776
+ },
2664
2777
  publicEndpointDomainName: "Test string",
2778
+ serviceAttachment: "Test string",
2665
2779
  },
2666
2780
  embeddingManagement: {
2667
2781
  enabled: true,
@@ -2671,6 +2785,8 @@ gapi.load('client', async () => {
2671
2785
  A: "Test string"
2672
2786
  },
2673
2787
  name: "Test string",
2788
+ optimized: {
2789
+ },
2674
2790
  state: "Test string",
2675
2791
  updateTime: "Test string",
2676
2792
  });
@@ -3440,6 +3556,7 @@ gapi.load('client', async () => {
3440
3556
  name: "Test string",
3441
3557
  updateTime: "Test string",
3442
3558
  valueType: "Test string",
3559
+ versionColumnName: "Test string",
3443
3560
  },
3444
3561
  featureId: "Test string",
3445
3562
  parent: "Test string",
@@ -3504,6 +3621,7 @@ gapi.load('client', async () => {
3504
3621
  name: "Test string",
3505
3622
  updateTime: "Test string",
3506
3623
  valueType: "Test string",
3624
+ versionColumnName: "Test string",
3507
3625
  });
3508
3626
  /** Deletes a single Feature. */
3509
3627
  await gapi.client.aiplatform.projects.locations.featurestores.entityTypes.features.delete({
@@ -3581,6 +3699,7 @@ gapi.load('client', async () => {
3581
3699
  name: "Test string",
3582
3700
  updateTime: "Test string",
3583
3701
  valueType: "Test string",
3702
+ versionColumnName: "Test string",
3584
3703
  });
3585
3704
  /**
3586
3705
  * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this
@@ -4155,6 +4274,15 @@ gapi.load('client', async () => {
4155
4274
  featureVector: [
4156
4275
  42
4157
4276
  ],
4277
+ numericRestricts: [
4278
+ {
4279
+ namespace: "Test string",
4280
+ op: "Test string",
4281
+ valueDouble: 42,
4282
+ valueFloat: 42,
4283
+ valueInt: "Test string",
4284
+ }
4285
+ ],
4158
4286
  restricts: [
4159
4287
  {
4160
4288
  allowList: [
@@ -4461,6 +4589,15 @@ gapi.load('client', async () => {
4461
4589
  featureVector: [
4462
4590
  42
4463
4591
  ],
4592
+ numericRestricts: [
4593
+ {
4594
+ namespace: "Test string",
4595
+ op: "Test string",
4596
+ valueDouble: 42,
4597
+ valueFloat: 42,
4598
+ valueInt: "Test string",
4599
+ }
4600
+ ],
4464
4601
  restricts: [
4465
4602
  {
4466
4603
  allowList: [
@@ -6847,6 +6984,14 @@ gapi.load('client', async () => {
6847
6984
  name: "Test string",
6848
6985
  timeout: "Test string",
6849
6986
  });
6987
+ /** Batch deletes PipelineJobs The Operation is atomic. If it fails, none of the PipelineJobs are deleted. If it succeeds, all of the PipelineJobs are deleted. */
6988
+ await gapi.client.aiplatform.projects.locations.pipelineJobs.batchDelete({
6989
+ parent: "Test string",
6990
+ }, {
6991
+ names: [
6992
+ "Test string"
6993
+ ],
6994
+ });
6850
6995
  /**
6851
6996
  * Cancels a PipelineJob. Starts asynchronous cancellation on the PipelineJob. The server makes a best effort to cancel the pipeline, but success is not guaranteed. Clients can use
6852
6997
  * PipelineService.GetPipelineJob or other methods to check whether the cancellation succeeded or whether the pipeline completed despite cancellation. On successful cancellation, the