-
Notifications
You must be signed in to change notification settings - Fork 1.9k
/
OpenAIClientBuilder.java
341 lines (302 loc) · 12.2 KB
/
OpenAIClientBuilder.java
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
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.
// Code generated by Microsoft (R) AutoRest Code Generator.
package com.azure.ai.openai;
import static com.azure.ai.openai.implementation.NonAzureOpenAIClientImpl.OPEN_AI_ENDPOINT;
import com.azure.ai.openai.implementation.NonAzureOpenAIClientImpl;
import com.azure.ai.openai.implementation.OpenAIClientImpl;
import com.azure.core.annotation.Generated;
import com.azure.core.annotation.ServiceClientBuilder;
import com.azure.core.client.traits.ConfigurationTrait;
import com.azure.core.client.traits.EndpointTrait;
import com.azure.core.client.traits.HttpTrait;
import com.azure.core.client.traits.KeyCredentialTrait;
import com.azure.core.client.traits.TokenCredentialTrait;
import com.azure.core.credential.KeyCredential;
import com.azure.core.credential.TokenCredential;
import com.azure.core.http.HttpClient;
import com.azure.core.http.HttpHeaders;
import com.azure.core.http.HttpPipeline;
import com.azure.core.http.HttpPipelineBuilder;
import com.azure.core.http.HttpPipelinePosition;
import com.azure.core.http.policy.AddDatePolicy;
import com.azure.core.http.policy.AddHeadersFromContextPolicy;
import com.azure.core.http.policy.AddHeadersPolicy;
import com.azure.core.http.policy.BearerTokenAuthenticationPolicy;
import com.azure.core.http.policy.CookiePolicy;
import com.azure.core.http.policy.HttpLogOptions;
import com.azure.core.http.policy.HttpLoggingPolicy;
import com.azure.core.http.policy.HttpPipelinePolicy;
import com.azure.core.http.policy.HttpPolicyProviders;
import com.azure.core.http.policy.KeyCredentialPolicy;
import com.azure.core.http.policy.RequestIdPolicy;
import com.azure.core.http.policy.RetryOptions;
import com.azure.core.http.policy.RetryPolicy;
import com.azure.core.http.policy.UserAgentPolicy;
import com.azure.core.util.ClientOptions;
import com.azure.core.util.Configuration;
import com.azure.core.util.CoreUtils;
import com.azure.core.util.builder.ClientBuilderUtil;
import com.azure.core.util.logging.ClientLogger;
import com.azure.core.util.serializer.JacksonAdapter;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.Objects;
/** A builder for creating a new instance of the OpenAIClient type. */
@ServiceClientBuilder(serviceClients = {OpenAIClient.class, OpenAIAsyncClient.class})
public final class OpenAIClientBuilder
implements HttpTrait<OpenAIClientBuilder>,
ConfigurationTrait<OpenAIClientBuilder>,
TokenCredentialTrait<OpenAIClientBuilder>,
KeyCredentialTrait<OpenAIClientBuilder>,
EndpointTrait<OpenAIClientBuilder> {
@Generated private static final String SDK_NAME = "name";
@Generated private static final String SDK_VERSION = "version";
@Generated
private static final String[] DEFAULT_SCOPES = new String[] {"https://cognitiveservices.azure.com/.default"};
@Generated
private static final Map<String, String> PROPERTIES = CoreUtils.getProperties("azure-ai-openai.properties");
@Generated private final List<HttpPipelinePolicy> pipelinePolicies;
/** Create an instance of the OpenAIClientBuilder. */
@Generated
public OpenAIClientBuilder() {
this.pipelinePolicies = new ArrayList<>();
}
/*
* The HTTP pipeline to send requests through.
*/
@Generated private HttpPipeline pipeline;
/** {@inheritDoc}. */
@Generated
@Override
public OpenAIClientBuilder pipeline(HttpPipeline pipeline) {
if (this.pipeline != null && pipeline == null) {
LOGGER.info("HttpPipeline is being set to 'null' when it was previously configured.");
}
this.pipeline = pipeline;
return this;
}
/*
* The HTTP client used to send the request.
*/
@Generated private HttpClient httpClient;
/** {@inheritDoc}. */
@Generated
@Override
public OpenAIClientBuilder httpClient(HttpClient httpClient) {
this.httpClient = httpClient;
return this;
}
/*
* The logging configuration for HTTP requests and responses.
*/
@Generated private HttpLogOptions httpLogOptions;
/** {@inheritDoc}. */
@Generated
@Override
public OpenAIClientBuilder httpLogOptions(HttpLogOptions httpLogOptions) {
this.httpLogOptions = httpLogOptions;
return this;
}
/*
* The client options such as application ID and custom headers to set on a request.
*/
@Generated private ClientOptions clientOptions;
/** {@inheritDoc}. */
@Generated
@Override
public OpenAIClientBuilder clientOptions(ClientOptions clientOptions) {
this.clientOptions = clientOptions;
return this;
}
/*
* The retry options to configure retry policy for failed requests.
*/
@Generated private RetryOptions retryOptions;
/** {@inheritDoc}. */
@Generated
@Override
public OpenAIClientBuilder retryOptions(RetryOptions retryOptions) {
this.retryOptions = retryOptions;
return this;
}
/** {@inheritDoc}. */
@Generated
@Override
public OpenAIClientBuilder addPolicy(HttpPipelinePolicy customPolicy) {
Objects.requireNonNull(customPolicy, "'customPolicy' cannot be null.");
pipelinePolicies.add(customPolicy);
return this;
}
/*
* The configuration store that is used during construction of the service client.
*/
@Generated private Configuration configuration;
/** {@inheritDoc}. */
@Generated
@Override
public OpenAIClientBuilder configuration(Configuration configuration) {
this.configuration = configuration;
return this;
}
/*
* The TokenCredential used for authentication.
*/
@Generated private TokenCredential tokenCredential;
/** {@inheritDoc}. */
@Generated
@Override
public OpenAIClientBuilder credential(TokenCredential tokenCredential) {
this.tokenCredential = tokenCredential;
return this;
}
/** The KeyCredential used for OpenAi authentication. It could be either of Azure or Non-Azure OpenAI API key. */
private KeyCredential keyCredential;
/** {@inheritDoc}. */
@Generated
@Override
public OpenAIClientBuilder credential(KeyCredential keyCredential) {
this.keyCredential = keyCredential;
return this;
}
/*
* The service endpoint
*/
@Generated private String endpoint;
/** {@inheritDoc}. */
@Generated
@Override
public OpenAIClientBuilder endpoint(String endpoint) {
this.endpoint = endpoint;
return this;
}
/*
* Service version
*/
@Generated private OpenAIServiceVersion serviceVersion;
/**
* Sets Service version.
*
* @param serviceVersion the serviceVersion value.
* @return the OpenAIClientBuilder.
*/
@Generated
public OpenAIClientBuilder serviceVersion(OpenAIServiceVersion serviceVersion) {
this.serviceVersion = serviceVersion;
return this;
}
/*
* The retry policy that will attempt to retry failed requests, if applicable.
*/
@Generated private RetryPolicy retryPolicy;
/**
* Sets The retry policy that will attempt to retry failed requests, if applicable.
*
* @param retryPolicy the retryPolicy value.
* @return the OpenAIClientBuilder.
*/
@Generated
public OpenAIClientBuilder retryPolicy(RetryPolicy retryPolicy) {
this.retryPolicy = retryPolicy;
return this;
}
/**
* Builds an instance of OpenAIClientImpl with the provided parameters.
*
* @return an instance of OpenAIClientImpl.
*/
@Generated
private OpenAIClientImpl buildInnerClient() {
HttpPipeline localPipeline = (pipeline != null) ? pipeline : createHttpPipeline();
OpenAIServiceVersion localServiceVersion =
(serviceVersion != null) ? serviceVersion : OpenAIServiceVersion.getLatest();
OpenAIClientImpl client =
new OpenAIClientImpl(
localPipeline,
JacksonAdapter.createDefaultSerializerAdapter(),
this.endpoint,
localServiceVersion);
return client;
}
private HttpPipeline createHttpPipeline() {
Configuration buildConfiguration =
(configuration == null) ? Configuration.getGlobalConfiguration() : configuration;
HttpLogOptions localHttpLogOptions = this.httpLogOptions == null ? new HttpLogOptions() : this.httpLogOptions;
ClientOptions localClientOptions = this.clientOptions == null ? new ClientOptions() : this.clientOptions;
List<HttpPipelinePolicy> policies = new ArrayList<>();
String clientName = PROPERTIES.getOrDefault(SDK_NAME, "UnknownName");
String clientVersion = PROPERTIES.getOrDefault(SDK_VERSION, "UnknownVersion");
String applicationId = CoreUtils.getApplicationId(localClientOptions, localHttpLogOptions);
policies.add(new UserAgentPolicy(applicationId, clientName, clientVersion, buildConfiguration));
policies.add(new RequestIdPolicy());
policies.add(new AddHeadersFromContextPolicy());
HttpHeaders headers = new HttpHeaders();
localClientOptions.getHeaders().forEach(header -> headers.set(header.getName(), header.getValue()));
if (headers.getSize() > 0) {
policies.add(new AddHeadersPolicy(headers));
}
this.pipelinePolicies.stream()
.filter(p -> p.getPipelinePosition() == HttpPipelinePosition.PER_CALL)
.forEach(p -> policies.add(p));
HttpPolicyProviders.addBeforeRetryPolicies(policies);
policies.add(ClientBuilderUtil.validateAndGetRetryPolicy(retryPolicy, retryOptions, new RetryPolicy()));
policies.add(new AddDatePolicy());
policies.add(new CookiePolicy());
if (keyCredential != null) {
policies.add(
useNonAzureOpenAIService()
? new KeyCredentialPolicy("Authorization", keyCredential, "Bearer")
: new KeyCredentialPolicy("api-key", keyCredential));
}
if (tokenCredential != null) {
policies.add(new BearerTokenAuthenticationPolicy(tokenCredential, DEFAULT_SCOPES));
}
this.pipelinePolicies.stream()
.filter(p -> p.getPipelinePosition() == HttpPipelinePosition.PER_RETRY)
.forEach(p -> policies.add(p));
HttpPolicyProviders.addAfterRetryPolicies(policies);
policies.add(new HttpLoggingPolicy(httpLogOptions));
HttpPipeline httpPipeline =
new HttpPipelineBuilder()
.policies(policies.toArray(new HttpPipelinePolicy[0]))
.httpClient(httpClient)
.clientOptions(localClientOptions)
.build();
return httpPipeline;
}
private NonAzureOpenAIClientImpl buildInnerNonAzureOpenAIClient() {
HttpPipeline localPipeline = (pipeline != null) ? pipeline : createHttpPipeline();
NonAzureOpenAIClientImpl client =
new NonAzureOpenAIClientImpl(localPipeline, JacksonAdapter.createDefaultSerializerAdapter());
return client;
}
/**
* Builds an instance of OpenAIAsyncClient class.
*
* @return an instance of OpenAIAsyncClient.
*/
public OpenAIAsyncClient buildAsyncClient() {
return useNonAzureOpenAIService()
? new OpenAIAsyncClient(buildInnerNonAzureOpenAIClient())
: new OpenAIAsyncClient(buildInnerClient());
}
/**
* Builds an instance of OpenAIClient class.
*
* @return an instance of OpenAIClient.
*/
public OpenAIClient buildClient() {
return useNonAzureOpenAIService()
? new OpenAIClient(buildInnerNonAzureOpenAIClient())
: new OpenAIClient(buildInnerClient());
}
private static final ClientLogger LOGGER = new ClientLogger(OpenAIClientBuilder.class);
/**
* OpenAI service can be used by either not setting the endpoint or by setting the endpoint to start with
* "https://api.openai.com/"
*/
private boolean useNonAzureOpenAIService() {
return endpoint == null || endpoint.startsWith(OPEN_AI_ENDPOINT);
}
}