openai classification action 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:

Configuration Options

The following table summarizes the configuration options available for the openai-classification-action Kamelet:

Property Name Description Type Default Example

authorizationToken

Authorization Token

Required The authorization token to use to contact the openAI API.

string

engine

Engine

The OpenAI engine to use.

string

davinci

file

Examples File

The ID of an uploaded file containing examples for classification.

string

file-9HbeJXxtG7pg1YTXRx1v1fmn

format

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.4.4-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:log-sink"

You can now run it directly through the following command

camel run route.yaml

Camel K Environment Usage

This section describes how you can use the openai-classification-action.

Knative action

You can use the openai-classification-action Kamelet as an intermediate step in a Knative binding.

openai-classification-action-pipe.yaml
apiVersion: camel.apache.org/v1
kind: Pipe
metadata:
  name: openai-classification-action-pipe
spec:
  source:
    ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1
      name: kafka-source
      properties:
        bootstrapServers: localhost:9092
        topic: mytopic
        user: kafka
        password: kafka123!
  steps:
    - ref:
        kind: Kamelet
        apiVersion: camel.apache.org/v1
        name: openai-classification-action
      properties:
        authorizationToken: The Authorization Token
  sink:
    ref:
      kind: Channel
      apiVersion: messaging.knative.dev/v1
      name: mychannel

Prerequisite

You have Camel K installed on the cluster.

Procedure for using the cluster CLI

  1. Save the openai-classification-action-pipe.yaml file to your local drive, and then edit it as needed for your configuration.

  2. Run the action by using the following command:

    kubectl apply -f openai-classification-action-pipe.yaml

Procedure for using the Kamel CLI

Configure and run the action by using the following command:

kamel bind channel:mychannel -p "step-0.authorizationToken=The Authorization Token" openai-classification-action

This command creates the Kamelet Pipe in the current namespace on the cluster.

Kafka action

You can use the openai-classification-action Kamelet as an intermediate step in a Kafka binding.

openai-classification-action-pipe.yaml
apiVersion: camel.apache.org/v1
kind: Pipe
metadata:
  name: openai-classification-action-pipe
spec:
  source:
    ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1
      name: kafka-source
      properties:
        bootstrapServers: localhost:9092
        topic: mytopic
        user: kafka
        password: kafka123!
  steps:
    - ref:
        kind: Kamelet
        apiVersion: camel.apache.org/v1
        name: openai-classification-action
      properties:
        authorizationToken: The Authorization Token
  sink:
    ref:
      kind: KafkaTopic
      apiVersion: kafka.strimzi.io/v1beta1
      name: my-topic

Prerequisites

  • You’ve installed Strimzi.

  • You’ve created a topic named my-topic in the current namespace.

  • You have Camel K installed on the cluster.

Procedure for using the cluster CLI

  1. Save the openai-classification-action-pipe.yaml file to your local drive, and then edit it as needed for your configuration.

  2. Run the action by using the following command:

    kubectl apply -f openai-classification-action-pipe.yaml

Procedure for using the Kamel CLI

Configure and run the action by using the following command:

kamel bind kafka.strimzi.io/v1beta1:KafkaTopic:my-topic -p "step-0.authorizationToken=The Authorization Token" openai-classification-action

This command creates the Kamelet Pipe in the current namespace on the cluster.

Kamelet source file

https://github.com/apache/camel-kamelets/blob/main/kamelets/openai-classification-action.kamelet.yaml

Back to top