strique-proto-schema 32.0.4rc417__tar.gz → 32.1.0rc418__tar.gz

{strique_proto_schema-32.0.4rc417 → strique_proto_schema-32.1.0rc418}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: strique-proto-schema
-Version: 32.0.4rc417
+Version: 32.1.0rc418
 Summary: API contracts and Data Transfer Objects (DTO) in the form of Protocol Buffers for Strique binaries.
 Requires-Python: >=3.7
 Description-Content-Type: text/markdown

{strique_proto_schema-32.0.4rc417 → strique_proto_schema-32.1.0rc418}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "strique-proto-schema"
-version = "32.0.4-rc.417"
+version = "32.1.0-rc.418"
 readme = "README.md"
 description = "API contracts and Data Transfer Objects (DTO) in the form of Protocol Buffers for Strique binaries."
 requires-python = ">=3.7"

strique_proto_schema-32.1.0rc418/src/protos/ai/catalog/enhance_product.proto

@@ -0,0 +1,68 @@
+syntax = "proto3";
+
+package strique.model.ai.catalog;
+
+import "db/catalog/product.proto";
+import "types/filter_predicate/filters.proto";
+
+option java_outer_classname = "EnhanceProductProto";
+option java_package = "com.strique.model.ai.catalog";
+
+// Next Id: 5
+// Proto definition for the AI Catalog Enhancement Request.
+message EnhanceProductRequest {
+  // List of products to enhance.
+  repeated db.catalog.Product products = 1;
+
+  // Specifies which columns/fields should be updated during enhancement.
+  repeated string columns_to_update = 2;
+
+  // Specifies the enhancement mode.
+  Mode mode = 3;
+
+  // Specifies the enhancement style/approach.
+  EnhancementStyle enhancement_style = 4;
+}
+
+// Next Id: 2
+// Proto definition for the AI Catalog Enhancement Response.
+message EnhanceProductResponse {
+  // List of enhanced products with AI-generated content.
+  repeated db.catalog.Product enhanced_products = 1;
+}
+
+// Next Id: 6
+// Proto definition for the AI Catalog Enhancement Request.
+message BulkEnhanceProductRequest {
+  // List of products ids to enhance.
+  repeated string product_ids = 1;
+
+  // Specifies which columns/fields should be updated during enhancement.
+  repeated string columns_to_update = 2;
+
+  // Specifies the enhancement mode.
+  Mode mode = 3;
+
+  // Specifies the enhancement style/approach.
+  EnhancementStyle enhancement_style = 4;
+
+  // Specifies the platform id.
+  types.Expression filter_expression = 5;
+}
+
+// Next Id: 3
+// Enhancement mode specifies how products should be enhanced.
+enum Mode {
+  MODE_UNKNOWN = 0;
+  ENHANCE_ALL = 1;
+  UPDATE_ONLY_MISSING = 2;
+}
+
+// Next Id: 3
+// Enhancement style specifies the approach for content generation.
+enum EnhancementStyle {
+  ENHANCEMENT_STYLE_UNKNOWN = 0;
+  SEO_FRIENDLY = 1;
+  CONVERSION_FOCUSED = 2;
+}
+

{strique_proto_schema-32.0.4rc417 → strique_proto_schema-32.1.0rc418}/src/protos/constants/datasource/data_source.proto

@@ -5,10 +5,11 @@ package strique.constants;
 option java_outer_classname = "DataSourceProto";
 option java_package = "com.strique.constants.datasource";
 
-// Next Id : 3
+// Next Id : 4
 // Proto enum of data source.
 enum DataSource {
   DATA_SOURCE_UNKNOWN = 0;
   DATA_SOURCE_ECOMMERCE_PLATFORM = 1;
   DATA_SOURCE_STRIQUE = 2;
+  DATA_SOURCE_AI = 3;
 }

{strique_proto_schema-32.0.4rc417 → strique_proto_schema-32.1.0rc418}/src/protos/db/catalog/activity_request.proto

