@maxim_mazurok/gapi.client.aiplatform-v1 0.0.20250319 → 0.0.20250331
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 +69 -4
- 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: 20250331
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -809,6 +809,14 @@ declare namespace gapi.client {
|
|
|
809
809
|
/** Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. */
|
|
810
810
|
role?: string;
|
|
811
811
|
}
|
|
812
|
+
interface GoogleCloudAiplatformV1ContentMap {
|
|
813
|
+
/** Optional. Map of placeholder to contents. */
|
|
814
|
+
values?: {[P in string]: GoogleCloudAiplatformV1ContentMapContents};
|
|
815
|
+
}
|
|
816
|
+
interface GoogleCloudAiplatformV1ContentMapContents {
|
|
817
|
+
/** Optional. Repeated contents. */
|
|
818
|
+
contents?: GoogleCloudAiplatformV1Content[];
|
|
819
|
+
}
|
|
812
820
|
interface GoogleCloudAiplatformV1Context {
|
|
813
821
|
/** Output only. Timestamp when this Context was created. */
|
|
814
822
|
createTime?: string;
|
|
@@ -1095,6 +1103,14 @@ declare namespace gapi.client {
|
|
|
1095
1103
|
/** Required. The spec of the worker pools including machine type and Docker image. All worker pools except the first one are optional and can be skipped by providing an empty value. */
|
|
1096
1104
|
workerPoolSpecs?: GoogleCloudAiplatformV1WorkerPoolSpec[];
|
|
1097
1105
|
}
|
|
1106
|
+
interface GoogleCloudAiplatformV1CustomOutput {
|
|
1107
|
+
/** Output only. List of raw output strings. */
|
|
1108
|
+
rawOutputs?: GoogleCloudAiplatformV1RawOutput;
|
|
1109
|
+
}
|
|
1110
|
+
interface GoogleCloudAiplatformV1CustomOutputFormatConfig {
|
|
1111
|
+
/** Optional. Whether to return raw output. */
|
|
1112
|
+
returnRawOutput?: boolean;
|
|
1113
|
+
}
|
|
1098
1114
|
interface GoogleCloudAiplatformV1DataItem {
|
|
1099
1115
|
/** Output only. Timestamp when this DataItem was created. */
|
|
1100
1116
|
createTime?: string;
|
|
@@ -1477,7 +1493,7 @@ declare namespace gapi.client {
|
|
|
1477
1493
|
clientConnectionConfig?: GoogleCloudAiplatformV1ClientConnectionConfig;
|
|
1478
1494
|
/** Output only. Timestamp when this Endpoint was created. */
|
|
1479
1495
|
createTime?: string;
|
|
1480
|
-
/** Output only. DNS of the dedicated endpoint. Will only be populated if dedicated_endpoint_enabled is true. Format: `https://{endpoint_id}.{region}-{
|
|
1496
|
+
/** Output only. DNS of the dedicated endpoint. Will only be populated if dedicated_endpoint_enabled is true. Depending on the features enabled, uid might be a random number or a string. For example, if fast_tryout is enabled, uid will be fasttryout. Format: `https://{endpoint_id}.{region}-{uid}.prediction.vertexai.goog`. */
|
|
1481
1497
|
dedicatedEndpointDns?: string;
|
|
1482
1498
|
/** 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 limitation will be removed soon. */
|
|
1483
1499
|
dedicatedEndpointEnabled?: boolean;
|
|
@@ -1590,7 +1606,7 @@ declare namespace gapi.client {
|
|
|
1590
1606
|
explanationType?: string;
|
|
1591
1607
|
}
|
|
1592
1608
|
interface GoogleCloudAiplatformV1EvaluateDatasetRequest {
|
|
1593
|
-
/** Optional. Autorater config used for evaluation. */
|
|
1609
|
+
/** Optional. Autorater config used for evaluation. Currently only publisher Gemini models are supported. Format: `projects/{PROJECT}/locations/{LOCATION}/publishers/google/models/{MODEL}.` */
|
|
1594
1610
|
autoraterConfig?: GoogleCloudAiplatformV1AutoraterConfig;
|
|
1595
1611
|
/** Required. The dataset used for evaluation. */
|
|
1596
1612
|
dataset?: GoogleCloudAiplatformV1EvaluationDataset;
|
|
@@ -1636,6 +1652,8 @@ declare namespace gapi.client {
|
|
|
1636
1652
|
questionAnsweringRelevanceInput?: GoogleCloudAiplatformV1QuestionAnsweringRelevanceInput;
|
|
1637
1653
|
/** Instances and metric spec for rouge metric. */
|
|
1638
1654
|
rougeInput?: GoogleCloudAiplatformV1RougeInput;
|
|
1655
|
+
/** Rubric Based Instruction Following metric. */
|
|
1656
|
+
rubricBasedInstructionFollowingInput?: GoogleCloudAiplatformV1RubricBasedInstructionFollowingInput;
|
|
1639
1657
|
/** Input for safety metric. */
|
|
1640
1658
|
safetyInput?: GoogleCloudAiplatformV1SafetyInput;
|
|
1641
1659
|
/** Input for summarization helpfulness metric. */
|
|
@@ -1700,6 +1718,8 @@ declare namespace gapi.client {
|
|
|
1700
1718
|
questionAnsweringRelevanceResult?: GoogleCloudAiplatformV1QuestionAnsweringRelevanceResult;
|
|
1701
1719
|
/** Results for rouge metric. */
|
|
1702
1720
|
rougeResults?: GoogleCloudAiplatformV1RougeResults;
|
|
1721
|
+
/** Result for rubric based instruction following metric. */
|
|
1722
|
+
rubricBasedInstructionFollowingResult?: GoogleCloudAiplatformV1RubricBasedInstructionFollowingResult;
|
|
1703
1723
|
/** Result for safety metric. */
|
|
1704
1724
|
safetyResult?: GoogleCloudAiplatformV1SafetyResult;
|
|
1705
1725
|
/** Result for summarization helpfulness metric. */
|
|
@@ -1732,7 +1752,7 @@ declare namespace gapi.client {
|
|
|
1732
1752
|
interface GoogleCloudAiplatformV1EvaluationDataset {
|
|
1733
1753
|
/** BigQuery source holds the dataset. */
|
|
1734
1754
|
bigquerySource?: GoogleCloudAiplatformV1BigQuerySource;
|
|
1735
|
-
/** Cloud storage source holds the dataset. */
|
|
1755
|
+
/** Cloud storage source holds the dataset. Currently only one Cloud Storage file path is supported. */
|
|
1736
1756
|
gcsSource?: GoogleCloudAiplatformV1GcsSource;
|
|
1737
1757
|
}
|
|
1738
1758
|
interface GoogleCloudAiplatformV1Event {
|
|
@@ -2727,6 +2747,8 @@ declare namespace gapi.client {
|
|
|
2727
2747
|
toolUsePromptTokensDetails?: GoogleCloudAiplatformV1ModalityTokenCount[];
|
|
2728
2748
|
/** Total token count for prompt, response candidates, and tool-use prompts (if present). */
|
|
2729
2749
|
totalTokenCount?: number;
|
|
2750
|
+
/** Output only. Traffic type. This shows whether a request consumes Pay-As-You-Go or Provisioned Throughput quota. */
|
|
2751
|
+
trafficType?: string;
|
|
2730
2752
|
}
|
|
2731
2753
|
interface GoogleCloudAiplatformV1GenerateVideoResponse {
|
|
2732
2754
|
/** The cloud storage uris of the generated videos. */
|
|
@@ -4622,10 +4644,14 @@ declare namespace gapi.client {
|
|
|
4622
4644
|
metricSpec?: GoogleCloudAiplatformV1PairwiseMetricSpec;
|
|
4623
4645
|
}
|
|
4624
4646
|
interface GoogleCloudAiplatformV1PairwiseMetricInstance {
|
|
4647
|
+
/** Key-value contents for the mutlimodality input, including text, image, video, audio, and pdf, etc. The key is placeholder in metric prompt template, and the value is the multimodal content. */
|
|
4648
|
+
contentMapInstance?: GoogleCloudAiplatformV1ContentMap;
|
|
4625
4649
|
/** Instance specified as a json string. String key-value pairs are expected in the json_instance to render PairwiseMetricSpec.instance_prompt_template. */
|
|
4626
4650
|
jsonInstance?: string;
|
|
4627
4651
|
}
|
|
4628
4652
|
interface GoogleCloudAiplatformV1PairwiseMetricResult {
|
|
4653
|
+
/** Output only. Spec for custom output. */
|
|
4654
|
+
customOutput?: GoogleCloudAiplatformV1CustomOutput;
|
|
4629
4655
|
/** Output only. Explanation for pairwise metric score. */
|
|
4630
4656
|
explanation?: string;
|
|
4631
4657
|
/** Output only. Pairwise metric choice. */
|
|
@@ -4636,6 +4662,8 @@ declare namespace gapi.client {
|
|
|
4636
4662
|
baselineResponseFieldName?: string;
|
|
4637
4663
|
/** Optional. The field name of the candidate response. */
|
|
4638
4664
|
candidateResponseFieldName?: string;
|
|
4665
|
+
/** Optional. CustomOutputFormatConfig allows customization of metric output. When this config is set, the default output is replaced with the raw output string. If a custom format is chosen, the `pairwise_choice` and `explanation` fields in the corresponding metric result will be empty. */
|
|
4666
|
+
customOutputFormatConfig?: GoogleCloudAiplatformV1CustomOutputFormatConfig;
|
|
4639
4667
|
/** Required. Metric prompt template for pairwise metric. */
|
|
4640
4668
|
metricPromptTemplate?: string;
|
|
4641
4669
|
/** Optional. System instructions for pairwise metric. */
|
|
@@ -4910,16 +4938,22 @@ declare namespace gapi.client {
|
|
|
4910
4938
|
metricSpec?: GoogleCloudAiplatformV1PointwiseMetricSpec;
|
|
4911
4939
|
}
|
|
4912
4940
|
interface GoogleCloudAiplatformV1PointwiseMetricInstance {
|
|
4941
|
+
/** Key-value contents for the mutlimodality input, including text, image, video, audio, and pdf, etc. The key is placeholder in metric prompt template, and the value is the multimodal content. */
|
|
4942
|
+
contentMapInstance?: GoogleCloudAiplatformV1ContentMap;
|
|
4913
4943
|
/** Instance specified as a json string. String key-value pairs are expected in the json_instance to render PointwiseMetricSpec.instance_prompt_template. */
|
|
4914
4944
|
jsonInstance?: string;
|
|
4915
4945
|
}
|
|
4916
4946
|
interface GoogleCloudAiplatformV1PointwiseMetricResult {
|
|
4947
|
+
/** Output only. Spec for custom output. */
|
|
4948
|
+
customOutput?: GoogleCloudAiplatformV1CustomOutput;
|
|
4917
4949
|
/** Output only. Explanation for pointwise metric score. */
|
|
4918
4950
|
explanation?: string;
|
|
4919
4951
|
/** Output only. Pointwise metric score. */
|
|
4920
4952
|
score?: number;
|
|
4921
4953
|
}
|
|
4922
4954
|
interface GoogleCloudAiplatformV1PointwiseMetricSpec {
|
|
4955
|
+
/** Optional. CustomOutputFormatConfig allows customization of metric output. By default, metrics return a score and explanation. When this config is set, the default output is replaced with either: - The raw output string. - A parsed output based on a user-defined schema. If a custom format is chosen, the `score` and `explanation` fields in the corresponding metric result will be empty. */
|
|
4956
|
+
customOutputFormatConfig?: GoogleCloudAiplatformV1CustomOutputFormatConfig;
|
|
4923
4957
|
/** Required. Metric prompt template for pointwise metric. */
|
|
4924
4958
|
metricPromptTemplate?: string;
|
|
4925
4959
|
/** Optional. System instructions for pointwise metric. */
|
|
@@ -5566,6 +5600,10 @@ declare namespace gapi.client {
|
|
|
5566
5600
|
/** The resource name of the Index Endpoint. Format: `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}` */
|
|
5567
5601
|
indexEndpoint?: string;
|
|
5568
5602
|
}
|
|
5603
|
+
interface GoogleCloudAiplatformV1RawOutput {
|
|
5604
|
+
/** Output only. Raw output string. */
|
|
5605
|
+
rawOutput?: string[];
|
|
5606
|
+
}
|
|
5569
5607
|
interface GoogleCloudAiplatformV1RawPredictRequest {
|
|
5570
5608
|
/** The prediction input. Supports HTTP headers and arbitrary data payload. A DeployedModel may have an upper limit on the number of instances it supports per request. When this limit it is exceeded for an AutoML model, the RawPredict method returns an error. When this limit is exceeded for a custom-trained model, the behavior varies depending on the model. You can specify the schema for each instance in the predict_schemata.instance_schema_uri field when you create a Model. This schema applies when you deploy the `Model` as a `DeployedModel` to an Endpoint and use the `RawPredict` method. */
|
|
5571
5609
|
httpBody?: GoogleApiHttpBody;
|
|
@@ -5850,6 +5888,29 @@ declare namespace gapi.client {
|
|
|
5850
5888
|
/** Optional. Whether to use stemmer to compute rouge score. */
|
|
5851
5889
|
useStemmer?: boolean;
|
|
5852
5890
|
}
|
|
5891
|
+
interface GoogleCloudAiplatformV1RubricBasedInstructionFollowingInput {
|
|
5892
|
+
/** Required. Instance for RubricBasedInstructionFollowing metric. */
|
|
5893
|
+
instance?: GoogleCloudAiplatformV1RubricBasedInstructionFollowingInstance;
|
|
5894
|
+
/** Required. Spec for RubricBasedInstructionFollowing metric. */
|
|
5895
|
+
metricSpec?: any;
|
|
5896
|
+
}
|
|
5897
|
+
interface GoogleCloudAiplatformV1RubricBasedInstructionFollowingInstance {
|
|
5898
|
+
/** Required. Instance specified as a json string. String key-value pairs are expected in the json_instance to render RubricBasedInstructionFollowing prompt templates. */
|
|
5899
|
+
jsonInstance?: string;
|
|
5900
|
+
}
|
|
5901
|
+
interface GoogleCloudAiplatformV1RubricBasedInstructionFollowingResult {
|
|
5902
|
+
/** Output only. List of per rubric critique results. */
|
|
5903
|
+
rubricCritiqueResults?: GoogleCloudAiplatformV1RubricCritiqueResult[];
|
|
5904
|
+
/** Output only. Overall score for the instruction following. */
|
|
5905
|
+
score?: number;
|
|
5906
|
+
}
|
|
5907
|
+
interface GoogleCloudAiplatformV1RubricBasedInstructionFollowingSpec {}
|
|
5908
|
+
interface GoogleCloudAiplatformV1RubricCritiqueResult {
|
|
5909
|
+
/** Output only. Rubric to be evaluated. */
|
|
5910
|
+
rubric?: string;
|
|
5911
|
+
/** Output only. Verdict for the rubric - true if the rubric is met, false otherwise. */
|
|
5912
|
+
verdict?: boolean;
|
|
5913
|
+
}
|
|
5853
5914
|
interface GoogleCloudAiplatformV1SafetyInput {
|
|
5854
5915
|
/** Required. Safety instance. */
|
|
5855
5916
|
instance?: GoogleCloudAiplatformV1SafetyInstance;
|
|
@@ -27353,6 +27414,8 @@ declare namespace gapi.client {
|
|
|
27353
27414
|
callback?: string;
|
|
27354
27415
|
/** Selector specifying which fields to include in a partial response. */
|
|
27355
27416
|
fields?: string;
|
|
27417
|
+
/** Optional. If set to true, child resources of this reasoning engine will also be deleted. Otherwise, the request will fail with FAILED_PRECONDITION error when the reasoning engine has undeleted child resources. */
|
|
27418
|
+
force?: boolean;
|
|
27356
27419
|
/** 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. */
|
|
27357
27420
|
key?: string;
|
|
27358
27421
|
/** Required. The name of the ReasoningEngine resource to be deleted. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` */
|
|
@@ -32287,6 +32350,8 @@ declare namespace gapi.client {
|
|
|
32287
32350
|
alt?: string;
|
|
32288
32351
|
/** JSONP */
|
|
32289
32352
|
callback?: string;
|
|
32353
|
+
/** Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. */
|
|
32354
|
+
extraLocationTypes?: string | string[];
|
|
32290
32355
|
/** Selector specifying which fields to include in a partial response. */
|
|
32291
32356
|
fields?: string;
|
|
32292
32357
|
/** A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). */
|