You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by nf...@apache.org on 2021/04/23 12:59:23 UTC
[camel-kamelets] 02/03: openai action doc
This is an automated email from the ASF dual-hosted git repository.
nferraro pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel-kamelets.git
commit 9bb4a13ff49b6096f558741082dab7e468017f2f
Author: nicolaferraro <ni...@gmail.com>
AuthorDate: Fri Apr 23 12:50:45 2021 +0200
openai action doc
---
.../images/kamelets/openai-completion-action.svg | 2 +
docs/modules/ROOT/nav.adoc | 1 +
.../ROOT/pages/openai-completion-action.adoc | 76 ++++++++++++++++++++++
3 files changed, 79 insertions(+)
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 0000000..f742d9e
--- /dev/null
+++ b/docs/modules/ROOT/assets/images/kamelets/openai-completion-action.svg
@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<svg width="894" height="170" xmlns="http://www.w3.org/2000/svg"><path d="M625.55 35.22c-13.75 0-23.57 4.7-28.39 13.59l-2.59 4.79V37.54h-22.4v97.85h23.56V77.18c0-13.91 7.55-21.89 20.73-21.89 12.56 0 19.76 7.76 19.76 21.31v58.79h23.56v-63c0-23.26-12.8-37.17-34.23-37.17zm-114.22 0c-27.79 0-45.06 17.33-45.06 45.25v13.74c0 26.83 17.42 43.51 45.45 43.51 18.74 0 31.88-6.88 40.15-21l-14.61-8.39c-6.11 8.15-15.86 13.19-25.54 13.19-14.19 0-22.67-8.76-22.67-23.44v-3.89h65.79V77.95c0-26-17.08-42.73- [...]
\ No newline at end of file
diff --git a/docs/modules/ROOT/nav.adoc b/docs/modules/ROOT/nav.adoc
index c85a314..6155fc2 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 0000000..d0f8cf3
--- /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