vellum-ai 0.1.13__py3-none-any.whl → 0.2.1__py3-none-any.whl

vellum/resources/document_indexes/client.py

@@ -8,7 +8,7 @@ from ...core.api_error import ApiError
 from ...core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
 from ...core.jsonable_encoder import jsonable_encoder
 from ...types.document_index_read import DocumentIndexRead
-from ...types.document_index_status import DocumentIndexStatus
+from ...types.entity_status import EntityStatus
 from ...types.environment_enum import EnvironmentEnum
 
 try:
@@ -29,7 +29,7 @@ class DocumentIndexesClient:
         *,
         label: str,
         name: str,
-        status: typing.Optional[DocumentIndexStatus] = OMIT,
+        status: typing.Optional[EntityStatus] = OMIT,
         environment: typing.Optional[EnvironmentEnum] = OMIT,
         indexing_config: typing.Dict[str, typing.Any],
         copy_documents_from_index_id: typing.Optional[str] = OMIT,
@@ -42,10 +42,10 @@ class DocumentIndexesClient:
 
             - name: str. A name that uniquely identifies this index within its workspace
 
-            - status: typing.Optional[DocumentIndexStatus]. The current status of the document index
+            - status: typing.Optional[EntityStatus]. The current status of the document index
 
-                                                            * `ACTIVE` - Active
-                                                            * `ARCHIVED` - Archived
+                                                     * `ACTIVE` - Active
+                                                     * `ARCHIVED` - Archived
             - environment: typing.Optional[EnvironmentEnum]. The environment this document index is used in
 
                                                              * `DEVELOPMENT` - Development
@@ -54,6 +54,20 @@ class DocumentIndexesClient:
             - indexing_config: typing.Dict[str, typing.Any]. Configuration representing how documents should be indexed
 
             - copy_documents_from_index_id: typing.Optional[str]. Optionally specify the id of a document index from which you'd like to copy and re-index its documents into this newly created index
