vapi-server-sdk 0.0.0a7__py3-none-any.whl

vapi/types/cartesia_credential.py

@@ -0,0 +1,46 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import typing
+import typing_extensions
+from ..core.serialization import FieldMetadata
+import pydantic
+import datetime as dt
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class CartesiaCredential(UniversalBaseModel):
+    provider: typing.Literal["cartesia"] = "cartesia"
+    api_key: typing_extensions.Annotated[str, FieldMetadata(alias="apiKey")] = pydantic.Field()
+    """
+    This is not returned in the API.
+    """
+
+    id: str = pydantic.Field()
+    """
+    This is the unique identifier for the credential.
+    """
+
+    org_id: typing_extensions.Annotated[str, FieldMetadata(alias="orgId")] = pydantic.Field()
+    """
+    This is the unique identifier for the org that this credential belongs to.
+    """
+
+    created_at: typing_extensions.Annotated[dt.datetime, FieldMetadata(alias="createdAt")] = pydantic.Field()
+    """
+    This is the ISO 8601 date-time string of when the credential was created.
+    """
+
+    updated_at: typing_extensions.Annotated[dt.datetime, FieldMetadata(alias="updatedAt")] = pydantic.Field()
+    """
+    This is the ISO 8601 date-time string of when the assistant was last updated.
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

vapi/types/cartesia_voice.py

@@ -0,0 +1,58 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import typing_extensions
+import typing
+from ..core.serialization import FieldMetadata
+import pydantic
+from .cartesia_voice_model import CartesiaVoiceModel
+from .cartesia_voice_language import CartesiaVoiceLanguage
+from .chunk_plan import ChunkPlan
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class CartesiaVoice(UniversalBaseModel):
+    filler_injection_enabled: typing_extensions.Annotated[
+        typing.Optional[bool], FieldMetadata(alias="fillerInjectionEnabled")
+    ] = pydantic.Field(default=None)
+    """
+    This determines whether fillers are injected into the model output before inputting it into the voice provider.
+    
+    Default `false` because you can achieve better results with prompting the model.
+    """
+
+    provider: typing.Literal["cartesia"] = pydantic.Field(default="cartesia")
+    """
+    This is the voice provider that will be used.
+    """
+
+    model: typing.Optional[CartesiaVoiceModel] = pydantic.Field(default=None)
+    """
+    This is the model that will be used. This is optional and will default to the correct model for the voiceId.
+    """
+
+    language: typing.Optional[CartesiaVoiceLanguage] = pydantic.Field(default=None)
+    """
+    This is the language that will be used. This is optional and will default to the correct language for the voiceId.
+    """
+
+    voice_id: typing_extensions.Annotated[str, FieldMetadata(alias="voiceId")] = pydantic.Field()
+    """
+    This is the provider-specific ID that will be used.
+    """
+
+    chunk_plan: typing_extensions.Annotated[typing.Optional[ChunkPlan], FieldMetadata(alias="chunkPlan")] = (
+        pydantic.Field(default=None)
+    )
+    """
+    This is the plan for chunking the model output before it is sent to the voice provider.
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

vapi/types/cartesia_voice_language.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+CartesiaVoiceLanguage = typing.Union[typing.Literal["de", "en", "es", "fr", "ja", "pt", "zh"], typing.Any]

vapi/types/cartesia_voice_model.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+CartesiaVoiceModel = typing.Union[typing.Literal["sonic-english", "sonic-multilingual"], typing.Any]

vapi/types/chunk_plan.py

