Discovery Engine API: projects. Discovery Engine API. See: https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects
Discovery Engine API: projects. Discovery Engine API. See: https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects
(locations-collections-dataConnector-operations-get$ auth parameters)
Required parameters: name
Optional parameters: none
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.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/collections/dataConnector/operations/get Required parameters: name Optional parameters: none 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.
(locations-collections-dataConnector-operations-list$ auth parameters)
Required parameters: name
Optional parameters: filter, pageSize, pageToken
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED
.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/collections/dataConnector/operations/list Required parameters: name Optional parameters: filter, pageSize, pageToken Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
(locations-collections-dataStores-branches-documents-create$ auth
parameters
body)
Required parameters: parent
Optional parameters: documentId
Body:
{:content {:rawBytes string, :uri string, :mimeType string}, :parentDocumentId string, :name string, :indexTime string, :schemaId string, :structData {}, :id string, :jsonData string, :derivedStructData {}}
Creates a Document.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/collections/dataStores/branches/documents/create Required parameters: parent Optional parameters: documentId Body: {:content {:rawBytes string, :uri string, :mimeType string}, :parentDocumentId string, :name string, :indexTime string, :schemaId string, :structData {}, :id string, :jsonData string, :derivedStructData {}} Creates a Document.
(locations-collections-dataStores-branches-documents-delete$ auth parameters)
Required parameters: name
Optional parameters: none
Deletes a Document.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/collections/dataStores/branches/documents/delete Required parameters: name Optional parameters: none Deletes a Document.
(locations-collections-dataStores-branches-documents-get$ auth parameters)
Required parameters: name
Optional parameters: none
Gets a Document.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/collections/dataStores/branches/documents/get Required parameters: name Optional parameters: none Gets a Document.
(locations-collections-dataStores-branches-documents-import$ auth
parameters
body)
Required parameters: parent
Optional parameters: none
Body:
{:inlineSource {:documents [GoogleCloudDiscoveryengineV1betaDocument]}, :gcsSource {:inputUris [string], :dataSchema string}, :bigquerySource {:partitionDate GoogleTypeDate, :projectId string, :datasetId string, :tableId string, :gcsStagingDir string, :dataSchema string}, :errorConfig {:gcsPrefix string}, :reconciliationMode string, :autoGenerateIds boolean, :idField string}
Bulk import of multiple Documents. Request processing may be synchronous. Non-existing items will be created. Note: It is possible for a subset of the Documents to be successfully updated.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/collections/dataStores/branches/documents/import Required parameters: parent Optional parameters: none Body: {:inlineSource {:documents [GoogleCloudDiscoveryengineV1betaDocument]}, :gcsSource {:inputUris [string], :dataSchema string}, :bigquerySource {:partitionDate GoogleTypeDate, :projectId string, :datasetId string, :tableId string, :gcsStagingDir string, :dataSchema string}, :errorConfig {:gcsPrefix string}, :reconciliationMode string, :autoGenerateIds boolean, :idField string} Bulk import of multiple Documents. Request processing may be synchronous. Non-existing items will be created. Note: It is possible for a subset of the Documents to be successfully updated.
(locations-collections-dataStores-branches-documents-list$ auth parameters)
Required parameters: parent
Optional parameters: pageSize, pageToken
Gets a list of Documents.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/collections/dataStores/branches/documents/list Required parameters: parent Optional parameters: pageSize, pageToken Gets a list of Documents.
(locations-collections-dataStores-branches-documents-patch$ auth
parameters
body)
Required parameters: name
Optional parameters: allowMissing
Body:
{:content {:rawBytes string, :uri string, :mimeType string}, :parentDocumentId string, :name string, :indexTime string, :schemaId string, :structData {}, :id string, :jsonData string, :derivedStructData {}}
Updates a Document.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/collections/dataStores/branches/documents/patch Required parameters: name Optional parameters: allowMissing Body: {:content {:rawBytes string, :uri string, :mimeType string}, :parentDocumentId string, :name string, :indexTime string, :schemaId string, :structData {}, :id string, :jsonData string, :derivedStructData {}} Updates a Document.
(locations-collections-dataStores-branches-documents-purge$ auth
parameters
body)
Required parameters: parent
Optional parameters: none
Body:
{:filter string, :force boolean}
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.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/collections/dataStores/branches/documents/purge Required parameters: parent Optional parameters: none Body: {:filter string, :force boolean} 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.
(locations-collections-dataStores-branches-operations-get$ auth parameters)
Required parameters: name
Optional parameters: none
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.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/collections/dataStores/branches/operations/get Required parameters: name Optional parameters: none 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.
(locations-collections-dataStores-branches-operations-list$ auth parameters)
Required parameters: name
Optional parameters: filter, pageSize, pageToken
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED
.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/collections/dataStores/branches/operations/list Required parameters: name Optional parameters: filter, pageSize, pageToken Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
(locations-collections-dataStores-completeQuery$ auth parameters)
Required parameters: dataStore
Optional parameters: query, queryModel, userPseudoId, includeTailSuggestions
Completes the specified user input with keyword suggestions.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/collections/dataStores/completeQuery Required parameters: dataStore Optional parameters: query, queryModel, userPseudoId, includeTailSuggestions Completes the specified user input with keyword suggestions.
(locations-collections-dataStores-conversations-converse$ auth parameters body)
Required parameters: name
Optional parameters: none
Body:
{:query {:input string, :context GoogleCloudDiscoveryengineV1betaConversationContext}, :servingConfig string, :conversation {:name string, :state string, :userPseudoId string, :messages [GoogleCloudDiscoveryengineV1betaConversationMessage], :startTime string, :endTime string}, :safeSearch boolean, :userLabels {}, :summarySpec {:summaryResultCount integer, :includeCitations boolean, :ignoreAdversarialQuery boolean, :ignoreNonSummarySeekingQuery boolean, :modelPromptSpec GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec, :languageCode string, :modelSpec GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec, :useSemanticChunks boolean}, :filter string, :boostSpec {:conditionBoostSpecs [GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpec]}}
Converses a conversation.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/collections/dataStores/conversations/converse Required parameters: name Optional parameters: none Body: {:query {:input string, :context GoogleCloudDiscoveryengineV1betaConversationContext}, :servingConfig string, :conversation {:name string, :state string, :userPseudoId string, :messages [GoogleCloudDiscoveryengineV1betaConversationMessage], :startTime string, :endTime string}, :safeSearch boolean, :userLabels {}, :summarySpec {:summaryResultCount integer, :includeCitations boolean, :ignoreAdversarialQuery boolean, :ignoreNonSummarySeekingQuery boolean, :modelPromptSpec GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec, :languageCode string, :modelSpec GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec, :useSemanticChunks boolean}, :filter string, :boostSpec {:conditionBoostSpecs [GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpec]}} Converses a conversation.
(locations-collections-dataStores-conversations-create$ auth parameters body)
Required parameters: parent
Optional parameters: none
Body:
{:name string, :state string, :userPseudoId string, :messages [{:userInput GoogleCloudDiscoveryengineV1betaTextInput, :reply GoogleCloudDiscoveryengineV1betaReply, :createTime string}], :startTime string, :endTime string}
Creates a Conversation. If the Conversation to create already exists, an ALREADY_EXISTS error is returned.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/collections/dataStores/conversations/create Required parameters: parent Optional parameters: none Body: {:name string, :state string, :userPseudoId string, :messages [{:userInput GoogleCloudDiscoveryengineV1betaTextInput, :reply GoogleCloudDiscoveryengineV1betaReply, :createTime string}], :startTime string, :endTime string} Creates a Conversation. If the Conversation to create already exists, an ALREADY_EXISTS error is returned.
(locations-collections-dataStores-conversations-delete$ auth parameters)
Required parameters: name
Optional parameters: none
Deletes a Conversation. If the Conversation to delete does not exist, a NOT_FOUND error is returned.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/collections/dataStores/conversations/delete Required parameters: name Optional parameters: none Deletes a Conversation. If the Conversation to delete does not exist, a NOT_FOUND error is returned.
(locations-collections-dataStores-conversations-get$ auth parameters)
Required parameters: name
Optional parameters: none
Gets a Conversation.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/collections/dataStores/conversations/get Required parameters: name Optional parameters: none Gets a Conversation.
(locations-collections-dataStores-conversations-list$ auth parameters)
Required parameters: parent
Optional parameters: pageSize, pageToken, filter, orderBy
Lists all Conversations by their parent DataStore.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/collections/dataStores/conversations/list Required parameters: parent Optional parameters: pageSize, pageToken, filter, orderBy Lists all Conversations by their parent DataStore.
(locations-collections-dataStores-conversations-patch$ auth parameters body)
Required parameters: name
Optional parameters: updateMask
Body:
{:name string, :state string, :userPseudoId string, :messages [{:userInput GoogleCloudDiscoveryengineV1betaTextInput, :reply GoogleCloudDiscoveryengineV1betaReply, :createTime string}], :startTime string, :endTime string}
Updates a Conversation. Conversation action type cannot be changed. If the Conversation to update does not exist, a NOT_FOUND error is returned.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/collections/dataStores/conversations/patch Required parameters: name Optional parameters: updateMask Body: {:name string, :state string, :userPseudoId string, :messages [{:userInput GoogleCloudDiscoveryengineV1betaTextInput, :reply GoogleCloudDiscoveryengineV1betaReply, :createTime string}], :startTime string, :endTime string} Updates a Conversation. Conversation action type cannot be changed. If the Conversation to update does not exist, a NOT_FOUND error is returned.
(locations-collections-dataStores-create$ auth parameters body)
Required parameters: parent
Optional parameters: dataStoreId, createAdvancedSiteSearch
Body:
{:displayName string, :defaultSchemaId string, :name string, :industryVertical string, :createTime string, :solutionTypes [string], :startingSchema {:structSchema {}, :jsonSchema string, :name string}, :contentConfig string, :documentProcessingConfig {:name string, :defaultParsingConfig GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig, :parsingConfigOverrides {}}}
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.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/collections/dataStores/create Required parameters: parent Optional parameters: dataStoreId, createAdvancedSiteSearch Body: {:displayName string, :defaultSchemaId string, :name string, :industryVertical string, :createTime string, :solutionTypes [string], :startingSchema {:structSchema {}, :jsonSchema string, :name string}, :contentConfig string, :documentProcessingConfig {:name string, :defaultParsingConfig GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig, :parsingConfigOverrides {}}} 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.
(locations-collections-dataStores-delete$ auth parameters)
Required parameters: name
Optional parameters: none
Deletes a DataStore.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/collections/dataStores/delete Required parameters: name Optional parameters: none Deletes a DataStore.
(locations-collections-dataStores-get$ auth parameters)
Required parameters: name
Optional parameters: none
Gets a DataStore.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/collections/dataStores/get Required parameters: name Optional parameters: none Gets a DataStore.
(locations-collections-dataStores-getSiteSearchEngine$ auth parameters)
Required parameters: name
Optional parameters: none
Gets the SiteSearchEngine.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/collections/dataStores/getSiteSearchEngine Required parameters: name Optional parameters: none Gets the SiteSearchEngine.
(locations-collections-dataStores-list$ auth parameters)
Required parameters: parent
Optional parameters: pageSize, pageToken, filter
Lists all the DataStores associated with the project.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/collections/dataStores/list Required parameters: parent Optional parameters: pageSize, pageToken, filter Lists all the DataStores associated with the project.
(locations-collections-dataStores-models-operations-get$ auth parameters)
Required parameters: name
Optional parameters: none
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.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/collections/dataStores/models/operations/get Required parameters: name Optional parameters: none 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.
(locations-collections-dataStores-models-operations-list$ auth parameters)
Required parameters: name
Optional parameters: filter, pageSize, pageToken
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED
.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/collections/dataStores/models/operations/list Required parameters: name Optional parameters: filter, pageSize, pageToken Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
(locations-collections-dataStores-operations-get$ auth parameters)
Required parameters: name
Optional parameters: none
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.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/collections/dataStores/operations/get Required parameters: name Optional parameters: none 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.
(locations-collections-dataStores-operations-list$ auth parameters)
Required parameters: name
Optional parameters: filter, pageSize, pageToken
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED
.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/collections/dataStores/operations/list Required parameters: name Optional parameters: filter, pageSize, pageToken Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
(locations-collections-dataStores-patch$ auth parameters body)
Required parameters: name
Optional parameters: updateMask
Body:
{:displayName string, :defaultSchemaId string, :name string, :industryVertical string, :createTime string, :solutionTypes [string], :startingSchema {:structSchema {}, :jsonSchema string, :name string}, :contentConfig string, :documentProcessingConfig {:name string, :defaultParsingConfig GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig, :parsingConfigOverrides {}}}
Updates a DataStore
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/collections/dataStores/patch Required parameters: name Optional parameters: updateMask Body: {:displayName string, :defaultSchemaId string, :name string, :industryVertical string, :createTime string, :solutionTypes [string], :startingSchema {:structSchema {}, :jsonSchema string, :name string}, :contentConfig string, :documentProcessingConfig {:name string, :defaultParsingConfig GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig, :parsingConfigOverrides {}}} Updates a DataStore
(locations-collections-dataStores-schemas-create$ auth parameters body)
Required parameters: parent
Optional parameters: schemaId
Body:
{:structSchema {}, :jsonSchema string, :name string}
Creates a Schema.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/collections/dataStores/schemas/create Required parameters: parent Optional parameters: schemaId Body: {:structSchema {}, :jsonSchema string, :name string} Creates a Schema.
(locations-collections-dataStores-schemas-delete$ auth parameters)
Required parameters: name
Optional parameters: none
Deletes a Schema.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/collections/dataStores/schemas/delete Required parameters: name Optional parameters: none Deletes a Schema.
(locations-collections-dataStores-schemas-get$ auth parameters)
Required parameters: name
Optional parameters: none
Gets a Schema.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/collections/dataStores/schemas/get Required parameters: name Optional parameters: none Gets a Schema.
(locations-collections-dataStores-schemas-list$ auth parameters)
Required parameters: parent
Optional parameters: pageSize, pageToken
Gets a list of Schemas.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/collections/dataStores/schemas/list Required parameters: parent Optional parameters: pageSize, pageToken Gets a list of Schemas.
(locations-collections-dataStores-schemas-operations-get$ auth parameters)
Required parameters: name
Optional parameters: none
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.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/collections/dataStores/schemas/operations/get Required parameters: name Optional parameters: none 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.
(locations-collections-dataStores-schemas-operations-list$ auth parameters)
Required parameters: name
Optional parameters: filter, pageSize, pageToken
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED
.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/collections/dataStores/schemas/operations/list Required parameters: name Optional parameters: filter, pageSize, pageToken Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
(locations-collections-dataStores-schemas-patch$ auth parameters body)
Required parameters: name
Optional parameters: allowMissing
Body:
{:structSchema {}, :jsonSchema string, :name string}
Updates a Schema.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/collections/dataStores/schemas/patch Required parameters: name Optional parameters: allowMissing Body: {:structSchema {}, :jsonSchema string, :name string} Updates a Schema.
(locations-collections-dataStores-servingConfigs-get$ auth parameters)
Required parameters: name
Optional parameters: none
Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/collections/dataStores/servingConfigs/get Required parameters: name Optional parameters: none Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.
(locations-collections-dataStores-servingConfigs-list$ auth parameters)
Required parameters: parent
Optional parameters: pageSize, pageToken
Lists all ServingConfigs linked to this dataStore.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/collections/dataStores/servingConfigs/list Required parameters: parent Optional parameters: pageSize, pageToken Lists all ServingConfigs linked to this dataStore.
(locations-collections-dataStores-servingConfigs-patch$ auth parameters body)
Required parameters: name
Optional parameters: updateMask
Body:
{:mediaConfig {:contentWatchedPercentageThreshold number, :contentWatchedSecondsThreshold number, :demotionEventType string, :contentFreshnessCutoffDays integer}, :solutionType string, :onewaySynonymsControlIds [string], :displayName string, :filterControlIds [string], :name string, :diversityLevel string, :modelId string, :createTime string, :genericConfig {:contentSearchSpec GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec}, :updateTime string, :synonymsControlIds [string], :redirectControlIds [string], :embeddingConfig {:fieldPath string}, :rankingExpression string, :dissociateControlIds [string], :ignoreControlIds [string], :replacementControlIds [string], :boostControlIds [string]}
Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/collections/dataStores/servingConfigs/patch Required parameters: name Optional parameters: updateMask Body: {:mediaConfig {:contentWatchedPercentageThreshold number, :contentWatchedSecondsThreshold number, :demotionEventType string, :contentFreshnessCutoffDays integer}, :solutionType string, :onewaySynonymsControlIds [string], :displayName string, :filterControlIds [string], :name string, :diversityLevel string, :modelId string, :createTime string, :genericConfig {:contentSearchSpec GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec}, :updateTime string, :synonymsControlIds [string], :redirectControlIds [string], :embeddingConfig {:fieldPath string}, :rankingExpression string, :dissociateControlIds [string], :ignoreControlIds [string], :replacementControlIds [string], :boostControlIds [string]} Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.
(locations-collections-dataStores-servingConfigs-recommend$ auth
parameters
body)
Required parameters: servingConfig
Optional parameters: none
Body:
{:userEvent {:eventType string, :tagIds [string], :transactionInfo GoogleCloudDiscoveryengineV1betaTransactionInfo, :sessionId string, :searchInfo GoogleCloudDiscoveryengineV1betaSearchInfo, :userPseudoId string, :panel GoogleCloudDiscoveryengineV1betaPanelInfo, :documents [GoogleCloudDiscoveryengineV1betaDocumentInfo], :directUserRequest boolean, :filter string, :completionInfo GoogleCloudDiscoveryengineV1betaCompletionInfo, :mediaInfo GoogleCloudDiscoveryengineV1betaMediaInfo, :pageInfo GoogleCloudDiscoveryengineV1betaPageInfo, :eventTime string, :promotionIds [string], :attributes {}, :attributionToken string, :userInfo GoogleCloudDiscoveryengineV1betaUserInfo}, :pageSize integer, :filter string, :validateOnly boolean, :params {}, :userLabels {}}
Makes a recommendation, which requires a contextual user event.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/collections/dataStores/servingConfigs/recommend Required parameters: servingConfig Optional parameters: none Body: {:userEvent {:eventType string, :tagIds [string], :transactionInfo GoogleCloudDiscoveryengineV1betaTransactionInfo, :sessionId string, :searchInfo GoogleCloudDiscoveryengineV1betaSearchInfo, :userPseudoId string, :panel GoogleCloudDiscoveryengineV1betaPanelInfo, :documents [GoogleCloudDiscoveryengineV1betaDocumentInfo], :directUserRequest boolean, :filter string, :completionInfo GoogleCloudDiscoveryengineV1betaCompletionInfo, :mediaInfo GoogleCloudDiscoveryengineV1betaMediaInfo, :pageInfo GoogleCloudDiscoveryengineV1betaPageInfo, :eventTime string, :promotionIds [string], :attributes {}, :attributionToken string, :userInfo GoogleCloudDiscoveryengineV1betaUserInfo}, :pageSize integer, :filter string, :validateOnly boolean, :params {}, :userLabels {}} Makes a recommendation, which requires a contextual user event.
(locations-collections-dataStores-servingConfigs-search$ auth parameters body)
Required parameters: servingConfig
Optional parameters: none
Body:
{:canonicalFilter string, :contentSearchSpec {:snippetSpec GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSnippetSpec, :summarySpec GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec, :extractiveContentSpec GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec}, :offset integer, :imageQuery {:imageBytes string}, :params {}, :userPseudoId string, :safeSearch boolean, :pageToken string, :facetSpecs [{:facetKey GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpecFacetKey, :limit integer, :excludedFilterKeys [string], :enableDynamicPosition boolean}], :embeddingSpec {:embeddingVectors [GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpecEmbeddingVector]}, :filter string, :pageSize integer, :query string, :rankingExpression string, :branch string, :userLabels {}, :dataStoreSpecs [{:dataStore string}], :queryExpansionSpec {:condition string, :pinUnexpandedResults boolean}, :boostSpec {:conditionBoostSpecs [GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpec]}, :spellCorrectionSpec {:mode string}, :userInfo {:userId string, :userAgent string}, :orderBy string}
Performs a search.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/collections/dataStores/servingConfigs/search Required parameters: servingConfig Optional parameters: none Body: {:canonicalFilter string, :contentSearchSpec {:snippetSpec GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSnippetSpec, :summarySpec GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec, :extractiveContentSpec GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec}, :offset integer, :imageQuery {:imageBytes string}, :params {}, :userPseudoId string, :safeSearch boolean, :pageToken string, :facetSpecs [{:facetKey GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpecFacetKey, :limit integer, :excludedFilterKeys [string], :enableDynamicPosition boolean}], :embeddingSpec {:embeddingVectors [GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpecEmbeddingVector]}, :filter string, :pageSize integer, :query string, :rankingExpression string, :branch string, :userLabels {}, :dataStoreSpecs [{:dataStore string}], :queryExpansionSpec {:condition string, :pinUnexpandedResults boolean}, :boostSpec {:conditionBoostSpecs [GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpec]}, :spellCorrectionSpec {:mode string}, :userInfo {:userId string, :userAgent string}, :orderBy string} Performs a search.
(locations-collections-dataStores-siteSearchEngine-batchVerifyTargetSites$
auth
parameters
body)
Required parameters: parent
Optional parameters: none
Body:
{}
Verify target sites' ownership and validity. This API sends all the target sites under site search engine for verification.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/collections/dataStores/siteSearchEngine/batchVerifyTargetSites Required parameters: parent Optional parameters: none Body: {} Verify target sites' ownership and validity. This API sends all the target sites under site search engine for verification.
(locations-collections-dataStores-siteSearchEngine-disableAdvancedSiteSearch$
auth
parameters
body)
Required parameters: siteSearchEngine
Optional parameters: none
Body:
{}
Downgrade from advanced site search to basic site search.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/collections/dataStores/siteSearchEngine/disableAdvancedSiteSearch Required parameters: siteSearchEngine Optional parameters: none Body: {} Downgrade from advanced site search to basic site search.
(locations-collections-dataStores-siteSearchEngine-enableAdvancedSiteSearch$
auth
parameters
body)
Required parameters: siteSearchEngine
Optional parameters: none
Body:
{}
Upgrade from basic site search to advanced site search.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/collections/dataStores/siteSearchEngine/enableAdvancedSiteSearch Required parameters: siteSearchEngine Optional parameters: none Body: {} Upgrade from basic site search to advanced site search.
(locations-collections-dataStores-siteSearchEngine-fetchDomainVerificationStatus$
auth
parameters)
Required parameters: siteSearchEngine
Optional parameters: pageSize, pageToken
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.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/collections/dataStores/siteSearchEngine/fetchDomainVerificationStatus Required parameters: siteSearchEngine Optional parameters: pageSize, pageToken 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.
(locations-collections-dataStores-siteSearchEngine-operations-get$ auth
parameters)
Required parameters: name
Optional parameters: none
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.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/collections/dataStores/siteSearchEngine/operations/get Required parameters: name Optional parameters: none 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.
(locations-collections-dataStores-siteSearchEngine-operations-list$ auth
parameters)
Required parameters: name
Optional parameters: filter, pageSize, pageToken
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED
.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/collections/dataStores/siteSearchEngine/operations/list Required parameters: name Optional parameters: filter, pageSize, pageToken Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
(locations-collections-dataStores-siteSearchEngine-recrawlUris$ auth
parameters
body)
Required parameters: siteSearchEngine
Optional parameters: none
Body:
{:uris [string]}
Request on-demand recrawl for a list of URIs.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/collections/dataStores/siteSearchEngine/recrawlUris Required parameters: siteSearchEngine Optional parameters: none Body: {:uris [string]} Request on-demand recrawl for a list of URIs.
(locations-collections-dataStores-siteSearchEngine-targetSites-batchCreate$
auth
parameters
body)
Required parameters: parent
Optional parameters: none
Body:
{:requests [{:parent string, :targetSite GoogleCloudDiscoveryengineV1betaTargetSite}]}
Creates TargetSite in a batch.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/collections/dataStores/siteSearchEngine/targetSites/batchCreate Required parameters: parent Optional parameters: none Body: {:requests [{:parent string, :targetSite GoogleCloudDiscoveryengineV1betaTargetSite}]} Creates TargetSite in a batch.
(locations-collections-dataStores-siteSearchEngine-targetSites-create$
auth
parameters
body)
Required parameters: parent
Optional parameters: none
Body:
{:providedUriPattern string, :exactMatch boolean, :name string, :indexingStatus string, :type string, :updateTime string, :siteVerificationInfo {:siteVerificationState string, :verifyTime string}, :failureReason {:quotaFailure GoogleCloudDiscoveryengineV1betaTargetSiteFailureReasonQuotaFailure}, :generatedUriPattern string}
Creates a TargetSite.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/collections/dataStores/siteSearchEngine/targetSites/create Required parameters: parent Optional parameters: none Body: {:providedUriPattern string, :exactMatch boolean, :name string, :indexingStatus string, :type string, :updateTime string, :siteVerificationInfo {:siteVerificationState string, :verifyTime string}, :failureReason {:quotaFailure GoogleCloudDiscoveryengineV1betaTargetSiteFailureReasonQuotaFailure}, :generatedUriPattern string} Creates a TargetSite.
(locations-collections-dataStores-siteSearchEngine-targetSites-delete$
auth
parameters)
Required parameters: name
Optional parameters: none
Deletes a TargetSite.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/collections/dataStores/siteSearchEngine/targetSites/delete Required parameters: name Optional parameters: none Deletes a TargetSite.
(locations-collections-dataStores-siteSearchEngine-targetSites-get$ auth
parameters)
Required parameters: name
Optional parameters: none
Gets a TargetSite.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/collections/dataStores/siteSearchEngine/targetSites/get Required parameters: name Optional parameters: none Gets a TargetSite.
(locations-collections-dataStores-siteSearchEngine-targetSites-list$ auth
parameters)
Required parameters: parent
Optional parameters: pageSize, pageToken
Gets a list of TargetSites.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/collections/dataStores/siteSearchEngine/targetSites/list Required parameters: parent Optional parameters: pageSize, pageToken Gets a list of TargetSites.
(locations-collections-dataStores-siteSearchEngine-targetSites-operations-get$
auth
parameters)
Required parameters: name
Optional parameters: none
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.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/collections/dataStores/siteSearchEngine/targetSites/operations/get Required parameters: name Optional parameters: none 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.
(locations-collections-dataStores-siteSearchEngine-targetSites-operations-list$
auth
parameters)
Required parameters: name
Optional parameters: filter, pageSize, pageToken
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED
.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/collections/dataStores/siteSearchEngine/targetSites/operations/list Required parameters: name Optional parameters: filter, pageSize, pageToken Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
(locations-collections-dataStores-siteSearchEngine-targetSites-patch$ auth
parameters
body)
Required parameters: name
Optional parameters: none
Body:
{:providedUriPattern string, :exactMatch boolean, :name string, :indexingStatus string, :type string, :updateTime string, :siteVerificationInfo {:siteVerificationState string, :verifyTime string}, :failureReason {:quotaFailure GoogleCloudDiscoveryengineV1betaTargetSiteFailureReasonQuotaFailure}, :generatedUriPattern string}
Updates a TargetSite.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/collections/dataStores/siteSearchEngine/targetSites/patch Required parameters: name Optional parameters: none Body: {:providedUriPattern string, :exactMatch boolean, :name string, :indexingStatus string, :type string, :updateTime string, :siteVerificationInfo {:siteVerificationState string, :verifyTime string}, :failureReason {:quotaFailure GoogleCloudDiscoveryengineV1betaTargetSiteFailureReasonQuotaFailure}, :generatedUriPattern string} Updates a TargetSite.
(locations-collections-dataStores-suggestionDenyListEntries-import$ auth
parameters
body)
Required parameters: parent
Optional parameters: none
Body:
{:inlineSource {:entries [GoogleCloudDiscoveryengineV1betaSuggestionDenyListEntry]}, :gcsSource {:inputUris [string], :dataSchema string}}
Imports all SuggestionDenyListEntry for a DataStore.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/collections/dataStores/suggestionDenyListEntries/import Required parameters: parent Optional parameters: none Body: {:inlineSource {:entries [GoogleCloudDiscoveryengineV1betaSuggestionDenyListEntry]}, :gcsSource {:inputUris [string], :dataSchema string}} Imports all SuggestionDenyListEntry for a DataStore.
(locations-collections-dataStores-suggestionDenyListEntries-purge$ auth
parameters
body)
Required parameters: parent
Optional parameters: none
Body:
{}
Permanently deletes all SuggestionDenyListEntry for a DataStore.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/collections/dataStores/suggestionDenyListEntries/purge Required parameters: parent Optional parameters: none Body: {} Permanently deletes all SuggestionDenyListEntry for a DataStore.
(locations-collections-dataStores-trainCustomModel$ auth parameters body)
Required parameters: dataStore
Optional parameters: none
Body:
{:gcsTrainingInput {:corpusDataPath string, :queryDataPath string, :trainDataPath string, :testDataPath string}, :modelType string, :errorConfig {:gcsPrefix string}}
Trains a custom model.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/collections/dataStores/trainCustomModel Required parameters: dataStore Optional parameters: none Body: {:gcsTrainingInput {:corpusDataPath string, :queryDataPath string, :trainDataPath string, :testDataPath string}, :modelType string, :errorConfig {:gcsPrefix string}} Trains a custom model.
(locations-collections-dataStores-userEvents-collect$ auth parameters)
Required parameters: parent
Optional parameters: userEvent, uri, ets
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.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/collections/dataStores/userEvents/collect Required parameters: parent Optional parameters: userEvent, uri, ets 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.
(locations-collections-dataStores-userEvents-import$ auth parameters body)
Required parameters: parent
Optional parameters: none
Body:
{:inlineSource {:userEvents [GoogleCloudDiscoveryengineV1betaUserEvent]}, :gcsSource {:inputUris [string], :dataSchema string}, :bigquerySource {:partitionDate GoogleTypeDate, :projectId string, :datasetId string, :tableId string, :gcsStagingDir string, :dataSchema string}, :errorConfig {:gcsPrefix string}}
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.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/collections/dataStores/userEvents/import Required parameters: parent Optional parameters: none Body: {:inlineSource {:userEvents [GoogleCloudDiscoveryengineV1betaUserEvent]}, :gcsSource {:inputUris [string], :dataSchema string}, :bigquerySource {:partitionDate GoogleTypeDate, :projectId string, :datasetId string, :tableId string, :gcsStagingDir string, :dataSchema string}, :errorConfig {:gcsPrefix string}} 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.
(locations-collections-dataStores-userEvents-write$ auth parameters body)
Required parameters: parent
Optional parameters: none
Body:
{:eventType string, :tagIds [string], :transactionInfo {:value number, :currency string, :transactionId string, :tax number, :cost number, :discountValue number}, :sessionId string, :searchInfo {:searchQuery string, :orderBy string, :offset integer}, :userPseudoId string, :panel {:panelId string, :displayName string, :panelPosition integer, :totalPanels integer}, :documents [{:id string, :name string, :uri string, :quantity integer, :promotionIds [string]}], :directUserRequest boolean, :filter string, :completionInfo {:selectedSuggestion string, :selectedPosition integer}, :mediaInfo {:mediaProgressDuration string, :mediaProgressPercentage number}, :pageInfo {:pageviewId string, :pageCategory string, :uri string, :referrerUri string}, :eventTime string, :promotionIds [string], :attributes {}, :attributionToken string, :userInfo {:userId string, :userAgent string}}
Writes a single user event.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/collections/dataStores/userEvents/write Required parameters: parent Optional parameters: none Body: {:eventType string, :tagIds [string], :transactionInfo {:value number, :currency string, :transactionId string, :tax number, :cost number, :discountValue number}, :sessionId string, :searchInfo {:searchQuery string, :orderBy string, :offset integer}, :userPseudoId string, :panel {:panelId string, :displayName string, :panelPosition integer, :totalPanels integer}, :documents [{:id string, :name string, :uri string, :quantity integer, :promotionIds [string]}], :directUserRequest boolean, :filter string, :completionInfo {:selectedSuggestion string, :selectedPosition integer}, :mediaInfo {:mediaProgressDuration string, :mediaProgressPercentage number}, :pageInfo {:pageviewId string, :pageCategory string, :uri string, :referrerUri string}, :eventTime string, :promotionIds [string], :attributes {}, :attributionToken string, :userInfo {:userId string, :userAgent string}} Writes a single user event.
(locations-collections-engines-conversations-converse$ auth parameters body)
Required parameters: name
Optional parameters: none
Body:
{:query {:input string, :context GoogleCloudDiscoveryengineV1betaConversationContext}, :servingConfig string, :conversation {:name string, :state string, :userPseudoId string, :messages [GoogleCloudDiscoveryengineV1betaConversationMessage], :startTime string, :endTime string}, :safeSearch boolean, :userLabels {}, :summarySpec {:summaryResultCount integer, :includeCitations boolean, :ignoreAdversarialQuery boolean, :ignoreNonSummarySeekingQuery boolean, :modelPromptSpec GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec, :languageCode string, :modelSpec GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec, :useSemanticChunks boolean}, :filter string, :boostSpec {:conditionBoostSpecs [GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpec]}}
Converses a conversation.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/collections/engines/conversations/converse Required parameters: name Optional parameters: none Body: {:query {:input string, :context GoogleCloudDiscoveryengineV1betaConversationContext}, :servingConfig string, :conversation {:name string, :state string, :userPseudoId string, :messages [GoogleCloudDiscoveryengineV1betaConversationMessage], :startTime string, :endTime string}, :safeSearch boolean, :userLabels {}, :summarySpec {:summaryResultCount integer, :includeCitations boolean, :ignoreAdversarialQuery boolean, :ignoreNonSummarySeekingQuery boolean, :modelPromptSpec GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec, :languageCode string, :modelSpec GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec, :useSemanticChunks boolean}, :filter string, :boostSpec {:conditionBoostSpecs [GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpec]}} Converses a conversation.
(locations-collections-engines-conversations-create$ auth parameters body)
Required parameters: parent
Optional parameters: none
Body:
{:name string, :state string, :userPseudoId string, :messages [{:userInput GoogleCloudDiscoveryengineV1betaTextInput, :reply GoogleCloudDiscoveryengineV1betaReply, :createTime string}], :startTime string, :endTime string}
Creates a Conversation. If the Conversation to create already exists, an ALREADY_EXISTS error is returned.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/collections/engines/conversations/create Required parameters: parent Optional parameters: none Body: {:name string, :state string, :userPseudoId string, :messages [{:userInput GoogleCloudDiscoveryengineV1betaTextInput, :reply GoogleCloudDiscoveryengineV1betaReply, :createTime string}], :startTime string, :endTime string} Creates a Conversation. If the Conversation to create already exists, an ALREADY_EXISTS error is returned.
(locations-collections-engines-conversations-delete$ auth parameters)
Required parameters: name
Optional parameters: none
Deletes a Conversation. If the Conversation to delete does not exist, a NOT_FOUND error is returned.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/collections/engines/conversations/delete Required parameters: name Optional parameters: none Deletes a Conversation. If the Conversation to delete does not exist, a NOT_FOUND error is returned.
(locations-collections-engines-conversations-get$ auth parameters)
Required parameters: name
Optional parameters: none
Gets a Conversation.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/collections/engines/conversations/get Required parameters: name Optional parameters: none Gets a Conversation.
(locations-collections-engines-conversations-list$ auth parameters)
Required parameters: parent
Optional parameters: pageSize, pageToken, filter, orderBy
Lists all Conversations by their parent DataStore.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/collections/engines/conversations/list Required parameters: parent Optional parameters: pageSize, pageToken, filter, orderBy Lists all Conversations by their parent DataStore.
(locations-collections-engines-conversations-patch$ auth parameters body)
Required parameters: name
Optional parameters: updateMask
Body:
{:name string, :state string, :userPseudoId string, :messages [{:userInput GoogleCloudDiscoveryengineV1betaTextInput, :reply GoogleCloudDiscoveryengineV1betaReply, :createTime string}], :startTime string, :endTime string}
Updates a Conversation. Conversation action type cannot be changed. If the Conversation to update does not exist, a NOT_FOUND error is returned.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/collections/engines/conversations/patch Required parameters: name Optional parameters: updateMask Body: {:name string, :state string, :userPseudoId string, :messages [{:userInput GoogleCloudDiscoveryengineV1betaTextInput, :reply GoogleCloudDiscoveryengineV1betaReply, :createTime string}], :startTime string, :endTime string} Updates a Conversation. Conversation action type cannot be changed. If the Conversation to update does not exist, a NOT_FOUND error is returned.
(locations-collections-engines-create$ auth parameters body)
Required parameters: parent
Optional parameters: engineId
Body:
{:solutionType string, :displayName string, :name string, :industryVertical string, :createTime string, :updateTime string, :dataStoreIds [string], :searchEngineConfig {:searchTier string, :searchAddOns [string]}, :chatEngineMetadata {:dialogflowAgent string}, :chatEngineConfig {:agentCreationConfig GoogleCloudDiscoveryengineV1betaEngineChatEngineConfigAgentCreationConfig, :dialogflowAgentToLink string}, :commonConfig {:companyName string}}
Creates a Engine.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/collections/engines/create Required parameters: parent Optional parameters: engineId Body: {:solutionType string, :displayName string, :name string, :industryVertical string, :createTime string, :updateTime string, :dataStoreIds [string], :searchEngineConfig {:searchTier string, :searchAddOns [string]}, :chatEngineMetadata {:dialogflowAgent string}, :chatEngineConfig {:agentCreationConfig GoogleCloudDiscoveryengineV1betaEngineChatEngineConfigAgentCreationConfig, :dialogflowAgentToLink string}, :commonConfig {:companyName string}} Creates a Engine.
(locations-collections-engines-delete$ auth parameters)
Required parameters: name
Optional parameters: none
Deletes a Engine.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/collections/engines/delete Required parameters: name Optional parameters: none Deletes a Engine.
(locations-collections-engines-get$ auth parameters)
Required parameters: name
Optional parameters: none
Gets a Engine.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/collections/engines/get Required parameters: name Optional parameters: none Gets a Engine.
(locations-collections-engines-list$ auth parameters)
Required parameters: parent
Optional parameters: pageSize, pageToken, filter
Lists all the Engines associated with the project.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/collections/engines/list Required parameters: parent Optional parameters: pageSize, pageToken, filter Lists all the Engines associated with the project.
(locations-collections-engines-operations-get$ auth parameters)
Required parameters: name
Optional parameters: none
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.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/collections/engines/operations/get Required parameters: name Optional parameters: none 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.
(locations-collections-engines-operations-list$ auth parameters)
Required parameters: name
Optional parameters: filter, pageSize, pageToken
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED
.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/collections/engines/operations/list Required parameters: name Optional parameters: filter, pageSize, pageToken Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
(locations-collections-engines-patch$ auth parameters body)
Required parameters: name
Optional parameters: updateMask
Body:
{:solutionType string, :displayName string, :name string, :industryVertical string, :createTime string, :updateTime string, :dataStoreIds [string], :searchEngineConfig {:searchTier string, :searchAddOns [string]}, :chatEngineMetadata {:dialogflowAgent string}, :chatEngineConfig {:agentCreationConfig GoogleCloudDiscoveryengineV1betaEngineChatEngineConfigAgentCreationConfig, :dialogflowAgentToLink string}, :commonConfig {:companyName string}}
Updates an Engine
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/collections/engines/patch Required parameters: name Optional parameters: updateMask Body: {:solutionType string, :displayName string, :name string, :industryVertical string, :createTime string, :updateTime string, :dataStoreIds [string], :searchEngineConfig {:searchTier string, :searchAddOns [string]}, :chatEngineMetadata {:dialogflowAgent string}, :chatEngineConfig {:agentCreationConfig GoogleCloudDiscoveryengineV1betaEngineChatEngineConfigAgentCreationConfig, :dialogflowAgentToLink string}, :commonConfig {:companyName string}} Updates an Engine
(locations-collections-engines-servingConfigs-get$ auth parameters)
Required parameters: name
Optional parameters: none
Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/collections/engines/servingConfigs/get Required parameters: name Optional parameters: none Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.
(locations-collections-engines-servingConfigs-list$ auth parameters)
Required parameters: parent
Optional parameters: pageSize, pageToken
Lists all ServingConfigs linked to this dataStore.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/collections/engines/servingConfigs/list Required parameters: parent Optional parameters: pageSize, pageToken Lists all ServingConfigs linked to this dataStore.
(locations-collections-engines-servingConfigs-patch$ auth parameters body)
Required parameters: name
Optional parameters: updateMask
Body:
{:mediaConfig {:contentWatchedPercentageThreshold number, :contentWatchedSecondsThreshold number, :demotionEventType string, :contentFreshnessCutoffDays integer}, :solutionType string, :onewaySynonymsControlIds [string], :displayName string, :filterControlIds [string], :name string, :diversityLevel string, :modelId string, :createTime string, :genericConfig {:contentSearchSpec GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec}, :updateTime string, :synonymsControlIds [string], :redirectControlIds [string], :embeddingConfig {:fieldPath string}, :rankingExpression string, :dissociateControlIds [string], :ignoreControlIds [string], :replacementControlIds [string], :boostControlIds [string]}
Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/collections/engines/servingConfigs/patch Required parameters: name Optional parameters: updateMask Body: {:mediaConfig {:contentWatchedPercentageThreshold number, :contentWatchedSecondsThreshold number, :demotionEventType string, :contentFreshnessCutoffDays integer}, :solutionType string, :onewaySynonymsControlIds [string], :displayName string, :filterControlIds [string], :name string, :diversityLevel string, :modelId string, :createTime string, :genericConfig {:contentSearchSpec GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec}, :updateTime string, :synonymsControlIds [string], :redirectControlIds [string], :embeddingConfig {:fieldPath string}, :rankingExpression string, :dissociateControlIds [string], :ignoreControlIds [string], :replacementControlIds [string], :boostControlIds [string]} Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.
(locations-collections-engines-servingConfigs-recommend$ auth parameters body)
Required parameters: servingConfig
Optional parameters: none
Body:
{:userEvent {:eventType string, :tagIds [string], :transactionInfo GoogleCloudDiscoveryengineV1betaTransactionInfo, :sessionId string, :searchInfo GoogleCloudDiscoveryengineV1betaSearchInfo, :userPseudoId string, :panel GoogleCloudDiscoveryengineV1betaPanelInfo, :documents [GoogleCloudDiscoveryengineV1betaDocumentInfo], :directUserRequest boolean, :filter string, :completionInfo GoogleCloudDiscoveryengineV1betaCompletionInfo, :mediaInfo GoogleCloudDiscoveryengineV1betaMediaInfo, :pageInfo GoogleCloudDiscoveryengineV1betaPageInfo, :eventTime string, :promotionIds [string], :attributes {}, :attributionToken string, :userInfo GoogleCloudDiscoveryengineV1betaUserInfo}, :pageSize integer, :filter string, :validateOnly boolean, :params {}, :userLabels {}}
Makes a recommendation, which requires a contextual user event.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/collections/engines/servingConfigs/recommend Required parameters: servingConfig Optional parameters: none Body: {:userEvent {:eventType string, :tagIds [string], :transactionInfo GoogleCloudDiscoveryengineV1betaTransactionInfo, :sessionId string, :searchInfo GoogleCloudDiscoveryengineV1betaSearchInfo, :userPseudoId string, :panel GoogleCloudDiscoveryengineV1betaPanelInfo, :documents [GoogleCloudDiscoveryengineV1betaDocumentInfo], :directUserRequest boolean, :filter string, :completionInfo GoogleCloudDiscoveryengineV1betaCompletionInfo, :mediaInfo GoogleCloudDiscoveryengineV1betaMediaInfo, :pageInfo GoogleCloudDiscoveryengineV1betaPageInfo, :eventTime string, :promotionIds [string], :attributes {}, :attributionToken string, :userInfo GoogleCloudDiscoveryengineV1betaUserInfo}, :pageSize integer, :filter string, :validateOnly boolean, :params {}, :userLabels {}} Makes a recommendation, which requires a contextual user event.
(locations-collections-engines-servingConfigs-search$ auth parameters body)
Required parameters: servingConfig
Optional parameters: none
Body:
{:canonicalFilter string, :contentSearchSpec {:snippetSpec GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSnippetSpec, :summarySpec GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec, :extractiveContentSpec GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec}, :offset integer, :imageQuery {:imageBytes string}, :params {}, :userPseudoId string, :safeSearch boolean, :pageToken string, :facetSpecs [{:facetKey GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpecFacetKey, :limit integer, :excludedFilterKeys [string], :enableDynamicPosition boolean}], :embeddingSpec {:embeddingVectors [GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpecEmbeddingVector]}, :filter string, :pageSize integer, :query string, :rankingExpression string, :branch string, :userLabels {}, :dataStoreSpecs [{:dataStore string}], :queryExpansionSpec {:condition string, :pinUnexpandedResults boolean}, :boostSpec {:conditionBoostSpecs [GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpec]}, :spellCorrectionSpec {:mode string}, :userInfo {:userId string, :userAgent string}, :orderBy string}
Performs a search.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/collections/engines/servingConfigs/search Required parameters: servingConfig Optional parameters: none Body: {:canonicalFilter string, :contentSearchSpec {:snippetSpec GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSnippetSpec, :summarySpec GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec, :extractiveContentSpec GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec}, :offset integer, :imageQuery {:imageBytes string}, :params {}, :userPseudoId string, :safeSearch boolean, :pageToken string, :facetSpecs [{:facetKey GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpecFacetKey, :limit integer, :excludedFilterKeys [string], :enableDynamicPosition boolean}], :embeddingSpec {:embeddingVectors [GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpecEmbeddingVector]}, :filter string, :pageSize integer, :query string, :rankingExpression string, :branch string, :userLabels {}, :dataStoreSpecs [{:dataStore string}], :queryExpansionSpec {:condition string, :pinUnexpandedResults boolean}, :boostSpec {:conditionBoostSpecs [GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpec]}, :spellCorrectionSpec {:mode string}, :userInfo {:userId string, :userAgent string}, :orderBy string} Performs a search.
(locations-collections-operations-get$ auth parameters)
Required parameters: name
Optional parameters: none
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.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/collections/operations/get Required parameters: name Optional parameters: none 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.
(locations-collections-operations-list$ auth parameters)
Required parameters: name
Optional parameters: filter, pageSize, pageToken
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED
.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/collections/operations/list Required parameters: name Optional parameters: filter, pageSize, pageToken Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
(locations-dataStores-branches-documents-create$ auth parameters body)
Required parameters: parent
Optional parameters: documentId
Body:
{:content {:rawBytes string, :uri string, :mimeType string}, :parentDocumentId string, :name string, :indexTime string, :schemaId string, :structData {}, :id string, :jsonData string, :derivedStructData {}}
Creates a Document.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/dataStores/branches/documents/create Required parameters: parent Optional parameters: documentId Body: {:content {:rawBytes string, :uri string, :mimeType string}, :parentDocumentId string, :name string, :indexTime string, :schemaId string, :structData {}, :id string, :jsonData string, :derivedStructData {}} Creates a Document.
(locations-dataStores-branches-documents-delete$ auth parameters)
Required parameters: name
Optional parameters: none
Deletes a Document.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/dataStores/branches/documents/delete Required parameters: name Optional parameters: none Deletes a Document.
(locations-dataStores-branches-documents-get$ auth parameters)
Required parameters: name
Optional parameters: none
Gets a Document.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/dataStores/branches/documents/get Required parameters: name Optional parameters: none Gets a Document.
(locations-dataStores-branches-documents-import$ auth parameters body)
Required parameters: parent
Optional parameters: none
Body:
{:inlineSource {:documents [GoogleCloudDiscoveryengineV1betaDocument]}, :gcsSource {:inputUris [string], :dataSchema string}, :bigquerySource {:partitionDate GoogleTypeDate, :projectId string, :datasetId string, :tableId string, :gcsStagingDir string, :dataSchema string}, :errorConfig {:gcsPrefix string}, :reconciliationMode string, :autoGenerateIds boolean, :idField string}
Bulk import of multiple Documents. Request processing may be synchronous. Non-existing items will be created. Note: It is possible for a subset of the Documents to be successfully updated.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/dataStores/branches/documents/import Required parameters: parent Optional parameters: none Body: {:inlineSource {:documents [GoogleCloudDiscoveryengineV1betaDocument]}, :gcsSource {:inputUris [string], :dataSchema string}, :bigquerySource {:partitionDate GoogleTypeDate, :projectId string, :datasetId string, :tableId string, :gcsStagingDir string, :dataSchema string}, :errorConfig {:gcsPrefix string}, :reconciliationMode string, :autoGenerateIds boolean, :idField string} Bulk import of multiple Documents. Request processing may be synchronous. Non-existing items will be created. Note: It is possible for a subset of the Documents to be successfully updated.
(locations-dataStores-branches-documents-list$ auth parameters)
Required parameters: parent
Optional parameters: pageSize, pageToken
Gets a list of Documents.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/dataStores/branches/documents/list Required parameters: parent Optional parameters: pageSize, pageToken Gets a list of Documents.
(locations-dataStores-branches-documents-patch$ auth parameters body)
Required parameters: name
Optional parameters: allowMissing
Body:
{:content {:rawBytes string, :uri string, :mimeType string}, :parentDocumentId string, :name string, :indexTime string, :schemaId string, :structData {}, :id string, :jsonData string, :derivedStructData {}}
Updates a Document.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/dataStores/branches/documents/patch Required parameters: name Optional parameters: allowMissing Body: {:content {:rawBytes string, :uri string, :mimeType string}, :parentDocumentId string, :name string, :indexTime string, :schemaId string, :structData {}, :id string, :jsonData string, :derivedStructData {}} Updates a Document.
(locations-dataStores-branches-documents-purge$ auth parameters body)
Required parameters: parent
Optional parameters: none
Body:
{:filter string, :force boolean}
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.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/dataStores/branches/documents/purge Required parameters: parent Optional parameters: none Body: {:filter string, :force boolean} 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.
(locations-dataStores-branches-operations-get$ auth parameters)
Required parameters: name
Optional parameters: none
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.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/dataStores/branches/operations/get Required parameters: name Optional parameters: none 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.
(locations-dataStores-branches-operations-list$ auth parameters)
Required parameters: name
Optional parameters: filter, pageSize, pageToken
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED
.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/dataStores/branches/operations/list Required parameters: name Optional parameters: filter, pageSize, pageToken Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
(locations-dataStores-completeQuery$ auth parameters)
Required parameters: dataStore
Optional parameters: query, queryModel, userPseudoId, includeTailSuggestions
Completes the specified user input with keyword suggestions.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/dataStores/completeQuery Required parameters: dataStore Optional parameters: query, queryModel, userPseudoId, includeTailSuggestions Completes the specified user input with keyword suggestions.
(locations-dataStores-conversations-converse$ auth parameters body)
Required parameters: name
Optional parameters: none
Body:
{:query {:input string, :context GoogleCloudDiscoveryengineV1betaConversationContext}, :servingConfig string, :conversation {:name string, :state string, :userPseudoId string, :messages [GoogleCloudDiscoveryengineV1betaConversationMessage], :startTime string, :endTime string}, :safeSearch boolean, :userLabels {}, :summarySpec {:summaryResultCount integer, :includeCitations boolean, :ignoreAdversarialQuery boolean, :ignoreNonSummarySeekingQuery boolean, :modelPromptSpec GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec, :languageCode string, :modelSpec GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec, :useSemanticChunks boolean}, :filter string, :boostSpec {:conditionBoostSpecs [GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpec]}}
Converses a conversation.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/dataStores/conversations/converse Required parameters: name Optional parameters: none Body: {:query {:input string, :context GoogleCloudDiscoveryengineV1betaConversationContext}, :servingConfig string, :conversation {:name string, :state string, :userPseudoId string, :messages [GoogleCloudDiscoveryengineV1betaConversationMessage], :startTime string, :endTime string}, :safeSearch boolean, :userLabels {}, :summarySpec {:summaryResultCount integer, :includeCitations boolean, :ignoreAdversarialQuery boolean, :ignoreNonSummarySeekingQuery boolean, :modelPromptSpec GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec, :languageCode string, :modelSpec GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec, :useSemanticChunks boolean}, :filter string, :boostSpec {:conditionBoostSpecs [GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpec]}} Converses a conversation.
(locations-dataStores-conversations-create$ auth parameters body)
Required parameters: parent
Optional parameters: none
Body:
{:name string, :state string, :userPseudoId string, :messages [{:userInput GoogleCloudDiscoveryengineV1betaTextInput, :reply GoogleCloudDiscoveryengineV1betaReply, :createTime string}], :startTime string, :endTime string}
Creates a Conversation. If the Conversation to create already exists, an ALREADY_EXISTS error is returned.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/dataStores/conversations/create Required parameters: parent Optional parameters: none Body: {:name string, :state string, :userPseudoId string, :messages [{:userInput GoogleCloudDiscoveryengineV1betaTextInput, :reply GoogleCloudDiscoveryengineV1betaReply, :createTime string}], :startTime string, :endTime string} Creates a Conversation. If the Conversation to create already exists, an ALREADY_EXISTS error is returned.
(locations-dataStores-conversations-delete$ auth parameters)
Required parameters: name
Optional parameters: none
Deletes a Conversation. If the Conversation to delete does not exist, a NOT_FOUND error is returned.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/dataStores/conversations/delete Required parameters: name Optional parameters: none Deletes a Conversation. If the Conversation to delete does not exist, a NOT_FOUND error is returned.
(locations-dataStores-conversations-get$ auth parameters)
Required parameters: name
Optional parameters: none
Gets a Conversation.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/dataStores/conversations/get Required parameters: name Optional parameters: none Gets a Conversation.
(locations-dataStores-conversations-list$ auth parameters)
Required parameters: parent
Optional parameters: pageSize, pageToken, filter, orderBy
Lists all Conversations by their parent DataStore.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/dataStores/conversations/list Required parameters: parent Optional parameters: pageSize, pageToken, filter, orderBy Lists all Conversations by their parent DataStore.
(locations-dataStores-conversations-patch$ auth parameters body)
Required parameters: name
Optional parameters: updateMask
Body:
{:name string, :state string, :userPseudoId string, :messages [{:userInput GoogleCloudDiscoveryengineV1betaTextInput, :reply GoogleCloudDiscoveryengineV1betaReply, :createTime string}], :startTime string, :endTime string}
Updates a Conversation. Conversation action type cannot be changed. If the Conversation to update does not exist, a NOT_FOUND error is returned.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/dataStores/conversations/patch Required parameters: name Optional parameters: updateMask Body: {:name string, :state string, :userPseudoId string, :messages [{:userInput GoogleCloudDiscoveryengineV1betaTextInput, :reply GoogleCloudDiscoveryengineV1betaReply, :createTime string}], :startTime string, :endTime string} Updates a Conversation. Conversation action type cannot be changed. If the Conversation to update does not exist, a NOT_FOUND error is returned.
(locations-dataStores-create$ auth parameters body)
Required parameters: parent
Optional parameters: dataStoreId, createAdvancedSiteSearch
Body:
{:displayName string, :defaultSchemaId string, :name string, :industryVertical string, :createTime string, :solutionTypes [string], :startingSchema {:structSchema {}, :jsonSchema string, :name string}, :contentConfig string, :documentProcessingConfig {:name string, :defaultParsingConfig GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig, :parsingConfigOverrides {}}}
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.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/dataStores/create Required parameters: parent Optional parameters: dataStoreId, createAdvancedSiteSearch Body: {:displayName string, :defaultSchemaId string, :name string, :industryVertical string, :createTime string, :solutionTypes [string], :startingSchema {:structSchema {}, :jsonSchema string, :name string}, :contentConfig string, :documentProcessingConfig {:name string, :defaultParsingConfig GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig, :parsingConfigOverrides {}}} 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.
(locations-dataStores-delete$ auth parameters)
Required parameters: name
Optional parameters: none
Deletes a DataStore.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/dataStores/delete Required parameters: name Optional parameters: none Deletes a DataStore.
(locations-dataStores-get$ auth parameters)
Required parameters: name
Optional parameters: none
Gets a DataStore.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/dataStores/get Required parameters: name Optional parameters: none Gets a DataStore.
(locations-dataStores-getSiteSearchEngine$ auth parameters)
Required parameters: name
Optional parameters: none
Gets the SiteSearchEngine.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/dataStores/getSiteSearchEngine Required parameters: name Optional parameters: none Gets the SiteSearchEngine.
(locations-dataStores-list$ auth parameters)
Required parameters: parent
Optional parameters: pageSize, pageToken, filter
Lists all the DataStores associated with the project.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/dataStores/list Required parameters: parent Optional parameters: pageSize, pageToken, filter Lists all the DataStores associated with the project.
(locations-dataStores-models-operations-get$ auth parameters)
Required parameters: name
Optional parameters: none
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.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/dataStores/models/operations/get Required parameters: name Optional parameters: none 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.
(locations-dataStores-models-operations-list$ auth parameters)
Required parameters: name
Optional parameters: filter, pageSize, pageToken
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED
.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/dataStores/models/operations/list Required parameters: name Optional parameters: filter, pageSize, pageToken Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
(locations-dataStores-operations-get$ auth parameters)
Required parameters: name
Optional parameters: none
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.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/dataStores/operations/get Required parameters: name Optional parameters: none 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.
(locations-dataStores-operations-list$ auth parameters)
Required parameters: name
Optional parameters: filter, pageSize, pageToken
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED
.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/dataStores/operations/list Required parameters: name Optional parameters: filter, pageSize, pageToken Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
(locations-dataStores-patch$ auth parameters body)
Required parameters: name
Optional parameters: updateMask
Body:
{:displayName string, :defaultSchemaId string, :name string, :industryVertical string, :createTime string, :solutionTypes [string], :startingSchema {:structSchema {}, :jsonSchema string, :name string}, :contentConfig string, :documentProcessingConfig {:name string, :defaultParsingConfig GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig, :parsingConfigOverrides {}}}
Updates a DataStore
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/dataStores/patch Required parameters: name Optional parameters: updateMask Body: {:displayName string, :defaultSchemaId string, :name string, :industryVertical string, :createTime string, :solutionTypes [string], :startingSchema {:structSchema {}, :jsonSchema string, :name string}, :contentConfig string, :documentProcessingConfig {:name string, :defaultParsingConfig GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig, :parsingConfigOverrides {}}} Updates a DataStore
(locations-dataStores-schemas-create$ auth parameters body)
Required parameters: parent
Optional parameters: schemaId
Body:
{:structSchema {}, :jsonSchema string, :name string}
Creates a Schema.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/dataStores/schemas/create Required parameters: parent Optional parameters: schemaId Body: {:structSchema {}, :jsonSchema string, :name string} Creates a Schema.
(locations-dataStores-schemas-delete$ auth parameters)
Required parameters: name
Optional parameters: none
Deletes a Schema.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/dataStores/schemas/delete Required parameters: name Optional parameters: none Deletes a Schema.
(locations-dataStores-schemas-get$ auth parameters)
Required parameters: name
Optional parameters: none
Gets a Schema.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/dataStores/schemas/get Required parameters: name Optional parameters: none Gets a Schema.
(locations-dataStores-schemas-list$ auth parameters)
Required parameters: parent
Optional parameters: pageSize, pageToken
Gets a list of Schemas.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/dataStores/schemas/list Required parameters: parent Optional parameters: pageSize, pageToken Gets a list of Schemas.
(locations-dataStores-schemas-patch$ auth parameters body)
Required parameters: name
Optional parameters: allowMissing
Body:
{:structSchema {}, :jsonSchema string, :name string}
Updates a Schema.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/dataStores/schemas/patch Required parameters: name Optional parameters: allowMissing Body: {:structSchema {}, :jsonSchema string, :name string} Updates a Schema.
(locations-dataStores-servingConfigs-get$ auth parameters)
Required parameters: name
Optional parameters: none
Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/dataStores/servingConfigs/get Required parameters: name Optional parameters: none Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.
(locations-dataStores-servingConfigs-list$ auth parameters)
Required parameters: parent
Optional parameters: pageSize, pageToken
Lists all ServingConfigs linked to this dataStore.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/dataStores/servingConfigs/list Required parameters: parent Optional parameters: pageSize, pageToken Lists all ServingConfigs linked to this dataStore.
(locations-dataStores-servingConfigs-patch$ auth parameters body)
Required parameters: name
Optional parameters: updateMask
Body:
{:mediaConfig {:contentWatchedPercentageThreshold number, :contentWatchedSecondsThreshold number, :demotionEventType string, :contentFreshnessCutoffDays integer}, :solutionType string, :onewaySynonymsControlIds [string], :displayName string, :filterControlIds [string], :name string, :diversityLevel string, :modelId string, :createTime string, :genericConfig {:contentSearchSpec GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec}, :updateTime string, :synonymsControlIds [string], :redirectControlIds [string], :embeddingConfig {:fieldPath string}, :rankingExpression string, :dissociateControlIds [string], :ignoreControlIds [string], :replacementControlIds [string], :boostControlIds [string]}
Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/dataStores/servingConfigs/patch Required parameters: name Optional parameters: updateMask Body: {:mediaConfig {:contentWatchedPercentageThreshold number, :contentWatchedSecondsThreshold number, :demotionEventType string, :contentFreshnessCutoffDays integer}, :solutionType string, :onewaySynonymsControlIds [string], :displayName string, :filterControlIds [string], :name string, :diversityLevel string, :modelId string, :createTime string, :genericConfig {:contentSearchSpec GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec}, :updateTime string, :synonymsControlIds [string], :redirectControlIds [string], :embeddingConfig {:fieldPath string}, :rankingExpression string, :dissociateControlIds [string], :ignoreControlIds [string], :replacementControlIds [string], :boostControlIds [string]} Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.
(locations-dataStores-servingConfigs-recommend$ auth parameters body)
Required parameters: servingConfig
Optional parameters: none
Body:
{:userEvent {:eventType string, :tagIds [string], :transactionInfo GoogleCloudDiscoveryengineV1betaTransactionInfo, :sessionId string, :searchInfo GoogleCloudDiscoveryengineV1betaSearchInfo, :userPseudoId string, :panel GoogleCloudDiscoveryengineV1betaPanelInfo, :documents [GoogleCloudDiscoveryengineV1betaDocumentInfo], :directUserRequest boolean, :filter string, :completionInfo GoogleCloudDiscoveryengineV1betaCompletionInfo, :mediaInfo GoogleCloudDiscoveryengineV1betaMediaInfo, :pageInfo GoogleCloudDiscoveryengineV1betaPageInfo, :eventTime string, :promotionIds [string], :attributes {}, :attributionToken string, :userInfo GoogleCloudDiscoveryengineV1betaUserInfo}, :pageSize integer, :filter string, :validateOnly boolean, :params {}, :userLabels {}}
Makes a recommendation, which requires a contextual user event.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/dataStores/servingConfigs/recommend Required parameters: servingConfig Optional parameters: none Body: {:userEvent {:eventType string, :tagIds [string], :transactionInfo GoogleCloudDiscoveryengineV1betaTransactionInfo, :sessionId string, :searchInfo GoogleCloudDiscoveryengineV1betaSearchInfo, :userPseudoId string, :panel GoogleCloudDiscoveryengineV1betaPanelInfo, :documents [GoogleCloudDiscoveryengineV1betaDocumentInfo], :directUserRequest boolean, :filter string, :completionInfo GoogleCloudDiscoveryengineV1betaCompletionInfo, :mediaInfo GoogleCloudDiscoveryengineV1betaMediaInfo, :pageInfo GoogleCloudDiscoveryengineV1betaPageInfo, :eventTime string, :promotionIds [string], :attributes {}, :attributionToken string, :userInfo GoogleCloudDiscoveryengineV1betaUserInfo}, :pageSize integer, :filter string, :validateOnly boolean, :params {}, :userLabels {}} Makes a recommendation, which requires a contextual user event.
(locations-dataStores-servingConfigs-search$ auth parameters body)
Required parameters: servingConfig
Optional parameters: none
Body:
{:canonicalFilter string, :contentSearchSpec {:snippetSpec GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSnippetSpec, :summarySpec GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec, :extractiveContentSpec GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec}, :offset integer, :imageQuery {:imageBytes string}, :params {}, :userPseudoId string, :safeSearch boolean, :pageToken string, :facetSpecs [{:facetKey GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpecFacetKey, :limit integer, :excludedFilterKeys [string], :enableDynamicPosition boolean}], :embeddingSpec {:embeddingVectors [GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpecEmbeddingVector]}, :filter string, :pageSize integer, :query string, :rankingExpression string, :branch string, :userLabels {}, :dataStoreSpecs [{:dataStore string}], :queryExpansionSpec {:condition string, :pinUnexpandedResults boolean}, :boostSpec {:conditionBoostSpecs [GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpec]}, :spellCorrectionSpec {:mode string}, :userInfo {:userId string, :userAgent string}, :orderBy string}
Performs a search.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/dataStores/servingConfigs/search Required parameters: servingConfig Optional parameters: none Body: {:canonicalFilter string, :contentSearchSpec {:snippetSpec GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSnippetSpec, :summarySpec GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec, :extractiveContentSpec GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec}, :offset integer, :imageQuery {:imageBytes string}, :params {}, :userPseudoId string, :safeSearch boolean, :pageToken string, :facetSpecs [{:facetKey GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpecFacetKey, :limit integer, :excludedFilterKeys [string], :enableDynamicPosition boolean}], :embeddingSpec {:embeddingVectors [GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpecEmbeddingVector]}, :filter string, :pageSize integer, :query string, :rankingExpression string, :branch string, :userLabels {}, :dataStoreSpecs [{:dataStore string}], :queryExpansionSpec {:condition string, :pinUnexpandedResults boolean}, :boostSpec {:conditionBoostSpecs [GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpec]}, :spellCorrectionSpec {:mode string}, :userInfo {:userId string, :userAgent string}, :orderBy string} Performs a search.
(locations-dataStores-siteSearchEngine-disableAdvancedSiteSearch$ auth
parameters
body)
Required parameters: siteSearchEngine
Optional parameters: none
Body:
{}
Downgrade from advanced site search to basic site search.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/dataStores/siteSearchEngine/disableAdvancedSiteSearch Required parameters: siteSearchEngine Optional parameters: none Body: {} Downgrade from advanced site search to basic site search.
(locations-dataStores-siteSearchEngine-enableAdvancedSiteSearch$ auth
parameters
body)
Required parameters: siteSearchEngine
Optional parameters: none
Body:
{}
Upgrade from basic site search to advanced site search.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/dataStores/siteSearchEngine/enableAdvancedSiteSearch Required parameters: siteSearchEngine Optional parameters: none Body: {} Upgrade from basic site search to advanced site search.
(locations-dataStores-siteSearchEngine-recrawlUris$ auth parameters body)
Required parameters: siteSearchEngine
Optional parameters: none
Body:
{:uris [string]}
Request on-demand recrawl for a list of URIs.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/dataStores/siteSearchEngine/recrawlUris Required parameters: siteSearchEngine Optional parameters: none Body: {:uris [string]} Request on-demand recrawl for a list of URIs.
(locations-dataStores-siteSearchEngine-targetSites-batchCreate$ auth
parameters
body)
Required parameters: parent
Optional parameters: none
Body:
{:requests [{:parent string, :targetSite GoogleCloudDiscoveryengineV1betaTargetSite}]}
Creates TargetSite in a batch.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/dataStores/siteSearchEngine/targetSites/batchCreate Required parameters: parent Optional parameters: none Body: {:requests [{:parent string, :targetSite GoogleCloudDiscoveryengineV1betaTargetSite}]} Creates TargetSite in a batch.
(locations-dataStores-siteSearchEngine-targetSites-create$ auth parameters body)
Required parameters: parent
Optional parameters: none
Body:
{:providedUriPattern string, :exactMatch boolean, :name string, :indexingStatus string, :type string, :updateTime string, :siteVerificationInfo {:siteVerificationState string, :verifyTime string}, :failureReason {:quotaFailure GoogleCloudDiscoveryengineV1betaTargetSiteFailureReasonQuotaFailure}, :generatedUriPattern string}
Creates a TargetSite.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/dataStores/siteSearchEngine/targetSites/create Required parameters: parent Optional parameters: none Body: {:providedUriPattern string, :exactMatch boolean, :name string, :indexingStatus string, :type string, :updateTime string, :siteVerificationInfo {:siteVerificationState string, :verifyTime string}, :failureReason {:quotaFailure GoogleCloudDiscoveryengineV1betaTargetSiteFailureReasonQuotaFailure}, :generatedUriPattern string} Creates a TargetSite.
(locations-dataStores-siteSearchEngine-targetSites-delete$ auth parameters)
Required parameters: name
Optional parameters: none
Deletes a TargetSite.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/dataStores/siteSearchEngine/targetSites/delete Required parameters: name Optional parameters: none Deletes a TargetSite.
(locations-dataStores-siteSearchEngine-targetSites-get$ auth parameters)
Required parameters: name
Optional parameters: none
Gets a TargetSite.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/dataStores/siteSearchEngine/targetSites/get Required parameters: name Optional parameters: none Gets a TargetSite.
(locations-dataStores-siteSearchEngine-targetSites-list$ auth parameters)
Required parameters: parent
Optional parameters: pageSize, pageToken
Gets a list of TargetSites.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/dataStores/siteSearchEngine/targetSites/list Required parameters: parent Optional parameters: pageSize, pageToken Gets a list of TargetSites.
(locations-dataStores-siteSearchEngine-targetSites-patch$ auth parameters body)
Required parameters: name
Optional parameters: none
Body:
{:providedUriPattern string, :exactMatch boolean, :name string, :indexingStatus string, :type string, :updateTime string, :siteVerificationInfo {:siteVerificationState string, :verifyTime string}, :failureReason {:quotaFailure GoogleCloudDiscoveryengineV1betaTargetSiteFailureReasonQuotaFailure}, :generatedUriPattern string}
Updates a TargetSite.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/dataStores/siteSearchEngine/targetSites/patch Required parameters: name Optional parameters: none Body: {:providedUriPattern string, :exactMatch boolean, :name string, :indexingStatus string, :type string, :updateTime string, :siteVerificationInfo {:siteVerificationState string, :verifyTime string}, :failureReason {:quotaFailure GoogleCloudDiscoveryengineV1betaTargetSiteFailureReasonQuotaFailure}, :generatedUriPattern string} Updates a TargetSite.
(locations-dataStores-suggestionDenyListEntries-import$ auth parameters body)
Required parameters: parent
Optional parameters: none
Body:
{:inlineSource {:entries [GoogleCloudDiscoveryengineV1betaSuggestionDenyListEntry]}, :gcsSource {:inputUris [string], :dataSchema string}}
Imports all SuggestionDenyListEntry for a DataStore.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/dataStores/suggestionDenyListEntries/import Required parameters: parent Optional parameters: none Body: {:inlineSource {:entries [GoogleCloudDiscoveryengineV1betaSuggestionDenyListEntry]}, :gcsSource {:inputUris [string], :dataSchema string}} Imports all SuggestionDenyListEntry for a DataStore.
(locations-dataStores-suggestionDenyListEntries-purge$ auth parameters body)
Required parameters: parent
Optional parameters: none
Body:
{}
Permanently deletes all SuggestionDenyListEntry for a DataStore.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/dataStores/suggestionDenyListEntries/purge Required parameters: parent Optional parameters: none Body: {} Permanently deletes all SuggestionDenyListEntry for a DataStore.
(locations-dataStores-userEvents-collect$ auth parameters)
Required parameters: parent
Optional parameters: userEvent, uri, ets
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.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/dataStores/userEvents/collect Required parameters: parent Optional parameters: userEvent, uri, ets 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.
(locations-dataStores-userEvents-import$ auth parameters body)
Required parameters: parent
Optional parameters: none
Body:
{:inlineSource {:userEvents [GoogleCloudDiscoveryengineV1betaUserEvent]}, :gcsSource {:inputUris [string], :dataSchema string}, :bigquerySource {:partitionDate GoogleTypeDate, :projectId string, :datasetId string, :tableId string, :gcsStagingDir string, :dataSchema string}, :errorConfig {:gcsPrefix string}}
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.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/dataStores/userEvents/import Required parameters: parent Optional parameters: none Body: {:inlineSource {:userEvents [GoogleCloudDiscoveryengineV1betaUserEvent]}, :gcsSource {:inputUris [string], :dataSchema string}, :bigquerySource {:partitionDate GoogleTypeDate, :projectId string, :datasetId string, :tableId string, :gcsStagingDir string, :dataSchema string}, :errorConfig {:gcsPrefix string}} 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.
(locations-dataStores-userEvents-write$ auth parameters body)
Required parameters: parent
Optional parameters: none
Body:
{:eventType string, :tagIds [string], :transactionInfo {:value number, :currency string, :transactionId string, :tax number, :cost number, :discountValue number}, :sessionId string, :searchInfo {:searchQuery string, :orderBy string, :offset integer}, :userPseudoId string, :panel {:panelId string, :displayName string, :panelPosition integer, :totalPanels integer}, :documents [{:id string, :name string, :uri string, :quantity integer, :promotionIds [string]}], :directUserRequest boolean, :filter string, :completionInfo {:selectedSuggestion string, :selectedPosition integer}, :mediaInfo {:mediaProgressDuration string, :mediaProgressPercentage number}, :pageInfo {:pageviewId string, :pageCategory string, :uri string, :referrerUri string}, :eventTime string, :promotionIds [string], :attributes {}, :attributionToken string, :userInfo {:userId string, :userAgent string}}
Writes a single user event.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/dataStores/userEvents/write Required parameters: parent Optional parameters: none Body: {:eventType string, :tagIds [string], :transactionInfo {:value number, :currency string, :transactionId string, :tax number, :cost number, :discountValue number}, :sessionId string, :searchInfo {:searchQuery string, :orderBy string, :offset integer}, :userPseudoId string, :panel {:panelId string, :displayName string, :panelPosition integer, :totalPanels integer}, :documents [{:id string, :name string, :uri string, :quantity integer, :promotionIds [string]}], :directUserRequest boolean, :filter string, :completionInfo {:selectedSuggestion string, :selectedPosition integer}, :mediaInfo {:mediaProgressDuration string, :mediaProgressPercentage number}, :pageInfo {:pageviewId string, :pageCategory string, :uri string, :referrerUri string}, :eventTime string, :promotionIds [string], :attributes {}, :attributionToken string, :userInfo {:userId string, :userAgent string}} Writes a single user event.
(locations-operations-get$ auth parameters)
Required parameters: name
Optional parameters: none
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.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/operations/get Required parameters: name Optional parameters: none 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.
(locations-operations-list$ auth parameters)
Required parameters: name
Optional parameters: filter, pageSize, pageToken
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED
.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/locations/operations/list Required parameters: name Optional parameters: filter, pageSize, pageToken Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
(operations-get$ auth parameters)
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/operations/get
Required parameters: name
Optional parameters: none
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.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/operations/get Required parameters: name Optional parameters: none Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
(operations-list$ auth parameters)
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/operations/list
Required parameters: name
Optional parameters: filter, pageSize, pageToken
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED
.
https://cloud.google.com/discovery-engine/docsapi/reference/rest/v1beta/projects/operations/list Required parameters: name Optional parameters: filter, pageSize, pageToken Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close