@maxim_mazurok/gapi.client.discoveryengine-v1alpha 0.0.20240510 → 0.0.20240517

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 +179 -60
  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: 20240510
12
+ // Revision: 20240517
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -139,7 +139,7 @@ declare namespace gapi.client {
139
139
  safetySpec?: GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSafetySpec;
140
140
  /** Search specification. */
141
141
  searchSpec?: GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpec;
142
- /** The session resource name. Not required. When session field is not set, the API is in sessionless mode. We support auto session mode: users can use the wildcard symbol “-” as session id. A new id will be automatically generated and assigned. */
142
+ /** The session resource name. Not required. When session field is not set, the API is in sessionless mode. We support auto session mode: users can use the wildcard symbol `-` as session ID. A new ID will be automatically generated and assigned. */
143
143
  session?: string;
144
144
  /** A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. */
145
145
  userPseudoId?: string;
@@ -484,6 +484,8 @@ declare namespace gapi.client {
484
484
  name?: string;
485
485
  /** Page span of the chunk. */
486
486
  pageSpan?: GoogleCloudDiscoveryengineV1alphaChunkPageSpan;
487
+ /** Represents the relevance score based on similarity. Higher score represents the chunk relevance. The score is in range [-1.0, 1.0]. Only populated on SearchService.SearchResponse */
488
+ relevanceScore?: number;
487
489
  }
488
490
  interface GoogleCloudDiscoveryengineV1alphaChunkChunkMetadata {
489
491
  /** 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. */
@@ -747,7 +749,7 @@ declare namespace gapi.client {
747
749
  name?: string;
748
750
  /** The promotion IDs associated with this Document. Currently, this field is restricted to at most one ID. */
749
751
  promotionIds?: string[];
750
- /** Quantity of the Document associated with the user event. Defaults to 1. For example, this field will be 2 if two quantities of the same Document are involved in a `add-to-cart` event. Required for events of the following event types: * `add-to-cart` * `purchase` */
752
+ /** Quantity of the Document associated with the user event. Defaults to 1. For example, this field is 2 if two quantities of the same Document are involved in a `add-to-cart` event. Required for events of the following event types: * `add-to-cart` * `purchase` */
751
753
  quantity?: number;
752
754
  /** The Document URI - only allowed for website data stores. */
753
755
  uri?: string;
@@ -819,7 +821,7 @@ declare namespace gapi.client {
819
821
  dataStoreIds?: string[];
820
822
  /** Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. */
821
823
  displayName?: string;
822
- /** The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore liniked to the engine. */
824
+ /** The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore linked to the engine. */
823
825
  industryVertical?: string;
824
826
  /** Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical. */
825
827
  mediaRecommendationEngineConfig?: GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig;
@@ -974,7 +976,7 @@ declare namespace gapi.client {
974
976
  searchableOption?: string;
975
977
  }
976
978
  interface GoogleCloudDiscoveryengineV1alphaFirestoreSource {
977
- /** Required. The Firestore collection to copy the data from with a length limit of 1,500 characters. */
979
+ /** Required. The Firestore collection (or entity) to copy the data from with a length limit of 1,500 characters. */
978
980
  collectionId?: string;
979
981
  /** Required. The Firestore database to copy the data from with a length limit of 256 characters. */
980
982
  databaseId?: string;
@@ -984,9 +986,9 @@ declare namespace gapi.client {
984
986
  projectId?: string;
985
987
  }
986
988
  interface GoogleCloudDiscoveryengineV1alphaGcsSource {
987
- /** 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 the GENERIC Data Store vertical. * `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 the GENERIC Data Store vertical. Supported values for user even imports: * `user_event` (default): One JSON UserEvent per line. */
989
+ /** 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 the GENERIC Data Store vertical. * `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 the GENERIC Data Store vertical. Supported values for user event imports: * `user_event` (default): One JSON UserEvent per line. */
988
990
  dataSchema?: string;
989
- /** 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`). */
991
+ /** Required. Cloud Storage URIs to input files. Each 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`). */
990
992
  inputUris?: string[];
991
993
  }
992
994
  interface GoogleCloudDiscoveryengineV1alphaGroundingFact {
@@ -1363,17 +1365,17 @@ declare namespace gapi.client {
1363
1365
  records?: GoogleCloudDiscoveryengineV1alphaRankingRecord[];
1364
1366
  }
1365
1367
  interface GoogleCloudDiscoveryengineV1alphaRecommendRequest {
1366
- /** 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. */
1368
+ /** 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 returns 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 never returns Documents with `storageStatus` as `EXPIRED` or `DELETED` regardless of filter choices. */
1367
1369
  filter?: string;
1368
- /** Maximum number of results to return. Set this property to the number of recommendation results needed. If zero, the service will choose a reasonable default. The maximum allowed value is 100. Values above 100 will be coerced to 100. */
1370
+ /** Maximum number of results to return. Set this property to the number of recommendation results needed. If zero, the service chooses a reasonable default. The maximum allowed value is 100. Values above 100 are set to 100. */
1369
1371
  pageSize?: number;
1370
- /** Additional domain specific parameters for the recommendations. Allowed values: * `returnDocument`: Boolean. If set to true, the associated Document object will be returned in RecommendResponse.RecommendationResult.document. * `returnScore`: Boolean. If set to true, the recommendation 'score' corresponding to each returned Document will be set in RecommendResponse.RecommendationResult.metadata. The given 'score' indicates the probability of a Document conversion given the user's context and history. * `strictFiltering`: Boolean. True by default. If set to false, the service will return generic (unfiltered) popular Documents instead of empty if your filter blocks all recommendation results. * `diversityLevel`: String. Default empty. If set to be non-empty, then it needs to be one of: * `no-diversity` * `low-diversity` * `medium-diversity` * `high-diversity` * `auto-diversity` This gives request-level control and adjusts recommendation results based on Document category. * `attributeFilteringSyntax`: Boolean. False by default. If set to true, the `filter` field is interpreted according to the new, attribute-based syntax. */
1372
+ /** Additional domain specific parameters for the recommendations. Allowed values: * `returnDocument`: Boolean. If set to `true`, the associated Document object is returned in RecommendResponse.RecommendationResult.document. * `returnScore`: Boolean. If set to true, the recommendation score corresponding to each returned Document is set in RecommendResponse.RecommendationResult.metadata. The given score indicates the probability of a Document conversion given the user's context and history. * `strictFiltering`: Boolean. True by default. If set to `false`, the service returns generic (unfiltered) popular Documents instead of empty if your filter blocks all recommendation results. * `diversityLevel`: String. Default empty. If set to be non-empty, then it needs to be one of: * `no-diversity` * `low-diversity` * `medium-diversity` * `high-diversity` * `auto-diversity` This gives request-level control and adjusts recommendation results based on Document category. * `attributeFilteringSyntax`: Boolean. False by default. If set to true, the `filter` field is interpreted according to the new, attribute-based syntax. */
1371
1373
  params?: {[P in string]: any};
1372
1374
  /** Required. Context about the user, what they are looking at and what action they took to trigger the Recommend request. Note that this user event detail won't be ingested to userEvent logs. Thus, a separate userEvent write request is required for event logging. Don't set UserEvent.user_pseudo_id or UserEvent.user_info.user_id to the same fixed ID for different users. If you are trying to receive non-personalized recommendations (not recommended; this can negatively impact model performance), instead set UserEvent.user_pseudo_id to a random unique ID and leave UserEvent.user_info.user_id unset. */
1373
1375
  userEvent?: GoogleCloudDiscoveryengineV1alphaUserEvent;
1374
1376
  /** The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Requirements for labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details. */
1375
1377
  userLabels?: {[P in string]: string};
1376
- /** Use validate only mode for this recommendation query. If set to true, a fake model will be used that returns arbitrary Document IDs. Note that the validate only mode should only be used for testing the API, or if the model is not ready. */
1378
+ /** Use validate only mode for this recommendation query. If set to `true`, a fake model is used that returns arbitrary Document IDs. Note that the validate only mode should only be used for testing the API, or if the model is not ready. */
1377
1379
  validateOnly?: boolean;
1378
1380
  }
1379
1381
  interface GoogleCloudDiscoveryengineV1alphaRecommendResponse {
@@ -1391,7 +1393,7 @@ declare namespace gapi.client {
1391
1393
  document?: GoogleCloudDiscoveryengineV1alphaDocument;
1392
1394
  /** Resource ID of the recommended Document. */
1393
1395
  id?: string;
1394
- /** Additional Document metadata / annotations. Possible values: * `score`: Recommendation score in double value. Is set if `returnScore` is set to true in RecommendRequest.params. */
1396
+ /** Additional Document metadata or annotations. Possible values: * `score`: Recommendation score in double value. Is set if `returnScore` is set to true in RecommendRequest.params. */
1395
1397
  metadata?: {[P in string]: any};
1396
1398
  }
1397
1399
  interface GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata {
@@ -1478,7 +1480,7 @@ declare namespace gapi.client {
1478
1480
  searchQuery?: string;
1479
1481
  }
1480
1482
  interface GoogleCloudDiscoveryengineV1alphaSearchRequest {
1481
- /** Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/retail/docs/boosting#boost) */
1483
+ /** Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) */
1482
1484
  boostSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec;
1483
1485
  /** The branch resource name, such as `projects/*‍/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`. Use `default_branch` as the branch ID or leave this field empty, to search documents under the default branch. */
1484
1486
  branch?: string;
@@ -1488,7 +1490,7 @@ declare namespace gapi.client {
1488
1490
  contentSearchSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec;
1489
1491
  /** Custom fine tuning configs. */
1490
1492
  customFineTuningSpec?: GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec;
1491
- /** A list of data store specs to apply on a search call. */
1493
+ /** Specs defining dataStores to filter on in a search call and configurations for those dataStores. This is only considered for engines with multiple dataStores use case. For single dataStore within an engine, they should use the specs at the top level. */
1492
1494
  dataStoreSpecs?: GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec[];
1493
1495
  /** Uses the provided embedding to do additional semantic document retrieval. The retrieval is based on the dot product of SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document embedding that is provided in SearchRequest.EmbeddingSpec.EmbeddingVector.field_path. If SearchRequest.EmbeddingSpec.EmbeddingVector.field_path is not provided, it will use ServingConfig.EmbeddingConfig.field_path. */
1494
1496
  embeddingSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec;
@@ -1506,7 +1508,7 @@ declare namespace gapi.client {
1506
1508
  pageSize?: number;
1507
1509
  /** A page token received from a previous SearchService.Search call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SearchService.Search must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. */
1508
1510
  pageToken?: string;
1509
- /** Additional search parameters. For public website search only, supported values are: * `user_country_code`: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided. Example: user_country_code: "au" For available codes see [Country Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) * `search_type`: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching. Example: search_type: 1 */
1511
+ /** Additional search parameters. For public website search only, supported values are: * `user_country_code`: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided. For example, `user_country_code: "au"` For available codes see [Country Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) * `search_type`: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching. For example, `search_type: 1` */
1510
1512
  params?: {[P in string]: any};
1511
1513
  /** Raw search query. */
1512
1514
  query?: string;
@@ -1638,13 +1640,13 @@ declare namespace gapi.client {
1638
1640
  excludedFilterKeys?: string[];
1639
1641
  /** Required. The facet key specification. */
1640
1642
  facetKey?: GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpecFacetKey;
1641
- /** Maximum of facet values that should be returned for this facet. If unspecified, defaults to 20. The maximum allowed value is 300. Values above 300 are coerced to 300. If this field is negative, an `INVALID_ARGUMENT` is returned. */
1643
+ /** Maximum facet values that are returned for this facet. If unspecified, defaults to 20. The maximum allowed value is 300. Values above 300 are coerced to 300. If this field is negative, an `INVALID_ARGUMENT` is returned. */
1642
1644
  limit?: number;
1643
1645
  }
1644
1646
  interface GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpecFacetKey {
1645
1647
  /** True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise. */
1646
1648
  caseInsensitive?: boolean;
1647
- /** Only get facet values that contains the given strings. For example, suppose "category" has three values "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set "contains" to "2022", the "category" facet only contains "Action > 2022" and "Sci-Fi > 2022". Only supported on textual fields. Maximum is 10. */
1649
+ /** Only get facet values that contain the given strings. For example, suppose "category" has three values "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set "contains" to "2022", the "category" facet only contains "Action > 2022" and "Sci-Fi > 2022". Only supported on textual fields. Maximum is 10. */
1648
1650
  contains?: string[];
1649
1651
  /** Set only if values should be bucketed into intervals. Must be set for facets with numerical values. Must not be set for facet with text values. Maximum number of intervals is 30. */
1650
1652
  intervals?: GoogleCloudDiscoveryengineV1alphaInterval[];
@@ -1668,7 +1670,7 @@ declare namespace gapi.client {
1668
1670
  pinUnexpandedResults?: boolean;
1669
1671
  }
1670
1672
  interface GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec {
1671
- /** The mode under which spell correction should take effect to replace the original search query. Default to Mode.AUTO. */
1673
+ /** The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO. */
1672
1674
  mode?: string;
1673
1675
  }
1674
1676
  interface GoogleCloudDiscoveryengineV1alphaSearchResponse {
@@ -1699,7 +1701,7 @@ declare namespace gapi.client {
1699
1701
  interface GoogleCloudDiscoveryengineV1alphaSearchResponseFacet {
1700
1702
  /** Whether the facet is dynamically generated. */
1701
1703
  dynamicFacet?: boolean;
1702
- /** The key for this facet. E.g., "colors" or "price". It matches SearchRequest.FacetSpec.FacetKey.key. */
1704
+ /** The key for this facet. For example, `"colors"` or `"price"`. It matches SearchRequest.FacetSpec.FacetKey.key. */
1703
1705
  key?: string;
1704
1706
  /** The facet values for this field. */
1705
1707
  values?: GoogleCloudDiscoveryengineV1alphaSearchResponseFacetFacetValue[];
@@ -1725,9 +1727,9 @@ declare namespace gapi.client {
1725
1727
  refinementAttributes?: GoogleCloudDiscoveryengineV1alphaSearchResponseGuidedSearchResultRefinementAttribute[];
1726
1728
  }
1727
1729
  interface GoogleCloudDiscoveryengineV1alphaSearchResponseGuidedSearchResultRefinementAttribute {
1728
- /** Attribute key used to refine the results e.g. 'movie_type'. */
1730
+ /** Attribute key used to refine the results. For example, `"movie_type"`. */
1729
1731
  attributeKey?: string;
1730
- /** Attribute value used to refine the results e.g. 'drama'. */
1732
+ /** Attribute value used to refine the results. For example, `"drama"`. */
1731
1733
  attributeValue?: string;
1732
1734
  }
1733
1735
  interface GoogleCloudDiscoveryengineV1alphaSearchResponseQueryExpansionInfo {
@@ -1739,7 +1741,7 @@ declare namespace gapi.client {
1739
1741
  interface GoogleCloudDiscoveryengineV1alphaSearchResponseSearchResult {
1740
1742
  /** The chunk data in the search response if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS. */
1741
1743
  chunk?: GoogleCloudDiscoveryengineV1alphaChunk;
1742
- /** The document data snippet in the search response. Only fields that are marked as retrievable are populated. */
1744
+ /** The document data snippet in the search response. Only fields that are marked as `retrievable` are populated. */
1743
1745
  document?: GoogleCloudDiscoveryengineV1alphaDocument;
1744
1746
  /** Document.id of the searched Document. */
1745
1747
  id?: string;
@@ -1877,7 +1879,7 @@ declare namespace gapi.client {
1877
1879
  userPseudoId?: string;
1878
1880
  }
1879
1881
  interface GoogleCloudDiscoveryengineV1alphaSessionTurn {
1880
- /** The resource name of the answer to the user query. */
1882
+ /** The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. */
1881
1883
  answer?: string;
1882
1884
  /** The user query. */
1883
1885
  query?: GoogleCloudDiscoveryengineV1alphaQuery;
@@ -2047,7 +2049,7 @@ declare namespace gapi.client {
2047
2049
  searchInfo?: GoogleCloudDiscoveryengineV1alphaSearchInfo;
2048
2050
  /** A unique identifier for tracking a visitor session with a length limit of 128 bytes. A session is an aggregation of an end user behavior in a time span. A general guideline to populate the session_id: 1. If user has no activity for 30 min, a new session_id should be assigned. 2. The session_id should be unique across users, suggest use uuid or add UserEvent.user_pseudo_id as prefix. */
2049
2051
  sessionId?: string;
2050
- /** A list of identifiers for the independent experiment groups this user event belongs to. This is used to distinguish between user events associated with different experiment setups on the customer end. */
2052
+ /** A list of identifiers for the independent experiment groups this user event belongs to. This is used to distinguish between user events associated with different experiment setups. */
2051
2053
  tagIds?: string[];
2052
2054
  /** The transaction metadata (if any) associated with this user event. */
2053
2055
  transactionInfo?: GoogleCloudDiscoveryengineV1alphaTransactionInfo;
@@ -2213,7 +2215,7 @@ declare namespace gapi.client {
2213
2215
  dataStoreIds?: string[];
2214
2216
  /** Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. */
2215
2217
  displayName?: string;
2216
- /** The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore liniked to the engine. */
2218
+ /** The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore linked to the engine. */
2217
2219
  industryVertical?: string;
2218
2220
  /** Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*‍/. Otherwise, an INVALID_ARGUMENT error is returned. */
2219
2221
  name?: string;
@@ -2541,7 +2543,7 @@ declare namespace gapi.client {
2541
2543
  dataStoreIds?: string[];
2542
2544
  /** Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. */
2543
2545
  displayName?: string;
2544
- /** The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore liniked to the engine. */
2546
+ /** The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore linked to the engine. */
2545
2547
  industryVertical?: string;
2546
2548
  /** Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*‍/. Otherwise, an INVALID_ARGUMENT error is returned. */
2547
2549
  name?: string;
@@ -2724,6 +2726,7 @@ declare namespace gapi.client {
2724
2726
  /** Operation last update time. If the operation is done, this is also the finish time. */
2725
2727
  updateTime?: string;
2726
2728
  }
2729
+ interface GoogleLongrunningCancelOperationRequest {}
2727
2730
  interface GoogleLongrunningListOperationsResponse {
2728
2731
  /** The standard List next-page token. */
2729
2732
  nextPageToken?: string;
@@ -2895,7 +2898,7 @@ declare namespace gapi.client {
2895
2898
  alt?: string;
2896
2899
  /** JSONP */
2897
2900
  callback?: string;
2898
- /** Required. The ID to use for the Document, which will become the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. */
2901
+ /** Required. The ID to use for the Document, which becomes the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. */
2899
2902
  documentId?: string;
2900
2903
  /** Selector specifying which fields to include in a partial response. */
2901
2904
  fields?: string;
@@ -2926,7 +2929,7 @@ declare namespace gapi.client {
2926
2929
  alt?: string;
2927
2930
  /** JSONP */
2928
2931
  callback?: string;
2929
- /** Required. The ID to use for the Document, which will become the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. */
2932
+ /** Required. The ID to use for the Document, which becomes the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. */
2930
2933
  documentId?: string;
2931
2934
  /** Selector specifying which fields to include in a partial response. */
2932
2935
  fields?: string;
@@ -3032,7 +3035,7 @@ declare namespace gapi.client {
3032
3035
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3033
3036
  uploadType?: string;
3034
3037
  }): Request<GoogleCloudDiscoveryengineV1alphaProcessedDocument>;
3035
- /** Bulk import of multiple Documents. Request processing may be synchronous. Non-existing items will be created. Note: It is possible for a subset of the Documents to be successfully updated. */
3038
+ /** Bulk import of multiple Documents. Request processing may be synchronous. Non-existing items are created. Note: It is possible for a subset of the Documents to be successfully updated. */
3036
3039
  import(request: {
3037
3040
  /** V1 error format. */
3038
3041
  '$.xgafv'?: string;
@@ -3106,7 +3109,7 @@ declare namespace gapi.client {
3106
3109
  key?: string;
3107
3110
  /** OAuth 2.0 token for the current user. */
3108
3111
  oauth_token?: string;
3109
- /** Maximum number of Documents to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned. */
3112
+ /** Maximum number of Documents to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 are set to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned. */
3110
3113
  pageSize?: number;
3111
3114
  /** A page token ListDocumentsResponse.next_page_token, received from a previous DocumentService.ListDocuments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to DocumentService.ListDocuments must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. */
3112
3115
  pageToken?: string;
@@ -3127,7 +3130,7 @@ declare namespace gapi.client {
3127
3130
  '$.xgafv'?: string;
3128
3131
  /** OAuth access token. */
3129
3132
  access_token?: string;
3130
- /** If set to true, and the Document is not found, a new Document will be created. */
3133
+ /** If set to `true` and the Document is not found, a new Document is be created. */
3131
3134
  allowMissing?: boolean;
3132
3135
  /** Data format for response. */
3133
3136
  alt?: string;
@@ -3145,7 +3148,7 @@ declare namespace gapi.client {
3145
3148
  prettyPrint?: boolean;
3146
3149
  /** 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. */
3147
3150
  quotaUser?: string;
3148
- /** Indicates which fields in the provided imported 'document' to update. If not set, will by default update all fields. */
3151
+ /** Indicates which fields in the provided imported 'document' to update. If not set, by default updates all fields. */
3149
3152
  updateMask?: string;
3150
3153
  /** Upload protocol for media (e.g. "raw", "multipart"). */
3151
3154
  upload_protocol?: string;
@@ -3160,7 +3163,7 @@ declare namespace gapi.client {
3160
3163
  '$.xgafv'?: string;
3161
3164
  /** OAuth access token. */
3162
3165
  access_token?: string;
3163
- /** If set to true, and the Document is not found, a new Document will be created. */
3166
+ /** If set to `true` and the Document is not found, a new Document is be created. */
3164
3167
  allowMissing?: boolean;
3165
3168
  /** Data format for response. */
3166
3169
  alt?: string;
@@ -3178,7 +3181,7 @@ declare namespace gapi.client {
3178
3181
  prettyPrint?: boolean;
3179
3182
  /** 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. */
3180
3183
  quotaUser?: string;
3181
- /** Indicates which fields in the provided imported 'document' to update. If not set, will by default update all fields. */
3184
+ /** Indicates which fields in the provided imported 'document' to update. If not set, by default updates all fields. */
3182
3185
  updateMask?: string;
3183
3186
  /** Upload protocol for media (e.g. "raw", "multipart"). */
3184
3187
  upload_protocol?: string;
@@ -3248,6 +3251,64 @@ declare namespace gapi.client {
3248
3251
  chunks: ChunksResource;
3249
3252
  }
3250
3253
  interface OperationsResource {
3254
+ /** Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. */
3255
+ cancel(request: {
3256
+ /** V1 error format. */
3257
+ '$.xgafv'?: string;
3258
+ /** OAuth access token. */
3259
+ access_token?: string;
3260
+ /** Data format for response. */
3261
+ alt?: string;
3262
+ /** JSONP */
3263
+ callback?: string;
3264
+ /** Selector specifying which fields to include in a partial response. */
3265
+ fields?: string;
3266
+ /** 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. */
3267
+ key?: string;
3268
+ /** The name of the operation resource to be cancelled. */
3269
+ name: string;
3270
+ /** OAuth 2.0 token for the current user. */
3271
+ oauth_token?: string;
3272
+ /** Returns response with indentations and line breaks. */
3273
+ prettyPrint?: boolean;
3274
+ /** 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. */
3275
+ quotaUser?: string;
3276
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3277
+ upload_protocol?: string;
3278
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3279
+ uploadType?: string;
3280
+ /** Request body */
3281
+ resource: GoogleLongrunningCancelOperationRequest;
3282
+ }): Request<{}>;
3283
+ cancel(
3284
+ request: {
3285
+ /** V1 error format. */
3286
+ '$.xgafv'?: string;
3287
+ /** OAuth access token. */
3288
+ access_token?: string;
3289
+ /** Data format for response. */
3290
+ alt?: string;
3291
+ /** JSONP */
3292
+ callback?: string;
3293
+ /** Selector specifying which fields to include in a partial response. */
3294
+ fields?: string;
3295
+ /** 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. */
3296
+ key?: string;
3297
+ /** The name of the operation resource to be cancelled. */
3298
+ name: string;
3299
+ /** OAuth 2.0 token for the current user. */
3300
+ oauth_token?: string;
3301
+ /** Returns response with indentations and line breaks. */
3302
+ prettyPrint?: boolean;
3303
+ /** 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. */
3304
+ quotaUser?: string;
3305
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3306
+ upload_protocol?: string;
3307
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3308
+ uploadType?: string;
3309
+ },
3310
+ body: GoogleLongrunningCancelOperationRequest
3311
+ ): Request<{}>;
3251
3312
  /** 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. */
3252
3313
  get(request?: {
3253
3314
  /** V1 error format. */
@@ -3823,7 +3884,7 @@ declare namespace gapi.client {
3823
3884
  prettyPrint?: boolean;
3824
3885
  /** 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. */
3825
3886
  quotaUser?: string;
3826
- /** Required. The ID to use for the Schema, which will become the final component of the Schema.name. This field should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. */
3887
+ /** Required. The ID to use for the Schema, which becomes the final component of the Schema.name. This field should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. */
3827
3888
  schemaId?: string;
3828
3889
  /** Upload protocol for media (e.g. "raw", "multipart"). */
3829
3890
  upload_protocol?: string;
@@ -3854,7 +3915,7 @@ declare namespace gapi.client {
3854
3915
  prettyPrint?: boolean;
3855
3916
  /** 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. */
3856
3917
  quotaUser?: string;
3857
- /** Required. The ID to use for the Schema, which will become the final component of the Schema.name. This field should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. */
3918
+ /** Required. The ID to use for the Schema, which becomes the final component of the Schema.name. This field should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. */
3858
3919
  schemaId?: string;
3859
3920
  /** Upload protocol for media (e.g. "raw", "multipart"). */
3860
3921
  upload_protocol?: string;
@@ -3933,7 +3994,7 @@ declare namespace gapi.client {
3933
3994
  key?: string;
3934
3995
  /** OAuth 2.0 token for the current user. */
3935
3996
  oauth_token?: string;
3936
- /** The maximum number of Schemas to return. The service may return fewer than this value. If unspecified, at most 100 Schemas will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. */
3997
+ /** The maximum number of Schemas to return. The service may return fewer than this value. If unspecified, at most 100 Schemas are returned. The maximum value is 1000; values above 1000 are set to 1000. */
3937
3998
  pageSize?: number;
3938
3999
  /** A page token, received from a previous SchemaService.ListSchemas call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SchemaService.ListSchemas must match the call that provided the page token. */
3939
4000
  pageToken?: string;
@@ -3954,7 +4015,7 @@ declare namespace gapi.client {
3954
4015
  '$.xgafv'?: string;
3955
4016
  /** OAuth access token. */
3956
4017
  access_token?: string;
3957
- /** If set to true, and the Schema is not found, a new Schema will be created. In this situation, `update_mask` is ignored. */
4018
+ /** If set to true, and the Schema is not found, a new Schema is created. In this situation, `update_mask` is ignored. */
3958
4019
  allowMissing?: boolean;
3959
4020
  /** Data format for response. */
3960
4021
  alt?: string;
@@ -3985,7 +4046,7 @@ declare namespace gapi.client {
3985
4046
  '$.xgafv'?: string;
3986
4047
  /** OAuth access token. */
3987
4048
  access_token?: string;
3988
- /** If set to true, and the Schema is not found, a new Schema will be created. In this situation, `update_mask` is ignored. */
4049
+ /** If set to true, and the Schema is not found, a new Schema is created. In this situation, `update_mask` is ignored. */
3989
4050
  allowMissing?: boolean;
3990
4051
  /** Data format for response. */
3991
4052
  alt?: string;
@@ -4211,7 +4272,7 @@ declare namespace gapi.client {
4211
4272
  prettyPrint?: boolean;
4212
4273
  /** 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. */
4213
4274
  quotaUser?: string;
4214
- /** Required. Full resource name of a ServingConfig: `projects/*‍/locations/global/collections/*‍/engines/*‍/servingConfigs/*`, or `projects/*‍/locations/global/collections/*‍/dataStores/*‍/servingConfigs/*` One default serving config is created along with your recommendation engine creation. The engine ID will be used as the ID of the default serving config. For example, for Engine `projects/*‍/locations/global/collections/*‍/engines/my-engine`, you can use `projects/*‍/locations/global/collections/*‍/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests. */
4275
+ /** Required. Full resource name of a ServingConfig: `projects/*‍/locations/global/collections/*‍/engines/*‍/servingConfigs/*`, or `projects/*‍/locations/global/collections/*‍/dataStores/*‍/servingConfigs/*` One default serving config is created along with your recommendation engine creation. The engine ID is used as the ID of the default serving config. For example, for Engine `projects/*‍/locations/global/collections/*‍/engines/my-engine`, you can use `projects/*‍/locations/global/collections/*‍/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests. */
4215
4276
  servingConfig: string;
4216
4277
  /** Upload protocol for media (e.g. "raw", "multipart"). */
4217
4278
  upload_protocol?: string;
@@ -4240,7 +4301,7 @@ declare namespace gapi.client {
4240
4301
  prettyPrint?: boolean;
4241
4302
  /** 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. */
4242
4303
  quotaUser?: string;
4243
- /** Required. Full resource name of a ServingConfig: `projects/*‍/locations/global/collections/*‍/engines/*‍/servingConfigs/*`, or `projects/*‍/locations/global/collections/*‍/dataStores/*‍/servingConfigs/*` One default serving config is created along with your recommendation engine creation. The engine ID will be used as the ID of the default serving config. For example, for Engine `projects/*‍/locations/global/collections/*‍/engines/my-engine`, you can use `projects/*‍/locations/global/collections/*‍/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests. */
4304
+ /** Required. Full resource name of a ServingConfig: `projects/*‍/locations/global/collections/*‍/engines/*‍/servingConfigs/*`, or `projects/*‍/locations/global/collections/*‍/dataStores/*‍/servingConfigs/*` One default serving config is created along with your recommendation engine creation. The engine ID is used as the ID of the default serving config. For example, for Engine `projects/*‍/locations/global/collections/*‍/engines/my-engine`, you can use `projects/*‍/locations/global/collections/*‍/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests. */
4244
4305
  servingConfig: string;
4245
4306
  /** Upload protocol for media (e.g. "raw", "multipart"). */
4246
4307
  upload_protocol?: string;
@@ -5354,7 +5415,7 @@ declare namespace gapi.client {
5354
5415
  /** Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters. */
5355
5416
  userEvent?: string;
5356
5417
  }): Request<GoogleApiHttpBody>;
5357
- /** Bulk import of User events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully inserted. Operation.metadata is of type ImportMetadata. */
5418
+ /** Bulk import of user events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully inserted. Operation.metadata is of type ImportMetadata. */
5358
5419
  import(request: {
5359
5420
  /** V1 error format. */
5360
5421
  '$.xgafv'?: string;
@@ -6496,7 +6557,7 @@ declare namespace gapi.client {
6496
6557
  prettyPrint?: boolean;
6497
6558
  /** 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. */
6498
6559
  quotaUser?: string;
6499
- /** Required. Full resource name of a ServingConfig: `projects/*‍/locations/global/collections/*‍/engines/*‍/servingConfigs/*`, or `projects/*‍/locations/global/collections/*‍/dataStores/*‍/servingConfigs/*` One default serving config is created along with your recommendation engine creation. The engine ID will be used as the ID of the default serving config. For example, for Engine `projects/*‍/locations/global/collections/*‍/engines/my-engine`, you can use `projects/*‍/locations/global/collections/*‍/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests. */
6560
+ /** Required. Full resource name of a ServingConfig: `projects/*‍/locations/global/collections/*‍/engines/*‍/servingConfigs/*`, or `projects/*‍/locations/global/collections/*‍/dataStores/*‍/servingConfigs/*` One default serving config is created along with your recommendation engine creation. The engine ID is used as the ID of the default serving config. For example, for Engine `projects/*‍/locations/global/collections/*‍/engines/my-engine`, you can use `projects/*‍/locations/global/collections/*‍/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests. */
6500
6561
  servingConfig: string;
6501
6562
  /** Upload protocol for media (e.g. "raw", "multipart"). */
6502
6563
  upload_protocol?: string;
@@ -6525,7 +6586,7 @@ declare namespace gapi.client {
6525
6586
  prettyPrint?: boolean;
6526
6587
  /** 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. */
6527
6588
  quotaUser?: string;
6528
- /** Required. Full resource name of a ServingConfig: `projects/*‍/locations/global/collections/*‍/engines/*‍/servingConfigs/*`, or `projects/*‍/locations/global/collections/*‍/dataStores/*‍/servingConfigs/*` One default serving config is created along with your recommendation engine creation. The engine ID will be used as the ID of the default serving config. For example, for Engine `projects/*‍/locations/global/collections/*‍/engines/my-engine`, you can use `projects/*‍/locations/global/collections/*‍/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests. */
6589
+ /** Required. Full resource name of a ServingConfig: `projects/*‍/locations/global/collections/*‍/engines/*‍/servingConfigs/*`, or `projects/*‍/locations/global/collections/*‍/dataStores/*‍/servingConfigs/*` One default serving config is created along with your recommendation engine creation. The engine ID is used as the ID of the default serving config. For example, for Engine `projects/*‍/locations/global/collections/*‍/engines/my-engine`, you can use `projects/*‍/locations/global/collections/*‍/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests. */
6529
6590
  servingConfig: string;
6530
6591
  /** Upload protocol for media (e.g. "raw", "multipart"). */
6531
6592
  upload_protocol?: string;
@@ -7364,7 +7425,7 @@ declare namespace gapi.client {
7364
7425
  alt?: string;
7365
7426
  /** JSONP */
7366
7427
  callback?: string;
7367
- /** Required. The ID to use for the Document, which will become the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. */
7428
+ /** Required. The ID to use for the Document, which becomes the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. */
7368
7429
  documentId?: string;
7369
7430
  /** Selector specifying which fields to include in a partial response. */
7370
7431
  fields?: string;
@@ -7395,7 +7456,7 @@ declare namespace gapi.client {
7395
7456
  alt?: string;
7396
7457
  /** JSONP */
7397
7458
  callback?: string;
7398
- /** Required. The ID to use for the Document, which will become the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. */
7459
+ /** Required. The ID to use for the Document, which becomes the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. */
7399
7460
  documentId?: string;
7400
7461
  /** Selector specifying which fields to include in a partial response. */
7401
7462
  fields?: string;
@@ -7501,7 +7562,7 @@ declare namespace gapi.client {
7501
7562
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
7502
7563
  uploadType?: string;
7503
7564
  }): Request<GoogleCloudDiscoveryengineV1alphaProcessedDocument>;
7504
- /** Bulk import of multiple Documents. Request processing may be synchronous. Non-existing items will be created. Note: It is possible for a subset of the Documents to be successfully updated. */
7565
+ /** Bulk import of multiple Documents. Request processing may be synchronous. Non-existing items are created. Note: It is possible for a subset of the Documents to be successfully updated. */
7505
7566
  import(request: {
7506
7567
  /** V1 error format. */
7507
7568
  '$.xgafv'?: string;
@@ -7575,7 +7636,7 @@ declare namespace gapi.client {
7575
7636
  key?: string;
7576
7637
  /** OAuth 2.0 token for the current user. */
7577
7638
  oauth_token?: string;
7578
- /** Maximum number of Documents to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned. */
7639
+ /** Maximum number of Documents to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 are set to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned. */
7579
7640
  pageSize?: number;
7580
7641
  /** A page token ListDocumentsResponse.next_page_token, received from a previous DocumentService.ListDocuments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to DocumentService.ListDocuments must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. */
7581
7642
  pageToken?: string;
@@ -7596,7 +7657,7 @@ declare namespace gapi.client {
7596
7657
  '$.xgafv'?: string;
7597
7658
  /** OAuth access token. */
7598
7659
  access_token?: string;
7599
- /** If set to true, and the Document is not found, a new Document will be created. */
7660
+ /** If set to `true` and the Document is not found, a new Document is be created. */
7600
7661
  allowMissing?: boolean;
7601
7662
  /** Data format for response. */
7602
7663
  alt?: string;
@@ -7614,7 +7675,7 @@ declare namespace gapi.client {
7614
7675
  prettyPrint?: boolean;
7615
7676
  /** 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. */
7616
7677
  quotaUser?: string;
7617
- /** Indicates which fields in the provided imported 'document' to update. If not set, will by default update all fields. */
7678
+ /** Indicates which fields in the provided imported 'document' to update. If not set, by default updates all fields. */
7618
7679
  updateMask?: string;
7619
7680
  /** Upload protocol for media (e.g. "raw", "multipart"). */
7620
7681
  upload_protocol?: string;
@@ -7629,7 +7690,7 @@ declare namespace gapi.client {
7629
7690
  '$.xgafv'?: string;
7630
7691
  /** OAuth access token. */
7631
7692
  access_token?: string;
7632
- /** If set to true, and the Document is not found, a new Document will be created. */
7693
+ /** If set to `true` and the Document is not found, a new Document is be created. */
7633
7694
  allowMissing?: boolean;
7634
7695
  /** Data format for response. */
7635
7696
  alt?: string;
@@ -7647,7 +7708,7 @@ declare namespace gapi.client {
7647
7708
  prettyPrint?: boolean;
7648
7709
  /** 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. */
7649
7710
  quotaUser?: string;
7650
- /** Indicates which fields in the provided imported 'document' to update. If not set, will by default update all fields. */
7711
+ /** Indicates which fields in the provided imported 'document' to update. If not set, by default updates all fields. */
7651
7712
  updateMask?: string;
7652
7713
  /** Upload protocol for media (e.g. "raw", "multipart"). */
7653
7714
  upload_protocol?: string;
@@ -7717,6 +7778,64 @@ declare namespace gapi.client {
7717
7778
  chunks: ChunksResource;
7718
7779
  }
7719
7780
  interface OperationsResource {
7781
+ /** Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. */
7782
+ cancel(request: {
7783
+ /** V1 error format. */
7784
+ '$.xgafv'?: string;
7785
+ /** OAuth access token. */
7786
+ access_token?: string;
7787
+ /** Data format for response. */
7788
+ alt?: string;
7789
+ /** JSONP */
7790
+ callback?: string;
7791
+ /** Selector specifying which fields to include in a partial response. */
7792
+ fields?: string;
7793
+ /** 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. */
7794
+ key?: string;
7795
+ /** The name of the operation resource to be cancelled. */
7796
+ name: string;
7797
+ /** OAuth 2.0 token for the current user. */
7798
+ oauth_token?: string;
7799
+ /** Returns response with indentations and line breaks. */
7800
+ prettyPrint?: boolean;
7801
+ /** 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. */
7802
+ quotaUser?: string;
7803
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
7804
+ upload_protocol?: string;
7805
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
7806
+ uploadType?: string;
7807
+ /** Request body */
7808
+ resource: GoogleLongrunningCancelOperationRequest;
7809
+ }): Request<{}>;
7810
+ cancel(
7811
+ request: {
7812
+ /** V1 error format. */
7813
+ '$.xgafv'?: string;
7814
+ /** OAuth access token. */
7815
+ access_token?: string;
7816
+ /** Data format for response. */
7817
+ alt?: string;
7818
+ /** JSONP */
7819
+ callback?: string;
7820
+ /** Selector specifying which fields to include in a partial response. */
7821
+ fields?: string;
7822
+ /** 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. */
7823
+ key?: string;
7824
+ /** The name of the operation resource to be cancelled. */
7825
+ name: string;
7826
+ /** OAuth 2.0 token for the current user. */
7827
+ oauth_token?: string;
7828
+ /** Returns response with indentations and line breaks. */
7829
+ prettyPrint?: boolean;
7830
+ /** 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. */
7831
+ quotaUser?: string;
7832
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
7833
+ upload_protocol?: string;
7834
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
7835
+ uploadType?: string;
7836
+ },
7837
+ body: GoogleLongrunningCancelOperationRequest
7838
+ ): Request<{}>;
7720
7839
  /** 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. */
7721
7840
  get(request?: {
7722
7841
  /** V1 error format. */
@@ -8201,7 +8320,7 @@ declare namespace gapi.client {
8201
8320
  prettyPrint?: boolean;
8202
8321
  /** 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. */
8203
8322
  quotaUser?: string;
8204
- /** Required. The ID to use for the Schema, which will become the final component of the Schema.name. This field should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. */
8323
+ /** Required. The ID to use for the Schema, which becomes the final component of the Schema.name. This field should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. */
8205
8324
  schemaId?: string;
8206
8325
  /** Upload protocol for media (e.g. "raw", "multipart"). */
8207
8326
  upload_protocol?: string;
@@ -8232,7 +8351,7 @@ declare namespace gapi.client {
8232
8351
  prettyPrint?: boolean;
8233
8352
  /** 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. */
8234
8353
  quotaUser?: string;
8235
- /** Required. The ID to use for the Schema, which will become the final component of the Schema.name. This field should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. */
8354
+ /** Required. The ID to use for the Schema, which becomes the final component of the Schema.name. This field should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. */
8236
8355
  schemaId?: string;
8237
8356
  /** Upload protocol for media (e.g. "raw", "multipart"). */
8238
8357
  upload_protocol?: string;
@@ -8311,7 +8430,7 @@ declare namespace gapi.client {
8311
8430
  key?: string;
8312
8431
  /** OAuth 2.0 token for the current user. */
8313
8432
  oauth_token?: string;
8314
- /** The maximum number of Schemas to return. The service may return fewer than this value. If unspecified, at most 100 Schemas will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. */
8433
+ /** The maximum number of Schemas to return. The service may return fewer than this value. If unspecified, at most 100 Schemas are returned. The maximum value is 1000; values above 1000 are set to 1000. */
8315
8434
  pageSize?: number;
8316
8435
  /** A page token, received from a previous SchemaService.ListSchemas call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SchemaService.ListSchemas must match the call that provided the page token. */
8317
8436
  pageToken?: string;
@@ -8332,7 +8451,7 @@ declare namespace gapi.client {
8332
8451
  '$.xgafv'?: string;
8333
8452
  /** OAuth access token. */
8334
8453
  access_token?: string;
8335
- /** If set to true, and the Schema is not found, a new Schema will be created. In this situation, `update_mask` is ignored. */
8454
+ /** If set to true, and the Schema is not found, a new Schema is created. In this situation, `update_mask` is ignored. */
8336
8455
  allowMissing?: boolean;
8337
8456
  /** Data format for response. */
8338
8457
  alt?: string;
@@ -8363,7 +8482,7 @@ declare namespace gapi.client {
8363
8482
  '$.xgafv'?: string;
8364
8483
  /** OAuth access token. */
8365
8484
  access_token?: string;
8366
- /** If set to true, and the Schema is not found, a new Schema will be created. In this situation, `update_mask` is ignored. */
8485
+ /** If set to true, and the Schema is not found, a new Schema is created. In this situation, `update_mask` is ignored. */
8367
8486
  allowMissing?: boolean;
8368
8487
  /** Data format for response. */
8369
8488
  alt?: string;
@@ -8588,7 +8707,7 @@ declare namespace gapi.client {
8588
8707
  prettyPrint?: boolean;
8589
8708
  /** 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. */
8590
8709
  quotaUser?: string;
8591
- /** Required. Full resource name of a ServingConfig: `projects/*‍/locations/global/collections/*‍/engines/*‍/servingConfigs/*`, or `projects/*‍/locations/global/collections/*‍/dataStores/*‍/servingConfigs/*` One default serving config is created along with your recommendation engine creation. The engine ID will be used as the ID of the default serving config. For example, for Engine `projects/*‍/locations/global/collections/*‍/engines/my-engine`, you can use `projects/*‍/locations/global/collections/*‍/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests. */
8710
+ /** Required. Full resource name of a ServingConfig: `projects/*‍/locations/global/collections/*‍/engines/*‍/servingConfigs/*`, or `projects/*‍/locations/global/collections/*‍/dataStores/*‍/servingConfigs/*` One default serving config is created along with your recommendation engine creation. The engine ID is used as the ID of the default serving config. For example, for Engine `projects/*‍/locations/global/collections/*‍/engines/my-engine`, you can use `projects/*‍/locations/global/collections/*‍/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests. */
8592
8711
  servingConfig: string;
8593
8712
  /** Upload protocol for media (e.g. "raw", "multipart"). */
8594
8713
  upload_protocol?: string;
@@ -8617,7 +8736,7 @@ declare namespace gapi.client {
8617
8736
  prettyPrint?: boolean;
8618
8737
  /** 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. */
8619
8738
  quotaUser?: string;
8620
- /** Required. Full resource name of a ServingConfig: `projects/*‍/locations/global/collections/*‍/engines/*‍/servingConfigs/*`, or `projects/*‍/locations/global/collections/*‍/dataStores/*‍/servingConfigs/*` One default serving config is created along with your recommendation engine creation. The engine ID will be used as the ID of the default serving config. For example, for Engine `projects/*‍/locations/global/collections/*‍/engines/my-engine`, you can use `projects/*‍/locations/global/collections/*‍/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests. */
8739
+ /** Required. Full resource name of a ServingConfig: `projects/*‍/locations/global/collections/*‍/engines/*‍/servingConfigs/*`, or `projects/*‍/locations/global/collections/*‍/dataStores/*‍/servingConfigs/*` One default serving config is created along with your recommendation engine creation. The engine ID is used as the ID of the default serving config. For example, for Engine `projects/*‍/locations/global/collections/*‍/engines/my-engine`, you can use `projects/*‍/locations/global/collections/*‍/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests. */
8621
8740
  servingConfig: string;
8622
8741
  /** Upload protocol for media (e.g. "raw", "multipart"). */
8623
8742
  upload_protocol?: string;
@@ -9516,7 +9635,7 @@ declare namespace gapi.client {
9516
9635
  /** Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters. */
9517
9636
  userEvent?: string;
9518
9637
  }): Request<GoogleApiHttpBody>;
9519
- /** Bulk import of User events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully inserted. Operation.metadata is of type ImportMetadata. */
9638
+ /** Bulk import of user events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully inserted. Operation.metadata is of type ImportMetadata. */
9520
9639
  import(request: {
9521
9640
  /** V1 error format. */
9522
9641
  '$.xgafv'?: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.discoveryengine-v1alpha",
3
- "version": "0.0.20240510",
3
+ "version": "0.0.20240517",
4
4
  "description": "TypeScript typings for Discovery Engine API v1alpha",
5
5
  "repository": {
6
6
  "type": "git",