Namespace Google.Apis.DiscoveryEngine.v1alpha
Classes
DiscoveryEngineBaseServiceRequest<TResponse>
A base abstract class for DiscoveryEngine requests.
DiscoveryEngineService
The DiscoveryEngine Service.
DiscoveryEngineService.Scope
Available OAuth 2.0 scopes for use with the Discovery Engine API.
DiscoveryEngineService.ScopeConstants
Available OAuth 2.0 scope constants for use with the Discovery Engine API.
ProjectsResource
The "projects" collection of methods.
ProjectsResource.GetRequest
Gets a Project. Returns NOT_FOUND when the project is not yet created.
ProjectsResource.LocationsResource
The "locations" collection of methods.
ProjectsResource.LocationsResource.CmekConfigsResource
The "cmekConfigs" collection of methods.
ProjectsResource.LocationsResource.CmekConfigsResource.GetRequest
Gets the CmekConfig.
ProjectsResource.LocationsResource.CmekConfigsResource.ListRequest
Lists all the CmekConfigs with the project.
ProjectsResource.LocationsResource.CmekConfigsResource.PatchRequest
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.
ProjectsResource.LocationsResource.CollectionsResource
The "collections" collection of methods.
ProjectsResource.LocationsResource.CollectionsResource.DataConnectorResource
The "dataConnector" collection of methods.
ProjectsResource.LocationsResource.CollectionsResource.DataConnectorResource.OperationsResource
The "operations" collection of methods.
ProjectsResource.LocationsResource.CollectionsResource.DataConnectorResource.OperationsResource.GetRequest
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.
ProjectsResource.LocationsResource.CollectionsResource.DataConnectorResource.OperationsResource.ListRequest
Lists operations that match the specified filter in the request. If the server doesn't
support this method, it returns UNIMPLEMENTED.
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource
The "dataStores" collection of methods.
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.BranchesResource
The "branches" collection of methods.
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.BranchesResource.BatchGetDocumentsMetadataRequest
Gets index freshness metadata for Documents. Supported for website search only.
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.BranchesResource.DocumentsResource
The "documents" collection of methods.
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.BranchesResource.DocumentsResource.ChunksResource
The "chunks" collection of methods.
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.BranchesResource.DocumentsResource.ChunksResource.GetRequest
Gets a Document.
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.BranchesResource.DocumentsResource.ChunksResource.ListRequest
Gets a list of Chunks.
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.BranchesResource.DocumentsResource.CreateRequest
Creates a Document.
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.BranchesResource.DocumentsResource.DeleteRequest
Deletes a Document.
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.BranchesResource.DocumentsResource.GetProcessedDocumentRequest
Gets the parsed layout information for a Document.
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.BranchesResource.DocumentsResource.GetRequest
Gets a Document.
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.BranchesResource.DocumentsResource.ImportRequest
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.
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.BranchesResource.DocumentsResource.ListRequest
Gets a list of Documents.
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.BranchesResource.DocumentsResource.PatchRequest
Updates a Document.
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.BranchesResource.DocumentsResource.PurgeRequest
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.
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.BranchesResource.OperationsResource
The "operations" collection of methods.
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.BranchesResource.OperationsResource.CancelRequest
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.
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.BranchesResource.OperationsResource.GetRequest
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.
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.BranchesResource.OperationsResource.ListRequest
Lists operations that match the specified filter in the request. If the server doesn't
support this method, it returns UNIMPLEMENTED.
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.CompleteQueryRequest
Completes the specified user input with keyword suggestions.
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.CompletionConfigResource
The "completionConfig" collection of methods.
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.CompletionConfigResource.CompleteQueryRequest
Completes the user input with advanced keyword suggestions.
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.CompletionSuggestionsResource
The "completionSuggestions" collection of methods.
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.CompletionSuggestionsResource.ImportRequest
Imports CompletionSuggestions for a DataStore.
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.CompletionSuggestionsResource.PurgeRequest
Permanently deletes all CompletionSuggestions for a DataStore.
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.ControlsResource
The "controls" collection of methods.
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.ControlsResource.CreateRequest
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.
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.ControlsResource.DeleteRequest
Deletes a Control. If the Control to delete does not exist, a NOT_FOUND error is returned.
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.ControlsResource.GetRequest
Gets a Control.
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.ControlsResource.ListRequest
Lists all Controls by their parent DataStore.
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.ControlsResource.PatchRequest
Updates a Control. Control action type cannot be changed. If the Control to update does not exist, a NOT_FOUND error is returned.
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.ConversationsResource
The "conversations" collection of methods.
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.ConversationsResource.ConverseRequest
Converses a conversation.
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.ConversationsResource.CreateRequest
Creates a Conversation. If the Conversation to create already exists, an ALREADY_EXISTS error is returned.
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.ConversationsResource.DeleteRequest
Deletes a Conversation. If the Conversation to delete does not exist, a NOT_FOUND error is returned.
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.ConversationsResource.GetRequest
Gets a Conversation.
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.ConversationsResource.ListRequest
Lists all Conversations by their parent DataStore.
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.ConversationsResource.PatchRequest
Updates a Conversation. Conversation action type cannot be changed. If the Conversation to update does not exist, a NOT_FOUND error is returned.
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.CreateRequest
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.
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.CustomModelsResource
The "customModels" collection of methods.
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.CustomModelsResource.ListRequest
Gets a list of all the custom models.
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.DeleteRequest
Deletes a DataStore.
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.GetDocumentProcessingConfigRequest
Gets a DocumentProcessingConfig.
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.GetRequest
Gets a DataStore.
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.GetSiteSearchEngineRequest
Gets the SiteSearchEngine.
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.ListRequest
Lists all the DataStores associated with the project.
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.ModelsResource
The "models" collection of methods.
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.ModelsResource.OperationsResource
The "operations" collection of methods.
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.ModelsResource.OperationsResource.GetRequest
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.
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.ModelsResource.OperationsResource.ListRequest
Lists operations that match the specified filter in the request. If the server doesn't
support this method, it returns UNIMPLEMENTED.
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.OperationsResource
The "operations" collection of methods.
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.OperationsResource.GetRequest
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.
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.OperationsResource.ListRequest
Lists operations that match the specified filter in the request. If the server doesn't
support this method, it returns UNIMPLEMENTED.
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.PatchRequest
Updates a DataStore
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.SchemasResource
The "schemas" collection of methods.
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.SchemasResource.CreateRequest
Creates a Schema.
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.SchemasResource.DeleteRequest
Deletes a Schema.
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.SchemasResource.GetRequest
Gets a Schema.
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.SchemasResource.ListRequest
Gets a list of Schemas.
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.SchemasResource.OperationsResource
The "operations" collection of methods.
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.SchemasResource.OperationsResource.GetRequest
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.
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.SchemasResource.OperationsResource.ListRequest
Lists operations that match the specified filter in the request. If the server doesn't
support this method, it returns UNIMPLEMENTED.
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.SchemasResource.PatchRequest
Updates a Schema.
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.ServingConfigsResource
The "servingConfigs" collection of methods.
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.ServingConfigsResource.AnswerRequest
Answer query method.
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.ServingConfigsResource.GetRequest
Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.ServingConfigsResource.ListRequest
Lists all ServingConfigs linked to this dataStore.
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.ServingConfigsResource.PatchRequest
Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.ServingConfigsResource.RecommendRequest
Makes a recommendation, which requires a contextual user event.
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.ServingConfigsResource.SearchLiteRequest
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.
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.ServingConfigsResource.SearchRequest
Performs a search.
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.SessionsResource
The "sessions" collection of methods.
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.SessionsResource.AnswersResource
The "answers" collection of methods.
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.SessionsResource.AnswersResource.GetRequest
Gets a Answer.
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.SessionsResource.CreateRequest
Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is returned.
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.SessionsResource.DeleteRequest
Deletes a Session. If the Session to delete does not exist, a NOT_FOUND error is returned.
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.SessionsResource.GetRequest
Gets a Session.
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.SessionsResource.ListRequest
Lists all Sessions by their parent DataStore.
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.SessionsResource.PatchRequest
Updates a Session. Session action type cannot be changed. If the Session to update does not exist, a NOT_FOUND error is returned.
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.SiteSearchEngineResource
The "siteSearchEngine" collection of methods.
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.SiteSearchEngineResource.BatchVerifyTargetSitesRequest
Verify target sites' ownership and validity. This API sends all the target sites under site search engine for verification.
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.SiteSearchEngineResource.DisableAdvancedSiteSearchRequest
Downgrade from advanced site search to basic site search.
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.SiteSearchEngineResource.EnableAdvancedSiteSearchRequest
Upgrade from basic site search to advanced site search.
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.SiteSearchEngineResource.FetchDomainVerificationStatusRequest
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.
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.SiteSearchEngineResource.GetUriPatternDocumentDataRequest
Gets the URI Pattern to Document data mapping for an Advanced Site Search DataStore.
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.SiteSearchEngineResource.OperationsResource
The "operations" collection of methods.
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.SiteSearchEngineResource.OperationsResource.GetRequest
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.
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.SiteSearchEngineResource.OperationsResource.ListRequest
Lists operations that match the specified filter in the request. If the server doesn't
support this method, it returns UNIMPLEMENTED.
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.SiteSearchEngineResource.RecrawlUrisRequest
Request on-demand recrawl for a list of URIs.
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.SiteSearchEngineResource.SetUriPatternDocumentDataRequest
Sets the URI Pattern to Document data mapping for an Advanced Site Search DataStore.
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.SiteSearchEngineResource.SitemapsResource
The "sitemaps" collection of methods.
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.SiteSearchEngineResource.SitemapsResource.CreateRequest
Creates a Sitemap.
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.SiteSearchEngineResource.SitemapsResource.DeleteRequest
Deletes a Sitemap.
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.SiteSearchEngineResource.TargetSitesResource
The "targetSites" collection of methods.
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.SiteSearchEngineResource.TargetSitesResource.BatchCreateRequest
Creates TargetSite in a batch.
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.SiteSearchEngineResource.TargetSitesResource.CreateRequest
Creates a TargetSite.
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.SiteSearchEngineResource.TargetSitesResource.DeleteRequest
Deletes a TargetSite.
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.SiteSearchEngineResource.TargetSitesResource.GetRequest
Gets a TargetSite.
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.SiteSearchEngineResource.TargetSitesResource.ListRequest
Gets a list of TargetSites.
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.SiteSearchEngineResource.TargetSitesResource.OperationsResource
The "operations" collection of methods.
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.SiteSearchEngineResource.TargetSitesResource.OperationsResource.GetRequest
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.
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.SiteSearchEngineResource.TargetSitesResource.OperationsResource.ListRequest
Lists operations that match the specified filter in the request. If the server
doesn't support this method, it returns UNIMPLEMENTED.
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.SiteSearchEngineResource.TargetSitesResource.PatchRequest
Updates a TargetSite.
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.SuggestionDenyListEntriesResource
The "suggestionDenyListEntries" collection of methods.
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.SuggestionDenyListEntriesResource.ImportRequest
Imports all SuggestionDenyListEntry for a DataStore.
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.SuggestionDenyListEntriesResource.PurgeRequest
Permanently deletes all SuggestionDenyListEntry for a DataStore.
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.TrainCustomModelRequest
Trains a custom model.
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.UpdateDocumentProcessingConfigRequest
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.
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.UserEventsResource
The "userEvents" collection of methods.
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.UserEventsResource.CollectRequest
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.
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.UserEventsResource.ImportRequest
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.
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.UserEventsResource.PurgeRequest
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.
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.UserEventsResource.WriteRequest
Writes a single user event.
ProjectsResource.LocationsResource.CollectionsResource.EnginesResource
The "engines" collection of methods.
ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.CompletionConfigResource
The "completionConfig" collection of methods.
ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.CompletionConfigResource.CompleteQueryRequest
Completes the user input with advanced keyword suggestions.
ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.ControlsResource
The "controls" collection of methods.
ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.ControlsResource.CreateRequest
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.
ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.ControlsResource.DeleteRequest
Deletes a Control. If the Control to delete does not exist, a NOT_FOUND error is returned.
ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.ControlsResource.GetRequest
Gets a Control.
ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.ControlsResource.ListRequest
Lists all Controls by their parent DataStore.
ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.ControlsResource.PatchRequest
Updates a Control. Control action type cannot be changed. If the Control to update does not exist, a NOT_FOUND error is returned.
ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.ConversationsResource
The "conversations" collection of methods.
ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.ConversationsResource.ConverseRequest
Converses a conversation.
ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.ConversationsResource.CreateRequest
Creates a Conversation. If the Conversation to create already exists, an ALREADY_EXISTS error is returned.
ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.ConversationsResource.DeleteRequest
Deletes a Conversation. If the Conversation to delete does not exist, a NOT_FOUND error is returned.
ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.ConversationsResource.GetRequest
Gets a Conversation.
ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.ConversationsResource.ListRequest
Lists all Conversations by their parent DataStore.
ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.ConversationsResource.PatchRequest
Updates a Conversation. Conversation action type cannot be changed. If the Conversation to update does not exist, a NOT_FOUND error is returned.
ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.CreateRequest
Creates a Engine.
ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.DeleteRequest
Deletes a Engine.
ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.GetRequest
Gets a Engine.
ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.ListRequest
Lists all the Engines associated with the project.
ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.OperationsResource
The "operations" collection of methods.
ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.OperationsResource.GetRequest
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.
ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.OperationsResource.ListRequest
Lists operations that match the specified filter in the request. If the server doesn't
support this method, it returns UNIMPLEMENTED.
ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.PatchRequest
Updates an Engine
ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.PauseRequest
Pauses the training of an existing engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION.
ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.ResumeRequest
Resumes the training of an existing engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION.
ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.ServingConfigsResource
The "servingConfigs" collection of methods.
ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.ServingConfigsResource.AnswerRequest
Answer query method.
ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.ServingConfigsResource.GetRequest
Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.
ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.ServingConfigsResource.ListRequest
Lists all ServingConfigs linked to this dataStore.
ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.ServingConfigsResource.PatchRequest
Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.
ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.ServingConfigsResource.RecommendRequest
Makes a recommendation, which requires a contextual user event.
ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.ServingConfigsResource.SearchLiteRequest
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.
ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.ServingConfigsResource.SearchRequest
Performs a search.
ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.SessionsResource
The "sessions" collection of methods.
ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.SessionsResource.AnswersResource
The "answers" collection of methods.
ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.SessionsResource.AnswersResource.GetRequest
Gets a Answer.
ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.SessionsResource.CreateRequest
Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is returned.
ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.SessionsResource.DeleteRequest
Deletes a Session. If the Session to delete does not exist, a NOT_FOUND error is returned.
ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.SessionsResource.GetRequest
Gets a Session.
ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.SessionsResource.ListRequest
Lists all Sessions by their parent DataStore.
ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.SessionsResource.PatchRequest
Updates a Session. Session action type cannot be changed. If the Session to update does not exist, a NOT_FOUND error is returned.
ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.TuneRequest
Tunes an existing engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION.
ProjectsResource.LocationsResource.CollectionsResource.OperationsResource
The "operations" collection of methods.
ProjectsResource.LocationsResource.CollectionsResource.OperationsResource.GetRequest
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.
ProjectsResource.LocationsResource.CollectionsResource.OperationsResource.ListRequest
Lists operations that match the specified filter in the request. If the server doesn't support
this method, it returns UNIMPLEMENTED.
ProjectsResource.LocationsResource.DataStoresResource
The "dataStores" collection of methods.
ProjectsResource.LocationsResource.DataStoresResource.BranchesResource
The "branches" collection of methods.
ProjectsResource.LocationsResource.DataStoresResource.BranchesResource.BatchGetDocumentsMetadataRequest
Gets index freshness metadata for Documents. Supported for website search only.
ProjectsResource.LocationsResource.DataStoresResource.BranchesResource.DocumentsResource
The "documents" collection of methods.
ProjectsResource.LocationsResource.DataStoresResource.BranchesResource.DocumentsResource.ChunksResource
The "chunks" collection of methods.
ProjectsResource.LocationsResource.DataStoresResource.BranchesResource.DocumentsResource.ChunksResource.GetRequest
Gets a Document.
ProjectsResource.LocationsResource.DataStoresResource.BranchesResource.DocumentsResource.ChunksResource.ListRequest
Gets a list of Chunks.
ProjectsResource.LocationsResource.DataStoresResource.BranchesResource.DocumentsResource.CreateRequest
Creates a Document.
ProjectsResource.LocationsResource.DataStoresResource.BranchesResource.DocumentsResource.DeleteRequest
Deletes a Document.
ProjectsResource.LocationsResource.DataStoresResource.BranchesResource.DocumentsResource.GetProcessedDocumentRequest
Gets the parsed layout information for a Document.
ProjectsResource.LocationsResource.DataStoresResource.BranchesResource.DocumentsResource.GetRequest
Gets a Document.
ProjectsResource.LocationsResource.DataStoresResource.BranchesResource.DocumentsResource.ImportRequest
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.
ProjectsResource.LocationsResource.DataStoresResource.BranchesResource.DocumentsResource.ListRequest
Gets a list of Documents.
ProjectsResource.LocationsResource.DataStoresResource.BranchesResource.DocumentsResource.PatchRequest
Updates a Document.
ProjectsResource.LocationsResource.DataStoresResource.BranchesResource.DocumentsResource.PurgeRequest
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.
ProjectsResource.LocationsResource.DataStoresResource.BranchesResource.OperationsResource
The "operations" collection of methods.
ProjectsResource.LocationsResource.DataStoresResource.BranchesResource.OperationsResource.CancelRequest
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.
ProjectsResource.LocationsResource.DataStoresResource.BranchesResource.OperationsResource.GetRequest
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.
ProjectsResource.LocationsResource.DataStoresResource.BranchesResource.OperationsResource.ListRequest
Lists operations that match the specified filter in the request. If the server doesn't
support this method, it returns UNIMPLEMENTED.
ProjectsResource.LocationsResource.DataStoresResource.CompleteQueryRequest
Completes the specified user input with keyword suggestions.
ProjectsResource.LocationsResource.DataStoresResource.CompletionConfigResource
The "completionConfig" collection of methods.
ProjectsResource.LocationsResource.DataStoresResource.CompletionConfigResource.CompleteQueryRequest
Completes the user input with advanced keyword suggestions.
ProjectsResource.LocationsResource.DataStoresResource.CompletionSuggestionsResource
The "completionSuggestions" collection of methods.
ProjectsResource.LocationsResource.DataStoresResource.CompletionSuggestionsResource.ImportRequest
Imports CompletionSuggestions for a DataStore.
ProjectsResource.LocationsResource.DataStoresResource.CompletionSuggestionsResource.PurgeRequest
Permanently deletes all CompletionSuggestions for a DataStore.
ProjectsResource.LocationsResource.DataStoresResource.ControlsResource
The "controls" collection of methods.
ProjectsResource.LocationsResource.DataStoresResource.ControlsResource.CreateRequest
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.
ProjectsResource.LocationsResource.DataStoresResource.ControlsResource.DeleteRequest
Deletes a Control. If the Control to delete does not exist, a NOT_FOUND error is returned.
ProjectsResource.LocationsResource.DataStoresResource.ControlsResource.GetRequest
Gets a Control.
ProjectsResource.LocationsResource.DataStoresResource.ControlsResource.ListRequest
Lists all Controls by their parent DataStore.
ProjectsResource.LocationsResource.DataStoresResource.ControlsResource.PatchRequest
Updates a Control. Control action type cannot be changed. If the Control to update does not exist, a NOT_FOUND error is returned.
ProjectsResource.LocationsResource.DataStoresResource.ConversationsResource
The "conversations" collection of methods.
ProjectsResource.LocationsResource.DataStoresResource.ConversationsResource.ConverseRequest
Converses a conversation.
ProjectsResource.LocationsResource.DataStoresResource.ConversationsResource.CreateRequest
Creates a Conversation. If the Conversation to create already exists, an ALREADY_EXISTS error is returned.
ProjectsResource.LocationsResource.DataStoresResource.ConversationsResource.DeleteRequest
Deletes a Conversation. If the Conversation to delete does not exist, a NOT_FOUND error is returned.
ProjectsResource.LocationsResource.DataStoresResource.ConversationsResource.GetRequest
Gets a Conversation.
ProjectsResource.LocationsResource.DataStoresResource.ConversationsResource.ListRequest
Lists all Conversations by their parent DataStore.
ProjectsResource.LocationsResource.DataStoresResource.ConversationsResource.PatchRequest
Updates a Conversation. Conversation action type cannot be changed. If the Conversation to update does not exist, a NOT_FOUND error is returned.
ProjectsResource.LocationsResource.DataStoresResource.CreateRequest
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.
ProjectsResource.LocationsResource.DataStoresResource.DeleteRequest
Deletes a DataStore.
ProjectsResource.LocationsResource.DataStoresResource.GetDocumentProcessingConfigRequest
Gets a DocumentProcessingConfig.
ProjectsResource.LocationsResource.DataStoresResource.GetRequest
Gets a DataStore.
ProjectsResource.LocationsResource.DataStoresResource.GetSiteSearchEngineRequest
Gets the SiteSearchEngine.
ProjectsResource.LocationsResource.DataStoresResource.ListRequest
Lists all the DataStores associated with the project.
ProjectsResource.LocationsResource.DataStoresResource.ModelsResource
The "models" collection of methods.
ProjectsResource.LocationsResource.DataStoresResource.ModelsResource.OperationsResource
The "operations" collection of methods.
ProjectsResource.LocationsResource.DataStoresResource.ModelsResource.OperationsResource.GetRequest
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.
ProjectsResource.LocationsResource.DataStoresResource.ModelsResource.OperationsResource.ListRequest
Lists operations that match the specified filter in the request. If the server doesn't
support this method, it returns UNIMPLEMENTED.
ProjectsResource.LocationsResource.DataStoresResource.OperationsResource
The "operations" collection of methods.
ProjectsResource.LocationsResource.DataStoresResource.OperationsResource.GetRequest
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.
ProjectsResource.LocationsResource.DataStoresResource.OperationsResource.ListRequest
Lists operations that match the specified filter in the request. If the server doesn't support
this method, it returns UNIMPLEMENTED.
ProjectsResource.LocationsResource.DataStoresResource.PatchRequest
Updates a DataStore
ProjectsResource.LocationsResource.DataStoresResource.SchemasResource
The "schemas" collection of methods.
ProjectsResource.LocationsResource.DataStoresResource.SchemasResource.CreateRequest
Creates a Schema.
ProjectsResource.LocationsResource.DataStoresResource.SchemasResource.DeleteRequest
Deletes a Schema.
ProjectsResource.LocationsResource.DataStoresResource.SchemasResource.GetRequest
Gets a Schema.
ProjectsResource.LocationsResource.DataStoresResource.SchemasResource.ListRequest
Gets a list of Schemas.
ProjectsResource.LocationsResource.DataStoresResource.SchemasResource.PatchRequest
Updates a Schema.
ProjectsResource.LocationsResource.DataStoresResource.ServingConfigsResource
The "servingConfigs" collection of methods.
ProjectsResource.LocationsResource.DataStoresResource.ServingConfigsResource.AnswerRequest
Answer query method.
ProjectsResource.LocationsResource.DataStoresResource.ServingConfigsResource.GetRequest
Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.
ProjectsResource.LocationsResource.DataStoresResource.ServingConfigsResource.ListRequest
Lists all ServingConfigs linked to this dataStore.
ProjectsResource.LocationsResource.DataStoresResource.ServingConfigsResource.PatchRequest
Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.
ProjectsResource.LocationsResource.DataStoresResource.ServingConfigsResource.RecommendRequest
Makes a recommendation, which requires a contextual user event.
ProjectsResource.LocationsResource.DataStoresResource.ServingConfigsResource.SearchLiteRequest
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.
ProjectsResource.LocationsResource.DataStoresResource.ServingConfigsResource.SearchRequest
Performs a search.
ProjectsResource.LocationsResource.DataStoresResource.SessionsResource
The "sessions" collection of methods.
ProjectsResource.LocationsResource.DataStoresResource.SessionsResource.AnswersResource
The "answers" collection of methods.
ProjectsResource.LocationsResource.DataStoresResource.SessionsResource.AnswersResource.GetRequest
Gets a Answer.
ProjectsResource.LocationsResource.DataStoresResource.SessionsResource.CreateRequest
Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is returned.
ProjectsResource.LocationsResource.DataStoresResource.SessionsResource.DeleteRequest
Deletes a Session. If the Session to delete does not exist, a NOT_FOUND error is returned.
ProjectsResource.LocationsResource.DataStoresResource.SessionsResource.GetRequest
Gets a Session.
ProjectsResource.LocationsResource.DataStoresResource.SessionsResource.ListRequest
Lists all Sessions by their parent DataStore.
ProjectsResource.LocationsResource.DataStoresResource.SessionsResource.PatchRequest
Updates a Session. Session action type cannot be changed. If the Session to update does not exist, a NOT_FOUND error is returned.
ProjectsResource.LocationsResource.DataStoresResource.SiteSearchEngineResource
The "siteSearchEngine" collection of methods.
ProjectsResource.LocationsResource.DataStoresResource.SiteSearchEngineResource.DisableAdvancedSiteSearchRequest
Downgrade from advanced site search to basic site search.
ProjectsResource.LocationsResource.DataStoresResource.SiteSearchEngineResource.EnableAdvancedSiteSearchRequest
Upgrade from basic site search to advanced site search.
ProjectsResource.LocationsResource.DataStoresResource.SiteSearchEngineResource.RecrawlUrisRequest
Request on-demand recrawl for a list of URIs.
ProjectsResource.LocationsResource.DataStoresResource.SiteSearchEngineResource.SitemapsResource
The "sitemaps" collection of methods.
ProjectsResource.LocationsResource.DataStoresResource.SiteSearchEngineResource.SitemapsResource.CreateRequest
Creates a Sitemap.
ProjectsResource.LocationsResource.DataStoresResource.SiteSearchEngineResource.SitemapsResource.DeleteRequest
Deletes a Sitemap.
ProjectsResource.LocationsResource.DataStoresResource.SiteSearchEngineResource.SitemapsResource.FetchRequest
Fetch Sitemaps in a DataStore.
ProjectsResource.LocationsResource.DataStoresResource.SiteSearchEngineResource.TargetSitesResource
The "targetSites" collection of methods.
ProjectsResource.LocationsResource.DataStoresResource.SiteSearchEngineResource.TargetSitesResource.BatchCreateRequest
Creates TargetSite in a batch.
ProjectsResource.LocationsResource.DataStoresResource.SiteSearchEngineResource.TargetSitesResource.CreateRequest
Creates a TargetSite.
ProjectsResource.LocationsResource.DataStoresResource.SiteSearchEngineResource.TargetSitesResource.DeleteRequest
Deletes a TargetSite.
ProjectsResource.LocationsResource.DataStoresResource.SiteSearchEngineResource.TargetSitesResource.GetRequest
Gets a TargetSite.
ProjectsResource.LocationsResource.DataStoresResource.SiteSearchEngineResource.TargetSitesResource.ListRequest
Gets a list of TargetSites.
ProjectsResource.LocationsResource.DataStoresResource.SiteSearchEngineResource.TargetSitesResource.PatchRequest
Updates a TargetSite.
ProjectsResource.LocationsResource.DataStoresResource.SuggestionDenyListEntriesResource
The "suggestionDenyListEntries" collection of methods.
ProjectsResource.LocationsResource.DataStoresResource.SuggestionDenyListEntriesResource.ImportRequest
Imports all SuggestionDenyListEntry for a DataStore.
ProjectsResource.LocationsResource.DataStoresResource.SuggestionDenyListEntriesResource.PurgeRequest
Permanently deletes all SuggestionDenyListEntry for a DataStore.
ProjectsResource.LocationsResource.DataStoresResource.UpdateDocumentProcessingConfigRequest
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.
ProjectsResource.LocationsResource.DataStoresResource.UserEventsResource
The "userEvents" collection of methods.
ProjectsResource.LocationsResource.DataStoresResource.UserEventsResource.CollectRequest
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.
ProjectsResource.LocationsResource.DataStoresResource.UserEventsResource.ImportRequest
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.
ProjectsResource.LocationsResource.DataStoresResource.UserEventsResource.PurgeRequest
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.
ProjectsResource.LocationsResource.DataStoresResource.UserEventsResource.WriteRequest
Writes a single user event.
ProjectsResource.LocationsResource.EstimateDataSizeRequest
Estimates the data size to be used by a customer.
ProjectsResource.LocationsResource.EvaluationsResource
The "evaluations" collection of methods.
ProjectsResource.LocationsResource.EvaluationsResource.CreateRequest
Creates a Evaluation. Upon creation, the evaluation will be automatically triggered and begin execution.
ProjectsResource.LocationsResource.EvaluationsResource.GetRequest
Gets a Evaluation.
ProjectsResource.LocationsResource.EvaluationsResource.ListRequest
Gets a list of Evaluations.
ProjectsResource.LocationsResource.EvaluationsResource.ListResultsRequest
Gets a list of results for a given a Evaluation.
ProjectsResource.LocationsResource.EvaluationsResource.OperationsResource
The "operations" collection of methods.
ProjectsResource.LocationsResource.EvaluationsResource.OperationsResource.GetRequest
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.
ProjectsResource.LocationsResource.GetAclConfigRequest
Gets the AclConfig.
ProjectsResource.LocationsResource.GetCmekConfigRequest
Gets the CmekConfig.
ProjectsResource.LocationsResource.GroundingConfigsResource
The "groundingConfigs" collection of methods.
ProjectsResource.LocationsResource.GroundingConfigsResource.CheckRequest
Performs a grounding check.
ProjectsResource.LocationsResource.IdentityMappingStoresResource
The "identityMappingStores" collection of methods.
ProjectsResource.LocationsResource.IdentityMappingStoresResource.OperationsResource
The "operations" collection of methods.
ProjectsResource.LocationsResource.IdentityMappingStoresResource.OperationsResource.GetRequest
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.
ProjectsResource.LocationsResource.IdentityMappingStoresResource.OperationsResource.ListRequest
Lists operations that match the specified filter in the request. If the server doesn't support
this method, it returns UNIMPLEMENTED.
ProjectsResource.LocationsResource.OperationsResource
The "operations" collection of methods.
ProjectsResource.LocationsResource.OperationsResource.GetRequest
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.
ProjectsResource.LocationsResource.OperationsResource.ListRequest
Lists operations that match the specified filter in the request. If the server doesn't support this
method, it returns UNIMPLEMENTED.
ProjectsResource.LocationsResource.RankingConfigsResource
The "rankingConfigs" collection of methods.
ProjectsResource.LocationsResource.RankingConfigsResource.RankRequest
Ranks a list of text records based on the given input query.
ProjectsResource.LocationsResource.RequirementsResource
The "requirements" collection of methods.
ProjectsResource.LocationsResource.RequirementsResource.CheckRequirementRequest
Check a particular requirement.
ProjectsResource.LocationsResource.SampleQuerySetsResource
The "sampleQuerySets" collection of methods.
ProjectsResource.LocationsResource.SampleQuerySetsResource.CreateRequest
Creates a SampleQuerySet
ProjectsResource.LocationsResource.SampleQuerySetsResource.DeleteRequest
Deletes a SampleQuerySet.
ProjectsResource.LocationsResource.SampleQuerySetsResource.GetRequest
Gets a SampleQuerySet.
ProjectsResource.LocationsResource.SampleQuerySetsResource.ListRequest
Gets a list of SampleQuerySets.
ProjectsResource.LocationsResource.SampleQuerySetsResource.OperationsResource
The "operations" collection of methods.
ProjectsResource.LocationsResource.SampleQuerySetsResource.OperationsResource.GetRequest
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.
ProjectsResource.LocationsResource.SampleQuerySetsResource.PatchRequest
Updates a SampleQuerySet.
ProjectsResource.LocationsResource.SampleQuerySetsResource.SampleQueriesResource
The "sampleQueries" collection of methods.
ProjectsResource.LocationsResource.SampleQuerySetsResource.SampleQueriesResource.CreateRequest
Creates a SampleQuery
ProjectsResource.LocationsResource.SampleQuerySetsResource.SampleQueriesResource.DeleteRequest
Deletes a SampleQuery.
ProjectsResource.LocationsResource.SampleQuerySetsResource.SampleQueriesResource.GetRequest
Gets a SampleQuery.
ProjectsResource.LocationsResource.SampleQuerySetsResource.SampleQueriesResource.ImportRequest
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.
ProjectsResource.LocationsResource.SampleQuerySetsResource.SampleQueriesResource.ListRequest
Gets a list of SampleQuerys.
ProjectsResource.LocationsResource.SampleQuerySetsResource.SampleQueriesResource.PatchRequest
Updates a SampleQuery.
ProjectsResource.LocationsResource.UpdateAclConfigRequest
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.
ProjectsResource.LocationsResource.UpdateCmekConfigRequest
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.
ProjectsResource.LocationsResource.UserEventsResource
The "userEvents" collection of methods.
ProjectsResource.LocationsResource.UserEventsResource.CollectRequest
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.
ProjectsResource.LocationsResource.UserEventsResource.ImportRequest
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.
ProjectsResource.LocationsResource.UserEventsResource.WriteRequest
Writes a single user event.
ProjectsResource.LocationsResource.UserStoresResource
The "userStores" collection of methods.
ProjectsResource.LocationsResource.UserStoresResource.OperationsResource
The "operations" collection of methods.
ProjectsResource.LocationsResource.UserStoresResource.OperationsResource.GetRequest
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.
ProjectsResource.LocationsResource.UserStoresResource.OperationsResource.ListRequest
Lists operations that match the specified filter in the request. If the server doesn't support
this method, it returns UNIMPLEMENTED.
ProjectsResource.OperationsResource
The "operations" collection of methods.
ProjectsResource.OperationsResource.GetRequest
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.
ProjectsResource.OperationsResource.ListRequest
Lists operations that match the specified filter in the request. If the server doesn't support this
method, it returns UNIMPLEMENTED.
ProjectsResource.ProvisionRequest
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.
ProjectsResource.ReportConsentChangeRequest
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
Enums
DiscoveryEngineBaseServiceRequest<TResponse>.AltEnum
Data format for response.
DiscoveryEngineBaseServiceRequest<TResponse>.XgafvEnum
V1 error format.
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.BranchesResource.DocumentsResource.GetProcessedDocumentRequest.ProcessedDocumentFormatEnum
What format output should be. If unspecified, defaults to JSON.
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.BranchesResource.DocumentsResource.GetProcessedDocumentRequest.ProcessedDocumentTypeEnum
Required. What type of processing to return.
ProjectsResource.LocationsResource.DataStoresResource.BranchesResource.DocumentsResource.GetProcessedDocumentRequest.ProcessedDocumentFormatEnum
What format output should be. If unspecified, defaults to JSON.
ProjectsResource.LocationsResource.DataStoresResource.BranchesResource.DocumentsResource.GetProcessedDocumentRequest.ProcessedDocumentTypeEnum
Required. What type of processing to return.