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

vapi/types/stop_speaking_plan.py

@@ -0,0 +1,65 @@
+# 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 ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class StopSpeakingPlan(UniversalBaseModel):
+    num_words: typing_extensions.Annotated[typing.Optional[float], FieldMetadata(alias="numWords")] = pydantic.Field(
+        default=None
+    )
+    """
+    This is the number of words that the customer has to say before the assistant will stop talking.
+    
+    Words like "stop", "actually", "no", etc. will always interrupt immediately regardless of this value.
+    
+    Words like "okay", "yeah", "right" will never interrupt.
+    
+    When set to 0, `voiceSeconds` is used in addition to the transcriptions to determine the customer has started speaking.
+    
+    Defaults to 0.
+    
+    @default 0
+    """
+
+    voice_seconds: typing_extensions.Annotated[typing.Optional[float], FieldMetadata(alias="voiceSeconds")] = (
+        pydantic.Field(default=None)
+    )
+    """
+    This is the seconds customer has to speak before the assistant stops talking. This uses the VAD (Voice Activity Detection) spike to determine if the customer has started speaking.
+    
+    Considerations:
+    
+    - A lower value might be more responsive but could potentially pick up non-speech sounds.
+    - A higher value reduces false positives but might slightly delay the detection of speech onset.
+    
+    This is only used if `numWords` is set to 0.
+    
+    Defaults to 0.2
+    
+    @default 0.2
+    """
+
+    backoff_seconds: typing_extensions.Annotated[typing.Optional[float], FieldMetadata(alias="backoffSeconds")] = (
+        pydantic.Field(default=None)
+    )
+    """
+    This is the seconds to wait before the assistant will start talking again after being interrupted.
+    
+    Defaults to 1.
+    
+    @default 1
+    """
+
+    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/structured_data_plan.py