+        ---
+        from vellum import EntityStatus, EnvironmentEnum
+        from vellum.client import Vellum
+
+        client = Vellum(
+            api_key="YOUR_API_KEY",
+        )
+        client.document_indexes.create(
+            label="string",
+            name="string",
+            status=EntityStatus.ACTIVE,
+            environment=EnvironmentEnum.DEVELOPMENT,
+            indexing_config={"string": {"unknown": "string", "type": "unknown"}},
+        )
         """
         _request: typing.Dict[str, typing.Any] = {"label": label, "name": name, "indexing_config": indexing_config}
         if status is not OMIT:
@@ -83,6 +97,15 @@ class DocumentIndexesClient:
 
         Parameters:
             - id: str. Either the Document Index's ID or its unique name
+        ---
+        from vellum.client import Vellum
+
+        client = Vellum(
+            api_key="YOUR_API_KEY",
+        )
+        client.document_indexes.retrieve(
+            id="string",
+        )
         """
         _response = self._client_wrapper.httpx_client.request(
             "GET",
@@ -108,7 +131,7 @@ class AsyncDocumentIndexesClient:
         *,
         label: str,
         name: str,
-        status: typing.Optional[DocumentIndexStatus] = OMIT,
+        status: typing.Optional[EntityStatus] = OMIT,
         environment: typing.Optional[EnvironmentEnum] = OMIT,
         indexing_config: typing.Dict[str, typing.Any],
         copy_documents_from_index_id: typing.Optional[str] = OMIT,
@@ -121,10 +144,10 @@ class AsyncDocumentIndexesClient:
 
             - name: str. A name that uniquely identifies this index within its workspace
 
-            - status: typing.Optional[DocumentIndexStatus]. The current status of the document index
+            - status: typing.Optional[EntityStatus]. The current status of the document index
 
-                                                            * `ACTIVE` - Active
-                                                            * `ARCHIVED` - Archived
+                                                     * `ACTIVE` - Active
+                                                     * `ARCHIVED` - Archived
             - environment: typing.Optional[EnvironmentEnum]. The environment this document index is used in
 
                                                              * `DEVELOPMENT` - Development
@@ -133,6 +156,20 @@ class AsyncDocumentIndexesClient:
             - indexing_config: typing.Dict[str, typing.Any]. Configuration representing how documents should be indexed
 
             - copy_documents_from_index_id: typing.Optional[str]. Optionally specify the id of a document index from which you'd like to copy and re-index its documents into this newly created index
+        ---
+        from vellum import EntityStatus, EnvironmentEnum
+        from vellum.client import AsyncVellum
+
+        client = AsyncVellum(
+            api_key="YOUR_API_KEY",
+        )
+        await client.document_indexes.create(
+            label="string",
+            name="string",
+            status=EntityStatus.ACTIVE,
+            environment=EnvironmentEnum.DEVELOPMENT,
+            indexing_config={"string": {"unknown": "string", "type": "unknown"}},
+        )
         """
         _request: typing.Dict[str, typing.Any] = {"label": label, "name": name, "indexing_config": indexing_config}
         if status is not OMIT:
@@ -162,6 +199,15 @@ class AsyncDocumentIndexesClient:
 
         Parameters:
             - id: str. Either the Document Index's ID or its unique name
+        ---
+        from vellum.client import AsyncVellum
+
+        client = AsyncVellum(
+            api_key="YOUR_API_KEY",
+        )
+        await client.document_indexes.retrieve(
+            id="string",
+        )
         """
         _response = await self._client_wrapper.httpx_client.request(
             "GET",

vellum/resources/documents/client.py

@@ -84,7 +84,7 @@ class DocumentsClient:
             api_key="YOUR_API_KEY",
         )
         client.documents.destroy(
-            id="id",
+            id="string",
         )
         """
         _response = self._client_wrapper.httpx_client.request(
@@ -121,6 +121,16 @@ class DocumentsClient:
 
                                                        * `ACTIVE` - Active
             - metadata: typing.Optional[typing.Dict[str, typing.Any]]. A JSON object containing any metadata associated with the document that you'd like to filter upon later.
+        ---
+        from vellum.client import Vellum
+
+        client = Vellum(
+            api_key="YOUR_API_KEY",
+        )
+        client.documents.partial_update(
+            id="string",
+            status="ACTIVE",
+        )
         """
         _request: typing.Dict[str, typing.Any] = {}
         if label is not OMIT:
@@ -262,7 +272,7 @@ class AsyncDocumentsClient:
             api_key="YOUR_API_KEY",
         )
         await client.documents.destroy(
-            id="id",
+            id="string",
         )
         """
         _response = await self._client_wrapper.httpx_client.request(
@@ -299,6 +309,16 @@ class AsyncDocumentsClient:
 
                                                        * `ACTIVE` - Active
             - metadata: typing.Optional[typing.Dict[str, typing.Any]]. A JSON object containing any metadata associated with the document that you'd like to filter upon later.
+        ---
+        from vellum.client import AsyncVellum
+
+        client = AsyncVellum(
+            api_key="YOUR_API_KEY",
+        )
+        await client.documents.partial_update(
+            id="string",
+            status="ACTIVE",
+        )
         """
         _request: typing.Dict[str, typing.Any] = {}
         if label is not OMIT:

vellum/resources/model_versions/client.py

@@ -23,6 +23,15 @@ class ModelVersionsClient:
 
         Parameters:
             - id: str. A UUID string identifying this model version.
