public interface ImportProductSetsGcsSourceOrBuilder extends MessageOrBuilder
Implements
MessageOrBuilderMethods
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.
- image-uri
- image-id
- product-set-id
- product-id
- product-category
- product-display-name
- labels
- bounding-poly
The
image-uri
,product-set-id
,product-id
, andproduct-category
columns are required. All other columns are optional. If theProductSet
orProduct
specified by theproduct-set-id
andproduct-id
values does not exist, then the system will create a newProductSet
orProduct
for the image. In this case, theproduct-display-name
column refers to display_name, theproduct-category
column refers to product_category, and thelabels
column refers to product_labels. Theimage-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. Theproduct-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 thedisplay_name
later by using the API. If aProduct
with the specifiedproduct-id
already exists, then the system ignores theproduct-display-name
,product-category
, andlabels
columns. Thelabels
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" Thebounding-poly
column (optional) identifies one region of interest from the image in the same manner asCreateReferenceImage
. If you do not specify thebounding-poly
column, then the system will try to detect regions of interest automatically. At most onebounding-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 thebounding-poly
values for each region of interest. Thebounding-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.
- image-uri
- image-id
- product-set-id
- product-id
- product-category
- product-display-name
- labels
- bounding-poly
The
image-uri
,product-set-id
,product-id
, andproduct-category
columns are required. All other columns are optional. If theProductSet
orProduct
specified by theproduct-set-id
andproduct-id
values does not exist, then the system will create a newProductSet
orProduct
for the image. In this case, theproduct-display-name
column refers to display_name, theproduct-category
column refers to product_category, and thelabels
column refers to product_labels. Theimage-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. Theproduct-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 thedisplay_name
later by using the API. If aProduct
with the specifiedproduct-id
already exists, then the system ignores theproduct-display-name
,product-category
, andlabels
columns. Thelabels
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" Thebounding-poly
column (optional) identifies one region of interest from the image in the same manner asCreateReferenceImage
. If you do not specify thebounding-poly
column, then the system will try to detect regions of interest automatically. At most onebounding-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 thebounding-poly
values for each region of interest. Thebounding-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. |