From aae09fef7e63170296699f6b7ce799501800f55b Mon Sep 17 00:00:00 2001 From: Brandon Ruffridge Date: Wed, 24 Jan 2024 15:50:58 -0500 Subject: [PATCH 1/3] Update README.md --- README.md | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 1c7dfac..cbb90bd 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,16 @@ 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. +`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: + +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' +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' +7. Verify your phone number, then click the 'Create new secret key' button. +8. Copy your secret key and enter it into BIDARA. ## :fire: Features enabled @@ -49,4 +58,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. \ No newline at end of file +- get all code interpreter code. useful to check its work. From 1dc5e2281f0c35e6211ad5db9bb2e34d327bd1a9 Mon Sep 17 00:00:00 2001 From: Brandon Ruffridge Date: Wed, 24 Jan 2024 16:04:19 -0500 Subject: [PATCH 2/3] Update README.md --- README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index cbb90bd..e891e4e 100644 --- a/README.md +++ b/README.md @@ -2,20 +2,20 @@ ### 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: +## :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' +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' +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 and enter it into BIDARA. +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. +10. With OpenAI API you only pay for what you use. Track your usage and costs on the [Usage page](https://platform.openai.com/usage). ## :fire: Features enabled @@ -25,7 +25,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 From a65120bde05792ec8dfd94b1b76a1d2ab50fa9fb Mon Sep 17 00:00:00 2001 From: Brandon Ruffridge Date: Wed, 24 Jan 2024 16:35:30 -0500 Subject: [PATCH 3/3] Update README.md --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index e891e4e..5d609bd 100644 --- a/README.md +++ b/README.md @@ -14,8 +14,10 @@ BIDARA can guide users through the Biomimicry Institute’s [Design Process](htt 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. -10. With OpenAI API you only pay for what you use. Track your usage and costs on the [Usage page](https://platform.openai.com/usage). +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