merge staging docs (#367)

* checkpoint. routes first pass done, schemas not working * progress * restore some changes * change outline * update hosted quickstart * create docs for getting number (#293) * update code snippets for getting-number * finish using-actions * Add configuring numbers page * updates * nit * retrieve call data draft * use new openapi schema * updates * polish * schemas tab * Add vector db docs * vector db updates * update voices and add multilingual docs * context injection docs * remove environment params * adds dashboard link --------- Co-authored-by: Kian <[email protected]> Co-authored-by: Hayden Housen <[email protected]> Co-authored-by: zaptrem <[email protected]>
vocodedev · Aug 22, 2023 · c5a39b8 · c5a39b8
1 parent 8ace1a6
commit c5a39b8
Show file tree

Hide file tree

Showing 68 changed files with 2,853 additions and 67 deletions.
diff --git a/docs/agents.mdx b/docs/agents.mdx
@@ -0,0 +1,10 @@
+---
+title: "Agents"
+description: "🚧 Under construction"
+---
+
+# What are agents
+
+# How to configure an agent
+
+# API Schema
diff --git a/docs/api-reference/actions/create-action.mdx b/docs/api-reference/actions/create-action.mdx
@@ -0,0 +1,3 @@
+---
+openapi: post /v1/actions/create
+---
diff --git a/docs/api-reference/actions/get-action.mdx b/docs/api-reference/actions/get-action.mdx
@@ -0,0 +1,3 @@
+---
+openapi: get /v1/actions/
+---
diff --git a/docs/api-reference/actions/list-actions.mdx b/docs/api-reference/actions/list-actions.mdx
@@ -0,0 +1,3 @@
+---
+openapi: get /v1/actions/list
+---
diff --git a/docs/api-reference/actions/update-action.mdx b/docs/api-reference/actions/update-action.mdx
@@ -0,0 +1,3 @@
+---
+openapi: post /v1/actions/update
+---
diff --git a/docs/api-reference/agents/create-agent.mdx b/docs/api-reference/agents/create-agent.mdx
@@ -0,0 +1,3 @@
+---
+openapi: post /v1/agents/create
+---
diff --git a/docs/api-reference/agents/get-agent.mdx b/docs/api-reference/agents/get-agent.mdx
@@ -0,0 +1,3 @@
+---
+openapi: get /v1/agents/
+---
diff --git a/docs/api-reference/agents/list-agents.mdx b/docs/api-reference/agents/list-agents.mdx
@@ -0,0 +1,3 @@
+---
+openapi: get /v1/agents/list
+---
diff --git a/docs/api-reference/agents/update-agent.mdx b/docs/api-reference/agents/update-agent.mdx
@@ -0,0 +1,3 @@
+---
+openapi: post /v1/agents/update
+---
diff --git a/docs/api-reference/calls/create-call.mdx b/docs/api-reference/calls/create-call.mdx
@@ -0,0 +1,3 @@
+---
+openapi: post /v1/calls/create
+---
diff --git a/docs/api-reference/calls/end-call.mdx b/docs/api-reference/calls/end-call.mdx
@@ -0,0 +1,3 @@
+---
+openapi: post /v1/calls/end
+---
diff --git a/docs/api-reference/calls/get-call.mdx b/docs/api-reference/calls/get-call.mdx
@@ -0,0 +1,3 @@
+---
+openapi: get /v1/calls/
+---
diff --git a/docs/api-reference/calls/list-calls.mdx b/docs/api-reference/calls/list-calls.mdx
@@ -0,0 +1,3 @@
+---
+openapi: get /v1/calls/list
+---
diff --git a/docs/api-reference/numbers/buy-number.mdx b/docs/api-reference/numbers/buy-number.mdx
@@ -0,0 +1,3 @@
+---
+openapi: post /v1/numbers/buy
+---
diff --git a/docs/api-reference/numbers/cancel-number.mdx b/docs/api-reference/numbers/cancel-number.mdx
@@ -0,0 +1,3 @@
+---
+openapi: post /v1/numbers/cancel
+---
diff --git a/docs/api-reference/numbers/get-number.mdx b/docs/api-reference/numbers/get-number.mdx
@@ -0,0 +1,3 @@
+---
+openapi: get /v1/numbers/
+---
diff --git a/docs/api-reference/numbers/list-numbers.mdx b/docs/api-reference/numbers/list-numbers.mdx
@@ -0,0 +1,3 @@
+---
+openapi: get /v1/numbers/list
+---
diff --git a/docs/api-reference/numbers/update-number.mdx b/docs/api-reference/numbers/update-number.mdx
@@ -0,0 +1,3 @@
+---
+openapi: post /v1/numbers/update
+---
diff --git a/docs/api-reference/schemas/action-config.mdx b/docs/api-reference/schemas/action-config.mdx
@@ -0,0 +1,3 @@
+---
+openapi-schema: ActionConfig
+---
diff --git a/docs/api-reference/schemas/action-type.mdx b/docs/api-reference/schemas/action-type.mdx
@@ -0,0 +1,3 @@
+---
+openapi-schema: ActionType
+---
diff --git a/docs/api-reference/usage/get-usage.mdx b/docs/api-reference/usage/get-usage.mdx
@@ -0,0 +1,3 @@
+---
+openapi: get /v1/usage/
+---
diff --git a/docs/api-reference/voices/create-voice.mdx b/docs/api-reference/voices/create-voice.mdx
@@ -0,0 +1,3 @@
+---
+openapi: post /v1/voices/create
+---
diff --git a/docs/api-reference/voices/get-voice.mdx b/docs/api-reference/voices/get-voice.mdx
@@ -0,0 +1,3 @@
+---
+openapi: get /v1/voices/
+---
diff --git a/docs/api-reference/voices/list-voices.mdx b/docs/api-reference/voices/list-voices.mdx
@@ -0,0 +1,3 @@
+---
+openapi: get /v1/voices/list
+---
diff --git a/docs/api-reference/voices/update-voice.mdx b/docs/api-reference/voices/update-voice.mdx
@@ -0,0 +1,3 @@
+---
+openapi: post /v1/voices/update
+---
diff --git a/docs/api-reference/webhooks/create-webhook.mdx b/docs/api-reference/webhooks/create-webhook.mdx
@@ -0,0 +1,3 @@
+---
+openapi: post /v1/webhooks/create
+---
diff --git a/docs/api-reference/webhooks/get-webhook.mdx b/docs/api-reference/webhooks/get-webhook.mdx
@@ -0,0 +1,3 @@
+---
+openapi: get /v1/webhooks/
+---
diff --git a/docs/api-reference/webhooks/list-webhooks.mdx b/docs/api-reference/webhooks/list-webhooks.mdx
@@ -0,0 +1,3 @@
+---
+openapi: get /v1/webhooks/list
+---
diff --git a/docs/api-reference/webhooks/update-webhook.mdx b/docs/api-reference/webhooks/update-webhook.mdx
@@ -0,0 +1,3 @@
+---
+openapi: post /v1/webhooks/update
+---
diff --git a/docs/call-object.mdx b/docs/call-object.mdx
@@ -0,0 +1,4 @@
+---
+title: "Call Object"
+description: "🚧 Under construction"
+---
diff --git a/docs/configuring-number.mdx b/docs/configuring-number.mdx
@@ -0,0 +1,190 @@
+---
+title: "Configuring your number"
+description: "Learn how to configure your phone number with an agent."
+---
+
+# Configuring Numbers
+
+Once you have purchased a number, you can configure it with an inbound agent to set its prompt, voice, and actions.
+
+## Pick your Number
+
+First, list your numbers and pick the number you want to configure.
+
+<CodeGroup>
+
+```python Python
+numbers = vocode_client.numbers.list_numbers()
+```
+
+```javascript TypeScript
+const numbers = await vocode.numbers.listNumbers();
+```
+
+</CodeGroup>
+
+## Changing the Prompt
+
+All phone numbers come with the default agent configuration. Let's change the
+prompt so the AI responds like Yoda.
+
+<CodeGroup>
+
+```python Python
+from vocode import AgentUpdateParams
+
+yoda_prompt = "I want you to act as Yoda. Respond as Yoda would."
+number = vocode_client.numbers.update_number(
+    phone_number="YOUR_NUMBER", inbound_agent=AgentUpdateParams(prompt=yoda_prompt)
+)
+```
+
+```javascript TypeScript
+const yoda_prompt = "I want you to act as Yoda. Respond as Yoda would.";
+const number = await vocode.numbers.updateNumber({
+  phoneNumber: "YOUR_NUMBER",
+  inboundAgent: { prompt: yoda_prompt },
+});
+```
+
+</CodeGroup>
+
+## Changing the Voice
+
+Our prompt has been updated. Now let's use a voice provided by other API providers.
+
+### Rime
+
+<CodeGroup>
+
+```python Python
+from vocode import RimeVoiceParams, VoiceType
+
+rime_voice = RimeVoiceParams(
+    type=VoiceType.VOICE_RIME,
+    speaker="RIME_SPEAKER",
+)
+voice = vocode_client.voices.create_voice(request=rime_voice)
+```
+
+```javascript TypeScript
+import { VoiceType } from "@vocode/vocode-api/api";
+
+const rimeVoice = {
+  type: VoiceType.VoiceRime,
+  voiceId: "RIME_SPEAKER",
+};
+const number = await vocode.voices.createVoice(rimeVoice);
+```
+
+</CodeGroup>
+
+### Play.ht
+
+<CodeGroup>
+
+```python Python
+from vocode import PlayHtVoiceParams, VoiceType
+
+play_ht_voice = PlayHtVoiceParams(
+    type=VoiceType.VOICE_PLAY_HT,
+    voice_id="PLAY_HT_VOICE_ID",
+    api_user_id="PLAY_HT_USER_ID",
+    api_key="PLAY_HT_API_KEY",
+)
+voice = vocode_client.voices.create_voice(request=play_ht_voice)
+```
+
+```javascript TypeScript
+import { VoiceType } from "@vocode/vocode-api/api";
+
+const playHtVoice = {
+  type: VoiceType.VoicePlayHt,
+  voiceId: "PLAY_HT_VOICE_ID",
+  apiUserId: "PLAY_HT_USER_ID",
+  apiKey: "PLAY_HT_API_KEY,
+};
+const number = await vocode.voices.createVoice(playHtVoice);
+```
+
+</CodeGroup>
+
+### ElevenLabs
+
+We will use the `rachel` voice from ElevenLabs. Instead of updating our existing agent directly,
+we'll create a new voice config and set the agent to use it.
+
+<CodeGroup>
+
+```python Python
+from vocode import ElevenLabsVoiceParams, VoiceType
+
+elevenlabs_voice = ElevenLabsVoiceParams(
+    type=VoiceType.VOICE_ELEVEN_LABS,
+    voice_id="ELEVEN_LABS_VOICE_ID",
+    api_key="ELEVEN_LABS_API_KEY",
+)
+voice = vocode_client.voices.create_voice(request=elevenlabs_voice)
+```
+
+```javascript TypeScript
+import { VoiceType } from "@vocode/vocode-api/api";
+
+const elevenlabsVoice = {
+  type: VoiceType.VoiceElevenLabs,
+  voiceId: "ELEVEN_LABS_VOICE_ID",
+  apiKey: "ELEVEN_LABS_API_KEY",
+};
+const number = await vocode.voices.createVoice(elevenlabsVoice);
+```
+
+</CodeGroup>
+
+Now, we have our `voice_id` and can update our agent to use it.
+
+<CodeGroup>
+
+```python Python
+from vocode import AgentUpdateParams
+
+agent = vocode_client.agents.update_agent(
+    id="AGENT_ID",
+    request=AgentUpdateParams(voice="VOICE_ID"),
+)
+```
+
+```javascript TypeScript
+const agent = await vocode.agents.updateAgent({
+  id: "AGENT_ID",
+  body: { voice: "VOICE_ID" },
+});
+console.log(agent);
+```
+
+</CodeGroup>
+
+## Adding an Initial Message
+
+The initial message will be spoken as soon as the call starts before the user says anything. Let's make our agent say "Hello, I am Yoda" when the call starts.
+
+<CodeGroup>
+
+```python Python
+from vocode import AgentUpdateParams
+
+number = vocode_client.numbers.update_number(
+    phone_number="YOUR_NUMBER", inbound_agent=AgentUpdateParams(initial_message="Hello, I am Yoda.")
+)
+
+```
+
+```javascript TypeScript
+import { VocodeClient } from "@vocode/vocode-api";
+
+const number = await vocode.numbers.updateNumber({
+  phoneNumber: "YOUR_NUMBER",
+  inboundAgent: { initialMessage: "Hello, I am Yoda." },
+});
+```
+
+</CodeGroup>
diff --git a/docs/getting-number.mdx b/docs/getting-number.mdx
@@ -0,0 +1,38 @@
+---
+title: "Getting a number"
+---
+
+If you're on the Free plan, you'll have to head to the [dashboard](https://app.vocode.dev) to buy numbers. The Developer and
+Enterprise plans both come with numbers included in the subscription. For more info, see [Pricing](https://vocode.dev/pricing).
+
+<CodeGroup>
+
+```python Python
+phone_number = vocode_client.numbers.buy_number()
+```
+
+```typescript TypeScript
+const phoneNumber = await vocode.numbers.buyNumber();
+```
+
+```bash cURL
+curl --request POST \
+  --url https://api.vocode.dev/v1/numbers/buy \
+  --header 'Content-Type: application/json' \
+  --header 'Authorization: Bearer <API_KEY>'
+```
+
+</CodeGroup>
+
+You'll get a response that looks like:
+
+```json
+{
+  "id": "***",
+  "user_id": "***",
+  "number": "11234567890",
+  "inbound_agent": {...}
+}
+```
+
+Your phone number is now active! Call the phone number and have a conversation with your AI.