Discovery Engine API C++ Client Library
An idiomatic C++ client library for the Discovery Engine API, a service that powers high-quality content recommendations on your digital properties.
While this library is GA, please note that the Google Cloud C++ client libraries do not follow Semantic Versioning.
Quickstart
The following shows the code that you'll run in the google/cloud/discoveryengine/quickstart/
directory, which should give you a taste of the Discovery Engine API C++ client library API.
#include "google/cloud/discoveryengine/v1/document_client.h"
#include "google/cloud/location.h"
#include <iostream>
int main(int argc, char* argv[]) try {
if (argc != 2) {
std::cerr << "Usage: " << argv[0] << " project-id\n";
return 1;
}
auto const location = google::cloud::Location(argv[1], "global");
namespace discoveryengine = ::google::cloud::discoveryengine_v1;
auto client = discoveryengine::DocumentServiceClient(
discoveryengine::MakeDocumentServiceConnection());
auto const parent = location.FullName() +
"/dataStores/default_data_store/branches/default_branch";
for (auto d : client.ListDocuments(parent)) {
if (!d) throw std::move(d).status();
std::cout << d->DebugString() << "\n";
}
return 0;
} catch (google::cloud::Status const& status) {
std::cerr << "google::cloud::Status thrown: " << status << "\n";
return 1;
}
Main classes
This library offers multiple *Client
classes, which are listed below. Each one of these classes exposes all the RPCs for a service as member functions of the class. This library groups multiple services because they are part of the same product or are often used together. A typical example may be the administrative and data plane operations for a single product.
The library also has other classes that provide helpers, configuration parameters, and infrastructure to mock the *Client
classes when testing your application.
discoveryengine_v1::CompletionServiceClient
discoveryengine_v1::ConversationalSearchServiceClient
discoveryengine_v1::DocumentServiceClient
discoveryengine_v1::SchemaServiceClient
discoveryengine_v1::SearchServiceClient
discoveryengine_v1::UserEventServiceClient
More Information
- Error Handling - describes how the library reports errors.
- How to Override the Default Endpoint - describes how to override the default endpoint.
- How to Override the Authentication Credentials - describes how to change the authentication credentials used by the library.
- Override Retry, Backoff, and Idempotency Policies - describes how to change the default retry policies.
- Environment Variables - describes environment variables that can configure the behavior of the library.