@maxim_mazurok/gapi.client.discoveryengine-v1beta 0.0.20231130 → 0.0.20231218

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.
Files changed (2) hide show
  1. package/index.d.ts +81 -2
  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: 20231130
12
+ // Revision: 20231218
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -163,6 +163,12 @@ declare namespace gapi.client {
163
163
  updateTime?: string;
164
164
  }
165
165
  interface GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchResponse {}
166
+ interface GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig {
167
+ /** Output only. The full resource name of the Document Processing Config. Format: `projects/*‍/locations/*‍/collections/*‍/dataStores/*‍/documentProcessingConfig`. */
168
+ name?: string;
169
+ /** The OCR config. Currently it only applies to PDFs. */
170
+ ocrConfig?: GoogleCloudDiscoveryengineV1alphaOcrConfig;
171
+ }
166
172
  interface GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchMetadata {
167
173
  /** Operation create time. */
168
174
  createTime?: string;
@@ -255,6 +261,16 @@ declare namespace gapi.client {
255
261
  searchTier?: string;
256
262
  }
257
263
  interface GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig {}
264
+ interface GoogleCloudDiscoveryengineV1alphaEstimateDataSizeMetadata {
265
+ /** Operation create time. */
266
+ createTime?: string;
267
+ }
268
+ interface GoogleCloudDiscoveryengineV1alphaEstimateDataSizeResponse {
269
+ /** Data size in terms of bytes. */
270
+ dataSizeBytes?: string;
271
+ /** Total number of documents. */
272
+ documentCount?: string;
273
+ }
258
274
  interface GoogleCloudDiscoveryengineV1alphaFieldConfig {
259
275
  /** 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
276
  completableOption?: string;
@@ -315,6 +331,14 @@ declare namespace gapi.client {
315
331
  /** Count of user events imported, but with Document information not found in the existing Branch. */
316
332
  unjoinedEventsCount?: string;
317
333
  }
334
+ interface GoogleCloudDiscoveryengineV1alphaOcrConfig {
335
+ /** Required. If OCR is enabled or not. OCR must be enabled for other OcrConfig options to apply. */
336
+ enabled?: boolean;
337
+ /** Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model. */
338
+ enhancedDocumentElements?: string[];
339
+ /** If true, will use native text instead of OCR text on pages containing native text. */
340
+ useNativeText?: boolean;
341
+ }
318
342
  interface GoogleCloudDiscoveryengineV1alphaPurgeDocumentsMetadata {
319
343
  /** Operation create time. */
320
344
  createTime?: string;
@@ -420,6 +444,20 @@ declare namespace gapi.client {
420
444
  quotaFailure?: any;
421
445
  }
422
446
  interface GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure {}
447
+ interface GoogleCloudDiscoveryengineV1alphaTrainCustomModelMetadata {
448
+ /** Operation create time. */
449
+ createTime?: string;
450
+ /** Operation last update time. If the operation is done, this is also the finish time. */
451
+ updateTime?: string;
452
+ }
453
+ interface GoogleCloudDiscoveryengineV1alphaTrainCustomModelResponse {
454
+ /** Echoes the destination for the complete errors in the request if set. */
455
+ errorConfig?: GoogleCloudDiscoveryengineV1alphaImportErrorConfig;
456
+ /** A sample of errors encountered while processing the data. */
457
+ errorSamples?: GoogleRpcStatus[];
458
+ /** 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. */
459
+ modelStatus?: string;
460
+ }
423
461
  interface GoogleCloudDiscoveryengineV1alphaTuneEngineMetadata {
424
462
  /** 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
463
  engine?: string;
@@ -500,6 +538,8 @@ declare namespace gapi.client {
500
538
  interface GoogleCloudDiscoveryengineV1betaConverseConversationRequest {
501
539
  /** 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
540
  conversation?: GoogleCloudDiscoveryengineV1betaConversation;
541
+ /** 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) */
542
+ filter?: string;
503
543
  /** Required. Current user input. */
504
544
  query?: GoogleCloudDiscoveryengineV1betaTextInput;
505
545
  /** Whether to turn on safe search. */
@@ -892,13 +932,19 @@ declare namespace gapi.client {
892
932
  includeCitations?: boolean;
893
933
  /** 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
934
  languageCode?: string;
935
+ /** If specified, the spec will be used to modify the prompt provided to the LLM. */
936
+ modelPromptSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec;
895
937
  /** If specified, the spec will be used to modify the model specification provided to the LLM. */
896
938
  modelSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec;
897
939
  /** 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
940
  summaryResultCount?: number;
899
941
  }
942
+ interface GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec {
943
+ /** Text at the beginning of the prompt that instructs the assistant. Examples are available in the user guide. */
944
+ preamble?: string;
945
+ }
900
946
  interface GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec {
901
- /** The string format of the model version. e.g. stable, latest, etc. */
947
+ /** The string format of the model version. e.g. stable, preview, etc. */
902
948
  version?: string;
903
949
  }
904
950
  interface GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec {
@@ -1031,6 +1077,31 @@ declare namespace gapi.client {
1031
1077
  summarySkippedReasons?: string[];
1032
1078
  /** The summary content. */
1033
1079
  summaryText?: string;
1080
+ summaryWithMetadata?: GoogleCloudDiscoveryengineV1betaSearchResponseSummarySummaryWithMetadata;
1081
+ }
1082
+ interface GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitation {
1083
+ /** End of the attributed segment, exclusive. */
1084
+ endIndex?: string;
1085
+ /** Citation sources for the attributed segment. */
1086
+ sources?: GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitationSource[];
1087
+ /** Index indicates the start of the segment, measured in bytes/unicode. */
1088
+ startIndex?: string;
1089
+ }
1090
+ interface GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitationMetadata {
1091
+ /** Citations for segments. */
1092
+ citations?: GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitation[];
1093
+ }
1094
+ interface GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitationSource {
1095
+ /** Document reference index from SummaryWithMetadata.references. It is 0-indexed and the value will be zero if the reference_index is not set explicitly. */
1096
+ referenceIndex?: string;
1097
+ }
1098
+ interface GoogleCloudDiscoveryengineV1betaSearchResponseSummaryReference {
1099
+ /** Required. Document.name of the document. Full resource name of the referenced document, in the format `projects/*‍/locations/*‍/collections/*‍/dataStores/*‍/branches/*‍/documents/*`. */
1100
+ document?: string;
1101
+ /** Title of the document. */
1102
+ title?: string;
1103
+ /** GCS or HTTP uri for the document. */
1104
+ uri?: string;
1034
1105
  }
1035
1106
  interface GoogleCloudDiscoveryengineV1betaSearchResponseSummarySafetyAttributes {
1036
1107
  /** The display names of Safety Attribute categories associated with the generated content. Order matches the Scores. */
@@ -1038,6 +1109,14 @@ declare namespace gapi.client {
1038
1109
  /** The confidence scores of the each category, higher value means higher confidence. Order matches the Categories. */
1039
1110
  scores?: number[];
1040
1111
  }
1112
+ interface GoogleCloudDiscoveryengineV1betaSearchResponseSummarySummaryWithMetadata {
1113
+ /** Citation metadata for given summary. */
1114
+ citationMetadata?: GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitationMetadata;
1115
+ /** Document References. */
1116
+ references?: GoogleCloudDiscoveryengineV1betaSearchResponseSummaryReference[];
1117
+ /** Summary text with no citation information. */
1118
+ summary?: string;
1119
+ }
1041
1120
  interface GoogleCloudDiscoveryengineV1betaTextInput {
1042
1121
  /** Conversation context of the input. */
1043
1122
  context?: GoogleCloudDiscoveryengineV1betaConversationContext;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.discoveryengine-v1beta",
3
- "version": "0.0.20231130",
3
+ "version": "0.0.20231218",
4
4
  "description": "TypeScript typings for Discovery Engine API v1beta",
5
5
  "repository": {
6
6
  "type": "git",