@@ -0,0 +1,70 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import typing
+import pydantic
+import typing_extensions
+from ..core.serialization import FieldMetadata
+from .punctuation_boundary import PunctuationBoundary
+from .format_plan import FormatPlan
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class ChunkPlan(UniversalBaseModel):
+    enabled: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    This determines whether the model output is chunked before being sent to the voice provider. Default `true`.
+    
+    Usage:
+    
+    - To rely on the voice provider's audio generation logic, set this to `false`.
+    - If seeing issues with quality, set this to `true`.
+    
+    If disabled, Vapi-provided audio control tokens like <flush /> will not work.
+    
+    @default true
+    """
+
+    min_characters: typing_extensions.Annotated[typing.Optional[float], FieldMetadata(alias="minCharacters")] = (
+        pydantic.Field(default=None)
+    )
+    """
+    This is the minimum number of characters in a chunk.
+    
+    Usage:
+    
+    - To increase quality, set this to a higher value.
+    - To decrease latency, set this to a lower value.
+    
+    @default 30
+    """
+
+    punctuation_boundaries: typing_extensions.Annotated[
+        typing.Optional[typing.List[PunctuationBoundary]], FieldMetadata(alias="punctuationBoundaries")
+    ] = pydantic.Field(default=None)
+    """
+    These are the punctuations that are considered valid boundaries for a chunk to be created.
+    
+    Usage:
+    
+    - To increase quality, constrain to fewer boundaries.
+    - To decrease latency, enable all.
+    
+    Default is automatically set to balance the trade-off between quality and latency based on the provider.
+    """
+
+    format_plan: typing_extensions.Annotated[typing.Optional[FormatPlan], FieldMetadata(alias="formatPlan")] = (
+        pydantic.Field(default=None)
+    )
+    """
+    This is the plan for formatting the chunk before it is sent to the voice provider.
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

vapi/types/client_inbound_message.py

@@ -0,0 +1,23 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+from .client_inbound_message_message import ClientInboundMessageMessage
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+import typing
+
+
+class ClientInboundMessage(UniversalBaseModel):
+    message: ClientInboundMessageMessage = pydantic.Field()
+    """
+    These are the messages that can be sent from client-side SDKs to control the call.
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

vapi/types/client_inbound_message_add_message.py

@@ -0,0 +1,28 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import typing
+import pydantic
+from .open_ai_message import OpenAiMessage
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class ClientInboundMessageAddMessage(UniversalBaseModel):
+    type: typing.Literal["add-message"] = pydantic.Field(default="add-message")
+    """
+    This is the type of the message. Send "add-message" message to add a message to the conversation history.
+    """
+
+    message: OpenAiMessage = pydantic.Field()
+    """
+    This is the message to add to the conversation.
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

vapi/types/client_inbound_message_control.py

@@ -0,0 +1,32 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import typing
+import pydantic
+from .client_inbound_message_control_control import ClientInboundMessageControlControl
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class ClientInboundMessageControl(UniversalBaseModel):
+    type: typing.Literal["control"] = pydantic.Field(default="control")
+    """
+    This is the type of the message. Send "control" message to control the assistant. `control` options are:
+    
+    - "mute-assistant" - mute the assistant
+    - "unmute-assistant" - unmute the assistant
+    - "say-first-message" - say the first message (this is used when video recording is enabled and the conversation is only started once the client side kicks off the recording)
+    """
+
+    control: ClientInboundMessageControlControl = pydantic.Field()
+    """
+    This is the control action
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

vapi/types/client_inbound_message_control_control.py

@@ -0,0 +1,7 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+ClientInboundMessageControlControl = typing.Union[
+    typing.Literal["mute-assistant", "unmute-assistant", "say-first-message"], typing.Any
+]

vapi/types/client_inbound_message_message.py

@@ -0,0 +1,10 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+from .client_inbound_message_add_message import ClientInboundMessageAddMessage
+from .client_inbound_message_control import ClientInboundMessageControl
+from .client_inbound_message_say import ClientInboundMessageSay
+
+ClientInboundMessageMessage = typing.Union[
+    ClientInboundMessageAddMessage, ClientInboundMessageControl, ClientInboundMessageSay
+]

vapi/types/client_inbound_message_say.py

@@ -0,0 +1,36 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import typing
+import pydantic
+import typing_extensions
+from ..core.serialization import FieldMetadata
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class ClientInboundMessageSay(UniversalBaseModel):
+    type: typing.Optional[typing.Literal["say"]] = pydantic.Field(default=None)
+    """
+    This is the type of the message. Send "say" message to make the assistant say something.
+    """
+
+    content: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    This is the content to say.
+    """
+
+    end_call_after_spoken: typing_extensions.Annotated[
+        typing.Optional[bool], FieldMetadata(alias="endCallAfterSpoken")
+    ] = pydantic.Field(default=None)
+    """
+    This is the flag to end call after content is spoken.
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

vapi/types/client_message.py

@@ -0,0 +1,23 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+from .client_message_message import ClientMessageMessage
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+import typing
+
+
+class ClientMessage(UniversalBaseModel):
+    message: ClientMessageMessage = pydantic.Field()
+    """
+    These are all the messages that can be sent to the client-side SDKs during the call. Configure the messages you'd like to receive in `assistant.clientMessages`.
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

