vellum-ai 0.9.16__py3-none-any.whl → 0.9.16rc4__py3-none-any.whl

vellum/client/types/function_call_input.py

@@ -0,0 +1,30 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import pydantic
+import typing
+from .function_call import FunctionCall
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class FunctionCallInput(UniversalBaseModel):
+    """
+    A user input representing a Vellum Function Call value
+    """
+
+    name: str = pydantic.Field()
+    """
+    The variable's name
+    """
+
+    type: typing.Literal["FUNCTION_CALL"] = "FUNCTION_CALL"
+    value: FunctionCall
+
+    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/client/types/function_call_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 .fulfilled_enum import FulfilledEnum
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+import pydantic
+
+
+class FunctionCallRequest(UniversalBaseModel):
+    """
+    The final resolved function call value.
+    """
+
+    arguments: typing.Dict[str, typing.Optional[typing.Any]]
+    id: typing.Optional[str] = None
+    name: str
+    state: typing.Optional[FulfilledEnum] = 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/client/types/function_call_variable_value.py

@@ -0,0 +1,21 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import typing
+from .function_call import FunctionCall
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+import pydantic
+
+
+class FunctionCallVariableValue(UniversalBaseModel):
+    type: typing.Literal["FUNCTION_CALL"] = "FUNCTION_CALL"
+    value: typing.Optional[FunctionCall] = 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/client/types/function_call_vellum_value.py

@@ -0,0 +1,25 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import typing
+from .function_call import FunctionCall
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+import pydantic
+
+
+class FunctionCallVellumValue(UniversalBaseModel):
+    """
+    A value representing a Function Call.
+    """
+
+    type: typing.Literal["FUNCTION_CALL"] = "FUNCTION_CALL"
+    value: typing.Optional[FunctionCall] = 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/client/types/function_call_vellum_value_request.py

@@ -0,0 +1,25 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import typing
+from .function_call_request import FunctionCallRequest
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+import pydantic
+
+
+class FunctionCallVellumValueRequest(UniversalBaseModel):
+    """
+    A value representing a Function Call.
+    """
+
+    type: typing.Literal["FUNCTION_CALL"] = "FUNCTION_CALL"
+    value: typing.Optional[FunctionCallRequest] = 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/client/types/function_definition.py

@@ -0,0 +1,31 @@
+# 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 import EphemeralPromptCacheConfig
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+import pydantic
+
+
+class FunctionDefinition(UniversalBaseModel):
+    """
+    A block that represents a function definition in a prompt template.
+    """
+
+    state: typing.Optional[PromptBlockState] = None
+    cache_config: typing.Optional[EphemeralPromptCacheConfig] = None
+    name: typing.Optional[str] = None
+    description: typing.Optional[str] = None
+    parameters: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+    forced: typing.Optional[bool] = None
+    strict: typing.Optional[bool] = 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/client/types/generate_options_request.py

@@ -0,0 +1,26 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import typing
+from .logprobs_enum import LogprobsEnum
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class GenerateOptionsRequest(UniversalBaseModel):
+    logprobs: typing.Optional[LogprobsEnum] = pydantic.Field(default=None)
+    """
+    Which logprobs to include, if any. Defaults to NONE.
+    
+    - `ALL` - ALL
+    - `NONE` - 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/client/types/generate_request.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 .chat_message_request import ChatMessageRequest
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class GenerateRequest(UniversalBaseModel):
+    input_values: typing.Dict[str, typing.Optional[typing.Any]] = pydantic.Field()
+    """
+    Key/value pairs for each template variable defined in the deployment's prompt.
+    """
+
+    chat_history: typing.Optional[typing.List[ChatMessageRequest]] = pydantic.Field(default=None)
+    """
+    Optionally provide a list of chat messages that'll be used in place of the special chat_history variable, if included in the prompt.
+    """
+
+    external_ids: typing.Optional[typing.List[str]] = pydantic.Field(default=None)
+    """
+    Optionally include a unique identifier for each generation, as represented outside of Vellum. Note that this should generally be a list of length one.
+    """
+
+    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/client/types/generate_response.py

@@ -0,0 +1,38 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import typing
+from .generate_result import GenerateResult
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class GenerateResponse(UniversalBaseModel):
+    results: typing.List[GenerateResult] = pydantic.Field()
+    """
+    The results of each generation request.
+    """
+
+    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
+
+
+    @property
+    def texts(self) -> typing.List[str]:
+        return [
+            completion.text
+            for result in self.results
+            for completion in (result.data.completions if result.data else [])
+        ]
+
+    @property
+    def text(self) -> str:
+        if len(self.texts) != 1:
+            raise ValueError(f"Expected exactly one completion, but got {len(self.texts)}")
+        return self.texts[0]

vellum/client/types/generate_result.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 .generate_result_data import GenerateResultData
+import pydantic
+from .generate_result_error import GenerateResultError
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class GenerateResult(UniversalBaseModel):
+    data: typing.Optional[GenerateResultData] = pydantic.Field(default=None)
+    """
+    An object containing the resulting generation. This key will be absent if the LLM provider experienced an error.
+    """
+
+    error: typing.Optional[GenerateResultError] = pydantic.Field(default=None)
+    """
+    An object containing details about the error that occurred. This key will be absent if the LLM provider did not experience an error.
+    """
+
+    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/client/types/generate_result_data.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 .enriched_normalized_completion import EnrichedNormalizedCompletion
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class GenerateResultData(UniversalBaseModel):
+    completions: typing.List[EnrichedNormalizedCompletion] = pydantic.Field()
+    """
+    The generated completions. This will generally be a list of length one.
+    """
+
+    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/client/types/generate_result_error.py

@@ -0,0 +1,22 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+import typing
+
+
+class GenerateResultError(UniversalBaseModel):
+    message: str = pydantic.Field()
+    """
+    The error message returned by the LLM 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

