Package org.springframework.ai.azure.openai

Class AzureOpenAiChatClient

java.lang.Object

org.springframework.ai.azure.openai.AzureOpenAiChatClient

All Implemented Interfaces:

ChatClient, StreamingChatClient, ModelClient<Prompt,ChatResponse>, StreamingModelClient<Prompt,ChatResponse>

public class AzureOpenAiChatClient
extends Object
implements ChatClient, StreamingChatClient

ChatClient implementation for Microsoft Azure AI backed by OpenAIClient.

Author:

Mark Pollack, Ueibin Kim, John Blum, Christian Tzolov

See Also:

• ChatClient
• OpenAIClient

Constructor Summary

Constructors

Constructor	Description
AzureOpenAiChatClient(com.azure.ai.openai.OpenAIClient microsoftOpenAiClient)
AzureOpenAiChatClient(com.azure.ai.openai.OpenAIClient microsoftOpenAiClient, AzureOpenAiChatOptions options)

Method Summary

Modifier and Type	Method	Description
ChatResponse	call(Prompt prompt)	Executes a method call to the AI model.
AzureOpenAiChatOptions	getDefaultOptions()
reactor.core.publisher.Flux<ChatResponse>	stream(Prompt prompt)	Executes a method call to the AI model.
AzureOpenAiChatClient	withDefaultOptions(AzureOpenAiChatOptions defaultOptions)	Deprecated, for removal: This API element is subject to removal in a future version. since 0.8.0, use AzureOpenAiChatClient(OpenAIClient, AzureOpenAiChatOptions) instead.

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.ChatClient

call

Constructor Details

AzureOpenAiChatClient

public AzureOpenAiChatClient(com.azure.ai.openai.OpenAIClient microsoftOpenAiClient)

AzureOpenAiChatClient

public AzureOpenAiChatClient(com.azure.ai.openai.OpenAIClient microsoftOpenAiClient,
 AzureOpenAiChatOptions options)

Method Details

withDefaultOptions

@Deprecated(forRemoval=true,
            since="0.8.0")
public AzureOpenAiChatClient withDefaultOptions(AzureOpenAiChatOptions defaultOptions)

Deprecated, for removal: This API element is subject to removal in a future version.

since 0.8.0, use AzureOpenAiChatClient(OpenAIClient, AzureOpenAiChatOptions) instead.

getDefaultOptions

public AzureOpenAiChatOptions getDefaultOptions()

call

public ChatResponse call(Prompt prompt)

Description copied from interface: ModelClient

Executes a method call to the AI model.

Specified by:

call in interface ChatClient

Specified by:

call in interface ModelClient<Prompt,ChatResponse>

Parameters:

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

Returns:

the response from the AI model

stream

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

Description copied from interface: StreamingModelClient

Executes a method call to the AI model.

Specified by:

stream in interface StreamingChatClient

Specified by:

stream in interface StreamingModelClient<Prompt,ChatResponse>

Parameters:

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

Returns:

the streaming response from the AI model