Package google.cloud.discoveryengine.v1alpha

Index

AclConfigService

Service for managing Acl Configuration.

GetAclConfig

rpc GetAclConfig(GetAclConfigRequest) returns (AclConfig)

Gets the AclConfig.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

UpdateAclConfig

rpc UpdateAclConfig(UpdateAclConfigRequest) returns (AclConfig)

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.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

AssistantService

Service for managing Assistant configuration and assisting users.

ChunkService

Service for displaying processed Chunk information of the customer's unstructured data.

GetChunk

rpc GetChunk(GetChunkRequest) returns (Chunk)

Gets a Document.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

ListChunks

rpc ListChunks(ListChunksRequest) returns (ListChunksResponse)

Gets a list of Chunks.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

CompletionService

Service for Auto-Completion.

CompleteQuery

rpc CompleteQuery(CompleteQueryRequest) returns (CompleteQueryResponse)

Completes the specified user input with keyword suggestions.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the dataStore resource:

  • discoveryengine.dataStores.completeQuery

For more information, see the IAM documentation.

ImportCompletionSuggestions

rpc ImportCompletionSuggestions(ImportCompletionSuggestionsRequest) returns (Operation)

Imports CompletionSuggestions for a DataStore.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

ImportSuggestionDenyListEntries

rpc ImportSuggestionDenyListEntries(ImportSuggestionDenyListEntriesRequest) returns (Operation)

Imports all SuggestionDenyListEntry for a DataStore.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • discoveryengine.suggestionDenyListEntries.import

For more information, see the IAM documentation.

PurgeCompletionSuggestions

rpc PurgeCompletionSuggestions(PurgeCompletionSuggestionsRequest) returns (Operation)

Permanently deletes all CompletionSuggestions for a DataStore.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

PurgeSuggestionDenyListEntries

rpc PurgeSuggestionDenyListEntries(PurgeSuggestionDenyListEntriesRequest) returns (Operation)

Permanently deletes all SuggestionDenyListEntry for a DataStore.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • discoveryengine.suggestionDenyListEntries.purge

For more information, see the IAM documentation.

ControlService

Service for performing CRUD operations on Controls. Controls allow for custom logic to be implemented in the serving path. Controls need to be attached to a Serving Config to be considered during a request.

CreateControl

rpc CreateControl(CreateControlRequest) returns (Control)

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.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • discoveryengine.controls.create

For more information, see the IAM documentation.

DeleteControl

rpc DeleteControl(DeleteControlRequest) returns (Empty)

Deletes a Control.

If the Control to delete does not exist, a NOT_FOUND error is returned.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • discoveryengine.controls.delete

For more information, see the IAM documentation.

GetControl

rpc GetControl(GetControlRequest) returns (Control)

Gets a Control.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • discoveryengine.controls.get

For more information, see the IAM documentation.

ListControls

rpc ListControls(ListControlsRequest) returns (ListControlsResponse)

Lists all Controls by their parent DataStore.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • discoveryengine.controls.list

For more information, see the IAM documentation.

UpdateControl

rpc UpdateControl(UpdateControlRequest) returns (Control)

Updates a Control.

Control action type cannot be changed. If the Control to update does not exist, a NOT_FOUND error is returned.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • discoveryengine.controls.update

For more information, see the IAM documentation.

ConversationalSearchService

Service for conversational search.

AnswerQuery

rpc AnswerQuery(AnswerQueryRequest) returns (AnswerQueryResponse)

Answer query method.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the servingConfig resource:

  • discoveryengine.servingConfigs.answer

For more information, see the IAM documentation.

ConverseConversation

rpc ConverseConversation(ConverseConversationRequest) returns (ConverseConversationResponse)

Converses a conversation.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • discoveryengine.conversations.converse

For more information, see the IAM documentation.

CreateConversation

rpc CreateConversation(CreateConversationRequest) returns (Conversation)

Creates a Conversation.

If the Conversation to create already exists, an ALREADY_EXISTS error is returned.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • discoveryengine.conversations.create

For more information, see the IAM documentation.

CreateSession

rpc CreateSession(CreateSessionRequest) returns (Session)

Creates a Session.

If the Session to create already exists, an ALREADY_EXISTS error is returned.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • discoveryengine.sessions.create

For more information, see the IAM documentation.

DeleteConversation

rpc DeleteConversation(DeleteConversationRequest) returns (Empty)

Deletes a Conversation.

