@maxim_mazurok/gapi.client.discoveryengine-v1alpha 0.0.20240715 → 0.0.20240801

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 +66 -42
  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=v1alpha
12
- // Revision: 20240715
12
+ // Revision: 20240801
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -363,6 +363,8 @@ declare namespace gapi.client {
363
363
  interface GoogleCloudDiscoveryengineV1alphaAnswerReference {
364
364
  /** Chunk information. */
365
365
  chunkInfo?: GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo;
366
+ /** Structured document information. */
367
+ structuredDocumentInfo?: GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo;
366
368
  /** Unstructured document information. */
367
369
  unstructuredDocumentInfo?: GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo;
368
370
  }
@@ -373,7 +375,7 @@ declare namespace gapi.client {
373
375
  content?: string;
374
376
  /** Document metadata. */
375
377
  documentMetadata?: GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfoDocumentMetadata;
376
- /** Relevance score. */
378
+ /** The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. */
377
379
  relevanceScore?: number;
378
380
  }
379
381
  interface GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfoDocumentMetadata {
@@ -388,6 +390,12 @@ declare namespace gapi.client {
388
390
  /** URI for the document. */
389
391
  uri?: string;
390
392
  }
393
+ interface GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo {
394
+ /** Document resource name. */
395
+ document?: string;
396
+ /** Structured search data. */
397
+ structData?: {[P in string]: any};
398
+ }
391
399
  interface GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo {
392
400
  /** List of cited chunk contents derived from document content. */
393
401
  chunkContents?: GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfoChunkContent[];
@@ -405,6 +413,8 @@ declare namespace gapi.client {
405
413
  content?: string;
406
414
  /** Page identifier. */
407
415
  pageIdentifier?: string;
416
+ /** The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. */
417
+ relevanceScore?: number;
408
418
  }
409
419
  interface GoogleCloudDiscoveryengineV1alphaAnswerStep {
410
420
  /** Actions. */
@@ -445,7 +455,7 @@ declare namespace gapi.client {
445
455
  chunk?: string;
446
456
  /** Chunk textual content. */
447
457
  content?: string;
448
- /** Relevance score. */
458
+ /** The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. */
449
459
  relevanceScore?: number;
450
460
  }
451
461
  interface GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo {
@@ -935,6 +945,8 @@ declare namespace gapi.client {
935
945
  readers?: GoogleCloudDiscoveryengineV1alphaDocumentAclInfoAccessRestriction[];
936
946
  }
937
947
  interface GoogleCloudDiscoveryengineV1alphaDocumentAclInfoAccessRestriction {
948
+ /** All users within the Identity Provider. */
949
+ idpWide?: boolean;
938
950
  /** List of principals. */
939
951
  principals?: GoogleCloudDiscoveryengineV1alphaPrincipal[];
940
952
  }
@@ -949,6 +961,8 @@ declare namespace gapi.client {
949
961
  interface GoogleCloudDiscoveryengineV1alphaDocumentInfo {
950
962
  /** The Document resource ID. */
951
963
  id?: string;
964
+ /** Output only. Whether the referenced Document can be found in the data store. */
965
+ joined?: boolean;
952
966
  /** The Document resource full name, of the form: `projects/{project_id}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/branches/{branch_id}/documents/{document_id}` */
953
967
  name?: string;
954
968
  /** The promotion IDs associated with this Document. Currently, this field is restricted to at most one ID. */
@@ -965,7 +979,7 @@ declare namespace gapi.client {
965
979
  defaultParsingConfig?: GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig;
966
980
  /** The full resource name of the Document Processing Config. Format: `projects/*‍/locations/*‍/collections/*‍/dataStores/*‍/documentProcessingConfig`. */
967
981
  name?: string;
968
- /** Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported. */
982
+ /** Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported. * `xlsx`: Override parsing config for XLSX files, only digital parsing and layout parsing are supported. */
969
983
  parsingConfigOverrides?: {
970
984
  [P in string]: GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig;
971
985
  };
@@ -1144,7 +1158,7 @@ declare namespace gapi.client {
1144
1158
  errorSamples?: GoogleRpcStatus[];
1145
1159
  /** Required. The specification of the evaluation. */
1146
1160
  evaluationSpec?: GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpec;
1147
- /** Immutable. The full resource name of the Evaluation, in the format of `projects/{project}/locations/{location}/evaluations/{evaluation}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */
1161
+ /** Identifier. The full resource name of the Evaluation, in the format of `projects/{project}/locations/{location}/evaluations/{evaluation}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */
1148
1162
  name?: string;
1149
1163
  /** Output only. The metrics produced by the evaluation, averaged across all SampleQuerys in the SampleQuerySet. Only populated when the evaluation's state is SUCCEEDED. */
1150
1164
  qualityMetrics?: GoogleCloudDiscoveryengineV1alphaQualityMetrics;
@@ -1161,18 +1175,6 @@ declare namespace gapi.client {
1161
1175
  /** Required. The full resource name of the SampleQuerySet used for the evaluation, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. */
1162
1176
  sampleQuerySet?: string;
1163
1177
  }
1164
- interface GoogleCloudDiscoveryengineV1alphaExportUserEventsMetadata {
1165
- /** Operation create time. */
1166
- createTime?: string;
1167
- /** Operation last update time. If the operation is done, this is also the finish time. */
1168
- updateTime?: string;
1169
- }
1170
- interface GoogleCloudDiscoveryengineV1alphaExportUserEventsResponse {
1171
- /** Output result indicating where the data were exported to. */
1172
- outputResult?: GoogleCloudDiscoveryengineV1alphaOutputResult;
1173
- /** The status of the export operation. */
1174
- status?: GoogleRpcStatus;
1175
- }
1176
1178
  interface GoogleCloudDiscoveryengineV1alphaFactChunk {
1177
1179
  /** Text content of the fact chunk. Can be at most 10K characters long. */
1178
1180
  chunkText?: string;
@@ -1196,6 +1198,8 @@ declare namespace gapi.client {
1196
1198
  fhirStore?: string;
1197
1199
  /** 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. */
1198
1200
  gcsStagingDir?: string;
1201
+ /** The FHIR resource types to import. The resource types should be a subset of all [supported FHIR resource types](https://cloud.google.com/generative-ai-app-builder/docs/fhir-schema-reference#resource-level-specification). Default to all supported FHIR resource types if empty. */
1202
+ resourceTypes?: string[];
1199
1203
  }
1200
1204
  interface GoogleCloudDiscoveryengineV1alphaFieldConfig {
1201
1205
  /** If this field is set, only the corresponding source will be indexed for this field. Otherwise, the values from different sources are merged. Assuming a page with `` in meta tag, and `` in page map: if this enum is set to METATAGS, we will only index ``; if this enum is not set, we will merge them and index ``. */
@@ -1563,16 +1567,6 @@ declare namespace gapi.client {
1563
1567
  /** Media progress should be computed using only the media_progress_duration relative to the media total length. This value must be between `[0, 1.0]` inclusive. If this is not a playback or the progress cannot be computed (e.g. ongoing livestream), this field should be unset. */
1564
1568
  mediaProgressPercentage?: number;
1565
1569
  }
1566
- interface GoogleCloudDiscoveryengineV1alphaOutputResult {
1567
- /** The BigQuery location where the result is stored. */
1568
- bigqueryResult?: GoogleCloudDiscoveryengineV1alphaOutputResultBigQueryOutputResult;
1569
- }
1570
- interface GoogleCloudDiscoveryengineV1alphaOutputResultBigQueryOutputResult {
1571
- /** The ID of a BigQuery Dataset. */
1572
- datasetId?: string;
1573
- /** The ID of a BigQuery Table. */
1574
- tableId?: string;
1575
- }
1576
1570
  interface GoogleCloudDiscoveryengineV1alphaPageInfo {
1577
1571
  /** The most specific category associated with a category page. To represent full path of category, use '>' sign to separate different hierarchies. If '>' is part of the category name, replace it with other character(s). Category pages include special pages such as sales or promotions. For instance, a special sale page may have the category hierarchy: `"pageCategory" : "Sales > 2017 Black Friday Deals"`. Required for `view-category-page` events. Other event types should not set this field. Otherwise, an `INVALID_ARGUMENT` error is returned. */
1578
1572
  pageCategory?: string;
@@ -1671,6 +1665,12 @@ declare namespace gapi.client {
1671
1665
  force?: boolean;
1672
1666
  /** Cloud Storage location for the input content. Supported `data_schema`: * `document_id`: One valid Document.id per line. */
1673
1667
  gcsSource?: GoogleCloudDiscoveryengineV1alphaGcsSource;
1668
+ /** Inline source for the input content for purge. */
1669
+ inlineSource?: GoogleCloudDiscoveryengineV1alphaPurgeDocumentsRequestInlineSource;
1670
+ }
1671
+ interface GoogleCloudDiscoveryengineV1alphaPurgeDocumentsRequestInlineSource {
1672
+ /** Required. A list of full resource name of documents to purge. In the format `projects/*‍/locations/*‍/collections/*‍/dataStores/*‍/branches/*‍/documents/*`. Recommended max of 100 items. */
1673
+ documents?: string[];
1674
1674
  }
1675
1675
  interface GoogleCloudDiscoveryengineV1alphaPurgeDocumentsResponse {
1676
1676
  /** The total count of documents purged as a result of the operation. */
@@ -1917,7 +1917,7 @@ declare namespace gapi.client {
1917
1917
  interface GoogleCloudDiscoveryengineV1alphaSampleQuery {
1918
1918
  /** Output only. Timestamp the SampleQuery was created at. */
1919
1919
  createTime?: string;
1920
- /** Immutable. The full resource name of the sample query, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */
1920
+ /** Identifier. The full resource name of the sample query, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */
1921
1921
  name?: string;
1922
1922
  /** The query entry. */
1923
1923
  queryEntry?: GoogleCloudDiscoveryengineV1alphaSampleQueryQueryEntry;
@@ -1943,7 +1943,7 @@ declare namespace gapi.client {
1943
1943
  description?: string;
1944
1944
  /** Required. The sample query set display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. */
1945
1945
  displayName?: string;
1946
- /** Immutable. The full resource name of the SampleQuerySet, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */
1946
+ /** Identifier. The full resource name of the SampleQuerySet, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */
1947
1947
  name?: string;
1948
1948
  }
1949
1949
  interface GoogleCloudDiscoveryengineV1alphaSchema {
@@ -1991,7 +1991,7 @@ declare namespace gapi.client {
1991
1991
  naturalLanguageQueryUnderstandingSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec;
1992
1992
  /** A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. */
1993
1993
  offset?: number;
1994
- /** 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 for retail search, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. */
1994
+ /** 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. */
1995
1995
  orderBy?: string;
1996
1996
  /** 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. */
1997
1997
  pageSize?: number;
@@ -2097,6 +2097,8 @@ declare namespace gapi.client {
2097
2097
  interface GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec {
2098
2098
  /** Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No summary is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating summaries for adversarial queries and return fallback messages instead. */
2099
2099
  ignoreAdversarialQuery?: boolean;
2100
+ /** Specifies whether to filter out queries that have low relevance. The default value is `false`. If this field is set to `false`, all search results are used regardless of relevance to generate answers. If set to `true`, only queries with high relevance search results will generate answers. */
2101
+ ignoreLowRelevantContent?: boolean;
2100
2102
  /** Specifies whether to filter out queries that are not summary-seeking. The default value is `false`. Google employs search-query classification to detect summary-seeking queries. No summary is returned if the search query is classified as a non-summary seeking query. For example, `why is the sky blue` and `Who is the best soccer player in the world?` are summary-seeking queries, but `SFO airport` and `world cup 2026` are not. They are most likely navigational queries. If this field is set to `true`, we skip generating summaries for non-summary seeking queries and return fallback messages instead. */
2101
2103
  ignoreNonSummarySeekingQuery?: boolean;
2102
2104
  /** Specifies whether to include citations in the summary. The default value is `false`. When this field is set to `true`, summaries include in-line citation numbers. Example summary including citations: BigQuery is Google Cloud's fully managed and completely serverless enterprise data warehouse [1]. BigQuery supports all data types, works across clouds, and has built-in machine learning and business intelligence, all within a unified platform [2, 3]. The citation numbers refer to the returned search results and are 1-indexed. For example, [1] means that the sentence is attributed to the first search result. [2, 3] means that the sentence is attributed to both the second and third search results. */
@@ -2206,6 +2208,8 @@ declare namespace gapi.client {
2206
2208
  naturalLanguageQueryUnderstandingInfo?: GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfo;
2207
2209
  /** A token that can be sent as SearchRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages. */
2208
2210
  nextPageToken?: string;
2211
+ /** A list of One Box results. There can be multiple One Box results of different types. */
2212
+ oneBoxResults?: GoogleCloudDiscoveryengineV1alphaSearchResponseOneBoxResult[];
2209
2213
  /** Query expansion information for the returned results. */
2210
2214
  queryExpansionInfo?: GoogleCloudDiscoveryengineV1alphaSearchResponseQueryExpansionInfo;
2211
2215
  /** The URI of a customer-defined redirect page. If redirect action is triggered, no search is performed, and only redirect_uri and attribution_token are set in the response. */
@@ -2286,6 +2290,10 @@ declare namespace gapi.client {
2286
2290
  address?: string;
2287
2291
  /** The name of the geolocation field as defined in the schema. */
2288
2292
  fieldName?: string;
2293
+ /** The latitude of the geolocation inferred from the input query. */
2294
+ latitude?: number;
2295
+ /** The longitude of the geolocation inferred from the input query. */
2296
+ longitude?: number;
2289
2297
  /** The radius in meters around the address. The record is returned if the location of the geolocation field is within the radius. */
2290
2298
  radiusInMeters?: number;
2291
2299
  }
@@ -2307,6 +2315,12 @@ declare namespace gapi.client {
2307
2315
  /** Values of the string field. The record will only be returned if the field value matches one of the values specified here. */
2308
2316
  values?: string[];
2309
2317
  }
2318
+ interface GoogleCloudDiscoveryengineV1alphaSearchResponseOneBoxResult {
2319
+ /** The type of One Box result. */
2320
+ oneBoxType?: string;
2321
+ /** The search results for this One Box. */
2322
+ searchResults?: GoogleCloudDiscoveryengineV1alphaSearchResponseSearchResult[];
2323
+ }
2310
2324
  interface GoogleCloudDiscoveryengineV1alphaSearchResponseQueryExpansionInfo {
2311
2325
  /** Bool describing whether query expansion has occurred. */
2312
2326
  expandedQuery?: boolean;
@@ -2847,7 +2861,7 @@ declare namespace gapi.client {
2847
2861
  defaultParsingConfig?: GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig;
2848
2862
  /** The full resource name of the Document Processing Config. Format: `projects/*‍/locations/*‍/collections/*‍/dataStores/*‍/documentProcessingConfig`. */
2849
2863
  name?: string;
2850
- /** Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported. */
2864
+ /** Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported. * `xlsx`: Override parsing config for XLSX files, only digital parsing and layout parsing are supported. */
2851
2865
  parsingConfigOverrides?: {
2852
2866
  [P in string]: GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig;
2853
2867
  };
@@ -2950,7 +2964,7 @@ declare namespace gapi.client {
2950
2964
  errorSamples?: GoogleRpcStatus[];
2951
2965
  /** Required. The specification of the evaluation. */
2952
2966
  evaluationSpec?: GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpec;
2953
- /** Immutable. The full resource name of the Evaluation, in the format of `projects/{project}/locations/{location}/evaluations/{evaluation}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */
2967
+ /** Identifier. The full resource name of the Evaluation, in the format of `projects/{project}/locations/{location}/evaluations/{evaluation}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */
2954
2968
  name?: string;
2955
2969
  /** Output only. The metrics produced by the evaluation, averaged across all SampleQuerys in the SampleQuerySet. Only populated when the evaluation's state is SUCCEEDED. */
2956
2970
  qualityMetrics?: GoogleCloudDiscoveryengineV1betaQualityMetrics;
@@ -3191,7 +3205,7 @@ declare namespace gapi.client {
3191
3205
  naturalLanguageQueryUnderstandingSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec;
3192
3206
  /** A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. */
3193
3207
  offset?: number;
3194
- /** 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 for retail search, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. */
3208
+ /** 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. */
3195
3209
  orderBy?: string;
3196
3210
  /** 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. */
3197
3211
  pageSize?: number;
@@ -3295,6 +3309,8 @@ declare namespace gapi.client {
3295
3309
  interface GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec {
3296
3310
  /** Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No summary is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating summaries for adversarial queries and return fallback messages instead. */
3297
3311
  ignoreAdversarialQuery?: boolean;
3312
+ /** Specifies whether to filter out queries that have low relevance. The default value is `false`. If this field is set to `false`, all search results are used regardless of relevance to generate answers. If set to `true`, only queries with high relevance search results will generate answers. */
3313
+ ignoreLowRelevantContent?: boolean;
3298
3314
  /** Specifies whether to filter out queries that are not summary-seeking. The default value is `false`. Google employs search-query classification to detect summary-seeking queries. No summary is returned if the search query is classified as a non-summary seeking query. For example, `why is the sky blue` and `Who is the best soccer player in the world?` are summary-seeking queries, but `SFO airport` and `world cup 2026` are not. They are most likely navigational queries. If this field is set to `true`, we skip generating summaries for non-summary seeking queries and return fallback messages instead. */
3299
3315
  ignoreNonSummarySeekingQuery?: boolean;
3300
3316
  /** Specifies whether to include citations in the summary. The default value is `false`. When this field is set to `true`, summaries include in-line citation numbers. Example summary including citations: BigQuery is Google Cloud's fully managed and completely serverless enterprise data warehouse [1]. BigQuery supports all data types, works across clouds, and has built-in machine learning and business intelligence, all within a unified platform [2, 3]. The citation numbers refer to the returned search results and are 1-indexed. For example, [1] means that the sentence is attributed to the first search result. [2, 3] means that the sentence is attributed to both the second and third search results. */
@@ -3609,7 +3625,7 @@ declare namespace gapi.client {
3609
3625
  defaultParsingConfig?: GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig;
3610
3626
  /** The full resource name of the Document Processing Config. Format: `projects/*‍/locations/*‍/collections/*‍/dataStores/*‍/documentProcessingConfig`. */
3611
3627
  name?: string;
3612
- /** Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported. */
3628
+ /** Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported. * `xlsx`: Override parsing config for XLSX files, only digital parsing and layout parsing are supported. */
3613
3629
  parsingConfigOverrides?: {
3614
3630
  [P in string]: GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig;
3615
3631
  };
@@ -7264,6 +7280,8 @@ declare namespace gapi.client {
7264
7280
  prettyPrint?: boolean;
7265
7281
  /** 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. */
7266
7282
  quotaUser?: string;
7283
+ /** A boolean flag indicating whether to skip the default schema creation for the data store. Only enable this flag if you are certain that the default schema is incompatible with your use case. If set to true, you must manually create a schema for the data store before any documents can be ingested. This flag cannot be specified if `data_store.starting_schema` is specified. */
7284
+ skipDefaultSchemaCreation?: boolean;
7267
7285
  /** Upload protocol for media (e.g. "raw", "multipart"). */
7268
7286
  upload_protocol?: string;
7269
7287
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
@@ -7297,6 +7315,8 @@ declare namespace gapi.client {
7297
7315
  prettyPrint?: boolean;
7298
7316
  /** 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. */
7299
7317
  quotaUser?: string;
7318
+ /** A boolean flag indicating whether to skip the default schema creation for the data store. Only enable this flag if you are certain that the default schema is incompatible with your use case. If set to true, you must manually create a schema for the data store before any documents can be ingested. This flag cannot be specified if `data_store.starting_schema` is specified. */
7319
+ skipDefaultSchemaCreation?: boolean;
7300
7320
  /** Upload protocol for media (e.g. "raw", "multipart"). */
7301
7321
  upload_protocol?: string;
7302
7322
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
@@ -12035,6 +12055,8 @@ declare namespace gapi.client {
12035
12055
  prettyPrint?: boolean;
12036
12056
  /** 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. */
12037
12057
  quotaUser?: string;
12058
+ /** A boolean flag indicating whether to skip the default schema creation for the data store. Only enable this flag if you are certain that the default schema is incompatible with your use case. If set to true, you must manually create a schema for the data store before any documents can be ingested. This flag cannot be specified if `data_store.starting_schema` is specified. */
12059
+ skipDefaultSchemaCreation?: boolean;
12038
12060
  /** Upload protocol for media (e.g. "raw", "multipart"). */
12039
12061
  upload_protocol?: string;
12040
12062
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
@@ -12068,6 +12090,8 @@ declare namespace gapi.client {
12068
12090
  prettyPrint?: boolean;
12069
12091
  /** 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. */
12070
12092
  quotaUser?: string;
12093
+ /** A boolean flag indicating whether to skip the default schema creation for the data store. Only enable this flag if you are certain that the default schema is incompatible with your use case. If set to true, you must manually create a schema for the data store before any documents can be ingested. This flag cannot be specified if `data_store.starting_schema` is specified. */
12094
+ skipDefaultSchemaCreation?: boolean;
12071
12095
  /** Upload protocol for media (e.g. "raw", "multipart"). */
12072
12096
  upload_protocol?: string;
12073
12097
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
@@ -12945,7 +12969,7 @@ declare namespace gapi.client {
12945
12969
  fields?: string;
12946
12970
  /** 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. */
12947
12971
  key?: string;
12948
- /** Required. Full resource name of SampleQuery, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. If the caller does not have permission to delete the SampleQuery, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the SampleQuery to delete does not exist, a `NOT_FOUND` error is returned. */
12972
+ /** Required. Full resource name of SampleQuery, such as `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}`. If the caller does not have permission to delete the SampleQuery, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the SampleQuery to delete does not exist, a `NOT_FOUND` error is returned. */
12949
12973
  name: string;
12950
12974
  /** OAuth 2.0 token for the current user. */
12951
12975
  oauth_token?: string;
@@ -12972,7 +12996,7 @@ declare namespace gapi.client {
12972
12996
  fields?: string;
12973
12997
  /** 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. */
12974
12998
  key?: string;
12975
- /** Required. Full resource name of SampleQuery, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. If the caller does not have permission to access the SampleQuery, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested SampleQuery does not exist, a NOT_FOUND error is returned. */
12999
+ /** Required. Full resource name of SampleQuery, such as `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}`. If the caller does not have permission to access the SampleQuery, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested SampleQuery does not exist, a NOT_FOUND error is returned. */
12976
13000
  name: string;
12977
13001
  /** OAuth 2.0 token for the current user. */
12978
13002
  oauth_token?: string;
@@ -13088,7 +13112,7 @@ declare namespace gapi.client {
13088
13112
  fields?: string;
13089
13113
  /** 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. */
13090
13114
  key?: string;
13091
- /** Immutable. The full resource name of the sample query, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */
13115
+ /** Identifier. The full resource name of the sample query, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */
13092
13116
  name: string;
13093
13117
  /** OAuth 2.0 token for the current user. */
13094
13118
  oauth_token?: string;
@@ -13119,7 +13143,7 @@ declare namespace gapi.client {
13119
13143
  fields?: string;
13120
13144
  /** 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. */
13121
13145
  key?: string;
13122
- /** Immutable. The full resource name of the sample query, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */
13146
+ /** Identifier. The full resource name of the sample query, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */
13123
13147
  name: string;
13124
13148
  /** OAuth 2.0 token for the current user. */
13125
13149
  oauth_token?: string;
@@ -13214,7 +13238,7 @@ declare namespace gapi.client {
13214
13238
  fields?: string;
13215
13239
  /** 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. */
13216
13240
  key?: string;
13217
- /** Required. Full resource name of SampleQuerySet, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. If the caller does not have permission to delete the SampleQuerySet, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the SampleQuerySet to delete does not exist, a `NOT_FOUND` error is returned. */
13241
+ /** Required. Full resource name of SampleQuerySet, such as `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}`. If the caller does not have permission to delete the SampleQuerySet, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the SampleQuerySet to delete does not exist, a `NOT_FOUND` error is returned. */
13218
13242
  name: string;
13219
13243
  /** OAuth 2.0 token for the current user. */
13220
13244
  oauth_token?: string;
@@ -13241,7 +13265,7 @@ declare namespace gapi.client {
13241
13265
  fields?: string;
13242
13266
  /** 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. */
13243
13267
  key?: string;
13244
- /** Required. Full resource name of SampleQuerySet, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. If the caller does not have permission to access the SampleQuerySet, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested SampleQuerySet does not exist, a NOT_FOUND error is returned. */
13268
+ /** Required. Full resource name of SampleQuerySet, such as `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}`. If the caller does not have permission to access the SampleQuerySet, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested SampleQuerySet does not exist, a NOT_FOUND error is returned. */
13245
13269
  name: string;
13246
13270
  /** OAuth 2.0 token for the current user. */
13247
13271
  oauth_token?: string;
@@ -13299,7 +13323,7 @@ declare namespace gapi.client {
13299
13323
  fields?: string;
13300
13324
  /** 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. */
13301
13325
  key?: string;
13302
- /** Immutable. The full resource name of the SampleQuerySet, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */
13326
+ /** Identifier. The full resource name of the SampleQuerySet, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */
13303
13327
  name: string;
13304
13328
  /** OAuth 2.0 token for the current user. */
13305
13329
  oauth_token?: string;
@@ -13330,7 +13354,7 @@ declare namespace gapi.client {
13330
13354
  fields?: string;
13331
13355
  /** 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. */
13332
13356
  key?: string;
13333
- /** Immutable. The full resource name of the SampleQuerySet, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */
13357
+ /** Identifier. The full resource name of the SampleQuerySet, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */
13334
13358
  name: string;
13335
13359
  /** OAuth 2.0 token for the current user. */
13336
13360
  oauth_token?: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.discoveryengine-v1alpha",
3
- "version": "0.0.20240715",
3
+ "version": "0.0.20240801",
4
4
  "description": "TypeScript typings for Discovery Engine API v1alpha",
5
5
  "repository": {
6
6
  "type": "git",