Spring/spring-ai
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Remove the obsolate okhttp and the related interceptor

Browse Source 
The OpenAiApi, returns the HTTP headers that can be intropsect for metadata
 with the help of OpenAiResponseHeaderExtractor.
 No need for http interception nor for joining by ID.
This commit is contained in:
Christian Tzolov
2023-12-22 08:49:12 +01:00
parent 6cec33b4bd
commit aebfd719a7
4 changed files with 3 additions and 258 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
models/spring-ai-openai/pom.xml
View File

@@ -39,11 +39,6 @@
<artifactId>json-path</artifactId>
</dependency>
<dependency>
<groupId>com.squareup.okhttp3</groupId>
<artifactId>okhttp</artifactId>
</dependency>
<dependency>
<groupId>com.github.victools</groupId>
<artifactId>jsonschema-generator</artifactId>

2
models/spring-ai-openai/src/main/java/org/springframework/ai/openai/metadata/OpenAiGenerationMetadata.java
View File

@@ -20,7 +20,6 @@ import org.springframework.ai.metadata.GenerationMetadata;
import org.springframework.ai.metadata.RateLimit;
import org.springframework.ai.metadata.Usage;
import org.springframework.ai.openai.api.OpenAiApi;
import org.springframework.ai.openai.metadata.support.OpenAiHttpResponseHeadersInterceptor;
import org.springframework.lang.Nullable;
import org.springframework.util.Assert;
@@ -41,7 +40,6 @@ public class OpenAiGenerationMetadata implements GenerationMetadata {
Assert.notNull(result, "OpenAI ChatCompletionResult must not be null");
OpenAiUsage usage = OpenAiUsage.from(result.usage());
OpenAiGenerationMetadata generationMetadata = new OpenAiGenerationMetadata(result.id(), usage);
OpenAiHttpResponseHeadersInterceptor.applyTo(generationMetadata);
return generationMetadata;
}

249
models/spring-ai-openai/src/main/java/org/springframework/ai/openai/metadata/support/OpenAiHttpResponseHeadersInterceptor.java
View File