If the Conversation to delete does not exist, a NOT_FOUND error is returned.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • discoveryengine.conversations.delete

For more information, see the IAM documentation.

DeleteSession

rpc DeleteSession(DeleteSessionRequest) returns (Empty)

Deletes a Session.

If the Session to delete does not exist, a NOT_FOUND error is returned.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • discoveryengine.sessions.delete

For more information, see the IAM documentation.

GetAnswer

rpc GetAnswer(GetAnswerRequest) returns (Answer)

Gets a Answer.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • discoveryengine.answers.get

For more information, see the IAM documentation.

GetConversation

rpc GetConversation(GetConversationRequest) returns (Conversation)

Gets a Conversation.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • discoveryengine.conversations.get

For more information, see the IAM documentation.

GetSession

rpc GetSession(GetSessionRequest) returns (Session)

Gets a Session.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • discoveryengine.sessions.get

For more information, see the IAM documentation.

ListConversations

rpc ListConversations(ListConversationsRequest) returns (ListConversationsResponse)

Lists all Conversations by their parent DataStore.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • discoveryengine.conversations.list

For more information, see the IAM documentation.

ListSessions

rpc ListSessions(ListSessionsRequest) returns (ListSessionsResponse)

Lists all Sessions by their parent DataStore.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • discoveryengine.sessions.list

For more information, see the IAM documentation.

UpdateConversation

rpc UpdateConversation(UpdateConversationRequest) returns (Conversation)

Updates a Conversation.

Conversation action type cannot be changed. If the Conversation to update does not exist, a NOT_FOUND error is returned.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • discoveryengine.conversations.update

For more information, see the IAM documentation.

UpdateSession

rpc UpdateSession(UpdateSessionRequest) returns (Session)

Updates a Session.

Session action type cannot be changed. If the Session to update does not exist, a NOT_FOUND error is returned.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • discoveryengine.sessions.update

For more information, see the IAM documentation.

DataStoreService

Service for managing DataStore configuration.

CreateDataStore

rpc CreateDataStore(CreateDataStoreRequest) returns (Operation)

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.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • discoveryengine.dataStores.create

For more information, see the IAM documentation.

DeleteDataStore

rpc DeleteDataStore(DeleteDataStoreRequest) returns (Operation)

Deletes a DataStore.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • discoveryengine.dataStores.delete

For more information, see the IAM documentation.

GetCompletionConfig

rpc GetCompletionConfig(GetCompletionConfigRequest) returns (CompletionConfig)

Gets a CompletionConfig

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • discoveryengine.completionConfigs.get

For more information, see the IAM documentation.

GetDataStore

rpc GetDataStore(GetDataStoreRequest) returns (DataStore)

Gets a DataStore.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • discoveryengine.dataStores.get

For more information, see the IAM documentation.

GetDocumentProcessingConfig

rpc GetDocumentProcessingConfig(GetDocumentProcessingConfigRequest) returns (DocumentProcessingConfig)

Gets a DocumentProcessingConfig.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • discoveryengine.documentProcessingConfigs.get

For more information, see the IAM documentation.

ListDataStores

rpc ListDataStores(ListDataStoresRequest) returns (ListDataStoresResponse)

Lists all the DataStores associated with the project.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • discoveryengine.dataStores.list

For more information, see the IAM documentation.

UpdateCompletionConfig

rpc UpdateCompletionConfig(UpdateCompletionConfigRequest) returns (CompletionConfig)

Updates the CompletionConfigs.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • discoveryengine.completionConfigs.update

For more information, see the IAM documentation.

UpdateDataStore

rpc UpdateDataStore(UpdateDataStoreRequest) returns (DataStore)

Updates a DataStore

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • discoveryengine.dataStores.update

For more information, see the IAM documentation.

UpdateDocumentProcessingConfig

rpc UpdateDocumentProcessingConfig(UpdateDocumentProcessingConfigRequest) returns (DocumentProcessingConfig)

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.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • discoveryengine.documentProcessingConfigs.update

For more information, see the IAM documentation.

DocumentService

Service for ingesting Document information of the customer's website.

CreateDocument

rpc CreateDocument(CreateDocumentRequest) returns (Document)

Creates a Document.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • discoveryengine.documents.create

For more information, see the IAM documentation.

DeleteDocument

rpc DeleteDocument(DeleteDocumentRequest) returns (Empty)

Deletes a Document.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • discoveryengine.documents.delete

