@maxim_mazurok/gapi.client.aiplatform-v1 0.0.20250331 → 0.0.20250422
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 +381 -11
- package/package.json +1 -1
- package/readme.md +15 -0
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: 20250422
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -312,7 +312,7 @@ declare namespace gapi.client {
|
|
|
312
312
|
interface GoogleCloudAiplatformV1AutoraterConfig {
|
|
313
313
|
/** Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` */
|
|
314
314
|
autoraterModel?: string;
|
|
315
|
-
/** Optional. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. */
|
|
315
|
+
/** Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. */
|
|
316
316
|
flipEnabled?: boolean;
|
|
317
317
|
/** Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. */
|
|
318
318
|
samplingCount?: number;
|
|
@@ -2107,6 +2107,8 @@ declare namespace gapi.client {
|
|
|
2107
2107
|
timeSeriesDataPoints?: GoogleCloudAiplatformV1TimeSeriesDataPoint[];
|
|
2108
2108
|
}
|
|
2109
2109
|
interface GoogleCloudAiplatformV1Fact {
|
|
2110
|
+
/** If present, chunk properties. */
|
|
2111
|
+
chunk?: GoogleCloudAiplatformV1RagChunk;
|
|
2110
2112
|
/** Query that is used to retrieve this fact. */
|
|
2111
2113
|
query?: string;
|
|
2112
2114
|
/** If present, according to the underlying Vector DB and the selected metric type, the score can be either the distance or the similarity between the query and the fact and its range depends on the metric type. For example, if the metric type is COSINE_DISTANCE, it represents the distance between the query and the fact. The larger the distance, the less relevant the fact is to the query. The range is [0, 2], while 0 means the most relevant and 2 means the least relevant. */
|
|
@@ -2643,7 +2645,7 @@ declare namespace gapi.client {
|
|
|
2643
2645
|
version?: number;
|
|
2644
2646
|
}
|
|
2645
2647
|
interface GoogleCloudAiplatformV1FunctionCall {
|
|
2646
|
-
/** Optional.
|
|
2648
|
+
/** Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. */
|
|
2647
2649
|
args?: {[P in string]: any};
|
|
2648
2650
|
/** Required. The name of the function to call. Matches [FunctionDeclaration.name]. */
|
|
2649
2651
|
name?: string;
|
|
@@ -2675,7 +2677,7 @@ declare namespace gapi.client {
|
|
|
2675
2677
|
outputUriPrefix?: string;
|
|
2676
2678
|
}
|
|
2677
2679
|
interface GoogleCloudAiplatformV1GcsSource {
|
|
2678
|
-
/** Required. Google Cloud Storage URI(-s) to the input file(s). May contain wildcards. For more information on wildcards, see https://cloud.google.com/storage/docs/
|
|
2680
|
+
/** Required. Google Cloud Storage URI(-s) to the input file(s). May contain wildcards. For more information on wildcards, see https://cloud.google.com/storage/docs/wildcards. */
|
|
2679
2681
|
uris?: string[];
|
|
2680
2682
|
}
|
|
2681
2683
|
interface GoogleCloudAiplatformV1GenAiAdvancedFeaturesConfig {
|
|
@@ -2801,6 +2803,8 @@ declare namespace gapi.client {
|
|
|
2801
2803
|
stopSequences?: string[];
|
|
2802
2804
|
/** Optional. Controls the randomness of predictions. */
|
|
2803
2805
|
temperature?: number;
|
|
2806
|
+
/** Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. */
|
|
2807
|
+
thinkingConfig?: GoogleCloudAiplatformV1GenerationConfigThinkingConfig;
|
|
2804
2808
|
/** Optional. If specified, top-k sampling will be used. */
|
|
2805
2809
|
topK?: number;
|
|
2806
2810
|
/** Optional. If specified, nucleus sampling will be used. */
|
|
@@ -2817,9 +2821,13 @@ declare namespace gapi.client {
|
|
|
2817
2821
|
modelRoutingPreference?: string;
|
|
2818
2822
|
}
|
|
2819
2823
|
interface GoogleCloudAiplatformV1GenerationConfigRoutingConfigManualRoutingMode {
|
|
2820
|
-
/** The model name to use. Only the public LLM models are accepted.
|
|
2824
|
+
/** 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). */
|
|
2821
2825
|
modelName?: string;
|
|
2822
2826
|
}
|
|
2827
|
+
interface GoogleCloudAiplatformV1GenerationConfigThinkingConfig {
|
|
2828
|
+
/** Optional. Indicates the thinking budget in tokens. This is only applied when enable_thinking is true. */
|
|
2829
|
+
thinkingBudget?: number;
|
|
2830
|
+
}
|
|
2823
2831
|
interface GoogleCloudAiplatformV1GenericOperationMetadata {
|
|
2824
2832
|
/** Output only. Time when the operation was created. */
|
|
2825
2833
|
createTime?: string;
|
|
@@ -2877,6 +2885,8 @@ declare namespace gapi.client {
|
|
|
2877
2885
|
web?: GoogleCloudAiplatformV1GroundingChunkWeb;
|
|
2878
2886
|
}
|
|
2879
2887
|
interface GoogleCloudAiplatformV1GroundingChunkRetrievedContext {
|
|
2888
|
+
/** Additional context for the RAG retrieval result. This is only populated when using the RAG retrieval tool. */
|
|
2889
|
+
ragChunk?: GoogleCloudAiplatformV1RagChunk;
|
|
2880
2890
|
/** Text of the attribution. */
|
|
2881
2891
|
text?: string;
|
|
2882
2892
|
/** Title of the attribution. */
|
|
@@ -4201,8 +4211,6 @@ declare namespace gapi.client {
|
|
|
4201
4211
|
checkpointId?: string;
|
|
4202
4212
|
/** The epoch of the checkpoint. */
|
|
4203
4213
|
epoch?: string;
|
|
4204
|
-
/** Identifier. The resource name of the ModelVersionCheckpoint. Format: `projects/{project}/locations/{location}/models/{model}/versions/{version}/checkpoints/{checkpoint}` */
|
|
4205
|
-
name?: string;
|
|
4206
4214
|
/** The step of the checkpoint. */
|
|
4207
4215
|
step?: string;
|
|
4208
4216
|
}
|
|
@@ -4527,6 +4535,14 @@ declare namespace gapi.client {
|
|
|
4527
4535
|
/** Required. Duration is accurate to the second. In Notebook, Idle Timeout is accurate to minute so the range of idle_timeout (second) is: 10 * 60 ~ 1440 * 60. */
|
|
4528
4536
|
idleTimeout?: string;
|
|
4529
4537
|
}
|
|
4538
|
+
interface GoogleCloudAiplatformV1NotebookReservationAffinity {
|
|
4539
|
+
/** Required. Specifies the type of reservation from which this instance can consume resources: RESERVATION_ANY (default), RESERVATION_SPECIFIC, or RESERVATION_NONE. See Consuming reserved instances for examples. */
|
|
4540
|
+
consumeReservationType?: string;
|
|
4541
|
+
/** Optional. Corresponds to the label key of a reservation resource. To target a RESERVATION_SPECIFIC by name, use compute.googleapis.com/reservation-name as the key and specify the name of your reservation as its value. */
|
|
4542
|
+
key?: string;
|
|
4543
|
+
/** Optional. Corresponds to the label values of a reservation resource. This must be the full path name of Reservation. */
|
|
4544
|
+
values?: string[];
|
|
4545
|
+
}
|
|
4530
4546
|
interface GoogleCloudAiplatformV1NotebookRuntime {
|
|
4531
4547
|
/** Output only. Timestamp when this NotebookRuntime was created. */
|
|
4532
4548
|
createTime?: string;
|
|
@@ -4564,6 +4580,8 @@ declare namespace gapi.client {
|
|
|
4564
4580
|
notebookRuntimeType?: string;
|
|
4565
4581
|
/** Output only. The proxy endpoint used to access the NotebookRuntime. */
|
|
4566
4582
|
proxyUri?: string;
|
|
4583
|
+
/** Output only. Reservation Affinity of the notebook runtime. */
|
|
4584
|
+
reservationAffinity?: GoogleCloudAiplatformV1NotebookReservationAffinity;
|
|
4567
4585
|
/** Output only. The runtime (instance) state of the NotebookRuntime. */
|
|
4568
4586
|
runtimeState?: string;
|
|
4569
4587
|
/** Required. The user email of the NotebookRuntime. */
|
|
@@ -4614,6 +4632,8 @@ declare namespace gapi.client {
|
|
|
4614
4632
|
networkTags?: string[];
|
|
4615
4633
|
/** Optional. Immutable. The type of the notebook runtime template. */
|
|
4616
4634
|
notebookRuntimeType?: string;
|
|
4635
|
+
/** Optional. Reservation Affinity of the notebook runtime template. */
|
|
4636
|
+
reservationAffinity?: GoogleCloudAiplatformV1NotebookReservationAffinity;
|
|
4617
4637
|
/** Deprecated: This field is ignored and the "Vertex AI Notebook Service Account" (service-PROJECT_NUMBER@gcp-sa-aiplatform-vm.iam.gserviceaccount.com) is used for the runtime workload identity. See https://cloud.google.com/iam/docs/service-agents#vertex-ai-notebook-service-account for more details. For NotebookExecutionJob, use NotebookExecutionJob.service_account instead. The service account that the runtime workload runs as. You can use any service account within the same project, but you must have the service account user permission to use the instance. If not specified, the [Compute Engine default service account](https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used. */
|
|
4618
4638
|
serviceAccount?: string;
|
|
4619
4639
|
/** Optional. Immutable. Runtime Shielded VM spec. */
|
|
@@ -5072,7 +5092,7 @@ declare namespace gapi.client {
|
|
|
5072
5092
|
interface GoogleCloudAiplatformV1ProbeGrpcAction {
|
|
5073
5093
|
/** Port number of the gRPC service. Number must be in the range 1 to 65535. */
|
|
5074
5094
|
port?: number;
|
|
5075
|
-
/** Service is the name of the service to place in the gRPC HealthCheckRequest
|
|
5095
|
+
/** Service is the name of the service to place in the gRPC HealthCheckRequest. See https://github.com/grpc/grpc/blob/master/doc/health-checking.md. If this is not specified, the default behavior is defined by gRPC. */
|
|
5076
5096
|
service?: string;
|
|
5077
5097
|
}
|
|
5078
5098
|
interface GoogleCloudAiplatformV1ProbeHttpGetAction {
|
|
@@ -5447,11 +5467,25 @@ declare namespace gapi.client {
|
|
|
5447
5467
|
/** Optional. Which version to use for evaluation. */
|
|
5448
5468
|
version?: number;
|
|
5449
5469
|
}
|
|
5470
|
+
interface GoogleCloudAiplatformV1RagChunk {
|
|
5471
|
+
/** If populated, represents where the chunk starts and ends in the document. */
|
|
5472
|
+
pageSpan?: GoogleCloudAiplatformV1RagChunkPageSpan;
|
|
5473
|
+
/** The content of the chunk. */
|
|
5474
|
+
text?: string;
|
|
5475
|
+
}
|
|
5476
|
+
interface GoogleCloudAiplatformV1RagChunkPageSpan {
|
|
5477
|
+
/** Page where chunk starts in the document. Inclusive. 1-indexed. */
|
|
5478
|
+
firstPage?: number;
|
|
5479
|
+
/** Page where chunk ends in the document. Inclusive. 1-indexed. */
|
|
5480
|
+
lastPage?: number;
|
|
5481
|
+
}
|
|
5450
5482
|
interface GoogleCloudAiplatformV1RagContexts {
|
|
5451
5483
|
/** All its contexts. */
|
|
5452
5484
|
contexts?: GoogleCloudAiplatformV1RagContextsContext[];
|
|
5453
5485
|
}
|
|
5454
5486
|
interface GoogleCloudAiplatformV1RagContextsContext {
|
|
5487
|
+
/** Context of the retrieved chunk. */
|
|
5488
|
+
chunk?: GoogleCloudAiplatformV1RagChunk;
|
|
5455
5489
|
/** According to the underlying Vector DB and the selected metric type, the score can be either the distance or the similarity between the query and the context and its range depends on the metric type. For example, if the metric type is COSINE_DISTANCE, it represents the distance between the query and the context. The larger the distance, the less relevant the context is to the query. The range is [0, 2], while 0 means the most relevant and 2 means the least relevant. */
|
|
5456
5490
|
score?: number;
|
|
5457
5491
|
/** The file display name. */
|
|
@@ -5570,7 +5604,7 @@ declare namespace gapi.client {
|
|
|
5570
5604
|
rankService?: GoogleCloudAiplatformV1RagRetrievalConfigRankingRankService;
|
|
5571
5605
|
}
|
|
5572
5606
|
interface GoogleCloudAiplatformV1RagRetrievalConfigRankingLlmRanker {
|
|
5573
|
-
/** Optional. The model name used for ranking.
|
|
5607
|
+
/** Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). */
|
|
5574
5608
|
modelName?: string;
|
|
5575
5609
|
}
|
|
5576
5610
|
interface GoogleCloudAiplatformV1RagRetrievalConfigRankingRankService {
|
|
@@ -5717,7 +5751,7 @@ declare namespace gapi.client {
|
|
|
5717
5751
|
updateTime?: string;
|
|
5718
5752
|
}
|
|
5719
5753
|
interface GoogleCloudAiplatformV1ReasoningEngineSpec {
|
|
5720
|
-
/** Optional. The OSS agent framework used to develop the agent. Currently supported values: "langchain", "langgraph", "ag2", "custom". */
|
|
5754
|
+
/** Optional. The OSS agent framework used to develop the agent. Currently supported values: "google-adk", "langchain", "langgraph", "ag2", "llama-index", "custom". */
|
|
5721
5755
|
agentFramework?: string;
|
|
5722
5756
|
/** Optional. Declarations for object class methods in OpenAPI specification format. */
|
|
5723
5757
|
classMethods?: Array<{[P in string]: any}>;
|
|
@@ -7720,6 +7754,8 @@ declare namespace gapi.client {
|
|
|
7720
7754
|
ngramSize?: number;
|
|
7721
7755
|
}
|
|
7722
7756
|
interface GoogleCloudAiplatformV1SpeechConfig {
|
|
7757
|
+
/** Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. */
|
|
7758
|
+
languageCode?: string;
|
|
7723
7759
|
/** The configuration for the speaker to use. */
|
|
7724
7760
|
voiceConfig?: GoogleCloudAiplatformV1VoiceConfig;
|
|
7725
7761
|
}
|
|
@@ -8658,7 +8694,7 @@ declare namespace gapi.client {
|
|
|
8658
8694
|
supervisedTuningDataStats?: GoogleCloudAiplatformV1SupervisedTuningDataStats;
|
|
8659
8695
|
}
|
|
8660
8696
|
interface GoogleCloudAiplatformV1TuningJob {
|
|
8661
|
-
/** The base model that is being tuned
|
|
8697
|
+
/** The base model that is being tuned. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/tuning#supported_models). */
|
|
8662
8698
|
baseModel?: string;
|
|
8663
8699
|
/** Output only. Time when the TuningJob was created. */
|
|
8664
8700
|
createTime?: string;
|
|
@@ -9048,6 +9084,128 @@ declare namespace gapi.client {
|
|
|
9048
9084
|
/** The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. */
|
|
9049
9085
|
units?: string;
|
|
9050
9086
|
}
|
|
9087
|
+
interface BatchPredictionJobsResource {
|
|
9088
|
+
/** Creates a BatchPredictionJob. A BatchPredictionJob once created will right away be attempted to start. */
|
|
9089
|
+
create(request: {
|
|
9090
|
+
/** V1 error format. */
|
|
9091
|
+
'$.xgafv'?: string;
|
|
9092
|
+
/** OAuth access token. */
|
|
9093
|
+
access_token?: string;
|
|
9094
|
+
/** Data format for response. */
|
|
9095
|
+
alt?: string;
|
|
9096
|
+
/** JSONP */
|
|
9097
|
+
callback?: string;
|
|
9098
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
9099
|
+
fields?: string;
|
|
9100
|
+
/** 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. */
|
|
9101
|
+
key?: string;
|
|
9102
|
+
/** OAuth 2.0 token for the current user. */
|
|
9103
|
+
oauth_token?: string;
|
|
9104
|
+
/** Required. The resource name of the Location to create the BatchPredictionJob in. Format: `projects/{project}/locations/{location}` */
|
|
9105
|
+
parent?: string;
|
|
9106
|
+
/** Returns response with indentations and line breaks. */
|
|
9107
|
+
prettyPrint?: boolean;
|
|
9108
|
+
/** 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. */
|
|
9109
|
+
quotaUser?: string;
|
|
9110
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
9111
|
+
upload_protocol?: string;
|
|
9112
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
9113
|
+
uploadType?: string;
|
|
9114
|
+
/** Request body */
|
|
9115
|
+
resource: GoogleCloudAiplatformV1BatchPredictionJob;
|
|
9116
|
+
}): Request<GoogleCloudAiplatformV1BatchPredictionJob>;
|
|
9117
|
+
create(
|
|
9118
|
+
request: {
|
|
9119
|
+
/** V1 error format. */
|
|
9120
|
+
'$.xgafv'?: string;
|
|
9121
|
+
/** OAuth access token. */
|
|
9122
|
+
access_token?: string;
|
|
9123
|
+
/** Data format for response. */
|
|
9124
|
+
alt?: string;
|
|
9125
|
+
/** JSONP */
|
|
9126
|
+
callback?: string;
|
|
9127
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
9128
|
+
fields?: string;
|
|
9129
|
+
/** 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. */
|
|
9130
|
+
key?: string;
|
|
9131
|
+
/** OAuth 2.0 token for the current user. */
|
|
9132
|
+
oauth_token?: string;
|
|
9133
|
+
/** Required. The resource name of the Location to create the BatchPredictionJob in. Format: `projects/{project}/locations/{location}` */
|
|
9134
|
+
parent?: string;
|
|
9135
|
+
/** Returns response with indentations and line breaks. */
|
|
9136
|
+
prettyPrint?: boolean;
|
|
9137
|
+
/** 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. */
|
|
9138
|
+
quotaUser?: string;
|
|
9139
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
9140
|
+
upload_protocol?: string;
|
|
9141
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
9142
|
+
uploadType?: string;
|
|
9143
|
+
},
|
|
9144
|
+
body: GoogleCloudAiplatformV1BatchPredictionJob,
|
|
9145
|
+
): Request<GoogleCloudAiplatformV1BatchPredictionJob>;
|
|
9146
|
+
/** Gets a BatchPredictionJob */
|
|
9147
|
+
get(request?: {
|
|
9148
|
+
/** V1 error format. */
|
|
9149
|
+
'$.xgafv'?: string;
|
|
9150
|
+
/** OAuth access token. */
|
|
9151
|
+
access_token?: string;
|
|
9152
|
+
/** Data format for response. */
|
|
9153
|
+
alt?: string;
|
|
9154
|
+
/** JSONP */
|
|
9155
|
+
callback?: string;
|
|
9156
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
9157
|
+
fields?: string;
|
|
9158
|
+
/** 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. */
|
|
9159
|
+
key?: string;
|
|
9160
|
+
/** Required. The name of the BatchPredictionJob resource. Format: `projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}` */
|
|
9161
|
+
name: string;
|
|
9162
|
+
/** OAuth 2.0 token for the current user. */
|
|
9163
|
+
oauth_token?: string;
|
|
9164
|
+
/** Returns response with indentations and line breaks. */
|
|
9165
|
+
prettyPrint?: boolean;
|
|
9166
|
+
/** 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. */
|
|
9167
|
+
quotaUser?: string;
|
|
9168
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
9169
|
+
upload_protocol?: string;
|
|
9170
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
9171
|
+
uploadType?: string;
|
|
9172
|
+
}): Request<GoogleCloudAiplatformV1BatchPredictionJob>;
|
|
9173
|
+
/** Lists BatchPredictionJobs in a Location. */
|
|
9174
|
+
list(request?: {
|
|
9175
|
+
/** V1 error format. */
|
|
9176
|
+
'$.xgafv'?: string;
|
|
9177
|
+
/** OAuth access token. */
|
|
9178
|
+
access_token?: string;
|
|
9179
|
+
/** Data format for response. */
|
|
9180
|
+
alt?: string;
|
|
9181
|
+
/** JSONP */
|
|
9182
|
+
callback?: string;
|
|
9183
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
9184
|
+
fields?: string;
|
|
9185
|
+
/** The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `model_display_name` supports `=`, `!=` comparisons. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"` * `state!="JOB_STATE_FAILED" OR display_name="my_job"` * `NOT display_name="my_job"` * `create_time>"2021-05-18T00:00:00Z"` * `labels.keyA=valueA` * `labels.keyB:*` */
|
|
9186
|
+
filter?: string;
|
|
9187
|
+
/** 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. */
|
|
9188
|
+
key?: string;
|
|
9189
|
+
/** OAuth 2.0 token for the current user. */
|
|
9190
|
+
oauth_token?: string;
|
|
9191
|
+
/** The standard list page size. */
|
|
9192
|
+
pageSize?: number;
|
|
9193
|
+
/** The standard list page token. Typically obtained via ListBatchPredictionJobsResponse.next_page_token of the previous JobService.ListBatchPredictionJobs call. */
|
|
9194
|
+
pageToken?: string;
|
|
9195
|
+
/** Required. The resource name of the Location to list the BatchPredictionJobs from. Format: `projects/{project}/locations/{location}` */
|
|
9196
|
+
parent?: string;
|
|
9197
|
+
/** Returns response with indentations and line breaks. */
|
|
9198
|
+
prettyPrint?: boolean;
|
|
9199
|
+
/** 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. */
|
|
9200
|
+
quotaUser?: string;
|
|
9201
|
+
/** Mask specifying which fields to read. */
|
|
9202
|
+
readMask?: string;
|
|
9203
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
9204
|
+
upload_protocol?: string;
|
|
9205
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
9206
|
+
uploadType?: string;
|
|
9207
|
+
}): Request<GoogleCloudAiplatformV1ListBatchPredictionJobsResponse>;
|
|
9208
|
+
}
|
|
9051
9209
|
interface DatasetVersionsResource {
|
|
9052
9210
|
/** Create a version from a Dataset. */
|
|
9053
9211
|
create(request: {
|
|
@@ -9506,6 +9664,66 @@ declare namespace gapi.client {
|
|
|
9506
9664
|
): Request<GoogleCloudAiplatformV1Dataset>;
|
|
9507
9665
|
datasetVersions: DatasetVersionsResource;
|
|
9508
9666
|
}
|
|
9667
|
+
interface ChatResource {
|
|
9668
|
+
/** Exposes an OpenAI-compatible endpoint for chat completions. */
|
|
9669
|
+
completions(request: {
|
|
9670
|
+
/** V1 error format. */
|
|
9671
|
+
'$.xgafv'?: string;
|
|
9672
|
+
/** OAuth access token. */
|
|
9673
|
+
access_token?: string;
|
|
9674
|
+
/** Data format for response. */
|
|
9675
|
+
alt?: string;
|
|
9676
|
+
/** JSONP */
|
|
9677
|
+
callback?: string;
|
|
9678
|
+
/** Required. The name of the endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` */
|
|
9679
|
+
endpoint: string;
|
|
9680
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
9681
|
+
fields?: string;
|
|
9682
|
+
/** 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. */
|
|
9683
|
+
key?: string;
|
|
9684
|
+
/** OAuth 2.0 token for the current user. */
|
|
9685
|
+
oauth_token?: string;
|
|
9686
|
+
/** Returns response with indentations and line breaks. */
|
|
9687
|
+
prettyPrint?: boolean;
|
|
9688
|
+
/** 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. */
|
|
9689
|
+
quotaUser?: string;
|
|
9690
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
9691
|
+
upload_protocol?: string;
|
|
9692
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
9693
|
+
uploadType?: string;
|
|
9694
|
+
/** Request body */
|
|
9695
|
+
resource: GoogleApiHttpBody;
|
|
9696
|
+
}): Request<GoogleApiHttpBody>;
|
|
9697
|
+
completions(
|
|
9698
|
+
request: {
|
|
9699
|
+
/** V1 error format. */
|
|
9700
|
+
'$.xgafv'?: string;
|
|
9701
|
+
/** OAuth access token. */
|
|
9702
|
+
access_token?: string;
|
|
9703
|
+
/** Data format for response. */
|
|
9704
|
+
alt?: string;
|
|
9705
|
+
/** JSONP */
|
|
9706
|
+
callback?: string;
|
|
9707
|
+
/** Required. The name of the endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` */
|
|
9708
|
+
endpoint: string;
|
|
9709
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
9710
|
+
fields?: string;
|
|
9711
|
+
/** 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. */
|
|
9712
|
+
key?: string;
|
|
9713
|
+
/** OAuth 2.0 token for the current user. */
|
|
9714
|
+
oauth_token?: string;
|
|
9715
|
+
/** Returns response with indentations and line breaks. */
|
|
9716
|
+
prettyPrint?: boolean;
|
|
9717
|
+
/** 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. */
|
|
9718
|
+
quotaUser?: string;
|
|
9719
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
9720
|
+
upload_protocol?: string;
|
|
9721
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
9722
|
+
uploadType?: string;
|
|
9723
|
+
},
|
|
9724
|
+
body: GoogleApiHttpBody,
|
|
9725
|
+
): Request<GoogleApiHttpBody>;
|
|
9726
|
+
}
|
|
9509
9727
|
interface EndpointsResource {
|
|
9510
9728
|
/** Return a list of tokens based on the input text. */
|
|
9511
9729
|
computeTokens(request: {
|
|
@@ -9797,6 +10015,7 @@ declare namespace gapi.client {
|
|
|
9797
10015
|
},
|
|
9798
10016
|
body: GoogleCloudAiplatformV1GenerateContentRequest,
|
|
9799
10017
|
): Request<GoogleCloudAiplatformV1GenerateContentResponse>;
|
|
10018
|
+
chat: ChatResource;
|
|
9800
10019
|
}
|
|
9801
10020
|
interface MediaResource {
|
|
9802
10021
|
/** Upload a file into a RagCorpus. */
|
|
@@ -27343,6 +27562,154 @@ declare namespace gapi.client {
|
|
|
27343
27562
|
uploadType?: string;
|
|
27344
27563
|
}): Request<GoogleLongrunningOperation>;
|
|
27345
27564
|
}
|
|
27565
|
+
interface RagEngineConfigResource {
|
|
27566
|
+
operations: OperationsResource;
|
|
27567
|
+
}
|
|
27568
|
+
interface OperationsResource {
|
|
27569
|
+
/** Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. */
|
|
27570
|
+
cancel(request?: {
|
|
27571
|
+
/** V1 error format. */
|
|
27572
|
+
'$.xgafv'?: string;
|
|
27573
|
+
/** OAuth access token. */
|
|
27574
|
+
access_token?: string;
|
|
27575
|
+
/** Data format for response. */
|
|
27576
|
+
alt?: string;
|
|
27577
|
+
/** JSONP */
|
|
27578
|
+
callback?: string;
|
|
27579
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
27580
|
+
fields?: string;
|
|
27581
|
+
/** 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. */
|
|
27582
|
+
key?: string;
|
|
27583
|
+
/** The name of the operation resource to be cancelled. */
|
|
27584
|
+
name: string;
|
|
27585
|
+
/** OAuth 2.0 token for the current user. */
|
|
27586
|
+
oauth_token?: string;
|
|
27587
|
+
/** Returns response with indentations and line breaks. */
|
|
27588
|
+
prettyPrint?: boolean;
|
|
27589
|
+
/** 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. */
|
|
27590
|
+
quotaUser?: string;
|
|
27591
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
27592
|
+
upload_protocol?: string;
|
|
27593
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
27594
|
+
uploadType?: string;
|
|
27595
|
+
}): Request<{}>;
|
|
27596
|
+
/** Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. */
|
|
27597
|
+
delete(request?: {
|
|
27598
|
+
/** V1 error format. */
|
|
27599
|
+
'$.xgafv'?: string;
|
|
27600
|
+
/** OAuth access token. */
|
|
27601
|
+
access_token?: string;
|
|
27602
|
+
/** Data format for response. */
|
|
27603
|
+
alt?: string;
|
|
27604
|
+
/** JSONP */
|
|
27605
|
+
callback?: string;
|
|
27606
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
27607
|
+
fields?: string;
|
|
27608
|
+
/** 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. */
|
|
27609
|
+
key?: string;
|
|
27610
|
+
/** The name of the operation resource to be deleted. */
|
|
27611
|
+
name: string;
|
|
27612
|
+
/** OAuth 2.0 token for the current user. */
|
|
27613
|
+
oauth_token?: string;
|
|
27614
|
+
/** Returns response with indentations and line breaks. */
|
|
27615
|
+
prettyPrint?: boolean;
|
|
27616
|
+
/** 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. */
|
|
27617
|
+
quotaUser?: string;
|
|
27618
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
27619
|
+
upload_protocol?: string;
|
|
27620
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
27621
|
+
uploadType?: string;
|
|
27622
|
+
}): Request<{}>;
|
|
27623
|
+
/** Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. */
|
|
27624
|
+
get(request?: {
|
|
27625
|
+
/** V1 error format. */
|
|
27626
|
+
'$.xgafv'?: string;
|
|
27627
|
+
/** OAuth access token. */
|
|
27628
|
+
access_token?: string;
|
|
27629
|
+
/** Data format for response. */
|
|
27630
|
+
alt?: string;
|
|
27631
|
+
/** JSONP */
|
|
27632
|
+
callback?: string;
|
|
27633
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
27634
|
+
fields?: string;
|
|
27635
|
+
/** 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. */
|
|
27636
|
+
key?: string;
|
|
27637
|
+
/** The name of the operation resource. */
|
|
27638
|
+
name: string;
|
|
27639
|
+
/** OAuth 2.0 token for the current user. */
|
|
27640
|
+
oauth_token?: string;
|
|
27641
|
+
/** Returns response with indentations and line breaks. */
|
|
27642
|
+
prettyPrint?: boolean;
|
|
27643
|
+
/** 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. */
|
|
27644
|
+
quotaUser?: string;
|
|
27645
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
27646
|
+
upload_protocol?: string;
|
|
27647
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
27648
|
+
uploadType?: string;
|
|
27649
|
+
}): Request<GoogleLongrunningOperation>;
|
|
27650
|
+
/** Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. */
|
|
27651
|
+
list(request?: {
|
|
27652
|
+
/** V1 error format. */
|
|
27653
|
+
'$.xgafv'?: string;
|
|
27654
|
+
/** OAuth access token. */
|
|
27655
|
+
access_token?: string;
|
|
27656
|
+
/** Data format for response. */
|
|
27657
|
+
alt?: string;
|
|
27658
|
+
/** JSONP */
|
|
27659
|
+
callback?: string;
|
|
27660
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
27661
|
+
fields?: string;
|
|
27662
|
+
/** The standard list filter. */
|
|
27663
|
+
filter?: string;
|
|
27664
|
+
/** 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. */
|
|
27665
|
+
key?: string;
|
|
27666
|
+
/** The name of the operation's parent resource. */
|
|
27667
|
+
name: string;
|
|
27668
|
+
/** OAuth 2.0 token for the current user. */
|
|
27669
|
+
oauth_token?: string;
|
|
27670
|
+
/** The standard list page size. */
|
|
27671
|
+
pageSize?: number;
|
|
27672
|
+
/** The standard list page token. */
|
|
27673
|
+
pageToken?: string;
|
|
27674
|
+
/** Returns response with indentations and line breaks. */
|
|
27675
|
+
prettyPrint?: boolean;
|
|
27676
|
+
/** 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. */
|
|
27677
|
+
quotaUser?: string;
|
|
27678
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
27679
|
+
upload_protocol?: string;
|
|
27680
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
27681
|
+
uploadType?: string;
|
|
27682
|
+
}): Request<GoogleLongrunningListOperationsResponse>;
|
|
27683
|
+
/** Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. */
|
|
27684
|
+
wait(request?: {
|
|
27685
|
+
/** V1 error format. */
|
|
27686
|
+
'$.xgafv'?: string;
|
|
27687
|
+
/** OAuth access token. */
|
|
27688
|
+
access_token?: string;
|
|
27689
|
+
/** Data format for response. */
|
|
27690
|
+
alt?: string;
|
|
27691
|
+
/** JSONP */
|
|
27692
|
+
callback?: string;
|
|
27693
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
27694
|
+
fields?: string;
|
|
27695
|
+
/** 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. */
|
|
27696
|
+
key?: string;
|
|
27697
|
+
/** The name of the operation resource to wait on. */
|
|
27698
|
+
name: string;
|
|
27699
|
+
/** OAuth 2.0 token for the current user. */
|
|
27700
|
+
oauth_token?: string;
|
|
27701
|
+
/** Returns response with indentations and line breaks. */
|
|
27702
|
+
prettyPrint?: boolean;
|
|
27703
|
+
/** 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. */
|
|
27704
|
+
quotaUser?: string;
|
|
27705
|
+
/** The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. */
|
|
27706
|
+
timeout?: string;
|
|
27707
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
27708
|
+
upload_protocol?: string;
|
|
27709
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
27710
|
+
uploadType?: string;
|
|
27711
|
+
}): Request<GoogleLongrunningOperation>;
|
|
27712
|
+
}
|
|
27346
27713
|
interface ReasoningEnginesResource {
|
|
27347
27714
|
/** Creates a reasoning engine. */
|
|
27348
27715
|
create(request: {
|
|
@@ -32459,6 +32826,7 @@ declare namespace gapi.client {
|
|
|
32459
32826
|
pipelineJobs: PipelineJobsResource;
|
|
32460
32827
|
publishers: PublishersResource;
|
|
32461
32828
|
ragCorpora: RagCorporaResource;
|
|
32829
|
+
ragEngineConfig: RagEngineConfigResource;
|
|
32462
32830
|
reasoningEngines: ReasoningEnginesResource;
|
|
32463
32831
|
schedules: SchedulesResource;
|
|
32464
32832
|
specialistPools: SpecialistPoolsResource;
|
|
@@ -32886,6 +33254,8 @@ declare namespace gapi.client {
|
|
|
32886
33254
|
models: ModelsResource;
|
|
32887
33255
|
}
|
|
32888
33256
|
|
|
33257
|
+
const batchPredictionJobs: BatchPredictionJobsResource;
|
|
33258
|
+
|
|
32889
33259
|
const datasets: DatasetsResource;
|
|
32890
33260
|
|
|
32891
33261
|
const endpoints: EndpointsResource;
|
package/package.json
CHANGED
package/readme.md
CHANGED
|
@@ -72,6 +72,21 @@ gapi.auth.authorize(
|
|
|
72
72
|
After that you can use Vertex AI API resources: <!-- TODO: make this work for multiple namespaces -->
|
|
73
73
|
|
|
74
74
|
```typescript
|
|
75
|
+
/*
|
|
76
|
+
Creates a BatchPredictionJob. A BatchPredictionJob once created will right away be attempted to start.
|
|
77
|
+
*/
|
|
78
|
+
await gapi.client.aiplatform.batchPredictionJobs.create({});
|
|
79
|
+
|
|
80
|
+
/*
|
|
81
|
+
Gets a BatchPredictionJob
|
|
82
|
+
*/
|
|
83
|
+
await gapi.client.aiplatform.batchPredictionJobs.get({name: 'name'});
|
|
84
|
+
|
|
85
|
+
/*
|
|
86
|
+
Lists BatchPredictionJobs in a Location.
|
|
87
|
+
*/
|
|
88
|
+
await gapi.client.aiplatform.batchPredictionJobs.list({});
|
|
89
|
+
|
|
75
90
|
/*
|
|
76
91
|
Creates a Dataset.
|
|
77
92
|
*/
|