vellum-ai 0.10.5 → 0.10.7

package/.mock/definition/__package__.yml

@@ -2,15 +2,38 @@ errors:
   BadRequestError:
     status-code: 400
     type: unknown
+    docs: ''
+    examples:
+      - value:
+          detail: detail
+      - value:
+          message: message
+          log: log
+      - value:
+          key: value
   ForbiddenError:
     status-code: 403
     type: unknown
+    docs: ''
+    examples:
+      - value:
+          detail: detail
   InternalServerError:
     status-code: 500
     type: unknown
+    docs: ''
+    examples:
+      - value:
+          detail: detail
   NotFoundError:
     status-code: 404
     type: unknown
+    docs: ''
+    examples:
+      - value:
+          detail: detail
+      - value:
+          key: value
 service:
   auth: false
   base-path: ''
@@ -22,6 +45,8 @@ service:
       docs: >-
         An internal-only endpoint that's subject to breaking changes without
         notice. Not intended for public use.
+      source:
+        openapi: openapi/openapi.yml
       request:
         name: CodeExecutor
         body:
@@ -34,6 +59,7 @@ service:
             input_values: list<CodeExecutorInput>
             packages: list<CodeExecutionPackage>
             output_type: VellumVariableType
+        content-type: application/json
       response:
         docs: ''
         type: CodeExecutorResponse
@@ -66,6 +92,8 @@ service:
       method: POST
       auth: true
       docs: Executes a deployed Prompt and returns the result.
+      source:
+        openapi: openapi/openapi.yml
       request:
         name: ExecutePromptRequest
         body:
@@ -130,6 +158,7 @@ service:
                 Arbitrary JSON metadata associated with this request. Can be
                 used to capture additional monitoring data such as user id,
                 session id, etc. for future analysis.
+        content-type: application/json
       response:
         docs: ''
         type: ExecutePromptResponse
@@ -179,6 +208,8 @@ service:
       method: POST
       auth: true
       docs: Executes a deployed Prompt and streams back the results.
+      source:
+        openapi: openapi/openapi.yml
       request:
         name: ExecutePromptStreamRequest
         body:
@@ -243,6 +274,7 @@ service:
                 Arbitrary JSON metadata associated with this request. Can be
                 used to capture additional monitoring data such as user id,
                 session id, etc. for future analysis.
+        content-type: application/json
       response-stream:
         docs: ''
         type: ExecutePromptEvent
@@ -254,6 +286,21 @@ service:
         - ForbiddenError
         - NotFoundError
         - InternalServerError
+      examples:
+        - request:
+            inputs:
+              - name: name
+                type: STRING
+                value: value
+          response:
+            stream:
+              - state: INITIATED
+                meta:
+                  model_name: model_name
+                  latency: 1
+                  deployment_release_tag: deployment_release_tag
+                  prompt_version_id: prompt_version_id
+                execution_id: execution_id
       audiences:
         - customers
     execute-workflow:
@@ -261,6 +308,8 @@ service:
       method: POST
       auth: true
       docs: Executes a deployed Workflow and returns its outputs.
+      source:
+        openapi: openapi/openapi.yml
       request:
         name: ExecuteWorkflowRequest
         body:
@@ -312,6 +361,7 @@ service:
                 Arbitrary JSON metadata associated with this request. Can be
                 used to capture additional monitoring data such as user id,
                 session id, etc. for future analysis.
+        content-type: application/json
       response:
         docs: ''
         type: ExecuteWorkflowResponse
@@ -347,6 +397,8 @@ service:
       method: POST
       auth: true
       docs: Executes a deployed Workflow and streams back its results.
+      source:
+        openapi: openapi/openapi.yml
       request:
         name: ExecuteWorkflowStreamRequest
         body:
@@ -404,6 +456,7 @@ service:
                 Arbitrary JSON metadata associated with this request. Can be
                 used to capture additional monitoring data such as user id,
                 session id, etc. for future analysis.
+        content-type: application/json
       response-stream:
         docs: ''
         type: WorkflowStreamEvent