For more information, see the IAM documentation.

GetDocument

rpc GetDocument(GetDocumentRequest) returns (Document)

Gets a Document.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • discoveryengine.documents.get

For more information, see the IAM documentation.

GetProcessedDocument

rpc GetProcessedDocument(GetProcessedDocumentRequest) returns (ProcessedDocument)

Gets the parsed layout information for a Document.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • discoveryengine.documents.get

For more information, see the IAM documentation.

ImportDocuments

rpc ImportDocuments(ImportDocumentsRequest) returns (Operation)

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.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • discoveryengine.documents.import

For more information, see the IAM documentation.

ListDocuments

rpc ListDocuments(ListDocumentsRequest) returns (ListDocumentsResponse)

Gets a list of Documents.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • discoveryengine.documents.list

For more information, see the IAM documentation.

PurgeDocuments

rpc PurgeDocuments(PurgeDocumentsRequest) returns (Operation)

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.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • discoveryengine.documents.purge

For more information, see the IAM documentation.

UpdateDocument

rpc UpdateDocument(UpdateDocumentRequest) returns (Document)

Updates a Document.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • discoveryengine.documents.update

For more information, see the IAM documentation.

EngineService

Service for managing Engine configuration.

CreateEngine

rpc CreateEngine(CreateEngineRequest) returns (Operation)

Creates a Engine.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • discoveryengine.engines.create

For more information, see the IAM documentation.

DeleteEngine

rpc DeleteEngine(DeleteEngineRequest) returns (Operation)

Deletes a Engine.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • discoveryengine.engines.delete

For more information, see the IAM documentation.

GetEngine

rpc GetEngine(GetEngineRequest) returns (Engine)

Gets a Engine.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • discoveryengine.engines.get

For more information, see the IAM documentation.

ListEngines

rpc ListEngines(ListEnginesRequest) returns (ListEnginesResponse)

Lists all the Engines associated with the project.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • discoveryengine.engines.list

For more information, see the IAM documentation.

PauseEngine

rpc PauseEngine(PauseEngineRequest) returns (Engine)

Pauses the training of an existing engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • discoveryengine.engines.pause

For more information, see the IAM documentation.

ResumeEngine

rpc ResumeEngine(ResumeEngineRequest) returns (Engine)

Resumes the training of an existing engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • discoveryengine.engines.resume

For more information, see the IAM documentation.

TuneEngine

rpc TuneEngine(TuneEngineRequest) returns (Operation)

Tunes an existing engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • discoveryengine.engines.tune

For more information, see the IAM documentation.

UpdateEngine

rpc UpdateEngine(UpdateEngineRequest) returns (Engine)

Updates an Engine

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • discoveryengine.engines.update

For more information, see the IAM documentation.

EstimateBillingService

Service for managing billing estimations resources.

EstimateDataSize

rpc EstimateDataSize(EstimateDataSizeRequest) returns (Operation)

Estimates the data size to be used by a customer.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the location resource:

  • discoveryengine.locations.estimateDataSize

For more information, see the IAM documentation.

EvaluationService

Service for managing Evaluations,

GroundedGenerationService

Service for grounded generation.

CheckGrounding

rpc CheckGrounding(CheckGroundingRequest) returns (CheckGroundingResponse)

Performs a grounding check.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the groundingConfig resource:

  • discoveryengine.groundingConfigs.check

For more information, see the IAM documentation.

ProjectService

Service for operations on the Project.

GetProject

rpc GetProject(GetProjectRequest) returns (Project)

Gets a Project. Returns NOT_FOUND when the project is not yet created.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • discoveryengine.projects.get

For more information, see the IAM documentation.

ProvisionProject

rpc ProvisionProject(ProvisionProjectRequest) returns (Operation)

Provisions the project resource. During the process, related systems will get prepared and initialized.

Caller must read the Terms for data use, and optionally specify in request to provide consent to that service terms.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • discoveryengine.projects.provision

For more information, see the IAM documentation.

ReportConsentChange

rpc ReportConsentChange(ReportConsentChangeRequest) returns (Project)

Updates service terms for this project.

This method can be used to retroactively accept the latest terms.

Terms available for update:

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the project resource:

  • discoveryengine.projects.reportConsentChange

For more information, see the IAM documentation.

RankService

Service for ranking text records.

Rank

rpc Rank(RankRequest) returns (RankResponse)

