vellum-ai 0.8.5__py3-none-any.whl → 0.8.7__py3-none-any.whl

vellum/types/fulfilled_ad_hoc_execute_prompt_event.py

@@ -0,0 +1,28 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import typing
+from .prompt_output import PromptOutput
+from .ad_hoc_fulfilled_prompt_execution_meta import AdHocFulfilledPromptExecutionMeta
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+import pydantic
+
+
+class FulfilledAdHocExecutePromptEvent(UniversalBaseModel):
+    """
+    The final data event returned indicating that the stream has ended and all final resolved values from the model can be found.
+    """
+
+    state: typing.Literal["FULFILLED"] = "FULFILLED"
+    outputs: typing.List[PromptOutput]
+    execution_id: str
+    meta: typing.Optional[AdHocFulfilledPromptExecutionMeta] = None
+
+    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

vellum/types/function_definition_prompt_block_properties_request.py

@@ -0,0 +1,42 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import typing
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class FunctionDefinitionPromptBlockPropertiesRequest(UniversalBaseModel):
+    function_name: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    The name identifying the function.
+    """
+
+    function_description: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    A description to help guide the model when to invoke this function.
+    """
+
+    function_parameters: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = pydantic.Field(default=None)
+    """
+    An OpenAPI specification of parameters that are supported by this function.
+    """
+
+    function_forced: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Set this option to true to force the model to return a function call of this function.
+    """
+
+    function_strict: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Set this option to use strict schema decoding when available.
+    """
+
+    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

vellum/types/function_definition_prompt_block_request.py

@@ -0,0 +1,30 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import typing
+from .function_definition_prompt_block_properties_request import FunctionDefinitionPromptBlockPropertiesRequest
+from .prompt_block_state import PromptBlockState
+from .ephemeral_prompt_cache_config_request import EphemeralPromptCacheConfigRequest
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+import pydantic
+
+
+class FunctionDefinitionPromptBlockRequest(UniversalBaseModel):
+    """
+    A block that represents a function definition in a prompt template.
+    """
+
+    block_type: typing.Literal["FUNCTION_DEFINITION"] = "FUNCTION_DEFINITION"
+    properties: FunctionDefinitionPromptBlockPropertiesRequest
+    id: str
+    state: typing.Optional[PromptBlockState] = None
+    cache_config: typing.Optional[EphemeralPromptCacheConfigRequest] = None
+
+    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

vellum/types/{hugging_face_tokenizer_config.py → initiated_ad_hoc_execute_prompt_event.py}

@@ -2,18 +2,19 @@
 
 from ..core.pydantic_utilities import UniversalBaseModel
 import typing
+from .ad_hoc_initiated_prompt_execution_meta import AdHocInitiatedPromptExecutionMeta
 from ..core.pydantic_utilities import IS_PYDANTIC_V2
 import pydantic
 
 
-class HuggingFaceTokenizerConfig(UniversalBaseModel):
+class InitiatedAdHocExecutePromptEvent(UniversalBaseModel):
     """
-    Tokenizer config for Hugging Face type tokenizers.
+    The initial data returned indicating that the response from the model has returned and begun streaming.
     """
 
-    type: typing.Literal["HUGGING_FACE"] = "HUGGING_FACE"
-    name: str
-    path: typing.Optional[str] = None
+    state: typing.Literal["INITIATED"] = "INITIATED"
+    meta: typing.Optional[AdHocInitiatedPromptExecutionMeta] = None
+    execution_id: str
 
     if IS_PYDANTIC_V2:
         model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

vellum/types/{ml_model_display_tag_enum_value_label.py → jinja_prompt_block_properties_request.py}

@@ -1,15 +1,15 @@
 # This file was auto-generated by Fern from our API Definition.
 
 from ..core.pydantic_utilities import UniversalBaseModel
-from .ml_model_display_tag import MlModelDisplayTag
-from ..core.pydantic_utilities import IS_PYDANTIC_V2
 import typing
+from .vellum_variable_type import VellumVariableType
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
 import pydantic
 
 
