Skip to content

Commit

Permalink
Merge remote-tracking branch 'origin/main' into fern/update-api-specs
Browse files Browse the repository at this point in the history
  • Loading branch information
fern-api[bot] committed Dec 9, 2024
2 parents e13f1c0 + 3c22533 commit ab1adab
Show file tree
Hide file tree
Showing 9 changed files with 92 additions and 5 deletions.
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
**/.preview/**
**/.definition
**/.preview/**
4 changes: 3 additions & 1 deletion fern/apis/api/generators.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ groups:
generators:
- name: fernapi/fern-python-sdk
version: 4.3.8
disable-examples: true
api:
settings:
unions: v1
Expand All @@ -25,7 +26,8 @@ groups:
ts-sdk:
generators:
- name: fernapi/fern-typescript-node-sdk
version: 0.40.5
version: 0.42.7
disable-examples: true
api:
settings:
unions: v1
Expand Down
52 changes: 52 additions & 0 deletions fern/apis/api/openapi-overrides.yml
Original file line number Diff line number Diff line change
Expand Up @@ -183,6 +183,8 @@ paths:
x-fern-sdk-group-name:
- analytics
x-fern-sdk-method-name: get
get:
x-fern-ignore: true
/logs:
get:
x-fern-pagination: true
Expand All @@ -191,6 +193,56 @@ paths:
x-fern-sdk-method-name: get
components:
schemas:
FallbackAzureVoice:
properties:
voiceId:
x-fern-type-name: FallbackAzureVoiceId
oneOf:
- x-fern-type-name: FallbackAzureVoiceIdEnum
FallbackDeepgramVoice:
properties:
voiceId:
x-fern-type-name: FallbackDeepgramVoiceId
oneOf:
- x-fern-type-name: FallbackDeepgramVoiceIdEnum
FallbackElevenLabsVoice:
properties:
voiceId:
x-fern-type-name: FallbackElevenLabsVoiceId
oneOf:
- x-fern-type-name: FallbackElevenLabsVoiceIdEnum
provider:
x-fern-type: literal<"11labs">
FallbackOpenAIVoice:
properties:
voiceId:
x-fern-type-name: FallbackOpenAIVoiceId
oneOf:
- x-fern-type-name: FallbackOpenAIVoiceIdEnum
FallbackRimeAIVoice:
properties:
voiceId:
x-fern-type-name: FallbackRimeAIVoiceId
oneOf:
- x-fern-type-name: FallbackRimeAIVoiceIdEnum
FallbackPlayHTVoice:
properties:
voiceId:
x-fern-type-name: FallbackPlayHTVoiceId
oneOf:
- x-fern-type-name: FallbackPlayHTVoiceIdEnum
FallbackLMNTVoice:
properties:
voiceId:
x-fern-type-name: FallbackLMNTVoiceId
oneOf:
- x-fern-type-name: FallbackLMNTVoiceIdEnum
FallbackNeetsVoice:
properties:
voiceId:
x-fern-type-name: FallbackNeetsVoiceId
oneOf:
- x-fern-type-name: FallbackNeetsVoiceIdEnum
AzureVoice:
properties:
voiceId:
Expand Down
10 changes: 9 additions & 1 deletion changelog/2024-12-05.mdx → fern/changelog/2024-12-05.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
1. **OAuth2 Support for Custom LLM Credentials and Webhooks**: You can now secure access to your [custom LLMs](https://docs.vapi.ai/customization/custom-llm/using-your-server#step-2-configuring-vapi-with-custom-llm) and [server urls (aka webhooks)](https://docs.vapi.ai/server-url) using OAuth2 (RFC 6749). Create a webhook credential with `CreateWebhookCredentialDTO` and specify the following information.
1. **OAuth2 Support for Custom LLM Credentials and Webhooks**: You can now authorize access to your [custom LLMs](https://docs.vapi.ai/customization/custom-llm/using-your-server#step-2-configuring-vapi-with-custom-llm) and [server urls (aka webhooks)](https://docs.vapi.ai/server-url) using OAuth2 (RFC 6749).

For example, create a webhook credential with `CreateWebhookCredentialDTO` with the following payload:

```json
{
Expand All @@ -13,4 +15,10 @@
}
```

This returns a [`WebhookCredential`](https://api.vapi.ai/api) object as follows:

<Frame caption="Refer to the `WebhookCredential` schema for more information">
<img src="../static/images/changelog/webhook-credential.png" />
</Frame>

3. **Removal of Canonical Knowledge Base**: The ability to create, update, and use canoncial knowledge bases in your assistant has been removed from the API(as custom knowledge bases and the Trieve integration supports as superset of this functionality). Please update your implementations as endpoints and models referencing canoncial knowledge base schemas are no longer available.
24 changes: 24 additions & 0 deletions fern/changelog/2024-12-06.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
1. **OAuth 2 Authentication for Custom LLM Models and Webhooks**: In addition to (AuthZ)[https://www.okta.com/identity-101/authentication-vs-authorization/], you can now now authenticate users accessing your [custom LLMs](https://docs.vapi.ai/customization/custom-llm/using-your-server#step-2-configuring-vapi-with-custom-llm) and [server urls (aka webhooks)](https://docs.vapi.ai/server-url) using OAuth2 (RFC 6749). Use the `authenticationSession` dictionary which contains an `accessToken` and `expiresAt` datetime to authenticate further requests to your custom LLM or server URL.

For example, create a webhook credential with `CreateCustomLLMCredentialDTO` with the following payload:
```json
{
"provider": "custom-llm",
"apiKey": "your-api-key-max-10000-characters",
"authenticationPlan": {
"type": "oauth2",
"url": "https://your-url.com/your/path/token",
"clientId": "your-client-id",
"clientSecret": "your-client-secret"
},
"name": "your-credential-name-between-1-and-40-characters"
}
```

This returns a [`CustomLLMCredential`](https://api.vapi.ai/api) object as follows:

<Frame caption="Refer to the `CustomLLMCredential` schema for more information">
<img src="../static/images/changelog/custom-llm-credential.png" />
</Frame>

This can be used to authenticate successive requests to your custom LLM or server URL.
2 changes: 1 addition & 1 deletion fern/customization/custom-voices/tavus.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ slug: customization/custom-voices/tavus

This guide outlines the procedure for integrating your custom replica with Tavus through the VAPI platform.

<Note>An API subscription is required for this process to work.</Note>
<Note>An API subscription is required for this process to work. This process is only required if you would like to use your **custom Tavus replicas**. This process is not required to use stock replicas on the Vapi platform.</Note>

To integrate your custom replica with [Tavus](https://platform.tavus.io/) using the VAPI platform, follow these steps.

Expand Down
2 changes: 1 addition & 1 deletion fern/fern.config.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"organization": "vapi",
"version": "0.45.1"
"version": "0.45.3"
}
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.

0 comments on commit ab1adab

Please sign in to comment.