@@ -414,6 +467,41 @@ service:
         - BadRequestError
         - NotFoundError
         - InternalServerError
+      examples:
+        - request:
+            inputs:
+              - name: name
+                type: STRING
+                value: value
+          response:
+            stream:
+              - execution_id: execution_id
+                run_id: run_id
+                external_id: external_id
+                type: WORKFLOW
+                data:
+                  id: id
+                  state: INITIATED
+                  ts: '2024-01-15T09:30:00Z'
+                  output:
+                    id: id
+                    name: name
+                    state: INITIATED
+                    node_id: node_id
+                    delta: delta
+                    type: STRING
+                    value: value
+                  error:
+                    message: message
+                    code: WORKFLOW_INITIALIZATION
+                  outputs:
+                    - id: id
+                      name: name
+                      type: STRING
+                  inputs:
+                    - id: id
+                      name: name
+                      type: STRING
       audiences:
         - customers
     generate:
@@ -425,6 +513,8 @@ service:
 
         Important: This endpoint is DEPRECATED and has been superseded by
         [execute-prompt](/api-reference/api-reference/execute-prompt).
+      source:
+        openapi: openapi/openapi.yml
       request:
         name: GenerateBodyRequest
         body:
@@ -453,6 +543,7 @@ service:
               docs: >-
                 Additional configuration that can be used to control what's
                 included in the response.
+        content-type: application/json
       response:
         docs: ''
         type: GenerateResponse
@@ -493,6 +584,8 @@ service:
         Important: This endpoint is DEPRECATED and has been superseded by
 
         [execute-prompt-stream](/api-reference/api-reference/execute-prompt-stream).
+      source:
+        openapi: openapi/openapi.yml
       request:
         name: GenerateStreamBodyRequest
         body:
@@ -521,6 +614,7 @@ service:
               docs: >-
                 Additional configuration that can be used to control what's
                 included in the response.
+        content-type: application/json
       response-stream:
         docs: ''
         type: GenerateStreamResponse
@@ -532,6 +626,25 @@ service:
         - ForbiddenError
         - NotFoundError
         - InternalServerError
+      examples:
+        - request:
+            requests:
+              - input_values:
+                  key: value
+          response:
+            stream:
+              - delta:
+                  request_index: 1
+                  data:
+                    completion_index: 1
+                    completion:
+                      id: id
+                      text: text
+                      prompt_version_id: prompt_version_id
+                      deployment_release_tag: deployment_release_tag
+                      model_name: model_name
+                  error:
+                    message: message
       audiences:
         - deprecated
     search:
@@ -539,6 +652,8 @@ service:
       method: POST
       auth: true
       docs: Perform a search against a document index.
+      source:
+        openapi: openapi/openapi.yml
       request:
         name: SearchRequestBodyRequest
         body:
@@ -565,6 +680,7 @@ service:
             options:
               type: optional<SearchRequestOptionsRequest>
               docs: Configuration options for the search.
+        content-type: application/json
       response:
         docs: ''
         type: SearchResponse
@@ -595,6 +711,8 @@ service:
       docs: >-
         Used to submit feedback regarding the quality of previously generated
         completions.
+      source:
+        openapi: openapi/openapi.yml
       request:
         name: SubmitCompletionActualsRequest
         body:
@@ -618,6 +736,7 @@ service:
                 Feedback regarding the quality of previously generated
                 completions
               type: list<SubmitCompletionActualRequest>
+        content-type: application/json
       url: Predict
       availability: generally-available
       errors:
@@ -638,6 +757,8 @@ service:
             Used to submit feedback regarding the quality of previous workflow execution and its outputs.
 
             **Note:** Uses a base url of `https://predict.vellum.ai`.    
+      source:
+        openapi: openapi/openapi.yml
       request:
         name: SubmitWorkflowExecutionActualsRequest
         body:
@@ -662,6 +783,7 @@ service:
                 actuals for. Must provide either this or execution_id.
               validation:
                 minLength: 1
+        content-type: application/json
       url: Predict
       availability: generally-available
       examples:
