@maxim_mazurok/gapi.client.aiplatform-v1 0.3.20251028 → 0.4.20251101
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 +305 -125
- 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: 20251101
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -641,9 +641,9 @@ declare namespace gapi.client {
|
|
|
641
641
|
useEffectiveOrder?: boolean;
|
|
642
642
|
}
|
|
643
643
|
interface GoogleCloudAiplatformV1Blob {
|
|
644
|
-
/** Required.
|
|
644
|
+
/** Required. The raw bytes of the data. */
|
|
645
645
|
data?: string;
|
|
646
|
-
/** Optional.
|
|
646
|
+
/** Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. */
|
|
647
647
|
displayName?: string;
|
|
648
648
|
/** Required. The IANA standard MIME type of the source data. */
|
|
649
649
|
mimeType?: string;
|
|
@@ -712,25 +712,25 @@ declare namespace gapi.client {
|
|
|
712
712
|
interface GoogleCloudAiplatformV1CancelTrainingPipelineRequest {}
|
|
713
713
|
interface GoogleCloudAiplatformV1CancelTuningJobRequest {}
|
|
714
714
|
interface GoogleCloudAiplatformV1Candidate {
|
|
715
|
-
/** Output only.
|
|
715
|
+
/** Output only. The average log probability of the tokens in this candidate. This is a length-normalized score that can be used to compare the quality of candidates of different lengths. A higher average log probability suggests a more confident and coherent response. */
|
|
716
716
|
avgLogprobs?: number;
|
|
717
|
-
/** Output only.
|
|
717
|
+
/** Output only. A collection of citations that apply to the generated content. */
|
|
718
718
|
citationMetadata?: GoogleCloudAiplatformV1CitationMetadata;
|
|
719
|
-
/** Output only.
|
|
719
|
+
/** Output only. The content of the candidate. */
|
|
720
720
|
content?: GoogleCloudAiplatformV1Content;
|
|
721
|
-
/** Output only. Describes the reason the
|
|
721
|
+
/** Output only. Describes the reason the model stopped generating tokens in more detail. This field is returned only when `finish_reason` is set. */
|
|
722
722
|
finishMessage?: string;
|
|
723
|
-
/** Output only. The reason why the model stopped generating tokens. If empty, the model has not stopped generating
|
|
723
|
+
/** Output only. The reason why the model stopped generating tokens. If empty, the model has not stopped generating. */
|
|
724
724
|
finishReason?: string;
|
|
725
|
-
/** Output only. Metadata
|
|
725
|
+
/** Output only. Metadata returned when grounding is enabled. It contains the sources used to ground the generated content. */
|
|
726
726
|
groundingMetadata?: GoogleCloudAiplatformV1GroundingMetadata;
|
|
727
|
-
/** Output only.
|
|
727
|
+
/** Output only. The 0-based index of this candidate in the list of generated responses. This is useful for distinguishing between multiple candidates when `candidate_count` > 1. */
|
|
728
728
|
index?: number;
|
|
729
|
-
/** Output only.
|
|
729
|
+
/** Output only. The detailed log probability information for the tokens in this candidate. This is useful for debugging, understanding model uncertainty, and identifying potential "hallucinations". */
|
|
730
730
|
logprobsResult?: GoogleCloudAiplatformV1LogprobsResult;
|
|
731
|
-
/** Output only.
|
|
731
|
+
/** Output only. A list of ratings for the safety of a response candidate. There is at most one rating per category. */
|
|
732
732
|
safetyRatings?: GoogleCloudAiplatformV1SafetyRating[];
|
|
733
|
-
/** Output only. Metadata
|
|
733
|
+
/** Output only. Metadata returned when the model uses the `url_context` tool to get information from a user-provided URL. */
|
|
734
734
|
urlContextMetadata?: GoogleCloudAiplatformV1UrlContextMetadata;
|
|
735
735
|
}
|
|
736
736
|
interface GoogleCloudAiplatformV1CandidateResponse {
|
|
@@ -777,21 +777,21 @@ declare namespace gapi.client {
|
|
|
777
777
|
shouldStop?: boolean;
|
|
778
778
|
}
|
|
779
779
|
interface GoogleCloudAiplatformV1Citation {
|
|
780
|
-
/** Output only.
|
|
780
|
+
/** Output only. The end index of the citation in the content. */
|
|
781
781
|
endIndex?: number;
|
|
782
|
-
/** Output only.
|
|
782
|
+
/** Output only. The license of the source of the citation. */
|
|
783
783
|
license?: string;
|
|
784
|
-
/** Output only.
|
|
784
|
+
/** Output only. The publication date of the source of the citation. */
|
|
785
785
|
publicationDate?: GoogleTypeDate;
|
|
786
|
-
/** Output only.
|
|
786
|
+
/** Output only. The start index of the citation in the content. */
|
|
787
787
|
startIndex?: number;
|
|
788
|
-
/** Output only.
|
|
788
|
+
/** Output only. The title of the source of the citation. */
|
|
789
789
|
title?: string;
|
|
790
|
-
/** Output only.
|
|
790
|
+
/** Output only. The URI of the source of the citation. */
|
|
791
791
|
uri?: string;
|
|
792
792
|
}
|
|
793
793
|
interface GoogleCloudAiplatformV1CitationMetadata {
|
|
794
|
-
/** Output only.
|
|
794
|
+
/** Output only. A list of citations for the content. */
|
|
795
795
|
citations?: GoogleCloudAiplatformV1Citation[];
|
|
796
796
|
}
|
|
797
797
|
interface GoogleCloudAiplatformV1Claim {
|
|
@@ -913,9 +913,9 @@ declare namespace gapi.client {
|
|
|
913
913
|
imageUri?: string;
|
|
914
914
|
}
|
|
915
915
|
interface GoogleCloudAiplatformV1Content {
|
|
916
|
-
/** Required.
|
|
916
|
+
/** Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. */
|
|
917
917
|
parts?: GoogleCloudAiplatformV1Part[];
|
|
918
|
-
/** Optional. The producer of the content. Must be either 'user' or 'model'.
|
|
918
|
+
/** Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. */
|
|
919
919
|
role?: string;
|
|
920
920
|
}
|
|
921
921
|
interface GoogleCloudAiplatformV1ContentMap {
|
|
@@ -1154,6 +1154,10 @@ declare namespace gapi.client {
|
|
|
1154
1154
|
/** Required. Google Cloud Storage location. */
|
|
1155
1155
|
gcsSource?: GoogleCloudAiplatformV1GcsSource;
|
|
1156
1156
|
}
|
|
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 ``` 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
|
+
evaluationFunction?: string;
|
|
1160
|
+
}
|
|
1157
1161
|
interface GoogleCloudAiplatformV1CustomJob {
|
|
1158
1162
|
/** Output only. Time when the CustomJob was created. */
|
|
1159
1163
|
createTime?: string;
|
|
@@ -1322,6 +1326,32 @@ declare namespace gapi.client {
|
|
|
1322
1326
|
/** Output only. Timestamp when this Dataset was last updated. */
|
|
1323
1327
|
updateTime?: string;
|
|
1324
1328
|
}
|
|
1329
|
+
interface GoogleCloudAiplatformV1DatasetDistribution {
|
|
1330
|
+
/** Output only. Defines the histogram bucket. */
|
|
1331
|
+
buckets?: GoogleCloudAiplatformV1DatasetDistributionDistributionBucket[];
|
|
1332
|
+
/** Output only. The maximum of the population values. */
|
|
1333
|
+
max?: number;
|
|
1334
|
+
/** Output only. The arithmetic mean of the values in the population. */
|
|
1335
|
+
mean?: number;
|
|
1336
|
+
/** Output only. The median of the values in the population. */
|
|
1337
|
+
median?: number;
|
|
1338
|
+
/** Output only. The minimum of the population values. */
|
|
1339
|
+
min?: number;
|
|
1340
|
+
/** Output only. The 5th percentile of the values in the population. */
|
|
1341
|
+
p5?: number;
|
|
1342
|
+
/** Output only. The 95th percentile of the values in the population. */
|
|
1343
|
+
p95?: number;
|
|
1344
|
+
/** Output only. Sum of a given population of values. */
|
|
1345
|
+
sum?: number;
|
|
1346
|
+
}
|
|
1347
|
+
interface GoogleCloudAiplatformV1DatasetDistributionDistributionBucket {
|
|
1348
|
+
/** Output only. Number of values in the bucket. */
|
|
1349
|
+
count?: string;
|
|
1350
|
+
/** Output only. Left bound of the bucket. */
|
|
1351
|
+
left?: number;
|
|
1352
|
+
/** Output only. Right bound of the bucket. */
|
|
1353
|
+
right?: number;
|
|
1354
|
+
}
|
|
1325
1355
|
interface GoogleCloudAiplatformV1DatasetVersion {
|
|
1326
1356
|
/** Output only. Name of the associated BigQuery dataset. */
|
|
1327
1357
|
bigQueryDatasetName?: string;
|
|
@@ -2026,8 +2056,6 @@ declare namespace gapi.client {
|
|
|
2026
2056
|
developerInstruction?: GoogleCloudAiplatformV1EvaluationInstanceInstanceData;
|
|
2027
2057
|
/** A list of events. */
|
|
2028
2058
|
events?: GoogleCloudAiplatformV1EvaluationInstanceAgentDataEvents;
|
|
2029
|
-
/** A JSON string containing a sequence of events. */
|
|
2030
|
-
eventsText?: string;
|
|
2031
2059
|
/** List of tools. */
|
|
2032
2060
|
tools?: GoogleCloudAiplatformV1EvaluationInstanceAgentDataTools;
|
|
2033
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"] } ] */
|
|
@@ -3116,9 +3144,9 @@ declare namespace gapi.client {
|
|
|
3116
3144
|
operationName?: string;
|
|
3117
3145
|
}
|
|
3118
3146
|
interface GoogleCloudAiplatformV1FileData {
|
|
3119
|
-
/** Optional.
|
|
3147
|
+
/** Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. */
|
|
3120
3148
|
displayName?: string;
|
|
3121
|
-
/** Required. URI. */
|
|
3149
|
+
/** Required. The URI of the file in Google Cloud Storage. */
|
|
3122
3150
|
fileUri?: string;
|
|
3123
3151
|
/** Required. The IANA standard MIME type of the source data. */
|
|
3124
3152
|
mimeType?: string;
|
|
@@ -3303,6 +3331,18 @@ declare namespace gapi.client {
|
|
|
3303
3331
|
/** GDC zone. A cluster will be designated for the Vertex AI workload in this zone. */
|
|
3304
3332
|
zone?: string;
|
|
3305
3333
|
}
|
|
3334
|
+
interface GoogleCloudAiplatformV1GeminiPreferenceExample {
|
|
3335
|
+
/** List of completions for a given prompt. */
|
|
3336
|
+
completions?: GoogleCloudAiplatformV1GeminiPreferenceExampleCompletion[];
|
|
3337
|
+
/** Multi-turn contents that represents the Prompt. */
|
|
3338
|
+
contents?: GoogleCloudAiplatformV1Content[];
|
|
3339
|
+
}
|
|
3340
|
+
interface GoogleCloudAiplatformV1GeminiPreferenceExampleCompletion {
|
|
3341
|
+
/** Single turn completion for the given prompt. */
|
|
3342
|
+
completion?: GoogleCloudAiplatformV1Content;
|
|
3343
|
+
/** The score for the given completion. */
|
|
3344
|
+
score?: number;
|
|
3345
|
+
}
|
|
3306
3346
|
interface GoogleCloudAiplatformV1GenAiAdvancedFeaturesConfig {
|
|
3307
3347
|
/** Configuration for Retrieval Augmented Generation feature. */
|
|
3308
3348
|
ragConfig?: GoogleCloudAiplatformV1GenAiAdvancedFeaturesConfigRagConfig;
|
|
@@ -3431,55 +3471,55 @@ declare namespace gapi.client {
|
|
|
3431
3471
|
mimeType?: string;
|
|
3432
3472
|
}
|
|
3433
3473
|
interface GoogleCloudAiplatformV1GenerationConfig {
|
|
3434
|
-
/** Optional. If enabled, audio
|
|
3474
|
+
/** Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. */
|
|
3435
3475
|
audioTimestamp?: boolean;
|
|
3436
|
-
/** Optional.
|
|
3476
|
+
/** Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. */
|
|
3437
3477
|
candidateCount?: number;
|
|
3438
|
-
/** Optional. If enabled, the model will detect emotions and adapt its responses accordingly. */
|
|
3478
|
+
/** Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. */
|
|
3439
3479
|
enableAffectiveDialog?: boolean;
|
|
3440
|
-
/** Optional.
|
|
3480
|
+
/** Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. */
|
|
3441
3481
|
frequencyPenalty?: number;
|
|
3442
3482
|
/** Optional. Config for image generation features. */
|
|
3443
3483
|
imageConfig?: GoogleCloudAiplatformV1ImageConfig;
|
|
3444
|
-
/** Optional.
|
|
3484
|
+
/** Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. */
|
|
3445
3485
|
logprobs?: number;
|
|
3446
|
-
/** Optional. The maximum number of
|
|
3486
|
+
/** Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. */
|
|
3447
3487
|
maxOutputTokens?: number;
|
|
3448
|
-
/** Optional.
|
|
3488
|
+
/** Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. */
|
|
3449
3489
|
mediaResolution?: string;
|
|
3450
|
-
/** Optional.
|
|
3490
|
+
/** Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. */
|
|
3451
3491
|
presencePenalty?: number;
|
|
3452
|
-
/** Optional.
|
|
3492
|
+
/** Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. */
|
|
3453
3493
|
responseJsonSchema?: any;
|
|
3454
|
-
/** Optional. If true,
|
|
3494
|
+
/** Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. */
|
|
3455
3495
|
responseLogprobs?: boolean;
|
|
3456
|
-
/** Optional.
|
|
3496
|
+
/** Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. */
|
|
3457
3497
|
responseMimeType?: string;
|
|
3458
|
-
/** Optional. The modalities of the response. */
|
|
3498
|
+
/** Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. */
|
|
3459
3499
|
responseModalities?: string[];
|
|
3460
|
-
/** Optional.
|
|
3500
|
+
/** Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. */
|
|
3461
3501
|
responseSchema?: GoogleCloudAiplatformV1Schema;
|
|
3462
3502
|
/** Optional. Routing configuration. */
|
|
3463
3503
|
routingConfig?: GoogleCloudAiplatformV1GenerationConfigRoutingConfig;
|
|
3464
|
-
/** Optional.
|
|
3504
|
+
/** Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. */
|
|
3465
3505
|
seed?: number;
|
|
3466
3506
|
/** Optional. The speech generation config. */
|
|
3467
3507
|
speechConfig?: GoogleCloudAiplatformV1SpeechConfig;
|
|
3468
|
-
/** Optional.
|
|
3508
|
+
/** Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. */
|
|
3469
3509
|
stopSequences?: string[];
|
|
3470
|
-
/** Optional. Controls the randomness of
|
|
3510
|
+
/** Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. */
|
|
3471
3511
|
temperature?: number;
|
|
3472
|
-
/** Optional.
|
|
3512
|
+
/** Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. */
|
|
3473
3513
|
thinkingConfig?: GoogleCloudAiplatformV1GenerationConfigThinkingConfig;
|
|
3474
|
-
/** Optional.
|
|
3514
|
+
/** Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. */
|
|
3475
3515
|
topK?: number;
|
|
3476
|
-
/** Optional.
|
|
3516
|
+
/** Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. */
|
|
3477
3517
|
topP?: number;
|
|
3478
3518
|
}
|
|
3479
3519
|
interface GoogleCloudAiplatformV1GenerationConfigRoutingConfig {
|
|
3480
|
-
/**
|
|
3520
|
+
/** In this mode, the model is selected automatically based on the content of the request. */
|
|
3481
3521
|
autoMode?: GoogleCloudAiplatformV1GenerationConfigRoutingConfigAutoRoutingMode;
|
|
3482
|
-
/**
|
|
3522
|
+
/** In this mode, the model is specified manually. */
|
|
3483
3523
|
manualMode?: GoogleCloudAiplatformV1GenerationConfigRoutingConfigManualRoutingMode;
|
|
3484
3524
|
}
|
|
3485
3525
|
interface GoogleCloudAiplatformV1GenerationConfigRoutingConfigAutoRoutingMode {
|
|
@@ -3487,13 +3527,13 @@ declare namespace gapi.client {
|
|
|
3487
3527
|
modelRoutingPreference?: string;
|
|
3488
3528
|
}
|
|
3489
3529
|
interface GoogleCloudAiplatformV1GenerationConfigRoutingConfigManualRoutingMode {
|
|
3490
|
-
/** The model
|
|
3530
|
+
/** The name of the model to use. Only public LLM models are accepted. */
|
|
3491
3531
|
modelName?: string;
|
|
3492
3532
|
}
|
|
3493
3533
|
interface GoogleCloudAiplatformV1GenerationConfigThinkingConfig {
|
|
3494
|
-
/** Optional.
|
|
3534
|
+
/** Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. */
|
|
3495
3535
|
includeThoughts?: boolean;
|
|
3496
|
-
/** Optional.
|
|
3536
|
+
/** Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. */
|
|
3497
3537
|
thinkingBudget?: number;
|
|
3498
3538
|
}
|
|
3499
3539
|
interface GoogleCloudAiplatformV1GenericOperationMetadata {
|
|
@@ -3551,85 +3591,85 @@ declare namespace gapi.client {
|
|
|
3551
3591
|
version?: number;
|
|
3552
3592
|
}
|
|
3553
3593
|
interface GoogleCloudAiplatformV1GroundingChunk {
|
|
3554
|
-
/**
|
|
3594
|
+
/** A grounding chunk from Google Maps. See the `Maps` message for details. */
|
|
3555
3595
|
maps?: GoogleCloudAiplatformV1GroundingChunkMaps;
|
|
3556
|
-
/**
|
|
3596
|
+
/** A grounding chunk from a data source retrieved by a retrieval tool, such as Vertex AI Search. See the `RetrievedContext` message for details */
|
|
3557
3597
|
retrievedContext?: GoogleCloudAiplatformV1GroundingChunkRetrievedContext;
|
|
3558
|
-
/**
|
|
3598
|
+
/** A grounding chunk from a web page, typically from Google Search. See the `Web` message for details. */
|
|
3559
3599
|
web?: GoogleCloudAiplatformV1GroundingChunkWeb;
|
|
3560
3600
|
}
|
|
3561
3601
|
interface GoogleCloudAiplatformV1GroundingChunkMaps {
|
|
3562
|
-
/**
|
|
3602
|
+
/** The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content. */
|
|
3563
3603
|
placeAnswerSources?: GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSources;
|
|
3564
|
-
/** This Place's resource name, in `places/{place_id}` format.
|
|
3604
|
+
/** This Place's resource name, in `places/{place_id}` format. This can be used to look up the place in the Google Maps API. */
|
|
3565
3605
|
placeId?: string;
|
|
3566
|
-
/**
|
|
3606
|
+
/** The text of the place answer. */
|
|
3567
3607
|
text?: string;
|
|
3568
|
-
/**
|
|
3608
|
+
/** The title of the place. */
|
|
3569
3609
|
title?: string;
|
|
3570
|
-
/** URI
|
|
3610
|
+
/** The URI of the place. */
|
|
3571
3611
|
uri?: string;
|
|
3572
3612
|
}
|
|
3573
3613
|
interface GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSources {
|
|
3574
|
-
/** Snippets of reviews that
|
|
3614
|
+
/** Snippets of reviews that were used to generate the answer. */
|
|
3575
3615
|
reviewSnippets?: GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSourcesReviewSnippet[];
|
|
3576
3616
|
}
|
|
3577
3617
|
interface GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSourcesReviewSnippet {
|
|
3578
3618
|
/** A link to show the review on Google Maps. */
|
|
3579
3619
|
googleMapsUri?: string;
|
|
3580
|
-
/**
|
|
3620
|
+
/** The ID of the review that is being referenced. */
|
|
3581
3621
|
reviewId?: string;
|
|
3582
|
-
/**
|
|
3622
|
+
/** The title of the review. */
|
|
3583
3623
|
title?: string;
|
|
3584
3624
|
}
|
|
3585
3625
|
interface GoogleCloudAiplatformV1GroundingChunkRetrievedContext {
|
|
3586
|
-
/** Output only. The full
|
|
3626
|
+
/** Output only. The full resource name of the referenced Vertex AI Search document. This is used to identify the specific document that was retrieved. The format is `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`. */
|
|
3587
3627
|
documentName?: string;
|
|
3588
|
-
/** Additional context for
|
|
3628
|
+
/** Additional context for a Retrieval-Augmented Generation (RAG) retrieval result. This is populated only when the RAG retrieval tool is used. */
|
|
3589
3629
|
ragChunk?: GoogleCloudAiplatformV1RagChunk;
|
|
3590
|
-
/**
|
|
3630
|
+
/** The content of the retrieved data source. */
|
|
3591
3631
|
text?: string;
|
|
3592
|
-
/**
|
|
3632
|
+
/** The title of the retrieved data source. */
|
|
3593
3633
|
title?: string;
|
|
3594
|
-
/** URI
|
|
3634
|
+
/** The URI of the retrieved data source. */
|
|
3595
3635
|
uri?: string;
|
|
3596
3636
|
}
|
|
3597
3637
|
interface GoogleCloudAiplatformV1GroundingChunkWeb {
|
|
3598
|
-
/**
|
|
3638
|
+
/** The domain of the web page that contains the evidence. This can be used to filter out low-quality sources. */
|
|
3599
3639
|
domain?: string;
|
|
3600
|
-
/**
|
|
3640
|
+
/** The title of the web page that contains the evidence. */
|
|
3601
3641
|
title?: string;
|
|
3602
|
-
/** URI
|
|
3642
|
+
/** The URI of the web page that contains the evidence. */
|
|
3603
3643
|
uri?: string;
|
|
3604
3644
|
}
|
|
3605
3645
|
interface GoogleCloudAiplatformV1GroundingMetadata {
|
|
3606
|
-
/** Optional. Output only.
|
|
3646
|
+
/** Optional. Output only. A token that can be used to render a Google Maps widget with the contextual data. This field is populated only when the grounding source is Google Maps. */
|
|
3607
3647
|
googleMapsWidgetContextToken?: string;
|
|
3608
|
-
/**
|
|
3648
|
+
/** A list of supporting references retrieved from the grounding source. This field is populated when the grounding source is Google Search, Vertex AI Search, or Google Maps. */
|
|
3609
3649
|
groundingChunks?: GoogleCloudAiplatformV1GroundingChunk[];
|
|
3610
|
-
/** Optional.
|
|
3650
|
+
/** Optional. A list of grounding supports that connect the generated content to the grounding chunks. This field is populated when the grounding source is Google Search or Vertex AI Search. */
|
|
3611
3651
|
groundingSupports?: GoogleCloudAiplatformV1GroundingSupport[];
|
|
3612
|
-
/** Optional. Output only.
|
|
3652
|
+
/** Optional. Output only. Metadata related to the retrieval grounding source. */
|
|
3613
3653
|
retrievalMetadata?: GoogleCloudAiplatformV1RetrievalMetadata;
|
|
3614
|
-
/** Optional.
|
|
3654
|
+
/** Optional. A web search entry point that can be used to display search results. This field is populated only when the grounding source is Google Search. */
|
|
3615
3655
|
searchEntryPoint?: GoogleCloudAiplatformV1SearchEntryPoint;
|
|
3616
|
-
/** Optional. Output only.
|
|
3656
|
+
/** Optional. Output only. A list of URIs that can be used to flag a place or review for inappropriate content. This field is populated only when the grounding source is Google Maps. */
|
|
3617
3657
|
sourceFlaggingUris?: GoogleCloudAiplatformV1GroundingMetadataSourceFlaggingUri[];
|
|
3618
|
-
/** Optional.
|
|
3658
|
+
/** Optional. The web search queries that were used to generate the content. This field is populated only when the grounding source is Google Search. */
|
|
3619
3659
|
webSearchQueries?: string[];
|
|
3620
3660
|
}
|
|
3621
3661
|
interface GoogleCloudAiplatformV1GroundingMetadataSourceFlaggingUri {
|
|
3622
|
-
/**
|
|
3662
|
+
/** The URI that can be used to flag the content. */
|
|
3623
3663
|
flagContentUri?: string;
|
|
3624
|
-
/**
|
|
3664
|
+
/** The ID of the place or review. */
|
|
3625
3665
|
sourceId?: string;
|
|
3626
3666
|
}
|
|
3627
3667
|
interface GoogleCloudAiplatformV1GroundingSupport {
|
|
3628
|
-
/**
|
|
3668
|
+
/** The confidence scores for the support references. This list is parallel to the `grounding_chunk_indices` list. A score is a value between 0.0 and 1.0, with a higher score indicating a higher confidence that the reference supports the claim. For Gemini 2.0 and before, this list has the same size as `grounding_chunk_indices`. For Gemini 2.5 and later, this list is empty and should be ignored. */
|
|
3629
3669
|
confidenceScores?: number[];
|
|
3630
|
-
/** A list of indices
|
|
3670
|
+
/** A list of indices into the `grounding_chunks` field of the `GroundingMetadata` message. These indices specify which grounding chunks support the claim made in the content segment. For example, if this field has the values `[1, 3]`, it means that `grounding_chunks[1]` and `grounding_chunks[3]` are the sources for the claim in the content segment. */
|
|
3631
3671
|
groundingChunkIndices?: number[];
|
|
3632
|
-
/**
|
|
3672
|
+
/** The content segment that this support message applies to. */
|
|
3633
3673
|
segment?: GoogleCloudAiplatformV1Segment;
|
|
3634
3674
|
}
|
|
3635
3675
|
interface GoogleCloudAiplatformV1HyperparameterTuningJob {
|
|
@@ -4345,21 +4385,21 @@ declare namespace gapi.client {
|
|
|
4345
4385
|
systemInstruction?: string;
|
|
4346
4386
|
}
|
|
4347
4387
|
interface GoogleCloudAiplatformV1LogprobsResult {
|
|
4348
|
-
/**
|
|
4388
|
+
/** A list of the chosen candidate tokens at each decoding step. The length of this list is equal to the total number of decoding steps. Note that the chosen candidate might not be in `top_candidates`. */
|
|
4349
4389
|
chosenCandidates?: GoogleCloudAiplatformV1LogprobsResultCandidate[];
|
|
4350
|
-
/**
|
|
4390
|
+
/** A list of the top candidate tokens at each decoding step. The length of this list is equal to the total number of decoding steps. */
|
|
4351
4391
|
topCandidates?: GoogleCloudAiplatformV1LogprobsResultTopCandidates[];
|
|
4352
4392
|
}
|
|
4353
4393
|
interface GoogleCloudAiplatformV1LogprobsResultCandidate {
|
|
4354
|
-
/** The
|
|
4394
|
+
/** The log probability of this token. A higher value indicates that the model was more confident in this token. The log probability can be used to assess the relative likelihood of different tokens and to identify when the model is uncertain. */
|
|
4355
4395
|
logProbability?: number;
|
|
4356
|
-
/** The
|
|
4396
|
+
/** The token's string representation. */
|
|
4357
4397
|
token?: string;
|
|
4358
|
-
/** The
|
|
4398
|
+
/** The token's numerical ID. While the `token` field provides the string representation of the token, the `token_id` is the numerical representation that the model uses internally. This can be useful for developers who want to build custom logic based on the model's vocabulary. */
|
|
4359
4399
|
tokenId?: number;
|
|
4360
4400
|
}
|
|
4361
4401
|
interface GoogleCloudAiplatformV1LogprobsResultTopCandidates {
|
|
4362
|
-
/**
|
|
4402
|
+
/** The list of candidate tokens, sorted by log probability in descending order. */
|
|
4363
4403
|
candidates?: GoogleCloudAiplatformV1LogprobsResultCandidate[];
|
|
4364
4404
|
}
|
|
4365
4405
|
interface GoogleCloudAiplatformV1LookupStudyRequest {
|
|
@@ -4453,6 +4493,8 @@ declare namespace gapi.client {
|
|
|
4453
4493
|
aggregationMetrics?: string[];
|
|
4454
4494
|
/** Spec for bleu metric. */
|
|
4455
4495
|
bleuSpec?: GoogleCloudAiplatformV1BleuSpec;
|
|
4496
|
+
/** Spec for Custom Code Execution metric. */
|
|
4497
|
+
customCodeExecutionSpec?: GoogleCloudAiplatformV1CustomCodeExecutionSpec;
|
|
4456
4498
|
/** Spec for exact match metric. */
|
|
4457
4499
|
exactMatchSpec?: any;
|
|
4458
4500
|
/** Spec for an LLM based metric. */
|
|
@@ -4599,9 +4641,9 @@ declare namespace gapi.client {
|
|
|
4599
4641
|
model?: string;
|
|
4600
4642
|
}
|
|
4601
4643
|
interface GoogleCloudAiplatformV1ModalityTokenCount {
|
|
4602
|
-
/** The modality
|
|
4644
|
+
/** The modality that this token count applies to. */
|
|
4603
4645
|
modality?: string;
|
|
4604
|
-
/**
|
|
4646
|
+
/** The number of tokens counted for this modality. */
|
|
4605
4647
|
tokenCount?: number;
|
|
4606
4648
|
}
|
|
4607
4649
|
interface GoogleCloudAiplatformV1Model {
|
|
@@ -4677,9 +4719,9 @@ declare namespace gapi.client {
|
|
|
4677
4719
|
versionUpdateTime?: string;
|
|
4678
4720
|
}
|
|
4679
4721
|
interface GoogleCloudAiplatformV1ModelArmorConfig {
|
|
4680
|
-
/** Optional. The name of the Model Armor template to use for prompt
|
|
4722
|
+
/** Optional. The resource name of the Model Armor template to use for prompt screening. A Model Armor template is a set of customized filters and thresholds that define how Model Armor screens content. If specified, Model Armor will use this template to check the user's prompt for safety and security risks before it is sent to the model. The name must be in the format `projects/{project}/locations/{location}/templates/{template}`. */
|
|
4681
4723
|
promptTemplateName?: string;
|
|
4682
|
-
/** Optional. The name of the Model Armor template to use for response
|
|
4724
|
+
/** Optional. The resource name of the Model Armor template to use for response screening. A Model Armor template is a set of customized filters and thresholds that define how Model Armor screens content. If specified, Model Armor will use this template to check the model's response for safety and security risks before it is returned to the user. The name must be in the format `projects/{project}/locations/{location}/templates/{template}`. */
|
|
4683
4725
|
responseTemplateName?: string;
|
|
4684
4726
|
}
|
|
4685
4727
|
interface GoogleCloudAiplatformV1ModelBaseModelSource {
|
|
@@ -5570,21 +5612,21 @@ declare namespace gapi.client {
|
|
|
5570
5612
|
version?: number;
|
|
5571
5613
|
}
|
|
5572
5614
|
interface GoogleCloudAiplatformV1Part {
|
|
5573
|
-
/** Optional.
|
|
5615
|
+
/** Optional. The result of executing the ExecutableCode. */
|
|
5574
5616
|
codeExecutionResult?: GoogleCloudAiplatformV1CodeExecutionResult;
|
|
5575
|
-
/** Optional. Code generated by the model that is
|
|
5617
|
+
/** Optional. Code generated by the model that is intended to be executed. */
|
|
5576
5618
|
executableCode?: GoogleCloudAiplatformV1ExecutableCode;
|
|
5577
|
-
/** Optional. URI
|
|
5619
|
+
/** Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. */
|
|
5578
5620
|
fileData?: GoogleCloudAiplatformV1FileData;
|
|
5579
|
-
/** Optional. A predicted
|
|
5621
|
+
/** Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. */
|
|
5580
5622
|
functionCall?: GoogleCloudAiplatformV1FunctionCall;
|
|
5581
|
-
/** Optional. The result
|
|
5623
|
+
/** Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. */
|
|
5582
5624
|
functionResponse?: GoogleCloudAiplatformV1FunctionResponse;
|
|
5583
|
-
/** Optional.
|
|
5625
|
+
/** Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. */
|
|
5584
5626
|
inlineData?: GoogleCloudAiplatformV1Blob;
|
|
5585
|
-
/** Optional.
|
|
5627
|
+
/** Optional. The text content of the part. */
|
|
5586
5628
|
text?: string;
|
|
5587
|
-
/** Optional. Indicates
|
|
5629
|
+
/** Optional. Indicates whether the `part` represents the model's thought process or reasoning. */
|
|
5588
5630
|
thought?: boolean;
|
|
5589
5631
|
/** Optional. An opaque signature for the thought so it can be reused in subsequent requests. */
|
|
5590
5632
|
thoughtSignature?: string;
|
|
@@ -5818,7 +5860,7 @@ declare namespace gapi.client {
|
|
|
5818
5860
|
postStartupScriptUrl?: string;
|
|
5819
5861
|
}
|
|
5820
5862
|
interface GoogleCloudAiplatformV1PrebuiltVoiceConfig {
|
|
5821
|
-
/** The name of the
|
|
5863
|
+
/** The name of the prebuilt voice to use. */
|
|
5822
5864
|
voiceName?: string;
|
|
5823
5865
|
}
|
|
5824
5866
|
interface GoogleCloudAiplatformV1PredefinedMetricSpec {
|
|
@@ -5875,6 +5917,48 @@ declare namespace gapi.client {
|
|
|
5875
5917
|
/** Immutable. Points to a YAML file stored on Google Cloud Storage describing the format of a single prediction produced by this Model, which are returned via PredictResponse.predictions, ExplainResponse.explanations, and BatchPredictionJob.output_config. The schema is defined as an OpenAPI 3.0.2 [Schema Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). AutoML Models always have this field populated by Vertex AI. Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access. */
|
|
5876
5918
|
predictionSchemaUri?: string;
|
|
5877
5919
|
}
|
|
5920
|
+
interface GoogleCloudAiplatformV1PreferenceOptimizationDataStats {
|
|
5921
|
+
/** Output only. A partial sample of the indices (starting from 1) of the dropped examples. */
|
|
5922
|
+
droppedExampleIndices?: string[];
|
|
5923
|
+
/** Output only. For each index in `dropped_example_indices`, the user-facing reason why the example was dropped. */
|
|
5924
|
+
droppedExampleReasons?: string[];
|
|
5925
|
+
/** Output only. Dataset distributions for scores. */
|
|
5926
|
+
scoresDistribution?: GoogleCloudAiplatformV1DatasetDistribution;
|
|
5927
|
+
/** Output only. Dataset distributions for scores variance per example. */
|
|
5928
|
+
scoreVariancePerExampleDistribution?: GoogleCloudAiplatformV1DatasetDistribution;
|
|
5929
|
+
/** Output only. Number of billable tokens in the tuning dataset. */
|
|
5930
|
+
totalBillableTokenCount?: string;
|
|
5931
|
+
/** Output only. Number of examples in the tuning dataset. */
|
|
5932
|
+
tuningDatasetExampleCount?: string;
|
|
5933
|
+
/** Output only. Number of tuning steps for this Tuning Job. */
|
|
5934
|
+
tuningStepCount?: string;
|
|
5935
|
+
/** Output only. Sample user examples in the training dataset. */
|
|
5936
|
+
userDatasetExamples?: GoogleCloudAiplatformV1GeminiPreferenceExample[];
|
|
5937
|
+
/** Output only. Dataset distributions for the user input tokens. */
|
|
5938
|
+
userInputTokenDistribution?: GoogleCloudAiplatformV1DatasetDistribution;
|
|
5939
|
+
/** Output only. Dataset distributions for the user output tokens. */
|
|
5940
|
+
userOutputTokenDistribution?: GoogleCloudAiplatformV1DatasetDistribution;
|
|
5941
|
+
}
|
|
5942
|
+
interface GoogleCloudAiplatformV1PreferenceOptimizationHyperParameters {
|
|
5943
|
+
/** Optional. Adapter size for preference optimization. */
|
|
5944
|
+
adapterSize?: string;
|
|
5945
|
+
/** Optional. Weight for KL Divergence regularization. */
|
|
5946
|
+
beta?: number;
|
|
5947
|
+
/** Optional. Number of complete passes the model makes over the entire training dataset during training. */
|
|
5948
|
+
epochCount?: string;
|
|
5949
|
+
/** Optional. Multiplier for adjusting the default learning rate. */
|
|
5950
|
+
learningRateMultiplier?: number;
|
|
5951
|
+
}
|
|
5952
|
+
interface GoogleCloudAiplatformV1PreferenceOptimizationSpec {
|
|
5953
|
+
/** Optional. If set to true, disable intermediate checkpoints for Preference Optimization and only the last checkpoint will be exported. Otherwise, enable intermediate checkpoints for Preference Optimization. Default is false. */
|
|
5954
|
+
exportLastCheckpointOnly?: boolean;
|
|
5955
|
+
/** Optional. Hyperparameters for Preference Optimization. */
|
|
5956
|
+
hyperParameters?: GoogleCloudAiplatformV1PreferenceOptimizationHyperParameters;
|
|
5957
|
+
/** Required. Cloud Storage path to file containing training dataset for preference optimization tuning. The dataset must be formatted as a JSONL file. */
|
|
5958
|
+
trainingDatasetUri?: string;
|
|
5959
|
+
/** Optional. Cloud Storage path to file containing validation dataset for preference optimization tuning. The dataset must be formatted as a JSONL file. */
|
|
5960
|
+
validationDatasetUri?: string;
|
|
5961
|
+
}
|
|
5878
5962
|
interface GoogleCloudAiplatformV1Presets {
|
|
5879
5963
|
/** The modality of the uploaded model, which automatically configures the distance measurement and feature normalization for the underlying example index and queries. If your model does not precisely fit one of these types, it is okay to choose the closest type. */
|
|
5880
5964
|
modality?: string;
|
|
@@ -6370,6 +6454,10 @@ declare namespace gapi.client {
|
|
|
6370
6454
|
encryptionSpec?: GoogleCloudAiplatformV1EncryptionSpec;
|
|
6371
6455
|
/** Output only. The resource name of the RagCorpus. */
|
|
6372
6456
|
name?: string;
|
|
6457
|
+
/** Output only. Reserved for future use. */
|
|
6458
|
+
satisfiesPzi?: boolean;
|
|
6459
|
+
/** Output only. Reserved for future use. */
|
|
6460
|
+
satisfiesPzs?: boolean;
|
|
6373
6461
|
/** Output only. Timestamp when this RagCorpus was last updated. */
|
|
6374
6462
|
updateTime?: string;
|
|
6375
6463
|
/** Optional. Immutable. The config for the Vector DBs. */
|
|
@@ -6694,7 +6782,7 @@ declare namespace gapi.client {
|
|
|
6694
6782
|
dependencyFilesGcsUri?: string;
|
|
6695
6783
|
/** Optional. The Cloud Storage URI of the pickled python object. */
|
|
6696
6784
|
pickleObjectGcsUri?: string;
|
|
6697
|
-
/** Optional. The Python version.
|
|
6785
|
+
/** Optional. The Python version. Supported values are 3.9, 3.10, 3.11, 3.12, 3.13. If not specified, the default value is 3.10. */
|
|
6698
6786
|
pythonVersion?: string;
|
|
6699
6787
|
/** Optional. The Cloud Storage URI of the `requirements.txt` file */
|
|
6700
6788
|
requirementsGcsUri?: string;
|
|
@@ -6814,7 +6902,7 @@ declare namespace gapi.client {
|
|
|
6814
6902
|
latLng?: GoogleTypeLatLng;
|
|
6815
6903
|
}
|
|
6816
6904
|
interface GoogleCloudAiplatformV1RetrievalMetadata {
|
|
6817
|
-
/** Optional.
|
|
6905
|
+
/** Optional. A score indicating how likely it is that a Google Search query could help answer the prompt. The score is in the range of `[0, 1]`. A score of 1 means the model is confident that a search will be helpful, and 0 means it is not. This score is populated only when Google Search grounding and dynamic retrieval are enabled. The score is used to determine whether to trigger a search. */
|
|
6818
6906
|
googleSearchDynamicRetrievalScore?: number;
|
|
6819
6907
|
}
|
|
6820
6908
|
interface GoogleCloudAiplatformV1RetrieveContextsRequest {
|
|
@@ -6945,19 +7033,19 @@ declare namespace gapi.client {
|
|
|
6945
7033
|
prediction?: string;
|
|
6946
7034
|
}
|
|
6947
7035
|
interface GoogleCloudAiplatformV1SafetyRating {
|
|
6948
|
-
/** Output only. Indicates whether the content was
|
|
7036
|
+
/** Output only. Indicates whether the content was blocked because of this rating. */
|
|
6949
7037
|
blocked?: boolean;
|
|
6950
|
-
/** Output only.
|
|
7038
|
+
/** Output only. The harm category of this rating. */
|
|
6951
7039
|
category?: string;
|
|
6952
7040
|
/** Output only. The overwritten threshold for the safety category of Gemini 2.0 image out. If minors are detected in the output image, the threshold of each safety category will be overwritten if user sets a lower threshold. */
|
|
6953
7041
|
overwrittenThreshold?: string;
|
|
6954
|
-
/** Output only.
|
|
7042
|
+
/** Output only. The probability of harm for this category. */
|
|
6955
7043
|
probability?: string;
|
|
6956
|
-
/** Output only.
|
|
7044
|
+
/** Output only. The probability score of harm for this category. */
|
|
6957
7045
|
probabilityScore?: number;
|
|
6958
|
-
/** Output only.
|
|
7046
|
+
/** Output only. The severity of harm for this category. */
|
|
6959
7047
|
severity?: string;
|
|
6960
|
-
/** Output only.
|
|
7048
|
+
/** Output only. The severity score of harm for this category. */
|
|
6961
7049
|
severityScore?: number;
|
|
6962
7050
|
}
|
|
6963
7051
|
interface GoogleCloudAiplatformV1SafetyResult {
|
|
@@ -6969,11 +7057,11 @@ declare namespace gapi.client {
|
|
|
6969
7057
|
score?: number;
|
|
6970
7058
|
}
|
|
6971
7059
|
interface GoogleCloudAiplatformV1SafetySetting {
|
|
6972
|
-
/** Required.
|
|
7060
|
+
/** Required. The harm category to be blocked. */
|
|
6973
7061
|
category?: string;
|
|
6974
|
-
/** Optional.
|
|
7062
|
+
/** Optional. The method for blocking content. If not specified, the default behavior is to use the probability score. */
|
|
6975
7063
|
method?: string;
|
|
6976
|
-
/** Required. The harm
|
|
7064
|
+
/** Required. The threshold for blocking content. If the harm probability exceeds this threshold, the content will be blocked. */
|
|
6977
7065
|
threshold?: string;
|
|
6978
7066
|
}
|
|
6979
7067
|
interface GoogleCloudAiplatformV1SafetySpec {
|
|
@@ -8576,9 +8664,9 @@ declare namespace gapi.client {
|
|
|
8576
8664
|
nextPageToken?: string;
|
|
8577
8665
|
}
|
|
8578
8666
|
interface GoogleCloudAiplatformV1SearchEntryPoint {
|
|
8579
|
-
/** Optional.
|
|
8667
|
+
/** Optional. An HTML snippet that can be embedded in a web page or an application's webview. This snippet displays a search result, including the title, URL, and a brief description of the search result. */
|
|
8580
8668
|
renderedContent?: string;
|
|
8581
|
-
/** Optional.
|
|
8669
|
+
/** Optional. A base64-encoded JSON object that contains a list of search queries and their corresponding search URLs. This information can be used to build a custom search UI. */
|
|
8582
8670
|
sdkBlob?: string;
|
|
8583
8671
|
}
|
|
8584
8672
|
interface GoogleCloudAiplatformV1SearchFeaturesResponse {
|
|
@@ -8651,13 +8739,13 @@ declare namespace gapi.client {
|
|
|
8651
8739
|
version?: string;
|
|
8652
8740
|
}
|
|
8653
8741
|
interface GoogleCloudAiplatformV1Segment {
|
|
8654
|
-
/** Output only.
|
|
8742
|
+
/** Output only. The end index of the segment in the `Part`, measured in bytes. This marks the end of the segment and is exclusive, meaning the segment includes content up to, but not including, the byte at this index. */
|
|
8655
8743
|
endIndex?: number;
|
|
8656
|
-
/** Output only. The index of
|
|
8744
|
+
/** Output only. The index of the `Part` object that this segment belongs to. This is useful for associating the segment with a specific part of the content. */
|
|
8657
8745
|
partIndex?: number;
|
|
8658
|
-
/** Output only.
|
|
8746
|
+
/** Output only. The start index of the segment in the `Part`, measured in bytes. This marks the beginning of the segment and is inclusive, meaning the byte at this index is the first byte of the segment. */
|
|
8659
8747
|
startIndex?: number;
|
|
8660
|
-
/** Output only. The text
|
|
8748
|
+
/** Output only. The text of the segment. */
|
|
8661
8749
|
text?: string;
|
|
8662
8750
|
}
|
|
8663
8751
|
interface GoogleCloudAiplatformV1ServiceAccountSpec {
|
|
@@ -8757,11 +8845,11 @@ declare namespace gapi.client {
|
|
|
8757
8845
|
ngramSize?: number;
|
|
8758
8846
|
}
|
|
8759
8847
|
interface GoogleCloudAiplatformV1SpeechConfig {
|
|
8760
|
-
/** Optional.
|
|
8848
|
+
/** Optional. The language code (ISO 639-1) for the speech synthesis. */
|
|
8761
8849
|
languageCode?: string;
|
|
8762
8850
|
/** The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. */
|
|
8763
8851
|
multiSpeakerVoiceConfig?: GoogleCloudAiplatformV1MultiSpeakerVoiceConfig;
|
|
8764
|
-
/** The configuration for the
|
|
8852
|
+
/** The configuration for the voice to use. */
|
|
8765
8853
|
voiceConfig?: GoogleCloudAiplatformV1VoiceConfig;
|
|
8766
8854
|
}
|
|
8767
8855
|
interface GoogleCloudAiplatformV1StartNotebookRuntimeOperationMetadata {
|
|
@@ -9748,6 +9836,8 @@ declare namespace gapi.client {
|
|
|
9748
9836
|
tuningJob?: string;
|
|
9749
9837
|
}
|
|
9750
9838
|
interface GoogleCloudAiplatformV1TuningDataStats {
|
|
9839
|
+
/** Output only. Statistics for preference optimization. */
|
|
9840
|
+
preferenceOptimizationDataStats?: GoogleCloudAiplatformV1PreferenceOptimizationDataStats;
|
|
9751
9841
|
/** The SFT Tuning data stats. */
|
|
9752
9842
|
supervisedTuningDataStats?: GoogleCloudAiplatformV1SupervisedTuningDataStats;
|
|
9753
9843
|
}
|
|
@@ -9770,6 +9860,8 @@ declare namespace gapi.client {
|
|
|
9770
9860
|
labels?: {[P in string]: string};
|
|
9771
9861
|
/** Output only. Identifier. Resource name of a TuningJob. Format: `projects/{project}/locations/{location}/tuningJobs/{tuning_job}` */
|
|
9772
9862
|
name?: string;
|
|
9863
|
+
/** Tuning Spec for Preference Optimization. */
|
|
9864
|
+
preferenceOptimizationSpec?: GoogleCloudAiplatformV1PreferenceOptimizationSpec;
|
|
9773
9865
|
/** The pre-tuned model for continuous tuning. */
|
|
9774
9866
|
preTunedModel?: GoogleCloudAiplatformV1PreTunedModel;
|
|
9775
9867
|
/** The service account that the tuningJob workload runs as. If not specified, the Vertex AI Secure Fine-Tuned Service Agent in the project will be used. See https://cloud.google.com/iam/docs/service-agents#vertex-ai-secure-fine-tuning-service-agent Users starting the pipeline must have the `iam.serviceAccounts.actAs` permission on this service account. */
|
|
@@ -9932,13 +10024,13 @@ declare namespace gapi.client {
|
|
|
9932
10024
|
interface GoogleCloudAiplatformV1UpsertDatapointsResponse {}
|
|
9933
10025
|
interface GoogleCloudAiplatformV1UrlContext {}
|
|
9934
10026
|
interface GoogleCloudAiplatformV1UrlContextMetadata {
|
|
9935
|
-
/** Output only.
|
|
10027
|
+
/** Output only. A list of URL metadata, with one entry for each URL retrieved by the tool. */
|
|
9936
10028
|
urlMetadata?: GoogleCloudAiplatformV1UrlMetadata[];
|
|
9937
10029
|
}
|
|
9938
10030
|
interface GoogleCloudAiplatformV1UrlMetadata {
|
|
9939
|
-
/**
|
|
10031
|
+
/** The URL retrieved by the tool. */
|
|
9940
10032
|
retrievedUrl?: string;
|
|
9941
|
-
/**
|
|
10033
|
+
/** The status of the URL retrieval. */
|
|
9942
10034
|
urlRetrievalStatus?: string;
|
|
9943
10035
|
}
|
|
9944
10036
|
interface GoogleCloudAiplatformV1UsageMetadata {
|
|
@@ -10022,13 +10114,13 @@ declare namespace gapi.client {
|
|
|
10022
10114
|
interface GoogleCloudAiplatformV1VideoMetadata {
|
|
10023
10115
|
/** Optional. The end offset of the video. */
|
|
10024
10116
|
endOffset?: string;
|
|
10025
|
-
/** Optional. The frame rate of the video sent to the model. If not specified, the default value
|
|
10117
|
+
/** Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. */
|
|
10026
10118
|
fps?: number;
|
|
10027
10119
|
/** Optional. The start offset of the video. */
|
|
10028
10120
|
startOffset?: string;
|
|
10029
10121
|
}
|
|
10030
10122
|
interface GoogleCloudAiplatformV1VoiceConfig {
|
|
10031
|
-
/** The configuration for
|
|
10123
|
+
/** The configuration for a prebuilt voice. */
|
|
10032
10124
|
prebuiltVoiceConfig?: GoogleCloudAiplatformV1PrebuiltVoiceConfig;
|
|
10033
10125
|
}
|
|
10034
10126
|
interface GoogleCloudAiplatformV1WorkerPoolSpec {
|
|
@@ -18608,6 +18700,35 @@ declare namespace gapi.client {
|
|
|
18608
18700
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
18609
18701
|
uploadType?: string;
|
|
18610
18702
|
}): Request<GoogleCloudAiplatformV1Dataset>;
|
|
18703
|
+
/** Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. */
|
|
18704
|
+
getIamPolicy(request?: {
|
|
18705
|
+
/** V1 error format. */
|
|
18706
|
+
'$.xgafv'?: string;
|
|
18707
|
+
/** OAuth access token. */
|
|
18708
|
+
access_token?: string;
|
|
18709
|
+
/** Data format for response. */
|
|
18710
|
+
alt?: string;
|
|
18711
|
+
/** JSONP */
|
|
18712
|
+
callback?: string;
|
|
18713
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
18714
|
+
fields?: string;
|
|
18715
|
+
/** 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. */
|
|
18716
|
+
key?: string;
|
|
18717
|
+
/** OAuth 2.0 token for the current user. */
|
|
18718
|
+
oauth_token?: string;
|
|
18719
|
+
/** 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). */
|
|
18720
|
+
'options.requestedPolicyVersion'?: number;
|
|
18721
|
+
/** Returns response with indentations and line breaks. */
|
|
18722
|
+
prettyPrint?: boolean;
|
|
18723
|
+
/** 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. */
|
|
18724
|
+
quotaUser?: string;
|
|
18725
|
+
/** 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. */
|
|
18726
|
+
resource: string;
|
|
18727
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
18728
|
+
upload_protocol?: string;
|
|
18729
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
18730
|
+
uploadType?: string;
|
|
18731
|
+
}): Request<GoogleIamV1Policy>;
|
|
18611
18732
|
/** Imports data into a Dataset. */
|
|
18612
18733
|
import(request: {
|
|
18613
18734
|
/** V1 error format. */
|
|
@@ -18818,6 +18939,65 @@ declare namespace gapi.client {
|
|
|
18818
18939
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
18819
18940
|
uploadType?: string;
|
|
18820
18941
|
}): Request<GoogleCloudAiplatformV1SearchDataItemsResponse>;
|
|
18942
|
+
/** Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. */
|
|
18943
|
+
setIamPolicy(
|
|
18944
|
+
request: {
|
|
18945
|
+
/** V1 error format. */
|
|
18946
|
+
'$.xgafv'?: string;
|
|
18947
|
+
/** OAuth access token. */
|
|
18948
|
+
access_token?: string;
|
|
18949
|
+
/** Data format for response. */
|
|
18950
|
+
alt?: string;
|
|
18951
|
+
/** JSONP */
|
|
18952
|
+
callback?: string;
|
|
18953
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
18954
|
+
fields?: string;
|
|
18955
|
+
/** 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. */
|
|
18956
|
+
key?: string;
|
|
18957
|
+
/** OAuth 2.0 token for the current user. */
|
|
18958
|
+
oauth_token?: string;
|
|
18959
|
+
/** Returns response with indentations and line breaks. */
|
|
18960
|
+
prettyPrint?: boolean;
|
|
18961
|
+
/** 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. */
|
|
18962
|
+
quotaUser?: string;
|
|
18963
|
+
/** 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. */
|
|
18964
|
+
resource: string;
|
|
18965
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
18966
|
+
upload_protocol?: string;
|
|
18967
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
18968
|
+
uploadType?: string;
|
|
18969
|
+
},
|
|
18970
|
+
body: GoogleIamV1SetIamPolicyRequest,
|
|
18971
|
+
): Request<GoogleIamV1Policy>;
|
|
18972
|
+
/** 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. */
|
|
18973
|
+
testIamPermissions(request?: {
|
|
18974
|
+
/** V1 error format. */
|
|
18975
|
+
'$.xgafv'?: string;
|
|
18976
|
+
/** OAuth access token. */
|
|
18977
|
+
access_token?: string;
|
|
18978
|
+
/** Data format for response. */
|
|
18979
|
+
alt?: string;
|
|
18980
|
+
/** JSONP */
|
|
18981
|
+
callback?: string;
|
|
18982
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
18983
|
+
fields?: string;
|
|
18984
|
+
/** 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. */
|
|
18985
|
+
key?: string;
|
|
18986
|
+
/** OAuth 2.0 token for the current user. */
|
|
18987
|
+
oauth_token?: string;
|
|
18988
|
+
/** 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). */
|
|
18989
|
+
permissions?: string | string[];
|
|
18990
|
+
/** Returns response with indentations and line breaks. */
|
|
18991
|
+
prettyPrint?: boolean;
|
|
18992
|
+
/** 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. */
|
|
18993
|
+
quotaUser?: string;
|
|
18994
|
+
/** 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. */
|
|
18995
|
+
resource: string;
|
|
18996
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
18997
|
+
upload_protocol?: string;
|
|
18998
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
18999
|
+
uploadType?: string;
|
|
19000
|
+
}): Request<GoogleIamV1TestIamPermissionsResponse>;
|
|
18821
19001
|
annotationSpecs: AnnotationSpecsResource;
|
|
18822
19002
|
dataItems: DataItemsResource;
|
|
18823
19003
|
datasetVersions: DatasetVersionsResource;
|
|
@@ -40030,7 +40210,7 @@ declare namespace gapi.client {
|
|
|
40030
40210
|
alt?: string;
|
|
40031
40211
|
/** JSONP */
|
|
40032
40212
|
callback?: string;
|
|
40033
|
-
/** Optional.
|
|
40213
|
+
/** Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. */
|
|
40034
40214
|
extraLocationTypes?: string | string[];
|
|
40035
40215
|
/** Selector specifying which fields to include in a partial response. */
|
|
40036
40216
|
fields?: string;
|