@maxim_mazurok/gapi.client.discoveryengine-v1alpha 0.0.20240512 → 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.
- package/index.d.ts +61 -61
- 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:
|
|
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
|
|
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,7 +484,7 @@ 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 [
|
|
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
488
|
relevanceScore?: number;
|
|
489
489
|
}
|
|
490
490
|
interface GoogleCloudDiscoveryengineV1alphaChunkChunkMetadata {
|
|
@@ -749,7 +749,7 @@ declare namespace gapi.client {
|
|
|
749
749
|
name?: string;
|
|
750
750
|
/** The promotion IDs associated with this Document. Currently, this field is restricted to at most one ID. */
|
|
751
751
|
promotionIds?: string[];
|
|
752
|
-
/** Quantity of the Document associated with the user event. Defaults to 1. For example, this field
|
|
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` */
|
|
753
753
|
quantity?: number;
|
|
754
754
|
/** The Document URI - only allowed for website data stores. */
|
|
755
755
|
uri?: string;
|
|
@@ -821,7 +821,7 @@ declare namespace gapi.client {
|
|
|
821
821
|
dataStoreIds?: string[];
|
|
822
822
|
/** Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. */
|
|
823
823
|
displayName?: string;
|
|
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
|
|
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. */
|
|
825
825
|
industryVertical?: string;
|
|
826
826
|
/** Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical. */
|
|
827
827
|
mediaRecommendationEngineConfig?: GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig;
|
|
@@ -976,7 +976,7 @@ declare namespace gapi.client {
|
|
|
976
976
|
searchableOption?: string;
|
|
977
977
|
}
|
|
978
978
|
interface GoogleCloudDiscoveryengineV1alphaFirestoreSource {
|
|
979
|
-
/** 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. */
|
|
980
980
|
collectionId?: string;
|
|
981
981
|
/** Required. The Firestore database to copy the data from with a length limit of 256 characters. */
|
|
982
982
|
databaseId?: string;
|
|
@@ -986,9 +986,9 @@ declare namespace gapi.client {
|
|
|
986
986
|
projectId?: string;
|
|
987
987
|
}
|
|
988
988
|
interface GoogleCloudDiscoveryengineV1alphaGcsSource {
|
|
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
|
|
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. */
|
|
990
990
|
dataSchema?: string;
|
|
991
|
-
/** 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`). */
|
|
992
992
|
inputUris?: string[];
|
|
993
993
|
}
|
|
994
994
|
interface GoogleCloudDiscoveryengineV1alphaGroundingFact {
|
|
@@ -1365,17 +1365,17 @@ declare namespace gapi.client {
|
|
|
1365
1365
|
records?: GoogleCloudDiscoveryengineV1alphaRankingRecord[];
|
|
1366
1366
|
}
|
|
1367
1367
|
interface GoogleCloudDiscoveryengineV1alphaRecommendRequest {
|
|
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
|
|
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. */
|
|
1369
1369
|
filter?: string;
|
|
1370
|
-
/** Maximum number of results to return. Set this property to the number of recommendation results needed. If zero, the service
|
|
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. */
|
|
1371
1371
|
pageSize?: number;
|
|
1372
|
-
/** Additional domain specific parameters for the recommendations. Allowed values: * `returnDocument`: Boolean. If set to true
|
|
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. */
|
|
1373
1373
|
params?: {[P in string]: any};
|
|
1374
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. */
|
|
1375
1375
|
userEvent?: GoogleCloudDiscoveryengineV1alphaUserEvent;
|
|
1376
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. */
|
|
1377
1377
|
userLabels?: {[P in string]: string};
|
|
1378
|
-
/** Use validate only mode for this recommendation query. If set to true
|
|
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. */
|
|
1379
1379
|
validateOnly?: boolean;
|
|
1380
1380
|
}
|
|
1381
1381
|
interface GoogleCloudDiscoveryengineV1alphaRecommendResponse {
|
|
@@ -1393,7 +1393,7 @@ declare namespace gapi.client {
|
|
|
1393
1393
|
document?: GoogleCloudDiscoveryengineV1alphaDocument;
|
|
1394
1394
|
/** Resource ID of the recommended Document. */
|
|
1395
1395
|
id?: string;
|
|
1396
|
-
/** Additional Document metadata
|
|
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. */
|
|
1397
1397
|
metadata?: {[P in string]: any};
|
|
1398
1398
|
}
|
|
1399
1399
|
interface GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata {
|
|
@@ -1480,7 +1480,7 @@ declare namespace gapi.client {
|
|
|
1480
1480
|
searchQuery?: string;
|
|
1481
1481
|
}
|
|
1482
1482
|
interface GoogleCloudDiscoveryengineV1alphaSearchRequest {
|
|
1483
|
-
/** Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/
|
|
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) */
|
|
1484
1484
|
boostSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec;
|
|
1485
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. */
|
|
1486
1486
|
branch?: string;
|
|
@@ -1490,7 +1490,7 @@ declare namespace gapi.client {
|
|
|
1490
1490
|
contentSearchSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec;
|
|
1491
1491
|
/** Custom fine tuning configs. */
|
|
1492
1492
|
customFineTuningSpec?: GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec;
|
|
1493
|
-
/**
|
|
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. */
|
|
1494
1494
|
dataStoreSpecs?: GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec[];
|
|
1495
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. */
|
|
1496
1496
|
embeddingSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec;
|
|
@@ -1508,7 +1508,7 @@ declare namespace gapi.client {
|
|
|
1508
1508
|
pageSize?: number;
|
|
1509
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. */
|
|
1510
1510
|
pageToken?: string;
|
|
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.
|
|
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` */
|
|
1512
1512
|
params?: {[P in string]: any};
|
|
1513
1513
|
/** Raw search query. */
|
|
1514
1514
|
query?: string;
|
|
@@ -1640,13 +1640,13 @@ declare namespace gapi.client {
|
|
|
1640
1640
|
excludedFilterKeys?: string[];
|
|
1641
1641
|
/** Required. The facet key specification. */
|
|
1642
1642
|
facetKey?: GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpecFacetKey;
|
|
1643
|
-
/** Maximum
|
|
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. */
|
|
1644
1644
|
limit?: number;
|
|
1645
1645
|
}
|
|
1646
1646
|
interface GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpecFacetKey {
|
|
1647
1647
|
/** True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise. */
|
|
1648
1648
|
caseInsensitive?: boolean;
|
|
1649
|
-
/** Only get facet values that
|
|
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. */
|
|
1650
1650
|
contains?: string[];
|
|
1651
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. */
|
|
1652
1652
|
intervals?: GoogleCloudDiscoveryengineV1alphaInterval[];
|
|
@@ -1670,7 +1670,7 @@ declare namespace gapi.client {
|
|
|
1670
1670
|
pinUnexpandedResults?: boolean;
|
|
1671
1671
|
}
|
|
1672
1672
|
interface GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec {
|
|
1673
|
-
/** The mode under which spell correction
|
|
1673
|
+
/** The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO. */
|
|
1674
1674
|
mode?: string;
|
|
1675
1675
|
}
|
|
1676
1676
|
interface GoogleCloudDiscoveryengineV1alphaSearchResponse {
|
|
@@ -1701,7 +1701,7 @@ declare namespace gapi.client {
|
|
|
1701
1701
|
interface GoogleCloudDiscoveryengineV1alphaSearchResponseFacet {
|
|
1702
1702
|
/** Whether the facet is dynamically generated. */
|
|
1703
1703
|
dynamicFacet?: boolean;
|
|
1704
|
-
/** The key for this facet.
|
|
1704
|
+
/** The key for this facet. For example, `"colors"` or `"price"`. It matches SearchRequest.FacetSpec.FacetKey.key. */
|
|
1705
1705
|
key?: string;
|
|
1706
1706
|
/** The facet values for this field. */
|
|
1707
1707
|
values?: GoogleCloudDiscoveryengineV1alphaSearchResponseFacetFacetValue[];
|
|
@@ -1727,9 +1727,9 @@ declare namespace gapi.client {
|
|
|
1727
1727
|
refinementAttributes?: GoogleCloudDiscoveryengineV1alphaSearchResponseGuidedSearchResultRefinementAttribute[];
|
|
1728
1728
|
}
|
|
1729
1729
|
interface GoogleCloudDiscoveryengineV1alphaSearchResponseGuidedSearchResultRefinementAttribute {
|
|
1730
|
-
/** Attribute key used to refine the results
|
|
1730
|
+
/** Attribute key used to refine the results. For example, `"movie_type"`. */
|
|
1731
1731
|
attributeKey?: string;
|
|
1732
|
-
/** Attribute value used to refine the results
|
|
1732
|
+
/** Attribute value used to refine the results. For example, `"drama"`. */
|
|
1733
1733
|
attributeValue?: string;
|
|
1734
1734
|
}
|
|
1735
1735
|
interface GoogleCloudDiscoveryengineV1alphaSearchResponseQueryExpansionInfo {
|
|
@@ -1741,7 +1741,7 @@ declare namespace gapi.client {
|
|
|
1741
1741
|
interface GoogleCloudDiscoveryengineV1alphaSearchResponseSearchResult {
|
|
1742
1742
|
/** The chunk data in the search response if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS. */
|
|
1743
1743
|
chunk?: GoogleCloudDiscoveryengineV1alphaChunk;
|
|
1744
|
-
/** 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. */
|
|
1745
1745
|
document?: GoogleCloudDiscoveryengineV1alphaDocument;
|
|
1746
1746
|
/** Document.id of the searched Document. */
|
|
1747
1747
|
id?: string;
|
|
@@ -1879,7 +1879,7 @@ declare namespace gapi.client {
|
|
|
1879
1879
|
userPseudoId?: string;
|
|
1880
1880
|
}
|
|
1881
1881
|
interface GoogleCloudDiscoveryengineV1alphaSessionTurn {
|
|
1882
|
-
/** 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. */
|
|
1883
1883
|
answer?: string;
|
|
1884
1884
|
/** The user query. */
|
|
1885
1885
|
query?: GoogleCloudDiscoveryengineV1alphaQuery;
|
|
@@ -2049,7 +2049,7 @@ declare namespace gapi.client {
|
|
|
2049
2049
|
searchInfo?: GoogleCloudDiscoveryengineV1alphaSearchInfo;
|
|
2050
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. */
|
|
2051
2051
|
sessionId?: string;
|
|
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
|
|
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. */
|
|
2053
2053
|
tagIds?: string[];
|
|
2054
2054
|
/** The transaction metadata (if any) associated with this user event. */
|
|
2055
2055
|
transactionInfo?: GoogleCloudDiscoveryengineV1alphaTransactionInfo;
|
|
@@ -2215,7 +2215,7 @@ declare namespace gapi.client {
|
|
|
2215
2215
|
dataStoreIds?: string[];
|
|
2216
2216
|
/** Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. */
|
|
2217
2217
|
displayName?: string;
|
|
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
|
|
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. */
|
|
2219
2219
|
industryVertical?: string;
|
|
2220
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. */
|
|
2221
2221
|
name?: string;
|
|
@@ -2543,7 +2543,7 @@ declare namespace gapi.client {
|
|
|
2543
2543
|
dataStoreIds?: string[];
|
|
2544
2544
|
/** Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. */
|
|
2545
2545
|
displayName?: string;
|
|
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
|
|
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. */
|
|
2547
2547
|
industryVertical?: string;
|
|
2548
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. */
|
|
2549
2549
|
name?: string;
|
|
@@ -2898,7 +2898,7 @@ declare namespace gapi.client {
|
|
|
2898
2898
|
alt?: string;
|
|
2899
2899
|
/** JSONP */
|
|
2900
2900
|
callback?: string;
|
|
2901
|
-
/** Required. The ID to use for the Document, which
|
|
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. */
|
|
2902
2902
|
documentId?: string;
|
|
2903
2903
|
/** Selector specifying which fields to include in a partial response. */
|
|
2904
2904
|
fields?: string;
|
|
@@ -2929,7 +2929,7 @@ declare namespace gapi.client {
|
|
|
2929
2929
|
alt?: string;
|
|
2930
2930
|
/** JSONP */
|
|
2931
2931
|
callback?: string;
|
|
2932
|
-
/** Required. The ID to use for the Document, which
|
|
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. */
|
|
2933
2933
|
documentId?: string;
|
|
2934
2934
|
/** Selector specifying which fields to include in a partial response. */
|
|
2935
2935
|
fields?: string;
|
|
@@ -3035,7 +3035,7 @@ declare namespace gapi.client {
|
|
|
3035
3035
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3036
3036
|
uploadType?: string;
|
|
3037
3037
|
}): Request<GoogleCloudDiscoveryengineV1alphaProcessedDocument>;
|
|
3038
|
-
/** Bulk import of multiple Documents. Request processing may be synchronous. Non-existing items
|
|
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. */
|
|
3039
3039
|
import(request: {
|
|
3040
3040
|
/** V1 error format. */
|
|
3041
3041
|
'$.xgafv'?: string;
|
|
@@ -3109,7 +3109,7 @@ declare namespace gapi.client {
|
|
|
3109
3109
|
key?: string;
|
|
3110
3110
|
/** OAuth 2.0 token for the current user. */
|
|
3111
3111
|
oauth_token?: string;
|
|
3112
|
-
/** Maximum number of Documents to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000
|
|
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. */
|
|
3113
3113
|
pageSize?: number;
|
|
3114
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. */
|
|
3115
3115
|
pageToken?: string;
|
|
@@ -3130,7 +3130,7 @@ declare namespace gapi.client {
|
|
|
3130
3130
|
'$.xgafv'?: string;
|
|
3131
3131
|
/** OAuth access token. */
|
|
3132
3132
|
access_token?: string;
|
|
3133
|
-
/** If set to true
|
|
3133
|
+
/** If set to `true` and the Document is not found, a new Document is be created. */
|
|
3134
3134
|
allowMissing?: boolean;
|
|
3135
3135
|
/** Data format for response. */
|
|
3136
3136
|
alt?: string;
|
|
@@ -3148,7 +3148,7 @@ declare namespace gapi.client {
|
|
|
3148
3148
|
prettyPrint?: boolean;
|
|
3149
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. */
|
|
3150
3150
|
quotaUser?: string;
|
|
3151
|
-
/** Indicates which fields in the provided imported 'document' to update. If not set,
|
|
3151
|
+
/** Indicates which fields in the provided imported 'document' to update. If not set, by default updates all fields. */
|
|
3152
3152
|
updateMask?: string;
|
|
3153
3153
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3154
3154
|
upload_protocol?: string;
|
|
@@ -3163,7 +3163,7 @@ declare namespace gapi.client {
|
|
|
3163
3163
|
'$.xgafv'?: string;
|
|
3164
3164
|
/** OAuth access token. */
|
|
3165
3165
|
access_token?: string;
|
|
3166
|
-
/** If set to true
|
|
3166
|
+
/** If set to `true` and the Document is not found, a new Document is be created. */
|
|
3167
3167
|
allowMissing?: boolean;
|
|
3168
3168
|
/** Data format for response. */
|
|
3169
3169
|
alt?: string;
|
|
@@ -3181,7 +3181,7 @@ declare namespace gapi.client {
|
|
|
3181
3181
|
prettyPrint?: boolean;
|
|
3182
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. */
|
|
3183
3183
|
quotaUser?: string;
|
|
3184
|
-
/** Indicates which fields in the provided imported 'document' to update. If not set,
|
|
3184
|
+
/** Indicates which fields in the provided imported 'document' to update. If not set, by default updates all fields. */
|
|
3185
3185
|
updateMask?: string;
|
|
3186
3186
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3187
3187
|
upload_protocol?: string;
|
|
@@ -3884,7 +3884,7 @@ declare namespace gapi.client {
|
|
|
3884
3884
|
prettyPrint?: boolean;
|
|
3885
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. */
|
|
3886
3886
|
quotaUser?: string;
|
|
3887
|
-
/** Required. The ID to use for the Schema, which
|
|
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. */
|
|
3888
3888
|
schemaId?: string;
|
|
3889
3889
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3890
3890
|
upload_protocol?: string;
|
|
@@ -3915,7 +3915,7 @@ declare namespace gapi.client {
|
|
|
3915
3915
|
prettyPrint?: boolean;
|
|
3916
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. */
|
|
3917
3917
|
quotaUser?: string;
|
|
3918
|
-
/** Required. The ID to use for the Schema, which
|
|
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. */
|
|
3919
3919
|
schemaId?: string;
|
|
3920
3920
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3921
3921
|
upload_protocol?: string;
|
|
@@ -3994,7 +3994,7 @@ declare namespace gapi.client {
|
|
|
3994
3994
|
key?: string;
|
|
3995
3995
|
/** OAuth 2.0 token for the current user. */
|
|
3996
3996
|
oauth_token?: string;
|
|
3997
|
-
/** The maximum number of Schemas to return. The service may return fewer than this value. If unspecified, at most 100 Schemas
|
|
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. */
|
|
3998
3998
|
pageSize?: number;
|
|
3999
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. */
|
|
4000
4000
|
pageToken?: string;
|
|
@@ -4015,7 +4015,7 @@ declare namespace gapi.client {
|
|
|
4015
4015
|
'$.xgafv'?: string;
|
|
4016
4016
|
/** OAuth access token. */
|
|
4017
4017
|
access_token?: string;
|
|
4018
|
-
/** If set to true, and the Schema is not found, a new Schema
|
|
4018
|
+
/** If set to true, and the Schema is not found, a new Schema is created. In this situation, `update_mask` is ignored. */
|
|
4019
4019
|
allowMissing?: boolean;
|
|
4020
4020
|
/** Data format for response. */
|
|
4021
4021
|
alt?: string;
|
|
@@ -4046,7 +4046,7 @@ declare namespace gapi.client {
|
|
|
4046
4046
|
'$.xgafv'?: string;
|
|
4047
4047
|
/** OAuth access token. */
|
|
4048
4048
|
access_token?: string;
|
|
4049
|
-
/** If set to true, and the Schema is not found, a new Schema
|
|
4049
|
+
/** If set to true, and the Schema is not found, a new Schema is created. In this situation, `update_mask` is ignored. */
|
|
4050
4050
|
allowMissing?: boolean;
|
|
4051
4051
|
/** Data format for response. */
|
|
4052
4052
|
alt?: string;
|
|
@@ -4272,7 +4272,7 @@ declare namespace gapi.client {
|
|
|
4272
4272
|
prettyPrint?: boolean;
|
|
4273
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. */
|
|
4274
4274
|
quotaUser?: string;
|
|
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
|
|
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. */
|
|
4276
4276
|
servingConfig: string;
|
|
4277
4277
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
4278
4278
|
upload_protocol?: string;
|
|
@@ -4301,7 +4301,7 @@ declare namespace gapi.client {
|
|
|
4301
4301
|
prettyPrint?: boolean;
|
|
4302
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. */
|
|
4303
4303
|
quotaUser?: string;
|
|
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
|
|
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. */
|
|
4305
4305
|
servingConfig: string;
|
|
4306
4306
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
4307
4307
|
upload_protocol?: string;
|
|
@@ -5415,7 +5415,7 @@ declare namespace gapi.client {
|
|
|
5415
5415
|
/** Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters. */
|
|
5416
5416
|
userEvent?: string;
|
|
5417
5417
|
}): Request<GoogleApiHttpBody>;
|
|
5418
|
-
/** Bulk import of
|
|
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. */
|
|
5419
5419
|
import(request: {
|
|
5420
5420
|
/** V1 error format. */
|
|
5421
5421
|
'$.xgafv'?: string;
|
|
@@ -6557,7 +6557,7 @@ declare namespace gapi.client {
|
|
|
6557
6557
|
prettyPrint?: boolean;
|
|
6558
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. */
|
|
6559
6559
|
quotaUser?: string;
|
|
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
|
|
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. */
|
|
6561
6561
|
servingConfig: string;
|
|
6562
6562
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
6563
6563
|
upload_protocol?: string;
|
|
@@ -6586,7 +6586,7 @@ declare namespace gapi.client {
|
|
|
6586
6586
|
prettyPrint?: boolean;
|
|
6587
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. */
|
|
6588
6588
|
quotaUser?: string;
|
|
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
|
|
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. */
|
|
6590
6590
|
servingConfig: string;
|
|
6591
6591
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
6592
6592
|
upload_protocol?: string;
|
|
@@ -7425,7 +7425,7 @@ declare namespace gapi.client {
|
|
|
7425
7425
|
alt?: string;
|
|
7426
7426
|
/** JSONP */
|
|
7427
7427
|
callback?: string;
|
|
7428
|
-
/** Required. The ID to use for the Document, which
|
|
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. */
|
|
7429
7429
|
documentId?: string;
|
|
7430
7430
|
/** Selector specifying which fields to include in a partial response. */
|
|
7431
7431
|
fields?: string;
|
|
@@ -7456,7 +7456,7 @@ declare namespace gapi.client {
|
|
|
7456
7456
|
alt?: string;
|
|
7457
7457
|
/** JSONP */
|
|
7458
7458
|
callback?: string;
|
|
7459
|
-
/** Required. The ID to use for the Document, which
|
|
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. */
|
|
7460
7460
|
documentId?: string;
|
|
7461
7461
|
/** Selector specifying which fields to include in a partial response. */
|
|
7462
7462
|
fields?: string;
|
|
@@ -7562,7 +7562,7 @@ declare namespace gapi.client {
|
|
|
7562
7562
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
7563
7563
|
uploadType?: string;
|
|
7564
7564
|
}): Request<GoogleCloudDiscoveryengineV1alphaProcessedDocument>;
|
|
7565
|
-
/** Bulk import of multiple Documents. Request processing may be synchronous. Non-existing items
|
|
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. */
|
|
7566
7566
|
import(request: {
|
|
7567
7567
|
/** V1 error format. */
|
|
7568
7568
|
'$.xgafv'?: string;
|
|
@@ -7636,7 +7636,7 @@ declare namespace gapi.client {
|
|
|
7636
7636
|
key?: string;
|
|
7637
7637
|
/** OAuth 2.0 token for the current user. */
|
|
7638
7638
|
oauth_token?: string;
|
|
7639
|
-
/** Maximum number of Documents to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000
|
|
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. */
|
|
7640
7640
|
pageSize?: number;
|
|
7641
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. */
|
|
7642
7642
|
pageToken?: string;
|
|
@@ -7657,7 +7657,7 @@ declare namespace gapi.client {
|
|
|
7657
7657
|
'$.xgafv'?: string;
|
|
7658
7658
|
/** OAuth access token. */
|
|
7659
7659
|
access_token?: string;
|
|
7660
|
-
/** If set to true
|
|
7660
|
+
/** If set to `true` and the Document is not found, a new Document is be created. */
|
|
7661
7661
|
allowMissing?: boolean;
|
|
7662
7662
|
/** Data format for response. */
|
|
7663
7663
|
alt?: string;
|
|
@@ -7675,7 +7675,7 @@ declare namespace gapi.client {
|
|
|
7675
7675
|
prettyPrint?: boolean;
|
|
7676
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. */
|
|
7677
7677
|
quotaUser?: string;
|
|
7678
|
-
/** Indicates which fields in the provided imported 'document' to update. If not set,
|
|
7678
|
+
/** Indicates which fields in the provided imported 'document' to update. If not set, by default updates all fields. */
|
|
7679
7679
|
updateMask?: string;
|
|
7680
7680
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
7681
7681
|
upload_protocol?: string;
|
|
@@ -7690,7 +7690,7 @@ declare namespace gapi.client {
|
|
|
7690
7690
|
'$.xgafv'?: string;
|
|
7691
7691
|
/** OAuth access token. */
|
|
7692
7692
|
access_token?: string;
|
|
7693
|
-
/** If set to true
|
|
7693
|
+
/** If set to `true` and the Document is not found, a new Document is be created. */
|
|
7694
7694
|
allowMissing?: boolean;
|
|
7695
7695
|
/** Data format for response. */
|
|
7696
7696
|
alt?: string;
|
|
@@ -7708,7 +7708,7 @@ declare namespace gapi.client {
|
|
|
7708
7708
|
prettyPrint?: boolean;
|
|
7709
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. */
|
|
7710
7710
|
quotaUser?: string;
|
|
7711
|
-
/** Indicates which fields in the provided imported 'document' to update. If not set,
|
|
7711
|
+
/** Indicates which fields in the provided imported 'document' to update. If not set, by default updates all fields. */
|
|
7712
7712
|
updateMask?: string;
|
|
7713
7713
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
7714
7714
|
upload_protocol?: string;
|
|
@@ -8320,7 +8320,7 @@ declare namespace gapi.client {
|
|
|
8320
8320
|
prettyPrint?: boolean;
|
|
8321
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. */
|
|
8322
8322
|
quotaUser?: string;
|
|
8323
|
-
/** Required. The ID to use for the Schema, which
|
|
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. */
|
|
8324
8324
|
schemaId?: string;
|
|
8325
8325
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
8326
8326
|
upload_protocol?: string;
|
|
@@ -8351,7 +8351,7 @@ declare namespace gapi.client {
|
|
|
8351
8351
|
prettyPrint?: boolean;
|
|
8352
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. */
|
|
8353
8353
|
quotaUser?: string;
|
|
8354
|
-
/** Required. The ID to use for the Schema, which
|
|
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. */
|
|
8355
8355
|
schemaId?: string;
|
|
8356
8356
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
8357
8357
|
upload_protocol?: string;
|
|
@@ -8430,7 +8430,7 @@ declare namespace gapi.client {
|
|
|
8430
8430
|
key?: string;
|
|
8431
8431
|
/** OAuth 2.0 token for the current user. */
|
|
8432
8432
|
oauth_token?: string;
|
|
8433
|
-
/** The maximum number of Schemas to return. The service may return fewer than this value. If unspecified, at most 100 Schemas
|
|
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. */
|
|
8434
8434
|
pageSize?: number;
|
|
8435
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. */
|
|
8436
8436
|
pageToken?: string;
|
|
@@ -8451,7 +8451,7 @@ declare namespace gapi.client {
|
|
|
8451
8451
|
'$.xgafv'?: string;
|
|
8452
8452
|
/** OAuth access token. */
|
|
8453
8453
|
access_token?: string;
|
|
8454
|
-
/** If set to true, and the Schema is not found, a new Schema
|
|
8454
|
+
/** If set to true, and the Schema is not found, a new Schema is created. In this situation, `update_mask` is ignored. */
|
|
8455
8455
|
allowMissing?: boolean;
|
|
8456
8456
|
/** Data format for response. */
|
|
8457
8457
|
alt?: string;
|
|
@@ -8482,7 +8482,7 @@ declare namespace gapi.client {
|
|
|
8482
8482
|
'$.xgafv'?: string;
|
|
8483
8483
|
/** OAuth access token. */
|
|
8484
8484
|
access_token?: string;
|
|
8485
|
-
/** If set to true, and the Schema is not found, a new Schema
|
|
8485
|
+
/** If set to true, and the Schema is not found, a new Schema is created. In this situation, `update_mask` is ignored. */
|
|
8486
8486
|
allowMissing?: boolean;
|
|
8487
8487
|
/** Data format for response. */
|
|
8488
8488
|
alt?: string;
|
|
@@ -8707,7 +8707,7 @@ declare namespace gapi.client {
|
|
|
8707
8707
|
prettyPrint?: boolean;
|
|
8708
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. */
|
|
8709
8709
|
quotaUser?: string;
|
|
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
|
|
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. */
|
|
8711
8711
|
servingConfig: string;
|
|
8712
8712
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
8713
8713
|
upload_protocol?: string;
|
|
@@ -8736,7 +8736,7 @@ declare namespace gapi.client {
|
|
|
8736
8736
|
prettyPrint?: boolean;
|
|
8737
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. */
|
|
8738
8738
|
quotaUser?: string;
|
|
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
|
|
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. */
|
|
8740
8740
|
servingConfig: string;
|
|
8741
8741
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
8742
8742
|
upload_protocol?: string;
|
|
@@ -9635,7 +9635,7 @@ declare namespace gapi.client {
|
|
|
9635
9635
|
/** Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters. */
|
|
9636
9636
|
userEvent?: string;
|
|
9637
9637
|
}): Request<GoogleApiHttpBody>;
|
|
9638
|
-
/** Bulk import of
|
|
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. */
|
|
9639
9639
|
import(request: {
|
|
9640
9640
|
/** V1 error format. */
|
|
9641
9641
|
'$.xgafv'?: string;
|