@maxim_mazurok/gapi.client.aiplatform-v1beta1 0.0.20240213 → 0.0.20240224
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 +76 -13
- 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://aiplatform.googleapis.com/$discovery/rest?version=v1beta1
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20240224
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -59,10 +59,12 @@ declare namespace gapi.client {
|
|
|
59
59
|
image?: string;
|
|
60
60
|
/** RAI scores for generated image. */
|
|
61
61
|
imageRaiScores?: CloudAiLargeModelsVisionImageRAIScores;
|
|
62
|
-
/** RAI info for image */
|
|
62
|
+
/** RAI info for image. */
|
|
63
63
|
raiInfo?: CloudAiLargeModelsVisionRaiInfo;
|
|
64
64
|
/** Semantic filter info for image. */
|
|
65
65
|
semanticFilterResponse?: CloudAiLargeModelsVisionSemanticFilterResponse;
|
|
66
|
+
/** Text/Expanded text input for imagen. */
|
|
67
|
+
text?: string;
|
|
66
68
|
/** Path to another storage (typically Google Cloud Storage). */
|
|
67
69
|
uri?: string;
|
|
68
70
|
}
|
|
@@ -945,8 +947,6 @@ declare namespace gapi.client {
|
|
|
945
947
|
pipelineJob?: GoogleCloudAiplatformV1beta1PipelineJob;
|
|
946
948
|
/** The ID to use for the PipelineJob, which will become the final component of the PipelineJob name. If not provided, an ID will be automatically generated. This value should be less than 128 characters, and valid characters are `/a-z-/`. */
|
|
947
949
|
pipelineJobId?: string;
|
|
948
|
-
/** Optional. Whether to do component level validations before job creation. Currently we only support Google First Party Component/Pipelines. */
|
|
949
|
-
preflightValidations?: boolean;
|
|
950
950
|
}
|
|
951
951
|
interface GoogleCloudAiplatformV1beta1CreateRegistryFeatureOperationMetadata {
|
|
952
952
|
/** Operation metadata for Feature. */
|
|
@@ -1137,8 +1137,12 @@ declare namespace gapi.client {
|
|
|
1137
1137
|
bigQueryDatasetName?: string;
|
|
1138
1138
|
/** Output only. Timestamp when this DatasetVersion was created. */
|
|
1139
1139
|
createTime?: string;
|
|
1140
|
+
/** The user-defined name of the DatasetVersion. The name can be up to 128 characters long and can consist of any UTF-8 characters. */
|
|
1141
|
+
displayName?: string;
|
|
1140
1142
|
/** Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. */
|
|
1141
1143
|
etag?: string;
|
|
1144
|
+
/** Required. Additional information about the DatasetVersion. */
|
|
1145
|
+
metadata?: any;
|
|
1142
1146
|
/** Output only. The resource name of the DatasetVersion. */
|
|
1143
1147
|
name?: string;
|
|
1144
1148
|
/** Output only. Timestamp when this DatasetVersion was last updated. */
|
|
@@ -1805,6 +1809,8 @@ declare namespace gapi.client {
|
|
|
1805
1809
|
monitoringStatsAnomalies?: GoogleCloudAiplatformV1beta1FeatureMonitoringStatsAnomaly[];
|
|
1806
1810
|
/** Immutable. Name of the Feature. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/features/{feature}` `projects/{project}/locations/{location}/featureGroups/{feature_group}/features/{feature}` The last part feature is assigned by the client. The feature can be up to 64 characters long and can consist only of ASCII Latin letters A-Z and a-z, underscore(_), and ASCII digits 0-9 starting with a letter. The value will be unique given an entity type. */
|
|
1807
1811
|
name?: string;
|
|
1812
|
+
/** Entity responsible for maintaining this feature. Can be comma separated list of email addresses or URIs. */
|
|
1813
|
+
pointOfContact?: string;
|
|
1808
1814
|
/** Output only. Only applicable for Vertex AI Feature Store (Legacy). Timestamp when this EntityType was most recently updated. */
|
|
1809
1815
|
updateTime?: string;
|
|
1810
1816
|
/** Immutable. Only applicable for Vertex AI Feature Store (Legacy). Type of Feature value. */
|
|
@@ -1831,7 +1837,7 @@ declare namespace gapi.client {
|
|
|
1831
1837
|
interface GoogleCloudAiplatformV1beta1FeatureGroupBigQuery {
|
|
1832
1838
|
/** Required. Immutable. The BigQuery source URI that points to either a BigQuery Table or View. */
|
|
1833
1839
|
bigQuerySource?: GoogleCloudAiplatformV1beta1BigQuerySource;
|
|
1834
|
-
/** Optional. Columns to construct entity_id / row keys.
|
|
1840
|
+
/** Optional. Columns to construct entity_id / row keys. If not provided defaults to `entity_id`. */
|
|
1835
1841
|
entityIdColumns?: string[];
|
|
1836
1842
|
}
|
|
1837
1843
|
interface GoogleCloudAiplatformV1beta1FeatureMonitoringStatsAnomaly {
|
|
@@ -2032,6 +2038,10 @@ declare namespace gapi.client {
|
|
|
2032
2038
|
labels?: {[P in string]: string};
|
|
2033
2039
|
/** Identifier. Name of the FeatureView. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}` */
|
|
2034
2040
|
name?: string;
|
|
2041
|
+
/** Output only. A Service Account unique to this FeatureView. The role bigquery.dataViewer should be granted to this service account to allow Vertex AI Feature Store to sync data to the online store. */
|
|
2042
|
+
serviceAccountEmail?: string;
|
|
2043
|
+
/** Optional. Service agent type used during data sync. By default, the Vertex AI Service Agent is used. When using an IAM Policy to isolate this FeatureView within a project (https://cloud.google.com/vertex-ai/docs/featurestore/latest/resource-policy) a separate service account should be provisioned by setting this field to `SERVICE_AGENT_TYPE_FEATURE_VIEW`. This will generate a separate service account to access the BigQuery source table. */
|
|
2044
|
+
serviceAgentType?: string;
|
|
2035
2045
|
/** Configures when data is to be synced/updated for this FeatureView. At the end of the sync the latest featureValues for each entityId of this FeatureView are made ready for online serving. */
|
|
2036
2046
|
syncConfig?: GoogleCloudAiplatformV1beta1FeatureViewSyncConfig;
|
|
2037
2047
|
/** Output only. Timestamp when this FeatureView was last updated. */
|
|
@@ -2040,15 +2050,21 @@ declare namespace gapi.client {
|
|
|
2040
2050
|
vectorSearchConfig?: GoogleCloudAiplatformV1beta1FeatureViewVectorSearchConfig;
|
|
2041
2051
|
}
|
|
2042
2052
|
interface GoogleCloudAiplatformV1beta1FeatureViewBigQuerySource {
|
|
2043
|
-
/** Required. Columns to construct entity_id / row keys.
|
|
2053
|
+
/** Required. Columns to construct entity_id / row keys. */
|
|
2044
2054
|
entityIdColumns?: string[];
|
|
2045
2055
|
/** Required. The BigQuery view URI that will be materialized on each sync trigger based on FeatureView.SyncConfig. */
|
|
2046
2056
|
uri?: string;
|
|
2047
2057
|
}
|
|
2048
2058
|
interface GoogleCloudAiplatformV1beta1FeatureViewDataKey {
|
|
2059
|
+
/** The actual Entity ID will be composed from this struct. This should match with the way ID is defined in the FeatureView spec. */
|
|
2060
|
+
compositeKey?: GoogleCloudAiplatformV1beta1FeatureViewDataKeyCompositeKey;
|
|
2049
2061
|
/** String key to use for lookup. */
|
|
2050
2062
|
key?: string;
|
|
2051
2063
|
}
|
|
2064
|
+
interface GoogleCloudAiplatformV1beta1FeatureViewDataKeyCompositeKey {
|
|
2065
|
+
/** Parts to construct Entity ID. Should match with the same ID columns as defined in FeatureView in the same order. */
|
|
2066
|
+
parts?: string[];
|
|
2067
|
+
}
|
|
2052
2068
|
interface GoogleCloudAiplatformV1beta1FeatureViewFeatureRegistrySource {
|
|
2053
2069
|
/** Required. List of features that need to be synced to Online Store. */
|
|
2054
2070
|
featureGroups?: GoogleCloudAiplatformV1beta1FeatureViewFeatureRegistrySourceFeatureGroup[];
|
|
@@ -2285,6 +2301,10 @@ declare namespace gapi.client {
|
|
|
2285
2301
|
/** Output only. Time when the operation was updated for the last time. If the operation has finished (successfully or not), this is the finish time. */
|
|
2286
2302
|
updateTime?: string;
|
|
2287
2303
|
}
|
|
2304
|
+
interface GoogleCloudAiplatformV1beta1GenieSource {
|
|
2305
|
+
/** Required. The public base model URI. */
|
|
2306
|
+
baseModelUri?: string;
|
|
2307
|
+
}
|
|
2288
2308
|
interface GoogleCloudAiplatformV1beta1GoogleSearchRetrieval {
|
|
2289
2309
|
/** Optional. Disable using the result from this tool in detecting grounding attribution. This does not affect how the result is given to the model for generation. */
|
|
2290
2310
|
disableAttribution?: boolean;
|
|
@@ -3036,6 +3056,8 @@ declare namespace gapi.client {
|
|
|
3036
3056
|
interface GoogleCloudAiplatformV1beta1Model {
|
|
3037
3057
|
/** Immutable. The path to the directory containing the Model artifact and any of its supporting files. Not required for AutoML Models. */
|
|
3038
3058
|
artifactUri?: string;
|
|
3059
|
+
/** Optional. User input field to specify the base model source. Currently it only supports specifing the Model Garden models and Genie models. */
|
|
3060
|
+
baseModelSource?: GoogleCloudAiplatformV1beta1ModelBaseModelSource;
|
|
3039
3061
|
/** Input only. The specification of the container that is to be used when deploying this Model. The specification is ingested upon ModelService.UploadModel, and all binaries it contains are copied and stored internally by Vertex AI. Not required for AutoML Models. */
|
|
3040
3062
|
containerSpec?: GoogleCloudAiplatformV1beta1ModelContainerSpec;
|
|
3041
3063
|
/** Output only. Timestamp when this Model was uploaded into Vertex AI. */
|
|
@@ -3091,6 +3113,12 @@ declare namespace gapi.client {
|
|
|
3091
3113
|
/** Output only. Timestamp when this version was most recently updated. */
|
|
3092
3114
|
versionUpdateTime?: string;
|
|
3093
3115
|
}
|
|
3116
|
+
interface GoogleCloudAiplatformV1beta1ModelBaseModelSource {
|
|
3117
|
+
/** Information about the base model of Genie models. */
|
|
3118
|
+
genieSource?: GoogleCloudAiplatformV1beta1GenieSource;
|
|
3119
|
+
/** Source information of Model Garden models. */
|
|
3120
|
+
modelGardenSource?: GoogleCloudAiplatformV1beta1ModelGardenSource;
|
|
3121
|
+
}
|
|
3094
3122
|
interface GoogleCloudAiplatformV1beta1ModelContainerSpec {
|
|
3095
3123
|
/** Immutable. Specifies arguments for the command that runs when the container starts. This overrides the container's [`CMD`](https://docs.docker.com/engine/reference/builder/#cmd). Specify this field as an array of executable and arguments, similar to a Docker `CMD`'s "default parameters" form. If you don't specify this field but do specify the command field, then the command from the `command` field runs without any additional arguments. See the [Kubernetes documentation about how the `command` and `args` fields interact with a container's `ENTRYPOINT` and `CMD`](https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#notes). If you don't specify this field and don't specify the `command` field, then the container's [`ENTRYPOINT`](https://docs.docker.com/engine/reference/builder/#cmd) and `CMD` determine what runs based on their default behavior. See the Docker documentation about [how `CMD` and `ENTRYPOINT` interact](https://docs.docker.com/engine/reference/builder/#understand-how-cmd-and-entrypoint-interact). In this field, you can reference [environment variables set by Vertex AI](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables) and environment variables set in the env field. You cannot reference environment variables set in the Docker image. In order for environment variables to be expanded, reference them by using the following syntax: $( VARIABLE_NAME) Note that this differs from Bash variable expansion, which does not use parentheses. If a variable cannot be resolved, the reference in the input string is used unchanged. To avoid variable expansion, you can escape this syntax with `$$`; for example: $$(VARIABLE_NAME) This field corresponds to the `args` field of the Kubernetes Containers [v1 core API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). */
|
|
3096
3124
|
args?: string[];
|
|
@@ -3285,6 +3313,10 @@ declare namespace gapi.client {
|
|
|
3285
3313
|
/** Output only. The ID of the export format. The possible format IDs are: * `tflite` Used for Android mobile devices. * `edgetpu-tflite` Used for [Edge TPU](https://cloud.google.com/edge-tpu/) devices. * `tf-saved-model` A tensorflow model in SavedModel format. * `tf-js` A [TensorFlow.js](https://www.tensorflow.org/js) model that can be used in the browser and in Node.js using JavaScript. * `core-ml` Used for iOS mobile devices. * `custom-trained` A Model that was uploaded or trained by custom code. */
|
|
3286
3314
|
id?: string;
|
|
3287
3315
|
}
|
|
3316
|
+
interface GoogleCloudAiplatformV1beta1ModelGardenSource {
|
|
3317
|
+
/** Required. The model garden source model resource name. */
|
|
3318
|
+
publicModelName?: string;
|
|
3319
|
+
}
|
|
3288
3320
|
interface GoogleCloudAiplatformV1beta1ModelMonitoringAlertConfig {
|
|
3289
3321
|
/** Email alert config. */
|
|
3290
3322
|
emailAlertConfig?: GoogleCloudAiplatformV1beta1ModelMonitoringAlertConfigEmailAlertConfig;
|
|
@@ -3792,6 +3824,8 @@ declare namespace gapi.client {
|
|
|
3792
3824
|
network?: string;
|
|
3793
3825
|
/** The spec of the pipeline. */
|
|
3794
3826
|
pipelineSpec?: {[P in string]: any};
|
|
3827
|
+
/** Optional. Whether to do component level validations before job creation. */
|
|
3828
|
+
preflightValidations?: boolean;
|
|
3795
3829
|
/** A list of names for the reserved ip ranges under the VPC network that can be used for this Pipeline Job's workload. If set, we will deploy the Pipeline Job's workload within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network. Example: ['vertex-ai-ip-range']. */
|
|
3796
3830
|
reservedIpRanges?: string[];
|
|
3797
3831
|
/** Runtime config of the pipeline. */
|
|
@@ -4372,6 +4406,12 @@ declare namespace gapi.client {
|
|
|
4372
4406
|
category?: string;
|
|
4373
4407
|
/** Output only. Harm probability levels in the content. */
|
|
4374
4408
|
probability?: string;
|
|
4409
|
+
/** Output only. Harm probability score. */
|
|
4410
|
+
probabilityScore?: number;
|
|
4411
|
+
/** Output only. Harm severity levels in the content. */
|
|
4412
|
+
severity?: string;
|
|
4413
|
+
/** Output only. Harm severity score. */
|
|
4414
|
+
severityScore?: number;
|
|
4375
4415
|
}
|
|
4376
4416
|
interface GoogleCloudAiplatformV1beta1SafetySetting {
|
|
4377
4417
|
/** Required. Harm category. */
|
|
@@ -6265,11 +6305,11 @@ declare namespace gapi.client {
|
|
|
6265
6305
|
tokens?: string[];
|
|
6266
6306
|
}
|
|
6267
6307
|
interface GoogleCloudAiplatformV1beta1Tool {
|
|
6268
|
-
/** Optional. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 64 function declarations can be provided. */
|
|
6308
|
+
/** Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 64 function declarations can be provided. */
|
|
6269
6309
|
functionDeclarations?: GoogleCloudAiplatformV1beta1FunctionDeclaration[];
|
|
6270
|
-
/** Optional. Specialized retrieval tool that is powered by Google search. */
|
|
6310
|
+
/** Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. */
|
|
6271
6311
|
googleSearchRetrieval?: GoogleCloudAiplatformV1beta1GoogleSearchRetrieval;
|
|
6272
|
-
/** Optional. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation. */
|
|
6312
|
+
/** Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation. */
|
|
6273
6313
|
retrieval?: GoogleCloudAiplatformV1beta1Retrieval;
|
|
6274
6314
|
}
|
|
6275
6315
|
interface GoogleCloudAiplatformV1beta1TrainingConfig {
|
|
@@ -6853,6 +6893,31 @@ declare namespace gapi.client {
|
|
|
6853
6893
|
dataProviderOutput?: LearningGenaiRootDataProviderOutput[];
|
|
6854
6894
|
metricOutput?: LearningGenaiRootMetricOutput[];
|
|
6855
6895
|
}
|
|
6896
|
+
interface LearningGenaiRootCodeyChatMetadata {
|
|
6897
|
+
/** Indicates the programming language of the code if the message is a code chunk. */
|
|
6898
|
+
codeLanguage?: string;
|
|
6899
|
+
}
|
|
6900
|
+
interface LearningGenaiRootCodeyCheckpoint {
|
|
6901
|
+
/** Metadata that describes what was truncated at this checkpoint. */
|
|
6902
|
+
codeyTruncatorMetadata?: LearningGenaiRootCodeyTruncatorMetadata;
|
|
6903
|
+
/** Current state of the sample after truncator. */
|
|
6904
|
+
currentSample?: string;
|
|
6905
|
+
/** Postprocessor run that yielded this checkpoint. */
|
|
6906
|
+
postInferenceStep?: string;
|
|
6907
|
+
}
|
|
6908
|
+
interface LearningGenaiRootCodeyCompletionMetadata {
|
|
6909
|
+
checkpoints?: LearningGenaiRootCodeyCheckpoint[];
|
|
6910
|
+
}
|
|
6911
|
+
interface LearningGenaiRootCodeyOutput {
|
|
6912
|
+
codeyChatMetadata?: LearningGenaiRootCodeyChatMetadata;
|
|
6913
|
+
codeyCompletionMetadata?: LearningGenaiRootCodeyCompletionMetadata;
|
|
6914
|
+
}
|
|
6915
|
+
interface LearningGenaiRootCodeyTruncatorMetadata {
|
|
6916
|
+
/** Index of the current sample that trims off truncated text. */
|
|
6917
|
+
cutoffIndex?: number;
|
|
6918
|
+
/** Text that was truncated at a specific checkpoint. */
|
|
6919
|
+
truncatedText?: string;
|
|
6920
|
+
}
|
|
6856
6921
|
interface LearningGenaiRootDataProviderOutput {
|
|
6857
6922
|
name?: string;
|
|
6858
6923
|
/** If set, this DataProvider failed and this is the error message. */
|
|
@@ -7087,6 +7152,8 @@ declare namespace gapi.client {
|
|
|
7087
7152
|
interface LearningServingLlmMessageMetadata {
|
|
7088
7153
|
/** Summary of classifier output. We attach this to all messages regardless of whether classification rules triggered or not. */
|
|
7089
7154
|
classifierSummary?: LearningGenaiRootClassifierOutputSummary;
|
|
7155
|
+
/** Contains metadata related to Codey Processors. */
|
|
7156
|
+
codeyOutput?: LearningGenaiRootCodeyOutput;
|
|
7090
7157
|
currentStreamTextLength?: number;
|
|
7091
7158
|
/** Whether the corresponding message has been deleted. */
|
|
7092
7159
|
deleted?: boolean;
|
|
@@ -22731,8 +22798,6 @@ declare namespace gapi.client {
|
|
|
22731
22798
|
parent: string;
|
|
22732
22799
|
/** The ID to use for the PipelineJob, which will become the final component of the PipelineJob name. If not provided, an ID will be automatically generated. This value should be less than 128 characters, and valid characters are `/a-z-/`. */
|
|
22733
22800
|
pipelineJobId?: string;
|
|
22734
|
-
/** Optional. Whether to do component level validations before job creation. Currently we only support Google First Party Component/Pipelines. */
|
|
22735
|
-
preflightValidations?: boolean;
|
|
22736
22801
|
/** Returns response with indentations and line breaks. */
|
|
22737
22802
|
prettyPrint?: boolean;
|
|
22738
22803
|
/** 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. */
|
|
@@ -22764,8 +22829,6 @@ declare namespace gapi.client {
|
|
|
22764
22829
|
parent: string;
|
|
22765
22830
|
/** The ID to use for the PipelineJob, which will become the final component of the PipelineJob name. If not provided, an ID will be automatically generated. This value should be less than 128 characters, and valid characters are `/a-z-/`. */
|
|
22766
22831
|
pipelineJobId?: string;
|
|
22767
|
-
/** Optional. Whether to do component level validations before job creation. Currently we only support Google First Party Component/Pipelines. */
|
|
22768
|
-
preflightValidations?: boolean;
|
|
22769
22832
|
/** Returns response with indentations and line breaks. */
|
|
22770
22833
|
prettyPrint?: boolean;
|
|
22771
22834
|
/** 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. */
|