Skip to content

Commit

Permalink
fix(recommendationengine): update the API
Browse files Browse the repository at this point in the history
#### recommendationengine:v1beta1

The following keys were changed:
- description
- resources.projects.resources.locations.resources.catalogs.resources.eventStores.resources.placements.methods.predict.description
- schemas.GoogleCloudRecommendationengineV1beta1ProductEventDetail.properties.pageCategories.description
- schemas.GoogleCloudRecommendationengineV1beta1ProductEventDetail.properties.searchQuery.description
- title
  • Loading branch information
yoshi-automation authored and sofisl committed Mar 10, 2021
1 parent 0a62f96 commit c8139c2
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 12 deletions.
12 changes: 6 additions & 6 deletions discovery/recommendationengine-v1beta1.json
Expand Up @@ -12,7 +12,7 @@
"baseUrl": "https://recommendationengine.googleapis.com/",
"batchPath": "batch",
"canonicalName": "Recommendations AI",
"description": "Recommendations AI service enables customers to build end-to-end personalized recommendation systems without requiring a high level of expertise in machine learning, recommendation system, or Google Cloud.",
"description": "Note that we now highly recommend new customers to use Retail API, which incorporates the GA version of the Recommendations AI funtionalities. To enable Retail API, please visit https://console.cloud.google.com/apis/library/retail.googleapis.com. The Recommendations AI service enables customers to build end-to-end personalized recommendation systems without requiring a high level of expertise in machine learning, recommendation system, or Google Cloud.",
"discoveryVersion": "v1",
"documentationLink": "https://cloud.google.com/recommendations-ai/docs",
"fullyEncodeReservedExpansion": true,
Expand Down Expand Up @@ -443,7 +443,7 @@
"placements": {
"methods": {
"predict": {
"description": "Makes a recommendation prediction. If using API Key based authentication, the API Key must be registered using the PredictionApiKeyRegistry service. [Learn more](/recommendations-ai/docs/setting-up#register-key).",
"description": "Makes a recommendation prediction. If using API Key based authentication, the API Key must be registered using the PredictionApiKeyRegistry service. [Learn more](https://cloud.google.com/recommendations-ai/docs/setting-up#register-key).",
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/eventStores/{eventStoresId}/placements/{placementsId}:predict",
"httpMethod": "POST",
"id": "recommendationengine.projects.locations.catalogs.eventStores.placements.predict",
Expand Down Expand Up @@ -842,7 +842,7 @@
}
}
},
"revision": "20201027",
"revision": "20210303",
"rootUrl": "https://recommendationengine.googleapis.com/",
"schemas": {
"GoogleApiHttpBody": {
Expand Down Expand Up @@ -1704,7 +1704,7 @@
"type": "string"
},
"pageCategories": {
"description": "Required for `category-page-view` events. Other event types should not set this field. The categories associated with a category page. Category pages include special pages such as sales or promotions. For instance, a special sale page may have the category hierarchy: categories : [\"Sales\", \"2017 Black Friday Deals\"].",
"description": "Required for `category-page-view` events. At least one of search_query or page_categories is required for `search` events. Other event types should not set this field. The categories associated with a category page. Category pages include special pages such as sales or promotions. For instance, a special sale page may have the category hierarchy: categories : [\"Sales\", \"2017 Black Friday Deals\"].",
"items": {
"$ref": "GoogleCloudRecommendationengineV1beta1CatalogItemCategoryHierarchy"
},
Expand All @@ -1722,7 +1722,7 @@
"description": "Optional. A transaction represents the entire purchase transaction. Required for `purchase-complete` events. Optional for `checkout-start` events. Other event types should not set this field."
},
"searchQuery": {
"description": "Required for `search` events. Other event types should not set this field. The user's search query as UTF-8 encoded text with a length limit of 5 KiB.",
"description": "At least one of search_query or page_categories is required for `search` events. Other event types should not set this field. The user's search query as UTF-8 encoded text with a length limit of 5 KiB.",
"type": "string"
}
},
Expand Down Expand Up @@ -2043,7 +2043,7 @@
}
},
"servicePath": "",
"title": "Recommendations AI",
"title": "Recommendations AI (Beta)",
"version": "v1beta1",
"version_module": true
}
2 changes: 1 addition & 1 deletion src/apis/recommendationengine/README.md
Expand Up @@ -2,7 +2,7 @@