@@ -1,249 +0,0 @@
/*
* Copyright 2023 the original author or authors.
*
* 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.
*/
package org.springframework.ai.openai.metadata.support;
import static org.springframework.ai.openai.metadata.support.OpenAiApiResponseHeaders.REQUESTS_LIMIT_HEADER;
import static org.springframework.ai.openai.metadata.support.OpenAiApiResponseHeaders.REQUESTS_REMAINING_HEADER;
import static org.springframework.ai.openai.metadata.support.OpenAiApiResponseHeaders.REQUESTS_RESET_HEADER;
import static org.springframework.ai.openai.metadata.support.OpenAiApiResponseHeaders.TOKENS_LIMIT_HEADER;
import static org.springframework.ai.openai.metadata.support.OpenAiApiResponseHeaders.TOKENS_REMAINING_HEADER;
import static org.springframework.ai.openai.metadata.support.OpenAiApiResponseHeaders.TOKENS_RESET_HEADER;
import java.io.IOException;
import java.time.Duration;
import java.time.temporal.ChronoUnit;
import java.util.Arrays;
import java.util.Collections;
import java.util.Map;
import java.util.WeakHashMap;
import java.util.function.Predicate;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import io.restassured.path.json.JsonPath;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.ai.metadata.RateLimit;
import org.springframework.ai.openai.metadata.OpenAiGenerationMetadata;
import org.springframework.ai.openai.metadata.OpenAiRateLimit;
import org.springframework.http.HttpHeaders;
import org.springframework.util.Assert;
import org.springframework.util.StringUtils;
import okhttp3.Interceptor;
import okhttp3.Request;
import okhttp3.Response;
import okhttp3.ResponseBody;
/**
* OkHttp {@link Interceptor} implementation used capture the AI HTTP response headers
* from {@literal OpenAI} API.
*
* @author John Blum
* @see okhttp3.Interceptor
* @since 0.7.0
*/
public class OpenAiHttpResponseHeadersInterceptor implements Interceptor {
private static final Map<String, OpenAiRateLimit> cache = Collections.synchronizedMap(new WeakHashMap<>());
public static void applyTo(OpenAiGenerationMetadata metadata) {
String id = metadata.getId();
synchronized (cache) {
metadata.withRateLimit(cache.get(id));
cache.remove(id);
}
}
private final Logger logger = LoggerFactory.getLogger(getClass());
@Override
public Response intercept(Chain chain) throws IOException {
Request request = chain.request();
Response response = chain.proceed(request);
cacheAiResponseHeaders(response);
return response;
}
protected Logger getLogger() {
return this.logger;
}
private RateLimit cacheAiResponseHeaders(Response response) {
String id = parseAiResponseId(response);
OpenAiRateLimit rateLimit = StringUtils.hasText(id) ? cache.computeIfAbsent(id, key -> {
Long requestsLimit = getHeaderAsLong(response, REQUESTS_LIMIT_HEADER.getName());
Long requestsRemaining = getHeaderAsLong(response, REQUESTS_REMAINING_HEADER.getName());
Long tokensLimit = getHeaderAsLong(response, TOKENS_LIMIT_HEADER.getName());
Long tokensRemaining = getHeaderAsLong(response, TOKENS_REMAINING_HEADER.getName());
Duration requestsReset = getHeaderAsDuration(response, REQUESTS_RESET_HEADER.getName());
Duration tokensReset = getHeaderAsDuration(response, TOKENS_RESET_HEADER.getName());
return new OpenAiRateLimit(requestsLimit, requestsRemaining, requestsReset, tokensLimit, tokensRemaining,
tokensReset);
}) : null;
return rateLimit;
}
private Duration getHeaderAsDuration(Response response, String headerName) {
String headerValue = response.header(headerName);
return DurationFormatter.TIME_UNIT.parse(headerValue);
}
private Long getHeaderAsLong(Response response, String headerName) {
String headerValue = response.header(headerName);
return parseLong(headerName, headerValue);
}
private String parseAiResponseId(Response response) {
try {
long contentLength = resolveContentLength(response);
ResponseBody responseBody = response.peekBody(contentLength);
String bodyContent = responseBody.string();
String id = JsonPath.with(bodyContent).getString("id");
return id;
}
catch (Exception e) {
getLogger().warn("Unable to get AI response body as a String: {}", e.getMessage());
return null;
}
}
private Long parseLong(String headerName, String headerValue) {
if (StringUtils.hasText(headerValue)) {
try {
return Long.parseLong(headerValue.trim());
}
catch (NumberFormatException e) {
getLogger().warn("Value [{}] for HTTP header [{}] is not valid: {}", headerName, headerValue,
e.getMessage());
}
}
return null;
}
private long resolveContentLength(Response response) {
return getHeaderAsLong(response, HttpHeaders.CONTENT_LENGTH);
}
enum DurationFormatter {
TIME_UNIT("\\d+[a-zA-Z]{1,2}");
private final Pattern pattern;
DurationFormatter(String durationPattern) {
this.pattern = Pattern.compile(durationPattern);
}
public Duration parse(String text) {
Assert.hasText(text, "Text [%s] to parse as a Duration must not be null or empty".formatted(text));
Matcher matcher = this.pattern.matcher(text);
Duration total = Duration.ZERO;
while (matcher.find()) {
String value = matcher.group();
total = total.plus(Unit.parseUnit(value).toDuration(value));
}
return total;
}
enum Unit {
NANOSECONDS("ns", "nanoseconds", ChronoUnit.NANOS), MICROSECONDS("us", "microseconds", ChronoUnit.MICROS),
MILLISECONDS("ms", "milliseconds", ChronoUnit.MILLIS), SECONDS("s", "seconds", ChronoUnit.SECONDS),
MINUTES("m", "minutes", ChronoUnit.MINUTES), HOURS("h", "hours", ChronoUnit.HOURS),
DAYS("d", "days", ChronoUnit.DAYS);
private final String name;
private final String symbol;
private final ChronoUnit unit;
Unit(String symbol, String name, ChronoUnit unit) {
this.symbol = symbol;
this.name = name;
this.unit = unit;
}
static Unit parseUnit(String value) {
String symbol = parseSymbol(value);
return Arrays.stream(values())
.filter(unit -> unit.getSymbol().equalsIgnoreCase(symbol))
.findFirst()
.orElseThrow(() -> new IllegalStateException(
"Value [%s] does not contain a valid time unit".formatted(value)));
}
private static String parse(String value, Predicate<Character> predicate) {
Assert.hasText(value, "Value [%s] must not be null or empty".formatted(value));
StringBuilder builder = new StringBuilder();
for (char character : value.toCharArray()) {
if (predicate.test(character)) {
builder.append(character);
}
}
return builder.toString();
}
private static String parseSymbol(String value) {
return parse(value, Character::isLetter);
}
private static Long parseTime(String value) {
return Long.parseLong(parse(value, Character::isDigit));
}
public String getName() {
return this.name;
}
public String getSymbol() {
return this.symbol;
}
public ChronoUnit getUnit() {
return this.unit;
}
public Duration toDuration(String value) {
return Duration.of(parseTime(value), getUnit());
}
}
}
}

5
models/spring-ai-openai/src/test/java/org/springframework/ai/openai/metadata/support/OpenAiHttpResponseHeadersInterceptorTests.java → models/spring-ai-openai/src/test/java/org/springframework/ai/openai/metadata/support/OpenAiResponseHeaderExtractorTests.java
View File

@@ -22,15 +22,16 @@ import java.time.Duration;
import org.junit.jupiter.api.Test;
import org.springframework.ai.openai.metadata.support.OpenAiHttpResponseHeadersInterceptor.DurationFormatter;
import org.springframework.ai.openai.metadata.support.OpenAiResponseHeaderExtractor.DurationFormatter;
/**
* Unit Tests for {@link OpenAiHttpResponseHeadersInterceptor}.
*
* @author John Blum
* @author Christian Tzolov
* @since 0.7.0
*/
public class OpenAiHttpResponseHeadersInterceptorTests {
public class OpenAiResponseHeaderExtractorTests {
@Test
void parseTimeAsDurationWithDaysHoursMinutesSeconds() {