Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@shaharLiblab
shaharLiblab committed Jul 11, 2024
1 parent fcf9de3 commit 23d0522
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 10 deletions.
10 changes: 5 additions & 5 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -309,8 +309,8 @@ Optional parameters are passed as part of the last parameter to the method. Ex.
| Name | Type | Description |
| :------ | :----- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| key | string | API key issued by Speechace. |
| userId | string | A unique anonymized identifier for the end-user who spoke the audio. <br><br>Structure this field to include as much info as possible to aid in reporting and analytics.<br><br>For example: **user_id=XYZ-ABC-99001** where:<br> <br>_ XYZ is an id for your Product or App<br>_ ABC is an id for the customer/site/account<br>\* 99001 is an id for the end-user<br><br>Ensure user_id is unique and anonymized containing **no personally identifiable information**. |
| dialect | string | The dialect to use for scoring. Supported values are "en-us" (US English) and "en-gb" (UK English).<br><br>en-gb requires setting v0.1 in url path. i.e. `https://api.speechace.co/api/scoring/text/v0.1/json?` |
| userId | string | A unique anonymized identifier for the end-user who spoke the audio. \n\nStructure this field to include as much info as possible to aid in reporting and analytics.\n\nFor example: **user_id=XYZ-ABC-99001** where:\n \n_ XYZ is an id for your Product or App\n_ ABC is an id for the customer/site/account\n\* 99001 is an id for the end-user\n\nEnsure user_id is unique and anonymized containing **no personally identifiable information**. |
| dialect | string | The dialect to use for scoring. Supported values are "en-us" (US English) and "en-gb" (UK English).\n\nen-gb requires setting v0.1 in url path. i.e. `https://api.speechace.co/api/scoring/text/v0.1/json?` |

**Return Type**

Expand Down Expand Up @@ -353,8 +353,8 @@ Optional parameters are passed as part of the last parameter to the method. Ex.
| Name | Type | Description |
| :------ | :----- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| key | string | API key issued by Speechace. |
| userId | string | A unique anonymized identifier for the end-user who spoke the audio. <br><br>Structure this field to include as much info as possible to aid in reporting and analytics.<br><br>For example: **user_id=XYZ-ABC-99001** where:<br> <br>_ XYZ is an id for your Product or App<br>_ ABC is an id for the customer/site/account<br>\* 99001 is an id for the end-user<br><br>Ensure user_id is unique and anonymized containing **no personally identifiable information**. |
| dialect | string | The dialect to use for scoring. Supported values are "en-us" (US English) and "en-gb" (UK English).<br><br>en-gb requires setting v0.1 in url path. i.e. `https://api.speechace.co/api/scoring/text/v0.1/json?` |
| userId | string | A unique anonymized identifier for the end-user who spoke the audio. \n\nStructure this field to include as much info as possible to aid in reporting and analytics.\n\nFor example: **user_id=XYZ-ABC-99001** where:\n \n_ XYZ is an id for your Product or App\n_ ABC is an id for the customer/site/account\n\* 99001 is an id for the end-user\n\nEnsure user_id is unique and anonymized containing **no personally identifiable information**. |
| dialect | string | The dialect to use for scoring. Supported values are "en-us" (US English) and "en-gb" (UK English).\n\nen-gb requires setting v0.1 in url path. i.e. `https://api.speechace.co/api/scoring/text/v0.1/json?` |

**Return Type**

Expand Down Expand Up @@ -442,7 +442,7 @@ Optional parameters are passed as part of the last parameter to the method. Ex.
| :------ | :----- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| key | string | API key issued by Speechace. |
| dialect | string | The dialect to use for scoring. Supported values are "en-us" (US English) and "en-gb" (UK English). |
| userId | string | A unique anonymized identifier for the end-user who spoke the audio. <br>Structure this field to include as much info as possible to aid in reporting and analytics.<br>For example: **user_id=XYZ-ABC-99001** where:<br> <br>_ XYZ is an id for your Product or App<br>_ ABC is an id for the customer/site/account<br>\* 99001 is an id for the end-user<br>Ensure user_id is unique and anonymized containing **no personally identifiable information**. |
| userId | string | A unique anonymized identifier for the end-user who spoke the audio. \nStructure this field to include as much info as possible to aid in reporting and analytics.\nFor example: **user_id=XYZ-ABC-99001** where:\n \n_ XYZ is an id for your Product or App\n_ ABC is an id for the customer/site/account\n\* 99001 is an id for the end-user\nEnsure user_id is unique and anonymized containing **no personally identifiable information**. |

