vellum-ai 0.8.8 → 0.8.10

package/.mock/definition/documentIndexes.yml

@@ -0,0 +1,429 @@
+types:
+  DocumentIndexesListRequestStatus:
+    enum:
+      - ACTIVE
+      - ARCHIVED
+    source:
+      openapi: openapi/openapi.yml
+imports:
+  root: __package__.yml
+service:
+  auth: false
+  base-path: ''
+  endpoints:
+    list:
+      path: /v1/document-indexes
+      method: GET
+      auth: true
+      docs: Used to retrieve a list of Document Indexes.
+      request:
+        name: DocumentIndexesListRequest
+        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.
+          search:
+            type: optional<string>
+            docs: Search for document indices by name or label
+          status:
+            type: optional<DocumentIndexesListRequestStatus>
+            docs: >-
+              Filter down to only document indices that have a status matching
+              the status specified
+
+
+              * `ACTIVE` - Active
+
+              * `ARCHIVED` - Archived
+      response:
+        docs: ''
+        type: root.PaginatedDocumentIndexReadList
+      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
+                  indexing_config:
+                    vectorizer:
+                      config: {}
+                      model_name: text-embedding-3-small
+      audiences:
+        - customers
+    create:
+      path: /v1/document-indexes
+      method: POST
+      auth: true
+      docs: Creates a new document index.
+      request:
+        name: DocumentIndexCreateRequest
+        body:
+          properties:
+            label:
+              type: string
+              docs: A human-readable label for the document index
+              validation:
+                minLength: 1
+                maxLength: 150
+            name:
+              type: string
+              docs: A name that uniquely identifies this index within its workspace
+              validation:
+                minLength: 1
+                maxLength: 150
+            status:
+              type: optional<root.EntityStatus>
+              docs: |-
+                The current status of the document index
+
+                * `ACTIVE` - Active
+                * `ARCHIVED` - Archived
+            environment:
+              type: optional<root.EnvironmentEnum>
+              docs: |-
+                The environment this document index is used in
+
+                * `DEVELOPMENT` - Development
+                * `STAGING` - Staging
+                * `PRODUCTION` - Production
+            indexing_config: root.DocumentIndexIndexingConfigRequest
+            copy_documents_from_index_id:
+              type: optional<string>
+              docs: >-
+                Optionally specify the id of a document index from which you'd
+                like to copy and re-index its documents into this newly created
+                index
+              validation:
+                format: uuid
+      response:
+        docs: ''
+        type: root.DocumentIndexRead
+      url: Default
+      availability: pre-release
+      examples:
+        - name: Index Using Instructor Model
+          request:
+            label: My Document Index
+            name: my-document-index
+            indexing_config:
+              vectorizer:
+                model_name: hkunlp/instructor-xl
+                config:
+                  instruction_domain: ''
+                  instruction_query_text_type: plain_text
+                  instruction_document_text_type: plain_text
+              chunking:
+                chunker_name: sentence-chunker
+                chunker_config:
+                  character_limit: 1000
+                  min_overlap_ratio: 0.5
+          response:
+            body:
+              id: id
+              created: '2024-01-15T09:30:00Z'
+              label: label
+              name: name
+              status: ACTIVE
+              environment: DEVELOPMENT
+              indexing_config:
+                vectorizer:
+                  config: {}
+                  model_name: text-embedding-3-small
+                chunking:
+                  chunker_name: reducto-chunker
+        - name: Index Using a Sentence Transformers Model
+          request:
+            label: My Document Index
+            name: my-document-index
+            indexing_config:
+              vectorizer:
+                model_name: sentence-transformers/multi-qa-mpnet-base-dot-v1
+                config:
+                  key: value
+              chunking:
+                chunker_name: sentence-chunker
+                chunker_config:
+                  character_limit: 1000
+                  min_overlap_ratio: 0.5
+          response:
+            body:
+              id: id
+              created: '2024-01-15T09:30:00Z'
+              label: label
+              name: name
+              status: ACTIVE
+              environment: DEVELOPMENT
+              indexing_config:
+                vectorizer:
+                  config: {}
+                  model_name: text-embedding-3-small
+                chunking:
+                  chunker_name: reducto-chunker
+        - name: Index Using OpenAI Model
+          request:
+            label: My Document Index
+            name: my-document-index
+            indexing_config:
+              vectorizer:
+                config:
+                  add_openai_api_key: true
+                model_name: text-embedding-ada-002
+              chunking:
+                chunker_name: sentence-chunker
+                chunker_config:
+                  character_limit: 1000
+                  min_overlap_ratio: 0.5
+          response:
+            body:
+              id: id
+              created: '2024-01-15T09:30:00Z'
+              label: label
+              name: name
+              status: ACTIVE
+              environment: DEVELOPMENT
+              indexing_config:
+                vectorizer:
+                  config: {}
+                  model_name: text-embedding-3-small
+                chunking:
+                  chunker_name: reducto-chunker
+      audiences:
+        - customers
+    retrieve:
+      path: /v1/document-indexes/{id}
+      method: GET
+      auth: true
+      docs: Used to retrieve a Document Index given its ID or name.
+      path-parameters:
+        id:
+          type: string
+          docs: Either the Document Index's ID or its unique name
+      response:
+        docs: ''
+        type: root.DocumentIndexRead
+      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
+              indexing_config:
+                vectorizer:
+                  config: {}
+                  model_name: text-embedding-3-small
+                chunking:
+                  chunker_name: reducto-chunker
+      audiences:
+        - customers
+    update:
+      path: /v1/document-indexes/{id}
+      method: PUT
+      auth: true
+      docs: Used to fully update a Document Index given its ID or name.
+      path-parameters:
+        id:
+          type: string
+          docs: Either the Document Index's ID or its unique name
+      request:
+        name: DocumentIndexUpdateRequest
+        body:
+          properties:
+            label:
+              type: string
+              docs: A human-readable label for the document index
+              validation:
+                minLength: 1
+                maxLength: 150
+            status:
+              type: optional<root.EntityStatus>
+              docs: |-
+                The current status of the document index
+
+                * `ACTIVE` - Active
+                * `ARCHIVED` - Archived
+            environment:
+              type: optional<root.EnvironmentEnum>
+              docs: |-
+                The environment this document index is used in
+
+                * `DEVELOPMENT` - Development
+                * `STAGING` - Staging
+                * `PRODUCTION` - Production
+      response:
+        docs: ''
+        type: root.DocumentIndexRead
+      url: Default
+      availability: pre-release
+      examples:
+        - path-parameters:
+            id: id
+          request:
+            label: label
+          response:
+            body:
+              id: id
+              created: '2024-01-15T09:30:00Z'
+              label: label
+              name: name
+              status: ACTIVE
+              environment: DEVELOPMENT
+              indexing_config:
+                vectorizer:
+                  config: {}
+                  model_name: text-embedding-3-small
+                chunking:
+                  chunker_name: reducto-chunker
+      audiences:
+        - customers
+    destroy:
+      path: /v1/document-indexes/{id}
+      method: DELETE
+      auth: true
+      docs: Used to delete a Document Index given its ID or name.
+      path-parameters:
+        id:
+          type: string
+          docs: Either the Document Index's ID or its unique name
+      url: Default
+      availability: pre-release
+      examples:
+        - path-parameters:
+            id: id
+      audiences:
+        - customers
+    partialUpdate:
+      path: /v1/document-indexes/{id}
+      method: PATCH
+      auth: true
+      docs: Used to partial update a Document Index given its ID or name.
+      path-parameters:
+        id:
+          type: string
+          docs: Either the Document Index's ID or its unique name
+      request:
+        name: PatchedDocumentIndexUpdateRequest
+        body:
+          properties:
+            label:
+              type: optional<string>
+              docs: A human-readable label for the document index
+              validation:
+                minLength: 1
+                maxLength: 150
+            status:
+              type: optional<root.EntityStatus>
+              docs: |-
+                The current status of the document index
+
+                * `ACTIVE` - Active
+                * `ARCHIVED` - Archived
+            environment:
+              type: optional<root.EnvironmentEnum>
+              docs: |-
+                The environment this document index is used in
+
+                * `DEVELOPMENT` - Development
+                * `STAGING` - Staging
+                * `PRODUCTION` - Production
+      response:
+        docs: ''
+        type: root.DocumentIndexRead
+      url: Default
+      availability: pre-release
+      examples:
+        - path-parameters:
+            id: id
+          request: {}
+          response:
+            body:
+              id: id
+              created: '2024-01-15T09:30:00Z'
+              label: label
+              name: name
+              status: ACTIVE
+              environment: DEVELOPMENT
+              indexing_config:
+                vectorizer:
+                  config: {}
+                  model_name: text-embedding-3-small
+                chunking:
+                  chunker_name: reducto-chunker
+      audiences:
+        - customers
+    add_document:
+      path: /v1/document-indexes/{id}/documents/{document_id}
+      method: POST
+      auth: true
+      docs: Adds a previously uploaded Document to the specified Document Index.
+      path-parameters:
+        document_id:
+          type: string
+          docs: >-
+            Either the Vellum-generated ID or the originally supplied
+            external_id that uniquely identifies the Document you'd like to add.
+        id:
+          type: string
+          docs: >-
+            Either the Vellum-generated ID or the originally specified name that
+            uniquely identifies the Document Index to which you'd like to add
+            the Document.
+      url: Default
+      availability: pre-release
+      examples:
+        - path-parameters:
+            document_id: document_id
+            id: id
+      audiences:
+        - customers
+    remove_document:
+      path: /v1/document-indexes/{id}/documents/{document_id}
+      method: DELETE
+      auth: true
+      docs: >-
+        Removes a Document from a Document Index without deleting the Document
+        itself.
+      path-parameters:
+        document_id:
+          type: string
+          docs: >-
+            Either the Vellum-generated ID or the originally supplied
+            external_id that uniquely identifies the Document you'd like to
+            remove.
+        id:
+          type: string
+          docs: >-
+            Either the Vellum-generated ID or the originally specified name that
+            uniquely identifies the Document Index from which you'd like to
+            remove a Document.
+      url: Default
+      availability: pre-release
+      examples:
+        - path-parameters:
+            document_id: document_id
+            id: id
+      audiences:
+        - customers
+  source:
+    openapi: openapi/openapi.yml

package/.mock/definition/documents.yml

@@ -0,0 +1,261 @@
+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.
+      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.
+          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.
+      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.
+      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
+              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.
+      path-parameters:
+        id:
+          type: string
+          docs: A UUID string identifying this document.
+      url: Default
+      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.
+      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.
+      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
+              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.
+      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: file
+            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