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

vapi/types/together_ai_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 TogetherAiCredential(UniversalBaseModel):
+    provider: typing.Literal["together-ai"] = "together-ai"
+    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/together_ai_model.py

@@ -0,0 +1,90 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import typing
+from .open_ai_message import OpenAiMessage
+import pydantic
+from .together_ai_model_tools_item import TogetherAiModelToolsItem
+import typing_extensions
+from ..core.serialization import FieldMetadata
+from .knowledge_base import KnowledgeBase
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class TogetherAiModel(UniversalBaseModel):
+    messages: typing.Optional[typing.List[OpenAiMessage]] = pydantic.Field(default=None)
+    """
+    This is the starting state for the conversation.
+    """
+
+    tools: typing.Optional[typing.List[TogetherAiModelToolsItem]] = pydantic.Field(default=None)
+    """
+    These are the tools that the assistant can use during the call. To use existing tools, use `toolIds`.
+    
+    Both `tools` and `toolIds` can be used together.
+    """
+
+    tool_ids: typing_extensions.Annotated[typing.Optional[typing.List[str]], FieldMetadata(alias="toolIds")] = (
+        pydantic.Field(default=None)
+    )
+    """
+    These are the tools that the assistant can use during the call. To use transient tools, use `tools`.
+    
+    Both `tools` and `toolIds` can be used together.
+    """
+
+    provider: typing.Literal["together-ai"] = "together-ai"
+    model: str = pydantic.Field()
+    """
+    This is the name of the model. Ex. cognitivecomputations/dolphin-mixtral-8x7b
+    """
+
+    temperature: typing.Optional[float] = pydantic.Field(default=None)
+    """
+    This is the temperature that will be used for calls. Default is 0 to leverage caching for lower latency.
+    """
+
+    knowledge_base: typing_extensions.Annotated[
+        typing.Optional[KnowledgeBase], FieldMetadata(alias="knowledgeBase")
+    ] = pydantic.Field(default=None)
+    """
+    These are the options for the knowledge base.
+    """
+
+    max_tokens: typing_extensions.Annotated[typing.Optional[float], FieldMetadata(alias="maxTokens")] = pydantic.Field(
+        default=None
+    )
+    """
+    This is the max number of tokens that the assistant will be allowed to generate in each turn of the conversation. Default is 250.
+    """
+
+    emotion_recognition_enabled: typing_extensions.Annotated[
+        typing.Optional[bool], FieldMetadata(alias="emotionRecognitionEnabled")
+    ] = pydantic.Field(default=None)
+    """
+    This determines whether we detect user's emotion while they speak and send it as an additional info to model.
+    
+    Default `false` because the model is usually are good at understanding the user's emotion from text.
+    
+    @default false
+    """
+
+    num_fast_turns: typing_extensions.Annotated[typing.Optional[float], FieldMetadata(alias="numFastTurns")] = (
+        pydantic.Field(default=None)
+    )
+    """
+    This sets how many turns at the start of the conversation to use a smaller, faster model from the same provider before switching to the primary model. Example, gpt-3.5-turbo if provider is openai.
+    
+    Default is 0.
+    
+    @default 0
+    """
+
+    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/together_ai_model_tools_item.py

@@ -0,0 +1,20 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+from .create_dtmf_tool_dto import CreateDtmfToolDto
+from .create_end_call_tool_dto import CreateEndCallToolDto
+from .create_voicemail_tool_dto import CreateVoicemailToolDto
+from .create_function_tool_dto import CreateFunctionToolDto
+from .create_ghl_tool_dto import CreateGhlToolDto
+from .create_make_tool_dto import CreateMakeToolDto
+from .create_transfer_call_tool_dto import CreateTransferCallToolDto
+
+TogetherAiModelToolsItem = typing.Union[
+    CreateDtmfToolDto,
+    CreateEndCallToolDto,
+    CreateVoicemailToolDto,
+    CreateFunctionToolDto,
+    CreateGhlToolDto,
+    CreateMakeToolDto,
+    CreateTransferCallToolDto,
+]

vapi/types/token.py

