google-api-python-client 2.178.0__py3-none-any.whl → 2.179.0__py3-none-any.whl

googleapiclient/discovery_cache/documents/discoveryengine.v1.json

@@ -7291,7 +7291,7 @@
 }
 }
 },
-"revision": "20250728",
+"revision": "20250803",
 "rootUrl": "https://discoveryengine.googleapis.com/",
 "schemas": {
 "GdataBlobstore2Info": {
@@ -9776,9 +9776,40 @@
 "description": "Discovery Engine Assistant resource.",
 "id": "GoogleCloudDiscoveryengineV1Assistant",
 "properties": {
+"customerPolicy": {
+"$ref": "GoogleCloudDiscoveryengineV1AssistantCustomerPolicy",
+"description": "Optional. Customer policy for the assistant."
+},
+"enabledTools": {
+"additionalProperties": {
+"$ref": "GoogleCloudDiscoveryengineV1AssistantToolList"
+},
+"description": "Optional. Note: not implemented yet. Use enabled_actions instead. The enabled tools on this assistant. The keys are connector name, for example \"projects/{projectId}/locations/{locationId}/collections/{collectionId}/dataconnector The values consist of admin enabled tools towards the connector instance. Admin can selectively enable multiple tools on any of the connector instances that they created in the project. For example {\"jira1ConnectorName\": [(toolId1, \"createTicket\"), (toolId2, \"transferTicket\")], \"gmail1ConnectorName\": [(toolId3, \"sendEmail\"),..] }",
+"type": "object"
+},
+"generationConfig": {
+"$ref": "GoogleCloudDiscoveryengineV1AssistantGenerationConfig",
+"description": "Optional. Configuration for the generation of the assistant response."
+},
 "name": {
 "description": "Immutable. Resource name of the assistant. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}` It must be a UTF-8 encoded string with a length limit of 1024 characters.",
 "type": "string"
+},
+"webGroundingType": {
+"description": "Optional. The type of web grounding to use.",
+"enum": [
+"WEB_GROUNDING_TYPE_UNSPECIFIED",
+"WEB_GROUNDING_TYPE_DISABLED",
+"WEB_GROUNDING_TYPE_GOOGLE_SEARCH",
+"WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH"
+],
+"enumDescriptions": [
+"Default, unspecified setting. This is the same as disabled.",
+"Web grounding is disabled.",
+"Grounding with Google Search is enabled.",
+"Grounding with Enterprise Web Search is enabled."
+],
+"type": "string"
 }
 },
 "type": "object"
@@ -9887,6 +9918,75 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1AssistantCustomerPolicy": {
+"description": "Customer-defined policy for the assistant.",
+"id": "GoogleCloudDiscoveryengineV1AssistantCustomerPolicy",
+"properties": {
+"bannedPhrases": {
+"description": "Optional. List of banned phrases.",
+"items": {
+"$ref": "GoogleCloudDiscoveryengineV1AssistantCustomerPolicyBannedPhrase"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1AssistantCustomerPolicyBannedPhrase": {
+"description": "Definition of a customer-defined banned phrase. A banned phrase is not allowed to appear in the user query or the LLM response, or else the answer will be refused.",
+"id": "GoogleCloudDiscoveryengineV1AssistantCustomerPolicyBannedPhrase",
+"properties": {
+"ignoreDiacritics": {
+"description": "Optional. If true, diacritical marks (e.g., accents, umlauts) are ignored when matching banned phrases. For example, \"cafe\" would match \"caf\u00e9\".",
+"type": "boolean"
+},
+"matchType": {
+"description": "Optional. Match type for the banned phrase.",
+"enum": [
+"BANNED_PHRASE_MATCH_TYPE_UNSPECIFIED",
+"SIMPLE_STRING_MATCH",
+"WORD_BOUNDARY_STRING_MATCH"
+],
+"enumDescriptions": [
+"Defaults to SIMPLE_STRING_MATCH.",
+"The banned phrase matches if it is found anywhere in the text as an exact substring.",
+"Banned phrase only matches if the pattern found in the text is surrounded by word delimiters. The phrase itself may still contain word delimiters."
+],
+"type": "string"
+},
+"phrase": {
+"description": "Required. The raw string content to be banned.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1AssistantGenerationConfig": {
+"description": "Configuration for the generation of the assistant response.",
+"id": "GoogleCloudDiscoveryengineV1AssistantGenerationConfig",
+"properties": {
+"defaultLanguage": {
+"description": "The default language to use for the generation of the assistant response. Use an ISO 639-1 language code such as `en`. If not specified, the language will be automatically detected.",
+"type": "string"
+},
+"systemInstruction": {
+"$ref": "GoogleCloudDiscoveryengineV1AssistantGenerationConfigSystemInstruction",
+"description": "System instruction, also known as the prompt preamble for LLM calls. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/prompts/system-instructions"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1AssistantGenerationConfigSystemInstruction": {
+"description": "System instruction, also known as the prompt preamble for LLM calls.",
+"id": "GoogleCloudDiscoveryengineV1AssistantGenerationConfigSystemInstruction",
+"properties": {
+"additionalSystemInstruction": {
+"description": "Optional. Additional system instruction that will be added to the default system instruction.",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1AssistantGroundedContent": {
 "description": "A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like \"Of course, I will gladly search it for you.\" do not need grounding.",
 "id": "GoogleCloudDiscoveryengineV1AssistantGroundedContent",
@@ -9999,6 +10099,35 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1AssistantToolInfo": {
+"description": "Information to identify a tool.",
+"id": "GoogleCloudDiscoveryengineV1AssistantToolInfo",
+"properties": {
+"toolDisplayName": {
+"description": "The display name of the tool.",
+"type": "string"
+},
+"toolName": {
+"description": "The name of the tool as defined by DataConnectorService.QueryAvailableActions. Note: it's using `action` in the DataConnectorService apis, but they are the same as the `tool` here.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1AssistantToolList": {
+"description": "The enabled tools on a connector",
+"id": "GoogleCloudDiscoveryengineV1AssistantToolList",
+"properties": {
+"toolInfo": {
+"description": "The list of tools with corresponding tool information.",
+"items": {
+"$ref": "GoogleCloudDiscoveryengineV1AssistantToolInfo"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1BatchCreateTargetSiteMetadata": {
 "description": "Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field.",
 "id": "GoogleCloudDiscoveryengineV1BatchCreateTargetSiteMetadata",
@@ -10619,6 +10748,10 @@
 "description": "Document metadata contains the information of the document of the current chunk.",
 "id": "GoogleCloudDiscoveryengineV1ChunkDocumentMetadata",
 "properties": {
+"mimeType": {
+"description": "The mime type of the document. https://www.iana.org/assignments/media-types/media-types.xhtml.",
+"type": "string"
+},
 "structData": {
 "additionalProperties": {
 "description": "Properties of the object.",

googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json

@@ -8049,13 +8049,13 @@
 ],
 "parameters": {
 "pageSize": {
-"description": "Maximum number of Evaluations to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.",
+"description": "Optional. Maximum number of Evaluations to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.",
 "format": "int32",
 "location": "query",
 "type": "integer"
 },
 "pageToken": {
-"description": "A page token ListEvaluationsResponse.next_page_token, received from a previous EvaluationService.ListEvaluations call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to EvaluationService.ListEvaluations must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.",
+"description": "Optional. A page token ListEvaluationsResponse.next_page_token, received from a previous EvaluationService.ListEvaluations call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to EvaluationService.ListEvaluations must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.",
 "location": "query",
 "type": "string"
 },
@@ -8092,13 +8092,13 @@
 "type": "string"
 },
 "pageSize": {
-"description": "Maximum number of ListEvaluationResultsResponse.EvaluationResult to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.",
+"description": "Optional. Maximum number of ListEvaluationResultsResponse.EvaluationResult to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.",
 "format": "int32",
 "location": "query",
 "type": "integer"
 },
 "pageToken": {
-"description": "A page token ListEvaluationResultsResponse.next_page_token, received from a previous EvaluationService.ListEvaluationResults call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to EvaluationService.ListEvaluationResults must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.",
+"description": "Optional. A page token ListEvaluationResultsResponse.next_page_token, received from a previous EvaluationService.ListEvaluationResults call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to EvaluationService.ListEvaluationResults must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.",
 "location": "query",
 "type": "string"
 }
@@ -9452,7 +9452,7 @@
 }
 }
 },
-"revision": "20250728",
+"revision": "20250803",
 "rootUrl": "https://discoveryengine.googleapis.com/",
 "schemas": {
 "ApiservingMediaRequestInfo": {
@@ -10533,9 +10533,138 @@
 "description": "Discovery Engine Assistant resource.",
 "id": "GoogleCloudDiscoveryengineV1Assistant",
 "properties": {
+"customerPolicy": {
+"$ref": "GoogleCloudDiscoveryengineV1AssistantCustomerPolicy",
+"description": "Optional. Customer policy for the assistant."
+},
+"enabledTools": {
+"additionalProperties": {
+"$ref": "GoogleCloudDiscoveryengineV1AssistantToolList"
+},
+"description": "Optional. Note: not implemented yet. Use enabled_actions instead. The enabled tools on this assistant. The keys are connector name, for example \"projects/{projectId}/locations/{locationId}/collections/{collectionId}/dataconnector The values consist of admin enabled tools towards the connector instance. Admin can selectively enable multiple tools on any of the connector instances that they created in the project. For example {\"jira1ConnectorName\": [(toolId1, \"createTicket\"), (toolId2, \"transferTicket\")], \"gmail1ConnectorName\": [(toolId3, \"sendEmail\"),..] }",
+"type": "object"
+},
+"generationConfig": {
+"$ref": "GoogleCloudDiscoveryengineV1AssistantGenerationConfig",
+"description": "Optional. Configuration for the generation of the assistant response."
+},
 "name": {
 "description": "Immutable. Resource name of the assistant. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}` It must be a UTF-8 encoded string with a length limit of 1024 characters.",
 "type": "string"
+},
+"webGroundingType": {
+"description": "Optional. The type of web grounding to use.",
+"enum": [
+"WEB_GROUNDING_TYPE_UNSPECIFIED",
+"WEB_GROUNDING_TYPE_DISABLED",
+"WEB_GROUNDING_TYPE_GOOGLE_SEARCH",
+"WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH"
+],
+"enumDescriptions": [
+"Default, unspecified setting. This is the same as disabled.",
+"Web grounding is disabled.",
+"Grounding with Google Search is enabled.",
+"Grounding with Enterprise Web Search is enabled."
+],
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1AssistantCustomerPolicy": {
+"description": "Customer-defined policy for the assistant.",
+"id": "GoogleCloudDiscoveryengineV1AssistantCustomerPolicy",
+"properties": {
+"bannedPhrases": {
+"description": "Optional. List of banned phrases.",
+"items": {
+"$ref": "GoogleCloudDiscoveryengineV1AssistantCustomerPolicyBannedPhrase"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1AssistantCustomerPolicyBannedPhrase": {
+"description": "Definition of a customer-defined banned phrase. A banned phrase is not allowed to appear in the user query or the LLM response, or else the answer will be refused.",
+"id": "GoogleCloudDiscoveryengineV1AssistantCustomerPolicyBannedPhrase",
+"properties": {
+"ignoreDiacritics": {
+"description": "Optional. If true, diacritical marks (e.g., accents, umlauts) are ignored when matching banned phrases. For example, \"cafe\" would match \"caf\u00e9\".",
+"type": "boolean"
+},
+"matchType": {
+"description": "Optional. Match type for the banned phrase.",
+"enum": [
+"BANNED_PHRASE_MATCH_TYPE_UNSPECIFIED",
+"SIMPLE_STRING_MATCH",
+"WORD_BOUNDARY_STRING_MATCH"
+],
+"enumDescriptions": [
+"Defaults to SIMPLE_STRING_MATCH.",
+"The banned phrase matches if it is found anywhere in the text as an exact substring.",
+"Banned phrase only matches if the pattern found in the text is surrounded by word delimiters. The phrase itself may still contain word delimiters."
+],
+"type": "string"
+},
+"phrase": {
+"description": "Required. The raw string content to be banned.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1AssistantGenerationConfig": {
+"description": "Configuration for the generation of the assistant response.",
+"id": "GoogleCloudDiscoveryengineV1AssistantGenerationConfig",
+"properties": {
+"defaultLanguage": {
+"description": "The default language to use for the generation of the assistant response. Use an ISO 639-1 language code such as `en`. If not specified, the language will be automatically detected.",
+"type": "string"
+},
+"systemInstruction": {
+"$ref": "GoogleCloudDiscoveryengineV1AssistantGenerationConfigSystemInstruction",
+"description": "System instruction, also known as the prompt preamble for LLM calls. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/prompts/system-instructions"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1AssistantGenerationConfigSystemInstruction": {
+"description": "System instruction, also known as the prompt preamble for LLM calls.",
+"id": "GoogleCloudDiscoveryengineV1AssistantGenerationConfigSystemInstruction",
+"properties": {
+"additionalSystemInstruction": {
+"description": "Optional. Additional system instruction that will be added to the default system instruction.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1AssistantToolInfo": {
+"description": "Information to identify a tool.",
+"id": "GoogleCloudDiscoveryengineV1AssistantToolInfo",
+"properties": {
+"toolDisplayName": {
+"description": "The display name of the tool.",
+"type": "string"
+},
+"toolName": {
+"description": "The name of the tool as defined by DataConnectorService.QueryAvailableActions. Note: it's using `action` in the DataConnectorService apis, but they are the same as the `tool` here.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1AssistantToolList": {
+"description": "The enabled tools on a connector",
+"id": "GoogleCloudDiscoveryengineV1AssistantToolList",
+"properties": {
+"toolInfo": {
+"description": "The list of tools with corresponding tool information.",
+"items": {
+"$ref": "GoogleCloudDiscoveryengineV1AssistantToolInfo"
+},
+"type": "array"
 }
 },
 "type": "object"
@@ -14940,9 +15069,40 @@
 "description": "Discovery Engine Assistant resource.",
 "id": "GoogleCloudDiscoveryengineV1alphaAssistant",
 "properties": {
+"customerPolicy": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaAssistantCustomerPolicy",
+"description": "Optional. Customer policy for the assistant."
+},
+"enabledTools": {
+"additionalProperties": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaAssistantToolList"
+},
+"description": "Optional. Note: not implemented yet. Use enabled_actions instead. The enabled tools on this assistant. The keys are connector name, for example \"projects/{projectId}/locations/{locationId}/collections/{collectionId}/dataconnector The values consist of admin enabled tools towards the connector instance. Admin can selectively enable multiple tools on any of the connector instances that they created in the project. For example {\"jira1ConnectorName\": [(toolId1, \"createTicket\"), (toolId2, \"transferTicket\")], \"gmail1ConnectorName\": [(toolId3, \"sendEmail\"),..] }",
+"type": "object"
+},
+"generationConfig": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaAssistantGenerationConfig",
+"description": "Optional. Configuration for the generation of the assistant response."
+},
 "name": {
 "description": "Immutable. Resource name of the assistant. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}` It must be a UTF-8 encoded string with a length limit of 1024 characters.",
 "type": "string"
+},
+"webGroundingType": {
+"description": "Optional. The type of web grounding to use.",
+"enum": [
+"WEB_GROUNDING_TYPE_UNSPECIFIED",
+"WEB_GROUNDING_TYPE_DISABLED",
+"WEB_GROUNDING_TYPE_GOOGLE_SEARCH",
+"WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH"
+],
+"enumDescriptions": [
+"Default, unspecified setting. This is the same as disabled.",
+"Web grounding is disabled.",
+"Grounding with Google Search is enabled.",
+"Grounding with Enterprise Web Search is enabled."
+],
+"type": "string"
 }
 },
 "type": "object"
@@ -15051,6 +15211,75 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1alphaAssistantCustomerPolicy": {
+"description": "Customer-defined policy for the assistant.",
+"id": "GoogleCloudDiscoveryengineV1alphaAssistantCustomerPolicy",
+"properties": {
+"bannedPhrases": {
+"description": "Optional. List of banned phrases.",
+"items": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaAssistantCustomerPolicyBannedPhrase"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1alphaAssistantCustomerPolicyBannedPhrase": {
+"description": "Definition of a customer-defined banned phrase. A banned phrase is not allowed to appear in the user query or the LLM response, or else the answer will be refused.",
+"id": "GoogleCloudDiscoveryengineV1alphaAssistantCustomerPolicyBannedPhrase",
+"properties": {
+"ignoreDiacritics": {
+"description": "Optional. If true, diacritical marks (e.g., accents, umlauts) are ignored when matching banned phrases. For example, \"cafe\" would match \"caf\u00e9\".",
+"type": "boolean"
+},
+"matchType": {
+"description": "Optional. Match type for the banned phrase.",
+"enum": [
+"BANNED_PHRASE_MATCH_TYPE_UNSPECIFIED",
+"SIMPLE_STRING_MATCH",
+"WORD_BOUNDARY_STRING_MATCH"
+],
+"enumDescriptions": [
+"Defaults to SIMPLE_STRING_MATCH.",
+"The banned phrase matches if it is found anywhere in the text as an exact substring.",
+"Banned phrase only matches if the pattern found in the text is surrounded by word delimiters. The phrase itself may still contain word delimiters."
+],
+"type": "string"
+},
+"phrase": {
+"description": "Required. The raw string content to be banned.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1alphaAssistantGenerationConfig": {
+"description": "Configuration for the generation of the assistant response.",
+"id": "GoogleCloudDiscoveryengineV1alphaAssistantGenerationConfig",
+"properties": {
+"defaultLanguage": {
+"description": "The default language to use for the generation of the assistant response. Use an ISO 639-1 language code such as `en`. If not specified, the language will be automatically detected.",
+"type": "string"
+},
+"systemInstruction": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaAssistantGenerationConfigSystemInstruction",
+"description": "System instruction, also known as the prompt preamble for LLM calls. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/prompts/system-instructions"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1alphaAssistantGenerationConfigSystemInstruction": {
+"description": "System instruction, also known as the prompt preamble for LLM calls.",
+"id": "GoogleCloudDiscoveryengineV1alphaAssistantGenerationConfigSystemInstruction",
+"properties": {
+"additionalSystemInstruction": {
+"description": "Optional. Additional system instruction that will be added to the default system instruction.",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1alphaAssistantGroundedContent": {
 "description": "A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like \"Of course, I will gladly search it for you.\" do not need grounding.",
 "id": "GoogleCloudDiscoveryengineV1alphaAssistantGroundedContent",
@@ -15163,6 +15392,35 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1alphaAssistantToolInfo": {
+"description": "Information to identify a tool.",
+"id": "GoogleCloudDiscoveryengineV1alphaAssistantToolInfo",
+"properties": {
+"toolDisplayName": {
+"description": "The display name of the tool.",
+"type": "string"
+},
+"toolName": {
+"description": "The name of the tool as defined by DataConnectorService.QueryAvailableActions. Note: it's using `action` in the DataConnectorService apis, but they are the same as the `tool` here.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1alphaAssistantToolList": {
+"description": "The enabled tools on a connector",
+"id": "GoogleCloudDiscoveryengineV1alphaAssistantToolList",
+"properties": {
+"toolInfo": {
+"description": "The list of tools with corresponding tool information.",
+"items": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaAssistantToolInfo"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1alphaBAPConfig": {
 "description": "The configuration for the BAP connector.",
 "id": "GoogleCloudDiscoveryengineV1alphaBAPConfig",
@@ -15901,6 +16159,10 @@
 "description": "Document metadata contains the information of the document of the current chunk.",
 "id": "GoogleCloudDiscoveryengineV1alphaChunkDocumentMetadata",
 "properties": {
+"mimeType": {
+"description": "The mime type of the document. https://www.iana.org/assignments/media-types/media-types.xhtml.",
+"type": "string"
+},
 "structData": {
 "additionalProperties": {
 "description": "Properties of the object.",