vapi/types/client_message_conversation_update.py

@@ -0,0 +1,38 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import typing
+import pydantic
+from .client_message_conversation_update_messages_item import ClientMessageConversationUpdateMessagesItem
+import typing_extensions
+from .open_ai_message import OpenAiMessage
+from ..core.serialization import FieldMetadata
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class ClientMessageConversationUpdate(UniversalBaseModel):
+    type: typing.Literal["conversation-update"] = pydantic.Field(default="conversation-update")
+    """
+    This is the type of the message. "conversation-update" is sent when an update is committed to the conversation history.
+    """
+
+    messages: typing.Optional[typing.List[ClientMessageConversationUpdateMessagesItem]] = pydantic.Field(default=None)
+    """
+    This is the most up-to-date conversation history at the time the message is sent.
+    """
+
+    messages_open_ai_formatted: typing_extensions.Annotated[
+        typing.List[OpenAiMessage], FieldMetadata(alias="messagesOpenAIFormatted")
+    ] = pydantic.Field()
+    """
+    This is the most up-to-date conversation history at the time the message is sent, formatted for OpenAI.
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

vapi/types/client_message_conversation_update_messages_item.py

@@ -0,0 +1,12 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+from .user_message import UserMessage
+from .system_message import SystemMessage
+from .bot_message import BotMessage
+from .tool_call_message import ToolCallMessage
+from .tool_call_result_message import ToolCallResultMessage
+
+ClientMessageConversationUpdateMessagesItem = typing.Union[
+    UserMessage, SystemMessage, BotMessage, ToolCallMessage, ToolCallResultMessage
+]

vapi/types/client_message_hang.py

@@ -0,0 +1,27 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import typing
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class ClientMessageHang(UniversalBaseModel):
+    type: typing.Literal["hang"] = pydantic.Field(default="hang")
+    """
+    This is the type of the message. "hang" is sent when the assistant is hanging due to a delay. The delay can be caused by many factors, such as:
+    
+    - the model is too slow to respond
+    - the voice is too slow to respond
+    - the tool call is still waiting for a response from your server
+    - etc.
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

vapi/types/client_message_language_changed.py

