{ "auth": { "oauth2": { "scopes": { "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/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." }, "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/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." } } } }, "version_module": true, "version": "v1alpha", "ownerDomain": "google.com", "schemas": { "GoogleCloudNotebooklmV1alphaCreateAudioOverviewRequest": { "id": "GoogleCloudNotebooklmV1alphaCreateAudioOverviewRequest", "description": "Request for AudioOverviewService.CreateAudioOverview method.", "type": "object", "properties": { "generationOptions": { "description": "Options for the audio overview generation.", "$ref": "GoogleCloudNotebooklmV1alphaAudioOverviewGenerationOptions" } } }, "GoogleCloudNotebooklmV1alphaAudioOverviewGenerationOptions": { "id": "GoogleCloudNotebooklmV1alphaAudioOverviewGenerationOptions", "description": "Options used during audio overview generation.", "type": "object", "properties": { "episodeFocus": { "description": "What the hosts of the show should focus on.", "type": "string" }, "sourceIds": { "description": "Optional. The sources in which the audio overview is grounded.", "type": "array", "items": { "$ref": "GoogleCloudNotebooklmV1alphaSourceId" } }, "languageCode": { "description": "The language that the audio overview was requested in.", "type": "string" } } }, "GoogleCloudNotebooklmV1alphaSourceId": { "id": "GoogleCloudNotebooklmV1alphaSourceId", "description": "SourceId is the last segment of the source's resource name.", "type": "object", "properties": { "id": { "description": "The id of the source.", "type": "string" } } }, "GoogleCloudNotebooklmV1alphaCreateAudioOverviewResponse": { "id": "GoogleCloudNotebooklmV1alphaCreateAudioOverviewResponse", "description": "Response for AudioOverviewService.CreateAudioOverview method.", "type": "object", "properties": { "audioOverview": { "description": "The generated audio overview.", "$ref": "GoogleCloudNotebooklmV1alphaAudioOverview" } } }, "GoogleCloudNotebooklmV1alphaAudioOverview": { "id": "GoogleCloudNotebooklmV1alphaAudioOverview", "description": "An audio overview of a notebook. This is a summary of the notebook in audio format.", "type": "object", "properties": { "name": { "description": "Identifier. The full resource name of the notebook. Format: `projects/{project}/locations/{location}/notebooks/{notebook}/audioOverviews/{audio_overview_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", "type": "string" }, "audioOverviewId": { "description": "Output only. Unique ID of the audio overview.", "readOnly": true, "type": "string" }, "status": { "description": "The status of the audio overview.", "type": "string", "enumDescriptions": [ "The status has not been set.", "The audio overview has not started being generated.", "The audio overview is in the process of being generated.", "The audio overview has been generated and is available.", "The audio overview failed to be generated." ], "enum": [ "AUDIO_OVERVIEW_STATUS_UNSPECIFIED", "AUDIO_OVERVIEW_STATUS_NOT_STARTED", "AUDIO_OVERVIEW_STATUS_IN_PROGRESS", "AUDIO_OVERVIEW_STATUS_COMPLETE", "AUDIO_OVERVIEW_STATUS_FAILED" ] }, "generationOptions": { "description": "The options used to generate the audio overview.", "$ref": "GoogleCloudNotebooklmV1alphaAudioOverviewGenerationOptions" }, "mimeType": { "description": "The mime type of the audio overview.", "type": "string", "enumDescriptions": [ "The mime type has not been set.", "The mime type is audio/wav.", "The mime type is audio/mp4." ], "enum": [ "MIME_TYPE_UNKNOWN", "MIME_TYPE_WAV", "MIME_TYPE_MP4" ] }, "languageCode": { "description": "The language code of the generated audio overview. Use the BCP 47 language code (e.g. \"en\", \"es\", \"hi\", etc.).", "type": "string" } } }, "GoogleProtobufEmpty": { "id": "GoogleProtobufEmpty", "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); }", "type": "object", "properties": {} }, "GoogleCloudNotebooklmV1alphaNotebook": { "id": "GoogleCloudNotebooklmV1alphaNotebook", "description": "Notebook is a resource where users can store their content (as sources) and interacts with the content.", "type": "object", "properties": { "name": { "description": "Identifier. The identifier of the notebook. Format: `projects/{project}/locations/{location}/notebooks/{notebook_id}`. This field must be a UTF-8 encoded string.", "type": "string" }, "title": { "description": "Optional. The title of the notebook.", "type": "string" }, "sources": { "description": "Output only. List of sources in the notebook. This is an output only field.", "readOnly": true, "type": "array", "items": { "$ref": "GoogleCloudNotebooklmV1alphaSource" } }, "notebookId": { "description": "Output only. Notebook id, which is the last segment of the notebook's resource name.", "readOnly": true, "type": "string" }, "emoji": { "description": "Output only. The emoji of the notebook.", "readOnly": true, "type": "string" }, "metadata": { "description": "Output only. The metadata of the notebook.", "readOnly": true, "$ref": "GoogleCloudNotebooklmV1alphaNotebookMetadata" }, "cmekConfig": { "description": "Output only. CMEK-related information for the Notebook.", "readOnly": true, "$ref": "GoogleCloudNotebooklmV1alphaCmekConfig" } } }, "GoogleCloudNotebooklmV1alphaSource": { "id": "GoogleCloudNotebooklmV1alphaSource", "description": "Source represents a single source of content.", "type": "object", "properties": { "name": { "description": "Identifier. The full resource name of the source. Format: `projects/{project}/locations/{location}/notebooks/{notebook}/sources/{source_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", "type": "string" }, "sourceId": { "description": "Optional. Output only. Source id, which is the last segment of the source's resource name.", "readOnly": true, "$ref": "GoogleCloudNotebooklmV1alphaSourceId" }, "title": { "description": "Optional. Title of the source.", "type": "string" }, "metadata": { "description": "Output only. Metadata about the source.", "readOnly": true, "$ref": "GoogleCloudNotebooklmV1alphaSourceMetadata" }, "settings": { "description": "Output only. Status of the source, and any failure reasons.", "readOnly": true, "$ref": "GoogleCloudNotebooklmV1alphaSourceSettings" } } }, "GoogleCloudNotebooklmV1alphaSourceMetadata": { "id": "GoogleCloudNotebooklmV1alphaSourceMetadata", "description": "Represents the metadata of a source and some additional information.", "type": "object", "properties": { "googleDocsMetadata": { "description": "Metadata for a google doc source.", "$ref": "GoogleCloudNotebooklmV1alphaGoogleDocsSourceMetadata" }, "youtubeMetadata": { "description": "Metadata for a youtube video source.", "$ref": "GoogleCloudNotebooklmV1alphaYoutubeMetadata" }, "agentspaceMetadata": { "description": "Metadata for an agentspace source.", "$ref": "GoogleCloudNotebooklmV1alphaAgentspaceMetadata" }, "wordCount": { "description": "The word count of the source.", "type": "integer", "format": "int32" }, "tokenCount": { "description": "The number of tokens in the source.", "type": "integer", "format": "int32" }, "sourceAddedTimestamp": { "description": "The timestamp the source was added.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudNotebooklmV1alphaGoogleDocsSourceMetadata": { "id": "GoogleCloudNotebooklmV1alphaGoogleDocsSourceMetadata", "description": "Metadata about a google doc source.", "type": "object", "properties": { "documentId": { "description": "Output only. The document id of the google doc.", "readOnly": true, "type": "string" }, "revisionId": { "description": "Output only. Revision id for the doc.", "readOnly": true, "type": "string" } } }, "GoogleCloudNotebooklmV1alphaYoutubeMetadata": { "id": "GoogleCloudNotebooklmV1alphaYoutubeMetadata", "description": "Metadata about a youtube video source.", "type": "object", "properties": { "videoId": { "description": "Output only. The id of the youtube video.", "readOnly": true, "type": "string" }, "channelName": { "description": "Output only. The channel name of the youtube video.", "readOnly": true, "type": "string" } } }, "GoogleCloudNotebooklmV1alphaAgentspaceMetadata": { "id": "GoogleCloudNotebooklmV1alphaAgentspaceMetadata", "description": "Metadata about an agentspace source.", "type": "object", "properties": { "documentName": { "description": "Output only. The full document name in Agentspace.", "readOnly": true, "type": "string" }, "documentTitle": { "description": "Output only. The title of the document.", "readOnly": true, "type": "string" } } }, "GoogleCloudNotebooklmV1alphaSourceSettings": { "id": "GoogleCloudNotebooklmV1alphaSourceSettings", "description": "Allows extension of Source Settings in the BatchCreateSources (Formerly AddSource request).", "type": "object", "properties": { "status": { "description": "Status of the source.", "type": "string", "enumDescriptions": [ "Unspecified status.", "The source is pending addition.", "Source addition is complete and successful.", "Source addition has permanently failed.", "The source is pending deletion.", "The user is attempting to add a source, but we have not yet uploaded it or checked user limits. Does not count towards the user's source limit." ], "enum": [ "SOURCE_STATUS_UNSPECIFIED", "SOURCE_STATUS_PENDING", "SOURCE_STATUS_COMPLETE", "SOURCE_STATUS_ERROR", "SOURCE_STATUS_PENDING_DELETION", "SOURCE_STATUS_TENTATIVE" ] }, "failureReason": { "description": "Failure reason containing details about why a source failed to ingest.", "$ref": "GoogleCloudNotebooklmV1alphaFailureReason" } } }, "GoogleCloudNotebooklmV1alphaFailureReason": { "id": "GoogleCloudNotebooklmV1alphaFailureReason", "description": "Failure reason containing details about why a source failed to ingest.", "type": "object", "properties": { "unknown": { "description": "Indicates an unknown error occurred.", "$ref": "GoogleCloudNotebooklmV1alphaFailureReasonUnknown" }, "sourceTooLong": { "description": "Indicates source word count exceeded the user's limit.", "$ref": "GoogleCloudNotebooklmV1alphaFailureReasonSourceTooLong" }, "ingestionError": { "description": "Indicates an error occurred while ingesting the source.", "$ref": "GoogleCloudNotebooklmV1alphaFailureReasonIngestionError" }, "sourceEmpty": { "description": "Indicates that the source is empty.", "$ref": "GoogleCloudNotebooklmV1alphaFailureReasonSourceEmpty" }, "uploadError": { "description": "Indicates an error occurred while uploading the source.", "$ref": "GoogleCloudNotebooklmV1alphaFailureReasonUploadError" }, "paywallError": { "description": "Indicates that the source is paywalled and cannot be ingested.", "$ref": "GoogleCloudNotebooklmV1alphaFailureReasonPaywallError" }, "sourceUnreachable": { "description": "Indicates that the source is unreachable.", "$ref": "GoogleCloudNotebooklmV1alphaFailureReasonSourceUnreachable" }, "googleDriveError": { "description": "A google drive specific error.", "$ref": "GoogleCloudNotebooklmV1alphaFailureReasonGoogleDriveError" }, "youtubeError": { "description": "A youtube specific error.", "$ref": "GoogleCloudNotebooklmV1alphaFailureReasonYoutubeError" }, "audioTranscriptionError": { "description": "An audio file transcription specific error.", "$ref": "GoogleCloudNotebooklmV1alphaFailureReasonAudioTranscriptionError" }, "sourceLimitExceeded": { "description": "Error if the user tries to update beyond their limits.", "$ref": "GoogleCloudNotebooklmV1alphaFailureReasonSourceLimitExceeded" }, "domainBlocked": { "description": "Error if the user tries to add a source from a blocked domain.", "$ref": "GoogleCloudNotebooklmV1alphaFailureReasonDomainBlocked" }, "mimeTypeBlocked": { "description": "Indicates that the source MIME type is blocked.", "$ref": "GoogleCloudNotebooklmV1alphaFailureReasonMimeTypeBlocked" }, "policyCheckFailed": { "description": "Indicates that the policy check failed.", "$ref": "GoogleCloudNotebooklmV1alphaFailureReasonPolicyCheckFailed" } } }, "GoogleCloudNotebooklmV1alphaFailureReasonUnknown": { "id": "GoogleCloudNotebooklmV1alphaFailureReasonUnknown", "description": "Indicates an unknown error occurred.", "type": "object", "properties": {} }, "GoogleCloudNotebooklmV1alphaFailureReasonSourceTooLong": { "id": "GoogleCloudNotebooklmV1alphaFailureReasonSourceTooLong", "description": "Indicates source word count exceeded the user's limit.", "type": "object", "properties": { "wordCount": { "description": "The number of words in the source.", "type": "integer", "format": "int32" }, "wordLimit": { "description": "The word count limit for the current user at the time of the upload.", "type": "integer", "format": "int32" } } }, "GoogleCloudNotebooklmV1alphaFailureReasonIngestionError": { "id": "GoogleCloudNotebooklmV1alphaFailureReasonIngestionError", "description": "Indicates an error occurred while ingesting the source.", "type": "object", "properties": {} }, "GoogleCloudNotebooklmV1alphaFailureReasonSourceEmpty": { "id": "GoogleCloudNotebooklmV1alphaFailureReasonSourceEmpty", "description": "Indicates that the source is empty.", "type": "object", "properties": {} }, "GoogleCloudNotebooklmV1alphaFailureReasonUploadError": { "id": "GoogleCloudNotebooklmV1alphaFailureReasonUploadError", "description": "Indicates an error occurred while uploading the source.", "type": "object", "properties": {} }, "GoogleCloudNotebooklmV1alphaFailureReasonPaywallError": { "id": "GoogleCloudNotebooklmV1alphaFailureReasonPaywallError", "description": "Indicates that the source is paywalled and cannot be ingested.", "type": "object", "properties": {} }, "GoogleCloudNotebooklmV1alphaFailureReasonSourceUnreachable": { "id": "GoogleCloudNotebooklmV1alphaFailureReasonSourceUnreachable", "description": "Indicates that the source is unreachable. This is primarily used for sources that are added via URL.", "type": "object", "properties": { "errorDetails": { "description": "Describes why the source is unreachable.", "type": "string", "enumDescriptions": [ "Default", "The source URL is invalid.", "The source URL is not accessible.", "The source URL is not reachable.", "The source URL returned 404.", "The source URL not reachable due to a transient network error or host timeout etc.", "The source URL could not be fetched due to an internal error.", "The URL is not yet supported. Examples include: the fetched content exceeds the trawler fetch max size, the fetched content is a type we do not yet support, etc." ], "enum": [ "ERROR_REASON_UNSPECIFIED", "ERROR_REASON_INVALID_URL", "ERROR_REASON_NOT_ACCESSIBLE", "ERROR_REASON_NOT_REACHABLE", "ERROR_REASON_URL_NOT_FOUND", "ERROR_REASON_TRANSIENT_ERROR", "ERROR_REASON_FETCH_FAILED", "ERROR_REASON_NOT_SUPPORTED" ] } } }, "GoogleCloudNotebooklmV1alphaFailureReasonGoogleDriveError": { "id": "GoogleCloudNotebooklmV1alphaFailureReasonGoogleDriveError", "description": "A google drive specific error.", "type": "object", "properties": { "downloadPrevented": { "description": "The user was prevented from downloading the file.", "$ref": "GoogleCloudNotebooklmV1alphaFailureReasonGoogleDriveErrorDownloadPrevented" } } }, "GoogleCloudNotebooklmV1alphaFailureReasonGoogleDriveErrorDownloadPrevented": { "id": "GoogleCloudNotebooklmV1alphaFailureReasonGoogleDriveErrorDownloadPrevented", "description": "The user was prevented from downloading the file.", "type": "object", "properties": {} }, "GoogleCloudNotebooklmV1alphaFailureReasonYoutubeError": { "id": "GoogleCloudNotebooklmV1alphaFailureReasonYoutubeError", "description": "A youtube specific error.", "type": "object", "properties": { "videoDeleted": { "description": "Error to indicate that the source was removed because the video was deleted.", "$ref": "GoogleCloudNotebooklmV1alphaFailureReasonYoutubeErrorVideoDeleted" } } }, "GoogleCloudNotebooklmV1alphaFailureReasonYoutubeErrorVideoDeleted": { "id": "GoogleCloudNotebooklmV1alphaFailureReasonYoutubeErrorVideoDeleted", "description": "Error to indicate that the source was removed because the video was deleted.", "type": "object", "properties": {} }, "GoogleCloudNotebooklmV1alphaFailureReasonAudioTranscriptionError": { "id": "GoogleCloudNotebooklmV1alphaFailureReasonAudioTranscriptionError", "description": "An audio file transcription specific error.", "type": "object", "properties": { "languageDetectionFailed": { "description": "Could not detect language of the file (it may not be speech).", "$ref": "GoogleCloudNotebooklmV1alphaFailureReasonAudioTranscriptionErrorLanguageDetectionFailed" }, "noAudioDetected": { "description": "No audio was detected in the input file (it may have been a video).", "$ref": "GoogleCloudNotebooklmV1alphaFailureReasonAudioTranscriptionErrorNoAudioDetected" } } }, "GoogleCloudNotebooklmV1alphaFailureReasonAudioTranscriptionErrorLanguageDetectionFailed": { "id": "GoogleCloudNotebooklmV1alphaFailureReasonAudioTranscriptionErrorLanguageDetectionFailed", "description": "Could not detect language of the file (it may not be speech).", "type": "object", "properties": {} }, "GoogleCloudNotebooklmV1alphaFailureReasonAudioTranscriptionErrorNoAudioDetected": { "id": "GoogleCloudNotebooklmV1alphaFailureReasonAudioTranscriptionErrorNoAudioDetected", "description": "No audio was detected in the input file.", "type": "object", "properties": {} }, "GoogleCloudNotebooklmV1alphaFailureReasonSourceLimitExceeded": { "id": "GoogleCloudNotebooklmV1alphaFailureReasonSourceLimitExceeded", "description": "Indicates that the user does not have space for this source.", "type": "object", "properties": {} }, "GoogleCloudNotebooklmV1alphaFailureReasonDomainBlocked": { "id": "GoogleCloudNotebooklmV1alphaFailureReasonDomainBlocked", "description": "Error to indicate that the source was removed because the domain was blocked.", "type": "object", "properties": {} }, "GoogleCloudNotebooklmV1alphaFailureReasonMimeTypeBlocked": { "id": "GoogleCloudNotebooklmV1alphaFailureReasonMimeTypeBlocked", "description": "Indicates that the source MIME type is blocked.", "type": "object", "properties": {} }, "GoogleCloudNotebooklmV1alphaFailureReasonPolicyCheckFailed": { "id": "GoogleCloudNotebooklmV1alphaFailureReasonPolicyCheckFailed", "description": "Indicates that the policy check failed.", "type": "object", "properties": {} }, "GoogleCloudNotebooklmV1alphaNotebookMetadata": { "id": "GoogleCloudNotebooklmV1alphaNotebookMetadata", "description": "Metadata for a notebook.", "type": "object", "properties": { "isShared": { "description": "True if this project is currently shared with other people, false otherwise.", "type": "boolean" }, "isShareable": { "description": "True if the project is shareable.", "type": "boolean" }, "lastViewed": { "description": "A timestamp indicating the time that the current in session user has last viewed the project.", "type": "string", "format": "google-datetime" }, "createTime": { "description": "The time at which this project was created.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudNotebooklmV1alphaCmekConfig": { "id": "GoogleCloudNotebooklmV1alphaCmekConfig", "description": "Customer-managed encryption configuration for Notebooks.", "type": "object", "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" } } }, "GoogleCloudNotebooklmV1alphaListRecentlyViewedNotebooksResponse": { "id": "GoogleCloudNotebooklmV1alphaListRecentlyViewedNotebooksResponse", "description": "Response for NotebookService.ListRecentlyViewedNotebooks method.", "type": "object", "properties": { "notebooks": { "description": "The list of recently viewed notebooks.", "type": "array", "items": { "$ref": "GoogleCloudNotebooklmV1alphaNotebook" } }, "nextPageToken": { "description": "The page token, provide this to retrieve the subsequent page.", "type": "string" } } }, "GoogleCloudNotebooklmV1alphaBatchDeleteNotebooksRequest": { "id": "GoogleCloudNotebooklmV1alphaBatchDeleteNotebooksRequest", "description": "Request for NotebookService.BatchDeleteNotebooks method.", "type": "object", "properties": { "names": { "description": "Required. Full resource names of Notebook, such as `projects/{project}/locations/{location}/notebooks/{notebook_id}`.", "type": "array", "items": { "type": "string" } } } }, "GoogleCloudNotebooklmV1alphaShareNotebookRequest": { "id": "GoogleCloudNotebooklmV1alphaShareNotebookRequest", "description": "Request for NotebookService.ShareNotebook method.", "type": "object", "properties": { "accountAndRoles": { "description": "Required. The list of accounts and roles to share the notebook with.", "type": "array", "items": { "$ref": "GoogleCloudNotebooklmV1alphaAccountAndRole" } }, "notifyViaEmail": { "description": "Required. Whether to notify the shared users via email.", "type": "boolean" } } }, "GoogleCloudNotebooklmV1alphaAccountAndRole": { "id": "GoogleCloudNotebooklmV1alphaAccountAndRole", "description": "Account and role information.", "type": "object", "properties": { "email": { "description": "Required. The email address associated with the account.", "type": "string" }, "role": { "description": "Required. The role in the notebook.", "type": "string", "enumDescriptions": [ "Unknown role.", "The user owns the project.", "The user has writer permissions on the project.", "The user has reader permissions on the project.", "The user has no access to the project." ], "enum": [ "PROJECT_ROLE_UNKNOWN", "PROJECT_ROLE_OWNER", "PROJECT_ROLE_WRITER", "PROJECT_ROLE_READER", "PROJECT_ROLE_NOT_SHARED" ] } } }, "GoogleCloudNotebooklmV1alphaShareNotebookResponse": { "id": "GoogleCloudNotebooklmV1alphaShareNotebookResponse", "description": "Response for NotebookService.ShareNotebook method.", "type": "object", "properties": {} }, "GoogleCloudNotebooklmV1alphaBatchCreateSourcesRequest": { "id": "GoogleCloudNotebooklmV1alphaBatchCreateSourcesRequest", "description": "Request for SourceService.BatchCreateSources method.", "type": "object", "properties": { "userContents": { "description": "Required. The UserContents to be uploaded.", "type": "array", "items": { "$ref": "GoogleCloudNotebooklmV1alphaUserContent" } } } }, "GoogleCloudNotebooklmV1alphaUserContent": { "id": "GoogleCloudNotebooklmV1alphaUserContent", "description": "The \"Content\" messages refer to data the user wants to upload.", "type": "object", "properties": { "googleDriveContent": { "description": "The content from Google Drive.", "$ref": "GoogleCloudNotebooklmV1alphaUserContentGoogleDriveContent" }, "textContent": { "description": "The text content uploaded as source.", "$ref": "GoogleCloudNotebooklmV1alphaUserContentTextContent" }, "webContent": { "description": "The web content uploaded as source.", "$ref": "GoogleCloudNotebooklmV1alphaUserContentWebContent" }, "videoContent": { "description": "The video content uploaded as source.", "$ref": "GoogleCloudNotebooklmV1alphaUserContentVideoContent" }, "agentspaceContent": { "description": "Agentspace content uploaded as source.", "$ref": "GoogleCloudNotebooklmV1alphaUserContentAgentspaceContent" } } }, "GoogleCloudNotebooklmV1alphaUserContentGoogleDriveContent": { "id": "GoogleCloudNotebooklmV1alphaUserContentGoogleDriveContent", "description": "The content from Google Drive.", "type": "object", "properties": { "documentId": { "description": "The document id of the selected document.", "type": "string" }, "mimeType": { "description": "The mime type of the selected document. This can be used to differentiate type of content selected in the drive picker. Use application/vnd.google-apps.document for Google Docs or application/vnd.google-apps.presentation for Google Slides.", "type": "string" }, "sourceName": { "description": "The name to be displayed for the source.", "type": "string" } } }, "GoogleCloudNotebooklmV1alphaUserContentTextContent": { "id": "GoogleCloudNotebooklmV1alphaUserContentTextContent", "description": "The text content uploaded as source.", "type": "object", "properties": { "sourceName": { "description": "The display name of the text source.", "type": "string" }, "content": { "description": "The name to be displayed for the source.", "type": "string" } } }, "GoogleCloudNotebooklmV1alphaUserContentWebContent": { "id": "GoogleCloudNotebooklmV1alphaUserContentWebContent", "description": "The web content uploaded as source.", "type": "object", "properties": { "url": { "description": "If URL is supplied, will fetch the webpage in the backend.", "type": "string" }, "sourceName": { "description": "The name to be displayed for the source.", "type": "string" } } }, "GoogleCloudNotebooklmV1alphaUserContentVideoContent": { "id": "GoogleCloudNotebooklmV1alphaUserContentVideoContent", "description": "Video content uploaded as source.", "type": "object", "properties": { "youtubeUrl": { "description": "The youtube url of the video content.", "type": "string" } } }, "GoogleCloudNotebooklmV1alphaUserContentAgentspaceContent": { "id": "GoogleCloudNotebooklmV1alphaUserContentAgentspaceContent", "description": "Agentspace content uploaded as source.", "type": "object", "properties": { "documentName": { "description": "Optional. The full resource name of the Agentspace document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`.", "type": "string" }, "engineName": { "description": "Optional. Engine to verify the permission of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`.", "type": "string" }, "ideaforgeIdeaName": { "description": "Optional. Resource name of the idea forge instance. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/ideaForgeInstances/{instance}`", "type": "string" } } }, "GoogleCloudNotebooklmV1alphaBatchCreateSourcesResponse": { "id": "GoogleCloudNotebooklmV1alphaBatchCreateSourcesResponse", "description": "Response for SourceService.BatchCreateSources method.", "type": "object", "properties": { "sources": { "description": "The Sources.", "type": "array", "items": { "$ref": "GoogleCloudNotebooklmV1alphaSource" } } } }, "GoogleCloudNotebooklmV1alphaBatchDeleteSourcesRequest": { "id": "GoogleCloudNotebooklmV1alphaBatchDeleteSourcesRequest", "description": "Request for BatchDeleteSourcesRequest method.", "type": "object", "properties": { "names": { "description": "Required. Names of sources to be deleted. Format: projects/{project}/locations/{location}/notebooks/{notebook}/sources/{source}", "type": "array", "items": { "type": "string" } } } }, "GoogleCloudDiscoveryengineV1alphaAclConfig": { "id": "GoogleCloudDiscoveryengineV1alphaAclConfig", "description": "Access Control Configuration.", "type": "object", "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" } } }, "GoogleCloudDiscoveryengineV1alphaIdpConfig": { "id": "GoogleCloudDiscoveryengineV1alphaIdpConfig", "description": "Identity Provider Config.", "type": "object", "properties": { "idpType": { "description": "Identity provider type configured.", "type": "string", "enumDescriptions": [ "Default value. ACL search not enabled.", "Google 1P provider.", "Third party provider." ], "enum": [ "IDP_TYPE_UNSPECIFIED", "GSUITE", "THIRD_PARTY" ] }, "externalIdpConfig": { "description": "External Identity provider config.", "$ref": "GoogleCloudDiscoveryengineV1alphaIdpConfigExternalIdpConfig" } } }, "GoogleCloudDiscoveryengineV1alphaIdpConfigExternalIdpConfig": { "id": "GoogleCloudDiscoveryengineV1alphaIdpConfigExternalIdpConfig", "description": "Third party IDP Config.", "type": "object", "properties": { "workforcePoolName": { "description": "Workforce pool name. Example: \"locations/global/workforcePools/pool_id\"", "type": "string" } } }, "GoogleCloudDiscoveryengineV1alphaSearchRequest": { "id": "GoogleCloudDiscoveryengineV1alphaSearchRequest", "description": "Request message for SearchService.Search method.", "type": "object", "properties": { "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" }, "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" }, "query": { "description": "Raw search query.", "type": "string" }, "pageCategories": { "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`", "type": "array", "items": { "type": "string" } }, "imageQuery": { "description": "Raw image query.", "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestImageQuery" }, "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" }, "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" }, "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" }, "oneBoxPageSize": { "description": "The maximum number of results to return for OneBox. This applies to each OneBox type individually. Default number is 10.", "type": "integer", "format": "int32" }, "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.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec" } }, "numResultsPerDataStore": { "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", "format": "int32" }, "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" }, "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" }, "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" }, "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" }, "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" }, "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" }, "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.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpec" } }, "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": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec" }, "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" } }, "queryExpansionSpec": { "description": "The query expansion specification that specifies the conditions under which query expansion occurs.", "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec" }, "spellCorrectionSpec": { "description": "The spell correction specification that specifies the mode under which spell correction takes effect.", "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec" }, "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" }, "useLatestData": { "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.", "type": "boolean" }, "contentSearchSpec": { "description": "A specification for configuring the behavior of content search.", "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec" }, "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": "GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec" }, "rankingExpression": { "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", "type": "string" }, "rankingExpressionBackend": { "description": "Optional. The backend to use for the ranking expression evaluation.", "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" ] }, "safeSearch": { "description": "Whether to turn on safe search. This is only supported for website search.", "type": "boolean" }, "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.", "type": "object", "additionalProperties": { "type": "string" } }, "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" }, "searchAsYouTypeSpec": { "description": "Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical.", "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec" }, "customFineTuningSpec": { "description": "Custom fine tuning configs. If set, it has higher priority than the configs set in ServingConfig.custom_fine_tuning_spec.", "$ref": "GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec" }, "displaySpec": { "description": "Optional. Config for display feature, like match highlighting on search results.", "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestDisplaySpec" }, "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": "GoogleCloudDiscoveryengineV1alphaSearchRequestCrowdingSpec" } }, "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" }, "sessionSpec": { "description": "Session specification. Can be used only when `session` is set.", "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestSessionSpec" }, "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" ] }, "relevanceFilterSpec": { "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.", "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpec" }, "personalizationSpec": { "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.", "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestPersonalizationSpec" }, "relevanceScoreSpec": { "description": "Optional. The specification for returning the relevance score.", "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceScoreSpec" }, "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" }, "customRankingParams": { "description": "Optional. Optional configuration for the Custom Ranking feature.", "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestCustomRankingParams" }, "entity": { "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.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1alphaSearchRequestImageQuery": { "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestImageQuery", "description": "Specifies the image query input.", "type": "object", "properties": { "imageBytes": { "description": "Base64 encoded image bytes. Supported image formats: JPEG, PNG, and BMP.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec": { "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", "properties": { "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" }, "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" }, "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": { "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" } } }, "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec": { "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec", "description": "Boost specification to boost certain documents.", "type": "object", "properties": { "conditionBoostSpecs": { "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": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec" } } } }, "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec": { "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec", "description": "Boost applies to documents which match a condition.", "type": "object", "properties": { "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" }, "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" }, "boostControlSpec": { "description": "Complex specification for custom ranking based on customer defined attribute value.", "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec" } } }, "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec": { "id": "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": { "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).", "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" ] }, "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" ] }, "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.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint" } } } }, "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint": { "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint", "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": { "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": { "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", "format": "float" } } }, "GoogleCloudDiscoveryengineV1alphaUserInfo": { "id": "GoogleCloudDiscoveryengineV1alphaUserInfo", "description": "Information of an end user.", "type": "object", "properties": { "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" }, "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" }, "timeZone": { "description": "Optional. IANA time zone, e.g. Europe/Budapest.", "type": "string" }, "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" } } }, "GoogleCloudDiscoveryengineV1alphaUserInfoPreciseLocation": { "id": "GoogleCloudDiscoveryengineV1alphaUserInfoPreciseLocation", "description": "Precise location info with multiple representation options. Currently only latitude and longitude point is supported.", "type": "object", "properties": { "point": { "description": "Optional. Location represented by a latitude/longitude point.", "$ref": "GoogleTypeLatLng" }, "address": { "description": "Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon.", "type": "string" } } }, "GoogleTypeLatLng": { "id": "GoogleTypeLatLng", "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.", "type": "object", "properties": { "latitude": { "description": "The latitude in degrees. It must be in the range [-90.0, +90.0].", "type": "number", "format": "double" }, "longitude": { "description": "The longitude in degrees. It must be in the range [-180.0, +180.0].", "type": "number", "format": "double" } } }, "GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpec": { "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpec", "description": "A facet specification to perform faceted search.", "type": "object", "properties": { "facetKey": { "description": "Required. The facet key specification.", "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpecFacetKey" }, "limit": { "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", "format": "int32" }, "excludedFilterKeys": { "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", "items": { "type": "string" } }, "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" } } }, "GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpecFacetKey": { "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpecFacetKey", "description": "Specifies how a facet is computed.", "type": "object", "properties": { "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" }, "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": "GoogleCloudDiscoveryengineV1alphaInterval" } }, "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.", "type": "array", "items": { "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" } }, "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.", "type": "array", "items": { "type": "string" } }, "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" } } }, "GoogleCloudDiscoveryengineV1alphaInterval": { "id": "GoogleCloudDiscoveryengineV1alphaInterval", "description": "A floating point interval.", "type": "object", "properties": { "minimum": { "description": "Inclusive lower bound.", "type": "number", "format": "double" }, "exclusiveMinimum": { "description": "Exclusive lower bound.", "type": "number", "format": "double" }, "maximum": { "description": "Inclusive upper bound.", "type": "number", "format": "double" }, "exclusiveMaximum": { "description": "Exclusive upper bound.", "type": "number", "format": "double" } } }, "GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec": { "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec", "description": "Specification to determine under which conditions query expansion should occur.", "type": "object", "properties": { "condition": { "description": "The condition under which query expansion should occur. Default to Condition.DISABLED.", "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." ], "enum": [ "CONDITION_UNSPECIFIED", "DISABLED", "AUTO" ] }, "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" } } }, "GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec": { "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec", "description": "The specification for query spell correction.", "type": "object", "properties": { "mode": { "description": "The mode under which spell correction replaces the original search query. Defaults to Mode.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." ], "enum": [ "MODE_UNSPECIFIED", "SUGGESTION_ONLY", "AUTO" ] } } }, "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec": { "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec", "description": "A specification for configuring the behavior of content search.", "type": "object", "properties": { "snippetSpec": { "description": "If `snippetSpec` is not specified, snippets are not included in the search response.", "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSnippetSpec" }, "summarySpec": { "description": "If `summarySpec` is not specified, summaries are not included in the search response.", "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec" }, "extractiveContentSpec": { "description": "If there is no extractive_content_spec provided, there will be no extractive answer in the search response.", "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec" }, "searchResultMode": { "description": "Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`.", "type": "string", "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" ] }, "chunkSpec": { "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", "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecChunkSpec" } } }, "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSnippetSpec": { "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSnippetSpec", "description": "A specification for configuring snippets in a search response.", "type": "object", "properties": { "maxSnippetCount": { "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, "type": "integer", "format": "int32" }, "referenceOnly": { "description": "[DEPRECATED] This field is deprecated and will have no affect on the snippet.", "deprecated": true, "type": "boolean" }, "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" } } }, "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec": { "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec", "description": "A specification for configuring a summary returned in a search response.", "type": "object", "properties": { "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.", "type": "integer", "format": "int32" }, "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" }, "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" }, "ignoreLowRelevantContent": { "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": "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" }, "multimodalSpec": { "description": "Optional. Multimodal specification.", "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecMultiModalSpec" }, "modelPromptSpec": { "description": "If specified, the spec will be used to modify the prompt provided to the LLM.", "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelPromptSpec" }, "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" }, "modelSpec": { "description": "If specified, the spec will be used to modify the model specification provided to the LLM.", "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec" }, "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" } } }, "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecMultiModalSpec": { "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecMultiModalSpec", "description": "Multimodal specification: Will return an image from specified source. If multiple sources are specified, the pick is a quality based decision.", "type": "object", "properties": { "imageSource": { "description": "Optional. Source of image returned in the answer.", "type": "string", "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." ], "enum": [ "IMAGE_SOURCE_UNSPECIFIED", "ALL_AVAILABLE_SOURCES", "CORPUS_IMAGE_ONLY", "FIGURE_GENERATION_ONLY" ] } } }, "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelPromptSpec": { "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelPromptSpec", "description": "Specification of the prompt to use with the model.", "type": "object", "properties": { "preamble": { "description": "Text at the beginning of the prompt that instructs the assistant. Examples are available in the user guide.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec": { "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec", "description": "Specification of the model.", "type": "object", "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" } } }, "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec": { "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec", "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.", "type": "integer", "format": "int32" }, "maxExtractiveSegmentCount": { "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", "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" }, "numPreviousSegments": { "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", "format": "int32" }, "numNextSegments": { "description": "Return at most `num_next_segments` segments after each selected segments.", "type": "integer", "format": "int32" } } }, "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecChunkSpec": { "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", "type": "object", "properties": { "numPreviousChunks": { "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": "integer", "format": "int32" }, "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.", "type": "integer", "format": "int32" } } }, "GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec": { "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec", "description": "The specification that uses customized query embedding vector to do semantic document retrieval.", "type": "object", "properties": { "embeddingVectors": { "description": "The embedding vector used for retrieval. Limit to 1.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpecEmbeddingVector" } } } }, "GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpecEmbeddingVector": { "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpecEmbeddingVector", "description": "Embedding vector.", "type": "object", "properties": { "fieldPath": { "description": "Embedding field path in schema.", "type": "string" }, "vector": { "description": "Query embedding vector.", "type": "array", "items": { "type": "number", "format": "float" } } } }, "GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec": { "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec", "description": "Specification to enable natural language understanding capabilities for search requests.", "type": "object", "properties": { "filterExtractionCondition": { "description": "The condition under which filter extraction should occur. Server behavior defaults to `DISABLED`.", "type": "string", "enumDescriptions": [ "Server behavior defaults to `DISABLED`.", "Disables NL filter extraction.", "Enables NL filter extraction." ], "enum": [ "CONDITION_UNSPECIFIED", "DISABLED", "ENABLED" ] }, "geoSearchQueryDetectionFieldNames": { "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", "items": { "type": "string" } }, "extractedFilterBehavior": { "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", "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." ], "enum": [ "EXTRACTED_FILTER_BEHAVIOR_UNSPECIFIED", "HARD_FILTER", "SOFT_BOOST" ] }, "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.", "type": "array", "items": { "type": "string" } } } }, "GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec": { "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec", "description": "Specification for search as you type in search requests.", "type": "object", "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" ] } } }, "GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec": { "id": "GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec", "description": "Defines custom fine tuning spec.", "type": "object", "properties": { "enableSearchAdaptor": { "description": "Whether or not to enable and include custom fine tuned search adaptor model.", "type": "boolean" } } }, "GoogleCloudDiscoveryengineV1alphaSearchRequestDisplaySpec": { "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestDisplaySpec", "description": "Specifies features for display, like match highlighting.", "type": "object", "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" ] } } }, "GoogleCloudDiscoveryengineV1alphaSearchRequestCrowdingSpec": { "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestCrowdingSpec", "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.", "type": "object", "properties": { "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" }, "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.", "type": "integer", "format": "int32" }, "mode": { "description": "Mode to use for documents that are crowded away.", "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." ], "enum": [ "MODE_UNSPECIFIED", "DROP_CROWDED_RESULTS", "DEMOTE_CROWDED_RESULTS_TO_END" ] } } }, "GoogleCloudDiscoveryengineV1alphaSearchRequestSessionSpec": { "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestSessionSpec", "description": "Session specification.", "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.", "type": "integer", "format": "int32" } } }, "GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpec": { "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpec", "description": "Relevance filtering specification.", "type": "object", "properties": { "keywordSearchThreshold": { "description": "Optional. Relevance filtering threshold specification for keyword search.", "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec" }, "semanticSearchThreshold": { "description": "Optional. Relevance filtering threshold specification for semantic search.", "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec" } } }, "GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec": { "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec", "description": "Specification for relevance filtering on a specific sub-search.", "type": "object", "properties": { "relevanceThreshold": { "description": "Pre-defined relevance threshold for the sub-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" ] }, "semanticRelevanceThreshold": { "description": "Custom relevance threshold for the sub-search. The value must be in [0.0, 1.0].", "type": "number", "format": "float" } } }, "GoogleCloudDiscoveryengineV1alphaSearchRequestPersonalizationSpec": { "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestPersonalizationSpec", "description": "The specification for personalization.", "type": "object", "properties": { "mode": { "description": "The personalization mode of the search request. Defaults to Mode.AUTO.", "type": "string", "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" ] } } }, "GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceScoreSpec": { "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceScoreSpec", "description": "The specification for returning the document relevance score.", "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" } } }, "GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAddonSpec": { "id": "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.", "type": "object", "properties": { "disableSemanticAddOn": { "description": "Optional. If true, semantic add-on is disabled. Semantic add-on includes embeddings and jetstream.", "type": "boolean" }, "disableKpiPersonalizationAddOn": { "description": "Optional. If true, disables event re-ranking and personalization to optimize KPIs & personalize results.", "type": "boolean" }, "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" } } }, "GoogleCloudDiscoveryengineV1alphaSearchRequestCustomRankingParams": { "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestCustomRankingParams", "description": "Configuration parameters for the Custom Ranking feature.", "type": "object", "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" } } } }, "GoogleCloudDiscoveryengineV1alphaSearchResponse": { "id": "GoogleCloudDiscoveryengineV1alphaSearchResponse", "description": "Response message for SearchService.Search method.", "type": "object", "properties": { "results": { "description": "A list of matched documents. The order represents the ranking.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseSearchResult" } }, "facets": { "description": "Results of facets requested by user.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseFacet" } }, "guidedSearchResult": { "description": "Guided search result.", "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseGuidedSearchResult" }, "totalSize": { "description": "The estimated total count of matched items irrespective of pagination. The count of results returned by pagination may be less than the total_size that matches.", "type": "integer", "format": "int32" }, "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" }, "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" }, "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" }, "correctedQuery": { "description": "Contains the spell corrected query, if found. If the spell correction type is AUTOMATIC, then the search results are based on corrected_query. Otherwise the original query is used for search.", "type": "string" }, "suggestedQuery": { "description": "Corrected query with low confidence, AKA did you mean query. Compared with corrected_query, this field is set when SpellCorrector returned a response, but FPR(full page replacement) is not triggered because the corrction is of low confidence(eg, reversed because there are matches of the original query in document corpus).", "type": "string" }, "summary": { "description": "A summary as part of the search results. This field is only returned if SearchRequest.ContentSearchSpec.summary_spec is set.", "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummary" }, "appliedControls": { "description": "Controls applied as part of the Control service.", "type": "array", "items": { "type": "string" } }, "geoSearchDebugInfo": { "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseGeoSearchDebugInfo" } }, "queryExpansionInfo": { "description": "Query expansion information for the returned results.", "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseQueryExpansionInfo" }, "naturalLanguageQueryUnderstandingInfo": { "description": "Output only. Natural language query understanding information for the returned results.", "readOnly": true, "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfo" }, "sessionInfo": { "description": "Session information. Only set if SearchRequest.session is provided. See its description for more details.", "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseSessionInfo" }, "oneBoxResults": { "description": "A list of One Box results. There can be multiple One Box results of different types.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseOneBoxResult" } }, "searchLinkPromotions": { "description": "Promotions for site search.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaSearchLinkPromotion" } }, "semanticState": { "description": "Output only. Indicates the semantic state of the search response.", "readOnly": true, "type": "string", "enumDescriptions": [ "Default value. Should not be used.", "Semantic search was disabled for this search response.", "Semantic search was enabled for this search response." ], "enum": [ "SEMANTIC_STATE_UNSPECIFIED", "DISABLED", "ENABLED" ] } } }, "GoogleCloudDiscoveryengineV1alphaSearchResponseSearchResult": { "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseSearchResult", "description": "Represents the search results.", "type": "object", "properties": { "id": { "description": "Document.id of the searched Document.", "type": "string" }, "document": { "description": "The document data snippet in the search response. Only fields that are marked as `retrievable` are populated.", "$ref": "GoogleCloudDiscoveryengineV1alphaDocument" }, "chunk": { "description": "The chunk data in the search response if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS.", "$ref": "GoogleCloudDiscoveryengineV1alphaChunk" }, "modelScores": { "description": "Output only. Google provided available scores.", "readOnly": true, "type": "object", "additionalProperties": { "$ref": "GoogleCloudDiscoveryengineV1alphaDoubleList" } }, "rankSignals": { "description": "Optional. A set of ranking signals associated with the result.", "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseSearchResultRankSignals" } } }, "GoogleCloudDiscoveryengineV1alphaDocument": { "id": "GoogleCloudDiscoveryengineV1alphaDocument", "description": "Document captures all raw metadata information of items to be recommended or searched.", "type": "object", "properties": { "structData": { "description": "The structured JSON data for the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "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" }, "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" }, "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" }, "schemaId": { "description": "The identifier of the schema located in the same data store.", "type": "string" }, "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": "GoogleCloudDiscoveryengineV1alphaDocumentContent" }, "parentDocumentId": { "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.", "type": "string" }, "derivedStructData": { "description": "Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document.", "readOnly": true, "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "aclInfo": { "description": "Access control information for the document.", "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentAclInfo" }, "indexTime": { "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", "format": "google-datetime" }, "indexStatus": { "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.", "readOnly": true, "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentIndexStatus" } } }, "GoogleCloudDiscoveryengineV1alphaDocumentContent": { "id": "GoogleCloudDiscoveryengineV1alphaDocumentContent", "description": "Unstructured data linked to this document.", "type": "object", "properties": { "rawBytes": { "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", "format": "byte" }, "uri": { "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.", "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" } } }, "GoogleCloudDiscoveryengineV1alphaDocumentAclInfo": { "id": "GoogleCloudDiscoveryengineV1alphaDocumentAclInfo", "description": "ACL Information of the Document.", "type": "object", "properties": { "readers": { "description": "Readers of the document.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentAclInfoAccessRestriction" } } } }, "GoogleCloudDiscoveryengineV1alphaDocumentAclInfoAccessRestriction": { "id": "GoogleCloudDiscoveryengineV1alphaDocumentAclInfoAccessRestriction", "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\" } ], } ] } }", "type": "object", "properties": { "principals": { "description": "List of principals.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaPrincipal" } }, "idpWide": { "description": "All users within the Identity Provider.", "type": "boolean" } } }, "GoogleCloudDiscoveryengineV1alphaPrincipal": { "id": "GoogleCloudDiscoveryengineV1alphaPrincipal", "description": "Principal identifier of a user or a group.", "type": "object", "properties": { "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": { "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.", "type": "string" }, "externalEntityId": { "description": "For 3P application identities which are not present in the customer identity provider.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1alphaDocumentIndexStatus": { "id": "GoogleCloudDiscoveryengineV1alphaDocumentIndexStatus", "description": "Index status of the document.", "type": "object", "properties": { "indexTime": { "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.", "type": "string", "format": "google-datetime" }, "errorSamples": { "description": "A sample of errors encountered while indexing the document. If this field is populated, the document is not indexed due to errors.", "type": "array", "items": { "$ref": "GoogleRpcStatus" } }, "pendingMessage": { "description": "Immutable. The message indicates the document index is in progress. If this field is populated, the document index is pending.", "type": "string" } } }, "GoogleRpcStatus": { "id": "GoogleRpcStatus", "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).", "type": "object", "properties": { "code": { "description": "The status code, which should be an enum value of google.rpc.Code.", "type": "integer", "format": "int32" }, "message": { "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": "string" }, "details": { "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", "type": "array", "items": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } } } } }, "GoogleCloudDiscoveryengineV1alphaChunk": { "id": "GoogleCloudDiscoveryengineV1alphaChunk", "description": "Chunk captures all raw metadata information of items to be recommended or searched in the chunk mode.", "type": "object", "properties": { "name": { "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.", "type": "string" }, "id": { "description": "Unique chunk ID of the current chunk.", "type": "string" }, "content": { "description": "Content is a string from a document (parsed content).", "type": "string" }, "relevanceScore": { "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.", "readOnly": true, "type": "number", "format": "double" }, "documentMetadata": { "description": "Metadata of the document from the current chunk.", "$ref": "GoogleCloudDiscoveryengineV1alphaChunkDocumentMetadata" }, "derivedStructData": { "description": "Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document.", "readOnly": true, "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "pageSpan": { "description": "Page span of the chunk.", "$ref": "GoogleCloudDiscoveryengineV1alphaChunkPageSpan" }, "chunkMetadata": { "description": "Output only. Metadata of the current chunk.", "readOnly": true, "$ref": "GoogleCloudDiscoveryengineV1alphaChunkChunkMetadata" }, "dataUrls": { "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:,", "readOnly": true, "type": "array", "items": { "type": "string" } }, "annotationContents": { "description": "Output only. Annotation contents if the current chunk contains annotations.", "readOnly": true, "type": "array", "items": { "type": "string" } }, "annotationMetadata": { "description": "Output only. The annotation metadata includes structured content in the current chunk.", "readOnly": true, "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaChunkAnnotationMetadata" } } } }, "GoogleCloudDiscoveryengineV1alphaChunkDocumentMetadata": { "id": "GoogleCloudDiscoveryengineV1alphaChunkDocumentMetadata", "description": "Document metadata contains the information of the document of the current chunk.", "type": "object", "properties": { "uri": { "description": "Uri of the document.", "type": "string" }, "title": { "description": "Title of the document.", "type": "string" }, "mimeType": { "description": "The mime type of the document. https://www.iana.org/assignments/media-types/media-types.xhtml.", "type": "string" }, "structData": { "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", "additionalProperties": { "type": "any", "description": "Properties of the object." } } } }, "GoogleCloudDiscoveryengineV1alphaChunkPageSpan": { "id": "GoogleCloudDiscoveryengineV1alphaChunkPageSpan", "description": "Page span of the chunk.", "type": "object", "properties": { "pageStart": { "description": "The start page of the chunk.", "type": "integer", "format": "int32" }, "pageEnd": { "description": "The end page of the chunk.", "type": "integer", "format": "int32" } } }, "GoogleCloudDiscoveryengineV1alphaChunkChunkMetadata": { "id": "GoogleCloudDiscoveryengineV1alphaChunkChunkMetadata", "description": "Metadata of the current chunk. This field is only populated on SearchService.Search API.", "type": "object", "properties": { "previousChunks": { "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.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaChunk" } }, "nextChunks": { "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.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaChunk" } } } }, "GoogleCloudDiscoveryengineV1alphaChunkAnnotationMetadata": { "id": "GoogleCloudDiscoveryengineV1alphaChunkAnnotationMetadata", "description": "The annotation metadata includes structured content in the current chunk.", "type": "object", "properties": { "structuredContent": { "description": "Output only. The structured content information.", "readOnly": true, "$ref": "GoogleCloudDiscoveryengineV1alphaChunkStructuredContent" }, "imageId": { "description": "Output only. Image id is provided if the structured content is based on an image.", "readOnly": true, "type": "string" } } }, "GoogleCloudDiscoveryengineV1alphaChunkStructuredContent": { "id": "GoogleCloudDiscoveryengineV1alphaChunkStructuredContent", "description": "The structured content information.", "type": "object", "properties": { "structureType": { "description": "Output only. The structure type of the structured content.", "readOnly": true, "type": "string", "enumDescriptions": [ "Default value.", "Shareholder structure.", "Signature structure.", "Checkbox structure." ], "enum": [ "STRUCTURE_TYPE_UNSPECIFIED", "SHAREHOLDER_STRUCTURE", "SIGNATURE_STRUCTURE", "CHECKBOX_STRUCTURE" ] }, "content": { "description": "Output only. The content of the structured content.", "readOnly": true, "type": "string" } } }, "GoogleCloudDiscoveryengineV1alphaDoubleList": { "id": "GoogleCloudDiscoveryengineV1alphaDoubleList", "description": "Double list.", "type": "object", "properties": { "values": { "description": "Double values.", "type": "array", "items": { "type": "number", "format": "double" } } } }, "GoogleCloudDiscoveryengineV1alphaSearchResponseSearchResultRankSignals": { "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseSearchResultRankSignals", "description": "A set of ranking signals.", "type": "object", "properties": { "keywordSimilarityScore": { "description": "Optional. Keyword matching adjustment.", "type": "number", "format": "float" }, "relevanceScore": { "description": "Optional. Semantic relevance adjustment.", "type": "number", "format": "float" }, "semanticSimilarityScore": { "description": "Optional. Semantic similarity adjustment.", "type": "number", "format": "float" }, "pctrRank": { "description": "Optional. Predicted conversion rate adjustment as a rank.", "type": "number", "format": "float" }, "topicalityRank": { "description": "Optional. Topicality adjustment as a rank.", "type": "number", "format": "float" }, "documentAge": { "description": "Optional. Age of the document in hours.", "type": "number", "format": "float" }, "boostingFactor": { "description": "Optional. Combined custom boosts for a doc.", "type": "number", "format": "float" }, "defaultRank": { "description": "Optional. The default rank of the result.", "type": "number", "format": "float" }, "customSignals": { "description": "Optional. A list of custom clearbox signals.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseSearchResultRankSignalsCustomSignal" } }, "precomputedExpressionValues": { "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`.", "type": "array", "items": { "type": "number", "format": "float" } } } }, "GoogleCloudDiscoveryengineV1alphaSearchResponseSearchResultRankSignalsCustomSignal": { "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseSearchResultRankSignalsCustomSignal", "description": "Custom clearbox signal represented by name and value pair.", "type": "object", "properties": { "name": { "description": "Optional. Name of the signal.", "type": "string" }, "value": { "description": "Optional. Float value representing the ranking signal (e.g. 1.25 for BM25).", "type": "number", "format": "float" } } }, "GoogleCloudDiscoveryengineV1alphaSearchResponseFacet": { "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseFacet", "description": "A facet result.", "type": "object", "properties": { "key": { "description": "The key for this facet. For example, `\"colors\"` or `\"price\"`. It matches SearchRequest.FacetSpec.FacetKey.key.", "type": "string" }, "values": { "description": "The facet values for this field.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseFacetFacetValue" } }, "dynamicFacet": { "description": "Whether the facet is dynamically generated.", "type": "boolean" } } }, "GoogleCloudDiscoveryengineV1alphaSearchResponseFacetFacetValue": { "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseFacetFacetValue", "description": "A facet value which contains value names and their count.", "type": "object", "properties": { "value": { "description": "Text value of a facet, such as \"Black\" for facet \"colors\".", "type": "string" }, "interval": { "description": "Interval value for a facet, such as 10, 20) for facet \"price\". It matches [SearchRequest.FacetSpec.FacetKey.intervals.", "$ref": "GoogleCloudDiscoveryengineV1alphaInterval" }, "count": { "description": "Number of items that have this facet value.", "type": "string", "format": "int64" } } }, "GoogleCloudDiscoveryengineV1alphaSearchResponseGuidedSearchResult": { "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseGuidedSearchResult", "description": "Guided search result. The guided search helps user to refine the search results and narrow down to the real needs from a broaded search results.", "type": "object", "properties": { "refinementAttributes": { "description": "A list of ranked refinement attributes.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseGuidedSearchResultRefinementAttribute" } }, "followUpQuestions": { "description": "Suggested follow-up questions.", "type": "array", "items": { "type": "string" } } } }, "GoogleCloudDiscoveryengineV1alphaSearchResponseGuidedSearchResultRefinementAttribute": { "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseGuidedSearchResultRefinementAttribute", "description": "Useful attribute for search result refinements.", "type": "object", "properties": { "attributeKey": { "description": "Attribute key used to refine the results. For example, `\"movie_type\"`.", "type": "string" }, "attributeValue": { "description": "Attribute value used to refine the results. For example, `\"drama\"`.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1alphaSearchResponseSummary": { "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummary", "description": "Summary of the top N search results specified by the summary spec.", "type": "object", "properties": { "summaryText": { "description": "The summary content.", "type": "string" }, "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": { "type": "string", "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" ] } }, "safetyAttributes": { "description": "A collection of Safety Attribute categories and their associated confidence scores.", "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySafetyAttributes" }, "summaryWithMetadata": { "description": "Summary with metadata information.", "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySummaryWithMetadata" } } }, "GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySafetyAttributes": { "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySafetyAttributes", "description": "Safety Attribute categories and their associated confidence scores.", "type": "object", "properties": { "categories": { "description": "The display names of Safety Attribute categories associated with the generated content. Order matches the Scores.", "type": "array", "items": { "type": "string" } }, "scores": { "description": "The confidence scores of the each category, higher value means higher confidence. Order matches the Categories.", "type": "array", "items": { "type": "number", "format": "float" } } } }, "GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySummaryWithMetadata": { "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySummaryWithMetadata", "description": "Summary with metadata information.", "type": "object", "properties": { "summary": { "description": "Summary text with no citation information.", "type": "string" }, "citationMetadata": { "description": "Citation metadata for given summary.", "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitationMetadata" }, "references": { "description": "Document References.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryReference" } }, "blobAttachments": { "description": "Output only. Store multimodal data for answer enhancement.", "readOnly": true, "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryBlobAttachment" } } } }, "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitationMetadata": { "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitationMetadata", "description": "Citation metadata.", "type": "object", "properties": { "citations": { "description": "Citations for segments.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitation" } } } }, "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitation": { "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitation", "description": "Citation info for a segment.", "type": "object", "properties": { "startIndex": { "description": "Index indicates the start of the segment, measured in bytes/unicode.", "type": "string", "format": "int64" }, "endIndex": { "description": "End of the attributed segment, exclusive.", "type": "string", "format": "int64" }, "sources": { "description": "Citation sources for the attributed segment.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitationSource" } } } }, "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitationSource": { "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitationSource", "description": "Citation source.", "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" } } }, "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryReference": { "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryReference", "description": "Document reference.", "type": "object", "properties": { "title": { "description": "Title of the document.", "type": "string" }, "document": { "description": "Required. Document.name of the document. Full resource name of the referenced document, in the format `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.", "type": "string" }, "uri": { "description": "Cloud Storage or HTTP uri for the document.", "type": "string" }, "chunkContents": { "description": "List of cited chunk contents derived from document content.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryReferenceChunkContent" } } } }, "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryReferenceChunkContent": { "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryReferenceChunkContent", "description": "Chunk content.", "type": "object", "properties": { "content": { "description": "Chunk textual content.", "type": "string" }, "pageIdentifier": { "description": "Page identifier.", "type": "string" }, "blobAttachmentIndexes": { "description": "Output only. Stores indexes of blobattachments linked to this chunk.", "readOnly": true, "type": "array", "items": { "type": "string", "format": "int64" } } } }, "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryBlobAttachment": { "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryBlobAttachment", "description": "Stores binarydata attached to text answer, e.g. image, video, audio, etc.", "type": "object", "properties": { "data": { "description": "Output only. The blob data.", "readOnly": true, "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryBlobAttachmentBlob" }, "attributionType": { "description": "Output only. The attribution type of the blob.", "readOnly": true, "type": "string", "enumDescriptions": [ "Unspecified attribution type.", "The attachment data is from the corpus.", "The attachment data is generated by the model through code generation." ], "enum": [ "ATTRIBUTION_TYPE_UNSPECIFIED", "CORPUS", "GENERATED" ] } } }, "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryBlobAttachmentBlob": { "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryBlobAttachmentBlob", "description": "Stores type and data of the blob.", "type": "object", "properties": { "mimeType": { "description": "Output only. The media type (MIME type) of the generated data.", "readOnly": true, "type": "string" }, "data": { "description": "Output only. Raw bytes.", "readOnly": true, "type": "string", "format": "byte" } } }, "GoogleCloudDiscoveryengineV1alphaSearchResponseGeoSearchDebugInfo": { "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseGeoSearchDebugInfo", "description": "Debug information specifically related to forward geocoding issues arising from Geolocation Search.", "type": "object", "properties": { "originalAddressQuery": { "description": "The address from which forward geocoding ingestion produced issues.", "type": "string" }, "errorMessage": { "description": "The error produced.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1alphaSearchResponseQueryExpansionInfo": { "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseQueryExpansionInfo", "description": "Information describing query expansion including whether expansion has occurred.", "type": "object", "properties": { "expandedQuery": { "description": "Bool describing whether query expansion has occurred.", "type": "boolean" }, "pinnedResultCount": { "description": "Number of pinned results. This field will only be set when expansion happens and SearchRequest.QueryExpansionSpec.pin_unexpanded_results is set to true.", "type": "string", "format": "int64" } } }, "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfo": { "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfo", "description": "Information describing what natural language understanding was done on the input query.", "type": "object", "properties": { "extractedFilters": { "description": "The filters that were extracted from the input query.", "type": "string" }, "rewrittenQuery": { "description": "Rewritten input query minus the extracted filters.", "type": "string" }, "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": "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilter" } } }, "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilter": { "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilter", "description": "The filters that were extracted from the input query represented in a structured form.", "type": "object", "properties": { "expression": { "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.", "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterExpression" } } }, "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterExpression": { "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterExpression", "description": "The expression denoting the filter that was extracted from the input query.", "type": "object", "properties": { "stringConstraint": { "description": "String constraint expression.", "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterStringConstraint" }, "numberConstraint": { "description": "Numerical constraint expression.", "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterNumberConstraint" }, "geolocationConstraint": { "description": "Geolocation constraint expression.", "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterGeolocationConstraint" }, "andExpr": { "description": "Logical \"And\" compound operator connecting multiple expressions.", "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterAndExpression" }, "orExpr": { "description": "Logical \"Or\" compound operator connecting multiple expressions.", "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterOrExpression" } } }, "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterStringConstraint": { "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterStringConstraint", "description": "Constraint expression of a string field.", "type": "object", "properties": { "fieldName": { "description": "Name of the string field as defined in the schema.", "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.", "type": "array", "items": { "type": "string" } }, "querySegment": { "description": "Identifies the keywords within the search query that match a filter.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterNumberConstraint": { "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterNumberConstraint", "description": "Constraint expression of a number field. Example: price \u003c 100.", "type": "object", "properties": { "fieldName": { "description": "Name of the numerical field as defined in the schema.", "type": "string" }, "comparison": { "description": "The comparison operation performed between the field value and the value specified in the constraint.", "type": "string", "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." ], "enum": [ "COMPARISON_UNSPECIFIED", "EQUALS", "LESS_THAN_EQUALS", "LESS_THAN", "GREATER_THAN_EQUALS", "GREATER_THAN" ] }, "value": { "description": "The value specified in the numerical constraint.", "type": "number", "format": "double" }, "querySegment": { "description": "Identifies the keywords within the search query that match a filter.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterGeolocationConstraint": { "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterGeolocationConstraint", "description": "Constraint of a geolocation field. Name of the geolocation field as defined in the schema.", "type": "object", "properties": { "fieldName": { "description": "The name of the geolocation field as defined in the schema.", "type": "string" }, "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" }, "latitude": { "description": "The latitude of the geolocation inferred from the input query.", "type": "number", "format": "double" }, "longitude": { "description": "The longitude of the geolocation inferred from the input query.", "type": "number", "format": "double" }, "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" } } }, "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterAndExpression": { "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterAndExpression", "description": "Logical `And` operator.", "type": "object", "properties": { "expressions": { "description": "The expressions that were ANDed together.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterExpression" } } } }, "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterOrExpression": { "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterOrExpression", "description": "Logical `Or` operator.", "type": "object", "properties": { "expressions": { "description": "The expressions that were ORed together.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterExpression" } } } }, "GoogleCloudDiscoveryengineV1alphaSearchResponseSessionInfo": { "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseSessionInfo", "description": "Information about the session.", "type": "object", "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" } } }, "GoogleCloudDiscoveryengineV1alphaSearchResponseOneBoxResult": { "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseOneBoxResult", "description": "OneBoxResult is a holder for all results of specific type that we want to display in UI differently.", "type": "object", "properties": { "oneBoxType": { "description": "The type of One Box result.", "type": "string", "enumDescriptions": [ "Default value. Should not be used.", "One Box result contains people results.", "One Box result contains organization results.", "One Box result contains slack results.", "One Box result contains Knowledge Graph search responses." ], "enum": [ "ONE_BOX_TYPE_UNSPECIFIED", "PEOPLE", "ORGANIZATION", "SLACK", "KNOWLEDGE_GRAPH" ] }, "searchResults": { "description": "The search results for this One Box.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseSearchResult" } } } }, "GoogleCloudDiscoveryengineV1alphaSearchLinkPromotion": { "id": "GoogleCloudDiscoveryengineV1alphaSearchLinkPromotion", "description": "Promotion proto includes uri and other helping information to display the promotion.", "type": "object", "properties": { "title": { "description": "Required. The title of the promotion. Maximum length: 160 characters.", "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" }, "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" }, "description": { "description": "Optional. The Promotion description. Maximum length: 200 characters.", "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" } } }, "GoogleCloudDiscoveryengineV1alphaCheckGroundingRequest": { "id": "GoogleCloudDiscoveryengineV1alphaCheckGroundingRequest", "description": "Request message for GroundedGenerationService.CheckGrounding method.", "type": "object", "properties": { "answerCandidate": { "description": "Answer candidate to check. It can have a maximum length of 4096 tokens.", "type": "string" }, "facts": { "description": "List of facts for the grounding check. We support up to 200 facts.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaGroundingFact" } }, "groundingSpec": { "description": "Configuration of the grounding check.", "$ref": "GoogleCloudDiscoveryengineV1alphaCheckGroundingSpec" }, "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.", "type": "object", "additionalProperties": { "type": "string" } } } }, "GoogleCloudDiscoveryengineV1alphaGroundingFact": { "id": "GoogleCloudDiscoveryengineV1alphaGroundingFact", "description": "Grounding Fact.", "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" } } } }, "GoogleCloudDiscoveryengineV1alphaCheckGroundingSpec": { "id": "GoogleCloudDiscoveryengineV1alphaCheckGroundingSpec", "description": "Specification for the grounding check.", "type": "object", "properties": { "citationThreshold": { "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.", "type": "number", "format": "double" }, "enableClaimLevelScore": { "description": "The control flag that enables claim-level grounding score in the response.", "type": "boolean" } } }, "GoogleCloudDiscoveryengineV1alphaCheckGroundingResponse": { "id": "GoogleCloudDiscoveryengineV1alphaCheckGroundingResponse", "description": "Response message for the GroundedGenerationService.CheckGrounding method.", "type": "object", "properties": { "supportScore": { "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", "format": "float" }, "citedChunks": { "description": "List of facts cited across all claims in the answer candidate. These are derived from the facts supplied in the request.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaFactChunk" } }, "citedFacts": { "description": "List of facts cited across all claims in the answer candidate. These are derived from the facts supplied in the request.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaCheckGroundingResponseCheckGroundingFactChunk" } }, "claims": { "description": "Claim texts and citation info across all claims in the answer candidate.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaCheckGroundingResponseClaim" } } } }, "GoogleCloudDiscoveryengineV1alphaFactChunk": { "id": "GoogleCloudDiscoveryengineV1alphaFactChunk", "description": "Fact Chunk.", "type": "object", "properties": { "chunkText": { "description": "Text content of the fact chunk. Can be at most 10K characters long.", "type": "string" }, "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" }, "index": { "description": "The index of this chunk. Currently, only used for the streaming mode.", "type": "integer", "format": "int32" }, "sourceMetadata": { "description": "More fine-grained information for the source reference.", "type": "object", "additionalProperties": { "type": "string" } }, "uri": { "description": "The URI of the source.", "type": "string" }, "title": { "description": "The title of the source.", "type": "string" }, "domain": { "description": "The domain of the source.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1alphaCheckGroundingResponseCheckGroundingFactChunk": { "id": "GoogleCloudDiscoveryengineV1alphaCheckGroundingResponseCheckGroundingFactChunk", "description": "Fact chunk for grounding check.", "type": "object", "properties": { "chunkText": { "description": "Text content of the fact chunk. Can be at most 10K characters long.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1alphaCheckGroundingResponseClaim": { "id": "GoogleCloudDiscoveryengineV1alphaCheckGroundingResponseClaim", "description": "Text and citation info for a claim in the answer candidate.", "type": "object", "properties": { "startPos": { "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).", "type": "integer", "format": "int32" }, "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" }, "claimText": { "description": "Text for the claim in the answer candidate. Always provided regardless of whether citations or anti-citations are found.", "type": "string" }, "citationIndices": { "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.", "type": "array", "items": { "type": "integer", "format": "int32" } }, "groundingCheckRequired": { "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.", "type": "boolean" }, "score": { "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.", "type": "number", "format": "double" } } }, "GoogleLongrunningListOperationsResponse": { "id": "GoogleLongrunningListOperationsResponse", "description": "The response message for Operations.ListOperations.", "type": "object", "properties": { "operations": { "description": "A list of operations that matches the specified filter in the request.", "type": "array", "items": { "$ref": "GoogleLongrunningOperation" } }, "nextPageToken": { "description": "The standard List next-page token.", "type": "string" }, "unreachable": { "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", "items": { "type": "string" } } } }, "GoogleLongrunningOperation": { "id": "GoogleLongrunningOperation", "description": "This resource represents a long-running operation that is the result of a network API call.", "type": "object", "properties": { "name": { "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": "string" }, "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": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } }, "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" }, "error": { "description": "The error result of the operation in case of failure or cancellation.", "$ref": "GoogleRpcStatus" }, "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": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } } } }, "GoogleLongrunningCancelOperationRequest": { "id": "GoogleLongrunningCancelOperationRequest", "description": "The request message for Operations.CancelOperation.", "type": "object", "properties": {} }, "GoogleCloudDiscoveryengineV1alphaAgent": { "id": "GoogleCloudDiscoveryengineV1alphaAgent", "description": "Performs a predefined, specific task.", "type": "object", "properties": { "adkAgentDefinition": { "description": "Optional. The behavior of the agent is defined as an ADK agent.", "$ref": "GoogleCloudDiscoveryengineV1alphaAdkAgentDefinition" }, "managedAgentDefinition": { "description": "Optional. The behavior of the Google managed agent.", "$ref": "GoogleCloudDiscoveryengineV1alphaManagedAgentDefinition" }, "a2aAgentDefinition": { "description": "Optional. The behavior of the agent is defined as an A2A agent.", "$ref": "GoogleCloudDiscoveryengineV1alphaA2AAgentDefinition" }, "dialogflowAgentDefinition": { "description": "Optional. The behavior of the agent is defined as a Dialogflow agent.", "$ref": "GoogleCloudDiscoveryengineV1alphaDialogflowAgentDefinition" }, "suspensionReason": { "description": "Output only. The reason why the agent was suspended. Only set if the state is SUSPENDED.", "readOnly": true, "type": "string" }, "rejectionReason": { "description": "Output only. The reason why the agent was rejected. Only set if the state is PRIVATE, and got there via rejection.", "readOnly": true, "type": "string" }, "deploymentFailureReason": { "description": "Output only. The reason why the agent deployment failed. Only set if the state is DEPLOYMENT_FAILED.", "readOnly": true, "type": "string" }, "name": { "description": "Identifier. Resource name of the agent. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}`", "type": "string" }, "displayName": { "description": "Required. Display name of the agent. This might be used by an LLM to automatically select an agent to respond to a user query.", "type": "string" }, "description": { "description": "Required. Human-readable description of the agent. This might be used by an LLM to automatically select an agent to respond to a user query.", "type": "string" }, "icon": { "description": "Optional. The icon that represents the agent on the UI.", "$ref": "GoogleCloudDiscoveryengineV1alphaAgentImage" }, "createTime": { "description": "Output only. Timestamp when this Agent was created.", "readOnly": true, "type": "string", "format": "google-datetime" }, "updateTime": { "description": "Output only. Timestamp when this Agent was most recently updated.", "readOnly": true, "type": "string", "format": "google-datetime" }, "authorizationConfig": { "description": "Optional. The authorizations that are required by the agent.", "$ref": "GoogleCloudDiscoveryengineV1alphaAuthorizationConfig" }, "state": { "description": "Output only. The lifecycle state of the agent.", "readOnly": true, "type": "string", "enumDescriptions": [ "The state is unspecified.", "The agent is configured, but no deployment triggered yet.", "The agent is being deployed.", "The agent is available for admins only.", "The agent deployment failed.", "Agent is available only to its creator..", "Agent is available for users who have access.", "Agent is temporarily unavailable, though visible to users who have access.", "Agent is being created." ], "enum": [ "STATE_UNSPECIFIED", "CONFIGURED", "DEPLOYING", "DISABLED", "DEPLOYMENT_FAILED", "PRIVATE", "ENABLED", "SUSPENDED", "CREATING" ] }, "languageCode": { "description": "Optional. The code of the language of the text in the description, display_name and starter_prompts fields.", "type": "string" }, "starterPrompts": { "description": "Optional. The starter prompt suggestions to show the user on the landing page of the agent.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaAgentStarterPrompt" } }, "customPlaceholderText": { "description": "Optional. The custom placeholder text that appears in the text box before the user enters any text.", "type": "string" }, "sharingConfig": { "description": "Optional. The sharing config of the agent.", "$ref": "GoogleCloudDiscoveryengineV1alphaAgentSharingConfig" }, "observabilityConfig": { "description": "Optional. Observability config for the agent.", "$ref": "GoogleCloudDiscoveryengineV1alphaObservabilityConfig" } } }, "GoogleCloudDiscoveryengineV1alphaAdkAgentDefinition": { "id": "GoogleCloudDiscoveryengineV1alphaAdkAgentDefinition", "description": "Stores the definition of an agent that uses ADK and is deployed to Agent Engine (formerly known as Reasoning Engine).", "type": "object", "properties": { "provisionedReasoningEngine": { "description": "Optional. The reasoning engine that the agent is connected to.", "$ref": "GoogleCloudDiscoveryengineV1alphaAdkAgentDefinitionProvisionedReasoningEngine" } } }, "GoogleCloudDiscoveryengineV1alphaAdkAgentDefinitionProvisionedReasoningEngine": { "id": "GoogleCloudDiscoveryengineV1alphaAdkAgentDefinitionProvisionedReasoningEngine", "description": "Keeps track of the reasoning engine that the agent is connected to. This message is not intended to keep track of agent's lifecycle. Instead it is only used to define parameters to connect to the agent that is already deployed to a reasoning engine.", "type": "object", "properties": { "reasoningEngine": { "description": "Required. The reasoning engine that the agent is connected to. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "type": "string" } } }, "GoogleCloudDiscoveryengineV1alphaManagedAgentDefinition": { "id": "GoogleCloudDiscoveryengineV1alphaManagedAgentDefinition", "description": "Stores the definition of a Google managed agent.", "type": "object", "properties": {} }, "GoogleCloudDiscoveryengineV1alphaA2AAgentDefinition": { "id": "GoogleCloudDiscoveryengineV1alphaA2AAgentDefinition", "description": "Stored definition of an agent that uses A2A.", "type": "object", "properties": { "jsonAgentCard": { "description": "Optional. The agent card is a JSON string.", "type": "string" }, "cloudMarketplaceConfig": { "description": "Optional. Configuration specific to agents that are deployed from Cloud Marketplace.", "$ref": "GoogleCloudDiscoveryengineV1alphaA2AAgentDefinitionCloudMarketplaceConfig" } } }, "GoogleCloudDiscoveryengineV1alphaA2AAgentDefinitionCloudMarketplaceConfig": { "id": "GoogleCloudDiscoveryengineV1alphaA2AAgentDefinitionCloudMarketplaceConfig", "description": "Configuration specific to agents that are deployed from Cloud Marketplace.", "type": "object", "properties": { "entitlement": { "description": "Required. The Marketplace Entitlement this agent is associated with. Format: `projects/{project}/entitlements/{entitlement}`.", "type": "string" }, "order": { "description": "Output only. The Marketplace Order this agent belongs to. Format: `billingAccounts/{billing_account}/orders/{order}`", "readOnly": true, "type": "string" } } }, "GoogleCloudDiscoveryengineV1alphaDialogflowAgentDefinition": { "id": "GoogleCloudDiscoveryengineV1alphaDialogflowAgentDefinition", "description": "Stored definition of an agent that uses a Dialogflow agent.", "type": "object", "properties": { "dialogflowAgent": { "description": "Required. Resource name of the underlying Dialogflow Agent. Format: `projects/{project}/locations/{location}/agents/{agent}`", "type": "string" } } }, "GoogleCloudDiscoveryengineV1alphaAgentImage": { "id": "GoogleCloudDiscoveryengineV1alphaAgentImage", "description": "Represents an image.", "type": "object", "properties": { "uri": { "description": "Image URI.", "type": "string" }, "content": { "description": "Base64-encoded image file contents.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1alphaAuthorizationConfig": { "id": "GoogleCloudDiscoveryengineV1alphaAuthorizationConfig", "description": "Describes the authorizations required.", "type": "object", "properties": { "toolAuthorizations": { "description": "Optional. List of required authorizations for agent to access other resources. Auth tokens will be passed to the agent as part of the request body.", "type": "array", "items": { "type": "string" } }, "agentAuthorization": { "description": "Optional. The authorization that is required to invoke the agent. Auth tokens will be passed to the agent as part of the request auth header.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1alphaAgentStarterPrompt": { "id": "GoogleCloudDiscoveryengineV1alphaAgentStarterPrompt", "description": "The starter prompt suggestion to show the user on the landing page of the agent.", "type": "object", "properties": { "text": { "description": "Required. The text of the starter prompt.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1alphaAgentSharingConfig": { "id": "GoogleCloudDiscoveryengineV1alphaAgentSharingConfig", "description": "Sharing related configuration.", "type": "object", "properties": { "scope": { "description": "Optional. The sharing scope of the agent.", "type": "string", "enumDescriptions": [ "Default value. Behaves as `RESTRICTED`.", "The agent is shared based on the IAM policy.", "The agent is shared with all users." ], "enum": [ "SCOPE_UNSPECIFIED", "RESTRICTED", "ALL_USERS" ] } } }, "GoogleCloudDiscoveryengineV1alphaObservabilityConfig": { "id": "GoogleCloudDiscoveryengineV1alphaObservabilityConfig", "description": "Observability config for a resource.", "type": "object", "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" } } }, "GoogleCloudDiscoveryengineV1alphaListAgentsResponse": { "id": "GoogleCloudDiscoveryengineV1alphaListAgentsResponse", "description": "Response message for the AgentService.ListAgents method.", "type": "object", "properties": { "agents": { "description": "The agents visible to the caller under the parent Assistant.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaAgent" } }, "nextPageToken": { "description": "A token that can be sent as ListAgentsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1alphaImportAgentFileRequest": { "id": "GoogleCloudDiscoveryengineV1alphaImportAgentFileRequest", "description": "Request for the AgentService.ImportAgentFile method.", "type": "object", "properties": { "fileName": { "description": "Required. The name of the file.", "type": "string" }, "mimeType": { "description": "Optional. The content type of the file, see https://www.iana.org/assignments/media-types/media-types.xhtml. This field is required when the data source does not provide the content type.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1alphaImportAgentFileResponse": { "id": "GoogleCloudDiscoveryengineV1alphaImportAgentFileResponse", "description": "Response for the AgentService.ImportAgentFile method.", "type": "object", "properties": { "agentFile": { "description": "The imported AgentFile.", "$ref": "GoogleCloudDiscoveryengineV1alphaAgentFile" } } }, "GoogleCloudDiscoveryengineV1alphaAgentFile": { "id": "GoogleCloudDiscoveryengineV1alphaAgentFile", "description": "Describes a file used internally by an agent as a context on each invocation.", "type": "object", "properties": { "name": { "description": "Identifier. The resource name of the file. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}/files/{file}`", "type": "string" }, "fileName": { "description": "Required. The name of the file.", "type": "string" }, "mimeType": { "description": "Immutable. The content type of the file.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1alphaExportMetricsRequest": { "id": "GoogleCloudDiscoveryengineV1alphaExportMetricsRequest", "description": "Request message for the `ExportMetrics` method.", "type": "object", "properties": { "outputConfig": { "description": "Required. The output location of the data.", "$ref": "GoogleCloudDiscoveryengineV1alphaOutputConfig" } } }, "GoogleCloudDiscoveryengineV1alphaOutputConfig": { "id": "GoogleCloudDiscoveryengineV1alphaOutputConfig", "description": "The output configuration setting.", "type": "object", "properties": { "bigqueryDestination": { "description": "The BigQuery location where the output is to be written to.", "$ref": "GoogleCloudDiscoveryengineV1alphaBigQueryDestination" } } }, "GoogleCloudDiscoveryengineV1alphaBigQueryDestination": { "id": "GoogleCloudDiscoveryengineV1alphaBigQueryDestination", "description": "The BigQuery output destination configuration.", "type": "object", "properties": { "datasetId": { "description": "Required. The ID of a BigQuery Dataset.", "type": "string" }, "tableId": { "description": "Required. The table_id of exported BigQuery table.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1alphaAnalyticsConfig": { "id": "GoogleCloudDiscoveryengineV1alphaAnalyticsConfig", "description": "The customer controllable config for Analytics.", "type": "object", "properties": { "name": { "description": "Required. The resource name of the analytics customer config. Format: `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/analytics/config`", "type": "string" }, "userLevelMetricsEnabled": { "description": "Whether user-level metrics are enabled.", "type": "boolean" } } }, "GoogleCloudDiscoveryengineV1alphaStreamAssistRequest": { "id": "GoogleCloudDiscoveryengineV1alphaStreamAssistRequest", "description": "Request for the AssistantService.StreamAssist method.", "type": "object", "properties": { "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": "GoogleCloudDiscoveryengineV1alphaQuery" }, "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": "GoogleCloudDiscoveryengineV1alphaAssistUserMetadata" }, "toolsSpec": { "description": "Optional. Specification of tools that are used to serve the request.", "$ref": "GoogleCloudDiscoveryengineV1alphaStreamAssistRequestToolsSpec" }, "generationSpec": { "description": "Optional. Specification of the generation configuration for the request.", "$ref": "GoogleCloudDiscoveryengineV1alphaStreamAssistRequestGenerationSpec" }, "actionSpec": { "description": "Optional. Specification of actions for the request.", "$ref": "GoogleCloudDiscoveryengineV1alphaStreamAssistRequestActionSpec" } } }, "GoogleCloudDiscoveryengineV1alphaQuery": { "id": "GoogleCloudDiscoveryengineV1alphaQuery", "description": "Defines a user inputed query.", "type": "object", "properties": { "text": { "description": "Plain text.", "type": "string" }, "queryId": { "description": "Output only. Unique Id for the query.", "readOnly": true, "type": "string" }, "createTime": { "description": "Output only. The time at which the server accepted this query.", "readOnly": true, "type": "string", "format": "google-datetime" }, "parts": { "description": "Query content parts.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaQueryPart" } } } }, "GoogleCloudDiscoveryengineV1alphaQueryPart": { "id": "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.", "type": "object", "properties": { "text": { "description": "Text content.", "type": "string" }, "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" }, "personReference": { "description": "Reference to a person.", "$ref": "GoogleCloudDiscoveryengineV1alphaQueryPartPersonReference" }, "driveDocumentReference": { "description": "Reference to a Google Drive document.", "$ref": "GoogleCloudDiscoveryengineV1alphaQueryPartDriveDocumentReference" }, "documentReference": { "description": "Other VAIS Document references.", "$ref": "GoogleCloudDiscoveryengineV1alphaQueryPartDocumentReference" }, "mimeType": { "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.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1alphaQueryPartPersonReference": { "id": "GoogleCloudDiscoveryengineV1alphaQueryPartPersonReference", "description": "Represents a person reference.", "type": "object", "properties": { "documentName": { "description": "The full resource name of the person. Format: `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.", "type": "string" }, "personId": { "description": "The person id of the person.", "type": "string" }, "email": { "description": "The email of the person.", "type": "string" }, "displayName": { "description": "The display name of the person.", "type": "string" }, "displayPhotoUri": { "description": "The display photo url of the person.", "type": "string" }, "destinationUri": { "description": "The destination uri of the person.", "type": "string" }, "fileId": { "description": "Output only. The file id of the person data stored in the session context files.", "readOnly": true, "type": "string" } } }, "GoogleCloudDiscoveryengineV1alphaQueryPartDriveDocumentReference": { "id": "GoogleCloudDiscoveryengineV1alphaQueryPartDriveDocumentReference", "description": "Represents a Google Drive document reference.", "type": "object", "properties": { "driveId": { "description": "The Drive id of the document.", "type": "string" }, "documentName": { "description": "The full resource name of the document. Format: `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.", "type": "string" }, "displayTitle": { "description": "The display title of the reference.", "type": "string" }, "destinationUri": { "description": "The destination uri of the reference.", "type": "string" }, "iconUri": { "description": "The icon uri of the Drive document reference.", "type": "string" }, "fileId": { "description": "Output only. The file id of the Drive document data stored in the session context files.", "readOnly": true, "type": "string" } } }, "GoogleCloudDiscoveryengineV1alphaQueryPartDocumentReference": { "id": "GoogleCloudDiscoveryengineV1alphaQueryPartDocumentReference", "description": "Represents a document reference.", "type": "object", "properties": { "documentName": { "description": "The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`.", "type": "string" }, "displayTitle": { "description": "The display title of the reference.", "type": "string" }, "destinationUri": { "description": "The destination uri of the reference.", "type": "string" }, "iconUri": { "description": "The icon uri of the reference.", "type": "string" }, "fileId": { "description": "Output only. The file id of the document data stored in the session context files.", "readOnly": true, "type": "string" }, "urlForConnector": { "description": "Input only. The url_for_connector of the document returned by Federated Search.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1alphaAssistUserMetadata": { "id": "GoogleCloudDiscoveryengineV1alphaAssistUserMetadata", "description": "User metadata of the request.", "type": "object", "properties": { "timeZone": { "description": "Optional. IANA time zone, e.g. Europe/Budapest.", "type": "string" }, "preferredLanguageCode": { "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.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1alphaStreamAssistRequestToolsSpec": { "id": "GoogleCloudDiscoveryengineV1alphaStreamAssistRequestToolsSpec", "description": "Specification of tools that are used to serve the request.", "type": "object", "properties": { "vertexAiSearchSpec": { "description": "Optional. Specification of the Vertex AI Search tool.", "$ref": "GoogleCloudDiscoveryengineV1alphaStreamAssistRequestToolsSpecVertexAiSearchSpec" }, "webGroundingSpec": { "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.", "$ref": "GoogleCloudDiscoveryengineV1alphaStreamAssistRequestToolsSpecWebGroundingSpec" }, "imageGenerationSpec": { "description": "Optional. Specification of the image generation tool.", "$ref": "GoogleCloudDiscoveryengineV1alphaStreamAssistRequestToolsSpecImageGenerationSpec" }, "videoGenerationSpec": { "description": "Optional. Specification of the video generation tool.", "$ref": "GoogleCloudDiscoveryengineV1alphaStreamAssistRequestToolsSpecVideoGenerationSpec" } } }, "GoogleCloudDiscoveryengineV1alphaStreamAssistRequestToolsSpecVertexAiSearchSpec": { "id": "GoogleCloudDiscoveryengineV1alphaStreamAssistRequestToolsSpecVertexAiSearchSpec", "description": "Specification of the Vertex AI Search tool.", "type": "object", "properties": { "dataStoreSpecs": { "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", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec" } }, "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" } } }, "GoogleCloudDiscoveryengineV1alphaStreamAssistRequestToolsSpecWebGroundingSpec": { "id": "GoogleCloudDiscoveryengineV1alphaStreamAssistRequestToolsSpecWebGroundingSpec", "description": "Specification of the web grounding tool.", "type": "object", "properties": {} }, "GoogleCloudDiscoveryengineV1alphaStreamAssistRequestToolsSpecImageGenerationSpec": { "id": "GoogleCloudDiscoveryengineV1alphaStreamAssistRequestToolsSpecImageGenerationSpec", "description": "Specification of the image generation tool.", "type": "object", "properties": {} }, "GoogleCloudDiscoveryengineV1alphaStreamAssistRequestToolsSpecVideoGenerationSpec": { "id": "GoogleCloudDiscoveryengineV1alphaStreamAssistRequestToolsSpecVideoGenerationSpec", "description": "Specification of the video generation tool.", "type": "object", "properties": {} }, "GoogleCloudDiscoveryengineV1alphaStreamAssistRequestGenerationSpec": { "id": "GoogleCloudDiscoveryengineV1alphaStreamAssistRequestGenerationSpec", "description": "Assistant generation specification for the request. This allows to override the default generation configuration at the engine level.", "type": "object", "properties": { "modelId": { "description": "Optional. The Vertex AI model_id used for the generative model. If not set, the default Assistant model will be used.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1alphaStreamAssistRequestActionSpec": { "id": "GoogleCloudDiscoveryengineV1alphaStreamAssistRequestActionSpec", "description": "Specification of actions for the request.", "type": "object", "properties": { "actionDisabled": { "description": "Optional. If true, actions will not be served for the request. This only works for enterprise edition.", "type": "boolean" } } }, "GoogleCloudDiscoveryengineV1alphaStreamAssistResponse": { "id": "GoogleCloudDiscoveryengineV1alphaStreamAssistResponse", "description": "Response for the AssistantService.StreamAssist method.", "type": "object", "properties": { "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": "GoogleCloudDiscoveryengineV1alphaAssistAnswer" }, "sessionInfo": { "description": "Session information. Only included in the final StreamAssistResponse of the response stream.", "$ref": "GoogleCloudDiscoveryengineV1alphaStreamAssistResponseSessionInfo" }, "assistToken": { "description": "A global unique ID that identifies the current pair of request and stream of responses. Used for feedback and support.", "type": "string" }, "invocationTools": { "description": "The tool names of the tools that were invoked.", "type": "array", "items": { "type": "string" } } } }, "GoogleCloudDiscoveryengineV1alphaAssistAnswer": { "id": "GoogleCloudDiscoveryengineV1alphaAssistAnswer", "description": "AssistAnswer resource, main part of AssistResponse.", "type": "object", "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" }, "state": { "description": "State of the answer generation.", "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" ] }, "replies": { "description": "Replies of the assistant.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaAssistAnswerReply" } }, "assistSkippedReasons": { "description": "Reasons for not answering the assist call.", "type": "array", "items": { "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)." ], "enum": [ "ASSIST_SKIPPED_REASON_UNSPECIFIED", "NON_ASSIST_SEEKING_QUERY_IGNORED", "CUSTOMER_POLICY_VIOLATION" ] } }, "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" } } }, "GoogleCloudDiscoveryengineV1alphaAssistAnswerReply": { "id": "GoogleCloudDiscoveryengineV1alphaAssistAnswerReply", "description": "One part of the multi-part response of the assist call.", "type": "object", "properties": { "groundedContent": { "description": "Possibly grounded response text or media from the assistant.", "$ref": "GoogleCloudDiscoveryengineV1alphaAssistantGroundedContent" }, "replyId": { "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.", "readOnly": true, "type": "string" }, "createTime": { "description": "The time when the reply was created.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudDiscoveryengineV1alphaAssistantGroundedContent": { "id": "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", "properties": { "textGroundingMetadata": { "description": "Metadata for grounding based on text sources.", "$ref": "GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadata" }, "content": { "description": "The content.", "$ref": "GoogleCloudDiscoveryengineV1alphaAssistantContent" }, "citationMetadata": { "description": "Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check", "$ref": "GoogleCloudDiscoveryengineV1alphaCitationMetadata" } } }, "GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadata": { "id": "GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadata", "description": "Grounding details for text sources.", "type": "object", "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.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadataVisualSegment" } }, "references": { "description": "References for the grounded text.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadataReference" } } } }, "GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadataSegment": { "id": "GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadataSegment", "description": "Grounding information for a segment of the text.", "type": "object", "properties": { "startIndex": { "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).", "type": "string", "format": "int64" }, "endIndex": { "description": "End of the segment, exclusive.", "type": "string", "format": "int64" }, "referenceIndices": { "description": "References for the segment.", "type": "array", "items": { "type": "integer", "format": "int32" } }, "groundingScore": { "description": "Score for the segment.", "type": "number", "format": "float" }, "text": { "description": "The text segment itself.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadataVisualSegment": { "id": "GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadataVisualSegment", "description": "Grounding information for a visual segment.", "type": "object", "properties": { "referenceIndices": { "description": "References for the visual segment.", "type": "array", "items": { "type": "integer", "format": "int32" } }, "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" } } }, "GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadataReference": { "id": "GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadataReference", "description": "Referenced content and related document metadata.", "type": "object", "properties": { "content": { "description": "Referenced text content.", "type": "string" }, "codeSnippet": { "description": "Chunk of code snippet from the referenced document.", "type": "string" }, "documentMetadata": { "description": "Document metadata.", "$ref": "GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadataReferenceDocumentMetadata" } } }, "GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadataReferenceDocumentMetadata": { "id": "GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadataReferenceDocumentMetadata", "description": "Document metadata.", "type": "object", "properties": { "language": { "type": "string", "enumDescriptions": [ "", "", "" ], "enum": [ "LANGUAGE_UNSPECIFIED", "PYTHON", "SQL" ] }, "document": { "description": "Document resource name.", "type": "string" }, "uri": { "description": "URI for the document. It may contain a URL that redirects to the actual website.", "type": "string" }, "title": { "description": "Title.", "type": "string" }, "pageIdentifier": { "description": "Page identifier.", "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" }, "mimeType": { "description": "The mime type of the document. https://www.iana.org/assignments/media-types/media-types.xhtml.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1alphaAssistantContent": { "id": "GoogleCloudDiscoveryengineV1alphaAssistantContent", "description": "Multi-modal content.", "type": "object", "properties": { "text": { "description": "Inline text.", "type": "string" }, "inlineData": { "description": "Inline binary data.", "$ref": "GoogleCloudDiscoveryengineV1alphaAssistantContentBlob" }, "file": { "description": "A file, e.g., an audio summary.", "$ref": "GoogleCloudDiscoveryengineV1alphaAssistantContentFile" }, "executableCode": { "description": "Code generated by the model that is meant to be executed.", "$ref": "GoogleCloudDiscoveryengineV1alphaAssistantContentExecutableCode" }, "codeExecutionResult": { "description": "Result of executing an ExecutableCode.", "$ref": "GoogleCloudDiscoveryengineV1alphaAssistantContentCodeExecutionResult" }, "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" } } }, "GoogleCloudDiscoveryengineV1alphaAssistantContentBlob": { "id": "GoogleCloudDiscoveryengineV1alphaAssistantContentBlob", "description": "Inline blob.", "type": "object", "properties": { "mimeType": { "description": "Required. The media type (MIME type) of the generated data.", "type": "string" }, "data": { "description": "Required. Raw bytes.", "type": "string", "format": "byte" } } }, "GoogleCloudDiscoveryengineV1alphaAssistantContentFile": { "id": "GoogleCloudDiscoveryengineV1alphaAssistantContentFile", "description": "A file, e.g., an audio summary.", "type": "object", "properties": { "mimeType": { "description": "Required. The media type (MIME type) of the file.", "type": "string" }, "fileId": { "description": "Required. The file ID.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1alphaAssistantContentExecutableCode": { "id": "GoogleCloudDiscoveryengineV1alphaAssistantContentExecutableCode", "description": "Code generated by the model that is meant to be executed by the model.", "type": "object", "properties": { "code": { "description": "Required. The code content. Currently only supports Python.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1alphaAssistantContentCodeExecutionResult": { "id": "GoogleCloudDiscoveryengineV1alphaAssistantContentCodeExecutionResult", "description": "Result of executing ExecutableCode.", "type": "object", "properties": { "outcome": { "description": "Required. Outcome of the code execution.", "type": "string", "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." ], "enum": [ "OUTCOME_UNSPECIFIED", "OUTCOME_OK", "OUTCOME_FAILED", "OUTCOME_DEADLINE_EXCEEDED" ] }, "output": { "description": "Optional. Contains stdout when code execution is successful, stderr or other description otherwise.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1alphaCitationMetadata": { "id": "GoogleCloudDiscoveryengineV1alphaCitationMetadata", "description": "A collection of source attributions for a piece of content.", "type": "object", "properties": { "citations": { "description": "Output only. List of citations.", "readOnly": true, "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaCitation" } } } }, "GoogleCloudDiscoveryengineV1alphaCitation": { "id": "GoogleCloudDiscoveryengineV1alphaCitation", "description": "Source attributions for content.", "type": "object", "properties": { "startIndex": { "description": "Output only. Start index into the content.", "readOnly": true, "type": "integer", "format": "int32" }, "endIndex": { "description": "Output only. End index into the content.", "readOnly": true, "type": "integer", "format": "int32" }, "uri": { "description": "Output only. Url reference of the attribution.", "readOnly": true, "type": "string" }, "title": { "description": "Output only. Title of the attribution.", "readOnly": true, "type": "string" }, "license": { "description": "Output only. License of the attribution.", "readOnly": true, "type": "string" }, "publicationDate": { "description": "Output only. Publication date of the attribution.", "readOnly": true, "$ref": "GoogleTypeDate" } } }, "GoogleTypeDate": { "id": "GoogleTypeDate", "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", "type": "object", "properties": { "year": { "description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.", "type": "integer", "format": "int32" }, "month": { "description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.", "type": "integer", "format": "int32" }, "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" } } }, "GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResult": { "id": "GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResult", "description": "Customer policy enforcement results. Contains the results of the various policy checks, like the banned phrases or the Model Armor checks.", "type": "object", "properties": { "verdict": { "description": "Final verdict of the customer policy enforcement. If only one policy blocked the processing, the verdict is BLOCK.", "type": "string", "enumDescriptions": [ "Unknown value.", "There was no policy violation.", "Processing was blocked by the customer policy." ], "enum": [ "UNSPECIFIED", "ALLOW", "BLOCK" ] }, "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.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResultPolicyEnforcementResult" } } } }, "GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResultPolicyEnforcementResult": { "id": "GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResultPolicyEnforcementResult", "description": "Customer policy enforcement result for a single policy type.", "type": "object", "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" } } }, "GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResultBannedPhraseEnforcementResult": { "id": "GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResultBannedPhraseEnforcementResult", "description": "Customer policy enforcement result for the banned phrase policy.", "type": "object", "properties": { "bannedPhrases": { "description": "The banned phrases that were found in the query or the answer.", "type": "array", "items": { "type": "string" } } } }, "GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResultModelArmorEnforcementResult": { "id": "GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResultModelArmorEnforcementResult", "description": "Customer policy enforcement result for the Model Armor policy.", "type": "object", "properties": { "modelArmorViolation": { "description": "The Model Armor violation that was found.", "type": "string" }, "error": { "description": "The error returned by Model Armor if the policy enforcement failed for some reason.", "$ref": "GoogleRpcStatus" } } }, "GoogleCloudDiscoveryengineV1alphaStreamAssistResponseSessionInfo": { "id": "GoogleCloudDiscoveryengineV1alphaStreamAssistResponseSessionInfo", "description": "Information about the session.", "type": "object", "properties": { "session": { "description": "Name of the newly generated or continued session. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}`.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1alphaAssistant": { "id": "GoogleCloudDiscoveryengineV1alphaAssistant", "description": "Discovery Engine Assistant resource.", "type": "object", "properties": { "name": { "description": "Immutable. Resource name of the assistant. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}` It must be a UTF-8 encoded string with a length limit of 1024 characters.", "type": "string" }, "displayName": { "description": "Required. The assistant display name. It must be a UTF-8 encoded string with a length limit of 128 characters.", "type": "string" }, "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": { "description": "Optional. Configuration for the generation of the assistant response.", "$ref": "GoogleCloudDiscoveryengineV1alphaAssistantGenerationConfig" }, "webGroundingType": { "description": "Optional. The type of web grounding to use.", "type": "string", "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." ], "enum": [ "WEB_GROUNDING_TYPE_UNSPECIFIED", "WEB_GROUNDING_TYPE_DISABLED", "WEB_GROUNDING_TYPE_GOOGLE_SEARCH", "WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH" ] }, "defaultWebGroundingToggleOff": { "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.", "type": "boolean" }, "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\"),..] }", "type": "object", "additionalProperties": { "$ref": "GoogleCloudDiscoveryengineV1alphaAssistantToolList" } }, "customerPolicy": { "description": "Optional. Customer policy for the assistant.", "$ref": "GoogleCloudDiscoveryengineV1alphaAssistantCustomerPolicy" }, "disableLocationContext": { "description": "Optional. Indicates whether to disable user location context. By default, user location context is enabled.", "type": "boolean" }, "createTime": { "description": "Output only. Represents the time when this Assistant was created.", "readOnly": true, "type": "string", "format": "google-datetime" }, "updateTime": { "description": "Output only. Represents the time when this Assistant was most recently updated.", "readOnly": true, "type": "string", "format": "google-datetime" } } }, "GoogleCloudDiscoveryengineV1alphaAssistantGenerationConfig": { "id": "GoogleCloudDiscoveryengineV1alphaAssistantGenerationConfig", "description": "Configuration for the generation of the assistant response.", "type": "object", "properties": { "defaultModelId": { "description": "Optional. The default model to use for assistant.", "type": "string" }, "allowedModelIds": { "description": "Optional. The list of models that are allowed to be used for assistant.", "type": "array", "items": { "type": "string" } }, "systemInstruction": { "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", "$ref": "GoogleCloudDiscoveryengineV1alphaAssistantGenerationConfigSystemInstruction" }, "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" } } }, "GoogleCloudDiscoveryengineV1alphaAssistantGenerationConfigSystemInstruction": { "id": "GoogleCloudDiscoveryengineV1alphaAssistantGenerationConfigSystemInstruction", "description": "System instruction, also known as the prompt preamble for LLM calls.", "type": "object", "properties": { "additionalSystemInstruction": { "description": "Optional. Additional system instruction that will be added to the default system instruction.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1alphaAssistantToolList": { "id": "GoogleCloudDiscoveryengineV1alphaAssistantToolList", "description": "The enabled tools on a connector", "type": "object", "properties": { "toolInfo": { "description": "The list of tools with corresponding tool information.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaAssistantToolInfo" } } } }, "GoogleCloudDiscoveryengineV1alphaAssistantToolInfo": { "id": "GoogleCloudDiscoveryengineV1alphaAssistantToolInfo", "description": "Information to identify a tool.", "type": "object", "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": { "description": "The display name of the tool.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1alphaAssistantCustomerPolicy": { "id": "GoogleCloudDiscoveryengineV1alphaAssistantCustomerPolicy", "description": "Customer-defined policy for the assistant.", "type": "object", "properties": { "bannedPhrases": { "description": "Optional. List of banned phrases.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaAssistantCustomerPolicyBannedPhrase" } }, "modelArmorConfig": { "description": "Optional. Model Armor configuration to be used for sanitizing user prompts and assistant responses.", "$ref": "GoogleCloudDiscoveryengineV1alphaAssistantCustomerPolicyModelArmorConfig" } } }, "GoogleCloudDiscoveryengineV1alphaAssistantCustomerPolicyBannedPhrase": { "id": "GoogleCloudDiscoveryengineV1alphaAssistantCustomerPolicyBannedPhrase", "description": "Definition of a customer-defined banned phrase. A banned phrase is not allowed to appear in the user query or the LLM response, or else the answer will be refused.", "type": "object", "properties": { "phrase": { "description": "Required. The raw string content to be banned.", "type": "string" }, "matchType": { "description": "Optional. Match type for the banned phrase.", "type": "string", "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." ], "enum": [ "BANNED_PHRASE_MATCH_TYPE_UNSPECIFIED", "SIMPLE_STRING_MATCH", "WORD_BOUNDARY_STRING_MATCH" ] }, "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" } } }, "GoogleCloudDiscoveryengineV1alphaAssistantCustomerPolicyModelArmorConfig": { "id": "GoogleCloudDiscoveryengineV1alphaAssistantCustomerPolicyModelArmorConfig", "description": "Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and assistant responses.", "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": { "description": "Optional. Defines the failure mode for Model Armor sanitization.", "type": "string", "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." ], "enum": [ "FAILURE_MODE_UNSPECIFIED", "FAIL_OPEN", "FAIL_CLOSED" ] } } }, "GoogleCloudDiscoveryengineV1alphaListAssistantsResponse": { "id": "GoogleCloudDiscoveryengineV1alphaListAssistantsResponse", "description": "Response message for the AssistantService.ListAssistants method.", "type": "object", "properties": { "assistants": { "description": "All the customer's Assistants.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaAssistant" } }, "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" } } }, "GoogleCloudDiscoveryengineV1alphaAuthorization": { "id": "GoogleCloudDiscoveryengineV1alphaAuthorization", "description": "Discovery Engine Authorization resource.", "type": "object", "properties": { "serverSideOauth2": { "description": "Server-side OAuth2 configuration.", "$ref": "GoogleCloudDiscoveryengineV1alphaAuthorizationServerSideOAuth2" }, "name": { "description": "Identifier. Resource name of the authorization. Format: `projects/{project}/locations/{location}/authorizations/{authorization}` It must be a UTF-8 encoded string with a length limit of 1024 characters.", "type": "string" }, "displayName": { "description": "Required. The display name of the authorization. It must be a UTF-8 encoded string with a length limit of 128 characters.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1alphaAuthorizationServerSideOAuth2": { "id": "GoogleCloudDiscoveryengineV1alphaAuthorizationServerSideOAuth2", "description": "OAuth2 configuration.", "type": "object", "properties": { "clientId": { "description": "Required. The OAuth2 client ID.", "type": "string" }, "clientSecret": { "description": "Required. The OAuth2 client secret. Encrypted at rest.", "type": "string" }, "tokenUri": { "description": "Required. The HTTP endpoint that exchanges a client authorization for an access token.", "type": "string" }, "authorizationUri": { "description": "Required. The URI the user is directed to when they need to authorize. Should include everything required for a successful authorization: OAuth ID, extra flags, etc. Example: `https://accounts.google.com/o/oauth2/v2/auth?client_id=OAUTH_ID&scope=https://www.googleapis.com/auth/calendar.events&response_type=code&access_type=offline&prompt=consent` The `redirect_uri` parameter will be overwritten by the Vertex AI Search frontend.", "type": "string" }, "scopes": { "description": "Optional. The scopes to request. Example: `https://www.googleapis.com/auth/calendar.events` If omitted, no additional scopes are requested beyond those required by the authorization uri. If set, it will overwrite the scopes in the authorization uri when acquiring user authorization.", "type": "array", "items": { "type": "string" } }, "pkceVerificationEnabled": { "description": "Optional. Whether to enable PKCE verification. https://datatracker.ietf.org/doc/html/rfc7636#section-3.1/", "type": "boolean" } } }, "GoogleCloudDiscoveryengineV1alphaListAuthorizationsResponse": { "id": "GoogleCloudDiscoveryengineV1alphaListAuthorizationsResponse", "description": "Response message for the AuthorizationService.ListAuthorizations method.", "type": "object", "properties": { "authorizations": { "description": "All the customer's Authorizations.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaAuthorization" } }, "nextPageToken": { "description": "A token that can be sent as ListAuthorizationsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1alphaListBranchesResponse": { "id": "GoogleCloudDiscoveryengineV1alphaListBranchesResponse", "description": "Response for BranchService.ListBranches method.", "type": "object", "properties": { "branches": { "description": "The Branches.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaBranch" } } } }, "GoogleCloudDiscoveryengineV1alphaBranch": { "id": "GoogleCloudDiscoveryengineV1alphaBranch", "description": "A data branch that stores Documents.", "type": "object", "properties": { "name": { "description": "Immutable. Full resource name of the branch, such as `projects/*/locations/global/dataStores/data_store/branches/branch_id`.", "type": "string" }, "displayName": { "description": "Output only. Human readable name of the branch to display in the UI.", "readOnly": true, "type": "string" }, "isDefault": { "description": "Output only. Indicates whether this branch is set as the default branch of its parent data store.", "readOnly": true, "type": "boolean" }, "lastDocumentImportTime": { "description": "Output only. Timestamp of last import through DocumentService.ImportDocuments. Empty value means no import has been made to this branch.", "readOnly": true, "type": "string", "format": "google-datetime" }, "branchStats": { "description": "Output only. Statistics describing a branch. This field is not populated in BranchView.BRANCH_VIEW_BASIC view.", "readOnly": true, "$ref": "GoogleCloudDiscoveryengineV1alphaBranchBranchStats" } } }, "GoogleCloudDiscoveryengineV1alphaBranchBranchStats": { "id": "GoogleCloudDiscoveryengineV1alphaBranchBranchStats", "description": "Statistics describing a branch.", "type": "object", "properties": { "documentCounts": { "description": "The number of documents in a given branch. The key is a group representing a set of documents, and the value is the number of document in that group. Note: keys in this map may change over time. Supported keys: ['all'].", "type": "object", "additionalProperties": { "type": "string", "format": "int64" } } } }, "GoogleCloudDiscoveryengineV1alphaCannedQuery": { "id": "GoogleCloudDiscoveryengineV1alphaCannedQuery", "description": "Canned query resource of Assistant. It represents a short-cut to a predefined conversation start.", "type": "object", "properties": { "name": { "description": "Immutable. Resource name of the canned query. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/cannedQueries/{canned_query}` It must be a UTF-8 encoded string with a length limit of 1024 characters.", "type": "string" }, "displayName": { "description": "The display name of the canned query. It must be a UTF-8 encoded string with a length limit of 128 characters.", "type": "string" }, "defaultTexts": { "description": "Required. The default (non-localized) values for the text attributes.", "$ref": "GoogleCloudDiscoveryengineV1alphaCannedQueryCannedQueryTexts" }, "localizedTexts": { "description": "Optional. The translations of the text attributes. The keys should be BCP-47 language codes.", "type": "object", "additionalProperties": { "$ref": "GoogleCloudDiscoveryengineV1alphaCannedQueryCannedQueryTexts" } }, "requiredCapabilities": { "description": "Optional. The capabilities the Assistant needs to have to use this canned query.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaCannedQueryAssistantCapability" } }, "enabled": { "description": "Whether this canned query is enabled.", "type": "boolean" }, "googleDefined": { "description": "Output only. Whether this is a Google-defined, read-only canned query.", "readOnly": true, "type": "boolean" } } }, "GoogleCloudDiscoveryengineV1alphaCannedQueryCannedQueryTexts": { "id": "GoogleCloudDiscoveryengineV1alphaCannedQueryCannedQueryTexts", "description": "The text pieces for the canned query, which can be localized.", "type": "object", "properties": { "title": { "description": "Required. The title that is for the end user.", "type": "string" }, "prefix": { "description": "Optional. The prefix that `suggested_prompts` should start with.", "type": "string" }, "suggestedPrompts": { "description": "Required. The prompts the canned query will offer to the user.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaCannedQuerySuggestedPrompt" } } } }, "GoogleCloudDiscoveryengineV1alphaCannedQuerySuggestedPrompt": { "id": "GoogleCloudDiscoveryengineV1alphaCannedQuerySuggestedPrompt", "description": "A suggested prompt for the canned query.", "type": "object", "properties": { "promptText": { "description": "Required. The text of the suggested prompt.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1alphaCannedQueryAssistantCapability": { "id": "GoogleCloudDiscoveryengineV1alphaCannedQueryAssistantCapability", "description": "Capability of an assistant needed to use this canned query.", "type": "object", "properties": { "actionName": { "description": "The name of the action that the Assistant needs to have set up to use this canned query.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1alphaListCannedQueriesResponse": { "id": "GoogleCloudDiscoveryengineV1alphaListCannedQueriesResponse", "description": "Response message for the CannedQueryService.ListCannedQueries method.", "type": "object", "properties": { "cannedQueries": { "description": "The list of CannedQuerys matching the request.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaCannedQuery" } }, "nextPageToken": { "description": "A token that can be sent as ListCannedQueriesRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1alphaListChunksResponse": { "id": "GoogleCloudDiscoveryengineV1alphaListChunksResponse", "description": "Response message for ChunkService.ListChunks method.", "type": "object", "properties": { "chunks": { "description": "The Chunks.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaChunk" } }, "nextPageToken": { "description": "A token that can be sent as ListChunksRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1alphaCmekConfig": { "id": "GoogleCloudDiscoveryengineV1alphaCmekConfig", "description": "Configurations used to enable CMEK data encryption with Cloud KMS keys.", "type": "object", "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" }, "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": { "description": "Output only. KMS key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`.", "readOnly": true, "type": "string" }, "state": { "description": "Output only. The states of the CmekConfig.", "readOnly": true, "type": "string", "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." ], "enum": [ "STATE_UNSPECIFIED", "CREATING", "ACTIVE", "KEY_ISSUE", "DELETING", "DELETE_FAILED", "UNUSABLE", "ACTIVE_ROTATING", "DELETED", "EXPIRED" ] }, "isDefault": { "description": "Output only. The default CmekConfig for the Customer.", "readOnly": true, "type": "boolean" }, "lastRotationTimestampMicros": { "description": "Output only. The timestamp of the last key rotation.", "readOnly": true, "type": "string", "format": "int64" }, "singleRegionKeys": { "description": "Optional. Single-regional CMEKs that are required for some VAIS features.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaSingleRegionKey" } }, "notebooklmState": { "description": "Output only. Whether the NotebookLM Corpus is ready to be used.", "readOnly": true, "type": "string", "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" ] } } }, "GoogleCloudDiscoveryengineV1alphaSingleRegionKey": { "id": "GoogleCloudDiscoveryengineV1alphaSingleRegionKey", "description": "Metadata for single-regional CMEKs.", "type": "object", "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" } } }, "GoogleCloudDiscoveryengineV1alphaListCmekConfigsResponse": { "id": "GoogleCloudDiscoveryengineV1alphaListCmekConfigsResponse", "description": "Response message for CmekConfigService.ListCmekConfigs method.", "type": "object", "properties": { "cmekConfigs": { "description": "All the customer's CmekConfigs.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaCmekConfig" } } } }, "GoogleCloudDiscoveryengineV1alphaCollection": { "id": "GoogleCloudDiscoveryengineV1alphaCollection", "description": "Collection is a container for configuring resources and access to a set of DataStores.", "type": "object", "properties": { "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" }, "displayName": { "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.", "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.", "readOnly": true, "$ref": "GoogleCloudDiscoveryengineV1alphaDataConnector" }, "createTime": { "description": "Output only. Timestamp the Collection was created at.", "readOnly": true, "type": "string", "format": "google-datetime" } } }, "GoogleCloudDiscoveryengineV1alphaDataConnector": { "id": "GoogleCloudDiscoveryengineV1alphaDataConnector", "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", "properties": { "params": { "description": "Required data connector parameters in structured json format.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "jsonParams": { "description": "Required data connector parameters in json string format.", "type": "string" }, "name": { "description": "Identifier. The full resource name of the Data Connector. Format: `projects/*/locations/*/collections/*/dataConnector`.", "type": "string" }, "state": { "description": "Output only. State of the connector.", "readOnly": true, "type": "string", "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" ] }, "dataSource": { "description": "Required. The identifier for the data source. This is a partial list of supported connectors. Please refer to the [documentation](https://docs.cloud.google.com/gemini/enterprise/docs/connectors/introduction-to-connectors-and-data-stores) for the full list of connectors. Supported first-party connectors include: * `gcs` * `bigquery` * `gcp_fhir` * `google_mail` * `google_drive` * `google_calendar` * `google_chat` Supported third-party connectors include: Generally available (GA) connectors: * `onedrive` * `outlook` * `confluence` * `jira` * `servicenow` * `sharepoint` Preview connectors: * `asana` * `azure_active_directory` * `box` * `canva` * `confluence_server` * `custom_connector` * `docusign` * `dropbox` * `dynamics365` * `github` * `gitlab` * `hubspot` * `jira_server` * `linear` * `native_cloud_identity` * `notion` * `okta` * `pagerduty` * `peoplesoft` * `salesforce` * `shopify` * `slack` * `snowflake` * `teams` * `trello` * `workday` * `zendesk`", "type": "string" }, "removeParamKeys": { "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", "items": { "type": "string" } }, "refreshInterval": { "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.", "type": "string", "format": "google-duration" }, "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" }, "entities": { "description": "List of entities from the connected data source to ingest.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaDataConnectorSourceEntity" } }, "createTime": { "description": "Output only. Timestamp the DataConnector was created at.", "readOnly": true, "type": "string", "format": "google-datetime" }, "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, "type": "string", "format": "google-datetime" }, "lastSyncTime": { "description": "Output only. For periodic connectors only, the last time a data sync was completed.", "readOnly": true, "type": "string", "format": "google-datetime" }, "updateTime": { "description": "Output only. Timestamp the DataConnector was last updated.", "readOnly": true, "type": "string", "format": "google-datetime" }, "errors": { "description": "Output only. The errors from initialization or from the latest connector run.", "readOnly": true, "type": "array", "items": { "$ref": "GoogleRpcStatus" } }, "syncMode": { "description": "The data synchronization mode supported by the data connector.", "type": "string", "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" ] }, "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" }, "destinationConfigs": { "description": "Optional. Any target destinations used to connect to third-party services.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaDestinationConfig" } }, "actionState": { "description": "Output only. State of the action connector. This reflects whether the action connector is initializing, active or has encountered errors.", "readOnly": true, "type": "string", "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" ] }, "actionConfig": { "description": "Optional. Action configurations to make the connector support actions.", "$ref": "GoogleCloudDiscoveryengineV1alphaActionConfig" }, "endUserConfig": { "description": "Optional. Any params and credentials used specifically for EUA connectors.", "$ref": "GoogleCloudDiscoveryengineV1alphaDataConnectorEndUserConfig" }, "federatedConfig": { "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.", "$ref": "GoogleCloudDiscoveryengineV1alphaDataConnectorFederatedConfig" }, "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": { "description": "Optional. Whether customer has enabled static IP addresses for this connector.", "type": "boolean" }, "staticIpAddresses": { "description": "Output only. The static IP addresses used by this connector.", "readOnly": true, "type": "array", "items": { "type": "string" } }, "blockingReasons": { "description": "Output only. User actions that must be completed before the connector can start syncing data.", "readOnly": true, "type": "array", "items": { "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." ], "enum": [ "BLOCKING_REASON_UNSPECIFIED", "ALLOWLIST_STATIC_IP", "ALLOWLIST_IN_SERVICE_ATTACHMENT", "ALLOWLIST_SERVICE_ACCOUNT" ] } }, "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" }, "identityScheduleConfig": { "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.", "$ref": "GoogleCloudDiscoveryengineV1alphaIdentityScheduleConfig" }, "privateConnectivityProjectId": { "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.", "readOnly": true, "type": "string" }, "bapConfig": { "description": "Optional. The configuration for establishing a BAP connection.", "$ref": "GoogleCloudDiscoveryengineV1alphaBAPConfig" }, "connectorType": { "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.", "readOnly": true, "type": "string", "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." ], "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" ] }, "realtimeState": { "description": "Output only. real-time sync state", "readOnly": true, "type": "string", "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" ] }, "alertPolicyConfigs": { "description": "Optional. The connector level alert config.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaAlertPolicyConfig" } }, "realtimeSyncConfig": { "description": "Optional. The configuration for realtime sync.", "$ref": "GoogleCloudDiscoveryengineV1alphaDataConnectorRealtimeSyncConfig" }, "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" }, "createEuaSaas": { "description": "Optional. Whether the END USER AUTHENTICATION connector is created in SaaS.", "type": "boolean" }, "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" }, "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" }, "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.", "type": "string", "format": "google-duration" }, "hybridIngestionDisabled": { "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.", "type": "boolean" }, "dataProtectionPolicy": { "description": "Optional. Specifies the data protection policy for the connector.", "$ref": "GoogleCloudDiscoveryengineV1alphaDataProtectionPolicy" }, "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.", "readOnly": true, "type": "array", "items": { "type": "string" } }, "vpcscEnabled": { "description": "Output only. Whether the connector is created with VPC-SC enabled.", "readOnly": true, "type": "boolean" }, "dynamicTools": { "description": "Output only. The dynamic tools fetched for this connector.", "readOnly": true, "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaDynamicTool" } }, "cliConfig": { "description": "Optional. The configuration for establishing a CLI connection.", "$ref": "GoogleCloudDiscoveryengineV1alphaCliConfig" }, "connectorSourceId": { "description": "Optional. If set, this value instead of `data_source` is used to fetch the corresponding connector source.", "type": "string" } } }, "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.", "type": "object", "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": { "description": "Optional. Month of year. Must be from 1 to 12, or 0 if specifying a datetime without a month.", "type": "integer", "format": "int32" }, "day": { "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.", "type": "integer", "format": "int32" }, "hours": { "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.", "type": "integer", "format": "int32" }, "minutes": { "description": "Optional. Minutes of hour of day. Must be from 0 to 59, defaults to 0.", "type": "integer", "format": "int32" }, "seconds": { "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.", "type": "integer", "format": "int32" }, "nanos": { "description": "Optional. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999, defaults to 0.", "type": "integer", "format": "int32" }, "utcOffset": { "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 }.", "type": "string", "format": "google-duration" }, "timeZone": { "description": "Time zone.", "$ref": "GoogleTypeTimeZone" } } }, "GoogleTypeTimeZone": { "id": "GoogleTypeTimeZone", "description": "Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones).", "type": "object", "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" } } }, "GoogleCloudDiscoveryengineV1alphaDataConnectorSourceEntity": { "id": "GoogleCloudDiscoveryengineV1alphaDataConnectorSourceEntity", "description": "Represents an entity in the data source. For example, the `Account` object in Salesforce.", "type": "object", "properties": { "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." } }, "jsonParams": { "description": "The parameters for the entity to facilitate data ingestion in json string format.", "type": "string" }, "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" }, "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" } }, "dataStore": { "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.", "readOnly": true, "type": "string" }, "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" }, "healthcareFhirConfig": { "description": "Optional. Configuration for `HEALTHCARE_FHIR` vertical.", "$ref": "GoogleCloudDiscoveryengineV1alphaHealthcareFhirConfig" } } }, "GoogleCloudDiscoveryengineV1alphaSchema": { "id": "GoogleCloudDiscoveryengineV1alphaSchema", "description": "Defines the structure and layout of a type of document data.", "type": "object", "properties": { "structSchema": { "description": "The structured representation of the schema.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "jsonSchema": { "description": "The JSON representation of the schema.", "type": "string" }, "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" }, "fieldConfigs": { "description": "Output only. Configurations for fields of the schema.", "readOnly": true, "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaFieldConfig" } } } }, "GoogleCloudDiscoveryengineV1alphaFieldConfig": { "id": "GoogleCloudDiscoveryengineV1alphaFieldConfig", "description": "Configurations for fields of a schema. For example, configuring a field is indexable, or searchable.", "type": "object", "properties": { "fieldPath": { "description": "Required. Field path of the schema field. For example: `title`, `description`, `release_info.release_year`.", "type": "string" }, "fieldType": { "description": "Output only. Raw type of the field.", "readOnly": true, "type": "string", "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\"`" ], "enum": [ "FIELD_TYPE_UNSPECIFIED", "OBJECT", "STRING", "NUMBER", "INTEGER", "BOOLEAN", "GEOLOCATION", "DATETIME" ] }, "indexableOption": { "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.", "type": "string", "enumDescriptions": [ "Value used when unset.", "Indexable option enabled for a schema field.", "Indexable option disabled for a schema field." ], "enum": [ "INDEXABLE_OPTION_UNSPECIFIED", "INDEXABLE_ENABLED", "INDEXABLE_DISABLED" ] }, "dynamicFacetableOption": { "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.", "type": "string", "enumDescriptions": [ "Value used when unset.", "Dynamic facetable option enabled for a schema field.", "Dynamic facetable option disabled for a schema field." ], "enum": [ "DYNAMIC_FACETABLE_OPTION_UNSPECIFIED", "DYNAMIC_FACETABLE_ENABLED", "DYNAMIC_FACETABLE_DISABLED" ] }, "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.", "type": "string", "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" ] }, "retrievableOption": { "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.", "type": "string", "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" ] }, "completableOption": { "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", "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" ] }, "recsFilterableOption": { "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.", "type": "string", "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" ] }, "keyPropertyType": { "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.", "readOnly": true, "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 ``.", "type": "array", "items": { "type": "string", "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" ] } }, "schemaOrgPaths": { "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", "type": "array", "items": { "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" }, "searchableFieldImportance": { "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`.", "type": "string", "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." ], "enum": [ "SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED", "VERY_LOW_IMPORTANCE", "LOW_IMPORTANCE", "DEFAULT_IMPORTANCE", "HIGH_IMPORTANCE", "VERY_HIGH_IMPORTANCE" ] } } }, "GoogleCloudDiscoveryengineV1alphaHealthcareFhirConfig": { "id": "GoogleCloudDiscoveryengineV1alphaHealthcareFhirConfig", "description": "Config to data store for `HEALTHCARE_FHIR` vertical.", "type": "object", "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": { "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" } } } }, "GoogleCloudDiscoveryengineV1alphaDestinationConfig": { "id": "GoogleCloudDiscoveryengineV1alphaDestinationConfig", "description": "Defines target endpoints used to connect to third-party sources.", "type": "object", "properties": { "params": { "description": "Optional. Additional parameters for this destination config in structured json format.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "jsonParams": { "description": "Additional parameters for this destination config in json string format.", "type": "string" }, "key": { "description": "Optional. Unique destination identifier that is supported by the connector.", "type": "string" }, "destinations": { "description": "Optional. The destinations for the corresponding key.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaDestinationConfigDestination" } } } }, "GoogleCloudDiscoveryengineV1alphaDestinationConfigDestination": { "id": "GoogleCloudDiscoveryengineV1alphaDestinationConfigDestination", "description": "Defines a target endpoint", "type": "object", "properties": { "host": { "description": "Publicly routable host.", "type": "string" }, "port": { "description": "Optional. Target port number accepted by the destination.", "type": "integer", "format": "int32" } } }, "GoogleCloudDiscoveryengineV1alphaActionConfig": { "id": "GoogleCloudDiscoveryengineV1alphaActionConfig", "description": "Informations to support actions on the connector.", "type": "object", "properties": { "actionParams": { "description": "Optional. Action parameters in structured json format.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "jsonActionParams": { "description": "Optional. Action parameters in json string format.", "type": "string" }, "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" }, "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" }, "createBapConnection": { "description": "Optional. Whether to create a BAP connection for the connector.", "type": "boolean" }, "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" } } } }, "GoogleCloudDiscoveryengineV1alphaActionConfigScopeList": { "id": "GoogleCloudDiscoveryengineV1alphaActionConfigScopeList", "description": "Stores a list of scopes.", "type": "object", "properties": { "scopes": { "description": "Optional. The list of scopes.", "type": "array", "items": { "type": "string" } } } }, "GoogleCloudDiscoveryengineV1alphaDataConnectorEndUserConfig": { "id": "GoogleCloudDiscoveryengineV1alphaDataConnectorEndUserConfig", "description": "Any params and credentials used specifically for EUA connectors.", "type": "object", "properties": { "authParams": { "description": "Optional. Any authentication parameters specific to EUA connectors.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "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.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "tenant": { "description": "Optional. The tenant project the connector is connected to.", "$ref": "GoogleCloudDiscoveryengineV1alphaTenant" } } }, "GoogleCloudDiscoveryengineV1alphaTenant": { "id": "GoogleCloudDiscoveryengineV1alphaTenant", "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", "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" } } }, "GoogleCloudDiscoveryengineV1alphaDataConnectorFederatedConfig": { "id": "GoogleCloudDiscoveryengineV1alphaDataConnectorFederatedConfig", "description": "Any params and credentials used specifically for hybrid connectors supporting FEDERATED mode.", "type": "object", "properties": { "authParams": { "description": "Optional. Any authentication parameters specific to FEDERATED connectors.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "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." } } } }, "GoogleCloudDiscoveryengineV1alphaIdentityScheduleConfig": { "id": "GoogleCloudDiscoveryengineV1alphaIdentityScheduleConfig", "description": "The configuration for the identity data synchronization runs.", "type": "object", "properties": { "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" }, "nextSyncTime": { "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.", "$ref": "GoogleTypeDateTime" } } }, "GoogleCloudDiscoveryengineV1alphaBAPConfig": { "id": "GoogleCloudDiscoveryengineV1alphaBAPConfig", "description": "The configuration for the BAP connector.", "type": "object", "properties": { "supportedConnectorModes": { "description": "Required. The supported connector modes for the associated BAP connection.", "type": "array", "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" ] } }, "enabledActions": { "description": "Optional. The actions enabled on the associated BAP connection.", "type": "array", "items": { "type": "string" } } } }, "GoogleCloudDiscoveryengineV1alphaAlertPolicyConfig": { "id": "GoogleCloudDiscoveryengineV1alphaAlertPolicyConfig", "description": "The connector level alert config.", "type": "object", "properties": { "alertPolicyName": { "description": "Immutable. The fully qualified resource name of the AlertPolicy.", "type": "string" }, "alertEnrollments": { "description": "Optional. The enrollment states of each alert.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaAlertPolicyConfigAlertEnrollment" } } } }, "GoogleCloudDiscoveryengineV1alphaAlertPolicyConfigAlertEnrollment": { "id": "GoogleCloudDiscoveryengineV1alphaAlertPolicyConfigAlertEnrollment", "description": "The alert enrollment status.", "type": "object", "properties": { "alertId": { "description": "Immutable. The id of an alert.", "type": "string" }, "enrollState": { "description": "Required. The enrollment status of a customer.", "type": "string", "enumDescriptions": [ "Default value. Used for customers who have not responded to the alert policy.", "Customer is enrolled in this policy.", "Customer declined this policy." ], "enum": [ "ENROLL_STATES_UNSPECIFIED", "ENROLLED", "DECLINED" ] } } }, "GoogleCloudDiscoveryengineV1alphaDataConnectorRealtimeSyncConfig": { "id": "GoogleCloudDiscoveryengineV1alphaDataConnectorRealtimeSyncConfig", "description": "The configuration for realtime sync to store additional params for realtime sync.", "type": "object", "properties": { "webhookUri": { "description": "Optional. Webhook url for the connector to specify additional params for realtime sync.", "type": "string" }, "realtimeSyncSecret": { "description": "Optional. The ID of the Secret Manager secret used for webhook secret.", "type": "string" }, "streamingError": { "description": "Optional. Streaming error details.", "$ref": "GoogleCloudDiscoveryengineV1alphaDataConnectorRealtimeSyncConfigStreamingError" } } }, "GoogleCloudDiscoveryengineV1alphaDataConnectorRealtimeSyncConfigStreamingError": { "id": "GoogleCloudDiscoveryengineV1alphaDataConnectorRealtimeSyncConfigStreamingError", "description": "Streaming error details.", "type": "object", "properties": { "streamingErrorReason": { "description": "Optional. Streaming error.", "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." ], "enum": [ "STREAMING_ERROR_REASON_UNSPECIFIED", "STREAMING_SETUP_ERROR", "STREAMING_SYNC_ERROR", "INGRESS_ENDPOINT_REQUIRED" ] }, "error": { "description": "Optional. Error details.", "$ref": "GoogleRpcStatus" } } }, "GoogleCloudDiscoveryengineV1alphaDataProtectionPolicy": { "id": "GoogleCloudDiscoveryengineV1alphaDataProtectionPolicy", "description": "Contains the data protection policy config for a DataStore or a connector.", "type": "object", "properties": { "sensitiveDataProtectionPolicy": { "description": "Optional. Specifies the sensitive data protection policy for the connector source.", "$ref": "GoogleCloudDiscoveryengineV1alphaDataProtectionPolicySensitiveDataProtectionPolicy" } } }, "GoogleCloudDiscoveryengineV1alphaDataProtectionPolicySensitiveDataProtectionPolicy": { "id": "GoogleCloudDiscoveryengineV1alphaDataProtectionPolicySensitiveDataProtectionPolicy", "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. Specifies the resource name of the Sensitive Data Protection content policy.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1alphaDynamicTool": { "id": "GoogleCloudDiscoveryengineV1alphaDynamicTool", "description": "Configuration for dynamic tools.", "type": "object", "properties": { "name": { "description": "Required. The name of the tool.", "type": "string" }, "description": { "description": "Optional. The description of the tool.", "type": "string" }, "enabled": { "description": "Optional. Whether the tool is enabled.", "type": "boolean" }, "displayName": { "description": "Optional. The display name of the tool.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1alphaCliConfig": { "id": "GoogleCloudDiscoveryengineV1alphaCliConfig", "description": "The configuration for the CLI execution based connectors.", "type": "object", "properties": { "enabledActions": { "description": "Optional. The actions enabled on the associated CLI connection.", "type": "array", "items": { "type": "string" } } } }, "GoogleCloudDiscoveryengineV1alphaListCollectionsResponse": { "id": "GoogleCloudDiscoveryengineV1alphaListCollectionsResponse", "description": "Response message for CollectionService.ListCollections method.", "type": "object", "properties": { "collections": { "description": "The Collections.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaCollection" } }, "nextPageToken": { "description": "A token that can be sent as ListCollectionsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1alphaCompleteQueryResponse": { "id": "GoogleCloudDiscoveryengineV1alphaCompleteQueryResponse", "description": "Response message for CompletionService.CompleteQuery method.", "type": "object", "properties": { "querySuggestions": { "description": "Results of the matched query suggestions. The result list is ordered and the first result is a top suggestion.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaCompleteQueryResponseQuerySuggestion" } }, "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" } } }, "GoogleCloudDiscoveryengineV1alphaCompleteQueryResponseQuerySuggestion": { "id": "GoogleCloudDiscoveryengineV1alphaCompleteQueryResponseQuerySuggestion", "description": "Suggestions as search queries.", "type": "object", "properties": { "suggestion": { "description": "The suggestion for the query.", "type": "string" }, "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.", "type": "array", "items": { "type": "string" } } } }, "GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryRequest": { "id": "GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryRequest", "description": "Request message for CompletionService.AdvancedCompleteQuery method. .", "type": "object", "properties": { "query": { "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.", "type": "string" }, "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" }, "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", "type": "string" }, "userInfo": { "description": "Optional. Information about the end user. This should be the same identifier information as UserEvent.user_info and SearchRequest.user_info.", "$ref": "GoogleCloudDiscoveryengineV1alphaUserInfo" }, "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": "GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryRequestBoostSpec" }, "suggestionTypes": { "description": "Optional. Suggestion types to return. If empty or unspecified, query suggestions are returned. Only one suggestion type is supported at the moment.", "type": "array", "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" ] } }, "suggestionTypeSpecs": { "description": "Optional. Specification of each suggestion type.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryRequestSuggestionTypeSpec" } }, "experimentIds": { "description": "Optional. Experiment ids for this request.", "type": "array", "items": { "type": "string" } } } }, "GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryRequestBoostSpec": { "id": "GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryRequestBoostSpec", "description": "Specification to boost suggestions based on the condition of the suggestion.", "type": "object", "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": "GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryRequestBoostSpecConditionBoostSpec" } } } }, "GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryRequestBoostSpecConditionBoostSpec": { "id": "GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryRequestBoostSpecConditionBoostSpec", "description": "Boost applies to suggestions which match a condition.", "type": "object", "properties": { "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" }, "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" } } }, "GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryRequestSuggestionTypeSpec": { "id": "GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryRequestSuggestionTypeSpec", "description": "Specification of each suggestion type.", "type": "object", "properties": { "suggestionType": { "description": "Optional. Suggestion type.", "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" ] }, "maxSuggestions": { "description": "Optional. Maximum number of suggestions to return for each suggestion type.", "type": "integer", "format": "int32" } } }, "GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryResponse": { "id": "GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryResponse", "description": "Response message for CompletionService.AdvancedCompleteQuery method.", "type": "object", "properties": { "querySuggestions": { "description": "Results of the matched query suggestions. The result list is ordered and the first result is a top suggestion.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryResponseQuerySuggestion" } }, "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" }, "peopleSuggestions": { "description": "Results of the matched people suggestions. The result list is ordered and the first result is the top suggestion.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryResponsePersonSuggestion" } }, "contentSuggestions": { "description": "Results of the matched content suggestions. The result list is ordered and the first result is the top suggestion.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryResponseContentSuggestion" } }, "recentSearchSuggestions": { "description": "Results of the matched \"recent search\" suggestions. The result list is ordered and the first result is the top suggestion.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryResponseRecentSearchSuggestion" } } } }, "GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryResponseQuerySuggestion": { "id": "GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryResponseQuerySuggestion", "description": "Suggestions as search queries.", "type": "object", "properties": { "suggestion": { "description": "The suggestion for the query.", "type": "string" }, "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.", "type": "array", "items": { "type": "string" } }, "dataStore": { "description": "The name of the dataStore that this suggestion belongs to.", "type": "array", "items": { "type": "string" } }, "score": { "description": "The score of each suggestion. The score is in the range of [0, 1].", "type": "number", "format": "double" } } }, "GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryResponsePersonSuggestion": { "id": "GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryResponsePersonSuggestion", "description": "Suggestions as people.", "type": "object", "properties": { "suggestion": { "description": "The suggestion for the query.", "type": "string" }, "personType": { "description": "The type of the person.", "type": "string", "enumDescriptions": [ "Default value.", "The suggestion is from a GOOGLE_IDENTITY source.", "The suggestion is from a THIRD_PARTY_IDENTITY source." ], "enum": [ "PERSON_TYPE_UNSPECIFIED", "CLOUD_IDENTITY", "THIRD_PARTY_IDENTITY" ] }, "document": { "description": "The document data snippet in the suggestion. Only a subset of fields is populated.", "$ref": "GoogleCloudDiscoveryengineV1alphaDocument" }, "dataStore": { "description": "The name of the dataStore that this suggestion belongs to.", "type": "string" }, "score": { "description": "The score of each suggestion. The score is in the range of [0, 1].", "type": "number", "format": "double" }, "displayPhotoUri": { "description": "The photo uri of the person suggestion.", "type": "string" }, "destinationUri": { "description": "The destination uri of the person suggestion.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryResponseContentSuggestion": { "id": "GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryResponseContentSuggestion", "description": "Suggestions as content.", "type": "object", "properties": { "suggestion": { "description": "The suggestion for the query.", "type": "string" }, "contentType": { "description": "The type of the content suggestion.", "type": "string", "enumDescriptions": [ "Default value.", "The suggestion is from a Google Workspace source.", "The suggestion is from a third party source." ], "enum": [ "CONTENT_TYPE_UNSPECIFIED", "GOOGLE_WORKSPACE", "THIRD_PARTY" ] }, "document": { "description": "The document data snippet in the suggestion. Only a subset of fields will be populated.", "$ref": "GoogleCloudDiscoveryengineV1alphaDocument" }, "dataStore": { "description": "The name of the dataStore that this suggestion belongs to.", "type": "string" }, "score": { "description": "The score of each suggestion. The score is in the range of [0, 1].", "type": "number", "format": "double" }, "iconUri": { "description": "The icon uri of the content suggestion.", "type": "string" }, "destinationUri": { "description": "The destination uri of the content suggestion.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryResponseRecentSearchSuggestion": { "id": "GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryResponseRecentSearchSuggestion", "description": "Suggestions from recent search history.", "type": "object", "properties": { "suggestion": { "description": "The suggestion for the query.", "type": "string" }, "recentSearchTime": { "description": "The time when this recent rearch happened.", "type": "string", "format": "google-datetime" }, "score": { "description": "The score of each suggestion. The score is in the range of [0, 1].", "type": "number", "format": "double" } } }, "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesRequest": { "id": "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesRequest", "description": "Request message for CompletionService.ImportSuggestionDenyListEntries method.", "type": "object", "properties": { "inlineSource": { "description": "The Inline source for the input content for suggestion deny list entries.", "$ref": "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesRequestInlineSource" }, "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": "GoogleCloudDiscoveryengineV1alphaGcsSource" } } }, "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesRequestInlineSource": { "id": "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesRequestInlineSource", "description": "The inline source for SuggestionDenyListEntry.", "type": "object", "properties": { "entries": { "description": "Required. A list of all denylist entries to import. Max of 1000 items.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaSuggestionDenyListEntry" } } } }, "GoogleCloudDiscoveryengineV1alphaSuggestionDenyListEntry": { "id": "GoogleCloudDiscoveryengineV1alphaSuggestionDenyListEntry", "description": "Suggestion deny list entry identifying the phrase to block from suggestions and the applied operation for the phrase.", "type": "object", "properties": { "blockPhrase": { "description": "Required. Phrase to block from suggestions served. Can be maximum 125 characters.", "type": "string" }, "matchOperator": { "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", "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." ], "enum": [ "MATCH_OPERATOR_UNSPECIFIED", "EXACT_MATCH", "CONTAINS" ] } } }, "GoogleCloudDiscoveryengineV1alphaGcsSource": { "id": "GoogleCloudDiscoveryengineV1alphaGcsSource", "description": "Cloud Storage location for input content.", "type": "object", "properties": { "inputUris": { "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`).", "type": "array", "items": { "type": "string" } }, "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" } } }, "GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesRequest": { "id": "GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesRequest", "description": "Request message for CompletionService.PurgeSuggestionDenyListEntries method.", "type": "object", "properties": {} }, "GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsRequest": { "id": "GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsRequest", "description": "Request message for CompletionService.ImportCompletionSuggestions method.", "type": "object", "properties": { "inlineSource": { "description": "The Inline source for suggestion entries.", "$ref": "GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsRequestInlineSource" }, "gcsSource": { "description": "Cloud Storage location for the input content.", "$ref": "GoogleCloudDiscoveryengineV1alphaGcsSource" }, "bigquerySource": { "description": "BigQuery input source.", "$ref": "GoogleCloudDiscoveryengineV1alphaBigQuerySource" }, "errorConfig": { "description": "The desired location of errors incurred during the Import.", "$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig" } } }, "GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsRequestInlineSource": { "id": "GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsRequestInlineSource", "description": "The inline source for CompletionSuggestions.", "type": "object", "properties": { "suggestions": { "description": "Required. A list of all denylist entries to import. Max of 1000 items.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaCompletionSuggestion" } } } }, "GoogleCloudDiscoveryengineV1alphaCompletionSuggestion": { "id": "GoogleCloudDiscoveryengineV1alphaCompletionSuggestion", "description": "Autocomplete suggestions that are imported from Customer.", "type": "object", "properties": { "globalScore": { "description": "Global score of this suggestion. Control how this suggestion would be scored / ranked.", "type": "number", "format": "double" }, "frequency": { "description": "Frequency of this suggestion. Will be used to rank suggestions when score is not available.", "type": "string", "format": "int64" }, "suggestion": { "description": "Required. The suggestion text.", "type": "string" }, "languageCode": { "description": "BCP-47 language code of this suggestion.", "type": "string" }, "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": { "description": "The score of this suggestion within its group.", "type": "number", "format": "double" }, "alternativePhrases": { "description": "Alternative matching phrases for this suggestion.", "type": "array", "items": { "type": "string" } } } }, "GoogleCloudDiscoveryengineV1alphaBigQuerySource": { "id": "GoogleCloudDiscoveryengineV1alphaBigQuerySource", "description": "BigQuery source import data from.", "type": "object", "properties": { "partitionDate": { "description": "BigQuery time partitioned table's _PARTITIONDATE in YYYY-MM-DD format.", "$ref": "GoogleTypeDate" }, "projectId": { "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.", "type": "string" }, "datasetId": { "description": "Required. The BigQuery data set to copy the data from with a length limit of 1,024 characters.", "type": "string" }, "tableId": { "description": "Required. The BigQuery table to copy the data from with a length limit of 1,024 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 BigQuery export to a specific Cloud Storage directory.", "type": "string" }, "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" } } }, "GoogleCloudDiscoveryengineV1alphaImportErrorConfig": { "id": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", "description": "Configuration of destination for Import related errors.", "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" } } }, "GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsRequest": { "id": "GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsRequest", "description": "Request message for CompletionService.PurgeCompletionSuggestions method.", "type": "object", "properties": {} }, "GoogleCloudDiscoveryengineV1alphaRemoveSuggestionRequest": { "id": "GoogleCloudDiscoveryengineV1alphaRemoveSuggestionRequest", "description": "Request message for CompletionService.RemoveSuggestion method.", "type": "object", "properties": { "searchHistorySuggestion": { "description": "The search history suggestion to be removed.", "type": "string" }, "removeAllSearchHistorySuggestions": { "description": "Remove all search history suggestions for the user.", "type": "boolean" }, "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 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.", "type": "string" }, "userInfo": { "description": "Optional. Information about the end user. This should be the same identifier information as UserEvent.user_info and SearchRequest.user_info.", "$ref": "GoogleCloudDiscoveryengineV1alphaUserInfo" }, "removeTime": { "description": "Required. Time at which the suggestion was removed. If not set, the current time will be used.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudDiscoveryengineV1alphaRemoveSuggestionResponse": { "id": "GoogleCloudDiscoveryengineV1alphaRemoveSuggestionResponse", "description": "Response message for CompletionService.RemoveSuggestion method.", "type": "object", "properties": {} }, "GoogleCloudDiscoveryengineV1alphaCompleteExternalIdentitiesResponse": { "id": "GoogleCloudDiscoveryengineV1alphaCompleteExternalIdentitiesResponse", "description": "Response message for CompletionService.CompleteExternalIdentities.", "type": "object", "properties": { "externalIdentities": { "description": "The list of external identities that match the query.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaExternalIdentity" } } } }, "GoogleCloudDiscoveryengineV1alphaExternalIdentity": { "id": "GoogleCloudDiscoveryengineV1alphaExternalIdentity", "description": "External identity representing either a user or group. This user or group is from an external identity provider (IdP).", "type": "object", "properties": { "userMetadata": { "description": "Metadata corresponding to the external user.", "$ref": "GoogleCloudDiscoveryengineV1alphaExternalIdentityUserMetadata" }, "groupMetadata": { "description": "Metadata corresponding to the external user.", "$ref": "GoogleCloudDiscoveryengineV1alphaExternalIdentityGroupMetadata" }, "externalId": { "description": "The unique 3P ID(external_id) of the entity (user or group).", "type": "string" }, "displayName": { "description": "The display name of the user or group.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1alphaExternalIdentityUserMetadata": { "id": "GoogleCloudDiscoveryengineV1alphaExternalIdentityUserMetadata", "description": "Metadata corresponding to the external user.", "type": "object", "properties": { "givenName": { "description": "The user's given name.", "type": "string" }, "familyName": { "description": "The user's family name.", "type": "string" }, "primaryEmail": { "description": "The user's primary email address.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1alphaExternalIdentityGroupMetadata": { "id": "GoogleCloudDiscoveryengineV1alphaExternalIdentityGroupMetadata", "description": "Metadata corresponding to the external group.", "type": "object", "properties": {} }, "GoogleCloudDiscoveryengineV1alphaControl": { "id": "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`.", "type": "object", "properties": { "boostAction": { "description": "Defines a boost-type control", "$ref": "GoogleCloudDiscoveryengineV1alphaControlBoostAction" }, "filterAction": { "description": "Defines a filter-type control Currently not supported by Recommendation", "$ref": "GoogleCloudDiscoveryengineV1alphaControlFilterAction" }, "redirectAction": { "description": "Defines a redirect-type control.", "$ref": "GoogleCloudDiscoveryengineV1alphaControlRedirectAction" }, "synonymsAction": { "description": "Treats a group of terms as synonyms of one another.", "$ref": "GoogleCloudDiscoveryengineV1alphaControlSynonymsAction" }, "promoteAction": { "description": "Promote certain links based on predefined trigger queries.", "$ref": "GoogleCloudDiscoveryengineV1alphaControlPromoteAction" }, "name": { "description": "Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*`", "type": "string" }, "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" }, "associatedServingConfigIds": { "description": "Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes.", "readOnly": true, "type": "array", "items": { "type": "string" } }, "solutionType": { "description": "Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown.", "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." ], "enum": [ "SOLUTION_TYPE_UNSPECIFIED", "SOLUTION_TYPE_RECOMMENDATION", "SOLUTION_TYPE_SEARCH", "SOLUTION_TYPE_CHAT", "SOLUTION_TYPE_GENERATIVE_CHAT", "SOLUTION_TYPE_AI_MODE" ] }, "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", "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." ], "enum": [ "SEARCH_USE_CASE_UNSPECIFIED", "SEARCH_USE_CASE_SEARCH", "SEARCH_USE_CASE_BROWSE" ] } }, "conditions": { "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", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaCondition" } } } }, "GoogleCloudDiscoveryengineV1alphaControlBoostAction": { "id": "GoogleCloudDiscoveryengineV1alphaControlBoostAction", "description": "Adjusts order of products in returned list.", "type": "object", "properties": { "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" }, "interpolationBoostSpec": { "description": "Optional. Complex specification for custom ranking based on customer defined attribute value.", "$ref": "GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpec" }, "boost": { "description": "Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).", "deprecated": true, "type": "number", "format": "float" }, "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" }, "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" } } }, "GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpec": { "id": "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.", "type": "object", "properties": { "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" ] }, "interpolationType": { "description": "Optional. 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" ] }, "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.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpecControlPoint" } } } }, "GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpecControlPoint": { "id": "GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpecControlPoint", "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": { "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" }, "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.", "type": "number", "format": "float" } } }, "GoogleCloudDiscoveryengineV1alphaControlFilterAction": { "id": "GoogleCloudDiscoveryengineV1alphaControlFilterAction", "description": "Specified which products may be included in results. Uses same filter as boost.", "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" } } }, "GoogleCloudDiscoveryengineV1alphaControlRedirectAction": { "id": "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" } } }, "GoogleCloudDiscoveryengineV1alphaControlSynonymsAction": { "id": "GoogleCloudDiscoveryengineV1alphaControlSynonymsAction", "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", "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.", "type": "array", "items": { "type": "string" } } } }, "GoogleCloudDiscoveryengineV1alphaControlPromoteAction": { "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.", "type": "object", "properties": { "dataStore": { "description": "Required. Data store with which this promotion is attached to.", "type": "string" }, "searchLinkPromotion": { "description": "Required. Promotion attached to this action.", "$ref": "GoogleCloudDiscoveryengineV1alphaSearchLinkPromotion" } } }, "GoogleCloudDiscoveryengineV1alphaCondition": { "id": "GoogleCloudDiscoveryengineV1alphaCondition", "description": "Defines circumstances to be checked before allowing a behavior", "type": "object", "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.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaConditionQueryTerm" } }, "activeTimeRange": { "description": "Range of time(s) specifying when condition is active. Maximum of 10 time ranges.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaConditionTimeRange" } }, "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" } } }, "GoogleCloudDiscoveryengineV1alphaConditionQueryTerm": { "id": "GoogleCloudDiscoveryengineV1alphaConditionQueryTerm", "description": "Matcher for search request query", "type": "object", "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": { "description": "Whether the search query needs to exactly match the query term.", "type": "boolean" } } }, "GoogleCloudDiscoveryengineV1alphaConditionTimeRange": { "id": "GoogleCloudDiscoveryengineV1alphaConditionTimeRange", "description": "Used for time-dependent conditions.", "type": "object", "properties": { "startTime": { "description": "Start of time range. Range is inclusive.", "type": "string", "format": "google-datetime" }, "endTime": { "description": "End of time range. Range is inclusive. Must be in the future.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudDiscoveryengineV1alphaListControlsResponse": { "id": "GoogleCloudDiscoveryengineV1alphaListControlsResponse", "description": "Response for ListControls method.", "type": "object", "properties": { "controls": { "description": "All the Controls for a given data store.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaControl" } }, "nextPageToken": { "description": "Pagination token, if not returned indicates the last page.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1alphaConverseConversationRequest": { "id": "GoogleCloudDiscoveryengineV1alphaConverseConversationRequest", "description": "Request message for ConversationalSearchService.ConverseConversation method.", "type": "object", "properties": { "query": { "description": "Required. Current user input.", "$ref": "GoogleCloudDiscoveryengineV1alphaTextInput" }, "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": { "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.", "$ref": "GoogleCloudDiscoveryengineV1alphaConversation" }, "safeSearch": { "description": "Whether to turn on safe search.", "type": "boolean" }, "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.", "type": "object", "additionalProperties": { "type": "string" } }, "summarySpec": { "description": "A specification for configuring the summary returned in the response.", "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec" }, "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" }, "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": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec" } } }, "GoogleCloudDiscoveryengineV1alphaTextInput": { "id": "GoogleCloudDiscoveryengineV1alphaTextInput", "description": "Defines text input.", "type": "object", "properties": { "input": { "description": "Text input.", "type": "string" }, "context": { "description": "Conversation context of the input.", "$ref": "GoogleCloudDiscoveryengineV1alphaConversationContext" } } }, "GoogleCloudDiscoveryengineV1alphaConversationContext": { "id": "GoogleCloudDiscoveryengineV1alphaConversationContext", "description": "Defines context of the conversation", "type": "object", "properties": { "contextDocuments": { "description": "The current list of documents the user is seeing. It contains the document resource references.", "type": "array", "items": { "type": "string" } }, "activeDocument": { "description": "The current active document the user opened. It contains the document resource reference.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1alphaConversation": { "id": "GoogleCloudDiscoveryengineV1alphaConversation", "description": "External conversation proto definition.", "type": "object", "properties": { "name": { "description": "Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/dataStore/*/conversations/*` or `projects/{project}/locations/global/collections/{collection}/engines/*/conversations/*`.", "type": "string" }, "state": { "description": "The state of the Conversation.", "type": "string", "enumDescriptions": [ "Unknown.", "Conversation is currently open.", "Conversation has been completed." ], "enum": [ "STATE_UNSPECIFIED", "IN_PROGRESS", "COMPLETED" ] }, "userPseudoId": { "description": "A unique identifier for tracking users.", "type": "string" }, "messages": { "description": "Conversation messages.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaConversationMessage" } }, "startTime": { "description": "Output only. The time the conversation started.", "readOnly": true, "type": "string", "format": "google-datetime" }, "endTime": { "description": "Output only. The time the conversation finished.", "readOnly": true, "type": "string", "format": "google-datetime" } } }, "GoogleCloudDiscoveryengineV1alphaConversationMessage": { "id": "GoogleCloudDiscoveryengineV1alphaConversationMessage", "description": "Defines a conversation message.", "type": "object", "properties": { "userInput": { "description": "User text input.", "$ref": "GoogleCloudDiscoveryengineV1alphaTextInput" }, "reply": { "description": "Search reply.", "$ref": "GoogleCloudDiscoveryengineV1alphaReply" }, "createTime": { "description": "Output only. Message creation timestamp.", "readOnly": true, "type": "string", "format": "google-datetime" } } }, "GoogleCloudDiscoveryengineV1alphaReply": { "id": "GoogleCloudDiscoveryengineV1alphaReply", "description": "Defines a reply message to user.", "type": "object", "properties": { "reply": { "description": "DEPRECATED: use `summary` instead. Text reply.", "deprecated": true, "type": "string" }, "references": { "description": "References in the reply.", "deprecated": true, "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaReplyReference" } }, "summary": { "description": "Summary based on search results.", "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummary" } } }, "GoogleCloudDiscoveryengineV1alphaReplyReference": { "id": "GoogleCloudDiscoveryengineV1alphaReplyReference", "deprecated": true, "description": "Defines reference in reply.", "type": "object", "properties": { "uri": { "description": "URI link reference.", "type": "string" }, "anchorText": { "description": "Anchor text.", "type": "string" }, "start": { "description": "Anchor text start index.", "type": "integer", "format": "int32" }, "end": { "description": "Anchor text end index.", "type": "integer", "format": "int32" } } }, "GoogleCloudDiscoveryengineV1alphaConverseConversationResponse": { "id": "GoogleCloudDiscoveryengineV1alphaConverseConversationResponse", "description": "Response message for ConversationalSearchService.ConverseConversation method.", "type": "object", "properties": { "reply": { "description": "Answer to the current query.", "$ref": "GoogleCloudDiscoveryengineV1alphaReply" }, "conversation": { "description": "Updated conversation including the answer.", "$ref": "GoogleCloudDiscoveryengineV1alphaConversation" }, "relatedQuestions": { "description": "Suggested related questions.", "type": "array", "items": { "type": "string" } }, "searchResults": { "description": "Search Results.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseSearchResult" } } } }, "GoogleCloudDiscoveryengineV1alphaListConversationsResponse": { "id": "GoogleCloudDiscoveryengineV1alphaListConversationsResponse", "description": "Response for ListConversations method.", "type": "object", "properties": { "conversations": { "description": "All the Conversations for a given data store.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaConversation" } }, "nextPageToken": { "description": "Pagination token, if not returned indicates the last page.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest": { "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest", "description": "Request message for ConversationalSearchService.AnswerQuery method.", "type": "object", "properties": { "query": { "description": "Required. Current user query.", "$ref": "GoogleCloudDiscoveryengineV1alphaQuery" }, "session": { "description": "The session resource name. Not required. When session field is not set, the API is in sessionless mode. We support auto session mode: users can use the wildcard symbol `-` as session ID. A new ID will be automatically generated and assigned.", "type": "string" }, "safetySpec": { "description": "Model specification.", "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSafetySpec" }, "relatedQuestionsSpec": { "description": "Related questions specification.", "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestRelatedQuestionsSpec" }, "groundingSpec": { "description": "Optional. Grounding specification.", "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestGroundingSpec" }, "answerGenerationSpec": { "description": "Answer generation specification.", "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestAnswerGenerationSpec" }, "searchSpec": { "description": "Search specification.", "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpec" }, "queryUnderstandingSpec": { "description": "Query understanding specification.", "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpec" }, "asynchronousMode": { "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.", "deprecated": true, "type": "boolean" }, "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" }, "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.", "type": "object", "additionalProperties": { "type": "string" } }, "endUserSpec": { "description": "Optional. End user specification.", "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestEndUserSpec" } } }, "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSafetySpec": { "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSafetySpec", "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.", "type": "object", "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": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSafetySpecSafetySetting" } } } }, "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSafetySpecSafetySetting": { "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSafetySpecSafetySetting", "description": "Safety settings.", "type": "object", "properties": { "category": { "description": "Required. Harm category.", "type": "string", "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." ], "enum": [ "HARM_CATEGORY_UNSPECIFIED", "HARM_CATEGORY_HATE_SPEECH", "HARM_CATEGORY_DANGEROUS_CONTENT", "HARM_CATEGORY_HARASSMENT", "HARM_CATEGORY_SEXUALLY_EXPLICIT", "HARM_CATEGORY_CIVIC_INTEGRITY" ] }, "threshold": { "description": "Required. The harm block threshold.", "type": "string", "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." ], "enum": [ "HARM_BLOCK_THRESHOLD_UNSPECIFIED", "BLOCK_LOW_AND_ABOVE", "BLOCK_MEDIUM_AND_ABOVE", "BLOCK_ONLY_HIGH", "BLOCK_NONE", "OFF" ] } } }, "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestRelatedQuestionsSpec": { "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestRelatedQuestionsSpec", "description": "Related questions specification.", "type": "object", "properties": { "enable": { "description": "Enable related questions feature if true.", "type": "boolean" } } }, "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestGroundingSpec": { "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestGroundingSpec", "description": "Grounding specification.", "type": "object", "properties": { "includeGroundingSupports": { "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.", "type": "boolean" }, "filteringLevel": { "description": "Optional. Specifies whether to enable the filtering based on grounding score and at what level.", "type": "string", "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" ] } } }, "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestAnswerGenerationSpec": { "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestAnswerGenerationSpec", "description": "Answer generation specification.", "type": "object", "properties": { "modelSpec": { "description": "Answer generation model specification.", "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestAnswerGenerationSpecModelSpec" }, "promptSpec": { "description": "Answer generation prompt specification.", "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestAnswerGenerationSpecPromptSpec" }, "includeCitations": { "description": "Specifies whether to include citation metadata in the answer. The default value is `false`.", "type": "boolean" }, "answerLanguageCode": { "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.", "type": "string" }, "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": { "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.", "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" }, "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" }, "multimodalSpec": { "description": "Optional. Multimodal specification.", "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestAnswerGenerationSpecMultimodalSpec" } } }, "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestAnswerGenerationSpecModelSpec": { "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestAnswerGenerationSpecModelSpec", "description": "Answer Generation Model specification.", "type": "object", "properties": { "modelVersion": { "description": "Model version. If not set, it will use the default stable model. Allowed values are: stable, preview.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestAnswerGenerationSpecPromptSpec": { "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestAnswerGenerationSpecPromptSpec", "description": "Answer generation prompt specification.", "type": "object", "properties": { "preamble": { "description": "Customized preamble.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestAnswerGenerationSpecMultimodalSpec": { "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestAnswerGenerationSpecMultimodalSpec", "description": "Multimodal specification: Will return an image from specified source. If multiple sources are specified, the pick is a quality based decision.", "type": "object", "properties": { "imageSource": { "description": "Optional. Source of image returned in the answer.", "type": "string", "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." ], "enum": [ "IMAGE_SOURCE_UNSPECIFIED", "ALL_AVAILABLE_SOURCES", "CORPUS_IMAGE_ONLY", "FIGURE_GENERATION_ONLY" ] } } }, "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpec": { "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpec", "description": "Search specification.", "type": "object", "properties": { "searchParams": { "description": "Search parameters.", "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchParams" }, "searchResultList": { "description": "Search result list.", "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultList" } } }, "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchParams": { "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchParams", "description": "Search parameters.", "type": "object", "properties": { "maxReturnResults": { "description": "Number of search results to return. The default value is 10.", "type": "integer", "format": "int32" }, "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 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)", "type": "string" }, "boostSpec": { "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)", "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec" }, "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, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.", "type": "string" }, "searchResultMode": { "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)", "type": "string", "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" ] }, "customFineTuningSpec": { "description": "Optional. Custom fine tuning configs.", "$ref": "GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec" }, "dataStoreSpecs": { "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", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec" } }, "naturalLanguageQueryUnderstandingSpec": { "description": "Optional. Specification to enable natural language understanding capabilities for search requests.", "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec" } } }, "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultList": { "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultList", "description": "Search result list.", "type": "object", "properties": { "searchResults": { "description": "Search results.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResult" } } } }, "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResult": { "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResult", "description": "Search result.", "type": "object", "properties": { "unstructuredDocumentInfo": { "description": "Unstructured document information.", "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfo" }, "chunkInfo": { "description": "Chunk information.", "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfo" } } }, "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfo": { "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfo", "description": "Unstructured document information.", "type": "object", "properties": { "document": { "description": "Document resource name.", "type": "string" }, "uri": { "description": "URI for the document.", "type": "string" }, "title": { "description": "Title.", "type": "string" }, "documentContexts": { "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.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoDocumentContext" } }, "extractiveSegments": { "description": "List of extractive segments.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveSegment" } }, "extractiveAnswers": { "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.", "deprecated": true, "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveAnswer" } } } }, "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoDocumentContext": { "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoDocumentContext", "description": "Document context.", "type": "object", "properties": { "pageIdentifier": { "description": "Page identifier.", "type": "string" }, "content": { "description": "Document content to be used for answer generation.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveSegment": { "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveSegment", "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.", "type": "object", "properties": { "pageIdentifier": { "description": "Page identifier.", "type": "string" }, "content": { "description": "Extractive segment content.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveAnswer": { "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveAnswer", "description": "Extractive answer. [Guide](https://cloud.google.com/generative-ai-app-builder/docs/snippets#get-answers)", "type": "object", "properties": { "pageIdentifier": { "description": "Page identifier.", "type": "string" }, "content": { "description": "Extractive answer content.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfo": { "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfo", "description": "Chunk information.", "type": "object", "properties": { "chunk": { "description": "Chunk resource name.", "type": "string" }, "content": { "description": "Chunk textual content.", "type": "string" }, "documentMetadata": { "description": "Metadata of the document from the current chunk.", "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfoDocumentMetadata" } } }, "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfoDocumentMetadata": { "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfoDocumentMetadata", "description": "Document metadata contains the information of the document of the current chunk.", "type": "object", "properties": { "uri": { "description": "Uri of the document.", "type": "string" }, "title": { "description": "Title of the document.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpec": { "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpec", "description": "Query understanding specification.", "type": "object", "properties": { "queryClassificationSpec": { "description": "Query classification specification.", "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpecQueryClassificationSpec" }, "queryRephraserSpec": { "description": "Query rephraser specification.", "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpec" }, "disableSpellCorrection": { "description": "Optional. Whether to disable spell correction. The default value is `false`.", "type": "boolean" } } }, "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpecQueryClassificationSpec": { "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpecQueryClassificationSpec", "description": "Query classification specification.", "type": "object", "properties": { "types": { "description": "Enabled query classification types.", "type": "array", "items": { "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" ] } } } }, "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpec": { "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpec", "description": "Query rephraser specification.", "type": "object", "properties": { "disable": { "description": "Disable query rephraser.", "type": "boolean" }, "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.", "type": "integer", "format": "int32" }, "modelSpec": { "description": "Optional. Query Rephraser Model specification.", "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpecModelSpec" } } }, "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpecModelSpec": { "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpecModelSpec", "description": "Query Rephraser Model specification.", "type": "object", "properties": { "modelType": { "description": "Optional. Enabled query rephraser model type. If not set, it will use LARGE by default.", "type": "string", "enumDescriptions": [ "Unspecified model type.", "Small query rephraser model. Gemini 1.0 XS model.", "Large query rephraser model. Gemini 1.0 Pro model." ], "enum": [ "MODEL_TYPE_UNSPECIFIED", "SMALL", "LARGE" ] } } }, "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestEndUserSpec": { "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestEndUserSpec", "description": "End user specification.", "type": "object", "properties": { "endUserMetadata": { "description": "Optional. End user metadata.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestEndUserSpecEndUserMetaData" } } } }, "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestEndUserSpecEndUserMetaData": { "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestEndUserSpecEndUserMetaData", "description": "End user metadata.", "type": "object", "properties": { "chunkInfo": { "description": "Chunk information.", "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestEndUserSpecEndUserMetaDataChunkInfo" } } }, "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestEndUserSpecEndUserMetaDataChunkInfo": { "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestEndUserSpecEndUserMetaDataChunkInfo", "description": "Chunk information.", "type": "object", "properties": { "content": { "description": "Chunk textual content. It is limited to 8000 characters.", "type": "string" }, "documentMetadata": { "description": "Metadata of the document from the current chunk.", "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestEndUserSpecEndUserMetaDataChunkInfoDocumentMetadata" } } }, "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestEndUserSpecEndUserMetaDataChunkInfoDocumentMetadata": { "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestEndUserSpecEndUserMetaDataChunkInfoDocumentMetadata", "description": "Document metadata contains the information of the document of the current chunk.", "type": "object", "properties": { "title": { "description": "Title of the document.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse": { "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse", "description": "Response message for ConversationalSearchService.AnswerQuery method.", "type": "object", "properties": { "answer": { "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.", "$ref": "GoogleCloudDiscoveryengineV1alphaAnswer" }, "session": { "description": "Session resource object. It will be only available when session field is set and valid in the AnswerQueryRequest request.", "$ref": "GoogleCloudDiscoveryengineV1alphaSession" }, "answerQueryToken": { "description": "A global unique ID used for logging.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1alphaAnswer": { "id": "GoogleCloudDiscoveryengineV1alphaAnswer", "description": "Defines an answer.", "type": "object", "properties": { "name": { "description": "Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*/answers/*`", "type": "string" }, "state": { "description": "The state of the answer generation.", "type": "string", "enumDescriptions": [ "Unknown.", "Answer generation is currently in progress.", "Answer generation currently failed.", "Answer generation has succeeded.", "Answer generation is currently in progress." ], "enum": [ "STATE_UNSPECIFIED", "IN_PROGRESS", "FAILED", "SUCCEEDED", "STREAMING" ] }, "answerText": { "description": "The textual answer.", "type": "string" }, "groundingScore": { "description": "A score in the range of [0, 1] describing how grounded the answer is by the reference chunks.", "type": "number", "format": "double" }, "citations": { "description": "Citations.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerCitation" } }, "groundingSupports": { "description": "Optional. Grounding supports.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerGroundingSupport" } }, "references": { "description": "References.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReference" } }, "blobAttachments": { "description": "Output only. List of blob attachments in the answer.", "readOnly": true, "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerBlobAttachment" } }, "relatedQuestions": { "description": "Suggested related questions.", "type": "array", "items": { "type": "string" } }, "steps": { "description": "Answer generation steps.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStep" } }, "queryUnderstandingInfo": { "description": "Query understanding information.", "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfo" }, "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", "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" ] } }, "createTime": { "description": "Output only. Answer creation timestamp.", "readOnly": true, "type": "string", "format": "google-datetime" }, "completeTime": { "description": "Output only. Answer completed timestamp.", "readOnly": true, "type": "string", "format": "google-datetime" }, "safetyRatings": { "description": "Optional. Safety ratings.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaSafetyRating" } } } }, "GoogleCloudDiscoveryengineV1alphaAnswerCitation": { "id": "GoogleCloudDiscoveryengineV1alphaAnswerCitation", "description": "Citation info for a segment.", "type": "object", "properties": { "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" }, "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": { "description": "Citation sources for the attributed segment.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerCitationSource" } } } }, "GoogleCloudDiscoveryengineV1alphaAnswerCitationSource": { "id": "GoogleCloudDiscoveryengineV1alphaAnswerCitationSource", "description": "Citation source.", "type": "object", "properties": { "referenceId": { "description": "ID of the citation source.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1alphaAnswerGroundingSupport": { "id": "GoogleCloudDiscoveryengineV1alphaAnswerGroundingSupport", "description": "Grounding support for a claim in `answer_text`.", "type": "object", "properties": { "startIndex": { "description": "Required. Index indicates the start of the claim, measured in bytes (UTF-8 unicode).", "type": "string", "format": "int64" }, "endIndex": { "description": "Required. End of the claim, exclusive.", "type": "string", "format": "int64" }, "groundingScore": { "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", "format": "double" }, "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" }, "sources": { "description": "Optional. Citation sources for the claim.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerCitationSource" } } } }, "GoogleCloudDiscoveryengineV1alphaAnswerReference": { "id": "GoogleCloudDiscoveryengineV1alphaAnswerReference", "description": "Reference.", "type": "object", "properties": { "unstructuredDocumentInfo": { "description": "Unstructured document information.", "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo" }, "chunkInfo": { "description": "Chunk information.", "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo" }, "structuredDocumentInfo": { "description": "Structured document information.", "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo" } } }, "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo": { "id": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo", "description": "Unstructured document information.", "type": "object", "properties": { "document": { "description": "Document resource name.", "type": "string" }, "uri": { "description": "URI for the document.", "type": "string" }, "title": { "description": "Title.", "type": "string" }, "chunkContents": { "description": "List of cited chunk contents derived from document content.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfoChunkContent" } }, "structData": { "description": "The structured JSON metadata for the document. It is populated from the struct data from the Chunk in search result.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } } } }, "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfoChunkContent": { "id": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfoChunkContent", "description": "Chunk content.", "type": "object", "properties": { "content": { "description": "Chunk textual content.", "type": "string" }, "pageIdentifier": { "description": "Page identifier.", "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.", "type": "number", "format": "float" }, "blobAttachmentIndexes": { "description": "Output only. Stores indexes of blobattachments linked to this chunk.", "readOnly": true, "type": "array", "items": { "type": "string", "format": "int64" } } } }, "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo": { "id": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo", "description": "Chunk information.", "type": "object", "properties": { "chunk": { "description": "Chunk resource name.", "type": "string" }, "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.", "type": "number", "format": "float" }, "documentMetadata": { "description": "Document metadata.", "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfoDocumentMetadata" }, "blobAttachmentIndexes": { "description": "Output only. Stores indexes of blobattachments linked to this chunk.", "readOnly": true, "type": "array", "items": { "type": "string", "format": "int64" } } } }, "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfoDocumentMetadata": { "id": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfoDocumentMetadata", "description": "Document metadata.", "type": "object", "properties": { "document": { "description": "Document resource name.", "type": "string" }, "uri": { "description": "URI for the document.", "type": "string" }, "title": { "description": "Title.", "type": "string" }, "pageIdentifier": { "description": "Page identifier.", "type": "string" }, "structData": { "description": "The structured JSON metadata for the document. It is populated from the struct data from the Chunk in search result.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } } } }, "GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo": { "id": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo", "description": "Structured search information.", "type": "object", "properties": { "document": { "description": "Document resource name.", "type": "string" }, "structData": { "description": "Structured search data.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "title": { "description": "Output only. The title of the document.", "readOnly": true, "type": "string" }, "uri": { "description": "Output only. The URI of the document.", "readOnly": true, "type": "string" } } }, "GoogleCloudDiscoveryengineV1alphaAnswerBlobAttachment": { "id": "GoogleCloudDiscoveryengineV1alphaAnswerBlobAttachment", "description": "Stores binarydata attached to text answer, e.g. image, video, audio, etc.", "type": "object", "properties": { "data": { "description": "Output only. The mime type and data of the blob.", "readOnly": true, "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerBlobAttachmentBlob" }, "attributionType": { "description": "Output only. The attribution type of the blob.", "readOnly": true, "type": "string", "enumDescriptions": [ "Unspecified attribution type.", "The attachment data is from the corpus.", "The attachment data is generated by the model through code generation." ], "enum": [ "ATTRIBUTION_TYPE_UNSPECIFIED", "CORPUS", "GENERATED" ] } } }, "GoogleCloudDiscoveryengineV1alphaAnswerBlobAttachmentBlob": { "id": "GoogleCloudDiscoveryengineV1alphaAnswerBlobAttachmentBlob", "description": "The media type and data of the blob.", "type": "object", "properties": { "mimeType": { "description": "Output only. The media type (MIME type) of the generated or retrieved data.", "readOnly": true, "type": "string" }, "data": { "description": "Output only. Raw bytes.", "readOnly": true, "type": "string", "format": "byte" } } }, "GoogleCloudDiscoveryengineV1alphaAnswerStep": { "id": "GoogleCloudDiscoveryengineV1alphaAnswerStep", "description": "Step information.", "type": "object", "properties": { "state": { "description": "The state of the step.", "type": "string", "enumDescriptions": [ "Unknown.", "Step is currently in progress.", "Step currently failed.", "Step has succeeded." ], "enum": [ "STATE_UNSPECIFIED", "IN_PROGRESS", "FAILED", "SUCCEEDED" ] }, "description": { "description": "The description of the step.", "type": "string" }, "thought": { "description": "The thought of the step.", "type": "string" }, "actions": { "description": "Actions.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepAction" } } } }, "GoogleCloudDiscoveryengineV1alphaAnswerStepAction": { "id": "GoogleCloudDiscoveryengineV1alphaAnswerStepAction", "description": "Action.", "type": "object", "properties": { "searchAction": { "description": "Search action.", "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionSearchAction" }, "observation": { "description": "Observation.", "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservation" } } }, "GoogleCloudDiscoveryengineV1alphaAnswerStepActionSearchAction": { "id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionSearchAction", "description": "Search action.", "type": "object", "properties": { "query": { "description": "The query to search.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservation": { "id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservation", "description": "Observation.", "type": "object", "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": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResult" } } } }, "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResult": { "id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResult", "type": "object", "properties": { "document": { "description": "Document resource name.", "type": "string" }, "uri": { "description": "URI for the document.", "type": "string" }, "title": { "description": "Title.", "type": "string" }, "snippetInfo": { "description": "If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo" } }, "chunkInfo": { "description": "If citation_type is CHUNK_LEVEL_CITATION and chunk mode is on, populate chunk info.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultChunkInfo" } }, "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.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } } } }, "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo": { "id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo", "description": "Snippet information.", "type": "object", "properties": { "snippet": { "description": "Snippet content.", "type": "string" }, "snippetStatus": { "description": "Status of the snippet defined by the search team.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultChunkInfo": { "id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultChunkInfo", "description": "Chunk information.", "type": "object", "properties": { "chunk": { "description": "Chunk resource name.", "type": "string" }, "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.", "type": "number", "format": "float" } } }, "GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfo": { "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfo", "description": "Query understanding information.", "type": "object", "properties": { "queryClassificationInfo": { "description": "Query classification information.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfoQueryClassificationInfo" } } } }, "GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfoQueryClassificationInfo": { "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfoQueryClassificationInfo", "description": "Query classification information.", "type": "object", "properties": { "type": { "description": "Query classification 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" ] }, "positive": { "description": "Classification output.", "type": "boolean" } } }, "GoogleCloudDiscoveryengineV1alphaSafetyRating": { "id": "GoogleCloudDiscoveryengineV1alphaSafetyRating", "description": "Safety rating corresponding to the generated content.", "type": "object", "properties": { "category": { "description": "Output only. Harm category.", "readOnly": true, "type": "string", "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." ], "enum": [ "HARM_CATEGORY_UNSPECIFIED", "HARM_CATEGORY_HATE_SPEECH", "HARM_CATEGORY_DANGEROUS_CONTENT", "HARM_CATEGORY_HARASSMENT", "HARM_CATEGORY_SEXUALLY_EXPLICIT", "HARM_CATEGORY_CIVIC_INTEGRITY" ] }, "probability": { "description": "Output only. Harm probability levels in the content.", "readOnly": true, "type": "string", "enumDescriptions": [ "Harm probability unspecified.", "Negligible level of harm.", "Low level of harm.", "Medium level of harm.", "High level of harm." ], "enum": [ "HARM_PROBABILITY_UNSPECIFIED", "NEGLIGIBLE", "LOW", "MEDIUM", "HIGH" ] }, "probabilityScore": { "description": "Output only. Harm probability score.", "readOnly": true, "type": "number", "format": "float" }, "severity": { "description": "Output only. Harm severity levels in the content.", "readOnly": true, "type": "string", "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" ] }, "severityScore": { "description": "Output only. Harm severity score.", "readOnly": true, "type": "number", "format": "float" }, "blocked": { "description": "Output only. Indicates whether the content was filtered out because of this rating.", "readOnly": true, "type": "boolean" } } }, "GoogleCloudDiscoveryengineV1alphaSession": { "id": "GoogleCloudDiscoveryengineV1alphaSession", "description": "External session proto definition.", "type": "object", "properties": { "name": { "description": "Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*`", "type": "string" }, "displayName": { "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.", "type": "string" }, "state": { "description": "The state of the session.", "type": "string", "enumDescriptions": [ "State is unspecified.", "The session is currently open." ], "enum": [ "STATE_UNSPECIFIED", "IN_PROGRESS" ] }, "userPseudoId": { "description": "A unique identifier for tracking users.", "type": "string" }, "turns": { "description": "Turns.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaSessionTurn" } }, "labels": { "description": "Optional. The labels for the session. Can be set as filter in ListSessionsRequest.", "type": "array", "items": { "type": "string" } }, "startTime": { "description": "Output only. The time the session started.", "readOnly": true, "type": "string", "format": "google-datetime" }, "endTime": { "description": "Output only. The time the session finished.", "readOnly": true, "type": "string", "format": "google-datetime" }, "isPinned": { "description": "Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list.", "type": "boolean" }, "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" } } }, "GoogleCloudDiscoveryengineV1alphaSessionTurn": { "id": "GoogleCloudDiscoveryengineV1alphaSessionTurn", "description": "Represents a turn, including a query from the user and a answer from service.", "type": "object", "properties": { "query": { "description": "Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn", "$ref": "GoogleCloudDiscoveryengineV1alphaQuery" }, "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" }, "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.", "readOnly": true, "$ref": "GoogleCloudDiscoveryengineV1alphaAnswer" }, "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" }, "queryConfig": { "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.", "type": "object", "additionalProperties": { "type": "string" } }, "live": { "description": "Optional. Indicates whether this turn is a live turn.", "type": "boolean" } } }, "GoogleCloudDiscoveryengineV1alphaObtainCrawlRateRequest": { "id": "GoogleCloudDiscoveryengineV1alphaObtainCrawlRateRequest", "description": "Request message for CrawlRateManagementService.ObtainCrawlRate method.", "type": "object", "properties": { "crawlRateScope": { "description": "Required. The scope of the crawl rate that the user wants to monitor. Currently, only domain and host name are supported. A domain name example: `example.com`. A host name example: `www.example.com`. Please do not include `/` in the domain or host name.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1alphaObtainCrawlRateResponse": { "id": "GoogleCloudDiscoveryengineV1alphaObtainCrawlRateResponse", "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", "properties": { "organicCrawlRateTimeSeries": { "description": "The historical organic crawl rate timeseries data, used for monitoring.", "$ref": "GoogleCloudDiscoveryengineV1alphaOrganicCrawlRateTimeSeries" }, "dedicatedCrawlRateTimeSeries": { "description": "The historical dedicated crawl rate timeseries data, used for monitoring.", "$ref": "GoogleCloudDiscoveryengineV1alphaDedicatedCrawlRateTimeSeries" }, "state": { "description": "Output only. The state of the response.", "readOnly": true, "type": "string", "enumDescriptions": [ "The state is unspecified.", "The state is successful.", "The state is failed." ], "enum": [ "STATE_UNSPECIFIED", "SUCCEEDED", "FAILED" ] }, "error": { "description": "Errors from service when handling the request.", "$ref": "GoogleRpcStatus" } } }, "GoogleCloudDiscoveryengineV1alphaOrganicCrawlRateTimeSeries": { "id": "GoogleCloudDiscoveryengineV1alphaOrganicCrawlRateTimeSeries", "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.", "type": "object", "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": "GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries" }, "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": "GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries" } } }, "GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries": { "id": "GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries", "description": "The historical crawl rate timeseries data, used for monitoring.", "type": "object", "properties": { "qpsTimeSeries": { "description": "The QPS of the crawl rate.", "$ref": "GoogleMonitoringV3TimeSeries" } } }, "GoogleMonitoringV3TimeSeries": { "id": "GoogleMonitoringV3TimeSeries", "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.", "type": "object", "properties": { "metric": { "description": "The associated metric. A fully-specified metric used to identify the time series.", "$ref": "GoogleApiMetric" }, "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" }, "metadata": { "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.", "$ref": "GoogleApiMonitoredResourceMetadata" }, "metricKind": { "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`.", "type": "string", "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." ], "enum": [ "METRIC_KIND_UNSPECIFIED", "GAUGE", "DELTA", "CUMULATIVE" ] }, "valueType": { "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." ], "enum": [ "VALUE_TYPE_UNSPECIFIED", "BOOL", "INT64", "DOUBLE", "STRING", "DISTRIBUTION", "MONEY" ] }, "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`.", "type": "array", "items": { "$ref": "GoogleMonitoringV3Point" } }, "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" }, "description": { "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.", "type": "string" } } }, "GoogleApiMetric": { "id": "GoogleApiMetric", "description": "A specific metric, identified by specifying values for all of the labels of a `MetricDescriptor`.", "type": "object", "properties": { "type": { "description": "An existing metric type, see google.api.MetricDescriptor. For example, `custom.googleapis.com/invoice/paid/amount`.", "type": "string" }, "labels": { "description": "The set of label values that uniquely identify this metric. All labels listed in the `MetricDescriptor` must be assigned values.", "type": "object", "additionalProperties": { "type": "string" } } } }, "GoogleApiMonitoredResource": { "id": "GoogleApiMonitoredResource", "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\" }}", "type": "object", "properties": { "type": { "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`.", "type": "string" }, "labels": { "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", "additionalProperties": { "type": "string" } } } }, "GoogleApiMonitoredResourceMetadata": { "id": "GoogleApiMonitoredResourceMetadata", "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.", "type": "object", "properties": { "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 }", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "userLabels": { "description": "Output only. A map of user-defined metadata labels.", "type": "object", "additionalProperties": { "type": "string" } } } }, "GoogleMonitoringV3Point": { "id": "GoogleMonitoringV3Point", "description": "A single data point in a time series.", "type": "object", "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" } } }, "GoogleMonitoringV3TimeInterval": { "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.", "type": "object", "properties": { "endTime": { "description": "Required. The end of the time interval.", "type": "string", "format": "google-datetime" }, "startTime": { "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.", "type": "string", "format": "google-datetime" } } }, "GoogleMonitoringV3TypedValue": { "id": "GoogleMonitoringV3TypedValue", "description": "A single strongly-typed value.", "type": "object", "properties": { "boolValue": { "description": "A Boolean value: `true` or `false`.", "type": "boolean" }, "int64Value": { "description": "A 64-bit integer. Its range is approximately ±9.2x1018.", "type": "string", "format": "int64" }, "doubleValue": { "description": "A 64-bit double-precision floating-point number. Its magnitude is approximately ±10±300 and it has 16 significant digits of precision.", "type": "number", "format": "double" }, "stringValue": { "description": "A variable-length string value.", "type": "string" }, "distributionValue": { "description": "A distribution value.", "$ref": "GoogleApiDistribution" } } }, "GoogleApiDistribution": { "id": "GoogleApiDistribution", "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.", "type": "object", "properties": { "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.", "type": "string", "format": "int64" }, "mean": { "description": "The arithmetic mean of the values in the population. If `count` is zero then this field must be zero.", "type": "number", "format": "double" }, "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.", "type": "number", "format": "double" }, "range": { "description": "If specified, contains the range of the population values. The field must not be present if the `count` is zero.", "$ref": "GoogleApiDistributionRange" }, "bucketOptions": { "description": "Defines the histogram bucket boundaries. If the distribution does not contain a histogram, then omit this field.", "$ref": "GoogleApiDistributionBucketOptions" }, "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).", "type": "array", "items": { "type": "string", "format": "int64" } }, "exemplars": { "description": "Must be in increasing order of `value` field.", "type": "array", "items": { "$ref": "GoogleApiDistributionExemplar" } } } }, "GoogleApiDistributionRange": { "id": "GoogleApiDistributionRange", "description": "The range of the population values.", "type": "object", "properties": { "min": { "description": "The minimum of the population values.", "type": "number", "format": "double" }, "max": { "description": "The maximum of the population values.", "type": "number", "format": "double" } } }, "GoogleApiDistributionBucketOptions": { "id": "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.", "type": "object", "properties": { "linearBuckets": { "description": "The linear bucket.", "$ref": "GoogleApiDistributionBucketOptionsLinear" }, "exponentialBuckets": { "description": "The exponential buckets.", "$ref": "GoogleApiDistributionBucketOptionsExponential" }, "explicitBuckets": { "description": "The explicit buckets.", "$ref": "GoogleApiDistributionBucketOptionsExplicit" } } }, "GoogleApiDistributionBucketOptionsLinear": { "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", "properties": { "numFiniteBuckets": { "description": "Must be greater than 0.", "type": "integer", "format": "int32" }, "width": { "description": "Must be greater than 0.", "type": "number", "format": "double" }, "offset": { "description": "Lower bound of the first bucket.", "type": "number", "format": "double" } } }, "GoogleApiDistributionBucketOptionsExponential": { "id": "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)).", "type": "object", "properties": { "numFiniteBuckets": { "description": "Must be greater than 0.", "type": "integer", "format": "int32" }, "growthFactor": { "description": "Must be greater than 1.", "type": "number", "format": "double" }, "scale": { "description": "Must be greater than 0.", "type": "number", "format": "double" } } }, "GoogleApiDistributionBucketOptionsExplicit": { "id": "GoogleApiDistributionBucketOptionsExplicit", "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", "properties": { "bounds": { "description": "The values must be monotonically increasing.", "type": "array", "items": { "type": "number", "format": "double" } } } }, "GoogleApiDistributionExemplar": { "id": "GoogleApiDistributionExemplar", "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.", "type": "object", "properties": { "value": { "description": "Value of the exemplar point. This value determines to which bucket the exemplar belongs.", "type": "number", "format": "double" }, "timestamp": { "description": "The observation (sampling) time of the above value.", "type": "string", "format": "google-datetime" }, "attachments": { "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.", "type": "array", "items": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } } } } }, "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": { "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": "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" }, "userTriggeredCrawlErrorRate": { "description": "Vertex AI's error rate time series of user triggered dedicated crawl.", "$ref": "GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries" }, "autoRefreshCrawlErrorRate": { "description": "Vertex AI's error rate time series of auto-refresh dedicated crawl.", "$ref": "GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries" } } }, "GoogleCloudDiscoveryengineV1alphaSetDedicatedCrawlRateRequest": { "id": "GoogleCloudDiscoveryengineV1alphaSetDedicatedCrawlRateRequest", "description": "Request message for CrawlRateManagementService.SetDedicatedCrawlRate method. The user can set the crawl rate for a crawl_rate_scope they own. They can set up an overall crawl rate, or set up a user-triggered crawl rate and a auto-refresh crawl rate separately. If an overall crawl rate is set, Vertex AI will automatically splits crawl_rate into user-triggered and auto-refresh.", "type": "object", "properties": { "crawlRateScope": { "description": "Required. The scope of the crawl rate that the user wants to config. Currently, only domain and host name are supported. A domain name example: `example.com`. A host name example: `www.example.com`. Please do not include `/` in the domain or host name.", "type": "string" }, "crawlRate": { "description": "Optional. The crawl QPS set by the user. It is not guaranteed that Vertex crawl bot will crawl at this QPS. If the crawl rate is too high, the real QPS may be lower than the value set by the user to avoid overloading the user's website.", "type": "integer", "format": "int32" }, "crawlType": { "description": "Optional. Whether it's the crawl rate of user-triggered or auto-refresh.", "type": "string", "enumDescriptions": [ "The crawl type is unspecified.", "The crawl type is user-triggered.", "The crawl type is auto-refresh." ], "enum": [ "CRAWL_TYPE_UNSPECIFIED", "USER_TRIGGERED", "AUTO_REFRESH" ] }, "mode": { "description": "Optional. Whether the rate is explicitly set by users, or set by vertex AI.", "type": "string", "enumDescriptions": [ "The mode is unspecified. If the user does not specify the mode, default to AUTOMATIC.", "Vertex AI automatically splits crawl_rate into user-triggered and auto-refresh. Users don't need to specify SetDedicatedCrawlRateRequest.CrawlType if the mode is AUTOMATIC.", "Users explicitly set user-triggered or auto-refresh crawl rate." ], "enum": [ "MODE_UNSPECIFIED", "AUTOMATIC", "EXPLICIT" ] } } }, "GoogleCloudDiscoveryengineV1alphaRemoveDedicatedCrawlRateRequest": { "id": "GoogleCloudDiscoveryengineV1alphaRemoveDedicatedCrawlRateRequest", "description": "Request message for CrawlRateManagementService.RemoveDedicatedCrawlRate method. The user can remove the dedicated crawl rate for a crawl_rate_scope they own, and Google will fall back to organic crawl, and the crawl rate will be determined by Google.", "type": "object", "properties": { "crawlRateScope": { "description": "Required. The scope of the crawl rate change. Currently, only domain and host name are supported. A domain name example: `example.com`. A host name example: `www.example.com`. Please do not include `/` in the domain or host name.", "type": "string" } } }, "GoogleApiHttpBody": { "id": "GoogleApiHttpBody", "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.", "type": "object", "properties": { "contentType": { "description": "The HTTP Content-Type header value specifying the content type of the body.", "type": "string" }, "data": { "description": "The HTTP request/response body as raw binary.", "type": "string", "format": "byte" }, "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." } } } } }, "GoogleCloudDiscoveryengineV1alphaSetUpDataConnectorRequest": { "id": "GoogleCloudDiscoveryengineV1alphaSetUpDataConnectorRequest", "description": "Request for DataConnectorService.SetUpDataConnector method.", "type": "object", "properties": { "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" }, "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.", "type": "string" }, "dataConnector": { "description": "Required. The DataConnector to initialize in the newly created Collection.", "$ref": "GoogleCloudDiscoveryengineV1alphaDataConnector" } } }, "GoogleCloudDiscoveryengineV1alphaListConnectorRunsResponse": { "id": "GoogleCloudDiscoveryengineV1alphaListConnectorRunsResponse", "description": "Response for DataConnectorService.ListConnectorRuns method.", "type": "object", "properties": { "connectorRuns": { "description": "List of ConnectorRuns.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaConnectorRun" } }, "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" } } }, "GoogleCloudDiscoveryengineV1alphaConnectorRun": { "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. //", "type": "object", "properties": { "name": { "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, "type": "string" }, "startTime": { "description": "Output only. The time when the connector run started.", "readOnly": true, "type": "string", "format": "google-datetime" }, "endTime": { "description": "Output only. The time when the connector run ended.", "readOnly": true, "type": "string", "format": "google-datetime" }, "state": { "description": "Output only. The state of the sync run.", "readOnly": true, "type": "string", "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." ], "enum": [ "STATE_UNSPECIFIED", "RUNNING", "SUCCEEDED", "FAILED", "OVERRUN", "CANCELLED", "PENDING", "WARNING", "SKIPPED" ] }, "errors": { "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.", "type": "array", "items": { "$ref": "GoogleRpcStatus" } }, "stateUpdateTime": { "description": "Timestamp at which the connector run sync state was last updated.", "type": "string", "format": "google-datetime" }, "latestPauseTime": { "description": "Output only. The time when the connector run was most recently paused.", "readOnly": true, "type": "string", "format": "google-datetime" }, "entityRuns": { "description": "Output only. The details of the entities synced at the ConnectorRun. Each ConnectorRun consists of syncing one or more entities.", "readOnly": true, "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRun" } }, "trigger": { "description": "Output only. The trigger for this ConnectorRun.", "readOnly": true, "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." ], "enum": [ "TRIGGER_UNSPECIFIED", "SCHEDULER", "INITIALIZATION", "RESUME", "MANUAL" ] } } }, "GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRun": { "id": "GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRun", "description": "Represents an entity that was synced in this ConnectorRun.", "type": "object", "properties": { "entityName": { "description": "The name of the source entity.", "type": "string" }, "state": { "description": "The state of the entity's sync run.", "type": "string", "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." ], "enum": [ "STATE_UNSPECIFIED", "RUNNING", "SUCCEEDED", "FAILED", "OVERRUN", "CANCELLED", "PENDING", "WARNING", "SKIPPED" ] }, "errors": { "description": "The errors from the entity's sync run. Only exist if running into an error state. Contains error code and error message.", "type": "array", "items": { "$ref": "GoogleRpcStatus" } }, "stateUpdateTime": { "description": "Timestamp at which the entity sync state was last updated.", "type": "string", "format": "google-datetime" }, "scheduledRecordCount": { "description": "Optional. The number of documents scheduled to be crawled/extracted from connector source. This only applies to third party connectors.", "type": "string", "format": "int64" }, "extractedRecordCount": { "description": "Optional. The number of documents extracted from connector source, ready to be ingested to VAIS.", "type": "string", "format": "int64" }, "indexedRecordCount": { "description": "Optional. The number of documents indexed.", "type": "string", "format": "int64" }, "errorRecordCount": { "description": "Optional. The total number of documents failed at sync at indexing stage.", "type": "string", "format": "int64" }, "sourceApiRequestCount": { "description": "Optional. The number of requests sent to 3p API.", "type": "string", "format": "int64" }, "deletedRecordCount": { "description": "Optional. The number of documents deleted.", "type": "string", "format": "int64" }, "progress": { "description": "Metadata to generate the progress bar.", "$ref": "GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRunProgress" }, "statsUpdateTime": { "description": "The timestamp for either extracted_documents_count, indexed_documents_count and error_documents_count was last updated.", "type": "string", "format": "google-datetime" }, "syncType": { "description": "Sync type of this run.", "type": "string", "enumDescriptions": [ "Sync type unspecified.", "Sync triggers full sync of all documents.", "Incremental sync of updated documents.", "Realtime sync.", "Scala sync." ], "enum": [ "SYNC_TYPE_UNSPECIFIED", "FULL", "INCREMENTAL", "REALTIME", "SCALA_SYNC" ] } } }, "GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRunProgress": { "id": "GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRunProgress", "description": "Represents the progress of a sync run.", "type": "object", "properties": { "currentCount": { "description": "The current progress.", "type": "string", "format": "int64" }, "totalCount": { "description": "The total.", "type": "string", "format": "int64" }, "percentile": { "description": "Derived. The percentile of the progress.current_count / total_count. The value is between [0, 1.0] inclusive.", "type": "number", "format": "float" } } }, "GoogleCloudDiscoveryengineV1alphaStartConnectorRunRequest": { "id": "GoogleCloudDiscoveryengineV1alphaStartConnectorRunRequest", "description": "Request message for DataConnectorService.StartConnectorRun method.", "type": "object", "properties": { "entities": { "description": "Specifies which Third Party Connector entities should be synced. If not specified, all entities will be synced.", "type": "array", "items": { "type": "string" } }, "syncIdentity": { "description": "If true, trigger Identity sync.", "type": "boolean" }, "syncSinceTimestamp": { "description": "Timestamp to indicate the point in time from which data should be synced for Streaming/Batch Data Connectors. This field is only utilized for Healthcare Connectors.", "type": "string", "format": "google-datetime" }, "healthcareFhirResourceTypes": { "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.", "type": "array", "items": { "type": "string" } }, "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" } } }, "GoogleCloudDiscoveryengineV1alphaCheckRefreshTokenResponse": { "id": "GoogleCloudDiscoveryengineV1alphaCheckRefreshTokenResponse", "description": "Response message for the DataConnectorService.CheckRefreshToken method.", "type": "object", "properties": { "refreshTokenInfo": { "description": "Info about the stored refresh token.", "$ref": "GoogleCloudDiscoveryengineV1alphaRefreshTokenInfo" } } }, "GoogleCloudDiscoveryengineV1alphaRefreshTokenInfo": { "id": "GoogleCloudDiscoveryengineV1alphaRefreshTokenInfo", "description": "Describes a refresh token.", "type": "object", "properties": { "name": { "description": "Required. The connection for which this token applies.", "type": "string" }, "scopes": { "description": "The list of scopes for this token.", "type": "array", "items": { "type": "string" } } } }, "GoogleCloudDiscoveryengineV1alphaAcquireAccessTokenRequest": { "id": "GoogleCloudDiscoveryengineV1alphaAcquireAccessTokenRequest", "description": "Request message for the DataConnectorService.AcquireAccessToken method.", "type": "object", "properties": { "scope": { "description": "Optional. The scope to request for the access token. Scope will override default scope if specified.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1alphaAcquireAccessTokenResponse": { "id": "GoogleCloudDiscoveryengineV1alphaAcquireAccessTokenResponse", "description": "Response message for the DataConnectorService.AcquireAccessToken method.", "type": "object", "properties": { "refreshTokenInfo": { "description": "Info about the stored refresh token used to create the access token.", "$ref": "GoogleCloudDiscoveryengineV1alphaRefreshTokenInfo" }, "accessToken": { "description": "The created access token.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1alphaGetConnectorSecretResponse": { "id": "GoogleCloudDiscoveryengineV1alphaGetConnectorSecretResponse", "description": "Response message for DataConnectorService.GetConnectorSecret.", "type": "object", "properties": { "app": { "description": "The app name of the associated Connector.", "type": "string" }, "instance": { "description": "The instance name of the associated Connector.", "type": "string" }, "tenantId": { "description": "The tenant id of the associated Connector.", "type": "string" }, "clientId": { "description": "The client id of the associated Connector.", "type": "string" }, "redirectUri": { "description": "The redirect url of the associated Connector.", "type": "string" }, "authorizationUri": { "description": "The authorization uri for the data connector.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1alphaDataStore": { "id": "GoogleCloudDiscoveryengineV1alphaDataStore", "description": "DataStore captures global settings and configs at the DataStore level.", "type": "object", "properties": { "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" }, "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" }, "industryVertical": { "description": "Immutable. The industry vertical that the data store registers.", "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" ] }, "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": { "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." ], "enum": [ "SOLUTION_TYPE_UNSPECIFIED", "SOLUTION_TYPE_RECOMMENDATION", "SOLUTION_TYPE_SEARCH", "SOLUTION_TYPE_CHAT", "SOLUTION_TYPE_GENERATIVE_CHAT", "SOLUTION_TYPE_AI_MODE" ] } }, "defaultSchemaId": { "description": "Output only. The id of the default Schema associated to this data store.", "readOnly": true, "type": "string" }, "contentConfig": { "description": "Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.", "type": "string", "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." ], "enum": [ "CONTENT_CONFIG_UNSPECIFIED", "NO_CONTENT", "CONTENT_REQUIRED", "PUBLIC_WEBSITE", "GOOGLE_WORKSPACE" ] }, "createTime": { "description": "Output only. Timestamp the DataStore was created at.", "readOnly": true, "type": "string", "format": "google-datetime" }, "advancedSiteSearchConfig": { "description": "Optional. Configuration for advanced site search.", "$ref": "GoogleCloudDiscoveryengineV1alphaAdvancedSiteSearchConfig" }, "languageInfo": { "description": "Language info for DataStore.", "$ref": "GoogleCloudDiscoveryengineV1alphaLanguageInfo" }, "naturalLanguageQueryUnderstandingConfig": { "description": "Optional. Configuration for Natural Language Query Understanding.", "$ref": "GoogleCloudDiscoveryengineV1alphaNaturalLanguageQueryUnderstandingConfig" }, "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" }, "cmekConfig": { "description": "Output only. CMEK-related information for the DataStore.", "readOnly": true, "$ref": "GoogleCloudDiscoveryengineV1alphaCmekConfig" }, "idpConfig": { "description": "Output only. Data store level identity provider config.", "readOnly": true, "$ref": "GoogleCloudDiscoveryengineV1alphaIdpConfig" }, "billingEstimation": { "description": "Output only. Data size estimation for billing.", "readOnly": true, "$ref": "GoogleCloudDiscoveryengineV1alphaDataStoreBillingEstimation" }, "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" }, "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" }, "documentProcessingConfig": { "description": "Configuration for Document understanding and enrichment.", "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig" }, "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": "GoogleCloudDiscoveryengineV1alphaSchema" }, "healthcareFhirConfig": { "description": "Optional. Configuration for `HEALTHCARE_FHIR` vertical.", "$ref": "GoogleCloudDiscoveryengineV1alphaHealthcareFhirConfig" }, "servingConfigDataStore": { "description": "Optional. Stores serving config at DataStore level.", "$ref": "GoogleCloudDiscoveryengineV1alphaDataStoreServingConfigDataStore" }, "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" }, "isInfobotFaqDataStore": { "description": "Optional. If set, this DataStore is an Infobot FAQ DataStore.", "type": "boolean" }, "federatedSearchConfig": { "description": "Optional. If set, this DataStore is a federated search DataStore.", "$ref": "GoogleCloudDiscoveryengineV1alphaDataStoreFederatedSearchConfig" }, "configurableBillingApproach": { "description": "Optional. Configuration for configurable billing approach. See", "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." ], "enum": [ "CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED", "CONFIGURABLE_SUBSCRIPTION_INDEXING_CORE", "CONFIGURABLE_CONSUMPTION_EMBEDDING" ] }, "configurableBillingApproachUpdateTime": { "description": "Output only. The timestamp when configurable_billing_approach was last updated.", "readOnly": true, "type": "string", "format": "google-datetime" }, "dataProtectionPolicy": { "description": "Optional. Specifies the data protection policy for the data store.", "$ref": "GoogleCloudDiscoveryengineV1alphaDataProtectionPolicy" } } }, "GoogleCloudDiscoveryengineV1alphaAdvancedSiteSearchConfig": { "id": "GoogleCloudDiscoveryengineV1alphaAdvancedSiteSearchConfig", "description": "Configuration data for advance site search.", "type": "object", "properties": { "disableInitialIndex": { "description": "If set true, initial indexing is disabled for the DataStore.", "type": "boolean" }, "disableAutomaticRefresh": { "description": "If set true, automatic refresh is disabled for the DataStore.", "type": "boolean" } } }, "GoogleCloudDiscoveryengineV1alphaLanguageInfo": { "id": "GoogleCloudDiscoveryengineV1alphaLanguageInfo", "description": "Language info for DataStore.", "type": "object", "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`.", "readOnly": true, "type": "string" }, "language": { "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, "type": "string" }, "region": { "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, "type": "string" } } }, "GoogleCloudDiscoveryengineV1alphaNaturalLanguageQueryUnderstandingConfig": { "id": "GoogleCloudDiscoveryengineV1alphaNaturalLanguageQueryUnderstandingConfig", "description": "Configuration for Natural Language Query Understanding.", "type": "object", "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" ] } } }, "GoogleCloudDiscoveryengineV1alphaDataStoreBillingEstimation": { "id": "GoogleCloudDiscoveryengineV1alphaDataStoreBillingEstimation", "description": "Estimation of data size per data store.", "type": "object", "properties": { "structuredDataSize": { "description": "Data size for structured data in terms of bytes.", "type": "string", "format": "int64" }, "unstructuredDataSize": { "description": "Data size for unstructured data in terms of bytes.", "type": "string", "format": "int64" }, "websiteDataSize": { "description": "Data size for websites in terms of bytes.", "type": "string", "format": "int64" }, "structuredDataUpdateTime": { "description": "Last updated timestamp for structured data.", "type": "string", "format": "google-datetime" }, "unstructuredDataUpdateTime": { "description": "Last updated timestamp for unstructured data.", "type": "string", "format": "google-datetime" }, "websiteDataUpdateTime": { "description": "Last updated timestamp for websites.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudDiscoveryengineV1alphaWorkspaceConfig": { "id": "GoogleCloudDiscoveryengineV1alphaWorkspaceConfig", "description": "Config to store data store type configuration for workspace data", "type": "object", "properties": { "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" ], "enum": [ "TYPE_UNSPECIFIED", "GOOGLE_DRIVE", "GOOGLE_MAIL", "GOOGLE_SITES", "GOOGLE_CALENDAR", "GOOGLE_CHAT", "GOOGLE_GROUPS", "GOOGLE_KEEP", "GOOGLE_PEOPLE" ] }, "dasherCustomerId": { "description": "Obfuscated Dasher customer ID.", "type": "string" }, "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" } } }, "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig": { "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.", "type": "object", "properties": { "name": { "description": "The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`.", "type": "string" }, "chunkingConfig": { "description": "Whether chunking mode is enabled.", "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig" }, "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": { "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": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig" } } } }, "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig": { "id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig", "description": "Configuration for chunking config.", "type": "object", "properties": { "layoutBasedChunkingConfig": { "description": "Configuration for the layout based chunking.", "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig" } } }, "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig": { "id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", "description": "Configuration for the layout based chunking.", "type": "object", "properties": { "chunkSize": { "description": "The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500.", "type": "integer", "format": "int32" }, "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" } } }, "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig": { "id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig", "description": "Related configurations applied to a specific type of document parser.", "type": "object", "properties": { "digitalParsingConfig": { "description": "Configurations applied to digital parser.", "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigDigitalParsingConfig" }, "ocrParsingConfig": { "description": "Configurations applied to OCR parser. Currently it only applies to PDFs.", "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig" }, "layoutParsingConfig": { "description": "Configurations applied to layout parser.", "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig" } } }, "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigDigitalParsingConfig": { "id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigDigitalParsingConfig", "description": "The digital parsing configurations for documents.", "type": "object", "properties": {} }, "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig": { "id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig", "description": "The OCR parsing configurations for documents.", "type": "object", "properties": { "enhancedDocumentElements": { "description": "[DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`.", "deprecated": true, "type": "array", "items": { "type": "string" } }, "useNativeText": { "description": "If true, will use native text instead of OCR text on pages containing native text.", "type": "boolean" } } }, "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": { "description": "Optional. If true, the LLM based annotation is added to the image during parsing.", "type": "boolean" }, "enableLlmLayoutParsing": { "description": "Optional. If true, the pdf layout will be refined using an LLM.", "type": "boolean" }, "structuredContentTypes": { "description": "Optional. Contains the required structure types to extract from the document. Supported values: * `shareholder-structure`", "type": "array", "items": { "type": "string" } }, "excludeHtmlElements": { "description": "Optional. List of HTML elements to exclude from the parsed content.", "type": "array", "items": { "type": "string" } }, "excludeHtmlClasses": { "description": "Optional. List of HTML classes to exclude from the parsed content.", "type": "array", "items": { "type": "string" } }, "excludeHtmlIds": { "description": "Optional. List of HTML ids to exclude from the parsed content.", "type": "array", "items": { "type": "string" } }, "enableGetProcessedDocument": { "description": "Optional. If true, the processed document will be made available for the GetProcessedDocument API.", "type": "boolean" } } }, "GoogleCloudDiscoveryengineV1alphaDataStoreServingConfigDataStore": { "id": "GoogleCloudDiscoveryengineV1alphaDataStoreServingConfigDataStore", "description": "Stores information regarding the serving configurations at DataStore level.", "type": "object", "properties": { "disabledForServing": { "description": "Optional. If set true, the DataStore will not be available for serving search requests.", "type": "boolean" } } }, "GoogleCloudDiscoveryengineV1alphaDataStoreFederatedSearchConfig": { "id": "GoogleCloudDiscoveryengineV1alphaDataStoreFederatedSearchConfig", "description": "Stores information for federated search.", "type": "object", "properties": { "alloyDbConfig": { "description": "AlloyDB config. If set, this DataStore is connected to AlloyDB.", "$ref": "GoogleCloudDiscoveryengineV1alphaDataStoreFederatedSearchConfigAlloyDbConfig" }, "thirdPartyOauthConfig": { "description": "Third Party OAuth config. If set, this DataStore is connected to a third party application.", "$ref": "GoogleCloudDiscoveryengineV1alphaDataStoreFederatedSearchConfigThirdPartyOauthConfig" }, "notebooklmConfig": { "description": "NotebookLM config. If set, this DataStore is connected to NotebookLM Enterprise.", "$ref": "GoogleCloudDiscoveryengineV1alphaDataStoreFederatedSearchConfigNotebooklmConfig" } } }, "GoogleCloudDiscoveryengineV1alphaDataStoreFederatedSearchConfigAlloyDbConfig": { "id": "GoogleCloudDiscoveryengineV1alphaDataStoreFederatedSearchConfigAlloyDbConfig", "description": "Stores information for connecting to AlloyDB.", "type": "object", "properties": { "alloydbConnectionConfig": { "description": "Required. Configuration for connecting to AlloyDB.", "$ref": "GoogleCloudDiscoveryengineV1alphaDataStoreFederatedSearchConfigAlloyDbConfigAlloyDbConnectionConfig" }, "alloydbAiNlConfig": { "description": "Optional. Configuration for Magic.", "$ref": "GoogleCloudDiscoveryengineV1alphaDataStoreFederatedSearchConfigAlloyDbConfigAlloyDbAiNaturalLanguageConfig" }, "returnedFields": { "description": "Optional. Fields to be returned in the search results. If empty, all fields will be returned.", "type": "array", "items": { "type": "string" } } } }, "GoogleCloudDiscoveryengineV1alphaDataStoreFederatedSearchConfigAlloyDbConfigAlloyDbConnectionConfig": { "id": "GoogleCloudDiscoveryengineV1alphaDataStoreFederatedSearchConfigAlloyDbConfigAlloyDbConnectionConfig", "description": "Configuration for connecting to AlloyDB.", "type": "object", "properties": { "instance": { "description": "Required. The AlloyDB instance to connect to.", "type": "string" }, "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" }, "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" }, "authMode": { "description": "Optional. Auth mode.", "type": "string", "enumDescriptions": [ "", "Uses P4SA when VAIS talks to AlloyDB.", "Uses EUC when VAIS talks to AlloyDB." ], "enum": [ "AUTH_MODE_UNSPECIFIED", "AUTH_MODE_SERVICE_ACCOUNT", "AUTH_MODE_END_USER_ACCOUNT" ] }, "enablePsvs": { "description": "Optional. If true, enable PSVS for AlloyDB.", "type": "boolean" } } }, "GoogleCloudDiscoveryengineV1alphaDataStoreFederatedSearchConfigAlloyDbConfigAlloyDbAiNaturalLanguageConfig": { "id": "GoogleCloudDiscoveryengineV1alphaDataStoreFederatedSearchConfigAlloyDbConfigAlloyDbAiNaturalLanguageConfig", "description": "Configuration for AlloyDB AI Natural Language.", "type": "object", "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" } } }, "GoogleCloudDiscoveryengineV1alphaDataStoreFederatedSearchConfigThirdPartyOauthConfig": { "id": "GoogleCloudDiscoveryengineV1alphaDataStoreFederatedSearchConfigThirdPartyOauthConfig", "description": "Stores information for third party applicationOAuth.", "type": "object", "properties": { "appName": { "description": "Optional. The type of the application. E.g., \"jira\", \"box\", etc.", "type": "string" }, "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" } } }, "GoogleCloudDiscoveryengineV1alphaDataStoreFederatedSearchConfigNotebooklmConfig": { "id": "GoogleCloudDiscoveryengineV1alphaDataStoreFederatedSearchConfigNotebooklmConfig", "description": "Config for connecting to NotebookLM Enterprise.", "type": "object", "properties": { "searchConfig": { "description": "Required. Search config name. Format: projects/*/locations/global/notebookLmSearchConfigs/*", "type": "string" } } }, "GoogleCloudDiscoveryengineV1alphaListDataStoresResponse": { "id": "GoogleCloudDiscoveryengineV1alphaListDataStoresResponse", "description": "Response message for DataStoreService.ListDataStores method.", "type": "object", "properties": { "dataStores": { "description": "All the customer's DataStores.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaDataStore" } }, "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" } } }, "GoogleCloudDiscoveryengineV1alphaAddPatientFilterRequest": { "id": "GoogleCloudDiscoveryengineV1alphaAddPatientFilterRequest", "description": "Request for DataStoreService.AddPatientFilter method.", "type": "object", "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 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.", "type": "array", "items": { "type": "string" } } } }, "GoogleCloudDiscoveryengineV1alphaRemovePatientFilterRequest": { "id": "GoogleCloudDiscoveryengineV1alphaRemovePatientFilterRequest", "description": "Request for DataStoreService.RemovePatientFilter method.", "type": "object", "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" }, "filterGroups": { "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", "items": { "type": "string" } } } }, "GoogleCloudDiscoveryengineV1alphaDeletePatientFiltersRequest": { "id": "GoogleCloudDiscoveryengineV1alphaDeletePatientFiltersRequest", "description": "Request for DataStoreService.DeletePatientFilters method.", "type": "object", "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" } } }, "GoogleCloudDiscoveryengineV1alphaReplacePatientFilterRequest": { "id": "GoogleCloudDiscoveryengineV1alphaReplacePatientFilterRequest", "description": "Request for DataStoreService.ReplacePatientFilter method.", "type": "object", "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.", "type": "array", "items": { "type": "string" } } } }, "GoogleCloudDiscoveryengineV1alphaListDocumentsResponse": { "id": "GoogleCloudDiscoveryengineV1alphaListDocumentsResponse", "description": "Response message for DocumentService.ListDocuments method.", "type": "object", "properties": { "documents": { "description": "The Documents.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaDocument" } }, "nextPageToken": { "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.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1alphaImportDocumentsRequest": { "id": "GoogleCloudDiscoveryengineV1alphaImportDocumentsRequest", "description": "Request message for Import methods.", "type": "object", "properties": { "inlineSource": { "description": "The Inline source for the input content for documents.", "$ref": "GoogleCloudDiscoveryengineV1alphaImportDocumentsRequestInlineSource" }, "gcsSource": { "description": "Cloud Storage location for the input content.", "$ref": "GoogleCloudDiscoveryengineV1alphaGcsSource" }, "bigquerySource": { "description": "BigQuery input source.", "$ref": "GoogleCloudDiscoveryengineV1alphaBigQuerySource" }, "fhirStoreSource": { "description": "FhirStore input source.", "$ref": "GoogleCloudDiscoveryengineV1alphaFhirStoreSource" }, "spannerSource": { "description": "Spanner input source.", "$ref": "GoogleCloudDiscoveryengineV1alphaSpannerSource" }, "cloudSqlSource": { "description": "Cloud SQL input source.", "$ref": "GoogleCloudDiscoveryengineV1alphaCloudSqlSource" }, "firestoreSource": { "description": "Firestore input source.", "$ref": "GoogleCloudDiscoveryengineV1alphaFirestoreSource" }, "alloyDbSource": { "description": "AlloyDB input source.", "$ref": "GoogleCloudDiscoveryengineV1alphaAlloyDbSource" }, "bigtableSource": { "description": "Cloud Bigtable input source.", "$ref": "GoogleCloudDiscoveryengineV1alphaBigtableSource" }, "errorConfig": { "description": "The desired location of errors incurred during the Import.", "$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig" }, "reconciliationMode": { "description": "The mode of reconciliation between existing documents and the documents to be imported. Defaults to ReconciliationMode.INCREMENTAL.", "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." ], "enum": [ "RECONCILIATION_MODE_UNSPECIFIED", "INCREMENTAL", "FULL" ] }, "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" }, "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" }, "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" }, "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" } } }, "GoogleCloudDiscoveryengineV1alphaImportDocumentsRequestInlineSource": { "id": "GoogleCloudDiscoveryengineV1alphaImportDocumentsRequestInlineSource", "description": "The inline source for the input config for ImportDocuments method.", "type": "object", "properties": { "documents": { "description": "Required. A list of documents to update/create. Each document must have a valid Document.id. Recommended max of 100 items.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaDocument" } } } }, "GoogleCloudDiscoveryengineV1alphaFhirStoreSource": { "id": "GoogleCloudDiscoveryengineV1alphaFhirStoreSource", "description": "Cloud FhirStore source import data from.", "type": "object", "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": { "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.", "type": "array", "items": { "type": "string" } }, "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" } } }, "GoogleCloudDiscoveryengineV1alphaSpannerSource": { "id": "GoogleCloudDiscoveryengineV1alphaSpannerSource", "description": "The Spanner source for importing data", "type": "object", "properties": { "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" }, "instanceId": { "description": "Required. The instance ID of the source Spanner table.", "type": "string" }, "databaseId": { "description": "Required. The database ID of the source Spanner table.", "type": "string" }, "tableId": { "description": "Required. The table name of the Spanner database that needs to be imported.", "type": "string" }, "enableDataBoost": { "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).", "type": "boolean" } } }, "GoogleCloudDiscoveryengineV1alphaCloudSqlSource": { "id": "GoogleCloudDiscoveryengineV1alphaCloudSqlSource", "description": "Cloud SQL source import data from.", "type": "object", "properties": { "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" }, "instanceId": { "description": "Required. The Cloud SQL instance 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" }, "tableId": { "description": "Required. The Cloud SQL table 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 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" }, "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" } } }, "GoogleCloudDiscoveryengineV1alphaFirestoreSource": { "id": "GoogleCloudDiscoveryengineV1alphaFirestoreSource", "description": "Firestore source import data from.", "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" }, "databaseId": { "description": "Required. The Firestore database to copy the data from with a length limit of 256 characters.", "type": "string" }, "collectionId": { "description": "Required. The Firestore collection (or entity) to copy the data from with a length limit of 1,500 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" } } }, "GoogleCloudDiscoveryengineV1alphaAlloyDbSource": { "id": "GoogleCloudDiscoveryengineV1alphaAlloyDbSource", "description": "AlloyDB source import data from.", "type": "object", "properties": { "projectId": { "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.", "type": "string" }, "locationId": { "description": "Required. The AlloyDB location to copy the data from with a length limit of 256 characters.", "type": "string" }, "clusterId": { "description": "Required. The AlloyDB cluster to copy the data from with a length limit of 256 characters.", "type": "string" }, "databaseId": { "description": "Required. The AlloyDB database to copy the data from with a length limit of 256 characters.", "type": "string" }, "tableId": { "description": "Required. The AlloyDB table to copy the data from with a length limit of 256 characters.", "type": "string" }, "gcsStagingDir": { "description": "Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the AlloyDB export to a specific Cloud Storage directory. Ensure that the AlloyDB service account has the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1alphaBigtableSource": { "id": "GoogleCloudDiscoveryengineV1alphaBigtableSource", "description": "The Cloud Bigtable source for importing data.", "type": "object", "properties": { "projectId": { "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.", "type": "string" }, "instanceId": { "description": "Required. The instance ID of the Cloud Bigtable that needs to be imported.", "type": "string" }, "tableId": { "description": "Required. The table ID of the Cloud Bigtable that needs to be imported.", "type": "string" }, "bigtableOptions": { "description": "Required. Bigtable options that contains information needed when parsing data into typed structures. For example, column type annotations.", "$ref": "GoogleCloudDiscoveryengineV1alphaBigtableOptions" } } }, "GoogleCloudDiscoveryengineV1alphaBigtableOptions": { "id": "GoogleCloudDiscoveryengineV1alphaBigtableOptions", "description": "The Bigtable Options object that contains information to support the import.", "type": "object", "properties": { "keyFieldName": { "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": "string" }, "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": "GoogleCloudDiscoveryengineV1alphaBigtableOptionsBigtableColumnFamily" } } } }, "GoogleCloudDiscoveryengineV1alphaBigtableOptionsBigtableColumnFamily": { "id": "GoogleCloudDiscoveryengineV1alphaBigtableOptionsBigtableColumnFamily", "description": "The column family of the Bigtable.", "type": "object", "properties": { "fieldName": { "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": "string" }, "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", "enumDescriptions": [ "The encoding is unspecified.", "Text encoding.", "Binary encoding." ], "enum": [ "ENCODING_UNSPECIFIED", "TEXT", "BINARY" ] }, "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`.", "type": "string", "enumDescriptions": [ "The type is unspecified.", "String type.", "Numerical type.", "Integer type.", "Variable length integer type.", "BigDecimal type.", "Boolean type.", "JSON type." ], "enum": [ "TYPE_UNSPECIFIED", "STRING", "NUMBER", "INTEGER", "VAR_INTEGER", "BIG_NUMERIC", "BOOLEAN", "JSON" ] }, "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": "GoogleCloudDiscoveryengineV1alphaBigtableOptionsBigtableColumn" } } } }, "GoogleCloudDiscoveryengineV1alphaBigtableOptionsBigtableColumn": { "id": "GoogleCloudDiscoveryengineV1alphaBigtableOptionsBigtableColumn", "description": "The column of the Bigtable.", "type": "object", "properties": { "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" }, "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" }, "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", "enumDescriptions": [ "The encoding is unspecified.", "Text encoding.", "Binary encoding." ], "enum": [ "ENCODING_UNSPECIFIED", "TEXT", "BINARY" ] }, "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`.", "type": "string", "enumDescriptions": [ "The type is unspecified.", "String type.", "Numerical type.", "Integer type.", "Variable length integer type.", "BigDecimal type.", "Boolean type.", "JSON type." ], "enum": [ "TYPE_UNSPECIFIED", "STRING", "NUMBER", "INTEGER", "VAR_INTEGER", "BIG_NUMERIC", "BOOLEAN", "JSON" ] } } }, "GoogleCloudDiscoveryengineV1alphaPurgeDocumentsRequest": { "id": "GoogleCloudDiscoveryengineV1alphaPurgeDocumentsRequest", "description": "Request message for DocumentService.PurgeDocuments method.", "type": "object", "properties": { "gcsSource": { "description": "Cloud Storage location for the input content. Supported `data_schema`: * `document_id`: One valid Document.id per line.", "$ref": "GoogleCloudDiscoveryengineV1alphaGcsSource" }, "inlineSource": { "description": "Inline source for the input content for purge.", "$ref": "GoogleCloudDiscoveryengineV1alphaPurgeDocumentsRequestInlineSource" }, "filter": { "description": "Required. Filter matching documents to purge. Only currently supported value is `*` (all items).", "type": "string" }, "errorConfig": { "description": "The desired location of errors incurred during the purge.", "$ref": "GoogleCloudDiscoveryengineV1alphaPurgeErrorConfig" }, "force": { "description": "Actually performs the purge. If `force` is set to false, return the expected purge count without deleting any documents.", "type": "boolean" } } }, "GoogleCloudDiscoveryengineV1alphaPurgeDocumentsRequestInlineSource": { "id": "GoogleCloudDiscoveryengineV1alphaPurgeDocumentsRequestInlineSource", "description": "The inline source for the input config for DocumentService.PurgeDocuments method.", "type": "object", "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" } } } }, "GoogleCloudDiscoveryengineV1alphaPurgeErrorConfig": { "id": "GoogleCloudDiscoveryengineV1alphaPurgeErrorConfig", "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" } } }, "GoogleCloudDiscoveryengineV1alphaProcessedDocument": { "id": "GoogleCloudDiscoveryengineV1alphaProcessedDocument", "description": "Document captures all raw metadata information of items to be recommended or searched.", "type": "object", "properties": { "jsonData": { "description": "The JSON string representation of the processed document.", "type": "string" }, "document": { "description": "Required. Full resource name of the referenced document, in the format `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1alphaBatchGetDocumentsMetadataResponse": { "id": "GoogleCloudDiscoveryengineV1alphaBatchGetDocumentsMetadataResponse", "description": "Response message for DocumentService.BatchGetDocumentsMetadata method.", "type": "object", "properties": { "documentsMetadata": { "description": "The metadata of the Documents.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaBatchGetDocumentsMetadataResponseDocumentMetadata" } } } }, "GoogleCloudDiscoveryengineV1alphaBatchGetDocumentsMetadataResponseDocumentMetadata": { "id": "GoogleCloudDiscoveryengineV1alphaBatchGetDocumentsMetadataResponseDocumentMetadata", "description": "The metadata of a Document.", "type": "object", "properties": { "matcherValue": { "description": "The value of the matcher that was used to match the Document.", "$ref": "GoogleCloudDiscoveryengineV1alphaBatchGetDocumentsMetadataResponseDocumentMetadataMatcherValue" }, "state": { "description": "The state of the document.", "type": "string", "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." ], "enum": [ "STATE_UNSPECIFIED", "INDEXED", "NOT_IN_TARGET_SITE", "NOT_IN_INDEX" ] }, "lastRefreshedTime": { "description": "The timestamp of the last time the Document was last indexed.", "type": "string", "format": "google-datetime" }, "dataIngestionSource": { "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.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1alphaBatchGetDocumentsMetadataResponseDocumentMetadataMatcherValue": { "id": "GoogleCloudDiscoveryengineV1alphaBatchGetDocumentsMetadataResponseDocumentMetadataMatcherValue", "description": "The value of the matcher that was used to match the Document.", "type": "object", "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" } } }, "GoogleCloudDiscoveryengineV1alphaEngine": { "id": "GoogleCloudDiscoveryengineV1alphaEngine", "description": "Metadata that describes the training and serving parameters of an Engine.", "type": "object", "properties": { "similarDocumentsConfig": { "description": "Additional config specs for a `similar-items` engine.", "$ref": "GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig" }, "chatEngineConfig": { "description": "Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.", "$ref": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig" }, "searchEngineConfig": { "description": "Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.", "$ref": "GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig" }, "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" }, "recommendationMetadata": { "description": "Output only. Additional information of a recommendation engine. Only applicable if solution_type is SOLUTION_TYPE_RECOMMENDATION.", "readOnly": true, "$ref": "GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata" }, "chatEngineMetadata": { "description": "Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.", "readOnly": true, "$ref": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadata" }, "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" }, "displayName": { "description": "Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.", "type": "string" }, "createTime": { "description": "Output only. Timestamp the Recommendation Engine was created at.", "readOnly": true, "type": "string", "format": "google-datetime" }, "updateTime": { "description": "Output only. Timestamp the Recommendation Engine was last updated.", "readOnly": true, "type": "string", "format": "google-datetime" }, "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.", "type": "array", "items": { "type": "string" } }, "solutionType": { "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." ], "enum": [ "SOLUTION_TYPE_UNSPECIFIED", "SOLUTION_TYPE_RECOMMENDATION", "SOLUTION_TYPE_SEARCH", "SOLUTION_TYPE_CHAT", "SOLUTION_TYPE_GENERATIVE_CHAT", "SOLUTION_TYPE_AI_MODE" ] }, "industryVertical": { "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.", "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" ] }, "commonConfig": { "description": "Common config spec that specifies the metadata of the engine.", "$ref": "GoogleCloudDiscoveryengineV1alphaEngineCommonConfig" }, "knowledgeGraphConfig": { "description": "Optional. Configurations for the Knowledge Graph. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.", "$ref": "GoogleCloudDiscoveryengineV1alphaEngineKnowledgeGraphConfig" }, "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.", "type": "string", "enumDescriptions": [ "All non specified apps.", "App type for intranet search and Agentspace." ], "enum": [ "APP_TYPE_UNSPECIFIED", "APP_TYPE_INTRANET" ] }, "disableAnalytics": { "description": "Optional. Whether to disable analytics for searches performed on this engine.", "type": "boolean" }, "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` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-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` * `disable-canvas-workspace` * `disable-skills` * `enable-end-user-sharing-with-groups`", "type": "object", "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" ] } }, "cmekConfig": { "description": "Output only. CMEK-related information for the Engine.", "readOnly": true, "$ref": "GoogleCloudDiscoveryengineV1alphaCmekConfig" }, "configurableBillingApproach": { "description": "Optional. Configuration for configurable billing approach.", "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." ], "enum": [ "CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED", "CONFIGURABLE_BILLING_APPROACH_ENABLED" ] }, "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.", "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" ] } }, "observabilityConfig": { "description": "Optional. Observability config for the engine.", "$ref": "GoogleCloudDiscoveryengineV1alphaObservabilityConfig" }, "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.", "type": "object", "additionalProperties": { "type": "string" } }, "agentGatewaySetting": { "description": "Optional. The agent gateway setting for the engine.", "$ref": "GoogleCloudDiscoveryengineV1alphaAgentGatewaySetting" }, "marketplaceAgentVisibility": { "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." ], "enum": [ "MARKETPLACE_AGENT_VISIBILITY_UNSPECIFIED", "SHOW_AVAILABLE_AGENTS_ONLY", "SHOW_AGENTS_ALREADY_INTEGRATED", "SHOW_AGENTS_ALREADY_PURCHASED", "SHOW_ALL_AGENTS" ] }, "procurementContactEmails": { "description": "Optional. The emails of the procurement contacts.", "type": "array", "items": { "type": "string" } } } }, "GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig": { "id": "GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig", "description": "Additional config specs for a `similar-items` engine.", "type": "object", "properties": {} }, "GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig": { "id": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig", "description": "Configurations for a Chat Engine.", "type": "object", "properties": { "agentCreationConfig": { "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.", "$ref": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig" }, "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" } } }, "GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig": { "id": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig", "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": { "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": { "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" }, "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" }, "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" } } }, "GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig": { "id": "GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig", "description": "Configurations for a Search Engine.", "type": "object", "properties": { "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.", "type": "string", "enumDescriptions": [ "Default value when the enum is unspecified. This is invalid to use.", "Standard tier.", "Enterprise tier." ], "enum": [ "SEARCH_TIER_UNSPECIFIED", "SEARCH_TIER_STANDARD", "SEARCH_TIER_ENTERPRISE" ] }, "requiredSubscriptionTier": { "description": "Optional. The required subscription tier of this engine. They cannot be modified after engine creation. If the required subscription tier is search, user with higher license tier like assist can still access the standalone app associated with this engine.", "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." ], "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" ] }, "searchAddOns": { "description": "The add-on that this search engine enables.", "type": "array", "items": { "type": "string", "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" ] } } } }, "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig": { "id": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig", "description": "Additional config specs for a Media Recommendation engine.", "type": "object", "properties": { "type": { "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`.", "type": "string" }, "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" }, "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": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig" }, "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.", "type": "string", "enumDescriptions": [ "Unspecified training state.", "The engine training is paused.", "The engine is training." ], "enum": [ "TRAINING_STATE_UNSPECIFIED", "PAUSED", "TRAINING" ] }, "engineFeaturesConfig": { "description": "Optional. Additional engine features config.", "$ref": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigEngineFeaturesConfig" } } }, "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig": { "id": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig", "description": "Custom threshold for `cvr` optimization_objective.", "type": "object", "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" } } }, "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigEngineFeaturesConfig": { "id": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigEngineFeaturesConfig", "description": "More feature configs of the selected engine type.", "type": "object", "properties": { "recommendedForYouConfig": { "description": "Recommended for you engine feature config.", "$ref": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig" }, "mostPopularConfig": { "description": "Most popular engine feature config.", "$ref": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigMostPopularFeatureConfig" } } }, "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig": { "id": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig", "description": "Additional feature configurations for creating a `recommended-for-you` engine.", "type": "object", "properties": { "contextEventType": { "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`.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigMostPopularFeatureConfig": { "id": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigMostPopularFeatureConfig", "description": "Feature configurations that are required for creating a Most Popular engine.", "type": "object", "properties": { "timeWindowDays": { "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": "string", "format": "int64" } } }, "GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata": { "id": "GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata", "description": "Additional information of a recommendation engine.", "type": "object", "properties": { "servingState": { "description": "Output only. The serving state of the engine: `ACTIVE`, `NOT_ACTIVE`.", "readOnly": true, "type": "string", "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." ], "enum": [ "SERVING_STATE_UNSPECIFIED", "INACTIVE", "ACTIVE", "TUNED" ] }, "dataState": { "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.", "readOnly": true, "type": "string", "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." ], "enum": [ "DATA_STATE_UNSPECIFIED", "DATA_OK", "DATA_ERROR" ] }, "lastTuneTime": { "description": "Output only. The timestamp when the latest successful tune finished. Only applicable on Media Recommendation engines.", "readOnly": true, "type": "string", "format": "google-datetime" }, "lastTrainTime": { "description": "Output only. The timestamp when the latest successful training finished. Only applicable on Media Recommendation engines.", "readOnly": true, "type": "string", "format": "google-datetime" }, "tuningOperation": { "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.", "readOnly": true, "type": "string" } } }, "GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadata": { "id": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadata", "description": "Additional information of a Chat Engine. Fields in this message are output only.", "type": "object", "properties": { "dialogflowAgent": { "description": "The resource name of a Dialogflow agent, that this Chat Engine refers to. Format: `projects//locations//agents/`.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1alphaEngineCommonConfig": { "id": "GoogleCloudDiscoveryengineV1alphaEngineCommonConfig", "description": "Common configurations for an Engine.", "type": "object", "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" } } }, "GoogleCloudDiscoveryengineV1alphaEngineKnowledgeGraphConfig": { "id": "GoogleCloudDiscoveryengineV1alphaEngineKnowledgeGraphConfig", "description": "Configuration message for the Knowledge Graph.", "type": "object", "properties": { "enableCloudKnowledgeGraph": { "description": "Whether to enable the Cloud Knowledge Graph for the engine. Defaults to false if not specified.", "type": "boolean" }, "cloudKnowledgeGraphTypes": { "description": "Specify entity types to support.", "type": "array", "items": { "type": "string" } }, "enablePrivateKnowledgeGraph": { "description": "Whether to enable the Private Knowledge Graph for the engine. Defaults to false if not specified.", "type": "boolean" }, "privateKnowledgeGraphTypes": { "description": "Specify entity types to support.", "type": "array", "items": { "type": "string" } }, "featureConfig": { "description": "Optional. Feature config for the Knowledge Graph.", "$ref": "GoogleCloudDiscoveryengineV1alphaEngineKnowledgeGraphConfigFeatureConfig" } } }, "GoogleCloudDiscoveryengineV1alphaEngineKnowledgeGraphConfigFeatureConfig": { "id": "GoogleCloudDiscoveryengineV1alphaEngineKnowledgeGraphConfigFeatureConfig", "description": "Feature config for the Knowledge Graph.", "type": "object", "properties": { "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" }, "disablePrivateKgAutoComplete": { "description": "Whether to disable the private KG auto complete 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" } } }, "GoogleCloudDiscoveryengineV1alphaAgentGatewaySetting": { "id": "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.", "type": "object", "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" } } }, "GoogleCloudDiscoveryengineV1alphaAgentGatewaySettingAgentGatewayReference": { "id": "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" } } }, "GoogleCloudDiscoveryengineV1alphaListEnginesResponse": { "id": "GoogleCloudDiscoveryengineV1alphaListEnginesResponse", "description": "Response message for EngineService.ListEngines method.", "type": "object", "properties": { "engines": { "description": "All the customer's Engines.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaEngine" } }, "nextPageToken": { "description": "Not supported.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1alphaWorkspaceSettings": { "id": "GoogleCloudDiscoveryengineV1alphaWorkspaceSettings", "description": "Workspace settings for the end user.", "type": "object", "properties": { "workspaceAccessEnabled": { "description": "Whether an end user has workspace access enabled.", "type": "boolean" } } }, "GoogleCloudDiscoveryengineV1alphaPauseEngineRequest": { "id": "GoogleCloudDiscoveryengineV1alphaPauseEngineRequest", "description": "Request for pausing training of an engine.", "type": "object", "properties": {} }, "GoogleCloudDiscoveryengineV1alphaResumeEngineRequest": { "id": "GoogleCloudDiscoveryengineV1alphaResumeEngineRequest", "description": "Request for resuming training of an engine.", "type": "object", "properties": {} }, "GoogleCloudDiscoveryengineV1alphaTuneEngineRequest": { "id": "GoogleCloudDiscoveryengineV1alphaTuneEngineRequest", "description": "Request to manually start a tuning process now (instead of waiting for the periodically scheduled tuning to happen).", "type": "object", "properties": {} }, "GoogleIamV1Policy": { "id": "GoogleIamV1Policy", "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/).", "type": "object", "properties": { "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" }, "bindings": { "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", "items": { "$ref": "GoogleIamV1Binding" } }, "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.", "type": "string", "format": "byte" } } }, "GoogleIamV1Binding": { "id": "GoogleIamV1Binding", "description": "Associates `members`, or principals, with a `role`.", "type": "object", "properties": { "role": { "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).", "type": "string" }, "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`.", "type": "array", "items": { "type": "string" } }, "condition": { "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).", "$ref": "GoogleTypeExpr" } } }, "GoogleTypeExpr": { "id": "GoogleTypeExpr", "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.", "type": "object", "properties": { "expression": { "description": "Textual representation of an expression in Common Expression Language syntax.", "type": "string" }, "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" }, "description": { "description": "Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.", "type": "string" }, "location": { "description": "Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.", "type": "string" } } }, "GoogleIamV1SetIamPolicyRequest": { "id": "GoogleIamV1SetIamPolicyRequest", "description": "Request message for `SetIamPolicy` method.", "type": "object", "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" } } }, "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequest": { "id": "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequest", "description": "Request message for EstimateBillingService.EstimateDataSize method", "type": "object", "properties": { "websiteDataSource": { "description": "Website data.", "$ref": "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestWebsiteDataSource" }, "fileDataSource": { "description": "Structured or unstructured data.", "$ref": "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestFileDataSource" } } }, "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestWebsiteDataSource": { "id": "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestWebsiteDataSource", "description": "Data source is a set of website patterns that we crawl to get the total number of websites.", "type": "object", "properties": { "estimatorUriPatterns": { "description": "Required. The URI patterns to estimate the data sizes. At most 10 patterns are allowed, otherwise an INVALID_ARGUMENT error is thrown.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestWebsiteDataSourceEstimatorUriPattern" } } } }, "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestWebsiteDataSourceEstimatorUriPattern": { "id": "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestWebsiteDataSourceEstimatorUriPattern", "description": "URI patterns that we use to crawl.", "type": "object", "properties": { "providedUriPattern": { "description": "User provided URI pattern. For example, `foo.com/bar/*`.", "type": "string" }, "exactMatch": { "description": "Whether we infer the generated URI or use the exact provided one.", "type": "boolean" }, "exclusive": { "description": "Whether the pattern is exclusive or not. If set to true, the pattern is considered exclusive. If unset or set to false, the pattern is considered inclusive by default.", "type": "boolean" } } }, "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestFileDataSource": { "id": "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestFileDataSource", "description": "Data source contains files either in Cloud Storage or BigQuery.", "type": "object", "properties": { "gcsSource": { "description": "Cloud Storage location for the input content.", "$ref": "GoogleCloudDiscoveryengineV1alphaGcsSource" }, "bigquerySource": { "description": "BigQuery input source.", "$ref": "GoogleCloudDiscoveryengineV1alphaBigQuerySource" } } }, "GoogleCloudDiscoveryengineV1alphaEvaluation": { "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.", "type": "object", "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" }, "evaluationSpec": { "description": "Required. The specification of the evaluation.", "$ref": "GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpec" }, "qualityMetrics": { "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.", "readOnly": true, "$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetrics" }, "state": { "description": "Output only. The state of the evaluation.", "readOnly": true, "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." ], "enum": [ "STATE_UNSPECIFIED", "PENDING", "RUNNING", "SUCCEEDED", "FAILED" ] }, "error": { "description": "Output only. The error that occurred during evaluation. Only populated when the evaluation's state is FAILED.", "readOnly": true, "$ref": "GoogleRpcStatus" }, "createTime": { "description": "Output only. Timestamp the Evaluation was created at.", "readOnly": true, "type": "string", "format": "google-datetime" }, "endTime": { "description": "Output only. Timestamp the Evaluation was completed at.", "readOnly": true, "type": "string", "format": "google-datetime" }, "errorSamples": { "description": "Output only. A sample of errors encountered while processing the request.", "readOnly": true, "type": "array", "items": { "$ref": "GoogleRpcStatus" } } } }, "GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpec": { "id": "GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpec", "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": "GoogleCloudDiscoveryengineV1alphaSearchRequest" }, "querySetSpec": { "description": "Optional. The specification of the query set.", "$ref": "GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpecQuerySetSpec" } } }, "GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpecQuerySetSpec": { "id": "GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpecQuerySetSpec", "description": "Describes the specification of the query set.", "type": "object", "properties": { "sampleQuerySet": { "description": "Optional. The full resource name of the SampleQuerySet used for the evaluation, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1alphaQualityMetrics": { "id": "GoogleCloudDiscoveryengineV1alphaQualityMetrics", "description": "Describes the metrics produced by the evaluation.", "type": "object", "properties": { "docRecall": { "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", "$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics" }, "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" }, "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" }, "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": "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics" }, "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" } } }, "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics": { "id": "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics", "description": "Stores the metric values at specific top-k levels.", "type": "object", "properties": { "top1": { "description": "The top-1 value.", "type": "number", "format": "double" }, "top3": { "description": "The top-3 value.", "type": "number", "format": "double" }, "top5": { "description": "The top-5 value.", "type": "number", "format": "double" }, "top10": { "description": "The top-10 value.", "type": "number", "format": "double" } } }, "GoogleCloudDiscoveryengineV1alphaListEvaluationsResponse": { "id": "GoogleCloudDiscoveryengineV1alphaListEvaluationsResponse", "description": "Response message for EvaluationService.ListEvaluations method.", "type": "object", "properties": { "evaluations": { "description": "The Evaluations.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaEvaluation" } }, "nextPageToken": { "description": "A token that can be sent as ListEvaluationsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1alphaListEvaluationResultsResponse": { "id": "GoogleCloudDiscoveryengineV1alphaListEvaluationResultsResponse", "description": "Response message for EvaluationService.ListEvaluationResults method.", "type": "object", "properties": { "evaluationResults": { "description": "The evaluation results for the SampleQuerys.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaListEvaluationResultsResponseEvaluationResult" } }, "nextPageToken": { "description": "A token that can be sent as ListEvaluationResultsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1alphaListEvaluationResultsResponseEvaluationResult": { "id": "GoogleCloudDiscoveryengineV1alphaListEvaluationResultsResponseEvaluationResult", "description": "Represents the results of an evaluation for a single SampleQuery.", "type": "object", "properties": { "sampleQuery": { "description": "Output only. The SampleQuery that was evaluated.", "readOnly": true, "$ref": "GoogleCloudDiscoveryengineV1alphaSampleQuery" }, "qualityMetrics": { "description": "Output only. The metrics produced by the evaluation, for a given SampleQuery.", "readOnly": true, "$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetrics" } } }, "GoogleCloudDiscoveryengineV1alphaSampleQuery": { "id": "GoogleCloudDiscoveryengineV1alphaSampleQuery", "description": "Sample Query captures metadata to be used for evaluation.", "type": "object", "properties": { "queryEntry": { "description": "The query entry.", "$ref": "GoogleCloudDiscoveryengineV1alphaSampleQueryQueryEntry" }, "name": { "description": "Identifier. The full resource name of the sample query, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", "type": "string" }, "createTime": { "description": "Output only. Timestamp the SampleQuery was created at.", "readOnly": true, "type": "string", "format": "google-datetime" } } }, "GoogleCloudDiscoveryengineV1alphaSampleQueryQueryEntry": { "id": "GoogleCloudDiscoveryengineV1alphaSampleQueryQueryEntry", "description": "Query Entry captures metadata to be used for search evaluation.", "type": "object", "properties": { "query": { "description": "Required. The query.", "type": "string" }, "targets": { "description": "List of targets for the query.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaSampleQueryQueryEntryTarget" } } } }, "GoogleCloudDiscoveryengineV1alphaSampleQueryQueryEntryTarget": { "id": "GoogleCloudDiscoveryengineV1alphaSampleQueryQueryEntryTarget", "description": "Defines the parameters of the query's expected outcome.", "type": "object", "properties": { "uri": { "description": "Expected uri of the target. This field must be a UTF-8 encoded string with a length limit of 2048 characters. Example of valid uris: `https://example.com/abc`, `gcs://example/example.pdf`.", "type": "string" }, "pageNumbers": { "description": "Expected page numbers of the target. Each page number must be non negative.", "type": "array", "items": { "type": "integer", "format": "int32" } }, "score": { "description": "Relevance score of the target.", "type": "number", "format": "double" } } }, "GoogleCloudDiscoveryengineV1alphaIdentityMappingStore": { "id": "GoogleCloudDiscoveryengineV1alphaIdentityMappingStore", "description": "Identity Mapping Store which contains Identity Mapping Entries.", "type": "object", "properties": { "name": { "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.", "type": "string" }, "idpConfig": { "description": "Output only. The identity provider configuration this is bound to translate the identity mapping entries within.", "readOnly": true, "$ref": "GoogleCloudDiscoveryengineV1alphaIdpConfig" }, "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" }, "cmekConfig": { "description": "Output only. CMEK-related information for the Identity Mapping Store.", "readOnly": true, "$ref": "GoogleCloudDiscoveryengineV1alphaCmekConfig" } } }, "GoogleCloudDiscoveryengineV1alphaImportIdentityMappingsRequest": { "id": "GoogleCloudDiscoveryengineV1alphaImportIdentityMappingsRequest", "description": "Request message for IdentityMappingStoreService.ImportIdentityMappings", "type": "object", "properties": { "inlineSource": { "description": "The inline source to import identity mapping entries from.", "$ref": "GoogleCloudDiscoveryengineV1alphaImportIdentityMappingsRequestInlineSource" } } }, "GoogleCloudDiscoveryengineV1alphaImportIdentityMappingsRequestInlineSource": { "id": "GoogleCloudDiscoveryengineV1alphaImportIdentityMappingsRequestInlineSource", "description": "The inline source to import identity mapping entries from.", "type": "object", "properties": { "identityMappingEntries": { "description": "A maximum of 10000 entries can be imported at one time", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaIdentityMappingEntry" } } } }, "GoogleCloudDiscoveryengineV1alphaIdentityMappingEntry": { "id": "GoogleCloudDiscoveryengineV1alphaIdentityMappingEntry", "description": "Identity Mapping Entry that maps an external identity to an internal identity.", "type": "object", "properties": { "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": { "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.", "type": "string" }, "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" } } }, "GoogleCloudDiscoveryengineV1alphaPurgeIdentityMappingsRequest": { "id": "GoogleCloudDiscoveryengineV1alphaPurgeIdentityMappingsRequest", "description": "Request message for IdentityMappingStoreService.PurgeIdentityMappings", "type": "object", "properties": { "inlineSource": { "description": "The inline source to purge identity mapping entries from.", "$ref": "GoogleCloudDiscoveryengineV1alphaPurgeIdentityMappingsRequestInlineSource" }, "filter": { "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.", "type": "string" }, "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" } } }, "GoogleCloudDiscoveryengineV1alphaPurgeIdentityMappingsRequestInlineSource": { "id": "GoogleCloudDiscoveryengineV1alphaPurgeIdentityMappingsRequestInlineSource", "description": "The inline source to purge identity mapping entries from.", "type": "object", "properties": { "identityMappingEntries": { "description": "A maximum of 10000 entries can be purged at one time", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaIdentityMappingEntry" } } } }, "GoogleCloudDiscoveryengineV1alphaListIdentityMappingsResponse": { "id": "GoogleCloudDiscoveryengineV1alphaListIdentityMappingsResponse", "description": "Response message for IdentityMappingStoreService.ListIdentityMappings", "type": "object", "properties": { "identityMappingEntries": { "description": "The Identity Mapping Entries.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaIdentityMappingEntry" } }, "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" } } }, "GoogleCloudDiscoveryengineV1alphaListIdentityMappingStoresResponse": { "id": "GoogleCloudDiscoveryengineV1alphaListIdentityMappingStoresResponse", "description": "Response message for IdentityMappingStoreService.ListIdentityMappingStores", "type": "object", "properties": { "identityMappingStores": { "description": "The Identity Mapping Stores.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaIdentityMappingStore" } }, "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" } } }, "GoogleCloudDiscoveryengineV1alphaLicenseConfig": { "id": "GoogleCloudDiscoveryengineV1alphaLicenseConfig", "description": "Information about users' licenses.", "type": "object", "properties": { "name": { "description": "Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project}/locations/{location}/licenseConfigs/{license_config}`", "type": "string" }, "licenseCount": { "description": "Required. Number of licenses purchased.", "type": "string", "format": "int64" }, "subscriptionTier": { "description": "Required. Subscription tier information for the license config.", "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." ], "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" ] }, "state": { "description": "Output only. The state of the license config.", "readOnly": true, "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." ], "enum": [ "STATE_UNSPECIFIED", "ACTIVE", "EXPIRED", "NOT_STARTED", "WITHDRAWN", "DEACTIVATING" ] }, "autoRenew": { "description": "Optional. Whether the license config should be auto renewed when it reaches the end date.", "type": "boolean" }, "startDate": { "description": "Required. The start date.", "$ref": "GoogleTypeDate" }, "endDate": { "description": "Optional. The planed end date.", "$ref": "GoogleTypeDate" }, "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" ] }, "freeTrial": { "description": "Optional. Whether the license config is for free trial.", "type": "boolean" }, "alertPolicyResourceConfig": { "description": "Optional. The alert policy config for this license config.", "$ref": "GoogleCloudDiscoveryengineV1alphaAlertPolicyResourceConfig" }, "geminiBundle": { "description": "Output only. Whether the license config is for Gemini bundle.", "readOnly": true, "type": "boolean" }, "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.", "readOnly": true, "type": "boolean" }, "earlyTerminationDate": { "description": "Output only. The date when the subscription is terminated earlier than the expiration date.", "readOnly": true, "$ref": "GoogleTypeDate" } } }, "GoogleCloudDiscoveryengineV1alphaAlertPolicyResourceConfig": { "id": "GoogleCloudDiscoveryengineV1alphaAlertPolicyResourceConfig", "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", "properties": { "alertPolicy": { "description": "Immutable. The fully qualified resource name of the AlertPolicy.", "type": "string" }, "alertEnrollments": { "description": "Optional. The enrollment state of each alert.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaAlertPolicyResourceConfigAlertEnrollment" } }, "contactDetails": { "description": "Optional. The contact details for each alert policy.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaContactDetails" } }, "languageCode": { "description": "Optional. The language code used for notifications", "type": "string" }, "regionCode": { "description": "Optional. The region code used of the user that subscribed to the alert policy.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1alphaAlertPolicyResourceConfigAlertEnrollment": { "id": "GoogleCloudDiscoveryengineV1alphaAlertPolicyResourceConfigAlertEnrollment", "description": "The alert enrollment status.", "type": "object", "properties": { "alertId": { "description": "Immutable. The id of an alert.", "type": "string" }, "enrollState": { "description": "Required. The enrollment status of a customer.", "type": "string", "enumDescriptions": [ "Default value. Used for customers who have not responded to the alert policy.", "Customer is enrolled in this policy.", "Customer declined this policy." ], "enum": [ "ENROLL_STATE_UNSPECIFIED", "ENROLLED", "DECLINED" ] }, "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.", "type": "object", "additionalProperties": { "type": "string" } } } }, "GoogleCloudDiscoveryengineV1alphaContactDetails": { "id": "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.", "type": "object", "properties": { "emailAddress": { "description": "Optional. The email address of the contact.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1alphaListLicenseConfigsResponse": { "id": "GoogleCloudDiscoveryengineV1alphaListLicenseConfigsResponse", "description": "Response message for LicenseConfigService.ListLicenseConfigs method.", "type": "object", "properties": { "licenseConfigs": { "description": "All the customer's LicenseConfigs.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaLicenseConfig" } }, "nextPageToken": { "description": "Not supported.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1alphaDistributeLicenseConfigRequest": { "id": "GoogleCloudDiscoveryengineV1alphaDistributeLicenseConfigRequest", "description": "Request message for LicenseConfigService.DistributeLicenseConfig method.", "type": "object", "properties": { "projectNumber": { "description": "Required. The target GCP project number to distribute the license config to.", "type": "string", "format": "int64" }, "location": { "description": "Required. The target GCP project region to distribute the license config to.", "type": "string" }, "licenseCount": { "description": "Required. The number of licenses to distribute.", "type": "string", "format": "int64" }, "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" } } }, "GoogleCloudDiscoveryengineV1alphaDistributeLicenseConfigResponse": { "id": "GoogleCloudDiscoveryengineV1alphaDistributeLicenseConfigResponse", "description": "Response message for LicenseConfigService.DistributeLicenseConfig method.", "type": "object", "properties": { "licenseConfig": { "description": "The updated or created LicenseConfig.", "$ref": "GoogleCloudDiscoveryengineV1alphaLicenseConfig" } } }, "GoogleCloudDiscoveryengineV1alphaRetractLicenseConfigRequest": { "id": "GoogleCloudDiscoveryengineV1alphaRetractLicenseConfigRequest", "description": "Request message for LicenseConfigService.RetractLicenseConfig method.", "type": "object", "properties": { "licenseConfig": { "description": "Required. Full resource name of LicenseConfig. Format: `projects/{project}/locations/{location}/licenseConfigs/{license_config_id}`.", "type": "string" }, "fullRetract": { "description": "Optional. If set to true, retract the entire license config. Otherwise, retract the specified license count.", "type": "boolean" }, "licenseCount": { "description": "Optional. The number of licenses to retract. Only used when full_retract is false.", "type": "string", "format": "int64" } } }, "GoogleCloudDiscoveryengineV1alphaRetractLicenseConfigResponse": { "id": "GoogleCloudDiscoveryengineV1alphaRetractLicenseConfigResponse", "description": "Response message for LicenseConfigService.RetractLicenseConfig method.", "type": "object", "properties": { "licenseConfig": { "description": "The updated LicenseConfig.", "$ref": "GoogleCloudDiscoveryengineV1alphaLicenseConfig" } } }, "GoogleCloudDiscoveryengineV1alphaListBillingAccountLicenseConfigsResponse": { "id": "GoogleCloudDiscoveryengineV1alphaListBillingAccountLicenseConfigsResponse", "description": "Response message for LicenseConfigService.ListBillingAccountLicenseConfigs method.", "type": "object", "properties": { "billingAccountLicenseConfigs": { "description": "All BillingAccountLicenseConfigs for the given billing account.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaBillingAccountLicenseConfig" } }, "nextPageToken": { "description": "A token that can be sent as ListBillingAccountLicenseConfigsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1alphaBillingAccountLicenseConfig": { "id": "GoogleCloudDiscoveryengineV1alphaBillingAccountLicenseConfig", "description": "Information about license configs at billing account level.", "type": "object", "properties": { "name": { "description": "Immutable. Identifier. The fully qualified resource name of the billing account license config. Format: `billingAccounts/{billing_account}/billingAccountLicenseConfigs/{billing_account_license_config}`.", "type": "string" }, "licenseCount": { "description": "Required. The number of licenses purchased under this billing account license config.", "type": "string", "format": "int64" }, "licenseConfigDistributions": { "description": "A map of LicenseConfig names to the number of licenses distributed to each. The key is the full resource name of the LicenseConfig, such as `projects/{project}/locations/{location}/licenseConfigs/{license_config}`. The value is the count of licenses allocated to it.", "type": "object", "additionalProperties": { "type": "string", "format": "int64" } }, "subscriptionName": { "description": "Output only. The corresponding SubV3 subscription name.", "readOnly": true, "type": "string" }, "subscriptionTier": { "description": "Required. The subscription tier.", "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." ], "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" ] }, "subscriptionTerm": { "description": "Required. The 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" ] }, "startDate": { "description": "Required. The subscription start date.", "$ref": "GoogleTypeDate" }, "endDate": { "description": "Optional. The planed subscription end date.", "$ref": "GoogleTypeDate" }, "state": { "description": "Output only. The state of the BillingAccountLicenseConfig.", "readOnly": true, "type": "string", "enumDescriptions": [ "The BillingAccountLicenseConfig does not exist. Default value. Do not use.", "The BillingAccountLicenseConfig is active and being used.", "The BillingAccountLicenseConfig has expired.", "The BillingAccountLicenseConfig has not started yet, and its start date is in the future.", "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", "DEACTIVATING" ] }, "autoRenew": { "description": "Whether the BillingAccountLicenseConfig is auto renewed when it reaches the end date.", "type": "boolean" }, "procurementEntitlementId": { "description": "The procurement entitlement id of the subscription.", "type": "string" }, "subscriptionDisplayName": { "description": "The subscription display name.", "type": "string" }, "geminiBundle": { "description": "Whether the license config is for Gemini bundle.", "type": "boolean" }, "earlyTerminated": { "description": "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" }, "earlyTerminationDate": { "description": "The date when the subscription is terminated earlier than the expiration date.", "$ref": "GoogleTypeDate" } } }, "GoogleCloudDiscoveryengineV1alphaProject": { "id": "GoogleCloudDiscoveryengineV1alphaProject", "description": "Metadata and configurations for a Google Cloud project in the service.", "type": "object", "properties": { "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.", "readOnly": true, "type": "string" }, "createTime": { "description": "Output only. The timestamp when this project is created.", "readOnly": true, "type": "string", "format": "google-datetime" }, "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" }, "serviceTermsMap": { "description": "Output only. A map of terms of services. The key is the `id` of ServiceTerms.", "readOnly": true, "type": "object", "additionalProperties": { "$ref": "GoogleCloudDiscoveryengineV1alphaProjectServiceTerms" } }, "customerProvidedConfig": { "description": "Optional. Customer provided configurations.", "$ref": "GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfig" }, "configurableBillingStatus": { "description": "Output only. The current status of the project's configurable billing.", "readOnly": true, "$ref": "GoogleCloudDiscoveryengineV1alphaProjectConfigurableBillingStatus" } } }, "GoogleCloudDiscoveryengineV1alphaProjectServiceTerms": { "id": "GoogleCloudDiscoveryengineV1alphaProjectServiceTerms", "description": "Metadata about the terms of service.", "type": "object", "properties": { "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": { "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.", "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" ] }, "acceptTime": { "description": "The last time when the project agreed to the terms of service.", "type": "string", "format": "google-datetime" }, "declineTime": { "description": "The last time when the project declined or revoked the agreement to terms of service.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfig": { "id": "GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfig", "description": "Customer provided configurations.", "type": "object", "properties": { "notebooklmConfig": { "description": "Optional. Configuration for NotebookLM settings.", "$ref": "GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfig" } } }, "GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfig": { "id": "GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfig", "description": "Configuration for NotebookLM.", "type": "object", "properties": { "modelArmorConfig": { "description": "Model Armor configuration to be used for sanitizing user prompts and LLM responses.", "$ref": "GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig" }, "optOutNotebookSharing": { "description": "Optional. Whether to disable the notebook sharing feature for the project. Default to false if not specified.", "type": "boolean" }, "dataProtectionPolicy": { "description": "Optional. Specifies the data protection policy for NotebookLM.", "$ref": "GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfigDataProtectionPolicy" }, "observabilityConfig": { "description": "Optional. Observability config for NotebookLM.", "$ref": "GoogleCloudDiscoveryengineV1alphaObservabilityConfig" } } }, "GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig": { "id": "GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig", "description": "Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and LLM responses.", "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 LLM responses. Format: projects/{project}/locations/{location}/templates/{template_id} If not specified, no sanitization will be applied to the LLM response.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfigDataProtectionPolicy": { "id": "GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfigDataProtectionPolicy", "description": "Data protection policy config for NotebookLM.", "type": "object", "properties": { "sensitiveDataProtectionPolicy": { "description": "Optional. The sensitive data protection policy.", "$ref": "GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfigDataProtectionPolicySensitiveDataProtectionPolicy" } } }, "GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfigDataProtectionPolicySensitiveDataProtectionPolicy": { "id": "GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfigDataProtectionPolicySensitiveDataProtectionPolicy", "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" } } }, "GoogleCloudDiscoveryengineV1alphaProjectConfigurableBillingStatus": { "id": "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.", "type": "object", "properties": { "effectiveSearchQpmThreshold": { "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.", "type": "string", "format": "int64" }, "effectiveIndexingCoreThreshold": { "description": "Optional. The currently effective Indexing Core threshold. This is the threshold against which Indexing Core usage is compared for overage calculations.", "type": "string", "format": "int64" }, "startTime": { "description": "Optional. The start time of the currently active billing subscription.", "type": "string", "format": "google-datetime" }, "terminateTime": { "description": "Output only. The latest terminate effective time of search qpm and indexing core subscriptions.", "readOnly": true, "type": "string", "format": "google-datetime" }, "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.", "readOnly": true, "type": "string", "format": "google-datetime" }, "indexingCoreThresholdNextUpdateTime": { "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, "type": "string", "format": "google-datetime" }, "updateType": { "description": "Output only. The type of update performed in this operation. This field is populated in the response of UpdateProject.", "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)." ], "enum": [ "UPDATE_TYPE_UNSPECIFIED", "CREATE", "DELETE", "SCALE_UP", "SCALE_DOWN" ] } } }, "GoogleCloudDiscoveryengineV1alphaProvisionProjectRequest": { "id": "GoogleCloudDiscoveryengineV1alphaProvisionProjectRequest", "description": "Request for ProjectService.ProvisionProject method.", "type": "object", "properties": { "acceptDataUseTerms": { "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).", "type": "boolean" }, "dataUseTermsVersion": { "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.", "type": "string" }, "saasParams": { "description": "Optional. Parameters for Agentspace.", "$ref": "GoogleCloudDiscoveryengineV1alphaProvisionProjectRequestSaasParams" } } }, "GoogleCloudDiscoveryengineV1alphaProvisionProjectRequestSaasParams": { "id": "GoogleCloudDiscoveryengineV1alphaProvisionProjectRequestSaasParams", "description": "Parameters for Agentspace.", "type": "object", "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" } } }, "GoogleCloudDiscoveryengineV1alphaReportConsentChangeRequest": { "id": "GoogleCloudDiscoveryengineV1alphaReportConsentChangeRequest", "description": "Request for ReportConsentChange method.", "type": "object", "properties": { "consentChangeAction": { "description": "Required. Whether customer decides to accept or decline service term. At this moment, only accept action is supported.", "type": "string", "enumDescriptions": [ "Invalid action, user must specify accept/decline", "User accepts service terms." ], "enum": [ "CONSENT_CHANGE_ACTION_UNSPECIFIED", "ACCEPT" ] }, "serviceTermId": { "description": "Required. The unique identifier of the terms of service to update. Available term ids: * `GA_DATA_USE_TERMS`: [Terms for data use](https://cloud.google.com/retail/data-use-terms). When using this service term id, the acceptable service_term_version to provide is `2022-11-23`.", "type": "string" }, "serviceTermVersion": { "description": "Required. The version string of the terms of service to update.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1alphaQueryConfigurablePricingUsageStatsResponse": { "id": "GoogleCloudDiscoveryengineV1alphaQueryConfigurablePricingUsageStatsResponse", "description": "Response for [ProjectService.QueryConfigurablePricingUsageStats] method.", "type": "object", "properties": { "metricUsages": { "description": "A list of metric usages, one for each requested resource type that has data in the requested time range.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaQueryConfigurablePricingUsageStatsResponseMetricUsage" } } } }, "GoogleCloudDiscoveryengineV1alphaQueryConfigurablePricingUsageStatsResponseMetricUsage": { "id": "GoogleCloudDiscoveryengineV1alphaQueryConfigurablePricingUsageStatsResponseMetricUsage", "description": "The usage of a metric over a list of days.", "type": "object", "properties": { "metricType": { "description": "The metric type.", "type": "string", "enumDescriptions": [ "Default value.", "Daily median search request QPM.", "Daily min search request QPM.", "Daily max search request QPM.", "Daily search request total.", "Total storage bytes for indexing core." ], "enum": [ "BILLING_METRIC_TYPE_UNSPECIFIED", "DAILY_MDN_QPM", "DAILY_MIN_QPM", "DAILY_MAX_QPM", "DAILY_SEARCH_REQUEST", "TOTAL_STORAGE" ] }, "datedUsages": { "description": "The list of usages for this resource type, chronologically sorted by date. This is populated for metrics with daily aggregation like DAILY_MDN_QPM.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaQueryConfigurablePricingUsageStatsResponseDatedUsage" } }, "totalUsage": { "description": "The total usage for this resource type. This is populated for metrics like TOTAL_STORAGE.", "type": "number", "format": "double" } } }, "GoogleCloudDiscoveryengineV1alphaQueryConfigurablePricingUsageStatsResponseDatedUsage": { "id": "GoogleCloudDiscoveryengineV1alphaQueryConfigurablePricingUsageStatsResponseDatedUsage", "description": "A list of usages for a specific day.", "type": "object", "properties": { "date": { "description": "The date of the usage.", "$ref": "GoogleTypeDate" }, "usage": { "description": "The usage value on the date.", "type": "number", "format": "double" } } }, "GoogleCloudDiscoveryengineV1alphaRankRequest": { "id": "GoogleCloudDiscoveryengineV1alphaRankRequest", "description": "Request message for RankService.Rank method.", "type": "object", "properties": { "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" }, "topN": { "description": "The number of results to return. If this is unset or no bigger than zero, returns all results.", "type": "integer", "format": "int32" }, "query": { "description": "The query to use.", "type": "string" }, "records": { "description": "Required. A list of records to rank.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaRankingRecord" } }, "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" }, "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.", "type": "object", "additionalProperties": { "type": "string" } } } }, "GoogleCloudDiscoveryengineV1alphaRankingRecord": { "id": "GoogleCloudDiscoveryengineV1alphaRankingRecord", "description": "Record message for RankService.Rank method.", "type": "object", "properties": { "id": { "description": "The unique ID to represent the record.", "type": "string" }, "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" }, "content": { "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.", "type": "string" }, "score": { "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", "format": "float" } } }, "GoogleCloudDiscoveryengineV1alphaRankResponse": { "id": "GoogleCloudDiscoveryengineV1alphaRankResponse", "description": "Response message for RankService.Rank method.", "type": "object", "properties": { "records": { "description": "A list of records sorted by descending score.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaRankingRecord" } } } }, "GoogleCloudDiscoveryengineV1alphaRecommendRequest": { "id": "GoogleCloudDiscoveryengineV1alphaRecommendRequest", "description": "Request message for Recommend method.", "type": "object", "properties": { "userEvent": { "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.", "$ref": "GoogleCloudDiscoveryengineV1alphaUserEvent" }, "pageSize": { "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.", "type": "integer", "format": "int32" }, "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" }, "validateOnly": { "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": "boolean" }, "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" } }, "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 [Requirements for labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.", "type": "object", "additionalProperties": { "type": "string" } } } }, "GoogleCloudDiscoveryengineV1alphaUserEvent": { "id": "GoogleCloudDiscoveryengineV1alphaUserEvent", "description": "UserEvent captures all metadata information Discovery Engine API needs to know about how end users interact with your website.", "type": "object", "properties": { "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" }, "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" }, "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" }, "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" }, "dataStore": { "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.", "type": "string" }, "eventTime": { "description": "Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened.", "type": "string", "format": "google-datetime" }, "userInfo": { "description": "Information about the end user.", "$ref": "GoogleCloudDiscoveryengineV1alphaUserInfo" }, "directUserRequest": { "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.", "type": "boolean" }, "sessionId": { "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": "string" }, "pageInfo": { "description": "Page metadata such as categories and other critical information for certain event types such as `view-category-page`.", "$ref": "GoogleCloudDiscoveryengineV1alphaPageInfo" }, "attributionToken": { "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.", "type": "string" }, "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" }, "documents": { "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", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentInfo" } }, "panel": { "description": "Panel metadata associated with this user event.", "$ref": "GoogleCloudDiscoveryengineV1alphaPanelInfo" }, "searchInfo": { "description": "SearchService.Search details related to the event. This field should be set for `search` event.", "$ref": "GoogleCloudDiscoveryengineV1alphaSearchInfo" }, "completionInfo": { "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.", "$ref": "GoogleCloudDiscoveryengineV1alphaCompletionInfo" }, "transactionInfo": { "description": "The transaction metadata (if any) associated with this user event.", "$ref": "GoogleCloudDiscoveryengineV1alphaTransactionInfo" }, "tagIds": { "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.", "type": "array", "items": { "type": "string" } }, "promotionIds": { "description": "The promotion IDs if this is an event associated with promotions. Currently, this field is restricted to at most one ID.", "type": "array", "items": { "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.", "type": "object", "additionalProperties": { "$ref": "GoogleCloudDiscoveryengineV1alphaCustomAttribute" } }, "mediaInfo": { "description": "Media-specific info.", "$ref": "GoogleCloudDiscoveryengineV1alphaMediaInfo" }, "panels": { "description": "Optional. List of panels associated with this event. Used for page-level impression data.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaPanelInfo" } }, "entity": { "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.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1alphaPageInfo": { "id": "GoogleCloudDiscoveryengineV1alphaPageInfo", "description": "Detailed page information.", "type": "object", "properties": { "pageviewId": { "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.", "type": "string" }, "pageCategory": { "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.", "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" }, "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" } } }, "GoogleCloudDiscoveryengineV1alphaDocumentInfo": { "id": "GoogleCloudDiscoveryengineV1alphaDocumentInfo", "description": "Detailed document information associated with a user event.", "type": "object", "properties": { "id": { "description": "The Document resource ID.", "type": "string" }, "name": { "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}`", "type": "string" }, "uri": { "description": "The Document URI - only allowed for website data stores.", "type": "string" }, "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`", "type": "integer", "format": "int32" }, "promotionIds": { "description": "The promotion IDs associated with this Document. Currently, this field is restricted to at most one ID.", "type": "array", "items": { "type": "string" } }, "joined": { "description": "Output only. Whether the referenced Document can be found in the data store.", "readOnly": true, "type": "boolean" }, "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.", "type": "number", "format": "float" } } }, "GoogleCloudDiscoveryengineV1alphaPanelInfo": { "id": "GoogleCloudDiscoveryengineV1alphaPanelInfo", "description": "Detailed panel information associated with a user event.", "type": "object", "properties": { "panelId": { "description": "Required. The panel ID.", "type": "string" }, "displayName": { "description": "The display name of the panel.", "type": "string" }, "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" }, "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" }, "documents": { "description": "Optional. The document IDs associated with this panel.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentInfo" } } } }, "GoogleCloudDiscoveryengineV1alphaSearchInfo": { "id": "GoogleCloudDiscoveryengineV1alphaSearchInfo", "description": "Detailed search information.", "type": "object", "properties": { "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": { "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.", "type": "string" }, "offset": { "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.", "type": "integer", "format": "int32" } } }, "GoogleCloudDiscoveryengineV1alphaCompletionInfo": { "id": "GoogleCloudDiscoveryengineV1alphaCompletionInfo", "description": "Detailed completion information including completion attribution token and clicked completion info.", "type": "object", "properties": { "selectedSuggestion": { "description": "End user selected CompleteQueryResponse.QuerySuggestion.suggestion.", "type": "string" }, "selectedPosition": { "description": "End user selected CompleteQueryResponse.QuerySuggestion.suggestion position, starting from 0.", "type": "integer", "format": "int32" } } }, "GoogleCloudDiscoveryengineV1alphaTransactionInfo": { "id": "GoogleCloudDiscoveryengineV1alphaTransactionInfo", "description": "A transaction represents the entire purchase transaction.", "type": "object", "properties": { "value": { "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.", "type": "number", "format": "float" }, "currency": { "description": "Required. Currency code. Use three-character ISO-4217 code.", "type": "string" }, "transactionId": { "description": "The transaction ID with a length limit of 128 characters.", "type": "string" }, "tax": { "description": "All the taxes associated with the transaction.", "type": "number", "format": "float" }, "cost": { "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", "type": "number", "format": "float" }, "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", "type": "number", "format": "float" } } }, "GoogleCloudDiscoveryengineV1alphaCustomAttribute": { "id": "GoogleCloudDiscoveryengineV1alphaCustomAttribute", "description": "A custom attribute that is not explicitly modeled in a resource, e.g. UserEvent.", "type": "object", "properties": { "text": { "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.", "type": "array", "items": { "type": "string" } }, "numbers": { "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.", "type": "array", "items": { "type": "number", "format": "double" } } } }, "GoogleCloudDiscoveryengineV1alphaMediaInfo": { "id": "GoogleCloudDiscoveryengineV1alphaMediaInfo", "description": "Media-specific user event information.", "type": "object", "properties": { "mediaProgressDuration": { "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.", "type": "string", "format": "google-duration" }, "mediaProgressPercentage": { "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.", "type": "number", "format": "float" } } }, "GoogleCloudDiscoveryengineV1alphaRecommendResponse": { "id": "GoogleCloudDiscoveryengineV1alphaRecommendResponse", "description": "Response message for Recommend method.", "type": "object", "properties": { "results": { "description": "A list of recommended Documents. The order represents the ranking (from the most relevant Document to the least).", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaRecommendResponseRecommendationResult" } }, "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" }, "missingIds": { "description": "IDs of documents in the request that were missing from the default Branch associated with the requested ServingConfig.", "type": "array", "items": { "type": "string" } }, "validateOnly": { "description": "True if RecommendRequest.validate_only was set.", "type": "boolean" } } }, "GoogleCloudDiscoveryengineV1alphaRecommendResponseRecommendationResult": { "id": "GoogleCloudDiscoveryengineV1alphaRecommendResponseRecommendationResult", "description": "RecommendationResult represents a generic recommendation result with associated metadata.", "type": "object", "properties": { "id": { "description": "Resource ID of the recommended Document.", "type": "string" }, "document": { "description": "Set if `returnDocument` is set to true in RecommendRequest.params.", "$ref": "GoogleCloudDiscoveryengineV1alphaDocument" }, "metadata": { "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", "additionalProperties": { "type": "any" } } } }, "GoogleCloudDiscoveryengineV1alphaCheckRequirementRequest": { "id": "GoogleCloudDiscoveryengineV1alphaCheckRequirementRequest", "description": "Request for CheckRequirement method.", "type": "object", "properties": { "requirementType": { "description": "The type specifying the requirement to check. The supported types are: * `discoveryengine.googleapis.com/media_recs/general/all/warning` * `discoveryengine.googleapis.com/media_recs/oyml/cvr/warning` * `discoveryengine.googleapis.com/media_recs/rfy/cvr/warning` * `discoveryengine.googleapis.com/media_recs/mlt/cvr/warning` * `discoveryengine.googleapis.com/media_recs/mp/cvr/warning` * `discoveryengine.googleapis.com/media_recs/oyml/wdps/warning` * `discoveryengine.googleapis.com/media_recs/rfy/wdps/warning` * `discoveryengine.googleapis.com/media_recs/mlt/wdps/warning`", "type": "string" }, "resources": { "description": "The resources to be checked for this requirement. The type needed for the monitored resources: * `discoveryengine.googleapis.com/Branch`. * The labels needed for this resource: * `project_number` * `location_id` * `collection_id` * `datastore_id` * `branch_id` * `discoveryengine.googleapis.com/DataStore` * The labels needed for this resource: * `project_number` * `location_id` * `collection_id` * `datastore_id`", "type": "array", "items": { "$ref": "GoogleApiMonitoredResource" } } } }, "GoogleCloudDiscoveryengineV1alphaCheckRequirementResponse": { "id": "GoogleCloudDiscoveryengineV1alphaCheckRequirementResponse", "description": "Response for the CheckRequirement method.", "type": "object", "properties": { "requirement": { "description": "Requirement definition.", "$ref": "GoogleCloudDiscoveryengineV1alphaRequirement" }, "requirementCondition": { "description": "The condition for evaluating the requirement result.", "$ref": "GoogleTypeExpr" }, "metricResults": { "description": "Metric results.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaCheckRequirementResponseMetricQueryResult" } }, "oldestMetricTimestamp": { "description": "Timestamp of the oldest calculated metric (i.e. the most stale metric). Indicates that the `result` may not accurately reflect any Event and Product Catalog updates performed after this time.", "type": "string", "format": "google-datetime" }, "result": { "description": "The result of the requirement. It should be one of the `severity` fields in the requirement definition. If any error happens during the evaluation, it will be `UNKNOWN`.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1alphaRequirement": { "id": "GoogleCloudDiscoveryengineV1alphaRequirement", "description": "A data requirement.", "type": "object", "properties": { "type": { "description": "The requirement type, used as an identifier. Must be unique. The type should prefix with service name to avoid possible collision. It's encouraged to use natural hierarchical grouping for similar requirements. Examples: * `library.googleapis.com/books/min_available_books` * `discoveryengine.googleapis.com/media_rec/recommended_for_you/conversion_rate`", "type": "string" }, "displayName": { "description": "The name of the requirement.", "type": "string" }, "description": { "description": "The description of the requirement.", "type": "string" }, "condition": { "description": "The condition for evaluating the requirement result. Variables in the expression should be provided by `metrics_bindings` or `threshold_bindings`. Where `metrics_bindings` are used for computed metrics and `threshold_bindings` are used to define thresholds for corresponding `metric_bindings`.", "$ref": "GoogleTypeExpr" }, "metricBindings": { "description": "A list of the metric bindings to be used in `condition`.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaRequirementMetricBinding" } }, "thresholdBindings": { "description": "A list of threshold bindings to be used in `condition`.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaRequirementThresholdBinding" } }, "violationSamplesBindings": { "description": "A list of the metric bindings to be used in `condition`.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaRequirementViolationSamplesBinding" } }, "severity": { "description": "The severity of errors if the requirement is not met. It must be ordered from the most strict to the least strict. Examples: * `BLOCKING` * `CRITICAL` * `WARNING` All thresholds in the requirement must have all the severity here.", "type": "array", "items": { "type": "string" } } } }, "GoogleCloudDiscoveryengineV1alphaRequirementMetricBinding": { "id": "GoogleCloudDiscoveryengineV1alphaRequirementMetricBinding", "description": "Specifies a metrics query and bind its result to a variable which will be used in the `condition`.", "type": "object", "properties": { "variableId": { "description": "The variable id to be referenced in `condition`.", "type": "string" }, "resourceType": { "description": "The resource being monitored for the metric.", "type": "string" }, "metricFilter": { "description": "The filter string used for metrics query. Example: \"metric.type = \\\"discoveryengine.googleapis.com/events/day_count\\\" AND \" \"metric.conditions.time_range = \\\"NINETY_DAYS\\\"\"", "type": "string" }, "description": { "description": "Human readable description of the corresponding metric filter.", "type": "string" }, "category": { "description": "The category of the metric's target resource. Example: \"Events\"", "type": "string" } } }, "GoogleCloudDiscoveryengineV1alphaRequirementThresholdBinding": { "id": "GoogleCloudDiscoveryengineV1alphaRequirementThresholdBinding", "description": "Specifies a multi-level threshold to apply to apply to a `metric_bindings` in the `condition` CEL expression.", "type": "object", "properties": { "variableId": { "description": "The variable id to be referenced in `condition`. Must be unique across all `metric_bindings` and `threshold_bindings`.", "type": "string" }, "description": { "description": "Human readable description of the corresponding threshold and sub-requirement.", "type": "string" }, "thresholdValues": { "description": "The values of the threshold. The values should be ordered from the most strict to the least strict.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaRequirementThresholdBindingThresholdValue" } } } }, "GoogleCloudDiscoveryengineV1alphaRequirementThresholdBindingThresholdValue": { "id": "GoogleCloudDiscoveryengineV1alphaRequirementThresholdBindingThresholdValue", "description": "Specifies a threshold value for a given severity.", "type": "object", "properties": { "severity": { "description": "The severity of errors if the threshold is not met. It should be one of the `severity` fields in the requirement.", "type": "string" }, "value": { "description": "The value of the threshold.", "type": "number", "format": "double" } } }, "GoogleCloudDiscoveryengineV1alphaRequirementViolationSamplesBinding": { "id": "GoogleCloudDiscoveryengineV1alphaRequirementViolationSamplesBinding", "description": "Specifies a samples query and bind its result to a variable which will be used in the `condition`.", "type": "object", "properties": { "variableId": { "description": "The variable id to be referenced in `condition`.", "type": "string" }, "sampleFilter": { "description": "The filter string used for samples query. Example: \"sample.type = \\\"retail.googleapis.com/user_event\\\" AND \" \"sample.labels.event_type = \\\"PURCHASE\\\" \"", "type": "string" }, "description": { "description": "Description of this sample binding. Used by the UI to render user friendly descriptions for each requirement condition. Should be less than 128 characters long.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1alphaCheckRequirementResponseMetricQueryResult": { "id": "GoogleCloudDiscoveryengineV1alphaCheckRequirementResponseMetricQueryResult", "description": "Metric result. The metric are in the requirement_condition.", "type": "object", "properties": { "name": { "description": "This metric query name is mapping to variables in the requirement_condition.", "type": "string" }, "value": { "description": "Value of the metric query.", "$ref": "GoogleMonitoringV3TypedValue" }, "timestamp": { "description": "Time corresponding to when this metric value was calculated.", "type": "string", "format": "google-datetime" }, "unit": { "description": "The unit in which this metric is reported. Follows [The Unified Code for Units of Measure](https://unitsofmeasure.org/ucum.html) standard.", "type": "string" }, "metricType": { "description": "Type identifier of the metric corresponding to this query result.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1alphaListSampleQueriesResponse": { "id": "GoogleCloudDiscoveryengineV1alphaListSampleQueriesResponse", "description": "Response message for SampleQueryService.ListSampleQueries method.", "type": "object", "properties": { "sampleQueries": { "description": "The SampleQuerys.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaSampleQuery" } }, "nextPageToken": { "description": "A token that can be sent as ListSampleQueriesRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1alphaImportSampleQueriesRequest": { "id": "GoogleCloudDiscoveryengineV1alphaImportSampleQueriesRequest", "description": "Request message for SampleQueryService.ImportSampleQueries method.", "type": "object", "properties": { "inlineSource": { "description": "The Inline source for sample query entries.", "$ref": "GoogleCloudDiscoveryengineV1alphaImportSampleQueriesRequestInlineSource" }, "gcsSource": { "description": "Cloud Storage location for the input content.", "$ref": "GoogleCloudDiscoveryengineV1alphaGcsSource" }, "bigquerySource": { "description": "BigQuery input source.", "$ref": "GoogleCloudDiscoveryengineV1alphaBigQuerySource" }, "errorConfig": { "description": "The desired location of errors incurred during the Import.", "$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig" } } }, "GoogleCloudDiscoveryengineV1alphaImportSampleQueriesRequestInlineSource": { "id": "GoogleCloudDiscoveryengineV1alphaImportSampleQueriesRequestInlineSource", "description": "The inline source for SampleQuerys.", "type": "object", "properties": { "sampleQueries": { "description": "Required. A list of SampleQuerys to import. Max of 1000 items.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaSampleQuery" } } } }, "GoogleCloudDiscoveryengineV1alphaSampleQuerySet": { "id": "GoogleCloudDiscoveryengineV1alphaSampleQuerySet", "description": "A SampleQuerySet is the parent resource of SampleQuery, and contains the configurations shared by all SampleQuery under it.", "type": "object", "properties": { "name": { "description": "Identifier. The full resource name of the SampleQuerySet, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", "type": "string" }, "displayName": { "description": "Required. The sample query set display name. This field must be a UTF-8 encoded string with a length limit of 128 characters.", "type": "string" }, "createTime": { "description": "Output only. Timestamp the SampleQuerySet was created at.", "readOnly": true, "type": "string", "format": "google-datetime" }, "description": { "description": "The description of the SampleQuerySet.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1alphaListSampleQuerySetsResponse": { "id": "GoogleCloudDiscoveryengineV1alphaListSampleQuerySetsResponse", "description": "Response message for SampleQuerySetService.ListSampleQuerySets method.", "type": "object", "properties": { "sampleQuerySets": { "description": "The SampleQuerySets.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaSampleQuerySet" } }, "nextPageToken": { "description": "A token that can be sent as ListSampleQuerySetsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1alphaListSchemasResponse": { "id": "GoogleCloudDiscoveryengineV1alphaListSchemasResponse", "description": "Response message for SchemaService.ListSchemas method.", "type": "object", "properties": { "schemas": { "description": "The Schemas.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaSchema" } }, "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" } } }, "GoogleCloudDiscoveryengineV1alphaTrainCustomModelRequest": { "id": "GoogleCloudDiscoveryengineV1alphaTrainCustomModelRequest", "description": "Request message for SearchTuningService.TrainCustomModel method.", "type": "object", "properties": { "gcsTrainingInput": { "description": "Cloud Storage training input.", "$ref": "GoogleCloudDiscoveryengineV1alphaTrainCustomModelRequestGcsTrainingInput" }, "modelType": { "description": "Model to be trained. Supported values are: * **search-tuning**: Fine tuning the search system based on data provided.", "type": "string" }, "errorConfig": { "description": "The desired location of errors incurred during the data ingestion and training.", "$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig" }, "modelId": { "description": "If not provided, a UUID will be generated.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1alphaTrainCustomModelRequestGcsTrainingInput": { "id": "GoogleCloudDiscoveryengineV1alphaTrainCustomModelRequestGcsTrainingInput", "description": "Cloud Storage training data input.", "type": "object", "properties": { "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" }, "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": { "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`", "type": "string" }, "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" } } }, "GoogleCloudDiscoveryengineV1alphaListCustomModelsResponse": { "id": "GoogleCloudDiscoveryengineV1alphaListCustomModelsResponse", "description": "Response message for SearchTuningService.ListCustomModels method.", "type": "object", "properties": { "models": { "description": "List of custom tuning models.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaCustomTuningModel" } } } }, "GoogleCloudDiscoveryengineV1alphaCustomTuningModel": { "id": "GoogleCloudDiscoveryengineV1alphaCustomTuningModel", "description": "Metadata that describes a custom tuned model.", "type": "object", "properties": { "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" }, "displayName": { "description": "The display name of the model.", "type": "string" }, "modelVersion": { "description": "The version of the model.", "type": "string", "format": "int64" }, "modelState": { "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." ], "enum": [ "MODEL_STATE_UNSPECIFIED", "TRAINING_PAUSED", "TRAINING", "TRAINING_COMPLETE", "READY_FOR_SERVING", "TRAINING_FAILED", "NO_IMPROVEMENT", "INPUT_VALIDATION_FAILED" ] }, "createTime": { "description": "Deprecated: Timestamp the Model was created at.", "deprecated": true, "type": "string", "format": "google-datetime" }, "trainingStartTime": { "description": "Timestamp the model training was initiated.", "type": "string", "format": "google-datetime" }, "metrics": { "description": "The metrics of the trained model.", "type": "object", "additionalProperties": { "type": "number", "format": "double" } }, "errorMessage": { "description": "Currently this is only populated if the model state is `INPUT_VALIDATION_FAILED`.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1alphaServingConfig": { "id": "GoogleCloudDiscoveryengineV1alphaServingConfig", "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.", "type": "object", "properties": { "mediaConfig": { "description": "The MediaConfig of the serving configuration.", "$ref": "GoogleCloudDiscoveryengineV1alphaServingConfigMediaConfig" }, "genericConfig": { "description": "The GenericConfig of the serving configuration.", "$ref": "GoogleCloudDiscoveryengineV1alphaServingConfigGenericConfig" }, "name": { "description": "Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}`", "type": "string" }, "displayName": { "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.", "type": "string" }, "solutionType": { "description": "Required. Immutable. Specifies the solution type that a serving config can be associated with.", "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." ], "enum": [ "SOLUTION_TYPE_UNSPECIFIED", "SOLUTION_TYPE_RECOMMENDATION", "SOLUTION_TYPE_SEARCH", "SOLUTION_TYPE_CHAT", "SOLUTION_TYPE_GENERATIVE_CHAT", "SOLUTION_TYPE_AI_MODE" ] }, "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" }, "diversityLevel": { "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.", "type": "string" }, "embeddingConfig": { "description": "Bring your own embedding config. The config is used for search semantic retrieval. The retrieval is based on the dot product of SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document embeddings that are provided by this EmbeddingConfig. If SearchRequest.EmbeddingSpec.EmbeddingVector.vector is provided, it overrides this ServingConfig.embedding_config.", "$ref": "GoogleCloudDiscoveryengineV1alphaEmbeddingConfig" }, "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" }, "guidedSearchSpec": { "description": "Guided search configs.", "$ref": "GoogleCloudDiscoveryengineV1alphaGuidedSearchSpec" }, "customFineTuningSpec": { "description": "Custom fine tuning configs. If SearchRequest.custom_fine_tuning_spec is set, it has higher priority than the configs set here.", "$ref": "GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec" }, "createTime": { "description": "Output only. ServingConfig created timestamp.", "readOnly": true, "type": "string", "format": "google-datetime" }, "updateTime": { "description": "Output only. ServingConfig updated timestamp.", "readOnly": true, "type": "string", "format": "google-datetime" }, "filterControlIds": { "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.", "type": "array", "items": { "type": "string" } }, "boostControlIds": { "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", "items": { "type": "string" } }, "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": { "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.", "type": "array", "items": { "type": "string" } }, "onewaySynonymsControlIds": { "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.", "type": "array", "items": { "type": "string" } }, "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.", "type": "array", "items": { "type": "string" } }, "replacementControlIds": { "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.", "type": "array", "items": { "type": "string" } }, "ignoreControlIds": { "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.", "type": "array", "items": { "type": "string" } }, "promoteControlIds": { "description": "Condition promote specifications. Maximum number of specifications is 100.", "type": "array", "items": { "type": "string" } }, "personalizationSpec": { "description": "The specification for personalization spec. Notice that if both ServingConfig.personalization_spec and SearchRequest.personalization_spec are set, SearchRequest.personalization_spec overrides ServingConfig.personalization_spec.", "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestPersonalizationSpec" }, "answerGenerationSpec": { "description": "Optional. The specification for answer generation.", "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerGenerationSpec" } } }, "GoogleCloudDiscoveryengineV1alphaServingConfigMediaConfig": { "id": "GoogleCloudDiscoveryengineV1alphaServingConfigMediaConfig", "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.", "type": "object", "properties": { "contentWatchedPercentageThreshold": { "description": "Specifies the content watched percentage threshold for demotion. Threshold value must be between [0, 1.0] inclusive.", "type": "number", "format": "float" }, "contentWatchedSecondsThreshold": { "description": "Specifies the content watched minutes threshold for demotion.", "type": "number", "format": "float" }, "demotionEventType": { "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.", "type": "string" }, "demoteContentWatchedPastDays": { "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": "integer", "format": "int32" }, "contentFreshnessCutoffDays": { "description": "Specifies the content freshness used for recommendation result. Contents will be demoted if contents were published for more than content freshness cutoff days.", "type": "integer", "format": "int32" } } }, "GoogleCloudDiscoveryengineV1alphaServingConfigGenericConfig": { "id": "GoogleCloudDiscoveryengineV1alphaServingConfigGenericConfig", "description": "Specifies the configurations needed for Generic Discovery.Currently we support: * `content_search_spec`: configuration for generic content search.", "type": "object", "properties": { "contentSearchSpec": { "description": "Specifies the expected behavior of content search. Only valid for content-search enabled data store.", "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec" } } }, "GoogleCloudDiscoveryengineV1alphaEmbeddingConfig": { "id": "GoogleCloudDiscoveryengineV1alphaEmbeddingConfig", "description": "Defines embedding config, used for bring your own embeddings feature.", "type": "object", "properties": { "fieldPath": { "description": "Full field path in the schema mapped as embedding field.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1alphaGuidedSearchSpec": { "id": "GoogleCloudDiscoveryengineV1alphaGuidedSearchSpec", "description": "Defines guided search spec.", "type": "object", "properties": { "enableRefinementAttributes": { "description": "Whether or not to enable and include refinement attributes in gudied search result.", "type": "boolean" }, "enableRelatedQuestions": { "description": "Whether or not to enable and include related questions in search response.", "type": "boolean" }, "maxRelatedQuestions": { "description": "Max number of related questions to be returned. The valid range is [1, 5]. If enable_related_questions is true, the default value is 3.", "type": "integer", "format": "int32" } } }, "GoogleCloudDiscoveryengineV1alphaAnswerGenerationSpec": { "id": "GoogleCloudDiscoveryengineV1alphaAnswerGenerationSpec", "description": "The specification for answer generation.", "type": "object", "properties": { "userDefinedClassifierSpec": { "description": "Optional. The specification for user specified classifier spec.", "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerGenerationSpecUserDefinedClassifierSpec" } } }, "GoogleCloudDiscoveryengineV1alphaAnswerGenerationSpecUserDefinedClassifierSpec": { "id": "GoogleCloudDiscoveryengineV1alphaAnswerGenerationSpecUserDefinedClassifierSpec", "description": "The specification for user defined classifier.", "type": "object", "properties": { "enableUserDefinedClassifier": { "description": "Optional. Whether or not to enable and include user defined classifier.", "type": "boolean" }, "preamble": { "description": "Optional. The preamble to be used for the user defined classifier.", "type": "string" }, "modelId": { "description": "Optional. The model id to be used for the user defined classifier.", "type": "string" }, "taskMarker": { "description": "Optional. The task marker to be used for the user defined classifier.", "type": "string" }, "topP": { "description": "Optional. The top-p value to be used for the user defined classifier.", "type": "number", "format": "double" }, "topK": { "description": "Optional. The top-k value to be used for the user defined classifier.", "type": "string", "format": "int64" }, "temperature": { "description": "Optional. The temperature value to be used for the user defined classifier.", "type": "number", "format": "double" }, "seed": { "description": "Optional. The seed value to be used for the user defined classifier.", "type": "integer", "format": "int32" } } }, "GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse": { "id": "GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse", "description": "Response for ListServingConfigs method.", "type": "object", "properties": { "servingConfigs": { "description": "All the ServingConfigs for a given dataStore.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaServingConfig" } }, "nextPageToken": { "description": "Pagination token, if not returned indicates the last page.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1alphaListSessionsResponse": { "id": "GoogleCloudDiscoveryengineV1alphaListSessionsResponse", "description": "Response for ListSessions method.", "type": "object", "properties": { "sessions": { "description": "All the Sessions for a given data store.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaSession" } }, "nextPageToken": { "description": "Pagination token, if not returned indicates the last page.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1alphaListFilesResponse": { "id": "GoogleCloudDiscoveryengineV1alphaListFilesResponse", "description": "Response message for SessionService.ListFiles method.", "type": "object", "properties": { "files": { "description": "The FileMetadatas.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaFileMetadata" } }, "nextPageToken": { "description": "A token to retrieve next page of results. Pass this value in the ListFilesRequest.page_token field in the subsequent call to `ListFiles` method to retrieve the next page of results.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1alphaFileMetadata": { "id": "GoogleCloudDiscoveryengineV1alphaFileMetadata", "description": "Represents a file attached to a session (context file)", "type": "object", "properties": { "fileId": { "description": "Output only. The ID of the file.", "readOnly": true, "type": "string" }, "name": { "description": "Output only. The name of the file uploaded.", "readOnly": true, "type": "string" }, "mimeType": { "description": "The content type of the file, see https://www.iana.org/assignments/media-types/media-types.xhtml.", "type": "string" }, "byteSize": { "description": "Output only. The size of the context file in bytes.", "readOnly": true, "type": "string", "format": "int64" }, "originalUri": { "description": "Optional. The original location of the file. It may be a local file path, or any other URI that allows accessing the file in an external system. There are two scenarios in which this url may be empty: 1. If the file was sent as inline data (e.g. pasted from the clipboard). 2. If the original location is not available. Note that there's no guarantee that the URI will be pointing to a valid or actually existing file. For example, a file might have been uploaded to the session, and then deleted from the original source.", "type": "string" }, "originalSourceType": { "description": "Optional. The type of the original source of the file.", "type": "string", "enumDescriptions": [ "Default value. Unknown source.", "The data of the file was provided inline (e.g. pasted from the clipboard).", "The file was uploaded from a local file.", "The file was uploaded from Cloud Storage.", "The file was uploaded from Drive.", "The file was retrieved from a URL (e.g. public web)." ], "enum": [ "FILE_SOURCE_UNSPECIFIED", "FILE_SOURCE_INLINE", "FILE_SOURCE_LOCAL", "FILE_SOURCE_CLOUD_STORAGE", "FILE_SOURCE_CLOUD_DRIVE", "FILE_SOURCE_URL" ] }, "uploadTime": { "description": "Output only. The time the file was uploaded (If this is a file generated by an internal process and then made available to the session, this indicates the moment it happened).", "readOnly": true, "type": "string", "format": "google-datetime" }, "lastAddTime": { "description": "Output only. The time the file was added to the session. Note that if a file was added, then modified externally, then added again, the add time will be updated.", "readOnly": true, "type": "string", "format": "google-datetime" }, "metadata": { "description": "Optional. Represents metadata related to the file that can suit particular use cases. The prefix \"google.\" is reserved for the key for use by Google, but other prefixes can be freely used.", "type": "object", "additionalProperties": { "type": "string" } }, "downloadUri": { "description": "Output only. The AssistantService.DownloadSessionFile URL to download the file. This URL will need the same credentials as AssistantService.ListSessionFileMetadata method and will provide the resource.", "readOnly": true, "type": "string" }, "fileOriginType": { "description": "Optional. The origin of the file.", "type": "string", "enumDescriptions": [ "Default value.", "The file was provided by the user.", "The file was generated by an AI model.", "The file was generated from other files by an internal process." ], "enum": [ "FILE_ORIGIN_TYPE_UNSPECIFIED", "USER_PROVIDED", "AI_GENERATED", "INTERNALLY_GENERATED" ] }, "views": { "description": "Output only. Alternate views of this file object. Each file view is attached to a specific role. Possible example keys: - \"thumbnail\" - \"mobile_thumbnail\" - \"clip\" - \"summary\" - \"translation\"", "readOnly": true, "type": "object", "additionalProperties": { "$ref": "GoogleCloudDiscoveryengineV1alphaFileView" } } } }, "GoogleCloudDiscoveryengineV1alphaFileView": { "id": "GoogleCloudDiscoveryengineV1alphaFileView", "description": "Represents a specific alternate version or \"view\" of a file object, such as a summary, a thumbnail, a translated version, etc.", "type": "object", "properties": { "imageCharacteristics": { "description": "Output only. Characteristics of an image media view.", "readOnly": true, "$ref": "GoogleCloudDiscoveryengineV1alphaImageCharacteristics" }, "videoCharacteristics": { "description": "Output only. Characteristics of a video media view.", "readOnly": true, "$ref": "GoogleCloudDiscoveryengineV1alphaVideoCharacteristics" }, "fileCharacteristics": { "description": "Output only. Characteristics of other file types.", "readOnly": true, "$ref": "GoogleCloudDiscoveryengineV1alphaFileCharacteristics" }, "viewId": { "description": "Output only. Globally Unique id for this specific view.", "readOnly": true, "type": "string" }, "uri": { "description": "Output only. The URI to access this media view.", "readOnly": true, "type": "string" }, "mimeType": { "description": "Output only. MIME type (e.g., \"image/jpeg\", \"image/png\", \"text/plain\", \"video/mp4\")", "readOnly": true, "type": "string" }, "byteSize": { "description": "Output only. The size of the view in bytes.", "readOnly": true, "type": "string", "format": "int64" }, "createTime": { "description": "Output only. The time the view was created.", "readOnly": true, "type": "string", "format": "google-datetime" } } }, "GoogleCloudDiscoveryengineV1alphaImageCharacteristics": { "id": "GoogleCloudDiscoveryengineV1alphaImageCharacteristics", "description": "Standard characteristics of an image media view.", "type": "object", "properties": { "width": { "description": "Output only. Image width in pixels.", "readOnly": true, "type": "integer", "format": "int32" }, "height": { "description": "Output only. Image height in pixels.", "readOnly": true, "type": "integer", "format": "int32" }, "colorSpace": { "description": "Output only. Color space of the image (e.g., \"RGB\", \"CMYK\", \"Grayscale\").", "readOnly": true, "type": "string", "enumDescriptions": [ "Default value. Unknown color space.", "Red, green, blue colorspace.", "Cyan, magenta, yellow, and black colorspace.", "Grayscale colorspace.", "YUV colorspace.", "Other colorspace." ], "enum": [ "COLOR_SPACE_UNSPECIFIED", "RGB", "CMYK", "GRAYSCALE", "YUV", "OTHER_COLOR_SPACE" ] }, "bitDepth": { "description": "Output only. Bit depth of the image (e.g., 8-bit, 16-bit).", "readOnly": true, "type": "integer", "format": "int32" } } }, "GoogleCloudDiscoveryengineV1alphaVideoCharacteristics": { "id": "GoogleCloudDiscoveryengineV1alphaVideoCharacteristics", "description": "Standard characteristics of a video media view.", "type": "object", "properties": { "width": { "description": "Output only. Video width in pixels.", "readOnly": true, "type": "integer", "format": "int32" }, "height": { "description": "Output only. Video height in pixels.", "readOnly": true, "type": "integer", "format": "int32" }, "duration": { "description": "Output only. Video duration.", "readOnly": true, "type": "string", "format": "google-duration" }, "frameRate": { "description": "Output only. Frame rate (frames per second).", "readOnly": true, "type": "number", "format": "double" }, "audioCodecs": { "description": "Output only. Audio codecs used in the video.", "readOnly": true, "type": "array", "items": { "type": "string" } }, "videoCodecs": { "description": "Output only. Video codecs used in the video.", "readOnly": true, "type": "array", "items": { "type": "string" } }, "videoBitrateKbps": { "description": "Output only. Bitrate of the video in kbps.", "readOnly": true, "type": "integer", "format": "int32" }, "audioBitrateKbps": { "description": "Output only. Bitrate of the audio in kbps.", "readOnly": true, "type": "integer", "format": "int32" } } }, "GoogleCloudDiscoveryengineV1alphaFileCharacteristics": { "id": "GoogleCloudDiscoveryengineV1alphaFileCharacteristics", "description": "Caracteristics of other file types.", "type": "object", "properties": { "characteristics": { "description": "Output only. Generic map of characteristics.", "readOnly": true, "type": "object", "additionalProperties": { "type": "string" } } } }, "GoogleCloudDiscoveryengineV1alphaSiteSearchEngine": { "id": "GoogleCloudDiscoveryengineV1alphaSiteSearchEngine", "description": "SiteSearchEngine captures DataStore level site search persisting configurations. It is a singleton value per data store.", "type": "object", "properties": { "name": { "description": "The fully qualified resource name of the site search engine. Format: `projects/*/locations/*/dataStores/*/siteSearchEngine`", "type": "string" } } }, "GoogleCloudDiscoveryengineV1alphaTargetSite": { "id": "GoogleCloudDiscoveryengineV1alphaTargetSite", "description": "A target site for the SiteSearchEngine.", "type": "object", "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.", "readOnly": true, "type": "string" }, "providedUriPattern": { "description": "Required. Input only. The user provided URI pattern from which the `generated_uri_pattern` is generated.", "type": "string" }, "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" ] }, "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" }, "generatedUriPattern": { "description": "Output only. This is system-generated based on the provided_uri_pattern.", "readOnly": true, "type": "string" }, "rootDomainUri": { "description": "Output only. Root domain of the provided_uri_pattern.", "readOnly": true, "type": "string" }, "siteVerificationInfo": { "description": "Output only. Site ownership and validity verification status.", "readOnly": true, "$ref": "GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo" }, "indexingStatus": { "description": "Output only. Indexing status.", "readOnly": true, "type": "string", "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" ] }, "updateTime": { "description": "Output only. The target site's last updated time.", "readOnly": true, "type": "string", "format": "google-datetime" }, "failureReason": { "description": "Output only. Failure reason.", "readOnly": true, "$ref": "GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReason" } } }, "GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo": { "id": "GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo", "description": "Verification information for target sites in advanced site search.", "type": "object", "properties": { "siteVerificationState": { "description": "Site verification state indicating the ownership and validity.", "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." ], "enum": [ "SITE_VERIFICATION_STATE_UNSPECIFIED", "VERIFIED", "UNVERIFIED", "EXEMPTED" ] }, "verifyTime": { "description": "Latest site verification time.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReason": { "id": "GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReason", "description": "Site search indexing failure reasons.", "type": "object", "properties": { "quotaFailure": { "description": "Failed due to insufficient quota.", "$ref": "GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure" } } }, "GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure": { "id": "GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure", "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.", "type": "string", "format": "int64" } } }, "GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesRequest": { "id": "GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesRequest", "description": "Request message for SiteSearchEngineService.BatchCreateTargetSites method.", "type": "object", "properties": { "requests": { "description": "Required. The request message specifying the resources to create. A maximum of 20 TargetSites can be created in a batch.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaCreateTargetSiteRequest" } } } }, "GoogleCloudDiscoveryengineV1alphaCreateTargetSiteRequest": { "id": "GoogleCloudDiscoveryengineV1alphaCreateTargetSiteRequest", "description": "Request message for SiteSearchEngineService.CreateTargetSite method.", "type": "object", "properties": { "parent": { "description": "Required. Parent resource name of TargetSite, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`.", "type": "string" }, "targetSite": { "description": "Required. The TargetSite to create.", "$ref": "GoogleCloudDiscoveryengineV1alphaTargetSite" } } }, "GoogleCloudDiscoveryengineV1alphaListTargetSitesResponse": { "id": "GoogleCloudDiscoveryengineV1alphaListTargetSitesResponse", "description": "Response message for SiteSearchEngineService.ListTargetSites method.", "type": "object", "properties": { "targetSites": { "description": "List of TargetSites.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaTargetSite" } }, "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" }, "totalSize": { "description": "The total number of items matching the request. This will always be populated in the response.", "type": "integer", "format": "int32" } } }, "GoogleCloudDiscoveryengineV1alphaSitemap": { "id": "GoogleCloudDiscoveryengineV1alphaSitemap", "description": "A sitemap for the SiteSearchEngine.", "type": "object", "properties": { "uri": { "description": "Public URI for the sitemap, e.g. `www.example.com/sitemap.xml`.", "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" }, "createTime": { "description": "Output only. The sitemap's creation time.", "readOnly": true, "type": "string", "format": "google-datetime" } } }, "GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponse": { "id": "GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponse", "description": "Response message for SiteSearchEngineService.FetchSitemaps method.", "type": "object", "properties": { "sitemapsMetadata": { "description": "List of Sitemaps fetched.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponseSitemapMetadata" } } } }, "GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponseSitemapMetadata": { "id": "GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponseSitemapMetadata", "description": "Contains a Sitemap and its metadata.", "type": "object", "properties": { "sitemap": { "description": "The Sitemap.", "$ref": "GoogleCloudDiscoveryengineV1alphaSitemap" } } }, "GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchRequest": { "id": "GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchRequest", "description": "Request message for SiteSearchEngineService.EnableAdvancedSiteSearch method.", "type": "object", "properties": {} }, "GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchRequest": { "id": "GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchRequest", "description": "Request message for SiteSearchEngineService.DisableAdvancedSiteSearch method.", "type": "object", "properties": {} }, "GoogleCloudDiscoveryengineV1alphaRecrawlUrisRequest": { "id": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisRequest", "description": "Request message for SiteSearchEngineService.RecrawlUris method.", "type": "object", "properties": { "uris": { "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`.", "type": "array", "items": { "type": "string" } }, "siteCredential": { "description": "Optional. Credential id to use for crawling.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1alphaBatchVerifyTargetSitesRequest": { "id": "GoogleCloudDiscoveryengineV1alphaBatchVerifyTargetSitesRequest", "description": "Request message for SiteSearchEngineService.BatchVerifyTargetSites method.", "type": "object", "properties": {} }, "GoogleCloudDiscoveryengineV1alphaFetchDomainVerificationStatusResponse": { "id": "GoogleCloudDiscoveryengineV1alphaFetchDomainVerificationStatusResponse", "description": "Response message for SiteSearchEngineService.FetchDomainVerificationStatus method.", "type": "object", "properties": { "targetSites": { "description": "List of TargetSites containing the site verification status.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaTargetSite" } }, "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" }, "totalSize": { "description": "The total number of items matching the request. This will always be populated in the response.", "type": "integer", "format": "int32" } } }, "GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataRequest": { "id": "GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataRequest", "description": "Request message for SiteSearchEngineService.SetUriPatternDocumentData method.", "type": "object", "properties": { "documentDataMap": { "description": "Document data keyed by URI pattern. Each entry must be consistent with the Schema. For example: Schema = { \"type\": \"object\", \"properties\": { \"Categories\": { \"type\": \"array\", \"items\": { \"retrievable\": true, \"type\": \"string\" } } } document_data_map = { \"www.url1.com/*\": { \"Categories\": [\"category1\", \"category2\"] }, \"www.url2.com/*\": { \"Categories\": [\"category3\"] } }", "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } } }, "emptyDocumentDataMap": { "description": "If true, clears the document data map. If true, SetUriPatternDocumentDataRequest.document_data_map must be empty.", "type": "boolean" }, "schema": { "description": "Optional. If not provided, the current Schema is used. If provided, validates and updates the Schema. If validation fails, an error is returned.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } } } }, "GoogleCloudDiscoveryengineV1alphaGetUriPatternDocumentDataResponse": { "id": "GoogleCloudDiscoveryengineV1alphaGetUriPatternDocumentDataResponse", "description": "Response message for SiteSearchEngineService.GetUriPatternDocumentData method.", "type": "object", "properties": { "documentDataMap": { "description": "Document data keyed by URI pattern. For example: document_data_map = { \"www.url1.com/*\": { \"Categories\": [\"category1\", \"category2\"] }, \"www.url2.com/*\": { \"Categories\": [\"category3\"] } }", "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } } } } }, "GoogleCloudDiscoveryengineV1alphaPurgeUserEventsRequest": { "id": "GoogleCloudDiscoveryengineV1alphaPurgeUserEventsRequest", "description": "Request message for PurgeUserEvents method.", "type": "object", "properties": { "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" }, "force": { "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.", "type": "boolean" } } }, "GoogleCloudDiscoveryengineV1alphaImportUserEventsRequest": { "id": "GoogleCloudDiscoveryengineV1alphaImportUserEventsRequest", "description": "Request message for the ImportUserEvents request.", "type": "object", "properties": { "inlineSource": { "description": "The Inline source for the input content for UserEvents.", "$ref": "GoogleCloudDiscoveryengineV1alphaImportUserEventsRequestInlineSource" }, "gcsSource": { "description": "Cloud Storage location for the input content.", "$ref": "GoogleCloudDiscoveryengineV1alphaGcsSource" }, "bigquerySource": { "description": "BigQuery input source.", "$ref": "GoogleCloudDiscoveryengineV1alphaBigQuerySource" }, "errorConfig": { "description": "The desired location of errors incurred during the Import. Cannot be set for inline user event imports.", "$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig" } } }, "GoogleCloudDiscoveryengineV1alphaImportUserEventsRequestInlineSource": { "id": "GoogleCloudDiscoveryengineV1alphaImportUserEventsRequestInlineSource", "description": "The inline source for the input config for ImportUserEvents method.", "type": "object", "properties": { "userEvents": { "description": "Required. A list of user events to import. Recommended max of 10k items.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaUserEvent" } } } }, "GoogleCloudDiscoveryengineV1alphaListUserLicensesResponse": { "id": "GoogleCloudDiscoveryengineV1alphaListUserLicensesResponse", "description": "Response message for UserLicenseService.ListUserLicenses.", "type": "object", "properties": { "userLicenses": { "description": "All the customer's UserLicenses.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaUserLicense" } }, "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" } } }, "GoogleCloudDiscoveryengineV1alphaUserLicense": { "id": "GoogleCloudDiscoveryengineV1alphaUserLicense", "description": "User License information assigned by the admin.", "type": "object", "properties": { "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" }, "userProfile": { "description": "Optional. The user profile. We user user full name(First name + Last name) as user profile.", "type": "string" }, "licenseAssignmentState": { "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;", "readOnly": true, "type": "string", "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" ] }, "licenseConfig": { "description": "Optional. The full resource name of the Subscription(LicenseConfig) assigned to the user.", "type": "string" }, "createTime": { "description": "Output only. User created timestamp.", "readOnly": true, "type": "string", "format": "google-datetime" }, "updateTime": { "description": "Output only. User update timestamp.", "readOnly": true, "type": "string", "format": "google-datetime" }, "lastLoginTime": { "description": "Output only. User last logged in time. If the user has not logged in yet, this field will be empty.", "readOnly": true, "type": "string", "format": "google-datetime" } } }, "GoogleCloudDiscoveryengineV1alphaListLicenseConfigsUsageStatsResponse": { "id": "GoogleCloudDiscoveryengineV1alphaListLicenseConfigsUsageStatsResponse", "description": "Response message for UserLicenseService.ListLicenseConfigsUsageStats method.", "type": "object", "properties": { "licenseConfigUsageStats": { "description": "All the customer's LicenseConfigUsageStats.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaLicenseConfigUsageStats" } } } }, "GoogleCloudDiscoveryengineV1alphaLicenseConfigUsageStats": { "id": "GoogleCloudDiscoveryengineV1alphaLicenseConfigUsageStats", "description": "Stats about users' licenses.", "type": "object", "properties": { "licenseConfig": { "description": "Required. The LicenseConfig name.", "type": "string" }, "usedLicenseCount": { "description": "Required. The number of licenses used.", "type": "string", "format": "int64" } } }, "GoogleCloudDiscoveryengineV1alphaBatchUpdateUserLicensesRequest": { "id": "GoogleCloudDiscoveryengineV1alphaBatchUpdateUserLicensesRequest", "description": "Request message for UserLicenseService.BatchUpdateUserLicenses method.", "type": "object", "properties": { "inlineSource": { "description": "The inline source for the input content for document embeddings.", "$ref": "GoogleCloudDiscoveryengineV1alphaBatchUpdateUserLicensesRequestInlineSource" }, "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" } } }, "GoogleCloudDiscoveryengineV1alphaBatchUpdateUserLicensesRequestInlineSource": { "id": "GoogleCloudDiscoveryengineV1alphaBatchUpdateUserLicensesRequestInlineSource", "description": "The inline source for the input config for BatchUpdateUserLicenses method.", "type": "object", "properties": { "userLicenses": { "description": "Required. A list of user licenses to update. Each user license must have a valid UserLicense.user_principal.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaUserLicense" } }, "updateMask": { "description": "Optional. The list of fields to update.", "type": "string", "format": "google-fieldmask" } } }, "GoogleCloudDiscoveryengineV1alphaUserStore": { "id": "GoogleCloudDiscoveryengineV1alphaUserStore", "description": "Configures metadata that is used for End User entities.", "type": "object", "properties": { "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" }, "displayName": { "description": "The display name of the User Store.", "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" }, "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" }, "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" } } }, "GoogleCloudDiscoveryengineV1alphaWidgetConfig": { "id": "GoogleCloudDiscoveryengineV1alphaWidgetConfig", "description": "WidgetConfig captures configs at the Widget level.", "type": "object", "properties": { "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" }, "displayName": { "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.", "type": "string" }, "createTime": { "description": "Output only. Timestamp the WidgetConfig was created.", "readOnly": true, "type": "string", "format": "google-datetime" }, "updateTime": { "description": "Output only. Timestamp the WidgetConfig was updated.", "readOnly": true, "type": "string", "format": "google-datetime" }, "enableAutocomplete": { "description": "Whether or not to enable autocomplete.", "deprecated": true, "type": "boolean" }, "fieldsUiComponentsMap": { "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.", "deprecated": true, "type": "object", "additionalProperties": { "$ref": "GoogleCloudDiscoveryengineV1alphaWidgetConfigUIComponentField" } }, "facetField": { "description": "The configuration and appearance of facets in the end user view.", "deprecated": true, "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaWidgetConfigFacetField" } }, "dataStoreType": { "description": "Output only. The type of the parent data store.", "readOnly": true, "type": "string", "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." ], "enum": [ "DATA_STORE_TYPE_UNSPECIFIED", "SITE_SEARCH", "STRUCTURED", "UNSTRUCTURED", "BLENDED" ] }, "contentSearchSpec": { "description": "The content search spec that configs the desired behavior of content search.", "deprecated": true, "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec" }, "enableSummarization": { "description": "Turn on or off summarization for the search response.", "deprecated": true, "type": "boolean" }, "enableSnippetResultSummary": { "description": "Turn on or off summary for each snippets result.", "deprecated": true, "type": "boolean" }, "configId": { "description": "Output only. Unique obfuscated identifier of a WidgetConfig.", "readOnly": true, "type": "string" }, "enableQualityFeedback": { "description": "Turn on or off collecting the search result quality feedback from end users.", "deprecated": true, "type": "boolean" }, "solutionType": { "description": "Required. Immutable. Specifies the solution type that this WidgetConfig can be used for.", "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." ], "enum": [ "SOLUTION_TYPE_UNSPECIFIED", "SOLUTION_TYPE_RECOMMENDATION", "SOLUTION_TYPE_SEARCH", "SOLUTION_TYPE_CHAT", "SOLUTION_TYPE_GENERATIVE_CHAT", "SOLUTION_TYPE_AI_MODE" ] }, "industryVertical": { "description": "Output only. The industry vertical that the WidgetConfig registers. The WidgetConfig industry vertical is based on the associated Engine.", "readOnly": true, "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" ] }, "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.", "deprecated": true, "type": "boolean" }, "allowlistedDomains": { "description": "Allowlisted domains that can load this widget.", "deprecated": true, "type": "array", "items": { "type": "string" } }, "enableSafeSearch": { "description": "Whether to enable safe search.", "deprecated": true, "type": "boolean" }, "enableConversationalSearch": { "description": "Whether to allow conversational search (LLM, multi-turn) or not (non-LLM, single-turn).", "deprecated": true, "type": "boolean" }, "llmEnabled": { "description": "Output only. Whether LLM is enabled in the corresponding data store.", "readOnly": true, "type": "boolean" }, "enableResultScore": { "description": "Whether to show the result score.", "type": "boolean" }, "resultDisplayType": { "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.", "deprecated": true, "type": "string", "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" ] }, "minimumDataTermAccepted": { "description": "Output only. Whether the customer accepted data use terms.", "readOnly": true, "type": "boolean" }, "enableWebApp": { "description": "Whether to enable standalone web app.", "deprecated": true, "type": "boolean" }, "dataStoreUiConfigs": { "description": "Configurable UI configurations per data store.", "deprecated": true, "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreUiConfig" } }, "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.", "readOnly": true, "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaWidgetConfigCollectionComponent" } }, "enableSearchAsYouType": { "description": "Whether to enable search-as-you-type behavior for the search widget", "deprecated": true, "type": "boolean" }, "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", "deprecated": true, "type": "string" }, "uiSettings": { "description": "Describes general widget search settings as seen in cloud console widget configuration page. Replaces top deprecated top level properties.", "$ref": "GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettings" }, "accessSettings": { "description": "Will be used for all widget access settings seen in cloud console integration page. Replaces top deprecated top level properties.", "$ref": "GoogleCloudDiscoveryengineV1alphaWidgetConfigAccessSettings" }, "uiBranding": { "description": "Describes search widget UI branding settings, such as the widget title, logo, favicons, and colors.", "$ref": "GoogleCloudDiscoveryengineV1alphaWidgetConfigUiBrandingSettings" }, "homepageSetting": { "description": "Optional. Describes the homepage settings of the widget.", "$ref": "GoogleCloudDiscoveryengineV1alphaWidgetConfigHomepageSetting" }, "assistantSettings": { "description": "Optional. Output only. Describes the assistant settings of the widget.", "readOnly": true, "$ref": "GoogleCloudDiscoveryengineV1alphaWidgetConfigAssistantSettings" }, "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": "GoogleCloudDiscoveryengineV1alphaWidgetConfigCustomerProvidedConfig" }, "enablePrivateKnowledgeGraph": { "description": "Optional. Output only. Whether to enable private knowledge graph.", "readOnly": true, "type": "boolean" }, "geminiBundle": { "description": "Output only. Whether the subscription is gemini bundle or not.", "readOnly": true, "type": "boolean" }, "nodes": { "description": "Output only. The nodes associated with the Widget Config.", "readOnly": true, "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaWidgetConfigNode" } } } }, "GoogleCloudDiscoveryengineV1alphaWidgetConfigUIComponentField": { "id": "GoogleCloudDiscoveryengineV1alphaWidgetConfigUIComponentField", "description": "Facet field that maps to a UI Component.", "type": "object", "properties": { "field": { "description": "Required. Registered field name. The format is `field.abc`.", "type": "string" }, "deviceVisibility": { "description": "The field visibility on different types of devices.", "type": "array", "items": { "type": "string", "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" ] } }, "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" } } }, "GoogleCloudDiscoveryengineV1alphaWidgetConfigFacetField": { "id": "GoogleCloudDiscoveryengineV1alphaWidgetConfigFacetField", "description": "Facet fields that store the mapping of fields to end user widget appearance.", "type": "object", "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" } } }, "GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreUiConfig": { "id": "GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreUiConfig", "description": "UI component configuration for data store.", "type": "object", "properties": { "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" }, "id": { "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.", "readOnly": true, "type": "string" }, "facetField": { "description": "Facet fields that store the mapping of fields to end user widget appearance.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaWidgetConfigFacetField" } }, "fieldsUiComponentsMap": { "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.", "type": "object", "additionalProperties": { "$ref": "GoogleCloudDiscoveryengineV1alphaWidgetConfigUIComponentField" } } } }, "GoogleCloudDiscoveryengineV1alphaWidgetConfigCollectionComponent": { "id": "GoogleCloudDiscoveryengineV1alphaWidgetConfigCollectionComponent", "description": "Read-only collection component that contains data store collections fields that may be used for filtering", "type": "object", "properties": { "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.", "type": "string" }, "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.", "readOnly": true, "type": "string" }, "displayName": { "description": "The display name of the collection.", "type": "string" }, "dataStoreComponents": { "description": "For the data store collection, list of the children data stores.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreComponent" } }, "dataSource": { "description": "The name of the data source, retrieved from `Collection.data_connector.data_source`.", "type": "string" }, "dataSourceDisplayName": { "description": "Output only. The display name of the data source.", "readOnly": true, "type": "string" }, "connectorIconLink": { "description": "Output only. The icon link of the connector source.", "readOnly": true, "type": "string" } } }, "GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreComponent": { "id": "GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreComponent", "description": "Read-only data store component that contains data stores fields that may be used for filtering, it's the child of `CollectionComponent`.", "type": "object", "properties": { "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" }, "id": { "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.", "readOnly": true, "type": "string" }, "displayName": { "description": "The display name of the data store.", "type": "string" }, "entityName": { "description": "The name of the entity, retrieved from `Collection.data_connector.entities.entityName`.", "type": "string" }, "workspaceType": { "description": "Output only. Workspace Source Types for workspace data, retrieved from `DataStore.workspace_config.type`.", "readOnly": true, "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" ], "enum": [ "TYPE_UNSPECIFIED", "GOOGLE_DRIVE", "GOOGLE_MAIL", "GOOGLE_SITES", "GOOGLE_CALENDAR", "GOOGLE_CHAT", "GOOGLE_GROUPS", "GOOGLE_KEEP", "GOOGLE_PEOPLE" ] }, "contentConfig": { "description": "Output only. The content config of the data store.", "readOnly": true, "type": "string", "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." ], "enum": [ "CONTENT_CONFIG_UNSPECIFIED", "NO_CONTENT", "CONTENT_REQUIRED", "PUBLIC_WEBSITE", "GOOGLE_WORKSPACE" ] }, "dataStoreConfigType": { "description": "Output only. The type of the data store config.", "readOnly": true, "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" ] } } }, "GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettings": { "id": "GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettings", "description": "Describes general widget (or web app) UI settings as seen in the cloud console UI configuration page.", "type": "object", "properties": { "interactionType": { "description": "Describes widget (or web app) interaction type", "type": "string", "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." ], "enum": [ "INTERACTION_TYPE_UNSPECIFIED", "SEARCH_ONLY", "SEARCH_WITH_ANSWER", "SEARCH_WITH_FOLLOW_UPS" ] }, "generativeAnswerConfig": { "description": "Describes generative answer configuration.", "$ref": "GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettingsGenerativeAnswerConfig" }, "resultDescriptionType": { "description": "Controls whether result extract is display and how (snippet or extractive answer). Default to no result if unspecified.", "type": "string", "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" ] }, "enableAutocomplete": { "description": "Whether or not to enable autocomplete.", "type": "boolean" }, "enableSafeSearch": { "description": "Whether to enable safe search.", "type": "boolean" }, "enableQualityFeedback": { "description": "Turn on or off collecting the search result quality feedback from end users.", "type": "boolean" }, "enableSearchAsYouType": { "description": "Whether to enable search-as-you-type behavior for the search widget.", "type": "boolean" }, "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" }, "dataStoreUiConfigs": { "description": "Per data store configuration.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreUiConfig" } }, "disableUserEventsCollection": { "description": "If set to true, the widget will not collect user events.", "type": "boolean" }, "enableVisualContentSummary": { "description": "If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search.", "type": "boolean" }, "enablePeopleSearch": { "description": "Optional. If set to true, the widget will enable people search.", "type": "boolean" }, "enableCreateAgentButton": { "description": "Optional. If set to true, the widget will enable the create agent button.", "type": "boolean" }, "features": { "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` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-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` * `disable-canvas-workspace` * `disable-skills` * `enable-end-user-sharing-with-groups`", "readOnly": true, "type": "object", "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" ] } }, "modelConfigs": { "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.", "readOnly": true, "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" ] } }, "searchAddonSpec": { "description": "Optional. SearchAddonSpec is used to disable add-ons for search. This field is only supported for search requests.", "$ref": "GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettingsSearchAddonSpec" } } }, "GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettingsGenerativeAnswerConfig": { "id": "GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettingsGenerativeAnswerConfig", "description": "Describes configuration for generative answer.", "type": "object", "properties": { "resultCount": { "description": "The number of top results to generate the answer from. Up to 10.", "type": "integer", "format": "int32" }, "modelVersion": { "description": "The model version used to generate the answer.", "type": "string" }, "modelPromptPreamble": { "description": "Text at the beginning of the prompt that instructs the model that generates the answer.", "type": "string" }, "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.", "type": "integer", "format": "int32" }, "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" }, "disableRelatedQuestions": { "description": "Whether generated answer contains suggested related questions.", "type": "boolean" }, "ignoreNonAnswerSeekingQuery": { "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.", "type": "boolean" }, "ignoreAdversarialQuery": { "description": "Optional. Specifies whether to filter out queries that are adversarial.", "type": "boolean" }, "ignoreLowRelevantContent": { "description": "Optional. Specifies whether to filter out queries that are not relevant to the content.", "type": "boolean" }, "imageSource": { "description": "Optional. Source of image returned in the answer.", "type": "string", "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." ], "enum": [ "IMAGE_SOURCE_UNSPECIFIED", "ALL_AVAILABLE_SOURCES", "CORPUS_IMAGE_ONLY", "FIGURE_GENERATION_ONLY" ] } } }, "GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettingsSearchAddonSpec": { "id": "GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettingsSearchAddonSpec", "description": "SearchAddonSpec is used to disable add-ons for search. By default, if this field is not specified, add-ons are enabled wherever applicable.", "type": "object", "properties": { "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" }, "generativeAnswerAddOnDisabled": { "description": "Optional. If true, generative answer add-on is disabled. Generative answer add-on includes natural language to filters and simple answers.", "type": "boolean" } } }, "GoogleCloudDiscoveryengineV1alphaWidgetConfigAccessSettings": { "id": "GoogleCloudDiscoveryengineV1alphaWidgetConfigAccessSettings", "description": "Describes widget access settings.", "type": "object", "properties": { "allowPublicAccess": { "description": "Whether public unauthenticated access is allowed.", "type": "boolean" }, "allowlistedDomains": { "description": "List of domains that are allowed to integrate the search widget.", "type": "array", "items": { "type": "string" } }, "enableWebApp": { "description": "Whether web app access is enabled.", "type": "boolean" }, "workforceIdentityPoolProvider": { "description": "Optional. The workforce identity pool provider used to access the widget.", "type": "string" }, "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" } } }, "GoogleCloudDiscoveryengineV1alphaWidgetConfigUiBrandingSettings": { "id": "GoogleCloudDiscoveryengineV1alphaWidgetConfigUiBrandingSettings", "description": "Describes widget UI branding settings.", "type": "object", "properties": { "logo": { "description": "Logo image.", "$ref": "GoogleCloudDiscoveryengineV1alphaWidgetConfigImage" } } }, "GoogleCloudDiscoveryengineV1alphaWidgetConfigImage": { "id": "GoogleCloudDiscoveryengineV1alphaWidgetConfigImage", "description": "Options to store an image.", "type": "object", "properties": { "url": { "description": "Image URL.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1alphaWidgetConfigHomepageSetting": { "id": "GoogleCloudDiscoveryengineV1alphaWidgetConfigHomepageSetting", "description": "Describes the homepage setting of the widget. It includes all homepage related settings and configurations, such as shortcuts.", "type": "object", "properties": { "shortcuts": { "description": "Optional. The shortcuts to display on the homepage.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaWidgetConfigHomepageSettingShortcut" } } } }, "GoogleCloudDiscoveryengineV1alphaWidgetConfigHomepageSettingShortcut": { "id": "GoogleCloudDiscoveryengineV1alphaWidgetConfigHomepageSettingShortcut", "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.", "type": "object", "properties": { "title": { "description": "Optional. Title of the shortcut.", "type": "string" }, "icon": { "description": "Optional. Icon URL of shortcut.", "$ref": "GoogleCloudDiscoveryengineV1alphaWidgetConfigImage" }, "destinationUri": { "description": "Optional. Destination URL of shortcut.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1alphaWidgetConfigAssistantSettings": { "id": "GoogleCloudDiscoveryengineV1alphaWidgetConfigAssistantSettings", "description": "Describes the assistant settings of the widget.", "type": "object", "properties": { "googleSearchGroundingEnabled": { "description": "Whether or not the Google search grounding toggle is shown. Deprecated. Use web_grounding_type instead.", "deprecated": true, "type": "boolean" }, "webGroundingType": { "description": "Optional. The type of web grounding to use.", "type": "string", "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." ], "enum": [ "WEB_GROUNDING_TYPE_UNSPECIFIED", "WEB_GROUNDING_TYPE_DISABLED", "WEB_GROUNDING_TYPE_GOOGLE_SEARCH", "WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH" ] }, "defaultWebGroundingToggleOff": { "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.", "readOnly": true, "type": "boolean" }, "disableLocationContext": { "description": "Optional. Output only. Whether to disable user location context.", "readOnly": true, "type": "boolean" } } }, "GoogleCloudDiscoveryengineV1alphaWidgetConfigCustomerProvidedConfig": { "id": "GoogleCloudDiscoveryengineV1alphaWidgetConfigCustomerProvidedConfig", "description": "Customer provided configurations.", "type": "object", "properties": { "customerType": { "description": "Customer type.", "type": "string", "enumDescriptions": [ "Default customer type.", "Government customer type. Some features are disabled for government customers due to legal requirements." ], "enum": [ "DEFAULT_CUSTOMER", "GOVERNMENT_CUSTOMER" ] } } }, "GoogleCloudDiscoveryengineV1alphaWidgetConfigNode": { "id": "GoogleCloudDiscoveryengineV1alphaWidgetConfigNode", "description": "Represents a single reusable computational or logical unit.", "type": "object", "properties": { "displayName": { "description": "Output only. A human readable name for the node.", "readOnly": true, "type": "string" }, "iconUrl": { "description": "Output only. An identifier or URL pointing to an icon representing this node type.", "readOnly": true, "type": "string" }, "description": { "description": "Output only. A detailed description of what the node does.", "readOnly": true, "type": "string" }, "parameterSchema": { "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, "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "outputSchema": { "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", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "type": { "description": "Output only. The type of the node.", "readOnly": true, "type": "string", "enumDescriptions": [ "Unspecified type.", "Trigger type.", "Flow type.", "Connector type." ], "enum": [ "TYPE_UNSPECIFIED", "TRIGGER", "FLOW", "CONNECTOR" ] } } }, "GoogleCloudDiscoveryengineLoggingErrorLog": { "id": "GoogleCloudDiscoveryengineLoggingErrorLog", "description": "An error log which is reported to the Error Reporting system.", "type": "object", "properties": { "serviceContext": { "description": "The service context in which this error has occurred.", "$ref": "GoogleCloudDiscoveryengineLoggingServiceContext" }, "context": { "description": "A description of the context in which the error occurred.", "$ref": "GoogleCloudDiscoveryengineLoggingErrorContext" }, "message": { "description": "A message describing the error.", "type": "string" }, "status": { "description": "The RPC status associated with the error log.", "$ref": "GoogleRpcStatus" }, "requestPayload": { "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`", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "responsePayload": { "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`", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "importPayload": { "description": "The error payload that is populated on LRO import APIs.", "$ref": "GoogleCloudDiscoveryengineLoggingImportErrorContext" }, "connectorRunPayload": { "description": "The error payload that is populated on LRO connector sync APIs.", "$ref": "GoogleCloudDiscoveryengineLoggingConnectorRunErrorContext" } } }, "GoogleCloudDiscoveryengineLoggingServiceContext": { "id": "GoogleCloudDiscoveryengineLoggingServiceContext", "description": "Describes a running service that sends errors.", "type": "object", "properties": { "service": { "description": "An identifier of the service—for example, `discoveryengine.googleapis.com`.", "type": "string" } } }, "GoogleCloudDiscoveryengineLoggingErrorContext": { "id": "GoogleCloudDiscoveryengineLoggingErrorContext", "description": "A description of the context in which an error occurred.", "type": "object", "properties": { "httpRequest": { "description": "The HTTP request which was processed when the error was triggered.", "$ref": "GoogleCloudDiscoveryengineLoggingHttpRequestContext" }, "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" } } }, "GoogleCloudDiscoveryengineLoggingHttpRequestContext": { "id": "GoogleCloudDiscoveryengineLoggingHttpRequestContext", "description": "HTTP request data that is related to a reported error.", "type": "object", "properties": { "responseStatusCode": { "description": "The HTTP response status code for the request.", "type": "integer", "format": "int32" } } }, "GoogleCloudDiscoveryengineLoggingSourceLocation": { "id": "GoogleCloudDiscoveryengineLoggingSourceLocation", "description": "Indicates a location in the source code of the service for which errors are reported.", "type": "object", "properties": { "functionName": { "description": "Human-readable name of a function or method—for example, `google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend`.", "type": "string" } } }, "GoogleCloudDiscoveryengineLoggingImportErrorContext": { "id": "GoogleCloudDiscoveryengineLoggingImportErrorContext", "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`", "type": "object", "properties": { "operation": { "description": "The operation resource name of the LRO.", "type": "string" }, "gcsPath": { "description": "Google Cloud Storage file path of the import source. Can be set for batch operation error.", "type": "string" }, "lineNumber": { "description": "Line number of the content in file. Should be empty for permission or batch operation error.", "type": "string" }, "document": { "description": "The detailed content which caused the error on importing a document.", "type": "string" }, "userEvent": { "description": "The detailed content which caused the error on importing a user event.", "type": "string" } } }, "GoogleCloudDiscoveryengineLoggingConnectorRunErrorContext": { "id": "GoogleCloudDiscoveryengineLoggingConnectorRunErrorContext", "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`", "type": "object", "properties": { "operation": { "description": "The operation resource name of the LRO to sync the connector.", "type": "string" }, "dataConnector": { "description": "The full resource name of the DataConnector. Format: `projects/*/locations/*/collections/*/dataConnector`.", "type": "string" }, "connectorRun": { "description": "The full resource name of the Connector Run. Format: `projects/*/locations/*/collections/*/dataConnector/connectorRuns/*`. The `connector_run_id` is system-generated.", "type": "string" }, "entity": { "description": "The entity to sync for the connector run.", "type": "string" }, "syncType": { "description": "The type of sync run. Can be one of the following: * `FULL` * `INCREMENTAL`", "type": "string" }, "startTime": { "description": "The time when the connector run started.", "type": "string", "format": "google-datetime" }, "endTime": { "description": "The time when the connector run ended.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudDiscoveryengineV1AclConfig": { "id": "GoogleCloudDiscoveryengineV1AclConfig", "description": "Access Control Configuration.", "type": "object", "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": "GoogleCloudDiscoveryengineV1IdpConfig" } } }, "GoogleCloudDiscoveryengineV1IdpConfig": { "id": "GoogleCloudDiscoveryengineV1IdpConfig", "description": "Identity Provider Config.", "type": "object", "properties": { "idpType": { "description": "Identity provider type configured.", "type": "string", "enumDescriptions": [ "Default value. ACL search not enabled.", "Google 1P provider.", "Third party provider." ], "enum": [ "IDP_TYPE_UNSPECIFIED", "GSUITE", "THIRD_PARTY" ] }, "externalIdpConfig": { "description": "External Identity provider config.", "$ref": "GoogleCloudDiscoveryengineV1IdpConfigExternalIdpConfig" } } }, "GoogleCloudDiscoveryengineV1IdpConfigExternalIdpConfig": { "id": "GoogleCloudDiscoveryengineV1IdpConfigExternalIdpConfig", "description": "Third party IDP Config.", "type": "object", "properties": { "workforcePoolName": { "description": "Workforce pool name. Example: \"locations/global/workforcePools/pool_id\"", "type": "string" } } }, "GoogleCloudDiscoveryengineV1Assistant": { "id": "GoogleCloudDiscoveryengineV1Assistant", "description": "Discovery Engine Assistant resource.", "type": "object", "properties": { "name": { "description": "Immutable. Resource name of the assistant. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}` It must be a UTF-8 encoded string with a length limit of 1024 characters.", "type": "string" }, "displayName": { "description": "Required. The assistant display name. It must be a UTF-8 encoded string with a length limit of 128 characters.", "type": "string" }, "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": { "description": "Optional. Configuration for the generation of the assistant response.", "$ref": "GoogleCloudDiscoveryengineV1AssistantGenerationConfig" }, "webGroundingType": { "description": "Optional. The type of web grounding to use.", "type": "string", "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." ], "enum": [ "WEB_GROUNDING_TYPE_UNSPECIFIED", "WEB_GROUNDING_TYPE_DISABLED", "WEB_GROUNDING_TYPE_GOOGLE_SEARCH", "WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH" ] }, "defaultWebGroundingToggleOff": { "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.", "type": "boolean" }, "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\"),..] }", "type": "object", "additionalProperties": { "$ref": "GoogleCloudDiscoveryengineV1AssistantToolList" } }, "customerPolicy": { "description": "Optional. Customer policy for the assistant.", "$ref": "GoogleCloudDiscoveryengineV1AssistantCustomerPolicy" }, "createTime": { "description": "Output only. Represents the time when this Assistant was created.", "readOnly": true, "type": "string", "format": "google-datetime" }, "updateTime": { "description": "Output only. Represents the time when this Assistant was most recently updated.", "readOnly": true, "type": "string", "format": "google-datetime" } } }, "GoogleCloudDiscoveryengineV1AssistantGenerationConfig": { "id": "GoogleCloudDiscoveryengineV1AssistantGenerationConfig", "description": "Configuration for the generation of the assistant response.", "type": "object", "properties": { "defaultModelId": { "description": "Optional. The default model to use for assistant.", "type": "string" }, "allowedModelIds": { "description": "Optional. The list of models that are allowed to be used for assistant.", "type": "array", "items": { "type": "string" } }, "systemInstruction": { "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", "$ref": "GoogleCloudDiscoveryengineV1AssistantGenerationConfigSystemInstruction" }, "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" } } }, "GoogleCloudDiscoveryengineV1AssistantGenerationConfigSystemInstruction": { "id": "GoogleCloudDiscoveryengineV1AssistantGenerationConfigSystemInstruction", "description": "System instruction, also known as the prompt preamble for LLM calls.", "type": "object", "properties": { "additionalSystemInstruction": { "description": "Optional. Additional system instruction that will be added to the default system instruction.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1AssistantToolList": { "id": "GoogleCloudDiscoveryengineV1AssistantToolList", "description": "The enabled tools on a connector", "type": "object", "properties": { "toolInfo": { "description": "The list of tools with corresponding tool information.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1AssistantToolInfo" } } } }, "GoogleCloudDiscoveryengineV1AssistantToolInfo": { "id": "GoogleCloudDiscoveryengineV1AssistantToolInfo", "description": "Information to identify a tool.", "type": "object", "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": { "description": "The display name of the tool.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1AssistantCustomerPolicy": { "id": "GoogleCloudDiscoveryengineV1AssistantCustomerPolicy", "description": "Customer-defined policy for the assistant.", "type": "object", "properties": { "bannedPhrases": { "description": "Optional. List of banned phrases.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1AssistantCustomerPolicyBannedPhrase" } }, "modelArmorConfig": { "description": "Optional. Model Armor configuration to be used for sanitizing user prompts and assistant responses.", "$ref": "GoogleCloudDiscoveryengineV1AssistantCustomerPolicyModelArmorConfig" } } }, "GoogleCloudDiscoveryengineV1AssistantCustomerPolicyBannedPhrase": { "id": "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.", "type": "object", "properties": { "phrase": { "description": "Required. The raw string content to be banned.", "type": "string" }, "matchType": { "description": "Optional. Match type for the banned phrase.", "type": "string", "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." ], "enum": [ "BANNED_PHRASE_MATCH_TYPE_UNSPECIFIED", "SIMPLE_STRING_MATCH", "WORD_BOUNDARY_STRING_MATCH" ] }, "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" } } }, "GoogleCloudDiscoveryengineV1AssistantCustomerPolicyModelArmorConfig": { "id": "GoogleCloudDiscoveryengineV1AssistantCustomerPolicyModelArmorConfig", "description": "Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and assistant responses.", "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": { "description": "Optional. Defines the failure mode for Model Armor sanitization.", "type": "string", "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." ], "enum": [ "FAILURE_MODE_UNSPECIFIED", "FAIL_OPEN", "FAIL_CLOSED" ] } } }, "GoogleCloudDiscoveryengineV1BatchCreateTargetSiteMetadata": { "id": "GoogleCloudDiscoveryengineV1BatchCreateTargetSiteMetadata", "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": { "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.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudDiscoveryengineV1BatchCreateTargetSitesResponse": { "id": "GoogleCloudDiscoveryengineV1BatchCreateTargetSitesResponse", "description": "Response message for SiteSearchEngineService.BatchCreateTargetSites method.", "type": "object", "properties": { "targetSites": { "description": "TargetSites created.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1TargetSite" } } } }, "GoogleCloudDiscoveryengineV1TargetSite": { "id": "GoogleCloudDiscoveryengineV1TargetSite", "description": "A target site for the SiteSearchEngine.", "type": "object", "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.", "readOnly": true, "type": "string" }, "providedUriPattern": { "description": "Required. Input only. The user provided URI pattern from which the `generated_uri_pattern` is generated.", "type": "string" }, "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" ] }, "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" }, "generatedUriPattern": { "description": "Output only. This is system-generated based on the provided_uri_pattern.", "readOnly": true, "type": "string" }, "rootDomainUri": { "description": "Output only. Root domain of the provided_uri_pattern.", "readOnly": true, "type": "string" }, "siteVerificationInfo": { "description": "Output only. Site ownership and validity verification status.", "readOnly": true, "$ref": "GoogleCloudDiscoveryengineV1SiteVerificationInfo" }, "indexingStatus": { "description": "Output only. Indexing status.", "readOnly": true, "type": "string", "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" ] }, "updateTime": { "description": "Output only. The target site's last updated time.", "readOnly": true, "type": "string", "format": "google-datetime" }, "failureReason": { "description": "Output only. Failure reason.", "readOnly": true, "$ref": "GoogleCloudDiscoveryengineV1TargetSiteFailureReason" } } }, "GoogleCloudDiscoveryengineV1SiteVerificationInfo": { "id": "GoogleCloudDiscoveryengineV1SiteVerificationInfo", "description": "Verification information for target sites in advanced site search.", "type": "object", "properties": { "siteVerificationState": { "description": "Site verification state indicating the ownership and validity.", "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." ], "enum": [ "SITE_VERIFICATION_STATE_UNSPECIFIED", "VERIFIED", "UNVERIFIED", "EXEMPTED" ] }, "verifyTime": { "description": "Latest site verification time.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudDiscoveryengineV1TargetSiteFailureReason": { "id": "GoogleCloudDiscoveryengineV1TargetSiteFailureReason", "description": "Site search indexing failure reasons.", "type": "object", "properties": { "quotaFailure": { "description": "Failed due to insufficient quota.", "$ref": "GoogleCloudDiscoveryengineV1TargetSiteFailureReasonQuotaFailure" } } }, "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.", "type": "string", "format": "int64" } } }, "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": { "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.", "type": "string", "format": "google-datetime" }, "successCount": { "description": "Count of user licenses successfully updated.", "type": "string", "format": "int64" }, "failureCount": { "description": "Count of user licenses that failed to be updated.", "type": "string", "format": "int64" } } }, "GoogleCloudDiscoveryengineV1BatchUpdateUserLicensesResponse": { "id": "GoogleCloudDiscoveryengineV1BatchUpdateUserLicensesResponse", "description": "Response message for UserLicenseService.BatchUpdateUserLicenses method.", "type": "object", "properties": { "userLicenses": { "description": "UserLicenses successfully updated.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1UserLicense" } }, "errorSamples": { "description": "A sample of errors encountered while processing the request.", "type": "array", "items": { "$ref": "GoogleRpcStatus" } } } }, "GoogleCloudDiscoveryengineV1UserLicense": { "id": "GoogleCloudDiscoveryengineV1UserLicense", "description": "User License information assigned by the admin.", "type": "object", "properties": { "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" }, "userProfile": { "description": "Optional. The user profile. We user user full name(First name + Last name) as user profile.", "type": "string" }, "licenseAssignmentState": { "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;", "readOnly": true, "type": "string", "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" ] }, "licenseConfig": { "description": "Optional. The full resource name of the Subscription(LicenseConfig) assigned to the user.", "type": "string" }, "createTime": { "description": "Output only. User created timestamp.", "readOnly": true, "type": "string", "format": "google-datetime" }, "updateTime": { "description": "Output only. User update timestamp.", "readOnly": true, "type": "string", "format": "google-datetime" }, "lastLoginTime": { "description": "Output only. User last logged in time. If the user has not logged in yet, this field will be empty.", "readOnly": true, "type": "string", "format": "google-datetime" } } }, "GoogleCloudDiscoveryengineV1CmekConfig": { "id": "GoogleCloudDiscoveryengineV1CmekConfig", "description": "Configurations used to enable CMEK data encryption with Cloud KMS keys.", "type": "object", "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" }, "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": { "description": "Output only. KMS key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`.", "readOnly": true, "type": "string" }, "state": { "description": "Output only. The states of the CmekConfig.", "readOnly": true, "type": "string", "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." ], "enum": [ "STATE_UNSPECIFIED", "CREATING", "ACTIVE", "KEY_ISSUE", "DELETING", "DELETE_FAILED", "UNUSABLE", "ACTIVE_ROTATING", "DELETED", "EXPIRED" ] }, "isDefault": { "description": "Output only. The default CmekConfig for the Customer.", "readOnly": true, "type": "boolean" }, "lastRotationTimestampMicros": { "description": "Output only. The timestamp of the last key rotation.", "readOnly": true, "type": "string", "format": "int64" }, "singleRegionKeys": { "description": "Optional. Single-regional CMEKs that are required for some VAIS features.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1SingleRegionKey" } }, "notebooklmState": { "description": "Output only. Whether the NotebookLM Corpus is ready to be used.", "readOnly": true, "type": "string", "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" ] } } }, "GoogleCloudDiscoveryengineV1SingleRegionKey": { "id": "GoogleCloudDiscoveryengineV1SingleRegionKey", "description": "Metadata for single-regional CMEKs.", "type": "object", "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" } } }, "GoogleCloudDiscoveryengineV1Collection": { "id": "GoogleCloudDiscoveryengineV1Collection", "description": "Collection is a container for configuring resources and access to a set of DataStores.", "type": "object", "properties": { "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" }, "displayName": { "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.", "type": "string" }, "createTime": { "description": "Output only. Timestamp the Collection was created at.", "readOnly": true, "type": "string", "format": "google-datetime" } } }, "GoogleCloudDiscoveryengineV1Control": { "id": "GoogleCloudDiscoveryengineV1Control", "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": { "boostAction": { "description": "Defines a boost-type control", "$ref": "GoogleCloudDiscoveryengineV1ControlBoostAction" }, "filterAction": { "description": "Defines a filter-type control Currently not supported by Recommendation", "$ref": "GoogleCloudDiscoveryengineV1ControlFilterAction" }, "redirectAction": { "description": "Defines a redirect-type control.", "$ref": "GoogleCloudDiscoveryengineV1ControlRedirectAction" }, "synonymsAction": { "description": "Treats a group of terms as synonyms of one another.", "$ref": "GoogleCloudDiscoveryengineV1ControlSynonymsAction" }, "promoteAction": { "description": "Promote certain links based on predefined trigger queries.", "$ref": "GoogleCloudDiscoveryengineV1ControlPromoteAction" }, "name": { "description": "Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*`", "type": "string" }, "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" }, "associatedServingConfigIds": { "description": "Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes.", "readOnly": true, "type": "array", "items": { "type": "string" } }, "solutionType": { "description": "Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown.", "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." ], "enum": [ "SOLUTION_TYPE_UNSPECIFIED", "SOLUTION_TYPE_RECOMMENDATION", "SOLUTION_TYPE_SEARCH", "SOLUTION_TYPE_CHAT", "SOLUTION_TYPE_GENERATIVE_CHAT", "SOLUTION_TYPE_AI_MODE" ] }, "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", "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." ], "enum": [ "SEARCH_USE_CASE_UNSPECIFIED", "SEARCH_USE_CASE_SEARCH", "SEARCH_USE_CASE_BROWSE" ] } }, "conditions": { "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", "items": { "$ref": "GoogleCloudDiscoveryengineV1Condition" } } } }, "GoogleCloudDiscoveryengineV1ControlBoostAction": { "id": "GoogleCloudDiscoveryengineV1ControlBoostAction", "description": "Adjusts order of products in returned list.", "type": "object", "properties": { "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" }, "interpolationBoostSpec": { "description": "Optional. Complex specification for custom ranking based on customer defined attribute value.", "$ref": "GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpec" }, "boost": { "description": "Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).", "deprecated": true, "type": "number", "format": "float" }, "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" }, "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" } } }, "GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpec": { "id": "GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpec", "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": { "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" ] }, "interpolationType": { "description": "Optional. 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" ] }, "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.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpecControlPoint" } } } }, "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": { "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" }, "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.", "type": "number", "format": "float" } } }, "GoogleCloudDiscoveryengineV1ControlFilterAction": { "id": "GoogleCloudDiscoveryengineV1ControlFilterAction", "description": "Specified which products may be included in results. Uses same filter as boost.", "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" } } }, "GoogleCloudDiscoveryengineV1ControlRedirectAction": { "id": "GoogleCloudDiscoveryengineV1ControlRedirectAction", "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" } } }, "GoogleCloudDiscoveryengineV1ControlSynonymsAction": { "id": "GoogleCloudDiscoveryengineV1ControlSynonymsAction", "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", "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.", "type": "array", "items": { "type": "string" } } } }, "GoogleCloudDiscoveryengineV1ControlPromoteAction": { "id": "GoogleCloudDiscoveryengineV1ControlPromoteAction", "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", "properties": { "dataStore": { "description": "Required. Data store with which this promotion is attached to.", "type": "string" }, "searchLinkPromotion": { "description": "Required. Promotion attached to this action.", "$ref": "GoogleCloudDiscoveryengineV1SearchLinkPromotion" } } }, "GoogleCloudDiscoveryengineV1SearchLinkPromotion": { "id": "GoogleCloudDiscoveryengineV1SearchLinkPromotion", "description": "Promotion proto includes uri and other helping information to display the promotion.", "type": "object", "properties": { "title": { "description": "Required. The title of the promotion. Maximum length: 160 characters.", "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" }, "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" }, "description": { "description": "Optional. The Promotion description. Maximum length: 200 characters.", "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" } } }, "GoogleCloudDiscoveryengineV1Condition": { "id": "GoogleCloudDiscoveryengineV1Condition", "description": "Defines circumstances to be checked before allowing a behavior", "type": "object", "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.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1ConditionQueryTerm" } }, "activeTimeRange": { "description": "Range of time(s) specifying when condition is active. Maximum of 10 time ranges.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1ConditionTimeRange" } }, "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" } } }, "GoogleCloudDiscoveryengineV1ConditionQueryTerm": { "id": "GoogleCloudDiscoveryengineV1ConditionQueryTerm", "description": "Matcher for search request query", "type": "object", "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": { "description": "Whether the search query needs to exactly match the query term.", "type": "boolean" } } }, "GoogleCloudDiscoveryengineV1ConditionTimeRange": { "id": "GoogleCloudDiscoveryengineV1ConditionTimeRange", "description": "Used for time-dependent conditions.", "type": "object", "properties": { "startTime": { "description": "Start of time range. Range is inclusive.", "type": "string", "format": "google-datetime" }, "endTime": { "description": "End of time range. Range is inclusive. Must be in the future.", "type": "string", "format": "google-datetime" } } }, "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.", "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.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudDiscoveryengineV1CreateEngineMetadata": { "id": "GoogleCloudDiscoveryengineV1CreateEngineMetadata", "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": { "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.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudDiscoveryengineV1CreateSchemaMetadata": { "id": "GoogleCloudDiscoveryengineV1CreateSchemaMetadata", "description": "Metadata for Create Schema LRO.", "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.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudDiscoveryengineV1CreateSitemapMetadata": { "id": "GoogleCloudDiscoveryengineV1CreateSitemapMetadata", "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": { "description": "Operation last update time. If the operation is done, this is also the finish time.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudDiscoveryengineV1CreateTargetSiteMetadata": { "id": "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": { "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.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudDiscoveryengineV1DataConnector": { "id": "GoogleCloudDiscoveryengineV1DataConnector", "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", "properties": { "params": { "description": "Required data connector parameters in structured json format.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "jsonParams": { "description": "Required data connector parameters in json string format.", "type": "string" }, "name": { "description": "Identifier. The full resource name of the Data Connector. Format: `projects/*/locations/*/collections/*/dataConnector`.", "type": "string" }, "state": { "description": "Output only. State of the connector.", "readOnly": true, "type": "string", "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" ] }, "dataSource": { "description": "Required. The identifier for the data source. This is a partial list of supported connectors. Please refer to the [documentation](https://docs.cloud.google.com/gemini/enterprise/docs/connectors/introduction-to-connectors-and-data-stores) for the full list of connectors. Supported first-party connectors include: * `gcs` * `bigquery` * `gcp_fhir` * `google_mail` * `google_drive` * `google_calendar` * `google_chat` Supported third-party connectors include: Generally available (GA) connectors: * `onedrive` * `outlook` * `confluence` * `jira` * `servicenow` * `sharepoint` Preview connectors: * `asana` * `azure_active_directory` * `box` * `canva` * `confluence_server` * `custom_connector` * `docusign` * `dropbox` * `dynamics365` * `github` * `gitlab` * `hubspot` * `jira_server` * `linear` * `native_cloud_identity` * `notion` * `okta` * `pagerduty` * `peoplesoft` * `salesforce` * `shopify` * `slack` * `snowflake` * `teams` * `trello` * `workday` * `zendesk`", "type": "string" }, "removeParamKeys": { "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", "items": { "type": "string" } }, "refreshInterval": { "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.", "type": "string", "format": "google-duration" }, "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" }, "entities": { "description": "List of entities from the connected data source to ingest.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1DataConnectorSourceEntity" } }, "createTime": { "description": "Output only. Timestamp the DataConnector was created at.", "readOnly": true, "type": "string", "format": "google-datetime" }, "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, "type": "string", "format": "google-datetime" }, "lastSyncTime": { "description": "Output only. For periodic connectors only, the last time a data sync was completed.", "readOnly": true, "type": "string", "format": "google-datetime" }, "updateTime": { "description": "Output only. Timestamp the DataConnector was last updated.", "readOnly": true, "type": "string", "format": "google-datetime" }, "errors": { "description": "Output only. The errors from initialization or from the latest connector run.", "readOnly": true, "type": "array", "items": { "$ref": "GoogleRpcStatus" } }, "syncMode": { "description": "The data synchronization mode supported by the data connector.", "type": "string", "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" ] }, "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" }, "destinationConfigs": { "description": "Optional. Any target destinations used to connect to third-party services.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1DestinationConfig" } }, "actionState": { "description": "Output only. State of the action connector. This reflects whether the action connector is initializing, active or has encountered errors.", "readOnly": true, "type": "string", "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" ] }, "actionConfig": { "description": "Optional. Action configurations to make the connector support actions.", "$ref": "GoogleCloudDiscoveryengineV1ActionConfig" }, "endUserConfig": { "description": "Optional. Any params and credentials used specifically for EUA connectors.", "$ref": "GoogleCloudDiscoveryengineV1DataConnectorEndUserConfig" }, "federatedConfig": { "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.", "$ref": "GoogleCloudDiscoveryengineV1DataConnectorFederatedConfig" }, "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": { "description": "Optional. Whether customer has enabled static IP addresses for this connector.", "type": "boolean" }, "staticIpAddresses": { "description": "Output only. The static IP addresses used by this connector.", "readOnly": true, "type": "array", "items": { "type": "string" } }, "blockingReasons": { "description": "Output only. User actions that must be completed before the connector can start syncing data.", "readOnly": true, "type": "array", "items": { "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." ], "enum": [ "BLOCKING_REASON_UNSPECIFIED", "ALLOWLIST_STATIC_IP", "ALLOWLIST_IN_SERVICE_ATTACHMENT", "ALLOWLIST_SERVICE_ACCOUNT" ] } }, "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" }, "identityScheduleConfig": { "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.", "$ref": "GoogleCloudDiscoveryengineV1IdentityScheduleConfig" }, "privateConnectivityProjectId": { "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.", "readOnly": true, "type": "string" }, "bapConfig": { "description": "Optional. The configuration for establishing a BAP connection.", "$ref": "GoogleCloudDiscoveryengineV1BAPConfig" }, "connectorType": { "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.", "readOnly": true, "type": "string", "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." ], "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" ] }, "realtimeState": { "description": "Output only. real-time sync state", "readOnly": true, "type": "string", "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" ] }, "alertPolicyConfigs": { "description": "Optional. The connector level alert config.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1AlertPolicyConfig" } }, "realtimeSyncConfig": { "description": "Optional. The configuration for realtime sync.", "$ref": "GoogleCloudDiscoveryengineV1DataConnectorRealtimeSyncConfig" }, "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" }, "createEuaSaas": { "description": "Optional. Whether the END USER AUTHENTICATION connector is created in SaaS.", "type": "boolean" }, "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" }, "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" }, "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.", "type": "string", "format": "google-duration" }, "hybridIngestionDisabled": { "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.", "type": "boolean" }, "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.", "readOnly": true, "type": "array", "items": { "type": "string" } }, "vpcscEnabled": { "description": "Output only. Whether the connector is created with VPC-SC enabled.", "readOnly": true, "type": "boolean" }, "dynamicTools": { "description": "Output only. The dynamic tools fetched for this connector.", "readOnly": true, "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1DynamicTool" } }, "cliConfig": { "description": "Optional. The configuration for establishing a CLI connection.", "$ref": "GoogleCloudDiscoveryengineV1CliConfig" }, "connectorSourceId": { "description": "Optional. If set, this value instead of `data_source` is used to fetch the corresponding connector source.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1DataConnectorSourceEntity": { "id": "GoogleCloudDiscoveryengineV1DataConnectorSourceEntity", "description": "Represents an entity in the data source. For example, the `Account` object in Salesforce.", "type": "object", "properties": { "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." } }, "jsonParams": { "description": "The parameters for the entity to facilitate data ingestion in json string format.", "type": "string" }, "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" }, "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" } }, "dataStore": { "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.", "readOnly": true, "type": "string" }, "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": "GoogleCloudDiscoveryengineV1Schema" }, "healthcareFhirConfig": { "description": "Optional. Configuration for `HEALTHCARE_FHIR` vertical.", "$ref": "GoogleCloudDiscoveryengineV1HealthcareFhirConfig" } } }, "GoogleCloudDiscoveryengineV1Schema": { "id": "GoogleCloudDiscoveryengineV1Schema", "description": "Defines the structure and layout of a type of document data.", "type": "object", "properties": { "structSchema": { "description": "The structured representation of the schema.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "jsonSchema": { "description": "The JSON representation of the schema.", "type": "string" }, "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" } } }, "GoogleCloudDiscoveryengineV1HealthcareFhirConfig": { "id": "GoogleCloudDiscoveryengineV1HealthcareFhirConfig", "description": "Config to data store for `HEALTHCARE_FHIR` vertical.", "type": "object", "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": { "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" } } } }, "GoogleCloudDiscoveryengineV1DestinationConfig": { "id": "GoogleCloudDiscoveryengineV1DestinationConfig", "description": "Defines target endpoints used to connect to third-party sources.", "type": "object", "properties": { "params": { "description": "Optional. Additional parameters for this destination config in structured json format.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "jsonParams": { "description": "Additional parameters for this destination config in json string format.", "type": "string" }, "key": { "description": "Optional. Unique destination identifier that is supported by the connector.", "type": "string" }, "destinations": { "description": "Optional. The destinations for the corresponding key.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1DestinationConfigDestination" } } } }, "GoogleCloudDiscoveryengineV1DestinationConfigDestination": { "id": "GoogleCloudDiscoveryengineV1DestinationConfigDestination", "description": "Defines a target endpoint", "type": "object", "properties": { "host": { "description": "Publicly routable host.", "type": "string" }, "port": { "description": "Optional. Target port number accepted by the destination.", "type": "integer", "format": "int32" } } }, "GoogleCloudDiscoveryengineV1ActionConfig": { "id": "GoogleCloudDiscoveryengineV1ActionConfig", "description": "Informations to support actions on the connector.", "type": "object", "properties": { "actionParams": { "description": "Optional. Action parameters in structured json format.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "jsonActionParams": { "description": "Optional. Action parameters in json string format.", "type": "string" }, "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" }, "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" }, "createBapConnection": { "description": "Optional. Whether to create a BAP connection for the connector.", "type": "boolean" }, "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": "GoogleCloudDiscoveryengineV1ActionConfigScopeList" } } } }, "GoogleCloudDiscoveryengineV1ActionConfigScopeList": { "id": "GoogleCloudDiscoveryengineV1ActionConfigScopeList", "description": "Stores a list of scopes.", "type": "object", "properties": { "scopes": { "description": "Optional. The list of scopes.", "type": "array", "items": { "type": "string" } } } }, "GoogleCloudDiscoveryengineV1DataConnectorEndUserConfig": { "id": "GoogleCloudDiscoveryengineV1DataConnectorEndUserConfig", "description": "Any params and credentials used specifically for EUA connectors.", "type": "object", "properties": { "authParams": { "description": "Optional. Any authentication parameters specific to EUA connectors.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "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.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "tenant": { "description": "Optional. The tenant project the connector is connected to.", "$ref": "GoogleCloudDiscoveryengineV1Tenant" } } }, "GoogleCloudDiscoveryengineV1Tenant": { "id": "GoogleCloudDiscoveryengineV1Tenant", "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", "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" } } }, "GoogleCloudDiscoveryengineV1DataConnectorFederatedConfig": { "id": "GoogleCloudDiscoveryengineV1DataConnectorFederatedConfig", "description": "Any params and credentials used specifically for hybrid connectors supporting FEDERATED mode.", "type": "object", "properties": { "authParams": { "description": "Optional. Any authentication parameters specific to FEDERATED connectors.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "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." } } } }, "GoogleCloudDiscoveryengineV1IdentityScheduleConfig": { "id": "GoogleCloudDiscoveryengineV1IdentityScheduleConfig", "description": "The configuration for the identity data synchronization runs.", "type": "object", "properties": { "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" }, "nextSyncTime": { "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.", "$ref": "GoogleTypeDateTime" } } }, "GoogleCloudDiscoveryengineV1BAPConfig": { "id": "GoogleCloudDiscoveryengineV1BAPConfig", "description": "The configuration for the BAP connector.", "type": "object", "properties": { "supportedConnectorModes": { "description": "Required. The supported connector modes for the associated BAP connection.", "type": "array", "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" ] } }, "enabledActions": { "description": "Optional. The actions enabled on the associated BAP connection.", "type": "array", "items": { "type": "string" } } } }, "GoogleCloudDiscoveryengineV1AlertPolicyConfig": { "id": "GoogleCloudDiscoveryengineV1AlertPolicyConfig", "description": "The connector level alert config.", "type": "object", "properties": { "alertPolicyName": { "description": "Immutable. The fully qualified resource name of the AlertPolicy.", "type": "string" }, "alertEnrollments": { "description": "Optional. The enrollment states of each alert.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1AlertPolicyConfigAlertEnrollment" } } } }, "GoogleCloudDiscoveryengineV1AlertPolicyConfigAlertEnrollment": { "id": "GoogleCloudDiscoveryengineV1AlertPolicyConfigAlertEnrollment", "description": "The alert enrollment status.", "type": "object", "properties": { "alertId": { "description": "Immutable. The id of an alert.", "type": "string" }, "enrollState": { "description": "Required. The enrollment status of a customer.", "type": "string", "enumDescriptions": [ "Default value. Used for customers who have not responded to the alert policy.", "Customer is enrolled in this policy.", "Customer declined this policy." ], "enum": [ "ENROLL_STATES_UNSPECIFIED", "ENROLLED", "DECLINED" ] } } }, "GoogleCloudDiscoveryengineV1DataConnectorRealtimeSyncConfig": { "id": "GoogleCloudDiscoveryengineV1DataConnectorRealtimeSyncConfig", "description": "The configuration for realtime sync to store additional params for realtime sync.", "type": "object", "properties": { "webhookUri": { "description": "Optional. Webhook url for the connector to specify additional params for realtime sync.", "type": "string" }, "realtimeSyncSecret": { "description": "Optional. The ID of the Secret Manager secret used for webhook secret.", "type": "string" }, "streamingError": { "description": "Optional. Streaming error details.", "$ref": "GoogleCloudDiscoveryengineV1DataConnectorRealtimeSyncConfigStreamingError" } } }, "GoogleCloudDiscoveryengineV1DataConnectorRealtimeSyncConfigStreamingError": { "id": "GoogleCloudDiscoveryengineV1DataConnectorRealtimeSyncConfigStreamingError", "description": "Streaming error details.", "type": "object", "properties": { "streamingErrorReason": { "description": "Optional. Streaming error.", "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." ], "enum": [ "STREAMING_ERROR_REASON_UNSPECIFIED", "STREAMING_SETUP_ERROR", "STREAMING_SYNC_ERROR", "INGRESS_ENDPOINT_REQUIRED" ] }, "error": { "description": "Optional. Error details.", "$ref": "GoogleRpcStatus" } } }, "GoogleCloudDiscoveryengineV1DynamicTool": { "id": "GoogleCloudDiscoveryengineV1DynamicTool", "description": "Configuration for dynamic tools.", "type": "object", "properties": { "name": { "description": "Required. The name of the tool.", "type": "string" }, "description": { "description": "Optional. The description of the tool.", "type": "string" }, "enabled": { "description": "Optional. Whether the tool is enabled.", "type": "boolean" }, "displayName": { "description": "Optional. The display name of the tool.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1CliConfig": { "id": "GoogleCloudDiscoveryengineV1CliConfig", "description": "The configuration for the CLI execution based connectors.", "type": "object", "properties": { "enabledActions": { "description": "Optional. The actions enabled on the associated CLI connection.", "type": "array", "items": { "type": "string" } } } }, "GoogleCloudDiscoveryengineV1DataStore": { "id": "GoogleCloudDiscoveryengineV1DataStore", "description": "DataStore captures global settings and configs at the DataStore level.", "type": "object", "properties": { "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" }, "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" }, "industryVertical": { "description": "Immutable. The industry vertical that the data store registers.", "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" ] }, "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": { "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." ], "enum": [ "SOLUTION_TYPE_UNSPECIFIED", "SOLUTION_TYPE_RECOMMENDATION", "SOLUTION_TYPE_SEARCH", "SOLUTION_TYPE_CHAT", "SOLUTION_TYPE_GENERATIVE_CHAT", "SOLUTION_TYPE_AI_MODE" ] } }, "defaultSchemaId": { "description": "Output only. The id of the default Schema associated to this data store.", "readOnly": true, "type": "string" }, "contentConfig": { "description": "Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.", "type": "string", "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." ], "enum": [ "CONTENT_CONFIG_UNSPECIFIED", "NO_CONTENT", "CONTENT_REQUIRED", "PUBLIC_WEBSITE", "GOOGLE_WORKSPACE" ] }, "createTime": { "description": "Output only. Timestamp the DataStore was created at.", "readOnly": true, "type": "string", "format": "google-datetime" }, "advancedSiteSearchConfig": { "description": "Optional. Configuration for advanced site search.", "$ref": "GoogleCloudDiscoveryengineV1AdvancedSiteSearchConfig" }, "naturalLanguageQueryUnderstandingConfig": { "description": "Optional. Configuration for Natural Language Query Understanding.", "$ref": "GoogleCloudDiscoveryengineV1NaturalLanguageQueryUnderstandingConfig" }, "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" }, "cmekConfig": { "description": "Output only. CMEK-related information for the DataStore.", "readOnly": true, "$ref": "GoogleCloudDiscoveryengineV1CmekConfig" }, "billingEstimation": { "description": "Output only. Data size estimation for billing.", "readOnly": true, "$ref": "GoogleCloudDiscoveryengineV1DataStoreBillingEstimation" }, "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" }, "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": "GoogleCloudDiscoveryengineV1WorkspaceConfig" }, "documentProcessingConfig": { "description": "Configuration for Document understanding and enrichment.", "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfig" }, "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" }, "healthcareFhirConfig": { "description": "Optional. Configuration for `HEALTHCARE_FHIR` vertical.", "$ref": "GoogleCloudDiscoveryengineV1HealthcareFhirConfig" }, "servingConfigDataStore": { "description": "Optional. Stores serving config at DataStore level.", "$ref": "GoogleCloudDiscoveryengineV1DataStoreServingConfigDataStore" }, "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" }, "isInfobotFaqDataStore": { "description": "Optional. If set, this DataStore is an Infobot FAQ DataStore.", "type": "boolean" }, "federatedSearchConfig": { "description": "Optional. If set, this DataStore is a federated search DataStore.", "$ref": "GoogleCloudDiscoveryengineV1DataStoreFederatedSearchConfig" }, "configurableBillingApproach": { "description": "Optional. Configuration for configurable billing approach. See", "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." ], "enum": [ "CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED", "CONFIGURABLE_SUBSCRIPTION_INDEXING_CORE", "CONFIGURABLE_CONSUMPTION_EMBEDDING" ] }, "configurableBillingApproachUpdateTime": { "description": "Output only. The timestamp when configurable_billing_approach was last updated.", "readOnly": true, "type": "string", "format": "google-datetime" } } }, "GoogleCloudDiscoveryengineV1AdvancedSiteSearchConfig": { "id": "GoogleCloudDiscoveryengineV1AdvancedSiteSearchConfig", "description": "Configuration data for advance site search.", "type": "object", "properties": { "disableInitialIndex": { "description": "If set true, initial indexing is disabled for the DataStore.", "type": "boolean" }, "disableAutomaticRefresh": { "description": "If set true, automatic refresh is disabled for the DataStore.", "type": "boolean" } } }, "GoogleCloudDiscoveryengineV1NaturalLanguageQueryUnderstandingConfig": { "id": "GoogleCloudDiscoveryengineV1NaturalLanguageQueryUnderstandingConfig", "description": "Configuration for Natural Language Query Understanding.", "type": "object", "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" ] } } }, "GoogleCloudDiscoveryengineV1DataStoreBillingEstimation": { "id": "GoogleCloudDiscoveryengineV1DataStoreBillingEstimation", "description": "Estimation of data size per data store.", "type": "object", "properties": { "structuredDataSize": { "description": "Data size for structured data in terms of bytes.", "type": "string", "format": "int64" }, "unstructuredDataSize": { "description": "Data size for unstructured data in terms of bytes.", "type": "string", "format": "int64" }, "websiteDataSize": { "description": "Data size for websites in terms of bytes.", "type": "string", "format": "int64" }, "structuredDataUpdateTime": { "description": "Last updated timestamp for structured data.", "type": "string", "format": "google-datetime" }, "unstructuredDataUpdateTime": { "description": "Last updated timestamp for unstructured data.", "type": "string", "format": "google-datetime" }, "websiteDataUpdateTime": { "description": "Last updated timestamp for websites.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudDiscoveryengineV1WorkspaceConfig": { "id": "GoogleCloudDiscoveryengineV1WorkspaceConfig", "description": "Config to store data store type configuration for workspace data", "type": "object", "properties": { "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" ], "enum": [ "TYPE_UNSPECIFIED", "GOOGLE_DRIVE", "GOOGLE_MAIL", "GOOGLE_SITES", "GOOGLE_CALENDAR", "GOOGLE_CHAT", "GOOGLE_GROUPS", "GOOGLE_KEEP", "GOOGLE_PEOPLE" ] }, "dasherCustomerId": { "description": "Obfuscated Dasher customer ID.", "type": "string" }, "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" } } }, "GoogleCloudDiscoveryengineV1DocumentProcessingConfig": { "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfig", "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.", "type": "object", "properties": { "name": { "description": "The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`.", "type": "string" }, "chunkingConfig": { "description": "Whether chunking mode is enabled.", "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig" }, "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" }, "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" } } } }, "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig": { "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig", "description": "Configuration for chunking config.", "type": "object", "properties": { "layoutBasedChunkingConfig": { "description": "Configuration for the layout based chunking.", "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig" } } }, "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig": { "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", "description": "Configuration for the layout based chunking.", "type": "object", "properties": { "chunkSize": { "description": "The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500.", "type": "integer", "format": "int32" }, "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" } } }, "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig": { "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig", "description": "Related configurations applied to a specific type of document parser.", "type": "object", "properties": { "digitalParsingConfig": { "description": "Configurations applied to digital parser.", "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig" }, "ocrParsingConfig": { "description": "Configurations applied to OCR parser. Currently it only applies to PDFs.", "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig" }, "layoutParsingConfig": { "description": "Configurations applied to layout parser.", "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig" } } }, "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig": { "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig", "description": "The digital parsing configurations for documents.", "type": "object", "properties": {} }, "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig": { "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig", "description": "The OCR parsing configurations for documents.", "type": "object", "properties": { "enhancedDocumentElements": { "description": "[DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`.", "deprecated": true, "type": "array", "items": { "type": "string" } }, "useNativeText": { "description": "If true, will use native text instead of OCR text on pages containing native text.", "type": "boolean" } } }, "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig": { "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig", "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": { "description": "Optional. If true, the LLM based annotation is added to the image during parsing.", "type": "boolean" }, "enableLlmLayoutParsing": { "description": "Optional. If true, the pdf layout will be refined using an LLM.", "type": "boolean" }, "structuredContentTypes": { "description": "Optional. Contains the required structure types to extract from the document. Supported values: * `shareholder-structure`", "type": "array", "items": { "type": "string" } }, "excludeHtmlElements": { "description": "Optional. List of HTML elements to exclude from the parsed content.", "type": "array", "items": { "type": "string" } }, "excludeHtmlClasses": { "description": "Optional. List of HTML classes to exclude from the parsed content.", "type": "array", "items": { "type": "string" } }, "excludeHtmlIds": { "description": "Optional. List of HTML ids to exclude from the parsed content.", "type": "array", "items": { "type": "string" } }, "enableGetProcessedDocument": { "description": "Optional. If true, the processed document will be made available for the GetProcessedDocument API.", "type": "boolean" } } }, "GoogleCloudDiscoveryengineV1DataStoreServingConfigDataStore": { "id": "GoogleCloudDiscoveryengineV1DataStoreServingConfigDataStore", "description": "Stores information regarding the serving configurations at DataStore level.", "type": "object", "properties": { "disabledForServing": { "description": "Optional. If set true, the DataStore will not be available for serving search requests.", "type": "boolean" } } }, "GoogleCloudDiscoveryengineV1DataStoreFederatedSearchConfig": { "id": "GoogleCloudDiscoveryengineV1DataStoreFederatedSearchConfig", "description": "Stores information for federated search.", "type": "object", "properties": { "alloyDbConfig": { "description": "AlloyDB config. If set, this DataStore is connected to AlloyDB.", "$ref": "GoogleCloudDiscoveryengineV1DataStoreFederatedSearchConfigAlloyDbConfig" }, "thirdPartyOauthConfig": { "description": "Third Party OAuth config. If set, this DataStore is connected to a third party application.", "$ref": "GoogleCloudDiscoveryengineV1DataStoreFederatedSearchConfigThirdPartyOauthConfig" }, "notebooklmConfig": { "description": "NotebookLM config. If set, this DataStore is connected to NotebookLM Enterprise.", "$ref": "GoogleCloudDiscoveryengineV1DataStoreFederatedSearchConfigNotebooklmConfig" } } }, "GoogleCloudDiscoveryengineV1DataStoreFederatedSearchConfigAlloyDbConfig": { "id": "GoogleCloudDiscoveryengineV1DataStoreFederatedSearchConfigAlloyDbConfig", "description": "Stores information for connecting to AlloyDB.", "type": "object", "properties": { "alloydbConnectionConfig": { "description": "Required. Configuration for connecting to AlloyDB.", "$ref": "GoogleCloudDiscoveryengineV1DataStoreFederatedSearchConfigAlloyDbConfigAlloyDbConnectionConfig" }, "alloydbAiNlConfig": { "description": "Optional. Configuration for Magic.", "$ref": "GoogleCloudDiscoveryengineV1DataStoreFederatedSearchConfigAlloyDbConfigAlloyDbAiNaturalLanguageConfig" }, "returnedFields": { "description": "Optional. Fields to be returned in the search results. If empty, all fields will be returned.", "type": "array", "items": { "type": "string" } } } }, "GoogleCloudDiscoveryengineV1DataStoreFederatedSearchConfigAlloyDbConfigAlloyDbConnectionConfig": { "id": "GoogleCloudDiscoveryengineV1DataStoreFederatedSearchConfigAlloyDbConfigAlloyDbConnectionConfig", "description": "Configuration for connecting to AlloyDB.", "type": "object", "properties": { "instance": { "description": "Required. The AlloyDB instance to connect to.", "type": "string" }, "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" }, "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" }, "authMode": { "description": "Optional. Auth mode.", "type": "string", "enumDescriptions": [ "", "Uses P4SA when VAIS talks to AlloyDB.", "Uses EUC when VAIS talks to AlloyDB." ], "enum": [ "AUTH_MODE_UNSPECIFIED", "AUTH_MODE_SERVICE_ACCOUNT", "AUTH_MODE_END_USER_ACCOUNT" ] }, "enablePsvs": { "description": "Optional. If true, enable PSVS for AlloyDB.", "type": "boolean" } } }, "GoogleCloudDiscoveryengineV1DataStoreFederatedSearchConfigAlloyDbConfigAlloyDbAiNaturalLanguageConfig": { "id": "GoogleCloudDiscoveryengineV1DataStoreFederatedSearchConfigAlloyDbConfigAlloyDbAiNaturalLanguageConfig", "description": "Configuration for AlloyDB AI Natural Language.", "type": "object", "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" } } }, "GoogleCloudDiscoveryengineV1DataStoreFederatedSearchConfigThirdPartyOauthConfig": { "id": "GoogleCloudDiscoveryengineV1DataStoreFederatedSearchConfigThirdPartyOauthConfig", "description": "Stores information for third party applicationOAuth.", "type": "object", "properties": { "appName": { "description": "Optional. The type of the application. E.g., \"jira\", \"box\", etc.", "type": "string" }, "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" } } }, "GoogleCloudDiscoveryengineV1DataStoreFederatedSearchConfigNotebooklmConfig": { "id": "GoogleCloudDiscoveryengineV1DataStoreFederatedSearchConfigNotebooklmConfig", "description": "Config for connecting to NotebookLM Enterprise.", "type": "object", "properties": { "searchConfig": { "description": "Required. Search config name. Format: projects/*/locations/global/notebookLmSearchConfigs/*", "type": "string" } } }, "GoogleCloudDiscoveryengineV1DeleteCmekConfigMetadata": { "id": "GoogleCloudDiscoveryengineV1DeleteCmekConfigMetadata", "description": "Metadata related to the progress of the CmekConfigService.DeleteCmekConfig 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": { "description": "Operation last update time. If the operation is done, this is also the finish time.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudDiscoveryengineV1DeleteCollectionMetadata": { "id": "GoogleCloudDiscoveryengineV1DeleteCollectionMetadata", "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": { "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.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudDiscoveryengineV1DeleteDataStoreMetadata": { "id": "GoogleCloudDiscoveryengineV1DeleteDataStoreMetadata", "description": "Metadata related to the progress of the DataStoreService.DeleteDataStore 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": { "description": "Operation last update time. If the operation is done, this is also the finish time.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudDiscoveryengineV1DeleteEngineMetadata": { "id": "GoogleCloudDiscoveryengineV1DeleteEngineMetadata", "description": "Metadata related to the progress of the EngineService.DeleteEngine 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": { "description": "Operation last update time. If the operation is done, this is also the finish time.", "type": "string", "format": "google-datetime" } } }, "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.", "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.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudDiscoveryengineV1DeleteSchemaMetadata": { "id": "GoogleCloudDiscoveryengineV1DeleteSchemaMetadata", "description": "Metadata for DeleteSchema LRO.", "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.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudDiscoveryengineV1DeleteSitemapMetadata": { "id": "GoogleCloudDiscoveryengineV1DeleteSitemapMetadata", "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": { "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.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudDiscoveryengineV1DeleteTargetSiteMetadata": { "id": "GoogleCloudDiscoveryengineV1DeleteTargetSiteMetadata", "description": "Metadata related to the progress of the SiteSearchEngineService.DeleteTargetSite 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": { "description": "Operation last update time. If the operation is done, this is also the finish time.", "type": "string", "format": "google-datetime" } } }, "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": { "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.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchResponse": { "id": "GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchResponse", "description": "Response message for SiteSearchEngineService.DisableAdvancedSiteSearch method.", "type": "object", "properties": {} }, "GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchMetadata": { "id": "GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchMetadata", "description": "Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch 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": { "description": "Operation last update time. If the operation is done, this is also the finish time.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchResponse": { "id": "GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchResponse", "description": "Response message for SiteSearchEngineService.EnableAdvancedSiteSearch method.", "type": "object", "properties": {} }, "GoogleCloudDiscoveryengineV1Engine": { "id": "GoogleCloudDiscoveryengineV1Engine", "description": "Metadata that describes the training and serving parameters of an Engine.", "type": "object", "properties": { "chatEngineConfig": { "description": "Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.", "$ref": "GoogleCloudDiscoveryengineV1EngineChatEngineConfig" }, "searchEngineConfig": { "description": "Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.", "$ref": "GoogleCloudDiscoveryengineV1EngineSearchEngineConfig" }, "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" }, "chatEngineMetadata": { "description": "Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.", "readOnly": true, "$ref": "GoogleCloudDiscoveryengineV1EngineChatEngineMetadata" }, "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" }, "displayName": { "description": "Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.", "type": "string" }, "createTime": { "description": "Output only. Timestamp the Recommendation Engine was created at.", "readOnly": true, "type": "string", "format": "google-datetime" }, "updateTime": { "description": "Output only. Timestamp the Recommendation Engine was last updated.", "readOnly": true, "type": "string", "format": "google-datetime" }, "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.", "type": "array", "items": { "type": "string" } }, "solutionType": { "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." ], "enum": [ "SOLUTION_TYPE_UNSPECIFIED", "SOLUTION_TYPE_RECOMMENDATION", "SOLUTION_TYPE_SEARCH", "SOLUTION_TYPE_CHAT", "SOLUTION_TYPE_GENERATIVE_CHAT", "SOLUTION_TYPE_AI_MODE" ] }, "industryVertical": { "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.", "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" ] }, "commonConfig": { "description": "Common config spec that specifies the metadata of the engine.", "$ref": "GoogleCloudDiscoveryengineV1EngineCommonConfig" }, "knowledgeGraphConfig": { "description": "Optional. Configurations for the Knowledge Graph. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.", "$ref": "GoogleCloudDiscoveryengineV1EngineKnowledgeGraphConfig" }, "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.", "type": "string", "enumDescriptions": [ "All non specified apps.", "App type for intranet search and Agentspace." ], "enum": [ "APP_TYPE_UNSPECIFIED", "APP_TYPE_INTRANET" ] }, "disableAnalytics": { "description": "Optional. Whether to disable analytics for searches performed on this engine.", "type": "boolean" }, "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` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-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` * `disable-canvas-workspace` * `disable-skills` * `enable-end-user-sharing-with-groups`", "type": "object", "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" ] } }, "cmekConfig": { "description": "Output only. CMEK-related information for the Engine.", "readOnly": true, "$ref": "GoogleCloudDiscoveryengineV1CmekConfig" }, "configurableBillingApproach": { "description": "Optional. Configuration for configurable billing approach.", "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." ], "enum": [ "CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED", "CONFIGURABLE_BILLING_APPROACH_ENABLED" ] }, "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.", "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" ] } }, "observabilityConfig": { "description": "Optional. Observability config for the engine.", "$ref": "GoogleCloudDiscoveryengineV1ObservabilityConfig" }, "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.", "type": "object", "additionalProperties": { "type": "string" } }, "agentGatewaySetting": { "description": "Optional. The agent gateway setting for the engine.", "$ref": "GoogleCloudDiscoveryengineV1AgentGatewaySetting" }, "marketplaceAgentVisibility": { "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." ], "enum": [ "MARKETPLACE_AGENT_VISIBILITY_UNSPECIFIED", "SHOW_AVAILABLE_AGENTS_ONLY", "SHOW_AGENTS_ALREADY_INTEGRATED", "SHOW_AGENTS_ALREADY_PURCHASED", "SHOW_ALL_AGENTS" ] }, "procurementContactEmails": { "description": "Optional. The emails of the procurement contacts.", "type": "array", "items": { "type": "string" } } } }, "GoogleCloudDiscoveryengineV1EngineChatEngineConfig": { "id": "GoogleCloudDiscoveryengineV1EngineChatEngineConfig", "description": "Configurations for a Chat Engine.", "type": "object", "properties": { "agentCreationConfig": { "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.", "$ref": "GoogleCloudDiscoveryengineV1EngineChatEngineConfigAgentCreationConfig" }, "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" } } }, "GoogleCloudDiscoveryengineV1EngineChatEngineConfigAgentCreationConfig": { "id": "GoogleCloudDiscoveryengineV1EngineChatEngineConfigAgentCreationConfig", "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": { "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": { "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" }, "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" }, "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" } } }, "GoogleCloudDiscoveryengineV1EngineSearchEngineConfig": { "id": "GoogleCloudDiscoveryengineV1EngineSearchEngineConfig", "description": "Configurations for a Search Engine.", "type": "object", "properties": { "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.", "type": "string", "enumDescriptions": [ "Default value when the enum is unspecified. This is invalid to use.", "Standard tier.", "Enterprise tier." ], "enum": [ "SEARCH_TIER_UNSPECIFIED", "SEARCH_TIER_STANDARD", "SEARCH_TIER_ENTERPRISE" ] }, "requiredSubscriptionTier": { "description": "Optional. The required subscription tier of this engine. They cannot be modified after engine creation. If the required subscription tier is search, user with higher license tier like assist can still access the standalone app associated with this engine.", "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." ], "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" ] }, "searchAddOns": { "description": "The add-on that this search engine enables.", "type": "array", "items": { "type": "string", "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" ] } } } }, "GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfig": { "id": "GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfig", "description": "Additional config specs for a Media Recommendation engine.", "type": "object", "properties": { "type": { "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`.", "type": "string" }, "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" }, "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" }, "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.", "type": "string", "enumDescriptions": [ "Unspecified training state.", "The engine training is paused.", "The engine is training." ], "enum": [ "TRAINING_STATE_UNSPECIFIED", "PAUSED", "TRAINING" ] }, "engineFeaturesConfig": { "description": "Optional. Additional engine features config.", "$ref": "GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigEngineFeaturesConfig" } } }, "GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigOptimizationObjectiveConfig": { "id": "GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigOptimizationObjectiveConfig", "description": "Custom threshold for `cvr` optimization_objective.", "type": "object", "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" } } }, "GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigEngineFeaturesConfig": { "id": "GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigEngineFeaturesConfig", "description": "More feature configs of the selected engine type.", "type": "object", "properties": { "recommendedForYouConfig": { "description": "Recommended for you engine feature config.", "$ref": "GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig" }, "mostPopularConfig": { "description": "Most popular engine feature config.", "$ref": "GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigMostPopularFeatureConfig" } } }, "GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig": { "id": "GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig", "description": "Additional feature configurations for creating a `recommended-for-you` engine.", "type": "object", "properties": { "contextEventType": { "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`.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigMostPopularFeatureConfig": { "id": "GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigMostPopularFeatureConfig", "description": "Feature configurations that are required for creating a Most Popular engine.", "type": "object", "properties": { "timeWindowDays": { "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": "string", "format": "int64" } } }, "GoogleCloudDiscoveryengineV1EngineChatEngineMetadata": { "id": "GoogleCloudDiscoveryengineV1EngineChatEngineMetadata", "description": "Additional information of a Chat Engine. Fields in this message are output only.", "type": "object", "properties": { "dialogflowAgent": { "description": "The resource name of a Dialogflow agent, that this Chat Engine refers to. Format: `projects//locations//agents/`.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1EngineCommonConfig": { "id": "GoogleCloudDiscoveryengineV1EngineCommonConfig", "description": "Common configurations for an Engine.", "type": "object", "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" } } }, "GoogleCloudDiscoveryengineV1EngineKnowledgeGraphConfig": { "id": "GoogleCloudDiscoveryengineV1EngineKnowledgeGraphConfig", "description": "Configuration message for the Knowledge Graph.", "type": "object", "properties": { "enableCloudKnowledgeGraph": { "description": "Whether to enable the Cloud Knowledge Graph for the engine. Defaults to false if not specified.", "type": "boolean" }, "cloudKnowledgeGraphTypes": { "description": "Specify entity types to support.", "type": "array", "items": { "type": "string" } }, "enablePrivateKnowledgeGraph": { "description": "Whether to enable the Private Knowledge Graph for the engine. Defaults to false if not specified.", "type": "boolean" }, "privateKnowledgeGraphTypes": { "description": "Specify entity types to support.", "type": "array", "items": { "type": "string" } }, "featureConfig": { "description": "Optional. Feature config for the Knowledge Graph.", "$ref": "GoogleCloudDiscoveryengineV1EngineKnowledgeGraphConfigFeatureConfig" } } }, "GoogleCloudDiscoveryengineV1EngineKnowledgeGraphConfigFeatureConfig": { "id": "GoogleCloudDiscoveryengineV1EngineKnowledgeGraphConfigFeatureConfig", "description": "Feature config for the Knowledge Graph.", "type": "object", "properties": { "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" }, "disablePrivateKgAutoComplete": { "description": "Whether to disable the private KG auto complete 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" } } }, "GoogleCloudDiscoveryengineV1ObservabilityConfig": { "id": "GoogleCloudDiscoveryengineV1ObservabilityConfig", "description": "Observability config for a resource.", "type": "object", "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" } } }, "GoogleCloudDiscoveryengineV1AgentGatewaySetting": { "id": "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": { "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": "GoogleCloudDiscoveryengineV1AgentGatewaySettingAgentGatewayReference" } } }, "GoogleCloudDiscoveryengineV1AgentGatewaySettingAgentGatewayReference": { "id": "GoogleCloudDiscoveryengineV1AgentGatewaySettingAgentGatewayReference", "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" } } }, "GoogleCloudDiscoveryengineV1IdentityMappingEntryOperationMetadata": { "id": "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": { "description": "The total number of IdentityMappingEntries that were processed.", "type": "string", "format": "int64" } } }, "GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsMetadata": { "id": "GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsMetadata", "description": "Metadata related to the progress of the ImportCompletionSuggestions 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": { "description": "Operation last update time. If the operation is done, this is also the finish time.", "type": "string", "format": "google-datetime" }, "successCount": { "description": "Count of CompletionSuggestions successfully imported.", "type": "string", "format": "int64" }, "failureCount": { "description": "Count of CompletionSuggestions that failed to be imported.", "type": "string", "format": "int64" } } }, "GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsResponse": { "id": "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": { "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": "GoogleCloudDiscoveryengineV1ImportErrorConfig" } } }, "GoogleCloudDiscoveryengineV1ImportErrorConfig": { "id": "GoogleCloudDiscoveryengineV1ImportErrorConfig", "description": "Configuration of destination for Import related errors.", "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" } } }, "GoogleCloudDiscoveryengineV1ImportDocumentsMetadata": { "id": "GoogleCloudDiscoveryengineV1ImportDocumentsMetadata", "description": "Metadata related to the progress of the ImportDocuments operation. This is returned by the google.longrunning.Operation.metadata field.", "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.", "type": "string", "format": "google-datetime" }, "successCount": { "description": "Count of entries that were processed successfully.", "type": "string", "format": "int64" }, "failureCount": { "description": "Count of entries that encountered errors while processing.", "type": "string", "format": "int64" }, "totalCount": { "description": "Total count of entries that were processed.", "type": "string", "format": "int64" } } }, "GoogleCloudDiscoveryengineV1ImportDocumentsResponse": { "id": "GoogleCloudDiscoveryengineV1ImportDocumentsResponse", "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.", "type": "object", "properties": { "errorSamples": { "description": "A sample of errors encountered while processing the request.", "type": "array", "items": { "$ref": "GoogleRpcStatus" } }, "errorConfig": { "description": "Echoes the destination for the complete errors in the request if set.", "$ref": "GoogleCloudDiscoveryengineV1ImportErrorConfig" } } }, "GoogleCloudDiscoveryengineV1ImportIdentityMappingsResponse": { "id": "GoogleCloudDiscoveryengineV1ImportIdentityMappingsResponse", "description": "Response message for IdentityMappingStoreService.ImportIdentityMappings", "type": "object", "properties": { "errorSamples": { "description": "A sample of errors encountered while processing the request.", "type": "array", "items": { "$ref": "GoogleRpcStatus" } } } }, "GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesMetadata": { "id": "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": { "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.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesResponse": { "id": "GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesResponse", "description": "Response message for CompletionService.ImportSuggestionDenyListEntries method.", "type": "object", "properties": { "errorSamples": { "description": "A sample of errors encountered while processing the request.", "type": "array", "items": { "$ref": "GoogleRpcStatus" } }, "importedEntriesCount": { "description": "Count of deny list entries successfully imported.", "type": "string", "format": "int64" }, "failedEntriesCount": { "description": "Count of deny list entries that failed to be imported.", "type": "string", "format": "int64" } } }, "GoogleCloudDiscoveryengineV1ImportUserEventsMetadata": { "id": "GoogleCloudDiscoveryengineV1ImportUserEventsMetadata", "description": "Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field.", "type": "object", "properties": { "createTime": { "description": "Operation create time.", "type": "string", "format": "google-datetime" }, "updateTime": { "description": "Output only. Operation last update time. If the operation is done, this is also the finish time.", "readOnly": true, "type": "string", "format": "google-datetime" }, "successCount": { "description": "Count of entries that were processed successfully.", "type": "string", "format": "int64" }, "failureCount": { "description": "Count of entries that encountered errors while processing.", "type": "string", "format": "int64" } } }, "GoogleCloudDiscoveryengineV1ImportUserEventsResponse": { "id": "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.", "type": "object", "properties": { "errorSamples": { "description": "A sample of errors encountered while processing the request.", "type": "array", "items": { "$ref": "GoogleRpcStatus" } }, "errorConfig": { "description": "Echoes the destination for the complete errors if this field was set in the request.", "$ref": "GoogleCloudDiscoveryengineV1ImportErrorConfig" }, "joinedEventsCount": { "description": "Count of user events imported with complete existing Documents.", "type": "string", "format": "int64" }, "unjoinedEventsCount": { "description": "Count of user events imported, but with Document information not found in the existing Branch.", "type": "string", "format": "int64" } } }, "GoogleCloudDiscoveryengineV1LicenseConfig": { "id": "GoogleCloudDiscoveryengineV1LicenseConfig", "description": "Information about users' licenses.", "type": "object", "properties": { "name": { "description": "Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project}/locations/{location}/licenseConfigs/{license_config}`", "type": "string" }, "licenseCount": { "description": "Required. Number of licenses purchased.", "type": "string", "format": "int64" }, "subscriptionTier": { "description": "Required. Subscription tier information for the license config.", "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." ], "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" ] }, "state": { "description": "Output only. The state of the license config.", "readOnly": true, "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." ], "enum": [ "STATE_UNSPECIFIED", "ACTIVE", "EXPIRED", "NOT_STARTED", "WITHDRAWN", "DEACTIVATING" ] }, "autoRenew": { "description": "Optional. Whether the license config should be auto renewed when it reaches the end date.", "type": "boolean" }, "startDate": { "description": "Required. The start date.", "$ref": "GoogleTypeDate" }, "endDate": { "description": "Optional. The planed end date.", "$ref": "GoogleTypeDate" }, "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" ] }, "freeTrial": { "description": "Optional. Whether the license config is for free trial.", "type": "boolean" }, "geminiBundle": { "description": "Output only. Whether the license config is for Gemini bundle.", "readOnly": true, "type": "boolean" }, "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.", "readOnly": true, "type": "boolean" }, "earlyTerminationDate": { "description": "Output only. The date when the subscription is terminated earlier than the expiration date.", "readOnly": true, "$ref": "GoogleTypeDate" } } }, "GoogleCloudDiscoveryengineV1Project": { "id": "GoogleCloudDiscoveryengineV1Project", "description": "Metadata and configurations for a Google Cloud project in the service.", "type": "object", "properties": { "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.", "readOnly": true, "type": "string" }, "createTime": { "description": "Output only. The timestamp when this project is created.", "readOnly": true, "type": "string", "format": "google-datetime" }, "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" }, "serviceTermsMap": { "description": "Output only. A map of terms of services. The key is the `id` of ServiceTerms.", "readOnly": true, "type": "object", "additionalProperties": { "$ref": "GoogleCloudDiscoveryengineV1ProjectServiceTerms" } }, "customerProvidedConfig": { "description": "Optional. Customer provided configurations.", "$ref": "GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfig" }, "configurableBillingStatus": { "description": "Output only. The current status of the project's configurable billing.", "readOnly": true, "$ref": "GoogleCloudDiscoveryengineV1ProjectConfigurableBillingStatus" } } }, "GoogleCloudDiscoveryengineV1ProjectServiceTerms": { "id": "GoogleCloudDiscoveryengineV1ProjectServiceTerms", "description": "Metadata about the terms of service.", "type": "object", "properties": { "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": { "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.", "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" ] }, "acceptTime": { "description": "The last time when the project agreed to the terms of service.", "type": "string", "format": "google-datetime" }, "declineTime": { "description": "The last time when the project declined or revoked the agreement to terms of service.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfig": { "id": "GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfig", "description": "Customer provided configurations.", "type": "object", "properties": { "notebooklmConfig": { "description": "Optional. Configuration for NotebookLM settings.", "$ref": "GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfig" } } }, "GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfig": { "id": "GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfig", "description": "Configuration for NotebookLM.", "type": "object", "properties": { "modelArmorConfig": { "description": "Model Armor configuration to be used for sanitizing user prompts and LLM responses.", "$ref": "GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig" }, "optOutNotebookSharing": { "description": "Optional. Whether to disable the notebook sharing feature for the project. Default to false if not specified.", "type": "boolean" }, "dataProtectionPolicy": { "description": "Optional. Specifies the data protection policy for NotebookLM.", "$ref": "GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfigDataProtectionPolicy" }, "observabilityConfig": { "description": "Optional. Observability config for NotebookLM.", "$ref": "GoogleCloudDiscoveryengineV1ObservabilityConfig" } } }, "GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig": { "id": "GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig", "description": "Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and LLM responses.", "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 LLM responses. Format: projects/{project}/locations/{location}/templates/{template_id} If not specified, no sanitization will be applied to the LLM response.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfigDataProtectionPolicy": { "id": "GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfigDataProtectionPolicy", "description": "Data protection policy config for NotebookLM.", "type": "object", "properties": { "sensitiveDataProtectionPolicy": { "description": "Optional. The sensitive data protection policy.", "$ref": "GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfigDataProtectionPolicySensitiveDataProtectionPolicy" } } }, "GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfigDataProtectionPolicySensitiveDataProtectionPolicy": { "id": "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" } } }, "GoogleCloudDiscoveryengineV1ProjectConfigurableBillingStatus": { "id": "GoogleCloudDiscoveryengineV1ProjectConfigurableBillingStatus", "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", "properties": { "effectiveSearchQpmThreshold": { "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.", "type": "string", "format": "int64" }, "effectiveIndexingCoreThreshold": { "description": "Optional. The currently effective Indexing Core threshold. This is the threshold against which Indexing Core usage is compared for overage calculations.", "type": "string", "format": "int64" }, "startTime": { "description": "Optional. The start time of the currently active billing subscription.", "type": "string", "format": "google-datetime" }, "terminateTime": { "description": "Output only. The latest terminate effective time of search qpm and indexing core subscriptions.", "readOnly": true, "type": "string", "format": "google-datetime" }, "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.", "readOnly": true, "type": "string", "format": "google-datetime" }, "indexingCoreThresholdNextUpdateTime": { "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, "type": "string", "format": "google-datetime" }, "updateType": { "description": "Output only. The type of update performed in this operation. This field is populated in the response of UpdateProject.", "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)." ], "enum": [ "UPDATE_TYPE_UNSPECIFIED", "CREATE", "DELETE", "SCALE_UP", "SCALE_DOWN" ] } } }, "GoogleCloudDiscoveryengineV1ProvisionProjectMetadata": { "id": "GoogleCloudDiscoveryengineV1ProvisionProjectMetadata", "description": "Metadata associated with a project provision operation.", "type": "object", "properties": {} }, "GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsMetadata": { "id": "GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsMetadata", "description": "Metadata related to the progress of the PurgeCompletionSuggestions operation. This is returned by the google.longrunning.Operation.metadata field.", "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.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsResponse": { "id": "GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsResponse", "description": "Response message for CompletionService.PurgeCompletionSuggestions method.", "type": "object", "properties": { "purgeSucceeded": { "description": "Whether the completion suggestions were successfully purged.", "type": "boolean" }, "errorSamples": { "description": "A sample of errors encountered while processing the request.", "type": "array", "items": { "$ref": "GoogleRpcStatus" } } } }, "GoogleCloudDiscoveryengineV1PurgeDocumentsMetadata": { "id": "GoogleCloudDiscoveryengineV1PurgeDocumentsMetadata", "description": "Metadata related to the progress of the PurgeDocuments 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": { "description": "Operation last update time. If the operation is done, this is also the finish time.", "type": "string", "format": "google-datetime" }, "successCount": { "description": "Count of entries that were deleted successfully.", "type": "string", "format": "int64" }, "failureCount": { "description": "Count of entries that encountered errors while processing.", "type": "string", "format": "int64" }, "ignoredCount": { "description": "Count of entries that were ignored as entries were not found.", "type": "string", "format": "int64" } } }, "GoogleCloudDiscoveryengineV1PurgeDocumentsResponse": { "id": "GoogleCloudDiscoveryengineV1PurgeDocumentsResponse", "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", "properties": { "purgeCount": { "description": "The total count of documents purged as a result of the operation.", "type": "string", "format": "int64" }, "purgeSample": { "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.", "type": "array", "items": { "type": "string" } } } }, "GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesMetadata": { "id": "GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesMetadata", "description": "Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", "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.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesResponse": { "id": "GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesResponse", "description": "Response message for CompletionService.PurgeSuggestionDenyListEntries method.", "type": "object", "properties": { "purgeCount": { "description": "Number of suggestion deny list entries purged.", "type": "string", "format": "int64" }, "errorSamples": { "description": "A sample of errors encountered while processing the request.", "type": "array", "items": { "$ref": "GoogleRpcStatus" } } } }, "GoogleCloudDiscoveryengineV1ServingConfig": { "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.", "type": "object", "properties": { "mediaConfig": { "description": "The MediaConfig of the serving configuration.", "$ref": "GoogleCloudDiscoveryengineV1ServingConfigMediaConfig" }, "genericConfig": { "description": "The GenericConfig of the serving configuration.", "$ref": "GoogleCloudDiscoveryengineV1ServingConfigGenericConfig" }, "name": { "description": "Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}`", "type": "string" }, "displayName": { "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.", "type": "string" }, "solutionType": { "description": "Required. Immutable. Specifies the solution type that a serving config can be associated with.", "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." ], "enum": [ "SOLUTION_TYPE_UNSPECIFIED", "SOLUTION_TYPE_RECOMMENDATION", "SOLUTION_TYPE_SEARCH", "SOLUTION_TYPE_CHAT", "SOLUTION_TYPE_GENERATIVE_CHAT", "SOLUTION_TYPE_AI_MODE" ] }, "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" }, "diversityLevel": { "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.", "type": "string" }, "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" }, "createTime": { "description": "Output only. ServingConfig created timestamp.", "readOnly": true, "type": "string", "format": "google-datetime" }, "updateTime": { "description": "Output only. ServingConfig updated timestamp.", "readOnly": true, "type": "string", "format": "google-datetime" }, "filterControlIds": { "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.", "type": "array", "items": { "type": "string" } }, "boostControlIds": { "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", "items": { "type": "string" } }, "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": { "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.", "type": "array", "items": { "type": "string" } }, "onewaySynonymsControlIds": { "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.", "type": "array", "items": { "type": "string" } }, "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.", "type": "array", "items": { "type": "string" } }, "replacementControlIds": { "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.", "type": "array", "items": { "type": "string" } }, "ignoreControlIds": { "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.", "type": "array", "items": { "type": "string" } }, "promoteControlIds": { "description": "Condition promote specifications. Maximum number of specifications is 100.", "type": "array", "items": { "type": "string" } }, "answerGenerationSpec": { "description": "Optional. The specification for answer generation.", "$ref": "GoogleCloudDiscoveryengineV1AnswerGenerationSpec" } } }, "GoogleCloudDiscoveryengineV1ServingConfigMediaConfig": { "id": "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.", "type": "object", "properties": { "contentWatchedPercentageThreshold": { "description": "Specifies the content watched percentage threshold for demotion. Threshold value must be between [0, 1.0] inclusive.", "type": "number", "format": "float" }, "contentWatchedSecondsThreshold": { "description": "Specifies the content watched minutes threshold for demotion.", "type": "number", "format": "float" }, "demotionEventType": { "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.", "type": "string" }, "demoteContentWatchedPastDays": { "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": "integer", "format": "int32" }, "contentFreshnessCutoffDays": { "description": "Specifies the content freshness used for recommendation result. Contents will be demoted if contents were published for more than content freshness cutoff days.", "type": "integer", "format": "int32" } } }, "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": { "description": "Specifies the expected behavior of content search. Only valid for content-search enabled data store.", "$ref": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpec" } } }, "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpec": { "id": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpec", "description": "A specification for configuring the behavior of content search.", "type": "object", "properties": { "snippetSpec": { "description": "If `snippetSpec` is not specified, snippets are not included in the search response.", "$ref": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSnippetSpec" }, "summarySpec": { "description": "If `summarySpec` is not specified, summaries are not included in the search response.", "$ref": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpec" }, "extractiveContentSpec": { "description": "If there is no extractive_content_spec provided, there will be no extractive answer in the search response.", "$ref": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecExtractiveContentSpec" }, "searchResultMode": { "description": "Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`.", "type": "string", "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" ] }, "chunkSpec": { "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", "$ref": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecChunkSpec" } } }, "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSnippetSpec": { "id": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSnippetSpec", "description": "A specification for configuring snippets in a search response.", "type": "object", "properties": { "maxSnippetCount": { "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, "type": "integer", "format": "int32" }, "referenceOnly": { "description": "[DEPRECATED] This field is deprecated and will have no affect on the snippet.", "deprecated": true, "type": "boolean" }, "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" } } }, "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpec": { "id": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpec", "description": "A specification for configuring a summary returned in a search response.", "type": "object", "properties": { "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.", "type": "integer", "format": "int32" }, "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" }, "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" }, "ignoreLowRelevantContent": { "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": "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" }, "modelPromptSpec": { "description": "If specified, the spec will be used to modify the prompt provided to the LLM.", "$ref": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpecModelPromptSpec" }, "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" }, "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" } } }, "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpecModelPromptSpec": { "id": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpecModelPromptSpec", "description": "Specification of the prompt to use with the model.", "type": "object", "properties": { "preamble": { "description": "Text at the beginning of the prompt that instructs the assistant. Examples are available in the user guide.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpecModelSpec": { "id": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpecModelSpec", "description": "Specification of the model.", "type": "object", "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" } } }, "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecExtractiveContentSpec": { "id": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecExtractiveContentSpec", "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.", "type": "integer", "format": "int32" }, "maxExtractiveSegmentCount": { "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", "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" }, "numPreviousSegments": { "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", "format": "int32" }, "numNextSegments": { "description": "Return at most `num_next_segments` segments after each selected segments.", "type": "integer", "format": "int32" } } }, "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecChunkSpec": { "id": "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", "type": "object", "properties": { "numPreviousChunks": { "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": "integer", "format": "int32" }, "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.", "type": "integer", "format": "int32" } } }, "GoogleCloudDiscoveryengineV1AnswerGenerationSpec": { "id": "GoogleCloudDiscoveryengineV1AnswerGenerationSpec", "description": "The specification for answer generation.", "type": "object", "properties": { "userDefinedClassifierSpec": { "description": "Optional. The specification for user specified classifier spec.", "$ref": "GoogleCloudDiscoveryengineV1AnswerGenerationSpecUserDefinedClassifierSpec" } } }, "GoogleCloudDiscoveryengineV1AnswerGenerationSpecUserDefinedClassifierSpec": { "id": "GoogleCloudDiscoveryengineV1AnswerGenerationSpecUserDefinedClassifierSpec", "description": "The specification for user defined classifier.", "type": "object", "properties": { "enableUserDefinedClassifier": { "description": "Optional. Whether or not to enable and include user defined classifier.", "type": "boolean" }, "preamble": { "description": "Optional. The preamble to be used for the user defined classifier.", "type": "string" }, "modelId": { "description": "Optional. The model id to be used for the user defined classifier.", "type": "string" }, "taskMarker": { "description": "Optional. The task marker to be used for the user defined classifier.", "type": "string" }, "topP": { "description": "Optional. The top-p value to be used for the user defined classifier.", "type": "number", "format": "double" }, "topK": { "description": "Optional. The top-k value to be used for the user defined classifier.", "type": "string", "format": "int64" }, "temperature": { "description": "Optional. The temperature value to be used for the user defined classifier.", "type": "number", "format": "double" }, "seed": { "description": "Optional. The seed value to be used for the user defined classifier.", "type": "integer", "format": "int32" } } }, "GoogleCloudDiscoveryengineV1SetUpDataConnectorMetadata": { "id": "GoogleCloudDiscoveryengineV1SetUpDataConnectorMetadata", "description": "Metadata for DataConnectorService.SetUpDataConnector method.", "type": "object", "properties": {} }, "GoogleCloudDiscoveryengineV1Sitemap": { "id": "GoogleCloudDiscoveryengineV1Sitemap", "description": "A sitemap for the SiteSearchEngine.", "type": "object", "properties": { "uri": { "description": "Public URI for the sitemap, e.g. `www.example.com/sitemap.xml`.", "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" }, "createTime": { "description": "Output only. The sitemap's creation time.", "readOnly": true, "type": "string", "format": "google-datetime" } } }, "GoogleCloudDiscoveryengineV1TrainCustomModelMetadata": { "id": "GoogleCloudDiscoveryengineV1TrainCustomModelMetadata", "description": "Metadata related to the progress of the TrainCustomModel operation. This is returned by the google.longrunning.Operation.metadata field.", "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.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudDiscoveryengineV1TrainCustomModelResponse": { "id": "GoogleCloudDiscoveryengineV1TrainCustomModelResponse", "description": "Response of the TrainCustomModelRequest. This message is returned by the google.longrunning.Operations.response field.", "type": "object", "properties": { "errorSamples": { "description": "A sample of errors encountered while processing the data.", "type": "array", "items": { "$ref": "GoogleRpcStatus" } }, "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": { "description": "The metrics of the trained model.", "type": "object", "additionalProperties": { "type": "number", "format": "double" } }, "modelName": { "description": "Fully qualified name of the CustomTuningModel.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1UpdateCmekConfigMetadata": { "id": "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": { "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.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudDiscoveryengineV1UpdateSchemaMetadata": { "id": "GoogleCloudDiscoveryengineV1UpdateSchemaMetadata", "description": "Metadata for UpdateSchema LRO.", "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.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudDiscoveryengineV1UpdateTargetSiteMetadata": { "id": "GoogleCloudDiscoveryengineV1UpdateTargetSiteMetadata", "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": { "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.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudDiscoveryengineV1UserStore": { "id": "GoogleCloudDiscoveryengineV1UserStore", "description": "Configures metadata that is used for End User entities.", "type": "object", "properties": { "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" }, "displayName": { "description": "The display name of the User Store.", "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" }, "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" }, "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" } } }, "GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSiteMetadata": { "id": "GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSiteMetadata", "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": { "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.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesResponse": { "id": "GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesResponse", "description": "Response message for SiteSearchEngineService.BatchCreateTargetSites method.", "type": "object", "properties": { "targetSites": { "description": "TargetSites created.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaTargetSite" } } } }, "GoogleCloudDiscoveryengineV1alphaBatchUpdateUserLicensesMetadata": { "id": "GoogleCloudDiscoveryengineV1alphaBatchUpdateUserLicensesMetadata", "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": { "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.", "type": "string", "format": "google-datetime" }, "successCount": { "description": "Count of user licenses successfully updated.", "type": "string", "format": "int64" }, "failureCount": { "description": "Count of user licenses that failed to be updated.", "type": "string", "format": "int64" } } }, "GoogleCloudDiscoveryengineV1alphaBatchUpdateUserLicensesResponse": { "id": "GoogleCloudDiscoveryengineV1alphaBatchUpdateUserLicensesResponse", "description": "Response message for UserLicenseService.BatchUpdateUserLicenses method.", "type": "object", "properties": { "userLicenses": { "description": "UserLicenses successfully updated.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaUserLicense" } }, "errorSamples": { "description": "A sample of errors encountered while processing the request.", "type": "array", "items": { "$ref": "GoogleRpcStatus" } } } }, "GoogleCloudDiscoveryengineV1alphaCreateDataStoreMetadata": { "id": "GoogleCloudDiscoveryengineV1alphaCreateDataStoreMetadata", "description": "Metadata related to the progress of the DataStoreService.CreateDataStore 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": { "description": "Operation last update time. If the operation is done, this is also the finish time.", "type": "string", "format": "google-datetime" } } }, "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": { "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.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudDiscoveryengineV1alphaCreateEvaluationMetadata": { "id": "GoogleCloudDiscoveryengineV1alphaCreateEvaluationMetadata", "description": "Metadata for EvaluationService.CreateEvaluation method.", "type": "object", "properties": {} }, "GoogleCloudDiscoveryengineV1alphaCreateSchemaMetadata": { "id": "GoogleCloudDiscoveryengineV1alphaCreateSchemaMetadata", "description": "Metadata for Create Schema LRO.", "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.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudDiscoveryengineV1alphaCreateSitemapMetadata": { "id": "GoogleCloudDiscoveryengineV1alphaCreateSitemapMetadata", "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": { "description": "Operation last update time. If the operation is done, this is also the finish time.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudDiscoveryengineV1alphaCreateTargetSiteMetadata": { "id": "GoogleCloudDiscoveryengineV1alphaCreateTargetSiteMetadata", "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": { "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.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudDiscoveryengineV1alphaDeleteAgentMetadata": { "id": "GoogleCloudDiscoveryengineV1alphaDeleteAgentMetadata", "description": "Metadata related to the progress of the AgentService.DeleteAgent 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": { "description": "Operation last update time. If the operation is done, this is also the finish time.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudDiscoveryengineV1alphaDeleteCmekConfigMetadata": { "id": "GoogleCloudDiscoveryengineV1alphaDeleteCmekConfigMetadata", "description": "Metadata related to the progress of the CmekConfigService.DeleteCmekConfig 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": { "description": "Operation last update time. If the operation is done, this is also the finish time.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudDiscoveryengineV1alphaDeleteCollectionMetadata": { "id": "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": { "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.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudDiscoveryengineV1alphaDeleteDataStoreMetadata": { "id": "GoogleCloudDiscoveryengineV1alphaDeleteDataStoreMetadata", "description": "Metadata related to the progress of the DataStoreService.DeleteDataStore 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": { "description": "Operation last update time. If the operation is done, this is also the finish time.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudDiscoveryengineV1alphaDeleteEngineMetadata": { "id": "GoogleCloudDiscoveryengineV1alphaDeleteEngineMetadata", "description": "Metadata related to the progress of the EngineService.DeleteEngine 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": { "description": "Operation last update time. If the operation is done, this is also the finish time.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudDiscoveryengineV1alphaDeleteIdentityMappingStoreMetadata": { "id": "GoogleCloudDiscoveryengineV1alphaDeleteIdentityMappingStoreMetadata", "description": "Metadata related to the progress of the IdentityMappingStoreService.DeleteIdentityMappingStore 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": { "description": "Operation last update time. If the operation is done, this is also the finish time.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudDiscoveryengineV1alphaDeleteSchemaMetadata": { "id": "GoogleCloudDiscoveryengineV1alphaDeleteSchemaMetadata", "description": "Metadata for DeleteSchema LRO.", "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.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudDiscoveryengineV1alphaDeleteSessionRequest": { "id": "GoogleCloudDiscoveryengineV1alphaDeleteSessionRequest", "description": "Request for DeleteSession method.", "type": "object", "properties": { "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" } } }, "GoogleCloudDiscoveryengineV1alphaDeleteSitemapMetadata": { "id": "GoogleCloudDiscoveryengineV1alphaDeleteSitemapMetadata", "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": { "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.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudDiscoveryengineV1alphaDeleteTargetSiteMetadata": { "id": "GoogleCloudDiscoveryengineV1alphaDeleteTargetSiteMetadata", "description": "Metadata related to the progress of the SiteSearchEngineService.DeleteTargetSite 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": { "description": "Operation last update time. If the operation is done, this is also the finish time.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudDiscoveryengineV1alphaDeleteUserStoreMetadata": { "id": "GoogleCloudDiscoveryengineV1alphaDeleteUserStoreMetadata", "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.", "type": "object", "properties": { "successCount": { "description": "The number of end users under the user store that were successfully deleted.", "type": "string", "format": "int64" }, "failureCount": { "description": "The number of end users under the user store that failed to be deleted.", "type": "string", "format": "int64" } } }, "GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchMetadata": { "id": "GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchMetadata", "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": { "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.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchResponse": { "id": "GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchResponse", "description": "Response message for SiteSearchEngineService.DisableAdvancedSiteSearch method.", "type": "object", "properties": {} }, "GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchMetadata": { "id": "GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchMetadata", "description": "Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch 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": { "description": "Operation last update time. If the operation is done, this is also the finish time.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchResponse": { "id": "GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchResponse", "description": "Response message for SiteSearchEngineService.EnableAdvancedSiteSearch method.", "type": "object", "properties": {} }, "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeMetadata": { "id": "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeMetadata", "description": "Metadata related to the progress of the EstimateDataSize operation. This is returned by the google.longrunning.Operation.metadata field.", "type": "object", "properties": { "createTime": { "description": "Operation create time.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeResponse": { "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.", "type": "object", "properties": { "dataSizeBytes": { "description": "Data size in terms of bytes.", "type": "string", "format": "int64" }, "documentCount": { "description": "Total number of documents.", "type": "string", "format": "int64" } } }, "GoogleCloudDiscoveryengineV1alphaExportMetricsMetadata": { "id": "GoogleCloudDiscoveryengineV1alphaExportMetricsMetadata", "description": "Metadata related to the progress of the Export operation. This is returned by the google.longrunning.Operation.metadata field.", "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.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudDiscoveryengineV1alphaExportMetricsResponse": { "id": "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.", "type": "object", "properties": {} }, "GoogleCloudDiscoveryengineV1alphaGetSessionRequest": { "id": "GoogleCloudDiscoveryengineV1alphaGetSessionRequest", "description": "Request for GetSession method.", "type": "object", "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": { "description": "Optional. If set to true, the full session including all answer details will be returned.", "type": "boolean" } } }, "GoogleCloudDiscoveryengineV1alphaIdentityMappingEntryOperationMetadata": { "id": "GoogleCloudDiscoveryengineV1alphaIdentityMappingEntryOperationMetadata", "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": { "description": "The total number of IdentityMappingEntries that were processed.", "type": "string", "format": "int64" } } }, "GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsMetadata": { "id": "GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsMetadata", "description": "Metadata related to the progress of the ImportCompletionSuggestions 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": { "description": "Operation last update time. If the operation is done, this is also the finish time.", "type": "string", "format": "google-datetime" }, "successCount": { "description": "Count of CompletionSuggestions successfully imported.", "type": "string", "format": "int64" }, "failureCount": { "description": "Count of CompletionSuggestions that failed to be imported.", "type": "string", "format": "int64" } } }, "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.", "type": "object", "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": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig" } } }, "GoogleCloudDiscoveryengineV1alphaImportDocumentsMetadata": { "id": "GoogleCloudDiscoveryengineV1alphaImportDocumentsMetadata", "description": "Metadata related to the progress of the ImportDocuments operation. This is returned by the google.longrunning.Operation.metadata field.", "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.", "type": "string", "format": "google-datetime" }, "successCount": { "description": "Count of entries that were processed successfully.", "type": "string", "format": "int64" }, "failureCount": { "description": "Count of entries that encountered errors while processing.", "type": "string", "format": "int64" }, "totalCount": { "description": "Total count of entries that were processed.", "type": "string", "format": "int64" } } }, "GoogleCloudDiscoveryengineV1alphaImportDocumentsResponse": { "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.", "type": "object", "properties": { "errorSamples": { "description": "A sample of errors encountered while processing the request.", "type": "array", "items": { "$ref": "GoogleRpcStatus" } }, "errorConfig": { "description": "Echoes the destination for the complete errors in the request if set.", "$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig" } } }, "GoogleCloudDiscoveryengineV1alphaImportIdentityMappingsResponse": { "id": "GoogleCloudDiscoveryengineV1alphaImportIdentityMappingsResponse", "description": "Response message for IdentityMappingStoreService.ImportIdentityMappings", "type": "object", "properties": { "errorSamples": { "description": "A sample of errors encountered while processing the request.", "type": "array", "items": { "$ref": "GoogleRpcStatus" } } } }, "GoogleCloudDiscoveryengineV1alphaImportSampleQueriesMetadata": { "id": "GoogleCloudDiscoveryengineV1alphaImportSampleQueriesMetadata", "description": "Metadata related to the progress of the ImportSampleQueries operation. This will be returned by the google.longrunning.Operation.metadata field.", "type": "object", "properties": { "createTime": { "description": "ImportSampleQueries operation create time.", "type": "string", "format": "google-datetime" }, "updateTime": { "description": "ImportSampleQueries operation last update time. If the operation is done, this is also the finish time.", "type": "string", "format": "google-datetime" }, "successCount": { "description": "Count of SampleQuerys successfully imported.", "type": "string", "format": "int64" }, "failureCount": { "description": "Count of SampleQuerys that failed to be imported.", "type": "string", "format": "int64" }, "totalCount": { "description": "Total count of SampleQuerys that were processed.", "type": "string", "format": "int64" } } }, "GoogleCloudDiscoveryengineV1alphaImportSampleQueriesResponse": { "id": "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.", "type": "object", "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": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig" } } }, "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": { "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.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesResponse": { "id": "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesResponse", "description": "Response message for CompletionService.ImportSuggestionDenyListEntries method.", "type": "object", "properties": { "errorSamples": { "description": "A sample of errors encountered while processing the request.", "type": "array", "items": { "$ref": "GoogleRpcStatus" } }, "importedEntriesCount": { "description": "Count of deny list entries successfully imported.", "type": "string", "format": "int64" }, "failedEntriesCount": { "description": "Count of deny list entries that failed to be imported.", "type": "string", "format": "int64" } } }, "GoogleCloudDiscoveryengineV1alphaImportUserEventsMetadata": { "id": "GoogleCloudDiscoveryengineV1alphaImportUserEventsMetadata", "description": "Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field.", "type": "object", "properties": { "createTime": { "description": "Operation create time.", "type": "string", "format": "google-datetime" }, "updateTime": { "description": "Output only. Operation last update time. If the operation is done, this is also the finish time.", "readOnly": true, "type": "string", "format": "google-datetime" }, "successCount": { "description": "Count of entries that were processed successfully.", "type": "string", "format": "int64" }, "failureCount": { "description": "Count of entries that encountered errors while processing.", "type": "string", "format": "int64" } } }, "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.", "type": "object", "properties": { "errorSamples": { "description": "A sample of errors encountered while processing the request.", "type": "array", "items": { "$ref": "GoogleRpcStatus" } }, "errorConfig": { "description": "Echoes the destination for the complete errors if this field was set in the request.", "$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig" }, "joinedEventsCount": { "description": "Count of user events imported with complete existing Documents.", "type": "string", "format": "int64" }, "unjoinedEventsCount": { "description": "Count of user events imported, but with Document information not found in the existing Branch.", "type": "string", "format": "int64" } } }, "GoogleCloudDiscoveryengineV1alphaListSessionsRequest": { "id": "GoogleCloudDiscoveryengineV1alphaListSessionsRequest", "description": "Request for ListSessions method.", "type": "object", "properties": { "parent": { "description": "Required. The data store resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`", "type": "string" }, "pageSize": { "description": "Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.", "type": "integer", "format": "int32" }, "pageToken": { "description": "A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page.", "type": "string" }, "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\"`", "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` * `session_name` * `is_pinned` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1alphaPatientFilterOperationMetadata": { "id": "GoogleCloudDiscoveryengineV1alphaPatientFilterOperationMetadata", "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", "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.", "type": "string", "format": "google-datetime" }, "filtersAddedCount": { "description": "The number of patient IDs added to the patient filter.", "type": "string", "format": "int64" }, "filtersRemovedCount": { "description": "The number of patient IDs removed from the patient filter.", "type": "string", "format": "int64" } } }, "GoogleCloudDiscoveryengineV1alphaProvisionProjectMetadata": { "id": "GoogleCloudDiscoveryengineV1alphaProvisionProjectMetadata", "description": "Metadata associated with a project provision operation.", "type": "object", "properties": {} }, "GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsMetadata": { "id": "GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsMetadata", "description": "Metadata related to the progress of the PurgeCompletionSuggestions operation. This is returned by the google.longrunning.Operation.metadata field.", "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.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsResponse": { "id": "GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsResponse", "description": "Response message for CompletionService.PurgeCompletionSuggestions method.", "type": "object", "properties": { "purgeSucceeded": { "description": "Whether the completion suggestions were successfully purged.", "type": "boolean" }, "errorSamples": { "description": "A sample of errors encountered while processing the request.", "type": "array", "items": { "$ref": "GoogleRpcStatus" } } } }, "GoogleCloudDiscoveryengineV1alphaPurgeDocumentsMetadata": { "id": "GoogleCloudDiscoveryengineV1alphaPurgeDocumentsMetadata", "description": "Metadata related to the progress of the PurgeDocuments 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": { "description": "Operation last update time. If the operation is done, this is also the finish time.", "type": "string", "format": "google-datetime" }, "successCount": { "description": "Count of entries that were deleted successfully.", "type": "string", "format": "int64" }, "failureCount": { "description": "Count of entries that encountered errors while processing.", "type": "string", "format": "int64" }, "ignoredCount": { "description": "Count of entries that were ignored as entries were not found.", "type": "string", "format": "int64" } } }, "GoogleCloudDiscoveryengineV1alphaPurgeDocumentsResponse": { "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.", "type": "object", "properties": { "purgeCount": { "description": "The total count of documents purged as a result of the operation.", "type": "string", "format": "int64" }, "purgeSample": { "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.", "type": "array", "items": { "type": "string" } } } }, "GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesMetadata": { "id": "GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesMetadata", "description": "Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", "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.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesResponse": { "id": "GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesResponse", "description": "Response message for CompletionService.PurgeSuggestionDenyListEntries method.", "type": "object", "properties": { "purgeCount": { "description": "Number of suggestion deny list entries purged.", "type": "string", "format": "int64" }, "errorSamples": { "description": "A sample of errors encountered while processing the request.", "type": "array", "items": { "$ref": "GoogleRpcStatus" } } } }, "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": { "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.", "type": "string", "format": "google-datetime" }, "successCount": { "description": "Count of entries that were deleted successfully.", "type": "string", "format": "int64" }, "failureCount": { "description": "Count of entries that encountered errors while processing.", "type": "string", "format": "int64" } } }, "GoogleCloudDiscoveryengineV1alphaPurgeUserEventsResponse": { "id": "GoogleCloudDiscoveryengineV1alphaPurgeUserEventsResponse", "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.", "type": "object", "properties": { "purgeCount": { "description": "The total count of events purged as a result of the operation.", "type": "string", "format": "int64" } } }, "GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata": { "id": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata", "description": "Metadata related to the progress of the SiteSearchEngineService.RecrawlUris 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": { "description": "Operation last update time. If the operation is done, this is also the finish time.", "type": "string", "format": "google-datetime" }, "invalidUris": { "description": "Unique URIs in the request that have invalid format. Sample limited to 1000.", "type": "array", "items": { "type": "string" } }, "invalidUrisCount": { "description": "Total number of unique URIs in the request that have invalid format.", "type": "integer", "format": "int32" }, "noindexUris": { "description": "URIs that have no index meta tag. Sample limited to 1000.", "type": "array", "items": { "type": "string" } }, "noindexUrisCount": { "description": "Total number of URIs that have no index meta tag.", "type": "integer", "format": "int32" }, "urisNotMatchingTargetSites": { "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.", "type": "array", "items": { "type": "string" } }, "urisNotMatchingTargetSitesCount": { "description": "Total number of URIs that don't match any TargetSites.", "type": "integer", "format": "int32" }, "validUrisCount": { "description": "Total number of unique URIs in the request that are not in invalid_uris.", "type": "integer", "format": "int32" }, "successCount": { "description": "Total number of URIs that have been crawled so far.", "type": "integer", "format": "int32" }, "pendingCount": { "description": "Total number of URIs that have yet to be crawled.", "type": "integer", "format": "int32" }, "quotaExceededCount": { "description": "Total number of URIs that were rejected due to insufficient indexing resources.", "type": "integer", "format": "int32" } } }, "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponse": { "id": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponse", "description": "Response message for SiteSearchEngineService.RecrawlUris method.", "type": "object", "properties": { "failureSamples": { "description": "Details for a sample of up to 10 `failed_uris`.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo" } }, "failedUris": { "description": "URIs that were not crawled before the LRO terminated.", "type": "array", "items": { "type": "string" } } } }, "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo": { "id": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo", "description": "Details about why a particular URI failed to be crawled. Each FailureInfo contains one FailureReason per CorpusType.", "type": "object", "properties": { "uri": { "description": "URI that failed to be crawled.", "type": "string" }, "failureReasons": { "description": "List of failure reasons by corpus type (e.g. desktop, mobile).", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason" } } } }, "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason": { "id": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason", "description": "Details about why crawling failed for a particular CorpusType, e.g., DESKTOP and MOBILE crawling may fail for different reasons.", "type": "object", "properties": { "corpusType": { "description": "DESKTOP, MOBILE, or CORPUS_TYPE_UNSPECIFIED.", "type": "string", "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" ] }, "errorMessage": { "description": "Reason why the URI was not crawled.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1alphaRemoveDedicatedCrawlRateMetadata": { "id": "GoogleCloudDiscoveryengineV1alphaRemoveDedicatedCrawlRateMetadata", "description": "Metadata related to the progress of the CrawlRateManagementService.RemoveDedicatedCrawlRate 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": { "description": "Operation last update time. If the operation is done, this is also the finish time.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudDiscoveryengineV1alphaRemoveDedicatedCrawlRateResponse": { "id": "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.", "type": "object", "properties": { "state": { "description": "Output only. The state of the response.", "readOnly": true, "type": "string", "enumDescriptions": [ "The state is unspecified.", "The state is successful.", "The state is failed." ], "enum": [ "STATE_UNSPECIFIED", "SUCCEEDED", "FAILED" ] }, "error": { "description": "Errors from service when handling the request.", "$ref": "GoogleRpcStatus" } } }, "GoogleCloudDiscoveryengineV1alphaSetDedicatedCrawlRateMetadata": { "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", "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.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudDiscoveryengineV1alphaSetDedicatedCrawlRateResponse": { "id": "GoogleCloudDiscoveryengineV1alphaSetDedicatedCrawlRateResponse", "description": "Response message for CrawlRateManagementService.SetDedicatedCrawlRate method. It simply returns the state of the response, and an error message if the state is FAILED.", "type": "object", "properties": { "state": { "description": "Output only. The state of the response.", "readOnly": true, "type": "string", "enumDescriptions": [ "The state is unspecified.", "The state is successful.", "The state is failed." ], "enum": [ "STATE_UNSPECIFIED", "SUCCEEDED", "FAILED" ] }, "error": { "description": "Errors from service when handling the request.", "$ref": "GoogleRpcStatus" } } }, "GoogleCloudDiscoveryengineV1alphaSetUpDataConnectorMetadata": { "id": "GoogleCloudDiscoveryengineV1alphaSetUpDataConnectorMetadata", "description": "Metadata for DataConnectorService.SetUpDataConnector method.", "type": "object", "properties": {} }, "GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataMetadata": { "id": "GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataMetadata", "description": "Metadata related to the progress of the SiteSearchEngineService.SetUriPatternDocumentData 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": { "description": "Operation last update time. If the operation is done, this is also the finish time.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataResponse": { "id": "GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataResponse", "description": "Response message for SiteSearchEngineService.SetUriPatternDocumentData method.", "type": "object", "properties": {} }, "GoogleCloudDiscoveryengineV1alphaTrainCustomModelMetadata": { "id": "GoogleCloudDiscoveryengineV1alphaTrainCustomModelMetadata", "description": "Metadata related to the progress of the TrainCustomModel operation. This is returned by the google.longrunning.Operation.metadata field.", "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.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudDiscoveryengineV1alphaTrainCustomModelResponse": { "id": "GoogleCloudDiscoveryengineV1alphaTrainCustomModelResponse", "description": "Response of the TrainCustomModelRequest. This message is returned by the google.longrunning.Operations.response field.", "type": "object", "properties": { "errorSamples": { "description": "A sample of errors encountered while processing the data.", "type": "array", "items": { "$ref": "GoogleRpcStatus" } }, "errorConfig": { "description": "Echoes the destination for the complete errors in the request if set.", "$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig" }, "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": { "description": "The metrics of the trained model.", "type": "object", "additionalProperties": { "type": "number", "format": "double" } }, "modelName": { "description": "Fully qualified name of the CustomTuningModel.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1alphaTuneEngineMetadata": { "id": "GoogleCloudDiscoveryengineV1alphaTuneEngineMetadata", "description": "Metadata associated with a tune operation.", "type": "object", "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" } } }, "GoogleCloudDiscoveryengineV1alphaTuneEngineResponse": { "id": "GoogleCloudDiscoveryengineV1alphaTuneEngineResponse", "description": "Response associated with a tune operation.", "type": "object", "properties": {} }, "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": { "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.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudDiscoveryengineV1alphaUpdateCollectionMetadata": { "id": "GoogleCloudDiscoveryengineV1alphaUpdateCollectionMetadata", "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": { "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.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudDiscoveryengineV1alphaUpdateSchemaMetadata": { "id": "GoogleCloudDiscoveryengineV1alphaUpdateSchemaMetadata", "description": "Metadata for UpdateSchema LRO.", "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.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudDiscoveryengineV1alphaUpdateSessionRequest": { "id": "GoogleCloudDiscoveryengineV1alphaUpdateSessionRequest", "description": "Request for UpdateSession method.", "type": "object", "properties": { "session": { "description": "Required. The Session to update.", "$ref": "GoogleCloudDiscoveryengineV1alphaSession" }, "updateMask": { "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.", "type": "string", "format": "google-fieldmask" } } }, "GoogleCloudDiscoveryengineV1alphaUpdateTargetSiteMetadata": { "id": "GoogleCloudDiscoveryengineV1alphaUpdateTargetSiteMetadata", "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": { "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.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudDiscoveryengineV1betaAclConfig": { "id": "GoogleCloudDiscoveryengineV1betaAclConfig", "description": "Access Control Configuration.", "type": "object", "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": "GoogleCloudDiscoveryengineV1betaIdpConfig" } } }, "GoogleCloudDiscoveryengineV1betaIdpConfig": { "id": "GoogleCloudDiscoveryengineV1betaIdpConfig", "description": "Identity Provider Config.", "type": "object", "properties": { "idpType": { "description": "Identity provider type configured.", "type": "string", "enumDescriptions": [ "Default value. ACL search not enabled.", "Google 1P provider.", "Third party provider." ], "enum": [ "IDP_TYPE_UNSPECIFIED", "GSUITE", "THIRD_PARTY" ] }, "externalIdpConfig": { "description": "External Identity provider config.", "$ref": "GoogleCloudDiscoveryengineV1betaIdpConfigExternalIdpConfig" } } }, "GoogleCloudDiscoveryengineV1betaIdpConfigExternalIdpConfig": { "id": "GoogleCloudDiscoveryengineV1betaIdpConfigExternalIdpConfig", "description": "Third party IDP Config.", "type": "object", "properties": { "workforcePoolName": { "description": "Workforce pool name. Example: \"locations/global/workforcePools/pool_id\"", "type": "string" } } }, "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": { "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.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudDiscoveryengineV1betaBatchCreateTargetSitesResponse": { "id": "GoogleCloudDiscoveryengineV1betaBatchCreateTargetSitesResponse", "description": "Response message for SiteSearchEngineService.BatchCreateTargetSites method.", "type": "object", "properties": { "targetSites": { "description": "TargetSites created.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1betaTargetSite" } } } }, "GoogleCloudDiscoveryengineV1betaTargetSite": { "id": "GoogleCloudDiscoveryengineV1betaTargetSite", "description": "A target site for the SiteSearchEngine.", "type": "object", "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.", "readOnly": true, "type": "string" }, "providedUriPattern": { "description": "Required. Input only. The user provided URI pattern from which the `generated_uri_pattern` is generated.", "type": "string" }, "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" ] }, "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" }, "generatedUriPattern": { "description": "Output only. This is system-generated based on the provided_uri_pattern.", "readOnly": true, "type": "string" }, "rootDomainUri": { "description": "Output only. Root domain of the provided_uri_pattern.", "readOnly": true, "type": "string" }, "siteVerificationInfo": { "description": "Output only. Site ownership and validity verification status.", "readOnly": true, "$ref": "GoogleCloudDiscoveryengineV1betaSiteVerificationInfo" }, "indexingStatus": { "description": "Output only. Indexing status.", "readOnly": true, "type": "string", "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" ] }, "updateTime": { "description": "Output only. The target site's last updated time.", "readOnly": true, "type": "string", "format": "google-datetime" }, "failureReason": { "description": "Output only. Failure reason.", "readOnly": true, "$ref": "GoogleCloudDiscoveryengineV1betaTargetSiteFailureReason" } } }, "GoogleCloudDiscoveryengineV1betaSiteVerificationInfo": { "id": "GoogleCloudDiscoveryengineV1betaSiteVerificationInfo", "description": "Verification information for target sites in advanced site search.", "type": "object", "properties": { "siteVerificationState": { "description": "Site verification state indicating the ownership and validity.", "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." ], "enum": [ "SITE_VERIFICATION_STATE_UNSPECIFIED", "VERIFIED", "UNVERIFIED", "EXEMPTED" ] }, "verifyTime": { "description": "Latest site verification time.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudDiscoveryengineV1betaTargetSiteFailureReason": { "id": "GoogleCloudDiscoveryengineV1betaTargetSiteFailureReason", "description": "Site search indexing failure reasons.", "type": "object", "properties": { "quotaFailure": { "description": "Failed due to insufficient quota.", "$ref": "GoogleCloudDiscoveryengineV1betaTargetSiteFailureReasonQuotaFailure" } } }, "GoogleCloudDiscoveryengineV1betaTargetSiteFailureReasonQuotaFailure": { "id": "GoogleCloudDiscoveryengineV1betaTargetSiteFailureReasonQuotaFailure", "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.", "type": "string", "format": "int64" } } }, "GoogleCloudDiscoveryengineV1betaBatchUpdateUserLicensesMetadata": { "id": "GoogleCloudDiscoveryengineV1betaBatchUpdateUserLicensesMetadata", "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": { "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.", "type": "string", "format": "google-datetime" }, "successCount": { "description": "Count of user licenses successfully updated.", "type": "string", "format": "int64" }, "failureCount": { "description": "Count of user licenses that failed to be updated.", "type": "string", "format": "int64" } } }, "GoogleCloudDiscoveryengineV1betaBatchUpdateUserLicensesResponse": { "id": "GoogleCloudDiscoveryengineV1betaBatchUpdateUserLicensesResponse", "description": "Response message for UserLicenseService.BatchUpdateUserLicenses method.", "type": "object", "properties": { "userLicenses": { "description": "UserLicenses successfully updated.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1betaUserLicense" } }, "errorSamples": { "description": "A sample of errors encountered while processing the request.", "type": "array", "items": { "$ref": "GoogleRpcStatus" } } } }, "GoogleCloudDiscoveryengineV1betaUserLicense": { "id": "GoogleCloudDiscoveryengineV1betaUserLicense", "description": "User License information assigned by the admin.", "type": "object", "properties": { "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" }, "userProfile": { "description": "Optional. The user profile. We user user full name(First name + Last name) as user profile.", "type": "string" }, "licenseAssignmentState": { "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;", "readOnly": true, "type": "string", "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" ] }, "licenseConfig": { "description": "Optional. The full resource name of the Subscription(LicenseConfig) assigned to the user.", "type": "string" }, "createTime": { "description": "Output only. User created timestamp.", "readOnly": true, "type": "string", "format": "google-datetime" }, "updateTime": { "description": "Output only. User update timestamp.", "readOnly": true, "type": "string", "format": "google-datetime" }, "lastLoginTime": { "description": "Output only. User last logged in time. If the user has not logged in yet, this field will be empty.", "readOnly": true, "type": "string", "format": "google-datetime" } } }, "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": { "boostAction": { "description": "Defines a boost-type control", "$ref": "GoogleCloudDiscoveryengineV1betaControlBoostAction" }, "filterAction": { "description": "Defines a filter-type control Currently not supported by Recommendation", "$ref": "GoogleCloudDiscoveryengineV1betaControlFilterAction" }, "redirectAction": { "description": "Defines a redirect-type control.", "$ref": "GoogleCloudDiscoveryengineV1betaControlRedirectAction" }, "synonymsAction": { "description": "Treats a group of terms as synonyms of one another.", "$ref": "GoogleCloudDiscoveryengineV1betaControlSynonymsAction" }, "promoteAction": { "description": "Promote certain links based on predefined trigger queries.", "$ref": "GoogleCloudDiscoveryengineV1betaControlPromoteAction" }, "name": { "description": "Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*`", "type": "string" }, "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" }, "associatedServingConfigIds": { "description": "Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes.", "readOnly": true, "type": "array", "items": { "type": "string" } }, "solutionType": { "description": "Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown.", "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." ], "enum": [ "SOLUTION_TYPE_UNSPECIFIED", "SOLUTION_TYPE_RECOMMENDATION", "SOLUTION_TYPE_SEARCH", "SOLUTION_TYPE_CHAT", "SOLUTION_TYPE_GENERATIVE_CHAT", "SOLUTION_TYPE_AI_MODE" ] }, "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", "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." ], "enum": [ "SEARCH_USE_CASE_UNSPECIFIED", "SEARCH_USE_CASE_SEARCH", "SEARCH_USE_CASE_BROWSE" ] } }, "conditions": { "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", "items": { "$ref": "GoogleCloudDiscoveryengineV1betaCondition" } } } }, "GoogleCloudDiscoveryengineV1betaControlBoostAction": { "id": "GoogleCloudDiscoveryengineV1betaControlBoostAction", "description": "Adjusts order of products in returned list.", "type": "object", "properties": { "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" }, "interpolationBoostSpec": { "description": "Optional. Complex specification for custom ranking based on customer defined attribute value.", "$ref": "GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpec" }, "boost": { "description": "Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).", "deprecated": true, "type": "number", "format": "float" }, "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" }, "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" } } }, "GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpec": { "id": "GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpec", "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": { "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" ] }, "interpolationType": { "description": "Optional. 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" ] }, "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.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpecControlPoint" } } } }, "GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpecControlPoint": { "id": "GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpecControlPoint", "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": { "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" }, "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.", "type": "number", "format": "float" } } }, "GoogleCloudDiscoveryengineV1betaControlFilterAction": { "id": "GoogleCloudDiscoveryengineV1betaControlFilterAction", "description": "Specified which products may be included in results. Uses same filter as boost.", "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" } } }, "GoogleCloudDiscoveryengineV1betaControlRedirectAction": { "id": "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" } } }, "GoogleCloudDiscoveryengineV1betaControlSynonymsAction": { "id": "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\".", "type": "object", "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.", "type": "array", "items": { "type": "string" } } } }, "GoogleCloudDiscoveryengineV1betaControlPromoteAction": { "id": "GoogleCloudDiscoveryengineV1betaControlPromoteAction", "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", "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" } } }, "GoogleCloudDiscoveryengineV1betaSearchLinkPromotion": { "id": "GoogleCloudDiscoveryengineV1betaSearchLinkPromotion", "description": "Promotion proto includes uri and other helping information to display the promotion.", "type": "object", "properties": { "title": { "description": "Required. The title of the promotion. Maximum length: 160 characters.", "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" }, "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" }, "description": { "description": "Optional. The Promotion description. Maximum length: 200 characters.", "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" } } }, "GoogleCloudDiscoveryengineV1betaCondition": { "id": "GoogleCloudDiscoveryengineV1betaCondition", "description": "Defines circumstances to be checked before allowing a behavior", "type": "object", "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.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1betaConditionQueryTerm" } }, "activeTimeRange": { "description": "Range of time(s) specifying when condition is active. Maximum of 10 time ranges.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1betaConditionTimeRange" } }, "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" } } }, "GoogleCloudDiscoveryengineV1betaConditionQueryTerm": { "id": "GoogleCloudDiscoveryengineV1betaConditionQueryTerm", "description": "Matcher for search request query", "type": "object", "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": { "description": "Whether the search query needs to exactly match the query term.", "type": "boolean" } } }, "GoogleCloudDiscoveryengineV1betaConditionTimeRange": { "id": "GoogleCloudDiscoveryengineV1betaConditionTimeRange", "description": "Used for time-dependent conditions.", "type": "object", "properties": { "startTime": { "description": "Start of time range. Range is inclusive.", "type": "string", "format": "google-datetime" }, "endTime": { "description": "End of time range. Range is inclusive. Must be in the future.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudDiscoveryengineV1betaCreateDataStoreMetadata": { "id": "GoogleCloudDiscoveryengineV1betaCreateDataStoreMetadata", "description": "Metadata related to the progress of the DataStoreService.CreateDataStore 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": { "description": "Operation last update time. If the operation is done, this is also the finish time.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudDiscoveryengineV1betaCreateEngineMetadata": { "id": "GoogleCloudDiscoveryengineV1betaCreateEngineMetadata", "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": { "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.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudDiscoveryengineV1betaCreateEvaluationMetadata": { "id": "GoogleCloudDiscoveryengineV1betaCreateEvaluationMetadata", "description": "Metadata for EvaluationService.CreateEvaluation method.", "type": "object", "properties": {} }, "GoogleCloudDiscoveryengineV1betaCreateSchemaMetadata": { "id": "GoogleCloudDiscoveryengineV1betaCreateSchemaMetadata", "description": "Metadata for Create Schema LRO.", "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.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudDiscoveryengineV1betaCreateSitemapMetadata": { "id": "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": { "description": "Operation last update time. If the operation is done, this is also the finish time.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudDiscoveryengineV1betaCreateTargetSiteMetadata": { "id": "GoogleCloudDiscoveryengineV1betaCreateTargetSiteMetadata", "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": { "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.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudDiscoveryengineV1betaDataStore": { "id": "GoogleCloudDiscoveryengineV1betaDataStore", "description": "DataStore captures global settings and configs at the DataStore level.", "type": "object", "properties": { "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" }, "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" }, "industryVertical": { "description": "Immutable. The industry vertical that the data store registers.", "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" ] }, "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": { "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." ], "enum": [ "SOLUTION_TYPE_UNSPECIFIED", "SOLUTION_TYPE_RECOMMENDATION", "SOLUTION_TYPE_SEARCH", "SOLUTION_TYPE_CHAT", "SOLUTION_TYPE_GENERATIVE_CHAT", "SOLUTION_TYPE_AI_MODE" ] } }, "defaultSchemaId": { "description": "Output only. The id of the default Schema associated to this data store.", "readOnly": true, "type": "string" }, "contentConfig": { "description": "Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.", "type": "string", "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." ], "enum": [ "CONTENT_CONFIG_UNSPECIFIED", "NO_CONTENT", "CONTENT_REQUIRED", "PUBLIC_WEBSITE", "GOOGLE_WORKSPACE" ] }, "createTime": { "description": "Output only. Timestamp the DataStore was created at.", "readOnly": true, "type": "string", "format": "google-datetime" }, "advancedSiteSearchConfig": { "description": "Optional. Configuration for advanced site search.", "$ref": "GoogleCloudDiscoveryengineV1betaAdvancedSiteSearchConfig" }, "languageInfo": { "description": "Language info for DataStore.", "$ref": "GoogleCloudDiscoveryengineV1betaLanguageInfo" }, "naturalLanguageQueryUnderstandingConfig": { "description": "Optional. Configuration for Natural Language Query Understanding.", "$ref": "GoogleCloudDiscoveryengineV1betaNaturalLanguageQueryUnderstandingConfig" }, "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" }, "cmekConfig": { "description": "Output only. CMEK-related information for the DataStore.", "readOnly": true, "$ref": "GoogleCloudDiscoveryengineV1betaCmekConfig" }, "billingEstimation": { "description": "Output only. Data size estimation for billing.", "readOnly": true, "$ref": "GoogleCloudDiscoveryengineV1betaDataStoreBillingEstimation" }, "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" }, "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" }, "documentProcessingConfig": { "description": "Configuration for Document understanding and enrichment.", "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig" }, "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" }, "healthcareFhirConfig": { "description": "Optional. Configuration for `HEALTHCARE_FHIR` vertical.", "$ref": "GoogleCloudDiscoveryengineV1betaHealthcareFhirConfig" }, "servingConfigDataStore": { "description": "Optional. Stores serving config at DataStore level.", "$ref": "GoogleCloudDiscoveryengineV1betaDataStoreServingConfigDataStore" }, "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" }, "isInfobotFaqDataStore": { "description": "Optional. If set, this DataStore is an Infobot FAQ DataStore.", "type": "boolean" }, "federatedSearchConfig": { "description": "Optional. If set, this DataStore is a federated search DataStore.", "$ref": "GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfig" }, "configurableBillingApproach": { "description": "Optional. Configuration for configurable billing approach. See", "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." ], "enum": [ "CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED", "CONFIGURABLE_SUBSCRIPTION_INDEXING_CORE", "CONFIGURABLE_CONSUMPTION_EMBEDDING" ] }, "configurableBillingApproachUpdateTime": { "description": "Output only. The timestamp when configurable_billing_approach was last updated.", "readOnly": true, "type": "string", "format": "google-datetime" } } }, "GoogleCloudDiscoveryengineV1betaAdvancedSiteSearchConfig": { "id": "GoogleCloudDiscoveryengineV1betaAdvancedSiteSearchConfig", "description": "Configuration data for advance site search.", "type": "object", "properties": { "disableInitialIndex": { "description": "If set true, initial indexing is disabled for the DataStore.", "type": "boolean" }, "disableAutomaticRefresh": { "description": "If set true, automatic refresh is disabled for the DataStore.", "type": "boolean" } } }, "GoogleCloudDiscoveryengineV1betaLanguageInfo": { "id": "GoogleCloudDiscoveryengineV1betaLanguageInfo", "description": "Language info for DataStore.", "type": "object", "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`.", "readOnly": true, "type": "string" }, "language": { "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, "type": "string" }, "region": { "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, "type": "string" } } }, "GoogleCloudDiscoveryengineV1betaNaturalLanguageQueryUnderstandingConfig": { "id": "GoogleCloudDiscoveryengineV1betaNaturalLanguageQueryUnderstandingConfig", "description": "Configuration for Natural Language Query Understanding.", "type": "object", "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" ] } } }, "GoogleCloudDiscoveryengineV1betaCmekConfig": { "id": "GoogleCloudDiscoveryengineV1betaCmekConfig", "description": "Configurations used to enable CMEK data encryption with Cloud KMS keys.", "type": "object", "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" }, "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": { "description": "Output only. KMS key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`.", "readOnly": true, "type": "string" }, "state": { "description": "Output only. The states of the CmekConfig.", "readOnly": true, "type": "string", "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." ], "enum": [ "STATE_UNSPECIFIED", "CREATING", "ACTIVE", "KEY_ISSUE", "DELETING", "DELETE_FAILED", "UNUSABLE", "ACTIVE_ROTATING", "DELETED", "EXPIRED" ] }, "isDefault": { "description": "Output only. The default CmekConfig for the Customer.", "readOnly": true, "type": "boolean" }, "lastRotationTimestampMicros": { "description": "Output only. The timestamp of the last key rotation.", "readOnly": true, "type": "string", "format": "int64" }, "singleRegionKeys": { "description": "Optional. Single-regional CMEKs that are required for some VAIS features.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1betaSingleRegionKey" } }, "notebooklmState": { "description": "Output only. Whether the NotebookLM Corpus is ready to be used.", "readOnly": true, "type": "string", "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" ] } } }, "GoogleCloudDiscoveryengineV1betaSingleRegionKey": { "id": "GoogleCloudDiscoveryengineV1betaSingleRegionKey", "description": "Metadata for single-regional CMEKs.", "type": "object", "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" } } }, "GoogleCloudDiscoveryengineV1betaDataStoreBillingEstimation": { "id": "GoogleCloudDiscoveryengineV1betaDataStoreBillingEstimation", "description": "Estimation of data size per data store.", "type": "object", "properties": { "structuredDataSize": { "description": "Data size for structured data in terms of bytes.", "type": "string", "format": "int64" }, "unstructuredDataSize": { "description": "Data size for unstructured data in terms of bytes.", "type": "string", "format": "int64" }, "websiteDataSize": { "description": "Data size for websites in terms of bytes.", "type": "string", "format": "int64" }, "structuredDataUpdateTime": { "description": "Last updated timestamp for structured data.", "type": "string", "format": "google-datetime" }, "unstructuredDataUpdateTime": { "description": "Last updated timestamp for unstructured data.", "type": "string", "format": "google-datetime" }, "websiteDataUpdateTime": { "description": "Last updated timestamp for websites.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudDiscoveryengineV1betaWorkspaceConfig": { "id": "GoogleCloudDiscoveryengineV1betaWorkspaceConfig", "description": "Config to store data store type configuration for workspace data", "type": "object", "properties": { "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" ], "enum": [ "TYPE_UNSPECIFIED", "GOOGLE_DRIVE", "GOOGLE_MAIL", "GOOGLE_SITES", "GOOGLE_CALENDAR", "GOOGLE_CHAT", "GOOGLE_GROUPS", "GOOGLE_KEEP", "GOOGLE_PEOPLE" ] }, "dasherCustomerId": { "description": "Obfuscated Dasher customer ID.", "type": "string" }, "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" } } }, "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig": { "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig", "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.", "type": "object", "properties": { "name": { "description": "The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`.", "type": "string" }, "chunkingConfig": { "description": "Whether chunking mode is enabled.", "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig" }, "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" }, "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" } } } }, "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig": { "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig", "description": "Configuration for chunking config.", "type": "object", "properties": { "layoutBasedChunkingConfig": { "description": "Configuration for the layout based chunking.", "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig" } } }, "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig": { "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", "description": "Configuration for the layout based chunking.", "type": "object", "properties": { "chunkSize": { "description": "The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500.", "type": "integer", "format": "int32" }, "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" } } }, "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig": { "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig", "description": "Related configurations applied to a specific type of document parser.", "type": "object", "properties": { "digitalParsingConfig": { "description": "Configurations applied to digital parser.", "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig" }, "ocrParsingConfig": { "description": "Configurations applied to OCR parser. Currently it only applies to PDFs.", "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig" }, "layoutParsingConfig": { "description": "Configurations applied to layout parser.", "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig" } } }, "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig": { "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig", "description": "The digital parsing configurations for documents.", "type": "object", "properties": {} }, "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig": { "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig", "description": "The OCR parsing configurations for documents.", "type": "object", "properties": { "enhancedDocumentElements": { "description": "[DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`.", "deprecated": true, "type": "array", "items": { "type": "string" } }, "useNativeText": { "description": "If true, will use native text instead of OCR text on pages containing native text.", "type": "boolean" } } }, "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig": { "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig", "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": { "description": "Optional. If true, the LLM based annotation is added to the image during parsing.", "type": "boolean" }, "enableLlmLayoutParsing": { "description": "Optional. If true, the pdf layout will be refined using an LLM.", "type": "boolean" }, "structuredContentTypes": { "description": "Optional. Contains the required structure types to extract from the document. Supported values: * `shareholder-structure`", "type": "array", "items": { "type": "string" } }, "excludeHtmlElements": { "description": "Optional. List of HTML elements to exclude from the parsed content.", "type": "array", "items": { "type": "string" } }, "excludeHtmlClasses": { "description": "Optional. List of HTML classes to exclude from the parsed content.", "type": "array", "items": { "type": "string" } }, "excludeHtmlIds": { "description": "Optional. List of HTML ids to exclude from the parsed content.", "type": "array", "items": { "type": "string" } }, "enableGetProcessedDocument": { "description": "Optional. If true, the processed document will be made available for the GetProcessedDocument API.", "type": "boolean" } } }, "GoogleCloudDiscoveryengineV1betaSchema": { "id": "GoogleCloudDiscoveryengineV1betaSchema", "description": "Defines the structure and layout of a type of document data.", "type": "object", "properties": { "structSchema": { "description": "The structured representation of the schema.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "jsonSchema": { "description": "The JSON representation of the schema.", "type": "string" }, "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" } } }, "GoogleCloudDiscoveryengineV1betaHealthcareFhirConfig": { "id": "GoogleCloudDiscoveryengineV1betaHealthcareFhirConfig", "description": "Config to data store for `HEALTHCARE_FHIR` vertical.", "type": "object", "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": { "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" } } } }, "GoogleCloudDiscoveryengineV1betaDataStoreServingConfigDataStore": { "id": "GoogleCloudDiscoveryengineV1betaDataStoreServingConfigDataStore", "description": "Stores information regarding the serving configurations at DataStore level.", "type": "object", "properties": { "disabledForServing": { "description": "Optional. If set true, the DataStore will not be available for serving search requests.", "type": "boolean" } } }, "GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfig": { "id": "GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfig", "description": "Stores information for federated search.", "type": "object", "properties": { "alloyDbConfig": { "description": "AlloyDB config. If set, this DataStore is connected to AlloyDB.", "$ref": "GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfigAlloyDbConfig" }, "thirdPartyOauthConfig": { "description": "Third Party OAuth config. If set, this DataStore is connected to a third party application.", "$ref": "GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfigThirdPartyOauthConfig" }, "notebooklmConfig": { "description": "NotebookLM config. If set, this DataStore is connected to NotebookLM Enterprise.", "$ref": "GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfigNotebooklmConfig" } } }, "GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfigAlloyDbConfig": { "id": "GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfigAlloyDbConfig", "description": "Stores information for connecting to AlloyDB.", "type": "object", "properties": { "alloydbConnectionConfig": { "description": "Required. Configuration for connecting to AlloyDB.", "$ref": "GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfigAlloyDbConfigAlloyDbConnectionConfig" }, "alloydbAiNlConfig": { "description": "Optional. Configuration for Magic.", "$ref": "GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfigAlloyDbConfigAlloyDbAiNaturalLanguageConfig" }, "returnedFields": { "description": "Optional. Fields to be returned in the search results. If empty, all fields will be returned.", "type": "array", "items": { "type": "string" } } } }, "GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfigAlloyDbConfigAlloyDbConnectionConfig": { "id": "GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfigAlloyDbConfigAlloyDbConnectionConfig", "description": "Configuration for connecting to AlloyDB.", "type": "object", "properties": { "instance": { "description": "Required. The AlloyDB instance to connect to.", "type": "string" }, "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" }, "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" }, "authMode": { "description": "Optional. Auth mode.", "type": "string", "enumDescriptions": [ "", "Uses P4SA when VAIS talks to AlloyDB.", "Uses EUC when VAIS talks to AlloyDB." ], "enum": [ "AUTH_MODE_UNSPECIFIED", "AUTH_MODE_SERVICE_ACCOUNT", "AUTH_MODE_END_USER_ACCOUNT" ] }, "enablePsvs": { "description": "Optional. If true, enable PSVS for AlloyDB.", "type": "boolean" } } }, "GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfigAlloyDbConfigAlloyDbAiNaturalLanguageConfig": { "id": "GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfigAlloyDbConfigAlloyDbAiNaturalLanguageConfig", "description": "Configuration for AlloyDB AI Natural Language.", "type": "object", "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" } } }, "GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfigThirdPartyOauthConfig": { "id": "GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfigThirdPartyOauthConfig", "description": "Stores information for third party applicationOAuth.", "type": "object", "properties": { "appName": { "description": "Optional. The type of the application. E.g., \"jira\", \"box\", etc.", "type": "string" }, "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" } } }, "GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfigNotebooklmConfig": { "id": "GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfigNotebooklmConfig", "description": "Config for connecting to NotebookLM Enterprise.", "type": "object", "properties": { "searchConfig": { "description": "Required. Search config name. Format: projects/*/locations/global/notebookLmSearchConfigs/*", "type": "string" } } }, "GoogleCloudDiscoveryengineV1betaDeleteDataStoreMetadata": { "id": "GoogleCloudDiscoveryengineV1betaDeleteDataStoreMetadata", "description": "Metadata related to the progress of the DataStoreService.DeleteDataStore 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": { "description": "Operation last update time. If the operation is done, this is also the finish time.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudDiscoveryengineV1betaDeleteEngineMetadata": { "id": "GoogleCloudDiscoveryengineV1betaDeleteEngineMetadata", "description": "Metadata related to the progress of the EngineService.DeleteEngine 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": { "description": "Operation last update time. If the operation is done, this is also the finish time.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudDiscoveryengineV1betaDeleteIdentityMappingStoreMetadata": { "id": "GoogleCloudDiscoveryengineV1betaDeleteIdentityMappingStoreMetadata", "description": "Metadata related to the progress of the IdentityMappingStoreService.DeleteIdentityMappingStore 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": { "description": "Operation last update time. If the operation is done, this is also the finish time.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudDiscoveryengineV1betaDeleteSchemaMetadata": { "id": "GoogleCloudDiscoveryengineV1betaDeleteSchemaMetadata", "description": "Metadata for DeleteSchema LRO.", "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.", "type": "string", "format": "google-datetime" } } }, "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": { "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.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudDiscoveryengineV1betaDeleteTargetSiteMetadata": { "id": "GoogleCloudDiscoveryengineV1betaDeleteTargetSiteMetadata", "description": "Metadata related to the progress of the SiteSearchEngineService.DeleteTargetSite 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": { "description": "Operation last update time. If the operation is done, this is also the finish time.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchMetadata": { "id": "GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchMetadata", "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": { "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.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchResponse": { "id": "GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchResponse", "description": "Response message for SiteSearchEngineService.DisableAdvancedSiteSearch method.", "type": "object", "properties": {} }, "GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchMetadata": { "id": "GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchMetadata", "description": "Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch 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": { "description": "Operation last update time. If the operation is done, this is also the finish time.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchResponse": { "id": "GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchResponse", "description": "Response message for SiteSearchEngineService.EnableAdvancedSiteSearch method.", "type": "object", "properties": {} }, "GoogleCloudDiscoveryengineV1betaEngine": { "id": "GoogleCloudDiscoveryengineV1betaEngine", "description": "Metadata that describes the training and serving parameters of an Engine.", "type": "object", "properties": { "chatEngineConfig": { "description": "Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.", "$ref": "GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig" }, "searchEngineConfig": { "description": "Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.", "$ref": "GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig" }, "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" }, "chatEngineMetadata": { "description": "Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.", "readOnly": true, "$ref": "GoogleCloudDiscoveryengineV1betaEngineChatEngineMetadata" }, "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" }, "displayName": { "description": "Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.", "type": "string" }, "createTime": { "description": "Output only. Timestamp the Recommendation Engine was created at.", "readOnly": true, "type": "string", "format": "google-datetime" }, "updateTime": { "description": "Output only. Timestamp the Recommendation Engine was last updated.", "readOnly": true, "type": "string", "format": "google-datetime" }, "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.", "type": "array", "items": { "type": "string" } }, "solutionType": { "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." ], "enum": [ "SOLUTION_TYPE_UNSPECIFIED", "SOLUTION_TYPE_RECOMMENDATION", "SOLUTION_TYPE_SEARCH", "SOLUTION_TYPE_CHAT", "SOLUTION_TYPE_GENERATIVE_CHAT", "SOLUTION_TYPE_AI_MODE" ] }, "industryVertical": { "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.", "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" ] }, "commonConfig": { "description": "Common config spec that specifies the metadata of the engine.", "$ref": "GoogleCloudDiscoveryengineV1betaEngineCommonConfig" }, "knowledgeGraphConfig": { "description": "Optional. Configurations for the Knowledge Graph. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.", "$ref": "GoogleCloudDiscoveryengineV1betaEngineKnowledgeGraphConfig" }, "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.", "type": "string", "enumDescriptions": [ "All non specified apps.", "App type for intranet search and Agentspace." ], "enum": [ "APP_TYPE_UNSPECIFIED", "APP_TYPE_INTRANET" ] }, "disableAnalytics": { "description": "Optional. Whether to disable analytics for searches performed on this engine.", "type": "boolean" }, "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` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-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` * `disable-canvas-workspace` * `disable-skills` * `enable-end-user-sharing-with-groups`", "type": "object", "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" ] } }, "cmekConfig": { "description": "Output only. CMEK-related information for the Engine.", "readOnly": true, "$ref": "GoogleCloudDiscoveryengineV1betaCmekConfig" }, "configurableBillingApproach": { "description": "Optional. Configuration for configurable billing approach.", "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." ], "enum": [ "CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED", "CONFIGURABLE_BILLING_APPROACH_ENABLED" ] }, "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.", "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" ] } }, "observabilityConfig": { "description": "Optional. Observability config for the engine.", "$ref": "GoogleCloudDiscoveryengineV1betaObservabilityConfig" }, "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.", "type": "object", "additionalProperties": { "type": "string" } }, "agentGatewaySetting": { "description": "Optional. The agent gateway setting for the engine.", "$ref": "GoogleCloudDiscoveryengineV1betaAgentGatewaySetting" }, "marketplaceAgentVisibility": { "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." ], "enum": [ "MARKETPLACE_AGENT_VISIBILITY_UNSPECIFIED", "SHOW_AVAILABLE_AGENTS_ONLY", "SHOW_AGENTS_ALREADY_INTEGRATED", "SHOW_AGENTS_ALREADY_PURCHASED", "SHOW_ALL_AGENTS" ] }, "procurementContactEmails": { "description": "Optional. The emails of the procurement contacts.", "type": "array", "items": { "type": "string" } } } }, "GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig": { "id": "GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig", "description": "Configurations for a Chat Engine.", "type": "object", "properties": { "agentCreationConfig": { "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.", "$ref": "GoogleCloudDiscoveryengineV1betaEngineChatEngineConfigAgentCreationConfig" }, "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" } } }, "GoogleCloudDiscoveryengineV1betaEngineChatEngineConfigAgentCreationConfig": { "id": "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": { "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": { "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" }, "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" }, "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" } } }, "GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig": { "id": "GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig", "description": "Configurations for a Search Engine.", "type": "object", "properties": { "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.", "type": "string", "enumDescriptions": [ "Default value when the enum is unspecified. This is invalid to use.", "Standard tier.", "Enterprise tier." ], "enum": [ "SEARCH_TIER_UNSPECIFIED", "SEARCH_TIER_STANDARD", "SEARCH_TIER_ENTERPRISE" ] }, "requiredSubscriptionTier": { "description": "Optional. The required subscription tier of this engine. They cannot be modified after engine creation. If the required subscription tier is search, user with higher license tier like assist can still access the standalone app associated with this engine.", "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." ], "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" ] }, "searchAddOns": { "description": "The add-on that this search engine enables.", "type": "array", "items": { "type": "string", "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" ] } } } }, "GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfig": { "id": "GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfig", "description": "Additional config specs for a Media Recommendation engine.", "type": "object", "properties": { "type": { "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`.", "type": "string" }, "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" }, "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" }, "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.", "type": "string", "enumDescriptions": [ "Unspecified training state.", "The engine training is paused.", "The engine is training." ], "enum": [ "TRAINING_STATE_UNSPECIFIED", "PAUSED", "TRAINING" ] }, "engineFeaturesConfig": { "description": "Optional. Additional engine features config.", "$ref": "GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigEngineFeaturesConfig" } } }, "GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig": { "id": "GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig", "description": "Custom threshold for `cvr` optimization_objective.", "type": "object", "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" } } }, "GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigEngineFeaturesConfig": { "id": "GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigEngineFeaturesConfig", "description": "More feature configs of the selected engine type.", "type": "object", "properties": { "recommendedForYouConfig": { "description": "Recommended for you engine feature config.", "$ref": "GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig" }, "mostPopularConfig": { "description": "Most popular engine feature config.", "$ref": "GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigMostPopularFeatureConfig" } } }, "GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig": { "id": "GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig", "description": "Additional feature configurations for creating a `recommended-for-you` engine.", "type": "object", "properties": { "contextEventType": { "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`.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigMostPopularFeatureConfig": { "id": "GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigMostPopularFeatureConfig", "description": "Feature configurations that are required for creating a Most Popular engine.", "type": "object", "properties": { "timeWindowDays": { "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": "string", "format": "int64" } } }, "GoogleCloudDiscoveryengineV1betaEngineChatEngineMetadata": { "id": "GoogleCloudDiscoveryengineV1betaEngineChatEngineMetadata", "description": "Additional information of a Chat Engine. Fields in this message are output only.", "type": "object", "properties": { "dialogflowAgent": { "description": "The resource name of a Dialogflow agent, that this Chat Engine refers to. Format: `projects//locations//agents/`.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1betaEngineCommonConfig": { "id": "GoogleCloudDiscoveryengineV1betaEngineCommonConfig", "description": "Common configurations for an Engine.", "type": "object", "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" } } }, "GoogleCloudDiscoveryengineV1betaEngineKnowledgeGraphConfig": { "id": "GoogleCloudDiscoveryengineV1betaEngineKnowledgeGraphConfig", "description": "Configuration message for the Knowledge Graph.", "type": "object", "properties": { "enableCloudKnowledgeGraph": { "description": "Whether to enable the Cloud Knowledge Graph for the engine. Defaults to false if not specified.", "type": "boolean" }, "cloudKnowledgeGraphTypes": { "description": "Specify entity types to support.", "type": "array", "items": { "type": "string" } }, "enablePrivateKnowledgeGraph": { "description": "Whether to enable the Private Knowledge Graph for the engine. Defaults to false if not specified.", "type": "boolean" }, "privateKnowledgeGraphTypes": { "description": "Specify entity types to support.", "type": "array", "items": { "type": "string" } }, "featureConfig": { "description": "Optional. Feature config for the Knowledge Graph.", "$ref": "GoogleCloudDiscoveryengineV1betaEngineKnowledgeGraphConfigFeatureConfig" } } }, "GoogleCloudDiscoveryengineV1betaEngineKnowledgeGraphConfigFeatureConfig": { "id": "GoogleCloudDiscoveryengineV1betaEngineKnowledgeGraphConfigFeatureConfig", "description": "Feature config for the Knowledge Graph.", "type": "object", "properties": { "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" }, "disablePrivateKgAutoComplete": { "description": "Whether to disable the private KG auto complete 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" } } }, "GoogleCloudDiscoveryengineV1betaObservabilityConfig": { "id": "GoogleCloudDiscoveryengineV1betaObservabilityConfig", "description": "Observability config for a resource.", "type": "object", "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" } } }, "GoogleCloudDiscoveryengineV1betaAgentGatewaySetting": { "id": "GoogleCloudDiscoveryengineV1betaAgentGatewaySetting", "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": { "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": "GoogleCloudDiscoveryengineV1betaAgentGatewaySettingAgentGatewayReference" } } }, "GoogleCloudDiscoveryengineV1betaAgentGatewaySettingAgentGatewayReference": { "id": "GoogleCloudDiscoveryengineV1betaAgentGatewaySettingAgentGatewayReference", "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" } } }, "GoogleCloudDiscoveryengineV1betaEvaluation": { "id": "GoogleCloudDiscoveryengineV1betaEvaluation", "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", "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" }, "evaluationSpec": { "description": "Required. The specification of the evaluation.", "$ref": "GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpec" }, "qualityMetrics": { "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.", "readOnly": true, "$ref": "GoogleCloudDiscoveryengineV1betaQualityMetrics" }, "state": { "description": "Output only. The state of the evaluation.", "readOnly": true, "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." ], "enum": [ "STATE_UNSPECIFIED", "PENDING", "RUNNING", "SUCCEEDED", "FAILED" ] }, "error": { "description": "Output only. The error that occurred during evaluation. Only populated when the evaluation's state is FAILED.", "readOnly": true, "$ref": "GoogleRpcStatus" }, "createTime": { "description": "Output only. Timestamp the Evaluation was created at.", "readOnly": true, "type": "string", "format": "google-datetime" }, "endTime": { "description": "Output only. Timestamp the Evaluation was completed at.", "readOnly": true, "type": "string", "format": "google-datetime" }, "errorSamples": { "description": "Output only. A sample of errors encountered while processing the request.", "readOnly": true, "type": "array", "items": { "$ref": "GoogleRpcStatus" } } } }, "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" } } }, "GoogleCloudDiscoveryengineV1betaSearchRequest": { "id": "GoogleCloudDiscoveryengineV1betaSearchRequest", "description": "Request message for SearchService.Search method.", "type": "object", "properties": { "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" }, "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" }, "query": { "description": "Raw search query.", "type": "string" }, "pageCategories": { "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`", "type": "array", "items": { "type": "string" } }, "imageQuery": { "description": "Raw image query.", "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestImageQuery" }, "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" }, "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" }, "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" }, "oneBoxPageSize": { "description": "The maximum number of results to return for OneBox. This applies to each OneBox type individually. Default number is 10.", "type": "integer", "format": "int32" }, "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.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec" } }, "numResultsPerDataStore": { "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", "format": "int32" }, "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" }, "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" }, "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" }, "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": "GoogleCloudDiscoveryengineV1betaUserInfo" }, "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" }, "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" }, "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.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpec" } }, "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" }, "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" } }, "queryExpansionSpec": { "description": "The query expansion specification that specifies the conditions under which query expansion occurs.", "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec" }, "spellCorrectionSpec": { "description": "The spell correction specification that specifies the mode under which spell correction takes effect.", "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestSpellCorrectionSpec" }, "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" }, "contentSearchSpec": { "description": "A specification for configuring the behavior of content search.", "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec" }, "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" }, "rankingExpression": { "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", "type": "string" }, "rankingExpressionBackend": { "description": "Optional. The backend to use for the ranking expression evaluation.", "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" ] }, "safeSearch": { "description": "Whether to turn on safe search. This is only supported for website search.", "type": "boolean" }, "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.", "type": "object", "additionalProperties": { "type": "string" } }, "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" }, "searchAsYouTypeSpec": { "description": "Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical.", "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec" }, "displaySpec": { "description": "Optional. Config for display feature, like match highlighting on search results.", "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestDisplaySpec" }, "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" } }, "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" }, "sessionSpec": { "description": "Session specification. Can be used only when `session` is set.", "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestSessionSpec" }, "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" ] }, "relevanceFilterSpec": { "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.", "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpec" }, "personalizationSpec": { "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.", "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestPersonalizationSpec" }, "relevanceScoreSpec": { "description": "Optional. The specification for returning the relevance score.", "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceScoreSpec" }, "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" }, "customRankingParams": { "description": "Optional. Optional configuration for the Custom Ranking feature.", "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestCustomRankingParams" }, "entity": { "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.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1betaSearchRequestImageQuery": { "id": "GoogleCloudDiscoveryengineV1betaSearchRequestImageQuery", "description": "Specifies the image query input.", "type": "object", "properties": { "imageBytes": { "description": "Base64 encoded image bytes. Supported image formats: JPEG, PNG, and BMP.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec": { "id": "GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec", "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", "properties": { "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" }, "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" }, "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": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec" }, "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" } } }, "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec": { "id": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec", "description": "Boost specification to boost certain documents.", "type": "object", "properties": { "conditionBoostSpecs": { "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": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpec" } } } }, "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpec": { "id": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpec", "description": "Boost applies to documents which match a condition.", "type": "object", "properties": { "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" }, "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" }, "boostControlSpec": { "description": "Complex specification for custom ranking based on customer defined attribute value.", "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec" } } }, "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec": { "id": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec", "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": { "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).", "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" ] }, "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" ] }, "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.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint" } } } }, "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint": { "id": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint", "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": { "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": { "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", "format": "float" } } }, "GoogleCloudDiscoveryengineV1betaUserInfo": { "id": "GoogleCloudDiscoveryengineV1betaUserInfo", "description": "Information of an end user.", "type": "object", "properties": { "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" }, "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" }, "timeZone": { "description": "Optional. IANA time zone, e.g. Europe/Budapest.", "type": "string" }, "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" } } }, "GoogleCloudDiscoveryengineV1betaUserInfoPreciseLocation": { "id": "GoogleCloudDiscoveryengineV1betaUserInfoPreciseLocation", "description": "Precise location info with multiple representation options. Currently only latitude and longitude point is supported.", "type": "object", "properties": { "point": { "description": "Optional. Location represented by a latitude/longitude point.", "$ref": "GoogleTypeLatLng" }, "address": { "description": "Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpec": { "id": "GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpec", "description": "A facet specification to perform faceted search.", "type": "object", "properties": { "facetKey": { "description": "Required. The facet key specification.", "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpecFacetKey" }, "limit": { "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", "format": "int32" }, "excludedFilterKeys": { "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", "items": { "type": "string" } }, "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" } } }, "GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpecFacetKey": { "id": "GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpecFacetKey", "description": "Specifies how a facet is computed.", "type": "object", "properties": { "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" }, "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": "GoogleCloudDiscoveryengineV1betaInterval" } }, "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.", "type": "array", "items": { "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" } }, "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.", "type": "array", "items": { "type": "string" } }, "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" } } }, "GoogleCloudDiscoveryengineV1betaInterval": { "id": "GoogleCloudDiscoveryengineV1betaInterval", "description": "A floating point interval.", "type": "object", "properties": { "minimum": { "description": "Inclusive lower bound.", "type": "number", "format": "double" }, "exclusiveMinimum": { "description": "Exclusive lower bound.", "type": "number", "format": "double" }, "maximum": { "description": "Inclusive upper bound.", "type": "number", "format": "double" }, "exclusiveMaximum": { "description": "Exclusive upper bound.", "type": "number", "format": "double" } } }, "GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec": { "id": "GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec", "description": "Specification to determine under which conditions query expansion should occur.", "type": "object", "properties": { "condition": { "description": "The condition under which query expansion should occur. Default to Condition.DISABLED.", "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." ], "enum": [ "CONDITION_UNSPECIFIED", "DISABLED", "AUTO" ] }, "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" } } }, "GoogleCloudDiscoveryengineV1betaSearchRequestSpellCorrectionSpec": { "id": "GoogleCloudDiscoveryengineV1betaSearchRequestSpellCorrectionSpec", "description": "The specification for query spell correction.", "type": "object", "properties": { "mode": { "description": "The mode under which spell correction replaces the original search query. Defaults to Mode.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." ], "enum": [ "MODE_UNSPECIFIED", "SUGGESTION_ONLY", "AUTO" ] } } }, "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec": { "id": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec", "description": "A specification for configuring the behavior of content search.", "type": "object", "properties": { "snippetSpec": { "description": "If `snippetSpec` is not specified, snippets are not included in the search response.", "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSnippetSpec" }, "summarySpec": { "description": "If `summarySpec` is not specified, summaries are not included in the search response.", "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec" }, "extractiveContentSpec": { "description": "If there is no extractive_content_spec provided, there will be no extractive answer in the search response.", "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec" }, "searchResultMode": { "description": "Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`.", "type": "string", "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" ] }, "chunkSpec": { "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", "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecChunkSpec" } } }, "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSnippetSpec": { "id": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSnippetSpec", "description": "A specification for configuring snippets in a search response.", "type": "object", "properties": { "maxSnippetCount": { "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, "type": "integer", "format": "int32" }, "referenceOnly": { "description": "[DEPRECATED] This field is deprecated and will have no affect on the snippet.", "deprecated": true, "type": "boolean" }, "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" } } }, "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec": { "id": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec", "description": "A specification for configuring a summary returned in a search response.", "type": "object", "properties": { "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.", "type": "integer", "format": "int32" }, "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" }, "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" }, "ignoreLowRelevantContent": { "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": "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" }, "multimodalSpec": { "description": "Optional. Multimodal specification.", "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecMultiModalSpec" }, "modelPromptSpec": { "description": "If specified, the spec will be used to modify the prompt provided to the LLM.", "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec" }, "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" }, "modelSpec": { "description": "If specified, the spec will be used to modify the model specification provided to the LLM.", "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec" }, "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" } } }, "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecMultiModalSpec": { "id": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecMultiModalSpec", "description": "Multimodal specification: Will return an image from specified source. If multiple sources are specified, the pick is a quality based decision.", "type": "object", "properties": { "imageSource": { "description": "Optional. Source of image returned in the answer.", "type": "string", "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." ], "enum": [ "IMAGE_SOURCE_UNSPECIFIED", "ALL_AVAILABLE_SOURCES", "CORPUS_IMAGE_ONLY", "FIGURE_GENERATION_ONLY" ] } } }, "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec": { "id": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec", "description": "Specification of the prompt to use with the model.", "type": "object", "properties": { "preamble": { "description": "Text at the beginning of the prompt that instructs the assistant. Examples are available in the user guide.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec": { "id": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec", "description": "Specification of the model.", "type": "object", "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" } } }, "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec": { "id": "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.", "type": "integer", "format": "int32" }, "maxExtractiveSegmentCount": { "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", "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" }, "numPreviousSegments": { "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", "format": "int32" }, "numNextSegments": { "description": "Return at most `num_next_segments` segments after each selected segments.", "type": "integer", "format": "int32" } } }, "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecChunkSpec": { "id": "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", "type": "object", "properties": { "numPreviousChunks": { "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": "integer", "format": "int32" }, "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.", "type": "integer", "format": "int32" } } }, "GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec": { "id": "GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec", "description": "The specification that uses customized query embedding vector to do semantic document retrieval.", "type": "object", "properties": { "embeddingVectors": { "description": "The embedding vector used for retrieval. Limit to 1.", "type": "array", "items": { "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpecEmbeddingVector" } } } }, "GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpecEmbeddingVector": { "id": "GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpecEmbeddingVector", "description": "Embedding vector.", "type": "object", "properties": { "fieldPath": { "description": "Embedding field path in schema.", "type": "string" }, "vector": { "description": "Query embedding vector.", "type": "array", "items": { "type": "number", "format": "float" } } } }, "GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec": { "id": "GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec", "description": "Specification to enable natural language understanding capabilities for search requests.", "type": "object", "properties": { "filterExtractionCondition": { "description": "The condition under which filter extraction should occur. Server behavior defaults to `DISABLED`.", "type": "string", "enumDescriptions": [ "Server behavior defaults to `DISABLED`.", "Disables NL filter extraction.", "Enables NL filter extraction." ], "enum": [ "CONDITION_UNSPECIFIED", "DISABLED", "ENABLED" ] }, "geoSearchQueryDetectionFieldNames": { "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", "items": { "type": "string" } }, "extractedFilterBehavior": { "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", "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." ], "enum": [ "EXTRACTED_FILTER_BEHAVIOR_UNSPECIFIED", "HARD_FILTER", "SOFT_BOOST" ] }, "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.", "type": "array", "items": { "type": "string" } } } }, "GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec": { "id": "GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec", "description": "Specification for search as you type in search requests.", "type": "object", "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" ] } } }, "GoogleCloudDiscoveryengineV1betaSearchRequestDisplaySpec": { "id": "GoogleCloudDiscoveryengineV1betaSearchRequestDisplaySpec", "description": "Specifies features for display, like match highlighting.", "type": "object", "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" ] } } }, "GoogleCloudDiscoveryengineV1betaSearchRequestCrowdingSpec": { "id": "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.", "type": "object", "properties": { "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" }, "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.", "type": "integer", "format": "int32" }, "mode": { "description": "Mode to use for documents that are crowded away.", "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." ], "enum": [ "MODE_UNSPECIFIED", "DROP_CROWDED_RESULTS", "DEMOTE_CROWDED_RESULTS_TO_END" ] } } }, "GoogleCloudDiscoveryengineV1betaSearchRequestSessionSpec": { "id": "GoogleCloudDiscoveryengineV1betaSearchRequestSessionSpec", "description": "Session specification.", "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.", "type": "integer", "format": "int32" } } }, "GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpec": { "id": "GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpec", "description": "Relevance filtering specification.", "type": "object", "properties": { "keywordSearchThreshold": { "description": "Optional. Relevance filtering threshold specification for keyword search.", "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec" }, "semanticSearchThreshold": { "description": "Optional. Relevance filtering threshold specification for semantic search.", "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec" } } }, "GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec": { "id": "GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec", "description": "Specification for relevance filtering on a specific sub-search.", "type": "object", "properties": { "relevanceThreshold": { "description": "Pre-defined relevance threshold for the sub-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" ] }, "semanticRelevanceThreshold": { "description": "Custom relevance threshold for the sub-search. The value must be in [0.0, 1.0].", "type": "number", "format": "float" } } }, "GoogleCloudDiscoveryengineV1betaSearchRequestPersonalizationSpec": { "id": "GoogleCloudDiscoveryengineV1betaSearchRequestPersonalizationSpec", "description": "The specification for personalization.", "type": "object", "properties": { "mode": { "description": "The personalization mode of the search request. Defaults to Mode.AUTO.", "type": "string", "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" ] } } }, "GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceScoreSpec": { "id": "GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceScoreSpec", "description": "The specification for returning the document relevance score.", "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" } } }, "GoogleCloudDiscoveryengineV1betaSearchRequestSearchAddonSpec": { "id": "GoogleCloudDiscoveryengineV1betaSearchRequestSearchAddonSpec", "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.", "type": "object", "properties": { "disableSemanticAddOn": { "description": "Optional. If true, semantic add-on is disabled. Semantic add-on includes embeddings and jetstream.", "type": "boolean" }, "disableKpiPersonalizationAddOn": { "description": "Optional. If true, disables event re-ranking and personalization to optimize KPIs & personalize results.", "type": "boolean" }, "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" } } }, "GoogleCloudDiscoveryengineV1betaSearchRequestCustomRankingParams": { "id": "GoogleCloudDiscoveryengineV1betaSearchRequestCustomRankingParams", "description": "Configuration parameters for the Custom Ranking feature.", "type": "object", "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" } } } }, "GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpecQuerySetSpec": { "id": "GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpecQuerySetSpec", "description": "Describes the specification of the query set.", "type": "object", "properties": { "sampleQuerySet": { "description": "Optional. The full resource name of the SampleQuerySet used for the evaluation, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1betaQualityMetrics": { "id": "GoogleCloudDiscoveryengineV1betaQualityMetrics", "description": "Describes the metrics produced by the evaluation.", "type": "object", "properties": { "docRecall": { "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", "$ref": "GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics" }, "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": "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" }, "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" }, "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" } } }, "GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics": { "id": "GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics", "description": "Stores the metric values at specific top-k levels.", "type": "object", "properties": { "top1": { "description": "The top-1 value.", "type": "number", "format": "double" }, "top3": { "description": "The top-3 value.", "type": "number", "format": "double" }, "top5": { "description": "The top-5 value.", "type": "number", "format": "double" }, "top10": { "description": "The top-10 value.", "type": "number", "format": "double" } } }, "GoogleCloudDiscoveryengineV1betaIdentityMappingEntryOperationMetadata": { "id": "GoogleCloudDiscoveryengineV1betaIdentityMappingEntryOperationMetadata", "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": { "description": "The total number of IdentityMappingEntries that were processed.", "type": "string", "format": "int64" } } }, "GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsMetadata": { "id": "GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsMetadata", "description": "Metadata related to the progress of the ImportCompletionSuggestions 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": { "description": "Operation last update time. If the operation is done, this is also the finish time.", "type": "string", "format": "google-datetime" }, "successCount": { "description": "Count of CompletionSuggestions successfully imported.", "type": "string", "format": "int64" }, "failureCount": { "description": "Count of CompletionSuggestions that failed to be imported.", "type": "string", "format": "int64" } } }, "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": { "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" } } }, "GoogleCloudDiscoveryengineV1betaImportErrorConfig": { "id": "GoogleCloudDiscoveryengineV1betaImportErrorConfig", "description": "Configuration of destination for Import related errors.", "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" } } }, "GoogleCloudDiscoveryengineV1betaImportDocumentsMetadata": { "id": "GoogleCloudDiscoveryengineV1betaImportDocumentsMetadata", "description": "Metadata related to the progress of the ImportDocuments operation. This is returned by the google.longrunning.Operation.metadata field.", "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.", "type": "string", "format": "google-datetime" }, "successCount": { "description": "Count of entries that were processed successfully.", "type": "string", "format": "int64" }, "failureCount": { "description": "Count of entries that encountered errors while processing.", "type": "string", "format": "int64" }, "totalCount": { "description": "Total count of entries that were processed.", "type": "string", "format": "int64" } } }, "GoogleCloudDiscoveryengineV1betaImportDocumentsResponse": { "id": "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.", "type": "object", "properties": { "errorSamples": { "description": "A sample of errors encountered while processing the request.", "type": "array", "items": { "$ref": "GoogleRpcStatus" } }, "errorConfig": { "description": "Echoes the destination for the complete errors in the request if set.", "$ref": "GoogleCloudDiscoveryengineV1betaImportErrorConfig" } } }, "GoogleCloudDiscoveryengineV1betaImportIdentityMappingsResponse": { "id": "GoogleCloudDiscoveryengineV1betaImportIdentityMappingsResponse", "description": "Response message for IdentityMappingStoreService.ImportIdentityMappings", "type": "object", "properties": { "errorSamples": { "description": "A sample of errors encountered while processing the request.", "type": "array", "items": { "$ref": "GoogleRpcStatus" } } } }, "GoogleCloudDiscoveryengineV1betaImportSampleQueriesMetadata": { "id": "GoogleCloudDiscoveryengineV1betaImportSampleQueriesMetadata", "description": "Metadata related to the progress of the ImportSampleQueries operation. This will be returned by the google.longrunning.Operation.metadata field.", "type": "object", "properties": { "createTime": { "description": "ImportSampleQueries operation create time.", "type": "string", "format": "google-datetime" }, "updateTime": { "description": "ImportSampleQueries operation last update time. If the operation is done, this is also the finish time.", "type": "string", "format": "google-datetime" }, "successCount": { "description": "Count of SampleQuerys successfully imported.", "type": "string", "format": "int64" }, "failureCount": { "description": "Count of SampleQuerys that failed to be imported.", "type": "string", "format": "int64" }, "totalCount": { "description": "Total count of SampleQuerys that were processed.", "type": "string", "format": "int64" } } }, "GoogleCloudDiscoveryengineV1betaImportSampleQueriesResponse": { "id": "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.", "type": "object", "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" } } }, "GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesMetadata": { "id": "GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesMetadata", "description": "Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", "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.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesResponse": { "id": "GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesResponse", "description": "Response message for CompletionService.ImportSuggestionDenyListEntries method.", "type": "object", "properties": { "errorSamples": { "description": "A sample of errors encountered while processing the request.", "type": "array", "items": { "$ref": "GoogleRpcStatus" } }, "importedEntriesCount": { "description": "Count of deny list entries successfully imported.", "type": "string", "format": "int64" }, "failedEntriesCount": { "description": "Count of deny list entries that failed to be imported.", "type": "string", "format": "int64" } } }, "GoogleCloudDiscoveryengineV1betaImportUserEventsMetadata": { "id": "GoogleCloudDiscoveryengineV1betaImportUserEventsMetadata", "description": "Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field.", "type": "object", "properties": { "createTime": { "description": "Operation create time.", "type": "string", "format": "google-datetime" }, "updateTime": { "description": "Output only. Operation last update time. If the operation is done, this is also the finish time.", "readOnly": true, "type": "string", "format": "google-datetime" }, "successCount": { "description": "Count of entries that were processed successfully.", "type": "string", "format": "int64" }, "failureCount": { "description": "Count of entries that encountered errors while processing.", "type": "string", "format": "int64" } } }, "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.", "type": "object", "properties": { "errorSamples": { "description": "A sample of errors encountered while processing the request.", "type": "array", "items": { "$ref": "GoogleRpcStatus" } }, "errorConfig": { "description": "Echoes the destination for the complete errors if this field was set in the request.", "$ref": "GoogleCloudDiscoveryengineV1betaImportErrorConfig" }, "joinedEventsCount": { "description": "Count of user events imported with complete existing Documents.", "type": "string", "format": "int64" }, "unjoinedEventsCount": { "description": "Count of user events imported, but with Document information not found in the existing Branch.", "type": "string", "format": "int64" } } }, "GoogleCloudDiscoveryengineV1betaLicenseConfig": { "id": "GoogleCloudDiscoveryengineV1betaLicenseConfig", "description": "Information about users' licenses.", "type": "object", "properties": { "name": { "description": "Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project}/locations/{location}/licenseConfigs/{license_config}`", "type": "string" }, "licenseCount": { "description": "Required. Number of licenses purchased.", "type": "string", "format": "int64" }, "subscriptionTier": { "description": "Required. Subscription tier information for the license config.", "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." ], "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" ] }, "state": { "description": "Output only. The state of the license config.", "readOnly": true, "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." ], "enum": [ "STATE_UNSPECIFIED", "ACTIVE", "EXPIRED", "NOT_STARTED", "WITHDRAWN", "DEACTIVATING" ] }, "autoRenew": { "description": "Optional. Whether the license config should be auto renewed when it reaches the end date.", "type": "boolean" }, "startDate": { "description": "Required. The start date.", "$ref": "GoogleTypeDate" }, "endDate": { "description": "Optional. The planed end date.", "$ref": "GoogleTypeDate" }, "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" ] }, "freeTrial": { "description": "Optional. Whether the license config is for free trial.", "type": "boolean" }, "geminiBundle": { "description": "Output only. Whether the license config is for Gemini bundle.", "readOnly": true, "type": "boolean" }, "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.", "readOnly": true, "type": "boolean" }, "earlyTerminationDate": { "description": "Output only. The date when the subscription is terminated earlier than the expiration date.", "readOnly": true, "$ref": "GoogleTypeDate" } } }, "GoogleCloudDiscoveryengineV1betaObtainCrawlRateResponse": { "id": "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.", "type": "object", "properties": { "organicCrawlRateTimeSeries": { "description": "The historical organic crawl rate timeseries data, used for monitoring.", "$ref": "GoogleCloudDiscoveryengineV1betaOrganicCrawlRateTimeSeries" }, "dedicatedCrawlRateTimeSeries": { "description": "The historical dedicated crawl rate timeseries data, used for monitoring.", "$ref": "GoogleCloudDiscoveryengineV1betaDedicatedCrawlRateTimeSeries" }, "state": { "description": "Output only. The state of the response.", "readOnly": true, "type": "string", "enumDescriptions": [ "The state is unspecified.", "The state is successful.", "The state is failed." ], "enum": [ "STATE_UNSPECIFIED", "SUCCEEDED", "FAILED" ] }, "error": { "description": "Errors from service when handling the request.", "$ref": "GoogleRpcStatus" } } }, "GoogleCloudDiscoveryengineV1betaOrganicCrawlRateTimeSeries": { "id": "GoogleCloudDiscoveryengineV1betaOrganicCrawlRateTimeSeries", "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.", "type": "object", "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" } } }, "GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries": { "id": "GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries", "description": "The historical crawl rate timeseries data, used for monitoring.", "type": "object", "properties": { "qpsTimeSeries": { "description": "The QPS of the crawl rate.", "$ref": "GoogleMonitoringV3TimeSeries" } } }, "GoogleCloudDiscoveryengineV1betaDedicatedCrawlRateTimeSeries": { "id": "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", "properties": { "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" }, "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": "GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries" }, "userTriggeredCrawlErrorRate": { "description": "Vertex AI's error rate time series of user triggered dedicated crawl.", "$ref": "GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries" }, "autoRefreshCrawlErrorRate": { "description": "Vertex AI's error rate time series of auto-refresh dedicated crawl.", "$ref": "GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries" } } }, "GoogleCloudDiscoveryengineV1betaProject": { "id": "GoogleCloudDiscoveryengineV1betaProject", "description": "Metadata and configurations for a Google Cloud project in the service.", "type": "object", "properties": { "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.", "readOnly": true, "type": "string" }, "createTime": { "description": "Output only. The timestamp when this project is created.", "readOnly": true, "type": "string", "format": "google-datetime" }, "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" }, "serviceTermsMap": { "description": "Output only. A map of terms of services. The key is the `id` of ServiceTerms.", "readOnly": true, "type": "object", "additionalProperties": { "$ref": "GoogleCloudDiscoveryengineV1betaProjectServiceTerms" } }, "customerProvidedConfig": { "description": "Optional. Customer provided configurations.", "$ref": "GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfig" }, "configurableBillingStatus": { "description": "Output only. The current status of the project's configurable billing.", "readOnly": true, "$ref": "GoogleCloudDiscoveryengineV1betaProjectConfigurableBillingStatus" } } }, "GoogleCloudDiscoveryengineV1betaProjectServiceTerms": { "id": "GoogleCloudDiscoveryengineV1betaProjectServiceTerms", "description": "Metadata about the terms of service.", "type": "object", "properties": { "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": { "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.", "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" ] }, "acceptTime": { "description": "The last time when the project agreed to the terms of service.", "type": "string", "format": "google-datetime" }, "declineTime": { "description": "The last time when the project declined or revoked the agreement to terms of service.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfig": { "id": "GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfig", "description": "Customer provided configurations.", "type": "object", "properties": { "notebooklmConfig": { "description": "Optional. Configuration for NotebookLM settings.", "$ref": "GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfig" } } }, "GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfig": { "id": "GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfig", "description": "Configuration for NotebookLM.", "type": "object", "properties": { "modelArmorConfig": { "description": "Model Armor configuration to be used for sanitizing user prompts and LLM responses.", "$ref": "GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig" }, "optOutNotebookSharing": { "description": "Optional. Whether to disable the notebook sharing feature for the project. Default to false if not specified.", "type": "boolean" }, "dataProtectionPolicy": { "description": "Optional. Specifies the data protection policy for NotebookLM.", "$ref": "GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfigDataProtectionPolicy" }, "observabilityConfig": { "description": "Optional. Observability config for NotebookLM.", "$ref": "GoogleCloudDiscoveryengineV1betaObservabilityConfig" } } }, "GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig": { "id": "GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig", "description": "Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and LLM responses.", "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 LLM responses. Format: projects/{project}/locations/{location}/templates/{template_id} If not specified, no sanitization will be applied to the LLM response.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfigDataProtectionPolicy": { "id": "GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfigDataProtectionPolicy", "description": "Data protection policy config for NotebookLM.", "type": "object", "properties": { "sensitiveDataProtectionPolicy": { "description": "Optional. The sensitive data protection policy.", "$ref": "GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfigDataProtectionPolicySensitiveDataProtectionPolicy" } } }, "GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfigDataProtectionPolicySensitiveDataProtectionPolicy": { "id": "GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfigDataProtectionPolicySensitiveDataProtectionPolicy", "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" } } }, "GoogleCloudDiscoveryengineV1betaProjectConfigurableBillingStatus": { "id": "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.", "type": "object", "properties": { "effectiveSearchQpmThreshold": { "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.", "type": "string", "format": "int64" }, "effectiveIndexingCoreThreshold": { "description": "Optional. The currently effective Indexing Core threshold. This is the threshold against which Indexing Core usage is compared for overage calculations.", "type": "string", "format": "int64" }, "startTime": { "description": "Optional. The start time of the currently active billing subscription.", "type": "string", "format": "google-datetime" }, "terminateTime": { "description": "Output only. The latest terminate effective time of search qpm and indexing core subscriptions.", "readOnly": true, "type": "string", "format": "google-datetime" }, "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.", "readOnly": true, "type": "string", "format": "google-datetime" }, "indexingCoreThresholdNextUpdateTime": { "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, "type": "string", "format": "google-datetime" }, "updateType": { "description": "Output only. The type of update performed in this operation. This field is populated in the response of UpdateProject.", "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)." ], "enum": [ "UPDATE_TYPE_UNSPECIFIED", "CREATE", "DELETE", "SCALE_UP", "SCALE_DOWN" ] } } }, "GoogleCloudDiscoveryengineV1betaProvisionProjectMetadata": { "id": "GoogleCloudDiscoveryengineV1betaProvisionProjectMetadata", "description": "Metadata associated with a project provision operation.", "type": "object", "properties": {} }, "GoogleCloudDiscoveryengineV1betaPurgeDocumentsMetadata": { "id": "GoogleCloudDiscoveryengineV1betaPurgeDocumentsMetadata", "description": "Metadata related to the progress of the PurgeDocuments 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": { "description": "Operation last update time. If the operation is done, this is also the finish time.", "type": "string", "format": "google-datetime" }, "successCount": { "description": "Count of entries that were deleted successfully.", "type": "string", "format": "int64" }, "failureCount": { "description": "Count of entries that encountered errors while processing.", "type": "string", "format": "int64" }, "ignoredCount": { "description": "Count of entries that were ignored as entries were not found.", "type": "string", "format": "int64" } } }, "GoogleCloudDiscoveryengineV1betaPurgeDocumentsResponse": { "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", "properties": { "purgeCount": { "description": "The total count of documents purged as a result of the operation.", "type": "string", "format": "int64" }, "purgeSample": { "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.", "type": "array", "items": { "type": "string" } } } }, "GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesMetadata": { "id": "GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesMetadata", "description": "Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", "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.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesResponse": { "id": "GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesResponse", "description": "Response message for CompletionService.PurgeSuggestionDenyListEntries method.", "type": "object", "properties": { "purgeCount": { "description": "Number of suggestion deny list entries purged.", "type": "string", "format": "int64" }, "errorSamples": { "description": "A sample of errors encountered while processing the request.", "type": "array", "items": { "$ref": "GoogleRpcStatus" } } } }, "GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateMetadata": { "id": "GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateMetadata", "description": "Metadata related to the progress of the CrawlRateManagementService.RemoveDedicatedCrawlRate 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": { "description": "Operation last update time. If the operation is done, this is also the finish time.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateResponse": { "id": "GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateResponse", "description": "Response message for CrawlRateManagementService.RemoveDedicatedCrawlRate method. It simply returns the state of the response, and an error message if the state is FAILED.", "type": "object", "properties": { "state": { "description": "Output only. The state of the response.", "readOnly": true, "type": "string", "enumDescriptions": [ "The state is unspecified.", "The state is successful.", "The state is failed." ], "enum": [ "STATE_UNSPECIFIED", "SUCCEEDED", "FAILED" ] }, "error": { "description": "Errors from service when handling the request.", "$ref": "GoogleRpcStatus" } } }, "GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateMetadata": { "id": "GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateMetadata", "description": "Metadata related to the progress of the CrawlRateManagementService.SetDedicatedCrawlRate 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": { "description": "Operation last update time. If the operation is done, this is also the finish time.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateResponse": { "id": "GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateResponse", "description": "Response message for CrawlRateManagementService.SetDedicatedCrawlRate method. It simply returns the state of the response, and an error message if the state is FAILED.", "type": "object", "properties": { "state": { "description": "Output only. The state of the response.", "readOnly": true, "type": "string", "enumDescriptions": [ "The state is unspecified.", "The state is successful.", "The state is failed." ], "enum": [ "STATE_UNSPECIFIED", "SUCCEEDED", "FAILED" ] }, "error": { "description": "Errors from service when handling the request.", "$ref": "GoogleRpcStatus" } } }, "GoogleCloudDiscoveryengineV1betaSitemap": { "id": "GoogleCloudDiscoveryengineV1betaSitemap", "description": "A sitemap for the SiteSearchEngine.", "type": "object", "properties": { "uri": { "description": "Public URI for the sitemap, e.g. `www.example.com/sitemap.xml`.", "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" }, "createTime": { "description": "Output only. The sitemap's creation time.", "readOnly": true, "type": "string", "format": "google-datetime" } } }, "GoogleCloudDiscoveryengineV1betaTrainCustomModelMetadata": { "id": "GoogleCloudDiscoveryengineV1betaTrainCustomModelMetadata", "description": "Metadata related to the progress of the TrainCustomModel operation. This is returned by the google.longrunning.Operation.metadata field.", "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.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudDiscoveryengineV1betaTrainCustomModelResponse": { "id": "GoogleCloudDiscoveryengineV1betaTrainCustomModelResponse", "description": "Response of the TrainCustomModelRequest. This message is returned by the google.longrunning.Operations.response field.", "type": "object", "properties": { "errorSamples": { "description": "A sample of errors encountered while processing the data.", "type": "array", "items": { "$ref": "GoogleRpcStatus" } }, "errorConfig": { "description": "Echoes the destination for the complete errors in the request if set.", "$ref": "GoogleCloudDiscoveryengineV1betaImportErrorConfig" }, "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": { "description": "The metrics of the trained model.", "type": "object", "additionalProperties": { "type": "number", "format": "double" } }, "modelName": { "description": "Fully qualified name of the CustomTuningModel.", "type": "string" } } }, "GoogleCloudDiscoveryengineV1betaTuneEngineMetadata": { "id": "GoogleCloudDiscoveryengineV1betaTuneEngineMetadata", "description": "Metadata associated with a tune operation.", "type": "object", "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" } } }, "GoogleCloudDiscoveryengineV1betaTuneEngineResponse": { "id": "GoogleCloudDiscoveryengineV1betaTuneEngineResponse", "description": "Response associated with a tune operation.", "type": "object", "properties": {} }, "GoogleCloudDiscoveryengineV1betaUpdateSchemaMetadata": { "id": "GoogleCloudDiscoveryengineV1betaUpdateSchemaMetadata", "description": "Metadata for UpdateSchema LRO.", "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.", "type": "string", "format": "google-datetime" } } }, "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": { "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.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudDiscoveryengineV1betaUserStore": { "id": "GoogleCloudDiscoveryengineV1betaUserStore", "description": "Configures metadata that is used for End User entities.", "type": "object", "properties": { "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" }, "displayName": { "description": "The display name of the User Store.", "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" }, "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" }, "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" } } } }, "rootUrl": "https://discoveryengine.googleapis.com/", "fullyEncodeReservedExpansion": true, "ownerName": "Google", "protocol": "rest", "documentationLink": "https://cloud.google.com/generative-ai-app-builder/docs/", "baseUrl": "https://discoveryengine.googleapis.com/", "batchPath": "batch", "discoveryVersion": "v1", "id": "discoveryengine:v1alpha", "endpoints": [ { "endpointUrl": "https://discoveryengine.asia-northeast1.rep.googleapis.com/", "location": "asia-northeast1", "description": "Regional Endpoint" }, { "endpointUrl": "https://discoveryengine.europe-west2.rep.googleapis.com/", "location": "europe-west2", "description": "Regional Endpoint" }, { "endpointUrl": "https://discoveryengine.us.rep.googleapis.com/", "location": "us", "description": "Regional Endpoint" }, { "endpointUrl": "https://discoveryengine.eu.rep.googleapis.com/", "location": "eu", "description": "Regional Endpoint" }, { "endpointUrl": "https://discoveryengine.in.rep.googleapis.com/", "location": "in", "description": "Regional Endpoint" } ], "name": "discoveryengine", "basePath": "", "title": "Discovery Engine API", "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "servicePath": "", "revision": "20260512", "parameters": { "access_token": { "type": "string", "description": "OAuth access token.", "location": "query" }, "alt": { "type": "string", "description": "Data format for response.", "default": "json", "enum": [ "json", "media", "proto" ], "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ], "location": "query" }, "callback": { "type": "string", "description": "JSONP", "location": "query" }, "fields": { "type": "string", "description": "Selector specifying which fields to include in a partial response.", "location": "query" }, "key": { "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.", "location": "query" }, "oauth_token": { "type": "string", "description": "OAuth 2.0 token for the current user.", "location": "query" }, "prettyPrint": { "type": "boolean", "description": "Returns response with indentations and line breaks.", "default": "true", "location": "query" }, "quotaUser": { "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.", "location": "query" }, "upload_protocol": { "type": "string", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "location": "query" }, "uploadType": { "type": "string", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "location": "query" }, "$.xgafv": { "type": "string", "description": "V1 error format.", "enum": [ "1", "2" ], "enumDescriptions": [ "v1 error format", "v2 error format" ], "location": "query" } }, "kind": "discovery#restDescription", "resources": { "billingAccounts": { "resources": { "billingAccountLicenseConfigs": { "methods": { "distributeLicenseConfig": { "id": "discoveryengine.billingAccounts.billingAccountLicenseConfigs.distributeLicenseConfig", "path": "v1alpha/{+billingAccountLicenseConfig}:distributeLicenseConfig", "flatPath": "v1alpha/billingAccounts/{billingAccountsId}/billingAccountLicenseConfigs/{billingAccountLicenseConfigsId}:distributeLicenseConfig", "httpMethod": "POST", "parameters": { "billingAccountLicenseConfig": { "description": "Required. Full resource name of BillingAccountLicenseConfig. Format: `billingAccounts/{billing_account}/billingAccountLicenseConfigs/{billing_account_license_config_id}`.", "pattern": "^billingAccounts/[^/]+/billingAccountLicenseConfigs/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "billingAccountLicenseConfig" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaDistributeLicenseConfigRequest" }, "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaDistributeLicenseConfigResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "description": "Distributes a LicenseConfig from billing account level to project level." }, "retractLicenseConfig": { "id": "discoveryengine.billingAccounts.billingAccountLicenseConfigs.retractLicenseConfig", "path": "v1alpha/{+billingAccountLicenseConfig}:retractLicenseConfig", "flatPath": "v1alpha/billingAccounts/{billingAccountsId}/billingAccountLicenseConfigs/{billingAccountLicenseConfigsId}:retractLicenseConfig", "httpMethod": "POST", "parameters": { "billingAccountLicenseConfig": { "description": "Required. Full resource name of BillingAccountLicenseConfig. Format: `billingAccounts/{billing_account}/billingAccountLicenseConfigs/{billing_account_license_config_id}`.", "pattern": "^billingAccounts/[^/]+/billingAccountLicenseConfigs/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "billingAccountLicenseConfig" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaRetractLicenseConfigRequest" }, "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaRetractLicenseConfigResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "description": "This method is called from the billing account side to retract the LicenseConfig from the given project back to the billing account." }, "list": { "id": "discoveryengine.billingAccounts.billingAccountLicenseConfigs.list", "path": "v1alpha/{+parent}/billingAccountLicenseConfigs", "flatPath": "v1alpha/billingAccounts/{billingAccountsId}/billingAccountLicenseConfigs", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. Format: `billingAccounts/{billing_account}`.", "pattern": "^billingAccounts/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "Optional. Not supported.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. Not supported.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaListBillingAccountLicenseConfigsResponse" }, "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 BillingAccountLicenseConfigs for a given billing account." }, "get": { "id": "discoveryengine.billingAccounts.billingAccountLicenseConfigs.get", "path": "v1alpha/{+name}", "flatPath": "v1alpha/billingAccounts/{billingAccountsId}/billingAccountLicenseConfigs/{billingAccountLicenseConfigsId}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. Full resource name of BillingAccountLicenseConfig. Format: `billingAccounts/{billing_account}/billingAccountLicenseConfigs/{billing_account_license_config_id}`.", "pattern": "^billingAccounts/[^/]+/billingAccountLicenseConfigs/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaBillingAccountLicenseConfig" }, "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 BillingAccountLicenseConfig." } } } } }, "projects": { "methods": { "get": { "id": "discoveryengine.projects.get", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. Full resource name of a Project, such as `projects/{project_id_or_number}`.", "pattern": "^projects/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaProject" }, "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 Project. Returns NOT_FOUND when the project is not yet created." }, "provision": { "id": "discoveryengine.projects.provision", "path": "v1alpha/{+name}:provision", "flatPath": "v1alpha/projects/{projectsId}:provision", "httpMethod": "POST", "parameters": { "name": { "description": "Required. Full resource name of a Project, such as `projects/{project_id_or_number}`.", "pattern": "^projects/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaProvisionProjectRequest" }, "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": "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." }, "reportConsentChange": { "id": "discoveryengine.projects.reportConsentChange", "path": "v1alpha/{+project}:reportConsentChange", "flatPath": "v1alpha/projects/{projectsId}:reportConsentChange", "httpMethod": "POST", "parameters": { "project": { "description": "Required. Full resource name of a Project, such as `projects/{project_id_or_number}`.", "pattern": "^projects/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaReportConsentChangeRequest" }, "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaProject" }, "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 service terms for this project. This method can be used to retroactively accept the latest terms. Terms available for update: * [Terms for data use](https://cloud.google.com/retail/data-use-terms)" }, "patch": { "id": "discoveryengine.projects.patch", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}", "httpMethod": "PATCH", "parameters": { "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.", "pattern": "^projects/[^/]+$", "location": "path", "required": true, "type": "string" }, "updateMask": { "description": "Optional. The list of fields to update. Supported fields: * `customer_provided_config` * `customer_provided_config.notebooklm_config.observability_config`", "location": "query", "type": "string", "format": "google-fieldmask" } }, "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaProject" }, "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaProject" }, "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 editable settings of a Discovery Engine Project." } }, "resources": { "locations": { "methods": { "updateAclConfig": { "id": "discoveryengine.projects.locations.updateAclConfig", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/aclConfig", "httpMethod": "PATCH", "parameters": { "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.", "pattern": "^projects/[^/]+/locations/[^/]+/aclConfig$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaAclConfig" }, "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaAclConfig" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "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." }, "getAclConfig": { "id": "discoveryengine.projects.locations.getAclConfig", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/aclConfig", "httpMethod": "GET", "parameters": { "name": { "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$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaAclConfig" }, "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 AclConfig." }, "updateCmekConfig": { "id": "discoveryengine.projects.locations.updateCmekConfig", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/cmekConfig", "httpMethod": "PATCH", "parameters": { "name": { "description": "Required. The name of the CmekConfig of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmek_config}`.", "pattern": "^projects/[^/]+/locations/[^/]+/cmekConfig$", "location": "path", "required": true, "type": "string" }, "setDefault": { "description": "Set the following CmekConfig as the default to be used for child resources if one is not specified.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaCmekConfig" }, "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": "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." }, "getCmekConfig": { "id": "discoveryengine.projects.locations.getCmekConfig", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/cmekConfig", "httpMethod": "GET", "parameters": { "name": { "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.", "pattern": "^projects/[^/]+/locations/[^/]+/cmekConfig$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaCmekConfig" }, "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 CmekConfig." }, "completeExternalIdentities": { "id": "discoveryengine.projects.locations.completeExternalIdentities", "path": "v1alpha/{+parent}:completeExternalIdentities", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}:completeExternalIdentities", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The parent location resource name, such as `projects/*/locations/global`.", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" }, "prefixQuery": { "description": "Required. The prefix to search for. For users, this prefix is matched against the `primary_email`. For groups, this prefix is matched against the `display_name`. The matching is case-insensitive.", "location": "query", "type": "string" }, "maxSuggestions": { "description": "Optional. The maximum number of user and group results to return. The service may return fewer than this value. If unspecified, at most 6 results will be returned. The limit is distributed as evenly as possible across users and groups. For example, if max_suggestions is 7, the service may return 4 users and 3 groups. If there are fewer suggestions of one type than half the limit, the other type may return more suggestions up to the max_suggestions limit.", "location": "query", "type": "integer", "format": "int32" }, "entityTypeFilter": { "description": "Optional. The type of entities to fetch. If not set, all entity types will be returned.", "location": "query", "type": "string", "enumDescriptions": [ "Unspecified entity type filter.", "Fetch only users.", "Fetch only groups." ], "enum": [ "ENTITY_TYPE_FILTER_UNSPECIFIED", "USERS", "GROUPS" ] }, "useScimIdentities": { "description": "Optional. Whether to use scim identities for external identity completion. If false, we will call the Microsoft graph API to fetch the external identities.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaCompleteExternalIdentitiesResponse" }, "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": "This method provides suggestions for users and groups managed in an external identity provider, based on the provided prefix." }, "obtainCrawlRate": { "id": "discoveryengine.projects.locations.obtainCrawlRate", "path": "v1alpha/{+location}:obtainCrawlRate", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}:obtainCrawlRate", "httpMethod": "POST", "parameters": { "location": { "description": "Required. The location resource where crawl rate management will be performed. Format: `projects/{project}/locations/{location}`", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "location" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaObtainCrawlRateRequest" }, "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaObtainCrawlRateResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "description": "Obtains the time series data of organic or dedicated crawl rate for monitoring. When dedicated crawl rate is not set, it will return vertex AI's organic crawl rate time series. Organic crawl means Google automatically crawl the internet at its own convenience. When dedicated crawl rate is set, it will return vertex AI's dedicated crawl rate time series." }, "setDedicatedCrawlRate": { "id": "discoveryengine.projects.locations.setDedicatedCrawlRate", "path": "v1alpha/{+location}:setDedicatedCrawlRate", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}:setDedicatedCrawlRate", "httpMethod": "POST", "parameters": { "location": { "description": "Required. The location resource where crawl rate management will be performed. Format: `projects/{project}/locations/{location}`", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "location" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaSetDedicatedCrawlRateRequest" }, "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": "Sets the dedicated crawl rate for a crawl_rate_scope. If the dedicated crawl rate was not set, this will enable vertex AI's crawl bot to use the new dedicated crawl rate for crawling. If the dedicated crawl rate was set, vertex AI's crawl bot will try to update the rate to the new value. If the new value is too high, the crawl bot may crawl at a lower rate to avoid overloading the user's website." }, "removeDedicatedCrawlRate": { "id": "discoveryengine.projects.locations.removeDedicatedCrawlRate", "path": "v1alpha/{+location}:removeDedicatedCrawlRate", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}:removeDedicatedCrawlRate", "httpMethod": "POST", "parameters": { "location": { "description": "Required. The location resource where crawl rate management will be performed. Format: `projects/{project}/locations/{location}`", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "location" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaRemoveDedicatedCrawlRateRequest" }, "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": "Removes the dedicated crawl rate for a craw_rate_scope. If the dedicated crawl rate was set, this will disable vertex AI's crawl bot from using the dedicated crawl rate for crawling. If the dedicated crawl rate was not set, this is a no-op." }, "setUpDataConnector": { "id": "discoveryengine.projects.locations.setUpDataConnector", "path": "v1alpha/{+parent}:setUpDataConnector", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}:setUpDataConnector", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The parent of Collection, in the format of `projects/{project}/locations/{location}`.", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaSetUpDataConnectorRequest" }, "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": "Creates a Collection and sets up the DataConnector for it. To stop a DataConnector after setup, use the CollectionService.DeleteCollection method." }, "setUpDataConnectorV2": { "id": "discoveryengine.projects.locations.setUpDataConnectorV2", "path": "v1alpha/{+parent}:setUpDataConnectorV2", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}:setUpDataConnectorV2", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The parent of Collection, in the format of `projects/{project}/locations/{location}`.", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" }, "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.", "location": "query", "type": "string" }, "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" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaDataConnector" }, "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": "Creates a Collection and sets up the DataConnector for it. To stop a DataConnector after setup, use the CollectionService.DeleteCollection method." }, "estimateDataSize": { "id": "discoveryengine.projects.locations.estimateDataSize", "path": "v1alpha/{+location}:estimateDataSize", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}:estimateDataSize", "httpMethod": "POST", "parameters": { "location": { "description": "Required. Full resource name of the location, such as `projects/{project}/locations/{location}`.", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "location" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequest" }, "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": "Estimates the data size to be used by a customer." }, "queryConfigurablePricingUsageStats": { "id": "discoveryengine.projects.locations.queryConfigurablePricingUsageStats", "path": "v1alpha/{+project}/locations/{location}:queryConfigurablePricingUsageStats", "flatPath": "v1alpha/projects/{projectsId}/locations/{location}:queryConfigurablePricingUsageStats", "httpMethod": "GET", "parameters": { "project": { "description": "Required. The project to query usage stats for. Format: projects/{project}", "pattern": "^projects/[^/]+$", "location": "path", "required": true, "type": "string" }, "location": { "description": "Required. The location to query usage stats for.", "location": "path", "required": true, "type": "string" }, "timeRange.startDate.year": { "description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.", "location": "query", "type": "integer", "format": "int32" }, "timeRange.startDate.month": { "description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.", "location": "query", "type": "integer", "format": "int32" }, "timeRange.startDate.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.", "location": "query", "type": "integer", "format": "int32" }, "timeRange.endDate.year": { "description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.", "location": "query", "type": "integer", "format": "int32" }, "timeRange.endDate.month": { "description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.", "location": "query", "type": "integer", "format": "int32" }, "timeRange.endDate.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.", "location": "query", "type": "integer", "format": "int32" }, "metricTypes": { "description": "Optional. The metric types to return usage for.", "location": "query", "repeated": true, "type": "string", "enumDescriptions": [ "Default value.", "Daily median search request QPM.", "Daily min search request QPM.", "Daily max search request QPM.", "Daily search request total.", "Total storage bytes for indexing core." ], "enum": [ "BILLING_METRIC_TYPE_UNSPECIFIED", "DAILY_MDN_QPM", "DAILY_MIN_QPM", "DAILY_MAX_QPM", "DAILY_SEARCH_REQUEST", "TOTAL_STORAGE" ] } }, "parameterOrder": [ "project", "location" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaQueryConfigurablePricingUsageStatsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "description": "Queries configurable pricing usage stats for a project." } }, "resources": { "notebooks": { "methods": { "create": { "id": "discoveryengine.projects.locations.notebooks.create", "path": "v1alpha/{+parent}/notebooks", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/notebooks", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The parent resource name, such as `projects/{project}/locations/{location}`.", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudNotebooklmV1alphaNotebook" }, "response": { "$ref": "GoogleCloudNotebooklmV1alphaNotebook" }, "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 notebook." }, "get": { "id": "discoveryengine.projects.locations.notebooks.get", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/notebooks/{notebooksId}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. Full resource name of Notebook, such as `projects/{project}/locations/{location}/notebooks/{notebook_id}`.", "pattern": "^projects/[^/]+/locations/[^/]+/notebooks/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudNotebooklmV1alphaNotebook" }, "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 notebook." }, "listRecentlyViewed": { "id": "discoveryengine.projects.locations.notebooks.listRecentlyViewed", "path": "v1alpha/{+parent}/notebooks:listRecentlyViewed", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/notebooks:listRecentlyViewed", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The parent branch resource name, such as `projects/{project}/locations/{location}`.", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "Optional. Maximum number of Notebooks to return. If unspecified, defaults to \"500\". The maximum allowed value is \"500\". If this field is negative, will use the default value.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. The page token, provide this to retrieve the subsequent page.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudNotebooklmV1alphaListRecentlyViewedNotebooksResponse" }, "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 the notebooks ordered by last view time." }, "batchDelete": { "id": "discoveryengine.projects.locations.notebooks.batchDelete", "path": "v1alpha/{+parent}/notebooks:batchDelete", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/notebooks:batchDelete", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The parent branch resource name, such as `projects/{project}/locations/{location}`.", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudNotebooklmV1alphaBatchDeleteNotebooksRequest" }, "response": { "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "description": "Batch deletes Notebooks." }, "share": { "id": "discoveryengine.projects.locations.notebooks.share", "path": "v1alpha/{+name}:share", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/notebooks/{notebooksId}:share", "httpMethod": "POST", "parameters": { "name": { "description": "Required. Full resource name of Notebook, such as `projects/{project}/locations/{location}/notebooks/{notebook_id}`.", "pattern": "^projects/[^/]+/locations/[^/]+/notebooks/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudNotebooklmV1alphaShareNotebookRequest" }, "response": { "$ref": "GoogleCloudNotebooklmV1alphaShareNotebookResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "description": "Shares a notebook to other accounts." } }, "resources": { "audioOverviews": { "methods": { "create": { "id": "discoveryengine.projects.locations.notebooks.audioOverviews.create", "path": "v1alpha/{+parent}/audioOverviews", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/notebooks/{notebooksId}/audioOverviews", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The parent resource where this notebook will be created. Format: projects/{project}/locations/{location}/notebooks/{notebook}", "pattern": "^projects/[^/]+/locations/[^/]+/notebooks/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudNotebooklmV1alphaCreateAudioOverviewRequest" }, "response": { "$ref": "GoogleCloudNotebooklmV1alphaCreateAudioOverviewResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "description": "Generates a new audio overview." }, "delete": { "id": "discoveryengine.projects.locations.notebooks.audioOverviews.delete", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/notebooks/{notebooksId}/audioOverviews/{audioOverviewsId}", "httpMethod": "DELETE", "parameters": { "name": { "description": "Required. The full resource name of the AudioOverview, such as `projects/{project}/locations/{location}/notebooks/{notebook}/audioOverviews/{audio_overview_id}`.", "pattern": "^projects/[^/]+/locations/[^/]+/notebooks/[^/]+/audioOverviews/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleProtobufEmpty" }, "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 an audio overview." } } }, "sources": { "methods": { "batchCreate": { "id": "discoveryengine.projects.locations.notebooks.sources.batchCreate", "path": "v1alpha/{+parent}/sources:batchCreate", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/notebooks/{notebooksId}/sources:batchCreate", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The parent resource where the sources will be created. Format: projects/{project}/locations/{location}/notebooks/{notebook}", "pattern": "^projects/[^/]+/locations/[^/]+/notebooks/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudNotebooklmV1alphaBatchCreateSourcesRequest" }, "response": { "$ref": "GoogleCloudNotebooklmV1alphaBatchCreateSourcesResponse" }, "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 list of Sources." }, "get": { "id": "discoveryengine.projects.locations.notebooks.sources.get", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/notebooks/{notebooksId}/sources/{sourcesId}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. The resource name for source Format: projects/{project}/locations/{location}/notebooks/{notebook}/sources/{source}", "pattern": "^projects/[^/]+/locations/[^/]+/notebooks/[^/]+/sources/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudNotebooklmV1alphaSource" }, "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 Source." }, "batchDelete": { "id": "discoveryengine.projects.locations.notebooks.sources.batchDelete", "path": "v1alpha/{+parent}/sources:batchDelete", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/notebooks/{notebooksId}/sources:batchDelete", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The parent resource where the sources will be deleted. Format: projects/{project}/locations/{location}/notebooks/{notebook}", "pattern": "^projects/[^/]+/locations/[^/]+/notebooks/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudNotebooklmV1alphaBatchDeleteSourcesRequest" }, "response": { "$ref": "GoogleProtobufEmpty" }, "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 multiple sources" } } } } }, "groundingConfigs": { "methods": { "check": { "id": "discoveryengine.projects.locations.groundingConfigs.check", "path": "v1alpha/{+groundingConfig}:check", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/groundingConfigs/{groundingConfigsId}:check", "httpMethod": "POST", "parameters": { "groundingConfig": { "description": "Required. The resource name of the grounding config, such as `projects/*/locations/global/groundingConfigs/default_grounding_config`.", "pattern": "^projects/[^/]+/locations/[^/]+/groundingConfigs/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "groundingConfig" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaCheckGroundingRequest" }, "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaCheckGroundingResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "description": "Performs a grounding check." } } }, "operations": { "methods": { "list": { "id": "discoveryengine.projects.locations.operations.list", "path": "v1alpha/{+name}/operations", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/operations", "httpMethod": "GET", "parameters": { "name": { "description": "The name of the operation's parent resource.", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" }, "filter": { "description": "The standard list filter.", "location": "query", "type": "string" }, "pageSize": { "description": "The standard list page size.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "The standard list page token.", "location": "query", "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.", "location": "query", "type": "boolean" } }, "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" ], "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`." }, "get": { "id": "discoveryengine.projects.locations.operations.get", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", "httpMethod": "GET", "parameters": { "name": { "description": "The name of the operation resource.", "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "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" ], "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." } } }, "podcasts": { "resources": { "operations": { "methods": { "get": { "id": "discoveryengine.projects.locations.podcasts.operations.get", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/podcasts/{podcastsId}/operations/{operationsId}", "httpMethod": "GET", "parameters": { "name": { "description": "The name of the operation resource.", "pattern": "^projects/[^/]+/locations/[^/]+/podcasts/[^/]+/operations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "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" ], "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." } } } } }, "authorizations": { "methods": { "create": { "id": "discoveryengine.projects.locations.authorizations.create", "path": "v1alpha/{+parent}/authorizations", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/authorizations", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The parent resource name. Format: `projects/{project}/locations/{location}`", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" }, "authorizationId": { "description": "Required. The ID to use for the authorization, which will become the final component of the resource name. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) with a length limit of 63 characters.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaAuthorization" }, "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaAuthorization" }, "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 an Authorization." }, "delete": { "id": "discoveryengine.projects.locations.authorizations.delete", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/authorizations/{authorizationsId}", "httpMethod": "DELETE", "parameters": { "name": { "description": "Required. Resource name of Authorization. Format: `projects/{project}/locations/{location}/authorizations/{authorization}` If the caller does not have permission to delete the authorization, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the authorization to delete does not exist, a `NOT_FOUND` error is returned.", "pattern": "^projects/[^/]+/locations/[^/]+/authorizations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleProtobufEmpty" }, "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 an Authorization." }, "patch": { "id": "discoveryengine.projects.locations.authorizations.patch", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/authorizations/{authorizationsId}", "httpMethod": "PATCH", "parameters": { "name": { "description": "Identifier. Resource name of the authorization. Format: `projects/{project}/locations/{location}/authorizations/{authorization}` It must be a UTF-8 encoded string with a length limit of 1024 characters.", "pattern": "^projects/[^/]+/locations/[^/]+/authorizations/[^/]+$", "location": "path", "required": true, "type": "string" }, "updateMask": { "description": "The list of fields to update.", "location": "query", "type": "string", "format": "google-fieldmask" } }, "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaAuthorization" }, "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaAuthorization" }, "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 an Authorization" }, "get": { "id": "discoveryengine.projects.locations.authorizations.get", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/authorizations/{authorizationsId}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. Resource name of Authorization. Format: `projects/{project}/locations/{location}/authorizations/{authorization}`", "pattern": "^projects/[^/]+/locations/[^/]+/authorizations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaAuthorization" }, "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 an Authorization." }, "list": { "id": "discoveryengine.projects.locations.authorizations.list", "path": "v1alpha/{+parent}/authorizations", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/authorizations", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The parent resource name. Format: `projects/{project}/locations/{location}`", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "Maximum number of Authorizations to return. If unspecified, defaults to 100. The maximum allowed value is 1000; anything above that will be coerced down to 1000.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "A page token ListAuthorizationsResponse.next_page_token, received from a previous AuthorizationService.ListAuthorizations call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListAuthorizations must match the call that provided the page token.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaListAuthorizationsResponse" }, "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 Authorizations under an Engine." } } }, "cmekConfigs": { "methods": { "patch": { "id": "discoveryengine.projects.locations.cmekConfigs.patch", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/cmekConfigs/{cmekConfigsId}", "httpMethod": "PATCH", "parameters": { "name": { "description": "Required. The name of the CmekConfig of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmek_config}`.", "pattern": "^projects/[^/]+/locations/[^/]+/cmekConfigs/[^/]+$", "location": "path", "required": true, "type": "string" }, "setDefault": { "description": "Set the following CmekConfig as the default to be used for child resources if one is not specified.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaCmekConfig" }, "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": "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." }, "get": { "id": "discoveryengine.projects.locations.cmekConfigs.get", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/cmekConfigs/{cmekConfigsId}", "httpMethod": "GET", "parameters": { "name": { "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.", "pattern": "^projects/[^/]+/locations/[^/]+/cmekConfigs/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaCmekConfig" }, "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 CmekConfig." }, "list": { "id": "discoveryengine.projects.locations.cmekConfigs.list", "path": "v1alpha/{+parent}/cmekConfigs", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/cmekConfigs", "httpMethod": "GET", "parameters": { "parent": { "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.", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaListCmekConfigsResponse" }, "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 CmekConfigs with the project." }, "delete": { "id": "discoveryengine.projects.locations.cmekConfigs.delete", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/cmekConfigs/{cmekConfigsId}", "httpMethod": "DELETE", "parameters": { "name": { "description": "Required. The resource name of the CmekConfig to delete, such as `projects/{project}/locations/{location}/cmekConfigs/{cmek_config}`.", "pattern": "^projects/[^/]+/locations/[^/]+/cmekConfigs/[^/]+$", "location": "path", "required": true, "type": "string" } }, "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" ], "description": "De-provisions a CmekConfig." } } }, "collections": { "methods": { "get": { "id": "discoveryengine.projects.locations.collections.get", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. The full resource name, in the format of `projects/{project}/locations/{location}/collections/{collection}`.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaCollection" }, "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 Collection." }, "list": { "id": "discoveryengine.projects.locations.collections.list", "path": "v1alpha/{+parent}/collections", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The parent data store resource name, in the format of `projects/{project}/locations/{location}`.", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "The maximum number of Collections to return. The service may return fewer than this value. If unspecified, at most 100 Collections will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "A page token, received from a previous CollectionService.ListCollections call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to CollectionService.ListCollections must match the call that provided the page token.", "location": "query", "type": "string" }, "filter": { "description": "Filter returned collections by associated data connector data sources. For example: `filter = 'data_source:jira confluence'`. If the filter is empty, we return all collections under a project and location.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaListCollectionsResponse" }, "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 Collections." }, "patch": { "id": "discoveryengine.projects.locations.collections.patch", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}", "httpMethod": "PATCH", "parameters": { "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.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+$", "location": "path", "required": true, "type": "string" }, "updateMask": { "description": "Optional. The list of fields to be updated.", "location": "query", "type": "string", "format": "google-fieldmask" } }, "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaCollection" }, "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 Collection." }, "delete": { "id": "discoveryengine.projects.locations.collections.delete", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}", "httpMethod": "DELETE", "parameters": { "name": { "description": "Required. The full resource name of the Collection, in the format of `projects/{project}/locations/{location}/collections/{collection}`.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+$", "location": "path", "required": true, "type": "string" } }, "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" ], "description": "Deletes a Collection." }, "getDataConnector": { "id": "discoveryengine.projects.locations.collections.getDataConnector", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataConnector", "httpMethod": "GET", "parameters": { "name": { "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.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataConnector$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaDataConnector" }, "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 the DataConnector. DataConnector is a singleton resource for each Collection." }, "updateDataConnector": { "id": "discoveryengine.projects.locations.collections.updateDataConnector", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataConnector", "httpMethod": "PATCH", "parameters": { "name": { "description": "Identifier. The full resource name of the Data Connector. Format: `projects/*/locations/*/collections/*/dataConnector`.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataConnector$", "location": "path", "required": true, "type": "string" }, "updateMask": { "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.", "location": "query", "type": "string", "format": "google-fieldmask" } }, "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaDataConnector" }, "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaDataConnector" }, "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": "Updates a DataConnector." } }, "resources": { "operations": { "methods": { "list": { "id": "discoveryengine.projects.locations.collections.operations.list", "path": "v1alpha/{+name}/operations", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/operations", "httpMethod": "GET", "parameters": { "name": { "description": "The name of the operation's parent resource.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+$", "location": "path", "required": true, "type": "string" }, "filter": { "description": "The standard list filter.", "location": "query", "type": "string" }, "pageSize": { "description": "The standard list page size.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "The standard list page token.", "location": "query", "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.", "location": "query", "type": "boolean" } }, "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" ], "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`." }, "get": { "id": "discoveryengine.projects.locations.collections.operations.get", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/operations/{operationsId}", "httpMethod": "GET", "parameters": { "name": { "description": "The name of the operation resource.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/operations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "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" ], "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." } } }, "dataStores": { "methods": { "completeQuery": { "id": "discoveryengine.projects.locations.collections.dataStores.completeQuery", "path": "v1alpha/{+dataStore}:completeQuery", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}:completeQuery", "httpMethod": "GET", "parameters": { "dataStore": { "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/[^/]+$", "location": "path", "required": true, "type": "string" }, "query": { "description": "Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters.", "location": "query", "type": "string" }, "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.", "location": "query", "type": "string" }, "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": { "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" } }, "parameterOrder": [ "dataStore" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaCompleteQueryResponse" }, "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": "Completes the specified user input with keyword suggestions." }, "create": { "id": "discoveryengine.projects.locations.collections.dataStores.create", "path": "v1alpha/{+parent}/dataStores", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection}`.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+$", "location": "path", "required": true, "type": "string" }, "cmekConfigName": { "description": "Resource name of the CmekConfig to use for protecting this DataStore.", "location": "query", "type": "string" }, "disableCmek": { "description": "DataStore without CMEK protections. If a default CmekConfig is set for the project, setting this field will override the default CmekConfig as well.", "location": "query", "type": "boolean" }, "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.", "location": "query", "type": "string" }, "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" }, "skipDefaultSchemaCreation": { "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.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaDataStore" }, "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": "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." }, "get": { "id": "discoveryengine.projects.locations.collections.dataStores.get", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}", "httpMethod": "GET", "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.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaDataStore" }, "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 DataStore." }, "list": { "id": "discoveryengine.projects.locations.collections.dataStores.list", "path": "v1alpha/{+parent}/dataStores", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores", "httpMethod": "GET", "parameters": { "parent": { "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.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "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", "format": "int32" }, "pageToken": { "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", "type": "string" }, "filter": { "description": "Filter by solution type . For example: `filter = 'solution_type:SOLUTION_TYPE_SEARCH'`", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaListDataStoresResponse" }, "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 DataStores associated with the project." }, "delete": { "id": "discoveryengine.projects.locations.collections.dataStores.delete", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}", "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.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "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": "Deletes a DataStore." }, "patch": { "id": "discoveryengine.projects.locations.collections.dataStores.patch", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}", "httpMethod": "PATCH", "parameters": { "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.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", "location": "path", "required": true, "type": "string" }, "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" } }, "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaDataStore" }, "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaDataStore" }, "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 DataStore" }, "getDocumentProcessingConfig": { "id": "discoveryengine.projects.locations.collections.dataStores.getDocumentProcessingConfig", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/documentProcessingConfig", "httpMethod": "GET", "parameters": { "name": { "description": "Required. Full DocumentProcessingConfig resource name. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/documentProcessingConfig`", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/documentProcessingConfig$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig" }, "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 DocumentProcessingConfig." }, "updateDocumentProcessingConfig": { "id": "discoveryengine.projects.locations.collections.dataStores.updateDocumentProcessingConfig", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/documentProcessingConfig", "httpMethod": "PATCH", "parameters": { "name": { "description": "The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/documentProcessingConfig$", "location": "path", "required": true, "type": "string" }, "updateMask": { "description": "Indicates which fields in the provided DocumentProcessingConfig to update. The following are the only supported fields: * DocumentProcessingConfig.ocr_config If not set, all supported fields are updated.", "location": "query", "type": "string", "format": "google-fieldmask" } }, "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig" }, "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig" }, "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 DocumentProcessingConfig. DocumentProcessingConfig is a singleon resource of DataStore. It's empty when DataStore is created. The first call to this method will set up DocumentProcessingConfig." }, "addPatientFilter": { "id": "discoveryengine.projects.locations.collections.dataStores.addPatientFilter", "path": "v1alpha/{+dataStore}:addPatientFilter", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}:addPatientFilter", "httpMethod": "POST", "parameters": { "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.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "dataStore" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaAddPatientFilterRequest" }, "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": "Adds a group of patient IDs as a patient filter for the data store. Patient filters are empty by default when a data store is created, and are stored in a separate table. The data store must first be created, and must be a healthcare data store. 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." }, "removePatientFilter": { "id": "discoveryengine.projects.locations.collections.dataStores.removePatientFilter", "path": "v1alpha/{+dataStore}:removePatientFilter", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}:removePatientFilter", "httpMethod": "POST", "parameters": { "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", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "dataStore" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaRemovePatientFilterRequest" }, "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": "Removes a group of patient IDs from the patient filter for the data store. Patient filters are empty by default when a data store is created, and are stored in a separate table. The data store must first be created, and must be a healthcare data store. This method will fail if the data store does not have a patient filter. The filter group must be a FHIR resource name of type Group, and the list of patient IDs to remove will be constructed from the direct members of the group which are Patient resources." }, "deletePatientFilter": { "id": "discoveryengine.projects.locations.collections.dataStores.deletePatientFilter", "path": "v1alpha/{+dataStore}:deletePatientFilter", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}:deletePatientFilter", "httpMethod": "POST", "parameters": { "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.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "dataStore" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaDeletePatientFiltersRequest" }, "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 the entire patient filter for the data store. Patient filters are empty by default when a data store is created, and are stored in a separate table. The data store must first be created, and must be a healthcare data store. This method will fail if the data store does not have a patient filter." }, "replacePatientFilter": { "id": "discoveryengine.projects.locations.collections.dataStores.replacePatientFilter", "path": "v1alpha/{+dataStore}:replacePatientFilter", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}:replacePatientFilter", "httpMethod": "POST", "parameters": { "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.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "dataStore" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaReplacePatientFilterRequest" }, "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": "Replaces the patient filter for the data store. This method is essentially a combination of DeletePatientFilters and AddPatientFilter. Patient filters are empty by default when a data store is created, and are stored in a separate table. The data store must first be created, and must be a healthcare data store. This method will fail if the data store does not have a patient filter. 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." }, "trainCustomModel": { "id": "discoveryengine.projects.locations.collections.dataStores.trainCustomModel", "path": "v1alpha/{+dataStore}:trainCustomModel", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}:trainCustomModel", "httpMethod": "POST", "parameters": { "dataStore": { "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/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "dataStore" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaTrainCustomModelRequest" }, "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": "Trains a custom model." }, "getSiteSearchEngine": { "id": "discoveryengine.projects.locations.collections.dataStores.getSiteSearchEngine", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine", "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.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaSiteSearchEngine" }, "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." } }, "resources": { "servingConfigs": { "methods": { "search": { "id": "discoveryengine.projects.locations.collections.dataStores.servingConfigs.search", "path": "v1alpha/{+servingConfig}:search", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}:search", "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/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/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "servingConfig" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequest" }, "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponse" }, "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." }, "searchLite": { "id": "discoveryengine.projects.locations.collections.dataStores.servingConfigs.searchLite", "path": "v1alpha/{+servingConfig}:searchLite", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}:searchLite", "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/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/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "servingConfig" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequest" }, "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponse" }, "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." }, "answer": { "id": "discoveryengine.projects.locations.collections.dataStores.servingConfigs.answer", "path": "v1alpha/{+servingConfig}:answer", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}:answer", "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/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "servingConfig" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest" }, "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse" }, "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": "Answer query method." }, "streamAnswer": { "id": "discoveryengine.projects.locations.collections.dataStores.servingConfigs.streamAnswer", "path": "v1alpha/{+servingConfig}:streamAnswer", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}:streamAnswer", "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/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "servingConfig" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest" }, "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse" }, "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": "Answer query method (streaming). It takes one AnswerQueryRequest and returns multiple AnswerQueryResponse messages in a stream." }, "recommend": { "id": "discoveryengine.projects.locations.collections.dataStores.servingConfigs.recommend", "path": "v1alpha/{+servingConfig}:recommend", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}:recommend", "httpMethod": "POST", "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.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "servingConfig" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaRecommendRequest" }, "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaRecommendResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "description": "Makes a recommendation, which requires a contextual user event." }, "create": { "id": "discoveryengine.projects.locations.collections.dataStores.servingConfigs.create", "path": "v1alpha/{+parent}/servingConfigs", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/servingConfigs", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. Full resource name of parent. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", "location": "path", "required": true, "type": "string" }, "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+/.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaServingConfig" }, "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaServingConfig" }, "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 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." }, "delete": { "id": "discoveryengine.projects.locations.collections.dataStores.servingConfigs.delete", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}", "httpMethod": "DELETE", "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}`", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleProtobufEmpty" }, "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 ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist." }, "patch": { "id": "discoveryengine.projects.locations.collections.dataStores.servingConfigs.patch", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}", "httpMethod": "PATCH", "parameters": { "name": { "description": "Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}`", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$", "location": "path", "required": true, "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.", "location": "query", "type": "string", "format": "google-fieldmask" } }, "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaServingConfig" }, "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaServingConfig" }, "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." }, "get": { "id": "discoveryengine.projects.locations.collections.dataStores.servingConfigs.get", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}", "httpMethod": "GET", "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/[^/]+/collections/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaServingConfig" }, "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 ServingConfig. Returns a NotFound error if the ServingConfig does not exist." }, "list": { "id": "discoveryengine.projects.locations.collections.dataStores.servingConfigs.list", "path": "v1alpha/{+parent}/servingConfigs", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/servingConfigs", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. Full resource name of the parent resource. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "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", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse" }, "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." } } }, "models": { "resources": { "operations": { "methods": { "list": { "id": "discoveryengine.projects.locations.collections.dataStores.models.operations.list", "path": "v1alpha/{+name}/operations", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/models/{modelsId}/operations", "httpMethod": "GET", "parameters": { "name": { "description": "The name of the operation's parent resource.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/models/[^/]+$", "location": "path", "required": true, "type": "string" }, "filter": { "description": "The standard list filter.", "location": "query", "type": "string" }, "pageSize": { "description": "The standard list page size.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "The standard list page token.", "location": "query", "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.", "location": "query", "type": "boolean" } }, "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" ], "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`." }, "get": { "id": "discoveryengine.projects.locations.collections.dataStores.models.operations.get", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/models/{modelsId}/operations/{operationsId}", "httpMethod": "GET", "parameters": { "name": { "description": "The name of the operation resource.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/models/[^/]+/operations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "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" ], "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." } } } } }, "operations": { "methods": { "list": { "id": "discoveryengine.projects.locations.collections.dataStores.operations.list", "path": "v1alpha/{+name}/operations", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/operations", "httpMethod": "GET", "parameters": { "name": { "description": "The name of the operation's parent resource.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", "location": "path", "required": true, "type": "string" }, "filter": { "description": "The standard list filter.", "location": "query", "type": "string" }, "pageSize": { "description": "The standard list page size.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "The standard list page token.", "location": "query", "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.", "location": "query", "type": "boolean" } }, "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" ], "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`." }, "get": { "id": "discoveryengine.projects.locations.collections.dataStores.operations.get", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/operations/{operationsId}", "httpMethod": "GET", "parameters": { "name": { "description": "The name of the operation resource.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/operations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "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" ], "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." } } }, "branches": { "methods": { "list": { "id": "discoveryengine.projects.locations.collections.dataStores.branches.list", "path": "v1alpha/{+parent}/branches", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The parent data store resource name.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", "location": "path", "required": true, "type": "string" }, "view": { "description": "The view to apply to the returned Branch. Defaults to BranchView.BRANCH_VIEW_BASIC if unspecified.", "location": "query", "type": "string", "enumDescriptions": [ "The value when it's unspecified. This defaults to the BASIC view.", "Includes basic metadata about the branch, but not statistical fields. See documentation of individual fields of Branch to know what is excluded.", "Includes all fields of a Branch." ], "enum": [ "BRANCH_VIEW_UNSPECIFIED", "BRANCH_VIEW_BASIC", "BRANCH_VIEW_FULL" ] } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaListBranchesResponse" }, "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 Branchs under the specified parent DataStore." }, "get": { "id": "discoveryengine.projects.locations.collections.dataStores.branches.get", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. The name of the branch to retrieve. Format: `projects/*/locations/global/dataStores/default_data_store/branches/some_branch_id`. \"default_branch\" can be used as a special branch_id, it returns the default branch that has been set for the document.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/branches/[^/]+$", "location": "path", "required": true, "type": "string" }, "view": { "description": "The view to apply to the returned Branch. Defaults to BranchView.BRANCH_VIEW_BASIC if unspecified.", "location": "query", "type": "string", "enumDescriptions": [ "The value when it's unspecified. This defaults to the BASIC view.", "Includes basic metadata about the branch, but not statistical fields. See documentation of individual fields of Branch to know what is excluded.", "Includes all fields of a Branch." ], "enum": [ "BRANCH_VIEW_UNSPECIFIED", "BRANCH_VIEW_BASIC", "BRANCH_VIEW_FULL" ] } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaBranch" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "description": "Retrieves a Branch." }, "batchGetDocumentsMetadata": { "id": "discoveryengine.projects.locations.collections.dataStores.branches.batchGetDocumentsMetadata", "path": "v1alpha/{+parent}/batchGetDocumentsMetadata", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}/batchGetDocumentsMetadata", "httpMethod": "GET", "parameters": { "parent": { "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/[^/]+$", "location": "path", "required": true, "type": "string" }, "matcher.urisMatcher.uris": { "description": "The exact URIs to match by.", "location": "query", "repeated": true, "type": "string" }, "matcher.fhirMatcher.fhirResources": { "description": "Required. The FHIR resources to match by. Format: projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id}", "location": "query", "repeated": true, "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaBatchGetDocumentsMetadataResponse" }, "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." } }, "resources": { "operations": { "methods": { "list": { "id": "discoveryengine.projects.locations.collections.dataStores.branches.operations.list", "path": "v1alpha/{+name}/operations", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}/operations", "httpMethod": "GET", "parameters": { "name": { "description": "The name of the operation's parent resource.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/branches/[^/]+$", "location": "path", "required": true, "type": "string" }, "filter": { "description": "The standard list filter.", "location": "query", "type": "string" }, "pageSize": { "description": "The standard list page size.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "The standard list page token.", "location": "query", "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.", "location": "query", "type": "boolean" } }, "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" ], "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`." }, "get": { "id": "discoveryengine.projects.locations.collections.dataStores.branches.operations.get", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}/operations/{operationsId}", "httpMethod": "GET", "parameters": { "name": { "description": "The name of the operation resource.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/branches/[^/]+/operations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "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" ], "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." }, "cancel": { "id": "discoveryengine.projects.locations.collections.dataStores.branches.operations.cancel", "path": "v1alpha/{+name}:cancel", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}/operations/{operationsId}:cancel", "httpMethod": "POST", "parameters": { "name": { "description": "The name of the operation resource to be cancelled.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/branches/[^/]+/operations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "request": { "$ref": "GoogleLongrunningCancelOperationRequest" }, "response": { "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "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`." } } }, "documents": { "methods": { "get": { "id": "discoveryengine.projects.locations.collections.dataStores.branches.documents.get", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents/{documentsId}", "httpMethod": "GET", "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.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/branches/[^/]+/documents/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaDocument" }, "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 Document." }, "list": { "id": "discoveryengine.projects.locations.collections.dataStores.branches.documents.list", "path": "v1alpha/{+parent}/documents", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents", "httpMethod": "GET", "parameters": { "parent": { "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.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/branches/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "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", "format": "int32" }, "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" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaListDocumentsResponse" }, "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 Documents." }, "create": { "id": "discoveryengine.projects.locations.collections.dataStores.branches.documents.create", "path": "v1alpha/{+parent}/documents", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/branches/[^/]+$", "location": "path", "required": true, "type": "string" }, "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.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaDocument" }, "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaDocument" }, "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 Document." }, "patch": { "id": "discoveryengine.projects.locations.collections.dataStores.branches.documents.patch", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents/{documentsId}", "httpMethod": "PATCH", "parameters": { "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.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/branches/[^/]+/documents/[^/]+$", "location": "path", "required": true, "type": "string" }, "allowMissing": { "description": "If set to `true` and the Document is not found, a new Document is be created.", "location": "query", "type": "boolean" }, "updateMask": { "description": "Indicates which fields in the provided imported 'document' to update. If not set, by default updates all fields.", "location": "query", "type": "string", "format": "google-fieldmask" } }, "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaDocument" }, "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaDocument" }, "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 Document." }, "delete": { "id": "discoveryengine.projects.locations.collections.dataStores.branches.documents.delete", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents/{documentsId}", "httpMethod": "DELETE", "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 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/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleProtobufEmpty" }, "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 Document." }, "import": { "id": "discoveryengine.projects.locations.collections.dataStores.branches.documents.import", "path": "v1alpha/{+parent}/documents:import", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents:import", "httpMethod": "POST", "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.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/branches/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaImportDocumentsRequest" }, "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": "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." }, "purge": { "id": "discoveryengine.projects.locations.collections.dataStores.branches.documents.purge", "path": "v1alpha/{+parent}/documents:purge", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents:purge", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/branches/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaPurgeDocumentsRequest" }, "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": "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." }, "getProcessedDocument": { "id": "discoveryengine.projects.locations.collections.dataStores.branches.documents.getProcessedDocument", "path": "v1alpha/{+name}:getProcessedDocument", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents/{documentsId}:getProcessedDocument", "httpMethod": "GET", "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.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/branches/[^/]+/documents/[^/]+$", "location": "path", "required": true, "type": "string" }, "processedDocumentType": { "description": "Required. What type of processing to return.", "location": "query", "type": "string", "enumDescriptions": [ "Default value.", "Available for all data store parsing configs.", "Only available if ChunkingConfig is enabled on the data store.", "Returns the converted Image bytes (as JPEG or PNG) if available.", "Return image bytes in base64 encoded format if image_id of a document is provided, only supported for enabling shareholder-structure in layout parsing config for now." ], "enum": [ "PROCESSED_DOCUMENT_TYPE_UNSPECIFIED", "PARSED_DOCUMENT", "CHUNKED_DOCUMENT", "IMAGE_CONVERTED_DOCUMENT", "IMAGE_BYTES" ] }, "processedDocumentFormat": { "description": "What format output should be. If unspecified, defaults to JSON.", "location": "query", "type": "string", "enumDescriptions": [ "Default value.", "Output format is a JSON string representation of processed document." ], "enum": [ "PROCESSED_DOCUMENT_FORMAT_UNSPECIFIED", "JSON" ] }, "imageId": { "description": "Optional. Specifies config for IMAGE_BYTES.", "location": "query", "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaProcessedDocument" }, "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 parsed layout information for a Document." } }, "resources": { "chunks": { "methods": { "get": { "id": "discoveryengine.projects.locations.collections.dataStores.branches.documents.chunks.get", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents/{documentsId}/chunks/{chunksId}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. Full resource name of Chunk, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}/chunks/{chunk}`. If the caller does not have permission to access the Chunk, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the requested Chunk does not exist, a `NOT_FOUND` error is returned.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/branches/[^/]+/documents/[^/]+/chunks/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaChunk" }, "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 Document." }, "list": { "id": "discoveryengine.projects.locations.collections.dataStores.branches.documents.chunks.list", "path": "v1alpha/{+parent}/chunks", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents/{documentsId}/chunks", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The parent document resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`. If the caller does not have permission to list Chunks under this document, regardless of whether or not this document exists, a `PERMISSION_DENIED` error is returned.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/branches/[^/]+/documents/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "Maximum number of Chunks to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "A page token ListChunksResponse.next_page_token, received from a previous ChunkService.ListChunks call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ChunkService.ListChunks must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaListChunksResponse" }, "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 Chunks." } } } } } } }, "completionConfig": { "methods": { "completeQuery": { "id": "discoveryengine.projects.locations.collections.dataStores.completionConfig.completeQuery", "path": "v1alpha/{+completionConfig}:completeQuery", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/completionConfig:completeQuery", "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`.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/completionConfig$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "completionConfig" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryRequest" }, "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryResponse" }, "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" ], "description": "Completes the user input with advanced keyword suggestions." } } }, "suggestionDenyListEntries": { "methods": { "import": { "id": "discoveryengine.projects.locations.collections.dataStores.suggestionDenyListEntries.import", "path": "v1alpha/{+parent}/suggestionDenyListEntries:import", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/suggestionDenyListEntries:import", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The parent data store resource name for which to import denylist entries. Follows pattern projects/*/locations/*/collections/*/dataStores/*.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesRequest" }, "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": "Imports all SuggestionDenyListEntry for a DataStore." }, "purge": { "id": "discoveryengine.projects.locations.collections.dataStores.suggestionDenyListEntries.purge", "path": "v1alpha/{+parent}/suggestionDenyListEntries:purge", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/suggestionDenyListEntries:purge", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The parent data store resource name for which to import denylist entries. Follows pattern projects/*/locations/*/collections/*/dataStores/*.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesRequest" }, "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 SuggestionDenyListEntry for a DataStore." } } }, "completionSuggestions": { "methods": { "import": { "id": "discoveryengine.projects.locations.collections.dataStores.completionSuggestions.import", "path": "v1alpha/{+parent}/completionSuggestions:import", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/completionSuggestions:import", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The parent data store resource name for which to import customer autocomplete suggestions. Follows pattern `projects/*/locations/*/collections/*/dataStores/*`", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsRequest" }, "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": "Imports CompletionSuggestions for a DataStore." }, "purge": { "id": "discoveryengine.projects.locations.collections.dataStores.completionSuggestions.purge", "path": "v1alpha/{+parent}/completionSuggestions:purge", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/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/*.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsRequest" }, "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." } } }, "controls": { "methods": { "create": { "id": "discoveryengine.projects.locations.collections.dataStores.controls.create", "path": "v1alpha/{+parent}/controls", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/controls", "httpMethod": "POST", "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}`.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", "location": "path", "required": true, "type": "string" }, "controlId": { "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", "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaControl" }, "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaControl" }, "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 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." }, "delete": { "id": "discoveryengine.projects.locations.collections.dataStores.controls.delete", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/controls/{controlsId}", "httpMethod": "DELETE", "parameters": { "name": { "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/[^/]+/collections/[^/]+/dataStores/[^/]+/controls/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleProtobufEmpty" }, "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 Control. If the Control to delete does not exist, a NOT_FOUND error is returned." }, "patch": { "id": "discoveryengine.projects.locations.collections.dataStores.controls.patch", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/controls/{controlsId}", "httpMethod": "PATCH", "parameters": { "name": { "description": "Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*`", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/controls/[^/]+$", "location": "path", "required": true, "type": "string" }, "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" } }, "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaControl" }, "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaControl" }, "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." }, "get": { "id": "discoveryengine.projects.locations.collections.dataStores.controls.get", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/controls/{controlsId}", "httpMethod": "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}`", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/controls/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaControl" }, "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 Control." }, "list": { "id": "discoveryengine.projects.locations.collections.dataStores.controls.list", "path": "v1alpha/{+parent}/controls", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/controls", "httpMethod": "GET", "parameters": { "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/[^/]+/collections/[^/]+/dataStores/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.", "location": "query", "type": "integer", "format": "int32" }, "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.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaListControlsResponse" }, "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 Controls by their parent DataStore." } } }, "conversations": { "methods": { "converse": { "id": "discoveryengine.projects.locations.collections.dataStores.conversations.converse", "path": "v1alpha/{+name}:converse", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/conversations/{conversationsId}:converse", "httpMethod": "POST", "parameters": { "name": { "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.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/conversations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaConverseConversationRequest" }, "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaConverseConversationResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "description": "Converses a conversation." }, "create": { "id": "discoveryengine.projects.locations.collections.dataStores.conversations.create", "path": "v1alpha/{+parent}/conversations", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/conversations", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. Full resource name of parent data store. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaConversation" }, "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaConversation" }, "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 Conversation. If the Conversation to create already exists, an ALREADY_EXISTS error is returned." }, "delete": { "id": "discoveryengine.projects.locations.collections.dataStores.conversations.delete", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/conversations/{conversationsId}", "httpMethod": "DELETE", "parameters": { "name": { "description": "Required. The resource name of the Conversation to delete. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/conversations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleProtobufEmpty" }, "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." }, "patch": { "id": "discoveryengine.projects.locations.collections.dataStores.conversations.patch", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/conversations/{conversationsId}", "httpMethod": "PATCH", "parameters": { "name": { "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/[^/]+$", "location": "path", "required": true, "type": "string" }, "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.", "location": "query", "type": "string", "format": "google-fieldmask" } }, "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaConversation" }, "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaConversation" }, "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 Conversation. Conversation action type cannot be changed. If the Conversation to update does not exist, a NOT_FOUND error is returned." }, "get": { "id": "discoveryengine.projects.locations.collections.dataStores.conversations.get", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/conversations/{conversationsId}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. The resource name of the Conversation to get. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/conversations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaConversation" }, "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." }, "list": { "id": "discoveryengine.projects.locations.collections.dataStores.conversations.list", "path": "v1alpha/{+parent}/conversations", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/conversations", "httpMethod": "GET", "parameters": { "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", "required": true, "type": "string" }, "pageSize": { "description": "Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "A page token, received from a previous `ListConversations` call. Provide this to retrieve the subsequent page.", "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\"", "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" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaListConversationsResponse" }, "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 Conversations by their parent DataStore." } } }, "schemas": { "methods": { "get": { "id": "discoveryengine.projects.locations.collections.dataStores.schemas.get", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/schemas/{schemasId}", "httpMethod": "GET", "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}`.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/schemas/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaSchema" }, "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 Schema." }, "list": { "id": "discoveryengine.projects.locations.collections.dataStores.schemas.list", "path": "v1alpha/{+parent}/schemas", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/schemas", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The parent data store resource name, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "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", "type": "integer", "format": "int32" }, "pageToken": { "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", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaListSchemasResponse" }, "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." }, "create": { "id": "discoveryengine.projects.locations.collections.dataStores.schemas.create", "path": "v1alpha/{+parent}/schemas", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/schemas", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The parent data store resource name, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", "location": "path", "required": true, "type": "string" }, "schemaId": { "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.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaSchema" }, "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": "Creates a Schema." }, "patch": { "id": "discoveryengine.projects.locations.collections.dataStores.schemas.patch", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/schemas/{schemasId}", "httpMethod": "PATCH", "parameters": { "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.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/schemas/[^/]+$", "location": "path", "required": true, "type": "string" }, "allowMissing": { "description": "If set to true, and the Schema is not found, a new Schema is created. In this situation, `update_mask` is ignored.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaSchema" }, "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 Schema." }, "delete": { "id": "discoveryengine.projects.locations.collections.dataStores.schemas.delete", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/schemas/{schemasId}", "httpMethod": "DELETE", "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}`.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/schemas/[^/]+$", "location": "path", "required": true, "type": "string" } }, "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" ], "description": "Deletes a Schema." } }, "resources": { "operations": { "methods": { "list": { "id": "discoveryengine.projects.locations.collections.dataStores.schemas.operations.list", "path": "v1alpha/{+name}/operations", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/schemas/{schemasId}/operations", "httpMethod": "GET", "parameters": { "name": { "description": "The name of the operation's parent resource.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/schemas/[^/]+$", "location": "path", "required": true, "type": "string" }, "filter": { "description": "The standard list filter.", "location": "query", "type": "string" }, "pageSize": { "description": "The standard list page size.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "The standard list page token.", "location": "query", "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.", "location": "query", "type": "boolean" } }, "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" ], "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`." }, "get": { "id": "discoveryengine.projects.locations.collections.dataStores.schemas.operations.get", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/schemas/{schemasId}/operations/{operationsId}", "httpMethod": "GET", "parameters": { "name": { "description": "The name of the operation resource.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/schemas/[^/]+/operations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "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" ], "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." } } } } }, "customModels": { "methods": { "list": { "id": "discoveryengine.projects.locations.collections.dataStores.customModels.list", "path": "v1alpha/{+dataStore}/customModels", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/customModels", "httpMethod": "GET", "parameters": { "dataStore": { "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.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "dataStore" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaListCustomModelsResponse" }, "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 all the custom models." } } }, "sessions": { "methods": { "create": { "id": "discoveryengine.projects.locations.collections.dataStores.sessions.create", "path": "v1alpha/{+parent}/sessions", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/sessions", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. Full resource name of parent data store. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", "location": "path", "required": true, "type": "string" }, "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" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaSession" }, "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaSession" }, "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." }, "delete": { "id": "discoveryengine.projects.locations.collections.dataStores.sessions.delete", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/sessions/{sessionsId}", "httpMethod": "DELETE", "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}`", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/sessions/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "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" ], "description": "Deletes a Session. If the Session to delete does not exist, a NOT_FOUND error is returned." }, "patch": { "id": "discoveryengine.projects.locations.collections.dataStores.sessions.patch", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/sessions/{sessionsId}", "httpMethod": "PATCH", "parameters": { "name": { "description": "Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*`", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/sessions/[^/]+$", "location": "path", "required": true, "type": "string" }, "updateMask": { "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.", "location": "query", "type": "string", "format": "google-fieldmask" } }, "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaSession" }, "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaSession" }, "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": "Updates a Session. Session action type cannot be changed. If the Session to update does not exist, a NOT_FOUND error is returned." }, "get": { "id": "discoveryengine.projects.locations.collections.dataStores.sessions.get", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/sessions/{sessionsId}", "httpMethod": "GET", "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/[^/]+/dataStores/[^/]+/sessions/[^/]+$", "location": "path", "required": true, "type": "string" }, "includeAnswerDetails": { "description": "Optional. If set to true, the full session including all answer details will be returned.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaSession" }, "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 Session." }, "list": { "id": "discoveryengine.projects.locations.collections.dataStores.sessions.list", "path": "v1alpha/{+parent}/sessions", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/sessions", "httpMethod": "GET", "parameters": { "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", "required": true, "type": "string" }, "pageSize": { "description": "Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page.", "location": "query", "type": "string" }, "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" }, "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` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaListSessionsResponse" }, "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": "Lists all Sessions by their parent DataStore." } }, "resources": { "answers": { "methods": { "get": { "id": "discoveryengine.projects.locations.collections.dataStores.sessions.answers.get", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/sessions/{sessionsId}/answers/{answersId}", "httpMethod": "GET", "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/[^/]+/dataStores/[^/]+/sessions/[^/]+/answers/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaAnswer" }, "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." } } } } }, "siteSearchEngine": { "methods": { "enableAdvancedSiteSearch": { "id": "discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.enableAdvancedSiteSearch", "path": "v1alpha/{+siteSearchEngine}:enableAdvancedSiteSearch", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine:enableAdvancedSiteSearch", "httpMethod": "POST", "parameters": { "siteSearchEngine": { "description": "Required. Full resource name of the SiteSearchEngine, such as `projects/{project}/locations/{location}/dataStores/{data_store_id}/siteSearchEngine`.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "siteSearchEngine" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchRequest" }, "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": "Upgrade from basic site search to advanced site search." }, "disableAdvancedSiteSearch": { "id": "discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.disableAdvancedSiteSearch", "path": "v1alpha/{+siteSearchEngine}:disableAdvancedSiteSearch", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine:disableAdvancedSiteSearch", "httpMethod": "POST", "parameters": { "siteSearchEngine": { "description": "Required. Full resource name of the SiteSearchEngine, such as `projects/{project}/locations/{location}/dataStores/{data_store_id}/siteSearchEngine`.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "siteSearchEngine" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchRequest" }, "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": "Downgrade from advanced site search to basic site search." }, "recrawlUris": { "id": "discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.recrawlUris", "path": "v1alpha/{+siteSearchEngine}:recrawlUris", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine:recrawlUris", "httpMethod": "POST", "parameters": { "siteSearchEngine": { "description": "Required. Full resource name of the SiteSearchEngine, such as `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine`.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "siteSearchEngine" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisRequest" }, "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": "Request on-demand recrawl for a list of URIs." }, "batchVerifyTargetSites": { "id": "discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.batchVerifyTargetSites", "path": "v1alpha/{+parent}:batchVerifyTargetSites", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine:batchVerifyTargetSites", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The parent resource shared by all TargetSites being verified. `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaBatchVerifyTargetSitesRequest" }, "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": "Verify target sites' ownership and validity. This API sends all the target sites under site search engine for verification." }, "fetchDomainVerificationStatus": { "id": "discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.fetchDomainVerificationStatus", "path": "v1alpha/{+siteSearchEngine}:fetchDomainVerificationStatus", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine:fetchDomainVerificationStatus", "httpMethod": "GET", "parameters": { "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`.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine$", "location": "path", "required": true, "type": "string" }, "pageSize": { "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.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "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.", "location": "query", "type": "string" } }, "parameterOrder": [ "siteSearchEngine" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaFetchDomainVerificationStatusResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "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." }, "setUriPatternDocumentData": { "id": "discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.setUriPatternDocumentData", "path": "v1alpha/{+siteSearchEngine}:setUriPatternDocumentData", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine:setUriPatternDocumentData", "httpMethod": "POST", "parameters": { "siteSearchEngine": { "description": "Required. Full resource name of the SiteSearchEngine, such as `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine`.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "siteSearchEngine" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataRequest" }, "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": "Sets the URI Pattern to Document data mapping for an Advanced Site Search DataStore." }, "getUriPatternDocumentData": { "id": "discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.getUriPatternDocumentData", "path": "v1alpha/{+siteSearchEngine}:getUriPatternDocumentData", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine:getUriPatternDocumentData", "httpMethod": "GET", "parameters": { "siteSearchEngine": { "description": "Required. Full resource name of the SiteSearchEngine, such as `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine`.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "siteSearchEngine" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaGetUriPatternDocumentDataResponse" }, "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 URI Pattern to Document data mapping for an Advanced Site Search DataStore." } }, "resources": { "operations": { "methods": { "list": { "id": "discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.operations.list", "path": "v1alpha/{+name}/operations", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine/operations", "httpMethod": "GET", "parameters": { "name": { "description": "The name of the operation's parent resource.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine$", "location": "path", "required": true, "type": "string" }, "filter": { "description": "The standard list filter.", "location": "query", "type": "string" }, "pageSize": { "description": "The standard list page size.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "The standard list page token.", "location": "query", "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.", "location": "query", "type": "boolean" } }, "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" ], "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`." }, "get": { "id": "discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.operations.get", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine/operations/{operationsId}", "httpMethod": "GET", "parameters": { "name": { "description": "The name of the operation resource.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine/operations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "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" ], "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." } } }, "targetSites": { "methods": { "create": { "id": "discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.targetSites.create", "path": "v1alpha/{+parent}/targetSites", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine/targetSites", "httpMethod": "POST", "parameters": { "parent": { "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$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaTargetSite" }, "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": "Creates a TargetSite." }, "batchCreate": { "id": "discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.targetSites.batchCreate", "path": "v1alpha/{+parent}/targetSites:batchCreate", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine/targetSites:batchCreate", "httpMethod": "POST", "parameters": { "parent": { "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.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesRequest" }, "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": "Creates TargetSite in a batch." }, "get": { "id": "discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.targetSites.get", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine/targetSites/{targetSitesId}", "httpMethod": "GET", "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.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine/targetSites/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaTargetSite" }, "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 TargetSite." }, "patch": { "id": "discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.targetSites.patch", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine/targetSites/{targetSitesId}", "httpMethod": "PATCH", "parameters": { "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.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine/targetSites/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaTargetSite" }, "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." }, "delete": { "id": "discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.targetSites.delete", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine/targetSites/{targetSitesId}", "httpMethod": "DELETE", "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.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine/targetSites/[^/]+$", "location": "path", "required": true, "type": "string" } }, "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" ], "description": "Deletes a TargetSite." }, "list": { "id": "discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.targetSites.list", "path": "v1alpha/{+parent}/targetSites", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine/targetSites", "httpMethod": "GET", "parameters": { "parent": { "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.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine$", "location": "path", "required": true, "type": "string" }, "pageSize": { "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.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "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.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaListTargetSitesResponse" }, "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 TargetSites." } }, "resources": { "operations": { "methods": { "list": { "id": "discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.targetSites.operations.list", "path": "v1alpha/{+name}/operations", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine/targetSites/operations", "httpMethod": "GET", "parameters": { "name": { "description": "The name of the operation's parent resource.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine/targetSites$", "location": "path", "required": true, "type": "string" }, "filter": { "description": "The standard list filter.", "location": "query", "type": "string" }, "pageSize": { "description": "The standard list page size.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "The standard list page token.", "location": "query", "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.", "location": "query", "type": "boolean" } }, "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" ], "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`." }, "get": { "id": "discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.targetSites.operations.get", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine/targetSites/operations/{operationsId}", "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" } }, "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" ], "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." } } } } }, "sitemaps": { "methods": { "create": { "id": "discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.sitemaps.create", "path": "v1alpha/{+parent}/sitemaps", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine/sitemaps", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. Parent resource name of the SiteSearchEngine, such as `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine`.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaSitemap" }, "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": "Creates a Sitemap." }, "delete": { "id": "discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.sitemaps.delete", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine/sitemaps/{sitemapsId}", "httpMethod": "DELETE", "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/[^/]+$", "location": "path", "required": true, "type": "string" } }, "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" ], "description": "Deletes a Sitemap." }, "fetch": { "id": "discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.sitemaps.fetch", "path": "v1alpha/{+parent}/sitemaps:fetch", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine/sitemaps:fetch", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. Parent resource name of the SiteSearchEngine, such as `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine`.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine$", "location": "path", "required": true, "type": "string" }, "matcher.urisMatcher.uris": { "description": "The Sitemap uris.", "location": "query", "repeated": true, "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "description": "Fetch Sitemaps in a DataStore." } } } } }, "userEvents": { "methods": { "write": { "id": "discoveryengine.projects.locations.collections.dataStores.userEvents.write", "path": "v1alpha/{+parent}/userEvents:write", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/userEvents:write", "httpMethod": "POST", "parameters": { "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}`.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", "location": "path", "required": true, "type": "string" }, "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" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaUserEvent" }, "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaUserEvent" }, "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": "Writes a single user event." }, "collect": { "id": "discoveryengine.projects.locations.collections.dataStores.userEvents.collect", "path": "v1alpha/{+parent}/userEvents:collect", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/userEvents:collect", "httpMethod": "GET", "parameters": { "parent": { "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/[^/]+$", "location": "path", "required": true, "type": "string" }, "userEvent": { "description": "Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters.", "location": "query", "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.", "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.", "location": "query", "type": "string", "format": "int64" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleApiHttpBody" }, "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": "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." }, "purge": { "id": "discoveryengine.projects.locations.collections.dataStores.userEvents.purge", "path": "v1alpha/{+parent}/userEvents:purge", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/userEvents:purge", "httpMethod": "POST", "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}`.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaPurgeUserEventsRequest" }, "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": "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." }, "import": { "id": "discoveryengine.projects.locations.collections.dataStores.userEvents.import", "path": "v1alpha/{+parent}/userEvents:import", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/userEvents:import", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. Parent DataStore resource name, of the form `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaImportUserEventsRequest" }, "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": "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." } } }, "widgetConfigs": { "methods": { "get": { "id": "discoveryengine.projects.locations.collections.dataStores.widgetConfigs.get", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/widgetConfigs/{widgetConfigsId}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. Full WidgetConfig resource name. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/widgetConfigs/{widget_config_id}`", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/widgetConfigs/[^/]+$", "location": "path", "required": true, "type": "string" }, "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.", "location": "query", "type": "boolean" }, "getWidgetConfigRequestOption.turnOffCollectionComponents": { "description": "Optional. Whether to turn off collection_components in WidgetConfig to reduce latency and data transmission.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaWidgetConfig" }, "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." }, "patch": { "id": "discoveryengine.projects.locations.collections.dataStores.widgetConfigs.patch", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/widgetConfigs/{widgetConfigsId}", "httpMethod": "PATCH", "parameters": { "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.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/widgetConfigs/[^/]+$", "location": "path", "required": true, "type": "string" }, "updateMask": { "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", "type": "string", "format": "google-fieldmask" } }, "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaWidgetConfig" }, "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaWidgetConfig" }, "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": "Update a WidgetConfig." } } } } }, "dataConnector": { "methods": { "mcp": { "id": "discoveryengine.projects.locations.collections.dataConnector.mcp", "path": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataConnector/mcp", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataConnector/mcp", "httpMethod": "DELETE", "parameters": { "projectsId": { "location": "path", "required": true, "type": "string" }, "locationsId": { "location": "path", "required": true, "type": "string" }, "collectionsId": { "location": "path", "required": true, "type": "string" }, "contentType": { "description": "The HTTP Content-Type header value specifying the content type of the body.", "location": "query", "type": "string" }, "data": { "description": "The HTTP request/response body as raw binary.", "location": "query", "type": "string", "format": "byte" }, "extensions": { "description": "Application specific response metadata. Must be set in the first response for streaming APIs.", "location": "query", "repeated": true, "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } } }, "parameterOrder": [ "projectsId", "locationsId", "collectionsId" ], "response": { "$ref": "GoogleApiHttpBody" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "description": "ServeMcpDeleteRequest serves a MCP DELETE request." }, "startConnectorRun": { "id": "discoveryengine.projects.locations.collections.dataConnector.startConnectorRun", "path": "v1alpha/{+parent}:startConnectorRun", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataConnector:startConnectorRun", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. Connector name of the form `projects/{project}/locations/{location}/collections/{collection_id}/dataConnector`", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataConnector$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaStartConnectorRunRequest" }, "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaConnectorRun" }, "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": "Starts an immediate synchronization process for a DataConnector. Third Party Connector Users must specify which entities should be synced. FHIR Connectors must provide a timestamp to indicate the point in time from which data should be synced." }, "checkRefreshToken": { "id": "discoveryengine.projects.locations.collections.dataConnector.checkRefreshToken", "path": "v1alpha/{+name}:checkRefreshToken", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataConnector:checkRefreshToken", "httpMethod": "GET", "parameters": { "name": { "description": "Required. The resource name of the connector for which a token is queried.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataConnector$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaCheckRefreshTokenResponse" }, "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" ], "deprecated": true, "description": "Deprecated: Checks the existence of a refresh token for the EUC user for a given connection and returns its details. Use AcquireAccessToken instead and then check the validity of the returned token by asking the 3rd party system. There's no way to know for sure if a refresh token is valid without asking the 3rd party system." }, "acquireAccessToken": { "id": "discoveryengine.projects.locations.collections.dataConnector.acquireAccessToken", "path": "v1alpha/{+name}:acquireAccessToken", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataConnector:acquireAccessToken", "httpMethod": "POST", "parameters": { "name": { "description": "Required. The resource name of the connector for which a token is queried.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataConnector$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaAcquireAccessTokenRequest" }, "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaAcquireAccessTokenResponse" }, "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": "Uses the per-user refresh token minted with AcquireAndStoreRefreshToken to generate and return a new access token and its details. Takes the access token from cache if available. Rotates the stored refresh token if needed. Uses the end user identity to return the user specific access token. Does *not* return the credentials configured by the administrator. Used by action execution and UI." }, "getConnectorSecret": { "id": "discoveryengine.projects.locations.collections.dataConnector.getConnectorSecret", "path": "v1alpha/{+name}:getConnectorSecret", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataConnector:getConnectorSecret", "httpMethod": "GET", "parameters": { "name": { "description": "Required. The full resource name of the associated data connector.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataConnector$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaGetConnectorSecretResponse" }, "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": "Get the secret for the associated connector." } }, "resources": { "operations": { "methods": { "list": { "id": "discoveryengine.projects.locations.collections.dataConnector.operations.list", "path": "v1alpha/{+name}/operations", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataConnector/operations", "httpMethod": "GET", "parameters": { "name": { "description": "The name of the operation's parent resource.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataConnector$", "location": "path", "required": true, "type": "string" }, "filter": { "description": "The standard list filter.", "location": "query", "type": "string" }, "pageSize": { "description": "The standard list page size.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "The standard list page token.", "location": "query", "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.", "location": "query", "type": "boolean" } }, "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" ], "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`." }, "get": { "id": "discoveryengine.projects.locations.collections.dataConnector.operations.get", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataConnector/operations/{operationsId}", "httpMethod": "GET", "parameters": { "name": { "description": "The name of the operation resource.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataConnector/operations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "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" ], "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." } } }, "connectorRuns": { "methods": { "list": { "id": "discoveryengine.projects.locations.collections.dataConnector.connectorRuns.list", "path": "v1alpha/{+parent}/connectorRuns", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataConnector/connectorRuns", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The parent DataConnector resource name, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataConnector`. If the caller does not have permission to list ConnectorRuns under this DataConnector, regardless of whether or not this DataConnector exists, a `PERMISSION_DENIED` error is returned.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataConnector$", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "Requested page size. Server may return fewer items than requested. If unspecified, defaults to 10. The maximum value is 50; values above 50 will be coerced to 50. If this field is negative, an `INVALID_ARGUMENT` error is returned.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "A page token, received from a previous `ListConnectorRuns` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListConnectorRuns` must match the call that provided the page token.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaListConnectorRunsResponse" }, "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": "Lists the ConnectorRuns of a DataConnector." } } } } }, "engines": { "methods": { "create": { "id": "discoveryengine.projects.locations.collections.engines.create", "path": "v1alpha/{+parent}/engines", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection}`.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+$", "location": "path", "required": true, "type": "string" }, "engineId": { "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", "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaEngine" }, "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": "Creates an Engine." }, "delete": { "id": "discoveryengine.projects.locations.collections.engines.delete", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}", "httpMethod": "DELETE", "parameters": { "name": { "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.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$", "location": "path", "required": true, "type": "string" } }, "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" ], "description": "Deletes an Engine." }, "patch": { "id": "discoveryengine.projects.locations.collections.engines.patch", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}", "httpMethod": "PATCH", "parameters": { "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.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$", "location": "path", "required": true, "type": "string" }, "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.", "location": "query", "type": "string", "format": "google-fieldmask" } }, "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaEngine" }, "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaEngine" }, "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 an Engine" }, "get": { "id": "discoveryengine.projects.locations.collections.engines.get", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. Full resource name of Engine, such as `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaEngine" }, "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 an Engine." }, "list": { "id": "discoveryengine.projects.locations.collections.engines.list", "path": "v1alpha/{+parent}/engines", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection_id}`.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "Optional. Not supported.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. Not supported.", "location": "query", "type": "string" }, "filter": { "description": "Optional. Filter by solution type. For example: solution_type=SOLUTION_TYPE_SEARCH", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaListEnginesResponse" }, "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 Engines associated with the project." }, "getWorkspaceSettings": { "id": "discoveryengine.projects.locations.collections.engines.getWorkspaceSettings", "path": "v1alpha/{+name}:getWorkspaceSettings", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}:getWorkspaceSettings", "httpMethod": "GET", "parameters": { "name": { "description": "Required. Full Engine resource name. Format: `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaWorkspaceSettings" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "description": "Get Workspace settings for the end user." }, "pause": { "id": "discoveryengine.projects.locations.collections.engines.pause", "path": "v1alpha/{+name}:pause", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}:pause", "httpMethod": "POST", "parameters": { "name": { "description": "Required. The name of the engine to pause. Format: `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaPauseEngineRequest" }, "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaEngine" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "description": "Pauses the training of an existing Engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION." }, "resume": { "id": "discoveryengine.projects.locations.collections.engines.resume", "path": "v1alpha/{+name}:resume", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}:resume", "httpMethod": "POST", "parameters": { "name": { "description": "Required. The name of the engine to resume. Format: `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaResumeEngineRequest" }, "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaEngine" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "description": "Resumes the training of an existing Engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION." }, "tune": { "id": "discoveryengine.projects.locations.collections.engines.tune", "path": "v1alpha/{+name}:tune", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}:tune", "httpMethod": "POST", "parameters": { "name": { "description": "Required. The resource name of the engine to tune. Format: `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaTuneEngineRequest" }, "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": "Tunes an existing Engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION." }, "getIamPolicy": { "id": "discoveryengine.projects.locations.collections.engines.getIamPolicy", "path": "v1alpha/{+resource}:getIamPolicy", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}:getIamPolicy", "httpMethod": "GET", "parameters": { "resource": { "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", "required": true, "type": "string" }, "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).", "location": "query", "type": "integer", "format": "int32" } }, "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 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." }, "setIamPolicy": { "id": "discoveryengine.projects.locations.collections.engines.setIamPolicy", "path": "v1alpha/{+resource}:setIamPolicy", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}:setIamPolicy", "httpMethod": "POST", "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.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "resource" ], "request": { "$ref": "GoogleIamV1SetIamPolicyRequest" }, "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": "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." } }, "resources": { "servingConfigs": { "methods": { "search": { "id": "discoveryengine.projects.locations.collections.engines.servingConfigs.search", "path": "v1alpha/{+servingConfig}:search", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/servingConfigs/{servingConfigsId}:search", "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/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/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "servingConfig" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequest" }, "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponse" }, "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." }, "searchLite": { "id": "discoveryengine.projects.locations.collections.engines.servingConfigs.searchLite", "path": "v1alpha/{+servingConfig}:searchLite", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/servingConfigs/{servingConfigsId}:searchLite", "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/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/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "servingConfig" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequest" }, "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponse" }, "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." }, "answer": { "id": "discoveryengine.projects.locations.collections.engines.servingConfigs.answer", "path": "v1alpha/{+servingConfig}:answer", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/servingConfigs/{servingConfigsId}:answer", "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/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "servingConfig" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest" }, "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse" }, "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": "Answer query method." }, "streamAnswer": { "id": "discoveryengine.projects.locations.collections.engines.servingConfigs.streamAnswer", "path": "v1alpha/{+servingConfig}:streamAnswer", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/servingConfigs/{servingConfigsId}:streamAnswer", "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/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "servingConfig" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest" }, "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse" }, "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": "Answer query method (streaming). It takes one AnswerQueryRequest and returns multiple AnswerQueryResponse messages in a stream." }, "recommend": { "id": "discoveryengine.projects.locations.collections.engines.servingConfigs.recommend", "path": "v1alpha/{+servingConfig}:recommend", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/servingConfigs/{servingConfigsId}:recommend", "httpMethod": "POST", "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.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/servingConfigs/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "servingConfig" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaRecommendRequest" }, "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaRecommendResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "description": "Makes a recommendation, which requires a contextual user event." }, "create": { "id": "discoveryengine.projects.locations.collections.engines.servingConfigs.create", "path": "v1alpha/{+parent}/servingConfigs", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/servingConfigs", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. Full resource name of parent. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$", "location": "path", "required": true, "type": "string" }, "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+/.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaServingConfig" }, "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaServingConfig" }, "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 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." }, "delete": { "id": "discoveryengine.projects.locations.collections.engines.servingConfigs.delete", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/servingConfigs/{servingConfigsId}", "httpMethod": "DELETE", "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}`", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/servingConfigs/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleProtobufEmpty" }, "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 ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist." }, "patch": { "id": "discoveryengine.projects.locations.collections.engines.servingConfigs.patch", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/servingConfigs/{servingConfigsId}", "httpMethod": "PATCH", "parameters": { "name": { "description": "Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}`", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/servingConfigs/[^/]+$", "location": "path", "required": true, "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.", "location": "query", "type": "string", "format": "google-fieldmask" } }, "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaServingConfig" }, "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaServingConfig" }, "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." }, "get": { "id": "discoveryengine.projects.locations.collections.engines.servingConfigs.get", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/servingConfigs/{servingConfigsId}", "httpMethod": "GET", "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/[^/]+/collections/[^/]+/engines/[^/]+/servingConfigs/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaServingConfig" }, "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 ServingConfig. Returns a NotFound error if the ServingConfig does not exist." }, "list": { "id": "discoveryengine.projects.locations.collections.engines.servingConfigs.list", "path": "v1alpha/{+parent}/servingConfigs", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/servingConfigs", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. Full resource name of the parent resource. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "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", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse" }, "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." } } }, "operations": { "methods": { "list": { "id": "discoveryengine.projects.locations.collections.engines.operations.list", "path": "v1alpha/{+name}/operations", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/operations", "httpMethod": "GET", "parameters": { "name": { "description": "The name of the operation's parent resource.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$", "location": "path", "required": true, "type": "string" }, "filter": { "description": "The standard list filter.", "location": "query", "type": "string" }, "pageSize": { "description": "The standard list page size.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "The standard list page token.", "location": "query", "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.", "location": "query", "type": "boolean" } }, "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" ], "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`." }, "get": { "id": "discoveryengine.projects.locations.collections.engines.operations.get", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/operations/{operationsId}", "httpMethod": "GET", "parameters": { "name": { "description": "The name of the operation resource.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/operations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "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" ], "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." } } }, "analytics": { "methods": { "exportMetrics": { "id": "discoveryengine.projects.locations.collections.engines.analytics.exportMetrics", "path": "v1alpha/{+analytics}:exportMetrics", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/analytics:exportMetrics", "httpMethod": "POST", "parameters": { "analytics": { "description": "Required. The analytics resource name under the engine where the metrics are created. The format is `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/analytics`.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/analytics$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "analytics" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaExportMetricsRequest" }, "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": "Exports metrics." }, "getConfig": { "id": "discoveryengine.projects.locations.collections.engines.analytics.getConfig", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/analytics/config", "httpMethod": "GET", "parameters": { "name": { "description": "Required. The resource name of the analytics customer config. Format: `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/analytics/config`", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/analytics/config$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaAnalyticsConfig" }, "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 AnalyticsConfig." }, "updateConfig": { "id": "discoveryengine.projects.locations.collections.engines.analytics.updateConfig", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/analytics/config", "httpMethod": "PATCH", "parameters": { "name": { "description": "Required. The resource name of the analytics customer config. Format: `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/analytics/config`", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/analytics/config$", "location": "path", "required": true, "type": "string" }, "updateMask": { "description": "The list of fields of AnalyticsConfig to update. If not specified, the method will perform a full replacement.", "location": "query", "type": "string", "format": "google-fieldmask" } }, "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaAnalyticsConfig" }, "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaAnalyticsConfig" }, "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 AnalyticsConfig for analytics." } } }, "assistants": { "methods": { "streamAssist": { "id": "discoveryengine.projects.locations.collections.engines.assistants.streamAssist", "path": "v1alpha/{+name}:streamAssist", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}:streamAssist", "httpMethod": "POST", "parameters": { "name": { "description": "Required. The resource name of the Assistant. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}`", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaStreamAssistRequest" }, "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaStreamAssistResponse" }, "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": "Assists the user with a query in a streaming fashion." }, "create": { "id": "discoveryengine.projects.locations.collections.engines.assistants.create", "path": "v1alpha/{+parent}/assistants", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The parent resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$", "location": "path", "required": true, "type": "string" }, "assistantId": { "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.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaAssistant" }, "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaAssistant" }, "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 an Assistant." }, "delete": { "id": "discoveryengine.projects.locations.collections.engines.assistants.delete", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}", "httpMethod": "DELETE", "parameters": { "name": { "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.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "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" ], "description": "Deletes an Assistant." }, "patch": { "id": "discoveryengine.projects.locations.collections.engines.assistants.patch", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}", "httpMethod": "PATCH", "parameters": { "name": { "description": "Immutable. Resource name of the assistant. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}` It must be a UTF-8 encoded string with a length limit of 1024 characters.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+$", "location": "path", "required": true, "type": "string" }, "updateMask": { "description": "The list of fields to update.", "location": "query", "type": "string", "format": "google-fieldmask" } }, "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaAssistant" }, "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaAssistant" }, "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": "Updates an Assistant" }, "get": { "id": "discoveryengine.projects.locations.collections.engines.assistants.get", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. Resource name of Assistant. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}`", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaAssistant" }, "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 an Assistant." }, "list": { "id": "discoveryengine.projects.locations.collections.engines.assistants.list", "path": "v1alpha/{+parent}/assistants", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The parent resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "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.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "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.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaListAssistantsResponse" }, "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": "Lists all Assistants under an Engine." } }, "resources": { "agents": { "methods": { "create": { "id": "discoveryengine.projects.locations.collections.engines.assistants.agents.create", "path": "v1alpha/{+parent}/agents", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}/agents", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The parent resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}`", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaAgent" }, "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaAgent" }, "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 an Agent." }, "delete": { "id": "discoveryengine.projects.locations.collections.engines.assistants.agents.delete", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}/agents/{agentsId}", "httpMethod": "DELETE", "parameters": { "name": { "description": "Required. Resource name of Agent. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}` If the caller does not have permission to delete the agent, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the agent to delete does not exist, a `NOT_FOUND` error is returned.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+/agents/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "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": "Deletes an Agent." }, "patch": { "id": "discoveryengine.projects.locations.collections.engines.assistants.agents.patch", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}/agents/{agentsId}", "httpMethod": "PATCH", "parameters": { "name": { "description": "Identifier. Resource name of the agent. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}`", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+/agents/[^/]+$", "location": "path", "required": true, "type": "string" }, "updateMask": { "description": "Optional. The list of fields to update.", "location": "query", "type": "string", "format": "google-fieldmask" } }, "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaAgent" }, "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaAgent" }, "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": "Updates an Agent" }, "get": { "id": "discoveryengine.projects.locations.collections.engines.assistants.agents.get", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}/agents/{agentsId}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. Resource name of Agent. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}`", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+/agents/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaAgent" }, "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 an Agent." }, "list": { "id": "discoveryengine.projects.locations.collections.engines.assistants.agents.list", "path": "v1alpha/{+parent}/agents", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}/agents", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The parent resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}`", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "Optional. Maximum number of Agents to return. If unspecified, defaults to 100. The maximum allowed value is 1000; anything above that will be coerced down to 1000.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. A page token ListAgentsResponse.next_page_token, received from a previous AgentService.ListAgents call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListAgents must match the call that provided the page token.", "location": "query", "type": "string" }, "orderBy": { "description": "Optional. 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` * `is_pinned` Example: * \"update_time desc\" * \"is_pinned desc,update_time desc\": list agents by is_pinned first, then by update_time.", "location": "query", "type": "string" }, "filter": { "description": "Optional. Filters the Agents list. Supported fields: * `display_name`: display name of the agent. Supports `=`, `:`. * `id`: ID of the agent. Supports `=`. * `state`: state of the agent. Supports `=`. * `create_time`: timestamp when the agent was created. Supports `=`, `\u003e`, `\u003c`, `\u003e=`, `\u003c=`. * `update_time`: timestamp when the agent was last updated. Supports `=`, `\u003e`, `\u003c`, `\u003e=`, `\u003c=`. Examples: * `display_name = \"My Agent\"` * `create_time \u003e \"2023-01-01T00:00:00Z\"`", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaListAgentsResponse" }, "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": "Lists all Agents under an Assistant which were created by the caller." } }, "resources": { "operations": { "methods": { "get": { "id": "discoveryengine.projects.locations.collections.engines.assistants.agents.operations.get", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}/agents/{agentsId}/operations/{operationsId}", "httpMethod": "GET", "parameters": { "name": { "description": "The name of the operation resource.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+/agents/[^/]+/operations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "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" ], "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." } } }, "files": { "methods": { "import": { "id": "discoveryengine.projects.locations.collections.engines.assistants.agents.files.import", "path": "v1alpha/{+parent}/files:import", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}/agents/{agentsId}/files:import", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The resource name of the Agent. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}`", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+/agents/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaImportAgentFileRequest" }, "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaImportAgentFileResponse" }, "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 a file to an Agent. Currently only No-Code agents are supported." } } } } }, "cannedQueries": { "methods": { "create": { "id": "discoveryengine.projects.locations.collections.engines.assistants.cannedQueries.create", "path": "v1alpha/{+parent}/cannedQueries", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}/cannedQueries", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The parent resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}`", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+$", "location": "path", "required": true, "type": "string" }, "cannedQueryId": { "description": "Required. The ID to use for the canned query, which will become the final component of the canned query's resource name. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) with a length limit of 63 characters.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaCannedQuery" }, "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaCannedQuery" }, "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 CannedQuery." }, "delete": { "id": "discoveryengine.projects.locations.collections.engines.assistants.cannedQueries.delete", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}/cannedQueries/{cannedQueriesId}", "httpMethod": "DELETE", "parameters": { "name": { "description": "Required. Resource name of CannedQuery. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/cannedQueries/{canned_query}` If the caller does not have permission to delete the canned query, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the canned query to delete does not exist, a `NOT_FOUND` error is returned.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+/cannedQueries/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "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" ], "description": "Deletes a CannedQuery." }, "patch": { "id": "discoveryengine.projects.locations.collections.engines.assistants.cannedQueries.patch", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}/cannedQueries/{cannedQueriesId}", "httpMethod": "PATCH", "parameters": { "name": { "description": "Immutable. Resource name of the canned query. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/cannedQueries/{canned_query}` It must be a UTF-8 encoded string with a length limit of 1024 characters.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+/cannedQueries/[^/]+$", "location": "path", "required": true, "type": "string" }, "updateMask": { "description": "The list of fields to update.", "location": "query", "type": "string", "format": "google-fieldmask" } }, "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaCannedQuery" }, "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaCannedQuery" }, "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": "Updates a CannedQuery." }, "get": { "id": "discoveryengine.projects.locations.collections.engines.assistants.cannedQueries.get", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}/cannedQueries/{cannedQueriesId}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. Resource name of CannedQuery. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/cannedQueries/{canned_query}`", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+/cannedQueries/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaCannedQuery" }, "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 CannedQuery." }, "list": { "id": "discoveryengine.projects.locations.collections.engines.assistants.cannedQueries.list", "path": "v1alpha/{+parent}/cannedQueries", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}/cannedQueries", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The parent resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}`", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+$", "location": "path", "required": true, "type": "string" }, "filter": { "description": "Optional. The filter expression. Supported fields: * `enabled` * `google_defined` Examples: * `enabled=true` * `google_defined=true` * `enabled=true AND google_defined=true`", "location": "query", "type": "string" }, "pageSize": { "description": "Maximum number of canned queries to return. If unspecified, defaults to 100. The maximum allowed value is 1000; anything above that will be coerced down to 1000.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "A page token received from a previous CannedQueryService.ListCannedQueries call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to CannedQueryService.ListCannedQueries must match the call that provided the page token.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaListCannedQueriesResponse" }, "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": "Lists all CannedQuerys under an Assistant." } } } } }, "completionConfig": { "methods": { "completeQuery": { "id": "discoveryengine.projects.locations.collections.engines.completionConfig.completeQuery", "path": "v1alpha/{+completionConfig}:completeQuery", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/completionConfig:completeQuery", "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`.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/completionConfig$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "completionConfig" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryRequest" }, "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryResponse" }, "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" ], "description": "Completes the user input with advanced keyword suggestions." }, "removeSuggestion": { "id": "discoveryengine.projects.locations.collections.engines.completionConfig.removeSuggestion", "path": "v1alpha/{+completionConfig}:removeSuggestion", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/completionConfig:removeSuggestion", "httpMethod": "POST", "parameters": { "completionConfig": { "description": "Required. The completion_config of the parent engine resource name for which the search history suggestion is to be removed, such as `projects/*/locations/global/collections/default_collection/engines/*/completionConfig`.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/completionConfig$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "completionConfig" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaRemoveSuggestionRequest" }, "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaRemoveSuggestionResponse" }, "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": "Removes the search history suggestion in an engine for a user. This will remove the suggestion from being returned in the AdvancedCompleteQueryResponse.recent_search_suggestions for this user. If the user searches the same suggestion again, the new history will override and suggest this suggestion again." } } }, "controls": { "methods": { "create": { "id": "discoveryengine.projects.locations.collections.engines.controls.create", "path": "v1alpha/{+parent}/controls", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/controls", "httpMethod": "POST", "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}`.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$", "location": "path", "required": true, "type": "string" }, "controlId": { "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", "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaControl" }, "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaControl" }, "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 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." }, "delete": { "id": "discoveryengine.projects.locations.collections.engines.controls.delete", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/controls/{controlsId}", "httpMethod": "DELETE", "parameters": { "name": { "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/[^/]+/collections/[^/]+/engines/[^/]+/controls/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleProtobufEmpty" }, "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 Control. If the Control to delete does not exist, a NOT_FOUND error is returned." }, "patch": { "id": "discoveryengine.projects.locations.collections.engines.controls.patch", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/controls/{controlsId}", "httpMethod": "PATCH", "parameters": { "name": { "description": "Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*`", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/controls/[^/]+$", "location": "path", "required": true, "type": "string" }, "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" } }, "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaControl" }, "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaControl" }, "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." }, "get": { "id": "discoveryengine.projects.locations.collections.engines.controls.get", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/controls/{controlsId}", "httpMethod": "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}`", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/controls/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaControl" }, "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 Control." }, "list": { "id": "discoveryengine.projects.locations.collections.engines.controls.list", "path": "v1alpha/{+parent}/controls", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/controls", "httpMethod": "GET", "parameters": { "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/[^/]+/collections/[^/]+/engines/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.", "location": "query", "type": "integer", "format": "int32" }, "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.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaListControlsResponse" }, "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 Controls by their parent DataStore." } } }, "conversations": { "methods": { "converse": { "id": "discoveryengine.projects.locations.collections.engines.conversations.converse", "path": "v1alpha/{+name}:converse", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/conversations/{conversationsId}:converse", "httpMethod": "POST", "parameters": { "name": { "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.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/conversations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaConverseConversationRequest" }, "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaConverseConversationResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "description": "Converses a conversation." }, "create": { "id": "discoveryengine.projects.locations.collections.engines.conversations.create", "path": "v1alpha/{+parent}/conversations", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/conversations", "httpMethod": "POST", "parameters": { "parent": { "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/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaConversation" }, "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaConversation" }, "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 Conversation. If the Conversation to create already exists, an ALREADY_EXISTS error is returned." }, "delete": { "id": "discoveryengine.projects.locations.collections.engines.conversations.delete", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/conversations/{conversationsId}", "httpMethod": "DELETE", "parameters": { "name": { "description": "Required. The resource name of the Conversation to delete. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/conversations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleProtobufEmpty" }, "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." }, "patch": { "id": "discoveryengine.projects.locations.collections.engines.conversations.patch", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/conversations/{conversationsId}", "httpMethod": "PATCH", "parameters": { "name": { "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/[^/]+/engines/[^/]+/conversations/[^/]+$", "location": "path", "required": true, "type": "string" }, "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.", "location": "query", "type": "string", "format": "google-fieldmask" } }, "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaConversation" }, "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaConversation" }, "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 Conversation. Conversation action type cannot be changed. If the Conversation to update does not exist, a NOT_FOUND error is returned." }, "get": { "id": "discoveryengine.projects.locations.collections.engines.conversations.get", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/conversations/{conversationsId}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. The resource name of the Conversation to get. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/conversations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaConversation" }, "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." }, "list": { "id": "discoveryengine.projects.locations.collections.engines.conversations.list", "path": "v1alpha/{+parent}/conversations", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/conversations", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The data store resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "A page token, received from a previous `ListConversations` call. Provide this to retrieve the subsequent page.", "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\"", "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" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaListConversationsResponse" }, "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 Conversations by their parent DataStore." } } }, "sessions": { "methods": { "create": { "id": "discoveryengine.projects.locations.collections.engines.sessions.create", "path": "v1alpha/{+parent}/sessions", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/sessions", "httpMethod": "POST", "parameters": { "parent": { "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/[^/]+$", "location": "path", "required": true, "type": "string" }, "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" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaSession" }, "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaSession" }, "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." }, "delete": { "id": "discoveryengine.projects.locations.collections.engines.sessions.delete", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/sessions/{sessionsId}", "httpMethod": "DELETE", "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}`", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/sessions/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "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" ], "description": "Deletes a Session. If the Session to delete does not exist, a NOT_FOUND error is returned." }, "patch": { "id": "discoveryengine.projects.locations.collections.engines.sessions.patch", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/sessions/{sessionsId}", "httpMethod": "PATCH", "parameters": { "name": { "description": "Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*`", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/sessions/[^/]+$", "location": "path", "required": true, "type": "string" }, "updateMask": { "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.", "location": "query", "type": "string", "format": "google-fieldmask" } }, "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaSession" }, "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaSession" }, "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": "Updates a Session. Session action type cannot be changed. If the Session to update does not exist, a NOT_FOUND error is returned." }, "get": { "id": "discoveryengine.projects.locations.collections.engines.sessions.get", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/sessions/{sessionsId}", "httpMethod": "GET", "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": { "description": "Optional. If set to true, the full session including all answer details will be returned.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaSession" }, "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 Session." }, "list": { "id": "discoveryengine.projects.locations.collections.engines.sessions.list", "path": "v1alpha/{+parent}/sessions", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/sessions", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The data store resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page.", "location": "query", "type": "string" }, "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" }, "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` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaListSessionsResponse" }, "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": "Lists all Sessions by their parent DataStore." } }, "resources": { "alphaEvolveExperiments": { "resources": { "operations": { "methods": { "get": { "id": "discoveryengine.projects.locations.collections.engines.sessions.alphaEvolveExperiments.operations.get", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/sessions/{sessionsId}/alphaEvolveExperiments/{alphaEvolveExperimentsId}/operations/{operationsId}", "httpMethod": "GET", "parameters": { "name": { "description": "The name of the operation resource.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/sessions/[^/]+/alphaEvolveExperiments/[^/]+/operations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "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" ], "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." } } } } }, "operations": { "methods": { "get": { "id": "discoveryengine.projects.locations.collections.engines.sessions.operations.get", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/sessions/{sessionsId}/operations/{operationsId}", "httpMethod": "GET", "parameters": { "name": { "description": "The name of the operation resource.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/sessions/[^/]+/operations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "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" ], "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." } } }, "answers": { "methods": { "get": { "id": "discoveryengine.projects.locations.collections.engines.sessions.answers.get", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/sessions/{sessionsId}/answers/{answersId}", "httpMethod": "GET", "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", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaAnswer" }, "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." } } }, "files": { "methods": { "list": { "id": "discoveryengine.projects.locations.collections.engines.sessions.files.list", "path": "v1alpha/{+parent}/files", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/sessions/{sessionsId}/files", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The resource name of the Session. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}` Name of the session resource to which the file belong.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/sessions/[^/]+$", "location": "path", "required": true, "type": "string" }, "filter": { "description": "Optional. The filter syntax consists of an expression language for constructing a predicate from one or more fields of the files being filtered. Filter expression is case-sensitive. Currently supported field names are: * upload_time * last_add_time * last_use_time * file_name * mime_type Some examples of filters would be: * \"file_name = 'file_1'\" * \"file_name = 'file_1' AND mime_type = 'text/plain'\" * \"last_use_time \u003e '2025-06-14T12:00:00Z'\" For a full description of the filter format, please see https://google.aip.dev/160.", "location": "query", "type": "string" }, "pageSize": { "description": "Optional. The maximum number of files to return. The service may return fewer than this value. If unspecified, at most 100 files will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. If user specifies a value less than or equal to 0 - the request will be rejected with an INVALID_ARGUMENT error.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. A page token received from a previous `ListFiles` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListFiles` must match the call that provided the page token (except `page_size`, which may differ).", "location": "query", "type": "string" }, "orderBy": { "description": "Optional. Specifies the order in which files are returned. The value is a comma-separated string of fields to sort by. For ascending order - just the field name is used. For descending order - the field name is suffixed with ` desc`. Sorting is stable and applied sequentially according to the order of fields provided in the string. Supported fields for ordering: * `upload_time`: The time the file was uploaded. * `file_name`: The name of the file. * `mime_type`: The MIME type of the file. * `session_name`: The name of the session the file belongs to. Default Behavior: If the `order_by` field is not specified, files will be returned sorted by creation time in descending order. Examples: 1. Sort by file name in ascending order: `file_name` 2. Sort by upload time in descending order: `upload_time desc` 3. Sort by file name (ascending), then by content type (MIME type) (descending), and finally by upload time (ascending): `file_name, mime_type desc, upload_time`", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaListFilesResponse" }, "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": "Lists metadata for all files in the current session." } } } } }, "widgetConfigs": { "methods": { "get": { "id": "discoveryengine.projects.locations.collections.engines.widgetConfigs.get", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/widgetConfigs/{widgetConfigsId}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. Full WidgetConfig resource name. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/widgetConfigs/{widget_config_id}`", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/widgetConfigs/[^/]+$", "location": "path", "required": true, "type": "string" }, "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.", "location": "query", "type": "boolean" }, "getWidgetConfigRequestOption.turnOffCollectionComponents": { "description": "Optional. Whether to turn off collection_components in WidgetConfig to reduce latency and data transmission.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaWidgetConfig" }, "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." }, "patch": { "id": "discoveryengine.projects.locations.collections.engines.widgetConfigs.patch", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/widgetConfigs/{widgetConfigsId}", "httpMethod": "PATCH", "parameters": { "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.", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/widgetConfigs/[^/]+$", "location": "path", "required": true, "type": "string" }, "updateMask": { "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", "type": "string", "format": "google-fieldmask" } }, "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaWidgetConfig" }, "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaWidgetConfig" }, "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": "Update a WidgetConfig." } } } } } } }, "dataStores": { "methods": { "completeQuery": { "id": "discoveryengine.projects.locations.dataStores.completeQuery", "path": "v1alpha/{+dataStore}:completeQuery", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}:completeQuery", "httpMethod": "GET", "parameters": { "dataStore": { "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/[^/]+/dataStores/[^/]+$", "location": "path", "required": true, "type": "string" }, "query": { "description": "Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters.", "location": "query", "type": "string" }, "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.", "location": "query", "type": "string" }, "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": { "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" } }, "parameterOrder": [ "dataStore" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaCompleteQueryResponse" }, "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": "Completes the specified user input with keyword suggestions." }, "create": { "id": "discoveryengine.projects.locations.dataStores.create", "path": "v1alpha/{+parent}/dataStores", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection}`.", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" }, "cmekConfigName": { "description": "Resource name of the CmekConfig to use for protecting this DataStore.", "location": "query", "type": "string" }, "disableCmek": { "description": "DataStore without CMEK protections. If a default CmekConfig is set for the project, setting this field will override the default CmekConfig as well.", "location": "query", "type": "boolean" }, "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.", "location": "query", "type": "string" }, "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" }, "skipDefaultSchemaCreation": { "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.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaDataStore" }, "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": "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." }, "get": { "id": "discoveryengine.projects.locations.dataStores.get", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}", "httpMethod": "GET", "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.", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaDataStore" }, "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 DataStore." }, "list": { "id": "discoveryengine.projects.locations.dataStores.list", "path": "v1alpha/{+parent}/dataStores", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores", "httpMethod": "GET", "parameters": { "parent": { "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.", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "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", "format": "int32" }, "pageToken": { "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", "type": "string" }, "filter": { "description": "Filter by solution type . For example: `filter = 'solution_type:SOLUTION_TYPE_SEARCH'`", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaListDataStoresResponse" }, "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 DataStores associated with the project." }, "delete": { "id": "discoveryengine.projects.locations.dataStores.delete", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}", "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.", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "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": "Deletes a DataStore." }, "patch": { "id": "discoveryengine.projects.locations.dataStores.patch", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}", "httpMethod": "PATCH", "parameters": { "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.", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", "location": "path", "required": true, "type": "string" }, "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" } }, "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaDataStore" }, "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaDataStore" }, "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 DataStore" }, "getDocumentProcessingConfig": { "id": "discoveryengine.projects.locations.dataStores.getDocumentProcessingConfig", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/documentProcessingConfig", "httpMethod": "GET", "parameters": { "name": { "description": "Required. Full DocumentProcessingConfig resource name. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/documentProcessingConfig`", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/documentProcessingConfig$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig" }, "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 DocumentProcessingConfig." }, "updateDocumentProcessingConfig": { "id": "discoveryengine.projects.locations.dataStores.updateDocumentProcessingConfig", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/documentProcessingConfig", "httpMethod": "PATCH", "parameters": { "name": { "description": "The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`.", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/documentProcessingConfig$", "location": "path", "required": true, "type": "string" }, "updateMask": { "description": "Indicates which fields in the provided DocumentProcessingConfig to update. The following are the only supported fields: * DocumentProcessingConfig.ocr_config If not set, all supported fields are updated.", "location": "query", "type": "string", "format": "google-fieldmask" } }, "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig" }, "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig" }, "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 DocumentProcessingConfig. DocumentProcessingConfig is a singleon resource of DataStore. It's empty when DataStore is created. The first call to this method will set up DocumentProcessingConfig." }, "addPatientFilter": { "id": "discoveryengine.projects.locations.dataStores.addPatientFilter", "path": "v1alpha/{+dataStore}:addPatientFilter", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}:addPatientFilter", "httpMethod": "POST", "parameters": { "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.", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "dataStore" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaAddPatientFilterRequest" }, "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": "Adds a group of patient IDs as a patient filter for the data store. Patient filters are empty by default when a data store is created, and are stored in a separate table. The data store must first be created, and must be a healthcare data store. 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." }, "removePatientFilter": { "id": "discoveryengine.projects.locations.dataStores.removePatientFilter", "path": "v1alpha/{+dataStore}:removePatientFilter", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}:removePatientFilter", "httpMethod": "POST", "parameters": { "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", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "dataStore" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaRemovePatientFilterRequest" }, "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": "Removes a group of patient IDs from the patient filter for the data store. Patient filters are empty by default when a data store is created, and are stored in a separate table. The data store must first be created, and must be a healthcare data store. This method will fail if the data store does not have a patient filter. The filter group must be a FHIR resource name of type Group, and the list of patient IDs to remove will be constructed from the direct members of the group which are Patient resources." }, "deletePatientFilter": { "id": "discoveryengine.projects.locations.dataStores.deletePatientFilter", "path": "v1alpha/{+dataStore}:deletePatientFilter", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}:deletePatientFilter", "httpMethod": "POST", "parameters": { "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.", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "dataStore" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaDeletePatientFiltersRequest" }, "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 the entire patient filter for the data store. Patient filters are empty by default when a data store is created, and are stored in a separate table. The data store must first be created, and must be a healthcare data store. This method will fail if the data store does not have a patient filter." }, "replacePatientFilter": { "id": "discoveryengine.projects.locations.dataStores.replacePatientFilter", "path": "v1alpha/{+dataStore}:replacePatientFilter", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}:replacePatientFilter", "httpMethod": "POST", "parameters": { "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.", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "dataStore" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaReplacePatientFilterRequest" }, "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": "Replaces the patient filter for the data store. This method is essentially a combination of DeletePatientFilters and AddPatientFilter. Patient filters are empty by default when a data store is created, and are stored in a separate table. The data store must first be created, and must be a healthcare data store. This method will fail if the data store does not have a patient filter. 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." }, "getSiteSearchEngine": { "id": "discoveryengine.projects.locations.dataStores.getSiteSearchEngine", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine", "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.", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/siteSearchEngine$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaSiteSearchEngine" }, "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." } }, "resources": { "servingConfigs": { "methods": { "search": { "id": "discoveryengine.projects.locations.dataStores.servingConfigs.search", "path": "v1alpha/{+servingConfig}:search", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}:search", "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/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/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "servingConfig" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequest" }, "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponse" }, "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." }, "searchLite": { "id": "discoveryengine.projects.locations.dataStores.servingConfigs.searchLite", "path": "v1alpha/{+servingConfig}:searchLite", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}:searchLite", "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/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/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "servingConfig" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequest" }, "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponse" }, "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." }, "answer": { "id": "discoveryengine.projects.locations.dataStores.servingConfigs.answer", "path": "v1alpha/{+servingConfig}:answer", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}:answer", "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/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "servingConfig" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest" }, "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse" }, "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": "Answer query method." }, "streamAnswer": { "id": "discoveryengine.projects.locations.dataStores.servingConfigs.streamAnswer", "path": "v1alpha/{+servingConfig}:streamAnswer", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}:streamAnswer", "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/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "servingConfig" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest" }, "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse" }, "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": "Answer query method (streaming). It takes one AnswerQueryRequest and returns multiple AnswerQueryResponse messages in a stream." }, "recommend": { "id": "discoveryengine.projects.locations.dataStores.servingConfigs.recommend", "path": "v1alpha/{+servingConfig}:recommend", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}:recommend", "httpMethod": "POST", "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.", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "servingConfig" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaRecommendRequest" }, "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaRecommendResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "description": "Makes a recommendation, which requires a contextual user event." }, "create": { "id": "discoveryengine.projects.locations.dataStores.servingConfigs.create", "path": "v1alpha/{+parent}/servingConfigs", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/servingConfigs", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. Full resource name of parent. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", "location": "path", "required": true, "type": "string" }, "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+/.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaServingConfig" }, "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaServingConfig" }, "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 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." }, "delete": { "id": "discoveryengine.projects.locations.dataStores.servingConfigs.delete", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}", "httpMethod": "DELETE", "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}`", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleProtobufEmpty" }, "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 ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist." }, "patch": { "id": "discoveryengine.projects.locations.dataStores.servingConfigs.patch", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}", "httpMethod": "PATCH", "parameters": { "name": { "description": "Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}`", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$", "location": "path", "required": true, "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.", "location": "query", "type": "string", "format": "google-fieldmask" } }, "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaServingConfig" }, "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaServingConfig" }, "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." }, "get": { "id": "discoveryengine.projects.locations.dataStores.servingConfigs.get", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}", "httpMethod": "GET", "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/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaServingConfig" }, "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 ServingConfig. Returns a NotFound error if the ServingConfig does not exist." }, "list": { "id": "discoveryengine.projects.locations.dataStores.servingConfigs.list", "path": "v1alpha/{+parent}/servingConfigs", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/servingConfigs", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. Full resource name of the parent resource. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "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", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse" }, "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." } } }, "models": { "resources": { "operations": { "methods": { "list": { "id": "discoveryengine.projects.locations.dataStores.models.operations.list", "path": "v1alpha/{+name}/operations", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/models/{modelsId}/operations", "httpMethod": "GET", "parameters": { "name": { "description": "The name of the operation's parent resource.", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/models/[^/]+$", "location": "path", "required": true, "type": "string" }, "filter": { "description": "The standard list filter.", "location": "query", "type": "string" }, "pageSize": { "description": "The standard list page size.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "The standard list page token.", "location": "query", "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.", "location": "query", "type": "boolean" } }, "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" ], "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`." }, "get": { "id": "discoveryengine.projects.locations.dataStores.models.operations.get", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/models/{modelsId}/operations/{operationsId}", "httpMethod": "GET", "parameters": { "name": { "description": "The name of the operation resource.", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/models/[^/]+/operations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "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" ], "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." } } } } }, "operations": { "methods": { "list": { "id": "discoveryengine.projects.locations.dataStores.operations.list", "path": "v1alpha/{+name}/operations", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/operations", "httpMethod": "GET", "parameters": { "name": { "description": "The name of the operation's parent resource.", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", "location": "path", "required": true, "type": "string" }, "filter": { "description": "The standard list filter.", "location": "query", "type": "string" }, "pageSize": { "description": "The standard list page size.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "The standard list page token.", "location": "query", "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.", "location": "query", "type": "boolean" } }, "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" ], "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`." }, "get": { "id": "discoveryengine.projects.locations.dataStores.operations.get", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/operations/{operationsId}", "httpMethod": "GET", "parameters": { "name": { "description": "The name of the operation resource.", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/operations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "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" ], "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." } } }, "branches": { "methods": { "list": { "id": "discoveryengine.projects.locations.dataStores.branches.list", "path": "v1alpha/{+parent}/branches", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The parent data store resource name.", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", "location": "path", "required": true, "type": "string" }, "view": { "description": "The view to apply to the returned Branch. Defaults to BranchView.BRANCH_VIEW_BASIC if unspecified.", "location": "query", "type": "string", "enumDescriptions": [ "The value when it's unspecified. This defaults to the BASIC view.", "Includes basic metadata about the branch, but not statistical fields. See documentation of individual fields of Branch to know what is excluded.", "Includes all fields of a Branch." ], "enum": [ "BRANCH_VIEW_UNSPECIFIED", "BRANCH_VIEW_BASIC", "BRANCH_VIEW_FULL" ] } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaListBranchesResponse" }, "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 Branchs under the specified parent DataStore." }, "get": { "id": "discoveryengine.projects.locations.dataStores.branches.get", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. The name of the branch to retrieve. Format: `projects/*/locations/global/dataStores/default_data_store/branches/some_branch_id`. \"default_branch\" can be used as a special branch_id, it returns the default branch that has been set for the document.", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+$", "location": "path", "required": true, "type": "string" }, "view": { "description": "The view to apply to the returned Branch. Defaults to BranchView.BRANCH_VIEW_BASIC if unspecified.", "location": "query", "type": "string", "enumDescriptions": [ "The value when it's unspecified. This defaults to the BASIC view.", "Includes basic metadata about the branch, but not statistical fields. See documentation of individual fields of Branch to know what is excluded.", "Includes all fields of a Branch." ], "enum": [ "BRANCH_VIEW_UNSPECIFIED", "BRANCH_VIEW_BASIC", "BRANCH_VIEW_FULL" ] } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaBranch" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "description": "Retrieves a Branch." }, "batchGetDocumentsMetadata": { "id": "discoveryengine.projects.locations.dataStores.branches.batchGetDocumentsMetadata", "path": "v1alpha/{+parent}/batchGetDocumentsMetadata", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/batchGetDocumentsMetadata", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+$", "location": "path", "required": true, "type": "string" }, "matcher.urisMatcher.uris": { "description": "The exact URIs to match by.", "location": "query", "repeated": true, "type": "string" }, "matcher.fhirMatcher.fhirResources": { "description": "Required. The FHIR resources to match by. Format: projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id}", "location": "query", "repeated": true, "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaBatchGetDocumentsMetadataResponse" }, "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." } }, "resources": { "operations": { "methods": { "list": { "id": "discoveryengine.projects.locations.dataStores.branches.operations.list", "path": "v1alpha/{+name}/operations", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/operations", "httpMethod": "GET", "parameters": { "name": { "description": "The name of the operation's parent resource.", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+$", "location": "path", "required": true, "type": "string" }, "filter": { "description": "The standard list filter.", "location": "query", "type": "string" }, "pageSize": { "description": "The standard list page size.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "The standard list page token.", "location": "query", "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.", "location": "query", "type": "boolean" } }, "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" ], "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`." }, "get": { "id": "discoveryengine.projects.locations.dataStores.branches.operations.get", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/operations/{operationsId}", "httpMethod": "GET", "parameters": { "name": { "description": "The name of the operation resource.", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+/operations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "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" ], "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." }, "cancel": { "id": "discoveryengine.projects.locations.dataStores.branches.operations.cancel", "path": "v1alpha/{+name}:cancel", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/operations/{operationsId}:cancel", "httpMethod": "POST", "parameters": { "name": { "description": "The name of the operation resource to be cancelled.", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+/operations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "request": { "$ref": "GoogleLongrunningCancelOperationRequest" }, "response": { "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "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`." } } }, "documents": { "methods": { "get": { "id": "discoveryengine.projects.locations.dataStores.branches.documents.get", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents/{documentsId}", "httpMethod": "GET", "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.", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+/documents/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaDocument" }, "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 Document." }, "list": { "id": "discoveryengine.projects.locations.dataStores.branches.documents.list", "path": "v1alpha/{+parent}/documents", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents", "httpMethod": "GET", "parameters": { "parent": { "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.", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "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", "format": "int32" }, "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" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaListDocumentsResponse" }, "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 Documents." }, "create": { "id": "discoveryengine.projects.locations.dataStores.branches.documents.create", "path": "v1alpha/{+parent}/documents", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+$", "location": "path", "required": true, "type": "string" }, "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.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaDocument" }, "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaDocument" }, "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 Document." }, "patch": { "id": "discoveryengine.projects.locations.dataStores.branches.documents.patch", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents/{documentsId}", "httpMethod": "PATCH", "parameters": { "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.", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+/documents/[^/]+$", "location": "path", "required": true, "type": "string" }, "allowMissing": { "description": "If set to `true` and the Document is not found, a new Document is be created.", "location": "query", "type": "boolean" }, "updateMask": { "description": "Indicates which fields in the provided imported 'document' to update. If not set, by default updates all fields.", "location": "query", "type": "string", "format": "google-fieldmask" } }, "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaDocument" }, "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaDocument" }, "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 Document." }, "delete": { "id": "discoveryengine.projects.locations.dataStores.branches.documents.delete", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents/{documentsId}", "httpMethod": "DELETE", "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 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/[^/]+/dataStores/[^/]+/branches/[^/]+/documents/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleProtobufEmpty" }, "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 Document." }, "import": { "id": "discoveryengine.projects.locations.dataStores.branches.documents.import", "path": "v1alpha/{+parent}/documents:import", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents:import", "httpMethod": "POST", "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.", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaImportDocumentsRequest" }, "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": "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." }, "purge": { "id": "discoveryengine.projects.locations.dataStores.branches.documents.purge", "path": "v1alpha/{+parent}/documents:purge", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents:purge", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaPurgeDocumentsRequest" }, "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": "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." }, "getProcessedDocument": { "id": "discoveryengine.projects.locations.dataStores.branches.documents.getProcessedDocument", "path": "v1alpha/{+name}:getProcessedDocument", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents/{documentsId}:getProcessedDocument", "httpMethod": "GET", "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.", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+/documents/[^/]+$", "location": "path", "required": true, "type": "string" }, "processedDocumentType": { "description": "Required. What type of processing to return.", "location": "query", "type": "string", "enumDescriptions": [ "Default value.", "Available for all data store parsing configs.", "Only available if ChunkingConfig is enabled on the data store.", "Returns the converted Image bytes (as JPEG or PNG) if available.", "Return image bytes in base64 encoded format if image_id of a document is provided, only supported for enabling shareholder-structure in layout parsing config for now." ], "enum": [ "PROCESSED_DOCUMENT_TYPE_UNSPECIFIED", "PARSED_DOCUMENT", "CHUNKED_DOCUMENT", "IMAGE_CONVERTED_DOCUMENT", "IMAGE_BYTES" ] }, "processedDocumentFormat": { "description": "What format output should be. If unspecified, defaults to JSON.", "location": "query", "type": "string", "enumDescriptions": [ "Default value.", "Output format is a JSON string representation of processed document." ], "enum": [ "PROCESSED_DOCUMENT_FORMAT_UNSPECIFIED", "JSON" ] }, "imageId": { "description": "Optional. Specifies config for IMAGE_BYTES.", "location": "query", "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaProcessedDocument" }, "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 parsed layout information for a Document." } }, "resources": { "chunks": { "methods": { "get": { "id": "discoveryengine.projects.locations.dataStores.branches.documents.chunks.get", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents/{documentsId}/chunks/{chunksId}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. Full resource name of Chunk, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}/chunks/{chunk}`. If the caller does not have permission to access the Chunk, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the requested Chunk does not exist, a `NOT_FOUND` error is returned.", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+/documents/[^/]+/chunks/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaChunk" }, "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 Document." }, "list": { "id": "discoveryengine.projects.locations.dataStores.branches.documents.chunks.list", "path": "v1alpha/{+parent}/chunks", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents/{documentsId}/chunks", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The parent document resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`. If the caller does not have permission to list Chunks under this document, regardless of whether or not this document exists, a `PERMISSION_DENIED` error is returned.", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+/documents/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "Maximum number of Chunks to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "A page token ListChunksResponse.next_page_token, received from a previous ChunkService.ListChunks call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ChunkService.ListChunks must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaListChunksResponse" }, "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 Chunks." } } } } } } }, "completionConfig": { "methods": { "completeQuery": { "id": "discoveryengine.projects.locations.dataStores.completionConfig.completeQuery", "path": "v1alpha/{+completionConfig}:completeQuery", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/completionConfig:completeQuery", "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`.", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/completionConfig$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "completionConfig" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryRequest" }, "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryResponse" }, "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" ], "description": "Completes the user input with advanced keyword suggestions." } } }, "suggestionDenyListEntries": { "methods": { "import": { "id": "discoveryengine.projects.locations.dataStores.suggestionDenyListEntries.import", "path": "v1alpha/{+parent}/suggestionDenyListEntries:import", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/suggestionDenyListEntries:import", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The parent data store resource name for which to import denylist entries. Follows pattern projects/*/locations/*/collections/*/dataStores/*.", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesRequest" }, "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": "Imports all SuggestionDenyListEntry for a DataStore." }, "purge": { "id": "discoveryengine.projects.locations.dataStores.suggestionDenyListEntries.purge", "path": "v1alpha/{+parent}/suggestionDenyListEntries:purge", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/suggestionDenyListEntries:purge", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The parent data store resource name for which to import denylist entries. Follows pattern projects/*/locations/*/collections/*/dataStores/*.", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/.*$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesRequest" }, "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 SuggestionDenyListEntry for a DataStore." } } }, "completionSuggestions": { "methods": { "import": { "id": "discoveryengine.projects.locations.dataStores.completionSuggestions.import", "path": "v1alpha/{+parent}/completionSuggestions:import", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/completionSuggestions:import", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The parent data store resource name for which to import customer autocomplete suggestions. Follows pattern `projects/*/locations/*/collections/*/dataStores/*`", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsRequest" }, "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": "Imports CompletionSuggestions for a DataStore." }, "purge": { "id": "discoveryengine.projects.locations.dataStores.completionSuggestions.purge", "path": "v1alpha/{+parent}/completionSuggestions:purge", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/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/*.", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsRequest" }, "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." } } }, "controls": { "methods": { "create": { "id": "discoveryengine.projects.locations.dataStores.controls.create", "path": "v1alpha/{+parent}/controls", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/controls", "httpMethod": "POST", "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}`.", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", "location": "path", "required": true, "type": "string" }, "controlId": { "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", "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaControl" }, "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaControl" }, "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 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." }, "delete": { "id": "discoveryengine.projects.locations.dataStores.controls.delete", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/controls/{controlsId}", "httpMethod": "DELETE", "parameters": { "name": { "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/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleProtobufEmpty" }, "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 Control. If the Control to delete does not exist, a NOT_FOUND error is returned." }, "patch": { "id": "discoveryengine.projects.locations.dataStores.controls.patch", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/controls/{controlsId}", "httpMethod": "PATCH", "parameters": { "name": { "description": "Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*`", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/controls/[^/]+$", "location": "path", "required": true, "type": "string" }, "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" } }, "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaControl" }, "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaControl" }, "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." }, "get": { "id": "discoveryengine.projects.locations.dataStores.controls.get", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/controls/{controlsId}", "httpMethod": "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}`", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/controls/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaControl" }, "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 Control." }, "list": { "id": "discoveryengine.projects.locations.dataStores.controls.list", "path": "v1alpha/{+parent}/controls", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/controls", "httpMethod": "GET", "parameters": { "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/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.", "location": "query", "type": "integer", "format": "int32" }, "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.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaListControlsResponse" }, "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 Controls by their parent DataStore." } } }, "conversations": { "methods": { "converse": { "id": "discoveryengine.projects.locations.dataStores.conversations.converse", "path": "v1alpha/{+name}:converse", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/conversations/{conversationsId}:converse", "httpMethod": "POST", "parameters": { "name": { "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.", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/conversations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaConverseConversationRequest" }, "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaConverseConversationResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "description": "Converses a conversation." }, "create": { "id": "discoveryengine.projects.locations.dataStores.conversations.create", "path": "v1alpha/{+parent}/conversations", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/conversations", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. Full resource name of parent data store. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaConversation" }, "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaConversation" }, "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 Conversation. If the Conversation to create already exists, an ALREADY_EXISTS error is returned." }, "delete": { "id": "discoveryengine.projects.locations.dataStores.conversations.delete", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/conversations/{conversationsId}", "httpMethod": "DELETE", "parameters": { "name": { "description": "Required. The resource name of the Conversation to delete. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/conversations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleProtobufEmpty" }, "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." }, "patch": { "id": "discoveryengine.projects.locations.dataStores.conversations.patch", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/conversations/{conversationsId}", "httpMethod": "PATCH", "parameters": { "name": { "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/[^/]+/dataStores/[^/]+/conversations/[^/]+$", "location": "path", "required": true, "type": "string" }, "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.", "location": "query", "type": "string", "format": "google-fieldmask" } }, "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaConversation" }, "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaConversation" }, "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 Conversation. Conversation action type cannot be changed. If the Conversation to update does not exist, a NOT_FOUND error is returned." }, "get": { "id": "discoveryengine.projects.locations.dataStores.conversations.get", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/conversations/{conversationsId}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. The resource name of the Conversation to get. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/conversations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaConversation" }, "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." }, "list": { "id": "discoveryengine.projects.locations.dataStores.conversations.list", "path": "v1alpha/{+parent}/conversations", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/conversations", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The data store resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "A page token, received from a previous `ListConversations` call. Provide this to retrieve the subsequent page.", "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\"", "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" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaListConversationsResponse" }, "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 Conversations by their parent DataStore." } } }, "schemas": { "methods": { "get": { "id": "discoveryengine.projects.locations.dataStores.schemas.get", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/schemas/{schemasId}", "httpMethod": "GET", "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}`.", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/schemas/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaSchema" }, "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 Schema." }, "list": { "id": "discoveryengine.projects.locations.dataStores.schemas.list", "path": "v1alpha/{+parent}/schemas", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/schemas", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The parent data store resource name, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "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", "type": "integer", "format": "int32" }, "pageToken": { "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", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaListSchemasResponse" }, "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." }, "create": { "id": "discoveryengine.projects.locations.dataStores.schemas.create", "path": "v1alpha/{+parent}/schemas", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/schemas", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The parent data store resource name, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", "location": "path", "required": true, "type": "string" }, "schemaId": { "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.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaSchema" }, "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": "Creates a Schema." }, "patch": { "id": "discoveryengine.projects.locations.dataStores.schemas.patch", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/schemas/{schemasId}", "httpMethod": "PATCH", "parameters": { "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.", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/schemas/[^/]+$", "location": "path", "required": true, "type": "string" }, "allowMissing": { "description": "If set to true, and the Schema is not found, a new Schema is created. In this situation, `update_mask` is ignored.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaSchema" }, "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 Schema." }, "delete": { "id": "discoveryengine.projects.locations.dataStores.schemas.delete", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/schemas/{schemasId}", "httpMethod": "DELETE", "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}`.", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/schemas/[^/]+$", "location": "path", "required": true, "type": "string" } }, "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" ], "description": "Deletes a Schema." } } }, "sessions": { "methods": { "create": { "id": "discoveryengine.projects.locations.dataStores.sessions.create", "path": "v1alpha/{+parent}/sessions", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/sessions", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. Full resource name of parent data store. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", "location": "path", "required": true, "type": "string" }, "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" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaSession" }, "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaSession" }, "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." }, "delete": { "id": "discoveryengine.projects.locations.dataStores.sessions.delete", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/sessions/{sessionsId}", "httpMethod": "DELETE", "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}`", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/sessions/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "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" ], "description": "Deletes a Session. If the Session to delete does not exist, a NOT_FOUND error is returned." }, "patch": { "id": "discoveryengine.projects.locations.dataStores.sessions.patch", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/sessions/{sessionsId}", "httpMethod": "PATCH", "parameters": { "name": { "description": "Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*`", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/sessions/[^/]+$", "location": "path", "required": true, "type": "string" }, "updateMask": { "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.", "location": "query", "type": "string", "format": "google-fieldmask" } }, "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaSession" }, "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaSession" }, "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": "Updates a Session. Session action type cannot be changed. If the Session to update does not exist, a NOT_FOUND error is returned." }, "get": { "id": "discoveryengine.projects.locations.dataStores.sessions.get", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/sessions/{sessionsId}", "httpMethod": "GET", "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/[^/]+/dataStores/[^/]+/sessions/[^/]+$", "location": "path", "required": true, "type": "string" }, "includeAnswerDetails": { "description": "Optional. If set to true, the full session including all answer details will be returned.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaSession" }, "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 Session." }, "list": { "id": "discoveryengine.projects.locations.dataStores.sessions.list", "path": "v1alpha/{+parent}/sessions", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/sessions", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The data store resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page.", "location": "query", "type": "string" }, "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" }, "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` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaListSessionsResponse" }, "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": "Lists all Sessions by their parent DataStore." } }, "resources": { "answers": { "methods": { "get": { "id": "discoveryengine.projects.locations.dataStores.sessions.answers.get", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/sessions/{sessionsId}/answers/{answersId}", "httpMethod": "GET", "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/[^/]+/dataStores/[^/]+/sessions/[^/]+/answers/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaAnswer" }, "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." } } } } }, "siteSearchEngine": { "methods": { "enableAdvancedSiteSearch": { "id": "discoveryengine.projects.locations.dataStores.siteSearchEngine.enableAdvancedSiteSearch", "path": "v1alpha/{+siteSearchEngine}:enableAdvancedSiteSearch", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine:enableAdvancedSiteSearch", "httpMethod": "POST", "parameters": { "siteSearchEngine": { "description": "Required. Full resource name of the SiteSearchEngine, such as `projects/{project}/locations/{location}/dataStores/{data_store_id}/siteSearchEngine`.", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/siteSearchEngine$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "siteSearchEngine" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchRequest" }, "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": "Upgrade from basic site search to advanced site search." }, "disableAdvancedSiteSearch": { "id": "discoveryengine.projects.locations.dataStores.siteSearchEngine.disableAdvancedSiteSearch", "path": "v1alpha/{+siteSearchEngine}:disableAdvancedSiteSearch", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine:disableAdvancedSiteSearch", "httpMethod": "POST", "parameters": { "siteSearchEngine": { "description": "Required. Full resource name of the SiteSearchEngine, such as `projects/{project}/locations/{location}/dataStores/{data_store_id}/siteSearchEngine`.", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/siteSearchEngine$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "siteSearchEngine" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchRequest" }, "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": "Downgrade from advanced site search to basic site search." }, "recrawlUris": { "id": "discoveryengine.projects.locations.dataStores.siteSearchEngine.recrawlUris", "path": "v1alpha/{+siteSearchEngine}:recrawlUris", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine:recrawlUris", "httpMethod": "POST", "parameters": { "siteSearchEngine": { "description": "Required. Full resource name of the SiteSearchEngine, such as `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine`.", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/siteSearchEngine$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "siteSearchEngine" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisRequest" }, "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": "Request on-demand recrawl for a list of URIs." } }, "resources": { "targetSites": { "methods": { "create": { "id": "discoveryengine.projects.locations.dataStores.siteSearchEngine.targetSites.create", "path": "v1alpha/{+parent}/targetSites", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine/targetSites", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. Parent resource name of TargetSite, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`.", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/siteSearchEngine$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaTargetSite" }, "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": "Creates a TargetSite." }, "batchCreate": { "id": "discoveryengine.projects.locations.dataStores.siteSearchEngine.targetSites.batchCreate", "path": "v1alpha/{+parent}/targetSites:batchCreate", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine/targetSites:batchCreate", "httpMethod": "POST", "parameters": { "parent": { "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.", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/siteSearchEngine$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesRequest" }, "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": "Creates TargetSite in a batch." }, "get": { "id": "discoveryengine.projects.locations.dataStores.siteSearchEngine.targetSites.get", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine/targetSites/{targetSitesId}", "httpMethod": "GET", "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.", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/siteSearchEngine/targetSites/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaTargetSite" }, "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 TargetSite." }, "patch": { "id": "discoveryengine.projects.locations.dataStores.siteSearchEngine.targetSites.patch", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine/targetSites/{targetSitesId}", "httpMethod": "PATCH", "parameters": { "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.", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/siteSearchEngine/targetSites/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaTargetSite" }, "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." }, "delete": { "id": "discoveryengine.projects.locations.dataStores.siteSearchEngine.targetSites.delete", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine/targetSites/{targetSitesId}", "httpMethod": "DELETE", "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.", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/siteSearchEngine/targetSites/[^/]+$", "location": "path", "required": true, "type": "string" } }, "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" ], "description": "Deletes a TargetSite." }, "list": { "id": "discoveryengine.projects.locations.dataStores.siteSearchEngine.targetSites.list", "path": "v1alpha/{+parent}/targetSites", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine/targetSites", "httpMethod": "GET", "parameters": { "parent": { "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.", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/siteSearchEngine$", "location": "path", "required": true, "type": "string" }, "pageSize": { "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.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "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.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaListTargetSitesResponse" }, "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 TargetSites." } } }, "sitemaps": { "methods": { "create": { "id": "discoveryengine.projects.locations.dataStores.siteSearchEngine.sitemaps.create", "path": "v1alpha/{+parent}/sitemaps", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine/sitemaps", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. Parent resource name of the SiteSearchEngine, such as `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine`.", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/siteSearchEngine$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaSitemap" }, "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": "Creates a Sitemap." }, "delete": { "id": "discoveryengine.projects.locations.dataStores.siteSearchEngine.sitemaps.delete", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine/sitemaps/{sitemapsId}", "httpMethod": "DELETE", "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/[^/]+/dataStores/[^/]+/siteSearchEngine/sitemaps/[^/]+$", "location": "path", "required": true, "type": "string" } }, "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" ], "description": "Deletes a Sitemap." }, "fetch": { "id": "discoveryengine.projects.locations.dataStores.siteSearchEngine.sitemaps.fetch", "path": "v1alpha/{+parent}/sitemaps:fetch", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine/sitemaps:fetch", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. Parent resource name of the SiteSearchEngine, such as `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine`.", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/siteSearchEngine$", "location": "path", "required": true, "type": "string" }, "matcher.urisMatcher.uris": { "description": "The Sitemap uris.", "location": "query", "repeated": true, "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "description": "Fetch Sitemaps in a DataStore." } } } } }, "userEvents": { "methods": { "write": { "id": "discoveryengine.projects.locations.dataStores.userEvents.write", "path": "v1alpha/{+parent}/userEvents:write", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/userEvents:write", "httpMethod": "POST", "parameters": { "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}`.", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", "location": "path", "required": true, "type": "string" }, "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" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaUserEvent" }, "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaUserEvent" }, "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": "Writes a single user event." }, "collect": { "id": "discoveryengine.projects.locations.dataStores.userEvents.collect", "path": "v1alpha/{+parent}/userEvents:collect", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/userEvents:collect", "httpMethod": "GET", "parameters": { "parent": { "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/[^/]+/dataStores/[^/]+$", "location": "path", "required": true, "type": "string" }, "userEvent": { "description": "Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters.", "location": "query", "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.", "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.", "location": "query", "type": "string", "format": "int64" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleApiHttpBody" }, "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": "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." }, "purge": { "id": "discoveryengine.projects.locations.dataStores.userEvents.purge", "path": "v1alpha/{+parent}/userEvents:purge", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/userEvents:purge", "httpMethod": "POST", "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}`.", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaPurgeUserEventsRequest" }, "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": "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." }, "import": { "id": "discoveryengine.projects.locations.dataStores.userEvents.import", "path": "v1alpha/{+parent}/userEvents:import", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/userEvents:import", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. Parent DataStore resource name, of the form `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaImportUserEventsRequest" }, "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": "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." } } }, "widgetConfigs": { "methods": { "get": { "id": "discoveryengine.projects.locations.dataStores.widgetConfigs.get", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/widgetConfigs/{widgetConfigsId}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. Full WidgetConfig resource name. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/widgetConfigs/{widget_config_id}`", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/widgetConfigs/[^/]+$", "location": "path", "required": true, "type": "string" }, "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.", "location": "query", "type": "boolean" }, "getWidgetConfigRequestOption.turnOffCollectionComponents": { "description": "Optional. Whether to turn off collection_components in WidgetConfig to reduce latency and data transmission.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaWidgetConfig" }, "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." }, "patch": { "id": "discoveryengine.projects.locations.dataStores.widgetConfigs.patch", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/widgetConfigs/{widgetConfigsId}", "httpMethod": "PATCH", "parameters": { "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.", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/widgetConfigs/[^/]+$", "location": "path", "required": true, "type": "string" }, "updateMask": { "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", "type": "string", "format": "google-fieldmask" } }, "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaWidgetConfig" }, "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaWidgetConfig" }, "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": "Update a WidgetConfig." } } } } }, "evaluations": { "methods": { "get": { "id": "discoveryengine.projects.locations.evaluations.get", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/evaluations/{evaluationsId}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. Full resource name of Evaluation, such as `projects/{project}/locations/{location}/evaluations/{evaluation}`. If the caller does not have permission to access the Evaluation, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested Evaluation does not exist, a NOT_FOUND error is returned.", "pattern": "^projects/[^/]+/locations/[^/]+/evaluations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaEvaluation" }, "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 Evaluation." }, "list": { "id": "discoveryengine.projects.locations.evaluations.list", "path": "v1alpha/{+parent}/evaluations", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/evaluations", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The parent location resource name, such as `projects/{project}/locations/{location}`. If the caller does not have permission to list Evaluations under this location, regardless of whether or not this location exists, a `PERMISSION_DENIED` error is returned.", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "Optional. Maximum number of Evaluations to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. A page token ListEvaluationsResponse.next_page_token, received from a previous EvaluationService.ListEvaluations call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to EvaluationService.ListEvaluations must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaListEvaluationsResponse" }, "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 Evaluations." }, "create": { "id": "discoveryengine.projects.locations.evaluations.create", "path": "v1alpha/{+parent}/evaluations", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/evaluations", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The parent resource name, such as `projects/{project}/locations/{location}`.", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaEvaluation" }, "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": "Creates a Evaluation. Upon creation, the evaluation will be automatically triggered and begin execution." }, "listResults": { "id": "discoveryengine.projects.locations.evaluations.listResults", "path": "v1alpha/{+evaluation}:listResults", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/evaluations/{evaluationsId}:listResults", "httpMethod": "GET", "parameters": { "evaluation": { "description": "Required. The evaluation resource name, such as `projects/{project}/locations/{location}/evaluations/{evaluation}`. If the caller does not have permission to list ListEvaluationResultsResponse.EvaluationResult under this evaluation, regardless of whether or not this evaluation set exists, a `PERMISSION_DENIED` error is returned.", "pattern": "^projects/[^/]+/locations/[^/]+/evaluations/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "Optional. Maximum number of ListEvaluationResultsResponse.EvaluationResult to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. A page token ListEvaluationResultsResponse.next_page_token, received from a previous EvaluationService.ListEvaluationResults call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to EvaluationService.ListEvaluationResults must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.", "location": "query", "type": "string" } }, "parameterOrder": [ "evaluation" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaListEvaluationResultsResponse" }, "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 results for a given a Evaluation." } }, "resources": { "operations": { "methods": { "get": { "id": "discoveryengine.projects.locations.evaluations.operations.get", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/evaluations/{evaluationsId}/operations/{operationsId}", "httpMethod": "GET", "parameters": { "name": { "description": "The name of the operation resource.", "pattern": "^projects/[^/]+/locations/[^/]+/evaluations/[^/]+/operations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "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" ], "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." } } } } }, "identityMappingStores": { "methods": { "create": { "id": "discoveryengine.projects.locations.identityMappingStores.create", "path": "v1alpha/{+parent}/identityMappingStores", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/identityMappingStores", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The parent collection resource name, such as `projects/{project}/locations/{location}`.", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" }, "cmekConfigName": { "description": "Resource name of the CmekConfig to use for protecting this Identity Mapping Store.", "location": "query", "type": "string" }, "disableCmek": { "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.", "location": "query", "type": "boolean" }, "identityMappingStoreId": { "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.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaIdentityMappingStore" }, "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaIdentityMappingStore" }, "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 new Identity Mapping Store." }, "get": { "id": "discoveryengine.projects.locations.identityMappingStores.get", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/identityMappingStores/{identityMappingStoresId}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. The name of the Identity Mapping Store to get. Format: `projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}`", "pattern": "^projects/[^/]+/locations/[^/]+/identityMappingStores/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaIdentityMappingStore" }, "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 Identity Mapping Store." }, "delete": { "id": "discoveryengine.projects.locations.identityMappingStores.delete", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/identityMappingStores/{identityMappingStoresId}", "httpMethod": "DELETE", "parameters": { "name": { "description": "Required. The name of the Identity Mapping Store to delete. Format: `projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}`", "pattern": "^projects/[^/]+/locations/[^/]+/identityMappingStores/[^/]+$", "location": "path", "required": true, "type": "string" } }, "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" ], "description": "Deletes the Identity Mapping Store." }, "importIdentityMappings": { "id": "discoveryengine.projects.locations.identityMappingStores.importIdentityMappings", "path": "v1alpha/{+identityMappingStore}:importIdentityMappings", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/identityMappingStores/{identityMappingStoresId}: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}`", "pattern": "^projects/[^/]+/locations/[^/]+/identityMappingStores/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "identityMappingStore" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaImportIdentityMappingsRequest" }, "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": "Imports a list of Identity Mapping Entries to an Identity Mapping Store." }, "purgeIdentityMappings": { "id": "discoveryengine.projects.locations.identityMappingStores.purgeIdentityMappings", "path": "v1alpha/{+identityMappingStore}:purgeIdentityMappings", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/identityMappingStores/{identityMappingStoresId}:purgeIdentityMappings", "httpMethod": "POST", "parameters": { "identityMappingStore": { "description": "Required. The name of the Identity Mapping Store to purge Identity Mapping Entries from. Format: `projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}`", "pattern": "^projects/[^/]+/locations/[^/]+/identityMappingStores/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "identityMappingStore" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaPurgeIdentityMappingsRequest" }, "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": "Purges specified or all Identity Mapping Entries from an Identity Mapping Store." }, "listIdentityMappings": { "id": "discoveryengine.projects.locations.identityMappingStores.listIdentityMappings", "path": "v1alpha/{+identityMappingStore}:listIdentityMappings", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/identityMappingStores/{identityMappingStoresId}:listIdentityMappings", "httpMethod": "GET", "parameters": { "identityMappingStore": { "description": "Required. The name of the Identity Mapping Store to list Identity Mapping Entries in. Format: `projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}`", "pattern": "^projects/[^/]+/locations/[^/]+/identityMappingStores/[^/]+$", "location": "path", "required": true, "type": "string" }, "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.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "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.", "location": "query", "type": "string" } }, "parameterOrder": [ "identityMappingStore" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaListIdentityMappingsResponse" }, "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 Identity Mappings in an Identity Mapping Store." }, "list": { "id": "discoveryengine.projects.locations.identityMappingStores.list", "path": "v1alpha/{+parent}/identityMappingStores", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/identityMappingStores", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The parent of the Identity Mapping Stores to list. Format: `projects/{project}/locations/{location}`.", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "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.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "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.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaListIdentityMappingStoresResponse" }, "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 Identity Mapping Stores." } }, "resources": { "operations": { "methods": { "list": { "id": "discoveryengine.projects.locations.identityMappingStores.operations.list", "path": "v1alpha/{+name}/operations", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/identityMappingStores/{identityMappingStoresId}/operations", "httpMethod": "GET", "parameters": { "name": { "description": "The name of the operation's parent resource.", "pattern": "^projects/[^/]+/locations/[^/]+/identityMappingStores/[^/]+$", "location": "path", "required": true, "type": "string" }, "filter": { "description": "The standard list filter.", "location": "query", "type": "string" }, "pageSize": { "description": "The standard list page size.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "The standard list page token.", "location": "query", "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.", "location": "query", "type": "boolean" } }, "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" ], "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`." }, "get": { "id": "discoveryengine.projects.locations.identityMappingStores.operations.get", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/identityMappingStores/{identityMappingStoresId}/operations/{operationsId}", "httpMethod": "GET", "parameters": { "name": { "description": "The name of the operation resource.", "pattern": "^projects/[^/]+/locations/[^/]+/identityMappingStores/[^/]+/operations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "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" ], "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." } } } } }, "licenseConfigs": { "methods": { "create": { "id": "discoveryengine.projects.locations.licenseConfigs.create", "path": "v1alpha/{+parent}/licenseConfigs", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/licenseConfigs", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The parent resource name, such as `projects/{project}/locations/{location}`.", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" }, "licenseConfigId": { "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`.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaLicenseConfig" }, "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaLicenseConfig" }, "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 LicenseConfig This method should only be used for creating NotebookLm licenses or Gemini Enterprise free trial licenses." }, "patch": { "id": "discoveryengine.projects.locations.licenseConfigs.patch", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/licenseConfigs/{licenseConfigsId}", "httpMethod": "PATCH", "parameters": { "name": { "description": "Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project}/locations/{location}/licenseConfigs/{license_config}`", "pattern": "^projects/[^/]+/locations/[^/]+/licenseConfigs/[^/]+$", "location": "path", "required": true, "type": "string" }, "updateMask": { "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.", "location": "query", "type": "string", "format": "google-fieldmask" } }, "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaLicenseConfig" }, "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaLicenseConfig" }, "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 LicenseConfig" }, "get": { "id": "discoveryengine.projects.locations.licenseConfigs.get", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/licenseConfigs/{licenseConfigsId}", "httpMethod": "GET", "parameters": { "name": { "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.", "pattern": "^projects/[^/]+/locations/[^/]+/licenseConfigs/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaLicenseConfig" }, "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." }, "list": { "id": "discoveryengine.projects.locations.licenseConfigs.list", "path": "v1alpha/{+parent}/licenseConfigs", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/licenseConfigs", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The parent branch resource name, such as `projects/{project}/locations/{location}`.", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "Optional. Not supported.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. Not supported.", "location": "query", "type": "string" }, "filter": { "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.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaListLicenseConfigsResponse" }, "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 LicenseConfigs associated with the project." } } }, "rankingConfigs": { "methods": { "rank": { "id": "discoveryengine.projects.locations.rankingConfigs.rank", "path": "v1alpha/{+rankingConfig}:rank", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/rankingConfigs/{rankingConfigsId}:rank", "httpMethod": "POST", "parameters": { "rankingConfig": { "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/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "rankingConfig" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaRankRequest" }, "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaRankResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "description": "Ranks a list of text records based on the given input query." } } }, "requirements": { "methods": { "checkRequirement": { "id": "discoveryengine.projects.locations.requirements.checkRequirement", "path": "v1alpha/{+location}/requirements:checkRequirement", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/requirements:checkRequirement", "httpMethod": "POST", "parameters": { "location": { "description": "Required. Full resource name of the location. Format `projects/{project_number_or_id}/locations/{location}`", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "location" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaCheckRequirementRequest" }, "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaCheckRequirementResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ], "description": "Check a particular requirement." } } }, "sampleQuerySets": { "methods": { "get": { "id": "discoveryengine.projects.locations.sampleQuerySets.get", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. Full resource name of SampleQuerySet, such as `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}`. If the caller does not have permission to access the SampleQuerySet, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested SampleQuerySet does not exist, a NOT_FOUND error is returned.", "pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaSampleQuerySet" }, "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 SampleQuerySet." }, "list": { "id": "discoveryengine.projects.locations.sampleQuerySets.list", "path": "v1alpha/{+parent}/sampleQuerySets", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/sampleQuerySets", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The parent location resource name, such as `projects/{project}/locations/{location}`. If the caller does not have permission to list SampleQuerySets under this location, regardless of whether or not this location exists, a `PERMISSION_DENIED` error is returned.", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "Maximum number of SampleQuerySets to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "A page token ListSampleQuerySetsResponse.next_page_token, received from a previous SampleQuerySetService.ListSampleQuerySets call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SampleQuerySetService.ListSampleQuerySets must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaListSampleQuerySetsResponse" }, "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 SampleQuerySets." }, "create": { "id": "discoveryengine.projects.locations.sampleQuerySets.create", "path": "v1alpha/{+parent}/sampleQuerySets", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/sampleQuerySets", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The parent resource name, such as `projects/{project}/locations/{location}`.", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" }, "sampleQuerySetId": { "description": "Required. The ID to use for the SampleQuerySet, which will become the final component of the SampleQuerySet.name. If the caller does not have permission to create the SampleQuerySet, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all SampleQuerySets 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 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaSampleQuerySet" }, "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaSampleQuerySet" }, "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 SampleQuerySet" }, "patch": { "id": "discoveryengine.projects.locations.sampleQuerySets.patch", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}", "httpMethod": "PATCH", "parameters": { "name": { "description": "Identifier. The full resource name of the SampleQuerySet, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", "pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+$", "location": "path", "required": true, "type": "string" }, "updateMask": { "description": "Indicates which fields in the provided imported 'sample query set' to update. If not set, will by default update all fields.", "location": "query", "type": "string", "format": "google-fieldmask" } }, "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaSampleQuerySet" }, "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaSampleQuerySet" }, "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 SampleQuerySet." }, "delete": { "id": "discoveryengine.projects.locations.sampleQuerySets.delete", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}", "httpMethod": "DELETE", "parameters": { "name": { "description": "Required. Full resource name of SampleQuerySet, such as `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}`. If the caller does not have permission to delete the SampleQuerySet, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the SampleQuerySet to delete does not exist, a `NOT_FOUND` error is returned.", "pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleProtobufEmpty" }, "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 SampleQuerySet." } }, "resources": { "operations": { "methods": { "get": { "id": "discoveryengine.projects.locations.sampleQuerySets.operations.get", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}/operations/{operationsId}", "httpMethod": "GET", "parameters": { "name": { "description": "The name of the operation resource.", "pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+/operations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "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" ], "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." } } }, "sampleQueries": { "methods": { "get": { "id": "discoveryengine.projects.locations.sampleQuerySets.sampleQueries.get", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}/sampleQueries/{sampleQueriesId}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. Full resource name of SampleQuery, such as `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}`. If the caller does not have permission to access the SampleQuery, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested SampleQuery does not exist, a NOT_FOUND error is returned.", "pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+/sampleQueries/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaSampleQuery" }, "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 SampleQuery." }, "list": { "id": "discoveryengine.projects.locations.sampleQuerySets.sampleQueries.list", "path": "v1alpha/{+parent}/sampleQueries", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}/sampleQueries", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The parent sample query set resource name, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. If the caller does not have permission to list SampleQuerys under this sample query set, regardless of whether or not this sample query set exists, a `PERMISSION_DENIED` error is returned.", "pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "Maximum number of SampleQuerys to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "A page token ListSampleQueriesResponse.next_page_token, received from a previous SampleQueryService.ListSampleQueries call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SampleQueryService.ListSampleQueries must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaListSampleQueriesResponse" }, "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 SampleQuerys." }, "create": { "id": "discoveryengine.projects.locations.sampleQuerySets.sampleQueries.create", "path": "v1alpha/{+parent}/sampleQueries", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}/sampleQueries", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The parent resource name, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.", "pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+$", "location": "path", "required": true, "type": "string" }, "sampleQueryId": { "description": "Required. The ID to use for the SampleQuery, which will become the final component of the SampleQuery.name. If the caller does not have permission to create the SampleQuery, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all SampleQuerys 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 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaSampleQuery" }, "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaSampleQuery" }, "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 SampleQuery" }, "patch": { "id": "discoveryengine.projects.locations.sampleQuerySets.sampleQueries.patch", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}/sampleQueries/{sampleQueriesId}", "httpMethod": "PATCH", "parameters": { "name": { "description": "Identifier. The full resource name of the sample query, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", "pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+/sampleQueries/[^/]+$", "location": "path", "required": true, "type": "string" }, "updateMask": { "description": "Indicates which fields in the provided imported 'simple query' to update. If not set, will by default update all fields.", "location": "query", "type": "string", "format": "google-fieldmask" } }, "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaSampleQuery" }, "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaSampleQuery" }, "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 SampleQuery." }, "delete": { "id": "discoveryengine.projects.locations.sampleQuerySets.sampleQueries.delete", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}/sampleQueries/{sampleQueriesId}", "httpMethod": "DELETE", "parameters": { "name": { "description": "Required. Full resource name of SampleQuery, such as `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}`. If the caller does not have permission to delete the SampleQuery, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the SampleQuery to delete does not exist, a `NOT_FOUND` error is returned.", "pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+/sampleQueries/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleProtobufEmpty" }, "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 SampleQuery." }, "import": { "id": "discoveryengine.projects.locations.sampleQuerySets.sampleQueries.import", "path": "v1alpha/{+parent}/sampleQueries:import", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}/sampleQueries:import", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The parent sample query set resource name, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. If the caller does not have permission to list SampleQuerys under this sample query set, regardless of whether or not this sample query set exists, a `PERMISSION_DENIED` error is returned.", "pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaImportSampleQueriesRequest" }, "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": "Bulk import of multiple SampleQuerys. Sample queries that already exist may be deleted. Note: It is possible for a subset of the SampleQuerys to be successfully imported." } } } } }, "userEvents": { "methods": { "write": { "id": "discoveryengine.projects.locations.userEvents.write", "path": "v1alpha/{+parent}/userEvents:write", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/userEvents:write", "httpMethod": "POST", "parameters": { "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}`.", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" }, "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" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaUserEvent" }, "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaUserEvent" }, "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": "Writes a single user event." }, "collect": { "id": "discoveryengine.projects.locations.userEvents.collect", "path": "v1alpha/{+parent}/userEvents:collect", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/userEvents:collect", "httpMethod": "GET", "parameters": { "parent": { "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/[^/]+$", "location": "path", "required": true, "type": "string" }, "userEvent": { "description": "Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters.", "location": "query", "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.", "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.", "location": "query", "type": "string", "format": "int64" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleApiHttpBody" }, "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": "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." }, "import": { "id": "discoveryengine.projects.locations.userEvents.import", "path": "v1alpha/{+parent}/userEvents:import", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/userEvents:import", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. Parent DataStore resource name, of the form `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaImportUserEventsRequest" }, "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": "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." } } }, "userStores": { "methods": { "batchUpdateUserLicenses": { "id": "discoveryengine.projects.locations.userStores.batchUpdateUserLicenses", "path": "v1alpha/{+parent}:batchUpdateUserLicenses", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/userStores/{userStoresId}:batchUpdateUserLicenses", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The parent UserStore resource name, format: `projects/{project}/locations/{location}/userStores/{user_store_id}`.", "pattern": "^projects/[^/]+/locations/[^/]+/userStores/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaBatchUpdateUserLicensesRequest" }, "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 the User License. This method is used for batch assign/unassign licenses to users." }, "get": { "id": "discoveryengine.projects.locations.userStores.get", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/userStores/{userStoresId}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. The name of the User Store to get. Format: `projects/{project}/locations/{location}/userStores/{user_store_id}`", "pattern": "^projects/[^/]+/locations/[^/]+/userStores/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaUserStore" }, "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 User Store." }, "patch": { "id": "discoveryengine.projects.locations.userStores.patch", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/userStores/{userStoresId}", "httpMethod": "PATCH", "parameters": { "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.", "pattern": "^projects/[^/]+/locations/[^/]+/userStores/[^/]+$", "location": "path", "required": true, "type": "string" }, "updateMask": { "description": "Optional. The list of fields to update.", "location": "query", "type": "string", "format": "google-fieldmask" } }, "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudDiscoveryengineV1alphaUserStore" }, "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaUserStore" }, "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." } }, "resources": { "operations": { "methods": { "list": { "id": "discoveryengine.projects.locations.userStores.operations.list", "path": "v1alpha/{+name}/operations", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/userStores/{userStoresId}/operations", "httpMethod": "GET", "parameters": { "name": { "description": "The name of the operation's parent resource.", "pattern": "^projects/[^/]+/locations/[^/]+/userStores/[^/]+$", "location": "path", "required": true, "type": "string" }, "filter": { "description": "The standard list filter.", "location": "query", "type": "string" }, "pageSize": { "description": "The standard list page size.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "The standard list page token.", "location": "query", "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.", "location": "query", "type": "boolean" } }, "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" ], "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`." }, "get": { "id": "discoveryengine.projects.locations.userStores.operations.get", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/userStores/{userStoresId}/operations/{operationsId}", "httpMethod": "GET", "parameters": { "name": { "description": "The name of the operation resource.", "pattern": "^projects/[^/]+/locations/[^/]+/userStores/[^/]+/operations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "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" ], "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." } } }, "userLicenses": { "methods": { "list": { "id": "discoveryengine.projects.locations.userStores.userLicenses.list", "path": "v1alpha/{+parent}/userLicenses", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/userStores/{userStoresId}/userLicenses", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The parent UserStore resource name, format: `projects/{project}/locations/{location}/userStores/{user_store_id}`.", "pattern": "^projects/[^/]+/locations/[^/]+/userStores/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, defaults to 10. The maximum value is 50; values above 50 will be coerced to 50. If this field is negative, an INVALID_ARGUMENT error is returned.", "location": "query", "type": "integer", "format": "int32" }, "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.", "location": "query", "type": "string" }, "filter": { "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`.", "location": "query", "type": "string" }, "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.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaListUserLicensesResponse" }, "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 the User Licenses." } } }, "licenseConfigsUsageStats": { "methods": { "list": { "id": "discoveryengine.projects.locations.userStores.licenseConfigsUsageStats.list", "path": "v1alpha/{+parent}/licenseConfigsUsageStats", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/userStores/{userStoresId}/licenseConfigsUsageStats", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The parent branch resource name, such as `projects/{project}/locations/{location}/userStores/{user_store_id}`.", "pattern": "^projects/[^/]+/locations/[^/]+/userStores/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaListLicenseConfigsUsageStatsResponse" }, "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." } } } } } } }, "operations": { "methods": { "list": { "id": "discoveryengine.projects.operations.list", "path": "v1alpha/{+name}/operations", "flatPath": "v1alpha/projects/{projectsId}/operations", "httpMethod": "GET", "parameters": { "name": { "description": "The name of the operation's parent resource.", "pattern": "^projects/[^/]+$", "location": "path", "required": true, "type": "string" }, "filter": { "description": "The standard list filter.", "location": "query", "type": "string" }, "pageSize": { "description": "The standard list page size.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "The standard list page token.", "location": "query", "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.", "location": "query", "type": "boolean" } }, "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" ], "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`." }, "get": { "id": "discoveryengine.projects.operations.get", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/operations/{operationsId}", "httpMethod": "GET", "parameters": { "name": { "description": "The name of the operation resource.", "pattern": "^projects/[^/]+/operations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "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" ], "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." } } } } } }, "canonicalName": "Discovery Engine", "mtlsRootUrl": "https://discoveryengine.mtls.googleapis.com/", "description": "Discovery Engine API." }