@maxim_mazurok/gapi.client.aiplatform-v1beta1 0.3.20251028 → 0.4.20251028

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.
Files changed (2) hide show
  1. package/index.d.ts +350 -123
  2. package/package.json +1 -1
package/index.d.ts CHANGED
@@ -208,6 +208,8 @@ declare namespace gapi.client {
208
208
  aggregationMetric?: string;
209
209
  /** Results for bleu metric. */
210
210
  bleuMetricValue?: GoogleCloudAiplatformV1beta1BleuMetricValue;
211
+ /** Result for code execution metric. */
212
+ customCodeExecutionResult?: GoogleCloudAiplatformV1beta1CustomCodeExecutionResult;
211
213
  /** Results for exact match metric. */
212
214
  exactMatchMetricValue?: GoogleCloudAiplatformV1beta1ExactMatchMetricValue;
213
215
  /** Result for pairwise metric. */
@@ -734,9 +736,9 @@ declare namespace gapi.client {
734
736
  useEffectiveOrder?: boolean;
735
737
  }
736
738
  interface GoogleCloudAiplatformV1beta1Blob {
737
- /** Required. Raw bytes. */
739
+ /** Required. The raw bytes of the data. */
738
740
  data?: string;
739
- /** Optional. 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 currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. */
741
+ /** 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. */
740
742
  displayName?: string;
741
743
  /** Required. The IANA standard MIME type of the source data. */
742
744
  mimeType?: string;
@@ -805,25 +807,25 @@ declare namespace gapi.client {
805
807
  interface GoogleCloudAiplatformV1beta1CancelTrainingPipelineRequest {}
806
808
  interface GoogleCloudAiplatformV1beta1CancelTuningJobRequest {}
807
809
  interface GoogleCloudAiplatformV1beta1Candidate {
808
- /** Output only. Average log probability score of the candidate. */
810
+ /** 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. */
809
811
  avgLogprobs?: number;
810
- /** Output only. Source attribution of the generated content. */
812
+ /** Output only. A collection of citations that apply to the generated content. */
811
813
  citationMetadata?: GoogleCloudAiplatformV1beta1CitationMetadata;
812
- /** Output only. Content parts of the candidate. */
814
+ /** Output only. The content of the candidate. */
813
815
  content?: GoogleCloudAiplatformV1beta1Content;
814
- /** Output only. Describes the reason the mode stopped generating tokens in more detail. This is only filled when `finish_reason` is set. */
816
+ /** Output only. Describes the reason the model stopped generating tokens in more detail. This field is returned only when `finish_reason` is set. */
815
817
  finishMessage?: string;
816
- /** Output only. The reason why the model stopped generating tokens. If empty, the model has not stopped generating the tokens. */
818
+ /** Output only. The reason why the model stopped generating tokens. If empty, the model has not stopped generating. */
817
819
  finishReason?: string;
818
- /** Output only. Metadata specifies sources used to ground generated content. */
820
+ /** Output only. Metadata returned when grounding is enabled. It contains the sources used to ground the generated content. */
819
821
  groundingMetadata?: GoogleCloudAiplatformV1beta1GroundingMetadata;
820
- /** Output only. Index of the candidate. */
822
+ /** 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. */
821
823
  index?: number;
822
- /** Output only. Log-likelihood scores for the response tokens and top tokens */
824
+ /** 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". */
823
825
  logprobsResult?: GoogleCloudAiplatformV1beta1LogprobsResult;
824
- /** Output only. List of ratings for the safety of a response candidate. There is at most one rating per category. */
826
+ /** Output only. A list of ratings for the safety of a response candidate. There is at most one rating per category. */
825
827
  safetyRatings?: GoogleCloudAiplatformV1beta1SafetyRating[];
826
- /** Output only. Metadata related to url context retrieval tool. */
828
+ /** Output only. Metadata returned when the model uses the `url_context` tool to get information from a user-provided URL. */
827
829
  urlContextMetadata?: GoogleCloudAiplatformV1beta1UrlContextMetadata;
828
830
  }
829
831
  interface GoogleCloudAiplatformV1beta1CandidateResponse {
@@ -884,21 +886,21 @@ declare namespace gapi.client {
884
886
  mimeType?: string;
885
887
  }
886
888
  interface GoogleCloudAiplatformV1beta1Citation {
887
- /** Output only. End index into the content. */
889
+ /** Output only. The end index of the citation in the content. */
888
890
  endIndex?: number;
889
- /** Output only. License of the attribution. */
891
+ /** Output only. The license of the source of the citation. */
890
892
  license?: string;
891
- /** Output only. Publication date of the attribution. */
893
+ /** Output only. The publication date of the source of the citation. */
892
894
  publicationDate?: GoogleTypeDate;
893
- /** Output only. Start index into the content. */
895
+ /** Output only. The start index of the citation in the content. */
894
896
  startIndex?: number;
895
- /** Output only. Title of the attribution. */
897
+ /** Output only. The title of the source of the citation. */
896
898
  title?: string;
897
- /** Output only. Url reference of the attribution. */
899
+ /** Output only. The URI of the source of the citation. */
898
900
  uri?: string;
899
901
  }
900
902
  interface GoogleCloudAiplatformV1beta1CitationMetadata {
901
- /** Output only. List of citations. */
903
+ /** Output only. A list of citations for the content. */
902
904
  citations?: GoogleCloudAiplatformV1beta1Citation[];
903
905
  }
904
906
  interface GoogleCloudAiplatformV1beta1Claim {
@@ -1020,9 +1022,9 @@ declare namespace gapi.client {
1020
1022
  imageUri?: string;
1021
1023
  }
1022
1024
  interface GoogleCloudAiplatformV1beta1Content {
1023
- /** Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. */
1025
+ /** 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. */
1024
1026
  parts?: GoogleCloudAiplatformV1beta1Part[];
1025
- /** 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. */
1027
+ /** Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. */
1026
1028
  role?: string;
1027
1029
  }
1028
1030
  interface GoogleCloudAiplatformV1beta1ContentMap {
@@ -1291,6 +1293,14 @@ declare namespace gapi.client {
1291
1293
  /** Required. Google Cloud Storage location. */
1292
1294
  gcsSource?: GoogleCloudAiplatformV1beta1GcsSource;
1293
1295
  }
1296
+ interface GoogleCloudAiplatformV1beta1CustomCodeExecutionResult {
1297
+ /** Output only. Custom code execution score. */
1298
+ score?: number;
1299
+ }
1300
+ interface GoogleCloudAiplatformV1beta1CustomCodeExecutionSpec {
1301
+ /** 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 ``` */
1302
+ evaluationFunction?: string;
1303
+ }
1294
1304
  interface GoogleCloudAiplatformV1beta1CustomJob {
1295
1305
  /** Output only. Time when the CustomJob was created. */
1296
1306
  createTime?: string;
@@ -3680,9 +3690,9 @@ declare namespace gapi.client {
3680
3690
  operationName?: string;
3681
3691
  }
3682
3692
  interface GoogleCloudAiplatformV1beta1FileData {
3683
- /** Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. */
3693
+ /** 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. */
3684
3694
  displayName?: string;
3685
- /** Required. URI. */
3695
+ /** Required. The URI of the file in Google Cloud Storage. */
3686
3696
  fileUri?: string;
3687
3697
  /** Required. The IANA standard MIME type of the source data. */
3688
3698
  mimeType?: string;
@@ -4115,51 +4125,51 @@ declare namespace gapi.client {
4115
4125
  mimeType?: string;
4116
4126
  }
4117
4127
  interface GoogleCloudAiplatformV1beta1GenerationConfig {
4118
- /** Optional. If enabled, audio timestamp will be included in the request to the model. */
4128
+ /** 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. */
4119
4129
  audioTimestamp?: boolean;
4120
- /** Optional. Number of candidates to generate. */
4130
+ /** 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. */
4121
4131
  candidateCount?: number;
4122
- /** Optional. If enabled, the model will detect emotions and adapt its responses accordingly. */
4132
+ /** 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. */
4123
4133
  enableAffectiveDialog?: boolean;
4124
- /** Optional. Frequency penalties. */
4134
+ /** 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]. */
4125
4135
  frequencyPenalty?: number;
4126
4136
  /** Optional. Config for image generation features. */
4127
4137
  imageConfig?: GoogleCloudAiplatformV1beta1ImageConfig;
4128
- /** Optional. Logit probabilities. */
4138
+ /** 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. */
4129
4139
  logprobs?: number;
4130
- /** Optional. The maximum number of output tokens to generate per message. */
4140
+ /** 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. */
4131
4141
  maxOutputTokens?: number;
4132
- /** Optional. If specified, the media resolution specified will be used. */
4142
+ /** 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. */
4133
4143
  mediaResolution?: string;
4134
4144
  /** Optional. Config for model selection. */
4135
4145
  modelConfig?: GoogleCloudAiplatformV1beta1GenerationConfigModelConfig;
4136
- /** Optional. Positive penalties. */
4146
+ /** 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]. */
4137
4147
  presencePenalty?: number;
4138
- /** Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set. */
4148
+ /** Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. */
4139
4149
  responseJsonSchema?: any;
4140
- /** Optional. If true, export the logprobs results in response. */
4150
+ /** 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. */
4141
4151
  responseLogprobs?: boolean;
4142
- /** Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. */
4152
+ /** 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. */
4143
4153
  responseMimeType?: string;
4144
- /** Optional. The modalities of the response. */
4154
+ /** 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. */
4145
4155
  responseModalities?: string[];
4146
- /** Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response. */
4156
+ /** 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`. */
4147
4157
  responseSchema?: GoogleCloudAiplatformV1beta1Schema;
4148
4158
  /** Optional. Routing configuration. */
4149
4159
  routingConfig?: GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfig;
4150
- /** Optional. Seed. */
4160
+ /** 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. */
4151
4161
  seed?: number;
4152
4162
  /** Optional. The speech generation config. */
4153
4163
  speechConfig?: GoogleCloudAiplatformV1beta1SpeechConfig;
4154
- /** Optional. Stop sequences. */
4164
+ /** 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. */
4155
4165
  stopSequences?: string[];
4156
- /** Optional. Controls the randomness of predictions. */
4166
+ /** 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]. */
4157
4167
  temperature?: number;
4158
- /** Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. */
4168
+ /** Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. */
4159
4169
  thinkingConfig?: GoogleCloudAiplatformV1beta1GenerationConfigThinkingConfig;
4160
- /** Optional. If specified, top-k sampling will be used. */
4170
+ /** 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. */
4161
4171
  topK?: number;
4162
- /** Optional. If specified, nucleus sampling will be used. */
4172
+ /** 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. */
4163
4173
  topP?: number;
4164
4174
  }
4165
4175
  interface GoogleCloudAiplatformV1beta1GenerationConfigModelConfig {
@@ -4167,9 +4177,9 @@ declare namespace gapi.client {
4167
4177
  featureSelectionPreference?: string;
4168
4178
  }
4169
4179
  interface GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfig {
4170
- /** Automated routing. */
4180
+ /** In this mode, the model is selected automatically based on the content of the request. */
4171
4181
  autoMode?: GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfigAutoRoutingMode;
4172
- /** Manual routing. */
4182
+ /** In this mode, the model is specified manually. */
4173
4183
  manualMode?: GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfigManualRoutingMode;
4174
4184
  }
4175
4185
  interface GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfigAutoRoutingMode {
@@ -4177,13 +4187,13 @@ declare namespace gapi.client {
4177
4187
  modelRoutingPreference?: string;
4178
4188
  }
4179
4189
  interface GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfigManualRoutingMode {
4180
- /** The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). */
4190
+ /** The name of the model to use. Only public LLM models are accepted. */
4181
4191
  modelName?: string;
4182
4192
  }
4183
4193
  interface GoogleCloudAiplatformV1beta1GenerationConfigThinkingConfig {
4184
- /** Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. */
4194
+ /** 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. */
4185
4195
  includeThoughts?: boolean;
4186
- /** Optional. Indicates the thinking budget in tokens. */
4196
+ /** 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. */
4187
4197
  thinkingBudget?: number;
4188
4198
  }
4189
4199
  interface GoogleCloudAiplatformV1beta1GenericOperationMetadata {
@@ -4241,87 +4251,87 @@ declare namespace gapi.client {
4241
4251
  version?: number;
4242
4252
  }
4243
4253
  interface GoogleCloudAiplatformV1beta1GroundingChunk {
4244
- /** Grounding chunk from Google Maps. */
4254
+ /** A grounding chunk from Google Maps. See the `Maps` message for details. */
4245
4255
  maps?: GoogleCloudAiplatformV1beta1GroundingChunkMaps;
4246
- /** Grounding chunk from context retrieved by the retrieval tools. */
4256
+ /** A grounding chunk from a data source retrieved by a retrieval tool, such as Vertex AI Search. See the `RetrievedContext` message for details */
4247
4257
  retrievedContext?: GoogleCloudAiplatformV1beta1GroundingChunkRetrievedContext;
4248
- /** Grounding chunk from the web. */
4258
+ /** A grounding chunk from a web page, typically from Google Search. See the `Web` message for details. */
4249
4259
  web?: GoogleCloudAiplatformV1beta1GroundingChunkWeb;
4250
4260
  }
4251
4261
  interface GoogleCloudAiplatformV1beta1GroundingChunkMaps {
4252
- /** Sources 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. */
4262
+ /** 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. */
4253
4263
  placeAnswerSources?: GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSources;
4254
- /** This Place's resource name, in `places/{place_id}` format. Can be used to look up the Place. */
4264
+ /** This Place's resource name, in `places/{place_id}` format. This can be used to look up the place in the Google Maps API. */
4255
4265
  placeId?: string;
4256
- /** Text of the place answer. */
4266
+ /** The text of the place answer. */
4257
4267
  text?: string;
4258
- /** Title of the place. */
4268
+ /** The title of the place. */
4259
4269
  title?: string;
4260
- /** URI reference of the place. */
4270
+ /** The URI of the place. */
4261
4271
  uri?: string;
4262
4272
  }
4263
4273
  interface GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSources {
4264
- /** Snippets of reviews that are used to generate the answer. */
4274
+ /** Snippets of reviews that were used to generate the answer. */
4265
4275
  reviewSnippets?: GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSourcesReviewSnippet[];
4266
4276
  }
4267
4277
  interface GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSourcesReviewSnippet {
4268
4278
  /** A link to show the review on Google Maps. */
4269
4279
  googleMapsUri?: string;
4270
- /** Id of the review referencing the place. */
4280
+ /** The ID of the review that is being referenced. */
4271
4281
  reviewId?: string;
4272
- /** Title of the review. */
4282
+ /** The title of the review. */
4273
4283
  title?: string;
4274
4284
  }
4275
4285
  interface GoogleCloudAiplatformV1beta1GroundingChunkRetrievedContext {
4276
- /** Output only. The full document name for the referenced Vertex AI Search document. */
4286
+ /** 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}`. */
4277
4287
  documentName?: string;
4278
- /** Additional context for the RAG retrieval result. This is only populated when using the RAG retrieval tool. */
4288
+ /** Additional context for a Retrieval-Augmented Generation (RAG) retrieval result. This is populated only when the RAG retrieval tool is used. */
4279
4289
  ragChunk?: GoogleCloudAiplatformV1beta1RagChunk;
4280
- /** Text of the attribution. */
4290
+ /** The content of the retrieved data source. */
4281
4291
  text?: string;
4282
- /** Title of the attribution. */
4292
+ /** The title of the retrieved data source. */
4283
4293
  title?: string;
4284
- /** URI reference of the attribution. */
4294
+ /** The URI of the retrieved data source. */
4285
4295
  uri?: string;
4286
4296
  }
4287
4297
  interface GoogleCloudAiplatformV1beta1GroundingChunkWeb {
4288
- /** Domain of the (original) URI. */
4298
+ /** The domain of the web page that contains the evidence. This can be used to filter out low-quality sources. */
4289
4299
  domain?: string;
4290
- /** Title of the chunk. */
4300
+ /** The title of the web page that contains the evidence. */
4291
4301
  title?: string;
4292
- /** URI reference of the chunk. */
4302
+ /** The URI of the web page that contains the evidence. */
4293
4303
  uri?: string;
4294
4304
  }
4295
4305
  interface GoogleCloudAiplatformV1beta1GroundingMetadata {
4296
- /** Optional. Output only. Resource name of the Google Maps widget context token to be used with the PlacesContextElement widget to render contextual data. This is populated only for Google Maps grounding. */
4306
+ /** 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. */
4297
4307
  googleMapsWidgetContextToken?: string;
4298
- /** List of supporting references retrieved from specified grounding source. */
4308
+ /** 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. */
4299
4309
  groundingChunks?: GoogleCloudAiplatformV1beta1GroundingChunk[];
4300
- /** Optional. List of grounding support. */
4310
+ /** 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. */
4301
4311
  groundingSupports?: GoogleCloudAiplatformV1beta1GroundingSupport[];
4302
- /** Optional. Output only. Retrieval metadata. */
4312
+ /** Optional. Output only. Metadata related to the retrieval grounding source. */
4303
4313
  retrievalMetadata?: GoogleCloudAiplatformV1beta1RetrievalMetadata;
4304
- /** Optional. Queries executed by the retrieval tools. */
4314
+ /** Optional. The queries that were executed by the retrieval tools. This field is populated only when the grounding source is a retrieval tool, such as Vertex AI Search. */
4305
4315
  retrievalQueries?: string[];
4306
- /** Optional. Google search entry for the following-up web searches. */
4316
+ /** 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. */
4307
4317
  searchEntryPoint?: GoogleCloudAiplatformV1beta1SearchEntryPoint;
4308
- /** Optional. Output only. List of source flagging uris. This is currently populated only for Google Maps grounding. */
4318
+ /** 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. */
4309
4319
  sourceFlaggingUris?: GoogleCloudAiplatformV1beta1GroundingMetadataSourceFlaggingUri[];
4310
- /** Optional. Web search queries for the following-up web search. */
4320
+ /** Optional. The web search queries that were used to generate the content. This field is populated only when the grounding source is Google Search. */
4311
4321
  webSearchQueries?: string[];
4312
4322
  }
4313
4323
  interface GoogleCloudAiplatformV1beta1GroundingMetadataSourceFlaggingUri {
4314
- /** A link where users can flag a problem with the source (place or review). */
4324
+ /** The URI that can be used to flag the content. */
4315
4325
  flagContentUri?: string;
4316
- /** Id of the place or review. */
4326
+ /** The ID of the place or review. */
4317
4327
  sourceId?: string;
4318
4328
  }
4319
4329
  interface GoogleCloudAiplatformV1beta1GroundingSupport {
4320
- /** Confidence score of the support references. Ranges from 0 to 1. 1 is the most confident. For Gemini 2.0 and before, this list must have the same size as the grounding_chunk_indices. For Gemini 2.5 and after, this list will be empty and should be ignored. */
4330
+ /** 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. */
4321
4331
  confidenceScores?: number[];
4322
- /** A list of indices (into 'grounding_chunk') specifying the citations associated with the claim. For instance [1,3,4] means that grounding_chunk[1], grounding_chunk[3], grounding_chunk[4] are the retrieved content attributed to the claim. */
4332
+ /** 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. */
4323
4333
  groundingChunkIndices?: number[];
4324
- /** Segment of the content this support belongs to. */
4334
+ /** The content segment that this support message applies to. */
4325
4335
  segment?: GoogleCloudAiplatformV1beta1Segment;
4326
4336
  }
4327
4337
  interface GoogleCloudAiplatformV1beta1HyperparameterTuningJob {
@@ -5173,21 +5183,21 @@ declare namespace gapi.client {
5173
5183
  systemInstruction?: string;
5174
5184
  }
5175
5185
  interface GoogleCloudAiplatformV1beta1LogprobsResult {
5176
- /** Length = total number of decoding steps. The chosen candidates may or may not be in top_candidates. */
5186
+ /** 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`. */
5177
5187
  chosenCandidates?: GoogleCloudAiplatformV1beta1LogprobsResultCandidate[];
5178
- /** Length = total number of decoding steps. */
5188
+ /** 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. */
5179
5189
  topCandidates?: GoogleCloudAiplatformV1beta1LogprobsResultTopCandidates[];
5180
5190
  }
5181
5191
  interface GoogleCloudAiplatformV1beta1LogprobsResultCandidate {
5182
- /** The candidate's log probability. */
5192
+ /** 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. */
5183
5193
  logProbability?: number;
5184
- /** The candidate's token string value. */
5194
+ /** The token's string representation. */
5185
5195
  token?: string;
5186
- /** The candidate's token id value. */
5196
+ /** 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. */
5187
5197
  tokenId?: number;
5188
5198
  }
5189
5199
  interface GoogleCloudAiplatformV1beta1LogprobsResultTopCandidates {
5190
- /** Sorted by log probability in descending order. */
5200
+ /** The list of candidate tokens, sorted by log probability in descending order. */
5191
5201
  candidates?: GoogleCloudAiplatformV1beta1LogprobsResultCandidate[];
5192
5202
  }
5193
5203
  interface GoogleCloudAiplatformV1beta1LookupStudyRequest {
@@ -5255,6 +5265,8 @@ declare namespace gapi.client {
5255
5265
  name?: string;
5256
5266
  /** Optional. Input only. Timestamp of when the revision is considered expired. If not set, the memory revision will be kept until manually deleted. */
5257
5267
  revisionExpireTime?: string;
5268
+ /** Optional. Input only. The labels to apply to the Memory Revision created as a result of this request. */
5269
+ revisionLabels?: {[P in string]: string};
5258
5270
  /** Optional. Input only. The TTL for the revision. The expiration time is computed: now + TTL. */
5259
5271
  revisionTtl?: string;
5260
5272
  /** Required. Immutable. The scope of the Memory. Memories are isolated within their scope. The scope is defined when creating or generating memories. Scope values cannot contain the wildcard character '*'. */
@@ -5381,6 +5393,8 @@ declare namespace gapi.client {
5381
5393
  aggregationMetrics?: string[];
5382
5394
  /** Spec for bleu metric. */
5383
5395
  bleuSpec?: GoogleCloudAiplatformV1beta1BleuSpec;
5396
+ /** Spec for Custom Code Execution metric. */
5397
+ customCodeExecutionSpec?: GoogleCloudAiplatformV1beta1CustomCodeExecutionSpec;
5384
5398
  /** Spec for exact match metric. */
5385
5399
  exactMatchSpec?: any;
5386
5400
  /** Spec for an LLM based metric. */
@@ -5527,9 +5541,9 @@ declare namespace gapi.client {
5527
5541
  model?: string;
5528
5542
  }
5529
5543
  interface GoogleCloudAiplatformV1beta1ModalityTokenCount {
5530
- /** The modality associated with this token count. */
5544
+ /** The modality that this token count applies to. */
5531
5545
  modality?: string;
5532
- /** Number of tokens. */
5546
+ /** The number of tokens counted for this modality. */
5533
5547
  tokenCount?: number;
5534
5548
  }
5535
5549
  interface GoogleCloudAiplatformV1beta1Model {
@@ -5601,9 +5615,9 @@ declare namespace gapi.client {
5601
5615
  versionUpdateTime?: string;
5602
5616
  }
5603
5617
  interface GoogleCloudAiplatformV1beta1ModelArmorConfig {
5604
- /** Optional. The name of the Model Armor template to use for prompt sanitization. */
5618
+ /** 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}`. */
5605
5619
  promptTemplateName?: string;
5606
- /** Optional. The name of the Model Armor template to use for response sanitization. */
5620
+ /** 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}`. */
5607
5621
  responseTemplateName?: string;
5608
5622
  }
5609
5623
  interface GoogleCloudAiplatformV1beta1ModelBaseModelSource {
@@ -6802,21 +6816,21 @@ declare namespace gapi.client {
6802
6816
  version?: number;
6803
6817
  }
6804
6818
  interface GoogleCloudAiplatformV1beta1Part {
6805
- /** Optional. Result of executing the [ExecutableCode]. */
6819
+ /** Optional. The result of executing the ExecutableCode. */
6806
6820
  codeExecutionResult?: GoogleCloudAiplatformV1beta1CodeExecutionResult;
6807
- /** Optional. Code generated by the model that is meant to be executed. */
6821
+ /** Optional. Code generated by the model that is intended to be executed. */
6808
6822
  executableCode?: GoogleCloudAiplatformV1beta1ExecutableCode;
6809
- /** Optional. URI based data. */
6823
+ /** Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. */
6810
6824
  fileData?: GoogleCloudAiplatformV1beta1FileData;
6811
- /** Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. */
6825
+ /** 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. */
6812
6826
  functionCall?: GoogleCloudAiplatformV1beta1FunctionCall;
6813
- /** Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. */
6827
+ /** Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. */
6814
6828
  functionResponse?: GoogleCloudAiplatformV1beta1FunctionResponse;
6815
- /** Optional. Inlined bytes data. */
6829
+ /** Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. */
6816
6830
  inlineData?: GoogleCloudAiplatformV1beta1Blob;
6817
- /** Optional. Text part (can be code). */
6831
+ /** Optional. The text content of the part. */
6818
6832
  text?: string;
6819
- /** Optional. Indicates if the part is thought from the model. */
6833
+ /** Optional. Indicates whether the `part` represents the model's thought process or reasoning. */
6820
6834
  thought?: boolean;
6821
6835
  /** Optional. An opaque signature for the thought so it can be reused in subsequent requests. */
6822
6836
  thoughtSignature?: string;
@@ -7104,7 +7118,7 @@ declare namespace gapi.client {
7104
7118
  postStartupScriptUrl?: string;
7105
7119
  }
7106
7120
  interface GoogleCloudAiplatformV1beta1PrebuiltVoiceConfig {
7107
- /** The name of the preset voice to use. */
7121
+ /** The name of the prebuilt voice to use. */
7108
7122
  voiceName?: string;
7109
7123
  }
7110
7124
  interface GoogleCloudAiplatformV1beta1PredefinedMetricSpec {
@@ -7751,6 +7765,10 @@ declare namespace gapi.client {
7751
7765
  ragFilesCount?: number;
7752
7766
  /** Optional. Immutable. The Vector DB config of the RagCorpus. */
7753
7767
  ragVectorDbConfig?: GoogleCloudAiplatformV1beta1RagVectorDbConfig;
7768
+ /** Output only. Reserved for future use. */
7769
+ satisfiesPzi?: boolean;
7770
+ /** Output only. Reserved for future use. */
7771
+ satisfiesPzs?: boolean;
7754
7772
  /** Output only. Timestamp when this RagCorpus was last updated. */
7755
7773
  updateTime?: string;
7756
7774
  /** Optional. Immutable. The config for the Vector DBs. */
@@ -8181,6 +8199,8 @@ declare namespace gapi.client {
8181
8199
  generateUpdatedTtl?: string;
8182
8200
  }
8183
8201
  interface GoogleCloudAiplatformV1beta1ReasoningEngineSpec {
8202
+ /** Optional. The A2A Agent Card for the agent (if available). It follows the specification at https://a2a-protocol.org/latest/specification/#5-agent-discovery-the-agent-card. */
8203
+ agentCard?: {[P in string]: any};
8184
8204
  /** Optional. The OSS agent framework used to develop the agent. Currently supported values: "google-adk", "langchain", "langgraph", "ag2", "llama-index", "custom". */
8185
8205
  agentFramework?: string;
8186
8206
  /** Optional. Declarations for object class methods in OpenAPI specification format. */
@@ -8217,7 +8237,7 @@ declare namespace gapi.client {
8217
8237
  dependencyFilesGcsUri?: string;
8218
8238
  /** Optional. The Cloud Storage URI of the pickled python object. */
8219
8239
  pickleObjectGcsUri?: string;
8220
- /** Optional. The Python version. Currently support 3.8, 3.9, 3.10, 3.11. If not specified, default value is 3.10. */
8240
+ /** 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. */
8221
8241
  pythonVersion?: string;
8222
8242
  /** Optional. The Cloud Storage URI of the `requirements.txt` file */
8223
8243
  requirementsGcsUri?: string;
@@ -8404,7 +8424,7 @@ declare namespace gapi.client {
8404
8424
  latLng?: GoogleTypeLatLng;
8405
8425
  }
8406
8426
  interface GoogleCloudAiplatformV1beta1RetrievalMetadata {
8407
- /** Optional. Score indicating how likely information from Google Search could help answer the prompt. The score is in the range `[0, 1]`, where 0 is the least likely and 1 is the most likely. This score is only populated when Google Search grounding and dynamic retrieval is enabled. It will be compared to the threshold to determine whether to trigger Google Search. */
8427
+ /** 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. */
8408
8428
  googleSearchDynamicRetrievalScore?: number;
8409
8429
  }
8410
8430
  interface GoogleCloudAiplatformV1beta1RetrieveContextsRequest {
@@ -8623,19 +8643,19 @@ declare namespace gapi.client {
8623
8643
  prediction?: string;
8624
8644
  }
8625
8645
  interface GoogleCloudAiplatformV1beta1SafetyRating {
8626
- /** Output only. Indicates whether the content was filtered out because of this rating. */
8646
+ /** Output only. Indicates whether the content was blocked because of this rating. */
8627
8647
  blocked?: boolean;
8628
- /** Output only. Harm category. */
8648
+ /** Output only. The harm category of this rating. */
8629
8649
  category?: string;
8630
8650
  /** 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. */
8631
8651
  overwrittenThreshold?: string;
8632
- /** Output only. Harm probability levels in the content. */
8652
+ /** Output only. The probability of harm for this category. */
8633
8653
  probability?: string;
8634
- /** Output only. Harm probability score. */
8654
+ /** Output only. The probability score of harm for this category. */
8635
8655
  probabilityScore?: number;
8636
- /** Output only. Harm severity levels in the content. */
8656
+ /** Output only. The severity of harm for this category. */
8637
8657
  severity?: string;
8638
- /** Output only. Harm severity score. */
8658
+ /** Output only. The severity score of harm for this category. */
8639
8659
  severityScore?: number;
8640
8660
  }
8641
8661
  interface GoogleCloudAiplatformV1beta1SafetyResult {
@@ -8647,11 +8667,11 @@ declare namespace gapi.client {
8647
8667
  score?: number;
8648
8668
  }
8649
8669
  interface GoogleCloudAiplatformV1beta1SafetySetting {
8650
- /** Required. Harm category. */
8670
+ /** Required. The harm category to be blocked. */
8651
8671
  category?: string;
8652
- /** Optional. Specify if the threshold is used for probability or severity score. If not specified, the threshold is used for probability score. */
8672
+ /** Optional. The method for blocking content. If not specified, the default behavior is to use the probability score. */
8653
8673
  method?: string;
8654
- /** Required. The harm block threshold. */
8674
+ /** Required. The threshold for blocking content. If the harm probability exceeds this threshold, the content will be blocked. */
8655
8675
  threshold?: string;
8656
8676
  }
8657
8677
  interface GoogleCloudAiplatformV1beta1SafetySpec {
@@ -10301,9 +10321,9 @@ declare namespace gapi.client {
10301
10321
  nextPageToken?: string;
10302
10322
  }
10303
10323
  interface GoogleCloudAiplatformV1beta1SearchEntryPoint {
10304
- /** Optional. Web content snippet that can be embedded in a web page or an app webview. */
10324
+ /** 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. */
10305
10325
  renderedContent?: string;
10306
- /** Optional. Base64 encoded JSON representing array of tuple. */
10326
+ /** 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. */
10307
10327
  sdkBlob?: string;
10308
10328
  }
10309
10329
  interface GoogleCloudAiplatformV1beta1SearchExamplesRequest {
@@ -10446,13 +10466,13 @@ declare namespace gapi.client {
10446
10466
  version?: string;
10447
10467
  }
10448
10468
  interface GoogleCloudAiplatformV1beta1Segment {
10449
- /** Output only. End index in the given Part, measured in bytes. Offset from the start of the Part, exclusive, starting at zero. */
10469
+ /** 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. */
10450
10470
  endIndex?: number;
10451
- /** Output only. The index of a Part object within its parent Content object. */
10471
+ /** 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. */
10452
10472
  partIndex?: number;
10453
- /** Output only. Start index in the given Part, measured in bytes. Offset from the start of the Part, inclusive, starting at zero. */
10473
+ /** 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. */
10454
10474
  startIndex?: number;
10455
- /** Output only. The text corresponding to the segment from the response. */
10475
+ /** Output only. The text of the segment. */
10456
10476
  text?: string;
10457
10477
  }
10458
10478
  interface GoogleCloudAiplatformV1beta1ServiceAccountSpec {
@@ -10594,11 +10614,11 @@ declare namespace gapi.client {
10594
10614
  ngramSize?: number;
10595
10615
  }
10596
10616
  interface GoogleCloudAiplatformV1beta1SpeechConfig {
10597
- /** Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. */
10617
+ /** Optional. The language code (ISO 639-1) for the speech synthesis. */
10598
10618
  languageCode?: string;
10599
10619
  /** The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. */
10600
10620
  multiSpeakerVoiceConfig?: GoogleCloudAiplatformV1beta1MultiSpeakerVoiceConfig;
10601
- /** The configuration for the speaker to use. */
10621
+ /** The configuration for the voice to use. */
10602
10622
  voiceConfig?: GoogleCloudAiplatformV1beta1VoiceConfig;
10603
10623
  }
10604
10624
  interface GoogleCloudAiplatformV1beta1StartNotebookRuntimeOperationMetadata {
@@ -11923,13 +11943,13 @@ declare namespace gapi.client {
11923
11943
  }
11924
11944
  interface GoogleCloudAiplatformV1beta1UrlContext {}
11925
11945
  interface GoogleCloudAiplatformV1beta1UrlContextMetadata {
11926
- /** Output only. List of url context. */
11946
+ /** Output only. A list of URL metadata, with one entry for each URL retrieved by the tool. */
11927
11947
  urlMetadata?: GoogleCloudAiplatformV1beta1UrlMetadata[];
11928
11948
  }
11929
11949
  interface GoogleCloudAiplatformV1beta1UrlMetadata {
11930
- /** Retrieved url by the tool. */
11950
+ /** The URL retrieved by the tool. */
11931
11951
  retrievedUrl?: string;
11932
- /** Status of the url retrieval. */
11952
+ /** The status of the URL retrieval. */
11933
11953
  urlRetrievalStatus?: string;
11934
11954
  }
11935
11955
  interface GoogleCloudAiplatformV1beta1UsageMetadata {
@@ -12033,13 +12053,13 @@ declare namespace gapi.client {
12033
12053
  interface GoogleCloudAiplatformV1beta1VideoMetadata {
12034
12054
  /** Optional. The end offset of the video. */
12035
12055
  endOffset?: string;
12036
- /** Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. */
12056
+ /** 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]. */
12037
12057
  fps?: number;
12038
12058
  /** Optional. The start offset of the video. */
12039
12059
  startOffset?: string;
12040
12060
  }
12041
12061
  interface GoogleCloudAiplatformV1beta1VoiceConfig {
12042
- /** The configuration for the prebuilt voice to use. */
12062
+ /** The configuration for a prebuilt voice. */
12043
12063
  prebuiltVoiceConfig?: GoogleCloudAiplatformV1beta1PrebuiltVoiceConfig;
12044
12064
  }
12045
12065
  interface GoogleCloudAiplatformV1beta1WorkerPoolSpec {
@@ -43763,6 +43783,8 @@ declare namespace gapi.client {
43763
43783
  key?: string;
43764
43784
  /** OAuth 2.0 token for the current user. */
43765
43785
  oauth_token?: string;
43786
+ /** Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `timestamp` Example: `timestamp desc`. */
43787
+ orderBy?: string;
43766
43788
  /** Optional. The maximum number of events to return. The service may return fewer than this value. If unspecified, at most 100 events will be returned. These events are ordered by timestamp in ascending order. */
43767
43789
  pageSize?: number;
43768
43790
  /** Optional. The next_page_token value returned from a previous list SessionService.ListEvents call. */
@@ -49551,7 +49573,7 @@ declare namespace gapi.client {
49551
49573
  alt?: string;
49552
49574
  /** JSONP */
49553
49575
  callback?: string;
49554
- /** Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. */
49576
+ /** Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. */
49555
49577
  extraLocationTypes?: string | string[];
49556
49578
  /** Selector specifying which fields to include in a partial response. */
49557
49579
  fields?: string;
@@ -52325,6 +52347,209 @@ declare namespace gapi.client {
52325
52347
  }): Request<GoogleLongrunningOperation>;
52326
52348
  }
52327
52349
  interface SandboxEnvironmentsResource {
52350
+ /** Creates a SandboxEnvironment in a given reasoning engine. */
52351
+ create(request: {
52352
+ /** V1 error format. */
52353
+ '$.xgafv'?: string;
52354
+ /** OAuth access token. */
52355
+ access_token?: string;
52356
+ /** Data format for response. */
52357
+ alt?: string;
52358
+ /** JSONP */
52359
+ callback?: string;
52360
+ /** Selector specifying which fields to include in a partial response. */
52361
+ fields?: string;
52362
+ /** 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. */
52363
+ key?: string;
52364
+ /** OAuth 2.0 token for the current user. */
52365
+ oauth_token?: string;
52366
+ /** Required. The resource name of the reasoning engine to create the SandboxEnvironment in. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`. */
52367
+ parent: string;
52368
+ /** Returns response with indentations and line breaks. */
52369
+ prettyPrint?: boolean;
52370
+ /** 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. */
52371
+ quotaUser?: string;
52372
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
52373
+ upload_protocol?: string;
52374
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
52375
+ uploadType?: string;
52376
+ /** Request body */
52377
+ resource: GoogleCloudAiplatformV1beta1SandboxEnvironment;
52378
+ }): Request<GoogleLongrunningOperation>;
52379
+ create(
52380
+ request: {
52381
+ /** V1 error format. */
52382
+ '$.xgafv'?: string;
52383
+ /** OAuth access token. */
52384
+ access_token?: string;
52385
+ /** Data format for response. */
52386
+ alt?: string;
52387
+ /** JSONP */
52388
+ callback?: string;
52389
+ /** Selector specifying which fields to include in a partial response. */
52390
+ fields?: string;
52391
+ /** 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. */
52392
+ key?: string;
52393
+ /** OAuth 2.0 token for the current user. */
52394
+ oauth_token?: string;
52395
+ /** Required. The resource name of the reasoning engine to create the SandboxEnvironment in. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`. */
52396
+ parent: string;
52397
+ /** Returns response with indentations and line breaks. */
52398
+ prettyPrint?: boolean;
52399
+ /** 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. */
52400
+ quotaUser?: string;
52401
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
52402
+ upload_protocol?: string;
52403
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
52404
+ uploadType?: string;
52405
+ },
52406
+ body: GoogleCloudAiplatformV1beta1SandboxEnvironment,
52407
+ ): Request<GoogleLongrunningOperation>;
52408
+ /** Deletes the specific SandboxEnvironment. */
52409
+ delete(request?: {
52410
+ /** V1 error format. */
52411
+ '$.xgafv'?: string;
52412
+ /** OAuth access token. */
52413
+ access_token?: string;
52414
+ /** Data format for response. */
52415
+ alt?: string;
52416
+ /** JSONP */
52417
+ callback?: string;
52418
+ /** Selector specifying which fields to include in a partial response. */
52419
+ fields?: string;
52420
+ /** 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. */
52421
+ key?: string;
52422
+ /** Required. The resource name of the SandboxEnvironment to delete. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironments/{sandbox_environment}` */
52423
+ name: string;
52424
+ /** OAuth 2.0 token for the current user. */
52425
+ oauth_token?: string;
52426
+ /** Returns response with indentations and line breaks. */
52427
+ prettyPrint?: boolean;
52428
+ /** 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. */
52429
+ quotaUser?: string;
52430
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
52431
+ upload_protocol?: string;
52432
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
52433
+ uploadType?: string;
52434
+ }): Request<GoogleLongrunningOperation>;
52435
+ /** Executes using a sandbox environment. */
52436
+ execute(request: {
52437
+ /** V1 error format. */
52438
+ '$.xgafv'?: string;
52439
+ /** OAuth access token. */
52440
+ access_token?: string;
52441
+ /** Data format for response. */
52442
+ alt?: string;
52443
+ /** JSONP */
52444
+ callback?: string;
52445
+ /** Selector specifying which fields to include in a partial response. */
52446
+ fields?: string;
52447
+ /** 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. */
52448
+ key?: string;
52449
+ /** Required. The resource name of the sandbox environment to execute. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironments/{sandbox_environment}` */
52450
+ name: string;
52451
+ /** OAuth 2.0 token for the current user. */
52452
+ oauth_token?: string;
52453
+ /** Returns response with indentations and line breaks. */
52454
+ prettyPrint?: boolean;
52455
+ /** 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. */
52456
+ quotaUser?: string;
52457
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
52458
+ upload_protocol?: string;
52459
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
52460
+ uploadType?: string;
52461
+ /** Request body */
52462
+ resource: GoogleCloudAiplatformV1beta1ExecuteSandboxEnvironmentRequest;
52463
+ }): Request<GoogleCloudAiplatformV1beta1ExecuteSandboxEnvironmentResponse>;
52464
+ execute(
52465
+ request: {
52466
+ /** V1 error format. */
52467
+ '$.xgafv'?: string;
52468
+ /** OAuth access token. */
52469
+ access_token?: string;
52470
+ /** Data format for response. */
52471
+ alt?: string;
52472
+ /** JSONP */
52473
+ callback?: string;
52474
+ /** Selector specifying which fields to include in a partial response. */
52475
+ fields?: string;
52476
+ /** 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. */
52477
+ key?: string;
52478
+ /** Required. The resource name of the sandbox environment to execute. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironments/{sandbox_environment}` */
52479
+ name: string;
52480
+ /** OAuth 2.0 token for the current user. */
52481
+ oauth_token?: string;
52482
+ /** Returns response with indentations and line breaks. */
52483
+ prettyPrint?: boolean;
52484
+ /** 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. */
52485
+ quotaUser?: string;
52486
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
52487
+ upload_protocol?: string;
52488
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
52489
+ uploadType?: string;
52490
+ },
52491
+ body: GoogleCloudAiplatformV1beta1ExecuteSandboxEnvironmentRequest,
52492
+ ): Request<GoogleCloudAiplatformV1beta1ExecuteSandboxEnvironmentResponse>;
52493
+ /** Gets details of the specific SandboxEnvironment. */
52494
+ get(request?: {
52495
+ /** V1 error format. */
52496
+ '$.xgafv'?: string;
52497
+ /** OAuth access token. */
52498
+ access_token?: string;
52499
+ /** Data format for response. */
52500
+ alt?: string;
52501
+ /** JSONP */
52502
+ callback?: string;
52503
+ /** Selector specifying which fields to include in a partial response. */
52504
+ fields?: string;
52505
+ /** 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. */
52506
+ key?: string;
52507
+ /** Required. The resource name of the sandbox environment. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironments/{sandbox_environment}` */
52508
+ name: string;
52509
+ /** OAuth 2.0 token for the current user. */
52510
+ oauth_token?: string;
52511
+ /** Returns response with indentations and line breaks. */
52512
+ prettyPrint?: boolean;
52513
+ /** 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. */
52514
+ quotaUser?: string;
52515
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
52516
+ upload_protocol?: string;
52517
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
52518
+ uploadType?: string;
52519
+ }): Request<GoogleCloudAiplatformV1beta1SandboxEnvironment>;
52520
+ /** Lists SandboxEnvironments in a given reasoning engine. */
52521
+ list(request?: {
52522
+ /** V1 error format. */
52523
+ '$.xgafv'?: string;
52524
+ /** OAuth access token. */
52525
+ access_token?: string;
52526
+ /** Data format for response. */
52527
+ alt?: string;
52528
+ /** JSONP */
52529
+ callback?: string;
52530
+ /** Selector specifying which fields to include in a partial response. */
52531
+ fields?: string;
52532
+ /** Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). */
52533
+ filter?: string;
52534
+ /** 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. */
52535
+ key?: string;
52536
+ /** OAuth 2.0 token for the current user. */
52537
+ oauth_token?: string;
52538
+ /** Optional. The maximum number of SandboxEnvironments to return. The service may return fewer than this value. If unspecified, at most 100 SandboxEnvironments will be returned. */
52539
+ pageSize?: number;
52540
+ /** Optional. The standard list page token, received from a previous `ListSandboxEnvironments` call. Provide this to retrieve the subsequent page. */
52541
+ pageToken?: string;
52542
+ /** Required. The resource name of the reasoning engine to list sandbox environments from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` */
52543
+ parent: string;
52544
+ /** Returns response with indentations and line breaks. */
52545
+ prettyPrint?: boolean;
52546
+ /** 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. */
52547
+ quotaUser?: string;
52548
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
52549
+ upload_protocol?: string;
52550
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
52551
+ uploadType?: string;
52552
+ }): Request<GoogleCloudAiplatformV1beta1ListSandboxEnvironmentsResponse>;
52328
52553
  operations: OperationsResource;
52329
52554
  }
52330
52555
  interface EventsResource {
@@ -52346,6 +52571,8 @@ declare namespace gapi.client {
52346
52571
  key?: string;
52347
52572
  /** OAuth 2.0 token for the current user. */
52348
52573
  oauth_token?: string;
52574
+ /** Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `timestamp` Example: `timestamp desc`. */
52575
+ orderBy?: string;
52349
52576
  /** Optional. The maximum number of events to return. The service may return fewer than this value. If unspecified, at most 100 events will be returned. These events are ordered by timestamp in ascending order. */
52350
52577
  pageSize?: number;
52351
52578
  /** Optional. The next_page_token value returned from a previous list SessionService.ListEvents call. */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.aiplatform-v1beta1",
3
- "version": "0.3.20251028",
3
+ "version": "0.4.20251028",
4
4
  "description": "TypeScript typings for Vertex AI API v1beta1",
5
5
  "repository": {
6
6
  "type": "git",