docs: expand documentation on product descriptions (#387)

googleapis · May 28, 2019 · 45e6ecc · 45e6ecc
1 parent e757123
commit 45e6ecc
Show file tree

Hide file tree

Showing 9 changed files with 43 additions and 23 deletions.
diff --git a/packages/google-cloud-vision/protos/google/cloud/vision/v1/product_search.proto b/packages/google-cloud-vision/protos/google/cloud/vision/v1/product_search.proto
@@ -45,7 +45,10 @@ message ProductSearchParams {
   // The list of product categories to search in. Currently, we only consider
   // the first category, and either "homegoods-v2", "apparel-v2", or "toys-v2"
   // should be specified. The legacy categories "homegoods", "apparel", and
-  // "toys" are still supported, but these should not be used for new products.
+  // "toys" are still supported but will be deprecated. For new products, please
+  // use "homegoods-v2", "apparel-v2", or "toys-v2" for better product search
+  // accuracy. It is recommended to migrate existing products to these
+  // categories as well.
   repeated string product_categories = 7;
 
   // The filtering expression. This can be used to restrict search results based

diff --git a/packages/google-cloud-vision/protos/google/cloud/vision/v1/product_search_service.proto b/packages/google-cloud-vision/protos/google/cloud/vision/v1/product_search_service.proto
@@ -338,8 +338,10 @@ message Product {
 
   // The category for the product identified by the reference image. This should
   // be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories
-  // "homegoods", "apparel", and "toys" are still supported, but these should
-  // not be used for new products.
+  // "homegoods", "apparel", and "toys" are still supported but will be
+  // deprecated. For new products, please use "homegoods-v2", "apparel-v2", or
+  // "toys-v2" for better product search accuracy. It is recommended to migrate
+  // existing products to these categories as well.
   //
   // This field is immutable.
   string product_category = 4;

diff --git a/packages/google-cloud-vision/protos/google/cloud/vision/v1p4beta1/product_search.proto b/packages/google-cloud-vision/protos/google/cloud/vision/v1p4beta1/product_search.proto
@@ -45,9 +45,11 @@ message ProductSearchParams {
 
   // The list of product categories to search in. Currently, we only consider
   // the first category, and either "homegoods-v2", "apparel-v2", "toys-v2", or
-  // "packagedgoods" should be specified. The legacy categories "homegoods",
-  // "apparel", and "toys" are still supported, but these should not be used for
-  // new products.
+  // "packagedgoods-v1" should be specified. The legacy categories "homegoods",
+  // "apparel", and "toys" are still supported but will be deprecated. For new
+  // products, please use "homegoods-v2", "apparel-v2", or "toys-v2" for better
+  // product search accuracy. It is recommended to migrate existing products to
+  // these categories as well.
   repeated string product_categories = 7;
 
   // The filtering expression. This can be used to restrict search results based

diff --git a/...ges/google-cloud-vision/protos/google/cloud/vision/v1p4beta1/product_search_service.proto b/...ges/google-cloud-vision/protos/google/cloud/vision/v1p4beta1/product_search_service.proto
@@ -355,9 +355,12 @@ message Product {
   string description = 3;
 
   // The category for the product identified by the reference image. This should
-  // be either "homegoods-v2", "apparel-v2", "toys-v2", or "packagedgoods". The
-  // legacy categories "homegoods", "apparel", and "toys" are still supported,
-  // but these should not be used for new products.
+  // be either "homegoods-v2", "apparel-v2", "toys-v2", or "packagedgoods-v1".
+  // The legacy categories "homegoods", "apparel", and "toys" are still
+  // supported but will be deprecated. For new products, please use
+  // "homegoods-v2", "apparel-v2", or "toys-v2" for better product search
+  // accuracy. It is recommended to migrate existing products to these
+  // categories as well.
   //
   // This field is immutable.
   string product_category = 4;

diff --git a/packages/google-cloud-vision/src/v1/doc/google/cloud/vision/v1/doc_product_search.js b/packages/google-cloud-vision/src/v1/doc/google/cloud/vision/v1/doc_product_search.js
@@ -35,7 +35,10 @@
  *   The list of product categories to search in. Currently, we only consider
  *   the first category, and either "homegoods-v2", "apparel-v2", or "toys-v2"
  *   should be specified. The legacy categories "homegoods", "apparel", and
- *   "toys" are still supported, but these should not be used for new products.
+ *   "toys" are still supported but will be deprecated. For new products, please
+ *   use "homegoods-v2", "apparel-v2", or "toys-v2" for better product search
+ *   accuracy. It is recommended to migrate existing products to these
+ *   categories as well.
  *
  * @property {string} filter
  *   The filtering expression. This can be used to restrict search results based

diff --git a/packages/google-cloud-vision/src/v1/doc/google/cloud/vision/v1/doc_product_search_service.js b/packages/google-cloud-vision/src/v1/doc/google/cloud/vision/v1/doc_product_search_service.js
@@ -37,8 +37,10 @@
  * @property {string} productCategory
  *   The category for the product identified by the reference image. This should
  *   be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories
- *   "homegoods", "apparel", and "toys" are still supported, but these should
- *   not be used for new products.
+ *   "homegoods", "apparel", and "toys" are still supported but will be
+ *   deprecated. For new products, please use "homegoods-v2", "apparel-v2", or
+ *   "toys-v2" for better product search accuracy. It is recommended to migrate
+ *   existing products to these categories as well.
  *
  *   This field is immutable.
  *

diff --git a/...google-cloud-vision/src/v1p4beta1/doc/google/cloud/vision/v1p4beta1/doc_product_search.js b/...google-cloud-vision/src/v1p4beta1/doc/google/cloud/vision/v1p4beta1/doc_product_search.js
@@ -35,9 +35,11 @@
  * @property {string[]} productCategories
  *   The list of product categories to search in. Currently, we only consider
  *   the first category, and either "homegoods-v2", "apparel-v2", "toys-v2", or
- *   "packagedgoods" should be specified. The legacy categories "homegoods",
- *   "apparel", and "toys" are still supported, but these should not be used for
- *   new products.
+ *   "packagedgoods-v1" should be specified. The legacy categories "homegoods",
+ *   "apparel", and "toys" are still supported but will be deprecated. For new
+ *   products, please use "homegoods-v2", "apparel-v2", or "toys-v2" for better
+ *   product search accuracy. It is recommended to migrate existing products to
+ *   these categories as well.
  *
  * @property {string} filter
  *   The filtering expression. This can be used to restrict search results based

diff --git a/...loud-vision/src/v1p4beta1/doc/google/cloud/vision/v1p4beta1/doc_product_search_service.js b/...loud-vision/src/v1p4beta1/doc/google/cloud/vision/v1p4beta1/doc_product_search_service.js
@@ -36,9 +36,12 @@
  *
  * @property {string} productCategory
  *   The category for the product identified by the reference image. This should
- *   be either "homegoods-v2", "apparel-v2", "toys-v2", or "packagedgoods". The
- *   legacy categories "homegoods", "apparel", and "toys" are still supported,
- *   but these should not be used for new products.
+ *   be either "homegoods-v2", "apparel-v2", "toys-v2", or "packagedgoods-v1".
+ *   The legacy categories "homegoods", "apparel", and "toys" are still
+ *   supported but will be deprecated. For new products, please use
+ *   "homegoods-v2", "apparel-v2", or "toys-v2" for better product search
+ *   accuracy. It is recommended to migrate existing products to these
+ *   categories as well.
  *
  *   This field is immutable.
  *

diff --git a/packages/google-cloud-vision/synth.metadata b/packages/google-cloud-vision/synth.metadata
@@ -1,19 +1,19 @@
 {
-  "updateTime": "2019-05-21T11:30:34.000955Z",
+  "updateTime": "2019-05-25T11:24:39.958552Z",
   "sources": [
     {
       "generator": {
         "name": "artman",
-        "version": "0.20.0",
-        "dockerImage": "googleapis/artman@sha256:3246adac900f4bdbd62920e80de2e5877380e44036b3feae13667ec255ebf5ec"
+        "version": "0.21.0",
+        "dockerImage": "googleapis/artman@sha256:28d4271586772b275cd3bc95cb46bd227a24d3c9048de45dccdb7f3afb0bfba9"
       }
     },
     {
       "git": {
         "name": "googleapis",
         "remote": "https://github.com/googleapis/googleapis.git",
-        "sha": "32a10f69e2c9ce15bba13ab1ff928bacebb25160",
-        "internalRef": "249058354"
+        "sha": "7ca19138ccebe219a67be2245200e821b3e32123",
+        "internalRef": "249916728"
       }
     },
     {