diff --git a/Home.md b/Home.md index 93a012c..461420b 100644 --- a/Home.md +++ b/Home.md @@ -1,21 +1,33 @@ -# Deploy the Project on CamelX Platform +# IBM Watson Natural Language Understanding Sink -Deploy on CamelX Platform in three steps +Analyze text using IBM Watson Natural Language Understanding to extract sentiment, entities, keywords, concepts, categories, and emotions. -## 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 | +|----------|-------| +| Type | sink | +| Group | IBM Watson | +| Namespace | IBM | +| Support Level | Preview | +| Provider | Apache Software Foundation | -## Step 2: Deploy -Click on **"Deploy"** +## Properties -- **Version:** Select the desired release -- **Environment:** Choose `Development`, `Staging`, or `Production` -- **Configuration:** Select the configuration source -- **Resources:** Set CPU and Memory +| Name | Type | Required | Default | Description | +|------|------|----------|---------|-------------| +| `apiKey` | string | ✓ | | The IBM Cloud API key for Watson Natural Language Understanding. | +| `serviceUrl` | string | | | The Watson Natural Language Understanding service endpoint URL. If not specified, the default URL will be used. | +| `operation` | string | | `analyzeText` | The operation to perform. | +| `analyzeSentiment` | boolean | | `true` | Enable sentiment analysis to detect positive, negative, or neutral sentiment. | +| `analyzeEmotion` | boolean | | `false` | Enable emotion analysis to detect emotions like joy, anger, sadness, fear, and disgust. | +| `analyzeEntities` | boolean | | `true` | Enable entity extraction to identify people, companies, organizations, cities, and more. | +| `analyzeKeywords` | boolean | | `true` | Enable keyword extraction to identify important keywords and phrases. | +| `analyzeConcepts` | boolean | | `false` | Enable concept extraction to identify high-level concepts that aren't necessarily mentioned in the text. | +| `analyzeCategories` | boolean | | `false` | Enable category classification to classify content into a hierarchy of categories. | -## Step 3: Expose -Enable **"Expose"** +## Dependencies -Choose an **API Gateway** (Internal, Public, etc.) +- `camel:core` +- `camel:ibm-watson-language` +- `camel:kamelet`