@mixedbread/sdk 0.3.0 → 0.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +51 -0
- package/README.md +110 -37
- package/api-promise.d.mts +2 -0
- package/api-promise.d.mts.map +1 -0
- package/api-promise.d.ts +2 -0
- package/api-promise.d.ts.map +1 -0
- package/api-promise.js +6 -0
- package/api-promise.js.map +1 -0
- package/api-promise.mjs +2 -0
- package/api-promise.mjs.map +1 -0
- package/bin/cli +52 -0
- package/bin/migration-config.json +73 -0
- package/client.d.mts +261 -0
- package/client.d.mts.map +1 -0
- package/client.d.ts +261 -0
- package/client.d.ts.map +1 -0
- package/client.js +535 -0
- package/client.js.map +1 -0
- package/client.mjs +531 -0
- package/client.mjs.map +1 -0
- package/core/api-promise.d.mts +46 -0
- package/core/api-promise.d.mts.map +1 -0
- package/core/api-promise.d.ts +46 -0
- package/core/api-promise.d.ts.map +1 -0
- package/core/api-promise.js +74 -0
- package/core/api-promise.js.map +1 -0
- package/core/api-promise.mjs +70 -0
- package/core/api-promise.mjs.map +1 -0
- package/core/error.d.mts +46 -0
- package/core/error.d.mts.map +1 -0
- package/core/error.d.ts +46 -0
- package/core/error.d.ts.map +1 -0
- package/core/error.js +113 -0
- package/core/error.js.map +1 -0
- package/core/error.mjs +97 -0
- package/core/error.mjs.map +1 -0
- package/core/pagination.d.mts +66 -0
- package/core/pagination.d.mts.map +1 -0
- package/core/pagination.d.ts +66 -0
- package/core/pagination.d.ts.map +1 -0
- package/core/pagination.js +110 -0
- package/core/pagination.js.map +1 -0
- package/core/pagination.mjs +104 -0
- package/core/pagination.mjs.map +1 -0
- package/core/resource.d.mts +6 -0
- package/core/resource.d.mts.map +1 -0
- package/core/resource.d.ts +6 -0
- package/core/resource.d.ts.map +1 -0
- package/core/resource.js +11 -0
- package/core/resource.js.map +1 -0
- package/core/resource.mjs +7 -0
- package/core/resource.mjs.map +1 -0
- package/core/uploads.d.mts +3 -0
- package/core/uploads.d.mts.map +1 -0
- package/core/uploads.d.ts +3 -0
- package/core/uploads.d.ts.map +1 -0
- package/core/uploads.js +6 -0
- package/core/uploads.js.map +1 -0
- package/core/uploads.mjs +2 -0
- package/core/uploads.mjs.map +1 -0
- package/error.d.mts +2 -0
- package/error.d.mts.map +1 -0
- package/error.d.ts +1 -46
- package/error.d.ts.map +1 -1
- package/error.js +3 -110
- package/error.js.map +1 -1
- package/error.mjs +1 -96
- package/error.mjs.map +1 -1
- package/index.d.mts +7 -169
- package/index.d.mts.map +1 -0
- package/index.d.ts +6 -168
- package/index.d.ts.map +1 -1
- package/index.js +14 -157
- package/index.js.map +1 -1
- package/index.mjs +6 -130
- package/index.mjs.map +1 -1
- package/internal/builtin-types.d.mts +73 -0
- package/internal/builtin-types.d.mts.map +1 -0
- package/internal/builtin-types.d.ts +73 -0
- package/internal/builtin-types.d.ts.map +1 -0
- package/internal/builtin-types.js +4 -0
- package/internal/builtin-types.js.map +1 -0
- package/internal/builtin-types.mjs +3 -0
- package/internal/builtin-types.mjs.map +1 -0
- package/internal/detect-platform.d.mts +15 -0
- package/internal/detect-platform.d.mts.map +1 -0
- package/internal/detect-platform.d.ts +15 -0
- package/internal/detect-platform.d.ts.map +1 -0
- package/internal/detect-platform.js +162 -0
- package/internal/detect-platform.js.map +1 -0
- package/internal/detect-platform.mjs +157 -0
- package/internal/detect-platform.mjs.map +1 -0
- package/internal/errors.d.mts +3 -0
- package/internal/errors.d.mts.map +1 -0
- package/internal/errors.d.ts +3 -0
- package/internal/errors.d.ts.map +1 -0
- package/internal/errors.js +41 -0
- package/internal/errors.js.map +1 -0
- package/internal/errors.mjs +36 -0
- package/internal/errors.mjs.map +1 -0
- package/internal/headers.d.mts +20 -0
- package/internal/headers.d.mts.map +1 -0
- package/internal/headers.d.ts +20 -0
- package/internal/headers.d.ts.map +1 -0
- package/internal/headers.js +79 -0
- package/internal/headers.js.map +1 -0
- package/internal/headers.mjs +74 -0
- package/internal/headers.mjs.map +1 -0
- package/internal/parse.d.mts +12 -0
- package/internal/parse.d.mts.map +1 -0
- package/internal/parse.d.ts +12 -0
- package/internal/parse.d.ts.map +1 -0
- package/internal/parse.js +35 -0
- package/internal/parse.js.map +1 -0
- package/internal/parse.mjs +32 -0
- package/internal/parse.mjs.map +1 -0
- package/internal/request-options.d.mts +32 -0
- package/internal/request-options.d.mts.map +1 -0
- package/internal/request-options.d.ts +32 -0
- package/internal/request-options.d.ts.map +1 -0
- package/internal/request-options.js +14 -0
- package/internal/request-options.js.map +1 -0
- package/internal/request-options.mjs +10 -0
- package/internal/request-options.mjs.map +1 -0
- package/internal/shim-types.d.mts +28 -0
- package/internal/shim-types.d.ts +28 -0
- package/internal/shims.d.mts +20 -0
- package/internal/shims.d.mts.map +1 -0
- package/internal/shims.d.ts +20 -0
- package/internal/shims.d.ts.map +1 -0
- package/internal/shims.js +92 -0
- package/internal/shims.js.map +1 -0
- package/internal/shims.mjs +85 -0
- package/internal/shims.mjs.map +1 -0
- package/internal/to-file.d.mts +45 -0
- package/internal/to-file.d.mts.map +1 -0
- package/internal/to-file.d.ts +45 -0
- package/internal/to-file.d.ts.map +1 -0
- package/internal/to-file.js +91 -0
- package/internal/to-file.js.map +1 -0
- package/internal/to-file.mjs +88 -0
- package/internal/to-file.mjs.map +1 -0
- package/internal/tslib.js +81 -0
- package/internal/tslib.mjs +17 -0
- package/internal/types.d.mts +67 -0
- package/internal/types.d.mts.map +1 -0
- package/internal/types.d.ts +67 -0
- package/internal/types.d.ts.map +1 -0
- package/internal/types.js +4 -0
- package/internal/types.js.map +1 -0
- package/internal/types.mjs +3 -0
- package/internal/types.mjs.map +1 -0
- package/internal/uploads.d.mts +42 -0
- package/internal/uploads.d.mts.map +1 -0
- package/internal/uploads.d.ts +42 -0
- package/internal/uploads.d.ts.map +1 -0
- package/internal/uploads.js +141 -0
- package/internal/uploads.js.map +1 -0
- package/internal/uploads.mjs +131 -0
- package/internal/uploads.mjs.map +1 -0
- package/internal/utils/base64.d.mts +3 -0
- package/internal/utils/base64.d.mts.map +1 -0
- package/internal/utils/base64.d.ts +3 -0
- package/internal/utils/base64.d.ts.map +1 -0
- package/internal/utils/base64.js +38 -0
- package/internal/utils/base64.js.map +1 -0
- package/internal/utils/base64.mjs +33 -0
- package/internal/utils/base64.mjs.map +1 -0
- package/internal/utils/bytes.d.mts +4 -0
- package/internal/utils/bytes.d.mts.map +1 -0
- package/internal/utils/bytes.d.ts +4 -0
- package/internal/utils/bytes.d.ts.map +1 -0
- package/internal/utils/bytes.js +31 -0
- package/internal/utils/bytes.js.map +1 -0
- package/internal/utils/bytes.mjs +26 -0
- package/internal/utils/bytes.mjs.map +1 -0
- package/internal/utils/env.d.mts +9 -0
- package/internal/utils/env.d.mts.map +1 -0
- package/internal/utils/env.d.ts +9 -0
- package/internal/utils/env.d.ts.map +1 -0
- package/internal/utils/env.js +22 -0
- package/internal/utils/env.js.map +1 -0
- package/internal/utils/env.mjs +18 -0
- package/internal/utils/env.mjs.map +1 -0
- package/internal/utils/log.d.mts +37 -0
- package/internal/utils/log.d.mts.map +1 -0
- package/internal/utils/log.d.ts +37 -0
- package/internal/utils/log.d.ts.map +1 -0
- package/internal/utils/log.js +85 -0
- package/internal/utils/log.js.map +1 -0
- package/internal/utils/log.mjs +79 -0
- package/internal/utils/log.mjs.map +1 -0
- package/internal/utils/path.d.mts +15 -0
- package/internal/utils/path.d.mts.map +1 -0
- package/internal/utils/path.d.ts +15 -0
- package/internal/utils/path.d.ts.map +1 -0
- package/internal/utils/path.js +58 -0
- package/internal/utils/path.js.map +1 -0
- package/internal/utils/path.mjs +53 -0
- package/internal/utils/path.mjs.map +1 -0
- package/internal/utils/sleep.d.mts +2 -0
- package/internal/utils/sleep.d.mts.map +1 -0
- package/internal/utils/sleep.d.ts +2 -0
- package/internal/utils/sleep.d.ts.map +1 -0
- package/internal/utils/sleep.js +7 -0
- package/internal/utils/sleep.js.map +1 -0
- package/internal/utils/sleep.mjs +3 -0
- package/internal/utils/sleep.mjs.map +1 -0
- package/internal/utils/uuid.d.mts +5 -0
- package/internal/utils/uuid.d.mts.map +1 -0
- package/internal/utils/uuid.d.ts +5 -0
- package/internal/utils/uuid.d.ts.map +1 -0
- package/internal/utils/uuid.js +19 -0
- package/internal/utils/uuid.js.map +1 -0
- package/internal/utils/uuid.mjs +15 -0
- package/internal/utils/uuid.mjs.map +1 -0
- package/internal/utils/values.d.mts +16 -0
- package/internal/utils/values.d.mts.map +1 -0
- package/internal/utils/values.d.ts +16 -0
- package/internal/utils/values.d.ts.map +1 -0
- package/internal/utils/values.js +109 -0
- package/internal/utils/values.js.map +1 -0
- package/internal/utils/values.mjs +92 -0
- package/internal/utils/values.mjs.map +1 -0
- package/internal/utils.d.mts +7 -0
- package/internal/utils.d.mts.map +1 -0
- package/internal/utils.d.ts +7 -0
- package/internal/utils.d.ts.map +1 -0
- package/internal/utils.js +11 -0
- package/internal/utils.js.map +1 -0
- package/internal/utils.mjs +8 -0
- package/internal/utils.mjs.map +1 -0
- package/lib/polling.d.mts +48 -0
- package/lib/polling.d.mts.map +1 -0
- package/lib/polling.d.ts.map +1 -1
- package/lib/polling.js +1 -3
- package/lib/polling.js.map +1 -1
- package/lib/polling.mjs +0 -1
- package/lib/polling.mjs.map +1 -1
- package/package.json +129 -64
- package/pagination.d.mts +2 -0
- package/pagination.d.mts.map +1 -0
- package/pagination.d.ts +1 -29
- package/pagination.d.ts.map +1 -1
- package/pagination.js +3 -42
- package/pagination.js.map +1 -1
- package/pagination.mjs +1 -40
- package/pagination.mjs.map +1 -1
- package/resource.d.mts +2 -0
- package/resource.d.mts.map +1 -0
- package/resource.d.ts +1 -5
- package/resource.d.ts.map +1 -1
- package/resource.js +3 -8
- package/resource.js.map +1 -1
- package/resource.mjs +1 -6
- package/resource.mjs.map +1 -1
- package/resources/embeddings.d.mts +55 -0
- package/resources/embeddings.d.mts.map +1 -0
- package/resources/embeddings.d.ts +13 -3
- package/resources/embeddings.d.ts.map +1 -1
- package/resources/embeddings.js +10 -1
- package/resources/embeddings.js.map +1 -1
- package/resources/embeddings.mjs +10 -1
- package/resources/embeddings.mjs.map +1 -1
- package/resources/extractions/content.d.mts +80 -0
- package/resources/extractions/content.d.mts.map +1 -0
- package/resources/extractions/content.d.ts +51 -4
- package/resources/extractions/content.d.ts.map +1 -1
- package/resources/extractions/content.js +1 -1
- package/resources/extractions/content.js.map +1 -1
- package/resources/extractions/content.mjs +1 -1
- package/resources/extractions/content.mjs.map +1 -1
- package/resources/extractions/extractions.d.mts +18 -0
- package/resources/extractions/extractions.d.mts.map +1 -0
- package/resources/extractions/extractions.d.ts +1 -1
- package/resources/extractions/extractions.d.ts.map +1 -1
- package/resources/extractions/extractions.js +5 -27
- package/resources/extractions/extractions.js.map +1 -1
- package/resources/extractions/extractions.mjs +1 -1
- package/resources/extractions/index.d.mts +5 -0
- package/resources/extractions/index.d.mts.map +1 -0
- package/resources/extractions/index.d.ts.map +1 -1
- package/resources/extractions/jobs.d.mts +85 -0
- package/resources/extractions/jobs.d.mts.map +1 -0
- package/resources/extractions/jobs.d.ts +5 -4
- package/resources/extractions/jobs.d.ts.map +1 -1
- package/resources/extractions/jobs.js +4 -3
- package/resources/extractions/jobs.js.map +1 -1
- package/resources/extractions/jobs.mjs +4 -3
- package/resources/extractions/jobs.mjs.map +1 -1
- package/resources/extractions/schema.d.mts +86 -0
- package/resources/extractions/schema.d.mts.map +1 -0
- package/resources/extractions/schema.d.ts +6 -5
- package/resources/extractions/schema.d.ts.map +1 -1
- package/resources/extractions/schema.js +1 -1
- package/resources/extractions/schema.js.map +1 -1
- package/resources/extractions/schema.mjs +1 -1
- package/resources/extractions/schema.mjs.map +1 -1
- package/resources/extractions.d.mts +2 -0
- package/resources/extractions.d.mts.map +1 -0
- package/resources/extractions.d.ts.map +1 -1
- package/resources/extractions.js +2 -15
- package/resources/extractions.js.map +1 -1
- package/resources/files.d.mts +124 -0
- package/resources/files.d.mts.map +1 -0
- package/resources/files.d.ts +15 -16
- package/resources/files.d.ts.map +1 -1
- package/resources/files.js +24 -46
- package/resources/files.js.map +1 -1
- package/resources/files.mjs +23 -21
- package/resources/files.mjs.map +1 -1
- package/resources/index.d.mts +8 -0
- package/resources/index.d.mts.map +1 -0
- package/resources/index.d.ts +2 -2
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js +3 -18
- package/resources/index.js.map +1 -1
- package/resources/index.mjs +2 -2
- package/resources/index.mjs.map +1 -1
- package/resources/parsing/index.d.mts +3 -0
- package/resources/parsing/index.d.mts.map +1 -0
- package/resources/parsing/index.d.ts +1 -1
- package/resources/parsing/index.d.ts.map +1 -1
- package/resources/parsing/index.js +1 -2
- package/resources/parsing/index.js.map +1 -1
- package/resources/parsing/index.mjs +1 -1
- package/resources/parsing/index.mjs.map +1 -1
- package/resources/parsing/jobs.d.mts +293 -0
- package/resources/parsing/jobs.d.mts.map +1 -0
- package/resources/parsing/jobs.d.ts +21 -18
- package/resources/parsing/jobs.d.ts.map +1 -1
- package/resources/parsing/jobs.js +20 -42
- package/resources/parsing/jobs.js.map +1 -1
- package/resources/parsing/jobs.mjs +17 -16
- package/resources/parsing/jobs.mjs.map +1 -1
- package/resources/parsing/parsing.d.mts +10 -0
- package/resources/parsing/parsing.d.mts.map +1 -0
- package/resources/parsing/parsing.d.ts +2 -2
- package/resources/parsing/parsing.d.ts.map +1 -1
- package/resources/parsing/parsing.js +3 -26
- package/resources/parsing/parsing.js.map +1 -1
- package/resources/parsing/parsing.mjs +2 -3
- package/resources/parsing/parsing.mjs.map +1 -1
- package/resources/parsing.d.mts +2 -0
- package/resources/parsing.d.mts.map +1 -0
- package/resources/parsing.d.ts.map +1 -1
- package/resources/parsing.js +2 -15
- package/resources/parsing.js.map +1 -1
- package/resources/shared.d.mts +49 -0
- package/resources/shared.d.mts.map +1 -0
- package/resources/top-level.d.mts +188 -0
- package/resources/top-level.d.mts.map +1 -0
- package/resources/top-level.d.ts +6 -2
- package/resources/top-level.d.ts.map +1 -1
- package/resources/vector-stores/files.d.mts +303 -0
- package/resources/vector-stores/files.d.mts.map +1 -0
- package/resources/vector-stores/files.d.ts +27 -16
- package/resources/vector-stores/files.d.ts.map +1 -1
- package/resources/vector-stores/files.js +25 -47
- package/resources/vector-stores/files.js.map +1 -1
- package/resources/vector-stores/files.mjs +22 -21
- package/resources/vector-stores/files.mjs.map +1 -1
- package/resources/vector-stores/index.d.mts +3 -0
- package/resources/vector-stores/index.d.mts.map +1 -0
- package/resources/vector-stores/index.d.ts +2 -2
- package/resources/vector-stores/index.d.ts.map +1 -1
- package/resources/vector-stores/index.js +1 -3
- package/resources/vector-stores/index.js.map +1 -1
- package/resources/vector-stores/index.mjs +2 -2
- package/resources/vector-stores/index.mjs.map +1 -1
- package/resources/vector-stores/vector-stores.d.mts +440 -0
- package/resources/vector-stores/vector-stores.d.mts.map +1 -0
- package/resources/vector-stores/vector-stores.d.ts +31 -20
- package/resources/vector-stores/vector-stores.d.ts.map +1 -1
- package/resources/vector-stores/vector-stores.js +20 -43
- package/resources/vector-stores/vector-stores.js.map +1 -1
- package/resources/vector-stores/vector-stores.mjs +18 -18
- package/resources/vector-stores/vector-stores.mjs.map +1 -1
- package/resources/vector-stores.d.mts +2 -0
- package/resources/vector-stores.d.mts.map +1 -0
- package/resources/vector-stores.d.ts.map +1 -1
- package/resources/vector-stores.js +2 -15
- package/resources/vector-stores.js.map +1 -1
- package/resources.d.mts +2 -0
- package/resources.d.mts.map +1 -0
- package/resources.d.ts.map +1 -1
- package/resources.js +2 -15
- package/resources.js.map +1 -1
- package/src/api-promise.ts +2 -0
- package/src/client.ts +900 -0
- package/src/core/README.md +3 -0
- package/src/core/api-promise.ts +92 -0
- package/src/core/error.ts +130 -0
- package/src/core/pagination.ts +183 -0
- package/src/core/resource.ts +11 -0
- package/src/core/uploads.ts +2 -0
- package/src/error.ts +2 -130
- package/src/index.ts +6 -330
- package/src/internal/README.md +3 -0
- package/src/internal/builtin-types.ts +93 -0
- package/src/internal/detect-platform.ts +196 -0
- package/src/internal/errors.ts +33 -0
- package/src/internal/headers.ts +97 -0
- package/src/internal/parse.ts +50 -0
- package/src/internal/request-options.ts +37 -0
- package/src/internal/shim-types.d.ts +28 -0
- package/src/internal/shims.ts +107 -0
- package/src/internal/to-file.ts +154 -0
- package/src/internal/types.ts +92 -0
- package/src/internal/uploads.ts +187 -0
- package/src/internal/utils/base64.ts +40 -0
- package/src/internal/utils/bytes.ts +32 -0
- package/src/internal/utils/env.ts +18 -0
- package/src/internal/utils/log.ts +126 -0
- package/src/internal/utils/path.ts +65 -0
- package/src/internal/utils/sleep.ts +3 -0
- package/src/internal/utils/uuid.ts +17 -0
- package/src/internal/utils/values.ts +102 -0
- package/src/internal/utils.ts +8 -0
- package/src/lib/polling.ts +0 -1
- package/src/pagination.ts +2 -82
- package/src/resource.ts +2 -11
- package/src/resources/embeddings.ts +14 -4
- package/src/resources/extractions/content.ts +57 -4
- package/src/resources/extractions/extractions.ts +1 -1
- package/src/resources/extractions/jobs.ts +7 -5
- package/src/resources/extractions/schema.ts +6 -5
- package/src/resources/files.ts +30 -34
- package/src/resources/index.ts +2 -2
- package/src/resources/parsing/index.ts +1 -1
- package/src/resources/parsing/jobs.ts +29 -33
- package/src/resources/parsing/parsing.ts +2 -3
- package/src/resources/top-level.ts +13 -4
- package/src/resources/vector-stores/files.ts +51 -49
- package/src/resources/vector-stores/index.ts +4 -2
- package/src/resources/vector-stores/vector-stores.ts +45 -40
- package/src/tsconfig.json +2 -2
- package/src/uploads.ts +2 -255
- package/src/version.ts +1 -1
- package/uploads.d.mts +2 -0
- package/uploads.d.mts.map +1 -0
- package/uploads.d.ts +1 -74
- package/uploads.d.ts.map +1 -1
- package/uploads.js +3 -168
- package/uploads.js.map +1 -1
- package/uploads.mjs +1 -157
- package/uploads.mjs.map +1 -1
- package/version.d.mts +2 -0
- package/version.d.mts.map +1 -0
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
- package/_shims/MultipartBody.d.ts +0 -9
- package/_shims/MultipartBody.d.ts.map +0 -1
- package/_shims/MultipartBody.js +0 -16
- package/_shims/MultipartBody.js.map +0 -1
- package/_shims/MultipartBody.mjs +0 -12
- package/_shims/MultipartBody.mjs.map +0 -1
- package/_shims/README.md +0 -46
- package/_shims/auto/runtime-bun.d.ts +0 -5
- package/_shims/auto/runtime-bun.d.ts.map +0 -1
- package/_shims/auto/runtime-bun.js +0 -21
- package/_shims/auto/runtime-bun.js.map +0 -1
- package/_shims/auto/runtime-bun.mjs +0 -2
- package/_shims/auto/runtime-bun.mjs.map +0 -1
- package/_shims/auto/runtime-node.d.ts +0 -5
- package/_shims/auto/runtime-node.d.ts.map +0 -1
- package/_shims/auto/runtime-node.js +0 -21
- package/_shims/auto/runtime-node.js.map +0 -1
- package/_shims/auto/runtime-node.mjs +0 -2
- package/_shims/auto/runtime-node.mjs.map +0 -1
- package/_shims/auto/runtime.d.ts +0 -5
- package/_shims/auto/runtime.d.ts.map +0 -1
- package/_shims/auto/runtime.js +0 -21
- package/_shims/auto/runtime.js.map +0 -1
- package/_shims/auto/runtime.mjs +0 -2
- package/_shims/auto/runtime.mjs.map +0 -1
- package/_shims/auto/types-node.d.ts +0 -5
- package/_shims/auto/types-node.d.ts.map +0 -1
- package/_shims/auto/types-node.js +0 -21
- package/_shims/auto/types-node.js.map +0 -1
- package/_shims/auto/types-node.mjs +0 -2
- package/_shims/auto/types-node.mjs.map +0 -1
- package/_shims/auto/types.d.ts +0 -101
- package/_shims/auto/types.js +0 -3
- package/_shims/auto/types.mjs +0 -3
- package/_shims/bun-runtime.d.ts +0 -6
- package/_shims/bun-runtime.d.ts.map +0 -1
- package/_shims/bun-runtime.js +0 -14
- package/_shims/bun-runtime.js.map +0 -1
- package/_shims/bun-runtime.mjs +0 -10
- package/_shims/bun-runtime.mjs.map +0 -1
- package/_shims/index.d.ts +0 -83
- package/_shims/index.js +0 -17
- package/_shims/index.mjs +0 -11
- package/_shims/manual-types.d.ts +0 -12
- package/_shims/manual-types.js +0 -3
- package/_shims/manual-types.mjs +0 -3
- package/_shims/node-runtime.d.ts +0 -3
- package/_shims/node-runtime.d.ts.map +0 -1
- package/_shims/node-runtime.js +0 -89
- package/_shims/node-runtime.js.map +0 -1
- package/_shims/node-runtime.mjs +0 -56
- package/_shims/node-runtime.mjs.map +0 -1
- package/_shims/node-types.d.ts +0 -42
- package/_shims/node-types.js +0 -3
- package/_shims/node-types.mjs +0 -3
- package/_shims/registry.d.ts +0 -37
- package/_shims/registry.d.ts.map +0 -1
- package/_shims/registry.js +0 -41
- package/_shims/registry.js.map +0 -1
- package/_shims/registry.mjs +0 -37
- package/_shims/registry.mjs.map +0 -1
- package/_shims/web-runtime.d.ts +0 -5
- package/_shims/web-runtime.d.ts.map +0 -1
- package/_shims/web-runtime.js +0 -78
- package/_shims/web-runtime.js.map +0 -1
- package/_shims/web-runtime.mjs +0 -71
- package/_shims/web-runtime.mjs.map +0 -1
- package/_shims/web-types.d.ts +0 -83
- package/_shims/web-types.js +0 -3
- package/_shims/web-types.mjs +0 -3
- package/core.d.ts +0 -252
- package/core.d.ts.map +0 -1
- package/core.js +0 -917
- package/core.js.map +0 -1
- package/core.mjs +0 -885
- package/core.mjs.map +0 -1
- package/shims/node.d.ts +0 -30
- package/shims/node.d.ts.map +0 -1
- package/shims/node.js +0 -31
- package/shims/node.js.map +0 -1
- package/shims/node.mjs +0 -5
- package/shims/node.mjs.map +0 -1
- package/shims/web.d.ts +0 -26
- package/shims/web.d.ts.map +0 -1
- package/shims/web.js +0 -31
- package/shims/web.js.map +0 -1
- package/shims/web.mjs +0 -5
- package/shims/web.mjs.map +0 -1
- package/src/_shims/MultipartBody.ts +0 -9
- package/src/_shims/README.md +0 -46
- package/src/_shims/auto/runtime-bun.ts +0 -4
- package/src/_shims/auto/runtime-node.ts +0 -4
- package/src/_shims/auto/runtime.ts +0 -4
- package/src/_shims/auto/types-node.ts +0 -4
- package/src/_shims/auto/types.d.ts +0 -101
- package/src/_shims/auto/types.js +0 -3
- package/src/_shims/auto/types.mjs +0 -3
- package/src/_shims/bun-runtime.ts +0 -14
- package/src/_shims/index.d.ts +0 -83
- package/src/_shims/index.js +0 -17
- package/src/_shims/index.mjs +0 -11
- package/src/_shims/manual-types.d.ts +0 -12
- package/src/_shims/manual-types.js +0 -3
- package/src/_shims/manual-types.mjs +0 -3
- package/src/_shims/node-runtime.ts +0 -81
- package/src/_shims/node-types.d.ts +0 -42
- package/src/_shims/node-types.js +0 -3
- package/src/_shims/node-types.mjs +0 -3
- package/src/_shims/registry.ts +0 -67
- package/src/_shims/web-runtime.ts +0 -103
- package/src/_shims/web-types.d.ts +0 -83
- package/src/_shims/web-types.js +0 -3
- package/src/_shims/web-types.mjs +0 -3
- package/src/core.ts +0 -1227
- package/src/shims/node.ts +0 -50
- package/src/shims/web.ts +0 -50
@@ -0,0 +1,188 @@
|
|
1
|
+
import * as Shared from "./shared.mjs";
|
2
|
+
export interface Embedding {
|
3
|
+
/**
|
4
|
+
* The encoded embedding.
|
5
|
+
*/
|
6
|
+
embedding: Array<number> | Array<number> | string;
|
7
|
+
/**
|
8
|
+
* The index of the embedding.
|
9
|
+
*/
|
10
|
+
index: number;
|
11
|
+
/**
|
12
|
+
* The object type of the embedding.
|
13
|
+
*/
|
14
|
+
object?: 'embedding';
|
15
|
+
}
|
16
|
+
export interface EmbeddingCreateResponse {
|
17
|
+
/**
|
18
|
+
* The usage of the model
|
19
|
+
*/
|
20
|
+
usage: Shared.Usage;
|
21
|
+
/**
|
22
|
+
* The model used
|
23
|
+
*/
|
24
|
+
model: string;
|
25
|
+
/**
|
26
|
+
* The created embeddings.
|
27
|
+
*/
|
28
|
+
data: Array<Embedding> | Array<MultiEncodingEmbedding>;
|
29
|
+
/**
|
30
|
+
* The object type of the response
|
31
|
+
*/
|
32
|
+
object?: 'list' | 'parsing_job' | 'extraction_job' | 'embedding' | 'embedding_dict' | 'rank_result' | 'file' | 'vector_store' | 'vector_store.file' | 'api_key' | 'data_source' | 'data_source.connector';
|
33
|
+
/**
|
34
|
+
* Whether the embeddings are normalized.
|
35
|
+
*/
|
36
|
+
normalized: boolean;
|
37
|
+
/**
|
38
|
+
* The encoding formats of the embeddings.
|
39
|
+
*/
|
40
|
+
encoding_format: 'float' | 'float16' | 'base64' | 'binary' | 'ubinary' | 'int8' | 'uint8' | Array<'float' | 'float16' | 'base64' | 'binary' | 'ubinary' | 'int8' | 'uint8'>;
|
41
|
+
/**
|
42
|
+
* The number of dimensions used for the embeddings.
|
43
|
+
*/
|
44
|
+
dimensions: number | null;
|
45
|
+
}
|
46
|
+
export interface MultiEncodingEmbedding {
|
47
|
+
/**
|
48
|
+
* The encoded embedding data by encoding format.Returned, if more than one
|
49
|
+
* encoding format is used.
|
50
|
+
*/
|
51
|
+
embedding: MultiEncodingEmbedding.Embedding;
|
52
|
+
/**
|
53
|
+
* The index of the embedding.
|
54
|
+
*/
|
55
|
+
index: number;
|
56
|
+
/**
|
57
|
+
* The object type of the embedding.
|
58
|
+
*/
|
59
|
+
object?: 'embedding_dict';
|
60
|
+
}
|
61
|
+
export declare namespace MultiEncodingEmbedding {
|
62
|
+
/**
|
63
|
+
* The encoded embedding data by encoding format.Returned, if more than one
|
64
|
+
* encoding format is used.
|
65
|
+
*/
|
66
|
+
interface Embedding {
|
67
|
+
float?: Array<number>;
|
68
|
+
int8?: Array<number>;
|
69
|
+
uint8?: Array<number>;
|
70
|
+
binary?: Array<number>;
|
71
|
+
ubinary?: Array<number>;
|
72
|
+
base64?: string;
|
73
|
+
}
|
74
|
+
}
|
75
|
+
/**
|
76
|
+
* Info Pydantic Response Service Message
|
77
|
+
*/
|
78
|
+
export interface InfoResponse {
|
79
|
+
name: string;
|
80
|
+
version: string;
|
81
|
+
}
|
82
|
+
export interface RerankResponse {
|
83
|
+
/**
|
84
|
+
* The usage of the model
|
85
|
+
*/
|
86
|
+
usage: Shared.Usage;
|
87
|
+
/**
|
88
|
+
* The model used
|
89
|
+
*/
|
90
|
+
model: string;
|
91
|
+
/**
|
92
|
+
* The ranked documents.
|
93
|
+
*/
|
94
|
+
data: Array<RerankResponse.Data>;
|
95
|
+
/**
|
96
|
+
* The object type of the response
|
97
|
+
*/
|
98
|
+
object?: 'list' | 'parsing_job' | 'extraction_job' | 'embedding' | 'embedding_dict' | 'rank_result' | 'file' | 'vector_store' | 'vector_store.file' | 'api_key' | 'data_source' | 'data_source.connector';
|
99
|
+
/**
|
100
|
+
* The number of documents to return.
|
101
|
+
*/
|
102
|
+
top_k: number;
|
103
|
+
/**
|
104
|
+
* Whether to return the documents.
|
105
|
+
*/
|
106
|
+
return_input: boolean;
|
107
|
+
}
|
108
|
+
export declare namespace RerankResponse {
|
109
|
+
interface Data {
|
110
|
+
/**
|
111
|
+
* The index of the document.
|
112
|
+
*/
|
113
|
+
index: number;
|
114
|
+
/**
|
115
|
+
* The score of the document.
|
116
|
+
*/
|
117
|
+
score: number;
|
118
|
+
/**
|
119
|
+
* The input document.
|
120
|
+
*/
|
121
|
+
input?: unknown;
|
122
|
+
/**
|
123
|
+
* The object type.
|
124
|
+
*/
|
125
|
+
object?: 'rank_result';
|
126
|
+
}
|
127
|
+
}
|
128
|
+
export interface EmbedParams {
|
129
|
+
/**
|
130
|
+
* The model to use for creating embeddings.
|
131
|
+
*/
|
132
|
+
model: string;
|
133
|
+
/**
|
134
|
+
* The input to create embeddings for.
|
135
|
+
*/
|
136
|
+
input: string | Array<string>;
|
137
|
+
/**
|
138
|
+
* The number of dimensions to use for the embeddings.
|
139
|
+
*/
|
140
|
+
dimensions?: number | null;
|
141
|
+
/**
|
142
|
+
* The prompt to use for the embedding creation.
|
143
|
+
*/
|
144
|
+
prompt?: string | null;
|
145
|
+
/**
|
146
|
+
* Whether to normalize the embeddings.
|
147
|
+
*/
|
148
|
+
normalized?: boolean;
|
149
|
+
/**
|
150
|
+
* The encoding format(s) of the embeddings. Can be a single format or a list of
|
151
|
+
* formats.
|
152
|
+
*/
|
153
|
+
encoding_format?: 'float' | 'float16' | 'base64' | 'binary' | 'ubinary' | 'int8' | 'uint8' | Array<'float' | 'float16' | 'base64' | 'binary' | 'ubinary' | 'int8' | 'uint8'>;
|
154
|
+
}
|
155
|
+
export interface RerankParams {
|
156
|
+
/**
|
157
|
+
* The model to use for reranking documents.
|
158
|
+
*/
|
159
|
+
model?: string;
|
160
|
+
/**
|
161
|
+
* The query to rerank the documents.
|
162
|
+
*/
|
163
|
+
query: string;
|
164
|
+
/**
|
165
|
+
* The input documents to rerank.
|
166
|
+
*/
|
167
|
+
input: Array<string | unknown | Array<unknown>>;
|
168
|
+
/**
|
169
|
+
* The fields of the documents to rank.
|
170
|
+
*/
|
171
|
+
rank_fields?: Array<string> | null;
|
172
|
+
/**
|
173
|
+
* The number of documents to return.
|
174
|
+
*/
|
175
|
+
top_k?: number;
|
176
|
+
/**
|
177
|
+
* Whether to return the documents.
|
178
|
+
*/
|
179
|
+
return_input?: boolean;
|
180
|
+
/**
|
181
|
+
* Wether or not to rewrite the query before passing it to the reranking model
|
182
|
+
*/
|
183
|
+
rewrite_query?: boolean;
|
184
|
+
}
|
185
|
+
export declare namespace TopLevel {
|
186
|
+
export { type Embedding as Embedding, type EmbeddingCreateResponse as EmbeddingCreateResponse, type MultiEncodingEmbedding as MultiEncodingEmbedding, type InfoResponse as InfoResponse, type RerankResponse as RerankResponse, type EmbedParams as EmbedParams, type RerankParams as RerankParams, };
|
187
|
+
}
|
188
|
+
//# sourceMappingURL=top-level.d.mts.map
|
@@ -0,0 +1 @@
|
|
1
|
+
{"version":3,"file":"top-level.d.mts","sourceRoot":"","sources":["../src/resources/top-level.ts"],"names":[],"mappings":"OAEO,KAAK,MAAM;AAElB,MAAM,WAAW,SAAS;IACxB;;OAEG;IACH,SAAS,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC;IAElD;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,MAAM,CAAC,EAAE,WAAW,CAAC;CACtB;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC,KAAK,CAAC;IAEpB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,SAAS,CAAC,GAAG,KAAK,CAAC,sBAAsB,CAAC,CAAC;IAEvD;;OAEG;IACH,MAAM,CAAC,EACH,MAAM,GACN,aAAa,GACb,gBAAgB,GAChB,WAAW,GACX,gBAAgB,GAChB,aAAa,GACb,MAAM,GACN,cAAc,GACd,mBAAmB,GACnB,SAAS,GACT,aAAa,GACb,uBAAuB,CAAC;IAE5B;;OAEG;IACH,UAAU,EAAE,OAAO,CAAC;IAEpB;;OAEG;IACH,eAAe,EACX,OAAO,GACP,SAAS,GACT,QAAQ,GACR,QAAQ,GACR,SAAS,GACT,MAAM,GACN,OAAO,GACP,KAAK,CAAC,OAAO,GAAG,SAAS,GAAG,QAAQ,GAAG,QAAQ,GAAG,SAAS,GAAG,MAAM,GAAG,OAAO,CAAC,CAAC;IAEpF;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED,MAAM,WAAW,sBAAsB;IACrC;;;OAGG;IACH,SAAS,EAAE,sBAAsB,CAAC,SAAS,CAAC;IAE5C;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,MAAM,CAAC,EAAE,gBAAgB,CAAC;CAC3B;AAED,yBAAiB,sBAAsB,CAAC;IACtC;;;OAGG;IACH,UAAiB,SAAS;QACxB,KAAK,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEtB,IAAI,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAErB,KAAK,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEtB,MAAM,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEvB,OAAO,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAExB,MAAM,CAAC,EAAE,MAAM,CAAC;KACjB;CACF;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,MAAM,CAAC;IAEb,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC,KAAK,CAAC;IAEpB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;IAEjC;;OAEG;IACH,MAAM,CAAC,EACH,MAAM,GACN,aAAa,GACb,gBAAgB,GAChB,WAAW,GACX,gBAAgB,GAChB,aAAa,GACb,MAAM,GACN,cAAc,GACd,mBAAmB,GACnB,SAAS,GACT,aAAa,GACb,uBAAuB,CAAC;IAE5B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,YAAY,EAAE,OAAO,CAAC;CACvB;AAED,yBAAiB,cAAc,CAAC;IAC9B,UAAiB,IAAI;QACnB;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,KAAK,CAAC,EAAE,OAAO,CAAC;QAEhB;;WAEG;QACH,MAAM,CAAC,EAAE,aAAa,CAAC;KACxB;CACF;AAED,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,KAAK,EAAE,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC;IAE9B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB;;;OAGG;IACH,eAAe,CAAC,EACZ,OAAO,GACP,SAAS,GACT,QAAQ,GACR,QAAQ,GACR,SAAS,GACT,MAAM,GACN,OAAO,GACP,KAAK,CAAC,OAAO,GAAG,SAAS,GAAG,QAAQ,GAAG,QAAQ,GAAG,SAAS,GAAG,MAAM,GAAG,OAAO,CAAC,CAAC;CACrF;AAED,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC,MAAM,GAAG,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;IAEhD;;OAEG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB;AAED,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,SAAS,IAAI,SAAS,EAC3B,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,YAAY,IAAI,YAAY,GAClC,CAAC;CACH"}
|
package/resources/top-level.d.ts
CHANGED
@@ -29,7 +29,7 @@ export interface EmbeddingCreateResponse {
|
|
29
29
|
/**
|
30
30
|
* The object type of the response
|
31
31
|
*/
|
32
|
-
object?: 'list' | 'parsing_job' | '
|
32
|
+
object?: 'list' | 'parsing_job' | 'extraction_job' | 'embedding' | 'embedding_dict' | 'rank_result' | 'file' | 'vector_store' | 'vector_store.file' | 'api_key' | 'data_source' | 'data_source.connector';
|
33
33
|
/**
|
34
34
|
* Whether the embeddings are normalized.
|
35
35
|
*/
|
@@ -95,7 +95,7 @@ export interface RerankResponse {
|
|
95
95
|
/**
|
96
96
|
* The object type of the response
|
97
97
|
*/
|
98
|
-
object?: 'list' | 'parsing_job' | '
|
98
|
+
object?: 'list' | 'parsing_job' | 'extraction_job' | 'embedding' | 'embedding_dict' | 'rank_result' | 'file' | 'vector_store' | 'vector_store.file' | 'api_key' | 'data_source' | 'data_source.connector';
|
99
99
|
/**
|
100
100
|
* The number of documents to return.
|
101
101
|
*/
|
@@ -177,6 +177,10 @@ export interface RerankParams {
|
|
177
177
|
* Whether to return the documents.
|
178
178
|
*/
|
179
179
|
return_input?: boolean;
|
180
|
+
/**
|
181
|
+
* Wether or not to rewrite the query before passing it to the reranking model
|
182
|
+
*/
|
183
|
+
rewrite_query?: boolean;
|
180
184
|
}
|
181
185
|
export declare namespace TopLevel {
|
182
186
|
export { type Embedding as Embedding, type EmbeddingCreateResponse as EmbeddingCreateResponse, type MultiEncodingEmbedding as MultiEncodingEmbedding, type InfoResponse as InfoResponse, type RerankResponse as RerankResponse, type EmbedParams as EmbedParams, type RerankParams as RerankParams, };
|
@@ -1 +1 @@
|
|
1
|
-
{"version":3,"file":"top-level.d.ts","sourceRoot":"","sources":["../src/resources/top-level.ts"],"names":[],"mappings":"
|
1
|
+
{"version":3,"file":"top-level.d.ts","sourceRoot":"","sources":["../src/resources/top-level.ts"],"names":[],"mappings":"OAEO,KAAK,MAAM;AAElB,MAAM,WAAW,SAAS;IACxB;;OAEG;IACH,SAAS,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC;IAElD;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,MAAM,CAAC,EAAE,WAAW,CAAC;CACtB;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC,KAAK,CAAC;IAEpB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,SAAS,CAAC,GAAG,KAAK,CAAC,sBAAsB,CAAC,CAAC;IAEvD;;OAEG;IACH,MAAM,CAAC,EACH,MAAM,GACN,aAAa,GACb,gBAAgB,GAChB,WAAW,GACX,gBAAgB,GAChB,aAAa,GACb,MAAM,GACN,cAAc,GACd,mBAAmB,GACnB,SAAS,GACT,aAAa,GACb,uBAAuB,CAAC;IAE5B;;OAEG;IACH,UAAU,EAAE,OAAO,CAAC;IAEpB;;OAEG;IACH,eAAe,EACX,OAAO,GACP,SAAS,GACT,QAAQ,GACR,QAAQ,GACR,SAAS,GACT,MAAM,GACN,OAAO,GACP,KAAK,CAAC,OAAO,GAAG,SAAS,GAAG,QAAQ,GAAG,QAAQ,GAAG,SAAS,GAAG,MAAM,GAAG,OAAO,CAAC,CAAC;IAEpF;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED,MAAM,WAAW,sBAAsB;IACrC;;;OAGG;IACH,SAAS,EAAE,sBAAsB,CAAC,SAAS,CAAC;IAE5C;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,MAAM,CAAC,EAAE,gBAAgB,CAAC;CAC3B;AAED,yBAAiB,sBAAsB,CAAC;IACtC;;;OAGG;IACH,UAAiB,SAAS;QACxB,KAAK,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEtB,IAAI,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAErB,KAAK,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEtB,MAAM,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEvB,OAAO,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAExB,MAAM,CAAC,EAAE,MAAM,CAAC;KACjB;CACF;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,MAAM,CAAC;IAEb,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC,KAAK,CAAC;IAEpB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;IAEjC;;OAEG;IACH,MAAM,CAAC,EACH,MAAM,GACN,aAAa,GACb,gBAAgB,GAChB,WAAW,GACX,gBAAgB,GAChB,aAAa,GACb,MAAM,GACN,cAAc,GACd,mBAAmB,GACnB,SAAS,GACT,aAAa,GACb,uBAAuB,CAAC;IAE5B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,YAAY,EAAE,OAAO,CAAC;CACvB;AAED,yBAAiB,cAAc,CAAC;IAC9B,UAAiB,IAAI;QACnB;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,KAAK,CAAC,EAAE,OAAO,CAAC;QAEhB;;WAEG;QACH,MAAM,CAAC,EAAE,aAAa,CAAC;KACxB;CACF;AAED,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,KAAK,EAAE,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC;IAE9B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB;;;OAGG;IACH,eAAe,CAAC,EACZ,OAAO,GACP,SAAS,GACT,QAAQ,GACR,QAAQ,GACR,SAAS,GACT,MAAM,GACN,OAAO,GACP,KAAK,CAAC,OAAO,GAAG,SAAS,GAAG,QAAQ,GAAG,QAAQ,GAAG,SAAS,GAAG,MAAM,GAAG,OAAO,CAAC,CAAC;CACrF;AAED,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC,MAAM,GAAG,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;IAEhD;;OAEG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB;AAED,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,SAAS,IAAI,SAAS,EAC3B,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,YAAY,IAAI,YAAY,GAClC,CAAC;CACH"}
|
@@ -0,0 +1,303 @@
|
|
1
|
+
import { APIResource } from "../../core/resource.mjs";
|
2
|
+
import * as Shared from "../shared.mjs";
|
3
|
+
import * as VectorStoresAPI from "./vector-stores.mjs";
|
4
|
+
import { APIPromise } from "../../core/api-promise.mjs";
|
5
|
+
import { LimitOffset, type LimitOffsetParams, PagePromise } from "../../core/pagination.mjs";
|
6
|
+
import { RequestOptions } from "../../internal/request-options.mjs";
|
7
|
+
import { Uploadable } from "../../uploads.mjs";
|
8
|
+
export declare class Files extends APIResource {
|
9
|
+
/**
|
10
|
+
* Upload a new file to a vector store for indexing.
|
11
|
+
*
|
12
|
+
* Args: vector_store_id: The ID of the vector store to upload to file: The file to
|
13
|
+
* upload and index
|
14
|
+
*
|
15
|
+
* Returns: VectorStoreFile: Details of the uploaded and indexed file
|
16
|
+
*/
|
17
|
+
create(vectorStoreID: string, body: FileCreateParams, options?: RequestOptions): APIPromise<VectorStoreFile>;
|
18
|
+
/**
|
19
|
+
* Get details of a specific file in a vector store.
|
20
|
+
*
|
21
|
+
* Args: vector_store_id: The ID of the vector store file_id: The ID of the file
|
22
|
+
*
|
23
|
+
* Returns: VectorStoreFile: Details of the vector store file
|
24
|
+
*/
|
25
|
+
retrieve(fileID: string, params: FileRetrieveParams, options?: RequestOptions): APIPromise<VectorStoreFile>;
|
26
|
+
/**
|
27
|
+
* List files indexed in a vector store with pagination.
|
28
|
+
*
|
29
|
+
* Args: vector_store_id: The ID of the vector store pagination: Pagination
|
30
|
+
* parameters
|
31
|
+
*
|
32
|
+
* Returns: VectorStoreFileListResponse: Paginated list of vector store files
|
33
|
+
*/
|
34
|
+
list(vectorStoreID: string, query?: FileListParams | null | undefined, options?: RequestOptions): PagePromise<VectorStoreFilesLimitOffset, VectorStoreFile>;
|
35
|
+
/**
|
36
|
+
* Delete a file from a vector store.
|
37
|
+
*
|
38
|
+
* Args: vector_store_id: The ID of the vector store file_id: The ID of the file to
|
39
|
+
* delete
|
40
|
+
*
|
41
|
+
* Returns: VectorStoreFileDeleted: The deleted file
|
42
|
+
*/
|
43
|
+
delete(fileID: string, params: FileDeleteParams, options?: RequestOptions): APIPromise<FileDeleteResponse>;
|
44
|
+
/**
|
45
|
+
* Perform semantic search across complete vector store files.
|
46
|
+
*
|
47
|
+
* This endpoint searches through vector store files using semantic similarity
|
48
|
+
* matching. Unlike chunk search, it returns complete matching files rather than
|
49
|
+
* individual chunks. Supports complex search queries with filters and returns
|
50
|
+
* relevance-scored results.
|
51
|
+
*
|
52
|
+
* Args: search_params: Search configuration including: - query text or
|
53
|
+
* embeddings - metadata filters - pagination parameters - sorting preferences
|
54
|
+
* \_state: API state dependency \_ctx: Service context dependency
|
55
|
+
*
|
56
|
+
* Returns: VectorStoreSearchFileResponse containing: - List of matched files with
|
57
|
+
* relevance scores - Pagination details including total result count
|
58
|
+
*
|
59
|
+
* Raises: HTTPException (400): If search parameters are invalid HTTPException
|
60
|
+
* (404): If no vector stores are found to search
|
61
|
+
*/
|
62
|
+
search(body: FileSearchParams, options?: RequestOptions): APIPromise<FileSearchResponse>;
|
63
|
+
/**
|
64
|
+
* Poll for a file's processing status until it reaches a terminal state.
|
65
|
+
*
|
66
|
+
* @param vectorStoreId - The ID of the vector store
|
67
|
+
* @param fileId - The ID of the file to poll
|
68
|
+
* @param pollIntervalMs - The interval between polls in milliseconds (default: 500)
|
69
|
+
* @param pollTimeoutMs - The maximum time to poll for in milliseconds (default: no timeout)
|
70
|
+
* @param options - Additional request options
|
71
|
+
* @returns The file object once it reaches a terminal state
|
72
|
+
*/
|
73
|
+
poll(vectorStoreId: string, fileId: string, pollIntervalMs?: number, pollTimeoutMs?: number, options?: RequestOptions): Promise<VectorStoreFile>;
|
74
|
+
/**
|
75
|
+
* Create a file in a vector store and wait for it to be processed.
|
76
|
+
*
|
77
|
+
* @param vectorStoreId - The ID of the vector store to upload to
|
78
|
+
* @param body - The file creation parameters
|
79
|
+
* @param pollIntervalMs - The interval between polls in milliseconds (default: 500)
|
80
|
+
* @param pollTimeoutMs - The maximum time to poll for in milliseconds (default: no timeout)
|
81
|
+
* @param options - Additional request options
|
82
|
+
* @returns The file object once it reaches a terminal state
|
83
|
+
*/
|
84
|
+
createAndPoll(vectorStoreId: string, body: FileCreateParams, pollIntervalMs?: number, pollTimeoutMs?: number, options?: RequestOptions): Promise<VectorStoreFile>;
|
85
|
+
/**
|
86
|
+
* Upload a file to the files API and then create a file in a vector store.
|
87
|
+
* Note the file will be asynchronously processed.
|
88
|
+
*
|
89
|
+
* @param vectorStoreId - The ID of the vector store to add the file to
|
90
|
+
* @param file - The file to upload
|
91
|
+
* @param body - Additional parameters for the vector store file
|
92
|
+
* @param options - Additional request options
|
93
|
+
* @returns The created vector store file
|
94
|
+
*/
|
95
|
+
upload(vectorStoreId: string, file: Uploadable, body?: Omit<FileCreateParams, 'file_id'>, options?: RequestOptions): Promise<VectorStoreFile>;
|
96
|
+
/**
|
97
|
+
* Upload a file to files API, create a file in a vector store, and poll until processing is complete.
|
98
|
+
*
|
99
|
+
* @param vectorStoreId - The ID of the vector store to add the file to
|
100
|
+
* @param file - The file to upload
|
101
|
+
* @param body - Additional parameters for the vector store file
|
102
|
+
* @param pollIntervalMs - The interval between polls in milliseconds (default: 500)
|
103
|
+
* @param pollTimeoutMs - The maximum time to poll for in milliseconds (default: no timeout)
|
104
|
+
* @param options - Additional request options
|
105
|
+
* @returns The vector store file object once it reaches a terminal state
|
106
|
+
*/
|
107
|
+
uploadAndPoll(vectorStoreId: string, file: Uploadable, body?: Omit<FileCreateParams, 'file_id'>, pollIntervalMs?: number, pollTimeoutMs?: number, options?: RequestOptions): Promise<VectorStoreFile>;
|
108
|
+
}
|
109
|
+
export type VectorStoreFilesLimitOffset = LimitOffset<VectorStoreFile>;
|
110
|
+
/**
|
111
|
+
* Represents a scored file stored in a vector store.
|
112
|
+
*/
|
113
|
+
export interface ScoredVectorStoreFile {
|
114
|
+
/**
|
115
|
+
* Unique identifier for the file
|
116
|
+
*/
|
117
|
+
id: string;
|
118
|
+
/**
|
119
|
+
* Name of the file
|
120
|
+
*/
|
121
|
+
filename?: string;
|
122
|
+
/**
|
123
|
+
* Optional file metadata
|
124
|
+
*/
|
125
|
+
metadata?: unknown;
|
126
|
+
/**
|
127
|
+
* Processing status of the file
|
128
|
+
*/
|
129
|
+
status?: string;
|
130
|
+
/**
|
131
|
+
* Last error message if processing failed
|
132
|
+
*/
|
133
|
+
last_error?: unknown;
|
134
|
+
/**
|
135
|
+
* ID of the containing vector store
|
136
|
+
*/
|
137
|
+
vector_store_id: string;
|
138
|
+
/**
|
139
|
+
* Timestamp of vector store file creation
|
140
|
+
*/
|
141
|
+
created_at: string;
|
142
|
+
/**
|
143
|
+
* Version number of the file
|
144
|
+
*/
|
145
|
+
version?: number | null;
|
146
|
+
/**
|
147
|
+
* Storage usage in bytes
|
148
|
+
*/
|
149
|
+
usage_bytes?: number | null;
|
150
|
+
/**
|
151
|
+
* Type of the object
|
152
|
+
*/
|
153
|
+
object?: 'vector_store.file';
|
154
|
+
/**
|
155
|
+
* score of the file
|
156
|
+
*/
|
157
|
+
score: number;
|
158
|
+
/**
|
159
|
+
* chunks
|
160
|
+
*/
|
161
|
+
chunks: Array<VectorStoresAPI.ScoredVectorStoreChunk> | null;
|
162
|
+
}
|
163
|
+
/**
|
164
|
+
* Represents a file stored in a vector store.
|
165
|
+
*/
|
166
|
+
export interface VectorStoreFile {
|
167
|
+
/**
|
168
|
+
* Unique identifier for the file
|
169
|
+
*/
|
170
|
+
id: string;
|
171
|
+
/**
|
172
|
+
* Name of the file
|
173
|
+
*/
|
174
|
+
filename?: string;
|
175
|
+
/**
|
176
|
+
* Optional file metadata
|
177
|
+
*/
|
178
|
+
metadata?: unknown;
|
179
|
+
/**
|
180
|
+
* Processing status of the file
|
181
|
+
*/
|
182
|
+
status?: string;
|
183
|
+
/**
|
184
|
+
* Last error message if processing failed
|
185
|
+
*/
|
186
|
+
last_error?: unknown;
|
187
|
+
/**
|
188
|
+
* ID of the containing vector store
|
189
|
+
*/
|
190
|
+
vector_store_id: string;
|
191
|
+
/**
|
192
|
+
* Timestamp of vector store file creation
|
193
|
+
*/
|
194
|
+
created_at: string;
|
195
|
+
/**
|
196
|
+
* Version number of the file
|
197
|
+
*/
|
198
|
+
version?: number | null;
|
199
|
+
/**
|
200
|
+
* Storage usage in bytes
|
201
|
+
*/
|
202
|
+
usage_bytes?: number | null;
|
203
|
+
/**
|
204
|
+
* Type of the object
|
205
|
+
*/
|
206
|
+
object?: 'vector_store.file';
|
207
|
+
}
|
208
|
+
/**
|
209
|
+
* Response model for file deletion.
|
210
|
+
*/
|
211
|
+
export interface FileDeleteResponse {
|
212
|
+
/**
|
213
|
+
* ID of the deleted file
|
214
|
+
*/
|
215
|
+
id: string;
|
216
|
+
/**
|
217
|
+
* Whether the deletion was successful
|
218
|
+
*/
|
219
|
+
deleted?: boolean;
|
220
|
+
/**
|
221
|
+
* Type of the deleted object
|
222
|
+
*/
|
223
|
+
object?: 'vector_store.file';
|
224
|
+
}
|
225
|
+
export interface FileSearchResponse {
|
226
|
+
/**
|
227
|
+
* The object type of the response
|
228
|
+
*/
|
229
|
+
object?: 'list';
|
230
|
+
/**
|
231
|
+
* The list of scored vector store files
|
232
|
+
*/
|
233
|
+
data: Array<ScoredVectorStoreFile>;
|
234
|
+
}
|
235
|
+
export interface FileCreateParams {
|
236
|
+
/**
|
237
|
+
* ID of the file to add
|
238
|
+
*/
|
239
|
+
file_id: string;
|
240
|
+
/**
|
241
|
+
* Optional metadata for the file
|
242
|
+
*/
|
243
|
+
metadata?: unknown;
|
244
|
+
/**
|
245
|
+
* Strategy for adding the file
|
246
|
+
*/
|
247
|
+
experimental?: FileCreateParams.Experimental;
|
248
|
+
}
|
249
|
+
export declare namespace FileCreateParams {
|
250
|
+
/**
|
251
|
+
* Strategy for adding the file
|
252
|
+
*/
|
253
|
+
interface Experimental {
|
254
|
+
/**
|
255
|
+
* Strategy for adding the file
|
256
|
+
*/
|
257
|
+
parsing_strategy?: 'fast' | 'high_quality';
|
258
|
+
/**
|
259
|
+
* Whether to contextualize the file
|
260
|
+
*/
|
261
|
+
contextualization?: boolean;
|
262
|
+
}
|
263
|
+
}
|
264
|
+
export interface FileRetrieveParams {
|
265
|
+
/**
|
266
|
+
* The ID of the vector store
|
267
|
+
*/
|
268
|
+
vector_store_id: string;
|
269
|
+
}
|
270
|
+
export interface FileListParams extends LimitOffsetParams {
|
271
|
+
}
|
272
|
+
export interface FileDeleteParams {
|
273
|
+
/**
|
274
|
+
* The ID of the vector store
|
275
|
+
*/
|
276
|
+
vector_store_id: string;
|
277
|
+
}
|
278
|
+
export interface FileSearchParams {
|
279
|
+
/**
|
280
|
+
* Search query text
|
281
|
+
*/
|
282
|
+
query: string;
|
283
|
+
/**
|
284
|
+
* IDs of vector stores to search
|
285
|
+
*/
|
286
|
+
vector_store_ids: Array<string>;
|
287
|
+
/**
|
288
|
+
* Number of results to return
|
289
|
+
*/
|
290
|
+
top_k?: number;
|
291
|
+
/**
|
292
|
+
* Optional filter conditions
|
293
|
+
*/
|
294
|
+
filters?: Shared.SearchFilter | Shared.SearchFilterCondition | Array<Shared.SearchFilter | Shared.SearchFilterCondition> | null;
|
295
|
+
/**
|
296
|
+
* Search configuration options
|
297
|
+
*/
|
298
|
+
search_options?: VectorStoresAPI.VectorStoreFileSearchOptions;
|
299
|
+
}
|
300
|
+
export declare namespace Files {
|
301
|
+
export { type ScoredVectorStoreFile as ScoredVectorStoreFile, type VectorStoreFile as VectorStoreFile, type FileDeleteResponse as FileDeleteResponse, type FileSearchResponse as FileSearchResponse, type VectorStoreFilesLimitOffset as VectorStoreFilesLimitOffset, type FileCreateParams as FileCreateParams, type FileRetrieveParams as FileRetrieveParams, type FileListParams as FileListParams, type FileDeleteParams as FileDeleteParams, type FileSearchParams as FileSearchParams, };
|
302
|
+
}
|
303
|
+
//# sourceMappingURL=files.d.mts.map
|
@@ -0,0 +1 @@
|
|
1
|
+
{"version":3,"file":"files.d.mts","sourceRoot":"","sources":["../../src/resources/vector-stores/files.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,KAAK,eAAe;OACpB,EAAE,UAAU,EAAE;OACd,EAAE,WAAW,EAAE,KAAK,iBAAiB,EAAE,WAAW,EAAE;OACpD,EAAE,cAAc,EAAE;OAGlB,EAAE,UAAU,EAAE;AAErB,qBAAa,KAAM,SAAQ,WAAW;IACpC;;;;;;;OAOG;IACH,MAAM,CACJ,aAAa,EAAE,MAAM,EACrB,IAAI,EAAE,gBAAgB,EACtB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,eAAe,CAAC;IAI9B;;;;;;OAMG;IACH,QAAQ,CACN,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,kBAAkB,EAC1B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,eAAe,CAAC;IAK9B;;;;;;;OAOG;IACH,IAAI,CACF,aAAa,EAAE,MAAM,EACrB,KAAK,GAAE,cAAc,GAAG,IAAI,GAAG,SAAc,EAC7C,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,2BAA2B,EAAE,eAAe,CAAC;IAQ5D;;;;;;;OAOG;IACH,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,kBAAkB,CAAC;IAK1G;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,CAAC,IAAI,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,kBAAkB,CAAC;IAIxF;;;;;;;;;OASG;IACG,IAAI,CACR,aAAa,EAAE,MAAM,EACrB,MAAM,EAAE,MAAM,EACd,cAAc,CAAC,EAAE,MAAM,EACvB,aAAa,CAAC,EAAE,MAAM,EACtB,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,eAAe,CAAC;IAa3B;;;;;;;;;OASG;IACG,aAAa,CACjB,aAAa,EAAE,MAAM,EACrB,IAAI,EAAE,gBAAgB,EACtB,cAAc,CAAC,EAAE,MAAM,EACvB,aAAa,CAAC,EAAE,MAAM,EACtB,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,eAAe,CAAC;IAK3B;;;;;;;;;OASG;IACG,MAAM,CACV,aAAa,EAAE,MAAM,EACrB,IAAI,EAAE,UAAU,EAChB,IAAI,CAAC,EAAE,IAAI,CAAC,gBAAgB,EAAE,SAAS,CAAC,EACxC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,eAAe,CAAC;IAa3B;;;;;;;;;;OAUG;IACG,aAAa,CACjB,aAAa,EAAE,MAAM,EACrB,IAAI,EAAE,UAAU,EAChB,IAAI,CAAC,EAAE,IAAI,CAAC,gBAAgB,EAAE,SAAS,CAAC,EACxC,cAAc,CAAC,EAAE,MAAM,EACvB,aAAa,CAAC,EAAE,MAAM,EACtB,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,eAAe,CAAC;CAI5B;AAED,MAAM,MAAM,2BAA2B,GAAG,WAAW,CAAC,eAAe,CAAC,CAAC;AAEvE;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,MAAM,CAAC,EAAE,mBAAmB,CAAC;IAE7B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,KAAK,CAAC,eAAe,CAAC,sBAAsB,CAAC,GAAG,IAAI,CAAC;CAC9D;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,MAAM,CAAC,EAAE,mBAAmB,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,MAAM,CAAC,EAAE,mBAAmB,CAAC;CAC9B;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,qBAAqB,CAAC,CAAC;CACpC;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,YAAY,CAAC,EAAE,gBAAgB,CAAC,YAAY,CAAC;CAC9C;AAED,yBAAiB,gBAAgB,CAAC;IAChC;;OAEG;IACH,UAAiB,YAAY;QAC3B;;WAEG;QACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,cAAc,CAAC;QAE3C;;WAEG;QACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;KAC7B;CACF;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,cAAe,SAAQ,iBAAiB;CAAG;AAE5D,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,gBAAgB,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEhC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,OAAO,CAAC,EACJ,MAAM,CAAC,YAAY,GACnB,MAAM,CAAC,qBAAqB,GAC5B,KAAK,CAAC,MAAM,CAAC,YAAY,GAAG,MAAM,CAAC,qBAAqB,CAAC,GACzD,IAAI,CAAC;IAET;;OAEG;IACH,cAAc,CAAC,EAAE,eAAe,CAAC,4BAA4B,CAAC;CAC/D;AAED,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,gBAAgB,IAAI,gBAAgB,GAC1C,CAAC;CACH"}
|
@@ -1,8 +1,9 @@
|
|
1
|
-
import { APIResource } from "../../resource.js";
|
2
|
-
import * as Core from "../../core.js";
|
1
|
+
import { APIResource } from "../../core/resource.js";
|
3
2
|
import * as Shared from "../shared.js";
|
4
3
|
import * as VectorStoresAPI from "./vector-stores.js";
|
5
|
-
import {
|
4
|
+
import { APIPromise } from "../../core/api-promise.js";
|
5
|
+
import { LimitOffset, type LimitOffsetParams, PagePromise } from "../../core/pagination.js";
|
6
|
+
import { RequestOptions } from "../../internal/request-options.js";
|
6
7
|
import { Uploadable } from "../../uploads.js";
|
7
8
|
export declare class Files extends APIResource {
|
8
9
|
/**
|
@@ -13,7 +14,7 @@ export declare class Files extends APIResource {
|
|
13
14
|
*
|
14
15
|
* Returns: VectorStoreFile: Details of the uploaded and indexed file
|
15
16
|
*/
|
16
|
-
create(
|
17
|
+
create(vectorStoreID: string, body: FileCreateParams, options?: RequestOptions): APIPromise<VectorStoreFile>;
|
17
18
|
/**
|
18
19
|
* Get details of a specific file in a vector store.
|
19
20
|
*
|
@@ -21,7 +22,7 @@ export declare class Files extends APIResource {
|
|
21
22
|
*
|
22
23
|
* Returns: VectorStoreFile: Details of the vector store file
|
23
24
|
*/
|
24
|
-
retrieve(
|
25
|
+
retrieve(fileID: string, params: FileRetrieveParams, options?: RequestOptions): APIPromise<VectorStoreFile>;
|
25
26
|
/**
|
26
27
|
* List files indexed in a vector store with pagination.
|
27
28
|
*
|
@@ -30,8 +31,7 @@ export declare class Files extends APIResource {
|
|
30
31
|
*
|
31
32
|
* Returns: VectorStoreFileListResponse: Paginated list of vector store files
|
32
33
|
*/
|
33
|
-
list(
|
34
|
-
list(vectorStoreId: string, options?: Core.RequestOptions): Core.PagePromise<VectorStoreFilesLimitOffset, VectorStoreFile>;
|
34
|
+
list(vectorStoreID: string, query?: FileListParams | null | undefined, options?: RequestOptions): PagePromise<VectorStoreFilesLimitOffset, VectorStoreFile>;
|
35
35
|
/**
|
36
36
|
* Delete a file from a vector store.
|
37
37
|
*
|
@@ -40,7 +40,7 @@ export declare class Files extends APIResource {
|
|
40
40
|
*
|
41
41
|
* Returns: VectorStoreFileDeleted: The deleted file
|
42
42
|
*/
|
43
|
-
delete(
|
43
|
+
delete(fileID: string, params: FileDeleteParams, options?: RequestOptions): APIPromise<FileDeleteResponse>;
|
44
44
|
/**
|
45
45
|
* Perform semantic search across complete vector store files.
|
46
46
|
*
|
@@ -59,7 +59,7 @@ export declare class Files extends APIResource {
|
|
59
59
|
* Raises: HTTPException (400): If search parameters are invalid HTTPException
|
60
60
|
* (404): If no vector stores are found to search
|
61
61
|
*/
|
62
|
-
search(body: FileSearchParams, options?:
|
62
|
+
search(body: FileSearchParams, options?: RequestOptions): APIPromise<FileSearchResponse>;
|
63
63
|
/**
|
64
64
|
* Poll for a file's processing status until it reaches a terminal state.
|
65
65
|
*
|
@@ -70,7 +70,7 @@ export declare class Files extends APIResource {
|
|
70
70
|
* @param options - Additional request options
|
71
71
|
* @returns The file object once it reaches a terminal state
|
72
72
|
*/
|
73
|
-
poll(vectorStoreId: string, fileId: string, pollIntervalMs?: number, pollTimeoutMs?: number, options?:
|
73
|
+
poll(vectorStoreId: string, fileId: string, pollIntervalMs?: number, pollTimeoutMs?: number, options?: RequestOptions): Promise<VectorStoreFile>;
|
74
74
|
/**
|
75
75
|
* Create a file in a vector store and wait for it to be processed.
|
76
76
|
*
|
@@ -81,7 +81,7 @@ export declare class Files extends APIResource {
|
|
81
81
|
* @param options - Additional request options
|
82
82
|
* @returns The file object once it reaches a terminal state
|
83
83
|
*/
|
84
|
-
createAndPoll(vectorStoreId: string, body: FileCreateParams, pollIntervalMs?: number, pollTimeoutMs?: number, options?:
|
84
|
+
createAndPoll(vectorStoreId: string, body: FileCreateParams, pollIntervalMs?: number, pollTimeoutMs?: number, options?: RequestOptions): Promise<VectorStoreFile>;
|
85
85
|
/**
|
86
86
|
* Upload a file to the files API and then create a file in a vector store.
|
87
87
|
* Note the file will be asynchronously processed.
|
@@ -92,7 +92,7 @@ export declare class Files extends APIResource {
|
|
92
92
|
* @param options - Additional request options
|
93
93
|
* @returns The created vector store file
|
94
94
|
*/
|
95
|
-
upload(vectorStoreId: string, file: Uploadable, body?: Omit<FileCreateParams, 'file_id'>, options?:
|
95
|
+
upload(vectorStoreId: string, file: Uploadable, body?: Omit<FileCreateParams, 'file_id'>, options?: RequestOptions): Promise<VectorStoreFile>;
|
96
96
|
/**
|
97
97
|
* Upload a file to files API, create a file in a vector store, and poll until processing is complete.
|
98
98
|
*
|
@@ -104,10 +104,9 @@ export declare class Files extends APIResource {
|
|
104
104
|
* @param options - Additional request options
|
105
105
|
* @returns The vector store file object once it reaches a terminal state
|
106
106
|
*/
|
107
|
-
uploadAndPoll(vectorStoreId: string, file: Uploadable, body?: Omit<FileCreateParams, 'file_id'>, pollIntervalMs?: number, pollTimeoutMs?: number, options?:
|
108
|
-
}
|
109
|
-
export declare class VectorStoreFilesLimitOffset extends LimitOffset<VectorStoreFile> {
|
107
|
+
uploadAndPoll(vectorStoreId: string, file: Uploadable, body?: Omit<FileCreateParams, 'file_id'>, pollIntervalMs?: number, pollTimeoutMs?: number, options?: RequestOptions): Promise<VectorStoreFile>;
|
110
108
|
}
|
109
|
+
export type VectorStoreFilesLimitOffset = LimitOffset<VectorStoreFile>;
|
111
110
|
/**
|
112
111
|
* Represents a scored file stored in a vector store.
|
113
112
|
*/
|
@@ -262,8 +261,20 @@ export declare namespace FileCreateParams {
|
|
262
261
|
contextualization?: boolean;
|
263
262
|
}
|
264
263
|
}
|
264
|
+
export interface FileRetrieveParams {
|
265
|
+
/**
|
266
|
+
* The ID of the vector store
|
267
|
+
*/
|
268
|
+
vector_store_id: string;
|
269
|
+
}
|
265
270
|
export interface FileListParams extends LimitOffsetParams {
|
266
271
|
}
|
272
|
+
export interface FileDeleteParams {
|
273
|
+
/**
|
274
|
+
* The ID of the vector store
|
275
|
+
*/
|
276
|
+
vector_store_id: string;
|
277
|
+
}
|
267
278
|
export interface FileSearchParams {
|
268
279
|
/**
|
269
280
|
* Search query text
|
@@ -287,6 +298,6 @@ export interface FileSearchParams {
|
|
287
298
|
search_options?: VectorStoresAPI.VectorStoreFileSearchOptions;
|
288
299
|
}
|
289
300
|
export declare namespace Files {
|
290
|
-
export { type ScoredVectorStoreFile as ScoredVectorStoreFile, type VectorStoreFile as VectorStoreFile, type FileDeleteResponse as FileDeleteResponse, type FileSearchResponse as FileSearchResponse, VectorStoreFilesLimitOffset as VectorStoreFilesLimitOffset, type FileCreateParams as FileCreateParams, type FileListParams as FileListParams, type FileSearchParams as FileSearchParams, };
|
301
|
+
export { type ScoredVectorStoreFile as ScoredVectorStoreFile, type VectorStoreFile as VectorStoreFile, type FileDeleteResponse as FileDeleteResponse, type FileSearchResponse as FileSearchResponse, type VectorStoreFilesLimitOffset as VectorStoreFilesLimitOffset, type FileCreateParams as FileCreateParams, type FileRetrieveParams as FileRetrieveParams, type FileListParams as FileListParams, type FileDeleteParams as FileDeleteParams, type FileSearchParams as FileSearchParams, };
|
291
302
|
}
|
292
303
|
//# sourceMappingURL=files.d.ts.map
|