vellum-ai 0.0.18__py3-none-any.whl → 0.0.25__py3-none-any.whl

vellum/resources/registered_prompts/client.py

@@ -4,12 +4,11 @@ import typing
 import urllib.parse
 from json.decoder import JSONDecodeError
 
-import httpx
 import pydantic
 
 from ...core.api_error import ApiError
+from ...core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
 from ...core.jsonable_encoder import jsonable_encoder
-from ...core.remove_none_from_headers import remove_none_from_headers
 from ...environment import VellumEnvironment
 from ...errors.conflict_error import ConflictError
 from ...types.provider_enum import ProviderEnum
@@ -23,9 +22,11 @@ OMIT = typing.cast(typing.Any, ...)
 
 
 class RegisteredPromptsClient:
-    def __init__(self, *, environment: VellumEnvironment = VellumEnvironment.PRODUCTION, api_key: str):
+    def __init__(
+        self, *, environment: VellumEnvironment = VellumEnvironment.PRODUCTION, client_wrapper: SyncClientWrapper
+    ):
         self._environment = environment
-        self.api_key = api_key
+        self._client_wrapper = client_wrapper
 
     def register_prompt(
         self,
@@ -38,6 +39,37 @@ class RegisteredPromptsClient:
         parameters: RegisterPromptModelParametersRequest,
         meta: typing.Optional[typing.Dict[str, typing.Any]] = OMIT,
     ) -> RegisterPromptResponse:
+        """
+        <strong style="background-color:#ffc107; color:white; padding:4px; border-radius:4px">Unstable</strong>
+
+        Registers a prompt within Vellum and creates associated Vellum entities. Intended to be used by integration
+        partners, not directly by Vellum users.
+
+        Under the hood, this endpoint creates a new sandbox, a new model version, and a new deployment.
+
+        Parameters:
+            - label: str. A human-friendly label for corresponding entities created in Vellum. <span style="white-space: nowrap">`non-empty`</span>
+
+            - name: str. A uniquely-identifying name for corresponding entities created in Vellum. <span style="white-space: nowrap">`non-empty`</span>
+
+            - prompt: RegisterPromptPromptInfoRequest. Information about how to execute the prompt template.
+
+            - provider: ProviderEnum. The initial LLM provider to use for this prompt
+
+                                      * `ANTHROPIC` - Anthropic
+                                      * `COHERE` - Cohere
+                                      * `GOOGLE` - Google
+                                      * `HOSTED` - Hosted
+                                      * `MOSAICML` - MosaicML
+                                      * `MYSTIC` - Mystic
+                                      * `OPENAI` - OpenAI
+                                      * `PYQ` - Pyq
+            - model: str. The initial model to use for this prompt <span style="white-space: nowrap">`non-empty`</span>
+
+            - 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.
+        """
         _request: typing.Dict[str, typing.Any] = {
             "label": label,
             "name": name,
@@ -48,11 +80,11 @@ class RegisteredPromptsClient:
         }
         if meta is not OMIT:
             _request["meta"] = meta
