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

vapi/types/add_voice_to_provider_dto.py

@@ -0,0 +1,34 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import typing_extensions
+from ..core.serialization import FieldMetadata
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+import typing
+
+
+class AddVoiceToProviderDto(UniversalBaseModel):
+    owner_id: typing_extensions.Annotated[str, FieldMetadata(alias="ownerId")] = pydantic.Field()
+    """
+    This is the owner_id of your shared voice which you want to add to your provider Account from Provider Voice Library
+    """
+
+    voice_id: typing_extensions.Annotated[str, FieldMetadata(alias="voiceId")] = pydantic.Field()
+    """
+    This is the voice_id of the shared voice which you want to add to your provider Account from Provider Voice Library
+    """
+
+    name: str = pydantic.Field()
+    """
+    This is the new name of the voice which you want to have once you have added voice to your provider Account from Provider Voice Library
+    """
+
+    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/analysis.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
+import typing_extensions
+from ..core.serialization import FieldMetadata
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class Analysis(UniversalBaseModel):
+    summary: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    This is the summary of the call. Customize by setting `assistant.analysisPlan.summaryPrompt`.
+    """
+
+    structured_data: typing_extensions.Annotated[
+        typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]], FieldMetadata(alias="structuredData")
+    ] = pydantic.Field(default=None)
+    """
+    This is the structured data extracted from the call. Customize by setting `assistant.analysisPlan.structuredDataPrompt` and/or `assistant.analysisPlan.structuredDataSchema`.
+    """
+
+    success_evaluation: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="successEvaluation")] = (
+        pydantic.Field(default=None)
+    )
+    """
+    This is the evaluation of the call. Customize by setting `assistant.analysisPlan.successEvaluationPrompt` and/or `assistant.analysisPlan.successEvaluationRubric`.
+    """
+
+    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/analysis_cost.py

@@ -0,0 +1,52 @@
+# 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 .analysis_cost_analysis_type import AnalysisCostAnalysisType
+from ..core.serialization import FieldMetadata
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class AnalysisCost(UniversalBaseModel):
+    type: typing.Literal["analysis"] = pydantic.Field(default="analysis")
+    """
+    This is the type of cost, always 'analysis' for this class.
+    """
+
+    analysis_type: typing_extensions.Annotated[AnalysisCostAnalysisType, FieldMetadata(alias="analysisType")] = (
+        pydantic.Field()
+    )
+    """
+    This is the type of analysis performed.
+    """
+
+    model: typing.Dict[str, typing.Optional[typing.Any]] = pydantic.Field()
+    """
+    This is the model that was used to perform the analysis.
+    """
+
+    prompt_tokens: typing_extensions.Annotated[float, FieldMetadata(alias="promptTokens")] = pydantic.Field()
+    """
+    This is the number of prompt tokens used in the analysis.
+    """
+
+    completion_tokens: typing_extensions.Annotated[float, FieldMetadata(alias="completionTokens")] = pydantic.Field()
+    """
+    This is the number of completion tokens generated in the analysis.
+    """
+
+    cost: float = pydantic.Field()
+    """
+    This is the cost of the component in USD.
+    """
+
+    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/analysis_cost_analysis_type.py

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

vapi/types/analysis_cost_breakdown.py

@@ -0,0 +1,80 @@
+# 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 AnalysisCostBreakdown(UniversalBaseModel):
+    summary: typing.Optional[float] = pydantic.Field(default=None)
+    """
+    This is the cost to summarize the call.
+    """
+
+    summary_prompt_tokens: typing_extensions.Annotated[
+        typing.Optional[float], FieldMetadata(alias="summaryPromptTokens")
+    ] = pydantic.Field(default=None)
+    """
+    This is the number of prompt tokens used to summarize the call.
+    """
+
+    summary_completion_tokens: typing_extensions.Annotated[
+        typing.Optional[float], FieldMetadata(alias="summaryCompletionTokens")
+    ] = pydantic.Field(default=None)
+    """
+    This is the number of completion tokens used to summarize the call.
+    """
+
+    structured_data: typing_extensions.Annotated[typing.Optional[float], FieldMetadata(alias="structuredData")] = (
+        pydantic.Field(default=None)
+    )
+    """
+    This is the cost to extract structured data from the call.
+    """
+
+    structured_data_prompt_tokens: typing_extensions.Annotated[
+        typing.Optional[float], FieldMetadata(alias="structuredDataPromptTokens")
+    ] = pydantic.Field(default=None)
+    """
+    This is the number of prompt tokens used to extract structured data from the call.
+    """
+
+    structured_data_completion_tokens: typing_extensions.Annotated[
+        typing.Optional[float], FieldMetadata(alias="structuredDataCompletionTokens")
+    ] = pydantic.Field(default=None)
+    """
+    This is the number of completion tokens used to extract structured data from the call.
+    """
+
+    success_evaluation: typing_extensions.Annotated[
+        typing.Optional[float], FieldMetadata(alias="successEvaluation")
+    ] = pydantic.Field(default=None)
+    """
+    This is the cost to evaluate if the call was successful.
+    """
+
+    success_evaluation_prompt_tokens: typing_extensions.Annotated[
+        typing.Optional[float], FieldMetadata(alias="successEvaluationPromptTokens")
+    ] = pydantic.Field(default=None)
+    """
+    This is the number of prompt tokens used to evaluate if the call was successful.
+    """
+
+    success_evaluation_completion_tokens: typing_extensions.Annotated[
+        typing.Optional[float], FieldMetadata(alias="successEvaluationCompletionTokens")
+    ] = pydantic.Field(default=None)
+    """
+    This is the number of completion tokens used to evaluate if the call was successful.
+    """
+
+    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/analysis_plan.py

@@ -0,0 +1,43 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import typing_extensions
+import typing
+from .summary_plan import SummaryPlan
+from ..core.serialization import FieldMetadata
+import pydantic
+from .structured_data_plan import StructuredDataPlan
+from .success_evaluation_plan import SuccessEvaluationPlan
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class AnalysisPlan(UniversalBaseModel):
+    summary_plan: typing_extensions.Annotated[typing.Optional[SummaryPlan], FieldMetadata(alias="summaryPlan")] = (
+        pydantic.Field(default=None)
+    )
+    """
+    This is the plan for generating the summary of the call. This outputs to `call.analysis.summary`.
+    """
+
+    structured_data_plan: typing_extensions.Annotated[
+        typing.Optional[StructuredDataPlan], FieldMetadata(alias="structuredDataPlan")
+    ] = pydantic.Field(default=None)
+    """
+    This is the plan for generating the structured data from the call. This outputs to `call.analysis.structuredData`.
+    """
+
+    success_evaluation_plan: typing_extensions.Annotated[
+        typing.Optional[SuccessEvaluationPlan], FieldMetadata(alias="successEvaluationPlan")
+    ] = pydantic.Field(default=None)
+    """
+    This is the plan for generating the success evaluation of the call. This outputs to `call.analysis.successEvaluation`.
+    """
+
+    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/analytics_operation.py

@@ -0,0 +1,34 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+from .analytics_operation_operation import AnalyticsOperationOperation
+import pydantic
+from .analytics_operation_column import AnalyticsOperationColumn
+import typing
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class AnalyticsOperation(UniversalBaseModel):
+    operation: AnalyticsOperationOperation = pydantic.Field()
+    """
+    This is the aggregation operation you want to perform.
+    """
+
+    column: AnalyticsOperationColumn = pydantic.Field()
+    """
+    This is the columns you want to perform the aggregation operation on.
+    """
+
+    alias: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    This is the alias for column name returned. Defaults to `${operation}${column}`.
+    """
+
+    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/analytics_operation_column.py

