Package org.apache.camel.builder.component.dsl

Interface OpenaiComponentBuilderFactory.OpenaiComponentBuilder

All Superinterfaces:
ComponentBuilder<org.apache.camel.component.openai.OpenAIComponent>
All Known Implementing Classes:
OpenaiComponentBuilderFactory.OpenaiComponentBuilderImpl
Enclosing interface:
OpenaiComponentBuilderFactory
public static interface OpenaiComponentBuilderFactory.OpenaiComponentBuilder extends ComponentBuilder<org.apache.camel.component.openai.OpenAIComponent>
Builder for the OpenAI component.

  • Method Details

    • apiKey

      default OpenaiComponentBuilderFactory.OpenaiComponentBuilder apiKey(String apiKey)
      Default API key for all endpoints. The option is a: <code>java.lang.String</code> type. Group: producer
      Parameters:
      apiKey - the value to set
      Returns:
      the dsl builder

    • baseUrl

      default OpenaiComponentBuilderFactory.OpenaiComponentBuilder baseUrl(String baseUrl)
      Default base URL for all endpoints. The option is a: <code>java.lang.String</code> type. Default: https://api.openai.com/v1 Group: producer
      Parameters:
      baseUrl - the value to set
      Returns:
      the dsl builder

    • embeddingModel

      default OpenaiComponentBuilderFactory.OpenaiComponentBuilder embeddingModel(String embeddingModel)
      Default model for embeddings endpoints. The option is a: <code>java.lang.String</code> type. Group: producer
      Parameters:
      embeddingModel - the value to set
      Returns:
      the dsl builder

    • lazyStartProducer

      default OpenaiComponentBuilderFactory.OpenaiComponentBuilder lazyStartProducer(boolean lazyStartProducer)
      Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. The option is a: <code>boolean</code> type. Default: false Group: producer
      Parameters:
      lazyStartProducer - the value to set
      Returns:
      the dsl builder

    • model

      default OpenaiComponentBuilderFactory.OpenaiComponentBuilder model(String model)
      Default model for chat completion endpoints. The option is a: <code>java.lang.String</code> type. Group: producer
      Parameters:
      model - the value to set
      Returns:
      the dsl builder

    • autowiredEnabled

      default OpenaiComponentBuilderFactory.OpenaiComponentBuilder autowiredEnabled(boolean autowiredEnabled)
      Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc. The option is a: <code>boolean</code> type. Default: true Group: advanced
      Parameters:
      autowiredEnabled - the value to set
      Returns:
      the dsl builder