vellum/client/types/generate_stream_response.py

@@ -0,0 +1,20 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+from .generate_stream_result import GenerateStreamResult
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+import typing
+import pydantic
+
+
+class GenerateStreamResponse(UniversalBaseModel):
+    delta: GenerateStreamResult
+
+    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/client/types/generate_stream_result.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 .generate_stream_result_data import GenerateStreamResultData
+from .generate_result_error import GenerateResultError
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+import pydantic
+
+
+class GenerateStreamResult(UniversalBaseModel):
+    request_index: int
+    data: typing.Optional[GenerateStreamResultData] = None
+    error: typing.Optional[GenerateResultError] = 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/client/types/generate_stream_result_data.py

@@ -0,0 +1,21 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+from .enriched_normalized_completion import EnrichedNormalizedCompletion
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+import typing
+import pydantic
+
+
+class GenerateStreamResultData(UniversalBaseModel):
+    completion_index: int
+    completion: EnrichedNormalizedCompletion
+
+    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/client/types/google_vertex_ai_vectorizer_config.py

@@ -0,0 +1,20 @@
+# 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 GoogleVertexAiVectorizerConfig(UniversalBaseModel):
+    project_id: str
+    region: 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/client/types/google_vertex_ai_vectorizer_config_request.py

@@ -0,0 +1,20 @@
+# 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 GoogleVertexAiVectorizerConfigRequest(UniversalBaseModel):
+    project_id: str
+    region: 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/client/types/google_vertex_ai_vectorizer_text_embedding_004.py

@@ -0,0 +1,21 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import typing
+from .google_vertex_ai_vectorizer_config import GoogleVertexAiVectorizerConfig
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+import pydantic
+
+
+class GoogleVertexAiVectorizerTextEmbedding004(UniversalBaseModel):
+    model_name: typing.Literal["text-embedding-004"] = "text-embedding-004"
+    config: GoogleVertexAiVectorizerConfig
+
+    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/client/types/google_vertex_ai_vectorizer_text_embedding_004_request.py

@@ -0,0 +1,21 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import typing
+from .google_vertex_ai_vectorizer_config_request import GoogleVertexAiVectorizerConfigRequest
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+import pydantic
+
+
+class GoogleVertexAiVectorizerTextEmbedding004Request(UniversalBaseModel):
+    model_name: typing.Literal["text-embedding-004"] = "text-embedding-004"
+    config: GoogleVertexAiVectorizerConfigRequest
+
+    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/client/types/google_vertex_ai_vectorizer_text_multilingual_embedding_002.py

@@ -0,0 +1,21 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import typing
+from .google_vertex_ai_vectorizer_config import GoogleVertexAiVectorizerConfig
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+import pydantic
+
+
+class GoogleVertexAiVectorizerTextMultilingualEmbedding002(UniversalBaseModel):
+    model_name: typing.Literal["text-multilingual-embedding-002"] = "text-multilingual-embedding-002"
+    config: GoogleVertexAiVectorizerConfig
+
+    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/client/types/google_vertex_ai_vectorizer_text_multilingual_embedding_002_request.py

@@ -0,0 +1,21 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import typing
+from .google_vertex_ai_vectorizer_config_request import GoogleVertexAiVectorizerConfigRequest
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+import pydantic
+
+
+class GoogleVertexAiVectorizerTextMultilingualEmbedding002Request(UniversalBaseModel):
+    model_name: typing.Literal["text-multilingual-embedding-002"] = "text-multilingual-embedding-002"
+    config: GoogleVertexAiVectorizerConfigRequest
+
+    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/client/types/hkunlp_instructor_xl_vectorizer.py

@@ -0,0 +1,25 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import typing
+from .instructor_vectorizer_config import InstructorVectorizerConfig
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+import pydantic
+
+
+class HkunlpInstructorXlVectorizer(UniversalBaseModel):
+    """
+    Vectorizer for hkunlp/instructor-xl.
+    """
+
+    model_name: typing.Literal["hkunlp/instructor-xl"] = "hkunlp/instructor-xl"
+    config: InstructorVectorizerConfig
+
+    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/client/types/hkunlp_instructor_xl_vectorizer_request.py

@@ -0,0 +1,25 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import typing
+from .instructor_vectorizer_config_request import InstructorVectorizerConfigRequest
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+import pydantic
+
+
+class HkunlpInstructorXlVectorizerRequest(UniversalBaseModel):
+    """
+    Vectorizer for hkunlp/instructor-xl.
+    """
+
+    model_name: typing.Literal["hkunlp/instructor-xl"] = "hkunlp/instructor-xl"
+    config: InstructorVectorizerConfigRequest
+
+    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/client/types/image_chat_message_content.py

@@ -0,0 +1,25 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import typing
+from .vellum_image import VellumImage
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+import pydantic
+
+
+class ImageChatMessageContent(UniversalBaseModel):
+    """
+    An image value that is used in a chat message.
+    """
+
+    type: typing.Literal["IMAGE"] = "IMAGE"
+    value: VellumImage
+
+    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/client/types/image_chat_message_content_request.py

@@ -0,0 +1,25 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import typing
+from .vellum_image_request import VellumImageRequest
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+import pydantic
+
+
+class ImageChatMessageContentRequest(UniversalBaseModel):
+    """
+    An image value that is used in a chat message.
+    """
+
+    type: typing.Literal["IMAGE"] = "IMAGE"
+    value: VellumImageRequest
+
+    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