google-api-python-client 2.146.0__py2.py3-none-any.whl → 2.148.0__py2.py3-none-any.whl

googleapiclient/discovery_cache/documents/retail.v2.json

@@ -281,6 +281,31 @@
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
+"getGenerativeQuestionFeature": {
+"description": "Manages overal generative question feature state -- enables toggling feature on and off.",
+"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/generativeQuestionFeature",
+"httpMethod": "GET",
+"id": "retail.projects.locations.catalogs.getGenerativeQuestionFeature",
+"parameterOrder": [
+"catalog"
+],
+"parameters": {
+"catalog": {
+"description": "Required. Resource name of the parent catalog. Format: projects/{project}/locations/{location}/catalogs/{catalog}",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v2/{+catalog}/generativeQuestionFeature",
+"response": {
+"$ref": "GoogleCloudRetailV2GenerativeQuestionsFeatureConfig"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
 "list": {
 "description": "Lists all the Catalogs associated with the project.",
 "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/catalogs",
@@ -446,6 +471,74 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
+},
+"updateGenerativeQuestion": {
+"description": "Allows management of individual questions.",
+"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/generativeQuestion",
+"httpMethod": "PATCH",
+"id": "retail.projects.locations.catalogs.updateGenerativeQuestion",
+"parameterOrder": [
+"catalog"
+],
+"parameters": {
+"catalog": {
+"description": "Required. Resource name of the catalog. Format: projects/{project}/locations/{location}/catalogs/{catalog}",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+$",
+"required": true,
+"type": "string"
+},
+"updateMask": {
+"description": "Optional. Indicates which fields in the provided GenerativeQuestionConfig to update. The following are NOT supported: * GenerativeQuestionConfig.frequency If not set or empty, all supported fields are updated.",
+"format": "google-fieldmask",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v2/{+catalog}/generativeQuestion",
+"request": {
+"$ref": "GoogleCloudRetailV2GenerativeQuestionConfig"
+},
+"response": {
+"$ref": "GoogleCloudRetailV2GenerativeQuestionConfig"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"updateGenerativeQuestionFeature": {
+"description": "Manages overal generative question feature state -- enables toggling feature on and off.",
+"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/generativeQuestionFeature",
+"httpMethod": "PATCH",
+"id": "retail.projects.locations.catalogs.updateGenerativeQuestionFeature",
+"parameterOrder": [
+"catalog"
+],
+"parameters": {
+"catalog": {
+"description": "Required. Resource name of the affected catalog. Format: projects/{project}/locations/{location}/catalogs/{catalog}",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+$",
+"required": true,
+"type": "string"
+},
+"updateMask": {
+"description": "Optional. Indicates which fields in the provided GenerativeQuestionsFeatureConfig to update. If not set or empty, all supported fields are updated.",
+"format": "google-fieldmask",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v2/{+catalog}/generativeQuestionFeature",
+"request": {
+"$ref": "GoogleCloudRetailV2GenerativeQuestionsFeatureConfig"
+},
+"response": {
+"$ref": "GoogleCloudRetailV2GenerativeQuestionsFeatureConfig"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
 }
 },
 "resources": {
@@ -1133,6 +1226,67 @@
 }
 }
 },
+"generativeQuestion": {
+"methods": {
+"batchUpdate": {
+"description": "Allows management of multiple questions.",
+"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/generativeQuestion:batchUpdate",
+"httpMethod": "POST",
+"id": "retail.projects.locations.catalogs.generativeQuestion.batchUpdate",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"parent": {
+"description": "Optional. Resource name of the parent catalog. Format: projects/{project}/locations/{location}/catalogs/{catalog}",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v2/{+parent}/generativeQuestion:batchUpdate",
+"request": {
+"$ref": "GoogleCloudRetailV2BatchUpdateGenerativeQuestionConfigsRequest"
+},
+"response": {
+"$ref": "GoogleCloudRetailV2BatchUpdateGenerativeQuestionConfigsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+}
+},
+"generativeQuestions": {
+"methods": {
+"list": {
+"description": "Returns all questions for a given catalog.",
+"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/generativeQuestions",
+"httpMethod": "GET",
+"id": "retail.projects.locations.catalogs.generativeQuestions.list",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"parent": {
+"description": "Required. Resource name of the parent catalog. Format: projects/{project}/locations/{location}/catalogs/{catalog}",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v2/{+parent}/generativeQuestions",
+"response": {
+"$ref": "GoogleCloudRetailV2ListGenerativeQuestionConfigsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+}
+},
 "models": {
 "methods": {
 "create": {
@@ -2092,7 +2246,7 @@
 }
 }
 },
-"revision": "20240822",
+"revision": "20240920",
 "rootUrl": "https://retail.googleapis.com/",
 "schemas": {
 "GoogleApiHttpBody": {
@@ -2400,6 +2554,34 @@
 },
 "type": "object"
 },
+"GoogleCloudRetailV2BatchUpdateGenerativeQuestionConfigsRequest": {
+"description": "Request for BatchUpdateGenerativeQuestionConfig method.",
+"id": "GoogleCloudRetailV2BatchUpdateGenerativeQuestionConfigsRequest",
+"properties": {
+"requests": {
+"description": "Required. The updates question configs.",
+"items": {
+"$ref": "GoogleCloudRetailV2UpdateGenerativeQuestionConfigRequest"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
+"GoogleCloudRetailV2BatchUpdateGenerativeQuestionConfigsResponse": {
+"description": "Aggregated response for UpdateGenerativeQuestionConfig method.",
+"id": "GoogleCloudRetailV2BatchUpdateGenerativeQuestionConfigsResponse",
+"properties": {
+"generativeQuestionConfigs": {
+"description": "Optional. The updates question configs.",
+"items": {
+"$ref": "GoogleCloudRetailV2GenerativeQuestionConfig"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
 "GoogleCloudRetailV2BigQueryOutputResult": {
 "description": "A BigQuery output result.",
 "id": "GoogleCloudRetailV2BigQueryOutputResult",
@@ -3170,6 +3352,68 @@
 },
 "type": "object"
 },
+"GoogleCloudRetailV2GenerativeQuestionConfig": {
+"description": "Configuration for a single generated question.",
+"id": "GoogleCloudRetailV2GenerativeQuestionConfig",
+"properties": {
+"allowedInConversation": {
+"description": "Optional. Whether the question is asked at serving time.",
+"type": "boolean"
+},
+"catalog": {
+"description": "Required. Resource name of the catalog. Format: projects/{project}/locations/{location}/catalogs/{catalog}",
+"type": "string"
+},
+"exampleValues": {
+"description": "Output only. Values that can be used to answer the question.",
+"items": {
+"type": "string"
+},
+"readOnly": true,
+"type": "array"
+},
+"facet": {
+"description": "Required. The facet to which the question is associated.",
+"type": "string"
+},
+"finalQuestion": {
+"description": "Optional. The question that will be used at serving time. Question can have a max length of 300 bytes. When not populated, generated_question should be used.",
+"type": "string"
+},
+"frequency": {
+"description": "Output only. The ratio of how often a question was asked.",
+"format": "float",
+"readOnly": true,
+"type": "number"
+},
+"generatedQuestion": {
+"description": "Output only. The LLM generated question.",
+"readOnly": true,
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudRetailV2GenerativeQuestionsFeatureConfig": {
+"description": "Configuration for overall generative question feature state.",
+"id": "GoogleCloudRetailV2GenerativeQuestionsFeatureConfig",
+"properties": {
+"catalog": {
+"description": "Required. Resource name of the affected catalog. Format: projects/{project}/locations/{location}/catalogs/{catalog}",
+"type": "string"
+},
+"featureEnabled": {
+"description": "Optional. Determines whether questions will be used at serving time. Note: This feature cannot be enabled until initial data requirements are satisfied.",
+"type": "boolean"
+},
+"minimumProducts": {
+"description": "Optional. Minimum number of products in the response to trigger follow-up questions. Value must be 0 or positive.",
+"format": "int32",
+"type": "integer"
+}
+},
+"type": "object"
+},
 "GoogleCloudRetailV2GetDefaultBranchResponse": {
 "description": "Response message of CatalogService.GetDefaultBranch.",
 "id": "GoogleCloudRetailV2GetDefaultBranchResponse",
@@ -3448,6 +3692,20 @@
 },
 "type": "object"
 },
+"GoogleCloudRetailV2ListGenerativeQuestionConfigsResponse": {
+"description": "Response for ListQuestions method.",
+"id": "GoogleCloudRetailV2ListGenerativeQuestionConfigsResponse",
+"properties": {
+"generativeQuestionConfigs": {
+"description": "All the questions for a given catalog.",
+"items": {
+"$ref": "GoogleCloudRetailV2GenerativeQuestionConfig"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
 "GoogleCloudRetailV2ListModelsResponse": {
 "description": "Response to a ListModelRequest.",
 "id": "GoogleCloudRetailV2ListModelsResponse",
@@ -4149,6 +4407,36 @@
 },
 "type": "object"
 },
+"GoogleCloudRetailV2ProductAttributeInterval": {
+"description": "Product attribute name and numeric interval.",
+"id": "GoogleCloudRetailV2ProductAttributeInterval",
+"properties": {
+"interval": {
+"$ref": "GoogleCloudRetailV2Interval",
+"description": "The numeric interval (e.g. [10, 20))"
+},
+"name": {
+"description": "The attribute name (e.g. \"length\")",
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudRetailV2ProductAttributeValue": {
+"description": "Product attribute which structured by an attribute name and value. This structure is used in conversational search filters and answers. For example, if we have `name=color` and `value=red`, this means that the color is `red`.",
+"id": "GoogleCloudRetailV2ProductAttributeValue",
+"properties": {
+"name": {
+"description": "The attribute name.",
+"type": "string"
+},
+"value": {
+"description": "The attribute value.",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudRetailV2ProductDetail": {
 "description": "Detailed product information associated with a user event.",
 "id": "GoogleCloudRetailV2ProductDetail",
@@ -4785,6 +5073,10 @@
 "description": "The default filter that is applied when a user performs a search without checking any filters on the search page. The filter applied to every search request when quality improvement such as query expansion is needed. In the case a query does not have a sufficient amount of results this filter will be used to determine whether or not to enable the query expansion flow. The original filter will still be used for the query expanded search. This field is strongly recommended to achieve high search quality. For more information about filter syntax, see SearchRequest.filter.",
 "type": "string"
 },
+"conversationalSearchSpec": {
+"$ref": "GoogleCloudRetailV2SearchRequestConversationalSearchSpec",
+"description": "Optional. This field specifies all conversational related parameters addition to traditional retail search."
+},
 "dynamicFacetSpec": {
 "$ref": "GoogleCloudRetailV2SearchRequestDynamicFacetSpec",
 "deprecated": true,
@@ -4867,6 +5159,10 @@
 "$ref": "GoogleCloudRetailV2SearchRequestSpellCorrectionSpec",
 "description": "The spell correction specification that specifies the mode under which spell correction will take effect."
 },
+"tileNavigationSpec": {
+"$ref": "GoogleCloudRetailV2SearchRequestTileNavigationSpec",
+"description": "Optional. This field specifies tile navigation related parameters."
+},
 "userInfo": {
 "$ref": "GoogleCloudRetailV2UserInfo",
 "description": "User information."
@@ -4919,6 +5215,59 @@
 },
 "type": "object"
 },
+"GoogleCloudRetailV2SearchRequestConversationalSearchSpec": {
+"description": "This field specifies all conversational related parameters addition to traditional retail search.",
+"id": "GoogleCloudRetailV2SearchRequestConversationalSearchSpec",
+"properties": {
+"conversationId": {
+"description": "This field specifies the conversation id, which maintains the state of the conversation between client side and server side. Use the value from the previous ConversationalSearchResult.conversation_id. For the initial request, this should be empty.",
+"type": "string"
+},
+"followupConversationRequested": {
+"description": "This field specifies whether the customer would like to do conversational search. If this field is set to true, conversational related extra information will be returned from server side, including follow-up question, answer options, etc.",
+"type": "boolean"
+},
+"userAnswer": {
+"$ref": "GoogleCloudRetailV2SearchRequestConversationalSearchSpecUserAnswer",
+"description": "This field specifies the current user answer during the conversational search. This can be either user selected from suggested answers or user input plain text."
+}
+},
+"type": "object"
+},
+"GoogleCloudRetailV2SearchRequestConversationalSearchSpecUserAnswer": {
+"description": "This field specifies the current user answer during the conversational search. This can be either user selected from suggested answers or user input plain text.",
+"id": "GoogleCloudRetailV2SearchRequestConversationalSearchSpecUserAnswer",
+"properties": {
+"selectedAnswer": {
+"$ref": "GoogleCloudRetailV2SearchRequestConversationalSearchSpecUserAnswerSelectedAnswer",
+"description": "This field specifies the selected attributes during the conversational search. This should be a subset of ConversationalSearchResult.suggested_answers."
+},
+"textAnswer": {
+"description": "This field specifies the incremental input text from the user during the conversational search.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudRetailV2SearchRequestConversationalSearchSpecUserAnswerSelectedAnswer": {
+"description": "This field specifies the selected answers during the conversational search.",
+"id": "GoogleCloudRetailV2SearchRequestConversationalSearchSpecUserAnswerSelectedAnswer",
+"properties": {
+"productAttributeValue": {
+"$ref": "GoogleCloudRetailV2ProductAttributeValue",
+"description": "This field specifies the selected answer which is a attribute key-value."
+},
+"productAttributeValues": {
+"deprecated": true,
+"description": "This field is deprecated and should not be set.",
+"items": {
+"$ref": "GoogleCloudRetailV2ProductAttributeValue"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
 "GoogleCloudRetailV2SearchRequestDynamicFacetSpec": {
 "description": "The specifications of dynamically generated facets.",
 "id": "GoogleCloudRetailV2SearchRequestDynamicFacetSpec",
@@ -5089,6 +5438,24 @@
 },
 "type": "object"
 },
+"GoogleCloudRetailV2SearchRequestTileNavigationSpec": {
+"description": "This field specifies tile navigation related parameters.",
+"id": "GoogleCloudRetailV2SearchRequestTileNavigationSpec",
+"properties": {
+"appliedTiles": {
+"description": "This field specifies the tiles which are already clicked in client side. NOTE: This field is not being used for filtering search products. Client side should also put all the applied tiles in SearchRequest.filter.",
+"items": {
+"$ref": "GoogleCloudRetailV2Tile"
+},
+"type": "array"
+},
+"tileNavigationRequested": {
+"description": "This field specifies whether the customer would like to request tile navigation.",
+"type": "boolean"
+}
+},
+"type": "object"
+},
 "GoogleCloudRetailV2SearchResponse": {
 "description": "Response message for SearchService.Search method.",
 "id": "GoogleCloudRetailV2SearchResponse",
@@ -5104,6 +5471,10 @@
 "description": "A unique search token. This should be included in the UserEvent logs resulting from this search, which enables accurate attribution of search model performance.",
 "type": "string"
 },
+"conversationalSearchResult": {
+"$ref": "GoogleCloudRetailV2SearchResponseConversationalSearchResult",
+"description": "This field specifies all related information that is needed on client side for UI rendering of conversational retail search."
+},
 "correctedQuery": {
 "description": "Contains the spell corrected query, if found. If the spell correction type is AUTOMATIC, then the search results are based on corrected_query. Otherwise the original query is used for search.",
 "type": "string"
@@ -5148,6 +5519,10 @@
 },
 "type": "array"
 },
+"tileNavigationResult": {
+"$ref": "GoogleCloudRetailV2SearchResponseTileNavigationResult",
+"description": "This field specifies all related information for tile navigation that will be used in client side."
+},
 "totalSize": {
 "description": "The estimated total count of matched items irrespective of pagination. The count of results returned by pagination may be less than the total_size that matches.",
 "format": "int32",
@@ -5156,6 +5531,66 @@
 },
 "type": "object"
 },
+"GoogleCloudRetailV2SearchResponseConversationalSearchResult": {
+"description": "This field specifies all related information that is needed on client side for UI rendering of conversational retail search.",
+"id": "GoogleCloudRetailV2SearchResponseConversationalSearchResult",
+"properties": {
+"additionalFilter": {
+"$ref": "GoogleCloudRetailV2SearchResponseConversationalSearchResultAdditionalFilter",
+"description": "This is the incremental additional filters implied from the current user answer. User should add the suggested addition filters to the previous SearchRequest.filter, and use the merged filter in the follow up search request."
+},
+"additionalFilters": {
+"deprecated": true,
+"description": "This field is deprecated but will be kept for backward compatibility. There is expected to have only one additional filter and the value will be the same to the same as field `additional_filter`.",
+"items": {
+"$ref": "GoogleCloudRetailV2SearchResponseConversationalSearchResultAdditionalFilter"
+},
+"type": "array"
+},
+"conversationId": {
+"description": "Conversation UUID. This field will be stored in client side storage to maintain the conversation session with server and will be used for next search request's SearchRequest.ConversationalSearchSpec.conversation_id to restore conversation state in server.",
+"type": "string"
+},
+"followupQuestion": {
+"description": "The follow-up question. e.g., `What is the color?`",
+"type": "string"
+},
+"refinedQuery": {
+"description": "The current refined query for the conversational search. This field will be used in customer UI that the query in the search bar should be replaced with the refined query. For example, if SearchRequest.query is `dress` and next SearchRequest.ConversationalSearchSpec.UserAnswer.text_answer is `red color`, which does not match any product attribute value filters, the refined query will be `dress, red color`.",
+"type": "string"
+},
+"suggestedAnswers": {
+"description": "The answer options provided to client for the follow-up question.",
+"items": {
+"$ref": "GoogleCloudRetailV2SearchResponseConversationalSearchResultSuggestedAnswer"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
+"GoogleCloudRetailV2SearchResponseConversationalSearchResultAdditionalFilter": {
+"description": "Additional filter that client side need to apply.",
+"id": "GoogleCloudRetailV2SearchResponseConversationalSearchResultAdditionalFilter",
+"properties": {
+"productAttributeValue": {
+"$ref": "GoogleCloudRetailV2ProductAttributeValue",
+"description": "Product attribute value, including an attribute key and an attribute value. Other types can be added here in the future."
+}
+},
+"type": "object"
+},
+"GoogleCloudRetailV2SearchResponseConversationalSearchResultSuggestedAnswer": {
+"description": "Suggested answers to the follow-up question.",
+"id": "GoogleCloudRetailV2SearchResponseConversationalSearchResultSuggestedAnswer",
+"properties": {
+"productAttributeValue": {
+"$ref": "GoogleCloudRetailV2ProductAttributeValue",
+"description": "Product attribute value, including an attribute key and an attribute value. Other types can be added here in the future."
+}
+},
+"type": "object"
+},
 "GoogleCloudRetailV2SearchResponseFacet": {
 "description": "A facet result.",
 "id": "GoogleCloudRetailV2SearchResponseFacet",
@@ -5266,6 +5701,20 @@
 },
 "type": "object"
 },
+"GoogleCloudRetailV2SearchResponseTileNavigationResult": {
+"description": "This field specifies all related information for tile navigation that will be used in client side.",
+"id": "GoogleCloudRetailV2SearchResponseTileNavigationResult",
+"properties": {
+"tiles": {
+"description": "The current tiles that are used for tile navigation, sorted by engagement.",
+"items": {
+"$ref": "GoogleCloudRetailV2Tile"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
 "GoogleCloudRetailV2ServingConfig": {
 "description": "Configures metadata that is used to generate serving time results (e.g. search results or recommendation predictions).",
 "id": "GoogleCloudRetailV2ServingConfig",
@@ -5459,6 +5908,25 @@
 "properties": {},
 "type": "object"
 },
+"GoogleCloudRetailV2Tile": {
+"description": "This field specifies the tile information including an attribute key, attribute value. More fields will be added in the future, eg: product id or product counts, etc.",
+"id": "GoogleCloudRetailV2Tile",
+"properties": {
+"productAttributeInterval": {
+"$ref": "GoogleCloudRetailV2ProductAttributeInterval",
+"description": "The product attribute key-numeric interval."
+},
+"productAttributeValue": {
+"$ref": "GoogleCloudRetailV2ProductAttributeValue",
+"description": "The product attribute key-value."
+},
+"representativeProductId": {
+"description": "The representative product id for this tile.",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudRetailV2TuneModelMetadata": {
 "description": "Metadata associated with a tune operation.",
 "id": "GoogleCloudRetailV2TuneModelMetadata",
@@ -5482,6 +5950,22 @@
 "properties": {},
 "type": "object"
 },
+"GoogleCloudRetailV2UpdateGenerativeQuestionConfigRequest": {
+"description": "Request for UpdateGenerativeQuestionConfig method.",
+"id": "GoogleCloudRetailV2UpdateGenerativeQuestionConfigRequest",
+"properties": {
+"generativeQuestionConfig": {
+"$ref": "GoogleCloudRetailV2GenerativeQuestionConfig",
+"description": "Required. The question to update."
+},
+"updateMask": {
+"description": "Optional. Indicates which fields in the provided GenerativeQuestionConfig to update. The following are NOT supported: * GenerativeQuestionConfig.frequency If not set or empty, all supported fields are updated.",
+"format": "google-fieldmask",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudRetailV2UserEvent": {
 "description": "UserEvent captures all metadata information Retail API needs to know about how end users interact with customers' website.",
 "id": "GoogleCloudRetailV2UserEvent",