vellum-ai 0.11.6 → 0.11.8

package/.mock/definition/documentIndexes.yml

@@ -1,448 +0,0 @@
-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.
-      source:
-        openapi: openapi/openapi.yml
-      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.
-      source:
-        openapi: openapi/openapi.yml
-      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
-        content-type: application/json
-      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.
-      source:
-        openapi: openapi/openapi.yml
-      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.
-      source:
-        openapi: openapi/openapi.yml
-      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
-        content-type: application/json
-      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.
-      source:
-        openapi: openapi/openapi.yml
-      path-parameters:
-        id:
-          type: string
-          docs: Either the Document Index's ID or its unique name
-      url: Documents
-      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.
-      source:
-        openapi: openapi/openapi.yml
-      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
-        content-type: application/json
-      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.
-      source:
-        openapi: openapi/openapi.yml
-      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.
-      source:
-        openapi: openapi/openapi.yml
-      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: Documents
-      availability: pre-release
-      examples:
-        - path-parameters:
-            document_id: document_id
-            id: id
-      audiences:
-        - customers
-  source:
-    openapi: openapi/openapi.yml