com.google.cloud.discoveryengine.v1
A client to Discovery Engine API
The interfaces provided are listed below, along with usage samples.
CompletionServiceClient
Service Description: Service for Auto-Completion.
Sample for CompletionServiceClient:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (CompletionServiceClient completionServiceClient = CompletionServiceClient.create()) {
CompleteQueryRequest request =
CompleteQueryRequest.newBuilder()
.setDataStore(
DataStoreName.ofProjectLocationDataStoreName(
"[PROJECT]", "[LOCATION]", "[DATA_STORE]")
.toString())
.setQuery("query107944136")
.setQueryModel("queryModel-184930495")
.setUserPseudoId("userPseudoId-1155274652")
.setIncludeTailSuggestions(true)
.build();
CompleteQueryResponse response = completionServiceClient.completeQuery(request);
}
ConversationalSearchServiceClient
Service Description: Service for conversational search.
Sample for ConversationalSearchServiceClient:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ConversationalSearchServiceClient conversationalSearchServiceClient =
ConversationalSearchServiceClient.create()) {
ConversationName name =
ConversationName.ofProjectLocationDataStoreConversationName(
"[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[CONVERSATION]");
TextInput query = TextInput.newBuilder().build();
ConverseConversationResponse response =
conversationalSearchServiceClient.converseConversation(name, query);
}
DocumentServiceClient
Service Description: Service for ingesting Document information of the customer's website.
Sample for DocumentServiceClient:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DocumentServiceClient documentServiceClient = DocumentServiceClient.create()) {
DocumentName name =
DocumentName.ofProjectLocationDataStoreBranchDocumentName(
"[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[BRANCH]", "[DOCUMENT]");
Document response = documentServiceClient.getDocument(name);
}
SchemaServiceClient
Service Description: Service for managing Schemas.
Sample for SchemaServiceClient:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (SchemaServiceClient schemaServiceClient = SchemaServiceClient.create()) {
SchemaName name =
SchemaName.ofProjectLocationDataStoreSchemaName(
"[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[SCHEMA]");
Schema response = schemaServiceClient.getSchema(name);
}
SearchServiceClient
Service Description: Service for search.
Sample for SearchServiceClient:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (SearchServiceClient searchServiceClient = SearchServiceClient.create()) {
SearchRequest request =
SearchRequest.newBuilder()
.setServingConfig(
ServingConfigName.ofProjectLocationDataStoreServingConfigName(
"[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[SERVING_CONFIG]")
.toString())
.setBranch(
BranchName.ofProjectLocationDataStoreBranchName(
"[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[BRANCH]")
.toString())
.setQuery("query107944136")
.setImageQuery(SearchRequest.ImageQuery.newBuilder().build())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setOffset(-1019779949)
.setFilter("filter-1274492040")
.setOrderBy("orderBy-1207110587")
.setUserInfo(UserInfo.newBuilder().build())
.addAllFacetSpecs(new ArrayList<SearchRequest.FacetSpec>())
.setBoostSpec(SearchRequest.BoostSpec.newBuilder().build())
.putAllParams(new HashMap<String, Value>())
.setQueryExpansionSpec(SearchRequest.QueryExpansionSpec.newBuilder().build())
.setSpellCorrectionSpec(SearchRequest.SpellCorrectionSpec.newBuilder().build())
.setUserPseudoId("userPseudoId-1155274652")
.setContentSearchSpec(SearchRequest.ContentSearchSpec.newBuilder().build())
.setSafeSearch(true)
.putAllUserLabels(new HashMap<String, String>())
.build();
for (SearchResponse.SearchResult element : searchServiceClient.search(request).iterateAll()) {
// doThingsWith(element);
}
}
UserEventServiceClient
Service Description: Service for ingesting end user actions on a website to Discovery Engine API.
Sample for UserEventServiceClient:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (UserEventServiceClient userEventServiceClient = UserEventServiceClient.create()) {
WriteUserEventRequest request =
WriteUserEventRequest.newBuilder()
.setParent(
DataStoreName.ofProjectLocationDataStoreName(
"[PROJECT]", "[LOCATION]", "[DATA_STORE]")
.toString())
.setUserEvent(UserEvent.newBuilder().build())
.build();
UserEvent response = userEventServiceClient.writeUserEvent(request);
}
com.google.cloud.discoveryengine.v1.stub
com.google.cloud.discoveryengine.v1alpha
A client to Discovery Engine API
The interfaces provided are listed below, along with usage samples.
CompletionServiceClient
Service Description: Service for Auto-Completion.
Sample for CompletionServiceClient:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (CompletionServiceClient completionServiceClient = CompletionServiceClient.create()) {
CompleteQueryRequest request =
CompleteQueryRequest.newBuilder()
.setDataStore(
DataStoreName.ofProjectLocationDataStoreName(
"[PROJECT]", "[LOCATION]", "[DATA_STORE]")
.toString())
.setQuery("query107944136")
.setQueryModel("queryModel-184930495")
.setUserPseudoId("userPseudoId-1155274652")
.setIncludeTailSuggestions(true)
.build();
CompleteQueryResponse response = completionServiceClient.completeQuery(request);
}
ConversationalSearchServiceClient
Service Description: Service for conversational search.
Sample for ConversationalSearchServiceClient:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ConversationalSearchServiceClient conversationalSearchServiceClient =
ConversationalSearchServiceClient.create()) {
ConversationName name =
ConversationName.ofProjectLocationDataStoreConversationName(
"[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[CONVERSATION]");
TextInput query = TextInput.newBuilder().build();
ConverseConversationResponse response =
conversationalSearchServiceClient.converseConversation(name, query);
}
DocumentServiceClient
Service Description: Service for ingesting Document information of the customer's website.
Sample for DocumentServiceClient:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DocumentServiceClient documentServiceClient = DocumentServiceClient.create()) {
DocumentName name =
DocumentName.ofProjectLocationDataStoreBranchDocumentName(
"[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[BRANCH]", "[DOCUMENT]");
Document response = documentServiceClient.getDocument(name);
}
RecommendationServiceClient
Service Description: Service for making recommendations.
Sample for RecommendationServiceClient:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RecommendationServiceClient recommendationServiceClient =
RecommendationServiceClient.create()) {
RecommendRequest request =
RecommendRequest.newBuilder()
.setServingConfig(
ServingConfigName.ofProjectLocationDataStoreServingConfigName(
"[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[SERVING_CONFIG]")
.toString())
.setUserEvent(UserEvent.newBuilder().build())
.setPageSize(883849137)
.setFilter("filter-1274492040")
.setValidateOnly(true)
.putAllParams(new HashMap<String, Value>())
.putAllUserLabels(new HashMap<String, String>())
.build();
RecommendResponse response = recommendationServiceClient.recommend(request);
}
SchemaServiceClient
Service Description: Service for managing Schemas.
Sample for SchemaServiceClient:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (SchemaServiceClient schemaServiceClient = SchemaServiceClient.create()) {
SchemaName name =
SchemaName.ofProjectLocationDataStoreSchemaName(
"[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[SCHEMA]");
Schema response = schemaServiceClient.getSchema(name);
}
SearchServiceClient
Service Description: Service for search.
Sample for SearchServiceClient:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (SearchServiceClient searchServiceClient = SearchServiceClient.create()) {
SearchRequest request =
SearchRequest.newBuilder()
.setServingConfig(
ServingConfigName.ofProjectLocationDataStoreServingConfigName(
"[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[SERVING_CONFIG]")
.toString())
.setBranch(
BranchName.ofProjectLocationDataStoreBranchName(
"[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[BRANCH]")
.toString())
.setQuery("query107944136")
.setImageQuery(SearchRequest.ImageQuery.newBuilder().build())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setOffset(-1019779949)
.setFilter("filter-1274492040")
.setOrderBy("orderBy-1207110587")
.setUserInfo(UserInfo.newBuilder().build())
.addAllFacetSpecs(new ArrayList<SearchRequest.FacetSpec>())
.setBoostSpec(SearchRequest.BoostSpec.newBuilder().build())
.putAllParams(new HashMap<String, Value>())
.setQueryExpansionSpec(SearchRequest.QueryExpansionSpec.newBuilder().build())
.setSpellCorrectionSpec(SearchRequest.SpellCorrectionSpec.newBuilder().build())
.setUserPseudoId("userPseudoId-1155274652")
.setContentSearchSpec(SearchRequest.ContentSearchSpec.newBuilder().build())
.setEmbeddingSpec(SearchRequest.EmbeddingSpec.newBuilder().build())
.setRankingExpression("rankingExpression2110320494")
.setSafeSearch(true)
.putAllUserLabels(new HashMap<String, String>())
.build();
for (SearchResponse.SearchResult element : searchServiceClient.search(request).iterateAll()) {
// doThingsWith(element);
}
}
SiteSearchEngineServiceClient
Service Description: Service for managing site search related resources.
Sample for SiteSearchEngineServiceClient:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (SiteSearchEngineServiceClient siteSearchEngineServiceClient =
SiteSearchEngineServiceClient.create()) {
RecrawlUrisRequest request =
RecrawlUrisRequest.newBuilder()
.setSiteSearchEngine(
SiteSearchEngineName.ofProjectLocationDataStoreName(
"[PROJECT]", "[LOCATION]", "[DATA_STORE]")
.toString())
.addAllUris(new ArrayList<String>())
.build();
RecrawlUrisResponse response = siteSearchEngineServiceClient.recrawlUrisAsync(request).get();
}
UserEventServiceClient
Service Description: Service for ingesting end user actions on a website to Discovery Engine API.
Sample for UserEventServiceClient:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (UserEventServiceClient userEventServiceClient = UserEventServiceClient.create()) {
WriteUserEventRequest request =
WriteUserEventRequest.newBuilder()
.setParent(
DataStoreName.ofProjectLocationDataStoreName(
"[PROJECT]", "[LOCATION]", "[DATA_STORE]")
.toString())
.setUserEvent(UserEvent.newBuilder().build())
.build();
UserEvent response = userEventServiceClient.writeUserEvent(request);
}
com.google.cloud.discoveryengine.v1alpha.stub
com.google.cloud.discoveryengine.v1beta
A client to Discovery Engine API
The interfaces provided are listed below, along with usage samples.
CompletionServiceClient
Service Description: Service for Auto-Completion.
Sample for CompletionServiceClient:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (CompletionServiceClient completionServiceClient = CompletionServiceClient.create()) {
CompleteQueryRequest request =
CompleteQueryRequest.newBuilder()
.setDataStore(
DataStoreName.ofProjectLocationDataStoreName(
"[PROJECT]", "[LOCATION]", "[DATA_STORE]")
.toString())
.setQuery("query107944136")
.setQueryModel("queryModel-184930495")
.setUserPseudoId("userPseudoId-1155274652")
.setIncludeTailSuggestions(true)
.build();
CompleteQueryResponse response = completionServiceClient.completeQuery(request);
}
ConversationalSearchServiceClient
Service Description: Service for conversational search.
Sample for ConversationalSearchServiceClient:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ConversationalSearchServiceClient conversationalSearchServiceClient =
ConversationalSearchServiceClient.create()) {
ConversationName name =
ConversationName.ofProjectLocationDataStoreConversationName(
"[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[CONVERSATION]");
TextInput query = TextInput.newBuilder().build();
ConverseConversationResponse response =
conversationalSearchServiceClient.converseConversation(name, query);
}
DocumentServiceClient
Service Description: Service for ingesting Document information of the customer's website.
Sample for DocumentServiceClient:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DocumentServiceClient documentServiceClient = DocumentServiceClient.create()) {
DocumentName name =
DocumentName.ofProjectLocationDataStoreBranchDocumentName(
"[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[BRANCH]", "[DOCUMENT]");
Document response = documentServiceClient.getDocument(name);
}
RecommendationServiceClient
Service Description: Service for making recommendations.
Sample for RecommendationServiceClient:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (RecommendationServiceClient recommendationServiceClient =
RecommendationServiceClient.create()) {
RecommendRequest request =
RecommendRequest.newBuilder()
.setServingConfig(
ServingConfigName.ofProjectLocationDataStoreServingConfigName(
"[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[SERVING_CONFIG]")
.toString())
.setUserEvent(UserEvent.newBuilder().build())
.setPageSize(883849137)
.setFilter("filter-1274492040")
.setValidateOnly(true)
.putAllParams(new HashMap<String, Value>())
.putAllUserLabels(new HashMap<String, String>())
.build();
RecommendResponse response = recommendationServiceClient.recommend(request);
}
SchemaServiceClient
Service Description: Service for managing Schemas.
Sample for SchemaServiceClient:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (SchemaServiceClient schemaServiceClient = SchemaServiceClient.create()) {
SchemaName name =
SchemaName.ofProjectLocationDataStoreSchemaName(
"[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[SCHEMA]");
Schema response = schemaServiceClient.getSchema(name);
}
SearchServiceClient
Service Description: Service for search.
Sample for SearchServiceClient:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (SearchServiceClient searchServiceClient = SearchServiceClient.create()) {
SearchRequest request =
SearchRequest.newBuilder()
.setServingConfig(
ServingConfigName.ofProjectLocationDataStoreServingConfigName(
"[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[SERVING_CONFIG]")
.toString())
.setBranch(
BranchName.ofProjectLocationDataStoreBranchName(
"[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[BRANCH]")
.toString())
.setQuery("query107944136")
.setImageQuery(SearchRequest.ImageQuery.newBuilder().build())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setOffset(-1019779949)
.setFilter("filter-1274492040")
.setOrderBy("orderBy-1207110587")
.setUserInfo(UserInfo.newBuilder().build())
.addAllFacetSpecs(new ArrayList<SearchRequest.FacetSpec>())
.setBoostSpec(SearchRequest.BoostSpec.newBuilder().build())
.putAllParams(new HashMap<String, Value>())
.setQueryExpansionSpec(SearchRequest.QueryExpansionSpec.newBuilder().build())
.setSpellCorrectionSpec(SearchRequest.SpellCorrectionSpec.newBuilder().build())
.setUserPseudoId("userPseudoId-1155274652")
.setContentSearchSpec(SearchRequest.ContentSearchSpec.newBuilder().build())
.setEmbeddingSpec(SearchRequest.EmbeddingSpec.newBuilder().build())
.setRankingExpression("rankingExpression2110320494")
.setSafeSearch(true)
.putAllUserLabels(new HashMap<String, String>())
.build();
for (SearchResponse.SearchResult element : searchServiceClient.search(request).iterateAll()) {
// doThingsWith(element);
}
}
UserEventServiceClient
Service Description: Service for ingesting end user actions on a website to Discovery Engine API.
Sample for UserEventServiceClient:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (UserEventServiceClient userEventServiceClient = UserEventServiceClient.create()) {
WriteUserEventRequest request =
WriteUserEventRequest.newBuilder()
.setParent(
DataStoreName.ofProjectLocationDataStoreName(
"[PROJECT]", "[LOCATION]", "[DATA_STORE]")
.toString())
.setUserEvent(UserEvent.newBuilder().build())
.build();
UserEvent response = userEventServiceClient.writeUserEvent(request);
}