@@ -1318,6 +1440,7 @@ types:
       - string
     source:
       openapi: openapi/openapi.yml
+    inline: true
   DeploymentProviderPayloadResponse:
     properties:
       payload: DeploymentProviderPayloadResponsePayload

package/.mock/definition/adHoc.yml

@@ -11,6 +11,8 @@ service:
       docs: >-
         An internal-only endpoint that's subject to breaking changes without
         notice. Not intended for public use.
+      source:
+        openapi: openapi/openapi.yml
       request:
         name: AdHocExecutePromptStream
         body:
@@ -26,6 +28,7 @@ service:
             blocks: list<root.PromptBlock>
             functions: optional<list<root.FunctionDefinition>>
             expand_meta: optional<root.AdHocExpandMeta>
+        content-type: application/json
       response-stream:
         docs: ''
         type: root.AdHocExecutePromptEvent
@@ -36,6 +39,28 @@ service:
         - root.BadRequestError
         - root.ForbiddenError
         - root.InternalServerError
+      examples:
+        - request:
+            ml_model: ml_model
+            input_values:
+              - key: key
+                type: STRING
+                value: value
+            input_variables:
+              - id: id
+                key: key
+                type: STRING
+            parameters: {}
+            blocks:
+              - block_type: JINJA
+                template: template
+          response:
+            stream:
+              - state: INITIATED
+                meta:
+                  model_name: model_name
+                  latency: 1
+                execution_id: execution_id
       audiences:
         - internal
   source:

package/.mock/definition/containerImages.yml

@@ -9,6 +9,8 @@ service:
       method: GET
       auth: true
       docs: Retrieve a list of container images for the organization.
+      source:
+        openapi: openapi/openapi.yml
       request:
         name: ContainerImagesListRequest
         query-parameters:
@@ -49,6 +51,8 @@ service:
       method: GET
       auth: true
       docs: Retrieve a Container Image by its ID or name.
+      source:
+        openapi: openapi/openapi.yml
       path-parameters:
         id:
           type: string
@@ -81,6 +85,8 @@ service:
       docs: >-
         An internal-only endpoint that's subject to breaking changes without
         notice. Not intended for public use.
+      source:
+        openapi: openapi/openapi.yml
       response:
         docs: ''
         type: root.DockerServiceToken
@@ -101,6 +107,8 @@ service:
       docs: >-
         An internal-only endpoint that's subject to breaking changes without
         notice. Not intended for public use.
+      source:
+        openapi: openapi/openapi.yml
       request:
         name: PushContainerImageRequest
         body:
@@ -114,6 +122,7 @@ service:
               validation:
                 minLength: 1
             tags: list<string>
+        content-type: application/json
       response:
         docs: ''
         type: root.ContainerImageRead

package/.mock/definition/deployments.yml

@@ -22,6 +22,8 @@ service:
       method: GET
       auth: true
       docs: Used to list all Prompt Deployments.
+      source:
+        openapi: openapi/openapi.yml
       request:
         name: DeploymentsListRequest
         query-parameters:
@@ -68,6 +70,8 @@ service:
       method: GET
       auth: true
       docs: Used to retrieve a Prompt Deployment given its ID or name.
+      source:
+        openapi: openapi/openapi.yml
       path-parameters:
         id:
           type: string
@@ -109,6 +113,8 @@ service:
       docs: >-
         Retrieve a specific Deployment History Item by either its UUID or the
         name of a Release Tag that points to it.
+      source:
+        openapi: openapi/openapi.yml
       path-parameters:
         history_id_or_release_tag:
           type: string
@@ -150,6 +156,8 @@ service:
       method: GET
       auth: true
       docs: List Release Tags associated with the specified Prompt Deployment
+      source:
+        openapi: openapi/openapi.yml
       path-parameters:
         id:
           type: string
@@ -195,6 +203,8 @@ service:
       docs: >-
         Retrieve a Deployment Release Tag by tag name, associated with a
         specified Deployment.
+      source:
+        openapi: openapi/openapi.yml
       path-parameters:
         id:
           type: string
