@maxim_mazurok/gapi.client.aiplatform-v1beta1 0.0.20240830 → 0.0.20240907
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 +91 -5
- 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: 20240907
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -74,6 +74,8 @@ declare namespace gapi.client {
|
|
|
74
74
|
y2?: number;
|
|
75
75
|
}
|
|
76
76
|
interface CloudAiLargeModelsVisionRaiInfo {
|
|
77
|
+
/** List of blocked entities from the blocklist if it is detected. */
|
|
78
|
+
blockedEntities?: string[];
|
|
77
79
|
/** The list of detected labels for different rai categories. */
|
|
78
80
|
detectedLabels?: CloudAiLargeModelsVisionRaiInfoDetectedLabels[];
|
|
79
81
|
/** The model name used to indexing into the RaiFilterConfig map. Would either be one of imagegeneration@002-006, imagen-3.0-... api endpoint names, or internal names used for mapping to different filter configs (genselfie, ai_watermark) than its api endpoint. */
|
|
@@ -232,6 +234,16 @@ declare namespace gapi.client {
|
|
|
232
234
|
/** The uniform resource identifier of the artifact file. May be empty if there is no actual artifact file. */
|
|
233
235
|
uri?: string;
|
|
234
236
|
}
|
|
237
|
+
interface GoogleCloudAiplatformV1beta1ArtifactTypeSchema {
|
|
238
|
+
/** Contains a raw YAML string, describing the format of the properties of the type. */
|
|
239
|
+
instanceSchema?: string;
|
|
240
|
+
/** The name of the type. The format of the title must be: `.`. Examples: - `aiplatform.Model` - `acme.CustomModel` When this field is set, the type must be pre-registered in the MLMD store. */
|
|
241
|
+
schemaTitle?: string;
|
|
242
|
+
/** Points to a YAML file stored on Cloud Storage describing the format. Deprecated. Use PipelineArtifactTypeSchema.schema_title or PipelineArtifactTypeSchema.instance_schema instead. */
|
|
243
|
+
schemaUri?: string;
|
|
244
|
+
/** The schema version of the artifact. If the value is not set, it defaults to the latest version in the system. */
|
|
245
|
+
schemaVersion?: string;
|
|
246
|
+
}
|
|
235
247
|
interface GoogleCloudAiplatformV1beta1AssignNotebookRuntimeOperationMetadata {
|
|
236
248
|
/** The operation generic information. */
|
|
237
249
|
genericMetadata?: GoogleCloudAiplatformV1beta1GenericOperationMetadata;
|
|
@@ -867,6 +879,8 @@ declare namespace gapi.client {
|
|
|
867
879
|
interface GoogleCloudAiplatformV1beta1CountTokensRequest {
|
|
868
880
|
/** Optional. Input content. */
|
|
869
881
|
contents?: GoogleCloudAiplatformV1beta1Content[];
|
|
882
|
+
/** Optional. Generation config that the model will use to generate the response. */
|
|
883
|
+
generationConfig?: GoogleCloudAiplatformV1beta1GenerationConfig;
|
|
870
884
|
/** Optional. The instances that are the input to token counting call. Schema is identical to the prediction schema of the underlying model. */
|
|
871
885
|
instances?: any[];
|
|
872
886
|
/** Optional. The name of the publisher model requested to serve the prediction. Format: `projects/{project}/locations/{location}/publishers/*/models/*` */
|
|
@@ -1347,6 +1361,8 @@ declare namespace gapi.client {
|
|
|
1347
1361
|
indexSyncTime?: string;
|
|
1348
1362
|
/** Output only. Provides paths for users to send requests directly to the deployed index services running on Cloud via private services access. This field is populated if network is configured. */
|
|
1349
1363
|
privateEndpoints?: GoogleCloudAiplatformV1beta1IndexPrivateEndpoints;
|
|
1364
|
+
/** Optional. If set for PSC deployed index, PSC connection will be automatically created after deployment is done and the endpoint information is populated in private_endpoints.psc_automated_endpoints. */
|
|
1365
|
+
pscAutomationConfigs?: GoogleCloudAiplatformV1beta1PSCAutomationConfig[];
|
|
1350
1366
|
/** Optional. A list of reserved ip ranges under the VPC network that can be used for this DeployedIndex. If set, we will deploy the index within the provided ip ranges. Otherwise, the index might be deployed to any ip ranges under the provided VPC network. The value should be the name of the address (https://cloud.google.com/compute/docs/reference/rest/v1/addresses) Example: ['vertex-ai-ip-range']. For more information about subnets and network IP ranges, please see https://cloud.google.com/vpc/docs/subnets#manually_created_subnet_ip_ranges. */
|
|
1351
1367
|
reservedIpRanges?: string[];
|
|
1352
1368
|
}
|
|
@@ -2195,7 +2211,7 @@ declare namespace gapi.client {
|
|
|
2195
2211
|
interface GoogleCloudAiplatformV1beta1FeatureGroupBigQuery {
|
|
2196
2212
|
/** Required. Immutable. The BigQuery source URI that points to either a BigQuery Table or View. */
|
|
2197
2213
|
bigQuerySource?: GoogleCloudAiplatformV1beta1BigQuerySource;
|
|
2198
|
-
/** Optional. If set, all feature values will be fetched from a single row per unique entityId including nulls. If not set, will collapse all rows for each unique entityId into a singe row with any non-null values if present, if no non-null values are present will sync null. ex: If source has schema (entity_id, feature_timestamp, f0, f1) and
|
|
2214
|
+
/** Optional. If set, all feature values will be fetched from a single row per unique entityId including nulls. If not set, will collapse all rows for each unique entityId into a singe row with any non-null values if present, if no non-null values are present will sync null. ex: If source has schema `(entity_id, feature_timestamp, f0, f1)` and the following rows: `(e1, 2020-01-01T10:00:00.123Z, 10, 15)` `(e1, 2020-02-01T10:00:00.123Z, 20, null)` If dense is set, `(e1, 20, null)` is synced to online stores. If dense is not set, `(e1, 20, 15)` is synced to online stores. */
|
|
2199
2215
|
dense?: boolean;
|
|
2200
2216
|
/** Optional. Columns to construct entity_id / row keys. If not provided defaults to `entity_id`. */
|
|
2201
2217
|
entityIdColumns?: string[];
|
|
@@ -2538,7 +2554,7 @@ declare namespace gapi.client {
|
|
|
2538
2554
|
interface GoogleCloudAiplatformV1beta1FeatureViewVertexRagSource {
|
|
2539
2555
|
/** Optional. The RAG corpus id corresponding to this FeatureView. */
|
|
2540
2556
|
ragCorpusId?: string;
|
|
2541
|
-
/** Required. The BigQuery view/table URI that will be materialized on each manual sync trigger. The table/view is expected to have the following columns at least:
|
|
2557
|
+
/** Required. The BigQuery view/table URI that will be materialized on each manual sync trigger. The table/view is expected to have the following columns and types at least: - `corpus_id` (STRING, NULLABLE/REQUIRED) - `file_id` (STRING, NULLABLE/REQUIRED) - `chunk_id` (STRING, NULLABLE/REQUIRED) - `chunk_data_type` (STRING, NULLABLE/REQUIRED) - `chunk_data` (STRING, NULLABLE/REQUIRED) - `embeddings` (FLOAT, REPEATED) - `file_original_uri` (STRING, NULLABLE/REQUIRED) */
|
|
2542
2558
|
uri?: string;
|
|
2543
2559
|
}
|
|
2544
2560
|
interface GoogleCloudAiplatformV1beta1FetchFeatureValuesRequest {
|
|
@@ -2744,6 +2760,8 @@ declare namespace gapi.client {
|
|
|
2744
2760
|
contents?: GoogleCloudAiplatformV1beta1Content[];
|
|
2745
2761
|
/** Optional. Generation config. */
|
|
2746
2762
|
generationConfig?: GoogleCloudAiplatformV1beta1GenerationConfig;
|
|
2763
|
+
/** Optional. The labels with user-defined metadata for the request. It is used for billing and reporting only. Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter. */
|
|
2764
|
+
labels?: {[P in string]: string};
|
|
2747
2765
|
/** Optional. Per request settings for blocking unsafe content. Enforced on GenerateContentResponse.candidates. */
|
|
2748
2766
|
safetySettings?: GoogleCloudAiplatformV1beta1SafetySetting[];
|
|
2749
2767
|
/** Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph. */
|
|
@@ -3041,6 +3059,10 @@ declare namespace gapi.client {
|
|
|
3041
3059
|
jiraSource?: GoogleCloudAiplatformV1beta1JiraSource;
|
|
3042
3060
|
/** Optional. The max number of queries per minute that this job is allowed to make to the embedding model specified on the corpus. This value is specific to this job and not shared across other import jobs. Consult the Quotas page on the project to set an appropriate value here. If unspecified, a default value of 1,000 QPM would be used. */
|
|
3043
3061
|
maxEmbeddingRequestsPerMin?: number;
|
|
3062
|
+
/** The BigQuery destination to write partial failures to. It should be a bigquery table resource name (e.g. "bq://projectId.bqDatasetId.bqTableId"). If the dataset id does not exist, it will be created. If the table does not exist, it will be created with the expected schema. If the table exists, the schema will be validated and data will be added to this existing table. */
|
|
3063
|
+
partialFailureBigquerySink?: GoogleCloudAiplatformV1beta1BigQueryDestination;
|
|
3064
|
+
/** The Cloud Storage path to write partial failures to. */
|
|
3065
|
+
partialFailureGcsSink?: GoogleCloudAiplatformV1beta1GcsDestination;
|
|
3044
3066
|
/** Specifies the size and overlap of chunks after importing RagFiles. */
|
|
3045
3067
|
ragFileChunkingConfig?: GoogleCloudAiplatformV1beta1RagFileChunkingConfig;
|
|
3046
3068
|
/** Specifies the parsing config for RagFiles. */
|
|
@@ -4983,8 +5005,12 @@ declare namespace gapi.client {
|
|
|
4983
5005
|
name?: string;
|
|
4984
5006
|
/** The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the Pipeline Job's workload should be peered. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. Private services access must already be configured for the network. Pipeline job will apply the network configuration to the Google Cloud resources being launched, if applied, such as Vertex AI Training or Dataflow job. If left unspecified, the workload is not peered with any network. */
|
|
4985
5007
|
network?: string;
|
|
5008
|
+
/** Output only. The original pipeline job id if this pipeline job is a rerun of a previous pipeline job. */
|
|
5009
|
+
originalPipelineJobId?: string;
|
|
4986
5010
|
/** The spec of the pipeline. */
|
|
4987
5011
|
pipelineSpec?: {[P in string]: any};
|
|
5012
|
+
/** Output only. The rerun configs for each task in the pipeline job. By default, the rerun will: 1. Use the same input artifacts as the original run. 2. Use the same input parameters as the original run. 3. Skip all the tasks that are already succeeded in the original run. 4. Rerun all the tasks that are not succeeded in the original run. By providing this field, users can override the default behavior and specify the rerun config for each task. */
|
|
5013
|
+
pipelineTaskRerunConfigs?: GoogleCloudAiplatformV1beta1PipelineTaskRerunConfig[];
|
|
4988
5014
|
/** Optional. Whether to do component level validations before job creation. */
|
|
4989
5015
|
preflightValidations?: boolean;
|
|
4990
5016
|
/** 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']. */
|
|
@@ -5102,6 +5128,30 @@ declare namespace gapi.client {
|
|
|
5102
5128
|
/** Output only. The name of the CustomJob. */
|
|
5103
5129
|
job?: string;
|
|
5104
5130
|
}
|
|
5131
|
+
interface GoogleCloudAiplatformV1beta1PipelineTaskRerunConfig {
|
|
5132
|
+
/** Output only. The runtime input of the task overridden by the user. */
|
|
5133
|
+
inputs?: GoogleCloudAiplatformV1beta1PipelineTaskRerunConfigInputs;
|
|
5134
|
+
/** Output only. Whether to skip downstream tasks. Default value is False. */
|
|
5135
|
+
skipDownstreamTasks?: boolean;
|
|
5136
|
+
/** Output only. Whether to skip this task. Default value is False. */
|
|
5137
|
+
skipTask?: boolean;
|
|
5138
|
+
/** Output only. The system generated ID of the task. Retrieved from original run. */
|
|
5139
|
+
taskId?: string;
|
|
5140
|
+
/** Output only. The name of the task. */
|
|
5141
|
+
taskName?: string;
|
|
5142
|
+
}
|
|
5143
|
+
interface GoogleCloudAiplatformV1beta1PipelineTaskRerunConfigArtifactList {
|
|
5144
|
+
/** Output only. A list of artifact metadata. */
|
|
5145
|
+
artifacts?: GoogleCloudAiplatformV1beta1RuntimeArtifact[];
|
|
5146
|
+
}
|
|
5147
|
+
interface GoogleCloudAiplatformV1beta1PipelineTaskRerunConfigInputs {
|
|
5148
|
+
/** Output only. Input artifacts. */
|
|
5149
|
+
artifacts?: {
|
|
5150
|
+
[P in string]: GoogleCloudAiplatformV1beta1PipelineTaskRerunConfigArtifactList;
|
|
5151
|
+
};
|
|
5152
|
+
/** Output only. Input parameters. */
|
|
5153
|
+
parameterValues?: {[P in string]: any};
|
|
5154
|
+
}
|
|
5105
5155
|
interface GoogleCloudAiplatformV1beta1PipelineTemplateMetadata {
|
|
5106
5156
|
/** The version_name in artifact registry. Will always be presented in output if the PipelineJob.template_uri is from supported template registry. Format is "sha256:abcdef123456...". */
|
|
5107
5157
|
version?: string;
|
|
@@ -5219,6 +5269,12 @@ declare namespace gapi.client {
|
|
|
5219
5269
|
/** Corresponding project_id in pscAutomationConfigs */
|
|
5220
5270
|
projectId?: string;
|
|
5221
5271
|
}
|
|
5272
|
+
interface GoogleCloudAiplatformV1beta1PSCAutomationConfig {
|
|
5273
|
+
/** Required. The full name of the Google Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks). [Format](https://cloud.google.com/compute/docs/reference/rest/v1/networks/insert): `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in '12345', and {network} is network name. */
|
|
5274
|
+
network?: string;
|
|
5275
|
+
/** Required. Project id used to create forwarding rule. */
|
|
5276
|
+
projectId?: string;
|
|
5277
|
+
}
|
|
5222
5278
|
interface GoogleCloudAiplatformV1beta1PscInterfaceConfig {
|
|
5223
5279
|
/** Optional. The full name of the Compute Engine [network attachment](https://cloud.google.com/vpc/docs/about-network-attachments) to attach to the resource. For example, `projects/12345/regions/us-central1/networkAttachments/myNA`. is of the form `projects/{project}/regions/{region}/networkAttachments/{networkAttachment}`. Where {project} is a project number, as in `12345`, and {networkAttachment} is a network attachment name. To specify this field, you must have already [created a network attachment] (https://cloud.google.com/vpc/docs/create-manage-network-attachments#create-network-attachments). This field is only used for resources using PSC-I. */
|
|
5224
5280
|
networkAttachment?: string;
|
|
@@ -5690,18 +5746,32 @@ declare namespace gapi.client {
|
|
|
5690
5746
|
interface GoogleCloudAiplatformV1beta1RagVectorDbConfig {
|
|
5691
5747
|
/** Authentication config for the chosen Vector DB. */
|
|
5692
5748
|
apiAuth?: GoogleCloudAiplatformV1beta1ApiAuth;
|
|
5749
|
+
/** The config for the Pinecone. */
|
|
5750
|
+
pinecone?: GoogleCloudAiplatformV1beta1RagVectorDbConfigPinecone;
|
|
5693
5751
|
/** The config for the RAG-managed Vector DB. */
|
|
5694
5752
|
ragManagedDb?: any;
|
|
5695
5753
|
/** The config for the Vertex Feature Store. */
|
|
5696
5754
|
vertexFeatureStore?: GoogleCloudAiplatformV1beta1RagVectorDbConfigVertexFeatureStore;
|
|
5755
|
+
/** The config for the Vertex Vector Search. */
|
|
5756
|
+
vertexVectorSearch?: GoogleCloudAiplatformV1beta1RagVectorDbConfigVertexVectorSearch;
|
|
5697
5757
|
/** The config for the Weaviate. */
|
|
5698
5758
|
weaviate?: GoogleCloudAiplatformV1beta1RagVectorDbConfigWeaviate;
|
|
5699
5759
|
}
|
|
5760
|
+
interface GoogleCloudAiplatformV1beta1RagVectorDbConfigPinecone {
|
|
5761
|
+
/** Pinecone index name. This value cannot be changed after it's set. */
|
|
5762
|
+
indexName?: string;
|
|
5763
|
+
}
|
|
5700
5764
|
interface GoogleCloudAiplatformV1beta1RagVectorDbConfigRagManagedDb {}
|
|
5701
5765
|
interface GoogleCloudAiplatformV1beta1RagVectorDbConfigVertexFeatureStore {
|
|
5702
5766
|
/** The resource name of the FeatureView. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}` */
|
|
5703
5767
|
featureViewResourceName?: string;
|
|
5704
5768
|
}
|
|
5769
|
+
interface GoogleCloudAiplatformV1beta1RagVectorDbConfigVertexVectorSearch {
|
|
5770
|
+
/** The resource name of the Index. Format: `projects/{project}/locations/{location}/indexes/{index}` */
|
|
5771
|
+
index?: string;
|
|
5772
|
+
/** The resource name of the Index Endpoint. Format: `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}` */
|
|
5773
|
+
indexEndpoint?: string;
|
|
5774
|
+
}
|
|
5705
5775
|
interface GoogleCloudAiplatformV1beta1RagVectorDbConfigWeaviate {
|
|
5706
5776
|
/** The corresponding collection this corpus maps to. This value cannot be changed after it's set. */
|
|
5707
5777
|
collectionName?: string;
|
|
@@ -5991,6 +6061,20 @@ declare namespace gapi.client {
|
|
|
5991
6061
|
/** Optional. Whether to use stemmer to compute rouge score. */
|
|
5992
6062
|
useStemmer?: boolean;
|
|
5993
6063
|
}
|
|
6064
|
+
interface GoogleCloudAiplatformV1beta1RuntimeArtifact {
|
|
6065
|
+
/** The custom properties of the artifact. Deprecated. Use RuntimeArtifact.metadata instead. */
|
|
6066
|
+
customProperties?: {[P in string]: GoogleCloudAiplatformV1beta1Value};
|
|
6067
|
+
/** Properties of the Artifact. */
|
|
6068
|
+
metadata?: {[P in string]: any};
|
|
6069
|
+
/** The name of an artifact. */
|
|
6070
|
+
name?: string;
|
|
6071
|
+
/** The properties of the artifact. Deprecated. Use RuntimeArtifact.metadata instead. */
|
|
6072
|
+
properties?: {[P in string]: GoogleCloudAiplatformV1beta1Value};
|
|
6073
|
+
/** The type of the artifact. */
|
|
6074
|
+
type?: GoogleCloudAiplatformV1beta1ArtifactTypeSchema;
|
|
6075
|
+
/** The URI of the artifact. */
|
|
6076
|
+
uri?: string;
|
|
6077
|
+
}
|
|
5994
6078
|
interface GoogleCloudAiplatformV1beta1RuntimeConfig {
|
|
5995
6079
|
/** Code execution runtime configurations for code interpreter extension. */
|
|
5996
6080
|
codeInterpreterRuntimeConfig?: GoogleCloudAiplatformV1beta1RuntimeConfigCodeInterpreterRuntimeConfig;
|
|
@@ -6196,6 +6280,8 @@ declare namespace gapi.client {
|
|
|
6196
6280
|
pattern?: string;
|
|
6197
6281
|
/** Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT. */
|
|
6198
6282
|
properties?: {[P in string]: GoogleCloudAiplatformV1beta1Schema};
|
|
6283
|
+
/** Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties. */
|
|
6284
|
+
propertyOrdering?: string[];
|
|
6199
6285
|
/** Optional. Required properties of Type.OBJECT. */
|
|
6200
6286
|
required?: string[];
|
|
6201
6287
|
/** Optional. The title of the Schema. */
|
|
@@ -15788,7 +15874,7 @@ declare namespace gapi.client {
|
|
|
15788
15874
|
alt?: string;
|
|
15789
15875
|
/** JSONP */
|
|
15790
15876
|
callback?: string;
|
|
15791
|
-
/** Required. The ID to use for this FeatureGroup, which will become the final component of the FeatureGroup's resource name. This value may be up to
|
|
15877
|
+
/** Required. The ID to use for this FeatureGroup, which will become the final component of the FeatureGroup's resource name. This value may be up to 128 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within the project and location. */
|
|
15792
15878
|
featureGroupId?: string;
|
|
15793
15879
|
/** Selector specifying which fields to include in a partial response. */
|
|
15794
15880
|
fields?: string;
|
|
@@ -15819,7 +15905,7 @@ declare namespace gapi.client {
|
|
|
15819
15905
|
alt?: string;
|
|
15820
15906
|
/** JSONP */
|
|
15821
15907
|
callback?: string;
|
|
15822
|
-
/** Required. The ID to use for this FeatureGroup, which will become the final component of the FeatureGroup's resource name. This value may be up to
|
|
15908
|
+
/** Required. The ID to use for this FeatureGroup, which will become the final component of the FeatureGroup's resource name. This value may be up to 128 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within the project and location. */
|
|
15823
15909
|
featureGroupId?: string;
|
|
15824
15910
|
/** Selector specifying which fields to include in a partial response. */
|
|
15825
15911
|
fields?: string;
|