Skip to content

Commit

Permalink
MARP-1838 Removing duplication in README_DE (#90)
Browse files Browse the repository at this point in the history
  • Loading branch information
ndkhanh-axonivy authored Jan 22, 2025
1 parent 6b04302 commit 64eff73
Show file tree
Hide file tree
Showing 2 changed files with 0 additions and 72 deletions.
46 changes: 0 additions & 46 deletions openai-assistant-product/README_DE.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,49 +13,3 @@ Dieser Assistent:
- neue Anweisungen einfügt,
- Fragen zu deinem Code beantwortet
- und neue BPMN-Elemente hinzufügt.


## Demo

The assistant context menu, popping up in all code-editors:
![context](docs/chat-gpt-context.png)

Supports you in reviews, by explaining existing code:
![explain](docs/chat-gpt-explain.png)

Accepts insert or change code change requests in natural language:
![explain](docs/chat-gpt-insert.png)

Allows you to select and apply the changes you were asking for:
![explain](docs/chat-gpt-insert-review.png)

## Setup

1. Install this Dropin extension by pressing the 'install' button in the market.
2. After installing, reboot the Designer, as advised by the dropin-installer.
3. Setup the OpenAI API key

### OpenAI API key

ChatGPT requests do not come for free. However, when you register a new account,
5$ are automatically added to it. This is perfect to develop your ChatGPT integration free of charge.

1. Register an account on [platform.openai.com](https://platform.openai.com/overview).
2. Once logged in, click on your user icon on the upper right corner.
3. In the menu, use the "View API keys" option.
4. Generate a new API key
5. Open a Designer where the openai-assistant was installed.
6. Right click into a code editor: select `ChatGPT assistant` > `Set apiKey` > fill in your secret key.

### Customization

The OpenAI assistant uses the designer app.yaml to load custom settings.
The following keys are valid and interpreted:

```
@variables.yaml@
```

### Note
Make sure to enable the `Show Only Source Page` option under `Window` -> `Preferences` -> `Axon Ivy` -> `Html Dialog Editor` -> `Show Only Source Page` to prevent unexpected behavior.

26 changes: 0 additions & 26 deletions openai-connector-product/README_DE.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,29 +5,3 @@ ChatGPT ist ein KI-Modell, das von [OpenAI](https://openai.com/) entwickelt wurd
Dieser Konnektor:
- Basiert auf der OpenAI API 'https://platform.openai.com/'
- Bietet ein einfaches Chat-Frontend für die nahtlose Integration in Axon Ivy Anwendungen

## Demo

This demo showcases a simple prompt window to chat directly with ChatGPT. Enter in any language a question that is of interest, and you will immediately get ChatGPT’s answer within the Axon Ivy business process.

![demo-dialog](images/demo1.png)
![demo-dialog](images/demo0.png)

This is the demo showcase for generating the email subject and content base on the information which is entered by the user.

![demo-dialog](images/demo2.png)

## Setup

Chat GPT requests do not come for free. However, when you register a new account,
5$ are automatically added to it. This is perfect to develop your Chat GPT integration free of charge.

1. Register an account on [platform.openai.com](https://platform.openai.com/overview).
2. Once logged in, click on your user icon on the upper right corner.
3. In the menu, use the "View API keys" option.
4. Generate a new API key and store it in your variables.yaml under `Variables.openai-connector.apiKey`

```
@variables.yaml@
```

0 comments on commit 64eff73

Please sign in to comment.