@@ -0,0 +1,62 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import typing
+from .token_tag import TokenTag
+import pydantic
+import typing_extensions
+from ..core.serialization import FieldMetadata
+import datetime as dt
+from .token_restrictions import TokenRestrictions
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class Token(UniversalBaseModel):
+    tag: typing.Optional[TokenTag] = pydantic.Field(default=None)
+    """
+    This is the tag for the token. It represents its scope.
+    """
+
+    id: str = pydantic.Field()
+    """
+    This is the unique identifier for the token.
+    """
+
+    org_id: typing_extensions.Annotated[str, FieldMetadata(alias="orgId")] = pydantic.Field()
+    """
+    This is unique identifier for the org that this token 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 token 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 token was last updated.
+    """
+
+    value: str = pydantic.Field()
+    """
+    This is the token key.
+    """
+
+    name: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    This is the name of the token. This is just for your own reference.
+    """
+
+    restrictions: typing.Optional[TokenRestrictions] = pydantic.Field(default=None)
+    """
+    This are the restrictions for the token.
+    """
+
+    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/token_restrictions.py

@@ -0,0 +1,53 @@
+# 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 TokenRestrictions(UniversalBaseModel):
+    enabled: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    This determines whether the token is enabled or disabled. Default is true, it's enabled.
+    """
+
+    allowed_origins: typing_extensions.Annotated[
+        typing.Optional[typing.List[str]], FieldMetadata(alias="allowedOrigins")
+    ] = pydantic.Field(default=None)
+    """
+    This determines the allowed origins for this token. Validates the `Origin` header. Default is any origin.
+    
+    Only relevant for `public` tokens.
+    """
+
+    allowed_assistant_ids: typing_extensions.Annotated[
+        typing.Optional[typing.List[str]], FieldMetadata(alias="allowedAssistantIds")
+    ] = pydantic.Field(default=None)
+    """
+    This determines which assistantIds can be used when creating a call. Default is any assistantId.
+    
+    Only relevant for `public` tokens.
+    """
+
+    allow_transient_assistant: typing_extensions.Annotated[
+        typing.Optional[bool], FieldMetadata(alias="allowTransientAssistant")
+    ] = pydantic.Field(default=None)
+    """
+    This determines whether transient assistants can be used when creating a call. Default is true.
+    
+    If `allowedAssistantIds` is provided, this is automatically false.
+    
+    Only relevant for `public` tokens.
+    """
+
+    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/token_tag.py

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

vapi/types/tool_call.py

@@ -0,0 +1,33 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import typing
+import pydantic
+from .tool_call_function import ToolCallFunction
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class ToolCall(UniversalBaseModel):
+    type: typing.Literal["function"] = pydantic.Field(default="function")
+    """
+    This is the type of tool the model called.
+    """
+
+    function: ToolCallFunction = pydantic.Field()
+    """
+    This is the function the model called.
+    """
+
+    id: str = pydantic.Field()
+    """
+    This is the unique identifier for the 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/tool_call_block.py

@@ -0,0 +1,96 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import typing
+from .tool_call_block_messages_item import ToolCallBlockMessagesItem
+import pydantic
+import typing_extensions
+from .json_schema import JsonSchema
+from ..core.serialization import FieldMetadata
+from .tool_call_block_tool import ToolCallBlockTool
+import datetime as dt
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class ToolCallBlock(UniversalBaseModel):
+    messages: typing.Optional[typing.List[ToolCallBlockMessagesItem]] = pydantic.Field(default=None)
+    """
+    These are the pre-configured messages that will be spoken to the user while the block is running.
+    """
+
+    input_schema: typing_extensions.Annotated[typing.Optional[JsonSchema], FieldMetadata(alias="inputSchema")] = (
+        pydantic.Field(default=None)
+    )
+    """
+    This is the input schema for the block. This is the input the block needs to run. It's given to the block as `steps[0].input`
+    
+    These are accessible as variables:
+    
+    - ({{input.propertyName}}) in context of the block execution (step)
+    - ({{stepName.input.propertyName}}) in context of the workflow
+    """
+
+    output_schema: typing_extensions.Annotated[typing.Optional[JsonSchema], FieldMetadata(alias="outputSchema")] = (
+        pydantic.Field(default=None)
+    )
+    """
+    This is the output schema for the block. This is the output the block will return to the workflow (`{{stepName.output}}`).
+    
+    These are accessible as variables:
+    
+    - ({{output.propertyName}}) in context of the block execution (step)
+    - ({{stepName.output.propertyName}}) in context of the workflow (read caveat #1)
+    - ({{blockName.output.propertyName}}) in context of the workflow (read caveat #2)
+    
+    Caveats:
+    
+    1. a workflow can execute a step multiple times. example, if a loop is used in the graph. {{stepName.output.propertyName}} will reference the latest usage of the step.
+    2. a workflow can execute a block multiple times. example, if a step is called multiple times or if a block is used in multiple steps. {{blockName.output.propertyName}} will reference the latest usage of the block. this liquid variable is just provided for convenience when creating blocks outside of a workflow with steps.
+    """
+
+    type: typing.Literal["tool-call"] = "tool-call"
+    tool: typing.Optional[ToolCallBlockTool] = pydantic.Field(default=None)
+    """
+    This is the tool that the block will call. To use an existing tool, use `toolId`.
+    """
+
+    id: str = pydantic.Field()
+    """
+    This is the unique identifier for the block.
+    """
+
+    org_id: typing_extensions.Annotated[str, FieldMetadata(alias="orgId")] = pydantic.Field()
+    """
+    This is the unique identifier for the organization that this block 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 block 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 block was last updated.
+    """
+
+    name: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    This is the name of the block. This is just for your reference.
+    """
+
+    tool_id: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="toolId")] = pydantic.Field(
+        default=None
+    )
+    """
+    This is the id of the tool that the block will call. To use a transient tool, use `tool`.
+    """
+
+    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/tool_call_block_messages_item.py

@@ -0,0 +1,7 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+from .block_start_message import BlockStartMessage
+from .block_complete_message import BlockCompleteMessage
+
+ToolCallBlockMessagesItem = typing.Union[BlockStartMessage, BlockCompleteMessage]

