vellum-ai 0.8.9 → 0.8.10

package/.mock/definition/folderEntities.yml

@@ -0,0 +1,41 @@
+service:
+  auth: false
+  base-path: ''
+  endpoints:
+    add_entity_to_folder:
+      path: /v1/folders/{folder_id}/add-entity
+      method: POST
+      auth: true
+      docs: >-
+        Add an entity to a specific folder or root directory.
+
+
+        Adding an entity to a folder will remove it from any other folders it
+        might have been a member of.
+      path-parameters:
+        folder_id:
+          type: string
+          docs: >-
+            The ID of the folder to which the entity should be added. This can
+            be a UUID of a folder, or the name of a root directory (e.g.
+            "PROMPT_SANDBOX").
+      request:
+        name: AddEntityToFolderRequest
+        body:
+          properties:
+            entity_id:
+              type: string
+              docs: The ID of the entity you would like to move.
+              validation:
+                format: uuid
+      url: Default
+      availability: pre-release
+      examples:
+        - path-parameters:
+            folder_id: folder_id
+          request:
+            entity_id: entity_id
+      audiences:
+        - customers
+  source:
+    openapi: openapi/openapi.yml

package/.mock/definition/sandboxes.yml

@@ -0,0 +1,194 @@
+imports:
+  root: __package__.yml
+service:
+  auth: false
+  base-path: ''
+  endpoints:
+    deploy_prompt:
+      path: /v1/sandboxes/{id}/prompts/{prompt_variant_id}/deploy
+      method: POST
+      auth: true
+      path-parameters:
+        id:
+          type: string
+          docs: A UUID string identifying this sandbox.
+        prompt_variant_id:
+          type: string
+          docs: An ID identifying the Prompt you'd like to deploy.
+      request:
+        name: DeploySandboxPromptRequest
+        body:
+          properties:
+            prompt_deployment_id:
+              type: optional<string>
+              docs: >-
+                The Vellum-generated ID of the Prompt Deployment you'd like to
+                update. Cannot specify both this and prompt_deployment_name.
+                Leave null to create a new Prompt Deployment.
+              validation:
+                format: uuid
+            prompt_deployment_name:
+              type: optional<string>
+              docs: >-
+                The unique name of the Prompt Deployment you'd like to either
+                create or update. Cannot specify both this and
+                prompt_deployment_id. If provided and matches an existing Prompt
+                Deployment, that Prompt Deployment will be updated. Otherwise, a
+                new Prompt Deployment will be created.
+              validation:
+                minLength: 1
+            label:
+              type: optional<string>
+              docs: >-
+                In the event that a new Prompt Deployment is created, this will
+                be the label it's given.
+              validation:
+                minLength: 1
+            release_tags:
+              type: optional<list<string>>
+              docs: >-
+                Optionally provide the release tags that you'd like to be
+                associated with the latest release of the created/updated Prompt
+                Deployment.
+      response:
+        docs: ''
+        type: root.DeploymentRead
+      url: Default
+      availability: pre-release
+      examples:
+        - path-parameters:
+            id: id
+            prompt_variant_id: prompt_variant_id
+          request: {}
+          response:
+            body:
+              id: id
+              created: '2024-01-15T09:30:00Z'
+              label: label
+              name: name
+              status: ACTIVE
+              environment: DEVELOPMENT
+              last_deployed_on: '2024-01-15T09:30:00Z'
+              input_variables:
+                - id: id
+                  key: key
+                  type: STRING
+              description: description
+              active_model_version_ids:
+                - active_model_version_ids
+              last_deployed_history_item_id: last_deployed_history_item_id
+      audiences:
+        - customers
+    upsert_sandbox_scenario:
+      path: /v1/sandboxes/{id}/scenarios
+      method: POST
+      auth: true
+      docs: >-
+        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.
+      path-parameters:
+        id:
+          type: string
+          docs: A UUID string identifying this sandbox.
+      request:
+        name: UpsertSandboxScenarioRequest
+        body:
+          properties:
+            label:
+              type: optional<string>
+              default: Untitled Scenario
+            inputs:
+              docs: The inputs for the scenario
+              type: list<root.NamedScenarioInputRequest>
+            scenario_id:
+              type: optional<string>
+              docs: >-
+                The id of the scenario to update. If none is provided, an id
+                will be generated and a new scenario will be appended.
+              validation:
+                minLength: 1
+      response:
+        docs: ''
+        type: root.SandboxScenario
+      url: Default
+      availability: pre-release
+      examples:
+        - name: Basic Example
+          path-parameters:
+            id: id
+          request:
+            label: Scenario 1
+            inputs:
+              - type: STRING
+                value: Hello, world!
+                name: var_1
+              - type: STRING
+                value: Why hello, there!
+                name: var_2
+          response:
+            body:
+              label: label
+              inputs:
+                - type: STRING
+                  value: value
+                  input_variable_id: input_variable_id
+              id: id
+        - name: Chat History Example
+          path-parameters:
+            id: id
+          request:
+            label: Scenario 2
+            inputs:
+              - type: CHAT_HISTORY
+                value:
+                  - text: What's your favorite color?
+                    role: USER
+                  - text: AI's don't have a favorite color.... Yet.
+                    role: ASSISTANT
+                name: chat_history
+          response:
+            body:
+              label: label
+              inputs:
+                - type: STRING
+                  value: value
+                  input_variable_id: input_variable_id
+              id: id
+      audiences:
+        - customers
+    delete_sandbox_scenario:
+      path: /v1/sandboxes/{id}/scenarios/{scenario_id}
+      method: DELETE
+      auth: true
+      docs: >-
+        Deletes an existing scenario from a sandbox, keying off of the provided
+        scenario id.
+      path-parameters:
+        id:
+          type: string
+          docs: A UUID string identifying this sandbox.
+        scenario_id:
+          type: string
+          docs: An id identifying the scenario that you'd like to delete
+      url: Default
+      availability: pre-release
+      examples:
+        - path-parameters:
+            id: id
+            scenario_id: scenario_id
+      audiences:
+        - customers
+  source:
+    openapi: openapi/openapi.yml

