Update wiki Home page for langchain4j-embeddingstore
parent
49fdd1a689
commit
8114cdfe0e
42
Home.md
42
Home.md
@ -1,21 +1,35 @@
|
||||
# Deploy the Project on CamelX Platform
|
||||
# LangChain4j Embedding Store
|
||||
|
||||
Deploy on CamelX Platform in three steps
|
||||
Perform operations on the Langchain4jEmbeddingStores.
|
||||
|
||||
## Step 1: Create a release
|
||||
From the project space, click on **"Create a release"**
|
||||
## Metadata
|
||||
|
||||
The new version is automatically available in the list
|
||||
| Property | Value |
|
||||
|----------|-------|
|
||||
| Scheme | `langchain4j-embeddingstore` |
|
||||
| Support Level | Stable |
|
||||
| Labels | database,ai |
|
||||
| Version | 4.20.0 (CEQ 3.36.0) |
|
||||
|
||||
## Step 2: Deploy
|
||||
Click on **"Deploy"**
|
||||
## Maven Dependency
|
||||
|
||||
- **Version:** Select the desired release
|
||||
- **Environment:** Choose `Development`, `Staging`, or `Production`
|
||||
- **Configuration:** Select the configuration source
|
||||
- **Resources:** Set CPU and Memory
|
||||
```xml
|
||||
<dependency>
|
||||
<groupId>org.apache.camel.quarkus</groupId>
|
||||
<artifactId>camel-quarkus-langchain4j-embeddingstore</artifactId>
|
||||
<version>4.20.0 (CEQ 3.36.0)</version>
|
||||
</dependency>
|
||||
```
|
||||
|
||||
## Step 3: Expose
|
||||
Enable **"Expose"**
|
||||
## Endpoint Properties
|
||||
|
||||
Choose an **API Gateway** (Internal, Public, etc.)
|
||||
| Name | Type | Required | Default | Description |
|
||||
|------|------|----------|---------|-------------|
|
||||
| `embeddingStoreId` | string | ✓ | | The id of the embedding store |
|
||||
| `action` | enum | | | The operation to perform: ADD, REMOVE, or SEARCH |
|
||||
| `embeddingStore` | object | | | Direct embedding store instance for vector operations |
|
||||
| `embeddingStoreFactory` | object | | | The embedding store factory to use for creating embedding stores if no embeddingstore is provided |
|
||||
| `maxResults` | integer | | `5` | Maximum number of results to return for SEARCH operation |
|
||||
| `minScore` | number | | | Minimum similarity score threshold for SEARCH operation (0.0 to 1.0) |
|
||||
| `returnTextContent` | boolean | | `false` | When true, SEARCH returns List with text content instead of List |
|
||||
| `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. |
|
||||
|
||||
Loading…
Reference in New Issue
Block a user