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

vapi/types/play_ht_voice.py

@@ -0,0 +1,84 @@
+# 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 .play_ht_voice_id import PlayHtVoiceId
+from .play_ht_voice_emotion import PlayHtVoiceEmotion
+from .chunk_plan import ChunkPlan
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class PlayHtVoice(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["playht"] = pydantic.Field(default="playht")
+    """
+    This is the voice provider that will be used.
+    """
+
+    voice_id: typing_extensions.Annotated[PlayHtVoiceId, FieldMetadata(alias="voiceId")] = pydantic.Field()
+    """
+    This is the provider-specific ID that will be used.
+    """
+
+    speed: typing.Optional[float] = pydantic.Field(default=None)
+    """
+    This is the speed multiplier that will be used.
+    """
+
+    temperature: typing.Optional[float] = pydantic.Field(default=None)
+    """
+    A floating point number between 0, exclusive, and 2, inclusive. If equal to null or not provided, the model's default temperature will be used. The temperature parameter controls variance. Lower temperatures result in more predictable results, higher temperatures allow each run to vary more, so the voice may sound less like the baseline voice.
+    """
+
+    emotion: typing.Optional[PlayHtVoiceEmotion] = pydantic.Field(default=None)
+    """
+    An emotion to be applied to the speech.
+    """
+
+    voice_guidance: typing_extensions.Annotated[typing.Optional[float], FieldMetadata(alias="voiceGuidance")] = (
+        pydantic.Field(default=None)
+    )
+    """
+    A number between 1 and 6. Use lower numbers to reduce how unique your chosen voice will be compared to other voices.
+    """
+
+    style_guidance: typing_extensions.Annotated[typing.Optional[float], FieldMetadata(alias="styleGuidance")] = (
+        pydantic.Field(default=None)
+    )
+    """
+    A number between 1 and 30. Use lower numbers to to reduce how strong your chosen emotion will be. Higher numbers will create a very emotional performance.
+    """
+
+    text_guidance: typing_extensions.Annotated[typing.Optional[float], FieldMetadata(alias="textGuidance")] = (
+        pydantic.Field(default=None)
+    )
+    """
+    A number between 1 and 2. This number influences how closely the generated speech adheres to the input text. Use lower values to create more fluid speech, but with a higher chance of deviating from the input text. Higher numbers will make the generated speech more accurate to the input text, ensuring that the words spoken align closely with the provided text.
+    """
+
+    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/play_ht_voice_emotion.py

@@ -0,0 +1,21 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+PlayHtVoiceEmotion = typing.Union[
+    typing.Literal[
+        "female_happy",
+        "female_sad",
+        "female_angry",
+        "female_fearful",
+        "female_disgust",
+        "female_surprised",
+        "male_happy",
+        "male_sad",
+        "male_angry",
+        "male_fearful",
+        "male_disgust",
+        "male_surprised",
+    ],
+    typing.Any,
+]

vapi/types/play_ht_voice_id.py

@@ -0,0 +1,6 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+from .play_ht_voice_id_enum import PlayHtVoiceIdEnum
+
+PlayHtVoiceId = typing.Union[PlayHtVoiceIdEnum, str]

vapi/types/play_ht_voice_id_enum.py

@@ -0,0 +1,8 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+PlayHtVoiceIdEnum = typing.Union[
+    typing.Literal["jennifer", "melissa", "will", "chris", "matt", "jack", "ruby", "davis", "donna", "michael"],
+    typing.Any,
+]

vapi/types/punctuation_boundary.py

@@ -0,0 +1,7 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+PunctuationBoundary = typing.Union[
+    typing.Literal["。", "，", ".", "!", "?", ";", ")", "،", "۔", "।", "॥", "|", "||", ",", ":"], typing.Any
+]

vapi/types/regex_option.py

@@ -0,0 +1,34 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+from .regex_option_type import RegexOptionType
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+import typing
+
+
+class RegexOption(UniversalBaseModel):
+    type: RegexOptionType = pydantic.Field()
+    """
+    This is the type of the regex option. Options are:
+    
+    - `ignore-case`: Ignores the case of the text being matched.
+    - `whole-word`: Matches whole words only.
+    - `multi-line`: Matches across multiple lines.
+    """
+
+    enabled: bool = pydantic.Field()
+    """
+    This is whether to enable the option.
+    
+    @default false
+    """
+
+    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/regex_option_type.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+RegexOptionType = typing.Union[typing.Literal["ignore-case", "whole-word", "multi-line"], typing.Any]

vapi/types/regex_replacement.py

@@ -0,0 +1,48 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import typing
+import pydantic
+from .regex_option import RegexOption
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class RegexReplacement(UniversalBaseModel):
+    type: typing.Literal["regex"] = pydantic.Field(default="regex")
+    """
+    This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.
+    
+    Usage:
+    
+    - Replace all numbers with "some number": { type: 'regex', regex: '\\d+', value: 'some number' }
+    - Replace email addresses with "[EMAIL]": { type: 'regex', regex: '\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\.[A-Z|a-z]{2,}\\b', value: '[EMAIL]' }
+    - Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\d{3})(\\d{3})(\\d{4})', value: '($1) $2-$3' }
+    - Replace all instances of "color" or "colour" with "hue": { type: 'regex', regex: 'colou?r', value: 'hue' }
+    - Capitalize the first letter of every sentence: { type: 'regex', regex: '(?<=\\. |^)[a-z]', value: (match) => match.toUpperCase() }
+    """
+
+    regex: str = pydantic.Field()
+    """
+    This is the regex pattern to replace.
+    """
+
+    options: typing.Optional[typing.List[RegexOption]] = pydantic.Field(default=None)
+    """
+    These are the options for the regex replacement. Default all options are disabled.
+    
+    @default []
+    """
+
+    value: str = pydantic.Field()
+    """
+    This is the value that will replace the match.
+    """
+
+    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/rime_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 RimeAiCredential(UniversalBaseModel):
+    provider: typing.Literal["rime-ai"] = "rime-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/rime_ai_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 .rime_ai_voice_id import RimeAiVoiceId
+from .rime_ai_voice_model import RimeAiVoiceModel
+from .chunk_plan import ChunkPlan
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class RimeAiVoice(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["rime-ai"] = pydantic.Field(default="rime-ai")
+    """
+    This is the voice provider that will be used.
+    """
+
+    voice_id: typing_extensions.Annotated[RimeAiVoiceId, FieldMetadata(alias="voiceId")] = pydantic.Field()
+    """
+    This is the provider-specific ID that will be used.
+    """
+
+    model: typing.Optional[RimeAiVoiceModel] = pydantic.Field(default=None)
+    """
+    This is the model that will be used. Defaults to 'v1' when not specified.
+    """
+
+    speed: typing.Optional[float] = pydantic.Field(default=None)
+    """
+    This is the speed multiplier 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/rime_ai_voice_id.py

@@ -0,0 +1,6 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+from .rime_ai_voice_id_enum import RimeAiVoiceIdEnum
+
+RimeAiVoiceId = typing.Union[RimeAiVoiceIdEnum, str]

vapi/types/rime_ai_voice_id_enum.py

@@ -0,0 +1,90 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+RimeAiVoiceIdEnum = typing.Union[
+    typing.Literal[
+        "marsh",
+        "bayou",
+        "creek",
+        "brook",
+        "flower",
+        "spore",
+        "glacier",
+        "gulch",
+        "alpine",
+        "cove",
+        "lagoon",
+        "tundra",
+        "steppe",
+        "mesa",
+        "grove",
+        "rainforest",
+        "moraine",
+        "wildflower",
+        "peak",
+        "boulder",
+        "abbie",
+        "allison",
+        "ally",
+        "alona",
+        "amber",
+        "ana",
+        "antoine",
+        "armon",
+        "brenda",
+        "brittany",
+        "carol",
+        "colin",
+        "courtney",
+        "elena",
+        "elliot",
+        "eva",
+        "geoff",
+        "gerald",
+        "hank",
+        "helen",
+        "hera",
+        "jen",
+        "joe",
+        "joy",
+        "juan",
+        "kendra",
+        "kendrick",
+        "kenneth",
+        "kevin",
+        "kris",
+        "linda",
+        "madison",
+        "marge",
+        "marina",
+        "marissa",
+        "marta",
+        "maya",
+        "nicholas",
+        "nyles",
+        "phil",
+        "reba",
+        "rex",
+        "rick",
+        "ritu",
+        "rob",
+        "rodney",
+        "rohan",
+        "rosco",
+        "samantha",
+        "sandy",
+        "selena",
+        "seth",
+        "sharon",
+        "stan",
+        "tamra",
+        "tanya",
+        "tibur",
+        "tj",
+        "tyler",
+        "viv",
+        "yadira",
+    ],
+    typing.Any,
+]

vapi/types/rime_ai_voice_model.py

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

vapi/types/rule_based_condition.py

@@ -0,0 +1,96 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import typing
+import pydantic
+from .rule_based_condition_operator import RuleBasedConditionOperator
+import typing_extensions
+from ..core.serialization import FieldMetadata
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class RuleBasedCondition(UniversalBaseModel):
+    type: typing.Literal["rule-based"] = pydantic.Field(default="rule-based")
+    """
+    This condition is based on a strict rule.
+    """
+
+    operator: RuleBasedConditionOperator = pydantic.Field()
+    """
+    This is the operator you want to use to compare the left side and right side.
+    
+    The operation becomes `(leftSide) operator (rightSide)`.
+    """
+
+    left_side: typing_extensions.Annotated[str, FieldMetadata(alias="leftSide")] = pydantic.Field()
+    """
+    This is the left side of the operation.
+    
+    You can reference any variable in the context of the current block execution (step):
+    
+    - "{{output.your-property-name}}" for current step's output
+    - "{{input.your-property-name}}" for current step's input
+    - "{{your-step-name.output.your-property-name}}" for another step's output (in the same workflow; read caveat #1)
+    - "{{your-step-name.input.your-property-name}}" for another step's input (in the same workflow; read caveat #1)
+    - "{{your-block-name.output.your-property-name}}" for another block's output (in the same workflow; read caveat #2)
+    - "{{your-block-name.input.your-property-name}}" for another block's input (in the same workflow; read caveat #2)
+    - "{{workflow.input.your-property-name}}" for the current workflow's input
+    - "{{global.your-property-name}}" for the global context
+    
+    Or, you can use a constant:
+    
+    - "1"
+    - "text"
+    - "true"
+    - "false"
+    
+    Or, you can mix and match with string interpolation:
+    
+    - "{{your-property-name}}-{{input.your-property-name-2}}-1"
+    
+    Caveats:
+    
+    1. a workflow can execute a step multiple times. example, if a loop is used in the graph. {{stepName.input/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.input/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.
+    """
+
+    right_side: typing_extensions.Annotated[str, FieldMetadata(alias="rightSide")] = pydantic.Field()
+    """
+    This is the right side of the operation.
+    
+    You can reference any variable in the context of the current block execution (step):
+    
+    - "{{output.your-property-name}}" for current step's output
+    - "{{input.your-property-name}}" for current step's input
+    - "{{your-step-name.output.your-property-name}}" for another step's output (in the same workflow; read caveat #1)
+    - "{{your-step-name.input.your-property-name}}" for another step's input (in the same workflow; read caveat #1)
+    - "{{your-block-name.output.your-property-name}}" for another block's output (in the same workflow; read caveat #2)
+    - "{{your-block-name.input.your-property-name}}" for another block's input (in the same workflow; read caveat #2)
+    - "{{workflow.input.your-property-name}}" for the current workflow's input
+    - "{{global.your-property-name}}" for the global context
+    
+    Or, you can use a constant:
+    
+    - "1"
+    - "text"
+    - "true"
+    - "false"
+    
+    Or, you can mix and match with string interpolation:
+    
+    - "{{your-property-name}}-{{input.your-property-name-2}}-1"
+    
+    Caveats:
+    
+    1. a workflow can execute a step multiple times. example, if a loop is used in the graph. {{stepName.input/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.input/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.
+    """
+
+    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/rule_based_condition_operator.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+RuleBasedConditionOperator = typing.Union[typing.Literal["eq", "neq", "gt", "gte", "lt", "lte"], typing.Any]

vapi/types/runpod_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 RunpodCredential(UniversalBaseModel):
+    provider: typing.Literal["runpod"] = "runpod"
+    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/s_3_credential.py

@@ -0,0 +1,72 @@
+# 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
+import datetime as dt
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class S3Credential(UniversalBaseModel):
+    provider: typing.Literal["s3"] = pydantic.Field(default="s3")
+    """
+    Credential provider. Only allowed value is s3
+    """
+
+    aws_access_key_id: typing_extensions.Annotated[str, FieldMetadata(alias="awsAccessKeyId")] = pydantic.Field()
+    """
+    AWS access key ID.
+    """
+
+    aws_secret_access_key: typing_extensions.Annotated[str, FieldMetadata(alias="awsSecretAccessKey")] = (
+        pydantic.Field()
+    )
+    """
+    AWS access key secret. This is not returned in the API.
+    """
+
+    region: str = pydantic.Field()
+    """
+    AWS region in which the S3 bucket is located.
+    """
+
+    s_3_bucket_name: typing_extensions.Annotated[str, FieldMetadata(alias="s3BucketName")] = pydantic.Field()
+    """
+    AWS S3 bucket name.
+    """
+
+    s_3_path_prefix: typing_extensions.Annotated[str, FieldMetadata(alias="s3PathPrefix")] = pydantic.Field()
+    """
+    The path prefix for the uploaded recording. Ex. "recordings/"
+    """
+
+    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/sbc_configuration.py

@@ -0,0 +1,17 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+import typing
+import pydantic
+
+
+class SbcConfiguration(UniversalBaseModel):
+    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