Package dev.langchain4j.service.spring

Annotation Interface AiService

@Service
@Target(TYPE)
@Retention(RUNTIME)
public @interface AiService

An interface annotated with @AiService will be automatically registered as a bean and wired with all the following components (beans) available in the context:

 - ChatModel
 - StreamingChatModel
 - ChatMemory
 - ChatMemoryProvider
 - ContentRetriever
 - RetrievalAugmentor
 - All beans containing methods annotated with @Tool
 

You can also explicitly specify which components (beans) should be wired into this AI Service by setting wiringMode() to AiServiceWiringMode.EXPLICIT and specifying bean names using the following attributes:

 - chatModel()
 - streamingChatModel()
 - chatMemory()
 - chatMemoryProvider()
 - contentRetriever()
 - retrievalAugmentor()
 

See more information about AI Services here and in the Javadoc of AiServices.

See Also:

• AiServices

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
String	chatMemory	When the wiringMode() is set to AiServiceWiringMode.EXPLICIT, this attribute specifies the name of a ChatMemory bean that should be used by this AI Service.
String	chatMemoryProvider	When the wiringMode() is set to AiServiceWiringMode.EXPLICIT, this attribute specifies the name of a ChatMemoryProvider bean that should be used by this AI Service.
String	chatModel	When the wiringMode() is set to AiServiceWiringMode.EXPLICIT, this attribute specifies the name of a ChatModel bean that should be used by this AI Service.
String	contentRetriever	When the wiringMode() is set to AiServiceWiringMode.EXPLICIT, this attribute specifies the name of a ContentRetriever bean that should be used by this AI Service.
String	moderationModel	When the wiringMode() is set to AiServiceWiringMode.EXPLICIT, this attribute specifies the name of a ModerationModel bean that should be used by this AI Service.
String	retrievalAugmentor	When the wiringMode() is set to AiServiceWiringMode.EXPLICIT, this attribute specifies the name of a RetrievalAugmentor bean that should be used by this AI Service.
String	streamingChatModel	When the wiringMode() is set to AiServiceWiringMode.EXPLICIT, this attribute specifies the name of a StreamingChatModel bean that should be used by this AI Service.
String[]	tools	When the wiringMode() is set to AiServiceWiringMode.EXPLICIT, this attribute specifies the names of beans containing methods annotated with Tool that should be used by this AI Service.
AiServiceWiringMode	wiringMode	Specifies how LangChain4j components (beans) are wired (injected) into this AI Service.

Element Details

wiringMode

AiServiceWiringMode wiringMode

Specifies how LangChain4j components (beans) are wired (injected) into this AI Service.

Default:

AUTOMATIC

chatModel

String chatModel

When the wiringMode() is set to AiServiceWiringMode.EXPLICIT, this attribute specifies the name of a ChatModel bean that should be used by this AI Service.

Default:

""

streamingChatModel

String streamingChatModel

When the wiringMode() is set to AiServiceWiringMode.EXPLICIT, this attribute specifies the name of a StreamingChatModel bean that should be used by this AI Service.

Default:

""

chatMemory

String chatMemory

When the wiringMode() is set to AiServiceWiringMode.EXPLICIT, this attribute specifies the name of a ChatMemory bean that should be used by this AI Service.

Default:

""

chatMemoryProvider

String chatMemoryProvider

When the wiringMode() is set to AiServiceWiringMode.EXPLICIT, this attribute specifies the name of a ChatMemoryProvider bean that should be used by this AI Service.

Default:

""

contentRetriever

String contentRetriever

When the wiringMode() is set to AiServiceWiringMode.EXPLICIT, this attribute specifies the name of a ContentRetriever bean that should be used by this AI Service.

Default:

""

retrievalAugmentor

String retrievalAugmentor

When the wiringMode() is set to AiServiceWiringMode.EXPLICIT, this attribute specifies the name of a RetrievalAugmentor bean that should be used by this AI Service.

Default:

""

moderationModel

String moderationModel

When the wiringMode() is set to AiServiceWiringMode.EXPLICIT, this attribute specifies the name of a ModerationModel bean that should be used by this AI Service.

Default:

""

tools

String[] tools

When the wiringMode() is set to AiServiceWiringMode.EXPLICIT, this attribute specifies the names of beans containing methods annotated with Tool that should be used by this AI Service.

Default:

{}