@@ -0,0 +1,19 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+AnalyticsOperationColumn = typing.Union[
+    typing.Literal[
+        "id",
+        "cost",
+        "costBreakdown.llm",
+        "costBreakdown.stt",
+        "costBreakdown.tts",
+        "costBreakdown.vapi",
+        "costBreakdown.ttsCharacters",
+        "costBreakdown.llmPromptTokens",
+        "costBreakdown.llmCompletionTokens",
+        "duration",
+    ],
+    typing.Any,
+]

vapi/types/analytics_operation_operation.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+AnalyticsOperationOperation = typing.Union[typing.Literal["sum", "avg", "count", "min", "max"], typing.Any]

vapi/types/analytics_query.py

@@ -0,0 +1,51 @@
+# 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 .analytics_query_group_by_item import AnalyticsQueryGroupByItem
+from ..core.serialization import FieldMetadata
+from .time_range import TimeRange
+from .analytics_operation import AnalyticsOperation
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class AnalyticsQuery(UniversalBaseModel):
+    table: typing.Literal["call"] = pydantic.Field(default="call")
+    """
+    This is the table you want to query.
+    """
+
+    group_by: typing_extensions.Annotated[
+        typing.Optional[typing.List[AnalyticsQueryGroupByItem]], FieldMetadata(alias="groupBy")
+    ] = pydantic.Field(default=None)
+    """
+    This is the list of columns you want to group by.
+    """
+
+    name: str = pydantic.Field()
+    """
+    This is the name of the query. This will be used to identify the query in the response.
+    """
+
+    time_range: typing_extensions.Annotated[typing.Optional[TimeRange], FieldMetadata(alias="timeRange")] = (
+        pydantic.Field(default=None)
+    )
+    """
+    This is the time range for the query.
+    """
+
+    operations: typing.List[AnalyticsOperation] = pydantic.Field()
+    """
+    This is the list of operations you want to perform.
+    """
+
+    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/analytics_query_group_by_item.py

