@maxim_mazurok/gapi.client.discoveryengine-v1beta 0.1.20251109 → 0.1.20251203
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 +230 -214
- package/package.json +1 -1
- package/readme.md +0 -5
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://discoveryengine.googleapis.com/$discovery/rest?version=v1beta
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20251203
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -28,166 +28,6 @@ declare namespace gapi.client {
|
|
|
28
28
|
): void;
|
|
29
29
|
|
|
30
30
|
namespace discoveryengine {
|
|
31
|
-
interface GdataBlobstore2Info {
|
|
32
|
-
/** The blob generation id. */
|
|
33
|
-
blobGeneration?: string;
|
|
34
|
-
/** The blob id, e.g., /blobstore/prod/playground/scotty */
|
|
35
|
-
blobId?: string;
|
|
36
|
-
/** Read handle passed from Bigstore -> Scotty for a GCS download. This is a signed, serialized blobstore2.ReadHandle proto which must never be set outside of Bigstore, and is not applicable to non-GCS media downloads. */
|
|
37
|
-
downloadReadHandle?: string;
|
|
38
|
-
/** The blob read token. Needed to read blobs that have not been replicated. Might not be available until the final call. */
|
|
39
|
-
readToken?: string;
|
|
40
|
-
/** Metadata passed from Blobstore -> Scotty for a new GCS upload. This is a signed, serialized blobstore2.BlobMetadataContainer proto which must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads. */
|
|
41
|
-
uploadMetadataContainer?: string;
|
|
42
|
-
}
|
|
43
|
-
interface GdataCompositeMedia {
|
|
44
|
-
/** Blobstore v1 reference, set if reference_type is BLOBSTORE_REF This should be the byte representation of a blobstore.BlobRef. Since Blobstore is deprecating v1, use blobstore2_info instead. For now, any v2 blob will also be represented in this field as v1 BlobRef. */
|
|
45
|
-
blobRef?: string;
|
|
46
|
-
/** Blobstore v2 info, set if reference_type is BLOBSTORE_REF and it refers to a v2 blob. */
|
|
47
|
-
blobstore2Info?: GdataBlobstore2Info;
|
|
48
|
-
/** A binary data reference for a media download. Serves as a technology-agnostic binary reference in some Google infrastructure. This value is a serialized storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get around the fact that the cosmo proto (as well as others it includes) doesn't support JavaScript. This prevents us from including the actual type of this field. */
|
|
49
|
-
cosmoBinaryReference?: string;
|
|
50
|
-
/** crc32.c hash for the payload. */
|
|
51
|
-
crc32cHash?: number;
|
|
52
|
-
/** Media data, set if reference_type is INLINE */
|
|
53
|
-
inline?: string;
|
|
54
|
-
/** Size of the data, in bytes */
|
|
55
|
-
length?: string;
|
|
56
|
-
/** MD5 hash for the payload. */
|
|
57
|
-
md5Hash?: string;
|
|
58
|
-
/** Reference to a TI Blob, set if reference_type is BIGSTORE_REF. */
|
|
59
|
-
objectId?: GdataObjectId;
|
|
60
|
-
/** Path to the data, set if reference_type is PATH */
|
|
61
|
-
path?: string;
|
|
62
|
-
/** Describes what the field reference contains. */
|
|
63
|
-
referenceType?: string;
|
|
64
|
-
/** SHA-1 hash for the payload. */
|
|
65
|
-
sha1Hash?: string;
|
|
66
|
-
}
|
|
67
|
-
interface GdataContentTypeInfo {
|
|
68
|
-
/** Scotty's best guess of what the content type of the file is. */
|
|
69
|
-
bestGuess?: string;
|
|
70
|
-
/** The content type of the file derived by looking at specific bytes (i.e. "magic bytes") of the actual file. */
|
|
71
|
-
fromBytes?: string;
|
|
72
|
-
/** The content type of the file derived from the file extension of the original file name used by the client. */
|
|
73
|
-
fromFileName?: string;
|
|
74
|
-
/** The content type of the file as specified in the request headers, multipart headers, or RUPIO start request. */
|
|
75
|
-
fromHeader?: string;
|
|
76
|
-
/** The content type of the file derived from the file extension of the URL path. The URL path is assumed to represent a file name (which is typically only true for agents that are providing a REST API). */
|
|
77
|
-
fromUrlPath?: string;
|
|
78
|
-
}
|
|
79
|
-
interface GdataDiffChecksumsResponse {
|
|
80
|
-
/** Exactly one of these fields must be populated. If checksums_location is filled, the server will return the corresponding contents to the user. If object_location is filled, the server will calculate the checksums based on the content there and return that to the user. For details on the format of the checksums, see http://go/scotty-diff-protocol. */
|
|
81
|
-
checksumsLocation?: GdataCompositeMedia;
|
|
82
|
-
/** The chunk size of checksums. Must be a multiple of 256KB. */
|
|
83
|
-
chunkSizeBytes?: string;
|
|
84
|
-
/** If set, calculate the checksums based on the contents and return them to the caller. */
|
|
85
|
-
objectLocation?: GdataCompositeMedia;
|
|
86
|
-
/** The total size of the server object. */
|
|
87
|
-
objectSizeBytes?: string;
|
|
88
|
-
/** The object version of the object the checksums are being returned for. */
|
|
89
|
-
objectVersion?: string;
|
|
90
|
-
}
|
|
91
|
-
interface GdataDiffDownloadResponse {
|
|
92
|
-
/** The original object location. */
|
|
93
|
-
objectLocation?: GdataCompositeMedia;
|
|
94
|
-
}
|
|
95
|
-
interface GdataDiffUploadRequest {
|
|
96
|
-
/** The location of the checksums for the new object. Agents must clone the object located here, as the upload server will delete the contents once a response is received. For details on the format of the checksums, see http://go/scotty-diff-protocol. */
|
|
97
|
-
checksumsInfo?: GdataCompositeMedia;
|
|
98
|
-
/** The location of the new object. Agents must clone the object located here, as the upload server will delete the contents once a response is received. */
|
|
99
|
-
objectInfo?: GdataCompositeMedia;
|
|
100
|
-
/** The object version of the object that is the base version the incoming diff script will be applied to. This field will always be filled in. */
|
|
101
|
-
objectVersion?: string;
|
|
102
|
-
}
|
|
103
|
-
interface GdataDiffUploadResponse {
|
|
104
|
-
/** The object version of the object at the server. Must be included in the end notification response. The version in the end notification response must correspond to the new version of the object that is now stored at the server, after the upload. */
|
|
105
|
-
objectVersion?: string;
|
|
106
|
-
/** The location of the original file for a diff upload request. Must be filled in if responding to an upload start notification. */
|
|
107
|
-
originalObject?: GdataCompositeMedia;
|
|
108
|
-
}
|
|
109
|
-
interface GdataDiffVersionResponse {
|
|
110
|
-
/** The total size of the server object. */
|
|
111
|
-
objectSizeBytes?: string;
|
|
112
|
-
/** The version of the object stored at the server. */
|
|
113
|
-
objectVersion?: string;
|
|
114
|
-
}
|
|
115
|
-
interface GdataDownloadParameters {
|
|
116
|
-
/** A boolean to be returned in the response to Scotty. Allows/disallows gzip encoding of the payload content when the server thinks it's advantageous (hence, does not guarantee compression) which allows Scotty to GZip the response to the client. */
|
|
117
|
-
allowGzipCompression?: boolean;
|
|
118
|
-
/** Determining whether or not Apiary should skip the inclusion of any Content-Range header on its response to Scotty. */
|
|
119
|
-
ignoreRange?: boolean;
|
|
120
|
-
}
|
|
121
|
-
interface GdataMedia {
|
|
122
|
-
/** Deprecated, use one of explicit hash type fields instead. Algorithm used for calculating the hash. As of 2011/01/21, "MD5" is the only possible value for this field. New values may be added at any time. */
|
|
123
|
-
algorithm?: string;
|
|
124
|
-
/** Use object_id instead. */
|
|
125
|
-
bigstoreObjectRef?: string;
|
|
126
|
-
/** Blobstore v1 reference, set if reference_type is BLOBSTORE_REF This should be the byte representation of a blobstore.BlobRef. Since Blobstore is deprecating v1, use blobstore2_info instead. For now, any v2 blob will also be represented in this field as v1 BlobRef. */
|
|
127
|
-
blobRef?: string;
|
|
128
|
-
/** Blobstore v2 info, set if reference_type is BLOBSTORE_REF and it refers to a v2 blob. */
|
|
129
|
-
blobstore2Info?: GdataBlobstore2Info;
|
|
130
|
-
/** A composite media composed of one or more media objects, set if reference_type is COMPOSITE_MEDIA. The media length field must be set to the sum of the lengths of all composite media objects. Note: All composite media must have length specified. */
|
|
131
|
-
compositeMedia?: GdataCompositeMedia[];
|
|
132
|
-
/** MIME type of the data */
|
|
133
|
-
contentType?: string;
|
|
134
|
-
/** Extended content type information provided for Scotty uploads. */
|
|
135
|
-
contentTypeInfo?: GdataContentTypeInfo;
|
|
136
|
-
/** A binary data reference for a media download. Serves as a technology-agnostic binary reference in some Google infrastructure. This value is a serialized storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get around the fact that the cosmo proto (as well as others it includes) doesn't support JavaScript. This prevents us from including the actual type of this field. */
|
|
137
|
-
cosmoBinaryReference?: string;
|
|
138
|
-
/** For Scotty Uploads: Scotty-provided hashes for uploads For Scotty Downloads: (WARNING: DO NOT USE WITHOUT PERMISSION FROM THE SCOTTY TEAM.) A Hash provided by the agent to be used to verify the data being downloaded. Currently only supported for inline payloads. Further, only crc32c_hash is currently supported. */
|
|
139
|
-
crc32cHash?: number;
|
|
140
|
-
/** Set if reference_type is DIFF_CHECKSUMS_RESPONSE. */
|
|
141
|
-
diffChecksumsResponse?: GdataDiffChecksumsResponse;
|
|
142
|
-
/** Set if reference_type is DIFF_DOWNLOAD_RESPONSE. */
|
|
143
|
-
diffDownloadResponse?: GdataDiffDownloadResponse;
|
|
144
|
-
/** Set if reference_type is DIFF_UPLOAD_REQUEST. */
|
|
145
|
-
diffUploadRequest?: GdataDiffUploadRequest;
|
|
146
|
-
/** Set if reference_type is DIFF_UPLOAD_RESPONSE. */
|
|
147
|
-
diffUploadResponse?: GdataDiffUploadResponse;
|
|
148
|
-
/** Set if reference_type is DIFF_VERSION_RESPONSE. */
|
|
149
|
-
diffVersionResponse?: GdataDiffVersionResponse;
|
|
150
|
-
/** Parameters for a media download. */
|
|
151
|
-
downloadParameters?: GdataDownloadParameters;
|
|
152
|
-
/** Original file name */
|
|
153
|
-
filename?: string;
|
|
154
|
-
/** Deprecated, use one of explicit hash type fields instead. These two hash related fields will only be populated on Scotty based media uploads and will contain the content of the hash group in the NotificationRequest: http://cs/#google3/blobstore2/api/scotty/service/proto/upload_listener.proto&q=class:Hash Hex encoded hash value of the uploaded media. */
|
|
155
|
-
hash?: string;
|
|
156
|
-
/** For Scotty uploads only. If a user sends a hash code and the backend has requested that Scotty verify the upload against the client hash, Scotty will perform the check on behalf of the backend and will reject it if the hashes don't match. This is set to true if Scotty performed this verification. */
|
|
157
|
-
hashVerified?: boolean;
|
|
158
|
-
/** Media data, set if reference_type is INLINE */
|
|
159
|
-
inline?: string;
|
|
160
|
-
/** |is_potential_retry| is set false only when Scotty is certain that it has not sent the request before. When a client resumes an upload, this field must be set true in agent calls, because Scotty cannot be certain that it has never sent the request before due to potential failure in the session state persistence. */
|
|
161
|
-
isPotentialRetry?: boolean;
|
|
162
|
-
/** Size of the data, in bytes */
|
|
163
|
-
length?: string;
|
|
164
|
-
/** Scotty-provided MD5 hash for an upload. */
|
|
165
|
-
md5Hash?: string;
|
|
166
|
-
/** Media id to forward to the operation GetMedia. Can be set if reference_type is GET_MEDIA. */
|
|
167
|
-
mediaId?: string;
|
|
168
|
-
/** Reference to a TI Blob, set if reference_type is BIGSTORE_REF. */
|
|
169
|
-
objectId?: GdataObjectId;
|
|
170
|
-
/** Path to the data, set if reference_type is PATH */
|
|
171
|
-
path?: string;
|
|
172
|
-
/** Describes what the field reference contains. */
|
|
173
|
-
referenceType?: string;
|
|
174
|
-
/** Scotty-provided SHA1 hash for an upload. */
|
|
175
|
-
sha1Hash?: string;
|
|
176
|
-
/** Scotty-provided SHA256 hash for an upload. */
|
|
177
|
-
sha256Hash?: string;
|
|
178
|
-
/** Time at which the media data was last updated, in milliseconds since UNIX epoch */
|
|
179
|
-
timestamp?: string;
|
|
180
|
-
/** A unique fingerprint/version id for the media data */
|
|
181
|
-
token?: string;
|
|
182
|
-
}
|
|
183
|
-
interface GdataObjectId {
|
|
184
|
-
/** The name of the bucket to which this object belongs. */
|
|
185
|
-
bucketName?: string;
|
|
186
|
-
/** Generation of the object. Generations are monotonically increasing across writes, allowing them to be be compared to determine which generation is newer. If this is omitted in a request, then you are requesting the live object. See http://go/bigstore-versions */
|
|
187
|
-
generation?: string;
|
|
188
|
-
/** The name of the object. */
|
|
189
|
-
objectName?: string;
|
|
190
|
-
}
|
|
191
31
|
interface GoogleApiDistribution {
|
|
192
32
|
/** The number of values in each bucket of the histogram, as described in `bucket_options`. If the distribution does not have a histogram, then omit this field. If there is a histogram, then the sum of the values in `bucket_counts` must equal the value in the `count` field of the distribution. If present, `bucket_counts` should contain N values, where N is the number of buckets specified in `bucket_options`. If you supply fewer than N values, the remaining values are assumed to be 0. The order of the values in `bucket_counts` follows the bucket numbering schemes described for the three bucket types. The first value must be the count for the underflow bucket (number 0). The next N-2 values are the counts for the finite buckets (number 1 through N-2). The N'th value in `bucket_counts` is the count for the overflow bucket (number N-1). */
|
|
193
33
|
bucketCounts?: string[];
|
|
@@ -1481,6 +1321,8 @@ declare namespace gapi.client {
|
|
|
1481
1321
|
tuningOperation?: string;
|
|
1482
1322
|
}
|
|
1483
1323
|
interface GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig {
|
|
1324
|
+
/** Optional. The required subscription tier of this engine. They cannot be modified after engine creation. If the required subscription tier is search, user with higher license tier like assist can still access the standalone app associated with this engine. */
|
|
1325
|
+
requiredSubscriptionTier?: string;
|
|
1484
1326
|
/** The add-on that this search engine enables. */
|
|
1485
1327
|
searchAddOns?: string[];
|
|
1486
1328
|
/** The search feature tier of this engine. Different tiers might have different pricing. To learn more, check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified. */
|
|
@@ -2014,6 +1856,8 @@ declare namespace gapi.client {
|
|
|
2014
1856
|
canonicalFilter?: string;
|
|
2015
1857
|
/** A specification for configuring the behavior of content search. */
|
|
2016
1858
|
contentSearchSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec;
|
|
1859
|
+
/** Optional. Crowding specifications for improving result diversity. If multiple CrowdingSpecs are specified, crowding will be evaluated on each unique combination of the `field` values, and max_count will be the maximum value of `max_count` across all CrowdingSpecs. For example, if the first CrowdingSpec has `field` = "color" and `max_count` = 3, and the second CrowdingSpec has `field` = "size" and `max_count` = 2, then after 3 documents that share the same color AND size have been returned, subsequent ones should be removed or demoted. */
|
|
1860
|
+
crowdingSpecs?: GoogleCloudDiscoveryengineV1alphaSearchRequestCrowdingSpec[];
|
|
2017
1861
|
/** Custom fine tuning configs. If set, it has higher priority than the configs set in ServingConfig.custom_fine_tuning_spec. */
|
|
2018
1862
|
customFineTuningSpec?: GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec;
|
|
2019
1863
|
/** Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used. */
|
|
@@ -2038,6 +1882,8 @@ declare namespace gapi.client {
|
|
|
2038
1882
|
oneBoxPageSize?: number;
|
|
2039
1883
|
/** The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. */
|
|
2040
1884
|
orderBy?: string;
|
|
1885
|
+
/** Optional. The categories associated with a category page. Must be set for category navigation queries to achieve good search quality. The format should be the same as UserEvent.PageInfo.page_category. This field is the equivalent of the query for browse (navigation) queries. It's used by the browse model when the query is empty. If the field is empty, it will not be used by the browse model. To represent full path of a category, use '>' character to separate different hierarchies. If '>' is part of the category name, replace it with other character(s). For example, `Graphics Cards > RTX>4090 > Founders Edition` where "RTX > 4090" represents one level, can be rewritten as `Graphics Cards > RTX_4090 > Founders Edition` */
|
|
1886
|
+
pageCategories?: string[];
|
|
2041
1887
|
/** Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned. */
|
|
2042
1888
|
pageSize?: number;
|
|
2043
1889
|
/** A page token received from a previous SearchService.Search call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SearchService.Search must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. */
|
|
@@ -2185,6 +2031,14 @@ declare namespace gapi.client {
|
|
|
2185
2031
|
/** Optional. Source of image returned in the answer. */
|
|
2186
2032
|
imageSource?: string;
|
|
2187
2033
|
}
|
|
2034
|
+
interface GoogleCloudDiscoveryengineV1alphaSearchRequestCrowdingSpec {
|
|
2035
|
+
/** The field to use for crowding. Documents can be crowded by a field in the Document object. Crowding field is case sensitive. */
|
|
2036
|
+
field?: string;
|
|
2037
|
+
/** The maximum number of documents to keep per value of the field. Once there are at least max_count previous results which contain the same value for the given field (according to the order specified in `order_by`), later results with the same value are "crowded away". If not specified, the default value is 1. */
|
|
2038
|
+
maxCount?: number;
|
|
2039
|
+
/** Mode to use for documents that are crowded away. */
|
|
2040
|
+
mode?: string;
|
|
2041
|
+
}
|
|
2188
2042
|
interface GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec {
|
|
2189
2043
|
/** Optional. Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) */
|
|
2190
2044
|
boostSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec;
|
|
@@ -2505,6 +2359,10 @@ declare namespace gapi.client {
|
|
|
2505
2359
|
interface GoogleCloudDiscoveryengineV1Assistant {
|
|
2506
2360
|
/** Optional. Customer policy for the assistant. */
|
|
2507
2361
|
customerPolicy?: GoogleCloudDiscoveryengineV1AssistantCustomerPolicy;
|
|
2362
|
+
/** Optional. Description for additional information. Expected to be shown on the configuration UI, not to the users of the assistant. */
|
|
2363
|
+
description?: string;
|
|
2364
|
+
/** Required. The assistant display name. It must be a UTF-8 encoded string with a length limit of 128 characters. */
|
|
2365
|
+
displayName?: string;
|
|
2508
2366
|
/** Optional. Note: not implemented yet. Use enabled_actions instead. The enabled tools on this assistant. The keys are connector name, for example "projects/{projectId}/locations/{locationId}/collections/{collectionId}/dataconnector The values consist of admin enabled tools towards the connector instance. Admin can selectively enable multiple tools on any of the connector instances that they created in the project. For example {"jira1ConnectorName": [(toolId1, "createTicket"), (toolId2, "transferTicket")], "gmail1ConnectorName": [(toolId3, "sendEmail"),..] } */
|
|
2509
2367
|
enabledTools?: {
|
|
2510
2368
|
[P in string]: GoogleCloudDiscoveryengineV1AssistantToolList;
|
|
@@ -2539,8 +2397,12 @@ declare namespace gapi.client {
|
|
|
2539
2397
|
userPromptTemplate?: string;
|
|
2540
2398
|
}
|
|
2541
2399
|
interface GoogleCloudDiscoveryengineV1AssistantGenerationConfig {
|
|
2400
|
+
/** Optional. The list of models that are allowed to be used for assistant. */
|
|
2401
|
+
allowedModelIds?: string[];
|
|
2542
2402
|
/** The default language to use for the generation of the assistant response. Use an ISO 639-1 language code such as `en`. If not specified, the language will be automatically detected. */
|
|
2543
2403
|
defaultLanguage?: string;
|
|
2404
|
+
/** Optional. The default model to use for assistant. */
|
|
2405
|
+
defaultModelId?: string;
|
|
2544
2406
|
/** System instruction, also known as the prompt preamble for LLM calls. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/prompts/system-instructions */
|
|
2545
2407
|
systemInstruction?: GoogleCloudDiscoveryengineV1AssistantGenerationConfigSystemInstruction;
|
|
2546
2408
|
}
|
|
@@ -3179,6 +3041,10 @@ declare namespace gapi.client {
|
|
|
3179
3041
|
interface GoogleCloudDiscoveryengineV1betaAssistant {
|
|
3180
3042
|
/** Optional. Customer policy for the assistant. */
|
|
3181
3043
|
customerPolicy?: GoogleCloudDiscoveryengineV1betaAssistantCustomerPolicy;
|
|
3044
|
+
/** Optional. Description for additional information. Expected to be shown on the configuration UI, not to the users of the assistant. */
|
|
3045
|
+
description?: string;
|
|
3046
|
+
/** Required. The assistant display name. It must be a UTF-8 encoded string with a length limit of 128 characters. */
|
|
3047
|
+
displayName?: string;
|
|
3182
3048
|
/** Optional. Note: not implemented yet. Use enabled_actions instead. The enabled tools on this assistant. The keys are connector name, for example "projects/{projectId}/locations/{locationId}/collections/{collectionId}/dataconnector The values consist of admin enabled tools towards the connector instance. Admin can selectively enable multiple tools on any of the connector instances that they created in the project. For example {"jira1ConnectorName": [(toolId1, "createTicket"), (toolId2, "transferTicket")], "gmail1ConnectorName": [(toolId3, "sendEmail"),..] } */
|
|
3183
3049
|
enabledTools?: {
|
|
3184
3050
|
[P in string]: GoogleCloudDiscoveryengineV1betaAssistantToolList;
|
|
@@ -3251,8 +3117,12 @@ declare namespace gapi.client {
|
|
|
3251
3117
|
userPromptTemplate?: string;
|
|
3252
3118
|
}
|
|
3253
3119
|
interface GoogleCloudDiscoveryengineV1betaAssistantGenerationConfig {
|
|
3120
|
+
/** Optional. The list of models that are allowed to be used for assistant. */
|
|
3121
|
+
allowedModelIds?: string[];
|
|
3254
3122
|
/** The default language to use for the generation of the assistant response. Use an ISO 639-1 language code such as `en`. If not specified, the language will be automatically detected. */
|
|
3255
3123
|
defaultLanguage?: string;
|
|
3124
|
+
/** Optional. The default model to use for assistant. */
|
|
3125
|
+
defaultModelId?: string;
|
|
3256
3126
|
/** System instruction, also known as the prompt preamble for LLM calls. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/prompts/system-instructions */
|
|
3257
3127
|
systemInstruction?: GoogleCloudDiscoveryengineV1betaAssistantGenerationConfigSystemInstruction;
|
|
3258
3128
|
}
|
|
@@ -4190,6 +4060,8 @@ declare namespace gapi.client {
|
|
|
4190
4060
|
contextEventType?: string;
|
|
4191
4061
|
}
|
|
4192
4062
|
interface GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig {
|
|
4063
|
+
/** Optional. The required subscription tier of this engine. They cannot be modified after engine creation. If the required subscription tier is search, user with higher license tier like assist can still access the standalone app associated with this engine. */
|
|
4064
|
+
requiredSubscriptionTier?: string;
|
|
4193
4065
|
/** The add-on that this search engine enables. */
|
|
4194
4066
|
searchAddOns?: string[];
|
|
4195
4067
|
/** The search feature tier of this engine. Different tiers might have different pricing. To learn more, check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified. */
|
|
@@ -4296,6 +4168,8 @@ declare namespace gapi.client {
|
|
|
4296
4168
|
interface GoogleCloudDiscoveryengineV1betaIdentityMappingEntry {
|
|
4297
4169
|
/** Required. Identity outside the customer identity provider. The length limit of external identity will be of 100 characters. */
|
|
4298
4170
|
externalIdentity?: string;
|
|
4171
|
+
/** Optional. The name of the external identity. */
|
|
4172
|
+
externalIdentityName?: string;
|
|
4299
4173
|
/** Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider, group_id is the mapped group identifier configured during the workforcepool config. */
|
|
4300
4174
|
groupId?: string;
|
|
4301
4175
|
/** User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider, user_id is the mapped user identifier configured during the workforcepool config. */
|
|
@@ -4565,6 +4439,12 @@ declare namespace gapi.client {
|
|
|
4565
4439
|
/** Required. The number of licenses used. */
|
|
4566
4440
|
usedLicenseCount?: string;
|
|
4567
4441
|
}
|
|
4442
|
+
interface GoogleCloudDiscoveryengineV1betaListAssistantsResponse {
|
|
4443
|
+
/** All the customer's Assistants. */
|
|
4444
|
+
assistants?: GoogleCloudDiscoveryengineV1betaAssistant[];
|
|
4445
|
+
/** A token that can be sent as ListAssistantsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages. */
|
|
4446
|
+
nextPageToken?: string;
|
|
4447
|
+
}
|
|
4568
4448
|
interface GoogleCloudDiscoveryengineV1betaListCmekConfigsResponse {
|
|
4569
4449
|
/** All the customer's CmekConfigs. */
|
|
4570
4450
|
cmekConfigs?: GoogleCloudDiscoveryengineV1betaCmekConfig[];
|
|
@@ -5106,6 +4986,8 @@ declare namespace gapi.client {
|
|
|
5106
4986
|
canonicalFilter?: string;
|
|
5107
4987
|
/** A specification for configuring the behavior of content search. */
|
|
5108
4988
|
contentSearchSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec;
|
|
4989
|
+
/** Optional. Crowding specifications for improving result diversity. If multiple CrowdingSpecs are specified, crowding will be evaluated on each unique combination of the `field` values, and max_count will be the maximum value of `max_count` across all CrowdingSpecs. For example, if the first CrowdingSpec has `field` = "color" and `max_count` = 3, and the second CrowdingSpec has `field` = "size" and `max_count` = 2, then after 3 documents that share the same color AND size have been returned, subsequent ones should be removed or demoted. */
|
|
4990
|
+
crowdingSpecs?: GoogleCloudDiscoveryengineV1betaSearchRequestCrowdingSpec[];
|
|
5109
4991
|
/** Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used. */
|
|
5110
4992
|
dataStoreSpecs?: GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec[];
|
|
5111
4993
|
/** Optional. Config for display feature, like match highlighting on search results. */
|
|
@@ -5128,6 +5010,8 @@ declare namespace gapi.client {
|
|
|
5128
5010
|
oneBoxPageSize?: number;
|
|
5129
5011
|
/** The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. */
|
|
5130
5012
|
orderBy?: string;
|
|
5013
|
+
/** Optional. The categories associated with a category page. Must be set for category navigation queries to achieve good search quality. The format should be the same as UserEvent.PageInfo.page_category. This field is the equivalent of the query for browse (navigation) queries. It's used by the browse model when the query is empty. If the field is empty, it will not be used by the browse model. To represent full path of a category, use '>' character to separate different hierarchies. If '>' is part of the category name, replace it with other character(s). For example, `Graphics Cards > RTX>4090 > Founders Edition` where "RTX > 4090" represents one level, can be rewritten as `Graphics Cards > RTX_4090 > Founders Edition` */
|
|
5014
|
+
pageCategories?: string[];
|
|
5131
5015
|
/** Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned. */
|
|
5132
5016
|
pageSize?: number;
|
|
5133
5017
|
/** A page token received from a previous SearchService.Search call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SearchService.Search must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. */
|
|
@@ -5273,6 +5157,14 @@ declare namespace gapi.client {
|
|
|
5273
5157
|
/** Optional. Source of image returned in the answer. */
|
|
5274
5158
|
imageSource?: string;
|
|
5275
5159
|
}
|
|
5160
|
+
interface GoogleCloudDiscoveryengineV1betaSearchRequestCrowdingSpec {
|
|
5161
|
+
/** The field to use for crowding. Documents can be crowded by a field in the Document object. Crowding field is case sensitive. */
|
|
5162
|
+
field?: string;
|
|
5163
|
+
/** The maximum number of documents to keep per value of the field. Once there are at least max_count previous results which contain the same value for the given field (according to the order specified in `order_by`), later results with the same value are "crowded away". If not specified, the default value is 1. */
|
|
5164
|
+
maxCount?: number;
|
|
5165
|
+
/** Mode to use for documents that are crowded away. */
|
|
5166
|
+
mode?: string;
|
|
5167
|
+
}
|
|
5276
5168
|
interface GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec {
|
|
5277
5169
|
/** Optional. Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) */
|
|
5278
5170
|
boostSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec;
|
|
@@ -5399,6 +5291,8 @@ declare namespace gapi.client {
|
|
|
5399
5291
|
results?: GoogleCloudDiscoveryengineV1betaSearchResponseSearchResult[];
|
|
5400
5292
|
/** Promotions for site search. */
|
|
5401
5293
|
searchLinkPromotions?: GoogleCloudDiscoveryengineV1betaSearchLinkPromotion[];
|
|
5294
|
+
/** Output only. Indicates the semantic state of the search response. */
|
|
5295
|
+
semanticState?: string;
|
|
5402
5296
|
/** Session information. Only set if SearchRequest.session is provided. See its description for more details. */
|
|
5403
5297
|
sessionInfo?: GoogleCloudDiscoveryengineV1betaSearchResponseSessionInfo;
|
|
5404
5298
|
/** Corrected query with low confidence, AKA did you mean query. Compared with corrected_query, this field is set when SpellCorrector returned a response, but FPR(full page replacement) is not triggered because the corrction is of low confidence(eg, reversed because there are matches of the original query in document corpus). */
|
|
@@ -5824,6 +5718,8 @@ declare namespace gapi.client {
|
|
|
5824
5718
|
answer?: GoogleCloudDiscoveryengineV1betaAssistAnswer;
|
|
5825
5719
|
/** A global unique ID that identifies the current pair of request and stream of responses. Used for feedback and support. */
|
|
5826
5720
|
assistToken?: string;
|
|
5721
|
+
/** The tool names of the tools that were invoked. */
|
|
5722
|
+
invocationTools?: string[];
|
|
5827
5723
|
/** Session information. Only included in the final StreamAssistResponse of the response stream. */
|
|
5828
5724
|
sessionInfo?: GoogleCloudDiscoveryengineV1betaStreamAssistResponseSessionInfo;
|
|
5829
5725
|
}
|
|
@@ -6605,6 +6501,8 @@ declare namespace gapi.client {
|
|
|
6605
6501
|
contextEventType?: string;
|
|
6606
6502
|
}
|
|
6607
6503
|
interface GoogleCloudDiscoveryengineV1EngineSearchEngineConfig {
|
|
6504
|
+
/** Optional. The required subscription tier of this engine. They cannot be modified after engine creation. If the required subscription tier is search, user with higher license tier like assist can still access the standalone app associated with this engine. */
|
|
6505
|
+
requiredSubscriptionTier?: string;
|
|
6608
6506
|
/** The add-on that this search engine enables. */
|
|
6609
6507
|
searchAddOns?: string[];
|
|
6610
6508
|
/** The search feature tier of this engine. Different tiers might have different pricing. To learn more, check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified. */
|
|
@@ -7118,7 +7016,7 @@ declare namespace gapi.client {
|
|
|
7118
7016
|
nextPageToken?: string;
|
|
7119
7017
|
/** A list of operations that matches the specified filter in the request. */
|
|
7120
7018
|
operations?: GoogleLongrunningOperation[];
|
|
7121
|
-
/** Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections
|
|
7019
|
+
/** Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations. */
|
|
7122
7020
|
unreachable?: string[];
|
|
7123
7021
|
}
|
|
7124
7022
|
interface GoogleLongrunningOperation {
|
|
@@ -7218,39 +7116,6 @@ declare namespace gapi.client {
|
|
|
7218
7116
|
/** Optional. IANA Time Zone Database version number. For example "2019a". */
|
|
7219
7117
|
version?: string;
|
|
7220
7118
|
}
|
|
7221
|
-
interface MediaResource {
|
|
7222
|
-
/** Downloads a file from the session. */
|
|
7223
|
-
download(request?: {
|
|
7224
|
-
/** V1 error format. */
|
|
7225
|
-
'$.xgafv'?: string;
|
|
7226
|
-
/** OAuth access token. */
|
|
7227
|
-
access_token?: string;
|
|
7228
|
-
/** Data format for response. */
|
|
7229
|
-
alt?: string;
|
|
7230
|
-
/** JSONP */
|
|
7231
|
-
callback?: string;
|
|
7232
|
-
/** Selector specifying which fields to include in a partial response. */
|
|
7233
|
-
fields?: string;
|
|
7234
|
-
/** Required. The ID of the file to be downloaded. */
|
|
7235
|
-
fileId?: string;
|
|
7236
|
-
/** 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. */
|
|
7237
|
-
key?: string;
|
|
7238
|
-
/** Required. The resource name of the Session. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}` */
|
|
7239
|
-
name: string;
|
|
7240
|
-
/** OAuth 2.0 token for the current user. */
|
|
7241
|
-
oauth_token?: string;
|
|
7242
|
-
/** Returns response with indentations and line breaks. */
|
|
7243
|
-
prettyPrint?: boolean;
|
|
7244
|
-
/** 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. */
|
|
7245
|
-
quotaUser?: string;
|
|
7246
|
-
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
7247
|
-
upload_protocol?: string;
|
|
7248
|
-
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
7249
|
-
uploadType?: string;
|
|
7250
|
-
/** Optional. The ID of the view to be downloaded. */
|
|
7251
|
-
viewId?: string;
|
|
7252
|
-
}): Request<GdataMedia>;
|
|
7253
|
-
}
|
|
7254
7119
|
interface CmekConfigsResource {
|
|
7255
7120
|
/** De-provisions a CmekConfig. */
|
|
7256
7121
|
delete(request?: {
|
|
@@ -7452,7 +7317,7 @@ declare namespace gapi.client {
|
|
|
7452
7317
|
prettyPrint?: boolean;
|
|
7453
7318
|
/** 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. */
|
|
7454
7319
|
quotaUser?: string;
|
|
7455
|
-
/** When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
7320
|
+
/** When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. */
|
|
7456
7321
|
returnPartialSuccess?: boolean;
|
|
7457
7322
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
7458
7323
|
upload_protocol?: string;
|
|
@@ -7908,7 +7773,7 @@ declare namespace gapi.client {
|
|
|
7908
7773
|
prettyPrint?: boolean;
|
|
7909
7774
|
/** 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. */
|
|
7910
7775
|
quotaUser?: string;
|
|
7911
|
-
/** When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
7776
|
+
/** When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. */
|
|
7912
7777
|
returnPartialSuccess?: boolean;
|
|
7913
7778
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
7914
7779
|
upload_protocol?: string;
|
|
@@ -8696,7 +8561,7 @@ declare namespace gapi.client {
|
|
|
8696
8561
|
prettyPrint?: boolean;
|
|
8697
8562
|
/** 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. */
|
|
8698
8563
|
quotaUser?: string;
|
|
8699
|
-
/** When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
8564
|
+
/** When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. */
|
|
8700
8565
|
returnPartialSuccess?: boolean;
|
|
8701
8566
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
8702
8567
|
upload_protocol?: string;
|
|
@@ -8763,7 +8628,7 @@ declare namespace gapi.client {
|
|
|
8763
8628
|
prettyPrint?: boolean;
|
|
8764
8629
|
/** 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. */
|
|
8765
8630
|
quotaUser?: string;
|
|
8766
|
-
/** When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
8631
|
+
/** When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. */
|
|
8767
8632
|
returnPartialSuccess?: boolean;
|
|
8768
8633
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
8769
8634
|
upload_protocol?: string;
|
|
@@ -8827,7 +8692,7 @@ declare namespace gapi.client {
|
|
|
8827
8692
|
prettyPrint?: boolean;
|
|
8828
8693
|
/** 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. */
|
|
8829
8694
|
quotaUser?: string;
|
|
8830
|
-
/** When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
8695
|
+
/** When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. */
|
|
8831
8696
|
returnPartialSuccess?: boolean;
|
|
8832
8697
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
8833
8698
|
upload_protocol?: string;
|
|
@@ -9758,7 +9623,7 @@ declare namespace gapi.client {
|
|
|
9758
9623
|
prettyPrint?: boolean;
|
|
9759
9624
|
/** 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. */
|
|
9760
9625
|
quotaUser?: string;
|
|
9761
|
-
/** When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
9626
|
+
/** When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. */
|
|
9762
9627
|
returnPartialSuccess?: boolean;
|
|
9763
9628
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
9764
9629
|
upload_protocol?: string;
|
|
@@ -9938,7 +9803,7 @@ declare namespace gapi.client {
|
|
|
9938
9803
|
prettyPrint?: boolean;
|
|
9939
9804
|
/** 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. */
|
|
9940
9805
|
quotaUser?: string;
|
|
9941
|
-
/** When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
9806
|
+
/** When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. */
|
|
9942
9807
|
returnPartialSuccess?: boolean;
|
|
9943
9808
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
9944
9809
|
upload_protocol?: string;
|
|
@@ -11170,7 +11035,128 @@ declare namespace gapi.client {
|
|
|
11170
11035
|
suggestionDenyListEntries: SuggestionDenyListEntriesResource;
|
|
11171
11036
|
userEvents: UserEventsResource;
|
|
11172
11037
|
}
|
|
11038
|
+
interface OperationsResource {
|
|
11039
|
+
/** 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. */
|
|
11040
|
+
get(request?: {
|
|
11041
|
+
/** V1 error format. */
|
|
11042
|
+
'$.xgafv'?: string;
|
|
11043
|
+
/** OAuth access token. */
|
|
11044
|
+
access_token?: string;
|
|
11045
|
+
/** Data format for response. */
|
|
11046
|
+
alt?: string;
|
|
11047
|
+
/** JSONP */
|
|
11048
|
+
callback?: string;
|
|
11049
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
11050
|
+
fields?: string;
|
|
11051
|
+
/** 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. */
|
|
11052
|
+
key?: string;
|
|
11053
|
+
/** The name of the operation resource. */
|
|
11054
|
+
name: string;
|
|
11055
|
+
/** OAuth 2.0 token for the current user. */
|
|
11056
|
+
oauth_token?: string;
|
|
11057
|
+
/** Returns response with indentations and line breaks. */
|
|
11058
|
+
prettyPrint?: boolean;
|
|
11059
|
+
/** 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. */
|
|
11060
|
+
quotaUser?: string;
|
|
11061
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
11062
|
+
upload_protocol?: string;
|
|
11063
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
11064
|
+
uploadType?: string;
|
|
11065
|
+
}): Request<GoogleLongrunningOperation>;
|
|
11066
|
+
}
|
|
11067
|
+
interface AgentsResource {
|
|
11068
|
+
operations: OperationsResource;
|
|
11069
|
+
}
|
|
11173
11070
|
interface AssistantsResource {
|
|
11071
|
+
/** Creates an Assistant. */
|
|
11072
|
+
create(request: {
|
|
11073
|
+
/** V1 error format. */
|
|
11074
|
+
'$.xgafv'?: string;
|
|
11075
|
+
/** OAuth access token. */
|
|
11076
|
+
access_token?: string;
|
|
11077
|
+
/** Data format for response. */
|
|
11078
|
+
alt?: string;
|
|
11079
|
+
/** Required. The ID to use for the Assistant, which will become the final component of the Assistant's resource name. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) with a length limit of 63 characters. */
|
|
11080
|
+
assistantId?: string;
|
|
11081
|
+
/** JSONP */
|
|
11082
|
+
callback?: string;
|
|
11083
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
11084
|
+
fields?: string;
|
|
11085
|
+
/** 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. */
|
|
11086
|
+
key?: string;
|
|
11087
|
+
/** OAuth 2.0 token for the current user. */
|
|
11088
|
+
oauth_token?: string;
|
|
11089
|
+
/** Required. The parent resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` */
|
|
11090
|
+
parent: string;
|
|
11091
|
+
/** Returns response with indentations and line breaks. */
|
|
11092
|
+
prettyPrint?: boolean;
|
|
11093
|
+
/** 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. */
|
|
11094
|
+
quotaUser?: string;
|
|
11095
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
11096
|
+
upload_protocol?: string;
|
|
11097
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
11098
|
+
uploadType?: string;
|
|
11099
|
+
/** Request body */
|
|
11100
|
+
resource: GoogleCloudDiscoveryengineV1betaAssistant;
|
|
11101
|
+
}): Request<GoogleCloudDiscoveryengineV1betaAssistant>;
|
|
11102
|
+
create(
|
|
11103
|
+
request: {
|
|
11104
|
+
/** V1 error format. */
|
|
11105
|
+
'$.xgafv'?: string;
|
|
11106
|
+
/** OAuth access token. */
|
|
11107
|
+
access_token?: string;
|
|
11108
|
+
/** Data format for response. */
|
|
11109
|
+
alt?: string;
|
|
11110
|
+
/** Required. The ID to use for the Assistant, which will become the final component of the Assistant's resource name. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) with a length limit of 63 characters. */
|
|
11111
|
+
assistantId?: string;
|
|
11112
|
+
/** JSONP */
|
|
11113
|
+
callback?: string;
|
|
11114
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
11115
|
+
fields?: string;
|
|
11116
|
+
/** 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. */
|
|
11117
|
+
key?: string;
|
|
11118
|
+
/** OAuth 2.0 token for the current user. */
|
|
11119
|
+
oauth_token?: string;
|
|
11120
|
+
/** Required. The parent resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` */
|
|
11121
|
+
parent: string;
|
|
11122
|
+
/** Returns response with indentations and line breaks. */
|
|
11123
|
+
prettyPrint?: boolean;
|
|
11124
|
+
/** 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. */
|
|
11125
|
+
quotaUser?: string;
|
|
11126
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
11127
|
+
upload_protocol?: string;
|
|
11128
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
11129
|
+
uploadType?: string;
|
|
11130
|
+
},
|
|
11131
|
+
body: GoogleCloudDiscoveryengineV1betaAssistant,
|
|
11132
|
+
): Request<GoogleCloudDiscoveryengineV1betaAssistant>;
|
|
11133
|
+
/** Deletes an Assistant. */
|
|
11134
|
+
delete(request?: {
|
|
11135
|
+
/** V1 error format. */
|
|
11136
|
+
'$.xgafv'?: string;
|
|
11137
|
+
/** OAuth access token. */
|
|
11138
|
+
access_token?: string;
|
|
11139
|
+
/** Data format for response. */
|
|
11140
|
+
alt?: string;
|
|
11141
|
+
/** JSONP */
|
|
11142
|
+
callback?: string;
|
|
11143
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
11144
|
+
fields?: string;
|
|
11145
|
+
/** 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. */
|
|
11146
|
+
key?: string;
|
|
11147
|
+
/** Required. Resource name of Assistant. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}` If the caller does not have permission to delete the Assistant, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the Assistant to delete does not exist, a NOT_FOUND error is returned. */
|
|
11148
|
+
name: string;
|
|
11149
|
+
/** OAuth 2.0 token for the current user. */
|
|
11150
|
+
oauth_token?: string;
|
|
11151
|
+
/** Returns response with indentations and line breaks. */
|
|
11152
|
+
prettyPrint?: boolean;
|
|
11153
|
+
/** 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. */
|
|
11154
|
+
quotaUser?: string;
|
|
11155
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
11156
|
+
upload_protocol?: string;
|
|
11157
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
11158
|
+
uploadType?: string;
|
|
11159
|
+
}): Request<{}>;
|
|
11174
11160
|
/** Gets an Assistant. */
|
|
11175
11161
|
get(request?: {
|
|
11176
11162
|
/** V1 error format. */
|
|
@@ -11198,6 +11184,37 @@ declare namespace gapi.client {
|
|
|
11198
11184
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
11199
11185
|
uploadType?: string;
|
|
11200
11186
|
}): Request<GoogleCloudDiscoveryengineV1betaAssistant>;
|
|
11187
|
+
/** Lists all Assistants under an Engine. */
|
|
11188
|
+
list(request?: {
|
|
11189
|
+
/** V1 error format. */
|
|
11190
|
+
'$.xgafv'?: string;
|
|
11191
|
+
/** OAuth access token. */
|
|
11192
|
+
access_token?: string;
|
|
11193
|
+
/** Data format for response. */
|
|
11194
|
+
alt?: string;
|
|
11195
|
+
/** JSONP */
|
|
11196
|
+
callback?: string;
|
|
11197
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
11198
|
+
fields?: string;
|
|
11199
|
+
/** 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. */
|
|
11200
|
+
key?: string;
|
|
11201
|
+
/** OAuth 2.0 token for the current user. */
|
|
11202
|
+
oauth_token?: string;
|
|
11203
|
+
/** Maximum number of Assistants to return. If unspecified, defaults to 100. The maximum allowed value is 1000; anything above that will be coerced down to 1000. */
|
|
11204
|
+
pageSize?: number;
|
|
11205
|
+
/** A page token ListAssistantsResponse.next_page_token, received from a previous AssistantService.ListAssistants call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListAssistants must match the call that provided the page token. */
|
|
11206
|
+
pageToken?: string;
|
|
11207
|
+
/** Required. The parent resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` */
|
|
11208
|
+
parent: string;
|
|
11209
|
+
/** Returns response with indentations and line breaks. */
|
|
11210
|
+
prettyPrint?: boolean;
|
|
11211
|
+
/** 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. */
|
|
11212
|
+
quotaUser?: string;
|
|
11213
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
11214
|
+
upload_protocol?: string;
|
|
11215
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
11216
|
+
uploadType?: string;
|
|
11217
|
+
}): Request<GoogleCloudDiscoveryengineV1betaListAssistantsResponse>;
|
|
11201
11218
|
/** Updates an Assistant */
|
|
11202
11219
|
patch(request: {
|
|
11203
11220
|
/** V1 error format. */
|
|
@@ -11318,6 +11335,7 @@ declare namespace gapi.client {
|
|
|
11318
11335
|
},
|
|
11319
11336
|
body: GoogleCloudDiscoveryengineV1betaStreamAssistRequest,
|
|
11320
11337
|
): Request<GoogleCloudDiscoveryengineV1betaStreamAssistResponse>;
|
|
11338
|
+
agents: AgentsResource;
|
|
11321
11339
|
}
|
|
11322
11340
|
interface CompletionConfigResource {
|
|
11323
11341
|
/** Completes the user input with advanced keyword suggestions. */
|
|
@@ -11975,7 +11993,7 @@ declare namespace gapi.client {
|
|
|
11975
11993
|
prettyPrint?: boolean;
|
|
11976
11994
|
/** 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. */
|
|
11977
11995
|
quotaUser?: string;
|
|
11978
|
-
/** When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
11996
|
+
/** When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. */
|
|
11979
11997
|
returnPartialSuccess?: boolean;
|
|
11980
11998
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
11981
11999
|
upload_protocol?: string;
|
|
@@ -13088,7 +13106,7 @@ declare namespace gapi.client {
|
|
|
13088
13106
|
prettyPrint?: boolean;
|
|
13089
13107
|
/** 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. */
|
|
13090
13108
|
quotaUser?: string;
|
|
13091
|
-
/** When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
13109
|
+
/** When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. */
|
|
13092
13110
|
returnPartialSuccess?: boolean;
|
|
13093
13111
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
13094
13112
|
upload_protocol?: string;
|
|
@@ -13547,7 +13565,7 @@ declare namespace gapi.client {
|
|
|
13547
13565
|
prettyPrint?: boolean;
|
|
13548
13566
|
/** 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. */
|
|
13549
13567
|
quotaUser?: string;
|
|
13550
|
-
/** When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
13568
|
+
/** When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. */
|
|
13551
13569
|
returnPartialSuccess?: boolean;
|
|
13552
13570
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
13553
13571
|
upload_protocol?: string;
|
|
@@ -14306,7 +14324,7 @@ declare namespace gapi.client {
|
|
|
14306
14324
|
prettyPrint?: boolean;
|
|
14307
14325
|
/** 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. */
|
|
14308
14326
|
quotaUser?: string;
|
|
14309
|
-
/** When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
14327
|
+
/** When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. */
|
|
14310
14328
|
returnPartialSuccess?: boolean;
|
|
14311
14329
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
14312
14330
|
upload_protocol?: string;
|
|
@@ -14373,7 +14391,7 @@ declare namespace gapi.client {
|
|
|
14373
14391
|
prettyPrint?: boolean;
|
|
14374
14392
|
/** 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. */
|
|
14375
14393
|
quotaUser?: string;
|
|
14376
|
-
/** When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
14394
|
+
/** When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. */
|
|
14377
14395
|
returnPartialSuccess?: boolean;
|
|
14378
14396
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
14379
14397
|
upload_protocol?: string;
|
|
@@ -16732,7 +16750,7 @@ declare namespace gapi.client {
|
|
|
16732
16750
|
prettyPrint?: boolean;
|
|
16733
16751
|
/** 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. */
|
|
16734
16752
|
quotaUser?: string;
|
|
16735
|
-
/** When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
16753
|
+
/** When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. */
|
|
16736
16754
|
returnPartialSuccess?: boolean;
|
|
16737
16755
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
16738
16756
|
upload_protocol?: string;
|
|
@@ -17254,7 +17272,7 @@ declare namespace gapi.client {
|
|
|
17254
17272
|
prettyPrint?: boolean;
|
|
17255
17273
|
/** 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. */
|
|
17256
17274
|
quotaUser?: string;
|
|
17257
|
-
/** When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
17275
|
+
/** When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. */
|
|
17258
17276
|
returnPartialSuccess?: boolean;
|
|
17259
17277
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
17260
17278
|
upload_protocol?: string;
|
|
@@ -18062,12 +18080,12 @@ declare namespace gapi.client {
|
|
|
18062
18080
|
callback?: string;
|
|
18063
18081
|
/** Selector specifying which fields to include in a partial response. */
|
|
18064
18082
|
fields?: string;
|
|
18065
|
-
/** Optional. Filter for the list request. Supported fields: * `license`_`assignment`_`state` * `user_principal` * `user_profile` Examples: * `license`_`assignment`_`state = ASSIGNED` to list assigned user licenses. * `license`_`assignment`_`state = NO_LICENSE` to list not licensed users. * `license`_`assignment`_`state = NO_LICENSE_ATTEMPTED_LOGIN` to list users who attempted login but no license assigned. * `license`_`assignment`_`state != NO_LICENSE_ATTEMPTED_LOGIN` to filter out users who attempted login but no license assigned. */
|
|
18066
|
-
filter?: string;
|
|
18067
18083
|
/** 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. */
|
|
18068
18084
|
key?: string;
|
|
18069
18085
|
/** OAuth 2.0 token for the current user. */
|
|
18070
18086
|
oauth_token?: string;
|
|
18087
|
+
/** Optional. The order in which the UserLicenses are listed. The value must be a comma-separated list of fields. Default sorting order is ascending. To specify descending order for a field, append a " desc" suffix. Redundant space characters in the syntax are insignificant. Supported fields: * `license_assignment_state` * `user_principal` * `user_profile` * `last_login_date` * `update_time` If not set, the default ordering is by `user_principal`. Examples: * `user_principal desc` to order by `user_principal` in descending order. * `license_assignment_state` to order by `license_assignment_state` in ascending order. * `last_login_date desc` to order by `last_login_date` in descending order. * `update_time desc` to order by `update_time` in descending order. * `last_login_date desc, user_principal` to order by `last_login_date` in descending order and then by `user_principal` in ascending order. */
|
|
18088
|
+
orderBy?: string;
|
|
18071
18089
|
/** Optional. Requested page size. Server may return fewer items than requested. If unspecified, defaults to 10. The maximum value is 50; values above 50 will be coerced to 50. If this field is negative, an INVALID_ARGUMENT error is returned. */
|
|
18072
18090
|
pageSize?: number;
|
|
18073
18091
|
/** Optional. A page token, received from a previous `ListUserLicenses` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListUserLicenses` must match the call that provided the page token. */
|
|
@@ -18743,7 +18761,7 @@ declare namespace gapi.client {
|
|
|
18743
18761
|
prettyPrint?: boolean;
|
|
18744
18762
|
/** 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. */
|
|
18745
18763
|
quotaUser?: string;
|
|
18746
|
-
/** When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
18764
|
+
/** When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. */
|
|
18747
18765
|
returnPartialSuccess?: boolean;
|
|
18748
18766
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
18749
18767
|
upload_protocol?: string;
|
|
@@ -18814,8 +18832,6 @@ declare namespace gapi.client {
|
|
|
18814
18832
|
operations: OperationsResource;
|
|
18815
18833
|
}
|
|
18816
18834
|
|
|
18817
|
-
const media: MediaResource;
|
|
18818
|
-
|
|
18819
18835
|
const projects: ProjectsResource;
|
|
18820
18836
|
}
|
|
18821
18837
|
}
|
package/package.json
CHANGED
package/readme.md
CHANGED
|
@@ -78,11 +78,6 @@ gapi.auth.authorize(
|
|
|
78
78
|
After that you can use Discovery Engine API resources: <!-- TODO: make this work for multiple namespaces -->
|
|
79
79
|
|
|
80
80
|
```typescript
|
|
81
|
-
/*
|
|
82
|
-
Downloads a file from the session.
|
|
83
|
-
*/
|
|
84
|
-
await gapi.client.discoveryengine.media.download({name: 'name'});
|
|
85
|
-
|
|
86
81
|
/*
|
|
87
82
|
Provisions the project resource. During the process, related systems will get prepared and initialized. Caller must read the [Terms for data use](https://cloud.google.com/retail/data-use-terms), and optionally specify in request to provide consent to that service terms.
|
|
88
83
|
*/
|