@@ -229,6 +239,8 @@ service:
       docs: >-
         Updates an existing Release Tag associated with the specified Prompt
         Deployment.
+      source:
+        openapi: openapi/openapi.yml
       path-parameters:
         id:
           type: string
@@ -247,6 +259,7 @@ service:
               docs: The ID of the Deployment History Item to tag
               validation:
                 format: uuid
+        content-type: application/json
       response:
         docs: ''
         type: root.DeploymentReleaseTagRead
@@ -295,6 +308,8 @@ service:
 
         We encourage you to seek advise from Vellum Support before integrating
         with this API for production use.
+      source:
+        openapi: openapi/openapi.yml
       request:
         name: DeploymentProviderPayloadRequest
         body:
@@ -326,6 +341,7 @@ service:
               validation:
                 minLength: 1
             expand_meta: optional<root.CompilePromptDeploymentExpandMetaRequest>
+        content-type: application/json
       response:
         docs: ''
         type: root.DeploymentProviderPayloadResponse

package/.mock/definition/documentIndexes.yml

@@ -16,6 +16,8 @@ service:
       method: GET
       auth: true
       docs: Used to retrieve a list of Document Indexes.
+      source:
+        openapi: openapi/openapi.yml
       request:
         name: DocumentIndexesListRequest
         query-parameters:
@@ -70,6 +72,8 @@ service:
       method: POST
       auth: true
       docs: Creates a new document index.
+      source:
+        openapi: openapi/openapi.yml
       request:
         name: DocumentIndexCreateRequest
         body:
@@ -110,6 +114,7 @@ service:
                 index
               validation:
                 format: uuid
+        content-type: application/json
       response:
         docs: ''
         type: root.DocumentIndexRead
@@ -209,6 +214,8 @@ service:
       method: GET
       auth: true
       docs: Used to retrieve a Document Index given its ID or name.
+      source:
+        openapi: openapi/openapi.yml
       path-parameters:
         id:
           type: string
@@ -242,6 +249,8 @@ service:
       method: PUT
       auth: true
       docs: Used to fully update a Document Index given its ID or name.
+      source:
+        openapi: openapi/openapi.yml
       path-parameters:
         id:
           type: string
@@ -271,6 +280,7 @@ service:
                 * `DEVELOPMENT` - Development
                 * `STAGING` - Staging
                 * `PRODUCTION` - Production
+        content-type: application/json
       response:
         docs: ''
         type: root.DocumentIndexRead
@@ -302,6 +312,8 @@ service:
       method: DELETE
       auth: true
       docs: Used to delete a Document Index given its ID or name.
+      source:
+        openapi: openapi/openapi.yml
       path-parameters:
         id:
           type: string
@@ -318,6 +330,8 @@ service:
       method: PATCH
       auth: true
       docs: Used to partial update a Document Index given its ID or name.
+      source:
+        openapi: openapi/openapi.yml
       path-parameters:
         id:
           type: string
@@ -347,6 +361,7 @@ service:
                 * `DEVELOPMENT` - Development
                 * `STAGING` - Staging
                 * `PRODUCTION` - Production
+        content-type: application/json
       response:
         docs: ''
         type: root.DocumentIndexRead
@@ -377,6 +392,8 @@ service:
       method: POST
       auth: true
       docs: Adds a previously uploaded Document to the specified Document Index.
+      source:
+        openapi: openapi/openapi.yml
       path-parameters:
         document_id:
           type: string
@@ -404,6 +421,8 @@ service:
       docs: >-
         Removes a Document from a Document Index without deleting the Document
         itself.
+      source:
+        openapi: openapi/openapi.yml
       path-parameters:
         document_id:
           type: string

package/.mock/definition/documents.yml

@@ -9,6 +9,8 @@ service:
       method: GET
       auth: true
       docs: Used to list documents. Optionally filter on supported fields.
+      source:
+        openapi: openapi/openapi.yml
       request:
         name: DocumentsListRequest
         query-parameters:
