@maxim_mazurok/gapi.client.discoveryengine-v1alpha 0.0.20240318 → 0.0.20240323
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 +165 -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: 20240323
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -122,6 +122,8 @@ declare namespace gapi.client {
|
|
|
122
122
|
tableId?: string;
|
|
123
123
|
}
|
|
124
124
|
interface GoogleCloudDiscoveryengineV1alphaChunk {
|
|
125
|
+
/** Output only. Metadata of the current chunk. */
|
|
126
|
+
chunkMetadata?: GoogleCloudDiscoveryengineV1alphaChunkChunkMetadata;
|
|
125
127
|
/** Content is a string from a document (parsed content). */
|
|
126
128
|
content?: string;
|
|
127
129
|
/** Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document. */
|
|
@@ -132,6 +134,14 @@ declare namespace gapi.client {
|
|
|
132
134
|
id?: string;
|
|
133
135
|
/** 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
136
|
name?: string;
|
|
137
|
+
/** Page span of the chunk. */
|
|
138
|
+
pageSpan?: GoogleCloudDiscoveryengineV1alphaChunkPageSpan;
|
|
139
|
+
}
|
|
140
|
+
interface GoogleCloudDiscoveryengineV1alphaChunkChunkMetadata {
|
|
141
|
+
/** 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. */
|
|
142
|
+
nextChunks?: GoogleCloudDiscoveryengineV1alphaChunk[];
|
|
143
|
+
/** 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. */
|
|
144
|
+
previousChunks?: GoogleCloudDiscoveryengineV1alphaChunk[];
|
|
135
145
|
}
|
|
136
146
|
interface GoogleCloudDiscoveryengineV1alphaChunkDocumentMetadata {
|
|
137
147
|
/** Title of the document. */
|
|
@@ -139,6 +149,12 @@ declare namespace gapi.client {
|
|
|
139
149
|
/** Uri of the document. */
|
|
140
150
|
uri?: string;
|
|
141
151
|
}
|
|
152
|
+
interface GoogleCloudDiscoveryengineV1alphaChunkPageSpan {
|
|
153
|
+
/** The end page of the chunk. */
|
|
154
|
+
pageEnd?: number;
|
|
155
|
+
/** The start page of the chunk. */
|
|
156
|
+
pageStart?: number;
|
|
157
|
+
}
|
|
142
158
|
interface GoogleCloudDiscoveryengineV1alphaCompleteQueryRequest {
|
|
143
159
|
/** 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
160
|
dataStore?: string;
|
|
@@ -556,6 +572,12 @@ declare namespace gapi.client {
|
|
|
556
572
|
/** The total number of items matching the request. This will always be populated in the response. */
|
|
557
573
|
totalSize?: number;
|
|
558
574
|
}
|
|
575
|
+
interface GoogleCloudDiscoveryengineV1alphaFhirStoreSource {
|
|
576
|
+
/** 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}`. */
|
|
577
|
+
fhirStore?: string;
|
|
578
|
+
/** 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. */
|
|
579
|
+
gcsStagingDir?: string;
|
|
580
|
+
}
|
|
559
581
|
interface GoogleCloudDiscoveryengineV1alphaFieldConfig {
|
|
560
582
|
/** 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
583
|
completableOption?: string;
|
|
@@ -582,6 +604,10 @@ declare namespace gapi.client {
|
|
|
582
604
|
/** 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
605
|
inputUris?: string[];
|
|
584
606
|
}
|
|
607
|
+
interface GoogleCloudDiscoveryengineV1alphaGroundingConfig {
|
|
608
|
+
/** Required. Name of the GroundingConfig, of the form `projects/{project}/locations/{location}/groundingConfig`. */
|
|
609
|
+
name?: string;
|
|
610
|
+
}
|
|
585
611
|
interface GoogleCloudDiscoveryengineV1alphaGuidedSearchSpec {
|
|
586
612
|
/** Whether or not to enable and include refinement attributes in gudied search result. */
|
|
587
613
|
enableRefinementAttributes?: boolean;
|
|
@@ -600,6 +626,20 @@ declare namespace gapi.client {
|
|
|
600
626
|
/** Workforce pool name. Example: "locations/global/workforcePools/pool_id" */
|
|
601
627
|
workforcePoolName?: string;
|
|
602
628
|
}
|
|
629
|
+
interface GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsMetadata {
|
|
630
|
+
/** Operation create time. */
|
|
631
|
+
createTime?: string;
|
|
632
|
+
/** Operation last update time. If the operation is done, this is also the finish time. */
|
|
633
|
+
updateTime?: string;
|
|
634
|
+
}
|
|
635
|
+
interface GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsResponse {
|
|
636
|
+
/** A sample of errors encountered while processing the request. */
|
|
637
|
+
errorSamples?: GoogleRpcStatus[];
|
|
638
|
+
/** Count of CompletionSuggestions that failed to be imported. */
|
|
639
|
+
failureCount?: string;
|
|
640
|
+
/** Count of CompletionSuggestions successfully imported. */
|
|
641
|
+
successCount?: string;
|
|
642
|
+
}
|
|
603
643
|
interface GoogleCloudDiscoveryengineV1alphaImportDocumentsMetadata {
|
|
604
644
|
/** Operation create time. */
|
|
605
645
|
createTime?: string;
|
|
@@ -611,15 +651,17 @@ declare namespace gapi.client {
|
|
|
611
651
|
updateTime?: string;
|
|
612
652
|
}
|
|
613
653
|
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.
|
|
654
|
+
/** 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
655
|
autoGenerateIds?: boolean;
|
|
616
656
|
/** BigQuery input source. */
|
|
617
657
|
bigquerySource?: GoogleCloudDiscoveryengineV1alphaBigQuerySource;
|
|
618
658
|
/** The desired location of errors incurred during the Import. */
|
|
619
659
|
errorConfig?: GoogleCloudDiscoveryengineV1alphaImportErrorConfig;
|
|
660
|
+
/** FhirStore input source. */
|
|
661
|
+
fhirStoreSource?: GoogleCloudDiscoveryengineV1alphaFhirStoreSource;
|
|
620
662
|
/** Cloud Storage location for the input content. */
|
|
621
663
|
gcsSource?: GoogleCloudDiscoveryengineV1alphaGcsSource;
|
|
622
|
-
/** The field
|
|
664
|
+
/** 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
665
|
idField?: string;
|
|
624
666
|
/** The Inline source for the input content for documents. */
|
|
625
667
|
inlineSource?: GoogleCloudDiscoveryengineV1alphaImportDocumentsRequestInlineSource;
|
|
@@ -870,6 +912,32 @@ declare namespace gapi.client {
|
|
|
870
912
|
/** The total count of events purged as a result of the operation. */
|
|
871
913
|
purgeCount?: string;
|
|
872
914
|
}
|
|
915
|
+
interface GoogleCloudDiscoveryengineV1alphaRankingRecord {
|
|
916
|
+
/** 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. */
|
|
917
|
+
content?: string;
|
|
918
|
+
/** The unique ID to represent the record. */
|
|
919
|
+
id?: string;
|
|
920
|
+
/** The score of this record based on the given query and selected model. */
|
|
921
|
+
score?: number;
|
|
922
|
+
/** 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. */
|
|
923
|
+
title?: string;
|
|
924
|
+
}
|
|
925
|
+
interface GoogleCloudDiscoveryengineV1alphaRankRequest {
|
|
926
|
+
/** If true, the response will contain only record ID and score. By default, it is false, the response will contain record details. */
|
|
927
|
+
ignoreRecordDetailsInResponse?: boolean;
|
|
928
|
+
/** 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. */
|
|
929
|
+
model?: string;
|
|
930
|
+
/** The query to use. */
|
|
931
|
+
query?: string;
|
|
932
|
+
/** Required. A list of records to rank. */
|
|
933
|
+
records?: GoogleCloudDiscoveryengineV1alphaRankingRecord[];
|
|
934
|
+
/** The number of results to return. If this is unset or no bigger than zero, returns all results. */
|
|
935
|
+
topN?: number;
|
|
936
|
+
}
|
|
937
|
+
interface GoogleCloudDiscoveryengineV1alphaRankResponse {
|
|
938
|
+
/** A list of records sorted by descending score. */
|
|
939
|
+
records?: GoogleCloudDiscoveryengineV1alphaRankingRecord[];
|
|
940
|
+
}
|
|
873
941
|
interface GoogleCloudDiscoveryengineV1alphaRecommendRequest {
|
|
874
942
|
/** 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
943
|
filter?: string;
|
|
@@ -1038,6 +1106,8 @@ declare namespace gapi.client {
|
|
|
1038
1106
|
condition?: string;
|
|
1039
1107
|
}
|
|
1040
1108
|
interface GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec {
|
|
1109
|
+
/** Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS */
|
|
1110
|
+
chunkSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecChunkSpec;
|
|
1041
1111
|
/** If there is no extractive_content_spec provided, there will be no extractive answer in the search response. */
|
|
1042
1112
|
extractiveContentSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec;
|
|
1043
1113
|
/** 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 +1117,12 @@ declare namespace gapi.client {
|
|
|
1047
1117
|
/** If `summarySpec` is not specified, summaries are not included in the search response. */
|
|
1048
1118
|
summarySpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec;
|
|
1049
1119
|
}
|
|
1120
|
+
interface GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecChunkSpec {
|
|
1121
|
+
/** 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. */
|
|
1122
|
+
numNextChunks?: number;
|
|
1123
|
+
/** 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. */
|
|
1124
|
+
numPreviousChunks?: number;
|
|
1125
|
+
}
|
|
1050
1126
|
interface GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec {
|
|
1051
1127
|
/** 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
1128
|
maxExtractiveAnswerCount?: number;
|
|
@@ -1251,6 +1327,8 @@ declare namespace gapi.client {
|
|
|
1251
1327
|
referenceIndex?: string;
|
|
1252
1328
|
}
|
|
1253
1329
|
interface GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryReference {
|
|
1330
|
+
/** List of cited chunk contents derived from document content. */
|
|
1331
|
+
chunkContents?: GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryReferenceChunkContent[];
|
|
1254
1332
|
/** Required. Document.name of the document. Full resource name of the referenced document, in the format `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`. */
|
|
1255
1333
|
document?: string;
|
|
1256
1334
|
/** Title of the document. */
|
|
@@ -1258,6 +1336,12 @@ declare namespace gapi.client {
|
|
|
1258
1336
|
/** Cloud Storage or HTTP uri for the document. */
|
|
1259
1337
|
uri?: string;
|
|
1260
1338
|
}
|
|
1339
|
+
interface GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryReferenceChunkContent {
|
|
1340
|
+
/** Chunk textual content. */
|
|
1341
|
+
content?: string;
|
|
1342
|
+
/** Page identifier. */
|
|
1343
|
+
pageIdentifier?: string;
|
|
1344
|
+
}
|
|
1261
1345
|
interface GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySafetyAttributes {
|
|
1262
1346
|
/** The display names of Safety Attribute categories associated with the generated content. Order matches the Scores. */
|
|
1263
1347
|
categories?: string[];
|
|
@@ -1409,6 +1493,8 @@ declare namespace gapi.client {
|
|
|
1409
1493
|
errorConfig?: GoogleCloudDiscoveryengineV1alphaImportErrorConfig;
|
|
1410
1494
|
/** A sample of errors encountered while processing the data. */
|
|
1411
1495
|
errorSamples?: GoogleRpcStatus[];
|
|
1496
|
+
/** The metrics of the trained model. */
|
|
1497
|
+
metrics?: {[P in string]: number};
|
|
1412
1498
|
/** 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
1499
|
modelStatus?: string;
|
|
1414
1500
|
}
|
|
@@ -1537,6 +1623,8 @@ declare namespace gapi.client {
|
|
|
1537
1623
|
enableResultScore?: boolean;
|
|
1538
1624
|
/** Whether to enable safe search. */
|
|
1539
1625
|
enableSafeSearch?: boolean;
|
|
1626
|
+
/** Whether to enable search-as-you-type behavior for the search widget */
|
|
1627
|
+
enableSearchAsYouType?: boolean;
|
|
1540
1628
|
/** Turn on or off summary for each snippets result. */
|
|
1541
1629
|
enableSnippetResultSummary?: boolean;
|
|
1542
1630
|
/** Turn on or off summarization for the search response. */
|
|
@@ -1571,7 +1659,7 @@ declare namespace gapi.client {
|
|
|
1571
1659
|
displayName?: string;
|
|
1572
1660
|
/** 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
1661
|
id?: string;
|
|
1574
|
-
/** The name of the collection. It should be collection resource name. Format: `projects/{project_number}/locations/{location}/collections/{collection_id}`. For
|
|
1662
|
+
/** 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
1663
|
name?: string;
|
|
1576
1664
|
}
|
|
1577
1665
|
interface GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreComponent {
|
|
@@ -1579,7 +1667,7 @@ declare namespace gapi.client {
|
|
|
1579
1667
|
displayName?: string;
|
|
1580
1668
|
/** 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
1669
|
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
|
|
1670
|
+
/** 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
1671
|
name?: string;
|
|
1584
1672
|
}
|
|
1585
1673
|
interface GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreUiConfig {
|
|
@@ -1591,7 +1679,7 @@ declare namespace gapi.client {
|
|
|
1591
1679
|
};
|
|
1592
1680
|
/** 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
1681
|
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
|
|
1682
|
+
/** 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
1683
|
name?: string;
|
|
1596
1684
|
}
|
|
1597
1685
|
interface GoogleCloudDiscoveryengineV1alphaWidgetConfigFacetField {
|
|
@@ -1819,6 +1907,10 @@ declare namespace gapi.client {
|
|
|
1819
1907
|
/** 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
1908
|
searchTier?: string;
|
|
1821
1909
|
}
|
|
1910
|
+
interface GoogleCloudDiscoveryengineV1betaGroundingConfig {
|
|
1911
|
+
/** Required. Name of the GroundingConfig, of the form `projects/{project}/locations/{location}/groundingConfig`. */
|
|
1912
|
+
name?: string;
|
|
1913
|
+
}
|
|
1822
1914
|
interface GoogleCloudDiscoveryengineV1betaImportDocumentsMetadata {
|
|
1823
1915
|
/** Operation create time. */
|
|
1824
1916
|
createTime?: string;
|
|
@@ -1956,9 +2048,15 @@ declare namespace gapi.client {
|
|
|
1956
2048
|
errorConfig?: GoogleCloudDiscoveryengineV1betaImportErrorConfig;
|
|
1957
2049
|
/** A sample of errors encountered while processing the data. */
|
|
1958
2050
|
errorSamples?: GoogleRpcStatus[];
|
|
2051
|
+
/** The metrics of the trained model. */
|
|
2052
|
+
metrics?: {[P in string]: number};
|
|
1959
2053
|
/** 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
2054
|
modelStatus?: string;
|
|
1961
2055
|
}
|
|
2056
|
+
interface GoogleCloudDiscoveryengineV1betaTuneEngineMetadata {
|
|
2057
|
+
/** 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}` */
|
|
2058
|
+
engine?: string;
|
|
2059
|
+
}
|
|
1962
2060
|
interface GoogleCloudDiscoveryengineV1betaUpdateSchemaMetadata {
|
|
1963
2061
|
/** Operation create time. */
|
|
1964
2062
|
createTime?: string;
|
|
@@ -8979,6 +9077,66 @@ declare namespace gapi.client {
|
|
|
8979
9077
|
uploadType?: string;
|
|
8980
9078
|
}): Request<GoogleLongrunningListOperationsResponse>;
|
|
8981
9079
|
}
|
|
9080
|
+
interface RankingConfigsResource {
|
|
9081
|
+
/** Ranks a list of text records based on the given input query. */
|
|
9082
|
+
rank(request: {
|
|
9083
|
+
/** V1 error format. */
|
|
9084
|
+
'$.xgafv'?: string;
|
|
9085
|
+
/** OAuth access token. */
|
|
9086
|
+
access_token?: string;
|
|
9087
|
+
/** Data format for response. */
|
|
9088
|
+
alt?: string;
|
|
9089
|
+
/** JSONP */
|
|
9090
|
+
callback?: string;
|
|
9091
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
9092
|
+
fields?: string;
|
|
9093
|
+
/** 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. */
|
|
9094
|
+
key?: string;
|
|
9095
|
+
/** OAuth 2.0 token for the current user. */
|
|
9096
|
+
oauth_token?: string;
|
|
9097
|
+
/** Returns response with indentations and line breaks. */
|
|
9098
|
+
prettyPrint?: boolean;
|
|
9099
|
+
/** 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. */
|
|
9100
|
+
quotaUser?: string;
|
|
9101
|
+
/** Required. The resource name of the rank service config, such as `projects/{project_num}/locations/{location_id}/rankingConfigs/default_ranking_config`. */
|
|
9102
|
+
rankingConfig: string;
|
|
9103
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
9104
|
+
upload_protocol?: string;
|
|
9105
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
9106
|
+
uploadType?: string;
|
|
9107
|
+
/** Request body */
|
|
9108
|
+
resource: GoogleCloudDiscoveryengineV1alphaRankRequest;
|
|
9109
|
+
}): Request<GoogleCloudDiscoveryengineV1alphaRankResponse>;
|
|
9110
|
+
rank(
|
|
9111
|
+
request: {
|
|
9112
|
+
/** V1 error format. */
|
|
9113
|
+
'$.xgafv'?: string;
|
|
9114
|
+
/** OAuth access token. */
|
|
9115
|
+
access_token?: string;
|
|
9116
|
+
/** Data format for response. */
|
|
9117
|
+
alt?: string;
|
|
9118
|
+
/** JSONP */
|
|
9119
|
+
callback?: string;
|
|
9120
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
9121
|
+
fields?: string;
|
|
9122
|
+
/** 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. */
|
|
9123
|
+
key?: string;
|
|
9124
|
+
/** OAuth 2.0 token for the current user. */
|
|
9125
|
+
oauth_token?: string;
|
|
9126
|
+
/** Returns response with indentations and line breaks. */
|
|
9127
|
+
prettyPrint?: boolean;
|
|
9128
|
+
/** 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. */
|
|
9129
|
+
quotaUser?: string;
|
|
9130
|
+
/** Required. The resource name of the rank service config, such as `projects/{project_num}/locations/{location_id}/rankingConfigs/default_ranking_config`. */
|
|
9131
|
+
rankingConfig: string;
|
|
9132
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
9133
|
+
upload_protocol?: string;
|
|
9134
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
9135
|
+
uploadType?: string;
|
|
9136
|
+
},
|
|
9137
|
+
body: GoogleCloudDiscoveryengineV1alphaRankRequest
|
|
9138
|
+
): Request<GoogleCloudDiscoveryengineV1alphaRankResponse>;
|
|
9139
|
+
}
|
|
8982
9140
|
interface LocationsResource {
|
|
8983
9141
|
/** Estimates the data size to be used by a customer. */
|
|
8984
9142
|
estimateDataSize(request: {
|
|
@@ -9126,6 +9284,7 @@ declare namespace gapi.client {
|
|
|
9126
9284
|
collections: CollectionsResource;
|
|
9127
9285
|
dataStores: DataStoresResource;
|
|
9128
9286
|
operations: OperationsResource;
|
|
9287
|
+
rankingConfigs: RankingConfigsResource;
|
|
9129
9288
|
}
|
|
9130
9289
|
interface OperationsResource {
|
|
9131
9290
|
/** 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. */
|