vellum-ai 0.8.9 → 0.8.11

package/.mock/definition/adHoc.yml

@@ -0,0 +1,40 @@
+imports:
+  root: __package__.yml
+service:
+  auth: false
+  base-path: ''
+  endpoints:
+    adhoc_execute_prompt_stream:
+      path: /v1/ad-hoc/execute-prompt-stream
+      method: POST
+      auth: true
+      docs: >-
+        An internal-only endpoint that's subject to breaking changes without
+        notice. Not intended for public use.
+      request:
+        name: AdHocExecutePromptStreamRequest
+        body:
+          properties:
+            ml_model:
+              type: string
+              validation:
+                minLength: 1
+            input_values: list<root.PromptRequestInputRequest>
+            input_variables: list<root.VellumVariableRequest>
+            parameters: root.PromptParametersRequest
+            blocks: list<root.PromptBlockRequest>
+            expand_meta: optional<root.AdHocExpandMetaRequest>
+      response-stream:
+        docs: ''
+        type: root.AdHocExecutePromptEvent
+        format: json
+      url: Default
+      availability: pre-release
+      errors:
+        - root.BadRequestError
+        - root.ForbiddenError
+        - root.InternalServerError
+      audiences:
+        - internal
+  source:
+    openapi: openapi/openapi.yml

package/.mock/definition/api.yml

@@ -0,0 +1,17 @@
+name: api
+error-discrimination:
+  strategy: status-code
+display-name: Vellum Client API
+environments:
+  Production:
+    urls:
+      Default: https://api.vellum.ai
+      Documents: https://documents.vellum.ai
+      Predict: https://predict.vellum.ai
+default-environment: Production
+auth-schemes:
+  apiKeyAuth:
+    header: X_API_KEY
+    name: apiKey
+    type: string
+auth: apiKeyAuth

package/.mock/definition/deployments.yml

@@ -0,0 +1,261 @@
+types:
+  DeploymentsListRequestStatus:
+    enum:
+      - ACTIVE
+      - ARCHIVED
+    source:
+      openapi: openapi/openapi.yml
+imports:
+  root: __package__.yml
+service:
+  auth: false
+  base-path: ''
+  endpoints:
+    list:
+      path: /v1/deployments
+      method: GET
+      auth: true
+      docs: Used to list all Prompt Deployments.
+      request:
+        name: DeploymentsListRequest
+        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.
+          ordering:
+            type: optional<string>
+            docs: Which field to use when ordering the results.
+          status:
+            type: optional<DeploymentsListRequestStatus>
+            docs: status
+      response:
+        docs: ''
+        type: root.PaginatedSlimDeploymentReadList
+      url: Default
+      availability: pre-release
+      examples:
+        - 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
+                  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
+      audiences:
+        - customers
+    retrieve:
+      path: /v1/deployments/{id}
+      method: GET
+      auth: true
+      docs: Used to retrieve a Prompt Deployment given its ID or name.
+      path-parameters:
+        id:
+          type: string
+          docs: Either the Deployment's ID or its unique name
+      response:
+        docs: ''
+        type: root.DeploymentRead
+      url: Default
+      availability: pre-release
+      examples:
+        - path-parameters:
+            id: id
+          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
+    retrieve_deployment_release_tag:
+      path: /v1/deployments/{id}/release-tags/{name}
+      method: GET
+      auth: true
+      docs: >-
+        Retrieve a Deployment Release Tag by tag name, associated with a
+        specified Deployment.
+      path-parameters:
+        id:
+          type: string
+          docs: A UUID string identifying this deployment.
+        name:
+          type: string
+          docs: >-
+            The name of the Release Tag associated with this Deployment that
+            you'd like to retrieve.
+      response:
+        docs: ''
+        type: root.DeploymentReleaseTagRead
+      url: Default
+      availability: pre-release
+      examples:
+        - path-parameters:
+            id: id
+            name: name
+          response:
+            body:
+              name: name
+              source: SYSTEM
+              history_item:
+                id: id
+                timestamp: '2024-01-15T09:30:00Z'
+      audiences:
+        - customers
+    update_deployment_release_tag:
+      path: /v1/deployments/{id}/release-tags/{name}
+      method: PATCH
+      auth: true
+      docs: >-
+        Updates an existing Release Tag associated with the specified
+        Deployment.
+      path-parameters:
+        id:
+          type: string
+          docs: A UUID string identifying this deployment.
+        name:
+          type: string
+          docs: >-
+            The name of the Release Tag associated with this Deployment that
+            you'd like to update.
+      request:
+        name: PatchedDeploymentReleaseTagUpdateRequest
+        body:
+          properties:
+            history_item_id:
+              type: optional<string>
+              docs: The ID of the Deployment History Item to tag
+              validation:
+                format: uuid
+      response:
+        docs: ''
+        type: root.DeploymentReleaseTagRead
+      url: Default
+      availability: pre-release
+      examples:
+        - path-parameters:
+            id: id
+            name: name
+          request: {}
+          response:
+            body:
+              name: name
+              source: SYSTEM
+              history_item:
+                id: id
+                timestamp: '2024-01-15T09:30:00Z'
+      audiences:
+        - customers
+    retrieve_provider_payload:
+      path: /v1/deployments/provider-payload
+      method: POST
+      auth: true
+      docs: >
+        Given a set of input variable values, compile the exact payload that
+        Vellum would send to the configured model provider
+
+        for execution if the execute-prompt endpoint had been invoked. Note that
+        this endpoint does not actually execute the
+
+        prompt or make an API call to the model provider.
+
+
+        This endpoint is useful if you don't want to proxy LLM provider requests
+        through Vellum and prefer to send them directly
+
+        to the provider yourself. Note that no guarantees are made on the format
+        of this API's response schema, other than
+
+        that it will be a valid payload for the configured model provider. It's
+        not recommended that you try to parse or
+
+        derive meaning from the response body and instead, should simply pass it
+        directly to the model provider as is.
+
+
+        We encourage you to seek advise from Vellum Support before integrating
+        with this API for production use.
+      request:
+        name: DeploymentProviderPayloadRequest
+        body:
+          properties:
+            deployment_id:
+              type: optional<string>
+              docs: >-
+                The ID of the deployment. Must provide either this or
+                deployment_name.
+              validation:
+                format: uuid
+            deployment_name:
+              type: optional<string>
+              docs: >-
+                The name of the deployment. Must provide either this or
+                deployment_id.
+              validation:
+                minLength: 1
+            inputs:
+              docs: >-
+                The list of inputs defined in the Prompt's deployment with their
+                corresponding values.
+              type: list<root.PromptDeploymentInputRequest>
+            release_tag:
+              type: optional<string>
+              docs: >-
+                Optionally specify a release tag if you want to pin to a
+                specific release of the Workflow Deployment
+              validation:
+                minLength: 1
+            expand_meta: optional<root.CompilePromptDeploymentExpandMetaRequest>
+      response:
+        docs: ''
+        type: root.DeploymentProviderPayloadResponse
+      url: Default
+      availability: pre-release
+      errors:
+        - root.BadRequestError
+        - root.ForbiddenError
+        - root.NotFoundError
+        - root.InternalServerError
+      examples:
+        - request:
+            inputs:
+              - name: name
+                type: STRING
+                value: value
+          response:
+            body:
+              payload:
+                key: value
+              meta:
+                model_name: model_name
+                deployment_release_tag: deployment_release_tag
+                prompt_version_id: prompt_version_id
+      audiences:
+        - customers
+  source:
+    openapi: openapi/openapi.yml