@@ -18,6 +20,8 @@ service:
               Filter down to only those documents that are included in the
               specified index. You may provide either the Vellum-generated ID or
               the unique name of the index specified upon initial creation.
+            validation:
+              format: uuid
           limit:
             type: optional<integer>
             docs: Number of results to return per page.
@@ -62,6 +66,8 @@ service:
       docs: >-
         Retrieve a Document, keying off of either its Vellum-generated ID or its
         external ID.
+      source:
+        openapi: openapi/openapi.yml
       path-parameters:
         id:
           type: string
@@ -99,6 +105,8 @@ service:
       docs: >-
         Delete a Document, keying off of either its Vellum-generated ID or its
         external ID.
+      source:
+        openapi: openapi/openapi.yml
       path-parameters:
         id:
           type: string
@@ -117,6 +125,8 @@ service:
       docs: >-
         Update a Document, keying off of either its Vellum-generated ID or its
         external ID. Particularly useful for updating its metadata.
+      source:
+        openapi: openapi/openapi.yml
       path-parameters:
         id:
           type: string
@@ -144,6 +154,7 @@ service:
               docs: >-
                 A JSON object containing any metadata associated with the
                 document that you'd like to filter upon later.
+        content-type: application/json
       response:
         docs: ''
         type: root.DocumentRead
@@ -202,6 +213,8 @@ service:
         - `metadata: dict[str, Any]` - A stringified JSON object containing any
         metadata associated with the document that you'd like to filter upon
         later.
+      source:
+        openapi: openapi/openapi.yml
       request:
         name: UploadDocumentBodyRequest
         body:
@@ -226,7 +239,9 @@ service:
               validation:
                 minLength: 1
                 maxLength: 1000
-            contents: file
+            contents:
+              type: file
+              docs: The file contents of the document.
             keywords:
               type: optional<list<string>>
               docs: >-

package/.mock/definition/folderEntities.yml

@@ -16,6 +16,8 @@ service:
       method: GET
       auth: false
       docs: List all folder entities within a specified folder.
+      source:
+        openapi: openapi/openapi.yml
       request:
         name: FolderEntitiesListRequest
         query-parameters:
@@ -92,6 +94,8 @@ service:
 
         Adding an entity to a folder will remove it from any other folders it
         might have been a member of.
+      source:
+        openapi: openapi/openapi.yml
       path-parameters:
         folder_id:
           type: string
@@ -117,6 +121,7 @@ service:
               docs: The ID of the entity you would like to move.
               validation:
                 format: uuid
+        content-type: application/json
       url: Default
       availability: pre-release
       examples:

package/.mock/definition/metricDefinitions.yml

@@ -11,6 +11,8 @@ service:
       docs: >-
         An internal-only endpoint that's subject to breaking changes without
         notice. Not intended for public use.
+      source:
+        openapi: openapi/openapi.yml
       path-parameters:
         id:
           type: string
@@ -24,6 +26,7 @@ service:
               type: optional<string>
               validation:
                 minLength: 1
+        content-type: application/json
       response:
         docs: ''
         type: root.MetricDefinitionExecution
@@ -49,6 +52,8 @@ service:
       path: /v1/metric-definitions/{id}/history/{history_id_or_release_tag}
       method: GET
       auth: true
+      source:
+        openapi: openapi/openapi.yml
       path-parameters:
         history_id_or_release_tag:
           type: string
@@ -63,6 +68,7 @@ service:
         docs: ''
         type: root.MetricDefinitionHistoryItem
       url: Default
+      availability: pre-release
       examples:
         - path-parameters:
             history_id_or_release_tag: history_id_or_release_tag
@@ -87,5 +93,7 @@ service:
                   required: true
                   default:
                     type: STRING
+      audiences:
+        - internal
   source:
     openapi: openapi/openapi.yml

package/.mock/definition/mlModels.yml

@@ -10,6 +10,8 @@ service:
       auth: true
       docs: |
         Retrieve details about an ML Model
+      source:
+        openapi: openapi/openapi.yml
       path-parameters:
         id:
           type: string