package/.mock/definition/testSuiteRuns.yml

@@ -0,0 +1,148 @@
+imports:
+  root: __package__.yml
+service:
+  auth: false
+  base-path: ''
+  endpoints:
+    create:
+      path: /v1/test-suite-runs
+      method: POST
+      auth: true
+      docs: Trigger a Test Suite and create a new Test Suite Run
+      request:
+        name: TestSuiteRunCreateRequest
+        body:
+          properties:
+            test_suite_id:
+              type: string
+              docs: The ID of the Test Suite to run
+              validation:
+                format: uuid
+            exec_config:
+              type: root.TestSuiteRunExecConfigRequest
+              docs: Configuration that defines how the Test Suite should be run
+      response:
+        docs: ''
+        type: root.TestSuiteRunRead
+      url: Default
+      availability: pre-release
+      examples:
+        - request:
+            test_suite_id: test_suite_id
+            exec_config:
+              type: DEPLOYMENT_RELEASE_TAG
+              data:
+                deployment_id: deployment_id
+          response:
+            body:
+              id: id
+              created: '2024-01-15T09:30:00Z'
+              test_suite:
+                id: id
+                history_item_id: history_item_id
+                label: label
+              state: QUEUED
+              exec_config:
+                type: DEPLOYMENT_RELEASE_TAG
+                data:
+                  deployment_id: deployment_id
+                  tag: tag
+                test_case_ids:
+                  - test_case_ids
+      audiences:
+        - customers
+    retrieve:
+      path: /v1/test-suite-runs/{id}
+      method: GET
+      auth: true
+      docs: Retrieve a specific Test Suite Run by ID
+      path-parameters:
+        id:
+          type: string
+          docs: A UUID string identifying this test suite run.
+      response:
+        docs: ''
+        type: root.TestSuiteRunRead
+      url: Default
+      availability: pre-release
+      examples:
+        - path-parameters:
+            id: id
+          response:
+            body:
+              id: id
+              created: '2024-01-15T09:30:00Z'
+              test_suite:
+                id: id
+                history_item_id: history_item_id
+                label: label
+              state: QUEUED
+              exec_config:
+                type: DEPLOYMENT_RELEASE_TAG
+                data:
+                  deployment_id: deployment_id
+                  tag: tag
+                test_case_ids:
+                  - test_case_ids
+      audiences:
+        - customers
+    listExecutions:
+      path: /v1/test-suite-runs/{id}/executions
+      method: GET
+      auth: true
+      path-parameters:
+        id:
+          type: string
+          docs: A UUID string identifying this test suite run.
+      request:
+        name: TestSuiteRunsListExecutionsRequest
+        query-parameters:
+          expand:
+            type: optional<string>
+            allow-multiple: true
+            docs: >-
+              The response fields to expand for more information.
+
+              - 'results.metric_results.metric_label' expands the metric label
+              for each metric result.
+
+              - 'results.metric_results.metric_definition' expands the metric
+              definition for each metric result.
+
+              - 'results.metric_results.metric_definition.name' expands the
+              metric definition name for each metric result.
+          limit:
+            type: optional<integer>
+            docs: Number of results to return per page.
+          offset:
+            type: optional<integer>
+            docs: The initial index from which to return the results.
+      response:
+        docs: ''
+        type: root.PaginatedTestSuiteRunExecutionList
+      url: Default
+      availability: pre-release
+      examples:
+        - path-parameters:
+            id: id
+          response:
+            body:
+              count: 123
+              next: http://api.example.org/accounts/?offset=400&limit=100
+              previous: http://api.example.org/accounts/?offset=200&limit=100
+              results:
+                - id: id
+                  test_case_id: test_case_id
+                  outputs:
+                    - name: name
+                      type: STRING
+                      output_variable_id: output_variable_id
+                  metric_results:
+                    - metric_id: metric_id
+                      outputs:
+                        - type: STRING
+                          name: name
+      audiences:
+        - customers
+  source:
+    openapi: openapi/openapi.yml