**Return Type**

Expand Down
10 changes: 5 additions & 5 deletions src/services/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -267,8 +267,8 @@ Optional parameters are passed as part of the last parameter to the method. Ex.
| Name | Type | Description |
| :------ | :----- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| key | string | API key issued by Speechace. |
| userId | string | A unique anonymized identifier for the end-user who spoke the audio. <br><br>Structure this field to include as much info as possible to aid in reporting and analytics.<br><br>For example: **user_id=XYZ-ABC-99001** where:<br> <br>_ XYZ is an id for your Product or App<br>_ ABC is an id for the customer/site/account<br>\* 99001 is an id for the end-user<br><br>Ensure user_id is unique and anonymized containing **no personally identifiable information**. |
| dialect | string | The dialect to use for scoring. Supported values are "en-us" (US English) and "en-gb" (UK English).<br><br>en-gb requires setting v0.1 in url path. i.e. `https://api.speechace.co/api/scoring/text/v0.1/json?` |
| userId | string | A unique anonymized identifier for the end-user who spoke the audio. \n\nStructure this field to include as much info as possible to aid in reporting and analytics.\n\nFor example: **user_id=XYZ-ABC-99001** where:\n \n_ XYZ is an id for your Product or App\n_ ABC is an id for the customer/site/account\n\* 99001 is an id for the end-user\n\nEnsure user_id is unique and anonymized containing **no personally identifiable information**. |
| dialect | string | The dialect to use for scoring. Supported values are "en-us" (US English) and "en-gb" (UK English).\n\nen-gb requires setting v0.1 in url path. i.e. `https://api.speechace.co/api/scoring/text/v0.1/json?` |

**Return Type**

Expand Down Expand Up @@ -311,8 +311,8 @@ Optional parameters are passed as part of the last parameter to the method. Ex.
| Name | Type | Description |
| :------ | :----- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| key | string | API key issued by Speechace. |
| userId | string | A unique anonymized identifier for the end-user who spoke the audio. <br><br>Structure this field to include as much info as possible to aid in reporting and analytics.<br><br>For example: **user_id=XYZ-ABC-99001** where:<br> <br>_ XYZ is an id for your Product or App<br>_ ABC is an id for the customer/site/account<br>\* 99001 is an id for the end-user<br><br>Ensure user_id is unique and anonymized containing **no personally identifiable information**. |
| dialect | string | The dialect to use for scoring. Supported values are "en-us" (US English) and "en-gb" (UK English).<br><br>en-gb requires setting v0.1 in url path. i.e. `https://api.speechace.co/api/scoring/text/v0.1/json?` |
| userId | string | A unique anonymized identifier for the end-user who spoke the audio. \n\nStructure this field to include as much info as possible to aid in reporting and analytics.\n\nFor example: **user_id=XYZ-ABC-99001** where:\n \n_ XYZ is an id for your Product or App\n_ ABC is an id for the customer/site/account\n\* 99001 is an id for the end-user\n\nEnsure user_id is unique and anonymized containing **no personally identifiable information**. |
| dialect | string | The dialect to use for scoring. Supported values are "en-us" (US English) and "en-gb" (UK English).\n\nen-gb requires setting v0.1 in url path. i.e. `https://api.speechace.co/api/scoring/text/v0.1/json?` |

**Return Type**

Expand Down Expand Up @@ -400,7 +400,7 @@ Optional parameters are passed as part of the last parameter to the method. Ex.
| :------ | :----- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| key | string | API key issued by Speechace. |
| dialect | string | The dialect to use for scoring. Supported values are "en-us" (US English) and "en-gb" (UK English). |
| userId | string | A unique anonymized identifier for the end-user who spoke the audio. <br>Structure this field to include as much info as possible to aid in reporting and analytics.<br>For example: **user_id=XYZ-ABC-99001** where:<br> <br>_ XYZ is an id for your Product or App<br>_ ABC is an id for the customer/site/account<br>\* 99001 is an id for the end-user<br>Ensure user_id is unique and anonymized containing **no personally identifiable information**. |
| userId | string | A unique anonymized identifier for the end-user who spoke the audio. \nStructure this field to include as much info as possible to aid in reporting and analytics.\nFor example: **user_id=XYZ-ABC-99001** where:\n \n_ XYZ is an id for your Product or App\n_ ABC is an id for the customer/site/account\n\* 99001 is an id for the end-user\nEnsure user_id is unique and anonymized containing **no personally identifiable information**. |

**Return Type**

Expand Down

0 comments on commit 23d0522

Please sign in to comment.