openai completion action OpenAI Completion Action

Provided by: "Apache Software Foundation"

Support Level for this Kamelet is: "Preview"

Completes a sentence using the OpenAI API.

It requires an OpenAI account (beta accounts available at https://beta.openai.com/).

The Kamelet accepts data in:

Configuration Options

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

Property Name Description Type Default Example

authorizationToken *

Authorization Token

The authorization token to use to contact the openAI API

string

engine

Engine

The OpenAI engine to use

string

"davinci"

format

Format

The response format ('text/plain' or 'application/json' are supported)

string

"text/plain"
Fields marked with (*) are mandatory.

Usage

This section summarizes how the openai-completion-action can be used in various contexts.

Knative Action

The openai-completion-action Kamelet can be used as intermediate step in a Knative binding.

openai-completion-action-binding.yaml
apiVersion: camel.apache.org/v1alpha1
kind: KameletBinding
metadata:
  name: openai-completion-action-binding
spec:
  source:
    ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1alpha1
      name: timer-source
    properties:
      message: "Hello"
  steps:
  - ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1alpha1
      name: openai-completion-action
    properties:
      authorizationToken: "The Authorization Token"
  sink:
    ref:
      kind: Channel
      apiVersion: messaging.knative.dev/v1
      name: mychannel

Make sure you have Camel K installed into the Kubernetes cluster you’re connected to.

Save the openai-completion-action-binding.yaml file into your hard drive, then configure it according to your needs.

You can run the action using the following command:

kubectl apply -f openai-completion-action-binding.yaml

Dependencies

The Kamelet needs the following dependencies:

  • camel:jackson

  • camel:jsonpath

  • camel:core

  • camel:kamelet

  • camel:http

Binding to Knative using the Kamel CLI:

The procedure described above can be simplified into a single execution of the kamel bind command:

kamel bind timer-source?message=Hello --step openai-completion-action -p "step-0.authorizationToken=The Authorization Token" channel:mychannel

This will create the KameletBinding under the hood and apply it to the current namespace in the cluster.

Kafka Action

The openai-completion-action Kamelet can be used as intermediate step in a Kafka binding.

openai-completion-action-binding.yaml
apiVersion: camel.apache.org/v1alpha1
kind: KameletBinding
metadata:
  name: openai-completion-action-binding
spec:
  source:
    ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1alpha1
      name: timer-source
    properties:
      message: "Hello"
  steps:
  - ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1alpha1
      name: openai-completion-action
    properties:
      authorizationToken: "The Authorization Token"
  sink:
    ref:
      kind: KafkaTopic
      apiVersion: kafka.strimzi.io/v1beta1
      name: my-topic

Ensure that you’ve installed Strimzi and created a topic named my-topic in the current namespace. Make also sure you have Camel K installed into the Kubernetes cluster you’re connected to.

Save the openai-completion-action-binding.yaml file into your hard drive, then configure it according to your needs.

You can run the action using the following command:

kubectl apply -f openai-completion-action-binding.yaml

Binding to Kafka using the Kamel CLI:

The procedure described above can be simplified into a single execution of the kamel bind command:

kamel bind timer-source?message=Hello --step openai-completion-action -p "step-0.authorizationToken=The Authorization Token" kafka.strimzi.io/v1beta1:KafkaTopic:my-topic

This will create the KameletBinding under the hood and apply it to the current namespace in the cluster.

Kamelet source file

Have a look at the following link:

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

Back to top