google-cloud-aiplatform-v1 1.10.0

Google Cloud Client Libraries for Rust - Vertex AI API
Documentation 
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
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219

// Copyright 2025 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
// Code generated by sidekick. DO NOT EDIT.

//! Google Cloud Client Libraries for Rust - Vertex AI API
//!
//! **WARNING:** some RPCs have no corresponding Rust function to call them.
//! Typically these are streaming RPCs. We expect adding these RPCs in a
//! way that does not break the existing APIs or changes their behavior in a
//! significant way. We do anticipate a number of new crate dependencies
//! will be required. If you need these RPCs please open an issue in our
//! GitHub repository.
//!
//! This crate contains traits, types, and functions to interact with Vertex AI API
//! Most applications will use the structs defined in the [client] module.
//!
//! The client library types and functions are stable and not expected to change.
//! Please note that Google Cloud services do change from time to time. The client
//! libraries are designed to preserve backwards compatibility when the service
//! changes in compatible ways. For example, adding RPCs, or fields to messages
//! should not introduce breaking changes to the client libraries.
//!
//! # Available Clients
//!
//! * [DataFoundryService](client/struct.DataFoundryService.html)
//! * [DatasetService](client/struct.DatasetService.html)
//! * [DeploymentResourcePoolService](client/struct.DeploymentResourcePoolService.html)
//! * [EndpointService](client/struct.EndpointService.html)
//! * [EvaluationService](client/struct.EvaluationService.html)
//! * [FeatureOnlineStoreAdminService](client/struct.FeatureOnlineStoreAdminService.html)
//! * [FeatureOnlineStoreService](client/struct.FeatureOnlineStoreService.html)
//! * [FeatureRegistryService](client/struct.FeatureRegistryService.html)
//! * [FeaturestoreOnlineServingService](client/struct.FeaturestoreOnlineServingService.html)
//! * [FeaturestoreService](client/struct.FeaturestoreService.html)
//! * [GenAiCacheService](client/struct.GenAiCacheService.html)
//! * [GenAiTuningService](client/struct.GenAiTuningService.html)
//! * [IndexEndpointService](client/struct.IndexEndpointService.html)
//! * [IndexService](client/struct.IndexService.html)
//! * [JobService](client/struct.JobService.html)
//! * [LlmUtilityService](client/struct.LlmUtilityService.html)
//! * [MatchService](client/struct.MatchService.html)
//! * [MetadataService](client/struct.MetadataService.html)
//! * [MigrationService](client/struct.MigrationService.html)
//! * [ModelGardenService](client/struct.ModelGardenService.html)
//! * [ModelService](client/struct.ModelService.html)
//! * [NotebookService](client/struct.NotebookService.html)
//! * [PersistentResourceService](client/struct.PersistentResourceService.html)
//! * [PipelineService](client/struct.PipelineService.html)
//! * [PredictionService](client/struct.PredictionService.html)
//! * [ReasoningEngineExecutionService](client/struct.ReasoningEngineExecutionService.html)
//! * [ReasoningEngineService](client/struct.ReasoningEngineService.html)
//! * [ScheduleService](client/struct.ScheduleService.html)
//! * [SessionService](client/struct.SessionService.html)
//! * [SpecialistPoolService](client/struct.SpecialistPoolService.html)
//! * [TensorboardService](client/struct.TensorboardService.html)
//! * [VertexRagDataService](client/struct.VertexRagDataService.html)
//! * [VertexRagService](client/struct.VertexRagService.html)
//! * [VizierService](client/struct.VizierService.html)
//!
//! # Features
//!
//! - `default-rustls-provider`: enabled by default. Use the default rustls
//!   crypto provider ([aws-lc-rs]) for TLS and authentication. Applications
//!   with specific requirements for cryptography (such as exclusively using the
//!   [ring] crate) should disable this default and call
//!   `rustls::crypto::CryptoProvider::install_default()`.
//! - Each client can be enabled using its own feature. Use the client's name
//!   in `kebab-case` to enable the client.
//!
//! [aws-lc-rs]: https://crates.io/crates/aws-lc-rs
//! [ring]: https://crates.io/crates/ring

#![cfg_attr(docsrs, feature(doc_cfg))]
#![allow(deprecated)]

/// The messages and enums that are part of this client library.
#[allow(clippy::module_inception)]
pub mod model;

pub use google_cloud_gax::Result;
pub use google_cloud_gax::error::Error;