@@ -0,0 +1,66 @@
+# 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 .json_schema import JsonSchema
+from ..core.serialization import FieldMetadata
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class StructuredDataPlan(UniversalBaseModel):
+    messages: typing.Optional[typing.List[typing.Dict[str, typing.Optional[typing.Any]]]] = pydantic.Field(default=None)
+    """
+    These are the messages used to generate the structured data.
+    
+    @default: ` [ { "role": "system", "content": "You are an expert data extractor. You will be given a transcript of a call. Extract structured data per the JSON Schema. DO NOT return anything except the structured data.\n\nJson Schema:\\n{{schema}}\n\nOnly respond with the JSON." }, { "role": "user", "content": "Here is the transcript:\n\n{{transcript}}\n\n" } ]`
+    
+    You can customize by providing any messages you want.
+    
+    Here are the template variables available:
+    
+    - {{transcript}}: the transcript of the call from `call.artifact.transcript`- {{systemPrompt}}: the system prompt of the call from `assistant.model.messages[type=system].content`- {{schema}}: the schema of the structured data from `structuredDataPlan.schema`
+    """
+
+    enabled: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    This determines whether structured data is generated and stored in `call.analysis.structuredData`. Defaults to false.
+    
+    Usage:
+    
+    - If you want to extract structured data, set this to true and provide a `schema`.
+    
+    @default false
+    """
+
+    schema_: typing_extensions.Annotated[typing.Optional[JsonSchema], FieldMetadata(alias="schema")] = pydantic.Field(
+        default=None
+    )
+    """
+    This is the schema of the structured data. The output is stored in `call.analysis.structuredData`.
+    
+    Complete guide on JSON Schema can be found [here](https://ajv.js.org/json-schema.html#json-data-type).
+    """
+
+    timeout_seconds: typing_extensions.Annotated[typing.Optional[float], FieldMetadata(alias="timeoutSeconds")] = (
+        pydantic.Field(default=None)
+    )
+    """
+    This is how long the request is tried before giving up. When request times out, `call.analysis.structuredData` will be empty.
+    
+    Usage:
+    
+    - To guarantee the structured data is generated, set this value high. Note, this will delay the end of call report in cases where model is slow to respond.
+    
+    @default 5 seconds
+    """
+
+    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/success_evaluation_plan.py

@@ -0,0 +1,75 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import typing
+from .success_evaluation_plan_rubric import SuccessEvaluationPlanRubric
+import pydantic
+import typing_extensions
+from ..core.serialization import FieldMetadata
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class SuccessEvaluationPlan(UniversalBaseModel):
+    rubric: typing.Optional[SuccessEvaluationPlanRubric] = pydantic.Field(default=None)
+    """
+    This enforces the rubric of the evaluation. The output is stored in `call.analysis.successEvaluation`.
+    
+    Options include:
+    
+    - 'NumericScale': A scale of 1 to 10.
+    - 'DescriptiveScale': A scale of Excellent, Good, Fair, Poor.
+    - 'Checklist': A checklist of criteria and their status.
+    - 'Matrix': A grid that evaluates multiple criteria across different performance levels.
+    - 'PercentageScale': A scale of 0% to 100%.
+    - 'LikertScale': A scale of Strongly Agree, Agree, Neutral, Disagree, Strongly Disagree.
+    - 'AutomaticRubric': Automatically break down evaluation into several criteria, each with its own score.
+    - 'PassFail': A simple 'true' if call passed, 'false' if not.
+    
+    Default is 'PassFail'.
+    """
+
+    messages: typing.Optional[typing.List[typing.Dict[str, typing.Optional[typing.Any]]]] = pydantic.Field(default=None)
+    """
+    These are the messages used to generate the success evaluation.
+    
+    @default: ` [ { "role": "system", "content": "You are an expert call evaluator. You will be given a transcript of a call and the system prompt of the AI participant. Determine if the call was successful based on the objectives inferred from the system prompt. DO NOT return anything except the result.\n\nRubric:\\n{{rubric}}\n\nOnly respond with the result." }, { "role": "user", "content": "Here is the transcript:\n\n{{transcript}}\n\n" }, { "role": "user", "content": "Here was the system prompt of the call:\n\n{{systemPrompt}}\n\n" } ]`
+    
+    You can customize by providing any messages you want.
+    
+    Here are the template variables available:
+    
+    - {{transcript}}: the transcript of the call from `call.artifact.transcript`- {{systemPrompt}}: the system prompt of the call from `assistant.model.messages[type=system].content`- {{rubric}}: the rubric of the success evaluation from `successEvaluationPlan.rubric`
+    """
+
+    enabled: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    This determines whether a success evaluation is generated and stored in `call.analysis.successEvaluation`. Defaults to true.
+    
+    Usage:
+    
+    - If you want to disable the success evaluation, set this to false.
+    
+    @default true
+    """
+
+    timeout_seconds: typing_extensions.Annotated[typing.Optional[float], FieldMetadata(alias="timeoutSeconds")] = (
+        pydantic.Field(default=None)
+    )
+    """
+    This is how long the request is tried before giving up. When request times out, `call.analysis.successEvaluation` will be empty.
+    
+    Usage:
+    
+    - To guarantee the success evaluation is generated, set this value high. Note, this will delay the end of call report in cases where model is slow to respond.
+    
+    @default 5 seconds
+    """
+
+    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/success_evaluation_plan_rubric.py

@@ -0,0 +1,17 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+SuccessEvaluationPlanRubric = typing.Union[
+    typing.Literal[
+        "NumericScale",
+        "DescriptiveScale",
+        "Checklist",
+        "Matrix",
+        "PercentageScale",
+        "LikertScale",
+        "AutomaticRubric",
+        "PassFail",
+    ],
+    typing.Any,
+]

vapi/types/summary_plan.py

@@ -0,0 +1,56 @@
+# 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 SummaryPlan(UniversalBaseModel):
+    messages: typing.Optional[typing.List[typing.Dict[str, typing.Optional[typing.Any]]]] = pydantic.Field(default=None)
+    """
+    These are the messages used to generate the summary.
+    
+    @default: ` [ { "role": "system", "content": "You are an expert note-taker. You will be given a transcript of a call. Summarize the call in 2-3 sentences. DO NOT return anything except the summary." }, { "role": "user", "content": "Here is the transcript:\n\n{{transcript}}\n\n" } ]`
+    
+    You can customize by providing any messages you want.
+    
+    Here are the template variables available:
+    
+    - {{transcript}}: The transcript of the call from `call.artifact.transcript`- {{systemPrompt}}: The system prompt of the call from `assistant.model.messages[type=system].content`
+    """
+
+    enabled: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    This determines whether a summary is generated and stored in `call.analysis.summary`. Defaults to true.
+    
+    Usage:
+    
+    - If you want to disable the summary, set this to false.
+    
+    @default true
+    """
+
+    timeout_seconds: typing_extensions.Annotated[typing.Optional[float], FieldMetadata(alias="timeoutSeconds")] = (
+        pydantic.Field(default=None)
+    )
+    """
+    This is how long the request is tried before giving up. When request times out, `call.analysis.summary` will be empty.
+    
+    Usage:
+    
+    - To guarantee the summary is generated, set this value high. Note, this will delay the end of call report in cases where model is slow to respond.
+    
+    @default 5 seconds
+    """
+
+    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/sync_voice_library_dto.py

@@ -0,0 +1,23 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import typing
+from .sync_voice_library_dto_providers_item import SyncVoiceLibraryDtoProvidersItem
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class SyncVoiceLibraryDto(UniversalBaseModel):
+    providers: typing.Optional[typing.List[SyncVoiceLibraryDtoProvidersItem]] = pydantic.Field(default=None)
+    """
+    List of providers you want to sync.
+    """
+
+    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/sync_voice_library_dto_providers_item.py

@@ -0,0 +1,10 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+SyncVoiceLibraryDtoProvidersItem = typing.Union[
+    typing.Literal[
+        "11labs", "azure", "cartesia", "custom-voice", "deepgram", "lmnt", "neets", "openai", "playht", "rime-ai"
+    ],
+    typing.Any,
+]

vapi/types/system_message.py

@@ -0,0 +1,39 @@
+# 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 SystemMessage(UniversalBaseModel):
+    role: str = pydantic.Field()
+    """
+    The role of the system in the conversation.
+    """
+
+    message: str = pydantic.Field()
+    """
+    The message content from the system.
+    """
+
+    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/talkscriber_transcriber.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 .talkscriber_transcriber_language import TalkscriberTranscriberLanguage
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class TalkscriberTranscriber(UniversalBaseModel):
+    provider: typing.Literal["talkscriber"] = pydantic.Field(default="talkscriber")
+    """
+    This is the transcription provider that will be used.
+    """
+
+    model: typing.Optional[typing.Literal["whisper"]] = pydantic.Field(default=None)
+    """
+    This is the model that will be used for the transcription.
+    """
+
+    language: typing.Optional[TalkscriberTranscriberLanguage] = pydantic.Field(default=None)
+    """
+    This is the language that will be set for the transcription. The list of languages Whisper supports can be found here: https://github.com/openai/whisper/blob/main/whisper/tokenizer.py
+    """
+
+    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/talkscriber_transcriber_language.py

@@ -0,0 +1,109 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+TalkscriberTranscriberLanguage = typing.Union[
+    typing.Literal[
+        "en",
+        "zh",
+        "de",
+        "es",
+        "ru",
+        "ko",
+        "fr",
+        "ja",
+        "pt",
+        "tr",
+        "pl",
+        "ca",
+        "nl",
+        "ar",
+        "sv",
+        "it",
+        "id",
+        "hi",
+        "fi",
+        "vi",
+        "he",
+        "uk",
+        "el",
+        "ms",
+        "cs",
+        "ro",
+        "da",
+        "hu",
+        "ta",
+        "no",
+        "th",
+        "ur",
+        "hr",
+        "bg",
+        "lt",
+        "la",
+        "mi",
+        "ml",
+        "cy",
+        "sk",
+        "te",
+        "fa",
+        "lv",
+        "bn",
+        "sr",
+        "az",
+        "sl",
+        "kn",
+        "et",
+        "mk",
+        "br",
+        "eu",
+        "is",
+        "hy",
+        "ne",
+        "mn",
+        "bs",
+        "kk",
+        "sq",
+        "sw",
+        "gl",
+        "mr",
+        "pa",
+        "si",
+        "km",
+        "sn",
+        "yo",
+        "so",
+        "af",
+        "oc",
+        "ka",
+        "be",
+        "tg",
+        "sd",
+        "gu",
+        "am",
+        "yi",
+        "lo",
+        "uz",
+        "fo",
+        "ht",
+        "ps",
+        "tk",
+        "nn",
+        "mt",
+        "sa",
+        "lb",
+        "my",
+        "bo",
+        "tl",
+        "mg",
+        "as",
+        "tt",
+        "haw",
+        "ln",
+        "ha",
+        "ba",
+        "jw",
+        "su",
+        "yue",
+    ],
+    typing.Any,
+]

vapi/types/template.py

@@ -0,0 +1,58 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import typing
+from .template_details import TemplateDetails
+import typing_extensions
+from .template_provider_details import TemplateProviderDetails
+from ..core.serialization import FieldMetadata
+from .tool_template_metadata import ToolTemplateMetadata
+from .template_visibility import TemplateVisibility
+import pydantic
+from .template_provider import TemplateProvider
+import datetime as dt
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class Template(UniversalBaseModel):
+    details: typing.Optional[TemplateDetails] = None
+    provider_details: typing_extensions.Annotated[
+        typing.Optional[TemplateProviderDetails], FieldMetadata(alias="providerDetails")
+    ] = None
+    metadata: typing.Optional[ToolTemplateMetadata] = None
+    visibility: typing.Optional[TemplateVisibility] = None
+    type: typing.Literal["tool"] = "tool"
+    name: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    The name of the template. This is just for your own reference.
+    """
+
+    provider: typing.Optional[TemplateProvider] = None
+    id: str = pydantic.Field()
+    """
+    The unique identifier for the template.
+    """
+
+    org_id: typing_extensions.Annotated[str, FieldMetadata(alias="orgId")] = pydantic.Field()
+    """
+    The unique identifier for the organization that this template belongs to.
+    """
+
+    created_at: typing_extensions.Annotated[dt.datetime, FieldMetadata(alias="createdAt")] = pydantic.Field()
+    """
+    The ISO 8601 date-time string of when the template was created.
+    """
+
+    updated_at: typing_extensions.Annotated[dt.datetime, FieldMetadata(alias="updatedAt")] = pydantic.Field()
+    """
+    The ISO 8601 date-time string of when the template 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/template_details.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
+
+TemplateDetails = typing.Union[
+    CreateDtmfToolDto,
+    CreateEndCallToolDto,
+    CreateVoicemailToolDto,
+    CreateFunctionToolDto,
+    CreateGhlToolDto,
+    CreateMakeToolDto,
+    CreateTransferCallToolDto,
+]

vapi/types/template_provider.py

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

vapi/types/template_provider_details.py

@@ -0,0 +1,8 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+from .make_tool_provider_details import MakeToolProviderDetails
+from .ghl_tool_provider_details import GhlToolProviderDetails
+from .function_tool_provider_details import FunctionToolProviderDetails
+
+TemplateProviderDetails = typing.Union[MakeToolProviderDetails, GhlToolProviderDetails, FunctionToolProviderDetails]

vapi/types/template_visibility.py

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

vapi/types/time_range.py

@@ -0,0 +1,47 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import typing
+from .time_range_step import TimeRangeStep
+import pydantic
+import datetime as dt
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class TimeRange(UniversalBaseModel):
+    step: typing.Optional[TimeRangeStep] = pydantic.Field(default=None)
+    """
+    This is the time step for aggregations.
+    
+    If not provided, defaults to returning for the entire time range.
+    """
+
+    start: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+    """
+    This is the start date for the time range.
+    
+    If not provided, defaults to the 7 days ago.
+    """
+
+    end: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+    """
+    This is the end date for the time range.
+    
+    If not provided, defaults to now.
+    """
+
+    timezone: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    This is the timezone you want to set for the query.
+    
+    If not provided, defaults to UTC.
+    """
+
+    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/time_range_step.py

@@ -0,0 +1,8 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+TimeRangeStep = typing.Union[
+    typing.Literal["minute", "hour", "day", "week", "month", "quarter", "year", "decade", "century", "millennium"],
+    typing.Any,
+]