# recommendationengine

> Recommendations AI service enables customers to build end-to-end personalized recommendation systems without requiring a high level of expertise in machine learning, recommendation system, or Google Cloud.
> Note that we now highly recommend new customers to use Retail API, which incorporates the GA version of the Recommendations AI funtionalities. To enable Retail API, please visit https://console.cloud.google.com/apis/library/retail.googleapis.com. The Recommendations AI service enables customers to build end-to-end personalized recommendation systems without requiring a high level of expertise in machine learning, recommendation system, or Google Cloud.
## Installation

Expand Down
10 changes: 5 additions & 5 deletions src/apis/recommendationengine/v1beta1.ts
Expand Up @@ -101,9 +101,9 @@ export namespace recommendationengine_v1beta1 {
}

/**
* Recommendations AI
* Recommendations AI (Beta)
*
* Recommendations AI service enables customers to build end-to-end personalized recommendation systems without requiring a high level of expertise in machine learning, recommendation system, or Google Cloud.
* Note that we now highly recommend new customers to use Retail API, which incorporates the GA version of the Recommendations AI funtionalities. To enable Retail API, please visit https://console.cloud.google.com/apis/library/retail.googleapis.com. The Recommendations AI service enables customers to build end-to-end personalized recommendation systems without requiring a high level of expertise in machine learning, recommendation system, or Google Cloud.
*
* @example
* ```js
Expand Down Expand Up @@ -769,7 +769,7 @@ export namespace recommendationengine_v1beta1 {
*/
listId?: string | null;
/**
* Required for `category-page-view` events. Other event types should not set this field. The categories associated with a category page. Category pages include special pages such as sales or promotions. For instance, a special sale page may have the category hierarchy: categories : ["Sales", "2017 Black Friday Deals"].
* Required for `category-page-view` events. At least one of search_query or page_categories is required for `search` events. Other event types should not set this field. The categories associated with a category page. Category pages include special pages such as sales or promotions. For instance, a special sale page may have the category hierarchy: categories : ["Sales", "2017 Black Friday Deals"].
*/
pageCategories?: Schema$GoogleCloudRecommendationengineV1beta1CatalogItemCategoryHierarchy[];
/**
Expand All @@ -781,7 +781,7 @@ export namespace recommendationengine_v1beta1 {
*/
purchaseTransaction?: Schema$GoogleCloudRecommendationengineV1beta1PurchaseTransaction;
/**
* Required for `search` events. Other event types should not set this field. The user's search query as UTF-8 encoded text with a length limit of 5 KiB.
* At least one of search_query or page_categories is required for `search` events. Other event types should not set this field. The user's search query as UTF-8 encoded text with a length limit of 5 KiB.
*/
searchQuery?: string | null;
}
Expand Down Expand Up @@ -2717,7 +2717,7 @@ export namespace recommendationengine_v1beta1 {
}

/**
* Makes a recommendation prediction. If using API Key based authentication, the API Key must be registered using the PredictionApiKeyRegistry service. [Learn more](/recommendations-ai/docs/setting-up#register-key).
* Makes a recommendation prediction. If using API Key based authentication, the API Key must be registered using the PredictionApiKeyRegistry service. [Learn more](https://cloud.google.com/recommendations-ai/docs/setting-up#register-key).
* @example
* ```js
* // Before running the sample:
Expand Down

0 comments on commit c8139c2

Please sign in to comment.