diff --git a/.gitbook/assets/BULK-RUN-API (1).jpg b/.gitbook/assets/BULK-RUN-API (1).jpg new file mode 100644 index 0000000..1a3d59e Binary files /dev/null and b/.gitbook/assets/BULK-RUN-API (1).jpg differ diff --git a/.gitbook/assets/BULK-RUN-API (2) (1).jpg b/.gitbook/assets/BULK-RUN-API (2) (1).jpg new file mode 100644 index 0000000..ceadd7b Binary files /dev/null and b/.gitbook/assets/BULK-RUN-API (2) (1).jpg differ diff --git a/.gitbook/assets/BULK-RUN-API (2).jpg b/.gitbook/assets/BULK-RUN-API (2).jpg new file mode 100644 index 0000000..6695255 Binary files /dev/null and b/.gitbook/assets/BULK-RUN-API (2).jpg differ diff --git a/.gitbook/assets/BULK-RUN-API (3).jpg b/.gitbook/assets/BULK-RUN-API (3).jpg new file mode 100644 index 0000000..80e01f6 Binary files /dev/null and b/.gitbook/assets/BULK-RUN-API (3).jpg differ diff --git a/.gitbook/assets/BULK-RUN-API.jpg b/.gitbook/assets/BULK-RUN-API.jpg new file mode 100644 index 0000000..d64936c Binary files /dev/null and b/.gitbook/assets/BULK-RUN-API.jpg differ diff --git "a/.gitbook/assets/Screen Recording 2025-01-06 at 5.15.31\342\200\257PM processed.gif" "b/.gitbook/assets/Screen Recording 2025-01-06 at 5.15.31\342\200\257PM processed.gif" new file mode 100644 index 0000000..891e9f6 Binary files /dev/null and "b/.gitbook/assets/Screen Recording 2025-01-06 at 5.15.31\342\200\257PM processed.gif" differ diff --git "a/.gitbook/assets/Screenshot 2025-01-28 at 2.23.00\342\200\257PM.png" "b/.gitbook/assets/Screenshot 2025-01-28 at 2.23.00\342\200\257PM.png" new file mode 100644 index 0000000..939de80 Binary files /dev/null and "b/.gitbook/assets/Screenshot 2025-01-28 at 2.23.00\342\200\257PM.png" differ diff --git a/SUMMARY.md b/SUMMARY.md index 5dffdff..85ec589 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -23,6 +23,7 @@ * [⚖️ Understanding Bulk Runner and Evaluation](guides/understanding-bulk-runner-and-evaluation/README.md) * [💪 How to set up Bulk Runner?](guides/understanding-bulk-runner-and-evaluation/how-to-set-up-bulk-runner.md) * [🕵️‍♀️ How to set up Evaluations?](guides/understanding-bulk-runner-and-evaluation/how-to-set-up-evaluations.md) + * [How to use Bulk Run via API](guides/understanding-bulk-runner-and-evaluation/how-to-use-bulk-run-via-api.md) * [👄 How to use AI Lip Sync Generator?](guides/how-to-use-ai-lip-sync-generator/README.md) * [Lip Sync Animation Generator (WITH AUDIO FILES)](guides/how-to-use-ai-lip-sync-generator/lip-sync-animation-generator-with-audio-files.md) * [LipSync videos with Custom Voices](guides/how-to-use-ai-lip-sync-generator/lipsync-videos-with-custom-voices.md) diff --git a/guides/how-to-use-workspaces/frequently-asked-questions-about-workspaces.md b/guides/how-to-use-workspaces/frequently-asked-questions-about-workspaces.md index da2b102..58ad135 100644 --- a/guides/how-to-use-workspaces/frequently-asked-questions-about-workspaces.md +++ b/guides/how-to-use-workspaces/frequently-asked-questions-about-workspaces.md @@ -5,6 +5,21 @@ hidden: true # Frequently Asked Questions about Workspaces -### Q: Where can I find all my workspaces? +Q: How can I shift between my Workspace and my account? + +A: Click the icon on the top right to see your workspace and personal account. + +{% hint style="warning" %} +NOTE: The team or personal icon on top determines whose credits you are using for a run. If you hit "Run" on any Gooey.AI workflow and the "personal" icon is on the top right, it means your credits from the "personal" workspace will be debited. +{% endhint %} + +### Q: How can I manage my Workspace settings? + +A: Select the workspace in the top right corner, click on "Open Workspace". You will be led to the relevant workspace. + +Q: What are the various Workspaces roles? + +### Q: What are workspace roles? + +
FeatureOwnerAdminMember
Billing✅✅❌
Workspace Info Edit
(logo, name, description, handle)		✅✅❌
API Keys (Create and Delete)✅✅✅
Shared Workflows (View and Edit)✅✅✅
-A: Click the icon on the top right to see all your diff --git a/guides/understanding-bulk-runner-and-evaluation/how-to-use-bulk-run-via-api.md b/guides/understanding-bulk-runner-and-evaluation/how-to-use-bulk-run-via-api.md new file mode 100644 index 0000000..1f053af --- /dev/null +++ b/guides/understanding-bulk-runner-and-evaluation/how-to-use-bulk-run-via-api.md @@ -0,0 +1,65 @@ +--- +icon: code +--- + +# How to use Bulk Run via API + +### Step 1 + +* Run the TTS models you want to test on the UI. +* Copy the links of the test runs + +
+ +### Step 2 + +* Open Gooey.AI bulk +* Head to the API tab +* Click on the “curl” tab + +
+ +EXAMPLE: + +{% embed url="https://gooey.ai/bulk/compare-swahili-speech-recognition-ehrfs6a0yukt/api/" %} + +### Step 3 + +* Add your CSV/google sheet in the documents section (see a screenshot of the CSV example below) +* Add your run URLs in the run\_urls section. +* Point to the correct column for the input in input\_columns + +```sh +curl 'https://api.gooey.ai/v2/bulk-runner?example_id=ehrfs6a0yukt' \ + -H "Authorization: bearer $GOOEY_API_KEY" \ + -H 'Content-Type: application/json' \ + -d '{ + "documents": [ + "https://docs.google.com/spreadsheets/d/1EsQ_NKhyNikNNO3xLV9GOc6C5LTflu9dJ5CSpHqNUQs/edit?gid=0#gid=0" + ], + "run_urls": [ + "https://gooey.ai/compare-text-to-speech-engines/?run_id=todlwvm01l31&uid=fm165fOmucZlpa5YHupPBdcvDR02", + "https://gooey.ai/compare-text-to-speech-engines/?run_id=j8v9fqrfl26o&uid=fm165fOmucZlpa5YHupPBdcvDR02", + ], + "input_columns": { + "text_prompt": "Column Name" + }, + "output_columns": { + "price": "Price", + "run_url": "Run URL", + "run_time": "Run Time", + "output_text": "Output Text", + "raw_output_text": "Raw Output Text" + } +}' +``` + +
+ +### How can I calculate the credits? + +
+ +* Please check the credit per run in the sample run you run for your bulk run. +* This should be the average cost per run. +* Since you are running Bulk API, you can also check the credits for every run by adding `"price": "Price"` in the `"output_columns"` section