@maxim_mazurok/gapi.client.discoveryengine-v1beta 0.0.20231130 → 0.0.20231209
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 +67 -2
- 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=v1beta
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20231209
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -255,6 +255,16 @@ declare namespace gapi.client {
|
|
|
255
255
|
searchTier?: string;
|
|
256
256
|
}
|
|
257
257
|
interface GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig {}
|
|
258
|
+
interface GoogleCloudDiscoveryengineV1alphaEstimateDataSizeMetadata {
|
|
259
|
+
/** Operation create time. */
|
|
260
|
+
createTime?: string;
|
|
261
|
+
}
|
|
262
|
+
interface GoogleCloudDiscoveryengineV1alphaEstimateDataSizeResponse {
|
|
263
|
+
/** Data size in terms of bytes. */
|
|
264
|
+
dataSizeBytes?: string;
|
|
265
|
+
/** Total number of documents. */
|
|
266
|
+
documentCount?: string;
|
|
267
|
+
}
|
|
258
268
|
interface GoogleCloudDiscoveryengineV1alphaFieldConfig {
|
|
259
269
|
/** 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. */
|
|
260
270
|
completableOption?: string;
|
|
@@ -420,6 +430,20 @@ declare namespace gapi.client {
|
|
|
420
430
|
quotaFailure?: any;
|
|
421
431
|
}
|
|
422
432
|
interface GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure {}
|
|
433
|
+
interface GoogleCloudDiscoveryengineV1alphaTrainCustomModelMetadata {
|
|
434
|
+
/** Operation create time. */
|
|
435
|
+
createTime?: string;
|
|
436
|
+
/** Operation last update time. If the operation is done, this is also the finish time. */
|
|
437
|
+
updateTime?: string;
|
|
438
|
+
}
|
|
439
|
+
interface GoogleCloudDiscoveryengineV1alphaTrainCustomModelResponse {
|
|
440
|
+
/** Echoes the destination for the complete errors in the request if set. */
|
|
441
|
+
errorConfig?: GoogleCloudDiscoveryengineV1alphaImportErrorConfig;
|
|
442
|
+
/** A sample of errors encountered while processing the data. */
|
|
443
|
+
errorSamples?: GoogleRpcStatus[];
|
|
444
|
+
/** 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. */
|
|
445
|
+
modelStatus?: string;
|
|
446
|
+
}
|
|
423
447
|
interface GoogleCloudDiscoveryengineV1alphaTuneEngineMetadata {
|
|
424
448
|
/** 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}` */
|
|
425
449
|
engine?: string;
|
|
@@ -500,6 +524,8 @@ declare namespace gapi.client {
|
|
|
500
524
|
interface GoogleCloudDiscoveryengineV1betaConverseConversationRequest {
|
|
501
525
|
/** The conversation to be used by auto session only. The name field will be ignored as we automatically assign new name for the conversation in auto session. */
|
|
502
526
|
conversation?: GoogleCloudDiscoveryengineV1betaConversation;
|
|
527
|
+
/** The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. This will be used to filter search results which may affect the summary response. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customer might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) */
|
|
528
|
+
filter?: string;
|
|
503
529
|
/** Required. Current user input. */
|
|
504
530
|
query?: GoogleCloudDiscoveryengineV1betaTextInput;
|
|
505
531
|
/** Whether to turn on safe search. */
|
|
@@ -892,13 +918,19 @@ declare namespace gapi.client {
|
|
|
892
918
|
includeCitations?: boolean;
|
|
893
919
|
/** Language code for Summary. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is an experimental feature. */
|
|
894
920
|
languageCode?: string;
|
|
921
|
+
/** If specified, the spec will be used to modify the prompt provided to the LLM. */
|
|
922
|
+
modelPromptSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec;
|
|
895
923
|
/** If specified, the spec will be used to modify the model specification provided to the LLM. */
|
|
896
924
|
modelSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec;
|
|
897
925
|
/** The number of top results to generate the summary from. If the number of results returned is less than `summaryResultCount`, the summary is generated from all of the results. At most five results can be used to generate a summary. */
|
|
898
926
|
summaryResultCount?: number;
|
|
899
927
|
}
|
|
928
|
+
interface GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec {
|
|
929
|
+
/** Text at the beginning of the prompt that instructs the assistant. Examples are available in the user guide. */
|
|
930
|
+
preamble?: string;
|
|
931
|
+
}
|
|
900
932
|
interface GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec {
|
|
901
|
-
/** The string format of the model version. e.g. stable,
|
|
933
|
+
/** The string format of the model version. e.g. stable, preview, etc. */
|
|
902
934
|
version?: string;
|
|
903
935
|
}
|
|
904
936
|
interface GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec {
|
|
@@ -1031,6 +1063,31 @@ declare namespace gapi.client {
|
|
|
1031
1063
|
summarySkippedReasons?: string[];
|
|
1032
1064
|
/** The summary content. */
|
|
1033
1065
|
summaryText?: string;
|
|
1066
|
+
summaryWithMetadata?: GoogleCloudDiscoveryengineV1betaSearchResponseSummarySummaryWithMetadata;
|
|
1067
|
+
}
|
|
1068
|
+
interface GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitation {
|
|
1069
|
+
/** End of the attributed segment, exclusive. */
|
|
1070
|
+
endIndex?: string;
|
|
1071
|
+
/** Citation sources for the attributed segment. */
|
|
1072
|
+
sources?: GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitationSource[];
|
|
1073
|
+
/** Index indicates the start of the segment, measured in bytes/unicode. */
|
|
1074
|
+
startIndex?: string;
|
|
1075
|
+
}
|
|
1076
|
+
interface GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitationMetadata {
|
|
1077
|
+
/** Citations for segments. */
|
|
1078
|
+
citations?: GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitation[];
|
|
1079
|
+
}
|
|
1080
|
+
interface GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitationSource {
|
|
1081
|
+
/** Document reference index from SummaryWithMetadata.references. It is 0-indexed and the value will be zero if the reference_index is not set explicitly. */
|
|
1082
|
+
referenceIndex?: string;
|
|
1083
|
+
}
|
|
1084
|
+
interface GoogleCloudDiscoveryengineV1betaSearchResponseSummaryReference {
|
|
1085
|
+
/** Required. Document.name of the document. Full resource name of the referenced document, in the format `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`. */
|
|
1086
|
+
document?: string;
|
|
1087
|
+
/** Title of the document. */
|
|
1088
|
+
title?: string;
|
|
1089
|
+
/** GCS or HTTP uri for the document. */
|
|
1090
|
+
uri?: string;
|
|
1034
1091
|
}
|
|
1035
1092
|
interface GoogleCloudDiscoveryengineV1betaSearchResponseSummarySafetyAttributes {
|
|
1036
1093
|
/** The display names of Safety Attribute categories associated with the generated content. Order matches the Scores. */
|
|
@@ -1038,6 +1095,14 @@ declare namespace gapi.client {
|
|
|
1038
1095
|
/** The confidence scores of the each category, higher value means higher confidence. Order matches the Categories. */
|
|
1039
1096
|
scores?: number[];
|
|
1040
1097
|
}
|
|
1098
|
+
interface GoogleCloudDiscoveryengineV1betaSearchResponseSummarySummaryWithMetadata {
|
|
1099
|
+
/** Citation metadata for given summary. */
|
|
1100
|
+
citationMetadata?: GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitationMetadata;
|
|
1101
|
+
/** Document References. */
|
|
1102
|
+
references?: GoogleCloudDiscoveryengineV1betaSearchResponseSummaryReference[];
|
|
1103
|
+
/** Summary text with no citation information. */
|
|
1104
|
+
summary?: string;
|
|
1105
|
+
}
|
|
1041
1106
|
interface GoogleCloudDiscoveryengineV1betaTextInput {
|
|
1042
1107
|
/** Conversation context of the input. */
|
|
1043
1108
|
context?: GoogleCloudDiscoveryengineV1betaConversationContext;
|