Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
feat(retail): update the api
#### retail:v2alpha

The following keys were added:
- resources.projects.resources.locations.resources.catalogs.methods.completeQuery.parameters.enableAttributeSuggestions (Total Keys: 2)
- schemas.GoogleCloudRetailV2alphaCompleteQueryResponse.properties.attributeResults (Total Keys: 2)
- schemas.GoogleCloudRetailV2alphaCompleteQueryResponseAttributeResult (Total Keys: 4)
  • Loading branch information
yoshi-automation committed Nov 1, 2022
1 parent 15a8fe0 commit 606bdc2
Show file tree
Hide file tree
Showing 12 changed files with 69 additions and 35 deletions.
Expand Up @@ -108,7 +108,7 @@ <h3>Method Details</h3>
},
&quot;pageSize&quot;: 42, # Maximum number of results to return. Set this property to the number of prediction results needed. If zero, the service will choose a reasonable default. The maximum allowed value is 100. Values above 100 will be coerced to 100.
&quot;pageToken&quot;: &quot;A String&quot;, # This field is not used; leave it unset.
&quot;params&quot;: { # Additional domain specific parameters for the predictions. Allowed values: * `returnProduct`: Boolean. If set to true, the associated product object will be returned in the `results.metadata` field in the prediction response. * `returnScore`: Boolean. If set to true, the prediction &#x27;score&#x27; corresponding to each returned product will be set in the `results.metadata` field in the prediction response. The given &#x27;score&#x27; indicates the probability of an product being clicked/purchased given the user&#x27;s context and history. * `strictFiltering`: Boolean. True by default. If set to false, the service will return generic (unfiltered) popular products instead of empty if your filter blocks all prediction results. * `priceRerankLevel`: String. Default empty. If set to be non-empty, then it needs to be one of {&#x27;no-price-reranking&#x27;, &#x27;low-price-reranking&#x27;, &#x27;medium-price-reranking&#x27;, &#x27;high-price-reranking&#x27;}. This gives request-level control and adjusts prediction results based on product price. * `diversityLevel`: String. Default empty. If set to be non-empty, then it needs to be one of {&#x27;no-diversity&#x27;, &#x27;low-diversity&#x27;, &#x27;medium-diversity&#x27;, &#x27;high-diversity&#x27;, &#x27;auto-diversity&#x27;}. This gives request-level control and adjusts prediction results based on product category. * `filterSyntaxV2`: Boolean. False by default. If set to true, the `filter` field is interpreteted according to the new, attribute-based syntax.
&quot;params&quot;: { # Additional domain specific parameters for the predictions. Allowed values: * `returnProduct`: Boolean. If set to true, the associated product object will be returned in the `results.metadata` field in the prediction response. * `returnScore`: Boolean. If set to true, the prediction &#x27;score&#x27; corresponding to each returned product will be set in the `results.metadata` field in the prediction response. The given &#x27;score&#x27; indicates the probability of a product being clicked/purchased given the user&#x27;s context and history. * `strictFiltering`: Boolean. True by default. If set to false, the service will return generic (unfiltered) popular products instead of empty if your filter blocks all prediction results. * `priceRerankLevel`: String. Default empty. If set to be non-empty, then it needs to be one of {&#x27;no-price-reranking&#x27;, &#x27;low-price-reranking&#x27;, &#x27;medium-price-reranking&#x27;, &#x27;high-price-reranking&#x27;}. This gives request-level control and adjusts prediction results based on product price. * `diversityLevel`: String. Default empty. If set to be non-empty, then it needs to be one of {&#x27;no-diversity&#x27;, &#x27;low-diversity&#x27;, &#x27;medium-diversity&#x27;, &#x27;high-diversity&#x27;, &#x27;auto-diversity&#x27;}. This gives request-level control and adjusts prediction results based on product category. * `filterSyntaxV2`: Boolean. False by default. If set to true, the `filter` field is interpreteted according to the new, attribute-based syntax.
&quot;a_key&quot;: &quot;&quot;,
},
&quot;userEvent&quot;: { # UserEvent captures all metadata information Retail API needs to know about how end users interact with customers&#x27; website. # Required. Context about the user, what they are looking at and what action they took to trigger the predict request. Note that this user event detail won&#x27;t be ingested to userEvent logs. Thus, a separate userEvent write request is required for event logging. Don&#x27;t set UserEvent.visitor_id or UserInfo.user_id to the same fixed ID for different users. If you are trying to receive non-personalized recommendations (not recommended; this can negatively impact model performance), instead set UserEvent.visitor_id to a random unique ID and leave UserInfo.user_id unset.
Expand Down Expand Up @@ -413,7 +413,7 @@ <h3>Method Details</h3>
],
&quot;returnMinMax&quot;: True or False, # Returns the min and max value for each numerical facet intervals. Ignored for textual facets.
},
&quot;limit&quot;: 42, # Maximum of facet values that should be returned for this facet. If unspecified, defaults to 20. The maximum allowed value is 300. Values above 300 will be coerced to 300. If this field is negative, an INVALID_ARGUMENT is returned.
&quot;limit&quot;: 42, # Maximum of facet values that should be returned for this facet. If unspecified, defaults to 50. The maximum allowed value is 300. Values above 300 will be coerced to 300. If this field is negative, an INVALID_ARGUMENT is returned.
},
],
&quot;filter&quot;: &quot;A String&quot;, # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the products being filtered. Filter expression is case-sensitive. See more details at this [user guide](https://cloud.google.com/retail/docs/filter-and-order#filter). If this field is unrecognizable, an INVALID_ARGUMENT is returned.
Expand Down
Expand Up @@ -583,7 +583,7 @@ <h3>Method Details</h3>
},
&quot;pageSize&quot;: 42, # Maximum number of results to return. Set this property to the number of prediction results needed. If zero, the service will choose a reasonable default. The maximum allowed value is 100. Values above 100 will be coerced to 100.
&quot;pageToken&quot;: &quot;A String&quot;, # This field is not used; leave it unset.
&quot;params&quot;: { # Additional domain specific parameters for the predictions. Allowed values: * `returnProduct`: Boolean. If set to true, the associated product object will be returned in the `results.metadata` field in the prediction response. * `returnScore`: Boolean. If set to true, the prediction &#x27;score&#x27; corresponding to each returned product will be set in the `results.metadata` field in the prediction response. The given &#x27;score&#x27; indicates the probability of an product being clicked/purchased given the user&#x27;s context and history. * `strictFiltering`: Boolean. True by default. If set to false, the service will return generic (unfiltered) popular products instead of empty if your filter blocks all prediction results. * `priceRerankLevel`: String. Default empty. If set to be non-empty, then it needs to be one of {&#x27;no-price-reranking&#x27;, &#x27;low-price-reranking&#x27;, &#x27;medium-price-reranking&#x27;, &#x27;high-price-reranking&#x27;}. This gives request-level control and adjusts prediction results based on product price. * `diversityLevel`: String. Default empty. If set to be non-empty, then it needs to be one of {&#x27;no-diversity&#x27;, &#x27;low-diversity&#x27;, &#x27;medium-diversity&#x27;, &#x27;high-diversity&#x27;, &#x27;auto-diversity&#x27;}. This gives request-level control and adjusts prediction results based on product category. * `filterSyntaxV2`: Boolean. False by default. If set to true, the `filter` field is interpreteted according to the new, attribute-based syntax.
&quot;params&quot;: { # Additional domain specific parameters for the predictions. Allowed values: * `returnProduct`: Boolean. If set to true, the associated product object will be returned in the `results.metadata` field in the prediction response. * `returnScore`: Boolean. If set to true, the prediction &#x27;score&#x27; corresponding to each returned product will be set in the `results.metadata` field in the prediction response. The given &#x27;score&#x27; indicates the probability of a product being clicked/purchased given the user&#x27;s context and history. * `strictFiltering`: Boolean. True by default. If set to false, the service will return generic (unfiltered) popular products instead of empty if your filter blocks all prediction results. * `priceRerankLevel`: String. Default empty. If set to be non-empty, then it needs to be one of {&#x27;no-price-reranking&#x27;, &#x27;low-price-reranking&#x27;, &#x27;medium-price-reranking&#x27;, &#x27;high-price-reranking&#x27;}. This gives request-level control and adjusts prediction results based on product price. * `diversityLevel`: String. Default empty. If set to be non-empty, then it needs to be one of {&#x27;no-diversity&#x27;, &#x27;low-diversity&#x27;, &#x27;medium-diversity&#x27;, &#x27;high-diversity&#x27;, &#x27;auto-diversity&#x27;}. This gives request-level control and adjusts prediction results based on product category. * `filterSyntaxV2`: Boolean. False by default. If set to true, the `filter` field is interpreteted according to the new, attribute-based syntax.
&quot;a_key&quot;: &quot;&quot;,
},
&quot;userEvent&quot;: { # UserEvent captures all metadata information Retail API needs to know about how end users interact with customers&#x27; website. # Required. Context about the user, what they are looking at and what action they took to trigger the predict request. Note that this user event detail won&#x27;t be ingested to userEvent logs. Thus, a separate userEvent write request is required for event logging. Don&#x27;t set UserEvent.visitor_id or UserInfo.user_id to the same fixed ID for different users. If you are trying to receive non-personalized recommendations (not recommended; this can negatively impact model performance), instead set UserEvent.visitor_id to a random unique ID and leave UserInfo.user_id unset.
Expand Down Expand Up @@ -956,7 +956,7 @@ <h3>Method Details</h3>
],
&quot;returnMinMax&quot;: True or False, # Returns the min and max value for each numerical facet intervals. Ignored for textual facets.
},
&quot;limit&quot;: 42, # Maximum of facet values that should be returned for this facet. If unspecified, defaults to 20. The maximum allowed value is 300. Values above 300 will be coerced to 300. If this field is negative, an INVALID_ARGUMENT is returned.
&quot;limit&quot;: 42, # Maximum of facet values that should be returned for this facet. If unspecified, defaults to 50. The maximum allowed value is 300. Values above 300 will be coerced to 300. If this field is negative, an INVALID_ARGUMENT is returned.
},
],
&quot;filter&quot;: &quot;A String&quot;, # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the products being filtered. Filter expression is case-sensitive. See more details at this [user guide](https://cloud.google.com/retail/docs/filter-and-order#filter). If this field is unrecognizable, an INVALID_ARGUMENT is returned.
Expand Down
Expand Up @@ -144,7 +144,7 @@ <h3>Method Details</h3>
],
&quot;returnMinMax&quot;: True or False, # Returns the min and max value for each numerical facet intervals. Ignored for textual facets.
},
&quot;limit&quot;: 42, # Maximum of facet values that should be returned for this facet. If unspecified, defaults to 20. The maximum allowed value is 300. Values above 300 will be coerced to 300. If this field is negative, an INVALID_ARGUMENT is returned.
&quot;limit&quot;: 42, # Maximum of facet values that should be returned for this facet. If unspecified, defaults to 50. The maximum allowed value is 300. Values above 300 will be coerced to 300. If this field is negative, an INVALID_ARGUMENT is returned.
},
&quot;name&quot;: &quot;A String&quot;, # Immutable. Fully qualified name `projects/*/locations/global/catalogs/*/controls/*`
&quot;rule&quot;: { # A rule is a condition-action pair * A condition defines when a rule is to be triggered. * An action specifies what occurs on that trigger. Currently rules only work for controls with SOLUTION_TYPE_SEARCH. # A rule control - a condition-action pair. Enacts a set action when the condition is triggered. For example: Boost &quot;gShoe&quot; when query full matches &quot;Running Shoes&quot;.
Expand Down Expand Up @@ -263,7 +263,7 @@ <h3>Method Details</h3>
],
&quot;returnMinMax&quot;: True or False, # Returns the min and max value for each numerical facet intervals. Ignored for textual facets.
},
&quot;limit&quot;: 42, # Maximum of facet values that should be returned for this facet. If unspecified, defaults to 20. The maximum allowed value is 300. Values above 300 will be coerced to 300. If this field is negative, an INVALID_ARGUMENT is returned.
&quot;limit&quot;: 42, # Maximum of facet values that should be returned for this facet. If unspecified, defaults to 50. The maximum allowed value is 300. Values above 300 will be coerced to 300. If this field is negative, an INVALID_ARGUMENT is returned.
},
&quot;name&quot;: &quot;A String&quot;, # Immutable. Fully qualified name `projects/*/locations/global/catalogs/*/controls/*`
&quot;rule&quot;: { # A rule is a condition-action pair * A condition defines when a rule is to be triggered. * An action specifies what occurs on that trigger. Currently rules only work for controls with SOLUTION_TYPE_SEARCH. # A rule control - a condition-action pair. Enacts a set action when the condition is triggered. For example: Boost &quot;gShoe&quot; when query full matches &quot;Running Shoes&quot;.
Expand Down Expand Up @@ -406,7 +406,7 @@ <h3>Method Details</h3>
],
&quot;returnMinMax&quot;: True or False, # Returns the min and max value for each numerical facet intervals. Ignored for textual facets.
},
&quot;limit&quot;: 42, # Maximum of facet values that should be returned for this facet. If unspecified, defaults to 20. The maximum allowed value is 300. Values above 300 will be coerced to 300. If this field is negative, an INVALID_ARGUMENT is returned.
&quot;limit&quot;: 42, # Maximum of facet values that should be returned for this facet. If unspecified, defaults to 50. The maximum allowed value is 300. Values above 300 will be coerced to 300. If this field is negative, an INVALID_ARGUMENT is returned.
},
&quot;name&quot;: &quot;A String&quot;, # Immutable. Fully qualified name `projects/*/locations/global/catalogs/*/controls/*`
&quot;rule&quot;: { # A rule is a condition-action pair * A condition defines when a rule is to be triggered. * An action specifies what occurs on that trigger. Currently rules only work for controls with SOLUTION_TYPE_SEARCH. # A rule control - a condition-action pair. Enacts a set action when the condition is triggered. For example: Boost &quot;gShoe&quot; when query full matches &quot;Running Shoes&quot;.
Expand Down Expand Up @@ -536,7 +536,7 @@ <h3>Method Details</h3>
],
&quot;returnMinMax&quot;: True or False, # Returns the min and max value for each numerical facet intervals. Ignored for textual facets.
},
&quot;limit&quot;: 42, # Maximum of facet values that should be returned for this facet. If unspecified, defaults to 20. The maximum allowed value is 300. Values above 300 will be coerced to 300. If this field is negative, an INVALID_ARGUMENT is returned.
&quot;limit&quot;: 42, # Maximum of facet values that should be returned for this facet. If unspecified, defaults to 50. The maximum allowed value is 300. Values above 300 will be coerced to 300. If this field is negative, an INVALID_ARGUMENT is returned.
},
&quot;name&quot;: &quot;A String&quot;, # Immutable. Fully qualified name `projects/*/locations/global/catalogs/*/controls/*`
&quot;rule&quot;: { # A rule is a condition-action pair * A condition defines when a rule is to be triggered. * An action specifies what occurs on that trigger. Currently rules only work for controls with SOLUTION_TYPE_SEARCH. # A rule control - a condition-action pair. Enacts a set action when the condition is triggered. For example: Boost &quot;gShoe&quot; when query full matches &quot;Running Shoes&quot;.
Expand Down Expand Up @@ -673,7 +673,7 @@ <h3>Method Details</h3>
],
&quot;returnMinMax&quot;: True or False, # Returns the min and max value for each numerical facet intervals. Ignored for textual facets.
},
&quot;limit&quot;: 42, # Maximum of facet values that should be returned for this facet. If unspecified, defaults to 20. The maximum allowed value is 300. Values above 300 will be coerced to 300. If this field is negative, an INVALID_ARGUMENT is returned.
&quot;limit&quot;: 42, # Maximum of facet values that should be returned for this facet. If unspecified, defaults to 50. The maximum allowed value is 300. Values above 300 will be coerced to 300. If this field is negative, an INVALID_ARGUMENT is returned.
},
&quot;name&quot;: &quot;A String&quot;, # Immutable. Fully qualified name `projects/*/locations/global/catalogs/*/controls/*`
&quot;rule&quot;: { # A rule is a condition-action pair * A condition defines when a rule is to be triggered. * An action specifies what occurs on that trigger. Currently rules only work for controls with SOLUTION_TYPE_SEARCH. # A rule control - a condition-action pair. Enacts a set action when the condition is triggered. For example: Boost &quot;gShoe&quot; when query full matches &quot;Running Shoes&quot;.
Expand Down Expand Up @@ -792,7 +792,7 @@ <h3>Method Details</h3>
],
&quot;returnMinMax&quot;: True or False, # Returns the min and max value for each numerical facet intervals. Ignored for textual facets.
},
&quot;limit&quot;: 42, # Maximum of facet values that should be returned for this facet. If unspecified, defaults to 20. The maximum allowed value is 300. Values above 300 will be coerced to 300. If this field is negative, an INVALID_ARGUMENT is returned.
&quot;limit&quot;: 42, # Maximum of facet values that should be returned for this facet. If unspecified, defaults to 50. The maximum allowed value is 300. Values above 300 will be coerced to 300. If this field is negative, an INVALID_ARGUMENT is returned.
},
&quot;name&quot;: &quot;A String&quot;, # Immutable. Fully qualified name `projects/*/locations/global/catalogs/*/controls/*`
&quot;rule&quot;: { # A rule is a condition-action pair * A condition defines when a rule is to be triggered. * An action specifies what occurs on that trigger. Currently rules only work for controls with SOLUTION_TYPE_SEARCH. # A rule control - a condition-action pair. Enacts a set action when the condition is triggered. For example: Boost &quot;gShoe&quot; when query full matches &quot;Running Shoes&quot;.
Expand Down

0 comments on commit 606bdc2

Please sign in to comment.