{ "kind": "discovery#restDescription", "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "schemas": { "A2aV1OAuth2SecurityScheme": { "type": "object", "properties": { "oauth2MetadataUrl": { "description": "URL to the oauth2 authorization server metadata [RFC8414](https://datatracker.ietf.org/doc/html/rfc8414). TLS is required.", "type": "string" }, "description": { "type": "string", "description": "Description of this security scheme." }, "flows": { "$ref": "A2aV1OAuthFlows", "description": "An object containing configuration information for the flow types supported" } }, "id": "A2aV1OAuth2SecurityScheme" }, "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservation": { "properties": { "searchResults": { "type": "array", "description": "Search results observed by the search action, it can be snippets info or chunk info, depending on the citation type set by the user.", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResult" } } }, "type": "object", "id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservation", "description": "Observation." }, "GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesRequest": { "type": "object", "description": "Request message for CompletionService.PurgeSuggestionDenyListEntries method.", "id": "GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesRequest", "properties": {} }, "GoogleCloudDiscoveryengineV1SiteVerificationInfo": { "id": "GoogleCloudDiscoveryengineV1SiteVerificationInfo", "properties": { "verifyTime": { "type": "string", "description": "Latest site verification time.", "format": "google-datetime" }, "siteVerificationState": { "enumDescriptions": [ "Defaults to VERIFIED.", "Site ownership verified.", "Site ownership pending verification or verification failed.", "Site exempt from verification, e.g., a public website that opens to all." ], "description": "Site verification state indicating the ownership and validity.", "enum": [ "SITE_VERIFICATION_STATE_UNSPECIFIED", "VERIFIED", "UNVERIFIED", "EXEMPTED" ], "type": "string" } }, "description": "Verification information for target sites in advanced site search.", "type": "object" }, "GoogleCloudDiscoveryengineV1StreamAssistResponseInvokedSkill": { "id": "GoogleCloudDiscoveryengineV1StreamAssistResponseInvokedSkill", "properties": { "name": { "type": "string", "description": "The resource name of the skill." }, "displayName": { "description": "The display name of the skill.", "type": "string" } }, "description": "Represents a skill used during the assist call.", "type": "object" }, "GoogleCloudDiscoveryengineV1TextInput": { "id": "GoogleCloudDiscoveryengineV1TextInput", "type": "object", "description": "Defines text input.", "properties": { "input": { "description": "Text input.", "type": "string" }, "context": { "description": "Conversation context of the input.", "$ref": "GoogleCloudDiscoveryengineV1ConversationContext" } } }, "GoogleMonitoringV3TimeInterval": { "type": "object", "id": "GoogleMonitoringV3TimeInterval", "description": "A time interval extending just after a start time through an end time. If the start time is the same as the end time, then the interval represents a single point in time.", "properties": { "endTime": { "type": "string", "description": "Required. The end of the time interval.", "format": "google-datetime" }, "startTime": { "type": "string", "format": "google-datetime", "description": "Optional. The beginning of the time interval. The default value for the start time is the end time. The start time must not be later than the end time." } } }, "GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentStats": { "description": "Stats about the experiment.", "type": "object", "id": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentStats", "properties": { "inputTokenCount": { "format": "int64", "type": "string", "readOnly": true, "description": "Output only. Number of billed input tokens consumed by the experiment." }, "outputTokenCount": { "readOnly": true, "format": "int64", "description": "Output only. Number of billed output tokens consumed by the experiment.", "type": "string" }, "candidatesCount": { "description": "Output only. Number of candidates generated.", "readOnly": true, "type": "integer", "format": "int32" }, "evaluatedCandidatesCount": { "readOnly": true, "type": "integer", "format": "int32", "description": "Output only. Number of candidates evaluated." } } }, "GoogleCloudDiscoveryengineV1Control": { "id": "GoogleCloudDiscoveryengineV1Control", "properties": { "redirectAction": { "description": "Defines a redirect-type control.", "$ref": "GoogleCloudDiscoveryengineV1ControlRedirectAction" }, "synonymsAction": { "description": "Treats a group of terms as synonyms of one another.", "$ref": "GoogleCloudDiscoveryengineV1ControlSynonymsAction" }, "useCases": { "items": { "enum": [ "SEARCH_USE_CASE_UNSPECIFIED", "SEARCH_USE_CASE_SEARCH", "SEARCH_USE_CASE_BROWSE" ], "type": "string", "enumDescriptions": [ "Value used when unset. Will not occur in CSS.", "Search use case. Expects the traffic has a non-empty query.", "Browse use case. Expects the traffic has an empty query." ] }, "type": "array", "description": "Specifies the use case for the control. Affects what condition fields can be set. Only applies to SOLUTION_TYPE_SEARCH. Currently only allow one use case per control. Must be set when solution_type is SolutionType.SOLUTION_TYPE_SEARCH." }, "name": { "type": "string", "description": "Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*`" }, "associatedServingConfigIds": { "description": "Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes.", "items": { "type": "string" }, "readOnly": true, "type": "array" }, "filterAction": { "$ref": "GoogleCloudDiscoveryengineV1ControlFilterAction", "description": "Defines a filter-type control Currently not supported by Recommendation" }, "promoteAction": { "description": "Promote certain links based on predefined trigger queries.", "$ref": "GoogleCloudDiscoveryengineV1ControlPromoteAction" }, "conditions": { "items": { "$ref": "GoogleCloudDiscoveryengineV1Condition" }, "description": "Determines when the associated action will trigger. Omit to always apply the action. Currently only a single condition may be specified. Otherwise an INVALID ARGUMENT error is thrown.", "type": "array" }, "boostAction": { "$ref": "GoogleCloudDiscoveryengineV1ControlBoostAction", "description": "Defines a boost-type control" }, "displayName": { "type": "string", "description": "Required. Human readable name. The identifier used in UI views. Must be UTF-8 encoded string. Length limit is 128 characters. Otherwise an INVALID ARGUMENT error is thrown." }, "solutionType": { "enum": [ "SOLUTION_TYPE_UNSPECIFIED", "SOLUTION_TYPE_RECOMMENDATION", "SOLUTION_TYPE_SEARCH", "SOLUTION_TYPE_CHAT", "SOLUTION_TYPE_GENERATIVE_CHAT", "SOLUTION_TYPE_AI_MODE" ], "type": "string", "enumDescriptions": [ "Default value.", "Used for Recommendations AI.", "Used for Discovery Search.", "Used for use cases related to the Generative AI agent.", "Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution.", "Used for AI Mode." ], "description": "Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown." } }, "description": "Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`.", "type": "object" }, "GoogleCloudDiscoveryengineV1alphaDataStoreFederatedSearchConfigNotebooklmConfig": { "type": "object", "id": "GoogleCloudDiscoveryengineV1alphaDataStoreFederatedSearchConfigNotebooklmConfig", "properties": { "searchConfig": { "description": "Required. Search config name. Format: projects/*/locations/global/notebookLmSearchConfigs/*", "type": "string" } }, "description": "Config for connecting to NotebookLM Enterprise." }, "GoogleCloudDiscoveryengineV1betaEngineChatEngineConfigAgentCreationConfig": { "description": "Configurations for generating a Dialogflow agent. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation.", "type": "object", "properties": { "defaultLanguageCode": { "description": "Required. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes.", "type": "string" }, "business": { "description": "Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search.", "type": "string" }, "location": { "type": "string", "description": "Agent location for Agent creation, supported values: global/us/eu. If not provided, us Engine will create Agent using us-central-1 by default; eu Engine will create Agent using eu-west-1 by default." }, "timeZone": { "type": "string", "description": "Required. The time zone of the agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris." } }, "id": "GoogleCloudDiscoveryengineV1betaEngineChatEngineConfigAgentCreationConfig" }, "GoogleCloudDiscoveryengineV1alphaUpdateSessionRequest": { "id": "GoogleCloudDiscoveryengineV1alphaUpdateSessionRequest", "properties": { "updateMask": { "type": "string", "format": "google-fieldmask", "description": "Indicates which fields in the provided Session to update. The following are NOT supported: * Session.name If not set or empty, all supported fields are updated." }, "session": { "$ref": "GoogleCloudDiscoveryengineV1alphaSession", "description": "Required. The Session to update." } }, "description": "Request for UpdateSession method.", "type": "object" }, "GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpec": { "id": "GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpec", "properties": { "fieldName": { "description": "Optional. The name of the field whose value will be used to determine the boost amount.", "type": "string" }, "attributeType": { "enum": [ "ATTRIBUTE_TYPE_UNSPECIFIED", "NUMERICAL", "FRESHNESS" ], "enumDescriptions": [ "Unspecified AttributeType.", "The value of the numerical field will be used to dynamically update the boost amount. In this case, the attribute_value (the x value) of the control point will be the actual value of the numerical field for which the boost_amount is specified.", "For the freshness use case the attribute value will be the duration between the current time and the date in the datetime field specified. The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`. For example, `5D`, `3DT12H30M`, `T24H`." ], "description": "Optional. The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value).", "type": "string" }, "interpolationType": { "type": "string", "enumDescriptions": [ "Interpolation type is unspecified. In this case, it defaults to Linear.", "Piecewise linear interpolation will be applied." ], "enum": [ "INTERPOLATION_TYPE_UNSPECIFIED", "LINEAR" ], "description": "Optional. The interpolation type to be applied to connect the control points listed below." }, "controlPoints": { "items": { "$ref": "GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpecControlPoint" }, "description": "Optional. The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here.", "type": "array" } }, "description": "Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above.", "type": "object" }, "GoogleCloudDiscoveryengineV1alphaCmekConfig": { "description": "Configurations used to enable CMEK data encryption with Cloud KMS keys.", "type": "object", "id": "GoogleCloudDiscoveryengineV1alphaCmekConfig", "properties": { "kmsKey": { "description": "Required. KMS key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.", "type": "string" }, "kmsKeyVersion": { "readOnly": true, "type": "string", "description": "Output only. KMS key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`." }, "name": { "type": "string", "description": "Required. The name of the CmekConfig of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmek_config}`." }, "state": { "enumDescriptions": [ "The CmekConfig state is unknown.", "The CmekConfig is creating.", "The CmekConfig can be used with DataStores.", "The CmekConfig is unavailable, most likely due to the KMS Key being revoked.", "The CmekConfig is deleting.", "The CmekConfig deletion process failed.", "The CmekConfig is not usable, most likely due to some internal issue.", "The KMS key version is being rotated.", "The KMS key is soft deleted. Some cleanup policy will eventually be applied.", "The KMS key is expired, meaning the key has been disabled for 30+ days. The customer can call DeleteCmekConfig to change the state to DELETED." ], "readOnly": true, "type": "string", "description": "Output only. The states of the CmekConfig.", "enum": [ "STATE_UNSPECIFIED", "CREATING", "ACTIVE", "KEY_ISSUE", "DELETING", "DELETE_FAILED", "UNUSABLE", "ACTIVE_ROTATING", "DELETED", "EXPIRED" ] }, "notebooklmState": { "type": "string", "readOnly": true, "description": "Output only. Whether the NotebookLM Corpus is ready to be used.", "enumDescriptions": [ "The NotebookLM state is unknown.", "The NotebookLM is not ready.", "The NotebookLM is ready to be used.", "The NotebookLM is not enabled." ], "enum": [ "NOTEBOOK_LM_STATE_UNSPECIFIED", "NOTEBOOK_LM_NOT_READY", "NOTEBOOK_LM_READY", "NOTEBOOK_LM_NOT_ENABLED" ] }, "lastRotationTimestampMicros": { "format": "int64", "readOnly": true, "description": "Output only. The timestamp of the last key rotation.", "type": "string" }, "isDefault": { "description": "Output only. The default CmekConfig for the Customer.", "readOnly": true, "type": "boolean" }, "singleRegionKeys": { "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaSingleRegionKey" }, "description": "Optional. Single-regional CMEKs that are required for some VAIS features." } } }, "GoogleCloudDiscoveryengineV1AnswerQueryUnderstandingInfoQueryClassificationInfo": { "description": "Query classification information.", "type": "object", "properties": { "positive": { "type": "boolean", "description": "Classification output." }, "type": { "type": "string", "enumDescriptions": [ "Unspecified query classification type.", "Adversarial query classification type.", "Non-answer-seeking query classification type, for chit chat.", "Jail-breaking query classification type.", "Non-answer-seeking query classification type, for no clear intent.", "User defined query classification type." ], "enum": [ "TYPE_UNSPECIFIED", "ADVERSARIAL_QUERY", "NON_ANSWER_SEEKING_QUERY", "JAIL_BREAKING_QUERY", "NON_ANSWER_SEEKING_QUERY_V2", "USER_DEFINED_CLASSIFICATION_QUERY" ], "description": "Query classification type." } }, "id": "GoogleCloudDiscoveryengineV1AnswerQueryUnderstandingInfoQueryClassificationInfo" }, "GoogleCloudDiscoveryengineV1PurgeIdentityMappingsRequest": { "id": "GoogleCloudDiscoveryengineV1PurgeIdentityMappingsRequest", "properties": { "filter": { "type": "string", "description": "Filter matching identity mappings to purge. The eligible field for filtering is: * `update_time`: in ISO 8601 \"zulu\" format. * `external_id` Examples: * Deleting all identity mappings updated in a time range: `update_time \u003e \"2012-04-23T18:25:43.511Z\" AND update_time \u003c \"2012-04-23T18:30:43.511Z\"` * Deleting all identity mappings for a given external_id: `external_id = \"id1\"` * Deleting all identity mappings inside an identity mapping store: `*` The filtering fields are assumed to have an implicit AND. Should not be used with source. An error will be thrown, if both are provided." }, "inlineSource": { "description": "The inline source to purge identity mapping entries from.", "$ref": "GoogleCloudDiscoveryengineV1PurgeIdentityMappingsRequestInlineSource" }, "force": { "description": "Actually performs the purge. If `force` is set to false, return the expected purge count without deleting any identity mappings. This field is only supported for purge with filter. For input source this field is ignored and data will be purged regardless of the value of this field.", "type": "boolean" } }, "description": "Request message for IdentityMappingStoreService.PurgeIdentityMappings", "type": "object" }, "GoogleCloudDiscoveryengineV1betaControlPromoteAction": { "id": "GoogleCloudDiscoveryengineV1betaControlPromoteAction", "properties": { "dataStore": { "description": "Required. Data store with which this promotion is attached to.", "type": "string" }, "searchLinkPromotion": { "description": "Required. Promotion attached to this action.", "$ref": "GoogleCloudDiscoveryengineV1betaSearchLinkPromotion" } }, "description": "Promote certain links based on some trigger queries. Example: Promote shoe store link when searching for `shoe` keyword. The link can be outside of associated data store.", "type": "object" }, "GoogleCloudDiscoveryengineV1betaDeleteDataStoreMetadata": { "type": "object", "properties": { "createTime": { "description": "Operation create time.", "format": "google-datetime", "type": "string" }, "updateTime": { "type": "string", "description": "Operation last update time. If the operation is done, this is also the finish time.", "format": "google-datetime" } }, "id": "GoogleCloudDiscoveryengineV1betaDeleteDataStoreMetadata", "description": "Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field." }, "GoogleCloudDiscoveryengineV1DistributeLicenseConfigRequest": { "description": "Request message for LicenseConfigService.DistributeLicenseConfig method.", "id": "GoogleCloudDiscoveryengineV1DistributeLicenseConfigRequest", "properties": { "licenseCount": { "type": "string", "format": "int64", "description": "Required. The number of licenses to distribute." }, "projectNumber": { "description": "Required. The target GCP project number to distribute the license config to.", "format": "int64", "type": "string" }, "location": { "description": "Required. The target GCP project region to distribute the license config to.", "type": "string" }, "licenseConfigId": { "description": "Optional. Distribute seats to this license config instead of creating a new one. If not specified, a new license config will be created from the billing account license config.", "type": "string" } }, "type": "object" }, "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo": { "type": "object", "description": "Unstructured document information.", "id": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo", "properties": { "document": { "type": "string", "description": "Document resource name." }, "title": { "type": "string", "description": "Title." }, "structData": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." }, "description": "The structured JSON metadata for the document. It is populated from the struct data from the Chunk in search result." }, "chunkContents": { "description": "List of cited chunk contents derived from document content.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfoChunkContent" } }, "uri": { "type": "string", "description": "URI for the document." } } }, "A2aV1TaskArtifactUpdateEvent": { "properties": { "artifact": { "description": "The artifact itself", "$ref": "A2aV1Artifact" }, "append": { "type": "boolean", "description": "Whether this should be appended to a prior one produced" }, "contextId": { "description": "The id of the context that this task belongs too", "type": "string" }, "metadata": { "description": "Optional metadata associated with the artifact update.", "additionalProperties": { "type": "any", "description": "Properties of the object." }, "type": "object" }, "taskId": { "type": "string", "description": "The id of the task for this artifact" }, "lastChunk": { "type": "boolean", "description": "Whether this represents the last part of an artifact" } }, "type": "object", "description": "TaskArtifactUpdateEvent represents a task delta where an artifact has been generated.", "id": "A2aV1TaskArtifactUpdateEvent" }, "GoogleCloudDiscoveryengineV1ListCustomModelsResponse": { "id": "GoogleCloudDiscoveryengineV1ListCustomModelsResponse", "properties": { "models": { "type": "array", "description": "List of custom tuning models.", "items": { "$ref": "GoogleCloudDiscoveryengineV1CustomTuningModel" } } }, "description": "Response message for SearchTuningService.ListCustomModels method.", "type": "object" }, "GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfigAlloyDbConfigAlloyDbAiNaturalLanguageConfig": { "properties": { "nlConfigId": { "description": "Optional. AlloyDb AI NL config id, i.e. the value that was used for calling `SELECT alloydb_ai_nl.g_create_configuration(...)`. Can be empty.", "type": "string" } }, "description": "Configuration for AlloyDB AI Natural Language.", "type": "object", "id": "GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfigAlloyDbConfigAlloyDbAiNaturalLanguageConfig" }, "GoogleCloudDiscoveryengineV1alphaLanguageInfo": { "description": "Language info for DataStore.", "type": "object", "properties": { "region": { "type": "string", "readOnly": true, "description": "Output only. Region part of normalized_language_code, if present. E.g.: `en-US` -\u003e `US`, `zh-Hans-HK` -\u003e `HK`, `en` -\u003e ``." }, "normalizedLanguageCode": { "description": "Output only. This is the normalized form of language_code. E.g.: language_code of `en-GB`, `en_GB`, `en-UK` or `en-gb` will have normalized_language_code of `en-GB`.", "type": "string", "readOnly": true }, "languageCode": { "type": "string", "description": "The language code for the DataStore." }, "language": { "type": "string", "description": "Output only. Language part of normalized_language_code. E.g.: `en-US` -\u003e `en`, `zh-Hans-HK` -\u003e `zh`, `en` -\u003e `en`.", "readOnly": true } }, "id": "GoogleCloudDiscoveryengineV1alphaLanguageInfo" }, "GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata": { "id": "GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata", "description": "Additional information of a recommendation engine.", "properties": { "dataState": { "type": "string", "description": "Output only. The state of data requirements for this engine: `DATA_OK` and `DATA_ERROR`. Engine cannot be trained if the data is in `DATA_ERROR` state. Engine can have `DATA_ERROR` state even if serving state is `ACTIVE`: engines were trained successfully before, but cannot be refreshed because the underlying engine no longer has sufficient data for training.", "enum": [ "DATA_STATE_UNSPECIFIED", "DATA_OK", "DATA_ERROR" ], "enumDescriptions": [ "Unspecified default value, should never be explicitly set.", "The engine has sufficient training data.", "The engine does not have sufficient training data. Error messages can be queried via Stackdriver." ], "readOnly": true }, "lastTuneTime": { "type": "string", "format": "google-datetime", "description": "Output only. The timestamp when the latest successful tune finished. Only applicable on Media Recommendation engines.", "readOnly": true }, "lastTrainTime": { "format": "google-datetime", "description": "Output only. The timestamp when the latest successful training finished. Only applicable on Media Recommendation engines.", "type": "string", "readOnly": true }, "tuningOperation": { "readOnly": true, "type": "string", "description": "Output only. The latest tune operation id associated with the engine. Only applicable on Media Recommendation engines. If present, this operation id can be used to determine if there is an ongoing tune for this engine. To check the operation status, send the GetOperation request with this operation id in the engine resource format. If no tuning has happened for this engine, the string is empty." }, "servingState": { "type": "string", "readOnly": true, "enumDescriptions": [ "Unspecified serving state.", "The engine is not serving.", "The engine is serving and can be queried.", "The engine is trained on tuned hyperparameters and can be queried." ], "description": "Output only. The serving state of the engine: `ACTIVE`, `NOT_ACTIVE`.", "enum": [ "SERVING_STATE_UNSPECIFIED", "INACTIVE", "ACTIVE", "TUNED" ] } }, "type": "object" }, "GoogleCloudDiscoveryengineV1alphaImportUserEventsMetadata": { "id": "GoogleCloudDiscoveryengineV1alphaImportUserEventsMetadata", "type": "object", "properties": { "createTime": { "type": "string", "format": "google-datetime", "description": "Operation create time." }, "updateTime": { "format": "google-datetime", "type": "string", "readOnly": true, "description": "Output only. Operation last update time. If the operation is done, this is also the finish time." }, "failureCount": { "type": "string", "description": "Count of entries that encountered errors while processing.", "format": "int64" }, "successCount": { "type": "string", "description": "Count of entries that were processed successfully.", "format": "int64" } }, "description": "Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field." }, "GoogleCloudDiscoveryengineV1SearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterNumberConstraint": { "type": "object", "properties": { "querySegment": { "type": "string", "description": "Identifies the keywords within the search query that match a filter." }, "comparison": { "description": "The comparison operation performed between the field value and the value specified in the constraint.", "enum": [ "COMPARISON_UNSPECIFIED", "EQUALS", "LESS_THAN_EQUALS", "LESS_THAN", "GREATER_THAN_EQUALS", "GREATER_THAN" ], "enumDescriptions": [ "Undefined comparison operator.", "Denotes equality `=` operator.", "Denotes less than or equal to `\u003c=` operator.", "Denotes less than `\u003c` operator.", "Denotes greater than or equal to `\u003e=` operator.", "Denotes greater than `\u003e` operator." ], "type": "string" }, "fieldName": { "type": "string", "description": "Name of the numerical field as defined in the schema." }, "value": { "format": "double", "type": "number", "description": "The value specified in the numerical constraint." } }, "id": "GoogleCloudDiscoveryengineV1SearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterNumberConstraint", "description": "Constraint expression of a number field. Example: price \u003c 100." }, "GoogleCloudDiscoveryengineV1alphaCreateSchemaMetadata": { "description": "Metadata for Create Schema LRO.", "id": "GoogleCloudDiscoveryengineV1alphaCreateSchemaMetadata", "properties": { "updateTime": { "format": "google-datetime", "description": "Operation last update time. If the operation is done, this is also the finish time.", "type": "string" }, "createTime": { "description": "Operation create time.", "type": "string", "format": "google-datetime" } }, "type": "object" }, "GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpec": { "type": "object", "properties": { "querySetSpec": { "description": "Optional. The specification of the query set.", "$ref": "GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpecQuerySetSpec" }, "searchRequest": { "description": "Required. The search request that is used to perform the evaluation. Only the following fields within SearchRequest are supported; if any other fields are provided, an UNSUPPORTED error will be returned: * SearchRequest.serving_config * SearchRequest.branch * SearchRequest.canonical_filter * SearchRequest.query_expansion_spec * SearchRequest.spell_correction_spec * SearchRequest.content_search_spec * SearchRequest.user_pseudo_id", "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequest" } }, "description": "Describes the specification of the evaluation.", "id": "GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpec" }, "GoogleCloudDiscoveryengineV1alphaCitation": { "type": "object", "properties": { "license": { "description": "Output only. License of the attribution.", "type": "string", "readOnly": true }, "title": { "description": "Output only. Title of the attribution.", "readOnly": true, "type": "string" }, "startIndex": { "readOnly": true, "format": "int32", "type": "integer", "description": "Output only. Start index into the content." }, "uri": { "readOnly": true, "description": "Output only. Url reference of the attribution.", "type": "string" }, "endIndex": { "readOnly": true, "description": "Output only. End index into the content.", "format": "int32", "type": "integer" }, "publicationDate": { "description": "Output only. Publication date of the attribution.", "$ref": "GoogleTypeDate", "readOnly": true } }, "description": "Source attributions for content.", "id": "GoogleCloudDiscoveryengineV1alphaCitation" }, "GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries": { "description": "The historical crawl rate timeseries data, used for monitoring.", "properties": { "qpsTimeSeries": { "$ref": "GoogleMonitoringV3TimeSeries", "description": "The QPS of the crawl rate." } }, "type": "object", "id": "GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries" }, "GoogleCloudDiscoveryengineV1RankResponse": { "type": "object", "properties": { "records": { "type": "array", "description": "A list of records sorted by descending score.", "items": { "$ref": "GoogleCloudDiscoveryengineV1RankingRecord" } } }, "description": "Response message for RankService.Rank method.", "id": "GoogleCloudDiscoveryengineV1RankResponse" }, "GoogleCloudDiscoveryengineV1WidgetConfigCustomerProvidedConfig": { "description": "Customer provided configurations.", "properties": { "customerType": { "enumDescriptions": [ "Default customer type.", "Government customer type. Some features are disabled for government customers due to legal requirements." ], "enum": [ "DEFAULT_CUSTOMER", "GOVERNMENT_CUSTOMER" ], "description": "Customer type.", "type": "string" }, "complianceLevel": { "enumDescriptions": [ "The project has no Assured Workloads compliance level, or reports one that this API version does not model.", "FedRAMP High compliance level.", "Impact Level 4 (IL4) compliance level.", "Impact Level 5 (IL5) compliance level." ], "enum": [ "COMPLIANCE_LEVEL_UNSPECIFIED", "COMPLIANCE_LEVEL_FEDRAMP_HIGH", "COMPLIANCE_LEVEL_IL4", "COMPLIANCE_LEVEL_IL5" ], "readOnly": true, "description": "Output only. The customer's Assured Workloads compliance level. `customer_type` collapses every compliance level into a single `GOVERNMENT_CUSTOMER` value, so a client that gates a feature on one specific level rather than on government status as a whole must read this field instead.", "type": "string" } }, "id": "GoogleCloudDiscoveryengineV1WidgetConfigCustomerProvidedConfig", "type": "object" }, "GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateResponse": { "type": "object", "properties": { "error": { "description": "Errors from service when handling the request.", "$ref": "GoogleRpcStatus" }, "state": { "readOnly": true, "type": "string", "enumDescriptions": [ "The state is unspecified.", "The state is successful.", "The state is failed." ], "description": "Output only. The state of the response.", "enum": [ "STATE_UNSPECIFIED", "SUCCEEDED", "FAILED" ] } }, "description": "Response message for CrawlRateManagementService.RemoveDedicatedCrawlRate method. It simply returns the state of the response, and an error message if the state is FAILED.", "id": "GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateResponse" }, "GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsResponse": { "type": "object", "description": "Response message for CompletionService.PurgeCompletionSuggestions method. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.", "id": "GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsResponse", "properties": { "errorSamples": { "items": { "$ref": "GoogleRpcStatus" }, "description": "A sample of errors encountered while processing the request.", "type": "array" }, "purgeSucceeded": { "type": "boolean", "description": "Whether the completion suggestions were successfully purged." } } }, "GoogleCloudDiscoveryengineV1SearchResponseSummary": { "description": "Summary of the top N search results specified by the summary spec.", "type": "object", "id": "GoogleCloudDiscoveryengineV1SearchResponseSummary", "properties": { "safetyAttributes": { "description": "A collection of Safety Attribute categories and their associated confidence scores.", "$ref": "GoogleCloudDiscoveryengineV1SearchResponseSummarySafetyAttributes" }, "summaryWithMetadata": { "description": "Summary with metadata information.", "$ref": "GoogleCloudDiscoveryengineV1SearchResponseSummarySummaryWithMetadata" }, "summarySkippedReasons": { "description": "Additional summary-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.", "type": "array", "items": { "enumDescriptions": [ "Default value. The summary skipped reason is not specified.", "The adversarial query ignored case. Only used when SummarySpec.ignore_adversarial_query is set to `true`.", "The non-summary seeking query ignored case. Google skips the summary if the query is chit chat. Only used when SummarySpec.ignore_non_summary_seeking_query is set to `true`.", "The out-of-domain query ignored case. Google skips the summary if there are no high-relevance search results. For example, the data store contains facts about company A but the user query is asking questions about company B.", "The potential policy violation case. Google skips the summary if there is a potential policy violation detected. This includes content that may be violent or toxic.", "The LLM addon not enabled case. Google skips the summary if the LLM addon is not enabled.", "The no relevant content case. Google skips the summary if there is no relevant content in the retrieved search results.", "The jail-breaking query ignored case. For example, \"Reply in the tone of a competing company's CEO\". Only used when [SearchRequest.ContentSearchSpec.SummarySpec.ignore_jail_breaking_query] is set to `true`.", "The customer policy violation case. Google skips the summary if there is a customer policy violation detected. The policy is defined by the customer.", "The non-answer seeking query ignored case. Google skips the summary if the query doesn't have clear intent. Only used when [SearchRequest.ContentSearchSpec.SummarySpec.ignore_non_answer_seeking_query] is set to `true`.", "The time out case. Google skips the summary if the time out." ], "enum": [ "SUMMARY_SKIPPED_REASON_UNSPECIFIED", "ADVERSARIAL_QUERY_IGNORED", "NON_SUMMARY_SEEKING_QUERY_IGNORED", "OUT_OF_DOMAIN_QUERY_IGNORED", "POTENTIAL_POLICY_VIOLATION", "LLM_ADDON_NOT_ENABLED", "NO_RELEVANT_CONTENT", "JAIL_BREAKING_QUERY_IGNORED", "CUSTOMER_POLICY_VIOLATION", "NON_SUMMARY_SEEKING_QUERY_IGNORED_V2", "TIME_OUT" ], "type": "string" } }, "summaryText": { "description": "The summary content.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1PurgeDocumentsMetadata": { "description": "Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.", "properties": { "createTime": { "type": "string", "format": "google-datetime", "description": "Operation create time." }, "updateTime": { "format": "google-datetime", "description": "Operation last update time. If the operation is done, this is also the finish time.", "type": "string" }, "successCount": { "format": "int64", "description": "Count of entries that were deleted successfully.", "type": "string" }, "failureCount": { "format": "int64", "description": "Count of entries that encountered errors while processing.", "type": "string" }, "ignoredCount": { "description": "Count of entries that were ignored as entries were not found.", "type": "string", "format": "int64" } }, "type": "object", "id": "GoogleCloudDiscoveryengineV1PurgeDocumentsMetadata" }, "GoogleCloudDiscoveryengineV1alphaAlertPolicyResourceConfig": { "properties": { "alertPolicy": { "description": "Immutable. The fully qualified resource name of the AlertPolicy.", "type": "string" }, "regionCode": { "description": "Optional. The region code used of the user that subscribed to the alert policy.", "type": "string" }, "contactDetails": { "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaContactDetails" }, "type": "array", "description": "Optional. The contact details for each alert policy." }, "languageCode": { "description": "Optional. The language code used for notifications", "type": "string" }, "alertEnrollments": { "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaAlertPolicyResourceConfigAlertEnrollment" }, "description": "Optional. The enrollment state of each alert." } }, "description": "The resource level alert config. Used in: * UserLicense * EngineUserData The AlertPolicyConfig in data connector is of same usage. No easy way to migrate.", "type": "object", "id": "GoogleCloudDiscoveryengineV1alphaAlertPolicyResourceConfig" }, "GoogleCloudDiscoveryengineV1ControlRedirectAction": { "type": "object", "properties": { "redirectUri": { "description": "Required. The URI to which the shopper will be redirected. Required. URI must have length equal or less than 2000 characters. Otherwise an INVALID ARGUMENT error is thrown.", "type": "string" } }, "id": "GoogleCloudDiscoveryengineV1ControlRedirectAction", "description": "Redirects a shopper to the provided URI." }, "GoogleCloudDiscoveryengineV1BatchCreateTargetSiteMetadata": { "properties": { "createTime": { "type": "string", "description": "Operation create time.", "format": "google-datetime" }, "updateTime": { "type": "string", "description": "Operation last update time. If the operation is done, this is also the finish time.", "format": "google-datetime" } }, "type": "object", "description": "Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1BatchCreateTargetSiteMetadata" }, "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponseContentSuggestion": { "id": "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponseContentSuggestion", "description": "Suggestions as content.", "type": "object", "properties": { "destinationUri": { "type": "string", "description": "The destination uri of the content suggestion." }, "score": { "description": "The score of each suggestion. The score is in the range of [0, 1].", "format": "double", "type": "number" }, "iconUri": { "description": "The icon uri of the content suggestion.", "type": "string" }, "suggestion": { "description": "The suggestion for the query.", "type": "string" }, "document": { "$ref": "GoogleCloudDiscoveryengineV1Document", "description": "The document data snippet in the suggestion. Only a subset of fields will be populated." }, "contentType": { "type": "string", "enum": [ "CONTENT_TYPE_UNSPECIFIED", "GOOGLE_WORKSPACE", "THIRD_PARTY" ], "enumDescriptions": [ "Default value.", "The suggestion is from a Google Workspace source.", "The suggestion is from a third party source." ], "description": "The type of the content suggestion." }, "dataStore": { "type": "string", "description": "The name of the dataStore that this suggestion belongs to." } } }, "GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResultSnippetInfo": { "id": "GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResultSnippetInfo", "description": "Snippet information.", "properties": { "snippet": { "description": "Snippet content.", "type": "string" }, "snippetStatus": { "type": "string", "description": "Status of the snippet defined by the search team." } }, "type": "object" }, "GoogleCloudDiscoveryengineV1SearchResponseSearchResultRetrievalSignals": { "type": "object", "properties": { "semanticRelevanceScore": { "type": "number", "format": "float", "description": "Optional. Relevance score used by the filter when semantic_relevance_threshold is set." }, "retrievalSources": { "items": { "enum": [ "RETRIEVAL_SOURCE_UNSPECIFIED", "KEYWORD_SEARCH", "SEMANTIC_SEARCH" ], "type": "string", "enumDescriptions": [ "Unspecified retrieval source.", "Indicates the result was retrieved by keyword search.", "Indicates the result was retrieved by semantic search." ] }, "type": "array", "description": "Optional. Indicates how the result was retrieved." } }, "description": "Contains a set of signals used by the relevance filter.", "id": "GoogleCloudDiscoveryengineV1SearchResponseSearchResultRetrievalSignals" }, "GoogleCloudDiscoveryengineLoggingErrorContext": { "properties": { "httpRequest": { "$ref": "GoogleCloudDiscoveryengineLoggingHttpRequestContext", "description": "The HTTP request which was processed when the error was triggered." }, "reportLocation": { "description": "The location in the source code where the decision was made to report the error, usually the place where it was logged.", "$ref": "GoogleCloudDiscoveryengineLoggingSourceLocation" } }, "id": "GoogleCloudDiscoveryengineLoggingErrorContext", "description": "A description of the context in which an error occurred.", "type": "object" }, "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecChunkSpec": { "properties": { "numPreviousChunks": { "type": "integer", "description": "The number of previous chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no previous chunks will be returned.", "format": "int32" }, "numNextChunks": { "format": "int32", "type": "integer", "description": "The number of next chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no next chunks will be returned." } }, "type": "object", "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecChunkSpec", "description": "Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS" }, "GoogleCloudDiscoveryengineV1DocumentIndexStatus": { "id": "GoogleCloudDiscoveryengineV1DocumentIndexStatus", "description": "Index status of the document.", "type": "object", "properties": { "indexTime": { "format": "google-datetime", "type": "string", "description": "The time when the document was indexed. If this field is populated, it means the document has been indexed. While documents typically become searchable within seconds of indexing, it can sometimes take up to a few hours." }, "pendingMessage": { "description": "Immutable. The message indicates the document index is in progress. If this field is populated, the document index is pending.", "type": "string" }, "errorSamples": { "items": { "$ref": "GoogleRpcStatus" }, "type": "array", "description": "A sample of errors encountered while indexing the document. If this field is populated, the document is not indexed due to errors." } } }, "GoogleCloudDiscoveryengineV1betaSitemap": { "description": "A sitemap for the SiteSearchEngine.", "type": "object", "id": "GoogleCloudDiscoveryengineV1betaSitemap", "properties": { "createTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The sitemap's creation time.", "type": "string" }, "name": { "description": "Output only. The fully qualified resource name of the sitemap. `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine/sitemaps/*` The `sitemap_id` suffix is system-generated.", "readOnly": true, "type": "string" }, "uri": { "description": "Public URI for the sitemap, e.g. `www.example.com/sitemap.xml`.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1SearchRequestRelevanceFilterSpecRelevanceThresholdSpec": { "id": "GoogleCloudDiscoveryengineV1SearchRequestRelevanceFilterSpecRelevanceThresholdSpec", "type": "object", "properties": { "semanticRelevanceThreshold": { "type": "number", "format": "float", "description": "Custom relevance threshold for the sub-search. The value must be in [0.0, 1.0]." }, "relevanceThreshold": { "type": "string", "enum": [ "RELEVANCE_THRESHOLD_UNSPECIFIED", "LOWEST", "LOW", "MEDIUM", "HIGH" ], "description": "Pre-defined relevance threshold for the sub-search.", "enumDescriptions": [ "Default value. In this case, server behavior defaults to Google defined threshold.", "Lowest relevance threshold.", "Low relevance threshold.", "Medium relevance threshold.", "High relevance threshold." ] } }, "description": "Specification for relevance filtering on a specific sub-search." }, "GoogleCloudDiscoveryengineV1AssistantGroundedContentTextGroundingMetadata": { "description": "Grounding details for text sources.", "type": "object", "properties": { "visualSegments": { "type": "array", "description": "Grounding information for parts of the visual content.", "items": { "$ref": "GoogleCloudDiscoveryengineV1AssistantGroundedContentTextGroundingMetadataVisualSegment" } }, "references": { "description": "References for the grounded text.", "items": { "$ref": "GoogleCloudDiscoveryengineV1AssistantGroundedContentTextGroundingMetadataReference" }, "type": "array" }, "segments": { "items": { "$ref": "GoogleCloudDiscoveryengineV1AssistantGroundedContentTextGroundingMetadataSegment" }, "type": "array", "description": "Grounding information for parts of the text." } }, "id": "GoogleCloudDiscoveryengineV1AssistantGroundedContentTextGroundingMetadata" }, "GoogleCloudDiscoveryengineLoggingConnectorRunErrorContext": { "id": "GoogleCloudDiscoveryengineLoggingConnectorRunErrorContext", "properties": { "dataConnector": { "description": "The full resource name of the DataConnector. Format: `projects/*/locations/*/collections/*/dataConnector`.", "type": "string" }, "entity": { "description": "The entity to sync for the connector run.", "type": "string" }, "endTime": { "description": "The time when the connector run ended.", "type": "string", "format": "google-datetime" }, "connectorRun": { "type": "string", "description": "The full resource name of the Connector Run. Format: `projects/*/locations/*/collections/*/dataConnector/connectorRuns/*`. The `connector_run_id` is system-generated." }, "operation": { "description": "The operation resource name of the LRO to sync the connector.", "type": "string" }, "startTime": { "type": "string", "format": "google-datetime", "description": "The time when the connector run started." }, "syncType": { "description": "The type of sync run. Can be one of the following: * `FULL` * `INCREMENTAL`", "type": "string" } }, "type": "object", "description": "The error payload that is populated on LRO sync APIs, including the following: * `google.cloud.discoveryengine.v1main.DataConnectorService.SetUpDataConnector` * `google.cloud.discoveryengine.v1main.DataConnectorService.StartConnectorRun`" }, "GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpecModelSpec": { "id": "GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpecModelSpec", "properties": { "modelType": { "description": "Optional. Enabled query rephraser model type. If not set, it will use LARGE by default.", "type": "string", "enum": [ "MODEL_TYPE_UNSPECIFIED", "SMALL", "LARGE" ], "enumDescriptions": [ "Unspecified model type.", "Small query rephraser model. Gemini 1.0 XS model.", "Large query rephraser model. Gemini 1.0 Pro model." ] } }, "description": "Query Rephraser Model specification.", "type": "object" }, "GoogleCloudDiscoveryengineV1DataStoreFederatedSearchConfigThirdPartyOauthConfig": { "id": "GoogleCloudDiscoveryengineV1DataStoreFederatedSearchConfigThirdPartyOauthConfig", "type": "object", "properties": { "instanceName": { "type": "string", "description": "Optional. The instance name identifying the 3P app, e.g., \"vaissptbots-my\". This is different from the instance_uri which is the full URL of the 3P app e.g., \"https://vaissptbots-my.sharepoint.com\"." }, "appName": { "description": "Optional. The type of the application. E.g., \"jira\", \"box\", etc.", "type": "string" } }, "description": "Stores information for third party applicationOAuth." }, "GoogleCloudDiscoveryengineV1AnswerQueryRequestSafetySpecSafetySetting": { "description": "Safety settings.", "id": "GoogleCloudDiscoveryengineV1AnswerQueryRequestSafetySpecSafetySetting", "type": "object", "properties": { "threshold": { "description": "Required. The harm block threshold.", "enumDescriptions": [ "Unspecified harm block threshold.", "Block low threshold and above (i.e. block more).", "Block medium threshold and above.", "Block only high threshold (i.e. block less).", "Block none.", "Turn off the safety filter." ], "type": "string", "enum": [ "HARM_BLOCK_THRESHOLD_UNSPECIFIED", "BLOCK_LOW_AND_ABOVE", "BLOCK_MEDIUM_AND_ABOVE", "BLOCK_ONLY_HIGH", "BLOCK_NONE", "OFF" ] }, "category": { "enumDescriptions": [ "The harm category is unspecified.", "The harm category is hate speech.", "The harm category is dangerous content.", "The harm category is harassment.", "The harm category is sexually explicit content.", "The harm category is civic integrity." ], "description": "Required. Harm category.", "enum": [ "HARM_CATEGORY_UNSPECIFIED", "HARM_CATEGORY_HATE_SPEECH", "HARM_CATEGORY_DANGEROUS_CONTENT", "HARM_CATEGORY_HARASSMENT", "HARM_CATEGORY_SEXUALLY_EXPLICIT", "HARM_CATEGORY_CIVIC_INTEGRITY" ], "type": "string" } } }, "GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig": { "id": "GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig", "description": "Additional feature configurations for creating a `recommended-for-you` engine.", "type": "object", "properties": { "contextEventType": { "type": "string", "description": "The type of event with which the engine is queried at prediction time. If set to `generic`, only `view-item`, `media-play`,and `media-complete` will be used as `context-event` in engine training. If set to `view-home-page`, `view-home-page` will also be used as `context-events` in addition to `view-item`, `media-play`, and `media-complete`. Currently supported for the `recommended-for-you` engine. Currently supported values: `view-home-page`, `generic`." } } }, "GoogleCloudDiscoveryengineV1SearchResponseSummaryCitationSource": { "description": "Citation source.", "id": "GoogleCloudDiscoveryengineV1SearchResponseSummaryCitationSource", "type": "object", "properties": { "referenceIndex": { "description": "Document reference index from SummaryWithMetadata.references. It is 0-indexed and the value will be zero if the reference_index is not set explicitly.", "type": "string", "format": "int64" } } }, "GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec": { "properties": { "embeddingVectors": { "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpecEmbeddingVector" }, "description": "The embedding vector used for retrieval. Limit to 1." } }, "type": "object", "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec", "description": "The specification that uses customized query embedding vector to do semantic document retrieval." }, "GoogleCloudDiscoveryengineV1FirestoreSource": { "type": "object", "properties": { "projectId": { "description": "The project ID that the Cloud SQL source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.", "type": "string" }, "collectionId": { "type": "string", "description": "Required. The Firestore collection (or entity) to copy the data from with a length limit of 1,500 characters." }, "databaseId": { "description": "Required. The Firestore 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 Firestore export to a specific Cloud Storage directory. Ensure that the Firestore service account has the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory.", "type": "string" } }, "id": "GoogleCloudDiscoveryengineV1FirestoreSource", "description": "Firestore source import data from." }, "GoogleCloudDiscoveryengineV1betaTrainCustomModelMetadata": { "description": "Metadata related to the progress of the TrainCustomModel operation. This is returned by the google.longrunning.Operation.metadata field.", "properties": { "updateTime": { "format": "google-datetime", "type": "string", "description": "Operation last update time. If the operation is done, this is also the finish time." }, "createTime": { "format": "google-datetime", "description": "Operation create time.", "type": "string" } }, "type": "object", "id": "GoogleCloudDiscoveryengineV1betaTrainCustomModelMetadata" }, "GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchResponse": { "id": "GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchResponse", "type": "object", "properties": {}, "description": "Response message for SiteSearchEngineService.EnableAdvancedSiteSearch method." }, "GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfigDataProtectionPolicySensitiveDataProtectionPolicy": { "type": "object", "properties": { "policy": { "type": "string", "description": "Optional. The Sensitive Data Protection policy resource name." } }, "description": "Specifies a Sensitive Data Protection (https://cloud.google.com/sensitive-data-protection/docs/sensitive-data-protection-overview) policy.", "id": "GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfigDataProtectionPolicySensitiveDataProtectionPolicy" }, "GoogleCloudDiscoveryengineV1alphaQuery": { "properties": { "createTime": { "description": "Output only. The time at which the server accepted this query.", "type": "string", "readOnly": true, "format": "google-datetime" }, "text": { "type": "string", "description": "Plain text." }, "queryId": { "description": "Output only. Unique Id for the query.", "type": "string", "readOnly": true }, "parts": { "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaQueryPart" }, "type": "array", "description": "Query content parts." } }, "description": "Defines a user inputed query.", "id": "GoogleCloudDiscoveryengineV1alphaQuery", "type": "object" }, "GoogleCloudDiscoveryengineV1SearchResponseSummarySafetyAttributes": { "description": "Safety Attribute categories and their associated confidence scores.", "properties": { "scores": { "type": "array", "items": { "format": "float", "type": "number" }, "description": "The confidence scores of the each category, higher value means higher confidence. Order matches the Categories." }, "categories": { "items": { "type": "string" }, "type": "array", "description": "The display names of Safety Attribute categories associated with the generated content. Order matches the Scores." } }, "type": "object", "id": "GoogleCloudDiscoveryengineV1SearchResponseSummarySafetyAttributes" }, "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesResponse": { "description": "Response message for CompletionService.ImportSuggestionDenyListEntries method.", "properties": { "failedEntriesCount": { "type": "string", "description": "Count of deny list entries that failed to be imported.", "format": "int64" }, "errorSamples": { "items": { "$ref": "GoogleRpcStatus" }, "type": "array", "description": "A sample of errors encountered while processing the request." }, "importedEntriesCount": { "description": "Count of deny list entries successfully imported.", "type": "string", "format": "int64" } }, "id": "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesResponse", "type": "object" }, "GoogleCloudDiscoveryengineV1RecrawlUrisRequest": { "description": "Request message for SiteSearchEngineService.RecrawlUris method.", "type": "object", "properties": { "siteCredential": { "type": "string", "description": "Optional. Credential id to use for crawling." }, "uris": { "items": { "type": "string" }, "type": "array", "description": "Required. List of URIs to crawl. At most 10K URIs are supported, otherwise an INVALID_ARGUMENT error is thrown. Each URI should match at least one TargetSite in `site_search_engine`." } }, "id": "GoogleCloudDiscoveryengineV1RecrawlUrisRequest" }, "GoogleCloudDiscoveryengineV1SearchRequestBoostSpecConditionBoostSpecBoostControlSpec": { "description": "Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above.", "properties": { "controlPoints": { "type": "array", "description": "The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here.", "items": { "$ref": "GoogleCloudDiscoveryengineV1SearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint" } }, "interpolationType": { "enum": [ "INTERPOLATION_TYPE_UNSPECIFIED", "LINEAR" ], "description": "The interpolation type to be applied to connect the control points listed below.", "type": "string", "enumDescriptions": [ "Interpolation type is unspecified. In this case, it defaults to Linear.", "Piecewise linear interpolation will be applied." ] }, "fieldName": { "type": "string", "description": "The name of the field whose value will be used to determine the boost amount." }, "attributeType": { "enumDescriptions": [ "Unspecified AttributeType.", "The value of the numerical field will be used to dynamically update the boost amount. In this case, the attribute_value (the x value) of the control point will be the actual value of the numerical field for which the boost_amount is specified.", "For the freshness use case the attribute value will be the duration between the current time and the date in the datetime field specified. The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`. For example, `5D`, `3DT12H30M`, `T24H`." ], "type": "string", "enum": [ "ATTRIBUTE_TYPE_UNSPECIFIED", "NUMERICAL", "FRESHNESS" ], "description": "The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value)." } }, "id": "GoogleCloudDiscoveryengineV1SearchRequestBoostSpecConditionBoostSpecBoostControlSpec", "type": "object" }, "GoogleCloudDiscoveryengineV1ListIdentityMappingStoresResponse": { "type": "object", "properties": { "identityMappingStores": { "items": { "$ref": "GoogleCloudDiscoveryengineV1IdentityMappingStore" }, "description": "The Identity Mapping Stores.", "type": "array" }, "nextPageToken": { "description": "A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" } }, "description": "Response message for IdentityMappingStoreService.ListIdentityMappingStores", "id": "GoogleCloudDiscoveryengineV1ListIdentityMappingStoresResponse" }, "GoogleCloudDiscoveryengineV1alphaAnswerGroundingSupport": { "description": "Grounding support for a claim in `answer_text`.", "properties": { "groundingScore": { "format": "double", "type": "number", "description": "A score in the range of [0, 1] describing how grounded is a specific claim by the references. Higher value means that the claim is better supported by the reference chunks." }, "endIndex": { "description": "Required. End of the claim, exclusive.", "format": "int64", "type": "string" }, "sources": { "description": "Optional. Citation sources for the claim.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerCitationSource" } }, "groundingCheckRequired": { "type": "boolean", "description": "Indicates that this claim required grounding check. When the system decided this claim didn't require attribution/grounding check, this field is set to false. In that case, no grounding check was done for the claim and therefore `grounding_score`, `sources` is not returned." }, "startIndex": { "description": "Required. Index indicates the start of the claim, measured in bytes (UTF-8 unicode).", "type": "string", "format": "int64" } }, "id": "GoogleCloudDiscoveryengineV1alphaAnswerGroundingSupport", "type": "object" }, "GoogleCloudDiscoveryengineV1Project": { "description": "Metadata and configurations for a Google Cloud project in the service.", "id": "GoogleCloudDiscoveryengineV1Project", "type": "object", "properties": { "provisionCompletionTime": { "description": "Output only. The timestamp when this project is successfully provisioned. Empty value means this project is still provisioning and is not ready for use.", "format": "google-datetime", "readOnly": true, "type": "string" }, "name": { "description": "Output only. Full resource name of the project, for example `projects/{project}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number.", "type": "string", "readOnly": true }, "serviceTermsMap": { "additionalProperties": { "$ref": "GoogleCloudDiscoveryengineV1ProjectServiceTerms" }, "readOnly": true, "description": "Output only. A map of terms of services. The key is the `id` of ServiceTerms.", "type": "object" }, "configurableBillingStatus": { "$ref": "GoogleCloudDiscoveryengineV1ProjectConfigurableBillingStatus", "readOnly": true, "description": "Output only. The current status of the project's configurable billing." }, "customerProvidedConfig": { "description": "Optional. Customer provided configurations.", "$ref": "GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfig" }, "createTime": { "description": "Output only. The timestamp when this project is created.", "format": "google-datetime", "type": "string", "readOnly": true } } }, "GoogleCloudDiscoveryengineV1alphaAgentGatewaySettingAgentGatewayReference": { "description": "Reference to an Agent Gateway resource.", "type": "object", "properties": { "name": { "description": "Required. Immutable. The resource name of the agent gateway. Expected format: `projects/{project_number}/locations/{location}/agentGateways/{agent_gateway}`.", "type": "string" } }, "id": "GoogleCloudDiscoveryengineV1alphaAgentGatewaySettingAgentGatewayReference" }, "GoogleCloudDiscoveryengineV1CheckGroundingResponse": { "properties": { "citedChunks": { "items": { "$ref": "GoogleCloudDiscoveryengineV1FactChunk" }, "description": "List of facts cited across all claims in the answer candidate. These are derived from the facts supplied in the request.", "type": "array" }, "claims": { "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1CheckGroundingResponseClaim" }, "description": "Claim texts and citation info across all claims in the answer candidate." }, "supportScore": { "format": "float", "description": "The support score for the input answer candidate. Higher the score, higher is the fraction of claims that are supported by the provided facts. This is always set when a response is returned.", "type": "number" }, "citedFacts": { "description": "List of facts cited across all claims in the answer candidate. These are derived from the facts supplied in the request.", "items": { "$ref": "GoogleCloudDiscoveryengineV1CheckGroundingResponseCheckGroundingFactChunk" }, "type": "array" } }, "description": "Response message for the GroundedGenerationService.CheckGrounding method.", "id": "GoogleCloudDiscoveryengineV1CheckGroundingResponse", "type": "object" }, "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecExtractiveContentSpec": { "properties": { "maxExtractiveAnswerCount": { "format": "int32", "description": "The maximum number of extractive answers returned in each search result. An extractive answer is a verbatim answer extracted from the original document, which provides a precise and contextually relevant answer to the search query. If the number of matching answers is less than the `max_extractive_answer_count`, return all of the answers. Otherwise, return the `max_extractive_answer_count`. At most five answers are returned for each SearchResult.", "type": "integer" }, "maxExtractiveSegmentCount": { "format": "int32", "description": "The max number of extractive segments returned in each search result. Only applied if the DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED or DataStore.solution_types is SOLUTION_TYPE_CHAT. An extractive segment is a text segment extracted from the original document that is relevant to the search query, and, in general, more verbose than an extractive answer. The segment could then be used as input for LLMs to generate summaries and answers. If the number of matching segments is less than `max_extractive_segment_count`, return all of the segments. Otherwise, return the `max_extractive_segment_count`.", "type": "integer" }, "numPreviousSegments": { "description": "Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments.", "format": "int32", "type": "integer" }, "numNextSegments": { "type": "integer", "description": "Return at most `num_next_segments` segments after each selected segments.", "format": "int32" }, "returnExtractiveSegmentScore": { "description": "Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`.", "type": "boolean" } }, "description": "A specification for configuring the extractive content in a search response.", "type": "object", "id": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecExtractiveContentSpec" }, "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig": { "properties": { "layoutBasedChunkingConfig": { "description": "Configuration for the layout based chunking.", "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig" } }, "description": "Configuration for chunking config.", "type": "object", "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig" }, "GoogleCloudDiscoveryengineV1betaSearchRequestImageQuery": { "id": "GoogleCloudDiscoveryengineV1betaSearchRequestImageQuery", "properties": { "imageBytes": { "description": "Base64 encoded image bytes. Supported image formats: JPEG, PNG, and BMP.", "type": "string" } }, "type": "object", "description": "Specifies the image query input." }, "GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig": { "properties": { "business": { "description": "Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search.", "type": "string" }, "timeZone": { "description": "Required. The time zone of the agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris.", "type": "string" }, "defaultLanguageCode": { "type": "string", "description": "Required. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes." }, "location": { "description": "Agent location for Agent creation, supported values: global/us/eu. If not provided, us Engine will create Agent using us-central-1 by default; eu Engine will create Agent using eu-west-1 by default.", "type": "string" } }, "type": "object", "description": "Configurations for generating a Dialogflow agent. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation.", "id": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig" }, "GoogleCloudDiscoveryengineV1TransactionInfo": { "type": "object", "description": "A transaction represents the entire purchase transaction.", "properties": { "cost": { "format": "float", "type": "number", "description": "All the costs associated with the products. These can be manufacturing costs, shipping expenses not borne by the end user, or any other costs, such that: * Profit = value - tax - cost" }, "currency": { "description": "Required. Currency code. Use three-character ISO-4217 code.", "type": "string" }, "value": { "type": "number", "format": "float", "description": "Required. Total non-zero value associated with the transaction. This value may include shipping, tax, or other adjustments to the total value that you want to include." }, "discountValue": { "description": "The total discount(s) value applied to this transaction. This figure should be excluded from TransactionInfo.value For example, if a user paid TransactionInfo.value amount, then nominal (pre-discount) value of the transaction is the sum of TransactionInfo.value and TransactionInfo.discount_value This means that profit is calculated the same way, regardless of the discount value, and that TransactionInfo.discount_value can be larger than TransactionInfo.value: * Profit = value - tax - cost", "format": "float", "type": "number" }, "tax": { "description": "All the taxes associated with the transaction.", "type": "number", "format": "float" }, "transactionId": { "type": "string", "description": "The transaction ID with a length limit of 128 characters." } }, "id": "GoogleCloudDiscoveryengineV1TransactionInfo" }, "GoogleCloudDiscoveryengineV1CompletionSuggestion": { "properties": { "alternativePhrases": { "description": "Alternative matching phrases for this suggestion.", "type": "array", "items": { "type": "string" } }, "languageCode": { "type": "string", "description": "BCP-47 language code of this suggestion." }, "groupId": { "description": "If two suggestions have the same groupId, they will not be returned together. Instead the one ranked higher will be returned. This can be used to deduplicate semantically identical suggestions.", "type": "string" }, "groupScore": { "type": "number", "description": "The score of this suggestion within its group.", "format": "double" }, "frequency": { "type": "string", "description": "Frequency of this suggestion. Will be used to rank suggestions when score is not available.", "format": "int64" }, "globalScore": { "format": "double", "type": "number", "description": "Global score of this suggestion. Control how this suggestion would be scored / ranked." }, "suggestion": { "description": "Required. The suggestion text.", "type": "string" } }, "description": "Autocomplete suggestions that are imported from Customer.", "id": "GoogleCloudDiscoveryengineV1CompletionSuggestion", "type": "object" }, "GoogleCloudDiscoveryengineV1alphaUpdateSchemaMetadata": { "type": "object", "id": "GoogleCloudDiscoveryengineV1alphaUpdateSchemaMetadata", "properties": { "createTime": { "description": "Operation create time.", "format": "google-datetime", "type": "string" }, "updateTime": { "description": "Operation last update time. If the operation is done, this is also the finish time.", "format": "google-datetime", "type": "string" } }, "description": "Metadata for UpdateSchema LRO." }, "GoogleIamV1Policy": { "type": "object", "description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time \u003c timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time \u003c timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).", "properties": { "bindings": { "items": { "$ref": "GoogleIamV1Binding" }, "description": "Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.", "type": "array" }, "etag": { "description": "`etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.", "format": "byte", "type": "string" }, "version": { "description": "Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "type": "integer", "format": "int32" } }, "id": "GoogleIamV1Policy" }, "GoogleCloudDiscoveryengineV1SessionConfigSessionTtl": { "id": "GoogleCloudDiscoveryengineV1SessionConfigSessionTtl", "properties": { "days": { "type": "integer", "description": "Defines the number of days for session TTL.", "format": "int32" } }, "type": "object", "description": "Defines the TTL for sessions." }, "GoogleCloudDiscoveryengineV1alphaIdpConfigExternalIdpConfig": { "description": "Third party IDP Config.", "properties": { "workforcePoolName": { "description": "Workforce pool name. Example: \"locations/global/workforcePools/pool_id\"", "type": "string" } }, "id": "GoogleCloudDiscoveryengineV1alphaIdpConfigExternalIdpConfig", "type": "object" }, "GoogleCloudDiscoveryengineV1RetractLicenseConfigRequest": { "id": "GoogleCloudDiscoveryengineV1RetractLicenseConfigRequest", "properties": { "licenseCount": { "type": "string", "description": "Optional. The number of licenses to retract. Only used when full_retract is false.", "format": "int64" }, "fullRetract": { "type": "boolean", "description": "Optional. If set to true, retract the entire license config. Otherwise, retract the specified license count." }, "licenseConfig": { "type": "string", "description": "Required. Full resource name of LicenseConfig. Format: `projects/{project}/locations/{location}/licenseConfigs/{license_config_id}`." } }, "description": "Request message for LicenseConfigService.RetractLicenseConfig method.", "type": "object" }, "GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSiteMetadata": { "properties": { "updateTime": { "type": "string", "format": "google-datetime", "description": "Operation last update time. If the operation is done, this is also the finish time." }, "createTime": { "format": "google-datetime", "description": "Operation create time.", "type": "string" } }, "id": "GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSiteMetadata", "type": "object", "description": "Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field." }, "GoogleCloudDiscoveryengineV1alphaExportMetricsResponse": { "description": "Response of the ExportMetricsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field.", "id": "GoogleCloudDiscoveryengineV1alphaExportMetricsResponse", "type": "object", "properties": {} }, "GoogleApiMonitoredResource": { "id": "GoogleApiMonitoredResource", "properties": { "type": { "type": "string", "description": "Required. The monitored resource type. This field must match the `type` field of a MonitoredResourceDescriptor object. For example, the type of a Compute Engine VM instance is `gce_instance`. Some descriptors include the service name in the type; for example, the type of a Datastream stream is `datastream.googleapis.com/Stream`." }, "labels": { "additionalProperties": { "type": "string" }, "description": "Required. Values for all of the labels listed in the associated monitored resource descriptor. For example, Compute Engine VM instances use the labels `\"project_id\"`, `\"instance_id\"`, and `\"zone\"`.", "type": "object" } }, "type": "object", "description": "An object representing a resource that can be used for monitoring, logging, billing, or other purposes. Examples include virtual machine instances, databases, and storage devices such as disks. The `type` field identifies a MonitoredResourceDescriptor object that describes the resource's schema. Information in the `labels` field identifies the actual resource and its attributes according to the schema. For example, a particular Compute Engine VM instance could be represented by the following object, because the MonitoredResourceDescriptor for `\"gce_instance\"` has labels `\"project_id\"`, `\"instance_id\"` and `\"zone\"`: { \"type\": \"gce_instance\", \"labels\": { \"project_id\": \"my-project\", \"instance_id\": \"12345678901234\", \"zone\": \"us-central1-a\" }}" }, "GoogleCloudDiscoveryengineV1betaHealthcareFhirConfig": { "id": "GoogleCloudDiscoveryengineV1betaHealthcareFhirConfig", "type": "object", "description": "Config to data store for `HEALTHCARE_FHIR` vertical.", "properties": { "initialFilterGroups": { "description": "Optional. Names of the Group resources to use as a basis for the initial patient filter, in format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Group/{group_id}`. The filter group must be a FHIR resource name of type Group, and the filter will be constructed from the direct members of the group which are Patient resources.", "type": "array", "items": { "type": "string" } }, "enableConfigurableSchema": { "type": "boolean", "description": "Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering." }, "enableStaticIndexingForBatchIngestion": { "description": "Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume.", "type": "boolean" } } }, "GoogleCloudDiscoveryengineV1ChunkAnnotationMetadata": { "properties": { "imageId": { "description": "Output only. Image id is provided if the structured content is based on an image.", "readOnly": true, "type": "string" }, "structuredContent": { "description": "Output only. The structured content information.", "$ref": "GoogleCloudDiscoveryengineV1ChunkStructuredContent", "readOnly": true } }, "id": "GoogleCloudDiscoveryengineV1ChunkAnnotationMetadata", "type": "object", "description": "The annotation metadata includes structured content in the current chunk." }, "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpec": { "properties": { "condition": { "type": "string", "description": "An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost documents with document ID \"doc_1\" or \"doc_2\", and color \"Red\" or \"Blue\": `(document_id: ANY(\"doc_1\", \"doc_2\")) AND (color: ANY(\"Red\", \"Blue\"))`" }, "boostControlSpec": { "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec", "description": "Complex specification for custom ranking based on customer defined attribute value." }, "boost": { "description": "Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored. Only one of the (condition, boost) combination or the boost_control_spec below are set. If both are set then the global boost is ignored and the more fine-grained boost_control_spec is applied.", "type": "number", "format": "float" } }, "description": "Boost applies to documents which match a condition.", "type": "object", "id": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpec" }, "GoogleCloudDiscoveryengineV1alphaImportIdentityMappingsResponse": { "properties": { "errorSamples": { "items": { "$ref": "GoogleRpcStatus" }, "type": "array", "description": "A sample of errors encountered while processing the request." } }, "type": "object", "description": "Response message for IdentityMappingStoreService.ImportIdentityMappings", "id": "GoogleCloudDiscoveryengineV1alphaImportIdentityMappingsResponse" }, "GoogleCloudDiscoveryengineV1betaSearchRequestSearchAddonSpec": { "id": "GoogleCloudDiscoveryengineV1betaSearchRequestSearchAddonSpec", "type": "object", "description": "SearchAddonSpec is used to disable add-ons for search as per new repricing model. By default if the SearchAddonSpec is not specified, we consider that the customer wants to enable them wherever applicable.", "properties": { "disableSemanticAddOn": { "type": "boolean", "description": "Optional. If true, semantic add-on is disabled. Semantic add-on includes embeddings and jetstream." }, "disableKpiPersonalizationAddOn": { "description": "Optional. If true, disables event re-ranking and personalization to optimize KPIs & personalize results.", "type": "boolean" }, "disableGenerativeAnswerAddOn": { "type": "boolean", "description": "Optional. If true, generative answer add-on is disabled. Generative answer add-on includes natural language to filters and simple answers." } } }, "GoogleCloudDiscoveryengineV1CheckGroundingRequest": { "description": "Request message for GroundedGenerationService.CheckGrounding method.", "type": "object", "id": "GoogleCloudDiscoveryengineV1CheckGroundingRequest", "properties": { "userLabels": { "type": "object", "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.", "additionalProperties": { "type": "string" } }, "groundingSpec": { "description": "Configuration of the grounding check.", "$ref": "GoogleCloudDiscoveryengineV1CheckGroundingSpec" }, "facts": { "description": "List of facts for the grounding check. We support up to 200 facts.", "items": { "$ref": "GoogleCloudDiscoveryengineV1GroundingFact" }, "type": "array" }, "answerCandidate": { "description": "Answer candidate to check. It can have a maximum length of 4096 tokens.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1alphaAlertPolicyResourceConfigAlertEnrollment": { "id": "GoogleCloudDiscoveryengineV1alphaAlertPolicyResourceConfigAlertEnrollment", "properties": { "enrollState": { "enum": [ "ENROLL_STATE_UNSPECIFIED", "ENROLLED", "DECLINED" ], "type": "string", "description": "Required. The enrollment status of a customer.", "enumDescriptions": [ "Default value. Used for customers who have not responded to the alert policy.", "Customer is enrolled in this policy.", "Customer declined this policy." ] }, "alertId": { "description": "Immutable. The id of an alert.", "type": "string" }, "notificationParams": { "description": "Optional. Parameters used to instantiate a notification. Used for notifications that are triggered when registered. Not stored. * Gemini Business welcome emails. * Gemini Business user invitation emails.", "additionalProperties": { "type": "string" }, "type": "object" } }, "type": "object", "description": "The alert enrollment status." }, "GoogleCloudDiscoveryengineV1alphaSingleRegionKey": { "id": "GoogleCloudDiscoveryengineV1alphaSingleRegionKey", "properties": { "kmsKey": { "type": "string", "description": "Required. Single-regional kms key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`." } }, "description": "Metadata for single-regional CMEKs.", "type": "object" }, "GoogleCloudDiscoveryengineV1SearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterStringConstraint": { "properties": { "querySegment": { "description": "Identifies the keywords within the search query that match a filter.", "type": "string" }, "values": { "description": "Values of the string field. The record will only be returned if the field value matches one of the values specified here.", "items": { "type": "string" }, "type": "array" }, "fieldName": { "description": "Name of the string field as defined in the schema.", "type": "string" } }, "id": "GoogleCloudDiscoveryengineV1SearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterStringConstraint", "description": "Constraint expression of a string field.", "type": "object" }, "GoogleCloudDiscoveryengineV1alphaDataProtectionPolicySensitiveDataProtectionPolicy": { "description": "Specifies a Sensitive Data Protection (https://cloud.google.com/sensitive-data-protection/docs/sensitive-data-protection-overview) policy.", "properties": { "policy": { "type": "string", "description": "Optional. Specifies the resource name of the Sensitive Data Protection content policy." } }, "type": "object", "id": "GoogleCloudDiscoveryengineV1alphaDataProtectionPolicySensitiveDataProtectionPolicy" }, "GoogleLongrunningCancelOperationRequest": { "id": "GoogleLongrunningCancelOperationRequest", "description": "The request message for Operations.CancelOperation.", "type": "object", "properties": {} }, "GoogleCloudDiscoveryengineV1alphaCondition": { "type": "object", "description": "Defines circumstances to be checked before allowing a behavior", "properties": { "activeTimeRange": { "type": "array", "description": "Range of time(s) specifying when condition is active. Maximum of 10 time ranges.", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaConditionTimeRange" } }, "queryTerms": { "description": "Search only A list of terms to match the query on. Cannot be set when Condition.query_regex is set. Maximum of 10 query terms.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaConditionQueryTerm" } }, "queryRegex": { "description": "Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. Only supported for Basic Site Search promotion serving controls.", "type": "string" } }, "id": "GoogleCloudDiscoveryengineV1alphaCondition" }, "GoogleCloudDiscoveryengineV1alphaSessionConfig": { "description": "Configuration for the session.", "properties": { "sessionTtl": { "$ref": "GoogleCloudDiscoveryengineV1alphaSessionConfigSessionTtl", "description": "Optional. The TTL for the session. If unset, the default value is 60 days." }, "sessionManagementPolicy": { "description": "Optional. Session management policy that defines who will manage the session.", "enum": [ "SESSION_MANAGEMENT_POLICY_UNSPECIFIED", "NOT_MANAGED", "VERTEX_AI_MANAGED" ], "type": "string", "enumDescriptions": [ "Default value.", "The session will be managed by the customer.", "Sessions multi-tenancy will be controlled by Google using 1P or 3P identity providers." ] } }, "id": "GoogleCloudDiscoveryengineV1alphaSessionConfig", "type": "object" }, "GoogleCloudDiscoveryengineV1SearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint": { "type": "object", "description": "The control points used to define the curve. The curve defined through these control points can only be monotonically increasing or decreasing(constant values are acceptable).", "properties": { "attributeValue": { "description": "Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`.", "type": "string" }, "boostAmount": { "type": "number", "format": "float", "description": "The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above." } }, "id": "GoogleCloudDiscoveryengineV1SearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint" }, "GoogleCloudDiscoveryengineV1SearchResponseSummaryCitationMetadata": { "properties": { "citations": { "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1SearchResponseSummaryCitation" }, "description": "Citations for segments." } }, "type": "object", "id": "GoogleCloudDiscoveryengineV1SearchResponseSummaryCitationMetadata", "description": "Citation metadata." }, "GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsMetadata": { "properties": { "updateTime": { "type": "string", "description": "Operation last update time. If the operation is done, this is also the finish time.", "format": "google-datetime" }, "successCount": { "format": "int64", "description": "Count of CompletionSuggestions successfully imported.", "type": "string" }, "createTime": { "format": "google-datetime", "type": "string", "description": "Operation create time." }, "failureCount": { "type": "string", "format": "int64", "description": "Count of CompletionSuggestions that failed to be imported." } }, "description": "Metadata related to the progress of the ImportCompletionSuggestions operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsMetadata", "type": "object" }, "GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataMetadata": { "id": "GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataMetadata", "type": "object", "description": "Metadata related to the progress of the SiteSearchEngineService.SetUriPatternDocumentData operation. This will be returned by the google.longrunning.Operation.metadata field.", "properties": { "updateTime": { "description": "Operation last update time. If the operation is done, this is also the finish time.", "format": "google-datetime", "type": "string" }, "createTime": { "type": "string", "format": "google-datetime", "description": "Operation create time." } } }, "GoogleCloudDiscoveryengineV1ActionConfig": { "type": "object", "id": "GoogleCloudDiscoveryengineV1ActionConfig", "properties": { "jsonActionParams": { "type": "string", "description": "Optional. Action parameters in json string format." }, "actionParams": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "type": "object", "description": "Optional. Action parameters in structured json format." }, "serviceName": { "description": "Optional. The Service Directory resource name (projects/*/locations/*/namespaces/*/services/*) representing a VPC network endpoint used to connect to the data source's `instance_uri`, defined in DataConnector.params. Required when VPC Service Controls are enabled.", "type": "string" }, "createBapConnection": { "description": "Optional. Whether to create a BAP connection for the connector.", "type": "boolean" }, "isActionConfigured": { "type": "boolean", "readOnly": true, "description": "Output only. The connector contains the necessary parameters and is configured to support actions." }, "userDefinedScopesMapping": { "additionalProperties": { "$ref": "GoogleCloudDiscoveryengineV1ActionConfigScopeList" }, "description": "Optional. Mapping from operation name to the list of scopes. Only be populated if there are user specified scopes.", "type": "object" }, "useStaticSecrets": { "type": "boolean", "description": "Optional. Whether to use static secrets for the connector. If true, the secrets provided in the action_params will be ignored." } }, "description": "Informations to support actions on the connector." }, "GoogleCloudDiscoveryengineV1alphaPurgeUserEventsResponse": { "type": "object", "id": "GoogleCloudDiscoveryengineV1alphaPurgeUserEventsResponse", "properties": { "purgeCount": { "format": "int64", "type": "string", "description": "The total count of events purged as a result of the operation." } }, "description": "Response of the PurgeUserEventsRequest. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field." }, "GoogleCloudDiscoveryengineV1ListCmekConfigsResponse": { "type": "object", "description": "Response message for CmekConfigService.ListCmekConfigs method.", "id": "GoogleCloudDiscoveryengineV1ListCmekConfigsResponse", "properties": { "cmekConfigs": { "items": { "$ref": "GoogleCloudDiscoveryengineV1CmekConfig" }, "description": "All the customer's CmekConfigs.", "type": "array" } } }, "GoogleCloudDiscoveryengineV1alphaSessionConfigSessionTtl": { "description": "Defines the TTL for sessions.", "properties": { "days": { "format": "int32", "description": "Defines the number of days for session TTL.", "type": "integer" } }, "type": "object", "id": "GoogleCloudDiscoveryengineV1alphaSessionConfigSessionTtl" }, "GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfo": { "id": "GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfo", "description": "Unstructured document information.", "properties": { "document": { "type": "string", "description": "Document resource name." }, "title": { "description": "Title.", "type": "string" }, "documentContexts": { "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoDocumentContext" }, "description": "List of document contexts. The content will be used for Answer Generation. This is supposed to be the main content of the document that can be long and comprehensive." }, "extractiveSegments": { "description": "List of extractive segments.", "items": { "$ref": "GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveSegment" }, "type": "array" }, "uri": { "type": "string", "description": "URI for the document." }, "extractiveAnswers": { "deprecated": true, "description": "Deprecated: This field is deprecated and will have no effect on the Answer generation. Please use document_contexts and extractive_segments fields. List of extractive answers.", "items": { "$ref": "GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveAnswer" }, "type": "array" } }, "type": "object" }, "GoogleCloudDiscoveryengineV1ImportDocumentsMetadata": { "description": "Metadata related to the progress of the ImportDocuments operation. This is returned by the google.longrunning.Operation.metadata field.", "properties": { "failureCount": { "format": "int64", "description": "Count of entries that encountered errors while processing.", "type": "string" }, "totalCount": { "format": "int64", "type": "string", "description": "Total count of entries that were processed." }, "successCount": { "format": "int64", "description": "Count of entries that were processed successfully.", "type": "string" }, "createTime": { "format": "google-datetime", "description": "Operation create time.", "type": "string" }, "updateTime": { "description": "Operation last update time. If the operation is done, this is also the finish time.", "type": "string", "format": "google-datetime" } }, "type": "object", "id": "GoogleCloudDiscoveryengineV1ImportDocumentsMetadata" }, "GoogleCloudDiscoveryengineV1Collection": { "description": "Collection is a container for configuring resources and access to a set of DataStores.", "type": "object", "properties": { "name": { "type": "string", "description": "Immutable. The full resource name of the Collection. Format: `projects/{project}/locations/{location}/collections/{collection_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters." }, "displayName": { "type": "string", "description": "Required. The Collection display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned." }, "createTime": { "type": "string", "readOnly": true, "format": "google-datetime", "description": "Output only. Timestamp the Collection was created at." } }, "id": "GoogleCloudDiscoveryengineV1Collection" }, "GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesResponse": { "properties": { "targetSites": { "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaTargetSite" }, "type": "array", "description": "TargetSites created." } }, "id": "GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesResponse", "description": "Response message for SiteSearchEngineService.BatchCreateTargetSites method.", "type": "object" }, "GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigOptimizationObjectiveConfig": { "properties": { "targetField": { "description": "Required. The name of the field to target. Currently supported values: `watch-percentage`, `watch-time`.", "type": "string" }, "targetFieldValueFloat": { "description": "Required. The threshold to be applied to the target (e.g., 0.5).", "type": "number", "format": "float" } }, "type": "object", "id": "GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigOptimizationObjectiveConfig", "description": "Custom threshold for `cvr` optimization_objective." }, "GoogleCloudDiscoveryengineV1DataConnectorRealtimeSyncConfig": { "type": "object", "description": "The configuration for realtime sync to store additional params for realtime sync.", "id": "GoogleCloudDiscoveryengineV1DataConnectorRealtimeSyncConfig", "properties": { "streamingError": { "$ref": "GoogleCloudDiscoveryengineV1DataConnectorRealtimeSyncConfigStreamingError", "description": "Optional. Streaming error details." }, "realtimeSyncSecret": { "description": "Optional. The ID of the Secret Manager secret used for webhook secret.", "type": "string" }, "webhookUri": { "type": "string", "description": "Optional. Webhook url for the connector to specify additional params for realtime sync." } } }, "GoogleCloudDiscoveryengineV1SuggestionDenyListEntry": { "description": "Suggestion deny list entry identifying the phrase to block from suggestions and the applied operation for the phrase.", "id": "GoogleCloudDiscoveryengineV1SuggestionDenyListEntry", "properties": { "blockPhrase": { "description": "Required. Phrase to block from suggestions served. Can be maximum 125 characters.", "type": "string" }, "matchOperator": { "enumDescriptions": [ "Default value. Should not be used", "If the suggestion is an exact match to the block_phrase, then block it.", "If the suggestion contains the block_phrase, then block it." ], "description": "Required. The match operator to apply for this phrase. Whether to block the exact phrase, or block any suggestions containing this phrase.", "type": "string", "enum": [ "MATCH_OPERATOR_UNSPECIFIED", "EXACT_MATCH", "CONTAINS" ] } }, "type": "object" }, "GoogleCloudDiscoveryengineV1alphaStartExperimentRequest": { "description": "Request message for AlphaEvolveService.StartExperiment.", "properties": { "name": { "type": "string", "description": "Required. Experiment to start. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/alphaEvolveExperiments/{alpha_evolve_experiment}`" } }, "id": "GoogleCloudDiscoveryengineV1alphaStartExperimentRequest", "type": "object" }, "GoogleProtobufEmpty": { "type": "object", "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", "properties": {}, "id": "GoogleProtobufEmpty" }, "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequestSuggestionTypeSpec": { "type": "object", "id": "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequestSuggestionTypeSpec", "properties": { "suggestionType": { "type": "string", "description": "Optional. Suggestion type.", "enum": [ "SUGGESTION_TYPE_UNSPECIFIED", "QUERY", "PEOPLE", "CONTENT", "RECENT_SEARCH", "GOOGLE_WORKSPACE" ], "enumDescriptions": [ "Default value.", "Returns query suggestions.", "Returns people suggestions.", "Returns content suggestions.", "Returns recent search suggestions.", "Returns Google Workspace suggestions." ] }, "maxSuggestions": { "description": "Optional. Maximum number of suggestions to return for each suggestion type.", "type": "integer", "format": "int32" } }, "description": "Specification of each suggestion type." }, "GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentConfigEvolutionSettings": { "properties": { "parentSamplingConfig": { "$ref": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentConfigEvolutionSettingsParentSamplingConfig", "description": "Optional. Parent sampling configuration." } }, "id": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentConfigEvolutionSettings", "description": "Evolution settings for the experiment.", "type": "object" }, "GoogleCloudDiscoveryengineV1betaImportDocumentsResponse": { "description": "Response of the ImportDocumentsRequest. If the long running operation is done, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.", "properties": { "errorConfig": { "$ref": "GoogleCloudDiscoveryengineV1betaImportErrorConfig", "description": "Echoes the destination for the complete errors in the request if set." }, "errorSamples": { "description": "A sample of errors encountered while processing the request.", "type": "array", "items": { "$ref": "GoogleRpcStatus" } } }, "id": "GoogleCloudDiscoveryengineV1betaImportDocumentsResponse", "type": "object" }, "GoogleCloudDiscoveryengineV1CompleteQueryResponse": { "description": "Response message for CompletionService.CompleteQuery method.", "type": "object", "id": "GoogleCloudDiscoveryengineV1CompleteQueryResponse", "properties": { "tailMatchTriggered": { "description": "True if the returned suggestions are all tail suggestions. For tail matching to be triggered, include_tail_suggestions in the request must be true and there must be no suggestions that match the full query.", "type": "boolean" }, "querySuggestions": { "description": "Results of the matched query suggestions. The result list is ordered and the first result is a top suggestion.", "items": { "$ref": "GoogleCloudDiscoveryengineV1CompleteQueryResponseQuerySuggestion" }, "type": "array" } } }, "GoogleCloudDiscoveryengineV1alphaCollection": { "description": "Collection is a container for configuring resources and access to a set of DataStores.", "properties": { "displayName": { "type": "string", "description": "Required. The Collection display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned." }, "createTime": { "format": "google-datetime", "description": "Output only. Timestamp the Collection was created at.", "readOnly": true, "type": "string" }, "dataConnector": { "description": "Output only. The data connector, if present, manages the connection for data stores in the Collection. To set up the connector, use DataConnectorService.SetUpDataConnector method, which creates a new Collection while setting up the DataConnector singleton resource. Setting up connector on an existing Collection is not supported. This output only field contains a subset of the DataConnector fields, including `name`, `data_source`, `entities.entity_name` and `entities.data_store`. To get more details about a data connector, use the DataConnectorService.GetDataConnector method.", "$ref": "GoogleCloudDiscoveryengineV1alphaDataConnector", "readOnly": true }, "name": { "description": "Immutable. The full resource name of the Collection. Format: `projects/{project}/locations/{location}/collections/{collection_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", "type": "string" } }, "id": "GoogleCloudDiscoveryengineV1alphaCollection", "type": "object" }, "GoogleCloudDiscoveryengineV1alphaSetUpDataConnectorMetadata": { "id": "GoogleCloudDiscoveryengineV1alphaSetUpDataConnectorMetadata", "description": "Metadata for DataConnectorService.SetUpDataConnector method.", "properties": {}, "type": "object" }, "GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpecQuerySetSpec": { "type": "object", "properties": { "sampleQuerySet": { "type": "string", "description": "Optional. The full resource name of the SampleQuerySet used for the evaluation, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`." } }, "id": "GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpecQuerySetSpec", "description": "Describes the specification of the query set." }, "GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponse": { "type": "object", "properties": { "documentsMetadata": { "description": "The metadata of the Documents.", "items": { "$ref": "GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponseDocumentMetadata" }, "type": "array" } }, "id": "GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponse", "description": "Response message for DocumentService.BatchGetDocumentsMetadata method." }, "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig": { "description": "The digital parsing configurations for documents.", "properties": {}, "type": "object", "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig" }, "GoogleCloudDiscoveryengineV1SearchRequestSearchAddonSpec": { "description": "SearchAddonSpec is used to disable add-ons for search as per new repricing model. By default if the SearchAddonSpec is not specified, we consider that the customer wants to enable them wherever applicable.", "id": "GoogleCloudDiscoveryengineV1SearchRequestSearchAddonSpec", "properties": { "disableGenerativeAnswerAddOn": { "description": "Optional. If true, generative answer add-on is disabled. Generative answer add-on includes natural language to filters and simple answers.", "type": "boolean" }, "disableKpiPersonalizationAddOn": { "description": "Optional. If true, disables event re-ranking and personalization to optimize KPIs & personalize results.", "type": "boolean" }, "disableSemanticAddOn": { "description": "Optional. If true, semantic add-on is disabled. Semantic add-on includes embeddings and jetstream.", "type": "boolean" } }, "type": "object" }, "GoogleCloudDiscoveryengineV1alphaEngineCommonConfig": { "type": "object", "properties": { "companyName": { "type": "string", "description": "The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features." } }, "id": "GoogleCloudDiscoveryengineV1alphaEngineCommonConfig", "description": "Common configurations for an Engine." }, "GoogleCloudDiscoveryengineV1ImportUserEventsMetadata": { "properties": { "failureCount": { "format": "int64", "description": "Count of entries that encountered errors while processing.", "type": "string" }, "createTime": { "description": "Operation create time.", "type": "string", "format": "google-datetime" }, "successCount": { "format": "int64", "description": "Count of entries that were processed successfully.", "type": "string" }, "updateTime": { "type": "string", "description": "Output only. Operation last update time. If the operation is done, this is also the finish time.", "readOnly": true, "format": "google-datetime" } }, "id": "GoogleCloudDiscoveryengineV1ImportUserEventsMetadata", "type": "object", "description": "Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field." }, "GoogleCloudDiscoveryengineV1DataStoreServingConfigDataStore": { "type": "object", "properties": { "disabledForServing": { "description": "Optional. If set true, the DataStore will not be available for serving search requests.", "type": "boolean" } }, "description": "Stores information regarding the serving configurations at DataStore level.", "id": "GoogleCloudDiscoveryengineV1DataStoreServingConfigDataStore" }, "GoogleCloudDiscoveryengineV1alphaBatchUpdateUserLicensesResponse": { "id": "GoogleCloudDiscoveryengineV1alphaBatchUpdateUserLicensesResponse", "type": "object", "properties": { "userLicenses": { "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaUserLicense" }, "description": "UserLicenses successfully updated." }, "errorSamples": { "type": "array", "description": "A sample of errors encountered while processing the request.", "items": { "$ref": "GoogleRpcStatus" } } }, "description": "Response message for UserLicenseService.BatchUpdateUserLicenses method." }, "GoogleCloudDiscoveryengineV1Interval": { "id": "GoogleCloudDiscoveryengineV1Interval", "type": "object", "description": "A floating point interval.", "properties": { "exclusiveMaximum": { "type": "number", "description": "Exclusive upper bound.", "format": "double" }, "exclusiveMinimum": { "format": "double", "description": "Exclusive lower bound.", "type": "number" }, "minimum": { "format": "double", "description": "Inclusive lower bound.", "type": "number" }, "maximum": { "format": "double", "type": "number", "description": "Inclusive upper bound." } } }, "A2aV1TaskPushNotificationConfig": { "properties": { "name": { "description": "The resource name of the config. Format: tasks/{task_id}/pushNotificationConfigs/{config_id}", "type": "string" }, "pushNotificationConfig": { "description": "The push notification configuration details.", "$ref": "A2aV1PushNotificationConfig" } }, "id": "A2aV1TaskPushNotificationConfig", "type": "object" }, "GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo": { "id": "GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo", "description": "Verification information for target sites in advanced site search.", "type": "object", "properties": { "verifyTime": { "format": "google-datetime", "description": "Latest site verification time.", "type": "string" }, "siteVerificationState": { "description": "Site verification state indicating the ownership and validity.", "enum": [ "SITE_VERIFICATION_STATE_UNSPECIFIED", "VERIFIED", "UNVERIFIED", "EXEMPTED" ], "enumDescriptions": [ "Defaults to VERIFIED.", "Site ownership verified.", "Site ownership pending verification or verification failed.", "Site exempt from verification, e.g., a public website that opens to all." ], "type": "string" } } }, "GoogleCloudDiscoveryengineV1ConversationContext": { "type": "object", "description": "Defines context of the conversation", "id": "GoogleCloudDiscoveryengineV1ConversationContext", "properties": { "contextDocuments": { "items": { "type": "string" }, "description": "The current list of documents the user is seeing. It contains the document resource references.", "type": "array" }, "activeDocument": { "type": "string", "description": "The current active document the user opened. It contains the document resource reference." } } }, "A2aV1Part": { "description": "Part represents a container for a section of communication content. Parts can be purely textual, some sort of file (image, video, etc) or a structured data blob (i.e. JSON).", "type": "object", "id": "A2aV1Part", "properties": { "metadata": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "description": "Optional metadata associated with this part.", "type": "object" }, "text": { "type": "string" }, "file": { "$ref": "A2aV1FilePart" }, "data": { "$ref": "A2aV1DataPart" } } }, "GoogleCloudDiscoveryengineV1betaControlBoostAction": { "description": "Adjusts order of products in returned list.", "id": "GoogleCloudDiscoveryengineV1betaControlBoostAction", "properties": { "fixedBoost": { "description": "Optional. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).", "format": "float", "type": "number" }, "interpolationBoostSpec": { "$ref": "GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpec", "description": "Optional. Complex specification for custom ranking based on customer defined attribute value." }, "boost": { "description": "Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).", "format": "float", "deprecated": true, "type": "number" }, "filter": { "type": "string", "description": "Required. Specifies which products to apply the boost to. If no filter is provided all products will be boosted (No-op). Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown." }, "dataStore": { "type": "string", "description": "Required. Specifies which data store's documents can be boosted by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store" } }, "type": "object" }, "GoogleCloudDiscoveryengineV1DocumentInfo": { "id": "GoogleCloudDiscoveryengineV1DocumentInfo", "type": "object", "description": "Detailed document information associated with a user event.", "properties": { "id": { "type": "string", "description": "The Document resource ID." }, "quantity": { "description": "Quantity of the Document associated with the user event. Defaults to 1. For example, this field is 2 if two quantities of the same Document are involved in a `add-to-cart` event. Required for events of the following event types: * `add-to-cart` * `purchase`", "format": "int32", "type": "integer" }, "name": { "type": "string", "description": "The Document resource full name, of the form: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/branches/{branch_id}/documents/{document_id}`" }, "promotionIds": { "type": "array", "description": "The promotion IDs associated with this Document. Currently, this field is restricted to at most one ID.", "items": { "type": "string" } }, "uri": { "description": "The Document URI - only allowed for website data stores.", "type": "string" }, "joined": { "readOnly": true, "type": "boolean", "description": "Output only. Whether the referenced Document can be found in the data store." }, "conversionValue": { "description": "Optional. The conversion value associated with this Document. Must be set if UserEvent.event_type is \"conversion\". For example, a value of 1000 signifies that 1000 seconds were spent viewing a Document for the `watch` conversion type.", "format": "float", "type": "number" } } }, "GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchMetadata": { "id": "GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchMetadata", "description": "Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.", "type": "object", "properties": { "updateTime": { "type": "string", "description": "Operation last update time. If the operation is done, this is also the finish time.", "format": "google-datetime" }, "createTime": { "format": "google-datetime", "type": "string", "description": "Operation create time." } } }, "GoogleCloudDiscoveryengineV1DynamicTool": { "properties": { "enabled": { "type": "boolean", "description": "Optional. Whether the tool is enabled." }, "name": { "description": "Required. The name of the tool.", "type": "string" }, "description": { "description": "Optional. The description of the tool.", "type": "string" }, "displayName": { "description": "Optional. The display name of the tool.", "type": "string" } }, "description": "Configuration for dynamic tools.", "id": "GoogleCloudDiscoveryengineV1DynamicTool", "type": "object" }, "GoogleCloudDiscoveryengineV1AssistantContentCodeExecutionResult": { "properties": { "outcome": { "type": "string", "enum": [ "OUTCOME_UNSPECIFIED", "OUTCOME_OK", "OUTCOME_FAILED", "OUTCOME_DEADLINE_EXCEEDED" ], "enumDescriptions": [ "Unspecified status. This value should not be used.", "Code execution completed successfully.", "Code execution finished but with a failure. `stderr` should contain the reason.", "Code execution ran for too long, and was cancelled. There may or may not be a partial output present." ], "description": "Required. Outcome of the code execution." }, "output": { "type": "string", "description": "Optional. Contains stdout when code execution is successful, stderr or other description otherwise." } }, "description": "Result of executing ExecutableCode.", "id": "GoogleCloudDiscoveryengineV1AssistantContentCodeExecutionResult", "type": "object" }, "GoogleCloudDiscoveryengineV1betaSearchRequestCustomRankingParams": { "id": "GoogleCloudDiscoveryengineV1betaSearchRequestCustomRankingParams", "properties": { "expressionsToPrecompute": { "description": "Optional. A list of ranking expressions (see `ranking_expression` for the syntax documentation) to evaluate. The evaluation results will be returned in `SearchResponse.SearchResult.rank_signals.precomputed_expression_values` field.", "type": "array", "items": { "type": "string" } } }, "description": "Configuration parameters for the Custom Ranking feature.", "type": "object" }, "GoogleCloudDiscoveryengineV1TargetSiteFailureReason": { "id": "GoogleCloudDiscoveryengineV1TargetSiteFailureReason", "description": "Site search indexing failure reasons.", "properties": { "quotaFailure": { "$ref": "GoogleCloudDiscoveryengineV1TargetSiteFailureReasonQuotaFailure", "description": "Failed due to insufficient quota." } }, "type": "object" }, "GoogleCloudDiscoveryengineV1StreamAssistRequestAgentsSpec": { "description": "Specification of agents that are used to serve the request.", "type": "object", "id": "GoogleCloudDiscoveryengineV1StreamAssistRequestAgentsSpec", "properties": { "agentSpecs": { "description": "Optional. Specification of agents that are used to serve the request.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1StreamAssistRequestAgentsSpecAgentSpec" } } } }, "GoogleCloudDiscoveryengineLoggingHttpRequestContext": { "properties": { "responseStatusCode": { "format": "int32", "type": "integer", "description": "The HTTP response status code for the request." } }, "description": "HTTP request data that is related to a reported error.", "type": "object", "id": "GoogleCloudDiscoveryengineLoggingHttpRequestContext" }, "GoogleCloudDiscoveryengineV1alphaWorkspaceConfig": { "description": "Config to store data store type configuration for workspace data", "properties": { "superAdminServiceAccount": { "description": "Optional. The super admin service account for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion.", "type": "string" }, "superAdminEmailAddress": { "description": "Optional. The super admin email address for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion.", "type": "string" }, "dasherCustomerId": { "readOnly": true, "description": "Output only. Obfuscated Dasher customer ID. Derived by the server from the project's GCP organization at data store creation time; any value supplied in the request payload is ignored.", "type": "string" }, "type": { "enumDescriptions": [ "Defaults to an unspecified Workspace type.", "Workspace Data Store contains Drive data", "Workspace Data Store contains Mail data", "Workspace Data Store contains Sites data", "Workspace Data Store contains Calendar data", "Workspace Data Store contains Chat data", "Workspace Data Store contains Groups data", "Workspace Data Store contains Keep data", "Workspace Data Store contains People data", "Workspace Data Store contains all Workspace apps data" ], "type": "string", "description": "The Google Workspace data source.", "enum": [ "TYPE_UNSPECIFIED", "GOOGLE_DRIVE", "GOOGLE_MAIL", "GOOGLE_SITES", "GOOGLE_CALENDAR", "GOOGLE_CHAT", "GOOGLE_GROUPS", "GOOGLE_KEEP", "GOOGLE_PEOPLE", "GOOGLE_WORKSPACE" ] } }, "id": "GoogleCloudDiscoveryengineV1alphaWorkspaceConfig", "type": "object" }, "GoogleCloudDiscoveryengineV1RetractLicenseConfigResponse": { "type": "object", "properties": { "licenseConfig": { "description": "The updated LicenseConfig.", "$ref": "GoogleCloudDiscoveryengineV1LicenseConfig" } }, "id": "GoogleCloudDiscoveryengineV1RetractLicenseConfigResponse", "description": "Response message for LicenseConfigService.RetractLicenseConfig method." }, "GoogleCloudDiscoveryengineV1CreateEngineMetadata": { "type": "object", "properties": { "updateTime": { "description": "Operation last update time. If the operation is done, this is also the finish time.", "format": "google-datetime", "type": "string" }, "createTime": { "description": "Operation create time.", "format": "google-datetime", "type": "string" } }, "id": "GoogleCloudDiscoveryengineV1CreateEngineMetadata", "description": "Metadata related to the progress of the EngineService.CreateEngine operation. This will be returned by the google.longrunning.Operation.metadata field." }, "GoogleCloudDiscoveryengineV1alphaAssistantContentExecutableCode": { "description": "Code generated by the model that is meant to be executed by the model.", "properties": { "code": { "description": "Required. The code content. Currently only supports Python.", "type": "string" } }, "id": "GoogleCloudDiscoveryengineV1alphaAssistantContentExecutableCode", "type": "object" }, "GoogleCloudDiscoveryengineV1UserStore": { "type": "object", "description": "Configures metadata that is used for End User entities.", "properties": { "enableLicenseAutoRegister": { "description": "Optional. Whether to enable license auto register for users in this User Store. If true, new users will automatically register under the default license config as long as the default license config has seats left.", "type": "boolean" }, "defaultLicenseConfig": { "description": "Optional. The default subscription LicenseConfig for the UserStore, if UserStore.enable_license_auto_register is true, new users will automatically register under the default subscription. If default LicenseConfig doesn't have remaining license seats left, new users will not be assigned with license and will be blocked for Vertex AI Search features. This is used if `license_assignment_tier_rules` is not configured.", "type": "string" }, "displayName": { "type": "string", "description": "The display name of the User Store." }, "enableExpiredLicenseAutoUpdate": { "description": "Optional. Whether to enable license auto update for users in this User Store. If true, users with expired licenses will automatically be updated to use the default license config as long as the default license config has seats left.", "type": "boolean" }, "name": { "description": "Immutable. The full resource name of the User Store, in the format of `projects/{project}/locations/{location}/userStores/{user_store}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", "type": "string" } }, "id": "GoogleCloudDiscoveryengineV1UserStore" }, "GoogleCloudDiscoveryengineV1alphaUpdateCmekConfigMetadata": { "id": "GoogleCloudDiscoveryengineV1alphaUpdateCmekConfigMetadata", "description": "Metadata related to the progress of the CmekConfigService.UpdateCmekConfig operation. This will be returned by the google.longrunning.Operation.metadata field.", "type": "object", "properties": { "updateTime": { "description": "Operation last update time. If the operation is done, this is also the finish time.", "type": "string", "format": "google-datetime" }, "createTime": { "description": "Operation create time.", "format": "google-datetime", "type": "string" } } }, "A2aV1Task": { "type": "object", "id": "A2aV1Task", "description": "Task is the core unit of action for A2A. It has a current status and when results are created for the task they are stored in the artifact. If there are multiple turns for a task, these are stored in history.", "properties": { "contextId": { "type": "string", "description": "Unique identifier (e.g. UUID) for the contextual collection of interactions (tasks and messages). Created by the A2A server." }, "status": { "description": "The current status of a Task, including state and a message.", "$ref": "A2aV1TaskStatus" }, "metadata": { "type": "object", "description": "protolint:enable REPEATED_FIELD_NAMES_PLURALIZED A key/value object to store custom metadata about a task.", "additionalProperties": { "description": "Properties of the object.", "type": "any" } }, "id": { "type": "string", "description": "Unique identifier (e.g. UUID) for the task, generated by the server for a new task." }, "artifacts": { "items": { "$ref": "A2aV1Artifact" }, "description": "A set of output artifacts for a Task.", "type": "array" }, "history": { "items": { "$ref": "A2aV1Message" }, "type": "array", "description": "protolint:disable REPEATED_FIELD_NAMES_PLURALIZED The history of interactions from a task." } } }, "GoogleLongrunningOperation": { "id": "GoogleLongrunningOperation", "properties": { "metadata": { "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", "type": "object", "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" } }, "response": { "description": "The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.", "type": "object", "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" } }, "error": { "description": "The error result of the operation in case of failure or cancellation.", "$ref": "GoogleRpcStatus" }, "done": { "description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.", "type": "boolean" }, "name": { "type": "string", "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`." } }, "type": "object", "description": "This resource represents a long-running operation that is the result of a network API call." }, "GoogleCloudDiscoveryengineV1AnswerQueryRequestEndUserSpecEndUserMetaDataChunkInfoDocumentMetadata": { "properties": { "title": { "description": "Title of the document.", "type": "string" } }, "id": "GoogleCloudDiscoveryengineV1AnswerQueryRequestEndUserSpecEndUserMetaDataChunkInfoDocumentMetadata", "type": "object", "description": "Document metadata contains the information of the document of the current chunk." }, "GoogleCloudDiscoveryengineV1alphaSafetyRating": { "properties": { "severityScore": { "readOnly": true, "type": "number", "format": "float", "description": "Output only. Harm severity score." }, "probability": { "type": "string", "description": "Output only. Harm probability levels in the content.", "readOnly": true, "enum": [ "HARM_PROBABILITY_UNSPECIFIED", "NEGLIGIBLE", "LOW", "MEDIUM", "HIGH" ], "enumDescriptions": [ "Harm probability unspecified.", "Negligible level of harm.", "Low level of harm.", "Medium level of harm.", "High level of harm." ] }, "category": { "enumDescriptions": [ "The harm category is unspecified.", "The harm category is hate speech.", "The harm category is dangerous content.", "The harm category is harassment.", "The harm category is sexually explicit content.", "The harm category is civic integrity." ], "type": "string", "readOnly": true, "enum": [ "HARM_CATEGORY_UNSPECIFIED", "HARM_CATEGORY_HATE_SPEECH", "HARM_CATEGORY_DANGEROUS_CONTENT", "HARM_CATEGORY_HARASSMENT", "HARM_CATEGORY_SEXUALLY_EXPLICIT", "HARM_CATEGORY_CIVIC_INTEGRITY" ], "description": "Output only. Harm category." }, "severity": { "enum": [ "HARM_SEVERITY_UNSPECIFIED", "HARM_SEVERITY_NEGLIGIBLE", "HARM_SEVERITY_LOW", "HARM_SEVERITY_MEDIUM", "HARM_SEVERITY_HIGH" ], "enumDescriptions": [ "Harm severity unspecified.", "Negligible level of harm severity.", "Low level of harm severity.", "Medium level of harm severity.", "High level of harm severity." ], "description": "Output only. Harm severity levels in the content.", "type": "string", "readOnly": true }, "probabilityScore": { "readOnly": true, "type": "number", "description": "Output only. Harm probability score.", "format": "float" }, "blocked": { "type": "boolean", "readOnly": true, "description": "Output only. Indicates whether the content was filtered out because of this rating." } }, "type": "object", "description": "Safety rating corresponding to the generated content.", "id": "GoogleCloudDiscoveryengineV1alphaSafetyRating" }, "GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadata": { "properties": { "dialogflowAgent": { "description": "The resource name of a Dialogflow agent, that this Chat Engine refers to. Format: `projects//locations//agents/`.", "type": "string" } }, "description": "Additional information of a Chat Engine. Fields in this message are output only.", "type": "object", "id": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadata" }, "GoogleCloudDiscoveryengineV1betaCreateEvaluationMetadata": { "id": "GoogleCloudDiscoveryengineV1betaCreateEvaluationMetadata", "properties": {}, "description": "Metadata for EvaluationService.CreateEvaluation method.", "type": "object" }, "GoogleCloudDiscoveryengineV1betaEngineChatEngineMetadata": { "description": "Additional information of a Chat Engine. Fields in this message are output only.", "id": "GoogleCloudDiscoveryengineV1betaEngineChatEngineMetadata", "type": "object", "properties": { "dialogflowAgent": { "description": "The resource name of a Dialogflow agent, that this Chat Engine refers to. Format: `projects//locations//agents/`.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1DocumentAclInfoAccessRestriction": { "properties": { "idpWide": { "type": "boolean", "description": "All users within the Identity Provider." }, "principals": { "items": { "$ref": "GoogleCloudDiscoveryengineV1Principal" }, "type": "array", "description": "List of principals." } }, "description": "AclRestriction to model complex inheritance restrictions. Example: Modeling a \"Both Permit\" inheritance, where to access a child document, user needs to have access to parent document. Document Hierarchy - Space_S --\u003e Page_P. Readers: Space_S: group_1, user_1 Page_P: group_2, group_3, user_2 Space_S ACL Restriction - { \"acl_info\": { \"readers\": [ { \"principals\": [ { \"group_id\": \"group_1\" }, { \"user_id\": \"user_1\" } ] } ] } } Page_P ACL Restriction. { \"acl_info\": { \"readers\": [ { \"principals\": [ { \"group_id\": \"group_2\" }, { \"group_id\": \"group_3\" }, { \"user_id\": \"user_2\" } ], }, { \"principals\": [ { \"group_id\": \"group_1\" }, { \"user_id\": \"user_1\" } ], } ] } }", "id": "GoogleCloudDiscoveryengineV1DocumentAclInfoAccessRestriction", "type": "object" }, "GoogleCloudDiscoveryengineV1betaImportDocumentsMetadata": { "description": "Metadata related to the progress of the ImportDocuments operation. This is returned by the google.longrunning.Operation.metadata field.", "type": "object", "id": "GoogleCloudDiscoveryengineV1betaImportDocumentsMetadata", "properties": { "failureCount": { "type": "string", "description": "Count of entries that encountered errors while processing.", "format": "int64" }, "successCount": { "format": "int64", "description": "Count of entries that were processed successfully.", "type": "string" }, "totalCount": { "type": "string", "description": "Total count of entries that were processed.", "format": "int64" }, "updateTime": { "description": "Operation last update time. If the operation is done, this is also the finish time.", "format": "google-datetime", "type": "string" }, "createTime": { "type": "string", "format": "google-datetime", "description": "Operation create time." } } }, "GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchMetadata": { "description": "Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.", "properties": { "createTime": { "format": "google-datetime", "description": "Operation create time.", "type": "string" }, "updateTime": { "description": "Operation last update time. If the operation is done, this is also the finish time.", "type": "string", "format": "google-datetime" } }, "type": "object", "id": "GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchMetadata" }, "GoogleCloudDiscoveryengineV1alphaPurgeUserEventsMetadata": { "id": "GoogleCloudDiscoveryengineV1alphaPurgeUserEventsMetadata", "description": "Metadata related to the progress of the PurgeUserEvents operation. This will be returned by the google.longrunning.Operation.metadata field.", "type": "object", "properties": { "createTime": { "format": "google-datetime", "type": "string", "description": "Operation create time." }, "successCount": { "type": "string", "description": "Count of entries that were deleted successfully.", "format": "int64" }, "updateTime": { "type": "string", "format": "google-datetime", "description": "Operation last update time. If the operation is done, this is also the finish time." }, "failureCount": { "format": "int64", "description": "Count of entries that encountered errors while processing.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1alphaUserInfoPreciseLocation": { "description": "Precise location info with multiple representation options.", "properties": { "address": { "type": "string", "description": "Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon." }, "point": { "$ref": "GoogleTypeLatLng", "description": "Optional. Location represented by a latitude/longitude point." } }, "type": "object", "id": "GoogleCloudDiscoveryengineV1alphaUserInfoPreciseLocation" }, "GoogleCloudDiscoveryengineV1BatchUpdateUserLicensesResponse": { "description": "Response message for UserLicenseService.BatchUpdateUserLicenses method.", "properties": { "userLicenses": { "items": { "$ref": "GoogleCloudDiscoveryengineV1UserLicense" }, "description": "UserLicenses successfully updated.", "type": "array" }, "errorSamples": { "type": "array", "description": "A sample of errors encountered while processing the request.", "items": { "$ref": "GoogleRpcStatus" } } }, "id": "GoogleCloudDiscoveryengineV1BatchUpdateUserLicensesResponse", "type": "object" }, "GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesMetadata": { "description": "Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", "type": "object", "properties": { "updateTime": { "description": "Operation last update time. If the operation is done, this is also the finish time.", "type": "string", "format": "google-datetime" }, "createTime": { "type": "string", "description": "Operation create time.", "format": "google-datetime" } }, "id": "GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesMetadata" }, "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpecModelPromptSpec": { "description": "Specification of the prompt to use with the model.", "type": "object", "properties": { "preamble": { "type": "string", "description": "Text at the beginning of the prompt that instructs the assistant. Examples are available in the user guide." } }, "id": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpecModelPromptSpec" }, "GoogleCloudDiscoveryengineV1DataStoreBillingEstimation": { "description": "Estimation of data size per data store.", "properties": { "structuredDataUpdateTime": { "type": "string", "description": "Last updated timestamp for structured data.", "format": "google-datetime" }, "websiteDataSize": { "description": "Data size for websites in terms of bytes.", "type": "string", "format": "int64" }, "structuredDataSize": { "format": "int64", "description": "Data size for structured data in terms of bytes.", "type": "string" }, "websiteDataUpdateTime": { "type": "string", "description": "Last updated timestamp for websites.", "format": "google-datetime" }, "unstructuredDataSize": { "description": "Data size for unstructured data in terms of bytes.", "type": "string", "format": "int64" }, "unstructuredDataUpdateTime": { "format": "google-datetime", "type": "string", "description": "Last updated timestamp for unstructured data." } }, "type": "object", "id": "GoogleCloudDiscoveryengineV1DataStoreBillingEstimation" }, "GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpecControlPoint": { "properties": { "boostAmount": { "format": "float", "description": "Optional. The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above.", "type": "number" }, "attributeValue": { "description": "Optional. Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`.", "type": "string" } }, "description": "The control points used to define the curve. The curve defined through these control points can only be monotonically increasing or decreasing(constant values are acceptable).", "type": "object", "id": "GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpecControlPoint" }, "GoogleCloudDiscoveryengineV1UserInfo": { "description": "Information of an end user.", "properties": { "preciseLocation": { "$ref": "GoogleCloudDiscoveryengineV1UserInfoPreciseLocation", "description": "Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents." }, "timeZone": { "type": "string", "description": "Optional. IANA time zone, e.g. Europe/Budapest." }, "userAgent": { "description": "User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set.", "type": "string" }, "userId": { "type": "string", "description": "Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded." } }, "type": "object", "id": "GoogleCloudDiscoveryengineV1UserInfo" }, "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint": { "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint", "type": "object", "description": "The control points used to define the curve. The curve defined through these control points can only be monotonically increasing or decreasing(constant values are acceptable).", "properties": { "attributeValue": { "type": "string", "description": "Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`." }, "boostAmount": { "format": "float", "description": "The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above.", "type": "number" } } }, "GoogleCloudDiscoveryengineV1ListDocumentsResponse": { "type": "object", "properties": { "nextPageToken": { "type": "string", "description": "A token that can be sent as ListDocumentsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages." }, "documents": { "description": "The Documents.", "items": { "$ref": "GoogleCloudDiscoveryengineV1Document" }, "type": "array" } }, "description": "Response message for DocumentService.ListDocuments method.", "id": "GoogleCloudDiscoveryengineV1ListDocumentsResponse" }, "GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesRequest": { "properties": { "gcsSource": { "description": "Cloud Storage location for the input content. Only 1 file can be specified that contains all entries to import. Supported values `gcs_source.schema` for autocomplete suggestion deny list entry imports: * `suggestion_deny_list` (default): One JSON [SuggestionDenyListEntry] per line.", "$ref": "GoogleCloudDiscoveryengineV1GcsSource" }, "inlineSource": { "description": "The Inline source for the input content for suggestion deny list entries.", "$ref": "GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesRequestInlineSource" } }, "description": "Request message for CompletionService.ImportSuggestionDenyListEntries method.", "type": "object", "id": "GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesRequest" }, "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponse": { "type": "object", "properties": { "failedUris": { "items": { "type": "string" }, "description": "URIs that were not crawled before the LRO terminated.", "type": "array" }, "failureSamples": { "type": "array", "description": "Details for a sample of up to 10 `failed_uris`.", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo" } } }, "id": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponse", "description": "Response message for SiteSearchEngineService.RecrawlUris method." }, "GoogleCloudDiscoveryengineV1FetchSitemapsResponse": { "description": "Response message for SiteSearchEngineService.FetchSitemaps method.", "properties": { "sitemapsMetadata": { "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1FetchSitemapsResponseSitemapMetadata" }, "description": "List of Sitemaps fetched." } }, "type": "object", "id": "GoogleCloudDiscoveryengineV1FetchSitemapsResponse" }, "GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpecEmbeddingVector": { "description": "Embedding vector.", "properties": { "vector": { "description": "Query embedding vector.", "type": "array", "items": { "format": "float", "type": "number" } }, "fieldPath": { "type": "string", "description": "Embedding field path in schema." } }, "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpecEmbeddingVector", "type": "object" }, "GoogleCloudDiscoveryengineV1betaWorkspaceConfig": { "id": "GoogleCloudDiscoveryengineV1betaWorkspaceConfig", "properties": { "superAdminServiceAccount": { "type": "string", "description": "Optional. The super admin service account for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion." }, "type": { "description": "The Google Workspace data source.", "type": "string", "enumDescriptions": [ "Defaults to an unspecified Workspace type.", "Workspace Data Store contains Drive data", "Workspace Data Store contains Mail data", "Workspace Data Store contains Sites data", "Workspace Data Store contains Calendar data", "Workspace Data Store contains Chat data", "Workspace Data Store contains Groups data", "Workspace Data Store contains Keep data", "Workspace Data Store contains People data", "Workspace Data Store contains all Workspace apps data" ], "enum": [ "TYPE_UNSPECIFIED", "GOOGLE_DRIVE", "GOOGLE_MAIL", "GOOGLE_SITES", "GOOGLE_CALENDAR", "GOOGLE_CHAT", "GOOGLE_GROUPS", "GOOGLE_KEEP", "GOOGLE_PEOPLE", "GOOGLE_WORKSPACE" ] }, "dasherCustomerId": { "readOnly": true, "type": "string", "description": "Output only. Obfuscated Dasher customer ID. Derived by the server from the project's GCP organization at data store creation time; any value supplied in the request payload is ignored." }, "superAdminEmailAddress": { "description": "Optional. The super admin email address for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion.", "type": "string" } }, "type": "object", "description": "Config to store data store type configuration for workspace data" }, "GoogleApiMonitoredResourceMetadata": { "id": "GoogleApiMonitoredResourceMetadata", "properties": { "userLabels": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Output only. A map of user-defined metadata labels." }, "systemLabels": { "description": "Output only. Values for predefined system metadata labels. System labels are a kind of metadata extracted by Google, including \"machine_image\", \"vpc\", \"subnet_id\", \"security_group\", \"name\", etc. System label values can be only strings, Boolean values, or a list of strings. For example: { \"name\": \"my-test-instance\", \"security_group\": [\"a\", \"b\", \"c\"], \"spot_instance\": false }", "additionalProperties": { "type": "any", "description": "Properties of the object." }, "type": "object" } }, "type": "object", "description": "Auxiliary metadata for a MonitoredResource object. MonitoredResource objects contain the minimum set of information to uniquely identify a monitored resource instance. There is some other useful auxiliary metadata. Monitoring and Logging use an ingestion pipeline to extract metadata for cloud resources of all types, and store the metadata in this message." }, "GoogleCloudDiscoveryengineV1RecommendResponseRecommendationResult": { "id": "GoogleCloudDiscoveryengineV1RecommendResponseRecommendationResult", "properties": { "metadata": { "additionalProperties": { "type": "any" }, "description": "Additional Document metadata or annotations. Possible values: * `score`: Recommendation score in double value. Is set if `returnScore` is set to true in RecommendRequest.params.", "type": "object" }, "id": { "description": "Resource ID of the recommended Document.", "type": "string" }, "document": { "description": "Set if `returnDocument` is set to true in RecommendRequest.params.", "$ref": "GoogleCloudDiscoveryengineV1Document" } }, "type": "object", "description": "RecommendationResult represents a generic recommendation result with associated metadata." }, "GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchResponse": { "id": "GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchResponse", "properties": {}, "description": "Response message for SiteSearchEngineService.EnableAdvancedSiteSearch method.", "type": "object" }, "GoogleCloudDiscoveryengineV1alphaDeleteEngineMetadata": { "type": "object", "description": "Metadata related to the progress of the EngineService.DeleteEngine operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1alphaDeleteEngineMetadata", "properties": { "updateTime": { "format": "google-datetime", "description": "Operation last update time. If the operation is done, this is also the finish time.", "type": "string" }, "createTime": { "type": "string", "description": "Operation create time.", "format": "google-datetime" } } }, "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig": { "description": "Custom threshold for `cvr` optimization_objective.", "properties": { "targetFieldValueFloat": { "description": "Required. The threshold to be applied to the target (e.g., 0.5).", "type": "number", "format": "float" }, "targetField": { "description": "Required. The name of the field to target. Currently supported values: `watch-percentage`, `watch-time`.", "type": "string" } }, "type": "object", "id": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig" }, "GoogleCloudDiscoveryengineLoggingSourceLocation": { "id": "GoogleCloudDiscoveryengineLoggingSourceLocation", "description": "Indicates a location in the source code of the service for which errors are reported.", "properties": { "functionName": { "type": "string", "description": "Human-readable name of a function or method—for example, `google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend`." } }, "type": "object" }, "GoogleCloudDiscoveryengineV1betaSearchRequestSpellCorrectionSpec": { "properties": { "mode": { "enum": [ "MODE_UNSPECIFIED", "SUGGESTION_ONLY", "AUTO" ], "type": "string", "enumDescriptions": [ "Unspecified spell correction mode. In this case, server behavior defaults to Mode.AUTO.", "Search API tries to find a spelling suggestion. If a suggestion is found, it is put in the SearchResponse.corrected_query. The spelling suggestion won't be used as the search query.", "Automatic spell correction built by the Search API. Search will be based on the corrected query if found." ], "description": "The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO." } }, "id": "GoogleCloudDiscoveryengineV1betaSearchRequestSpellCorrectionSpec", "type": "object", "description": "The specification for query spell correction." }, "GoogleCloudDiscoveryengineV1NaturalLanguageQueryUnderstandingConfig": { "id": "GoogleCloudDiscoveryengineV1NaturalLanguageQueryUnderstandingConfig", "properties": { "mode": { "description": "Mode of Natural Language Query Understanding. If this field is unset, the behavior defaults to NaturalLanguageQueryUnderstandingConfig.Mode.DISABLED.", "type": "string", "enumDescriptions": [ "Default value.", "Natural Language Query Understanding is disabled.", "Natural Language Query Understanding is enabled." ], "enum": [ "MODE_UNSPECIFIED", "DISABLED", "ENABLED" ] } }, "description": "Configuration for Natural Language Query Understanding.", "type": "object" }, "GoogleCloudDiscoveryengineV1betaBatchCreateTargetSiteMetadata": { "id": "GoogleCloudDiscoveryengineV1betaBatchCreateTargetSiteMetadata", "description": "Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field.", "type": "object", "properties": { "createTime": { "type": "string", "description": "Operation create time.", "format": "google-datetime" }, "updateTime": { "format": "google-datetime", "type": "string", "description": "Operation last update time. If the operation is done, this is also the finish time." } } }, "GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfig": { "id": "GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfig", "description": "Configuration for NotebookLM.", "properties": { "observabilityConfig": { "$ref": "GoogleCloudDiscoveryengineV1ObservabilityConfig", "description": "Optional. Observability config for NotebookLM." }, "optOutNotebookSharing": { "type": "boolean", "description": "Optional. Whether to disable the notebook sharing feature for the project. Default to false if not specified." }, "modelArmorConfig": { "description": "Model Armor configuration to be used for sanitizing user prompts and LLM responses.", "$ref": "GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig" }, "dataProtectionPolicy": { "$ref": "GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfigDataProtectionPolicy", "description": "Optional. Specifies the data protection policy for NotebookLM." } }, "type": "object" }, "GoogleCloudDiscoveryengineV1alphaObservabilityConfig": { "properties": { "observabilityEnabled": { "description": "Optional. Enables observability. If `false`, all other flags are ignored.", "type": "boolean" }, "sensitiveLoggingEnabled": { "description": "Optional. Enables sensitive logging. Sensitive logging includes customer core content (e.g. prompts, responses). If `false`, will sanitize all sensitive fields.", "type": "boolean" } }, "id": "GoogleCloudDiscoveryengineV1alphaObservabilityConfig", "description": "Observability config for a resource.", "type": "object" }, "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecMultiModalSpec": { "type": "object", "description": "Multimodal specification: Will return an image from specified source. If multiple sources are specified, the pick is a quality based decision.", "properties": { "imageSource": { "type": "string", "enum": [ "IMAGE_SOURCE_UNSPECIFIED", "ALL_AVAILABLE_SOURCES", "CORPUS_IMAGE_ONLY", "FIGURE_GENERATION_ONLY" ], "description": "Optional. Source of image returned in the answer.", "enumDescriptions": [ "Unspecified image source (multimodal feature is disabled by default).", "Behavior when service determines the pick from all available sources.", "Includes image from corpus in the answer.", "Triggers figure generation in the answer." ] } }, "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecMultiModalSpec" }, "GoogleCloudDiscoveryengineV1betaEngineKnowledgeGraphConfigFeatureConfig": { "description": "Feature config for the Knowledge Graph.", "properties": { "disablePrivateKgQueryUiChips": { "description": "Whether to disable the private KG for query UI chips. Defaults to false if not specified.", "type": "boolean" }, "disablePrivateKgQueryUnderstanding": { "type": "boolean", "description": "Whether to disable the private KG query understanding for the engine. Defaults to false if not specified." }, "disablePrivateKgEnrichment": { "description": "Whether to disable the private KG enrichment for the engine. Defaults to false if not specified.", "type": "boolean" }, "disablePrivateKgAutoComplete": { "description": "Whether to disable the private KG auto complete for the engine. Defaults to false if not specified.", "type": "boolean" } }, "type": "object", "id": "GoogleCloudDiscoveryengineV1betaEngineKnowledgeGraphConfigFeatureConfig" }, "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecChunkSpec": { "description": "Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS", "properties": { "numNextChunks": { "description": "The number of next chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no next chunks will be returned.", "format": "int32", "type": "integer" }, "numPreviousChunks": { "type": "integer", "format": "int32", "description": "The number of previous chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no previous chunks will be returned." } }, "type": "object", "id": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecChunkSpec" }, "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig": { "description": "The layout parsing configurations for documents.", "properties": { "excludeHtmlClasses": { "description": "Optional. List of HTML classes to exclude from the parsed content.", "type": "array", "items": { "type": "string" } }, "structuredContentTypes": { "type": "array", "items": { "type": "string" }, "description": "Optional. Contains the required structure types to extract from the document. Supported values: * `shareholder-structure`" }, "enableLlmLayoutParsing": { "description": "Optional. If true, the pdf layout will be refined using an LLM.", "type": "boolean" }, "excludeHtmlIds": { "type": "array", "items": { "type": "string" }, "description": "Optional. List of HTML ids to exclude from the parsed content." }, "enableGetProcessedDocument": { "description": "Optional. If true, the processed document will be made available for the GetProcessedDocument API.", "type": "boolean" }, "excludeHtmlElements": { "type": "array", "description": "Optional. List of HTML elements to exclude from the parsed content.", "items": { "type": "string" } }, "enableTableAnnotation": { "description": "Optional. If true, the LLM based annotation is added to the table during parsing.", "type": "boolean" }, "enableImageAnnotation": { "description": "Optional. If true, the LLM based annotation is added to the image during parsing.", "type": "boolean" } }, "type": "object", "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig" }, "GoogleCloudDiscoveryengineV1alphaAddPatientFilterRequest": { "description": "Request for DataStoreService.AddPatientFilter method.", "properties": { "dataStore": { "type": "string", "description": "Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. If the caller does not have permission to access the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error is returned. If the requested DataStore already has a patient filter, an ALREADY_EXISTS error will be returned." }, "filterGroups": { "type": "array", "description": "Required. Names of the Group resources to use as a basis for the patient filter, in format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Group/{group_id}`. if the caller does not have permission to access the FHIR store, regardless of whether it exists, PERMISSION_DENIED error is returned. If the discovery engine service account does not have permission to access the FHIR store, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the group is not found at the location, a RESOURCE_NOT_FOUND error will be returned. The filter group must be a FHIR resource name of type Group, and the filter will be constructed from the direct members of the group which are Patient resources.", "items": { "type": "string" } } }, "type": "object", "id": "GoogleCloudDiscoveryengineV1alphaAddPatientFilterRequest" }, "GoogleCloudDiscoveryengineV1alphaPurgeDocumentsResponse": { "type": "object", "properties": { "purgeSample": { "items": { "type": "string" }, "type": "array", "description": "A sample of document names that will be deleted. Only populated if `force` is set to false. A max of 100 names will be returned and the names are chosen at random." }, "purgeCount": { "description": "The total count of documents purged as a result of the operation.", "type": "string", "format": "int64" } }, "id": "GoogleCloudDiscoveryengineV1alphaPurgeDocumentsResponse", "description": "Response message for DocumentService.PurgeDocuments method. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field." }, "GoogleCloudDiscoveryengineV1WidgetConfigHomepageSettingShortcut": { "properties": { "destinationUri": { "description": "Optional. Destination URL of shortcut.", "type": "string" }, "title": { "type": "string", "description": "Optional. Title of the shortcut." }, "icon": { "$ref": "GoogleCloudDiscoveryengineV1WidgetConfigImage", "description": "Optional. Icon URL of shortcut." } }, "type": "object", "id": "GoogleCloudDiscoveryengineV1WidgetConfigHomepageSettingShortcut", "description": "Describes an entity of shortcut (aka pinned content) on the homepage. The home page will render these shortcuts in the same order as what the API returns. If a customer wants to reorder or remove a shortcut, the UI should always provide the new full list of shortcuts." }, "GoogleCloudDiscoveryengineV1LicenseConfig": { "description": "Information about users' licenses.", "properties": { "autoRenew": { "type": "boolean", "description": "Optional. Whether the license config should be auto renewed when it reaches the end date." }, "subscriptionTier": { "type": "string", "description": "Required. Subscription tier information for the license config.", "enum": [ "SUBSCRIPTION_TIER_UNSPECIFIED", "SUBSCRIPTION_TIER_SEARCH", "SUBSCRIPTION_TIER_SEARCH_AND_ASSISTANT", "SUBSCRIPTION_TIER_NOTEBOOK_LM", "SUBSCRIPTION_TIER_FRONTLINE_WORKER", "SUBSCRIPTION_TIER_AGENTSPACE_STARTER", "SUBSCRIPTION_TIER_AGENTSPACE_BUSINESS", "SUBSCRIPTION_TIER_ENTERPRISE", "SUBSCRIPTION_TIER_ENTERPRISE_EMERGING", "SUBSCRIPTION_TIER_EDU", "SUBSCRIPTION_TIER_EDU_PRO", "SUBSCRIPTION_TIER_EDU_EMERGING", "SUBSCRIPTION_TIER_EDU_PRO_EMERGING", "SUBSCRIPTION_TIER_FRONTLINE_STARTER", "SUBSCRIPTION_TIER_CONSUMPTION_ONLY", "SUBSCRIPTION_TIER_EDU_GOV_EMERGING" ], "enumDescriptions": [ "Default value.", "Search tier. Search tier can access Vertex AI Search features and NotebookLM features.", "Gemini Enterprise Plus tier.", "NotebookLM tier. NotebookLM is a subscription tier can only access NotebookLM features.", "Gemini Frontline worker tier.", "Gemini Business Starter tier.", "Gemini Business tier.", "Gemini Enterprise Standard tier.", "Gemini Enterprise Standard tier for emerging markets.", "Gemini Enterprise EDU tier.", "Gemini Enterprise EDU Pro tier.", "Gemini Enterprise EDU tier for emerging market only.", "Gemini Enterprise EDU Pro tier for emerging market.", "Gemini Frontline Starter tier.", "Represents the Gemini Enterprise Consumption-only tier: $0 subscription billed purely on usage (PAYG).", "Gemini Enterprise EDU tier for government in emerging markets." ] }, "name": { "description": "Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project}/locations/{location}/licenseConfigs/{license_config}`", "type": "string" }, "freeTrial": { "type": "boolean", "description": "Optional. Whether the license config is for free trial." }, "geminiBundle": { "description": "Output only. Whether the license config is for Gemini bundle.", "type": "boolean", "readOnly": true }, "subscriptionTerm": { "type": "string", "description": "Required. Subscription term.", "enum": [ "SUBSCRIPTION_TERM_UNSPECIFIED", "SUBSCRIPTION_TERM_ONE_MONTH", "SUBSCRIPTION_TERM_ONE_YEAR", "SUBSCRIPTION_TERM_THREE_YEARS", "SUBSCRIPTION_TERM_CUSTOM" ], "enumDescriptions": [ "Default value, do not use.", "1 month.", "1 year.", "3 years.", "Custom term. Must set the end_date." ] }, "startDate": { "$ref": "GoogleTypeDate", "description": "Required. The start date." }, "lastUserUpdateTime": { "type": "string", "format": "google-datetime", "description": "Optional. Timestamp of the most recent user-initiated update (seat count change or subscription term change). Unlike `update_time`, this field is only stamped when a customer explicitly updates the license (e.g. via the UI), and is not touched by system-driven writes (subscription pipeline, BALC propagation, etc.)." }, "state": { "enumDescriptions": [ "Default value. The license config does not exist.", "The license config is effective and being used.", "The license config has expired.", "The license config has not started yet, and its start date is in the future.", "This is when a sub license config has returned all its seats back to BillingAccountLicenseConfig that it belongs to. Similar to EXPIRED.", "The license config is terminated earlier than the expiration date and it is deactivating. The customer will still have access in this state. It will be converted to EXPIRED after the deactivating period ends (14 days) or when the end date is reached, whichever comes first." ], "enum": [ "STATE_UNSPECIFIED", "ACTIVE", "EXPIRED", "NOT_STARTED", "WITHDRAWN", "DEACTIVATING" ], "description": "Output only. The state of the license config.", "type": "string", "readOnly": true }, "endDate": { "description": "Optional. The planed end date.", "$ref": "GoogleTypeDate" }, "licenseCount": { "type": "string", "description": "Required. Number of licenses purchased.", "format": "int64" }, "earlyTerminationDate": { "$ref": "GoogleTypeDate", "description": "Output only. The date when the subscription is terminated earlier than the expiration date.", "readOnly": true }, "earlyTerminated": { "type": "boolean", "readOnly": true, "description": "Output only. Indication of whether the subscription is terminated earlier than the expiration date. This is usually terminated by pipeline once the subscription gets terminated from subsv3." } }, "id": "GoogleCloudDiscoveryengineV1LicenseConfig", "type": "object" }, "GoogleApiDistributionBucketOptionsLinear": { "properties": { "numFiniteBuckets": { "type": "integer", "format": "int32", "description": "Must be greater than 0." }, "width": { "format": "double", "type": "number", "description": "Must be greater than 0." }, "offset": { "type": "number", "format": "double", "description": "Lower bound of the first bucket." } }, "id": "GoogleApiDistributionBucketOptionsLinear", "description": "Specifies a linear sequence of buckets that all have the same width (except overflow and underflow). Each bucket represents a constant absolute uncertainty on the specific value in the bucket. There are `num_finite_buckets + 2` (= N) buckets. Bucket `i` has the following boundaries: Upper bound (0 \u003c= i \u003c N-1): offset + (width * i). Lower bound (1 \u003c= i \u003c N): offset + (width * (i - 1)).", "type": "object" }, "GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig": { "description": "Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and LLM responses.", "type": "object", "id": "GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig", "properties": { "responseTemplate": { "description": "Optional. The resource name of the Model Armor Template for sanitizing LLM responses. Format: projects/{project}/locations/{location}/templates/{template_id} If not specified, no sanitization will be applied to the LLM response.", "type": "string" }, "userPromptTemplate": { "description": "Optional. The resource name of the Model Armor Template for sanitizing user prompts. Format: projects/{project}/locations/{location}/templates/{template_id} If not specified, no sanitization will be applied to the user prompt.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1betaSessionConfig": { "type": "object", "description": "Configuration for the session.", "id": "GoogleCloudDiscoveryengineV1betaSessionConfig", "properties": { "sessionTtl": { "description": "Optional. The TTL for the session. If unset, the default value is 60 days.", "$ref": "GoogleCloudDiscoveryengineV1betaSessionConfigSessionTtl" }, "sessionManagementPolicy": { "description": "Optional. Session management policy that defines who will manage the session.", "enumDescriptions": [ "Default value.", "The session will be managed by the customer.", "Sessions multi-tenancy will be controlled by Google using 1P or 3P identity providers." ], "enum": [ "SESSION_MANAGEMENT_POLICY_UNSPECIFIED", "NOT_MANAGED", "VERTEX_AI_MANAGED" ], "type": "string" } } }, "GoogleCloudDiscoveryengineV1alphaIdentityScheduleConfig": { "id": "GoogleCloudDiscoveryengineV1alphaIdentityScheduleConfig", "type": "object", "properties": { "nextSyncTime": { "$ref": "GoogleTypeDateTime", "description": "Optional. The UTC time when the next data sync is expected to start for the Data Connector. Customers are only able to specify the hour and minute to schedule the data sync. This is utilized when the data connector has a refresh interval greater than 1 day." }, "refreshInterval": { "description": "Optional. The refresh interval to sync the Access Control List information for the documents ingested by this connector. If not set, the access control list will be refreshed at the default interval of 30 minutes. The identity refresh interval can be at least 30 minutes and at most 7 days.", "type": "string", "format": "google-duration" } }, "description": "The configuration for the identity data synchronization runs." }, "GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReason": { "id": "GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReason", "properties": { "quotaFailure": { "description": "Failed due to insufficient quota.", "$ref": "GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure" } }, "description": "Site search indexing failure reasons.", "type": "object" }, "GoogleCloudDiscoveryengineV1CreateTargetSiteMetadata": { "description": "Metadata related to the progress of the SiteSearchEngineService.CreateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", "type": "object", "properties": { "updateTime": { "format": "google-datetime", "description": "Operation last update time. If the operation is done, this is also the finish time.", "type": "string" }, "createTime": { "type": "string", "format": "google-datetime", "description": "Operation create time." } }, "id": "GoogleCloudDiscoveryengineV1CreateTargetSiteMetadata" }, "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequest": { "description": "Request message for CompletionService.AdvancedCompleteQuery method. .", "properties": { "suggestionTypeSpecs": { "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequestSuggestionTypeSpec" }, "description": "Optional. Specification of each suggestion type." }, "experimentIds": { "description": "Optional. Experiment ids for this request.", "type": "array", "items": { "type": "string" } }, "includeTailSuggestions": { "description": "Indicates if tail suggestions should be returned if there are no suggestions that match the full query. Even if set to true, if there are suggestions that match the full query, those are returned and no tail suggestions are returned.", "type": "boolean" }, "boostSpec": { "description": "Optional. Specification to boost suggestions matching the condition.", "$ref": "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequestBoostSpec" }, "queryModel": { "description": "Specifies the autocomplete query model, which only applies to the QUERY SuggestionType. This overrides any model specified in the Configuration \u003e Autocomplete section of the Cloud console. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores.", "type": "string" }, "suggestionTypes": { "type": "array", "description": "Optional. Suggestion types to return. If empty or unspecified, query suggestions are returned. Only one suggestion type is supported at the moment.", "items": { "type": "string", "enumDescriptions": [ "Default value.", "Returns query suggestions.", "Returns people suggestions.", "Returns content suggestions.", "Returns recent search suggestions.", "Returns Google Workspace suggestions." ], "enum": [ "SUGGESTION_TYPE_UNSPECIFIED", "QUERY", "PEOPLE", "CONTENT", "RECENT_SEARCH", "GOOGLE_WORKSPACE" ] } }, "userPseudoId": { "type": "string", "description": "Optional. 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`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128" }, "userInfo": { "description": "Optional. Information about the end user. This should be the same identifier information as UserEvent.user_info and SearchRequest.user_info.", "$ref": "GoogleCloudDiscoveryengineV1UserInfo" }, "query": { "type": "string", "description": "Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters. The query can not be empty for most of the suggestion types. If it is empty, an `INVALID_ARGUMENT` error is returned. The exception is when the suggestion_types contains only the type `RECENT_SEARCH`, the query can be an empty string. The is called \"zero prefix\" feature, which returns user's recently searched queries given the empty query." } }, "id": "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequest", "type": "object" }, "GoogleCloudDiscoveryengineV1StreamAssistRequestToolsSpecWebGroundingSpec": { "type": "object", "id": "GoogleCloudDiscoveryengineV1StreamAssistRequestToolsSpecWebGroundingSpec", "properties": {}, "description": "Specification of the web grounding tool." }, "GoogleCloudDiscoveryengineV1alphaControlSynonymsAction": { "properties": { "synonyms": { "description": "Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is thrown.", "items": { "type": "string" }, "type": "array" } }, "description": "Creates a set of terms that will act as synonyms of one another. Example: \"happy\" will also be considered as \"glad\", \"glad\" will also be considered as \"happy\".", "type": "object", "id": "GoogleCloudDiscoveryengineV1alphaControlSynonymsAction" }, "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequestBoostSpecConditionBoostSpec": { "id": "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequestBoostSpecConditionBoostSpec", "type": "object", "properties": { "boost": { "description": "Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the suggestions a big promotion. However, it does not necessarily mean that the top result will be a boosted suggestion. Setting to -1.0 gives the suggestions a big demotion. However, other suggestions that are relevant might still be shown. Setting to 0.0 means no boost applied. The boosting condition is ignored.", "type": "number", "format": "float" }, "condition": { "description": "An expression which specifies a boost condition. The syntax is the same as [filter expression syntax](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata#filter-expression-syntax). Currently, the only supported condition is a list of BCP-47 lang codes. Example: * To boost suggestions in languages `en` or `fr`: `(lang_code: ANY(\"en\", \"fr\"))`", "type": "string" } }, "description": "Boost applies to suggestions which match a condition." }, "GoogleCloudDiscoveryengineV1alphaSearchRequestDisplaySpec": { "type": "object", "description": "Specifies features for display, like match highlighting.", "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestDisplaySpec", "properties": { "matchHighlightingCondition": { "description": "The condition under which match highlighting should occur.", "type": "string", "enum": [ "MATCH_HIGHLIGHTING_CONDITION_UNSPECIFIED", "MATCH_HIGHLIGHTING_DISABLED", "MATCH_HIGHLIGHTING_ENABLED" ], "enumDescriptions": [ "Server behavior is the same as `MATCH_HIGHLIGHTING_DISABLED`.", "Disables match highlighting on all documents.", "Enables match highlighting on all documents." ] } } }, "GoogleCloudDiscoveryengineV1alphaAlertPolicyConfigAlertEnrollment": { "id": "GoogleCloudDiscoveryengineV1alphaAlertPolicyConfigAlertEnrollment", "properties": { "enrollState": { "enumDescriptions": [ "Default value. Used for customers who have not responded to the alert policy.", "Customer is enrolled in this policy.", "Customer declined this policy." ], "description": "Required. The enrollment status of a customer.", "enum": [ "ENROLL_STATES_UNSPECIFIED", "ENROLLED", "DECLINED" ], "type": "string" }, "alertId": { "type": "string", "description": "Immutable. The id of an alert." } }, "type": "object", "description": "The alert enrollment status." }, "GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfigDataProtectionPolicy": { "properties": { "sensitiveDataProtectionPolicy": { "description": "Optional. The sensitive data protection policy.", "$ref": "GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfigDataProtectionPolicySensitiveDataProtectionPolicy" } }, "type": "object", "description": "Data protection policy config for NotebookLM.", "id": "GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfigDataProtectionPolicy" }, "GoogleCloudDiscoveryengineV1WidgetConfigUiSettingsGenerativeAnswerConfig": { "properties": { "ignoreLowRelevantContent": { "description": "Optional. Specifies whether to filter out queries that are not relevant to the content.", "type": "boolean" }, "modelVersion": { "type": "string", "description": "The model version used to generate the answer." }, "languageCode": { "description": "Language code for Summary. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is an experimental feature.", "type": "string" }, "resultCount": { "type": "integer", "description": "The number of top results to generate the answer from. Up to 10.", "format": "int32" }, "modelPromptPreamble": { "description": "Text at the beginning of the prompt that instructs the model that generates the answer.", "type": "string" }, "ignoreAdversarialQuery": { "type": "boolean", "description": "Optional. Specifies whether to filter out queries that are adversarial." }, "disableRelatedQuestions": { "description": "Whether generated answer contains suggested related questions.", "type": "boolean" }, "imageSource": { "enumDescriptions": [ "Unspecified image source (multimodal feature is disabled by default)", "Behavior when service determines the pick from all available sources.", "Include image from corpus in the answer.", "Triggers figure generation in the answer." ], "type": "string", "enum": [ "IMAGE_SOURCE_UNSPECIFIED", "ALL_AVAILABLE_SOURCES", "CORPUS_IMAGE_ONLY", "FIGURE_GENERATION_ONLY" ], "description": "Optional. Source of image returned in the answer." }, "maxRephraseSteps": { "type": "integer", "description": "Max rephrase steps. The max number is 5 steps. If not set or set to \u003c 1, it will be set to 1 by default.", "format": "int32" }, "ignoreNonAnswerSeekingQuery": { "type": "boolean", "description": "Optional. Specifies whether to filter out queries that are not answer-seeking. The default value is `false`. No answer is returned if the search query is classified as a non-answer seeking query. If this field is set to `true`, we skip generating answers for non-answer seeking queries and return fallback messages instead." } }, "id": "GoogleCloudDiscoveryengineV1WidgetConfigUiSettingsGenerativeAnswerConfig", "type": "object", "description": "Describes configuration for generative answer." }, "GoogleCloudDiscoveryengineV1betaEngineCommonConfig": { "properties": { "companyName": { "description": "The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features.", "type": "string" } }, "description": "Common configurations for an Engine.", "type": "object", "id": "GoogleCloudDiscoveryengineV1betaEngineCommonConfig" }, "A2aV1PushNotificationConfig": { "type": "object", "id": "A2aV1PushNotificationConfig", "properties": { "url": { "description": "Url to send the notification too", "type": "string" }, "token": { "description": "Token unique for this task/session", "type": "string" }, "id": { "type": "string", "description": "A unique identifier (e.g. UUID) for this push notification." }, "authentication": { "$ref": "A2aV1AuthenticationInfo", "description": "Information about the authentication to sent with the notification" } }, "description": "Configuration for setting up push notifications for task updates." }, "GoogleCloudDiscoveryengineV1alphaEngine": { "id": "GoogleCloudDiscoveryengineV1alphaEngine", "type": "object", "description": "Metadata that describes the training and serving parameters of an Engine.", "properties": { "recommendationMetadata": { "readOnly": true, "$ref": "GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata", "description": "Output only. Additional information of a recommendation engine. Only applicable if solution_type is SOLUTION_TYPE_RECOMMENDATION." }, "displayName": { "description": "Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.", "type": "string" }, "mediaRecommendationEngineConfig": { "description": "Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical.", "$ref": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig" }, "similarDocumentsConfig": { "description": "Additional config specs for a `similar-items` engine.", "$ref": "GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig" }, "createTime": { "type": "string", "format": "google-datetime", "readOnly": true, "description": "Output only. Timestamp the Recommendation Engine was created at." }, "dataStoreIds": { "items": { "type": "string" }, "description": "Optional. The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations.", "type": "array" }, "procurementContactEmails": { "items": { "type": "string" }, "description": "Optional. The emails of the procurement contacts.", "type": "array" }, "cmekConfig": { "readOnly": true, "description": "Output only. CMEK-related information for the Engine.", "$ref": "GoogleCloudDiscoveryengineV1alphaCmekConfig" }, "observabilityConfig": { "description": "Optional. Observability config for the engine.", "$ref": "GoogleCloudDiscoveryengineV1alphaObservabilityConfig" }, "appType": { "description": "Optional. Immutable. This the application type which this engine resource represents. NOTE: this is a new concept independ of existing industry vertical or solution type.", "enumDescriptions": [ "All non specified apps.", "App type for intranet search and Agentspace." ], "type": "string", "enum": [ "APP_TYPE_UNSPECIFIED", "APP_TYPE_INTRANET" ] }, "name": { "description": "Immutable. Identifier. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.", "type": "string" }, "disableAnalytics": { "description": "Optional. Whether to disable analytics for searches performed on this engine.", "type": "boolean" }, "commonConfig": { "description": "Common config spec that specifies the metadata of the engine.", "$ref": "GoogleCloudDiscoveryengineV1alphaEngineCommonConfig" }, "configurableBillingApproach": { "enumDescriptions": [ "Default value. For Spark and non-Spark non-configurable billing approach. General pricing model.", "The billing approach follows configurations specified by customer." ], "type": "string", "enum": [ "CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED", "CONFIGURABLE_BILLING_APPROACH_ENABLED" ], "description": "Optional. Configuration for configurable billing approach." }, "knowledgeGraphConfig": { "description": "Optional. Configurations for the Knowledge Graph. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.", "$ref": "GoogleCloudDiscoveryengineV1alphaEngineKnowledgeGraphConfig" }, "solutionType": { "type": "string", "enum": [ "SOLUTION_TYPE_UNSPECIFIED", "SOLUTION_TYPE_RECOMMENDATION", "SOLUTION_TYPE_SEARCH", "SOLUTION_TYPE_CHAT", "SOLUTION_TYPE_GENERATIVE_CHAT", "SOLUTION_TYPE_AI_MODE" ], "description": "Required. The solutions of the engine.", "enumDescriptions": [ "Default value.", "Used for Recommendations AI.", "Used for Discovery Search.", "Used for use cases related to the Generative AI agent.", "Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution.", "Used for AI Mode." ] }, "features": { "additionalProperties": { "type": "string", "enumDescriptions": [ "The feature state is unspecified.", "The feature is turned on to be accessible.", "The feature is turned off to be inaccessible." ], "enum": [ "FEATURE_STATE_UNSPECIFIED", "FEATURE_STATE_ON", "FEATURE_STATE_OFF" ] }, "type": "object", "description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `speech-to-text` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `canvas-app-builder` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications`" }, "sessionConfig": { "description": "Optional. Non-empty default. Session config for the engine.", "$ref": "GoogleCloudDiscoveryengineV1alphaSessionConfig" }, "chatEngineMetadata": { "$ref": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadata", "readOnly": true, "description": "Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT." }, "agentGatewaySetting": { "$ref": "GoogleCloudDiscoveryengineV1alphaAgentGatewaySetting", "description": "Optional. The agent gateway setting for the engine." }, "connectorTenantInfo": { "description": "Optional. Maps a connector ID (e.g., \"hybrid-github\", \"shopify\") to tenant-specific information required for that connector. The structure of the tenant information string is connector-dependent.", "additionalProperties": { "type": "string" }, "type": "object" }, "associatedAgentRegistry": { "readOnly": true, "description": "Output only. The Agent registry containing the agents, MCP servers and tools associated with this engine. Derived server-side from the linked Agent Gateway's registry.", "type": "string" }, "modelConfigs": { "type": "object", "description": "Optional. Maps a model name to its specific configuration for this engine. This allows admin users to turn on/off individual models. This only stores models whose states are overridden by the admin. When the state is unspecified, or model_configs is empty for this model, the system will decide if this model should be available or not based on the default configuration. For example, a preview model should be disabled by default if the admin has not chosen to enable it.", "additionalProperties": { "enumDescriptions": [ "The model state is unspecified.", "The model is enabled by admin.", "The model is disabled by admin." ], "enum": [ "MODEL_STATE_UNSPECIFIED", "MODEL_ENABLED", "MODEL_DISABLED" ], "type": "string" } }, "searchEngineConfig": { "description": "Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.", "$ref": "GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig" }, "industryVertical": { "enumDescriptions": [ "Value used when unset.", "The generic vertical for documents that are not specific to any industry vertical.", "The media industry vertical.", "The healthcare FHIR vertical." ], "description": "Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine.", "enum": [ "INDUSTRY_VERTICAL_UNSPECIFIED", "GENERIC", "MEDIA", "HEALTHCARE_FHIR" ], "type": "string" }, "marketplaceAgentVisibility": { "enum": [ "MARKETPLACE_AGENT_VISIBILITY_UNSPECIFIED", "SHOW_AVAILABLE_AGENTS_ONLY", "SHOW_AGENTS_ALREADY_INTEGRATED", "SHOW_AGENTS_ALREADY_PURCHASED", "SHOW_ALL_AGENTS" ], "description": "Optional. The visibility of marketplace agents in the agent gallery.", "type": "string", "enumDescriptions": [ "Defaults to `MARKETPLACE_AGENT_VISIBILITY_UNSPECIFIED`.", "Only agents that are currently available for use by the user are visible.", "Show marketplace agents that the user does not yet have access to but are integrated into the engine. This level also includes all agents visible with `SHOW_AVAILABLE_AGENTS_ONLY`.", "Show all agents visible with `SHOW_AGENTS_ALREADY_INTEGRATED`, plus agents that have already been purchased by the project/organization, even if they are not currently integrated into the engine.", "All agents in the marketplace are visible, regardless of access or purchase status. This level encompasses all agents shown in the previous levels." ] }, "chatEngineConfig": { "$ref": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig", "description": "Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT." }, "updateTime": { "type": "string", "description": "Output only. Timestamp the Recommendation Engine was last updated.", "readOnly": true, "format": "google-datetime" } } }, "GoogleCloudDiscoveryengineV1alphaAnswerBlobAttachmentBlob": { "id": "GoogleCloudDiscoveryengineV1alphaAnswerBlobAttachmentBlob", "type": "object", "properties": { "mimeType": { "description": "Output only. The media type (MIME type) of the generated or retrieved data.", "type": "string", "readOnly": true }, "data": { "readOnly": true, "description": "Output only. Raw bytes.", "type": "string", "format": "byte" } }, "description": "The media type and data of the blob." }, "GoogleCloudDiscoveryengineV1CheckGroundingSpec": { "id": "GoogleCloudDiscoveryengineV1CheckGroundingSpec", "description": "Specification for the grounding check.", "properties": { "enableClaimLevelScore": { "description": "The control flag that enables claim-level grounding score in the response.", "type": "boolean" }, "citationThreshold": { "type": "number", "description": "The threshold (in [0,1]) used for determining whether a fact must be cited for a claim in the answer candidate. Choosing a higher threshold will lead to fewer but very strong citations, while choosing a lower threshold may lead to more but somewhat weaker citations. If unset, the threshold will default to 0.6.", "format": "double" } }, "type": "object" }, "GoogleCloudDiscoveryengineV1betaPurgeDocumentsResponse": { "properties": { "purgeCount": { "format": "int64", "description": "The total count of documents purged as a result of the operation.", "type": "string" }, "purgeSample": { "type": "array", "description": "A sample of document names that will be deleted. Only populated if `force` is set to false. A max of 100 names will be returned and the names are chosen at random.", "items": { "type": "string" } } }, "id": "GoogleCloudDiscoveryengineV1betaPurgeDocumentsResponse", "description": "Response message for DocumentService.PurgeDocuments method. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.", "type": "object" }, "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig": { "description": "The OCR parsing configurations for documents.", "properties": { "useNativeText": { "description": "If true, will use native text instead of OCR text on pages containing native text.", "type": "boolean" }, "enhancedDocumentElements": { "type": "array", "items": { "type": "string" }, "deprecated": true, "description": "[DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`." } }, "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig", "type": "object" }, "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo": { "type": "object", "description": "Snippet information.", "id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo", "properties": { "snippet": { "description": "Snippet content.", "type": "string" }, "snippetStatus": { "type": "string", "description": "Status of the snippet defined by the search team." } } }, "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResult": { "id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResult", "type": "object", "properties": { "structData": { "description": "Data representation. The structured JSON data for the document. It's populated from the struct data from the Document, or the Chunk in search result.", "additionalProperties": { "type": "any", "description": "Properties of the object." }, "type": "object" }, "title": { "description": "Title.", "type": "string" }, "uri": { "description": "URI for the document.", "type": "string" }, "chunkInfo": { "type": "array", "description": "If citation_type is CHUNK_LEVEL_CITATION and chunk mode is on, populate chunk info.", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultChunkInfo" } }, "document": { "type": "string", "description": "Document resource name." }, "snippetInfo": { "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo" }, "description": "If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets." } } }, "GoogleCloudDiscoveryengineV1SearchRequestImageQuery": { "description": "Specifies the image query input.", "properties": { "imageBytes": { "description": "Base64 encoded image bytes. Supported image formats: JPEG, PNG, and BMP.", "type": "string" } }, "id": "GoogleCloudDiscoveryengineV1SearchRequestImageQuery", "type": "object" }, "GoogleCloudDiscoveryengineV1DataStoreFederatedSearchConfigAlloyDbConfigAlloyDbAiNaturalLanguageConfig": { "description": "Configuration for AlloyDB AI Natural Language.", "id": "GoogleCloudDiscoveryengineV1DataStoreFederatedSearchConfigAlloyDbConfigAlloyDbAiNaturalLanguageConfig", "properties": { "nlConfigId": { "type": "string", "description": "Optional. AlloyDb AI NL config id, i.e. the value that was used for calling `SELECT alloydb_ai_nl.g_create_configuration(...)`. Can be empty." } }, "type": "object" }, "GoogleCloudDiscoveryengineV1betaDedicatedCrawlRateTimeSeries": { "description": "The historical dedicated crawl rate timeseries data, used for monitoring. Dedicated crawl is used by Vertex AI to crawl the user's website when dedicate crawl is set.", "type": "object", "id": "GoogleCloudDiscoveryengineV1betaDedicatedCrawlRateTimeSeries", "properties": { "userTriggeredCrawlErrorRate": { "$ref": "GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries", "description": "Vertex AI's error rate time series of user triggered dedicated crawl." }, "autoRefreshCrawlErrorRate": { "description": "Vertex AI's error rate time series of auto-refresh dedicated crawl.", "$ref": "GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries" }, "autoRefreshCrawlRate": { "$ref": "GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries", "description": "Vertex AI's dedicated crawl rate time series of auto-refresh, which is the crawl rate of Google-CloudVertexBot when dedicate crawl is set, and the crawl rate is for best effort use cases like refreshing urls periodically." }, "userTriggeredCrawlRate": { "description": "Vertex AI's dedicated crawl rate time series of user triggered crawl, which is the crawl rate of Google-CloudVertexBot when dedicate crawl is set, and user triggered crawl rate is for deterministic use cases like crawling urls or sitemaps specified by users.", "$ref": "GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries" } } }, "GoogleCloudDiscoveryengineV1ImportUserEventsResponse": { "description": "Response of the ImportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.", "id": "GoogleCloudDiscoveryengineV1ImportUserEventsResponse", "type": "object", "properties": { "unjoinedEventsCount": { "description": "Count of user events imported, but with Document information not found in the existing Branch.", "type": "string", "format": "int64" }, "joinedEventsCount": { "description": "Count of user events imported with complete existing Documents.", "format": "int64", "type": "string" }, "errorConfig": { "description": "Echoes the destination for the complete errors if this field was set in the request.", "$ref": "GoogleCloudDiscoveryengineV1ImportErrorConfig" }, "errorSamples": { "type": "array", "items": { "$ref": "GoogleRpcStatus" }, "description": "A sample of errors encountered while processing the request." } } }, "GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfig": { "properties": { "dataProtectionPolicy": { "description": "Optional. Specifies the data protection policy for NotebookLM.", "$ref": "GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfigDataProtectionPolicy" }, "observabilityConfig": { "description": "Optional. Observability config for NotebookLM.", "$ref": "GoogleCloudDiscoveryengineV1betaObservabilityConfig" }, "modelArmorConfig": { "$ref": "GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig", "description": "Model Armor configuration to be used for sanitizing user prompts and LLM responses." }, "optOutNotebookSharing": { "description": "Optional. Whether to disable the notebook sharing feature for the project. Default to false if not specified.", "type": "boolean" } }, "type": "object", "id": "GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfig", "description": "Configuration for NotebookLM." }, "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecMultiModalSpec": { "description": "Multimodal specification: Will return an image from specified source. If multiple sources are specified, the pick is a quality based decision.", "properties": { "imageSource": { "type": "string", "enum": [ "IMAGE_SOURCE_UNSPECIFIED", "ALL_AVAILABLE_SOURCES", "CORPUS_IMAGE_ONLY", "FIGURE_GENERATION_ONLY" ], "description": "Optional. Source of image returned in the answer.", "enumDescriptions": [ "Unspecified image source (multimodal feature is disabled by default).", "Behavior when service determines the pick from all available sources.", "Includes image from corpus in the answer.", "Triggers figure generation in the answer." ] } }, "type": "object", "id": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecMultiModalSpec" }, "GoogleCloudDiscoveryengineV1alphaRemoveDedicatedCrawlRateResponse": { "description": "Response message for CrawlRateManagementService.RemoveDedicatedCrawlRate method. It simply returns the state of the response, and an error message if the state is FAILED.", "properties": { "state": { "enum": [ "STATE_UNSPECIFIED", "SUCCEEDED", "FAILED" ], "readOnly": true, "description": "Output only. The state of the response.", "type": "string", "enumDescriptions": [ "The state is unspecified.", "The state is successful.", "The state is failed." ] }, "error": { "$ref": "GoogleRpcStatus", "description": "Errors from service when handling the request." } }, "id": "GoogleCloudDiscoveryengineV1alphaRemoveDedicatedCrawlRateResponse", "type": "object" }, "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec": { "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec", "type": "object", "description": "Boost applies to documents which match a condition.", "properties": { "boostControlSpec": { "description": "Complex specification for custom ranking based on customer defined attribute value.", "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec" }, "boost": { "format": "float", "type": "number", "description": "Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored. Only one of the (condition, boost) combination or the boost_control_spec below are set. If both are set then the global boost is ignored and the more fine-grained boost_control_spec is applied." }, "condition": { "description": "An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost documents with document ID \"doc_1\" or \"doc_2\", and color \"Red\" or \"Blue\": `(document_id: ANY(\"doc_1\", \"doc_2\")) AND (color: ANY(\"Red\", \"Blue\"))`", "type": "string" } } }, "GoogleCloudDiscoveryengineV1DataConnectorRealtimeSyncConfigStreamingError": { "description": "Streaming error details.", "properties": { "error": { "$ref": "GoogleRpcStatus", "description": "Optional. Error details." }, "streamingErrorReason": { "description": "Optional. Streaming error.", "enum": [ "STREAMING_ERROR_REASON_UNSPECIFIED", "STREAMING_SETUP_ERROR", "STREAMING_SYNC_ERROR", "INGRESS_ENDPOINT_REQUIRED" ], "type": "string", "enumDescriptions": [ "Streaming error reason unspecified.", "Some error occurred while setting up resources for realtime sync.", "Some error was encountered while running realtime sync for the connector.", "Ingress endpoint is required when setting up realtime sync in private connectivity." ] } }, "type": "object", "id": "GoogleCloudDiscoveryengineV1DataConnectorRealtimeSyncConfigStreamingError" }, "GoogleCloudDiscoveryengineV1alphaCitationMetadata": { "type": "object", "id": "GoogleCloudDiscoveryengineV1alphaCitationMetadata", "description": "A collection of source attributions for a piece of content.", "properties": { "citations": { "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaCitation" }, "readOnly": true, "description": "Output only. List of citations.", "type": "array" } } }, "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigMostPopularFeatureConfig": { "id": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigMostPopularFeatureConfig", "properties": { "timeWindowDays": { "type": "string", "description": "The time window of which the engine is queried at training and prediction time. Positive integers only. The value translates to the last X days of events. Currently required for the `most-popular-items` engine.", "format": "int64" } }, "description": "Feature configurations that are required for creating a Most Popular engine.", "type": "object" }, "GoogleCloudDiscoveryengineV1Reply": { "type": "object", "id": "GoogleCloudDiscoveryengineV1Reply", "description": "Defines a reply message to user.", "properties": { "summary": { "$ref": "GoogleCloudDiscoveryengineV1SearchResponseSummary", "description": "Summary based on search results." } } }, "GoogleCloudDiscoveryengineV1betaTuneEngineResponse": { "id": "GoogleCloudDiscoveryengineV1betaTuneEngineResponse", "properties": {}, "type": "object", "description": "Response associated with a tune operation." }, "GoogleCloudDiscoveryengineV1betaIdpConfigExternalIdpConfig": { "id": "GoogleCloudDiscoveryengineV1betaIdpConfigExternalIdpConfig", "properties": { "workforcePoolName": { "type": "string", "description": "Workforce pool name. Example: \"locations/global/workforcePools/pool_id\"" } }, "description": "Third party IDP Config.", "type": "object" }, "GoogleCloudDiscoveryengineV1ImportErrorConfig": { "type": "object", "properties": { "gcsPrefix": { "type": "string", "description": "Cloud Storage prefix for import errors. This must be an empty, existing Cloud Storage directory. Import errors are written to sharded files in this directory, one per line, as a JSON-encoded `google.rpc.Status` message." } }, "description": "Configuration of destination for Import related errors.", "id": "GoogleCloudDiscoveryengineV1ImportErrorConfig" }, "GoogleCloudDiscoveryengineV1betaSearchRequestCrowdingSpec": { "description": "Specification for crowding. Crowding improves the diversity of search results by limiting the number of results that share the same field value. For example, crowding on the color field with a max_count of 3 and mode DROP_CROWDED_RESULTS will return at most 3 results with the same color across all pages.", "properties": { "maxCount": { "type": "integer", "format": "int32", "description": "The maximum number of documents to keep per value of the field. Once there are at least max_count previous results which contain the same value for the given field (according to the order specified in `order_by`), later results with the same value are \"crowded away\". If not specified, the default value is 1." }, "field": { "description": "The field to use for crowding. Documents can be crowded by a field in the Document object. Crowding field is case sensitive.", "type": "string" }, "mode": { "enumDescriptions": [ "Unspecified crowding mode. In this case, server behavior defaults to Mode.DROP_CROWDED_RESULTS.", "Drop crowded results.", "Demote crowded results to the later pages." ], "type": "string", "enum": [ "MODE_UNSPECIFIED", "DROP_CROWDED_RESULTS", "DEMOTE_CROWDED_RESULTS_TO_END" ], "description": "Mode to use for documents that are crowded away." } }, "type": "object", "id": "GoogleCloudDiscoveryengineV1betaSearchRequestCrowdingSpec" }, "GoogleMonitoringV3TimeSeries": { "type": "object", "description": "A collection of data points that describes the time-varying values of a metric. A time series is identified by a combination of a fully-specified monitored resource and a fully-specified metric. This type is used for both listing and creating time series.", "id": "GoogleMonitoringV3TimeSeries", "properties": { "description": { "type": "string", "description": "Input only. A detailed description of the time series that will be associated with the google.api.MetricDescriptor for the metric. Once set, this field cannot be changed through CreateTimeSeries." }, "resource": { "description": "The associated monitored resource. Custom metrics can use only certain monitored resource types in their time series data. For more information, see [Monitored resources for custom metrics](https://cloud.google.com/monitoring/custom-metrics/creating-metrics#custom-metric-resources).", "$ref": "GoogleApiMonitoredResource" }, "unit": { "description": "The units in which the metric value is reported. It is only applicable if the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The `unit` defines the representation of the stored metric values. This field can only be changed through CreateTimeSeries when it is empty.", "type": "string" }, "metricKind": { "type": "string", "enum": [ "METRIC_KIND_UNSPECIFIED", "GAUGE", "DELTA", "CUMULATIVE" ], "description": "The metric kind of the time series. When listing time series, this metric kind might be different from the metric kind of the associated metric if this time series is an alignment or reduction of other time series. When creating a time series, this field is optional. If present, it must be the same as the metric kind of the associated metric. If the associated metric's descriptor must be auto-created, then this field specifies the metric kind of the new descriptor and must be either `GAUGE` (the default) or `CUMULATIVE`.", "enumDescriptions": [ "Do not use this default value.", "An instantaneous measurement of a value.", "The change in a value during a time interval.", "A value accumulated over a time interval. Cumulative measurements in a time series should have the same start time and increasing end times, until an event resets the cumulative value to zero and sets a new start time for the following points." ] }, "metric": { "$ref": "GoogleApiMetric", "description": "The associated metric. A fully-specified metric used to identify the time series." }, "points": { "description": "The data points of this time series. When listing time series, points are returned in reverse time order. When creating a time series, this field must contain exactly one point and the point's type must be the same as the value type of the associated metric. If the associated metric's descriptor must be auto-created, then the value type of the descriptor is determined by the point's type, which must be `BOOL`, `INT64`, `DOUBLE`, or `DISTRIBUTION`.", "items": { "$ref": "GoogleMonitoringV3Point" }, "type": "array" }, "metadata": { "$ref": "GoogleApiMonitoredResourceMetadata", "description": "Output only. The associated monitored resource metadata. When reading a time series, this field will include metadata labels that are explicitly named in the reduction. When creating a time series, this field is ignored." }, "valueType": { "enum": [ "VALUE_TYPE_UNSPECIFIED", "BOOL", "INT64", "DOUBLE", "STRING", "DISTRIBUTION", "MONEY" ], "description": "The value type of the time series. When listing time series, this value type might be different from the value type of the associated metric if this time series is an alignment or reduction of other time series. When creating a time series, this field is optional. If present, it must be the same as the type of the data in the `points` field.", "type": "string", "enumDescriptions": [ "Do not use this default value.", "The value is a boolean. This value type can be used only if the metric kind is `GAUGE`.", "The value is a signed 64-bit integer.", "The value is a double precision floating point number.", "The value is a text string. This value type can be used only if the metric kind is `GAUGE`.", "The value is a `Distribution`.", "The value is money." ] } } }, "GoogleCloudDiscoveryengineV1BAPConfigToolspecOverride": { "id": "GoogleCloudDiscoveryengineV1BAPConfigToolspecOverride", "description": "Customer-facing view of the admin-curated toolspec for a BAP connection. Holds the (simplified) per-tool definitions surfaced to and editable by the admin in the Discovery Engine UI. Mirrors the shape of the backend `google.cloud.connectorexecution.v1.ToolspecOverride` message, but is intentionally kept as a separate public type so the Discovery Engine API surface can evolve independently of the fed-API surface (AIP-215). Handlers convert between the two via helpers in //cloud/ml/discoveryengine/external_service/v1main/data_connector_service/lib:bap_custom_tool_util.", "type": "object", "properties": { "baseVersion": { "type": "string", "description": "Required. Base toolspec version against which `tools` were authored. On Update, MUST match the server's current stable toolspec version for the connection; mismatch is rejected with a user-facing error directing the admin to re-download the latest tools first." }, "tools": { "description": "Required. Tool definitions (one Struct per tool) that the admin has customised on top of the base toolspec returned by the fed API. REQUIRED because it is the only user-editable field in the modify API; the request must carry at least one tool.", "type": "array", "items": { "type": "object", "additionalProperties": { "description": "Properties of the object.", "type": "any" } } } } }, "A2aV1PasswordOAuthFlow": { "properties": { "tokenUrl": { "type": "string", "description": "The token URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS." }, "refreshUrl": { "description": "The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS.", "type": "string" }, "scopes": { "description": "The available scopes for the OAuth2 security scheme. A map between the scope name and a short description for it. The map MAY be empty.", "additionalProperties": { "type": "string" }, "type": "object" } }, "type": "object", "id": "A2aV1PasswordOAuthFlow" }, "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig": { "description": "The OCR parsing configurations for documents.", "type": "object", "id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig", "properties": { "useNativeText": { "description": "If true, will use native text instead of OCR text on pages containing native text.", "type": "boolean" }, "enhancedDocumentElements": { "description": "[DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`.", "type": "array", "items": { "type": "string" }, "deprecated": true } } }, "GoogleCloudDiscoveryengineV1alphaContactDetails": { "description": "The contact info stored in resource level. If both project level and resource level is populated, the resource level contact info will override the project level contact info.", "properties": { "emailAddress": { "type": "string", "description": "Optional. The email address of the contact." } }, "id": "GoogleCloudDiscoveryengineV1alphaContactDetails", "type": "object" }, "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig": { "id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig", "description": "The layout parsing configurations for documents.", "type": "object", "properties": { "enableTableAnnotation": { "description": "Optional. If true, the LLM based annotation is added to the table during parsing.", "type": "boolean" }, "enableImageAnnotation": { "type": "boolean", "description": "Optional. If true, the LLM based annotation is added to the image during parsing." }, "excludeHtmlClasses": { "type": "array", "items": { "type": "string" }, "description": "Optional. List of HTML classes to exclude from the parsed content." }, "structuredContentTypes": { "description": "Optional. Contains the required structure types to extract from the document. Supported values: * `shareholder-structure`", "items": { "type": "string" }, "type": "array" }, "enableLlmLayoutParsing": { "type": "boolean", "description": "Optional. If true, the pdf layout will be refined using an LLM." }, "excludeHtmlElements": { "items": { "type": "string" }, "description": "Optional. List of HTML elements to exclude from the parsed content.", "type": "array" }, "enableGetProcessedDocument": { "type": "boolean", "description": "Optional. If true, the processed document will be made available for the GetProcessedDocument API." }, "excludeHtmlIds": { "description": "Optional. List of HTML ids to exclude from the parsed content.", "items": { "type": "string" }, "type": "array" } } }, "GoogleCloudDiscoveryengineV1AssistAnswerCustomerPolicyEnforcementResultPolicyEnforcementResult": { "properties": { "bannedPhraseEnforcementResult": { "$ref": "GoogleCloudDiscoveryengineV1AssistAnswerCustomerPolicyEnforcementResultBannedPhraseEnforcementResult", "description": "The policy enforcement result for the banned phrase policy." }, "modelArmorEnforcementResult": { "description": "The policy enforcement result for the Model Armor policy.", "$ref": "GoogleCloudDiscoveryengineV1AssistAnswerCustomerPolicyEnforcementResultModelArmorEnforcementResult" } }, "description": "Customer policy enforcement result for a single policy type.", "type": "object", "id": "GoogleCloudDiscoveryengineV1AssistAnswerCustomerPolicyEnforcementResultPolicyEnforcementResult" }, "GoogleCloudDiscoveryengineV1betaDeleteSitemapMetadata": { "id": "GoogleCloudDiscoveryengineV1betaDeleteSitemapMetadata", "description": "Metadata related to the progress of the SiteSearchEngineService.DeleteSitemap operation. This will be returned by the google.longrunning.Operation.metadata field.", "type": "object", "properties": { "createTime": { "type": "string", "format": "google-datetime", "description": "Operation create time." }, "updateTime": { "description": "Operation last update time. If the operation is done, this is also the finish time.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudDiscoveryengineV1ImportDocumentsResponse": { "properties": { "errorSamples": { "type": "array", "description": "A sample of errors encountered while processing the request.", "items": { "$ref": "GoogleRpcStatus" } }, "errorConfig": { "description": "Echoes the destination for the complete errors in the request if set.", "$ref": "GoogleCloudDiscoveryengineV1ImportErrorConfig" } }, "id": "GoogleCloudDiscoveryengineV1ImportDocumentsResponse", "type": "object", "description": "Response of the ImportDocumentsRequest. If the long running operation is done, then this message is returned by the google.longrunning.Operations.response field if the operation was successful." }, "GoogleCloudDiscoveryengineV1AgentGatewaySettingAgentGatewayReference": { "id": "GoogleCloudDiscoveryengineV1AgentGatewaySettingAgentGatewayReference", "type": "object", "properties": { "name": { "type": "string", "description": "Required. Immutable. The resource name of the agent gateway. Expected format: `projects/{project_number}/locations/{location}/agentGateways/{agent_gateway}`." } }, "description": "Reference to an Agent Gateway resource." }, "GoogleCloudDiscoveryengineV1SearchLinkPromotion": { "type": "object", "properties": { "document": { "type": "string", "description": "Optional. The Document the user wants to promote. For site search, leave unset and only populate uri. Can be set along with uri." }, "description": { "type": "string", "description": "Optional. The Promotion description. Maximum length: 200 characters." }, "title": { "type": "string", "description": "Required. The title of the promotion. Maximum length: 160 characters." }, "imageUri": { "description": "Optional. The promotion thumbnail image url.", "type": "string" }, "enabled": { "description": "Optional. The enabled promotion will be returned for any serving configs associated with the parent of the control this promotion is attached to. This flag is used for basic site search only.", "type": "boolean" }, "uri": { "description": "Optional. The URL for the page the user wants to promote. Must be set for site search. For other verticals, this is optional.", "type": "string" } }, "description": "Promotion proto includes uri and other helping information to display the promotion.", "id": "GoogleCloudDiscoveryengineV1SearchLinkPromotion" }, "GoogleCloudDiscoveryengineV1ChunkStructuredContent": { "id": "GoogleCloudDiscoveryengineV1ChunkStructuredContent", "description": "The structured content information.", "type": "object", "properties": { "structureType": { "enumDescriptions": [ "Default value.", "Shareholder structure.", "Signature structure.", "Checkbox structure." ], "enum": [ "STRUCTURE_TYPE_UNSPECIFIED", "SHAREHOLDER_STRUCTURE", "SIGNATURE_STRUCTURE", "CHECKBOX_STRUCTURE" ], "readOnly": true, "description": "Output only. The structure type of the structured content.", "type": "string" }, "content": { "type": "string", "readOnly": true, "description": "Output only. The content of the structured content." } } }, "GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateMetadata": { "type": "object", "id": "GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateMetadata", "description": "Metadata related to the progress of the CrawlRateManagementService.RemoveDedicatedCrawlRate operation. This will be returned by the google.longrunning.Operation.metadata field.", "properties": { "updateTime": { "format": "google-datetime", "description": "Operation last update time. If the operation is done, this is also the finish time.", "type": "string" }, "createTime": { "type": "string", "description": "Operation create time.", "format": "google-datetime" } } }, "GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigEngineFeaturesConfig": { "type": "object", "description": "More feature configs of the selected engine type.", "properties": { "mostPopularConfig": { "description": "Most popular engine feature config.", "$ref": "GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigMostPopularFeatureConfig" }, "recommendedForYouConfig": { "$ref": "GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig", "description": "Recommended for you engine feature config." } }, "id": "GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigEngineFeaturesConfig" }, "GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsRequestInlineSource": { "description": "The inline source for CompletionSuggestions.", "id": "GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsRequestInlineSource", "properties": { "suggestions": { "type": "array", "description": "Required. A list of all denylist entries to import. Max of 1000 items.", "items": { "$ref": "GoogleCloudDiscoveryengineV1CompletionSuggestion" } } }, "type": "object" }, "A2aV1OAuthFlows": { "id": "A2aV1OAuthFlows", "type": "object", "properties": { "implicit": { "$ref": "A2aV1ImplicitOAuthFlow" }, "password": { "$ref": "A2aV1PasswordOAuthFlow" }, "authorizationCode": { "$ref": "A2aV1AuthorizationCodeOAuthFlow" }, "clientCredentials": { "$ref": "A2aV1ClientCredentialsOAuthFlow" } } }, "GoogleCloudDiscoveryengineV1AnswerReferenceUnstructuredDocumentInfo": { "description": "Unstructured document information.", "properties": { "chunkContents": { "type": "array", "description": "List of cited chunk contents derived from document content.", "items": { "$ref": "GoogleCloudDiscoveryengineV1AnswerReferenceUnstructuredDocumentInfoChunkContent" } }, "uri": { "description": "URI for the document.", "type": "string" }, "title": { "description": "Title.", "type": "string" }, "document": { "type": "string", "description": "Document resource name." }, "structData": { "description": "The structured JSON metadata for the document. It is populated from the struct data from the Chunk in search result.", "additionalProperties": { "type": "any", "description": "Properties of the object." }, "type": "object" } }, "type": "object", "id": "GoogleCloudDiscoveryengineV1AnswerReferenceUnstructuredDocumentInfo" }, "GoogleCloudDiscoveryengineV1alphaDataConnectorFederatedConfig": { "description": "Any params and credentials used specifically for hybrid connectors supporting FEDERATED mode.", "properties": { "authParams": { "description": "Optional. Any authentication parameters specific to FEDERATED connectors.", "type": "object", "additionalProperties": { "description": "Properties of the object.", "type": "any" } }, "additionalParams": { "type": "object", "description": "Optional. Any additional parameters needed for FEDERATED.", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "jsonAuthParams": { "description": "Optional. Any authentication parameters specific to FEDERATED connectors in json string format.", "type": "string" } }, "id": "GoogleCloudDiscoveryengineV1alphaDataConnectorFederatedConfig", "type": "object" }, "GoogleCloudDiscoveryengineV1ListUserLicensesResponse": { "properties": { "userLicenses": { "description": "All the customer's UserLicenses.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1UserLicense" } }, "nextPageToken": { "type": "string", "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages." } }, "type": "object", "id": "GoogleCloudDiscoveryengineV1ListUserLicensesResponse", "description": "Response message for UserLicenseService.ListUserLicenses." }, "GoogleCloudDiscoveryengineV1DataStoreFederatedSearchConfig": { "id": "GoogleCloudDiscoveryengineV1DataStoreFederatedSearchConfig", "type": "object", "properties": { "thirdPartyOauthConfig": { "$ref": "GoogleCloudDiscoveryengineV1DataStoreFederatedSearchConfigThirdPartyOauthConfig", "description": "Third Party OAuth config. If set, this DataStore is connected to a third party application." }, "alloyDbConfig": { "$ref": "GoogleCloudDiscoveryengineV1DataStoreFederatedSearchConfigAlloyDbConfig", "description": "AlloyDB config. If set, this DataStore is connected to AlloyDB." }, "notebooklmConfig": { "$ref": "GoogleCloudDiscoveryengineV1DataStoreFederatedSearchConfigNotebooklmConfig", "description": "NotebookLM config. If set, this DataStore is connected to NotebookLM Enterprise." } }, "description": "Stores information for federated search." }, "GoogleCloudDiscoveryengineV1betaLanguageInfo": { "properties": { "languageCode": { "description": "The language code for the DataStore.", "type": "string" }, "normalizedLanguageCode": { "description": "Output only. This is the normalized form of language_code. E.g.: language_code of `en-GB`, `en_GB`, `en-UK` or `en-gb` will have normalized_language_code of `en-GB`.", "type": "string", "readOnly": true }, "region": { "type": "string", "description": "Output only. Region part of normalized_language_code, if present. E.g.: `en-US` -\u003e `US`, `zh-Hans-HK` -\u003e `HK`, `en` -\u003e ``.", "readOnly": true }, "language": { "type": "string", "readOnly": true, "description": "Output only. Language part of normalized_language_code. E.g.: `en-US` -\u003e `en`, `zh-Hans-HK` -\u003e `zh`, `en` -\u003e `en`." } }, "type": "object", "id": "GoogleCloudDiscoveryengineV1betaLanguageInfo", "description": "Language info for DataStore." }, "GoogleCloudDiscoveryengineV1AnswerQueryRequestSafetySpec": { "description": "Safety specification. There are two use cases: 1. when only safety_spec.enable is set, the BLOCK_LOW_AND_ABOVE threshold will be applied for all categories. 2. when safety_spec.enable is set and some safety_settings are set, only specified safety_settings are applied.", "properties": { "enable": { "description": "Enable the safety filtering on the answer response. It is false by default.", "type": "boolean" }, "safetySettings": { "description": "Optional. Safety settings. This settings are effective only when the safety_spec.enable is true.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1AnswerQueryRequestSafetySpecSafetySetting" } } }, "type": "object", "id": "GoogleCloudDiscoveryengineV1AnswerQueryRequestSafetySpec" }, "GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig": { "type": "object", "properties": { "contextEventType": { "type": "string", "description": "The type of event with which the engine is queried at prediction time. If set to `generic`, only `view-item`, `media-play`,and `media-complete` will be used as `context-event` in engine training. If set to `view-home-page`, `view-home-page` will also be used as `context-events` in addition to `view-item`, `media-play`, and `media-complete`. Currently supported for the `recommended-for-you` engine. Currently supported values: `view-home-page`, `generic`." } }, "id": "GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig", "description": "Additional feature configurations for creating a `recommended-for-you` engine." }, "GoogleCloudDiscoveryengineV1betaObtainCrawlRateResponse": { "description": "Response message for CrawlRateManagementService.ObtainCrawlRate method. The response contains organcic or dedicated crawl rate time series data for monitoring, depending on whether dedicated crawl rate is set.", "properties": { "dedicatedCrawlRateTimeSeries": { "description": "The historical dedicated crawl rate timeseries data, used for monitoring.", "$ref": "GoogleCloudDiscoveryengineV1betaDedicatedCrawlRateTimeSeries" }, "state": { "type": "string", "enumDescriptions": [ "The state is unspecified.", "The state is successful.", "The state is failed." ], "enum": [ "STATE_UNSPECIFIED", "SUCCEEDED", "FAILED" ], "readOnly": true, "description": "Output only. The state of the response." }, "organicCrawlRateTimeSeries": { "description": "The historical organic crawl rate timeseries data, used for monitoring.", "$ref": "GoogleCloudDiscoveryengineV1betaOrganicCrawlRateTimeSeries" }, "error": { "$ref": "GoogleRpcStatus", "description": "Errors from service when handling the request." } }, "id": "GoogleCloudDiscoveryengineV1betaObtainCrawlRateResponse", "type": "object" }, "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpec": { "description": "A specification for configuring a summary returned in a search response.", "id": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpec", "properties": { "ignoreAdversarialQuery": { "type": "boolean", "description": "Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No summary is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating summaries for adversarial queries and return fallback messages instead." }, "modelSpec": { "description": "If specified, the spec will be used to modify the model specification provided to the LLM.", "$ref": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpecModelSpec" }, "useSemanticChunks": { "description": "If true, answer will be generated from most relevant chunks from top search results. This feature will improve summary quality. Note that with this feature enabled, not all top search results will be referenced and included in the reference list, so the citation source index only points to the search results listed in the reference list.", "type": "boolean" }, "ignoreJailBreakingQuery": { "description": "Optional. Specifies whether to filter out jail-breaking queries. The default value is `false`. Google employs search-query classification to detect jail-breaking queries. No summary is returned if the search query is classified as a jail-breaking query. A user might add instructions to the query to change the tone, style, language, content of the answer, or ask the model to act as a different entity, e.g. \"Reply in the tone of a competing company's CEO\". If this field is set to `true`, we skip generating summaries for jail-breaking queries and return fallback messages instead.", "type": "boolean" }, "ignoreLowRelevantContent": { "type": "boolean", "description": "Specifies whether to filter out queries that have low relevance. The default value is `false`. If this field is set to `false`, all search results are used regardless of relevance to generate answers. If set to `true`, only queries with high relevance search results will generate answers." }, "modelPromptSpec": { "description": "If specified, the spec will be used to modify the prompt provided to the LLM.", "$ref": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpecModelPromptSpec" }, "summaryResultCount": { "format": "int32", "description": "The number of top results to generate the summary from. If the number of results returned is less than `summaryResultCount`, the summary is generated from all of the results. At most 10 results for documents mode, or 50 for chunks mode, can be used to generate a summary. The chunks mode is used when SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS.", "type": "integer" }, "languageCode": { "type": "string", "description": "Language code for Summary. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is an experimental feature." }, "ignoreNonSummarySeekingQuery": { "description": "Specifies whether to filter out queries that are not summary-seeking. The default value is `false`. Google employs search-query classification to detect summary-seeking queries. No summary is returned if the search query is classified as a non-summary seeking query. For example, `why is the sky blue` and `Who is the best soccer player in the world?` are summary-seeking queries, but `SFO airport` and `world cup 2026` are not. They are most likely navigational queries. If this field is set to `true`, we skip generating summaries for non-summary seeking queries and return fallback messages instead.", "type": "boolean" }, "includeCitations": { "type": "boolean", "description": "Specifies whether to include citations in the summary. The default value is `false`. When this field is set to `true`, summaries include in-line citation numbers. Example summary including citations: BigQuery is Google Cloud's fully managed and completely serverless enterprise data warehouse [1]. BigQuery supports all data types, works across clouds, and has built-in machine learning and business intelligence, all within a unified platform [2, 3]. The citation numbers refer to the returned search results and are 1-indexed. For example, [1] means that the sentence is attributed to the first search result. [2, 3] means that the sentence is attributed to both the second and third search results." } }, "type": "object" }, "GoogleCloudDiscoveryengineV1DataStore": { "id": "GoogleCloudDiscoveryengineV1DataStore", "properties": { "configurableBillingApproach": { "type": "string", "enum": [ "CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED", "CONFIGURABLE_SUBSCRIPTION_INDEXING_CORE", "CONFIGURABLE_CONSUMPTION_EMBEDDING" ], "description": "Optional. Configuration for configurable billing approach. See", "enumDescriptions": [ "Default value. For Spark and non-Spark non-configurable billing approach.", "Use the subscription base + overage billing for indexing core for non embedding storage.", "Use the consumption pay-as-you-go billing for embedding storage add-on." ] }, "documentProcessingConfig": { "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfig", "description": "Configuration for Document understanding and enrichment." }, "federatedSearchConfig": { "$ref": "GoogleCloudDiscoveryengineV1DataStoreFederatedSearchConfig", "description": "Optional. If set, this DataStore is a federated search DataStore." }, "configurableBillingApproachUpdateTime": { "description": "Output only. The timestamp when configurable_billing_approach was last updated.", "type": "string", "format": "google-datetime", "readOnly": true }, "servingConfigDataStore": { "$ref": "GoogleCloudDiscoveryengineV1DataStoreServingConfigDataStore", "description": "Optional. Stores serving config at DataStore level." }, "solutionTypes": { "type": "array", "items": { "enum": [ "SOLUTION_TYPE_UNSPECIFIED", "SOLUTION_TYPE_RECOMMENDATION", "SOLUTION_TYPE_SEARCH", "SOLUTION_TYPE_CHAT", "SOLUTION_TYPE_GENERATIVE_CHAT", "SOLUTION_TYPE_AI_MODE" ], "type": "string", "enumDescriptions": [ "Default value.", "Used for Recommendations AI.", "Used for Discovery Search.", "Used for use cases related to the Generative AI agent.", "Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution.", "Used for AI Mode." ] }, "description": "The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled." }, "workspaceConfig": { "$ref": "GoogleCloudDiscoveryengineV1WorkspaceConfig", "description": "Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE." }, "createTime": { "type": "string", "format": "google-datetime", "readOnly": true, "description": "Output only. Timestamp the DataStore was created at." }, "isInfobotFaqDataStore": { "description": "Optional. If set, this DataStore is an Infobot FAQ DataStore.", "type": "boolean" }, "startingSchema": { "description": "The start schema to use for this DataStore when provisioning it. If unset, a default vertical specialized schema will be used. This field is only used by CreateDataStore API, and will be ignored if used in other APIs. This field will be omitted from all API responses including CreateDataStore API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema).", "$ref": "GoogleCloudDiscoveryengineV1Schema" }, "cmekConfig": { "readOnly": true, "description": "Output only. CMEK-related information for the DataStore.", "$ref": "GoogleCloudDiscoveryengineV1CmekConfig" }, "contentConfig": { "description": "Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.", "enumDescriptions": [ "Default value.", "Only contains documents without any Document.content.", "Only contains documents with Document.content.", "The data store is used for public website search.", "The data store is used for workspace search. Details of workspace data store are specified in the WorkspaceConfig." ], "type": "string", "enum": [ "CONTENT_CONFIG_UNSPECIFIED", "NO_CONTENT", "CONTENT_REQUIRED", "PUBLIC_WEBSITE", "GOOGLE_WORKSPACE" ] }, "defaultSchemaId": { "type": "string", "description": "Output only. The id of the default Schema associated to this data store.", "readOnly": true }, "industryVertical": { "description": "Immutable. The industry vertical that the data store registers.", "enum": [ "INDUSTRY_VERTICAL_UNSPECIFIED", "GENERIC", "MEDIA", "HEALTHCARE_FHIR" ], "enumDescriptions": [ "Value used when unset.", "The generic vertical for documents that are not specific to any industry vertical.", "The media industry vertical.", "The healthcare FHIR vertical." ], "type": "string" }, "healthcareFhirConfig": { "$ref": "GoogleCloudDiscoveryengineV1HealthcareFhirConfig", "description": "Optional. Configuration for `HEALTHCARE_FHIR` vertical." }, "identityMappingStore": { "type": "string", "description": "Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`." }, "name": { "description": "Immutable. Identifier. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", "type": "string" }, "dataProtectionPolicy": { "description": "Optional. Specifies the data protection policy for the data store.", "$ref": "GoogleCloudDiscoveryengineV1DataProtectionPolicy" }, "kmsKeyName": { "description": "Input only. The KMS key to be used to protect this DataStore at creation time. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStore will be protected by the KMS key, as indicated in the cmek_config field.", "type": "string" }, "billingEstimation": { "readOnly": true, "$ref": "GoogleCloudDiscoveryengineV1DataStoreBillingEstimation", "description": "Output only. Data size estimation for billing." }, "naturalLanguageQueryUnderstandingConfig": { "$ref": "GoogleCloudDiscoveryengineV1NaturalLanguageQueryUnderstandingConfig", "description": "Optional. Configuration for Natural Language Query Understanding." }, "aclEnabled": { "description": "Immutable. Whether data in the DataStore has ACL information. If set to `true`, the source data must have ACL. ACL will be ingested when data is ingested by DocumentService.ImportDocuments methods. When ACL is enabled for the DataStore, Document can't be accessed by calling DocumentService.GetDocument or DocumentService.ListDocuments. Currently ACL is only supported in `GENERIC` industry vertical with non-`PUBLIC_WEBSITE` content config.", "type": "boolean" }, "displayName": { "type": "string", "description": "Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned." }, "advancedSiteSearchConfig": { "description": "Optional. Configuration for advanced site search.", "$ref": "GoogleCloudDiscoveryengineV1AdvancedSiteSearchConfig" } }, "description": "DataStore captures global settings and configs at the DataStore level.", "type": "object" }, "GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsResponse": { "id": "GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsResponse", "description": "Response of the CompletionService.ImportCompletionSuggestions method. If the long running operation is done, this message is returned by the google.longrunning.Operations.response field if the operation is successful.", "properties": { "errorSamples": { "type": "array", "items": { "$ref": "GoogleRpcStatus" }, "description": "A sample of errors encountered while processing the request." }, "errorConfig": { "$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", "description": "The desired location of errors incurred during the Import." } }, "type": "object" }, "GoogleCloudDiscoveryengineV1betaCreateTargetSiteMetadata": { "id": "GoogleCloudDiscoveryengineV1betaCreateTargetSiteMetadata", "properties": { "createTime": { "format": "google-datetime", "description": "Operation create time.", "type": "string" }, "updateTime": { "description": "Operation last update time. If the operation is done, this is also the finish time.", "format": "google-datetime", "type": "string" } }, "description": "Metadata related to the progress of the SiteSearchEngineService.CreateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", "type": "object" }, "GoogleCloudDiscoveryengineV1DataProtectionPolicySensitiveDataProtectionPolicy": { "properties": { "policy": { "description": "Optional. Specifies the resource name of the Sensitive Data Protection content policy.", "type": "string" } }, "id": "GoogleCloudDiscoveryengineV1DataProtectionPolicySensitiveDataProtectionPolicy", "description": "Specifies a Sensitive Data Protection (https://cloud.google.com/sensitive-data-protection/docs/sensitive-data-protection-overview) policy.", "type": "object" }, "GoogleCloudDiscoveryengineV1alphaAssistantContentCodeExecutionResult": { "description": "Result of executing ExecutableCode.", "properties": { "output": { "description": "Optional. Contains stdout when code execution is successful, stderr or other description otherwise.", "type": "string" }, "outcome": { "enum": [ "OUTCOME_UNSPECIFIED", "OUTCOME_OK", "OUTCOME_FAILED", "OUTCOME_DEADLINE_EXCEEDED" ], "type": "string", "description": "Required. Outcome of the code execution.", "enumDescriptions": [ "Unspecified status. This value should not be used.", "Code execution completed successfully.", "Code execution finished but with a failure. `stderr` should contain the reason.", "Code execution ran for too long, and was cancelled. There may or may not be a partial output present." ] } }, "type": "object", "id": "GoogleCloudDiscoveryengineV1alphaAssistantContentCodeExecutionResult" }, "GoogleCloudDiscoveryengineV1Document": { "properties": { "indexStatus": { "readOnly": true, "description": "Output only. The index status of the document. * If document is indexed successfully, the index_time field is populated. * Otherwise, if document is not indexed due to errors, the error_samples field is populated. * Otherwise, if document's index is in progress, the pending_message field is populated.", "$ref": "GoogleCloudDiscoveryengineV1DocumentIndexStatus" }, "indexTime": { "format": "google-datetime", "description": "Output only. The time when the document was last indexed. If this field is populated, it means the document has been indexed. While documents typically become searchable within seconds of indexing, it can sometimes take up to a few hours. If this field is not populated, it means the document has never been indexed.", "readOnly": true, "type": "string" }, "name": { "description": "Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", "type": "string" }, "derivedStructData": { "description": "Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document.", "type": "object", "readOnly": true, "additionalProperties": { "description": "Properties of the object.", "type": "any" } }, "jsonData": { "description": "The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown.", "type": "string" }, "parentDocumentId": { "type": "string", "description": "The identifier of the parent document. Currently supports at most two level document hierarchy. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters." }, "content": { "description": "The unstructured data linked to this document. Content can only be set and must be set if this document is under a `CONTENT_REQUIRED` data store.", "$ref": "GoogleCloudDiscoveryengineV1DocumentContent" }, "schemaId": { "description": "The identifier of the schema located in the same data store.", "type": "string" }, "structData": { "additionalProperties": { "description": "Properties of the object.", "type": "any" }, "type": "object", "description": "The structured JSON data for the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown." }, "id": { "description": "Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 128 characters.", "type": "string" }, "aclInfo": { "description": "Access control information for the document.", "$ref": "GoogleCloudDiscoveryengineV1DocumentAclInfo" } }, "id": "GoogleCloudDiscoveryengineV1Document", "description": "Document captures all raw metadata information of items to be recommended or searched.", "type": "object" }, "GoogleCloudDiscoveryengineV1betaDataStore": { "id": "GoogleCloudDiscoveryengineV1betaDataStore", "type": "object", "properties": { "startingSchema": { "description": "The start schema to use for this DataStore when provisioning it. If unset, a default vertical specialized schema will be used. This field is only used by CreateDataStore API, and will be ignored if used in other APIs. This field will be omitted from all API responses including CreateDataStore API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema).", "$ref": "GoogleCloudDiscoveryengineV1betaSchema" }, "naturalLanguageQueryUnderstandingConfig": { "description": "Optional. Configuration for Natural Language Query Understanding.", "$ref": "GoogleCloudDiscoveryengineV1betaNaturalLanguageQueryUnderstandingConfig" }, "configurableBillingApproach": { "enum": [ "CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED", "CONFIGURABLE_SUBSCRIPTION_INDEXING_CORE", "CONFIGURABLE_CONSUMPTION_EMBEDDING" ], "type": "string", "description": "Optional. Configuration for configurable billing approach. See", "enumDescriptions": [ "Default value. For Spark and non-Spark non-configurable billing approach.", "Use the subscription base + overage billing for indexing core for non embedding storage.", "Use the consumption pay-as-you-go billing for embedding storage add-on." ] }, "healthcareFhirConfig": { "description": "Optional. Configuration for `HEALTHCARE_FHIR` vertical.", "$ref": "GoogleCloudDiscoveryengineV1betaHealthcareFhirConfig" }, "createTime": { "format": "google-datetime", "description": "Output only. Timestamp the DataStore was created at.", "readOnly": true, "type": "string" }, "identityMappingStore": { "type": "string", "description": "Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`." }, "cmekConfig": { "$ref": "GoogleCloudDiscoveryengineV1betaCmekConfig", "description": "Output only. CMEK-related information for the DataStore.", "readOnly": true }, "languageInfo": { "$ref": "GoogleCloudDiscoveryengineV1betaLanguageInfo", "description": "Language info for DataStore." }, "name": { "type": "string", "description": "Immutable. Identifier. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters." }, "isInfobotFaqDataStore": { "type": "boolean", "description": "Optional. If set, this DataStore is an Infobot FAQ DataStore." }, "contentConfig": { "type": "string", "enum": [ "CONTENT_CONFIG_UNSPECIFIED", "NO_CONTENT", "CONTENT_REQUIRED", "PUBLIC_WEBSITE", "GOOGLE_WORKSPACE" ], "description": "Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.", "enumDescriptions": [ "Default value.", "Only contains documents without any Document.content.", "Only contains documents with Document.content.", "The data store is used for public website search.", "The data store is used for workspace search. Details of workspace data store are specified in the WorkspaceConfig." ] }, "kmsKeyName": { "type": "string", "description": "Input only. The KMS key to be used to protect this DataStore at creation time. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStore will be protected by the KMS key, as indicated in the cmek_config field." }, "configurableBillingApproachUpdateTime": { "type": "string", "description": "Output only. The timestamp when configurable_billing_approach was last updated.", "format": "google-datetime", "readOnly": true }, "federatedSearchConfig": { "description": "Optional. If set, this DataStore is a federated search DataStore.", "$ref": "GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfig" }, "billingEstimation": { "readOnly": true, "description": "Output only. Data size estimation for billing.", "$ref": "GoogleCloudDiscoveryengineV1betaDataStoreBillingEstimation" }, "industryVertical": { "enumDescriptions": [ "Value used when unset.", "The generic vertical for documents that are not specific to any industry vertical.", "The media industry vertical.", "The healthcare FHIR vertical." ], "description": "Immutable. The industry vertical that the data store registers.", "enum": [ "INDUSTRY_VERTICAL_UNSPECIFIED", "GENERIC", "MEDIA", "HEALTHCARE_FHIR" ], "type": "string" }, "documentProcessingConfig": { "description": "Configuration for Document understanding and enrichment.", "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig" }, "dataProtectionPolicy": { "description": "Optional. Specifies the data protection policy for the data store.", "$ref": "GoogleCloudDiscoveryengineV1betaDataProtectionPolicy" }, "workspaceConfig": { "description": "Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE.", "$ref": "GoogleCloudDiscoveryengineV1betaWorkspaceConfig" }, "advancedSiteSearchConfig": { "description": "Optional. Configuration for advanced site search.", "$ref": "GoogleCloudDiscoveryengineV1betaAdvancedSiteSearchConfig" }, "solutionTypes": { "description": "The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled.", "items": { "enumDescriptions": [ "Default value.", "Used for Recommendations AI.", "Used for Discovery Search.", "Used for use cases related to the Generative AI agent.", "Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution.", "Used for AI Mode." ], "type": "string", "enum": [ "SOLUTION_TYPE_UNSPECIFIED", "SOLUTION_TYPE_RECOMMENDATION", "SOLUTION_TYPE_SEARCH", "SOLUTION_TYPE_CHAT", "SOLUTION_TYPE_GENERATIVE_CHAT", "SOLUTION_TYPE_AI_MODE" ] }, "type": "array" }, "servingConfigDataStore": { "$ref": "GoogleCloudDiscoveryengineV1betaDataStoreServingConfigDataStore", "description": "Optional. Stores serving config at DataStore level." }, "displayName": { "description": "Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.", "type": "string" }, "defaultSchemaId": { "description": "Output only. The id of the default Schema associated to this data store.", "readOnly": true, "type": "string" }, "aclEnabled": { "description": "Immutable. Whether data in the DataStore has ACL information. If set to `true`, the source data must have ACL. ACL will be ingested when data is ingested by DocumentService.ImportDocuments methods. When ACL is enabled for the DataStore, Document can't be accessed by calling DocumentService.GetDocument or DocumentService.ListDocuments. Currently ACL is only supported in `GENERIC` industry vertical with non-`PUBLIC_WEBSITE` content config.", "type": "boolean" } }, "description": "DataStore captures global settings and configs at the DataStore level." }, "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig": { "type": "object", "properties": { "defaultParsingConfig": { "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.", "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig" }, "parsingConfigOverrides": { "type": "object", "additionalProperties": { "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig" }, "description": "Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported. * `xlsm`: Override parsing config for XLSM files, only digital parsing and layout parsing are supported. * `xlsx`: Override parsing config for XLSX files, only digital parsing and layout parsing are supported." }, "chunkingConfig": { "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig", "description": "Whether chunking mode is enabled." }, "name": { "description": "The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`.", "type": "string" } }, "id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig", "description": "A singleton resource of DataStore. If it's empty when DataStore is created and DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED, the default parser will default to digital parser." }, "GoogleCloudDiscoveryengineV1alphaAlertPolicyConfig": { "type": "object", "id": "GoogleCloudDiscoveryengineV1alphaAlertPolicyConfig", "description": "The connector level alert config.", "properties": { "alertPolicyName": { "type": "string", "description": "Immutable. The fully qualified resource name of the AlertPolicy." }, "alertEnrollments": { "description": "Optional. The enrollment states of each alert.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaAlertPolicyConfigAlertEnrollment" } } } }, "A2aV1StringList": { "description": "protolint:disable REPEATED_FIELD_NAMES_PLURALIZED", "id": "A2aV1StringList", "properties": { "list": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "GoogleCloudDiscoveryengineV1alphaIdentityMappingEntryOperationMetadata": { "type": "object", "description": "IdentityMappingEntry LongRunningOperation metadata for IdentityMappingStoreService.ImportIdentityMappings and IdentityMappingStoreService.PurgeIdentityMappings", "properties": { "totalCount": { "format": "int64", "description": "The total number of IdentityMappingEntries that were processed.", "type": "string" }, "successCount": { "description": "The number of IdentityMappingEntries that were successfully processed.", "format": "int64", "type": "string" }, "failureCount": { "format": "int64", "description": "The number of IdentityMappingEntries that failed to be processed.", "type": "string" } }, "id": "GoogleCloudDiscoveryengineV1alphaIdentityMappingEntryOperationMetadata" }, "GoogleCloudDiscoveryengineV1PurgeDocumentsResponse": { "properties": { "purgeCount": { "type": "string", "format": "int64", "description": "The total count of documents purged as a result of the operation." }, "purgeSample": { "type": "array", "items": { "type": "string" }, "description": "A sample of document names that will be deleted. Only populated if `force` is set to false. A max of 100 names will be returned and the names are chosen at random." } }, "id": "GoogleCloudDiscoveryengineV1PurgeDocumentsResponse", "type": "object", "description": "Response message for DocumentService.PurgeDocuments method. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field." }, "GoogleCloudDiscoveryengineV1UpdateSchemaMetadata": { "id": "GoogleCloudDiscoveryengineV1UpdateSchemaMetadata", "description": "Metadata for UpdateSchema LRO.", "type": "object", "properties": { "updateTime": { "description": "Operation last update time. If the operation is done, this is also the finish time.", "format": "google-datetime", "type": "string" }, "createTime": { "type": "string", "format": "google-datetime", "description": "Operation create time." } } }, "GoogleCloudDiscoveryengineV1TrainCustomModelResponse": { "id": "GoogleCloudDiscoveryengineV1TrainCustomModelResponse", "type": "object", "description": "Response of the TrainCustomModelRequest. This message is returned by the google.longrunning.Operations.response field.", "properties": { "errorSamples": { "type": "array", "items": { "$ref": "GoogleRpcStatus" }, "description": "A sample of errors encountered while processing the data." }, "modelName": { "type": "string", "description": "Fully qualified name of the CustomTuningModel." }, "errorConfig": { "description": "Echoes the destination for the complete errors in the request if set.", "$ref": "GoogleCloudDiscoveryengineV1ImportErrorConfig" }, "modelStatus": { "description": "The trained model status. Possible values are: * **bad-data**: The training data quality is bad. * **no-improvement**: Tuning didn't improve performance. Won't deploy. * **in-progress**: Model training job creation is in progress. * **training**: Model is actively training. * **evaluating**: The model is evaluating trained metrics. * **indexing**: The model trained metrics are indexing. * **ready**: The model is ready for serving.", "type": "string" }, "metrics": { "type": "object", "description": "The metrics of the trained model.", "additionalProperties": { "type": "number", "format": "double" } } } }, "GoogleCloudDiscoveryengineV1betaAgentGatewaySetting": { "type": "object", "id": "GoogleCloudDiscoveryengineV1betaAgentGatewaySetting", "properties": { "defaultEgressAgentGateway": { "$ref": "GoogleCloudDiscoveryengineV1betaAgentGatewaySettingAgentGatewayReference", "description": "Optional. The default egress agent gateway to use, when this setting is applied to a Gemini Enterprise resource. The deployment mode must be GOOGLE_MANAGED, and the governed access path must be AGENT_TO_ANYWHERE." } }, "description": "Agent Gateway setting, which may be attached to Gemini Enterprise resources for egress control of Gemini Enterprise agents to agents and tools outside of Gemini Enterprise." }, "GoogleCloudDiscoveryengineV1betaSearchRequestDisplaySpec": { "properties": { "matchHighlightingCondition": { "description": "The condition under which match highlighting should occur.", "type": "string", "enumDescriptions": [ "Server behavior is the same as `MATCH_HIGHLIGHTING_DISABLED`.", "Disables match highlighting on all documents.", "Enables match highlighting on all documents." ], "enum": [ "MATCH_HIGHLIGHTING_CONDITION_UNSPECIFIED", "MATCH_HIGHLIGHTING_DISABLED", "MATCH_HIGHLIGHTING_ENABLED" ] } }, "id": "GoogleCloudDiscoveryengineV1betaSearchRequestDisplaySpec", "type": "object", "description": "Specifies features for display, like match highlighting." }, "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec": { "description": "A specification for configuring the extractive content in a search response.", "type": "object", "properties": { "maxExtractiveAnswerCount": { "description": "The maximum number of extractive answers returned in each search result. An extractive answer is a verbatim answer extracted from the original document, which provides a precise and contextually relevant answer to the search query. If the number of matching answers is less than the `max_extractive_answer_count`, return all of the answers. Otherwise, return the `max_extractive_answer_count`. At most five answers are returned for each SearchResult.", "format": "int32", "type": "integer" }, "numPreviousSegments": { "format": "int32", "description": "Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments.", "type": "integer" }, "numNextSegments": { "description": "Return at most `num_next_segments` segments after each selected segments.", "type": "integer", "format": "int32" }, "maxExtractiveSegmentCount": { "type": "integer", "format": "int32", "description": "The max number of extractive segments returned in each search result. Only applied if the DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED or DataStore.solution_types is SOLUTION_TYPE_CHAT. An extractive segment is a text segment extracted from the original document that is relevant to the search query, and, in general, more verbose than an extractive answer. The segment could then be used as input for LLMs to generate summaries and answers. If the number of matching segments is less than `max_extractive_segment_count`, return all of the segments. Otherwise, return the `max_extractive_segment_count`." }, "returnExtractiveSegmentScore": { "type": "boolean", "description": "Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`." } }, "id": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec" }, "GoogleCloudDiscoveryengineV1betaInterval": { "id": "GoogleCloudDiscoveryengineV1betaInterval", "type": "object", "properties": { "exclusiveMaximum": { "format": "double", "type": "number", "description": "Exclusive upper bound." }, "exclusiveMinimum": { "format": "double", "type": "number", "description": "Exclusive lower bound." }, "minimum": { "description": "Inclusive lower bound.", "format": "double", "type": "number" }, "maximum": { "format": "double", "type": "number", "description": "Inclusive upper bound." } }, "description": "A floating point interval." }, "GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec": { "description": "Specification for search as you type in search requests.", "properties": { "condition": { "description": "The condition under which search as you type should occur. Default to Condition.DISABLED.", "enumDescriptions": [ "Server behavior defaults to Condition.DISABLED.", "Disables Search As You Type.", "Enables Search As You Type.", "Automatic switching between search-as-you-type and standard search modes, ideal for single-API implementations (e.g., debouncing)." ], "type": "string", "enum": [ "CONDITION_UNSPECIFIED", "DISABLED", "ENABLED", "AUTO" ] } }, "type": "object", "id": "GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec" }, "GoogleCloudDiscoveryengineV1AdvancedSiteSearchConfig": { "id": "GoogleCloudDiscoveryengineV1AdvancedSiteSearchConfig", "type": "object", "properties": { "disableAutomaticRefresh": { "description": "If set true, automatic refresh is disabled for the DataStore.", "type": "boolean" }, "disableInitialIndex": { "description": "If set true, initial indexing is disabled for the DataStore.", "type": "boolean" } }, "description": "Configuration data for advance site search." }, "GoogleCloudDiscoveryengineV1alphaAnswer": { "properties": { "groundingSupports": { "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerGroundingSupport" }, "description": "Optional. Grounding supports." }, "citations": { "description": "Citations.", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerCitation" }, "type": "array" }, "references": { "description": "References.", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReference" }, "type": "array" }, "groundingScore": { "format": "double", "type": "number", "description": "A score in the range of [0, 1] describing how grounded the answer is by the reference chunks." }, "answerSkippedReasons": { "description": "Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.", "items": { "type": "string", "enumDescriptions": [ "Default value. The answer skipped reason is not specified.", "The adversarial query ignored case.", "The non-answer seeking query ignored case Google skips the answer if the query is chit chat.", "The out-of-domain query ignored case. Google skips the answer if there are no high-relevance search results.", "The potential policy violation case. Google skips the answer if there is a potential policy violation detected. This includes content that may be violent or toxic.", "The no relevant content case. Google skips the answer if there is no relevant content in the retrieved search results.", "The jail-breaking query ignored case. For example, \"Reply in the tone of a competing company's CEO\". Google skips the answer if the query is classified as a jail-breaking query.", "The customer policy violation case. Google skips the summary if there is a customer policy violation detected. The policy is defined by the customer.", "The non-answer seeking query ignored case. Google skips the answer if the query doesn't have clear intent.", "The low-grounded answer case. Google skips the answer if a well grounded answer was unable to be generated.", "The user defined query classification ignored case. Google skips the answer if the query is classified as a user defined query classification.", "The unhelpful answer case. Google skips the answer if the answer is not helpful. This can be due to a variety of factors, including but not limited to: the query is not answerable, the answer is not relevant to the query, or the answer is not well-formatted." ], "enum": [ "ANSWER_SKIPPED_REASON_UNSPECIFIED", "ADVERSARIAL_QUERY_IGNORED", "NON_ANSWER_SEEKING_QUERY_IGNORED", "OUT_OF_DOMAIN_QUERY_IGNORED", "POTENTIAL_POLICY_VIOLATION", "NO_RELEVANT_CONTENT", "JAIL_BREAKING_QUERY_IGNORED", "CUSTOMER_POLICY_VIOLATION", "NON_ANSWER_SEEKING_QUERY_IGNORED_V2", "LOW_GROUNDED_ANSWER", "USER_DEFINED_CLASSIFICATION_QUERY_IGNORED", "UNHELPFUL_ANSWER" ] }, "type": "array" }, "safetyRatings": { "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaSafetyRating" }, "description": "Optional. Safety ratings.", "type": "array" }, "queryUnderstandingInfo": { "description": "Query understanding information.", "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfo" }, "completeTime": { "description": "Output only. Answer completed timestamp.", "readOnly": true, "format": "google-datetime", "type": "string" }, "name": { "description": "Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*/answers/*`", "type": "string" }, "answerText": { "description": "The textual answer.", "type": "string" }, "relatedQuestions": { "type": "array", "description": "Suggested related questions.", "items": { "type": "string" } }, "steps": { "type": "array", "description": "Answer generation steps.", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStep" } }, "state": { "enum": [ "STATE_UNSPECIFIED", "IN_PROGRESS", "FAILED", "SUCCEEDED", "STREAMING" ], "enumDescriptions": [ "Unknown.", "Answer generation is currently in progress.", "Answer generation currently failed.", "Answer generation has succeeded.", "Answer generation is currently in progress." ], "description": "The state of the answer generation.", "type": "string" }, "blobAttachments": { "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerBlobAttachment" }, "description": "Output only. List of blob attachments in the answer.", "readOnly": true }, "createTime": { "readOnly": true, "description": "Output only. Answer creation timestamp.", "type": "string", "format": "google-datetime" } }, "id": "GoogleCloudDiscoveryengineV1alphaAnswer", "type": "object", "description": "Defines an answer." }, "GoogleCloudDiscoveryengineV1DeleteCollectionMetadata": { "type": "object", "properties": { "createTime": { "format": "google-datetime", "type": "string", "description": "Operation create time." }, "updateTime": { "format": "google-datetime", "type": "string", "description": "Operation last update time. If the operation is done, this is also the finish time." } }, "id": "GoogleCloudDiscoveryengineV1DeleteCollectionMetadata", "description": "Metadata related to the progress of the CollectionService.UpdateCollection operation. This will be returned by the google.longrunning.Operation.metadata field." }, "GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfig": { "description": "Customer provided configurations.", "type": "object", "properties": { "notebooklmConfig": { "description": "Optional. Configuration for NotebookLM settings.", "$ref": "GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfig" } }, "id": "GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfig" }, "GoogleCloudDiscoveryengineV1AnswerQueryResponse": { "properties": { "answer": { "$ref": "GoogleCloudDiscoveryengineV1Answer", "description": "Answer resource object. If AnswerQueryRequest.QueryUnderstandingSpec.QueryRephraserSpec.max_rephrase_steps is greater than 1, use Answer.name to fetch answer information using ConversationalSearchService.GetAnswer API." }, "answerQueryToken": { "description": "A global unique ID used for logging.", "type": "string" }, "session": { "description": "Session resource object. It will be only available when session field is set and valid in the AnswerQueryRequest request.", "$ref": "GoogleCloudDiscoveryengineV1Session" } }, "description": "Response message for ConversationalSearchService.AnswerQuery method.", "id": "GoogleCloudDiscoveryengineV1AnswerQueryResponse", "type": "object" }, "GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec": { "type": "object", "properties": { "mode": { "enum": [ "MODE_UNSPECIFIED", "SUGGESTION_ONLY", "AUTO" ], "type": "string", "description": "The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO.", "enumDescriptions": [ "Unspecified spell correction mode. In this case, server behavior defaults to Mode.AUTO.", "Search API tries to find a spelling suggestion. If a suggestion is found, it is put in the SearchResponse.corrected_query. The spelling suggestion won't be used as the search query.", "Automatic spell correction built by the Search API. Search will be based on the corrected query if found." ] } }, "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec", "description": "The specification for query spell correction." }, "GoogleCloudDiscoveryengineV1AssistAnswerCustomerPolicyEnforcementResultBannedPhraseEnforcementResult": { "description": "Customer policy enforcement result for the banned phrase policy.", "type": "object", "properties": { "bannedPhrases": { "type": "array", "description": "The banned phrases that were found in the query or the answer.", "items": { "type": "string" } } }, "id": "GoogleCloudDiscoveryengineV1AssistAnswerCustomerPolicyEnforcementResultBannedPhraseEnforcementResult" }, "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec": { "id": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec", "properties": { "languageCode": { "description": "Language code for Summary. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is an experimental feature.", "type": "string" }, "modelPromptSpec": { "description": "If specified, the spec will be used to modify the prompt provided to the LLM.", "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec" }, "summaryResultCount": { "format": "int32", "type": "integer", "description": "The number of top results to generate the summary from. If the number of results returned is less than `summaryResultCount`, the summary is generated from all of the results. At most 10 results for documents mode, or 50 for chunks mode, can be used to generate a summary. The chunks mode is used when SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS." }, "ignoreNonSummarySeekingQuery": { "type": "boolean", "description": "Specifies whether to filter out queries that are not summary-seeking. The default value is `false`. Google employs search-query classification to detect summary-seeking queries. No summary is returned if the search query is classified as a non-summary seeking query. For example, `why is the sky blue` and `Who is the best soccer player in the world?` are summary-seeking queries, but `SFO airport` and `world cup 2026` are not. They are most likely navigational queries. If this field is set to `true`, we skip generating summaries for non-summary seeking queries and return fallback messages instead." }, "modelSpec": { "description": "If specified, the spec will be used to modify the model specification provided to the LLM.", "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec" }, "ignoreLowRelevantContent": { "type": "boolean", "description": "Specifies whether to filter out queries that have low relevance. The default value is `false`. If this field is set to `false`, all search results are used regardless of relevance to generate answers. If set to `true`, only queries with high relevance search results will generate answers." }, "includeCitations": { "type": "boolean", "description": "Specifies whether to include citations in the summary. The default value is `false`. When this field is set to `true`, summaries include in-line citation numbers. Example summary including citations: BigQuery is Google Cloud's fully managed and completely serverless enterprise data warehouse [1]. BigQuery supports all data types, works across clouds, and has built-in machine learning and business intelligence, all within a unified platform [2, 3]. The citation numbers refer to the returned search results and are 1-indexed. For example, [1] means that the sentence is attributed to the first search result. [2, 3] means that the sentence is attributed to both the second and third search results." }, "ignoreAdversarialQuery": { "description": "Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No summary is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating summaries for adversarial queries and return fallback messages instead.", "type": "boolean" }, "useSemanticChunks": { "type": "boolean", "description": "If true, answer will be generated from most relevant chunks from top search results. This feature will improve summary quality. Note that with this feature enabled, not all top search results will be referenced and included in the reference list, so the citation source index only points to the search results listed in the reference list." }, "multimodalSpec": { "description": "Optional. Multimodal specification.", "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecMultiModalSpec" }, "ignoreJailBreakingQuery": { "description": "Optional. Specifies whether to filter out jail-breaking queries. The default value is `false`. Google employs search-query classification to detect jail-breaking queries. No summary is returned if the search query is classified as a jail-breaking query. A user might add instructions to the query to change the tone, style, language, content of the answer, or ask the model to act as a different entity, e.g. \"Reply in the tone of a competing company's CEO\". If this field is set to `true`, we skip generating summaries for jail-breaking queries and return fallback messages instead.", "type": "boolean" } }, "description": "A specification for configuring a summary returned in a search response.", "type": "object" }, "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec": { "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec", "type": "object", "description": "A specification for configuring the behavior of content search.", "properties": { "summarySpec": { "description": "If `summarySpec` is not specified, summaries are not included in the search response.", "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec" }, "extractiveContentSpec": { "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec", "description": "If there is no extractive_content_spec provided, there will be no extractive answer in the search response." }, "chunkSpec": { "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecChunkSpec", "description": "Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS" }, "searchResultMode": { "type": "string", "description": "Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`.", "enum": [ "SEARCH_RESULT_MODE_UNSPECIFIED", "DOCUMENTS", "CHUNKS" ], "enumDescriptions": [ "Default value.", "Returns documents in the search result.", "Returns chunks in the search result. Only available if the DocumentProcessingConfig.chunking_config is specified." ] }, "snippetSpec": { "description": "If `snippetSpec` is not specified, snippets are not included in the search response.", "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSnippetSpec" } } }, "GoogleCloudDiscoveryengineV1ConditionQueryTerm": { "description": "Matcher for search request query", "type": "object", "id": "GoogleCloudDiscoveryengineV1ConditionQueryTerm", "properties": { "value": { "description": "The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters.", "type": "string" }, "fullMatch": { "type": "boolean", "description": "Whether the search query needs to exactly match the query term." } } }, "GoogleCloudDiscoveryengineV1ListIdentityMappingsResponse": { "type": "object", "properties": { "identityMappingEntries": { "items": { "$ref": "GoogleCloudDiscoveryengineV1IdentityMappingEntry" }, "type": "array", "description": "The Identity Mapping Entries." }, "nextPageToken": { "type": "string", "description": "A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages." } }, "description": "Response message for IdentityMappingStoreService.ListIdentityMappings", "id": "GoogleCloudDiscoveryengineV1ListIdentityMappingsResponse" }, "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig": { "properties": { "layoutParsingConfig": { "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig", "description": "Configurations applied to layout parser." }, "digitalParsingConfig": { "description": "Configurations applied to digital parser.", "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig" }, "ocrParsingConfig": { "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig", "description": "Configurations applied to OCR parser. Currently it only applies to PDFs." } }, "type": "object", "description": "Related configurations applied to a specific type of document parser.", "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig" }, "GoogleCloudDiscoveryengineV1alphaProjectConfigurableBillingStatusAgentSearchTokenSubscriptionStatus": { "description": "Per-model Agent Search TPM subscription status. One entry per active `core_subscription.agent_search_token_subscriptions[*]` entry in the customer-provided config; populated by UpdateProject and GetProject. The lifecycle scalars on this message (`start_time`, `terminate_time`, `update_type`, `tpm_threshold_next_update_time`) are per (project, model_version) — siblings of the whole-relationship `start_time` / `terminate_time` / `update_type` on the enclosing ConfigurableBillingStatus, but scoped to this specific Agent Search TPM subscription instead of to the overall customer-configurable- pricing relationship. This per-instance granularity is intentional: the underlying SubV3 storage is per-(project, model_version), so each model has its own activation, termination, and deferred-update clock; surfacing that on the response gives customers the granularity they need to manage per-model commitments independently. QPM / IndexingCore differ — their storage is one row per (project, location), so their lifecycle is represented only by the whole- relationship scalars on ConfigurableBillingStatus.", "properties": { "terminateTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. If set, the scheduled effective time at which this (project, model_version) Agent Search TPM subscription will terminate. Populated when the customer removes this entry from `core_subscription.agent_search_token_subscriptions[*]`. Does NOT move the whole-relationship `terminate_time` on the enclosing ConfigurableBillingStatus, which is populated only when the entire customer-configurable-pricing relationship is being torn down.", "type": "string" }, "startTime": { "description": "Output only. When this (project, model_version) Agent Search TPM subscription was first activated. Set once on first activation of this model version and never moved by subsequent threshold updates; on termination + re-activation a new value is recorded. Does NOT move the whole-relationship `start_time` on the enclosing ConfigurableBillingStatus, which continues to represent the first activation of the overall customer-configurable-pricing relationship.", "format": "google-datetime", "type": "string", "readOnly": true }, "effectiveTpmThreshold": { "type": "string", "description": "Output only. The currently effective TPM threshold. Reflects scale-up immediately and scale-down at the next billing cycle, matching `effective_search_qpm_threshold` semantics.", "readOnly": true, "format": "int64" }, "modelVersion": { "description": "Output only. The Gemini model version this status corresponds to. Matches CoreSubscription.AgentSearchTokenSubscription.model_version (a stable Gemini model version from the Gemini Enterprise Agent Platform model-versions registry; see https://docs.cloud.google.com/gemini-enterprise-agent-platform/models/model-versions#gemini-models).", "readOnly": true, "type": "string" }, "updateType": { "readOnly": true, "type": "string", "enumDescriptions": [ "Unspecified update type.", "Configurable billing was created/enabled.", "Configurable billing was deleted/disabled.", "Subscription was scaled up (thresholds increased).", "Subscription was scaled down (thresholds decreased)." ], "description": "Output only. The type of the most recent update to this (project, model_version) subscription, as performed by the most recent UpdateProject call. `UPDATE_TYPE_UNSPECIFIED` indicates this model_version was not touched by the most recent UpdateProject (its `effective_tpm_threshold` reflects an earlier update). The whole-relationship `update_type` on the enclosing ConfigurableBillingStatus continues to summarize the direction of the most recent update across all surfaces in the project (QPM, IndexingCore, and Agent Search TPM together).", "enum": [ "UPDATE_TYPE_UNSPECIFIED", "CREATE", "DELETE", "SCALE_UP", "SCALE_DOWN" ] }, "tpmThresholdNextUpdateTime": { "description": "Output only. The earliest next update time for the TPM subscription threshold for this (project, model_version). Populated only after a successful update.", "type": "string", "readOnly": true, "format": "google-datetime" } }, "id": "GoogleCloudDiscoveryengineV1alphaProjectConfigurableBillingStatusAgentSearchTokenSubscriptionStatus", "type": "object" }, "GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata": { "type": "object", "description": "Metadata related to the progress of the SiteSearchEngineService.RecrawlUris operation. This will be returned by the google.longrunning.Operation.metadata field.", "properties": { "invalidUris": { "type": "array", "items": { "type": "string" }, "description": "Unique URIs in the request that have invalid format. Sample limited to 1000." }, "invalidUrisCount": { "description": "Total number of unique URIs in the request that have invalid format.", "format": "int32", "type": "integer" }, "validUrisCount": { "type": "integer", "description": "Total number of unique URIs in the request that are not in invalid_uris.", "format": "int32" }, "pendingCount": { "type": "integer", "format": "int32", "description": "Total number of URIs that have yet to be crawled." }, "urisNotMatchingTargetSites": { "type": "array", "items": { "type": "string" }, "description": "Unique URIs in the request that don't match any TargetSite in the DataStore, only match TargetSites that haven't been fully indexed, or match a TargetSite with type EXCLUDE. Sample limited to 1000." }, "createTime": { "description": "Operation create time.", "format": "google-datetime", "type": "string" }, "updateTime": { "format": "google-datetime", "description": "Operation last update time. If the operation is done, this is also the finish time.", "type": "string" }, "urisNotMatchingTargetSitesCount": { "type": "integer", "description": "Total number of URIs that don't match any TargetSites.", "format": "int32" }, "noindexUris": { "type": "array", "description": "URIs that have no index meta tag. Sample limited to 1000.", "items": { "type": "string" } }, "noindexUrisCount": { "description": "Total number of URIs that have no index meta tag.", "format": "int32", "type": "integer" }, "quotaExceededCount": { "type": "integer", "description": "Total number of URIs that were rejected due to insufficient indexing resources.", "format": "int32" }, "successCount": { "format": "int32", "type": "integer", "description": "Total number of URIs that have been crawled so far." } }, "id": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata" }, "GoogleCloudDiscoveryengineV1ControlFilterAction": { "type": "object", "properties": { "filter": { "description": "Required. A filter to apply on the matching condition results. Required Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown.", "type": "string" }, "dataStore": { "description": "Required. Specifies which data store's documents can be filtered by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store", "type": "string" } }, "description": "Specified which products may be included in results. Uses same filter as boost.", "id": "GoogleCloudDiscoveryengineV1ControlFilterAction" }, "GoogleCloudDiscoveryengineV1AnswerQueryRequestEndUserSpec": { "type": "object", "description": "End user specification.", "id": "GoogleCloudDiscoveryengineV1AnswerQueryRequestEndUserSpec", "properties": { "endUserMetadata": { "items": { "$ref": "GoogleCloudDiscoveryengineV1AnswerQueryRequestEndUserSpecEndUserMetaData" }, "description": "Optional. End user metadata.", "type": "array" } } }, "GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec": { "description": "Specification for relevance filtering on a specific sub-search.", "type": "object", "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec", "properties": { "relevanceThreshold": { "description": "Pre-defined relevance threshold for the sub-search.", "enum": [ "RELEVANCE_THRESHOLD_UNSPECIFIED", "LOWEST", "LOW", "MEDIUM", "HIGH" ], "type": "string", "enumDescriptions": [ "Default value. In this case, server behavior defaults to Google defined threshold.", "Lowest relevance threshold.", "Low relevance threshold.", "Medium relevance threshold.", "High relevance threshold." ] }, "semanticRelevanceThreshold": { "format": "float", "description": "Custom relevance threshold for the sub-search. The value must be in [0.0, 1.0].", "type": "number" } } }, "GoogleCloudDiscoveryengineV1alphaAclConfig": { "description": "Access Control Configuration.", "properties": { "name": { "description": "Immutable. The full resource name of the acl configuration. Format: `projects/{project}/locations/{location}/aclConfig`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", "type": "string" }, "idpConfig": { "description": "Identity provider config.", "$ref": "GoogleCloudDiscoveryengineV1alphaIdpConfig" } }, "id": "GoogleCloudDiscoveryengineV1alphaAclConfig", "type": "object" }, "GoogleCloudDiscoveryengineV1alphaDataConnectorRealtimeSyncConfig": { "description": "The configuration for realtime sync to store additional params for realtime sync.", "type": "object", "id": "GoogleCloudDiscoveryengineV1alphaDataConnectorRealtimeSyncConfig", "properties": { "webhookUri": { "description": "Optional. Webhook url for the connector to specify additional params for realtime sync.", "type": "string" }, "streamingError": { "description": "Optional. Streaming error details.", "$ref": "GoogleCloudDiscoveryengineV1alphaDataConnectorRealtimeSyncConfigStreamingError" }, "realtimeSyncSecret": { "description": "Optional. The ID of the Secret Manager secret used for webhook secret.", "type": "string" } } }, "A2aV1AgentInterface": { "type": "object", "description": "Defines additional transport information for the agent.", "properties": { "transport": { "type": "string", "description": "The transport supported this url. This is an open form string, to be easily extended for many transport protocols. The core ones officially supported are JSONRPC, GRPC and HTTP+JSON." }, "url": { "description": "The url this interface is found at.", "type": "string" }, "tenant": { "type": "string", "description": "Tenant to be set in the request when calling the agent. Experimental, might still change for 1.0 release." } }, "id": "A2aV1AgentInterface" }, "GoogleCloudDiscoveryengineV1alphaDeletePatientFiltersRequest": { "id": "GoogleCloudDiscoveryengineV1alphaDeletePatientFiltersRequest", "properties": { "dataStore": { "description": "Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. If the caller does not have permission to access the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error is returned. If the requested DataStore does not have a patient filter, a NOT_FOUND error will be returned.", "type": "string" } }, "type": "object", "description": "Request for DataStoreService.DeletePatientFilters method." }, "GoogleCloudDiscoveryengineV1SearchRequestSpellCorrectionSpec": { "type": "object", "id": "GoogleCloudDiscoveryengineV1SearchRequestSpellCorrectionSpec", "properties": { "mode": { "enumDescriptions": [ "Unspecified spell correction mode. In this case, server behavior defaults to Mode.AUTO.", "Search API tries to find a spelling suggestion. If a suggestion is found, it is put in the SearchResponse.corrected_query. The spelling suggestion won't be used as the search query.", "Automatic spell correction built by the Search API. Search will be based on the corrected query if found." ], "enum": [ "MODE_UNSPECIFIED", "SUGGESTION_ONLY", "AUTO" ], "description": "The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO.", "type": "string" } }, "description": "The specification for query spell correction." }, "GoogleCloudDiscoveryengineV1UserInfoPreciseLocation": { "id": "GoogleCloudDiscoveryengineV1UserInfoPreciseLocation", "description": "Precise location info with multiple representation options.", "type": "object", "properties": { "point": { "$ref": "GoogleTypeLatLng", "description": "Optional. Location represented by a latitude/longitude point." }, "address": { "description": "Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1PanelInfo": { "properties": { "panelPosition": { "description": "The ordered position of the panel, if shown to the user with other panels. If set, then total_panels must also be set.", "type": "integer", "format": "int32" }, "panelId": { "description": "Required. The panel ID.", "type": "string" }, "totalPanels": { "description": "The total number of panels, including this one, shown to the user. Must be set if panel_position is set.", "type": "integer", "format": "int32" }, "displayName": { "type": "string", "description": "The display name of the panel." }, "documents": { "items": { "$ref": "GoogleCloudDiscoveryengineV1DocumentInfo" }, "type": "array", "description": "Optional. The document IDs associated with this panel." } }, "id": "GoogleCloudDiscoveryengineV1PanelInfo", "description": "Detailed panel information associated with a user event.", "type": "object" }, "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpecModelSpec": { "description": "Specification of the model.", "properties": { "version": { "type": "string", "description": "The model version used to generate the summary. Supported values are: * `stable`: string. Default value when no value is specified. Uses a generally available, fine-tuned model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). * `preview`: string. (Public preview) Uses a preview model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models)." } }, "type": "object", "id": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpecModelSpec" }, "GoogleCloudDiscoveryengineV1AnswerGroundingSupport": { "description": "Grounding support for a claim in `answer_text`.", "id": "GoogleCloudDiscoveryengineV1AnswerGroundingSupport", "type": "object", "properties": { "groundingCheckRequired": { "description": "Indicates that this claim required grounding check. When the system decided this claim didn't require attribution/grounding check, this field is set to false. In that case, no grounding check was done for the claim and therefore `grounding_score`, `sources` is not returned.", "type": "boolean" }, "endIndex": { "description": "Required. End of the claim, exclusive.", "format": "int64", "type": "string" }, "startIndex": { "type": "string", "description": "Required. Index indicates the start of the claim, measured in bytes (UTF-8 unicode).", "format": "int64" }, "sources": { "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1AnswerCitationSource" }, "description": "Optional. Citation sources for the claim." }, "groundingScore": { "format": "double", "description": "A score in the range of [0, 1] describing how grounded is a specific claim by the references. Higher value means that the claim is better supported by the reference chunks.", "type": "number" } } }, "GoogleCloudDiscoveryengineV1AlertPolicyConfig": { "description": "The connector level alert config.", "properties": { "alertPolicyName": { "description": "Immutable. The fully qualified resource name of the AlertPolicy.", "type": "string" }, "alertEnrollments": { "type": "array", "description": "Optional. The enrollment states of each alert.", "items": { "$ref": "GoogleCloudDiscoveryengineV1AlertPolicyConfigAlertEnrollment" } } }, "type": "object", "id": "GoogleCloudDiscoveryengineV1AlertPolicyConfig" }, "GoogleCloudDiscoveryengineV1SearchResponseSummaryCitation": { "description": "Citation info for a segment.", "type": "object", "properties": { "startIndex": { "type": "string", "format": "int64", "description": "Index indicates the start of the segment, measured in bytes/unicode." }, "endIndex": { "description": "End of the attributed segment, exclusive.", "format": "int64", "type": "string" }, "sources": { "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1SearchResponseSummaryCitationSource" }, "description": "Citation sources for the attributed segment." } }, "id": "GoogleCloudDiscoveryengineV1SearchResponseSummaryCitation" }, "GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadataReference": { "id": "GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadataReference", "properties": { "content": { "description": "Referenced text content.", "type": "string" }, "documentMetadata": { "$ref": "GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadataReferenceDocumentMetadata", "description": "Document metadata." }, "codeSnippet": { "description": "Chunk of code snippet from the referenced document.", "type": "string" }, "chunkMetadata": { "description": "Output only. Generic structured chunk metadata from upstream data source connectors.", "additionalProperties": { "description": "Properties of the object.", "type": "any" }, "type": "object", "readOnly": true } }, "description": "Referenced content and related document metadata.", "type": "object" }, "GoogleApiHttpBody": { "type": "object", "description": "Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.", "id": "GoogleApiHttpBody", "properties": { "data": { "format": "byte", "type": "string", "description": "The HTTP request/response body as raw binary." }, "contentType": { "description": "The HTTP Content-Type header value specifying the content type of the body.", "type": "string" }, "extensions": { "description": "Application specific response metadata. Must be set in the first response for streaming APIs.", "type": "array", "items": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } } } } }, "GoogleCloudDiscoveryengineV1SearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilter": { "type": "object", "description": "The filters that were extracted from the input query represented in a structured form.", "id": "GoogleCloudDiscoveryengineV1SearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilter", "properties": { "expression": { "$ref": "GoogleCloudDiscoveryengineV1SearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterExpression", "description": "The expression denoting the filter that was extracted from the input query in a structured form. It can be a simple expression denoting a single string, numerical or geolocation constraint or a compound expression which is a combination of multiple expressions connected using logical (OR and AND) operators." } } }, "GoogleCloudDiscoveryengineV1DataConnectorFederatedConfig": { "id": "GoogleCloudDiscoveryengineV1DataConnectorFederatedConfig", "description": "Any params and credentials used specifically for hybrid connectors supporting FEDERATED mode.", "properties": { "jsonAuthParams": { "description": "Optional. Any authentication parameters specific to FEDERATED connectors in json string format.", "type": "string" }, "additionalParams": { "description": "Optional. Any additional parameters needed for FEDERATED.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "authParams": { "description": "Optional. Any authentication parameters specific to FEDERATED connectors.", "additionalProperties": { "description": "Properties of the object.", "type": "any" }, "type": "object" } }, "type": "object" }, "GoogleCloudDiscoveryengineV1DestinationConfig": { "description": "Defines target endpoints used to connect to third-party sources.", "id": "GoogleCloudDiscoveryengineV1DestinationConfig", "type": "object", "properties": { "jsonParams": { "description": "Additional parameters for this destination config in json string format.", "type": "string" }, "key": { "type": "string", "description": "Optional. Unique destination identifier that is supported by the connector." }, "params": { "type": "object", "description": "Optional. Additional parameters for this destination config in structured json format.", "additionalProperties": { "description": "Properties of the object.", "type": "any" } }, "destinations": { "items": { "$ref": "GoogleCloudDiscoveryengineV1DestinationConfigDestination" }, "type": "array", "description": "Optional. The destinations for the corresponding key." } } }, "GoogleCloudDiscoveryengineV1AssistantCustomerPolicyModelArmorConfig": { "description": "Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and assistant responses.", "id": "GoogleCloudDiscoveryengineV1AssistantCustomerPolicyModelArmorConfig", "type": "object", "properties": { "userPromptTemplate": { "description": "Optional. The resource name of the Model Armor template for sanitizing user prompts. Format: `projects/{project}/locations/{location}/templates/{template_id}` If not specified, no sanitization will be applied to the user prompt.", "type": "string" }, "responseTemplate": { "description": "Optional. The resource name of the Model Armor template for sanitizing assistant responses. Format: `projects/{project}/locations/{location}/templates/{template_id}` If not specified, no sanitization will be applied to the assistant response.", "type": "string" }, "failureMode": { "enum": [ "FAILURE_MODE_UNSPECIFIED", "FAIL_OPEN", "FAIL_CLOSED" ], "type": "string", "description": "Optional. Defines the failure mode for Model Armor sanitization.", "enumDescriptions": [ "Unspecified failure mode, default behavior is `FAIL_CLOSED`.", "In case of a Model Armor processing failure, the request is allowed to proceed without any changes.", "In case of a Model Armor processing failure, the request is rejected." ] } } }, "GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponseDocumentMetadataMatcherValue": { "properties": { "uri": { "description": "If match by URI, the URI of the Document.", "type": "string" }, "fhirResource": { "description": "Format: projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id}", "type": "string" } }, "type": "object", "id": "GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponseDocumentMetadataMatcherValue", "description": "The value of the matcher that was used to match the Document." }, "GoogleCloudDiscoveryengineV1alphaAssistantContentBlob": { "properties": { "mimeType": { "description": "Required. The media type (MIME type) of the generated data.", "type": "string" }, "data": { "description": "Required. Raw bytes.", "format": "byte", "type": "string" } }, "description": "Inline blob.", "type": "object", "id": "GoogleCloudDiscoveryengineV1alphaAssistantContentBlob" }, "GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesMetadata": { "type": "object", "description": "Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", "properties": { "createTime": { "format": "google-datetime", "description": "Operation create time.", "type": "string" }, "updateTime": { "type": "string", "format": "google-datetime", "description": "Operation last update time. If the operation is done, this is also the finish time." } }, "id": "GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesMetadata" }, "GoogleApiDistributionBucketOptionsExplicit": { "properties": { "bounds": { "items": { "format": "double", "type": "number" }, "description": "The values must be monotonically increasing.", "type": "array" } }, "description": "Specifies a set of buckets with arbitrary widths. There are `size(bounds) + 1` (= N) buckets. Bucket `i` has the following boundaries: Upper bound (0 \u003c= i \u003c N-1): bounds[i] Lower bound (1 \u003c= i \u003c N); bounds[i - 1] The `bounds` field must contain at least one element. If `bounds` has only one element, then there are no finite buckets, and that single element is the common boundary of the overflow and underflow buckets.", "type": "object", "id": "GoogleApiDistributionBucketOptionsExplicit" }, "GoogleCloudDiscoveryengineV1alphaSearchRequestCrowdingSpec": { "properties": { "field": { "type": "string", "description": "The field to use for crowding. Documents can be crowded by a field in the Document object. Crowding field is case sensitive." }, "maxCount": { "description": "The maximum number of documents to keep per value of the field. Once there are at least max_count previous results which contain the same value for the given field (according to the order specified in `order_by`), later results with the same value are \"crowded away\". If not specified, the default value is 1.", "format": "int32", "type": "integer" }, "mode": { "description": "Mode to use for documents that are crowded away.", "type": "string", "enum": [ "MODE_UNSPECIFIED", "DROP_CROWDED_RESULTS", "DEMOTE_CROWDED_RESULTS_TO_END" ], "enumDescriptions": [ "Unspecified crowding mode. In this case, server behavior defaults to Mode.DROP_CROWDED_RESULTS.", "Drop crowded results.", "Demote crowded results to the later pages." ] } }, "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestCrowdingSpec", "type": "object", "description": "Specification for crowding. Crowding improves the diversity of search results by limiting the number of results that share the same field value. For example, crowding on the color field with a max_count of 3 and mode DROP_CROWDED_RESULTS will return at most 3 results with the same color across all pages." }, "GoogleCloudDiscoveryengineV1alphaExportMetricsMetadata": { "id": "GoogleCloudDiscoveryengineV1alphaExportMetricsMetadata", "properties": { "updateTime": { "format": "google-datetime", "description": "Operation last update time. If the operation is done, this is also the finish time.", "type": "string" }, "createTime": { "format": "google-datetime", "description": "Operation create time.", "type": "string" } }, "description": "Metadata related to the progress of the Export operation. This is returned by the google.longrunning.Operation.metadata field.", "type": "object" }, "GoogleCloudDiscoveryengineV1alphaSearchRequestCustomRankingParams": { "properties": { "expressionsToPrecompute": { "description": "Optional. A list of ranking expressions (see `ranking_expression` for the syntax documentation) to evaluate. The evaluation results will be returned in `SearchResponse.SearchResult.rank_signals.precomputed_expression_values` field.", "type": "array", "items": { "type": "string" } } }, "type": "object", "description": "Configuration parameters for the Custom Ranking feature.", "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestCustomRankingParams" }, "GoogleIamV1SetIamPolicyRequest": { "type": "object", "id": "GoogleIamV1SetIamPolicyRequest", "description": "Request message for `SetIamPolicy` method.", "properties": { "policy": { "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them.", "$ref": "GoogleIamV1Policy" } } }, "GoogleCloudDiscoveryengineV1TargetSite": { "properties": { "name": { "description": "Output only. The fully qualified resource name of the target site. `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}` The `target_site_id` is system-generated.", "type": "string", "readOnly": true }, "updateTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The target site's last updated time." }, "siteVerificationInfo": { "$ref": "GoogleCloudDiscoveryengineV1SiteVerificationInfo", "readOnly": true, "description": "Output only. Site ownership and validity verification status." }, "indexingStatus": { "type": "string", "readOnly": true, "description": "Output only. Indexing status.", "enum": [ "INDEXING_STATUS_UNSPECIFIED", "PENDING", "FAILED", "SUCCEEDED", "DELETING", "CANCELLABLE", "CANCELLED" ], "enumDescriptions": [ "Defaults to SUCCEEDED.", "The target site is in the update queue and will be picked up by indexing pipeline.", "The target site fails to be indexed.", "The target site has been indexed.", "The previously indexed target site has been marked to be deleted. This is a transitioning state which will resulted in either: 1. target site deleted if unindexing is successful; 2. state reverts to SUCCEEDED if the unindexing fails.", "The target site change is pending but cancellable.", "The target site change is cancelled." ] }, "rootDomainUri": { "type": "string", "readOnly": true, "description": "Output only. Root domain of the provided_uri_pattern." }, "providedUriPattern": { "description": "Required. Input only. The user provided URI pattern from which the `generated_uri_pattern` is generated.", "type": "string" }, "generatedUriPattern": { "description": "Output only. This is system-generated based on the provided_uri_pattern.", "readOnly": true, "type": "string" }, "type": { "type": "string", "enum": [ "TYPE_UNSPECIFIED", "INCLUDE", "EXCLUDE" ], "enumDescriptions": [ "This value is unused. In this case, server behavior defaults to Type.INCLUDE.", "Include the target site.", "Exclude the target site." ], "description": "The type of the target site, e.g., whether the site is to be included or excluded." }, "exactMatch": { "type": "boolean", "description": "Immutable. If set to false, a uri_pattern is generated to include all pages whose address contains the provided_uri_pattern. If set to true, an uri_pattern is generated to try to be an exact match of the provided_uri_pattern or just the specific page if the provided_uri_pattern is a specific one. provided_uri_pattern is always normalized to generate the URI pattern to be used by the search engine." }, "failureReason": { "description": "Output only. Failure reason.", "readOnly": true, "$ref": "GoogleCloudDiscoveryengineV1TargetSiteFailureReason" } }, "type": "object", "description": "A target site for the SiteSearchEngine.", "id": "GoogleCloudDiscoveryengineV1TargetSite" }, "GoogleCloudDiscoveryengineV1betaEngine": { "properties": { "disableAnalytics": { "type": "boolean", "description": "Optional. Whether to disable analytics for searches performed on this engine." }, "connectorTenantInfo": { "description": "Optional. Maps a connector ID (e.g., \"hybrid-github\", \"shopify\") to tenant-specific information required for that connector. The structure of the tenant information string is connector-dependent.", "additionalProperties": { "type": "string" }, "type": "object" }, "commonConfig": { "description": "Common config spec that specifies the metadata of the engine.", "$ref": "GoogleCloudDiscoveryengineV1betaEngineCommonConfig" }, "agentGatewaySetting": { "description": "Optional. The agent gateway setting for the engine.", "$ref": "GoogleCloudDiscoveryengineV1betaAgentGatewaySetting" }, "solutionType": { "enum": [ "SOLUTION_TYPE_UNSPECIFIED", "SOLUTION_TYPE_RECOMMENDATION", "SOLUTION_TYPE_SEARCH", "SOLUTION_TYPE_CHAT", "SOLUTION_TYPE_GENERATIVE_CHAT", "SOLUTION_TYPE_AI_MODE" ], "description": "Required. The solutions of the engine.", "type": "string", "enumDescriptions": [ "Default value.", "Used for Recommendations AI.", "Used for Discovery Search.", "Used for use cases related to the Generative AI agent.", "Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution.", "Used for AI Mode." ] }, "cmekConfig": { "readOnly": true, "$ref": "GoogleCloudDiscoveryengineV1betaCmekConfig", "description": "Output only. CMEK-related information for the Engine." }, "displayName": { "type": "string", "description": "Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters." }, "createTime": { "type": "string", "description": "Output only. Timestamp the Recommendation Engine was created at.", "format": "google-datetime", "readOnly": true }, "dataStoreIds": { "description": "Optional. The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations.", "items": { "type": "string" }, "type": "array" }, "appType": { "type": "string", "enum": [ "APP_TYPE_UNSPECIFIED", "APP_TYPE_INTRANET" ], "description": "Optional. Immutable. This the application type which this engine resource represents. NOTE: this is a new concept independ of existing industry vertical or solution type.", "enumDescriptions": [ "All non specified apps.", "App type for intranet search and Agentspace." ] }, "features": { "type": "object", "description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `speech-to-text` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `canvas-app-builder` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications`", "additionalProperties": { "enumDescriptions": [ "The feature state is unspecified.", "The feature is turned on to be accessible.", "The feature is turned off to be inaccessible." ], "type": "string", "enum": [ "FEATURE_STATE_UNSPECIFIED", "FEATURE_STATE_ON", "FEATURE_STATE_OFF" ] } }, "configurableBillingApproach": { "type": "string", "description": "Optional. Configuration for configurable billing approach.", "enum": [ "CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED", "CONFIGURABLE_BILLING_APPROACH_ENABLED" ], "enumDescriptions": [ "Default value. For Spark and non-Spark non-configurable billing approach. General pricing model.", "The billing approach follows configurations specified by customer." ] }, "knowledgeGraphConfig": { "description": "Optional. Configurations for the Knowledge Graph. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.", "$ref": "GoogleCloudDiscoveryengineV1betaEngineKnowledgeGraphConfig" }, "name": { "description": "Immutable. Identifier. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.", "type": "string" }, "industryVertical": { "enum": [ "INDUSTRY_VERTICAL_UNSPECIFIED", "GENERIC", "MEDIA", "HEALTHCARE_FHIR" ], "enumDescriptions": [ "Value used when unset.", "The generic vertical for documents that are not specific to any industry vertical.", "The media industry vertical.", "The healthcare FHIR vertical." ], "type": "string", "description": "Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine." }, "observabilityConfig": { "$ref": "GoogleCloudDiscoveryengineV1betaObservabilityConfig", "description": "Optional. Observability config for the engine." }, "updateTime": { "description": "Output only. Timestamp the Recommendation Engine was last updated.", "readOnly": true, "type": "string", "format": "google-datetime" }, "procurementContactEmails": { "type": "array", "items": { "type": "string" }, "description": "Optional. The emails of the procurement contacts." }, "sessionConfig": { "$ref": "GoogleCloudDiscoveryengineV1betaSessionConfig", "description": "Optional. Non-empty default. Session config for the engine." }, "marketplaceAgentVisibility": { "enumDescriptions": [ "Defaults to `MARKETPLACE_AGENT_VISIBILITY_UNSPECIFIED`.", "Only agents that are currently available for use by the user are visible.", "Show marketplace agents that the user does not yet have access to but are integrated into the engine. This level also includes all agents visible with `SHOW_AVAILABLE_AGENTS_ONLY`.", "Show all agents visible with `SHOW_AGENTS_ALREADY_INTEGRATED`, plus agents that have already been purchased by the project/organization, even if they are not currently integrated into the engine.", "All agents in the marketplace are visible, regardless of access or purchase status. This level encompasses all agents shown in the previous levels." ], "description": "Optional. The visibility of marketplace agents in the agent gallery.", "enum": [ "MARKETPLACE_AGENT_VISIBILITY_UNSPECIFIED", "SHOW_AVAILABLE_AGENTS_ONLY", "SHOW_AGENTS_ALREADY_INTEGRATED", "SHOW_AGENTS_ALREADY_PURCHASED", "SHOW_ALL_AGENTS" ], "type": "string" }, "chatEngineConfig": { "$ref": "GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig", "description": "Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT." }, "mediaRecommendationEngineConfig": { "description": "Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical.", "$ref": "GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfig" }, "associatedAgentRegistry": { "type": "string", "readOnly": true, "description": "Output only. The Agent registry containing the agents, MCP servers and tools associated with this engine. Derived server-side from the linked Agent Gateway's registry." }, "chatEngineMetadata": { "description": "Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.", "$ref": "GoogleCloudDiscoveryengineV1betaEngineChatEngineMetadata", "readOnly": true }, "searchEngineConfig": { "description": "Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.", "$ref": "GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig" }, "modelConfigs": { "description": "Optional. Maps a model name to its specific configuration for this engine. This allows admin users to turn on/off individual models. This only stores models whose states are overridden by the admin. When the state is unspecified, or model_configs is empty for this model, the system will decide if this model should be available or not based on the default configuration. For example, a preview model should be disabled by default if the admin has not chosen to enable it.", "additionalProperties": { "enumDescriptions": [ "The model state is unspecified.", "The model is enabled by admin.", "The model is disabled by admin." ], "type": "string", "enum": [ "MODEL_STATE_UNSPECIFIED", "MODEL_ENABLED", "MODEL_DISABLED" ] }, "type": "object" } }, "id": "GoogleCloudDiscoveryengineV1betaEngine", "description": "Metadata that describes the training and serving parameters of an Engine.", "type": "object" }, "GoogleCloudDiscoveryengineV1alphaConditionQueryTerm": { "description": "Matcher for search request query", "type": "object", "properties": { "value": { "type": "string", "description": "The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters." }, "fullMatch": { "description": "Whether the search query needs to exactly match the query term.", "type": "boolean" } }, "id": "GoogleCloudDiscoveryengineV1alphaConditionQueryTerm" }, "GoogleCloudDiscoveryengineV1alphaInterval": { "description": "A floating point interval.", "id": "GoogleCloudDiscoveryengineV1alphaInterval", "type": "object", "properties": { "exclusiveMaximum": { "description": "Exclusive upper bound.", "type": "number", "format": "double" }, "minimum": { "type": "number", "description": "Inclusive lower bound.", "format": "double" }, "maximum": { "description": "Inclusive upper bound.", "type": "number", "format": "double" }, "exclusiveMinimum": { "description": "Exclusive lower bound.", "format": "double", "type": "number" } } }, "GoogleCloudDiscoveryengineV1IdentityMappingStore": { "properties": { "kmsKeyName": { "description": "Input only. The KMS key to be used to protect this Identity Mapping Store at creation time. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the Identity Mapping Store will be protected by the KMS key, as indicated in the cmek_config field.", "type": "string" }, "name": { "type": "string", "description": "Immutable. The full resource name of the identity mapping store. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters." }, "cmekConfig": { "readOnly": true, "description": "Output only. CMEK-related information for the Identity Mapping Store.", "$ref": "GoogleCloudDiscoveryengineV1CmekConfig" } }, "id": "GoogleCloudDiscoveryengineV1IdentityMappingStore", "description": "Identity Mapping Store which contains Identity Mapping Entries.", "type": "object" }, "GoogleApiDistributionRange": { "description": "The range of the population values.", "properties": { "min": { "format": "double", "type": "number", "description": "The minimum of the population values." }, "max": { "description": "The maximum of the population values.", "format": "double", "type": "number" } }, "type": "object", "id": "GoogleApiDistributionRange" }, "GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoDocumentContext": { "properties": { "content": { "type": "string", "description": "Document content to be used for answer generation." }, "pageIdentifier": { "description": "Page identifier.", "type": "string" } }, "id": "GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoDocumentContext", "description": "Document context.", "type": "object" }, "GoogleCloudDiscoveryengineV1BatchUpdateUserLicensesRequestInlineSource": { "type": "object", "id": "GoogleCloudDiscoveryengineV1BatchUpdateUserLicensesRequestInlineSource", "properties": { "updateMask": { "type": "string", "description": "Optional. The list of fields to update.", "format": "google-fieldmask" }, "userLicenses": { "description": "Required. A list of user licenses to update. Each user license must have a valid UserLicense.user_principal.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1UserLicense" } } }, "description": "The inline source for the input config for BatchUpdateUserLicenses method." }, "GoogleCloudDiscoveryengineV1StreamAssistRequestToolsSpec": { "type": "object", "description": "Specification of tools that are used to serve the request.", "properties": { "webGroundingSpec": { "$ref": "GoogleCloudDiscoveryengineV1StreamAssistRequestToolsSpecWebGroundingSpec", "description": "Optional. Specification of the web grounding tool. If field is present, enables grounding with web search. Works only if Assistant.web_grounding_type is WEB_GROUNDING_TYPE_GOOGLE_SEARCH or WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH." }, "vertexAiSearchSpec": { "$ref": "GoogleCloudDiscoveryengineV1StreamAssistRequestToolsSpecVertexAiSearchSpec", "description": "Optional. Specification of the Vertex AI Search tool." }, "imageGenerationSpec": { "description": "Optional. Specification of the image generation tool.", "$ref": "GoogleCloudDiscoveryengineV1StreamAssistRequestToolsSpecImageGenerationSpec" }, "videoGenerationSpec": { "$ref": "GoogleCloudDiscoveryengineV1StreamAssistRequestToolsSpecVideoGenerationSpec", "description": "Optional. Specification of the video generation tool." } }, "id": "GoogleCloudDiscoveryengineV1StreamAssistRequestToolsSpec" }, "GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpecEmbeddingVector": { "id": "GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpecEmbeddingVector", "description": "Embedding vector.", "type": "object", "properties": { "vector": { "description": "Query embedding vector.", "items": { "type": "number", "format": "float" }, "type": "array" }, "fieldPath": { "type": "string", "description": "Embedding field path in schema." } } }, "GoogleCloudDiscoveryengineV1alphaDestinationConfigDestination": { "id": "GoogleCloudDiscoveryengineV1alphaDestinationConfigDestination", "properties": { "port": { "type": "integer", "format": "int32", "description": "Optional. Target port number accepted by the destination." }, "host": { "type": "string", "description": "Publicly routable host." } }, "type": "object", "description": "Defines a target endpoint" }, "GoogleCloudDiscoveryengineV1AssistantGenerationConfig": { "type": "object", "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" }, "allowedModelIds": { "type": "array", "description": "Optional. The list of models that are allowed to be used for assistant.", "items": { "type": "string" } }, "defaultModelId": { "type": "string", "description": "Optional. The default model to use for assistant." } }, "id": "GoogleCloudDiscoveryengineV1AssistantGenerationConfig", "description": "Configuration for the generation of the assistant response." }, "GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadata": { "id": "GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadata", "type": "object", "description": "Grounding details for text sources.", "properties": { "segments": { "description": "Grounding information for parts of the text.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadataSegment" } }, "visualSegments": { "description": "Grounding information for parts of the visual content.", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadataVisualSegment" }, "type": "array" }, "references": { "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadataReference" }, "type": "array", "description": "References for the grounded text." } } }, "GoogleCloudDiscoveryengineV1ProjectConfigurableBillingStatusAgentSearchTokenSubscriptionStatus": { "type": "object", "properties": { "updateType": { "description": "Output only. The type of the most recent update to this (project, model_version) subscription, as performed by the most recent UpdateProject call. `UPDATE_TYPE_UNSPECIFIED` indicates this model_version was not touched by the most recent UpdateProject (its `effective_tpm_threshold` reflects an earlier update). The whole-relationship `update_type` on the enclosing ConfigurableBillingStatus continues to summarize the direction of the most recent update across all surfaces in the project (QPM, IndexingCore, and Agent Search TPM together).", "readOnly": true, "enum": [ "UPDATE_TYPE_UNSPECIFIED", "CREATE", "DELETE", "SCALE_UP", "SCALE_DOWN" ], "type": "string", "enumDescriptions": [ "Unspecified update type.", "Configurable billing was created/enabled.", "Configurable billing was deleted/disabled.", "Subscription was scaled up (thresholds increased).", "Subscription was scaled down (thresholds decreased)." ] }, "startTime": { "description": "Output only. When this (project, model_version) Agent Search TPM subscription was first activated. Set once on first activation of this model version and never moved by subsequent threshold updates; on termination + re-activation a new value is recorded. Does NOT move the whole-relationship `start_time` on the enclosing ConfigurableBillingStatus, which continues to represent the first activation of the overall customer-configurable-pricing relationship.", "type": "string", "format": "google-datetime", "readOnly": true }, "effectiveTpmThreshold": { "format": "int64", "description": "Output only. The currently effective TPM threshold. Reflects scale-up immediately and scale-down at the next billing cycle, matching `effective_search_qpm_threshold` semantics.", "readOnly": true, "type": "string" }, "modelVersion": { "readOnly": true, "description": "Output only. The Gemini model version this status corresponds to. Matches CoreSubscription.AgentSearchTokenSubscription.model_version (a stable Gemini model version from the Gemini Enterprise Agent Platform model-versions registry; see https://docs.cloud.google.com/gemini-enterprise-agent-platform/models/model-versions#gemini-models).", "type": "string" }, "tpmThresholdNextUpdateTime": { "type": "string", "description": "Output only. The earliest next update time for the TPM subscription threshold for this (project, model_version). Populated only after a successful update.", "readOnly": true, "format": "google-datetime" }, "terminateTime": { "readOnly": true, "type": "string", "description": "Output only. If set, the scheduled effective time at which this (project, model_version) Agent Search TPM subscription will terminate. Populated when the customer removes this entry from `core_subscription.agent_search_token_subscriptions[*]`. Does NOT move the whole-relationship `terminate_time` on the enclosing ConfigurableBillingStatus, which is populated only when the entire customer-configurable-pricing relationship is being torn down.", "format": "google-datetime" } }, "id": "GoogleCloudDiscoveryengineV1ProjectConfigurableBillingStatusAgentSearchTokenSubscriptionStatus", "description": "Per-model Agent Search TPM subscription status. One entry per active `core_subscription.agent_search_token_subscriptions[*]` entry in the customer-provided config; populated by UpdateProject and GetProject. The lifecycle scalars on this message (`start_time`, `terminate_time`, `update_type`, `tpm_threshold_next_update_time`) are per (project, model_version) — siblings of the whole-relationship `start_time` / `terminate_time` / `update_type` on the enclosing ConfigurableBillingStatus, but scoped to this specific Agent Search TPM subscription instead of to the overall customer-configurable- pricing relationship. This per-instance granularity is intentional: the underlying SubV3 storage is per-(project, model_version), so each model has its own activation, termination, and deferred-update clock; surfacing that on the response gives customers the granularity they need to manage per-model commitments independently. QPM / IndexingCore differ — their storage is one row per (project, location), so their lifecycle is represented only by the whole- relationship scalars on ConfigurableBillingStatus." }, "GoogleCloudDiscoveryengineV1alphaTargetSite": { "type": "object", "description": "A target site for the SiteSearchEngine.", "properties": { "updateTime": { "format": "google-datetime", "type": "string", "description": "Output only. The target site's last updated time.", "readOnly": true }, "rootDomainUri": { "type": "string", "readOnly": true, "description": "Output only. Root domain of the provided_uri_pattern." }, "siteVerificationInfo": { "description": "Output only. Site ownership and validity verification status.", "readOnly": true, "$ref": "GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo" }, "type": { "description": "The type of the target site, e.g., whether the site is to be included or excluded.", "type": "string", "enumDescriptions": [ "This value is unused. In this case, server behavior defaults to Type.INCLUDE.", "Include the target site.", "Exclude the target site." ], "enum": [ "TYPE_UNSPECIFIED", "INCLUDE", "EXCLUDE" ] }, "failureReason": { "$ref": "GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReason", "description": "Output only. Failure reason.", "readOnly": true }, "exactMatch": { "type": "boolean", "description": "Immutable. If set to false, a uri_pattern is generated to include all pages whose address contains the provided_uri_pattern. If set to true, an uri_pattern is generated to try to be an exact match of the provided_uri_pattern or just the specific page if the provided_uri_pattern is a specific one. provided_uri_pattern is always normalized to generate the URI pattern to be used by the search engine." }, "generatedUriPattern": { "readOnly": true, "description": "Output only. This is system-generated based on the provided_uri_pattern.", "type": "string" }, "name": { "type": "string", "description": "Output only. The fully qualified resource name of the target site. `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}` The `target_site_id` is system-generated.", "readOnly": true }, "providedUriPattern": { "type": "string", "description": "Required. Input only. The user provided URI pattern from which the `generated_uri_pattern` is generated." }, "indexingStatus": { "type": "string", "readOnly": true, "enumDescriptions": [ "Defaults to SUCCEEDED.", "The target site is in the update queue and will be picked up by indexing pipeline.", "The target site fails to be indexed.", "The target site has been indexed.", "The previously indexed target site has been marked to be deleted. This is a transitioning state which will resulted in either: 1. target site deleted if unindexing is successful; 2. state reverts to SUCCEEDED if the unindexing fails.", "The target site change is pending but cancellable.", "The target site change is cancelled." ], "description": "Output only. Indexing status.", "enum": [ "INDEXING_STATUS_UNSPECIFIED", "PENDING", "FAILED", "SUCCEEDED", "DELETING", "CANCELLABLE", "CANCELLED" ] } }, "id": "GoogleCloudDiscoveryengineV1alphaTargetSite" }, "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelPromptSpec": { "description": "Specification of the prompt to use with the model.", "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelPromptSpec", "type": "object", "properties": { "preamble": { "type": "string", "description": "Text at the beginning of the prompt that instructs the assistant. Examples are available in the user guide." } } }, "A2aV1SendMessageResponse": { "type": "object", "properties": { "message": { "$ref": "A2aV1Message" }, "task": { "$ref": "A2aV1Task" } }, "id": "A2aV1SendMessageResponse", "description": "////// Response Messages ///////////" }, "GoogleCloudDiscoveryengineV1Feedback": { "properties": { "feedbackType": { "enum": [ "FEEDBACK_TYPE_UNSPECIFIED", "LIKE", "DISLIKE" ], "description": "Required. Indicate whether the user gives a positive or negative feedback. If the user gives a negative feedback, there might be more feedback details.", "enumDescriptions": [ "Unspecified feedback type.", "The user gives a positive feedback.", "The user gives a negative feedback." ], "type": "string" }, "dataTermsAccepted": { "description": "Optional. Whether the customer accepted data use terms.", "type": "boolean" }, "reasons": { "items": { "type": "string", "enumDescriptions": [ "Unspecified reason.", "The response is inaccurate.", "The response is not relevant.", "The response is incomprehensive.", "The response is offensive or unsafe.", "The response is not well-formatted.", "The response is not well-associated with the query.", "The expected canvas was not generated for the response.", "The generated canvas is of bad quality (e.g. inaccurate, incomplete, poorly formatted).", "Exporting the generated canvas failed (e.g. download or external export action did not complete successfully)." ], "enum": [ "REASON_UNSPECIFIED", "INACCURATE_RESPONSE", "NOT_RELEVANT", "INCOMPREHENSIVE", "OFFENSIVE_OR_UNSAFE", "FORMAT_AND_STYLES", "BAD_CITATION", "CANVAS_NOT_GENERATED", "CANVAS_QUALITY_BAD", "CANVAS_EXPORT_FAILED" ] }, "description": "Optional. The reason if user gives a thumb down.", "type": "array" }, "conversationInfo": { "$ref": "GoogleCloudDiscoveryengineV1FeedbackConversationInfo", "description": "The related conversation information when user gives feedback." }, "componentVersion": { "type": "string", "description": "Optional. The version of the component that this report is being sent from." }, "feedbackSource": { "description": "Optional. The UI component the user feedback comes from, which could be GOOGLE_CONSOLE, GOOGLE_WIDGET, GOOGLE_WEBAPP.", "enumDescriptions": [ "Unspecified feedback source.", "Feedback source is Google Console.", "Feedback source is Google Widget.", "Feedback source is Google Webapp.", "Feedback source is Google AgentSpace Mobile app." ], "type": "string", "enum": [ "FEEDBACK_SOURCE_UNSPECIFIED", "GOOGLE_CONSOLE", "GOOGLE_WIDGET", "GOOGLE_WEBAPP", "GOOGLE_AGENTSPACE_MOBILE" ] }, "comment": { "description": "Optional. The additional user comment of the feedback if user gives a thumb down.", "type": "string" }, "llmModelVersion": { "description": "The version of the LLM model that was used to generate the response.", "type": "string" } }, "type": "object", "description": "Information about the user feedback. This information will be used for logging and metrics purpose.", "id": "GoogleCloudDiscoveryengineV1Feedback" }, "A2aV1Artifact": { "type": "object", "description": "Artifacts are the container for task completed results. These are similar to Messages but are intended to be the product of a task, as opposed to point-to-point communication.", "properties": { "extensions": { "type": "array", "items": { "type": "string" }, "description": "The URIs of extensions that are present or contributed to this Artifact." }, "name": { "type": "string", "description": "A human readable name for the artifact." }, "description": { "description": "A human readable description of the artifact, optional.", "type": "string" }, "artifactId": { "description": "Unique identifier (e.g. UUID) for the artifact. It must be at least unique within a task.", "type": "string" }, "parts": { "type": "array", "items": { "$ref": "A2aV1Part" }, "description": "The content of the artifact." }, "metadata": { "additionalProperties": { "description": "Properties of the object.", "type": "any" }, "type": "object", "description": "Optional metadata included with the artifact." } }, "id": "A2aV1Artifact" }, "GoogleCloudDiscoveryengineV1RankRequest": { "type": "object", "id": "GoogleCloudDiscoveryengineV1RankRequest", "description": "Request message for RankService.Rank method.", "properties": { "ignoreRecordDetailsInResponse": { "description": "If true, the response will contain only record ID and score. By default, it is false, the response will contain record details.", "type": "boolean" }, "topN": { "format": "int32", "type": "integer", "description": "The number of results to return. If this is unset or no bigger than zero, returns all results." }, "records": { "type": "array", "description": "Required. A list of records to rank.", "items": { "$ref": "GoogleCloudDiscoveryengineV1RankingRecord" } }, "userLabels": { "additionalProperties": { "type": "string" }, "type": "object", "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." }, "model": { "description": "The identifier of the model to use. It is one of: * `semantic-ranker-512@latest`: Semantic ranking model with maximum input token size 512. It is set to `semantic-ranker-512@latest` by default if unspecified.", "type": "string" }, "query": { "description": "The query to use.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesResponse": { "description": "Response message for CompletionService.ImportSuggestionDenyListEntries method.", "type": "object", "properties": { "importedEntriesCount": { "type": "string", "format": "int64", "description": "Count of deny list entries successfully imported." }, "errorSamples": { "description": "A sample of errors encountered while processing the request.", "items": { "$ref": "GoogleRpcStatus" }, "type": "array" }, "failedEntriesCount": { "format": "int64", "description": "Count of deny list entries that failed to be imported.", "type": "string" } }, "id": "GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesResponse" }, "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo": { "description": "Details about why a particular URI failed to be crawled. Each FailureInfo contains one FailureReason per CorpusType.", "id": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo", "properties": { "failureReasons": { "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason" }, "description": "List of failure reasons by corpus type (e.g. desktop, mobile).", "type": "array" }, "uri": { "description": "URI that failed to be crawled.", "type": "string" } }, "type": "object" }, "GoogleCloudDiscoveryengineV1alphaBAPConfig": { "properties": { "enabledActions": { "type": "array", "items": { "type": "string" }, "description": "Optional. The actions enabled on the associated BAP connection." }, "supportedConnectorModes": { "items": { "type": "string", "enumDescriptions": [ "Connector mode unspecified.", "Connector utilized for data ingestion.", "Connector utilized for Actions", "Connector utilized for End User Authentication." ], "enum": [ "CONNECTOR_MODE_UNSPECIFIED", "DATA_INGESTION", "ACTIONS", "END_USER_AUTHENTICATION" ] }, "type": "array", "description": "Required. The supported connector modes for the associated BAP connection." }, "toolspecOverride": { "$ref": "GoogleCloudDiscoveryengineV1alphaBAPConfigToolspecOverride", "description": "Optional. Custom toolspec overrides for this connection. For Enterprise BAP connectors that support admin-curated tool definitions, this holds the (simplified) per-tool overrides. On Get, populated by the server by merging persisted overrides with live runtime tool definitions and trimming the result for UI consumption. On Update, the supplied value replaces the persisted overrides after server-side validation and merging: the `base_version` field MUST match the server's current base toolspec version (otherwise the request is rejected with a user-facing error directing the admin to re-download the latest tools first)." } }, "type": "object", "description": "The configuration for the BAP connector.", "id": "GoogleCloudDiscoveryengineV1alphaBAPConfig" }, "GoogleCloudDiscoveryengineV1ImportIdentityMappingsRequestInlineSource": { "type": "object", "properties": { "identityMappingEntries": { "items": { "$ref": "GoogleCloudDiscoveryengineV1IdentityMappingEntry" }, "description": "A maximum of 10000 entries can be imported at one time", "type": "array" } }, "id": "GoogleCloudDiscoveryengineV1ImportIdentityMappingsRequestInlineSource", "description": "The inline source to import identity mapping entries from." }, "GoogleCloudDiscoveryengineV1AnswerStepAction": { "properties": { "searchAction": { "$ref": "GoogleCloudDiscoveryengineV1AnswerStepActionSearchAction", "description": "Search action." }, "observation": { "$ref": "GoogleCloudDiscoveryengineV1AnswerStepActionObservation", "description": "Observation." } }, "description": "Action.", "type": "object", "id": "GoogleCloudDiscoveryengineV1AnswerStepAction" }, "GoogleCloudDiscoveryengineV1UpdateTargetSiteMetadata": { "type": "object", "properties": { "updateTime": { "format": "google-datetime", "description": "Operation last update time. If the operation is done, this is also the finish time.", "type": "string" }, "createTime": { "description": "Operation create time.", "format": "google-datetime", "type": "string" } }, "description": "Metadata related to the progress of the SiteSearchEngineService.UpdateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1UpdateTargetSiteMetadata" }, "GoogleCloudDiscoveryengineV1SearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterExpression": { "id": "GoogleCloudDiscoveryengineV1SearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterExpression", "type": "object", "properties": { "numberConstraint": { "description": "Numerical constraint expression.", "$ref": "GoogleCloudDiscoveryengineV1SearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterNumberConstraint" }, "stringConstraint": { "description": "String constraint expression.", "$ref": "GoogleCloudDiscoveryengineV1SearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterStringConstraint" }, "andExpr": { "$ref": "GoogleCloudDiscoveryengineV1SearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterAndExpression", "description": "Logical \"And\" compound operator connecting multiple expressions." }, "orExpr": { "$ref": "GoogleCloudDiscoveryengineV1SearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterOrExpression", "description": "Logical \"Or\" compound operator connecting multiple expressions." }, "geolocationConstraint": { "description": "Geolocation constraint expression.", "$ref": "GoogleCloudDiscoveryengineV1SearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterGeolocationConstraint" } }, "description": "The expression denoting the filter that was extracted from the input query." }, "GoogleCloudDiscoveryengineV1ConditionTimeRange": { "type": "object", "properties": { "endTime": { "type": "string", "description": "End of time range. Range is inclusive. Must be in the future.", "format": "google-datetime" }, "startTime": { "type": "string", "format": "google-datetime", "description": "Start of time range. Range is inclusive." } }, "id": "GoogleCloudDiscoveryengineV1ConditionTimeRange", "description": "Used for time-dependent conditions." }, "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSnippetSpec": { "properties": { "referenceOnly": { "type": "boolean", "deprecated": true, "description": "[DEPRECATED] This field is deprecated and will have no affect on the snippet." }, "returnSnippet": { "description": "If `true`, then return snippet. If no snippet can be generated, we return \"No snippet is available for this page.\" A `snippet_status` with `SUCCESS` or `NO_SNIPPET_AVAILABLE` will also be returned.", "type": "boolean" }, "maxSnippetCount": { "format": "int32", "type": "integer", "description": "[DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count \u003e 0.", "deprecated": true } }, "description": "A specification for configuring snippets in a search response.", "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSnippetSpec", "type": "object" }, "GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfigDataProtectionPolicy": { "id": "GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfigDataProtectionPolicy", "type": "object", "description": "Data protection policy config for NotebookLM.", "properties": { "sensitiveDataProtectionPolicy": { "description": "Optional. The sensitive data protection policy.", "$ref": "GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfigDataProtectionPolicySensitiveDataProtectionPolicy" } } }, "GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig": { "id": "GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig", "type": "object", "properties": { "responseTemplate": { "description": "Optional. The resource name of the Model Armor Template for sanitizing LLM responses. Format: projects/{project}/locations/{location}/templates/{template_id} If not specified, no sanitization will be applied to the LLM response.", "type": "string" }, "userPromptTemplate": { "type": "string", "description": "Optional. The resource name of the Model Armor Template for sanitizing user prompts. Format: projects/{project}/locations/{location}/templates/{template_id} If not specified, no sanitization will be applied to the user prompt." } }, "description": "Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and LLM responses." }, "A2aV1ClientCredentialsOAuthFlow": { "type": "object", "properties": { "refreshUrl": { "description": "The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS.", "type": "string" }, "scopes": { "description": "The available scopes for the OAuth2 security scheme. A map between the scope name and a short description for it. The map MAY be empty.", "additionalProperties": { "type": "string" }, "type": "object" }, "tokenUrl": { "type": "string", "description": "The token URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS." } }, "id": "A2aV1ClientCredentialsOAuthFlow" }, "GoogleTypeExpr": { "type": "object", "description": "Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: \"Summary size limit\" description: \"Determines if a summary is less than 100 chars\" expression: \"document.summary.size() \u003c 100\" Example (Equality): title: \"Requestor is owner\" description: \"Determines if requestor is the document owner\" expression: \"document.owner == request.auth.claims.email\" Example (Logic): title: \"Public documents\" description: \"Determine whether the document should be publicly visible\" expression: \"document.type != 'private' && document.type != 'internal'\" Example (Data Manipulation): title: \"Notification string\" description: \"Create a notification string with a timestamp.\" expression: \"'New message received at ' + string(document.create_time)\" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.", "id": "GoogleTypeExpr", "properties": { "description": { "type": "string", "description": "Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI." }, "expression": { "description": "Textual representation of an expression in Common Expression Language syntax.", "type": "string" }, "location": { "type": "string", "description": "Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file." }, "title": { "description": "Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1UserLicense": { "type": "object", "properties": { "userProfile": { "description": "Optional. The user profile. We user user full name(First name + Last name) as user profile.", "type": "string" }, "updateTime": { "format": "google-datetime", "type": "string", "readOnly": true, "description": "Output only. User update timestamp." }, "licenseAssignmentState": { "readOnly": true, "enumDescriptions": [ "Default value.", "License assigned to the user.", "No license assigned to the user. Deprecated, translated to NO_LICENSE.", "No license assigned to the user.", "User attempted to login but no license assigned to the user. This state is only used for no user first time login attempt but cannot get license assigned. Users already logged in but cannot get license assigned will be assigned NO_LICENSE state(License could be unassigned by admin).", "User is blocked from assigning a license." ], "enum": [ "LICENSE_ASSIGNMENT_STATE_UNSPECIFIED", "ASSIGNED", "UNASSIGNED", "NO_LICENSE", "NO_LICENSE_ATTEMPTED_LOGIN", "BLOCKED" ], "description": "Output only. License assignment state of the user. If the user is assigned with a license config, the user login will be assigned with the license; If the user's license assignment state is unassigned or unspecified, no license config will be associated to the user;", "type": "string" }, "createTime": { "format": "google-datetime", "readOnly": true, "type": "string", "description": "Output only. User created timestamp." }, "lastLoginTime": { "type": "string", "readOnly": true, "format": "google-datetime", "description": "Output only. User last logged in time. If the user has not logged in yet, this field will be empty." }, "userPrincipal": { "description": "Required. Immutable. The user principal of the User, could be email address or other prinical identifier. This field is immutable. Admin assign licenses based on the user principal.", "type": "string" }, "licenseConfig": { "description": "Optional. The full resource name of the Subscription(LicenseConfig) assigned to the user.", "type": "string" } }, "description": "User License information assigned by the admin.", "id": "GoogleCloudDiscoveryengineV1UserLicense" }, "GoogleCloudDiscoveryengineV1IdpConfig": { "type": "object", "description": "Identity Provider Config.", "properties": { "externalIdpConfig": { "$ref": "GoogleCloudDiscoveryengineV1IdpConfigExternalIdpConfig", "description": "External Identity provider config." }, "idpType": { "enum": [ "IDP_TYPE_UNSPECIFIED", "GSUITE", "THIRD_PARTY" ], "type": "string", "description": "Identity provider type configured.", "enumDescriptions": [ "Default value. ACL search not enabled.", "Google 1P provider.", "Third party provider." ] } }, "id": "GoogleCloudDiscoveryengineV1IdpConfig" }, "GoogleCloudDiscoveryengineV1ListServingConfigsResponse": { "id": "GoogleCloudDiscoveryengineV1ListServingConfigsResponse", "type": "object", "description": "Response for ListServingConfigs method.", "properties": { "servingConfigs": { "description": "All the ServingConfigs for a given dataStore.", "items": { "$ref": "GoogleCloudDiscoveryengineV1ServingConfig" }, "type": "array" }, "nextPageToken": { "type": "string", "description": "Pagination token, if not returned indicates the last page." } } }, "GoogleCloudDiscoveryengineV1betaLicenseConfig": { "description": "Information about users' licenses.", "id": "GoogleCloudDiscoveryengineV1betaLicenseConfig", "type": "object", "properties": { "subscriptionTier": { "description": "Required. Subscription tier information for the license config.", "enumDescriptions": [ "Default value.", "Search tier. Search tier can access Vertex AI Search features and NotebookLM features.", "Gemini Enterprise Plus tier.", "NotebookLM tier. NotebookLM is a subscription tier can only access NotebookLM features.", "Gemini Frontline worker tier.", "Gemini Business Starter tier.", "Gemini Business tier.", "Gemini Enterprise Standard tier.", "Gemini Enterprise Standard tier for emerging markets.", "Gemini Enterprise EDU tier.", "Gemini Enterprise EDU Pro tier.", "Gemini Enterprise EDU tier for emerging market only.", "Gemini Enterprise EDU Pro tier for emerging market.", "Gemini Frontline Starter tier.", "Represents the Gemini Enterprise Consumption-only tier: $0 subscription billed purely on usage (PAYG).", "Gemini Enterprise EDU tier for government in emerging markets." ], "type": "string", "enum": [ "SUBSCRIPTION_TIER_UNSPECIFIED", "SUBSCRIPTION_TIER_SEARCH", "SUBSCRIPTION_TIER_SEARCH_AND_ASSISTANT", "SUBSCRIPTION_TIER_NOTEBOOK_LM", "SUBSCRIPTION_TIER_FRONTLINE_WORKER", "SUBSCRIPTION_TIER_AGENTSPACE_STARTER", "SUBSCRIPTION_TIER_AGENTSPACE_BUSINESS", "SUBSCRIPTION_TIER_ENTERPRISE", "SUBSCRIPTION_TIER_ENTERPRISE_EMERGING", "SUBSCRIPTION_TIER_EDU", "SUBSCRIPTION_TIER_EDU_PRO", "SUBSCRIPTION_TIER_EDU_EMERGING", "SUBSCRIPTION_TIER_EDU_PRO_EMERGING", "SUBSCRIPTION_TIER_FRONTLINE_STARTER", "SUBSCRIPTION_TIER_CONSUMPTION_ONLY", "SUBSCRIPTION_TIER_EDU_GOV_EMERGING" ] }, "earlyTerminationDate": { "description": "Output only. The date when the subscription is terminated earlier than the expiration date.", "$ref": "GoogleTypeDate", "readOnly": true }, "name": { "description": "Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project}/locations/{location}/licenseConfigs/{license_config}`", "type": "string" }, "licenseCount": { "type": "string", "format": "int64", "description": "Required. Number of licenses purchased." }, "lastUserUpdateTime": { "format": "google-datetime", "type": "string", "description": "Optional. Timestamp of the most recent user-initiated update (seat count change or subscription term change). Unlike `update_time`, this field is only stamped when a customer explicitly updates the license (e.g. via the UI), and is not touched by system-driven writes (subscription pipeline, BALC propagation, etc.)." }, "subscriptionTerm": { "description": "Required. Subscription term.", "type": "string", "enumDescriptions": [ "Default value, do not use.", "1 month.", "1 year.", "3 years.", "Custom term. Must set the end_date." ], "enum": [ "SUBSCRIPTION_TERM_UNSPECIFIED", "SUBSCRIPTION_TERM_ONE_MONTH", "SUBSCRIPTION_TERM_ONE_YEAR", "SUBSCRIPTION_TERM_THREE_YEARS", "SUBSCRIPTION_TERM_CUSTOM" ] }, "endDate": { "$ref": "GoogleTypeDate", "description": "Optional. The planed end date." }, "earlyTerminated": { "readOnly": true, "type": "boolean", "description": "Output only. Indication of whether the subscription is terminated earlier than the expiration date. This is usually terminated by pipeline once the subscription gets terminated from subsv3." }, "startDate": { "description": "Required. The start date.", "$ref": "GoogleTypeDate" }, "autoRenew": { "type": "boolean", "description": "Optional. Whether the license config should be auto renewed when it reaches the end date." }, "geminiBundle": { "description": "Output only. Whether the license config is for Gemini bundle.", "readOnly": true, "type": "boolean" }, "state": { "type": "string", "enumDescriptions": [ "Default value. The license config does not exist.", "The license config is effective and being used.", "The license config has expired.", "The license config has not started yet, and its start date is in the future.", "This is when a sub license config has returned all its seats back to BillingAccountLicenseConfig that it belongs to. Similar to EXPIRED.", "The license config is terminated earlier than the expiration date and it is deactivating. The customer will still have access in this state. It will be converted to EXPIRED after the deactivating period ends (14 days) or when the end date is reached, whichever comes first." ], "description": "Output only. The state of the license config.", "enum": [ "STATE_UNSPECIFIED", "ACTIVE", "EXPIRED", "NOT_STARTED", "WITHDRAWN", "DEACTIVATING" ], "readOnly": true }, "freeTrial": { "description": "Optional. Whether the license config is for free trial.", "type": "boolean" } } }, "GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfigDataProtectionPolicy": { "id": "GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfigDataProtectionPolicy", "description": "Data protection policy config for NotebookLM.", "type": "object", "properties": { "sensitiveDataProtectionPolicy": { "$ref": "GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfigDataProtectionPolicySensitiveDataProtectionPolicy", "description": "Optional. The sensitive data protection policy." } } }, "GoogleCloudDiscoveryengineV1Answer": { "description": "Defines an answer.", "properties": { "completeTime": { "description": "Output only. Answer completed timestamp.", "type": "string", "format": "google-datetime", "readOnly": true }, "groundingSupports": { "items": { "$ref": "GoogleCloudDiscoveryengineV1AnswerGroundingSupport" }, "type": "array", "description": "Optional. Grounding supports." }, "references": { "description": "References.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1AnswerReference" } }, "queryUnderstandingInfo": { "$ref": "GoogleCloudDiscoveryengineV1AnswerQueryUnderstandingInfo", "description": "Query understanding information." }, "citations": { "items": { "$ref": "GoogleCloudDiscoveryengineV1AnswerCitation" }, "description": "Citations.", "type": "array" }, "safetyRatings": { "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1SafetyRating" }, "description": "Optional. Safety ratings." }, "name": { "description": "Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*/answers/*`", "type": "string" }, "groundingScore": { "type": "number", "format": "double", "description": "A score in the range of [0, 1] describing how grounded the answer is by the reference chunks." }, "answerSkippedReasons": { "description": "Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.", "type": "array", "items": { "type": "string", "enum": [ "ANSWER_SKIPPED_REASON_UNSPECIFIED", "ADVERSARIAL_QUERY_IGNORED", "NON_ANSWER_SEEKING_QUERY_IGNORED", "OUT_OF_DOMAIN_QUERY_IGNORED", "POTENTIAL_POLICY_VIOLATION", "NO_RELEVANT_CONTENT", "JAIL_BREAKING_QUERY_IGNORED", "CUSTOMER_POLICY_VIOLATION", "NON_ANSWER_SEEKING_QUERY_IGNORED_V2", "LOW_GROUNDED_ANSWER", "USER_DEFINED_CLASSIFICATION_QUERY_IGNORED", "UNHELPFUL_ANSWER" ], "enumDescriptions": [ "Default value. The answer skipped reason is not specified.", "The adversarial query ignored case.", "The non-answer seeking query ignored case Google skips the answer if the query is chit chat.", "The out-of-domain query ignored case. Google skips the answer if there are no high-relevance search results.", "The potential policy violation case. Google skips the answer if there is a potential policy violation detected. This includes content that may be violent or toxic.", "The no relevant content case. Google skips the answer if there is no relevant content in the retrieved search results.", "The jail-breaking query ignored case. For example, \"Reply in the tone of a competing company's CEO\". Google skips the answer if the query is classified as a jail-breaking query.", "The customer policy violation case. Google skips the summary if there is a customer policy violation detected. The policy is defined by the customer.", "The non-answer seeking query ignored case. Google skips the answer if the query doesn't have clear intent.", "The low-grounded answer case. Google skips the answer if a well grounded answer was unable to be generated.", "The user defined query classification ignored case. Google skips the answer if the query is classified as a user defined query classification.", "The unhelpful answer case. Google skips the answer if the answer is not helpful. This can be due to a variety of factors, including but not limited to: the query is not answerable, the answer is not relevant to the query, or the answer is not well-formatted." ] } }, "createTime": { "format": "google-datetime", "readOnly": true, "description": "Output only. Answer creation timestamp.", "type": "string" }, "answerText": { "description": "The textual answer.", "type": "string" }, "relatedQuestions": { "items": { "type": "string" }, "description": "Suggested related questions.", "type": "array" }, "steps": { "description": "Answer generation steps.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1AnswerStep" } }, "state": { "enumDescriptions": [ "Unknown.", "Answer generation is currently in progress.", "Answer generation currently failed.", "Answer generation has succeeded.", "Answer generation is currently in progress." ], "type": "string", "description": "The state of the answer generation.", "enum": [ "STATE_UNSPECIFIED", "IN_PROGRESS", "FAILED", "SUCCEEDED", "STREAMING" ] } }, "id": "GoogleCloudDiscoveryengineV1Answer", "type": "object" }, "GoogleCloudDiscoveryengineV1Schema": { "type": "object", "description": "Defines the structure and layout of a type of document data.", "id": "GoogleCloudDiscoveryengineV1Schema", "properties": { "jsonSchema": { "type": "string", "description": "The JSON representation of the schema." }, "structSchema": { "description": "The structured representation of the schema.", "additionalProperties": { "type": "any", "description": "Properties of the object." }, "type": "object" }, "name": { "type": "string", "description": "Immutable. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters." } } }, "GoogleCloudDiscoveryengineV1alphaFieldConfig": { "properties": { "recsFilterableOption": { "enumDescriptions": [ "Value used when unset.", "Filterable option enabled for a schema field.", "Filterable option disabled for a schema field." ], "enum": [ "FILTERABLE_OPTION_UNSPECIFIED", "FILTERABLE_ENABLED", "FILTERABLE_DISABLED" ], "type": "string", "description": "If recs_filterable_option is FILTERABLE_ENABLED, field values are filterable by filter expression in RecommendationService.Recommend. If FILTERABLE_ENABLED but the field type is numerical, field values are not filterable by text queries in RecommendationService.Recommend. Only textual fields are supported. If recs_filterable_option is unset, the default setting is FILTERABLE_DISABLED for fields that support setting filterable options. When a field set to [FILTERABLE_DISABLED] is filtered, a warning is generated and an empty result is returned." }, "completableOption": { "enumDescriptions": [ "Value used when unset.", "Completable option enabled for a schema field.", "Completable option disabled for a schema field." ], "enum": [ "COMPLETABLE_OPTION_UNSPECIFIED", "COMPLETABLE_ENABLED", "COMPLETABLE_DISABLED" ], "description": "If completable_option is COMPLETABLE_ENABLED, field values are directly used and returned as suggestions for Autocomplete in CompletionService.CompleteQuery. If completable_option is unset, the server behavior defaults to COMPLETABLE_DISABLED for fields that support setting completable options, which are just `string` fields. For those fields that do not support setting completable options, the server will skip completable option setting, and setting completable_option for those fields will throw `INVALID_ARGUMENT` error.", "type": "string" }, "searchableOption": { "description": "If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error.", "enumDescriptions": [ "Value used when unset.", "Searchable option enabled for a schema field.", "Searchable option disabled for a schema field." ], "enum": [ "SEARCHABLE_OPTION_UNSPECIFIED", "SEARCHABLE_ENABLED", "SEARCHABLE_DISABLED" ], "type": "string" }, "fieldType": { "readOnly": true, "type": "string", "description": "Output only. Raw type of the field.", "enum": [ "FIELD_TYPE_UNSPECIFIED", "OBJECT", "STRING", "NUMBER", "INTEGER", "BOOLEAN", "GEOLOCATION", "DATETIME" ], "enumDescriptions": [ "Field type is unspecified.", "Field value type is Object.", "Field value type is String.", "Field value type is Number.", "Field value type is Integer.", "Field value type is Boolean.", "Field value type is Geolocation. Geolocation is expressed as an object with the following keys: * `id`: a string representing the location id * `longitude`: a number representing the longitude coordinate of the location * `latitude`: a number repesenting the latitude coordinate of the location * `address`: a string representing the full address of the location `latitude` and `longitude` must always be provided together. At least one of a) `address` or b) `latitude`-`longitude` pair must be provided.", "Field value type is Datetime. Datetime can be expressed as either: * a number representing milliseconds-since-the-epoch * a string representing milliseconds-since-the-epoch. e.g. `\"1420070400001\"` * a string representing the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date or date and time. e.g. `\"2015-01-01\"` or `\"2015-01-01T12:10:30Z\"`" ] }, "keyPropertyType": { "readOnly": true, "description": "Output only. Type of the key property that this field is mapped to. Empty string if this is not annotated as mapped to a key property. Example types are `title`, `description`. Full list is defined by `keyPropertyMapping` in the schema field annotation. If the schema field has a `KeyPropertyMapping` annotation, `indexable_option` and `searchable_option` of this field cannot be modified.", "type": "string" }, "indexableOption": { "enumDescriptions": [ "Value used when unset.", "Indexable option enabled for a schema field.", "Indexable option disabled for a schema field." ], "type": "string", "description": "If indexable_option is INDEXABLE_ENABLED, field values are indexed so that it can be filtered or faceted in SearchService.Search. If indexable_option is unset, the server behavior defaults to INDEXABLE_DISABLED for fields that support setting indexable options. For those fields that do not support setting indexable options, such as `object` and `boolean` and key properties, the server will skip indexable_option setting, and setting indexable_option for those fields will throw `INVALID_ARGUMENT` error.", "enum": [ "INDEXABLE_OPTION_UNSPECIFIED", "INDEXABLE_ENABLED", "INDEXABLE_DISABLED" ] }, "retrievableOption": { "enumDescriptions": [ "Value used when unset.", "Retrievable option enabled for a schema field.", "Retrievable option disabled for a schema field." ], "enum": [ "RETRIEVABLE_OPTION_UNSPECIFIED", "RETRIEVABLE_ENABLED", "RETRIEVABLE_DISABLED" ], "type": "string", "description": "If retrievable_option is RETRIEVABLE_ENABLED, field values are included in the search results. If retrievable_option is unset, the server behavior defaults to RETRIEVABLE_DISABLED for fields that support setting retrievable options. For those fields that do not support setting retrievable options, such as `object` and `boolean`, the server will skip retrievable option setting, and setting retrievable_option for those fields will throw `INVALID_ARGUMENT` error." }, "searchableFieldImportance": { "enumDescriptions": [ "Value used when unset. Behaves as `DEFAULT_IMPORTANCE` if the field is searchable.", "Provides a tiny signal for search.", "Indicates the field is used for search, but is less important than the default.", "Default importance. Equivalent to previous behavior.", "More important than default fields.", "Most important field for search." ], "description": "Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`. For more information, see [Weight searchable fields](https://cloud.google.com/generative-ai-app-builder/docs/configure-field-settings#weight-search).", "enum": [ "SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED", "VERY_LOW_IMPORTANCE", "LOW_IMPORTANCE", "DEFAULT_IMPORTANCE", "HIGH_IMPORTANCE", "VERY_HIGH_IMPORTANCE" ], "type": "string" }, "dynamicFacetableOption": { "enum": [ "DYNAMIC_FACETABLE_OPTION_UNSPECIFIED", "DYNAMIC_FACETABLE_ENABLED", "DYNAMIC_FACETABLE_DISABLED" ], "type": "string", "enumDescriptions": [ "Value used when unset.", "Dynamic facetable option enabled for a schema field.", "Dynamic facetable option disabled for a schema field." ], "description": "If dynamic_facetable_option is DYNAMIC_FACETABLE_ENABLED, field values are available for dynamic facet. Could only be DYNAMIC_FACETABLE_DISABLED if FieldConfig.indexable_option is INDEXABLE_DISABLED. Otherwise, an `INVALID_ARGUMENT` error will be returned. If dynamic_facetable_option is unset, the server behavior defaults to DYNAMIC_FACETABLE_DISABLED for fields that support setting dynamic facetable options. For those fields that do not support setting dynamic facetable options, such as `object` and `boolean`, the server will skip dynamic facetable option setting, and setting dynamic_facetable_option for those fields will throw `INVALID_ARGUMENT` error." }, "schemaOrgPaths": { "type": "array", "description": "Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished", "items": { "type": "string" } }, "fieldPath": { "description": "Required. Field path of the schema field. For example: `title`, `description`, `release_info.release_year`.", "type": "string" }, "metatagName": { "description": "Optional. The metatag name found in the HTML page. If user defines this field, the value of this metatag name will be used to extract metatag. If the user does not define this field, the FieldConfig.field_path will be used to extract metatag.", "type": "string" }, "advancedSiteSearchDataSources": { "description": "If this field is set, only the corresponding source will be indexed for this field. Otherwise, the values from different sources are merged. Assuming a page with `` in meta tag, and `` in page map: if this enum is set to METATAGS, we will only index ``; if this enum is not set, we will merge them and index ``.", "items": { "enumDescriptions": [ "Value used when unset.", "Retrieve value from meta tag.", "Retrieve value from page map.", "Retrieve value from the attributes set by SiteSearchEngineService.SetUriPatternDocumentData API.", "Retrieve value from schema.org data." ], "enum": [ "ADVANCED_SITE_SEARCH_DATA_SOURCE_UNSPECIFIED", "METATAGS", "PAGEMAP", "URI_PATTERN_MAPPING", "SCHEMA_ORG" ], "type": "string" }, "type": "array" } }, "id": "GoogleCloudDiscoveryengineV1alphaFieldConfig", "description": "Configurations for fields of a schema. For example, configuring a field is indexable, or searchable.", "type": "object" }, "GoogleCloudDiscoveryengineV1ImportDocumentsRequest": { "type": "object", "properties": { "bigquerySource": { "description": "BigQuery input source.", "$ref": "GoogleCloudDiscoveryengineV1BigQuerySource" }, "updateMask": { "description": "Indicates which fields in the provided imported documents to update. If not set, the default is to update all fields.", "type": "string", "format": "google-fieldmask" }, "firestoreSource": { "$ref": "GoogleCloudDiscoveryengineV1FirestoreSource", "description": "Firestore input source." }, "inlineSource": { "$ref": "GoogleCloudDiscoveryengineV1ImportDocumentsRequestInlineSource", "description": "The Inline source for the input content for documents." }, "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" }, "gcsSource": { "description": "Cloud Storage location for the input content.", "$ref": "GoogleCloudDiscoveryengineV1GcsSource" }, "cloudSqlSource": { "description": "Cloud SQL input source.", "$ref": "GoogleCloudDiscoveryengineV1CloudSqlSource" }, "spannerSource": { "description": "Spanner input source.", "$ref": "GoogleCloudDiscoveryengineV1SpannerSource" }, "idField": { "description": "The field indicates the ID field or column to be used as unique IDs of the documents. For GcsSource it is the key of the JSON field. For instance, `my_id` for JSON `{\"my_id\": \"some_uuid\"}`. For others, it may be the column name of the table where the unique ids are stored. The values of the JSON field or the table column are used as the Document.ids. The JSON field or the table column must be of string type, and the values must be set as valid strings conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) with 1-63 characters. Otherwise, documents without valid IDs fail to be imported. Only set this field when auto_generate_ids is unset or set as `false`. Otherwise, an INVALID_ARGUMENT error is thrown. If it is unset, a default value `_id` is used when importing from the allowed data sources. 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. * BigtableSource.", "type": "string" }, "fhirStoreSource": { "$ref": "GoogleCloudDiscoveryengineV1FhirStoreSource", "description": "FhirStore input source." }, "errorConfig": { "$ref": "GoogleCloudDiscoveryengineV1ImportErrorConfig", "description": "The desired location of errors incurred during the Import." }, "reconciliationMode": { "description": "The mode of reconciliation between existing documents and the documents to be imported. Defaults to ReconciliationMode.INCREMENTAL.", "enum": [ "RECONCILIATION_MODE_UNSPECIFIED", "INCREMENTAL", "FULL" ], "type": "string", "enumDescriptions": [ "Defaults to `INCREMENTAL`.", "Inserts new documents or updates existing documents.", "Calculates diff and replaces the entire document dataset. Existing documents may be deleted if they are not present in the source location. When using this mode, there won't be any downtime on the dataset targeted. Any document that should remain unchanged or that should be updated will continue serving while the operation is running." ] }, "alloyDbSource": { "description": "AlloyDB input source.", "$ref": "GoogleCloudDiscoveryengineV1AlloyDbSource" }, "forceRefreshContent": { "description": "Optional. Whether to force refresh the unstructured content of the documents. If set to `true`, the content part of the documents will be refreshed regardless of the update status of the referencing content.", "type": "boolean" }, "bigtableSource": { "description": "Cloud Bigtable input source.", "$ref": "GoogleCloudDiscoveryengineV1BigtableSource" } }, "description": "Request message for Import methods.", "id": "GoogleCloudDiscoveryengineV1ImportDocumentsRequest" }, "GoogleCloudDiscoveryengineV1alphaDataConnectorEndUserConfig": { "id": "GoogleCloudDiscoveryengineV1alphaDataConnectorEndUserConfig", "properties": { "jsonAuthParams": { "description": "Optional. Any authentication parameters specific to EUA connectors in json string format.", "type": "string" }, "additionalParams": { "description": "Optional. Any additional parameters needed for EUA.", "additionalProperties": { "type": "any", "description": "Properties of the object." }, "type": "object" }, "authParams": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." }, "description": "Optional. Any authentication parameters specific to EUA connectors." }, "tenant": { "$ref": "GoogleCloudDiscoveryengineV1alphaTenant", "description": "Optional. The tenant project the connector is connected to." } }, "type": "object", "description": "Any params and credentials used specifically for EUA connectors." }, "GoogleCloudDiscoveryengineV1ListConversationsResponse": { "properties": { "nextPageToken": { "description": "Pagination token, if not returned indicates the last page.", "type": "string" }, "conversations": { "type": "array", "description": "All the Conversations for a given data store.", "items": { "$ref": "GoogleCloudDiscoveryengineV1Conversation" } } }, "description": "Response for ListConversations method.", "id": "GoogleCloudDiscoveryengineV1ListConversationsResponse", "type": "object" }, "GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceScoreSpec": { "id": "GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceScoreSpec", "type": "object", "description": "The specification for returning the document relevance score.", "properties": { "returnRelevanceScore": { "type": "boolean", "description": "Optional. Whether to return the relevance score for search results. The higher the score, the more relevant the document is to the query." } } }, "GoogleCloudDiscoveryengineV1WidgetConfigNode": { "properties": { "type": { "type": "string", "readOnly": true, "description": "Output only. The type of the node.", "enumDescriptions": [ "Unspecified type.", "Trigger type.", "Flow type.", "Connector type." ], "enum": [ "TYPE_UNSPECIFIED", "TRIGGER", "FLOW", "CONNECTOR" ] }, "description": { "readOnly": true, "type": "string", "description": "Output only. A detailed description of what the node does." }, "outputSchema": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "description": "Output only. The output schema of the tool. This schema is expected to conform to the OpenAPI Schema standard (see https://spec.openapis.org/oas/v3.0.3.html/ and AIP-146). It describes the structure of the output produced by this node.", "readOnly": true, "type": "object" }, "iconUrl": { "type": "string", "readOnly": true, "description": "Output only. An identifier or URL pointing to an icon representing this node type." }, "displayName": { "readOnly": true, "description": "Output only. A human readable name for the node.", "type": "string" }, "parameterSchema": { "type": "object", "description": "Output only. The parameter schema of the tool. This schema is expected to conform to the OpenAPI Schema standard (see https://spec.openapis.org/oas/v3.0.3.html and AIP-146). It describes the expected structure of the parameters that this node accepts.", "readOnly": true, "additionalProperties": { "description": "Properties of the object.", "type": "any" } } }, "id": "GoogleCloudDiscoveryengineV1WidgetConfigNode", "type": "object", "description": "Represents a single reusable computational or logical unit." }, "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigDigitalParsingConfig": { "description": "The digital parsing configurations for documents.", "properties": {}, "id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigDigitalParsingConfig", "type": "object" }, "GoogleCloudDiscoveryengineV1CmekConfig": { "type": "object", "id": "GoogleCloudDiscoveryengineV1CmekConfig", "description": "Configurations used to enable CMEK data encryption with Cloud KMS keys.", "properties": { "lastRotationTimestampMicros": { "format": "int64", "description": "Output only. The timestamp of the last key rotation.", "type": "string", "readOnly": true }, "state": { "enum": [ "STATE_UNSPECIFIED", "CREATING", "ACTIVE", "KEY_ISSUE", "DELETING", "DELETE_FAILED", "UNUSABLE", "ACTIVE_ROTATING", "DELETED", "EXPIRED" ], "description": "Output only. The states of the CmekConfig.", "type": "string", "readOnly": true, "enumDescriptions": [ "The CmekConfig state is unknown.", "The CmekConfig is creating.", "The CmekConfig can be used with DataStores.", "The CmekConfig is unavailable, most likely due to the KMS Key being revoked.", "The CmekConfig is deleting.", "The CmekConfig deletion process failed.", "The CmekConfig is not usable, most likely due to some internal issue.", "The KMS key version is being rotated.", "The KMS key is soft deleted. Some cleanup policy will eventually be applied.", "The KMS key is expired, meaning the key has been disabled for 30+ days. The customer can call DeleteCmekConfig to change the state to DELETED." ] }, "notebooklmState": { "enum": [ "NOTEBOOK_LM_STATE_UNSPECIFIED", "NOTEBOOK_LM_NOT_READY", "NOTEBOOK_LM_READY", "NOTEBOOK_LM_NOT_ENABLED" ], "readOnly": true, "enumDescriptions": [ "The NotebookLM state is unknown.", "The NotebookLM is not ready.", "The NotebookLM is ready to be used.", "The NotebookLM is not enabled." ], "type": "string", "description": "Output only. Whether the NotebookLM Corpus is ready to be used." }, "kmsKeyVersion": { "type": "string", "description": "Output only. KMS key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`.", "readOnly": true }, "name": { "description": "Required. The name of the CmekConfig of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmek_config}`.", "type": "string" }, "singleRegionKeys": { "description": "Optional. Single-regional CMEKs that are required for some VAIS features.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1SingleRegionKey" } }, "isDefault": { "description": "Output only. The default CmekConfig for the Customer.", "type": "boolean", "readOnly": true }, "kmsKey": { "description": "Required. KMS key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1alphaActionConfig": { "description": "Informations to support actions on the connector.", "id": "GoogleCloudDiscoveryengineV1alphaActionConfig", "properties": { "userDefinedScopesMapping": { "description": "Optional. Mapping from operation name to the list of scopes. Only be populated if there are user specified scopes.", "type": "object", "additionalProperties": { "$ref": "GoogleCloudDiscoveryengineV1alphaActionConfigScopeList" } }, "useStaticSecrets": { "description": "Optional. Whether to use static secrets for the connector. If true, the secrets provided in the action_params will be ignored.", "type": "boolean" }, "actionParams": { "type": "object", "description": "Optional. Action parameters in structured json format.", "additionalProperties": { "description": "Properties of the object.", "type": "any" } }, "isActionConfigured": { "description": "Output only. The connector contains the necessary parameters and is configured to support actions.", "readOnly": true, "type": "boolean" }, "serviceName": { "description": "Optional. The Service Directory resource name (projects/*/locations/*/namespaces/*/services/*) representing a VPC network endpoint used to connect to the data source's `instance_uri`, defined in DataConnector.params. Required when VPC Service Controls are enabled.", "type": "string" }, "createBapConnection": { "description": "Optional. Whether to create a BAP connection for the connector.", "type": "boolean" }, "jsonActionParams": { "type": "string", "description": "Optional. Action parameters in json string format." } }, "type": "object" }, "GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResultModelArmorEnforcementResult": { "type": "object", "id": "GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResultModelArmorEnforcementResult", "description": "Customer policy enforcement result for the Model Armor policy.", "properties": { "error": { "description": "The error returned by Model Armor if the policy enforcement failed for some reason.", "$ref": "GoogleRpcStatus" }, "modelArmorViolation": { "description": "The Model Armor violation that was found.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1betaAdvancedSiteSearchConfig": { "properties": { "disableAutomaticRefresh": { "description": "If set true, automatic refresh is disabled for the DataStore.", "type": "boolean" }, "disableInitialIndex": { "type": "boolean", "description": "If set true, initial indexing is disabled for the DataStore." } }, "type": "object", "id": "GoogleCloudDiscoveryengineV1betaAdvancedSiteSearchConfig", "description": "Configuration data for advance site search." }, "GoogleCloudDiscoveryengineV1AnswerQueryRequestEndUserSpecEndUserMetaDataChunkInfo": { "description": "Chunk information.", "type": "object", "properties": { "content": { "type": "string", "description": "Chunk textual content. It is limited to 8000 characters." }, "documentMetadata": { "$ref": "GoogleCloudDiscoveryengineV1AnswerQueryRequestEndUserSpecEndUserMetaDataChunkInfoDocumentMetadata", "description": "Metadata of the document from the current chunk." } }, "id": "GoogleCloudDiscoveryengineV1AnswerQueryRequestEndUserSpecEndUserMetaDataChunkInfo" }, "GoogleCloudDiscoveryengineV1alphaDataStoreFederatedSearchConfigAlloyDbConfig": { "type": "object", "id": "GoogleCloudDiscoveryengineV1alphaDataStoreFederatedSearchConfigAlloyDbConfig", "properties": { "returnedFields": { "items": { "type": "string" }, "type": "array", "description": "Optional. Fields to be returned in the search results. If empty, all fields will be returned." }, "alloydbAiNlConfig": { "description": "Optional. Configuration for Magic.", "$ref": "GoogleCloudDiscoveryengineV1alphaDataStoreFederatedSearchConfigAlloyDbConfigAlloyDbAiNaturalLanguageConfig" }, "alloydbConnectionConfig": { "$ref": "GoogleCloudDiscoveryengineV1alphaDataStoreFederatedSearchConfigAlloyDbConfigAlloyDbConnectionConfig", "description": "Required. Configuration for connecting to AlloyDB." } }, "description": "Stores information for connecting to AlloyDB." }, "GoogleCloudDiscoveryengineV1WidgetConfigAccessSettings": { "properties": { "allowPublicAccess": { "description": "Whether public unauthenticated access is allowed.", "type": "boolean" }, "workforceIdentityPoolProvider": { "description": "Optional. The workforce identity pool provider used to access the widget.", "type": "string" }, "enableWebApp": { "type": "boolean", "description": "Whether web app access is enabled." }, "languageCode": { "description": "Optional. Language code for user interface. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). If unset, the default language code is \"en-US\".", "type": "string" }, "allowlistedDomains": { "type": "array", "description": "List of domains that are allowed to integrate the search widget.", "items": { "type": "string" } } }, "type": "object", "id": "GoogleCloudDiscoveryengineV1WidgetConfigAccessSettings", "description": "Describes widget access settings." }, "GoogleCloudDiscoveryengineV1alphaDeleteSchemaMetadata": { "type": "object", "id": "GoogleCloudDiscoveryengineV1alphaDeleteSchemaMetadata", "properties": { "createTime": { "description": "Operation create time.", "format": "google-datetime", "type": "string" }, "updateTime": { "format": "google-datetime", "description": "Operation last update time. If the operation is done, this is also the finish time.", "type": "string" } }, "description": "Metadata for DeleteSchema LRO." }, "GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchMetadata": { "type": "object", "id": "GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchMetadata", "properties": { "createTime": { "description": "Operation create time.", "format": "google-datetime", "type": "string" }, "updateTime": { "type": "string", "description": "Operation last update time. If the operation is done, this is also the finish time.", "format": "google-datetime" } }, "description": "Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field." }, "GoogleCloudDiscoveryengineV1AnswerReference": { "type": "object", "properties": { "chunkInfo": { "description": "Chunk information.", "$ref": "GoogleCloudDiscoveryengineV1AnswerReferenceChunkInfo" }, "structuredDocumentInfo": { "$ref": "GoogleCloudDiscoveryengineV1AnswerReferenceStructuredDocumentInfo", "description": "Structured document information." }, "unstructuredDocumentInfo": { "$ref": "GoogleCloudDiscoveryengineV1AnswerReferenceUnstructuredDocumentInfo", "description": "Unstructured document information." } }, "id": "GoogleCloudDiscoveryengineV1AnswerReference", "description": "Reference." }, "A2aV1SendMessageRequest": { "type": "object", "description": "/////////// Request Messages ///////////", "properties": { "message": { "$ref": "A2aV1Message", "description": "Required. The message to send to the agent." }, "configuration": { "$ref": "A2aV1SendMessageConfiguration", "description": "Configuration for the send request." }, "metadata": { "description": "Optional metadata for the request.", "additionalProperties": { "description": "Properties of the object.", "type": "any" }, "type": "object" } }, "id": "A2aV1SendMessageRequest" }, "GoogleCloudDiscoveryengineV1WidgetConfigUiBrandingSettings": { "type": "object", "id": "GoogleCloudDiscoveryengineV1WidgetConfigUiBrandingSettings", "description": "Describes widget UI branding settings.", "properties": { "logo": { "description": "Logo image.", "$ref": "GoogleCloudDiscoveryengineV1WidgetConfigImage" } } }, "GoogleCloudDiscoveryengineV1ActionConfigScopeList": { "type": "object", "properties": { "scopes": { "description": "Optional. The list of scopes.", "type": "array", "items": { "type": "string" } } }, "id": "GoogleCloudDiscoveryengineV1ActionConfigScopeList", "description": "Stores a list of scopes." }, "GoogleCloudDiscoveryengineV1betaSearchRequestSessionSpec": { "description": "Session specification.", "id": "GoogleCloudDiscoveryengineV1betaSearchRequestSessionSpec", "type": "object", "properties": { "queryId": { "description": "If set, the search result gets stored to the \"turn\" specified by this query ID. Example: Let's say the session looks like this: session { name: \".../sessions/xxx\" turns { query { text: \"What is foo?\" query_id: \".../questions/yyy\" } answer: \"Foo is ...\" } turns { query { text: \"How about bar then?\" query_id: \".../questions/zzz\" } } } The user can call /search API with a request like this: session: \".../sessions/xxx\" session_spec { query_id: \".../questions/zzz\" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID.", "type": "string" }, "searchResultPersistenceCount": { "description": "The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is similar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode.", "format": "int32", "type": "integer" } } }, "GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfig": { "type": "object", "id": "GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfig", "description": "Additional config specs for a Media Recommendation engine.", "properties": { "type": { "type": "string", "description": "Required. The type of engine. e.g., `recommended-for-you`. This field together with optimization_objective describe engine metadata to use to control engine training and serving. Currently supported values: `recommended-for-you`, `others-you-may-like`, `more-like-this`, `most-popular-items`." }, "optimizationObjectiveConfig": { "description": "Name and value of the custom threshold for cvr optimization_objective. For target_field `watch-time`, target_field_value must be an integer value indicating the media progress time in seconds between (0, 86400] (excludes 0, includes 86400) (e.g., 90). For target_field `watch-percentage`, the target_field_value must be a valid float value between (0, 1.0] (excludes 0, includes 1.0) (e.g., 0.5).", "$ref": "GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigOptimizationObjectiveConfig" }, "optimizationObjective": { "description": "The optimization objective. e.g., `cvr`. This field together with optimization_objective describe engine metadata to use to control engine training and serving. Currently supported values: `ctr`, `cvr`. If not specified, we choose default based on engine type. Default depends on type of recommendation: `recommended-for-you` =\u003e `ctr` `others-you-may-like` =\u003e `ctr`", "type": "string" }, "engineFeaturesConfig": { "$ref": "GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigEngineFeaturesConfig", "description": "Optional. Additional engine features config." }, "trainingState": { "enumDescriptions": [ "Unspecified training state.", "The engine training is paused.", "The engine is training." ], "description": "The training state that the engine is in (e.g. `TRAINING` or `PAUSED`). Since part of the cost of running the service is frequency of training - this can be used to determine when to train engine in order to control cost. If not specified: the default value for `CreateEngine` method is `TRAINING`. The default value for `UpdateEngine` method is to keep the state the same as before.", "enum": [ "TRAINING_STATE_UNSPECIFIED", "PAUSED", "TRAINING" ], "type": "string" } } }, "GoogleCloudDiscoveryengineV1alphaHealthcareFhirConfig": { "type": "object", "id": "GoogleCloudDiscoveryengineV1alphaHealthcareFhirConfig", "properties": { "enableConfigurableSchema": { "description": "Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering.", "type": "boolean" }, "enableStaticIndexingForBatchIngestion": { "description": "Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume.", "type": "boolean" }, "initialFilterGroups": { "items": { "type": "string" }, "description": "Optional. Names of the Group resources to use as a basis for the initial patient filter, in format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Group/{group_id}`. The filter group must be a FHIR resource name of type Group, and the filter will be constructed from the direct members of the group which are Patient resources.", "type": "array" } }, "description": "Config to data store for `HEALTHCARE_FHIR` vertical." }, "GoogleCloudDiscoveryengineV1DeleteSchemaMetadata": { "id": "GoogleCloudDiscoveryengineV1DeleteSchemaMetadata", "type": "object", "description": "Metadata for DeleteSchema LRO.", "properties": { "createTime": { "format": "google-datetime", "description": "Operation create time.", "type": "string" }, "updateTime": { "format": "google-datetime", "description": "Operation last update time. If the operation is done, this is also the finish time.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1CompleteQueryResponseQuerySuggestion": { "type": "object", "id": "GoogleCloudDiscoveryengineV1CompleteQueryResponseQuerySuggestion", "properties": { "suggestion": { "type": "string", "description": "The suggestion for the query." }, "completableFieldPaths": { "description": "The unique document field paths that serve as the source of this suggestion if it was generated from completable fields. This field is only populated for the document-completable model.", "items": { "type": "string" }, "type": "array" } }, "description": "Suggestions as search queries." }, "GoogleCloudDiscoveryengineV1CreateSchemaMetadata": { "description": "Metadata for Create Schema LRO.", "id": "GoogleCloudDiscoveryengineV1CreateSchemaMetadata", "type": "object", "properties": { "createTime": { "type": "string", "description": "Operation create time.", "format": "google-datetime" }, "updateTime": { "format": "google-datetime", "description": "Operation last update time. If the operation is done, this is also the finish time.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1betaNaturalLanguageQueryUnderstandingConfig": { "properties": { "mode": { "description": "Mode of Natural Language Query Understanding. If this field is unset, the behavior defaults to NaturalLanguageQueryUnderstandingConfig.Mode.DISABLED.", "enum": [ "MODE_UNSPECIFIED", "DISABLED", "ENABLED" ], "enumDescriptions": [ "Default value.", "Natural Language Query Understanding is disabled.", "Natural Language Query Understanding is enabled." ], "type": "string" } }, "type": "object", "id": "GoogleCloudDiscoveryengineV1betaNaturalLanguageQueryUnderstandingConfig", "description": "Configuration for Natural Language Query Understanding." }, "GoogleCloudDiscoveryengineV1betaControl": { "id": "GoogleCloudDiscoveryengineV1betaControl", "description": "Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`.", "type": "object", "properties": { "promoteAction": { "$ref": "GoogleCloudDiscoveryengineV1betaControlPromoteAction", "description": "Promote certain links based on predefined trigger queries." }, "associatedServingConfigIds": { "type": "array", "readOnly": true, "items": { "type": "string" }, "description": "Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes." }, "useCases": { "description": "Specifies the use case for the control. Affects what condition fields can be set. Only applies to SOLUTION_TYPE_SEARCH. Currently only allow one use case per control. Must be set when solution_type is SolutionType.SOLUTION_TYPE_SEARCH.", "type": "array", "items": { "type": "string", "enum": [ "SEARCH_USE_CASE_UNSPECIFIED", "SEARCH_USE_CASE_SEARCH", "SEARCH_USE_CASE_BROWSE" ], "enumDescriptions": [ "Value used when unset. Will not occur in CSS.", "Search use case. Expects the traffic has a non-empty query.", "Browse use case. Expects the traffic has an empty query." ] } }, "filterAction": { "description": "Defines a filter-type control Currently not supported by Recommendation", "$ref": "GoogleCloudDiscoveryengineV1betaControlFilterAction" }, "name": { "description": "Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*`", "type": "string" }, "conditions": { "type": "array", "description": "Determines when the associated action will trigger. Omit to always apply the action. Currently only a single condition may be specified. Otherwise an INVALID ARGUMENT error is thrown.", "items": { "$ref": "GoogleCloudDiscoveryengineV1betaCondition" } }, "synonymsAction": { "description": "Treats a group of terms as synonyms of one another.", "$ref": "GoogleCloudDiscoveryengineV1betaControlSynonymsAction" }, "boostAction": { "$ref": "GoogleCloudDiscoveryengineV1betaControlBoostAction", "description": "Defines a boost-type control" }, "solutionType": { "description": "Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown.", "enumDescriptions": [ "Default value.", "Used for Recommendations AI.", "Used for Discovery Search.", "Used for use cases related to the Generative AI agent.", "Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution.", "Used for AI Mode." ], "type": "string", "enum": [ "SOLUTION_TYPE_UNSPECIFIED", "SOLUTION_TYPE_RECOMMENDATION", "SOLUTION_TYPE_SEARCH", "SOLUTION_TYPE_CHAT", "SOLUTION_TYPE_GENERATIVE_CHAT", "SOLUTION_TYPE_AI_MODE" ] }, "redirectAction": { "$ref": "GoogleCloudDiscoveryengineV1betaControlRedirectAction", "description": "Defines a redirect-type control." }, "displayName": { "type": "string", "description": "Required. Human readable name. The identifier used in UI views. Must be UTF-8 encoded string. Length limit is 128 characters. Otherwise an INVALID ARGUMENT error is thrown." } } }, "GoogleCloudDiscoveryengineV1alphaAlphaEvolveSourceFile": { "type": "object", "description": "A single source file with its path, content and metadata.", "properties": { "programLanguage": { "type": "string", "description": "Optional. The programming language of the file." }, "path": { "type": "string", "description": "Required. The relative path of the file, including the filename. e.g., \"src/main.py\", \"utils/helpers.js\", \"README.md\"" }, "description": { "description": "Optional. Additional description of the file.", "type": "string" }, "content": { "type": "string", "description": "Required. The raw content of the file. This is a string and not bytes, because it should be ultimately processed by the LLM as text." } }, "id": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveSourceFile" }, "GoogleCloudDiscoveryengineV1alphaOrganicCrawlRateTimeSeries": { "id": "GoogleCloudDiscoveryengineV1alphaOrganicCrawlRateTimeSeries", "type": "object", "properties": { "vertexAiOrganicCrawlRate": { "$ref": "GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries", "description": "Vertex AI's organic crawl rate time series, which is the crawl rate of Google-CloudVertexBot when dedicate crawl is not set. Please refer to https://developers.google.com/search/docs/crawling-indexing/google-common-crawlers#google-cloudvertexbot for more details about Google-CloudVertexBot." }, "googleOrganicCrawlRate": { "$ref": "GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries", "description": "Google's organic crawl rate time series, which is the sum of all googlebots' crawl rate. Please refer to https://developers.google.com/search/docs/crawling-indexing/overview-google-crawlers for more details about googlebots." } }, "description": "The historical organic crawl rate timeseries data, used for monitoring. Organic crawl is auto-determined by Google to crawl the user's website when dedicate crawl is not set. Crawl rate is the QPS of crawl request Google sends to the user's website." }, "GoogleCloudDiscoveryengineV1SearchRequestSearchAsYouTypeSpec": { "description": "Specification for search as you type in search requests.", "id": "GoogleCloudDiscoveryengineV1SearchRequestSearchAsYouTypeSpec", "properties": { "condition": { "type": "string", "enum": [ "CONDITION_UNSPECIFIED", "DISABLED", "ENABLED", "AUTO" ], "description": "The condition under which search as you type should occur. Default to Condition.DISABLED.", "enumDescriptions": [ "Server behavior defaults to Condition.DISABLED.", "Disables Search As You Type.", "Enables Search As You Type.", "Automatic switching between search-as-you-type and standard search modes, ideal for single-API implementations (e.g., debouncing)." ] } }, "type": "object" }, "GoogleCloudDiscoveryengineV1AssistAnswerReply": { "id": "GoogleCloudDiscoveryengineV1AssistAnswerReply", "properties": { "groundedContent": { "$ref": "GoogleCloudDiscoveryengineV1AssistantGroundedContent", "description": "Possibly grounded response text or media from the assistant." }, "createTime": { "format": "google-datetime", "type": "string", "description": "The time when the reply was created." } }, "type": "object", "description": "One part of the multi-part response of the assist call." }, "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSnippetSpec": { "id": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSnippetSpec", "type": "object", "properties": { "returnSnippet": { "description": "If `true`, then return snippet. If no snippet can be generated, we return \"No snippet is available for this page.\" A `snippet_status` with `SUCCESS` or `NO_SNIPPET_AVAILABLE` will also be returned.", "type": "boolean" }, "referenceOnly": { "deprecated": true, "type": "boolean", "description": "[DEPRECATED] This field is deprecated and will have no affect on the snippet." }, "maxSnippetCount": { "format": "int32", "type": "integer", "deprecated": true, "description": "[DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count \u003e 0." } }, "description": "A specification for configuring snippets in a search response." }, "GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResultBannedPhraseEnforcementResult": { "id": "GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResultBannedPhraseEnforcementResult", "properties": { "bannedPhrases": { "type": "array", "description": "The banned phrases that were found in the query or the answer.", "items": { "type": "string" } } }, "description": "Customer policy enforcement result for the banned phrase policy.", "type": "object" }, "GoogleCloudDiscoveryengineV1PurgeErrorConfig": { "id": "GoogleCloudDiscoveryengineV1PurgeErrorConfig", "description": "Configuration of destination for Purge related errors.", "type": "object", "properties": { "gcsPrefix": { "description": "Cloud Storage prefix for purge errors. This must be an empty, existing Cloud Storage directory. Purge errors are written to sharded files in this directory, one per line, as a JSON-encoded `google.rpc.Status` message.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1DeleteDataStoreMetadata": { "id": "GoogleCloudDiscoveryengineV1DeleteDataStoreMetadata", "type": "object", "properties": { "createTime": { "description": "Operation create time.", "type": "string", "format": "google-datetime" }, "updateTime": { "format": "google-datetime", "type": "string", "description": "Operation last update time. If the operation is done, this is also the finish time." } }, "description": "Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field." }, "GoogleCloudDiscoveryengineV1EngineChatEngineMetadata": { "id": "GoogleCloudDiscoveryengineV1EngineChatEngineMetadata", "type": "object", "properties": { "dialogflowAgent": { "description": "The resource name of a Dialogflow agent, that this Chat Engine refers to. Format: `projects//locations//agents/`.", "type": "string" } }, "description": "Additional information of a Chat Engine. Fields in this message are output only." }, "GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchParams": { "description": "Search parameters.", "properties": { "searchResultMode": { "type": "string", "description": "Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. See [parse and chunk documents](https://cloud.google.com/generative-ai-app-builder/docs/parse-chunk-documents)", "enumDescriptions": [ "Default value.", "Returns documents in the search result.", "Returns chunks in the search result. Only available if the DocumentProcessingConfig.chunking_config is specified." ], "enum": [ "SEARCH_RESULT_MODE_UNSPECIFIED", "DOCUMENTS", "CHUNKS" ] }, "dataStoreSpecs": { "items": { "$ref": "GoogleCloudDiscoveryengineV1SearchRequestDataStoreSpec" }, "description": "Specs defining dataStores to filter on in a search call and configurations for those dataStores. This is only considered for engines with multiple dataStores use case. For single dataStore within an engine, they should use the specs at the top level.", "type": "array" }, "maxReturnResults": { "type": "integer", "format": "int32", "description": "Number of search results to return. The default value is 10." }, "filter": { "type": "string", "description": "The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. This will be used to filter search results which may affect the Answer response. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customers might have a field 'name' in their schema. In this case the filter would look like this: filter --\u003e name:'ANY(\"king kong\")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)" }, "orderBy": { "type": "string", "description": "The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned." }, "boostSpec": { "$ref": "GoogleCloudDiscoveryengineV1SearchRequestBoostSpec", "description": "Boost specification to boost certain documents in search results which may affect the answer query response. For more information on boosting, see [Boosting](https://cloud.google.com/retail/docs/boosting#boost)" } }, "id": "GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchParams", "type": "object" }, "GoogleCloudDiscoveryengineV1AnswerReferenceUnstructuredDocumentInfoChunkContent": { "id": "GoogleCloudDiscoveryengineV1AnswerReferenceUnstructuredDocumentInfoChunkContent", "properties": { "pageIdentifier": { "type": "string", "description": "Page identifier." }, "content": { "type": "string", "description": "Chunk textual content." }, "relevanceScore": { "type": "number", "format": "float", "description": "The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation." } }, "description": "Chunk content.", "type": "object" }, "GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpec": { "id": "GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpec", "description": "Describes the specification of the evaluation.", "type": "object", "properties": { "searchRequest": { "description": "Required. The search request that is used to perform the evaluation. Only the following fields within SearchRequest are supported; if any other fields are provided, an UNSUPPORTED error will be returned: * SearchRequest.serving_config * SearchRequest.branch * SearchRequest.canonical_filter * SearchRequest.query_expansion_spec * SearchRequest.spell_correction_spec * SearchRequest.content_search_spec * SearchRequest.user_pseudo_id", "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequest" }, "querySetSpec": { "description": "Optional. The specification of the query set.", "$ref": "GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpecQuerySetSpec" } } }, "GoogleCloudDiscoveryengineLoggingImportErrorContext": { "id": "GoogleCloudDiscoveryengineLoggingImportErrorContext", "properties": { "document": { "description": "The detailed content which caused the error on importing a document.", "type": "string" }, "gcsPath": { "description": "Google Cloud Storage file path of the import source. Can be set for batch operation error.", "type": "string" }, "operation": { "type": "string", "description": "The operation resource name of the LRO." }, "userEvent": { "description": "The detailed content which caused the error on importing a user event.", "type": "string" }, "lineNumber": { "type": "string", "description": "Line number of the content in file. Should be empty for permission or batch operation error." } }, "type": "object", "description": "The error payload that is populated on LRO import APIs, including the following: * `google.cloud.discoveryengine.v1alpha.DocumentService.ImportDocuments` * `google.cloud.discoveryengine.v1alpha.UserEventService.ImportUserEvents`" }, "GoogleCloudDiscoveryengineV1CitationMetadata": { "description": "A collection of source attributions for a piece of content.", "properties": { "citations": { "items": { "$ref": "GoogleCloudDiscoveryengineV1Citation" }, "type": "array", "readOnly": true, "description": "Output only. List of citations." } }, "type": "object", "id": "GoogleCloudDiscoveryengineV1CitationMetadata" }, "GoogleCloudDiscoveryengineV1betaDataStoreBillingEstimation": { "type": "object", "properties": { "websiteDataUpdateTime": { "format": "google-datetime", "type": "string", "description": "Last updated timestamp for websites." }, "unstructuredDataUpdateTime": { "format": "google-datetime", "description": "Last updated timestamp for unstructured data.", "type": "string" }, "unstructuredDataSize": { "format": "int64", "type": "string", "description": "Data size for unstructured data in terms of bytes." }, "structuredDataUpdateTime": { "format": "google-datetime", "type": "string", "description": "Last updated timestamp for structured data." }, "structuredDataSize": { "format": "int64", "description": "Data size for structured data in terms of bytes.", "type": "string" }, "websiteDataSize": { "description": "Data size for websites in terms of bytes.", "format": "int64", "type": "string" } }, "description": "Estimation of data size per data store.", "id": "GoogleCloudDiscoveryengineV1betaDataStoreBillingEstimation" }, "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig": { "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig", "type": "object", "properties": { "ocrParsingConfig": { "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig", "description": "Configurations applied to OCR parser. Currently it only applies to PDFs." }, "layoutParsingConfig": { "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig", "description": "Configurations applied to layout parser." }, "digitalParsingConfig": { "description": "Configurations applied to digital parser.", "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig" } }, "description": "Related configurations applied to a specific type of document parser." }, "GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRun": { "id": "GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRun", "properties": { "extractedRecordCount": { "description": "Optional. The number of documents extracted from connector source, ready to be ingested to VAIS.", "format": "int64", "type": "string" }, "state": { "enumDescriptions": [ "Default value.", "The data sync is ongoing.", "The data sync is finished.", "The data sync is failed.", "Data sync has been running longer than expected and is still running at the time the next run is supposed to start.", "Data sync was scheduled but has been cancelled.", "Data sync is about to start.", "The data sync completed with non-fatal errors.", "An ongoing connector run has been running longer than expected, causing this run to be skipped." ], "type": "string", "description": "The state of the entity's sync run.", "enum": [ "STATE_UNSPECIFIED", "RUNNING", "SUCCEEDED", "FAILED", "OVERRUN", "CANCELLED", "PENDING", "WARNING", "SKIPPED" ] }, "scheduledRecordCount": { "type": "string", "format": "int64", "description": "Optional. The number of documents scheduled to be crawled/extracted from connector source. This only applies to third party connectors." }, "stateUpdateTime": { "type": "string", "description": "Timestamp at which the entity sync state was last updated.", "format": "google-datetime" }, "deletedRecordCount": { "description": "Optional. The number of documents deleted.", "type": "string", "format": "int64" }, "indexedRecordCount": { "description": "Optional. The number of documents indexed.", "format": "int64", "type": "string" }, "statsUpdateTime": { "description": "The timestamp for either extracted_documents_count, indexed_documents_count and error_documents_count was last updated.", "format": "google-datetime", "type": "string" }, "errorRecordCount": { "description": "Optional. The total number of documents failed at sync at indexing stage.", "format": "int64", "type": "string" }, "entityName": { "description": "The name of the source entity.", "type": "string" }, "sourceApiRequestCount": { "description": "Optional. The number of requests sent to 3p API.", "format": "int64", "type": "string" }, "progress": { "$ref": "GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRunProgress", "description": "Metadata to generate the progress bar." }, "errors": { "items": { "$ref": "GoogleRpcStatus" }, "type": "array", "description": "The errors from the entity's sync run. Only exist if running into an error state. Contains error code and error message." }, "syncType": { "description": "Sync type of this run.", "enum": [ "SYNC_TYPE_UNSPECIFIED", "FULL", "INCREMENTAL", "REALTIME", "SCALA_SYNC" ], "enumDescriptions": [ "Sync type unspecified.", "Sync triggers full sync of all documents.", "Incremental sync of updated documents.", "Realtime sync.", "Scala sync." ], "type": "string" } }, "description": "Represents an entity that was synced in this ConnectorRun.", "type": "object" }, "GoogleCloudDiscoveryengineV1alphaControlRedirectAction": { "description": "Redirects a shopper to the provided URI.", "type": "object", "properties": { "redirectUri": { "description": "Required. The URI to which the shopper will be redirected. Required. URI must have length equal or less than 2000 characters. Otherwise an INVALID ARGUMENT error is thrown.", "type": "string" } }, "id": "GoogleCloudDiscoveryengineV1alphaControlRedirectAction" }, "A2aV1DataPart": { "type": "object", "properties": { "data": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "type": "object" } }, "id": "A2aV1DataPart", "description": "DataPart represents a structured blob. This is most commonly a JSON payload." }, "GoogleCloudDiscoveryengineV1betaTargetSiteFailureReasonQuotaFailure": { "id": "GoogleCloudDiscoveryengineV1betaTargetSiteFailureReasonQuotaFailure", "description": "Failed due to insufficient quota.", "properties": { "totalRequiredQuota": { "type": "string", "format": "int64", "description": "This number is an estimation on how much total quota this project needs to successfully complete indexing." } }, "type": "object" }, "GoogleCloudDiscoveryengineV1StreamAssistResponse": { "type": "object", "description": "Response for the AssistantService.StreamAssist method.", "properties": { "assistToken": { "type": "string", "description": "A global unique ID that identifies the current pair of request and stream of responses. Used for feedback and support." }, "invocationTools": { "items": { "type": "string" }, "description": "The tool names of the tools that were invoked.", "type": "array" }, "connectorAuthErrors": { "description": "Per-connector authentication errors encountered during the request. Present when one or more connectors failed authentication but the request proceeded with the remaining connectors.", "items": { "$ref": "GoogleCloudDiscoveryengineV1StreamAssistResponseConnectorAuthError" }, "type": "array" }, "sessionInfo": { "$ref": "GoogleCloudDiscoveryengineV1StreamAssistResponseSessionInfo", "description": "Session information. Only included in the final StreamAssistResponse of the response stream." }, "answer": { "description": "Assist answer resource object containing parts of the assistant's final answer for the user's query. Not present if the current response doesn't add anything to previously sent AssistAnswer.replies. Observe AssistAnswer.state to see if more parts are to be expected. While the state is `IN_PROGRESS`, the AssistAnswer.replies field in each response will contain replies (reply fragments) to be appended to the ones received in previous responses. AssistAnswer.name won't be filled. If the state is `SUCCEEDED`, `FAILED` or `SKIPPED`, the response is the last response and AssistAnswer.name will have a value.", "$ref": "GoogleCloudDiscoveryengineV1AssistAnswer" }, "invokedSkills": { "type": "array", "description": "The skills executed during the turn.", "items": { "$ref": "GoogleCloudDiscoveryengineV1StreamAssistResponseInvokedSkill" } } }, "id": "GoogleCloudDiscoveryengineV1StreamAssistResponse" }, "GoogleCloudDiscoveryengineV1betaCreateEngineMetadata": { "id": "GoogleCloudDiscoveryengineV1betaCreateEngineMetadata", "type": "object", "properties": { "updateTime": { "type": "string", "format": "google-datetime", "description": "Operation last update time. If the operation is done, this is also the finish time." }, "createTime": { "format": "google-datetime", "description": "Operation create time.", "type": "string" } }, "description": "Metadata related to the progress of the EngineService.CreateEngine operation. This will be returned by the google.longrunning.Operation.metadata field." }, "GoogleCloudDiscoveryengineV1AnswerCitationSource": { "type": "object", "id": "GoogleCloudDiscoveryengineV1AnswerCitationSource", "description": "Citation source.", "properties": { "referenceId": { "description": "ID of the citation source.", "type": "string" } } }, "A2aV1APIKeySecurityScheme": { "properties": { "location": { "type": "string", "description": "Location of the API key, valid values are \"query\", \"header\", or \"cookie\"" }, "name": { "type": "string", "description": "Name of the header, query or cookie parameter to be used." }, "description": { "description": "Description of this security scheme.", "type": "string" } }, "id": "A2aV1APIKeySecurityScheme", "type": "object" }, "GoogleCloudDiscoveryengineV1IdentityScheduleConfig": { "properties": { "nextSyncTime": { "$ref": "GoogleTypeDateTime", "description": "Optional. The UTC time when the next data sync is expected to start for the Data Connector. Customers are only able to specify the hour and minute to schedule the data sync. This is utilized when the data connector has a refresh interval greater than 1 day." }, "refreshInterval": { "format": "google-duration", "description": "Optional. The refresh interval to sync the Access Control List information for the documents ingested by this connector. If not set, the access control list will be refreshed at the default interval of 30 minutes. The identity refresh interval can be at least 30 minutes and at most 7 days.", "type": "string" } }, "description": "The configuration for the identity data synchronization runs.", "id": "GoogleCloudDiscoveryengineV1IdentityScheduleConfig", "type": "object" }, "GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec": { "type": "object", "description": "Defines custom fine tuning spec.", "id": "GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec", "properties": { "enableSearchAdaptor": { "type": "boolean", "description": "Whether or not to enable and include custom fine tuned search adaptor model." } } }, "GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfig": { "description": "Additional config specs for a Media Recommendation engine.", "properties": { "optimizationObjectiveConfig": { "description": "Name and value of the custom threshold for cvr optimization_objective. For target_field `watch-time`, target_field_value must be an integer value indicating the media progress time in seconds between (0, 86400] (excludes 0, includes 86400) (e.g., 90). For target_field `watch-percentage`, the target_field_value must be a valid float value between (0, 1.0] (excludes 0, includes 1.0) (e.g., 0.5).", "$ref": "GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig" }, "type": { "type": "string", "description": "Required. The type of engine. e.g., `recommended-for-you`. This field together with optimization_objective describe engine metadata to use to control engine training and serving. Currently supported values: `recommended-for-you`, `others-you-may-like`, `more-like-this`, `most-popular-items`." }, "optimizationObjective": { "description": "The optimization objective. e.g., `cvr`. This field together with optimization_objective describe engine metadata to use to control engine training and serving. Currently supported values: `ctr`, `cvr`. If not specified, we choose default based on engine type. Default depends on type of recommendation: `recommended-for-you` =\u003e `ctr` `others-you-may-like` =\u003e `ctr`", "type": "string" }, "engineFeaturesConfig": { "$ref": "GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigEngineFeaturesConfig", "description": "Optional. Additional engine features config." }, "trainingState": { "enum": [ "TRAINING_STATE_UNSPECIFIED", "PAUSED", "TRAINING" ], "enumDescriptions": [ "Unspecified training state.", "The engine training is paused.", "The engine is training." ], "type": "string", "description": "The training state that the engine is in (e.g. `TRAINING` or `PAUSED`). Since part of the cost of running the service is frequency of training - this can be used to determine when to train engine in order to control cost. If not specified: the default value for `CreateEngine` method is `TRAINING`. The default value for `UpdateEngine` method is to keep the state the same as before." } }, "id": "GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfig", "type": "object" }, "GoogleCloudDiscoveryengineV1betaSiteVerificationInfo": { "properties": { "siteVerificationState": { "enum": [ "SITE_VERIFICATION_STATE_UNSPECIFIED", "VERIFIED", "UNVERIFIED", "EXEMPTED" ], "type": "string", "enumDescriptions": [ "Defaults to VERIFIED.", "Site ownership verified.", "Site ownership pending verification or verification failed.", "Site exempt from verification, e.g., a public website that opens to all." ], "description": "Site verification state indicating the ownership and validity." }, "verifyTime": { "type": "string", "description": "Latest site verification time.", "format": "google-datetime" } }, "description": "Verification information for target sites in advanced site search.", "id": "GoogleCloudDiscoveryengineV1betaSiteVerificationInfo", "type": "object" }, "GoogleCloudDiscoveryengineV1AnswerQueryRequestGroundingSpec": { "id": "GoogleCloudDiscoveryengineV1AnswerQueryRequestGroundingSpec", "type": "object", "properties": { "includeGroundingSupports": { "type": "boolean", "description": "Optional. Specifies whether to include grounding_supports in the answer. The default value is `false`. When this field is set to `true`, returned answer will have `grounding_score` and will contain GroundingSupports for each claim." }, "filteringLevel": { "enumDescriptions": [ "Default is no filter", "Filter answers based on a low threshold.", "Filter answers based on a high threshold." ], "enum": [ "FILTERING_LEVEL_UNSPECIFIED", "FILTERING_LEVEL_LOW", "FILTERING_LEVEL_HIGH" ], "description": "Optional. Specifies whether to enable the filtering based on grounding score and at what level.", "type": "string" } }, "description": "Grounding specification." }, "GoogleCloudDiscoveryengineV1BatchUpdateUserLicensesMetadata": { "id": "GoogleCloudDiscoveryengineV1BatchUpdateUserLicensesMetadata", "description": "Metadata related to the progress of the UserLicenseService.BatchUpdateUserLicenses operation. This will be returned by the google.longrunning.Operation.metadata field.", "type": "object", "properties": { "updateTime": { "type": "string", "format": "google-datetime", "description": "Operation last update time. If the operation is done, this is also the finish time." }, "failureCount": { "format": "int64", "type": "string", "description": "Count of user licenses that failed to be updated." }, "createTime": { "description": "Operation create time.", "type": "string", "format": "google-datetime" }, "successCount": { "description": "Count of user licenses successfully updated.", "type": "string", "format": "int64" } } }, "GoogleCloudDiscoveryengineV1alphaImportErrorConfig": { "description": "Configuration of destination for Import related errors.", "properties": { "gcsPrefix": { "description": "Cloud Storage prefix for import errors. This must be an empty, existing Cloud Storage directory. Import errors are written to sharded files in this directory, one per line, as a JSON-encoded `google.rpc.Status` message.", "type": "string" } }, "type": "object", "id": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig" }, "GoogleCloudDiscoveryengineV1DoubleList": { "id": "GoogleCloudDiscoveryengineV1DoubleList", "description": "Double list.", "properties": { "values": { "type": "array", "items": { "type": "number", "format": "double" }, "description": "Double values." } }, "type": "object" }, "GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpecControlPoint": { "id": "GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpecControlPoint", "properties": { "boostAmount": { "description": "Optional. The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above.", "format": "float", "type": "number" }, "attributeValue": { "type": "string", "description": "Optional. Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`." } }, "description": "The control points used to define the curve. The curve defined through these control points can only be monotonically increasing or decreasing(constant values are acceptable).", "type": "object" }, "GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig": { "type": "object", "properties": { "agentCreationConfig": { "$ref": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig", "description": "The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation." }, "allowCrossRegion": { "description": "Optional. If the flag set to true, we allow the agent and engine are in different locations, otherwise the agent and engine are required to be in the same location. The flag is set to false by default. Note that the `allow_cross_region` are one-time consumed by and passed to EngineService.CreateEngine. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation.", "type": "boolean" }, "dialogflowAgentToLink": { "type": "string", "description": "The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide `agent_creation_config` to create agent or provide an agent name that links the agent with the Chat engine. Format: `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. Use ChatEngineMetadata.dialogflow_agent for actual agent association after Engine is created." } }, "description": "Configurations for a Chat Engine.", "id": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig" }, "GoogleCloudDiscoveryengineV1AssistAnswerCustomerPolicyEnforcementResultModelArmorEnforcementResult": { "id": "GoogleCloudDiscoveryengineV1AssistAnswerCustomerPolicyEnforcementResultModelArmorEnforcementResult", "properties": { "error": { "$ref": "GoogleRpcStatus", "description": "The error returned by Model Armor if the policy enforcement failed for some reason." }, "modelArmorViolation": { "description": "The Model Armor violation that was found.", "type": "string" } }, "type": "object", "description": "Customer policy enforcement result for the Model Armor policy." }, "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeMetadata": { "properties": { "createTime": { "description": "Operation create time.", "type": "string", "format": "google-datetime" } }, "type": "object", "description": "Metadata related to the progress of the EstimateDataSize operation. This is returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeMetadata" }, "GoogleCloudDiscoveryengineV1alphaUpdateTargetSiteMetadata": { "properties": { "updateTime": { "description": "Operation last update time. If the operation is done, this is also the finish time.", "type": "string", "format": "google-datetime" }, "createTime": { "type": "string", "description": "Operation create time.", "format": "google-datetime" } }, "type": "object", "id": "GoogleCloudDiscoveryengineV1alphaUpdateTargetSiteMetadata", "description": "Metadata related to the progress of the SiteSearchEngineService.UpdateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field." }, "GoogleCloudDiscoveryengineV1SearchRequestDataStoreSpec": { "description": "A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned.", "properties": { "customSearchOperators": { "description": "Optional. Custom search operators which if specified will be used to filter results from workspace data stores. For more information on custom search operators, see [SearchOperators](https://support.google.com/cloudsearch/answer/6172299).", "type": "string" }, "numResults": { "description": "Optional. The maximum number of results to retrieve from this data store. If not specified, it will use the SearchRequest.num_results_per_data_store if provided, otherwise there is no limit. If both this field and SearchRequest.num_results_per_data_store are specified, this field will be used.", "type": "integer", "format": "int32" }, "dataStore": { "description": "Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. The path must include the project number, project id is not supported for this field.", "type": "string" }, "boostSpec": { "description": "Optional. Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)", "$ref": "GoogleCloudDiscoveryengineV1SearchRequestBoostSpec" }, "filter": { "description": "Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)", "type": "string" } }, "type": "object", "id": "GoogleCloudDiscoveryengineV1SearchRequestDataStoreSpec" }, "GoogleCloudDiscoveryengineV1alphaSearchRequestImageQuery": { "type": "object", "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestImageQuery", "description": "Specifies the image query input.", "properties": { "imageBytes": { "description": "Base64 encoded image bytes. Supported image formats: JPEG, PNG, and BMP.", "type": "string" } } }, "GoogleTypeLatLng": { "id": "GoogleTypeLatLng", "properties": { "latitude": { "format": "double", "type": "number", "description": "The latitude in degrees. It must be in the range [-90.0, +90.0]." }, "longitude": { "format": "double", "description": "The longitude in degrees. It must be in the range [-180.0, +180.0].", "type": "number" } }, "type": "object", "description": "An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges." }, "GoogleApiDistributionBucketOptions": { "description": "`BucketOptions` describes the bucket boundaries used to create a histogram for the distribution. The buckets can be in a linear sequence, an exponential sequence, or each bucket can be specified explicitly. `BucketOptions` does not include the number of values in each bucket. A bucket has an inclusive lower bound and exclusive upper bound for the values that are counted for that bucket. The upper bound of a bucket must be strictly greater than the lower bound. The sequence of N buckets for a distribution consists of an underflow bucket (number 0), zero or more finite buckets (number 1 through N - 2) and an overflow bucket (number N - 1). The buckets are contiguous: the lower bound of bucket i (i \u003e 0) is the same as the upper bound of bucket i - 1. The buckets span the whole range of finite values: lower bound of the underflow bucket is -infinity and the upper bound of the overflow bucket is +infinity. The finite buckets are so-called because both bounds are finite.", "properties": { "explicitBuckets": { "description": "The explicit buckets.", "$ref": "GoogleApiDistributionBucketOptionsExplicit" }, "exponentialBuckets": { "description": "The exponential buckets.", "$ref": "GoogleApiDistributionBucketOptionsExponential" }, "linearBuckets": { "$ref": "GoogleApiDistributionBucketOptionsLinear", "description": "The linear bucket." } }, "id": "GoogleApiDistributionBucketOptions", "type": "object" }, "GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpecModelSpec": { "id": "GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpecModelSpec", "properties": { "modelVersion": { "type": "string", "description": "Model version. If not set, it will use the default stable model. Allowed values are: stable, preview." } }, "description": "Answer Generation Model specification.", "type": "object" }, "GoogleCloudDiscoveryengineV1BigQuerySource": { "id": "GoogleCloudDiscoveryengineV1BigQuerySource", "properties": { "projectId": { "type": "string", "description": "The project ID or the project number that contains the BigQuery source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request." }, "datasetId": { "type": "string", "description": "Required. The BigQuery data set to copy the data from with a length limit of 1,024 characters." }, "dataSchema": { "description": "The schema to use when parsing the data from the source. Supported values for user event imports: * `user_event` (default): One UserEvent per row. Supported values for document imports: * `document` (default): One Document format per row. Each document must have a valid Document.id and one of Document.json_data or Document.struct_data. * `custom`: One custom data per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by the GENERIC Data Store vertical.", "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 BigQuery export to a specific Cloud Storage directory.", "type": "string" }, "partitionDate": { "$ref": "GoogleTypeDate", "description": "BigQuery time partitioned table's _PARTITIONDATE in YYYY-MM-DD format." }, "tableId": { "type": "string", "description": "Required. The BigQuery table to copy the data from with a length limit of 1,024 characters." } }, "description": "BigQuery source import data from.", "type": "object" }, "GoogleTypeTimeZone": { "type": "object", "description": "Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones).", "properties": { "id": { "description": "IANA Time Zone Database time zone. For example \"America/New_York\".", "type": "string" }, "version": { "description": "Optional. IANA Time Zone Database version number. For example \"2019a\".", "type": "string" } }, "id": "GoogleTypeTimeZone" }, "GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataResponse": { "properties": {}, "id": "GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataResponse", "type": "object", "description": "Response message for SiteSearchEngineService.SetUriPatternDocumentData method." }, "GoogleCloudDiscoveryengineV1BatchVerifyTargetSitesRequest": { "type": "object", "id": "GoogleCloudDiscoveryengineV1BatchVerifyTargetSitesRequest", "description": "Request message for SiteSearchEngineService.BatchVerifyTargetSites method.", "properties": {} }, "GoogleCloudDiscoveryengineV1StreamAssistRequestToolsSpecImageGenerationSpec": { "properties": {}, "description": "Specification of the image generation tool.", "type": "object", "id": "GoogleCloudDiscoveryengineV1StreamAssistRequestToolsSpecImageGenerationSpec" }, "GoogleCloudDiscoveryengineV1FactChunk": { "description": "Fact Chunk.", "properties": { "uri": { "description": "The URI of the source.", "type": "string" }, "index": { "format": "int32", "type": "integer", "description": "The index of this chunk. Currently, only used for the streaming mode." }, "chunkText": { "type": "string", "description": "Text content of the fact chunk. Can be at most 10K characters long." }, "domain": { "description": "The domain of the source.", "type": "string" }, "sourceMetadata": { "type": "object", "description": "More fine-grained information for the source reference.", "additionalProperties": { "type": "string" } }, "title": { "type": "string", "description": "The title of the source." }, "source": { "description": "Source from which this fact chunk was retrieved. If it was retrieved from the GroundingFacts provided in the request then this field will contain the index of the specific fact from which this chunk was retrieved.", "type": "string" } }, "type": "object", "id": "GoogleCloudDiscoveryengineV1FactChunk" }, "GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpecFacetKey": { "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpecFacetKey", "description": "Specifies how a facet is computed.", "properties": { "caseInsensitive": { "description": "True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise.", "type": "boolean" }, "restrictedValues": { "items": { "type": "string" }, "description": "Only get facet for the given restricted values. Only supported on textual fields. For example, suppose \"category\" has three values \"Action \u003e 2022\", \"Action \u003e 2021\" and \"Sci-Fi \u003e 2022\". If set \"restricted_values\" to \"Action \u003e 2022\", the \"category\" facet only contains \"Action \u003e 2022\". Only supported on textual fields. Maximum is 10.", "type": "array" }, "contains": { "type": "array", "items": { "type": "string" }, "description": "Only get facet values that contain the given strings. For example, suppose \"category\" has three values \"Action \u003e 2022\", \"Action \u003e 2021\" and \"Sci-Fi \u003e 2022\". If set \"contains\" to \"2022\", the \"category\" facet only contains \"Action \u003e 2022\" and \"Sci-Fi \u003e 2022\". Only supported on textual fields. Maximum is 10." }, "key": { "type": "string", "description": "Required. Supported textual and numerical facet keys in Document object, over which the facet values are computed. Facet key is case-sensitive." }, "prefixes": { "items": { "type": "string" }, "type": "array", "description": "Only get facet values that start with the given string prefix. For example, suppose \"category\" has three values \"Action \u003e 2022\", \"Action \u003e 2021\" and \"Sci-Fi \u003e 2022\". If set \"prefixes\" to \"Action\", the \"category\" facet only contains \"Action \u003e 2022\" and \"Action \u003e 2021\". Only supported on textual fields. Maximum is 10." }, "intervals": { "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaInterval" }, "description": "Set only if values should be bucketed into intervals. Must be set for facets with numerical values. Must not be set for facet with text values. Maximum number of intervals is 30." }, "orderBy": { "description": "The order in which documents are returned. Allowed values are: * \"count desc\", which means order by SearchResponse.Facet.values.count descending. * \"value desc\", which means order by SearchResponse.Facet.values.value descending. Only applies to textual facets. If not set, textual values are sorted in [natural order](https://en.wikipedia.org/wiki/Natural_sort_order); numerical intervals are sorted in the order given by FacetSpec.FacetKey.intervals.", "type": "string" } }, "type": "object" }, "GoogleCloudDiscoveryengineV1alphaDataConnectorSourceEntity": { "description": "Represents an entity in the data source. For example, the `Account` object in Salesforce.", "id": "GoogleCloudDiscoveryengineV1alphaDataConnectorSourceEntity", "type": "object", "properties": { "healthcareFhirConfig": { "description": "Optional. Configuration for `HEALTHCARE_FHIR` vertical.", "$ref": "GoogleCloudDiscoveryengineV1alphaHealthcareFhirConfig" }, "startingSchema": { "description": "Optional. The start schema to use for the DataStore created from this SourceEntity. If unset, a default vertical specialized schema will be used. This field is only used by SetUpDataConnector API, and will be ignored if used in other APIs. This field will be omitted from all API responses including GetDataConnector API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema).", "$ref": "GoogleCloudDiscoveryengineV1alphaSchema" }, "params": { "description": "The parameters for the entity to facilitate data ingestion in structured json format.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "dataStore": { "readOnly": true, "description": "Output only. The full resource name of the associated data store for the source entity. Format: `projects/*/locations/*/collections/*/dataStores/*`. When the connector is initialized by the DataConnectorService.SetUpDataConnector method, a DataStore is automatically created for each source entity.", "type": "string" }, "jsonParams": { "description": "The parameters for the entity to facilitate data ingestion in json string format.", "type": "string" }, "keyPropertyMappings": { "additionalProperties": { "type": "string" }, "type": "object", "description": "Attributes for indexing. Key: Field name. Value: The key property to map a field to, such as `title`, and `description`. Supported key properties: * `title`: The title for data record. This would be displayed on search results. * `description`: The description for data record. This would be displayed on search results." }, "entityName": { "description": "The name of the entity. Supported values by data source: * Salesforce: `Lead`, `Opportunity`, `Contact`, `Account`, `Case`, `Contract`, `Campaign` * Jira: `Issue` * Confluence: `Content`, `Space`", "type": "string" } } }, "GoogleCloudDiscoveryengineV1Conversation": { "description": "External conversation proto definition.", "properties": { "state": { "type": "string", "enumDescriptions": [ "Unknown.", "Conversation is currently open.", "Conversation has been completed." ], "enum": [ "STATE_UNSPECIFIED", "IN_PROGRESS", "COMPLETED" ], "description": "The state of the Conversation." }, "name": { "type": "string", "description": "Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/dataStore/*/conversations/*` or `projects/{project}/locations/global/collections/{collection}/engines/*/conversations/*`." }, "startTime": { "format": "google-datetime", "description": "Output only. The time the conversation started.", "readOnly": true, "type": "string" }, "endTime": { "format": "google-datetime", "type": "string", "readOnly": true, "description": "Output only. The time the conversation finished." }, "messages": { "items": { "$ref": "GoogleCloudDiscoveryengineV1ConversationMessage" }, "description": "Conversation messages.", "type": "array" }, "userPseudoId": { "description": "A unique identifier for tracking users.", "type": "string" } }, "type": "object", "id": "GoogleCloudDiscoveryengineV1Conversation" }, "GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchMetadata": { "properties": { "createTime": { "description": "Operation create time.", "format": "google-datetime", "type": "string" }, "updateTime": { "format": "google-datetime", "description": "Operation last update time. If the operation is done, this is also the finish time.", "type": "string" } }, "type": "object", "id": "GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchMetadata", "description": "Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field." }, "GoogleCloudDiscoveryengineV1alphaDeleteIdentityMappingStoreMetadata": { "id": "GoogleCloudDiscoveryengineV1alphaDeleteIdentityMappingStoreMetadata", "type": "object", "properties": { "createTime": { "format": "google-datetime", "type": "string", "description": "Operation create time." }, "updateTime": { "type": "string", "description": "Operation last update time. If the operation is done, this is also the finish time.", "format": "google-datetime" } }, "description": "Metadata related to the progress of the IdentityMappingStoreService.DeleteIdentityMappingStore operation. This will be returned by the google.longrunning.Operation.metadata field." }, "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec": { "id": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec", "type": "object", "description": "Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above.", "properties": { "attributeType": { "type": "string", "description": "The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value).", "enum": [ "ATTRIBUTE_TYPE_UNSPECIFIED", "NUMERICAL", "FRESHNESS" ], "enumDescriptions": [ "Unspecified AttributeType.", "The value of the numerical field will be used to dynamically update the boost amount. In this case, the attribute_value (the x value) of the control point will be the actual value of the numerical field for which the boost_amount is specified.", "For the freshness use case the attribute value will be the duration between the current time and the date in the datetime field specified. The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`. For example, `5D`, `3DT12H30M`, `T24H`." ] }, "interpolationType": { "type": "string", "description": "The interpolation type to be applied to connect the control points listed below.", "enumDescriptions": [ "Interpolation type is unspecified. In this case, it defaults to Linear.", "Piecewise linear interpolation will be applied." ], "enum": [ "INTERPOLATION_TYPE_UNSPECIFIED", "LINEAR" ] }, "fieldName": { "description": "The name of the field whose value will be used to determine the boost amount.", "type": "string" }, "controlPoints": { "description": "The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here.", "items": { "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint" }, "type": "array" } } }, "A2aV1AgentCard": { "properties": { "provider": { "description": "The service provider of the agent.", "$ref": "A2aV1AgentProvider" }, "capabilities": { "description": "A2A Capability set supported by the agent.", "$ref": "A2aV1AgentCapabilities" }, "skills": { "items": { "$ref": "A2aV1AgentSkill" }, "description": "Skills represent a unit of ability an agent can perform. This may somewhat abstract but represents a more focused set of actions that the agent is highly likely to succeed at.", "type": "array" }, "preferredTransport": { "type": "string", "description": "The transport of the preferred endpoint. If empty, defaults to JSONRPC." }, "name": { "description": "A human readable name for the agent. Example: \"Recipe Agent\"", "type": "string" }, "signatures": { "items": { "$ref": "A2aV1AgentCardSignature" }, "description": "JSON Web Signatures computed for this AgentCard.", "type": "array" }, "supportsAuthenticatedExtendedCard": { "description": "Whether the agent supports providing an extended agent card when the user is authenticated, i.e. is the card from .well-known different than the card from GetAgentCard.", "type": "boolean" }, "description": { "type": "string", "description": "A description of the agent's domain of action/solution space. Example: \"Agent that helps users with recipes and cooking.\"" }, "defaultOutputModes": { "type": "array", "items": { "type": "string" }, "description": "The mime types supported as outputs from this agent." }, "security": { "items": { "$ref": "A2aV1Security" }, "type": "array", "description": "protolint:disable REPEATED_FIELD_NAMES_PLURALIZED Security requirements for contacting the agent. This list can be seen as an OR of ANDs. Each object in the list describes one possible set of security requirements that must be present on a request. This allows specifying, for example, \"callers must either use OAuth OR an API Key AND mTLS.\" Example: security { schemes { key: \"oauth\" value { list: [\"read\"] } } } security { schemes { key: \"api-key\" } schemes { key: \"mtls\" } }" }, "url": { "type": "string", "description": "A URL to the address the agent is hosted at. This represents the preferred endpoint as declared by the agent." }, "additionalInterfaces": { "description": "Announcement of additional supported transports. Client can use any of the supported transports.", "items": { "$ref": "A2aV1AgentInterface" }, "type": "array" }, "version": { "type": "string", "description": "The version of the agent. Example: \"1.0.0\"" }, "protocolVersion": { "description": "The version of the A2A protocol this agent supports.", "type": "string" }, "securitySchemes": { "description": "The security scheme details used for authenticating with this agent.", "additionalProperties": { "$ref": "A2aV1SecurityScheme" }, "type": "object" }, "iconUrl": { "description": "An optional URL to an icon for the agent.", "type": "string" }, "defaultInputModes": { "type": "array", "description": "protolint:enable REPEATED_FIELD_NAMES_PLURALIZED The set of interaction modes that the agent supports across all skills. This can be overridden per skill. Defined as mime types.", "items": { "type": "string" } }, "documentationUrl": { "description": "A url to provide additional documentation about the agent.", "type": "string" } }, "description": "AgentCard conveys key information: - Overall details (version, name, description, uses) - Skills; a set of actions/solutions the agent can perform - Default modalities/content types supported by the agent. - Authentication requirements Next ID: 19", "type": "object", "id": "A2aV1AgentCard" }, "GoogleCloudDiscoveryengineV1alphaSearchRequestPersonalizationSpec": { "properties": { "mode": { "description": "The personalization mode of the search request. Defaults to Mode.AUTO.", "enumDescriptions": [ "Default value. In this case, server behavior defaults to Mode.AUTO.", "Personalization is enabled if data quality requirements are met.", "Disable personalization." ], "enum": [ "MODE_UNSPECIFIED", "AUTO", "DISABLED" ], "type": "string" } }, "description": "The specification for personalization.", "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestPersonalizationSpec", "type": "object" }, "GoogleCloudDiscoveryengineV1Condition": { "type": "object", "description": "Defines circumstances to be checked before allowing a behavior", "properties": { "queryTerms": { "description": "Search only A list of terms to match the query on. Cannot be set when Condition.query_regex is set. Maximum of 10 query terms.", "items": { "$ref": "GoogleCloudDiscoveryengineV1ConditionQueryTerm" }, "type": "array" }, "activeTimeRange": { "items": { "$ref": "GoogleCloudDiscoveryengineV1ConditionTimeRange" }, "description": "Range of time(s) specifying when condition is active. Maximum of 10 time ranges.", "type": "array" }, "queryRegex": { "description": "Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. Only supported for Basic Site Search promotion serving controls.", "type": "string" } }, "id": "GoogleCloudDiscoveryengineV1Condition" }, "GoogleCloudDiscoveryengineV1AssistantGroundedContent": { "type": "object", "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.", "properties": { "content": { "$ref": "GoogleCloudDiscoveryengineV1AssistantContent", "description": "The content." }, "textGroundingMetadata": { "description": "Metadata for grounding based on text sources.", "$ref": "GoogleCloudDiscoveryengineV1AssistantGroundedContentTextGroundingMetadata" }, "citationMetadata": { "$ref": "GoogleCloudDiscoveryengineV1CitationMetadata", "description": "Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check" } }, "id": "GoogleCloudDiscoveryengineV1AssistantGroundedContent" }, "GoogleCloudDiscoveryengineV1SearchResponseSessionInfo": { "description": "Information about the session.", "properties": { "name": { "description": "Name of the session. If the auto-session mode is used (when SearchRequest.session ends with \"-\"), this field holds the newly generated session name.", "type": "string" }, "queryId": { "description": "Query ID that corresponds to this search API call. One session can have multiple turns, each with a unique query ID. By specifying the session name and this query ID in the Answer API call, the answer generation happens in the context of the search results from this search call.", "type": "string" } }, "type": "object", "id": "GoogleCloudDiscoveryengineV1SearchResponseSessionInfo" }, "GoogleCloudDiscoveryengineV1SearchRequestBoostSpecConditionBoostSpec": { "properties": { "boost": { "format": "float", "type": "number", "description": "Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored. Only one of the (condition, boost) combination or the boost_control_spec below are set. If both are set then the global boost is ignored and the more fine-grained boost_control_spec is applied." }, "condition": { "description": "An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost documents with document ID \"doc_1\" or \"doc_2\", and color \"Red\" or \"Blue\": `(document_id: ANY(\"doc_1\", \"doc_2\")) AND (color: ANY(\"Red\", \"Blue\"))`", "type": "string" }, "boostControlSpec": { "description": "Complex specification for custom ranking based on customer defined attribute value.", "$ref": "GoogleCloudDiscoveryengineV1SearchRequestBoostSpecConditionBoostSpecBoostControlSpec" } }, "id": "GoogleCloudDiscoveryengineV1SearchRequestBoostSpecConditionBoostSpec", "description": "Boost applies to documents which match a condition.", "type": "object" }, "GoogleCloudDiscoveryengineV1alphaAlphaEvolveProgramEvaluation": { "description": "Evaluation results for a program candidate.", "id": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveProgramEvaluation", "type": "object", "properties": { "scores": { "$ref": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveEvaluationScores", "description": "Optional. Contains the evaluation scores for the target metrics to optimize." }, "insights": { "description": "Optional. Represents various insights about the candidate, which are not directly used as optimization target, but that can be used to improve subsequent generations, and as such can be used to construct the evolution prompt.", "$ref": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveEvaluationInsights" } } }, "GoogleCloudDiscoveryengineV1alphaDataProtectionPolicy": { "type": "object", "description": "Contains the data protection policy config for a DataStore or a connector.", "id": "GoogleCloudDiscoveryengineV1alphaDataProtectionPolicy", "properties": { "sensitiveDataProtectionPolicy": { "$ref": "GoogleCloudDiscoveryengineV1alphaDataProtectionPolicySensitiveDataProtectionPolicy", "description": "Optional. Specifies the sensitive data protection policy for the connector source." } } }, "GoogleCloudDiscoveryengineV1betaDeleteEngineMetadata": { "description": "Metadata related to the progress of the EngineService.DeleteEngine operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1betaDeleteEngineMetadata", "properties": { "updateTime": { "type": "string", "format": "google-datetime", "description": "Operation last update time. If the operation is done, this is also the finish time." }, "createTime": { "format": "google-datetime", "description": "Operation create time.", "type": "string" } }, "type": "object" }, "GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpec": { "properties": { "attributeType": { "enum": [ "ATTRIBUTE_TYPE_UNSPECIFIED", "NUMERICAL", "FRESHNESS" ], "type": "string", "description": "Optional. The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value).", "enumDescriptions": [ "Unspecified AttributeType.", "The value of the numerical field will be used to dynamically update the boost amount. In this case, the attribute_value (the x value) of the control point will be the actual value of the numerical field for which the boost_amount is specified.", "For the freshness use case the attribute value will be the duration between the current time and the date in the datetime field specified. The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`. For example, `5D`, `3DT12H30M`, `T24H`." ] }, "fieldName": { "description": "Optional. The name of the field whose value will be used to determine the boost amount.", "type": "string" }, "interpolationType": { "enumDescriptions": [ "Interpolation type is unspecified. In this case, it defaults to Linear.", "Piecewise linear interpolation will be applied." ], "type": "string", "description": "Optional. The interpolation type to be applied to connect the control points listed below.", "enum": [ "INTERPOLATION_TYPE_UNSPECIFIED", "LINEAR" ] }, "controlPoints": { "description": "Optional. The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here.", "items": { "$ref": "GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpecControlPoint" }, "type": "array" } }, "description": "Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above.", "id": "GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpec", "type": "object" }, "GoogleCloudDiscoveryengineV1DataConnector": { "type": "object", "description": "Manages the connection to external data sources for all data stores grouped under a Collection. It's a singleton resource of Collection. The initialization is only supported through DataConnectorService.SetUpDataConnector method, which will create a new Collection and initialize its DataConnector.", "properties": { "createEuaSaas": { "type": "boolean", "description": "Optional. Whether the END USER AUTHENTICATION connector is created in SaaS." }, "dataProtectionPolicy": { "description": "Optional. Specifies the data protection policy for the connector.", "$ref": "GoogleCloudDiscoveryengineV1DataProtectionPolicy" }, "identityScheduleConfig": { "$ref": "GoogleCloudDiscoveryengineV1IdentityScheduleConfig", "description": "The configuration for the identity data synchronization runs. This contains the refresh interval to sync the Access Control List information for the documents ingested by this connector." }, "params": { "additionalProperties": { "description": "Properties of the object.", "type": "any" }, "type": "object", "description": "Required data connector parameters in structured json format." }, "federatedConfig": { "$ref": "GoogleCloudDiscoveryengineV1DataConnectorFederatedConfig", "description": "Optional. Any params and credentials used specifically for hybrid connectors supporting FEDERATED mode. This field should only be set if the connector is a hybrid connector and we want to enable FEDERATED mode." }, "entities": { "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1DataConnectorSourceEntity" }, "description": "List of entities from the connected data source to ingest." }, "actionConfig": { "$ref": "GoogleCloudDiscoveryengineV1ActionConfig", "description": "Optional. Action configurations to make the connector support actions." }, "errors": { "readOnly": true, "items": { "$ref": "GoogleRpcStatus" }, "type": "array", "description": "Output only. The errors from initialization or from the latest connector run." }, "latestPauseTime": { "type": "string", "format": "google-datetime", "readOnly": true, "description": "Output only. The most recent timestamp when this DataConnector was paused, affecting all functionalities such as data synchronization. Pausing a connector has the following effects: - All functionalities, including data synchronization, are halted. - Any ongoing data synchronization job will be canceled. - No future data synchronization runs will be scheduled nor can be triggered." }, "incrementalRefreshInterval": { "type": "string", "format": "google-duration", "description": "Optional. The refresh interval specifically for incremental data syncs. If unset, incremental syncs will use the default from env, set to 3hrs. The minimum is 30 minutes and maximum is 7 days. Applicable to only 3P connectors. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled." }, "tag": { "description": "Optional. Immutable. User-facing, version-independent label for this connector. May be shared by multiple connectors under the same (project, location, collection, data_source); tag-based lookup returns the one with the greatest create_time. Optional at Create time. Agent Designer resolves connectors via (data_source, tag) when set, falling back to the legacy resource-name lookup when unset, so connectors created before the tag-write launch continue to work without a backfill.", "type": "string" }, "aclEnabled": { "description": "Optional. Whether the connector will be created with an ACL config. Currently this field only affects Cloud Storage and BigQuery connectors.", "type": "boolean" }, "identityRefreshInterval": { "description": "The refresh interval to sync the Access Control List information for the documents ingested by this connector. If not set, the access control list will be refreshed at the default interval of 30 minutes. The identity refresh interval can be at least 30 minutes and at most 7 days.", "deprecated": true, "type": "string", "format": "google-duration" }, "updateTime": { "description": "Output only. Timestamp the DataConnector was last updated.", "format": "google-datetime", "type": "string", "readOnly": true }, "name": { "type": "string", "description": "Identifier. The full resource name of the Data Connector. Format: `projects/*/locations/*/collections/*/dataConnector`." }, "cliConfig": { "description": "Optional. The configuration for establishing a CLI connection.", "$ref": "GoogleCloudDiscoveryengineV1CliConfig" }, "state": { "type": "string", "description": "Output only. State of the connector.", "readOnly": true, "enum": [ "STATE_UNSPECIFIED", "CREATING", "ACTIVE", "FAILED", "RUNNING", "WARNING", "INITIALIZATION_FAILED", "UPDATING" ], "enumDescriptions": [ "Default value.", "The connector is being set up.", "The connector is successfully set up and awaiting next sync run.", "The connector is in error. The error details can be found in DataConnector.errors. If the error is unfixable, the DataConnector can be deleted by CollectionService.DeleteCollection API.", "The connector is actively syncing records from the data source.", "The connector has completed a sync run, but encountered non-fatal errors.", "Connector initialization failed. Potential causes include runtime errors or issues in the asynchronous pipeline, preventing the request from reaching downstream services (except for some connector types).", "Connector is in the process of an update." ] }, "refreshInterval": { "type": "string", "format": "google-duration", "description": "Required. The refresh interval for data sync. If duration is set to 0, the data will be synced in real time. The streaming feature is not supported yet. The minimum is 30 minutes and maximum is 7 days. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled." }, "vpcscEnabled": { "description": "Output only. Whether the connector is created with VPC-SC enabled.", "type": "boolean", "readOnly": true }, "connectorType": { "type": "string", "enum": [ "CONNECTOR_TYPE_UNSPECIFIED", "THIRD_PARTY", "GCP_FHIR", "BIG_QUERY", "GCS", "GOOGLE_MAIL", "GOOGLE_CALENDAR", "GOOGLE_DRIVE", "NATIVE_CLOUD_IDENTITY", "THIRD_PARTY_FEDERATED", "THIRD_PARTY_EUA", "GCNV", "GOOGLE_CHAT", "GOOGLE_SITES", "REMOTE_MCP", "GOOGLE_WORKSPACE" ], "enumDescriptions": [ "Default value.", "Third party connector to connector to third party application.", "Data connector connects between FHIR store and VAIS datastore.", "Big query connector.", "Google Cloud Storage connector.", "Gmail connector.", "Google Calendar connector.", "Google Drive connector.", "Native Cloud Identity connector for people search powered by People API.", "Federated connector, it is a third party connector that doesn't ingestion data, and search is powered by third party application's API.", "Connector utilized for End User Authentication features.", "Google Cloud NetApp Volumes connector.", "Google Chat connector.", "Google Sites connector.", "Remote MCP based connector.", "Google Workspace connector." ], "readOnly": true, "description": "Output only. The type of connector. Each source can only map to one type. For example, salesforce, confluence and jira have THIRD_PARTY connector type. It is not mutable once set by system." }, "destinationConfigs": { "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1DestinationConfig" }, "description": "Optional. Any target destinations used to connect to third-party services." }, "egressFqdns": { "description": "Output only. The list of FQDNs of the data connector can egress to. This includes both FQDN derived from the customer provided instance URL and default per connector type FQDNs.", "items": { "type": "string" }, "type": "array", "readOnly": true }, "hybridIngestionDisabled": { "type": "boolean", "description": "Optional. If the connector is a hybrid connector, determines whether ingestion is enabled and appropriate resources are provisioned during connector creation. If the connector is not a hybrid connector, this field is ignored." }, "jsonParams": { "type": "string", "description": "Required data connector parameters in json string format." }, "nextSyncTime": { "description": "Defines the scheduled time for the next data synchronization. This field requires hour , minute, and time_zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). This is utilized when the data connector has a refresh interval greater than 1 day. When the hours or minutes are not specified, we will assume a sync time of 0:00. The user must provide a time zone to avoid ambiguity.", "$ref": "GoogleTypeDateTime" }, "dynamicTools": { "description": "Output only. The dynamic tools fetched for this connector.", "readOnly": true, "items": { "$ref": "GoogleCloudDiscoveryengineV1DynamicTool" }, "type": "array" }, "metadata": { "$ref": "GoogleCloudDiscoveryengineV1DataConnectorConnectorMetadata", "description": "Optional. User-facing metadata for the connector. Populated from the connector's generated metadata / registry `ConnectorSource`." }, "blockingReasons": { "items": { "enum": [ "BLOCKING_REASON_UNSPECIFIED", "ALLOWLIST_STATIC_IP", "ALLOWLIST_IN_SERVICE_ATTACHMENT", "ALLOWLIST_SERVICE_ACCOUNT" ], "type": "string", "enumDescriptions": [ "Default value.", "Connector requires customer to allowlist static IPs.", "Connector requires customer to allowlist our project in their service attachment.", "Connector requires customer to allowlist service account in their project." ] }, "description": "Output only. User actions that must be completed before the connector can start syncing data.", "type": "array", "readOnly": true }, "createTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. Timestamp the DataConnector was created at.", "type": "string" }, "realtimeSyncConfig": { "description": "Optional. The configuration for realtime sync.", "$ref": "GoogleCloudDiscoveryengineV1DataConnectorRealtimeSyncConfig" }, "dataSource": { "description": "Required. The identifier for the data source. For the full, up-to-date list of supported connectors and their values, see [Connect a third-party data source](https://docs.cloud.google.com/gemini/enterprise/docs/connectors/connect-third-party-data-source#sources-by-launch-stage).", "type": "string" }, "realtimeState": { "enumDescriptions": [ "Default value.", "The connector is being set up.", "The connector is successfully set up and awaiting next sync run.", "The connector is in error. The error details can be found in DataConnector.errors. If the error is unfixable, the DataConnector can be deleted by CollectionService.DeleteCollection API.", "The connector is actively syncing records from the data source.", "The connector has completed a sync run, but encountered non-fatal errors.", "Connector initialization failed. Potential causes include runtime errors or issues in the asynchronous pipeline, preventing the request from reaching downstream services (except for some connector types).", "Connector is in the process of an update." ], "enum": [ "STATE_UNSPECIFIED", "CREATING", "ACTIVE", "FAILED", "RUNNING", "WARNING", "INITIALIZATION_FAILED", "UPDATING" ], "description": "Output only. real-time sync state", "type": "string", "readOnly": true }, "staticIpAddresses": { "type": "array", "description": "Output only. The static IP addresses used by this connector.", "readOnly": true, "items": { "type": "string" } }, "alertPolicyConfigs": { "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1AlertPolicyConfig" }, "description": "Optional. The connector level alert config." }, "connectorSourceId": { "description": "Optional. If set, this value instead of `data_source` is used to fetch the corresponding connector source.", "type": "string" }, "endUserConfig": { "$ref": "GoogleCloudDiscoveryengineV1DataConnectorEndUserConfig", "description": "Optional. Any params and credentials used specifically for EUA connectors." }, "privateConnectivityProjectId": { "type": "string", "readOnly": true, "description": "Output only. The tenant project ID associated with private connectivity connectors. This project must be allowlisted by in order for the connector to function." }, "bapConfig": { "$ref": "GoogleCloudDiscoveryengineV1BAPConfig", "description": "Optional. The configuration for establishing a BAP connection." }, "autoRunDisabled": { "description": "Optional. Indicates whether the connector is disabled for auto run. It can be used to pause periodical and real time sync. Update: with the introduction of incremental_sync_disabled, auto_run_disabled is used to pause/disable only full syncs", "type": "boolean" }, "actionState": { "type": "string", "readOnly": true, "enum": [ "STATE_UNSPECIFIED", "CREATING", "ACTIVE", "FAILED", "RUNNING", "WARNING", "INITIALIZATION_FAILED", "UPDATING" ], "description": "Output only. State of the action connector. This reflects whether the action connector is initializing, active or has encountered errors.", "enumDescriptions": [ "Default value.", "The connector is being set up.", "The connector is successfully set up and awaiting next sync run.", "The connector is in error. The error details can be found in DataConnector.errors. If the error is unfixable, the DataConnector can be deleted by CollectionService.DeleteCollection API.", "The connector is actively syncing records from the data source.", "The connector has completed a sync run, but encountered non-fatal errors.", "Connector initialization failed. Potential causes include runtime errors or issues in the asynchronous pipeline, preventing the request from reaching downstream services (except for some connector types).", "Connector is in the process of an update." ] }, "lastSyncTime": { "description": "Output only. For periodic connectors only, the last time a data sync was completed.", "type": "string", "format": "google-datetime", "readOnly": true }, "kmsKeyName": { "type": "string", "description": "Input only. The KMS key to be used to protect the DataStores managed by this connector. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStores created by this connector will be protected by the KMS key." }, "syncMode": { "enum": [ "PERIODIC", "STREAMING", "UNSPECIFIED" ], "enumDescriptions": [ "The connector will sync data periodically based on the refresh_interval. Use it with auto_run_disabled to pause the periodic sync, or indicate a one-time sync.", "The data will be synced in real time.", "Connector that doesn't ingest data will have this value" ], "type": "string", "description": "The data synchronization mode supported by the data connector." }, "removeParamKeys": { "items": { "type": "string" }, "type": "array", "description": "Optional. Specifies keys to be removed from the 'params' field. This is only active when 'params' is included in the 'update_mask' in an UpdateDataConnectorRequest. Deletion takes precedence if a key is both in 'remove_param_keys' and present in the 'params' field of the request." }, "oauthStaticIpAddresses": { "readOnly": true, "items": { "type": "string" }, "type": "array", "description": "Output only. The static IP addresses used by this connector for OAuth APIs (e.g. end user authentication). These are surfaced separately from `static_ip_addresses` so that customers can apply granular firewall settings for OAuth endpoints. Only populated for connectors that have static IP enabled and are used for actions and/or federated search." }, "connectorModes": { "type": "array", "description": "Optional. The modes enabled for this connector. Default state is CONNECTOR_MODE_UNSPECIFIED.", "items": { "enum": [ "CONNECTOR_MODE_UNSPECIFIED", "DATA_INGESTION", "ACTIONS", "FEDERATED", "EUA", "FEDERATED_AND_EUA" ], "type": "string", "enumDescriptions": [ "Connector mode unspecified.", "Connector utilized for data ingestion.", "Connector utilized for actions.", "Connector utilized for federated search.", "Connector utilized for End User Authentication.", "Hybrid connector utilized for federated search and End User Authentication." ] } }, "incrementalSyncDisabled": { "description": "Optional. Indicates whether incremental syncs are paused for this connector. This is independent of auto_run_disabled. Applicable to only 3P connectors. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled, i.e. set to true.", "type": "boolean" }, "staticIpEnabled": { "type": "boolean", "description": "Optional. Whether customer has enabled static IP addresses for this connector." } }, "id": "GoogleCloudDiscoveryengineV1DataConnector" }, "GoogleCloudDiscoveryengineV1BAPConfig": { "id": "GoogleCloudDiscoveryengineV1BAPConfig", "properties": { "toolspecOverride": { "$ref": "GoogleCloudDiscoveryengineV1BAPConfigToolspecOverride", "description": "Optional. Custom toolspec overrides for this connection. For Enterprise BAP connectors that support admin-curated tool definitions, this holds the (simplified) per-tool overrides. On Get, populated by the server by merging persisted overrides with live runtime tool definitions and trimming the result for UI consumption. On Update, the supplied value replaces the persisted overrides after server-side validation and merging: the `base_version` field MUST match the server's current base toolspec version (otherwise the request is rejected with a user-facing error directing the admin to re-download the latest tools first)." }, "enabledActions": { "type": "array", "items": { "type": "string" }, "description": "Optional. The actions enabled on the associated BAP connection." }, "supportedConnectorModes": { "items": { "enumDescriptions": [ "Connector mode unspecified.", "Connector utilized for data ingestion.", "Connector utilized for Actions", "Connector utilized for End User Authentication." ], "type": "string", "enum": [ "CONNECTOR_MODE_UNSPECIFIED", "DATA_INGESTION", "ACTIONS", "END_USER_AUTHENTICATION" ] }, "type": "array", "description": "Required. The supported connector modes for the associated BAP connection." } }, "description": "The configuration for the BAP connector.", "type": "object" }, "GoogleCloudDiscoveryengineV1alphaControlBoostAction": { "description": "Adjusts order of products in returned list.", "properties": { "filter": { "type": "string", "description": "Required. Specifies which products to apply the boost to. If no filter is provided all products will be boosted (No-op). Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown." }, "dataStore": { "description": "Required. Specifies which data store's documents can be boosted by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store", "type": "string" }, "interpolationBoostSpec": { "description": "Optional. Complex specification for custom ranking based on customer defined attribute value.", "$ref": "GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpec" }, "fixedBoost": { "description": "Optional. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).", "type": "number", "format": "float" }, "boost": { "deprecated": true, "type": "number", "description": "Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).", "format": "float" } }, "id": "GoogleCloudDiscoveryengineV1alphaControlBoostAction", "type": "object" }, "GoogleApiDistributionExemplar": { "properties": { "value": { "type": "number", "description": "Value of the exemplar point. This value determines to which bucket the exemplar belongs.", "format": "double" }, "attachments": { "items": { "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" }, "type": "object" }, "type": "array", "description": "Contextual information about the example value. Examples are: Trace: type.googleapis.com/google.monitoring.v3.SpanContext Literal string: type.googleapis.com/google.protobuf.StringValue Labels dropped during aggregation: type.googleapis.com/google.monitoring.v3.DroppedLabels There may be only a single attachment of any given message type in a single exemplar, and this is enforced by the system." }, "timestamp": { "description": "The observation (sampling) time of the above value.", "format": "google-datetime", "type": "string" } }, "type": "object", "description": "Exemplars are example points that may be used to annotate aggregated distribution values. They are metadata that gives information about a particular value added to a Distribution bucket, such as a trace ID that was active when a value was added. They may contain further information, such as a example values and timestamps, origin, etc.", "id": "GoogleApiDistributionExemplar" }, "GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResult": { "type": "object", "id": "GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResult", "properties": { "structData": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "description": "Data representation. The structured JSON data for the document. It's populated from the struct data from the Document, or the Chunk in search result.", "type": "object" }, "snippetInfo": { "type": "array", "description": "If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets.", "items": { "$ref": "GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResultSnippetInfo" } }, "title": { "type": "string", "description": "Title." }, "document": { "description": "Document resource name.", "type": "string" }, "chunkInfo": { "description": "If citation_type is CHUNK_LEVEL_CITATION and chunk mode is on, populate chunk info.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResultChunkInfo" } }, "uri": { "type": "string", "description": "URI for the document." } } }, "GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsResponse": { "id": "GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsResponse", "description": "Response of the CompletionService.ImportCompletionSuggestions method. If the long running operation is done, this message is returned by the google.longrunning.Operations.response field if the operation is successful.", "type": "object", "properties": { "errorConfig": { "description": "The desired location of errors incurred during the Import.", "$ref": "GoogleCloudDiscoveryengineV1betaImportErrorConfig" }, "errorSamples": { "items": { "$ref": "GoogleRpcStatus" }, "type": "array", "description": "A sample of errors encountered while processing the request." } } }, "GoogleCloudDiscoveryengineV1alphaPatientFilterOperationMetadata": { "id": "GoogleCloudDiscoveryengineV1alphaPatientFilterOperationMetadata", "properties": { "updateTime": { "type": "string", "description": "Operation last update time. If the operation is done, this is also the finish time.", "format": "google-datetime" }, "filtersAddedCount": { "format": "int64", "description": "The number of patient IDs added to the patient filter.", "type": "string" }, "filtersRemovedCount": { "type": "string", "description": "The number of patient IDs removed from the patient filter.", "format": "int64" }, "createTime": { "format": "google-datetime", "type": "string", "description": "Operation create time." } }, "description": "Metadata related to the progress of the various patient filter operations. This will be returned by the google.longrunning.Operation.metadata field.", "type": "object" }, "GoogleCloudDiscoveryengineV1betaProvisionProjectMetadata": { "properties": {}, "type": "object", "description": "Metadata associated with a project provision operation.", "id": "GoogleCloudDiscoveryengineV1betaProvisionProjectMetadata" }, "GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpec": { "type": "object", "id": "GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpec", "properties": { "disable": { "type": "boolean", "description": "Disable query rephraser." }, "modelSpec": { "$ref": "GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpecModelSpec", "description": "Optional. Query Rephraser Model specification." }, "maxRephraseSteps": { "description": "Max rephrase steps. The max number is 5 steps. If not set or set to \u003c 1, it will be set to 1 by default.", "format": "int32", "type": "integer" } }, "description": "Query rephraser specification." }, "GoogleCloudDiscoveryengineV1alphaDeleteSessionRequest": { "description": "Request for DeleteSession method.", "type": "object", "id": "GoogleCloudDiscoveryengineV1alphaDeleteSessionRequest", "properties": { "name": { "type": "string", "description": "Required. The resource name of the Session to delete. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`" } } }, "GoogleCloudDiscoveryengineV1SingleRegionKey": { "type": "object", "description": "Metadata for single-regional CMEKs.", "properties": { "kmsKey": { "type": "string", "description": "Required. Single-regional kms key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`." } }, "id": "GoogleCloudDiscoveryengineV1SingleRegionKey" }, "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.", "type": "object", "id": "GoogleCloudDiscoveryengineV1alphaAssistantGroundedContent", "properties": { "textGroundingMetadata": { "description": "Metadata for grounding based on text sources.", "$ref": "GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadata" }, "citationMetadata": { "$ref": "GoogleCloudDiscoveryengineV1alphaCitationMetadata", "description": "Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check" }, "content": { "description": "The content.", "$ref": "GoogleCloudDiscoveryengineV1alphaAssistantContent" } } }, "GoogleCloudDiscoveryengineV1BatchUpdateUserLicensesRequest": { "description": "Request message for UserLicenseService.BatchUpdateUserLicenses method.", "properties": { "deleteUnassignedUserLicenses": { "description": "Optional. If true, if user licenses removed associated license config, the user license will be deleted. By default which is false, the user license will be updated to unassigned state.", "type": "boolean" }, "inlineSource": { "description": "The inline source for the input content for license assignment.", "$ref": "GoogleCloudDiscoveryengineV1BatchUpdateUserLicensesRequestInlineSource" } }, "id": "GoogleCloudDiscoveryengineV1BatchUpdateUserLicensesRequest", "type": "object" }, "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec": { "description": "Specification of the model.", "properties": { "version": { "description": "The model version used to generate the summary. Supported values are: * `stable`: string. Default value when no value is specified. Uses a generally available, fine-tuned model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). * `preview`: string. (Public preview) Uses a preview model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models).", "type": "string" } }, "type": "object", "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec" }, "GoogleCloudDiscoveryengineV1ObservabilityConfig": { "description": "Observability config for a resource.", "type": "object", "properties": { "sensitiveLoggingEnabled": { "type": "boolean", "description": "Optional. Enables sensitive logging. Sensitive logging includes customer core content (e.g. prompts, responses). If `false`, will sanitize all sensitive fields." }, "observabilityEnabled": { "description": "Optional. Enables observability. If `false`, all other flags are ignored.", "type": "boolean" } }, "id": "GoogleCloudDiscoveryengineV1ObservabilityConfig" }, "GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesMetadata": { "description": "Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", "type": "object", "properties": { "createTime": { "format": "google-datetime", "description": "Operation create time.", "type": "string" }, "updateTime": { "format": "google-datetime", "description": "Operation last update time. If the operation is done, this is also the finish time.", "type": "string" } }, "id": "GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesMetadata" }, "GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperiment": { "properties": { "initialAlphaEvolveProgram": { "description": "Output only. Specifies the name of the seed program used to start the experiment.", "type": "string", "readOnly": true }, "name": { "type": "string", "description": "Identifier. The full resource name of the experiment. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/alphaEvolveExperiments/{alpha_evolve_experiment}`" }, "createTime": { "format": "google-datetime", "readOnly": true, "type": "string", "description": "Output only. Time when the experiment was created." }, "config": { "description": "Required. Experiment configuration.", "$ref": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentConfig" }, "state": { "readOnly": true, "description": "Output only. The state of the experiment.", "enum": [ "STATE_UNSPECIFIED", "CREATED", "RUNNING", "PAUSED", "COMPLETED", "FAILED" ], "enumDescriptions": [ "Default value. This value is unused.", "The experiment is created.", "The experiment is running.", "The experiment is paused.", "The experiment is completed.", "The experiment has failed." ], "type": "string" }, "stats": { "readOnly": true, "description": "Output only. Experiment stats.", "$ref": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentStats" } }, "id": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperiment", "type": "object", "description": "An experiment is a single run of the AlphaEvolve agent, an evolutionary coding agent powered by LLM for algorithm discovery and optimization." }, "GoogleCloudDiscoveryengineV1alphaControl": { "description": "Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`.", "id": "GoogleCloudDiscoveryengineV1alphaControl", "type": "object", "properties": { "useCases": { "items": { "enum": [ "SEARCH_USE_CASE_UNSPECIFIED", "SEARCH_USE_CASE_SEARCH", "SEARCH_USE_CASE_BROWSE" ], "enumDescriptions": [ "Value used when unset. Will not occur in CSS.", "Search use case. Expects the traffic has a non-empty query.", "Browse use case. Expects the traffic has an empty query." ], "type": "string" }, "description": "Specifies the use case for the control. Affects what condition fields can be set. Only applies to SOLUTION_TYPE_SEARCH. Currently only allow one use case per control. Must be set when solution_type is SolutionType.SOLUTION_TYPE_SEARCH.", "type": "array" }, "associatedServingConfigIds": { "readOnly": true, "type": "array", "items": { "type": "string" }, "description": "Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes." }, "solutionType": { "description": "Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown.", "enumDescriptions": [ "Default value.", "Used for Recommendations AI.", "Used for Discovery Search.", "Used for use cases related to the Generative AI agent.", "Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution.", "Used for AI Mode." ], "enum": [ "SOLUTION_TYPE_UNSPECIFIED", "SOLUTION_TYPE_RECOMMENDATION", "SOLUTION_TYPE_SEARCH", "SOLUTION_TYPE_CHAT", "SOLUTION_TYPE_GENERATIVE_CHAT", "SOLUTION_TYPE_AI_MODE" ], "type": "string" }, "conditions": { "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaCondition" }, "type": "array", "description": "Determines when the associated action will trigger. Omit to always apply the action. Currently only a single condition may be specified. Otherwise an INVALID ARGUMENT error is thrown." }, "promoteAction": { "$ref": "GoogleCloudDiscoveryengineV1alphaControlPromoteAction", "description": "Promote certain links based on predefined trigger queries." }, "filterAction": { "$ref": "GoogleCloudDiscoveryengineV1alphaControlFilterAction", "description": "Defines a filter-type control Currently not supported by Recommendation" }, "redirectAction": { "description": "Defines a redirect-type control.", "$ref": "GoogleCloudDiscoveryengineV1alphaControlRedirectAction" }, "name": { "description": "Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*`", "type": "string" }, "synonymsAction": { "$ref": "GoogleCloudDiscoveryengineV1alphaControlSynonymsAction", "description": "Treats a group of terms as synonyms of one another." }, "displayName": { "description": "Required. Human readable name. The identifier used in UI views. Must be UTF-8 encoded string. Length limit is 128 characters. Otherwise an INVALID ARGUMENT error is thrown.", "type": "string" }, "boostAction": { "description": "Defines a boost-type control", "$ref": "GoogleCloudDiscoveryengineV1alphaControlBoostAction" } } }, "GoogleCloudDiscoveryengineV1TrainCustomModelRequestGcsTrainingInput": { "properties": { "queryDataPath": { "description": "The gcs query data which could be associated in train data. The data path format is `gs:///`. A newline delimited jsonl/ndjson file. For search-tuning model, each line should have the _id and text. Example: {\"_id\": \"query1\", \"text\": \"example query\"}", "type": "string" }, "trainDataPath": { "type": "string", "description": "Cloud Storage training data path whose format should be `gs:///`. The file should be in tsv format. Each line should have the doc_id and query_id and score (number). For search-tuning model, it should have the query-id corpus-id score as tsv file header. The score should be a number in `[0, inf+)`. The larger the number is, the more relevant the pair is. Example: * `query-id\\tcorpus-id\\tscore` * `query1\\tdoc1\\t1`" }, "testDataPath": { "description": "Cloud Storage test data. Same format as train_data_path. If not provided, a random 80/20 train/test split will be performed on train_data_path.", "type": "string" }, "corpusDataPath": { "description": "The Cloud Storage corpus data which could be associated in train data. The data path format is `gs:///`. A newline delimited jsonl/ndjson file. For search-tuning model, each line should have the _id, title and text. Example: `{\"_id\": \"doc1\", title: \"relevant doc\", \"text\": \"relevant text\"}`", "type": "string" } }, "description": "Cloud Storage training data input.", "id": "GoogleCloudDiscoveryengineV1TrainCustomModelRequestGcsTrainingInput", "type": "object" }, "GoogleCloudDiscoveryengineV1SearchResponseNaturalLanguageQueryUnderstandingInfo": { "description": "Information describing what natural language understanding was done on the input query.", "type": "object", "properties": { "rewrittenQuery": { "type": "string", "description": "Rewritten input query minus the extracted filters." }, "classifiedIntents": { "description": "The classified intents from the input query.", "type": "array", "items": { "type": "string" } }, "structuredExtractedFilter": { "description": "The filters that were extracted from the input query represented in a structured form.", "$ref": "GoogleCloudDiscoveryengineV1SearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilter" }, "extractedFilters": { "type": "string", "description": "The filters that were extracted from the input query." } }, "id": "GoogleCloudDiscoveryengineV1SearchResponseNaturalLanguageQueryUnderstandingInfo" }, "GoogleCloudDiscoveryengineV1SearchRequestDisplaySpec": { "description": "Specifies features for display, like match highlighting.", "type": "object", "properties": { "matchHighlightingCondition": { "description": "The condition under which match highlighting should occur.", "enum": [ "MATCH_HIGHLIGHTING_CONDITION_UNSPECIFIED", "MATCH_HIGHLIGHTING_DISABLED", "MATCH_HIGHLIGHTING_ENABLED" ], "type": "string", "enumDescriptions": [ "Server behavior is the same as `MATCH_HIGHLIGHTING_DISABLED`.", "Disables match highlighting on all documents.", "Enables match highlighting on all documents." ] } }, "id": "GoogleCloudDiscoveryengineV1SearchRequestDisplaySpec" }, "GoogleCloudDiscoveryengineV1ListTargetSitesResponse": { "description": "Response message for SiteSearchEngineService.ListTargetSites method.", "id": "GoogleCloudDiscoveryengineV1ListTargetSitesResponse", "properties": { "totalSize": { "type": "integer", "format": "int32", "description": "The total number of items matching the request. This will always be populated in the response." }, "targetSites": { "items": { "$ref": "GoogleCloudDiscoveryengineV1TargetSite" }, "description": "List of TargetSites.", "type": "array" }, "nextPageToken": { "type": "string", "description": "A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages." } }, "type": "object" }, "GoogleCloudDiscoveryengineV1CustomAttribute": { "description": "A custom attribute that is not explicitly modeled in a resource, e.g. UserEvent.", "properties": { "numbers": { "type": "array", "items": { "format": "double", "type": "number" }, "description": "The numerical values of this custom attribute. For example, `[2.3, 15.4]` when the key is \"lengths_cm\". Exactly one of CustomAttribute.text or CustomAttribute.numbers should be set. Otherwise, an `INVALID_ARGUMENT` error is returned." }, "text": { "type": "array", "items": { "type": "string" }, "description": "The textual values of this custom attribute. For example, `[\"yellow\", \"green\"]` when the key is \"color\". Empty string is not allowed. Otherwise, an `INVALID_ARGUMENT` error is returned. Exactly one of CustomAttribute.text or CustomAttribute.numbers should be set. Otherwise, an `INVALID_ARGUMENT` error is returned." } }, "id": "GoogleCloudDiscoveryengineV1CustomAttribute", "type": "object" }, "GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfigNotebooklmConfig": { "id": "GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfigNotebooklmConfig", "description": "Config for connecting to NotebookLM Enterprise.", "properties": { "searchConfig": { "description": "Required. Search config name. Format: projects/*/locations/global/notebookLmSearchConfigs/*", "type": "string" } }, "type": "object" }, "GoogleCloudDiscoveryengineV1EngineSearchEngineConfig": { "id": "GoogleCloudDiscoveryengineV1EngineSearchEngineConfig", "properties": { "requiredSubscriptionTier": { "description": "Optional. The required subscription tier of this engine. If the required subscription tier is search, user with higher license tier like assist can still access the standalone app associated with this engine. Web grounding feature is only available on the app if it is set as SubscriptionTier.SUBSCRIPTION_TIER_SEARCH_AND_ASSISTANT.", "type": "string", "enumDescriptions": [ "Default value.", "Search tier. Search tier can access Vertex AI Search features and NotebookLM features.", "Gemini Enterprise Plus tier.", "NotebookLM tier. NotebookLM is a subscription tier can only access NotebookLM features.", "Gemini Frontline worker tier.", "Gemini Business Starter tier.", "Gemini Business tier.", "Gemini Enterprise Standard tier.", "Gemini Enterprise Standard tier for emerging markets.", "Gemini Enterprise EDU tier.", "Gemini Enterprise EDU Pro tier.", "Gemini Enterprise EDU tier for emerging market only.", "Gemini Enterprise EDU Pro tier for emerging market.", "Gemini Frontline Starter tier.", "Represents the Gemini Enterprise Consumption-only tier: $0 subscription billed purely on usage (PAYG).", "Gemini Enterprise EDU tier for government in emerging markets." ], "enum": [ "SUBSCRIPTION_TIER_UNSPECIFIED", "SUBSCRIPTION_TIER_SEARCH", "SUBSCRIPTION_TIER_SEARCH_AND_ASSISTANT", "SUBSCRIPTION_TIER_NOTEBOOK_LM", "SUBSCRIPTION_TIER_FRONTLINE_WORKER", "SUBSCRIPTION_TIER_AGENTSPACE_STARTER", "SUBSCRIPTION_TIER_AGENTSPACE_BUSINESS", "SUBSCRIPTION_TIER_ENTERPRISE", "SUBSCRIPTION_TIER_ENTERPRISE_EMERGING", "SUBSCRIPTION_TIER_EDU", "SUBSCRIPTION_TIER_EDU_PRO", "SUBSCRIPTION_TIER_EDU_EMERGING", "SUBSCRIPTION_TIER_EDU_PRO_EMERGING", "SUBSCRIPTION_TIER_FRONTLINE_STARTER", "SUBSCRIPTION_TIER_CONSUMPTION_ONLY", "SUBSCRIPTION_TIER_EDU_GOV_EMERGING" ] }, "searchTier": { "description": "The search feature tier of this engine. Different tiers might have different pricing. To learn more, check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified.", "enumDescriptions": [ "Default value when the enum is unspecified. This is invalid to use.", "Standard tier.", "Enterprise tier." ], "type": "string", "enum": [ "SEARCH_TIER_UNSPECIFIED", "SEARCH_TIER_STANDARD", "SEARCH_TIER_ENTERPRISE" ] }, "searchAddOns": { "items": { "enumDescriptions": [ "Default value when the enum is unspecified. This is invalid to use.", "Large language model add-on." ], "enum": [ "SEARCH_ADD_ON_UNSPECIFIED", "SEARCH_ADD_ON_LLM" ], "type": "string" }, "description": "The add-on that this search engine enables.", "type": "array" } }, "type": "object", "description": "Configurations for a Search Engine." }, "GoogleCloudDiscoveryengineV1ControlBoostAction": { "properties": { "fixedBoost": { "format": "float", "description": "Optional. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).", "type": "number" }, "interpolationBoostSpec": { "$ref": "GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpec", "description": "Optional. Complex specification for custom ranking based on customer defined attribute value." }, "dataStore": { "description": "Required. Specifies which data store's documents can be boosted by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store", "type": "string" }, "filter": { "description": "Required. Specifies which products to apply the boost to. If no filter is provided all products will be boosted (No-op). Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown.", "type": "string" }, "boost": { "description": "Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).", "type": "number", "format": "float", "deprecated": true } }, "id": "GoogleCloudDiscoveryengineV1ControlBoostAction", "description": "Adjusts order of products in returned list.", "type": "object" }, "GoogleCloudDiscoveryengineV1Engine": { "id": "GoogleCloudDiscoveryengineV1Engine", "properties": { "connectorTenantInfo": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Optional. Maps a connector ID (e.g., \"hybrid-github\", \"shopify\") to tenant-specific information required for that connector. The structure of the tenant information string is connector-dependent." }, "agentGatewaySetting": { "description": "Optional. The agent gateway setting for the engine.", "$ref": "GoogleCloudDiscoveryengineV1AgentGatewaySetting" }, "modelConfigs": { "additionalProperties": { "enumDescriptions": [ "The model state is unspecified.", "The model is enabled by admin.", "The model is disabled by admin." ], "type": "string", "enum": [ "MODEL_STATE_UNSPECIFIED", "MODEL_ENABLED", "MODEL_DISABLED" ] }, "description": "Optional. Maps a model name to its specific configuration for this engine. This allows admin users to turn on/off individual models. This only stores models whose states are overridden by the admin. When the state is unspecified, or model_configs is empty for this model, the system will decide if this model should be available or not based on the default configuration. For example, a preview model should be disabled by default if the admin has not chosen to enable it.", "type": "object" }, "updateTime": { "format": "google-datetime", "description": "Output only. Timestamp the Recommendation Engine was last updated.", "type": "string", "readOnly": true }, "displayName": { "description": "Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.", "type": "string" }, "procurementContactEmails": { "items": { "type": "string" }, "type": "array", "description": "Optional. The emails of the procurement contacts." }, "chatEngineConfig": { "description": "Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.", "$ref": "GoogleCloudDiscoveryengineV1EngineChatEngineConfig" }, "features": { "description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `speech-to-text` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `canvas-app-builder` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications`", "type": "object", "additionalProperties": { "enumDescriptions": [ "The feature state is unspecified.", "The feature is turned on to be accessible.", "The feature is turned off to be inaccessible." ], "enum": [ "FEATURE_STATE_UNSPECIFIED", "FEATURE_STATE_ON", "FEATURE_STATE_OFF" ], "type": "string" } }, "industryVertical": { "enum": [ "INDUSTRY_VERTICAL_UNSPECIFIED", "GENERIC", "MEDIA", "HEALTHCARE_FHIR" ], "type": "string", "enumDescriptions": [ "Value used when unset.", "The generic vertical for documents that are not specific to any industry vertical.", "The media industry vertical.", "The healthcare FHIR vertical." ], "description": "Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine." }, "marketplaceAgentVisibility": { "description": "Optional. The visibility of marketplace agents in the agent gallery.", "enum": [ "MARKETPLACE_AGENT_VISIBILITY_UNSPECIFIED", "SHOW_AVAILABLE_AGENTS_ONLY", "SHOW_AGENTS_ALREADY_INTEGRATED", "SHOW_AGENTS_ALREADY_PURCHASED", "SHOW_ALL_AGENTS" ], "type": "string", "enumDescriptions": [ "Defaults to `MARKETPLACE_AGENT_VISIBILITY_UNSPECIFIED`.", "Only agents that are currently available for use by the user are visible.", "Show marketplace agents that the user does not yet have access to but are integrated into the engine. This level also includes all agents visible with `SHOW_AVAILABLE_AGENTS_ONLY`.", "Show all agents visible with `SHOW_AGENTS_ALREADY_INTEGRATED`, plus agents that have already been purchased by the project/organization, even if they are not currently integrated into the engine.", "All agents in the marketplace are visible, regardless of access or purchase status. This level encompasses all agents shown in the previous levels." ] }, "name": { "type": "string", "description": "Immutable. Identifier. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned." }, "sessionConfig": { "description": "Optional. Non-empty default. Session config for the engine.", "$ref": "GoogleCloudDiscoveryengineV1SessionConfig" }, "associatedAgentRegistry": { "type": "string", "description": "Output only. The Agent registry containing the agents, MCP servers and tools associated with this engine. Derived server-side from the linked Agent Gateway's registry.", "readOnly": true }, "dataStoreIds": { "type": "array", "description": "Optional. The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations.", "items": { "type": "string" } }, "mediaRecommendationEngineConfig": { "description": "Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical.", "$ref": "GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfig" }, "observabilityConfig": { "$ref": "GoogleCloudDiscoveryengineV1ObservabilityConfig", "description": "Optional. Observability config for the engine." }, "appType": { "description": "Optional. Immutable. This the application type which this engine resource represents. NOTE: this is a new concept independ of existing industry vertical or solution type.", "enumDescriptions": [ "All non specified apps.", "App type for intranet search and Agentspace." ], "enum": [ "APP_TYPE_UNSPECIFIED", "APP_TYPE_INTRANET" ], "type": "string" }, "configurableBillingApproach": { "enum": [ "CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED", "CONFIGURABLE_BILLING_APPROACH_ENABLED" ], "type": "string", "enumDescriptions": [ "Default value. For Spark and non-Spark non-configurable billing approach. General pricing model.", "The billing approach follows configurations specified by customer." ], "description": "Optional. Configuration for configurable billing approach." }, "knowledgeGraphConfig": { "description": "Optional. Configurations for the Knowledge Graph. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.", "$ref": "GoogleCloudDiscoveryengineV1EngineKnowledgeGraphConfig" }, "commonConfig": { "description": "Common config spec that specifies the metadata of the engine.", "$ref": "GoogleCloudDiscoveryengineV1EngineCommonConfig" }, "chatEngineMetadata": { "readOnly": true, "description": "Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.", "$ref": "GoogleCloudDiscoveryengineV1EngineChatEngineMetadata" }, "solutionType": { "type": "string", "enum": [ "SOLUTION_TYPE_UNSPECIFIED", "SOLUTION_TYPE_RECOMMENDATION", "SOLUTION_TYPE_SEARCH", "SOLUTION_TYPE_CHAT", "SOLUTION_TYPE_GENERATIVE_CHAT", "SOLUTION_TYPE_AI_MODE" ], "description": "Required. The solutions of the engine.", "enumDescriptions": [ "Default value.", "Used for Recommendations AI.", "Used for Discovery Search.", "Used for use cases related to the Generative AI agent.", "Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution.", "Used for AI Mode." ] }, "cmekConfig": { "$ref": "GoogleCloudDiscoveryengineV1CmekConfig", "description": "Output only. CMEK-related information for the Engine.", "readOnly": true }, "createTime": { "readOnly": true, "description": "Output only. Timestamp the Recommendation Engine was created at.", "type": "string", "format": "google-datetime" }, "searchEngineConfig": { "$ref": "GoogleCloudDiscoveryengineV1EngineSearchEngineConfig", "description": "Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH." }, "disableAnalytics": { "description": "Optional. Whether to disable analytics for searches performed on this engine.", "type": "boolean" } }, "description": "Metadata that describes the training and serving parameters of an Engine.", "type": "object" }, "GoogleCloudDiscoveryengineV1alphaEvaluation": { "type": "object", "id": "GoogleCloudDiscoveryengineV1alphaEvaluation", "description": "An evaluation is a single execution (or run) of an evaluation process. It encapsulates the state of the evaluation and the resulting data.", "properties": { "name": { "type": "string", "description": "Identifier. The full resource name of the Evaluation, in the format of `projects/{project}/locations/{location}/evaluations/{evaluation}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters." }, "endTime": { "description": "Output only. Timestamp the Evaluation was completed at.", "format": "google-datetime", "type": "string", "readOnly": true }, "evaluationSpec": { "description": "Required. The specification of the evaluation.", "$ref": "GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpec" }, "qualityMetrics": { "$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetrics", "readOnly": true, "description": "Output only. The metrics produced by the evaluation, averaged across all SampleQuerys in the SampleQuerySet. Only populated when the evaluation's state is SUCCEEDED." }, "createTime": { "description": "Output only. Timestamp the Evaluation was created at.", "type": "string", "format": "google-datetime", "readOnly": true }, "errorSamples": { "items": { "$ref": "GoogleRpcStatus" }, "readOnly": true, "type": "array", "description": "Output only. A sample of errors encountered while processing the request." }, "state": { "enumDescriptions": [ "The evaluation is unspecified.", "The service is preparing to run the evaluation.", "The evaluation is in progress.", "The evaluation completed successfully.", "The evaluation failed." ], "enum": [ "STATE_UNSPECIFIED", "PENDING", "RUNNING", "SUCCEEDED", "FAILED" ], "description": "Output only. The state of the evaluation.", "readOnly": true, "type": "string" }, "error": { "description": "Output only. The error that occurred during evaluation. Only populated when the evaluation's state is FAILED.", "$ref": "GoogleRpcStatus", "readOnly": true } } }, "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig": { "properties": { "trainingState": { "description": "The training state that the engine is in (e.g. `TRAINING` or `PAUSED`). Since part of the cost of running the service is frequency of training - this can be used to determine when to train engine in order to control cost. If not specified: the default value for `CreateEngine` method is `TRAINING`. The default value for `UpdateEngine` method is to keep the state the same as before.", "enum": [ "TRAINING_STATE_UNSPECIFIED", "PAUSED", "TRAINING" ], "enumDescriptions": [ "Unspecified training state.", "The engine training is paused.", "The engine is training." ], "type": "string" }, "engineFeaturesConfig": { "description": "Optional. Additional engine features config.", "$ref": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigEngineFeaturesConfig" }, "optimizationObjective": { "description": "The optimization objective. e.g., `cvr`. This field together with optimization_objective describe engine metadata to use to control engine training and serving. Currently supported values: `ctr`, `cvr`. If not specified, we choose default based on engine type. Default depends on type of recommendation: `recommended-for-you` =\u003e `ctr` `others-you-may-like` =\u003e `ctr`", "type": "string" }, "type": { "type": "string", "description": "Required. The type of engine. e.g., `recommended-for-you`. This field together with optimization_objective describe engine metadata to use to control engine training and serving. Currently supported values: `recommended-for-you`, `others-you-may-like`, `more-like-this`, `most-popular-items`." }, "optimizationObjectiveConfig": { "$ref": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig", "description": "Name and value of the custom threshold for cvr optimization_objective. For target_field `watch-time`, target_field_value must be an integer value indicating the media progress time in seconds between (0, 86400] (excludes 0, includes 86400) (e.g., 90). For target_field `watch-percentage`, the target_field_value must be a valid float value between (0, 1.0] (excludes 0, includes 1.0) (e.g., 0.5)." } }, "type": "object", "description": "Additional config specs for a Media Recommendation engine.", "id": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig" }, "GoogleCloudDiscoveryengineV1AssistUserMetadata": { "type": "object", "properties": { "timeZone": { "description": "Optional. IANA time zone, e.g. Europe/Budapest.", "type": "string" }, "preferredLanguageCode": { "type": "string", "description": "Optional. Preferred language to be used for answering if language detection fails. Also used as the language of error messages created by actions, regardless of language detection results." } }, "id": "GoogleCloudDiscoveryengineV1AssistUserMetadata", "description": "User metadata of the request." }, "GoogleCloudDiscoveryengineV1alphaSearchRequest": { "id": "GoogleCloudDiscoveryengineV1alphaSearchRequest", "type": "object", "description": "Request message for SearchService.Search method.", "properties": { "offset": { "type": "integer", "description": "A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. A large offset may be capped to a reasonable threshold.", "format": "int32" }, "userLabels": { "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.", "additionalProperties": { "type": "string" }, "type": "object" }, "orderBy": { "type": "string", "description": "The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned." }, "customFineTuningSpec": { "description": "Custom fine tuning configs. If set, it has higher priority than the configs set in ServingConfig.custom_fine_tuning_spec.", "$ref": "GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec" }, "sessionSpec": { "description": "Session specification. Can be used only when `session` is set.", "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestSessionSpec" }, "params": { "description": "Additional search parameters. For public website search only, supported values are: * `user_country_code`: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided. For example, `user_country_code: \"au\"` For available codes see [Country Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) * `search_type`: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching. For example, `search_type: 1`", "type": "object", "additionalProperties": { "type": "any" } }, "personalizationSpec": { "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestPersonalizationSpec", "description": "The specification for personalization. Notice that if both ServingConfig.personalization_spec and SearchRequest.personalization_spec are set, SearchRequest.personalization_spec overrides ServingConfig.personalization_spec." }, "oneBoxPageSize": { "format": "int32", "description": "The maximum number of results to return for OneBox. This applies to each OneBox type individually. Default number is 10.", "type": "integer" }, "userInfo": { "description": "Information about the end user. Highly recommended for analytics and personalization. UserInfo.user_agent is used to deduce `device_type` for analytics.", "$ref": "GoogleCloudDiscoveryengineV1alphaUserInfo" }, "relevanceScoreSpec": { "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceScoreSpec", "description": "Optional. The specification for returning the relevance score." }, "naturalLanguageQueryUnderstandingSpec": { "description": "Optional. Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done.", "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec" }, "branch": { "type": "string", "description": "The branch resource name, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`. Use `default_branch` as the branch ID or leave this field empty, to search documents under the default branch." }, "customRankingParams": { "description": "Optional. Optional configuration for the Custom Ranking feature.", "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestCustomRankingParams" }, "relevanceFilterSpec": { "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpec", "description": "Optional. The granular relevance filtering specification. If not specified, the global `relevance_threshold` will be used for all sub-searches. If specified, this overrides the global `relevance_threshold` to use thresholds on a per sub-search basis. This feature is currently supported only for custom and site search." }, "canonicalFilter": { "description": "The default filter that is applied when a user performs a search without checking any filters on the search page. The filter applied to every search request when quality improvement such as query expansion is needed. In the case a query does not have a sufficient amount of results this filter will be used to determine whether or not to enable the query expansion flow. The original filter will still be used for the query expanded search. This field is strongly recommended to achieve high search quality. For more information about filter syntax, see SearchRequest.filter.", "type": "string" }, "imageQuery": { "description": "Raw image query.", "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestImageQuery" }, "safeSearch": { "description": "Whether to turn on safe search. This is only supported for website search.", "type": "boolean" }, "servingConfig": { "type": "string", "description": "Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search." }, "rankingExpressionBackend": { "type": "string", "enum": [ "RANKING_EXPRESSION_BACKEND_UNSPECIFIED", "BYOE", "CLEARBOX", "RANK_BY_EMBEDDING", "RANK_BY_FORMULA" ], "enumDescriptions": [ "Default option for unspecified/unknown values.", "Deprecated: Use `RANK_BY_EMBEDDING` instead. Ranking by custom embedding model, the default way to evaluate the ranking expression. Legacy enum option, `RANK_BY_EMBEDDING` should be used instead.", "Deprecated: Use `RANK_BY_FORMULA` instead. Ranking by custom formula. Legacy enum option, `RANK_BY_FORMULA` should be used instead.", "Ranking by custom embedding model, the default way to evaluate the ranking expression.", "Ranking by custom formula." ], "description": "Optional. The backend to use for the ranking expression evaluation.", "enumDeprecated": [ false, true, true, false, false ] }, "rankingExpression": { "type": "string", "description": "Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by \"+\". * ranking_expression = function, { \" + \", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double \u003e 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result * `media_actor_match`: whether the media actor matches the query * `media_director_match`: whether the media director matches the query * `media_genre_match`: whether the media genre matches the query * `media_language_match`: whether the media language matches the query * `media_title_match`: whether the media title matches the query * `media_prefix_similarity_rank`: prefix similarity rank for media results * `media_semantic_similarity_rank`: semantic similarity rank for media results" }, "dataStoreSpecs": { "type": "array", "description": "Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used.", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec" } }, "contentSearchSpec": { "description": "A specification for configuring the behavior of content search.", "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec" }, "searchAddonSpec": { "description": "Optional. SearchAddonSpec is used to disable add-ons for search as per new repricing model. This field is only supported for search requests.", "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAddonSpec" }, "entity": { "type": "string", "description": "Optional. The entity for customers that may run multiple different entities, domains, sites or regions, for example, \"Google US\", \"Google Ads\", \"Waymo\", \"google.com\", \"youtube.com\", etc. If this is set, it should be exactly matched with UserEvent.entity to get search results boosted by entity." }, "boostSpec": { "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec", "description": "Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)" }, "userPseudoId": { "description": "Optional. 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`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id 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" }, "crowdingSpecs": { "type": "array", "description": "Optional. Crowding specifications for improving result diversity. If multiple CrowdingSpecs are specified, crowding will be evaluated on each unique combination of the `field` values, and max_count will be the maximum value of `max_count` across all CrowdingSpecs. For example, if the first CrowdingSpec has `field` = \"color\" and `max_count` = 3, and the second CrowdingSpec has `field` = \"size\" and `max_count` = 2, then after 3 documents that share the same color AND size have been returned, subsequent ones should be removed or demoted.", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestCrowdingSpec" } }, "languageCode": { "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate.", "type": "string" }, "pageSize": { "type": "integer", "description": "Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned.", "format": "int32" }, "searchAsYouTypeSpec": { "description": "Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical.", "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec" }, "query": { "type": "string", "description": "Raw search query." }, "pageCategories": { "type": "array", "items": { "type": "string" }, "description": "Optional. The categories associated with a category page. Must be set for category navigation queries to achieve good search quality. The format should be the same as PageInfo.page_category. This field is the equivalent of the query for browse (navigation) queries. It's used by the browse model when the query is empty. If the field is empty, it will not be used by the browse model. If the field contains more than one element, only the first element will be used. To represent full path of a category, use '\u003e' character to separate different hierarchies. If '\u003e' is part of the category name, replace it with other character(s). For example, `Graphics Cards \u003e RTX\u003e4090 \u003e Founders Edition` where \"RTX \u003e 4090\" represents one level, can be rewritten as `Graphics Cards \u003e RTX_4090 \u003e Founders Edition`" }, "filter": { "type": "string", "description": "The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customer might have a field 'name' in their schema. In this case the filter would look like this: filter --\u003e name:'ANY(\"king kong\")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)" }, "numResultsPerDataStore": { "format": "int32", "type": "integer", "description": "Optional. The maximum number of results to retrieve from each data store. If not specified, it will use the SearchRequest.DataStoreSpec.num_results if provided, otherwise there is no limit." }, "displaySpec": { "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestDisplaySpec", "description": "Optional. Config for display feature, like match highlighting on search results." }, "queryExpansionSpec": { "description": "The query expansion specification that specifies the conditions under which query expansion occurs.", "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec" }, "embeddingSpec": { "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec", "description": "Uses the provided embedding to do additional semantic document retrieval. The retrieval is based on the dot product of SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document embedding that is provided in SearchRequest.EmbeddingSpec.EmbeddingVector.field_path. If SearchRequest.EmbeddingSpec.EmbeddingVector.field_path is not provided, it will use ServingConfig.EmbeddingConfig.field_path." }, "useLatestData": { "type": "boolean", "description": "Uses the Engine, ServingConfig and Control freshly read from the database. Note: this skips config cache and introduces dependency on databases, which could significantly increase the API latency. It should only be used for testing, but not serving end users." }, "regionCode": { "description": "The Unicode country/region code (CLDR) of a location, such as \"US\" and \"419\". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided.", "type": "string" }, "pageToken": { "type": "string", "description": "A page token received from a previous SearchService.Search call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SearchService.Search must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned." }, "relevanceThreshold": { "description": "The global relevance threshold of the search results. Defaults to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. If more granular relevance filtering is required, use the `relevance_filter_spec` instead. This feature is not supported for healthcare search.", "type": "string", "enumDescriptions": [ "Default value. In this case, server behavior defaults to Google defined threshold.", "Lowest relevance threshold.", "Low relevance threshold.", "Medium relevance threshold.", "High relevance threshold." ], "enum": [ "RELEVANCE_THRESHOLD_UNSPECIFIED", "LOWEST", "LOW", "MEDIUM", "HIGH" ] }, "facetSpecs": { "description": "Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpec" }, "type": "array" }, "spellCorrectionSpec": { "description": "The spell correction specification that specifies the mode under which spell correction takes effect.", "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec" }, "session": { "description": "The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is \"How did Alphabet do in 2022?\" and the current query is \"How about 2023?\", the current query will be interpreted as \"How did Alphabet do in 2023?\". Example #2 (coordination between /search API calls and /answer API calls): Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1ListSchemasResponse": { "id": "GoogleCloudDiscoveryengineV1ListSchemasResponse", "type": "object", "description": "Response message for SchemaService.ListSchemas method.", "properties": { "nextPageToken": { "description": "A token that can be sent as ListSchemasRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" }, "schemas": { "items": { "$ref": "GoogleCloudDiscoveryengineV1Schema" }, "type": "array", "description": "The Schemas." } } }, "GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec": { "id": "GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec", "description": "The specification that uses customized query embedding vector to do semantic document retrieval.", "properties": { "embeddingVectors": { "type": "array", "description": "The embedding vector used for retrieval. Limit to 1.", "items": { "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpecEmbeddingVector" } } }, "type": "object" }, "GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponseDocumentMetadata": { "type": "object", "properties": { "dataIngestionSource": { "type": "string", "description": "The data ingestion source of the Document. Allowed values are: * `batch`: Data ingested via Batch API, e.g., ImportDocuments. * `streaming` Data ingested via Streaming API, e.g., FHIR streaming." }, "matcherValue": { "$ref": "GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponseDocumentMetadataMatcherValue", "description": "The value of the matcher that was used to match the Document." }, "state": { "enumDescriptions": [ "Should never be set.", "The Document is indexed.", "The Document is not indexed because its URI is not in the TargetSite.", "The Document is not indexed." ], "type": "string", "description": "The state of the document.", "enum": [ "STATE_UNSPECIFIED", "INDEXED", "NOT_IN_TARGET_SITE", "NOT_IN_INDEX" ] }, "lastRefreshedTime": { "type": "string", "description": "The timestamp of the last time the Document was last indexed.", "format": "google-datetime" } }, "id": "GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponseDocumentMetadata", "description": "The metadata of a Document." }, "GoogleCloudDiscoveryengineV1AssistantCustomerPolicy": { "properties": { "modelArmorConfig": { "description": "Optional. Model Armor configuration to be used for sanitizing user prompts and assistant responses.", "$ref": "GoogleCloudDiscoveryengineV1AssistantCustomerPolicyModelArmorConfig" }, "bannedPhrases": { "items": { "$ref": "GoogleCloudDiscoveryengineV1AssistantCustomerPolicyBannedPhrase" }, "description": "Optional. List of banned phrases.", "type": "array" }, "dataProtectionPolicy": { "$ref": "GoogleCloudDiscoveryengineV1DataProtectionPolicy", "description": "Optional. Data protection policy to be used for sanitizing file uploads." } }, "type": "object", "description": "Customer-defined policy for the assistant.", "id": "GoogleCloudDiscoveryengineV1AssistantCustomerPolicy" }, "GoogleCloudDiscoveryengineV1alphaControlPromoteAction": { "type": "object", "id": "GoogleCloudDiscoveryengineV1alphaControlPromoteAction", "description": "Promote certain links based on some trigger queries. Example: Promote shoe store link when searching for `shoe` keyword. The link can be outside of associated data store.", "properties": { "searchLinkPromotion": { "$ref": "GoogleCloudDiscoveryengineV1alphaSearchLinkPromotion", "description": "Required. Promotion attached to this action." }, "dataStore": { "description": "Required. Data store with which this promotion is attached to.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfigAlloyDbConfig": { "id": "GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfigAlloyDbConfig", "properties": { "returnedFields": { "type": "array", "items": { "type": "string" }, "description": "Optional. Fields to be returned in the search results. If empty, all fields will be returned." }, "alloydbConnectionConfig": { "description": "Required. Configuration for connecting to AlloyDB.", "$ref": "GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfigAlloyDbConfigAlloyDbConnectionConfig" }, "alloydbAiNlConfig": { "$ref": "GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfigAlloyDbConfigAlloyDbAiNaturalLanguageConfig", "description": "Optional. Configuration for Magic." } }, "description": "Stores information for connecting to AlloyDB.", "type": "object" }, "GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure": { "id": "GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure", "properties": { "totalRequiredQuota": { "format": "int64", "description": "This number is an estimation on how much total quota this project needs to successfully complete indexing.", "type": "string" } }, "type": "object", "description": "Failed due to insufficient quota." }, "A2aV1AgentCardSignature": { "type": "object", "properties": { "protected": { "type": "string", "description": "Required. The protected JWS header for the signature. This is always a base64url-encoded JSON object. Required." }, "header": { "description": "The unprotected JWS header values.", "additionalProperties": { "description": "Properties of the object.", "type": "any" }, "type": "object" }, "signature": { "type": "string", "description": "Required. The computed signature, base64url-encoded. Required." } }, "id": "A2aV1AgentCardSignature", "description": "AgentCardSignature represents a JWS signature of an AgentCard. This follows the JSON format of an RFC 7515 JSON Web Signature (JWS)." }, "GoogleCloudDiscoveryengineV1alphaDataStoreFederatedSearchConfig": { "properties": { "thirdPartyOauthConfig": { "description": "Third Party OAuth config. If set, this DataStore is connected to a third party application.", "$ref": "GoogleCloudDiscoveryengineV1alphaDataStoreFederatedSearchConfigThirdPartyOauthConfig" }, "alloyDbConfig": { "description": "AlloyDB config. If set, this DataStore is connected to AlloyDB.", "$ref": "GoogleCloudDiscoveryengineV1alphaDataStoreFederatedSearchConfigAlloyDbConfig" }, "notebooklmConfig": { "description": "NotebookLM config. If set, this DataStore is connected to NotebookLM Enterprise.", "$ref": "GoogleCloudDiscoveryengineV1alphaDataStoreFederatedSearchConfigNotebooklmConfig" } }, "description": "Stores information for federated search.", "type": "object", "id": "GoogleCloudDiscoveryengineV1alphaDataStoreFederatedSearchConfig" }, "GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesMetadata": { "properties": { "createTime": { "type": "string", "format": "google-datetime", "description": "Operation create time." }, "updateTime": { "type": "string", "format": "google-datetime", "description": "Operation last update time. If the operation is done, this is also the finish time." } }, "type": "object", "id": "GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesMetadata", "description": "Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field." }, "GoogleCloudDiscoveryengineV1SearchResponseSummaryReferenceChunkContent": { "properties": { "content": { "description": "Chunk textual content.", "type": "string" }, "pageIdentifier": { "description": "Page identifier.", "type": "string" } }, "description": "Chunk content.", "type": "object", "id": "GoogleCloudDiscoveryengineV1SearchResponseSummaryReferenceChunkContent" }, "GoogleCloudDiscoveryengineV1betaIdpConfig": { "description": "Identity Provider Config.", "id": "GoogleCloudDiscoveryengineV1betaIdpConfig", "type": "object", "properties": { "externalIdpConfig": { "description": "External Identity provider config.", "$ref": "GoogleCloudDiscoveryengineV1betaIdpConfigExternalIdpConfig" }, "idpType": { "description": "Identity provider type configured.", "enumDescriptions": [ "Default value. ACL search not enabled.", "Google 1P provider.", "Third party provider." ], "type": "string", "enum": [ "IDP_TYPE_UNSPECIFIED", "GSUITE", "THIRD_PARTY" ] } } }, "GoogleCloudDiscoveryengineV1alphaAnswerStepActionSearchAction": { "type": "object", "description": "Search action.", "id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionSearchAction", "properties": { "query": { "type": "string", "description": "The query to search." } } }, "GoogleCloudDiscoveryengineV1SiteSearchEngine": { "type": "object", "id": "GoogleCloudDiscoveryengineV1SiteSearchEngine", "description": "SiteSearchEngine captures DataStore level site search persisting configurations. It is a singleton value per data store.", "properties": { "name": { "type": "string", "description": "The fully qualified resource name of the site search engine. Format: `projects/*/locations/*/dataStores/*/siteSearchEngine`" } } }, "GoogleCloudDiscoveryengineV1alphaUserLicense": { "properties": { "licenseAssignmentState": { "enumDescriptions": [ "Default value.", "License assigned to the user.", "No license assigned to the user. Deprecated, translated to NO_LICENSE.", "No license assigned to the user.", "User attempted to login but no license assigned to the user. This state is only used for no user first time login attempt but cannot get license assigned. Users already logged in but cannot get license assigned will be assigned NO_LICENSE state(License could be unassigned by admin).", "User is blocked from assigning a license." ], "description": "Output only. License assignment state of the user. If the user is assigned with a license config, the user login will be assigned with the license; If the user's license assignment state is unassigned or unspecified, no license config will be associated to the user;", "enum": [ "LICENSE_ASSIGNMENT_STATE_UNSPECIFIED", "ASSIGNED", "UNASSIGNED", "NO_LICENSE", "NO_LICENSE_ATTEMPTED_LOGIN", "BLOCKED" ], "readOnly": true, "type": "string" }, "licenseConfig": { "type": "string", "description": "Optional. The full resource name of the Subscription(LicenseConfig) assigned to the user." }, "createTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. User created timestamp." }, "userPrincipal": { "description": "Required. Immutable. The user principal of the User, could be email address or other prinical identifier. This field is immutable. Admin assign licenses based on the user principal.", "type": "string" }, "updateTime": { "description": "Output only. User update timestamp.", "format": "google-datetime", "type": "string", "readOnly": true }, "lastLoginTime": { "type": "string", "readOnly": true, "format": "google-datetime", "description": "Output only. User last logged in time. If the user has not logged in yet, this field will be empty." }, "userProfile": { "type": "string", "description": "Optional. The user profile. We user user full name(First name + Last name) as user profile." } }, "id": "GoogleCloudDiscoveryengineV1alphaUserLicense", "description": "User License information assigned by the admin.", "type": "object" }, "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfoDocumentMetadata": { "description": "Document metadata.", "type": "object", "id": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfoDocumentMetadata", "properties": { "pageIdentifier": { "type": "string", "description": "Page identifier." }, "structData": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "type": "object", "description": "The structured JSON metadata for the document. It is populated from the struct data from the Chunk in search result." }, "uri": { "type": "string", "description": "URI for the document." }, "title": { "description": "Title.", "type": "string" }, "document": { "type": "string", "description": "Document resource name." } } }, "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesMetadata": { "id": "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesMetadata", "description": "Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", "type": "object", "properties": { "updateTime": { "description": "Operation last update time. If the operation is done, this is also the finish time.", "format": "google-datetime", "type": "string" }, "createTime": { "type": "string", "format": "google-datetime", "description": "Operation create time." } } }, "GoogleCloudDiscoveryengineV1AnswerReferenceChunkInfo": { "type": "object", "properties": { "documentMetadata": { "description": "Document metadata.", "$ref": "GoogleCloudDiscoveryengineV1AnswerReferenceChunkInfoDocumentMetadata" }, "chunk": { "type": "string", "description": "Chunk resource name." }, "relevanceScore": { "description": "The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation.", "format": "float", "type": "number" }, "content": { "type": "string", "description": "Chunk textual content." } }, "id": "GoogleCloudDiscoveryengineV1AnswerReferenceChunkInfo", "description": "Chunk information." }, "GoogleCloudDiscoveryengineV1alphaSetDedicatedCrawlRateMetadata": { "properties": { "updateTime": { "format": "google-datetime", "description": "Operation last update time. If the operation is done, this is also the finish time.", "type": "string" }, "createTime": { "format": "google-datetime", "type": "string", "description": "Operation create time." } }, "id": "GoogleCloudDiscoveryengineV1alphaSetDedicatedCrawlRateMetadata", "description": "Metadata related to the progress of the CrawlRateManagementService.SetDedicatedCrawlRate operation. This will be returned by the google.longrunning.Operation.metadata field.", "type": "object" }, "GoogleCloudDiscoveryengineV1EngineChatEngineConfig": { "description": "Configurations for a Chat Engine.", "id": "GoogleCloudDiscoveryengineV1EngineChatEngineConfig", "properties": { "dialogflowAgentToLink": { "description": "The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide `agent_creation_config` to create agent or provide an agent name that links the agent with the Chat engine. Format: `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. Use ChatEngineMetadata.dialogflow_agent for actual agent association after Engine is created.", "type": "string" }, "allowCrossRegion": { "description": "Optional. If the flag set to true, we allow the agent and engine are in different locations, otherwise the agent and engine are required to be in the same location. The flag is set to false by default. Note that the `allow_cross_region` are one-time consumed by and passed to EngineService.CreateEngine. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation.", "type": "boolean" }, "agentCreationConfig": { "$ref": "GoogleCloudDiscoveryengineV1EngineChatEngineConfigAgentCreationConfig", "description": "The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation." } }, "type": "object" }, "GoogleCloudDiscoveryengineV1betaCondition": { "description": "Defines circumstances to be checked before allowing a behavior", "type": "object", "properties": { "queryRegex": { "description": "Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. Only supported for Basic Site Search promotion serving controls.", "type": "string" }, "activeTimeRange": { "description": "Range of time(s) specifying when condition is active. Maximum of 10 time ranges.", "items": { "$ref": "GoogleCloudDiscoveryengineV1betaConditionTimeRange" }, "type": "array" }, "queryTerms": { "description": "Search only A list of terms to match the query on. Cannot be set when Condition.query_regex is set. Maximum of 10 query terms.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1betaConditionQueryTerm" } } }, "id": "GoogleCloudDiscoveryengineV1betaCondition" }, "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig": { "description": "Related configurations applied to a specific type of document parser.", "id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig", "type": "object", "properties": { "digitalParsingConfig": { "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigDigitalParsingConfig", "description": "Configurations applied to digital parser." }, "layoutParsingConfig": { "description": "Configurations applied to layout parser.", "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig" }, "ocrParsingConfig": { "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig", "description": "Configurations applied to OCR parser. Currently it only applies to PDFs." } } }, "GoogleApiMetric": { "id": "GoogleApiMetric", "description": "A specific metric, identified by specifying values for all of the labels of a `MetricDescriptor`.", "type": "object", "properties": { "labels": { "type": "object", "additionalProperties": { "type": "string" }, "description": "The set of label values that uniquely identify this metric. All labels listed in the `MetricDescriptor` must be assigned values." }, "type": { "type": "string", "description": "An existing metric type, see google.api.MetricDescriptor. For example, `custom.googleapis.com/invoice/paid/amount`." } } }, "GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsResponse": { "description": "Response message for CompletionService.PurgeCompletionSuggestions method. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.", "properties": { "errorSamples": { "description": "A sample of errors encountered while processing the request.", "items": { "$ref": "GoogleRpcStatus" }, "type": "array" }, "purgeSucceeded": { "type": "boolean", "description": "Whether the completion suggestions were successfully purged." } }, "id": "GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsResponse", "type": "object" }, "GoogleCloudDiscoveryengineV1betaCreateDataStoreMetadata": { "id": "GoogleCloudDiscoveryengineV1betaCreateDataStoreMetadata", "type": "object", "properties": { "createTime": { "description": "Operation create time.", "format": "google-datetime", "type": "string" }, "updateTime": { "type": "string", "description": "Operation last update time. If the operation is done, this is also the finish time.", "format": "google-datetime" } }, "description": "Metadata related to the progress of the DataStoreService.CreateDataStore operation. This will be returned by the google.longrunning.Operation.metadata field." }, "GoogleCloudDiscoveryengineV1AnswerQueryRequestEndUserSpecEndUserMetaData": { "type": "object", "properties": { "chunkInfo": { "$ref": "GoogleCloudDiscoveryengineV1AnswerQueryRequestEndUserSpecEndUserMetaDataChunkInfo", "description": "Chunk information." } }, "description": "End user metadata.", "id": "GoogleCloudDiscoveryengineV1AnswerQueryRequestEndUserSpecEndUserMetaData" }, "GoogleCloudDiscoveryengineV1AnswerQueryRequestRelatedQuestionsSpec": { "id": "GoogleCloudDiscoveryengineV1AnswerQueryRequestRelatedQuestionsSpec", "type": "object", "properties": { "enable": { "type": "boolean", "description": "Enable related questions feature if true." } }, "description": "Related questions specification." }, "A2aV1CancelTaskRequest": { "properties": {}, "id": "A2aV1CancelTaskRequest", "type": "object" }, "GoogleCloudDiscoveryengineV1WidgetConfigUiSettingsModelConfigInfo": { "id": "GoogleCloudDiscoveryengineV1WidgetConfigUiSettingsModelConfigInfo", "type": "object", "properties": { "defaultModelId": { "readOnly": true, "type": "string", "description": "Output only. The `model_id` of the model that should be selected by default in the model selector when the end-user has not made an explicit choice. The value is always one of the `model_id`s present in `resolved_models`." }, "resolvedModels": { "description": "Output only. The list of models that are available to the end-user in the model selector, in the order in which they should be displayed.", "items": { "$ref": "GoogleCloudDiscoveryengineV1WidgetConfigUiSettingsModelConfigInfoResolvedModel" }, "readOnly": true, "type": "array" } }, "description": "The resolved, server-side view of model selector configuration for the end-user. The backend computes this per-request by applying, in order: Mendel flag evaluation, regional availability rules based on the engine's location, and admin-panel overrides from `model_configs`. The backend is the single source of truth for this configuration; clients should render `resolved_models` directly in the model selector dropdown, in the order provided, without applying their own filtering, ordering, or localization." }, "GoogleCloudDiscoveryengineV1ListLicenseConfigsResponse": { "id": "GoogleCloudDiscoveryengineV1ListLicenseConfigsResponse", "properties": { "nextPageToken": { "type": "string", "description": "Not supported." }, "licenseConfigs": { "items": { "$ref": "GoogleCloudDiscoveryengineV1LicenseConfig" }, "description": "All the customer's LicenseConfigs.", "type": "array" } }, "type": "object", "description": "Response message for LicenseConfigService.ListLicenseConfigs method." }, "GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec": { "id": "GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec", "type": "object", "description": "Specification to enable natural language understanding capabilities for search requests.", "properties": { "geoSearchQueryDetectionFieldNames": { "items": { "type": "string" }, "description": "Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`.", "type": "array" }, "filterExtractionCondition": { "type": "string", "enum": [ "CONDITION_UNSPECIFIED", "DISABLED", "ENABLED" ], "enumDescriptions": [ "Server behavior defaults to `DISABLED`.", "Disables NL filter extraction.", "Enables NL filter extraction." ], "description": "The condition under which filter extraction should occur. Server behavior defaults to `DISABLED`." }, "allowedFieldNames": { "description": "Optional. Allowlist of fields that can be used for natural language filter extraction. By default, if this is unspecified, all indexable fields are eligible for natural language filter extraction (but are not guaranteed to be used). If any fields are specified in allowed_field_names, only the fields that are both marked as indexable in the schema and specified in the allowlist will be eligible for natural language filter extraction. Note: for multi-datastore search, this is not yet supported, and will be ignored.", "items": { "type": "string" }, "type": "array" }, "extractedFilterBehavior": { "enumDescriptions": [ "`EXTRACTED_FILTER_BEHAVIOR_UNSPECIFIED` will use the default behavior for extracted filters. For single datastore search, the default is to apply as hard filters. For multi-datastore search, the default is to apply as soft boosts.", "Applies all extracted filters as hard filters on the results. Results that do not pass the extracted filters will not be returned in the result set.", "Applies all extracted filters as soft boosts. Results that pass the filters will be boosted up to higher ranks in the result set." ], "description": "Optional. Controls behavior of how extracted filters are applied to the search. The default behavior depends on the request. For single datastore structured search, the default is `HARD_FILTER`. For multi-datastore search, the default behavior is `SOFT_BOOST`. Location-based filters are always applied as hard filters, and the `SOFT_BOOST` setting will not affect them. This field is only used if SearchRequest.NaturalLanguageQueryUnderstandingSpec.FilterExtractionCondition is set to FilterExtractionCondition.ENABLED.", "type": "string", "enum": [ "EXTRACTED_FILTER_BEHAVIOR_UNSPECIFIED", "HARD_FILTER", "SOFT_BOOST" ] } } }, "GoogleCloudDiscoveryengineV1AssistantContentBlob": { "properties": { "data": { "description": "Required. Raw bytes.", "type": "string", "format": "byte" }, "mimeType": { "description": "Required. The media type (MIME type) of the generated data.", "type": "string" } }, "type": "object", "id": "GoogleCloudDiscoveryengineV1AssistantContentBlob", "description": "Inline blob." }, "GoogleCloudDiscoveryengineV1alphaActionConfigScopeList": { "description": "Stores a list of scopes.", "properties": { "scopes": { "type": "array", "description": "Optional. The list of scopes.", "items": { "type": "string" } } }, "id": "GoogleCloudDiscoveryengineV1alphaActionConfigScopeList", "type": "object" }, "GoogleCloudDiscoveryengineV1BigtableSource": { "description": "The Cloud Bigtable source for importing data.", "properties": { "tableId": { "description": "Required. The table ID of the Cloud Bigtable that needs to be imported.", "type": "string" }, "projectId": { "type": "string", "description": "The project ID that contains the Bigtable source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request." }, "instanceId": { "type": "string", "description": "Required. The instance ID of the Cloud Bigtable that needs to be imported." }, "bigtableOptions": { "description": "Required. Bigtable options that contains information needed when parsing data into typed structures. For example, column type annotations.", "$ref": "GoogleCloudDiscoveryengineV1BigtableOptions" } }, "id": "GoogleCloudDiscoveryengineV1BigtableSource", "type": "object" }, "GoogleCloudDiscoveryengineV1ChunkChunkMetadata": { "properties": { "previousChunks": { "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1Chunk" }, "description": "The previous chunks of the current chunk. The number is controlled by SearchRequest.ContentSearchSpec.ChunkSpec.num_previous_chunks. This field is only populated on SearchService.Search API." }, "nextChunks": { "type": "array", "description": "The next chunks of the current chunk. The number is controlled by SearchRequest.ContentSearchSpec.ChunkSpec.num_next_chunks. This field is only populated on SearchService.Search API.", "items": { "$ref": "GoogleCloudDiscoveryengineV1Chunk" } } }, "description": "Metadata of the current chunk. This field is only populated on SearchService.Search API.", "type": "object", "id": "GoogleCloudDiscoveryengineV1ChunkChunkMetadata" }, "GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsMetadata": { "properties": { "updateTime": { "description": "Operation last update time. If the operation is done, this is also the finish time.", "type": "string", "format": "google-datetime" }, "createTime": { "type": "string", "format": "google-datetime", "description": "Operation create time." } }, "id": "GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsMetadata", "description": "Metadata related to the progress of the PurgeCompletionSuggestions operation. This is returned by the google.longrunning.Operation.metadata field.", "type": "object" }, "GoogleCloudDiscoveryengineV1DataStoreFederatedSearchConfigNotebooklmConfig": { "properties": { "searchConfig": { "type": "string", "description": "Required. Search config name. Format: projects/*/locations/global/notebookLmSearchConfigs/*" } }, "description": "Config for connecting to NotebookLM Enterprise.", "type": "object", "id": "GoogleCloudDiscoveryengineV1DataStoreFederatedSearchConfigNotebooklmConfig" }, "GoogleCloudDiscoveryengineV1SearchResponseSummaryReference": { "id": "GoogleCloudDiscoveryengineV1SearchResponseSummaryReference", "description": "Document reference.", "properties": { "document": { "type": "string", "description": "Required. Document.name of the document. Full resource name of the referenced document, in the format `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`." }, "chunkContents": { "items": { "$ref": "GoogleCloudDiscoveryengineV1SearchResponseSummaryReferenceChunkContent" }, "description": "List of cited chunk contents derived from document content.", "type": "array" }, "uri": { "type": "string", "description": "Cloud Storage or HTTP uri for the document." }, "title": { "description": "Title of the document.", "type": "string" } }, "type": "object" }, "GoogleCloudDiscoveryengineV1AlertPolicyConfigAlertEnrollment": { "type": "object", "properties": { "alertId": { "type": "string", "description": "Immutable. The id of an alert." }, "enrollState": { "description": "Required. The enrollment status of a customer.", "type": "string", "enum": [ "ENROLL_STATES_UNSPECIFIED", "ENROLLED", "DECLINED" ], "enumDescriptions": [ "Default value. Used for customers who have not responded to the alert policy.", "Customer is enrolled in this policy.", "Customer declined this policy." ] } }, "id": "GoogleCloudDiscoveryengineV1AlertPolicyConfigAlertEnrollment", "description": "The alert enrollment status." }, "GoogleCloudDiscoveryengineV1AnswerStep": { "type": "object", "id": "GoogleCloudDiscoveryengineV1AnswerStep", "description": "Step information.", "properties": { "description": { "description": "The description of the step.", "type": "string" }, "actions": { "description": "Actions.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1AnswerStepAction" } }, "state": { "enum": [ "STATE_UNSPECIFIED", "IN_PROGRESS", "FAILED", "SUCCEEDED" ], "type": "string", "enumDescriptions": [ "Unknown.", "Step is currently in progress.", "Step currently failed.", "Step has succeeded." ], "description": "The state of the step." }, "thought": { "description": "The thought of the step.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1ConversationMessage": { "properties": { "reply": { "description": "Search reply.", "$ref": "GoogleCloudDiscoveryengineV1Reply" }, "userInput": { "$ref": "GoogleCloudDiscoveryengineV1TextInput", "description": "User text input." }, "createTime": { "format": "google-datetime", "type": "string", "description": "Output only. Message creation timestamp.", "readOnly": true } }, "id": "GoogleCloudDiscoveryengineV1ConversationMessage", "description": "Defines a conversation message.", "type": "object" }, "GoogleCloudDiscoveryengineV1AnswerGenerationSpecUserDefinedClassifierSpec": { "properties": { "modelId": { "description": "Optional. The model id to be used for the user defined classifier.", "type": "string" }, "preamble": { "type": "string", "description": "Optional. The preamble to be used for the user defined classifier." }, "taskMarker": { "description": "Optional. The task marker to be used for the user defined classifier.", "type": "string" }, "topP": { "format": "double", "type": "number", "description": "Optional. The top-p value to be used for the user defined classifier." }, "topK": { "type": "string", "format": "int64", "description": "Optional. The top-k value to be used for the user defined classifier." }, "seed": { "format": "int32", "description": "Optional. The seed value to be used for the user defined classifier.", "type": "integer" }, "enableUserDefinedClassifier": { "description": "Optional. Whether or not to enable and include user defined classifier.", "type": "boolean" }, "temperature": { "format": "double", "description": "Optional. The temperature value to be used for the user defined classifier.", "type": "number" } }, "type": "object", "description": "The specification for user defined classifier.", "id": "GoogleCloudDiscoveryengineV1AnswerGenerationSpecUserDefinedClassifierSpec" }, "GoogleCloudDiscoveryengineV1alphaQueryPart": { "description": "Represents a part or the whole of a content, used to represent a query. A query can be made up of multiple parts.", "properties": { "text": { "description": "Text content.", "type": "string" }, "documentReference": { "description": "Other VAIS Document references.", "$ref": "GoogleCloudDiscoveryengineV1alphaQueryPartDocumentReference" }, "driveDocumentReference": { "$ref": "GoogleCloudDiscoveryengineV1alphaQueryPartDriveDocumentReference", "description": "Reference to a Google Drive document." }, "mimeType": { "type": "string", "description": "Optional. The IANA standard MIME type of the data. See https://www.iana.org/assignments/media-types/media-types.xhtml. This field is optional. If not set, the default assumed MIME type is \"text/plain\" for the \"data\" field." }, "personReference": { "description": "Reference to a person.", "$ref": "GoogleCloudDiscoveryengineV1alphaQueryPartPersonReference" }, "uiJsonPayload": { "description": "This field is expected to be a ui message in JSON format. As of Q1 2026, ui_json_payload is only supported for A2UI messages.", "type": "string" } }, "type": "object", "id": "GoogleCloudDiscoveryengineV1alphaQueryPart" }, "GoogleCloudDiscoveryengineV1AssistantGroundedContentTextGroundingMetadataVisualSegment": { "id": "GoogleCloudDiscoveryengineV1AssistantGroundedContentTextGroundingMetadataVisualSegment", "properties": { "contentId": { "description": "The content id of the visual segment. In order to display the citation of the visual element, this content_id needs to match with the `grounded_content.content_metadata.content_id` field.", "type": "string" }, "referenceIndices": { "items": { "type": "integer", "format": "int32" }, "type": "array", "description": "References for the visual segment." } }, "description": "Grounding information for a visual segment.", "type": "object" }, "GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpecPromptSpec": { "properties": { "preamble": { "description": "Customized preamble.", "type": "string" } }, "id": "GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpecPromptSpec", "description": "Answer generation prompt specification.", "type": "object" }, "GoogleCloudDiscoveryengineV1alphaDeleteUserStoreMetadata": { "type": "object", "id": "GoogleCloudDiscoveryengineV1alphaDeleteUserStoreMetadata", "properties": { "updateTime": { "description": "Operation last update time. If the operation is done, this is also the finish time.", "format": "google-datetime", "type": "string" }, "failureCount": { "type": "string", "format": "int64", "description": "The number of end users under the user store that failed to be deleted." }, "successCount": { "format": "int64", "description": "The number of end users under the user store that were successfully deleted.", "type": "string" } }, "description": "Metadata related to the progress of the UserStoreService.DeleteUserStore operation. This will be returned by the google.longrunning.Operation.metadata field. Delete UserStore will delete all the end users under the user store, return the number of end users successfully deleted or failed to delete in the metadata." }, "GoogleCloudDiscoveryengineV1WidgetConfigUiSettingsModelConfigInfoResolvedModel": { "id": "GoogleCloudDiscoveryengineV1WidgetConfigUiSettingsModelConfigInfoResolvedModel", "type": "object", "description": "A single model that is resolved to be available to the end-user in the model selector, with all of its localized display metadata.", "properties": { "modelId": { "readOnly": true, "description": "Output only. Unique identifier of the model (e.g. `gemini-2.5-flash`, `gemini-3.1-pro-preview`). This is the same identifier that clients pass back to the assistant service to select this model. Virtual / \"pseudo\" models (e.g. `gemini-fast`) are also valid values here; they are resolved to the underlying concrete model on the backend.", "type": "string" }, "description": { "readOnly": true, "description": "Output only. Localized description text (e.g. `State-of-the-art reasoning`). Localized using the same locale as `display_name`.", "type": "string" }, "promoted": { "type": "boolean", "description": "Output only. Whether this model should be promoted in the GE chat homepage banner.", "readOnly": true }, "displayName": { "readOnly": true, "type": "string", "description": "Output only. Localized display name of the model (e.g. `Gemini 3.1 Pro`). Localized server-side based on the LookupWidgetConfigRequest.language_code and LookupWidgetConfigRequest.region_code of the request." }, "icon": { "readOnly": true, "description": "Output only. GM3-compatible icon token associated with the model (e.g. `rocket_launch`, `bolt`, `graph_5`).", "type": "string" }, "label": { "description": "Output only. Short label shown in the compact selector bar chip (e.g. `3.x Flash`) as opposed to the full `display_name` (`Gemini 3.x Flash`). Falls back to `display_name` when the backend registry does not specify a distinct short label.", "readOnly": true, "type": "string" }, "iconUrl": { "description": "Output only. Absolute URL of a brand mark to render instead of `icon`, for models whose vendor logo is not a GM3 glyph. `icon` stays populated as the fallback, so a client that does not render images, or that fails to fetch this one, shows the glyph instead of nothing.", "readOnly": true, "type": "string" }, "isPreview": { "description": "Output only. Whether the model is currently in preview. Clients should surface this via a \"Preview\" badge in the selector UI.", "readOnly": true, "type": "boolean" }, "adminView": { "readOnly": true, "$ref": "GoogleCloudDiscoveryengineV1WidgetConfigUiSettingsModelConfigInfoResolvedModelAdminView", "description": "Output only. Admin-surface metadata; populated only for the Console admin Feature Control page (see `AdminView`). Unset for end-user surfaces." } } }, "GoogleCloudDiscoveryengineV1PurgeDocumentsRequest": { "description": "Request message for DocumentService.PurgeDocuments method.", "properties": { "force": { "description": "Actually performs the purge. If `force` is set to false, return the expected purge count without deleting any documents.", "type": "boolean" }, "gcsSource": { "$ref": "GoogleCloudDiscoveryengineV1GcsSource", "description": "Cloud Storage location for the input content. Supported `data_schema`: * `document_id`: One valid Document.id per line." }, "inlineSource": { "description": "Inline source for the input content for purge.", "$ref": "GoogleCloudDiscoveryengineV1PurgeDocumentsRequestInlineSource" }, "errorConfig": { "description": "The desired location of errors incurred during the purge.", "$ref": "GoogleCloudDiscoveryengineV1PurgeErrorConfig" }, "filter": { "description": "Required. Filter matching documents to purge. Only currently supported value is `*` (all items).", "type": "string" } }, "id": "GoogleCloudDiscoveryengineV1PurgeDocumentsRequest", "type": "object" }, "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec": { "id": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec", "properties": { "conditionBoostSpecs": { "type": "array", "description": "Condition boost specifications. If a document matches multiple conditions in the specifications, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20.", "items": { "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpec" } } }, "description": "Boost specification to boost certain documents.", "type": "object" }, "A2aV1MutualTlsSecurityScheme": { "type": "object", "id": "A2aV1MutualTlsSecurityScheme", "properties": { "description": { "description": "Description of this security scheme.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1ListLicenseConfigsUsageStatsResponse": { "properties": { "licenseConfigUsageStats": { "type": "array", "description": "All the customer's LicenseConfigUsageStats.", "items": { "$ref": "GoogleCloudDiscoveryengineV1LicenseConfigUsageStats" } } }, "type": "object", "description": "Response message for UserLicenseService.ListLicenseConfigsUsageStats method.", "id": "GoogleCloudDiscoveryengineV1ListLicenseConfigsUsageStatsResponse" }, "GoogleCloudDiscoveryengineV1TargetSiteFailureReasonQuotaFailure": { "id": "GoogleCloudDiscoveryengineV1TargetSiteFailureReasonQuotaFailure", "description": "Failed due to insufficient quota.", "type": "object", "properties": { "totalRequiredQuota": { "description": "This number is an estimation on how much total quota this project needs to successfully complete indexing.", "format": "int64", "type": "string" } } }, "GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig": { "description": "Custom threshold for `cvr` optimization_objective.", "type": "object", "properties": { "targetFieldValueFloat": { "type": "number", "format": "float", "description": "Required. The threshold to be applied to the target (e.g., 0.5)." }, "targetField": { "type": "string", "description": "Required. The name of the field to target. Currently supported values: `watch-percentage`, `watch-time`." } }, "id": "GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig" }, "GoogleCloudDiscoveryengineV1betaIdentityMappingEntryOperationMetadata": { "type": "object", "id": "GoogleCloudDiscoveryengineV1betaIdentityMappingEntryOperationMetadata", "properties": { "successCount": { "format": "int64", "type": "string", "description": "The number of IdentityMappingEntries that were successfully processed." }, "totalCount": { "description": "The total number of IdentityMappingEntries that were processed.", "type": "string", "format": "int64" }, "failureCount": { "format": "int64", "type": "string", "description": "The number of IdentityMappingEntries that failed to be processed." } }, "description": "IdentityMappingEntry LongRunningOperation metadata for IdentityMappingStoreService.ImportIdentityMappings and IdentityMappingStoreService.PurgeIdentityMappings" }, "GoogleCloudDiscoveryengineV1ControlPromoteAction": { "properties": { "dataStore": { "description": "Required. Data store with which this promotion is attached to.", "type": "string" }, "searchLinkPromotion": { "$ref": "GoogleCloudDiscoveryengineV1SearchLinkPromotion", "description": "Required. Promotion attached to this action." } }, "id": "GoogleCloudDiscoveryengineV1ControlPromoteAction", "type": "object", "description": "Promote certain links based on some trigger queries. Example: Promote shoe store link when searching for `shoe` keyword. The link can be outside of associated data store." }, "GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentConfigEvolutionSettingsParentSamplingConfig": { "description": "Configuration for parent sampling.", "type": "object", "properties": { "paretoSamplingConfig": { "description": "Optional. Pareto sampling configuration.", "$ref": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentConfigEvolutionSettingsParentSamplingConfigParetoSamplingConfig" } }, "id": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentConfigEvolutionSettingsParentSamplingConfig" }, "GoogleCloudDiscoveryengineV1FetchSitemapsResponseSitemapMetadata": { "description": "Contains a Sitemap and its metadata.", "id": "GoogleCloudDiscoveryengineV1FetchSitemapsResponseSitemapMetadata", "type": "object", "properties": { "sitemap": { "description": "The Sitemap.", "$ref": "GoogleCloudDiscoveryengineV1Sitemap" } } }, "GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigEngineFeaturesConfig": { "description": "More feature configs of the selected engine type.", "id": "GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigEngineFeaturesConfig", "type": "object", "properties": { "mostPopularConfig": { "description": "Most popular engine feature config.", "$ref": "GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigMostPopularFeatureConfig" }, "recommendedForYouConfig": { "$ref": "GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig", "description": "Recommended for you engine feature config." } } }, "GoogleCloudDiscoveryengineV1alphaEngineKnowledgeGraphConfigFeatureConfig": { "type": "object", "description": "Feature config for the Knowledge Graph.", "id": "GoogleCloudDiscoveryengineV1alphaEngineKnowledgeGraphConfigFeatureConfig", "properties": { "disablePrivateKgAutoComplete": { "type": "boolean", "description": "Whether to disable the private KG auto complete for the engine. Defaults to false if not specified." }, "disablePrivateKgQueryUnderstanding": { "description": "Whether to disable the private KG query understanding for the engine. Defaults to false if not specified.", "type": "boolean" }, "disablePrivateKgEnrichment": { "description": "Whether to disable the private KG enrichment for the engine. Defaults to false if not specified.", "type": "boolean" }, "disablePrivateKgQueryUiChips": { "type": "boolean", "description": "Whether to disable the private KG for query UI chips. Defaults to false if not specified." } } }, "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig": { "type": "object", "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig", "description": "The layout parsing configurations for documents.", "properties": { "enableGetProcessedDocument": { "description": "Optional. If true, the processed document will be made available for the GetProcessedDocument API.", "type": "boolean" }, "excludeHtmlIds": { "items": { "type": "string" }, "description": "Optional. List of HTML ids to exclude from the parsed content.", "type": "array" }, "enableTableAnnotation": { "description": "Optional. If true, the LLM based annotation is added to the table during parsing.", "type": "boolean" }, "enableImageAnnotation": { "description": "Optional. If true, the LLM based annotation is added to the image during parsing.", "type": "boolean" }, "excludeHtmlElements": { "items": { "type": "string" }, "description": "Optional. List of HTML elements to exclude from the parsed content.", "type": "array" }, "structuredContentTypes": { "description": "Optional. Contains the required structure types to extract from the document. Supported values: * `shareholder-structure`", "items": { "type": "string" }, "type": "array" }, "enableLlmLayoutParsing": { "description": "Optional. If true, the pdf layout will be refined using an LLM.", "type": "boolean" }, "excludeHtmlClasses": { "type": "array", "description": "Optional. List of HTML classes to exclude from the parsed content.", "items": { "type": "string" } } } }, "GoogleCloudDiscoveryengineV1alphaProvisionProjectMetadata": { "type": "object", "properties": {}, "id": "GoogleCloudDiscoveryengineV1alphaProvisionProjectMetadata", "description": "Metadata associated with a project provision operation." }, "A2aV1HTTPAuthSecurityScheme": { "type": "object", "properties": { "bearerFormat": { "type": "string", "description": "A hint to the client to identify how the bearer token is formatted. Bearer tokens are usually generated by an authorization server, so this information is primarily for documentation purposes." }, "description": { "type": "string", "description": "Description of this security scheme." }, "scheme": { "type": "string", "description": "The name of the HTTP Authentication scheme to be used in the Authorization header as defined in RFC7235. The values used SHOULD be registered in the IANA Authentication Scheme registry. The value is case-insensitive, as defined in RFC7235." } }, "id": "A2aV1HTTPAuthSecurityScheme" }, "GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentConfigEvolutionSettingsParentSamplingConfigParetoSamplingConfig": { "id": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentConfigEvolutionSettingsParentSamplingConfigParetoSamplingConfig", "type": "object", "description": "Configuration for Pareto sampling.", "properties": { "paretoSamplingProbability": { "type": "number", "format": "float", "description": "Optional. Probability [0.0, 1.0] of sampling parent programs from the Pareto frontier instead of normal fitness-based sampling during candidate generation. Useful when optimizing multiple metrics simultaneously. Default 0.0 (disabled). Only effective when evaluation returns multiple metrics in scores_to_optimize." } } }, "GoogleCloudDiscoveryengineV1SearchRequestRelevanceFilterSpec": { "properties": { "semanticSearchThreshold": { "description": "Optional. Relevance filtering threshold specification for semantic search.", "$ref": "GoogleCloudDiscoveryengineV1SearchRequestRelevanceFilterSpecRelevanceThresholdSpec" }, "keywordSearchThreshold": { "$ref": "GoogleCloudDiscoveryengineV1SearchRequestRelevanceFilterSpecRelevanceThresholdSpec", "description": "Optional. Relevance filtering threshold specification for keyword search." } }, "type": "object", "id": "GoogleCloudDiscoveryengineV1SearchRequestRelevanceFilterSpec", "description": "Relevance filtering specification." }, "GoogleCloudDiscoveryengineV1RankingRecord": { "properties": { "id": { "type": "string", "description": "The unique ID to represent the record." }, "content": { "type": "string", "description": "The content of the record. Empty by default. At least one of title or content should be set otherwise an INVALID_ARGUMENT error is thrown." }, "title": { "description": "The title of the record. Empty by default. At least one of title or content should be set otherwise an INVALID_ARGUMENT error is thrown.", "type": "string" }, "score": { "format": "float", "description": "The score of this record based on the given query and selected model. The score will be rounded to 4 decimal places. If the score is close to 0, it will be rounded to 0.00001 to avoid returning unset.", "type": "number" } }, "type": "object", "description": "Record message for RankService.Rank method.", "id": "GoogleCloudDiscoveryengineV1RankingRecord" }, "GoogleCloudDiscoveryengineV1WidgetConfigUIComponentField": { "type": "object", "id": "GoogleCloudDiscoveryengineV1WidgetConfigUIComponentField", "properties": { "field": { "description": "Required. Registered field name. The format is `field.abc`.", "type": "string" }, "displayTemplate": { "description": "The template to customize how the field is displayed. An example value would be a string that looks like: \"Price: {value}\".", "type": "string" }, "deviceVisibility": { "description": "The field visibility on different types of devices.", "items": { "enumDescriptions": [ "Default value when not specified. Server returns INVALID_ARGUMENT if used in requests.", "The UI component is visible on Mobile devices.", "The UI component is visible on Browser-based client." ], "enum": [ "DEVICE_VISIBILITY_UNSPECIFIED", "MOBILE", "DESKTOP" ], "type": "string" }, "type": "array" } }, "description": "Facet field that maps to a UI Component." }, "GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesResponse": { "id": "GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesResponse", "properties": { "errorSamples": { "description": "A sample of errors encountered while processing the request.", "items": { "$ref": "GoogleRpcStatus" }, "type": "array" }, "purgeCount": { "description": "Number of suggestion deny list entries purged.", "type": "string", "format": "int64" } }, "type": "object", "description": "Response message for CompletionService.PurgeSuggestionDenyListEntries method." }, "GoogleCloudDiscoveryengineV1alphaCreateEvaluationMetadata": { "id": "GoogleCloudDiscoveryengineV1alphaCreateEvaluationMetadata", "properties": {}, "description": "Metadata for EvaluationService.CreateEvaluation method.", "type": "object" }, "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSnippetSpec": { "description": "A specification for configuring snippets in a search response.", "id": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSnippetSpec", "type": "object", "properties": { "referenceOnly": { "type": "boolean", "deprecated": true, "description": "[DEPRECATED] This field is deprecated and will have no affect on the snippet." }, "maxSnippetCount": { "type": "integer", "deprecated": true, "description": "[DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count \u003e 0.", "format": "int32" }, "returnSnippet": { "description": "If `true`, then return snippet. If no snippet can be generated, we return \"No snippet is available for this page.\" A `snippet_status` with `SUCCESS` or `NO_SNIPPET_AVAILABLE` will also be returned.", "type": "boolean" } } }, "GoogleCloudDiscoveryengineV1FeedbackConversationInfo": { "properties": { "session": { "description": "Name of the newly generated or continued session.", "type": "string" }, "assistToken": { "type": "string", "description": "Optional. The token which could be used to fetch the assistant log." }, "answerQueryToken": { "description": "Optional. The token which could be used to fetch the answer log.", "type": "string" }, "query": { "description": "Required. The user's search query.", "$ref": "GoogleCloudDiscoveryengineV1Query" }, "questionIndex": { "description": "The index of the user input within the conversation messages.", "type": "integer", "format": "int32" } }, "description": "The conversation information such as the question index and session name.", "id": "GoogleCloudDiscoveryengineV1FeedbackConversationInfo", "type": "object" }, "GoogleCloudDiscoveryengineV1alphaDataStoreFederatedSearchConfigAlloyDbConfigAlloyDbAiNaturalLanguageConfig": { "id": "GoogleCloudDiscoveryengineV1alphaDataStoreFederatedSearchConfigAlloyDbConfigAlloyDbAiNaturalLanguageConfig", "description": "Configuration for AlloyDB AI Natural Language.", "type": "object", "properties": { "nlConfigId": { "type": "string", "description": "Optional. AlloyDb AI NL config id, i.e. the value that was used for calling `SELECT alloydb_ai_nl.g_create_configuration(...)`. Can be empty." } } }, "GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpecControlPoint": { "id": "GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpecControlPoint", "description": "The control points used to define the curve. The curve defined through these control points can only be monotonically increasing or decreasing(constant values are acceptable).", "type": "object", "properties": { "attributeValue": { "type": "string", "description": "Optional. Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`." }, "boostAmount": { "type": "number", "format": "float", "description": "Optional. The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above." } } }, "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.", "properties": { "phrase": { "description": "Required. The raw string content to be banned.", "type": "string" }, "ignoreDiacritics": { "description": "Optional. If true, diacritical marks (e.g., accents, umlauts) are ignored when matching banned phrases. For example, \"cafe\" would match \"café\".", "type": "boolean" }, "matchType": { "enum": [ "BANNED_PHRASE_MATCH_TYPE_UNSPECIFIED", "SIMPLE_STRING_MATCH", "WORD_BOUNDARY_STRING_MATCH" ], "type": "string", "description": "Optional. Match type for the banned phrase.", "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": "object", "id": "GoogleCloudDiscoveryengineV1AssistantCustomerPolicyBannedPhrase" }, "GoogleCloudDiscoveryengineV1SearchRequestFacetSpec": { "type": "object", "properties": { "enableDynamicPosition": { "description": "Enables dynamic position for this facet. If set to true, the position of this facet among all facets in the response is determined automatically. If dynamic facets are enabled, it is ordered together. If set to false, the position of this facet in the response is the same as in the request, and it is ranked before the facets with dynamic position enable and all dynamic facets. For example, you may always want to have rating facet returned in the response, but it's not necessarily to always display the rating facet at the top. In that case, you can set enable_dynamic_position to true so that the position of rating facet in response is determined automatically. Another example, assuming you have the following facets in the request: * \"rating\", enable_dynamic_position = true * \"price\", enable_dynamic_position = false * \"brands\", enable_dynamic_position = false And also you have a dynamic facets enabled, which generates a facet `gender`. Then the final order of the facets in the response can be (\"price\", \"brands\", \"rating\", \"gender\") or (\"price\", \"brands\", \"gender\", \"rating\") depends on how API orders \"gender\" and \"rating\" facets. However, notice that \"price\" and \"brands\" are always ranked at first and second position because their enable_dynamic_position is false.", "type": "boolean" }, "limit": { "type": "integer", "format": "int32", "description": "Maximum facet values that are returned for this facet. If unspecified, defaults to 20. The maximum allowed value is 300. Values above 300 are coerced to 300. For aggregation in healthcare search, when the [FacetKey.key] is \"healthcare_aggregation_key\", the limit will be overridden to 10,000 internally, regardless of the value set here. If this field is negative, an `INVALID_ARGUMENT` is returned." }, "excludedFilterKeys": { "type": "array", "description": "List of keys to exclude when faceting. By default, FacetKey.key is not excluded from the filter unless it is listed in this field. Listing a facet key in this field allows its values to appear as facet results, even when they are filtered out of search results. Using this field does not affect what search results are returned. For example, suppose there are 100 documents with the color facet \"Red\" and 200 documents with the color facet \"Blue\". A query containing the filter \"color:ANY(\"Red\")\" and having \"color\" as FacetKey.key would by default return only \"Red\" documents in the search results, and also return \"Red\" with count 100 as the only color facet. Although there are also blue documents available, \"Blue\" would not be shown as an available facet value. If \"color\" is listed in \"excludedFilterKeys\", then the query returns the facet values \"Red\" with count 100 and \"Blue\" with count 200, because the \"color\" key is now excluded from the filter. Because this field doesn't affect search results, the search results are still correctly filtered to return only \"Red\" documents. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.", "items": { "type": "string" } }, "facetKey": { "$ref": "GoogleCloudDiscoveryengineV1SearchRequestFacetSpecFacetKey", "description": "Required. The facet key specification." } }, "id": "GoogleCloudDiscoveryengineV1SearchRequestFacetSpec", "description": "A facet specification to perform faceted search." }, "GoogleCloudDiscoveryengineV1alphaCreateTargetSiteMetadata": { "properties": { "createTime": { "type": "string", "description": "Operation create time.", "format": "google-datetime" }, "updateTime": { "description": "Operation last update time. If the operation is done, this is also the finish time.", "type": "string", "format": "google-datetime" } }, "type": "object", "description": "Metadata related to the progress of the SiteSearchEngineService.CreateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1alphaCreateTargetSiteMetadata" }, "GoogleCloudDiscoveryengineV1alphaDestinationConfig": { "type": "object", "properties": { "destinations": { "description": "Optional. The destinations for the corresponding key.", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaDestinationConfigDestination" }, "type": "array" }, "params": { "type": "object", "description": "Optional. Additional parameters for this destination config in structured json format.", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "jsonParams": { "type": "string", "description": "Additional parameters for this destination config in json string format." }, "key": { "type": "string", "description": "Optional. Unique destination identifier that is supported by the connector." } }, "description": "Defines target endpoints used to connect to third-party sources.", "id": "GoogleCloudDiscoveryengineV1alphaDestinationConfig" }, "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig": { "description": "Configuration for the layout based chunking.", "properties": { "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" }, "chunkSize": { "format": "int32", "type": "integer", "description": "The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500." } }, "type": "object", "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig" }, "GoogleCloudDiscoveryengineV1betaProjectServiceTerms": { "id": "GoogleCloudDiscoveryengineV1betaProjectServiceTerms", "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of this terms of service. Available terms: * `GA_DATA_USE_TERMS`: [Terms for data use](https://cloud.google.com/retail/data-use-terms). When using this as `id`, the acceptable version to provide is `2022-11-23`." }, "version": { "description": "The version string of the terms of service. For acceptable values, see the comments for id above.", "type": "string" }, "state": { "description": "Whether the project has accepted/rejected the service terms or it is still pending.", "enum": [ "STATE_UNSPECIFIED", "TERMS_ACCEPTED", "TERMS_PENDING", "TERMS_DECLINED" ], "enumDescriptions": [ "The default value of the enum. This value is not actually used.", "The project has given consent to the terms of service.", "The project is pending to review and accept the terms of service.", "The project has declined or revoked the agreement to terms of service." ], "type": "string" }, "acceptTime": { "format": "google-datetime", "description": "The last time when the project agreed to the terms of service.", "type": "string" }, "declineTime": { "type": "string", "format": "google-datetime", "description": "The last time when the project declined or revoked the agreement to terms of service." } }, "description": "Metadata about the terms of service." }, "GoogleCloudDiscoveryengineV1ImportIdentityMappingsRequest": { "description": "Request message for IdentityMappingStoreService.ImportIdentityMappings", "properties": { "inlineSource": { "description": "The inline source to import identity mapping entries from.", "$ref": "GoogleCloudDiscoveryengineV1ImportIdentityMappingsRequestInlineSource" } }, "id": "GoogleCloudDiscoveryengineV1ImportIdentityMappingsRequest", "type": "object" }, "GoogleCloudDiscoveryengineV1alphaBatchUpdateUserLicensesMetadata": { "id": "GoogleCloudDiscoveryengineV1alphaBatchUpdateUserLicensesMetadata", "properties": { "createTime": { "type": "string", "description": "Operation create time.", "format": "google-datetime" }, "successCount": { "description": "Count of user licenses successfully updated.", "type": "string", "format": "int64" }, "failureCount": { "type": "string", "description": "Count of user licenses that failed to be updated.", "format": "int64" }, "updateTime": { "type": "string", "description": "Operation last update time. If the operation is done, this is also the finish time.", "format": "google-datetime" } }, "description": "Metadata related to the progress of the UserLicenseService.BatchUpdateUserLicenses operation. This will be returned by the google.longrunning.Operation.metadata field.", "type": "object" }, "GoogleCloudDiscoveryengineV1StreamAssistRequestGenerationSpec": { "properties": { "modelId": { "type": "string", "description": "Optional. The Vertex AI model_id used for the generative model. If not set, the default Assistant model will be used." } }, "type": "object", "id": "GoogleCloudDiscoveryengineV1StreamAssistRequestGenerationSpec", "description": "Assistant generation specification for the request. This allows to override the default generation configuration at the engine level." }, "GoogleCloudDiscoveryengineV1alphaSetDedicatedCrawlRateResponse": { "id": "GoogleCloudDiscoveryengineV1alphaSetDedicatedCrawlRateResponse", "type": "object", "description": "Response message for CrawlRateManagementService.SetDedicatedCrawlRate method. It simply returns the state of the response, and an error message if the state is FAILED.", "properties": { "error": { "$ref": "GoogleRpcStatus", "description": "Errors from service when handling the request." }, "state": { "readOnly": true, "enum": [ "STATE_UNSPECIFIED", "SUCCEEDED", "FAILED" ], "enumDescriptions": [ "The state is unspecified.", "The state is successful.", "The state is failed." ], "description": "Output only. The state of the response.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1ListSessionsResponse": { "description": "Response for ListSessions method.", "properties": { "sessions": { "items": { "$ref": "GoogleCloudDiscoveryengineV1Session" }, "description": "All the Sessions for a given data store.", "type": "array" }, "nextPageToken": { "type": "string", "description": "Pagination token, if not returned indicates the last page." } }, "id": "GoogleCloudDiscoveryengineV1ListSessionsResponse", "type": "object" }, "GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchRequest": { "id": "GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchRequest", "type": "object", "description": "Request message for SiteSearchEngineService.EnableAdvancedSiteSearch method.", "properties": {} }, "GoogleCloudDiscoveryengineV1SetUpDataConnectorRequest": { "properties": { "collectionDisplayName": { "type": "string", "description": "Required. The display name of the Collection. Should be human readable, used to display collections in the Console Dashboard. UTF-8 encoded string with limit of 1024 characters." }, "dataConnector": { "description": "Required. The DataConnector to initialize in the newly created Collection.", "$ref": "GoogleCloudDiscoveryengineV1DataConnector" }, "collectionId": { "description": "Required. The ID to use for the Collection, which will become the final component of the Collection's resource name. A new Collection is created as part of the DataConnector setup. DataConnector is a singleton resource under Collection, managing all DataStores of the Collection. Should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", "type": "string" } }, "id": "GoogleCloudDiscoveryengineV1SetUpDataConnectorRequest", "description": "Request for DataConnectorService.SetUpDataConnector method.", "type": "object" }, "GoogleCloudDiscoveryengineV1AnswerQueryUnderstandingInfo": { "id": "GoogleCloudDiscoveryengineV1AnswerQueryUnderstandingInfo", "description": "Query understanding information.", "properties": { "queryClassificationInfo": { "items": { "$ref": "GoogleCloudDiscoveryengineV1AnswerQueryUnderstandingInfoQueryClassificationInfo" }, "description": "Query classification information.", "type": "array" } }, "type": "object" }, "GoogleCloudDiscoveryengineV1SearchResponseFacetFacetValue": { "description": "A facet value which contains value names and their count.", "properties": { "interval": { "$ref": "GoogleCloudDiscoveryengineV1Interval", "description": "Interval value for a facet, such as 10, 20) for facet \"price\". It matches [SearchRequest.FacetSpec.FacetKey.intervals." }, "value": { "type": "string", "description": "Text value of a facet, such as \"Black\" for facet \"colors\"." }, "count": { "description": "Number of items that have this facet value.", "type": "string", "format": "int64" } }, "type": "object", "id": "GoogleCloudDiscoveryengineV1SearchResponseFacetFacetValue" }, "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason": { "type": "object", "id": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason", "properties": { "errorMessage": { "type": "string", "description": "Reason why the URI was not crawled." }, "corpusType": { "description": "DESKTOP, MOBILE, or CORPUS_TYPE_UNSPECIFIED.", "enumDescriptions": [ "Default value.", "Denotes a crawling attempt for the desktop version of a page.", "Denotes a crawling attempt for the mobile version of a page." ], "enum": [ "CORPUS_TYPE_UNSPECIFIED", "DESKTOP", "MOBILE" ], "type": "string" } }, "description": "Details about why crawling failed for a particular CorpusType, e.g., DESKTOP and MOBILE crawling may fail for different reasons." }, "GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfigThirdPartyOauthConfig": { "type": "object", "id": "GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfigThirdPartyOauthConfig", "properties": { "instanceName": { "description": "Optional. The instance name identifying the 3P app, e.g., \"vaissptbots-my\". This is different from the instance_uri which is the full URL of the 3P app e.g., \"https://vaissptbots-my.sharepoint.com\".", "type": "string" }, "appName": { "type": "string", "description": "Optional. The type of the application. E.g., \"jira\", \"box\", etc." } }, "description": "Stores information for third party applicationOAuth." }, "A2aV1AgentCapabilities": { "id": "A2aV1AgentCapabilities", "description": "Defines the A2A feature set supported by the agent", "properties": { "extensions": { "description": "Extensions supported by this agent.", "items": { "$ref": "A2aV1AgentExtension" }, "type": "array" }, "pushNotifications": { "type": "boolean", "description": "If the agent can send push notifications to the clients webhook" }, "streaming": { "type": "boolean", "description": "If the agent will support streaming responses" } }, "type": "object" }, "GoogleCloudDiscoveryengineV1alphaAlphaEvolveProgram": { "id": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveProgram", "type": "object", "description": "Represents a single program to be used within the context of an AlphaEvolve experiment.", "properties": { "lockToken": { "type": "string", "description": "Optional. Lock token for the program." }, "parentPrograms": { "type": "array", "readOnly": true, "items": { "type": "string" }, "description": "Output only. Optionally specifies which parent programs this program was evolved from. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/alphaEvolveExperiments/{alpha_evolve_experiment}/alphaEvolvePrograms/{alpha_evolve_program}`" }, "name": { "description": "Identifier. Unique identifier for the program. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/alphaEvolveExperiments/{alpha_evolve_experiment}/alphaEvolvePrograms/{alpha_evolve_program}`", "type": "string" }, "state": { "readOnly": true, "enumDescriptions": [ "Default value. This value is unused.", "The program is initialized.", "The program is in generation.", "The program is pending evaluation.", "The program is completed." ], "description": "Output only. State of the program.", "type": "string", "enum": [ "PROGRAM_STATE_UNSPECIFIED", "INITIALIZED", "GENERATING", "EVALUATING", "COMPLETED" ] }, "evaluation": { "description": "Optional. Evaluation results for the program.", "$ref": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveProgramEvaluation" }, "content": { "$ref": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveProgramContent", "description": "Optional. Content of the program." }, "createTime": { "format": "google-datetime", "readOnly": true, "type": "string", "description": "Output only. Time when the program was created." } } }, "GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsMetadata": { "id": "GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsMetadata", "properties": { "failureCount": { "type": "string", "format": "int64", "description": "Count of CompletionSuggestions that failed to be imported." }, "updateTime": { "format": "google-datetime", "description": "Operation last update time. If the operation is done, this is also the finish time.", "type": "string" }, "successCount": { "format": "int64", "description": "Count of CompletionSuggestions successfully imported.", "type": "string" }, "createTime": { "format": "google-datetime", "type": "string", "description": "Operation create time." } }, "type": "object", "description": "Metadata related to the progress of the ImportCompletionSuggestions operation. This will be returned by the google.longrunning.Operation.metadata field." }, "GoogleCloudDiscoveryengineV1ListDataStoresResponse": { "description": "Response message for DataStoreService.ListDataStores method.", "properties": { "nextPageToken": { "description": "A token that can be sent as ListDataStoresRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" }, "dataStores": { "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1DataStore" }, "description": "All the customer's DataStores." } }, "type": "object", "id": "GoogleCloudDiscoveryengineV1ListDataStoresResponse" }, "GoogleCloudDiscoveryengineV1alphaSearchRequestSessionSpec": { "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestSessionSpec", "description": "Session specification.", "type": "object", "properties": { "queryId": { "type": "string", "description": "If set, the search result gets stored to the \"turn\" specified by this query ID. Example: Let's say the session looks like this: session { name: \".../sessions/xxx\" turns { query { text: \"What is foo?\" query_id: \".../questions/yyy\" } answer: \"Foo is ...\" } turns { query { text: \"How about bar then?\" query_id: \".../questions/zzz\" } } } The user can call /search API with a request like this: session: \".../sessions/xxx\" session_spec { query_id: \".../questions/zzz\" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID." }, "searchResultPersistenceCount": { "description": "The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is similar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode.", "format": "int32", "type": "integer" } } }, "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig": { "properties": { "chunkSize": { "format": "int32", "description": "The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500.", "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" } }, "description": "Configuration for the layout based chunking.", "type": "object", "id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig" }, "GoogleCloudDiscoveryengineV1betaSchema": { "id": "GoogleCloudDiscoveryengineV1betaSchema", "description": "Defines the structure and layout of a type of document data.", "type": "object", "properties": { "structSchema": { "type": "object", "additionalProperties": { "description": "Properties of the object.", "type": "any" }, "description": "The structured representation of the schema." }, "name": { "description": "Immutable. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", "type": "string" }, "jsonSchema": { "description": "The JSON representation of the schema.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1betaCreateSitemapMetadata": { "description": "Metadata related to the progress of the SiteSearchEngineService.CreateSitemap operation. This will be returned by the google.longrunning.Operation.metadata field.", "type": "object", "properties": { "createTime": { "description": "Operation create time.", "type": "string", "format": "google-datetime" }, "updateTime": { "type": "string", "description": "Operation last update time. If the operation is done, this is also the finish time.", "format": "google-datetime" } }, "id": "GoogleCloudDiscoveryengineV1betaCreateSitemapMetadata" }, "GoogleCloudDiscoveryengineV1RecommendResponse": { "id": "GoogleCloudDiscoveryengineV1RecommendResponse", "type": "object", "properties": { "attributionToken": { "description": "A unique attribution token. This should be included in the UserEvent logs resulting from this recommendation, which enables accurate attribution of recommendation model performance.", "type": "string" }, "results": { "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1RecommendResponseRecommendationResult" }, "description": "A list of recommended Documents. The order represents the ranking (from the most relevant Document to the least)." }, "missingIds": { "type": "array", "description": "IDs of documents in the request that were missing from the default Branch associated with the requested ServingConfig.", "items": { "type": "string" } }, "validateOnly": { "description": "True if RecommendRequest.validate_only was set.", "type": "boolean" } }, "description": "Response message for Recommend method." }, "GoogleCloudDiscoveryengineV1alphaTuneEngineResponse": { "description": "Response associated with a tune operation.", "properties": {}, "type": "object", "id": "GoogleCloudDiscoveryengineV1alphaTuneEngineResponse" }, "GoogleCloudDiscoveryengineV1ProvisionProjectMetadata": { "properties": {}, "type": "object", "description": "Metadata associated with a project provision operation.", "id": "GoogleCloudDiscoveryengineV1ProvisionProjectMetadata" }, "GoogleCloudDiscoveryengineV1betaCreateSchemaMetadata": { "type": "object", "id": "GoogleCloudDiscoveryengineV1betaCreateSchemaMetadata", "description": "Metadata for Create Schema LRO.", "properties": { "createTime": { "type": "string", "format": "google-datetime", "description": "Operation create time." }, "updateTime": { "description": "Operation last update time. If the operation is done, this is also the finish time.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudDiscoveryengineV1betaBatchUpdateUserLicensesMetadata": { "properties": { "successCount": { "description": "Count of user licenses successfully updated.", "format": "int64", "type": "string" }, "failureCount": { "type": "string", "format": "int64", "description": "Count of user licenses that failed to be updated." }, "createTime": { "type": "string", "description": "Operation create time.", "format": "google-datetime" }, "updateTime": { "type": "string", "format": "google-datetime", "description": "Operation last update time. If the operation is done, this is also the finish time." } }, "description": "Metadata related to the progress of the UserLicenseService.BatchUpdateUserLicenses operation. This will be returned by the google.longrunning.Operation.metadata field.", "type": "object", "id": "GoogleCloudDiscoveryengineV1betaBatchUpdateUserLicensesMetadata" }, "A2aV1AgentSkill": { "id": "A2aV1AgentSkill", "properties": { "name": { "type": "string", "description": "A human readable name for the skill." }, "tags": { "items": { "type": "string" }, "description": "A set of tags for the skill to enhance categorization/utilization. Example: [\"cooking\", \"customer support\", \"billing\"]", "type": "array" }, "inputModes": { "description": "Possible input modalities supported.", "items": { "type": "string" }, "type": "array" }, "description": { "description": "A human (or llm) readable description of the skill details and behaviors.", "type": "string" }, "examples": { "type": "array", "description": "A set of example queries that this skill is designed to address. These examples should help the caller to understand how to craft requests to the agent to achieve specific goals. Example: [\"I need a recipe for bread\"]", "items": { "type": "string" } }, "outputModes": { "description": "Possible output modalities produced", "type": "array", "items": { "type": "string" } }, "id": { "description": "Unique identifier of the skill within this agent.", "type": "string" }, "security": { "items": { "$ref": "A2aV1Security" }, "description": "protolint:disable REPEATED_FIELD_NAMES_PLURALIZED Security schemes necessary for the agent to leverage this skill. As in the overall AgentCard.security, this list represents a logical OR of security requirement objects. Each object is a set of security schemes that must be used together (a logical AND). protolint:enable REPEATED_FIELD_NAMES_PLURALIZED", "type": "array" } }, "description": "AgentSkill represents a unit of action/solution that the agent can perform. One can think of this as a type of highly reliable solution that an agent can be tasked to provide. Agents have the autonomy to choose how and when to use specific skills, but clients should have confidence that if the skill is defined that unit of action can be reliably performed.", "type": "object" }, "GoogleCloudDiscoveryengineV1GcsSource": { "id": "GoogleCloudDiscoveryengineV1GcsSource", "description": "Cloud Storage location for input content.", "type": "object", "properties": { "inputUris": { "type": "array", "items": { "type": "string" }, "description": "Required. Cloud Storage URIs to input files. Each URI can be up to 2000 characters long. URIs can match the full object path (for example, `gs://bucket/directory/object.json`) or a pattern matching one or more files, such as `gs://bucket/directory/*.json`. A request can contain at most 100 files (or 100,000 files if `data_schema` is `content`). Each file can be up to 2 GB (or 100 MB if `data_schema` is `content`)." }, "dataSchema": { "description": "The schema to use when parsing the data from the source. Supported values for document imports: * `document` (default): One JSON Document per line. Each document must have a valid Document.id. * `content`: Unstructured data (e.g. PDF, HTML). Each file matched by `input_uris` becomes a document, with the ID set to the first 128 bits of SHA256(URI) encoded as a hex string. * `custom`: One custom data JSON per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by the GENERIC Data Store vertical. * `csv`: A CSV file with header conforming to the defined Schema of the data store. Each entry after the header is imported as a Document. This can only be used by the GENERIC Data Store vertical. Supported values for user event imports: * `user_event` (default): One JSON UserEvent per line.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1SearchRequestQueryExpansionSpec": { "description": "Specification to determine under which conditions query expansion should occur.", "properties": { "pinUnexpandedResults": { "description": "Whether to pin unexpanded results. If this field is set to true, unexpanded products are always at the top of the search results, followed by the expanded results.", "type": "boolean" }, "condition": { "enum": [ "CONDITION_UNSPECIFIED", "DISABLED", "AUTO" ], "type": "string", "enumDescriptions": [ "Unspecified query expansion condition. In this case, server behavior defaults to Condition.DISABLED.", "Disabled query expansion. Only the exact search query is used, even if SearchResponse.total_size is zero.", "Automatic query expansion built by the Search API." ], "description": "The condition under which query expansion should occur. Default to Condition.DISABLED." } }, "id": "GoogleCloudDiscoveryengineV1SearchRequestQueryExpansionSpec", "type": "object" }, "GoogleCloudDiscoveryengineV1ImportUserEventsRequestInlineSource": { "description": "The inline source for the input config for ImportUserEvents method.", "properties": { "userEvents": { "description": "Required. A list of user events to import. Recommended max of 10k items.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1UserEvent" } } }, "type": "object", "id": "GoogleCloudDiscoveryengineV1ImportUserEventsRequestInlineSource" }, "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo": { "description": "Chunk information.", "id": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo", "properties": { "relevanceScore": { "description": "The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation.", "format": "float", "type": "number" }, "chunk": { "type": "string", "description": "Chunk resource name." }, "content": { "description": "Chunk textual content.", "type": "string" }, "blobAttachmentIndexes": { "type": "array", "readOnly": true, "items": { "type": "string", "format": "int64" }, "description": "Output only. Stores indexes of blobattachments linked to this chunk." }, "documentMetadata": { "description": "Document metadata.", "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfoDocumentMetadata" } }, "type": "object" }, "A2aV1Security": { "properties": { "schemes": { "additionalProperties": { "$ref": "A2aV1StringList" }, "type": "object" } }, "type": "object", "id": "A2aV1Security" }, "GoogleCloudDiscoveryengineV1WidgetConfigCollectionComponent": { "properties": { "connectorAuthState": { "readOnly": true, "$ref": "GoogleCloudDiscoveryengineV1WidgetConfigConnectorAuthState", "description": "Output only. The auth uri of the connector source." }, "dataSource": { "description": "The name of the data source, retrieved from `Collection.data_connector.data_source`.", "type": "string" }, "displayName": { "description": "The display name of the collection.", "type": "string" }, "dataSourceDisplayName": { "type": "string", "readOnly": true, "description": "Output only. The display name of the data source." }, "id": { "description": "Output only. the identifier of the collection, used for widget service. For now it refers to collection_id, in the future we will migrate the field to encrypted collection name UUID. For synthetic placeholder entries (see message-level comment) this is a synthetic placeholder id, not a real collection_id.", "type": "string", "readOnly": true }, "isFirstParty": { "description": "Output only. Whether this is a first-party (Google-owned) connector, as opposed to a third-party connector. Used by the frontend to group 1P vs 3P connectors.", "type": "boolean", "readOnly": true }, "name": { "description": "The name of the collection. It should be collection resource name. Format: `projects/{project}/locations/{location}/collections/{collection_id}`. For APIs under WidgetService, such as WidgetService.LookupWidgetConfig, the project number and location part is erased in this field. For synthetic placeholder entries (see message-level comment) this carries a synthetic placeholder collection id that does not correspond to a real collection. Callers must not attempt to resolve / GET this resource until the user authorizes the connector.", "type": "string" }, "dataSourceEndUserDisplayName": { "type": "string", "description": "Output only. The end-user-facing display name of the data source, sourced from `ConnectorSource.end_user_display_name`. When unset, clients fall back to `data_source_display_name`.", "readOnly": true }, "metadata": { "description": "Output only. User-facing connector metadata (`title`, `description`, `short_description`, `author`, `note`), retrieved from the registry `ConnectorSource.metadata` (joined by data source). Shown on the connector detail page.", "$ref": "GoogleCloudDiscoveryengineV1DataConnectorConnectorMetadata", "readOnly": true }, "dataSourceVersion": { "type": "number", "readOnly": true, "format": "double", "description": "Output only. The version of the connector definition backing this collection, mirroring `DataConnector.data_source_version`." }, "connectorIconLink": { "readOnly": true, "type": "string", "description": "Output only. The icon link of the connector source." }, "dataStoreComponents": { "items": { "$ref": "GoogleCloudDiscoveryengineV1WidgetConfigDataStoreComponent" }, "description": "For the data store collection, list of the children data stores.", "type": "array" } }, "id": "GoogleCloudDiscoveryengineV1WidgetConfigCollectionComponent", "description": "Read-only collection component that contains data store collections fields that may be used for filtering. For SaaS / Business engines, when `LookupWidgetConfig` is called with `view = WITH_AVAILABLE_CONNECTORS`, instances of this message are also used to represent synthetic placeholder entries for connectors the caller may attach but has not yet attached. Placeholder entries have `connector_auth_state.auth_state == AUTH_STATE_UNSPECIFIED` (or `NO_AUTH`), an empty `connector_auth_state.authorization_uri` (the widget calls `WidgetBuildAuthorizationUrl` on the user's \"Connect\" click), and synthetic placeholder values in `name` / `id` (see field comments). Fields that only make sense for materialized connectors (`data_store_components`, `tenant`, `action_connector`) are left unset for placeholder entries.", "type": "object" }, "GoogleCloudDiscoveryengineV1AssistAnswerCustomerPolicyEnforcementResult": { "description": "Customer policy enforcement results. Contains the results of the various policy checks, like the banned phrases or the Model Armor checks.", "properties": { "verdict": { "description": "Final verdict of the customer policy enforcement. If only one policy blocked the processing, the verdict is BLOCK.", "enum": [ "UNSPECIFIED", "ALLOW", "BLOCK" ], "type": "string", "enumDescriptions": [ "Unknown value.", "There was no policy violation.", "Processing was blocked by the customer policy." ] }, "violationSource": { "enumDescriptions": [ "Unknown value.", "Violation found in the system response.", "Violation found in the user prompt.", "Violation found in the user attachment." ], "type": "string", "description": "Output only. The source of the violation.", "readOnly": true, "enum": [ "VIOLATION_SOURCE_UNSPECIFIED", "SYSTEM", "PROMPT", "ATTACHMENT" ] }, "policyResults": { "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1AssistAnswerCustomerPolicyEnforcementResultPolicyEnforcementResult" }, "description": "Customer policy enforcement results. Populated only if the assist call was skipped due to a policy violation. It contains results from those filters that blocked the processing of the query." } }, "type": "object", "id": "GoogleCloudDiscoveryengineV1AssistAnswerCustomerPolicyEnforcementResult" }, "GoogleCloudDiscoveryengineV1ProjectServiceTerms": { "id": "GoogleCloudDiscoveryengineV1ProjectServiceTerms", "description": "Metadata about the terms of service.", "type": "object", "properties": { "acceptTime": { "description": "The last time when the project agreed to the terms of service.", "type": "string", "format": "google-datetime" }, "state": { "description": "Whether the project has accepted/rejected the service terms or it is still pending.", "type": "string", "enumDescriptions": [ "The default value of the enum. This value is not actually used.", "The project has given consent to the terms of service.", "The project is pending to review and accept the terms of service.", "The project has declined or revoked the agreement to terms of service." ], "enum": [ "STATE_UNSPECIFIED", "TERMS_ACCEPTED", "TERMS_PENDING", "TERMS_DECLINED" ] }, "id": { "type": "string", "description": "The unique identifier of this terms of service. Available terms: * `GA_DATA_USE_TERMS`: [Terms for data use](https://cloud.google.com/retail/data-use-terms). When using this as `id`, the acceptable version to provide is `2022-11-23`." }, "version": { "type": "string", "description": "The version string of the terms of service. For acceptable values, see the comments for id above." }, "declineTime": { "description": "The last time when the project declined or revoked the agreement to terms of service.", "format": "google-datetime", "type": "string" } } }, "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig": { "properties": { "defaultParsingConfig": { "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.", "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig" }, "chunkingConfig": { "description": "Whether chunking mode is enabled.", "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig" }, "name": { "description": "The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`.", "type": "string" }, "parsingConfigOverrides": { "description": "Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported. * `xlsm`: Override parsing config for XLSM files, only digital parsing and layout parsing are supported. * `xlsx`: Override parsing config for XLSX files, only digital parsing and layout parsing are supported.", "type": "object", "additionalProperties": { "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig" } } }, "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig", "type": "object", "description": "A singleton resource of DataStore. If it's empty when DataStore is created and DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED, the default parser will default to digital parser." }, "GoogleCloudDiscoveryengineV1SearchRequestFacetSpecFacetKey": { "type": "object", "properties": { "restrictedValues": { "description": "Only get facet for the given restricted values. Only supported on textual fields. For example, suppose \"category\" has three values \"Action \u003e 2022\", \"Action \u003e 2021\" and \"Sci-Fi \u003e 2022\". If set \"restricted_values\" to \"Action \u003e 2022\", the \"category\" facet only contains \"Action \u003e 2022\". Only supported on textual fields. Maximum is 10.", "items": { "type": "string" }, "type": "array" }, "contains": { "items": { "type": "string" }, "type": "array", "description": "Only get facet values that contain the given strings. For example, suppose \"category\" has three values \"Action \u003e 2022\", \"Action \u003e 2021\" and \"Sci-Fi \u003e 2022\". If set \"contains\" to \"2022\", the \"category\" facet only contains \"Action \u003e 2022\" and \"Sci-Fi \u003e 2022\". Only supported on textual fields. Maximum is 10." }, "caseInsensitive": { "description": "True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise.", "type": "boolean" }, "orderBy": { "description": "The order in which documents are returned. Allowed values are: * \"count desc\", which means order by SearchResponse.Facet.values.count descending. * \"value desc\", which means order by SearchResponse.Facet.values.value descending. Only applies to textual facets. If not set, textual values are sorted in [natural order](https://en.wikipedia.org/wiki/Natural_sort_order); numerical intervals are sorted in the order given by FacetSpec.FacetKey.intervals.", "type": "string" }, "key": { "description": "Required. Supported textual and numerical facet keys in Document object, over which the facet values are computed. Facet key is case-sensitive.", "type": "string" }, "prefixes": { "description": "Only get facet values that start with the given string prefix. For example, suppose \"category\" has three values \"Action \u003e 2022\", \"Action \u003e 2021\" and \"Sci-Fi \u003e 2022\". If set \"prefixes\" to \"Action\", the \"category\" facet only contains \"Action \u003e 2022\" and \"Action \u003e 2021\". Only supported on textual fields. Maximum is 10.", "type": "array", "items": { "type": "string" } }, "intervals": { "description": "Set only if values should be bucketed into intervals. Must be set for facets with numerical values. Must not be set for facet with text values. Maximum number of intervals is 30.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1Interval" } } }, "description": "Specifies how a facet is computed.", "id": "GoogleCloudDiscoveryengineV1SearchRequestFacetSpecFacetKey" }, "GoogleCloudDiscoveryengineV1alphaSearchLinkPromotion": { "properties": { "title": { "description": "Required. The title of the promotion. Maximum length: 160 characters.", "type": "string" }, "enabled": { "type": "boolean", "description": "Optional. The enabled promotion will be returned for any serving configs associated with the parent of the control this promotion is attached to. This flag is used for basic site search only." }, "document": { "description": "Optional. The Document the user wants to promote. For site search, leave unset and only populate uri. Can be set along with uri.", "type": "string" }, "imageUri": { "description": "Optional. The promotion thumbnail image url.", "type": "string" }, "uri": { "description": "Optional. The URL for the page the user wants to promote. Must be set for site search. For other verticals, this is optional.", "type": "string" }, "description": { "type": "string", "description": "Optional. The Promotion description. Maximum length: 200 characters." } }, "description": "Promotion proto includes uri and other helping information to display the promotion.", "type": "object", "id": "GoogleCloudDiscoveryengineV1alphaSearchLinkPromotion" }, "GoogleCloudDiscoveryengineV1alphaConditionTimeRange": { "type": "object", "id": "GoogleCloudDiscoveryengineV1alphaConditionTimeRange", "properties": { "endTime": { "description": "End of time range. Range is inclusive. Must be in the future.", "format": "google-datetime", "type": "string" }, "startTime": { "description": "Start of time range. Range is inclusive.", "format": "google-datetime", "type": "string" } }, "description": "Used for time-dependent conditions." }, "GoogleCloudDiscoveryengineV1betaProject": { "id": "GoogleCloudDiscoveryengineV1betaProject", "type": "object", "description": "Metadata and configurations for a Google Cloud project in the service.", "properties": { "customerProvidedConfig": { "description": "Optional. Customer provided configurations.", "$ref": "GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfig" }, "createTime": { "type": "string", "description": "Output only. The timestamp when this project is created.", "format": "google-datetime", "readOnly": true }, "serviceTermsMap": { "readOnly": true, "description": "Output only. A map of terms of services. The key is the `id` of ServiceTerms.", "additionalProperties": { "$ref": "GoogleCloudDiscoveryengineV1betaProjectServiceTerms" }, "type": "object" }, "provisionCompletionTime": { "description": "Output only. The timestamp when this project is successfully provisioned. Empty value means this project is still provisioning and is not ready for use.", "readOnly": true, "type": "string", "format": "google-datetime" }, "name": { "type": "string", "description": "Output only. Full resource name of the project, for example `projects/{project}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number.", "readOnly": true }, "configurableBillingStatus": { "description": "Output only. The current status of the project's configurable billing.", "$ref": "GoogleCloudDiscoveryengineV1betaProjectConfigurableBillingStatus", "readOnly": true } } }, "GoogleCloudDiscoveryengineV1alphaDataStoreFederatedSearchConfigThirdPartyOauthConfig": { "properties": { "instanceName": { "type": "string", "description": "Optional. The instance name identifying the 3P app, e.g., \"vaissptbots-my\". This is different from the instance_uri which is the full URL of the 3P app e.g., \"https://vaissptbots-my.sharepoint.com\"." }, "appName": { "type": "string", "description": "Optional. The type of the application. E.g., \"jira\", \"box\", etc." } }, "description": "Stores information for third party applicationOAuth.", "id": "GoogleCloudDiscoveryengineV1alphaDataStoreFederatedSearchConfigThirdPartyOauthConfig", "type": "object" }, "GoogleCloudDiscoveryengineV1DeleteSitemapMetadata": { "id": "GoogleCloudDiscoveryengineV1DeleteSitemapMetadata", "type": "object", "properties": { "createTime": { "description": "Operation create time.", "format": "google-datetime", "type": "string" }, "updateTime": { "type": "string", "description": "Operation last update time. If the operation is done, this is also the finish time.", "format": "google-datetime" } }, "description": "Metadata related to the progress of the SiteSearchEngineService.DeleteSitemap operation. This will be returned by the google.longrunning.Operation.metadata field." }, "GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpecQuerySetSpec": { "type": "object", "id": "GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpecQuerySetSpec", "properties": { "sampleQuerySet": { "type": "string", "description": "Optional. The full resource name of the SampleQuerySet used for the evaluation, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`." } }, "description": "Describes the specification of the query set." }, "GoogleCloudDiscoveryengineV1betaTuneEngineMetadata": { "properties": { "engine": { "description": "Required. The resource name of the engine that this tune applies to. Format: `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`", "type": "string" } }, "id": "GoogleCloudDiscoveryengineV1betaTuneEngineMetadata", "type": "object", "description": "Metadata associated with a tune operation." }, "GoogleCloudDiscoveryengineV1alphaCliConfig": { "type": "object", "properties": { "enabledActions": { "description": "Optional. The actions enabled on the associated CLI connection.", "items": { "type": "string" }, "type": "array" } }, "description": "The configuration for the CLI execution based connectors.", "id": "GoogleCloudDiscoveryengineV1alphaCliConfig" }, "GoogleCloudDiscoveryengineV1alphaListSessionsRequest": { "type": "object", "description": "Request for ListSessions method.", "id": "GoogleCloudDiscoveryengineV1alphaListSessionsRequest", "properties": { "pageToken": { "description": "A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page.", "type": "string" }, "pageSize": { "description": "Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.", "type": "integer", "format": "int32" }, "filter": { "type": "string", "description": "A comma-separated list of fields to filter by, in EBNF grammar. The supported fields are: * `user_pseudo_id` * `state` * `display_name` * `starred` * `is_pinned` * `labels` * `create_time` * `update_time` * `collaborative_project` Examples: * `user_pseudo_id = some_id` * `display_name = \"some_name\"` * `starred = true` * `is_pinned=true AND (NOT labels:hidden)` * `create_time \u003e \"1970-01-01T12:00:00Z\"` * `collaborative_project = \"projects/123/locations/global/collections/default_collection/engines/\" \"default_engine/collaborative_projects/cp1\"`" }, "orderBy": { "description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` * `is_pinned` * `display_name` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time.", "type": "string" }, "parent": { "description": "Required. The data store resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`", "type": "string" } } }, "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig": { "description": "Configuration for chunking config.", "type": "object", "properties": { "layoutBasedChunkingConfig": { "description": "Configuration for the layout based chunking.", "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig" } }, "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig" }, "GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpec": { "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpec", "description": "A facet specification to perform faceted search.", "type": "object", "properties": { "enableDynamicPosition": { "type": "boolean", "description": "Enables dynamic position for this facet. If set to true, the position of this facet among all facets in the response is determined automatically. If dynamic facets are enabled, it is ordered together. If set to false, the position of this facet in the response is the same as in the request, and it is ranked before the facets with dynamic position enable and all dynamic facets. For example, you may always want to have rating facet returned in the response, but it's not necessarily to always display the rating facet at the top. In that case, you can set enable_dynamic_position to true so that the position of rating facet in response is determined automatically. Another example, assuming you have the following facets in the request: * \"rating\", enable_dynamic_position = true * \"price\", enable_dynamic_position = false * \"brands\", enable_dynamic_position = false And also you have a dynamic facets enabled, which generates a facet `gender`. Then the final order of the facets in the response can be (\"price\", \"brands\", \"rating\", \"gender\") or (\"price\", \"brands\", \"gender\", \"rating\") depends on how API orders \"gender\" and \"rating\" facets. However, notice that \"price\" and \"brands\" are always ranked at first and second position because their enable_dynamic_position is false." }, "excludedFilterKeys": { "type": "array", "items": { "type": "string" }, "description": "List of keys to exclude when faceting. By default, FacetKey.key is not excluded from the filter unless it is listed in this field. Listing a facet key in this field allows its values to appear as facet results, even when they are filtered out of search results. Using this field does not affect what search results are returned. For example, suppose there are 100 documents with the color facet \"Red\" and 200 documents with the color facet \"Blue\". A query containing the filter \"color:ANY(\"Red\")\" and having \"color\" as FacetKey.key would by default return only \"Red\" documents in the search results, and also return \"Red\" with count 100 as the only color facet. Although there are also blue documents available, \"Blue\" would not be shown as an available facet value. If \"color\" is listed in \"excludedFilterKeys\", then the query returns the facet values \"Red\" with count 100 and \"Blue\" with count 200, because the \"color\" key is now excluded from the filter. Because this field doesn't affect search results, the search results are still correctly filtered to return only \"Red\" documents. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned." }, "limit": { "format": "int32", "description": "Maximum facet values that are returned for this facet. If unspecified, defaults to 20. The maximum allowed value is 300. Values above 300 are coerced to 300. For aggregation in healthcare search, when the [FacetKey.key] is \"healthcare_aggregation_key\", the limit will be overridden to 10,000 internally, regardless of the value set here. If this field is negative, an `INVALID_ARGUMENT` is returned.", "type": "integer" }, "facetKey": { "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpecFacetKey", "description": "Required. The facet key specification." } } }, "GoogleCloudDiscoveryengineV1DestinationConfigDestination": { "properties": { "host": { "description": "Publicly routable host.", "type": "string" }, "port": { "type": "integer", "format": "int32", "description": "Optional. Target port number accepted by the destination." } }, "id": "GoogleCloudDiscoveryengineV1DestinationConfigDestination", "description": "Defines a target endpoint", "type": "object" }, "GoogleCloudDiscoveryengineV1alphaSession": { "type": "object", "properties": { "displayName": { "type": "string", "description": "Optional. The display name of the session. This field is used to identify the session in the UI. By default, the display name is the first turn query text in the session." }, "endTime": { "format": "google-datetime", "description": "Output only. The time the session finished.", "type": "string", "readOnly": true }, "userPseudoId": { "type": "string", "description": "A unique identifier for tracking users." }, "state": { "description": "The state of the session.", "enumDescriptions": [ "State is unspecified.", "The session is currently open." ], "enum": [ "STATE_UNSPECIFIED", "IN_PROGRESS" ], "type": "string" }, "startTime": { "readOnly": true, "format": "google-datetime", "type": "string", "description": "Output only. The time the session started." }, "turns": { "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaSessionTurn" }, "description": "Turns.", "type": "array" }, "isPinned": { "type": "boolean", "description": "Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list." }, "name": { "description": "Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*`", "type": "string" }, "pendingAsyncAssistOperationId": { "description": "Output only. Full resource name of an in-progress AsyncAssist operation for this session, e.g. `projects/*/locations/*/collections/*/engines/*/sessions/*/operations/*`. Set when the operation starts and cleared when it finishes.", "readOnly": true, "type": "string" }, "labels": { "description": "Optional. The labels for the session. Can be set as filter in ListSessionsRequest.", "type": "array", "items": { "type": "string" } } }, "id": "GoogleCloudDiscoveryengineV1alphaSession", "description": "External session proto definition." }, "GoogleApiDistributionBucketOptionsExponential": { "description": "Specifies an exponential sequence of buckets that have a width that is proportional to the value of the lower bound. Each bucket represents a constant relative uncertainty on a specific value in the bucket. There are `num_finite_buckets + 2` (= N) buckets. Bucket `i` has the following boundaries: Upper bound (0 \u003c= i \u003c N-1): scale * (growth_factor ^ i). Lower bound (1 \u003c= i \u003c N): scale * (growth_factor ^ (i - 1)).", "properties": { "growthFactor": { "type": "number", "format": "double", "description": "Must be greater than 1." }, "numFiniteBuckets": { "format": "int32", "description": "Must be greater than 0.", "type": "integer" }, "scale": { "description": "Must be greater than 0.", "format": "double", "type": "number" } }, "type": "object", "id": "GoogleApiDistributionBucketOptionsExponential" }, "GoogleCloudDiscoveryengineV1AnswerCitation": { "properties": { "startIndex": { "type": "string", "description": "Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length.", "format": "int64" }, "endIndex": { "type": "string", "format": "int64", "description": "End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length." }, "sources": { "description": "Citation sources for the attributed segment.", "items": { "$ref": "GoogleCloudDiscoveryengineV1AnswerCitationSource" }, "type": "array" } }, "type": "object", "id": "GoogleCloudDiscoveryengineV1AnswerCitation", "description": "Citation info for a segment." }, "GoogleCloudDiscoveryengineV1Chunk": { "description": "Chunk captures all raw metadata information of items to be recommended or searched in the chunk mode.", "id": "GoogleCloudDiscoveryengineV1Chunk", "properties": { "derivedStructData": { "type": "object", "readOnly": true, "description": "Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document.", "additionalProperties": { "description": "Properties of the object.", "type": "any" } }, "pageSpan": { "$ref": "GoogleCloudDiscoveryengineV1ChunkPageSpan", "description": "Page span of the chunk." }, "dataUrls": { "items": { "type": "string" }, "readOnly": true, "description": "Output only. Image Data URLs if the current chunk contains images. Data URLs are composed of four parts: a prefix (data:), a MIME type indicating the type of data, an optional base64 token if non-textual, and the data itself: data:,", "type": "array" }, "chunkMetadata": { "readOnly": true, "description": "Output only. Metadata of the current chunk.", "$ref": "GoogleCloudDiscoveryengineV1ChunkChunkMetadata" }, "relevanceScore": { "format": "double", "type": "number", "readOnly": true, "description": "Output only. Represents the relevance score based on similarity. Higher score indicates higher chunk relevance. The score is in range [-1.0, 1.0]. Only populated on SearchResponse." }, "content": { "description": "Content is a string from a document (parsed content).", "type": "string" }, "annotationMetadata": { "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1ChunkAnnotationMetadata" }, "description": "Output only. The annotation metadata includes structured content in the current chunk.", "readOnly": true }, "name": { "type": "string", "description": "The full resource name of the chunk. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}/chunks/{chunk_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters." }, "annotationContents": { "items": { "type": "string" }, "type": "array", "description": "Output only. Annotation contents if the current chunk contains annotations.", "readOnly": true }, "id": { "type": "string", "description": "Unique chunk ID of the current chunk." }, "documentMetadata": { "description": "Metadata of the document from the current chunk.", "$ref": "GoogleCloudDiscoveryengineV1ChunkDocumentMetadata" } }, "type": "object" }, "GoogleRpcStatus": { "id": "GoogleRpcStatus", "properties": { "code": { "format": "int32", "description": "The status code, which should be an enum value of google.rpc.Code.", "type": "integer" }, "details": { "type": "array", "items": { "type": "object", "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" } }, "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use." }, "message": { "type": "string", "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client." } }, "type": "object", "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors)." }, "GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig": { "id": "GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig", "description": "Configurations for a Chat Engine.", "properties": { "agentCreationConfig": { "$ref": "GoogleCloudDiscoveryengineV1betaEngineChatEngineConfigAgentCreationConfig", "description": "The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation." }, "allowCrossRegion": { "type": "boolean", "description": "Optional. If the flag set to true, we allow the agent and engine are in different locations, otherwise the agent and engine are required to be in the same location. The flag is set to false by default. Note that the `allow_cross_region` are one-time consumed by and passed to EngineService.CreateEngine. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation." }, "dialogflowAgentToLink": { "description": "The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide `agent_creation_config` to create agent or provide an agent name that links the agent with the Chat engine. Format: `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. Use ChatEngineMetadata.dialogflow_agent for actual agent association after Engine is created.", "type": "string" } }, "type": "object" }, "GoogleCloudDiscoveryengineV1HealthcareFhirConfig": { "type": "object", "id": "GoogleCloudDiscoveryengineV1HealthcareFhirConfig", "properties": { "initialFilterGroups": { "type": "array", "description": "Optional. Names of the Group resources to use as a basis for the initial patient filter, in format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Group/{group_id}`. The filter group must be a FHIR resource name of type Group, and the filter will be constructed from the direct members of the group which are Patient resources.", "items": { "type": "string" } }, "enableStaticIndexingForBatchIngestion": { "type": "boolean", "description": "Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume." }, "enableConfigurableSchema": { "type": "boolean", "description": "Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering." } }, "description": "Config to data store for `HEALTHCARE_FHIR` vertical." }, "GoogleCloudDiscoveryengineV1betaObservabilityConfig": { "id": "GoogleCloudDiscoveryengineV1betaObservabilityConfig", "properties": { "observabilityEnabled": { "type": "boolean", "description": "Optional. Enables observability. If `false`, all other flags are ignored." }, "sensitiveLoggingEnabled": { "type": "boolean", "description": "Optional. Enables sensitive logging. Sensitive logging includes customer core content (e.g. prompts, responses). If `false`, will sanitize all sensitive fields." } }, "description": "Observability config for a resource.", "type": "object" }, "GoogleCloudDiscoveryengineV1WidgetConfigDataStoreUiConfig": { "properties": { "fieldsUiComponentsMap": { "type": "object", "description": "The key is the UI component. Mock. Currently supported `title`, `thumbnail`, `url`, `custom1`, `custom2`, `custom3`. The value is the name of the field along with its device visibility. The 3 custom fields are optional and can be added or removed. `title`, `thumbnail`, `url` are required UI components that cannot be removed.", "additionalProperties": { "$ref": "GoogleCloudDiscoveryengineV1WidgetConfigUIComponentField" } }, "id": { "readOnly": true, "type": "string", "description": "Output only. the identifier of the data store, used for widget service. For now it refers to data_store_id, in the future we will migrate the field to encrypted data store name UUID." }, "name": { "type": "string", "description": "The name of the data store. It should be data store resource name Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. For APIs under WidgetService, such as WidgetService.LookupWidgetConfig, the project number and location part is erased in this field." }, "facetField": { "description": "Facet fields that store the mapping of fields to end user widget appearance.", "items": { "$ref": "GoogleCloudDiscoveryengineV1WidgetConfigFacetField" }, "type": "array" } }, "description": "UI component configuration for data store.", "id": "GoogleCloudDiscoveryengineV1WidgetConfigDataStoreUiConfig", "type": "object" }, "GoogleCloudDiscoveryengineV1DataStoreFederatedSearchConfigAlloyDbConfig": { "properties": { "alloydbConnectionConfig": { "description": "Required. Configuration for connecting to AlloyDB.", "$ref": "GoogleCloudDiscoveryengineV1DataStoreFederatedSearchConfigAlloyDbConfigAlloyDbConnectionConfig" }, "alloydbAiNlConfig": { "$ref": "GoogleCloudDiscoveryengineV1DataStoreFederatedSearchConfigAlloyDbConfigAlloyDbAiNaturalLanguageConfig", "description": "Optional. Configuration for Magic." }, "returnedFields": { "description": "Optional. Fields to be returned in the search results. If empty, all fields will be returned.", "type": "array", "items": { "type": "string" } } }, "type": "object", "description": "Stores information for connecting to AlloyDB.", "id": "GoogleCloudDiscoveryengineV1DataStoreFederatedSearchConfigAlloyDbConfig" }, "A2aV1AgentExtension": { "type": "object", "description": "A declaration of an extension supported by an Agent.", "id": "A2aV1AgentExtension", "properties": { "description": { "description": "A description of how this agent uses this extension. Example: \"Google OAuth 2.0 authentication\"", "type": "string" }, "required": { "description": "Whether the client must follow specific requirements of the extension. Example: false", "type": "boolean" }, "params": { "type": "object", "description": "Optional configuration for the extension.", "additionalProperties": { "description": "Properties of the object.", "type": "any" } }, "uri": { "type": "string", "description": "The URI of the extension. Example: \"https://developers.google.com/identity/protocols/oauth2\"" } } }, "GoogleCloudDiscoveryengineV1betaConditionTimeRange": { "properties": { "endTime": { "description": "End of time range. Range is inclusive. Must be in the future.", "format": "google-datetime", "type": "string" }, "startTime": { "format": "google-datetime", "type": "string", "description": "Start of time range. Range is inclusive." } }, "id": "GoogleCloudDiscoveryengineV1betaConditionTimeRange", "description": "Used for time-dependent conditions.", "type": "object" }, "GoogleCloudDiscoveryengineV1alphaProjectConfigurableBillingStatus": { "description": "Represents the currently effective configurable billing parameters. These values are derived from the customer's subscription history stored internally and reflect the thresholds actively being used for billing purposes at the time of the GetProject call. This includes the start_time of the subscription and may differ from the values in `customer_provided_config` due to billing rules (e.g., scale-downs taking effect only at the start of a new month). We also include the update type to indicate the type of update performed on the configurable billing configuration in the UpdateProject operation.", "properties": { "terminateTime": { "description": "Output only. The latest terminate effective time of search qpm and indexing core subscriptions.", "readOnly": true, "format": "google-datetime", "type": "string" }, "updateType": { "type": "string", "readOnly": true, "enumDescriptions": [ "Unspecified update type.", "Configurable billing was created/enabled.", "Configurable billing was deleted/disabled.", "Subscription was scaled up (thresholds increased).", "Subscription was scaled down (thresholds decreased)." ], "description": "Output only. The type of update performed in this operation. This field is populated in the response of UpdateProject.", "enum": [ "UPDATE_TYPE_UNSPECIFIED", "CREATE", "DELETE", "SCALE_UP", "SCALE_DOWN" ] }, "searchQpmThresholdNextUpdateTime": { "format": "google-datetime", "readOnly": true, "description": "Output only. The earliest next update time for the search QPM subscription threshold. This is based on the next_update_time returned by the underlying Cloud Billing Subscription V3 API. This field is populated only if an update QPM subscription threshold request is succeeded.", "type": "string" }, "indexingCoreThresholdNextUpdateTime": { "readOnly": true, "description": "Output only. The earliest next update time for the indexing core subscription threshold. This is based on the next_update_time returned by the underlying Cloud Billing Subscription V3 API. This field is populated only if an update indexing core subscription threshold request is succeeded.", "format": "google-datetime", "type": "string" }, "startTime": { "type": "string", "description": "Optional. The start time of the currently active billing subscription.", "format": "google-datetime" }, "effectiveIndexingCoreThreshold": { "description": "Optional. The currently effective Indexing Core threshold. This is the threshold against which Indexing Core usage is compared for overage calculations.", "format": "int64", "type": "string" }, "effectiveSearchQpmThreshold": { "type": "string", "description": "Optional. The currently effective Search QPM threshold in queries per minute. This is the threshold against which QPM usage is compared for overage calculations.", "format": "int64" }, "agentSearchTokenSubscriptionStatuses": { "readOnly": true, "description": "Output only. Per-model Agent Search TPM subscription status.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaProjectConfigurableBillingStatusAgentSearchTokenSubscriptionStatus" } } }, "id": "GoogleCloudDiscoveryengineV1alphaProjectConfigurableBillingStatus", "type": "object" }, "GoogleCloudDiscoveryengineV1betaControlRedirectAction": { "description": "Redirects a shopper to the provided URI.", "type": "object", "properties": { "redirectUri": { "description": "Required. The URI to which the shopper will be redirected. Required. URI must have length equal or less than 2000 characters. Otherwise an INVALID ARGUMENT error is thrown.", "type": "string" } }, "id": "GoogleCloudDiscoveryengineV1betaControlRedirectAction" }, "GoogleCloudDiscoveryengineV1betaImportSampleQueriesResponse": { "description": "Response of the SampleQueryService.ImportSampleQueries method. If the long running operation is done, this message is returned by the google.longrunning.Operations.response field if the operation is successful.", "properties": { "errorSamples": { "description": "A sample of errors encountered while processing the request.", "type": "array", "items": { "$ref": "GoogleRpcStatus" } }, "errorConfig": { "description": "The desired location of errors incurred during the Import.", "$ref": "GoogleCloudDiscoveryengineV1betaImportErrorConfig" } }, "id": "GoogleCloudDiscoveryengineV1betaImportSampleQueriesResponse", "type": "object" }, "GoogleCloudDiscoveryengineV1alphaPurgeDocumentsMetadata": { "description": "Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1alphaPurgeDocumentsMetadata", "properties": { "updateTime": { "format": "google-datetime", "description": "Operation last update time. If the operation is done, this is also the finish time.", "type": "string" }, "createTime": { "format": "google-datetime", "description": "Operation create time.", "type": "string" }, "failureCount": { "format": "int64", "description": "Count of entries that encountered errors while processing.", "type": "string" }, "ignoredCount": { "format": "int64", "type": "string", "description": "Count of entries that were ignored as entries were not found." }, "successCount": { "format": "int64", "description": "Count of entries that were deleted successfully.", "type": "string" } }, "type": "object" }, "GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig": { "type": "object", "properties": { "searchAddOns": { "type": "array", "items": { "type": "string", "enum": [ "SEARCH_ADD_ON_UNSPECIFIED", "SEARCH_ADD_ON_LLM" ], "enumDescriptions": [ "Default value when the enum is unspecified. This is invalid to use.", "Large language model add-on." ] }, "description": "The add-on that this search engine enables." }, "searchTier": { "enumDescriptions": [ "Default value when the enum is unspecified. This is invalid to use.", "Standard tier.", "Enterprise tier." ], "description": "The search feature tier of this engine. Different tiers might have different pricing. To learn more, check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified.", "enum": [ "SEARCH_TIER_UNSPECIFIED", "SEARCH_TIER_STANDARD", "SEARCH_TIER_ENTERPRISE" ], "type": "string" }, "requiredSubscriptionTier": { "enum": [ "SUBSCRIPTION_TIER_UNSPECIFIED", "SUBSCRIPTION_TIER_SEARCH", "SUBSCRIPTION_TIER_SEARCH_AND_ASSISTANT", "SUBSCRIPTION_TIER_NOTEBOOK_LM", "SUBSCRIPTION_TIER_FRONTLINE_WORKER", "SUBSCRIPTION_TIER_AGENTSPACE_STARTER", "SUBSCRIPTION_TIER_AGENTSPACE_BUSINESS", "SUBSCRIPTION_TIER_ENTERPRISE", "SUBSCRIPTION_TIER_ENTERPRISE_EMERGING", "SUBSCRIPTION_TIER_EDU", "SUBSCRIPTION_TIER_EDU_PRO", "SUBSCRIPTION_TIER_EDU_EMERGING", "SUBSCRIPTION_TIER_EDU_PRO_EMERGING", "SUBSCRIPTION_TIER_FRONTLINE_STARTER", "SUBSCRIPTION_TIER_CONSUMPTION_ONLY", "SUBSCRIPTION_TIER_EDU_GOV_EMERGING" ], "type": "string", "enumDescriptions": [ "Default value.", "Search tier. Search tier can access Vertex AI Search features and NotebookLM features.", "Gemini Enterprise Plus tier.", "NotebookLM tier. NotebookLM is a subscription tier can only access NotebookLM features.", "Gemini Frontline worker tier.", "Gemini Business Starter tier.", "Gemini Business tier.", "Gemini Enterprise Standard tier.", "Gemini Enterprise Standard tier for emerging markets.", "Gemini Enterprise EDU tier.", "Gemini Enterprise EDU Pro tier.", "Gemini Enterprise EDU tier for emerging market only.", "Gemini Enterprise EDU Pro tier for emerging market.", "Gemini Frontline Starter tier.", "Represents the Gemini Enterprise Consumption-only tier: $0 subscription billed purely on usage (PAYG).", "Gemini Enterprise EDU tier for government in emerging markets." ], "description": "Optional. The required subscription tier of this engine. If the required subscription tier is search, user with higher license tier like assist can still access the standalone app associated with this engine. Web grounding feature is only available on the app if it is set as SubscriptionTier.SUBSCRIPTION_TIER_SEARCH_AND_ASSISTANT." } }, "description": "Configurations for a Search Engine.", "id": "GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig" }, "GoogleCloudDiscoveryengineV1AssistantToolInfo": { "properties": { "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" }, "toolDisplayName": { "type": "string", "description": "The display name of the tool." } }, "description": "Information to identify a tool.", "id": "GoogleCloudDiscoveryengineV1AssistantToolInfo", "type": "object" }, "GoogleCloudDiscoveryengineV1AssistantGroundedContentTextGroundingMetadataSegment": { "id": "GoogleCloudDiscoveryengineV1AssistantGroundedContentTextGroundingMetadataSegment", "properties": { "groundingScore": { "format": "float", "description": "Score for the segment.", "type": "number" }, "startIndex": { "type": "string", "format": "int64", "description": "Zero-based index indicating the start of the segment, measured in bytes of a UTF-8 string (i.e. characters encoded on multiple bytes have a length of more than one)." }, "text": { "description": "The text segment itself.", "type": "string" }, "endIndex": { "format": "int64", "description": "End of the segment, exclusive.", "type": "string" }, "referenceIndices": { "description": "References for the segment.", "items": { "format": "int32", "type": "integer" }, "type": "array" } }, "type": "object", "description": "Grounding information for a segment of the text." }, "GoogleCloudDiscoveryengineV1betaSearchRequestPersonalizationSpec": { "description": "The specification for personalization.", "id": "GoogleCloudDiscoveryengineV1betaSearchRequestPersonalizationSpec", "type": "object", "properties": { "mode": { "description": "The personalization mode of the search request. Defaults to Mode.AUTO.", "enumDescriptions": [ "Default value. In this case, server behavior defaults to Mode.AUTO.", "Personalization is enabled if data quality requirements are met.", "Disable personalization." ], "enum": [ "MODE_UNSPECIFIED", "AUTO", "DISABLED" ], "type": "string" } } }, "GoogleCloudDiscoveryengineV1CustomTuningModel": { "id": "GoogleCloudDiscoveryengineV1CustomTuningModel", "description": "Metadata that describes a custom tuned model.", "type": "object", "properties": { "createTime": { "description": "Deprecated: Timestamp the Model was created at.", "type": "string", "deprecated": true, "format": "google-datetime" }, "displayName": { "description": "The display name of the model.", "type": "string" }, "metrics": { "type": "object", "description": "The metrics of the trained model.", "additionalProperties": { "type": "number", "format": "double" } }, "modelState": { "enum": [ "MODEL_STATE_UNSPECIFIED", "TRAINING_PAUSED", "TRAINING", "TRAINING_COMPLETE", "READY_FOR_SERVING", "TRAINING_FAILED", "NO_IMPROVEMENT", "INPUT_VALIDATION_FAILED" ], "description": "The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`).", "type": "string", "enumDescriptions": [ "Default value.", "The model is in a paused training state.", "The model is currently training.", "The model has successfully completed training.", "The model is ready for serving.", "The model training failed.", "The model training finished successfully but metrics did not improve.", "Input data validation failed. Model training didn't start." ] }, "modelVersion": { "type": "string", "format": "int64", "description": "The version of the model." }, "name": { "description": "Required. The fully qualified resource name of the model. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}`. Model must be an alpha-numerical string with limit of 40 characters.", "type": "string" }, "trainingStartTime": { "type": "string", "description": "Timestamp the model training was initiated.", "format": "google-datetime" }, "errorMessage": { "type": "string", "description": "Currently this is only populated if the model state is `INPUT_VALIDATION_FAILED`." } } }, "GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsRequest": { "type": "object", "properties": {}, "description": "Request message for CompletionService.PurgeCompletionSuggestions method.", "id": "GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsRequest" }, "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponseQuerySuggestion": { "type": "object", "properties": { "suggestion": { "description": "The suggestion for the query.", "type": "string" }, "completableFieldPaths": { "items": { "type": "string" }, "type": "array", "description": "The unique document field paths that serve as the source of this suggestion if it was generated from completable fields. This field is only populated for the document-completable model." }, "score": { "format": "double", "description": "The score of each suggestion. The score is in the range of [0, 1].", "type": "number" }, "dataStore": { "type": "array", "description": "The name of the dataStore that this suggestion belongs to.", "items": { "type": "string" } } }, "description": "Suggestions as search queries.", "id": "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponseQuerySuggestion" }, "GoogleCloudDiscoveryengineV1AssistantGenerationConfigSystemInstruction": { "id": "GoogleCloudDiscoveryengineV1AssistantGenerationConfigSystemInstruction", "type": "object", "properties": { "additionalSystemInstruction": { "description": "Optional. Additional system instruction that will be added to the default system instruction.", "type": "string" } }, "description": "System instruction, also known as the prompt preamble for LLM calls." }, "A2aV1FilePart": { "properties": { "fileWithBytes": { "type": "string", "format": "byte" }, "fileWithUri": { "type": "string" }, "mimeType": { "type": "string" }, "name": { "type": "string" } }, "id": "A2aV1FilePart", "description": "FilePart represents the different ways files can be provided. If files are small, directly feeding the bytes is supported via file_with_bytes. If the file is large, the agent should read the content as appropriate directly from the file_with_uri source.", "type": "object" }, "GoogleCloudDiscoveryengineV1StreamAssistRequest": { "type": "object", "description": "Request for the AssistantService.StreamAssist method.", "id": "GoogleCloudDiscoveryengineV1StreamAssistRequest", "properties": { "session": { "description": "Optional. The session to use for the request. If specified, the assistant has access to the session history, and the query and the answer are stored there. If `-` is specified as the session ID, or it is left empty, then a new session is created with an automatically generated ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}`", "type": "string" }, "userMetadata": { "description": "Optional. Information about the user initiating the query.", "$ref": "GoogleCloudDiscoveryengineV1AssistUserMetadata" }, "agentsSpec": { "description": "Optional. Specification of agents that are used to serve the request.", "$ref": "GoogleCloudDiscoveryengineV1StreamAssistRequestAgentsSpec" }, "query": { "description": "Optional. Current user query. Empty query is only supported if `file_ids` are provided. In this case, the answer will be generated based on those context files.", "$ref": "GoogleCloudDiscoveryengineV1Query" }, "generationSpec": { "$ref": "GoogleCloudDiscoveryengineV1StreamAssistRequestGenerationSpec", "description": "Optional. Specification of the generation configuration for the request." }, "toolsSpec": { "description": "Optional. Specification of tools that are used to serve the request.", "$ref": "GoogleCloudDiscoveryengineV1StreamAssistRequestToolsSpec" } } }, "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec": { "type": "object", "id": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec", "properties": { "version": { "type": "string", "description": "The model version used to generate the summary. Supported values are: * `stable`: string. Default value when no value is specified. Uses a generally available, fine-tuned model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). * `preview`: string. (Public preview) Uses a preview model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models)." } }, "description": "Specification of the model." }, "GoogleCloudDiscoveryengineV1RecommendRequest": { "properties": { "params": { "description": "Additional domain specific parameters for the recommendations. Allowed values: * `returnDocument`: Boolean. If set to `true`, the associated Document object is returned in RecommendResponse.RecommendationResult.document. * `returnScore`: Boolean. If set to true, the recommendation score corresponding to each returned Document is set in RecommendResponse.RecommendationResult.metadata. The given score indicates the probability of a Document conversion given the user's context and history. * `strictFiltering`: Boolean. True by default. If set to `false`, the service returns generic (unfiltered) popular Documents instead of empty if your filter blocks all recommendation results. * `diversityLevel`: String. Default empty. If set to be non-empty, then it needs to be one of: * `no-diversity` * `low-diversity` * `medium-diversity` * `high-diversity` * `auto-diversity` This gives request-level control and adjusts recommendation results based on Document category. * `attributeFilteringSyntax`: Boolean. False by default. If set to true, the `filter` field is interpreted according to the new, attribute-based syntax.", "type": "object", "additionalProperties": { "type": "any" } }, "filter": { "description": "Filter for restricting recommendation results with a length limit of 5,000 characters. Currently, only filter expressions on the `filter_tags` attribute is supported. Examples: * `(filter_tags: ANY(\"Red\", \"Blue\") OR filter_tags: ANY(\"Hot\", \"Cold\"))` * `(filter_tags: ANY(\"Red\", \"Blue\")) AND NOT (filter_tags: ANY(\"Green\"))` If `attributeFilteringSyntax` is set to true under the `params` field, then attribute-based expressions are expected instead of the above described tag-based syntax. Examples: * (language: ANY(\"en\", \"es\")) AND NOT (categories: ANY(\"Movie\")) * (available: true) AND (language: ANY(\"en\", \"es\")) OR (categories: ANY(\"Movie\")) If your filter blocks all results, the API returns generic (unfiltered) popular Documents. If you only want results strictly matching the filters, set `strictFiltering` to `true` in RecommendRequest.params to receive empty results instead. Note that the API never returns Documents with `storageStatus` as `EXPIRED` or `DELETED` regardless of filter choices.", "type": "string" }, "userLabels": { "type": "object", "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 [Requirements for labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.", "additionalProperties": { "type": "string" } }, "userEvent": { "$ref": "GoogleCloudDiscoveryengineV1UserEvent", "description": "Required. Context about the user, what they are looking at and what action they took to trigger the Recommend request. Note that this user event detail won't be ingested to userEvent logs. Thus, a separate userEvent write request is required for event logging. Don't set UserEvent.user_pseudo_id or UserEvent.user_info.user_id to the same fixed ID for different users. If you are trying to receive non-personalized recommendations (not recommended; this can negatively impact model performance), instead set UserEvent.user_pseudo_id to a random unique ID and leave UserEvent.user_info.user_id unset." }, "pageSize": { "format": "int32", "type": "integer", "description": "Maximum number of results to return. Set this property to the number of recommendation results needed. If zero, the service chooses a reasonable default. The maximum allowed value is 100. Values above 100 are set to 100." }, "validateOnly": { "type": "boolean", "description": "Use validate only mode for this recommendation query. If set to `true`, a fake model is used that returns arbitrary Document IDs. Note that the validate only mode should only be used for testing the API, or if the model is not ready." } }, "type": "object", "description": "Request message for Recommend method.", "id": "GoogleCloudDiscoveryengineV1RecommendRequest" }, "GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfig": { "description": "Configuration for NotebookLM.", "properties": { "dataProtectionPolicy": { "$ref": "GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfigDataProtectionPolicy", "description": "Optional. Specifies the data protection policy for NotebookLM." }, "observabilityConfig": { "description": "Optional. Observability config for NotebookLM.", "$ref": "GoogleCloudDiscoveryengineV1alphaObservabilityConfig" }, "modelArmorConfig": { "description": "Model Armor configuration to be used for sanitizing user prompts and LLM responses.", "$ref": "GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig" }, "optOutNotebookSharing": { "type": "boolean", "description": "Optional. Whether to disable the notebook sharing feature for the project. Default to false if not specified." } }, "type": "object", "id": "GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfig" }, "GoogleCloudDiscoveryengineV1betaProjectConfigurableBillingStatusAgentSearchTokenSubscriptionStatus": { "description": "Per-model Agent Search TPM subscription status. One entry per active `core_subscription.agent_search_token_subscriptions[*]` entry in the customer-provided config; populated by UpdateProject and GetProject. The lifecycle scalars on this message (`start_time`, `terminate_time`, `update_type`, `tpm_threshold_next_update_time`) are per (project, model_version) — siblings of the whole-relationship `start_time` / `terminate_time` / `update_type` on the enclosing ConfigurableBillingStatus, but scoped to this specific Agent Search TPM subscription instead of to the overall customer-configurable- pricing relationship. This per-instance granularity is intentional: the underlying SubV3 storage is per-(project, model_version), so each model has its own activation, termination, and deferred-update clock; surfacing that on the response gives customers the granularity they need to manage per-model commitments independently. QPM / IndexingCore differ — their storage is one row per (project, location), so their lifecycle is represented only by the whole- relationship scalars on ConfigurableBillingStatus.", "type": "object", "properties": { "effectiveTpmThreshold": { "description": "Output only. The currently effective TPM threshold. Reflects scale-up immediately and scale-down at the next billing cycle, matching `effective_search_qpm_threshold` semantics.", "format": "int64", "readOnly": true, "type": "string" }, "tpmThresholdNextUpdateTime": { "readOnly": true, "type": "string", "description": "Output only. The earliest next update time for the TPM subscription threshold for this (project, model_version). Populated only after a successful update.", "format": "google-datetime" }, "terminateTime": { "readOnly": true, "description": "Output only. If set, the scheduled effective time at which this (project, model_version) Agent Search TPM subscription will terminate. Populated when the customer removes this entry from `core_subscription.agent_search_token_subscriptions[*]`. Does NOT move the whole-relationship `terminate_time` on the enclosing ConfigurableBillingStatus, which is populated only when the entire customer-configurable-pricing relationship is being torn down.", "type": "string", "format": "google-datetime" }, "modelVersion": { "type": "string", "readOnly": true, "description": "Output only. The Gemini model version this status corresponds to. Matches CoreSubscription.AgentSearchTokenSubscription.model_version (a stable Gemini model version from the Gemini Enterprise Agent Platform model-versions registry; see https://docs.cloud.google.com/gemini-enterprise-agent-platform/models/model-versions#gemini-models)." }, "updateType": { "enumDescriptions": [ "Unspecified update type.", "Configurable billing was created/enabled.", "Configurable billing was deleted/disabled.", "Subscription was scaled up (thresholds increased).", "Subscription was scaled down (thresholds decreased)." ], "description": "Output only. The type of the most recent update to this (project, model_version) subscription, as performed by the most recent UpdateProject call. `UPDATE_TYPE_UNSPECIFIED` indicates this model_version was not touched by the most recent UpdateProject (its `effective_tpm_threshold` reflects an earlier update). The whole-relationship `update_type` on the enclosing ConfigurableBillingStatus continues to summarize the direction of the most recent update across all surfaces in the project (QPM, IndexingCore, and Agent Search TPM together).", "type": "string", "readOnly": true, "enum": [ "UPDATE_TYPE_UNSPECIFIED", "CREATE", "DELETE", "SCALE_UP", "SCALE_DOWN" ] }, "startTime": { "type": "string", "description": "Output only. When this (project, model_version) Agent Search TPM subscription was first activated. Set once on first activation of this model version and never moved by subsequent threshold updates; on termination + re-activation a new value is recorded. Does NOT move the whole-relationship `start_time` on the enclosing ConfigurableBillingStatus, which continues to represent the first activation of the overall customer-configurable-pricing relationship.", "readOnly": true, "format": "google-datetime" } }, "id": "GoogleCloudDiscoveryengineV1betaProjectConfigurableBillingStatusAgentSearchTokenSubscriptionStatus" }, "GoogleCloudDiscoveryengineV1WidgetConfigAssistantSettings": { "properties": { "webGroundingType": { "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." ], "description": "Optional. The type of web grounding to use.", "type": "string", "enum": [ "WEB_GROUNDING_TYPE_UNSPECIFIED", "WEB_GROUNDING_TYPE_DISABLED", "WEB_GROUNDING_TYPE_GOOGLE_SEARCH", "WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH" ] }, "defaultWebGroundingToggleOff": { "type": "boolean", "readOnly": true, "description": "Output only. This field controls the default web grounding toggle for end users if `web_grounding_type` is set to `WEB_GROUNDING_TYPE_GOOGLE_SEARCH` or `WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH`. By default, this field is set to false. If `web_grounding_type` is `WEB_GROUNDING_TYPE_GOOGLE_SEARCH` or `WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH`, end users will have web grounding enabled by default on UI. If true, grounding toggle will be disabled by default on UI. End users can still enable web grounding in the UI if web grounding is enabled." }, "googleSearchGroundingEnabled": { "type": "boolean", "deprecated": true, "description": "Whether or not the Google search grounding toggle is shown. Deprecated. Use web_grounding_type instead." }, "disableLocationContext": { "type": "boolean", "readOnly": true, "description": "Optional. Output only. Whether to disable user location context." } }, "description": "Describes the assistant settings of the widget.", "id": "GoogleCloudDiscoveryengineV1WidgetConfigAssistantSettings", "type": "object" }, "A2aV1Message": { "type": "object", "id": "A2aV1Message", "description": "Message is one unit of communication between client and server. It is associated with a context and optionally a task. Since the server is responsible for the context definition, it must always provide a context_id in its messages. The client can optionally provide the context_id if it knows the context to associate the message to. Similarly for task_id, except the server decides if a task is created and whether to include the task_id.", "properties": { "messageId": { "description": "The unique identifier (e.g. UUID)of the message. This is required and created by the message creator.", "type": "string" }, "extensions": { "description": "The URIs of extensions that are present or contributed to this Message.", "type": "array", "items": { "type": "string" } }, "metadata": { "type": "object", "description": "protolint:enable REPEATED_FIELD_NAMES_PLURALIZED Any optional metadata to provide along with the message.", "additionalProperties": { "description": "Properties of the object.", "type": "any" } }, "role": { "enumDescriptions": [ "", "USER role refers to communication from the client to the server.", "AGENT role refers to communication from the server to the client." ], "type": "string", "enum": [ "ROLE_UNSPECIFIED", "ROLE_USER", "ROLE_AGENT" ], "description": "A role for the message." }, "taskId": { "description": "The task id of the message. This is optional and if set, the message will be associated with the given task.", "type": "string" }, "content": { "type": "array", "items": { "$ref": "A2aV1Part" }, "description": "protolint:disable REPEATED_FIELD_NAMES_PLURALIZED Content is the container of the message content." }, "contextId": { "description": "The context id of the message. This is optional and if set, the message will be associated with the given context.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesResponse": { "id": "GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesResponse", "description": "Response message for CompletionService.ImportSuggestionDenyListEntries method.", "properties": { "failedEntriesCount": { "type": "string", "format": "int64", "description": "Count of deny list entries that failed to be imported." }, "importedEntriesCount": { "format": "int64", "description": "Count of deny list entries successfully imported.", "type": "string" }, "errorSamples": { "description": "A sample of errors encountered while processing the request.", "items": { "$ref": "GoogleRpcStatus" }, "type": "array" } }, "type": "object" }, "GoogleCloudDiscoveryengineV1EngineChatEngineConfigAgentCreationConfig": { "id": "GoogleCloudDiscoveryengineV1EngineChatEngineConfigAgentCreationConfig", "properties": { "business": { "description": "Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search.", "type": "string" }, "defaultLanguageCode": { "type": "string", "description": "Required. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes." }, "timeZone": { "type": "string", "description": "Required. The time zone of the agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris." }, "location": { "description": "Agent location for Agent creation, supported values: global/us/eu. If not provided, us Engine will create Agent using us-central-1 by default; eu Engine will create Agent using eu-west-1 by default.", "type": "string" } }, "description": "Configurations for generating a Dialogflow agent. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation.", "type": "object" }, "GoogleCloudDiscoveryengineV1BigtableOptionsBigtableColumn": { "properties": { "fieldName": { "description": "The field name to use for this column in the document. The name has to match the pattern `a-zA-Z0-9*`. If not set, it is parsed from the qualifier bytes with best effort. However, due to different naming patterns, field name collisions could happen, where parsing behavior is undefined.", "type": "string" }, "qualifier": { "description": "Required. Qualifier of the column. If it cannot be decoded with utf-8, use a base-64 encoded string instead.", "type": "string", "format": "byte" }, "type": { "type": "string", "description": "The type of values in this column family. The values are expected to be encoded using `HBase Bytes.toBytes` function when the encoding value is set to `BINARY`.", "enum": [ "TYPE_UNSPECIFIED", "STRING", "NUMBER", "INTEGER", "VAR_INTEGER", "BIG_NUMERIC", "BOOLEAN", "JSON" ], "enumDescriptions": [ "The type is unspecified.", "String type.", "Numerical type.", "Integer type.", "Variable length integer type.", "BigDecimal type.", "Boolean type.", "JSON type." ] }, "encoding": { "enumDescriptions": [ "The encoding is unspecified.", "Text encoding.", "Binary encoding." ], "description": "The encoding mode of the values when the type is not `STRING`. Acceptable encoding values are: * `TEXT`: indicates values are alphanumeric text strings. * `BINARY`: indicates values are encoded using `HBase Bytes.toBytes` family of functions. This can be overridden for a specific column by listing that column in `columns` and specifying an encoding for it.", "type": "string", "enum": [ "ENCODING_UNSPECIFIED", "TEXT", "BINARY" ] } }, "id": "GoogleCloudDiscoveryengineV1BigtableOptionsBigtableColumn", "description": "The column of the Bigtable.", "type": "object" }, "GoogleCloudDiscoveryengineV1alphaUpdateCollectionMetadata": { "properties": { "updateTime": { "format": "google-datetime", "type": "string", "description": "Operation last update time. If the operation is done, this is also the finish time." }, "createTime": { "type": "string", "description": "Operation create time.", "format": "google-datetime" } }, "type": "object", "description": "Metadata related to the progress of the CollectionService.UpdateCollection operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1alphaUpdateCollectionMetadata" }, "GoogleCloudDiscoveryengineV1alphaListSessionsResponse": { "type": "object", "properties": { "sessions": { "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaSession" }, "description": "All the Sessions for a given data store.", "type": "array" }, "nextPageToken": { "type": "string", "description": "Pagination token, if not returned indicates the last page." } }, "id": "GoogleCloudDiscoveryengineV1alphaListSessionsResponse", "description": "Response for ListSessions method." }, "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec": { "description": "Specification of the prompt to use with the model.", "properties": { "preamble": { "type": "string", "description": "Text at the beginning of the prompt that instructs the assistant. Examples are available in the user guide." } }, "type": "object", "id": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec" }, "GoogleCloudDiscoveryengineV1AnswerGenerationSpec": { "properties": { "userDefinedClassifierSpec": { "description": "Optional. The specification for user specified classifier spec.", "$ref": "GoogleCloudDiscoveryengineV1AnswerGenerationSpecUserDefinedClassifierSpec" } }, "description": "The specification for answer generation.", "id": "GoogleCloudDiscoveryengineV1AnswerGenerationSpec", "type": "object" }, "GoogleCloudDiscoveryengineV1ImportDocumentsRequestInlineSource": { "type": "object", "description": "The inline source for the input config for ImportDocuments method.", "properties": { "documents": { "items": { "$ref": "GoogleCloudDiscoveryengineV1Document" }, "description": "Required. A list of documents to update/create. Each document must have a valid Document.id. Recommended max of 100 items.", "type": "array" } }, "id": "GoogleCloudDiscoveryengineV1ImportDocumentsRequestInlineSource" }, "GoogleIamV1Binding": { "properties": { "role": { "type": "string", "description": "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles)." }, "members": { "description": "Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.", "items": { "type": "string" }, "type": "array" }, "condition": { "$ref": "GoogleTypeExpr", "description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)." } }, "description": "Associates `members`, or principals, with a `role`.", "id": "GoogleIamV1Binding", "type": "object" }, "GoogleCloudDiscoveryengineV1alphaObtainCrawlRateResponse": { "id": "GoogleCloudDiscoveryengineV1alphaObtainCrawlRateResponse", "properties": { "organicCrawlRateTimeSeries": { "$ref": "GoogleCloudDiscoveryengineV1alphaOrganicCrawlRateTimeSeries", "description": "The historical organic crawl rate timeseries data, used for monitoring." }, "state": { "description": "Output only. The state of the response.", "enum": [ "STATE_UNSPECIFIED", "SUCCEEDED", "FAILED" ], "readOnly": true, "type": "string", "enumDescriptions": [ "The state is unspecified.", "The state is successful.", "The state is failed." ] }, "dedicatedCrawlRateTimeSeries": { "description": "The historical dedicated crawl rate timeseries data, used for monitoring.", "$ref": "GoogleCloudDiscoveryengineV1alphaDedicatedCrawlRateTimeSeries" }, "error": { "description": "Errors from service when handling the request.", "$ref": "GoogleRpcStatus" } }, "description": "Response message for CrawlRateManagementService.ObtainCrawlRate method. The response contains organcic or dedicated crawl rate time series data for monitoring, depending on whether dedicated crawl rate is set.", "type": "object" }, "GoogleCloudDiscoveryengineV1SafetyRating": { "properties": { "severityScore": { "format": "float", "type": "number", "readOnly": true, "description": "Output only. Harm severity score." }, "probabilityScore": { "format": "float", "type": "number", "description": "Output only. Harm probability score.", "readOnly": true }, "severity": { "readOnly": true, "type": "string", "description": "Output only. Harm severity levels in the content.", "enumDescriptions": [ "Harm severity unspecified.", "Negligible level of harm severity.", "Low level of harm severity.", "Medium level of harm severity.", "High level of harm severity." ], "enum": [ "HARM_SEVERITY_UNSPECIFIED", "HARM_SEVERITY_NEGLIGIBLE", "HARM_SEVERITY_LOW", "HARM_SEVERITY_MEDIUM", "HARM_SEVERITY_HIGH" ] }, "category": { "enum": [ "HARM_CATEGORY_UNSPECIFIED", "HARM_CATEGORY_HATE_SPEECH", "HARM_CATEGORY_DANGEROUS_CONTENT", "HARM_CATEGORY_HARASSMENT", "HARM_CATEGORY_SEXUALLY_EXPLICIT", "HARM_CATEGORY_CIVIC_INTEGRITY" ], "readOnly": true, "type": "string", "description": "Output only. Harm category.", "enumDescriptions": [ "The harm category is unspecified.", "The harm category is hate speech.", "The harm category is dangerous content.", "The harm category is harassment.", "The harm category is sexually explicit content.", "The harm category is civic integrity." ] }, "blocked": { "type": "boolean", "description": "Output only. Indicates whether the content was filtered out because of this rating.", "readOnly": true }, "probability": { "type": "string", "enumDescriptions": [ "Harm probability unspecified.", "Negligible level of harm.", "Low level of harm.", "Medium level of harm.", "High level of harm." ], "description": "Output only. Harm probability levels in the content.", "enum": [ "HARM_PROBABILITY_UNSPECIFIED", "NEGLIGIBLE", "LOW", "MEDIUM", "HIGH" ], "readOnly": true } }, "id": "GoogleCloudDiscoveryengineV1SafetyRating", "description": "Safety rating corresponding to the generated content.", "type": "object" }, "GoogleCloudDiscoveryengineV1alphaImportSampleQueriesMetadata": { "properties": { "createTime": { "description": "ImportSampleQueries operation create time.", "format": "google-datetime", "type": "string" }, "updateTime": { "format": "google-datetime", "type": "string", "description": "ImportSampleQueries operation last update time. If the operation is done, this is also the finish time." }, "failureCount": { "format": "int64", "type": "string", "description": "Count of SampleQuerys that failed to be imported." }, "totalCount": { "format": "int64", "description": "Total count of SampleQuerys that were processed.", "type": "string" }, "successCount": { "description": "Count of SampleQuerys successfully imported.", "type": "string", "format": "int64" } }, "description": "Metadata related to the progress of the ImportSampleQueries operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1alphaImportSampleQueriesMetadata", "type": "object" }, "A2aV1AuthenticationInfo": { "properties": { "schemes": { "items": { "type": "string" }, "type": "array", "description": "Supported authentication schemes - e.g. Basic, Bearer, etc" }, "credentials": { "description": "Optional credentials", "type": "string" } }, "id": "A2aV1AuthenticationInfo", "type": "object", "description": "Defines authentication details, used for push notifications." }, "GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec": { "description": "Specification to determine under which conditions query expansion should occur.", "properties": { "pinUnexpandedResults": { "description": "Whether to pin unexpanded results. If this field is set to true, unexpanded products are always at the top of the search results, followed by the expanded results.", "type": "boolean" }, "condition": { "enumDescriptions": [ "Unspecified query expansion condition. In this case, server behavior defaults to Condition.DISABLED.", "Disabled query expansion. Only the exact search query is used, even if SearchResponse.total_size is zero.", "Automatic query expansion built by the Search API." ], "enum": [ "CONDITION_UNSPECIFIED", "DISABLED", "AUTO" ], "description": "The condition under which query expansion should occur. Default to Condition.DISABLED.", "type": "string" } }, "type": "object", "id": "GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec" }, "GoogleCloudDiscoveryengineV1StreamAssistResponseConnectorAuthError": { "properties": { "errorMessage": { "type": "string", "description": "Human-readable error message describing the auth failure." }, "dataConnector": { "type": "string", "description": "Resource name of the data connector that failed authentication." } }, "id": "GoogleCloudDiscoveryengineV1StreamAssistResponseConnectorAuthError", "type": "object", "description": "Describes an authentication error for a specific data connector." }, "GoogleCloudDiscoveryengineV1alphaAnswerCitationSource": { "id": "GoogleCloudDiscoveryengineV1alphaAnswerCitationSource", "description": "Citation source.", "properties": { "referenceId": { "description": "ID of the citation source.", "type": "string" } }, "type": "object" }, "GoogleCloudDiscoveryengineV1alphaReplacePatientFilterRequest": { "description": "Request for DataStoreService.ReplacePatientFilter method.", "properties": { "dataStore": { "description": "Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. If the caller does not have permission to access the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error is returned. If the requested DataStore already has a patient filter, an ALREADY_EXISTS error will be returned.", "type": "string" }, "filterGroups": { "description": "Required. Names of the Group resources to use as a basis for the list of patients for the new patient filter, in format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Group/{group_id}`. if the caller does not have permission to access the FHIR store, regardless of whether it exists, PERMISSION_DENIED error is returned. If the discovery engine service account does not have permission to access the FHIR store, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the group is not found at the location, a RESOURCE_NOT_FOUND error will be returned. The filter group must be a FHIR resource name of type Group, and the new filter will be constructed from the direct members of the group which are Patient resources.", "items": { "type": "string" }, "type": "array" } }, "id": "GoogleCloudDiscoveryengineV1alphaReplacePatientFilterRequest", "type": "object" }, "GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchRequest": { "type": "object", "description": "Request message for SiteSearchEngineService.DisableAdvancedSiteSearch method.", "properties": {}, "id": "GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchRequest" }, "GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfigDataProtectionPolicySensitiveDataProtectionPolicy": { "description": "Specifies a Sensitive Data Protection (https://cloud.google.com/sensitive-data-protection/docs/sensitive-data-protection-overview) policy.", "type": "object", "properties": { "policy": { "description": "Optional. The Sensitive Data Protection policy resource name.", "type": "string" } }, "id": "GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfigDataProtectionPolicySensitiveDataProtectionPolicy" }, "GoogleCloudDiscoveryengineV1alphaQueryPartPersonReference": { "id": "GoogleCloudDiscoveryengineV1alphaQueryPartPersonReference", "properties": { "documentName": { "type": "string", "description": "The full resource name of the person. Format: `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`." }, "destinationUri": { "type": "string", "description": "The destination uri of the person." }, "displayPhotoUri": { "type": "string", "description": "The display photo url of the person." }, "fileId": { "readOnly": true, "description": "Output only. The file id of the person data stored in the session context files.", "type": "string" }, "email": { "type": "string", "description": "The email of the person." }, "personId": { "description": "The person id of the person.", "type": "string" }, "displayName": { "type": "string", "description": "The display name of the person." } }, "type": "object", "description": "Represents a person reference." }, "GoogleCloudDiscoveryengineV1WidgetConfigImage": { "description": "Options to store an image.", "type": "object", "id": "GoogleCloudDiscoveryengineV1WidgetConfigImage", "properties": { "url": { "type": "string", "description": "Image URL." } } }, "GoogleCloudDiscoveryengineV1alphaAlphaEvolveProgramContent": { "description": "A self-contained message containing the content of a program. Can represent a collection of files.", "properties": { "description": { "type": "string", "description": "Optional. Description of the program." }, "files": { "description": "Required. A list of source files that make up the overall program.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveSourceFile" } } }, "id": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveProgramContent", "type": "object" }, "A2aV1ListTaskPushNotificationConfigResponse": { "id": "A2aV1ListTaskPushNotificationConfigResponse", "type": "object", "properties": { "configs": { "description": "The list of push notification configurations.", "type": "array", "items": { "$ref": "A2aV1TaskPushNotificationConfig" } }, "nextPageToken": { "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfoDocumentMetadata": { "properties": { "title": { "description": "Title of the document.", "type": "string" }, "uri": { "type": "string", "description": "Uri of the document." } }, "id": "GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfoDocumentMetadata", "description": "Document metadata contains the information of the document of the current chunk.", "type": "object" }, "GoogleCloudDiscoveryengineV1alphaCreateSitemapMetadata": { "description": "Metadata related to the progress of the SiteSearchEngineService.CreateSitemap operation. This will be returned by the google.longrunning.Operation.metadata field.", "properties": { "createTime": { "format": "google-datetime", "type": "string", "description": "Operation create time." }, "updateTime": { "format": "google-datetime", "type": "string", "description": "Operation last update time. If the operation is done, this is also the finish time." } }, "type": "object", "id": "GoogleCloudDiscoveryengineV1alphaCreateSitemapMetadata" }, "GoogleCloudDiscoveryengineV1alphaControlFilterAction": { "description": "Specified which products may be included in results. Uses same filter as boost.", "properties": { "dataStore": { "description": "Required. Specifies which data store's documents can be filtered by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store", "type": "string" }, "filter": { "description": "Required. A filter to apply on the matching condition results. Required Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown.", "type": "string" } }, "id": "GoogleCloudDiscoveryengineV1alphaControlFilterAction", "type": "object" }, "GoogleCloudDiscoveryengineV1alphaDeleteTargetSiteMetadata": { "type": "object", "id": "GoogleCloudDiscoveryengineV1alphaDeleteTargetSiteMetadata", "properties": { "createTime": { "type": "string", "description": "Operation create time.", "format": "google-datetime" }, "updateTime": { "description": "Operation last update time. If the operation is done, this is also the finish time.", "format": "google-datetime", "type": "string" } }, "description": "Metadata related to the progress of the SiteSearchEngineService.DeleteTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field." }, "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig": { "description": "Configuration for chunking config.", "type": "object", "properties": { "layoutBasedChunkingConfig": { "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", "description": "Configuration for the layout based chunking." } }, "id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig" }, "GoogleCloudDiscoveryengineV1alphaEngineKnowledgeGraphConfig": { "type": "object", "properties": { "privateKnowledgeGraphTypes": { "items": { "type": "string" }, "description": "Specify entity types to support.", "type": "array" }, "enableCloudKnowledgeGraph": { "description": "Whether to enable the Cloud Knowledge Graph for the engine. Defaults to false if not specified.", "type": "boolean" }, "featureConfig": { "description": "Optional. Feature config for the Knowledge Graph.", "$ref": "GoogleCloudDiscoveryengineV1alphaEngineKnowledgeGraphConfigFeatureConfig" }, "enablePrivateKnowledgeGraph": { "description": "Whether to enable the Private Knowledge Graph for the engine. Defaults to false if not specified.", "type": "boolean" }, "cloudKnowledgeGraphTypes": { "type": "array", "items": { "type": "string" }, "description": "Specify entity types to support." } }, "description": "Configuration message for the Knowledge Graph.", "id": "GoogleCloudDiscoveryengineV1alphaEngineKnowledgeGraphConfig" }, "GoogleCloudDiscoveryengineV1FhirStoreSource": { "type": "object", "description": "Cloud FhirStore source import data from.", "properties": { "fhirStore": { "description": "Required. The full resource name of the FHIR store to import data from, in the format of `projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}`.", "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 FhirStore export to a specific Cloud Storage directory.", "type": "string" }, "resourceTypes": { "items": { "type": "string" }, "type": "array", "description": "The FHIR resource types to import. The resource types should be a subset of all [supported FHIR resource types](https://cloud.google.com/generative-ai-app-builder/docs/fhir-schema-reference#resource-level-specification). Default to all supported FHIR resource types if empty." }, "updateFromLatestPredefinedSchema": { "description": "Optional. Whether to update the DataStore schema to the latest predefined schema. If true, the DataStore schema will be updated to include any FHIR fields or resource types that have been added since the last import and corresponding FHIR resources will be imported from the FHIR store. Note this field cannot be used in conjunction with `resource_types`. It should be used after initial import.", "type": "boolean" } }, "id": "GoogleCloudDiscoveryengineV1FhirStoreSource" }, "GoogleCloudDiscoveryengineV1SearchRequestBoostSpec": { "id": "GoogleCloudDiscoveryengineV1SearchRequestBoostSpec", "type": "object", "properties": { "conditionBoostSpecs": { "type": "array", "description": "Condition boost specifications. If a document matches multiple conditions in the specifications, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20.", "items": { "$ref": "GoogleCloudDiscoveryengineV1SearchRequestBoostSpecConditionBoostSpec" } } }, "description": "Boost specification to boost certain documents." }, "GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfigAlloyDbConfigAlloyDbConnectionConfig": { "id": "GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfigAlloyDbConfigAlloyDbConnectionConfig", "type": "object", "description": "Configuration for connecting to AlloyDB.", "properties": { "enablePsvs": { "description": "Optional. If true, enable PSVS for AlloyDB.", "type": "boolean" }, "authMode": { "enum": [ "AUTH_MODE_UNSPECIFIED", "AUTH_MODE_SERVICE_ACCOUNT", "AUTH_MODE_END_USER_ACCOUNT" ], "type": "string", "enumDescriptions": [ "", "Uses P4SA when VAIS talks to AlloyDB.", "Uses EUC when VAIS talks to AlloyDB." ], "description": "Optional. Auth mode." }, "instance": { "type": "string", "description": "Required. The AlloyDB instance to connect to." }, "database": { "description": "Required. The AlloyDB database to connect to.", "type": "string" }, "password": { "description": "Required. Database password. If auth_mode = END_USER_ACCOUNT, it can be unset. In that case, the password will be inferred on the AlloyDB side, based on the authenticated user.", "type": "string" }, "user": { "description": "Required. Database user. If auth_mode = END_USER_ACCOUNT, it can be unset. In that case, the user will be inferred on the AlloyDB side, based on the authenticated user.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1alphaAssistAnswerReply": { "properties": { "groundedContent": { "$ref": "GoogleCloudDiscoveryengineV1alphaAssistantGroundedContent", "description": "Possibly grounded response text or media from the assistant." }, "createTime": { "type": "string", "description": "The time when the reply was created.", "format": "google-datetime" }, "replyId": { "readOnly": true, "type": "string", "description": "Output only. When set, uniquely identifies a reply within the `AssistAnswer` resource. During an AssistantService.StreamAssist call, multiple `Reply` messages with the same ID can occur within the response stream (across multiple StreamAssistResponse messages). These represent parts of a single `Reply` message in the final `AssistAnswer` resource." } }, "id": "GoogleCloudDiscoveryengineV1alphaAssistAnswerReply", "description": "One part of the multi-part response of the assist call.", "type": "object" }, "GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentConfigRunSettings": { "id": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentConfigRunSettings", "type": "object", "properties": { "maxDuration": { "format": "google-duration", "description": "Optional. Maximum duration of the experiment. If unset, defaults to 24 hours.", "type": "string" }, "concurrency": { "description": "Required. Maximum number of programs that can be generated in parallel. Must be positive.", "format": "int32", "type": "integer" }, "maxPrograms": { "description": "Required. Maximum number of programs to generate during the experiment run. The initial program counts towards this limit. Must be greater than 1.", "format": "int32", "type": "integer" } }, "description": "Run settings for the experiment." }, "GoogleCloudDiscoveryengineV1alphaRemovePatientFilterRequest": { "type": "object", "description": "Request for DataStoreService.RemovePatientFilter method.", "properties": { "filterGroups": { "items": { "type": "string" }, "description": "Required. Names of the Group resources to use as a basis for the list of patients to remove from the patient filter, in format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Group/{group_id}`. if the caller does not have permission to access the FHIR store, regardless of whether it exists, PERMISSION_DENIED error is returned. If the discovery engine service account does not have permission to access the FHIR store, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the group is not found at the location, a RESOURCE_NOT_FOUND error will be returned. The filter group must be a FHIR resource name of type Group, and the list of IDs to remove will be constructed from the direct members of the group which are Patient resources.", "type": "array" }, "dataStore": { "description": "Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. If the caller does not have permission to access the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error is returned. If the requested DataStore does not have a patient filter, a NOT_FOUND error will be returned", "type": "string" } }, "id": "GoogleCloudDiscoveryengineV1alphaRemovePatientFilterRequest" }, "A2aV1TaskStatusUpdateEvent": { "properties": { "status": { "$ref": "A2aV1TaskStatus", "description": "The new status of the task." }, "contextId": { "type": "string", "description": "The id of the context that the task belongs to" }, "taskId": { "description": "The id of the task that is changed", "type": "string" }, "metadata": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "type": "object", "description": "Optional metadata to associate with the task update." }, "final": { "type": "boolean", "description": "Whether this is the last status update expected for this task." } }, "type": "object", "id": "A2aV1TaskStatusUpdateEvent", "description": "TaskStatusUpdateEvent is a delta even on a task indicating that a task has changed." }, "GoogleCloudDiscoveryengineV1LicenseConfigUsageStats": { "description": "Stats about users' licenses.", "properties": { "licenseConfig": { "description": "Required. The LicenseConfig name.", "type": "string" }, "usedLicenseCount": { "format": "int64", "type": "string", "description": "Required. The number of licenses used." } }, "type": "object", "id": "GoogleCloudDiscoveryengineV1LicenseConfigUsageStats" }, "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeResponse": { "type": "object", "id": "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeResponse", "description": "Response of the EstimateDataSize request. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.", "properties": { "dataSizeBytes": { "description": "Data size in terms of bytes.", "type": "string", "format": "int64" }, "documentCount": { "description": "Total number of documents.", "type": "string", "format": "int64" } } }, "GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRunProgress": { "id": "GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRunProgress", "properties": { "percentile": { "description": "Derived. The percentile of the progress.current_count / total_count. The value is between [0, 1.0] inclusive.", "type": "number", "format": "float" }, "currentCount": { "type": "string", "description": "The current progress.", "format": "int64" }, "totalCount": { "type": "string", "description": "The total.", "format": "int64" } }, "description": "Represents the progress of a sync run.", "type": "object" }, "GoogleCloudDiscoveryengineV1AssistAnswer": { "description": "AssistAnswer resource, main part of AssistResponse.", "properties": { "state": { "enum": [ "STATE_UNSPECIFIED", "IN_PROGRESS", "FAILED", "SUCCEEDED", "SKIPPED", "CANCELLED" ], "type": "string", "description": "State of the answer generation.", "enumDescriptions": [ "Unknown.", "Assist operation is currently in progress.", "Assist operation has failed.", "Assist operation has succeeded.", "Assist operation has been skipped.", "Assist operation has been cancelled (e.g. client closed the stream). May contain a partial response." ] }, "name": { "description": "Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters.", "type": "string" }, "customerPolicyEnforcementResult": { "$ref": "GoogleCloudDiscoveryengineV1AssistAnswerCustomerPolicyEnforcementResult", "description": "Optional. The field contains information about the various policy checks' results like the banned phrases or the Model Armor checks. This field is populated only if the assist call was skipped due to a policy violation." }, "assistSkippedReasons": { "type": "array", "description": "Reasons for not answering the assist call.", "items": { "enumDescriptions": [ "Default value. Skip reason is not specified.", "The assistant ignored the query, because it did not appear to be answer-seeking.", "The assistant ignored the query or refused to answer because of a customer policy violation (e.g., the query or the answer contained a banned phrase)." ], "type": "string", "enum": [ "ASSIST_SKIPPED_REASON_UNSPECIFIED", "NON_ASSIST_SEEKING_QUERY_IGNORED", "CUSTOMER_POLICY_VIOLATION" ] } }, "replies": { "description": "Replies of the assistant.", "items": { "$ref": "GoogleCloudDiscoveryengineV1AssistAnswerReply" }, "type": "array" } }, "id": "GoogleCloudDiscoveryengineV1AssistAnswer", "type": "object" }, "GoogleCloudDiscoveryengineV1StreamAssistRequestToolsSpecVideoGenerationSpec": { "description": "Specification of the video generation tool.", "id": "GoogleCloudDiscoveryengineV1StreamAssistRequestToolsSpecVideoGenerationSpec", "type": "object", "properties": {} }, "GoogleCloudDiscoveryengineV1ProvisionProjectRequest": { "type": "object", "id": "GoogleCloudDiscoveryengineV1ProvisionProjectRequest", "description": "Request for ProjectService.ProvisionProject method.", "properties": { "saasParams": { "$ref": "GoogleCloudDiscoveryengineV1ProvisionProjectRequestSaasParams", "description": "Optional. Parameters for Agentspace." }, "acceptDataUseTerms": { "type": "boolean", "description": "Required. Set to `true` to specify that caller has read and would like to give consent to the [Terms for data use](https://cloud.google.com/retail/data-use-terms)." }, "dataUseTermsVersion": { "type": "string", "description": "Required. The version of the [Terms for data use](https://cloud.google.com/retail/data-use-terms) that caller has read and would like to give consent to. Acceptable version is `2022-11-23`, and this may change over time." } } }, "GoogleCloudDiscoveryengineV1betaQualityMetrics": { "properties": { "docRecall": { "$ref": "GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics", "description": "Recall per document, at various top-k cutoff levels. Recall is the fraction of relevant documents retrieved out of all relevant documents. Example (top-5): * For a single SampleQuery, If 3 out of 5 relevant documents are retrieved in the top-5, recall@5 = 3/5 = 0.6" }, "pageNdcg": { "description": "Normalized discounted cumulative gain (NDCG) per page, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved pages (P1, P2, P3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [P3 (0), P1 (1), P2 (1)] Ideal: [P1 (1), P2 (1), P3 (0)] Calculate NDCG@3 for SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693", "$ref": "GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics" }, "docPrecision": { "$ref": "GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics", "description": "Precision per document, at various top-k cutoff levels. Precision is the fraction of retrieved documents that are relevant. Example (top-5): * For a single SampleQuery, If 4 out of 5 retrieved documents in the top-5 are relevant, precision@5 = 4/5 = 0.8" }, "pageRecall": { "description": "Recall per page, at various top-k cutoff levels. Recall is the fraction of relevant pages retrieved out of all relevant pages. Example (top-5): * For a single SampleQuery, if 3 out of 5 relevant pages are retrieved in the top-5, recall@5 = 3/5 = 0.6", "$ref": "GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics" }, "docNdcg": { "description": "Normalized discounted cumulative gain (NDCG) per document, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved documents (D1, D2, D3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [D3 (0), D1 (1), D2 (1)] Ideal: [D1 (1), D2 (1), D3 (0)] Calculate NDCG@3 for each SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693", "$ref": "GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics" } }, "description": "Describes the metrics produced by the evaluation.", "type": "object", "id": "GoogleCloudDiscoveryengineV1betaQualityMetrics" }, "GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpec": { "description": "Relevance filtering specification.", "properties": { "semanticSearchThreshold": { "description": "Optional. Relevance filtering threshold specification for semantic search.", "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec" }, "keywordSearchThreshold": { "description": "Optional. Relevance filtering threshold specification for keyword search.", "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec" } }, "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpec", "type": "object" }, "GoogleCloudDiscoveryengineLoggingErrorLog": { "description": "An error log which is reported to the Error Reporting system.", "properties": { "connectorRunPayload": { "description": "The error payload that is populated on LRO connector sync APIs.", "$ref": "GoogleCloudDiscoveryengineLoggingConnectorRunErrorContext" }, "status": { "$ref": "GoogleRpcStatus", "description": "The RPC status associated with the error log." }, "serviceContext": { "description": "The service context in which this error has occurred.", "$ref": "GoogleCloudDiscoveryengineLoggingServiceContext" }, "requestPayload": { "additionalProperties": { "description": "Properties of the object.", "type": "any" }, "type": "object", "description": "The API request payload, represented as a protocol buffer. Most API request types are supported—for example: * `type.googleapis.com/google.cloud.discoveryengine.v1alpha.DocumentService.CreateDocumentRequest` * `type.googleapis.com/google.cloud.discoveryengine.v1alpha.UserEventService.WriteUserEventRequest`" }, "importPayload": { "description": "The error payload that is populated on LRO import APIs.", "$ref": "GoogleCloudDiscoveryengineLoggingImportErrorContext" }, "message": { "type": "string", "description": "A message describing the error." }, "responsePayload": { "type": "object", "description": "The API response payload, represented as a protocol buffer. This is used to log some \"soft errors\", where the response is valid but we consider there are some quality issues like unjoined events. The following API responses are supported, and no PII is included: * `google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend` * `google.cloud.discoveryengine.v1alpha.UserEventService.WriteUserEvent` * `google.cloud.discoveryengine.v1alpha.UserEventService.CollectUserEvent`", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "context": { "description": "A description of the context in which the error occurred.", "$ref": "GoogleCloudDiscoveryengineLoggingErrorContext" } }, "type": "object", "id": "GoogleCloudDiscoveryengineLoggingErrorLog" }, "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics": { "properties": { "top3": { "format": "double", "description": "The top-3 value.", "type": "number" }, "top10": { "format": "double", "description": "The top-10 value.", "type": "number" }, "top5": { "description": "The top-5 value.", "format": "double", "type": "number" }, "top1": { "description": "The top-1 value.", "type": "number", "format": "double" } }, "description": "Stores the metric values at specific top-k levels.", "type": "object", "id": "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics" }, "GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics": { "type": "object", "id": "GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics", "properties": { "top1": { "description": "The top-1 value.", "format": "double", "type": "number" }, "top5": { "format": "double", "description": "The top-5 value.", "type": "number" }, "top3": { "description": "The top-3 value.", "type": "number", "format": "double" }, "top10": { "type": "number", "description": "The top-10 value.", "format": "double" } }, "description": "Stores the metric values at specific top-k levels." }, "GoogleCloudDiscoveryengineV1SearchRequest": { "description": "Request message for SearchService.Search method.", "properties": { "pageSize": { "description": "Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned.", "type": "integer", "format": "int32" }, "oneBoxPageSize": { "description": "The maximum number of results to return for OneBox. This applies to each OneBox type individually. Default number is 10.", "format": "int32", "type": "integer" }, "filter": { "type": "string", "description": "The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customer might have a field 'name' in their schema. In this case the filter would look like this: filter --\u003e name:'ANY(\"king kong\")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)" }, "query": { "type": "string", "description": "Raw search query." }, "entity": { "type": "string", "description": "Optional. The entity for customers that may run multiple different entities, domains, sites or regions, for example, \"Google US\", \"Google Ads\", \"Waymo\", \"google.com\", \"youtube.com\", etc. If this is set, it should be exactly matched with UserEvent.entity to get search results boosted by entity." }, "facetSpecs": { "description": "Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.", "items": { "$ref": "GoogleCloudDiscoveryengineV1SearchRequestFacetSpec" }, "type": "array" }, "naturalLanguageQueryUnderstandingSpec": { "description": "Optional. Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done.", "$ref": "GoogleCloudDiscoveryengineV1SearchRequestNaturalLanguageQueryUnderstandingSpec" }, "displaySpec": { "$ref": "GoogleCloudDiscoveryengineV1SearchRequestDisplaySpec", "description": "Optional. Config for display feature, like match highlighting on search results." }, "searchAsYouTypeSpec": { "description": "Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical.", "$ref": "GoogleCloudDiscoveryengineV1SearchRequestSearchAsYouTypeSpec" }, "crowdingSpecs": { "type": "array", "description": "Optional. Crowding specifications for improving result diversity. If multiple CrowdingSpecs are specified, crowding will be evaluated on each unique combination of the `field` values, and max_count will be the maximum value of `max_count` across all CrowdingSpecs. For example, if the first CrowdingSpec has `field` = \"color\" and `max_count` = 3, and the second CrowdingSpec has `field` = \"size\" and `max_count` = 2, then after 3 documents that share the same color AND size have been returned, subsequent ones should be removed or demoted.", "items": { "$ref": "GoogleCloudDiscoveryengineV1SearchRequestCrowdingSpec" } }, "queryExpansionSpec": { "description": "The query expansion specification that specifies the conditions under which query expansion occurs.", "$ref": "GoogleCloudDiscoveryengineV1SearchRequestQueryExpansionSpec" }, "dataStoreSpecs": { "items": { "$ref": "GoogleCloudDiscoveryengineV1SearchRequestDataStoreSpec" }, "type": "array", "description": "Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used." }, "relevanceThreshold": { "type": "string", "enum": [ "RELEVANCE_THRESHOLD_UNSPECIFIED", "LOWEST", "LOW", "MEDIUM", "HIGH" ], "description": "The global relevance threshold of the search results. Defaults to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. If more granular relevance filtering is required, use the `relevance_filter_spec` instead. This feature is not supported for healthcare search.", "enumDescriptions": [ "Default value. In this case, server behavior defaults to Google defined threshold.", "Lowest relevance threshold.", "Low relevance threshold.", "Medium relevance threshold.", "High relevance threshold." ] }, "orderBy": { "description": "The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.", "type": "string" }, "spellCorrectionSpec": { "$ref": "GoogleCloudDiscoveryengineV1SearchRequestSpellCorrectionSpec", "description": "The spell correction specification that specifies the mode under which spell correction takes effect." }, "canonicalFilter": { "type": "string", "description": "The default filter that is applied when a user performs a search without checking any filters on the search page. The filter applied to every search request when quality improvement such as query expansion is needed. In the case a query does not have a sufficient amount of results this filter will be used to determine whether or not to enable the query expansion flow. The original filter will still be used for the query expanded search. This field is strongly recommended to achieve high search quality. For more information about filter syntax, see SearchRequest.filter." }, "sessionSpec": { "$ref": "GoogleCloudDiscoveryengineV1SearchRequestSessionSpec", "description": "Session specification. Can be used only when `session` is set." }, "imageQuery": { "$ref": "GoogleCloudDiscoveryengineV1SearchRequestImageQuery", "description": "Raw image query." }, "safeSearch": { "type": "boolean", "description": "Whether to turn on safe search. This is only supported for website search." }, "branch": { "type": "string", "description": "The branch resource name, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`. Use `default_branch` as the branch ID or leave this field empty, to search documents under the default branch." }, "userInfo": { "description": "Information about the end user. Highly recommended for analytics and personalization. UserInfo.user_agent is used to deduce `device_type` for analytics.", "$ref": "GoogleCloudDiscoveryengineV1UserInfo" }, "pageCategories": { "type": "array", "items": { "type": "string" }, "description": "Optional. The categories associated with a category page. Must be set for category navigation queries to achieve good search quality. The format should be the same as PageInfo.page_category. This field is the equivalent of the query for browse (navigation) queries. It's used by the browse model when the query is empty. If the field is empty, it will not be used by the browse model. If the field contains more than one element, only the first element will be used. To represent full path of a category, use '\u003e' character to separate different hierarchies. If '\u003e' is part of the category name, replace it with other character(s). For example, `Graphics Cards \u003e RTX\u003e4090 \u003e Founders Edition` where \"RTX \u003e 4090\" represents one level, can be rewritten as `Graphics Cards \u003e RTX_4090 \u003e Founders Edition`" }, "session": { "description": "The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is \"How did Alphabet do in 2022?\" and the current query is \"How about 2023?\", the current query will be interpreted as \"How did Alphabet do in 2023?\". Example #2 (coordination between /search API calls and /answer API calls): Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call.", "type": "string" }, "contentSearchSpec": { "description": "A specification for configuring the behavior of content search.", "$ref": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpec" }, "searchAddonSpec": { "description": "Optional. SearchAddonSpec is used to disable add-ons for search as per new repricing model. This field is only supported for search requests.", "$ref": "GoogleCloudDiscoveryengineV1SearchRequestSearchAddonSpec" }, "relevanceScoreSpec": { "$ref": "GoogleCloudDiscoveryengineV1SearchRequestRelevanceScoreSpec", "description": "Optional. The specification for returning the relevance score." }, "offset": { "description": "A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. A large offset may be capped to a reasonable threshold.", "type": "integer", "format": "int32" }, "params": { "additionalProperties": { "type": "any" }, "description": "Additional search parameters. For public website search only, supported values are: * `user_country_code`: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided. For example, `user_country_code: \"au\"` For available codes see [Country Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) * `search_type`: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching. For example, `search_type: 1`", "type": "object" }, "boostSpec": { "description": "Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)", "$ref": "GoogleCloudDiscoveryengineV1SearchRequestBoostSpec" }, "rankingExpression": { "type": "string", "description": "Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by \"+\". * ranking_expression = function, { \" + \", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double \u003e 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result * `media_actor_match`: whether the media actor matches the query * `media_director_match`: whether the media director matches the query * `media_genre_match`: whether the media genre matches the query * `media_language_match`: whether the media language matches the query * `media_title_match`: whether the media title matches the query * `media_prefix_similarity_rank`: prefix similarity rank for media results * `media_semantic_similarity_rank`: semantic similarity rank for media results" }, "userPseudoId": { "type": "string", "description": "Optional. 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`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned." }, "languageCode": { "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate.", "type": "string" }, "userLabels": { "type": "object", "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.", "additionalProperties": { "type": "string" } }, "relevanceFilterSpec": { "$ref": "GoogleCloudDiscoveryengineV1SearchRequestRelevanceFilterSpec", "description": "Optional. The granular relevance filtering specification. If not specified, the global `relevance_threshold` will be used for all sub-searches. If specified, this overrides the global `relevance_threshold` to use thresholds on a per sub-search basis. This feature is currently supported only for custom and site search." }, "customRankingParams": { "description": "Optional. Optional configuration for the Custom Ranking feature.", "$ref": "GoogleCloudDiscoveryengineV1SearchRequestCustomRankingParams" }, "rankingExpressionBackend": { "type": "string", "enumDescriptions": [ "Default option for unspecified/unknown values.", "Deprecated: Use `RANK_BY_EMBEDDING` instead. Ranking by custom embedding model, the default way to evaluate the ranking expression. Legacy enum option, `RANK_BY_EMBEDDING` should be used instead.", "Deprecated: Use `RANK_BY_FORMULA` instead. Ranking by custom formula. Legacy enum option, `RANK_BY_FORMULA` should be used instead.", "Ranking by custom embedding model, the default way to evaluate the ranking expression.", "Ranking by custom formula." ], "enumDeprecated": [ false, true, true, false, false ], "enum": [ "RANKING_EXPRESSION_BACKEND_UNSPECIFIED", "BYOE", "CLEARBOX", "RANK_BY_EMBEDDING", "RANK_BY_FORMULA" ], "description": "Optional. The backend to use for the ranking expression evaluation." }, "pageToken": { "description": "A page token received from a previous SearchService.Search call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SearchService.Search must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.", "type": "string" }, "numResultsPerDataStore": { "type": "integer", "format": "int32", "description": "Optional. The maximum number of results to retrieve from each data store. If not specified, it will use the SearchRequest.DataStoreSpec.num_results if provided, otherwise there is no limit." } }, "type": "object", "id": "GoogleCloudDiscoveryengineV1SearchRequest" }, "GoogleCloudDiscoveryengineV1betaDeleteTargetSiteMetadata": { "type": "object", "id": "GoogleCloudDiscoveryengineV1betaDeleteTargetSiteMetadata", "description": "Metadata related to the progress of the SiteSearchEngineService.DeleteTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", "properties": { "createTime": { "description": "Operation create time.", "format": "google-datetime", "type": "string" }, "updateTime": { "description": "Operation last update time. If the operation is done, this is also the finish time.", "format": "google-datetime", "type": "string" } } }, "GoogleCloudDiscoveryengineV1SpannerSource": { "type": "object", "description": "The Spanner source for importing data", "properties": { "enableDataBoost": { "type": "boolean", "description": "Whether to apply data boost on Spanner export. Enabling this option will incur additional cost. More info can be found [here](https://cloud.google.com/spanner/docs/databoost/databoost-overview#billing_and_quotas)." }, "projectId": { "description": "The project ID that contains the Spanner source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request.", "type": "string" }, "databaseId": { "type": "string", "description": "Required. The database ID of the source Spanner table." }, "tableId": { "type": "string", "description": "Required. The table name of the Spanner database that needs to be imported." }, "instanceId": { "description": "Required. The instance ID of the source Spanner table.", "type": "string" } }, "id": "GoogleCloudDiscoveryengineV1SpannerSource" }, "GoogleCloudDiscoveryengineV1betaAclConfig": { "description": "Access Control Configuration.", "type": "object", "properties": { "name": { "type": "string", "description": "Immutable. The full resource name of the acl configuration. Format: `projects/{project}/locations/{location}/aclConfig`. This field must be a UTF-8 encoded string with a length limit of 1024 characters." }, "idpConfig": { "description": "Identity provider config.", "$ref": "GoogleCloudDiscoveryengineV1betaIdpConfig" } }, "id": "GoogleCloudDiscoveryengineV1betaAclConfig" }, "GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveSegment": { "properties": { "content": { "type": "string", "description": "Extractive segment content." }, "pageIdentifier": { "description": "Page identifier.", "type": "string" } }, "type": "object", "description": "Extractive segment. [Guide](https://cloud.google.com/generative-ai-app-builder/docs/snippets#extractive-segments) Answer generation will only use it if document_contexts is empty. This is supposed to be shorter snippets.", "id": "GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveSegment" }, "GoogleCloudDiscoveryengineV1AssistantContentExecutableCode": { "description": "Code generated by the model that is meant to be executed by the model.", "properties": { "code": { "type": "string", "description": "Required. The code content. Currently only supports Python." } }, "type": "object", "id": "GoogleCloudDiscoveryengineV1AssistantContentExecutableCode" }, "GoogleCloudDiscoveryengineV1alphaDedicatedCrawlRateTimeSeries": { "id": "GoogleCloudDiscoveryengineV1alphaDedicatedCrawlRateTimeSeries", "description": "The historical dedicated crawl rate timeseries data, used for monitoring. Dedicated crawl is used by Vertex AI to crawl the user's website when dedicate crawl is set.", "type": "object", "properties": { "userTriggeredCrawlErrorRate": { "description": "Vertex AI's error rate time series of user triggered dedicated crawl.", "$ref": "GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries" }, "autoRefreshCrawlRate": { "description": "Vertex AI's dedicated crawl rate time series of auto-refresh, which is the crawl rate of Google-CloudVertexBot when dedicate crawl is set, and the crawl rate is for best effort use cases like refreshing urls periodically.", "$ref": "GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries" }, "autoRefreshCrawlErrorRate": { "$ref": "GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries", "description": "Vertex AI's error rate time series of auto-refresh dedicated crawl." }, "userTriggeredCrawlRate": { "$ref": "GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries", "description": "Vertex AI's dedicated crawl rate time series of user triggered crawl, which is the crawl rate of Google-CloudVertexBot when dedicate crawl is set, and user triggered crawl rate is for deterministic use cases like crawling urls or sitemaps specified by users." } } }, "GoogleCloudDiscoveryengineV1AgentGatewaySetting": { "description": "Agent Gateway setting, which may be attached to Gemini Enterprise resources for egress control of Gemini Enterprise agents to agents and tools outside of Gemini Enterprise.", "type": "object", "properties": { "defaultEgressAgentGateway": { "$ref": "GoogleCloudDiscoveryengineV1AgentGatewaySettingAgentGatewayReference", "description": "Optional. The default egress agent gateway to use, when this setting is applied to a Gemini Enterprise resource. The deployment mode must be GOOGLE_MANAGED, and the governed access path must be AGENT_TO_ANYWHERE." } }, "id": "GoogleCloudDiscoveryengineV1AgentGatewaySetting" }, "GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigMostPopularFeatureConfig": { "id": "GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigMostPopularFeatureConfig", "description": "Feature configurations that are required for creating a Most Popular engine.", "properties": { "timeWindowDays": { "type": "string", "format": "int64", "description": "The time window of which the engine is queried at training and prediction time. Positive integers only. The value translates to the last X days of events. Currently required for the `most-popular-items` engine." } }, "type": "object" }, "GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpec": { "properties": { "disableSpellCorrection": { "type": "boolean", "description": "Optional. Whether to disable spell correction. The default value is `false`." }, "queryClassificationSpec": { "description": "Query classification specification.", "$ref": "GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpecQueryClassificationSpec" }, "queryRephraserSpec": { "description": "Query rephraser specification.", "$ref": "GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpec" } }, "id": "GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpec", "description": "Query understanding specification.", "type": "object" }, "GoogleCloudDiscoveryengineV1IdentityMappingEntryOperationMetadata": { "description": "IdentityMappingEntry LongRunningOperation metadata for IdentityMappingStoreService.ImportIdentityMappings and IdentityMappingStoreService.PurgeIdentityMappings", "type": "object", "properties": { "successCount": { "description": "The number of IdentityMappingEntries that were successfully processed.", "type": "string", "format": "int64" }, "failureCount": { "description": "The number of IdentityMappingEntries that failed to be processed.", "type": "string", "format": "int64" }, "totalCount": { "format": "int64", "description": "The total number of IdentityMappingEntries that were processed.", "type": "string" } }, "id": "GoogleCloudDiscoveryengineV1IdentityMappingEntryOperationMetadata" }, "GoogleCloudDiscoveryengineV1SearchResponseSearchResultRankSignalsCustomSignal": { "type": "object", "properties": { "name": { "description": "Optional. Name of the signal.", "type": "string" }, "value": { "format": "float", "description": "Optional. Float value representing the ranking signal (e.g. 1.25 for BM25).", "type": "number" } }, "description": "Custom clearbox signal represented by name and value pair.", "id": "GoogleCloudDiscoveryengineV1SearchResponseSearchResultRankSignalsCustomSignal" }, "GoogleCloudDiscoveryengineV1ConverseConversationResponse": { "type": "object", "id": "GoogleCloudDiscoveryengineV1ConverseConversationResponse", "description": "Response message for ConversationalSearchService.ConverseConversation method.", "properties": { "reply": { "description": "Answer to the current query.", "$ref": "GoogleCloudDiscoveryengineV1Reply" }, "conversation": { "description": "Updated conversation including the answer.", "$ref": "GoogleCloudDiscoveryengineV1Conversation" }, "searchResults": { "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1SearchResponseSearchResult" }, "description": "Search Results." } } }, "GoogleCloudDiscoveryengineV1ConverseConversationRequest": { "id": "GoogleCloudDiscoveryengineV1ConverseConversationRequest", "properties": { "summarySpec": { "$ref": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpec", "description": "A specification for configuring the summary returned in the response." }, "userLabels": { "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.", "additionalProperties": { "type": "string" }, "type": "object" }, "query": { "description": "Required. Current user input.", "$ref": "GoogleCloudDiscoveryengineV1TextInput" }, "safeSearch": { "description": "Whether to turn on safe search.", "type": "boolean" }, "servingConfig": { "description": "The resource name of the Serving Config to use. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/servingConfigs/{serving_config_id}` If this is not set, the default serving config will be used.", "type": "string" }, "conversation": { "$ref": "GoogleCloudDiscoveryengineV1Conversation", "description": "The conversation to be used by auto session only. The name field will be ignored as we automatically assign new name for the conversation in auto session." }, "boostSpec": { "description": "Boost specification to boost certain documents in search results which may affect the converse response. For more information on boosting, see [Boosting](https://cloud.google.com/retail/docs/boosting#boost)", "$ref": "GoogleCloudDiscoveryengineV1SearchRequestBoostSpec" }, "filter": { "description": "The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. This will be used to filter search results which may affect the summary response. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customer might have a field 'name' in their schema. In this case the filter would look like this: filter --\u003e name:'ANY(\"king kong\")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)", "type": "string" } }, "description": "Request message for ConversationalSearchService.ConverseConversation method.", "type": "object" }, "GoogleCloudDiscoveryengineV1alphaSitemap": { "properties": { "uri": { "type": "string", "description": "Public URI for the sitemap, e.g. `www.example.com/sitemap.xml`." }, "createTime": { "format": "google-datetime", "description": "Output only. The sitemap's creation time.", "readOnly": true, "type": "string" }, "name": { "type": "string", "description": "Output only. The fully qualified resource name of the sitemap. `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine/sitemaps/*` The `sitemap_id` suffix is system-generated.", "readOnly": true } }, "id": "GoogleCloudDiscoveryengineV1alphaSitemap", "description": "A sitemap for the SiteSearchEngine.", "type": "object" }, "GoogleCloudDiscoveryengineV1ProvisionProjectRequestSaasParams": { "type": "object", "id": "GoogleCloudDiscoveryengineV1ProvisionProjectRequestSaasParams", "properties": { "acceptBizQos": { "description": "Optional. Set to `true` to specify that caller has read and would like to give consent to the [Terms for Agent Space quality of service].", "type": "boolean" }, "isBiz": { "description": "Optional. Indicates if the current request is for Biz edition (= true) or not (= false).", "type": "boolean" } }, "description": "Parameters for Agentspace." }, "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequestBoostSpec": { "properties": { "conditionBoostSpecs": { "description": "Condition boost specifications. If a suggestion matches multiple conditions in the specifications, boost values from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20. Note: Currently only support language condition boost.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequestBoostSpecConditionBoostSpec" } } }, "id": "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequestBoostSpec", "description": "Specification to boost suggestions based on the condition of the suggestion.", "type": "object" }, "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig": { "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", "description": "Configuration for the layout based chunking.", "type": "object", "properties": { "chunkSize": { "type": "integer", "description": "The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500.", "format": "int32" }, "includeAncestorHeadings": { "type": "boolean", "description": "Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False." } } }, "GoogleCloudDiscoveryengineV1alphaImportDocumentsResponse": { "type": "object", "properties": { "errorSamples": { "description": "A sample of errors encountered while processing the request.", "items": { "$ref": "GoogleRpcStatus" }, "type": "array" }, "errorConfig": { "$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", "description": "Echoes the destination for the complete errors in the request if set." } }, "id": "GoogleCloudDiscoveryengineV1alphaImportDocumentsResponse", "description": "Response of the ImportDocumentsRequest. If the long running operation is done, then this message is returned by the google.longrunning.Operations.response field if the operation was successful." }, "GoogleCloudDiscoveryengineV1alphaDataStoreFederatedSearchConfigAlloyDbConfigAlloyDbConnectionConfig": { "id": "GoogleCloudDiscoveryengineV1alphaDataStoreFederatedSearchConfigAlloyDbConfigAlloyDbConnectionConfig", "description": "Configuration for connecting to AlloyDB.", "properties": { "password": { "type": "string", "description": "Required. Database password. If auth_mode = END_USER_ACCOUNT, it can be unset. In that case, the password will be inferred on the AlloyDB side, based on the authenticated user." }, "database": { "description": "Required. The AlloyDB database to connect to.", "type": "string" }, "user": { "description": "Required. Database user. If auth_mode = END_USER_ACCOUNT, it can be unset. In that case, the user will be inferred on the AlloyDB side, based on the authenticated user.", "type": "string" }, "instance": { "description": "Required. The AlloyDB instance to connect to.", "type": "string" }, "authMode": { "enum": [ "AUTH_MODE_UNSPECIFIED", "AUTH_MODE_SERVICE_ACCOUNT", "AUTH_MODE_END_USER_ACCOUNT" ], "description": "Optional. Auth mode.", "type": "string", "enumDescriptions": [ "", "Uses P4SA when VAIS talks to AlloyDB.", "Uses EUC when VAIS talks to AlloyDB." ] }, "enablePsvs": { "type": "boolean", "description": "Optional. If true, enable PSVS for AlloyDB." } }, "type": "object" }, "GoogleApiDistribution": { "properties": { "bucketOptions": { "$ref": "GoogleApiDistributionBucketOptions", "description": "Defines the histogram bucket boundaries. If the distribution does not contain a histogram, then omit this field." }, "range": { "description": "If specified, contains the range of the population values. The field must not be present if the `count` is zero.", "$ref": "GoogleApiDistributionRange" }, "mean": { "description": "The arithmetic mean of the values in the population. If `count` is zero then this field must be zero.", "format": "double", "type": "number" }, "exemplars": { "items": { "$ref": "GoogleApiDistributionExemplar" }, "description": "Must be in increasing order of `value` field.", "type": "array" }, "sumOfSquaredDeviation": { "description": "The sum of squared deviations from the mean of the values in the population. For values x_i this is: Sum[i=1..n]((x_i - mean)^2) Knuth, \"The Art of Computer Programming\", Vol. 2, page 232, 3rd edition describes Welford's method for accumulating this sum in one pass. If `count` is zero then this field must be zero.", "format": "double", "type": "number" }, "count": { "description": "The number of values in the population. Must be non-negative. This value must equal the sum of the values in `bucket_counts` if a histogram is provided.", "format": "int64", "type": "string" }, "bucketCounts": { "description": "The number of values in each bucket of the histogram, as described in `bucket_options`. If the distribution does not have a histogram, then omit this field. If there is a histogram, then the sum of the values in `bucket_counts` must equal the value in the `count` field of the distribution. If present, `bucket_counts` should contain N values, where N is the number of buckets specified in `bucket_options`. If you supply fewer than N values, the remaining values are assumed to be 0. The order of the values in `bucket_counts` follows the bucket numbering schemes described for the three bucket types. The first value must be the count for the underflow bucket (number 0). The next N-2 values are the counts for the finite buckets (number 1 through N-2). The N'th value in `bucket_counts` is the count for the overflow bucket (number N-1).", "items": { "format": "int64", "type": "string" }, "type": "array" } }, "id": "GoogleApiDistribution", "type": "object", "description": "`Distribution` contains summary statistics for a population of values. It optionally contains a histogram representing the distribution of those values across a set of buckets. The summary statistics are the count, mean, sum of the squared deviation from the mean, the minimum, and the maximum of the set of population of values. The histogram is based on a sequence of buckets and gives a count of values that fall into each bucket. The boundaries of the buckets are given either explicitly or by formulas for buckets of fixed or exponentially increasing widths. Although it is not forbidden, it is generally a bad idea to include non-finite values (infinities or NaNs) in the population of values, as this will render the `mean` and `sum_of_squared_deviation` fields meaningless." }, "GoogleCloudDiscoveryengineV1DistributeLicenseConfigResponse": { "type": "object", "id": "GoogleCloudDiscoveryengineV1DistributeLicenseConfigResponse", "properties": { "licenseConfig": { "$ref": "GoogleCloudDiscoveryengineV1LicenseConfig", "description": "The updated or created LicenseConfig." } }, "description": "Response message for LicenseConfigService.DistributeLicenseConfig method." }, "GoogleCloudDiscoveryengineV1ListAssistantsResponse": { "properties": { "assistants": { "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1Assistant" }, "description": "All the customer's Assistants." }, "nextPageToken": { "description": "A token that can be sent as ListAssistantsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" } }, "description": "Response message for the AssistantService.ListAssistants method.", "type": "object", "id": "GoogleCloudDiscoveryengineV1ListAssistantsResponse" }, "GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesRequestInlineSource": { "description": "The inline source for SuggestionDenyListEntry.", "id": "GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesRequestInlineSource", "properties": { "entries": { "description": "Required. A list of all denylist entries to import. Max of 1000 items.", "items": { "$ref": "GoogleCloudDiscoveryengineV1SuggestionDenyListEntry" }, "type": "array" } }, "type": "object" }, "GoogleCloudDiscoveryengineV1alphaAssistantContentFile": { "id": "GoogleCloudDiscoveryengineV1alphaAssistantContentFile", "description": "A file, e.g., an audio summary.", "type": "object", "properties": { "fileId": { "description": "Required. The file ID.", "type": "string" }, "mimeType": { "description": "Required. The media type (MIME type) of the file.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesResponse": { "id": "GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesResponse", "properties": { "purgeCount": { "description": "Number of suggestion deny list entries purged.", "format": "int64", "type": "string" }, "errorSamples": { "description": "A sample of errors encountered while processing the request.", "items": { "$ref": "GoogleRpcStatus" }, "type": "array" } }, "type": "object", "description": "Response message for CompletionService.PurgeSuggestionDenyListEntries method." }, "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec": { "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec", "description": "A specification for configuring the extractive content in a search response.", "properties": { "returnExtractiveSegmentScore": { "description": "Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`.", "type": "boolean" }, "numNextSegments": { "type": "integer", "format": "int32", "description": "Return at most `num_next_segments` segments after each selected segments." }, "maxExtractiveAnswerCount": { "type": "integer", "description": "The maximum number of extractive answers returned in each search result. An extractive answer is a verbatim answer extracted from the original document, which provides a precise and contextually relevant answer to the search query. If the number of matching answers is less than the `max_extractive_answer_count`, return all of the answers. Otherwise, return the `max_extractive_answer_count`. At most five answers are returned for each SearchResult.", "format": "int32" }, "maxExtractiveSegmentCount": { "format": "int32", "type": "integer", "description": "The max number of extractive segments returned in each search result. Only applied if the DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED or DataStore.solution_types is SOLUTION_TYPE_CHAT. An extractive segment is a text segment extracted from the original document that is relevant to the search query, and, in general, more verbose than an extractive answer. The segment could then be used as input for LLMs to generate summaries and answers. If the number of matching segments is less than `max_extractive_segment_count`, return all of the segments. Otherwise, return the `max_extractive_segment_count`." }, "numPreviousSegments": { "description": "Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments.", "format": "int32", "type": "integer" } }, "type": "object" }, "GoogleCloudDiscoveryengineV1AnswerStepActionObservation": { "properties": { "searchResults": { "description": "Search results observed by the search action, it can be snippets info or chunk info, depending on the citation type set by the user.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResult" } } }, "description": "Observation.", "id": "GoogleCloudDiscoveryengineV1AnswerStepActionObservation", "type": "object" }, "GoogleCloudDiscoveryengineV1MediaInfo": { "description": "Media-specific user event information.", "id": "GoogleCloudDiscoveryengineV1MediaInfo", "properties": { "mediaProgressDuration": { "type": "string", "format": "google-duration", "description": "The media progress time in seconds, if applicable. For example, if the end user has finished 90 seconds of a playback video, then MediaInfo.media_progress_duration.seconds should be set to 90." }, "mediaProgressPercentage": { "type": "number", "description": "Media progress should be computed using only the media_progress_duration relative to the media total length. This value must be between `[0, 1.0]` inclusive. If this is not a playback or the progress cannot be computed (e.g. ongoing livestream), this field should be unset.", "format": "float" } }, "type": "object" }, "GoogleCloudDiscoveryengineV1alphaImportDocumentsMetadata": { "type": "object", "description": "Metadata related to the progress of the ImportDocuments operation. This is returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1alphaImportDocumentsMetadata", "properties": { "totalCount": { "type": "string", "description": "Total count of entries that were processed.", "format": "int64" }, "failureCount": { "type": "string", "description": "Count of entries that encountered errors while processing.", "format": "int64" }, "createTime": { "type": "string", "description": "Operation create time.", "format": "google-datetime" }, "successCount": { "description": "Count of entries that were processed successfully.", "format": "int64", "type": "string" }, "updateTime": { "format": "google-datetime", "type": "string", "description": "Operation last update time. If the operation is done, this is also the finish time." } } }, "GoogleCloudDiscoveryengineV1AnswerQueryRequest": { "description": "Request message for ConversationalSearchService.AnswerQuery method.", "id": "GoogleCloudDiscoveryengineV1AnswerQueryRequest", "type": "object", "properties": { "relatedQuestionsSpec": { "$ref": "GoogleCloudDiscoveryengineV1AnswerQueryRequestRelatedQuestionsSpec", "description": "Related questions specification." }, "session": { "type": "string", "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." }, "groundingSpec": { "$ref": "GoogleCloudDiscoveryengineV1AnswerQueryRequestGroundingSpec", "description": "Optional. Grounding specification." }, "endUserSpec": { "$ref": "GoogleCloudDiscoveryengineV1AnswerQueryRequestEndUserSpec", "description": "Optional. End user specification." }, "asynchronousMode": { "deprecated": true, "description": "Deprecated: This field is deprecated. Streaming Answer API will be supported. Asynchronous mode control. If enabled, the response will be returned with answer/session resource name without final answer. The API users need to do the polling to get the latest status of answer/session by calling ConversationalSearchService.GetAnswer or ConversationalSearchService.GetSession method.", "type": "boolean" }, "safetySpec": { "description": "Model specification.", "$ref": "GoogleCloudDiscoveryengineV1AnswerQueryRequestSafetySpec" }, "answerGenerationSpec": { "description": "Answer generation specification.", "$ref": "GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpec" }, "userLabels": { "type": "object", "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." }, "queryUnderstandingSpec": { "$ref": "GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpec", "description": "Query understanding specification." }, "query": { "description": "Required. Current user query.", "$ref": "GoogleCloudDiscoveryengineV1Query" }, "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" }, "searchSpec": { "description": "Search specification.", "$ref": "GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpec" } } }, "GoogleCloudDiscoveryengineV1alphaAnswerStepAction": { "type": "object", "id": "GoogleCloudDiscoveryengineV1alphaAnswerStepAction", "description": "Action.", "properties": { "searchAction": { "description": "Search action.", "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionSearchAction" }, "observation": { "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservation", "description": "Observation." } } }, "GoogleCloudDiscoveryengineV1betaUserLicense": { "properties": { "updateTime": { "description": "Output only. User update timestamp.", "type": "string", "format": "google-datetime", "readOnly": true }, "userPrincipal": { "type": "string", "description": "Required. Immutable. The user principal of the User, could be email address or other prinical identifier. This field is immutable. Admin assign licenses based on the user principal." }, "lastLoginTime": { "description": "Output only. User last logged in time. If the user has not logged in yet, this field will be empty.", "type": "string", "format": "google-datetime", "readOnly": true }, "createTime": { "format": "google-datetime", "readOnly": true, "description": "Output only. User created timestamp.", "type": "string" }, "licenseAssignmentState": { "readOnly": true, "enumDescriptions": [ "Default value.", "License assigned to the user.", "No license assigned to the user. Deprecated, translated to NO_LICENSE.", "No license assigned to the user.", "User attempted to login but no license assigned to the user. This state is only used for no user first time login attempt but cannot get license assigned. Users already logged in but cannot get license assigned will be assigned NO_LICENSE state(License could be unassigned by admin).", "User is blocked from assigning a license." ], "enum": [ "LICENSE_ASSIGNMENT_STATE_UNSPECIFIED", "ASSIGNED", "UNASSIGNED", "NO_LICENSE", "NO_LICENSE_ATTEMPTED_LOGIN", "BLOCKED" ], "description": "Output only. License assignment state of the user. If the user is assigned with a license config, the user login will be assigned with the license; If the user's license assignment state is unassigned or unspecified, no license config will be associated to the user;", "type": "string" }, "userProfile": { "description": "Optional. The user profile. We user user full name(First name + Last name) as user profile.", "type": "string" }, "licenseConfig": { "description": "Optional. The full resource name of the Subscription(LicenseConfig) assigned to the user.", "type": "string" } }, "description": "User License information assigned by the admin.", "type": "object", "id": "GoogleCloudDiscoveryengineV1betaUserLicense" }, "GoogleCloudDiscoveryengineV1betaOrganicCrawlRateTimeSeries": { "properties": { "googleOrganicCrawlRate": { "description": "Google's organic crawl rate time series, which is the sum of all googlebots' crawl rate. Please refer to https://developers.google.com/search/docs/crawling-indexing/overview-google-crawlers for more details about googlebots.", "$ref": "GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries" }, "vertexAiOrganicCrawlRate": { "description": "Vertex AI's organic crawl rate time series, which is the crawl rate of Google-CloudVertexBot when dedicate crawl is not set. Please refer to https://developers.google.com/search/docs/crawling-indexing/google-common-crawlers#google-cloudvertexbot for more details about Google-CloudVertexBot.", "$ref": "GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries" } }, "id": "GoogleCloudDiscoveryengineV1betaOrganicCrawlRateTimeSeries", "type": "object", "description": "The historical organic crawl rate timeseries data, used for monitoring. Organic crawl is auto-determined by Google to crawl the user's website when dedicate crawl is not set. Crawl rate is the QPS of crawl request Google sends to the user's website." }, "GoogleCloudDiscoveryengineV1alphaProject": { "id": "GoogleCloudDiscoveryengineV1alphaProject", "description": "Metadata and configurations for a Google Cloud project in the service.", "properties": { "serviceTermsMap": { "readOnly": true, "additionalProperties": { "$ref": "GoogleCloudDiscoveryengineV1alphaProjectServiceTerms" }, "type": "object", "description": "Output only. A map of terms of services. The key is the `id` of ServiceTerms." }, "createTime": { "format": "google-datetime", "type": "string", "readOnly": true, "description": "Output only. The timestamp when this project is created." }, "name": { "readOnly": true, "type": "string", "description": "Output only. Full resource name of the project, for example `projects/{project}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number." }, "configurableBillingStatus": { "readOnly": true, "$ref": "GoogleCloudDiscoveryengineV1alphaProjectConfigurableBillingStatus", "description": "Output only. The current status of the project's configurable billing." }, "customerProvidedConfig": { "description": "Optional. Customer provided configurations.", "$ref": "GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfig" }, "provisionCompletionTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The timestamp when this project is successfully provisioned. Empty value means this project is still provisioning and is not ready for use." } }, "type": "object" }, "GoogleCloudDiscoveryengineV1DataStoreFederatedSearchConfigAlloyDbConfigAlloyDbConnectionConfig": { "id": "GoogleCloudDiscoveryengineV1DataStoreFederatedSearchConfigAlloyDbConfigAlloyDbConnectionConfig", "type": "object", "description": "Configuration for connecting to AlloyDB.", "properties": { "instance": { "description": "Required. The AlloyDB instance to connect to.", "type": "string" }, "enablePsvs": { "type": "boolean", "description": "Optional. If true, enable PSVS for AlloyDB." }, "authMode": { "enumDescriptions": [ "", "Uses P4SA when VAIS talks to AlloyDB.", "Uses EUC when VAIS talks to AlloyDB." ], "description": "Optional. Auth mode.", "type": "string", "enum": [ "AUTH_MODE_UNSPECIFIED", "AUTH_MODE_SERVICE_ACCOUNT", "AUTH_MODE_END_USER_ACCOUNT" ] }, "password": { "description": "Required. Database password. If auth_mode = END_USER_ACCOUNT, it can be unset. In that case, the password will be inferred on the AlloyDB side, based on the authenticated user.", "type": "string" }, "database": { "type": "string", "description": "Required. The AlloyDB database to connect to." }, "user": { "description": "Required. Database user. If auth_mode = END_USER_ACCOUNT, it can be unset. In that case, the user will be inferred on the AlloyDB side, based on the authenticated user.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1SearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterOrExpression": { "id": "GoogleCloudDiscoveryengineV1SearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterOrExpression", "description": "Logical `Or` operator.", "type": "object", "properties": { "expressions": { "type": "array", "description": "The expressions that were ORed together.", "items": { "$ref": "GoogleCloudDiscoveryengineV1SearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterExpression" } } } }, "GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfig": { "id": "GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfig", "properties": { "notebooklmConfig": { "description": "Optional. Configuration for NotebookLM settings.", "$ref": "GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfig" } }, "type": "object", "description": "Customer provided configurations." }, "GoogleCloudDiscoveryengineV1AlloyDbSource": { "id": "GoogleCloudDiscoveryengineV1AlloyDbSource", "properties": { "locationId": { "description": "Required. The AlloyDB location to copy the data from with a length limit of 256 characters.", "type": "string" }, "gcsStagingDir": { "type": "string", "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." }, "projectId": { "type": "string", "description": "The project ID that contains the AlloyDB source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request." }, "tableId": { "type": "string", "description": "Required. The AlloyDB table to copy the data from with a length limit of 256 characters." }, "databaseId": { "type": "string", "description": "Required. The AlloyDB database to copy the data from with a length limit of 256 characters." }, "clusterId": { "description": "Required. The AlloyDB cluster to copy the data from with a length limit of 256 characters.", "type": "string" } }, "type": "object", "description": "AlloyDB source import data from." }, "GoogleCloudDiscoveryengineV1alphaNaturalLanguageQueryUnderstandingConfig": { "type": "object", "properties": { "mode": { "type": "string", "enumDescriptions": [ "Default value.", "Natural Language Query Understanding is disabled.", "Natural Language Query Understanding is enabled." ], "enum": [ "MODE_UNSPECIFIED", "DISABLED", "ENABLED" ], "description": "Mode of Natural Language Query Understanding. If this field is unset, the behavior defaults to NaturalLanguageQueryUnderstandingConfig.Mode.DISABLED." } }, "id": "GoogleCloudDiscoveryengineV1alphaNaturalLanguageQueryUnderstandingConfig", "description": "Configuration for Natural Language Query Understanding." }, "GoogleCloudDiscoveryengineV1SearchInfo": { "type": "object", "description": "Detailed search information.", "id": "GoogleCloudDiscoveryengineV1SearchInfo", "properties": { "offset": { "type": "integer", "description": "An integer that specifies the current offset for pagination (the 0-indexed starting location, amongst the products deemed by the API as relevant). See SearchRequest.offset for definition. If this field is negative, an `INVALID_ARGUMENT` is returned. This can only be set for `search` events. Other event types should not set this field. Otherwise, an `INVALID_ARGUMENT` error is returned.", "format": "int32" }, "searchQuery": { "description": "The user's search query. See SearchRequest.query for definition. The value must be a UTF-8 encoded string with a length limit of 5,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. At least one of search_query or PageInfo.page_category is required for `search` events. Other event types should not set this field. Otherwise, an `INVALID_ARGUMENT` error is returned.", "type": "string" }, "orderBy": { "type": "string", "description": "The order in which products are returned, if applicable. See SearchRequest.order_by for definition and syntax. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This can only be set for `search` events. Other event types should not set this field. Otherwise, an `INVALID_ARGUMENT` error is returned." } } }, "GoogleCloudDiscoveryengineV1alphaAgentGatewaySetting": { "description": "Agent Gateway setting, which may be attached to Gemini Enterprise resources for egress control of Gemini Enterprise agents to agents and tools outside of Gemini Enterprise.", "properties": { "defaultEgressAgentGateway": { "description": "Optional. The default egress agent gateway to use, when this setting is applied to a Gemini Enterprise resource. The deployment mode must be GOOGLE_MANAGED, and the governed access path must be AGENT_TO_ANYWHERE.", "$ref": "GoogleCloudDiscoveryengineV1alphaAgentGatewaySettingAgentGatewayReference" } }, "id": "GoogleCloudDiscoveryengineV1alphaAgentGatewaySetting", "type": "object" }, "A2aV1ImplicitOAuthFlow": { "properties": { "scopes": { "additionalProperties": { "type": "string" }, "description": "The available scopes for the OAuth2 security scheme. A map between the scope name and a short description for it. The map MAY be empty.", "type": "object" }, "refreshUrl": { "description": "The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS.", "type": "string" }, "authorizationUrl": { "type": "string", "description": "The authorization URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS" } }, "id": "A2aV1ImplicitOAuthFlow", "type": "object" }, "GoogleCloudDiscoveryengineV1DataProtectionPolicy": { "id": "GoogleCloudDiscoveryengineV1DataProtectionPolicy", "type": "object", "description": "Contains the data protection policy config for a DataStore or a connector.", "properties": { "sensitiveDataProtectionPolicy": { "$ref": "GoogleCloudDiscoveryengineV1DataProtectionPolicySensitiveDataProtectionPolicy", "description": "Optional. Specifies the sensitive data protection policy for the connector source." } } }, "GoogleCloudDiscoveryengineV1DataConnectorSourceEntity": { "description": "Represents an entity in the data source. For example, the `Account` object in Salesforce.", "properties": { "healthcareFhirConfig": { "$ref": "GoogleCloudDiscoveryengineV1HealthcareFhirConfig", "description": "Optional. Configuration for `HEALTHCARE_FHIR` vertical." }, "keyPropertyMappings": { "description": "Attributes for indexing. Key: Field name. Value: The key property to map a field to, such as `title`, and `description`. Supported key properties: * `title`: The title for data record. This would be displayed on search results. * `description`: The description for data record. This would be displayed on search results.", "type": "object", "additionalProperties": { "type": "string" } }, "jsonParams": { "type": "string", "description": "The parameters for the entity to facilitate data ingestion in json string format." }, "entityName": { "description": "The name of the entity. Supported values by data source: * Salesforce: `Lead`, `Opportunity`, `Contact`, `Account`, `Case`, `Contract`, `Campaign` * Jira: `Issue` * Confluence: `Content`, `Space`", "type": "string" }, "params": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "description": "The parameters for the entity to facilitate data ingestion in structured json format.", "type": "object" }, "startingSchema": { "$ref": "GoogleCloudDiscoveryengineV1Schema", "description": "Optional. The start schema to use for the DataStore created from this SourceEntity. If unset, a default vertical specialized schema will be used. This field is only used by SetUpDataConnector API, and will be ignored if used in other APIs. This field will be omitted from all API responses including GetDataConnector API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema)." }, "dataStore": { "readOnly": true, "type": "string", "description": "Output only. The full resource name of the associated data store for the source entity. Format: `projects/*/locations/*/collections/*/dataStores/*`. When the connector is initialized by the DataConnectorService.SetUpDataConnector method, a DataStore is automatically created for each source entity." } }, "type": "object", "id": "GoogleCloudDiscoveryengineV1DataConnectorSourceEntity" }, "A2aV1StreamResponse": { "type": "object", "properties": { "task": { "$ref": "A2aV1Task" }, "statusUpdate": { "$ref": "A2aV1TaskStatusUpdateEvent" }, "artifactUpdate": { "$ref": "A2aV1TaskArtifactUpdateEvent" }, "message": { "$ref": "A2aV1Message" } }, "id": "A2aV1StreamResponse", "description": "The stream response for a message. The stream should be one of the following sequences: If the response is a message, the stream should contain one, and only one, message and then close If the response is a task lifecycle, the first response should be a Task object followed by zero or more TaskStatusUpdateEvents and TaskArtifactUpdateEvents. The stream should complete when the Task if in an interrupted or terminal state. A stream that ends before these conditions are met are" }, "GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfo": { "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfo", "properties": { "queryClassificationInfo": { "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfoQueryClassificationInfo" }, "description": "Query classification information.", "type": "array" } }, "description": "Query understanding information.", "type": "object" }, "GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceScoreSpec": { "properties": { "returnRelevanceScore": { "type": "boolean", "description": "Optional. Whether to return the relevance score for search results. The higher the score, the more relevant the document is to the query." } }, "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceScoreSpec", "description": "The specification for returning the document relevance score.", "type": "object" }, "GoogleCloudDiscoveryengineV1EngineKnowledgeGraphConfigFeatureConfig": { "description": "Feature config for the Knowledge Graph.", "type": "object", "id": "GoogleCloudDiscoveryengineV1EngineKnowledgeGraphConfigFeatureConfig", "properties": { "disablePrivateKgAutoComplete": { "description": "Whether to disable the private KG auto complete for the engine. Defaults to false if not specified.", "type": "boolean" }, "disablePrivateKgQueryUnderstanding": { "type": "boolean", "description": "Whether to disable the private KG query understanding for the engine. Defaults to false if not specified." }, "disablePrivateKgEnrichment": { "description": "Whether to disable the private KG enrichment for the engine. Defaults to false if not specified.", "type": "boolean" }, "disablePrivateKgQueryUiChips": { "description": "Whether to disable the private KG for query UI chips. Defaults to false if not specified.", "type": "boolean" } } }, "GoogleCloudDiscoveryengineV1TrainCustomModelRequest": { "type": "object", "id": "GoogleCloudDiscoveryengineV1TrainCustomModelRequest", "description": "Request message for SearchTuningService.TrainCustomModel method.", "properties": { "errorConfig": { "description": "The desired location of errors incurred during the data ingestion and training.", "$ref": "GoogleCloudDiscoveryengineV1ImportErrorConfig" }, "modelId": { "type": "string", "description": "If not provided, a UUID will be generated." }, "modelType": { "description": "Model to be trained. Supported values are: * **search-tuning**: Fine tuning the search system based on data provided.", "type": "string" }, "gcsTrainingInput": { "$ref": "GoogleCloudDiscoveryengineV1TrainCustomModelRequestGcsTrainingInput", "description": "Cloud Storage training input." } } }, "GoogleCloudDiscoveryengineV1betaDataProtectionPolicySensitiveDataProtectionPolicy": { "type": "object", "properties": { "policy": { "description": "Optional. Specifies the resource name of the Sensitive Data Protection content policy.", "type": "string" } }, "id": "GoogleCloudDiscoveryengineV1betaDataProtectionPolicySensitiveDataProtectionPolicy", "description": "Specifies a Sensitive Data Protection (https://cloud.google.com/sensitive-data-protection/docs/sensitive-data-protection-overview) policy." }, "GoogleCloudDiscoveryengineV1betaImportUserEventsMetadata": { "id": "GoogleCloudDiscoveryengineV1betaImportUserEventsMetadata", "type": "object", "description": "Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field.", "properties": { "createTime": { "description": "Operation create time.", "format": "google-datetime", "type": "string" }, "updateTime": { "readOnly": true, "description": "Output only. Operation last update time. If the operation is done, this is also the finish time.", "type": "string", "format": "google-datetime" }, "failureCount": { "description": "Count of entries that encountered errors while processing.", "type": "string", "format": "int64" }, "successCount": { "format": "int64", "type": "string", "description": "Count of entries that were processed successfully." } } }, "GoogleCloudDiscoveryengineV1alphaAssistantContent": { "id": "GoogleCloudDiscoveryengineV1alphaAssistantContent", "description": "Multi-modal content.", "properties": { "file": { "$ref": "GoogleCloudDiscoveryengineV1alphaAssistantContentFile", "description": "A file, e.g., an audio summary." }, "executableCode": { "description": "Code generated by the model that is meant to be executed.", "$ref": "GoogleCloudDiscoveryengineV1alphaAssistantContentExecutableCode" }, "codeExecutionResult": { "description": "Result of executing an ExecutableCode.", "$ref": "GoogleCloudDiscoveryengineV1alphaAssistantContentCodeExecutionResult" }, "inlineData": { "$ref": "GoogleCloudDiscoveryengineV1alphaAssistantContentBlob", "description": "Inline binary data." }, "text": { "type": "string", "description": "Inline text." }, "role": { "description": "The producer of the content. Can be \"model\" or \"user\".", "type": "string" }, "thought": { "description": "Optional. Indicates if the part is thought from the model.", "type": "boolean" } }, "type": "object" }, "GoogleCloudDiscoveryengineV1betaBatchCreateTargetSitesResponse": { "description": "Response message for SiteSearchEngineService.BatchCreateTargetSites method.", "type": "object", "id": "GoogleCloudDiscoveryengineV1betaBatchCreateTargetSitesResponse", "properties": { "targetSites": { "description": "TargetSites created.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1betaTargetSite" } } } }, "GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultList": { "properties": { "searchResults": { "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResult" }, "description": "Search results." } }, "id": "GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultList", "type": "object", "description": "Search result list." }, "GoogleCloudDiscoveryengineV1alphaDeleteCmekConfigMetadata": { "id": "GoogleCloudDiscoveryengineV1alphaDeleteCmekConfigMetadata", "properties": { "updateTime": { "type": "string", "format": "google-datetime", "description": "Operation last update time. If the operation is done, this is also the finish time." }, "createTime": { "type": "string", "format": "google-datetime", "description": "Operation create time." } }, "description": "Metadata related to the progress of the CmekConfigService.DeleteCmekConfig operation. This will be returned by the google.longrunning.Operation.metadata field.", "type": "object" }, "GoogleCloudDiscoveryengineV1betaImportIdentityMappingsResponse": { "type": "object", "properties": { "errorSamples": { "type": "array", "items": { "$ref": "GoogleRpcStatus" }, "description": "A sample of errors encountered while processing the request." } }, "description": "Response message for IdentityMappingStoreService.ImportIdentityMappings", "id": "GoogleCloudDiscoveryengineV1betaImportIdentityMappingsResponse" }, "GoogleTypeDate": { "id": "GoogleTypeDate", "type": "object", "properties": { "day": { "description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.", "type": "integer", "format": "int32" }, "month": { "type": "integer", "format": "int32", "description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day." }, "year": { "format": "int32", "description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.", "type": "integer" } }, "description": "Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp" }, "GoogleCloudDiscoveryengineV1betaDataStoreServingConfigDataStore": { "type": "object", "description": "Stores information regarding the serving configurations at DataStore level.", "properties": { "disabledForServing": { "description": "Optional. If set true, the DataStore will not be available for serving search requests.", "type": "boolean" } }, "id": "GoogleCloudDiscoveryengineV1betaDataStoreServingConfigDataStore" }, "GoogleCloudDiscoveryengineV1DataConnectorEndUserConfig": { "id": "GoogleCloudDiscoveryengineV1DataConnectorEndUserConfig", "description": "Any params and credentials used specifically for EUA connectors.", "type": "object", "properties": { "jsonAuthParams": { "description": "Optional. Any authentication parameters specific to EUA connectors in json string format.", "type": "string" }, "authParams": { "additionalProperties": { "description": "Properties of the object.", "type": "any" }, "description": "Optional. Any authentication parameters specific to EUA connectors.", "type": "object" }, "tenant": { "$ref": "GoogleCloudDiscoveryengineV1Tenant", "description": "Optional. The tenant project the connector is connected to." }, "additionalParams": { "description": "Optional. Any additional parameters needed for EUA.", "additionalProperties": { "description": "Properties of the object.", "type": "any" }, "type": "object" } } }, "GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpec": { "type": "object", "properties": { "ignoreJailBreakingQuery": { "type": "boolean", "description": "Optional. Specifies whether to filter out jail-breaking queries. The default value is `false`. Google employs search-query classification to detect jail-breaking queries. No summary is returned if the search query is classified as a jail-breaking query. A user might add instructions to the query to change the tone, style, language, content of the answer, or ask the model to act as a different entity, e.g. \"Reply in the tone of a competing company's CEO\". If this field is set to `true`, we skip generating summaries for jail-breaking queries and return fallback messages instead." }, "ignoreAdversarialQuery": { "description": "Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No answer is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating answers for adversarial queries and return fallback messages instead.", "type": "boolean" }, "ignoreNonAnswerSeekingQuery": { "type": "boolean", "description": "Specifies whether to filter out queries that are not answer-seeking. The default value is `false`. Google employs search-query classification to detect answer-seeking queries. No answer is returned if the search query is classified as a non-answer seeking query. If this field is set to `true`, we skip generating answers for non-answer seeking queries and return fallback messages instead." }, "answerLanguageCode": { "type": "string", "description": "Language code for Answer. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is an experimental feature." }, "modelSpec": { "description": "Answer generation model specification.", "$ref": "GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpecModelSpec" }, "includeCitations": { "description": "Specifies whether to include citation metadata in the answer. The default value is `false`.", "type": "boolean" }, "ignoreLowRelevantContent": { "description": "Specifies whether to filter out queries that have low relevance. If this field is set to `false`, all search results are used regardless of relevance to generate answers. If set to `true` or unset, the behavior will be determined automatically by the service.", "type": "boolean" }, "promptSpec": { "description": "Answer generation prompt specification.", "$ref": "GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpecPromptSpec" } }, "description": "Answer generation specification.", "id": "GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpec" }, "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig": { "properties": { "useNativeText": { "type": "boolean", "description": "If true, will use native text instead of OCR text on pages containing native text." }, "enhancedDocumentElements": { "deprecated": true, "type": "array", "items": { "type": "string" }, "description": "[DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`." } }, "description": "The OCR parsing configurations for documents.", "type": "object", "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig" }, "GoogleCloudDiscoveryengineV1betaDataProtectionPolicy": { "type": "object", "id": "GoogleCloudDiscoveryengineV1betaDataProtectionPolicy", "description": "Contains the data protection policy config for a DataStore or a connector.", "properties": { "sensitiveDataProtectionPolicy": { "$ref": "GoogleCloudDiscoveryengineV1betaDataProtectionPolicySensitiveDataProtectionPolicy", "description": "Optional. Specifies the sensitive data protection policy for the connector source." } } }, "GoogleCloudDiscoveryengineV1betaImportSampleQueriesMetadata": { "description": "Metadata related to the progress of the ImportSampleQueries operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1betaImportSampleQueriesMetadata", "properties": { "createTime": { "format": "google-datetime", "description": "ImportSampleQueries operation create time.", "type": "string" }, "updateTime": { "format": "google-datetime", "type": "string", "description": "ImportSampleQueries operation last update time. If the operation is done, this is also the finish time." }, "successCount": { "type": "string", "description": "Count of SampleQuerys successfully imported.", "format": "int64" }, "totalCount": { "format": "int64", "description": "Total count of SampleQuerys that were processed.", "type": "string" }, "failureCount": { "type": "string", "format": "int64", "description": "Count of SampleQuerys that failed to be imported." } }, "type": "object" }, "GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsMetadata": { "description": "Metadata related to the progress of the PurgeCompletionSuggestions operation. This is returned by the google.longrunning.Operation.metadata field.", "properties": { "createTime": { "type": "string", "format": "google-datetime", "description": "Operation create time." }, "updateTime": { "description": "Operation last update time. If the operation is done, this is also the finish time.", "type": "string", "format": "google-datetime" } }, "type": "object", "id": "GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsMetadata" }, "GoogleCloudDiscoveryengineV1PurgeUserEventsRequest": { "id": "GoogleCloudDiscoveryengineV1PurgeUserEventsRequest", "description": "Request message for PurgeUserEvents method.", "type": "object", "properties": { "force": { "type": "boolean", "description": "The `force` field is currently not supported. Purge user event requests will permanently delete all purgeable events. Once the development is complete: If `force` is set to false, the method will return the expected purge count without deleting any user events. This field will default to false if not included in the request." }, "filter": { "description": "Required. The filter string to specify the events to be deleted with a length limit of 5,000 characters. The eligible fields for filtering are: * `eventType`: Double quoted UserEvent.event_type string. * `eventTime`: in ISO 8601 \"zulu\" format. * `userPseudoId`: Double quoted string. Specifying this will delete all events associated with a visitor. * `userId`: Double quoted string. Specifying this will delete all events associated with a user. Note: This API only supports purging a max range of 30 days. Examples: * Deleting all events in a time range: `eventTime \u003e \"2012-04-23T18:25:43.511Z\" eventTime \u003c \"2012-04-23T18:30:43.511Z\"` * Deleting specific eventType in a time range: `eventTime \u003e \"2012-04-23T18:25:43.511Z\" eventTime \u003c \"2012-04-23T18:30:43.511Z\" eventType = \"search\"` * Deleting all events for a specific visitor in a time range: `eventTime \u003e \"2012-04-23T18:25:43.511Z\" eventTime \u003c \"2012-04-23T18:30:43.511Z\" userPseudoId = \"visitor1024\"` * Deleting the past 30 days of events inside a DataStore: `*` The filtering fields are assumed to have an implicit AND.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1SearchResponseFacet": { "type": "object", "id": "GoogleCloudDiscoveryengineV1SearchResponseFacet", "properties": { "values": { "description": "The facet values for this field.", "items": { "$ref": "GoogleCloudDiscoveryengineV1SearchResponseFacetFacetValue" }, "type": "array" }, "dynamicFacet": { "type": "boolean", "description": "Whether the facet is dynamically generated." }, "key": { "type": "string", "description": "The key for this facet. For example, `\"colors\"` or `\"price\"`. It matches SearchRequest.FacetSpec.FacetKey.key." } }, "description": "A facet result." }, "GoogleCloudDiscoveryengineV1betaSingleRegionKey": { "description": "Metadata for single-regional CMEKs.", "properties": { "kmsKey": { "description": "Required. Single-regional kms key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.", "type": "string" } }, "type": "object", "id": "GoogleCloudDiscoveryengineV1betaSingleRegionKey" }, "GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentConfig": { "type": "object", "properties": { "generationSettings": { "$ref": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentConfigGenerationSettings", "description": "Optional. Generation settings for the experiment, controlling how new program candidates are generated, including things LLM parameters and user-provided context and prompts." }, "programLanguage": { "description": "Required. Primary programming language of the code being optimized.", "type": "string" }, "evolutionSettings": { "description": "Optional. Evolution settings for the experiment.", "$ref": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentConfigEvolutionSettings" }, "problemDescription": { "type": "string", "description": "Required. Description of the problem to be solved by the experiment." }, "runSettings": { "$ref": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentConfigRunSettings", "description": "Required. Run settings for the experiment, controlling the overall behavior of the experiment run." }, "title": { "type": "string", "description": "Required. Title of the experiment." } }, "id": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentConfig", "description": "Configuration of an experiment." }, "GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo": { "properties": { "structData": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." }, "description": "Structured search data." }, "document": { "description": "Document resource name.", "type": "string" }, "uri": { "description": "Output only. The URI of the document.", "type": "string", "readOnly": true }, "title": { "description": "Output only. The title of the document.", "type": "string", "readOnly": true } }, "description": "Structured search information.", "id": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo", "type": "object" }, "GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadataReferenceDocumentMetadata": { "properties": { "uri": { "type": "string", "description": "URI for the document. It may contain a URL that redirects to the actual website." }, "pageIdentifier": { "type": "string", "description": "Page identifier." }, "title": { "description": "Title.", "type": "string" }, "language": { "enum": [ "LANGUAGE_UNSPECIFIED", "PYTHON", "SQL" ], "type": "string", "enumDescriptions": [ "", "", "" ] }, "document": { "description": "Document resource name.", "type": "string" }, "mimeType": { "description": "The mime type of the document. https://www.iana.org/assignments/media-types/media-types.xhtml.", "type": "string" }, "domain": { "description": "Domain name from the document URI. Note that the `uri` field may contain a URL that redirects to the actual website, in which case this will contain the domain name of the target site.", "type": "string" } }, "description": "Document metadata.", "id": "GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadataReferenceDocumentMetadata", "type": "object" }, "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec": { "description": "Boost specification to boost certain documents.", "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec", "properties": { "conditionBoostSpecs": { "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec" }, "description": "Condition boost specifications. If a document matches multiple conditions in the specifications, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20." } }, "type": "object" }, "GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchResponse": { "properties": {}, "id": "GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchResponse", "type": "object", "description": "Response message for SiteSearchEngineService.DisableAdvancedSiteSearch method." }, "GoogleCloudDiscoveryengineV1UserEvent": { "id": "GoogleCloudDiscoveryengineV1UserEvent", "description": "UserEvent captures all metadata information Discovery Engine API needs to know about how end users interact with your website.", "properties": { "mediaInfo": { "description": "Media-specific info.", "$ref": "GoogleCloudDiscoveryengineV1MediaInfo" }, "transactionInfo": { "$ref": "GoogleCloudDiscoveryengineV1TransactionInfo", "description": "The transaction metadata (if any) associated with this user event." }, "dataStore": { "type": "string", "description": "The DataStore resource full name, of the form `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. Optional. Only required for user events whose data store can't by determined by UserEvent.engine or UserEvent.documents. If data store is set in the parent of write/import/collect user event requests, this field can be omitted." }, "panel": { "description": "Panel metadata associated with this user event.", "$ref": "GoogleCloudDiscoveryengineV1PanelInfo" }, "entity": { "type": "string", "description": "Optional. Represents the entity for customers that may run multiple different entities, domains, sites or regions, for example, `Google US`, `Google Ads`, `Waymo`, `google.com`, `youtube.com`, etc. We recommend that you set `entity` to get better per-entity search, completion, and prediction results." }, "attributionToken": { "type": "string", "description": "Token to attribute an API response to user action(s) to trigger the event. Highly recommended for user events that are the result of RecommendationService.Recommend. This field enables accurate attribution of recommendation model performance. The value must be one of: * RecommendResponse.attribution_token for events that are the result of RecommendationService.Recommend. * SearchResponse.attribution_token for events that are the result of SearchService.Search. This token enables us to accurately attribute page view or conversion completion back to the event and the particular predict response containing this clicked/purchased product. If user clicks on product K in the recommendation results, pass RecommendResponse.attribution_token as a URL parameter to product K's page. When recording events on product K's page, log the RecommendResponse.attribution_token to this field." }, "documents": { "items": { "$ref": "GoogleCloudDiscoveryengineV1DocumentInfo" }, "description": "List of Documents associated with this user event. This field is optional except for the following event types: * `view-item` * `add-to-cart` * `purchase` * `media-play` * `media-complete` In a `search` event, this field represents the documents returned to the end user on the current page (the end user may have not finished browsing the whole page yet). When a new page is returned to the end user, after pagination/filtering/ordering even for the same query, a new `search` event with different UserEvent.documents is desired.", "type": "array" }, "directUserRequest": { "type": "boolean", "description": "Should set to true if the request is made directly from the end user, in which case the UserEvent.user_info.user_agent can be populated from the HTTP request. This flag should be set only if the API request is made directly from the end user such as a mobile app (and not if a gateway or a server is processing and pushing the user events). This should not be set when using the JavaScript tag in UserEventService.CollectUserEvent." }, "feedback": { "$ref": "GoogleCloudDiscoveryengineV1Feedback", "description": "Optional. This field is optional except for the `add-feedback` event types." }, "filter": { "description": "Optional. The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. One example is for `search` events, the associated SearchRequest may contain a filter expression in SearchRequest.filter conforming to https://google.aip.dev/160#filtering. Similarly, for `view-item-list` events that are generated from a RecommendRequest, this field may be populated directly from RecommendRequest.filter conforming to https://google.aip.dev/160#filtering. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", "type": "string" }, "promotionIds": { "items": { "type": "string" }, "type": "array", "description": "The promotion IDs if this is an event associated with promotions. Currently, this field is restricted to at most one ID." }, "completionInfo": { "$ref": "GoogleCloudDiscoveryengineV1CompletionInfo", "description": "CompletionService.CompleteQuery details related to the event. This field should be set for `search` event when autocomplete function is enabled and the user clicks a suggestion for search." }, "userPseudoId": { "description": "Required. 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 log in/out of the website. Do not set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. The field should not contain PII or user-data. We recommend to use Google Analytics [Client ID](https://developers.google.com/analytics/devguides/collection/analyticsjs/field-reference#clientId) for this field.", "type": "string" }, "attributes": { "description": "Extra user event features to include in the recommendation model. These attributes must NOT contain data that needs to be parsed or processed further, e.g. JSON or other encodings. If you provide custom attributes for ingested user events, also include them in the user events that you associate with prediction requests. Custom attribute formatting must be consistent between imported events and events provided with prediction requests. This lets the Discovery Engine API use those custom attributes when training models and serving predictions, which helps improve recommendation quality. This field needs to pass all below criteria, otherwise an `INVALID_ARGUMENT` error is returned: * The key must be a UTF-8 encoded string with a length limit of 5,000 characters. * For text attributes, at most 400 values are allowed. Empty values are not allowed. Each value must be a UTF-8 encoded string with a length limit of 256 characters. * For number attributes, at most 400 values are allowed. For product recommendations, an example of extra user information is `traffic_channel`, which is how a user arrives at the site. Users can arrive at the site by coming to the site directly, coming through Google search, or in other ways.", "additionalProperties": { "$ref": "GoogleCloudDiscoveryengineV1CustomAttribute" }, "type": "object" }, "engine": { "description": "The Engine resource name, in the form of `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. Optional. Only required for Engine produced user events. For example, user events from blended search.", "type": "string" }, "eventType": { "description": "Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home \u003e Men \u003e Jeans Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event.", "type": "string" }, "panels": { "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1PanelInfo" }, "description": "Optional. List of panels associated with this event. Used for page-level impression data." }, "userInfo": { "$ref": "GoogleCloudDiscoveryengineV1UserInfo", "description": "Information about the end user." }, "eventTime": { "format": "google-datetime", "type": "string", "description": "Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened." }, "searchInfo": { "$ref": "GoogleCloudDiscoveryengineV1SearchInfo", "description": "SearchService.Search details related to the event. This field should be set for `search` event." }, "tagIds": { "type": "array", "items": { "type": "string" }, "description": "A list of identifiers for the independent experiment groups this user event belongs to. This is used to distinguish between user events associated with different experiment setups." }, "pageInfo": { "$ref": "GoogleCloudDiscoveryengineV1PageInfo", "description": "Page metadata such as categories and other critical information for certain event types such as `view-category-page`." }, "conversionType": { "description": "Optional. Conversion type. Required if UserEvent.event_type is `conversion`. This is a customer-defined conversion name in lowercase letters or numbers separated by \"-\", such as \"watch\", \"good-visit\" etc. Do not set the field if UserEvent.event_type is not `conversion`. This mixes the custom conversion event with predefined events like `search`, `view-item` etc.", "type": "string" }, "sessionId": { "type": "string", "description": "A unique identifier for tracking a visitor session with a length limit of 128 bytes. A session is an aggregation of an end user behavior in a time span. A general guideline to populate the session_id: 1. If user has no activity for 30 min, a new session_id should be assigned. 2. The session_id should be unique across users, suggest use uuid or add UserEvent.user_pseudo_id as prefix." } }, "type": "object" }, "GoogleCloudDiscoveryengineV1betaEvaluation": { "properties": { "name": { "description": "Identifier. The full resource name of the Evaluation, in the format of `projects/{project}/locations/{location}/evaluations/{evaluation}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", "type": "string" }, "state": { "description": "Output only. The state of the evaluation.", "type": "string", "enumDescriptions": [ "The evaluation is unspecified.", "The service is preparing to run the evaluation.", "The evaluation is in progress.", "The evaluation completed successfully.", "The evaluation failed." ], "readOnly": true, "enum": [ "STATE_UNSPECIFIED", "PENDING", "RUNNING", "SUCCEEDED", "FAILED" ] }, "createTime": { "description": "Output only. Timestamp the Evaluation was created at.", "readOnly": true, "format": "google-datetime", "type": "string" }, "error": { "readOnly": true, "$ref": "GoogleRpcStatus", "description": "Output only. The error that occurred during evaluation. Only populated when the evaluation's state is FAILED." }, "endTime": { "description": "Output only. Timestamp the Evaluation was completed at.", "format": "google-datetime", "type": "string", "readOnly": true }, "errorSamples": { "type": "array", "description": "Output only. A sample of errors encountered while processing the request.", "readOnly": true, "items": { "$ref": "GoogleRpcStatus" } }, "evaluationSpec": { "description": "Required. The specification of the evaluation.", "$ref": "GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpec" }, "qualityMetrics": { "$ref": "GoogleCloudDiscoveryengineV1betaQualityMetrics", "readOnly": true, "description": "Output only. The metrics produced by the evaluation, averaged across all SampleQuerys in the SampleQuerySet. Only populated when the evaluation's state is SUCCEEDED." } }, "description": "An evaluation is a single execution (or run) of an evaluation process. It encapsulates the state of the evaluation and the resulting data.", "type": "object", "id": "GoogleCloudDiscoveryengineV1betaEvaluation" }, "GoogleCloudDiscoveryengineV1SearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterGeolocationConstraint": { "type": "object", "description": "Constraint of a geolocation field. Name of the geolocation field as defined in the schema.", "properties": { "address": { "description": "The reference address that was inferred from the input query. The proximity of the reference address to the geolocation field will be used to filter the results.", "type": "string" }, "radiusInMeters": { "description": "The radius in meters around the address. The record is returned if the location of the geolocation field is within the radius.", "type": "number", "format": "float" }, "fieldName": { "type": "string", "description": "The name of the geolocation field as defined in the schema." }, "longitude": { "description": "The longitude of the geolocation inferred from the input query.", "format": "double", "type": "number" }, "latitude": { "description": "The latitude of the geolocation inferred from the input query.", "format": "double", "type": "number" } }, "id": "GoogleCloudDiscoveryengineV1SearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterGeolocationConstraint" }, "GoogleCloudDiscoveryengineV1betaUserInfo": { "id": "GoogleCloudDiscoveryengineV1betaUserInfo", "type": "object", "properties": { "userAgent": { "type": "string", "description": "User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set." }, "preciseLocation": { "description": "Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents.", "$ref": "GoogleCloudDiscoveryengineV1betaUserInfoPreciseLocation" }, "userId": { "description": "Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded.", "type": "string" }, "timeZone": { "description": "Optional. IANA time zone, e.g. Europe/Budapest.", "type": "string" } }, "description": "Information of an end user." }, "GoogleCloudDiscoveryengineV1alphaTrainCustomModelMetadata": { "id": "GoogleCloudDiscoveryengineV1alphaTrainCustomModelMetadata", "description": "Metadata related to the progress of the TrainCustomModel operation. This is returned by the google.longrunning.Operation.metadata field.", "properties": { "updateTime": { "description": "Operation last update time. If the operation is done, this is also the finish time.", "format": "google-datetime", "type": "string" }, "createTime": { "description": "Operation create time.", "type": "string", "format": "google-datetime" } }, "type": "object" }, "GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpec": { "description": "Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above.", "properties": { "controlPoints": { "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpecControlPoint" }, "description": "Optional. The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here." }, "interpolationType": { "enumDescriptions": [ "Interpolation type is unspecified. In this case, it defaults to Linear.", "Piecewise linear interpolation will be applied." ], "type": "string", "enum": [ "INTERPOLATION_TYPE_UNSPECIFIED", "LINEAR" ], "description": "Optional. The interpolation type to be applied to connect the control points listed below." }, "fieldName": { "description": "Optional. The name of the field whose value will be used to determine the boost amount.", "type": "string" }, "attributeType": { "description": "Optional. The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value).", "type": "string", "enumDescriptions": [ "Unspecified AttributeType.", "The value of the numerical field will be used to dynamically update the boost amount. In this case, the attribute_value (the x value) of the control point will be the actual value of the numerical field for which the boost_amount is specified.", "For the freshness use case the attribute value will be the duration between the current time and the date in the datetime field specified. The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`. For example, `5D`, `3DT12H30M`, `T24H`." ], "enum": [ "ATTRIBUTE_TYPE_UNSPECIFIED", "NUMERICAL", "FRESHNESS" ] } }, "id": "GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpec", "type": "object" }, "GoogleCloudDiscoveryengineV1alphaDataConnectorRealtimeSyncConfigStreamingError": { "id": "GoogleCloudDiscoveryengineV1alphaDataConnectorRealtimeSyncConfigStreamingError", "properties": { "error": { "description": "Optional. Error details.", "$ref": "GoogleRpcStatus" }, "streamingErrorReason": { "type": "string", "description": "Optional. Streaming error.", "enum": [ "STREAMING_ERROR_REASON_UNSPECIFIED", "STREAMING_SETUP_ERROR", "STREAMING_SYNC_ERROR", "INGRESS_ENDPOINT_REQUIRED" ], "enumDescriptions": [ "Streaming error reason unspecified.", "Some error occurred while setting up resources for realtime sync.", "Some error was encountered while running realtime sync for the connector.", "Ingress endpoint is required when setting up realtime sync in private connectivity." ] } }, "type": "object", "description": "Streaming error details." }, "GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfigDataProtectionPolicySensitiveDataProtectionPolicy": { "properties": { "policy": { "description": "Optional. The Sensitive Data Protection policy resource name.", "type": "string" } }, "id": "GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfigDataProtectionPolicySensitiveDataProtectionPolicy", "type": "object", "description": "Specifies a Sensitive Data Protection (https://cloud.google.com/sensitive-data-protection/docs/sensitive-data-protection-overview) policy." }, "GoogleCloudDiscoveryengineV1ServingConfigMediaConfig": { "description": "Specifies the configurations needed for Media Discovery. Currently we support: * `demote_content_watched`: Threshold for watched content demotion. Customers can specify if using watched content demotion or use viewed detail page. Using the content watched demotion, customers need to specify the watched minutes or percentage exceeds the threshold, the content will be demoted in the recommendation result. * `promote_fresh_content`: cutoff days for fresh content promotion. Customers can specify if using content freshness promotion. If the content was published within the cutoff days, the content will be promoted in the recommendation result. Can only be set if SolutionType is SOLUTION_TYPE_RECOMMENDATION.", "id": "GoogleCloudDiscoveryengineV1ServingConfigMediaConfig", "properties": { "contentWatchedPercentageThreshold": { "type": "number", "format": "float", "description": "Specifies the content watched percentage threshold for demotion. Threshold value must be between [0, 1.0] inclusive." }, "contentFreshnessCutoffDays": { "type": "integer", "description": "Specifies the content freshness used for recommendation result. Contents will be demoted if contents were published for more than content freshness cutoff days.", "format": "int32" }, "contentWatchedSecondsThreshold": { "description": "Specifies the content watched minutes threshold for demotion.", "type": "number", "format": "float" }, "demotionEventType": { "type": "string", "description": "Specifies the event type used for demoting recommendation result. Currently supported values: * `view-item`: Item viewed. * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. If unset, watch history demotion will not be applied. Content freshness demotion will still be applied." }, "demoteContentWatchedPastDays": { "format": "int32", "type": "integer", "description": "Optional. Specifies the number of days to look back for demoting watched content. If set to zero or unset, defaults to the maximum of 365 days." } }, "type": "object" }, "GoogleCloudDiscoveryengineV1PageInfo": { "id": "GoogleCloudDiscoveryengineV1PageInfo", "type": "object", "description": "Detailed page information.", "properties": { "referrerUri": { "description": "The referrer URL of the current page. When using the client side event reporting with JavaScript pixel and Google Tag Manager, this value is filled in automatically. However, some browser privacy restrictions may cause this field to be empty.", "type": "string" }, "uri": { "description": "Complete URL (window.location.href) of the user's current page. When using the client side event reporting with JavaScript pixel and Google Tag Manager, this value is filled in automatically. Maximum length 5,000 characters.", "type": "string" }, "pageviewId": { "type": "string", "description": "A unique ID of a web page view. This should be kept the same for all user events triggered from the same pageview. For example, an item detail page view could trigger multiple events as the user is browsing the page. The `pageview_id` property should be kept the same for all these events so that they can be grouped together properly. When using the client side event reporting with JavaScript pixel and Google Tag Manager, this value is filled in automatically." }, "pageCategory": { "type": "string", "description": "The most specific category associated with a category page. To represent full path of category, use '\u003e' sign to separate different hierarchies. If '\u003e' is part of the category name, replace it with other character(s). Category pages include special pages such as sales or promotions. For instance, a special sale page may have the category hierarchy: `\"pageCategory\" : \"Sales \u003e 2017 Black Friday Deals\"`. Required for `view-category-page` events. Other event types should not set this field. Otherwise, an `INVALID_ARGUMENT` error is returned." } } }, "GoogleCloudDiscoveryengineV1ServingConfig": { "type": "object", "id": "GoogleCloudDiscoveryengineV1ServingConfig", "description": "Configures metadata that is used to generate serving time results (e.g. search results or recommendation predictions). The ServingConfig is passed in the search and predict request and generates results.", "properties": { "name": { "type": "string", "description": "Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}`" }, "promoteControlIds": { "items": { "type": "string" }, "type": "array", "description": "Condition promote specifications. Maximum number of specifications is 100." }, "redirectControlIds": { "description": "IDs of the redirect controls. Only the first triggered redirect action is applied, even if multiple apply. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.", "type": "array", "items": { "type": "string" } }, "synonymsControlIds": { "type": "array", "items": { "type": "string" }, "description": "Condition synonyms specifications. If multiple synonyms conditions match, all matching synonyms controls in the list will execute. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH." }, "onewaySynonymsControlIds": { "type": "array", "items": { "type": "string" }, "description": "Condition oneway synonyms specifications. If multiple oneway synonyms conditions match, all matching oneway synonyms controls in the list will execute. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH." }, "genericConfig": { "$ref": "GoogleCloudDiscoveryengineV1ServingConfigGenericConfig", "description": "The GenericConfig of the serving configuration." }, "updateTime": { "type": "string", "readOnly": true, "format": "google-datetime", "description": "Output only. ServingConfig updated timestamp." }, "diversityLevel": { "type": "string", "description": "How much diversity to use in recommendation model results e.g. `medium-diversity` or `high-diversity`. Currently supported values: * `no-diversity` * `low-diversity` * `medium-diversity` * `high-diversity` * `auto-diversity` If not specified, we choose default based on recommendation model type. Default value: `no-diversity`. Can only be set if SolutionType is SOLUTION_TYPE_RECOMMENDATION." }, "dissociateControlIds": { "description": "Condition do not associate specifications. If multiple do not associate conditions match, all matching do not associate controls in the list will execute. Order does not matter. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.", "items": { "type": "string" }, "type": "array" }, "answerGenerationSpec": { "$ref": "GoogleCloudDiscoveryengineV1AnswerGenerationSpec", "description": "Optional. The specification for answer generation." }, "filterControlIds": { "items": { "type": "string" }, "type": "array", "description": "Filter controls to use in serving path. All triggered filter controls will be applied. Filter controls must be in the same data store as the serving config. Maximum of 20 filter controls." }, "rankingExpression": { "description": "The ranking expression controls the customized ranking on retrieval documents. To leverage this, document embedding is required. The ranking expression setting in ServingConfig applies to all search requests served by the serving config. However, if `SearchRequest.ranking_expression` is specified, it overrides the ServingConfig ranking expression. The ranking expression is a single function or multiple functions that are joined by \"+\". * ranking_expression = function, { \" + \", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between embedding_field_path and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.", "type": "string" }, "boostControlIds": { "items": { "type": "string" }, "description": "Boost controls to use in serving path. All triggered boost controls will be applied. Boost controls must be in the same data store as the serving config. Maximum of 20 boost controls.", "type": "array" }, "modelId": { "description": "The id of the model to use at serving time. Currently only RecommendationModels are supported. Can be changed but only to a compatible model (e.g. others-you-may-like CTR to others-you-may-like CVR). Required when SolutionType is SOLUTION_TYPE_RECOMMENDATION.", "type": "string" }, "displayName": { "type": "string", "description": "Required. The human readable serving config display name. Used in Discovery UI. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned." }, "replacementControlIds": { "type": "array", "items": { "type": "string" }, "description": "Condition replacement specifications. Applied according to the order in the list. A previously replaced term can not be re-replaced. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH." }, "ignoreControlIds": { "items": { "type": "string" }, "type": "array", "description": "Condition ignore specifications. If multiple ignore conditions match, all matching ignore controls in the list will execute. Order does not matter. Maximum number of specifications is 100." }, "mediaConfig": { "$ref": "GoogleCloudDiscoveryengineV1ServingConfigMediaConfig", "description": "The MediaConfig of the serving configuration." }, "createTime": { "readOnly": true, "description": "Output only. ServingConfig created timestamp.", "format": "google-datetime", "type": "string" }, "solutionType": { "enumDescriptions": [ "Default value.", "Used for Recommendations AI.", "Used for Discovery Search.", "Used for use cases related to the Generative AI agent.", "Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution.", "Used for AI Mode." ], "enum": [ "SOLUTION_TYPE_UNSPECIFIED", "SOLUTION_TYPE_RECOMMENDATION", "SOLUTION_TYPE_SEARCH", "SOLUTION_TYPE_CHAT", "SOLUTION_TYPE_GENERATIVE_CHAT", "SOLUTION_TYPE_AI_MODE" ], "type": "string", "description": "Required. Immutable. Specifies the solution type that a serving config can be associated with." } } }, "GoogleCloudDiscoveryengineV1ProjectConfigurableBillingStatus": { "properties": { "searchQpmThresholdNextUpdateTime": { "readOnly": true, "format": "google-datetime", "type": "string", "description": "Output only. The earliest next update time for the search QPM subscription threshold. This is based on the next_update_time returned by the underlying Cloud Billing Subscription V3 API. This field is populated only if an update QPM subscription threshold request is succeeded." }, "startTime": { "type": "string", "description": "Optional. The start time of the currently active billing subscription.", "format": "google-datetime" }, "indexingCoreThresholdNextUpdateTime": { "type": "string", "description": "Output only. The earliest next update time for the indexing core subscription threshold. This is based on the next_update_time returned by the underlying Cloud Billing Subscription V3 API. This field is populated only if an update indexing core subscription threshold request is succeeded.", "readOnly": true, "format": "google-datetime" }, "effectiveSearchQpmThreshold": { "type": "string", "description": "Optional. The currently effective Search QPM threshold in queries per minute. This is the threshold against which QPM usage is compared for overage calculations.", "format": "int64" }, "agentSearchTokenSubscriptionStatuses": { "readOnly": true, "items": { "$ref": "GoogleCloudDiscoveryengineV1ProjectConfigurableBillingStatusAgentSearchTokenSubscriptionStatus" }, "description": "Output only. Per-model Agent Search TPM subscription status.", "type": "array" }, "terminateTime": { "readOnly": true, "description": "Output only. The latest terminate effective time of search qpm and indexing core subscriptions.", "format": "google-datetime", "type": "string" }, "updateType": { "enumDescriptions": [ "Unspecified update type.", "Configurable billing was created/enabled.", "Configurable billing was deleted/disabled.", "Subscription was scaled up (thresholds increased).", "Subscription was scaled down (thresholds decreased)." ], "readOnly": true, "enum": [ "UPDATE_TYPE_UNSPECIFIED", "CREATE", "DELETE", "SCALE_UP", "SCALE_DOWN" ], "description": "Output only. The type of update performed in this operation. This field is populated in the response of UpdateProject.", "type": "string" }, "effectiveIndexingCoreThreshold": { "type": "string", "description": "Optional. The currently effective Indexing Core threshold. This is the threshold against which Indexing Core usage is compared for overage calculations.", "format": "int64" } }, "description": "Represents the currently effective configurable billing parameters. These values are derived from the customer's subscription history stored internally and reflect the thresholds actively being used for billing purposes at the time of the GetProject call. This includes the start_time of the subscription and may differ from the values in `customer_provided_config` due to billing rules (e.g., scale-downs taking effect only at the start of a new month). We also include the update type to indicate the type of update performed on the configurable billing configuration in the UpdateProject operation.", "type": "object", "id": "GoogleCloudDiscoveryengineV1ProjectConfigurableBillingStatus" }, "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec": { "type": "object", "id": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec", "properties": { "extractiveContentSpec": { "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec", "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`.", "enumDescriptions": [ "Default value.", "Returns documents in the search result.", "Returns chunks in the search result. Only available if the DocumentProcessingConfig.chunking_config is specified." ], "type": "string", "enum": [ "SEARCH_RESULT_MODE_UNSPECIFIED", "DOCUMENTS", "CHUNKS" ] }, "snippetSpec": { "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSnippetSpec", "description": "If `snippetSpec` is not specified, snippets are not included in the search response." }, "summarySpec": { "description": "If `summarySpec` is not specified, summaries are not included in the search response.", "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec" }, "chunkSpec": { "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecChunkSpec", "description": "Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS" } }, "description": "A specification for configuring the behavior of content search." }, "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultChunkInfo": { "description": "Chunk information.", "properties": { "content": { "type": "string", "description": "Chunk textual content." }, "relevanceScore": { "description": "The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation.", "format": "float", "type": "number" }, "chunk": { "description": "Chunk resource name.", "type": "string" } }, "type": "object", "id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultChunkInfo" }, "GoogleCloudDiscoveryengineV1Principal": { "description": "Principal identifier of a user or a group.", "type": "object", "properties": { "externalEntityId": { "description": "For 3P application identities which are not present in the customer identity provider.", "type": "string" }, "userId": { "description": "User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config.", "type": "string" }, "groupId": { "type": "string", "description": "Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config." } }, "id": "GoogleCloudDiscoveryengineV1Principal" }, "GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResult": { "properties": { "violationSource": { "enum": [ "VIOLATION_SOURCE_UNSPECIFIED", "SYSTEM", "PROMPT", "ATTACHMENT" ], "description": "Output only. The source of the violation.", "readOnly": true, "enumDescriptions": [ "Unknown value.", "Violation found in the system response.", "Violation found in the user prompt.", "Violation found in the user attachment." ], "type": "string" }, "policyResults": { "description": "Customer policy enforcement results. Populated only if the assist call was skipped due to a policy violation. It contains results from those filters that blocked the processing of the query.", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResultPolicyEnforcementResult" }, "type": "array" }, "verdict": { "type": "string", "enum": [ "UNSPECIFIED", "ALLOW", "BLOCK" ], "description": "Final verdict of the customer policy enforcement. If only one policy blocked the processing, the verdict is BLOCK.", "enumDescriptions": [ "Unknown value.", "There was no policy violation.", "Processing was blocked by the customer policy." ] } }, "type": "object", "description": "Customer policy enforcement results. Contains the results of the various policy checks, like the banned phrases or the Model Armor checks.", "id": "GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResult" }, "GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfo": { "properties": { "content": { "description": "Chunk textual content.", "type": "string" }, "chunk": { "description": "Chunk resource name.", "type": "string" }, "documentMetadata": { "description": "Metadata of the document from the current chunk.", "$ref": "GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfoDocumentMetadata" } }, "id": "GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfo", "description": "Chunk information.", "type": "object" }, "GoogleCloudDiscoveryengineV1alphaGetUriPatternDocumentDataResponse": { "id": "GoogleCloudDiscoveryengineV1alphaGetUriPatternDocumentDataResponse", "description": "Response message for SiteSearchEngineService.GetUriPatternDocumentData method.", "type": "object", "properties": { "documentDataMap": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "description": "Document data keyed by URI pattern. For example: document_data_map = { \"www.url1.com/*\": { \"Categories\": [\"category1\", \"category2\"] }, \"www.url2.com/*\": { \"Categories\": [\"category3\"] } }" } } }, "GoogleCloudDiscoveryengineV1ControlSynonymsAction": { "properties": { "synonyms": { "description": "Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is thrown.", "items": { "type": "string" }, "type": "array" } }, "id": "GoogleCloudDiscoveryengineV1ControlSynonymsAction", "type": "object", "description": "Creates a set of terms that will act as synonyms of one another. Example: \"happy\" will also be considered as \"glad\", \"glad\" will also be considered as \"happy\"." }, "GoogleCloudDiscoveryengineV1alphaSchema": { "id": "GoogleCloudDiscoveryengineV1alphaSchema", "description": "Defines the structure and layout of a type of document data.", "type": "object", "properties": { "structSchema": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "description": "The structured representation of the schema.", "type": "object" }, "jsonSchema": { "type": "string", "description": "The JSON representation of the schema." }, "fieldConfigs": { "description": "Output only. Configurations for fields of the schema.", "type": "array", "readOnly": true, "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaFieldConfig" } }, "name": { "type": "string", "description": "Immutable. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters." } } }, "GoogleCloudDiscoveryengineV1SearchResponseSearchResultRankSignals": { "properties": { "documentAge": { "type": "number", "description": "Optional. Age of the document in hours.", "format": "float" }, "precomputedExpressionValues": { "items": { "format": "float", "type": "number" }, "type": "array", "description": "Optional. A list of precomputed expression results for a given document, in the same order as requested in `SearchRequest.custom_ranking_params.expressions_to_precompute`." }, "defaultRank": { "type": "number", "description": "Optional. The default rank of the result.", "format": "float" }, "semanticSimilarityScore": { "format": "float", "type": "number", "description": "Optional. Semantic similarity adjustment." }, "relevanceScore": { "format": "float", "type": "number", "description": "Optional. Semantic relevance adjustment." }, "customSignals": { "items": { "$ref": "GoogleCloudDiscoveryengineV1SearchResponseSearchResultRankSignalsCustomSignal" }, "description": "Optional. A list of custom clearbox signals.", "type": "array" }, "boostingFactor": { "format": "float", "description": "Optional. Combined custom boosts for a doc.", "type": "number" }, "keywordSimilarityScore": { "type": "number", "format": "float", "description": "Optional. Keyword matching adjustment." }, "topicalityRank": { "type": "number", "description": "Optional. Topicality adjustment as a rank.", "format": "float" }, "pctrRank": { "type": "number", "description": "Optional. Predicted conversion rate adjustment as a rank.", "format": "float" } }, "description": "A set of ranking signals.", "type": "object", "id": "GoogleCloudDiscoveryengineV1SearchResponseSearchResultRankSignals" }, "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponse": { "id": "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponse", "description": "Response message for CompletionService.AdvancedCompleteQuery method.", "type": "object", "properties": { "tailMatchTriggered": { "description": "True if the returned suggestions are all tail suggestions. For tail matching to be triggered, include_tail_suggestions in the request must be true and there must be no suggestions that match the full query.", "type": "boolean" }, "querySuggestions": { "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponseQuerySuggestion" }, "description": "Results of the matched query suggestions. The result list is ordered and the first result is a top suggestion." }, "recentSearchSuggestions": { "description": "Results of the matched \"recent search\" suggestions. The result list is ordered and the first result is the top suggestion.", "items": { "$ref": "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponseRecentSearchSuggestion" }, "type": "array" }, "contentSuggestions": { "items": { "$ref": "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponseContentSuggestion" }, "type": "array", "description": "Results of the matched content suggestions. The result list is ordered and the first result is the top suggestion." }, "peopleSuggestions": { "type": "array", "description": "Results of the matched people suggestions. The result list is ordered and the first result is the top suggestion.", "items": { "$ref": "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponsePersonSuggestion" } } } }, "GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigMostPopularFeatureConfig": { "type": "object", "properties": { "timeWindowDays": { "type": "string", "description": "The time window of which the engine is queried at training and prediction time. Positive integers only. The value translates to the last X days of events. Currently required for the `most-popular-items` engine.", "format": "int64" } }, "description": "Feature configurations that are required for creating a Most Popular engine.", "id": "GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigMostPopularFeatureConfig" }, "A2aV1SendMessageConfiguration": { "description": "Configuration of a send message request.", "type": "object", "properties": { "acceptedOutputModes": { "description": "The output modes that the agent is expected to respond with.", "type": "array", "items": { "type": "string" } }, "pushNotification": { "description": "A configuration of a webhook that can be used to receive updates", "$ref": "A2aV1PushNotificationConfig" }, "blocking": { "description": "If true, the message will be blocking until the task is completed. If false, the message will be non-blocking and the task will be returned immediately. It is the caller's responsibility to check for any task updates.", "type": "boolean" }, "historyLength": { "format": "int32", "description": "The maximum number of messages to include in the history. if 0, the history will be unlimited.", "type": "integer" } }, "id": "A2aV1SendMessageConfiguration" }, "GoogleCloudDiscoveryengineV1betaTrainCustomModelResponse": { "type": "object", "description": "Response of the TrainCustomModelRequest. This message is returned by the google.longrunning.Operations.response field.", "id": "GoogleCloudDiscoveryengineV1betaTrainCustomModelResponse", "properties": { "errorConfig": { "description": "Echoes the destination for the complete errors in the request if set.", "$ref": "GoogleCloudDiscoveryengineV1betaImportErrorConfig" }, "modelStatus": { "type": "string", "description": "The trained model status. Possible values are: * **bad-data**: The training data quality is bad. * **no-improvement**: Tuning didn't improve performance. Won't deploy. * **in-progress**: Model training job creation is in progress. * **training**: Model is actively training. * **evaluating**: The model is evaluating trained metrics. * **indexing**: The model trained metrics are indexing. * **ready**: The model is ready for serving." }, "metrics": { "additionalProperties": { "type": "number", "format": "double" }, "type": "object", "description": "The metrics of the trained model." }, "modelName": { "type": "string", "description": "Fully qualified name of the CustomTuningModel." }, "errorSamples": { "type": "array", "description": "A sample of errors encountered while processing the data.", "items": { "$ref": "GoogleRpcStatus" } } } }, "GoogleCloudDiscoveryengineLoggingServiceContext": { "description": "Describes a running service that sends errors.", "type": "object", "id": "GoogleCloudDiscoveryengineLoggingServiceContext", "properties": { "service": { "description": "An identifier of the service—for example, `discoveryengine.googleapis.com`.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1alphaAnswerCitation": { "description": "Citation info for a segment.", "properties": { "endIndex": { "description": "End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length.", "type": "string", "format": "int64" }, "sources": { "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerCitationSource" }, "description": "Citation sources for the attributed segment." }, "startIndex": { "description": "Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length.", "type": "string", "format": "int64" } }, "id": "GoogleCloudDiscoveryengineV1alphaAnswerCitation", "type": "object" }, "GoogleCloudDiscoveryengineV1alphaSessionTurn": { "type": "object", "description": "Represents a turn, including a query from the user and a answer from service.", "properties": { "live": { "description": "Optional. Indicates whether this turn is a live turn.", "type": "boolean" }, "query": { "$ref": "GoogleCloudDiscoveryengineV1alphaQuery", "description": "Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn" }, "detailedAssistAnswer": { "description": "Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting assistant session.", "readOnly": true, "$ref": "GoogleCloudDiscoveryengineV1alphaAssistAnswer" }, "detailedAnswer": { "$ref": "GoogleCloudDiscoveryengineV1alphaAnswer", "description": "Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting answer query session.", "readOnly": true }, "answer": { "description": "Optional. The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn.", "type": "string" }, "queryConfig": { "type": "object", "description": "Optional. Represents metadata related to the query config, for example LLM model and version used, model parameters (temperature, grounding parameters, etc.). The prefix \"google.\" is reserved for Google-developed functionality.", "additionalProperties": { "type": "string" } } }, "id": "GoogleCloudDiscoveryengineV1alphaSessionTurn" }, "GoogleCloudDiscoveryengineV1SearchRequestCustomRankingParams": { "description": "Configuration parameters for the Custom Ranking feature.", "type": "object", "properties": { "expressionsToPrecompute": { "type": "array", "items": { "type": "string" }, "description": "Optional. A list of ranking expressions (see `ranking_expression` for the syntax documentation) to evaluate. The evaluation results will be returned in `SearchResponse.SearchResult.rank_signals.precomputed_expression_values` field." } }, "id": "GoogleCloudDiscoveryengineV1SearchRequestCustomRankingParams" }, "GoogleCloudDiscoveryengineV1alphaAlphaEvolveEvaluationInsightsAlphaEvolveEvaluationInsight": { "properties": { "label": { "description": "Optional. Label of the insight.", "type": "string" }, "text": { "description": "Optional. Text of the insight.", "type": "string" } }, "description": "A single evaluation insight.", "id": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveEvaluationInsightsAlphaEvolveEvaluationInsight", "type": "object" }, "GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries": { "type": "object", "id": "GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries", "properties": { "qpsTimeSeries": { "$ref": "GoogleMonitoringV3TimeSeries", "description": "The QPS of the crawl rate." } }, "description": "The historical crawl rate timeseries data, used for monitoring." }, "GoogleCloudDiscoveryengineV1AssistantGroundedContentTextGroundingMetadataReference": { "id": "GoogleCloudDiscoveryengineV1AssistantGroundedContentTextGroundingMetadataReference", "description": "Referenced content and related document metadata.", "type": "object", "properties": { "chunkMetadata": { "type": "object", "readOnly": true, "additionalProperties": { "type": "any", "description": "Properties of the object." }, "description": "Output only. Generic structured chunk metadata from upstream data source connectors." }, "codeSnippet": { "description": "Chunk of code snippet from the referenced document.", "type": "string" }, "documentMetadata": { "$ref": "GoogleCloudDiscoveryengineV1AssistantGroundedContentTextGroundingMetadataReferenceDocumentMetadata", "description": "Document metadata." }, "content": { "description": "Referenced text content.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1AnswerStepActionSearchAction": { "id": "GoogleCloudDiscoveryengineV1AnswerStepActionSearchAction", "properties": { "query": { "type": "string", "description": "The query to search." } }, "type": "object", "description": "Search action." }, "GoogleCloudDiscoveryengineV1alphaIdpConfig": { "description": "Identity Provider Config.", "properties": { "externalIdpConfig": { "$ref": "GoogleCloudDiscoveryengineV1alphaIdpConfigExternalIdpConfig", "description": "External Identity provider config." }, "idpType": { "type": "string", "enum": [ "IDP_TYPE_UNSPECIFIED", "GSUITE", "THIRD_PARTY" ], "description": "Identity provider type configured.", "enumDescriptions": [ "Default value. ACL search not enabled.", "Google 1P provider.", "Third party provider." ] } }, "type": "object", "id": "GoogleCloudDiscoveryengineV1alphaIdpConfig" }, "GoogleCloudDiscoveryengineV1SearchRequestNaturalLanguageQueryUnderstandingSpec": { "description": "Specification to enable natural language understanding capabilities for search requests.", "properties": { "extractedFilterBehavior": { "type": "string", "description": "Optional. Controls behavior of how extracted filters are applied to the search. The default behavior depends on the request. For single datastore structured search, the default is `HARD_FILTER`. For multi-datastore search, the default behavior is `SOFT_BOOST`. Location-based filters are always applied as hard filters, and the `SOFT_BOOST` setting will not affect them. This field is only used if SearchRequest.NaturalLanguageQueryUnderstandingSpec.FilterExtractionCondition is set to FilterExtractionCondition.ENABLED.", "enum": [ "EXTRACTED_FILTER_BEHAVIOR_UNSPECIFIED", "HARD_FILTER", "SOFT_BOOST" ], "enumDescriptions": [ "`EXTRACTED_FILTER_BEHAVIOR_UNSPECIFIED` will use the default behavior for extracted filters. For single datastore search, the default is to apply as hard filters. For multi-datastore search, the default is to apply as soft boosts.", "Applies all extracted filters as hard filters on the results. Results that do not pass the extracted filters will not be returned in the result set.", "Applies all extracted filters as soft boosts. Results that pass the filters will be boosted up to higher ranks in the result set." ] }, "geoSearchQueryDetectionFieldNames": { "items": { "type": "string" }, "type": "array", "description": "Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`." }, "filterExtractionCondition": { "type": "string", "enumDescriptions": [ "Server behavior defaults to `DISABLED`.", "Disables NL filter extraction.", "Enables NL filter extraction." ], "description": "The condition under which filter extraction should occur. Server behavior defaults to `DISABLED`.", "enum": [ "CONDITION_UNSPECIFIED", "DISABLED", "ENABLED" ] }, "allowedFieldNames": { "type": "array", "items": { "type": "string" }, "description": "Optional. Allowlist of fields that can be used for natural language filter extraction. By default, if this is unspecified, all indexable fields are eligible for natural language filter extraction (but are not guaranteed to be used). If any fields are specified in allowed_field_names, only the fields that are both marked as indexable in the schema and specified in the allowlist will be eligible for natural language filter extraction. Note: for multi-datastore search, this is not yet supported, and will be ignored." } }, "id": "GoogleCloudDiscoveryengineV1SearchRequestNaturalLanguageQueryUnderstandingSpec", "type": "object" }, "GoogleCloudDiscoveryengineV1AclConfig": { "description": "Access Control Configuration.", "properties": { "name": { "description": "Immutable. The full resource name of the acl configuration. Format: `projects/{project}/locations/{location}/aclConfig`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", "type": "string" }, "idpConfig": { "$ref": "GoogleCloudDiscoveryengineV1IdpConfig", "description": "Identity provider config." } }, "type": "object", "id": "GoogleCloudDiscoveryengineV1AclConfig" }, "GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesMetadata": { "description": "Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", "properties": { "createTime": { "description": "Operation create time.", "type": "string", "format": "google-datetime" }, "updateTime": { "format": "google-datetime", "type": "string", "description": "Operation last update time. If the operation is done, this is also the finish time." } }, "type": "object", "id": "GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesMetadata" }, "GoogleCloudDiscoveryengineV1WidgetConfigBatchAuthStatus": { "properties": { "placeholder": { "description": "Output only. It is the batch authorization group placeholder full resource name. This is not a real data connector (not existed in DataConnector table in spanner). It's a resource name existing only in the connector_authorization in the user table. E.g. projects/{project}/locations/{location}/collections/oauth_placeholder_google_workspace/dataStores/dataConnector.", "readOnly": true, "type": "string" }, "batchAuthorizationGroup": { "description": "Output only. The batch authorization group the placeholder belongs to.", "type": "string", "readOnly": true }, "connectorAuthState": { "$ref": "GoogleCloudDiscoveryengineV1WidgetConfigConnectorAuthState", "description": "Output only. The current authorization state for this connector.", "readOnly": true } }, "type": "object", "description": "Describes the batch authorization status for a batch_authorization_group.", "id": "GoogleCloudDiscoveryengineV1WidgetConfigBatchAuthStatus" }, "GoogleCloudDiscoveryengineV1alphaDataConnector": { "id": "GoogleCloudDiscoveryengineV1alphaDataConnector", "properties": { "createTime": { "description": "Output only. Timestamp the DataConnector was created at.", "format": "google-datetime", "type": "string", "readOnly": true }, "state": { "enum": [ "STATE_UNSPECIFIED", "CREATING", "ACTIVE", "FAILED", "RUNNING", "WARNING", "INITIALIZATION_FAILED", "UPDATING" ], "readOnly": true, "enumDescriptions": [ "Default value.", "The connector is being set up.", "The connector is successfully set up and awaiting next sync run.", "The connector is in error. The error details can be found in DataConnector.errors. If the error is unfixable, the DataConnector can be deleted by CollectionService.DeleteCollection API.", "The connector is actively syncing records from the data source.", "The connector has completed a sync run, but encountered non-fatal errors.", "Connector initialization failed. Potential causes include runtime errors or issues in the asynchronous pipeline, preventing the request from reaching downstream services (except for some connector types).", "Connector is in the process of an update." ], "description": "Output only. State of the connector.", "type": "string" }, "refreshInterval": { "format": "google-duration", "type": "string", "description": "Required. The refresh interval for data sync. If duration is set to 0, the data will be synced in real time. The streaming feature is not supported yet. The minimum is 30 minutes and maximum is 7 days. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled." }, "dynamicTools": { "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaDynamicTool" }, "readOnly": true, "description": "Output only. The dynamic tools fetched for this connector.", "type": "array" }, "destinationConfigs": { "type": "array", "description": "Optional. Any target destinations used to connect to third-party services.", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaDestinationConfig" } }, "jsonParams": { "description": "Required data connector parameters in json string format.", "type": "string" }, "entities": { "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaDataConnectorSourceEntity" }, "description": "List of entities from the connected data source to ingest." }, "nextSyncTime": { "description": "Defines the scheduled time for the next data synchronization. This field requires hour , minute, and time_zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). This is utilized when the data connector has a refresh interval greater than 1 day. When the hours or minutes are not specified, we will assume a sync time of 0:00. The user must provide a time zone to avoid ambiguity.", "$ref": "GoogleTypeDateTime" }, "createEuaSaas": { "type": "boolean", "description": "Optional. Whether the END USER AUTHENTICATION connector is created in SaaS." }, "actionState": { "enum": [ "STATE_UNSPECIFIED", "CREATING", "ACTIVE", "FAILED", "RUNNING", "WARNING", "INITIALIZATION_FAILED", "UPDATING" ], "readOnly": true, "enumDescriptions": [ "Default value.", "The connector is being set up.", "The connector is successfully set up and awaiting next sync run.", "The connector is in error. The error details can be found in DataConnector.errors. If the error is unfixable, the DataConnector can be deleted by CollectionService.DeleteCollection API.", "The connector is actively syncing records from the data source.", "The connector has completed a sync run, but encountered non-fatal errors.", "Connector initialization failed. Potential causes include runtime errors or issues in the asynchronous pipeline, preventing the request from reaching downstream services (except for some connector types).", "Connector is in the process of an update." ], "type": "string", "description": "Output only. State of the action connector. This reflects whether the action connector is initializing, active or has encountered errors." }, "name": { "type": "string", "description": "Identifier. The full resource name of the Data Connector. Format: `projects/*/locations/*/collections/*/dataConnector`." }, "dataSource": { "description": "Required. The identifier for the data source. For the full, up-to-date list of supported connectors and their values, see [Connect a third-party data source](https://docs.cloud.google.com/gemini/enterprise/docs/connectors/connect-third-party-data-source#sources-by-launch-stage).", "type": "string" }, "kmsKeyName": { "description": "Input only. The KMS key to be used to protect the DataStores managed by this connector. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStores created by this connector will be protected by the KMS key.", "type": "string" }, "lastSyncTime": { "format": "google-datetime", "readOnly": true, "type": "string", "description": "Output only. For periodic connectors only, the last time a data sync was completed." }, "bapConfig": { "description": "Optional. The configuration for establishing a BAP connection.", "$ref": "GoogleCloudDiscoveryengineV1alphaBAPConfig" }, "identityScheduleConfig": { "$ref": "GoogleCloudDiscoveryengineV1alphaIdentityScheduleConfig", "description": "The configuration for the identity data synchronization runs. This contains the refresh interval to sync the Access Control List information for the documents ingested by this connector." }, "errors": { "type": "array", "readOnly": true, "description": "Output only. The errors from initialization or from the latest connector run.", "items": { "$ref": "GoogleRpcStatus" } }, "incrementalSyncDisabled": { "type": "boolean", "description": "Optional. Indicates whether incremental syncs are paused for this connector. This is independent of auto_run_disabled. Applicable to only 3P connectors. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled, i.e. set to true." }, "latestPauseTime": { "description": "Output only. The most recent timestamp when this DataConnector was paused, affecting all functionalities such as data synchronization. Pausing a connector has the following effects: - All functionalities, including data synchronization, are halted. - Any ongoing data synchronization job will be canceled. - No future data synchronization runs will be scheduled nor can be triggered.", "readOnly": true, "format": "google-datetime", "type": "string" }, "params": { "description": "Required data connector parameters in structured json format.", "type": "object", "additionalProperties": { "description": "Properties of the object.", "type": "any" } }, "connectorType": { "readOnly": true, "type": "string", "description": "Output only. The type of connector. Each source can only map to one type. For example, salesforce, confluence and jira have THIRD_PARTY connector type. It is not mutable once set by system.", "enum": [ "CONNECTOR_TYPE_UNSPECIFIED", "THIRD_PARTY", "GCP_FHIR", "BIG_QUERY", "GCS", "GOOGLE_MAIL", "GOOGLE_CALENDAR", "GOOGLE_DRIVE", "NATIVE_CLOUD_IDENTITY", "THIRD_PARTY_FEDERATED", "THIRD_PARTY_EUA", "GCNV", "GOOGLE_CHAT", "GOOGLE_SITES", "REMOTE_MCP", "GOOGLE_WORKSPACE" ], "enumDescriptions": [ "Default value.", "Third party connector to connector to third party application.", "Data connector connects between FHIR store and VAIS datastore.", "Big query connector.", "Google Cloud Storage connector.", "Gmail connector.", "Google Calendar connector.", "Google Drive connector.", "Native Cloud Identity connector for people search powered by People API.", "Federated connector, it is a third party connector that doesn't ingestion data, and search is powered by third party application's API.", "Connector utilized for End User Authentication features.", "Google Cloud NetApp Volumes connector.", "Google Chat connector.", "Google Sites connector.", "Remote MCP based connector.", "Google Workspace connector." ] }, "federatedConfig": { "$ref": "GoogleCloudDiscoveryengineV1alphaDataConnectorFederatedConfig", "description": "Optional. Any params and credentials used specifically for hybrid connectors supporting FEDERATED mode. This field should only be set if the connector is a hybrid connector and we want to enable FEDERATED mode." }, "removeParamKeys": { "items": { "type": "string" }, "description": "Optional. Specifies keys to be removed from the 'params' field. This is only active when 'params' is included in the 'update_mask' in an UpdateDataConnectorRequest. Deletion takes precedence if a key is both in 'remove_param_keys' and present in the 'params' field of the request.", "type": "array" }, "tag": { "type": "string", "description": "Optional. Immutable. User-facing, version-independent label for this connector. May be shared by multiple connectors under the same (project, location, collection, data_source); tag-based lookup returns the one with the greatest create_time. Optional at Create time. Agent Designer resolves connectors via (data_source, tag) when set, falling back to the legacy resource-name lookup when unset, so connectors created before the tag-write launch continue to work without a backfill." }, "connectorModes": { "description": "Optional. The modes enabled for this connector. Default state is CONNECTOR_MODE_UNSPECIFIED.", "type": "array", "items": { "type": "string", "enumDescriptions": [ "Connector mode unspecified.", "Connector utilized for data ingestion.", "Connector utilized for actions.", "Connector utilized for federated search.", "Connector utilized for End User Authentication.", "Hybrid connector utilized for federated search and End User Authentication." ], "enum": [ "CONNECTOR_MODE_UNSPECIFIED", "DATA_INGESTION", "ACTIONS", "FEDERATED", "EUA", "FEDERATED_AND_EUA" ] } }, "staticIpEnabled": { "type": "boolean", "description": "Optional. Whether customer has enabled static IP addresses for this connector." }, "actionConfig": { "$ref": "GoogleCloudDiscoveryengineV1alphaActionConfig", "description": "Optional. Action configurations to make the connector support actions." }, "egressFqdns": { "description": "Output only. The list of FQDNs of the data connector can egress to. This includes both FQDN derived from the customer provided instance URL and default per connector type FQDNs.", "type": "array", "items": { "type": "string" }, "readOnly": true }, "metadata": { "description": "Optional. User-facing metadata for the connector. Populated from the connector's generated metadata / registry `ConnectorSource`.", "$ref": "GoogleCloudDiscoveryengineV1alphaDataConnectorConnectorMetadata" }, "staticIpAddresses": { "description": "Output only. The static IP addresses used by this connector.", "items": { "type": "string" }, "readOnly": true, "type": "array" }, "oauthStaticIpAddresses": { "items": { "type": "string" }, "type": "array", "description": "Output only. The static IP addresses used by this connector for OAuth APIs (e.g. end user authentication). These are surfaced separately from `static_ip_addresses` so that customers can apply granular firewall settings for OAuth endpoints. Only populated for connectors that have static IP enabled and are used for actions and/or federated search.", "readOnly": true }, "autoRunDisabled": { "description": "Optional. Indicates whether the connector is disabled for auto run. It can be used to pause periodical and real time sync. Update: with the introduction of incremental_sync_disabled, auto_run_disabled is used to pause/disable only full syncs", "type": "boolean" }, "realtimeState": { "enumDescriptions": [ "Default value.", "The connector is being set up.", "The connector is successfully set up and awaiting next sync run.", "The connector is in error. The error details can be found in DataConnector.errors. If the error is unfixable, the DataConnector can be deleted by CollectionService.DeleteCollection API.", "The connector is actively syncing records from the data source.", "The connector has completed a sync run, but encountered non-fatal errors.", "Connector initialization failed. Potential causes include runtime errors or issues in the asynchronous pipeline, preventing the request from reaching downstream services (except for some connector types).", "Connector is in the process of an update." ], "readOnly": true, "type": "string", "description": "Output only. real-time sync state", "enum": [ "STATE_UNSPECIFIED", "CREATING", "ACTIVE", "FAILED", "RUNNING", "WARNING", "INITIALIZATION_FAILED", "UPDATING" ] }, "alertPolicyConfigs": { "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaAlertPolicyConfig" }, "description": "Optional. The connector level alert config.", "type": "array" }, "updateTime": { "readOnly": true, "type": "string", "description": "Output only. Timestamp the DataConnector was last updated.", "format": "google-datetime" }, "hybridIngestionDisabled": { "type": "boolean", "description": "Optional. If the connector is a hybrid connector, determines whether ingestion is enabled and appropriate resources are provisioned during connector creation. If the connector is not a hybrid connector, this field is ignored." }, "endUserConfig": { "$ref": "GoogleCloudDiscoveryengineV1alphaDataConnectorEndUserConfig", "description": "Optional. Any params and credentials used specifically for EUA connectors." }, "incrementalRefreshInterval": { "description": "Optional. The refresh interval specifically for incremental data syncs. If unset, incremental syncs will use the default from env, set to 3hrs. The minimum is 30 minutes and maximum is 7 days. Applicable to only 3P connectors. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled.", "format": "google-duration", "type": "string" }, "aclEnabled": { "description": "Optional. Whether the connector will be created with an ACL config. Currently this field only affects Cloud Storage and BigQuery connectors.", "type": "boolean" }, "syncMode": { "enumDescriptions": [ "The connector will sync data periodically based on the refresh_interval. Use it with auto_run_disabled to pause the periodic sync, or indicate a one-time sync.", "The data will be synced in real time.", "Connector that doesn't ingest data will have this value" ], "enum": [ "PERIODIC", "STREAMING", "UNSPECIFIED" ], "type": "string", "description": "The data synchronization mode supported by the data connector." }, "privateConnectivityProjectId": { "readOnly": true, "type": "string", "description": "Output only. The tenant project ID associated with private connectivity connectors. This project must be allowlisted by in order for the connector to function." }, "realtimeSyncConfig": { "$ref": "GoogleCloudDiscoveryengineV1alphaDataConnectorRealtimeSyncConfig", "description": "Optional. The configuration for realtime sync." }, "cliConfig": { "description": "Optional. The configuration for establishing a CLI connection.", "$ref": "GoogleCloudDiscoveryengineV1alphaCliConfig" }, "dataProtectionPolicy": { "description": "Optional. Specifies the data protection policy for the connector.", "$ref": "GoogleCloudDiscoveryengineV1alphaDataProtectionPolicy" }, "connectorSourceId": { "type": "string", "description": "Optional. If set, this value instead of `data_source` is used to fetch the corresponding connector source." }, "identityRefreshInterval": { "format": "google-duration", "description": "The refresh interval to sync the Access Control List information for the documents ingested by this connector. If not set, the access control list will be refreshed at the default interval of 30 minutes. The identity refresh interval can be at least 30 minutes and at most 7 days.", "deprecated": true, "type": "string" }, "blockingReasons": { "type": "array", "readOnly": true, "items": { "enumDescriptions": [ "Default value.", "Connector requires customer to allowlist static IPs.", "Connector requires customer to allowlist our project in their service attachment.", "Connector requires customer to allowlist service account in their project." ], "enum": [ "BLOCKING_REASON_UNSPECIFIED", "ALLOWLIST_STATIC_IP", "ALLOWLIST_IN_SERVICE_ATTACHMENT", "ALLOWLIST_SERVICE_ACCOUNT" ], "type": "string" }, "description": "Output only. User actions that must be completed before the connector can start syncing data." }, "vpcscEnabled": { "type": "boolean", "readOnly": true, "description": "Output only. Whether the connector is created with VPC-SC enabled." } }, "description": "Manages the connection to external data sources for all data stores grouped under a Collection. It's a singleton resource of Collection. The initialization is only supported through DataConnectorService.SetUpDataConnector method, which will create a new Collection and initialize its DataConnector.", "type": "object" }, "GoogleCloudDiscoveryengineV1DeleteIdentityMappingStoreMetadata": { "id": "GoogleCloudDiscoveryengineV1DeleteIdentityMappingStoreMetadata", "description": "Metadata related to the progress of the IdentityMappingStoreService.DeleteIdentityMappingStore operation. This will be returned by the google.longrunning.Operation.metadata field.", "properties": { "updateTime": { "description": "Operation last update time. If the operation is done, this is also the finish time.", "format": "google-datetime", "type": "string" }, "createTime": { "description": "Operation create time.", "format": "google-datetime", "type": "string" } }, "type": "object" }, "GoogleCloudDiscoveryengineV1SearchRequestCrowdingSpec": { "description": "Specification for crowding. Crowding improves the diversity of search results by limiting the number of results that share the same field value. For example, crowding on the color field with a max_count of 3 and mode DROP_CROWDED_RESULTS will return at most 3 results with the same color across all pages.", "properties": { "maxCount": { "description": "The maximum number of documents to keep per value of the field. Once there are at least max_count previous results which contain the same value for the given field (according to the order specified in `order_by`), later results with the same value are \"crowded away\". If not specified, the default value is 1.", "format": "int32", "type": "integer" }, "field": { "description": "The field to use for crowding. Documents can be crowded by a field in the Document object. Crowding field is case sensitive.", "type": "string" }, "mode": { "enum": [ "MODE_UNSPECIFIED", "DROP_CROWDED_RESULTS", "DEMOTE_CROWDED_RESULTS_TO_END" ], "type": "string", "enumDescriptions": [ "Unspecified crowding mode. In this case, server behavior defaults to Mode.DROP_CROWDED_RESULTS.", "Drop crowded results.", "Demote crowded results to the later pages." ], "description": "Mode to use for documents that are crowded away." } }, "type": "object", "id": "GoogleCloudDiscoveryengineV1SearchRequestCrowdingSpec" }, "GoogleCloudDiscoveryengineV1Query": { "description": "Defines a user inputed query.", "type": "object", "properties": { "queryId": { "type": "string", "readOnly": true, "description": "Output only. Unique Id for the query." }, "text": { "description": "Plain text.", "type": "string" } }, "id": "GoogleCloudDiscoveryengineV1Query" }, "GoogleCloudDiscoveryengineV1Sitemap": { "type": "object", "id": "GoogleCloudDiscoveryengineV1Sitemap", "properties": { "uri": { "type": "string", "description": "Public URI for the sitemap, e.g. `www.example.com/sitemap.xml`." }, "createTime": { "type": "string", "readOnly": true, "format": "google-datetime", "description": "Output only. The sitemap's creation time." }, "name": { "description": "Output only. The fully qualified resource name of the sitemap. `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine/sitemaps/*` The `sitemap_id` suffix is system-generated.", "readOnly": true, "type": "string" } }, "description": "A sitemap for the SiteSearchEngine." }, "GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpec": { "type": "object", "id": "GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpec", "description": "Search specification.", "properties": { "searchParams": { "$ref": "GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchParams", "description": "Search parameters." }, "searchResultList": { "$ref": "GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultList", "description": "Search result list." } } }, "GoogleCloudDiscoveryengineV1alphaQueryPartDriveDocumentReference": { "properties": { "displayTitle": { "description": "The display title of the reference.", "type": "string" }, "destinationUri": { "description": "The destination uri of the reference.", "type": "string" }, "iconUri": { "type": "string", "description": "The icon uri of the Drive document reference." }, "fileId": { "readOnly": true, "type": "string", "description": "Output only. The file id of the Drive document data stored in the session context files." }, "documentName": { "type": "string", "description": "The full resource name of the document. Format: `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`." }, "driveId": { "type": "string", "description": "The Drive id of the document." } }, "type": "object", "description": "Represents a Google Drive document reference.", "id": "GoogleCloudDiscoveryengineV1alphaQueryPartDriveDocumentReference" }, "GoogleCloudDiscoveryengineV1alphaGetSessionRequest": { "type": "object", "description": "Request for GetSession method.", "properties": { "name": { "description": "Required. The resource name of the Session to get. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`", "type": "string" }, "includeAnswerDetails": { "type": "boolean", "description": "Optional. If set to true, the full session including all answer details will be returned." } }, "id": "GoogleCloudDiscoveryengineV1alphaGetSessionRequest" }, "GoogleCloudDiscoveryengineV1alphaResumeExperimentMetadata": { "properties": { "createTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The time the operation was created." }, "updateTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The time the operation was last updated.", "type": "string" } }, "description": "Metadata for AlphaEvolveService.ResumeExperiment long running operation.", "id": "GoogleCloudDiscoveryengineV1alphaResumeExperimentMetadata", "type": "object" }, "GoogleCloudDiscoveryengineV1AssistantContent": { "description": "Multi-modal content.", "type": "object", "id": "GoogleCloudDiscoveryengineV1AssistantContent", "properties": { "file": { "$ref": "GoogleCloudDiscoveryengineV1AssistantContentFile", "description": "A file, e.g., an audio summary." }, "codeExecutionResult": { "description": "Result of executing an ExecutableCode.", "$ref": "GoogleCloudDiscoveryengineV1AssistantContentCodeExecutionResult" }, "thought": { "description": "Optional. Indicates if the part is thought from the model.", "type": "boolean" }, "executableCode": { "description": "Code generated by the model that is meant to be executed.", "$ref": "GoogleCloudDiscoveryengineV1AssistantContentExecutableCode" }, "text": { "description": "Inline text.", "type": "string" }, "role": { "description": "The producer of the content. Can be \"model\" or \"user\".", "type": "string" }, "inlineData": { "description": "Inline binary data.", "$ref": "GoogleCloudDiscoveryengineV1AssistantContentBlob" } } }, "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec": { "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec", "properties": { "ignoreNonSummarySeekingQuery": { "description": "Specifies whether to filter out queries that are not summary-seeking. The default value is `false`. Google employs search-query classification to detect summary-seeking queries. No summary is returned if the search query is classified as a non-summary seeking query. For example, `why is the sky blue` and `Who is the best soccer player in the world?` are summary-seeking queries, but `SFO airport` and `world cup 2026` are not. They are most likely navigational queries. If this field is set to `true`, we skip generating summaries for non-summary seeking queries and return fallback messages instead.", "type": "boolean" }, "modelPromptSpec": { "description": "If specified, the spec will be used to modify the prompt provided to the LLM.", "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelPromptSpec" }, "modelSpec": { "description": "If specified, the spec will be used to modify the model specification provided to the LLM.", "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec" }, "ignoreJailBreakingQuery": { "type": "boolean", "description": "Optional. Specifies whether to filter out jail-breaking queries. The default value is `false`. Google employs search-query classification to detect jail-breaking queries. No summary is returned if the search query is classified as a jail-breaking query. A user might add instructions to the query to change the tone, style, language, content of the answer, or ask the model to act as a different entity, e.g. \"Reply in the tone of a competing company's CEO\". If this field is set to `true`, we skip generating summaries for jail-breaking queries and return fallback messages instead." }, "useSemanticChunks": { "description": "If true, answer will be generated from most relevant chunks from top search results. This feature will improve summary quality. Note that with this feature enabled, not all top search results will be referenced and included in the reference list, so the citation source index only points to the search results listed in the reference list.", "type": "boolean" }, "includeCitations": { "description": "Specifies whether to include citations in the summary. The default value is `false`. When this field is set to `true`, summaries include in-line citation numbers. Example summary including citations: BigQuery is Google Cloud's fully managed and completely serverless enterprise data warehouse [1]. BigQuery supports all data types, works across clouds, and has built-in machine learning and business intelligence, all within a unified platform [2, 3]. The citation numbers refer to the returned search results and are 1-indexed. For example, [1] means that the sentence is attributed to the first search result. [2, 3] means that the sentence is attributed to both the second and third search results.", "type": "boolean" }, "ignoreAdversarialQuery": { "description": "Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No summary is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating summaries for adversarial queries and return fallback messages instead.", "type": "boolean" }, "languageCode": { "description": "Language code for Summary. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is an experimental feature.", "type": "string" }, "summaryResultCount": { "description": "The number of top results to generate the summary from. If the number of results returned is less than `summaryResultCount`, the summary is generated from all of the results. At most 10 results for documents mode, or 50 for chunks mode, can be used to generate a summary. The chunks mode is used when SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS.", "format": "int32", "type": "integer" }, "multimodalSpec": { "description": "Optional. Multimodal specification.", "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecMultiModalSpec" }, "ignoreLowRelevantContent": { "type": "boolean", "description": "Specifies whether to filter out queries that have low relevance. The default value is `false`. If this field is set to `false`, all search results are used regardless of relevance to generate answers. If set to `true`, only queries with high relevance search results will generate answers." } }, "type": "object", "description": "A specification for configuring a summary returned in a search response." }, "GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentConfigGenerationSettings": { "properties": { "context": { "type": "string", "description": "Optional. Additional user-provided context to be used during generation." }, "models": { "description": "Optional. Per-model configuration. See `ModelConfig` for details. If left unset, the server selects a default model.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentConfigGenerationSettingsModelConfig" } }, "includeFullProgramInPrompt": { "description": "Optional. When true, the LLM prompt includes the full program text (both mutable EVOLVE-BLOCK regions and immutable boilerplate). When false (default), only the mutable EVOLVE-BLOCK regions are shown, saving context window.", "type": "boolean" } }, "id": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentConfigGenerationSettings", "description": "Generation settings for the experiment.", "type": "object" }, "GoogleCloudDiscoveryengineV1Session": { "type": "object", "description": "External session proto definition.", "id": "GoogleCloudDiscoveryengineV1Session", "properties": { "pendingAsyncAssistOperationId": { "readOnly": true, "type": "string", "description": "Output only. Full resource name of an in-progress AsyncAssist operation for this session, e.g. `projects/*/locations/*/collections/*/engines/*/sessions/*/operations/*`. Set when the operation starts and cleared when it finishes." }, "endTime": { "type": "string", "description": "Output only. The time the session finished.", "readOnly": true, "format": "google-datetime" }, "labels": { "description": "Optional. The labels for the session. Can be set as filter in ListSessionsRequest.", "items": { "type": "string" }, "type": "array" }, "startTime": { "readOnly": true, "format": "google-datetime", "type": "string", "description": "Output only. The time the session started." }, "userPseudoId": { "description": "A unique identifier for tracking users.", "type": "string" }, "displayName": { "type": "string", "description": "Optional. The display name of the session. This field is used to identify the session in the UI. By default, the display name is the first turn query text in the session." }, "isPinned": { "description": "Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list.", "type": "boolean" }, "state": { "enum": [ "STATE_UNSPECIFIED", "IN_PROGRESS" ], "type": "string", "enumDescriptions": [ "State is unspecified.", "The session is currently open." ], "description": "The state of the session." }, "turns": { "items": { "$ref": "GoogleCloudDiscoveryengineV1SessionTurn" }, "type": "array", "description": "Turns." }, "name": { "type": "string", "description": "Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*`" } } }, "GoogleCloudDiscoveryengineV1alphaQueryPartDocumentReference": { "id": "GoogleCloudDiscoveryengineV1alphaQueryPartDocumentReference", "type": "object", "description": "Represents a document reference.", "properties": { "displayTitle": { "description": "The display title of the reference.", "type": "string" }, "urlForConnector": { "description": "Input only. The url_for_connector of the document returned by Federated Search.", "type": "string" }, "fileId": { "readOnly": true, "description": "Output only. The file id of the document data stored in the session context files.", "type": "string" }, "documentName": { "type": "string", "description": "The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`." }, "destinationUri": { "description": "The destination uri of the reference.", "type": "string" }, "iconUri": { "type": "string", "description": "The icon uri of the reference." } } }, "GoogleCloudDiscoveryengineV1UpdateCmekConfigMetadata": { "description": "Metadata related to the progress of the CmekConfigService.UpdateCmekConfig operation. This will be returned by the google.longrunning.Operation.metadata field.", "type": "object", "properties": { "createTime": { "format": "google-datetime", "type": "string", "description": "Operation create time." }, "updateTime": { "description": "Operation last update time. If the operation is done, this is also the finish time.", "format": "google-datetime", "type": "string" } }, "id": "GoogleCloudDiscoveryengineV1UpdateCmekConfigMetadata" }, "GoogleLongrunningListOperationsResponse": { "properties": { "unreachable": { "items": { "type": "string" }, "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations.", "type": "array" }, "nextPageToken": { "type": "string", "description": "The standard List next-page token." }, "operations": { "items": { "$ref": "GoogleLongrunningOperation" }, "description": "A list of operations that matches the specified filter in the request.", "type": "array" } }, "type": "object", "description": "The response message for Operations.ListOperations.", "id": "GoogleLongrunningListOperationsResponse" }, "GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResult": { "description": "Search result.", "properties": { "chunkInfo": { "description": "Chunk information.", "$ref": "GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfo" }, "unstructuredDocumentInfo": { "description": "Unstructured document information.", "$ref": "GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfo" } }, "type": "object", "id": "GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResult" }, "GoogleCloudDiscoveryengineV1betaEngineKnowledgeGraphConfig": { "description": "Configuration message for the Knowledge Graph.", "id": "GoogleCloudDiscoveryengineV1betaEngineKnowledgeGraphConfig", "properties": { "enableCloudKnowledgeGraph": { "type": "boolean", "description": "Whether to enable the Cloud Knowledge Graph for the engine. Defaults to false if not specified." }, "cloudKnowledgeGraphTypes": { "type": "array", "items": { "type": "string" }, "description": "Specify entity types to support." }, "featureConfig": { "$ref": "GoogleCloudDiscoveryengineV1betaEngineKnowledgeGraphConfigFeatureConfig", "description": "Optional. Feature config for the Knowledge Graph." }, "privateKnowledgeGraphTypes": { "description": "Specify entity types to support.", "items": { "type": "string" }, "type": "array" }, "enablePrivateKnowledgeGraph": { "type": "boolean", "description": "Whether to enable the Private Knowledge Graph for the engine. Defaults to false if not specified." } }, "type": "object" }, "GoogleCloudDiscoveryengineV1Assistant": { "properties": { "defaultWebGroundingToggleOff": { "type": "boolean", "description": "Optional. This field controls the default web grounding toggle for end users if `web_grounding_type` is set to `WEB_GROUNDING_TYPE_GOOGLE_SEARCH` or `WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH`. By default, this field is set to false. If `web_grounding_type` is `WEB_GROUNDING_TYPE_GOOGLE_SEARCH` or `WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH`, end users will have web grounding enabled by default on UI. If true, grounding toggle will be disabled by default on UI. End users can still enable web grounding in the UI if web grounding is enabled." }, "displayName": { "type": "string", "description": "Required. The assistant display name. It must be a UTF-8 encoded string with a length limit of 128 characters." }, "name": { "type": "string", "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." }, "customerPolicy": { "$ref": "GoogleCloudDiscoveryengineV1AssistantCustomerPolicy", "description": "Optional. Customer policy for the assistant." }, "createTime": { "format": "google-datetime", "readOnly": true, "description": "Output only. Represents the time when this Assistant was created.", "type": "string" }, "webGroundingType": { "type": "string", "enum": [ "WEB_GROUNDING_TYPE_UNSPECIFIED", "WEB_GROUNDING_TYPE_DISABLED", "WEB_GROUNDING_TYPE_GOOGLE_SEARCH", "WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH" ], "description": "Optional. The type of web grounding to use.", "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." ] }, "description": { "description": "Optional. Description for additional information. Expected to be shown on the configuration UI, not to the users of the assistant.", "type": "string" }, "generationConfig": { "$ref": "GoogleCloudDiscoveryengineV1AssistantGenerationConfig", "description": "Optional. Configuration for the generation of the assistant response." }, "updateTime": { "type": "string", "description": "Output only. Represents the time when this Assistant was most recently updated.", "readOnly": true, "format": "google-datetime" }, "enabledTools": { "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\"),..] }", "additionalProperties": { "$ref": "GoogleCloudDiscoveryengineV1AssistantToolList" }, "type": "object" } }, "description": "Discovery Engine Assistant resource.", "type": "object", "id": "GoogleCloudDiscoveryengineV1Assistant" }, "GoogleCloudDiscoveryengineV1alphaQualityMetrics": { "properties": { "docPrecision": { "description": "Precision per document, at various top-k cutoff levels. Precision is the fraction of retrieved documents that are relevant. Example (top-5): * For a single SampleQuery, If 4 out of 5 retrieved documents in the top-5 are relevant, precision@5 = 4/5 = 0.8", "$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics" }, "pageRecall": { "$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics", "description": "Recall per page, at various top-k cutoff levels. Recall is the fraction of relevant pages retrieved out of all relevant pages. Example (top-5): * For a single SampleQuery, if 3 out of 5 relevant pages are retrieved in the top-5, recall@5 = 3/5 = 0.6" }, "pageNdcg": { "description": "Normalized discounted cumulative gain (NDCG) per page, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved pages (P1, P2, P3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [P3 (0), P1 (1), P2 (1)] Ideal: [P1 (1), P2 (1), P3 (0)] Calculate NDCG@3 for SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693", "$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics" }, "docNdcg": { "description": "Normalized discounted cumulative gain (NDCG) per document, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved documents (D1, D2, D3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [D3 (0), D1 (1), D2 (1)] Ideal: [D1 (1), D2 (1), D3 (0)] Calculate NDCG@3 for each SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693", "$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics" }, "docRecall": { "$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics", "description": "Recall per document, at various top-k cutoff levels. Recall is the fraction of relevant documents retrieved out of all relevant documents. Example (top-5): * For a single SampleQuery, If 3 out of 5 relevant documents are retrieved in the top-5, recall@5 = 3/5 = 0.6" } }, "type": "object", "description": "Describes the metrics produced by the evaluation.", "id": "GoogleCloudDiscoveryengineV1alphaQualityMetrics" }, "GoogleMonitoringV3TypedValue": { "type": "object", "description": "A single strongly-typed value.", "id": "GoogleMonitoringV3TypedValue", "properties": { "distributionValue": { "$ref": "GoogleApiDistribution", "description": "A distribution value." }, "stringValue": { "description": "A variable-length string value.", "type": "string" }, "boolValue": { "description": "A Boolean value: `true` or `false`.", "type": "boolean" }, "int64Value": { "format": "int64", "type": "string", "description": "A 64-bit integer. Its range is approximately ±9.2x1018." }, "doubleValue": { "description": "A 64-bit double-precision floating-point number. Its magnitude is approximately ±10±300 and it has 16 significant digits of precision.", "format": "double", "type": "number" } } }, "GoogleCloudDiscoveryengineV1AssistantContentFile": { "id": "GoogleCloudDiscoveryengineV1AssistantContentFile", "description": "A file, e.g., an audio summary.", "properties": { "mimeType": { "description": "Required. The media type (MIME type) of the file.", "type": "string" }, "fileId": { "description": "Required. The file ID.", "type": "string" } }, "type": "object" }, "GoogleCloudDiscoveryengineV1alphaCreateEngineMetadata": { "id": "GoogleCloudDiscoveryengineV1alphaCreateEngineMetadata", "description": "Metadata related to the progress of the EngineService.CreateEngine operation. This will be returned by the google.longrunning.Operation.metadata field.", "type": "object", "properties": { "updateTime": { "type": "string", "format": "google-datetime", "description": "Operation last update time. If the operation is done, this is also the finish time." }, "createTime": { "description": "Operation create time.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudDiscoveryengineV1betaUserStore": { "description": "Configures metadata that is used for End User entities.", "type": "object", "properties": { "displayName": { "description": "The display name of the User Store.", "type": "string" }, "enableLicenseAutoRegister": { "description": "Optional. Whether to enable license auto register for users in this User Store. If true, new users will automatically register under the default license config as long as the default license config has seats left.", "type": "boolean" }, "name": { "description": "Immutable. The full resource name of the User Store, in the format of `projects/{project}/locations/{location}/userStores/{user_store}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", "type": "string" }, "defaultLicenseConfig": { "description": "Optional. The default subscription LicenseConfig for the UserStore, if UserStore.enable_license_auto_register is true, new users will automatically register under the default subscription. If default LicenseConfig doesn't have remaining license seats left, new users will not be assigned with license and will be blocked for Vertex AI Search features. This is used if `license_assignment_tier_rules` is not configured.", "type": "string" }, "enableExpiredLicenseAutoUpdate": { "description": "Optional. Whether to enable license auto update for users in this User Store. If true, users with expired licenses will automatically be updated to use the default license config as long as the default license config has seats left.", "type": "boolean" } }, "id": "GoogleCloudDiscoveryengineV1betaUserStore" }, "GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec": { "type": "object", "description": "A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned.", "properties": { "numResults": { "description": "Optional. The maximum number of results to retrieve from this data store. If not specified, it will use the SearchRequest.num_results_per_data_store if provided, otherwise there is no limit. If both this field and SearchRequest.num_results_per_data_store are specified, this field will be used.", "format": "int32", "type": "integer" }, "customSearchOperators": { "description": "Optional. Custom search operators which if specified will be used to filter results from workspace data stores. For more information on custom search operators, see [SearchOperators](https://support.google.com/cloudsearch/answer/6172299).", "type": "string" }, "dataStore": { "type": "string", "description": "Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. The path must include the project number, project id is not supported for this field." }, "boostSpec": { "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec", "description": "Optional. Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)" }, "filter": { "description": "Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)", "type": "string" } }, "id": "GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec" }, "GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchResponse": { "properties": {}, "type": "object", "description": "Response message for SiteSearchEngineService.DisableAdvancedSiteSearch method.", "id": "GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchResponse" }, "GoogleCloudDiscoveryengineV1alphaProjectServiceTerms": { "type": "object", "description": "Metadata about the terms of service.", "id": "GoogleCloudDiscoveryengineV1alphaProjectServiceTerms", "properties": { "declineTime": { "description": "The last time when the project declined or revoked the agreement to terms of service.", "format": "google-datetime", "type": "string" }, "id": { "description": "The unique identifier of this terms of service. Available terms: * `GA_DATA_USE_TERMS`: [Terms for data use](https://cloud.google.com/retail/data-use-terms). When using this as `id`, the acceptable version to provide is `2022-11-23`.", "type": "string" }, "version": { "type": "string", "description": "The version string of the terms of service. For acceptable values, see the comments for id above." }, "state": { "type": "string", "description": "Whether the project has accepted/rejected the service terms or it is still pending.", "enum": [ "STATE_UNSPECIFIED", "TERMS_ACCEPTED", "TERMS_PENDING", "TERMS_DECLINED" ], "enumDescriptions": [ "The default value of the enum. This value is not actually used.", "The project has given consent to the terms of service.", "The project is pending to review and accept the terms of service.", "The project has declined or revoked the agreement to terms of service." ] }, "acceptTime": { "format": "google-datetime", "description": "The last time when the project agreed to the terms of service.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigEngineFeaturesConfig": { "type": "object", "id": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigEngineFeaturesConfig", "description": "More feature configs of the selected engine type.", "properties": { "recommendedForYouConfig": { "$ref": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig", "description": "Recommended for you engine feature config." }, "mostPopularConfig": { "description": "Most popular engine feature config.", "$ref": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigMostPopularFeatureConfig" } } }, "GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchResponse": { "type": "object", "id": "GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchResponse", "properties": {}, "description": "Response message for SiteSearchEngineService.EnableAdvancedSiteSearch method." }, "GoogleCloudDiscoveryengineV1EngineKnowledgeGraphConfig": { "type": "object", "description": "Configuration message for the Knowledge Graph.", "properties": { "privateKnowledgeGraphTypes": { "description": "Specify entity types to support.", "items": { "type": "string" }, "type": "array" }, "enableCloudKnowledgeGraph": { "description": "Whether to enable the Cloud Knowledge Graph for the engine. Defaults to false if not specified.", "type": "boolean" }, "featureConfig": { "$ref": "GoogleCloudDiscoveryengineV1EngineKnowledgeGraphConfigFeatureConfig", "description": "Optional. Feature config for the Knowledge Graph." }, "enablePrivateKnowledgeGraph": { "type": "boolean", "description": "Whether to enable the Private Knowledge Graph for the engine. Defaults to false if not specified." }, "cloudKnowledgeGraphTypes": { "items": { "type": "string" }, "description": "Specify entity types to support.", "type": "array" } }, "id": "GoogleCloudDiscoveryengineV1EngineKnowledgeGraphConfig" }, "GoogleCloudDiscoveryengineV1SessionConfig": { "type": "object", "description": "Configuration for the session.", "id": "GoogleCloudDiscoveryengineV1SessionConfig", "properties": { "sessionManagementPolicy": { "enumDescriptions": [ "Default value.", "The session will be managed by the customer.", "Sessions multi-tenancy will be controlled by Google using 1P or 3P identity providers." ], "type": "string", "enum": [ "SESSION_MANAGEMENT_POLICY_UNSPECIFIED", "NOT_MANAGED", "VERTEX_AI_MANAGED" ], "description": "Optional. Session management policy that defines who will manage the session." }, "sessionTtl": { "description": "Optional. The TTL for the session. If unset, the default value is 60 days.", "$ref": "GoogleCloudDiscoveryengineV1SessionConfigSessionTtl" } } }, "GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpec": { "description": "Relevance filtering specification.", "properties": { "semanticSearchThreshold": { "description": "Optional. Relevance filtering threshold specification for semantic search.", "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec" }, "keywordSearchThreshold": { "description": "Optional. Relevance filtering threshold specification for keyword search.", "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec" } }, "type": "object", "id": "GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpec" }, "GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadataVisualSegment": { "description": "Grounding information for a visual segment.", "id": "GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadataVisualSegment", "properties": { "contentId": { "description": "The content id of the visual segment. In order to display the citation of the visual element, this content_id needs to match with the `grounded_content.content_metadata.content_id` field.", "type": "string" }, "referenceIndices": { "type": "array", "items": { "format": "int32", "type": "integer" }, "description": "References for the visual segment." } }, "type": "object" }, "GoogleMonitoringV3Point": { "id": "GoogleMonitoringV3Point", "type": "object", "description": "A single data point in a time series.", "properties": { "interval": { "description": "The time interval to which the data point applies. For `GAUGE` metrics, the start time is optional, but if it is supplied, it must equal the end time. For `DELTA` metrics, the start and end time should specify a non-zero interval, with subsequent points specifying contiguous and non-overlapping intervals. For `CUMULATIVE` metrics, the start and end time should specify a non-zero interval, with subsequent points specifying the same start time and increasing end times, until an event resets the cumulative value to zero and sets a new start time for the following points.", "$ref": "GoogleMonitoringV3TimeInterval" }, "value": { "description": "The value of the data point.", "$ref": "GoogleMonitoringV3TypedValue" } } }, "GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchMetadata": { "type": "object", "description": "Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.", "properties": { "updateTime": { "format": "google-datetime", "description": "Operation last update time. If the operation is done, this is also the finish time.", "type": "string" }, "createTime": { "type": "string", "description": "Operation create time.", "format": "google-datetime" } }, "id": "GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchMetadata" }, "GoogleCloudDiscoveryengineV1DeleteTargetSiteMetadata": { "description": "Metadata related to the progress of the SiteSearchEngineService.DeleteTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", "properties": { "createTime": { "format": "google-datetime", "description": "Operation create time.", "type": "string" }, "updateTime": { "format": "google-datetime", "type": "string", "description": "Operation last update time. If the operation is done, this is also the finish time." } }, "type": "object", "id": "GoogleCloudDiscoveryengineV1DeleteTargetSiteMetadata" }, "GoogleCloudDiscoveryengineV1alphaDeleteSitemapMetadata": { "id": "GoogleCloudDiscoveryengineV1alphaDeleteSitemapMetadata", "type": "object", "description": "Metadata related to the progress of the SiteSearchEngineService.DeleteSitemap operation. This will be returned by the google.longrunning.Operation.metadata field.", "properties": { "updateTime": { "description": "Operation last update time. If the operation is done, this is also the finish time.", "type": "string", "format": "google-datetime" }, "createTime": { "type": "string", "format": "google-datetime", "description": "Operation create time." } } }, "GoogleCloudDiscoveryengineV1betaProjectConfigurableBillingStatus": { "description": "Represents the currently effective configurable billing parameters. These values are derived from the customer's subscription history stored internally and reflect the thresholds actively being used for billing purposes at the time of the GetProject call. This includes the start_time of the subscription and may differ from the values in `customer_provided_config` due to billing rules (e.g., scale-downs taking effect only at the start of a new month). We also include the update type to indicate the type of update performed on the configurable billing configuration in the UpdateProject operation.", "id": "GoogleCloudDiscoveryengineV1betaProjectConfigurableBillingStatus", "type": "object", "properties": { "updateType": { "enumDescriptions": [ "Unspecified update type.", "Configurable billing was created/enabled.", "Configurable billing was deleted/disabled.", "Subscription was scaled up (thresholds increased).", "Subscription was scaled down (thresholds decreased)." ], "type": "string", "readOnly": true, "description": "Output only. The type of update performed in this operation. This field is populated in the response of UpdateProject.", "enum": [ "UPDATE_TYPE_UNSPECIFIED", "CREATE", "DELETE", "SCALE_UP", "SCALE_DOWN" ] }, "searchQpmThresholdNextUpdateTime": { "description": "Output only. The earliest next update time for the search QPM subscription threshold. This is based on the next_update_time returned by the underlying Cloud Billing Subscription V3 API. This field is populated only if an update QPM subscription threshold request is succeeded.", "type": "string", "readOnly": true, "format": "google-datetime" }, "startTime": { "type": "string", "format": "google-datetime", "description": "Optional. The start time of the currently active billing subscription." }, "agentSearchTokenSubscriptionStatuses": { "description": "Output only. Per-model Agent Search TPM subscription status.", "items": { "$ref": "GoogleCloudDiscoveryengineV1betaProjectConfigurableBillingStatusAgentSearchTokenSubscriptionStatus" }, "type": "array", "readOnly": true }, "effectiveSearchQpmThreshold": { "type": "string", "description": "Optional. The currently effective Search QPM threshold in queries per minute. This is the threshold against which QPM usage is compared for overage calculations.", "format": "int64" }, "indexingCoreThresholdNextUpdateTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The earliest next update time for the indexing core subscription threshold. This is based on the next_update_time returned by the underlying Cloud Billing Subscription V3 API. This field is populated only if an update indexing core subscription threshold request is succeeded.", "type": "string" }, "terminateTime": { "type": "string", "readOnly": true, "format": "google-datetime", "description": "Output only. The latest terminate effective time of search qpm and indexing core subscriptions." }, "effectiveIndexingCoreThreshold": { "description": "Optional. The currently effective Indexing Core threshold. This is the threshold against which Indexing Core usage is compared for overage calculations.", "format": "int64", "type": "string" } } }, "GoogleCloudDiscoveryengineV1WidgetConfigHomepageSetting": { "description": "Describes the homepage setting of the widget. It includes all homepage related settings and configurations, such as shortcuts.", "properties": { "shortcuts": { "items": { "$ref": "GoogleCloudDiscoveryengineV1WidgetConfigHomepageSettingShortcut" }, "type": "array", "description": "Optional. The shortcuts to display on the homepage." } }, "id": "GoogleCloudDiscoveryengineV1WidgetConfigHomepageSetting", "type": "object" }, "GoogleCloudDiscoveryengineV1SearchRequestRelevanceScoreSpec": { "type": "object", "properties": { "returnRelevanceScore": { "description": "Optional. Whether to return the relevance score for search results. The higher the score, the more relevant the document is to the query.", "type": "boolean" } }, "description": "The specification for returning the document relevance score.", "id": "GoogleCloudDiscoveryengineV1SearchRequestRelevanceScoreSpec" }, "GoogleCloudDiscoveryengineV1alphaImportUserEventsResponse": { "id": "GoogleCloudDiscoveryengineV1alphaImportUserEventsResponse", "description": "Response of the ImportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.", "properties": { "errorConfig": { "description": "Echoes the destination for the complete errors if this field was set in the request.", "$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig" }, "joinedEventsCount": { "type": "string", "description": "Count of user events imported with complete existing Documents.", "format": "int64" }, "unjoinedEventsCount": { "format": "int64", "description": "Count of user events imported, but with Document information not found in the existing Branch.", "type": "string" }, "errorSamples": { "items": { "$ref": "GoogleRpcStatus" }, "type": "array", "description": "A sample of errors encountered while processing the request." } }, "type": "object" }, "GoogleCloudDiscoveryengineV1CreateSitemapMetadata": { "description": "Metadata related to the progress of the SiteSearchEngineService.CreateSitemap operation. This will be returned by the google.longrunning.Operation.metadata field.", "properties": { "updateTime": { "format": "google-datetime", "type": "string", "description": "Operation last update time. If the operation is done, this is also the finish time." }, "createTime": { "description": "Operation create time.", "type": "string", "format": "google-datetime" } }, "id": "GoogleCloudDiscoveryengineV1CreateSitemapMetadata", "type": "object" }, "GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec": { "properties": { "filter": { "type": "string", "description": "Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)" }, "dataStore": { "type": "string", "description": "Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. The path must include the project number, project id is not supported for this field." }, "boostSpec": { "description": "Optional. Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)", "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec" }, "customSearchOperators": { "description": "Optional. Custom search operators which if specified will be used to filter results from workspace data stores. For more information on custom search operators, see [SearchOperators](https://support.google.com/cloudsearch/answer/6172299).", "type": "string" }, "numResults": { "format": "int32", "description": "Optional. The maximum number of results to retrieve from this data store. If not specified, it will use the SearchRequest.num_results_per_data_store if provided, otherwise there is no limit. If both this field and SearchRequest.num_results_per_data_store are specified, this field will be used.", "type": "integer" } }, "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec", "description": "A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned.", "type": "object" }, "GoogleCloudDiscoveryengineV1WidgetConfigUiSettingsModelConfigInfoResolvedModelAdminView": { "properties": { "enabledByDefault": { "type": "boolean", "description": "Output only. Whether the model is enabled when the admin has set no explicit override in `UiSettings.model_configs`. Derived from `MODEL_TAG_ENABLED_BY_DEFAULT`.", "readOnly": true }, "regions": { "type": "array", "description": "Output only. Regions where this model is launched.", "items": { "type": "string" }, "readOnly": true }, "adminOverridable": { "description": "Output only. Whether the admin can toggle this model's enabled/disabled state via `UiSettings.model_configs`. Derived from `MODEL_TAG_ADMIN_OVERRIDABLE`. When false, the model is \"forced\" and its state is governed by `enabled_by_default`.", "readOnly": true, "type": "boolean" } }, "description": "Admin-surface metadata. Populated only when the request originates from the Cloud Console admin \"Feature Control\" page; left unset for end-user surfaces (Web, Mobile). Lets the admin page render its toggle table directly from the backend instead of a hardcoded client-side registry.", "type": "object", "id": "GoogleCloudDiscoveryengineV1WidgetConfigUiSettingsModelConfigInfoResolvedModelAdminView" }, "GoogleCloudDiscoveryengineV1betaPurgeDocumentsMetadata": { "description": "Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.", "properties": { "successCount": { "description": "Count of entries that were deleted successfully.", "type": "string", "format": "int64" }, "failureCount": { "format": "int64", "type": "string", "description": "Count of entries that encountered errors while processing." }, "ignoredCount": { "type": "string", "format": "int64", "description": "Count of entries that were ignored as entries were not found." }, "createTime": { "type": "string", "description": "Operation create time.", "format": "google-datetime" }, "updateTime": { "description": "Operation last update time. If the operation is done, this is also the finish time.", "format": "google-datetime", "type": "string" } }, "id": "GoogleCloudDiscoveryengineV1betaPurgeDocumentsMetadata", "type": "object" }, "GoogleCloudDiscoveryengineV1ChunkDocumentMetadata": { "id": "GoogleCloudDiscoveryengineV1ChunkDocumentMetadata", "description": "Document metadata contains the information of the document of the current chunk.", "properties": { "uri": { "description": "Uri of the document.", "type": "string" }, "structData": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "description": "Data representation. The structured JSON data for the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown.", "type": "object" }, "title": { "type": "string", "description": "Title of the document." }, "mimeType": { "description": "The mime type of the document. https://www.iana.org/assignments/media-types/media-types.xhtml.", "type": "string" } }, "type": "object" }, "A2aV1AuthorizationCodeOAuthFlow": { "type": "object", "id": "A2aV1AuthorizationCodeOAuthFlow", "properties": { "authorizationUrl": { "description": "The authorization URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS", "type": "string" }, "refreshUrl": { "description": "The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS.", "type": "string" }, "scopes": { "type": "object", "description": "The available scopes for the OAuth2 security scheme. A map between the scope name and a short description for it. The map MAY be empty.", "additionalProperties": { "type": "string" } }, "tokenUrl": { "description": "The token URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1DataConnectorConnectorMetadata": { "type": "object", "description": "User-facing metadata for the connector, shown on the connector detail page (title, description, short_description, author, note).", "id": "GoogleCloudDiscoveryengineV1DataConnectorConnectorMetadata", "properties": { "description": { "type": "string", "description": "Optional. Human-readable description of the connector, shown on the connector detail page. One connector has a single description." }, "author": { "description": "Optional. The party that authored the connector, e.g. \"Google\" or a third-party provider name. Lets end users see who authored a connector (future: third-party-authored connectors).", "type": "string" }, "shortDescription": { "type": "string", "description": "Optional. Short, subtitle-length description of the connector (e.g. shown beneath the connector name in list and detail views)." }, "note": { "description": "Optional. Free-form, multi-line note about the connector's capabilities or a custom note that can be set for the connector.", "type": "string" }, "title": { "type": "string", "description": "Optional. Display title of the connector." } } }, "GoogleCloudDiscoveryengineV1betaControlFilterAction": { "description": "Specified which products may be included in results. Uses same filter as boost.", "id": "GoogleCloudDiscoveryengineV1betaControlFilterAction", "type": "object", "properties": { "dataStore": { "type": "string", "description": "Required. Specifies which data store's documents can be filtered by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store" }, "filter": { "type": "string", "description": "Required. A filter to apply on the matching condition results. Required Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown." } } }, "GoogleCloudDiscoveryengineV1alphaAnswerReference": { "description": "Reference.", "type": "object", "properties": { "unstructuredDocumentInfo": { "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo", "description": "Unstructured document information." }, "structuredDocumentInfo": { "description": "Structured document information.", "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo" }, "chunkInfo": { "description": "Chunk information.", "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo" } }, "id": "GoogleCloudDiscoveryengineV1alphaAnswerReference" }, "GoogleCloudDiscoveryengineV1betaBatchUpdateUserLicensesResponse": { "description": "Response message for UserLicenseService.BatchUpdateUserLicenses method.", "type": "object", "properties": { "userLicenses": { "type": "array", "description": "UserLicenses successfully updated.", "items": { "$ref": "GoogleCloudDiscoveryengineV1betaUserLicense" } }, "errorSamples": { "description": "A sample of errors encountered while processing the request.", "type": "array", "items": { "$ref": "GoogleRpcStatus" } } }, "id": "GoogleCloudDiscoveryengineV1betaBatchUpdateUserLicensesResponse" }, "GoogleCloudDiscoveryengineV1StreamAssistRequestToolsSpecVertexAiSearchSpec": { "properties": { "filter": { "description": "Optional. The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customer might have a field 'name' in their schema. In this case the filter would look like this: filter --\u003e name:'ANY(\"king kong\")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)", "type": "string" }, "dataStoreSpecs": { "items": { "$ref": "GoogleCloudDiscoveryengineV1SearchRequestDataStoreSpec" }, "description": "Optional. Specs defining DataStores to filter on in a search call and configurations for those data stores. This is only considered for Engines with multiple data stores.", "type": "array" } }, "description": "Specification of the Vertex AI Search tool.", "type": "object", "id": "GoogleCloudDiscoveryengineV1StreamAssistRequestToolsSpecVertexAiSearchSpec" }, "GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec": { "type": "object", "description": "Specification to enable natural language understanding capabilities for search requests.", "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec", "properties": { "geoSearchQueryDetectionFieldNames": { "type": "array", "items": { "type": "string" }, "description": "Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`." }, "filterExtractionCondition": { "enum": [ "CONDITION_UNSPECIFIED", "DISABLED", "ENABLED" ], "enumDescriptions": [ "Server behavior defaults to `DISABLED`.", "Disables NL filter extraction.", "Enables NL filter extraction." ], "description": "The condition under which filter extraction should occur. Server behavior defaults to `DISABLED`.", "type": "string" }, "allowedFieldNames": { "description": "Optional. Allowlist of fields that can be used for natural language filter extraction. By default, if this is unspecified, all indexable fields are eligible for natural language filter extraction (but are not guaranteed to be used). If any fields are specified in allowed_field_names, only the fields that are both marked as indexable in the schema and specified in the allowlist will be eligible for natural language filter extraction. Note: for multi-datastore search, this is not yet supported, and will be ignored.", "items": { "type": "string" }, "type": "array" }, "extractedFilterBehavior": { "enumDescriptions": [ "`EXTRACTED_FILTER_BEHAVIOR_UNSPECIFIED` will use the default behavior for extracted filters. For single datastore search, the default is to apply as hard filters. For multi-datastore search, the default is to apply as soft boosts.", "Applies all extracted filters as hard filters on the results. Results that do not pass the extracted filters will not be returned in the result set.", "Applies all extracted filters as soft boosts. Results that pass the filters will be boosted up to higher ranks in the result set." ], "description": "Optional. Controls behavior of how extracted filters are applied to the search. The default behavior depends on the request. For single datastore structured search, the default is `HARD_FILTER`. For multi-datastore search, the default behavior is `SOFT_BOOST`. Location-based filters are always applied as hard filters, and the `SOFT_BOOST` setting will not affect them. This field is only used if SearchRequest.NaturalLanguageQueryUnderstandingSpec.FilterExtractionCondition is set to FilterExtractionCondition.ENABLED.", "type": "string", "enum": [ "EXTRACTED_FILTER_BEHAVIOR_UNSPECIFIED", "HARD_FILTER", "SOFT_BOOST" ] } } }, "GoogleCloudDiscoveryengineV1alphaDataStoreBillingEstimation": { "type": "object", "description": "Estimation of data size per data store.", "properties": { "unstructuredDataSize": { "type": "string", "format": "int64", "description": "Data size for unstructured data in terms of bytes." }, "websiteDataSize": { "type": "string", "description": "Data size for websites in terms of bytes.", "format": "int64" }, "structuredDataUpdateTime": { "type": "string", "description": "Last updated timestamp for structured data.", "format": "google-datetime" }, "unstructuredDataUpdateTime": { "format": "google-datetime", "description": "Last updated timestamp for unstructured data.", "type": "string" }, "structuredDataSize": { "description": "Data size for structured data in terms of bytes.", "type": "string", "format": "int64" }, "websiteDataUpdateTime": { "type": "string", "format": "google-datetime", "description": "Last updated timestamp for websites." } }, "id": "GoogleCloudDiscoveryengineV1alphaDataStoreBillingEstimation" }, "GoogleCloudDiscoveryengineV1alphaCreateDataStoreMetadata": { "description": "Metadata related to the progress of the DataStoreService.CreateDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.", "properties": { "createTime": { "description": "Operation create time.", "type": "string", "format": "google-datetime" }, "updateTime": { "type": "string", "format": "google-datetime", "description": "Operation last update time. If the operation is done, this is also the finish time." } }, "id": "GoogleCloudDiscoveryengineV1alphaCreateDataStoreMetadata", "type": "object" }, "GoogleCloudDiscoveryengineV1GroundingFact": { "id": "GoogleCloudDiscoveryengineV1GroundingFact", "type": "object", "properties": { "factText": { "description": "Text content of the fact. Can be at most 10K characters long.", "type": "string" }, "attributes": { "description": "Attributes associated with the fact. Common attributes include `source` (indicating where the fact was sourced from), `author` (indicating the author of the fact), and so on.", "type": "object", "additionalProperties": { "type": "string" } } }, "description": "Grounding Fact." }, "GoogleCloudDiscoveryengineV1alphaAnswerBlobAttachment": { "id": "GoogleCloudDiscoveryengineV1alphaAnswerBlobAttachment", "type": "object", "properties": { "data": { "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerBlobAttachmentBlob", "readOnly": true, "description": "Output only. The mime type and data of the blob." }, "attributionType": { "enumDescriptions": [ "Unspecified attribution type.", "The attachment data is from the corpus.", "The attachment data is generated by the model through code generation." ], "type": "string", "readOnly": true, "description": "Output only. The attribution type of the blob.", "enum": [ "ATTRIBUTION_TYPE_UNSPECIFIED", "CORPUS", "GENERATED" ] } }, "description": "Stores binarydata attached to text answer, e.g. image, video, audio, etc." }, "GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchResponse": { "type": "object", "description": "Response message for SiteSearchEngineService.DisableAdvancedSiteSearch method.", "properties": {}, "id": "GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchResponse" }, "GoogleCloudDiscoveryengineV1CloudSqlSource": { "id": "GoogleCloudDiscoveryengineV1CloudSqlSource", "properties": { "instanceId": { "description": "Required. The Cloud SQL instance to copy the data from with a length limit of 256 characters.", "type": "string" }, "tableId": { "description": "Required. The Cloud SQL table to copy the data from with a length limit of 256 characters.", "type": "string" }, "databaseId": { "description": "Required. The Cloud SQL database to copy the data from with a length limit of 256 characters.", "type": "string" }, "offload": { "description": "Option for serverless export. Enabling this option will incur additional cost. More info can be found [here](https://cloud.google.com/sql/pricing#serverless).", "type": "boolean" }, "projectId": { "description": "The project ID that contains the Cloud SQL source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request.", "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 Cloud SQL export to a specific Cloud Storage directory. Ensure that the Cloud SQL service account has the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory.", "type": "string" } }, "type": "object", "description": "Cloud SQL source import data from." }, "GoogleCloudDiscoveryengineV1DeleteCmekConfigMetadata": { "id": "GoogleCloudDiscoveryengineV1DeleteCmekConfigMetadata", "type": "object", "properties": { "createTime": { "description": "Operation create time.", "type": "string", "format": "google-datetime" }, "updateTime": { "description": "Operation last update time. If the operation is done, this is also the finish time.", "format": "google-datetime", "type": "string" } }, "description": "Metadata related to the progress of the CmekConfigService.DeleteCmekConfig operation. This will be returned by the google.longrunning.Operation.metadata field." }, "GoogleCloudDiscoveryengineV1alphaDeleteDataStoreMetadata": { "properties": { "updateTime": { "type": "string", "description": "Operation last update time. If the operation is done, this is also the finish time.", "format": "google-datetime" }, "createTime": { "type": "string", "format": "google-datetime", "description": "Operation create time." } }, "type": "object", "description": "Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1alphaDeleteDataStoreMetadata" }, "GoogleCloudDiscoveryengineV1betaSessionConfigSessionTtl": { "properties": { "days": { "format": "int32", "description": "Defines the number of days for session TTL.", "type": "integer" } }, "description": "Defines the TTL for sessions.", "id": "GoogleCloudDiscoveryengineV1betaSessionConfigSessionTtl", "type": "object" }, "GoogleCloudDiscoveryengineV1betaUserInfoPreciseLocation": { "properties": { "point": { "description": "Optional. Location represented by a latitude/longitude point.", "$ref": "GoogleTypeLatLng" }, "address": { "description": "Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon.", "type": "string" } }, "description": "Precise location info with multiple representation options.", "type": "object", "id": "GoogleCloudDiscoveryengineV1betaUserInfoPreciseLocation" }, "GoogleCloudDiscoveryengineV1SearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterAndExpression": { "type": "object", "id": "GoogleCloudDiscoveryengineV1SearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterAndExpression", "properties": { "expressions": { "items": { "$ref": "GoogleCloudDiscoveryengineV1SearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterExpression" }, "description": "The expressions that were ANDed together.", "type": "array" } }, "description": "Logical `And` operator." }, "GoogleCloudDiscoveryengineV1CreateDataStoreMetadata": { "id": "GoogleCloudDiscoveryengineV1CreateDataStoreMetadata", "description": "Metadata related to the progress of the DataStoreService.CreateDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.", "properties": { "createTime": { "format": "google-datetime", "type": "string", "description": "Operation create time." }, "updateTime": { "type": "string", "description": "Operation last update time. If the operation is done, this is also the finish time.", "format": "google-datetime" } }, "type": "object" }, "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponseRecentSearchSuggestion": { "type": "object", "properties": { "suggestion": { "type": "string", "description": "The suggestion for the query." }, "score": { "description": "The score of each suggestion. The score is in the range of [0, 1].", "type": "number", "format": "double" }, "recentSearchTime": { "description": "The time when this recent rearch happened.", "type": "string", "format": "google-datetime" } }, "id": "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponseRecentSearchSuggestion", "description": "Suggestions from recent search history." }, "GoogleCloudDiscoveryengineV1AnswerReferenceStructuredDocumentInfo": { "properties": { "document": { "description": "Document resource name.", "type": "string" }, "uri": { "description": "Output only. The URI of the document.", "type": "string", "readOnly": true }, "title": { "type": "string", "readOnly": true, "description": "Output only. The title of the document." }, "structData": { "description": "Structured search data.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } } }, "type": "object", "id": "GoogleCloudDiscoveryengineV1AnswerReferenceStructuredDocumentInfo", "description": "Structured search information." }, "GoogleCloudDiscoveryengineV1alphaTuneEngineMetadata": { "description": "Metadata associated with a tune operation.", "id": "GoogleCloudDiscoveryengineV1alphaTuneEngineMetadata", "properties": { "engine": { "type": "string", "description": "Required. The resource name of the engine that this tune applies to. Format: `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`" } }, "type": "object" }, "GoogleCloudDiscoveryengineV1alphaTrainCustomModelResponse": { "description": "Response of the TrainCustomModelRequest. This message is returned by the google.longrunning.Operations.response field.", "type": "object", "id": "GoogleCloudDiscoveryengineV1alphaTrainCustomModelResponse", "properties": { "errorSamples": { "items": { "$ref": "GoogleRpcStatus" }, "type": "array", "description": "A sample of errors encountered while processing the data." }, "metrics": { "description": "The metrics of the trained model.", "additionalProperties": { "format": "double", "type": "number" }, "type": "object" }, "modelName": { "type": "string", "description": "Fully qualified name of the CustomTuningModel." }, "errorConfig": { "$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", "description": "Echoes the destination for the complete errors in the request if set." }, "modelStatus": { "type": "string", "description": "The trained model status. Possible values are: * **bad-data**: The training data quality is bad. * **no-improvement**: Tuning didn't improve performance. Won't deploy. * **in-progress**: Model training job creation is in progress. * **training**: Model is actively training. * **evaluating**: The model is evaluating trained metrics. * **indexing**: The model trained metrics are indexing. * **ready**: The model is ready for serving." } } }, "GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec": { "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec", "properties": { "pinUnexpandedResults": { "type": "boolean", "description": "Whether to pin unexpanded results. If this field is set to true, unexpanded products are always at the top of the search results, followed by the expanded results." }, "condition": { "type": "string", "description": "The condition under which query expansion should occur. Default to Condition.DISABLED.", "enum": [ "CONDITION_UNSPECIFIED", "DISABLED", "AUTO" ], "enumDescriptions": [ "Unspecified query expansion condition. In this case, server behavior defaults to Condition.DISABLED.", "Disabled query expansion. Only the exact search query is used, even if SearchResponse.total_size is zero.", "Automatic query expansion built by the Search API." ] } }, "type": "object", "description": "Specification to determine under which conditions query expansion should occur." }, "GoogleCloudDiscoveryengineV1CheckGroundingResponseCheckGroundingFactChunk": { "type": "object", "properties": { "chunkText": { "type": "string", "description": "Text content of the fact chunk. Can be at most 10K characters long." } }, "description": "Fact chunk for grounding check.", "id": "GoogleCloudDiscoveryengineV1CheckGroundingResponseCheckGroundingFactChunk" }, "GoogleCloudDiscoveryengineV1StreamAssistRequestAgentsSpecAgentSpec": { "type": "object", "description": "Specification of an agent.", "properties": { "agentId": { "description": "Required. ID to identify the agent resource serving the request. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) with a length limit of 63 characters.", "type": "string" } }, "id": "GoogleCloudDiscoveryengineV1StreamAssistRequestAgentsSpecAgentSpec" }, "GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig": { "properties": { "responseTemplate": { "description": "Optional. The resource name of the Model Armor Template for sanitizing LLM responses. Format: projects/{project}/locations/{location}/templates/{template_id} If not specified, no sanitization will be applied to the LLM response.", "type": "string" }, "userPromptTemplate": { "description": "Optional. The resource name of the Model Armor Template for sanitizing user prompts. Format: projects/{project}/locations/{location}/templates/{template_id} If not specified, no sanitization will be applied to the user prompt.", "type": "string" } }, "id": "GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig", "description": "Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and LLM responses.", "type": "object" }, "GoogleCloudDiscoveryengineV1IdpConfigExternalIdpConfig": { "id": "GoogleCloudDiscoveryengineV1IdpConfigExternalIdpConfig", "type": "object", "description": "Third party IDP Config.", "properties": { "workforcePoolName": { "description": "Workforce pool name. Example: \"locations/global/workforcePools/pool_id\"", "type": "string" } } }, "GoogleCloudDiscoveryengineV1betaImportErrorConfig": { "type": "object", "properties": { "gcsPrefix": { "description": "Cloud Storage prefix for import errors. This must be an empty, existing Cloud Storage directory. Import errors are written to sharded files in this directory, one per line, as a JSON-encoded `google.rpc.Status` message.", "type": "string" } }, "id": "GoogleCloudDiscoveryengineV1betaImportErrorConfig", "description": "Configuration of destination for Import related errors." }, "GoogleCloudDiscoveryengineV1alphaDataStore": { "description": "DataStore captures global settings and configs at the DataStore level.", "type": "object", "properties": { "displayName": { "description": "Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.", "type": "string" }, "documentProcessingConfig": { "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig", "description": "Configuration for Document understanding and enrichment." }, "identityMappingStore": { "description": "Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`.", "type": "string" }, "healthcareFhirConfig": { "description": "Optional. Configuration for `HEALTHCARE_FHIR` vertical.", "$ref": "GoogleCloudDiscoveryengineV1alphaHealthcareFhirConfig" }, "iconUri": { "readOnly": true, "description": "Output only. Provides the icon URI of the data store's connector source, if this is a connector-backed data store. Empty for data stores without an associated connector source. In DataStoreService.ListDataStores and DataStoreService.GetDataStore, this is only populated when DataStoreView.DATA_STORE_VIEW_FULL is requested via ListDataStoresRequest.view or GetDataStoreRequest.view respectively.", "type": "string" }, "contentConfig": { "enum": [ "CONTENT_CONFIG_UNSPECIFIED", "NO_CONTENT", "CONTENT_REQUIRED", "PUBLIC_WEBSITE", "GOOGLE_WORKSPACE" ], "enumDescriptions": [ "Default value.", "Only contains documents without any Document.content.", "Only contains documents with Document.content.", "The data store is used for public website search.", "The data store is used for workspace search. Details of workspace data store are specified in the WorkspaceConfig." ], "type": "string", "description": "Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT." }, "workspaceConfig": { "description": "Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE.", "$ref": "GoogleCloudDiscoveryengineV1alphaWorkspaceConfig" }, "aclEnabled": { "type": "boolean", "description": "Immutable. Whether data in the DataStore has ACL information. If set to `true`, the source data must have ACL. ACL will be ingested when data is ingested by DocumentService.ImportDocuments methods. When ACL is enabled for the DataStore, Document can't be accessed by calling DocumentService.GetDocument or DocumentService.ListDocuments. Currently ACL is only supported in `GENERIC` industry vertical with non-`PUBLIC_WEBSITE` content config." }, "idpConfig": { "readOnly": true, "$ref": "GoogleCloudDiscoveryengineV1alphaIdpConfig", "description": "Output only. Data store level identity provider config." }, "startingSchema": { "$ref": "GoogleCloudDiscoveryengineV1alphaSchema", "description": "The start schema to use for this DataStore when provisioning it. If unset, a default vertical specialized schema will be used. This field is only used by CreateDataStore API, and will be ignored if used in other APIs. This field will be omitted from all API responses including CreateDataStore API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema)." }, "defaultSchemaId": { "readOnly": true, "description": "Output only. The id of the default Schema associated to this data store.", "type": "string" }, "advancedSiteSearchConfig": { "$ref": "GoogleCloudDiscoveryengineV1alphaAdvancedSiteSearchConfig", "description": "Optional. Configuration for advanced site search." }, "dataProtectionPolicy": { "description": "Optional. Specifies the data protection policy for the data store.", "$ref": "GoogleCloudDiscoveryengineV1alphaDataProtectionPolicy" }, "createTime": { "type": "string", "format": "google-datetime", "readOnly": true, "description": "Output only. Timestamp the DataStore was created at." }, "solutionTypes": { "description": "The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled.", "type": "array", "items": { "enumDescriptions": [ "Default value.", "Used for Recommendations AI.", "Used for Discovery Search.", "Used for use cases related to the Generative AI agent.", "Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution.", "Used for AI Mode." ], "type": "string", "enum": [ "SOLUTION_TYPE_UNSPECIFIED", "SOLUTION_TYPE_RECOMMENDATION", "SOLUTION_TYPE_SEARCH", "SOLUTION_TYPE_CHAT", "SOLUTION_TYPE_GENERATIVE_CHAT", "SOLUTION_TYPE_AI_MODE" ] } }, "cmekConfig": { "readOnly": true, "$ref": "GoogleCloudDiscoveryengineV1alphaCmekConfig", "description": "Output only. CMEK-related information for the DataStore." }, "billingEstimation": { "$ref": "GoogleCloudDiscoveryengineV1alphaDataStoreBillingEstimation", "readOnly": true, "description": "Output only. Data size estimation for billing." }, "languageInfo": { "description": "Language info for DataStore.", "$ref": "GoogleCloudDiscoveryengineV1alphaLanguageInfo" }, "servingConfigDataStore": { "$ref": "GoogleCloudDiscoveryengineV1alphaDataStoreServingConfigDataStore", "description": "Optional. Stores serving config at DataStore level." }, "kmsKeyName": { "type": "string", "description": "Input only. The KMS key to be used to protect this DataStore at creation time. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStore will be protected by the KMS key, as indicated in the cmek_config field." }, "configurableBillingApproachUpdateTime": { "type": "string", "format": "google-datetime", "readOnly": true, "description": "Output only. The timestamp when configurable_billing_approach was last updated." }, "isInfobotFaqDataStore": { "type": "boolean", "description": "Optional. If set, this DataStore is an Infobot FAQ DataStore." }, "naturalLanguageQueryUnderstandingConfig": { "$ref": "GoogleCloudDiscoveryengineV1alphaNaturalLanguageQueryUnderstandingConfig", "description": "Optional. Configuration for Natural Language Query Understanding." }, "federatedSearchConfig": { "$ref": "GoogleCloudDiscoveryengineV1alphaDataStoreFederatedSearchConfig", "description": "Optional. If set, this DataStore is a federated search DataStore." }, "configurableBillingApproach": { "enum": [ "CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED", "CONFIGURABLE_SUBSCRIPTION_INDEXING_CORE", "CONFIGURABLE_CONSUMPTION_EMBEDDING" ], "type": "string", "enumDescriptions": [ "Default value. For Spark and non-Spark non-configurable billing approach.", "Use the subscription base + overage billing for indexing core for non embedding storage.", "Use the consumption pay-as-you-go billing for embedding storage add-on." ], "description": "Optional. Configuration for configurable billing approach. See" }, "name": { "type": "string", "description": "Immutable. Identifier. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters." }, "industryVertical": { "type": "string", "enumDescriptions": [ "Value used when unset.", "The generic vertical for documents that are not specific to any industry vertical.", "The media industry vertical.", "The healthcare FHIR vertical." ], "enum": [ "INDUSTRY_VERTICAL_UNSPECIFIED", "GENERIC", "MEDIA", "HEALTHCARE_FHIR" ], "description": "Immutable. The industry vertical that the data store registers." } }, "id": "GoogleCloudDiscoveryengineV1alphaDataStore" }, "GoogleCloudDiscoveryengineV1alphaImportSampleQueriesResponse": { "description": "Response of the SampleQueryService.ImportSampleQueries method. If the long running operation is done, this message is returned by the google.longrunning.Operations.response field if the operation is successful.", "id": "GoogleCloudDiscoveryengineV1alphaImportSampleQueriesResponse", "type": "object", "properties": { "errorConfig": { "description": "The desired location of errors incurred during the Import.", "$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig" }, "errorSamples": { "type": "array", "items": { "$ref": "GoogleRpcStatus" }, "description": "A sample of errors encountered while processing the request." } } }, "GoogleCloudDiscoveryengineV1WidgetConfigUiSettingsSearchAddonSpec": { "description": "SearchAddonSpec is used to disable add-ons for search. By default, if this field is not specified, add-ons are enabled wherever applicable.", "id": "GoogleCloudDiscoveryengineV1WidgetConfigUiSettingsSearchAddonSpec", "properties": { "generativeAnswerAddOnDisabled": { "type": "boolean", "description": "Optional. If true, generative answer add-on is disabled. Generative answer add-on includes natural language to filters and simple answers." }, "semanticAddOnDisabled": { "description": "Optional. If true, semantic add-on is disabled. Semantic add-on includes embeddings and jetstream.", "type": "boolean" }, "kpiPersonalizationAddOnDisabled": { "description": "Optional. If true, disables event re-ranking and personalization to optimize KPIs & personalize results.", "type": "boolean" } }, "type": "object" }, "GoogleCloudDiscoveryengineV1alphaAlphaEvolveEvaluationScores": { "description": "Contains the evaluation scores for the target metrics to optimize.", "properties": { "scores": { "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveEvaluationScoresAlphaEvolveEvaluationScore" }, "type": "array", "description": "Required. List of evaluation scores." } }, "id": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveEvaluationScores", "type": "object" }, "GoogleCloudDiscoveryengineV1alphaAlphaEvolveEvaluationInsights": { "type": "object", "description": "Evaluation insights for a program.", "id": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveEvaluationInsights", "properties": { "insights": { "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveEvaluationInsightsAlphaEvolveEvaluationInsight" }, "type": "array", "description": "Optional. List of evaluation insights." } } }, "GoogleCloudDiscoveryengineV1WidgetConfigDataStoreComponent": { "type": "object", "properties": { "displayName": { "description": "The display name of the data store.", "type": "string" }, "dataStoreConfigType": { "readOnly": true, "description": "Output only. The type of the data store config.", "type": "string", "enumDescriptions": [ "Default value. This value is unused.", "The data store is connected to AlloyDB", "The data store is a connected to a third party data source.", "The data store is a connected to NotebookLM Enterprise." ], "enum": [ "DATA_STORE_CONFIG_TYPE_UNSPECIFIED", "ALLOW_DB_CONFIG", "THIRD_PARTY_OAUTH_CONFIG", "NOTEBOOKLM_CONFIG" ] }, "entityName": { "description": "The name of the entity, retrieved from `Collection.data_connector.entities.entityName`.", "type": "string" }, "id": { "readOnly": true, "description": "Output only. the identifier of the data store, used for widget service. For now it refers to data_store_id, in the future we will migrate the field to encrypted data store name UUID.", "type": "string" }, "name": { "description": "The name of the data store. It should be data store resource name Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. For APIs under WidgetService, such as WidgetService.LookupWidgetConfig, the project number and location part is erased in this field.", "type": "string" } }, "description": "Read-only data store component that contains data stores fields that may be used for filtering, it's the child of `CollectionComponent`.", "id": "GoogleCloudDiscoveryengineV1WidgetConfigDataStoreComponent" }, "GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchMetadata": { "description": "Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.", "properties": { "updateTime": { "description": "Operation last update time. If the operation is done, this is also the finish time.", "format": "google-datetime", "type": "string" }, "createTime": { "description": "Operation create time.", "type": "string", "format": "google-datetime" } }, "type": "object", "id": "GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchMetadata" }, "GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsMetadata": { "description": "Metadata related to the progress of the ImportCompletionSuggestions operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsMetadata", "type": "object", "properties": { "updateTime": { "type": "string", "format": "google-datetime", "description": "Operation last update time. If the operation is done, this is also the finish time." }, "createTime": { "description": "Operation create time.", "type": "string", "format": "google-datetime" }, "failureCount": { "type": "string", "format": "int64", "description": "Count of CompletionSuggestions that failed to be imported." }, "successCount": { "description": "Count of CompletionSuggestions successfully imported.", "format": "int64", "type": "string" } } }, "GoogleCloudDiscoveryengineV1ChunkPageSpan": { "type": "object", "properties": { "pageEnd": { "type": "integer", "description": "The end page of the chunk.", "format": "int32" }, "pageStart": { "format": "int32", "type": "integer", "description": "The start page of the chunk." } }, "id": "GoogleCloudDiscoveryengineV1ChunkPageSpan", "description": "Page span of the chunk." }, "GoogleCloudDiscoveryengineV1WidgetConfigUiSettings": { "type": "object", "id": "GoogleCloudDiscoveryengineV1WidgetConfigUiSettings", "description": "Describes general widget (or web app) UI settings as seen in the cloud console UI configuration page.", "properties": { "sourceAdminDisplayNameEnabled": { "description": "Optional. Whether to show the admin-configured display name for data connectors in the widget sources UI (instead of the connector kind). Opt-in; defaults to false.", "type": "boolean" }, "features": { "readOnly": true, "type": "object", "additionalProperties": { "enumDescriptions": [ "The feature state is unspecified.", "The feature is turned on to be accessible.", "The feature is turned off to be inaccessible." ], "enum": [ "FEATURE_STATE_UNSPECIFIED", "FEATURE_STATE_ON", "FEATURE_STATE_OFF" ], "type": "string" }, "description": "Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `speech-to-text` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `canvas-app-builder` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications`" }, "enablePeopleSearch": { "description": "Optional. If set to true, the widget will enable people search.", "type": "boolean" }, "dataStoreUiConfigs": { "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1WidgetConfigDataStoreUiConfig" }, "description": "Per data store configuration." }, "generativeAnswerConfig": { "description": "Describes generative answer configuration.", "$ref": "GoogleCloudDiscoveryengineV1WidgetConfigUiSettingsGenerativeAnswerConfig" }, "modelConfigInfo": { "readOnly": true, "description": "Output only. The resolved, server-side view of model selector configuration. Holds both the ordered list of models that should appear in the model selector dropdown and the model that should be selected by default. Clients should render this directly without applying their own filtering, ordering, or localization. The legacy `model_configs` map above is retained for backward compatibility with clients that have not yet migrated to consuming this field.", "$ref": "GoogleCloudDiscoveryengineV1WidgetConfigUiSettingsModelConfigInfo" }, "googleDrivePickerEnabled": { "description": "Output only. Whether the Google Drive file picker is available to end-users. Declared `optional` for the same field-presence reason as `onedrive_picker_enabled` above.", "readOnly": true, "type": "boolean" }, "enableCreateAgentButton": { "description": "Optional. If set to true, the widget will enable the create agent button.", "type": "boolean" }, "enableSearchAsYouType": { "description": "Whether to enable search-as-you-type behavior for the search widget.", "type": "boolean" }, "defaultSearchRequestOrderBy": { "type": "string", "description": "The default ordering for search results if specified. Used to set SearchRequest#order_by on applicable requests. https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.dataStores.servingConfigs/search#request-body" }, "onedrivePickerEnabled": { "type": "boolean", "description": "Output only. Whether the OneDrive file picker is available to end-users. Computed by the backend from admin connector enablement (Business edition) or attached OneDrive connectors (Enterprise edition), combined with the existing `disable-onedrive-upload` admin feature. Declared `optional` so an explicitly-computed `false` is serialized with field presence. A plain proto3 `bool` drops a default `false` on the wire, which prevented clients from distinguishing \"picker disabled\" (`false`) from \"field not populated\" (unset).", "readOnly": true }, "enableAutocomplete": { "description": "Whether or not to enable autocomplete.", "type": "boolean" }, "interactionType": { "description": "Describes widget (or web app) interaction type", "enum": [ "INTERACTION_TYPE_UNSPECIFIED", "SEARCH_ONLY", "SEARCH_WITH_ANSWER", "SEARCH_WITH_FOLLOW_UPS" ], "enumDescriptions": [ "Not specified. Defaults to SEARCH_ONLY.", "Search without a generative answer.", "Search with the generative answer.", "Search with the generative answer that supports follow up questions. Also known as multi-turn search." ], "type": "string" }, "resultDescriptionType": { "enumDescriptions": [ "Unspecified display type (default to showing snippet).", "Display results from the snippet field.", "Display results from extractive answers field." ], "type": "string", "enum": [ "RESULT_DISPLAY_TYPE_UNSPECIFIED", "SNIPPET", "EXTRACTIVE_ANSWER" ], "description": "Controls whether result extract is display and how (snippet or extractive answer). Default to no result if unspecified." }, "disableUserEventsCollection": { "description": "If set to true, the widget will not collect user events.", "type": "boolean" }, "enableVisualContentSummary": { "type": "boolean", "description": "If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search." }, "enableSafeSearch": { "type": "boolean", "description": "Whether to enable safe search." }, "modelConfigs": { "type": "object", "additionalProperties": { "type": "string", "enumDescriptions": [ "The model state is unspecified.", "The model is enabled by admin.", "The model is disabled by admin." ], "enum": [ "MODEL_STATE_UNSPECIFIED", "MODEL_ENABLED", "MODEL_DISABLED" ] }, "readOnly": true, "description": "Output only. Maps a model name to its specific configuration for this engine. This allows admin users to turn on/off individual models. This only stores models whose states are overridden by the admin. When the state is unspecified, or model_configs is empty for this model, the system will decide if this model should be available or not based on the default configuration. For example, a preview model should be disabled by default if the admin has not chosen to enable it." }, "searchAddonSpec": { "description": "Optional. SearchAddonSpec is used to disable add-ons for search. This field is only supported for search requests.", "$ref": "GoogleCloudDiscoveryengineV1WidgetConfigUiSettingsSearchAddonSpec" }, "enableQualityFeedback": { "description": "Turn on or off collecting the search result quality feedback from end users.", "type": "boolean" } } }, "GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfoQueryClassificationInfo": { "type": "object", "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfoQueryClassificationInfo", "description": "Query classification information.", "properties": { "type": { "description": "Query classification type.", "type": "string", "enum": [ "TYPE_UNSPECIFIED", "ADVERSARIAL_QUERY", "NON_ANSWER_SEEKING_QUERY", "JAIL_BREAKING_QUERY", "NON_ANSWER_SEEKING_QUERY_V2", "USER_DEFINED_CLASSIFICATION_QUERY" ], "enumDescriptions": [ "Unspecified query classification type.", "Adversarial query classification type.", "Non-answer-seeking query classification type, for chit chat.", "Jail-breaking query classification type.", "Non-answer-seeking query classification type, for no clear intent.", "User defined query classification type." ] }, "positive": { "description": "Classification output.", "type": "boolean" } } }, "GoogleCloudDiscoveryengineV1FetchDomainVerificationStatusResponse": { "type": "object", "id": "GoogleCloudDiscoveryengineV1FetchDomainVerificationStatusResponse", "description": "Response message for SiteSearchEngineService.FetchDomainVerificationStatus method.", "properties": { "targetSites": { "description": "List of TargetSites containing the site verification status.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1TargetSite" } }, "totalSize": { "description": "The total number of items matching the request. This will always be populated in the response.", "format": "int32", "type": "integer" }, "nextPageToken": { "description": "A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1BatchCreateTargetSitesResponse": { "properties": { "targetSites": { "description": "TargetSites created.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1TargetSite" } } }, "id": "GoogleCloudDiscoveryengineV1BatchCreateTargetSitesResponse", "type": "object", "description": "Response message for SiteSearchEngineService.BatchCreateTargetSites method." }, "GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsResponse": { "description": "Response of the CompletionService.ImportCompletionSuggestions method. If the long running operation is done, this message is returned by the google.longrunning.Operations.response field if the operation is successful.", "type": "object", "properties": { "errorConfig": { "description": "The desired location of errors incurred during the Import.", "$ref": "GoogleCloudDiscoveryengineV1ImportErrorConfig" }, "errorSamples": { "type": "array", "items": { "$ref": "GoogleRpcStatus" }, "description": "A sample of errors encountered while processing the request." } }, "id": "GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsResponse" }, "GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpecQueryClassificationSpec": { "description": "Query classification specification.", "id": "GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpecQueryClassificationSpec", "type": "object", "properties": { "types": { "items": { "type": "string", "enum": [ "TYPE_UNSPECIFIED", "ADVERSARIAL_QUERY", "NON_ANSWER_SEEKING_QUERY", "JAIL_BREAKING_QUERY", "NON_ANSWER_SEEKING_QUERY_V2", "USER_DEFINED_CLASSIFICATION_QUERY" ], "enumDescriptions": [ "Unspecified query classification type.", "Adversarial query classification type.", "Non-answer-seeking query classification type, for chit chat.", "Jail-breaking query classification type.", "Non-answer-seeking query classification type, for no clear intent.", "User defined query classification type." ] }, "type": "array", "description": "Enabled query classification types." } } }, "GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpec": { "id": "GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpec", "properties": { "limit": { "format": "int32", "type": "integer", "description": "Maximum facet values that are returned for this facet. If unspecified, defaults to 20. The maximum allowed value is 300. Values above 300 are coerced to 300. For aggregation in healthcare search, when the [FacetKey.key] is \"healthcare_aggregation_key\", the limit will be overridden to 10,000 internally, regardless of the value set here. If this field is negative, an `INVALID_ARGUMENT` is returned." }, "facetKey": { "description": "Required. The facet key specification.", "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpecFacetKey" }, "enableDynamicPosition": { "description": "Enables dynamic position for this facet. If set to true, the position of this facet among all facets in the response is determined automatically. If dynamic facets are enabled, it is ordered together. If set to false, the position of this facet in the response is the same as in the request, and it is ranked before the facets with dynamic position enable and all dynamic facets. For example, you may always want to have rating facet returned in the response, but it's not necessarily to always display the rating facet at the top. In that case, you can set enable_dynamic_position to true so that the position of rating facet in response is determined automatically. Another example, assuming you have the following facets in the request: * \"rating\", enable_dynamic_position = true * \"price\", enable_dynamic_position = false * \"brands\", enable_dynamic_position = false And also you have a dynamic facets enabled, which generates a facet `gender`. Then the final order of the facets in the response can be (\"price\", \"brands\", \"rating\", \"gender\") or (\"price\", \"brands\", \"gender\", \"rating\") depends on how API orders \"gender\" and \"rating\" facets. However, notice that \"price\" and \"brands\" are always ranked at first and second position because their enable_dynamic_position is false.", "type": "boolean" }, "excludedFilterKeys": { "items": { "type": "string" }, "description": "List of keys to exclude when faceting. By default, FacetKey.key is not excluded from the filter unless it is listed in this field. Listing a facet key in this field allows its values to appear as facet results, even when they are filtered out of search results. Using this field does not affect what search results are returned. For example, suppose there are 100 documents with the color facet \"Red\" and 200 documents with the color facet \"Blue\". A query containing the filter \"color:ANY(\"Red\")\" and having \"color\" as FacetKey.key would by default return only \"Red\" documents in the search results, and also return \"Red\" with count 100 as the only color facet. Although there are also blue documents available, \"Blue\" would not be shown as an available facet value. If \"color\" is listed in \"excludedFilterKeys\", then the query returns the facet values \"Red\" with count 100 and \"Blue\" with count 200, because the \"color\" key is now excluded from the filter. Because this field doesn't affect search results, the search results are still correctly filtered to return only \"Red\" documents. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.", "type": "array" } }, "description": "A facet specification to perform faceted search.", "type": "object" }, "GoogleCloudDiscoveryengineV1betaImportUserEventsResponse": { "id": "GoogleCloudDiscoveryengineV1betaImportUserEventsResponse", "description": "Response of the ImportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.", "properties": { "errorConfig": { "description": "Echoes the destination for the complete errors if this field was set in the request.", "$ref": "GoogleCloudDiscoveryengineV1betaImportErrorConfig" }, "unjoinedEventsCount": { "description": "Count of user events imported, but with Document information not found in the existing Branch.", "type": "string", "format": "int64" }, "errorSamples": { "type": "array", "description": "A sample of errors encountered while processing the request.", "items": { "$ref": "GoogleRpcStatus" } }, "joinedEventsCount": { "description": "Count of user events imported with complete existing Documents.", "format": "int64", "type": "string" } }, "type": "object" }, "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpec": { "type": "object", "properties": { "chunkSpec": { "$ref": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecChunkSpec", "description": "Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS" }, "searchResultMode": { "enumDescriptions": [ "Default value.", "Returns documents in the search result.", "Returns chunks in the search result. Only available if the DocumentProcessingConfig.chunking_config is specified." ], "type": "string", "description": "Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`.", "enum": [ "SEARCH_RESULT_MODE_UNSPECIFIED", "DOCUMENTS", "CHUNKS" ] }, "summarySpec": { "$ref": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpec", "description": "If `summarySpec` is not specified, summaries are not included in the search response." }, "snippetSpec": { "description": "If `snippetSpec` is not specified, snippets are not included in the search response.", "$ref": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSnippetSpec" }, "extractiveContentSpec": { "$ref": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecExtractiveContentSpec", "description": "If there is no extractive_content_spec provided, there will be no extractive answer in the search response." } }, "id": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpec", "description": "A specification for configuring the behavior of content search." }, "GoogleCloudDiscoveryengineV1ListEnginesResponse": { "properties": { "engines": { "description": "All the customer's Engines.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1Engine" } }, "nextPageToken": { "type": "string", "description": "Not supported." } }, "type": "object", "id": "GoogleCloudDiscoveryengineV1ListEnginesResponse", "description": "Response message for EngineService.ListEngines method." }, "GoogleCloudDiscoveryengineV1PurgeIdentityMappingsRequestInlineSource": { "id": "GoogleCloudDiscoveryengineV1PurgeIdentityMappingsRequestInlineSource", "type": "object", "description": "The inline source to purge identity mapping entries from.", "properties": { "identityMappingEntries": { "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1IdentityMappingEntry" }, "description": "A maximum of 10000 entries can be purged at one time" } } }, "GoogleCloudDiscoveryengineV1ListControlsResponse": { "properties": { "nextPageToken": { "type": "string", "description": "Pagination token, if not returned indicates the last page." }, "controls": { "items": { "$ref": "GoogleCloudDiscoveryengineV1Control" }, "description": "All the Controls for a given data store.", "type": "array" } }, "description": "Response for ListControls method.", "type": "object", "id": "GoogleCloudDiscoveryengineV1ListControlsResponse" }, "GoogleCloudDiscoveryengineV1TrainCustomModelMetadata": { "type": "object", "id": "GoogleCloudDiscoveryengineV1TrainCustomModelMetadata", "properties": { "updateTime": { "description": "Operation last update time. If the operation is done, this is also the finish time.", "format": "google-datetime", "type": "string" }, "createTime": { "type": "string", "format": "google-datetime", "description": "Operation create time." } }, "description": "Metadata related to the progress of the TrainCustomModel operation. This is returned by the google.longrunning.Operation.metadata field." }, "GoogleCloudDiscoveryengineV1DeleteEngineMetadata": { "properties": { "createTime": { "format": "google-datetime", "type": "string", "description": "Operation create time." }, "updateTime": { "type": "string", "description": "Operation last update time. If the operation is done, this is also the finish time.", "format": "google-datetime" } }, "type": "object", "id": "GoogleCloudDiscoveryengineV1DeleteEngineMetadata", "description": "Metadata related to the progress of the EngineService.DeleteEngine operation. This will be returned by the google.longrunning.Operation.metadata field." }, "GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentConfigGenerationSettingsModelConfig": { "id": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentConfigGenerationSettingsModelConfig", "type": "object", "properties": { "weight": { "type": "number", "description": "Optional. Relative weight for this model in the mixture. Must be a finite, strictly positive value. Weights across all entries are normalized server-side, so they need not sum to 1.0. Defaults to 1.0 when unset, which is convenient when configuring a single model or an even mixture. Some Pro-tier models are capped at most 50% of the total weight; requests violating that cap are rejected with INVALID_ARGUMENT.", "format": "float" }, "thinkingLevel": { "type": "string", "enumDescriptions": [ "Unset. The model applies its own default, which is not the same level for every model.", "Least thinking. Not offered by every model.", "Vertex `LOW`.", "Vertex `MEDIUM`.", "Vertex `HIGH`." ], "description": "Optional. Sent as Vertex `ThinkingConfig.thinking_level`.", "enum": [ "THINKING_LEVEL_UNSPECIFIED", "MINIMAL", "LOW", "MEDIUM", "HIGH" ] }, "name": { "description": "Required. Model name (e.g. `gemini-2.5-flash`, `gemini-3.1-pro-preview`). See `model_mixture` for the list of allowed models.", "type": "string" } }, "description": "Per-model configuration. Mutually exclusive with `model_mixture` and `model`: when `models` is set, both `model_mixture` and `model` must be left unset. The same allowed-model list and at-most-2-models rule as for `model_mixture` apply. In addition, each entry may specify a per-model `temperature` for LLM sampling. Unlike `model_mixture`, weights here are *relative*: only their ratios matter (the server normalizes them), so callers may use any positive numbers without having to ensure they sum to 1.0." }, "A2aV1OpenIdConnectSecurityScheme": { "properties": { "description": { "description": "Description of this security scheme.", "type": "string" }, "openIdConnectUrl": { "description": "Well-known URL to discover the [[OpenID-Connect-Discovery]] provider metadata.", "type": "string" } }, "type": "object", "id": "A2aV1OpenIdConnectSecurityScheme" }, "GoogleCloudDiscoveryengineV1betaTargetSite": { "properties": { "updateTime": { "readOnly": true, "format": "google-datetime", "type": "string", "description": "Output only. The target site's last updated time." }, "providedUriPattern": { "type": "string", "description": "Required. Input only. The user provided URI pattern from which the `generated_uri_pattern` is generated." }, "name": { "type": "string", "readOnly": true, "description": "Output only. The fully qualified resource name of the target site. `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}` The `target_site_id` is system-generated." }, "failureReason": { "readOnly": true, "description": "Output only. Failure reason.", "$ref": "GoogleCloudDiscoveryengineV1betaTargetSiteFailureReason" }, "exactMatch": { "description": "Immutable. If set to false, a uri_pattern is generated to include all pages whose address contains the provided_uri_pattern. If set to true, an uri_pattern is generated to try to be an exact match of the provided_uri_pattern or just the specific page if the provided_uri_pattern is a specific one. provided_uri_pattern is always normalized to generate the URI pattern to be used by the search engine.", "type": "boolean" }, "type": { "description": "The type of the target site, e.g., whether the site is to be included or excluded.", "enum": [ "TYPE_UNSPECIFIED", "INCLUDE", "EXCLUDE" ], "enumDescriptions": [ "This value is unused. In this case, server behavior defaults to Type.INCLUDE.", "Include the target site.", "Exclude the target site." ], "type": "string" }, "siteVerificationInfo": { "$ref": "GoogleCloudDiscoveryengineV1betaSiteVerificationInfo", "description": "Output only. Site ownership and validity verification status.", "readOnly": true }, "rootDomainUri": { "type": "string", "readOnly": true, "description": "Output only. Root domain of the provided_uri_pattern." }, "generatedUriPattern": { "type": "string", "readOnly": true, "description": "Output only. This is system-generated based on the provided_uri_pattern." }, "indexingStatus": { "type": "string", "readOnly": true, "enumDescriptions": [ "Defaults to SUCCEEDED.", "The target site is in the update queue and will be picked up by indexing pipeline.", "The target site fails to be indexed.", "The target site has been indexed.", "The previously indexed target site has been marked to be deleted. This is a transitioning state which will resulted in either: 1. target site deleted if unindexing is successful; 2. state reverts to SUCCEEDED if the unindexing fails.", "The target site change is pending but cancellable.", "The target site change is cancelled." ], "enum": [ "INDEXING_STATUS_UNSPECIFIED", "PENDING", "FAILED", "SUCCEEDED", "DELETING", "CANCELLABLE", "CANCELLED" ], "description": "Output only. Indexing status." } }, "id": "GoogleCloudDiscoveryengineV1betaTargetSite", "description": "A target site for the SiteSearchEngine.", "type": "object" }, "GoogleCloudDiscoveryengineV1alphaDeleteCollectionMetadata": { "description": "Metadata related to the progress of the CollectionService.UpdateCollection operation. This will be returned by the google.longrunning.Operation.metadata field.", "type": "object", "properties": { "createTime": { "type": "string", "description": "Operation create time.", "format": "google-datetime" }, "updateTime": { "format": "google-datetime", "type": "string", "description": "Operation last update time. If the operation is done, this is also the finish time." } }, "id": "GoogleCloudDiscoveryengineV1alphaDeleteCollectionMetadata" }, "GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsRequest": { "description": "Request message for CompletionService.ImportCompletionSuggestions method.", "properties": { "inlineSource": { "description": "The Inline source for suggestion entries.", "$ref": "GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsRequestInlineSource" }, "bigquerySource": { "$ref": "GoogleCloudDiscoveryengineV1BigQuerySource", "description": "BigQuery input source." }, "gcsSource": { "description": "Cloud Storage location for the input content.", "$ref": "GoogleCloudDiscoveryengineV1GcsSource" }, "errorConfig": { "$ref": "GoogleCloudDiscoveryengineV1ImportErrorConfig", "description": "The desired location of errors incurred during the Import." } }, "id": "GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsRequest", "type": "object" }, "GoogleCloudDiscoveryengineV1WidgetConfigFacetField": { "description": "Facet fields that store the mapping of fields to end user widget appearance.", "properties": { "field": { "description": "Required. Registered field name. The format is `field.abc`.", "type": "string" }, "displayName": { "description": "Optional. The field name that end users will see.", "type": "string" } }, "type": "object", "id": "GoogleCloudDiscoveryengineV1WidgetConfigFacetField" }, "GoogleCloudDiscoveryengineV1betaUpdateTargetSiteMetadata": { "id": "GoogleCloudDiscoveryengineV1betaUpdateTargetSiteMetadata", "description": "Metadata related to the progress of the SiteSearchEngineService.UpdateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", "type": "object", "properties": { "createTime": { "type": "string", "format": "google-datetime", "description": "Operation create time." }, "updateTime": { "description": "Operation last update time. If the operation is done, this is also the finish time.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudDiscoveryengineV1SearchResponseSearchResult": { "id": "GoogleCloudDiscoveryengineV1SearchResponseSearchResult", "description": "Represents the search results.", "properties": { "id": { "type": "string", "description": "Document.id of the searched Document." }, "rankSignals": { "description": "Optional. A set of ranking signals associated with the result.", "$ref": "GoogleCloudDiscoveryengineV1SearchResponseSearchResultRankSignals" }, "modelScores": { "readOnly": true, "additionalProperties": { "$ref": "GoogleCloudDiscoveryengineV1DoubleList" }, "description": "Output only. Google provided available scores.", "type": "object" }, "chunk": { "$ref": "GoogleCloudDiscoveryengineV1Chunk", "description": "The chunk data in the search response if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS." }, "retrievalSignals": { "$ref": "GoogleCloudDiscoveryengineV1SearchResponseSearchResultRetrievalSignals", "description": "Optional. A set of signals used by the relevance filter meant for use to fine-tune the relevance filter thresholds." }, "document": { "$ref": "GoogleCloudDiscoveryengineV1Document", "description": "The document data snippet in the search response. Only fields that are marked as `retrievable` are populated." } }, "type": "object" }, "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig": { "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig", "type": "object", "description": "The digital parsing configurations for documents.", "properties": {} }, "GoogleCloudDiscoveryengineV1alphaAdvancedSiteSearchConfig": { "id": "GoogleCloudDiscoveryengineV1alphaAdvancedSiteSearchConfig", "description": "Configuration data for advance site search.", "type": "object", "properties": { "disableInitialIndex": { "type": "boolean", "description": "If set true, initial indexing is disabled for the DataStore." }, "disableAutomaticRefresh": { "description": "If set true, automatic refresh is disabled for the DataStore.", "type": "boolean" } } }, "GoogleCloudDiscoveryengineV1SessionTurn": { "properties": { "detailedAnswer": { "description": "Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting answer query session.", "$ref": "GoogleCloudDiscoveryengineV1Answer", "readOnly": true }, "queryConfig": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Optional. Represents metadata related to the query config, for example LLM model and version used, model parameters (temperature, grounding parameters, etc.). The prefix \"google.\" is reserved for Google-developed functionality." }, "query": { "description": "Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn", "$ref": "GoogleCloudDiscoveryengineV1Query" }, "answer": { "description": "Optional. The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn.", "type": "string" }, "live": { "description": "Optional. Indicates whether this turn is a live turn.", "type": "boolean" }, "detailedAssistAnswer": { "readOnly": true, "description": "Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting assistant session.", "$ref": "GoogleCloudDiscoveryengineV1AssistAnswer" } }, "description": "Represents a turn, including a query from the user and a answer from service.", "id": "GoogleCloudDiscoveryengineV1SessionTurn", "type": "object" }, "GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec": { "id": "GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec", "properties": { "relevanceThreshold": { "enumDescriptions": [ "Default value. In this case, server behavior defaults to Google defined threshold.", "Lowest relevance threshold.", "Low relevance threshold.", "Medium relevance threshold.", "High relevance threshold." ], "type": "string", "enum": [ "RELEVANCE_THRESHOLD_UNSPECIFIED", "LOWEST", "LOW", "MEDIUM", "HIGH" ], "description": "Pre-defined relevance threshold for the sub-search." }, "semanticRelevanceThreshold": { "format": "float", "description": "Custom relevance threshold for the sub-search. The value must be in [0.0, 1.0].", "type": "number" } }, "description": "Specification for relevance filtering on a specific sub-search.", "type": "object" }, "GoogleCloudDiscoveryengineV1WidgetConfig": { "type": "object", "properties": { "dataStoreUiConfigs": { "deprecated": true, "description": "Configurable UI configurations per data store.", "items": { "$ref": "GoogleCloudDiscoveryengineV1WidgetConfigDataStoreUiConfig" }, "type": "array" }, "enableAutocomplete": { "description": "Whether or not to enable autocomplete.", "type": "boolean", "deprecated": true }, "collectionComponents": { "description": "Output only. Collection components that lists all collections and child data stores associated with the widget config, those data sources can be used for filtering in widget service APIs, users can return results that from selected data sources. For SaaS / Business engines, when `LookupWidgetConfig` is called with `view = WITH_AVAILABLE_CONNECTORS`, this list is additionally augmented with synthetic placeholder entries for connectors the caller may attach but has not yet attached (see `CollectionComponent` for the placeholder contract). The frontend can therefore render a unified list of already-attached and available-to-attach sources by iterating this single field. For Enterprise engines and for the default `view`, only already-attached connectors are returned (today's behavior).", "readOnly": true, "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1WidgetConfigCollectionComponent" } }, "contentSearchSpec": { "deprecated": true, "description": "The content search spec that configs the desired behavior of content search.", "$ref": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpec" }, "dataStoreType": { "enumDescriptions": [ "Unspecified data store type.", "The parent data store contains a site search engine.", "The parent data store contains a search engine for structured data.", "The parent data store contains a search engine for unstructured data.", "The parent data store is served for blended search with multiple data stores." ], "description": "Output only. The type of the parent data store.", "readOnly": true, "type": "string", "enum": [ "DATA_STORE_TYPE_UNSPECIFIED", "SITE_SEARCH", "STRUCTURED", "UNSTRUCTURED", "BLENDED" ] }, "enableSearchAsYouType": { "description": "Whether to enable search-as-you-type behavior for the search widget", "type": "boolean", "deprecated": true }, "facetField": { "type": "array", "description": "The configuration and appearance of facets in the end user view.", "items": { "$ref": "GoogleCloudDiscoveryengineV1WidgetConfigFacetField" }, "deprecated": true }, "enablePrivateKnowledgeGraph": { "type": "boolean", "readOnly": true, "description": "Optional. Output only. Whether to enable private knowledge graph." }, "industryVertical": { "enumDescriptions": [ "Value used when unset.", "The generic vertical for documents that are not specific to any industry vertical.", "The media industry vertical.", "The healthcare FHIR vertical." ], "type": "string", "description": "Output only. The industry vertical that the WidgetConfig registers. The WidgetConfig industry vertical is based on the associated Engine.", "enum": [ "INDUSTRY_VERTICAL_UNSPECIFIED", "GENERIC", "MEDIA", "HEALTHCARE_FHIR" ], "readOnly": true }, "enableSnippetResultSummary": { "description": "Turn on or off summary for each snippets result.", "type": "boolean", "deprecated": true }, "homepageSetting": { "$ref": "GoogleCloudDiscoveryengineV1WidgetConfigHomepageSetting", "description": "Optional. Describes the homepage settings of the widget." }, "uiBranding": { "$ref": "GoogleCloudDiscoveryengineV1WidgetConfigUiBrandingSettings", "description": "Describes search widget UI branding settings, such as the widget title, logo, favicons, and colors." }, "configId": { "type": "string", "description": "Output only. Unique obfuscated identifier of a WidgetConfig.", "readOnly": true }, "allowPublicAccess": { "description": "Whether allow no-auth integration with widget. If set true, public access to search or other solutions from widget is allowed without authenication token provided by customer hosted backend server.", "type": "boolean", "deprecated": true }, "nodes": { "type": "array", "description": "Output only. The nodes associated with the Widget Config.", "items": { "$ref": "GoogleCloudDiscoveryengineV1WidgetConfigNode" }, "readOnly": true }, "createTime": { "format": "google-datetime", "type": "string", "readOnly": true, "description": "Output only. Timestamp the WidgetConfig was created." }, "llmEnabled": { "readOnly": true, "description": "Output only. Whether LLM is enabled in the corresponding data store.", "type": "boolean" }, "customerProvidedConfig": { "description": "Optional. Output only. Describes the customer related configurations, currently only used for government customers. This field cannot be modified after project onboarding.", "readOnly": true, "$ref": "GoogleCloudDiscoveryengineV1WidgetConfigCustomerProvidedConfig" }, "displayName": { "type": "string", "description": "Required. The human readable widget config display name. Used in Discovery UI. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned." }, "uiSettings": { "description": "Describes general widget search settings as seen in cloud console widget configuration page. Replaces top deprecated top level properties.", "$ref": "GoogleCloudDiscoveryengineV1WidgetConfigUiSettings" }, "fieldsUiComponentsMap": { "deprecated": true, "description": "The key is the UI component. Mock. Currently supported `title`, `thumbnail`, `url`, `custom1`, `custom2`, `custom3`. The value is the name of the field along with its device visibility. The 3 custom fields are optional and can be added or removed. `title`, `thumbnail`, `url` are required UI components that cannot be removed.", "additionalProperties": { "$ref": "GoogleCloudDiscoveryengineV1WidgetConfigUIComponentField" }, "type": "object" }, "defaultSearchRequestOrderBy": { "description": "The default ordering for search results if specified. Used to set SearchRequest#order_by on applicable requests. https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.dataStores.servingConfigs/search#request-body", "type": "string", "deprecated": true }, "enableSafeSearch": { "type": "boolean", "description": "Whether to enable safe search.", "deprecated": true }, "solutionType": { "description": "Required. Immutable. Specifies the solution type that this WidgetConfig can be used for.", "enum": [ "SOLUTION_TYPE_UNSPECIFIED", "SOLUTION_TYPE_RECOMMENDATION", "SOLUTION_TYPE_SEARCH", "SOLUTION_TYPE_CHAT", "SOLUTION_TYPE_GENERATIVE_CHAT", "SOLUTION_TYPE_AI_MODE" ], "type": "string", "enumDescriptions": [ "Default value.", "Used for Recommendations AI.", "Used for Discovery Search.", "Used for use cases related to the Generative AI agent.", "Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution.", "Used for AI Mode." ] }, "enableResultScore": { "description": "Whether to show the result score.", "type": "boolean" }, "assistantSettings": { "$ref": "GoogleCloudDiscoveryengineV1WidgetConfigAssistantSettings", "description": "Optional. Output only. Describes the assistant settings of the widget.", "readOnly": true }, "updateTime": { "format": "google-datetime", "readOnly": true, "description": "Output only. Timestamp the WidgetConfig was updated.", "type": "string" }, "resultDisplayType": { "deprecated": true, "type": "string", "description": "The type of snippet to display in UCS widget. - RESULT_DISPLAY_TYPE_UNSPECIFIED for existing users. - SNIPPET for new non-enterprise search users. - EXTRACTIVE_ANSWER for new enterprise search users.", "enumDescriptions": [ "Unspecified display type (default to showing snippet).", "Display results from the snippet field.", "Display results from extractive answers field." ], "enum": [ "RESULT_DISPLAY_TYPE_UNSPECIFIED", "SNIPPET", "EXTRACTIVE_ANSWER" ] }, "batchAuthStatuses": { "description": "Output only. The batch authorization statuses for the widget's connectors.", "items": { "$ref": "GoogleCloudDiscoveryengineV1WidgetConfigBatchAuthStatus" }, "type": "array", "readOnly": true }, "enableSummarization": { "type": "boolean", "description": "Turn on or off summarization for the search response.", "deprecated": true }, "allowlistedDomains": { "items": { "type": "string" }, "deprecated": true, "type": "array", "description": "Allowlisted domains that can load this widget." }, "accessSettings": { "$ref": "GoogleCloudDiscoveryengineV1WidgetConfigAccessSettings", "description": "Will be used for all widget access settings seen in cloud console integration page. Replaces top deprecated top level properties." }, "minimumDataTermAccepted": { "readOnly": true, "description": "Output only. Whether the customer accepted data use terms.", "type": "boolean" }, "enableWebApp": { "deprecated": true, "type": "boolean", "description": "Whether to enable standalone web app." }, "enableQualityFeedback": { "type": "boolean", "description": "Turn on or off collecting the search result quality feedback from end users.", "deprecated": true }, "enableConversationalSearch": { "deprecated": true, "description": "Whether to allow conversational search (LLM, multi-turn) or not (non-LLM, single-turn).", "type": "boolean" }, "geminiBundle": { "readOnly": true, "type": "boolean", "description": "Output only. Whether the subscription is gemini bundle or not." }, "name": { "description": "Immutable. The full resource name of the widget config. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/widgetConfigs/{widget_config_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", "type": "string" } }, "id": "GoogleCloudDiscoveryengineV1WidgetConfig", "description": "WidgetConfig captures configs at the Widget level." }, "GoogleCloudDiscoveryengineV1AssistantGroundedContentTextGroundingMetadataReferenceDocumentMetadata": { "properties": { "language": { "type": "string", "enum": [ "LANGUAGE_UNSPECIFIED", "PYTHON", "SQL" ], "enumDescriptions": [ "", "", "" ] }, "pageIdentifier": { "description": "Page identifier.", "type": "string" }, "uri": { "type": "string", "description": "URI for the document. It may contain a URL that redirects to the actual website." }, "domain": { "description": "Domain name from the document URI. Note that the `uri` field may contain a URL that redirects to the actual website, in which case this will contain the domain name of the target site.", "type": "string" }, "title": { "description": "Title.", "type": "string" }, "document": { "description": "Document resource name.", "type": "string" }, "mimeType": { "description": "The mime type of the document. https://www.iana.org/assignments/media-types/media-types.xhtml.", "type": "string" } }, "description": "Document metadata.", "type": "object", "id": "GoogleCloudDiscoveryengineV1AssistantGroundedContentTextGroundingMetadataReferenceDocumentMetadata" }, "GoogleCloudDiscoveryengineV1DocumentContent": { "type": "object", "id": "GoogleCloudDiscoveryengineV1DocumentContent", "description": "Unstructured data linked to this document.", "properties": { "uri": { "type": "string", "description": "The URI of the content. Only Cloud Storage URIs (e.g. `gs://bucket-name/path/to/file`) are supported. The maximum file size is 2.5 MB for text-based formats, 200 MB for other formats." }, "rawBytes": { "format": "byte", "description": "The content represented as a stream of bytes. The maximum length is 1,000,000 bytes (1 MB / ~0.95 MiB). Note: As with all `bytes` fields, this field is represented as pure binary in Protocol Buffers and base64-encoded string in JSON. For example, `abc123!?$*&()'-=@~` should be represented as `YWJjMTIzIT8kKiYoKSctPUB+` in JSON. See https://developers.google.com/protocol-buffers/docs/proto3#json.", "type": "string" }, "mimeType": { "description": "The MIME type of the content. Supported types: * `application/pdf` (PDF, only native PDFs are supported for now) * `text/html` (HTML) * `text/plain` (TXT) * `application/xml` or `text/xml` (XML) * `application/json` (JSON) * `application/vnd.openxmlformats-officedocument.wordprocessingml.document` (DOCX) * `application/vnd.openxmlformats-officedocument.presentationml.presentation` (PPTX) * `application/vnd.openxmlformats-officedocument.spreadsheetml.sheet` (XLSX) * `application/vnd.ms-excel.sheet.macroenabled.12` (XLSM) The following types are supported only if layout parser is enabled in the data store: * `image/bmp` (BMP) * `image/gif` (GIF) * `image/jpeg` (JPEG) * `image/png` (PNG) * `image/tiff` (TIFF) See https://www.iana.org/assignments/media-types/media-types.xhtml.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfig": { "description": "Stores information for federated search.", "type": "object", "id": "GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfig", "properties": { "notebooklmConfig": { "description": "NotebookLM config. If set, this DataStore is connected to NotebookLM Enterprise.", "$ref": "GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfigNotebooklmConfig" }, "thirdPartyOauthConfig": { "$ref": "GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfigThirdPartyOauthConfig", "description": "Third Party OAuth config. If set, this DataStore is connected to a third party application." }, "alloyDbConfig": { "description": "AlloyDB config. If set, this DataStore is connected to AlloyDB.", "$ref": "GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfigAlloyDbConfig" } } }, "GoogleCloudDiscoveryengineV1betaCmekConfig": { "description": "Configurations used to enable CMEK data encryption with Cloud KMS keys.", "properties": { "name": { "description": "Required. The name of the CmekConfig of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmek_config}`.", "type": "string" }, "isDefault": { "readOnly": true, "description": "Output only. The default CmekConfig for the Customer.", "type": "boolean" }, "notebooklmState": { "type": "string", "description": "Output only. Whether the NotebookLM Corpus is ready to be used.", "enum": [ "NOTEBOOK_LM_STATE_UNSPECIFIED", "NOTEBOOK_LM_NOT_READY", "NOTEBOOK_LM_READY", "NOTEBOOK_LM_NOT_ENABLED" ], "enumDescriptions": [ "The NotebookLM state is unknown.", "The NotebookLM is not ready.", "The NotebookLM is ready to be used.", "The NotebookLM is not enabled." ], "readOnly": true }, "lastRotationTimestampMicros": { "description": "Output only. The timestamp of the last key rotation.", "readOnly": true, "format": "int64", "type": "string" }, "singleRegionKeys": { "items": { "$ref": "GoogleCloudDiscoveryengineV1betaSingleRegionKey" }, "description": "Optional. Single-regional CMEKs that are required for some VAIS features.", "type": "array" }, "kmsKey": { "description": "Required. KMS key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.", "type": "string" }, "state": { "type": "string", "readOnly": true, "enumDescriptions": [ "The CmekConfig state is unknown.", "The CmekConfig is creating.", "The CmekConfig can be used with DataStores.", "The CmekConfig is unavailable, most likely due to the KMS Key being revoked.", "The CmekConfig is deleting.", "The CmekConfig deletion process failed.", "The CmekConfig is not usable, most likely due to some internal issue.", "The KMS key version is being rotated.", "The KMS key is soft deleted. Some cleanup policy will eventually be applied.", "The KMS key is expired, meaning the key has been disabled for 30+ days. The customer can call DeleteCmekConfig to change the state to DELETED." ], "description": "Output only. The states of the CmekConfig.", "enum": [ "STATE_UNSPECIFIED", "CREATING", "ACTIVE", "KEY_ISSUE", "DELETING", "DELETE_FAILED", "UNUSABLE", "ACTIVE_ROTATING", "DELETED", "EXPIRED" ] }, "kmsKeyVersion": { "type": "string", "readOnly": true, "description": "Output only. KMS key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`." } }, "type": "object", "id": "GoogleCloudDiscoveryengineV1betaCmekConfig" }, "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfoChunkContent": { "properties": { "blobAttachmentIndexes": { "type": "array", "items": { "type": "string", "format": "int64" }, "readOnly": true, "description": "Output only. Stores indexes of blobattachments linked to this chunk." }, "content": { "type": "string", "description": "Chunk textual content." }, "relevanceScore": { "type": "number", "description": "The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation.", "format": "float" }, "pageIdentifier": { "type": "string", "description": "Page identifier." } }, "description": "Chunk content.", "id": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfoChunkContent", "type": "object" }, "A2aV1TaskStatus": { "id": "A2aV1TaskStatus", "description": "A container for the status of a task", "properties": { "state": { "enum": [ "TASK_STATE_UNSPECIFIED", "TASK_STATE_SUBMITTED", "TASK_STATE_WORKING", "TASK_STATE_COMPLETED", "TASK_STATE_FAILED", "TASK_STATE_CANCELLED", "TASK_STATE_INPUT_REQUIRED", "TASK_STATE_REJECTED", "TASK_STATE_AUTH_REQUIRED" ], "type": "string", "enumDescriptions": [ "", "Represents the status that acknowledges a task is created", "Represents the status that a task is actively being processed", "Represents the status a task is finished. This is a terminal state", "Represents the status a task is done but failed. This is a terminal state", "Represents the status a task was cancelled before it finished. This is a terminal state.", "Represents the status that the task requires information to complete. This is an interrupted state.", "Represents the status that the agent has decided to not perform the task. This may be done during initial task creation or later once an agent has determined it can't or won't proceed. This is a terminal state.", "Represents the state that some authentication is needed from the upstream client. Authentication is expected to come out-of-band thus this is not an interrupted or terminal state." ], "description": "The current state of this task" }, "message": { "$ref": "A2aV1Message", "description": "A message associated with the status." }, "timestamp": { "format": "google-datetime", "type": "string", "description": "Timestamp when the status was recorded. Example: \"2023-10-27T10:00:00Z\"" } }, "type": "object" }, "GoogleCloudDiscoveryengineV1alphaBAPConfigToolspecOverride": { "description": "Customer-facing view of the admin-curated toolspec for a BAP connection. Holds the (simplified) per-tool definitions surfaced to and editable by the admin in the Discovery Engine UI. Mirrors the shape of the backend `google.cloud.connectorexecution.v1.ToolspecOverride` message, but is intentionally kept as a separate public type so the Discovery Engine API surface can evolve independently of the fed-API surface (AIP-215). Handlers convert between the two via helpers in //cloud/ml/discoveryengine/external_service/v1main/data_connector_service/lib:bap_custom_tool_util.", "id": "GoogleCloudDiscoveryengineV1alphaBAPConfigToolspecOverride", "type": "object", "properties": { "tools": { "type": "array", "description": "Required. Tool definitions (one Struct per tool) that the admin has customised on top of the base toolspec returned by the fed API. REQUIRED because it is the only user-editable field in the modify API; the request must carry at least one tool.", "items": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "type": "object" } }, "baseVersion": { "description": "Required. Base toolspec version against which `tools` were authored. On Update, MUST match the server's current stable toolspec version for the connection; mismatch is rejected with a user-facing error directing the admin to re-download the latest tools first.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateResponse": { "type": "object", "description": "Response message for CrawlRateManagementService.SetDedicatedCrawlRate method. It simply returns the state of the response, and an error message if the state is FAILED.", "id": "GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateResponse", "properties": { "error": { "$ref": "GoogleRpcStatus", "description": "Errors from service when handling the request." }, "state": { "description": "Output only. The state of the response.", "enumDescriptions": [ "The state is unspecified.", "The state is successful.", "The state is failed." ], "readOnly": true, "type": "string", "enum": [ "STATE_UNSPECIFIED", "SUCCEEDED", "FAILED" ] } } }, "GoogleCloudDiscoveryengineV1BigtableOptions": { "properties": { "families": { "description": "The mapping from family names to an object that contains column families level information for the given column family. If a family is not present in this map it will be ignored.", "type": "object", "additionalProperties": { "$ref": "GoogleCloudDiscoveryengineV1BigtableOptionsBigtableColumnFamily" } }, "keyFieldName": { "type": "string", "description": "The field name used for saving row key value in the document. The name has to match the pattern `a-zA-Z0-9*`." } }, "type": "object", "description": "The Bigtable Options object that contains information to support the import.", "id": "GoogleCloudDiscoveryengineV1BigtableOptions" }, "GoogleCloudDiscoveryengineV1alphaAlphaEvolveEvaluationScoresAlphaEvolveEvaluationScore": { "id": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveEvaluationScoresAlphaEvolveEvaluationScore", "properties": { "metric": { "type": "string", "description": "Required. Name of the metric." }, "score": { "type": "number", "description": "Required. Score of a program for this metric.", "format": "float" } }, "type": "object", "description": "Score for a single metric." }, "GoogleCloudDiscoveryengineV1DocumentAclInfo": { "type": "object", "description": "ACL Information of the Document.", "id": "GoogleCloudDiscoveryengineV1DocumentAclInfo", "properties": { "readers": { "description": "Readers of the document.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1DocumentAclInfoAccessRestriction" } } } }, "GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveAnswer": { "type": "object", "id": "GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveAnswer", "properties": { "pageIdentifier": { "description": "Page identifier.", "type": "string" }, "content": { "description": "Extractive answer content.", "type": "string" } }, "description": "Extractive answer. [Guide](https://cloud.google.com/generative-ai-app-builder/docs/snippets#get-answers)" }, "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecChunkSpec": { "type": "object", "properties": { "numPreviousChunks": { "type": "integer", "format": "int32", "description": "The number of previous chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no previous chunks will be returned." }, "numNextChunks": { "format": "int32", "type": "integer", "description": "The number of next chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no next chunks will be returned." } }, "description": "Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS", "id": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecChunkSpec" }, "GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfig": { "properties": { "notebooklmConfig": { "description": "Optional. Configuration for NotebookLM settings.", "$ref": "GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfig" } }, "description": "Customer provided configurations.", "type": "object", "id": "GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfig" }, "GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAddonSpec": { "description": "SearchAddonSpec is used to disable add-ons for search as per new repricing model. By default if the SearchAddonSpec is not specified, we consider that the customer wants to enable them wherever applicable.", "properties": { "disableKpiPersonalizationAddOn": { "description": "Optional. If true, disables event re-ranking and personalization to optimize KPIs & personalize results.", "type": "boolean" }, "disableGenerativeAnswerAddOn": { "type": "boolean", "description": "Optional. If true, generative answer add-on is disabled. Generative answer add-on includes natural language to filters and simple answers." }, "disableSemanticAddOn": { "description": "Optional. If true, semantic add-on is disabled. Semantic add-on includes embeddings and jetstream.", "type": "boolean" } }, "type": "object", "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAddonSpec" }, "GoogleCloudDiscoveryengineV1betaUpdateSchemaMetadata": { "properties": { "createTime": { "type": "string", "description": "Operation create time.", "format": "google-datetime" }, "updateTime": { "format": "google-datetime", "description": "Operation last update time. If the operation is done, this is also the finish time.", "type": "string" } }, "description": "Metadata for UpdateSchema LRO.", "type": "object", "id": "GoogleCloudDiscoveryengineV1betaUpdateSchemaMetadata" }, "GoogleCloudDiscoveryengineV1Tenant": { "properties": { "id": { "description": "The tenant's instance ID. Examples: Jira (\"8594f221-9797-5f78-1fa4-485e198d7cd0\"), Slack (\"T123456\").", "type": "string" }, "displayName": { "description": "Optional display name for the tenant, e.g. \"My Slack Team\".", "type": "string" }, "uri": { "type": "string", "description": "The URI of the tenant, if applicable. For example, the URI of a Jira instance is https://my-jira-instance.atlassian.net, and a Slack tenant does not have a URI." } }, "description": "Tenant information for a connector source. This includes some of the same information stored in the Credential message, but is limited to only what is needed to provide a list of accessible tenants to the user.", "id": "GoogleCloudDiscoveryengineV1Tenant", "type": "object" }, "GoogleCloudDiscoveryengineV1betaConditionQueryTerm": { "description": "Matcher for search request query", "properties": { "value": { "type": "string", "description": "The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters." }, "fullMatch": { "description": "Whether the search query needs to exactly match the query term.", "type": "boolean" } }, "id": "GoogleCloudDiscoveryengineV1betaConditionQueryTerm", "type": "object" }, "GoogleCloudDiscoveryengineV1CreateTargetSiteRequest": { "type": "object", "id": "GoogleCloudDiscoveryengineV1CreateTargetSiteRequest", "description": "Request message for SiteSearchEngineService.CreateTargetSite method.", "properties": { "parent": { "type": "string", "description": "Required. Parent resource name of TargetSite, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`." }, "targetSite": { "description": "Required. The TargetSite to create.", "$ref": "GoogleCloudDiscoveryengineV1TargetSite" } } }, "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponsePersonSuggestion": { "description": "Suggestions as people.", "id": "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponsePersonSuggestion", "type": "object", "properties": { "suggestion": { "description": "The suggestion for the query.", "type": "string" }, "displayPhotoUri": { "description": "The photo uri of the person suggestion.", "type": "string" }, "personType": { "description": "The type of the person.", "enum": [ "PERSON_TYPE_UNSPECIFIED", "CLOUD_IDENTITY", "THIRD_PARTY_IDENTITY", "GOOGLE_GROUP" ], "enumDescriptions": [ "Default value.", "The suggestion is from a GOOGLE_IDENTITY source.", "The suggestion is from a THIRD_PARTY_IDENTITY source.", "The suggestion is a group (e.g. a Google Group), not an individual." ], "type": "string" }, "dataStore": { "type": "string", "description": "The name of the dataStore that this suggestion belongs to." }, "document": { "description": "The document data snippet in the suggestion. Only a subset of fields is populated.", "$ref": "GoogleCloudDiscoveryengineV1Document" }, "score": { "description": "The score of each suggestion. The score is in the range of [0, 1].", "type": "number", "format": "double" }, "destinationUri": { "description": "The destination uri of the person suggestion.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig": { "properties": { "requiredSubscriptionTier": { "enum": [ "SUBSCRIPTION_TIER_UNSPECIFIED", "SUBSCRIPTION_TIER_SEARCH", "SUBSCRIPTION_TIER_SEARCH_AND_ASSISTANT", "SUBSCRIPTION_TIER_NOTEBOOK_LM", "SUBSCRIPTION_TIER_FRONTLINE_WORKER", "SUBSCRIPTION_TIER_AGENTSPACE_STARTER", "SUBSCRIPTION_TIER_AGENTSPACE_BUSINESS", "SUBSCRIPTION_TIER_ENTERPRISE", "SUBSCRIPTION_TIER_ENTERPRISE_EMERGING", "SUBSCRIPTION_TIER_EDU", "SUBSCRIPTION_TIER_EDU_PRO", "SUBSCRIPTION_TIER_EDU_EMERGING", "SUBSCRIPTION_TIER_EDU_PRO_EMERGING", "SUBSCRIPTION_TIER_FRONTLINE_STARTER", "SUBSCRIPTION_TIER_CONSUMPTION_ONLY", "SUBSCRIPTION_TIER_EDU_GOV_EMERGING" ], "enumDescriptions": [ "Default value.", "Search tier. Search tier can access Vertex AI Search features and NotebookLM features.", "Gemini Enterprise Plus tier.", "NotebookLM tier. NotebookLM is a subscription tier can only access NotebookLM features.", "Gemini Frontline worker tier.", "Gemini Business Starter tier.", "Gemini Business tier.", "Gemini Enterprise Standard tier.", "Gemini Enterprise Standard tier for emerging markets.", "Gemini Enterprise EDU tier.", "Gemini Enterprise EDU Pro tier.", "Gemini Enterprise EDU tier for emerging market only.", "Gemini Enterprise EDU Pro tier for emerging market.", "Gemini Frontline Starter tier.", "Represents the Gemini Enterprise Consumption-only tier: $0 subscription billed purely on usage (PAYG).", "Gemini Enterprise EDU tier for government in emerging markets." ], "type": "string", "description": "Optional. The required subscription tier of this engine. If the required subscription tier is search, user with higher license tier like assist can still access the standalone app associated with this engine. Web grounding feature is only available on the app if it is set as SubscriptionTier.SUBSCRIPTION_TIER_SEARCH_AND_ASSISTANT." }, "searchAddOns": { "type": "array", "description": "The add-on that this search engine enables.", "items": { "enum": [ "SEARCH_ADD_ON_UNSPECIFIED", "SEARCH_ADD_ON_LLM" ], "enumDescriptions": [ "Default value when the enum is unspecified. This is invalid to use.", "Large language model add-on." ], "type": "string" } }, "searchTier": { "enumDescriptions": [ "Default value when the enum is unspecified. This is invalid to use.", "Standard tier.", "Enterprise tier." ], "type": "string", "description": "The search feature tier of this engine. Different tiers might have different pricing. To learn more, check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified.", "enum": [ "SEARCH_TIER_UNSPECIFIED", "SEARCH_TIER_STANDARD", "SEARCH_TIER_ENTERPRISE" ] } }, "id": "GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig", "type": "object", "description": "Configurations for a Search Engine." }, "GoogleCloudDiscoveryengineV1alphaDynamicTool": { "description": "Configuration for dynamic tools.", "id": "GoogleCloudDiscoveryengineV1alphaDynamicTool", "type": "object", "properties": { "name": { "type": "string", "description": "Required. The name of the tool." }, "enabled": { "type": "boolean", "description": "Optional. Whether the tool is enabled." }, "description": { "description": "Optional. The description of the tool.", "type": "string" }, "displayName": { "type": "string", "description": "Optional. The display name of the tool." } } }, "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig": { "description": "Additional feature configurations for creating a `recommended-for-you` engine.", "type": "object", "properties": { "contextEventType": { "type": "string", "description": "The type of event with which the engine is queried at prediction time. If set to `generic`, only `view-item`, `media-play`,and `media-complete` will be used as `context-event` in engine training. If set to `view-home-page`, `view-home-page` will also be used as `context-events` in addition to `view-item`, `media-play`, and `media-complete`. Currently supported for the `recommended-for-you` engine. Currently supported values: `view-home-page`, `generic`." } }, "id": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig" }, "GoogleCloudDiscoveryengineV1alphaAnswerStep": { "description": "Step information.", "type": "object", "properties": { "actions": { "description": "Actions.", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepAction" }, "type": "array" }, "description": { "type": "string", "description": "The description of the step." }, "thought": { "description": "The thought of the step.", "type": "string" }, "state": { "enum": [ "STATE_UNSPECIFIED", "IN_PROGRESS", "FAILED", "SUCCEEDED" ], "type": "string", "enumDescriptions": [ "Unknown.", "Step is currently in progress.", "Step currently failed.", "Step has succeeded." ], "description": "The state of the step." } }, "id": "GoogleCloudDiscoveryengineV1alphaAnswerStep" }, "GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResultPolicyEnforcementResult": { "description": "Customer policy enforcement result for a single policy type.", "properties": { "bannedPhraseEnforcementResult": { "description": "The policy enforcement result for the banned phrase policy.", "$ref": "GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResultBannedPhraseEnforcementResult" }, "modelArmorEnforcementResult": { "description": "The policy enforcement result for the Model Armor policy.", "$ref": "GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResultModelArmorEnforcementResult" } }, "id": "GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResultPolicyEnforcementResult", "type": "object" }, "GoogleCloudDiscoveryengineV1betaAgentGatewaySettingAgentGatewayReference": { "properties": { "name": { "type": "string", "description": "Required. Immutable. The resource name of the agent gateway. Expected format: `projects/{project_number}/locations/{location}/agentGateways/{agent_gateway}`." } }, "description": "Reference to an Agent Gateway resource.", "id": "GoogleCloudDiscoveryengineV1betaAgentGatewaySettingAgentGatewayReference", "type": "object" }, "GoogleCloudDiscoveryengineV1WidgetConfigConnectorAuthState": { "type": "object", "properties": { "updateTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The authorization state update timestamp.", "type": "string" }, "authState": { "type": "string", "readOnly": true, "description": "Output only. The authorization state of the data connector.", "enum": [ "AUTH_STATE_UNSPECIFIED", "AUTHORIZED", "EXPIRED", "ACTIONS_DISABLED", "NO_AUTH" ], "enumDescriptions": [ "Default value. Also returned for synthetic placeholder `CollectionComponent` entries surfaced by `LookupWidgetConfig` with `view = WITH_AVAILABLE_CONNECTORS` (SaaS / Business only) — those entries represent connectors the caller may attach but has not yet attached.", "The user has authorized the data connector.", "The user authorization for the data connector has expired.", "The user can still make search requests but actions need to be enabled.", "The data connector does not require any authorization. Also used for placeholder entries whose underlying connector does not require user OAuth." ] }, "authorizationUri": { "type": "string", "readOnly": true, "description": "Output only. The authorization uri for the data connector. For synthetic placeholder `CollectionComponent` entries (returned by `LookupWidgetConfig` with `view = WITH_AVAILABLE_CONNECTORS` on SaaS / Business engines), this field is left empty. The widget should call `WidgetService.WidgetBuildAuthorizationUrl` on the user's \"Connect\" click to obtain a freshly-built authorization URL." } }, "id": "GoogleCloudDiscoveryengineV1WidgetConfigConnectorAuthState", "description": "Read-only connector in CollectionComponent auth state." }, "GoogleCloudDiscoveryengineV1alphaDataStoreServingConfigDataStore": { "type": "object", "description": "Stores information regarding the serving configurations at DataStore level.", "id": "GoogleCloudDiscoveryengineV1alphaDataStoreServingConfigDataStore", "properties": { "disabledForServing": { "description": "Optional. If set true, the DataStore will not be available for serving search requests.", "type": "boolean" } } }, "GoogleCloudDiscoveryengineV1alphaTenant": { "id": "GoogleCloudDiscoveryengineV1alphaTenant", "properties": { "id": { "description": "The tenant's instance ID. Examples: Jira (\"8594f221-9797-5f78-1fa4-485e198d7cd0\"), Slack (\"T123456\").", "type": "string" }, "uri": { "description": "The URI of the tenant, if applicable. For example, the URI of a Jira instance is https://my-jira-instance.atlassian.net, and a Slack tenant does not have a URI.", "type": "string" }, "displayName": { "description": "Optional display name for the tenant, e.g. \"My Slack Team\".", "type": "string" } }, "description": "Tenant information for a connector source. This includes some of the same information stored in the Credential message, but is limited to only what is needed to provide a list of accessible tenants to the user.", "type": "object" }, "GoogleCloudDiscoveryengineV1BigtableOptionsBigtableColumnFamily": { "description": "The column family of the Bigtable.", "properties": { "encoding": { "enum": [ "ENCODING_UNSPECIFIED", "TEXT", "BINARY" ], "type": "string", "description": "The encoding mode of the values when the type is not STRING. Acceptable encoding values are: * `TEXT`: indicates values are alphanumeric text strings. * `BINARY`: indicates values are encoded using `HBase Bytes.toBytes` family of functions. This can be overridden for a specific column by listing that column in `columns` and specifying an encoding for it.", "enumDescriptions": [ "The encoding is unspecified.", "Text encoding.", "Binary encoding." ] }, "columns": { "description": "The list of objects that contains column level information for each column. If a column is not present in this list it will be ignored.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1BigtableOptionsBigtableColumn" } }, "fieldName": { "type": "string", "description": "The field name to use for this column family in the document. The name has to match the pattern `a-zA-Z0-9*`. If not set, it is parsed from the family name with best effort. However, due to different naming patterns, field name collisions could happen, where parsing behavior is undefined." }, "type": { "enumDescriptions": [ "The type is unspecified.", "String type.", "Numerical type.", "Integer type.", "Variable length integer type.", "BigDecimal type.", "Boolean type.", "JSON type." ], "description": "The type of values in this column family. The values are expected to be encoded using `HBase Bytes.toBytes` function when the encoding value is set to `BINARY`.", "enum": [ "TYPE_UNSPECIFIED", "STRING", "NUMBER", "INTEGER", "VAR_INTEGER", "BIG_NUMERIC", "BOOLEAN", "JSON" ], "type": "string" } }, "type": "object", "id": "GoogleCloudDiscoveryengineV1BigtableOptionsBigtableColumnFamily" }, "A2aV1AgentProvider": { "id": "A2aV1AgentProvider", "properties": { "organization": { "description": "The providers organization name Example: \"Google\"", "type": "string" }, "url": { "type": "string", "description": "The providers reference url Example: \"https://ai.google.dev\"" } }, "description": "Represents information about the service provider of an agent.", "type": "object" }, "GoogleCloudDiscoveryengineV1alphaStartExperimentMetadata": { "description": "Metadata for AlphaEvolveService.StartExperiment long running operation.", "properties": { "createTime": { "description": "Output only. The time the operation was created.", "readOnly": true, "type": "string", "format": "google-datetime" }, "updateTime": { "format": "google-datetime", "readOnly": true, "description": "Output only. The time the operation was last updated.", "type": "string" } }, "id": "GoogleCloudDiscoveryengineV1alphaStartExperimentMetadata", "type": "object" }, "GoogleCloudDiscoveryengineV1betaSearchLinkPromotion": { "id": "GoogleCloudDiscoveryengineV1betaSearchLinkPromotion", "type": "object", "properties": { "description": { "description": "Optional. The Promotion description. Maximum length: 200 characters.", "type": "string" }, "document": { "type": "string", "description": "Optional. The Document the user wants to promote. For site search, leave unset and only populate uri. Can be set along with uri." }, "imageUri": { "description": "Optional. The promotion thumbnail image url.", "type": "string" }, "enabled": { "description": "Optional. The enabled promotion will be returned for any serving configs associated with the parent of the control this promotion is attached to. This flag is used for basic site search only.", "type": "boolean" }, "uri": { "type": "string", "description": "Optional. The URL for the page the user wants to promote. Must be set for site search. For other verticals, this is optional." }, "title": { "description": "Required. The title of the promotion. Maximum length: 160 characters.", "type": "string" } }, "description": "Promotion proto includes uri and other helping information to display the promotion." }, "GoogleCloudDiscoveryengineV1AnswerReferenceChunkInfoDocumentMetadata": { "id": "GoogleCloudDiscoveryengineV1AnswerReferenceChunkInfoDocumentMetadata", "description": "Document metadata.", "properties": { "structData": { "additionalProperties": { "description": "Properties of the object.", "type": "any" }, "type": "object", "description": "The structured JSON metadata for the document. It is populated from the struct data from the Chunk in search result." }, "uri": { "type": "string", "description": "URI for the document." }, "title": { "type": "string", "description": "Title." }, "pageIdentifier": { "type": "string", "description": "Page identifier." }, "document": { "description": "Document resource name.", "type": "string" } }, "type": "object" }, "GoogleCloudDiscoveryengineV1ServingConfigGenericConfig": { "id": "GoogleCloudDiscoveryengineV1ServingConfigGenericConfig", "description": "Specifies the configurations needed for Generic Discovery.Currently we support: * `content_search_spec`: configuration for generic content search.", "type": "object", "properties": { "contentSearchSpec": { "$ref": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpec", "description": "Specifies the expected behavior of content search. Only valid for content-search enabled data store." } } }, "GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadataSegment": { "id": "GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadataSegment", "type": "object", "properties": { "text": { "description": "The text segment itself.", "type": "string" }, "referenceIndices": { "items": { "type": "integer", "format": "int32" }, "type": "array", "description": "References for the segment." }, "groundingScore": { "description": "Score for the segment.", "type": "number", "format": "float" }, "startIndex": { "type": "string", "description": "Zero-based index indicating the start of the segment, measured in bytes of a UTF-8 string (i.e. characters encoded on multiple bytes have a length of more than one).", "format": "int64" }, "endIndex": { "format": "int64", "description": "End of the segment, exclusive.", "type": "string" } }, "description": "Grounding information for a segment of the text." }, "GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig": { "properties": {}, "type": "object", "description": "Additional config specs for a `similar-items` engine.", "id": "GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig" }, "GoogleCloudDiscoveryengineV1AssistantToolList": { "type": "object", "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" } } }, "GoogleCloudDiscoveryengineV1StreamAssistResponseSessionInfo": { "description": "Information about the session.", "id": "GoogleCloudDiscoveryengineV1StreamAssistResponseSessionInfo", "properties": { "session": { "description": "Name of the newly generated or continued session. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}`.", "type": "string" } }, "type": "object" }, "GoogleCloudDiscoveryengineV1SearchResponseQueryExpansionInfo": { "description": "Information describing query expansion including whether expansion has occurred.", "properties": { "expandedQuery": { "type": "boolean", "description": "Bool describing whether query expansion has occurred." }, "pinnedResultCount": { "type": "string", "format": "int64", "description": "Number of pinned results. This field will only be set when expansion happens and SearchRequest.QueryExpansionSpec.pin_unexpanded_results is set to true." } }, "id": "GoogleCloudDiscoveryengineV1SearchResponseQueryExpansionInfo", "type": "object" }, "GoogleCloudDiscoveryengineV1Citation": { "properties": { "uri": { "readOnly": true, "description": "Output only. Url reference of the attribution.", "type": "string" }, "startIndex": { "readOnly": true, "description": "Output only. Start index into the content.", "type": "integer", "format": "int32" }, "title": { "description": "Output only. Title of the attribution.", "type": "string", "readOnly": true }, "publicationDate": { "$ref": "GoogleTypeDate", "readOnly": true, "description": "Output only. Publication date of the attribution." }, "license": { "type": "string", "description": "Output only. License of the attribution.", "readOnly": true }, "endIndex": { "description": "Output only. End index into the content.", "readOnly": true, "type": "integer", "format": "int32" } }, "type": "object", "description": "Source attributions for content.", "id": "GoogleCloudDiscoveryengineV1Citation" }, "GoogleCloudDiscoveryengineV1alphaConnectorRun": { "properties": { "startTime": { "readOnly": true, "type": "string", "description": "Output only. The time when the connector run started.", "format": "google-datetime" }, "endTime": { "description": "Output only. The time when the connector run ended.", "format": "google-datetime", "type": "string", "readOnly": true }, "latestPauseTime": { "format": "google-datetime", "type": "string", "readOnly": true, "description": "Output only. The time when the connector run was most recently paused." }, "errors": { "type": "array", "description": "Contains info about errors incurred during the sync. Only exist if running into an error state. Contains error code and error message. Use with the `state` field.", "items": { "$ref": "GoogleRpcStatus" } }, "state": { "enum": [ "STATE_UNSPECIFIED", "RUNNING", "SUCCEEDED", "FAILED", "OVERRUN", "CANCELLED", "PENDING", "WARNING", "SKIPPED" ], "enumDescriptions": [ "Default value.", "The data sync is ongoing.", "The data sync is finished.", "The data sync is failed.", "Data sync has been running longer than expected and is still running at the time the next run is supposed to start.", "Data sync was scheduled but has been cancelled.", "Data sync is about to start.", "The data sync completed with non-fatal errors.", "An ongoing connector run has been running longer than expected, causing this run to be skipped." ], "readOnly": true, "type": "string", "description": "Output only. The state of the sync run." }, "trigger": { "type": "string", "enumDescriptions": [ "Default value.", "ConnectorRun triggered by scheduler if connector has PERIODIC sync mode.", "ConnectorRun auto triggered by connector initialization.", "ConnectorRun auto triggered by resuming connector.", "ConnectorRun triggered by user manually." ], "description": "Output only. The trigger for this ConnectorRun.", "readOnly": true, "enum": [ "TRIGGER_UNSPECIFIED", "SCHEDULER", "INITIALIZATION", "RESUME", "MANUAL" ] }, "stateUpdateTime": { "description": "Timestamp at which the connector run sync state was last updated.", "type": "string", "format": "google-datetime" }, "name": { "type": "string", "description": "Output only. The full resource name of the Connector Run. Format: `projects/*/locations/*/collections/*/dataConnector/connectorRuns/*`. The `connector_run_id` is system-generated.", "readOnly": true }, "entityRuns": { "description": "Output only. The details of the entities synced at the ConnectorRun. Each ConnectorRun consists of syncing one or more entities.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRun" }, "readOnly": true } }, "type": "object", "id": "GoogleCloudDiscoveryengineV1alphaConnectorRun", "description": "A data sync run of DataConnector. After DataConnector is successfully initialized, data syncs are scheduled at DataConnector.refresh_interval. A ConnectorRun represents a data sync either in the past or onging that the moment. //" }, "GoogleCloudDiscoveryengineV1alphaAssistAnswer": { "properties": { "name": { "description": "Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters.", "type": "string" }, "assistSkippedReasons": { "description": "Reasons for not answering the assist call.", "type": "array", "items": { "enum": [ "ASSIST_SKIPPED_REASON_UNSPECIFIED", "NON_ASSIST_SEEKING_QUERY_IGNORED", "CUSTOMER_POLICY_VIOLATION" ], "type": "string", "enumDescriptions": [ "Default value. Skip reason is not specified.", "The assistant ignored the query, because it did not appear to be answer-seeking.", "The assistant ignored the query or refused to answer because of a customer policy violation (e.g., the query or the answer contained a banned phrase)." ] } }, "customerPolicyEnforcementResult": { "description": "Optional. The field contains information about the various policy checks' results like the banned phrases or the Model Armor checks. This field is populated only if the assist call was skipped due to a policy violation.", "$ref": "GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResult" }, "replies": { "description": "Replies of the assistant.", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaAssistAnswerReply" }, "type": "array" }, "state": { "type": "string", "enumDescriptions": [ "Unknown.", "Assist operation is currently in progress.", "Assist operation has failed.", "Assist operation has succeeded.", "Assist operation has been skipped.", "Assist operation has been cancelled (e.g. client closed the stream). May contain a partial response." ], "enum": [ "STATE_UNSPECIFIED", "IN_PROGRESS", "FAILED", "SUCCEEDED", "SKIPPED", "CANCELLED" ], "description": "State of the answer generation." } }, "description": "AssistAnswer resource, main part of AssistResponse.", "type": "object", "id": "GoogleCloudDiscoveryengineV1alphaAssistAnswer" }, "GoogleCloudDiscoveryengineV1ImportIdentityMappingsResponse": { "properties": { "errorSamples": { "items": { "$ref": "GoogleRpcStatus" }, "type": "array", "description": "A sample of errors encountered while processing the request." } }, "type": "object", "id": "GoogleCloudDiscoveryengineV1ImportIdentityMappingsResponse", "description": "Response message for IdentityMappingStoreService.ImportIdentityMappings" }, "GoogleCloudDiscoveryengineV1CompletionInfo": { "id": "GoogleCloudDiscoveryengineV1CompletionInfo", "type": "object", "properties": { "selectedPosition": { "description": "End user selected CompleteQueryResponse.QuerySuggestion.suggestion position, starting from 0.", "type": "integer", "format": "int32" }, "selectedSuggestion": { "description": "End user selected CompleteQueryResponse.QuerySuggestion.suggestion.", "type": "string" } }, "description": "Detailed completion information including completion attribution token and clicked completion info." }, "GoogleCloudDiscoveryengineV1alphaDataConnectorConnectorMetadata": { "type": "object", "description": "User-facing metadata for the connector, shown on the connector detail page (title, description, short_description, author, note).", "id": "GoogleCloudDiscoveryengineV1alphaDataConnectorConnectorMetadata", "properties": { "shortDescription": { "description": "Optional. Short, subtitle-length description of the connector (e.g. shown beneath the connector name in list and detail views).", "type": "string" }, "description": { "description": "Optional. Human-readable description of the connector, shown on the connector detail page. One connector has a single description.", "type": "string" }, "author": { "description": "Optional. The party that authored the connector, e.g. \"Google\" or a third-party provider name. Lets end users see who authored a connector (future: third-party-authored connectors).", "type": "string" }, "note": { "type": "string", "description": "Optional. Free-form, multi-line note about the connector's capabilities or a custom note that can be set for the connector." }, "title": { "type": "string", "description": "Optional. Display title of the connector." } } }, "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec": { "description": "Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above.", "type": "object", "properties": { "controlPoints": { "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint" }, "description": "The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here." }, "fieldName": { "description": "The name of the field whose value will be used to determine the boost amount.", "type": "string" }, "attributeType": { "description": "The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value).", "enum": [ "ATTRIBUTE_TYPE_UNSPECIFIED", "NUMERICAL", "FRESHNESS" ], "enumDescriptions": [ "Unspecified AttributeType.", "The value of the numerical field will be used to dynamically update the boost amount. In this case, the attribute_value (the x value) of the control point will be the actual value of the numerical field for which the boost_amount is specified.", "For the freshness use case the attribute value will be the duration between the current time and the date in the datetime field specified. The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`. For example, `5D`, `3DT12H30M`, `T24H`." ], "type": "string" }, "interpolationType": { "description": "The interpolation type to be applied to connect the control points listed below.", "type": "string", "enumDescriptions": [ "Interpolation type is unspecified. In this case, it defaults to Linear.", "Piecewise linear interpolation will be applied." ], "enum": [ "INTERPOLATION_TYPE_UNSPECIFIED", "LINEAR" ] } }, "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec" }, "GoogleCloudDiscoveryengineV1betaSearchRequest": { "id": "GoogleCloudDiscoveryengineV1betaSearchRequest", "type": "object", "description": "Request message for SearchService.Search method.", "properties": { "query": { "description": "Raw search query.", "type": "string" }, "contentSearchSpec": { "description": "A specification for configuring the behavior of content search.", "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec" }, "branch": { "description": "The branch resource name, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`. Use `default_branch` as the branch ID or leave this field empty, to search documents under the default branch.", "type": "string" }, "displaySpec": { "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestDisplaySpec", "description": "Optional. Config for display feature, like match highlighting on search results." }, "boostSpec": { "description": "Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)", "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec" }, "rankingExpression": { "type": "string", "description": "Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by \"+\". * ranking_expression = function, { \" + \", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double \u003e 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result * `media_actor_match`: whether the media actor matches the query * `media_director_match`: whether the media director matches the query * `media_genre_match`: whether the media genre matches the query * `media_language_match`: whether the media language matches the query * `media_title_match`: whether the media title matches the query * `media_prefix_similarity_rank`: prefix similarity rank for media results * `media_semantic_similarity_rank`: semantic similarity rank for media results" }, "crowdingSpecs": { "description": "Optional. Crowding specifications for improving result diversity. If multiple CrowdingSpecs are specified, crowding will be evaluated on each unique combination of the `field` values, and max_count will be the maximum value of `max_count` across all CrowdingSpecs. For example, if the first CrowdingSpec has `field` = \"color\" and `max_count` = 3, and the second CrowdingSpec has `field` = \"size\" and `max_count` = 2, then after 3 documents that share the same color AND size have been returned, subsequent ones should be removed or demoted.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestCrowdingSpec" } }, "params": { "type": "object", "additionalProperties": { "type": "any" }, "description": "Additional search parameters. For public website search only, supported values are: * `user_country_code`: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided. For example, `user_country_code: \"au\"` For available codes see [Country Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) * `search_type`: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching. For example, `search_type: 1`" }, "personalizationSpec": { "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestPersonalizationSpec", "description": "The specification for personalization. Notice that if both ServingConfig.personalization_spec and SearchRequest.personalization_spec are set, SearchRequest.personalization_spec overrides ServingConfig.personalization_spec." }, "dataStoreSpecs": { "description": "Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used.", "items": { "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec" }, "type": "array" }, "orderBy": { "type": "string", "description": "The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned." }, "pageSize": { "type": "integer", "format": "int32", "description": "Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned." }, "offset": { "format": "int32", "description": "A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. A large offset may be capped to a reasonable threshold.", "type": "integer" }, "relevanceFilterSpec": { "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpec", "description": "Optional. The granular relevance filtering specification. If not specified, the global `relevance_threshold` will be used for all sub-searches. If specified, this overrides the global `relevance_threshold` to use thresholds on a per sub-search basis. This feature is currently supported only for custom and site search." }, "searchAddonSpec": { "description": "Optional. SearchAddonSpec is used to disable add-ons for search as per new repricing model. This field is only supported for search requests.", "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestSearchAddonSpec" }, "embeddingSpec": { "description": "Uses the provided embedding to do additional semantic document retrieval. The retrieval is based on the dot product of SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document embedding that is provided in SearchRequest.EmbeddingSpec.EmbeddingVector.field_path. If SearchRequest.EmbeddingSpec.EmbeddingVector.field_path is not provided, it will use ServingConfig.EmbeddingConfig.field_path.", "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec" }, "facetSpecs": { "type": "array", "description": "Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.", "items": { "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpec" } }, "pageToken": { "description": "A page token received from a previous SearchService.Search call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SearchService.Search must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.", "type": "string" }, "customRankingParams": { "description": "Optional. Optional configuration for the Custom Ranking feature.", "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestCustomRankingParams" }, "oneBoxPageSize": { "format": "int32", "description": "The maximum number of results to return for OneBox. This applies to each OneBox type individually. Default number is 10.", "type": "integer" }, "relevanceThreshold": { "type": "string", "enumDescriptions": [ "Default value. In this case, server behavior defaults to Google defined threshold.", "Lowest relevance threshold.", "Low relevance threshold.", "Medium relevance threshold.", "High relevance threshold." ], "enum": [ "RELEVANCE_THRESHOLD_UNSPECIFIED", "LOWEST", "LOW", "MEDIUM", "HIGH" ], "description": "The global relevance threshold of the search results. Defaults to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. If more granular relevance filtering is required, use the `relevance_filter_spec` instead. This feature is not supported for healthcare search." }, "queryExpansionSpec": { "description": "The query expansion specification that specifies the conditions under which query expansion occurs.", "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec" }, "regionCode": { "description": "The Unicode country/region code (CLDR) of a location, such as \"US\" and \"419\". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided.", "type": "string" }, "filter": { "description": "The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customer might have a field 'name' in their schema. In this case the filter would look like this: filter --\u003e name:'ANY(\"king kong\")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)", "type": "string" }, "relevanceScoreSpec": { "description": "Optional. The specification for returning the relevance score.", "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceScoreSpec" }, "canonicalFilter": { "type": "string", "description": "The default filter that is applied when a user performs a search without checking any filters on the search page. The filter applied to every search request when quality improvement such as query expansion is needed. In the case a query does not have a sufficient amount of results this filter will be used to determine whether or not to enable the query expansion flow. The original filter will still be used for the query expanded search. This field is strongly recommended to achieve high search quality. For more information about filter syntax, see SearchRequest.filter." }, "sessionSpec": { "description": "Session specification. Can be used only when `session` is set.", "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestSessionSpec" }, "userLabels": { "type": "object", "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." }, "searchAsYouTypeSpec": { "description": "Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical.", "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec" }, "naturalLanguageQueryUnderstandingSpec": { "description": "Optional. Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done.", "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec" }, "entity": { "type": "string", "description": "Optional. The entity for customers that may run multiple different entities, domains, sites or regions, for example, \"Google US\", \"Google Ads\", \"Waymo\", \"google.com\", \"youtube.com\", etc. If this is set, it should be exactly matched with UserEvent.entity to get search results boosted by entity." }, "userInfo": { "$ref": "GoogleCloudDiscoveryengineV1betaUserInfo", "description": "Information about the end user. Highly recommended for analytics and personalization. UserInfo.user_agent is used to deduce `device_type` for analytics." }, "session": { "description": "The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is \"How did Alphabet do in 2022?\" and the current query is \"How about 2023?\", the current query will be interpreted as \"How did Alphabet do in 2023?\". Example #2 (coordination between /search API calls and /answer API calls): Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call.", "type": "string" }, "spellCorrectionSpec": { "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestSpellCorrectionSpec", "description": "The spell correction specification that specifies the mode under which spell correction takes effect." }, "numResultsPerDataStore": { "format": "int32", "description": "Optional. The maximum number of results to retrieve from each data store. If not specified, it will use the SearchRequest.DataStoreSpec.num_results if provided, otherwise there is no limit.", "type": "integer" }, "servingConfig": { "description": "Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.", "type": "string" }, "pageCategories": { "items": { "type": "string" }, "type": "array", "description": "Optional. The categories associated with a category page. Must be set for category navigation queries to achieve good search quality. The format should be the same as PageInfo.page_category. This field is the equivalent of the query for browse (navigation) queries. It's used by the browse model when the query is empty. If the field is empty, it will not be used by the browse model. If the field contains more than one element, only the first element will be used. To represent full path of a category, use '\u003e' character to separate different hierarchies. If '\u003e' is part of the category name, replace it with other character(s). For example, `Graphics Cards \u003e RTX\u003e4090 \u003e Founders Edition` where \"RTX \u003e 4090\" represents one level, can be rewritten as `Graphics Cards \u003e RTX_4090 \u003e Founders Edition`" }, "imageQuery": { "description": "Raw image query.", "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestImageQuery" }, "safeSearch": { "type": "boolean", "description": "Whether to turn on safe search. This is only supported for website search." }, "userPseudoId": { "description": "Optional. 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`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id 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" }, "rankingExpressionBackend": { "enum": [ "RANKING_EXPRESSION_BACKEND_UNSPECIFIED", "BYOE", "CLEARBOX", "RANK_BY_EMBEDDING", "RANK_BY_FORMULA" ], "enumDeprecated": [ false, true, true, false, false ], "type": "string", "description": "Optional. The backend to use for the ranking expression evaluation.", "enumDescriptions": [ "Default option for unspecified/unknown values.", "Deprecated: Use `RANK_BY_EMBEDDING` instead. Ranking by custom embedding model, the default way to evaluate the ranking expression. Legacy enum option, `RANK_BY_EMBEDDING` should be used instead.", "Deprecated: Use `RANK_BY_FORMULA` instead. Ranking by custom formula. Legacy enum option, `RANK_BY_FORMULA` should be used instead.", "Ranking by custom embedding model, the default way to evaluate the ranking expression.", "Ranking by custom formula." ] }, "languageCode": { "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate.", "type": "string" } } }, "A2aV1SecurityScheme": { "id": "A2aV1SecurityScheme", "properties": { "apiKeySecurityScheme": { "$ref": "A2aV1APIKeySecurityScheme" }, "mtlsSecurityScheme": { "$ref": "A2aV1MutualTlsSecurityScheme" }, "httpAuthSecurityScheme": { "$ref": "A2aV1HTTPAuthSecurityScheme" }, "oauth2SecurityScheme": { "$ref": "A2aV1OAuth2SecurityScheme" }, "openIdConnectSecurityScheme": { "$ref": "A2aV1OpenIdConnectSecurityScheme" } }, "type": "object" }, "GoogleCloudDiscoveryengineV1SetUpDataConnectorMetadata": { "type": "object", "id": "GoogleCloudDiscoveryengineV1SetUpDataConnectorMetadata", "description": "Metadata for DataConnectorService.SetUpDataConnector method.", "properties": {} }, "GoogleCloudDiscoveryengineV1alphaLicenseConfig": { "properties": { "lastUserUpdateTime": { "description": "Optional. Timestamp of the most recent user-initiated update (seat count change or subscription term change). Unlike `update_time`, this field is only stamped when a customer explicitly updates the license (e.g. via the UI), and is not touched by system-driven writes (subscription pipeline, BALC propagation, etc.).", "type": "string", "format": "google-datetime" }, "earlyTerminationDate": { "readOnly": true, "$ref": "GoogleTypeDate", "description": "Output only. The date when the subscription is terminated earlier than the expiration date." }, "startDate": { "description": "Required. The start date.", "$ref": "GoogleTypeDate" }, "state": { "type": "string", "enumDescriptions": [ "Default value. The license config does not exist.", "The license config is effective and being used.", "The license config has expired.", "The license config has not started yet, and its start date is in the future.", "This is when a sub license config has returned all its seats back to BillingAccountLicenseConfig that it belongs to. Similar to EXPIRED.", "The license config is terminated earlier than the expiration date and it is deactivating. The customer will still have access in this state. It will be converted to EXPIRED after the deactivating period ends (14 days) or when the end date is reached, whichever comes first." ], "description": "Output only. The state of the license config.", "enum": [ "STATE_UNSPECIFIED", "ACTIVE", "EXPIRED", "NOT_STARTED", "WITHDRAWN", "DEACTIVATING" ], "readOnly": true }, "geminiBundle": { "readOnly": true, "description": "Output only. Whether the license config is for Gemini bundle.", "type": "boolean" }, "alertPolicyResourceConfig": { "description": "Optional. The alert policy config for this license config.", "$ref": "GoogleCloudDiscoveryengineV1alphaAlertPolicyResourceConfig" }, "autoRenew": { "description": "Optional. Whether the license config should be auto renewed when it reaches the end date.", "type": "boolean" }, "freeTrial": { "description": "Optional. Whether the license config is for free trial.", "type": "boolean" }, "subscriptionTier": { "enumDescriptions": [ "Default value.", "Search tier. Search tier can access Vertex AI Search features and NotebookLM features.", "Gemini Enterprise Plus tier.", "NotebookLM tier. NotebookLM is a subscription tier can only access NotebookLM features.", "Gemini Frontline worker tier.", "Gemini Business Starter tier.", "Gemini Business tier.", "Gemini Enterprise Standard tier.", "Gemini Enterprise Standard tier for emerging markets.", "Gemini Enterprise EDU tier.", "Gemini Enterprise EDU Pro tier.", "Gemini Enterprise EDU tier for emerging market only.", "Gemini Enterprise EDU Pro tier for emerging market.", "Gemini Frontline Starter tier.", "Represents the Gemini Enterprise Consumption-only tier: $0 subscription billed purely on usage (PAYG).", "Gemini Enterprise EDU tier for government in emerging markets." ], "enum": [ "SUBSCRIPTION_TIER_UNSPECIFIED", "SUBSCRIPTION_TIER_SEARCH", "SUBSCRIPTION_TIER_SEARCH_AND_ASSISTANT", "SUBSCRIPTION_TIER_NOTEBOOK_LM", "SUBSCRIPTION_TIER_FRONTLINE_WORKER", "SUBSCRIPTION_TIER_AGENTSPACE_STARTER", "SUBSCRIPTION_TIER_AGENTSPACE_BUSINESS", "SUBSCRIPTION_TIER_ENTERPRISE", "SUBSCRIPTION_TIER_ENTERPRISE_EMERGING", "SUBSCRIPTION_TIER_EDU", "SUBSCRIPTION_TIER_EDU_PRO", "SUBSCRIPTION_TIER_EDU_EMERGING", "SUBSCRIPTION_TIER_EDU_PRO_EMERGING", "SUBSCRIPTION_TIER_FRONTLINE_STARTER", "SUBSCRIPTION_TIER_CONSUMPTION_ONLY", "SUBSCRIPTION_TIER_EDU_GOV_EMERGING" ], "type": "string", "description": "Required. Subscription tier information for the license config." }, "endDate": { "$ref": "GoogleTypeDate", "description": "Optional. The planed end date." }, "licenseCount": { "description": "Required. Number of licenses purchased.", "type": "string", "format": "int64" }, "name": { "description": "Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project}/locations/{location}/licenseConfigs/{license_config}`", "type": "string" }, "subscriptionTerm": { "description": "Required. Subscription term.", "enumDescriptions": [ "Default value, do not use.", "1 month.", "1 year.", "3 years.", "Custom term. Must set the end_date." ], "type": "string", "enum": [ "SUBSCRIPTION_TERM_UNSPECIFIED", "SUBSCRIPTION_TERM_ONE_MONTH", "SUBSCRIPTION_TERM_ONE_YEAR", "SUBSCRIPTION_TERM_THREE_YEARS", "SUBSCRIPTION_TERM_CUSTOM" ] }, "earlyTerminated": { "description": "Output only. Indication of whether the subscription is terminated earlier than the expiration date. This is usually terminated by pipeline once the subscription gets terminated from subsv3.", "type": "boolean", "readOnly": true } }, "id": "GoogleCloudDiscoveryengineV1alphaLicenseConfig", "type": "object", "description": "Information about users' licenses." }, "GoogleCloudDiscoveryengineV1SearchRequestSessionSpec": { "id": "GoogleCloudDiscoveryengineV1SearchRequestSessionSpec", "type": "object", "properties": { "searchResultPersistenceCount": { "type": "integer", "format": "int32", "description": "The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is similar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode." }, "queryId": { "description": "If set, the search result gets stored to the \"turn\" specified by this query ID. Example: Let's say the session looks like this: session { name: \".../sessions/xxx\" turns { query { text: \"What is foo?\" query_id: \".../questions/yyy\" } answer: \"Foo is ...\" } turns { query { text: \"How about bar then?\" query_id: \".../questions/zzz\" } } } The user can call /search API with a request like this: session: \".../sessions/xxx\" session_spec { query_id: \".../questions/zzz\" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID.", "type": "string" } }, "description": "Session specification." }, "GoogleCloudDiscoveryengineV1alphaDeleteAgentMetadata": { "type": "object", "description": "Metadata related to the progress of the AgentService.DeleteAgent operation. This will be returned by the google.longrunning.Operation.metadata field.", "properties": { "createTime": { "format": "google-datetime", "type": "string", "description": "Operation create time." }, "updateTime": { "type": "string", "format": "google-datetime", "description": "Operation last update time. If the operation is done, this is also the finish time." } }, "id": "GoogleCloudDiscoveryengineV1alphaDeleteAgentMetadata" }, "GoogleCloudDiscoveryengineV1DocumentProcessingConfig": { "type": "object", "description": "A singleton resource of DataStore. If it's empty when DataStore is created and DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED, the default parser will default to digital parser.", "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfig", "properties": { "name": { "description": "The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`.", "type": "string" }, "defaultParsingConfig": { "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.", "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig" }, "chunkingConfig": { "description": "Whether chunking mode is enabled.", "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig" }, "parsingConfigOverrides": { "description": "Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported. * `xlsm`: Override parsing config for XLSM files, only digital parsing and layout parsing are supported. * `xlsx`: Override parsing config for XLSX files, only digital parsing and layout parsing are supported.", "type": "object", "additionalProperties": { "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig" } } } }, "GoogleCloudDiscoveryengineV1EngineCommonConfig": { "description": "Common configurations for an Engine.", "properties": { "companyName": { "type": "string", "description": "The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features." } }, "id": "GoogleCloudDiscoveryengineV1EngineCommonConfig", "type": "object" }, "GoogleCloudDiscoveryengineV1ImportUserEventsRequest": { "properties": { "bigquerySource": { "description": "BigQuery input source.", "$ref": "GoogleCloudDiscoveryengineV1BigQuerySource" }, "gcsSource": { "description": "Cloud Storage location for the input content.", "$ref": "GoogleCloudDiscoveryengineV1GcsSource" }, "inlineSource": { "description": "The Inline source for the input content for UserEvents.", "$ref": "GoogleCloudDiscoveryengineV1ImportUserEventsRequestInlineSource" }, "errorConfig": { "$ref": "GoogleCloudDiscoveryengineV1ImportErrorConfig", "description": "The desired location of errors incurred during the Import. Cannot be set for inline user event imports." } }, "type": "object", "description": "Request message for the ImportUserEvents request.", "id": "GoogleCloudDiscoveryengineV1ImportUserEventsRequest" }, "GoogleCloudDiscoveryengineV1WorkspaceConfig": { "description": "Config to store data store type configuration for workspace data", "type": "object", "properties": { "superAdminServiceAccount": { "type": "string", "description": "Optional. The super admin service account for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion." }, "superAdminEmailAddress": { "description": "Optional. The super admin email address for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion.", "type": "string" }, "dasherCustomerId": { "readOnly": true, "description": "Output only. Obfuscated Dasher customer ID. Derived by the server from the project's GCP organization at data store creation time; any value supplied in the request payload is ignored.", "type": "string" }, "type": { "type": "string", "enum": [ "TYPE_UNSPECIFIED", "GOOGLE_DRIVE", "GOOGLE_MAIL", "GOOGLE_SITES", "GOOGLE_CALENDAR", "GOOGLE_CHAT", "GOOGLE_GROUPS", "GOOGLE_KEEP", "GOOGLE_PEOPLE", "GOOGLE_WORKSPACE" ], "description": "The Google Workspace data source.", "enumDescriptions": [ "Defaults to an unspecified Workspace type.", "Workspace Data Store contains Drive data", "Workspace Data Store contains Mail data", "Workspace Data Store contains Sites data", "Workspace Data Store contains Calendar data", "Workspace Data Store contains Chat data", "Workspace Data Store contains Groups data", "Workspace Data Store contains Keep data", "Workspace Data Store contains People data", "Workspace Data Store contains all Workspace apps data" ] } }, "id": "GoogleCloudDiscoveryengineV1WorkspaceConfig" }, "GoogleCloudDiscoveryengineV1betaControlSynonymsAction": { "description": "Creates a set of terms that will act as synonyms of one another. Example: \"happy\" will also be considered as \"glad\", \"glad\" will also be considered as \"happy\".", "properties": { "synonyms": { "type": "array", "description": "Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is thrown.", "items": { "type": "string" } } }, "id": "GoogleCloudDiscoveryengineV1betaControlSynonymsAction", "type": "object" }, "GoogleCloudDiscoveryengineV1betaTargetSiteFailureReason": { "properties": { "quotaFailure": { "$ref": "GoogleCloudDiscoveryengineV1betaTargetSiteFailureReasonQuotaFailure", "description": "Failed due to insufficient quota." } }, "id": "GoogleCloudDiscoveryengineV1betaTargetSiteFailureReason", "description": "Site search indexing failure reasons.", "type": "object" }, "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint": { "id": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint", "type": "object", "description": "The control points used to define the curve. The curve defined through these control points can only be monotonically increasing or decreasing(constant values are acceptable).", "properties": { "attributeValue": { "type": "string", "description": "Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`." }, "boostAmount": { "format": "float", "type": "number", "description": "The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above." } } }, "GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateMetadata": { "id": "GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateMetadata", "properties": { "createTime": { "type": "string", "format": "google-datetime", "description": "Operation create time." }, "updateTime": { "type": "string", "format": "google-datetime", "description": "Operation last update time. If the operation is done, this is also the finish time." } }, "description": "Metadata related to the progress of the CrawlRateManagementService.SetDedicatedCrawlRate operation. This will be returned by the google.longrunning.Operation.metadata field.", "type": "object" }, "GoogleCloudDiscoveryengineV1SearchResponse": { "description": "Response message for SearchService.Search method.", "properties": { "summary": { "description": "A summary as part of the search results. This field is only returned if SearchRequest.ContentSearchSpec.summary_spec is set.", "$ref": "GoogleCloudDiscoveryengineV1SearchResponseSummary" }, "results": { "type": "array", "description": "A list of matched documents. The order represents the ranking.", "items": { "$ref": "GoogleCloudDiscoveryengineV1SearchResponseSearchResult" } }, "sessionInfo": { "$ref": "GoogleCloudDiscoveryengineV1SearchResponseSessionInfo", "description": "Session information. Only set if SearchRequest.session is provided. See its description for more details." }, "nextPageToken": { "description": "A token that can be sent as SearchRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" }, "redirectUri": { "description": "The URI of a customer-defined redirect page. If redirect action is triggered, no search is performed, and only redirect_uri and attribution_token are set in the response.", "type": "string" }, "queryExpansionInfo": { "description": "Query expansion information for the returned results.", "$ref": "GoogleCloudDiscoveryengineV1SearchResponseQueryExpansionInfo" }, "searchLinkPromotions": { "items": { "$ref": "GoogleCloudDiscoveryengineV1SearchLinkPromotion" }, "description": "Promotions for site search.", "type": "array" }, "semanticState": { "type": "string", "readOnly": true, "enum": [ "SEMANTIC_STATE_UNSPECIFIED", "DISABLED", "ENABLED" ], "enumDescriptions": [ "Default value. Should not be used.", "Semantic search was disabled for this search response.", "Semantic search was enabled for this search response." ], "description": "Output only. Indicates the semantic state of the search response." }, "attributionToken": { "description": "A unique search token. This should be included in the UserEvent logs resulting from this search, which enables accurate attribution of search model performance. This also helps to identify a request during the customer support scenarios.", "type": "string" }, "correctedQuery": { "type": "string", "description": "Contains the spell corrected query, if found. If the spell correction type is AUTOMATIC, then the search results are based on corrected_query. Otherwise the original query is used for search." }, "totalSize": { "format": "int32", "type": "integer", "description": "The estimated total count of matched items irrespective of pagination. The count of results returned by pagination may be less than the total_size that matches." }, "appliedControls": { "items": { "type": "string" }, "description": "Optional. Controls applied as part of the Control service.", "type": "array" }, "facets": { "description": "Results of facets requested by user.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1SearchResponseFacet" } }, "naturalLanguageQueryUnderstandingInfo": { "readOnly": true, "description": "Output only. Natural language query understanding information for the returned results.", "$ref": "GoogleCloudDiscoveryengineV1SearchResponseNaturalLanguageQueryUnderstandingInfo" } }, "id": "GoogleCloudDiscoveryengineV1SearchResponse", "type": "object" }, "GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec": { "description": "Specification for search as you type in search requests.", "properties": { "condition": { "description": "The condition under which search as you type should occur. Default to Condition.DISABLED.", "type": "string", "enumDescriptions": [ "Server behavior defaults to Condition.DISABLED.", "Disables Search As You Type.", "Enables Search As You Type.", "Automatic switching between search-as-you-type and standard search modes, ideal for single-API implementations (e.g., debouncing)." ], "enum": [ "CONDITION_UNSPECIFIED", "DISABLED", "ENABLED", "AUTO" ] } }, "type": "object", "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec" }, "GoogleCloudDiscoveryengineV1alphaRemoveDedicatedCrawlRateMetadata": { "type": "object", "description": "Metadata related to the progress of the CrawlRateManagementService.RemoveDedicatedCrawlRate operation. This will be returned by the google.longrunning.Operation.metadata field.", "properties": { "createTime": { "type": "string", "description": "Operation create time.", "format": "google-datetime" }, "updateTime": { "format": "google-datetime", "type": "string", "description": "Operation last update time. If the operation is done, this is also the finish time." } }, "id": "GoogleCloudDiscoveryengineV1alphaRemoveDedicatedCrawlRateMetadata" }, "GoogleTypeDateTime": { "id": "GoogleTypeDateTime", "description": "Represents civil time (or occasionally physical time). This type can represent a civil time in one of a few possible ways: * When utc_offset is set and time_zone is unset: a civil time on a calendar day with a particular offset from UTC. * When time_zone is set and utc_offset is unset: a civil time on a calendar day in a particular time zone. * When neither time_zone nor utc_offset is set: a civil time on a calendar day in local time. The date is relative to the Proleptic Gregorian Calendar. If year, month, or day are 0, the DateTime is considered not to have a specific year, month, or day respectively. This type may also be used to represent a physical time if all the date and time fields are set and either case of the `time_offset` oneof is set. Consider using `Timestamp` message for physical time instead. If your use case also would like to store the user's timezone, that can be done in another field. This type is more flexible than some applications may want. Make sure to document and validate your application's limitations.", "properties": { "year": { "description": "Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year.", "type": "integer", "format": "int32" }, "month": { "format": "int32", "type": "integer", "description": "Optional. Month of year. Must be from 1 to 12, or 0 if specifying a datetime without a month." }, "hours": { "type": "integer", "format": "int32", "description": "Optional. Hours of day in 24 hour format. Should be from 0 to 23, defaults to 0 (midnight). An API may choose to allow the value \"24:00:00\" for scenarios like business closing time." }, "minutes": { "format": "int32", "type": "integer", "description": "Optional. Minutes of hour of day. Must be from 0 to 59, defaults to 0." }, "day": { "type": "integer", "description": "Optional. Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a datetime without a day.", "format": "int32" }, "nanos": { "format": "int32", "description": "Optional. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999, defaults to 0.", "type": "integer" }, "utcOffset": { "type": "string", "description": "UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }.", "format": "google-duration" }, "seconds": { "format": "int32", "type": "integer", "description": "Optional. Seconds of minutes of the time. Must normally be from 0 to 59, defaults to 0. An API may allow the value 60 if it allows leap-seconds." }, "timeZone": { "$ref": "GoogleTypeTimeZone", "description": "Time zone." } }, "type": "object" }, "GoogleCloudDiscoveryengineV1PurgeDocumentsRequestInlineSource": { "description": "The inline source for the input config for DocumentService.PurgeDocuments method.", "properties": { "documents": { "description": "Required. A list of full resource name of documents to purge. In the format `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`. Recommended max of 100 items.", "type": "array", "items": { "type": "string" } } }, "id": "GoogleCloudDiscoveryengineV1PurgeDocumentsRequestInlineSource", "type": "object" }, "GoogleCloudDiscoveryengineV1CliConfig": { "type": "object", "id": "GoogleCloudDiscoveryengineV1CliConfig", "properties": { "enabledActions": { "items": { "type": "string" }, "type": "array", "description": "Optional. The actions enabled on the associated CLI connection." } }, "description": "The configuration for the CLI execution based connectors." }, "GoogleCloudDiscoveryengineV1alphaUserInfo": { "id": "GoogleCloudDiscoveryengineV1alphaUserInfo", "type": "object", "description": "Information of an end user.", "properties": { "preciseLocation": { "description": "Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents.", "$ref": "GoogleCloudDiscoveryengineV1alphaUserInfoPreciseLocation" }, "userAgent": { "type": "string", "description": "User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set." }, "timeZone": { "description": "Optional. IANA time zone, e.g. Europe/Budapest.", "type": "string" }, "userId": { "description": "Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1SearchResponseSummarySummaryWithMetadata": { "type": "object", "description": "Summary with metadata information.", "id": "GoogleCloudDiscoveryengineV1SearchResponseSummarySummaryWithMetadata", "properties": { "summary": { "type": "string", "description": "Summary text with no citation information." }, "references": { "description": "Document References.", "items": { "$ref": "GoogleCloudDiscoveryengineV1SearchResponseSummaryReference" }, "type": "array" }, "citationMetadata": { "$ref": "GoogleCloudDiscoveryengineV1SearchResponseSummaryCitationMetadata", "description": "Citation metadata for given summary." } } }, "GoogleCloudDiscoveryengineV1BatchCreateTargetSitesRequest": { "description": "Request message for SiteSearchEngineService.BatchCreateTargetSites method.", "properties": { "requests": { "type": "array", "description": "Required. The request message specifying the resources to create. A maximum of 20 TargetSites can be created in a batch.", "items": { "$ref": "GoogleCloudDiscoveryengineV1CreateTargetSiteRequest" } } }, "type": "object", "id": "GoogleCloudDiscoveryengineV1BatchCreateTargetSitesRequest" }, "GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpecFacetKey": { "id": "GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpecFacetKey", "properties": { "caseInsensitive": { "type": "boolean", "description": "True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise." }, "intervals": { "description": "Set only if values should be bucketed into intervals. Must be set for facets with numerical values. Must not be set for facet with text values. Maximum number of intervals is 30.", "items": { "$ref": "GoogleCloudDiscoveryengineV1betaInterval" }, "type": "array" }, "restrictedValues": { "items": { "type": "string" }, "type": "array", "description": "Only get facet for the given restricted values. Only supported on textual fields. For example, suppose \"category\" has three values \"Action \u003e 2022\", \"Action \u003e 2021\" and \"Sci-Fi \u003e 2022\". If set \"restricted_values\" to \"Action \u003e 2022\", the \"category\" facet only contains \"Action \u003e 2022\". Only supported on textual fields. Maximum is 10." }, "contains": { "description": "Only get facet values that contain the given strings. For example, suppose \"category\" has three values \"Action \u003e 2022\", \"Action \u003e 2021\" and \"Sci-Fi \u003e 2022\". If set \"contains\" to \"2022\", the \"category\" facet only contains \"Action \u003e 2022\" and \"Sci-Fi \u003e 2022\". Only supported on textual fields. Maximum is 10.", "items": { "type": "string" }, "type": "array" }, "prefixes": { "description": "Only get facet values that start with the given string prefix. For example, suppose \"category\" has three values \"Action \u003e 2022\", \"Action \u003e 2021\" and \"Sci-Fi \u003e 2022\". If set \"prefixes\" to \"Action\", the \"category\" facet only contains \"Action \u003e 2022\" and \"Action \u003e 2021\". Only supported on textual fields. Maximum is 10.", "items": { "type": "string" }, "type": "array" }, "key": { "description": "Required. Supported textual and numerical facet keys in Document object, over which the facet values are computed. Facet key is case-sensitive.", "type": "string" }, "orderBy": { "description": "The order in which documents are returned. Allowed values are: * \"count desc\", which means order by SearchResponse.Facet.values.count descending. * \"value desc\", which means order by SearchResponse.Facet.values.value descending. Only applies to textual facets. If not set, textual values are sorted in [natural order](https://en.wikipedia.org/wiki/Natural_sort_order); numerical intervals are sorted in the order given by FacetSpec.FacetKey.intervals.", "type": "string" } }, "type": "object", "description": "Specifies how a facet is computed." }, "GoogleCloudDiscoveryengineV1CheckGroundingResponseClaim": { "type": "object", "id": "GoogleCloudDiscoveryengineV1CheckGroundingResponseClaim", "properties": { "endPos": { "description": "Position indicating the end of the claim in the answer candidate, exclusive, in bytes. Note that this is not measured in characters and, therefore, must be rendered as such. For example, if the claim text contains non-ASCII characters, the start and end positions vary when measured in characters (programming-language-dependent) and when measured in bytes (programming-language-independent).", "type": "integer", "format": "int32" }, "score": { "type": "number", "format": "double", "description": "Confidence score for the claim in the answer candidate, in the range of [0, 1]. This is set only when `CheckGroundingRequest.grounding_spec.enable_claim_level_score` is true." }, "startPos": { "type": "integer", "description": "Position indicating the start of the claim in the answer candidate, measured in bytes. Note that this is not measured in characters and, therefore, must be rendered in the user interface keeping in mind that some characters may take more than one byte. For example, if the claim text contains non-ASCII characters, the start and end positions vary when measured in characters (programming-language-dependent) and when measured in bytes (programming-language-independent).", "format": "int32" }, "groundingCheckRequired": { "type": "boolean", "description": "Indicates that this claim required grounding check. When the system decided this claim doesn't require attribution/grounding check, this field will be set to false. In that case, no grounding check was done for the claim and therefore citation_indices should not be returned." }, "citationIndices": { "type": "array", "description": "A list of indices (into 'cited_chunks') specifying the citations associated with the claim. For instance [1,3,4] means that cited_chunks[1], cited_chunks[3], cited_chunks[4] are the facts cited supporting for the claim. A citation to a fact indicates that the claim is supported by the fact.", "items": { "format": "int32", "type": "integer" } }, "claimText": { "description": "Text for the claim in the answer candidate. Always provided regardless of whether citations or anti-citations are found.", "type": "string" } }, "description": "Text and citation info for a claim in the answer candidate." }, "GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesResponse": { "type": "object", "id": "GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesResponse", "properties": { "purgeCount": { "format": "int64", "type": "string", "description": "Number of suggestion deny list entries purged." }, "errorSamples": { "items": { "$ref": "GoogleRpcStatus" }, "type": "array", "description": "A sample of errors encountered while processing the request." } }, "description": "Response message for CompletionService.PurgeSuggestionDenyListEntries method." }, "GoogleCloudDiscoveryengineV1IdentityMappingEntry": { "type": "object", "description": "Identity Mapping Entry that maps an external identity to an internal identity.", "properties": { "externalIdentity": { "description": "Required. Identity outside the customer identity provider. The length limit of external identity will be of 100 characters.", "type": "string" }, "externalIdentityName": { "description": "Optional. The name of the external identity.", "type": "string" }, "userId": { "description": "User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider, user_id is the mapped user identifier configured during the workforcepool config.", "type": "string" }, "groupId": { "type": "string", "description": "Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider, group_id is the mapped group identifier configured during the workforcepool config." } }, "id": "GoogleCloudDiscoveryengineV1IdentityMappingEntry" }, "GoogleCloudDiscoveryengineV1betaDeleteIdentityMappingStoreMetadata": { "description": "Metadata related to the progress of the IdentityMappingStoreService.DeleteIdentityMappingStore operation. This will be returned by the google.longrunning.Operation.metadata field.", "properties": { "createTime": { "type": "string", "description": "Operation create time.", "format": "google-datetime" }, "updateTime": { "format": "google-datetime", "type": "string", "description": "Operation last update time. If the operation is done, this is also the finish time." } }, "id": "GoogleCloudDiscoveryengineV1betaDeleteIdentityMappingStoreMetadata", "type": "object" }, "GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResultChunkInfo": { "id": "GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResultChunkInfo", "properties": { "content": { "description": "Chunk textual content.", "type": "string" }, "relevanceScore": { "description": "The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation.", "format": "float", "type": "number" }, "chunk": { "type": "string", "description": "Chunk resource name." } }, "description": "Chunk information.", "type": "object" }, "GoogleCloudDiscoveryengineV1betaDeleteSchemaMetadata": { "description": "Metadata for DeleteSchema LRO.", "id": "GoogleCloudDiscoveryengineV1betaDeleteSchemaMetadata", "type": "object", "properties": { "updateTime": { "format": "google-datetime", "description": "Operation last update time. If the operation is done, this is also the finish time.", "type": "string" }, "createTime": { "type": "string", "description": "Operation create time.", "format": "google-datetime" } } } }, "ownerDomain": "google.com", "canonicalName": "Discovery Engine", "baseUrl": "https://discoveryengine.googleapis.com/", "endpoints": [ { "location": "asia-northeast1", "description": "Regional Endpoint", "endpointUrl": "https://discoveryengine.asia-northeast1.rep.googleapis.com/" }, { "location": "europe-west2", "description": "Regional Endpoint", "endpointUrl": "https://discoveryengine.europe-west2.rep.googleapis.com/" }, { "endpointUrl": "https://discoveryengine.us.rep.googleapis.com/", "description": "Regional Endpoint", "location": "us" }, { "endpointUrl": "https://discoveryengine.eu.rep.googleapis.com/", "location": "eu", "description": "Regional Endpoint" }, { "description": "Regional Endpoint", "location": "in", "endpointUrl": "https://discoveryengine.in.rep.googleapis.com/" }, { "description": "Regional Endpoint", "location": "asia-southeast1", "endpointUrl": "https://discoveryengine.asia-southeast1.rep.googleapis.com/" }, { "description": "Regional Endpoint", "location": "europe-west3", "endpointUrl": "https://discoveryengine.europe-west3.rep.googleapis.com/" }, { "location": "ca", "description": "Regional Endpoint", "endpointUrl": "https://discoveryengine.ca.rep.googleapis.com/" } ], "version": "v1", "resources": { "billingAccounts": { "resources": { "billingAccountLicenseConfigs": { "methods": { "distributeLicenseConfig": { "path": "v1/{+billingAccountLicenseConfig}:distributeLicenseConfig", "request": { "$ref": "GoogleCloudDiscoveryengineV1DistributeLicenseConfigRequest" }, "id": "discoveryengine.billingAccounts.billingAccountLicenseConfigs.distributeLicenseConfig", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1DistributeLicenseConfigResponse" }, "httpMethod": "POST", "parameters": { "billingAccountLicenseConfig": { "required": true, "type": "string", "pattern": "^billingAccounts/[^/]+/billingAccountLicenseConfigs/[^/]+$", "description": "Required. Full resource name of BillingAccountLicenseConfig. Format: `billingAccounts/{billing_account}/billingAccountLicenseConfigs/{billing_account_license_config_id}`.", "location": "path" } }, "flatPath": "v1/billingAccounts/{billingAccountsId}/billingAccountLicenseConfigs/{billingAccountLicenseConfigsId}:distributeLicenseConfig", "parameterOrder": [ "billingAccountLicenseConfig" ], "description": "Distributes a LicenseConfig from billing account level to project level." }, "retractLicenseConfig": { "description": "This method is called from the billing account side to retract the LicenseConfig from the given project back to the billing account.", "parameterOrder": [ "billingAccountLicenseConfig" ], "flatPath": "v1/billingAccounts/{billingAccountsId}/billingAccountLicenseConfigs/{billingAccountLicenseConfigsId}:retractLicenseConfig", "id": "discoveryengine.billingAccounts.billingAccountLicenseConfigs.retractLicenseConfig", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "path": "v1/{+billingAccountLicenseConfig}:retractLicenseConfig", "response": { "$ref": "GoogleCloudDiscoveryengineV1RetractLicenseConfigResponse" }, "request": { "$ref": "GoogleCloudDiscoveryengineV1RetractLicenseConfigRequest" }, "httpMethod": "POST", "parameters": { "billingAccountLicenseConfig": { "description": "Required. Full resource name of BillingAccountLicenseConfig. Format: `billingAccounts/{billing_account}/billingAccountLicenseConfigs/{billing_account_license_config_id}`.", "type": "string", "location": "path", "pattern": "^billingAccounts/[^/]+/billingAccountLicenseConfigs/[^/]+$", "required": true } } } } } } }, "projects": { "resources": { "operations": { "methods": { "cancel": { "response": { "$ref": "GoogleProtobufEmpty" }, "parameterOrder": [ "name" ], "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "parameters": { "name": { "location": "path", "required": true, "description": "The name of the operation resource to be cancelled.", "type": "string", "pattern": "^projects/[^/]+/operations/[^/]+$" } }, "id": "discoveryengine.projects.operations.cancel", "flatPath": "v1/projects/{projectsId}/operations/{operationsId}:cancel", "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "path": "v1/{+name}:cancel", "request": { "$ref": "GoogleLongrunningCancelOperationRequest" } }, "list": { "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "flatPath": "v1/projects/{projectsId}/operations", "id": "discoveryengine.projects.operations.list", "path": "v1/{+name}/operations", "httpMethod": "GET", "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "parameters": { "name": { "location": "path", "type": "string", "required": true, "pattern": "^projects/[^/]+$", "description": "The name of the operation's parent resource." }, "filter": { "description": "The standard list filter.", "location": "query", "type": "string" }, "returnPartialSuccess": { "location": "query", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "type": "boolean" }, "pageToken": { "location": "query", "type": "string", "description": "The standard list page token." }, "pageSize": { "description": "The standard list page size.", "format": "int32", "type": "integer", "location": "query" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "parameterOrder": [ "name" ] }, "get": { "id": "discoveryengine.projects.operations.get", "httpMethod": "GET", "parameters": { "name": { "type": "string", "pattern": "^projects/[^/]+/operations/[^/]+$", "required": true, "description": "The name of the operation resource.", "location": "path" } }, "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "flatPath": "v1/projects/{projectsId}/operations/{operationsId}", "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "path": "v1/{+name}", "parameterOrder": [ "name" ] } } }, "locations": { "resources": { "rankingConfigs": { "methods": { "rank": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/rankingConfigs/{rankingConfigsId}:rank", "request": { "$ref": "GoogleCloudDiscoveryengineV1RankRequest" }, "response": { "$ref": "GoogleCloudDiscoveryengineV1RankResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "id": "discoveryengine.projects.locations.rankingConfigs.rank", "parameterOrder": [ "rankingConfig" ], "parameters": { "rankingConfig": { "location": "path", "type": "string", "required": true, "description": "Required. The resource name of the rank service config, such as `projects/{project_num}/locations/{location}/rankingConfigs/default_ranking_config`.", "pattern": "^projects/[^/]+/locations/[^/]+/rankingConfigs/[^/]+$" } }, "httpMethod": "POST", "description": "Ranks a list of text records based on the given input query.", "path": "v1/{+rankingConfig}:rank" } } }, "collections": { "methods": { "delete": { "parameterOrder": [ "name" ], "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "response": { "$ref": "GoogleLongrunningOperation" }, "id": "discoveryengine.projects.locations.collections.delete", "description": "Deletes a Collection.", "parameters": { "name": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+$", "required": true, "location": "path", "description": "Required. The full resource name of the Collection, in the format of `projects/{project}/locations/{location}/collections/{collection}`." } }, "httpMethod": "DELETE" }, "setIamPolicy": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "id": "discoveryengine.projects.locations.collections.setIamPolicy", "httpMethod": "POST", "parameters": { "resource": { "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+$", "type": "string", "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field." } }, "description": "Sets the IAM access control policy for a Collection. A `NOT_FOUND` error is returned if the resource does not exist. **Important:** When setting a policy directly on a Collection resource, the only recommended roles in the bindings are: `roles/discoveryengine.admin` `roles/discoveryengine.agentspaceAdmin` `roles/discoveryengine.viewer` `roles/discoveryengine.agentspaceViewer` `roles/discoveryengine.user` `roles/discoveryengine.agentspaceUser` Attempting to grant any other role will result in a warning in logging.", "response": { "$ref": "GoogleIamV1Policy" }, "request": { "$ref": "GoogleIamV1SetIamPolicyRequest" }, "path": "v1/{+resource}:setIamPolicy", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}:setIamPolicy", "parameterOrder": [ "resource" ] }, "updateDataConnector": { "response": { "$ref": "GoogleCloudDiscoveryengineV1DataConnector" }, "description": "Updates a DataConnector.", "request": { "$ref": "GoogleCloudDiscoveryengineV1DataConnector" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.assist.readwrite", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataConnector", "httpMethod": "PATCH", "parameters": { "updateMask": { "format": "google-fieldmask", "type": "string", "location": "query", "description": "Indicates which fields in the provided DataConnector to update. Supported field paths include: - `refresh_interval` - `params` - `auto_run_disabled` - `action_config` - `action_config.action_params` - `action_config.service_name` - `destination_configs` - `blocking_reasons` - `sync_mode` - `incremental_sync_disabled` - `incremental_refresh_interval` - `data_protection_policy` Note: Support for these fields may vary depending on the connector type. For example, not all connectors support `destination_configs`. If an unsupported or unknown field path is provided, the request will return an `INVALID_ARGUMENT` error." }, "name": { "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataConnector$", "description": "Identifier. The full resource name of the Data Connector. Format: `projects/*/locations/*/collections/*/dataConnector`.", "required": true, "type": "string", "location": "path" } }, "parameterOrder": [ "name" ], "id": "discoveryengine.projects.locations.collections.updateDataConnector" }, "getIamPolicy": { "path": "v1/{+resource}:getIamPolicy", "httpMethod": "GET", "parameters": { "options.requestedPolicyVersion": { "type": "integer", "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "format": "int32", "location": "query" }, "resource": { "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+$", "required": true, "location": "path", "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "type": "string" } }, "id": "discoveryengine.projects.locations.collections.getIamPolicy", "parameterOrder": [ "resource" ], "response": { "$ref": "GoogleIamV1Policy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "description": "Gets the IAM access control policy for a Collection. A `NOT_FOUND` error is returned if the resource does not exist. An empty policy is returned if the resource exists but does not have a policy set on it.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}:getIamPolicy" }, "getDataConnector": { "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1DataConnector" }, "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataConnector", "description": "Gets the DataConnector. DataConnector is a singleton resource for each Collection.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.assist.readwrite", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "httpMethod": "GET", "parameters": { "name": { "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataConnector$", "description": "Required. Full resource name of DataConnector, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataConnector`. If the caller does not have permission to access the DataConnector, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the requested DataConnector does not exist, a `NOT_FOUND` error is returned.", "type": "string" } }, "id": "discoveryengine.projects.locations.collections.getDataConnector" } }, "resources": { "dataConnector": { "methods": { "mcp": { "parameterOrder": [ "projectsId", "locationsId", "collectionsId" ], "response": { "$ref": "GoogleApiHttpBody" }, "httpMethod": "DELETE", "parameters": { "extensions": { "description": "Application specific response metadata. Must be set in the first response for streaming APIs.", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." }, "type": "object", "location": "query", "repeated": true }, "collectionsId": { "required": true, "type": "string", "location": "path" }, "data": { "format": "byte", "description": "The HTTP request/response body as raw binary.", "type": "string", "location": "query" }, "locationsId": { "type": "string", "required": true, "location": "path" }, "projectsId": { "type": "string", "required": true, "location": "path" }, "contentType": { "description": "The HTTP Content-Type header value specifying the content type of the body.", "type": "string", "location": "query" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "id": "discoveryengine.projects.locations.collections.dataConnector.mcp", "path": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataConnector/mcp", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataConnector/mcp", "description": "ServeMcpDeleteRequest serves a MCP DELETE request." } }, "resources": { "operations": { "methods": { "get": { "httpMethod": "GET", "path": "v1/{+name}", "parameters": { "name": { "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataConnector/operations/[^/]+$", "required": true, "description": "The name of the operation resource." } }, "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataConnector/operations/{operationsId}", "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "id": "discoveryengine.projects.locations.collections.dataConnector.operations.get" }, "list": { "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "httpMethod": "GET", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataConnector/operations", "id": "discoveryengine.projects.locations.collections.dataConnector.operations.list", "parameters": { "pageToken": { "location": "query", "type": "string", "description": "The standard list page token." }, "filter": { "description": "The standard list filter.", "location": "query", "type": "string" }, "returnPartialSuccess": { "location": "query", "type": "boolean", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation." }, "pageSize": { "location": "query", "description": "The standard list page size.", "type": "integer", "format": "int32" }, "name": { "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataConnector$", "type": "string", "description": "The name of the operation's parent resource.", "location": "path", "required": true } }, "path": "v1/{+name}/operations", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] } } } } }, "engines": { "resources": { "completionConfig": { "methods": { "completeQuery": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/completionConfig:completeQuery", "response": { "$ref": "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponse" }, "parameterOrder": [ "completionConfig" ], "path": "v1/{+completionConfig}:completeQuery", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud_search.query", "https://www.googleapis.com/auth/discoveryengine.assist.readwrite", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequest" }, "id": "discoveryengine.projects.locations.collections.engines.completionConfig.completeQuery", "description": "Completes the user input with advanced keyword suggestions.", "parameters": { "completionConfig": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/completionConfig$", "location": "path", "type": "string", "description": "Required. The completion_config of the parent dataStore or engine resource name for which the completion is performed, such as `projects/*/locations/global/collections/default_collection/dataStores/*/completionConfig` `projects/*/locations/global/collections/default_collection/engines/*/completionConfig`." } }, "httpMethod": "POST" } } }, "operations": { "methods": { "cancel": { "httpMethod": "POST", "parameterOrder": [ "name" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/operations/[^/]+$", "description": "The name of the operation resource to be cancelled.", "required": true, "type": "string", "location": "path" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "request": { "$ref": "GoogleLongrunningCancelOperationRequest" }, "response": { "$ref": "GoogleProtobufEmpty" }, "path": "v1/{+name}:cancel", "id": "discoveryengine.projects.locations.collections.engines.operations.cancel", "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/operations/{operationsId}:cancel" }, "list": { "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "path": "v1/{+name}/operations", "id": "discoveryengine.projects.locations.collections.engines.operations.list", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/operations", "httpMethod": "GET", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$", "type": "string", "description": "The name of the operation's parent resource.", "required": true, "location": "path" }, "returnPartialSuccess": { "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "type": "boolean", "location": "query" }, "filter": { "type": "string", "location": "query", "description": "The standard list filter." }, "pageToken": { "type": "string", "description": "The standard list page token.", "location": "query" }, "pageSize": { "description": "The standard list page size.", "location": "query", "type": "integer", "format": "int32" } }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`." }, "get": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "parameterOrder": [ "name" ], "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "id": "discoveryengine.projects.locations.collections.engines.operations.get", "path": "v1/{+name}", "parameters": { "name": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/operations/[^/]+$", "location": "path", "type": "string", "description": "The name of the operation resource." } }, "httpMethod": "GET", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/operations/{operationsId}", "response": { "$ref": "GoogleLongrunningOperation" } } } }, "assistants": { "resources": { "agents": { "resources": { "a2a": { "resources": { "v1": { "methods": { "getCard": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}/agents/{agentsId}/a2a/v1/card", "path": "v1/{+tenant}/a2a/v1/card", "id": "discoveryengine.projects.locations.collections.engines.assistants.agents.a2a.v1.getCard", "httpMethod": "GET", "response": { "$ref": "A2aV1AgentCard" }, "parameters": { "tenant": { "location": "path", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+/agents/[^/]+$", "description": "Optional tenant, provided as a path parameter. Experimental, might still change for 1.0 release." } }, "description": "GetAgentCard returns the agent card for the agent.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "parameterOrder": [ "tenant" ] } }, "resources": { "message": { "methods": { "send": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}/agents/{agentsId}/a2a/v1/message:send", "parameterOrder": [ "tenant" ], "response": { "$ref": "A2aV1SendMessageResponse" }, "description": "Send a message to the agent. This is a blocking call that will return the task once it is completed, or a LRO if requested.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "request": { "$ref": "A2aV1SendMessageRequest" }, "id": "discoveryengine.projects.locations.collections.engines.assistants.agents.a2a.v1.message.send", "parameters": { "tenant": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+/agents/[^/]+$", "description": "Optional tenant, provided as a path parameter. Experimental, might still change for 1.0 release.", "type": "string", "location": "path" } }, "httpMethod": "POST", "path": "v1/{+tenant}/a2a/v1/message:send" }, "stream": { "description": "SendStreamingMessage is a streaming call that will return a stream of task update events until the Task is in an interrupted or terminal state.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "parameterOrder": [ "tenant" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}/agents/{agentsId}/a2a/v1/message:stream", "response": { "$ref": "A2aV1StreamResponse" }, "request": { "$ref": "A2aV1SendMessageRequest" }, "path": "v1/{+tenant}/a2a/v1/message:stream", "parameters": { "tenant": { "type": "string", "required": true, "description": "Optional tenant, provided as a path parameter. Experimental, might still change for 1.0 release.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+/agents/[^/]+$", "location": "path" } }, "httpMethod": "POST", "id": "discoveryengine.projects.locations.collections.engines.assistants.agents.a2a.v1.message.stream" } } }, "tasks": { "methods": { "get": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}/agents/{agentsId}/a2a/v1/tasks/{tasksId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "response": { "$ref": "A2aV1Task" }, "id": "discoveryengine.projects.locations.collections.engines.assistants.agents.a2a.v1.tasks.get", "path": "v1/{+tenant}/a2a/v1/{+name}", "parameterOrder": [ "tenant", "name" ], "parameters": { "name": { "location": "path", "required": true, "description": "Required. The resource name of the task. Format: tasks/{task_id}", "pattern": "^tasks/[^/]+$", "type": "string" }, "tenant": { "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+/agents/[^/]+$", "type": "string", "description": "Optional tenant, provided as a path parameter. Experimental, might still change for 1.0 release.", "location": "path", "required": true }, "historyLength": { "description": "The number of most recent messages from the task's history to retrieve.", "format": "int32", "location": "query", "type": "integer" } }, "description": "Get the current state of a task from the agent.", "httpMethod": "GET" }, "cancel": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "httpMethod": "POST", "parameterOrder": [ "tenant", "name" ], "parameters": { "tenant": { "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+/agents/[^/]+$", "description": "Optional tenant, provided as a path parameter. Experimental, might still change for 1.0 release.", "type": "string" }, "name": { "type": "string", "description": "The resource name of the task to cancel. Format: tasks/{task_id}", "location": "path", "pattern": "^tasks/[^/]+$", "required": true } }, "response": { "$ref": "A2aV1Task" }, "id": "discoveryengine.projects.locations.collections.engines.assistants.agents.a2a.v1.tasks.cancel", "description": "Cancel a task from the agent. If supported one should expect no more task updates for the task.", "request": { "$ref": "A2aV1CancelTaskRequest" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}/agents/{agentsId}/a2a/v1/tasks/{tasksId}:cancel", "path": "v1/{+tenant}/a2a/v1/{+name}:cancel" }, "subscribe": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}/agents/{agentsId}/a2a/v1/tasks/{tasksId}:subscribe", "description": "TaskSubscription is a streaming call that will return a stream of task update events. This attaches the stream to an existing in process task. If the task is complete the stream will return the completed task (like GetTask) and close the stream.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "parameters": { "name": { "required": true, "location": "path", "description": "The resource name of the task to subscribe to. Format: tasks/{task_id}", "pattern": "^tasks/[^/]+$", "type": "string" }, "tenant": { "description": "Optional tenant, provided as a path parameter. Experimental, might still change for 1.0 release.", "location": "path", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+/agents/[^/]+$" } }, "path": "v1/{+tenant}/a2a/v1/{+name}:subscribe", "httpMethod": "GET", "response": { "$ref": "A2aV1StreamResponse" }, "parameterOrder": [ "tenant", "name" ], "id": "discoveryengine.projects.locations.collections.engines.assistants.agents.a2a.v1.tasks.subscribe" } }, "resources": { "pushNotificationConfigs": { "methods": { "create": { "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The parent task resource for this config. Format: tasks/{task_id}", "pattern": "^tasks/[^/]+/pushNotificationConfigs$", "required": true, "type": "string", "location": "path" }, "configId": { "location": "query", "description": "Required. The ID for the new config.", "type": "string" }, "tenant": { "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+/agents/[^/]+$", "location": "path", "description": "Optional tenant, provided as a path parameter. Experimental, might still change for 1.0 release.", "type": "string", "required": true } }, "description": "Set a push notification config for a task.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "response": { "$ref": "A2aV1TaskPushNotificationConfig" }, "path": "v1/{+tenant}/a2a/v1/{+parent}", "id": "discoveryengine.projects.locations.collections.engines.assistants.agents.a2a.v1.tasks.pushNotificationConfigs.create", "request": { "$ref": "A2aV1TaskPushNotificationConfig" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}/agents/{agentsId}/a2a/v1/tasks/{tasksId}/pushNotificationConfigs", "parameterOrder": [ "tenant", "parent" ] }, "list": { "description": "Get a list of push notifications configured for a task.", "response": { "$ref": "A2aV1ListTaskPushNotificationConfigResponse" }, "id": "discoveryengine.projects.locations.collections.engines.assistants.agents.a2a.v1.tasks.pushNotificationConfigs.list", "parameterOrder": [ "tenant", "parent" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "httpMethod": "GET", "parameters": { "pageToken": { "description": "A page token received from a previous ListTaskPushNotificationConfigRequest call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListTaskPushNotificationConfigRequest` must match the call that provided the page token.", "type": "string", "location": "query" }, "parent": { "type": "string", "pattern": "^tasks/[^/]+$", "required": true, "description": "The parent task resource. Format: tasks/{task_id}", "location": "path" }, "tenant": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+/agents/[^/]+$", "description": "Optional tenant, provided as a path parameter. Experimental, might still change for 1.0 release.", "required": true, "location": "path" }, "pageSize": { "format": "int32", "location": "query", "description": "For AIP-158 these fields are present. Usually not used/needed. The maximum number of configurations to return. If unspecified, all configs will be returned.", "type": "integer" } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}/agents/{agentsId}/a2a/v1/tasks/{tasksId}/pushNotificationConfigs", "path": "v1/{+tenant}/a2a/v1/{+parent}/pushNotificationConfigs" }, "get": { "httpMethod": "GET", "parameters": { "name": { "required": true, "pattern": "^tasks/[^/]+/pushNotificationConfigs/[^/]+$", "description": "The resource name of the config to retrieve. Format: tasks/{task_id}/pushNotificationConfigs/{config_id}", "location": "path", "type": "string" }, "tenant": { "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+/agents/[^/]+$", "location": "path", "type": "string", "description": "Optional tenant, provided as a path parameter. Experimental, might still change for 1.0 release.", "required": true } }, "description": "Get a push notification config for a task.", "response": { "$ref": "A2aV1TaskPushNotificationConfig" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}/agents/{agentsId}/a2a/v1/tasks/{tasksId}/pushNotificationConfigs/{pushNotificationConfigsId}", "id": "discoveryengine.projects.locations.collections.engines.assistants.agents.a2a.v1.tasks.pushNotificationConfigs.get", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "parameterOrder": [ "tenant", "name" ], "path": "v1/{+tenant}/a2a/v1/{+name}" }, "delete": { "parameterOrder": [ "tenant", "name" ], "path": "v1/{+tenant}/a2a/v1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "id": "discoveryengine.projects.locations.collections.engines.assistants.agents.a2a.v1.tasks.pushNotificationConfigs.delete", "response": { "$ref": "GoogleProtobufEmpty" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}/agents/{agentsId}/a2a/v1/tasks/{tasksId}/pushNotificationConfigs/{pushNotificationConfigsId}", "httpMethod": "DELETE", "description": "Delete a push notification config for a task.", "parameters": { "tenant": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+/agents/[^/]+$", "required": true, "description": "Optional tenant, provided as a path parameter. Experimental, might still change for 1.0 release.", "location": "path" }, "name": { "pattern": "^tasks/[^/]+/pushNotificationConfigs/[^/]+$", "type": "string", "required": true, "description": "The resource name of the config to delete. Format: tasks/{task_id}/pushNotificationConfigs/{config_id}", "location": "path" } } } } } } } } } } }, "operations": { "methods": { "get": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "parameterOrder": [ "name" ], "path": "v1/{+name}", "response": { "$ref": "GoogleLongrunningOperation" }, "httpMethod": "GET", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+/agents/[^/]+/operations/[^/]+$", "type": "string", "description": "The name of the operation resource.", "required": true, "location": "path" } }, "id": "discoveryengine.projects.locations.collections.engines.assistants.agents.operations.get", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}/agents/{agentsId}/operations/{operationsId}", "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service." } } } } } }, "methods": { "streamAssist": { "path": "v1/{+name}:streamAssist", "request": { "$ref": "GoogleCloudDiscoveryengineV1StreamAssistRequest" }, "response": { "$ref": "GoogleCloudDiscoveryengineV1StreamAssistResponse" }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.assist.readwrite", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}:streamAssist", "id": "discoveryengine.projects.locations.collections.engines.assistants.streamAssist", "description": "Assists the user with a query in a streaming fashion.", "parameters": { "name": { "location": "path", "type": "string", "description": "Required. The resource name of the Assistant. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}`", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+$" } }, "httpMethod": "POST" }, "patch": { "id": "discoveryengine.projects.locations.collections.engines.assistants.patch", "description": "Updates an Assistant", "response": { "$ref": "GoogleCloudDiscoveryengineV1Assistant" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.assist.readwrite", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "httpMethod": "PATCH", "parameters": { "name": { "location": "path", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+$", "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." }, "updateMask": { "format": "google-fieldmask", "type": "string", "location": "query", "description": "The list of fields to update." } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}", "path": "v1/{+name}", "request": { "$ref": "GoogleCloudDiscoveryengineV1Assistant" }, "parameterOrder": [ "name" ] }, "delete": { "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.assist.readwrite", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "id": "discoveryengine.projects.locations.collections.engines.assistants.delete", "parameters": { "name": { "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+$", "type": "string", "description": "Required. Resource name of Assistant. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}` If the caller does not have permission to delete the Assistant, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the Assistant to delete does not exist, a NOT_FOUND error is returned." } }, "httpMethod": "DELETE", "description": "Deletes an Assistant.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}", "response": { "$ref": "GoogleProtobufEmpty" }, "path": "v1/{+name}" }, "get": { "id": "discoveryengine.projects.locations.collections.engines.assistants.get", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.assist.readwrite", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "parameters": { "name": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+$", "location": "path", "description": "Required. Resource name of Assistant. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}`", "type": "string" } }, "httpMethod": "GET", "parameterOrder": [ "name" ], "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}", "response": { "$ref": "GoogleCloudDiscoveryengineV1Assistant" }, "description": "Gets an Assistant." }, "create": { "id": "discoveryengine.projects.locations.collections.engines.assistants.create", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.assist.readwrite", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1Assistant" }, "httpMethod": "POST", "response": { "$ref": "GoogleCloudDiscoveryengineV1Assistant" }, "parameters": { "parent": { "location": "path", "description": "Required. The parent resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$", "required": true, "type": "string" }, "assistantId": { "type": "string", "location": "query", "description": "Required. The ID to use for the Assistant, which will become the final component of the Assistant's resource name. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) with a length limit of 63 characters." } }, "path": "v1/{+parent}/assistants", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants", "parameterOrder": [ "parent" ], "description": "Creates an Assistant." }, "list": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.assist.readwrite", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "path": "v1/{+parent}/assistants", "parameterOrder": [ "parent" ], "parameters": { "parent": { "description": "Required. The parent resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$", "type": "string", "required": true }, "pageToken": { "location": "query", "description": "A page token ListAssistantsResponse.next_page_token, received from a previous AssistantService.ListAssistants call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListAssistants must match the call that provided the page token.", "type": "string" }, "pageSize": { "format": "int32", "location": "query", "type": "integer", "description": "Maximum number of Assistants to return. If unspecified, defaults to 100. The maximum allowed value is 1000; anything above that will be coerced down to 1000." } }, "httpMethod": "GET", "id": "discoveryengine.projects.locations.collections.engines.assistants.list", "response": { "$ref": "GoogleCloudDiscoveryengineV1ListAssistantsResponse" }, "description": "Lists all Assistants under an Engine.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants" } } }, "servingConfigs": { "methods": { "search": { "description": "Performs a search.", "parameterOrder": [ "servingConfig" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.assist.readwrite", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "parameters": { "servingConfig": { "type": "string", "location": "path", "required": true, "description": "Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/servingConfigs/[^/]+$" } }, "httpMethod": "POST", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/servingConfigs/{servingConfigsId}:search", "request": { "$ref": "GoogleCloudDiscoveryengineV1SearchRequest" }, "id": "discoveryengine.projects.locations.collections.engines.servingConfigs.search", "response": { "$ref": "GoogleCloudDiscoveryengineV1SearchResponse" }, "path": "v1/{+servingConfig}:search" }, "patch": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "path": "v1/{+name}", "id": "discoveryengine.projects.locations.collections.engines.servingConfigs.patch", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/servingConfigs/{servingConfigsId}", "description": "Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.", "request": { "$ref": "GoogleCloudDiscoveryengineV1ServingConfig" }, "parameters": { "updateMask": { "description": "Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated.", "type": "string", "format": "google-fieldmask", "location": "query" }, "name": { "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/servingConfigs/[^/]+$", "location": "path", "required": true, "type": "string", "description": "Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}`" } }, "httpMethod": "PATCH", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1ServingConfig" } }, "streamAnswer": { "response": { "$ref": "GoogleCloudDiscoveryengineV1AnswerQueryResponse" }, "path": "v1/{+servingConfig}:streamAnswer", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/servingConfigs/{servingConfigsId}:streamAnswer", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "httpMethod": "POST", "parameters": { "servingConfig": { "description": "Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. Or the resource name of the agent engine serving config, such as: `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_agent_answer`. (use when `enable_agent_invocation` set to true, and you have custom `AI_MODE` agent engine configured) This field is used to identify the serving configuration name, set of models used to make the search.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/servingConfigs/[^/]+$", "required": true, "type": "string", "location": "path" } }, "parameterOrder": [ "servingConfig" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1AnswerQueryRequest" }, "id": "discoveryengine.projects.locations.collections.engines.servingConfigs.streamAnswer", "description": "Answer query method (streaming). It takes one AnswerQueryRequest and returns multiple AnswerQueryResponse messages in a stream." }, "get": { "response": { "$ref": "GoogleCloudDiscoveryengineV1ServingConfig" }, "httpMethod": "GET", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/servingConfigs/[^/]+$", "type": "string", "location": "path", "description": "Required. The resource name of the ServingConfig to get. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config_id}`", "required": true } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/servingConfigs/{servingConfigsId}", "parameterOrder": [ "name" ], "description": "Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.", "path": "v1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "id": "discoveryengine.projects.locations.collections.engines.servingConfigs.get" }, "searchLite": { "path": "v1/{+servingConfig}:searchLite", "parameterOrder": [ "servingConfig" ], "id": "discoveryengine.projects.locations.collections.engines.servingConfigs.searchLite", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.assist.readwrite", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "description": "Performs a search. Similar to the SearchService.Search method, but a lite version that allows API key for authentication, where OAuth and IAM checks are not required. Only public website search is supported by this method. If data stores and engines not associated with public website search are specified, a `FAILED_PRECONDITION` error is returned. This method can be used for easy onboarding without having to implement an authentication backend. However, it is strongly recommended to use SearchService.Search instead with required OAuth and IAM checks to provide better data security.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/servingConfigs/{servingConfigsId}:searchLite", "request": { "$ref": "GoogleCloudDiscoveryengineV1SearchRequest" }, "response": { "$ref": "GoogleCloudDiscoveryengineV1SearchResponse" }, "parameters": { "servingConfig": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/servingConfigs/[^/]+$", "required": true, "description": "Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.", "location": "path" } }, "httpMethod": "POST" }, "answer": { "parameterOrder": [ "servingConfig" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1AnswerQueryResponse" }, "parameters": { "servingConfig": { "required": true, "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/servingConfigs/[^/]+$", "description": "Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. Or the resource name of the agent engine serving config, such as: `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_agent_answer`. (use when `enable_agent_invocation` set to true, and you have custom `AI_MODE` agent engine configured) This field is used to identify the serving configuration name, set of models used to make the search." } }, "path": "v1/{+servingConfig}:answer", "httpMethod": "POST", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/servingConfigs/{servingConfigsId}:answer", "description": "Answer query method.", "id": "discoveryengine.projects.locations.collections.engines.servingConfigs.answer", "request": { "$ref": "GoogleCloudDiscoveryengineV1AnswerQueryRequest" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "recommend": { "response": { "$ref": "GoogleCloudDiscoveryengineV1RecommendResponse" }, "description": "Makes a recommendation, which requires a contextual user event.", "path": "v1/{+servingConfig}:recommend", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/servingConfigs/{servingConfigsId}:recommend", "parameters": { "servingConfig": { "description": "Required. Full resource name of a ServingConfig: `projects/*/locations/global/collections/*/engines/*/servingConfigs/*`, or `projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*` One default serving config is created along with your recommendation engine creation. The engine ID is used as the ID of the default serving config. For example, for Engine `projects/*/locations/global/collections/*/engines/my-engine`, you can use `projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/servingConfigs/[^/]+$", "type": "string", "location": "path" } }, "request": { "$ref": "GoogleCloudDiscoveryengineV1RecommendRequest" }, "httpMethod": "POST", "id": "discoveryengine.projects.locations.collections.engines.servingConfigs.recommend", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "parameterOrder": [ "servingConfig" ] }, "delete": { "response": { "$ref": "GoogleProtobufEmpty" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/servingConfigs/{servingConfigsId}", "parameterOrder": [ "name" ], "httpMethod": "DELETE", "parameters": { "name": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/servingConfigs/[^/]+$", "type": "string", "location": "path", "description": "Required. The resource name of the ServingConfig to delete. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config_id}`" } }, "description": "Deletes a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.", "path": "v1/{+name}", "id": "discoveryengine.projects.locations.collections.engines.servingConfigs.delete", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { "response": { "$ref": "GoogleCloudDiscoveryengineV1ListServingConfigsResponse" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/servingConfigs", "path": "v1/{+parent}/servingConfigs", "httpMethod": "GET", "parameters": { "pageToken": { "type": "string", "description": "Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page.", "location": "query" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$", "type": "string", "required": true, "description": "Required. Full resource name of the parent resource. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`", "location": "path" }, "pageSize": { "format": "int32", "location": "query", "description": "Optional. Maximum number of results to return. If unspecified, defaults to 100. If a value greater than 100 is provided, at most 100 results are returned.", "type": "integer" } }, "description": "Lists all ServingConfigs linked to this dataStore.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "parameterOrder": [ "parent" ], "id": "discoveryengine.projects.locations.collections.engines.servingConfigs.list" }, "create": { "request": { "$ref": "GoogleCloudDiscoveryengineV1ServingConfig" }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1ServingConfig" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "path": "v1/{+parent}/servingConfigs", "parameters": { "parent": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$", "description": "Required. Full resource name of parent. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`", "type": "string", "location": "path" }, "servingConfigId": { "type": "string", "description": "Required. The ID to use for the ServingConfig, which will become the final component of the ServingConfig's resource name. This value should be 4-63 characters, and valid characters are /a-zA-Z0-9+/.", "location": "query" } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/servingConfigs", "id": "discoveryengine.projects.locations.collections.engines.servingConfigs.create", "httpMethod": "POST", "description": "Creates a ServingConfig. Note: The Google Cloud console works only with the default serving config. Additional ServingConfigs can be created and managed only via the API. A maximum of 100 ServingConfigs are allowed in an Engine, otherwise a RESOURCE_EXHAUSTED error is returned." } } }, "widgetConfigs": { "methods": { "patch": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.assist.readwrite", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/widgetConfigs/{widgetConfigsId}", "request": { "$ref": "GoogleCloudDiscoveryengineV1WidgetConfig" }, "id": "discoveryengine.projects.locations.collections.engines.widgetConfigs.patch", "response": { "$ref": "GoogleCloudDiscoveryengineV1WidgetConfig" }, "parameterOrder": [ "name" ], "parameters": { "name": { "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/widgetConfigs/[^/]+$", "location": "path", "description": "Immutable. The full resource name of the widget config. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/widgetConfigs/{widget_config_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters." }, "updateMask": { "format": "google-fieldmask", "location": "query", "description": "Indicates which fields in the provided WidgetConfig to update. The following are the only supported fields: * WidgetConfig.enable_autocomplete If not set, all supported fields are updated.", "type": "string" } }, "httpMethod": "PATCH", "description": "Update a WidgetConfig.", "path": "v1/{+name}" }, "get": { "path": "v1/{+name}", "description": "Gets a WidgetConfig.", "parameters": { "acceptCache": { "type": "boolean", "description": "Optional. Whether it's acceptable to load the widget config from cache. If set to true, recent changes on widget configs may take a few minutes to reflect on the end user's view. It's recommended to set to true for maturely developed widgets, as it improves widget performance. Set to false to see changes reflected in prod right away, if your widget is under development.", "location": "query" }, "name": { "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/widgetConfigs/[^/]+$", "location": "path", "required": true, "description": "Required. Full WidgetConfig resource name. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/widgetConfigs/{widget_config_id}`", "type": "string" }, "getWidgetConfigRequestOption.turnOffCollectionComponents": { "description": "Optional. Whether to turn off collection_components in WidgetConfig to reduce latency and data transmission.", "location": "query", "type": "boolean" }, "languageCode": { "location": "query", "description": "Optional. BCP-47 language tag (e.g. \"en\", \"fr-CA\"). Used to localize human-readable strings in the response, such as the model selector `display_name` / `description` on `WidgetConfig.UiSettings.ModelConfigInfo`. Empty / unset falls back to the default language (English).", "type": "string" }, "modelInfoView": { "enumDescriptions": [ "Not specified.", "The end-user web model selector view.", "The Cloud Console admin \"Feature Control\" view that displays model toggles. Returns admin-surfaced models with `ResolvedModel.admin_view` populated.", "The end-user model selector view for the Gemini Enterprise mobile app. Returns only mobile-surfaced models, with the mobile default selected. Set explicitly by the mobile client." ], "location": "query", "description": "Optional. Selects which view of `WidgetConfig.UiSettings.ModelConfigInfo` the backend computes. `ADMIN` is set by the Cloud Console admin \"Feature Management\" page (screen/4Vn9gQKbN8tb7gm) to receive the admin-surfaced model set with `ResolvedModel.admin_view` populated; `END_USER_MOBILE` is set by the Gemini Enterprise mobile app to receive the mobile model set; unset / `END_USER_WEB` returns the end-user web selector.", "type": "string", "enum": [ "MODEL_INFO_VIEW_UNSPECIFIED", "END_USER_WEB", "ADMIN", "END_USER_MOBILE" ] } }, "parameterOrder": [ "name" ], "httpMethod": "GET", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/widgetConfigs/{widgetConfigsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.assist.readwrite", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "id": "discoveryengine.projects.locations.collections.engines.widgetConfigs.get", "response": { "$ref": "GoogleCloudDiscoveryengineV1WidgetConfig" } } } }, "controls": { "methods": { "patch": { "response": { "$ref": "GoogleCloudDiscoveryengineV1Control" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "description": "Updates a Control. Control action type cannot be changed. If the Control to update does not exist, a NOT_FOUND error is returned.", "id": "discoveryengine.projects.locations.collections.engines.controls.patch", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/controls/{controlsId}", "httpMethod": "PATCH", "request": { "$ref": "GoogleCloudDiscoveryengineV1Control" }, "parameters": { "updateMask": { "type": "string", "location": "query", "format": "google-fieldmask", "description": "Optional. Indicates which fields in the provided Control to update. The following are NOT supported: * Control.name * Control.solution_type If not set or empty, all supported fields are updated." }, "name": { "description": "Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*`", "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/controls/[^/]+$", "required": true } }, "path": "v1/{+name}", "parameterOrder": [ "name" ] }, "create": { "parameterOrder": [ "parent" ], "path": "v1/{+parent}/controls", "description": "Creates a Control. By default 1000 controls are allowed for a data store. A request can be submitted to adjust this limit. If the Control to create already exists, an ALREADY_EXISTS error is returned.", "id": "discoveryengine.projects.locations.collections.engines.controls.create", "request": { "$ref": "GoogleCloudDiscoveryengineV1Control" }, "response": { "$ref": "GoogleCloudDiscoveryengineV1Control" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/controls", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "httpMethod": "POST", "parameters": { "controlId": { "type": "string", "description": "Required. The ID to use for the Control, which will become the final component of the Control's resource name. This value must be within 1-63 characters. Valid characters are /a-z-_/.", "location": "query" }, "parent": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$", "location": "path", "description": "Required. Full resource name of parent data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`.", "required": true } } }, "list": { "description": "Lists all Controls by their parent DataStore.", "response": { "$ref": "GoogleCloudDiscoveryengineV1ListControlsResponse" }, "httpMethod": "GET", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/controls", "parameters": { "pageSize": { "location": "query", "description": "Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.", "type": "integer", "format": "int32" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$", "location": "path", "required": true, "description": "Required. The data store resource name. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`.", "type": "string" }, "pageToken": { "description": "Optional. A page token, received from a previous `ListControls` call. Provide this to retrieve the subsequent page.", "location": "query", "type": "string" }, "filter": { "description": "Optional. A filter to apply on the list results. Supported features: * List all the products under the parent branch if filter is unset. Currently this field is unsupported.", "type": "string", "location": "query" } }, "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "path": "v1/{+parent}/controls", "id": "discoveryengine.projects.locations.collections.engines.controls.list" }, "get": { "parameters": { "name": { "description": "Required. The resource name of the Control to get. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`", "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/controls/[^/]+$", "required": true } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/controls/{controlsId}", "parameterOrder": [ "name" ], "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1Control" }, "id": "discoveryengine.projects.locations.collections.engines.controls.get", "path": "v1/{+name}", "description": "Gets a Control." }, "delete": { "path": "v1/{+name}", "description": "Deletes a Control. If the Control to delete does not exist, a NOT_FOUND error is returned.", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/controls/[^/]+$", "description": "Required. The resource name of the Control to delete. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`", "location": "path", "type": "string", "required": true } }, "id": "discoveryengine.projects.locations.collections.engines.controls.delete", "httpMethod": "DELETE", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/controls/{controlsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "parameterOrder": [ "name" ], "response": { "$ref": "GoogleProtobufEmpty" } } } }, "sessions": { "resources": { "answers": { "methods": { "get": { "response": { "$ref": "GoogleCloudDiscoveryengineV1Answer" }, "httpMethod": "GET", "path": "v1/{+name}", "parameters": { "name": { "description": "Required. The resource name of the Answer to get. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine_id}/sessions/{session_id}/answers/{answer_id}`", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/sessions/[^/]+/answers/[^/]+$", "location": "path", "type": "string", "required": true } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/sessions/{sessionsId}/answers/{answersId}", "description": "Gets a Answer.", "parameterOrder": [ "name" ], "id": "discoveryengine.projects.locations.collections.engines.sessions.answers.get" } } } }, "methods": { "patch": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.assist.readwrite", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "parameters": { "updateMask": { "type": "string", "format": "google-fieldmask", "location": "query", "description": "Indicates which fields in the provided Session to update. The following are NOT supported: * Session.name If not set or empty, all supported fields are updated." }, "name": { "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/sessions/[^/]+$", "description": "Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*`", "type": "string" } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/sessions/{sessionsId}", "httpMethod": "PATCH", "path": "v1/{+name}", "id": "discoveryengine.projects.locations.collections.engines.sessions.patch", "response": { "$ref": "GoogleCloudDiscoveryengineV1Session" }, "request": { "$ref": "GoogleCloudDiscoveryengineV1Session" }, "parameterOrder": [ "name" ], "description": "Updates a Session. Session action type cannot be changed. If the Session to update does not exist, a NOT_FOUND error is returned." }, "create": { "description": "Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is returned.", "parameterOrder": [ "parent" ], "id": "discoveryengine.projects.locations.collections.engines.sessions.create", "request": { "$ref": "GoogleCloudDiscoveryengineV1Session" }, "parameters": { "parent": { "location": "path", "required": true, "type": "string", "description": "Required. Full resource name of parent data store. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$" }, "sessionId": { "description": "Optional. The ID to use for the session, which will become the final component of the session's resource name. This value should be 1-63 characters, and valid characters are /a-z0-9{0,61}[a-z0-9]/. If not specified, a unique ID will be generated.", "location": "query", "type": "string" } }, "httpMethod": "POST", "response": { "$ref": "GoogleCloudDiscoveryengineV1Session" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.assist.readwrite", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/sessions", "path": "v1/{+parent}/sessions" }, "get": { "parameterOrder": [ "name" ], "id": "discoveryengine.projects.locations.collections.engines.sessions.get", "description": "Gets a Session.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/sessions/{sessionsId}", "path": "v1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.assist.readwrite", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "parameters": { "name": { "description": "Required. The resource name of the Session to get. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/sessions/[^/]+$", "location": "path", "required": true, "type": "string" }, "includeAnswerDetails": { "type": "boolean", "description": "Optional. If set to true, the full session including all answer details will be returned.", "location": "query" } }, "httpMethod": "GET", "response": { "$ref": "GoogleCloudDiscoveryengineV1Session" } }, "list": { "description": "Lists all Sessions by their parent DataStore.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/sessions", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.assist.readwrite", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "id": "discoveryengine.projects.locations.collections.engines.sessions.list", "response": { "$ref": "GoogleCloudDiscoveryengineV1ListSessionsResponse" }, "parameters": { "pageSize": { "location": "query", "description": "Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.", "type": "integer", "format": "int32" }, "pageToken": { "type": "string", "location": "query", "description": "A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page." }, "orderBy": { "type": "string", "description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` * `is_pinned` * `display_name` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time.", "location": "query" }, "filter": { "location": "query", "type": "string", "description": "A comma-separated list of fields to filter by, in EBNF grammar. The supported fields are: * `user_pseudo_id` * `state` * `display_name` * `starred` * `is_pinned` * `labels` * `create_time` * `update_time` * `collaborative_project` Examples: * `user_pseudo_id = some_id` * `display_name = \"some_name\"` * `starred = true` * `is_pinned=true AND (NOT labels:hidden)` * `create_time \u003e \"1970-01-01T12:00:00Z\"` * `collaborative_project = \"projects/123/locations/global/collections/default_collection/engines/\" \"default_engine/collaborative_projects/cp1\"`" }, "parent": { "required": true, "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$", "description": "Required. The data store resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`" } }, "httpMethod": "GET", "parameterOrder": [ "parent" ], "path": "v1/{+parent}/sessions" }, "delete": { "httpMethod": "DELETE", "description": "Deletes a Session. If the Session to delete does not exist, a NOT_FOUND error is returned.", "parameters": { "name": { "description": "Required. The resource name of the Session to delete. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`", "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/sessions/[^/]+$", "required": true } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/sessions/{sessionsId}", "path": "v1/{+name}", "id": "discoveryengine.projects.locations.collections.engines.sessions.delete", "response": { "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.assist.readwrite", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "parameterOrder": [ "name" ] } } }, "conversations": { "methods": { "list": { "parameterOrder": [ "parent" ], "path": "v1/{+parent}/conversations", "id": "discoveryengine.projects.locations.collections.engines.conversations.list", "parameters": { "pageToken": { "type": "string", "location": "query", "description": "A page token, received from a previous `ListConversations` call. Provide this to retrieve the subsequent page." }, "filter": { "type": "string", "location": "query", "description": "A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: \"user_pseudo_id = some_id\"" }, "pageSize": { "type": "integer", "format": "int32", "location": "query", "description": "Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000." }, "parent": { "location": "path", "required": true, "description": "Required. The data store resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$" }, "orderBy": { "location": "query", "type": "string", "description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `update_time` * `create_time` * `conversation_name` Example: \"update_time desc\" \"create_time\"" } }, "httpMethod": "GET", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/conversations", "description": "Lists all Conversations by their parent DataStore.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1ListConversationsResponse" } }, "delete": { "id": "discoveryengine.projects.locations.collections.engines.conversations.delete", "response": { "$ref": "GoogleProtobufEmpty" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/conversations/{conversationsId}", "path": "v1/{+name}", "parameterOrder": [ "name" ], "httpMethod": "DELETE", "parameters": { "name": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/conversations/[^/]+$", "description": "Required. The resource name of the Conversation to delete. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`", "location": "path", "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "description": "Deletes a Conversation. If the Conversation to delete does not exist, a NOT_FOUND error is returned." }, "converse": { "response": { "$ref": "GoogleCloudDiscoveryengineV1ConverseConversationResponse" }, "httpMethod": "POST", "parameters": { "name": { "location": "path", "required": true, "description": "Required. The resource name of the Conversation to get. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`. Use `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/conversations/[^/]+$" } }, "id": "discoveryengine.projects.locations.collections.engines.conversations.converse", "request": { "$ref": "GoogleCloudDiscoveryengineV1ConverseConversationRequest" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/conversations/{conversationsId}:converse", "path": "v1/{+name}:converse", "description": "Converses a conversation.", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "create": { "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$", "description": "Required. Full resource name of parent data store. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`", "type": "string", "required": true, "location": "path" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/conversations", "httpMethod": "POST", "description": "Creates a Conversation. If the Conversation to create already exists, an ALREADY_EXISTS error is returned.", "response": { "$ref": "GoogleCloudDiscoveryengineV1Conversation" }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1Conversation" }, "path": "v1/{+parent}/conversations", "id": "discoveryengine.projects.locations.collections.engines.conversations.create" }, "patch": { "id": "discoveryengine.projects.locations.collections.engines.conversations.patch", "response": { "$ref": "GoogleCloudDiscoveryengineV1Conversation" }, "httpMethod": "PATCH", "parameterOrder": [ "name" ], "parameters": { "updateMask": { "description": "Indicates which fields in the provided Conversation to update. The following are NOT supported: * Conversation.name If not set or empty, all supported fields are updated.", "type": "string", "format": "google-fieldmask", "location": "query" }, "name": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/conversations/[^/]+$", "location": "path", "description": "Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/dataStore/*/conversations/*` or `projects/{project}/locations/global/collections/{collection}/engines/*/conversations/*`.", "type": "string" } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/conversations/{conversationsId}", "request": { "$ref": "GoogleCloudDiscoveryengineV1Conversation" }, "description": "Updates a Conversation. Conversation action type cannot be changed. If the Conversation to update does not exist, a NOT_FOUND error is returned.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "path": "v1/{+name}" }, "get": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/conversations/{conversationsId}", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1Conversation" }, "httpMethod": "GET", "description": "Gets a Conversation.", "parameters": { "name": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/conversations/[^/]+$", "location": "path", "description": "Required. The resource name of the Conversation to get. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`", "required": true } }, "id": "discoveryengine.projects.locations.collections.engines.conversations.get" } } } }, "methods": { "patch": { "description": "Updates an Engine", "path": "v1/{+name}", "request": { "$ref": "GoogleCloudDiscoveryengineV1Engine" }, "parameters": { "name": { "type": "string", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$", "description": "Immutable. Identifier. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned." }, "updateMask": { "description": "Indicates which fields in the provided Engine to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned.", "format": "google-fieldmask", "location": "query", "type": "string" } }, "httpMethod": "PATCH", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1Engine" }, "id": "discoveryengine.projects.locations.collections.engines.patch", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}" }, "getIamPolicy": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}:getIamPolicy", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "id": "discoveryengine.projects.locations.collections.engines.getIamPolicy", "response": { "$ref": "GoogleIamV1Policy" }, "path": "v1/{+resource}:getIamPolicy", "description": "Gets the IAM access control policy for an Engine. A `NOT_FOUND` error is returned if the resource does not exist. An empty policy is returned if the resource exists but does not have a policy set on it.", "parameters": { "resource": { "required": true, "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$", "location": "path", "type": "string" }, "options.requestedPolicyVersion": { "format": "int32", "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "location": "query", "type": "integer" } }, "httpMethod": "GET", "parameterOrder": [ "resource" ] }, "delete": { "id": "discoveryengine.projects.locations.collections.engines.delete", "parameterOrder": [ "name" ], "parameters": { "name": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$", "location": "path", "description": "Required. Full resource name of Engine, such as `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. If the caller does not have permission to delete the Engine, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the Engine to delete does not exist, a NOT_FOUND error is returned.", "type": "string" } }, "httpMethod": "DELETE", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}", "description": "Deletes an Engine.", "path": "v1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "response": { "$ref": "GoogleLongrunningOperation" } }, "get": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1Engine" }, "description": "Gets an Engine.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}", "httpMethod": "GET", "parameters": { "name": { "location": "path", "description": "Required. Full resource name of Engine, such as `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$" } }, "parameterOrder": [ "name" ], "path": "v1/{+name}", "id": "discoveryengine.projects.locations.collections.engines.get" }, "create": { "id": "discoveryengine.projects.locations.collections.engines.create", "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines", "httpMethod": "POST", "parameters": { "engineId": { "type": "string", "description": "Required. The ID to use for the Engine, which will become the final component of the Engine's resource name. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.", "location": "query" }, "parent": { "description": "Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+$", "type": "string", "required": true } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1Engine" }, "path": "v1/{+parent}/engines", "parameterOrder": [ "parent" ], "description": "Creates an Engine." }, "setIamPolicy": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "parameterOrder": [ "resource" ], "request": { "$ref": "GoogleIamV1SetIamPolicyRequest" }, "id": "discoveryengine.projects.locations.collections.engines.setIamPolicy", "parameters": { "resource": { "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$", "required": true, "location": "path" } }, "response": { "$ref": "GoogleIamV1Policy" }, "httpMethod": "POST", "path": "v1/{+resource}:setIamPolicy", "description": "Sets the IAM access control policy for an Engine. A `NOT_FOUND` error is returned if the resource does not exist. **Important:** When setting a policy directly on an Engine resource, the only recommended roles in the bindings are: `roles/discoveryengine.admin`, `roles/discoveryengine.agentspaceAdmin`, `roles/discoveryengine.user`, `roles/discoveryengine.agentspaceUser`, `roles/discoveryengine.viewer`, `roles/discoveryengine.agentspaceViewer`. Attempting to grant any other role will result in a warning in logging.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}:setIamPolicy" }, "list": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "id": "discoveryengine.projects.locations.collections.engines.list", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines", "description": "Lists all the Engines associated with the project.", "response": { "$ref": "GoogleCloudDiscoveryengineV1ListEnginesResponse" }, "path": "v1/{+parent}/engines", "parameterOrder": [ "parent" ], "parameters": { "parent": { "required": true, "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+$", "description": "Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection_id}`." }, "pageSize": { "description": "Optional. Not supported.", "format": "int32", "type": "integer", "location": "query" }, "filter": { "type": "string", "location": "query", "description": "Optional. Filter by solution type. For example: solution_type=SOLUTION_TYPE_SEARCH" }, "pageToken": { "location": "query", "description": "Optional. Not supported.", "type": "string" } }, "httpMethod": "GET" } } }, "operations": { "methods": { "get": { "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "parameterOrder": [ "name" ], "path": "v1/{+name}", "parameters": { "name": { "description": "The name of the operation resource.", "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/operations/[^/]+$", "required": true } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/operations/{operationsId}", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "response": { "$ref": "GoogleLongrunningOperation" }, "id": "discoveryengine.projects.locations.collections.operations.get" }, "list": { "id": "discoveryengine.projects.locations.collections.operations.list", "path": "v1/{+name}/operations", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/operations", "httpMethod": "GET", "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+$", "required": true, "type": "string", "description": "The name of the operation's parent resource.", "location": "path" }, "returnPartialSuccess": { "location": "query", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "type": "boolean" }, "pageToken": { "description": "The standard list page token.", "location": "query", "type": "string" }, "pageSize": { "description": "The standard list page size.", "location": "query", "format": "int32", "type": "integer" }, "filter": { "description": "The standard list filter.", "type": "string", "location": "query" } } } } }, "dataStores": { "resources": { "branches": { "methods": { "batchGetDocumentsMetadata": { "id": "discoveryengine.projects.locations.collections.dataStores.branches.batchGetDocumentsMetadata", "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "parameters": { "matcher.fhirMatcher.fhirResources": { "repeated": true, "location": "query", "type": "string", "description": "Required. The FHIR resources to match by. Format: projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id}" }, "matcher.urisMatcher.uris": { "location": "query", "description": "The exact URIs to match by.", "repeated": true, "type": "string" }, "parent": { "type": "string", "description": "Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/branches/[^/]+$", "required": true, "location": "path" } }, "httpMethod": "GET", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}/batchGetDocumentsMetadata", "response": { "$ref": "GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponse" }, "path": "v1/{+parent}/batchGetDocumentsMetadata", "description": "Gets index freshness metadata for Documents. Supported for website search only." } }, "resources": { "operations": { "methods": { "list": { "id": "discoveryengine.projects.locations.collections.dataStores.branches.operations.list", "path": "v1/{+name}/operations", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}/operations", "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "parameters": { "filter": { "type": "string", "location": "query", "description": "The standard list filter." }, "returnPartialSuccess": { "location": "query", "type": "boolean", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation." }, "name": { "location": "path", "required": true, "description": "The name of the operation's parent resource.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/branches/[^/]+$" }, "pageSize": { "location": "query", "format": "int32", "type": "integer", "description": "The standard list page size." }, "pageToken": { "type": "string", "location": "query", "description": "The standard list page token." } }, "httpMethod": "GET", "parameterOrder": [ "name" ] }, "cancel": { "id": "discoveryengine.projects.locations.collections.dataStores.branches.operations.cancel", "request": { "$ref": "GoogleLongrunningCancelOperationRequest" }, "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}/operations/{operationsId}:cancel", "path": "v1/{+name}:cancel", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "response": { "$ref": "GoogleProtobufEmpty" }, "parameters": { "name": { "description": "The name of the operation resource to be cancelled.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/branches/[^/]+/operations/[^/]+$", "type": "string", "required": true, "location": "path" } }, "httpMethod": "POST", "parameterOrder": [ "name" ] }, "get": { "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}/operations/{operationsId}", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "id": "discoveryengine.projects.locations.collections.dataStores.branches.operations.get", "response": { "$ref": "GoogleLongrunningOperation" }, "httpMethod": "GET", "parameters": { "name": { "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/branches/[^/]+/operations/[^/]+$", "required": true, "description": "The name of the operation resource." } }, "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service." } } }, "documents": { "methods": { "import": { "id": "discoveryengine.projects.locations.collections.dataStores.branches.documents.import", "parameterOrder": [ "parent" ], "description": "Bulk import of multiple Documents. Request processing may be synchronous. Non-existing items are created. Note: It is possible for a subset of the Documents to be successfully updated.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "response": { "$ref": "GoogleLongrunningOperation" }, "httpMethod": "POST", "path": "v1/{+parent}/documents:import", "parameters": { "parent": { "description": "Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. Requires create/update permission.", "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/branches/[^/]+$", "required": true } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents:import", "request": { "$ref": "GoogleCloudDiscoveryengineV1ImportDocumentsRequest" } }, "patch": { "request": { "$ref": "GoogleCloudDiscoveryengineV1Document" }, "id": "discoveryengine.projects.locations.collections.dataStores.branches.documents.patch", "description": "Updates a Document.", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents/{documentsId}", "path": "v1/{+name}", "parameters": { "allowMissing": { "location": "query", "description": "If set to `true` and the Document is not found, a new Document is be created.", "type": "boolean" }, "updateMask": { "description": "Indicates which fields in the provided imported 'document' to update. If not set, by default updates all fields.", "type": "string", "format": "google-fieldmask", "location": "query" }, "name": { "location": "path", "description": "Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/branches/[^/]+/documents/[^/]+$" } }, "response": { "$ref": "GoogleCloudDiscoveryengineV1Document" }, "httpMethod": "PATCH" }, "get": { "description": "Gets a Document.", "parameters": { "name": { "description": "Required. Full resource name of Document, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`. If the caller does not have permission to access the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the requested Document does not exist, a `NOT_FOUND` error is returned.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/branches/[^/]+/documents/[^/]+$", "type": "string", "required": true } }, "httpMethod": "GET", "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents/{documentsId}", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1Document" }, "id": "discoveryengine.projects.locations.collections.dataStores.branches.documents.get" }, "delete": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "response": { "$ref": "GoogleProtobufEmpty" }, "parameterOrder": [ "name" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents/{documentsId}", "description": "Deletes a Document.", "id": "discoveryengine.projects.locations.collections.dataStores.branches.documents.delete", "path": "v1/{+name}", "httpMethod": "DELETE", "parameters": { "name": { "location": "path", "description": "Required. Full resource name of Document, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`. If the caller does not have permission to delete the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the Document to delete does not exist, a `NOT_FOUND` error is returned.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/branches/[^/]+/documents/[^/]+$", "required": true, "type": "string" } } }, "list": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "parameterOrder": [ "parent" ], "httpMethod": "GET", "parameters": { "pageToken": { "type": "string", "location": "query", "description": "A page token ListDocumentsResponse.next_page_token, received from a previous DocumentService.ListDocuments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to DocumentService.ListDocuments must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned." }, "pageSize": { "location": "query", "format": "int32", "type": "integer", "description": "Maximum number of Documents to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 are set to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned." }, "parent": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/branches/[^/]+$", "location": "path", "description": "Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. Use `default_branch` as the branch ID, to list documents under the default branch. If the caller does not have permission to list Documents under this branch, regardless of whether or not this branch exists, a `PERMISSION_DENIED` error is returned.", "type": "string" } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents", "description": "Gets a list of Documents.", "id": "discoveryengine.projects.locations.collections.dataStores.branches.documents.list", "path": "v1/{+parent}/documents", "response": { "$ref": "GoogleCloudDiscoveryengineV1ListDocumentsResponse" } }, "create": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "id": "discoveryengine.projects.locations.collections.dataStores.branches.documents.create", "parameters": { "documentId": { "description": "Required. The ID to use for the Document, which becomes the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", "type": "string", "location": "query" }, "parent": { "location": "path", "required": true, "description": "Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/branches/[^/]+$" } }, "parameterOrder": [ "parent" ], "httpMethod": "POST", "path": "v1/{+parent}/documents", "description": "Creates a Document.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents", "request": { "$ref": "GoogleCloudDiscoveryengineV1Document" }, "response": { "$ref": "GoogleCloudDiscoveryengineV1Document" } }, "purge": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/branches/[^/]+$", "description": "Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.", "required": true, "location": "path", "type": "string" } }, "httpMethod": "POST", "description": "Permanently deletes all selected Documents in a branch. This process is asynchronous. Depending on the number of Documents to be deleted, this operation can take hours to complete. Before the delete operation completes, some Documents might still be returned by DocumentService.GetDocument or DocumentService.ListDocuments. To get a list of the Documents to be deleted, set PurgeDocumentsRequest.force to false.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents:purge", "id": "discoveryengine.projects.locations.collections.dataStores.branches.documents.purge", "parameterOrder": [ "parent" ], "path": "v1/{+parent}/documents:purge", "request": { "$ref": "GoogleCloudDiscoveryengineV1PurgeDocumentsRequest" }, "response": { "$ref": "GoogleLongrunningOperation" } } } } } }, "conversations": { "methods": { "list": { "parameters": { "orderBy": { "description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `update_time` * `create_time` * `conversation_name` Example: \"update_time desc\" \"create_time\"", "location": "query", "type": "string" }, "filter": { "description": "A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: \"user_pseudo_id = some_id\"", "type": "string", "location": "query" }, "pageSize": { "format": "int32", "location": "query", "description": "Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.", "type": "integer" }, "parent": { "description": "Required. The data store resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", "location": "path", "type": "string", "required": true }, "pageToken": { "location": "query", "description": "A page token, received from a previous `ListConversations` call. Provide this to retrieve the subsequent page.", "type": "string" } }, "description": "Lists all Conversations by their parent DataStore.", "httpMethod": "GET", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/conversations", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1ListConversationsResponse" }, "id": "discoveryengine.projects.locations.collections.dataStores.conversations.list", "path": "v1/{+parent}/conversations", "parameterOrder": [ "parent" ] }, "converse": { "parameterOrder": [ "name" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/conversations/[^/]+$", "type": "string", "location": "path", "description": "Required. The resource name of the Conversation to get. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`. Use `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session.", "required": true } }, "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "path": "v1/{+name}:converse", "request": { "$ref": "GoogleCloudDiscoveryengineV1ConverseConversationRequest" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/conversations/{conversationsId}:converse", "description": "Converses a conversation.", "id": "discoveryengine.projects.locations.collections.dataStores.conversations.converse", "response": { "$ref": "GoogleCloudDiscoveryengineV1ConverseConversationResponse" } }, "delete": { "httpMethod": "DELETE", "parameterOrder": [ "name" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/conversations/[^/]+$", "type": "string", "required": true, "description": "Required. The resource name of the Conversation to delete. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`", "location": "path" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "path": "v1/{+name}", "response": { "$ref": "GoogleProtobufEmpty" }, "description": "Deletes a Conversation. If the Conversation to delete does not exist, a NOT_FOUND error is returned.", "id": "discoveryengine.projects.locations.collections.dataStores.conversations.delete", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/conversations/{conversationsId}" }, "create": { "response": { "$ref": "GoogleCloudDiscoveryengineV1Conversation" }, "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", "required": true, "location": "path", "type": "string", "description": "Required. Full resource name of parent data store. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`" } }, "httpMethod": "POST", "id": "discoveryengine.projects.locations.collections.dataStores.conversations.create", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/conversations", "request": { "$ref": "GoogleCloudDiscoveryengineV1Conversation" }, "path": "v1/{+parent}/conversations", "description": "Creates a Conversation. If the Conversation to create already exists, an ALREADY_EXISTS error is returned.", "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "patch": { "parameters": { "updateMask": { "location": "query", "format": "google-fieldmask", "description": "Indicates which fields in the provided Conversation to update. The following are NOT supported: * Conversation.name If not set or empty, all supported fields are updated.", "type": "string" }, "name": { "required": true, "location": "path", "type": "string", "description": "Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/dataStore/*/conversations/*` or `projects/{project}/locations/global/collections/{collection}/engines/*/conversations/*`.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/conversations/[^/]+$" } }, "httpMethod": "PATCH", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/conversations/{conversationsId}", "path": "v1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1Conversation" }, "description": "Updates a Conversation. Conversation action type cannot be changed. If the Conversation to update does not exist, a NOT_FOUND error is returned.", "id": "discoveryengine.projects.locations.collections.dataStores.conversations.patch", "request": { "$ref": "GoogleCloudDiscoveryengineV1Conversation" }, "parameterOrder": [ "name" ] }, "get": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/conversations/{conversationsId}", "response": { "$ref": "GoogleCloudDiscoveryengineV1Conversation" }, "id": "discoveryengine.projects.locations.collections.dataStores.conversations.get", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/conversations/[^/]+$", "required": true, "description": "Required. The resource name of the Conversation to get. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`", "location": "path", "type": "string" } }, "description": "Gets a Conversation.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "httpMethod": "GET", "parameterOrder": [ "name" ], "path": "v1/{+name}" } } }, "sessions": { "resources": { "answers": { "methods": { "get": { "response": { "$ref": "GoogleCloudDiscoveryengineV1Answer" }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/sessions/{sessionsId}/answers/{answersId}", "id": "discoveryengine.projects.locations.collections.dataStores.sessions.answers.get", "httpMethod": "GET", "parameters": { "name": { "location": "path", "description": "Required. The resource name of the Answer to get. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine_id}/sessions/{session_id}/answers/{answer_id}`", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/sessions/[^/]+/answers/[^/]+$", "type": "string", "required": true } }, "description": "Gets a Answer." } } } }, "methods": { "create": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.assist.readwrite", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "description": "Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is returned.", "response": { "$ref": "GoogleCloudDiscoveryengineV1Session" }, "path": "v1/{+parent}/sessions", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/sessions", "parameterOrder": [ "parent" ], "id": "discoveryengine.projects.locations.collections.dataStores.sessions.create", "httpMethod": "POST", "request": { "$ref": "GoogleCloudDiscoveryengineV1Session" }, "parameters": { "parent": { "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", "description": "Required. Full resource name of parent data store. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`", "required": true }, "sessionId": { "type": "string", "description": "Optional. The ID to use for the session, which will become the final component of the session's resource name. This value should be 1-63 characters, and valid characters are /a-z0-9{0,61}[a-z0-9]/. If not specified, a unique ID will be generated.", "location": "query" } } }, "get": { "response": { "$ref": "GoogleCloudDiscoveryengineV1Session" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/sessions/{sessionsId}", "id": "discoveryengine.projects.locations.collections.dataStores.sessions.get", "path": "v1/{+name}", "description": "Gets a Session.", "httpMethod": "GET", "parameters": { "includeAnswerDetails": { "description": "Optional. If set to true, the full session including all answer details will be returned.", "type": "boolean", "location": "query" }, "name": { "description": "Required. The resource name of the Session to get. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`", "location": "path", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/sessions/[^/]+$" } }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.assist.readwrite", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "delete": { "id": "discoveryengine.projects.locations.collections.dataStores.sessions.delete", "httpMethod": "DELETE", "response": { "$ref": "GoogleProtobufEmpty" }, "parameters": { "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/sessions/[^/]+$", "required": true, "description": "Required. The resource name of the Session to delete. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`", "type": "string" } }, "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/sessions/{sessionsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.assist.readwrite", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "description": "Deletes a Session. If the Session to delete does not exist, a NOT_FOUND error is returned.", "parameterOrder": [ "name" ] }, "patch": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/sessions/{sessionsId}", "response": { "$ref": "GoogleCloudDiscoveryengineV1Session" }, "parameterOrder": [ "name" ], "id": "discoveryengine.projects.locations.collections.dataStores.sessions.patch", "parameters": { "updateMask": { "format": "google-fieldmask", "location": "query", "type": "string", "description": "Indicates which fields in the provided Session to update. The following are NOT supported: * Session.name If not set or empty, all supported fields are updated." }, "name": { "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/sessions/[^/]+$", "location": "path", "description": "Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*`", "required": true, "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.assist.readwrite", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "httpMethod": "PATCH", "request": { "$ref": "GoogleCloudDiscoveryengineV1Session" }, "path": "v1/{+name}", "description": "Updates a Session. Session action type cannot be changed. If the Session to update does not exist, a NOT_FOUND error is returned." }, "list": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.assist.readwrite", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "path": "v1/{+parent}/sessions", "response": { "$ref": "GoogleCloudDiscoveryengineV1ListSessionsResponse" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/sessions", "parameters": { "orderBy": { "type": "string", "location": "query", "description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` * `is_pinned` * `display_name` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time." }, "pageSize": { "location": "query", "format": "int32", "description": "Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.", "type": "integer" }, "parent": { "required": true, "type": "string", "description": "Required. The data store resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$" }, "pageToken": { "type": "string", "description": "A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page.", "location": "query" }, "filter": { "description": "A comma-separated list of fields to filter by, in EBNF grammar. The supported fields are: * `user_pseudo_id` * `state` * `display_name` * `starred` * `is_pinned` * `labels` * `create_time` * `update_time` * `collaborative_project` Examples: * `user_pseudo_id = some_id` * `display_name = \"some_name\"` * `starred = true` * `is_pinned=true AND (NOT labels:hidden)` * `create_time \u003e \"1970-01-01T12:00:00Z\"` * `collaborative_project = \"projects/123/locations/global/collections/default_collection/engines/\" \"default_engine/collaborative_projects/cp1\"`", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "httpMethod": "GET", "description": "Lists all Sessions by their parent DataStore.", "id": "discoveryengine.projects.locations.collections.dataStores.sessions.list" } } }, "servingConfigs": { "methods": { "delete": { "response": { "$ref": "GoogleProtobufEmpty" }, "description": "Deletes a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.", "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}", "parameterOrder": [ "name" ], "id": "discoveryengine.projects.locations.collections.dataStores.servingConfigs.delete", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "parameters": { "name": { "description": "Required. The resource name of the ServingConfig to delete. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$", "required": true, "type": "string" } }, "httpMethod": "DELETE" }, "recommend": { "path": "v1/{+servingConfig}:recommend", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}:recommend", "description": "Makes a recommendation, which requires a contextual user event.", "request": { "$ref": "GoogleCloudDiscoveryengineV1RecommendRequest" }, "response": { "$ref": "GoogleCloudDiscoveryengineV1RecommendResponse" }, "parameterOrder": [ "servingConfig" ], "id": "discoveryengine.projects.locations.collections.dataStores.servingConfigs.recommend", "parameters": { "servingConfig": { "location": "path", "type": "string", "required": true, "description": "Required. Full resource name of a ServingConfig: `projects/*/locations/global/collections/*/engines/*/servingConfigs/*`, or `projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*` One default serving config is created along with your recommendation engine creation. The engine ID is used as the ID of the default serving config. For example, for Engine `projects/*/locations/global/collections/*/engines/my-engine`, you can use `projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$" } }, "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "searchLite": { "description": "Performs a search. Similar to the SearchService.Search method, but a lite version that allows API key for authentication, where OAuth and IAM checks are not required. Only public website search is supported by this method. If data stores and engines not associated with public website search are specified, a `FAILED_PRECONDITION` error is returned. This method can be used for easy onboarding without having to implement an authentication backend. However, it is strongly recommended to use SearchService.Search instead with required OAuth and IAM checks to provide better data security.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.assist.readwrite", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1SearchResponse" }, "request": { "$ref": "GoogleCloudDiscoveryengineV1SearchRequest" }, "id": "discoveryengine.projects.locations.collections.dataStores.servingConfigs.searchLite", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}:searchLite", "parameterOrder": [ "servingConfig" ], "httpMethod": "POST", "parameters": { "servingConfig": { "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$", "required": true, "location": "path", "description": "Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.", "type": "string" } }, "path": "v1/{+servingConfig}:searchLite" }, "list": { "parameterOrder": [ "parent" ], "path": "v1/{+parent}/servingConfigs", "response": { "$ref": "GoogleCloudDiscoveryengineV1ListServingConfigsResponse" }, "description": "Lists all ServingConfigs linked to this dataStore.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/servingConfigs", "parameters": { "pageToken": { "location": "query", "type": "string", "description": "Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page." }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", "required": true, "type": "string", "location": "path", "description": "Required. Full resource name of the parent resource. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`" }, "pageSize": { "format": "int32", "location": "query", "type": "integer", "description": "Optional. Maximum number of results to return. If unspecified, defaults to 100. If a value greater than 100 is provided, at most 100 results are returned." } }, "httpMethod": "GET", "id": "discoveryengine.projects.locations.collections.dataStores.servingConfigs.list", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "create": { "request": { "$ref": "GoogleCloudDiscoveryengineV1ServingConfig" }, "httpMethod": "POST", "parameters": { "parent": { "type": "string", "description": "Required. Full resource name of parent. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", "required": true }, "servingConfigId": { "type": "string", "location": "query", "description": "Required. The ID to use for the ServingConfig, which will become the final component of the ServingConfig's resource name. This value should be 4-63 characters, and valid characters are /a-zA-Z0-9+/." } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1ServingConfig" }, "parameterOrder": [ "parent" ], "id": "discoveryengine.projects.locations.collections.dataStores.servingConfigs.create", "description": "Creates a ServingConfig. Note: The Google Cloud console works only with the default serving config. Additional ServingConfigs can be created and managed only via the API. A maximum of 100 ServingConfigs are allowed in an Engine, otherwise a RESOURCE_EXHAUSTED error is returned.", "path": "v1/{+parent}/servingConfigs", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/servingConfigs" }, "patch": { "request": { "$ref": "GoogleCloudDiscoveryengineV1ServingConfig" }, "id": "discoveryengine.projects.locations.collections.dataStores.servingConfigs.patch", "path": "v1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "description": "Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.", "parameters": { "name": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$", "description": "Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}`", "location": "path", "type": "string" }, "updateMask": { "description": "Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated.", "type": "string", "format": "google-fieldmask", "location": "query" } }, "httpMethod": "PATCH", "parameterOrder": [ "name" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}", "response": { "$ref": "GoogleCloudDiscoveryengineV1ServingConfig" } }, "streamAnswer": { "id": "discoveryengine.projects.locations.collections.dataStores.servingConfigs.streamAnswer", "response": { "$ref": "GoogleCloudDiscoveryengineV1AnswerQueryResponse" }, "description": "Answer query method (streaming). It takes one AnswerQueryRequest and returns multiple AnswerQueryResponse messages in a stream.", "httpMethod": "POST", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}:streamAnswer", "parameters": { "servingConfig": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$", "required": true, "description": "Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. Or the resource name of the agent engine serving config, such as: `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_agent_answer`. (use when `enable_agent_invocation` set to true, and you have custom `AI_MODE` agent engine configured) This field is used to identify the serving configuration name, set of models used to make the search.", "location": "path" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "path": "v1/{+servingConfig}:streamAnswer", "request": { "$ref": "GoogleCloudDiscoveryengineV1AnswerQueryRequest" }, "parameterOrder": [ "servingConfig" ] }, "search": { "path": "v1/{+servingConfig}:search", "parameterOrder": [ "servingConfig" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1SearchRequest" }, "httpMethod": "POST", "response": { "$ref": "GoogleCloudDiscoveryengineV1SearchResponse" }, "parameters": { "servingConfig": { "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$", "required": true, "type": "string", "location": "path", "description": "Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search." } }, "id": "discoveryengine.projects.locations.collections.dataStores.servingConfigs.search", "description": "Performs a search.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.assist.readwrite", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}:search" }, "get": { "id": "discoveryengine.projects.locations.collections.dataStores.servingConfigs.get", "path": "v1/{+name}", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$", "description": "Required. The resource name of the ServingConfig to get. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config_id}`", "type": "string", "required": true, "location": "path" } }, "parameterOrder": [ "name" ], "description": "Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.", "httpMethod": "GET", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1ServingConfig" } }, "answer": { "id": "discoveryengine.projects.locations.collections.dataStores.servingConfigs.answer", "parameters": { "servingConfig": { "required": true, "location": "path", "description": "Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. Or the resource name of the agent engine serving config, such as: `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_agent_answer`. (use when `enable_agent_invocation` set to true, and you have custom `AI_MODE` agent engine configured) This field is used to identify the serving configuration name, set of models used to make the search.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$" } }, "request": { "$ref": "GoogleCloudDiscoveryengineV1AnswerQueryRequest" }, "httpMethod": "POST", "description": "Answer query method.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}:answer", "parameterOrder": [ "servingConfig" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "path": "v1/{+servingConfig}:answer", "response": { "$ref": "GoogleCloudDiscoveryengineV1AnswerQueryResponse" } } } }, "schemas": { "methods": { "patch": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1Schema" }, "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/schemas/[^/]+$", "type": "string", "description": "Immutable. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", "required": true, "location": "path" }, "allowMissing": { "location": "query", "description": "If set to true, and the Schema is not found, a new Schema is created. In this situation, `update_mask` is ignored.", "type": "boolean" } }, "path": "v1/{+name}", "httpMethod": "PATCH", "id": "discoveryengine.projects.locations.collections.dataStores.schemas.patch", "description": "Updates a Schema.", "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/schemas/{schemasId}" }, "create": { "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1Schema" }, "id": "discoveryengine.projects.locations.collections.dataStores.schemas.create", "path": "v1/{+parent}/schemas", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/schemas", "httpMethod": "POST", "parameterOrder": [ "parent" ], "description": "Creates a Schema.", "parameters": { "parent": { "location": "path", "description": "Required. The parent data store resource name, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", "type": "string" }, "schemaId": { "location": "query", "description": "Required. The ID to use for the Schema, which becomes the final component of the Schema.name. This field should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters.", "type": "string" } } }, "delete": { "response": { "$ref": "GoogleLongrunningOperation" }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/schemas/{schemasId}", "path": "v1/{+name}", "parameters": { "name": { "description": "Required. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/schemas/[^/]+$", "required": true, "location": "path" } }, "id": "discoveryengine.projects.locations.collections.dataStores.schemas.delete", "httpMethod": "DELETE", "description": "Deletes a Schema." }, "list": { "id": "discoveryengine.projects.locations.collections.dataStores.schemas.list", "description": "Gets a list of Schemas.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "httpMethod": "GET", "parameters": { "pageSize": { "format": "int32", "location": "query", "description": "The maximum number of Schemas to return. The service may return fewer than this value. If unspecified, at most 100 Schemas are returned. The maximum value is 1000; values above 1000 are set to 1000.", "type": "integer" }, "parent": { "description": "Required. The parent data store resource name, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", "location": "path", "type": "string" }, "pageToken": { "type": "string", "description": "A page token, received from a previous SchemaService.ListSchemas call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SchemaService.ListSchemas must match the call that provided the page token.", "location": "query" } }, "path": "v1/{+parent}/schemas", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/schemas", "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1ListSchemasResponse" } }, "get": { "description": "Gets a Schema.", "path": "v1/{+name}", "parameters": { "name": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/schemas/[^/]+$", "description": "Required. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`.", "location": "path", "required": true } }, "httpMethod": "GET", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/schemas/{schemasId}", "id": "discoveryengine.projects.locations.collections.dataStores.schemas.get", "response": { "$ref": "GoogleCloudDiscoveryengineV1Schema" } } }, "resources": { "operations": { "methods": { "get": { "parameterOrder": [ "name" ], "id": "discoveryengine.projects.locations.collections.dataStores.schemas.operations.get", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "parameters": { "name": { "type": "string", "location": "path", "description": "The name of the operation resource.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/schemas/[^/]+/operations/[^/]+$", "required": true } }, "httpMethod": "GET", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/schemas/{schemasId}/operations/{operationsId}", "path": "v1/{+name}", "response": { "$ref": "GoogleLongrunningOperation" } }, "list": { "id": "discoveryengine.projects.locations.collections.dataStores.schemas.operations.list", "path": "v1/{+name}/operations", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "parameterOrder": [ "name" ], "httpMethod": "GET", "parameters": { "filter": { "location": "query", "description": "The standard list filter.", "type": "string" }, "pageToken": { "description": "The standard list page token.", "type": "string", "location": "query" }, "returnPartialSuccess": { "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "type": "boolean", "location": "query" }, "pageSize": { "type": "integer", "format": "int32", "location": "query", "description": "The standard list page size." }, "name": { "location": "path", "required": true, "description": "The name of the operation's parent resource.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/schemas/[^/]+$" } }, "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/schemas/{schemasId}/operations" } } } } }, "operations": { "methods": { "get": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/operations/{operationsId}", "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "parameterOrder": [ "name" ], "parameters": { "name": { "type": "string", "location": "path", "required": true, "description": "The name of the operation resource.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/operations/[^/]+$" } }, "httpMethod": "GET", "id": "discoveryengine.projects.locations.collections.dataStores.operations.get", "path": "v1/{+name}" }, "list": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/operations", "id": "discoveryengine.projects.locations.collections.dataStores.operations.list", "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "parameters": { "pageToken": { "location": "query", "type": "string", "description": "The standard list page token." }, "filter": { "location": "query", "description": "The standard list filter.", "type": "string" }, "returnPartialSuccess": { "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "type": "boolean", "location": "query" }, "pageSize": { "type": "integer", "description": "The standard list page size.", "location": "query", "format": "int32" }, "name": { "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", "required": true, "location": "path", "type": "string", "description": "The name of the operation's parent resource." } }, "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "parameterOrder": [ "name" ], "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "path": "v1/{+name}/operations" } } }, "userEvents": { "methods": { "collect": { "description": "Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a third-party domain. This method is used only by the Discovery Engine API JavaScript pixel and Google Tag Manager. Users should not call this method directly.", "path": "v1/{+parent}/userEvents:collect", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/userEvents:collect", "parameters": { "userEvent": { "description": "Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters.", "location": "query", "type": "string" }, "ets": { "description": "The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes.", "format": "int64", "type": "string", "location": "query" }, "parent": { "location": "path", "required": true, "description": "Required. The parent resource name. If the collect user event action is applied in DataStore level, the format is: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. If the collect user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project}/locations/{location}`.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", "type": "string" }, "uri": { "location": "query", "description": "The URL including cgi-parameters but excluding the hash fragment with a length limit of 5,000 characters. This is often more useful than the referer URL, because many browsers only send the domain for third-party requests.", "type": "string" } }, "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.assist.readwrite", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "response": { "$ref": "GoogleApiHttpBody" }, "parameterOrder": [ "parent" ], "id": "discoveryengine.projects.locations.collections.dataStores.userEvents.collect" }, "import": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.assist.readwrite", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "parameterOrder": [ "parent" ], "id": "discoveryengine.projects.locations.collections.dataStores.userEvents.import", "request": { "$ref": "GoogleCloudDiscoveryengineV1ImportUserEventsRequest" }, "path": "v1/{+parent}/userEvents:import", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/userEvents:import", "description": "Bulk import of user events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully inserted. Operation.metadata is of type ImportMetadata.", "httpMethod": "POST", "response": { "$ref": "GoogleLongrunningOperation" }, "parameters": { "parent": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", "location": "path", "required": true, "description": "Required. Parent DataStore resource name, of the form `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`" } } }, "write": { "httpMethod": "POST", "id": "discoveryengine.projects.locations.collections.dataStores.userEvents.write", "parameters": { "writeAsync": { "location": "query", "type": "boolean", "description": "If set to true, the user event is written asynchronously after validation, and the API responds without waiting for the write." }, "parent": { "location": "path", "type": "string", "description": "Required. The parent resource name. If the write user event action is applied in DataStore level, the format is: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. If the write user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project}/locations/{location}`.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$" } }, "path": "v1/{+parent}/userEvents:write", "description": "Writes a single user event.", "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1UserEvent" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.assist.readwrite", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1UserEvent" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/userEvents:write" }, "purge": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.assist.readwrite", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "description": "Deletes permanently all user events specified by the filter provided. Depending on the number of events specified by the filter, this operation could take hours or days to complete. To test a filter, use the list command first.", "response": { "$ref": "GoogleLongrunningOperation" }, "request": { "$ref": "GoogleCloudDiscoveryengineV1PurgeUserEventsRequest" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/userEvents:purge", "httpMethod": "POST", "path": "v1/{+parent}/userEvents:purge", "parameters": { "parent": { "description": "Required. The resource name of the catalog under which the events are created. The format is `projects/{project}/locations/global/collections/{collection}/dataStores/{dataStore}`.", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", "type": "string" } }, "parameterOrder": [ "parent" ], "id": "discoveryengine.projects.locations.collections.dataStores.userEvents.purge" } } }, "controls": { "methods": { "get": { "parameterOrder": [ "name" ], "path": "v1/{+name}", "httpMethod": "GET", "parameters": { "name": { "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/controls/[^/]+$", "description": "Required. The resource name of the Control to get. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`", "type": "string" } }, "id": "discoveryengine.projects.locations.collections.dataStores.controls.get", "description": "Gets a Control.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/controls/{controlsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1Control" } }, "patch": { "parameters": { "updateMask": { "description": "Optional. Indicates which fields in the provided Control to update. The following are NOT supported: * Control.name * Control.solution_type If not set or empty, all supported fields are updated.", "location": "query", "type": "string", "format": "google-fieldmask" }, "name": { "type": "string", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/controls/[^/]+$", "description": "Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*`" } }, "path": "v1/{+name}", "httpMethod": "PATCH", "description": "Updates a Control. Control action type cannot be changed. If the Control to update does not exist, a NOT_FOUND error is returned.", "request": { "$ref": "GoogleCloudDiscoveryengineV1Control" }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/controls/{controlsId}", "id": "discoveryengine.projects.locations.collections.dataStores.controls.patch", "response": { "$ref": "GoogleCloudDiscoveryengineV1Control" } }, "create": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/controls", "response": { "$ref": "GoogleCloudDiscoveryengineV1Control" }, "id": "discoveryengine.projects.locations.collections.dataStores.controls.create", "request": { "$ref": "GoogleCloudDiscoveryengineV1Control" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "parameterOrder": [ "parent" ], "parameters": { "parent": { "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", "type": "string", "description": "Required. Full resource name of parent data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`." }, "controlId": { "location": "query", "type": "string", "description": "Required. The ID to use for the Control, which will become the final component of the Control's resource name. This value must be within 1-63 characters. Valid characters are /a-z-_/." } }, "description": "Creates a Control. By default 1000 controls are allowed for a data store. A request can be submitted to adjust this limit. If the Control to create already exists, an ALREADY_EXISTS error is returned.", "path": "v1/{+parent}/controls", "httpMethod": "POST" }, "list": { "description": "Lists all Controls by their parent DataStore.", "path": "v1/{+parent}/controls", "parameters": { "pageToken": { "type": "string", "description": "Optional. A page token, received from a previous `ListControls` call. Provide this to retrieve the subsequent page.", "location": "query" }, "filter": { "type": "string", "location": "query", "description": "Optional. A filter to apply on the list results. Supported features: * List all the products under the parent branch if filter is unset. Currently this field is unsupported." }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", "location": "path", "required": true, "type": "string", "description": "Required. The data store resource name. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`." }, "pageSize": { "description": "Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.", "location": "query", "format": "int32", "type": "integer" } }, "httpMethod": "GET", "id": "discoveryengine.projects.locations.collections.dataStores.controls.list", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/controls", "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1ListControlsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "delete": { "description": "Deletes a Control. If the Control to delete does not exist, a NOT_FOUND error is returned.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/controls/{controlsId}", "id": "discoveryengine.projects.locations.collections.dataStores.controls.delete", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/controls/[^/]+$", "location": "path", "required": true, "type": "string", "description": "Required. The resource name of the Control to delete. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`" } }, "httpMethod": "DELETE", "response": { "$ref": "GoogleProtobufEmpty" }, "parameterOrder": [ "name" ] } } }, "widgetConfigs": { "methods": { "get": { "path": "v1/{+name}", "id": "discoveryengine.projects.locations.collections.dataStores.widgetConfigs.get", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/widgetConfigs/{widgetConfigsId}", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.assist.readwrite", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "description": "Gets a WidgetConfig.", "response": { "$ref": "GoogleCloudDiscoveryengineV1WidgetConfig" }, "parameters": { "acceptCache": { "description": "Optional. Whether it's acceptable to load the widget config from cache. If set to true, recent changes on widget configs may take a few minutes to reflect on the end user's view. It's recommended to set to true for maturely developed widgets, as it improves widget performance. Set to false to see changes reflected in prod right away, if your widget is under development.", "type": "boolean", "location": "query" }, "getWidgetConfigRequestOption.turnOffCollectionComponents": { "type": "boolean", "location": "query", "description": "Optional. Whether to turn off collection_components in WidgetConfig to reduce latency and data transmission." }, "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/widgetConfigs/[^/]+$", "description": "Required. Full WidgetConfig resource name. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/widgetConfigs/{widget_config_id}`", "type": "string", "required": true }, "languageCode": { "location": "query", "description": "Optional. BCP-47 language tag (e.g. \"en\", \"fr-CA\"). Used to localize human-readable strings in the response, such as the model selector `display_name` / `description` on `WidgetConfig.UiSettings.ModelConfigInfo`. Empty / unset falls back to the default language (English).", "type": "string" }, "modelInfoView": { "description": "Optional. Selects which view of `WidgetConfig.UiSettings.ModelConfigInfo` the backend computes. `ADMIN` is set by the Cloud Console admin \"Feature Management\" page (screen/4Vn9gQKbN8tb7gm) to receive the admin-surfaced model set with `ResolvedModel.admin_view` populated; `END_USER_MOBILE` is set by the Gemini Enterprise mobile app to receive the mobile model set; unset / `END_USER_WEB` returns the end-user web selector.", "type": "string", "enumDescriptions": [ "Not specified.", "The end-user web model selector view.", "The Cloud Console admin \"Feature Control\" view that displays model toggles. Returns admin-surfaced models with `ResolvedModel.admin_view` populated.", "The end-user model selector view for the Gemini Enterprise mobile app. Returns only mobile-surfaced models, with the mobile default selected. Set explicitly by the mobile client." ], "location": "query", "enum": [ "MODEL_INFO_VIEW_UNSPECIFIED", "END_USER_WEB", "ADMIN", "END_USER_MOBILE" ] } }, "httpMethod": "GET" }, "patch": { "id": "discoveryengine.projects.locations.collections.dataStores.widgetConfigs.patch", "path": "v1/{+name}", "httpMethod": "PATCH", "parameters": { "updateMask": { "type": "string", "description": "Indicates which fields in the provided WidgetConfig to update. The following are the only supported fields: * WidgetConfig.enable_autocomplete If not set, all supported fields are updated.", "location": "query", "format": "google-fieldmask" }, "name": { "location": "path", "description": "Immutable. The full resource name of the widget config. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/widgetConfigs/{widget_config_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/widgetConfigs/[^/]+$", "required": true } }, "request": { "$ref": "GoogleCloudDiscoveryengineV1WidgetConfig" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.assist.readwrite", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1WidgetConfig" }, "description": "Update a WidgetConfig.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/widgetConfigs/{widgetConfigsId}" } } }, "completionSuggestions": { "methods": { "import": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/completionSuggestions:import", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.assist.readwrite", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "description": "Imports CompletionSuggestions for a DataStore.", "request": { "$ref": "GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsRequest" }, "parameterOrder": [ "parent" ], "path": "v1/{+parent}/completionSuggestions:import", "parameters": { "parent": { "description": "Required. The parent data store resource name for which to import customer autocomplete suggestions. Follows pattern `projects/*/locations/*/collections/*/dataStores/*`", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", "location": "path", "required": true } }, "httpMethod": "POST", "response": { "$ref": "GoogleLongrunningOperation" }, "id": "discoveryengine.projects.locations.collections.dataStores.completionSuggestions.import" }, "purge": { "path": "v1/{+parent}/completionSuggestions:purge", "parameterOrder": [ "parent" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/completionSuggestions:purge", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.assist.readwrite", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "description": "Permanently deletes all CompletionSuggestions for a DataStore.", "id": "discoveryengine.projects.locations.collections.dataStores.completionSuggestions.purge", "request": { "$ref": "GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsRequest" }, "httpMethod": "POST", "parameters": { "parent": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", "description": "Required. The parent data store resource name for which to purge completion suggestions. Follows pattern projects/*/locations/*/collections/*/dataStores/*.", "location": "path", "required": true } } } } }, "suggestionDenyListEntries": { "methods": { "import": { "description": "Imports all SuggestionDenyListEntry for a DataStore.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/suggestionDenyListEntries:import", "parameters": { "parent": { "description": "Required. The parent data store resource name for which to import denylist entries. Follows pattern projects/*/locations/*/collections/*/dataStores/*.", "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", "required": true } }, "path": "v1/{+parent}/suggestionDenyListEntries:import", "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.assist.readwrite", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "response": { "$ref": "GoogleLongrunningOperation" }, "id": "discoveryengine.projects.locations.collections.dataStores.suggestionDenyListEntries.import", "request": { "$ref": "GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesRequest" }, "parameterOrder": [ "parent" ] }, "purge": { "response": { "$ref": "GoogleLongrunningOperation" }, "request": { "$ref": "GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesRequest" }, "description": "Permanently deletes all SuggestionDenyListEntry for a DataStore.", "path": "v1/{+parent}/suggestionDenyListEntries:purge", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/suggestionDenyListEntries:purge", "httpMethod": "POST", "id": "discoveryengine.projects.locations.collections.dataStores.suggestionDenyListEntries.purge", "parameters": { "parent": { "type": "string", "description": "Required. The parent data store resource name for which to import denylist entries. Follows pattern projects/*/locations/*/collections/*/dataStores/*.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", "required": true } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.assist.readwrite", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "parameterOrder": [ "parent" ] } } }, "completionConfig": { "methods": { "completeQuery": { "id": "discoveryengine.projects.locations.collections.dataStores.completionConfig.completeQuery", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud_search.query", "https://www.googleapis.com/auth/discoveryengine.assist.readwrite", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponse" }, "parameterOrder": [ "completionConfig" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequest" }, "path": "v1/{+completionConfig}:completeQuery", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/completionConfig:completeQuery", "description": "Completes the user input with advanced keyword suggestions.", "httpMethod": "POST", "parameters": { "completionConfig": { "description": "Required. The completion_config of the parent dataStore or engine resource name for which the completion is performed, such as `projects/*/locations/global/collections/default_collection/dataStores/*/completionConfig` `projects/*/locations/global/collections/default_collection/engines/*/completionConfig`.", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/completionConfig$", "type": "string" } } } } }, "models": { "resources": { "operations": { "methods": { "get": { "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "path": "v1/{+name}", "id": "discoveryengine.projects.locations.collections.dataStores.models.operations.get", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/models/{modelsId}/operations/{operationsId}", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/models/[^/]+/operations/[^/]+$", "type": "string", "description": "The name of the operation resource.", "required": true, "location": "path" } }, "response": { "$ref": "GoogleLongrunningOperation" }, "httpMethod": "GET" }, "list": { "id": "discoveryengine.projects.locations.collections.dataStores.models.operations.list", "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "parameters": { "filter": { "type": "string", "location": "query", "description": "The standard list filter." }, "pageSize": { "type": "integer", "location": "query", "format": "int32", "description": "The standard list page size." }, "name": { "location": "path", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/models/[^/]+$", "description": "The name of the operation's parent resource." }, "returnPartialSuccess": { "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" }, "pageToken": { "type": "string", "location": "query", "description": "The standard list page token." } }, "httpMethod": "GET", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/models/{modelsId}/operations", "path": "v1/{+name}/operations" } } } } }, "customModels": { "methods": { "list": { "description": "Gets a list of all the custom models.", "httpMethod": "GET", "path": "v1/{+dataStore}/customModels", "parameters": { "dataStore": { "location": "path", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", "description": "Required. The resource name of the parent Data Store, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store`. This field is used to identify the data store where to fetch the models from." } }, "id": "discoveryengine.projects.locations.collections.dataStores.customModels.list", "response": { "$ref": "GoogleCloudDiscoveryengineV1ListCustomModelsResponse" }, "parameterOrder": [ "dataStore" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/customModels" } } }, "siteSearchEngine": { "resources": { "operations": { "methods": { "list": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine/operations", "id": "discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.operations.list", "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "parameterOrder": [ "name" ], "parameters": { "returnPartialSuccess": { "type": "boolean", "location": "query", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation." }, "name": { "location": "path", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine$", "description": "The name of the operation's parent resource." }, "pageSize": { "description": "The standard list page size.", "type": "integer", "format": "int32", "location": "query" }, "filter": { "type": "string", "location": "query", "description": "The standard list filter." }, "pageToken": { "description": "The standard list page token.", "location": "query", "type": "string" } }, "httpMethod": "GET", "path": "v1/{+name}/operations" }, "get": { "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine/operations/[^/]+$", "description": "The name of the operation resource.", "type": "string", "required": true, "location": "path" } }, "httpMethod": "GET", "id": "discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.operations.get", "parameterOrder": [ "name" ], "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine/operations/{operationsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "response": { "$ref": "GoogleLongrunningOperation" } } } }, "targetSites": { "methods": { "delete": { "description": "Deletes a TargetSite.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "parameterOrder": [ "name" ], "path": "v1/{+name}", "httpMethod": "DELETE", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine/targetSites/[^/]+$", "required": true, "description": "Required. Full resource name of TargetSite, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}`. If the caller does not have permission to access the TargetSite, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested TargetSite does not exist, a NOT_FOUND error is returned.", "type": "string", "location": "path" } }, "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine/targetSites/{targetSitesId}", "id": "discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.targetSites.delete" }, "batchCreate": { "request": { "$ref": "GoogleCloudDiscoveryengineV1BatchCreateTargetSitesRequest" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleLongrunningOperation" }, "id": "discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.targetSites.batchCreate", "httpMethod": "POST", "path": "v1/{+parent}/targetSites:batchCreate", "parameters": { "parent": { "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine$", "type": "string", "description": "Required. The parent resource shared by all TargetSites being created. `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`. The parent field in the CreateBookRequest messages must either be empty or match this field." } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine/targetSites:batchCreate", "description": "Creates TargetSite in a batch." }, "patch": { "id": "discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.targetSites.patch", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine/targetSites/{targetSitesId}", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "description": "Updates a TargetSite.", "parameterOrder": [ "name" ], "path": "v1/{+name}", "parameters": { "name": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine/targetSites/[^/]+$", "description": "Output only. The fully qualified resource name of the target site. `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}` The `target_site_id` is system-generated.", "required": true, "location": "path" } }, "httpMethod": "PATCH", "request": { "$ref": "GoogleCloudDiscoveryengineV1TargetSite" } }, "get": { "id": "discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.targetSites.get", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine/targetSites/{targetSitesId}", "response": { "$ref": "GoogleCloudDiscoveryengineV1TargetSite" }, "parameters": { "name": { "description": "Required. Full resource name of TargetSite, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}`. If the caller does not have permission to access the TargetSite, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested TargetSite does not exist, a NOT_FOUND error is returned.", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine/targetSites/[^/]+$", "type": "string" } }, "httpMethod": "GET", "description": "Gets a TargetSite.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "parameterOrder": [ "name" ], "path": "v1/{+name}" }, "list": { "parameterOrder": [ "parent" ], "description": "Gets a list of TargetSites.", "id": "discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.targetSites.list", "parameters": { "parent": { "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine$", "description": "Required. The parent site search engine resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`. If the caller does not have permission to list TargetSites under this site search engine, regardless of whether or not this branch exists, a PERMISSION_DENIED error is returned.", "type": "string" }, "pageSize": { "format": "int32", "description": "Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. The maximum value is 1000; values above 1000 will be coerced to 1000. If this field is negative, an INVALID_ARGUMENT error is returned.", "type": "integer", "location": "query" }, "pageToken": { "location": "query", "type": "string", "description": "A page token, received from a previous `ListTargetSites` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListTargetSites` must match the call that provided the page token." } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "httpMethod": "GET", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine/targetSites", "path": "v1/{+parent}/targetSites", "response": { "$ref": "GoogleCloudDiscoveryengineV1ListTargetSitesResponse" } }, "create": { "response": { "$ref": "GoogleLongrunningOperation" }, "parameterOrder": [ "parent" ], "httpMethod": "POST", "parameters": { "parent": { "location": "path", "type": "string", "required": true, "description": "Required. Parent resource name of TargetSite, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine$" } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine/targetSites", "path": "v1/{+parent}/targetSites", "description": "Creates a TargetSite.", "id": "discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.targetSites.create", "request": { "$ref": "GoogleCloudDiscoveryengineV1TargetSite" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] } }, "resources": { "operations": { "methods": { "get": { "httpMethod": "GET", "parameters": { "name": { "description": "The name of the operation resource.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine/targetSites/operations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "id": "discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.targetSites.operations.get", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine/targetSites/operations/{operationsId}", "response": { "$ref": "GoogleLongrunningOperation" }, "parameterOrder": [ "name" ], "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "path": "v1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { "parameters": { "pageSize": { "location": "query", "format": "int32", "description": "The standard list page size.", "type": "integer" }, "returnPartialSuccess": { "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "type": "boolean", "location": "query" }, "pageToken": { "location": "query", "type": "string", "description": "The standard list page token." }, "name": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine/targetSites$", "description": "The name of the operation's parent resource.", "required": true, "location": "path" }, "filter": { "type": "string", "location": "query", "description": "The standard list filter." } }, "httpMethod": "GET", "path": "v1/{+name}/operations", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine/targetSites/operations", "id": "discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.targetSites.operations.list", "response": { "$ref": "GoogleLongrunningListOperationsResponse" } } } } } }, "sitemaps": { "methods": { "fetch": { "response": { "$ref": "GoogleCloudDiscoveryengineV1FetchSitemapsResponse" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine/sitemaps:fetch", "description": "Fetch Sitemaps in a DataStore.", "id": "discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.sitemaps.fetch", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "parameterOrder": [ "parent" ], "httpMethod": "GET", "path": "v1/{+parent}/sitemaps:fetch", "parameters": { "parent": { "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine$", "description": "Required. Parent resource name of the SiteSearchEngine, such as `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine`.", "type": "string" }, "matcher.urisMatcher.uris": { "description": "The Sitemap uris.", "location": "query", "type": "string", "repeated": true } } }, "create": { "description": "Creates a Sitemap.", "parameters": { "parent": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine$", "required": true, "location": "path", "description": "Required. Parent resource name of the SiteSearchEngine, such as `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine`." } }, "parameterOrder": [ "parent" ], "httpMethod": "POST", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine/sitemaps", "request": { "$ref": "GoogleCloudDiscoveryengineV1Sitemap" }, "id": "discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.sitemaps.create", "path": "v1/{+parent}/sitemaps", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "delete": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine/sitemaps/{sitemapsId}", "description": "Deletes a Sitemap.", "parameters": { "name": { "description": "Required. Full resource name of Sitemap, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/sitemaps/{sitemap}`. If the caller does not have permission to access the Sitemap, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested Sitemap does not exist, a NOT_FOUND error is returned.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine/sitemaps/[^/]+$", "required": true, "location": "path", "type": "string" } }, "id": "discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.sitemaps.delete", "httpMethod": "DELETE", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "path": "v1/{+name}" } } } }, "methods": { "recrawlUris": { "id": "discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.recrawlUris", "response": { "$ref": "GoogleLongrunningOperation" }, "path": "v1/{+siteSearchEngine}:recrawlUris", "request": { "$ref": "GoogleCloudDiscoveryengineV1RecrawlUrisRequest" }, "description": "Request on-demand recrawl for a list of URIs.", "httpMethod": "POST", "parameters": { "siteSearchEngine": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine$", "location": "path", "description": "Required. Full resource name of the SiteSearchEngine, such as `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine`.", "type": "string" } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine:recrawlUris", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "parameterOrder": [ "siteSearchEngine" ] }, "batchVerifyTargetSites": { "request": { "$ref": "GoogleCloudDiscoveryengineV1BatchVerifyTargetSitesRequest" }, "path": "v1/{+parent}:batchVerifyTargetSites", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine:batchVerifyTargetSites", "description": "Verify target sites' ownership and validity. This API sends all the target sites under site search engine for verification.", "parameterOrder": [ "parent" ], "id": "discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.batchVerifyTargetSites", "httpMethod": "POST", "parameters": { "parent": { "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine$", "description": "Required. The parent resource shared by all TargetSites being verified. `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`.", "required": true } } }, "disableAdvancedSiteSearch": { "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine:disableAdvancedSiteSearch", "parameterOrder": [ "siteSearchEngine" ], "description": "Downgrade from advanced site search to basic site search.", "request": { "$ref": "GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchRequest" }, "httpMethod": "POST", "parameters": { "siteSearchEngine": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine$", "description": "Required. Full resource name of the SiteSearchEngine, such as `projects/{project}/locations/{location}/dataStores/{data_store_id}/siteSearchEngine`.", "location": "path", "type": "string" } }, "path": "v1/{+siteSearchEngine}:disableAdvancedSiteSearch", "id": "discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.disableAdvancedSiteSearch", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "enableAdvancedSiteSearch": { "parameterOrder": [ "siteSearchEngine" ], "path": "v1/{+siteSearchEngine}:enableAdvancedSiteSearch", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "id": "discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.enableAdvancedSiteSearch", "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Upgrade from basic site search to advanced site search.", "request": { "$ref": "GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchRequest" }, "httpMethod": "POST", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine:enableAdvancedSiteSearch", "parameters": { "siteSearchEngine": { "description": "Required. Full resource name of the SiteSearchEngine, such as `projects/{project}/locations/{location}/dataStores/{data_store_id}/siteSearchEngine`.", "required": true, "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine$" } } }, "fetchDomainVerificationStatus": { "parameterOrder": [ "siteSearchEngine" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1FetchDomainVerificationStatusResponse" }, "id": "discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.fetchDomainVerificationStatus", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine:fetchDomainVerificationStatus", "httpMethod": "GET", "parameters": { "pageSize": { "format": "int32", "type": "integer", "location": "query", "description": "Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. The maximum value is 1000; values above 1000 will be coerced to 1000. If this field is negative, an INVALID_ARGUMENT error is returned." }, "siteSearchEngine": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine$", "description": "Required. The site search engine resource under which we fetch all the domain verification status. `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`.", "type": "string", "location": "path" }, "pageToken": { "type": "string", "location": "query", "description": "A page token, received from a previous `FetchDomainVerificationStatus` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `FetchDomainVerificationStatus` must match the call that provided the page token." } }, "description": "Returns list of target sites with its domain verification status. This method can only be called under data store with BASIC_SITE_SEARCH state at the moment.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "path": "v1/{+siteSearchEngine}:fetchDomainVerificationStatus" } } } }, "methods": { "create": { "httpMethod": "POST", "parameters": { "createAdvancedSiteSearch": { "description": "A boolean flag indicating whether user want to directly create an advanced data store for site search. If the data store is not configured as site search (GENERIC vertical and PUBLIC_WEBSITE content_config), this flag will be ignored.", "location": "query", "type": "boolean" }, "parent": { "type": "string", "description": "Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection}`.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+$", "location": "path", "required": true }, "skipDefaultSchemaCreation": { "location": "query", "type": "boolean", "description": "A boolean flag indicating whether to skip the default schema creation for the data store. Only enable this flag if you are certain that the default schema is incompatible with your use case. If set to true, you must manually create a schema for the data store before any documents can be ingested. This flag cannot be specified if `data_store.starting_schema` is specified." }, "cmekConfigName": { "type": "string", "location": "query", "description": "Resource name of the CmekConfig to use for protecting this DataStore." }, "dataStoreId": { "type": "string", "description": "Required. The ID to use for the DataStore, which will become the final component of the DataStore's resource name. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.", "location": "query" }, "disableCmek": { "type": "boolean", "location": "query", "description": "DataStore without CMEK protections. If a default CmekConfig is set for the project, setting this field will override the default CmekConfig as well." } }, "id": "discoveryengine.projects.locations.collections.dataStores.create", "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores", "path": "v1/{+parent}/dataStores", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "description": "Creates a DataStore. DataStore is for storing Documents. To serve these documents for Search, or Recommendation use case, an Engine needs to be created separately.", "request": { "$ref": "GoogleCloudDiscoveryengineV1DataStore" }, "parameterOrder": [ "parent" ] }, "getSiteSearchEngine": { "response": { "$ref": "GoogleCloudDiscoveryengineV1SiteSearchEngine" }, "path": "v1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "description": "Gets the SiteSearchEngine.", "id": "discoveryengine.projects.locations.collections.dataStores.getSiteSearchEngine", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine", "parameterOrder": [ "name" ], "httpMethod": "GET", "parameters": { "name": { "description": "Required. Resource name of SiteSearchEngine, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`. If the caller does not have permission to access the [SiteSearchEngine], regardless of whether or not it exists, a PERMISSION_DENIED error is returned.", "location": "path", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine$" } } }, "delete": { "path": "v1/{+name}", "httpMethod": "DELETE", "parameters": { "name": { "description": "Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. If the caller does not have permission to delete the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the DataStore to delete does not exist, a NOT_FOUND error is returned.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", "type": "string", "location": "path" } }, "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "parameterOrder": [ "name" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}", "id": "discoveryengine.projects.locations.collections.dataStores.delete", "description": "Deletes a DataStore." }, "setIamPolicy": { "description": "Sets the IAM access control policy for a DataStore. A `NOT_FOUND` error is returned if the resource does not exist. **Important:** When setting a policy directly on a DataStore resource, the only recommended roles in the bindings are: `roles/discoveryengine.admin` `roles/discoveryengine.agentspaceAdmin` `roles/discoveryengine.viewer` `roles/discoveryengine.agentspaceViewer` `roles/discoveryengine.user` `roles/discoveryengine.agentspaceUser` Attempting to grant any other role will result in a warning in logging.", "path": "v1/{+resource}:setIamPolicy", "parameterOrder": [ "resource" ], "httpMethod": "POST", "parameters": { "resource": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", "required": true, "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "location": "path" } }, "response": { "$ref": "GoogleIamV1Policy" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}:setIamPolicy", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "request": { "$ref": "GoogleIamV1SetIamPolicyRequest" }, "id": "discoveryengine.projects.locations.collections.dataStores.setIamPolicy" }, "trainCustomModel": { "response": { "$ref": "GoogleLongrunningOperation" }, "path": "v1/{+dataStore}:trainCustomModel", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}:trainCustomModel", "id": "discoveryengine.projects.locations.collections.dataStores.trainCustomModel", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "description": "Trains a custom model.", "httpMethod": "POST", "parameterOrder": [ "dataStore" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1TrainCustomModelRequest" }, "parameters": { "dataStore": { "required": true, "location": "path", "description": "Required. The resource name of the Data Store, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store`. This field is used to identify the data store where to train the models.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", "type": "string" } } }, "list": { "response": { "$ref": "GoogleCloudDiscoveryengineV1ListDataStoresResponse" }, "httpMethod": "GET", "description": "Lists all the DataStores associated with the project.", "parameters": { "filter": { "type": "string", "location": "query", "description": "Filter by solution type . For example: `filter = 'solution_type:SOLUTION_TYPE_SEARCH'`" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+$", "description": "Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection_id}`. If the caller does not have permission to list DataStores under this location, regardless of whether or not this data store exists, a PERMISSION_DENIED error is returned.", "required": true, "type": "string", "location": "path" }, "pageToken": { "type": "string", "description": "A page token ListDataStoresResponse.next_page_token, received from a previous DataStoreService.ListDataStores call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to DataStoreService.ListDataStores must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.", "location": "query" }, "pageSize": { "format": "int32", "description": "Maximum number of DataStores to return. If unspecified, defaults to 10. The maximum allowed value is 50. Values above 50 will be coerced to 50. If this field is negative, an INVALID_ARGUMENT is returned.", "location": "query", "type": "integer" } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores", "id": "discoveryengine.projects.locations.collections.dataStores.list", "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "path": "v1/{+parent}/dataStores" }, "completeQuery": { "response": { "$ref": "GoogleCloudDiscoveryengineV1CompleteQueryResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.assist.readwrite", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "parameterOrder": [ "dataStore" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}:completeQuery", "httpMethod": "GET", "parameters": { "queryModel": { "description": "Specifies the autocomplete data model. This overrides any model specified in the Configuration \u003e Autocomplete section of the Cloud console. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores.", "type": "string", "location": "query" }, "dataStore": { "type": "string", "location": "path", "description": "Required. The parent data store resource name for which the completion is performed, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store`.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", "required": true }, "userPseudoId": { "description": "Optional. 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`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", "location": "query", "type": "string" }, "includeTailSuggestions": { "location": "query", "description": "Indicates if tail suggestions should be returned if there are no suggestions that match the full query. Even if set to true, if there are suggestions that match the full query, those are returned and no tail suggestions are returned.", "type": "boolean" }, "query": { "description": "Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters.", "type": "string", "location": "query" } }, "description": "Completes the specified user input with keyword suggestions.", "id": "discoveryengine.projects.locations.collections.dataStores.completeQuery", "path": "v1/{+dataStore}:completeQuery" }, "getIamPolicy": { "response": { "$ref": "GoogleIamV1Policy" }, "httpMethod": "GET", "parameters": { "resource": { "location": "path", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field." }, "options.requestedPolicyVersion": { "location": "query", "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "format": "int32", "type": "integer" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}:getIamPolicy", "parameterOrder": [ "resource" ], "description": "Gets the IAM access control policy for a DataStore. A `NOT_FOUND` error is returned if the resource does not exist. An empty policy is returned if the resource exists but does not have a policy set on it.", "path": "v1/{+resource}:getIamPolicy", "id": "discoveryengine.projects.locations.collections.dataStores.getIamPolicy" }, "get": { "description": "Gets a DataStore.", "parameterOrder": [ "name" ], "path": "v1/{+name}", "parameters": { "name": { "location": "path", "description": "Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. If the caller does not have permission to access the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error is returned.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", "type": "string" } }, "httpMethod": "GET", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "id": "discoveryengine.projects.locations.collections.dataStores.get", "response": { "$ref": "GoogleCloudDiscoveryengineV1DataStore" } }, "patch": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1DataStore" }, "description": "Updates a DataStore", "id": "discoveryengine.projects.locations.collections.dataStores.patch", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}", "parameterOrder": [ "name" ], "path": "v1/{+name}", "httpMethod": "PATCH", "request": { "$ref": "GoogleCloudDiscoveryengineV1DataStore" }, "parameters": { "updateMask": { "description": "Indicates which fields in the provided DataStore to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned.", "location": "query", "type": "string", "format": "google-fieldmask" }, "name": { "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", "type": "string", "required": true, "location": "path", "description": "Immutable. Identifier. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters." } } } } } } }, "operations": { "methods": { "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "id": "discoveryengine.projects.locations.operations.list", "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "parameterOrder": [ "name" ], "parameters": { "returnPartialSuccess": { "location": "query", "type": "boolean", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation." }, "filter": { "location": "query", "description": "The standard list filter.", "type": "string" }, "pageToken": { "location": "query", "description": "The standard list page token.", "type": "string" }, "pageSize": { "location": "query", "type": "integer", "description": "The standard list page size.", "format": "int32" }, "name": { "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "description": "The name of the operation's parent resource." } }, "httpMethod": "GET", "path": "v1/{+name}/operations" }, "get": { "parameterOrder": [ "name" ], "httpMethod": "GET", "parameters": { "name": { "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "type": "string", "description": "The name of the operation resource." } }, "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "id": "discoveryengine.projects.locations.operations.get", "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] } } }, "userEvents": { "methods": { "write": { "description": "Writes a single user event.", "request": { "$ref": "GoogleCloudDiscoveryengineV1UserEvent" }, "parameterOrder": [ "parent" ], "parameters": { "parent": { "required": true, "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. The parent resource name. If the write user event action is applied in DataStore level, the format is: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. If the write user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project}/locations/{location}`." }, "writeAsync": { "description": "If set to true, the user event is written asynchronously after validation, and the API responds without waiting for the write.", "location": "query", "type": "boolean" } }, "response": { "$ref": "GoogleCloudDiscoveryengineV1UserEvent" }, "httpMethod": "POST", "id": "discoveryengine.projects.locations.userEvents.write", "path": "v1/{+parent}/userEvents:write", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.assist.readwrite", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/userEvents:write" }, "import": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/userEvents:import", "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Bulk import of user events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully inserted. Operation.metadata is of type ImportMetadata.", "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.assist.readwrite", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "httpMethod": "POST", "path": "v1/{+parent}/userEvents:import", "parameters": { "parent": { "description": "Required. Parent DataStore resource name, of the form `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true } }, "id": "discoveryengine.projects.locations.userEvents.import", "request": { "$ref": "GoogleCloudDiscoveryengineV1ImportUserEventsRequest" } }, "collect": { "response": { "$ref": "GoogleApiHttpBody" }, "httpMethod": "GET", "parameters": { "parent": { "location": "path", "required": true, "description": "Required. The parent resource name. If the collect user event action is applied in DataStore level, the format is: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. If the collect user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project}/locations/{location}`.", "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string" }, "ets": { "location": "query", "description": "The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes.", "format": "int64", "type": "string" }, "uri": { "description": "The URL including cgi-parameters but excluding the hash fragment with a length limit of 5,000 characters. This is often more useful than the referer URL, because many browsers only send the domain for third-party requests.", "type": "string", "location": "query" }, "userEvent": { "type": "string", "description": "Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters.", "location": "query" } }, "id": "discoveryengine.projects.locations.userEvents.collect", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/userEvents:collect", "path": "v1/{+parent}/userEvents:collect", "description": "Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a third-party domain. This method is used only by the Discovery Engine API JavaScript pixel and Google Tag Manager. Users should not call this method directly.", "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.assist.readwrite", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] } } }, "groundingConfigs": { "methods": { "check": { "id": "discoveryengine.projects.locations.groundingConfigs.check", "description": "Performs a grounding check.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "path": "v1/{+groundingConfig}:check", "response": { "$ref": "GoogleCloudDiscoveryengineV1CheckGroundingResponse" }, "httpMethod": "POST", "request": { "$ref": "GoogleCloudDiscoveryengineV1CheckGroundingRequest" }, "parameters": { "groundingConfig": { "required": true, "type": "string", "location": "path", "description": "Required. The resource name of the grounding config, such as `projects/*/locations/global/groundingConfigs/default_grounding_config`.", "pattern": "^projects/[^/]+/locations/[^/]+/groundingConfigs/[^/]+$" } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/groundingConfigs/{groundingConfigsId}:check", "parameterOrder": [ "groundingConfig" ] } } }, "userStores": { "methods": { "patch": { "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1UserStore" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/userStores/{userStoresId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "description": "Updates the User Store.", "path": "v1/{+name}", "response": { "$ref": "GoogleCloudDiscoveryengineV1UserStore" }, "id": "discoveryengine.projects.locations.userStores.patch", "parameters": { "updateMask": { "description": "Optional. The list of fields to update.", "location": "query", "format": "google-fieldmask", "type": "string" }, "name": { "type": "string", "description": "Immutable. The full resource name of the User Store, in the format of `projects/{project}/locations/{location}/userStores/{user_store}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/userStores/[^/]+$", "required": true } }, "httpMethod": "PATCH" }, "batchUpdateUserLicenses": { "parameters": { "parent": { "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/userStores/[^/]+$", "location": "path", "description": "Required. The parent UserStore resource name, format: `projects/{project}/locations/{location}/userStores/{user_store_id}`." } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/userStores/{userStoresId}:batchUpdateUserLicenses", "httpMethod": "POST", "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Updates the User License. This method is used for batch assign/unassign licenses to users.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "id": "discoveryengine.projects.locations.userStores.batchUpdateUserLicenses", "path": "v1/{+parent}:batchUpdateUserLicenses", "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1BatchUpdateUserLicensesRequest" } }, "get": { "httpMethod": "GET", "parameters": { "name": { "type": "string", "description": "Required. The name of the User Store to get. Format: `projects/{project}/locations/{location}/userStores/{user_store_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/userStores/[^/]+$", "required": true } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1UserStore" }, "parameterOrder": [ "name" ], "path": "v1/{+name}", "description": "Gets the User Store.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/userStores/{userStoresId}", "id": "discoveryengine.projects.locations.userStores.get" } }, "resources": { "licenseConfigsUsageStats": { "methods": { "list": { "parameterOrder": [ "parent" ], "path": "v1/{+parent}/licenseConfigsUsageStats", "id": "discoveryengine.projects.locations.userStores.licenseConfigsUsageStats.list", "httpMethod": "GET", "parameters": { "parent": { "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/userStores/[^/]+$", "description": "Required. The parent branch resource name, such as `projects/{project}/locations/{location}/userStores/{user_store_id}`.", "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "description": "Lists all the LicenseConfigUsageStatss associated with the project.", "response": { "$ref": "GoogleCloudDiscoveryengineV1ListLicenseConfigsUsageStatsResponse" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/userStores/{userStoresId}/licenseConfigsUsageStats" } } }, "userLicenses": { "methods": { "list": { "id": "discoveryengine.projects.locations.userStores.userLicenses.list", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "parameters": { "pageSize": { "type": "integer", "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, defaults to 100. The maximum 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" }, "pageToken": { "description": "Optional. A page token, received from a previous `ListUserLicenses` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListUserLicenses` must match the call that provided the page token.", "type": "string", "location": "query" }, "filter": { "type": "string", "location": "query", "description": "Optional. Filter for the list request. Supported fields: * `license_assignment_state` * `user_principal` * Examples: * `license_assignment_state = ASSIGNED` to list assigned user licenses. * `license_assignment_state = NO_LICENSE` to list not licensed users. * `license_assignment_state = NO_LICENSE_ATTEMPTED_LOGIN` to list users who attempted login but no license assigned. * `license_assignment_state != NO_LICENSE_ATTEMPTED_LOGIN` to filter out users who attempted login but no license assigned. * `user_principal = user1@example.com` to list user license for `user1@example.com`." }, "orderBy": { "description": "Optional. The order in which the UserLicenses are listed. The value must be a comma-separated list of fields. Default sorting order is ascending. To specify descending order for a field, append a \" desc\" suffix. Redundant space characters in the syntax are insignificant. Supported fields (only `user_principal` is supported for now): * `user_principal` If not set, the default ordering is by `user_principal`. Examples: * `user_principal` to order by `user_principal` in ascending order. * `user_principal desc` to order by `user_principal` in descending order.", "type": "string", "location": "query" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/userStores/[^/]+$", "required": true, "location": "path", "type": "string", "description": "Required. The parent UserStore resource name, format: `projects/{project}/locations/{location}/userStores/{user_store_id}`." } }, "description": "Lists the User Licenses.", "httpMethod": "GET", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/userStores/{userStoresId}/userLicenses", "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1ListUserLicensesResponse" }, "path": "v1/{+parent}/userLicenses" } } } } }, "identityMappingStores": { "methods": { "list": { "description": "Lists all Identity Mapping Stores.", "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "httpMethod": "GET", "parameters": { "pageSize": { "location": "query", "type": "integer", "description": "Maximum number of IdentityMappingStores to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000.", "format": "int32" }, "parent": { "required": true, "description": "Required. The parent of the Identity Mapping Stores to list. Format: `projects/{project}/locations/{location}`.", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "type": "string" }, "pageToken": { "location": "query", "description": "A page token, received from a previous `ListIdentityMappingStores` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListIdentityMappingStores` must match the call that provided the page token.", "type": "string" } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/identityMappingStores", "id": "discoveryengine.projects.locations.identityMappingStores.list", "path": "v1/{+parent}/identityMappingStores", "response": { "$ref": "GoogleCloudDiscoveryengineV1ListIdentityMappingStoresResponse" } }, "importIdentityMappings": { "parameterOrder": [ "identityMappingStore" ], "path": "v1/{+identityMappingStore}:importIdentityMappings", "httpMethod": "POST", "parameters": { "identityMappingStore": { "description": "Required. The name of the Identity Mapping Store to import Identity Mapping Entries to. Format: `projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}`", "required": true, "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/identityMappingStores/[^/]+$" } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/identityMappingStores/{identityMappingStoresId}:importIdentityMappings", "description": "Imports a list of Identity Mapping Entries to an Identity Mapping Store.", "request": { "$ref": "GoogleCloudDiscoveryengineV1ImportIdentityMappingsRequest" }, "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "id": "discoveryengine.projects.locations.identityMappingStores.importIdentityMappings" }, "get": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/identityMappingStores/{identityMappingStoresId}", "description": "Gets the Identity Mapping Store.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1IdentityMappingStore" }, "parameters": { "name": { "type": "string", "description": "Required. The name of the Identity Mapping Store to get. Format: `projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}`", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/identityMappingStores/[^/]+$" } }, "id": "discoveryengine.projects.locations.identityMappingStores.get", "path": "v1/{+name}", "httpMethod": "GET", "parameterOrder": [ "name" ] }, "create": { "description": "Creates a new Identity Mapping Store.", "path": "v1/{+parent}/identityMappingStores", "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "id": "discoveryengine.projects.locations.identityMappingStores.create", "response": { "$ref": "GoogleCloudDiscoveryengineV1IdentityMappingStore" }, "parameters": { "parent": { "location": "path", "type": "string", "description": "Required. The parent collection resource name, such as `projects/{project}/locations/{location}`.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$" }, "cmekConfigName": { "type": "string", "description": "Resource name of the CmekConfig to use for protecting this Identity Mapping Store.", "location": "query" }, "disableCmek": { "type": "boolean", "location": "query", "description": "Identity Mapping Store without CMEK protections. If a default CmekConfig is set for the project, setting this field will override the default CmekConfig as well." }, "identityMappingStoreId": { "location": "query", "description": "Required. The ID of the Identity Mapping Store to create. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 63 characters.", "type": "string" } }, "httpMethod": "POST", "request": { "$ref": "GoogleCloudDiscoveryengineV1IdentityMappingStore" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/identityMappingStores" }, "purgeIdentityMappings": { "parameterOrder": [ "identityMappingStore" ], "description": "Purges specified or all Identity Mapping Entries from an Identity Mapping Store.", "id": "discoveryengine.projects.locations.identityMappingStores.purgeIdentityMappings", "httpMethod": "POST", "parameters": { "identityMappingStore": { "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/identityMappingStores/[^/]+$", "type": "string", "description": "Required. The name of the Identity Mapping Store to purge Identity Mapping Entries from. Format: `projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}`" } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/identityMappingStores/{identityMappingStoresId}:purgeIdentityMappings", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "response": { "$ref": "GoogleLongrunningOperation" }, "path": "v1/{+identityMappingStore}:purgeIdentityMappings", "request": { "$ref": "GoogleCloudDiscoveryengineV1PurgeIdentityMappingsRequest" } }, "delete": { "path": "v1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "description": "Deletes the Identity Mapping Store.", "httpMethod": "DELETE", "parameters": { "name": { "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/identityMappingStores/[^/]+$", "description": "Required. The name of the Identity Mapping Store to delete. Format: `projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}`", "type": "string" } }, "parameterOrder": [ "name" ], "id": "discoveryengine.projects.locations.identityMappingStores.delete", "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/identityMappingStores/{identityMappingStoresId}" }, "listIdentityMappings": { "id": "discoveryengine.projects.locations.identityMappingStores.listIdentityMappings", "response": { "$ref": "GoogleCloudDiscoveryengineV1ListIdentityMappingsResponse" }, "httpMethod": "GET", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/identityMappingStores/{identityMappingStoresId}:listIdentityMappings", "description": "Lists Identity Mappings in an Identity Mapping Store.", "parameters": { "identityMappingStore": { "pattern": "^projects/[^/]+/locations/[^/]+/identityMappingStores/[^/]+$", "type": "string", "required": true, "description": "Required. The name of the Identity Mapping Store to list Identity Mapping Entries in. Format: `projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}`", "location": "path" }, "pageSize": { "description": "Maximum number of IdentityMappings to return. If unspecified, defaults to 2000. The maximum allowed value is 10000. Values above 10000 will be coerced to 10000.", "type": "integer", "format": "int32", "location": "query" }, "pageToken": { "type": "string", "location": "query", "description": "A page token, received from a previous `ListIdentityMappings` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListIdentityMappings` must match the call that provided the page token." } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "parameterOrder": [ "identityMappingStore" ], "path": "v1/{+identityMappingStore}:listIdentityMappings" } }, "resources": { "operations": { "methods": { "list": { "id": "discoveryengine.projects.locations.identityMappingStores.operations.list", "path": "v1/{+name}/operations", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/identityMappingStores/{identityMappingStoresId}/operations", "parameters": { "name": { "location": "path", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/identityMappingStores/[^/]+$", "description": "The name of the operation's parent resource." }, "pageToken": { "type": "string", "location": "query", "description": "The standard list page token." }, "pageSize": { "format": "int32", "type": "integer", "description": "The standard list page size.", "location": "query" }, "filter": { "description": "The standard list filter.", "location": "query", "type": "string" }, "returnPartialSuccess": { "location": "query", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "type": "boolean" } }, "httpMethod": "GET", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`." }, "get": { "path": "v1/{+name}", "parameterOrder": [ "name" ], "id": "discoveryengine.projects.locations.identityMappingStores.operations.get", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/identityMappingStores/{identityMappingStoresId}/operations/{operationsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "httpMethod": "GET", "parameters": { "name": { "type": "string", "required": true, "description": "The name of the operation resource.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/identityMappingStores/[^/]+/operations/[^/]+$" } }, "response": { "$ref": "GoogleLongrunningOperation" } } } } } }, "licenseConfigs": { "methods": { "patch": { "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1LicenseConfig" }, "description": "Updates the LicenseConfig", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "id": "discoveryengine.projects.locations.licenseConfigs.patch", "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/licenseConfigs/{licenseConfigsId}", "parameters": { "name": { "location": "path", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/licenseConfigs/[^/]+$", "description": "Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project}/locations/{location}/licenseConfigs/{license_config}`" }, "updateMask": { "location": "query", "format": "google-fieldmask", "description": "Optional. Indicates which fields in the provided LicenseConfig to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned.", "type": "string" } }, "response": { "$ref": "GoogleCloudDiscoveryengineV1LicenseConfig" }, "httpMethod": "PATCH" }, "list": { "parameters": { "pageToken": { "location": "query", "description": "Optional. Not supported.", "type": "string" }, "pageSize": { "description": "Optional. Not supported.", "location": "query", "type": "integer", "format": "int32" }, "filter": { "location": "query", "description": "Optional. The filter to apply to the list results. The supported fields are: * `subscription_tier` * `state` Examples: * `subscription_tier=SUBSCRIPTION_TIER_SEARCH,state=ACTIVE` - Lists all active search license configs. * `state=ACTIVE` - Lists all active license configs. The filter string should be a comma-separated list of field=value pairs.", "type": "string" }, "parent": { "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. The parent branch resource name, such as `projects/{project}/locations/{location}`.", "type": "string" } }, "parameterOrder": [ "parent" ], "id": "discoveryengine.projects.locations.licenseConfigs.list", "httpMethod": "GET", "description": "Lists all the LicenseConfigs associated with the project.", "path": "v1/{+parent}/licenseConfigs", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/licenseConfigs", "response": { "$ref": "GoogleCloudDiscoveryengineV1ListLicenseConfigsResponse" } }, "get": { "id": "discoveryengine.projects.locations.licenseConfigs.get", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "description": "Gets a LicenseConfig.", "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/licenseConfigs/{licenseConfigsId}", "parameterOrder": [ "name" ], "httpMethod": "GET", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/licenseConfigs/[^/]+$", "type": "string", "required": true, "location": "path", "description": "Required. Full resource name of LicenseConfig, such as `projects/{project}/locations/{location}/licenseConfigs/*`. If the caller does not have permission to access the LicenseConfig, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested LicenseConfig does not exist, a NOT_FOUND error is returned." } }, "response": { "$ref": "GoogleCloudDiscoveryengineV1LicenseConfig" } }, "create": { "httpMethod": "POST", "parameters": { "licenseConfigId": { "location": "query", "description": "Optional. The ID to use for the LicenseConfig, which will become the final component of the LicenseConfig's resource name. We are using the tier (product edition) name as the license config id such as `search` or `search_and_assistant`.", "type": "string" }, "parent": { "description": "Required. The parent resource name, such as `projects/{project}/locations/{location}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, "description": "Creates a LicenseConfig This method should only be used for creating NotebookLm licenses or Gemini Enterprise free trial licenses.", "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1LicenseConfig" }, "response": { "$ref": "GoogleCloudDiscoveryengineV1LicenseConfig" }, "path": "v1/{+parent}/licenseConfigs", "id": "discoveryengine.projects.locations.licenseConfigs.create", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/licenseConfigs" } } }, "podcasts": { "resources": { "operations": { "methods": { "get": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/podcasts/{podcastsId}/operations/{operationsId}", "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "id": "discoveryengine.projects.locations.podcasts.operations.get", "response": { "$ref": "GoogleLongrunningOperation" }, "path": "v1/{+name}", "parameterOrder": [ "name" ], "parameters": { "name": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/podcasts/[^/]+/operations/[^/]+$", "required": true, "description": "The name of the operation resource.", "location": "path" } }, "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] } } } } }, "dataStores": { "methods": { "getSiteSearchEngine": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "description": "Gets the SiteSearchEngine.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine", "path": "v1/{+name}", "parameterOrder": [ "name" ], "parameters": { "name": { "description": "Required. Resource name of SiteSearchEngine, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`. If the caller does not have permission to access the [SiteSearchEngine], regardless of whether or not it exists, a PERMISSION_DENIED error is returned.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/siteSearchEngine$", "location": "path", "required": true } }, "response": { "$ref": "GoogleCloudDiscoveryengineV1SiteSearchEngine" }, "httpMethod": "GET", "id": "discoveryengine.projects.locations.dataStores.getSiteSearchEngine" }, "getIamPolicy": { "description": "Gets the IAM access control policy for a DataStore. A `NOT_FOUND` error is returned if the resource does not exist. An empty policy is returned if the resource exists but does not have a policy set on it.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}:getIamPolicy", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "parameters": { "options.requestedPolicyVersion": { "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "format": "int32", "type": "integer", "location": "query" }, "resource": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", "required": true, "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "location": "path" } }, "id": "discoveryengine.projects.locations.dataStores.getIamPolicy", "httpMethod": "GET", "response": { "$ref": "GoogleIamV1Policy" }, "path": "v1/{+resource}:getIamPolicy", "parameterOrder": [ "resource" ] }, "list": { "description": "Lists all the DataStores associated with the project.", "response": { "$ref": "GoogleCloudDiscoveryengineV1ListDataStoresResponse" }, "httpMethod": "GET", "parameters": { "filter": { "location": "query", "description": "Filter by solution type . For example: `filter = 'solution_type:SOLUTION_TYPE_SEARCH'`", "type": "string" }, "pageSize": { "type": "integer", "description": "Maximum number of DataStores to return. If unspecified, defaults to 10. The maximum allowed value is 50. Values above 50 will be coerced to 50. If this field is negative, an INVALID_ARGUMENT is returned.", "location": "query", "format": "int32" }, "parent": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection_id}`. If the caller does not have permission to list DataStores under this location, regardless of whether or not this data store exists, a PERMISSION_DENIED error is returned.", "location": "path", "type": "string" }, "pageToken": { "location": "query", "description": "A page token ListDataStoresResponse.next_page_token, received from a previous DataStoreService.ListDataStores call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to DataStoreService.ListDataStores must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.", "type": "string" } }, "id": "discoveryengine.projects.locations.dataStores.list", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores", "parameterOrder": [ "parent" ], "path": "v1/{+parent}/dataStores", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "delete": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "parameters": { "name": { "description": "Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. If the caller does not have permission to delete the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the DataStore to delete does not exist, a NOT_FOUND error is returned.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", "location": "path", "required": true } }, "httpMethod": "DELETE", "id": "discoveryengine.projects.locations.dataStores.delete", "description": "Deletes a DataStore.", "path": "v1/{+name}", "parameterOrder": [ "name" ] }, "setIamPolicy": { "parameterOrder": [ "resource" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "response": { "$ref": "GoogleIamV1Policy" }, "request": { "$ref": "GoogleIamV1SetIamPolicyRequest" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}:setIamPolicy", "id": "discoveryengine.projects.locations.dataStores.setIamPolicy", "path": "v1/{+resource}:setIamPolicy", "httpMethod": "POST", "description": "Sets the IAM access control policy for a DataStore. A `NOT_FOUND` error is returned if the resource does not exist. **Important:** When setting a policy directly on a DataStore resource, the only recommended roles in the bindings are: `roles/discoveryengine.admin` `roles/discoveryengine.agentspaceAdmin` `roles/discoveryengine.viewer` `roles/discoveryengine.agentspaceViewer` `roles/discoveryengine.user` `roles/discoveryengine.agentspaceUser` Attempting to grant any other role will result in a warning in logging.", "parameters": { "resource": { "location": "path", "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$" } } }, "get": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "path": "v1/{+name}", "parameters": { "name": { "description": "Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. If the caller does not have permission to access the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error is returned.", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", "type": "string" } }, "response": { "$ref": "GoogleCloudDiscoveryengineV1DataStore" }, "httpMethod": "GET", "id": "discoveryengine.projects.locations.dataStores.get", "parameterOrder": [ "name" ], "description": "Gets a DataStore." }, "patch": { "path": "v1/{+name}", "response": { "$ref": "GoogleCloudDiscoveryengineV1DataStore" }, "id": "discoveryengine.projects.locations.dataStores.patch", "request": { "$ref": "GoogleCloudDiscoveryengineV1DataStore" }, "description": "Updates a DataStore", "parameters": { "name": { "location": "path", "type": "string", "required": true, "description": "Immutable. Identifier. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$" }, "updateMask": { "type": "string", "format": "google-fieldmask", "location": "query", "description": "Indicates which fields in the provided DataStore to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned." } }, "httpMethod": "PATCH", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "parameterOrder": [ "name" ] }, "create": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "description": "Creates a DataStore. DataStore is for storing Documents. To serve these documents for Search, or Recommendation use case, an Engine needs to be created separately.", "id": "discoveryengine.projects.locations.dataStores.create", "path": "v1/{+parent}/dataStores", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores", "response": { "$ref": "GoogleLongrunningOperation" }, "parameterOrder": [ "parent" ], "parameters": { "cmekConfigName": { "description": "Resource name of the CmekConfig to use for protecting this DataStore.", "location": "query", "type": "string" }, "dataStoreId": { "description": "Required. The ID to use for the DataStore, which will become the final component of the DataStore's resource name. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.", "type": "string", "location": "query" }, "createAdvancedSiteSearch": { "location": "query", "type": "boolean", "description": "A boolean flag indicating whether user want to directly create an advanced data store for site search. If the data store is not configured as site search (GENERIC vertical and PUBLIC_WEBSITE content_config), this flag will be ignored." }, "skipDefaultSchemaCreation": { "type": "boolean", "location": "query", "description": "A boolean flag indicating whether to skip the default schema creation for the data store. Only enable this flag if you are certain that the default schema is incompatible with your use case. If set to true, you must manually create a schema for the data store before any documents can be ingested. This flag cannot be specified if `data_store.starting_schema` is specified." }, "disableCmek": { "type": "boolean", "location": "query", "description": "DataStore without CMEK protections. If a default CmekConfig is set for the project, setting this field will override the default CmekConfig as well." }, "parent": { "type": "string", "description": "Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true } }, "request": { "$ref": "GoogleCloudDiscoveryengineV1DataStore" }, "httpMethod": "POST" }, "completeQuery": { "id": "discoveryengine.projects.locations.dataStores.completeQuery", "response": { "$ref": "GoogleCloudDiscoveryengineV1CompleteQueryResponse" }, "description": "Completes the specified user input with keyword suggestions.", "path": "v1/{+dataStore}:completeQuery", "parameterOrder": [ "dataStore" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.assist.readwrite", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}:completeQuery", "httpMethod": "GET", "parameters": { "queryModel": { "location": "query", "type": "string", "description": "Specifies the autocomplete data model. This overrides any model specified in the Configuration \u003e Autocomplete section of the Cloud console. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores." }, "userPseudoId": { "location": "query", "type": "string", "description": "Optional. 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`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned." }, "query": { "location": "query", "description": "Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters.", "type": "string" }, "dataStore": { "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", "type": "string", "required": true, "location": "path", "description": "Required. The parent data store resource name for which the completion is performed, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store`." }, "includeTailSuggestions": { "description": "Indicates if tail suggestions should be returned if there are no suggestions that match the full query. Even if set to true, if there are suggestions that match the full query, those are returned and no tail suggestions are returned.", "location": "query", "type": "boolean" } } } }, "resources": { "servingConfigs": { "methods": { "create": { "description": "Creates a ServingConfig. Note: The Google Cloud console works only with the default serving config. Additional ServingConfigs can be created and managed only via the API. A maximum of 100 ServingConfigs are allowed in an Engine, otherwise a RESOURCE_EXHAUSTED error is returned.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "httpMethod": "POST", "response": { "$ref": "GoogleCloudDiscoveryengineV1ServingConfig" }, "parameters": { "servingConfigId": { "description": "Required. The ID to use for the ServingConfig, which will become the final component of the ServingConfig's resource name. This value should be 4-63 characters, and valid characters are /a-zA-Z0-9+/.", "type": "string", "location": "query" }, "parent": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", "description": "Required. Full resource name of parent. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`", "required": true, "location": "path" } }, "request": { "$ref": "GoogleCloudDiscoveryengineV1ServingConfig" }, "id": "discoveryengine.projects.locations.dataStores.servingConfigs.create", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/servingConfigs", "parameterOrder": [ "parent" ], "path": "v1/{+parent}/servingConfigs" }, "get": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}", "id": "discoveryengine.projects.locations.dataStores.servingConfigs.get", "parameterOrder": [ "name" ], "parameters": { "name": { "description": "Required. The resource name of the ServingConfig to get. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config_id}`", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$", "required": true, "type": "string", "location": "path" } }, "httpMethod": "GET", "response": { "$ref": "GoogleCloudDiscoveryengineV1ServingConfig" }, "path": "v1/{+name}", "description": "Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { "response": { "$ref": "GoogleCloudDiscoveryengineV1ListServingConfigsResponse" }, "httpMethod": "GET", "parameters": { "pageSize": { "format": "int32", "type": "integer", "description": "Optional. Maximum number of results to return. If unspecified, defaults to 100. If a value greater than 100 is provided, at most 100 results are returned.", "location": "query" }, "pageToken": { "type": "string", "location": "query", "description": "Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page." }, "parent": { "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", "description": "Required. Full resource name of the parent resource. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`", "type": "string" } }, "path": "v1/{+parent}/servingConfigs", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/servingConfigs", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "description": "Lists all ServingConfigs linked to this dataStore.", "id": "discoveryengine.projects.locations.dataStores.servingConfigs.list", "parameterOrder": [ "parent" ] }, "delete": { "path": "v1/{+name}", "parameters": { "name": { "type": "string", "description": "Required. The resource name of the ServingConfig to delete. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config_id}`", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$", "location": "path" } }, "httpMethod": "DELETE", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}", "description": "Deletes a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.", "response": { "$ref": "GoogleProtobufEmpty" }, "id": "discoveryengine.projects.locations.dataStores.servingConfigs.delete" }, "recommend": { "parameterOrder": [ "servingConfig" ], "id": "discoveryengine.projects.locations.dataStores.servingConfigs.recommend", "parameters": { "servingConfig": { "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$", "type": "string", "required": true, "description": "Required. Full resource name of a ServingConfig: `projects/*/locations/global/collections/*/engines/*/servingConfigs/*`, or `projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*` One default serving config is created along with your recommendation engine creation. The engine ID is used as the ID of the default serving config. For example, for Engine `projects/*/locations/global/collections/*/engines/my-engine`, you can use `projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests.", "location": "path" } }, "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "path": "v1/{+servingConfig}:recommend", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}:recommend", "request": { "$ref": "GoogleCloudDiscoveryengineV1RecommendRequest" }, "response": { "$ref": "GoogleCloudDiscoveryengineV1RecommendResponse" }, "description": "Makes a recommendation, which requires a contextual user event." }, "answer": { "parameters": { "servingConfig": { "location": "path", "required": true, "description": "Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. Or the resource name of the agent engine serving config, such as: `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_agent_answer`. (use when `enable_agent_invocation` set to true, and you have custom `AI_MODE` agent engine configured) This field is used to identify the serving configuration name, set of models used to make the search.", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$", "type": "string" } }, "request": { "$ref": "GoogleCloudDiscoveryengineV1AnswerQueryRequest" }, "httpMethod": "POST", "description": "Answer query method.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}:answer", "response": { "$ref": "GoogleCloudDiscoveryengineV1AnswerQueryResponse" }, "parameterOrder": [ "servingConfig" ], "path": "v1/{+servingConfig}:answer", "id": "discoveryengine.projects.locations.dataStores.servingConfigs.answer" }, "patch": { "response": { "$ref": "GoogleCloudDiscoveryengineV1ServingConfig" }, "path": "v1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}", "id": "discoveryengine.projects.locations.dataStores.servingConfigs.patch", "request": { "$ref": "GoogleCloudDiscoveryengineV1ServingConfig" }, "description": "Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.", "parameters": { "updateMask": { "location": "query", "format": "google-fieldmask", "type": "string", "description": "Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated." }, "name": { "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$", "description": "Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}`", "location": "path", "type": "string", "required": true } }, "parameterOrder": [ "name" ], "httpMethod": "PATCH" }, "searchLite": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}:searchLite", "id": "discoveryengine.projects.locations.dataStores.servingConfigs.searchLite", "parameterOrder": [ "servingConfig" ], "description": "Performs a search. Similar to the SearchService.Search method, but a lite version that allows API key for authentication, where OAuth and IAM checks are not required. Only public website search is supported by this method. If data stores and engines not associated with public website search are specified, a `FAILED_PRECONDITION` error is returned. This method can be used for easy onboarding without having to implement an authentication backend. However, it is strongly recommended to use SearchService.Search instead with required OAuth and IAM checks to provide better data security.", "response": { "$ref": "GoogleCloudDiscoveryengineV1SearchResponse" }, "path": "v1/{+servingConfig}:searchLite", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.assist.readwrite", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "parameters": { "servingConfig": { "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$", "required": true, "type": "string", "location": "path", "description": "Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search." } }, "httpMethod": "POST", "request": { "$ref": "GoogleCloudDiscoveryengineV1SearchRequest" } }, "streamAnswer": { "path": "v1/{+servingConfig}:streamAnswer", "request": { "$ref": "GoogleCloudDiscoveryengineV1AnswerQueryRequest" }, "id": "discoveryengine.projects.locations.dataStores.servingConfigs.streamAnswer", "parameterOrder": [ "servingConfig" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1AnswerQueryResponse" }, "httpMethod": "POST", "parameters": { "servingConfig": { "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$", "type": "string", "description": "Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. Or the resource name of the agent engine serving config, such as: `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_agent_answer`. (use when `enable_agent_invocation` set to true, and you have custom `AI_MODE` agent engine configured) This field is used to identify the serving configuration name, set of models used to make the search.", "required": true, "location": "path" } }, "description": "Answer query method (streaming). It takes one AnswerQueryRequest and returns multiple AnswerQueryResponse messages in a stream.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}:streamAnswer" }, "search": { "path": "v1/{+servingConfig}:search", "id": "discoveryengine.projects.locations.dataStores.servingConfigs.search", "description": "Performs a search.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.assist.readwrite", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "httpMethod": "POST", "parameters": { "servingConfig": { "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$", "description": "Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.", "type": "string" } }, "parameterOrder": [ "servingConfig" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}:search", "request": { "$ref": "GoogleCloudDiscoveryengineV1SearchRequest" }, "response": { "$ref": "GoogleCloudDiscoveryengineV1SearchResponse" } } } }, "widgetConfigs": { "methods": { "get": { "description": "Gets a WidgetConfig.", "id": "discoveryengine.projects.locations.dataStores.widgetConfigs.get", "parameterOrder": [ "name" ], "path": "v1/{+name}", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.assist.readwrite", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "parameters": { "name": { "required": true, "description": "Required. Full WidgetConfig resource name. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/widgetConfigs/{widget_config_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/widgetConfigs/[^/]+$", "type": "string" }, "acceptCache": { "type": "boolean", "location": "query", "description": "Optional. Whether it's acceptable to load the widget config from cache. If set to true, recent changes on widget configs may take a few minutes to reflect on the end user's view. It's recommended to set to true for maturely developed widgets, as it improves widget performance. Set to false to see changes reflected in prod right away, if your widget is under development." }, "modelInfoView": { "description": "Optional. Selects which view of `WidgetConfig.UiSettings.ModelConfigInfo` the backend computes. `ADMIN` is set by the Cloud Console admin \"Feature Management\" page (screen/4Vn9gQKbN8tb7gm) to receive the admin-surfaced model set with `ResolvedModel.admin_view` populated; `END_USER_MOBILE` is set by the Gemini Enterprise mobile app to receive the mobile model set; unset / `END_USER_WEB` returns the end-user web selector.", "type": "string", "enumDescriptions": [ "Not specified.", "The end-user web model selector view.", "The Cloud Console admin \"Feature Control\" view that displays model toggles. Returns admin-surfaced models with `ResolvedModel.admin_view` populated.", "The end-user model selector view for the Gemini Enterprise mobile app. Returns only mobile-surfaced models, with the mobile default selected. Set explicitly by the mobile client." ], "enum": [ "MODEL_INFO_VIEW_UNSPECIFIED", "END_USER_WEB", "ADMIN", "END_USER_MOBILE" ], "location": "query" }, "getWidgetConfigRequestOption.turnOffCollectionComponents": { "description": "Optional. Whether to turn off collection_components in WidgetConfig to reduce latency and data transmission.", "location": "query", "type": "boolean" }, "languageCode": { "type": "string", "description": "Optional. BCP-47 language tag (e.g. \"en\", \"fr-CA\"). Used to localize human-readable strings in the response, such as the model selector `display_name` / `description` on `WidgetConfig.UiSettings.ModelConfigInfo`. Empty / unset falls back to the default language (English).", "location": "query" } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/widgetConfigs/{widgetConfigsId}", "response": { "$ref": "GoogleCloudDiscoveryengineV1WidgetConfig" } }, "patch": { "description": "Update a WidgetConfig.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.assist.readwrite", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1WidgetConfig" }, "httpMethod": "PATCH", "parameters": { "name": { "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/widgetConfigs/[^/]+$", "description": "Immutable. The full resource name of the widget config. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/widgetConfigs/{widget_config_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", "required": true }, "updateMask": { "location": "query", "type": "string", "description": "Indicates which fields in the provided WidgetConfig to update. The following are the only supported fields: * WidgetConfig.enable_autocomplete If not set, all supported fields are updated.", "format": "google-fieldmask" } }, "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/widgetConfigs/{widgetConfigsId}", "request": { "$ref": "GoogleCloudDiscoveryengineV1WidgetConfig" }, "id": "discoveryengine.projects.locations.dataStores.widgetConfigs.patch", "parameterOrder": [ "name" ] } } }, "controls": { "methods": { "patch": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1Control" }, "parameterOrder": [ "name" ], "id": "discoveryengine.projects.locations.dataStores.controls.patch", "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/controls/{controlsId}", "parameters": { "name": { "required": true, "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/controls/[^/]+$", "description": "Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*`" }, "updateMask": { "location": "query", "description": "Optional. Indicates which fields in the provided Control to update. The following are NOT supported: * Control.name * Control.solution_type If not set or empty, all supported fields are updated.", "type": "string", "format": "google-fieldmask" } }, "httpMethod": "PATCH", "description": "Updates a Control. Control action type cannot be changed. If the Control to update does not exist, a NOT_FOUND error is returned.", "response": { "$ref": "GoogleCloudDiscoveryengineV1Control" } }, "create": { "parameters": { "parent": { "description": "Required. Full resource name of parent data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`.", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", "type": "string" }, "controlId": { "location": "query", "type": "string", "description": "Required. The ID to use for the Control, which will become the final component of the Control's resource name. This value must be within 1-63 characters. Valid characters are /a-z-_/." } }, "path": "v1/{+parent}/controls", "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "parameterOrder": [ "parent" ], "id": "discoveryengine.projects.locations.dataStores.controls.create", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/controls", "request": { "$ref": "GoogleCloudDiscoveryengineV1Control" }, "description": "Creates a Control. By default 1000 controls are allowed for a data store. A request can be submitted to adjust this limit. If the Control to create already exists, an ALREADY_EXISTS error is returned.", "response": { "$ref": "GoogleCloudDiscoveryengineV1Control" } }, "list": { "description": "Lists all Controls by their parent DataStore.", "httpMethod": "GET", "parameters": { "pageSize": { "format": "int32", "description": "Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.", "location": "query", "type": "integer" }, "pageToken": { "description": "Optional. A page token, received from a previous `ListControls` call. Provide this to retrieve the subsequent page.", "location": "query", "type": "string" }, "filter": { "description": "Optional. A filter to apply on the list results. Supported features: * List all the products under the parent branch if filter is unset. Currently this field is unsupported.", "type": "string", "location": "query" }, "parent": { "description": "Required. The data store resource name. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`.", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", "type": "string", "required": true, "location": "path" } }, "parameterOrder": [ "parent" ], "path": "v1/{+parent}/controls", "response": { "$ref": "GoogleCloudDiscoveryengineV1ListControlsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "id": "discoveryengine.projects.locations.dataStores.controls.list", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/controls" }, "get": { "description": "Gets a Control.", "path": "v1/{+name}", "response": { "$ref": "GoogleCloudDiscoveryengineV1Control" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "httpMethod": "GET", "parameters": { "name": { "location": "path", "required": true, "description": "Required. The resource name of the Control to get. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/controls/[^/]+$" } }, "id": "discoveryengine.projects.locations.dataStores.controls.get", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/controls/{controlsId}", "parameterOrder": [ "name" ] }, "delete": { "id": "discoveryengine.projects.locations.dataStores.controls.delete", "description": "Deletes a Control. If the Control to delete does not exist, a NOT_FOUND error is returned.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "path": "v1/{+name}", "parameterOrder": [ "name" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/controls/{controlsId}", "parameters": { "name": { "location": "path", "type": "string", "required": true, "description": "Required. The resource name of the Control to delete. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/controls/[^/]+$" } }, "response": { "$ref": "GoogleProtobufEmpty" }, "httpMethod": "DELETE" } } }, "branches": { "methods": { "batchGetDocumentsMetadata": { "id": "discoveryengine.projects.locations.dataStores.branches.batchGetDocumentsMetadata", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/batchGetDocumentsMetadata", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "description": "Gets index freshness metadata for Documents. Supported for website search only.", "path": "v1/{+parent}/batchGetDocumentsMetadata", "response": { "$ref": "GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponse" }, "parameterOrder": [ "parent" ], "httpMethod": "GET", "parameters": { "matcher.urisMatcher.uris": { "location": "query", "description": "The exact URIs to match by.", "type": "string", "repeated": true }, "matcher.fhirMatcher.fhirResources": { "location": "query", "description": "Required. The FHIR resources to match by. Format: projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id}", "repeated": true, "type": "string" }, "parent": { "location": "path", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+$", "description": "Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`." } } } }, "resources": { "operations": { "methods": { "cancel": { "httpMethod": "POST", "response": { "$ref": "GoogleProtobufEmpty" }, "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+/operations/[^/]+$", "required": true, "type": "string", "location": "path", "description": "The name of the operation resource to be cancelled." } }, "path": "v1/{+name}:cancel", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/operations/{operationsId}:cancel", "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "id": "discoveryengine.projects.locations.dataStores.branches.operations.cancel", "request": { "$ref": "GoogleLongrunningCancelOperationRequest" }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { "path": "v1/{+name}/operations", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/operations", "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "id": "discoveryengine.projects.locations.dataStores.branches.operations.list", "parameterOrder": [ "name" ], "httpMethod": "GET", "parameters": { "name": { "description": "The name of the operation's parent resource.", "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+$", "required": true }, "pageToken": { "location": "query", "type": "string", "description": "The standard list page token." }, "filter": { "type": "string", "description": "The standard list filter.", "location": "query" }, "returnPartialSuccess": { "type": "boolean", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query" }, "pageSize": { "type": "integer", "location": "query", "format": "int32", "description": "The standard list page size." } }, "response": { "$ref": "GoogleLongrunningListOperationsResponse" } }, "get": { "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/operations/{operationsId}", "path": "v1/{+name}", "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "id": "discoveryengine.projects.locations.dataStores.branches.operations.get", "parameterOrder": [ "name" ], "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+/operations/[^/]+$", "description": "The name of the operation resource.", "location": "path", "required": true, "type": "string" } } } } }, "documents": { "methods": { "delete": { "parameterOrder": [ "name" ], "response": { "$ref": "GoogleProtobufEmpty" }, "id": "discoveryengine.projects.locations.dataStores.branches.documents.delete", "description": "Deletes a Document.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents/{documentsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "httpMethod": "DELETE", "parameters": { "name": { "type": "string", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+/documents/[^/]+$", "description": "Required. Full resource name of Document, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`. If the caller does not have permission to delete the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the Document to delete does not exist, a `NOT_FOUND` error is returned." } }, "path": "v1/{+name}" }, "purge": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents:purge", "path": "v1/{+parent}/documents:purge", "parameters": { "parent": { "required": true, "type": "string", "description": "Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+$" } }, "response": { "$ref": "GoogleLongrunningOperation" }, "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1PurgeDocumentsRequest" }, "id": "discoveryengine.projects.locations.dataStores.branches.documents.purge", "description": "Permanently deletes all selected Documents in a branch. This process is asynchronous. Depending on the number of Documents to be deleted, this operation can take hours to complete. Before the delete operation completes, some Documents might still be returned by DocumentService.GetDocument or DocumentService.ListDocuments. To get a list of the Documents to be deleted, set PurgeDocumentsRequest.force to false." }, "import": { "path": "v1/{+parent}/documents:import", "parameterOrder": [ "parent" ], "id": "discoveryengine.projects.locations.dataStores.branches.documents.import", "request": { "$ref": "GoogleCloudDiscoveryengineV1ImportDocumentsRequest" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents:import", "parameters": { "parent": { "description": "Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. Requires create/update permission.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+$", "location": "path", "type": "string" } }, "httpMethod": "POST", "description": "Bulk import of multiple Documents. Request processing may be synchronous. Non-existing items are created. Note: It is possible for a subset of the Documents to be successfully updated.", "response": { "$ref": "GoogleLongrunningOperation" } }, "get": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents/{documentsId}", "parameters": { "name": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+/documents/[^/]+$", "location": "path", "description": "Required. Full resource name of Document, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`. If the caller does not have permission to access the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the requested Document does not exist, a `NOT_FOUND` error is returned.", "type": "string" } }, "httpMethod": "GET", "response": { "$ref": "GoogleCloudDiscoveryengineV1Document" }, "description": "Gets a Document.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "parameterOrder": [ "name" ], "id": "discoveryengine.projects.locations.dataStores.branches.documents.get", "path": "v1/{+name}" }, "list": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents", "parameters": { "pageSize": { "format": "int32", "description": "Maximum number of Documents to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 are set to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.", "location": "query", "type": "integer" }, "parent": { "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+$", "type": "string", "description": "Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. Use `default_branch` as the branch ID, to list documents under the default branch. If the caller does not have permission to list Documents under this branch, regardless of whether or not this branch exists, a `PERMISSION_DENIED` error is returned." }, "pageToken": { "description": "A page token ListDocumentsResponse.next_page_token, received from a previous DocumentService.ListDocuments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to DocumentService.ListDocuments must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.", "location": "query", "type": "string" } }, "response": { "$ref": "GoogleCloudDiscoveryengineV1ListDocumentsResponse" }, "httpMethod": "GET", "id": "discoveryengine.projects.locations.dataStores.branches.documents.list", "description": "Gets a list of Documents.", "path": "v1/{+parent}/documents", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "parameterOrder": [ "parent" ] }, "patch": { "id": "discoveryengine.projects.locations.dataStores.branches.documents.patch", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents/{documentsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1Document" }, "request": { "$ref": "GoogleCloudDiscoveryengineV1Document" }, "description": "Updates a Document.", "parameters": { "updateMask": { "description": "Indicates which fields in the provided imported 'document' to update. If not set, by default updates all fields.", "location": "query", "format": "google-fieldmask", "type": "string" }, "allowMissing": { "description": "If set to `true` and the Document is not found, a new Document is be created.", "type": "boolean", "location": "query" }, "name": { "type": "string", "location": "path", "required": true, "description": "Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+/documents/[^/]+$" } }, "path": "v1/{+name}", "httpMethod": "PATCH" }, "create": { "description": "Creates a Document.", "response": { "$ref": "GoogleCloudDiscoveryengineV1Document" }, "path": "v1/{+parent}/documents", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents", "id": "discoveryengine.projects.locations.dataStores.branches.documents.create", "parameterOrder": [ "parent" ], "parameters": { "parent": { "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+$", "description": "Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.", "type": "string" }, "documentId": { "location": "query", "type": "string", "description": "Required. The ID to use for the Document, which becomes the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned." } }, "httpMethod": "POST", "request": { "$ref": "GoogleCloudDiscoveryengineV1Document" } } } } } }, "suggestionDenyListEntries": { "methods": { "import": { "id": "discoveryengine.projects.locations.dataStores.suggestionDenyListEntries.import", "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Imports all SuggestionDenyListEntry for a DataStore.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.assist.readwrite", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "parameterOrder": [ "parent" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/suggestionDenyListEntries:import", "httpMethod": "POST", "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", "description": "Required. The parent data store resource name for which to import denylist entries. Follows pattern projects/*/locations/*/collections/*/dataStores/*.", "required": true, "type": "string", "location": "path" } }, "request": { "$ref": "GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesRequest" }, "path": "v1/{+parent}/suggestionDenyListEntries:import" }, "purge": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.assist.readwrite", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesRequest" }, "description": "Permanently deletes all SuggestionDenyListEntry for a DataStore.", "httpMethod": "POST", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/suggestionDenyListEntries:purge", "parameters": { "parent": { "location": "path", "description": "Required. The parent data store resource name for which to import denylist entries. Follows pattern projects/*/locations/*/collections/*/dataStores/*.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/.*$" } }, "path": "v1/{+parent}/suggestionDenyListEntries:purge", "id": "discoveryengine.projects.locations.dataStores.suggestionDenyListEntries.purge", "response": { "$ref": "GoogleLongrunningOperation" } } } }, "sessions": { "methods": { "delete": { "path": "v1/{+name}", "parameterOrder": [ "name" ], "id": "discoveryengine.projects.locations.dataStores.sessions.delete", "description": "Deletes a Session. If the Session to delete does not exist, a NOT_FOUND error is returned.", "response": { "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.assist.readwrite", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "httpMethod": "DELETE", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/sessions/{sessionsId}", "parameters": { "name": { "description": "Required. The resource name of the Session to delete. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/sessions/[^/]+$", "required": true, "location": "path" } } }, "create": { "path": "v1/{+parent}/sessions", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.assist.readwrite", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "id": "discoveryengine.projects.locations.dataStores.sessions.create", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/sessions", "request": { "$ref": "GoogleCloudDiscoveryengineV1Session" }, "description": "Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is returned.", "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", "description": "Required. Full resource name of parent data store. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`", "type": "string", "required": true, "location": "path" }, "sessionId": { "type": "string", "description": "Optional. The ID to use for the session, which will become the final component of the session's resource name. This value should be 1-63 characters, and valid characters are /a-z0-9{0,61}[a-z0-9]/. If not specified, a unique ID will be generated.", "location": "query" } }, "response": { "$ref": "GoogleCloudDiscoveryengineV1Session" }, "httpMethod": "POST", "parameterOrder": [ "parent" ] }, "list": { "parameterOrder": [ "parent" ], "path": "v1/{+parent}/sessions", "httpMethod": "GET", "parameters": { "orderBy": { "location": "query", "description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` * `is_pinned` * `display_name` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time.", "type": "string" }, "pageToken": { "type": "string", "location": "query", "description": "A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page." }, "pageSize": { "format": "int32", "type": "integer", "description": "Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.", "location": "query" }, "filter": { "type": "string", "description": "A comma-separated list of fields to filter by, in EBNF grammar. The supported fields are: * `user_pseudo_id` * `state` * `display_name` * `starred` * `is_pinned` * `labels` * `create_time` * `update_time` * `collaborative_project` Examples: * `user_pseudo_id = some_id` * `display_name = \"some_name\"` * `starred = true` * `is_pinned=true AND (NOT labels:hidden)` * `create_time \u003e \"1970-01-01T12:00:00Z\"` * `collaborative_project = \"projects/123/locations/global/collections/default_collection/engines/\" \"default_engine/collaborative_projects/cp1\"`", "location": "query" }, "parent": { "location": "path", "type": "string", "description": "Required. The data store resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$" } }, "description": "Lists all Sessions by their parent DataStore.", "response": { "$ref": "GoogleCloudDiscoveryengineV1ListSessionsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.assist.readwrite", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "id": "discoveryengine.projects.locations.dataStores.sessions.list", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/sessions" }, "patch": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.assist.readwrite", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "path": "v1/{+name}", "response": { "$ref": "GoogleCloudDiscoveryengineV1Session" }, "request": { "$ref": "GoogleCloudDiscoveryengineV1Session" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/sessions/{sessionsId}", "description": "Updates a Session. Session action type cannot be changed. If the Session to update does not exist, a NOT_FOUND error is returned.", "parameterOrder": [ "name" ], "id": "discoveryengine.projects.locations.dataStores.sessions.patch", "httpMethod": "PATCH", "parameters": { "name": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/sessions/[^/]+$", "location": "path", "description": "Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*`", "type": "string" }, "updateMask": { "format": "google-fieldmask", "type": "string", "location": "query", "description": "Indicates which fields in the provided Session to update. The following are NOT supported: * Session.name If not set or empty, all supported fields are updated." } } }, "get": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.assist.readwrite", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1Session" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/sessions/{sessionsId}", "description": "Gets a Session.", "parameterOrder": [ "name" ], "httpMethod": "GET", "parameters": { "name": { "required": true, "description": "Required. The resource name of the Session to get. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`", "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/sessions/[^/]+$" }, "includeAnswerDetails": { "type": "boolean", "location": "query", "description": "Optional. If set to true, the full session including all answer details will be returned." } }, "path": "v1/{+name}", "id": "discoveryengine.projects.locations.dataStores.sessions.get" } }, "resources": { "answers": { "methods": { "get": { "httpMethod": "GET", "parameterOrder": [ "name" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/sessions/[^/]+/answers/[^/]+$", "description": "Required. The resource name of the Answer to get. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine_id}/sessions/{session_id}/answers/{answer_id}`", "type": "string", "required": true, "location": "path" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "description": "Gets a Answer.", "response": { "$ref": "GoogleCloudDiscoveryengineV1Answer" }, "id": "discoveryengine.projects.locations.dataStores.sessions.answers.get", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/sessions/{sessionsId}/answers/{answersId}", "path": "v1/{+name}" } } } } }, "completionConfig": { "methods": { "completeQuery": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud_search.query", "https://www.googleapis.com/auth/discoveryengine.assist.readwrite", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "parameters": { "completionConfig": { "location": "path", "required": true, "type": "string", "description": "Required. The completion_config of the parent dataStore or engine resource name for which the completion is performed, such as `projects/*/locations/global/collections/default_collection/dataStores/*/completionConfig` `projects/*/locations/global/collections/default_collection/engines/*/completionConfig`.", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/completionConfig$" } }, "httpMethod": "POST", "parameterOrder": [ "completionConfig" ], "path": "v1/{+completionConfig}:completeQuery", "description": "Completes the user input with advanced keyword suggestions.", "id": "discoveryengine.projects.locations.dataStores.completionConfig.completeQuery", "response": { "$ref": "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponse" }, "request": { "$ref": "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequest" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/completionConfig:completeQuery" } } }, "models": { "resources": { "operations": { "methods": { "list": { "path": "v1/{+name}/operations", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "id": "discoveryengine.projects.locations.dataStores.models.operations.list", "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "parameterOrder": [ "name" ], "httpMethod": "GET", "parameters": { "name": { "required": true, "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/models/[^/]+$", "description": "The name of the operation's parent resource." }, "pageToken": { "location": "query", "description": "The standard list page token.", "type": "string" }, "filter": { "description": "The standard list filter.", "type": "string", "location": "query" }, "returnPartialSuccess": { "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" }, "pageSize": { "type": "integer", "location": "query", "description": "The standard list page size.", "format": "int32" } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/models/{modelsId}/operations" }, "get": { "httpMethod": "GET", "parameters": { "name": { "description": "The name of the operation resource.", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/models/[^/]+/operations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "id": "discoveryengine.projects.locations.dataStores.models.operations.get", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/models/{modelsId}/operations/{operationsId}", "path": "v1/{+name}", "response": { "$ref": "GoogleLongrunningOperation" } } } } } }, "conversations": { "methods": { "get": { "parameters": { "name": { "type": "string", "location": "path", "description": "Required. The resource name of the Conversation to get. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/conversations/[^/]+$" } }, "httpMethod": "GET", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/conversations/{conversationsId}", "path": "v1/{+name}", "response": { "$ref": "GoogleCloudDiscoveryengineV1Conversation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "description": "Gets a Conversation.", "id": "discoveryengine.projects.locations.dataStores.conversations.get", "parameterOrder": [ "name" ] }, "patch": { "parameterOrder": [ "name" ], "path": "v1/{+name}", "request": { "$ref": "GoogleCloudDiscoveryengineV1Conversation" }, "id": "discoveryengine.projects.locations.dataStores.conversations.patch", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/conversations/{conversationsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "parameters": { "updateMask": { "type": "string", "description": "Indicates which fields in the provided Conversation to update. The following are NOT supported: * Conversation.name If not set or empty, all supported fields are updated.", "location": "query", "format": "google-fieldmask" }, "name": { "required": true, "description": "Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/dataStore/*/conversations/*` or `projects/{project}/locations/global/collections/{collection}/engines/*/conversations/*`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/conversations/[^/]+$", "type": "string" } }, "httpMethod": "PATCH", "response": { "$ref": "GoogleCloudDiscoveryengineV1Conversation" }, "description": "Updates a Conversation. Conversation action type cannot be changed. If the Conversation to update does not exist, a NOT_FOUND error is returned." }, "delete": { "httpMethod": "DELETE", "parameters": { "name": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/conversations/[^/]+$", "location": "path", "type": "string", "description": "Required. The resource name of the Conversation to delete. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "path": "v1/{+name}", "parameterOrder": [ "name" ], "id": "discoveryengine.projects.locations.dataStores.conversations.delete", "description": "Deletes a Conversation. If the Conversation to delete does not exist, a NOT_FOUND error is returned.", "response": { "$ref": "GoogleProtobufEmpty" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/conversations/{conversationsId}" }, "create": { "description": "Creates a Conversation. If the Conversation to create already exists, an ALREADY_EXISTS error is returned.", "path": "v1/{+parent}/conversations", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/conversations", "request": { "$ref": "GoogleCloudDiscoveryengineV1Conversation" }, "parameters": { "parent": { "location": "path", "description": "Required. Full resource name of parent data store. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$" } }, "parameterOrder": [ "parent" ], "id": "discoveryengine.projects.locations.dataStores.conversations.create", "httpMethod": "POST", "response": { "$ref": "GoogleCloudDiscoveryengineV1Conversation" } }, "converse": { "response": { "$ref": "GoogleCloudDiscoveryengineV1ConverseConversationResponse" }, "path": "v1/{+name}:converse", "description": "Converses a conversation.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/conversations/{conversationsId}:converse", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "httpMethod": "POST", "request": { "$ref": "GoogleCloudDiscoveryengineV1ConverseConversationRequest" }, "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/conversations/[^/]+$", "required": true, "type": "string", "description": "Required. The resource name of the Conversation to get. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`. Use `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session.", "location": "path" } }, "parameterOrder": [ "name" ], "id": "discoveryengine.projects.locations.dataStores.conversations.converse" }, "list": { "parameters": { "parent": { "required": true, "type": "string", "location": "path", "description": "Required. The data store resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$" }, "pageToken": { "location": "query", "type": "string", "description": "A page token, received from a previous `ListConversations` call. Provide this to retrieve the subsequent page." }, "filter": { "description": "A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: \"user_pseudo_id = some_id\"", "location": "query", "type": "string" }, "orderBy": { "description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `update_time` * `create_time` * `conversation_name` Example: \"update_time desc\" \"create_time\"", "location": "query", "type": "string" }, "pageSize": { "location": "query", "format": "int32", "type": "integer", "description": "Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000." } }, "parameterOrder": [ "parent" ], "httpMethod": "GET", "response": { "$ref": "GoogleCloudDiscoveryengineV1ListConversationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "path": "v1/{+parent}/conversations", "description": "Lists all Conversations by their parent DataStore.", "id": "discoveryengine.projects.locations.dataStores.conversations.list", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/conversations" } } }, "schemas": { "methods": { "delete": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/schemas/{schemasId}", "id": "discoveryengine.projects.locations.dataStores.schemas.delete", "path": "v1/{+name}", "description": "Deletes a Schema.", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/schemas/[^/]+$", "location": "path", "required": true, "description": "Required. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`.", "type": "string" } }, "httpMethod": "DELETE", "parameterOrder": [ "name" ] }, "patch": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1Schema" }, "id": "discoveryengine.projects.locations.dataStores.schemas.patch", "parameters": { "allowMissing": { "location": "query", "description": "If set to true, and the Schema is not found, a new Schema is created. In this situation, `update_mask` is ignored.", "type": "boolean" }, "name": { "type": "string", "location": "path", "description": "Immutable. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/schemas/[^/]+$" } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/schemas/{schemasId}", "httpMethod": "PATCH", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Updates a Schema.", "path": "v1/{+name}" }, "create": { "path": "v1/{+parent}/schemas", "parameters": { "parent": { "description": "Required. The parent data store resource name, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", "required": true, "type": "string" }, "schemaId": { "type": "string", "location": "query", "description": "Required. The ID to use for the Schema, which becomes the final component of the Schema.name. This field should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters." } }, "httpMethod": "POST", "request": { "$ref": "GoogleCloudDiscoveryengineV1Schema" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "description": "Creates a Schema.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/schemas", "id": "discoveryengine.projects.locations.dataStores.schemas.create", "response": { "$ref": "GoogleLongrunningOperation" }, "parameterOrder": [ "parent" ] }, "list": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/schemas", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "description": "Gets a list of Schemas.", "id": "discoveryengine.projects.locations.dataStores.schemas.list", "response": { "$ref": "GoogleCloudDiscoveryengineV1ListSchemasResponse" }, "path": "v1/{+parent}/schemas", "parameters": { "pageSize": { "format": "int32", "type": "integer", "description": "The maximum number of Schemas to return. The service may return fewer than this value. If unspecified, at most 100 Schemas are returned. The maximum value is 1000; values above 1000 are set to 1000.", "location": "query" }, "pageToken": { "type": "string", "location": "query", "description": "A page token, received from a previous SchemaService.ListSchemas call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SchemaService.ListSchemas must match the call that provided the page token." }, "parent": { "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", "type": "string", "description": "Required. The parent data store resource name, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`." } }, "httpMethod": "GET", "parameterOrder": [ "parent" ] }, "get": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/schemas/{schemasId}", "description": "Gets a Schema.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1Schema" }, "path": "v1/{+name}", "parameterOrder": [ "name" ], "id": "discoveryengine.projects.locations.dataStores.schemas.get", "parameters": { "name": { "location": "path", "required": true, "description": "Required. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/schemas/[^/]+$" } }, "httpMethod": "GET" } } }, "completionSuggestions": { "methods": { "purge": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.assist.readwrite", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/completionSuggestions:purge", "description": "Permanently deletes all CompletionSuggestions for a DataStore.", "path": "v1/{+parent}/completionSuggestions:purge", "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsRequest" }, "id": "discoveryengine.projects.locations.dataStores.completionSuggestions.purge", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The parent data store resource name for which to purge completion suggestions. Follows pattern projects/*/locations/*/collections/*/dataStores/*.", "type": "string", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$" } } }, "import": { "path": "v1/{+parent}/completionSuggestions:import", "parameters": { "parent": { "description": "Required. The parent data store resource name for which to import customer autocomplete suggestions. Follows pattern `projects/*/locations/*/collections/*/dataStores/*`", "location": "path", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$" } }, "httpMethod": "POST", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/completionSuggestions:import", "response": { "$ref": "GoogleLongrunningOperation" }, "id": "discoveryengine.projects.locations.dataStores.completionSuggestions.import", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.assist.readwrite", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsRequest" }, "description": "Imports CompletionSuggestions for a DataStore.", "parameterOrder": [ "parent" ] } } }, "operations": { "methods": { "get": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/operations/{operationsId}", "response": { "$ref": "GoogleLongrunningOperation" }, "httpMethod": "GET", "id": "discoveryengine.projects.locations.dataStores.operations.get", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/operations/[^/]+$", "required": true, "location": "path", "description": "The name of the operation resource.", "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "parameterOrder": [ "name" ], "path": "v1/{+name}" }, "list": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/operations", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "parameters": { "name": { "location": "path", "description": "The name of the operation's parent resource.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$" }, "filter": { "location": "query", "description": "The standard list filter.", "type": "string" }, "pageSize": { "location": "query", "description": "The standard list page size.", "type": "integer", "format": "int32" }, "returnPartialSuccess": { "location": "query", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "type": "boolean" }, "pageToken": { "type": "string", "location": "query", "description": "The standard list page token." } }, "path": "v1/{+name}/operations", "id": "discoveryengine.projects.locations.dataStores.operations.list", "httpMethod": "GET", "parameterOrder": [ "name" ], "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`." } } }, "userEvents": { "methods": { "import": { "request": { "$ref": "GoogleCloudDiscoveryengineV1ImportUserEventsRequest" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.assist.readwrite", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "description": "Bulk import of user events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully inserted. Operation.metadata is of type ImportMetadata.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/userEvents:import", "parameters": { "parent": { "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", "description": "Required. Parent DataStore resource name, of the form `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`", "type": "string" } }, "path": "v1/{+parent}/userEvents:import", "httpMethod": "POST", "response": { "$ref": "GoogleLongrunningOperation" }, "id": "discoveryengine.projects.locations.dataStores.userEvents.import", "parameterOrder": [ "parent" ] }, "collect": { "id": "discoveryengine.projects.locations.dataStores.userEvents.collect", "response": { "$ref": "GoogleApiHttpBody" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/userEvents:collect", "path": "v1/{+parent}/userEvents:collect", "httpMethod": "GET", "parameters": { "ets": { "location": "query", "description": "The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes.", "format": "int64", "type": "string" }, "parent": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", "description": "Required. The parent resource name. If the collect user event action is applied in DataStore level, the format is: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. If the collect user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project}/locations/{location}`.", "location": "path", "type": "string" }, "userEvent": { "location": "query", "description": "Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters.", "type": "string" }, "uri": { "location": "query", "type": "string", "description": "The URL including cgi-parameters but excluding the hash fragment with a length limit of 5,000 characters. This is often more useful than the referer URL, because many browsers only send the domain for third-party requests." } }, "description": "Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a third-party domain. This method is used only by the Discovery Engine API JavaScript pixel and Google Tag Manager. Users should not call this method directly.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.assist.readwrite", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "parameterOrder": [ "parent" ] }, "write": { "request": { "$ref": "GoogleCloudDiscoveryengineV1UserEvent" }, "path": "v1/{+parent}/userEvents:write", "httpMethod": "POST", "id": "discoveryengine.projects.locations.dataStores.userEvents.write", "parameters": { "writeAsync": { "description": "If set to true, the user event is written asynchronously after validation, and the API responds without waiting for the write.", "type": "boolean", "location": "query" }, "parent": { "description": "Required. The parent resource name. If the write user event action is applied in DataStore level, the format is: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. If the write user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project}/locations/{location}`.", "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", "required": true } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.assist.readwrite", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1UserEvent" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/userEvents:write", "description": "Writes a single user event.", "parameterOrder": [ "parent" ] }, "purge": { "description": "Deletes permanently all user events specified by the filter provided. Depending on the number of events specified by the filter, this operation could take hours or days to complete. To test a filter, use the list command first.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/userEvents:purge", "parameterOrder": [ "parent" ], "parameters": { "parent": { "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", "description": "Required. The resource name of the catalog under which the events are created. The format is `projects/{project}/locations/global/collections/{collection}/dataStores/{dataStore}`.", "required": true } }, "httpMethod": "POST", "request": { "$ref": "GoogleCloudDiscoveryengineV1PurgeUserEventsRequest" }, "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.assist.readwrite", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "path": "v1/{+parent}/userEvents:purge", "id": "discoveryengine.projects.locations.dataStores.userEvents.purge" } } }, "siteSearchEngine": { "methods": { "enableAdvancedSiteSearch": { "httpMethod": "POST", "parameters": { "siteSearchEngine": { "location": "path", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/siteSearchEngine$", "description": "Required. Full resource name of the SiteSearchEngine, such as `projects/{project}/locations/{location}/dataStores/{data_store_id}/siteSearchEngine`." } }, "parameterOrder": [ "siteSearchEngine" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "path": "v1/{+siteSearchEngine}:enableAdvancedSiteSearch", "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Upgrade from basic site search to advanced site search.", "request": { "$ref": "GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchRequest" }, "id": "discoveryengine.projects.locations.dataStores.siteSearchEngine.enableAdvancedSiteSearch", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine:enableAdvancedSiteSearch" }, "disableAdvancedSiteSearch": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "description": "Downgrade from advanced site search to basic site search.", "id": "discoveryengine.projects.locations.dataStores.siteSearchEngine.disableAdvancedSiteSearch", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine:disableAdvancedSiteSearch", "request": { "$ref": "GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchRequest" }, "parameters": { "siteSearchEngine": { "location": "path", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/siteSearchEngine$", "description": "Required. Full resource name of the SiteSearchEngine, such as `projects/{project}/locations/{location}/dataStores/{data_store_id}/siteSearchEngine`." } }, "path": "v1/{+siteSearchEngine}:disableAdvancedSiteSearch", "httpMethod": "POST", "response": { "$ref": "GoogleLongrunningOperation" }, "parameterOrder": [ "siteSearchEngine" ] }, "recrawlUris": { "response": { "$ref": "GoogleLongrunningOperation" }, "id": "discoveryengine.projects.locations.dataStores.siteSearchEngine.recrawlUris", "path": "v1/{+siteSearchEngine}:recrawlUris", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine:recrawlUris", "httpMethod": "POST", "parameterOrder": [ "siteSearchEngine" ], "parameters": { "siteSearchEngine": { "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/siteSearchEngine$", "description": "Required. Full resource name of the SiteSearchEngine, such as `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine`.", "type": "string", "location": "path", "required": true } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1RecrawlUrisRequest" }, "description": "Request on-demand recrawl for a list of URIs." } }, "resources": { "sitemaps": { "methods": { "delete": { "response": { "$ref": "GoogleLongrunningOperation" }, "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "parameters": { "name": { "required": true, "description": "Required. Full resource name of Sitemap, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/sitemaps/{sitemap}`. If the caller does not have permission to access the Sitemap, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested Sitemap does not exist, a NOT_FOUND error is returned.", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/siteSearchEngine/sitemaps/[^/]+$", "location": "path", "type": "string" } }, "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine/sitemaps/{sitemapsId}", "description": "Deletes a Sitemap.", "parameterOrder": [ "name" ], "id": "discoveryengine.projects.locations.dataStores.siteSearchEngine.sitemaps.delete" }, "fetch": { "id": "discoveryengine.projects.locations.dataStores.siteSearchEngine.sitemaps.fetch", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine/sitemaps:fetch", "description": "Fetch Sitemaps in a DataStore.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1FetchSitemapsResponse" }, "path": "v1/{+parent}/sitemaps:fetch", "parameterOrder": [ "parent" ], "parameters": { "matcher.urisMatcher.uris": { "type": "string", "repeated": true, "location": "query", "description": "The Sitemap uris." }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/siteSearchEngine$", "required": true, "type": "string", "location": "path", "description": "Required. Parent resource name of the SiteSearchEngine, such as `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine`." } }, "httpMethod": "GET" }, "create": { "response": { "$ref": "GoogleLongrunningOperation" }, "request": { "$ref": "GoogleCloudDiscoveryengineV1Sitemap" }, "path": "v1/{+parent}/sitemaps", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine/sitemaps", "description": "Creates a Sitemap.", "parameterOrder": [ "parent" ], "id": "discoveryengine.projects.locations.dataStores.siteSearchEngine.sitemaps.create", "parameters": { "parent": { "required": true, "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/siteSearchEngine$", "description": "Required. Parent resource name of the SiteSearchEngine, such as `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine`." } }, "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] } } }, "targetSites": { "methods": { "batchCreate": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "id": "discoveryengine.projects.locations.dataStores.siteSearchEngine.targetSites.batchCreate", "description": "Creates TargetSite in a batch.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine/targetSites:batchCreate", "request": { "$ref": "GoogleCloudDiscoveryengineV1BatchCreateTargetSitesRequest" }, "parameters": { "parent": { "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/siteSearchEngine$", "type": "string", "description": "Required. The parent resource shared by all TargetSites being created. `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`. The parent field in the CreateBookRequest messages must either be empty or match this field." } }, "path": "v1/{+parent}/targetSites:batchCreate", "httpMethod": "POST", "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleLongrunningOperation" } }, "get": { "httpMethod": "GET", "parameters": { "name": { "location": "path", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/siteSearchEngine/targetSites/[^/]+$", "description": "Required. Full resource name of TargetSite, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}`. If the caller does not have permission to access the TargetSite, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested TargetSite does not exist, a NOT_FOUND error is returned." } }, "parameterOrder": [ "name" ], "path": "v1/{+name}", "description": "Gets a TargetSite.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1TargetSite" }, "id": "discoveryengine.projects.locations.dataStores.siteSearchEngine.targetSites.get", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine/targetSites/{targetSitesId}" }, "list": { "parameterOrder": [ "parent" ], "description": "Gets a list of TargetSites.", "response": { "$ref": "GoogleCloudDiscoveryengineV1ListTargetSitesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "id": "discoveryengine.projects.locations.dataStores.siteSearchEngine.targetSites.list", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine/targetSites", "httpMethod": "GET", "path": "v1/{+parent}/targetSites", "parameters": { "pageToken": { "location": "query", "description": "A page token, received from a previous `ListTargetSites` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListTargetSites` must match the call that provided the page token.", "type": "string" }, "parent": { "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/siteSearchEngine$", "type": "string", "description": "Required. The parent site search engine resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`. If the caller does not have permission to list TargetSites under this site search engine, regardless of whether or not this branch exists, a PERMISSION_DENIED error is returned." }, "pageSize": { "type": "integer", "location": "query", "format": "int32", "description": "Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. The maximum value is 1000; values above 1000 will be coerced to 1000. If this field is negative, an INVALID_ARGUMENT error is returned." } } }, "create": { "description": "Creates a TargetSite.", "response": { "$ref": "GoogleLongrunningOperation" }, "httpMethod": "POST", "parameters": { "parent": { "location": "path", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/siteSearchEngine$", "description": "Required. Parent resource name of TargetSite, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`." } }, "request": { "$ref": "GoogleCloudDiscoveryengineV1TargetSite" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine/targetSites", "parameterOrder": [ "parent" ], "path": "v1/{+parent}/targetSites", "id": "discoveryengine.projects.locations.dataStores.siteSearchEngine.targetSites.create", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "delete": { "parameters": { "name": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/siteSearchEngine/targetSites/[^/]+$", "location": "path", "description": "Required. Full resource name of TargetSite, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}`. If the caller does not have permission to access the TargetSite, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested TargetSite does not exist, a NOT_FOUND error is returned.", "type": "string" } }, "httpMethod": "DELETE", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine/targetSites/{targetSitesId}", "path": "v1/{+name}", "id": "discoveryengine.projects.locations.dataStores.siteSearchEngine.targetSites.delete", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "description": "Deletes a TargetSite.", "parameterOrder": [ "name" ] }, "patch": { "description": "Updates a TargetSite.", "parameters": { "name": { "required": true, "location": "path", "type": "string", "description": "Output only. The fully qualified resource name of the target site. `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}` The `target_site_id` is system-generated.", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/siteSearchEngine/targetSites/[^/]+$" } }, "id": "discoveryengine.projects.locations.dataStores.siteSearchEngine.targetSites.patch", "parameterOrder": [ "name" ], "httpMethod": "PATCH", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine/targetSites/{targetSitesId}", "request": { "$ref": "GoogleCloudDiscoveryengineV1TargetSite" }, "path": "v1/{+name}", "response": { "$ref": "GoogleLongrunningOperation" } } } } } } } }, "cmekConfigs": { "methods": { "get": { "parameterOrder": [ "name" ], "id": "discoveryengine.projects.locations.cmekConfigs.get", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/cmekConfigs/{cmekConfigsId}", "path": "v1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1CmekConfig" }, "description": "Gets the CmekConfig.", "httpMethod": "GET", "parameters": { "name": { "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/cmekConfigs/[^/]+$", "description": "Required. Resource name of CmekConfig, such as `projects/*/locations/*/cmekConfig` or `projects/*/locations/*/cmekConfigs/*`. If the caller does not have permission to access the CmekConfig, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.", "type": "string" } } }, "delete": { "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/cmekConfigs/[^/]+$", "required": true, "description": "Required. The resource name of the CmekConfig to delete, such as `projects/{project}/locations/{location}/cmekConfigs/{cmek_config}`.", "type": "string", "location": "path" } }, "httpMethod": "DELETE", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/cmekConfigs/{cmekConfigsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "response": { "$ref": "GoogleLongrunningOperation" }, "path": "v1/{+name}", "description": "De-provisions a CmekConfig.", "parameterOrder": [ "name" ], "id": "discoveryengine.projects.locations.cmekConfigs.delete" }, "patch": { "request": { "$ref": "GoogleCloudDiscoveryengineV1CmekConfig" }, "httpMethod": "PATCH", "parameters": { "setDefault": { "description": "Set the following CmekConfig as the default to be used for child resources if one is not specified.", "type": "boolean", "location": "query" }, "name": { "description": "Required. The name of the CmekConfig of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmek_config}`.", "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/cmekConfigs/[^/]+$", "required": true } }, "id": "discoveryengine.projects.locations.cmekConfigs.patch", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "parameterOrder": [ "name" ], "response": { "$ref": "GoogleLongrunningOperation" }, "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/cmekConfigs/{cmekConfigsId}", "description": "Provisions a CMEK key for use in a location of a customer's project. This method will also conduct location validation on the provided cmekConfig to make sure the key is valid and can be used in the selected location." }, "list": { "id": "discoveryengine.projects.locations.cmekConfigs.list", "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "required": true, "description": "Required. The parent location resource name, such as `projects/{project}/locations/{location}`. If the caller does not have permission to list CmekConfigs under this location, regardless of whether or not a CmekConfig exists, a PERMISSION_DENIED error is returned.", "location": "path" } }, "httpMethod": "GET", "description": "Lists all the CmekConfigs with the project.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/cmekConfigs", "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1ListCmekConfigsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "path": "v1/{+parent}/cmekConfigs" } } } }, "methods": { "setUpDataConnector": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.assist.readwrite", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "parameterOrder": [ "parent" ], "id": "discoveryengine.projects.locations.setUpDataConnector", "request": { "$ref": "GoogleCloudDiscoveryengineV1SetUpDataConnectorRequest" }, "description": "Creates a Collection and sets up the DataConnector for it. To stop a DataConnector after setup, use the CollectionService.DeleteCollection method.", "path": "v1/{+parent}:setUpDataConnector", "httpMethod": "POST", "parameters": { "parent": { "location": "path", "description": "Required. The parent of Collection, in the format of `projects/{project}/locations/{location}`.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string" } }, "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}:setUpDataConnector" }, "getCmekConfig": { "description": "Gets the CmekConfig.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1CmekConfig" }, "httpMethod": "GET", "id": "discoveryengine.projects.locations.getCmekConfig", "parameters": { "name": { "location": "path", "required": true, "description": "Required. Resource name of CmekConfig, such as `projects/*/locations/*/cmekConfig` or `projects/*/locations/*/cmekConfigs/*`. If the caller does not have permission to access the CmekConfig, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/cmekConfig$" } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/cmekConfig", "path": "v1/{+name}" }, "getAclConfig": { "response": { "$ref": "GoogleCloudDiscoveryengineV1AclConfig" }, "parameterOrder": [ "name" ], "description": "Gets the AclConfig.", "id": "discoveryengine.projects.locations.getAclConfig", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/aclConfig", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "httpMethod": "GET", "path": "v1/{+name}", "parameters": { "name": { "type": "string", "description": "Required. Resource name of AclConfig, such as `projects/*/locations/*/aclConfig`. If the caller does not have permission to access the AclConfig, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.", "pattern": "^projects/[^/]+/locations/[^/]+/aclConfig$", "required": true, "location": "path" } } }, "setUpDataConnectorV2": { "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.assist.readwrite", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "parameterOrder": [ "parent" ], "path": "v1/{+parent}:setUpDataConnectorV2", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}:setUpDataConnectorV2", "id": "discoveryengine.projects.locations.setUpDataConnectorV2", "description": "Creates a Collection and sets up the DataConnector for it. To stop a DataConnector after setup, use the CollectionService.DeleteCollection method.", "httpMethod": "POST", "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "required": true, "location": "path", "description": "Required. The parent of Collection, in the format of `projects/{project}/locations/{location}`." }, "collectionDisplayName": { "description": "Required. The display name of the Collection. Should be human readable, used to display collections in the Console Dashboard. UTF-8 encoded string with limit of 1024 characters.", "location": "query", "type": "string" }, "collectionId": { "type": "string", "description": "Required. The ID to use for the Collection, which will become the final component of the Collection's resource name. A new Collection is created as part of the DataConnector setup. DataConnector is a singleton resource under Collection, managing all DataStores of the Collection. Should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", "location": "query" } }, "request": { "$ref": "GoogleCloudDiscoveryengineV1DataConnector" } }, "updateCmekConfig": { "description": "Provisions a CMEK key for use in a location of a customer's project. This method will also conduct location validation on the provided cmekConfig to make sure the key is valid and can be used in the selected location.", "path": "v1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/cmekConfig", "id": "discoveryengine.projects.locations.updateCmekConfig", "httpMethod": "PATCH", "request": { "$ref": "GoogleCloudDiscoveryengineV1CmekConfig" }, "parameters": { "setDefault": { "description": "Set the following CmekConfig as the default to be used for child resources if one is not specified.", "location": "query", "type": "boolean" }, "name": { "pattern": "^projects/[^/]+/locations/[^/]+/cmekConfig$", "type": "string", "required": true, "description": "Required. The name of the CmekConfig of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmek_config}`.", "location": "path" } }, "response": { "$ref": "GoogleLongrunningOperation" }, "parameterOrder": [ "name" ] }, "provision": { "id": "discoveryengine.projects.locations.provision", "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1ProvisionProjectRequest" }, "description": "Provisions the project resource. During the process, related systems will get prepared and initialized. Caller must read the [Terms for data use](https://cloud.google.com/retail/data-use-terms), and optionally specify in request to provide consent to that service terms.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}:provision", "path": "v1/{+name}:provision", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. Full resource name of a Project, such as `projects/{project_id_or_number}`.", "required": true, "type": "string", "location": "path" } }, "httpMethod": "POST", "response": { "$ref": "GoogleLongrunningOperation" } }, "updateAclConfig": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/aclConfig", "description": "Default ACL configuration for use in a location of a customer's project. Updates will only reflect to new data stores. Existing data stores will still use the old value.", "response": { "$ref": "GoogleCloudDiscoveryengineV1AclConfig" }, "id": "discoveryengine.projects.locations.updateAclConfig", "path": "v1/{+name}", "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1AclConfig" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "httpMethod": "PATCH", "parameters": { "name": { "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/aclConfig$", "description": "Immutable. The full resource name of the acl configuration. Format: `projects/{project}/locations/{location}/aclConfig`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", "type": "string" } } } } } }, "methods": { "provision": { "id": "discoveryengine.projects.provision", "description": "Provisions the project resource. During the process, related systems will get prepared and initialized. Caller must read the [Terms for data use](https://cloud.google.com/retail/data-use-terms), and optionally specify in request to provide consent to that service terms.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "parameters": { "name": { "required": true, "pattern": "^projects/[^/]+$", "location": "path", "description": "Required. Full resource name of a Project, such as `projects/{project_id_or_number}`.", "type": "string" } }, "httpMethod": "POST", "flatPath": "v1/projects/{projectsId}:provision", "parameterOrder": [ "name" ], "path": "v1/{+name}:provision", "request": { "$ref": "GoogleCloudDiscoveryengineV1ProvisionProjectRequest" }, "response": { "$ref": "GoogleLongrunningOperation" } } } } }, "rootUrl": "https://discoveryengine.googleapis.com/", "parameters": { "alt": { "description": "Data format for response.", "enum": [ "json", "media", "proto" ], "default": "json", "location": "query", "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ], "type": "string" }, "fields": { "type": "string", "description": "Selector specifying which fields to include in a partial response.", "location": "query" }, "uploadType": { "location": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "type": "string" }, "upload_protocol": { "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "location": "query", "type": "string" }, "callback": { "description": "JSONP", "type": "string", "location": "query" }, "key": { "location": "query", "type": "string", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, "prettyPrint": { "location": "query", "type": "boolean", "default": "true", "description": "Returns response with indentations and line breaks." }, "$.xgafv": { "type": "string", "enumDescriptions": [ "v1 error format", "v2 error format" ], "location": "query", "description": "V1 error format.", "enum": [ "1", "2" ] }, "access_token": { "description": "OAuth access token.", "type": "string", "location": "query" }, "oauth_token": { "description": "OAuth 2.0 token for the current user.", "type": "string", "location": "query" }, "quotaUser": { "location": "query", "type": "string", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." } }, "discoveryVersion": "v1", "ownerName": "Google", "title": "Discovery Engine API", "description": "Discovery Engine API.", "fullyEncodeReservedExpansion": true, "name": "discoveryengine", "batchPath": "batch", "id": "discoveryengine:v1", "documentationLink": "https://cloud.google.com/generative-ai-app-builder/docs/", "basePath": "", "revision": "20260914", "version_module": true, "servicePath": "", "mtlsRootUrl": "https://discoveryengine.mtls.googleapis.com/", "protocol": "rest", "auth": { "oauth2": { "scopes": { "https://www.googleapis.com/auth/cloud_search.query": { "description": "Search your organization's data in the Cloud Search index" }, "https://www.googleapis.com/auth/discoveryengine.assist.readwrite": { "description": "View your Agentspace chat history, including uploaded files and generated reports and visualizations, and interact with the Agentspace assistant on your behalf. Also view the artifacts you access through NotebookLM Enterprise." }, "https://www.googleapis.com/auth/discoveryengine.readwrite": { "description": "View, edit, create, and delete all your data associated with any Discovery Engine API product, such as Agentspace, Vertex AI Search, or NotebookLM Enterprise, including both end user data and administration or configuration data." }, "https://www.googleapis.com/auth/cloud-platform": { "description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." }, "https://www.googleapis.com/auth/discoveryengine.serving.readwrite": { "description": "Interact with Discovery Engine API products, such as Agentspace, Vertex AI Search, or NotebookLM Enterprise, on your behalf. It will also allow the app to view all data that you have access to when you use or interact with a Discovery Engine API product." } } } } }