vapi/types/tool_call_block_tool.py

@@ -0,0 +1,20 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+from .create_dtmf_tool_dto import CreateDtmfToolDto
+from .create_end_call_tool_dto import CreateEndCallToolDto
+from .create_voicemail_tool_dto import CreateVoicemailToolDto
+from .create_function_tool_dto import CreateFunctionToolDto
+from .create_ghl_tool_dto import CreateGhlToolDto
+from .create_make_tool_dto import CreateMakeToolDto
+from .create_transfer_call_tool_dto import CreateTransferCallToolDto
+
+ToolCallBlockTool = typing.Union[
+    CreateDtmfToolDto,
+    CreateEndCallToolDto,
+    CreateVoicemailToolDto,
+    CreateFunctionToolDto,
+    CreateGhlToolDto,
+    CreateMakeToolDto,
+    CreateTransferCallToolDto,
+]

vapi/types/tool_call_function.py

@@ -0,0 +1,27 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import pydantic
+import typing
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class ToolCallFunction(UniversalBaseModel):
+    name: str = pydantic.Field()
+    """
+    This is the name of the function the model called.
+    """
+
+    arguments: typing.Dict[str, typing.Optional[typing.Any]] = pydantic.Field()
+    """
+    These are the arguments that the function was called with.
+    """
+
+    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/tool_call_message.py

@@ -0,0 +1,46 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import pydantic
+import typing_extensions
+import typing
+from ..core.serialization import FieldMetadata
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class ToolCallMessage(UniversalBaseModel):
+    role: str = pydantic.Field()
+    """
+    The role of the tool call in the conversation.
+    """
+
+    tool_calls: typing_extensions.Annotated[
+        typing.List[typing.Dict[str, typing.Optional[typing.Any]]], FieldMetadata(alias="toolCalls")
+    ] = pydantic.Field()
+    """
+    The list of tool calls made during the conversation.
+    """
+
+    message: str = pydantic.Field()
+    """
+    The message content for the tool call.
+    """
+
+    time: float = pydantic.Field()
+    """
+    The timestamp when the message was sent.
+    """
+
+    seconds_from_start: typing_extensions.Annotated[float, FieldMetadata(alias="secondsFromStart")] = pydantic.Field()
+    """
+    The number of seconds from the start of 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/tool_call_result.py

@@ -0,0 +1,62 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import typing
+from .tool_call_result_message_item import ToolCallResultMessageItem
+import pydantic
+import typing_extensions
+from ..core.serialization import FieldMetadata
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class ToolCallResult(UniversalBaseModel):
+    message: typing.Optional[typing.List[ToolCallResultMessageItem]] = pydantic.Field(default=None)
+    """
+    This is the message that will be spoken to the user.
+    
+    If this is not returned, assistant will speak:
+    
+    1. a `request-complete` or `request-failed` message from `tool.messages`, if it exists
+    2. a response generated by the model, if not
+    """
+
+    name: str = pydantic.Field()
+    """
+    This is the name of the function the model called.
+    """
+
+    tool_call_id: typing_extensions.Annotated[str, FieldMetadata(alias="toolCallId")] = pydantic.Field()
+    """
+    This is the unique identifier for the tool call.
+    """
+
+    result: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    This is the result if the tool call was successful. This is added to the conversation history.
+    
+    Further, if this is returned, assistant will speak:
+    
+    1. the `message`, if it exists and is of type `request-complete`
+    2. a `request-complete` message from `tool.messages`, if it exists
+    3. a response generated by the model, if neither exist
+    """
+
+    error: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    This is the error if the tool call was not successful. This is added to the conversation history.
+    
+    Further, if this is returned, assistant will speak:
+    
+    1. the `message`, if it exists and is of type `request-failed`
+    2. a `request-failed` message from `tool.messages`, if it exists
+    3. a response generated by the model, if neither exist
+    """
+
+    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/tool_call_result_message.py

@@ -0,0 +1,49 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import pydantic
+import typing_extensions
+from ..core.serialization import FieldMetadata
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+import typing
+
+
+class ToolCallResultMessage(UniversalBaseModel):
+    role: str = pydantic.Field()
+    """
+    The role of the tool call result in the conversation.
+    """
+
+    tool_call_id: typing_extensions.Annotated[str, FieldMetadata(alias="toolCallId")] = pydantic.Field()
+    """
+    The ID of the tool call.
+    """
+
+    name: str = pydantic.Field()
+    """
+    The name of the tool that returned the result.
+    """
+
+    result: str = pydantic.Field()
+    """
+    The result of the tool call in JSON format.
+    """
+
+    time: float = pydantic.Field()
+    """
+    The timestamp when the message was sent.
+    """
+
+    seconds_from_start: typing_extensions.Annotated[float, FieldMetadata(alias="secondsFromStart")] = pydantic.Field()
+    """
+    The number of seconds from the start of 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/tool_call_result_message_item.py

@@ -0,0 +1,7 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+from .tool_message_complete import ToolMessageComplete
+from .tool_message_failed import ToolMessageFailed
+
+ToolCallResultMessageItem = typing.Union[ToolMessageComplete, ToolMessageFailed]