-        _response = httpx.request(
+        _response = self._client_wrapper.httpx_client.request(
             "POST",
             urllib.parse.urljoin(f"{self._environment.default}/", "v1/registered-prompts/register"),
             json=jsonable_encoder(_request),
-            headers=remove_none_from_headers({"X_API_KEY": self.api_key}),
+            headers=self._client_wrapper.get_headers(),
             timeout=None,
         )
         if 200 <= _response.status_code < 300:
@@ -67,9 +99,11 @@ class RegisteredPromptsClient:
 
 
 class AsyncRegisteredPromptsClient:
-    def __init__(self, *, environment: VellumEnvironment = VellumEnvironment.PRODUCTION, api_key: str):
+    def __init__(
+        self, *, environment: VellumEnvironment = VellumEnvironment.PRODUCTION, client_wrapper: AsyncClientWrapper
+    ):
         self._environment = environment
-        self.api_key = api_key
+        self._client_wrapper = client_wrapper
 
     async def register_prompt(
         self,
@@ -82,6 +116,37 @@ class AsyncRegisteredPromptsClient:
         parameters: RegisterPromptModelParametersRequest,
         meta: typing.Optional[typing.Dict[str, typing.Any]] = OMIT,
     ) -> RegisterPromptResponse:
+        """
+        <strong style="background-color:#ffc107; color:white; padding:4px; border-radius:4px">Unstable</strong>
+
+        Registers a prompt within Vellum and creates associated Vellum entities. Intended to be used by integration
+        partners, not directly by Vellum users.
+
+        Under the hood, this endpoint creates a new sandbox, a new model version, and a new deployment.
+
+        Parameters:
+            - label: str. A human-friendly label for corresponding entities created in Vellum. <span style="white-space: nowrap">`non-empty`</span>
+
+            - name: str. A uniquely-identifying name for corresponding entities created in Vellum. <span style="white-space: nowrap">`non-empty`</span>
+
+            - prompt: RegisterPromptPromptInfoRequest. Information about how to execute the prompt template.
+
+            - provider: ProviderEnum. The initial LLM provider to use for this prompt
+
+                                      * `ANTHROPIC` - Anthropic
+                                      * `COHERE` - Cohere
+                                      * `GOOGLE` - Google
+                                      * `HOSTED` - Hosted
+                                      * `MOSAICML` - MosaicML
+                                      * `MYSTIC` - Mystic
+                                      * `OPENAI` - OpenAI
+                                      * `PYQ` - Pyq
+            - model: str. The initial model to use for this prompt <span style="white-space: nowrap">`non-empty`</span>
+
+            - 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.
+        """
         _request: typing.Dict[str, typing.Any] = {
             "label": label,
             "name": name,
@@ -92,14 +157,13 @@ class AsyncRegisteredPromptsClient:
         }
         if meta is not OMIT:
             _request["meta"] = meta
-        async with httpx.AsyncClient() as _client:
-            _response = await _client.request(
-                "POST",
-                urllib.parse.urljoin(f"{self._environment.default}/", "v1/registered-prompts/register"),
-                json=jsonable_encoder(_request),
-                headers=remove_none_from_headers({"X_API_KEY": self.api_key}),
-                timeout=None,
-            )
+        _response = await self._client_wrapper.httpx_client.request(
+            "POST",
+            urllib.parse.urljoin(f"{self._environment.default}/", "v1/registered-prompts/register"),
+            json=jsonable_encoder(_request),
+            headers=self._client_wrapper.get_headers(),
+            timeout=None,
+        )
         if 200 <= _response.status_code < 300:
             return pydantic.parse_obj_as(RegisterPromptResponse, _response.json())  # type: ignore
         if _response.status_code == 409:

vellum/resources/sandboxes/client.py

@@ -4,12 +4,11 @@ import typing
 import urllib.parse
 from json.decoder import JSONDecodeError
 
-import httpx
 import pydantic
 
 from ...core.api_error import ApiError
+from ...core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
 from ...core.jsonable_encoder import jsonable_encoder
-from ...core.remove_none_from_headers import remove_none_from_headers
 from ...environment import VellumEnvironment
 from ...types.sandbox_metric_input_params_request import SandboxMetricInputParamsRequest
 from ...types.sandbox_scenario import SandboxScenario
@@ -20,9 +19,11 @@ OMIT = typing.cast(typing.Any, ...)
 
 
 class SandboxesClient:
-    def __init__(self, *, environment: VellumEnvironment = VellumEnvironment.PRODUCTION, api_key: str):
+    def __init__(
+        self, *, environment: VellumEnvironment = VellumEnvironment.PRODUCTION, client_wrapper: SyncClientWrapper
+    ):
         self._environment = environment
-        self.api_key = api_key
+        self._client_wrapper = client_wrapper
 
     def upsert_sandbox_scenario(
         self,
@@ -33,6 +34,28 @@ class SandboxesClient:
         scenario_id: typing.Optional[str] = OMIT,
         metric_input_params: typing.Optional[SandboxMetricInputParamsRequest] = OMIT,
     ) -> SandboxScenario:
+        """
+        <strong style="background-color:#ffc107; color:white; padding:4px; border-radius:4px">Unstable</strong>
+
+        Upserts a new scenario for a sandbox, keying off of the optionally provided scenario id.
+
+        If an id is provided and has a match, the scenario will be updated. If no id is provided or no match
+        is found, a new scenario will be appended to the end.
+
+        Note that a full replacement of the scenario is performed, so any fields not provided will be removed
+        or overwritten with default values.
+
+        Parameters:
+            - id: str. A UUID string identifying this sandbox.
+
+            - label: typing.Optional[str].
+
+            - inputs: typing.List[ScenarioInputRequest]. The inputs for the scenario
+
+            - 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. <span style="white-space: nowrap">`non-empty`</span>
+
+            - metric_input_params: typing.Optional[SandboxMetricInputParamsRequest].
+        """
         _request: typing.Dict[str, typing.Any] = {"inputs": inputs}
         if label is not OMIT:
             _request["label"] = label
@@ -40,11 +63,11 @@ class SandboxesClient:
             _request["scenario_id"] = scenario_id
         if metric_input_params is not OMIT:
             _request["metric_input_params"] = metric_input_params
-        _response = httpx.request(
+        _response = self._client_wrapper.httpx_client.request(
             "POST",
             urllib.parse.urljoin(f"{self._environment.default}/", f"v1/sandboxes/{id}/scenarios"),
             json=jsonable_encoder(_request),
-            headers=remove_none_from_headers({"X_API_KEY": self.api_key}),
+            headers=self._client_wrapper.get_headers(),
             timeout=None,
         )
         if 200 <= _response.status_code < 300:
@@ -56,10 +79,20 @@ class SandboxesClient:
         raise ApiError(status_code=_response.status_code, body=_response_json)
 
     def delete_sandbox_scenario(self, id: str, scenario_id: str) -> None:
-        _response = httpx.request(
+        """
+        <strong style="background-color:#ffc107; color:white; padding:4px; border-radius:4px">Unstable</strong>
+
+        Deletes an existing scenario from a sandbox, keying off of the provided scenario id.
+
+        Parameters:
+            - id: str. A UUID string identifying this sandbox.
+
+            - scenario_id: str. An id identifying the scenario that you'd like to delete
+        """
+        _response = self._client_wrapper.httpx_client.request(
             "DELETE",
             urllib.parse.urljoin(f"{self._environment.default}/", f"v1/sandboxes/{id}/scenarios/{scenario_id}"),
-            headers=remove_none_from_headers({"X_API_KEY": self.api_key}),
+            headers=self._client_wrapper.get_headers(),
             timeout=None,
         )
         if 200 <= _response.status_code < 300:
@@ -72,9 +105,11 @@ class SandboxesClient:
 
 
 class AsyncSandboxesClient:
-    def __init__(self, *, environment: VellumEnvironment = VellumEnvironment.PRODUCTION, api_key: str):
+    def __init__(
+        self, *, environment: VellumEnvironment = VellumEnvironment.PRODUCTION, client_wrapper: AsyncClientWrapper
+    ):
         self._environment = environment
-        self.api_key = api_key
+        self._client_wrapper = client_wrapper
 
     async def upsert_sandbox_scenario(
         self,
@@ -85,6 +120,28 @@ class AsyncSandboxesClient:
         scenario_id: typing.Optional[str] = OMIT,
         metric_input_params: typing.Optional[SandboxMetricInputParamsRequest] = OMIT,
     ) -> SandboxScenario:
+        """
+        <strong style="background-color:#ffc107; color:white; padding:4px; border-radius:4px">Unstable</strong>
+
+        Upserts a new scenario for a sandbox, keying off of the optionally provided scenario id.
+
+        If an id is provided and has a match, the scenario will be updated. If no id is provided or no match
+        is found, a new scenario will be appended to the end.
+
+        Note that a full replacement of the scenario is performed, so any fields not provided will be removed
+        or overwritten with default values.
+
+        Parameters:
+            - id: str. A UUID string identifying this sandbox.
+
+            - label: typing.Optional[str].
+
+            - inputs: typing.List[ScenarioInputRequest]. The inputs for the scenario
+
+            - 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. <span style="white-space: nowrap">`non-empty`</span>
+
+            - metric_input_params: typing.Optional[SandboxMetricInputParamsRequest].
+        """
         _request: typing.Dict[str, typing.Any] = {"inputs": inputs}
         if label is not OMIT:
             _request["label"] = label
@@ -92,14 +149,13 @@ class AsyncSandboxesClient:
             _request["scenario_id"] = scenario_id
         if metric_input_params is not OMIT:
             _request["metric_input_params"] = metric_input_params
-        async with httpx.AsyncClient() as _client:
-            _response = await _client.request(
-                "POST",
-                urllib.parse.urljoin(f"{self._environment.default}/", f"v1/sandboxes/{id}/scenarios"),
-                json=jsonable_encoder(_request),
-                headers=remove_none_from_headers({"X_API_KEY": self.api_key}),
-                timeout=None,
-            )
+        _response = await self._client_wrapper.httpx_client.request(
+            "POST",
+            urllib.parse.urljoin(f"{self._environment.default}/", f"v1/sandboxes/{id}/scenarios"),
+            json=jsonable_encoder(_request),
+            headers=self._client_wrapper.get_headers(),
+            timeout=None,
+        )
         if 200 <= _response.status_code < 300:
             return pydantic.parse_obj_as(SandboxScenario, _response.json())  # type: ignore
         try:
@@ -109,13 +165,22 @@ class AsyncSandboxesClient:
         raise ApiError(status_code=_response.status_code, body=_response_json)
 
     async def delete_sandbox_scenario(self, id: str, scenario_id: str) -> None:
-        async with httpx.AsyncClient() as _client:
-            _response = await _client.request(
-                "DELETE",
-                urllib.parse.urljoin(f"{self._environment.default}/", f"v1/sandboxes/{id}/scenarios/{scenario_id}"),
-                headers=remove_none_from_headers({"X_API_KEY": self.api_key}),
-                timeout=None,
-            )
+        """
+        <strong style="background-color:#ffc107; color:white; padding:4px; border-radius:4px">Unstable</strong>
+
+        Deletes an existing scenario from a sandbox, keying off of the provided scenario id.
+
+        Parameters:
+            - id: str. A UUID string identifying this sandbox.
+
+            - scenario_id: str. An id identifying the scenario that you'd like to delete
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            "DELETE",
+            urllib.parse.urljoin(f"{self._environment.default}/", f"v1/sandboxes/{id}/scenarios/{scenario_id}"),
+            headers=self._client_wrapper.get_headers(),
+            timeout=None,
+        )
         if 200 <= _response.status_code < 300:
             return
         try:

vellum/resources/test_suites/client.py

@@ -4,12 +4,11 @@ import typing
 import urllib.parse
 from json.decoder import JSONDecodeError
 
-import httpx
 import pydantic
 
 from ...core.api_error import ApiError
+from ...core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
 from ...core.jsonable_encoder import jsonable_encoder
-from ...core.remove_none_from_headers import remove_none_from_headers
 from ...environment import VellumEnvironment
 from ...types.evaluation_params_request import EvaluationParamsRequest
 from ...types.test_suite_test_case import TestSuiteTestCase
@@ -19,9 +18,11 @@ OMIT = typing.cast(typing.Any, ...)
 
 
 class TestSuitesClient:
-    def __init__(self, *, environment: VellumEnvironment = VellumEnvironment.PRODUCTION, api_key: str):
+    def __init__(
+        self, *, environment: VellumEnvironment = VellumEnvironment.PRODUCTION, client_wrapper: SyncClientWrapper
+    ):
         self._environment = environment
-        self.api_key = api_key
+        self._client_wrapper = client_wrapper
 
     def upsert_test_suite_test_case(
         self,
@@ -32,16 +33,38 @@ class TestSuitesClient:
         input_values: typing.Dict[str, typing.Any],
         evaluation_params: EvaluationParamsRequest,
     ) -> TestSuiteTestCase:
+        """
+        <strong style="background-color:#ffc107; color:white; padding:4px; border-radius:4px">Unstable</strong>
+
+        Upserts a new test case for a test suite, keying off of the optionally provided test case id.
+
+        If an id is provided and has a match, the test case will be updated. If no id is provided or no match
+        is found, a new test case will be appended to the end.
+
+        Note that a full replacement of the test case is performed, so any fields not provided will be removed
+        or overwritten with default values.
+
+        Parameters:
+            - id: str. A UUID string identifying this test suite.
+
+            - test_case_id: typing.Optional[str]. The id of the test case to update. If none is provided, an id will be generated and a new test case will be appended. <span style="white-space: nowrap">`non-empty`</span>
+
+            - label: typing.Optional[str]. A human-friendly label for the test case.
+
+            - input_values: typing.Dict[str, typing.Any]. Key/value pairs for each input variable that the Test Suite expects.
+
+            - evaluation_params: EvaluationParamsRequest. Parameters to use when evaluating the test case, specific to the test suite's evaluation metric.
+        """
         _request: typing.Dict[str, typing.Any] = {"input_values": input_values, "evaluation_params": evaluation_params}
         if test_case_id is not OMIT:
             _request["test_case_id"] = test_case_id
         if label is not OMIT:
             _request["label"] = label
-        _response = httpx.request(
+        _response = self._client_wrapper.httpx_client.request(
             "POST",
             urllib.parse.urljoin(f"{self._environment.default}/", f"v1/test-suites/{id}/test-cases"),
             json=jsonable_encoder(_request),
-            headers=remove_none_from_headers({"X_API_KEY": self.api_key}),
+            headers=self._client_wrapper.get_headers(),
             timeout=None,
         )
         if 200 <= _response.status_code < 300:
@@ -53,10 +76,20 @@ class TestSuitesClient:
         raise ApiError(status_code=_response.status_code, body=_response_json)
 
     def delete_test_suite_test_case(self, id: str, test_case_id: str) -> None:
-        _response = httpx.request(
+        """
+        <strong style="background-color:#ffc107; color:white; padding:4px; border-radius:4px">Unstable</strong>
+
+        Deletes an existing test case for a test suite, keying off of the test case id.
+
+        Parameters:
+            - id: str. A UUID string identifying this test suite.
+
+            - test_case_id: str. An id identifying the test case that you'd like to delete
+        """
+        _response = self._client_wrapper.httpx_client.request(
             "DELETE",
             urllib.parse.urljoin(f"{self._environment.default}/", f"v1/test-suites/{id}/test-cases/{test_case_id}"),
-            headers=remove_none_from_headers({"X_API_KEY": self.api_key}),
+            headers=self._client_wrapper.get_headers(),
             timeout=None,
         )
         if 200 <= _response.status_code < 300:
@@ -69,9 +102,11 @@ class TestSuitesClient:
 
 
 class AsyncTestSuitesClient:
-    def __init__(self, *, environment: VellumEnvironment = VellumEnvironment.PRODUCTION, api_key: str):
+    def __init__(
+        self, *, environment: VellumEnvironment = VellumEnvironment.PRODUCTION, client_wrapper: AsyncClientWrapper
+    ):
         self._environment = environment
-        self.api_key = api_key
+        self._client_wrapper = client_wrapper
 
     async def upsert_test_suite_test_case(
         self,
@@ -82,19 +117,40 @@ class AsyncTestSuitesClient:
         input_values: typing.Dict[str, typing.Any],
         evaluation_params: EvaluationParamsRequest,
     ) -> TestSuiteTestCase:
+        """
+        <strong style="background-color:#ffc107; color:white; padding:4px; border-radius:4px">Unstable</strong>
+
+        Upserts a new test case for a test suite, keying off of the optionally provided test case id.
+
+        If an id is provided and has a match, the test case will be updated. If no id is provided or no match
+        is found, a new test case will be appended to the end.
+
+        Note that a full replacement of the test case is performed, so any fields not provided will be removed
+        or overwritten with default values.
+
+        Parameters:
+            - id: str. A UUID string identifying this test suite.
+
+            - test_case_id: typing.Optional[str]. The id of the test case to update. If none is provided, an id will be generated and a new test case will be appended. <span style="white-space: nowrap">`non-empty`</span>
+
+            - label: typing.Optional[str]. A human-friendly label for the test case.
+
+            - input_values: typing.Dict[str, typing.Any]. Key/value pairs for each input variable that the Test Suite expects.
+
+            - evaluation_params: EvaluationParamsRequest. Parameters to use when evaluating the test case, specific to the test suite's evaluation metric.
+        """
         _request: typing.Dict[str, typing.Any] = {"input_values": input_values, "evaluation_params": evaluation_params}
         if test_case_id is not OMIT:
             _request["test_case_id"] = test_case_id
         if label is not OMIT:
             _request["label"] = label
-        async with httpx.AsyncClient() as _client:
-            _response = await _client.request(
-                "POST",
-                urllib.parse.urljoin(f"{self._environment.default}/", f"v1/test-suites/{id}/test-cases"),
-                json=jsonable_encoder(_request),
-                headers=remove_none_from_headers({"X_API_KEY": self.api_key}),
-                timeout=None,
-            )
+        _response = await self._client_wrapper.httpx_client.request(
+            "POST",
+            urllib.parse.urljoin(f"{self._environment.default}/", f"v1/test-suites/{id}/test-cases"),
+            json=jsonable_encoder(_request),
+            headers=self._client_wrapper.get_headers(),
+            timeout=None,
+        )
         if 200 <= _response.status_code < 300:
             return pydantic.parse_obj_as(TestSuiteTestCase, _response.json())  # type: ignore
         try:
@@ -104,13 +160,22 @@ class AsyncTestSuitesClient:
         raise ApiError(status_code=_response.status_code, body=_response_json)
 
     async def delete_test_suite_test_case(self, id: str, test_case_id: str) -> None:
-        async with httpx.AsyncClient() as _client:
-            _response = await _client.request(
-                "DELETE",
-                urllib.parse.urljoin(f"{self._environment.default}/", f"v1/test-suites/{id}/test-cases/{test_case_id}"),
-                headers=remove_none_from_headers({"X_API_KEY": self.api_key}),
-                timeout=None,
-            )
+        """
+        <strong style="background-color:#ffc107; color:white; padding:4px; border-radius:4px">Unstable</strong>
+
+        Deletes an existing test case for a test suite, keying off of the test case id.
+
+        Parameters:
+            - id: str. A UUID string identifying this test suite.
+
+            - test_case_id: str. An id identifying the test case that you'd like to delete
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            "DELETE",
+            urllib.parse.urljoin(f"{self._environment.default}/", f"v1/test-suites/{id}/test-cases/{test_case_id}"),
+            headers=self._client_wrapper.get_headers(),
+            timeout=None,
+        )
         if 200 <= _response.status_code < 300:
             return
         try: