Package org.springframework.ai.azure.openai

Class AzureOpenAiChatModel

java.lang.Object

org.springframework.ai.azure.openai.AzureOpenAiChatModel

All Implemented Interfaces:

ChatModel, StreamingChatModel, Model<Prompt,ChatResponse>, StreamingModel<Prompt,ChatResponse>

public class AzureOpenAiChatModel
extends Object
implements ChatModel

ChatModel implementation for Microsoft Azure AI backed by OpenAIClient.

Since:

1.0.0

Author:

Mark Pollack, Ueibin Kim, John Blum, Christian Tzolov, Grogdunn, Benoit Moussaud, Thomas Vitale, luocongqiu, timostark, Soby Chacko, Jihoon Kim, Ilayaperumal Gopinathan, Alexandros Pappas, Berjan Jonker, Andres da Silva Santos, Bart Veenstra

See Also:

• ChatModel
• OpenAIClient

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	AzureOpenAiChatModel.Builder	Builder to construct AzureOpenAiChatModel.

Constructor Summary

Constructors

Constructor	Description
AzureOpenAiChatModel(com.azure.ai.openai.OpenAIClientBuilder openAIClientBuilder, AzureOpenAiChatOptions defaultOptions, ToolCallingManager toolCallingManager, io.micrometer.observation.ObservationRegistry observationRegistry)
AzureOpenAiChatModel(com.azure.ai.openai.OpenAIClientBuilder openAIClientBuilder, AzureOpenAiChatOptions defaultOptions, ToolCallingManager toolCallingManager, io.micrometer.observation.ObservationRegistry observationRegistry, ToolExecutionEligibilityPredicate toolExecutionEligibilityPredicate)

Method Summary

Modifier and Type	Method	Description
static AzureOpenAiChatModel.Builder	builder()
ChatResponse	call(Prompt prompt)	Executes a method call to the AI model.
static ChatResponseMetadata	from(com.azure.ai.openai.models.ChatCompletions chatCompletions, PromptMetadata promptFilterMetadata)
static ChatResponseMetadata	from(com.azure.ai.openai.models.ChatCompletions chatCompletions, PromptMetadata promptFilterMetadata, com.azure.ai.openai.models.CompletionsUsage usage)
static ChatResponseMetadata	from(com.azure.ai.openai.models.ChatCompletions chatCompletions, PromptMetadata promptFilterMetadata, Usage usage)
static ChatResponseMetadata	from(ChatResponse chatResponse, Usage usage)
AzureOpenAiChatOptions	getDefaultOptions()
ChatResponse	internalCall(Prompt prompt, ChatResponse previousChatResponse)
reactor.core.publisher.Flux<ChatResponse>	internalStream(Prompt prompt, ChatResponse previousChatResponse)
void	setObservationConvention(ChatModelObservationConvention observationConvention)	Use the provided convention for reporting observation data
reactor.core.publisher.Flux<ChatResponse>	stream(Prompt prompt)	Executes a method call to the AI model.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.springframework.ai.chat.model.ChatModel

call, call

Methods inherited from interface org.springframework.ai.chat.model.StreamingChatModel

stream, stream

Constructor Details

AzureOpenAiChatModel

public AzureOpenAiChatModel(com.azure.ai.openai.OpenAIClientBuilder openAIClientBuilder,
 AzureOpenAiChatOptions defaultOptions,
 ToolCallingManager toolCallingManager,
 io.micrometer.observation.ObservationRegistry observationRegistry)

AzureOpenAiChatModel

public AzureOpenAiChatModel(com.azure.ai.openai.OpenAIClientBuilder openAIClientBuilder,
 AzureOpenAiChatOptions defaultOptions,
 ToolCallingManager toolCallingManager,
 io.micrometer.observation.ObservationRegistry observationRegistry,
 ToolExecutionEligibilityPredicate toolExecutionEligibilityPredicate)

Method Details

from

public static ChatResponseMetadata from(com.azure.ai.openai.models.ChatCompletions chatCompletions,
 PromptMetadata promptFilterMetadata,
 Usage usage)

from

public static ChatResponseMetadata from(com.azure.ai.openai.models.ChatCompletions chatCompletions,
 PromptMetadata promptFilterMetadata)

from

public static ChatResponseMetadata from(com.azure.ai.openai.models.ChatCompletions chatCompletions,
 PromptMetadata promptFilterMetadata,
 com.azure.ai.openai.models.CompletionsUsage usage)

from

public static ChatResponseMetadata from(ChatResponse chatResponse,
 Usage usage)

getDefaultOptions

public AzureOpenAiChatOptions getDefaultOptions()

Specified by:

getDefaultOptions in interface ChatModel

call

public ChatResponse call(Prompt prompt)

Description copied from interface: Model

Executes a method call to the AI model.

Specified by:

call in interface ChatModel

Specified by:

call in interface Model<Prompt,ChatResponse>

Parameters:

prompt - the request object to be sent to the AI model

Returns:

the response from the AI model

internalCall

public ChatResponse internalCall(Prompt prompt,
 ChatResponse previousChatResponse)

stream

public reactor.core.publisher.Flux<ChatResponse> stream(Prompt prompt)

Description copied from interface: StreamingModel

Executes a method call to the AI model.

Specified by:

stream in interface ChatModel

Specified by:

stream in interface StreamingChatModel

Specified by:

stream in interface StreamingModel<Prompt,ChatResponse>

Parameters:

prompt - the request object to be sent to the AI model

Returns:

the streaming response from the AI model

internalStream

public reactor.core.publisher.Flux<ChatResponse> internalStream(Prompt prompt,
 ChatResponse previousChatResponse)

setObservationConvention

public void setObservationConvention(ChatModelObservationConvention observationConvention)

Use the provided convention for reporting observation data

Parameters:

observationConvention - The provided convention

builder

public static AzureOpenAiChatModel.Builder builder()