Ranks a list of text records based on the given input query.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the rankingConfig resource:

  • discoveryengine.rankingConfigs.rank

For more information, see the IAM documentation.

RecommendationService

Service for making recommendations.

Recommend

rpc Recommend(RecommendRequest) returns (RecommendResponse)

Makes a recommendation, which requires a contextual user event.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the servingConfig resource:

  • discoveryengine.servingConfigs.recommend

For more information, see the IAM documentation.

RequirementService

Service for requirement management.

CheckRequirement

rpc CheckRequirement(CheckRequirementRequest) returns (CheckRequirementResponse)

Check a particular requirement.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

SchemaService

Service for managing Schemas.

CreateSchema

rpc CreateSchema(CreateSchemaRequest) returns (Operation)

Creates a Schema.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • discoveryengine.schemas.create

For more information, see the IAM documentation.

DeleteSchema

rpc DeleteSchema(DeleteSchemaRequest) returns (Operation)

Deletes a Schema.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • discoveryengine.schemas.delete

For more information, see the IAM documentation.

GetSchema

rpc GetSchema(GetSchemaRequest) returns (Schema)

Gets a Schema.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • discoveryengine.schemas.get

For more information, see the IAM documentation.

ListSchemas

rpc ListSchemas(ListSchemasRequest) returns (ListSchemasResponse)

Gets a list of Schemas.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • discoveryengine.schemas.list

For more information, see the IAM documentation.

UpdateSchema

rpc UpdateSchema(UpdateSchemaRequest) returns (Operation)

Updates a Schema.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • discoveryengine.schemas.update

For more information, see the IAM documentation.

SearchService

Service for search.

Search

rpc Search(SearchRequest) returns (SearchResponse)

Performs a search.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the servingConfig resource:

  • discoveryengine.servingConfigs.search

For more information, see the IAM documentation.

SearchTuningService

Service for search tuning.

ListCustomModels

rpc ListCustomModels(ListCustomModelsRequest) returns (ListCustomModelsResponse)

Gets a list of all the custom models.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

TrainCustomModel

rpc TrainCustomModel(TrainCustomModelRequest) returns (Operation)

Trains a custom model.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the dataStore resource:

  • discoveryengine.dataStores.trainCustomModel

For more information, see the IAM documentation.

ServingConfigService

Service for operations related to ServingConfig.

CreateServingConfig

rpc CreateServingConfig(CreateServingConfigRequest) returns (ServingConfig)

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.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • discoveryengine.servingConfigs.create

For more information, see the IAM documentation.

DeleteServingConfig

rpc DeleteServingConfig(DeleteServingConfigRequest) returns (Empty)

Deletes a ServingConfig.

Returns a NOT_FOUND error if the ServingConfig does not exist.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • discoveryengine.servingConfigs.delete

For more information, see the IAM documentation.

GetServingConfig

rpc GetServingConfig(GetServingConfigRequest) returns (ServingConfig)

Gets a ServingConfig.

Returns a NotFound error if the ServingConfig does not exist.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • discoveryengine.servingConfigs.get

For more information, see the IAM documentation.

ListServingConfigs

rpc ListServingConfigs(ListServingConfigsRequest) returns (ListServingConfigsResponse)

Lists all ServingConfigs linked to this dataStore.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • discoveryengine.servingConfigs.list

For more information, see the IAM documentation.

UpdateServingConfig

rpc UpdateServingConfig(UpdateServingConfigRequest) returns (ServingConfig)

Updates a ServingConfig.

Returns a NOT_FOUND error if the ServingConfig does not exist.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • discoveryengine.servingConfigs.update

For more information, see the IAM documentation.

SiteSearchEngineService

Service for managing site search related resources.

BatchCreateTargetSites

rpc BatchCreateTargetSites(BatchCreateTargetSitesRequest) returns (Operation)

Creates TargetSite in a batch.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • discoveryengine.targetSites.batchCreate

For more information, see the IAM documentation.

BatchVerifyTargetSites

rpc BatchVerifyTargetSites(BatchVerifyTargetSitesRequest) returns (Operation)

Verify target sites' ownership and validity. This API sends all the target sites under site search engine for verification.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • discoveryengine.siteSearchEngines.batchVerifyTargetSites

For more information, see the IAM documentation.

CreateTargetSite

rpc CreateTargetSite(CreateTargetSiteRequest) returns (Operation)

Creates a TargetSite.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • discoveryengine.targetSites.create

For more information, see the IAM documentation.