@@ -0,0 +1,7 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+AnalyticsQueryGroupByItem = typing.Union[
+    typing.Literal["type", "assistantId", "endedReason", "analysis.successEvaluation", "status"], typing.Any
+]

vapi/types/analytics_query_result.py

@@ -0,0 +1,42 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import pydantic
+import typing_extensions
+from .time_range import TimeRange
+from ..core.serialization import FieldMetadata
+import typing
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class AnalyticsQueryResult(UniversalBaseModel):
+    name: str = pydantic.Field()
+    """
+    This is the unique key for the query.
+    """
+
+    time_range: typing_extensions.Annotated[TimeRange, FieldMetadata(alias="timeRange")] = pydantic.Field()
+    """
+    This is the time range for the query.
+    """
+
+    result: typing.List[typing.Dict[str, typing.Optional[typing.Any]]] = pydantic.Field()
+    """
+    This is the result of the query, a list of unique groups with result of their aggregations.
+    
+    Example:
+    "result": [
+    { "date": "2023-01-01", "assistantId": "123", "endedReason": "customer-ended-call", "sumDuration": 120, "avgCost": 10.5 },
+    { "date": "2023-01-02", "assistantId": "123", "endedReason": "customer-did-not-give-microphone-permission", "sumDuration": 0, "avgCost": 0 },
+    // Additional results
+    ]
+    """
+
+    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/anthropic_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 AnthropicCredential(UniversalBaseModel):
+    provider: typing.Literal["anthropic"] = "anthropic"
+    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/anthropic_model.py

@@ -0,0 +1,91 @@
+# 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 .anthropic_model_tools_item import AnthropicModelToolsItem
+import typing_extensions
+from ..core.serialization import FieldMetadata
+from .anthropic_model_model import AnthropicModelModel
+from .knowledge_base import KnowledgeBase
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class AnthropicModel(UniversalBaseModel):
+    messages: typing.Optional[typing.List[OpenAiMessage]] = pydantic.Field(default=None)
+    """
+    This is the starting state for the conversation.
+    """
+
+    tools: typing.Optional[typing.List[AnthropicModelToolsItem]] = 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.
+    """
+
+    model: AnthropicModelModel = pydantic.Field()
+    """
+    This is the Anthropic/Claude models that will be used.
+    """
+
+    provider: typing.Literal["anthropic"] = "anthropic"
+    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/anthropic_model_model.py

@@ -0,0 +1,10 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+AnthropicModelModel = typing.Union[
+    typing.Literal[
+        "claude-3-opus-20240229", "claude-3-sonnet-20240229", "claude-3-haiku-20240307", "claude-3-5-sonnet-20240620"
+    ],
+    typing.Any,
+]

vapi/types/anthropic_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
+
+AnthropicModelToolsItem = typing.Union[
+    CreateDtmfToolDto,
+    CreateEndCallToolDto,
+    CreateVoicemailToolDto,
+    CreateFunctionToolDto,
+    CreateGhlToolDto,
+    CreateMakeToolDto,
+    CreateTransferCallToolDto,
+]

vapi/types/anyscale_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 AnyscaleCredential(UniversalBaseModel):
+    provider: typing.Literal["anyscale"] = "anyscale"
+    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