-class MlModelDisplayTagEnumValueLabel(UniversalBaseModel):
-    label: str
-    value: MlModelDisplayTag
+class JinjaPromptBlockPropertiesRequest(UniversalBaseModel):
+    template: typing.Optional[str] = None
+    template_type: typing.Optional[VellumVariableType] = None
 
     if IS_PYDANTIC_V2:
         model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

vellum/types/jinja_prompt_block_request.py

@@ -0,0 +1,30 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import typing
+from .jinja_prompt_block_properties_request import JinjaPromptBlockPropertiesRequest
+from .prompt_block_state import PromptBlockState
+from .ephemeral_prompt_cache_config_request import EphemeralPromptCacheConfigRequest
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+import pydantic
+
+
+class JinjaPromptBlockRequest(UniversalBaseModel):
+    """
+    A block of Jinja template code that is used to generate a prompt
+    """
+
+    block_type: typing.Literal["JINJA"] = "JINJA"
+    properties: JinjaPromptBlockPropertiesRequest
+    id: str
+    state: typing.Optional[PromptBlockState] = None
+    cache_config: typing.Optional[EphemeralPromptCacheConfigRequest] = None
+
+    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

vellum/types/ml_model_usage.py

@@ -12,6 +12,8 @@ class MlModelUsage(UniversalBaseModel):
     input_char_count: typing.Optional[int] = None
     output_char_count: typing.Optional[int] = None
     compute_nanos: typing.Optional[int] = None
+    cache_creation_input_tokens: typing.Optional[int] = None
+    cache_read_input_tokens: typing.Optional[int] = None
 
     if IS_PYDANTIC_V2:
         model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

vellum/types/plain_text_prompt_block_request.py

@@ -0,0 +1,29 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import typing
+from .prompt_block_state import PromptBlockState
+from .ephemeral_prompt_cache_config_request import EphemeralPromptCacheConfigRequest
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+import pydantic
+
+
+class PlainTextPromptBlockRequest(UniversalBaseModel):
+    """
+    A block that holds a plain text string value.
+    """
+
+    block_type: typing.Literal["PLAIN_TEXT"] = "PLAIN_TEXT"
+    text: str
+    id: str
+    state: typing.Optional[PromptBlockState] = None
+    cache_config: typing.Optional[EphemeralPromptCacheConfigRequest] = None
+
+    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

vellum/types/prompt_block_request.py

@@ -0,0 +1,19 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from __future__ import annotations
+import typing
+from .jinja_prompt_block_request import JinjaPromptBlockRequest
+from .function_definition_prompt_block_request import FunctionDefinitionPromptBlockRequest
+from .variable_prompt_block_request import VariablePromptBlockRequest
+from .rich_text_prompt_block_request import RichTextPromptBlockRequest
+import typing
+
+if typing.TYPE_CHECKING:
+    from .chat_message_prompt_block_request import ChatMessagePromptBlockRequest
+PromptBlockRequest = typing.Union[
+    JinjaPromptBlockRequest,
+    "ChatMessagePromptBlockRequest",
+    FunctionDefinitionPromptBlockRequest,
+    VariablePromptBlockRequest,
+    RichTextPromptBlockRequest,
+]

vellum/types/prompt_block_state.py

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

vellum/types/{prompt_deployment_expand_meta_request_request.py → prompt_deployment_expand_meta_request.py}

@@ -6,7 +6,7 @@ import pydantic
 from ..core.pydantic_utilities import IS_PYDANTIC_V2
 
 
