Interface SpringAiToolsEndpointBuilderFactory.SpringAiToolsEndpointConsumerBuilder
- All Superinterfaces:
org.apache.camel.builder.EndpointConsumerBuilder,org.apache.camel.EndpointConsumerResolver
- All Known Subinterfaces:
SpringAiToolsEndpointBuilderFactory.SpringAiToolsEndpointBuilder
- Enclosing interface:
SpringAiToolsEndpointBuilderFactory
public static interface SpringAiToolsEndpointBuilderFactory.SpringAiToolsEndpointConsumerBuilder
extends org.apache.camel.builder.EndpointConsumerBuilder
Builder for endpoint consumers for the Spring AI Tools component.
-
Method Summary
Modifier and TypeMethodDescriptionadvanced()description(String description) Tool description.Input type class for the tool.Input type class for the tool.Tool name.parameters(String key, Object value) List of Tool parameters with optional metadata.parameters(Map values) List of Tool parameters with optional metadata.returnDirect(boolean returnDirect) Whether the tool result should be returned directly or passed back to the model.returnDirect(String returnDirect) Whether the tool result should be returned directly or passed back to the model.The tags for the tools.Methods inherited from interface org.apache.camel.builder.EndpointConsumerBuilder
doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getRawUriMethods inherited from interface org.apache.camel.EndpointConsumerResolver
resolve, resolve
-
Method Details
-
advanced
-
tags
The tags for the tools. The option is a:java.lang.Stringtype. Required: true Group: common- Parameters:
tags- the value to set- Returns:
- the dsl builder
-
description
default SpringAiToolsEndpointBuilderFactory.SpringAiToolsEndpointConsumerBuilder description(String description) Tool description. The option is a:java.lang.Stringtype. Group: consumer- Parameters:
description- the value to set- Returns:
- the dsl builder
-
inputType
default SpringAiToolsEndpointBuilderFactory.SpringAiToolsEndpointConsumerBuilder inputType(Class<Object> inputType) Input type class for the tool. The option is a:java.lang.Class<java.lang.Object>type. Group: consumer- Parameters:
inputType- the value to set- Returns:
- the dsl builder
-
inputType
default SpringAiToolsEndpointBuilderFactory.SpringAiToolsEndpointConsumerBuilder inputType(String inputType) Input type class for the tool. The option will be converted to ajava.lang.Class<java.lang.Object>type. Group: consumer- Parameters:
inputType- the value to set- Returns:
- the dsl builder
-
name
Tool name. The option is a:java.lang.Stringtype. Group: consumer- Parameters:
name- the value to set- Returns:
- the dsl builder
-
parameters
default SpringAiToolsEndpointBuilderFactory.SpringAiToolsEndpointConsumerBuilder parameters(String key, Object value) List of Tool parameters with optional metadata. Format: parameter.=, parameter..description=, parameter..required=, parameter..enum=. Example: parameter.location=string, parameter.location.description=The city and state, parameter.location.required=true, parameter.unit.enum=C,F. This is a multi-value option with prefix: parameter. The option is a:java.util.Map<java.lang.String, java.lang.String>type. The option is multivalued, and you can use the parameters(String, Object) method to add a value (call the method multiple times to set more values). Group: consumer- Parameters:
key- the option keyvalue- the option value- Returns:
- the dsl builder
-
parameters
default SpringAiToolsEndpointBuilderFactory.SpringAiToolsEndpointConsumerBuilder parameters(Map values) List of Tool parameters with optional metadata. Format: parameter.=, parameter..description=, parameter..required=, parameter..enum=. Example: parameter.location=string, parameter.location.description=The city and state, parameter.location.required=true, parameter.unit.enum=C,F. This is a multi-value option with prefix: parameter. The option is a:java.util.Map<java.lang.String, java.lang.String>type. The option is multivalued, and you can use the parameters(String, Object) method to add a value (call the method multiple times to set more values). Group: consumer- Parameters:
values- the values- Returns:
- the dsl builder
-
returnDirect
default SpringAiToolsEndpointBuilderFactory.SpringAiToolsEndpointConsumerBuilder returnDirect(boolean returnDirect) Whether the tool result should be returned directly or passed back to the model. Default is false, meaning the result is passed back to the model for further processing. The option is a:booleantype. Default: false Group: consumer- Parameters:
returnDirect- the value to set- Returns:
- the dsl builder
-
returnDirect
default SpringAiToolsEndpointBuilderFactory.SpringAiToolsEndpointConsumerBuilder returnDirect(String returnDirect) Whether the tool result should be returned directly or passed back to the model. Default is false, meaning the result is passed back to the model for further processing. The option will be converted to abooleantype. Default: false Group: consumer- Parameters:
returnDirect- the value to set- Returns:
- the dsl builder
-