Interface ImportProductSetsGcsSourceOrBuilder (3.26.0)

Version 3.26.0

• 3.51.0 (latest)
• 3.50.0
• 3.49.0
• 3.47.0
• 3.46.0
• 3.45.0
• 3.44.0
• 3.43.0
• 3.42.0
• 3.41.0
• 3.40.0
• 3.39.0
• 3.38.0
• 3.37.0
• 3.35.0
• 3.34.0
• 3.33.0
• 3.32.0
• 3.31.0
• 3.30.0
• 3.29.0
• 3.28.0
• 3.27.0
• 3.26.0
• 3.25.0
• 3.22.0
• 3.21.0
• 3.20.0
• 3.19.0
• 3.18.0
• 3.17.0
• 3.16.0
• 3.15.0
• 3.14.0
• 3.13.0
• 3.12.0
• 3.11.0
• 3.10.0
• 3.9.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.0
• 3.3.0
• 3.2.0
• 3.1.3
• 2.1.4
• 2.0.29

public interface ImportProductSetsGcsSourceOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getCsvFileUri()

public abstract String getCsvFileUri()

The Google Cloud Storage URI of the input csv file.

The URI must start with gs://.

The format of the input csv file should be one image per line. In each line, there are 8 columns.

1. image-uri
2. image-id
3. product-set-id
4. product-id
5. product-category
6. product-display-name
7. labels

8. bounding-poly

   The image-uri, product-set-id, product-id, and product-category columns are required. All other columns are optional.

   If the ProductSet or Product specified by the product-set-id and product-id values does not exist, then the system will create a new ProductSet or Product for the image. In this case, the product-display-name column refers to display_name, the product-category column refers to product_category, and the labels column refers to product_labels.

   The image-id column is optional but must be unique if provided. If it is empty, the system will automatically assign a unique id to the image.

   The product-display-name column is optional. If it is empty, the system sets the display_name field for the product to a space (" "). You can update the display_name later by using the API.

   If a Product with the specified product-id already exists, then the system ignores the product-display-name, product-category, and labels columns.

   The labels column (optional) is a line containing a list of comma-separated key-value pairs, in the following format:

   "key_1=value_1,key_2=value_2,...,key_n=value_n"

   The bounding-poly column (optional) identifies one region of interest from the image in the same manner as CreateReferenceImage. If you do not specify the bounding-poly column, then the system will try to detect regions of interest automatically.

   At most one bounding-poly column is allowed per line. If the image contains multiple regions of interest, add a line to the CSV file that includes the same product information, and the bounding-poly values for each region of interest.

   The bounding-poly column must contain an even number of comma-separated numbers, in the format "p1_x,p1_y,p2_x,p2_y,...,pn_x,pn_y". Use non-negative integers for absolute bounding polygons, and float values in [0, 1] for normalized bounding polygons.

   The system will resize the image if the image resolution is too large to process (larger than 20MP).

string csv_file_uri = 1;

Returns
Type	Description
String	The csvFileUri.

getCsvFileUriBytes()

public abstract ByteString getCsvFileUriBytes()

The Google Cloud Storage URI of the input csv file.

The URI must start with gs://.

The format of the input csv file should be one image per line. In each line, there are 8 columns.

1. image-uri
2. image-id
3. product-set-id
4. product-id
5. product-category
6. product-display-name
7. labels

8. bounding-poly

   The image-uri, product-set-id, product-id, and product-category columns are required. All other columns are optional.

   If the ProductSet or Product specified by the product-set-id and product-id values does not exist, then the system will create a new ProductSet or Product for the image. In this case, the product-display-name column refers to display_name, the product-category column refers to product_category, and the labels column refers to product_labels.

   The image-id column is optional but must be unique if provided. If it is empty, the system will automatically assign a unique id to the image.

   The product-display-name column is optional. If it is empty, the system sets the display_name field for the product to a space (" "). You can update the display_name later by using the API.

   If a Product with the specified product-id already exists, then the system ignores the product-display-name, product-category, and labels columns.

   The labels column (optional) is a line containing a list of comma-separated key-value pairs, in the following format:

   "key_1=value_1,key_2=value_2,...,key_n=value_n"

   The bounding-poly column (optional) identifies one region of interest from the image in the same manner as CreateReferenceImage. If you do not specify the bounding-poly column, then the system will try to detect regions of interest automatically.

   At most one bounding-poly column is allowed per line. If the image contains multiple regions of interest, add a line to the CSV file that includes the same product information, and the bounding-poly values for each region of interest.

   The bounding-poly column must contain an even number of comma-separated numbers, in the format "p1_x,p1_y,p2_x,p2_y,...,pn_x,pn_y". Use non-negative integers for absolute bounding polygons, and float values in [0, 1] for normalized bounding polygons.

   The system will resize the image if the image resolution is too large to process (larger than 20MP).

string csv_file_uri = 1;

Returns
Type	Description
ByteString	The bytes for csvFileUri.