-class PromptDeploymentExpandMetaRequestRequest(UniversalBaseModel):
+class PromptDeploymentExpandMetaRequest(UniversalBaseModel):
     model_name: typing.Optional[bool] = pydantic.Field(default=None)
     """
     If enabled, the response will include the model identifier representing the ML Model invoked by the Prompt.

vellum/types/prompt_parameters_request.py

@@ -0,0 +1,27 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import typing
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+import pydantic
+
+
+class PromptParametersRequest(UniversalBaseModel):
+    stop: typing.Optional[typing.List[str]] = None
+    temperature: typing.Optional[float] = None
+    max_tokens: typing.Optional[int] = None
+    top_p: typing.Optional[float] = None
+    top_k: typing.Optional[int] = None
+    frequency_penalty: typing.Optional[float] = None
+    presence_penalty: typing.Optional[float] = None
+    logit_bias: typing.Optional[typing.Dict[str, typing.Optional[float]]] = None
+    custom_parameters: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+
+    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

vellum/types/{open_api_boolean_property.py → prompt_request_chat_history_input_request.py}

@@ -1,20 +1,20 @@
 # This file was auto-generated by Fern from our API Definition.
 
 from ..core.pydantic_utilities import UniversalBaseModel
+import pydantic
 import typing
+from .chat_message_request import ChatMessageRequest
 from ..core.pydantic_utilities import IS_PYDANTIC_V2
-import pydantic
 
 
-class OpenApiBooleanProperty(UniversalBaseModel):
+class PromptRequestChatHistoryInputRequest(UniversalBaseModel):
+    key: str = pydantic.Field()
     """
-    An OpenAPI specification of a property with type 'boolean'
+    The variable's name, as defined in the Prompt.
     """
 
-    type: typing.Literal["boolean"] = "boolean"
-    default: typing.Optional[bool] = None
-    title: typing.Optional[str] = None
-    description: typing.Optional[str] = None
+    type: typing.Literal["CHAT_HISTORY"] = "CHAT_HISTORY"
+    value: typing.List[ChatMessageRequest]
 
     if IS_PYDANTIC_V2:
         model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

vellum/types/prompt_request_input_request.py

@@ -0,0 +1,10 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+from .prompt_request_string_input_request import PromptRequestStringInputRequest
+from .prompt_request_json_input_request import PromptRequestJsonInputRequest
+from .prompt_request_chat_history_input_request import PromptRequestChatHistoryInputRequest
+
+PromptRequestInputRequest = typing.Union[
+    PromptRequestStringInputRequest, PromptRequestJsonInputRequest, PromptRequestChatHistoryInputRequest
+]

vellum/types/{hugging_face_tokenizer_config_request.py → prompt_request_json_input_request.py}

@@ -1,19 +1,19 @@
 # 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
-import pydantic
 
 
-class HuggingFaceTokenizerConfigRequest(UniversalBaseModel):
+class PromptRequestJsonInputRequest(UniversalBaseModel):
+    key: str = pydantic.Field()
     """
-    Tokenizer config for Hugging Face type tokenizers.
+    The variable's name, as defined in the Prompt.
     """
 
-    type: typing.Literal["HUGGING_FACE"] = "HUGGING_FACE"
-    name: str
-    path: typing.Optional[str] = None
+    type: typing.Literal["JSON"] = "JSON"
+    value: typing.Dict[str, typing.Optional[typing.Any]]
 
     if IS_PYDANTIC_V2:
         model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

vellum/types/{tik_token_tokenizer_config.py → prompt_request_string_input_request.py}

@@ -1,18 +1,19 @@
 # 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
-import pydantic
 
 
-class TikTokenTokenizerConfig(UniversalBaseModel):
+class PromptRequestStringInputRequest(UniversalBaseModel):
+    key: str = pydantic.Field()
     """
