Skip to content

Commit

Permalink
Merge branch 'main' of github.com:nasa-petal/bidara-deep-chat into main
Browse files Browse the repository at this point in the history
  • Loading branch information
bruffridge committed Jan 25, 2024
2 parents f0ec67c + a65120b commit 49bfdfd
Showing 1 changed file with 16 additions and 5 deletions.
21 changes: 16 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,22 @@

### BIDARA is a GPT-4 chatbot that was instructed to help scientists and engineers understand, learn from, and emulate the strategies used by living things to create sustainable designs and technologies.

:rocket: **[Try it out](https://nasa-petal.github.io/bidara-deep-chat/)**

BIDARA can guide users through the Biomimicry Institute’s [Design Process](https://toolbox.biomimicry.org/methods/process/), a step-by-step method to propose biomimetic solutions to challenges. This process includes defining the problem, biologizing the challenge, discovering natural models, abstracting design strategies, and emulating nature's lessons.

`bidara-deep-chat` uses [a web interface](https://github.com/OvidijusParsiunas/deep-chat) to connect to BIDARA over the OpenAI Assistants API. To use it, you need to register for [an OpenAI API key](https://platform.openai.com/account/api-keys) first. All messages are sent directly from your web browser to OpenAI and back.
## :rocket: How to access

1. [Create an OpenAI account](https://platform.openai.com/signup)
2. [Login to OpenAI Platform](https://platform.openai.com/login)
3. In the left sidebar, navigate to [Settings -> Billing](https://platform.openai.com/account/billing/overview)
4. Click the 'Add payment details' button
5. Add a minimum of $5 in credits. It is required to spend a minimum of $5 to [access GPT-4](https://platform.openai.com/docs/guides/rate-limits/usage-tiers?context=tier-free).
6. In the left sidebar, navigate to [API Keys](https://platform.openai.com/api-keys)
7. Verify your phone number, then click the 'Create new secret key' button.
8. Copy your secret key.
9. **[Open the BIDARA website](https://nasa-petal.github.io/bidara-deep-chat/)**, and paste your key into the input field. Your browser will save the key, so you only have to enter it once.

- With OpenAI API you only pay for what you use. Track your usage and costs on the [Usage page](https://platform.openai.com/usage).
- After you send your first message to BIDARA, it will also be available to interact with through the [OpenAI Assistants Playground](https://platform.openai.com/assistants). This interface is more complex, but also provides more customizability. Just select BIDARA, then click the 'Test' button.

## :fire: Features enabled

Expand All @@ -16,7 +27,7 @@ BIDARA can guide users through the Biomimicry Institute’s [Design Process](htt

## :computer: For developers

Uses Svelte and [deep-chat](https://github.com/OvidijusParsiunas/deep-chat)
`bidara-deep-chat` uses Svelte and [the deep-chat web component](https://github.com/OvidijusParsiunas/deep-chat) to connect to BIDARA over the OpenAI Assistants API.
Template based on https://github.com/sveltejs/template

### Run locally
Expand Down Expand Up @@ -55,4 +66,4 @@ npm run dev

- get all messages using openai API. Then BIDARA can use the list of messages to summarize the conversation, or save the conversation history to PDF.

- get all code interpreter code. useful to check its work.
- get all code interpreter code. useful to check its work.

0 comments on commit 49bfdfd

Please sign in to comment.