@maxim_mazurok/gapi.client.discoveryengine-v1beta 0.1.20251109 → 0.1.20251116
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 +220 -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: 20251116
|
|
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[];
|
|
@@ -2014,6 +1854,8 @@ declare namespace gapi.client {
|
|
|
2014
1854
|
canonicalFilter?: string;
|
|
2015
1855
|
/** A specification for configuring the behavior of content search. */
|
|
2016
1856
|
contentSearchSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec;
|
|
1857
|
+
/** 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. */
|
|
1858
|
+
crowdingSpecs?: GoogleCloudDiscoveryengineV1alphaSearchRequestCrowdingSpec[];
|
|
2017
1859
|
/** Custom fine tuning configs. If set, it has higher priority than the configs set in ServingConfig.custom_fine_tuning_spec. */
|
|
2018
1860
|
customFineTuningSpec?: GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec;
|
|
2019
1861
|
/** 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 +1880,8 @@ declare namespace gapi.client {
|
|
|
2038
1880
|
oneBoxPageSize?: number;
|
|
2039
1881
|
/** 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
1882
|
orderBy?: string;
|
|
1883
|
+
/** 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` */
|
|
1884
|
+
pageCategories?: string[];
|
|
2041
1885
|
/** 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
1886
|
pageSize?: number;
|
|
2043
1887
|
/** 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 +2029,14 @@ declare namespace gapi.client {
|
|
|
2185
2029
|
/** Optional. Source of image returned in the answer. */
|
|
2186
2030
|
imageSource?: string;
|
|
2187
2031
|
}
|
|
2032
|
+
interface GoogleCloudDiscoveryengineV1alphaSearchRequestCrowdingSpec {
|
|
2033
|
+
/** The field to use for crowding. Documents can be crowded by a field in the Document object. Crowding field is case sensitive. */
|
|
2034
|
+
field?: string;
|
|
2035
|
+
/** 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. */
|
|
2036
|
+
maxCount?: number;
|
|
2037
|
+
/** Mode to use for documents that are crowded away. */
|
|
2038
|
+
mode?: string;
|
|
2039
|
+
}
|
|
2188
2040
|
interface GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec {
|
|
2189
2041
|
/** 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
2042
|
boostSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec;
|
|
@@ -2505,6 +2357,10 @@ declare namespace gapi.client {
|
|
|
2505
2357
|
interface GoogleCloudDiscoveryengineV1Assistant {
|
|
2506
2358
|
/** Optional. Customer policy for the assistant. */
|
|
2507
2359
|
customerPolicy?: GoogleCloudDiscoveryengineV1AssistantCustomerPolicy;
|
|
2360
|
+
/** Optional. Description for additional information. Expected to be shown on the configuration UI, not to the users of the assistant. */
|
|
2361
|
+
description?: string;
|
|
2362
|
+
/** Required. The assistant display name. It must be a UTF-8 encoded string with a length limit of 128 characters. */
|
|
2363
|
+
displayName?: string;
|
|
2508
2364
|
/** 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
2365
|
enabledTools?: {
|
|
2510
2366
|
[P in string]: GoogleCloudDiscoveryengineV1AssistantToolList;
|
|
@@ -2539,8 +2395,12 @@ declare namespace gapi.client {
|
|
|
2539
2395
|
userPromptTemplate?: string;
|
|
2540
2396
|
}
|
|
2541
2397
|
interface GoogleCloudDiscoveryengineV1AssistantGenerationConfig {
|
|
2398
|
+
/** Optional. The list of models that are allowed to be used for assistant. */
|
|
2399
|
+
allowedModelIds?: string[];
|
|
2542
2400
|
/** 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
2401
|
defaultLanguage?: string;
|
|
2402
|
+
/** Optional. The default model to use for assistant. */
|
|
2403
|
+
defaultModelId?: string;
|
|
2544
2404
|
/** 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
2405
|
systemInstruction?: GoogleCloudDiscoveryengineV1AssistantGenerationConfigSystemInstruction;
|
|
2546
2406
|
}
|
|
@@ -3179,6 +3039,10 @@ declare namespace gapi.client {
|
|
|
3179
3039
|
interface GoogleCloudDiscoveryengineV1betaAssistant {
|
|
3180
3040
|
/** Optional. Customer policy for the assistant. */
|
|
3181
3041
|
customerPolicy?: GoogleCloudDiscoveryengineV1betaAssistantCustomerPolicy;
|
|
3042
|
+
/** Optional. Description for additional information. Expected to be shown on the configuration UI, not to the users of the assistant. */
|
|
3043
|
+
description?: string;
|
|
3044
|
+
/** Required. The assistant display name. It must be a UTF-8 encoded string with a length limit of 128 characters. */
|
|
3045
|
+
displayName?: string;
|
|
3182
3046
|
/** 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
3047
|
enabledTools?: {
|
|
3184
3048
|
[P in string]: GoogleCloudDiscoveryengineV1betaAssistantToolList;
|
|
@@ -3251,8 +3115,12 @@ declare namespace gapi.client {
|
|
|
3251
3115
|
userPromptTemplate?: string;
|
|
3252
3116
|
}
|
|
3253
3117
|
interface GoogleCloudDiscoveryengineV1betaAssistantGenerationConfig {
|
|
3118
|
+
/** Optional. The list of models that are allowed to be used for assistant. */
|
|
3119
|
+
allowedModelIds?: string[];
|
|
3254
3120
|
/** 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
3121
|
defaultLanguage?: string;
|
|
3122
|
+
/** Optional. The default model to use for assistant. */
|
|
3123
|
+
defaultModelId?: string;
|
|
3256
3124
|
/** 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
3125
|
systemInstruction?: GoogleCloudDiscoveryengineV1betaAssistantGenerationConfigSystemInstruction;
|
|
3258
3126
|
}
|
|
@@ -4565,6 +4433,12 @@ declare namespace gapi.client {
|
|
|
4565
4433
|
/** Required. The number of licenses used. */
|
|
4566
4434
|
usedLicenseCount?: string;
|
|
4567
4435
|
}
|
|
4436
|
+
interface GoogleCloudDiscoveryengineV1betaListAssistantsResponse {
|
|
4437
|
+
/** All the customer's Assistants. */
|
|
4438
|
+
assistants?: GoogleCloudDiscoveryengineV1betaAssistant[];
|
|
4439
|
+
/** 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. */
|
|
4440
|
+
nextPageToken?: string;
|
|
4441
|
+
}
|
|
4568
4442
|
interface GoogleCloudDiscoveryengineV1betaListCmekConfigsResponse {
|
|
4569
4443
|
/** All the customer's CmekConfigs. */
|
|
4570
4444
|
cmekConfigs?: GoogleCloudDiscoveryengineV1betaCmekConfig[];
|
|
@@ -5106,6 +4980,8 @@ declare namespace gapi.client {
|
|
|
5106
4980
|
canonicalFilter?: string;
|
|
5107
4981
|
/** A specification for configuring the behavior of content search. */
|
|
5108
4982
|
contentSearchSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec;
|
|
4983
|
+
/** 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. */
|
|
4984
|
+
crowdingSpecs?: GoogleCloudDiscoveryengineV1betaSearchRequestCrowdingSpec[];
|
|
5109
4985
|
/** 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
4986
|
dataStoreSpecs?: GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec[];
|
|
5111
4987
|
/** Optional. Config for display feature, like match highlighting on search results. */
|
|
@@ -5128,6 +5004,8 @@ declare namespace gapi.client {
|
|
|
5128
5004
|
oneBoxPageSize?: number;
|
|
5129
5005
|
/** 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
5006
|
orderBy?: string;
|
|
5007
|
+
/** 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` */
|
|
5008
|
+
pageCategories?: string[];
|
|
5131
5009
|
/** 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
5010
|
pageSize?: number;
|
|
5133
5011
|
/** 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 +5151,14 @@ declare namespace gapi.client {
|
|
|
5273
5151
|
/** Optional. Source of image returned in the answer. */
|
|
5274
5152
|
imageSource?: string;
|
|
5275
5153
|
}
|
|
5154
|
+
interface GoogleCloudDiscoveryengineV1betaSearchRequestCrowdingSpec {
|
|
5155
|
+
/** The field to use for crowding. Documents can be crowded by a field in the Document object. Crowding field is case sensitive. */
|
|
5156
|
+
field?: string;
|
|
5157
|
+
/** 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. */
|
|
5158
|
+
maxCount?: number;
|
|
5159
|
+
/** Mode to use for documents that are crowded away. */
|
|
5160
|
+
mode?: string;
|
|
5161
|
+
}
|
|
5276
5162
|
interface GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec {
|
|
5277
5163
|
/** 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
5164
|
boostSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec;
|
|
@@ -5824,6 +5710,8 @@ declare namespace gapi.client {
|
|
|
5824
5710
|
answer?: GoogleCloudDiscoveryengineV1betaAssistAnswer;
|
|
5825
5711
|
/** A global unique ID that identifies the current pair of request and stream of responses. Used for feedback and support. */
|
|
5826
5712
|
assistToken?: string;
|
|
5713
|
+
/** The tool names of the tools that were invoked. */
|
|
5714
|
+
invocationTools?: string[];
|
|
5827
5715
|
/** Session information. Only included in the final StreamAssistResponse of the response stream. */
|
|
5828
5716
|
sessionInfo?: GoogleCloudDiscoveryengineV1betaStreamAssistResponseSessionInfo;
|
|
5829
5717
|
}
|
|
@@ -7118,7 +7006,7 @@ declare namespace gapi.client {
|
|
|
7118
7006
|
nextPageToken?: string;
|
|
7119
7007
|
/** A list of operations that matches the specified filter in the request. */
|
|
7120
7008
|
operations?: GoogleLongrunningOperation[];
|
|
7121
|
-
/** Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections
|
|
7009
|
+
/** 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
7010
|
unreachable?: string[];
|
|
7123
7011
|
}
|
|
7124
7012
|
interface GoogleLongrunningOperation {
|
|
@@ -7218,39 +7106,6 @@ declare namespace gapi.client {
|
|
|
7218
7106
|
/** Optional. IANA Time Zone Database version number. For example "2019a". */
|
|
7219
7107
|
version?: string;
|
|
7220
7108
|
}
|
|
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
7109
|
interface CmekConfigsResource {
|
|
7255
7110
|
/** De-provisions a CmekConfig. */
|
|
7256
7111
|
delete(request?: {
|
|
@@ -7452,7 +7307,7 @@ declare namespace gapi.client {
|
|
|
7452
7307
|
prettyPrint?: boolean;
|
|
7453
7308
|
/** 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
7309
|
quotaUser?: string;
|
|
7455
|
-
/** When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
7310
|
+
/** 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
7311
|
returnPartialSuccess?: boolean;
|
|
7457
7312
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
7458
7313
|
upload_protocol?: string;
|
|
@@ -7908,7 +7763,7 @@ declare namespace gapi.client {
|
|
|
7908
7763
|
prettyPrint?: boolean;
|
|
7909
7764
|
/** 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
7765
|
quotaUser?: string;
|
|
7911
|
-
/** When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
7766
|
+
/** 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
7767
|
returnPartialSuccess?: boolean;
|
|
7913
7768
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
7914
7769
|
upload_protocol?: string;
|
|
@@ -8696,7 +8551,7 @@ declare namespace gapi.client {
|
|
|
8696
8551
|
prettyPrint?: boolean;
|
|
8697
8552
|
/** 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
8553
|
quotaUser?: string;
|
|
8699
|
-
/** When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
8554
|
+
/** 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
8555
|
returnPartialSuccess?: boolean;
|
|
8701
8556
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
8702
8557
|
upload_protocol?: string;
|
|
@@ -8763,7 +8618,7 @@ declare namespace gapi.client {
|
|
|
8763
8618
|
prettyPrint?: boolean;
|
|
8764
8619
|
/** 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
8620
|
quotaUser?: string;
|
|
8766
|
-
/** When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
8621
|
+
/** 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
8622
|
returnPartialSuccess?: boolean;
|
|
8768
8623
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
8769
8624
|
upload_protocol?: string;
|
|
@@ -8827,7 +8682,7 @@ declare namespace gapi.client {
|
|
|
8827
8682
|
prettyPrint?: boolean;
|
|
8828
8683
|
/** 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
8684
|
quotaUser?: string;
|
|
8830
|
-
/** When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
8685
|
+
/** 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
8686
|
returnPartialSuccess?: boolean;
|
|
8832
8687
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
8833
8688
|
upload_protocol?: string;
|
|
@@ -9758,7 +9613,7 @@ declare namespace gapi.client {
|
|
|
9758
9613
|
prettyPrint?: boolean;
|
|
9759
9614
|
/** 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
9615
|
quotaUser?: string;
|
|
9761
|
-
/** When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
9616
|
+
/** 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
9617
|
returnPartialSuccess?: boolean;
|
|
9763
9618
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
9764
9619
|
upload_protocol?: string;
|
|
@@ -9938,7 +9793,7 @@ declare namespace gapi.client {
|
|
|
9938
9793
|
prettyPrint?: boolean;
|
|
9939
9794
|
/** 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
9795
|
quotaUser?: string;
|
|
9941
|
-
/** When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
9796
|
+
/** 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
9797
|
returnPartialSuccess?: boolean;
|
|
9943
9798
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
9944
9799
|
upload_protocol?: string;
|
|
@@ -11170,7 +11025,128 @@ declare namespace gapi.client {
|
|
|
11170
11025
|
suggestionDenyListEntries: SuggestionDenyListEntriesResource;
|
|
11171
11026
|
userEvents: UserEventsResource;
|
|
11172
11027
|
}
|
|
11028
|
+
interface OperationsResource {
|
|
11029
|
+
/** 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. */
|
|
11030
|
+
get(request?: {
|
|
11031
|
+
/** V1 error format. */
|
|
11032
|
+
'$.xgafv'?: string;
|
|
11033
|
+
/** OAuth access token. */
|
|
11034
|
+
access_token?: string;
|
|
11035
|
+
/** Data format for response. */
|
|
11036
|
+
alt?: string;
|
|
11037
|
+
/** JSONP */
|
|
11038
|
+
callback?: string;
|
|
11039
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
11040
|
+
fields?: string;
|
|
11041
|
+
/** 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. */
|
|
11042
|
+
key?: string;
|
|
11043
|
+
/** The name of the operation resource. */
|
|
11044
|
+
name: string;
|
|
11045
|
+
/** OAuth 2.0 token for the current user. */
|
|
11046
|
+
oauth_token?: string;
|
|
11047
|
+
/** Returns response with indentations and line breaks. */
|
|
11048
|
+
prettyPrint?: boolean;
|
|
11049
|
+
/** 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. */
|
|
11050
|
+
quotaUser?: string;
|
|
11051
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
11052
|
+
upload_protocol?: string;
|
|
11053
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
11054
|
+
uploadType?: string;
|
|
11055
|
+
}): Request<GoogleLongrunningOperation>;
|
|
11056
|
+
}
|
|
11057
|
+
interface AgentsResource {
|
|
11058
|
+
operations: OperationsResource;
|
|
11059
|
+
}
|
|
11173
11060
|
interface AssistantsResource {
|
|
11061
|
+
/** Creates an Assistant. */
|
|
11062
|
+
create(request: {
|
|
11063
|
+
/** V1 error format. */
|
|
11064
|
+
'$.xgafv'?: string;
|
|
11065
|
+
/** OAuth access token. */
|
|
11066
|
+
access_token?: string;
|
|
11067
|
+
/** Data format for response. */
|
|
11068
|
+
alt?: string;
|
|
11069
|
+
/** 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. */
|
|
11070
|
+
assistantId?: string;
|
|
11071
|
+
/** JSONP */
|
|
11072
|
+
callback?: string;
|
|
11073
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
11074
|
+
fields?: string;
|
|
11075
|
+
/** 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. */
|
|
11076
|
+
key?: string;
|
|
11077
|
+
/** OAuth 2.0 token for the current user. */
|
|
11078
|
+
oauth_token?: string;
|
|
11079
|
+
/** Required. The parent resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` */
|
|
11080
|
+
parent: string;
|
|
11081
|
+
/** Returns response with indentations and line breaks. */
|
|
11082
|
+
prettyPrint?: boolean;
|
|
11083
|
+
/** 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. */
|
|
11084
|
+
quotaUser?: string;
|
|
11085
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
11086
|
+
upload_protocol?: string;
|
|
11087
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
11088
|
+
uploadType?: string;
|
|
11089
|
+
/** Request body */
|
|
11090
|
+
resource: GoogleCloudDiscoveryengineV1betaAssistant;
|
|
11091
|
+
}): Request<GoogleCloudDiscoveryengineV1betaAssistant>;
|
|
11092
|
+
create(
|
|
11093
|
+
request: {
|
|
11094
|
+
/** V1 error format. */
|
|
11095
|
+
'$.xgafv'?: string;
|
|
11096
|
+
/** OAuth access token. */
|
|
11097
|
+
access_token?: string;
|
|
11098
|
+
/** Data format for response. */
|
|
11099
|
+
alt?: string;
|
|
11100
|
+
/** 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. */
|
|
11101
|
+
assistantId?: string;
|
|
11102
|
+
/** JSONP */
|
|
11103
|
+
callback?: string;
|
|
11104
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
11105
|
+
fields?: string;
|
|
11106
|
+
/** 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. */
|
|
11107
|
+
key?: string;
|
|
11108
|
+
/** OAuth 2.0 token for the current user. */
|
|
11109
|
+
oauth_token?: string;
|
|
11110
|
+
/** Required. The parent resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` */
|
|
11111
|
+
parent: string;
|
|
11112
|
+
/** Returns response with indentations and line breaks. */
|
|
11113
|
+
prettyPrint?: boolean;
|
|
11114
|
+
/** 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. */
|
|
11115
|
+
quotaUser?: string;
|
|
11116
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
11117
|
+
upload_protocol?: string;
|
|
11118
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
11119
|
+
uploadType?: string;
|
|
11120
|
+
},
|
|
11121
|
+
body: GoogleCloudDiscoveryengineV1betaAssistant,
|
|
11122
|
+
): Request<GoogleCloudDiscoveryengineV1betaAssistant>;
|
|
11123
|
+
/** Deletes an Assistant. */
|
|
11124
|
+
delete(request?: {
|
|
11125
|
+
/** V1 error format. */
|
|
11126
|
+
'$.xgafv'?: string;
|
|
11127
|
+
/** OAuth access token. */
|
|
11128
|
+
access_token?: string;
|
|
11129
|
+
/** Data format for response. */
|
|
11130
|
+
alt?: string;
|
|
11131
|
+
/** JSONP */
|
|
11132
|
+
callback?: string;
|
|
11133
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
11134
|
+
fields?: string;
|
|
11135
|
+
/** 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. */
|
|
11136
|
+
key?: string;
|
|
11137
|
+
/** 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. */
|
|
11138
|
+
name: string;
|
|
11139
|
+
/** OAuth 2.0 token for the current user. */
|
|
11140
|
+
oauth_token?: string;
|
|
11141
|
+
/** Returns response with indentations and line breaks. */
|
|
11142
|
+
prettyPrint?: boolean;
|
|
11143
|
+
/** 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. */
|
|
11144
|
+
quotaUser?: string;
|
|
11145
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
11146
|
+
upload_protocol?: string;
|
|
11147
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
11148
|
+
uploadType?: string;
|
|
11149
|
+
}): Request<{}>;
|
|
11174
11150
|
/** Gets an Assistant. */
|
|
11175
11151
|
get(request?: {
|
|
11176
11152
|
/** V1 error format. */
|
|
@@ -11198,6 +11174,37 @@ declare namespace gapi.client {
|
|
|
11198
11174
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
11199
11175
|
uploadType?: string;
|
|
11200
11176
|
}): Request<GoogleCloudDiscoveryengineV1betaAssistant>;
|
|
11177
|
+
/** Lists all Assistants under an Engine. */
|
|
11178
|
+
list(request?: {
|
|
11179
|
+
/** V1 error format. */
|
|
11180
|
+
'$.xgafv'?: string;
|
|
11181
|
+
/** OAuth access token. */
|
|
11182
|
+
access_token?: string;
|
|
11183
|
+
/** Data format for response. */
|
|
11184
|
+
alt?: string;
|
|
11185
|
+
/** JSONP */
|
|
11186
|
+
callback?: string;
|
|
11187
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
11188
|
+
fields?: string;
|
|
11189
|
+
/** 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. */
|
|
11190
|
+
key?: string;
|
|
11191
|
+
/** OAuth 2.0 token for the current user. */
|
|
11192
|
+
oauth_token?: string;
|
|
11193
|
+
/** 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. */
|
|
11194
|
+
pageSize?: number;
|
|
11195
|
+
/** 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. */
|
|
11196
|
+
pageToken?: string;
|
|
11197
|
+
/** Required. The parent resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` */
|
|
11198
|
+
parent: string;
|
|
11199
|
+
/** Returns response with indentations and line breaks. */
|
|
11200
|
+
prettyPrint?: boolean;
|
|
11201
|
+
/** 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. */
|
|
11202
|
+
quotaUser?: string;
|
|
11203
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
11204
|
+
upload_protocol?: string;
|
|
11205
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
11206
|
+
uploadType?: string;
|
|
11207
|
+
}): Request<GoogleCloudDiscoveryengineV1betaListAssistantsResponse>;
|
|
11201
11208
|
/** Updates an Assistant */
|
|
11202
11209
|
patch(request: {
|
|
11203
11210
|
/** V1 error format. */
|
|
@@ -11318,6 +11325,7 @@ declare namespace gapi.client {
|
|
|
11318
11325
|
},
|
|
11319
11326
|
body: GoogleCloudDiscoveryengineV1betaStreamAssistRequest,
|
|
11320
11327
|
): Request<GoogleCloudDiscoveryengineV1betaStreamAssistResponse>;
|
|
11328
|
+
agents: AgentsResource;
|
|
11321
11329
|
}
|
|
11322
11330
|
interface CompletionConfigResource {
|
|
11323
11331
|
/** Completes the user input with advanced keyword suggestions. */
|
|
@@ -11975,7 +11983,7 @@ declare namespace gapi.client {
|
|
|
11975
11983
|
prettyPrint?: boolean;
|
|
11976
11984
|
/** 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
11985
|
quotaUser?: string;
|
|
11978
|
-
/** When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
11986
|
+
/** 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
11987
|
returnPartialSuccess?: boolean;
|
|
11980
11988
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
11981
11989
|
upload_protocol?: string;
|
|
@@ -13088,7 +13096,7 @@ declare namespace gapi.client {
|
|
|
13088
13096
|
prettyPrint?: boolean;
|
|
13089
13097
|
/** 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
13098
|
quotaUser?: string;
|
|
13091
|
-
/** When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
13099
|
+
/** 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
13100
|
returnPartialSuccess?: boolean;
|
|
13093
13101
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
13094
13102
|
upload_protocol?: string;
|
|
@@ -13547,7 +13555,7 @@ declare namespace gapi.client {
|
|
|
13547
13555
|
prettyPrint?: boolean;
|
|
13548
13556
|
/** 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
13557
|
quotaUser?: string;
|
|
13550
|
-
/** When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
13558
|
+
/** 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
13559
|
returnPartialSuccess?: boolean;
|
|
13552
13560
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
13553
13561
|
upload_protocol?: string;
|
|
@@ -14306,7 +14314,7 @@ declare namespace gapi.client {
|
|
|
14306
14314
|
prettyPrint?: boolean;
|
|
14307
14315
|
/** 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
14316
|
quotaUser?: string;
|
|
14309
|
-
/** When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
14317
|
+
/** 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
14318
|
returnPartialSuccess?: boolean;
|
|
14311
14319
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
14312
14320
|
upload_protocol?: string;
|
|
@@ -14373,7 +14381,7 @@ declare namespace gapi.client {
|
|
|
14373
14381
|
prettyPrint?: boolean;
|
|
14374
14382
|
/** 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
14383
|
quotaUser?: string;
|
|
14376
|
-
/** When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
14384
|
+
/** 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
14385
|
returnPartialSuccess?: boolean;
|
|
14378
14386
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
14379
14387
|
upload_protocol?: string;
|
|
@@ -16732,7 +16740,7 @@ declare namespace gapi.client {
|
|
|
16732
16740
|
prettyPrint?: boolean;
|
|
16733
16741
|
/** 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
16742
|
quotaUser?: string;
|
|
16735
|
-
/** When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
16743
|
+
/** 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
16744
|
returnPartialSuccess?: boolean;
|
|
16737
16745
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
16738
16746
|
upload_protocol?: string;
|
|
@@ -17254,7 +17262,7 @@ declare namespace gapi.client {
|
|
|
17254
17262
|
prettyPrint?: boolean;
|
|
17255
17263
|
/** 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
17264
|
quotaUser?: string;
|
|
17257
|
-
/** When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
17265
|
+
/** 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
17266
|
returnPartialSuccess?: boolean;
|
|
17259
17267
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
17260
17268
|
upload_protocol?: string;
|
|
@@ -18062,12 +18070,12 @@ declare namespace gapi.client {
|
|
|
18062
18070
|
callback?: string;
|
|
18063
18071
|
/** Selector specifying which fields to include in a partial response. */
|
|
18064
18072
|
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
18073
|
/** 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
18074
|
key?: string;
|
|
18069
18075
|
/** OAuth 2.0 token for the current user. */
|
|
18070
18076
|
oauth_token?: string;
|
|
18077
|
+
/** 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. */
|
|
18078
|
+
orderBy?: string;
|
|
18071
18079
|
/** 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
18080
|
pageSize?: number;
|
|
18073
18081
|
/** 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 +18751,7 @@ declare namespace gapi.client {
|
|
|
18743
18751
|
prettyPrint?: boolean;
|
|
18744
18752
|
/** 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
18753
|
quotaUser?: string;
|
|
18746
|
-
/** When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
18754
|
+
/** 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
18755
|
returnPartialSuccess?: boolean;
|
|
18748
18756
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
18749
18757
|
upload_protocol?: string;
|
|
@@ -18814,8 +18822,6 @@ declare namespace gapi.client {
|
|
|
18814
18822
|
operations: OperationsResource;
|
|
18815
18823
|
}
|
|
18816
18824
|
|
|
18817
|
-
const media: MediaResource;
|
|
18818
|
-
|
|
18819
18825
|
const projects: ProjectsResource;
|
|
18820
18826
|
}
|
|
18821
18827
|
}
|
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
|
*/
|