Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
rabea-al committed Dec 16, 2024
1 parent 76bf723 commit 74a0be4
Show file tree
Hide file tree
Showing 2 changed files with 74 additions and 86 deletions.
33 changes: 10 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,8 @@ This library connects OpenAI's models with Xircuits, making it easy to use featu

### The Example:

<img src="https://github.com/user-attachments/assets/2075832c-eda9-40a7-b7e1-ffb67079f639" alt="openai_sample" />
![openai_sample](https://github.com/user-attachments/assets/1b557501-47e7-40fe-8152-65ea5e74694d)


### The Result

Expand All @@ -56,19 +57,6 @@ Sets the API key and organization for OpenAI, enabling access to its models.

<img src="https://github.com/user-attachments/assets/fed4ddb7-f751-4497-9c9c-d229c0aea1a4" alt="OpenAIAuthorize" width="200" height="150" />

### OpenAIGetModels Component:

Fetches a list of available OpenAI models for use in workflows.

<img src="https://github.com/user-attachments/assets/8bac1705-f55d-4e3f-a508-8eb1cacbddee" alt="OpenAIGetModel" width="200" height="75" />


### OpenAIGetModel Component:

Retrieves detailed information about a specific OpenAI model.

<img src="https://github.com/user-attachments/assets/bf59f5b0-70b8-4af3-ad4d-a30ebce48c3c" alt="OpenAIGetModels" width="200" height="75" />

### OpenAIGenerate Component:

Creates text completions using an OpenAI model, with adjustable parameters.
Expand All @@ -81,31 +69,30 @@ Conducts conversations with OpenAI models, maintaining conversation history.

<img src="https://github.com/user-attachments/assets/692e8620-8b52-42ab-8bb7-c3467c94b710" alt="OpenAIChat" width="200" height="200" />

### OpenAIGetModels Component:

Fetches a list of available OpenAI models for use in workflows.

### OpenAIGetModel Component:

Retrieves detailed information about a specific OpenAI model.

### OpenAIEdit Component:

Edits input text based on specific instructions provided.

<img src="https://github.com/user-attachments/assets/43c3b869-312e-463b-84c6-b8265800878c" alt="OpenAIEdit" width="200" height="150" />

### OpenAIImageCreate Component:

Generates images from text prompts using OpenAI's image models.

<img src="https://github.com/user-attachments/assets/0713e749-bad1-4abc-91dd-c4077a755afc" alt="OpenAIImageCreate" width="200" height="125" />

### OpenAIImageCreateVariation Component:

Creates alternate versions of an input image using OpenAI's variation tools.

<img src="https://github.com/user-attachments/assets/eaf74947-3089-479d-8fec-aaa7f94b25d6" alt="OpenAIImageCreateVariation" width="200" height="125" />


### OpenAIImageEdit Component:

Modifies an input image based on a text prompt or a mask.

<img src="https://github.com/user-attachments/assets/05b490a8-2740-419f-acb4-9b1575573c18" alt="OpenAIImageEdit" width="200" height="150" />

## Try the Examples

We have provided an example workflow to help you get started with the OpenAI component library. Give it a try and see how you can create custom OpenAI components for your applications.
Expand Down
Loading

0 comments on commit 74a0be4

Please sign in to comment.