OpenAI Classification Action
Provided by: "Apache Software Foundation"
Support Level for this Kamelet is: "Stable"
Classifies a sentence using the OpenAI API.
It requires an OpenAI account (beta accounts available at https://beta.openai.com/).
Training data for classification can be provided in advance by uploading a file with purpose="classifications", see: https://beta.openai.com/docs/api-reference/files/upload.
The Kamelet accepts data in:
-
text/plain
format (default) -
application/json
format: see reference at https://beta.openai.com/docs/api-reference/classifications/create
Configuration Options
The following table summarizes the configuration options available for the openai-classification-action
Kamelet:
Property | Name | Description | Type | Default | Example |
---|---|---|---|---|---|
Authorization Token | Required The authorization token to use to contact the openAI API. | string | |||
Engine | The OpenAI engine to use. | string | davinci | ||
Examples File | The ID of an uploaded file containing examples for classification. | string | file-9HbeJXxtG7pg1YTXRx1v1fmn | ||
Format | The response format ('text/plain' or 'application/json' are supported). | string | text/plain |
Dependencies
At runtime, the openai-classification-action
Kamelet relies upon the presence of the following dependencies:
-
mvn:org.apache.camel.kamelets:camel-kamelets-utils:4.7.0-SNAPSHOT
-
camel:jackson
-
camel:jsonpath
-
camel:core
-
camel:kamelet
-
camel:http
Camel JBang usage
Prerequisites
-
You’ve installed JBang.
-
You have executed the following command:
jbang app install camel@apache/camel
Supposing you have a file named route.yaml with this content:
- route:
from:
uri: "kamelet:timer-source"
parameters:
period: 10000
message: 'test'
steps:
- to:
uri: "kamelet:openai-classification-action"
parameters:
.
.
.
- to:
uri: "kamelet:log-sink"
You can now run it directly through the following command
camel run route.yaml