Skip to content

Commit 3e3c695

Browse files
yoshi-automationyoshi-automation
committed
feat(retail): update the api
#### retail:v2 The following keys were added: - schemas.GoogleCloudRetailV2IntentClassificationConfig.properties.inlineSource.$ref (Total Keys: 1) - schemas.GoogleCloudRetailV2IntentClassificationConfigExample.properties.classifiedPositive.type (Total Keys: 1) - schemas.GoogleCloudRetailV2IntentClassificationConfigInlineForceIntent (Total Keys: 5) - schemas.GoogleCloudRetailV2IntentClassificationConfigInlineSource (Total Keys: 4) - schemas.GoogleCloudRetailV2SearchRequest.properties.userAttributes (Total Keys: 2) - schemas.GoogleCloudRetailV2StringList (Total Keys: 4) #### retail:v2alpha The following keys were added: - schemas.GoogleCloudRetailV2alphaIntentClassificationConfig.properties.inlineSource.$ref (Total Keys: 1) - schemas.GoogleCloudRetailV2alphaIntentClassificationConfigExample.properties.classifiedPositive.type (Total Keys: 1) - schemas.GoogleCloudRetailV2alphaIntentClassificationConfigInlineForceIntent (Total Keys: 5) - schemas.GoogleCloudRetailV2alphaIntentClassificationConfigInlineSource (Total Keys: 4) #### retail:v2beta The following keys were added: - schemas.GoogleCloudRetailV2betaIntentClassificationConfig.properties.inlineSource.$ref (Total Keys: 1) - schemas.GoogleCloudRetailV2betaIntentClassificationConfigExample.properties.classifiedPositive.type (Total Keys: 1) - schemas.GoogleCloudRetailV2betaIntentClassificationConfigInlineForceIntent (Total Keys: 5) - schemas.GoogleCloudRetailV2betaIntentClassificationConfigInlineSource (Total Keys: 4) - schemas.GoogleCloudRetailV2betaSearchRequest.properties.userAttributes (Total Keys: 2) - schemas.GoogleCloudRetailV2betaStringList (Total Keys: 4)
1 parent c0f8e8d commit 3e3c695

10 files changed

+316
-3
lines changed

