vellum-ai 0.2.2__py3-none-any.whl → 0.3.2__py3-none-any.whl

vellum/__init__.py

@@ -13,12 +13,9 @@ from .types import (
     ArrayChatMessageContentItem_Image,
     ArrayChatMessageContentItem_String,
     ArrayChatMessageContentRequest,
-    ArrayEnum,
-    ArrayVariableValue,
     BlockTypeEnum,
     ChatHistoryEnum,
     ChatHistoryInputRequest,
-    ChatHistoryVariableValue,
     ChatMessage,
     ChatMessageContent,
     ChatMessageContentRequest,
@@ -60,8 +57,6 @@ from .types import (
     EnvironmentEnum,
     ErrorEnum,
     ErrorVariableValue,
-    EvaluationParams,
-    EvaluationParamsRequest,
     ExecutePromptApiErrorResponse,
     ExecutePromptEvent,
     ExecutePromptEvent_Fulfilled,
@@ -84,6 +79,7 @@ from .types import (
     FulfilledExecuteWorkflowWorkflowResultEvent,
     FulfilledFunctionCall,
     FulfilledPromptExecutionMeta,
+    FulfilledWorkflowNodeResultEvent,
     FunctionCall,
     FunctionCallChatMessageContent,
     FunctionCallChatMessageContentRequest,
@@ -110,6 +106,7 @@ from .types import (
     InitiatedEnum,
     InitiatedExecutePromptEvent,
     InitiatedPromptExecutionMeta,
+    InitiatedWorkflowNodeResultEvent,
     JsonEnum,
     JsonInputRequest,
     JsonVariableValue,
@@ -150,10 +147,22 @@ from .types import (
     NodeInputVariableCompiledValue_Number,
     NodeInputVariableCompiledValue_SearchResults,
     NodeInputVariableCompiledValue_String,
+    NodeOutputCompiledChatHistoryValue,
+    NodeOutputCompiledErrorValue,
+    NodeOutputCompiledJsonValue,
+    NodeOutputCompiledNumberValue,
+    NodeOutputCompiledSearchResultsValue,
+    NodeOutputCompiledStringValue,
+    NodeOutputCompiledValue,
+    NodeOutputCompiledValue_ChatHistory,
+    NodeOutputCompiledValue_Error,
+    NodeOutputCompiledValue_Json,
+    NodeOutputCompiledValue_Number,
+    NodeOutputCompiledValue_SearchResults,
+    NodeOutputCompiledValue_String,
     NormalizedLogProbs,
     NormalizedTokenLogProbs,
     NumberEnum,
-    NumberVariableValue,
     PaginatedSlimDeploymentReadList,
     PaginatedSlimDocumentList,
     PaginatedSlimWorkflowDeploymentList,
@@ -196,8 +205,7 @@ from .types import (
     RejectedExecuteWorkflowWorkflowResultEvent,
     RejectedFunctionCall,
     RejectedPromptExecutionMeta,
-    SandboxMetricInputParams,
-    SandboxMetricInputParamsRequest,
+    RejectedWorkflowNodeResultEvent,
     SandboxScenario,
     ScenarioInput,
     ScenarioInputRequest,
@@ -214,7 +222,6 @@ from .types import (
     SearchResultMergingRequest,
     SearchResultRequest,
     SearchResultsEnum,
-    SearchResultsVariableValue,
     SearchWeightsRequest,
     SlimDeploymentRead,
     SlimDocument,
@@ -222,6 +229,7 @@ from .types import (
     StreamingEnum,
     StreamingExecutePromptEvent,
     StreamingPromptExecutionMeta,
+    StreamingWorkflowNodeResultEvent,
     StringChatMessageContent,
     StringChatMessageContentRequest,
     StringEnum,
@@ -279,15 +287,6 @@ from .types import (
     TestSuiteTestCase,
     UploadDocumentErrorResponse,
     UploadDocumentResponse,
-    VariableValue,
-    VariableValue_Array,
-    VariableValue_ChatHistory,
-    VariableValue_Error,
-    VariableValue_FunctionCall,
-    VariableValue_Json,
-    VariableValue_Number,
-    VariableValue_SearchResults,
-    VariableValue_String,
     VellumError,
     VellumErrorCodeEnum,
     VellumErrorRequest,
@@ -313,8 +312,11 @@ from .types import (
     WorkflowNodeResultData_Terminal,
     WorkflowNodeResultEvent,
     WorkflowNodeResultEventState,
+    WorkflowNodeResultEvent_Fulfilled,
+    WorkflowNodeResultEvent_Initiated,
+    WorkflowNodeResultEvent_Rejected,
+    WorkflowNodeResultEvent_Streaming,
     WorkflowOutput,
-    WorkflowOutputArray,
     WorkflowOutputChatHistory,
     WorkflowOutputError,
     WorkflowOutputFunctionCall,
@@ -323,7 +325,6 @@ from .types import (
     WorkflowOutputNumber,
     WorkflowOutputSearchResults,
     WorkflowOutputString,
-    WorkflowOutput_Array,
     WorkflowOutput_ChatHistory,
     WorkflowOutput_Error,
     WorkflowOutput_FunctionCall,
@@ -387,13 +388,10 @@ __all__ = [
     "ArrayChatMessageContentItem_Image",
     "ArrayChatMessageContentItem_String",
     "ArrayChatMessageContentRequest",
-    "ArrayEnum",
-    "ArrayVariableValue",
     "BadRequestError",
     "BlockTypeEnum",
     "ChatHistoryEnum",
     "ChatHistoryInputRequest",
-    "ChatHistoryVariableValue",
     "ChatMessage",
     "ChatMessageContent",
     "ChatMessageContentRequest",
@@ -437,8 +435,6 @@ __all__ = [
     "EnvironmentEnum",
     "ErrorEnum",
     "ErrorVariableValue",
-    "EvaluationParams",
-    "EvaluationParamsRequest",
     "ExecutePromptApiErrorResponse",
     "ExecutePromptEvent",
     "ExecutePromptEvent_Fulfilled",
@@ -462,6 +458,7 @@ __all__ = [
     "FulfilledExecuteWorkflowWorkflowResultEvent",
     "FulfilledFunctionCall",
     "FulfilledPromptExecutionMeta",
+    "FulfilledWorkflowNodeResultEvent",
     "FunctionCall",
     "FunctionCallChatMessageContent",
     "FunctionCallChatMessageContentRequest",
@@ -488,6 +485,7 @@ __all__ = [
     "InitiatedEnum",
     "InitiatedExecutePromptEvent",
     "InitiatedPromptExecutionMeta",
+    "InitiatedWorkflowNodeResultEvent",
     "InternalServerError",
     "JsonEnum",
     "JsonInputRequest",
@@ -529,11 +527,23 @@ __all__ = [
     "NodeInputVariableCompiledValue_Number",
     "NodeInputVariableCompiledValue_SearchResults",
     "NodeInputVariableCompiledValue_String",
+    "NodeOutputCompiledChatHistoryValue",
+    "NodeOutputCompiledErrorValue",
+    "NodeOutputCompiledJsonValue",
+    "NodeOutputCompiledNumberValue",
+    "NodeOutputCompiledSearchResultsValue",
+    "NodeOutputCompiledStringValue",
+    "NodeOutputCompiledValue",
+    "NodeOutputCompiledValue_ChatHistory",
+    "NodeOutputCompiledValue_Error",
+    "NodeOutputCompiledValue_Json",
+    "NodeOutputCompiledValue_Number",
+    "NodeOutputCompiledValue_SearchResults",
+    "NodeOutputCompiledValue_String",
     "NormalizedLogProbs",
     "NormalizedTokenLogProbs",
     "NotFoundError",
     "NumberEnum",
-    "NumberVariableValue",
     "PaginatedSlimDeploymentReadList",
     "PaginatedSlimDocumentList",
     "PaginatedSlimWorkflowDeploymentList",
@@ -576,8 +586,7 @@ __all__ = [
     "RejectedExecuteWorkflowWorkflowResultEvent",
     "RejectedFunctionCall",
     "RejectedPromptExecutionMeta",
-    "SandboxMetricInputParams",
-    "SandboxMetricInputParamsRequest",
+    "RejectedWorkflowNodeResultEvent",
     "SandboxScenario",
     "ScenarioInput",
     "ScenarioInputRequest",
@@ -594,7 +603,6 @@ __all__ = [
     "SearchResultMergingRequest",
     "SearchResultRequest",
     "SearchResultsEnum",
-    "SearchResultsVariableValue",
     "SearchWeightsRequest",
     "SlimDeploymentRead",
     "SlimDocument",
@@ -602,6 +610,7 @@ __all__ = [
     "StreamingEnum",
     "StreamingExecutePromptEvent",
     "StreamingPromptExecutionMeta",
+    "StreamingWorkflowNodeResultEvent",
     "StringChatMessageContent",
     "StringChatMessageContentRequest",
     "StringEnum",
@@ -659,15 +668,6 @@ __all__ = [
     "TestSuiteTestCase",
     "UploadDocumentErrorResponse",
     "UploadDocumentResponse",
-    "VariableValue",
-    "VariableValue_Array",
-    "VariableValue_ChatHistory",
-    "VariableValue_Error",
-    "VariableValue_FunctionCall",
-    "VariableValue_Json",
-    "VariableValue_Number",
-    "VariableValue_SearchResults",
-    "VariableValue_String",
     "VellumEnvironment",
     "VellumError",
     "VellumErrorCodeEnum",
@@ -695,8 +695,11 @@ __all__ = [
     "WorkflowNodeResultData_Terminal",
     "WorkflowNodeResultEvent",
     "WorkflowNodeResultEventState",
+    "WorkflowNodeResultEvent_Fulfilled",
+    "WorkflowNodeResultEvent_Initiated",
+    "WorkflowNodeResultEvent_Rejected",
+    "WorkflowNodeResultEvent_Streaming",
     "WorkflowOutput",
-    "WorkflowOutputArray",
     "WorkflowOutputChatHistory",
     "WorkflowOutputError",
     "WorkflowOutputFunctionCall",
@@ -705,7 +708,6 @@ __all__ = [
     "WorkflowOutputNumber",
     "WorkflowOutputSearchResults",
     "WorkflowOutputString",
-    "WorkflowOutput_Array",
     "WorkflowOutput_ChatHistory",
     "WorkflowOutput_Error",
     "WorkflowOutput_FunctionCall",

vellum/client.py

@@ -372,29 +372,14 @@ class Vellum:
 
             - options: typing.Optional[GenerateOptionsRequest]. Additional configuration that can be used to control what's included in the response.
         ---
-        from vellum import (
-            ChatMessageRequest,
-            ChatMessageRole,
-            GenerateOptionsRequest,
-            GenerateRequest,
-            LogprobsEnum,
-        )
+        from vellum import GenerateOptionsRequest, LogprobsEnum
         from vellum.client import Vellum
 
         client = Vellum(
             api_key="YOUR_API_KEY",
         )
         client.generate(
-            requests=[
-                GenerateRequest(
-                    input_values={"string": {"unknown": "string", "type": "unknown"}},
-                    chat_history=[
-                        ChatMessageRequest(
-                            role=ChatMessageRole.SYSTEM,
-                        )
-                    ],
-                )
-            ],
+            requests=[],
             options=GenerateOptionsRequest(
                 logprobs=LogprobsEnum.ALL,
             ),
@@ -513,7 +498,6 @@ class Vellum:
             LogicalOperator,
             MetadataFilterConfigRequest,
             MetadataFilterRuleCombinator,
-            MetadataFilterRuleRequest,
             SearchFiltersRequest,
             SearchRequestOptionsRequest,
             SearchResultMergingRequest,
@@ -532,12 +516,6 @@ class Vellum:
                 filters=SearchFiltersRequest(
                     metadata=MetadataFilterConfigRequest(
                         combinator=MetadataFilterRuleCombinator.AND,
-                        rules=[
-                            MetadataFilterRuleRequest(
-                                combinator=MetadataFilterRuleCombinator.AND,
-                                operator=LogicalOperator.EQUALS,
-                            )
-                        ],
                         operator=LogicalOperator.EQUALS,
                     ),
                 ),
@@ -591,14 +569,13 @@ class Vellum:
 
             - actuals: typing.List[SubmitCompletionActualRequest]. Feedback regarding the quality of previously generated completions
         ---
-        from vellum import SubmitCompletionActualRequest
         from vellum.client import Vellum
 
         client = Vellum(
             api_key="YOUR_API_KEY",
         )
         client.submit_completion_actuals(
-            actuals=[SubmitCompletionActualRequest()],
+            actuals=[],
         )
         """
         _request: typing.Dict[str, typing.Any] = {"actuals": actuals}
@@ -1000,29 +977,14 @@ class AsyncVellum:
 
             - options: typing.Optional[GenerateOptionsRequest]. Additional configuration that can be used to control what's included in the response.
         ---
-        from vellum import (
-            ChatMessageRequest,
-            ChatMessageRole,
-            GenerateOptionsRequest,
-            GenerateRequest,
-            LogprobsEnum,
-        )
+        from vellum import GenerateOptionsRequest, LogprobsEnum
         from vellum.client import AsyncVellum
 
         client = AsyncVellum(
             api_key="YOUR_API_KEY",
         )
         await client.generate(
-            requests=[
-                GenerateRequest(
-                    input_values={"string": {"unknown": "string", "type": "unknown"}},
-                    chat_history=[
-                        ChatMessageRequest(
-                            role=ChatMessageRole.SYSTEM,
-                        )
-                    ],
-                )
-            ],
+            requests=[],
             options=GenerateOptionsRequest(
                 logprobs=LogprobsEnum.ALL,
             ),
@@ -1141,7 +1103,6 @@ class AsyncVellum:
             LogicalOperator,
             MetadataFilterConfigRequest,
             MetadataFilterRuleCombinator,
-            MetadataFilterRuleRequest,
             SearchFiltersRequest,
             SearchRequestOptionsRequest,
             SearchResultMergingRequest,
@@ -1160,12 +1121,6 @@ class AsyncVellum:
                 filters=SearchFiltersRequest(
                     metadata=MetadataFilterConfigRequest(
                         combinator=MetadataFilterRuleCombinator.AND,
-                        rules=[
-                            MetadataFilterRuleRequest(
-                                combinator=MetadataFilterRuleCombinator.AND,
-                                operator=LogicalOperator.EQUALS,
-                            )
-                        ],
                         operator=LogicalOperator.EQUALS,
                     ),
                 ),
@@ -1219,14 +1174,13 @@ class AsyncVellum:
 
             - actuals: typing.List[SubmitCompletionActualRequest]. Feedback regarding the quality of previously generated completions
         ---
-        from vellum import SubmitCompletionActualRequest
         from vellum.client import AsyncVellum
 
         client = AsyncVellum(
             api_key="YOUR_API_KEY",
         )
         await client.submit_completion_actuals(
-            actuals=[SubmitCompletionActualRequest()],
+            actuals=[],
         )
         """
         _request: typing.Dict[str, typing.Any] = {"actuals": actuals}

vellum/core/client_wrapper.py

@@ -16,7 +16,7 @@ class BaseClientWrapper:
         headers: typing.Dict[str, str] = {
             "X-Fern-Language": "Python",
             "X-Fern-SDK-Name": "vellum-ai",
-            "X-Fern-SDK-Version": "v0.2.2",
+            "X-Fern-SDK-Version": "v0.3.2",
         }
         headers["X_API_KEY"] = self.api_key
         return headers

vellum/resources/deployments/client.py

@@ -44,9 +44,7 @@ class DeploymentsClient:
             - ordering: typing.Optional[str]. Which field to use when ordering the results.
 
             - status: typing.Optional[DeploymentsListRequestStatus]. The current status of the deployment
-
-                                                                     - `ACTIVE` - Active
-                                                                     - `ARCHIVED` - Archived---
+        ---
         from vellum import DeploymentsListRequestStatus
         from vellum.client import Vellum
 
@@ -170,9 +168,7 @@ class AsyncDeploymentsClient:
             - ordering: typing.Optional[str]. Which field to use when ordering the results.
 
             - status: typing.Optional[DeploymentsListRequestStatus]. The current status of the deployment
-
-                                                                     - `ACTIVE` - Active
-                                                                     - `ARCHIVED` - Archived---
+        ---
         from vellum import DeploymentsListRequestStatus
         from vellum.client import AsyncVellum
 

vellum/resources/document_indexes/client.py

@@ -62,11 +62,33 @@ class DocumentIndexesClient:
             api_key="YOUR_API_KEY",
         )
         client.document_indexes.create(
-            label="string",
-            name="string",
+            label="My Document Index",
+            name="my-document-index",
             status=EntityStatus.ACTIVE,
             environment=EnvironmentEnum.DEVELOPMENT,
-            indexing_config={"string": {"unknown": "string", "type": "unknown"}},
+            indexing_config={
+                "chunking": {
+                    "unknown": {
+                        "chunker_name": "sentence-chunker",
+                        "chunker_config": {
+                            "character_limit": 1000,
+                            "min_overlap_ratio": 0.5,
+                        },
+                    },
+                    "type": "unknown",
+                },
+                "vectorizer": {
+                    "unknown": {
+                        "model_name": "hkunlp/instructor-xl",
+                        "config": {
+                            "instruction_domain": "",
+                            "instruction_document_text_type": "plain_text",
+                            "instruction_query_text_type": "plain_text",
+                        },
+                    },
+                    "type": "unknown",
+                },
+            },
         )
         """
         _request: typing.Dict[str, typing.Any] = {"label": label, "name": name, "indexing_config": indexing_config}
@@ -164,11 +186,33 @@ class AsyncDocumentIndexesClient:
             api_key="YOUR_API_KEY",
         )
         await client.document_indexes.create(
-            label="string",
-            name="string",
+            label="My Document Index",
+            name="my-document-index",
             status=EntityStatus.ACTIVE,
             environment=EnvironmentEnum.DEVELOPMENT,
-            indexing_config={"string": {"unknown": "string", "type": "unknown"}},
+            indexing_config={
+                "chunking": {
+                    "unknown": {
+                        "chunker_name": "sentence-chunker",
+                        "chunker_config": {
+                            "character_limit": 1000,
+                            "min_overlap_ratio": 0.5,
+                        },
+                    },
+                    "type": "unknown",
+                },
+                "vectorizer": {
+                    "unknown": {
+                        "model_name": "hkunlp/instructor-xl",
+                        "config": {
+                            "instruction_domain": "",
+                            "instruction_document_text_type": "plain_text",
+                            "instruction_query_text_type": "plain_text",
+                        },
+                    },
+                    "type": "unknown",
+                },
+            },
         )
         """
         _request: typing.Dict[str, typing.Any] = {"label": label, "name": name, "indexing_config": indexing_config}

vellum/resources/documents/client.py

@@ -169,6 +169,14 @@ class DocumentsClient:
 
         **Note:** Uses a base url of `https://documents.vellum.ai`.
 
+        This is a multipart/form-data request. The `contents` field should be a file upload. It also expects a JSON body with the following fields:
+
+        - `add_to_index_names: list[str]` - Optionally include the names of all indexes that you'd like this document to be included in
+        - `external_id: str | None` - Optionally include an external ID for this document. This is useful if you want to re-upload the same document later when its contents change and would like it to be re-indexed.
+        - `label: str` - A human-friendly name for this document. Typically the filename.
+        - `keywords: list[str] | None` - Optionally include a list of keywords that'll be associated with this document. Used when performing keyword searches.
+        - `metadata: dict[str, Any]` - A stringified JSON object containing any metadata associated with the document that you'd like to filter upon later.
+
         Parameters:
             - add_to_index_names: typing.Optional[typing.List[str]].
 
@@ -357,6 +365,14 @@ class AsyncDocumentsClient:
 
         **Note:** Uses a base url of `https://documents.vellum.ai`.
 
+        This is a multipart/form-data request. The `contents` field should be a file upload. It also expects a JSON body with the following fields:
+
+        - `add_to_index_names: list[str]` - Optionally include the names of all indexes that you'd like this document to be included in
+        - `external_id: str | None` - Optionally include an external ID for this document. This is useful if you want to re-upload the same document later when its contents change and would like it to be re-indexed.
+        - `label: str` - A human-friendly name for this document. Typically the filename.
+        - `keywords: list[str] | None` - Optionally include a list of keywords that'll be associated with this document. Used when performing keyword searches.
+        - `metadata: dict[str, Any]` - A stringified JSON object containing any metadata associated with the document that you'd like to filter upon later.
+
         Parameters:
             - add_to_index_names: typing.Optional[typing.List[str]].
 

vellum/resources/registered_prompts/client.py

@@ -75,16 +75,10 @@ class RegisteredPromptsClient:
             - meta: typing.Optional[typing.Dict[str, typing.Any]]. Optionally include additional metadata to store along with the prompt.
         ---
         from vellum import (
-            BlockTypeEnum,
-            ChatMessageRole,
             PromptTemplateBlockDataRequest,
-            PromptTemplateBlockPropertiesRequest,
-            PromptTemplateBlockRequest,
             ProviderEnum,
-            RegisteredPromptInputVariableRequest,
             RegisterPromptModelParametersRequest,
             RegisterPromptPromptInfoRequest,
-            VellumVariableType,
         )
         from vellum.client import Vellum
 
@@ -97,23 +91,9 @@ class RegisteredPromptsClient:
             prompt=RegisterPromptPromptInfoRequest(
                 prompt_block_data=PromptTemplateBlockDataRequest(
                     version=1,
-                    blocks=[
-                        PromptTemplateBlockRequest(
-                            id="string",
-                            block_type=BlockTypeEnum.CHAT_MESSAGE,
-                            properties=PromptTemplateBlockPropertiesRequest(
-                                chat_role=ChatMessageRole.SYSTEM,
-                                template_type=VellumVariableType.STRING,
-                            ),
-                        )
-                    ],
+                    blocks=[],
                 ),
-                input_variables=[
-                    RegisteredPromptInputVariableRequest(
-                        key="string",
-                        type=VellumVariableType.STRING,
-                    )
-                ],
+                input_variables=[],
             ),
             provider=ProviderEnum.ANTHROPIC,
             model="string",
@@ -211,16 +191,10 @@ class AsyncRegisteredPromptsClient:
             - meta: typing.Optional[typing.Dict[str, typing.Any]]. Optionally include additional metadata to store along with the prompt.
         ---
         from vellum import (
-            BlockTypeEnum,
-            ChatMessageRole,
             PromptTemplateBlockDataRequest,
-            PromptTemplateBlockPropertiesRequest,
-            PromptTemplateBlockRequest,
             ProviderEnum,
-            RegisteredPromptInputVariableRequest,
             RegisterPromptModelParametersRequest,
             RegisterPromptPromptInfoRequest,
-            VellumVariableType,
         )
         from vellum.client import AsyncVellum
 
@@ -233,23 +207,9 @@ class AsyncRegisteredPromptsClient:
             prompt=RegisterPromptPromptInfoRequest(
                 prompt_block_data=PromptTemplateBlockDataRequest(
                     version=1,
-                    blocks=[
-                        PromptTemplateBlockRequest(
-                            id="string",
-                            block_type=BlockTypeEnum.CHAT_MESSAGE,
-                            properties=PromptTemplateBlockPropertiesRequest(
-                                chat_role=ChatMessageRole.SYSTEM,
-                                template_type=VellumVariableType.STRING,
-                            ),
-                        )
-                    ],
+                    blocks=[],
                 ),
-                input_variables=[
-                    RegisteredPromptInputVariableRequest(
-                        key="string",
-                        type=VellumVariableType.STRING,
-                    )
-                ],
+                input_variables=[],
             ),
             provider=ProviderEnum.ANTHROPIC,
             model="string",