@maxim_mazurok/gapi.client.aiplatform-v1 0.0.20250728 → 0.0.20250806
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 +41 -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=v1
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20250806
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -364,7 +364,7 @@ declare namespace gapi.client {
|
|
|
364
364
|
samplingCount?: number;
|
|
365
365
|
}
|
|
366
366
|
interface GoogleCloudAiplatformV1AutoscalingMetricSpec {
|
|
367
|
-
/** Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` */
|
|
367
|
+
/** Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` * `aiplatform.googleapis.com/prediction/online/request_count` */
|
|
368
368
|
metricName?: string;
|
|
369
369
|
/** The target resource utilization in percentage (1% - 100%) for the given metric; once the real usage deviates from the target by a certain percentage, the machine replicas change. The default value is 60 (representing 60%) if not provided. */
|
|
370
370
|
target?: number;
|
|
@@ -1374,6 +1374,8 @@ declare namespace gapi.client {
|
|
|
1374
1374
|
deployedIndexAuthConfig?: GoogleCloudAiplatformV1DeployedIndexAuthConfig;
|
|
1375
1375
|
/** Optional. The deployment group can be no longer than 64 characters (eg: 'test', 'prod'). If not set, we will use the 'default' deployment group. Creating `deployment_groups` with `reserved_ip_ranges` is a recommended practice when the peered network has multiple peering ranges. This creates your deployments from predictable IP spaces for easier traffic administration. Also, one deployment_group (except 'default') can only be used with the same reserved_ip_ranges which means if the deployment_group has been used with reserved_ip_ranges: [a, b, c], using it with [a, b] or [d, e] is disallowed. Note: we only support up to 5 deployment groups(not including 'default'). */
|
|
1376
1376
|
deploymentGroup?: string;
|
|
1377
|
+
/** Optional. The deployment tier that the index is deployed to. DEPLOYMENT_TIER_UNSPECIFIED defaults to PERFORMANCE. */
|
|
1378
|
+
deploymentTier?: string;
|
|
1377
1379
|
/** The display name of the DeployedIndex. If not provided upon creation, the Index's display_name is used. */
|
|
1378
1380
|
displayName?: string;
|
|
1379
1381
|
/** Optional. If true, private endpoint's access logs are sent to Cloud Logging. These logs are like standard server access logs, containing information like timestamp and latency for each MatchRequest. Note that logs may incur a cost, especially if the deployed index receives a high queries per second rate (QPS). Estimate your costs before enabling this option. */
|
|
@@ -1550,10 +1552,14 @@ declare namespace gapi.client {
|
|
|
1550
1552
|
systemLabels?: {[P in string]: string};
|
|
1551
1553
|
}
|
|
1552
1554
|
interface GoogleCloudAiplatformV1DeployRequestEndpointConfig {
|
|
1553
|
-
/** Optional.
|
|
1555
|
+
/** Optional. By default, if dedicated endpoint is enabled, the endpoint will be exposed through a dedicated DNS [Endpoint.dedicated_endpoint_dns]. Your request to the dedicated DNS will be isolated from other users' traffic and will have better performance and reliability. Note: Once you enabled dedicated endpoint, you won't be able to send request to the shared DNS {region}-aiplatform.googleapis.com. The limitations will be removed soon. If this field is set to true, the dedicated endpoint will be disabled and the deployed model will be exposed through the shared DNS {region}-aiplatform.googleapis.com. */
|
|
1556
|
+
dedicatedEndpointDisabled?: boolean;
|
|
1557
|
+
/** Optional. Deprecated. Use dedicated_endpoint_disabled instead. If true, the endpoint will be exposed through a dedicated DNS [Endpoint.dedicated_endpoint_dns]. Your request to the dedicated DNS will be isolated from other users' traffic and will have better performance and reliability. Note: Once you enabled dedicated endpoint, you won't be able to send request to the shared DNS {region}-aiplatform.googleapis.com. The limitations will be removed soon. */
|
|
1554
1558
|
dedicatedEndpointEnabled?: boolean;
|
|
1555
1559
|
/** Optional. The user-specified display name of the endpoint. If not set, a default name will be used. */
|
|
1556
1560
|
endpointDisplayName?: string;
|
|
1561
|
+
/** Optional. Immutable. The ID to use for endpoint, which will become the final component of the endpoint resource name. If not provided, Vertex AI will generate a value for this ID. If the first character is a letter, this value may be up to 63 characters, and valid characters are `[a-z0-9-]`. The last character must be a letter or number. If the first character is a number, this value may be up to 9 characters, and valid characters are `[0-9]` with no leading zeros. When using HTTP/JSON, this field is populated based on a query string argument, such as `?endpoint_id=12345`. This is the fallback for fields that are not included in either the URI or the body. */
|
|
1562
|
+
endpointUserId?: string;
|
|
1557
1563
|
}
|
|
1558
1564
|
interface GoogleCloudAiplatformV1DeployRequestModelConfig {
|
|
1559
1565
|
/** Optional. Whether the user accepts the End User License Agreement (EULA) for the model. */
|
|
@@ -1680,7 +1686,10 @@ declare namespace gapi.client {
|
|
|
1680
1686
|
/** Output only. Timestamp when this Endpoint was last updated. */
|
|
1681
1687
|
updateTime?: string;
|
|
1682
1688
|
}
|
|
1683
|
-
interface GoogleCloudAiplatformV1EnterpriseWebSearch {
|
|
1689
|
+
interface GoogleCloudAiplatformV1EnterpriseWebSearch {
|
|
1690
|
+
/** Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. */
|
|
1691
|
+
excludeDomains?: string[];
|
|
1692
|
+
}
|
|
1684
1693
|
interface GoogleCloudAiplatformV1EntityIdSelector {
|
|
1685
1694
|
/** Source of Csv */
|
|
1686
1695
|
csvSource?: GoogleCloudAiplatformV1CsvSource;
|
|
@@ -2904,6 +2913,8 @@ declare namespace gapi.client {
|
|
|
2904
2913
|
generationConfig?: GoogleCloudAiplatformV1GenerationConfig;
|
|
2905
2914
|
/** 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. */
|
|
2906
2915
|
labels?: {[P in string]: string};
|
|
2916
|
+
/** Optional. Settings for prompt and response sanitization using the Model Armor service. If supplied, safety_settings must not be supplied. */
|
|
2917
|
+
modelArmorConfig?: GoogleCloudAiplatformV1ModelArmorConfig;
|
|
2907
2918
|
/** Optional. Per request settings for blocking unsafe content. Enforced on GenerateContentResponse.candidates. */
|
|
2908
2919
|
safetySettings?: GoogleCloudAiplatformV1SafetySetting[];
|
|
2909
2920
|
/** 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. */
|
|
@@ -3144,6 +3155,8 @@ declare namespace gapi.client {
|
|
|
3144
3155
|
review?: string;
|
|
3145
3156
|
}
|
|
3146
3157
|
interface GoogleCloudAiplatformV1GroundingChunkRetrievedContext {
|
|
3158
|
+
/** Output only. The full document name for the referenced Vertex AI Search document. */
|
|
3159
|
+
documentName?: string;
|
|
3147
3160
|
/** Additional context for the RAG retrieval result. This is only populated when using the RAG retrieval tool. */
|
|
3148
3161
|
ragChunk?: GoogleCloudAiplatformV1RagChunk;
|
|
3149
3162
|
/** Text of the attribution. */
|
|
@@ -4149,6 +4162,12 @@ declare namespace gapi.client {
|
|
|
4149
4162
|
/** Output only. Timestamp when this version was most recently updated. */
|
|
4150
4163
|
versionUpdateTime?: string;
|
|
4151
4164
|
}
|
|
4165
|
+
interface GoogleCloudAiplatformV1ModelArmorConfig {
|
|
4166
|
+
/** Optional. The name of the Model Armor template to use for prompt sanitization. */
|
|
4167
|
+
promptTemplateName?: string;
|
|
4168
|
+
/** Optional. The name of the Model Armor template to use for response sanitization. */
|
|
4169
|
+
responseTemplateName?: string;
|
|
4170
|
+
}
|
|
4152
4171
|
interface GoogleCloudAiplatformV1ModelBaseModelSource {
|
|
4153
4172
|
/** Information about the base model of Genie models. */
|
|
4154
4173
|
genieSource?: GoogleCloudAiplatformV1GenieSource;
|
|
@@ -6109,8 +6128,18 @@ declare namespace gapi.client {
|
|
|
6109
6128
|
serviceAccount?: string;
|
|
6110
6129
|
}
|
|
6111
6130
|
interface GoogleCloudAiplatformV1ReasoningEngineSpecDeploymentSpec {
|
|
6131
|
+
/** Optional. Concurrency for each container and agent server. Recommended value: 2 * cpu + 1. Defaults to 9. */
|
|
6132
|
+
containerConcurrency?: number;
|
|
6112
6133
|
/** Optional. Environment variables to be set with the Reasoning Engine deployment. The environment variables can be updated through the UpdateReasoningEngine API. */
|
|
6113
6134
|
env?: GoogleCloudAiplatformV1EnvVar[];
|
|
6135
|
+
/** Optional. The maximum number of application instances that can be launched to handle increased traffic. Defaults to 100. */
|
|
6136
|
+
maxInstances?: number;
|
|
6137
|
+
/** Optional. The minimum number of application instances that will be kept running at all times. Defaults to 1. */
|
|
6138
|
+
minInstances?: number;
|
|
6139
|
+
/** Optional. Configuration for PSC-I. */
|
|
6140
|
+
pscInterfaceConfig?: GoogleCloudAiplatformV1PscInterfaceConfig;
|
|
6141
|
+
/** Optional. Resource limits for each container. Only 'cpu' and 'memory' keys are supported. Defaults to {"cpu": "4", "memory": "4Gi"}. * The only supported values for CPU are '1', '2', '4', and '8'. For more information, go to https://cloud.google.com/run/docs/configuring/cpu. * For supported 'memory' values and syntax, go to https://cloud.google.com/run/docs/configuring/memory-limits */
|
|
6142
|
+
resourceLimits?: {[P in string]: string};
|
|
6114
6143
|
/** Optional. Environment variables where the value is a secret in Cloud Secret Manager. To use this feature, add 'Secret Manager Secret Accessor' role (roles/secretmanager.secretAccessor) to AI Platform Reasoning Engine Service Agent. */
|
|
6115
6144
|
secretEnv?: GoogleCloudAiplatformV1SecretEnvVar[];
|
|
6116
6145
|
}
|
|
@@ -8714,16 +8743,14 @@ declare namespace gapi.client {
|
|
|
8714
8743
|
interface GoogleCloudAiplatformV1Tool {
|
|
8715
8744
|
/** Optional. CodeExecution tool type. Enables the model to execute code as part of generation. */
|
|
8716
8745
|
codeExecution?: any;
|
|
8717
|
-
/** Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. */
|
|
8718
|
-
computerUse?: GoogleCloudAiplatformV1ToolComputerUse;
|
|
8719
8746
|
/** Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. */
|
|
8720
|
-
enterpriseWebSearch?:
|
|
8747
|
+
enterpriseWebSearch?: GoogleCloudAiplatformV1EnterpriseWebSearch;
|
|
8721
8748
|
/** 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 512 function declarations can be provided. */
|
|
8722
8749
|
functionDeclarations?: GoogleCloudAiplatformV1FunctionDeclaration[];
|
|
8723
8750
|
/** Optional. GoogleMaps tool type. Tool to support Google Maps in Model. */
|
|
8724
8751
|
googleMaps?: GoogleCloudAiplatformV1GoogleMaps;
|
|
8725
8752
|
/** Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. */
|
|
8726
|
-
googleSearch?:
|
|
8753
|
+
googleSearch?: GoogleCloudAiplatformV1ToolGoogleSearch;
|
|
8727
8754
|
/** Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. */
|
|
8728
8755
|
googleSearchRetrieval?: GoogleCloudAiplatformV1GoogleSearchRetrieval;
|
|
8729
8756
|
/** 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. */
|
|
@@ -8759,17 +8786,16 @@ declare namespace gapi.client {
|
|
|
8759
8786
|
}
|
|
8760
8787
|
interface GoogleCloudAiplatformV1ToolCallValidSpec {}
|
|
8761
8788
|
interface GoogleCloudAiplatformV1ToolCodeExecution {}
|
|
8762
|
-
interface GoogleCloudAiplatformV1ToolComputerUse {
|
|
8763
|
-
/** Required. The environment being operated. */
|
|
8764
|
-
environment?: string;
|
|
8765
|
-
}
|
|
8766
8789
|
interface GoogleCloudAiplatformV1ToolConfig {
|
|
8767
8790
|
/** Optional. Function calling config. */
|
|
8768
8791
|
functionCallingConfig?: GoogleCloudAiplatformV1FunctionCallingConfig;
|
|
8769
8792
|
/** Optional. Retrieval config. */
|
|
8770
8793
|
retrievalConfig?: GoogleCloudAiplatformV1RetrievalConfig;
|
|
8771
8794
|
}
|
|
8772
|
-
interface GoogleCloudAiplatformV1ToolGoogleSearch {
|
|
8795
|
+
interface GoogleCloudAiplatformV1ToolGoogleSearch {
|
|
8796
|
+
/** Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. */
|
|
8797
|
+
excludeDomains?: string[];
|
|
8798
|
+
}
|
|
8773
8799
|
interface GoogleCloudAiplatformV1ToolNameMatchInput {
|
|
8774
8800
|
/** Required. Repeated tool name match instances. */
|
|
8775
8801
|
instances?: GoogleCloudAiplatformV1ToolNameMatchInstance[];
|
|
@@ -9320,6 +9346,8 @@ declare namespace gapi.client {
|
|
|
9320
9346
|
interface GoogleCloudAiplatformV1VideoMetadata {
|
|
9321
9347
|
/** Optional. The end offset of the video. */
|
|
9322
9348
|
endOffset?: string;
|
|
9349
|
+
/** Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. */
|
|
9350
|
+
fps?: number;
|
|
9323
9351
|
/** Optional. The start offset of the video. */
|
|
9324
9352
|
startOffset?: string;
|
|
9325
9353
|
}
|