Add support for OpenAI Java SDK (official Java library from OpenAI)

models/spring-ai-openai-official/README.md

@@ -0,0 +1,5 @@
+# OpenAI Java API Library
+
+This is the official OpenAI Java SDK from OpenAI, which provides integration with OpenAI's services, including Azure OpenAI.
+
+[OpenAI Java API Library GitHub repository](https://github.com/openai/openai-java)

models/spring-ai-openai-official/pom.xml

@@ -0,0 +1,88 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+  ~ Copyright 2025 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.
+  -->
+
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
+	<modelVersion>4.0.0</modelVersion>
+	<parent>
+		<groupId>org.springframework.ai</groupId>
+		<artifactId>spring-ai-parent</artifactId>
+		<version>1.1.0-SNAPSHOT</version>
+		<relativePath>../../pom.xml</relativePath>
+	</parent>
+	<artifactId>spring-ai-openai-official</artifactId>
+	<packaging>jar</packaging>
+	<name>Spring AI Model - OpenAI Official</name>
+	<description>OpenAI Java API Library support</description>
+	<url>https://github.com/spring-projects/spring-ai</url>
+
+	<scm>
+		<url>https://github.com/spring-projects/spring-ai</url>
+		<connection>git://github.com/spring-projects/spring-ai.git</connection>
+		<developerConnection>[email protected]:spring-projects/spring-ai.git</developerConnection>
+	</scm>
+
+	<properties>
+	</properties>
+
+	<dependencies>
+
+		<!-- production dependencies -->
+		<dependency>
+			<groupId>org.springframework.ai</groupId>
+			<artifactId>spring-ai-model</artifactId>
+			<version>${project.parent.version}</version>
+		</dependency>
+
+		<dependency>
+			<groupId>com.openai</groupId>
+			<artifactId>openai-java</artifactId>
+			<version>${openai-official.version}</version>
+		</dependency>
+
+		<!-- Spring Framework -->
+		<dependency>
+			<groupId>org.springframework</groupId>
+			<artifactId>spring-context-support</artifactId>
+		</dependency>
+
+		<dependency>
+			<groupId>org.slf4j</groupId>
+			<artifactId>slf4j-api</artifactId>
+		</dependency>
+
+		<!-- test dependencies -->
+		<dependency>
+			<groupId>org.springframework.ai</groupId>
+			<artifactId>spring-ai-test</artifactId>
+			<version>${project.version}</version>
+			<scope>test</scope>
+		</dependency>
+
+		<dependency>
+			<groupId>org.springframework.boot</groupId>
+			<artifactId>spring-boot-starter-test</artifactId>
+			<scope>test</scope>
+		</dependency>
+
+		<dependency>
+			<groupId>io.micrometer</groupId>
+			<artifactId>micrometer-observation-test</artifactId>
+			<scope>test</scope>
+		</dependency>
+	</dependencies>
+
+</project>

models/spring-ai-openai-official/src/main/java/org/springframework/ai/openaiofficial/OpenAiOfficialEmbeddingModel.java

@@ -0,0 +1,167 @@
+package org.springframework.ai.openaiofficial;
+
+import com.openai.client.OpenAIClient;
+import com.openai.models.embeddings.CreateEmbeddingResponse;
+import com.openai.models.embeddings.EmbeddingCreateParams;
+import io.micrometer.observation.ObservationRegistry;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.springframework.ai.chat.metadata.DefaultUsage;
+import org.springframework.ai.document.Document;
+import org.springframework.ai.document.MetadataMode;
+import org.springframework.ai.embedding.AbstractEmbeddingModel;
+import org.springframework.ai.embedding.Embedding;
+import org.springframework.ai.embedding.EmbeddingRequest;
+import org.springframework.ai.embedding.EmbeddingResponse;
+import org.springframework.ai.embedding.EmbeddingResponseMetadata;
+import org.springframework.ai.embedding.observation.DefaultEmbeddingModelObservationConvention;
+import org.springframework.ai.embedding.observation.EmbeddingModelObservationContext;
+import org.springframework.ai.embedding.observation.EmbeddingModelObservationConvention;
+import org.springframework.ai.embedding.observation.EmbeddingModelObservationDocumentation;
+import org.springframework.ai.model.EmbeddingUtils;
+import org.springframework.ai.observation.conventions.AiProvider;
+import org.springframework.util.Assert;
+import org.springframework.util.CollectionUtils;
+
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Objects;
+
+import static com.openai.models.embeddings.EmbeddingModel.TEXT_EMBEDDING_ADA_002;
+
+public class OpenAiOfficialEmbeddingModel extends AbstractEmbeddingModel {
+
+	private static final Logger logger = LoggerFactory.getLogger(OpenAiOfficialEmbeddingModel.class);
+
+	private static final EmbeddingModelObservationConvention DEFAULT_OBSERVATION_CONVENTION = new DefaultEmbeddingModelObservationConvention();
+
+	private final OpenAIClient openAiClient;
+
+	private final OpenAiOfficialEmbeddingOptions defaultOptions;
+
+	private final MetadataMode metadataMode;
+
+	/**
+	 * Observation registry used for instrumentation.
+	 */
+	private final ObservationRegistry observationRegistry;
+
+	/**
+	 * Conventions to use for generating observations.
+	 */
+	private EmbeddingModelObservationConvention observationConvention = DEFAULT_OBSERVATION_CONVENTION;
+
+	public OpenAiOfficialEmbeddingModel(OpenAIClient openAiClient) {
+		this(openAiClient, MetadataMode.EMBED);
+	}
+
+	public OpenAiOfficialEmbeddingModel(OpenAIClient openAiClient, MetadataMode metadataMode) {
+		this(openAiClient, metadataMode,
+				OpenAiOfficialEmbeddingOptions.builder().deploymentName(TEXT_EMBEDDING_ADA_002.toString()).build());
+	}
+
+	public OpenAiOfficialEmbeddingModel(OpenAIClient openAiClient, MetadataMode metadataMode,
+			OpenAiOfficialEmbeddingOptions options) {
+		this(openAiClient, metadataMode, options, ObservationRegistry.NOOP);
+	}
+
+	public OpenAiOfficialEmbeddingModel(OpenAIClient openAiClient, MetadataMode metadataMode,
+			OpenAiOfficialEmbeddingOptions options, ObservationRegistry observationRegistry) {
+
+		Assert.notNull(openAiClient, "com.openai.client.OpenAIClient must not be null");
+		Assert.notNull(metadataMode, "Metadata mode must not be null");
+		Assert.notNull(options, "Options must not be null");
+		Assert.notNull(observationRegistry, "Observation registry must not be null");
+		this.openAiClient = openAiClient;
+		this.metadataMode = metadataMode;
+		this.defaultOptions = options;
+		this.observationRegistry = observationRegistry;
+	}
+
+	@Override
+	public float[] embed(Document document) {
+		logger.debug("Retrieving embeddings");
+
+		EmbeddingResponse response = this
+			.call(new EmbeddingRequest(List.of(document.getFormattedContent(this.metadataMode)), null));
+		logger.debug("Embeddings retrieved");
+
+		if (CollectionUtils.isEmpty(response.getResults())) {
+			return new float[0];
+		}
+		return response.getResults().get(0).getOutput();
+	}
+
+	@Override
+	public EmbeddingResponse call(EmbeddingRequest embeddingRequest) {
+		logger.debug("Retrieving embeddings");
+
+		OpenAiOfficialEmbeddingOptions options = OpenAiOfficialEmbeddingOptions.builder()
+			.from(this.defaultOptions)
+			.merge(embeddingRequest.getOptions())
+			.build();
+
+		EmbeddingRequest embeddingRequestWithMergedOptions = new EmbeddingRequest(embeddingRequest.getInstructions(),
+				options);
+
+		EmbeddingCreateParams embeddingCreateParams = options
+			.toOpenAiCreateParams(embeddingRequestWithMergedOptions.getInstructions());
+
+		var observationContext = EmbeddingModelObservationContext.builder()
+			.embeddingRequest(embeddingRequestWithMergedOptions)
+			.provider(AiProvider.AZURE_OPENAI.value())
+			.build();
+
+		return Objects.requireNonNull(
+				EmbeddingModelObservationDocumentation.EMBEDDING_MODEL_OPERATION
+					.observation(this.observationConvention, DEFAULT_OBSERVATION_CONVENTION, () -> observationContext,
+							this.observationRegistry)
+					.observe(() -> {
+						CreateEmbeddingResponse response = this.openAiClient.embeddings().create(embeddingCreateParams);
+
+						logger.debug("Embeddings retrieved");
+						var embeddingResponse = generateEmbeddingResponse(response);
+						observationContext.setResponse(embeddingResponse);
+						return embeddingResponse;
+					}));
+	}
+
+	private EmbeddingResponse generateEmbeddingResponse(CreateEmbeddingResponse response) {
+
+		List<Embedding> data = generateEmbeddingList(response.data());
+		EmbeddingResponseMetadata metadata = new EmbeddingResponseMetadata();
+		metadata.setUsage(getDefaultUsage(response.usage()));
+		return new EmbeddingResponse(data, metadata);
+	}
+
+	private DefaultUsage getDefaultUsage(CreateEmbeddingResponse.Usage nativeUsage) {
+		return new DefaultUsage(Math.toIntExact(nativeUsage.promptTokens()), 0,
+				Math.toIntExact(nativeUsage.totalTokens()), nativeUsage);
+	}
+
+	private List<Embedding> generateEmbeddingList(List<com.openai.models.embeddings.Embedding> nativeData) {
+		List<Embedding> data = new ArrayList<>();
+		for (com.openai.models.embeddings.Embedding nativeDatum : nativeData) {
+			List<Float> nativeDatumEmbedding = nativeDatum.embedding();
+			Long nativeIndex = nativeDatum.index();
+			Embedding embedding = new Embedding(EmbeddingUtils.toPrimitive(nativeDatumEmbedding),
+					Math.toIntExact(nativeIndex));
+			data.add(embedding);
+		}
+		return data;
+	}
+
+	public OpenAiOfficialEmbeddingOptions getDefaultOptions() {
+		return this.defaultOptions;
+	}
+
+	/**
+	 * Use the provided convention for reporting observation data
+	 * @param observationConvention The provided convention
+	 */
+	public void setObservationConvention(EmbeddingModelObservationConvention observationConvention) {
+		Assert.notNull(observationConvention, "observationConvention cannot be null");
+		this.observationConvention = observationConvention;
+	}
+
+}