-
Notifications
You must be signed in to change notification settings - Fork 444
Expand file tree
/
Copy pathmain.dox
More file actions
65 lines (50 loc) · 3.38 KB
/
main.dox
File metadata and controls
65 lines (50 loc) · 3.38 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
/*!
@mainpage Discovery Engine API C++ Client Library
An idiomatic C++ client library for the
[Discovery Engine API][cloud-service-docs], 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](https://semver.org/).
@tableofcontents{HTML:2}
## 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.
@snippet quickstart.cc all
## Main classes
<!-- inject-client-list-start -->
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.
- [\c discoveryengine_v1::CompletionServiceClient](@ref google::cloud::discoveryengine_v1::CompletionServiceClient)
- [\c discoveryengine_v1::ControlServiceClient](@ref google::cloud::discoveryengine_v1::ControlServiceClient)
- [\c discoveryengine_v1::ConversationalSearchServiceClient](@ref google::cloud::discoveryengine_v1::ConversationalSearchServiceClient)
- [\c discoveryengine_v1::DataStoreServiceClient](@ref google::cloud::discoveryengine_v1::DataStoreServiceClient)
- [\c discoveryengine_v1::DocumentServiceClient](@ref google::cloud::discoveryengine_v1::DocumentServiceClient)
- [\c discoveryengine_v1::EngineServiceClient](@ref google::cloud::discoveryengine_v1::EngineServiceClient)
- [\c discoveryengine_v1::GroundedGenerationServiceClient](@ref google::cloud::discoveryengine_v1::GroundedGenerationServiceClient)
- [\c discoveryengine_v1::ProjectServiceClient](@ref google::cloud::discoveryengine_v1::ProjectServiceClient)
- [\c discoveryengine_v1::RankServiceClient](@ref google::cloud::discoveryengine_v1::RankServiceClient)
- [\c discoveryengine_v1::RecommendationServiceClient](@ref google::cloud::discoveryengine_v1::RecommendationServiceClient)
- [\c discoveryengine_v1::SchemaServiceClient](@ref google::cloud::discoveryengine_v1::SchemaServiceClient)
- [\c discoveryengine_v1::SearchServiceClient](@ref google::cloud::discoveryengine_v1::SearchServiceClient)
- [\c discoveryengine_v1::SiteSearchEngineServiceClient](@ref google::cloud::discoveryengine_v1::SiteSearchEngineServiceClient)
- [\c discoveryengine_v1::UserEventServiceClient](@ref google::cloud::discoveryengine_v1::UserEventServiceClient)
<!-- inject-client-list-end -->
## More Information
- @ref common-error-handling - describes how the library reports errors.
- @ref discoveryengine-override-endpoint - describes how to override the default
endpoint.
- @ref discoveryengine-override-authentication - describes how to change the
authentication credentials used by the library.
- @ref discoveryengine-override-retry - describes how to change the default retry
policies.
- @ref discoveryengine-env - describes environment variables that can configure the
behavior of the library.
[cloud-service-docs]: https://cloud.google.com/discovery-engine
*/