@maxim_mazurok/gapi.client.aiplatform-v1beta1 0.0.20240830 → 0.0.20240916
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 +262 -6
- 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: 20240916
|
|
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;
|
|
@@ -680,6 +692,8 @@ declare namespace gapi.client {
|
|
|
680
692
|
groundingMetadata?: GoogleCloudAiplatformV1beta1GroundingMetadata;
|
|
681
693
|
/** Output only. Index of the candidate. */
|
|
682
694
|
index?: number;
|
|
695
|
+
/** Output only. Log-likelihood scores for the response tokens and top tokens */
|
|
696
|
+
logprobsResult?: GoogleCloudAiplatformV1beta1LogprobsResult;
|
|
683
697
|
/** Output only. List of ratings for the safety of a response candidate. There is at most one rating per category. */
|
|
684
698
|
safetyRatings?: GoogleCloudAiplatformV1beta1SafetyRating[];
|
|
685
699
|
}
|
|
@@ -867,6 +881,8 @@ declare namespace gapi.client {
|
|
|
867
881
|
interface GoogleCloudAiplatformV1beta1CountTokensRequest {
|
|
868
882
|
/** Optional. Input content. */
|
|
869
883
|
contents?: GoogleCloudAiplatformV1beta1Content[];
|
|
884
|
+
/** Optional. Generation config that the model will use to generate the response. */
|
|
885
|
+
generationConfig?: GoogleCloudAiplatformV1beta1GenerationConfig;
|
|
870
886
|
/** Optional. The instances that are the input to token counting call. Schema is identical to the prediction schema of the underlying model. */
|
|
871
887
|
instances?: any[];
|
|
872
888
|
/** Optional. The name of the publisher model requested to serve the prediction. Format: `projects/{project}/locations/{location}/publishers/*/models/*` */
|
|
@@ -1347,6 +1363,8 @@ declare namespace gapi.client {
|
|
|
1347
1363
|
indexSyncTime?: string;
|
|
1348
1364
|
/** 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
1365
|
privateEndpoints?: GoogleCloudAiplatformV1beta1IndexPrivateEndpoints;
|
|
1366
|
+
/** 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. */
|
|
1367
|
+
pscAutomationConfigs?: GoogleCloudAiplatformV1beta1PSCAutomationConfig[];
|
|
1350
1368
|
/** 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
1369
|
reservedIpRanges?: string[];
|
|
1352
1370
|
}
|
|
@@ -2195,7 +2213,7 @@ declare namespace gapi.client {
|
|
|
2195
2213
|
interface GoogleCloudAiplatformV1beta1FeatureGroupBigQuery {
|
|
2196
2214
|
/** Required. Immutable. The BigQuery source URI that points to either a BigQuery Table or View. */
|
|
2197
2215
|
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
|
|
2216
|
+
/** 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
2217
|
dense?: boolean;
|
|
2200
2218
|
/** Optional. Columns to construct entity_id / row keys. If not provided defaults to `entity_id`. */
|
|
2201
2219
|
entityIdColumns?: string[];
|
|
@@ -2420,6 +2438,8 @@ declare namespace gapi.client {
|
|
|
2420
2438
|
labels?: {[P in string]: string};
|
|
2421
2439
|
/** Identifier. Name of the FeatureView. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}` */
|
|
2422
2440
|
name?: string;
|
|
2441
|
+
/** Optional. Configuration for FeatureView created under Optimized FeatureOnlineStore. */
|
|
2442
|
+
optimizedConfig?: GoogleCloudAiplatformV1beta1FeatureViewOptimizedConfig;
|
|
2423
2443
|
/** Output only. Reserved for future use. */
|
|
2424
2444
|
satisfiesPzi?: boolean;
|
|
2425
2445
|
/** Output only. Reserved for future use. */
|
|
@@ -2486,6 +2506,10 @@ declare namespace gapi.client {
|
|
|
2486
2506
|
/** Optional. Number of embeddings on each leaf node. The default value is 1000 if not set. */
|
|
2487
2507
|
leafNodeEmbeddingCount?: string;
|
|
2488
2508
|
}
|
|
2509
|
+
interface GoogleCloudAiplatformV1beta1FeatureViewOptimizedConfig {
|
|
2510
|
+
/** Optional. A description of resources that the FeatureView uses, which to large degree are decided by Vertex AI, and optionally allows only a modest additional configuration. If min_replica_count is not set, the default value is 2. If max_replica_count is not set, the default value is 6. The max allowed replica count is 1000. */
|
|
2511
|
+
automaticResources?: GoogleCloudAiplatformV1beta1AutomaticResources;
|
|
2512
|
+
}
|
|
2489
2513
|
interface GoogleCloudAiplatformV1beta1FeatureViewSync {
|
|
2490
2514
|
/** Output only. Time when this FeatureViewSync is created. Creation of a FeatureViewSync means that the job is pending / waiting for sufficient resources but may not have started the actual data transfer yet. */
|
|
2491
2515
|
createTime?: string;
|
|
@@ -2538,7 +2562,7 @@ declare namespace gapi.client {
|
|
|
2538
2562
|
interface GoogleCloudAiplatformV1beta1FeatureViewVertexRagSource {
|
|
2539
2563
|
/** Optional. The RAG corpus id corresponding to this FeatureView. */
|
|
2540
2564
|
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:
|
|
2565
|
+
/** 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
2566
|
uri?: string;
|
|
2543
2567
|
}
|
|
2544
2568
|
interface GoogleCloudAiplatformV1beta1FetchFeatureValuesRequest {
|
|
@@ -2744,6 +2768,8 @@ declare namespace gapi.client {
|
|
|
2744
2768
|
contents?: GoogleCloudAiplatformV1beta1Content[];
|
|
2745
2769
|
/** Optional. Generation config. */
|
|
2746
2770
|
generationConfig?: GoogleCloudAiplatformV1beta1GenerationConfig;
|
|
2771
|
+
/** 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. */
|
|
2772
|
+
labels?: {[P in string]: string};
|
|
2747
2773
|
/** Optional. Per request settings for blocking unsafe content. Enforced on GenerateContentResponse.candidates. */
|
|
2748
2774
|
safetySettings?: GoogleCloudAiplatformV1beta1SafetySetting[];
|
|
2749
2775
|
/** 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. */
|
|
@@ -2756,6 +2782,8 @@ declare namespace gapi.client {
|
|
|
2756
2782
|
interface GoogleCloudAiplatformV1beta1GenerateContentResponse {
|
|
2757
2783
|
/** Output only. Generated candidates. */
|
|
2758
2784
|
candidates?: GoogleCloudAiplatformV1beta1Candidate[];
|
|
2785
|
+
/** Output only. The model version used to generate the response. */
|
|
2786
|
+
modelVersion?: string;
|
|
2759
2787
|
/** Output only. Content filter results for a prompt sent in the request. Note: Sent only in the first stream chunk. Only happens when no candidates were generated due to content violations. */
|
|
2760
2788
|
promptFeedback?: GoogleCloudAiplatformV1beta1GenerateContentResponsePromptFeedback;
|
|
2761
2789
|
/** Usage metadata about the response(s). */
|
|
@@ -2792,10 +2820,14 @@ declare namespace gapi.client {
|
|
|
2792
2820
|
candidateCount?: number;
|
|
2793
2821
|
/** Optional. Frequency penalties. */
|
|
2794
2822
|
frequencyPenalty?: number;
|
|
2823
|
+
/** Optional. Logit probabilities. */
|
|
2824
|
+
logprobs?: number;
|
|
2795
2825
|
/** Optional. The maximum number of output tokens to generate per message. */
|
|
2796
2826
|
maxOutputTokens?: number;
|
|
2797
2827
|
/** Optional. Positive penalties. */
|
|
2798
2828
|
presencePenalty?: number;
|
|
2829
|
+
/** Optional. If true, export the logprobs results in response. */
|
|
2830
|
+
responseLogprobs?: boolean;
|
|
2799
2831
|
/** Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. */
|
|
2800
2832
|
responseMimeType?: string;
|
|
2801
2833
|
/** Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response. */
|
|
@@ -3041,10 +3073,16 @@ declare namespace gapi.client {
|
|
|
3041
3073
|
jiraSource?: GoogleCloudAiplatformV1beta1JiraSource;
|
|
3042
3074
|
/** 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
3075
|
maxEmbeddingRequestsPerMin?: number;
|
|
3076
|
+
/** 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. */
|
|
3077
|
+
partialFailureBigquerySink?: GoogleCloudAiplatformV1beta1BigQueryDestination;
|
|
3078
|
+
/** The Cloud Storage path to write partial failures to. */
|
|
3079
|
+
partialFailureGcsSink?: GoogleCloudAiplatformV1beta1GcsDestination;
|
|
3044
3080
|
/** Specifies the size and overlap of chunks after importing RagFiles. */
|
|
3045
3081
|
ragFileChunkingConfig?: GoogleCloudAiplatformV1beta1RagFileChunkingConfig;
|
|
3046
3082
|
/** Specifies the parsing config for RagFiles. */
|
|
3047
3083
|
ragFileParsingConfig?: GoogleCloudAiplatformV1beta1RagFileParsingConfig;
|
|
3084
|
+
/** SharePoint sources. */
|
|
3085
|
+
sharePointSources?: GoogleCloudAiplatformV1beta1SharePointSources;
|
|
3048
3086
|
/** Slack channels with their corresponding access tokens. */
|
|
3049
3087
|
slackSource?: GoogleCloudAiplatformV1beta1SlackSource;
|
|
3050
3088
|
}
|
|
@@ -3584,6 +3622,24 @@ declare namespace gapi.client {
|
|
|
3584
3622
|
/** List of TuningJobs in the requested page. */
|
|
3585
3623
|
tuningJobs?: GoogleCloudAiplatformV1beta1TuningJob[];
|
|
3586
3624
|
}
|
|
3625
|
+
interface GoogleCloudAiplatformV1beta1LogprobsResult {
|
|
3626
|
+
/** Length = total number of decoding steps. The chosen candidates may or may not be in top_candidates. */
|
|
3627
|
+
chosenCandidates?: GoogleCloudAiplatformV1beta1LogprobsResultCandidate[];
|
|
3628
|
+
/** Length = total number of decoding steps. */
|
|
3629
|
+
topCandidates?: GoogleCloudAiplatformV1beta1LogprobsResultTopCandidates[];
|
|
3630
|
+
}
|
|
3631
|
+
interface GoogleCloudAiplatformV1beta1LogprobsResultCandidate {
|
|
3632
|
+
/** The candidate's log probability. */
|
|
3633
|
+
logProbability?: number;
|
|
3634
|
+
/** The candidate’s token string value. */
|
|
3635
|
+
token?: string;
|
|
3636
|
+
/** The candidate’s token id value. */
|
|
3637
|
+
tokenId?: number;
|
|
3638
|
+
}
|
|
3639
|
+
interface GoogleCloudAiplatformV1beta1LogprobsResultTopCandidates {
|
|
3640
|
+
/** Sorted by log probability in descending order. */
|
|
3641
|
+
candidates?: GoogleCloudAiplatformV1beta1LogprobsResultCandidate[];
|
|
3642
|
+
}
|
|
3587
3643
|
interface GoogleCloudAiplatformV1beta1LookupStudyRequest {
|
|
3588
3644
|
/** Required. The user-defined display name of the Study */
|
|
3589
3645
|
displayName?: string;
|
|
@@ -4983,8 +5039,12 @@ declare namespace gapi.client {
|
|
|
4983
5039
|
name?: string;
|
|
4984
5040
|
/** 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
5041
|
network?: string;
|
|
5042
|
+
/** Output only. The original pipeline job id if this pipeline job is a rerun of a previous pipeline job. */
|
|
5043
|
+
originalPipelineJobId?: string;
|
|
4986
5044
|
/** The spec of the pipeline. */
|
|
4987
5045
|
pipelineSpec?: {[P in string]: any};
|
|
5046
|
+
/** 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. */
|
|
5047
|
+
pipelineTaskRerunConfigs?: GoogleCloudAiplatformV1beta1PipelineTaskRerunConfig[];
|
|
4988
5048
|
/** Optional. Whether to do component level validations before job creation. */
|
|
4989
5049
|
preflightValidations?: boolean;
|
|
4990
5050
|
/** 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 +5162,30 @@ declare namespace gapi.client {
|
|
|
5102
5162
|
/** Output only. The name of the CustomJob. */
|
|
5103
5163
|
job?: string;
|
|
5104
5164
|
}
|
|
5165
|
+
interface GoogleCloudAiplatformV1beta1PipelineTaskRerunConfig {
|
|
5166
|
+
/** Output only. The runtime input of the task overridden by the user. */
|
|
5167
|
+
inputs?: GoogleCloudAiplatformV1beta1PipelineTaskRerunConfigInputs;
|
|
5168
|
+
/** Output only. Whether to skip downstream tasks. Default value is False. */
|
|
5169
|
+
skipDownstreamTasks?: boolean;
|
|
5170
|
+
/** Output only. Whether to skip this task. Default value is False. */
|
|
5171
|
+
skipTask?: boolean;
|
|
5172
|
+
/** Output only. The system generated ID of the task. Retrieved from original run. */
|
|
5173
|
+
taskId?: string;
|
|
5174
|
+
/** Output only. The name of the task. */
|
|
5175
|
+
taskName?: string;
|
|
5176
|
+
}
|
|
5177
|
+
interface GoogleCloudAiplatformV1beta1PipelineTaskRerunConfigArtifactList {
|
|
5178
|
+
/** Output only. A list of artifact metadata. */
|
|
5179
|
+
artifacts?: GoogleCloudAiplatformV1beta1RuntimeArtifact[];
|
|
5180
|
+
}
|
|
5181
|
+
interface GoogleCloudAiplatformV1beta1PipelineTaskRerunConfigInputs {
|
|
5182
|
+
/** Output only. Input artifacts. */
|
|
5183
|
+
artifacts?: {
|
|
5184
|
+
[P in string]: GoogleCloudAiplatformV1beta1PipelineTaskRerunConfigArtifactList;
|
|
5185
|
+
};
|
|
5186
|
+
/** Output only. Input parameters. */
|
|
5187
|
+
parameterValues?: {[P in string]: any};
|
|
5188
|
+
}
|
|
5105
5189
|
interface GoogleCloudAiplatformV1beta1PipelineTemplateMetadata {
|
|
5106
5190
|
/** 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
5191
|
version?: string;
|
|
@@ -5194,6 +5278,8 @@ declare namespace gapi.client {
|
|
|
5194
5278
|
interface GoogleCloudAiplatformV1beta1PrivateServiceConnectConfig {
|
|
5195
5279
|
/** Required. If true, expose the IndexEndpoint via private service connect. */
|
|
5196
5280
|
enablePrivateServiceConnect?: boolean;
|
|
5281
|
+
/** Optional. If set to true, enable secure private service connect with IAM authorization. Otherwise, private service connect will be done without authorization. Note latency will be slightly increased if authorization is enabled. */
|
|
5282
|
+
enableSecurePrivateServiceConnect?: boolean;
|
|
5197
5283
|
/** A list of Projects from which the forwarding rule will target the service attachment. */
|
|
5198
5284
|
projectAllowlist?: string[];
|
|
5199
5285
|
/** Output only. The name of the generated service attachment resource. This is only populated if the endpoint is deployed with PrivateServiceConnect. */
|
|
@@ -5219,6 +5305,12 @@ declare namespace gapi.client {
|
|
|
5219
5305
|
/** Corresponding project_id in pscAutomationConfigs */
|
|
5220
5306
|
projectId?: string;
|
|
5221
5307
|
}
|
|
5308
|
+
interface GoogleCloudAiplatformV1beta1PSCAutomationConfig {
|
|
5309
|
+
/** 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. */
|
|
5310
|
+
network?: string;
|
|
5311
|
+
/** Required. Project id used to create forwarding rule. */
|
|
5312
|
+
projectId?: string;
|
|
5313
|
+
}
|
|
5222
5314
|
interface GoogleCloudAiplatformV1beta1PscInterfaceConfig {
|
|
5223
5315
|
/** 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
5316
|
networkAttachment?: string;
|
|
@@ -5658,6 +5750,8 @@ declare namespace gapi.client {
|
|
|
5658
5750
|
name?: string;
|
|
5659
5751
|
/** Output only. The type of the RagFile. */
|
|
5660
5752
|
ragFileType?: string;
|
|
5753
|
+
/** The RagFile is imported from a SharePoint source. */
|
|
5754
|
+
sharePointSources?: GoogleCloudAiplatformV1beta1SharePointSources;
|
|
5661
5755
|
/** Output only. The size of the RagFile in bytes. */
|
|
5662
5756
|
sizeBytes?: string;
|
|
5663
5757
|
/** The RagFile is imported from a Slack channel. */
|
|
@@ -5690,18 +5784,32 @@ declare namespace gapi.client {
|
|
|
5690
5784
|
interface GoogleCloudAiplatformV1beta1RagVectorDbConfig {
|
|
5691
5785
|
/** Authentication config for the chosen Vector DB. */
|
|
5692
5786
|
apiAuth?: GoogleCloudAiplatformV1beta1ApiAuth;
|
|
5787
|
+
/** The config for the Pinecone. */
|
|
5788
|
+
pinecone?: GoogleCloudAiplatformV1beta1RagVectorDbConfigPinecone;
|
|
5693
5789
|
/** The config for the RAG-managed Vector DB. */
|
|
5694
5790
|
ragManagedDb?: any;
|
|
5695
5791
|
/** The config for the Vertex Feature Store. */
|
|
5696
5792
|
vertexFeatureStore?: GoogleCloudAiplatformV1beta1RagVectorDbConfigVertexFeatureStore;
|
|
5793
|
+
/** The config for the Vertex Vector Search. */
|
|
5794
|
+
vertexVectorSearch?: GoogleCloudAiplatformV1beta1RagVectorDbConfigVertexVectorSearch;
|
|
5697
5795
|
/** The config for the Weaviate. */
|
|
5698
5796
|
weaviate?: GoogleCloudAiplatformV1beta1RagVectorDbConfigWeaviate;
|
|
5699
5797
|
}
|
|
5798
|
+
interface GoogleCloudAiplatformV1beta1RagVectorDbConfigPinecone {
|
|
5799
|
+
/** Pinecone index name. This value cannot be changed after it's set. */
|
|
5800
|
+
indexName?: string;
|
|
5801
|
+
}
|
|
5700
5802
|
interface GoogleCloudAiplatformV1beta1RagVectorDbConfigRagManagedDb {}
|
|
5701
5803
|
interface GoogleCloudAiplatformV1beta1RagVectorDbConfigVertexFeatureStore {
|
|
5702
5804
|
/** The resource name of the FeatureView. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}` */
|
|
5703
5805
|
featureViewResourceName?: string;
|
|
5704
5806
|
}
|
|
5807
|
+
interface GoogleCloudAiplatformV1beta1RagVectorDbConfigVertexVectorSearch {
|
|
5808
|
+
/** The resource name of the Index. Format: `projects/{project}/locations/{location}/indexes/{index}` */
|
|
5809
|
+
index?: string;
|
|
5810
|
+
/** The resource name of the Index Endpoint. Format: `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}` */
|
|
5811
|
+
indexEndpoint?: string;
|
|
5812
|
+
}
|
|
5705
5813
|
interface GoogleCloudAiplatformV1beta1RagVectorDbConfigWeaviate {
|
|
5706
5814
|
/** The corresponding collection this corpus maps to. This value cannot be changed after it's set. */
|
|
5707
5815
|
collectionName?: string;
|
|
@@ -5836,6 +5944,16 @@ declare namespace gapi.client {
|
|
|
5836
5944
|
/** Optional. The Cloud Storage URI of the `requirements.txt` file */
|
|
5837
5945
|
requirementsGcsUri?: string;
|
|
5838
5946
|
}
|
|
5947
|
+
interface GoogleCloudAiplatformV1beta1RebaseTunedModelRequest {
|
|
5948
|
+
/** Optional. The Google Cloud Storage location to write the artifacts. */
|
|
5949
|
+
artifactDestination?: GoogleCloudAiplatformV1beta1GcsDestination;
|
|
5950
|
+
/** Optional. By default, bison to gemini migration will always create new model/endpoint, but for gemini-1.0 to gemini-1.5 migration, we default deploy to the same endpoint. See details in this Section. */
|
|
5951
|
+
deployToSameEndpoint?: boolean;
|
|
5952
|
+
/** Required. TunedModel reference to retrieve the legacy model information. */
|
|
5953
|
+
tunedModelRef?: GoogleCloudAiplatformV1beta1TunedModelRef;
|
|
5954
|
+
/** Optional. The TuningJob to be updated. Users can use this TuningJob field to overwrite tuning configs. */
|
|
5955
|
+
tuningJob?: GoogleCloudAiplatformV1beta1TuningJob;
|
|
5956
|
+
}
|
|
5839
5957
|
interface GoogleCloudAiplatformV1beta1RebootPersistentResourceOperationMetadata {
|
|
5840
5958
|
/** Operation metadata for PersistentResource. */
|
|
5841
5959
|
genericMetadata?: GoogleCloudAiplatformV1beta1GenericOperationMetadata;
|
|
@@ -5991,6 +6109,20 @@ declare namespace gapi.client {
|
|
|
5991
6109
|
/** Optional. Whether to use stemmer to compute rouge score. */
|
|
5992
6110
|
useStemmer?: boolean;
|
|
5993
6111
|
}
|
|
6112
|
+
interface GoogleCloudAiplatformV1beta1RuntimeArtifact {
|
|
6113
|
+
/** The custom properties of the artifact. Deprecated. Use RuntimeArtifact.metadata instead. */
|
|
6114
|
+
customProperties?: {[P in string]: GoogleCloudAiplatformV1beta1Value};
|
|
6115
|
+
/** Properties of the Artifact. */
|
|
6116
|
+
metadata?: {[P in string]: any};
|
|
6117
|
+
/** The name of an artifact. */
|
|
6118
|
+
name?: string;
|
|
6119
|
+
/** The properties of the artifact. Deprecated. Use RuntimeArtifact.metadata instead. */
|
|
6120
|
+
properties?: {[P in string]: GoogleCloudAiplatformV1beta1Value};
|
|
6121
|
+
/** The type of the artifact. */
|
|
6122
|
+
type?: GoogleCloudAiplatformV1beta1ArtifactTypeSchema;
|
|
6123
|
+
/** The URI of the artifact. */
|
|
6124
|
+
uri?: string;
|
|
6125
|
+
}
|
|
5994
6126
|
interface GoogleCloudAiplatformV1beta1RuntimeConfig {
|
|
5995
6127
|
/** Code execution runtime configurations for code interpreter extension. */
|
|
5996
6128
|
codeInterpreterRuntimeConfig?: GoogleCloudAiplatformV1beta1RuntimeConfigCodeInterpreterRuntimeConfig;
|
|
@@ -6162,6 +6294,8 @@ declare namespace gapi.client {
|
|
|
6162
6294
|
timeout?: string;
|
|
6163
6295
|
}
|
|
6164
6296
|
interface GoogleCloudAiplatformV1beta1Schema {
|
|
6297
|
+
/** Optional. The value should be validated against any (one or more) of the subschemas in the list. */
|
|
6298
|
+
anyOf?: GoogleCloudAiplatformV1beta1Schema[];
|
|
6165
6299
|
/** Optional. Default value of the data. */
|
|
6166
6300
|
default?: any;
|
|
6167
6301
|
/** Optional. The description of the data. */
|
|
@@ -6196,6 +6330,8 @@ declare namespace gapi.client {
|
|
|
6196
6330
|
pattern?: string;
|
|
6197
6331
|
/** Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT. */
|
|
6198
6332
|
properties?: {[P in string]: GoogleCloudAiplatformV1beta1Schema};
|
|
6333
|
+
/** Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties. */
|
|
6334
|
+
propertyOrdering?: string[];
|
|
6199
6335
|
/** Optional. Required properties of Type.OBJECT. */
|
|
6200
6336
|
required?: string[];
|
|
6201
6337
|
/** Optional. The title of the Schema. */
|
|
@@ -7607,6 +7743,30 @@ declare namespace gapi.client {
|
|
|
7607
7743
|
/** Optional. Required when all below conditions are met * `enable_custom_service_account` is true; * any runtime is specified via `ResourceRuntimeSpec` on creation time, for example, Ray The users must have `iam.serviceAccounts.actAs` permission on this service account and then the specified runtime containers will run as it. Do not set this field if you want to submit jobs using custom service account to this PersistentResource after creation, but only specify the `service_account` inside the job. */
|
|
7608
7744
|
serviceAccount?: string;
|
|
7609
7745
|
}
|
|
7746
|
+
interface GoogleCloudAiplatformV1beta1SharePointSources {
|
|
7747
|
+
/** The SharePoint sources. */
|
|
7748
|
+
sharePointSources?: GoogleCloudAiplatformV1beta1SharePointSourcesSharePointSource[];
|
|
7749
|
+
}
|
|
7750
|
+
interface GoogleCloudAiplatformV1beta1SharePointSourcesSharePointSource {
|
|
7751
|
+
/** The Application ID for the app registered in Microsoft Azure Portal. The application must also be configured with MS Graph permissions "Files.ReadAll", "Sites.ReadAll" and BrowserSiteLists.Read.All. */
|
|
7752
|
+
clientId?: string;
|
|
7753
|
+
/** The application secret for the app registered in Azure. */
|
|
7754
|
+
clientSecret?: GoogleCloudAiplatformV1beta1ApiAuthApiKeyConfig;
|
|
7755
|
+
/** The ID of the drive to download from. */
|
|
7756
|
+
driveId?: string;
|
|
7757
|
+
/** The name of the drive to download from. */
|
|
7758
|
+
driveName?: string;
|
|
7759
|
+
/** Output only. The SharePoint file id. Output only. */
|
|
7760
|
+
fileId?: string;
|
|
7761
|
+
/** The ID of the SharePoint folder to download from. */
|
|
7762
|
+
sharepointFolderId?: string;
|
|
7763
|
+
/** The path of the SharePoint folder to download from. */
|
|
7764
|
+
sharepointFolderPath?: string;
|
|
7765
|
+
/** The name of the SharePoint site to download from. This can be the site name or the site id. */
|
|
7766
|
+
sharepointSiteName?: string;
|
|
7767
|
+
/** Unique identifier of the Azure Active Directory Instance. */
|
|
7768
|
+
tenantId?: string;
|
|
7769
|
+
}
|
|
7610
7770
|
interface GoogleCloudAiplatformV1beta1ShieldedVmConfig {
|
|
7611
7771
|
/** Defines whether the instance has [Secure Boot](https://cloud.google.com/compute/shielded-vm/docs/shielded-vm#secure-boot) enabled. Secure Boot helps ensure that the system only runs authentic software by verifying the digital signature of all boot components, and halting the boot process if signature verification fails. */
|
|
7612
7772
|
enableSecureBoot?: boolean;
|
|
@@ -8268,7 +8428,7 @@ declare namespace gapi.client {
|
|
|
8268
8428
|
tokens?: string[];
|
|
8269
8429
|
}
|
|
8270
8430
|
interface GoogleCloudAiplatformV1beta1Tool {
|
|
8271
|
-
/** 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
|
|
8431
|
+
/** 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 128 function declarations can be provided. */
|
|
8272
8432
|
functionDeclarations?: GoogleCloudAiplatformV1beta1FunctionDeclaration[];
|
|
8273
8433
|
/** Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. */
|
|
8274
8434
|
googleSearchRetrieval?: any;
|
|
@@ -8472,6 +8632,14 @@ declare namespace gapi.client {
|
|
|
8472
8632
|
/** Output only. The resource name of the TunedModel. Format: `projects/{project}/locations/{location}/models/{model}`. */
|
|
8473
8633
|
model?: string;
|
|
8474
8634
|
}
|
|
8635
|
+
interface GoogleCloudAiplatformV1beta1TunedModelRef {
|
|
8636
|
+
/** Support migration from tuning job list page, from bison model to gemini model. */
|
|
8637
|
+
pipelineJob?: string;
|
|
8638
|
+
/** Support migration from model registry. */
|
|
8639
|
+
tunedModel?: string;
|
|
8640
|
+
/** Support migration from tuning job list page, from gemini-1.0-pro-002 to 1.5 and above. */
|
|
8641
|
+
tuningJob?: string;
|
|
8642
|
+
}
|
|
8475
8643
|
interface GoogleCloudAiplatformV1beta1TuningDataStats {
|
|
8476
8644
|
/** Output only. Statistics for distillation. */
|
|
8477
8645
|
distillationDataStats?: GoogleCloudAiplatformV1beta1DistillationDataStats;
|
|
@@ -15788,7 +15956,7 @@ declare namespace gapi.client {
|
|
|
15788
15956
|
alt?: string;
|
|
15789
15957
|
/** JSONP */
|
|
15790
15958
|
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
|
|
15959
|
+
/** 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
15960
|
featureGroupId?: string;
|
|
15793
15961
|
/** Selector specifying which fields to include in a partial response. */
|
|
15794
15962
|
fields?: string;
|
|
@@ -15819,7 +15987,7 @@ declare namespace gapi.client {
|
|
|
15819
15987
|
alt?: string;
|
|
15820
15988
|
/** JSONP */
|
|
15821
15989
|
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
|
|
15990
|
+
/** 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
15991
|
featureGroupId?: string;
|
|
15824
15992
|
/** Selector specifying which fields to include in a partial response. */
|
|
15825
15993
|
fields?: string;
|
|
@@ -33371,6 +33539,35 @@ declare namespace gapi.client {
|
|
|
33371
33539
|
}): Request<GoogleCloudAiplatformV1beta1ListTrainingPipelinesResponse>;
|
|
33372
33540
|
operations: OperationsResource;
|
|
33373
33541
|
}
|
|
33542
|
+
interface OperationsResource {
|
|
33543
|
+
/** 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 this method, it returns `google.rpc.Code.UNIMPLEMENTED`. */
|
|
33544
|
+
delete(request?: {
|
|
33545
|
+
/** V1 error format. */
|
|
33546
|
+
'$.xgafv'?: string;
|
|
33547
|
+
/** OAuth access token. */
|
|
33548
|
+
access_token?: string;
|
|
33549
|
+
/** Data format for response. */
|
|
33550
|
+
alt?: string;
|
|
33551
|
+
/** JSONP */
|
|
33552
|
+
callback?: string;
|
|
33553
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
33554
|
+
fields?: string;
|
|
33555
|
+
/** 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. */
|
|
33556
|
+
key?: string;
|
|
33557
|
+
/** The name of the operation resource to be deleted. */
|
|
33558
|
+
name: string;
|
|
33559
|
+
/** OAuth 2.0 token for the current user. */
|
|
33560
|
+
oauth_token?: string;
|
|
33561
|
+
/** Returns response with indentations and line breaks. */
|
|
33562
|
+
prettyPrint?: boolean;
|
|
33563
|
+
/** 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. */
|
|
33564
|
+
quotaUser?: string;
|
|
33565
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
33566
|
+
upload_protocol?: string;
|
|
33567
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
33568
|
+
uploadType?: string;
|
|
33569
|
+
}): Request<{}>;
|
|
33570
|
+
}
|
|
33374
33571
|
interface TuningJobsResource {
|
|
33375
33572
|
/** Cancels a TuningJob. Starts asynchronous cancellation on the TuningJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use GenAiTuningService.GetTuningJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the TuningJob is not deleted; instead it becomes a job with a TuningJob.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and TuningJob.state is set to `CANCELLED`. */
|
|
33376
33573
|
cancel(request: {
|
|
@@ -33548,6 +33745,65 @@ declare namespace gapi.client {
|
|
|
33548
33745
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
33549
33746
|
uploadType?: string;
|
|
33550
33747
|
}): Request<GoogleCloudAiplatformV1beta1ListTuningJobsResponse>;
|
|
33748
|
+
/** Rebase a TunedModel. */
|
|
33749
|
+
rebaseTunedModel(request: {
|
|
33750
|
+
/** V1 error format. */
|
|
33751
|
+
'$.xgafv'?: string;
|
|
33752
|
+
/** OAuth access token. */
|
|
33753
|
+
access_token?: string;
|
|
33754
|
+
/** Data format for response. */
|
|
33755
|
+
alt?: string;
|
|
33756
|
+
/** JSONP */
|
|
33757
|
+
callback?: string;
|
|
33758
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
33759
|
+
fields?: string;
|
|
33760
|
+
/** 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. */
|
|
33761
|
+
key?: string;
|
|
33762
|
+
/** OAuth 2.0 token for the current user. */
|
|
33763
|
+
oauth_token?: string;
|
|
33764
|
+
/** Required. The resource name of the Location into which to rebase the Model. Format: `projects/{project}/locations/{location}` */
|
|
33765
|
+
parent: string;
|
|
33766
|
+
/** Returns response with indentations and line breaks. */
|
|
33767
|
+
prettyPrint?: boolean;
|
|
33768
|
+
/** 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. */
|
|
33769
|
+
quotaUser?: string;
|
|
33770
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
33771
|
+
upload_protocol?: string;
|
|
33772
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
33773
|
+
uploadType?: string;
|
|
33774
|
+
/** Request body */
|
|
33775
|
+
resource: GoogleCloudAiplatformV1beta1RebaseTunedModelRequest;
|
|
33776
|
+
}): Request<GoogleLongrunningOperation>;
|
|
33777
|
+
rebaseTunedModel(
|
|
33778
|
+
request: {
|
|
33779
|
+
/** V1 error format. */
|
|
33780
|
+
'$.xgafv'?: string;
|
|
33781
|
+
/** OAuth access token. */
|
|
33782
|
+
access_token?: string;
|
|
33783
|
+
/** Data format for response. */
|
|
33784
|
+
alt?: string;
|
|
33785
|
+
/** JSONP */
|
|
33786
|
+
callback?: string;
|
|
33787
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
33788
|
+
fields?: string;
|
|
33789
|
+
/** 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. */
|
|
33790
|
+
key?: string;
|
|
33791
|
+
/** OAuth 2.0 token for the current user. */
|
|
33792
|
+
oauth_token?: string;
|
|
33793
|
+
/** Required. The resource name of the Location into which to rebase the Model. Format: `projects/{project}/locations/{location}` */
|
|
33794
|
+
parent: string;
|
|
33795
|
+
/** Returns response with indentations and line breaks. */
|
|
33796
|
+
prettyPrint?: boolean;
|
|
33797
|
+
/** 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. */
|
|
33798
|
+
quotaUser?: string;
|
|
33799
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
33800
|
+
upload_protocol?: string;
|
|
33801
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
33802
|
+
uploadType?: string;
|
|
33803
|
+
},
|
|
33804
|
+
body: GoogleCloudAiplatformV1beta1RebaseTunedModelRequest
|
|
33805
|
+
): Request<GoogleLongrunningOperation>;
|
|
33806
|
+
operations: OperationsResource;
|
|
33551
33807
|
}
|
|
33552
33808
|
interface LocationsResource {
|
|
33553
33809
|
/** Given an input prompt, it returns augmented prompt from vertex rag store to guide LLM towards generating grounded responses. */
|