@maxim_mazurok/gapi.client.aiplatform-v1 0.4.20251028 → 0.4.20251107
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 +176 -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=v1
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20251107
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -366,7 +366,7 @@ declare namespace gapi.client {
|
|
|
366
366
|
samplingCount?: number;
|
|
367
367
|
}
|
|
368
368
|
interface GoogleCloudAiplatformV1AutoscalingMetricSpec {
|
|
369
|
-
/** 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` */
|
|
369
|
+
/** 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` * `pubsub.googleapis.com/subscription/num_undelivered_messages` */
|
|
370
370
|
metricName?: string;
|
|
371
371
|
/** 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. */
|
|
372
372
|
target?: number;
|
|
@@ -1155,7 +1155,7 @@ declare namespace gapi.client {
|
|
|
1155
1155
|
gcsSource?: GoogleCloudAiplatformV1GcsSource;
|
|
1156
1156
|
}
|
|
1157
1157
|
interface GoogleCloudAiplatformV1CustomCodeExecutionSpec {
|
|
1158
|
-
/** Required. Python function. Expected user to define the following function, e.g.: def evaluate(instance: dict[str, Any]) -> float: Please include this function signature in the code snippet. Instance is the evaluation instance, any fields populated in the instance are available to the function as instance[field_name]. Example: Example input: ``` instance= EvaluationInstance( response=EvaluationInstance.InstanceData(text="The answer is 4."), reference=EvaluationInstance.InstanceData(text="4") ) ``` Example converted input: ``` { 'response': {'text': 'The answer is 4.'}, 'reference': {'text': '4'} } ``` Example python function: ``` def evaluate(instance: dict[str, Any]) -> float: if instance'response' == instance'reference': return 1.0 return 0.0 ``` */
|
|
1158
|
+
/** Required. Python function. Expected user to define the following function, e.g.: def evaluate(instance: dict[str, Any]) -> float: Please include this function signature in the code snippet. Instance is the evaluation instance, any fields populated in the instance are available to the function as instance[field_name]. Example: Example input: ``` instance= EvaluationInstance( response=EvaluationInstance.InstanceData(text="The answer is 4."), reference=EvaluationInstance.InstanceData(text="4") ) ``` Example converted input: ``` { 'response': {'text': 'The answer is 4.'}, 'reference': {'text': '4'} } ``` Example python function: ``` def evaluate(instance: dict[str, Any]) -> float: if instance'response' == instance'reference': return 1.0 return 0.0 ``` CustomCodeExecutionSpec is also supported in Batch Evaluation (EvalDataset RPC) and Tuning Evaluation. Each line in the input jsonl file will be converted to dict[str, Any] and passed to the evaluation function. */
|
|
1159
1159
|
evaluationFunction?: string;
|
|
1160
1160
|
}
|
|
1161
1161
|
interface GoogleCloudAiplatformV1CustomJob {
|
|
@@ -2032,7 +2032,7 @@ declare namespace gapi.client {
|
|
|
2032
2032
|
prompt?: GoogleCloudAiplatformV1EvaluationInstanceInstanceData;
|
|
2033
2033
|
/** Optional. Data used to populate placeholder `reference` in a metric prompt template. */
|
|
2034
2034
|
reference?: GoogleCloudAiplatformV1EvaluationInstanceInstanceData;
|
|
2035
|
-
/**
|
|
2035
|
+
/** Optional. Data used to populate placeholder `response` in a metric prompt template. */
|
|
2036
2036
|
response?: GoogleCloudAiplatformV1EvaluationInstanceInstanceData;
|
|
2037
2037
|
/** Optional. Named groups of rubrics associated with the prompt. This is used for rubric-based evaluations where rubrics can be referenced by a key. The key could represent versions, associated metrics, etc. */
|
|
2038
2038
|
rubricGroups?: {[P in string]: GoogleCloudAiplatformV1RubricGroup};
|
|
@@ -2056,8 +2056,6 @@ declare namespace gapi.client {
|
|
|
2056
2056
|
developerInstruction?: GoogleCloudAiplatformV1EvaluationInstanceInstanceData;
|
|
2057
2057
|
/** A list of events. */
|
|
2058
2058
|
events?: GoogleCloudAiplatformV1EvaluationInstanceAgentDataEvents;
|
|
2059
|
-
/** A JSON string containing a sequence of events. */
|
|
2060
|
-
eventsText?: string;
|
|
2061
2059
|
/** List of tools. */
|
|
2062
2060
|
tools?: GoogleCloudAiplatformV1EvaluationInstanceAgentDataTools;
|
|
2063
2061
|
/** A JSON string containing a list of tools available to an agent with info such as name, description, parameters and required parameters. Example: [ { "name": "search_actors", "description": "Search for actors in a movie. Returns a list of actors, their roles, their birthdate, and their place of birth.", "parameters": [ { "name": "movie_name", "description": "The name of the movie." }, { "name": "character_name", "description": "The name of the character." } ], "required": ["movie_name", "character_name"] } ] */
|
|
@@ -7875,6 +7873,20 @@ declare namespace gapi.client {
|
|
|
7875
7873
|
/** The parts of the variable value. */
|
|
7876
7874
|
partList?: GoogleCloudAiplatformV1SchemaPromptSpecPartList;
|
|
7877
7875
|
}
|
|
7876
|
+
interface GoogleCloudAiplatformV1SchemaPromptSpecAppBuilderData {
|
|
7877
|
+
/** Serialized state of the code repository. This string will typically contain a JSON representation of the UI's CodeRepositoryService state (files, folders, content, and any metadata). The UI is responsible for serialization and deserialization. */
|
|
7878
|
+
codeRepositoryState?: string;
|
|
7879
|
+
/** Linked resources attached to the application by the user. */
|
|
7880
|
+
linkedResources?: GoogleCloudAiplatformV1SchemaPromptSpecAppBuilderDataLinkedResource[];
|
|
7881
|
+
}
|
|
7882
|
+
interface GoogleCloudAiplatformV1SchemaPromptSpecAppBuilderDataLinkedResource {
|
|
7883
|
+
/** A user-friendly name for the data source shown in the UI. */
|
|
7884
|
+
displayName?: string;
|
|
7885
|
+
/** The unique resource name of the data source. The format is determined by the 'type' field. For type "SAVED_PROMPT": projects/{project}/locations/{location}/datasets/{dataset} For type "AI_AGENT": projects/{project}/locations/{location}/agents/{agent} */
|
|
7886
|
+
name?: string;
|
|
7887
|
+
/** The type of the linked resource. e.g., "SAVED_PROMPT", "AI_AGENT" This string corresponds to the name of the LinkedResourceType enum member. See: google3/cloud/console/web/ai/platform/llm/prompts/build/services/specs_repository_service/linked_resources/linked_resource.ts */
|
|
7888
|
+
type?: string;
|
|
7889
|
+
}
|
|
7878
7890
|
interface GoogleCloudAiplatformV1SchemaPromptSpecMultimodalPrompt {
|
|
7879
7891
|
/** The prompt message. */
|
|
7880
7892
|
promptMessage?: GoogleCloudAiplatformV1SchemaPromptSpecPromptMessage;
|
|
@@ -7910,6 +7922,8 @@ declare namespace gapi.client {
|
|
|
7910
7922
|
referenceSentencePairs?: GoogleCloudAiplatformV1SchemaPromptSpecReferenceSentencePair[];
|
|
7911
7923
|
}
|
|
7912
7924
|
interface GoogleCloudAiplatformV1SchemaPromptSpecStructuredPrompt {
|
|
7925
|
+
/** Data for app builder use case. */
|
|
7926
|
+
appBuilderData?: GoogleCloudAiplatformV1SchemaPromptSpecAppBuilderData;
|
|
7913
7927
|
/** Preamble: The context of the prompt. */
|
|
7914
7928
|
context?: GoogleCloudAiplatformV1Content;
|
|
7915
7929
|
/** Preamble: A set of examples for expected model response. */
|
|
@@ -18702,6 +18716,35 @@ declare namespace gapi.client {
|
|
|
18702
18716
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
18703
18717
|
uploadType?: string;
|
|
18704
18718
|
}): Request<GoogleCloudAiplatformV1Dataset>;
|
|
18719
|
+
/** Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. */
|
|
18720
|
+
getIamPolicy(request?: {
|
|
18721
|
+
/** V1 error format. */
|
|
18722
|
+
'$.xgafv'?: string;
|
|
18723
|
+
/** OAuth access token. */
|
|
18724
|
+
access_token?: string;
|
|
18725
|
+
/** Data format for response. */
|
|
18726
|
+
alt?: string;
|
|
18727
|
+
/** JSONP */
|
|
18728
|
+
callback?: string;
|
|
18729
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
18730
|
+
fields?: string;
|
|
18731
|
+
/** 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. */
|
|
18732
|
+
key?: string;
|
|
18733
|
+
/** OAuth 2.0 token for the current user. */
|
|
18734
|
+
oauth_token?: string;
|
|
18735
|
+
/** Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). */
|
|
18736
|
+
'options.requestedPolicyVersion'?: number;
|
|
18737
|
+
/** Returns response with indentations and line breaks. */
|
|
18738
|
+
prettyPrint?: boolean;
|
|
18739
|
+
/** 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. */
|
|
18740
|
+
quotaUser?: string;
|
|
18741
|
+
/** REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. */
|
|
18742
|
+
resource: string;
|
|
18743
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
18744
|
+
upload_protocol?: string;
|
|
18745
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
18746
|
+
uploadType?: string;
|
|
18747
|
+
}): Request<GoogleIamV1Policy>;
|
|
18705
18748
|
/** Imports data into a Dataset. */
|
|
18706
18749
|
import(request: {
|
|
18707
18750
|
/** V1 error format. */
|
|
@@ -18912,6 +18955,65 @@ declare namespace gapi.client {
|
|
|
18912
18955
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
18913
18956
|
uploadType?: string;
|
|
18914
18957
|
}): Request<GoogleCloudAiplatformV1SearchDataItemsResponse>;
|
|
18958
|
+
/** Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. */
|
|
18959
|
+
setIamPolicy(
|
|
18960
|
+
request: {
|
|
18961
|
+
/** V1 error format. */
|
|
18962
|
+
'$.xgafv'?: string;
|
|
18963
|
+
/** OAuth access token. */
|
|
18964
|
+
access_token?: string;
|
|
18965
|
+
/** Data format for response. */
|
|
18966
|
+
alt?: string;
|
|
18967
|
+
/** JSONP */
|
|
18968
|
+
callback?: string;
|
|
18969
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
18970
|
+
fields?: string;
|
|
18971
|
+
/** 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. */
|
|
18972
|
+
key?: string;
|
|
18973
|
+
/** OAuth 2.0 token for the current user. */
|
|
18974
|
+
oauth_token?: string;
|
|
18975
|
+
/** Returns response with indentations and line breaks. */
|
|
18976
|
+
prettyPrint?: boolean;
|
|
18977
|
+
/** 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. */
|
|
18978
|
+
quotaUser?: string;
|
|
18979
|
+
/** REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. */
|
|
18980
|
+
resource: string;
|
|
18981
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
18982
|
+
upload_protocol?: string;
|
|
18983
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
18984
|
+
uploadType?: string;
|
|
18985
|
+
},
|
|
18986
|
+
body: GoogleIamV1SetIamPolicyRequest,
|
|
18987
|
+
): Request<GoogleIamV1Policy>;
|
|
18988
|
+
/** Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. */
|
|
18989
|
+
testIamPermissions(request?: {
|
|
18990
|
+
/** V1 error format. */
|
|
18991
|
+
'$.xgafv'?: string;
|
|
18992
|
+
/** OAuth access token. */
|
|
18993
|
+
access_token?: string;
|
|
18994
|
+
/** Data format for response. */
|
|
18995
|
+
alt?: string;
|
|
18996
|
+
/** JSONP */
|
|
18997
|
+
callback?: string;
|
|
18998
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
18999
|
+
fields?: string;
|
|
19000
|
+
/** 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. */
|
|
19001
|
+
key?: string;
|
|
19002
|
+
/** OAuth 2.0 token for the current user. */
|
|
19003
|
+
oauth_token?: string;
|
|
19004
|
+
/** The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). */
|
|
19005
|
+
permissions?: string | string[];
|
|
19006
|
+
/** Returns response with indentations and line breaks. */
|
|
19007
|
+
prettyPrint?: boolean;
|
|
19008
|
+
/** 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. */
|
|
19009
|
+
quotaUser?: string;
|
|
19010
|
+
/** REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. */
|
|
19011
|
+
resource: string;
|
|
19012
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
19013
|
+
upload_protocol?: string;
|
|
19014
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
19015
|
+
uploadType?: string;
|
|
19016
|
+
}): Request<GoogleIamV1TestIamPermissionsResponse>;
|
|
18915
19017
|
annotationSpecs: AnnotationSpecsResource;
|
|
18916
19018
|
dataItems: DataItemsResource;
|
|
18917
19019
|
datasetVersions: DatasetVersionsResource;
|
|
@@ -19433,6 +19535,73 @@ declare namespace gapi.client {
|
|
|
19433
19535
|
interface DeployedModelsResource {
|
|
19434
19536
|
invoke: InvokeResource;
|
|
19435
19537
|
}
|
|
19538
|
+
interface ScienceResource {
|
|
19539
|
+
/** Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request. */
|
|
19540
|
+
inference(request: {
|
|
19541
|
+
/** V1 error format. */
|
|
19542
|
+
'$.xgafv'?: string;
|
|
19543
|
+
/** OAuth access token. */
|
|
19544
|
+
access_token?: string;
|
|
19545
|
+
/** Data format for response. */
|
|
19546
|
+
alt?: string;
|
|
19547
|
+
/** JSONP */
|
|
19548
|
+
callback?: string;
|
|
19549
|
+
/** ID of the DeployedModel that serves the invoke request. */
|
|
19550
|
+
deployedModelId?: string;
|
|
19551
|
+
/** Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` */
|
|
19552
|
+
endpoint: string;
|
|
19553
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
19554
|
+
fields?: string;
|
|
19555
|
+
/** 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. */
|
|
19556
|
+
key?: string;
|
|
19557
|
+
/** OAuth 2.0 token for the current user. */
|
|
19558
|
+
oauth_token?: string;
|
|
19559
|
+
/** Returns response with indentations and line breaks. */
|
|
19560
|
+
prettyPrint?: boolean;
|
|
19561
|
+
/** 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. */
|
|
19562
|
+
quotaUser?: string;
|
|
19563
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
19564
|
+
upload_protocol?: string;
|
|
19565
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
19566
|
+
uploadType?: string;
|
|
19567
|
+
/** Request body */
|
|
19568
|
+
resource: GoogleApiHttpBody;
|
|
19569
|
+
}): Request<GoogleApiHttpBody>;
|
|
19570
|
+
inference(
|
|
19571
|
+
request: {
|
|
19572
|
+
/** V1 error format. */
|
|
19573
|
+
'$.xgafv'?: string;
|
|
19574
|
+
/** OAuth access token. */
|
|
19575
|
+
access_token?: string;
|
|
19576
|
+
/** Data format for response. */
|
|
19577
|
+
alt?: string;
|
|
19578
|
+
/** JSONP */
|
|
19579
|
+
callback?: string;
|
|
19580
|
+
/** ID of the DeployedModel that serves the invoke request. */
|
|
19581
|
+
deployedModelId?: string;
|
|
19582
|
+
/** Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` */
|
|
19583
|
+
endpoint: string;
|
|
19584
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
19585
|
+
fields?: string;
|
|
19586
|
+
/** 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. */
|
|
19587
|
+
key?: string;
|
|
19588
|
+
/** OAuth 2.0 token for the current user. */
|
|
19589
|
+
oauth_token?: string;
|
|
19590
|
+
/** Returns response with indentations and line breaks. */
|
|
19591
|
+
prettyPrint?: boolean;
|
|
19592
|
+
/** 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. */
|
|
19593
|
+
quotaUser?: string;
|
|
19594
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
19595
|
+
upload_protocol?: string;
|
|
19596
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
19597
|
+
uploadType?: string;
|
|
19598
|
+
},
|
|
19599
|
+
body: GoogleApiHttpBody,
|
|
19600
|
+
): Request<GoogleApiHttpBody>;
|
|
19601
|
+
}
|
|
19602
|
+
interface GoogleResource {
|
|
19603
|
+
science: ScienceResource;
|
|
19604
|
+
}
|
|
19436
19605
|
interface InvokeResource {
|
|
19437
19606
|
/** Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request. */
|
|
19438
19607
|
invoke(request: {
|
|
@@ -20911,6 +21080,7 @@ declare namespace gapi.client {
|
|
|
20911
21080
|
): Request<GoogleLongrunningOperation>;
|
|
20912
21081
|
chat: ChatResource;
|
|
20913
21082
|
deployedModels: DeployedModelsResource;
|
|
21083
|
+
google: GoogleResource;
|
|
20914
21084
|
invoke: InvokeResource;
|
|
20915
21085
|
openapi: OpenapiResource;
|
|
20916
21086
|
operations: OperationsResource;
|