-
Notifications
You must be signed in to change notification settings - Fork 71
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
5b89c23
commit 4df69db
Showing
3 changed files
with
79 additions
and
0 deletions.
There are no files selected for viewing
2 changes: 2 additions & 0 deletions
2
docs/modules/ROOT/assets/images/kamelets/openai-completion-action.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 |