@maxim_mazurok/gapi.client.aiplatform-v1beta1 0.0.20240429 → 0.0.20240501
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 +594 -6
- package/package.json +1 -1
- package/readme.md +5 -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=v1beta1
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20240501
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -1065,6 +1065,14 @@ declare namespace gapi.client {
|
|
|
1065
1065
|
/** The operation generic information. */
|
|
1066
1066
|
genericMetadata?: GoogleCloudAiplatformV1beta1GenericOperationMetadata;
|
|
1067
1067
|
}
|
|
1068
|
+
interface GoogleCloudAiplatformV1beta1CreateNotebookExecutionJobRequest {
|
|
1069
|
+
/** Required. The NotebookExecutionJob to create. */
|
|
1070
|
+
notebookExecutionJob?: GoogleCloudAiplatformV1beta1NotebookExecutionJob;
|
|
1071
|
+
/** Optional. User specified ID for the NotebookExecutionJob. */
|
|
1072
|
+
notebookExecutionJobId?: string;
|
|
1073
|
+
/** Required. The resource name of the Location to create the NotebookExecutionJob. Format: `projects/{project}/locations/{location}` */
|
|
1074
|
+
parent?: string;
|
|
1075
|
+
}
|
|
1068
1076
|
interface GoogleCloudAiplatformV1beta1CreateNotebookRuntimeTemplateOperationMetadata {
|
|
1069
1077
|
/** The operation generic information. */
|
|
1070
1078
|
genericMetadata?: GoogleCloudAiplatformV1beta1GenericOperationMetadata;
|
|
@@ -1491,6 +1499,7 @@ declare namespace gapi.client {
|
|
|
1491
1499
|
/** The prediction output. */
|
|
1492
1500
|
output?: string;
|
|
1493
1501
|
}
|
|
1502
|
+
interface GoogleCloudAiplatformV1beta1DirectUploadSource {}
|
|
1494
1503
|
interface GoogleCloudAiplatformV1beta1DiskSpec {
|
|
1495
1504
|
/** Size in GB of the boot disk (default is 100GB). */
|
|
1496
1505
|
bootDiskSizeGb?: number;
|
|
@@ -2510,6 +2519,12 @@ declare namespace gapi.client {
|
|
|
2510
2519
|
neighborCount?: number;
|
|
2511
2520
|
/** Crowding is a constraint on a neighbor list produced by nearest neighbor search requiring that no more than some value k' of the k neighbors returned have the same value of crowding_attribute. It's used for improving result diversity. This field is the maximum number of matches with the same crowding tag. */
|
|
2512
2521
|
perCrowdingAttributeNeighborCount?: number;
|
|
2522
|
+
/** Optional. Represents RRF algorithm that combines search results. */
|
|
2523
|
+
rrf?: GoogleCloudAiplatformV1beta1FindNeighborsRequestQueryRRF;
|
|
2524
|
+
}
|
|
2525
|
+
interface GoogleCloudAiplatformV1beta1FindNeighborsRequestQueryRRF {
|
|
2526
|
+
/** Required. Users can provide an alpha value to give more weight to dense vs sparse results. For example, if the alpha is 0, we only return sparse and if the alpha is 1, we only return dense. */
|
|
2527
|
+
alpha?: number;
|
|
2513
2528
|
}
|
|
2514
2529
|
interface GoogleCloudAiplatformV1beta1FindNeighborsResponse {
|
|
2515
2530
|
/** The nearest neighbors of the query datapoints. */
|
|
@@ -2526,6 +2541,8 @@ declare namespace gapi.client {
|
|
|
2526
2541
|
datapoint?: GoogleCloudAiplatformV1beta1IndexDatapoint;
|
|
2527
2542
|
/** The distance between the neighbor and the dense embedding query. */
|
|
2528
2543
|
distance?: number;
|
|
2544
|
+
/** The distance between the neighbor and the query sparse_embedding. */
|
|
2545
|
+
sparseDistance?: number;
|
|
2529
2546
|
}
|
|
2530
2547
|
interface GoogleCloudAiplatformV1beta1FluencyInput {
|
|
2531
2548
|
/** Required. Fluency instance. */
|
|
@@ -2700,6 +2717,16 @@ declare namespace gapi.client {
|
|
|
2700
2717
|
/** Required. The public base model URI. */
|
|
2701
2718
|
baseModelUri?: string;
|
|
2702
2719
|
}
|
|
2720
|
+
interface GoogleCloudAiplatformV1beta1GoogleDriveSource {
|
|
2721
|
+
/** Required. Google Drive resource IDs. */
|
|
2722
|
+
resourceIds?: GoogleCloudAiplatformV1beta1GoogleDriveSourceResourceId[];
|
|
2723
|
+
}
|
|
2724
|
+
interface GoogleCloudAiplatformV1beta1GoogleDriveSourceResourceId {
|
|
2725
|
+
/** Required. The ID of the Google Drive resource. */
|
|
2726
|
+
resourceId?: string;
|
|
2727
|
+
/** Required. The type of the Google Drive resource. */
|
|
2728
|
+
resourceType?: string;
|
|
2729
|
+
}
|
|
2703
2730
|
interface GoogleCloudAiplatformV1beta1GroundednessInput {
|
|
2704
2731
|
/** Required. Groundedness instance. */
|
|
2705
2732
|
instance?: GoogleCloudAiplatformV1beta1GroundednessInstance;
|
|
@@ -2848,6 +2875,18 @@ declare namespace gapi.client {
|
|
|
2848
2875
|
/** Required. Model evaluation resource to be imported. */
|
|
2849
2876
|
modelEvaluation?: GoogleCloudAiplatformV1beta1ModelEvaluation;
|
|
2850
2877
|
}
|
|
2878
|
+
interface GoogleCloudAiplatformV1beta1ImportRagFilesConfig {
|
|
2879
|
+
/** Google Cloud Storage location. Supports importing individual files as well as entire Google Cloud Storage directories. Sample formats: - `gs://bucket_name/my_directory/object_name/my_file.txt` - `gs://bucket_name/my_directory` */
|
|
2880
|
+
gcsSource?: GoogleCloudAiplatformV1beta1GcsSource;
|
|
2881
|
+
/** Google Drive location. Supports importing individual files as well as Google Drive folders. */
|
|
2882
|
+
googleDriveSource?: GoogleCloudAiplatformV1beta1GoogleDriveSource;
|
|
2883
|
+
/** Specifies the size and overlap of chunks after importing RagFiles. */
|
|
2884
|
+
ragFileChunkingConfig?: GoogleCloudAiplatformV1beta1RagFileChunkingConfig;
|
|
2885
|
+
}
|
|
2886
|
+
interface GoogleCloudAiplatformV1beta1ImportRagFilesRequest {
|
|
2887
|
+
/** Required. The config for the RagFiles to be synced and imported into the RagCorpus. VertexRagDataService.ImportRagFiles. */
|
|
2888
|
+
importRagFilesConfig?: GoogleCloudAiplatformV1beta1ImportRagFilesConfig;
|
|
2889
|
+
}
|
|
2851
2890
|
interface GoogleCloudAiplatformV1beta1Index {
|
|
2852
2891
|
/** Output only. Timestamp when this Index was created. */
|
|
2853
2892
|
createTime?: string;
|
|
@@ -2887,6 +2926,8 @@ declare namespace gapi.client {
|
|
|
2887
2926
|
numericRestricts?: GoogleCloudAiplatformV1beta1IndexDatapointNumericRestriction[];
|
|
2888
2927
|
/** Optional. List of Restrict of the datapoint, used to perform "restricted searches" where boolean rule are used to filter the subset of the database eligible for matching. This uses categorical tokens. See: https://cloud.google.com/vertex-ai/docs/matching-engine/filtering */
|
|
2889
2928
|
restricts?: GoogleCloudAiplatformV1beta1IndexDatapointRestriction[];
|
|
2929
|
+
/** Optional. Feature embedding vector for sparse index. */
|
|
2930
|
+
sparseEmbedding?: GoogleCloudAiplatformV1beta1IndexDatapointSparseEmbedding;
|
|
2890
2931
|
}
|
|
2891
2932
|
interface GoogleCloudAiplatformV1beta1IndexDatapointCrowdingTag {
|
|
2892
2933
|
/** The attribute value used for crowding. The maximum number of neighbors to return per crowding attribute value (per_crowding_attribute_num_neighbors) is configured per-query. This field is ignored if per_crowding_attribute_num_neighbors is larger than the total number of neighbors to return for a given query. */
|
|
@@ -2912,6 +2953,12 @@ declare namespace gapi.client {
|
|
|
2912
2953
|
/** The namespace of this restriction. e.g.: color. */
|
|
2913
2954
|
namespace?: string;
|
|
2914
2955
|
}
|
|
2956
|
+
interface GoogleCloudAiplatformV1beta1IndexDatapointSparseEmbedding {
|
|
2957
|
+
/** Optional. The list of indexes for the embedding values of the sparse vector. */
|
|
2958
|
+
dimensions?: string[];
|
|
2959
|
+
/** Optional. The list of embedding values of the sparse vector. */
|
|
2960
|
+
values?: number[];
|
|
2961
|
+
}
|
|
2915
2962
|
interface GoogleCloudAiplatformV1beta1IndexEndpoint {
|
|
2916
2963
|
/** Output only. Timestamp when this IndexEndpoint was created. */
|
|
2917
2964
|
createTime?: string;
|
|
@@ -2953,6 +3000,8 @@ declare namespace gapi.client {
|
|
|
2953
3000
|
interface GoogleCloudAiplatformV1beta1IndexStats {
|
|
2954
3001
|
/** Output only. The number of shards in the Index. */
|
|
2955
3002
|
shardsCount?: number;
|
|
3003
|
+
/** Output only. The number of sparse vectors in the Index. */
|
|
3004
|
+
sparseVectorsCount?: string;
|
|
2956
3005
|
/** Output only. The number of dense vectors in the Index. */
|
|
2957
3006
|
vectorsCount?: string;
|
|
2958
3007
|
}
|
|
@@ -3256,6 +3305,18 @@ declare namespace gapi.client {
|
|
|
3256
3305
|
/** List of PublisherModels in the requested page. */
|
|
3257
3306
|
publisherModels?: GoogleCloudAiplatformV1beta1PublisherModel[];
|
|
3258
3307
|
}
|
|
3308
|
+
interface GoogleCloudAiplatformV1beta1ListRagCorporaResponse {
|
|
3309
|
+
/** A token to retrieve the next page of results. Pass to ListRagCorporaRequest.page_token to obtain that page. */
|
|
3310
|
+
nextPageToken?: string;
|
|
3311
|
+
/** List of RagCorpora in the requested page. */
|
|
3312
|
+
ragCorpora?: GoogleCloudAiplatformV1beta1RagCorpus[];
|
|
3313
|
+
}
|
|
3314
|
+
interface GoogleCloudAiplatformV1beta1ListRagFilesResponse {
|
|
3315
|
+
/** A token to retrieve the next page of results. Pass to ListRagFilesRequest.page_token to obtain that page. */
|
|
3316
|
+
nextPageToken?: string;
|
|
3317
|
+
/** List of RagFiles in the requested page. */
|
|
3318
|
+
ragFiles?: GoogleCloudAiplatformV1beta1RagFile[];
|
|
3319
|
+
}
|
|
3259
3320
|
interface GoogleCloudAiplatformV1beta1ListReasoningEnginesResponse {
|
|
3260
3321
|
/** A token to retrieve the next page of results. Pass to ListReasoningEnginesRequest.page_token to obtain that page. */
|
|
3261
3322
|
nextPageToken?: string;
|
|
@@ -4505,7 +4566,7 @@ declare namespace gapi.client {
|
|
|
4505
4566
|
labels?: {[P in string]: string};
|
|
4506
4567
|
/** Optional. Immutable. The specification of a single machine for the template. */
|
|
4507
4568
|
machineSpec?: GoogleCloudAiplatformV1beta1MachineSpec;
|
|
4508
|
-
/**
|
|
4569
|
+
/** The resource name of the NotebookRuntimeTemplate. */
|
|
4509
4570
|
name?: string;
|
|
4510
4571
|
/** Optional. Network spec. */
|
|
4511
4572
|
networkSpec?: GoogleCloudAiplatformV1beta1NetworkSpec;
|
|
@@ -5204,6 +5265,64 @@ declare namespace gapi.client {
|
|
|
5204
5265
|
/** Optional. Which version to use for evaluation. */
|
|
5205
5266
|
version?: number;
|
|
5206
5267
|
}
|
|
5268
|
+
interface GoogleCloudAiplatformV1beta1RagContexts {
|
|
5269
|
+
/** All its contexts. */
|
|
5270
|
+
contexts?: GoogleCloudAiplatformV1beta1RagContextsContext[];
|
|
5271
|
+
}
|
|
5272
|
+
interface GoogleCloudAiplatformV1beta1RagContextsContext {
|
|
5273
|
+
/** The distance between the query vector and the context text vector. */
|
|
5274
|
+
distance?: number;
|
|
5275
|
+
/** For vertex RagStore, if the file is imported from Cloud Storage or Google Drive, source_uri will be original file URI in Cloud Storage or Google Drive; if file is uploaded, source_uri will be file display name. */
|
|
5276
|
+
sourceUri?: string;
|
|
5277
|
+
/** The text chunk. */
|
|
5278
|
+
text?: string;
|
|
5279
|
+
}
|
|
5280
|
+
interface GoogleCloudAiplatformV1beta1RagCorpus {
|
|
5281
|
+
/** Output only. Timestamp when this RagCorpus was created. */
|
|
5282
|
+
createTime?: string;
|
|
5283
|
+
/** Optional. The description of the RagCorpus. */
|
|
5284
|
+
description?: string;
|
|
5285
|
+
/** Required. The display name of the RagCorpus. The name can be up to 128 characters long and can consist of any UTF-8 characters. */
|
|
5286
|
+
displayName?: string;
|
|
5287
|
+
/** Output only. The resource name of the RagCorpus. */
|
|
5288
|
+
name?: string;
|
|
5289
|
+
/** Output only. Timestamp when this RagCorpus was last updated. */
|
|
5290
|
+
updateTime?: string;
|
|
5291
|
+
}
|
|
5292
|
+
interface GoogleCloudAiplatformV1beta1RagFile {
|
|
5293
|
+
/** Output only. Timestamp when this RagFile was created. */
|
|
5294
|
+
createTime?: string;
|
|
5295
|
+
/** Optional. The description of the RagFile. */
|
|
5296
|
+
description?: string;
|
|
5297
|
+
/** Output only. The RagFile is encapsulated and uploaded in the UploadRagFile request. */
|
|
5298
|
+
directUploadSource?: any;
|
|
5299
|
+
/** Required. The display name of the RagFile. The name can be up to 128 characters long and can consist of any UTF-8 characters. */
|
|
5300
|
+
displayName?: string;
|
|
5301
|
+
/** Output only. Google Cloud Storage location of the RagFile. It does not support wildcards in the Cloud Storage uri for now. */
|
|
5302
|
+
gcsSource?: GoogleCloudAiplatformV1beta1GcsSource;
|
|
5303
|
+
/** Output only. Google Drive location. Supports importing individual files as well as Google Drive folders. */
|
|
5304
|
+
googleDriveSource?: GoogleCloudAiplatformV1beta1GoogleDriveSource;
|
|
5305
|
+
/** Output only. The resource name of the RagFile. */
|
|
5306
|
+
name?: string;
|
|
5307
|
+
/** Output only. The type of the RagFile. */
|
|
5308
|
+
ragFileType?: string;
|
|
5309
|
+
/** Output only. The size of the RagFile in bytes. */
|
|
5310
|
+
sizeBytes?: string;
|
|
5311
|
+
/** Output only. Timestamp when this RagFile was last updated. */
|
|
5312
|
+
updateTime?: string;
|
|
5313
|
+
}
|
|
5314
|
+
interface GoogleCloudAiplatformV1beta1RagFileChunkingConfig {
|
|
5315
|
+
/** The overlap between chunks. */
|
|
5316
|
+
chunkOverlap?: number;
|
|
5317
|
+
/** The size of the chunks. */
|
|
5318
|
+
chunkSize?: number;
|
|
5319
|
+
}
|
|
5320
|
+
interface GoogleCloudAiplatformV1beta1RagQuery {
|
|
5321
|
+
/** Optional. The number of contexts to retrieve. */
|
|
5322
|
+
similarityTopK?: number;
|
|
5323
|
+
/** Optional. The query in text format to get relevant contexts. */
|
|
5324
|
+
text?: string;
|
|
5325
|
+
}
|
|
5207
5326
|
interface GoogleCloudAiplatformV1beta1RawPredictRequest {
|
|
5208
5327
|
/** The prediction input. Supports HTTP headers and arbitrary data payload. A DeployedModel may have an upper limit on the number of instances it supports per request. When this limit it is exceeded for an AutoML model, the RawPredict method returns an error. When this limit is exceeded for a custom-trained model, the behavior varies depending on the model. You can specify the schema for each instance in the predict_schemata.instance_schema_uri field when you create a Model. This schema applies when you deploy the `Model` as a `DeployedModel` to an Endpoint and use the `RawPredict` method. */
|
|
5209
5328
|
httpBody?: GoogleApiHttpBody;
|
|
@@ -5421,6 +5540,30 @@ declare namespace gapi.client {
|
|
|
5421
5540
|
/** Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. */
|
|
5422
5541
|
vertexRagStore?: GoogleCloudAiplatformV1beta1VertexRagStore;
|
|
5423
5542
|
}
|
|
5543
|
+
interface GoogleCloudAiplatformV1beta1RetrieveContextsRequest {
|
|
5544
|
+
/** Required. Single RAG retrieve query. */
|
|
5545
|
+
query?: GoogleCloudAiplatformV1beta1RagQuery;
|
|
5546
|
+
/** The data source for Vertex RagStore. */
|
|
5547
|
+
vertexRagStore?: GoogleCloudAiplatformV1beta1RetrieveContextsRequestVertexRagStore;
|
|
5548
|
+
}
|
|
5549
|
+
interface GoogleCloudAiplatformV1beta1RetrieveContextsRequestVertexRagStore {
|
|
5550
|
+
/** Optional. Deprecated. Please use rag_resources to specify the data source. */
|
|
5551
|
+
ragCorpora?: string[];
|
|
5552
|
+
/** Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. */
|
|
5553
|
+
ragResources?: GoogleCloudAiplatformV1beta1RetrieveContextsRequestVertexRagStoreRagResource[];
|
|
5554
|
+
/** Optional. Only return contexts with vector distance smaller than the threshold. */
|
|
5555
|
+
vectorDistanceThreshold?: number;
|
|
5556
|
+
}
|
|
5557
|
+
interface GoogleCloudAiplatformV1beta1RetrieveContextsRequestVertexRagStoreRagResource {
|
|
5558
|
+
/** Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` */
|
|
5559
|
+
ragCorpus?: string;
|
|
5560
|
+
/** Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. */
|
|
5561
|
+
ragFileIds?: string[];
|
|
5562
|
+
}
|
|
5563
|
+
interface GoogleCloudAiplatformV1beta1RetrieveContextsResponse {
|
|
5564
|
+
/** The contexts of the query. */
|
|
5565
|
+
contexts?: GoogleCloudAiplatformV1beta1RagContexts;
|
|
5566
|
+
}
|
|
5424
5567
|
interface GoogleCloudAiplatformV1beta1RougeInput {
|
|
5425
5568
|
/** Required. Repeated rouge instances. */
|
|
5426
5569
|
instances?: GoogleCloudAiplatformV1beta1RougeInstance[];
|
|
@@ -5464,7 +5607,9 @@ declare namespace gapi.client {
|
|
|
5464
5607
|
fileOutputGcsBucket?: string;
|
|
5465
5608
|
}
|
|
5466
5609
|
interface GoogleCloudAiplatformV1beta1RuntimeConfigVertexAISearchRuntimeConfig {
|
|
5467
|
-
/**
|
|
5610
|
+
/** Vertex AI Search App ID. This is used to construct the search request. By setting this app_id, API will construct the serving config which is required to call search API for the user. The app_id and serving_config_name cannot both be empty at the same time. */
|
|
5611
|
+
appId?: string;
|
|
5612
|
+
/** [Deprecated] Please use app_id instead. Vertex AI Search serving config name. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config}` */
|
|
5468
5613
|
servingConfigName?: string;
|
|
5469
5614
|
}
|
|
5470
5615
|
interface GoogleCloudAiplatformV1beta1SafetyInput {
|
|
@@ -5564,6 +5709,8 @@ declare namespace gapi.client {
|
|
|
5564
5709
|
catchUp?: boolean;
|
|
5565
5710
|
/** Request for ModelMonitoringService.CreateModelMonitoringJob. */
|
|
5566
5711
|
createModelMonitoringJobRequest?: GoogleCloudAiplatformV1beta1CreateModelMonitoringJobRequest;
|
|
5712
|
+
/** Request for NotebookService.CreateNotebookExecutionJob. */
|
|
5713
|
+
createNotebookExecutionJobRequest?: GoogleCloudAiplatformV1beta1CreateNotebookExecutionJobRequest;
|
|
5567
5714
|
/** Request for PipelineService.CreatePipelineJob. CreatePipelineJobRequest.parent field is required (format: projects/{project}/locations/{location}). */
|
|
5568
5715
|
createPipelineJobRequest?: GoogleCloudAiplatformV1beta1CreatePipelineJobRequest;
|
|
5569
5716
|
/** Output only. Timestamp when this Schedule was created. */
|
|
@@ -7920,6 +8067,22 @@ declare namespace gapi.client {
|
|
|
7920
8067
|
/** Output only. The version ID of the model that is uploaded. */
|
|
7921
8068
|
modelVersionId?: string;
|
|
7922
8069
|
}
|
|
8070
|
+
interface GoogleCloudAiplatformV1beta1UploadRagFileConfig {
|
|
8071
|
+
/** Specifies the size and overlap of chunks after uploading RagFile. */
|
|
8072
|
+
ragFileChunkingConfig?: GoogleCloudAiplatformV1beta1RagFileChunkingConfig;
|
|
8073
|
+
}
|
|
8074
|
+
interface GoogleCloudAiplatformV1beta1UploadRagFileRequest {
|
|
8075
|
+
/** Required. The RagFile to upload. */
|
|
8076
|
+
ragFile?: GoogleCloudAiplatformV1beta1RagFile;
|
|
8077
|
+
/** Required. The config for the RagFiles to be uploaded into the RagCorpus. VertexRagDataService.UploadRagFile. */
|
|
8078
|
+
uploadRagFileConfig?: GoogleCloudAiplatformV1beta1UploadRagFileConfig;
|
|
8079
|
+
}
|
|
8080
|
+
interface GoogleCloudAiplatformV1beta1UploadRagFileResponse {
|
|
8081
|
+
/** The error that occurred while processing the RagFile. */
|
|
8082
|
+
error?: GoogleRpcStatus;
|
|
8083
|
+
/** The RagFile that had been uploaded into the RagCorpus. */
|
|
8084
|
+
ragFile?: GoogleCloudAiplatformV1beta1RagFile;
|
|
8085
|
+
}
|
|
7923
8086
|
interface GoogleCloudAiplatformV1beta1UpsertDatapointsRequest {
|
|
7924
8087
|
/** A list of datapoints to be created/updated. */
|
|
7925
8088
|
datapoints?: GoogleCloudAiplatformV1beta1IndexDatapoint[];
|
|
@@ -7948,13 +8111,21 @@ declare namespace gapi.client {
|
|
|
7948
8111
|
datastore?: string;
|
|
7949
8112
|
}
|
|
7950
8113
|
interface GoogleCloudAiplatformV1beta1VertexRagStore {
|
|
7951
|
-
/**
|
|
8114
|
+
/** Optional. Deprecated. Please use rag_resources instead. */
|
|
7952
8115
|
ragCorpora?: string[];
|
|
8116
|
+
/** Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. */
|
|
8117
|
+
ragResources?: GoogleCloudAiplatformV1beta1VertexRagStoreRagResource[];
|
|
7953
8118
|
/** Optional. Number of top k results to return from the selected corpora. */
|
|
7954
8119
|
similarityTopK?: number;
|
|
7955
8120
|
/** Optional. Only return results with vector distance smaller than the threshold. */
|
|
7956
8121
|
vectorDistanceThreshold?: number;
|
|
7957
8122
|
}
|
|
8123
|
+
interface GoogleCloudAiplatformV1beta1VertexRagStoreRagResource {
|
|
8124
|
+
/** Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` */
|
|
8125
|
+
ragCorpus?: string;
|
|
8126
|
+
/** Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. */
|
|
8127
|
+
ragFileIds?: string[];
|
|
8128
|
+
}
|
|
7958
8129
|
interface GoogleCloudAiplatformV1beta1VideoMetadata {
|
|
7959
8130
|
/** Optional. The end offset of the video. */
|
|
7960
8131
|
endOffset?: string;
|
|
@@ -8620,7 +8791,12 @@ declare namespace gapi.client {
|
|
|
8620
8791
|
/** The sum of the size of all the contents in the request. */
|
|
8621
8792
|
totalContentSize?: string;
|
|
8622
8793
|
}
|
|
8794
|
+
interface LearningServingLlmAtlasOutputMetadata {
|
|
8795
|
+
requestTopic?: string;
|
|
8796
|
+
source?: string;
|
|
8797
|
+
}
|
|
8623
8798
|
interface LearningServingLlmMessageMetadata {
|
|
8799
|
+
atlasMetadata?: LearningServingLlmAtlasOutputMetadata;
|
|
8624
8800
|
/** Summary of classifier output. We attach this to all messages regardless of whether classification rules triggered or not. */
|
|
8625
8801
|
classifierSummary?: LearningGenaiRootClassifierOutputSummary;
|
|
8626
8802
|
/** Contains metadata related to Codey Processors. */
|
|
@@ -8647,13 +8823,15 @@ declare namespace gapi.client {
|
|
|
8647
8823
|
lmPrefix?: string;
|
|
8648
8824
|
/** The original text generated by LLM. This is the raw output for debugging purposes. */
|
|
8649
8825
|
originalText?: string;
|
|
8650
|
-
/**
|
|
8826
|
+
/** Number of tokens decoded by the model as part of a stream. This count may be different from `per_stream_returned_token_count` which, is counted after any response rewriting or truncation. Applies to streaming response only. */
|
|
8651
8827
|
perStreamDecodedTokenCount?: number;
|
|
8828
|
+
/** Number of tokens returned per stream in a response candidate after any response rewriting or truncation. Applies to streaming response only. Applies to Gemini models only. */
|
|
8829
|
+
perStreamReturnedTokenCount?: number;
|
|
8652
8830
|
/** Results of running RAI on the query or this response candidate. One output per rai_config. It will be populated regardless of whether the threshold is exceeded or not. */
|
|
8653
8831
|
raiOutputs?: LearningGenaiRootRAIOutput[];
|
|
8654
8832
|
/** Recitation Results. It will be populated as long as Recitation processing is enabled, regardless of recitation outcome. */
|
|
8655
8833
|
recitationResult?: LearningGenaiRecitationRecitationResult;
|
|
8656
|
-
/** NOT
|
|
8834
|
+
/** NOT IMPLEMENTED TODO (b/334187574) Remove this field after Labs migrates to per_stream_returned_token_count and total_returned_token_count. */
|
|
8657
8835
|
returnTokenCount?: number;
|
|
8658
8836
|
/** All the different scores for a message are logged here. */
|
|
8659
8837
|
scores?: LearningGenaiRootScore[];
|
|
@@ -8661,6 +8839,8 @@ declare namespace gapi.client {
|
|
|
8661
8839
|
streamTerminated?: boolean;
|
|
8662
8840
|
/** Total tokens decoded so far per response_candidate. For streaming: Count of all the tokens decoded so far (aggregated count). For unary: Count of all the tokens decoded per response_candidate. */
|
|
8663
8841
|
totalDecodedTokenCount?: number;
|
|
8842
|
+
/** Total number of tokens returned in a response candidate. For streaming, it is the aggregated count (i.e. total so far) Applies to Gemini models only. */
|
|
8843
|
+
totalReturnedTokenCount?: number;
|
|
8664
8844
|
/** Translated user-prompt used for RAI post processing. This is for internal processing only. We will translate in pre-processor and pass the translated text to the post processor using this field. It will be empty if non of the signals requested need translation. */
|
|
8665
8845
|
translatedUserPrompts?: string[];
|
|
8666
8846
|
/** The metadata from Vertex SafetyCat processors */
|
|
@@ -8712,6 +8892,66 @@ declare namespace gapi.client {
|
|
|
8712
8892
|
/** The following are usually only present when code != 0 Space to which this status belongs */
|
|
8713
8893
|
space?: string;
|
|
8714
8894
|
}
|
|
8895
|
+
interface MediaResource {
|
|
8896
|
+
/** Upload a file into a RagCorpus. */
|
|
8897
|
+
upload(request: {
|
|
8898
|
+
/** V1 error format. */
|
|
8899
|
+
'$.xgafv'?: string;
|
|
8900
|
+
/** OAuth access token. */
|
|
8901
|
+
access_token?: string;
|
|
8902
|
+
/** Data format for response. */
|
|
8903
|
+
alt?: string;
|
|
8904
|
+
/** JSONP */
|
|
8905
|
+
callback?: string;
|
|
8906
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
8907
|
+
fields?: string;
|
|
8908
|
+
/** 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. */
|
|
8909
|
+
key?: string;
|
|
8910
|
+
/** OAuth 2.0 token for the current user. */
|
|
8911
|
+
oauth_token?: string;
|
|
8912
|
+
/** Required. The name of the RagCorpus resource into which to upload the file. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` */
|
|
8913
|
+
parent: string;
|
|
8914
|
+
/** Returns response with indentations and line breaks. */
|
|
8915
|
+
prettyPrint?: boolean;
|
|
8916
|
+
/** 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. */
|
|
8917
|
+
quotaUser?: string;
|
|
8918
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
8919
|
+
upload_protocol?: string;
|
|
8920
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
8921
|
+
uploadType?: string;
|
|
8922
|
+
/** Request body */
|
|
8923
|
+
resource: GoogleCloudAiplatformV1beta1UploadRagFileRequest;
|
|
8924
|
+
}): Request<GoogleCloudAiplatformV1beta1UploadRagFileResponse>;
|
|
8925
|
+
upload(
|
|
8926
|
+
request: {
|
|
8927
|
+
/** V1 error format. */
|
|
8928
|
+
'$.xgafv'?: string;
|
|
8929
|
+
/** OAuth access token. */
|
|
8930
|
+
access_token?: string;
|
|
8931
|
+
/** Data format for response. */
|
|
8932
|
+
alt?: string;
|
|
8933
|
+
/** JSONP */
|
|
8934
|
+
callback?: string;
|
|
8935
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
8936
|
+
fields?: string;
|
|
8937
|
+
/** 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. */
|
|
8938
|
+
key?: string;
|
|
8939
|
+
/** OAuth 2.0 token for the current user. */
|
|
8940
|
+
oauth_token?: string;
|
|
8941
|
+
/** Required. The name of the RagCorpus resource into which to upload the file. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` */
|
|
8942
|
+
parent: string;
|
|
8943
|
+
/** Returns response with indentations and line breaks. */
|
|
8944
|
+
prettyPrint?: boolean;
|
|
8945
|
+
/** 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. */
|
|
8946
|
+
quotaUser?: string;
|
|
8947
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
8948
|
+
upload_protocol?: string;
|
|
8949
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
8950
|
+
uploadType?: string;
|
|
8951
|
+
},
|
|
8952
|
+
body: GoogleCloudAiplatformV1beta1UploadRagFileRequest
|
|
8953
|
+
): Request<GoogleCloudAiplatformV1beta1UploadRagFileResponse>;
|
|
8954
|
+
}
|
|
8715
8955
|
interface OperationsResource {
|
|
8716
8956
|
/** 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`. */
|
|
8717
8957
|
cancel(request?: {
|
|
@@ -26477,9 +26717,297 @@ declare namespace gapi.client {
|
|
|
26477
26717
|
}): Request<GoogleLongrunningOperation>;
|
|
26478
26718
|
}
|
|
26479
26719
|
interface RagFilesResource {
|
|
26720
|
+
/** Deletes a RagFile. */
|
|
26721
|
+
delete(request?: {
|
|
26722
|
+
/** V1 error format. */
|
|
26723
|
+
'$.xgafv'?: string;
|
|
26724
|
+
/** OAuth access token. */
|
|
26725
|
+
access_token?: string;
|
|
26726
|
+
/** Data format for response. */
|
|
26727
|
+
alt?: string;
|
|
26728
|
+
/** JSONP */
|
|
26729
|
+
callback?: string;
|
|
26730
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
26731
|
+
fields?: string;
|
|
26732
|
+
/** 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. */
|
|
26733
|
+
key?: string;
|
|
26734
|
+
/** Required. The name of the RagFile resource to be deleted. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragFiles/{rag_file}` */
|
|
26735
|
+
name: string;
|
|
26736
|
+
/** OAuth 2.0 token for the current user. */
|
|
26737
|
+
oauth_token?: string;
|
|
26738
|
+
/** Returns response with indentations and line breaks. */
|
|
26739
|
+
prettyPrint?: boolean;
|
|
26740
|
+
/** 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. */
|
|
26741
|
+
quotaUser?: string;
|
|
26742
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
26743
|
+
upload_protocol?: string;
|
|
26744
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
26745
|
+
uploadType?: string;
|
|
26746
|
+
}): Request<GoogleLongrunningOperation>;
|
|
26747
|
+
/** Gets a RagFile. */
|
|
26748
|
+
get(request?: {
|
|
26749
|
+
/** V1 error format. */
|
|
26750
|
+
'$.xgafv'?: string;
|
|
26751
|
+
/** OAuth access token. */
|
|
26752
|
+
access_token?: string;
|
|
26753
|
+
/** Data format for response. */
|
|
26754
|
+
alt?: string;
|
|
26755
|
+
/** JSONP */
|
|
26756
|
+
callback?: string;
|
|
26757
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
26758
|
+
fields?: string;
|
|
26759
|
+
/** 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. */
|
|
26760
|
+
key?: string;
|
|
26761
|
+
/** Required. The name of the RagFile resource. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragFiles/{rag_file}` */
|
|
26762
|
+
name: string;
|
|
26763
|
+
/** OAuth 2.0 token for the current user. */
|
|
26764
|
+
oauth_token?: string;
|
|
26765
|
+
/** Returns response with indentations and line breaks. */
|
|
26766
|
+
prettyPrint?: boolean;
|
|
26767
|
+
/** 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. */
|
|
26768
|
+
quotaUser?: string;
|
|
26769
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
26770
|
+
upload_protocol?: string;
|
|
26771
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
26772
|
+
uploadType?: string;
|
|
26773
|
+
}): Request<GoogleCloudAiplatformV1beta1RagFile>;
|
|
26774
|
+
/** Import files from Google Cloud Storage or Google Drive into a RagCorpus. */
|
|
26775
|
+
import(request: {
|
|
26776
|
+
/** V1 error format. */
|
|
26777
|
+
'$.xgafv'?: string;
|
|
26778
|
+
/** OAuth access token. */
|
|
26779
|
+
access_token?: string;
|
|
26780
|
+
/** Data format for response. */
|
|
26781
|
+
alt?: string;
|
|
26782
|
+
/** JSONP */
|
|
26783
|
+
callback?: string;
|
|
26784
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
26785
|
+
fields?: string;
|
|
26786
|
+
/** 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. */
|
|
26787
|
+
key?: string;
|
|
26788
|
+
/** OAuth 2.0 token for the current user. */
|
|
26789
|
+
oauth_token?: string;
|
|
26790
|
+
/** Required. The name of the RagCorpus resource into which to import files. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` */
|
|
26791
|
+
parent: string;
|
|
26792
|
+
/** Returns response with indentations and line breaks. */
|
|
26793
|
+
prettyPrint?: boolean;
|
|
26794
|
+
/** 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. */
|
|
26795
|
+
quotaUser?: string;
|
|
26796
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
26797
|
+
upload_protocol?: string;
|
|
26798
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
26799
|
+
uploadType?: string;
|
|
26800
|
+
/** Request body */
|
|
26801
|
+
resource: GoogleCloudAiplatformV1beta1ImportRagFilesRequest;
|
|
26802
|
+
}): Request<GoogleLongrunningOperation>;
|
|
26803
|
+
import(
|
|
26804
|
+
request: {
|
|
26805
|
+
/** V1 error format. */
|
|
26806
|
+
'$.xgafv'?: string;
|
|
26807
|
+
/** OAuth access token. */
|
|
26808
|
+
access_token?: string;
|
|
26809
|
+
/** Data format for response. */
|
|
26810
|
+
alt?: string;
|
|
26811
|
+
/** JSONP */
|
|
26812
|
+
callback?: string;
|
|
26813
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
26814
|
+
fields?: string;
|
|
26815
|
+
/** 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. */
|
|
26816
|
+
key?: string;
|
|
26817
|
+
/** OAuth 2.0 token for the current user. */
|
|
26818
|
+
oauth_token?: string;
|
|
26819
|
+
/** Required. The name of the RagCorpus resource into which to import files. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` */
|
|
26820
|
+
parent: string;
|
|
26821
|
+
/** Returns response with indentations and line breaks. */
|
|
26822
|
+
prettyPrint?: boolean;
|
|
26823
|
+
/** 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. */
|
|
26824
|
+
quotaUser?: string;
|
|
26825
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
26826
|
+
upload_protocol?: string;
|
|
26827
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
26828
|
+
uploadType?: string;
|
|
26829
|
+
},
|
|
26830
|
+
body: GoogleCloudAiplatformV1beta1ImportRagFilesRequest
|
|
26831
|
+
): Request<GoogleLongrunningOperation>;
|
|
26832
|
+
/** Lists RagFiles in a RagCorpus. */
|
|
26833
|
+
list(request?: {
|
|
26834
|
+
/** V1 error format. */
|
|
26835
|
+
'$.xgafv'?: string;
|
|
26836
|
+
/** OAuth access token. */
|
|
26837
|
+
access_token?: string;
|
|
26838
|
+
/** Data format for response. */
|
|
26839
|
+
alt?: string;
|
|
26840
|
+
/** JSONP */
|
|
26841
|
+
callback?: string;
|
|
26842
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
26843
|
+
fields?: string;
|
|
26844
|
+
/** 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. */
|
|
26845
|
+
key?: string;
|
|
26846
|
+
/** OAuth 2.0 token for the current user. */
|
|
26847
|
+
oauth_token?: string;
|
|
26848
|
+
/** Optional. The standard list page size. */
|
|
26849
|
+
pageSize?: number;
|
|
26850
|
+
/** Optional. The standard list page token. Typically obtained via ListRagFilesResponse.next_page_token of the previous VertexRagDataService.ListRagFiles call. */
|
|
26851
|
+
pageToken?: string;
|
|
26852
|
+
/** Required. The resource name of the RagCorpus from which to list the RagFiles. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` */
|
|
26853
|
+
parent: string;
|
|
26854
|
+
/** Returns response with indentations and line breaks. */
|
|
26855
|
+
prettyPrint?: boolean;
|
|
26856
|
+
/** 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. */
|
|
26857
|
+
quotaUser?: string;
|
|
26858
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
26859
|
+
upload_protocol?: string;
|
|
26860
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
26861
|
+
uploadType?: string;
|
|
26862
|
+
}): Request<GoogleCloudAiplatformV1beta1ListRagFilesResponse>;
|
|
26480
26863
|
operations: OperationsResource;
|
|
26481
26864
|
}
|
|
26482
26865
|
interface RagCorporaResource {
|
|
26866
|
+
/** Creates a RagCorpus. */
|
|
26867
|
+
create(request: {
|
|
26868
|
+
/** V1 error format. */
|
|
26869
|
+
'$.xgafv'?: string;
|
|
26870
|
+
/** OAuth access token. */
|
|
26871
|
+
access_token?: string;
|
|
26872
|
+
/** Data format for response. */
|
|
26873
|
+
alt?: string;
|
|
26874
|
+
/** JSONP */
|
|
26875
|
+
callback?: string;
|
|
26876
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
26877
|
+
fields?: string;
|
|
26878
|
+
/** 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. */
|
|
26879
|
+
key?: string;
|
|
26880
|
+
/** OAuth 2.0 token for the current user. */
|
|
26881
|
+
oauth_token?: string;
|
|
26882
|
+
/** Required. The resource name of the Location to create the RagCorpus in. Format: `projects/{project}/locations/{location}` */
|
|
26883
|
+
parent: string;
|
|
26884
|
+
/** Returns response with indentations and line breaks. */
|
|
26885
|
+
prettyPrint?: boolean;
|
|
26886
|
+
/** 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. */
|
|
26887
|
+
quotaUser?: string;
|
|
26888
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
26889
|
+
upload_protocol?: string;
|
|
26890
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
26891
|
+
uploadType?: string;
|
|
26892
|
+
/** Request body */
|
|
26893
|
+
resource: GoogleCloudAiplatformV1beta1RagCorpus;
|
|
26894
|
+
}): Request<GoogleLongrunningOperation>;
|
|
26895
|
+
create(
|
|
26896
|
+
request: {
|
|
26897
|
+
/** V1 error format. */
|
|
26898
|
+
'$.xgafv'?: string;
|
|
26899
|
+
/** OAuth access token. */
|
|
26900
|
+
access_token?: string;
|
|
26901
|
+
/** Data format for response. */
|
|
26902
|
+
alt?: string;
|
|
26903
|
+
/** JSONP */
|
|
26904
|
+
callback?: string;
|
|
26905
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
26906
|
+
fields?: string;
|
|
26907
|
+
/** 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. */
|
|
26908
|
+
key?: string;
|
|
26909
|
+
/** OAuth 2.0 token for the current user. */
|
|
26910
|
+
oauth_token?: string;
|
|
26911
|
+
/** Required. The resource name of the Location to create the RagCorpus in. Format: `projects/{project}/locations/{location}` */
|
|
26912
|
+
parent: string;
|
|
26913
|
+
/** Returns response with indentations and line breaks. */
|
|
26914
|
+
prettyPrint?: boolean;
|
|
26915
|
+
/** 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. */
|
|
26916
|
+
quotaUser?: string;
|
|
26917
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
26918
|
+
upload_protocol?: string;
|
|
26919
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
26920
|
+
uploadType?: string;
|
|
26921
|
+
},
|
|
26922
|
+
body: GoogleCloudAiplatformV1beta1RagCorpus
|
|
26923
|
+
): Request<GoogleLongrunningOperation>;
|
|
26924
|
+
/** Deletes a RagCorpus. */
|
|
26925
|
+
delete(request?: {
|
|
26926
|
+
/** V1 error format. */
|
|
26927
|
+
'$.xgafv'?: string;
|
|
26928
|
+
/** OAuth access token. */
|
|
26929
|
+
access_token?: string;
|
|
26930
|
+
/** Data format for response. */
|
|
26931
|
+
alt?: string;
|
|
26932
|
+
/** JSONP */
|
|
26933
|
+
callback?: string;
|
|
26934
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
26935
|
+
fields?: string;
|
|
26936
|
+
/** Optional. If set to true, any RagFiles in this RagCorpus will also be deleted. Otherwise, the request will only work if the RagCorpus has no RagFiles. */
|
|
26937
|
+
force?: boolean;
|
|
26938
|
+
/** 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. */
|
|
26939
|
+
key?: string;
|
|
26940
|
+
/** Required. The name of the RagCorpus resource to be deleted. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` */
|
|
26941
|
+
name: string;
|
|
26942
|
+
/** OAuth 2.0 token for the current user. */
|
|
26943
|
+
oauth_token?: string;
|
|
26944
|
+
/** Returns response with indentations and line breaks. */
|
|
26945
|
+
prettyPrint?: boolean;
|
|
26946
|
+
/** 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. */
|
|
26947
|
+
quotaUser?: string;
|
|
26948
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
26949
|
+
upload_protocol?: string;
|
|
26950
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
26951
|
+
uploadType?: string;
|
|
26952
|
+
}): Request<GoogleLongrunningOperation>;
|
|
26953
|
+
/** Gets a RagCorpus. */
|
|
26954
|
+
get(request?: {
|
|
26955
|
+
/** V1 error format. */
|
|
26956
|
+
'$.xgafv'?: string;
|
|
26957
|
+
/** OAuth access token. */
|
|
26958
|
+
access_token?: string;
|
|
26959
|
+
/** Data format for response. */
|
|
26960
|
+
alt?: string;
|
|
26961
|
+
/** JSONP */
|
|
26962
|
+
callback?: string;
|
|
26963
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
26964
|
+
fields?: string;
|
|
26965
|
+
/** 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. */
|
|
26966
|
+
key?: string;
|
|
26967
|
+
/** Required. The name of the RagCorpus resource. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` */
|
|
26968
|
+
name: string;
|
|
26969
|
+
/** OAuth 2.0 token for the current user. */
|
|
26970
|
+
oauth_token?: string;
|
|
26971
|
+
/** Returns response with indentations and line breaks. */
|
|
26972
|
+
prettyPrint?: boolean;
|
|
26973
|
+
/** 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. */
|
|
26974
|
+
quotaUser?: string;
|
|
26975
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
26976
|
+
upload_protocol?: string;
|
|
26977
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
26978
|
+
uploadType?: string;
|
|
26979
|
+
}): Request<GoogleCloudAiplatformV1beta1RagCorpus>;
|
|
26980
|
+
/** Lists RagCorpora in a Location. */
|
|
26981
|
+
list(request?: {
|
|
26982
|
+
/** V1 error format. */
|
|
26983
|
+
'$.xgafv'?: string;
|
|
26984
|
+
/** OAuth access token. */
|
|
26985
|
+
access_token?: string;
|
|
26986
|
+
/** Data format for response. */
|
|
26987
|
+
alt?: string;
|
|
26988
|
+
/** JSONP */
|
|
26989
|
+
callback?: string;
|
|
26990
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
26991
|
+
fields?: string;
|
|
26992
|
+
/** 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. */
|
|
26993
|
+
key?: string;
|
|
26994
|
+
/** OAuth 2.0 token for the current user. */
|
|
26995
|
+
oauth_token?: string;
|
|
26996
|
+
/** Optional. The standard list page size. */
|
|
26997
|
+
pageSize?: number;
|
|
26998
|
+
/** Optional. The standard list page token. Typically obtained via ListRagCorporaResponse.next_page_token of the previous VertexRagDataService.ListRagCorpora call. */
|
|
26999
|
+
pageToken?: string;
|
|
27000
|
+
/** Required. The resource name of the Location from which to list the RagCorpora. Format: `projects/{project}/locations/{location}` */
|
|
27001
|
+
parent: string;
|
|
27002
|
+
/** Returns response with indentations and line breaks. */
|
|
27003
|
+
prettyPrint?: boolean;
|
|
27004
|
+
/** 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. */
|
|
27005
|
+
quotaUser?: string;
|
|
27006
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
27007
|
+
upload_protocol?: string;
|
|
27008
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
27009
|
+
uploadType?: string;
|
|
27010
|
+
}): Request<GoogleCloudAiplatformV1beta1ListRagCorporaResponse>;
|
|
26483
27011
|
operations: OperationsResource;
|
|
26484
27012
|
ragFiles: RagFilesResource;
|
|
26485
27013
|
}
|
|
@@ -31101,6 +31629,64 @@ declare namespace gapi.client {
|
|
|
31101
31629
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
31102
31630
|
uploadType?: string;
|
|
31103
31631
|
}): Request<GoogleCloudLocationListLocationsResponse>;
|
|
31632
|
+
/** Retrieves relevant contexts for a query. */
|
|
31633
|
+
retrieveContexts(request: {
|
|
31634
|
+
/** V1 error format. */
|
|
31635
|
+
'$.xgafv'?: string;
|
|
31636
|
+
/** OAuth access token. */
|
|
31637
|
+
access_token?: string;
|
|
31638
|
+
/** Data format for response. */
|
|
31639
|
+
alt?: string;
|
|
31640
|
+
/** JSONP */
|
|
31641
|
+
callback?: string;
|
|
31642
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
31643
|
+
fields?: string;
|
|
31644
|
+
/** 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. */
|
|
31645
|
+
key?: string;
|
|
31646
|
+
/** OAuth 2.0 token for the current user. */
|
|
31647
|
+
oauth_token?: string;
|
|
31648
|
+
/** Required. The resource name of the Location from which to retrieve RagContexts. The users must have permission to make a call in the project. Format: `projects/{project}/locations/{location}`. */
|
|
31649
|
+
parent: string;
|
|
31650
|
+
/** Returns response with indentations and line breaks. */
|
|
31651
|
+
prettyPrint?: boolean;
|
|
31652
|
+
/** 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. */
|
|
31653
|
+
quotaUser?: string;
|
|
31654
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
31655
|
+
upload_protocol?: string;
|
|
31656
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
31657
|
+
uploadType?: string;
|
|
31658
|
+
/** Request body */
|
|
31659
|
+
resource: GoogleCloudAiplatformV1beta1RetrieveContextsRequest;
|
|
31660
|
+
}): Request<GoogleCloudAiplatformV1beta1RetrieveContextsResponse>;
|
|
31661
|
+
retrieveContexts(
|
|
31662
|
+
request: {
|
|
31663
|
+
/** V1 error format. */
|
|
31664
|
+
'$.xgafv'?: string;
|
|
31665
|
+
/** OAuth access token. */
|
|
31666
|
+
access_token?: string;
|
|
31667
|
+
/** Data format for response. */
|
|
31668
|
+
alt?: string;
|
|
31669
|
+
/** JSONP */
|
|
31670
|
+
callback?: string;
|
|
31671
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
31672
|
+
fields?: string;
|
|
31673
|
+
/** 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. */
|
|
31674
|
+
key?: string;
|
|
31675
|
+
/** OAuth 2.0 token for the current user. */
|
|
31676
|
+
oauth_token?: string;
|
|
31677
|
+
/** Required. The resource name of the Location from which to retrieve RagContexts. The users must have permission to make a call in the project. Format: `projects/{project}/locations/{location}`. */
|
|
31678
|
+
parent: string;
|
|
31679
|
+
/** Returns response with indentations and line breaks. */
|
|
31680
|
+
prettyPrint?: boolean;
|
|
31681
|
+
/** 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. */
|
|
31682
|
+
quotaUser?: string;
|
|
31683
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
31684
|
+
upload_protocol?: string;
|
|
31685
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
31686
|
+
uploadType?: string;
|
|
31687
|
+
},
|
|
31688
|
+
body: GoogleCloudAiplatformV1beta1RetrieveContextsRequest
|
|
31689
|
+
): Request<GoogleCloudAiplatformV1beta1RetrieveContextsResponse>;
|
|
31104
31690
|
agents: AgentsResource;
|
|
31105
31691
|
apps: AppsResource;
|
|
31106
31692
|
batchPredictionJobs: BatchPredictionJobsResource;
|
|
@@ -31306,6 +31892,8 @@ declare namespace gapi.client {
|
|
|
31306
31892
|
models: ModelsResource;
|
|
31307
31893
|
}
|
|
31308
31894
|
|
|
31895
|
+
const media: MediaResource;
|
|
31896
|
+
|
|
31309
31897
|
const projects: ProjectsResource;
|
|
31310
31898
|
|
|
31311
31899
|
const publishers: PublishersResource;
|
package/package.json
CHANGED
package/readme.md
CHANGED
|
@@ -72,6 +72,11 @@ 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
|
+
Upload a file into a RagCorpus.
|
|
77
|
+
*/
|
|
78
|
+
await gapi.client.aiplatform.media.upload({parent: 'parent'});
|
|
79
|
+
|
|
75
80
|
/*
|
|
76
81
|
Gets a GenAI cache config.
|
|
77
82
|
*/
|