‎docs/dyn/retail_v2.projects.locations.catalogs.html

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -455,11 +455,21 @@ <h3>Method Details</h3>
455455
],
456456
&quot;example&quot;: [ # Optional. A list of examples for intent classification.
457457
{ # An example for intent classification.
458+
&quot;classifiedPositive&quot;: True or False, # Required. Whether the example is classified positively.
458459
&quot;intentType&quot;: &quot;A String&quot;, # Optional. The intent_type must match one of the predefined intent types defined at https://cloud.google.com/retail/docs/reference/rpc/google.cloud.retail.v2alpha#querytype
459460
&quot;query&quot;: &quot;A String&quot;, # Required. Example query.
460461
&quot;reason&quot;: &quot;A String&quot;, # Optional. The reason for the intent classification. This is used to explain the intent classification decision.
461462
},
462463
],
464+
&quot;inlineSource&quot;: { # Inline source for intent classifications. # Optional. Inline source for intent classifications.
465+
&quot;inlineForceIntents&quot;: [ # Optional. A list of inline force intent classifications.
466+
{ # An inline force intent classification configuration.
467+
&quot;intentType&quot;: &quot;A String&quot;, # Optional. The intent_type must match one of the predefined intent types defined at https://cloud.google.com/retail/docs/reference/rpc/google.cloud.retail.v2alpha#querytype
468+
&quot;operation&quot;: &quot;A String&quot;, # Optional. The operation to perform for the query.
469+
&quot;query&quot;: &quot;A String&quot;, # Optional. A example query.
470+
},
471+
],
472+
},
463473
&quot;modelPreamble&quot;: &quot;A String&quot;, # Optional. Customers can use the preamble to specify any requirements for blocklisting intent classification. This preamble will be added to the blocklisting intent classification model prompt.
464474
},
465475
&quot;retailerDisplayName&quot;: &quot;A String&quot;, # Optional. The retailer&#x27;s display name that could be used in our LLM answers. Example - &quot;Google&quot;
@@ -887,11 +897,21 @@ <h3>Method Details</h3>
887897
],
888898
&quot;example&quot;: [ # Optional. A list of examples for intent classification.
889899
{ # An example for intent classification.
900+
&quot;classifiedPositive&quot;: True or False, # Required. Whether the example is classified positively.
890901
&quot;intentType&quot;: &quot;A String&quot;, # Optional. The intent_type must match one of the predefined intent types defined at https://cloud.google.com/retail/docs/reference/rpc/google.cloud.retail.v2alpha#querytype
891902
&quot;query&quot;: &quot;A String&quot;, # Required. Example query.
892903
&quot;reason&quot;: &quot;A String&quot;, # Optional. The reason for the intent classification. This is used to explain the intent classification decision.
893904
},
894905
],
906+
&quot;inlineSource&quot;: { # Inline source for intent classifications. # Optional. Inline source for intent classifications.
907+
&quot;inlineForceIntents&quot;: [ # Optional. A list of inline force intent classifications.
908+
{ # An inline force intent classification configuration.
909+
&quot;intentType&quot;: &quot;A String&quot;, # Optional. The intent_type must match one of the predefined intent types defined at https://cloud.google.com/retail/docs/reference/rpc/google.cloud.retail.v2alpha#querytype
910+
&quot;operation&quot;: &quot;A String&quot;, # Optional. The operation to perform for the query.
911+
&quot;query&quot;: &quot;A String&quot;, # Optional. A example query.
912+
},
913+
],
914+
},
895915
&quot;modelPreamble&quot;: &quot;A String&quot;, # Optional. Customers can use the preamble to specify any requirements for blocklisting intent classification. This preamble will be added to the blocklisting intent classification model prompt.
896916
},
897917
&quot;retailerDisplayName&quot;: &quot;A String&quot;, # Optional. The retailer&#x27;s display name that could be used in our LLM answers. Example - &quot;Google&quot;
@@ -917,11 +937,21 @@ <h3>Method Details</h3>
917937
],
918938
&quot;example&quot;: [ # Optional. A list of examples for intent classification.
919939
{ # An example for intent classification.
940+
&quot;classifiedPositive&quot;: True or False, # Required. Whether the example is classified positively.
920941
&quot;intentType&quot;: &quot;A String&quot;, # Optional. The intent_type must match one of the predefined intent types defined at https://cloud.google.com/retail/docs/reference/rpc/google.cloud.retail.v2alpha#querytype
921942
&quot;query&quot;: &quot;A String&quot;, # Required. Example query.
922943
&quot;reason&quot;: &quot;A String&quot;, # Optional. The reason for the intent classification. This is used to explain the intent classification decision.
923944
},
924945
],
946+
&quot;inlineSource&quot;: { # Inline source for intent classifications. # Optional. Inline source for intent classifications.
947+
&quot;inlineForceIntents&quot;: [ # Optional. A list of inline force intent classifications.
948+
{ # An inline force intent classification configuration.
949+
&quot;intentType&quot;: &quot;A String&quot;, # Optional. The intent_type must match one of the predefined intent types defined at https://cloud.google.com/retail/docs/reference/rpc/google.cloud.retail.v2alpha#querytype
950+
&quot;operation&quot;: &quot;A String&quot;, # Optional. The operation to perform for the query.
951+
&quot;query&quot;: &quot;A String&quot;, # Optional. A example query.
952+
},
953+
],
954+
},
925955
&quot;modelPreamble&quot;: &quot;A String&quot;, # Optional. Customers can use the preamble to specify any requirements for blocklisting intent classification. This preamble will be added to the blocklisting intent classification model prompt.
926956
},
927957
&quot;retailerDisplayName&quot;: &quot;A String&quot;, # Optional. The retailer&#x27;s display name that could be used in our LLM answers. Example - &quot;Google&quot;