#[allow(rustdoc::invalid_html_tags)]
#[allow(rustdoc::redundant_explicit_links)]
pub mod stub;

///
/// # Example
/// ```
/// # use google_cloud_aiplatform_v1::client::PredictionService;
/// # async fn sample() -> Result<(), Box<dyn std::error::Error>> {
///     let client = PredictionService::builder().build().await?;
///     let response = client.predict()
///         /* set fields */
///         .send().await?;
///     println!("response {:?}", response);
/// # Ok(()) }
/// ```
/// Concrete implementations of this client library traits.
pub mod client;

/// Request builders.
pub mod builder;

#[doc(hidden)]
pub(crate) mod tracing;

#[doc(hidden)]
pub(crate) mod transport;

/// The default host used by the service.
#[cfg(any(
    feature = "data-foundry-service",
    feature = "dataset-service",
    feature = "deployment-resource-pool-service",
    feature = "endpoint-service",
    feature = "evaluation-service",
    feature = "feature-online-store-admin-service",
    feature = "feature-online-store-service",
    feature = "feature-registry-service",
    feature = "featurestore-online-serving-service",
    feature = "featurestore-service",
    feature = "gen-ai-cache-service",
    feature = "gen-ai-tuning-service",
    feature = "index-endpoint-service",
    feature = "index-service",
    feature = "job-service",
    feature = "llm-utility-service",
    feature = "match-service",
    feature = "metadata-service",
    feature = "migration-service",
    feature = "model-garden-service",
    feature = "model-service",
    feature = "notebook-service",
    feature = "persistent-resource-service",
    feature = "pipeline-service",
    feature = "prediction-service",
    feature = "reasoning-engine-execution-service",
    feature = "reasoning-engine-service",
    feature = "schedule-service",
    feature = "session-service",
    feature = "specialist-pool-service",
    feature = "tensorboard-service",
    feature = "vertex-rag-data-service",
    feature = "vertex-rag-service",
    feature = "vizier-service",
))]
const DEFAULT_HOST: &str = "https://aiplatform.googleapis.com/";

#[cfg(any(
    feature = "data-foundry-service",
    feature = "dataset-service",
    feature = "deployment-resource-pool-service",
    feature = "endpoint-service",
    feature = "evaluation-service",
    feature = "feature-online-store-admin-service",
    feature = "feature-online-store-service",
    feature = "feature-registry-service",
    feature = "featurestore-online-serving-service",
    feature = "featurestore-service",
    feature = "gen-ai-cache-service",
    feature = "gen-ai-tuning-service",
    feature = "index-endpoint-service",
    feature = "index-service",
    feature = "job-service",
    feature = "llm-utility-service",
    feature = "match-service",
    feature = "metadata-service",
    feature = "migration-service",
    feature = "model-garden-service",
    feature = "model-service",
    feature = "notebook-service",
    feature = "persistent-resource-service",
    feature = "pipeline-service",
    feature = "prediction-service",
    feature = "reasoning-engine-execution-service",
    feature = "reasoning-engine-service",
    feature = "schedule-service",
    feature = "session-service",
    feature = "specialist-pool-service",
    feature = "tensorboard-service",
    feature = "vertex-rag-data-service",
    feature = "vertex-rag-service",
    feature = "vizier-service",
))]
pub(crate) mod info {
    const NAME: &str = env!("CARGO_PKG_NAME");
    const VERSION: &str = env!("CARGO_PKG_VERSION");
    pub(crate) static X_GOOG_API_CLIENT_HEADER: std::sync::LazyLock<String> =
        std::sync::LazyLock::new(|| {
            let ac = gaxi::api_header::XGoogApiClient {
                name: NAME,
                version: VERSION,
                library_type: gaxi::api_header::GAPIC,
            };
            ac.rest_header_value()
        });
}

// Define some shortcuts for imported crates.
pub(crate) use google_cloud_gax::client_builder::ClientBuilder;
pub(crate) use google_cloud_gax::client_builder::Result as ClientBuilderResult;
pub(crate) use google_cloud_gax::client_builder::internal::ClientFactory;
pub(crate) use google_cloud_gax::client_builder::internal::new_builder as new_client_builder;
pub(crate) use google_cloud_gax::options::RequestOptions;
pub(crate) use google_cloud_gax::options::internal::RequestBuilder;
pub(crate) use google_cloud_gax::response::Response;