From 4df69db734a0b8f7cd0cc77c9a11e2d6fd83627e Mon Sep 17 00:00:00 2001 From: nicolaferraro Date: Fri, 23 Apr 2021 12:50:45 +0200 Subject: [PATCH] openai action doc --- .../kamelets/openai-completion-action.svg | 2 + docs/modules/ROOT/nav.adoc | 1 + .../ROOT/pages/openai-completion-action.adoc | 76 +++++++++++++++++++ 3 files changed, 79 insertions(+) create mode 100644 docs/modules/ROOT/assets/images/kamelets/openai-completion-action.svg create mode 100644 docs/modules/ROOT/pages/openai-completion-action.adoc diff --git a/docs/modules/ROOT/assets/images/kamelets/openai-completion-action.svg b/docs/modules/ROOT/assets/images/kamelets/openai-completion-action.svg new file mode 100644 index 000000000..f742d9e3d --- /dev/null +++ b/docs/modules/ROOT/assets/images/kamelets/openai-completion-action.svg @@ -0,0 +1,2 @@ + + \ No newline at end of file diff --git a/docs/modules/ROOT/nav.adoc b/docs/modules/ROOT/nav.adoc index c85a314b7..6155fc2ea 100644 --- a/docs/modules/ROOT/nav.adoc +++ b/docs/modules/ROOT/nav.adoc @@ -40,6 +40,7 @@ * xref:ROOT:minio-source.adoc[image:kamelets/minio-source.svg[] Minio Source] * xref:ROOT:mqtt-source.adoc[image:kamelets/mqtt-source.svg[] MQTT Source] * xref:ROOT:nats-source.adoc[image:kamelets/nats-source.svg[] NATS Source] +* xref:ROOT:openai-completion-action.adoc[image:kamelets/openai-completion-action.svg[] OpenAI Completion Action] * xref:ROOT:pdf-action.adoc[image:kamelets/pdf-action.svg[] PDF Action] * xref:ROOT:rabbitmq-source.adoc[image:kamelets/rabbitmq-source.svg[] RabbitMQ Source] * xref:ROOT:salesforce-source.adoc[image:kamelets/salesforce-source.svg[] Salesforce Source] diff --git a/docs/modules/ROOT/pages/openai-completion-action.adoc b/docs/modules/ROOT/pages/openai-completion-action.adoc new file mode 100644 index 000000000..d0f8cf307 --- /dev/null +++ b/docs/modules/ROOT/pages/openai-completion-action.adoc @@ -0,0 +1,76 @@ +// THIS FILE IS AUTOMATICALLY GENERATED: DO NOT EDIT += image:kamelets/openai-completion-action.svg[] OpenAI Completion Action + +*Provided by: "Apache Software Foundation"* + +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: +- `text/plain` format (default) +- `application/json` format: see reference at https://beta.openai.com/docs/api-reference/completions/create + + +== Configuration Options + +The following table summarizes the configuration options available for the `openai-completion-action` Kamelet: +[width="100%",cols="2,^2,3,^2,^2,^3",options="header"] +|=== +| Property| Name| Description| Type| Default| Example +| *authorizationToken {empty}* *| 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"`| +|=== + +NOTE: Fields marked with ({empty}*) 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 binding. + +.openai-completion-action-binding.yaml +[source,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: InMemoryChannel + apiVersion: messaging.knative.dev/v1 + name: mychannel + +---- + +Make sure you have xref:latest@camel-k::installation/installation.adoc[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: + +[source,shell] +---- +kubectl apply -f openai-completion-action-binding.yaml +---- +// THIS FILE IS AUTOMATICALLY GENERATED: DO NOT EDIT