‎docs/dyn/retail_v2.projects.locations.catalogs.placements.html

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -484,6 +484,13 @@ <h3>Method Details</h3>
484484
],
485485
&quot;tileNavigationRequested&quot;: True or False, # This field specifies whether the customer would like to request tile navigation.
486486
},
487+
&quot;userAttributes&quot;: { # Optional. The user attributes that could be used for personalization of search results. * Populate at most 100 key-value pairs per query. * Only supports string keys and repeated string values. * Duplcate keys are not allowed within a single query. Example: user_attributes: [ { key: &quot;pets&quot; value { values: &quot;dog&quot; values: &quot;cat&quot; } }, { key: &quot;state&quot; value { values: &quot;CA&quot; } } ]
488+
&quot;a_key&quot;: { # A list of string values.
489+
&quot;values&quot;: [ # String values.
490+
&quot;A String&quot;,
491+
],
492+
},
493+
},
487494
&quot;userInfo&quot;: { # Information of an end user. # User information.
488495
&quot;directUserRequest&quot;: True or False, # True if the request is made directly from the end user, in which case the ip_address and user_agent can be populated from the HTTP request. This flag should be set only if the API request is made directly from the end user such as a mobile app (and not if a gateway or a server is processing and pushing the user events). This should not be set when using the JavaScript tag in UserEventService.CollectUserEvent.
489496
&quot;ipAddress&quot;: &quot;A String&quot;, # The end user&#x27;s IP address. This field is used to extract location information for personalization. This field must be either an IPv4 address (e.g. &quot;104.133.9.80&quot;) or an IPv6 address (e.g. &quot;2001:0db8:85a3:0000:0000:8a2e:0370:7334&quot;). Otherwise, an INVALID_ARGUMENT error is returned. This should not be set when: * setting SearchRequest.user_info. * using the JavaScript tag in UserEventService.CollectUserEvent or if direct_user_request is set.

‎docs/dyn/retail_v2.projects.locations.catalogs.servingConfigs.html

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1035,6 +1035,13 @@ <h3>Method Details</h3>
10351035
],
10361036
&quot;tileNavigationRequested&quot;: True or False, # This field specifies whether the customer would like to request tile navigation.
10371037
},
1038+
&quot;userAttributes&quot;: { # Optional. The user attributes that could be used for personalization of search results. * Populate at most 100 key-value pairs per query. * Only supports string keys and repeated string values. * Duplcate keys are not allowed within a single query. Example: user_attributes: [ { key: &quot;pets&quot; value { values: &quot;dog&quot; values: &quot;cat&quot; } }, { key: &quot;state&quot; value { values: &quot;CA&quot; } } ]
1039+
&quot;a_key&quot;: { # A list of string values.
1040+
&quot;values&quot;: [ # String values.
1041+
&quot;A String&quot;,
1042+
],
1043+
},
1044+
},
10381045
&quot;userInfo&quot;: { # Information of an end user. # User information.
10391046
&quot;directUserRequest&quot;: True or False, # True if the request is made directly from the end user, in which case the ip_address and user_agent can be populated from the HTTP request. This flag should be set only if the API request is made directly from the end user such as a mobile app (and not if a gateway or a server is processing and pushing the user events). This should not be set when using the JavaScript tag in UserEventService.CollectUserEvent.
10401047
&quot;ipAddress&quot;: &quot;A String&quot;, # The end user&#x27;s IP address. This field is used to extract location information for personalization. This field must be either an IPv4 address (e.g. &quot;104.133.9.80&quot;) or an IPv6 address (e.g. &quot;2001:0db8:85a3:0000:0000:8a2e:0370:7334&quot;). Otherwise, an INVALID_ARGUMENT error is returned. This should not be set when: * setting SearchRequest.user_info. * using the JavaScript tag in UserEventService.CollectUserEvent or if direct_user_request is set.

‎docs/dyn/retail_v2alpha.projects.locations.catalogs.html

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -482,11 +482,21 @@ <h3>Method Details</h3>
482482
],
483483
&quot;example&quot;: [ # Optional. A list of examples for intent classification.
484484
{ # An example for intent classification.
485+
&quot;classifiedPositive&quot;: True or False, # Required. Whether the example is classified positively.
485486
&quot;intentType&quot;: &quot;A String&quot;, # Optional. The intent_type must match one of the predefined intent types defined at https://cloud.google.com/retail/docs/reference/rpc/google.cloud.retail.v2alpha#querytype
486487
&quot;query&quot;: &quot;A String&quot;, # Required. Example query.
487488
&quot;reason&quot;: &quot;A String&quot;, # Optional. The reason for the intent classification. This is used to explain the intent classification decision.
488489
},
489490
],
491+
&quot;inlineSource&quot;: { # Inline source for intent classifications. # Optional. Inline source for intent classifications.
492+
&quot;inlineForceIntents&quot;: [ # Optional. A list of inline force intent classifications.
493+
{ # An inline force intent classification configuration.
494+
&quot;intentType&quot;: &quot;A String&quot;, # Optional. The intent_type must match one of the predefined intent types defined at https://cloud.google.com/retail/docs/reference/rpc/google.cloud.retail.v2alpha#querytype
495+
&quot;operation&quot;: &quot;A String&quot;, # Optional. The operation to perform for the query.
496+
&quot;query&quot;: &quot;A String&quot;, # Optional. A example query.
497+
},
498+
],
499+
},
490500
&quot;modelPreamble&quot;: &quot;A String&quot;, # Optional. Customers can use the preamble to specify any requirements for blocklisting intent classification. This preamble will be added to the blocklisting intent classification model prompt.
491501
},
492502
&quot;retailerDisplayName&quot;: &quot;A String&quot;, # Optional. The retailer&#x27;s display name that could be used in our LLM answers. Example - &quot;Google&quot;
@@ -976,11 +986,21 @@ <h3>Method Details</h3>
976986
],
977987
&quot;example&quot;: [ # Optional. A list of examples for intent classification.
978988
{ # An example for intent classification.
989+
&quot;classifiedPositive&quot;: True or False, # Required. Whether the example is classified positively.
979990
&quot;intentType&quot;: &quot;A String&quot;, # Optional. The intent_type must match one of the predefined intent types defined at https://cloud.google.com/retail/docs/reference/rpc/google.cloud.retail.v2alpha#querytype
980991
&quot;query&quot;: &quot;A String&quot;, # Required. Example query.
981992
&quot;reason&quot;: &quot;A String&quot;, # Optional. The reason for the intent classification. This is used to explain the intent classification decision.
982993
},
983994
],
995+
&quot;inlineSource&quot;: { # Inline source for intent classifications. # Optional. Inline source for intent classifications.
996+
&quot;inlineForceIntents&quot;: [ # Optional. A list of inline force intent classifications.
997+
{ # An inline force intent classification configuration.
998+
&quot;intentType&quot;: &quot;A String&quot;, # Optional. The intent_type must match one of the predefined intent types defined at https://cloud.google.com/retail/docs/reference/rpc/google.cloud.retail.v2alpha#querytype
999+
&quot;operation&quot;: &quot;A String&quot;, # Optional. The operation to perform for the query.
1000+
&quot;query&quot;: &quot;A String&quot;, # Optional. A example query.
1001+
},
1002+
],
1003+
},
9841004
&quot;modelPreamble&quot;: &quot;A String&quot;, # Optional. Customers can use the preamble to specify any requirements for blocklisting intent classification. This preamble will be added to the blocklisting intent classification model prompt.
9851005
},
9861006
&quot;retailerDisplayName&quot;: &quot;A String&quot;, # Optional. The retailer&#x27;s display name that could be used in our LLM answers. Example - &quot;Google&quot;
@@ -1006,11 +1026,21 @@ <h3>Method Details</h3>
10061026
],
10071027
&quot;example&quot;: [ # Optional. A list of examples for intent classification.
10081028
{ # An example for intent classification.
1029+
&quot;classifiedPositive&quot;: True or False, # Required. Whether the example is classified positively.
10091030
&quot;intentType&quot;: &quot;A String&quot;, # Optional. The intent_type must match one of the predefined intent types defined at https://cloud.google.com/retail/docs/reference/rpc/google.cloud.retail.v2alpha#querytype
10101031
&quot;query&quot;: &quot;A String&quot;, # Required. Example query.
10111032
&quot;reason&quot;: &quot;A String&quot;, # Optional. The reason for the intent classification. This is used to explain the intent classification decision.
10121033
},
10131034
],
1035+
&quot;inlineSource&quot;: { # Inline source for intent classifications. # Optional. Inline source for intent classifications.
1036+
&quot;inlineForceIntents&quot;: [ # Optional. A list of inline force intent classifications.
1037+
{ # An inline force intent classification configuration.
1038+
&quot;intentType&quot;: &quot;A String&quot;, # Optional. The intent_type must match one of the predefined intent types defined at https://cloud.google.com/retail/docs/reference/rpc/google.cloud.retail.v2alpha#querytype
1039+
&quot;operation&quot;: &quot;A String&quot;, # Optional. The operation to perform for the query.
1040+
&quot;query&quot;: &quot;A String&quot;, # Optional. A example query.
1041+
},
1042+
],
1043+
},
10141044
&quot;modelPreamble&quot;: &quot;A String&quot;, # Optional. Customers can use the preamble to specify any requirements for blocklisting intent classification. This preamble will be added to the blocklisting intent classification model prompt.
10151045
},
10161046
&quot;retailerDisplayName&quot;: &quot;A String&quot;, # Optional. The retailer&#x27;s display name that could be used in our LLM answers. Example - &quot;Google&quot;

0 commit comments

Comments
 (0)