vellum-ai 0.13.20 → 0.13.22

package/.mock/definition/documents.yml

@@ -1,281 +0,0 @@
-imports:
-  root: __package__.yml
-service:
-  auth: false
-  base-path: ''
-  endpoints:
-    list:
-      path: /v1/documents
-      method: GET
-      auth: true
-      docs: Used to list documents. Optionally filter on supported fields.
-      source:
-        openapi: openapi/openapi.yml
-      request:
-        name: DocumentsListRequest
-        query-parameters:
-          document_index_id:
-            type: optional<string>
-            docs: >-
-              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.
-          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.
-          search:
-            type: optional<string>
-            docs: A search term.
-      response:
-        docs: ''
-        type: root.PaginatedSlimDocumentList
-      url: Default
-      availability: generally-available
-      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
-                  external_id: external_id
-                  last_uploaded_at: '2024-01-15T09:30:00Z'
-                  label: label
-                  processing_state: QUEUED
-                  processing_failure_reason: EXCEEDED_CHARACTER_LIMIT
-                  status: ACTIVE
-                  keywords:
-                    - keywords
-                  metadata:
-                    key: value
-                  document_to_document_indexes:
-                    - id: id
-                      document_index_id: document_index_id
-      audiences:
-        - customers
-    retrieve:
-      path: /v1/documents/{id}
-      method: GET
-      auth: true
-      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
-          docs: A UUID string identifying this document.
-      response:
-        docs: ''
-        type: root.DocumentRead
-      url: Default
-      availability: pre-release
-      examples:
-        - path-parameters:
-            id: id
-          response:
-            body:
-              id: id
-              external_id: external_id
-              last_uploaded_at: '2024-01-15T09:30:00Z'
-              label: label
-              processing_state: QUEUED
-              status: ACTIVE
-              original_file_url: original_file_url
-              processed_file_url: processed_file_url
-              document_to_document_indexes:
-                - id: id
-                  document_index_id: document_index_id
-                  indexing_state: AWAITING_PROCESSING
-                  extracted_text_file_url: extracted_text_file_url
-              metadata:
-                key: value
-      audiences:
-        - customers
-    destroy:
-      path: /v1/documents/{id}
-      method: DELETE
-      auth: true
-      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
-          docs: A UUID string identifying this document.
-      url: Documents
-      availability: pre-release
-      examples:
-        - path-parameters:
-            id: id
-      audiences:
-        - customers
-    partialUpdate:
-      path: /v1/documents/{id}
-      method: PATCH
-      auth: true
-      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
-          docs: A UUID string identifying this document.
-      request:
-        name: PatchedDocumentUpdateRequest
-        body:
-          properties:
-            label:
-              type: optional<string>
-              docs: >-
-                A human-readable label for the document. Defaults to the
-                originally uploaded file's file name.
-              validation:
-                minLength: 1
-                maxLength: 1000
-            status:
-              type: optional<root.DocumentStatus>
-              docs: |-
-                The current status of the document
-
-                * `ACTIVE` - Active
-            metadata:
-              type: optional<map<string, unknown>>
-              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
-      url: Default
-      availability: pre-release
-      examples:
-        - path-parameters:
-            id: id
-          request: {}
-          response:
-            body:
-              id: id
-              external_id: external_id
-              last_uploaded_at: '2024-01-15T09:30:00Z'
-              label: label
-              processing_state: QUEUED
-              status: ACTIVE
-              original_file_url: original_file_url
-              processed_file_url: processed_file_url
-              document_to_document_indexes:
-                - id: id
-                  document_index_id: document_index_id
-                  indexing_state: AWAITING_PROCESSING
-                  extracted_text_file_url: extracted_text_file_url
-              metadata:
-                key: value
-      audiences:
-        - customers
-    upload:
-      path: /v1/upload-document
-      method: POST
-      auth: true
-      docs: >
-        Upload a document to be indexed and used for search.
-
-
-        **Note:** Uses a base url of `https://documents.vellum.ai`.
-
-
-        This is a multipart/form-data request. The `contents` field should be a
-        file upload. It also expects a JSON body with the following fields:
-
-        - `add_to_index_names: list[str]` - Optionally include the names of all
-        indexes that you'd like this document to be included in
-
-        - `external_id: str | None` - Optionally include an external ID for this
-        document. This is useful if you want to re-upload the same document
-        later when its contents change and would like it to be re-indexed.
-
-        - `label: str` - A human-friendly name for this document. Typically the
-        filename.
-
-        - `keywords: list[str] | None` - Optionally include a list of keywords
-        that'll be associated with this document. Used when performing keyword
-        searches.
-
-        - `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:
-          properties:
-            add_to_index_names:
-              type: optional<list<string>>
-              docs: >-
-                Optionally include the names of all indexes that you'd like this
-                document to be included in
-            external_id:
-              type: optional<string>
-              docs: >-
-                Optionally include an external ID for this document. This is
-                useful if you want to re-upload the same document later when its
-                contents change and would like it to be re-indexed.
-              validation:
-                minLength: 1
-                maxLength: 1000
-            label:
-              type: string
-              docs: A human-friendly name for this document. Typically the filename.
-              validation:
-                minLength: 1
-                maxLength: 1000
-            contents:
-              type: file
-              docs: The file contents of the document.
-            keywords:
-              type: optional<list<string>>
-              docs: >-
-                Optionally include a list of keywords that'll be associated with
-                this document. Used when performing keyword searches.
-            metadata:
-              type: optional<string>
-              docs: >-
-                A stringified JSON object containing any metadata associated
-                with the document that you'd like to filter upon later.
-              validation:
-                format: byte
-        content-type: multipart/form-data
-      response:
-        docs: ''
-        type: root.UploadDocumentResponse
-      url: Documents
-      availability: generally-available
-      errors:
-        - root.BadRequestError
-        - root.NotFoundError
-        - root.InternalServerError
-      examples:
-        - request:
-            label: label
-          response:
-            body:
-              document_id: document_id
-      audiences:
-        - customers
-  source:
-    openapi: openapi/openapi.yml

package/.mock/definition/folderEntities.yml

@@ -1,135 +0,0 @@
-types:
-  FolderEntitiesListRequestEntityStatus:
-    enum:
-      - ACTIVE
-      - ARCHIVED
-    source:
-      openapi: openapi/openapi.yml
-imports:
-  root: __package__.yml
-service:
-  auth: false
-  base-path: ''
-  endpoints:
-    list:
-      path: /v1/folder-entities
-      method: GET
-      auth: true
-      docs: List all folder entities within a specified folder.
-      source:
-        openapi: openapi/openapi.yml
-      request:
-        name: FolderEntitiesListRequest
-        query-parameters:
-          entity_status:
-            type: optional<FolderEntitiesListRequestEntityStatus>
-            docs: >-
-              Filter down to only those objects whose entities have a status
-              matching the status specified.
-
-
-              * `ACTIVE` - Active
-
-              * `ARCHIVED` - Archived
-          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.
-          parent_folder_id:
-            type: string
-            docs: >-
-              Filter down to only those entities whose parent folder has the
-              specified ID.
-
-
-              To filter by an entity's parent folder, provide the ID of the
-              parent folder. To filter by the root directory, provide
-
-              a string representing the entity type of the root directory.
-              Supported root directories include:
-
-              - PROMPT_SANDBOX
-
-              - WORKFLOW_SANDBOX
-
-              - DOCUMENT_INDEX
-
-              - TEST_SUITE
-      response:
-        docs: ''
-        type: root.PaginatedFolderEntityList
-      url: Default
-      availability: pre-release
-      examples:
-        - query-parameters:
-            parent_folder_id: parent_folder_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
-                  type: FOLDER
-                  data:
-                    id: id
-                    label: label
-                    created: '2024-01-15T09:30:00Z'
-                    modified: '2024-01-15T09:30:00Z'
-                    has_contents: true
-      audiences:
-        - customers
-    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.
-      source:
-        openapi: openapi/openapi.yml
-      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. Supported root directories include:
-
-            - PROMPT_SANDBOX
-
-            - WORKFLOW_SANDBOX
-
-            - DOCUMENT_INDEX
-
-            - TEST_SUITE
-      request:
-        name: AddEntityToFolderRequest
-        body:
-          properties:
-            entity_id:
-              type: string
-              docs: The ID of the entity you would like to move.
-              validation:
-                format: uuid
-        content-type: application/json
-      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/metricDefinitions.yml

@@ -1,96 +0,0 @@
-imports:
-  root: __package__.yml
-service:
-  auth: false
-  base-path: ''
-  endpoints:
-    execute_metric_definition:
-      path: /v1/metric-definitions/{id}/execute
-      method: POST
-      auth: true
-      source:
-        openapi: openapi/openapi.yml
-      path-parameters:
-        id:
-          type: string
-          docs: Either the Metric Definition's ID or its unique name
-      request:
-        name: ExecuteMetricDefinition
-        body:
-          properties:
-            inputs: list<root.MetricDefinitionInput>
-            release_tag:
-              type: optional<string>
-              validation:
-                minLength: 1
-        content-type: application/json
-      response:
-        docs: ''
-        type: root.MetricDefinitionExecution
-      url: Predict
-      availability: pre-release
-      examples:
-        - path-parameters:
-            id: id
-          request:
-            inputs:
-              - name: name
-                type: STRING
-                value: value
-          response:
-            body:
-              outputs:
-                - value: value
-                  type: STRING
-                  name: name
-      audiences:
-        - internal
-    metric_definition_history_item_retrieve:
-      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
-          docs: >-
-            Either the UUID of Metric Definition History Item you'd like to
-            retrieve, or the name of a Release Tag that's pointing to the Metric
-            Definition History Item you'd like to retrieve.
-        id:
-          type: string
-          docs: A UUID string identifying this metric definition.
-      response:
-        docs: ''
-        type: root.MetricDefinitionHistoryItem
-      url: Default
-      availability: pre-release
-      examples:
-        - path-parameters:
-            history_id_or_release_tag: history_id_or_release_tag
-            id: id
-          response:
-            body:
-              id: id
-              label: label
-              name: name
-              description: description
-              input_variables:
-                - id: id
-                  key: key
-                  type: STRING
-                  required: true
-                  default:
-                    type: STRING
-              output_variables:
-                - id: id
-                  key: key
-                  type: STRING
-                  required: true
-                  default:
-                    type: STRING
-      audiences:
-        - internal
-  source:
-    openapi: openapi/openapi.yml

package/.mock/definition/mlModels.yml

@@ -1,36 +0,0 @@
-imports:
-  root: __package__.yml
-service:
-  auth: false
-  base-path: ''
-  endpoints:
-    retrieve:
-      path: /v1/ml-models/{id}
-      method: GET
-      auth: true
-      docs: |
-        Retrieve details about an ML Model
-      source:
-        openapi: openapi/openapi.yml
-      path-parameters:
-        id:
-          type: string
-          docs: >-
-            Either the ML Model's ID, its unique name, or its ID in the
-            workspace.
-      response:
-        docs: ''
-        type: root.MlModelRead
-      url: Default
-      availability: pre-release
-      examples:
-        - path-parameters:
-            id: id
-          response:
-            body:
-              id: id
-              name: name
-      audiences:
-        - internal
-  source:
-    openapi: openapi/openapi.yml

package/.mock/definition/organizations.yml

@@ -1,29 +0,0 @@
-imports:
-  root: __package__.yml
-service:
-  auth: false
-  base-path: ''
-  endpoints:
-    organization_identity:
-      path: /v1/organizations/identity
-      method: GET
-      auth: true
-      docs: Retrieves information about the active Organization
-      source:
-        openapi: openapi/openapi.yml
-      response:
-        docs: ''
-        type: root.OrganizationRead
-      url: Default
-      availability: pre-release
-      examples:
-        - response:
-            body:
-              id: id
-              name: name
-              allow_staff_access: true
-              new_member_join_behavior: AUTO_ACCEPT_FROM_SHARED_DOMAIN
-      audiences:
-        - internal
-  source:
-    openapi: openapi/openapi.yml