From 7fccba6a6fce5ebedabf5d85601779318fe5c26e Mon Sep 17 00:00:00 2001 From: Yoshi Automation Bot Date: Wed, 12 Jun 2024 11:40:20 -0700 Subject: [PATCH] feat(all): auto-regenerate discovery clients (#2624) --- api-list.json | 2 +- assuredworkloads/v1/assuredworkloads-api.json | 8 +- assuredworkloads/v1/assuredworkloads-gen.go | 2 + .../v1beta1/assuredworkloads-api.json | 8 +- .../v1beta1/assuredworkloads-gen.go | 2 + cloudbilling/v1beta/cloudbilling-api.json | 5 +- dialogflow/v2/dialogflow-api.json | 463 +++++++++- dialogflow/v2/dialogflow-gen.go | 790 +++++++++++++++++- dialogflow/v3/dialogflow-api.json | 339 +++++++- dialogflow/v3/dialogflow-gen.go | 480 ++++++++++- discoveryengine/v1/discoveryengine-api.json | 138 ++- discoveryengine/v1/discoveryengine-gen.go | 225 ++++- .../v1alpha/discoveryengine-api.json | 140 +++- .../v1alpha/discoveryengine-gen.go | 231 ++++- .../v1beta/discoveryengine-api.json | 138 ++- discoveryengine/v1beta/discoveryengine-gen.go | 226 ++++- firebaseml/v2beta/firebaseml-api.json | 8 +- firebaseml/v2beta/firebaseml-gen.go | 2 + games/v1/games-api.json | 68 +- games/v1/games-gen.go | 181 +++- iam/v1/iam-api.json | 6 +- iam/v1/iam-gen.go | 7 +- iam/v2/iam-api.json | 178 +++- iam/v2/iam-gen.go | 152 ++++ iam/v2beta/iam-api.json | 178 +++- iam/v2beta/iam-gen.go | 152 ++++ 26 files changed, 3975 insertions(+), 154 deletions(-) diff --git a/api-list.json b/api-list.json index ca0c4b1444a..ce0cab65fd2 100644 --- a/api-list.json +++ b/api-list.json @@ -4032,7 +4032,7 @@ "name": "marketingplatformadmin", "version": "v1alpha", "title": "Google Marketing Platform Admin API", - "description": "The Google Marketing Platform Admin API allows for programmatic access to the Google Marketing Platform configuration data. You can use the Google Marketing Platform Admin API to manage links between your Google Marketing Platform organization and Google Analytics accounts, set the service level of your GA4 properties.", + "description": "The Google Marketing Platform Admin API allows for programmatic access to the Google Marketing Platform configuration data. You can use the Google Marketing Platform Admin API to manage links between your Google Marketing Platform organization and Google Analytics accounts, and to set the service level of your GA4 properties.", "discoveryRestUrl": "https://marketingplatformadmin.googleapis.com/$discovery/rest?version=v1alpha", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", diff --git a/assuredworkloads/v1/assuredworkloads-api.json b/assuredworkloads/v1/assuredworkloads-api.json index 1ed26651fc7..cac3f7f9dc4 100644 --- a/assuredworkloads/v1/assuredworkloads-api.json +++ b/assuredworkloads/v1/assuredworkloads-api.json @@ -591,7 +591,7 @@ } } }, - "revision": "20240523", + "revision": "20240530", "rootUrl": "https://assuredworkloads.googleapis.com/", "schemas": { "GoogleCloudAssuredworkloadsV1AcknowledgeViolationRequest": { @@ -1074,7 +1074,8 @@ "REMEDIATION_LIST_ALLOWED_VALUES_ORG_POLICY_VIOLATION", "REMEDIATION_LIST_DENIED_VALUES_ORG_POLICY_VIOLATION", "REMEDIATION_RESTRICT_CMEK_CRYPTO_KEY_PROJECTS_ORG_POLICY_VIOLATION", - "REMEDIATION_RESOURCE_VIOLATION" + "REMEDIATION_RESOURCE_VIOLATION", + "REMEDIATION_RESOURCE_VIOLATION_NON_CMEK_SERVICES" ], "enumDescriptions": [ "Unspecified remediation type", @@ -1082,7 +1083,8 @@ "Remediation type for list org policy which have allowed values in the monitoring rule", "Remediation type for list org policy which have denied values in the monitoring rule", "Remediation type for gcp.restrictCmekCryptoKeyProjects", - "Remediation type for resource violation." + "Remediation type for resource violation.", + "Remediation type for resource violation due to gcp.restrictNonCmekServices" ], "readOnly": true, "type": "string" diff --git a/assuredworkloads/v1/assuredworkloads-gen.go b/assuredworkloads/v1/assuredworkloads-gen.go index 37a6f040b30..b24291e594a 100644 --- a/assuredworkloads/v1/assuredworkloads-gen.go +++ b/assuredworkloads/v1/assuredworkloads-gen.go @@ -751,6 +751,8 @@ type GoogleCloudAssuredworkloadsV1ViolationRemediation struct { // Remediation type for gcp.restrictCmekCryptoKeyProjects // "REMEDIATION_RESOURCE_VIOLATION" - Remediation type for resource // violation. + // "REMEDIATION_RESOURCE_VIOLATION_NON_CMEK_SERVICES" - Remediation type for + // resource violation due to gcp.restrictNonCmekServices RemediationType string `json:"remediationType,omitempty"` // ForceSendFields is a list of field names (e.g. "CompliantValues") to // unconditionally include in API requests. By default, fields with empty or diff --git a/assuredworkloads/v1beta1/assuredworkloads-api.json b/assuredworkloads/v1beta1/assuredworkloads-api.json index e999568d4a5..7a7db2b6bd3 100644 --- a/assuredworkloads/v1beta1/assuredworkloads-api.json +++ b/assuredworkloads/v1beta1/assuredworkloads-api.json @@ -563,7 +563,7 @@ } } }, - "revision": "20240523", + "revision": "20240530", "rootUrl": "https://assuredworkloads.googleapis.com/", "schemas": { "GoogleCloudAssuredworkloadsV1beta1AcknowledgeViolationRequest": { @@ -1033,7 +1033,8 @@ "REMEDIATION_LIST_ALLOWED_VALUES_ORG_POLICY_VIOLATION", "REMEDIATION_LIST_DENIED_VALUES_ORG_POLICY_VIOLATION", "REMEDIATION_RESTRICT_CMEK_CRYPTO_KEY_PROJECTS_ORG_POLICY_VIOLATION", - "REMEDIATION_RESOURCE_VIOLATION" + "REMEDIATION_RESOURCE_VIOLATION", + "REMEDIATION_RESOURCE_VIOLATION_NON_CMEK_SERVICES" ], "enumDescriptions": [ "Unspecified remediation type", @@ -1041,7 +1042,8 @@ "Remediation type for list org policy which have allowed values in the monitoring rule", "Remediation type for list org policy which have denied values in the monitoring rule", "Remediation type for gcp.restrictCmekCryptoKeyProjects", - "Remediation type for resource violation." + "Remediation type for resource violation.", + "Remediation type for resource violation due to gcp.restrictNonCmekServices" ], "readOnly": true, "type": "string" diff --git a/assuredworkloads/v1beta1/assuredworkloads-gen.go b/assuredworkloads/v1beta1/assuredworkloads-gen.go index 09b99e5897f..1a707ac58a8 100644 --- a/assuredworkloads/v1beta1/assuredworkloads-gen.go +++ b/assuredworkloads/v1beta1/assuredworkloads-gen.go @@ -725,6 +725,8 @@ type GoogleCloudAssuredworkloadsV1beta1ViolationRemediation struct { // Remediation type for gcp.restrictCmekCryptoKeyProjects // "REMEDIATION_RESOURCE_VIOLATION" - Remediation type for resource // violation. + // "REMEDIATION_RESOURCE_VIOLATION_NON_CMEK_SERVICES" - Remediation type for + // resource violation due to gcp.restrictNonCmekServices RemediationType string `json:"remediationType,omitempty"` // ForceSendFields is a list of field names (e.g. "CompliantValues") to // unconditionally include in API requests. By default, fields with empty or diff --git a/cloudbilling/v1beta/cloudbilling-api.json b/cloudbilling/v1beta/cloudbilling-api.json index 101397273ac..a2f91b84f98 100644 --- a/cloudbilling/v1beta/cloudbilling-api.json +++ b/cloudbilling/v1beta/cloudbilling-api.json @@ -114,6 +114,7 @@ "billingAccounts": { "methods": { "estimateCostScenario": { + "deprecated": true, "description": "Use custom pricing in the estimate, using a `CostScenario` with a defined `billingAccount`.", "flatPath": "v1beta/billingAccounts/{billingAccountsId}:estimateCostScenario", "httpMethod": "POST", @@ -734,8 +735,10 @@ } }, "v1beta": { + "deprecated": true, "methods": { "estimateCostScenario": { + "deprecated": true, "description": "Estimate list prices using a `CostScenario` without a defined `billingAccount`.", "flatPath": "v1beta:estimateCostScenario", "httpMethod": "POST", @@ -758,7 +761,7 @@ } } }, - "revision": "20240412", + "revision": "20240531", "rootUrl": "https://cloudbilling.googleapis.com/", "schemas": { "CacheFillRegions": { diff --git a/dialogflow/v2/dialogflow-api.json b/dialogflow/v2/dialogflow-api.json index 54b1c36a6a6..858c633dcba 100644 --- a/dialogflow/v2/dialogflow-api.json +++ b/dialogflow/v2/dialogflow-api.json @@ -3644,6 +3644,35 @@ "https://www.googleapis.com/auth/dialogflow" ] }, + "suggestKnowledgeAssist": { + "description": "Gets knowledge assist suggestions based on historical messages.", + "flatPath": "v2/projects/{projectsId}/conversations/{conversationsId}/participants/{participantsId}/suggestions:suggestKnowledgeAssist", + "httpMethod": "POST", + "id": "dialogflow.projects.conversations.participants.suggestions.suggestKnowledgeAssist", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The name of the participant to fetch suggestions for. Format: `projects//locations//conversations//participants/`.", + "location": "path", + "pattern": "^projects/[^/]+/conversations/[^/]+/participants/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+parent}/suggestions:suggestKnowledgeAssist", + "request": { + "$ref": "GoogleCloudDialogflowV2SuggestKnowledgeAssistRequest" + }, + "response": { + "$ref": "GoogleCloudDialogflowV2SuggestKnowledgeAssistResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, "suggestSmartReplies": { "description": "Gets smart replies for a participant based on specific historical messages.", "flatPath": "v2/projects/{projectsId}/conversations/{conversationsId}/participants/{participantsId}/suggestions:suggestSmartReplies", @@ -7562,6 +7591,35 @@ "https://www.googleapis.com/auth/dialogflow" ] }, + "suggestKnowledgeAssist": { + "description": "Gets knowledge assist suggestions based on historical messages.", + "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/participants/{participantsId}/suggestions:suggestKnowledgeAssist", + "httpMethod": "POST", + "id": "dialogflow.projects.locations.conversations.participants.suggestions.suggestKnowledgeAssist", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The name of the participant to fetch suggestions for. Format: `projects//locations//conversations//participants/`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+/participants/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+parent}/suggestions:suggestKnowledgeAssist", + "request": { + "$ref": "GoogleCloudDialogflowV2SuggestKnowledgeAssistRequest" + }, + "response": { + "$ref": "GoogleCloudDialogflowV2SuggestKnowledgeAssistResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, "suggestSmartReplies": { "description": "Gets smart replies for a participant based on specific historical messages.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/participants/{participantsId}/suggestions:suggestSmartReplies", @@ -8597,7 +8655,7 @@ } } }, - "revision": "20240523", + "revision": "20240603", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AdvancedSettings": { @@ -8658,11 +8716,11 @@ "id": "GoogleCloudDialogflowCxV3AdvancedSettingsLoggingSettings", "properties": { "enableInteractionLogging": { - "description": "If true, DF Interaction logging is currently enabled.", + "description": "Enables DF Interaction logging.", "type": "boolean" }, "enableStackdriverLogging": { - "description": "If true, StackDriver logging is currently enabled.", + "description": "Enables StackDriver logging.", "type": "boolean" } }, @@ -11048,11 +11106,11 @@ "id": "GoogleCloudDialogflowCxV3beta1AdvancedSettingsLoggingSettings", "properties": { "enableInteractionLogging": { - "description": "If true, DF Interaction logging is currently enabled.", + "description": "Enables DF Interaction logging.", "type": "boolean" }, "enableStackdriverLogging": { - "description": "If true, StackDriver logging is currently enabled.", + "description": "Enables StackDriver logging.", "type": "boolean" } }, @@ -12405,6 +12463,10 @@ "text": { "$ref": "GoogleCloudDialogflowCxV3beta1TextInput", "description": "The natural language text to be processed." + }, + "toolCallResult": { + "$ref": "GoogleCloudDialogflowCxV3beta1ToolCallResult", + "description": "The results of a tool executed by the client." } }, "type": "object" @@ -12473,6 +12535,10 @@ "text": { "$ref": "GoogleCloudDialogflowCxV3beta1ResponseMessageText", "description": "Returns a text response." + }, + "toolCall": { + "$ref": "GoogleCloudDialogflowCxV3beta1ToolCall", + "description": "Returns the definition of a tool call that should be executed by the client." } }, "type": "object" @@ -12867,6 +12933,67 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3beta1ToolCall": { + "description": "Represents a call of a specific tool's action with the specified inputs.", + "id": "GoogleCloudDialogflowCxV3beta1ToolCall", + "properties": { + "action": { + "description": "Required. The name of the tool's action associated with this call.", + "type": "string" + }, + "inputParameters": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Optional. The action's input parameters.", + "type": "object" + }, + "tool": { + "description": "Required. The tool associated with this call. Format: `projects//locations//agents//tools/`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1ToolCallResult": { + "description": "The result of calling a tool's action that has been executed by the client.", + "id": "GoogleCloudDialogflowCxV3beta1ToolCallResult", + "properties": { + "action": { + "description": "Required. The name of the tool's action associated with this call.", + "type": "string" + }, + "error": { + "$ref": "GoogleCloudDialogflowCxV3beta1ToolCallResultError", + "description": "The tool call's error." + }, + "outputParameters": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "The tool call's output parameters.", + "type": "object" + }, + "tool": { + "description": "Required. The tool associated with this call. Format: `projects//locations//agents//tools/`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1ToolCallResultError": { + "description": "An error produced by the tool call.", + "id": "GoogleCloudDialogflowCxV3beta1ToolCallResultError", + "properties": { + "message": { + "description": "Optional. The error message of the function.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3beta1TransitionRoute": { "description": "A transition route specifies a intent that can be matched and/or a data condition that can be evaluated during a session. When a specified transition is matched, the following actions are taken in order: * If there is a `trigger_fulfillment` associated with the transition, it will be called. * If there is a `target_page` associated with the transition, the session will transition into the specified page. * If there is a `target_flow` associated with the transition, the session will transition into the specified flow.", "id": "GoogleCloudDialogflowCxV3beta1TransitionRoute", @@ -13510,6 +13637,10 @@ ], "type": "string" }, + "knowledgeAssistFeedback": { + "$ref": "GoogleCloudDialogflowV2AgentAssistantFeedbackKnowledgeAssistFeedback", + "description": "Optional. Feedback for knowledge assist." + }, "knowledgeSearchFeedback": { "$ref": "GoogleCloudDialogflowV2AgentAssistantFeedbackKnowledgeSearchFeedback", "description": "Optional. Feedback for knowledge search." @@ -13521,6 +13652,24 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2AgentAssistantFeedbackKnowledgeAssistFeedback": { + "description": "Feedback for knowledge assist.", + "id": "GoogleCloudDialogflowV2AgentAssistantFeedbackKnowledgeAssistFeedback", + "properties": { + "answerCopied": { + "description": "Whether the suggested answer was copied by the human agent. If the value is set to be true, AnswerFeedback.clicked will be updated to be true.", + "type": "boolean" + }, + "clickedUris": { + "description": "The URIs clicked by the human agent. The value is appended for each UpdateAnswerRecordRequest. If the value is not empty, AnswerFeedback.clicked will be updated to be true.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2AgentAssistantFeedbackKnowledgeSearchFeedback": { "description": "Feedback for knowledge search.", "id": "GoogleCloudDialogflowV2AgentAssistantFeedbackKnowledgeSearchFeedback", @@ -14089,14 +14238,16 @@ "ARTICLE_SUGGESTION", "FAQ", "SMART_REPLY", - "KNOWLEDGE_SEARCH" + "KNOWLEDGE_SEARCH", + "KNOWLEDGE_ASSIST" ], "enumDescriptions": [ "Unspecified feature type.", "Run article suggestion model for chat.", "Run FAQ model for chat.", "Run smart reply model for chat.", - "Run knowledge search with text input from agent or text generated query." + "Run knowledge search with text input from agent or text generated query.", + "Run knowledge assist with automatic query generation." ], "type": "string" } @@ -14130,14 +14281,16 @@ "ARTICLE_SUGGESTION", "FAQ", "SMART_REPLY", - "KNOWLEDGE_SEARCH" + "KNOWLEDGE_SEARCH", + "KNOWLEDGE_ASSIST" ], "enumDescriptions": [ "Unspecified feature type.", "Run article suggestion model for chat.", "Run FAQ model for chat.", "Run smart reply model for chat.", - "Run knowledge search with text input from agent or text generated query." + "Run knowledge search with text input from agent or text generated query.", + "Run knowledge assist with automatic query generation." ], "type": "string" } @@ -15599,6 +15752,10 @@ "description": "Detail human agent assistant config.", "id": "GoogleCloudDialogflowV2HumanAgentAssistantConfigSuggestionConfig", "properties": { + "disableHighLatencyFeaturesSyncDelivery": { + "description": "Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST.", + "type": "boolean" + }, "featureConfigs": { "description": "Configuration of different suggestion features. One feature can have only one config.", "items": { @@ -15644,6 +15801,14 @@ "description": "Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, KNOWLEDGE_ASSIST.", "type": "boolean" }, + "enableQuerySuggestionOnly": { + "description": "Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST", + "type": "boolean" + }, + "enableQuerySuggestionWhenNoAnswer": { + "description": "Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST", + "type": "boolean" + }, "queryConfig": { "$ref": "GoogleCloudDialogflowV2HumanAgentAssistantConfigSuggestionQueryConfig", "description": "Configs of query." @@ -17117,6 +17282,99 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2KnowledgeAssistAnswer": { + "description": "Represents a Knowledge Assist answer.", + "id": "GoogleCloudDialogflowV2KnowledgeAssistAnswer", + "properties": { + "answerRecord": { + "description": "The name of the answer record. Format: `projects//locations//answer Records/`.", + "type": "string" + }, + "suggestedQuery": { + "$ref": "GoogleCloudDialogflowV2KnowledgeAssistAnswerSuggestedQuery", + "description": "The query suggested based on the context. Suggestion is made only if it is different from the previous suggestion." + }, + "suggestedQueryAnswer": { + "$ref": "GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswer", + "description": "The answer generated for the suggested query. Whether or not an answer is generated depends on how confident we are about the generated query." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswer": { + "description": "Represents an answer from Knowledge. Currently supports FAQ and Generative answers.", + "id": "GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswer", + "properties": { + "answerText": { + "description": "The piece of text from the `source` that answers this suggested query.", + "type": "string" + }, + "faqSource": { + "$ref": "GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerFaqSource", + "description": "Populated if the prediction came from FAQ." + }, + "generativeSource": { + "$ref": "GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerGenerativeSource", + "description": "Populated if the prediction was Generative." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerFaqSource": { + "description": "Details about source of FAQ answer.", + "id": "GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerFaqSource", + "properties": { + "question": { + "description": "The corresponding FAQ question.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerGenerativeSource": { + "description": "Details about source of Generative answer.", + "id": "GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerGenerativeSource", + "properties": { + "snippets": { + "description": "All snippets used for this Generative Prediction, with their source URI and data.", + "items": { + "$ref": "GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerGenerativeSourceSnippet" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerGenerativeSourceSnippet": { + "description": "Snippet Source for a Generative Prediction.", + "id": "GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerGenerativeSourceSnippet", + "properties": { + "text": { + "description": "Text taken from that URI.", + "type": "string" + }, + "title": { + "description": "Title of the document.", + "type": "string" + }, + "uri": { + "description": "URI the data is sourced from.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2KnowledgeAssistAnswerSuggestedQuery": { + "description": "Represents a suggested query.", + "id": "GoogleCloudDialogflowV2KnowledgeAssistAnswerSuggestedQuery", + "properties": { + "queryText": { + "description": "Suggested query text.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2KnowledgeBase": { "description": "A knowledge base represents a collection of knowledge documents that you provide to Dialogflow. Your knowledge documents contain information that may be useful during conversations with end-users. Some Dialogflow features use knowledge bases when looking for a response to an end-user input. For more information, see the [knowledge base guide](https://cloud.google.com/dialogflow/docs/how/knowledge-bases). Note: The `projects.agent.knowledgeBases` resource is deprecated; only use `projects.knowledgeBases`.", "id": "GoogleCloudDialogflowV2KnowledgeBase", @@ -18175,14 +18433,16 @@ "ARTICLE_SUGGESTION", "FAQ", "SMART_REPLY", - "KNOWLEDGE_SEARCH" + "KNOWLEDGE_SEARCH", + "KNOWLEDGE_ASSIST" ], "enumDescriptions": [ "Unspecified feature type.", "Run article suggestion model for chat.", "Run FAQ model for chat.", "Run smart reply model for chat.", - "Run knowledge search with text input from agent or text generated query." + "Run knowledge search with text input from agent or text generated query.", + "Run knowledge assist with automatic query generation." ], "type": "string" } @@ -18500,6 +18760,47 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2SuggestKnowledgeAssistRequest": { + "description": "The request message for Participants.SuggestKnowledgeAssist.", + "id": "GoogleCloudDialogflowV2SuggestKnowledgeAssistRequest", + "properties": { + "contextSize": { + "description": "Optional. Max number of messages prior to and including latest_message to use as context when compiling the suggestion. The context size is by default 100 and at most 100.", + "format": "int32", + "type": "integer" + }, + "latestMessage": { + "description": "Optional. The name of the latest conversation message to compile suggestions for. If empty, it will be the latest message of the conversation. Format: `projects//locations//conversations//messages/`.", + "type": "string" + }, + "previousSuggestedQuery": { + "description": "Optional. The previously suggested query for the given conversation. This helps identify whether the next suggestion we generate is resonably different from the previous one. This is useful to avoid similar suggestions within the conversation.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2SuggestKnowledgeAssistResponse": { + "description": "The response message for Participants.SuggestKnowledgeAssist.", + "id": "GoogleCloudDialogflowV2SuggestKnowledgeAssistResponse", + "properties": { + "contextSize": { + "description": "Number of messages prior to and including latest_message to compile the suggestion. It may be smaller than the SuggestKnowledgeAssistRequest.context_size field in the request if there are fewer messages in the conversation.", + "format": "int32", + "type": "integer" + }, + "knowledgeAssistAnswer": { + "$ref": "GoogleCloudDialogflowV2KnowledgeAssistAnswer", + "description": "Output only. Knowledge Assist suggestion.", + "readOnly": true + }, + "latestMessage": { + "description": "The name of the latest conversation message used to compile suggestion for. Format: `projects//locations//conversations//messages/`.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2SuggestSmartRepliesRequest": { "description": "The request message for Participants.SuggestSmartReplies.", "id": "GoogleCloudDialogflowV2SuggestSmartRepliesRequest", @@ -18555,14 +18856,16 @@ "ARTICLE_SUGGESTION", "FAQ", "SMART_REPLY", - "KNOWLEDGE_SEARCH" + "KNOWLEDGE_SEARCH", + "KNOWLEDGE_ASSIST" ], "enumDescriptions": [ "Unspecified feature type.", "Run article suggestion model for chat.", "Run FAQ model for chat.", "Run smart reply model for chat.", - "Run knowledge search with text input from agent or text generated query." + "Run knowledge search with text input from agent or text generated query.", + "Run knowledge assist with automatic query generation." ], "type": "string" } @@ -18596,6 +18899,10 @@ "$ref": "GoogleCloudDialogflowV2SuggestFaqAnswersResponse", "description": "SuggestFaqAnswersResponse if request is for FAQ_ANSWER." }, + "suggestKnowledgeAssistResponse": { + "$ref": "GoogleCloudDialogflowV2SuggestKnowledgeAssistResponse", + "description": "SuggestKnowledgeAssistResponse if request is for KNOWLEDGE_ASSIST." + }, "suggestSmartRepliesResponse": { "$ref": "GoogleCloudDialogflowV2SuggestSmartRepliesResponse", "description": "SuggestSmartRepliesResponse if request is for SMART_REPLY." @@ -19144,7 +19451,8 @@ "SMART_REPLY", "DIALOGFLOW_ASSIST", "CONVERSATION_SUMMARIZATION", - "KNOWLEDGE_SEARCH" + "KNOWLEDGE_SEARCH", + "KNOWLEDGE_ASSIST" ], "enumDescriptions": [ "Unspecified feature type.", @@ -19153,7 +19461,8 @@ "Run smart reply model for chat.", "Run Dialogflow assist model for chat, which will return automated agent response as suggestion.", "Run conversation summarization model for chat.", - "Run knowledge search with text input from agent or text generated query." + "Run knowledge search with text input from agent or text generated query.", + "Run knowledge assist with automatic query generation." ], "type": "string" } @@ -20731,6 +21040,99 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2beta1KnowledgeAssistAnswer": { + "description": "Represents a Knowledge Assist answer.", + "id": "GoogleCloudDialogflowV2beta1KnowledgeAssistAnswer", + "properties": { + "answerRecord": { + "description": "The name of the answer record. Format: `projects//locations//answer Records/`.", + "type": "string" + }, + "suggestedQuery": { + "$ref": "GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerSuggestedQuery", + "description": "The query suggested based on the context. Suggestion is made only if it is different from the previous suggestion." + }, + "suggestedQueryAnswer": { + "$ref": "GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswer", + "description": "The answer generated for the suggested query. Whether or not an answer is generated depends on how confident we are about the generated query." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswer": { + "description": "Represents an answer from Knowledge. Currently supports FAQ and Generative answers.", + "id": "GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswer", + "properties": { + "answerText": { + "description": "The piece of text from the `source` that answers this suggested query.", + "type": "string" + }, + "faqSource": { + "$ref": "GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerFaqSource", + "description": "Populated if the prediction came from FAQ." + }, + "generativeSource": { + "$ref": "GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerGenerativeSource", + "description": "Populated if the prediction was Generative." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerFaqSource": { + "description": "Details about source of FAQ answer.", + "id": "GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerFaqSource", + "properties": { + "question": { + "description": "The corresponding FAQ question.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerGenerativeSource": { + "description": "Details about source of Generative answer.", + "id": "GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerGenerativeSource", + "properties": { + "snippets": { + "description": "All snippets used for this Generative Prediction, with their source URI and data.", + "items": { + "$ref": "GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerGenerativeSourceSnippet" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerGenerativeSourceSnippet": { + "description": "Snippet Source for a Generative Prediction.", + "id": "GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerGenerativeSourceSnippet", + "properties": { + "text": { + "description": "Text taken from that URI.", + "type": "string" + }, + "title": { + "description": "Title of the document.", + "type": "string" + }, + "uri": { + "description": "URI the data is sourced from.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerSuggestedQuery": { + "description": "Represents a suggested query.", + "id": "GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerSuggestedQuery", + "properties": { + "queryText": { + "description": "Suggested query text.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2beta1KnowledgeOperationMetadata": { "description": "Metadata in google::longrunning::Operation for Knowledge operations.", "id": "GoogleCloudDialogflowV2beta1KnowledgeOperationMetadata", @@ -21059,7 +21461,8 @@ "SMART_REPLY", "DIALOGFLOW_ASSIST", "CONVERSATION_SUMMARIZATION", - "KNOWLEDGE_SEARCH" + "KNOWLEDGE_SEARCH", + "KNOWLEDGE_ASSIST" ], "enumDescriptions": [ "Unspecified feature type.", @@ -21068,7 +21471,8 @@ "Run smart reply model for chat.", "Run Dialogflow assist model for chat, which will return automated agent response as suggestion.", "Run conversation summarization model for chat.", - "Run knowledge search with text input from agent or text generated query." + "Run knowledge search with text input from agent or text generated query.", + "Run knowledge assist with automatic query generation." ], "type": "string" } @@ -21164,6 +21568,27 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2beta1SuggestKnowledgeAssistResponse": { + "description": "The response message for Participants.SuggestKnowledgeAssist.", + "id": "GoogleCloudDialogflowV2beta1SuggestKnowledgeAssistResponse", + "properties": { + "contextSize": { + "description": "Number of messages prior to and including latest_message to compile the suggestion. It may be smaller than the SuggestKnowledgeAssistRequest.context_size field in the request if there are fewer messages in the conversation.", + "format": "int32", + "type": "integer" + }, + "knowledgeAssistAnswer": { + "$ref": "GoogleCloudDialogflowV2beta1KnowledgeAssistAnswer", + "description": "Output only. Knowledge Assist suggestion.", + "readOnly": true + }, + "latestMessage": { + "description": "The name of the latest conversation message used to compile suggestion for. Format: `projects//locations//conversations//messages/`.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2beta1SuggestSmartRepliesResponse": { "description": "The response message for Participants.SuggestSmartReplies.", "id": "GoogleCloudDialogflowV2beta1SuggestSmartRepliesResponse", @@ -21211,6 +21636,10 @@ "$ref": "GoogleCloudDialogflowV2beta1SuggestFaqAnswersResponse", "description": "SuggestFaqAnswersResponse if request is for FAQ_ANSWER." }, + "suggestKnowledgeAssistResponse": { + "$ref": "GoogleCloudDialogflowV2beta1SuggestKnowledgeAssistResponse", + "description": "SuggestKnowledgeAssistResponse if request is for KNOWLEDGE_ASSIST." + }, "suggestSmartRepliesResponse": { "$ref": "GoogleCloudDialogflowV2beta1SuggestSmartRepliesResponse", "description": "SuggestSmartRepliesResponse if request is for SMART_REPLY." diff --git a/dialogflow/v2/dialogflow-gen.go b/dialogflow/v2/dialogflow-gen.go index 242165417b8..ea166261e36 100644 --- a/dialogflow/v2/dialogflow-gen.go +++ b/dialogflow/v2/dialogflow-gen.go @@ -1001,10 +1001,9 @@ func (s *GoogleCloudDialogflowCxV3AdvancedSettingsDtmfSettings) MarshalJSON() ([ // GoogleCloudDialogflowCxV3AdvancedSettingsLoggingSettings: Define behaviors // on logging. type GoogleCloudDialogflowCxV3AdvancedSettingsLoggingSettings struct { - // EnableInteractionLogging: If true, DF Interaction logging is currently - // enabled. + // EnableInteractionLogging: Enables DF Interaction logging. EnableInteractionLogging bool `json:"enableInteractionLogging,omitempty"` - // EnableStackdriverLogging: If true, StackDriver logging is currently enabled. + // EnableStackdriverLogging: Enables StackDriver logging. EnableStackdriverLogging bool `json:"enableStackdriverLogging,omitempty"` // ForceSendFields is a list of field names (e.g. "EnableInteractionLogging") // to unconditionally include in API requests. By default, fields with empty or @@ -4439,10 +4438,9 @@ func (s *GoogleCloudDialogflowCxV3beta1AdvancedSettingsDtmfSettings) MarshalJSON // GoogleCloudDialogflowCxV3beta1AdvancedSettingsLoggingSettings: Define // behaviors on logging. type GoogleCloudDialogflowCxV3beta1AdvancedSettingsLoggingSettings struct { - // EnableInteractionLogging: If true, DF Interaction logging is currently - // enabled. + // EnableInteractionLogging: Enables DF Interaction logging. EnableInteractionLogging bool `json:"enableInteractionLogging,omitempty"` - // EnableStackdriverLogging: If true, StackDriver logging is currently enabled. + // EnableStackdriverLogging: Enables StackDriver logging. EnableStackdriverLogging bool `json:"enableStackdriverLogging,omitempty"` // ForceSendFields is a list of field names (e.g. "EnableInteractionLogging") // to unconditionally include in API requests. By default, fields with empty or @@ -6484,6 +6482,8 @@ type GoogleCloudDialogflowCxV3beta1QueryInput struct { LanguageCode string `json:"languageCode,omitempty"` // Text: The natural language text to be processed. Text *GoogleCloudDialogflowCxV3beta1TextInput `json:"text,omitempty"` + // ToolCallResult: The results of a tool executed by the client. + ToolCallResult *GoogleCloudDialogflowCxV3beta1ToolCallResult `json:"toolCallResult,omitempty"` // ForceSendFields is a list of field names (e.g. "Audio") to unconditionally // include in API requests. By default, fields with empty or default values are // omitted from API requests. See @@ -6576,6 +6576,9 @@ type GoogleCloudDialogflowCxV3beta1ResponseMessage struct { TelephonyTransferCall *GoogleCloudDialogflowCxV3beta1ResponseMessageTelephonyTransferCall `json:"telephonyTransferCall,omitempty"` // Text: Returns a text response. Text *GoogleCloudDialogflowCxV3beta1ResponseMessageText `json:"text,omitempty"` + // ToolCall: Returns the definition of a tool call that should be executed by + // the client. + ToolCall *GoogleCloudDialogflowCxV3beta1ToolCall `json:"toolCall,omitempty"` // ForceSendFields is a list of field names (e.g. "Channel") to unconditionally // include in API requests. By default, fields with empty or default values are // omitted from API requests. See @@ -7171,6 +7174,87 @@ func (s *GoogleCloudDialogflowCxV3beta1TextInput) MarshalJSON() ([]byte, error) return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields) } +// GoogleCloudDialogflowCxV3beta1ToolCall: Represents a call of a specific +// tool's action with the specified inputs. +type GoogleCloudDialogflowCxV3beta1ToolCall struct { + // Action: Required. The name of the tool's action associated with this call. + Action string `json:"action,omitempty"` + // InputParameters: Optional. The action's input parameters. + InputParameters googleapi.RawMessage `json:"inputParameters,omitempty"` + // Tool: Required. The tool associated with this call. Format: + // `projects//locations//agents//tools/`. + Tool string `json:"tool,omitempty"` + // ForceSendFields is a list of field names (e.g. "Action") to unconditionally + // include in API requests. By default, fields with empty or default values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "Action") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDialogflowCxV3beta1ToolCall) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDialogflowCxV3beta1ToolCall + return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields) +} + +// GoogleCloudDialogflowCxV3beta1ToolCallResult: The result of calling a tool's +// action that has been executed by the client. +type GoogleCloudDialogflowCxV3beta1ToolCallResult struct { + // Action: Required. The name of the tool's action associated with this call. + Action string `json:"action,omitempty"` + // Error: The tool call's error. + Error *GoogleCloudDialogflowCxV3beta1ToolCallResultError `json:"error,omitempty"` + // OutputParameters: The tool call's output parameters. + OutputParameters googleapi.RawMessage `json:"outputParameters,omitempty"` + // Tool: Required. The tool associated with this call. Format: + // `projects//locations//agents//tools/`. + Tool string `json:"tool,omitempty"` + // ForceSendFields is a list of field names (e.g. "Action") to unconditionally + // include in API requests. By default, fields with empty or default values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "Action") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDialogflowCxV3beta1ToolCallResult) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDialogflowCxV3beta1ToolCallResult + return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields) +} + +// GoogleCloudDialogflowCxV3beta1ToolCallResultError: An error produced by the +// tool call. +type GoogleCloudDialogflowCxV3beta1ToolCallResultError struct { + // Message: Optional. The error message of the function. + Message string `json:"message,omitempty"` + // ForceSendFields is a list of field names (e.g. "Message") to unconditionally + // include in API requests. By default, fields with empty or default values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "Message") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDialogflowCxV3beta1ToolCallResultError) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDialogflowCxV3beta1ToolCallResultError + return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields) +} + // GoogleCloudDialogflowCxV3beta1TransitionRoute: A transition route specifies // a intent that can be matched and/or a data condition that can be evaluated // during a session. When a specified transition is matched, the following @@ -7934,6 +8018,8 @@ type GoogleCloudDialogflowV2AgentAssistantFeedback struct { // "INEFFICIENT" - Document is inefficient. // "EFFICIENT" - Document is efficient. DocumentEfficiency string `json:"documentEfficiency,omitempty"` + // KnowledgeAssistFeedback: Optional. Feedback for knowledge assist. + KnowledgeAssistFeedback *GoogleCloudDialogflowV2AgentAssistantFeedbackKnowledgeAssistFeedback `json:"knowledgeAssistFeedback,omitempty"` // KnowledgeSearchFeedback: Optional. Feedback for knowledge search. KnowledgeSearchFeedback *GoogleCloudDialogflowV2AgentAssistantFeedbackKnowledgeSearchFeedback `json:"knowledgeSearchFeedback,omitempty"` // SummarizationFeedback: Optional. Feedback for conversation summarization. @@ -7956,6 +8042,35 @@ func (s *GoogleCloudDialogflowV2AgentAssistantFeedback) MarshalJSON() ([]byte, e return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields) } +// GoogleCloudDialogflowV2AgentAssistantFeedbackKnowledgeAssistFeedback: +// Feedback for knowledge assist. +type GoogleCloudDialogflowV2AgentAssistantFeedbackKnowledgeAssistFeedback struct { + // AnswerCopied: Whether the suggested answer was copied by the human agent. If + // the value is set to be true, AnswerFeedback.clicked will be updated to be + // true. + AnswerCopied bool `json:"answerCopied,omitempty"` + // ClickedUris: The URIs clicked by the human agent. The value is appended for + // each UpdateAnswerRecordRequest. If the value is not empty, + // AnswerFeedback.clicked will be updated to be true. + ClickedUris []string `json:"clickedUris,omitempty"` + // ForceSendFields is a list of field names (e.g. "AnswerCopied") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "AnswerCopied") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDialogflowV2AgentAssistantFeedbackKnowledgeAssistFeedback) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDialogflowV2AgentAssistantFeedbackKnowledgeAssistFeedback + return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields) +} + // GoogleCloudDialogflowV2AgentAssistantFeedbackKnowledgeSearchFeedback: // Feedback for knowledge search. type GoogleCloudDialogflowV2AgentAssistantFeedbackKnowledgeSearchFeedback struct { @@ -8739,6 +8854,7 @@ type GoogleCloudDialogflowV2ClearSuggestionFeatureConfigOperationMetadata struct // "SMART_REPLY" - Run smart reply model for chat. // "KNOWLEDGE_SEARCH" - Run knowledge search with text input from agent or // text generated query. + // "KNOWLEDGE_ASSIST" - Run knowledge assist with automatic query generation. SuggestionFeatureType string `json:"suggestionFeatureType,omitempty"` // ForceSendFields is a list of field names (e.g. "ConversationProfile") to // unconditionally include in API requests. By default, fields with empty or @@ -8782,6 +8898,7 @@ type GoogleCloudDialogflowV2ClearSuggestionFeatureConfigRequest struct { // "SMART_REPLY" - Run smart reply model for chat. // "KNOWLEDGE_SEARCH" - Run knowledge search with text input from agent or // text generated query. + // "KNOWLEDGE_ASSIST" - Run knowledge assist with automatic query generation. SuggestionFeatureType string `json:"suggestionFeatureType,omitempty"` // ForceSendFields is a list of field names (e.g. "ParticipantRole") to // unconditionally include in API requests. By default, fields with empty or @@ -10859,6 +10976,15 @@ func (s *GoogleCloudDialogflowV2HumanAgentAssistantConfigMessageAnalysisConfig) // GoogleCloudDialogflowV2HumanAgentAssistantConfigSuggestionConfig: Detail // human agent assistant config. type GoogleCloudDialogflowV2HumanAgentAssistantConfigSuggestionConfig struct { + // DisableHighLatencyFeaturesSyncDelivery: Optional. When + // disable_high_latency_features_sync_delivery is true and using the + // AnalyzeContent API, we will not deliver the responses from high latency + // features in the API response. The + // human_agent_assistant_config.notification_config must be configured and + // enable_event_based_suggestion must be set to true to receive the responses + // from high latency features in Pub/Sub. High latency feature(s): + // KNOWLEDGE_ASSIST. + DisableHighLatencyFeaturesSyncDelivery bool `json:"disableHighLatencyFeaturesSyncDelivery,omitempty"` // FeatureConfigs: Configuration of different suggestion features. One feature // can have only one config. FeatureConfigs []*GoogleCloudDialogflowV2HumanAgentAssistantConfigSuggestionFeatureConfig `json:"featureConfigs,omitempty"` @@ -10875,16 +11001,18 @@ type GoogleCloudDialogflowV2HumanAgentAssistantConfigSuggestionConfig struct { // will be grouped into a single Pub/Sub event or // StreamingAnalyzeContentResponse. GroupSuggestionResponses bool `json:"groupSuggestionResponses,omitempty"` - // ForceSendFields is a list of field names (e.g. "FeatureConfigs") to - // unconditionally include in API requests. By default, fields with empty or - // default values are omitted from API requests. See + // ForceSendFields is a list of field names (e.g. + // "DisableHighLatencyFeaturesSyncDelivery") to unconditionally include in API + // requests. By default, fields with empty or default values are omitted from + // API requests. See // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more // details. ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "FeatureConfigs") to include in - // API requests with the JSON null value. By default, fields with empty values - // are omitted from API requests. See - // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + // NullFields is a list of field names (e.g. + // "DisableHighLatencyFeaturesSyncDelivery") to include in API requests with + // the JSON null value. By default, fields with empty values are omitted from + // API requests. See https://pkg.go.dev/google.golang.org/api#hdr-NullFields + // for more details. NullFields []string `json:"-"` } @@ -10912,6 +11040,13 @@ type GoogleCloudDialogflowV2HumanAgentAssistantConfigSuggestionFeatureConfig str // tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, // DIALOGFLOW_ASSIST, KNOWLEDGE_ASSIST. EnableEventBasedSuggestion bool `json:"enableEventBasedSuggestion,omitempty"` + // EnableQuerySuggestionOnly: Optional. Enable query suggestion only. Supported + // features: KNOWLEDGE_ASSIST + EnableQuerySuggestionOnly bool `json:"enableQuerySuggestionOnly,omitempty"` + // EnableQuerySuggestionWhenNoAnswer: Optional. Enable query suggestion even if + // we can't find its answer. By default, queries are suggested only if we find + // its answer. Supported features: KNOWLEDGE_ASSIST + EnableQuerySuggestionWhenNoAnswer bool `json:"enableQuerySuggestionWhenNoAnswer,omitempty"` // QueryConfig: Configs of query. QueryConfig *GoogleCloudDialogflowV2HumanAgentAssistantConfigSuggestionQueryConfig `json:"queryConfig,omitempty"` // SuggestionFeature: The suggestion feature. @@ -12943,6 +13078,162 @@ func (s *GoogleCloudDialogflowV2IntentTrainingPhrasePart) MarshalJSON() ([]byte, return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields) } +// GoogleCloudDialogflowV2KnowledgeAssistAnswer: Represents a Knowledge Assist +// answer. +type GoogleCloudDialogflowV2KnowledgeAssistAnswer struct { + // AnswerRecord: The name of the answer record. Format: + // `projects//locations//answer Records/`. + AnswerRecord string `json:"answerRecord,omitempty"` + // SuggestedQuery: The query suggested based on the context. Suggestion is made + // only if it is different from the previous suggestion. + SuggestedQuery *GoogleCloudDialogflowV2KnowledgeAssistAnswerSuggestedQuery `json:"suggestedQuery,omitempty"` + // SuggestedQueryAnswer: The answer generated for the suggested query. Whether + // or not an answer is generated depends on how confident we are about the + // generated query. + SuggestedQueryAnswer *GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswer `json:"suggestedQueryAnswer,omitempty"` + // ForceSendFields is a list of field names (e.g. "AnswerRecord") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "AnswerRecord") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDialogflowV2KnowledgeAssistAnswer) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDialogflowV2KnowledgeAssistAnswer + return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields) +} + +// GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswer: Represents an +// answer from Knowledge. Currently supports FAQ and Generative answers. +type GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswer struct { + // AnswerText: The piece of text from the `source` that answers this suggested + // query. + AnswerText string `json:"answerText,omitempty"` + // FaqSource: Populated if the prediction came from FAQ. + FaqSource *GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerFaqSource `json:"faqSource,omitempty"` + // GenerativeSource: Populated if the prediction was Generative. + GenerativeSource *GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerGenerativeSource `json:"generativeSource,omitempty"` + // ForceSendFields is a list of field names (e.g. "AnswerText") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "AnswerText") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswer) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswer + return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields) +} + +// GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerFaqSource: +// Details about source of FAQ answer. +type GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerFaqSource struct { + // Question: The corresponding FAQ question. + Question string `json:"question,omitempty"` + // ForceSendFields is a list of field names (e.g. "Question") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "Question") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerFaqSource) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerFaqSource + return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields) +} + +// GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerGenerativeSource: +// Details about source of Generative answer. +type GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerGenerativeSource struct { + // Snippets: All snippets used for this Generative Prediction, with their + // source URI and data. + Snippets []*GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerGenerativeSourceSnippet `json:"snippets,omitempty"` + // ForceSendFields is a list of field names (e.g. "Snippets") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "Snippets") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerGenerativeSource) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerGenerativeSource + return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields) +} + +// GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerGenerativeSourceSn +// ippet: Snippet Source for a Generative Prediction. +type GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerGenerativeSourceSnippet struct { + // Text: Text taken from that URI. + Text string `json:"text,omitempty"` + // Title: Title of the document. + Title string `json:"title,omitempty"` + // Uri: URI the data is sourced from. + Uri string `json:"uri,omitempty"` + // ForceSendFields is a list of field names (e.g. "Text") to unconditionally + // include in API requests. By default, fields with empty or default values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "Text") to include in API requests + // with the JSON null value. By default, fields with empty values are omitted + // from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerGenerativeSourceSnippet) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerGenerativeSourceSnippet + return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields) +} + +// GoogleCloudDialogflowV2KnowledgeAssistAnswerSuggestedQuery: Represents a +// suggested query. +type GoogleCloudDialogflowV2KnowledgeAssistAnswerSuggestedQuery struct { + // QueryText: Suggested query text. + QueryText string `json:"queryText,omitempty"` + // ForceSendFields is a list of field names (e.g. "QueryText") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "QueryText") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDialogflowV2KnowledgeAssistAnswerSuggestedQuery) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDialogflowV2KnowledgeAssistAnswerSuggestedQuery + return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields) +} + // GoogleCloudDialogflowV2KnowledgeBase: A knowledge base represents a // collection of knowledge documents that you provide to Dialogflow. Your // knowledge documents contain information that may be useful during @@ -14505,6 +14796,7 @@ type GoogleCloudDialogflowV2SetSuggestionFeatureConfigOperationMetadata struct { // "SMART_REPLY" - Run smart reply model for chat. // "KNOWLEDGE_SEARCH" - Run knowledge search with text input from agent or // text generated query. + // "KNOWLEDGE_ASSIST" - Run knowledge assist with automatic query generation. SuggestionFeatureType string `json:"suggestionFeatureType,omitempty"` // ForceSendFields is a list of field names (e.g. "ConversationProfile") to // unconditionally include in API requests. By default, fields with empty or @@ -15066,6 +15358,74 @@ func (s *GoogleCloudDialogflowV2SuggestFaqAnswersResponse) MarshalJSON() ([]byte return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields) } +// GoogleCloudDialogflowV2SuggestKnowledgeAssistRequest: The request message +// for Participants.SuggestKnowledgeAssist. +type GoogleCloudDialogflowV2SuggestKnowledgeAssistRequest struct { + // ContextSize: Optional. Max number of messages prior to and including + // latest_message to use as context when compiling the suggestion. The context + // size is by default 100 and at most 100. + ContextSize int64 `json:"contextSize,omitempty"` + // LatestMessage: Optional. The name of the latest conversation message to + // compile suggestions for. If empty, it will be the latest message of the + // conversation. Format: `projects//locations//conversations//messages/`. + LatestMessage string `json:"latestMessage,omitempty"` + // PreviousSuggestedQuery: Optional. The previously suggested query for the + // given conversation. This helps identify whether the next suggestion we + // generate is resonably different from the previous one. This is useful to + // avoid similar suggestions within the conversation. + PreviousSuggestedQuery string `json:"previousSuggestedQuery,omitempty"` + // ForceSendFields is a list of field names (e.g. "ContextSize") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "ContextSize") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDialogflowV2SuggestKnowledgeAssistRequest) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDialogflowV2SuggestKnowledgeAssistRequest + return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields) +} + +// GoogleCloudDialogflowV2SuggestKnowledgeAssistResponse: The response message +// for Participants.SuggestKnowledgeAssist. +type GoogleCloudDialogflowV2SuggestKnowledgeAssistResponse struct { + // ContextSize: Number of messages prior to and including latest_message to + // compile the suggestion. It may be smaller than the + // SuggestKnowledgeAssistRequest.context_size field in the request if there are + // fewer messages in the conversation. + ContextSize int64 `json:"contextSize,omitempty"` + // KnowledgeAssistAnswer: Output only. Knowledge Assist suggestion. + KnowledgeAssistAnswer *GoogleCloudDialogflowV2KnowledgeAssistAnswer `json:"knowledgeAssistAnswer,omitempty"` + // LatestMessage: The name of the latest conversation message used to compile + // suggestion for. Format: `projects//locations//conversations//messages/`. + LatestMessage string `json:"latestMessage,omitempty"` + + // ServerResponse contains the HTTP response code and headers from the server. + googleapi.ServerResponse `json:"-"` + // ForceSendFields is a list of field names (e.g. "ContextSize") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "ContextSize") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDialogflowV2SuggestKnowledgeAssistResponse) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDialogflowV2SuggestKnowledgeAssistResponse + return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields) +} + // GoogleCloudDialogflowV2SuggestSmartRepliesRequest: The request message for // Participants.SuggestSmartReplies. type GoogleCloudDialogflowV2SuggestSmartRepliesRequest struct { @@ -15149,6 +15509,7 @@ type GoogleCloudDialogflowV2SuggestionFeature struct { // "SMART_REPLY" - Run smart reply model for chat. // "KNOWLEDGE_SEARCH" - Run knowledge search with text input from agent or // text generated query. + // "KNOWLEDGE_ASSIST" - Run knowledge assist with automatic query generation. Type string `json:"type,omitempty"` // ForceSendFields is a list of field names (e.g. "Type") to unconditionally // include in API requests. By default, fields with empty or default values are @@ -15207,6 +15568,9 @@ type GoogleCloudDialogflowV2SuggestionResult struct { // SuggestFaqAnswersResponse: SuggestFaqAnswersResponse if request is for // FAQ_ANSWER. SuggestFaqAnswersResponse *GoogleCloudDialogflowV2SuggestFaqAnswersResponse `json:"suggestFaqAnswersResponse,omitempty"` + // SuggestKnowledgeAssistResponse: SuggestKnowledgeAssistResponse if request is + // for KNOWLEDGE_ASSIST. + SuggestKnowledgeAssistResponse *GoogleCloudDialogflowV2SuggestKnowledgeAssistResponse `json:"suggestKnowledgeAssistResponse,omitempty"` // SuggestSmartRepliesResponse: SuggestSmartRepliesResponse if request is for // SMART_REPLY. SuggestSmartRepliesResponse *GoogleCloudDialogflowV2SuggestSmartRepliesResponse `json:"suggestSmartRepliesResponse,omitempty"` @@ -15970,6 +16334,7 @@ type GoogleCloudDialogflowV2beta1ClearSuggestionFeatureConfigOperationMetadata s // chat. // "KNOWLEDGE_SEARCH" - Run knowledge search with text input from agent or // text generated query. + // "KNOWLEDGE_ASSIST" - Run knowledge assist with automatic query generation. SuggestionFeatureType string `json:"suggestionFeatureType,omitempty"` // ForceSendFields is a list of field names (e.g. "ConversationProfile") to // unconditionally include in API requests. By default, fields with empty or @@ -18121,6 +18486,162 @@ func (s *GoogleCloudDialogflowV2beta1KnowledgeAnswersAnswer) UnmarshalJSON(data return nil } +// GoogleCloudDialogflowV2beta1KnowledgeAssistAnswer: Represents a Knowledge +// Assist answer. +type GoogleCloudDialogflowV2beta1KnowledgeAssistAnswer struct { + // AnswerRecord: The name of the answer record. Format: + // `projects//locations//answer Records/`. + AnswerRecord string `json:"answerRecord,omitempty"` + // SuggestedQuery: The query suggested based on the context. Suggestion is made + // only if it is different from the previous suggestion. + SuggestedQuery *GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerSuggestedQuery `json:"suggestedQuery,omitempty"` + // SuggestedQueryAnswer: The answer generated for the suggested query. Whether + // or not an answer is generated depends on how confident we are about the + // generated query. + SuggestedQueryAnswer *GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswer `json:"suggestedQueryAnswer,omitempty"` + // ForceSendFields is a list of field names (e.g. "AnswerRecord") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "AnswerRecord") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDialogflowV2beta1KnowledgeAssistAnswer) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDialogflowV2beta1KnowledgeAssistAnswer + return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields) +} + +// GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswer: Represents +// an answer from Knowledge. Currently supports FAQ and Generative answers. +type GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswer struct { + // AnswerText: The piece of text from the `source` that answers this suggested + // query. + AnswerText string `json:"answerText,omitempty"` + // FaqSource: Populated if the prediction came from FAQ. + FaqSource *GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerFaqSource `json:"faqSource,omitempty"` + // GenerativeSource: Populated if the prediction was Generative. + GenerativeSource *GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerGenerativeSource `json:"generativeSource,omitempty"` + // ForceSendFields is a list of field names (e.g. "AnswerText") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "AnswerText") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswer) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswer + return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields) +} + +// GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerFaqSource: +// Details about source of FAQ answer. +type GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerFaqSource struct { + // Question: The corresponding FAQ question. + Question string `json:"question,omitempty"` + // ForceSendFields is a list of field names (e.g. "Question") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "Question") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerFaqSource) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerFaqSource + return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields) +} + +// GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerGenerativeSou +// rce: Details about source of Generative answer. +type GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerGenerativeSource struct { + // Snippets: All snippets used for this Generative Prediction, with their + // source URI and data. + Snippets []*GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerGenerativeSourceSnippet `json:"snippets,omitempty"` + // ForceSendFields is a list of field names (e.g. "Snippets") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "Snippets") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerGenerativeSource) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerGenerativeSource + return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields) +} + +// GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerGenerativeSou +// rceSnippet: Snippet Source for a Generative Prediction. +type GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerGenerativeSourceSnippet struct { + // Text: Text taken from that URI. + Text string `json:"text,omitempty"` + // Title: Title of the document. + Title string `json:"title,omitempty"` + // Uri: URI the data is sourced from. + Uri string `json:"uri,omitempty"` + // ForceSendFields is a list of field names (e.g. "Text") to unconditionally + // include in API requests. By default, fields with empty or default values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "Text") to include in API requests + // with the JSON null value. By default, fields with empty values are omitted + // from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerGenerativeSourceSnippet) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerGenerativeSourceSnippet + return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields) +} + +// GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerSuggestedQuery: Represents +// a suggested query. +type GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerSuggestedQuery struct { + // QueryText: Suggested query text. + QueryText string `json:"queryText,omitempty"` + // ForceSendFields is a list of field names (e.g. "QueryText") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "QueryText") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerSuggestedQuery) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerSuggestedQuery + return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields) +} + // GoogleCloudDialogflowV2beta1KnowledgeOperationMetadata: Metadata in // google::longrunning::Operation for Knowledge operations. type GoogleCloudDialogflowV2beta1KnowledgeOperationMetadata struct { @@ -18561,6 +19082,7 @@ type GoogleCloudDialogflowV2beta1SetSuggestionFeatureConfigOperationMetadata str // chat. // "KNOWLEDGE_SEARCH" - Run knowledge search with text input from agent or // text generated query. + // "KNOWLEDGE_ASSIST" - Run knowledge assist with automatic query generation. SuggestionFeatureType string `json:"suggestionFeatureType,omitempty"` // ForceSendFields is a list of field names (e.g. "ConversationProfile") to // unconditionally include in API requests. By default, fields with empty or @@ -18719,6 +19241,37 @@ func (s *GoogleCloudDialogflowV2beta1SuggestFaqAnswersResponse) MarshalJSON() ([ return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields) } +// GoogleCloudDialogflowV2beta1SuggestKnowledgeAssistResponse: The response +// message for Participants.SuggestKnowledgeAssist. +type GoogleCloudDialogflowV2beta1SuggestKnowledgeAssistResponse struct { + // ContextSize: Number of messages prior to and including latest_message to + // compile the suggestion. It may be smaller than the + // SuggestKnowledgeAssistRequest.context_size field in the request if there are + // fewer messages in the conversation. + ContextSize int64 `json:"contextSize,omitempty"` + // KnowledgeAssistAnswer: Output only. Knowledge Assist suggestion. + KnowledgeAssistAnswer *GoogleCloudDialogflowV2beta1KnowledgeAssistAnswer `json:"knowledgeAssistAnswer,omitempty"` + // LatestMessage: The name of the latest conversation message used to compile + // suggestion for. Format: `projects//locations//conversations//messages/`. + LatestMessage string `json:"latestMessage,omitempty"` + // ForceSendFields is a list of field names (e.g. "ContextSize") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "ContextSize") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDialogflowV2beta1SuggestKnowledgeAssistResponse) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDialogflowV2beta1SuggestKnowledgeAssistResponse + return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields) +} + // GoogleCloudDialogflowV2beta1SuggestSmartRepliesResponse: The response // message for Participants.SuggestSmartReplies. type GoogleCloudDialogflowV2beta1SuggestSmartRepliesResponse struct { @@ -18771,6 +19324,9 @@ type GoogleCloudDialogflowV2beta1SuggestionResult struct { // SuggestFaqAnswersResponse: SuggestFaqAnswersResponse if request is for // FAQ_ANSWER. SuggestFaqAnswersResponse *GoogleCloudDialogflowV2beta1SuggestFaqAnswersResponse `json:"suggestFaqAnswersResponse,omitempty"` + // SuggestKnowledgeAssistResponse: SuggestKnowledgeAssistResponse if request is + // for KNOWLEDGE_ASSIST. + SuggestKnowledgeAssistResponse *GoogleCloudDialogflowV2beta1SuggestKnowledgeAssistResponse `json:"suggestKnowledgeAssistResponse,omitempty"` // SuggestSmartRepliesResponse: SuggestSmartRepliesResponse if request is for // SMART_REPLY. SuggestSmartRepliesResponse *GoogleCloudDialogflowV2beta1SuggestSmartRepliesResponse `json:"suggestSmartRepliesResponse,omitempty"` @@ -32104,6 +32660,110 @@ func (c *ProjectsConversationsParticipantsSuggestionsSuggestFaqAnswersCall) Do(o return ret, nil } +type ProjectsConversationsParticipantsSuggestionsSuggestKnowledgeAssistCall struct { + s *Service + parent string + googleclouddialogflowv2suggestknowledgeassistrequest *GoogleCloudDialogflowV2SuggestKnowledgeAssistRequest + urlParams_ gensupport.URLParams + ctx_ context.Context + header_ http.Header +} + +// SuggestKnowledgeAssist: Gets knowledge assist suggestions based on +// historical messages. +// +// - parent: The name of the participant to fetch suggestions for. Format: +// `projects//locations//conversations//participants/`. +func (r *ProjectsConversationsParticipantsSuggestionsService) SuggestKnowledgeAssist(parent string, googleclouddialogflowv2suggestknowledgeassistrequest *GoogleCloudDialogflowV2SuggestKnowledgeAssistRequest) *ProjectsConversationsParticipantsSuggestionsSuggestKnowledgeAssistCall { + c := &ProjectsConversationsParticipantsSuggestionsSuggestKnowledgeAssistCall{s: r.s, urlParams_: make(gensupport.URLParams)} + c.parent = parent + c.googleclouddialogflowv2suggestknowledgeassistrequest = googleclouddialogflowv2suggestknowledgeassistrequest + return c +} + +// Fields allows partial responses to be retrieved. See +// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more +// details. +func (c *ProjectsConversationsParticipantsSuggestionsSuggestKnowledgeAssistCall) Fields(s ...googleapi.Field) *ProjectsConversationsParticipantsSuggestionsSuggestKnowledgeAssistCall { + c.urlParams_.Set("fields", googleapi.CombineFields(s)) + return c +} + +// Context sets the context to be used in this call's Do method. +func (c *ProjectsConversationsParticipantsSuggestionsSuggestKnowledgeAssistCall) Context(ctx context.Context) *ProjectsConversationsParticipantsSuggestionsSuggestKnowledgeAssistCall { + c.ctx_ = ctx + return c +} + +// Header returns a http.Header that can be modified by the caller to add +// headers to the request. +func (c *ProjectsConversationsParticipantsSuggestionsSuggestKnowledgeAssistCall) Header() http.Header { + if c.header_ == nil { + c.header_ = make(http.Header) + } + return c.header_ +} + +func (c *ProjectsConversationsParticipantsSuggestionsSuggestKnowledgeAssistCall) doRequest(alt string) (*http.Response, error) { + reqHeaders := gensupport.SetHeaders(c.s.userAgent(), "application/json", c.header_) + var body io.Reader = nil + body, err := googleapi.WithoutDataWrapper.JSONReader(c.googleclouddialogflowv2suggestknowledgeassistrequest) + if err != nil { + return nil, err + } + c.urlParams_.Set("alt", alt) + c.urlParams_.Set("prettyPrint", "false") + urls := googleapi.ResolveRelative(c.s.BasePath, "v2/{+parent}/suggestions:suggestKnowledgeAssist") + urls += "?" + c.urlParams_.Encode() + req, err := http.NewRequest("POST", urls, body) + if err != nil { + return nil, err + } + req.Header = reqHeaders + googleapi.Expand(req.URL, map[string]string{ + "parent": c.parent, + }) + return gensupport.SendRequest(c.ctx_, c.s.client, req) +} + +// Do executes the "dialogflow.projects.conversations.participants.suggestions.suggestKnowledgeAssist" call. +// Any non-2xx status code is an error. Response headers are in either +// *GoogleCloudDialogflowV2SuggestKnowledgeAssistResponse.ServerResponse.Header +// or (if a response was returned at all) in error.(*googleapi.Error).Header. +// Use googleapi.IsNotModified to check whether the returned error was because +// http.StatusNotModified was returned. +func (c *ProjectsConversationsParticipantsSuggestionsSuggestKnowledgeAssistCall) Do(opts ...googleapi.CallOption) (*GoogleCloudDialogflowV2SuggestKnowledgeAssistResponse, error) { + gensupport.SetOptions(c.urlParams_, opts...) + res, err := c.doRequest("json") + if res != nil && res.StatusCode == http.StatusNotModified { + if res.Body != nil { + res.Body.Close() + } + return nil, gensupport.WrapError(&googleapi.Error{ + Code: res.StatusCode, + Header: res.Header, + }) + } + if err != nil { + return nil, err + } + defer googleapi.CloseBody(res) + if err := googleapi.CheckResponse(res); err != nil { + return nil, gensupport.WrapError(err) + } + ret := &GoogleCloudDialogflowV2SuggestKnowledgeAssistResponse{ + ServerResponse: googleapi.ServerResponse{ + Header: res.Header, + HTTPStatusCode: res.StatusCode, + }, + } + target := &ret + if err := gensupport.DecodeResponse(target, res); err != nil { + return nil, err + } + return ret, nil +} + type ProjectsConversationsParticipantsSuggestionsSuggestSmartRepliesCall struct { s *Service parent string @@ -46177,6 +46837,110 @@ func (c *ProjectsLocationsConversationsParticipantsSuggestionsSuggestFaqAnswersC return ret, nil } +type ProjectsLocationsConversationsParticipantsSuggestionsSuggestKnowledgeAssistCall struct { + s *Service + parent string + googleclouddialogflowv2suggestknowledgeassistrequest *GoogleCloudDialogflowV2SuggestKnowledgeAssistRequest + urlParams_ gensupport.URLParams + ctx_ context.Context + header_ http.Header +} + +// SuggestKnowledgeAssist: Gets knowledge assist suggestions based on +// historical messages. +// +// - parent: The name of the participant to fetch suggestions for. Format: +// `projects//locations//conversations//participants/`. +func (r *ProjectsLocationsConversationsParticipantsSuggestionsService) SuggestKnowledgeAssist(parent string, googleclouddialogflowv2suggestknowledgeassistrequest *GoogleCloudDialogflowV2SuggestKnowledgeAssistRequest) *ProjectsLocationsConversationsParticipantsSuggestionsSuggestKnowledgeAssistCall { + c := &ProjectsLocationsConversationsParticipantsSuggestionsSuggestKnowledgeAssistCall{s: r.s, urlParams_: make(gensupport.URLParams)} + c.parent = parent + c.googleclouddialogflowv2suggestknowledgeassistrequest = googleclouddialogflowv2suggestknowledgeassistrequest + return c +} + +// Fields allows partial responses to be retrieved. See +// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more +// details. +func (c *ProjectsLocationsConversationsParticipantsSuggestionsSuggestKnowledgeAssistCall) Fields(s ...googleapi.Field) *ProjectsLocationsConversationsParticipantsSuggestionsSuggestKnowledgeAssistCall { + c.urlParams_.Set("fields", googleapi.CombineFields(s)) + return c +} + +// Context sets the context to be used in this call's Do method. +func (c *ProjectsLocationsConversationsParticipantsSuggestionsSuggestKnowledgeAssistCall) Context(ctx context.Context) *ProjectsLocationsConversationsParticipantsSuggestionsSuggestKnowledgeAssistCall { + c.ctx_ = ctx + return c +} + +// Header returns a http.Header that can be modified by the caller to add +// headers to the request. +func (c *ProjectsLocationsConversationsParticipantsSuggestionsSuggestKnowledgeAssistCall) Header() http.Header { + if c.header_ == nil { + c.header_ = make(http.Header) + } + return c.header_ +} + +func (c *ProjectsLocationsConversationsParticipantsSuggestionsSuggestKnowledgeAssistCall) doRequest(alt string) (*http.Response, error) { + reqHeaders := gensupport.SetHeaders(c.s.userAgent(), "application/json", c.header_) + var body io.Reader = nil + body, err := googleapi.WithoutDataWrapper.JSONReader(c.googleclouddialogflowv2suggestknowledgeassistrequest) + if err != nil { + return nil, err + } + c.urlParams_.Set("alt", alt) + c.urlParams_.Set("prettyPrint", "false") + urls := googleapi.ResolveRelative(c.s.BasePath, "v2/{+parent}/suggestions:suggestKnowledgeAssist") + urls += "?" + c.urlParams_.Encode() + req, err := http.NewRequest("POST", urls, body) + if err != nil { + return nil, err + } + req.Header = reqHeaders + googleapi.Expand(req.URL, map[string]string{ + "parent": c.parent, + }) + return gensupport.SendRequest(c.ctx_, c.s.client, req) +} + +// Do executes the "dialogflow.projects.locations.conversations.participants.suggestions.suggestKnowledgeAssist" call. +// Any non-2xx status code is an error. Response headers are in either +// *GoogleCloudDialogflowV2SuggestKnowledgeAssistResponse.ServerResponse.Header +// or (if a response was returned at all) in error.(*googleapi.Error).Header. +// Use googleapi.IsNotModified to check whether the returned error was because +// http.StatusNotModified was returned. +func (c *ProjectsLocationsConversationsParticipantsSuggestionsSuggestKnowledgeAssistCall) Do(opts ...googleapi.CallOption) (*GoogleCloudDialogflowV2SuggestKnowledgeAssistResponse, error) { + gensupport.SetOptions(c.urlParams_, opts...) + res, err := c.doRequest("json") + if res != nil && res.StatusCode == http.StatusNotModified { + if res.Body != nil { + res.Body.Close() + } + return nil, gensupport.WrapError(&googleapi.Error{ + Code: res.StatusCode, + Header: res.Header, + }) + } + if err != nil { + return nil, err + } + defer googleapi.CloseBody(res) + if err := googleapi.CheckResponse(res); err != nil { + return nil, gensupport.WrapError(err) + } + ret := &GoogleCloudDialogflowV2SuggestKnowledgeAssistResponse{ + ServerResponse: googleapi.ServerResponse{ + Header: res.Header, + HTTPStatusCode: res.StatusCode, + }, + } + target := &ret + if err := gensupport.DecodeResponse(target, res); err != nil { + return nil, err + } + return ret, nil +} + type ProjectsLocationsConversationsParticipantsSuggestionsSuggestSmartRepliesCall struct { s *Service parent string diff --git a/dialogflow/v3/dialogflow-api.json b/dialogflow/v3/dialogflow-api.json index 25c37d8110e..b67fdd74dd7 100644 --- a/dialogflow/v3/dialogflow-api.json +++ b/dialogflow/v3/dialogflow-api.json @@ -4453,7 +4453,7 @@ } } }, - "revision": "20240507", + "revision": "20240603", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AdvancedSettings": { @@ -4514,11 +4514,11 @@ "id": "GoogleCloudDialogflowCxV3AdvancedSettingsLoggingSettings", "properties": { "enableInteractionLogging": { - "description": "If true, DF Interaction logging is currently enabled.", + "description": "Enables DF Interaction logging.", "type": "boolean" }, "enableStackdriverLogging": { - "description": "If true, StackDriver logging is currently enabled.", + "description": "Enables StackDriver logging.", "type": "boolean" } }, @@ -10261,11 +10261,11 @@ "id": "GoogleCloudDialogflowCxV3beta1AdvancedSettingsLoggingSettings", "properties": { "enableInteractionLogging": { - "description": "If true, DF Interaction logging is currently enabled.", + "description": "Enables DF Interaction logging.", "type": "boolean" }, "enableStackdriverLogging": { - "description": "If true, StackDriver logging is currently enabled.", + "description": "Enables StackDriver logging.", "type": "boolean" } }, @@ -11618,6 +11618,10 @@ "text": { "$ref": "GoogleCloudDialogflowCxV3beta1TextInput", "description": "The natural language text to be processed." + }, + "toolCallResult": { + "$ref": "GoogleCloudDialogflowCxV3beta1ToolCallResult", + "description": "The results of a tool executed by the client." } }, "type": "object" @@ -11686,6 +11690,10 @@ "text": { "$ref": "GoogleCloudDialogflowCxV3beta1ResponseMessageText", "description": "Returns a text response." + }, + "toolCall": { + "$ref": "GoogleCloudDialogflowCxV3beta1ToolCall", + "description": "Returns the definition of a tool call that should be executed by the client." } }, "type": "object" @@ -12080,6 +12088,67 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3beta1ToolCall": { + "description": "Represents a call of a specific tool's action with the specified inputs.", + "id": "GoogleCloudDialogflowCxV3beta1ToolCall", + "properties": { + "action": { + "description": "Required. The name of the tool's action associated with this call.", + "type": "string" + }, + "inputParameters": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Optional. The action's input parameters.", + "type": "object" + }, + "tool": { + "description": "Required. The tool associated with this call. Format: `projects//locations//agents//tools/`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1ToolCallResult": { + "description": "The result of calling a tool's action that has been executed by the client.", + "id": "GoogleCloudDialogflowCxV3beta1ToolCallResult", + "properties": { + "action": { + "description": "Required. The name of the tool's action associated with this call.", + "type": "string" + }, + "error": { + "$ref": "GoogleCloudDialogflowCxV3beta1ToolCallResultError", + "description": "The tool call's error." + }, + "outputParameters": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "The tool call's output parameters.", + "type": "object" + }, + "tool": { + "description": "Required. The tool associated with this call. Format: `projects//locations//agents//tools/`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1ToolCallResultError": { + "description": "An error produced by the tool call.", + "id": "GoogleCloudDialogflowCxV3beta1ToolCallResultError", + "properties": { + "message": { + "description": "Optional. The error message of the function.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3beta1TransitionRoute": { "description": "A transition route specifies a intent that can be matched and/or a data condition that can be evaluated during a session. When a specified transition is matched, the following actions are taken in order: * If there is a `trigger_fulfillment` associated with the transition, it will be called. * If there is a `target_page` associated with the transition, the session will transition into the specified page. * If there is a `target_flow` associated with the transition, the session will transition into the specified flow.", "id": "GoogleCloudDialogflowCxV3beta1TransitionRoute", @@ -12719,14 +12788,16 @@ "ARTICLE_SUGGESTION", "FAQ", "SMART_REPLY", - "KNOWLEDGE_SEARCH" + "KNOWLEDGE_SEARCH", + "KNOWLEDGE_ASSIST" ], "enumDescriptions": [ "Unspecified feature type.", "Run article suggestion model for chat.", "Run FAQ model for chat.", "Run smart reply model for chat.", - "Run knowledge search with text input from agent or text generated query." + "Run knowledge search with text input from agent or text generated query.", + "Run knowledge assist with automatic query generation." ], "type": "string" } @@ -14159,6 +14230,99 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2KnowledgeAssistAnswer": { + "description": "Represents a Knowledge Assist answer.", + "id": "GoogleCloudDialogflowV2KnowledgeAssistAnswer", + "properties": { + "answerRecord": { + "description": "The name of the answer record. Format: `projects//locations//answer Records/`.", + "type": "string" + }, + "suggestedQuery": { + "$ref": "GoogleCloudDialogflowV2KnowledgeAssistAnswerSuggestedQuery", + "description": "The query suggested based on the context. Suggestion is made only if it is different from the previous suggestion." + }, + "suggestedQueryAnswer": { + "$ref": "GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswer", + "description": "The answer generated for the suggested query. Whether or not an answer is generated depends on how confident we are about the generated query." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswer": { + "description": "Represents an answer from Knowledge. Currently supports FAQ and Generative answers.", + "id": "GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswer", + "properties": { + "answerText": { + "description": "The piece of text from the `source` that answers this suggested query.", + "type": "string" + }, + "faqSource": { + "$ref": "GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerFaqSource", + "description": "Populated if the prediction came from FAQ." + }, + "generativeSource": { + "$ref": "GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerGenerativeSource", + "description": "Populated if the prediction was Generative." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerFaqSource": { + "description": "Details about source of FAQ answer.", + "id": "GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerFaqSource", + "properties": { + "question": { + "description": "The corresponding FAQ question.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerGenerativeSource": { + "description": "Details about source of Generative answer.", + "id": "GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerGenerativeSource", + "properties": { + "snippets": { + "description": "All snippets used for this Generative Prediction, with their source URI and data.", + "items": { + "$ref": "GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerGenerativeSourceSnippet" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerGenerativeSourceSnippet": { + "description": "Snippet Source for a Generative Prediction.", + "id": "GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerGenerativeSourceSnippet", + "properties": { + "text": { + "description": "Text taken from that URI.", + "type": "string" + }, + "title": { + "description": "Title of the document.", + "type": "string" + }, + "uri": { + "description": "URI the data is sourced from.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2KnowledgeAssistAnswerSuggestedQuery": { + "description": "Represents a suggested query.", + "id": "GoogleCloudDialogflowV2KnowledgeAssistAnswerSuggestedQuery", + "properties": { + "queryText": { + "description": "Suggested query text.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2KnowledgeOperationMetadata": { "description": "Metadata in google::longrunning::Operation for Knowledge operations.", "id": "GoogleCloudDialogflowV2KnowledgeOperationMetadata", @@ -14481,14 +14645,16 @@ "ARTICLE_SUGGESTION", "FAQ", "SMART_REPLY", - "KNOWLEDGE_SEARCH" + "KNOWLEDGE_SEARCH", + "KNOWLEDGE_ASSIST" ], "enumDescriptions": [ "Unspecified feature type.", "Run article suggestion model for chat.", "Run FAQ model for chat.", "Run smart reply model for chat.", - "Run knowledge search with text input from agent or text generated query." + "Run knowledge search with text input from agent or text generated query.", + "Run knowledge assist with automatic query generation." ], "type": "string" } @@ -14582,6 +14748,27 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2SuggestKnowledgeAssistResponse": { + "description": "The response message for Participants.SuggestKnowledgeAssist.", + "id": "GoogleCloudDialogflowV2SuggestKnowledgeAssistResponse", + "properties": { + "contextSize": { + "description": "Number of messages prior to and including latest_message to compile the suggestion. It may be smaller than the SuggestKnowledgeAssistRequest.context_size field in the request if there are fewer messages in the conversation.", + "format": "int32", + "type": "integer" + }, + "knowledgeAssistAnswer": { + "$ref": "GoogleCloudDialogflowV2KnowledgeAssistAnswer", + "description": "Output only. Knowledge Assist suggestion.", + "readOnly": true + }, + "latestMessage": { + "description": "The name of the latest conversation message used to compile suggestion for. Format: `projects//locations//conversations//messages/`.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2SuggestSmartRepliesResponse": { "description": "The response message for Participants.SuggestSmartReplies.", "id": "GoogleCloudDialogflowV2SuggestSmartRepliesResponse", @@ -14622,6 +14809,10 @@ "$ref": "GoogleCloudDialogflowV2SuggestFaqAnswersResponse", "description": "SuggestFaqAnswersResponse if request is for FAQ_ANSWER." }, + "suggestKnowledgeAssistResponse": { + "$ref": "GoogleCloudDialogflowV2SuggestKnowledgeAssistResponse", + "description": "SuggestKnowledgeAssistResponse if request is for KNOWLEDGE_ASSIST." + }, "suggestSmartRepliesResponse": { "$ref": "GoogleCloudDialogflowV2SuggestSmartRepliesResponse", "description": "SuggestSmartRepliesResponse if request is for SMART_REPLY." @@ -14834,7 +15025,8 @@ "SMART_REPLY", "DIALOGFLOW_ASSIST", "CONVERSATION_SUMMARIZATION", - "KNOWLEDGE_SEARCH" + "KNOWLEDGE_SEARCH", + "KNOWLEDGE_ASSIST" ], "enumDescriptions": [ "Unspecified feature type.", @@ -14843,7 +15035,8 @@ "Run smart reply model for chat.", "Run Dialogflow assist model for chat, which will return automated agent response as suggestion.", "Run conversation summarization model for chat.", - "Run knowledge search with text input from agent or text generated query." + "Run knowledge search with text input from agent or text generated query.", + "Run knowledge assist with automatic query generation." ], "type": "string" } @@ -16421,6 +16614,99 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2beta1KnowledgeAssistAnswer": { + "description": "Represents a Knowledge Assist answer.", + "id": "GoogleCloudDialogflowV2beta1KnowledgeAssistAnswer", + "properties": { + "answerRecord": { + "description": "The name of the answer record. Format: `projects//locations//answer Records/`.", + "type": "string" + }, + "suggestedQuery": { + "$ref": "GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerSuggestedQuery", + "description": "The query suggested based on the context. Suggestion is made only if it is different from the previous suggestion." + }, + "suggestedQueryAnswer": { + "$ref": "GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswer", + "description": "The answer generated for the suggested query. Whether or not an answer is generated depends on how confident we are about the generated query." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswer": { + "description": "Represents an answer from Knowledge. Currently supports FAQ and Generative answers.", + "id": "GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswer", + "properties": { + "answerText": { + "description": "The piece of text from the `source` that answers this suggested query.", + "type": "string" + }, + "faqSource": { + "$ref": "GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerFaqSource", + "description": "Populated if the prediction came from FAQ." + }, + "generativeSource": { + "$ref": "GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerGenerativeSource", + "description": "Populated if the prediction was Generative." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerFaqSource": { + "description": "Details about source of FAQ answer.", + "id": "GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerFaqSource", + "properties": { + "question": { + "description": "The corresponding FAQ question.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerGenerativeSource": { + "description": "Details about source of Generative answer.", + "id": "GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerGenerativeSource", + "properties": { + "snippets": { + "description": "All snippets used for this Generative Prediction, with their source URI and data.", + "items": { + "$ref": "GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerGenerativeSourceSnippet" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerGenerativeSourceSnippet": { + "description": "Snippet Source for a Generative Prediction.", + "id": "GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerGenerativeSourceSnippet", + "properties": { + "text": { + "description": "Text taken from that URI.", + "type": "string" + }, + "title": { + "description": "Title of the document.", + "type": "string" + }, + "uri": { + "description": "URI the data is sourced from.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerSuggestedQuery": { + "description": "Represents a suggested query.", + "id": "GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerSuggestedQuery", + "properties": { + "queryText": { + "description": "Suggested query text.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2beta1KnowledgeOperationMetadata": { "description": "Metadata in google::longrunning::Operation for Knowledge operations.", "id": "GoogleCloudDialogflowV2beta1KnowledgeOperationMetadata", @@ -16749,7 +17035,8 @@ "SMART_REPLY", "DIALOGFLOW_ASSIST", "CONVERSATION_SUMMARIZATION", - "KNOWLEDGE_SEARCH" + "KNOWLEDGE_SEARCH", + "KNOWLEDGE_ASSIST" ], "enumDescriptions": [ "Unspecified feature type.", @@ -16758,7 +17045,8 @@ "Run smart reply model for chat.", "Run Dialogflow assist model for chat, which will return automated agent response as suggestion.", "Run conversation summarization model for chat.", - "Run knowledge search with text input from agent or text generated query." + "Run knowledge search with text input from agent or text generated query.", + "Run knowledge assist with automatic query generation." ], "type": "string" } @@ -16854,6 +17142,27 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2beta1SuggestKnowledgeAssistResponse": { + "description": "The response message for Participants.SuggestKnowledgeAssist.", + "id": "GoogleCloudDialogflowV2beta1SuggestKnowledgeAssistResponse", + "properties": { + "contextSize": { + "description": "Number of messages prior to and including latest_message to compile the suggestion. It may be smaller than the SuggestKnowledgeAssistRequest.context_size field in the request if there are fewer messages in the conversation.", + "format": "int32", + "type": "integer" + }, + "knowledgeAssistAnswer": { + "$ref": "GoogleCloudDialogflowV2beta1KnowledgeAssistAnswer", + "description": "Output only. Knowledge Assist suggestion.", + "readOnly": true + }, + "latestMessage": { + "description": "The name of the latest conversation message used to compile suggestion for. Format: `projects//locations//conversations//messages/`.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2beta1SuggestSmartRepliesResponse": { "description": "The response message for Participants.SuggestSmartReplies.", "id": "GoogleCloudDialogflowV2beta1SuggestSmartRepliesResponse", @@ -16901,6 +17210,10 @@ "$ref": "GoogleCloudDialogflowV2beta1SuggestFaqAnswersResponse", "description": "SuggestFaqAnswersResponse if request is for FAQ_ANSWER." }, + "suggestKnowledgeAssistResponse": { + "$ref": "GoogleCloudDialogflowV2beta1SuggestKnowledgeAssistResponse", + "description": "SuggestKnowledgeAssistResponse if request is for KNOWLEDGE_ASSIST." + }, "suggestSmartRepliesResponse": { "$ref": "GoogleCloudDialogflowV2beta1SuggestSmartRepliesResponse", "description": "SuggestSmartRepliesResponse if request is for SMART_REPLY." diff --git a/dialogflow/v3/dialogflow-gen.go b/dialogflow/v3/dialogflow-gen.go index 7f78d1dd0a9..c13b975ae22 100644 --- a/dialogflow/v3/dialogflow-gen.go +++ b/dialogflow/v3/dialogflow-gen.go @@ -557,10 +557,9 @@ func (s *GoogleCloudDialogflowCxV3AdvancedSettingsDtmfSettings) MarshalJSON() ([ // GoogleCloudDialogflowCxV3AdvancedSettingsLoggingSettings: Define behaviors // on logging. type GoogleCloudDialogflowCxV3AdvancedSettingsLoggingSettings struct { - // EnableInteractionLogging: If true, DF Interaction logging is currently - // enabled. + // EnableInteractionLogging: Enables DF Interaction logging. EnableInteractionLogging bool `json:"enableInteractionLogging,omitempty"` - // EnableStackdriverLogging: If true, StackDriver logging is currently enabled. + // EnableStackdriverLogging: Enables StackDriver logging. EnableStackdriverLogging bool `json:"enableStackdriverLogging,omitempty"` // ForceSendFields is a list of field names (e.g. "EnableInteractionLogging") // to unconditionally include in API requests. By default, fields with empty or @@ -8807,10 +8806,9 @@ func (s *GoogleCloudDialogflowCxV3beta1AdvancedSettingsDtmfSettings) MarshalJSON // GoogleCloudDialogflowCxV3beta1AdvancedSettingsLoggingSettings: Define // behaviors on logging. type GoogleCloudDialogflowCxV3beta1AdvancedSettingsLoggingSettings struct { - // EnableInteractionLogging: If true, DF Interaction logging is currently - // enabled. + // EnableInteractionLogging: Enables DF Interaction logging. EnableInteractionLogging bool `json:"enableInteractionLogging,omitempty"` - // EnableStackdriverLogging: If true, StackDriver logging is currently enabled. + // EnableStackdriverLogging: Enables StackDriver logging. EnableStackdriverLogging bool `json:"enableStackdriverLogging,omitempty"` // ForceSendFields is a list of field names (e.g. "EnableInteractionLogging") // to unconditionally include in API requests. By default, fields with empty or @@ -10852,6 +10850,8 @@ type GoogleCloudDialogflowCxV3beta1QueryInput struct { LanguageCode string `json:"languageCode,omitempty"` // Text: The natural language text to be processed. Text *GoogleCloudDialogflowCxV3beta1TextInput `json:"text,omitempty"` + // ToolCallResult: The results of a tool executed by the client. + ToolCallResult *GoogleCloudDialogflowCxV3beta1ToolCallResult `json:"toolCallResult,omitempty"` // ForceSendFields is a list of field names (e.g. "Audio") to unconditionally // include in API requests. By default, fields with empty or default values are // omitted from API requests. See @@ -10944,6 +10944,9 @@ type GoogleCloudDialogflowCxV3beta1ResponseMessage struct { TelephonyTransferCall *GoogleCloudDialogflowCxV3beta1ResponseMessageTelephonyTransferCall `json:"telephonyTransferCall,omitempty"` // Text: Returns a text response. Text *GoogleCloudDialogflowCxV3beta1ResponseMessageText `json:"text,omitempty"` + // ToolCall: Returns the definition of a tool call that should be executed by + // the client. + ToolCall *GoogleCloudDialogflowCxV3beta1ToolCall `json:"toolCall,omitempty"` // ForceSendFields is a list of field names (e.g. "Channel") to unconditionally // include in API requests. By default, fields with empty or default values are // omitted from API requests. See @@ -11539,6 +11542,87 @@ func (s *GoogleCloudDialogflowCxV3beta1TextInput) MarshalJSON() ([]byte, error) return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields) } +// GoogleCloudDialogflowCxV3beta1ToolCall: Represents a call of a specific +// tool's action with the specified inputs. +type GoogleCloudDialogflowCxV3beta1ToolCall struct { + // Action: Required. The name of the tool's action associated with this call. + Action string `json:"action,omitempty"` + // InputParameters: Optional. The action's input parameters. + InputParameters googleapi.RawMessage `json:"inputParameters,omitempty"` + // Tool: Required. The tool associated with this call. Format: + // `projects//locations//agents//tools/`. + Tool string `json:"tool,omitempty"` + // ForceSendFields is a list of field names (e.g. "Action") to unconditionally + // include in API requests. By default, fields with empty or default values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "Action") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDialogflowCxV3beta1ToolCall) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDialogflowCxV3beta1ToolCall + return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields) +} + +// GoogleCloudDialogflowCxV3beta1ToolCallResult: The result of calling a tool's +// action that has been executed by the client. +type GoogleCloudDialogflowCxV3beta1ToolCallResult struct { + // Action: Required. The name of the tool's action associated with this call. + Action string `json:"action,omitempty"` + // Error: The tool call's error. + Error *GoogleCloudDialogflowCxV3beta1ToolCallResultError `json:"error,omitempty"` + // OutputParameters: The tool call's output parameters. + OutputParameters googleapi.RawMessage `json:"outputParameters,omitempty"` + // Tool: Required. The tool associated with this call. Format: + // `projects//locations//agents//tools/`. + Tool string `json:"tool,omitempty"` + // ForceSendFields is a list of field names (e.g. "Action") to unconditionally + // include in API requests. By default, fields with empty or default values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "Action") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDialogflowCxV3beta1ToolCallResult) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDialogflowCxV3beta1ToolCallResult + return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields) +} + +// GoogleCloudDialogflowCxV3beta1ToolCallResultError: An error produced by the +// tool call. +type GoogleCloudDialogflowCxV3beta1ToolCallResultError struct { + // Message: Optional. The error message of the function. + Message string `json:"message,omitempty"` + // ForceSendFields is a list of field names (e.g. "Message") to unconditionally + // include in API requests. By default, fields with empty or default values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "Message") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDialogflowCxV3beta1ToolCallResultError) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDialogflowCxV3beta1ToolCallResultError + return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields) +} + // GoogleCloudDialogflowCxV3beta1TransitionRoute: A transition route specifies // a intent that can be matched and/or a data condition that can be evaluated // during a session. When a specified transition is matched, the following @@ -12348,6 +12432,7 @@ type GoogleCloudDialogflowV2ClearSuggestionFeatureConfigOperationMetadata struct // "SMART_REPLY" - Run smart reply model for chat. // "KNOWLEDGE_SEARCH" - Run knowledge search with text input from agent or // text generated query. + // "KNOWLEDGE_ASSIST" - Run knowledge assist with automatic query generation. SuggestionFeatureType string `json:"suggestionFeatureType,omitempty"` // ForceSendFields is a list of field names (e.g. "ConversationProfile") to // unconditionally include in API requests. By default, fields with empty or @@ -14207,6 +14292,162 @@ func (s *GoogleCloudDialogflowV2IntentTrainingPhrasePart) MarshalJSON() ([]byte, return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields) } +// GoogleCloudDialogflowV2KnowledgeAssistAnswer: Represents a Knowledge Assist +// answer. +type GoogleCloudDialogflowV2KnowledgeAssistAnswer struct { + // AnswerRecord: The name of the answer record. Format: + // `projects//locations//answer Records/`. + AnswerRecord string `json:"answerRecord,omitempty"` + // SuggestedQuery: The query suggested based on the context. Suggestion is made + // only if it is different from the previous suggestion. + SuggestedQuery *GoogleCloudDialogflowV2KnowledgeAssistAnswerSuggestedQuery `json:"suggestedQuery,omitempty"` + // SuggestedQueryAnswer: The answer generated for the suggested query. Whether + // or not an answer is generated depends on how confident we are about the + // generated query. + SuggestedQueryAnswer *GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswer `json:"suggestedQueryAnswer,omitempty"` + // ForceSendFields is a list of field names (e.g. "AnswerRecord") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "AnswerRecord") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDialogflowV2KnowledgeAssistAnswer) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDialogflowV2KnowledgeAssistAnswer + return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields) +} + +// GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswer: Represents an +// answer from Knowledge. Currently supports FAQ and Generative answers. +type GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswer struct { + // AnswerText: The piece of text from the `source` that answers this suggested + // query. + AnswerText string `json:"answerText,omitempty"` + // FaqSource: Populated if the prediction came from FAQ. + FaqSource *GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerFaqSource `json:"faqSource,omitempty"` + // GenerativeSource: Populated if the prediction was Generative. + GenerativeSource *GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerGenerativeSource `json:"generativeSource,omitempty"` + // ForceSendFields is a list of field names (e.g. "AnswerText") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "AnswerText") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswer) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswer + return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields) +} + +// GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerFaqSource: +// Details about source of FAQ answer. +type GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerFaqSource struct { + // Question: The corresponding FAQ question. + Question string `json:"question,omitempty"` + // ForceSendFields is a list of field names (e.g. "Question") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "Question") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerFaqSource) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerFaqSource + return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields) +} + +// GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerGenerativeSource: +// Details about source of Generative answer. +type GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerGenerativeSource struct { + // Snippets: All snippets used for this Generative Prediction, with their + // source URI and data. + Snippets []*GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerGenerativeSourceSnippet `json:"snippets,omitempty"` + // ForceSendFields is a list of field names (e.g. "Snippets") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "Snippets") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerGenerativeSource) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerGenerativeSource + return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields) +} + +// GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerGenerativeSourceSn +// ippet: Snippet Source for a Generative Prediction. +type GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerGenerativeSourceSnippet struct { + // Text: Text taken from that URI. + Text string `json:"text,omitempty"` + // Title: Title of the document. + Title string `json:"title,omitempty"` + // Uri: URI the data is sourced from. + Uri string `json:"uri,omitempty"` + // ForceSendFields is a list of field names (e.g. "Text") to unconditionally + // include in API requests. By default, fields with empty or default values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "Text") to include in API requests + // with the JSON null value. By default, fields with empty values are omitted + // from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerGenerativeSourceSnippet) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerGenerativeSourceSnippet + return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields) +} + +// GoogleCloudDialogflowV2KnowledgeAssistAnswerSuggestedQuery: Represents a +// suggested query. +type GoogleCloudDialogflowV2KnowledgeAssistAnswerSuggestedQuery struct { + // QueryText: Suggested query text. + QueryText string `json:"queryText,omitempty"` + // ForceSendFields is a list of field names (e.g. "QueryText") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "QueryText") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDialogflowV2KnowledgeAssistAnswerSuggestedQuery) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDialogflowV2KnowledgeAssistAnswerSuggestedQuery + return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields) +} + // GoogleCloudDialogflowV2KnowledgeOperationMetadata: Metadata in // google::longrunning::Operation for Knowledge operations. type GoogleCloudDialogflowV2KnowledgeOperationMetadata struct { @@ -14635,6 +14876,7 @@ type GoogleCloudDialogflowV2SetSuggestionFeatureConfigOperationMetadata struct { // "SMART_REPLY" - Run smart reply model for chat. // "KNOWLEDGE_SEARCH" - Run knowledge search with text input from agent or // text generated query. + // "KNOWLEDGE_ASSIST" - Run knowledge assist with automatic query generation. SuggestionFeatureType string `json:"suggestionFeatureType,omitempty"` // ForceSendFields is a list of field names (e.g. "ConversationProfile") to // unconditionally include in API requests. By default, fields with empty or @@ -14789,6 +15031,37 @@ func (s *GoogleCloudDialogflowV2SuggestFaqAnswersResponse) MarshalJSON() ([]byte return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields) } +// GoogleCloudDialogflowV2SuggestKnowledgeAssistResponse: The response message +// for Participants.SuggestKnowledgeAssist. +type GoogleCloudDialogflowV2SuggestKnowledgeAssistResponse struct { + // ContextSize: Number of messages prior to and including latest_message to + // compile the suggestion. It may be smaller than the + // SuggestKnowledgeAssistRequest.context_size field in the request if there are + // fewer messages in the conversation. + ContextSize int64 `json:"contextSize,omitempty"` + // KnowledgeAssistAnswer: Output only. Knowledge Assist suggestion. + KnowledgeAssistAnswer *GoogleCloudDialogflowV2KnowledgeAssistAnswer `json:"knowledgeAssistAnswer,omitempty"` + // LatestMessage: The name of the latest conversation message used to compile + // suggestion for. Format: `projects//locations//conversations//messages/`. + LatestMessage string `json:"latestMessage,omitempty"` + // ForceSendFields is a list of field names (e.g. "ContextSize") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "ContextSize") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDialogflowV2SuggestKnowledgeAssistResponse) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDialogflowV2SuggestKnowledgeAssistResponse + return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields) +} + // GoogleCloudDialogflowV2SuggestSmartRepliesResponse: The response message for // Participants.SuggestSmartReplies. type GoogleCloudDialogflowV2SuggestSmartRepliesResponse struct { @@ -14835,6 +15108,9 @@ type GoogleCloudDialogflowV2SuggestionResult struct { // SuggestFaqAnswersResponse: SuggestFaqAnswersResponse if request is for // FAQ_ANSWER. SuggestFaqAnswersResponse *GoogleCloudDialogflowV2SuggestFaqAnswersResponse `json:"suggestFaqAnswersResponse,omitempty"` + // SuggestKnowledgeAssistResponse: SuggestKnowledgeAssistResponse if request is + // for KNOWLEDGE_ASSIST. + SuggestKnowledgeAssistResponse *GoogleCloudDialogflowV2SuggestKnowledgeAssistResponse `json:"suggestKnowledgeAssistResponse,omitempty"` // SuggestSmartRepliesResponse: SuggestSmartRepliesResponse if request is for // SMART_REPLY. SuggestSmartRepliesResponse *GoogleCloudDialogflowV2SuggestSmartRepliesResponse `json:"suggestSmartRepliesResponse,omitempty"` @@ -15130,6 +15406,7 @@ type GoogleCloudDialogflowV2beta1ClearSuggestionFeatureConfigOperationMetadata s // chat. // "KNOWLEDGE_SEARCH" - Run knowledge search with text input from agent or // text generated query. + // "KNOWLEDGE_ASSIST" - Run knowledge assist with automatic query generation. SuggestionFeatureType string `json:"suggestionFeatureType,omitempty"` // ForceSendFields is a list of field names (e.g. "ConversationProfile") to // unconditionally include in API requests. By default, fields with empty or @@ -17281,6 +17558,162 @@ func (s *GoogleCloudDialogflowV2beta1KnowledgeAnswersAnswer) UnmarshalJSON(data return nil } +// GoogleCloudDialogflowV2beta1KnowledgeAssistAnswer: Represents a Knowledge +// Assist answer. +type GoogleCloudDialogflowV2beta1KnowledgeAssistAnswer struct { + // AnswerRecord: The name of the answer record. Format: + // `projects//locations//answer Records/`. + AnswerRecord string `json:"answerRecord,omitempty"` + // SuggestedQuery: The query suggested based on the context. Suggestion is made + // only if it is different from the previous suggestion. + SuggestedQuery *GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerSuggestedQuery `json:"suggestedQuery,omitempty"` + // SuggestedQueryAnswer: The answer generated for the suggested query. Whether + // or not an answer is generated depends on how confident we are about the + // generated query. + SuggestedQueryAnswer *GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswer `json:"suggestedQueryAnswer,omitempty"` + // ForceSendFields is a list of field names (e.g. "AnswerRecord") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "AnswerRecord") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDialogflowV2beta1KnowledgeAssistAnswer) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDialogflowV2beta1KnowledgeAssistAnswer + return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields) +} + +// GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswer: Represents +// an answer from Knowledge. Currently supports FAQ and Generative answers. +type GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswer struct { + // AnswerText: The piece of text from the `source` that answers this suggested + // query. + AnswerText string `json:"answerText,omitempty"` + // FaqSource: Populated if the prediction came from FAQ. + FaqSource *GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerFaqSource `json:"faqSource,omitempty"` + // GenerativeSource: Populated if the prediction was Generative. + GenerativeSource *GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerGenerativeSource `json:"generativeSource,omitempty"` + // ForceSendFields is a list of field names (e.g. "AnswerText") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "AnswerText") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswer) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswer + return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields) +} + +// GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerFaqSource: +// Details about source of FAQ answer. +type GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerFaqSource struct { + // Question: The corresponding FAQ question. + Question string `json:"question,omitempty"` + // ForceSendFields is a list of field names (e.g. "Question") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "Question") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerFaqSource) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerFaqSource + return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields) +} + +// GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerGenerativeSou +// rce: Details about source of Generative answer. +type GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerGenerativeSource struct { + // Snippets: All snippets used for this Generative Prediction, with their + // source URI and data. + Snippets []*GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerGenerativeSourceSnippet `json:"snippets,omitempty"` + // ForceSendFields is a list of field names (e.g. "Snippets") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "Snippets") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerGenerativeSource) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerGenerativeSource + return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields) +} + +// GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerGenerativeSou +// rceSnippet: Snippet Source for a Generative Prediction. +type GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerGenerativeSourceSnippet struct { + // Text: Text taken from that URI. + Text string `json:"text,omitempty"` + // Title: Title of the document. + Title string `json:"title,omitempty"` + // Uri: URI the data is sourced from. + Uri string `json:"uri,omitempty"` + // ForceSendFields is a list of field names (e.g. "Text") to unconditionally + // include in API requests. By default, fields with empty or default values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "Text") to include in API requests + // with the JSON null value. By default, fields with empty values are omitted + // from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerGenerativeSourceSnippet) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerGenerativeSourceSnippet + return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields) +} + +// GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerSuggestedQuery: Represents +// a suggested query. +type GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerSuggestedQuery struct { + // QueryText: Suggested query text. + QueryText string `json:"queryText,omitempty"` + // ForceSendFields is a list of field names (e.g. "QueryText") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "QueryText") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerSuggestedQuery) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerSuggestedQuery + return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields) +} + // GoogleCloudDialogflowV2beta1KnowledgeOperationMetadata: Metadata in // google::longrunning::Operation for Knowledge operations. type GoogleCloudDialogflowV2beta1KnowledgeOperationMetadata struct { @@ -17721,6 +18154,7 @@ type GoogleCloudDialogflowV2beta1SetSuggestionFeatureConfigOperationMetadata str // chat. // "KNOWLEDGE_SEARCH" - Run knowledge search with text input from agent or // text generated query. + // "KNOWLEDGE_ASSIST" - Run knowledge assist with automatic query generation. SuggestionFeatureType string `json:"suggestionFeatureType,omitempty"` // ForceSendFields is a list of field names (e.g. "ConversationProfile") to // unconditionally include in API requests. By default, fields with empty or @@ -17879,6 +18313,37 @@ func (s *GoogleCloudDialogflowV2beta1SuggestFaqAnswersResponse) MarshalJSON() ([ return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields) } +// GoogleCloudDialogflowV2beta1SuggestKnowledgeAssistResponse: The response +// message for Participants.SuggestKnowledgeAssist. +type GoogleCloudDialogflowV2beta1SuggestKnowledgeAssistResponse struct { + // ContextSize: Number of messages prior to and including latest_message to + // compile the suggestion. It may be smaller than the + // SuggestKnowledgeAssistRequest.context_size field in the request if there are + // fewer messages in the conversation. + ContextSize int64 `json:"contextSize,omitempty"` + // KnowledgeAssistAnswer: Output only. Knowledge Assist suggestion. + KnowledgeAssistAnswer *GoogleCloudDialogflowV2beta1KnowledgeAssistAnswer `json:"knowledgeAssistAnswer,omitempty"` + // LatestMessage: The name of the latest conversation message used to compile + // suggestion for. Format: `projects//locations//conversations//messages/`. + LatestMessage string `json:"latestMessage,omitempty"` + // ForceSendFields is a list of field names (e.g. "ContextSize") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "ContextSize") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDialogflowV2beta1SuggestKnowledgeAssistResponse) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDialogflowV2beta1SuggestKnowledgeAssistResponse + return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields) +} + // GoogleCloudDialogflowV2beta1SuggestSmartRepliesResponse: The response // message for Participants.SuggestSmartReplies. type GoogleCloudDialogflowV2beta1SuggestSmartRepliesResponse struct { @@ -17931,6 +18396,9 @@ type GoogleCloudDialogflowV2beta1SuggestionResult struct { // SuggestFaqAnswersResponse: SuggestFaqAnswersResponse if request is for // FAQ_ANSWER. SuggestFaqAnswersResponse *GoogleCloudDialogflowV2beta1SuggestFaqAnswersResponse `json:"suggestFaqAnswersResponse,omitempty"` + // SuggestKnowledgeAssistResponse: SuggestKnowledgeAssistResponse if request is + // for KNOWLEDGE_ASSIST. + SuggestKnowledgeAssistResponse *GoogleCloudDialogflowV2beta1SuggestKnowledgeAssistResponse `json:"suggestKnowledgeAssistResponse,omitempty"` // SuggestSmartRepliesResponse: SuggestSmartRepliesResponse if request is for // SMART_REPLY. SuggestSmartRepliesResponse *GoogleCloudDialogflowV2beta1SuggestSmartRepliesResponse `json:"suggestSmartRepliesResponse,omitempty"` diff --git a/discoveryengine/v1/discoveryengine-api.json b/discoveryengine/v1/discoveryengine-api.json index acb34452f1a..d2e36428143 100644 --- a/discoveryengine/v1/discoveryengine-api.json +++ b/discoveryengine/v1/discoveryengine-api.json @@ -789,7 +789,7 @@ "type": "string" }, "parent": { - "description": "Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}`", + "description": "Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", "required": true, @@ -883,7 +883,7 @@ "type": "string" }, "parent": { - "description": "Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}`", + "description": "Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", "required": true, @@ -2594,7 +2594,7 @@ "type": "string" }, "parent": { - "description": "Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}`", + "description": "Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$", "required": true, @@ -2688,7 +2688,7 @@ "type": "string" }, "parent": { - "description": "Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}`", + "description": "Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$", "required": true, @@ -3928,7 +3928,7 @@ "type": "string" }, "parent": { - "description": "Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}`", + "description": "Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", "required": true, @@ -4022,7 +4022,7 @@ "type": "string" }, "parent": { - "description": "Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}`", + "description": "Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", "required": true, @@ -5550,7 +5550,7 @@ } } }, - "revision": "20240526", + "revision": "20240530", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -5699,6 +5699,37 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1AlloyDbSource": { + "description": "AlloyDB source import data from.", + "id": "GoogleCloudDiscoveryengineV1AlloyDbSource", + "properties": { + "clusterId": { + "description": "Required. The AlloyDB cluster to copy the data from with a length limit of 256 characters.", + "type": "string" + }, + "databaseId": { + "description": "Required. The AlloyDB database to copy the data from with a length limit of 256 characters.", + "type": "string" + }, + "gcsStagingDir": { + "description": "Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the AlloyDB export to a specific Cloud Storage directory. Ensure that the AlloyDB service account has the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory.", + "type": "string" + }, + "locationId": { + "description": "Required. The AlloyDB location to copy the data from with a length limit of 256 characters.", + "type": "string" + }, + "projectId": { + "description": "The project ID that the AlloyDB source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.", + "type": "string" + }, + "tableId": { + "description": "Required. The AlloyDB table to copy the data from with a length limit of 256 characters.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1Answer": { "description": "Defines an answer.", "id": "GoogleCloudDiscoveryengineV1Answer", @@ -5866,6 +5897,13 @@ "description": "The session resource name. Not required. When session field is not set, the API is in sessionless mode. We support auto session mode: users can use the wildcard symbol `-` as session ID. A new ID will be automatically generated and assigned.", "type": "string" }, + "userLabels": { + "additionalProperties": { + "type": "string" + }, + "description": "The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.", + "type": "object" + }, "userPseudoId": { "description": "A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", "type": "string" @@ -7658,6 +7696,10 @@ "description": "A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config.", "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfig", "properties": { + "chunkingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig", + "description": "Whether chunking mode is enabled." + }, "defaultParsingConfig": { "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig", "description": "Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing." @@ -7676,6 +7718,33 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig": { + "description": "Configuration for chunking config.", + "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig", + "properties": { + "layoutBasedChunkingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", + "description": "Configuration for the layout based chunking." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig": { + "description": "Configuration for the layout based chunking.", + "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", + "properties": { + "chunkSize": { + "description": "The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500.", + "format": "int32", + "type": "integer" + }, + "includeAncestorHeadings": { + "description": "Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False.", + "type": "boolean" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig": { "description": "Related configurations applied to a specific type of document parser.", "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig", @@ -7684,6 +7753,10 @@ "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig", "description": "Configurations applied to digital parser." }, + "layoutParsingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig", + "description": "Configurations applied to layout parser." + }, "ocrParsingConfig": { "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig", "description": "Configurations applied to OCR parser. Currently it only applies to PDFs." @@ -7697,6 +7770,12 @@ "properties": {}, "type": "object" }, + "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig": { + "description": "The layout parsing configurations for documents.", + "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig", + "properties": {}, + "type": "object" + }, "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig": { "description": "The OCR parsing configurations for documents.", "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig", @@ -8086,6 +8165,10 @@ "description": "Request message for Import methods.", "id": "GoogleCloudDiscoveryengineV1ImportDocumentsRequest", "properties": { + "alloyDbSource": { + "$ref": "GoogleCloudDiscoveryengineV1AlloyDbSource", + "description": "AlloyDB input source." + }, "autoGenerateIds": { "description": "Whether to automatically generate IDs for the documents if absent. If set to `true`, Document.ids are automatically generated based on the hash of the payload, where IDs may not be consistent during multiple imports. In which case ReconciliationMode.FULL is highly recommended to avoid duplicate contents. If unset or set to `false`, Document.ids have to be specified using id_field, otherwise, documents without IDs fail to be imported. Supported data sources: * GcsSource. GcsSource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * BigQuerySource. BigQuerySource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * SpannerSource. * CloudSqlSource. * FirestoreSource. * BigtableSource.", "type": "boolean" @@ -13176,6 +13259,10 @@ "description": "A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config.", "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig", "properties": { + "chunkingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig", + "description": "Whether chunking mode is enabled." + }, "defaultParsingConfig": { "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig", "description": "Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing." @@ -13194,6 +13281,33 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig": { + "description": "Configuration for chunking config.", + "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig", + "properties": { + "layoutBasedChunkingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", + "description": "Configuration for the layout based chunking." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig": { + "description": "Configuration for the layout based chunking.", + "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", + "properties": { + "chunkSize": { + "description": "The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500.", + "format": "int32", + "type": "integer" + }, + "includeAncestorHeadings": { + "description": "Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False.", + "type": "boolean" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig": { "description": "Related configurations applied to a specific type of document parser.", "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig", @@ -13202,6 +13316,10 @@ "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig", "description": "Configurations applied to digital parser." }, + "layoutParsingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig", + "description": "Configurations applied to layout parser." + }, "ocrParsingConfig": { "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig", "description": "Configurations applied to OCR parser. Currently it only applies to PDFs." @@ -13215,6 +13333,12 @@ "properties": {}, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig": { + "description": "The layout parsing configurations for documents.", + "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig", + "properties": {}, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig": { "description": "The OCR parsing configurations for documents.", "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig", diff --git a/discoveryengine/v1/discoveryengine-gen.go b/discoveryengine/v1/discoveryengine-gen.go index 2f1cf96a70f..f4f632d21d8 100644 --- a/discoveryengine/v1/discoveryengine-gen.go +++ b/discoveryengine/v1/discoveryengine-gen.go @@ -1039,6 +1039,48 @@ func (s *GoogleCloudDiscoveryengineLoggingSourceLocation) MarshalJSON() ([]byte, return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields) } +// GoogleCloudDiscoveryengineV1AlloyDbSource: AlloyDB source import data from. +type GoogleCloudDiscoveryengineV1AlloyDbSource struct { + // ClusterId: Required. The AlloyDB cluster to copy the data from with a length + // limit of 256 characters. + ClusterId string `json:"clusterId,omitempty"` + // DatabaseId: Required. The AlloyDB database to copy the data from with a + // length limit of 256 characters. + DatabaseId string `json:"databaseId,omitempty"` + // GcsStagingDir: Intermediate Cloud Storage directory used for the import with + // a length limit of 2,000 characters. Can be specified if one wants to have + // the AlloyDB export to a specific Cloud Storage directory. Ensure that the + // AlloyDB service account has the necessary Cloud Storage Admin permissions to + // access the specified Cloud Storage directory. + GcsStagingDir string `json:"gcsStagingDir,omitempty"` + // LocationId: Required. The AlloyDB location to copy the data from with a + // length limit of 256 characters. + LocationId string `json:"locationId,omitempty"` + // ProjectId: The project ID that the AlloyDB source is in with a length limit + // of 128 characters. If not specified, inherits the project ID from the parent + // request. + ProjectId string `json:"projectId,omitempty"` + // TableId: Required. The AlloyDB table to copy the data from with a length + // limit of 256 characters. + TableId string `json:"tableId,omitempty"` + // ForceSendFields is a list of field names (e.g. "ClusterId") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "ClusterId") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDiscoveryengineV1AlloyDbSource) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDiscoveryengineV1AlloyDbSource + return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields) +} + // GoogleCloudDiscoveryengineV1Answer: Defines an answer. type GoogleCloudDiscoveryengineV1Answer struct { // AnswerSkippedReasons: Additional answer-skipped reasons. This provides the @@ -1180,6 +1222,19 @@ type GoogleCloudDiscoveryengineV1AnswerQueryRequest struct { // use the wildcard symbol `-` as session ID. A new ID will be automatically // generated and assigned. Session string `json:"session,omitempty"` + // UserLabels: The user labels applied to a resource must meet the following + // requirements: * Each resource can have multiple labels, up to a maximum of + // 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 + // character and a maximum length of 63 characters and cannot be empty. Values + // can be empty and have a maximum length of 63 characters. * Keys and values + // can contain only lowercase letters, numeric characters, underscores, and + // dashes. All characters must use UTF-8 encoding, and international characters + // are allowed. * The key portion of a label must be unique. However, you can + // use the same key with multiple resources. * Keys must start with a lowercase + // letter or international character. See Google Cloud Document + // (https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) + // for more details. + UserLabels map[string]string `json:"userLabels,omitempty"` // UserPseudoId: A unique identifier for tracking visitors. For example, this // could be implemented with an HTTP cookie, which should be able to uniquely // identify a visitor on a single device. This unique identifier should not @@ -3767,6 +3822,8 @@ func (s *GoogleCloudDiscoveryengineV1DocumentInfo) MarshalJSON() ([]byte, error) // DataStoreService.UpdateDocumentProcessingConfig method will initialize the // config. type GoogleCloudDiscoveryengineV1DocumentProcessingConfig struct { + // ChunkingConfig: Whether chunking mode is enabled. + ChunkingConfig *GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig `json:"chunkingConfig,omitempty"` // DefaultParsingConfig: Configurations for default Document parser. If not // specified, we will configure it as default DigitalParsingConfig, and the // default parsing config will be applied to all file types for Document @@ -3783,15 +3840,15 @@ type GoogleCloudDiscoveryengineV1DocumentProcessingConfig struct { // parsing config for DOCX files, only digital parsing and or layout parsing // are supported. ParsingConfigOverrides map[string]GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig `json:"parsingConfigOverrides,omitempty"` - // ForceSendFields is a list of field names (e.g. "DefaultParsingConfig") to + // ForceSendFields is a list of field names (e.g. "ChunkingConfig") to // unconditionally include in API requests. By default, fields with empty or // default values are omitted from API requests. See // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more // details. ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "DefaultParsingConfig") to include - // in API requests with the JSON null value. By default, fields with empty - // values are omitted from API requests. See + // NullFields is a list of field names (e.g. "ChunkingConfig") to include in + // API requests with the JSON null value. By default, fields with empty values + // are omitted from API requests. See // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. NullFields []string `json:"-"` } @@ -3801,11 +3858,64 @@ func (s *GoogleCloudDiscoveryengineV1DocumentProcessingConfig) MarshalJSON() ([] return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields) } +// GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig: +// Configuration for chunking config. +type GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig struct { + // LayoutBasedChunkingConfig: Configuration for the layout based chunking. + LayoutBasedChunkingConfig *GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig `json:"layoutBasedChunkingConfig,omitempty"` + // ForceSendFields is a list of field names (e.g. "LayoutBasedChunkingConfig") + // to unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "LayoutBasedChunkingConfig") to + // include in API requests with the JSON null value. By default, fields with + // empty values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig + return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields) +} + +// GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBased +// ChunkingConfig: Configuration for the layout based chunking. +type GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig struct { + // ChunkSize: The token size limit for each chunk. Supported values: 100-500 + // (inclusive). Default value: 500. + ChunkSize int64 `json:"chunkSize,omitempty"` + // IncludeAncestorHeadings: Whether to include appending different levels of + // headings to chunks from the middle of the document to prevent context loss. + // Default value: False. + IncludeAncestorHeadings bool `json:"includeAncestorHeadings,omitempty"` + // ForceSendFields is a list of field names (e.g. "ChunkSize") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "ChunkSize") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig + return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields) +} + // GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig: Related // configurations applied to a specific type of document parser. type GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig struct { // DigitalParsingConfig: Configurations applied to digital parser. DigitalParsingConfig *GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig `json:"digitalParsingConfig,omitempty"` + // LayoutParsingConfig: Configurations applied to layout parser. + LayoutParsingConfig *GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig `json:"layoutParsingConfig,omitempty"` // OcrParsingConfig: Configurations applied to OCR parser. Currently it only // applies to PDFs. OcrParsingConfig *GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig `json:"ocrParsingConfig,omitempty"` @@ -3832,6 +3942,11 @@ func (s *GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig) Mars type GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig struct { } +// GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsin +// gConfig: The layout parsing configurations for documents. +type GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig struct { +} + // GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingCo // nfig: The OCR parsing configurations for documents. type GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig struct { @@ -4375,6 +4490,8 @@ func (s *GoogleCloudDiscoveryengineV1ImportDocumentsMetadata) MarshalJSON() ([]b // GoogleCloudDiscoveryengineV1ImportDocumentsRequest: Request message for // Import methods. type GoogleCloudDiscoveryengineV1ImportDocumentsRequest struct { + // AlloyDbSource: AlloyDB input source. + AlloyDbSource *GoogleCloudDiscoveryengineV1AlloyDbSource `json:"alloyDbSource,omitempty"` // AutoGenerateIds: Whether to automatically generate IDs for the documents if // absent. If set to `true`, Document.ids are automatically generated based on // the hash of the payload, where IDs may not be consistent during multiple @@ -4436,15 +4553,15 @@ type GoogleCloudDiscoveryengineV1ImportDocumentsRequest struct { // UpdateMask: Indicates which fields in the provided imported documents to // update. If not set, the default is to update all fields. UpdateMask string `json:"updateMask,omitempty"` - // ForceSendFields is a list of field names (e.g. "AutoGenerateIds") to + // ForceSendFields is a list of field names (e.g. "AlloyDbSource") to // unconditionally include in API requests. By default, fields with empty or // default values are omitted from API requests. See // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more // details. ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "AutoGenerateIds") to include in - // API requests with the JSON null value. By default, fields with empty values - // are omitted from API requests. See + // NullFields is a list of field names (e.g. "AlloyDbSource") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. NullFields []string `json:"-"` } @@ -11492,6 +11609,8 @@ type GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchResponse struct { // DataStoreService.UpdateDocumentProcessingConfig method will initialize the // config. type GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig struct { + // ChunkingConfig: Whether chunking mode is enabled. + ChunkingConfig *GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig `json:"chunkingConfig,omitempty"` // DefaultParsingConfig: Configurations for default Document parser. If not // specified, we will configure it as default DigitalParsingConfig, and the // default parsing config will be applied to all file types for Document @@ -11508,15 +11627,15 @@ type GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig struct { // parsing config for DOCX files, only digital parsing and or layout parsing // are supported. ParsingConfigOverrides map[string]GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig `json:"parsingConfigOverrides,omitempty"` - // ForceSendFields is a list of field names (e.g. "DefaultParsingConfig") to + // ForceSendFields is a list of field names (e.g. "ChunkingConfig") to // unconditionally include in API requests. By default, fields with empty or // default values are omitted from API requests. See // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more // details. ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "DefaultParsingConfig") to include - // in API requests with the JSON null value. By default, fields with empty - // values are omitted from API requests. See + // NullFields is a list of field names (e.g. "ChunkingConfig") to include in + // API requests with the JSON null value. By default, fields with empty values + // are omitted from API requests. See // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. NullFields []string `json:"-"` } @@ -11526,11 +11645,64 @@ func (s *GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig) MarshalJSON() return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields) } +// GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig: +// Configuration for chunking config. +type GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig struct { + // LayoutBasedChunkingConfig: Configuration for the layout based chunking. + LayoutBasedChunkingConfig *GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig `json:"layoutBasedChunkingConfig,omitempty"` + // ForceSendFields is a list of field names (e.g. "LayoutBasedChunkingConfig") + // to unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "LayoutBasedChunkingConfig") to + // include in API requests with the JSON null value. By default, fields with + // empty values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig + return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields) +} + +// GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutB +// asedChunkingConfig: Configuration for the layout based chunking. +type GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig struct { + // ChunkSize: The token size limit for each chunk. Supported values: 100-500 + // (inclusive). Default value: 500. + ChunkSize int64 `json:"chunkSize,omitempty"` + // IncludeAncestorHeadings: Whether to include appending different levels of + // headings to chunks from the middle of the document to prevent context loss. + // Default value: False. + IncludeAncestorHeadings bool `json:"includeAncestorHeadings,omitempty"` + // ForceSendFields is a list of field names (e.g. "ChunkSize") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "ChunkSize") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig + return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields) +} + // GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig: // Related configurations applied to a specific type of document parser. type GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig struct { // DigitalParsingConfig: Configurations applied to digital parser. DigitalParsingConfig *GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig `json:"digitalParsingConfig,omitempty"` + // LayoutParsingConfig: Configurations applied to layout parser. + LayoutParsingConfig *GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig `json:"layoutParsingConfig,omitempty"` // OcrParsingConfig: Configurations applied to OCR parser. Currently it only // applies to PDFs. OcrParsingConfig *GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig `json:"ocrParsingConfig,omitempty"` @@ -11557,6 +11729,11 @@ func (s *GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig) type GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig struct { } +// GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutPa +// rsingConfig: The layout parsing configurations for documents. +type GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig struct { +} + // GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsi // ngConfig: The OCR parsing configurations for documents. type GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig struct { @@ -15240,7 +15417,9 @@ type ProjectsLocationsCollectionsDataStoresControlsCreateCall struct { // // - parent: Full resource name of parent data store. Format: // `projects/{project_number}/locations/{location_id}/collections/{collection_ -// id}/dataStores/{data_store_id}`. +// id}/dataStores/{data_store_id}` or +// `projects/{project_number}/locations/{location_id}/collections/{collection_ +// id}/engines/{engine_id}`. func (r *ProjectsLocationsCollectionsDataStoresControlsService) Create(parent string, googleclouddiscoveryenginev1control *GoogleCloudDiscoveryengineV1Control) *ProjectsLocationsCollectionsDataStoresControlsCreateCall { c := &ProjectsLocationsCollectionsDataStoresControlsCreateCall{s: r.s, urlParams_: make(gensupport.URLParams)} c.parent = parent @@ -15562,7 +15741,9 @@ type ProjectsLocationsCollectionsDataStoresControlsListCall struct { // // - parent: The data store resource name. Format: // `projects/{project_number}/locations/{location_id}/collections/{collection_ -// id}/dataStores/{data_store_id}`. +// id}/dataStores/{data_store_id}` or +// `projects/{project_number}/locations/{location_id}/collections/{collection_ +// id}/engines/{engine_id}`. func (r *ProjectsLocationsCollectionsDataStoresControlsService) List(parent string) *ProjectsLocationsCollectionsDataStoresControlsListCall { c := &ProjectsLocationsCollectionsDataStoresControlsListCall{s: r.s, urlParams_: make(gensupport.URLParams)} c.parent = parent @@ -21868,7 +22049,9 @@ type ProjectsLocationsCollectionsEnginesControlsCreateCall struct { // // - parent: Full resource name of parent data store. Format: // `projects/{project_number}/locations/{location_id}/collections/{collection_ -// id}/dataStores/{data_store_id}`. +// id}/dataStores/{data_store_id}` or +// `projects/{project_number}/locations/{location_id}/collections/{collection_ +// id}/engines/{engine_id}`. func (r *ProjectsLocationsCollectionsEnginesControlsService) Create(parent string, googleclouddiscoveryenginev1control *GoogleCloudDiscoveryengineV1Control) *ProjectsLocationsCollectionsEnginesControlsCreateCall { c := &ProjectsLocationsCollectionsEnginesControlsCreateCall{s: r.s, urlParams_: make(gensupport.URLParams)} c.parent = parent @@ -22190,7 +22373,9 @@ type ProjectsLocationsCollectionsEnginesControlsListCall struct { // // - parent: The data store resource name. Format: // `projects/{project_number}/locations/{location_id}/collections/{collection_ -// id}/dataStores/{data_store_id}`. +// id}/dataStores/{data_store_id}` or +// `projects/{project_number}/locations/{location_id}/collections/{collection_ +// id}/engines/{engine_id}`. func (r *ProjectsLocationsCollectionsEnginesControlsService) List(parent string) *ProjectsLocationsCollectionsEnginesControlsListCall { c := &ProjectsLocationsCollectionsEnginesControlsListCall{s: r.s, urlParams_: make(gensupport.URLParams)} c.parent = parent @@ -26798,7 +26983,9 @@ type ProjectsLocationsDataStoresControlsCreateCall struct { // // - parent: Full resource name of parent data store. Format: // `projects/{project_number}/locations/{location_id}/collections/{collection_ -// id}/dataStores/{data_store_id}`. +// id}/dataStores/{data_store_id}` or +// `projects/{project_number}/locations/{location_id}/collections/{collection_ +// id}/engines/{engine_id}`. func (r *ProjectsLocationsDataStoresControlsService) Create(parent string, googleclouddiscoveryenginev1control *GoogleCloudDiscoveryengineV1Control) *ProjectsLocationsDataStoresControlsCreateCall { c := &ProjectsLocationsDataStoresControlsCreateCall{s: r.s, urlParams_: make(gensupport.URLParams)} c.parent = parent @@ -27120,7 +27307,9 @@ type ProjectsLocationsDataStoresControlsListCall struct { // // - parent: The data store resource name. Format: // `projects/{project_number}/locations/{location_id}/collections/{collection_ -// id}/dataStores/{data_store_id}`. +// id}/dataStores/{data_store_id}` or +// `projects/{project_number}/locations/{location_id}/collections/{collection_ +// id}/engines/{engine_id}`. func (r *ProjectsLocationsDataStoresControlsService) List(parent string) *ProjectsLocationsDataStoresControlsListCall { c := &ProjectsLocationsDataStoresControlsListCall{s: r.s, urlParams_: make(gensupport.URLParams)} c.parent = parent diff --git a/discoveryengine/v1alpha/discoveryengine-api.json b/discoveryengine/v1alpha/discoveryengine-api.json index abc7c1b3015..4194cc3e440 100644 --- a/discoveryengine/v1alpha/discoveryengine-api.json +++ b/discoveryengine/v1alpha/discoveryengine-api.json @@ -1134,7 +1134,7 @@ "type": "string" }, "parent": { - "description": "Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}`", + "description": "Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", "required": true, @@ -1228,7 +1228,7 @@ "type": "string" }, "parent": { - "description": "Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}`", + "description": "Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", "required": true, @@ -3175,7 +3175,7 @@ "type": "string" }, "parent": { - "description": "Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}`", + "description": "Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$", "required": true, @@ -3269,7 +3269,7 @@ "type": "string" }, "parent": { - "description": "Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}`", + "description": "Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$", "required": true, @@ -4785,7 +4785,7 @@ "type": "string" }, "parent": { - "description": "Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}`", + "description": "Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", "required": true, @@ -4879,7 +4879,7 @@ "type": "string" }, "parent": { - "description": "Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}`", + "description": "Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", "required": true, @@ -6568,7 +6568,7 @@ } } }, - "revision": "20240526", + "revision": "20240530", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -7192,6 +7192,10 @@ "description": "A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config.", "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfig", "properties": { + "chunkingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig", + "description": "Whether chunking mode is enabled." + }, "defaultParsingConfig": { "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig", "description": "Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing." @@ -7210,6 +7214,33 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig": { + "description": "Configuration for chunking config.", + "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig", + "properties": { + "layoutBasedChunkingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", + "description": "Configuration for the layout based chunking." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig": { + "description": "Configuration for the layout based chunking.", + "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", + "properties": { + "chunkSize": { + "description": "The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500.", + "format": "int32", + "type": "integer" + }, + "includeAncestorHeadings": { + "description": "Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False.", + "type": "boolean" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig": { "description": "Related configurations applied to a specific type of document parser.", "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig", @@ -7218,6 +7249,10 @@ "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig", "description": "Configurations applied to digital parser." }, + "layoutParsingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig", + "description": "Configurations applied to layout parser." + }, "ocrParsingConfig": { "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig", "description": "Configurations applied to OCR parser. Currently it only applies to PDFs." @@ -7231,6 +7266,12 @@ "properties": {}, "type": "object" }, + "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig": { + "description": "The layout parsing configurations for documents.", + "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig", + "properties": {}, + "type": "object" + }, "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig": { "description": "The OCR parsing configurations for documents.", "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig", @@ -7979,6 +8020,37 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaAlloyDbSource": { + "description": "AlloyDB source import data from.", + "id": "GoogleCloudDiscoveryengineV1alphaAlloyDbSource", + "properties": { + "clusterId": { + "description": "Required. The AlloyDB cluster to copy the data from with a length limit of 256 characters.", + "type": "string" + }, + "databaseId": { + "description": "Required. The AlloyDB database to copy the data from with a length limit of 256 characters.", + "type": "string" + }, + "gcsStagingDir": { + "description": "Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the AlloyDB export to a specific Cloud Storage directory. Ensure that the AlloyDB service account has the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory.", + "type": "string" + }, + "locationId": { + "description": "Required. The AlloyDB location to copy the data from with a length limit of 256 characters.", + "type": "string" + }, + "projectId": { + "description": "The project ID that the AlloyDB source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.", + "type": "string" + }, + "tableId": { + "description": "Required. The AlloyDB table to copy the data from with a length limit of 256 characters.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaAnswer": { "description": "Defines an answer.", "id": "GoogleCloudDiscoveryengineV1alphaAnswer", @@ -8146,6 +8218,13 @@ "description": "The session resource name. Not required. When session field is not set, the API is in sessionless mode. We support auto session mode: users can use the wildcard symbol `-` as session ID. A new ID will be automatically generated and assigned.", "type": "string" }, + "userLabels": { + "additionalProperties": { + "type": "string" + }, + "description": "The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.", + "type": "object" + }, "userPseudoId": { "description": "A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", "type": "string" @@ -11090,6 +11169,10 @@ "description": "Request message for Import methods.", "id": "GoogleCloudDiscoveryengineV1alphaImportDocumentsRequest", "properties": { + "alloyDbSource": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAlloyDbSource", + "description": "AlloyDB input source." + }, "autoGenerateIds": { "description": "Whether to automatically generate IDs for the documents if absent. If set to `true`, Document.ids are automatically generated based on the hash of the payload, where IDs may not be consistent during multiple imports. In which case ReconciliationMode.FULL is highly recommended to avoid duplicate contents. If unset or set to `false`, Document.ids have to be specified using id_field, otherwise, documents without IDs fail to be imported. Supported data sources: * GcsSource. GcsSource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * BigQuerySource. BigQuerySource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * SpannerSource. * CloudSqlSource. * FirestoreSource. * BigtableSource.", "type": "boolean" @@ -12619,7 +12702,7 @@ "description": "If there is no extractive_content_spec provided, there will be no extractive answer in the search response." }, "searchResultMode": { - "description": "Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`.", + "description": "Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`.", "enum": [ "SEARCH_RESULT_MODE_UNSPECIFIED", "DOCUMENTS", @@ -14597,6 +14680,10 @@ "description": "A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config.", "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig", "properties": { + "chunkingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig", + "description": "Whether chunking mode is enabled." + }, "defaultParsingConfig": { "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig", "description": "Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing." @@ -14615,6 +14702,33 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig": { + "description": "Configuration for chunking config.", + "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig", + "properties": { + "layoutBasedChunkingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", + "description": "Configuration for the layout based chunking." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig": { + "description": "Configuration for the layout based chunking.", + "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", + "properties": { + "chunkSize": { + "description": "The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500.", + "format": "int32", + "type": "integer" + }, + "includeAncestorHeadings": { + "description": "Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False.", + "type": "boolean" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig": { "description": "Related configurations applied to a specific type of document parser.", "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig", @@ -14623,6 +14737,10 @@ "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig", "description": "Configurations applied to digital parser." }, + "layoutParsingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig", + "description": "Configurations applied to layout parser." + }, "ocrParsingConfig": { "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig", "description": "Configurations applied to OCR parser. Currently it only applies to PDFs." @@ -14636,6 +14754,12 @@ "properties": {}, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig": { + "description": "The layout parsing configurations for documents.", + "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig", + "properties": {}, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig": { "description": "The OCR parsing configurations for documents.", "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig", diff --git a/discoveryengine/v1alpha/discoveryengine-gen.go b/discoveryengine/v1alpha/discoveryengine-gen.go index 3bba27f9ff1..c469a444be9 100644 --- a/discoveryengine/v1alpha/discoveryengine-gen.go +++ b/discoveryengine/v1alpha/discoveryengine-gen.go @@ -1789,6 +1789,8 @@ type GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchResponse struct { // DataStoreService.UpdateDocumentProcessingConfig method will initialize the // config. type GoogleCloudDiscoveryengineV1DocumentProcessingConfig struct { + // ChunkingConfig: Whether chunking mode is enabled. + ChunkingConfig *GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig `json:"chunkingConfig,omitempty"` // DefaultParsingConfig: Configurations for default Document parser. If not // specified, we will configure it as default DigitalParsingConfig, and the // default parsing config will be applied to all file types for Document @@ -1805,15 +1807,15 @@ type GoogleCloudDiscoveryengineV1DocumentProcessingConfig struct { // parsing config for DOCX files, only digital parsing and or layout parsing // are supported. ParsingConfigOverrides map[string]GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig `json:"parsingConfigOverrides,omitempty"` - // ForceSendFields is a list of field names (e.g. "DefaultParsingConfig") to + // ForceSendFields is a list of field names (e.g. "ChunkingConfig") to // unconditionally include in API requests. By default, fields with empty or // default values are omitted from API requests. See // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more // details. ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "DefaultParsingConfig") to include - // in API requests with the JSON null value. By default, fields with empty - // values are omitted from API requests. See + // NullFields is a list of field names (e.g. "ChunkingConfig") to include in + // API requests with the JSON null value. By default, fields with empty values + // are omitted from API requests. See // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. NullFields []string `json:"-"` } @@ -1823,11 +1825,64 @@ func (s *GoogleCloudDiscoveryengineV1DocumentProcessingConfig) MarshalJSON() ([] return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields) } +// GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig: +// Configuration for chunking config. +type GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig struct { + // LayoutBasedChunkingConfig: Configuration for the layout based chunking. + LayoutBasedChunkingConfig *GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig `json:"layoutBasedChunkingConfig,omitempty"` + // ForceSendFields is a list of field names (e.g. "LayoutBasedChunkingConfig") + // to unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "LayoutBasedChunkingConfig") to + // include in API requests with the JSON null value. By default, fields with + // empty values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig + return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields) +} + +// GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBased +// ChunkingConfig: Configuration for the layout based chunking. +type GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig struct { + // ChunkSize: The token size limit for each chunk. Supported values: 100-500 + // (inclusive). Default value: 500. + ChunkSize int64 `json:"chunkSize,omitempty"` + // IncludeAncestorHeadings: Whether to include appending different levels of + // headings to chunks from the middle of the document to prevent context loss. + // Default value: False. + IncludeAncestorHeadings bool `json:"includeAncestorHeadings,omitempty"` + // ForceSendFields is a list of field names (e.g. "ChunkSize") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "ChunkSize") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig + return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields) +} + // GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig: Related // configurations applied to a specific type of document parser. type GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig struct { // DigitalParsingConfig: Configurations applied to digital parser. DigitalParsingConfig *GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig `json:"digitalParsingConfig,omitempty"` + // LayoutParsingConfig: Configurations applied to layout parser. + LayoutParsingConfig *GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig `json:"layoutParsingConfig,omitempty"` // OcrParsingConfig: Configurations applied to OCR parser. Currently it only // applies to PDFs. OcrParsingConfig *GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig `json:"ocrParsingConfig,omitempty"` @@ -1854,6 +1909,11 @@ func (s *GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig) Mars type GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig struct { } +// GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsin +// gConfig: The layout parsing configurations for documents. +type GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig struct { +} + // GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingCo // nfig: The OCR parsing configurations for documents. type GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig struct { @@ -2827,6 +2887,49 @@ func (s *GoogleCloudDiscoveryengineV1alphaAclConfig) MarshalJSON() ([]byte, erro return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields) } +// GoogleCloudDiscoveryengineV1alphaAlloyDbSource: AlloyDB source import data +// from. +type GoogleCloudDiscoveryengineV1alphaAlloyDbSource struct { + // ClusterId: Required. The AlloyDB cluster to copy the data from with a length + // limit of 256 characters. + ClusterId string `json:"clusterId,omitempty"` + // DatabaseId: Required. The AlloyDB database to copy the data from with a + // length limit of 256 characters. + DatabaseId string `json:"databaseId,omitempty"` + // GcsStagingDir: Intermediate Cloud Storage directory used for the import with + // a length limit of 2,000 characters. Can be specified if one wants to have + // the AlloyDB export to a specific Cloud Storage directory. Ensure that the + // AlloyDB service account has the necessary Cloud Storage Admin permissions to + // access the specified Cloud Storage directory. + GcsStagingDir string `json:"gcsStagingDir,omitempty"` + // LocationId: Required. The AlloyDB location to copy the data from with a + // length limit of 256 characters. + LocationId string `json:"locationId,omitempty"` + // ProjectId: The project ID that the AlloyDB source is in with a length limit + // of 128 characters. If not specified, inherits the project ID from the parent + // request. + ProjectId string `json:"projectId,omitempty"` + // TableId: Required. The AlloyDB table to copy the data from with a length + // limit of 256 characters. + TableId string `json:"tableId,omitempty"` + // ForceSendFields is a list of field names (e.g. "ClusterId") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "ClusterId") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDiscoveryengineV1alphaAlloyDbSource) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDiscoveryengineV1alphaAlloyDbSource + return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields) +} + // GoogleCloudDiscoveryengineV1alphaAnswer: Defines an answer. type GoogleCloudDiscoveryengineV1alphaAnswer struct { // AnswerSkippedReasons: Additional answer-skipped reasons. This provides the @@ -2969,6 +3072,19 @@ type GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest struct { // use the wildcard symbol `-` as session ID. A new ID will be automatically // generated and assigned. Session string `json:"session,omitempty"` + // UserLabels: The user labels applied to a resource must meet the following + // requirements: * Each resource can have multiple labels, up to a maximum of + // 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 + // character and a maximum length of 63 characters and cannot be empty. Values + // can be empty and have a maximum length of 63 characters. * Keys and values + // can contain only lowercase letters, numeric characters, underscores, and + // dashes. All characters must use UTF-8 encoding, and international characters + // are allowed. * The key portion of a label must be unique. However, you can + // use the same key with multiple resources. * Keys must start with a lowercase + // letter or international character. See Google Cloud Document + // (https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) + // for more details. + UserLabels map[string]string `json:"userLabels,omitempty"` // UserPseudoId: A unique identifier for tracking visitors. For example, this // could be implemented with an HTTP cookie, which should be able to uniquely // identify a visitor on a single device. This unique identifier should not @@ -7165,6 +7281,8 @@ func (s *GoogleCloudDiscoveryengineV1alphaImportDocumentsMetadata) MarshalJSON() // GoogleCloudDiscoveryengineV1alphaImportDocumentsRequest: Request message for // Import methods. type GoogleCloudDiscoveryengineV1alphaImportDocumentsRequest struct { + // AlloyDbSource: AlloyDB input source. + AlloyDbSource *GoogleCloudDiscoveryengineV1alphaAlloyDbSource `json:"alloyDbSource,omitempty"` // AutoGenerateIds: Whether to automatically generate IDs for the documents if // absent. If set to `true`, Document.ids are automatically generated based on // the hash of the payload, where IDs may not be consistent during multiple @@ -7226,15 +7344,15 @@ type GoogleCloudDiscoveryengineV1alphaImportDocumentsRequest struct { // UpdateMask: Indicates which fields in the provided imported documents to // update. If not set, the default is to update all fields. UpdateMask string `json:"updateMask,omitempty"` - // ForceSendFields is a list of field names (e.g. "AutoGenerateIds") to + // ForceSendFields is a list of field names (e.g. "AlloyDbSource") to // unconditionally include in API requests. By default, fields with empty or // default values are omitted from API requests. See // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more // details. ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "AutoGenerateIds") to include in - // API requests with the JSON null value. By default, fields with empty values - // are omitted from API requests. See + // NullFields is a list of field names (e.g. "AlloyDbSource") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. NullFields []string `json:"-"` } @@ -9477,7 +9595,10 @@ type GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec struct { // there will be no extractive answer in the search response. ExtractiveContentSpec *GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec `json:"extractiveContentSpec,omitempty"` // SearchResultMode: Specifies the search result mode. If unspecified, the - // search result mode defaults to `DOCUMENTS`. + // search result mode is based on + // DataStore.DocumentProcessingConfig.chunking_config: * If + // DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults + // to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. // // Possible values: // "SEARCH_RESULT_MODE_UNSPECIFIED" - Default value. @@ -12325,6 +12446,8 @@ type GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchResponse struct { // DataStoreService.UpdateDocumentProcessingConfig method will initialize the // config. type GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig struct { + // ChunkingConfig: Whether chunking mode is enabled. + ChunkingConfig *GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig `json:"chunkingConfig,omitempty"` // DefaultParsingConfig: Configurations for default Document parser. If not // specified, we will configure it as default DigitalParsingConfig, and the // default parsing config will be applied to all file types for Document @@ -12341,15 +12464,15 @@ type GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig struct { // parsing config for DOCX files, only digital parsing and or layout parsing // are supported. ParsingConfigOverrides map[string]GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig `json:"parsingConfigOverrides,omitempty"` - // ForceSendFields is a list of field names (e.g. "DefaultParsingConfig") to + // ForceSendFields is a list of field names (e.g. "ChunkingConfig") to // unconditionally include in API requests. By default, fields with empty or // default values are omitted from API requests. See // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more // details. ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "DefaultParsingConfig") to include - // in API requests with the JSON null value. By default, fields with empty - // values are omitted from API requests. See + // NullFields is a list of field names (e.g. "ChunkingConfig") to include in + // API requests with the JSON null value. By default, fields with empty values + // are omitted from API requests. See // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. NullFields []string `json:"-"` } @@ -12359,11 +12482,64 @@ func (s *GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig) MarshalJSON() return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields) } +// GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig: +// Configuration for chunking config. +type GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig struct { + // LayoutBasedChunkingConfig: Configuration for the layout based chunking. + LayoutBasedChunkingConfig *GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig `json:"layoutBasedChunkingConfig,omitempty"` + // ForceSendFields is a list of field names (e.g. "LayoutBasedChunkingConfig") + // to unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "LayoutBasedChunkingConfig") to + // include in API requests with the JSON null value. By default, fields with + // empty values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig + return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields) +} + +// GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutB +// asedChunkingConfig: Configuration for the layout based chunking. +type GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig struct { + // ChunkSize: The token size limit for each chunk. Supported values: 100-500 + // (inclusive). Default value: 500. + ChunkSize int64 `json:"chunkSize,omitempty"` + // IncludeAncestorHeadings: Whether to include appending different levels of + // headings to chunks from the middle of the document to prevent context loss. + // Default value: False. + IncludeAncestorHeadings bool `json:"includeAncestorHeadings,omitempty"` + // ForceSendFields is a list of field names (e.g. "ChunkSize") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "ChunkSize") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig + return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields) +} + // GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig: // Related configurations applied to a specific type of document parser. type GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig struct { // DigitalParsingConfig: Configurations applied to digital parser. DigitalParsingConfig *GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig `json:"digitalParsingConfig,omitempty"` + // LayoutParsingConfig: Configurations applied to layout parser. + LayoutParsingConfig *GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig `json:"layoutParsingConfig,omitempty"` // OcrParsingConfig: Configurations applied to OCR parser. Currently it only // applies to PDFs. OcrParsingConfig *GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig `json:"ocrParsingConfig,omitempty"` @@ -12390,6 +12566,11 @@ func (s *GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig) type GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig struct { } +// GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutPa +// rsingConfig: The layout parsing configurations for documents. +type GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig struct { +} + // GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsi // ngConfig: The OCR parsing configurations for documents. type GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig struct { @@ -17357,7 +17538,9 @@ type ProjectsLocationsCollectionsDataStoresControlsCreateCall struct { // // - parent: Full resource name of parent data store. Format: // `projects/{project_number}/locations/{location_id}/collections/{collection_ -// id}/dataStores/{data_store_id}`. +// id}/dataStores/{data_store_id}` or +// `projects/{project_number}/locations/{location_id}/collections/{collection_ +// id}/engines/{engine_id}`. func (r *ProjectsLocationsCollectionsDataStoresControlsService) Create(parent string, googleclouddiscoveryenginev1alphacontrol *GoogleCloudDiscoveryengineV1alphaControl) *ProjectsLocationsCollectionsDataStoresControlsCreateCall { c := &ProjectsLocationsCollectionsDataStoresControlsCreateCall{s: r.s, urlParams_: make(gensupport.URLParams)} c.parent = parent @@ -17679,7 +17862,9 @@ type ProjectsLocationsCollectionsDataStoresControlsListCall struct { // // - parent: The data store resource name. Format: // `projects/{project_number}/locations/{location_id}/collections/{collection_ -// id}/dataStores/{data_store_id}`. +// id}/dataStores/{data_store_id}` or +// `projects/{project_number}/locations/{location_id}/collections/{collection_ +// id}/engines/{engine_id}`. func (r *ProjectsLocationsCollectionsDataStoresControlsService) List(parent string) *ProjectsLocationsCollectionsDataStoresControlsListCall { c := &ProjectsLocationsCollectionsDataStoresControlsListCall{s: r.s, urlParams_: make(gensupport.URLParams)} c.parent = parent @@ -24890,7 +25075,9 @@ type ProjectsLocationsCollectionsEnginesControlsCreateCall struct { // // - parent: Full resource name of parent data store. Format: // `projects/{project_number}/locations/{location_id}/collections/{collection_ -// id}/dataStores/{data_store_id}`. +// id}/dataStores/{data_store_id}` or +// `projects/{project_number}/locations/{location_id}/collections/{collection_ +// id}/engines/{engine_id}`. func (r *ProjectsLocationsCollectionsEnginesControlsService) Create(parent string, googleclouddiscoveryenginev1alphacontrol *GoogleCloudDiscoveryengineV1alphaControl) *ProjectsLocationsCollectionsEnginesControlsCreateCall { c := &ProjectsLocationsCollectionsEnginesControlsCreateCall{s: r.s, urlParams_: make(gensupport.URLParams)} c.parent = parent @@ -25212,7 +25399,9 @@ type ProjectsLocationsCollectionsEnginesControlsListCall struct { // // - parent: The data store resource name. Format: // `projects/{project_number}/locations/{location_id}/collections/{collection_ -// id}/dataStores/{data_store_id}`. +// id}/dataStores/{data_store_id}` or +// `projects/{project_number}/locations/{location_id}/collections/{collection_ +// id}/engines/{engine_id}`. func (r *ProjectsLocationsCollectionsEnginesControlsService) List(parent string) *ProjectsLocationsCollectionsEnginesControlsListCall { c := &ProjectsLocationsCollectionsEnginesControlsListCall{s: r.s, urlParams_: make(gensupport.URLParams)} c.parent = parent @@ -30835,7 +31024,9 @@ type ProjectsLocationsDataStoresControlsCreateCall struct { // // - parent: Full resource name of parent data store. Format: // `projects/{project_number}/locations/{location_id}/collections/{collection_ -// id}/dataStores/{data_store_id}`. +// id}/dataStores/{data_store_id}` or +// `projects/{project_number}/locations/{location_id}/collections/{collection_ +// id}/engines/{engine_id}`. func (r *ProjectsLocationsDataStoresControlsService) Create(parent string, googleclouddiscoveryenginev1alphacontrol *GoogleCloudDiscoveryengineV1alphaControl) *ProjectsLocationsDataStoresControlsCreateCall { c := &ProjectsLocationsDataStoresControlsCreateCall{s: r.s, urlParams_: make(gensupport.URLParams)} c.parent = parent @@ -31157,7 +31348,9 @@ type ProjectsLocationsDataStoresControlsListCall struct { // // - parent: The data store resource name. Format: // `projects/{project_number}/locations/{location_id}/collections/{collection_ -// id}/dataStores/{data_store_id}`. +// id}/dataStores/{data_store_id}` or +// `projects/{project_number}/locations/{location_id}/collections/{collection_ +// id}/engines/{engine_id}`. func (r *ProjectsLocationsDataStoresControlsService) List(parent string) *ProjectsLocationsDataStoresControlsListCall { c := &ProjectsLocationsDataStoresControlsListCall{s: r.s, urlParams_: make(gensupport.URLParams)} c.parent = parent diff --git a/discoveryengine/v1beta/discoveryengine-api.json b/discoveryengine/v1beta/discoveryengine-api.json index 97e936c5e6a..8e994823947 100644 --- a/discoveryengine/v1beta/discoveryengine-api.json +++ b/discoveryengine/v1beta/discoveryengine-api.json @@ -817,7 +817,7 @@ "type": "string" }, "parent": { - "description": "Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}`", + "description": "Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", "required": true, @@ -911,7 +911,7 @@ "type": "string" }, "parent": { - "description": "Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}`", + "description": "Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", "required": true, @@ -2830,7 +2830,7 @@ "type": "string" }, "parent": { - "description": "Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}`", + "description": "Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$", "required": true, @@ -2924,7 +2924,7 @@ "type": "string" }, "parent": { - "description": "Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}`", + "description": "Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$", "required": true, @@ -4259,7 +4259,7 @@ "type": "string" }, "parent": { - "description": "Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}`", + "description": "Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", "required": true, @@ -4353,7 +4353,7 @@ "type": "string" }, "parent": { - "description": "Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}`", + "description": "Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", "required": true, @@ -5948,7 +5948,7 @@ } } }, - "revision": "20240526", + "revision": "20240530", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -6572,6 +6572,10 @@ "description": "A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config.", "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfig", "properties": { + "chunkingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig", + "description": "Whether chunking mode is enabled." + }, "defaultParsingConfig": { "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig", "description": "Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing." @@ -6590,6 +6594,33 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig": { + "description": "Configuration for chunking config.", + "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig", + "properties": { + "layoutBasedChunkingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", + "description": "Configuration for the layout based chunking." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig": { + "description": "Configuration for the layout based chunking.", + "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", + "properties": { + "chunkSize": { + "description": "The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500.", + "format": "int32", + "type": "integer" + }, + "includeAncestorHeadings": { + "description": "Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False.", + "type": "boolean" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig": { "description": "Related configurations applied to a specific type of document parser.", "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig", @@ -6598,6 +6629,10 @@ "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig", "description": "Configurations applied to digital parser." }, + "layoutParsingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig", + "description": "Configurations applied to layout parser." + }, "ocrParsingConfig": { "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig", "description": "Configurations applied to OCR parser. Currently it only applies to PDFs." @@ -6611,6 +6646,12 @@ "properties": {}, "type": "object" }, + "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig": { + "description": "The layout parsing configurations for documents.", + "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig", + "properties": {}, + "type": "object" + }, "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig": { "description": "The OCR parsing configurations for documents.", "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig", @@ -9787,6 +9828,37 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaAlloyDbSource": { + "description": "AlloyDB source import data from.", + "id": "GoogleCloudDiscoveryengineV1betaAlloyDbSource", + "properties": { + "clusterId": { + "description": "Required. The AlloyDB cluster to copy the data from with a length limit of 256 characters.", + "type": "string" + }, + "databaseId": { + "description": "Required. The AlloyDB database to copy the data from with a length limit of 256 characters.", + "type": "string" + }, + "gcsStagingDir": { + "description": "Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the AlloyDB export to a specific Cloud Storage directory. Ensure that the AlloyDB service account has the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory.", + "type": "string" + }, + "locationId": { + "description": "Required. The AlloyDB location to copy the data from with a length limit of 256 characters.", + "type": "string" + }, + "projectId": { + "description": "The project ID that the AlloyDB source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.", + "type": "string" + }, + "tableId": { + "description": "Required. The AlloyDB table to copy the data from with a length limit of 256 characters.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaAnswer": { "description": "Defines an answer.", "id": "GoogleCloudDiscoveryengineV1betaAnswer", @@ -9954,6 +10026,13 @@ "description": "The session resource name. Not required. When session field is not set, the API is in sessionless mode. We support auto session mode: users can use the wildcard symbol `-` as session ID. A new ID will be automatically generated and assigned.", "type": "string" }, + "userLabels": { + "additionalProperties": { + "type": "string" + }, + "description": "The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.", + "type": "object" + }, "userPseudoId": { "description": "A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", "type": "string" @@ -11808,6 +11887,10 @@ "description": "A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config.", "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig", "properties": { + "chunkingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig", + "description": "Whether chunking mode is enabled." + }, "defaultParsingConfig": { "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig", "description": "Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing." @@ -11826,6 +11909,33 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig": { + "description": "Configuration for chunking config.", + "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig", + "properties": { + "layoutBasedChunkingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", + "description": "Configuration for the layout based chunking." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig": { + "description": "Configuration for the layout based chunking.", + "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", + "properties": { + "chunkSize": { + "description": "The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500.", + "format": "int32", + "type": "integer" + }, + "includeAncestorHeadings": { + "description": "Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False.", + "type": "boolean" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig": { "description": "Related configurations applied to a specific type of document parser.", "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig", @@ -11834,6 +11944,10 @@ "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig", "description": "Configurations applied to digital parser." }, + "layoutParsingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig", + "description": "Configurations applied to layout parser." + }, "ocrParsingConfig": { "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig", "description": "Configurations applied to OCR parser. Currently it only applies to PDFs." @@ -11847,6 +11961,12 @@ "properties": {}, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig": { + "description": "The layout parsing configurations for documents.", + "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig", + "properties": {}, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig": { "description": "The OCR parsing configurations for documents.", "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig", @@ -12262,6 +12382,10 @@ "description": "Request message for Import methods.", "id": "GoogleCloudDiscoveryengineV1betaImportDocumentsRequest", "properties": { + "alloyDbSource": { + "$ref": "GoogleCloudDiscoveryengineV1betaAlloyDbSource", + "description": "AlloyDB input source." + }, "autoGenerateIds": { "description": "Whether to automatically generate IDs for the documents if absent. If set to `true`, Document.ids are automatically generated based on the hash of the payload, where IDs may not be consistent during multiple imports. In which case ReconciliationMode.FULL is highly recommended to avoid duplicate contents. If unset or set to `false`, Document.ids have to be specified using id_field, otherwise, documents without IDs fail to be imported. Supported data sources: * GcsSource. GcsSource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * BigQuerySource. BigQuerySource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * SpannerSource. * CloudSqlSource. * FirestoreSource. * BigtableSource.", "type": "boolean" diff --git a/discoveryengine/v1beta/discoveryengine-gen.go b/discoveryengine/v1beta/discoveryengine-gen.go index 3644e566b16..a5bb03f9800 100644 --- a/discoveryengine/v1beta/discoveryengine-gen.go +++ b/discoveryengine/v1beta/discoveryengine-gen.go @@ -1717,6 +1717,8 @@ type GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchResponse struct { // DataStoreService.UpdateDocumentProcessingConfig method will initialize the // config. type GoogleCloudDiscoveryengineV1DocumentProcessingConfig struct { + // ChunkingConfig: Whether chunking mode is enabled. + ChunkingConfig *GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig `json:"chunkingConfig,omitempty"` // DefaultParsingConfig: Configurations for default Document parser. If not // specified, we will configure it as default DigitalParsingConfig, and the // default parsing config will be applied to all file types for Document @@ -1733,15 +1735,15 @@ type GoogleCloudDiscoveryengineV1DocumentProcessingConfig struct { // parsing config for DOCX files, only digital parsing and or layout parsing // are supported. ParsingConfigOverrides map[string]GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig `json:"parsingConfigOverrides,omitempty"` - // ForceSendFields is a list of field names (e.g. "DefaultParsingConfig") to + // ForceSendFields is a list of field names (e.g. "ChunkingConfig") to // unconditionally include in API requests. By default, fields with empty or // default values are omitted from API requests. See // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more // details. ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "DefaultParsingConfig") to include - // in API requests with the JSON null value. By default, fields with empty - // values are omitted from API requests. See + // NullFields is a list of field names (e.g. "ChunkingConfig") to include in + // API requests with the JSON null value. By default, fields with empty values + // are omitted from API requests. See // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. NullFields []string `json:"-"` } @@ -1751,11 +1753,64 @@ func (s *GoogleCloudDiscoveryengineV1DocumentProcessingConfig) MarshalJSON() ([] return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields) } +// GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig: +// Configuration for chunking config. +type GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig struct { + // LayoutBasedChunkingConfig: Configuration for the layout based chunking. + LayoutBasedChunkingConfig *GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig `json:"layoutBasedChunkingConfig,omitempty"` + // ForceSendFields is a list of field names (e.g. "LayoutBasedChunkingConfig") + // to unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "LayoutBasedChunkingConfig") to + // include in API requests with the JSON null value. By default, fields with + // empty values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig + return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields) +} + +// GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBased +// ChunkingConfig: Configuration for the layout based chunking. +type GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig struct { + // ChunkSize: The token size limit for each chunk. Supported values: 100-500 + // (inclusive). Default value: 500. + ChunkSize int64 `json:"chunkSize,omitempty"` + // IncludeAncestorHeadings: Whether to include appending different levels of + // headings to chunks from the middle of the document to prevent context loss. + // Default value: False. + IncludeAncestorHeadings bool `json:"includeAncestorHeadings,omitempty"` + // ForceSendFields is a list of field names (e.g. "ChunkSize") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "ChunkSize") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig + return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields) +} + // GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig: Related // configurations applied to a specific type of document parser. type GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig struct { // DigitalParsingConfig: Configurations applied to digital parser. DigitalParsingConfig *GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig `json:"digitalParsingConfig,omitempty"` + // LayoutParsingConfig: Configurations applied to layout parser. + LayoutParsingConfig *GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig `json:"layoutParsingConfig,omitempty"` // OcrParsingConfig: Configurations applied to OCR parser. Currently it only // applies to PDFs. OcrParsingConfig *GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig `json:"ocrParsingConfig,omitempty"` @@ -1782,6 +1837,11 @@ func (s *GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig) Mars type GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig struct { } +// GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsin +// gConfig: The layout parsing configurations for documents. +type GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig struct { +} + // GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingCo // nfig: The OCR parsing configurations for documents. type GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig struct { @@ -5894,6 +5954,49 @@ func (s *GoogleCloudDiscoveryengineV1alphaUpdateTargetSiteMetadata) MarshalJSON( return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields) } +// GoogleCloudDiscoveryengineV1betaAlloyDbSource: AlloyDB source import data +// from. +type GoogleCloudDiscoveryengineV1betaAlloyDbSource struct { + // ClusterId: Required. The AlloyDB cluster to copy the data from with a length + // limit of 256 characters. + ClusterId string `json:"clusterId,omitempty"` + // DatabaseId: Required. The AlloyDB database to copy the data from with a + // length limit of 256 characters. + DatabaseId string `json:"databaseId,omitempty"` + // GcsStagingDir: Intermediate Cloud Storage directory used for the import with + // a length limit of 2,000 characters. Can be specified if one wants to have + // the AlloyDB export to a specific Cloud Storage directory. Ensure that the + // AlloyDB service account has the necessary Cloud Storage Admin permissions to + // access the specified Cloud Storage directory. + GcsStagingDir string `json:"gcsStagingDir,omitempty"` + // LocationId: Required. The AlloyDB location to copy the data from with a + // length limit of 256 characters. + LocationId string `json:"locationId,omitempty"` + // ProjectId: The project ID that the AlloyDB source is in with a length limit + // of 128 characters. If not specified, inherits the project ID from the parent + // request. + ProjectId string `json:"projectId,omitempty"` + // TableId: Required. The AlloyDB table to copy the data from with a length + // limit of 256 characters. + TableId string `json:"tableId,omitempty"` + // ForceSendFields is a list of field names (e.g. "ClusterId") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "ClusterId") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDiscoveryengineV1betaAlloyDbSource) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDiscoveryengineV1betaAlloyDbSource + return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields) +} + // GoogleCloudDiscoveryengineV1betaAnswer: Defines an answer. type GoogleCloudDiscoveryengineV1betaAnswer struct { // AnswerSkippedReasons: Additional answer-skipped reasons. This provides the @@ -6035,6 +6138,19 @@ type GoogleCloudDiscoveryengineV1betaAnswerQueryRequest struct { // use the wildcard symbol `-` as session ID. A new ID will be automatically // generated and assigned. Session string `json:"session,omitempty"` + // UserLabels: The user labels applied to a resource must meet the following + // requirements: * Each resource can have multiple labels, up to a maximum of + // 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 + // character and a maximum length of 63 characters and cannot be empty. Values + // can be empty and have a maximum length of 63 characters. * Keys and values + // can contain only lowercase letters, numeric characters, underscores, and + // dashes. All characters must use UTF-8 encoding, and international characters + // are allowed. * The key portion of a label must be unique. However, you can + // use the same key with multiple resources. * Keys must start with a lowercase + // letter or international character. See Google Cloud Document + // (https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) + // for more details. + UserLabels map[string]string `json:"userLabels,omitempty"` // UserPseudoId: A unique identifier for tracking visitors. For example, this // could be implemented with an HTTP cookie, which should be able to uniquely // identify a visitor on a single device. This unique identifier should not @@ -8674,6 +8790,8 @@ func (s *GoogleCloudDiscoveryengineV1betaDocumentInfo) MarshalJSON() ([]byte, er // DataStoreService.UpdateDocumentProcessingConfig method will initialize the // config. type GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig struct { + // ChunkingConfig: Whether chunking mode is enabled. + ChunkingConfig *GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig `json:"chunkingConfig,omitempty"` // DefaultParsingConfig: Configurations for default Document parser. If not // specified, we will configure it as default DigitalParsingConfig, and the // default parsing config will be applied to all file types for Document @@ -8690,15 +8808,15 @@ type GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig struct { // parsing config for DOCX files, only digital parsing and or layout parsing // are supported. ParsingConfigOverrides map[string]GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig `json:"parsingConfigOverrides,omitempty"` - // ForceSendFields is a list of field names (e.g. "DefaultParsingConfig") to + // ForceSendFields is a list of field names (e.g. "ChunkingConfig") to // unconditionally include in API requests. By default, fields with empty or // default values are omitted from API requests. See // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more // details. ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "DefaultParsingConfig") to include - // in API requests with the JSON null value. By default, fields with empty - // values are omitted from API requests. See + // NullFields is a list of field names (e.g. "ChunkingConfig") to include in + // API requests with the JSON null value. By default, fields with empty values + // are omitted from API requests. See // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. NullFields []string `json:"-"` } @@ -8708,11 +8826,64 @@ func (s *GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig) MarshalJSON() return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields) } +// GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig: +// Configuration for chunking config. +type GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig struct { + // LayoutBasedChunkingConfig: Configuration for the layout based chunking. + LayoutBasedChunkingConfig *GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig `json:"layoutBasedChunkingConfig,omitempty"` + // ForceSendFields is a list of field names (e.g. "LayoutBasedChunkingConfig") + // to unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "LayoutBasedChunkingConfig") to + // include in API requests with the JSON null value. By default, fields with + // empty values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig + return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields) +} + +// GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutB +// asedChunkingConfig: Configuration for the layout based chunking. +type GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig struct { + // ChunkSize: The token size limit for each chunk. Supported values: 100-500 + // (inclusive). Default value: 500. + ChunkSize int64 `json:"chunkSize,omitempty"` + // IncludeAncestorHeadings: Whether to include appending different levels of + // headings to chunks from the middle of the document to prevent context loss. + // Default value: False. + IncludeAncestorHeadings bool `json:"includeAncestorHeadings,omitempty"` + // ForceSendFields is a list of field names (e.g. "ChunkSize") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "ChunkSize") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig + return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields) +} + // GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig: // Related configurations applied to a specific type of document parser. type GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig struct { // DigitalParsingConfig: Configurations applied to digital parser. DigitalParsingConfig *GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig `json:"digitalParsingConfig,omitempty"` + // LayoutParsingConfig: Configurations applied to layout parser. + LayoutParsingConfig *GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig `json:"layoutParsingConfig,omitempty"` // OcrParsingConfig: Configurations applied to OCR parser. Currently it only // applies to PDFs. OcrParsingConfig *GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig `json:"ocrParsingConfig,omitempty"` @@ -8739,6 +8910,11 @@ func (s *GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig) type GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig struct { } +// GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutPa +// rsingConfig: The layout parsing configurations for documents. +type GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig struct { +} + // GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsi // ngConfig: The OCR parsing configurations for documents. type GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig struct { @@ -9345,6 +9521,8 @@ func (s *GoogleCloudDiscoveryengineV1betaImportDocumentsMetadata) MarshalJSON() // GoogleCloudDiscoveryengineV1betaImportDocumentsRequest: Request message for // Import methods. type GoogleCloudDiscoveryengineV1betaImportDocumentsRequest struct { + // AlloyDbSource: AlloyDB input source. + AlloyDbSource *GoogleCloudDiscoveryengineV1betaAlloyDbSource `json:"alloyDbSource,omitempty"` // AutoGenerateIds: Whether to automatically generate IDs for the documents if // absent. If set to `true`, Document.ids are automatically generated based on // the hash of the payload, where IDs may not be consistent during multiple @@ -9406,15 +9584,15 @@ type GoogleCloudDiscoveryengineV1betaImportDocumentsRequest struct { // UpdateMask: Indicates which fields in the provided imported documents to // update. If not set, the default is to update all fields. UpdateMask string `json:"updateMask,omitempty"` - // ForceSendFields is a list of field names (e.g. "AutoGenerateIds") to + // ForceSendFields is a list of field names (e.g. "AlloyDbSource") to // unconditionally include in API requests. By default, fields with empty or // default values are omitted from API requests. See // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more // details. ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "AutoGenerateIds") to include in - // API requests with the JSON null value. By default, fields with empty values - // are omitted from API requests. See + // NullFields is a list of field names (e.g. "AlloyDbSource") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. NullFields []string `json:"-"` } @@ -16079,7 +16257,9 @@ type ProjectsLocationsCollectionsDataStoresControlsCreateCall struct { // // - parent: Full resource name of parent data store. Format: // `projects/{project_number}/locations/{location_id}/collections/{collection_ -// id}/dataStores/{data_store_id}`. +// id}/dataStores/{data_store_id}` or +// `projects/{project_number}/locations/{location_id}/collections/{collection_ +// id}/engines/{engine_id}`. func (r *ProjectsLocationsCollectionsDataStoresControlsService) Create(parent string, googleclouddiscoveryenginev1betacontrol *GoogleCloudDiscoveryengineV1betaControl) *ProjectsLocationsCollectionsDataStoresControlsCreateCall { c := &ProjectsLocationsCollectionsDataStoresControlsCreateCall{s: r.s, urlParams_: make(gensupport.URLParams)} c.parent = parent @@ -16401,7 +16581,9 @@ type ProjectsLocationsCollectionsDataStoresControlsListCall struct { // // - parent: The data store resource name. Format: // `projects/{project_number}/locations/{location_id}/collections/{collection_ -// id}/dataStores/{data_store_id}`. +// id}/dataStores/{data_store_id}` or +// `projects/{project_number}/locations/{location_id}/collections/{collection_ +// id}/engines/{engine_id}`. func (r *ProjectsLocationsCollectionsDataStoresControlsService) List(parent string) *ProjectsLocationsCollectionsDataStoresControlsListCall { c := &ProjectsLocationsCollectionsDataStoresControlsListCall{s: r.s, urlParams_: make(gensupport.URLParams)} c.parent = parent @@ -23504,7 +23686,9 @@ type ProjectsLocationsCollectionsEnginesControlsCreateCall struct { // // - parent: Full resource name of parent data store. Format: // `projects/{project_number}/locations/{location_id}/collections/{collection_ -// id}/dataStores/{data_store_id}`. +// id}/dataStores/{data_store_id}` or +// `projects/{project_number}/locations/{location_id}/collections/{collection_ +// id}/engines/{engine_id}`. func (r *ProjectsLocationsCollectionsEnginesControlsService) Create(parent string, googleclouddiscoveryenginev1betacontrol *GoogleCloudDiscoveryengineV1betaControl) *ProjectsLocationsCollectionsEnginesControlsCreateCall { c := &ProjectsLocationsCollectionsEnginesControlsCreateCall{s: r.s, urlParams_: make(gensupport.URLParams)} c.parent = parent @@ -23826,7 +24010,9 @@ type ProjectsLocationsCollectionsEnginesControlsListCall struct { // // - parent: The data store resource name. Format: // `projects/{project_number}/locations/{location_id}/collections/{collection_ -// id}/dataStores/{data_store_id}`. +// id}/dataStores/{data_store_id}` or +// `projects/{project_number}/locations/{location_id}/collections/{collection_ +// id}/engines/{engine_id}`. func (r *ProjectsLocationsCollectionsEnginesControlsService) List(parent string) *ProjectsLocationsCollectionsEnginesControlsListCall { c := &ProjectsLocationsCollectionsEnginesControlsListCall{s: r.s, urlParams_: make(gensupport.URLParams)} c.parent = parent @@ -28807,7 +28993,9 @@ type ProjectsLocationsDataStoresControlsCreateCall struct { // // - parent: Full resource name of parent data store. Format: // `projects/{project_number}/locations/{location_id}/collections/{collection_ -// id}/dataStores/{data_store_id}`. +// id}/dataStores/{data_store_id}` or +// `projects/{project_number}/locations/{location_id}/collections/{collection_ +// id}/engines/{engine_id}`. func (r *ProjectsLocationsDataStoresControlsService) Create(parent string, googleclouddiscoveryenginev1betacontrol *GoogleCloudDiscoveryengineV1betaControl) *ProjectsLocationsDataStoresControlsCreateCall { c := &ProjectsLocationsDataStoresControlsCreateCall{s: r.s, urlParams_: make(gensupport.URLParams)} c.parent = parent @@ -29129,7 +29317,9 @@ type ProjectsLocationsDataStoresControlsListCall struct { // // - parent: The data store resource name. Format: // `projects/{project_number}/locations/{location_id}/collections/{collection_ -// id}/dataStores/{data_store_id}`. +// id}/dataStores/{data_store_id}` or +// `projects/{project_number}/locations/{location_id}/collections/{collection_ +// id}/engines/{engine_id}`. func (r *ProjectsLocationsDataStoresControlsService) List(parent string) *ProjectsLocationsDataStoresControlsListCall { c := &ProjectsLocationsDataStoresControlsListCall{s: r.s, urlParams_: make(gensupport.URLParams)} c.parent = parent diff --git a/firebaseml/v2beta/firebaseml-api.json b/firebaseml/v2beta/firebaseml-api.json index f911a4a1084..ed8ac4c0c58 100644 --- a/firebaseml/v2beta/firebaseml-api.json +++ b/firebaseml/v2beta/firebaseml-api.json @@ -206,7 +206,7 @@ } } }, - "revision": "20240524", + "revision": "20240603", "rootUrl": "https://firebaseml.googleapis.com/", "schemas": { "Blob": { @@ -255,7 +255,8 @@ "OTHER", "BLOCKLIST", "PROHIBITED_CONTENT", - "SPII" + "SPII", + "MALFORMED_FUNCTION_CALL" ], "enumDescriptions": [ "The finish reason is unspecified.", @@ -266,7 +267,8 @@ "All other reasons that stopped the token generation", "The token generation was stopped as the response was flagged for the terms which are included from the terminology blocklist.", "The token generation was stopped as the response was flagged for the prohibited contents.", - "The token generation was stopped as the response was flagged for Sensitive Personally Identifiable Information (SPII) contents." + "The token generation was stopped as the response was flagged for Sensitive Personally Identifiable Information (SPII) contents.", + "The function call generated by the model is invalid." ], "readOnly": true, "type": "string" diff --git a/firebaseml/v2beta/firebaseml-gen.go b/firebaseml/v2beta/firebaseml-gen.go index ad8a8dba558..480d3ca3f00 100644 --- a/firebaseml/v2beta/firebaseml-gen.go +++ b/firebaseml/v2beta/firebaseml-gen.go @@ -253,6 +253,8 @@ type Candidate struct { // was flagged for the prohibited contents. // "SPII" - The token generation was stopped as the response was flagged for // Sensitive Personally Identifiable Information (SPII) contents. + // "MALFORMED_FUNCTION_CALL" - The function call generated by the model is + // invalid. FinishReason string `json:"finishReason,omitempty"` // GroundingMetadata: Output only. Metadata specifies sources used to ground // generated content. diff --git a/games/v1/games-api.json b/games/v1/games-api.json index 0c557e3be3b..a30f7c5092b 100644 --- a/games/v1/games-api.json +++ b/games/v1/games-api.json @@ -822,8 +822,38 @@ }, "recall": { "methods": { + "gamesPlayerTokens": { + "description": "Retrieve the Recall tokens from all requested games that is associated with the PGS Player encoded in the provided recall session id. The API is only available for users that have an active PGS Player profile.", + "flatPath": "games/v1/recall/gamesPlayerTokens/{sessionId}", + "httpMethod": "GET", + "id": "games.recall.gamesPlayerTokens", + "parameterOrder": [ + "sessionId" + ], + "parameters": { + "applicationIds": { + "description": "Required. The application IDs from the Google Play developer console for the games to return scoped ids for.", + "location": "query", + "repeated": true, + "type": "string" + }, + "sessionId": { + "description": "Required. Opaque server-generated string that encodes all the necessary information to identify the PGS player / Google user and application.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "games/v1/recall/gamesPlayerTokens/{sessionId}", + "response": { + "$ref": "RetrieveGamesPlayerTokensResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/androidpublisher" + ] + }, "lastTokenFromAllDeveloperGames": { - "description": "Retrieve the last Recall token from all developer games that is associated with the PGS Player principal encoded in the provided recall session id. The API is only available for users that have active PGS Player profile.", + "description": "Retrieve the last Recall token from all developer games that is associated with the PGS Player encoded in the provided recall session id. The API is only available for users that have active PGS Player profile.", "flatPath": "games/v1/recall/developerGamesLastPlayerToken/{sessionId}", "httpMethod": "GET", "id": "games.recall.lastTokenFromAllDeveloperGames", @@ -883,7 +913,7 @@ ] }, "retrieveTokens": { - "description": "Retrieve all Recall tokens associated with the PGS Player principal encoded in the provided recall session id. The API is only available for users that have active PGS Player profile.", + "description": "Retrieve all Recall tokens associated with the PGS Player encoded in the provided recall session id. The API is only available for users that have active PGS Player profile.", "flatPath": "games/v1/recall/tokens/{sessionId}", "httpMethod": "GET", "id": "games.recall.retrieveTokens", @@ -1378,7 +1408,7 @@ } } }, - "revision": "20240416", + "revision": "20240529", "rootUrl": "https://games.googleapis.com/", "schemas": { "AchievementDefinition": { @@ -2132,6 +2162,24 @@ }, "type": "object" }, + "GamePlayerToken": { + "description": "Recall tokens for a game.", + "id": "GamePlayerToken", + "properties": { + "applicationId": { + "description": "The application that this player identifier is for.", + "type": "string" + }, + "token": { + "description": "Recall token data.", + "items": { + "$ref": "RecallToken" + }, + "type": "array" + } + }, + "type": "object" + }, "GamesAchievementIncrement": { "description": "The payload to request to increment an achievement.", "id": "GamesAchievementIncrement", @@ -3179,6 +3227,20 @@ }, "type": "object" }, + "RetrieveGamesPlayerTokensResponse": { + "description": "A list of recall token data returned from the RetrieveGamesPlayerTokens RPC", + "id": "RetrieveGamesPlayerTokensResponse", + "properties": { + "applicationRecallTokens": { + "description": "The requested applications along with the recall tokens for the player. If the player does not have recall tokens for an application, that application is not included in the response.", + "items": { + "$ref": "GamePlayerToken" + }, + "type": "array" + } + }, + "type": "object" + }, "RetrievePlayerTokensResponse": { "description": "Response for the RetrievePlayerTokens RPC", "id": "RetrievePlayerTokensResponse", diff --git a/games/v1/games-gen.go b/games/v1/games-gen.go index c0e6cc710e5..7a7c53a85a7 100644 --- a/games/v1/games-gen.go +++ b/games/v1/games-gen.go @@ -1197,6 +1197,30 @@ func (s *EventUpdateResponse) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields) } +// GamePlayerToken: Recall tokens for a game. +type GamePlayerToken struct { + // ApplicationId: The application that this player identifier is for. + ApplicationId string `json:"applicationId,omitempty"` + // Token: Recall token data. + Token []*RecallToken `json:"token,omitempty"` + // ForceSendFields is a list of field names (e.g. "ApplicationId") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "ApplicationId") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s *GamePlayerToken) MarshalJSON() ([]byte, error) { + type NoMethod GamePlayerToken + return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields) +} + // GamesAchievementIncrement: The payload to request to increment an // achievement. type GamesAchievementIncrement struct { @@ -2457,6 +2481,34 @@ func (s *RetrieveDeveloperGamesLastPlayerTokenResponse) MarshalJSON() ([]byte, e return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields) } +// RetrieveGamesPlayerTokensResponse: A list of recall token data returned from +// the RetrieveGamesPlayerTokens RPC +type RetrieveGamesPlayerTokensResponse struct { + // ApplicationRecallTokens: The requested applications along with the recall + // tokens for the player. If the player does not have recall tokens for an + // application, that application is not included in the response. + ApplicationRecallTokens []*GamePlayerToken `json:"applicationRecallTokens,omitempty"` + + // ServerResponse contains the HTTP response code and headers from the server. + googleapi.ServerResponse `json:"-"` + // ForceSendFields is a list of field names (e.g. "ApplicationRecallTokens") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "ApplicationRecallTokens") to + // include in API requests with the JSON null value. By default, fields with + // empty values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s *RetrieveGamesPlayerTokensResponse) MarshalJSON() ([]byte, error) { + type NoMethod RetrieveGamesPlayerTokensResponse + return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields) +} + // RetrievePlayerTokensResponse: Response for the RetrievePlayerTokens RPC type RetrievePlayerTokensResponse struct { // Tokens: Required. Recall tokens associated with the requested PGS Player @@ -5477,6 +5529,125 @@ func (c *PlayersListCall) Pages(ctx context.Context, f func(*PlayerListResponse) } } +type RecallGamesPlayerTokensCall struct { + s *Service + sessionId string + urlParams_ gensupport.URLParams + ifNoneMatch_ string + ctx_ context.Context + header_ http.Header +} + +// GamesPlayerTokens: Retrieve the Recall tokens from all requested games that +// is associated with the PGS Player encoded in the provided recall session id. +// The API is only available for users that have an active PGS Player profile. +// +// - sessionId: Opaque server-generated string that encodes all the necessary +// information to identify the PGS player / Google user and application. +func (r *RecallService) GamesPlayerTokens(sessionId string) *RecallGamesPlayerTokensCall { + c := &RecallGamesPlayerTokensCall{s: r.s, urlParams_: make(gensupport.URLParams)} + c.sessionId = sessionId + return c +} + +// ApplicationIds sets the optional parameter "applicationIds": Required. The +// application IDs from the Google Play developer console for the games to +// return scoped ids for. +func (c *RecallGamesPlayerTokensCall) ApplicationIds(applicationIds ...string) *RecallGamesPlayerTokensCall { + c.urlParams_.SetMulti("applicationIds", append([]string{}, applicationIds...)) + return c +} + +// Fields allows partial responses to be retrieved. See +// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more +// details. +func (c *RecallGamesPlayerTokensCall) Fields(s ...googleapi.Field) *RecallGamesPlayerTokensCall { + c.urlParams_.Set("fields", googleapi.CombineFields(s)) + return c +} + +// IfNoneMatch sets an optional parameter which makes the operation fail if the +// object's ETag matches the given value. This is useful for getting updates +// only after the object has changed since the last request. +func (c *RecallGamesPlayerTokensCall) IfNoneMatch(entityTag string) *RecallGamesPlayerTokensCall { + c.ifNoneMatch_ = entityTag + return c +} + +// Context sets the context to be used in this call's Do method. +func (c *RecallGamesPlayerTokensCall) Context(ctx context.Context) *RecallGamesPlayerTokensCall { + c.ctx_ = ctx + return c +} + +// Header returns a http.Header that can be modified by the caller to add +// headers to the request. +func (c *RecallGamesPlayerTokensCall) Header() http.Header { + if c.header_ == nil { + c.header_ = make(http.Header) + } + return c.header_ +} + +func (c *RecallGamesPlayerTokensCall) doRequest(alt string) (*http.Response, error) { + reqHeaders := gensupport.SetHeaders(c.s.userAgent(), "", c.header_) + if c.ifNoneMatch_ != "" { + reqHeaders.Set("If-None-Match", c.ifNoneMatch_) + } + var body io.Reader = nil + c.urlParams_.Set("alt", alt) + c.urlParams_.Set("prettyPrint", "false") + urls := googleapi.ResolveRelative(c.s.BasePath, "games/v1/recall/gamesPlayerTokens/{sessionId}") + urls += "?" + c.urlParams_.Encode() + req, err := http.NewRequest("GET", urls, body) + if err != nil { + return nil, err + } + req.Header = reqHeaders + googleapi.Expand(req.URL, map[string]string{ + "sessionId": c.sessionId, + }) + return gensupport.SendRequest(c.ctx_, c.s.client, req) +} + +// Do executes the "games.recall.gamesPlayerTokens" call. +// Any non-2xx status code is an error. Response headers are in either +// *RetrieveGamesPlayerTokensResponse.ServerResponse.Header or (if a response +// was returned at all) in error.(*googleapi.Error).Header. Use +// googleapi.IsNotModified to check whether the returned error was because +// http.StatusNotModified was returned. +func (c *RecallGamesPlayerTokensCall) Do(opts ...googleapi.CallOption) (*RetrieveGamesPlayerTokensResponse, error) { + gensupport.SetOptions(c.urlParams_, opts...) + res, err := c.doRequest("json") + if res != nil && res.StatusCode == http.StatusNotModified { + if res.Body != nil { + res.Body.Close() + } + return nil, gensupport.WrapError(&googleapi.Error{ + Code: res.StatusCode, + Header: res.Header, + }) + } + if err != nil { + return nil, err + } + defer googleapi.CloseBody(res) + if err := googleapi.CheckResponse(res); err != nil { + return nil, gensupport.WrapError(err) + } + ret := &RetrieveGamesPlayerTokensResponse{ + ServerResponse: googleapi.ServerResponse{ + Header: res.Header, + HTTPStatusCode: res.StatusCode, + }, + } + target := &ret + if err := gensupport.DecodeResponse(target, res); err != nil { + return nil, err + } + return ret, nil +} + type RecallLastTokenFromAllDeveloperGamesCall struct { s *Service sessionId string @@ -5487,9 +5658,9 @@ type RecallLastTokenFromAllDeveloperGamesCall struct { } // LastTokenFromAllDeveloperGames: Retrieve the last Recall token from all -// developer games that is associated with the PGS Player principal encoded in -// the provided recall session id. The API is only available for users that -// have active PGS Player profile. +// developer games that is associated with the PGS Player encoded in the +// provided recall session id. The API is only available for users that have +// active PGS Player profile. // // - sessionId: Opaque server-generated string that encodes all the necessary // information to identify the PGS player / Google user and application. @@ -5791,8 +5962,8 @@ type RecallRetrieveTokensCall struct { } // RetrieveTokens: Retrieve all Recall tokens associated with the PGS Player -// principal encoded in the provided recall session id. The API is only -// available for users that have active PGS Player profile. +// encoded in the provided recall session id. The API is only available for +// users that have active PGS Player profile. // // - sessionId: Opaque server-generated string that encodes all the necessary // information to identify the PGS player / Google user and application. diff --git a/iam/v1/iam-api.json b/iam/v1/iam-api.json index a555b2e2628..aacbc83fc93 100644 --- a/iam/v1/iam-api.json +++ b/iam/v1/iam-api.json @@ -3216,7 +3216,7 @@ } } }, - "revision": "20240521", + "revision": "20240530", "rootUrl": "https://iam.googleapis.com/", "schemas": { "AccessRestrictions": { @@ -4053,7 +4053,7 @@ "type": "object" }, "OauthClient": { - "description": "Represents an OauthClient. Used to access Google Cloud resources on behave of a user by using OAuth 2.0 Protocol to obtain an access token from Google Cloud Platform.", + "description": "Represents an OauthClient. Used to access Google Cloud resources on behalf of a Workforce Identity Federation user by using OAuth 2.0 Protocol to obtain an access token from Google Cloud.", "id": "OauthClient", "properties": { "allowedGrantTypes": { @@ -4081,7 +4081,7 @@ "type": "array" }, "allowedScopes": { - "description": "Required. The list of scopes that the OauthClient is allowed to request during OAuth flows. The following scopes are supported: * `https://www.googleapis.com/auth/cloud-platform`: See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account. * `openid`: Associate you with your personal info on Google Cloud. * `email`: See your Google Cloud Account email address.", + "description": "Required. The list of scopes that the OauthClient is allowed to request during OAuth flows. The following scopes are supported: * `https://www.googleapis.com/auth/cloud-platform`: See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account.", "items": { "type": "string" }, diff --git a/iam/v1/iam-gen.go b/iam/v1/iam-gen.go index f934b274ad9..2b457fc84e4 100644 --- a/iam/v1/iam-gen.go +++ b/iam/v1/iam-gen.go @@ -1913,8 +1913,8 @@ func (s *ListWorkloadIdentityPoolsResponse) MarshalJSON() ([]byte, error) { } // OauthClient: Represents an OauthClient. Used to access Google Cloud -// resources on behave of a user by using OAuth 2.0 Protocol to obtain an -// access token from Google Cloud Platform. +// resources on behalf of a Workforce Identity Federation user by using OAuth +// 2.0 Protocol to obtain an access token from Google Cloud. type OauthClient struct { // AllowedGrantTypes: Required. The list of OAuth grant types is allowed for // the OauthClient. @@ -1931,8 +1931,7 @@ type OauthClient struct { // to request during OAuth flows. The following scopes are supported: * // `https://www.googleapis.com/auth/cloud-platform`: See, edit, configure, and // delete your Google Cloud data and see the email address for your Google - // Account. * `openid`: Associate you with your personal info on Google Cloud. - // * `email`: See your Google Cloud Account email address. + // Account. AllowedScopes []string `json:"allowedScopes,omitempty"` // ClientId: Output only. The system-generated OauthClient id. ClientId string `json:"clientId,omitempty"` diff --git a/iam/v2/iam-api.json b/iam/v2/iam-api.json index 012b46d5cbd..fb2b251f272 100644 --- a/iam/v2/iam-api.json +++ b/iam/v2/iam-api.json @@ -293,7 +293,7 @@ } } }, - "revision": "20240314", + "revision": "20240530", "rootUrl": "https://iam.googleapis.com/", "schemas": { "CloudControl2SharedOperationsReconciliationOperationMetadata": { @@ -611,6 +611,182 @@ }, "type": "object" }, + "GoogleIamV3OperationMetadata": { + "description": "Represents the metadata of the long-running operation.", + "id": "GoogleIamV3OperationMetadata", + "properties": { + "apiVersion": { + "description": "Output only. API version used to start the operation.", + "readOnly": true, + "type": "string" + }, + "createTime": { + "description": "Output only. The time the operation was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "endTime": { + "description": "Output only. The time the operation finished running.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "requestedCancellation": { + "description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", + "readOnly": true, + "type": "boolean" + }, + "statusMessage": { + "description": "Output only. Human-readable status of the operation, if any.", + "readOnly": true, + "type": "string" + }, + "target": { + "description": "Output only. Server-defined resource path for the target of the", + "readOnly": true, + "type": "string" + }, + "verb": { + "description": "Output only. Name of the verb executed by the operation.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleIamV3alphaOperationMetadata": { + "description": "Represents the metadata of the long-running operation.", + "id": "GoogleIamV3alphaOperationMetadata", + "properties": { + "apiVersion": { + "description": "Output only. API version used to start the operation.", + "readOnly": true, + "type": "string" + }, + "createTime": { + "description": "Output only. The time the operation was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "endTime": { + "description": "Output only. The time the operation finished running.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "requestedCancellation": { + "description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", + "readOnly": true, + "type": "boolean" + }, + "statusMessage": { + "description": "Output only. Human-readable status of the operation, if any.", + "readOnly": true, + "type": "string" + }, + "target": { + "description": "Output only. Server-defined resource path for the target of the", + "readOnly": true, + "type": "string" + }, + "verb": { + "description": "Output only. Name of the verb executed by the operation.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleIamV3betaOperationMetadata": { + "description": "Represents the metadata of the long-running operation.", + "id": "GoogleIamV3betaOperationMetadata", + "properties": { + "apiVersion": { + "description": "Output only. API version used to start the operation.", + "readOnly": true, + "type": "string" + }, + "createTime": { + "description": "Output only. The time the operation was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "endTime": { + "description": "Output only. The time the operation finished running.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "requestedCancellation": { + "description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", + "readOnly": true, + "type": "boolean" + }, + "statusMessage": { + "description": "Output only. Human-readable status of the operation, if any.", + "readOnly": true, + "type": "string" + }, + "target": { + "description": "Output only. Server-defined resource path for the target of the", + "readOnly": true, + "type": "string" + }, + "verb": { + "description": "Output only. Name of the verb executed by the operation.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleIamV3mainOperationMetadata": { + "description": "Represents the metadata of the long-running operation.", + "id": "GoogleIamV3mainOperationMetadata", + "properties": { + "apiVersion": { + "description": "Output only. API version used to start the operation.", + "readOnly": true, + "type": "string" + }, + "createTime": { + "description": "Output only. The time the operation was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "endTime": { + "description": "Output only. The time the operation finished running.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "requestedCancellation": { + "description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", + "readOnly": true, + "type": "boolean" + }, + "statusMessage": { + "description": "Output only. Human-readable status of the operation, if any.", + "readOnly": true, + "type": "string" + }, + "target": { + "description": "Output only. Server-defined resource path for the target of the", + "readOnly": true, + "type": "string" + }, + "verb": { + "description": "Output only. Name of the verb executed by the operation.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "GoogleLongrunningOperation": { "description": "This resource represents a long-running operation that is the result of a network API call.", "id": "GoogleLongrunningOperation", diff --git a/iam/v2/iam-gen.go b/iam/v2/iam-gen.go index 02c1b973807..950add4241e 100644 --- a/iam/v2/iam-gen.go +++ b/iam/v2/iam-gen.go @@ -631,6 +631,158 @@ func (s *GoogleIamV2PolicyRule) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields) } +// GoogleIamV3OperationMetadata: Represents the metadata of the long-running +// operation. +type GoogleIamV3OperationMetadata struct { + // ApiVersion: Output only. API version used to start the operation. + ApiVersion string `json:"apiVersion,omitempty"` + // CreateTime: Output only. The time the operation was created. + CreateTime string `json:"createTime,omitempty"` + // EndTime: Output only. The time the operation finished running. + EndTime string `json:"endTime,omitempty"` + // RequestedCancellation: Output only. Identifies whether the user has + // requested cancellation of the operation. Operations that have successfully + // been cancelled have Operation.error value with a google.rpc.Status.code of + // 1, corresponding to `Code.CANCELLED`. + RequestedCancellation bool `json:"requestedCancellation,omitempty"` + // StatusMessage: Output only. Human-readable status of the operation, if any. + StatusMessage string `json:"statusMessage,omitempty"` + // Target: Output only. Server-defined resource path for the target of the + Target string `json:"target,omitempty"` + // Verb: Output only. Name of the verb executed by the operation. + Verb string `json:"verb,omitempty"` + // ForceSendFields is a list of field names (e.g. "ApiVersion") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "ApiVersion") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s *GoogleIamV3OperationMetadata) MarshalJSON() ([]byte, error) { + type NoMethod GoogleIamV3OperationMetadata + return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields) +} + +// GoogleIamV3alphaOperationMetadata: Represents the metadata of the +// long-running operation. +type GoogleIamV3alphaOperationMetadata struct { + // ApiVersion: Output only. API version used to start the operation. + ApiVersion string `json:"apiVersion,omitempty"` + // CreateTime: Output only. The time the operation was created. + CreateTime string `json:"createTime,omitempty"` + // EndTime: Output only. The time the operation finished running. + EndTime string `json:"endTime,omitempty"` + // RequestedCancellation: Output only. Identifies whether the user has + // requested cancellation of the operation. Operations that have successfully + // been cancelled have Operation.error value with a google.rpc.Status.code of + // 1, corresponding to `Code.CANCELLED`. + RequestedCancellation bool `json:"requestedCancellation,omitempty"` + // StatusMessage: Output only. Human-readable status of the operation, if any. + StatusMessage string `json:"statusMessage,omitempty"` + // Target: Output only. Server-defined resource path for the target of the + Target string `json:"target,omitempty"` + // Verb: Output only. Name of the verb executed by the operation. + Verb string `json:"verb,omitempty"` + // ForceSendFields is a list of field names (e.g. "ApiVersion") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "ApiVersion") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s *GoogleIamV3alphaOperationMetadata) MarshalJSON() ([]byte, error) { + type NoMethod GoogleIamV3alphaOperationMetadata + return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields) +} + +// GoogleIamV3betaOperationMetadata: Represents the metadata of the +// long-running operation. +type GoogleIamV3betaOperationMetadata struct { + // ApiVersion: Output only. API version used to start the operation. + ApiVersion string `json:"apiVersion,omitempty"` + // CreateTime: Output only. The time the operation was created. + CreateTime string `json:"createTime,omitempty"` + // EndTime: Output only. The time the operation finished running. + EndTime string `json:"endTime,omitempty"` + // RequestedCancellation: Output only. Identifies whether the user has + // requested cancellation of the operation. Operations that have successfully + // been cancelled have Operation.error value with a google.rpc.Status.code of + // 1, corresponding to `Code.CANCELLED`. + RequestedCancellation bool `json:"requestedCancellation,omitempty"` + // StatusMessage: Output only. Human-readable status of the operation, if any. + StatusMessage string `json:"statusMessage,omitempty"` + // Target: Output only. Server-defined resource path for the target of the + Target string `json:"target,omitempty"` + // Verb: Output only. Name of the verb executed by the operation. + Verb string `json:"verb,omitempty"` + // ForceSendFields is a list of field names (e.g. "ApiVersion") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "ApiVersion") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s *GoogleIamV3betaOperationMetadata) MarshalJSON() ([]byte, error) { + type NoMethod GoogleIamV3betaOperationMetadata + return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields) +} + +// GoogleIamV3mainOperationMetadata: Represents the metadata of the +// long-running operation. +type GoogleIamV3mainOperationMetadata struct { + // ApiVersion: Output only. API version used to start the operation. + ApiVersion string `json:"apiVersion,omitempty"` + // CreateTime: Output only. The time the operation was created. + CreateTime string `json:"createTime,omitempty"` + // EndTime: Output only. The time the operation finished running. + EndTime string `json:"endTime,omitempty"` + // RequestedCancellation: Output only. Identifies whether the user has + // requested cancellation of the operation. Operations that have successfully + // been cancelled have Operation.error value with a google.rpc.Status.code of + // 1, corresponding to `Code.CANCELLED`. + RequestedCancellation bool `json:"requestedCancellation,omitempty"` + // StatusMessage: Output only. Human-readable status of the operation, if any. + StatusMessage string `json:"statusMessage,omitempty"` + // Target: Output only. Server-defined resource path for the target of the + Target string `json:"target,omitempty"` + // Verb: Output only. Name of the verb executed by the operation. + Verb string `json:"verb,omitempty"` + // ForceSendFields is a list of field names (e.g. "ApiVersion") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "ApiVersion") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s *GoogleIamV3mainOperationMetadata) MarshalJSON() ([]byte, error) { + type NoMethod GoogleIamV3mainOperationMetadata + return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields) +} + // GoogleLongrunningOperation: This resource represents a long-running // operation that is the result of a network API call. type GoogleLongrunningOperation struct { diff --git a/iam/v2beta/iam-api.json b/iam/v2beta/iam-api.json index 9331edf89c3..1e7322619d5 100644 --- a/iam/v2beta/iam-api.json +++ b/iam/v2beta/iam-api.json @@ -293,7 +293,7 @@ } } }, - "revision": "20240314", + "revision": "20240530", "rootUrl": "https://iam.googleapis.com/", "schemas": { "CloudControl2SharedOperationsReconciliationOperationMetadata": { @@ -611,6 +611,182 @@ }, "type": "object" }, + "GoogleIamV3OperationMetadata": { + "description": "Represents the metadata of the long-running operation.", + "id": "GoogleIamV3OperationMetadata", + "properties": { + "apiVersion": { + "description": "Output only. API version used to start the operation.", + "readOnly": true, + "type": "string" + }, + "createTime": { + "description": "Output only. The time the operation was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "endTime": { + "description": "Output only. The time the operation finished running.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "requestedCancellation": { + "description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", + "readOnly": true, + "type": "boolean" + }, + "statusMessage": { + "description": "Output only. Human-readable status of the operation, if any.", + "readOnly": true, + "type": "string" + }, + "target": { + "description": "Output only. Server-defined resource path for the target of the", + "readOnly": true, + "type": "string" + }, + "verb": { + "description": "Output only. Name of the verb executed by the operation.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleIamV3alphaOperationMetadata": { + "description": "Represents the metadata of the long-running operation.", + "id": "GoogleIamV3alphaOperationMetadata", + "properties": { + "apiVersion": { + "description": "Output only. API version used to start the operation.", + "readOnly": true, + "type": "string" + }, + "createTime": { + "description": "Output only. The time the operation was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "endTime": { + "description": "Output only. The time the operation finished running.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "requestedCancellation": { + "description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", + "readOnly": true, + "type": "boolean" + }, + "statusMessage": { + "description": "Output only. Human-readable status of the operation, if any.", + "readOnly": true, + "type": "string" + }, + "target": { + "description": "Output only. Server-defined resource path for the target of the", + "readOnly": true, + "type": "string" + }, + "verb": { + "description": "Output only. Name of the verb executed by the operation.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleIamV3betaOperationMetadata": { + "description": "Represents the metadata of the long-running operation.", + "id": "GoogleIamV3betaOperationMetadata", + "properties": { + "apiVersion": { + "description": "Output only. API version used to start the operation.", + "readOnly": true, + "type": "string" + }, + "createTime": { + "description": "Output only. The time the operation was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "endTime": { + "description": "Output only. The time the operation finished running.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "requestedCancellation": { + "description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", + "readOnly": true, + "type": "boolean" + }, + "statusMessage": { + "description": "Output only. Human-readable status of the operation, if any.", + "readOnly": true, + "type": "string" + }, + "target": { + "description": "Output only. Server-defined resource path for the target of the", + "readOnly": true, + "type": "string" + }, + "verb": { + "description": "Output only. Name of the verb executed by the operation.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleIamV3mainOperationMetadata": { + "description": "Represents the metadata of the long-running operation.", + "id": "GoogleIamV3mainOperationMetadata", + "properties": { + "apiVersion": { + "description": "Output only. API version used to start the operation.", + "readOnly": true, + "type": "string" + }, + "createTime": { + "description": "Output only. The time the operation was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "endTime": { + "description": "Output only. The time the operation finished running.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "requestedCancellation": { + "description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", + "readOnly": true, + "type": "boolean" + }, + "statusMessage": { + "description": "Output only. Human-readable status of the operation, if any.", + "readOnly": true, + "type": "string" + }, + "target": { + "description": "Output only. Server-defined resource path for the target of the", + "readOnly": true, + "type": "string" + }, + "verb": { + "description": "Output only. Name of the verb executed by the operation.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "GoogleLongrunningOperation": { "description": "This resource represents a long-running operation that is the result of a network API call.", "id": "GoogleLongrunningOperation", diff --git a/iam/v2beta/iam-gen.go b/iam/v2beta/iam-gen.go index 63d89d4a25d..bc8a3ee39c3 100644 --- a/iam/v2beta/iam-gen.go +++ b/iam/v2beta/iam-gen.go @@ -631,6 +631,158 @@ func (s *GoogleIamV2betaPolicyRule) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields) } +// GoogleIamV3OperationMetadata: Represents the metadata of the long-running +// operation. +type GoogleIamV3OperationMetadata struct { + // ApiVersion: Output only. API version used to start the operation. + ApiVersion string `json:"apiVersion,omitempty"` + // CreateTime: Output only. The time the operation was created. + CreateTime string `json:"createTime,omitempty"` + // EndTime: Output only. The time the operation finished running. + EndTime string `json:"endTime,omitempty"` + // RequestedCancellation: Output only. Identifies whether the user has + // requested cancellation of the operation. Operations that have successfully + // been cancelled have Operation.error value with a google.rpc.Status.code of + // 1, corresponding to `Code.CANCELLED`. + RequestedCancellation bool `json:"requestedCancellation,omitempty"` + // StatusMessage: Output only. Human-readable status of the operation, if any. + StatusMessage string `json:"statusMessage,omitempty"` + // Target: Output only. Server-defined resource path for the target of the + Target string `json:"target,omitempty"` + // Verb: Output only. Name of the verb executed by the operation. + Verb string `json:"verb,omitempty"` + // ForceSendFields is a list of field names (e.g. "ApiVersion") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "ApiVersion") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s *GoogleIamV3OperationMetadata) MarshalJSON() ([]byte, error) { + type NoMethod GoogleIamV3OperationMetadata + return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields) +} + +// GoogleIamV3alphaOperationMetadata: Represents the metadata of the +// long-running operation. +type GoogleIamV3alphaOperationMetadata struct { + // ApiVersion: Output only. API version used to start the operation. + ApiVersion string `json:"apiVersion,omitempty"` + // CreateTime: Output only. The time the operation was created. + CreateTime string `json:"createTime,omitempty"` + // EndTime: Output only. The time the operation finished running. + EndTime string `json:"endTime,omitempty"` + // RequestedCancellation: Output only. Identifies whether the user has + // requested cancellation of the operation. Operations that have successfully + // been cancelled have Operation.error value with a google.rpc.Status.code of + // 1, corresponding to `Code.CANCELLED`. + RequestedCancellation bool `json:"requestedCancellation,omitempty"` + // StatusMessage: Output only. Human-readable status of the operation, if any. + StatusMessage string `json:"statusMessage,omitempty"` + // Target: Output only. Server-defined resource path for the target of the + Target string `json:"target,omitempty"` + // Verb: Output only. Name of the verb executed by the operation. + Verb string `json:"verb,omitempty"` + // ForceSendFields is a list of field names (e.g. "ApiVersion") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "ApiVersion") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s *GoogleIamV3alphaOperationMetadata) MarshalJSON() ([]byte, error) { + type NoMethod GoogleIamV3alphaOperationMetadata + return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields) +} + +// GoogleIamV3betaOperationMetadata: Represents the metadata of the +// long-running operation. +type GoogleIamV3betaOperationMetadata struct { + // ApiVersion: Output only. API version used to start the operation. + ApiVersion string `json:"apiVersion,omitempty"` + // CreateTime: Output only. The time the operation was created. + CreateTime string `json:"createTime,omitempty"` + // EndTime: Output only. The time the operation finished running. + EndTime string `json:"endTime,omitempty"` + // RequestedCancellation: Output only. Identifies whether the user has + // requested cancellation of the operation. Operations that have successfully + // been cancelled have Operation.error value with a google.rpc.Status.code of + // 1, corresponding to `Code.CANCELLED`. + RequestedCancellation bool `json:"requestedCancellation,omitempty"` + // StatusMessage: Output only. Human-readable status of the operation, if any. + StatusMessage string `json:"statusMessage,omitempty"` + // Target: Output only. Server-defined resource path for the target of the + Target string `json:"target,omitempty"` + // Verb: Output only. Name of the verb executed by the operation. + Verb string `json:"verb,omitempty"` + // ForceSendFields is a list of field names (e.g. "ApiVersion") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "ApiVersion") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s *GoogleIamV3betaOperationMetadata) MarshalJSON() ([]byte, error) { + type NoMethod GoogleIamV3betaOperationMetadata + return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields) +} + +// GoogleIamV3mainOperationMetadata: Represents the metadata of the +// long-running operation. +type GoogleIamV3mainOperationMetadata struct { + // ApiVersion: Output only. API version used to start the operation. + ApiVersion string `json:"apiVersion,omitempty"` + // CreateTime: Output only. The time the operation was created. + CreateTime string `json:"createTime,omitempty"` + // EndTime: Output only. The time the operation finished running. + EndTime string `json:"endTime,omitempty"` + // RequestedCancellation: Output only. Identifies whether the user has + // requested cancellation of the operation. Operations that have successfully + // been cancelled have Operation.error value with a google.rpc.Status.code of + // 1, corresponding to `Code.CANCELLED`. + RequestedCancellation bool `json:"requestedCancellation,omitempty"` + // StatusMessage: Output only. Human-readable status of the operation, if any. + StatusMessage string `json:"statusMessage,omitempty"` + // Target: Output only. Server-defined resource path for the target of the + Target string `json:"target,omitempty"` + // Verb: Output only. Name of the verb executed by the operation. + Verb string `json:"verb,omitempty"` + // ForceSendFields is a list of field names (e.g. "ApiVersion") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "ApiVersion") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s *GoogleIamV3mainOperationMetadata) MarshalJSON() ([]byte, error) { + type NoMethod GoogleIamV3mainOperationMetadata + return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields) +} + // GoogleLongrunningOperation: This resource represents a long-running // operation that is the result of a network API call. type GoogleLongrunningOperation struct {