generated from camel.apache.org/component
Update wiki Home page for langchain4j-tools
parent
84b9cfdd6e
commit
d84cb13b59
44
Home.md
44
Home.md
@ -1,21 +1,37 @@
|
|||||||
# Deploy the Project on CamelX Platform
|
# LangChain4j Tools
|
||||||
|
|
||||||
Deploy on CamelX Platform in three steps
|
LangChain4j Tools and Function Calling Features
|
||||||
|
|
||||||
## Step 1: Create a release
|
## Metadata
|
||||||
From the project space, click on **"Create a release"**
|
|
||||||
|
|
||||||
The new version is automatically available in the list
|
| Property | Value |
|
||||||
|
|----------|-------|
|
||||||
|
| Scheme | `langchain4j-tools` |
|
||||||
|
| Support Level | Experimental |
|
||||||
|
| Labels | ai |
|
||||||
|
| Version | 4.10.2 |
|
||||||
|
|
||||||
## Step 2: Deploy
|
## Maven Dependency
|
||||||
Click on **"Deploy"**
|
|
||||||
|
|
||||||
- **Version:** Select the desired release
|
```xml
|
||||||
- **Environment:** Choose `Development`, `Staging`, or `Production`
|
<dependency>
|
||||||
- **Configuration:** Select the configuration source
|
<groupId>org.apache.camel</groupId>
|
||||||
- **Resources:** Set CPU and Memory
|
<artifactId>camel-langchain4j-tools</artifactId>
|
||||||
|
<version>4.10.2</version>
|
||||||
|
</dependency>
|
||||||
|
```
|
||||||
|
|
||||||
## Step 3: Expose
|
## Endpoint Properties
|
||||||
Enable **"Expose"**
|
|
||||||
|
|
||||||
Choose an **API Gateway** (Internal, Public, etc.)
|
| Name | Type | Required | Default | Description |
|
||||||
|
|------|------|----------|---------|-------------|
|
||||||
|
| `toolId` | string | ✓ | | The tool name |
|
||||||
|
| `tags` | string | ✓ | | The tags for the tools |
|
||||||
|
| `description` | string | | | Tool description |
|
||||||
|
| `parameters` | object | | | List of Tool parameters in the form of parameter.= |
|
||||||
|
| `bridgeErrorHandler` | boolean | | `false` | Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. |
|
||||||
|
| `camelToolParameter` | object | | | Tool's Camel Parameters, programmatically define Tool description and parameters |
|
||||||
|
| `exceptionHandler` | object | | | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored. |
|
||||||
|
| `exchangePattern` | object | | | Sets the exchange pattern when the consumer creates an exchange. |
|
||||||
|
| `lazyStartProducer` | boolean | | `false` | 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. |
|
||||||
|
| `chatModel` | object | | | Chat Language Model of type dev.langchain4j.model.chat.ChatLanguageModel |
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user