@maxim_mazurok/gapi.client.discoveryengine-v1beta 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 +178 -61
  2. package/package.json +1 -1
package/index.d.ts CHANGED
@@ -9,7 +9,7 @@
9
9
  // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
10
10
  // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
11
11
  // Generated from: https://discoveryengine.googleapis.com/$discovery/rest?version=v1beta
12
- // Revision: 20240510
12
+ // Revision: 20240517
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -386,7 +386,7 @@ declare namespace gapi.client {
386
386
  dataStoreIds?: string[];
387
387
  /** Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. */
388
388
  displayName?: string;
389
- /** 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. */
389
+ /** 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. */
390
390
  industryVertical?: string;
391
391
  /** Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical. */
392
392
  mediaRecommendationEngineConfig?: GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig;
@@ -696,7 +696,7 @@ declare namespace gapi.client {
696
696
  userPseudoId?: string;
697
697
  }
698
698
  interface GoogleCloudDiscoveryengineV1alphaSessionTurn {
699
- /** The resource name of the answer to the user query. */
699
+ /** The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. */
700
700
  answer?: string;
701
701
  /** The user query. */
702
702
  query?: GoogleCloudDiscoveryengineV1alphaQuery;
@@ -833,7 +833,7 @@ declare namespace gapi.client {
833
833
  safetySpec?: GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSafetySpec;
834
834
  /** Search specification. */
835
835
  searchSpec?: GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpec;
836
- /** 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. */
836
+ /** 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. */
837
837
  session?: string;
838
838
  /** 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. */
839
839
  userPseudoId?: string;
@@ -1383,7 +1383,7 @@ declare namespace gapi.client {
1383
1383
  name?: string;
1384
1384
  /** The promotion IDs associated with this Document. Currently, this field is restricted to at most one ID. */
1385
1385
  promotionIds?: string[];
1386
- /** 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` */
1386
+ /** 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` */
1387
1387
  quantity?: number;
1388
1388
  /** The Document URI - only allowed for website data stores. */
1389
1389
  uri?: string;
@@ -1440,7 +1440,7 @@ declare namespace gapi.client {
1440
1440
  dataStoreIds?: string[];
1441
1441
  /** Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. */
1442
1442
  displayName?: string;
1443
- /** 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. */
1443
+ /** 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. */
1444
1444
  industryVertical?: string;
1445
1445
  /** 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. */
1446
1446
  name?: string;
@@ -1506,7 +1506,7 @@ declare namespace gapi.client {
1506
1506
  gcsStagingDir?: string;
1507
1507
  }
1508
1508
  interface GoogleCloudDiscoveryengineV1betaFirestoreSource {
1509
- /** Required. The Firestore collection to copy the data from with a length limit of 1,500 characters. */
1509
+ /** Required. The Firestore collection (or entity) to copy the data from with a length limit of 1,500 characters. */
1510
1510
  collectionId?: string;
1511
1511
  /** Required. The Firestore database to copy the data from with a length limit of 256 characters. */
1512
1512
  databaseId?: string;
@@ -1516,9 +1516,9 @@ declare namespace gapi.client {
1516
1516
  projectId?: string;
1517
1517
  }
1518
1518
  interface GoogleCloudDiscoveryengineV1betaGcsSource {
1519
- /** 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. */
1519
+ /** 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. */
1520
1520
  dataSchema?: string;
1521
- /** 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`). */
1521
+ /** 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`). */
1522
1522
  inputUris?: string[];
1523
1523
  }
1524
1524
  interface GoogleCloudDiscoveryengineV1betaGroundingFact {
@@ -1800,17 +1800,17 @@ declare namespace gapi.client {
1800
1800
  records?: GoogleCloudDiscoveryengineV1betaRankingRecord[];
1801
1801
  }
1802
1802
  interface GoogleCloudDiscoveryengineV1betaRecommendRequest {
1803
- /** 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. */
1803
+ /** 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. */
1804
1804
  filter?: string;
1805
- /** 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. */
1805
+ /** 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. */
1806
1806
  pageSize?: number;
1807
- /** 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. */
1807
+ /** 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. */
1808
1808
  params?: {[P in string]: any};
1809
1809
  /** 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. */
1810
1810
  userEvent?: GoogleCloudDiscoveryengineV1betaUserEvent;
1811
1811
  /** 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. */
1812
1812
  userLabels?: {[P in string]: string};
1813
- /** 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. */
1813
+ /** 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. */
1814
1814
  validateOnly?: boolean;
1815
1815
  }
1816
1816
  interface GoogleCloudDiscoveryengineV1betaRecommendResponse {
@@ -1828,7 +1828,7 @@ declare namespace gapi.client {
1828
1828
  document?: GoogleCloudDiscoveryengineV1betaDocument;
1829
1829
  /** Resource ID of the recommended Document. */
1830
1830
  id?: string;
1831
- /** Additional Document metadata / annotations. Possible values: * `score`: Recommendation score in double value. Is set if `returnScore` is set to true in RecommendRequest.params. */
1831
+ /** Additional Document metadata or annotations. Possible values: * `score`: Recommendation score in double value. Is set if `returnScore` is set to true in RecommendRequest.params. */
1832
1832
  metadata?: {[P in string]: any};
1833
1833
  }
1834
1834
  interface GoogleCloudDiscoveryengineV1betaRecrawlUrisRequest {
@@ -1871,7 +1871,7 @@ declare namespace gapi.client {
1871
1871
  searchQuery?: string;
1872
1872
  }
1873
1873
  interface GoogleCloudDiscoveryengineV1betaSearchRequest {
1874
- /** Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/retail/docs/boosting#boost) */
1874
+ /** 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) */
1875
1875
  boostSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec;
1876
1876
  /** 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. */
1877
1877
  branch?: string;
@@ -1879,7 +1879,7 @@ declare namespace gapi.client {
1879
1879
  canonicalFilter?: string;
1880
1880
  /** A specification for configuring the behavior of content search. */
1881
1881
  contentSearchSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec;
1882
- /** A list of data store specs to apply on a search call. */
1882
+ /** 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. */
1883
1883
  dataStoreSpecs?: GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec[];
1884
1884
  /** 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. */
1885
1885
  embeddingSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec;
@@ -1897,7 +1897,7 @@ declare namespace gapi.client {
1897
1897
  pageSize?: number;
1898
1898
  /** 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. */
1899
1899
  pageToken?: string;
1900
- /** 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 */
1900
+ /** 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` */
1901
1901
  params?: {[P in string]: any};
1902
1902
  /** Raw search query. */
1903
1903
  query?: string;
@@ -2019,13 +2019,13 @@ declare namespace gapi.client {
2019
2019
  excludedFilterKeys?: string[];
2020
2020
  /** Required. The facet key specification. */
2021
2021
  facetKey?: GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpecFacetKey;
2022
- /** 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. */
2022
+ /** 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. */
2023
2023
  limit?: number;
2024
2024
  }
2025
2025
  interface GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpecFacetKey {
2026
2026
  /** True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise. */
2027
2027
  caseInsensitive?: boolean;
2028
- /** 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. */
2028
+ /** 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. */
2029
2029
  contains?: string[];
2030
2030
  /** 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. */
2031
2031
  intervals?: GoogleCloudDiscoveryengineV1betaInterval[];
@@ -2049,7 +2049,7 @@ declare namespace gapi.client {
2049
2049
  pinUnexpandedResults?: boolean;
2050
2050
  }
2051
2051
  interface GoogleCloudDiscoveryengineV1betaSearchRequestSpellCorrectionSpec {
2052
- /** The mode under which spell correction should take effect to replace the original search query. Default to Mode.AUTO. */
2052
+ /** The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO. */
2053
2053
  mode?: string;
2054
2054
  }
2055
2055
  interface GoogleCloudDiscoveryengineV1betaSearchResponse {
@@ -2080,7 +2080,7 @@ declare namespace gapi.client {
2080
2080
  interface GoogleCloudDiscoveryengineV1betaSearchResponseFacet {
2081
2081
  /** Whether the facet is dynamically generated. */
2082
2082
  dynamicFacet?: boolean;
2083
- /** The key for this facet. E.g., "colors" or "price". It matches SearchRequest.FacetSpec.FacetKey.key. */
2083
+ /** The key for this facet. For example, `"colors"` or `"price"`. It matches SearchRequest.FacetSpec.FacetKey.key. */
2084
2084
  key?: string;
2085
2085
  /** The facet values for this field. */
2086
2086
  values?: GoogleCloudDiscoveryengineV1betaSearchResponseFacetFacetValue[];
@@ -2106,9 +2106,9 @@ declare namespace gapi.client {
2106
2106
  refinementAttributes?: GoogleCloudDiscoveryengineV1betaSearchResponseGuidedSearchResultRefinementAttribute[];
2107
2107
  }
2108
2108
  interface GoogleCloudDiscoveryengineV1betaSearchResponseGuidedSearchResultRefinementAttribute {
2109
- /** Attribute key used to refine the results e.g. 'movie_type'. */
2109
+ /** Attribute key used to refine the results. For example, `"movie_type"`. */
2110
2110
  attributeKey?: string;
2111
- /** Attribute value used to refine the results e.g. 'drama'. */
2111
+ /** Attribute value used to refine the results. For example, `"drama"`. */
2112
2112
  attributeValue?: string;
2113
2113
  }
2114
2114
  interface GoogleCloudDiscoveryengineV1betaSearchResponseQueryExpansionInfo {
@@ -2118,7 +2118,7 @@ declare namespace gapi.client {
2118
2118
  pinnedResultCount?: string;
2119
2119
  }
2120
2120
  interface GoogleCloudDiscoveryengineV1betaSearchResponseSearchResult {
2121
- /** The document data snippet in the search response. Only fields that are marked as retrievable are populated. */
2121
+ /** The document data snippet in the search response. Only fields that are marked as `retrievable` are populated. */
2122
2122
  document?: GoogleCloudDiscoveryengineV1betaDocument;
2123
2123
  /** Document.id of the searched Document. */
2124
2124
  id?: string;
@@ -2250,7 +2250,7 @@ declare namespace gapi.client {
2250
2250
  userPseudoId?: string;
2251
2251
  }
2252
2252
  interface GoogleCloudDiscoveryengineV1betaSessionTurn {
2253
- /** The resource name of the answer to the user query. */
2253
+ /** The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. */
2254
2254
  answer?: string;
2255
2255
  /** The user query. */
2256
2256
  query?: GoogleCloudDiscoveryengineV1betaQuery;
@@ -2420,7 +2420,7 @@ declare namespace gapi.client {
2420
2420
  searchInfo?: GoogleCloudDiscoveryengineV1betaSearchInfo;
2421
2421
  /** 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. */
2422
2422
  sessionId?: string;
2423
- /** 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. */
2423
+ /** 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. */
2424
2424
  tagIds?: string[];
2425
2425
  /** The transaction metadata (if any) associated with this user event. */
2426
2426
  transactionInfo?: GoogleCloudDiscoveryengineV1betaTransactionInfo;
@@ -2553,7 +2553,7 @@ declare namespace gapi.client {
2553
2553
  dataStoreIds?: string[];
2554
2554
  /** Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. */
2555
2555
  displayName?: string;
2556
- /** 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. */
2556
+ /** 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. */
2557
2557
  industryVertical?: string;
2558
2558
  /** 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. */
2559
2559
  name?: string;
@@ -2736,6 +2736,7 @@ declare namespace gapi.client {
2736
2736
  /** Operation last update time. If the operation is done, this is also the finish time. */
2737
2737
  updateTime?: string;
2738
2738
  }
2739
+ interface GoogleLongrunningCancelOperationRequest {}
2739
2740
  interface GoogleLongrunningListOperationsResponse {
2740
2741
  /** The standard List next-page token. */
2741
2742
  nextPageToken?: string;
@@ -2847,7 +2848,7 @@ declare namespace gapi.client {
2847
2848
  alt?: string;
2848
2849
  /** JSONP */
2849
2850
  callback?: string;
2850
- /** 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. */
2851
+ /** 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. */
2851
2852
  documentId?: string;
2852
2853
  /** Selector specifying which fields to include in a partial response. */
2853
2854
  fields?: string;
@@ -2878,7 +2879,7 @@ declare namespace gapi.client {
2878
2879
  alt?: string;
2879
2880
  /** JSONP */
2880
2881
  callback?: string;
2881
- /** 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. */
2882
+ /** 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. */
2882
2883
  documentId?: string;
2883
2884
  /** Selector specifying which fields to include in a partial response. */
2884
2885
  fields?: string;
@@ -2953,7 +2954,7 @@ declare namespace gapi.client {
2953
2954
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2954
2955
  uploadType?: string;
2955
2956
  }): Request<GoogleCloudDiscoveryengineV1betaDocument>;
2956
- /** 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. */
2957
+ /** 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. */
2957
2958
  import(request: {
2958
2959
  /** V1 error format. */
2959
2960
  '$.xgafv'?: string;
@@ -3027,7 +3028,7 @@ declare namespace gapi.client {
3027
3028
  key?: string;
3028
3029
  /** OAuth 2.0 token for the current user. */
3029
3030
  oauth_token?: string;
3030
- /** 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. */
3031
+ /** 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. */
3031
3032
  pageSize?: number;
3032
3033
  /** 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. */
3033
3034
  pageToken?: string;
@@ -3048,7 +3049,7 @@ declare namespace gapi.client {
3048
3049
  '$.xgafv'?: string;
3049
3050
  /** OAuth access token. */
3050
3051
  access_token?: string;
3051
- /** If set to true, and the Document is not found, a new Document will be created. */
3052
+ /** If set to `true` and the Document is not found, a new Document is be created. */
3052
3053
  allowMissing?: boolean;
3053
3054
  /** Data format for response. */
3054
3055
  alt?: string;
@@ -3066,7 +3067,7 @@ declare namespace gapi.client {
3066
3067
  prettyPrint?: boolean;
3067
3068
  /** 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. */
3068
3069
  quotaUser?: string;
3069
- /** Indicates which fields in the provided imported 'document' to update. If not set, will by default update all fields. */
3070
+ /** Indicates which fields in the provided imported 'document' to update. If not set, by default updates all fields. */
3070
3071
  updateMask?: string;
3071
3072
  /** Upload protocol for media (e.g. "raw", "multipart"). */
3072
3073
  upload_protocol?: string;
@@ -3081,7 +3082,7 @@ declare namespace gapi.client {
3081
3082
  '$.xgafv'?: string;
3082
3083
  /** OAuth access token. */
3083
3084
  access_token?: string;
3084
- /** If set to true, and the Document is not found, a new Document will be created. */
3085
+ /** If set to `true` and the Document is not found, a new Document is be created. */
3085
3086
  allowMissing?: boolean;
3086
3087
  /** Data format for response. */
3087
3088
  alt?: string;
@@ -3099,7 +3100,7 @@ declare namespace gapi.client {
3099
3100
  prettyPrint?: boolean;
3100
3101
  /** 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. */
3101
3102
  quotaUser?: string;
3102
- /** Indicates which fields in the provided imported 'document' to update. If not set, will by default update all fields. */
3103
+ /** Indicates which fields in the provided imported 'document' to update. If not set, by default updates all fields. */
3103
3104
  updateMask?: string;
3104
3105
  /** Upload protocol for media (e.g. "raw", "multipart"). */
3105
3106
  upload_protocol?: string;
@@ -3168,6 +3169,64 @@ declare namespace gapi.client {
3168
3169
  ): Request<GoogleLongrunningOperation>;
3169
3170
  }
3170
3171
  interface OperationsResource {
3172
+ /** 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`. */
3173
+ cancel(request: {
3174
+ /** V1 error format. */
3175
+ '$.xgafv'?: string;
3176
+ /** OAuth access token. */
3177
+ access_token?: string;
3178
+ /** Data format for response. */
3179
+ alt?: string;
3180
+ /** JSONP */
3181
+ callback?: string;
3182
+ /** Selector specifying which fields to include in a partial response. */
3183
+ fields?: string;
3184
+ /** 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. */
3185
+ key?: string;
3186
+ /** The name of the operation resource to be cancelled. */
3187
+ name: string;
3188
+ /** OAuth 2.0 token for the current user. */
3189
+ oauth_token?: string;
3190
+ /** Returns response with indentations and line breaks. */
3191
+ prettyPrint?: boolean;
3192
+ /** 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. */
3193
+ quotaUser?: string;
3194
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3195
+ upload_protocol?: string;
3196
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3197
+ uploadType?: string;
3198
+ /** Request body */
3199
+ resource: GoogleLongrunningCancelOperationRequest;
3200
+ }): Request<{}>;
3201
+ cancel(
3202
+ request: {
3203
+ /** V1 error format. */
3204
+ '$.xgafv'?: string;
3205
+ /** OAuth access token. */
3206
+ access_token?: string;
3207
+ /** Data format for response. */
3208
+ alt?: string;
3209
+ /** JSONP */
3210
+ callback?: string;
3211
+ /** Selector specifying which fields to include in a partial response. */
3212
+ fields?: string;
3213
+ /** 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. */
3214
+ key?: string;
3215
+ /** The name of the operation resource to be cancelled. */
3216
+ name: string;
3217
+ /** OAuth 2.0 token for the current user. */
3218
+ oauth_token?: string;
3219
+ /** Returns response with indentations and line breaks. */
3220
+ prettyPrint?: boolean;
3221
+ /** 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. */
3222
+ quotaUser?: string;
3223
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3224
+ upload_protocol?: string;
3225
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3226
+ uploadType?: string;
3227
+ },
3228
+ body: GoogleLongrunningCancelOperationRequest
3229
+ ): Request<{}>;
3171
3230
  /** 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. */
3172
3231
  get(request?: {
3173
3232
  /** V1 error format. */
@@ -3743,7 +3802,7 @@ declare namespace gapi.client {
3743
3802
  prettyPrint?: boolean;
3744
3803
  /** 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. */
3745
3804
  quotaUser?: string;
3746
- /** 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. */
3805
+ /** 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. */
3747
3806
  schemaId?: string;
3748
3807
  /** Upload protocol for media (e.g. "raw", "multipart"). */
3749
3808
  upload_protocol?: string;
@@ -3774,7 +3833,7 @@ declare namespace gapi.client {
3774
3833
  prettyPrint?: boolean;
3775
3834
  /** 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. */
3776
3835
  quotaUser?: string;
3777
- /** 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. */
3836
+ /** 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. */
3778
3837
  schemaId?: string;
3779
3838
  /** Upload protocol for media (e.g. "raw", "multipart"). */
3780
3839
  upload_protocol?: string;
@@ -3853,7 +3912,7 @@ declare namespace gapi.client {
3853
3912
  key?: string;
3854
3913
  /** OAuth 2.0 token for the current user. */
3855
3914
  oauth_token?: string;
3856
- /** 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. */
3915
+ /** 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. */
3857
3916
  pageSize?: number;
3858
3917
  /** 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. */
3859
3918
  pageToken?: string;
@@ -3874,7 +3933,7 @@ declare namespace gapi.client {
3874
3933
  '$.xgafv'?: string;
3875
3934
  /** OAuth access token. */
3876
3935
  access_token?: string;
3877
- /** If set to true, and the Schema is not found, a new Schema will be created. In this situation, `update_mask` is ignored. */
3936
+ /** If set to true, and the Schema is not found, a new Schema is created. In this situation, `update_mask` is ignored. */
3878
3937
  allowMissing?: boolean;
3879
3938
  /** Data format for response. */
3880
3939
  alt?: string;
@@ -3905,7 +3964,7 @@ declare namespace gapi.client {
3905
3964
  '$.xgafv'?: string;
3906
3965
  /** OAuth access token. */
3907
3966
  access_token?: string;
3908
- /** If set to true, and the Schema is not found, a new Schema will be created. In this situation, `update_mask` is ignored. */
3967
+ /** If set to true, and the Schema is not found, a new Schema is created. In this situation, `update_mask` is ignored. */
3909
3968
  allowMissing?: boolean;
3910
3969
  /** Data format for response. */
3911
3970
  alt?: string;
@@ -4131,7 +4190,7 @@ declare namespace gapi.client {
4131
4190
  prettyPrint?: boolean;
4132
4191
  /** 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. */
4133
4192
  quotaUser?: string;
4134
- /** 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. */
4193
+ /** 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. */
4135
4194
  servingConfig: string;
4136
4195
  /** Upload protocol for media (e.g. "raw", "multipart"). */
4137
4196
  upload_protocol?: string;
@@ -4160,7 +4219,7 @@ declare namespace gapi.client {
4160
4219
  prettyPrint?: boolean;
4161
4220
  /** 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. */
4162
4221
  quotaUser?: string;
4163
- /** 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. */
4222
+ /** 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. */
4164
4223
  servingConfig: string;
4165
4224
  /** Upload protocol for media (e.g. "raw", "multipart"). */
4166
4225
  upload_protocol?: string;
@@ -5274,7 +5333,7 @@ declare namespace gapi.client {
5274
5333
  /** Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters. */
5275
5334
  userEvent?: string;
5276
5335
  }): Request<GoogleApiHttpBody>;
5277
- /** 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. */
5336
+ /** 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. */
5278
5337
  import(request: {
5279
5338
  /** V1 error format. */
5280
5339
  '$.xgafv'?: string;
@@ -6269,7 +6328,7 @@ declare namespace gapi.client {
6269
6328
  prettyPrint?: boolean;
6270
6329
  /** 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. */
6271
6330
  quotaUser?: string;
6272
- /** 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. */
6331
+ /** 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. */
6273
6332
  servingConfig: string;
6274
6333
  /** Upload protocol for media (e.g. "raw", "multipart"). */
6275
6334
  upload_protocol?: string;
@@ -6298,7 +6357,7 @@ declare namespace gapi.client {
6298
6357
  prettyPrint?: boolean;
6299
6358
  /** 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. */
6300
6359
  quotaUser?: string;
6301
- /** 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. */
6360
+ /** 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. */
6302
6361
  servingConfig: string;
6303
6362
  /** Upload protocol for media (e.g. "raw", "multipart"). */
6304
6363
  upload_protocol?: string;
@@ -7077,7 +7136,7 @@ declare namespace gapi.client {
7077
7136
  alt?: string;
7078
7137
  /** JSONP */
7079
7138
  callback?: string;
7080
- /** 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. */
7139
+ /** 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. */
7081
7140
  documentId?: string;
7082
7141
  /** Selector specifying which fields to include in a partial response. */
7083
7142
  fields?: string;
@@ -7108,7 +7167,7 @@ declare namespace gapi.client {
7108
7167
  alt?: string;
7109
7168
  /** JSONP */
7110
7169
  callback?: string;
7111
- /** 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. */
7170
+ /** 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. */
7112
7171
  documentId?: string;
7113
7172
  /** Selector specifying which fields to include in a partial response. */
7114
7173
  fields?: string;
@@ -7183,7 +7242,7 @@ declare namespace gapi.client {
7183
7242
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
7184
7243
  uploadType?: string;
7185
7244
  }): Request<GoogleCloudDiscoveryengineV1betaDocument>;
7186
- /** 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. */
7245
+ /** 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. */
7187
7246
  import(request: {
7188
7247
  /** V1 error format. */
7189
7248
  '$.xgafv'?: string;
@@ -7257,7 +7316,7 @@ declare namespace gapi.client {
7257
7316
  key?: string;
7258
7317
  /** OAuth 2.0 token for the current user. */
7259
7318
  oauth_token?: string;
7260
- /** 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. */
7319
+ /** 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. */
7261
7320
  pageSize?: number;
7262
7321
  /** 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. */
7263
7322
  pageToken?: string;
@@ -7278,7 +7337,7 @@ declare namespace gapi.client {
7278
7337
  '$.xgafv'?: string;
7279
7338
  /** OAuth access token. */
7280
7339
  access_token?: string;
7281
- /** If set to true, and the Document is not found, a new Document will be created. */
7340
+ /** If set to `true` and the Document is not found, a new Document is be created. */
7282
7341
  allowMissing?: boolean;
7283
7342
  /** Data format for response. */
7284
7343
  alt?: string;
@@ -7296,7 +7355,7 @@ declare namespace gapi.client {
7296
7355
  prettyPrint?: boolean;
7297
7356
  /** 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. */
7298
7357
  quotaUser?: string;
7299
- /** Indicates which fields in the provided imported 'document' to update. If not set, will by default update all fields. */
7358
+ /** Indicates which fields in the provided imported 'document' to update. If not set, by default updates all fields. */
7300
7359
  updateMask?: string;
7301
7360
  /** Upload protocol for media (e.g. "raw", "multipart"). */
7302
7361
  upload_protocol?: string;
@@ -7311,7 +7370,7 @@ declare namespace gapi.client {
7311
7370
  '$.xgafv'?: string;
7312
7371
  /** OAuth access token. */
7313
7372
  access_token?: string;
7314
- /** If set to true, and the Document is not found, a new Document will be created. */
7373
+ /** If set to `true` and the Document is not found, a new Document is be created. */
7315
7374
  allowMissing?: boolean;
7316
7375
  /** Data format for response. */
7317
7376
  alt?: string;
@@ -7329,7 +7388,7 @@ declare namespace gapi.client {
7329
7388
  prettyPrint?: boolean;
7330
7389
  /** 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. */
7331
7390
  quotaUser?: string;
7332
- /** Indicates which fields in the provided imported 'document' to update. If not set, will by default update all fields. */
7391
+ /** Indicates which fields in the provided imported 'document' to update. If not set, by default updates all fields. */
7333
7392
  updateMask?: string;
7334
7393
  /** Upload protocol for media (e.g. "raw", "multipart"). */
7335
7394
  upload_protocol?: string;
@@ -7398,6 +7457,64 @@ declare namespace gapi.client {
7398
7457
  ): Request<GoogleLongrunningOperation>;
7399
7458
  }
7400
7459
  interface OperationsResource {
7460
+ /** 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`. */
7461
+ cancel(request: {
7462
+ /** V1 error format. */
7463
+ '$.xgafv'?: string;
7464
+ /** OAuth access token. */
7465
+ access_token?: string;
7466
+ /** Data format for response. */
7467
+ alt?: string;
7468
+ /** JSONP */
7469
+ callback?: string;
7470
+ /** Selector specifying which fields to include in a partial response. */
7471
+ fields?: string;
7472
+ /** 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. */
7473
+ key?: string;
7474
+ /** The name of the operation resource to be cancelled. */
7475
+ name: string;
7476
+ /** OAuth 2.0 token for the current user. */
7477
+ oauth_token?: string;
7478
+ /** Returns response with indentations and line breaks. */
7479
+ prettyPrint?: boolean;
7480
+ /** 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. */
7481
+ quotaUser?: string;
7482
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
7483
+ upload_protocol?: string;
7484
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
7485
+ uploadType?: string;
7486
+ /** Request body */
7487
+ resource: GoogleLongrunningCancelOperationRequest;
7488
+ }): Request<{}>;
7489
+ cancel(
7490
+ request: {
7491
+ /** V1 error format. */
7492
+ '$.xgafv'?: string;
7493
+ /** OAuth access token. */
7494
+ access_token?: string;
7495
+ /** Data format for response. */
7496
+ alt?: string;
7497
+ /** JSONP */
7498
+ callback?: string;
7499
+ /** Selector specifying which fields to include in a partial response. */
7500
+ fields?: string;
7501
+ /** 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. */
7502
+ key?: string;
7503
+ /** The name of the operation resource to be cancelled. */
7504
+ name: string;
7505
+ /** OAuth 2.0 token for the current user. */
7506
+ oauth_token?: string;
7507
+ /** Returns response with indentations and line breaks. */
7508
+ prettyPrint?: boolean;
7509
+ /** 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. */
7510
+ quotaUser?: string;
7511
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
7512
+ upload_protocol?: string;
7513
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
7514
+ uploadType?: string;
7515
+ },
7516
+ body: GoogleLongrunningCancelOperationRequest
7517
+ ): Request<{}>;
7401
7518
  /** 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. */
7402
7519
  get(request?: {
7403
7520
  /** V1 error format. */
@@ -7882,7 +7999,7 @@ declare namespace gapi.client {
7882
7999
  prettyPrint?: boolean;
7883
8000
  /** 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. */
7884
8001
  quotaUser?: string;
7885
- /** 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. */
8002
+ /** 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. */
7886
8003
  schemaId?: string;
7887
8004
  /** Upload protocol for media (e.g. "raw", "multipart"). */
7888
8005
  upload_protocol?: string;
@@ -7913,7 +8030,7 @@ declare namespace gapi.client {
7913
8030
  prettyPrint?: boolean;
7914
8031
  /** 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. */
7915
8032
  quotaUser?: string;
7916
- /** 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. */
8033
+ /** 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. */
7917
8034
  schemaId?: string;
7918
8035
  /** Upload protocol for media (e.g. "raw", "multipart"). */
7919
8036
  upload_protocol?: string;
@@ -7992,7 +8109,7 @@ declare namespace gapi.client {
7992
8109
  key?: string;
7993
8110
  /** OAuth 2.0 token for the current user. */
7994
8111
  oauth_token?: string;
7995
- /** 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. */
8112
+ /** 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. */
7996
8113
  pageSize?: number;
7997
8114
  /** 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. */
7998
8115
  pageToken?: string;
@@ -8013,7 +8130,7 @@ declare namespace gapi.client {
8013
8130
  '$.xgafv'?: string;
8014
8131
  /** OAuth access token. */
8015
8132
  access_token?: string;
8016
- /** If set to true, and the Schema is not found, a new Schema will be created. In this situation, `update_mask` is ignored. */
8133
+ /** If set to true, and the Schema is not found, a new Schema is created. In this situation, `update_mask` is ignored. */
8017
8134
  allowMissing?: boolean;
8018
8135
  /** Data format for response. */
8019
8136
  alt?: string;
@@ -8044,7 +8161,7 @@ declare namespace gapi.client {
8044
8161
  '$.xgafv'?: string;
8045
8162
  /** OAuth access token. */
8046
8163
  access_token?: string;
8047
- /** If set to true, and the Schema is not found, a new Schema will be created. In this situation, `update_mask` is ignored. */
8164
+ /** If set to true, and the Schema is not found, a new Schema is created. In this situation, `update_mask` is ignored. */
8048
8165
  allowMissing?: boolean;
8049
8166
  /** Data format for response. */
8050
8167
  alt?: string;
@@ -8269,7 +8386,7 @@ declare namespace gapi.client {
8269
8386
  prettyPrint?: boolean;
8270
8387
  /** 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. */
8271
8388
  quotaUser?: string;
8272
- /** 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. */
8389
+ /** 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. */
8273
8390
  servingConfig: string;
8274
8391
  /** Upload protocol for media (e.g. "raw", "multipart"). */
8275
8392
  upload_protocol?: string;
@@ -8298,7 +8415,7 @@ declare namespace gapi.client {
8298
8415
  prettyPrint?: boolean;
8299
8416
  /** 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. */
8300
8417
  quotaUser?: string;
8301
- /** 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. */
8418
+ /** 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. */
8302
8419
  servingConfig: string;
8303
8420
  /** Upload protocol for media (e.g. "raw", "multipart"). */
8304
8421
  upload_protocol?: string;
@@ -9197,7 +9314,7 @@ declare namespace gapi.client {
9197
9314
  /** Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters. */
9198
9315
  userEvent?: string;
9199
9316
  }): Request<GoogleApiHttpBody>;
9200
- /** 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. */
9317
+ /** 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. */
9201
9318
  import(request: {
9202
9319
  /** V1 error format. */
9203
9320
  '$.xgafv'?: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.discoveryengine-v1beta",
3
- "version": "0.0.20240510",
3
+ "version": "0.0.20240517",
4
4
  "description": "TypeScript typings for Discovery Engine API v1beta",
5
5
  "repository": {
6
6
  "type": "git",