Annotation Interface RegisterAiService

@Retention(RUNTIME) @Target(TYPE) public @interface RegisterAiService
Used to create LangChain4j's AiServices in a declarative manner that the application can then use simply by using the class as a CDI bean. Under the hood LangChain4j's AiServices.builder(Class) is called while also providing the builder with the proper ChatLanguageModel bean (mandatory), tools bean (optional), ChatMemoryProvider and Retriever beans (which by default are configured if such beans exist).

NOTE: The resulting CDI bean is RequestScoped by default. If you need to change the scope, simply annotate the class with a CDI scope. CAUTION: When using anything other than the request scope, you need to be very careful with the chat memory implementation.

NOTE: When the application also contains the quarkus-micrometer extension, metrics are automatically generated for the method invocations.

See also ToolBox, SeedMemory

  • Element Details

    • streamingChatLanguageModelSupplier

      Class<? extends Supplier<dev.langchain4j.model.chat.StreamingChatLanguageModel>> streamingChatLanguageModelSupplier
      Configures the way to obtain the StreamingChatLanguageModel to use. If not configured, the default CDI bean implementing the model is looked up. Such a bean provided automatically by extensions such as quarkus-langchain4j-openai, quarkus-langchain4j-azure-openai or quarkus-langchain4j-hugging-face
      Default:
      io.quarkiverse.langchain4j.RegisterAiService.BeanStreamingChatLanguageModelSupplier.class

    • chatLanguageModelSupplier

      Class<? extends Supplier<dev.langchain4j.model.chat.ChatLanguageModel>> chatLanguageModelSupplier
      Configures the way to obtain the ChatLanguageModel to use. If not configured, the default CDI bean implementing the model is looked up. Such a bean provided automatically by extensions such as quarkus-langchain4j-openai, quarkus-langchain4j-azure-openai or quarkus-langchain4j-hugging-face
      Default:
      io.quarkiverse.langchain4j.RegisterAiService.BeanChatLanguageModelSupplier.class

    • modelName

      String modelName
      When chatLanguageModelSupplier is set to BeanChatLanguageModelSupplier.class (which is the default) this allows the selection of the ChatLanguageModel CDI bean to use.

      If not set, the default model (i.e. the one configured without setting the model name) is used. An example of the default model configuration is the following: quarkus.langchain4j.openai.chat-model.model-name=gpt-4-turbo-preview

      If set, it uses the model configured by name. For example if this is set to somename an example configuration value for that named model could be: quarkus.langchain4j.somename.openai.chat-model.model-name=gpt-4-turbo-preview

      Default:
      "<default>"

    • tools

      Class<?>[] tools
      Tool classes to use. All tools are expected to be CDI beans.
      Default:
      {}

    • chatMemoryProviderSupplier

      Class<? extends Supplier<dev.langchain4j.memory.chat.ChatMemoryProvider>> chatMemoryProviderSupplier
      Configures the way to obtain the ChatMemoryProvider.

      Be default, Quarkus configures a ChatMemoryProvider bean that uses a InMemoryChatMemoryStore bean as the backing store. The default type for the actual ChatMemory is MessageWindowChatMemory and it is configured with the value of the quarkus.langchain4j.chat-memory.memory-window.max-messages configuration property (which default to 10) as a way of limiting the number of messages in each chat.

      If the application provides its own ChatMemoryProvider bean, that takes precedence over what Quarkus provides as the default.

      If the application provides an implementation of ChatMemoryStore, then that is used instead of the default InMemoryChatMemoryStore.

      In the most advances case, an arbitrary ChatMemoryProvider can be used by having a custom Supplier<ChatMemoryProvider> configured in this property. Supplier<dev.langchain4j.memory.chat.ChatMemoryProvider> needs to be provided.

      Default:
      io.quarkiverse.langchain4j.RegisterAiService.BeanChatMemoryProviderSupplier.class

    • retriever

      @Deprecated(forRemoval=true) Class<? extends dev.langchain4j.retriever.Retriever<dev.langchain4j.data.segment.TextSegment>> retriever
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use retrievalAugmentor instead
      Configures the way to obtain the Retriever to use (when using RAG). By default, no retriever is used.
      Default:
      io.quarkiverse.langchain4j.RegisterAiService.NoRetriever.class

    • retrievalAugmentor

      Class<? extends Supplier<dev.langchain4j.rag.RetrievalAugmentor>> retrievalAugmentor
      Configures the way to obtain the RetrievalAugmentor to use (when using RAG). The Supplier may or may not be a CDI bean (but most typically it will, so consider adding a bean-defining annotation to it). If it is not a CDI bean, Quarkus will create an instance by calling its no-arg constructor.

      If unspecified, Quarkus will attempt to locate a CDI bean that implements RetrievalAugmentor and use it if one exists.

      Default:
      io.quarkiverse.langchain4j.RegisterAiService.BeanIfExistsRetrievalAugmentorSupplier.class

    • auditServiceSupplier

      Class<? extends Supplier<AuditService>> auditServiceSupplier
      Configures the way to obtain the AuditService to use. By default, Quarkus will look for a CDI bean that implements AuditService, but will fall back to not using any memory if no such bean exists. If an arbitrary AuditService instance is needed, a custom implementation of Supplier<AuditService> needs to be provided.
      Default:
      io.quarkiverse.langchain4j.RegisterAiService.BeanIfExistsAuditServiceSupplier.class

    • moderationModelSupplier

      Class<? extends Supplier<dev.langchain4j.model.moderation.ModerationModel>> moderationModelSupplier
      Configures the way to obtain the ModerationModel to use. By default, Quarkus will look for a CDI bean that implements ModerationModel if at least one method is annotated with @Moderate. If an arbitrary ModerationModel instance is needed, a custom implementation of Supplier<dev.langchain4j.model.moderation.ModerationModel> needs to be provided.
      Default:
      io.quarkiverse.langchain4j.RegisterAiService.BeanIfExistsModerationModelSupplier.class

    • toolProviderSupplier

      Class<? extends Supplier<dev.langchain4j.service.tool.ToolProvider>> toolProviderSupplier
      Configures a toolProviderSupplier. Either a toolProviderSupplier or "normal" tools can be used, but not both
      Default:
      io.quarkiverse.langchain4j.RegisterAiService.BeanIfExistsToolProviderSupplier.class