Package org.springframework.ai.chat.client

Class DefaultChatClient.DefaultCallResponseSpec

java.lang.Object

org.springframework.ai.chat.client.DefaultChatClient.DefaultCallResponseSpec

All Implemented Interfaces:

ChatClient.CallResponseSpec

Enclosing class:

DefaultChatClient

public static class DefaultChatClient.DefaultCallResponseSpec
extends Object
implements ChatClient.CallResponseSpec

Constructor Summary

Constructors

Constructor	Description
DefaultCallResponseSpec(ChatClientRequest chatClientRequest, BaseAdvisorChain advisorChain, io.micrometer.observation.ObservationRegistry observationRegistry, ChatClientObservationConvention observationConvention)

Method Summary

Modifier and Type	Method	Description
ChatClientResponse	chatClientResponse()
@Nullable ChatResponse	chatResponse()
@Nullable String	content()
protected <T> ResponseEntity<ChatResponse,T>	doResponseEntity(StructuredOutputConverter<T> outputConverter)
protected <T> ResponseEntity<ChatResponse,T>	doResponseEntity(StructuredOutputConverter<T> outputConverter, BaseAdvisorChain advisorChain)
<T> @Nullable T	entity(Class<T> type)	Deserializes the response into a T instance.
<T> @Nullable T	entity(Class<T> type, Consumer<ChatClient.EntityParamSpec> entitySpecConsumer)	Deserializes the response into a T instance, with behaviour configured via the entityParamSpecConsumer.
<T> @Nullable T	entity(StructuredOutputConverter<T> structuredOutputConverter)	Deserializes the response using the given converter.
<T> @Nullable T	entity(StructuredOutputConverter<T> structuredOutputConverter, Consumer<ChatClient.EntityParamSpec> entitySpecConsumer)	Deserializes the response using the given converter, with behaviour configured via the entityParamSpecConsumer.
<T> @Nullable T	entity(org.springframework.core.ParameterizedTypeReference<T> type)	Deserializes the response into a T instance.
<T> @Nullable T	entity(org.springframework.core.ParameterizedTypeReference<T> type, Consumer<ChatClient.EntityParamSpec> entitySpecConsumer)	Deserializes the response into a T instance, with behaviour configured via the entityParamSpecConsumer.
<T> ResponseEntity<ChatResponse,T>	responseEntity(Class<T> type)	Returns a ResponseEntity containing both the complete ChatResponse object and a specific entity type.
<T> ResponseEntity<ChatResponse,T>	responseEntity(Class<T> type, Consumer<ChatClient.EntityParamSpec> entityParamSpecConsumer)	Returns a ResponseEntity containing both the complete ChatResponse object and a specific entity type, with behaviour configured via the entityParamSpecConsumer.
<T> ResponseEntity<ChatResponse,T>	responseEntity(StructuredOutputConverter<T> structuredOutputConverter)	Returns a ResponseEntity containing both the complete ChatResponse object and an entity converted using a specified StructuredOutputConverter.
<T> ResponseEntity<ChatResponse,T>	responseEntity(StructuredOutputConverter<T> structuredOutputConverter, Consumer<ChatClient.EntityParamSpec> entityParamSpecConsumer)	Returns a ResponseEntity containing both the complete ChatResponse object and an entity converted using a specified StructuredOutputConverter, with behaviour configured via the entityParamSpecConsumer.
<T> ResponseEntity<ChatResponse,T>	responseEntity(org.springframework.core.ParameterizedTypeReference<T> type)	Returns a ResponseEntity containing both the complete ChatResponse object and a Collection of entity types.
<T> ResponseEntity<ChatResponse,T>	responseEntity(org.springframework.core.ParameterizedTypeReference<T> type, Consumer<ChatClient.EntityParamSpec> entityParamSpecConsumer)	Returns a ResponseEntity containing both the complete ChatResponse object and a specific entity type, with behaviour configured via the entityParamSpecConsumer.

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultCallResponseSpec

public DefaultCallResponseSpec(ChatClientRequest chatClientRequest,
 BaseAdvisorChain advisorChain,
 io.micrometer.observation.ObservationRegistry observationRegistry,
 ChatClientObservationConvention observationConvention)

Method Details

responseEntity

public <T> ResponseEntity<ChatResponse,T> responseEntity(Class<T> type,
 Consumer<ChatClient.EntityParamSpec> entityParamSpecConsumer)

Description copied from interface: ChatClient.CallResponseSpec

Returns a ResponseEntity containing both the complete ChatResponse object and a specific entity type, with behaviour configured via the entityParamSpecConsumer.

Specified by:

responseEntity in interface ChatClient.CallResponseSpec

Parameters:

type - the target class

entityParamSpecConsumer - configures options such as ChatClient.EntityParamSpec.useProviderStructuredOutput() and ChatClient.EntityParamSpec.validateSchema()

Returns:

the ResponseEntity containing both the complete ChatResponse object and the deserialized entity

responseEntity

public <T> ResponseEntity<ChatResponse,T> responseEntity(Class<T> type)

Description copied from interface: ChatClient.CallResponseSpec

Returns a ResponseEntity containing both the complete ChatResponse object and a specific entity type.

Specified by:

responseEntity in interface ChatClient.CallResponseSpec

Parameters:

type - the target class

Returns:

the ResponseEntity containing both the complete ChatResponse object and the deserialized entity

responseEntity

public <T> ResponseEntity<ChatResponse,T> responseEntity(org.springframework.core.ParameterizedTypeReference<T> type,
 Consumer<ChatClient.EntityParamSpec> entityParamSpecConsumer)

Description copied from interface: ChatClient.CallResponseSpec

Returns a ResponseEntity containing both the complete ChatResponse object and a specific entity type, with behaviour configured via the entityParamSpecConsumer.

Specified by:

responseEntity in interface ChatClient.CallResponseSpec

Parameters:

type - the target parameterized type

entityParamSpecConsumer - configures options such as ChatClient.EntityParamSpec.useProviderStructuredOutput() and ChatClient.EntityParamSpec.validateSchema()

Returns:

the ResponseEntity containing both the complete ChatResponse object and the deserialized entity

responseEntity

public <T> ResponseEntity<ChatResponse,T> responseEntity(org.springframework.core.ParameterizedTypeReference<T> type)

Description copied from interface: ChatClient.CallResponseSpec

Returns a ResponseEntity containing both the complete ChatResponse object and a Collection of entity types.

Specified by:

responseEntity in interface ChatClient.CallResponseSpec

Parameters:

type - the target parameterized type

Returns:

the ResponseEntity containing both the complete ChatResponse object and the deserialized entities

responseEntity

public <T> ResponseEntity<ChatResponse,T> responseEntity(StructuredOutputConverter<T> structuredOutputConverter,
 Consumer<ChatClient.EntityParamSpec> entityParamSpecConsumer)

Description copied from interface: ChatClient.CallResponseSpec

Returns a ResponseEntity containing both the complete ChatResponse object and an entity converted using a specified StructuredOutputConverter, with behaviour configured via the entityParamSpecConsumer.

Specified by:

responseEntity in interface ChatClient.CallResponseSpec

Parameters:

structuredOutputConverter - the converter for parsing and schema resolution

entityParamSpecConsumer - configures options such as ChatClient.EntityParamSpec.useProviderStructuredOutput() and ChatClient.EntityParamSpec.validateSchema()

Returns:

the ResponseEntity containing both the complete ChatResponse object and the deserialized entity

responseEntity

public <T> ResponseEntity<ChatResponse,T> responseEntity(StructuredOutputConverter<T> structuredOutputConverter)

Description copied from interface: ChatClient.CallResponseSpec

Returns a ResponseEntity containing both the complete ChatResponse object and an entity converted using a specified StructuredOutputConverter.

Specified by:

responseEntity in interface ChatClient.CallResponseSpec

Parameters:

structuredOutputConverter - the converter for parsing and schema resolution

Returns:

the ResponseEntity containing both the complete ChatResponse object and the deserialized entity

doResponseEntity

protected <T> ResponseEntity<ChatResponse,T> doResponseEntity(StructuredOutputConverter<T> outputConverter)

doResponseEntity

protected <T> ResponseEntity<ChatResponse,T> doResponseEntity(StructuredOutputConverter<T> outputConverter,
 BaseAdvisorChain advisorChain)

entity

public <T> @Nullable T entity(org.springframework.core.ParameterizedTypeReference<T> type,
 Consumer<ChatClient.EntityParamSpec> entitySpecConsumer)

Description copied from interface: ChatClient.CallResponseSpec

Deserializes the response into a T instance, with behaviour configured via the entityParamSpecConsumer.

Specified by:

entity in interface ChatClient.CallResponseSpec

Parameters:

type - the target parameterized type

entitySpecConsumer - configures options such as ChatClient.EntityParamSpec.useProviderStructuredOutput() and ChatClient.EntityParamSpec.validateSchema()

Returns:

the deserialized entity, or null if the response is empty

entity

public <T> @Nullable T entity(Class<T> type,
 Consumer<ChatClient.EntityParamSpec> entitySpecConsumer)

Description copied from interface: ChatClient.CallResponseSpec

Deserializes the response into a T instance, with behaviour configured via the entityParamSpecConsumer.

Specified by:

entity in interface ChatClient.CallResponseSpec

Parameters:

type - the target class

entitySpecConsumer - configures options such as ChatClient.EntityParamSpec.useProviderStructuredOutput() and ChatClient.EntityParamSpec.validateSchema()

Returns:

the deserialized entity, or null if the response is empty

entity

public <T> @Nullable T entity(org.springframework.core.ParameterizedTypeReference<T> type)

Description copied from interface: ChatClient.CallResponseSpec

Deserializes the response into a T instance.

Specified by:

entity in interface ChatClient.CallResponseSpec

Parameters:

type - the target parameterized type

Returns:

the deserialized entity, or null if the response is empty

entity

public <T> @Nullable T entity(StructuredOutputConverter<T> structuredOutputConverter,
 Consumer<ChatClient.EntityParamSpec> entitySpecConsumer)

Description copied from interface: ChatClient.CallResponseSpec

Deserializes the response using the given converter, with behaviour configured via the entityParamSpecConsumer.

Specified by:

entity in interface ChatClient.CallResponseSpec

Parameters:

structuredOutputConverter - the converter for parsing and schema resolution

entitySpecConsumer - configures options such as ChatClient.EntityParamSpec.useProviderStructuredOutput() and ChatClient.EntityParamSpec.validateSchema()

Returns:

the deserialized entity, or null if the response is empty

entity

public <T> @Nullable T entity(StructuredOutputConverter<T> structuredOutputConverter)

Description copied from interface: ChatClient.CallResponseSpec

Deserializes the response using the given converter.

Specified by:

entity in interface ChatClient.CallResponseSpec

Parameters:

structuredOutputConverter - the converter for parsing and schema resolution

Returns:

the deserialized entity, or null if the response is empty

entity

public <T> @Nullable T entity(Class<T> type)

Description copied from interface: ChatClient.CallResponseSpec

Deserializes the response into a T instance.

Specified by:

entity in interface ChatClient.CallResponseSpec

Parameters:

type - the target class

Returns:

the deserialized entity, or null if the response is empty

chatClientResponse

public ChatClientResponse chatClientResponse()

Specified by:

chatClientResponse in interface ChatClient.CallResponseSpec

chatResponse

public @Nullable ChatResponse chatResponse()

Specified by:

chatResponse in interface ChatClient.CallResponseSpec

content

public @Nullable String content()

Specified by:

content in interface ChatClient.CallResponseSpec