Skip to content

Commit

Permalink
feat(api): update via SDK Studio (#18)
Browse files Browse the repository at this point in the history
  • Loading branch information
@stainless-app
stainless-app[bot] committed Mar 27, 2024
1 parent d3e8a75 commit f1cc79e
Show file tree
Hide file tree
Showing 8 changed files with 434 additions and 193 deletions.
11 changes: 5 additions & 6 deletions api.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,16 @@

Types:

- <code><a href="./src/resources/call.ts">CallResponse</a></code>
- <code><a href="./src/resources/call.ts">CallCreateResponse</a></code>
- <code><a href="./src/resources/call.ts">RegisterCallResponse</a></code>
- <code><a href="./src/resources/call.ts">CallRetrieveResponse</a></code>
- <code><a href="./src/resources/call.ts">CallListResponse</a></code>
- <code><a href="./src/resources/call.ts">CallRegisterResponse</a></code>

Methods:

- <code title="post /create-phone-call">client.call.<a href="./src/resources/call.ts">create</a>({ ...params }) -> CallCreateResponse</code>
- <code title="get /get-call/{call_id}">client.call.<a href="./src/resources/call.ts">retrieve</a>(callId) -> CallResponse</code>
- <code title="post /create-phone-call">client.call.<a href="./src/resources/call.ts">create</a>({ ...params }) -> RegisterCallResponse</code>
- <code title="get /get-call/{call_id}">client.call.<a href="./src/resources/call.ts">retrieve</a>(callId) -> CallRetrieveResponse</code>
- <code title="get /list-calls">client.call.<a href="./src/resources/call.ts">list</a>({ ...params }) -> CallListResponse</code>
- <code title="post /register-call">client.call.<a href="./src/resources/call.ts">register</a>({ ...params }) -> CallRegisterResponse</code>
- <code title="post /register-call">client.call.<a href="./src/resources/call.ts">register</a>({ ...params }) -> RegisterCallResponse</code>

# PhoneNumber

Expand Down
5 changes: 2 additions & 3 deletions src/index.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -185,10 +185,9 @@ export namespace Retell {
export import RequestOptions = Core.RequestOptions;

export import Call = API.Call;
export import CallResponse = API.CallResponse;
export import CallCreateResponse = API.CallCreateResponse;
export import RegisterCallResponse = API.RegisterCallResponse;
export import CallRetrieveResponse = API.CallRetrieveResponse;
export import CallListResponse = API.CallListResponse;
export import CallRegisterResponse = API.CallRegisterResponse;
export import CallCreateParams = API.CallCreateParams;
export import CallListParams = API.CallListParams;
export import CallRegisterParams = API.CallRegisterParams;
Expand Down
87 changes: 48 additions & 39 deletions src/resources/agent.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ export interface AgentResponse {
/**
* The name of the agent. Only used for your own reference.
*/
agent_name?: string;
agent_name?: string | null;

/**
* If set, will add ambient environment sound to the call to make experience more
Expand All @@ -95,24 +95,24 @@ export interface AgentResponse {
* - `mountain-outdoor`: Mountain outdoor ambience with birds singing.
* [Listen to Ambience](https://retell-utils-public.s3.us-west-2.amazonaws.com/mountain-outdoor.wav)
*
* Set to string `null` to remove ambient sound from this agent.
* Set to `null` to remove ambient sound from this agent.
*/
ambient_sound?: 'coffee-shop' | 'convention-hall' | 'summer-outdoor' | 'mountain-outdoor' | 'null';
ambient_sound?: 'coffee-shop' | 'convention-hall' | 'summer-outdoor' | 'mountain-outdoor' | null;

/**
* Provide a customized list of keywords to bias the transcriber model, so that
* these words are more likely to get transcribed. Commonly used for names, brands,
* street, etc.
*/
boosted_keywords?: Array<string>;
boosted_keywords?: Array<string> | null;

/**
* Controls whether the agent would backchannel (agent interjects the speaker with
* phrases like "yeah", "uh-huh" to signify interest and engagement). Backchannel
* when enabled tends to show up more in longer user utterances. If not set, agent
* will not backchannel.
*/
enable_backchannel?: boolean;
enable_backchannel?: boolean | null;

/**
* Whether to format the transcribed text with inverse text normalization. It
Expand All @@ -121,7 +121,7 @@ export interface AgentResponse {
* twenty two" can be converted into "february 4th 2022". If not set, the default
* is true.
*/
format_text?: boolean;
format_text?: boolean | null;

/**
* `Beta feature, use with caution.`
Expand All @@ -134,6 +134,8 @@ export interface AgentResponse {
* English, yet text-to-speech output will be in standard English. If
* dialect-specific text-to-speech is required, please contact us for support.
*
* If unset, will use default value `en-US`.
*
* - `11lab voices`: supports English(en), German(de), Spanish(es), Hindi(hi),
* Portuguese(pt)
*
Expand All @@ -152,44 +154,45 @@ export interface AgentResponse {
| 'hi-IN'
| 'ja-JP'
| 'pt-PT'
| 'pt-BR';
| 'pt-BR'
| null;

/**
* Disable transcripts and recordings storage for enhanced privacy. Access
* transcripts securely via webhooks.
*/
optOutSensitiveDataStorage?: boolean;
opt_out_sensitive_data_storage?: boolean | null;

/**
* Controls how responsive is the agent. Value ranging from [0,1]. Lower value
* means less responsive agent (wait more, respond slower), while higher value
* means faster exchanges (respond when it can). If unset, default value 1 will
* apply.
*/
responsiveness?: number;
responsiveness?: number | null;

/**
* Controls speed of voice. Value ranging from [0.5,2]. Lower value means slower
* speech, while higher value means faster speech rate. If unset, default value 1
* will apply.
*/
voice_speed?: number;
voice_speed?: number | null;

/**
* Controls how stable the voice is. Value ranging from [0,2]. Lower value means
* more stable, and higher value means more variant speech generation. Currently
* this setting only applies to `11labs` voices. If unset, default value 1 will
* apply.
*/
voice_temperature?: number;
voice_temperature?: number | null;

/**
* The webhook for agent to listen to call events. See what events it would get at
* [webhook doc](/features/webhook). If set, will binds webhook events for this
* agent to the specified url, and will ignore the account level webhook for this
* agent. Set to string `null` to remove webhook url from this agent.
* agent. Set to `null` to remove webhook url from this agent.
*/
webhook_url?: string;
webhook_url?: string | null;
}

export type AgentListResponse = Array<AgentResponse>;
Expand All @@ -211,7 +214,7 @@ export interface AgentCreateParams {
/**
* The name of the agent. Only used for your own reference.
*/
agent_name?: string;
agent_name?: string | null;

/**
* If set, will add ambient environment sound to the call to make experience more
Expand All @@ -230,24 +233,24 @@ export interface AgentCreateParams {
* - `mountain-outdoor`: Mountain outdoor ambience with birds singing.
* [Listen to Ambience](https://retell-utils-public.s3.us-west-2.amazonaws.com/mountain-outdoor.wav)
*
* Set to string `null` to remove ambient sound from this agent.
* Set to `null` to remove ambient sound from this agent.
*/
ambient_sound?: 'coffee-shop' | 'convention-hall' | 'summer-outdoor' | 'mountain-outdoor' | 'null';
ambient_sound?: 'coffee-shop' | 'convention-hall' | 'summer-outdoor' | 'mountain-outdoor' | null;

/**
* Provide a customized list of keywords to bias the transcriber model, so that
* these words are more likely to get transcribed. Commonly used for names, brands,
* street, etc.
*/
boosted_keywords?: Array<string>;
boosted_keywords?: Array<string> | null;

/**
* Controls whether the agent would backchannel (agent interjects the speaker with
* phrases like "yeah", "uh-huh" to signify interest and engagement). Backchannel
* when enabled tends to show up more in longer user utterances. If not set, agent
* will not backchannel.
*/
enable_backchannel?: boolean;
enable_backchannel?: boolean | null;

/**
* Whether to format the transcribed text with inverse text normalization. It
Expand All @@ -256,7 +259,7 @@ export interface AgentCreateParams {
* twenty two" can be converted into "february 4th 2022". If not set, the default
* is true.
*/
format_text?: boolean;
format_text?: boolean | null;

/**
* `Beta feature, use with caution.`
Expand All @@ -269,6 +272,8 @@ export interface AgentCreateParams {
* English, yet text-to-speech output will be in standard English. If
* dialect-specific text-to-speech is required, please contact us for support.
*
* If unset, will use default value `en-US`.
*
* - `11lab voices`: supports English(en), German(de), Spanish(es), Hindi(hi),
* Portuguese(pt)
*
Expand All @@ -287,51 +292,52 @@ export interface AgentCreateParams {
| 'hi-IN'
| 'ja-JP'
| 'pt-PT'
| 'pt-BR';
| 'pt-BR'
| null;

/**
* Disable transcripts and recordings storage for enhanced privacy. Access
* transcripts securely via webhooks.
*/
optOutSensitiveDataStorage?: boolean;
opt_out_sensitive_data_storage?: boolean | null;

/**
* Controls how responsive is the agent. Value ranging from [0,1]. Lower value
* means less responsive agent (wait more, respond slower), while higher value
* means faster exchanges (respond when it can). If unset, default value 1 will
* apply.
*/
responsiveness?: number;
responsiveness?: number | null;

/**
* Controls speed of voice. Value ranging from [0.5,2]. Lower value means slower
* speech, while higher value means faster speech rate. If unset, default value 1
* will apply.
*/
voice_speed?: number;
voice_speed?: number | null;

/**
* Controls how stable the voice is. Value ranging from [0,2]. Lower value means
* more stable, and higher value means more variant speech generation. Currently
* this setting only applies to `11labs` voices. If unset, default value 1 will
* apply.
*/
voice_temperature?: number;
voice_temperature?: number | null;

/**
* The webhook for agent to listen to call events. See what events it would get at
* [webhook doc](/features/webhook). If set, will binds webhook events for this
* agent to the specified url, and will ignore the account level webhook for this
* agent. Set to string `null` to remove webhook url from this agent.
* agent. Set to `null` to remove webhook url from this agent.
*/
webhook_url?: string;
webhook_url?: string | null;
}

export interface AgentUpdateParams {
/**
* The name of the agent. Only used for your own reference.
*/
agent_name?: string;
agent_name?: string | null;

/**
* If set, will add ambient environment sound to the call to make experience more
Expand All @@ -350,24 +356,24 @@ export interface AgentUpdateParams {
* - `mountain-outdoor`: Mountain outdoor ambience with birds singing.
* [Listen to Ambience](https://retell-utils-public.s3.us-west-2.amazonaws.com/mountain-outdoor.wav)
*
* Set to string `null` to remove ambient sound from this agent.
* Set to `null` to remove ambient sound from this agent.
*/
ambient_sound?: 'coffee-shop' | 'convention-hall' | 'summer-outdoor' | 'mountain-outdoor' | 'null';
ambient_sound?: 'coffee-shop' | 'convention-hall' | 'summer-outdoor' | 'mountain-outdoor' | null;

/**
* Provide a customized list of keywords to bias the transcriber model, so that
* these words are more likely to get transcribed. Commonly used for names, brands,
* street, etc.
*/
boosted_keywords?: Array<string>;
boosted_keywords?: Array<string> | null;

/**
* Controls whether the agent would backchannel (agent interjects the speaker with
* phrases like "yeah", "uh-huh" to signify interest and engagement). Backchannel
* when enabled tends to show up more in longer user utterances. If not set, agent
* will not backchannel.
*/
enable_backchannel?: boolean;
enable_backchannel?: boolean | null;

/**
* Whether to format the transcribed text with inverse text normalization. It
Expand All @@ -376,7 +382,7 @@ export interface AgentUpdateParams {
* twenty two" can be converted into "february 4th 2022". If not set, the default
* is true.
*/
format_text?: boolean;
format_text?: boolean | null;

/**
* `Beta feature, use with caution.`
Expand All @@ -389,6 +395,8 @@ export interface AgentUpdateParams {
* English, yet text-to-speech output will be in standard English. If
* dialect-specific text-to-speech is required, please contact us for support.
*
* If unset, will use default value `en-US`.
*
* - `11lab voices`: supports English(en), German(de), Spanish(es), Hindi(hi),
* Portuguese(pt)
*
Expand All @@ -407,7 +415,8 @@ export interface AgentUpdateParams {
| 'hi-IN'
| 'ja-JP'
| 'pt-PT'
| 'pt-BR';
| 'pt-BR'
| null;

/**
* The URL we will establish LLM websocket for getting response, usually your
Expand All @@ -420,15 +429,15 @@ export interface AgentUpdateParams {
* Disable transcripts and recordings storage for enhanced privacy. Access
* transcripts securely via webhooks.
*/
optOutSensitiveDataStorage?: boolean;
opt_out_sensitive_data_storage?: boolean | null;

/**
* Controls how responsive is the agent. Value ranging from [0,1]. Lower value
* means less responsive agent (wait more, respond slower), while higher value
* means faster exchanges (respond when it can). If unset, default value 1 will
* apply.
*/
responsiveness?: number;
responsiveness?: number | null;

/**
* Unique voice id used for the agent. Find list of available voices and their
Expand All @@ -441,23 +450,23 @@ export interface AgentUpdateParams {
* speech, while higher value means faster speech rate. If unset, default value 1
* will apply.
*/
voice_speed?: number;
voice_speed?: number | null;

/**
* Controls how stable the voice is. Value ranging from [0,2]. Lower value means
* more stable, and higher value means more variant speech generation. Currently
* this setting only applies to `11labs` voices. If unset, default value 1 will
* apply.
*/
voice_temperature?: number;
voice_temperature?: number | null;

/**
* The webhook for agent to listen to call events. See what events it would get at
* [webhook doc](/features/webhook). If set, will binds webhook events for this
* agent to the specified url, and will ignore the account level webhook for this
* agent. Set to string `null` to remove webhook url from this agent.
* agent. Set to `null` to remove webhook url from this agent.
*/
webhook_url?: string;
webhook_url?: string | null;
}

export namespace Agent {
Expand Down
Loading

0 comments on commit f1cc79e

Please sign in to comment.