@@ -7,6 +7,7 @@ import "db/catalog/product_sets_request.proto";
 import "db/catalog/update_feed_product.proto";
 import "db/catalog/xmlfeed/xml_feed.proto";
 import "google/protobuf/timestamp.proto";
+import "ai/catalog/enhance_product.proto";
 
 option java_outer_classname = "ActivityRequestProto";
 option java_package = "com.strique.model.db.catalog";
@@ -67,7 +68,7 @@ enum TaskStatus {
   FAILED = 4;
 }
 
-// Next Id: 6
+// Next Id: 7
 // Enum for request type
 enum RequestType {
   REQUEST_TYPE_UNKNOWN = 0;
@@ -76,9 +77,10 @@ enum RequestType {
   ON_DEMAND_XML_FEED_UPDATE = 3;
   PRODUCT_SET_UPDATE = 4;
   RESOLVE_ERROR_FOR_ALL_PRODUCTS = 5;
+  BULK_ENHANCE_PRODUCT = 6;
 }
 
-// Next Id: 5
+// Next Id: 6
 // Message for requst body
 message RequestBody {
   oneof request_body {
@@ -86,5 +88,6 @@ message RequestBody {
     XmlFeed xml_feed = 2;
     ProductSetsUpdateRequest product_sets_update_request = 3;
     BulkUpdateFeedProductRequest bulk_update_feed_product_request = 4;
+    ai.catalog.BulkEnhanceProductRequest bulk_enhance_product_request = 5;
   }
 }

{strique_proto_schema-32.0.4rc417 → strique_proto_schema-32.1.0rc418}/src/protos/db/catalog/catalog_enums.proto

@@ -195,4 +195,104 @@ message MeasuringUnit {
     // other supported units
     SupportedUnits other = 3;
   }
+}
+
+// Next Id: 19
+// Proto definition for AI enhance columns
+enum AiEnhanceColumn {
+  COLUMN_UNKNOWN = 0 [
+    (options.label) = 'Unknown',
+    (options.accessor_key) = '',
+    (options.is_ai_enhanceable) = false
+  ];
+  COLUMN_ID = 1 [
+    (options.label) = 'ID',
+    (options.accessor_key) = 'productId',
+    (options.is_ai_enhanceable) = false
+  ];
+  COLUMN_TITLE = 2 [
+    (options.label) = 'Title',
+    (options.accessor_key) = 'title',
+    (options.is_ai_enhanceable) = true
+  ];
+  COLUMN_DESCRIPTION = 3 [
+    (options.label) = 'Description',
+    (options.accessor_key) = 'description',
+    (options.is_ai_enhanceable) = true
+  ];
+  COLUMN_PRODUCT_TYPE = 4 [
+    (options.label) = 'Product type',
+    (options.accessor_key) = 'productType',
+    (options.is_ai_enhanceable) = true
+  ];
+  COLUMN_BRAND = 5 [
+    (options.label) = 'Brand',
+    (options.accessor_key) = 'brand',
+    (options.is_ai_enhanceable) = true
+  ];
+  COLUMN_GOOGLE_PRODUCT_CATEGORY = 6 [
+    (options.label) = 'Google product category',
+    (options.accessor_key) = 'googleProductCategory',
+    (options.is_ai_enhanceable) = true
+  ];
+  COLUMN_FB_PRODUCT_CATEGORY = 7 [
+    (options.label) = 'Facebook product category',
+    (options.accessor_key) = 'fbProductCategory',
+    (options.is_ai_enhanceable) = true
+  ];
+  COLUMN_GENDER = 8 [
+    (options.label) = 'Gender',
+    (options.accessor_key) = 'gender',
+    (options.is_ai_enhanceable) = true
+  ];
+  COLUMN_COLOR = 9 [
+    (options.label) = 'Color',
+    (options.accessor_key) = 'color',
+    (options.is_ai_enhanceable) = true
+  ];
+  COLUMN_SIZE = 10 [
+    (options.label) = 'Size',
+    (options.accessor_key) = 'size',
+    (options.is_ai_enhanceable) = true
+  ];
+  COLUMN_AGE_GROUP = 11 [
+    (options.label) = 'Age group',
+    (options.accessor_key) = 'ageGroup',
+    (options.is_ai_enhanceable) = true
+  ];
+  COLUMN_MATERIAL = 12 [
+    (options.label) = 'Material',
+    (options.accessor_key) = 'material',
+    (options.is_ai_enhanceable) = true
+  ];
+  COLUMN_PATTERN = 13 [
+    (options.label) = 'Pattern',
+    (options.accessor_key) = 'pattern',
+    (options.is_ai_enhanceable) = true
+  ];
+  COLUMN_ADULT_ORIENTED_PRODUCT = 14 [
+    (options.label) = 'Adult-oriented product',
+    (options.accessor_key) = 'adult',
+    (options.is_ai_enhanceable) = true
+  ];
+  COLUMN_CONDITION = 15 [
+    (options.label) = 'Condition',
+    (options.accessor_key) = 'condition',
+    (options.is_ai_enhanceable) = true
+  ];
+  COLUMN_SIZE_SYSTEM = 16 [
+    (options.label) = 'Size system',
+    (options.accessor_key) = 'sizeSystem',
+    (options.is_ai_enhanceable) = true
+  ];
+  COLUMN_SIZE_TYPE = 17 [
+    (options.label) = 'Size type',
+    (options.accessor_key) = 'sizeType',
+    (options.is_ai_enhanceable) = true
+  ];
+  COLUMN_MULTIPACK = 18 [
+    (options.label) = 'Multipack',
+    (options.accessor_key) = 'multipack',
+    (options.is_ai_enhanceable) = true
+  ];
 }

strique_proto_schema-32.1.0rc418/src/protos/db/catalog/product.proto

@@ -0,0 +1,247 @@
+syntax = "proto3";
+
+package strique.model.db.catalog;
+
+import "constants/countries/country_short_code.proto";
+import "constants/datasource/data_source.proto";
+import "db/catalog/catalog_enums.proto";
+import "db/catalog/collection.proto";
+import "db/catalog/certification.proto";
+import "db/catalog/media_url.proto";
+import "db/catalog/sales_channel.proto";
+import "db/catalog/shipping.proto";
+import "db/catalog/product_variant.proto";
+import "google/protobuf/timestamp.proto";
+import "types/filter_predicate/filters.proto";
+
+option java_outer_classname = "ProductProto";
+option java_package = "com.strique.model.db.catalog";
+
+// Next Id: 2
+// Proto definition for Product list.
+message ProductList {
+  repeated Product product_response = 1;
+}
+
+// Next Id: 3
+// Proto definition for Bulk Product Update request.
+message BulkProductUpdateRequest {
+  Product product = 1;
+
+  types.Expression filter_expression = 2;
+}
+
+// Next Id: 75
+// Proto definition for Product Data.
+message Product {
+  // product id 
+  string product_id = 1 [json_name = "productId"];
+
+  // source of the data
+  optional constants.DataSource source = 2 [json_name = "source"];
+
+  // title of the product
+  optional string title = 3 [json_name = "title"];
+
+  // description of the product
+  optional string description = 4 [json_name = "description"];
+
+  // seo title of the product
+  optional string seo_title = 5 [json_name = "seoTitle"];
+
+  // seo description of the product
+  optional string seo_description = 6 [json_name = "seoDescription"];
+
+  // landing page on your website for that product
+  optional string product_link = 7 [json_name = "productLink"];
+
+  // Include the URL for your main product image
+  optional MediaUrl image_link = 8 [json_name = "imageLink"];
+
+  // more images for your product
+  repeated MediaUrl additional_image_link = 9 [json_name = "additionalImageLink"];
+  repeated MediaUrl excluded_additional_image_link = 10 [json_name = "excludedAdditionalImageLink"];
+
+  // The costs associated with the sale of a particular product
+  optional double cost_of_goods_sold = 11 [json_name = "costOfGoodsSold"];
+
+  // The date that your product should stop showing
+  optional string expiration_date = 12 [json_name = "expirationDate"];
+  
+  // The measure and dimension of your product as it is sold
+  optional MeasuredValue unit_pricing_measure = 14 [json_name = "unitPricingMeasure"];
+
+  // The product’s base measure for pricing
+  optional MeasuredValue unit_pricing_base_measure = 15 [json_name = "unitPricingBaseMeasure"];
+
+  // unit price for meta
+  optional MeasuredValue meta_unit_price = 67 [json_name = "metaUnitPrice"];
+
+  // Google-defined product category for your product
+  optional string google_product_category = 17 [json_name = "googleProductCategory"];
+
+  // facebook-defined product category for your product
+  optional string fb_product_category = 18 [json_name = "fbProductCategory"];
+
+  // Product category that you define for your product
+  optional string product_type = 19 [json_name = "productType"];
+
+  optional ProductStatus status = 20 [json_name = "status"];
+
+  // Your product’s brand name
+  optional string brand = 21 [json_name = "brand"];
+
+  // The condition of your product at time of sale
+  optional ProductCondition condition = 22 [json_name = "condition"];
+
+  // Indicate a product includes sexually suggestive content
+  optional bool adult = 23 [json_name = "adult"];
+
+  // The number of identical products sold within a merchant-defined multipack
+  optional int64 multipack = 24 [json_name = "multipack"];
+
+  // Indicates a product is a merchant-defined custom group of different products featuring one main product
+  optional bool is_bundle = 25 [json_name = "isBundle"];
+
+  // Certifications, such as energy efficiency ratings, associated with your product.
+  repeated Certification certifications = 26 [json_name = "certifications"];
+
+  // Your product’s energy label
+  optional EnergyEfficiencyClass energy_efficiency_class = 27 [json_name = "energyEfficiencyClass"];
+
+  // The demographic for which your product is intended
+  optional AgeGroup age_group = 28 [json_name = "ageGroup"];
+
+  // Your product’s color(s)
+  optional string color = 29 [json_name = "color"];
+
+  // The gender for which your product is intended
+  optional Gender gender = 30 [json_name = "gender"];
+
+  // Your product’s fabric or material
+  optional string material = 31 [json_name = "material"];
+
+  // Your product’s pattern or graphic print
+  optional string pattern = 32 [json_name = "pattern"];
+
+  // Your product’s size
+  optional string size = 33 [json_name = "size"];
+
+  // Your apparel product’s cut
+  optional SizeType size_type = 34 [json_name = "sizeType"];
+
+  // The country of the size system used by your product
+  optional SizeSystem size_system = 35 [json_name = "sizeSystem"];
+
+  // Your product's length
+  optional MeasuredValue product_length = 36 [json_name = "productLength"];
+
+  // Your product's width
+  optional MeasuredValue product_width = 37 [json_name = "productWidth"];
+
+  // Your product's height
+  optional MeasuredValue product_height = 38 [json_name = "productHeight"];
+
+  // Your product's weight
+  optional MeasuredValue product_weight = 39 [json_name = "productWeight"];
+
+  // The most relevant highlights of your products
+  repeated string product_highlight = 40 [json_name = "productHighlight"];
+  repeated string excluded_product_highlight = 41 [json_name = "excludedProductHighlight"];
+
+  // Label that you assign to a product to help organize bidding and reporting in Shopping campaigns
+  optional string custom_label_0 = 42 [json_name = "customLabel0"];
+  optional string custom_label_1 = 43 [json_name = "customLabel1"];
+  optional string custom_label_2 = 44 [json_name = "customLabel2"];
+  optional string custom_label_3 = 45 [json_name = "customLabel3"];
+  optional string custom_label_4 = 46 [json_name = "customLabel4"];
+
+  // An identifier that allows you to match products to promotions
+  repeated string promotion_id = 47 [json_name = "promotionId"];
+  repeated string excluded_promotion_id = 48 [json_name = "excludedPromotionId"];
+
+  // Your product's shipping cost, shipping speeds, and the locations your product ships to
+  repeated Shipping shipping = 63 [json_name = "shipping"];
+
+  // Label that you assign to a product to help assign correct shipping costs in Merchant Center account settings.
+  optional string shipping_label = 50 [json_name = "shippingLabel"];
+
+  // The weight of the product used to calculate the shipping cost
+  optional MeasuredValue shipping_weight = 51 [json_name = "shippingWeight"];
+
+  // The length of the product used to calculate the shipping cost by dimensional weight
+  optional MeasuredValue shipping_length = 52 [json_name = "shippingLength"];
+
+  // The width of the product used to calculate the shipping cost by dimensional weight
+  optional MeasuredValue shipping_width = 53 [json_name = "shippingWidth"];
+
+  // The height of the product used to calculate the shipping cost by dimensional weight
+  optional MeasuredValue shipping_height = 54 [json_name = "shippingHeight"];
+
+  optional constants.CountryShortCodes origin_country = 68 [json_name = "originCountry"];
+
+  // The maximum amount of time between when an order is placed for a product and when the product ships
+  optional uint64 max_handling_time = 56 [json_name = "maxHandlingTime"];
+  
+  repeated string tags = 57 [json_name = "tags"];
+  repeated string excluded_tags = 66 [json_name = "excludedTags"];
+  
+  repeated Collection collection_details = 58 [json_name = "collectionDetails"];
+  
+  repeated MediaUrl video_link = 59 [json_name = "videoLink"];
+  repeated MediaUrl excluded_video_link = 60 [json_name = "excludedVideoLink"];
+  
+  string platform_id = 61 [json_name = "platformId"];
+  
+  repeated ProductVariant variants = 62 [json_name = "variants"];
+
+  repeated SalesChannel sales_channel = 64 [json_name = "salesChannel"];
+
+  optional google.protobuf.Timestamp created_at = 65 [json_name = "createdAt"];
+
+  optional string importer_name = 69 [json_name = "importerName"];
+
+  optional string manufacturer_info = 70 [json_name = "manufacturerInfo"];
+
+  optional MetaImporterAddress importer_address = 71 [json_name = "importerAddress"] ;
+
+  optional string return_policy_label = 72 [json_name = "returnPolicyLabel"];
+
+  repeated ProductDestination product_destinations = 73 [json_name = "productDestinations"];
+
+  // List of field names that have been enhanced by AI.
+  repeated string enhanced_fields = 74 [json_name = "enhancedFields"];
+
+  reserved 49, 13, 16, 55;
+}
+
+// Next Id: 4
+// Proto definition for subscription.
+message SubscriptionCost {
+  SubscriptionPeriod period = 1;
+
+  int64 length = 2;
+
+  double amount = 3;
+}
+
+// Next Id: 7
+// Proto definition for importer address.
+message MetaImporterAddress {
+  string street1 = 1;
+  optional string street2 = 2;
+  string city = 3;
+  optional string region = 4;
+  optional string postal_code = 5;
+  constants.CountryShortCodes country = 6;
+}
+
+// Next Id: 3
+// Proto definition for update product request.
+message UpdateProductRequest {
+  // product to be updated
+  Product product = 1;
+
+  // source of the data (AI, STRIQUE, etc.)
+  constants.DataSource source = 2;
+}

{strique_proto_schema-32.0.4rc417 → strique_proto_schema-32.1.0rc418}/src/protos/options/strique_enum_options.proto

@@ -62,4 +62,7 @@ extend google.protobuf.EnumValueOptions {
 
   // Defines the platform type for which this enum value is applicable.
   optional strique.model.db.platform.PlatformType platform_type = 10012;
+
+  // Defines whether the column can be enhanced by AI.
+  optional bool is_ai_enhanceable = 10013;
 }

{strique_proto_schema-32.0.4rc417 → strique_proto_schema-32.1.0rc418}/src/protos/widget/catalog/manage_products.proto

@@ -38,7 +38,7 @@ message ManageProductsData {
   reserved 3;
 }
 
-// Next Id: 40
+// Next Id: 41
 // Proto definition for a single record of Catalog products Data.
 message ManageProductsRecord {
   string product_id = 1 [json_name = "productId"];
@@ -110,14 +110,16 @@ message ManageProductsRecord {
   optional string manufacturer_info = 38 [json_name = "manufacturerInfo"];
 
   repeated string product_errors = 39 [json_name = "productErrors"];
-  
+
+  // Indicates whether the product has been AI-enhanced.
+  optional bool is_ai_enhanced = 40 [json_name = "isAiEnhanced"];
   reserved 14, 27, 28, 30;
 }
 
 // Next Id: 3
 // Proto definition for Catalog products Data Configuration.
 message ManageProductsConfig {
-  // Next Id: 37
+  // Next Id: 38
   // Enumeration of possible columns in the Catalog products Data table.
   enum Column {
     COLUMN_UNKNOWN = 0 [
@@ -393,6 +395,14 @@ message ManageProductsConfig {
       (options.is_permanently_hidden) = true,
       (options.is_dropdown_not_support) = true
     ];
+    COLUMN_IS_AI_ENHANCED = 37 [
+      (options.label) = 'Is AI enhanced',
+      (options.accessor_key) = 'isAiEnhanced',
+      (options.is_sortable) = false,
+      (options.is_filterable) = true,
+      (options.is_permanently_hidden) = true,
+      (options.is_dropdown_not_support) = true
+    ];
     reserved 14;
   }
 
@@ -444,4 +454,4 @@ message RepeatedFieldsData {
 message ValueLabel {
   string value = 1;
   string label = 2;
-}
+}

{strique_proto_schema-32.0.4rc417 → strique_proto_schema-32.1.0rc418}/src/protos/widget/table_column_static_config.proto

@@ -28,7 +28,7 @@ message WidgetTableColumnStaticConfig {
   optional WidgetInfo widget_info = 3;
 }
 
-// Next Id: 11
+// Next Id: 12
 // Proto Definition for Table Column Static Config
 message TableColumnStaticConfig {
   // Label for a column in a human-readable format.
@@ -60,6 +60,9 @@ message TableColumnStaticConfig {
 
   // Platform type for which this column config is applicable.
   optional model.db.platform.PlatformType platform_type = 10;
+
+  // Defines whether the column can be enhanced by AI.
+  optional bool is_ai_enhanceable = 11;
 }
 
 // Next Id: 4

{strique_proto_schema-32.0.4rc417 → strique_proto_schema-32.1.0rc418}/src/protos/widget/widget_types.proto

@@ -7,7 +7,7 @@ import "options/strique_enum_options.proto";
 option java_outer_classname = "WidgetTypeProto";
 option java_package = "com.strique.model.widget";
 
-// Next Id: 155
+// Next Id: 156
 // Enumeration of possible widget types.
 enum WidgetType {
   WIDGET_TYPE_UNKNOWN = 0;
@@ -481,4 +481,7 @@ enum WidgetType {
   PRODUCT_ANALYTICS = 154 [
     (options.description) = 'Provides insights into product performance on different platforms, including views, add-to-carts, and purchases, helping you optimize your inventory and marketing strategies.'
   ];
+  CATALOG_AI_ENHANCE = 155 [
+    (options.description) = 'Enhances the catalog products with AI, helping you optimize your catalog and marketing strategies.'
+  ];
 }

{strique_proto_schema-32.0.4rc417 → strique_proto_schema-32.1.0rc418}/strique_proto_schema.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: strique-proto-schema
-Version: 32.0.4rc417
+Version: 32.1.0rc418
 Summary: API contracts and Data Transfer Objects (DTO) in the form of Protocol Buffers for Strique binaries.
 Requires-Python: >=3.7
 Description-Content-Type: text/markdown

{strique_proto_schema-32.0.4rc417 → strique_proto_schema-32.1.0rc418}/strique_proto_schema.egg-info/SOURCES.txt

@@ -2,6 +2,7 @@ MANIFEST.in
 README.md
 __init__.py
 pyproject.toml
+src/protos/ai/catalog/enhance_product.proto
 src/protos/ai/reporting/summary.proto
 src/protos/authz/policy.proto
 src/protos/authz/policy.textproto