Skip to content

Commit fb3a1cf

Browse files
committed
Merge remote-tracking branch 'origin/main' into fern/update-api-specs
2 parents fdd82eb + 2a179a4 commit fb3a1cf

File tree

10 files changed

+129
-18
lines changed

10 files changed

+129
-18
lines changed

fern/advanced/sip/sip-telynx.mdx renamed to fern/advanced/sip/sip-telnyx.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
2-
title: Telynx SIP Integration
2+
title: Telnyx SIP Integration
33
subtitle: How to integrate SIP Telnyx to Vapi
4-
slug: advanced/sip/telynx
4+
slug: advanced/sip/telnyx
55
---
66
## Inbound
77
### On Vapi
@@ -45,7 +45,7 @@ Now every time you make a call to this number (i.e. assigned numbers on SIP trun
4545
</Step>
4646
</Steps>
4747

48-
### On Telynx
48+
### On Telnyx
4949
<Steps>
5050
<Step title="Setup inbound authentication">
5151
1. Go to Voice / SIP Trunking / Create
@@ -79,7 +79,7 @@ Modify SIP invite so your VAPI and Telnyx accounts will be matched correctly
7979
</Steps>
8080

8181
## Outbound
82-
### On Telynx
82+
### On Telnyx
8383
<Steps>
8484
<Step title="Set outbound authentication method">
8585
1. Go to Voice / Sip Trunking / Authentication and routing

fern/apis/api/generators.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ groups:
1010
python-sdk:
1111
generators:
1212
- name: fernapi/fern-python-sdk
13-
version: 4.3.9
13+
version: 4.3.10
1414
disable-examples: true
1515
api:
1616
settings:
@@ -47,7 +47,7 @@ groups:
4747
java-sdk:
4848
generators:
4949
- name: fernapi/fern-java-sdk
50-
version: 2.3.1
50+
version: 2.8.1
5151
output:
5252
location: maven
5353
coordinate: dev.vapi:server-sdk
@@ -60,7 +60,7 @@ groups:
6060
go-sdk:
6161
generators:
6262
- name: fernapi/fern-go-sdk
63-
version: 0.33.0
63+
version: 0.35.0
6464
api:
6565
settings:
6666
unions: v1

fern/apis/api/openapi-overrides.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@ x-fern-pagination:
22
offset: $request.page
33
results: $response.results
44
paths:
5+
/enterprise:
6+
post:
7+
x-fern-ignore: true
58
/call:
69
get:
710
x-fern-sdk-group-name:

fern/changelog/2024-12-21.mdx

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
**Expanded Voice Compatibility with Realtime Models**: You can use the voices ash, ballad, coral, sage, and verse with any realtime models, giving you more flexibility in voice synthesis options.
2+
3+
**Access to New OpenAI Models**:
4+
You can now specify the new models `gpt-4o-realtime-preview-2024-12-17` and `gpt-4o-mini-realtime-preview-2024-12-17` when configuring `OpenAIModel.model` and `OpenAIModel.fallbackModels`.
5+
6+
**New ElevenLabs Voice Models Available**:
7+
The new voice models `eleven_flash_v2` and `eleven_flash_v2_5` are now available for use in `ElevenLabsVoice` and `FallbackElevenLabsVoice`, offering potential improvements in voice performance.

fern/changelog/2024-12-30.mdx

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
1. **Addition of *AzureSpeechTranscriber*:**
2+
You can now configure assistants to use Azure's speech transcription service by setting
3+
`AzureSpeechTranscriber.provider` to `azure`. Additionally, you will receive azure transcriber errors like `pipeline-error-azure-speech-transcriber-failed` in `Call.endReason`, `ServerMessageEndOfCallReport.endReason`, and `ServerMessageStatusUpdate.endReason`.
4+
5+
2. **Combined `serverUrl` and `serverUrlSecret` into `server` Property**:
6+
The `serverUrl` and `serverUrlSecret` properties have been replaced by a new `server` property in multiple schemas. This lets you configure webhook endpoints using the `server` object, allowing for more detailed and flexible setup, including URL and authentication, in a single place. These schemas include:
7+
- ByoPhoneNumber
8+
- BuyPhoneNumberDTO
9+
- CreateByoPhoneNumberDTO
10+
- CreateOrgDTO
11+
- CreateTwilioPhoneNumberDTO
12+
- CreateVapiPhoneNumberDTO
13+
- CreateVonagePhoneNumberDTO
14+
- ImportTwilioPhoneNumberDTO
15+
- ImportVonagePhoneNumberDTO
16+
- Org
17+
- OrgWithOrgUser
18+
- TwilioPhoneNumber
19+
- UpdateOrgDTO
20+
- UpdatePhoneNumberDTO
21+
- VapiPhoneNumber
22+
- VonagePhoneNumber
23+
24+
3. **Introduction of New OpenAI Models**:
25+
You can now use `o1-preview`, `o1-preview-2024-09-12`, `o1-mini`, and `o1-mini-2024-09-12`. in `OpenAIModel.model`.
26+
27+
4. **Introduction of *'sonic' Voice Models* in Voice Schemas:**
28+
You can now use `sonic` and `sonic-preview` models in `CartesiaVoice.model` and `FallbackCartesiaVoice.model` configurations.
29+
30+
5. **Removal of Deprecated *GroqModel* Models:**
31+
The models `llama3-groq-8b-8192-tool-use-preview` and `llama3-groq-70b-8192-tool-use-preview` have been removed from `GroqModel.model`. You should switch to supported models to avoid any disruptions.

fern/changelog/2025-01-05.mdx

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
1. **New Transfer Plan Mode Added**: You can now include call summaries in the SIP header during blind transfers without assistant involvement with `blind-transfer-add-summary-to-sip-header` (a new `TransferPlan.mode` option). Doing so will make `ServerMessageStatusUpdate` include a `summary` when the call status is `forwarding` - which means you can access call summaries for real-time display or logging purposes in your SIP calls.
2+
3+
2. **Azure Speech Transcription Support**: You can now specify a new property called `AzureSpeechTranscriber.language` in Azure's Speech-to-Text service to improve the accuracy of processing spoken input.
4+
5+
3. **New Groq Model Available**: You can now use `'llama-3.3-70b-versatile'` in `GroqModel.model`.
6+
7+
<Frame caption="New Groq Model">
8+
<img src="../static/images/changelog/groq-new-model.png" />
9+
</Frame>
Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
---
2+
title: Bring your own chunks/vectors from Trieve
3+
subtitle: Use existing chunks/vectors from [Trieve](https://trieve.ai)
4+
slug: customization/bring-your-own-vectors/trieve
5+
---
6+
7+
Vapi supports Trieve as a knowledgebase provider, allowing you to leverage your existing document embeddings and chunks. While Vapi maintains its own storage of documents and vectors, you can seamlessly integrate with your Trieve datasets.
8+
9+
## Use Cases
10+
11+
### Existing Knowledge Base Migration
12+
13+
If you've already invested time in building and organizing your knowledge base in Trieve, you can continue using those vectors without having to reprocess your documents. This is particularly useful for:
14+
15+
- Large document collections that took significant time to process
16+
- Carefully curated and cleaned datasets
17+
- Custom-chunked documents with specific segmentation rules
18+
19+
### Parallel Systems
20+
21+
You might want to use both Trieve's native interface and Vapi simultaneously:
22+
23+
- Use Trieve's UI for content management and organization
24+
- Leverage Vapi's chat interface and API capabilities
25+
- Maintain consistency across both platforms
26+
27+
## Integration Steps
28+
29+
1. **Configure Trieve Credentials**
30+
31+
- Navigate to the credentials page in your [Vapi dashboard](https://dashboard.vapi.ai/keys)
32+
- Add your Trieve API key for authentication from [Trieve](https://dashboard.trieve.ai/org/keys)
33+
34+
2. **Create a New Knowledge Base**
35+
36+
- When setting up a new knowledge base, provide:
37+
- Your Trieve datasetId as the vectorStoreProviderId
38+
- Appropriate search configuration parameters
39+
- Vapi will then connect to your existing Trieve vectors
40+
41+
Example configuration:
42+
43+
```json
44+
{
45+
"name": "byok-test",
46+
"provider": "trieve",
47+
"vectorStoreSearchPlan": {
48+
"scoreThreshold": 0.2,
49+
"searchType": "semantic"
50+
},
51+
"vectorStoreProviderId": "<Your datasetId from Trieve>"
52+
}
53+
```
54+
55+
## Best Practices
56+
57+
- Ensure your Trieve API key has appropriate permissions
58+
- Keep track of which datasetIds correspond to which knowledge bases
59+
- Monitor vector synchronization to ensure consistency

fern/docs.yml

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -49,9 +49,6 @@ navbar-links:
4949
- type: minimal
5050
text: Status
5151
href: https://status.vapi.ai/
52-
- type: minimal
53-
text: Changelog
54-
href: /changelog
5552
- type: minimal
5653
text: Support
5754
href: /support
@@ -75,6 +72,11 @@ tabs:
7572
display-name: Documentation
7673
icon: book
7774
slug: documentation
75+
changelog:
76+
display-name: Changelog
77+
slug: changelog
78+
changelog: ./changelog
79+
icon: history
7880
layout:
7981
tabs-placement: header
8082
searchbar-placement: header
@@ -116,7 +118,6 @@ navigation:
116118
path: security-and-privacy/hipaa.mdx
117119
- link: SOC-2 Compliance
118120
href: https://security.vapi.ai/
119-
- changelog: ./changelog
120121
- page: Support
121122
path: support.mdx
122123
- link: Status
@@ -177,8 +178,10 @@ navigation:
177178
path: customization/custom-voices/tavus.mdx
178179
- page: Custom Keywords
179180
path: customization/custom-keywords.mdx
180-
- page: Knowledge Base
181-
path: customization/knowledgebase.mdx
181+
- section: Bring your own vectors
182+
contents:
183+
- page: Trieve
184+
path: customization/bring-your-own-vectors/trieve.mdx
182185
- page: Multilingual
183186
path: customization/multilingual.mdx
184187
- page: JWT Authentication
@@ -243,8 +246,8 @@ navigation:
243246
contents:
244247
- page: SIP Introduction
245248
path: advanced/sip/sip.mdx
246-
- page: Telynx Integration
247-
path: advanced/sip/sip-telynx.mdx
249+
- page: Telnyx Integration
250+
path: advanced/sip/sip-telnyx.mdx
248251
- page: Make & GHL Integration
249252
path: GHL.mdx
250253
- page: Tools Calling
@@ -392,10 +395,9 @@ navigation:
392395
href: https://api.vapi.ai/api
393396
- link: OpenAPI
394397
href: https://api.vapi.ai/api-json
398+
- tab: changelog
395399

396400
redirects:
397-
- source: /customization/knowledgebase
398-
destination: /knowledgebase
399401
- source: /developer-documentation
400402
destination: /introduction
401403
- source: /documentation/general/changelog

fern/fern.config.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
{
22
"organization": "vapi",
3-
"version": "0.46.12"
3+
"version": "0.46.16"
44
}
167 KB
Loading

0 commit comments

Comments
 (0)