@@ -0,0 +1,27 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import typing
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class ClientMessageLanguageChanged(UniversalBaseModel):
+    type: typing.Literal["language-changed"] = pydantic.Field(default="language-changed")
+    """
+    This is the type of the message. "language-switched" is sent when the transcriber is automatically switched based on the detected language.
+    """
+
+    language: str = pydantic.Field()
+    """
+    This is the language the transcriber is switched to.
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

vapi/types/client_message_message.py

@@ -0,0 +1,28 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+from .client_message_conversation_update import ClientMessageConversationUpdate
+from .client_message_hang import ClientMessageHang
+from .client_message_metadata import ClientMessageMetadata
+from .client_message_model_output import ClientMessageModelOutput
+from .client_message_speech_update import ClientMessageSpeechUpdate
+from .client_message_transcript import ClientMessageTranscript
+from .client_message_tool_calls import ClientMessageToolCalls
+from .client_message_tool_calls_result import ClientMessageToolCallsResult
+from .client_message_user_interrupted import ClientMessageUserInterrupted
+from .client_message_language_changed import ClientMessageLanguageChanged
+from .client_message_voice_input import ClientMessageVoiceInput
+
+ClientMessageMessage = typing.Union[
+    ClientMessageConversationUpdate,
+    ClientMessageHang,
+    ClientMessageMetadata,
+    ClientMessageModelOutput,
+    ClientMessageSpeechUpdate,
+    ClientMessageTranscript,
+    ClientMessageToolCalls,
+    ClientMessageToolCallsResult,
+    ClientMessageUserInterrupted,
+    ClientMessageLanguageChanged,
+    ClientMessageVoiceInput,
+]

vapi/types/client_message_metadata.py

@@ -0,0 +1,27 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import typing
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class ClientMessageMetadata(UniversalBaseModel):
+    type: typing.Literal["metadata"] = pydantic.Field(default="metadata")
+    """
+    This is the type of the message. "metadata" is sent to forward metadata to the client.
+    """
+
+    metadata: str = pydantic.Field()
+    """
+    This is the metadata content
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

vapi/types/client_message_model_output.py

@@ -0,0 +1,27 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import typing
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class ClientMessageModelOutput(UniversalBaseModel):
+    type: typing.Literal["model-output"] = pydantic.Field(default="model-output")
+    """
+    This is the type of the message. "model-output" is sent as the model outputs tokens.
+    """
+
+    output: typing.Dict[str, typing.Optional[typing.Any]] = pydantic.Field()
+    """
+    This is the output of the model. It can be a token or tool call.
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

vapi/types/client_message_speech_update.py

@@ -0,0 +1,34 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import typing
+import pydantic
+from .client_message_speech_update_status import ClientMessageSpeechUpdateStatus
+from .client_message_speech_update_role import ClientMessageSpeechUpdateRole
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class ClientMessageSpeechUpdate(UniversalBaseModel):
+    type: typing.Literal["speech-update"] = pydantic.Field(default="speech-update")
+    """
+    This is the type of the message. "speech-update" is sent whenever assistant or user start or stop speaking.
+    """
+
+    status: ClientMessageSpeechUpdateStatus = pydantic.Field()
+    """
+    This is the status of the speech update.
+    """
+
+    role: ClientMessageSpeechUpdateRole = pydantic.Field()
+    """
+    This is the role which the speech update is for.
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

vapi/types/client_message_speech_update_role.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+ClientMessageSpeechUpdateRole = typing.Union[typing.Literal["assistant", "user"], typing.Any]

vapi/types/client_message_speech_update_status.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+ClientMessageSpeechUpdateStatus = typing.Union[typing.Literal["started", "stopped"], typing.Any]

vapi/types/client_message_tool_calls.py

@@ -0,0 +1,40 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import typing
+import pydantic
+import typing_extensions
+from .client_message_tool_calls_tool_with_tool_call_list_item import ClientMessageToolCallsToolWithToolCallListItem
+from ..core.serialization import FieldMetadata
+from .tool_call import ToolCall
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class ClientMessageToolCalls(UniversalBaseModel):
+    type: typing.Optional[typing.Literal["tool-calls"]] = pydantic.Field(default=None)
+    """
+    This is the type of the message. "tool-calls" is sent to call a tool.
+    """
+
+    tool_with_tool_call_list: typing_extensions.Annotated[
+        typing.List[ClientMessageToolCallsToolWithToolCallListItem], FieldMetadata(alias="toolWithToolCallList")
+    ] = pydantic.Field()
+    """
+    This is the list of tools calls that the model is requesting along with the original tool configuration.
+    """
+
+    tool_call_list: typing_extensions.Annotated[typing.List[ToolCall], FieldMetadata(alias="toolCallList")] = (
+        pydantic.Field()
+    )
+    """
+    This is the list of tool calls that the model is requesting.
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow