Skip to content

Commit 08368dd

Browse files
committed
add php requirement note
1 parent 8c1601d commit 08368dd

File tree

1 file changed

+13
-11
lines changed

1 file changed

+13
-11
lines changed

README.md

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -11,14 +11,16 @@ intelligence products that powers applications like ChatGPT, GPT-3, GitHub
1111
CoPilot, and more. Our goal is to find ways of augmenting and adding assistive
1212
AI tech leveraging OpenAI API services in Backdrop CMS.
1313

14+
The OpenAI module uses the [OpenAI PHP client](https://github.com/openai-php/client) which Requires [PHP 8.1+](https://php.net/releases/).
15+
1416
## Requirements
1517

1618
You are required to provide an OpenAI key before you can use
1719
any of the provided services.
1820

1921
## Documentation
2022

21-
Please review and contribute to documentation for this module in our [wiki](https://github.com/backdrop-contrib/openai/wiki).
23+
Please review and contribute to documentation for this module in our [wiki](https://github.com/backdrop-contrib/openai/wiki).
2224

2325
## Installation
2426

@@ -28,34 +30,34 @@ Please review and contribute to documentation for this module in our [wiki](http
2830

2931
## Included Submodules
3032

31-
### **openai_audio**
33+
### **openai_audio**
3234
Adds capability to interact with the OpenAI audio (speech-to-text) endpoints.
3335

34-
### **openai_chatgpt**
36+
### **openai_chatgpt**
3537
Enables interaction with the Chat endpoint via the ChatGPT API.
3638

37-
### **openai_ckeditor**
39+
### **openai_ckeditor**
3840
Provides a button for CKEditor 5 to send a prompt to OpenAI and receive generated text back.
3941

40-
### **openai_content**
42+
### **openai_content**
4143
Adds assistive tools for different areas of the content editing process. This includes functionality to adjust the tone of the content, summarize body text, suggest taxonomy terms for nodes, and check content for [moderation violations](https://platform.openai.com/docs/guides/moderation/overview).
4244

43-
### **openai_dalle**
45+
### **openai_dalle**
4446
Adds capability to interact with the OpenAI DALL·E (image generation) endpoint, supporting both the new DALL·E 3 model and DALL·E 2 model.
4547

46-
### **openai_devel**
48+
### **openai_devel**
4749
Adds GPT content generation capability to Devel Generate. This provides Devel a way of generating realistic content (not lorem ipsum) using GPT and ChatGPT models. Users can generate sample content from the Drupal UI or via Drush. This is useful for filling out your site with realistic content for client demonstrations, layout, theming, or QA.
4850

49-
### **openai_dblog**
51+
### **openai_dblog**
5052
Demonstrates log analysis using OpenAI to find potential solutions or explanations for error logs. Responses from OpenAI are saved and persist for common error messages, allowing you to review them.
5153

52-
### **openai_prompt**
54+
### **openai_prompt**
5355
Adds an area in the admin interface to explore OpenAI text generation capabilities and ask it (prompt) for whatever you'd like.
5456

55-
### **openai_embeddings**
57+
### **openai_embeddings**
5658
Analyzes nodes and generates vectors and text embeddings of your nodes, taxonomy, media, and paragraph entities from OpenAI. Responses from OpenAI are saved and could augment search, ranking, automatically suggest taxonomy terms for content, and [improve search relevancy without expensive search backends. Content personalization and recommendation](https://www.pinecone.io/) may also be possible with this approach.
5759

58-
### **openai_tts**
60+
### **openai_tts**
5961
Adds capability to interact with the OpenAI TTS (text-to-speech) endpoints.
6062

6163
## Issues

0 commit comments

Comments
 (0)