@maxim_mazurok/gapi.client.aiplatform-v1 0.0.20240105 → 0.0.20240125
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 +206 -16
- 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: 20240125
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -128,6 +128,8 @@ declare namespace gapi.client {
|
|
|
128
128
|
finishMessage?: string;
|
|
129
129
|
/** The reason why the model stopped generating tokens. */
|
|
130
130
|
finishReason?: string;
|
|
131
|
+
/** Grounding metadata. Combine with the facts list from response to generate grounding citations for this choice. */
|
|
132
|
+
groundingMetadata?: LearningGenaiRootGroundingMetadata;
|
|
131
133
|
/** Index of the candidate. */
|
|
132
134
|
index?: number;
|
|
133
135
|
/** Safety ratings of the generated content. */
|
|
@@ -157,6 +159,16 @@ declare namespace gapi.client {
|
|
|
157
159
|
/** The role of the current conversation participant. */
|
|
158
160
|
role?: string;
|
|
159
161
|
}
|
|
162
|
+
interface CloudAiNlLlmProtoServiceFact {
|
|
163
|
+
/** Query that is used to retrieve this fact. */
|
|
164
|
+
query?: string;
|
|
165
|
+
/** If present, the summary/snippet of the fact. */
|
|
166
|
+
summary?: string;
|
|
167
|
+
/** If present, it refers to the title of this fact. */
|
|
168
|
+
title?: string;
|
|
169
|
+
/** If present, this URL links to the webpage of the fact. */
|
|
170
|
+
url?: string;
|
|
171
|
+
}
|
|
160
172
|
interface CloudAiNlLlmProtoServiceFunctionCall {
|
|
161
173
|
/** The function parameters and values in JSON format. */
|
|
162
174
|
args?: {[P in string]: any};
|
|
@@ -174,6 +186,8 @@ declare namespace gapi.client {
|
|
|
174
186
|
candidates?: CloudAiNlLlmProtoServiceCandidate[];
|
|
175
187
|
/** Debug information containing message metadata. Clients should not consume this field, and this is only populated for Flow Runner path. */
|
|
176
188
|
debugMetadata?: CloudAiNlLlmProtoServiceMessageMetadata;
|
|
189
|
+
/** External facts retrieved for factuality/grounding. */
|
|
190
|
+
facts?: CloudAiNlLlmProtoServiceFact[];
|
|
177
191
|
/** Content filter results for a prompt sent in the request. Note: Sent only in the first stream chunk. Only happens when no candidates were generated due to content violations. */
|
|
178
192
|
promptFeedback?: CloudAiNlLlmProtoServicePromptFeedback;
|
|
179
193
|
/** Billable prediction metrics. */
|
|
@@ -220,9 +234,17 @@ declare namespace gapi.client {
|
|
|
220
234
|
interface CloudAiNlLlmProtoServicePartVideoMetadata {
|
|
221
235
|
/** The end offset of the video. */
|
|
222
236
|
endOffset?: string;
|
|
237
|
+
/** Internal only model level metadata. */
|
|
238
|
+
modelLevelMetaData?: CloudAiNlLlmProtoServicePartVideoMetadataModelLevelMetadata;
|
|
223
239
|
/** The start offset of the video. */
|
|
224
240
|
startOffset?: string;
|
|
225
241
|
}
|
|
242
|
+
interface CloudAiNlLlmProtoServicePartVideoMetadataModelLevelMetadata {
|
|
243
|
+
/** Frame rate to decode from this video. */
|
|
244
|
+
fps?: number;
|
|
245
|
+
/** Number of frames to decode from this video. */
|
|
246
|
+
numFrames?: number;
|
|
247
|
+
}
|
|
226
248
|
interface CloudAiNlLlmProtoServicePromptFeedback {
|
|
227
249
|
/** Blocked reason. */
|
|
228
250
|
blockReason?: string;
|
|
@@ -241,7 +263,7 @@ declare namespace gapi.client {
|
|
|
241
263
|
/** Whether the text should be filtered and not shown to the end user. This is determined based on a combination of `triggered_recitation`, `triggered_blocklist`, `language_filter_result`, and `triggered_safety_filter`. */
|
|
242
264
|
filtered?: boolean;
|
|
243
265
|
/** Language filter result from SAFT LangId. */
|
|
244
|
-
languageFilterResult?:
|
|
266
|
+
languageFilterResult?: LearningGenaiRootLanguageFilterResult;
|
|
245
267
|
/** The RAI signals for the text. */
|
|
246
268
|
raiSignals?: CloudAiNlLlmProtoServiceRaiSignal[];
|
|
247
269
|
/** Whether the text triggered the blocklist. */
|
|
@@ -875,6 +897,8 @@ declare namespace gapi.client {
|
|
|
875
897
|
pipelineJob?: GoogleCloudAiplatformV1PipelineJob;
|
|
876
898
|
/** The ID to use for the PipelineJob, which will become the final component of the PipelineJob name. If not provided, an ID will be automatically generated. This value should be less than 128 characters, and valid characters are `/a-z-/`. */
|
|
877
899
|
pipelineJobId?: string;
|
|
900
|
+
/** Optional. Whether to do component level validations before job creation. Currently we only support Google First Party Component/Pipelines. */
|
|
901
|
+
preflightValidations?: boolean;
|
|
878
902
|
}
|
|
879
903
|
interface GoogleCloudAiplatformV1CreateRegistryFeatureOperationMetadata {
|
|
880
904
|
/** Operation metadata for Feature. */
|
|
@@ -1471,7 +1495,7 @@ declare namespace gapi.client {
|
|
|
1471
1495
|
predictions?: any[];
|
|
1472
1496
|
}
|
|
1473
1497
|
interface GoogleCloudAiplatformV1Explanation {
|
|
1474
|
-
/** Output only. Feature attributions grouped by predicted outputs. For Models that predict only one output, such as regression Models that predict only one score, there is only one attibution that explains the predicted output. For Models that predict multiple outputs, such as multiclass Models that predict multiple classes, each element explains one specific item. Attribution.output_index can be used to identify which output this attribution is explaining. If users set ExplanationParameters.top_k, the attributions are sorted by instance_output_value in descending order. If ExplanationParameters.output_indices is specified, the attributions are stored by Attribution.output_index in the same order as they appear in the output_indices. */
|
|
1498
|
+
/** Output only. Feature attributions grouped by predicted outputs. For Models that predict only one output, such as regression Models that predict only one score, there is only one attibution that explains the predicted output. For Models that predict multiple outputs, such as multiclass Models that predict multiple classes, each element explains one specific item. Attribution.output_index can be used to identify which output this attribution is explaining. By default, we provide Shapley values for the predicted class. However, you can configure the explanation request to generate Shapley values for any other classes too. For example, if a model predicts a probability of `0.4` for approving a loan application, the model's decision is to reject the application since `p(reject) = 0.6 > p(approve) = 0.4`, and the default Shapley values would be computed for rejection decision and not approval, even though the latter might be the positive class. If users set ExplanationParameters.top_k, the attributions are sorted by instance_output_value in descending order. If ExplanationParameters.output_indices is specified, the attributions are stored by Attribution.output_index in the same order as they appear in the output_indices. */
|
|
1475
1499
|
attributions?: GoogleCloudAiplatformV1Attribution[];
|
|
1476
1500
|
/** Output only. List of the nearest neighbors for example-based explanations. For models deployed with the examples explanations feature enabled, the attributions field is empty and instead the neighbors field is populated. */
|
|
1477
1501
|
neighbors?: GoogleCloudAiplatformV1Neighbor[];
|
|
@@ -2336,6 +2360,8 @@ declare namespace gapi.client {
|
|
|
2336
2360
|
interface GoogleCloudAiplatformV1IndexPrivateEndpoints {
|
|
2337
2361
|
/** Output only. The ip address used to send match gRPC requests. */
|
|
2338
2362
|
matchGrpcAddress?: string;
|
|
2363
|
+
/** Output only. PscAutomatedEndpoints is populated if private service connect is enabled if PscAutomatedConfig is set. */
|
|
2364
|
+
pscAutomatedEndpoints?: GoogleCloudAiplatformV1PscAutomatedEndpoints[];
|
|
2339
2365
|
/** Output only. The name of the service attachment resource. Populated if private service connect is enabled. */
|
|
2340
2366
|
serviceAttachment?: string;
|
|
2341
2367
|
}
|
|
@@ -2857,7 +2883,7 @@ declare namespace gapi.client {
|
|
|
2857
2883
|
metadataArtifact?: string;
|
|
2858
2884
|
/** Immutable. Points to a YAML file stored on Google Cloud Storage describing additional information about the Model, that is specific to it. Unset if the Model does not have any additional information. 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, if no additional metadata is needed, this field is set to an empty string. 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. */
|
|
2859
2885
|
metadataSchemaUri?: string;
|
|
2860
|
-
/** Output only. Source of a model. It can either be automl training pipeline, custom training pipeline, BigQuery ML, or
|
|
2886
|
+
/** Output only. Source of a model. It can either be automl training pipeline, custom training pipeline, BigQuery ML, or saved and tuned from Genie or Model Garden. */
|
|
2861
2887
|
modelSourceInfo?: GoogleCloudAiplatformV1ModelSourceInfo;
|
|
2862
2888
|
/** The resource name of the Model. */
|
|
2863
2889
|
name?: string;
|
|
@@ -3539,6 +3565,8 @@ declare namespace gapi.client {
|
|
|
3539
3565
|
taskDetails?: GoogleCloudAiplatformV1PipelineTaskDetail[];
|
|
3540
3566
|
}
|
|
3541
3567
|
interface GoogleCloudAiplatformV1PipelineJobRuntimeConfig {
|
|
3568
|
+
/** Optional. The default runtime for the PipelineJob. If not provided, Vertex Custom Job is used as the runtime. For Vertex Custom Job, please refer to https://cloud.google.com/vertex-ai/docs/training/overview */
|
|
3569
|
+
defaultRuntime?: GoogleCloudAiplatformV1PipelineJobRuntimeConfigDefaultRuntime;
|
|
3542
3570
|
/** Represents the failure policy of a pipeline. Currently, the default of a pipeline is that the pipeline will continue to run until no more tasks can be executed, also known as PIPELINE_FAILURE_POLICY_FAIL_SLOW. However, if a pipeline is set to PIPELINE_FAILURE_POLICY_FAIL_FAST, it will stop scheduling any new tasks when a task has failed. Any scheduled tasks will continue to completion. */
|
|
3543
3571
|
failurePolicy?: string;
|
|
3544
3572
|
/** Required. A path in a Cloud Storage bucket, which will be treated as the root output directory of the pipeline. It is used by the system to generate the paths of output artifacts. The artifact paths are generated with a sub-path pattern `{job_id}/{task_id}/{output_key}` under the specified output directory. The service account specified in this pipeline must have the `storage.objects.get` and `storage.objects.create` permissions for this bucket. */
|
|
@@ -3552,10 +3580,18 @@ declare namespace gapi.client {
|
|
|
3552
3580
|
/** The runtime parameters of the PipelineJob. The parameters will be passed into PipelineJob.pipeline_spec to replace the placeholders at runtime. This field is used by pipelines built using `PipelineJob.pipeline_spec.schema_version` 2.1.0, such as pipelines built using Kubeflow Pipelines SDK 1.9 or higher and the v2 DSL. */
|
|
3553
3581
|
parameterValues?: {[P in string]: any};
|
|
3554
3582
|
}
|
|
3583
|
+
interface GoogleCloudAiplatformV1PipelineJobRuntimeConfigDefaultRuntime {
|
|
3584
|
+
/** Persistent resource based runtime detail. */
|
|
3585
|
+
persistentResourceRuntimeDetail?: GoogleCloudAiplatformV1PipelineJobRuntimeConfigPersistentResourceRuntimeDetail;
|
|
3586
|
+
}
|
|
3555
3587
|
interface GoogleCloudAiplatformV1PipelineJobRuntimeConfigInputArtifact {
|
|
3556
3588
|
/** Artifact resource id from MLMD. Which is the last portion of an artifact resource name: `projects/{project}/locations/{location}/metadataStores/default/artifacts/{artifact_id}`. The artifact must stay within the same project, location and default metadatastore as the pipeline. */
|
|
3557
3589
|
artifactId?: string;
|
|
3558
3590
|
}
|
|
3591
|
+
interface GoogleCloudAiplatformV1PipelineJobRuntimeConfigPersistentResourceRuntimeDetail {
|
|
3592
|
+
/** Persistent resource name. Format: `projects/{project}/locations/{location}/persistentResources/{persistent_resource}` */
|
|
3593
|
+
persistentResourceName?: string;
|
|
3594
|
+
}
|
|
3559
3595
|
interface GoogleCloudAiplatformV1PipelineTaskDetail {
|
|
3560
3596
|
/** Output only. Task create time. */
|
|
3561
3597
|
createTime?: string;
|
|
@@ -3704,6 +3740,14 @@ declare namespace gapi.client {
|
|
|
3704
3740
|
/** Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. */
|
|
3705
3741
|
command?: string[];
|
|
3706
3742
|
}
|
|
3743
|
+
interface GoogleCloudAiplatformV1PscAutomatedEndpoints {
|
|
3744
|
+
/** Ip Address created by the automated forwarding rule. */
|
|
3745
|
+
matchAddress?: string;
|
|
3746
|
+
/** Corresponding network in pscAutomationConfigs. */
|
|
3747
|
+
network?: string;
|
|
3748
|
+
/** Corresponding project_id in pscAutomationConfigs */
|
|
3749
|
+
projectId?: string;
|
|
3750
|
+
}
|
|
3707
3751
|
interface GoogleCloudAiplatformV1PublisherModel {
|
|
3708
3752
|
/** Optional. Additional information about the model's Frameworks. */
|
|
3709
3753
|
frameworks?: string[];
|
|
@@ -5511,6 +5555,10 @@ declare namespace gapi.client {
|
|
|
5511
5555
|
/** Required. Selector choosing Features of the target EntityType. Feature IDs will be deduplicated. */
|
|
5512
5556
|
featureSelector?: GoogleCloudAiplatformV1FeatureSelector;
|
|
5513
5557
|
}
|
|
5558
|
+
interface GoogleCloudAiplatformV1StreamRawPredictRequest {
|
|
5559
|
+
/** The prediction input. Supports HTTP headers and arbitrary data payload. */
|
|
5560
|
+
httpBody?: GoogleApiHttpBody;
|
|
5561
|
+
}
|
|
5514
5562
|
interface GoogleCloudAiplatformV1StringArray {
|
|
5515
5563
|
/** A list of string values. */
|
|
5516
5564
|
values?: string[];
|
|
@@ -6165,7 +6213,7 @@ declare namespace gapi.client {
|
|
|
6165
6213
|
condition?: GoogleTypeExpr;
|
|
6166
6214
|
/** Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. */
|
|
6167
6215
|
members?: string[];
|
|
6168
|
-
/** Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. */
|
|
6216
|
+
/** Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles). */
|
|
6169
6217
|
role?: string;
|
|
6170
6218
|
}
|
|
6171
6219
|
interface GoogleIamV1Policy {
|
|
@@ -6282,6 +6330,8 @@ declare namespace gapi.client {
|
|
|
6282
6330
|
arxivId?: string;
|
|
6283
6331
|
author?: string;
|
|
6284
6332
|
bibkey?: string;
|
|
6333
|
+
/** ID of the paper in bioarxiv like ddoi.org/{biorxiv_id} eg: https://doi.org/10.1101/343517 */
|
|
6334
|
+
biorxivId?: string;
|
|
6285
6335
|
bookTitle?: string;
|
|
6286
6336
|
/** The Oceanographers full-view books dataset uses a 'volume id' as the unique ID of a book. There is a deterministic function from a volume id to a URL under the books.google.com domain. Marked as 'optional' since a volume ID of zero is potentially possible and we want to distinguish that from the volume ID not being set. */
|
|
6287
6337
|
bookVolumeId?: string;
|
|
@@ -6314,6 +6364,8 @@ declare namespace gapi.client {
|
|
|
6314
6364
|
volumeId?: string;
|
|
6315
6365
|
/** Wikipedia article title. The Wikipedia TFDS dataset includes article titles but not URLs. While a URL is to the best of our knowledge a deterministic function of the title, we store the original title to reflect the information in the original dataset. */
|
|
6316
6366
|
wikipediaArticleTitle?: string;
|
|
6367
|
+
/** The unique video id from Youtube. Example: AkoGsW52Ir0 */
|
|
6368
|
+
youtubeVideoId?: string;
|
|
6317
6369
|
}
|
|
6318
6370
|
interface LanguageLabsAidaTrustRecitationProtoRecitationResult {
|
|
6319
6371
|
dynamicSegmentResults?: LanguageLabsAidaTrustRecitationProtoSegmentResult[];
|
|
@@ -6352,6 +6404,8 @@ declare namespace gapi.client {
|
|
|
6352
6404
|
arxivId?: string;
|
|
6353
6405
|
author?: string;
|
|
6354
6406
|
bibkey?: string;
|
|
6407
|
+
/** ID of the paper in bioarxiv like ddoi.org/{biorxiv_id} eg: https://doi.org/10.1101/343517 */
|
|
6408
|
+
biorxivId?: string;
|
|
6355
6409
|
bookTitle?: string;
|
|
6356
6410
|
/** The Oceanographers full-view books dataset uses a 'volume id' as the unique ID of a book. There is a deterministic function from a volume id to a URL under the books.google.com domain. Marked as 'optional' since a volume ID of zero is potentially possible and we want to distinguish that from the volume ID not being set. */
|
|
6357
6411
|
bookVolumeId?: string;
|
|
@@ -6384,6 +6438,7 @@ declare namespace gapi.client {
|
|
|
6384
6438
|
volumeId?: string;
|
|
6385
6439
|
/** Wikipedia article title. The Wikipedia TFDS dataset includes article titles but not URLs. While a URL is to the best of our knowledge a deterministic function of the title, we store the original title to reflect the information in the original dataset. */
|
|
6386
6440
|
wikipediaArticleTitle?: string;
|
|
6441
|
+
youtubeVideoId?: string;
|
|
6387
6442
|
}
|
|
6388
6443
|
interface LearningGenaiRecitationRecitationResult {
|
|
6389
6444
|
dynamicSegmentResults?: LearningGenaiRecitationSegmentResult[];
|
|
@@ -6454,7 +6509,7 @@ declare namespace gapi.client {
|
|
|
6454
6509
|
interface LearningGenaiRootFilterMetadataFilterDebugInfo {
|
|
6455
6510
|
classifierOutput?: LearningGenaiRootClassifierOutput;
|
|
6456
6511
|
defaultMetadata?: string;
|
|
6457
|
-
languageFilterResult?:
|
|
6512
|
+
languageFilterResult?: LearningGenaiRootLanguageFilterResult;
|
|
6458
6513
|
/** Safety filter output information for LLM Root RAI harm check. */
|
|
6459
6514
|
raiOutput?: LearningGenaiRootRAIOutput;
|
|
6460
6515
|
raiResult?: CloudAiNlLlmProtoServiceRaiResult;
|
|
@@ -6463,6 +6518,22 @@ declare namespace gapi.client {
|
|
|
6463
6518
|
takedownResult?: LearningGenaiRootTakedownResult;
|
|
6464
6519
|
toxicityResult?: LearningGenaiRootToxicityResult;
|
|
6465
6520
|
}
|
|
6521
|
+
interface LearningGenaiRootGroundingMetadata {
|
|
6522
|
+
citations?: LearningGenaiRootGroundingMetadataCitation[];
|
|
6523
|
+
/** True if grounding is cancelled, for example, no facts being retrieved. */
|
|
6524
|
+
groundingCancelled?: boolean;
|
|
6525
|
+
searchQueries?: string[];
|
|
6526
|
+
}
|
|
6527
|
+
interface LearningGenaiRootGroundingMetadataCitation {
|
|
6528
|
+
/** Index in the prediction output where the citation ends (exclusive). Must be > start_index and < len(output). */
|
|
6529
|
+
endIndex?: number;
|
|
6530
|
+
/** Index of the fact supporting this claim. Should be within the range of the `world_facts` in the GenerateResponse. */
|
|
6531
|
+
factIndex?: number;
|
|
6532
|
+
/** Confidence score of this entailment. Value is [0,1] with 1 is the most confidence. */
|
|
6533
|
+
score?: number;
|
|
6534
|
+
/** Index in the prediction output where the citation starts (inclusive). Must be >= 0 and < end_index. */
|
|
6535
|
+
startIndex?: number;
|
|
6536
|
+
}
|
|
6466
6537
|
interface LearningGenaiRootHarm {
|
|
6467
6538
|
/** Please do not use, this is still under development. */
|
|
6468
6539
|
contextualDangerous?: boolean;
|
|
@@ -6502,6 +6573,14 @@ declare namespace gapi.client {
|
|
|
6502
6573
|
interface LearningGenaiRootInternalMetadata {
|
|
6503
6574
|
scoredTokens?: LearningGenaiRootScoredToken[];
|
|
6504
6575
|
}
|
|
6576
|
+
interface LearningGenaiRootLanguageFilterResult {
|
|
6577
|
+
/** False when query or response should be filtered out due to unsupported language. */
|
|
6578
|
+
allowed?: boolean;
|
|
6579
|
+
/** Language of the query or response. */
|
|
6580
|
+
detectedLanguage?: string;
|
|
6581
|
+
/** Probability of the language predicted as returned by LangID. */
|
|
6582
|
+
detectedLanguageProbability?: number;
|
|
6583
|
+
}
|
|
6505
6584
|
interface LearningGenaiRootMetricOutput {
|
|
6506
6585
|
debug?: string;
|
|
6507
6586
|
/** Name of the metric. */
|
|
@@ -6636,14 +6715,6 @@ declare namespace gapi.client {
|
|
|
6636
6715
|
label?: string;
|
|
6637
6716
|
score?: number;
|
|
6638
6717
|
}
|
|
6639
|
-
interface LearningServingLlmLanguageFilterResult {
|
|
6640
|
-
/** False when query or response should be filtered out due to unsupported language. */
|
|
6641
|
-
allowed?: boolean;
|
|
6642
|
-
/** Language of the query or response. */
|
|
6643
|
-
detectedLanguage?: string;
|
|
6644
|
-
/** Probability of the language predicted as returned by LangID. */
|
|
6645
|
-
detectedLanguageProbability?: number;
|
|
6646
|
-
}
|
|
6647
6718
|
interface LearningServingLlmMessageMetadata {
|
|
6648
6719
|
/** Summary of classifier output. We attach this to all messages regardless of whether classification rules triggered or not. */
|
|
6649
6720
|
classifierSummary?: LearningGenaiRootClassifierOutputSummary;
|
|
@@ -6656,6 +6727,7 @@ declare namespace gapi.client {
|
|
|
6656
6727
|
finalMessageScore?: LearningGenaiRootScore;
|
|
6657
6728
|
/** NOT YET IMPLEMENTED. */
|
|
6658
6729
|
finishReason?: string;
|
|
6730
|
+
groundingMetadata?: LearningGenaiRootGroundingMetadata;
|
|
6659
6731
|
/** Applies to Response message only. Indicates whether the message is a fallback and the response would have otherwise been empty. */
|
|
6660
6732
|
isFallback?: boolean;
|
|
6661
6733
|
/** Result from nlp_saft DetectLanguage method. Currently the predicted language code and language probability is used. */
|
|
@@ -10441,6 +10513,63 @@ declare namespace gapi.client {
|
|
|
10441
10513
|
},
|
|
10442
10514
|
body: GoogleCloudAiplatformV1GenerateContentRequest
|
|
10443
10515
|
): Request<GoogleCloudAiplatformV1GenerateContentResponse>;
|
|
10516
|
+
streamRawPredict(request: {
|
|
10517
|
+
/** V1 error format. */
|
|
10518
|
+
'$.xgafv'?: string;
|
|
10519
|
+
/** OAuth access token. */
|
|
10520
|
+
access_token?: string;
|
|
10521
|
+
/** Data format for response. */
|
|
10522
|
+
alt?: string;
|
|
10523
|
+
/** JSONP */
|
|
10524
|
+
callback?: string;
|
|
10525
|
+
/** Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` */
|
|
10526
|
+
endpoint: string;
|
|
10527
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
10528
|
+
fields?: string;
|
|
10529
|
+
/** 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. */
|
|
10530
|
+
key?: string;
|
|
10531
|
+
/** OAuth 2.0 token for the current user. */
|
|
10532
|
+
oauth_token?: string;
|
|
10533
|
+
/** Returns response with indentations and line breaks. */
|
|
10534
|
+
prettyPrint?: boolean;
|
|
10535
|
+
/** 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. */
|
|
10536
|
+
quotaUser?: string;
|
|
10537
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
10538
|
+
upload_protocol?: string;
|
|
10539
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
10540
|
+
uploadType?: string;
|
|
10541
|
+
/** Request body */
|
|
10542
|
+
resource: GoogleCloudAiplatformV1StreamRawPredictRequest;
|
|
10543
|
+
}): Request<GoogleApiHttpBody>;
|
|
10544
|
+
streamRawPredict(
|
|
10545
|
+
request: {
|
|
10546
|
+
/** V1 error format. */
|
|
10547
|
+
'$.xgafv'?: string;
|
|
10548
|
+
/** OAuth access token. */
|
|
10549
|
+
access_token?: string;
|
|
10550
|
+
/** Data format for response. */
|
|
10551
|
+
alt?: string;
|
|
10552
|
+
/** JSONP */
|
|
10553
|
+
callback?: string;
|
|
10554
|
+
/** Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` */
|
|
10555
|
+
endpoint: string;
|
|
10556
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
10557
|
+
fields?: string;
|
|
10558
|
+
/** 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. */
|
|
10559
|
+
key?: string;
|
|
10560
|
+
/** OAuth 2.0 token for the current user. */
|
|
10561
|
+
oauth_token?: string;
|
|
10562
|
+
/** Returns response with indentations and line breaks. */
|
|
10563
|
+
prettyPrint?: boolean;
|
|
10564
|
+
/** 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. */
|
|
10565
|
+
quotaUser?: string;
|
|
10566
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
10567
|
+
upload_protocol?: string;
|
|
10568
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
10569
|
+
uploadType?: string;
|
|
10570
|
+
},
|
|
10571
|
+
body: GoogleCloudAiplatformV1StreamRawPredictRequest
|
|
10572
|
+
): Request<GoogleApiHttpBody>;
|
|
10444
10573
|
/** Undeploys a Model from an Endpoint, removing a DeployedModel from it, and freeing all resources it's using. */
|
|
10445
10574
|
undeployModel(request: {
|
|
10446
10575
|
/** V1 error format. */
|
|
@@ -11832,7 +11961,7 @@ declare namespace gapi.client {
|
|
|
11832
11961
|
key?: string;
|
|
11833
11962
|
/** OAuth 2.0 token for the current user. */
|
|
11834
11963
|
oauth_token?: string;
|
|
11835
|
-
/** Required. The resource name of the Location to create FeatureOnlineStores. Format: `projects/{project}/locations/{location}
|
|
11964
|
+
/** Required. The resource name of the Location to create FeatureOnlineStores. Format: `projects/{project}/locations/{location}` */
|
|
11836
11965
|
parent: string;
|
|
11837
11966
|
/** Returns response with indentations and line breaks. */
|
|
11838
11967
|
prettyPrint?: boolean;
|
|
@@ -11863,7 +11992,7 @@ declare namespace gapi.client {
|
|
|
11863
11992
|
key?: string;
|
|
11864
11993
|
/** OAuth 2.0 token for the current user. */
|
|
11865
11994
|
oauth_token?: string;
|
|
11866
|
-
/** Required. The resource name of the Location to create FeatureOnlineStores. Format: `projects/{project}/locations/{location}
|
|
11995
|
+
/** Required. The resource name of the Location to create FeatureOnlineStores. Format: `projects/{project}/locations/{location}` */
|
|
11867
11996
|
parent: string;
|
|
11868
11997
|
/** Returns response with indentations and line breaks. */
|
|
11869
11998
|
prettyPrint?: boolean;
|
|
@@ -20283,6 +20412,8 @@ declare namespace gapi.client {
|
|
|
20283
20412
|
parent: string;
|
|
20284
20413
|
/** The ID to use for the PipelineJob, which will become the final component of the PipelineJob name. If not provided, an ID will be automatically generated. This value should be less than 128 characters, and valid characters are `/a-z-/`. */
|
|
20285
20414
|
pipelineJobId?: string;
|
|
20415
|
+
/** Optional. Whether to do component level validations before job creation. Currently we only support Google First Party Component/Pipelines. */
|
|
20416
|
+
preflightValidations?: boolean;
|
|
20286
20417
|
/** Returns response with indentations and line breaks. */
|
|
20287
20418
|
prettyPrint?: boolean;
|
|
20288
20419
|
/** 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. */
|
|
@@ -20314,6 +20445,8 @@ declare namespace gapi.client {
|
|
|
20314
20445
|
parent: string;
|
|
20315
20446
|
/** The ID to use for the PipelineJob, which will become the final component of the PipelineJob name. If not provided, an ID will be automatically generated. This value should be less than 128 characters, and valid characters are `/a-z-/`. */
|
|
20316
20447
|
pipelineJobId?: string;
|
|
20448
|
+
/** Optional. Whether to do component level validations before job creation. Currently we only support Google First Party Component/Pipelines. */
|
|
20449
|
+
preflightValidations?: boolean;
|
|
20317
20450
|
/** Returns response with indentations and line breaks. */
|
|
20318
20451
|
prettyPrint?: boolean;
|
|
20319
20452
|
/** 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. */
|
|
@@ -20767,6 +20900,63 @@ declare namespace gapi.client {
|
|
|
20767
20900
|
},
|
|
20768
20901
|
body: GoogleCloudAiplatformV1GenerateContentRequest
|
|
20769
20902
|
): Request<GoogleCloudAiplatformV1GenerateContentResponse>;
|
|
20903
|
+
streamRawPredict(request: {
|
|
20904
|
+
/** V1 error format. */
|
|
20905
|
+
'$.xgafv'?: string;
|
|
20906
|
+
/** OAuth access token. */
|
|
20907
|
+
access_token?: string;
|
|
20908
|
+
/** Data format for response. */
|
|
20909
|
+
alt?: string;
|
|
20910
|
+
/** JSONP */
|
|
20911
|
+
callback?: string;
|
|
20912
|
+
/** Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` */
|
|
20913
|
+
endpoint: string;
|
|
20914
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
20915
|
+
fields?: string;
|
|
20916
|
+
/** 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. */
|
|
20917
|
+
key?: string;
|
|
20918
|
+
/** OAuth 2.0 token for the current user. */
|
|
20919
|
+
oauth_token?: string;
|
|
20920
|
+
/** Returns response with indentations and line breaks. */
|
|
20921
|
+
prettyPrint?: boolean;
|
|
20922
|
+
/** 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. */
|
|
20923
|
+
quotaUser?: string;
|
|
20924
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
20925
|
+
upload_protocol?: string;
|
|
20926
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
20927
|
+
uploadType?: string;
|
|
20928
|
+
/** Request body */
|
|
20929
|
+
resource: GoogleCloudAiplatformV1StreamRawPredictRequest;
|
|
20930
|
+
}): Request<GoogleApiHttpBody>;
|
|
20931
|
+
streamRawPredict(
|
|
20932
|
+
request: {
|
|
20933
|
+
/** V1 error format. */
|
|
20934
|
+
'$.xgafv'?: string;
|
|
20935
|
+
/** OAuth access token. */
|
|
20936
|
+
access_token?: string;
|
|
20937
|
+
/** Data format for response. */
|
|
20938
|
+
alt?: string;
|
|
20939
|
+
/** JSONP */
|
|
20940
|
+
callback?: string;
|
|
20941
|
+
/** Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` */
|
|
20942
|
+
endpoint: string;
|
|
20943
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
20944
|
+
fields?: string;
|
|
20945
|
+
/** 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. */
|
|
20946
|
+
key?: string;
|
|
20947
|
+
/** OAuth 2.0 token for the current user. */
|
|
20948
|
+
oauth_token?: string;
|
|
20949
|
+
/** Returns response with indentations and line breaks. */
|
|
20950
|
+
prettyPrint?: boolean;
|
|
20951
|
+
/** 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. */
|
|
20952
|
+
quotaUser?: string;
|
|
20953
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
20954
|
+
upload_protocol?: string;
|
|
20955
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
20956
|
+
uploadType?: string;
|
|
20957
|
+
},
|
|
20958
|
+
body: GoogleCloudAiplatformV1StreamRawPredictRequest
|
|
20959
|
+
): Request<GoogleApiHttpBody>;
|
|
20770
20960
|
}
|
|
20771
20961
|
interface PublishersResource {
|
|
20772
20962
|
models: ModelsResource;
|