-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
91daa0b
commit a2f7dfb
Showing
10 changed files
with
83 additions
and
2 deletions.
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+384 KB
.gitbook/assets/Screen Recording 2025-01-06 at 5.15.31 PM processed.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
65 changes: 65 additions & 0 deletions
65
guides/understanding-bulk-runner-and-evaluation/how-to-use-bulk-run-via-api.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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  | ||
|
||
<figure><img src="../../.gitbook/assets/BULK-RUN-API (3).jpg" alt=""><figcaption></figcaption></figure> | ||
|
||
### Step 2 | ||
|
||
* Open Gooey.AI bulk  | ||
* Head to the API tab  | ||
* Click on the “curl” tab | ||
|
||
<figure><img src="../../.gitbook/assets/BULK-RUN-API (1).jpg" alt=""><figcaption></figcaption></figure> | ||
|
||
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" | ||
} | ||
}' | ||
``` | ||
|
||
<figure><img src="../../.gitbook/assets/Screenshot 2025-01-28 at 2.23.00 PM.png" alt=""><figcaption></figcaption></figure> | ||
|
||
### How can I calculate the credits?  | ||
|
||
<figure><img src="../../.gitbook/assets/BULK-RUN-API (2) (1).jpg" alt=""><figcaption></figcaption></figure> | ||
|
||
* 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 |