@maxim_mazurok/gapi.client.discoveryengine-v1alpha 0.0.20240318 → 0.0.20240329
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 +247 -6
- package/package.json +1 -1
package/index.d.ts
CHANGED
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
// This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
|
|
10
10
|
// In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
|
|
11
11
|
// Generated from: https://discoveryengine.googleapis.com/$discovery/rest?version=v1alpha
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20240329
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -121,7 +121,47 @@ declare namespace gapi.client {
|
|
|
121
121
|
/** Required. The BigQuery table to copy the data from with a length limit of 1,024 characters. */
|
|
122
122
|
tableId?: string;
|
|
123
123
|
}
|
|
124
|
+
interface GoogleCloudDiscoveryengineV1alphaBigtableOptions {
|
|
125
|
+
/** The mapping from family names to an object that contains column families level information for the given column family. If a family is not present in this map it will be ignored. */
|
|
126
|
+
families?: {
|
|
127
|
+
[P in string]: GoogleCloudDiscoveryengineV1alphaBigtableOptionsBigtableColumnFamily;
|
|
128
|
+
};
|
|
129
|
+
/** The field name used for saving row key value in the UCS document. The name has to match a-zA-Z0-9* */
|
|
130
|
+
keyFieldName?: string;
|
|
131
|
+
}
|
|
132
|
+
interface GoogleCloudDiscoveryengineV1alphaBigtableOptionsBigtableColumn {
|
|
133
|
+
/** Optional. The encoding mode of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. This can be overridden for a specific column by listing that column in 'columns' and specifying an encoding for it. */
|
|
134
|
+
encoding?: string;
|
|
135
|
+
/** The field name to use for this column in the UCS document. The name has to match a-zA-Z0-9* If not set, we will parse it from the qualifier bytes with best effort. However, field name collisions could happen, where parsing behavior is undefined. */
|
|
136
|
+
fieldName?: string;
|
|
137
|
+
/** Required. Qualifier of the column. If cannot decode with utf-8, store a base-64 encoded string. */
|
|
138
|
+
qualifier?: string;
|
|
139
|
+
/** Optional. The type of values in this column family. The values are expected to be encoded using HBase Bytes.toBytes function when the encoding value is set to BINARY. */
|
|
140
|
+
type?: string;
|
|
141
|
+
}
|
|
142
|
+
interface GoogleCloudDiscoveryengineV1alphaBigtableOptionsBigtableColumnFamily {
|
|
143
|
+
/** The list of objects that contains column level information for each column. If a column is not present in this list it will be ignored. */
|
|
144
|
+
columns?: GoogleCloudDiscoveryengineV1alphaBigtableOptionsBigtableColumn[];
|
|
145
|
+
/** Optional. The encoding mode of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. This can be overridden for a specific column by listing that column in 'columns' and specifying an encoding for it. */
|
|
146
|
+
encoding?: string;
|
|
147
|
+
/** The field name to use for this column family in the UCS document. The name has to match a-zA-Z0-9* If not set, we will parse it from the family name with best effort. However, due to difference naming pattern, there could be field name collisions, where parsing behavior is undefined. */
|
|
148
|
+
fieldName?: string;
|
|
149
|
+
/** Optional. The type of values in this column family. The values are expected to be encoded using HBase Bytes.toBytes function when the encoding value is set to BINARY. */
|
|
150
|
+
type?: string;
|
|
151
|
+
}
|
|
152
|
+
interface GoogleCloudDiscoveryengineV1alphaBigtableSource {
|
|
153
|
+
/** Required. Bigtable options that contains information needed when parsing data into typed structures. For example, column type annotations. */
|
|
154
|
+
bigtableOptions?: GoogleCloudDiscoveryengineV1alphaBigtableOptions;
|
|
155
|
+
/** Required. The instance ID of the Cloud Bigtable that needs to be exported. */
|
|
156
|
+
instanceId?: string;
|
|
157
|
+
/** The project ID (can be project # or ID) that the Bigtable source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request. */
|
|
158
|
+
projectId?: string;
|
|
159
|
+
/** Required. The table ID of the Cloud Bigtable that needs to be exported. */
|
|
160
|
+
tableId?: string;
|
|
161
|
+
}
|
|
124
162
|
interface GoogleCloudDiscoveryengineV1alphaChunk {
|
|
163
|
+
/** Output only. Metadata of the current chunk. */
|
|
164
|
+
chunkMetadata?: GoogleCloudDiscoveryengineV1alphaChunkChunkMetadata;
|
|
125
165
|
/** Content is a string from a document (parsed content). */
|
|
126
166
|
content?: string;
|
|
127
167
|
/** Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document. */
|
|
@@ -132,6 +172,14 @@ declare namespace gapi.client {
|
|
|
132
172
|
id?: string;
|
|
133
173
|
/** The full resource name of the chunk. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}/chunks/{chunk_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */
|
|
134
174
|
name?: string;
|
|
175
|
+
/** Page span of the chunk. */
|
|
176
|
+
pageSpan?: GoogleCloudDiscoveryengineV1alphaChunkPageSpan;
|
|
177
|
+
}
|
|
178
|
+
interface GoogleCloudDiscoveryengineV1alphaChunkChunkMetadata {
|
|
179
|
+
/** The next chunks of the current chunk. The number is controlled by SearchRequest.ContentSearchSpec.ChunkSpec.num_next_chunks. This field is only populated on SearchService.Search API. */
|
|
180
|
+
nextChunks?: GoogleCloudDiscoveryengineV1alphaChunk[];
|
|
181
|
+
/** The previous chunks of the current chunk. The number is controlled by SearchRequest.ContentSearchSpec.ChunkSpec.num_previous_chunks. This field is only populated on SearchService.Search API. */
|
|
182
|
+
previousChunks?: GoogleCloudDiscoveryengineV1alphaChunk[];
|
|
135
183
|
}
|
|
136
184
|
interface GoogleCloudDiscoveryengineV1alphaChunkDocumentMetadata {
|
|
137
185
|
/** Title of the document. */
|
|
@@ -139,6 +187,26 @@ declare namespace gapi.client {
|
|
|
139
187
|
/** Uri of the document. */
|
|
140
188
|
uri?: string;
|
|
141
189
|
}
|
|
190
|
+
interface GoogleCloudDiscoveryengineV1alphaChunkPageSpan {
|
|
191
|
+
/** The end page of the chunk. */
|
|
192
|
+
pageEnd?: number;
|
|
193
|
+
/** The start page of the chunk. */
|
|
194
|
+
pageStart?: number;
|
|
195
|
+
}
|
|
196
|
+
interface GoogleCloudDiscoveryengineV1alphaCloudSqlSource {
|
|
197
|
+
/** Required. The Cloud SQL database to copy the data from with a length limit of 256 characters. */
|
|
198
|
+
databaseId?: string;
|
|
199
|
+
/** Optional. Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the Cloud SQL export to a specific Cloud Storage directory. Please ensure that the Cloud SQL service account has the necessary GCS Storage Admin permissions to access the specified GCS directory. */
|
|
200
|
+
gcsStagingDir?: string;
|
|
201
|
+
/** Required. The Cloud SQL instance to copy the data from with a length limit of 256 characters. */
|
|
202
|
+
instanceId?: string;
|
|
203
|
+
/** Optional. Option for serverless export. Enabling this option will incur additional cost. More info: https://cloud.google.com/sql/pricing#serverless */
|
|
204
|
+
offload?: boolean;
|
|
205
|
+
/** Optional. The project ID (can be project # or ID) that the Cloud SQL source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request. */
|
|
206
|
+
projectId?: string;
|
|
207
|
+
/** Required. The Cloud SQL table to copy the data from with a length limit of 256 characters. */
|
|
208
|
+
tableId?: string;
|
|
209
|
+
}
|
|
142
210
|
interface GoogleCloudDiscoveryengineV1alphaCompleteQueryRequest {
|
|
143
211
|
/** Required. The parent data store resource name for which the completion is performed, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store`. */
|
|
144
212
|
dataStore?: string;
|
|
@@ -556,6 +624,12 @@ declare namespace gapi.client {
|
|
|
556
624
|
/** The total number of items matching the request. This will always be populated in the response. */
|
|
557
625
|
totalSize?: number;
|
|
558
626
|
}
|
|
627
|
+
interface GoogleCloudDiscoveryengineV1alphaFhirStoreSource {
|
|
628
|
+
/** Required. The full resource name of the FHIR store to import data from, in the format of `projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}`. */
|
|
629
|
+
fhirStore?: string;
|
|
630
|
+
/** Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the FhirStore export to a specific Cloud Storage directory. */
|
|
631
|
+
gcsStagingDir?: string;
|
|
632
|
+
}
|
|
559
633
|
interface GoogleCloudDiscoveryengineV1alphaFieldConfig {
|
|
560
634
|
/** If completable_option is COMPLETABLE_ENABLED, field values are directly used and returned as suggestions for Autocomplete in CompletionService.CompleteQuery. If completable_option is unset, the server behavior defaults to COMPLETABLE_DISABLED for fields that support setting completable options, which are just `string` fields. For those fields that do not support setting completable options, the server will skip completable option setting, and setting completable_option for those fields will throw `INVALID_ARGUMENT` error. */
|
|
561
635
|
completableOption?: string;
|
|
@@ -576,12 +650,26 @@ declare namespace gapi.client {
|
|
|
576
650
|
/** If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error. */
|
|
577
651
|
searchableOption?: string;
|
|
578
652
|
}
|
|
653
|
+
interface GoogleCloudDiscoveryengineV1alphaFirestoreSource {
|
|
654
|
+
/** Required. The Firestore collection to copy the data from with a length limit of 1500 characters. */
|
|
655
|
+
collectionId?: string;
|
|
656
|
+
/** Required. The Firestore database to copy the data from with a length limit of 256 characters. */
|
|
657
|
+
databaseId?: string;
|
|
658
|
+
/** Optional. Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the Firestore export to a specific Cloud Storage directory. Please ensure that the Firestore service account has the necessary GCS Storage Admin permissions to access the specified GCS directory. */
|
|
659
|
+
gcsStagingDir?: string;
|
|
660
|
+
/** Optional. The project ID (can be project # or ID) that the Cloud SQL source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request. */
|
|
661
|
+
projectId?: string;
|
|
662
|
+
}
|
|
579
663
|
interface GoogleCloudDiscoveryengineV1alphaGcsSource {
|
|
580
664
|
/** The schema to use when parsing the data from the source. Supported values for document imports: * `document` (default): One JSON Document per line. Each document must have a valid Document.id. * `content`: Unstructured data (e.g. PDF, HTML). Each file matched by `input_uris` becomes a document, with the ID set to the first 128 bits of SHA256(URI) encoded as a hex string. * `custom`: One custom data JSON per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by Gen App Builder. * `csv`: A CSV file with header conforming to the defined Schema of the data store. Each entry after the header is imported as a Document. This can only be used by Gen App Builder. Supported values for user even imports: * `user_event` (default): One JSON UserEvent per line. */
|
|
581
665
|
dataSchema?: string;
|
|
582
666
|
/** Required. Cloud Storage URIs to input files. URI can be up to 2000 characters long. URIs can match the full object path (for example, `gs://bucket/directory/object.json`) or a pattern matching one or more files, such as `gs://bucket/directory/*.json`. A request can contain at most 100 files (or 100,000 files if `data_schema` is `content`). Each file can be up to 2 GB (or 100 MB if `data_schema` is `content`). */
|
|
583
667
|
inputUris?: string[];
|
|
584
668
|
}
|
|
669
|
+
interface GoogleCloudDiscoveryengineV1alphaGroundingConfig {
|
|
670
|
+
/** Required. Name of the GroundingConfig, of the form `projects/{project}/locations/{location}/groundingConfig`. */
|
|
671
|
+
name?: string;
|
|
672
|
+
}
|
|
585
673
|
interface GoogleCloudDiscoveryengineV1alphaGuidedSearchSpec {
|
|
586
674
|
/** Whether or not to enable and include refinement attributes in gudied search result. */
|
|
587
675
|
enableRefinementAttributes?: boolean;
|
|
@@ -600,6 +688,20 @@ declare namespace gapi.client {
|
|
|
600
688
|
/** Workforce pool name. Example: "locations/global/workforcePools/pool_id" */
|
|
601
689
|
workforcePoolName?: string;
|
|
602
690
|
}
|
|
691
|
+
interface GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsMetadata {
|
|
692
|
+
/** Operation create time. */
|
|
693
|
+
createTime?: string;
|
|
694
|
+
/** Operation last update time. If the operation is done, this is also the finish time. */
|
|
695
|
+
updateTime?: string;
|
|
696
|
+
}
|
|
697
|
+
interface GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsResponse {
|
|
698
|
+
/** A sample of errors encountered while processing the request. */
|
|
699
|
+
errorSamples?: GoogleRpcStatus[];
|
|
700
|
+
/** Count of CompletionSuggestions that failed to be imported. */
|
|
701
|
+
failureCount?: string;
|
|
702
|
+
/** Count of CompletionSuggestions successfully imported. */
|
|
703
|
+
successCount?: string;
|
|
704
|
+
}
|
|
603
705
|
interface GoogleCloudDiscoveryengineV1alphaImportDocumentsMetadata {
|
|
604
706
|
/** Operation create time. */
|
|
605
707
|
createTime?: string;
|
|
@@ -611,20 +713,30 @@ declare namespace gapi.client {
|
|
|
611
713
|
updateTime?: string;
|
|
612
714
|
}
|
|
613
715
|
interface GoogleCloudDiscoveryengineV1alphaImportDocumentsRequest {
|
|
614
|
-
/** Whether to automatically generate IDs for the documents if absent. If set to `true`, Document.ids are automatically generated based on the hash of the payload, where IDs may not be consistent during multiple imports. In which case ReconciliationMode.FULL is highly recommended to avoid duplicate contents. If unset or set to `false`, Document.ids have to be specified using id_field, otherwise, documents without IDs fail to be imported.
|
|
716
|
+
/** Whether to automatically generate IDs for the documents if absent. If set to `true`, Document.ids are automatically generated based on the hash of the payload, where IDs may not be consistent during multiple imports. In which case ReconciliationMode.FULL is highly recommended to avoid duplicate contents. If unset or set to `false`, Document.ids have to be specified using id_field, otherwise, documents without IDs fail to be imported. Supported data sources: * GcsSource. GcsSource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * BigQuerySource. BigQuerySource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * SpannerSource * CloudSqlSource * FirestoreSource * BigtableSource */
|
|
615
717
|
autoGenerateIds?: boolean;
|
|
616
718
|
/** BigQuery input source. */
|
|
617
719
|
bigquerySource?: GoogleCloudDiscoveryengineV1alphaBigQuerySource;
|
|
720
|
+
/** Cloud Bigtable input source. */
|
|
721
|
+
bigtableSource?: GoogleCloudDiscoveryengineV1alphaBigtableSource;
|
|
722
|
+
/** Cloud SQL input source. */
|
|
723
|
+
cloudSqlSource?: GoogleCloudDiscoveryengineV1alphaCloudSqlSource;
|
|
618
724
|
/** The desired location of errors incurred during the Import. */
|
|
619
725
|
errorConfig?: GoogleCloudDiscoveryengineV1alphaImportErrorConfig;
|
|
726
|
+
/** FhirStore input source. */
|
|
727
|
+
fhirStoreSource?: GoogleCloudDiscoveryengineV1alphaFhirStoreSource;
|
|
728
|
+
/** Firestore input source. */
|
|
729
|
+
firestoreSource?: GoogleCloudDiscoveryengineV1alphaFirestoreSource;
|
|
620
730
|
/** Cloud Storage location for the input content. */
|
|
621
731
|
gcsSource?: GoogleCloudDiscoveryengineV1alphaGcsSource;
|
|
622
|
-
/** The field
|
|
732
|
+
/** The field indicates the ID field or column to be used as unique IDs of the documents. For GcsSource it is the key of the JSON field. For instance, `my_id` for JSON `{"my_id": "some_uuid"}`. For others, it may be the column name of the table where the unique ids are stored. The values of the JSON field or the table column are used as the Document.ids. The JSON field or the table column must be of string type, and the values must be set as valid strings conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) with 1-63 characters. Otherwise, documents without valid IDs fail to be imported. Only set this field when auto_generate_ids is unset or set as `false`. Otherwise, an INVALID_ARGUMENT error is thrown. If it is unset, a default value `_id` is used when importing from the allowed data sources. Supported data sources: * GcsSource. GcsSource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * BigQuerySource. BigQuerySource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * SpannerSource * CloudSqlSource * FirestoreSource * BigtableSource */
|
|
623
733
|
idField?: string;
|
|
624
734
|
/** The Inline source for the input content for documents. */
|
|
625
735
|
inlineSource?: GoogleCloudDiscoveryengineV1alphaImportDocumentsRequestInlineSource;
|
|
626
736
|
/** The mode of reconciliation between existing documents and the documents to be imported. Defaults to ReconciliationMode.INCREMENTAL. */
|
|
627
737
|
reconciliationMode?: string;
|
|
738
|
+
/** Spanner input source. */
|
|
739
|
+
spannerSource?: GoogleCloudDiscoveryengineV1alphaSpannerSource;
|
|
628
740
|
}
|
|
629
741
|
interface GoogleCloudDiscoveryengineV1alphaImportDocumentsRequestInlineSource {
|
|
630
742
|
/** Required. A list of documents to update/create. Each document must have a valid Document.id. Recommended max of 100 items. */
|
|
@@ -870,6 +982,32 @@ declare namespace gapi.client {
|
|
|
870
982
|
/** The total count of events purged as a result of the operation. */
|
|
871
983
|
purgeCount?: string;
|
|
872
984
|
}
|
|
985
|
+
interface GoogleCloudDiscoveryengineV1alphaRankingRecord {
|
|
986
|
+
/** The content of the record. Empty by default. At least one of title or content should be set otherwise an INVALID_ARGUMENT error is thrown. */
|
|
987
|
+
content?: string;
|
|
988
|
+
/** The unique ID to represent the record. */
|
|
989
|
+
id?: string;
|
|
990
|
+
/** The score of this record based on the given query and selected model. */
|
|
991
|
+
score?: number;
|
|
992
|
+
/** The title of the record. Empty by default. At least one of title or content should be set otherwise an INVALID_ARGUMENT error is thrown. */
|
|
993
|
+
title?: string;
|
|
994
|
+
}
|
|
995
|
+
interface GoogleCloudDiscoveryengineV1alphaRankRequest {
|
|
996
|
+
/** If true, the response will contain only record ID and score. By default, it is false, the response will contain record details. */
|
|
997
|
+
ignoreRecordDetailsInResponse?: boolean;
|
|
998
|
+
/** The identifier of the model to use. It is one of: * `semantic-ranker-512@latest`: Semantic ranking model with maxiumn input token size 512. It is set to `semantic-ranker-512@latest` by default if unspecified. */
|
|
999
|
+
model?: string;
|
|
1000
|
+
/** The query to use. */
|
|
1001
|
+
query?: string;
|
|
1002
|
+
/** Required. A list of records to rank. */
|
|
1003
|
+
records?: GoogleCloudDiscoveryengineV1alphaRankingRecord[];
|
|
1004
|
+
/** The number of results to return. If this is unset or no bigger than zero, returns all results. */
|
|
1005
|
+
topN?: number;
|
|
1006
|
+
}
|
|
1007
|
+
interface GoogleCloudDiscoveryengineV1alphaRankResponse {
|
|
1008
|
+
/** A list of records sorted by descending score. */
|
|
1009
|
+
records?: GoogleCloudDiscoveryengineV1alphaRankingRecord[];
|
|
1010
|
+
}
|
|
873
1011
|
interface GoogleCloudDiscoveryengineV1alphaRecommendRequest {
|
|
874
1012
|
/** Filter for restricting recommendation results with a length limit of 5,000 characters. Currently, only filter expressions on the `filter_tags` attribute is supported. Examples: * `(filter_tags: ANY("Red", "Blue") OR filter_tags: ANY("Hot", "Cold"))` * `(filter_tags: ANY("Red", "Blue")) AND NOT (filter_tags: ANY("Green"))` If `attributeFilteringSyntax` is set to true under the `params` field, then attribute-based expressions are expected instead of the above described tag-based syntax. Examples: * (launguage: ANY("en", "es")) AND NOT (categories: ANY("Movie")) * (available: true) AND (launguage: ANY("en", "es")) OR (categories: ANY("Movie")) If your filter blocks all results, the API will return generic (unfiltered) popular Documents. If you only want results strictly matching the filters, set `strictFiltering` to True in RecommendRequest.params to receive empty results instead. Note that the API will never return Documents with `storageStatus` of `EXPIRED` or `DELETED` regardless of filter choices. */
|
|
875
1013
|
filter?: string;
|
|
@@ -1038,6 +1176,8 @@ declare namespace gapi.client {
|
|
|
1038
1176
|
condition?: string;
|
|
1039
1177
|
}
|
|
1040
1178
|
interface GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec {
|
|
1179
|
+
/** Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS */
|
|
1180
|
+
chunkSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecChunkSpec;
|
|
1041
1181
|
/** If there is no extractive_content_spec provided, there will be no extractive answer in the search response. */
|
|
1042
1182
|
extractiveContentSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec;
|
|
1043
1183
|
/** Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. */
|
|
@@ -1047,6 +1187,12 @@ declare namespace gapi.client {
|
|
|
1047
1187
|
/** If `summarySpec` is not specified, summaries are not included in the search response. */
|
|
1048
1188
|
summarySpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec;
|
|
1049
1189
|
}
|
|
1190
|
+
interface GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecChunkSpec {
|
|
1191
|
+
/** The number of next chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no next chunks will be returned. */
|
|
1192
|
+
numNextChunks?: number;
|
|
1193
|
+
/** The number of previous chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no previous chunks will be returned. */
|
|
1194
|
+
numPreviousChunks?: number;
|
|
1195
|
+
}
|
|
1050
1196
|
interface GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec {
|
|
1051
1197
|
/** The maximum number of extractive answers returned in each search result. An extractive answer is a verbatim answer extracted from the original document, which provides a precise and contextually relevant answer to the search query. If the number of matching answers is less than the `max_extractive_answer_count`, return all of the answers. Otherwise, return the `max_extractive_answer_count`. At most five answers are returned for each SearchResult. */
|
|
1052
1198
|
maxExtractiveAnswerCount?: number;
|
|
@@ -1251,6 +1397,8 @@ declare namespace gapi.client {
|
|
|
1251
1397
|
referenceIndex?: string;
|
|
1252
1398
|
}
|
|
1253
1399
|
interface GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryReference {
|
|
1400
|
+
/** List of cited chunk contents derived from document content. */
|
|
1401
|
+
chunkContents?: GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryReferenceChunkContent[];
|
|
1254
1402
|
/** Required. Document.name of the document. Full resource name of the referenced document, in the format `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`. */
|
|
1255
1403
|
document?: string;
|
|
1256
1404
|
/** Title of the document. */
|
|
@@ -1258,6 +1406,12 @@ declare namespace gapi.client {
|
|
|
1258
1406
|
/** Cloud Storage or HTTP uri for the document. */
|
|
1259
1407
|
uri?: string;
|
|
1260
1408
|
}
|
|
1409
|
+
interface GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryReferenceChunkContent {
|
|
1410
|
+
/** Chunk textual content. */
|
|
1411
|
+
content?: string;
|
|
1412
|
+
/** Page identifier. */
|
|
1413
|
+
pageIdentifier?: string;
|
|
1414
|
+
}
|
|
1261
1415
|
interface GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySafetyAttributes {
|
|
1262
1416
|
/** The display names of Safety Attribute categories associated with the generated content. Order matches the Scores. */
|
|
1263
1417
|
categories?: string[];
|
|
@@ -1340,6 +1494,18 @@ declare namespace gapi.client {
|
|
|
1340
1494
|
/** Latest site verification time. */
|
|
1341
1495
|
verifyTime?: string;
|
|
1342
1496
|
}
|
|
1497
|
+
interface GoogleCloudDiscoveryengineV1alphaSpannerSource {
|
|
1498
|
+
/** Required. The database ID of the source Spanner table. */
|
|
1499
|
+
databaseId?: string;
|
|
1500
|
+
/** Optional. Whether to apply data boost on Spanner export. Enabling this option will incur additional cost. More info: https://cloud.google.com/spanner/docs/databoost/databoost-overview#billing_and_quotas */
|
|
1501
|
+
enableDataBoost?: boolean;
|
|
1502
|
+
/** Required. The instance ID of the source Spanner table. */
|
|
1503
|
+
instanceId?: string;
|
|
1504
|
+
/** The project ID that the Spanner source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request. */
|
|
1505
|
+
projectId?: string;
|
|
1506
|
+
/** Required. The table name of the Spanner database that needs to be imported. */
|
|
1507
|
+
tableId?: string;
|
|
1508
|
+
}
|
|
1343
1509
|
interface GoogleCloudDiscoveryengineV1alphaSuggestionDenyListEntry {
|
|
1344
1510
|
/** Required. Phrase to block from suggestions served. Can be maximum 125 characters. */
|
|
1345
1511
|
blockPhrase?: string;
|
|
@@ -1409,6 +1575,8 @@ declare namespace gapi.client {
|
|
|
1409
1575
|
errorConfig?: GoogleCloudDiscoveryengineV1alphaImportErrorConfig;
|
|
1410
1576
|
/** A sample of errors encountered while processing the data. */
|
|
1411
1577
|
errorSamples?: GoogleRpcStatus[];
|
|
1578
|
+
/** The metrics of the trained model. */
|
|
1579
|
+
metrics?: {[P in string]: number};
|
|
1412
1580
|
/** The trained model status. Possible values are: * **bad-data**: The training data quality is bad. * **no-improvement**: Tuning didn't improve performance. Won't deploy. * **in-progress**: Model training is in progress. * **ready**: The model is ready for serving. */
|
|
1413
1581
|
modelStatus?: string;
|
|
1414
1582
|
}
|
|
@@ -1537,6 +1705,8 @@ declare namespace gapi.client {
|
|
|
1537
1705
|
enableResultScore?: boolean;
|
|
1538
1706
|
/** Whether to enable safe search. */
|
|
1539
1707
|
enableSafeSearch?: boolean;
|
|
1708
|
+
/** Whether to enable search-as-you-type behavior for the search widget */
|
|
1709
|
+
enableSearchAsYouType?: boolean;
|
|
1540
1710
|
/** Turn on or off summary for each snippets result. */
|
|
1541
1711
|
enableSnippetResultSummary?: boolean;
|
|
1542
1712
|
/** Turn on or off summarization for the search response. */
|
|
@@ -1571,7 +1741,7 @@ declare namespace gapi.client {
|
|
|
1571
1741
|
displayName?: string;
|
|
1572
1742
|
/** Output only. the identifier of the collection, used for widget service. For now it refers to collection_id, in the future we will migrate the field to encrypted collection name UUID. */
|
|
1573
1743
|
id?: string;
|
|
1574
|
-
/** The name of the collection. It should be collection resource name. Format: `projects/{project_number}/locations/{location}/collections/{collection_id}`. For
|
|
1744
|
+
/** The name of the collection. It should be collection resource name. Format: `projects/{project_number}/locations/{location}/collections/{collection_id}`. For APIs under WidgetService, such as LookUpWidgetConfig, the project number and location part is erased in this field. */
|
|
1575
1745
|
name?: string;
|
|
1576
1746
|
}
|
|
1577
1747
|
interface GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreComponent {
|
|
@@ -1579,7 +1749,7 @@ declare namespace gapi.client {
|
|
|
1579
1749
|
displayName?: string;
|
|
1580
1750
|
/** Output only. the identifier of the data store, used for widget service. For now it refers to data_store_id, in the future we will migrate the field to encrypted data store name UUID. */
|
|
1581
1751
|
id?: string;
|
|
1582
|
-
/** The name of the data store. It should be data store resource name Format: `projects/{project_number}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. For
|
|
1752
|
+
/** The name of the data store. It should be data store resource name Format: `projects/{project_number}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. For APIs under WidgetService, such as LookUpWidgetConfig, the project number and location part is erased in this field. */
|
|
1583
1753
|
name?: string;
|
|
1584
1754
|
}
|
|
1585
1755
|
interface GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreUiConfig {
|
|
@@ -1591,7 +1761,7 @@ declare namespace gapi.client {
|
|
|
1591
1761
|
};
|
|
1592
1762
|
/** Output only. the identifier of the data store, used for widget service. For now it refers to data_store_id, in the future we will migrate the field to encrypted data store name UUID. */
|
|
1593
1763
|
id?: string;
|
|
1594
|
-
/** The name of the data store. It should be data store resource name Format: `projects/{project_number}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. For
|
|
1764
|
+
/** The name of the data store. It should be data store resource name Format: `projects/{project_number}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. For APIs under WidgetService, such as LookUpWidgetConfig, the project number and location part is erased in this field. */
|
|
1595
1765
|
name?: string;
|
|
1596
1766
|
}
|
|
1597
1767
|
interface GoogleCloudDiscoveryengineV1alphaWidgetConfigFacetField {
|
|
@@ -1819,6 +1989,10 @@ declare namespace gapi.client {
|
|
|
1819
1989
|
/** The search feature tier of this engine. Different tiers might have different pricing. To learn more, please check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified. */
|
|
1820
1990
|
searchTier?: string;
|
|
1821
1991
|
}
|
|
1992
|
+
interface GoogleCloudDiscoveryengineV1betaGroundingConfig {
|
|
1993
|
+
/** Required. Name of the GroundingConfig, of the form `projects/{project}/locations/{location}/groundingConfig`. */
|
|
1994
|
+
name?: string;
|
|
1995
|
+
}
|
|
1822
1996
|
interface GoogleCloudDiscoveryengineV1betaImportDocumentsMetadata {
|
|
1823
1997
|
/** Operation create time. */
|
|
1824
1998
|
createTime?: string;
|
|
@@ -1956,9 +2130,15 @@ declare namespace gapi.client {
|
|
|
1956
2130
|
errorConfig?: GoogleCloudDiscoveryengineV1betaImportErrorConfig;
|
|
1957
2131
|
/** A sample of errors encountered while processing the data. */
|
|
1958
2132
|
errorSamples?: GoogleRpcStatus[];
|
|
2133
|
+
/** The metrics of the trained model. */
|
|
2134
|
+
metrics?: {[P in string]: number};
|
|
1959
2135
|
/** The trained model status. Possible values are: * **bad-data**: The training data quality is bad. * **no-improvement**: Tuning didn't improve performance. Won't deploy. * **in-progress**: Model training is in progress. * **ready**: The model is ready for serving. */
|
|
1960
2136
|
modelStatus?: string;
|
|
1961
2137
|
}
|
|
2138
|
+
interface GoogleCloudDiscoveryengineV1betaTuneEngineMetadata {
|
|
2139
|
+
/** Required. The resource name of the engine that this tune applies to. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}` */
|
|
2140
|
+
engine?: string;
|
|
2141
|
+
}
|
|
1962
2142
|
interface GoogleCloudDiscoveryengineV1betaUpdateSchemaMetadata {
|
|
1963
2143
|
/** Operation create time. */
|
|
1964
2144
|
createTime?: string;
|
|
@@ -8979,6 +9159,66 @@ declare namespace gapi.client {
|
|
|
8979
9159
|
uploadType?: string;
|
|
8980
9160
|
}): Request<GoogleLongrunningListOperationsResponse>;
|
|
8981
9161
|
}
|
|
9162
|
+
interface RankingConfigsResource {
|
|
9163
|
+
/** Ranks a list of text records based on the given input query. */
|
|
9164
|
+
rank(request: {
|
|
9165
|
+
/** V1 error format. */
|
|
9166
|
+
'$.xgafv'?: string;
|
|
9167
|
+
/** OAuth access token. */
|
|
9168
|
+
access_token?: string;
|
|
9169
|
+
/** Data format for response. */
|
|
9170
|
+
alt?: string;
|
|
9171
|
+
/** JSONP */
|
|
9172
|
+
callback?: string;
|
|
9173
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
9174
|
+
fields?: string;
|
|
9175
|
+
/** 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. */
|
|
9176
|
+
key?: string;
|
|
9177
|
+
/** OAuth 2.0 token for the current user. */
|
|
9178
|
+
oauth_token?: string;
|
|
9179
|
+
/** Returns response with indentations and line breaks. */
|
|
9180
|
+
prettyPrint?: boolean;
|
|
9181
|
+
/** 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. */
|
|
9182
|
+
quotaUser?: string;
|
|
9183
|
+
/** Required. The resource name of the rank service config, such as `projects/{project_num}/locations/{location_id}/rankingConfigs/default_ranking_config`. */
|
|
9184
|
+
rankingConfig: string;
|
|
9185
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
9186
|
+
upload_protocol?: string;
|
|
9187
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
9188
|
+
uploadType?: string;
|
|
9189
|
+
/** Request body */
|
|
9190
|
+
resource: GoogleCloudDiscoveryengineV1alphaRankRequest;
|
|
9191
|
+
}): Request<GoogleCloudDiscoveryengineV1alphaRankResponse>;
|
|
9192
|
+
rank(
|
|
9193
|
+
request: {
|
|
9194
|
+
/** V1 error format. */
|
|
9195
|
+
'$.xgafv'?: string;
|
|
9196
|
+
/** OAuth access token. */
|
|
9197
|
+
access_token?: string;
|
|
9198
|
+
/** Data format for response. */
|
|
9199
|
+
alt?: string;
|
|
9200
|
+
/** JSONP */
|
|
9201
|
+
callback?: string;
|
|
9202
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
9203
|
+
fields?: string;
|
|
9204
|
+
/** 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. */
|
|
9205
|
+
key?: string;
|
|
9206
|
+
/** OAuth 2.0 token for the current user. */
|
|
9207
|
+
oauth_token?: string;
|
|
9208
|
+
/** Returns response with indentations and line breaks. */
|
|
9209
|
+
prettyPrint?: boolean;
|
|
9210
|
+
/** 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. */
|
|
9211
|
+
quotaUser?: string;
|
|
9212
|
+
/** Required. The resource name of the rank service config, such as `projects/{project_num}/locations/{location_id}/rankingConfigs/default_ranking_config`. */
|
|
9213
|
+
rankingConfig: string;
|
|
9214
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
9215
|
+
upload_protocol?: string;
|
|
9216
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
9217
|
+
uploadType?: string;
|
|
9218
|
+
},
|
|
9219
|
+
body: GoogleCloudDiscoveryengineV1alphaRankRequest
|
|
9220
|
+
): Request<GoogleCloudDiscoveryengineV1alphaRankResponse>;
|
|
9221
|
+
}
|
|
8982
9222
|
interface LocationsResource {
|
|
8983
9223
|
/** Estimates the data size to be used by a customer. */
|
|
8984
9224
|
estimateDataSize(request: {
|
|
@@ -9126,6 +9366,7 @@ declare namespace gapi.client {
|
|
|
9126
9366
|
collections: CollectionsResource;
|
|
9127
9367
|
dataStores: DataStoresResource;
|
|
9128
9368
|
operations: OperationsResource;
|
|
9369
|
+
rankingConfigs: RankingConfigsResource;
|
|
9129
9370
|
}
|
|
9130
9371
|
interface OperationsResource {
|
|
9131
9372
|
/** 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. */
|