+        ---
+        from vellum.client import Vellum
+
+        client = Vellum(
+            api_key="YOUR_API_KEY",
+        )
+        client.model_versions.retrieve(
+            id="string",
+        )
         """
         _response = self._client_wrapper.httpx_client.request(
             "GET",
@@ -49,6 +58,15 @@ class AsyncModelVersionsClient:
 
         Parameters:
             - id: str. A UUID string identifying this model version.
+        ---
+        from vellum.client import AsyncVellum
+
+        client = AsyncVellum(
+            api_key="YOUR_API_KEY",
+        )
+        await client.model_versions.retrieve(
+            id="string",
+        )
         """
         _response = await self._client_wrapper.httpx_client.request(
             "GET",

vellum/resources/registered_prompts/client.py

@@ -73,6 +73,58 @@ class RegisteredPromptsClient:
             - parameters: RegisterPromptModelParametersRequest. The initial model parameters to use for  this prompt
 
             - 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
+
+        client = Vellum(
+            api_key="YOUR_API_KEY",
+        )
+        client.registered_prompts.register_prompt(
+            label="string",
+            name="string",
+            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,
+                            ),
+                        )
+                    ],
+                ),
+                input_variables=[
+                    RegisteredPromptInputVariableRequest(
+                        key="string",
+                        type=VellumVariableType.STRING,
+                    )
+                ],
+            ),
+            provider=ProviderEnum.ANTHROPIC,
+            model="string",
+            parameters=RegisterPromptModelParametersRequest(
+                temperature=1.1,
+                max_tokens=1,
+                top_p=1.1,
+                frequency_penalty=1.1,
+                presence_penalty=1.1,
+            ),
+        )
         """
         _request: typing.Dict[str, typing.Any] = {
             "label": label,
@@ -157,6 +209,58 @@ class AsyncRegisteredPromptsClient:
             - parameters: RegisterPromptModelParametersRequest. The initial model parameters to use for  this prompt
 
             - 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
+
+        client = AsyncVellum(
+            api_key="YOUR_API_KEY",
+        )
+        await client.registered_prompts.register_prompt(
+            label="string",
+            name="string",
+            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,
+                            ),
+                        )
+                    ],
+                ),
+                input_variables=[
+                    RegisteredPromptInputVariableRequest(
+                        key="string",
+                        type=VellumVariableType.STRING,
+                    )
+                ],
+            ),
+            provider=ProviderEnum.ANTHROPIC,
+            model="string",
+            parameters=RegisterPromptModelParametersRequest(
+                temperature=1.1,
+                max_tokens=1,
+                top_p=1.1,
+                frequency_penalty=1.1,
+                presence_penalty=1.1,
+            ),
+        )
         """
         _request: typing.Dict[str, typing.Any] = {
             "label": label,

vellum/resources/sandboxes/client.py

@@ -52,6 +52,37 @@ class SandboxesClient:
             - scenario_id: typing.Optional[str]. The id of the scenario to update. If none is provided, an id will be generated and a new scenario will be appended.
 
             - metric_input_params: typing.Optional[SandboxMetricInputParamsRequest].
+        ---
+        from vellum import (
+            ChatMessageRequest,
+            ChatMessageRole,
+            EvaluationParamsRequest,
+            SandboxMetricInputParamsRequest,
+            ScenarioInputRequest,
+            ScenarioInputTypeEnum,
+        )
+        from vellum.client import Vellum
+
+        client = Vellum(
+            api_key="YOUR_API_KEY",
+        )
+        client.sandboxes.upsert_sandbox_scenario(
+            id="string",
+            inputs=[
+                ScenarioInputRequest(
+                    key="string",
+                    type=ScenarioInputTypeEnum.TEXT,
+                    chat_history=[
+                        ChatMessageRequest(
+                            role=ChatMessageRole.SYSTEM,
+                        )
+                    ],
+                )
+            ],
+            metric_input_params=SandboxMetricInputParamsRequest(
+                params=EvaluationParamsRequest(),
+            ),
+        )
         """
         _request: typing.Dict[str, typing.Any] = {"inputs": inputs}
         if label is not OMIT:
@@ -90,8 +121,8 @@ class SandboxesClient:
             api_key="YOUR_API_KEY",
         )
         client.sandboxes.delete_sandbox_scenario(
-            id="id",
-            scenario_id="scenario-id",
+            id="string",
+            scenario_id="string",
         )
         """
         _response = self._client_wrapper.httpx_client.request(
@@ -143,6 +174,37 @@ class AsyncSandboxesClient:
             - scenario_id: typing.Optional[str]. The id of the scenario to update. If none is provided, an id will be generated and a new scenario will be appended.
 
             - metric_input_params: typing.Optional[SandboxMetricInputParamsRequest].
+        ---
+        from vellum import (
+            ChatMessageRequest,
+            ChatMessageRole,
+            EvaluationParamsRequest,
+            SandboxMetricInputParamsRequest,
+            ScenarioInputRequest,
+            ScenarioInputTypeEnum,
+        )
+        from vellum.client import AsyncVellum
+
+        client = AsyncVellum(
+            api_key="YOUR_API_KEY",
+        )
+        await client.sandboxes.upsert_sandbox_scenario(
+            id="string",
+            inputs=[
+                ScenarioInputRequest(
+                    key="string",
+                    type=ScenarioInputTypeEnum.TEXT,
+                    chat_history=[
+                        ChatMessageRequest(
+                            role=ChatMessageRole.SYSTEM,
+                        )
+                    ],
+                )
+            ],
+            metric_input_params=SandboxMetricInputParamsRequest(
+                params=EvaluationParamsRequest(),
+            ),
+        )
         """
         _request: typing.Dict[str, typing.Any] = {"inputs": inputs}
         if label is not OMIT:
@@ -181,8 +243,8 @@ class AsyncSandboxesClient:
             api_key="YOUR_API_KEY",
         )
         await client.sandboxes.delete_sandbox_scenario(
-            id="id",
-            scenario_id="scenario-id",
+            id="string",
+            scenario_id="string",
         )
         """
         _response = await self._client_wrapper.httpx_client.request(

vellum/resources/test_suites/client.py

@@ -58,7 +58,7 @@ class TestSuitesClient:
             api_key="YOUR_API_KEY",
         )
         client.test_suites.upsert_test_suite_test_case(
-            id="id",
+            id="string",
             input_values=[],
             evaluation_values=[],
         )
@@ -100,8 +100,8 @@ class TestSuitesClient:
             api_key="YOUR_API_KEY",
         )
         client.test_suites.delete_test_suite_test_case(
-            id="id",
-            test_case_id="test-case-id",
+            id="string",
+            test_case_id="string",
         )
         """
         _response = self._client_wrapper.httpx_client.request(
@@ -160,7 +160,7 @@ class AsyncTestSuitesClient:
             api_key="YOUR_API_KEY",
         )
         await client.test_suites.upsert_test_suite_test_case(
-            id="id",
+            id="string",
             input_values=[],
             evaluation_values=[],
         )
@@ -202,8 +202,8 @@ class AsyncTestSuitesClient:
             api_key="YOUR_API_KEY",
         )
         await client.test_suites.delete_test_suite_test_case(
-            id="id",
-            test_case_id="test-case-id",
+            id="string",
+            test_case_id="string",
         )
         """
         _response = await self._client_wrapper.httpx_client.request(

vellum/resources/workflow_deployments/__init__.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from .types import WorkflowDeploymentsListRequestStatus
+
+__all__ = ["WorkflowDeploymentsListRequestStatus"]

vellum/resources/workflow_deployments/client.py

@@ -0,0 +1,116 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+import urllib.parse
+from json.decoder import JSONDecodeError
+
+from ...core.api_error import ApiError
+from ...core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from ...core.remove_none_from_dict import remove_none_from_dict
+from ...types.paginated_slim_workflow_deployment_list import PaginatedSlimWorkflowDeploymentList
+from .types.workflow_deployments_list_request_status import WorkflowDeploymentsListRequestStatus
+
+try:
+    import pydantic.v1 as pydantic  # type: ignore
+except ImportError:
+    import pydantic  # type: ignore
+
+
+class WorkflowDeploymentsClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    def list(
+        self,
+        *,
+        limit: typing.Optional[int] = None,
+        offset: typing.Optional[int] = None,
+        ordering: typing.Optional[str] = None,
+        status: typing.Optional[WorkflowDeploymentsListRequestStatus] = None,
+    ) -> PaginatedSlimWorkflowDeploymentList:
+        """
+        Parameters:
+            - limit: typing.Optional[int]. Number of results to return per page.
+
+            - offset: typing.Optional[int]. The initial index from which to return the results.
+
+            - ordering: typing.Optional[str]. Which field to use when ordering the results.
+
+            - status: typing.Optional[WorkflowDeploymentsListRequestStatus]. The current status of the workflow deployment
+
+                                                                             - `ACTIVE` - Active
+                                                                             - `ARCHIVED` - Archived---
+        from vellum import WorkflowDeploymentsListRequestStatus
+        from vellum.client import Vellum
+
+        client = Vellum(
+            api_key="YOUR_API_KEY",
+        )
+        client.workflow_deployments.list(
+            status=WorkflowDeploymentsListRequestStatus.ACTIVE,
+        )
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            "GET",
+            urllib.parse.urljoin(f"{self._client_wrapper.get_environment().default}/", "v1/workflow-deployments"),
+            params=remove_none_from_dict({"limit": limit, "offset": offset, "ordering": ordering, "status": status}),
+            headers=self._client_wrapper.get_headers(),
+            timeout=None,
+        )
+        if 200 <= _response.status_code < 300:
+            return pydantic.parse_obj_as(PaginatedSlimWorkflowDeploymentList, _response.json())  # type: ignore
+        try:
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, body=_response.text)
+        raise ApiError(status_code=_response.status_code, body=_response_json)
+
+
+class AsyncWorkflowDeploymentsClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    async def list(
+        self,
+        *,
+        limit: typing.Optional[int] = None,
+        offset: typing.Optional[int] = None,
+        ordering: typing.Optional[str] = None,
+        status: typing.Optional[WorkflowDeploymentsListRequestStatus] = None,
+    ) -> PaginatedSlimWorkflowDeploymentList:
+        """
+        Parameters:
+            - limit: typing.Optional[int]. Number of results to return per page.
+
+            - offset: typing.Optional[int]. The initial index from which to return the results.
+
+            - ordering: typing.Optional[str]. Which field to use when ordering the results.
+
+            - status: typing.Optional[WorkflowDeploymentsListRequestStatus]. The current status of the workflow deployment
+
+                                                                             - `ACTIVE` - Active
+                                                                             - `ARCHIVED` - Archived---
+        from vellum import WorkflowDeploymentsListRequestStatus
+        from vellum.client import AsyncVellum
+
+        client = AsyncVellum(
+            api_key="YOUR_API_KEY",
+        )
+        await client.workflow_deployments.list(
+            status=WorkflowDeploymentsListRequestStatus.ACTIVE,
+        )
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            "GET",
+            urllib.parse.urljoin(f"{self._client_wrapper.get_environment().default}/", "v1/workflow-deployments"),
+            params=remove_none_from_dict({"limit": limit, "offset": offset, "ordering": ordering, "status": status}),
+            headers=self._client_wrapper.get_headers(),
+            timeout=None,
+        )
+        if 200 <= _response.status_code < 300:
+            return pydantic.parse_obj_as(PaginatedSlimWorkflowDeploymentList, _response.json())  # type: ignore
+        try:
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, body=_response.text)
+        raise ApiError(status_code=_response.status_code, body=_response_json)

vellum/resources/workflow_deployments/types/__init__.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from .workflow_deployments_list_request_status import WorkflowDeploymentsListRequestStatus
+
+__all__ = ["WorkflowDeploymentsListRequestStatus"]

vellum/resources/workflow_deployments/types/workflow_deployments_list_request_status.py

@@ -0,0 +1,17 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import enum
+import typing
+
+T_Result = typing.TypeVar("T_Result")
+
+
+class WorkflowDeploymentsListRequestStatus(str, enum.Enum):
+    ACTIVE = "ACTIVE"
+    ARCHIVED = "ARCHIVED"
+
+    def visit(self, active: typing.Callable[[], T_Result], archived: typing.Callable[[], T_Result]) -> T_Result:
+        if self is WorkflowDeploymentsListRequestStatus.ACTIVE:
+            return active()
+        if self is WorkflowDeploymentsListRequestStatus.ARCHIVED:
+            return archived()