-    Tokenizer config for OpenAI's TikToken type tokenizers.
+    The variable's name, as defined in the Prompt.
     """
 
-    type: typing.Literal["TIKTOKEN"] = "TIKTOKEN"
-    name: str
+    type: typing.Literal["STRING"] = "STRING"
+    value: str
 
     if IS_PYDANTIC_V2:
         model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

vellum/types/rejected_ad_hoc_execute_prompt_event.py

@@ -0,0 +1,28 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import typing
+from .vellum_error import VellumError
+from .ad_hoc_rejected_prompt_execution_meta import AdHocRejectedPromptExecutionMeta
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+import pydantic
+
+
+class RejectedAdHocExecutePromptEvent(UniversalBaseModel):
+    """
+    The final data returned indicating an error occurred during the stream.
+    """
+
+    state: typing.Literal["REJECTED"] = "REJECTED"
+    error: VellumError
+    execution_id: str
+    meta: typing.Optional[AdHocRejectedPromptExecutionMeta] = None
+
+    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

vellum/types/rich_text_child_block_request.py

@@ -0,0 +1,7 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+from .variable_prompt_block_request import VariablePromptBlockRequest
+from .plain_text_prompt_block_request import PlainTextPromptBlockRequest
+
+RichTextChildBlockRequest = typing.Union[VariablePromptBlockRequest, PlainTextPromptBlockRequest]

vellum/types/rich_text_prompt_block_request.py

@@ -0,0 +1,30 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import typing
+from .rich_text_child_block_request import RichTextChildBlockRequest
+from .prompt_block_state import PromptBlockState
+from .ephemeral_prompt_cache_config_request import EphemeralPromptCacheConfigRequest
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+import pydantic
+
+
+class RichTextPromptBlockRequest(UniversalBaseModel):
+    """
+    A block that includes a combination of plain text and variable blocks.
+    """
+
+    block_type: typing.Literal["RICH_TEXT"] = "RICH_TEXT"
+    blocks: typing.List[RichTextChildBlockRequest]
+    id: str
+    state: typing.Optional[PromptBlockState] = None
+    cache_config: typing.Optional[EphemeralPromptCacheConfigRequest] = None
+
+    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

vellum/types/streaming_ad_hoc_execute_prompt_event.py

@@ -0,0 +1,33 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import typing
+from .prompt_output import PromptOutput
+from .ad_hoc_streaming_prompt_execution_meta import AdHocStreamingPromptExecutionMeta
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class StreamingAdHocExecutePromptEvent(UniversalBaseModel):
+    """
+    The data returned for each delta during the prompt execution stream.
+    """
+
+    state: typing.Literal["STREAMING"] = "STREAMING"
+    output: PromptOutput
+    output_index: int
+    execution_id: str
+    meta: typing.Optional[AdHocStreamingPromptExecutionMeta] = None
+    raw: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = pydantic.Field(default=None)
+    """
+    The subset of the raw response from the model that the request opted into with `expand_raw`.
+    """
+
+    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

vellum/types/variable_prompt_block_request.py

@@ -0,0 +1,29 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import typing
+from .prompt_block_state import PromptBlockState
+from .ephemeral_prompt_cache_config_request import EphemeralPromptCacheConfigRequest
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+import pydantic
+
+
+class VariablePromptBlockRequest(UniversalBaseModel):
+    """
+    A block that represents a variable in a prompt template.
+    """
+
+    block_type: typing.Literal["VARIABLE"] = "VARIABLE"
+    id: str
+    state: typing.Optional[PromptBlockState] = None
+    cache_config: typing.Optional[EphemeralPromptCacheConfigRequest] = None
+    input_variable_id: str
+
+    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

vellum/types/{ml_model_family_enum_value_label.py → vellum_variable_request.py}

@@ -1,15 +1,16 @@
 # This file was auto-generated by Fern from our API Definition.
 
 from ..core.pydantic_utilities import UniversalBaseModel
-from .ml_model_family import MlModelFamily
+from .vellum_variable_type import VellumVariableType
 from ..core.pydantic_utilities import IS_PYDANTIC_V2
 import typing
 import pydantic
 
 
-class MlModelFamilyEnumValueLabel(UniversalBaseModel):
-    label: str
-    value: MlModelFamily
+class VellumVariableRequest(UniversalBaseModel):
+    id: str
+    key: str
+    type: VellumVariableType
 
     if IS_PYDANTIC_V2:
         model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

{vellum_ai-0.8.5.dist-info → vellum_ai-0.8.7.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: vellum-ai
-Version: 0.8.5
+Version: 0.8.7
 Summary: 
 License: MIT
 Requires-Python: >=3.8,<4.0