package/.mock/definition/testSuites.yml

@@ -0,0 +1,153 @@
+imports:
+  root: __package__.yml
+service:
+  auth: false
+  base-path: ''
+  endpoints:
+    list_test_suite_test_cases:
+      path: /v1/test-suites/{id}/test-cases
+      method: GET
+      auth: true
+      docs: List the Test Cases associated with a Test Suite
+      path-parameters:
+        id:
+          type: string
+          docs: A UUID string identifying this test suite.
+      request:
+        name: ListTestSuiteTestCasesRequest
+        query-parameters:
+          limit:
+            type: optional<integer>
+            docs: Number of results to return per page.
+          offset:
+            type: optional<integer>
+            docs: The initial index from which to return the results.
+      response:
+        docs: ''
+        type: root.PaginatedTestSuiteTestCaseList
+      url: Default
+      availability: pre-release
+      examples:
+        - path-parameters:
+            id: id
+          response:
+            body:
+              count: 123
+              next: http://api.example.org/accounts/?offset=400&limit=100
+              previous: http://api.example.org/accounts/?offset=200&limit=100
+              results:
+                - id: id
+                  external_id: external_id
+                  label: label
+                  input_values:
+                    - variable_id: variable_id
+                      name: name
+                      type: STRING
+                  evaluation_values:
+                    - variable_id: variable_id
+                      name: name
+                      type: STRING
+      audiences:
+        - customers
+    upsert_test_suite_test_case:
+      path: /v1/test-suites/{id}/test-cases
+      method: POST
+      auth: true
+      docs: >-
+        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.
+      path-parameters:
+        id:
+          type: string
+          docs: A UUID string identifying this test suite.
+      request:
+        body: root.UpsertTestSuiteTestCaseRequest
+      response:
+        docs: ''
+        type: root.TestSuiteTestCase
+      url: Default
+      availability: pre-release
+      examples:
+        - path-parameters:
+            id: id
+          request:
+            input_values:
+              - type: STRING
+                name: name
+            evaluation_values:
+              - type: STRING
+                name: name
+          response:
+            body:
+              id: id
+              external_id: external_id
+              label: label
+              input_values:
+                - variable_id: variable_id
+                  name: name
+                  type: STRING
+                  value: value
+              evaluation_values:
+                - variable_id: variable_id
+                  name: name
+                  type: STRING
+                  value: value
+      audiences:
+        - customers
+    test_suite_test_cases_bulk:
+      path: /v1/test-suites/{id}/test-cases-bulk
+      method: POST
+      auth: true
+      docs: >-
+        Created, replace, and delete Test Cases within the specified Test Suite
+        in bulk
+      path-parameters:
+        id:
+          type: string
+          docs: A UUID string identifying this test suite.
+      request:
+        body: list<root.TestSuiteTestCaseBulkOperationRequest>
+      response-stream:
+        docs: ''
+        type: list<root.TestSuiteTestCaseBulkResult>
+        format: json
+      url: Default
+      availability: pre-release
+      audiences:
+        - customers
+    delete_test_suite_test_case:
+      path: /v1/test-suites/{id}/test-cases/{test_case_id}
+      method: DELETE
+      auth: true
+      docs: >
+        Deletes an existing test case for a test suite, keying off of the test
+        case id.
+      path-parameters:
+        id:
+          type: string
+          docs: A UUID string identifying this test suite.
+        test_case_id:
+          type: string
+          docs: An id identifying the test case that you'd like to delete
+      url: Default
+      availability: pre-release
+      examples:
+        - path-parameters:
+            id: id
+            test_case_id: test_case_id
+      audiences:
+        - customers
+  source:
+    openapi: openapi/openapi.yml