@mixedbread/sdk 0.1.0-alpha.18 → 0.1.0-alpha.20
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 +19 -0
- package/README.md +37 -52
- package/index.d.mts +10 -11
- package/index.d.ts +10 -11
- package/index.d.ts.map +1 -1
- package/index.js +8 -8
- package/index.js.map +1 -1
- package/index.mjs +8 -8
- package/index.mjs.map +1 -1
- package/package.json +1 -1
- package/resources/embeddings.d.ts +3 -94
- package/resources/embeddings.d.ts.map +1 -1
- package/resources/embeddings.js.map +1 -1
- package/resources/embeddings.mjs.map +1 -1
- package/resources/index.d.ts +2 -2
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js.map +1 -1
- package/resources/index.mjs +1 -1
- package/resources/index.mjs.map +1 -1
- package/resources/top-level.d.ts +94 -2
- package/resources/top-level.d.ts.map +1 -1
- package/src/index.ts +35 -38
- package/src/resources/embeddings.ts +3 -141
- package/src/resources/index.ts +10 -7
- package/src/resources/top-level.ts +136 -1
- package/src/version.ts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
package/CHANGELOG.md
CHANGED
@@ -1,5 +1,24 @@
|
|
1
1
|
# Changelog
|
2
2
|
|
3
|
+
## 0.1.0-alpha.20 (2025-04-03)
|
4
|
+
|
5
|
+
Full Changelog: [v0.1.0-alpha.19...v0.1.0-alpha.20](https://github.com/mixedbread-ai/mixedbread-ts/compare/v0.1.0-alpha.19...v0.1.0-alpha.20)
|
6
|
+
|
7
|
+
### Features
|
8
|
+
|
9
|
+
* **api:** update via SDK Studio ([#142](https://github.com/mixedbread-ai/mixedbread-ts/issues/142)) ([be169e6](https://github.com/mixedbread-ai/mixedbread-ts/commit/be169e6a64cbce82591d93f02f327f353769ad19))
|
10
|
+
* **api:** update via SDK Studio ([#144](https://github.com/mixedbread-ai/mixedbread-ts/issues/144)) ([ac3c4cf](https://github.com/mixedbread-ai/mixedbread-ts/commit/ac3c4cfe303837b1789c9b727e393c5888a93808))
|
11
|
+
* **api:** update via SDK Studio ([#145](https://github.com/mixedbread-ai/mixedbread-ts/issues/145)) ([d5f14db](https://github.com/mixedbread-ai/mixedbread-ts/commit/d5f14db8a4e9c5d2e4feba5e81a68b3cc9a09f29))
|
12
|
+
* **api:** update via SDK Studio ([#146](https://github.com/mixedbread-ai/mixedbread-ts/issues/146)) ([c3c2adb](https://github.com/mixedbread-ai/mixedbread-ts/commit/c3c2adbab2fbddf1a4ed814d1b6aeb9b39c5277f))
|
13
|
+
|
14
|
+
## 0.1.0-alpha.19 (2025-04-03)
|
15
|
+
|
16
|
+
Full Changelog: [v0.1.0-alpha.18...v0.1.0-alpha.19](https://github.com/mixedbread-ai/mixedbread-ts/compare/v0.1.0-alpha.18...v0.1.0-alpha.19)
|
17
|
+
|
18
|
+
### Features
|
19
|
+
|
20
|
+
* **api:** update via SDK Studio ([#139](https://github.com/mixedbread-ai/mixedbread-ts/issues/139)) ([915da64](https://github.com/mixedbread-ai/mixedbread-ts/commit/915da6413235e6fec5593fd134fa638296b3f388))
|
21
|
+
|
3
22
|
## 0.1.0-alpha.18 (2025-04-03)
|
4
23
|
|
5
24
|
Full Changelog: [v0.1.0-alpha.17...v0.1.0-alpha.18](https://github.com/mixedbread-ai/mixedbread-ts/compare/v0.1.0-alpha.17...v0.1.0-alpha.18)
|
package/README.md
CHANGED
@@ -1,4 +1,4 @@
|
|
1
|
-
# Mixedbread Node API Library
|
1
|
+
# Mixedbread Node/TypeScript SDK API Library
|
2
2
|
|
3
3
|
[](https://npmjs.org/package/@mixedbread/sdk) 
|
4
4
|
|
@@ -28,9 +28,12 @@ const client = new Mixedbread({
|
|
28
28
|
});
|
29
29
|
|
30
30
|
async function main() {
|
31
|
-
const
|
31
|
+
const response = await client.vectorStores.search({
|
32
|
+
query: 'how to configure SSL',
|
33
|
+
vector_store_ids: ['182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e'],
|
34
|
+
});
|
32
35
|
|
33
|
-
console.log(
|
36
|
+
console.log(response.object);
|
34
37
|
}
|
35
38
|
|
36
39
|
main();
|
@@ -50,7 +53,11 @@ const client = new Mixedbread({
|
|
50
53
|
});
|
51
54
|
|
52
55
|
async function main() {
|
53
|
-
const
|
56
|
+
const params: Mixedbread.VectorStoreSearchParams = {
|
57
|
+
query: 'how to configure SSL',
|
58
|
+
vector_store_ids: ['182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e'],
|
59
|
+
};
|
60
|
+
const response: Mixedbread.VectorStoreSearchResponse = await client.vectorStores.search(params);
|
54
61
|
}
|
55
62
|
|
56
63
|
main();
|
@@ -97,15 +104,17 @@ a subclass of `APIError` will be thrown:
|
|
97
104
|
<!-- prettier-ignore -->
|
98
105
|
```ts
|
99
106
|
async function main() {
|
100
|
-
const
|
101
|
-
|
102
|
-
|
103
|
-
|
104
|
-
|
105
|
-
|
106
|
-
|
107
|
-
|
108
|
-
|
107
|
+
const response = await client.vectorStores
|
108
|
+
.search({ query: 'how to configure SSL', vector_store_ids: ['182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e'] })
|
109
|
+
.catch(async (err) => {
|
110
|
+
if (err instanceof Mixedbread.APIError) {
|
111
|
+
console.log(err.status); // 400
|
112
|
+
console.log(err.name); // BadRequestError
|
113
|
+
console.log(err.headers); // {server: 'nginx', ...}
|
114
|
+
} else {
|
115
|
+
throw err;
|
116
|
+
}
|
117
|
+
});
|
109
118
|
}
|
110
119
|
|
111
120
|
main();
|
@@ -140,7 +149,7 @@ const client = new Mixedbread({
|
|
140
149
|
});
|
141
150
|
|
142
151
|
// Or, configure per-request:
|
143
|
-
await client.vectorStores.
|
152
|
+
await client.vectorStores.search({ query: 'how to configure SSL', vector_store_ids: ['182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e'] }, {
|
144
153
|
maxRetries: 5,
|
145
154
|
});
|
146
155
|
```
|
@@ -157,7 +166,7 @@ const client = new Mixedbread({
|
|
157
166
|
});
|
158
167
|
|
159
168
|
// Override per-request:
|
160
|
-
await client.vectorStores.
|
169
|
+
await client.vectorStores.search({ query: 'how to configure SSL', vector_store_ids: ['182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e'] }, {
|
161
170
|
timeout: 5 * 1000,
|
162
171
|
});
|
163
172
|
```
|
@@ -166,37 +175,6 @@ On timeout, an `APIConnectionTimeoutError` is thrown.
|
|
166
175
|
|
167
176
|
Note that requests which time out will be [retried twice by default](#retries).
|
168
177
|
|
169
|
-
## Auto-pagination
|
170
|
-
|
171
|
-
List methods in the Mixedbread API are paginated.
|
172
|
-
You can use the `for await … of` syntax to iterate through items across all pages:
|
173
|
-
|
174
|
-
```ts
|
175
|
-
async function fetchAllVectorStores(params) {
|
176
|
-
const allVectorStores = [];
|
177
|
-
// Automatically fetches more pages as needed.
|
178
|
-
for await (const vectorStore of client.vectorStores.list()) {
|
179
|
-
allVectorStores.push(vectorStore);
|
180
|
-
}
|
181
|
-
return allVectorStores;
|
182
|
-
}
|
183
|
-
```
|
184
|
-
|
185
|
-
Alternatively, you can request a single page at a time:
|
186
|
-
|
187
|
-
```ts
|
188
|
-
let page = await client.vectorStores.list();
|
189
|
-
for (const vectorStore of page.data) {
|
190
|
-
console.log(vectorStore);
|
191
|
-
}
|
192
|
-
|
193
|
-
// Convenience methods are provided for manually paginating:
|
194
|
-
while (page.hasNextPage()) {
|
195
|
-
page = await page.getNextPage();
|
196
|
-
// ...
|
197
|
-
}
|
198
|
-
```
|
199
|
-
|
200
178
|
## Advanced Usage
|
201
179
|
|
202
180
|
### Accessing raw Response data (e.g., headers)
|
@@ -209,13 +187,17 @@ You can also use the `.withResponse()` method to get the raw `Response` along wi
|
|
209
187
|
```ts
|
210
188
|
const client = new Mixedbread();
|
211
189
|
|
212
|
-
const response = await client.vectorStores
|
190
|
+
const response = await client.vectorStores
|
191
|
+
.search({ query: 'how to configure SSL', vector_store_ids: ['182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e'] })
|
192
|
+
.asResponse();
|
213
193
|
console.log(response.headers.get('X-My-Header'));
|
214
194
|
console.log(response.statusText); // access the underlying Response object
|
215
195
|
|
216
|
-
const { data:
|
196
|
+
const { data: response, response: raw } = await client.vectorStores
|
197
|
+
.search({ query: 'how to configure SSL', vector_store_ids: ['182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e'] })
|
198
|
+
.withResponse();
|
217
199
|
console.log(raw.headers.get('X-My-Header'));
|
218
|
-
console.log(
|
200
|
+
console.log(response.object);
|
219
201
|
```
|
220
202
|
|
221
203
|
### Making custom/undocumented requests
|
@@ -319,9 +301,12 @@ const client = new Mixedbread({
|
|
319
301
|
});
|
320
302
|
|
321
303
|
// Override per-request:
|
322
|
-
await client.vectorStores.
|
323
|
-
|
324
|
-
|
304
|
+
await client.vectorStores.search(
|
305
|
+
{ query: 'how to configure SSL', vector_store_ids: ['182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e'] },
|
306
|
+
{
|
307
|
+
httpAgent: new http.Agent({ keepAlive: false }),
|
308
|
+
},
|
309
|
+
);
|
325
310
|
```
|
326
311
|
|
327
312
|
## Semantic versioning
|
package/index.d.mts
CHANGED
@@ -4,11 +4,10 @@ import * as Errors from "./error.js";
|
|
4
4
|
import * as Pagination from "./pagination.js";
|
5
5
|
import { type LimitOffsetParams, LimitOffsetResponse } from "./pagination.js";
|
6
6
|
import * as Uploads from "./uploads.js";
|
7
|
-
import * as EmbeddingsAPI from "./resources/embeddings.js";
|
8
|
-
import { Embedding, EmbeddingCreateParams, EmbeddingCreateResponse, Embeddings } from "./resources/embeddings.js";
|
9
7
|
import * as API from "./resources/index.js";
|
10
8
|
import * as TopLevelAPI from "./resources/top-level.js";
|
11
|
-
import { EmbedParams, InfoResponse, RerankParams, RerankResponse } from "./resources/top-level.js";
|
9
|
+
import { Em, EmbedParams, Embedding, InfoResponse, MultiEncodingEmbedding, RerankParams, RerankResponse } from "./resources/top-level.js";
|
10
|
+
import { EmbeddingCreateParams, Embeddings } from "./resources/embeddings.js";
|
12
11
|
import { FileCreateParams, FileDeleteResponse, FileListParams, FileObject, FileObjectsLimitOffset, FileUpdateParams, Files } from "./resources/files.js";
|
13
12
|
import { Extractions } from "./resources/extractions/extractions.js";
|
14
13
|
import { Parsing } from "./resources/parsing/parsing.js";
|
@@ -101,11 +100,11 @@ export declare class Mixedbread extends Core.APIClient {
|
|
101
100
|
* @param {Core.DefaultQuery} opts.defaultQuery - Default query parameters to include with every request to the API.
|
102
101
|
*/
|
103
102
|
constructor({ baseURL, apiKey, ...opts }?: ClientOptions);
|
104
|
-
|
103
|
+
vectorStores: API.VectorStores;
|
105
104
|
parsing: API.Parsing;
|
106
105
|
files: API.Files;
|
107
|
-
vectorStores: API.VectorStores;
|
108
106
|
extractions: API.Extractions;
|
107
|
+
embeddings: API.Embeddings;
|
109
108
|
/**
|
110
109
|
* Create embeddings for text or images using the specified model, encoding format,
|
111
110
|
* and normalization.
|
@@ -114,7 +113,7 @@ export declare class Mixedbread extends Core.APIClient {
|
|
114
113
|
*
|
115
114
|
* Returns: EmbeddingCreateResponse: The response containing the embeddings.
|
116
115
|
*/
|
117
|
-
embed(body: TopLevelAPI.EmbedParams, options?: Core.RequestOptions): Core.APIPromise<
|
116
|
+
embed(body: TopLevelAPI.EmbedParams, options?: Core.RequestOptions): Core.APIPromise<TopLevelAPI.Em>;
|
118
117
|
/**
|
119
118
|
* Returns service information, including name and version.
|
120
119
|
*
|
@@ -124,9 +123,9 @@ export declare class Mixedbread extends Core.APIClient {
|
|
124
123
|
/**
|
125
124
|
* Rerank different kind of documents for a given query.
|
126
125
|
*
|
127
|
-
* Args: params:
|
126
|
+
* Args: params: RerankParams: The parameters for reranking.
|
128
127
|
*
|
129
|
-
* Returns:
|
128
|
+
* Returns: RerankResponse: The reranked documents for the input query.
|
130
129
|
*/
|
131
130
|
rerank(body: TopLevelAPI.RerankParams, options?: Core.RequestOptions): Core.APIPromise<TopLevelAPI.RerankResponse>;
|
132
131
|
protected defaultQuery(): Core.DefaultQuery | undefined;
|
@@ -154,12 +153,12 @@ export declare namespace Mixedbread {
|
|
154
153
|
export type RequestOptions = Core.RequestOptions;
|
155
154
|
export import LimitOffset = Pagination.LimitOffset;
|
156
155
|
export { type LimitOffsetParams as LimitOffsetParams, type LimitOffsetResponse as LimitOffsetResponse };
|
157
|
-
export { type InfoResponse as InfoResponse, type RerankResponse as RerankResponse, type EmbedParams as EmbedParams, type RerankParams as RerankParams, };
|
158
|
-
export {
|
156
|
+
export { type Em as Em, type Embedding as Embedding, type MultiEncodingEmbedding as MultiEncodingEmbedding, type InfoResponse as InfoResponse, type RerankResponse as RerankResponse, type EmbedParams as EmbedParams, type RerankParams as RerankParams, };
|
157
|
+
export { VectorStores as VectorStores, type ExpiresAfter as ExpiresAfter, type FileCounts as FileCounts, type ScoredVectorStoreChunk as ScoredVectorStoreChunk, type VectorStore as VectorStore, type VectorStoreChunkSearchOptions as VectorStoreChunkSearchOptions, type VectorStoreFileSearchOptions as VectorStoreFileSearchOptions, type VectorStoreDeleteResponse as VectorStoreDeleteResponse, type VectorStoreQuestionAnsweringResponse as VectorStoreQuestionAnsweringResponse, type VectorStoreSearchResponse as VectorStoreSearchResponse, VectorStoresLimitOffset as VectorStoresLimitOffset, type VectorStoreCreateParams as VectorStoreCreateParams, type VectorStoreUpdateParams as VectorStoreUpdateParams, type VectorStoreListParams as VectorStoreListParams, type VectorStoreQuestionAnsweringParams as VectorStoreQuestionAnsweringParams, type VectorStoreSearchParams as VectorStoreSearchParams, };
|
159
158
|
export { Parsing as Parsing };
|
160
159
|
export { Files as Files, type FileObject as FileObject, type FileDeleteResponse as FileDeleteResponse, FileObjectsLimitOffset as FileObjectsLimitOffset, type FileCreateParams as FileCreateParams, type FileUpdateParams as FileUpdateParams, type FileListParams as FileListParams, };
|
161
|
-
export { VectorStores as VectorStores, type ExpiresAfter as ExpiresAfter, type FileCounts as FileCounts, type ScoredVectorStoreChunk as ScoredVectorStoreChunk, type VectorStore as VectorStore, type VectorStoreChunkSearchOptions as VectorStoreChunkSearchOptions, type VectorStoreFileSearchOptions as VectorStoreFileSearchOptions, type VectorStoreDeleteResponse as VectorStoreDeleteResponse, type VectorStoreQuestionAnsweringResponse as VectorStoreQuestionAnsweringResponse, type VectorStoreSearchResponse as VectorStoreSearchResponse, VectorStoresLimitOffset as VectorStoresLimitOffset, type VectorStoreCreateParams as VectorStoreCreateParams, type VectorStoreUpdateParams as VectorStoreUpdateParams, type VectorStoreListParams as VectorStoreListParams, type VectorStoreQuestionAnsweringParams as VectorStoreQuestionAnsweringParams, type VectorStoreSearchParams as VectorStoreSearchParams, };
|
162
160
|
export { Extractions as Extractions };
|
161
|
+
export { Embeddings as Embeddings, type EmbeddingCreateParams as EmbeddingCreateParams };
|
163
162
|
export type SearchFilter = API.SearchFilter;
|
164
163
|
export type SearchFilterCondition = API.SearchFilterCondition;
|
165
164
|
}
|
package/index.d.ts
CHANGED
@@ -4,11 +4,10 @@ import * as Errors from "./error.js";
|
|
4
4
|
import * as Pagination from "./pagination.js";
|
5
5
|
import { type LimitOffsetParams, LimitOffsetResponse } from "./pagination.js";
|
6
6
|
import * as Uploads from "./uploads.js";
|
7
|
-
import * as EmbeddingsAPI from "./resources/embeddings.js";
|
8
|
-
import { Embedding, EmbeddingCreateParams, EmbeddingCreateResponse, Embeddings } from "./resources/embeddings.js";
|
9
7
|
import * as API from "./resources/index.js";
|
10
8
|
import * as TopLevelAPI from "./resources/top-level.js";
|
11
|
-
import { EmbedParams, InfoResponse, RerankParams, RerankResponse } from "./resources/top-level.js";
|
9
|
+
import { Em, EmbedParams, Embedding, InfoResponse, MultiEncodingEmbedding, RerankParams, RerankResponse } from "./resources/top-level.js";
|
10
|
+
import { EmbeddingCreateParams, Embeddings } from "./resources/embeddings.js";
|
12
11
|
import { FileCreateParams, FileDeleteResponse, FileListParams, FileObject, FileObjectsLimitOffset, FileUpdateParams, Files } from "./resources/files.js";
|
13
12
|
import { Extractions } from "./resources/extractions/extractions.js";
|
14
13
|
import { Parsing } from "./resources/parsing/parsing.js";
|
@@ -101,11 +100,11 @@ export declare class Mixedbread extends Core.APIClient {
|
|
101
100
|
* @param {Core.DefaultQuery} opts.defaultQuery - Default query parameters to include with every request to the API.
|
102
101
|
*/
|
103
102
|
constructor({ baseURL, apiKey, ...opts }?: ClientOptions);
|
104
|
-
|
103
|
+
vectorStores: API.VectorStores;
|
105
104
|
parsing: API.Parsing;
|
106
105
|
files: API.Files;
|
107
|
-
vectorStores: API.VectorStores;
|
108
106
|
extractions: API.Extractions;
|
107
|
+
embeddings: API.Embeddings;
|
109
108
|
/**
|
110
109
|
* Create embeddings for text or images using the specified model, encoding format,
|
111
110
|
* and normalization.
|
@@ -114,7 +113,7 @@ export declare class Mixedbread extends Core.APIClient {
|
|
114
113
|
*
|
115
114
|
* Returns: EmbeddingCreateResponse: The response containing the embeddings.
|
116
115
|
*/
|
117
|
-
embed(body: TopLevelAPI.EmbedParams, options?: Core.RequestOptions): Core.APIPromise<
|
116
|
+
embed(body: TopLevelAPI.EmbedParams, options?: Core.RequestOptions): Core.APIPromise<TopLevelAPI.Em>;
|
118
117
|
/**
|
119
118
|
* Returns service information, including name and version.
|
120
119
|
*
|
@@ -124,9 +123,9 @@ export declare class Mixedbread extends Core.APIClient {
|
|
124
123
|
/**
|
125
124
|
* Rerank different kind of documents for a given query.
|
126
125
|
*
|
127
|
-
* Args: params:
|
126
|
+
* Args: params: RerankParams: The parameters for reranking.
|
128
127
|
*
|
129
|
-
* Returns:
|
128
|
+
* Returns: RerankResponse: The reranked documents for the input query.
|
130
129
|
*/
|
131
130
|
rerank(body: TopLevelAPI.RerankParams, options?: Core.RequestOptions): Core.APIPromise<TopLevelAPI.RerankResponse>;
|
132
131
|
protected defaultQuery(): Core.DefaultQuery | undefined;
|
@@ -154,12 +153,12 @@ export declare namespace Mixedbread {
|
|
154
153
|
export type RequestOptions = Core.RequestOptions;
|
155
154
|
export import LimitOffset = Pagination.LimitOffset;
|
156
155
|
export { type LimitOffsetParams as LimitOffsetParams, type LimitOffsetResponse as LimitOffsetResponse };
|
157
|
-
export { type InfoResponse as InfoResponse, type RerankResponse as RerankResponse, type EmbedParams as EmbedParams, type RerankParams as RerankParams, };
|
158
|
-
export {
|
156
|
+
export { type Em as Em, type Embedding as Embedding, type MultiEncodingEmbedding as MultiEncodingEmbedding, type InfoResponse as InfoResponse, type RerankResponse as RerankResponse, type EmbedParams as EmbedParams, type RerankParams as RerankParams, };
|
157
|
+
export { VectorStores as VectorStores, type ExpiresAfter as ExpiresAfter, type FileCounts as FileCounts, type ScoredVectorStoreChunk as ScoredVectorStoreChunk, type VectorStore as VectorStore, type VectorStoreChunkSearchOptions as VectorStoreChunkSearchOptions, type VectorStoreFileSearchOptions as VectorStoreFileSearchOptions, type VectorStoreDeleteResponse as VectorStoreDeleteResponse, type VectorStoreQuestionAnsweringResponse as VectorStoreQuestionAnsweringResponse, type VectorStoreSearchResponse as VectorStoreSearchResponse, VectorStoresLimitOffset as VectorStoresLimitOffset, type VectorStoreCreateParams as VectorStoreCreateParams, type VectorStoreUpdateParams as VectorStoreUpdateParams, type VectorStoreListParams as VectorStoreListParams, type VectorStoreQuestionAnsweringParams as VectorStoreQuestionAnsweringParams, type VectorStoreSearchParams as VectorStoreSearchParams, };
|
159
158
|
export { Parsing as Parsing };
|
160
159
|
export { Files as Files, type FileObject as FileObject, type FileDeleteResponse as FileDeleteResponse, FileObjectsLimitOffset as FileObjectsLimitOffset, type FileCreateParams as FileCreateParams, type FileUpdateParams as FileUpdateParams, type FileListParams as FileListParams, };
|
161
|
-
export { VectorStores as VectorStores, type ExpiresAfter as ExpiresAfter, type FileCounts as FileCounts, type ScoredVectorStoreChunk as ScoredVectorStoreChunk, type VectorStore as VectorStore, type VectorStoreChunkSearchOptions as VectorStoreChunkSearchOptions, type VectorStoreFileSearchOptions as VectorStoreFileSearchOptions, type VectorStoreDeleteResponse as VectorStoreDeleteResponse, type VectorStoreQuestionAnsweringResponse as VectorStoreQuestionAnsweringResponse, type VectorStoreSearchResponse as VectorStoreSearchResponse, VectorStoresLimitOffset as VectorStoresLimitOffset, type VectorStoreCreateParams as VectorStoreCreateParams, type VectorStoreUpdateParams as VectorStoreUpdateParams, type VectorStoreListParams as VectorStoreListParams, type VectorStoreQuestionAnsweringParams as VectorStoreQuestionAnsweringParams, type VectorStoreSearchParams as VectorStoreSearchParams, };
|
162
160
|
export { Extractions as Extractions };
|
161
|
+
export { Embeddings as Embeddings, type EmbeddingCreateParams as EmbeddingCreateParams };
|
163
162
|
export type SearchFilter = API.SearchFilter;
|
164
163
|
export type SearchFilterCondition = API.SearchFilterCondition;
|
165
164
|
}
|
package/index.d.ts.map
CHANGED
@@ -1 +1 @@
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["src/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,KAAK,EAAE,MAAM,gBAAgB,CAAC;AAC5C,OAAO,KAAK,IAAI,MAAM,QAAQ,CAAC;AAC/B,OAAO,KAAK,MAAM,MAAM,SAAS,CAAC;AAClC,OAAO,KAAK,UAAU,MAAM,cAAc,CAAC;AAC3C,OAAO,EAAE,KAAK,iBAAiB,EAAE,mBAAmB,EAAE,MAAM,cAAc,CAAC;AAC3E,OAAO,KAAK,OAAO,MAAM,WAAW,CAAC;AACrC,OAAO,KAAK,
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["src/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,KAAK,EAAE,MAAM,gBAAgB,CAAC;AAC5C,OAAO,KAAK,IAAI,MAAM,QAAQ,CAAC;AAC/B,OAAO,KAAK,MAAM,MAAM,SAAS,CAAC;AAClC,OAAO,KAAK,UAAU,MAAM,cAAc,CAAC;AAC3C,OAAO,EAAE,KAAK,iBAAiB,EAAE,mBAAmB,EAAE,MAAM,cAAc,CAAC;AAC3E,OAAO,KAAK,OAAO,MAAM,WAAW,CAAC;AACrC,OAAO,KAAK,GAAG,MAAM,mBAAmB,CAAC;AACzC,OAAO,KAAK,WAAW,MAAM,uBAAuB,CAAC;AACrD,OAAO,EACL,EAAE,EACF,WAAW,EACX,SAAS,EACT,YAAY,EACZ,sBAAsB,EACtB,YAAY,EACZ,cAAc,EACf,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,qBAAqB,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AAC3E,OAAO,EACL,gBAAgB,EAChB,kBAAkB,EAClB,cAAc,EACd,UAAU,EACV,sBAAsB,EACtB,gBAAgB,EAChB,KAAK,EACN,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,WAAW,EAAE,MAAM,qCAAqC,CAAC;AAClE,OAAO,EAAE,OAAO,EAAE,MAAM,6BAA6B,CAAC;AACtD,OAAO,EACL,YAAY,EACZ,UAAU,EACV,sBAAsB,EACtB,WAAW,EACX,6BAA6B,EAC7B,uBAAuB,EACvB,yBAAyB,EACzB,4BAA4B,EAC5B,qBAAqB,EACrB,kCAAkC,EAClC,oCAAoC,EACpC,uBAAuB,EACvB,yBAAyB,EACzB,uBAAuB,EACvB,YAAY,EACZ,uBAAuB,EACxB,MAAM,yCAAyC,CAAC;AAEjD,QAAA,MAAM,YAAY;;;CAGjB,CAAC;AACF,KAAK,WAAW,GAAG,MAAM,OAAO,YAAY,CAAC;AAE7C,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAE5B;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,WAAW,GAAG,SAAS,CAAC;IAEtC;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IAEpC;;;;;;OAMG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAE7B;;;;;OAKG;IACH,SAAS,CAAC,EAAE,KAAK,GAAG,SAAS,CAAC;IAE9B;;;;;OAKG;IACH,KAAK,CAAC,EAAE,IAAI,CAAC,KAAK,GAAG,SAAS,CAAC;IAE/B;;;;;OAKG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAEhC;;;;;OAKG;IACH,cAAc,CAAC,EAAE,IAAI,CAAC,OAAO,GAAG,SAAS,CAAC;IAE1C;;;;;OAKG;IACH,YAAY,CAAC,EAAE,IAAI,CAAC,YAAY,GAAG,SAAS,CAAC;CAC9C;AAED;;GAEG;AACH,qBAAa,UAAW,SAAQ,IAAI,CAAC,SAAS;IAC5C,MAAM,EAAE,MAAM,CAAC;IAEf,OAAO,CAAC,QAAQ,CAAgB;IAEhC;;;;;;;;;;;;OAYG;gBACS,EACV,OAA6C,EAC7C,MAA2C,EAC3C,GAAG,IAAI,EACR,GAAE,aAAkB;IAiCrB,YAAY,EAAE,GAAG,CAAC,YAAY,CAA8B;IAC5D,OAAO,EAAE,GAAG,CAAC,OAAO,CAAyB;IAC7C,KAAK,EAAE,GAAG,CAAC,KAAK,CAAuB;IACvC,WAAW,EAAE,GAAG,CAAC,WAAW,CAA6B;IACzD,UAAU,EAAE,GAAG,CAAC,UAAU,CAA4B;IAEtD;;;;;;;OAOG;IACH,KAAK,CAAC,IAAI,EAAE,WAAW,CAAC,WAAW,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,EAAE,CAAC;IAIpG;;;;OAIG;IACH,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,YAAY,CAAC;IAI9E;;;;;;OAMG;IACH,MAAM,CACJ,IAAI,EAAE,WAAW,CAAC,YAAY,EAC9B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,cAAc,CAAC;cAI3B,YAAY,IAAI,IAAI,CAAC,YAAY,GAAG,SAAS;cAI7C,cAAc,CAAC,IAAI,EAAE,IAAI,CAAC,mBAAmB,GAAG,IAAI,CAAC,OAAO;cAO5D,WAAW,CAAC,IAAI,EAAE,IAAI,CAAC,mBAAmB,GAAG,IAAI,CAAC,OAAO;IAI5E,MAAM,CAAC,UAAU,oBAAQ;IACzB,MAAM,CAAC,eAAe,SAAS;IAE/B,MAAM,CAAC,eAAe,gCAA0B;IAChD,MAAM,CAAC,QAAQ,yBAAmB;IAClC,MAAM,CAAC,kBAAkB,mCAA6B;IACtD,MAAM,CAAC,yBAAyB,0CAAoC;IACpE,MAAM,CAAC,iBAAiB,kCAA4B;IACpD,MAAM,CAAC,aAAa,8BAAwB;IAC5C,MAAM,CAAC,aAAa,8BAAwB;IAC5C,MAAM,CAAC,cAAc,+BAAyB;IAC9C,MAAM,CAAC,eAAe,gCAA0B;IAChD,MAAM,CAAC,mBAAmB,oCAA8B;IACxD,MAAM,CAAC,mBAAmB,oCAA8B;IACxD,MAAM,CAAC,qBAAqB,sCAAgC;IAC5D,MAAM,CAAC,wBAAwB,yCAAmC;IAElE,MAAM,CAAC,MAAM,wBAAkB;IAC/B,MAAM,CAAC,YAAY,8BAAwB;CAC5C;AASD,MAAM,CAAC,OAAO,WAAW,UAAU,CAAC;IAClC,MAAM,MAAM,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC;IAEjD,MAAM,QAAQ,WAAW,GAAG,UAAU,CAAC,WAAW,CAAC;IACnD,OAAO,EAAE,KAAK,iBAAiB,IAAI,iBAAiB,EAAE,KAAK,mBAAmB,IAAI,mBAAmB,EAAE,CAAC;IAExG,OAAO,EACL,KAAK,EAAE,IAAI,EAAE,EACb,KAAK,SAAS,IAAI,SAAS,EAC3B,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;IAEF,OAAO,EACL,YAAY,IAAI,YAAY,EAC5B,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,oCAAoC,IAAI,oCAAoC,EACjF,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,uBAAuB,IAAI,uBAAuB,EAClD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,kCAAkC,IAAI,kCAAkC,EAC7E,KAAK,uBAAuB,IAAI,uBAAuB,GACxD,CAAC;IAEF,OAAO,EAAE,OAAO,IAAI,OAAO,EAAE,CAAC;IAE9B,OAAO,EACL,KAAK,IAAI,KAAK,EACd,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,sBAAsB,IAAI,sBAAsB,EAChD,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,cAAc,IAAI,cAAc,GACtC,CAAC;IAEF,OAAO,EAAE,WAAW,IAAI,WAAW,EAAE,CAAC;IAEtC,OAAO,EAAE,UAAU,IAAI,UAAU,EAAE,KAAK,qBAAqB,IAAI,qBAAqB,EAAE,CAAC;IAEzF,MAAM,MAAM,YAAY,GAAG,GAAG,CAAC,YAAY,CAAC;IAC5C,MAAM,MAAM,qBAAqB,GAAG,GAAG,CAAC,qBAAqB,CAAC;CAC/D;AAED,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AACjD,OAAO,EACL,eAAe,EACf,QAAQ,EACR,kBAAkB,EAClB,yBAAyB,EACzB,iBAAiB,EACjB,aAAa,EACb,aAAa,EACb,cAAc,EACd,eAAe,EACf,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,EACrB,wBAAwB,GACzB,MAAM,SAAS,CAAC;AAEjB,eAAe,UAAU,CAAC"}
|
package/index.js
CHANGED
@@ -30,8 +30,8 @@ const Core = __importStar(require("./core.js"));
|
|
30
30
|
const Errors = __importStar(require("./error.js"));
|
31
31
|
const Pagination = __importStar(require("./pagination.js"));
|
32
32
|
const Uploads = __importStar(require("./uploads.js"));
|
33
|
-
const embeddings_1 = require("./resources/embeddings.js");
|
34
33
|
const API = __importStar(require("./resources/index.js"));
|
34
|
+
const embeddings_1 = require("./resources/embeddings.js");
|
35
35
|
const files_1 = require("./resources/files.js");
|
36
36
|
const extractions_1 = require("./resources/extractions/extractions.js");
|
37
37
|
const parsing_1 = require("./resources/parsing/parsing.js");
|
@@ -77,11 +77,11 @@ class Mixedbread extends Core.APIClient {
|
|
77
77
|
maxRetries: options.maxRetries,
|
78
78
|
fetch: options.fetch,
|
79
79
|
});
|
80
|
-
this.
|
80
|
+
this.vectorStores = new API.VectorStores(this);
|
81
81
|
this.parsing = new API.Parsing(this);
|
82
82
|
this.files = new API.Files(this);
|
83
|
-
this.vectorStores = new API.VectorStores(this);
|
84
83
|
this.extractions = new API.Extractions(this);
|
84
|
+
this.embeddings = new API.Embeddings(this);
|
85
85
|
this._options = options;
|
86
86
|
this.apiKey = apiKey;
|
87
87
|
}
|
@@ -107,9 +107,9 @@ class Mixedbread extends Core.APIClient {
|
|
107
107
|
/**
|
108
108
|
* Rerank different kind of documents for a given query.
|
109
109
|
*
|
110
|
-
* Args: params:
|
110
|
+
* Args: params: RerankParams: The parameters for reranking.
|
111
111
|
*
|
112
|
-
* Returns:
|
112
|
+
* Returns: RerankResponse: The reranked documents for the input query.
|
113
113
|
*/
|
114
114
|
rerank(body, options) {
|
115
115
|
return this.post('/v1/reranking', { body, ...options });
|
@@ -146,13 +146,13 @@ Mixedbread.PermissionDeniedError = Errors.PermissionDeniedError;
|
|
146
146
|
Mixedbread.UnprocessableEntityError = Errors.UnprocessableEntityError;
|
147
147
|
Mixedbread.toFile = Uploads.toFile;
|
148
148
|
Mixedbread.fileFromPath = Uploads.fileFromPath;
|
149
|
-
Mixedbread.
|
149
|
+
Mixedbread.VectorStores = vector_stores_1.VectorStores;
|
150
|
+
Mixedbread.VectorStoresLimitOffset = vector_stores_1.VectorStoresLimitOffset;
|
150
151
|
Mixedbread.Parsing = parsing_1.Parsing;
|
151
152
|
Mixedbread.Files = files_1.Files;
|
152
153
|
Mixedbread.FileObjectsLimitOffset = files_1.FileObjectsLimitOffset;
|
153
|
-
Mixedbread.VectorStores = vector_stores_1.VectorStores;
|
154
|
-
Mixedbread.VectorStoresLimitOffset = vector_stores_1.VectorStoresLimitOffset;
|
155
154
|
Mixedbread.Extractions = extractions_1.Extractions;
|
155
|
+
Mixedbread.Embeddings = embeddings_1.Embeddings;
|
156
156
|
var uploads_1 = require("./uploads.js");
|
157
157
|
Object.defineProperty(exports, "toFile", { enumerable: true, get: function () { return uploads_1.toFile; } });
|
158
158
|
Object.defineProperty(exports, "fileFromPath", { enumerable: true, get: function () { return uploads_1.fileFromPath; } });
|
package/index.js.map
CHANGED
@@ -1 +1 @@
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["src/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;;;;;;;;;;;;;;;;;;;;;;;;AAGtF,gDAA+B;AAC/B,mDAAkC;AAClC,4DAA2C;AAE3C,sDAAqC;
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["src/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;;;;;;;;;;;;;;;;;;;;;;;;AAGtF,gDAA+B;AAC/B,mDAAkC;AAClC,4DAA2C;AAE3C,sDAAqC;AACrC,0DAAyC;AAWzC,0DAA2E;AAC3E,gDAQ2B;AAC3B,wEAAkE;AAClE,4DAAsD;AACtD,8EAiBiD;AAEjD,MAAM,YAAY,GAAG;IACnB,UAAU,EAAE,4BAA4B;IACxC,KAAK,EAAE,uBAAuB;CAC/B,CAAC;AA2EF;;GAEG;AACH,MAAa,UAAW,SAAQ,IAAI,CAAC,SAAS;IAK5C;;;;;;;;;;;;OAYG;IACH,YAAY,EACV,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,qBAAqB,CAAC,EAC7C,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,oBAAoB,CAAC,EAC3C,GAAG,IAAI,KACU,EAAE;QACnB,IAAI,MAAM,KAAK,SAAS,EAAE;YACxB,MAAM,IAAI,MAAM,CAAC,eAAe,CAC9B,gMAAgM,CACjM,CAAC;SACH;QAED,MAAM,OAAO,GAAkB;YAC7B,MAAM;YACN,GAAG,IAAI;YACP,OAAO;YACP,WAAW,EAAE,IAAI,CAAC,WAAW,IAAI,YAAY;SAC9C,CAAC;QAEF,IAAI,OAAO,IAAI,IAAI,CAAC,WAAW,EAAE;YAC/B,MAAM,IAAI,MAAM,CAAC,eAAe,CAC9B,6KAA6K,CAC9K,CAAC;SACH;QAED,KAAK,CAAC;YACJ,OAAO,EAAE,OAAO,CAAC,OAAO,IAAI,YAAY,CAAC,OAAO,CAAC,WAAW,IAAI,YAAY,CAAC;YAC7E,OAAO,EAAE,OAAO,CAAC,OAAO,IAAI,KAAK,CAAC,cAAc;YAChD,SAAS,EAAE,OAAO,CAAC,SAAS;YAC5B,UAAU,EAAE,OAAO,CAAC,UAAU;YAC9B,KAAK,EAAE,OAAO,CAAC,KAAK;SACrB,CAAC,CAAC;QAOL,iBAAY,GAAqB,IAAI,GAAG,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;QAC5D,YAAO,GAAgB,IAAI,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAC7C,UAAK,GAAc,IAAI,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACvC,gBAAW,GAAoB,IAAI,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;QACzD,eAAU,GAAmB,IAAI,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;QATpD,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;QAExB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAQD;;;;;;;OAOG;IACH,KAAK,CAAC,IAA6B,EAAE,OAA6B;QAChE,OAAO,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3D,CAAC;IAED;;;;OAIG;IACH,IAAI,CAAC,OAA6B;QAChC,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;IAChC,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CACJ,IAA8B,EAC9B,OAA6B;QAE7B,OAAO,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1D,CAAC;IAEkB,YAAY;QAC7B,OAAO,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC;IACpC,CAAC;IAEkB,cAAc,CAAC,IAA8B;QAC9D,OAAO;YACL,GAAG,KAAK,CAAC,cAAc,CAAC,IAAI,CAAC;YAC7B,GAAG,IAAI,CAAC,QAAQ,CAAC,cAAc;SAChC,CAAC;IACJ,CAAC;IAEkB,WAAW,CAAC,IAA8B;QAC3D,OAAO,EAAE,aAAa,EAAE,UAAU,IAAI,CAAC,MAAM,EAAE,EAAE,CAAC;IACpD,CAAC;;AA7GH,gCAkIC;;AAnBQ,qBAAU,GAAG,EAAI,CAAC;AAClB,0BAAe,GAAG,KAAK,CAAC,CAAC,WAAW;AAEpC,0BAAe,GAAG,MAAM,CAAC,eAAe,CAAC;AACzC,mBAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC;AAC3B,6BAAkB,GAAG,MAAM,CAAC,kBAAkB,CAAC;AAC/C,oCAAyB,GAAG,MAAM,CAAC,yBAAyB,CAAC;AAC7D,4BAAiB,GAAG,MAAM,CAAC,iBAAiB,CAAC;AAC7C,wBAAa,GAAG,MAAM,CAAC,aAAa,CAAC;AACrC,wBAAa,GAAG,MAAM,CAAC,aAAa,CAAC;AACrC,yBAAc,GAAG,MAAM,CAAC,cAAc,CAAC;AACvC,0BAAe,GAAG,MAAM,CAAC,eAAe,CAAC;AACzC,8BAAmB,GAAG,MAAM,CAAC,mBAAmB,CAAC;AACjD,8BAAmB,GAAG,MAAM,CAAC,mBAAmB,CAAC;AACjD,gCAAqB,GAAG,MAAM,CAAC,qBAAqB,CAAC;AACrD,mCAAwB,GAAG,MAAM,CAAC,wBAAwB,CAAC;AAE3D,iBAAM,GAAG,OAAO,CAAC,MAAM,CAAC;AACxB,uBAAY,GAAG,OAAO,CAAC,YAAY,CAAC;AAG7C,UAAU,CAAC,YAAY,GAAG,4BAAY,CAAC;AACvC,UAAU,CAAC,uBAAuB,GAAG,uCAAuB,CAAC;AAC7D,UAAU,CAAC,OAAO,GAAG,iBAAO,CAAC;AAC7B,UAAU,CAAC,KAAK,GAAG,aAAK,CAAC;AACzB,UAAU,CAAC,sBAAsB,GAAG,8BAAsB,CAAC;AAC3D,UAAU,CAAC,WAAW,GAAG,yBAAW,CAAC;AACrC,UAAU,CAAC,UAAU,GAAG,uBAAU,CAAC;AAwDnC,wCAAiD;AAAxC,iGAAA,MAAM,OAAA;AAAE,uGAAA,YAAY,OAAA;AAC7B,oCAciB;AAbf,wGAAA,eAAe,OAAA;AACf,iGAAA,QAAQ,OAAA;AACR,2GAAA,kBAAkB,OAAA;AAClB,kHAAA,yBAAyB,OAAA;AACzB,0GAAA,iBAAiB,OAAA;AACjB,sGAAA,aAAa,OAAA;AACb,sGAAA,aAAa,OAAA;AACb,uGAAA,cAAc,OAAA;AACd,wGAAA,eAAe,OAAA;AACf,4GAAA,mBAAmB,OAAA;AACnB,4GAAA,mBAAmB,OAAA;AACnB,8GAAA,qBAAqB,OAAA;AACrB,iHAAA,wBAAwB,OAAA;AAG1B,kBAAe,UAAU,CAAC"}
|
package/index.mjs
CHANGED
@@ -4,8 +4,8 @@ import * as Core from "./core.mjs";
|
|
4
4
|
import * as Errors from "./error.mjs";
|
5
5
|
import * as Pagination from "./pagination.mjs";
|
6
6
|
import * as Uploads from "./uploads.mjs";
|
7
|
-
import { Embeddings, } from "./resources/embeddings.mjs";
|
8
7
|
import * as API from "./resources/index.mjs";
|
8
|
+
import { Embeddings } from "./resources/embeddings.mjs";
|
9
9
|
import { FileObjectsLimitOffset, Files, } from "./resources/files.mjs";
|
10
10
|
import { Extractions } from "./resources/extractions/extractions.mjs";
|
11
11
|
import { Parsing } from "./resources/parsing/parsing.mjs";
|
@@ -51,11 +51,11 @@ export class Mixedbread extends Core.APIClient {
|
|
51
51
|
maxRetries: options.maxRetries,
|
52
52
|
fetch: options.fetch,
|
53
53
|
});
|
54
|
-
this.
|
54
|
+
this.vectorStores = new API.VectorStores(this);
|
55
55
|
this.parsing = new API.Parsing(this);
|
56
56
|
this.files = new API.Files(this);
|
57
|
-
this.vectorStores = new API.VectorStores(this);
|
58
57
|
this.extractions = new API.Extractions(this);
|
58
|
+
this.embeddings = new API.Embeddings(this);
|
59
59
|
this._options = options;
|
60
60
|
this.apiKey = apiKey;
|
61
61
|
}
|
@@ -81,9 +81,9 @@ export class Mixedbread extends Core.APIClient {
|
|
81
81
|
/**
|
82
82
|
* Rerank different kind of documents for a given query.
|
83
83
|
*
|
84
|
-
* Args: params:
|
84
|
+
* Args: params: RerankParams: The parameters for reranking.
|
85
85
|
*
|
86
|
-
* Returns:
|
86
|
+
* Returns: RerankResponse: The reranked documents for the input query.
|
87
87
|
*/
|
88
88
|
rerank(body, options) {
|
89
89
|
return this.post('/v1/reranking', { body, ...options });
|
@@ -119,13 +119,13 @@ Mixedbread.PermissionDeniedError = Errors.PermissionDeniedError;
|
|
119
119
|
Mixedbread.UnprocessableEntityError = Errors.UnprocessableEntityError;
|
120
120
|
Mixedbread.toFile = Uploads.toFile;
|
121
121
|
Mixedbread.fileFromPath = Uploads.fileFromPath;
|
122
|
-
Mixedbread.
|
122
|
+
Mixedbread.VectorStores = VectorStores;
|
123
|
+
Mixedbread.VectorStoresLimitOffset = VectorStoresLimitOffset;
|
123
124
|
Mixedbread.Parsing = Parsing;
|
124
125
|
Mixedbread.Files = Files;
|
125
126
|
Mixedbread.FileObjectsLimitOffset = FileObjectsLimitOffset;
|
126
|
-
Mixedbread.VectorStores = VectorStores;
|
127
|
-
Mixedbread.VectorStoresLimitOffset = VectorStoresLimitOffset;
|
128
127
|
Mixedbread.Extractions = Extractions;
|
128
|
+
Mixedbread.Embeddings = Embeddings;
|
129
129
|
export { toFile, fileFromPath } from "./uploads.mjs";
|
130
130
|
export { MixedbreadError, APIError, APIConnectionError, APIConnectionTimeoutError, APIUserAbortError, NotFoundError, ConflictError, RateLimitError, BadRequestError, AuthenticationError, InternalServerError, PermissionDeniedError, UnprocessableEntityError, } from "./error.mjs";
|
131
131
|
export default Mixedbread;
|
package/index.mjs.map
CHANGED
@@ -1 +1 @@
|
|
1
|
-
{"version":3,"file":"index.mjs","sourceRoot":"","sources":["src/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;;OAG/E,KAAK,IAAI;OACT,KAAK,MAAM;OACX,KAAK,UAAU;OAEf,KAAK,OAAO;
|
1
|
+
{"version":3,"file":"index.mjs","sourceRoot":"","sources":["src/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;;OAG/E,KAAK,IAAI;OACT,KAAK,MAAM;OACX,KAAK,UAAU;OAEf,KAAK,OAAO;OACZ,KAAK,GAAG;OAWR,EAAyB,UAAU,EAAE;OACrC,EAKL,sBAAsB,EAEtB,KAAK,GACN;OACM,EAAE,WAAW,EAAE;OACf,EAAE,OAAO,EAAE;OACX,EAeL,YAAY,EACZ,uBAAuB,GACxB;AAED,MAAM,YAAY,GAAG;IACnB,UAAU,EAAE,4BAA4B;IACxC,KAAK,EAAE,uBAAuB;CAC/B,CAAC;AA2EF;;GAEG;AACH,MAAM,OAAO,UAAW,SAAQ,IAAI,CAAC,SAAS;IAK5C;;;;;;;;;;;;OAYG;IACH,YAAY,EACV,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,qBAAqB,CAAC,EAC7C,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,oBAAoB,CAAC,EAC3C,GAAG,IAAI,KACU,EAAE;QACnB,IAAI,MAAM,KAAK,SAAS,EAAE;YACxB,MAAM,IAAI,MAAM,CAAC,eAAe,CAC9B,gMAAgM,CACjM,CAAC;SACH;QAED,MAAM,OAAO,GAAkB;YAC7B,MAAM;YACN,GAAG,IAAI;YACP,OAAO;YACP,WAAW,EAAE,IAAI,CAAC,WAAW,IAAI,YAAY;SAC9C,CAAC;QAEF,IAAI,OAAO,IAAI,IAAI,CAAC,WAAW,EAAE;YAC/B,MAAM,IAAI,MAAM,CAAC,eAAe,CAC9B,6KAA6K,CAC9K,CAAC;SACH;QAED,KAAK,CAAC;YACJ,OAAO,EAAE,OAAO,CAAC,OAAO,IAAI,YAAY,CAAC,OAAO,CAAC,WAAW,IAAI,YAAY,CAAC;YAC7E,OAAO,EAAE,OAAO,CAAC,OAAO,IAAI,KAAK,CAAC,cAAc;YAChD,SAAS,EAAE,OAAO,CAAC,SAAS;YAC5B,UAAU,EAAE,OAAO,CAAC,UAAU;YAC9B,KAAK,EAAE,OAAO,CAAC,KAAK;SACrB,CAAC,CAAC;QAOL,iBAAY,GAAqB,IAAI,GAAG,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;QAC5D,YAAO,GAAgB,IAAI,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAC7C,UAAK,GAAc,IAAI,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACvC,gBAAW,GAAoB,IAAI,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;QACzD,eAAU,GAAmB,IAAI,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;QATpD,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;QAExB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAQD;;;;;;;OAOG;IACH,KAAK,CAAC,IAA6B,EAAE,OAA6B;QAChE,OAAO,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3D,CAAC;IAED;;;;OAIG;IACH,IAAI,CAAC,OAA6B;QAChC,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;IAChC,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CACJ,IAA8B,EAC9B,OAA6B;QAE7B,OAAO,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1D,CAAC;IAEkB,YAAY;QAC7B,OAAO,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC;IACpC,CAAC;IAEkB,cAAc,CAAC,IAA8B;QAC9D,OAAO;YACL,GAAG,KAAK,CAAC,cAAc,CAAC,IAAI,CAAC;YAC7B,GAAG,IAAI,CAAC,QAAQ,CAAC,cAAc;SAChC,CAAC;IACJ,CAAC;IAEkB,WAAW,CAAC,IAA8B;QAC3D,OAAO,EAAE,aAAa,EAAE,UAAU,IAAI,CAAC,MAAM,EAAE,EAAE,CAAC;IACpD,CAAC;;;AAEM,qBAAU,GAAG,EAAI,CAAC;AAClB,0BAAe,GAAG,KAAK,CAAC,CAAC,WAAW;AAEpC,0BAAe,GAAG,MAAM,CAAC,eAAe,CAAC;AACzC,mBAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC;AAC3B,6BAAkB,GAAG,MAAM,CAAC,kBAAkB,CAAC;AAC/C,oCAAyB,GAAG,MAAM,CAAC,yBAAyB,CAAC;AAC7D,4BAAiB,GAAG,MAAM,CAAC,iBAAiB,CAAC;AAC7C,wBAAa,GAAG,MAAM,CAAC,aAAa,CAAC;AACrC,wBAAa,GAAG,MAAM,CAAC,aAAa,CAAC;AACrC,yBAAc,GAAG,MAAM,CAAC,cAAc,CAAC;AACvC,0BAAe,GAAG,MAAM,CAAC,eAAe,CAAC;AACzC,8BAAmB,GAAG,MAAM,CAAC,mBAAmB,CAAC;AACjD,8BAAmB,GAAG,MAAM,CAAC,mBAAmB,CAAC;AACjD,gCAAqB,GAAG,MAAM,CAAC,qBAAqB,CAAC;AACrD,mCAAwB,GAAG,MAAM,CAAC,wBAAwB,CAAC;AAE3D,iBAAM,GAAG,OAAO,CAAC,MAAM,CAAC;AACxB,uBAAY,GAAG,OAAO,CAAC,YAAY,CAAC;AAG7C,UAAU,CAAC,YAAY,GAAG,YAAY,CAAC;AACvC,UAAU,CAAC,uBAAuB,GAAG,uBAAuB,CAAC;AAC7D,UAAU,CAAC,OAAO,GAAG,OAAO,CAAC;AAC7B,UAAU,CAAC,KAAK,GAAG,KAAK,CAAC;AACzB,UAAU,CAAC,sBAAsB,GAAG,sBAAsB,CAAC;AAC3D,UAAU,CAAC,WAAW,GAAG,WAAW,CAAC;AACrC,UAAU,CAAC,UAAU,GAAG,UAAU,CAAC;OAwD5B,EAAE,MAAM,EAAE,YAAY,EAAE;OACxB,EACL,eAAe,EACf,QAAQ,EACR,kBAAkB,EAClB,yBAAyB,EACzB,iBAAiB,EACjB,aAAa,EACb,aAAa,EACb,cAAc,EACd,eAAe,EACf,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,EACrB,wBAAwB,GACzB;AAED,eAAe,UAAU,CAAC"}
|
package/package.json
CHANGED
@@ -1,5 +1,6 @@
|
|
1
1
|
import { APIResource } from "../resource.js";
|
2
2
|
import * as Core from "../core.js";
|
3
|
+
import * as TopLevelAPI from "./top-level.js";
|
3
4
|
export declare class Embeddings extends APIResource {
|
4
5
|
/**
|
5
6
|
* Create embeddings for text or images using the specified model, encoding format,
|
@@ -9,99 +10,7 @@ export declare class Embeddings extends APIResource {
|
|
9
10
|
*
|
10
11
|
* Returns: EmbeddingCreateResponse: The response containing the embeddings.
|
11
12
|
*/
|
12
|
-
create(body: EmbeddingCreateParams, options?: Core.RequestOptions): Core.APIPromise<
|
13
|
-
}
|
14
|
-
export interface Embedding {
|
15
|
-
/**
|
16
|
-
* The encoded embedding.
|
17
|
-
*/
|
18
|
-
embedding: Array<number> | Array<number> | string;
|
19
|
-
/**
|
20
|
-
* The index of the embedding.
|
21
|
-
*/
|
22
|
-
index: number;
|
23
|
-
/**
|
24
|
-
* The object type of the embedding.
|
25
|
-
*/
|
26
|
-
object?: 'embedding';
|
27
|
-
}
|
28
|
-
export interface EmbeddingCreateResponse {
|
29
|
-
/**
|
30
|
-
* The usage of the model
|
31
|
-
*/
|
32
|
-
usage: EmbeddingCreateResponse.Usage;
|
33
|
-
/**
|
34
|
-
* The model used
|
35
|
-
*/
|
36
|
-
model: string;
|
37
|
-
/**
|
38
|
-
* The created embeddings.
|
39
|
-
*/
|
40
|
-
data: Array<Embedding> | Array<EmbeddingCreateResponse.UnionMember1>;
|
41
|
-
/**
|
42
|
-
* The object type of the response
|
43
|
-
*/
|
44
|
-
object?: 'list' | 'parsing_job' | 'job' | 'embedding' | 'embedding_dict' | 'rank_result' | 'file' | 'vector_store' | 'vector_store.file' | 'api_key';
|
45
|
-
/**
|
46
|
-
* Whether the embeddings are normalized.
|
47
|
-
*/
|
48
|
-
normalized: boolean;
|
49
|
-
/**
|
50
|
-
* The encoding formats of the embeddings.
|
51
|
-
*/
|
52
|
-
encoding_format: 'float' | 'float16' | 'base64' | 'binary' | 'ubinary' | 'int8' | 'uint8' | Array<'float' | 'float16' | 'base64' | 'binary' | 'ubinary' | 'int8' | 'uint8'>;
|
53
|
-
/**
|
54
|
-
* The number of dimensions used for the embeddings.
|
55
|
-
*/
|
56
|
-
dimensions: number | null;
|
57
|
-
}
|
58
|
-
export declare namespace EmbeddingCreateResponse {
|
59
|
-
/**
|
60
|
-
* The usage of the model
|
61
|
-
*/
|
62
|
-
interface Usage {
|
63
|
-
/**
|
64
|
-
* The number of tokens used for the prompt
|
65
|
-
*/
|
66
|
-
prompt_tokens: number;
|
67
|
-
/**
|
68
|
-
* The total number of tokens used
|
69
|
-
*/
|
70
|
-
total_tokens: number;
|
71
|
-
/**
|
72
|
-
* The number of tokens used for the completion
|
73
|
-
*/
|
74
|
-
completion_tokens?: number | null;
|
75
|
-
}
|
76
|
-
interface UnionMember1 {
|
77
|
-
/**
|
78
|
-
* The encoded embedding data by encoding format.Returned, if more than one
|
79
|
-
* encoding format is used.
|
80
|
-
*/
|
81
|
-
embedding: UnionMember1.Embedding;
|
82
|
-
/**
|
83
|
-
* The index of the embedding.
|
84
|
-
*/
|
85
|
-
index: number;
|
86
|
-
/**
|
87
|
-
* The object type of the embedding.
|
88
|
-
*/
|
89
|
-
object?: 'embedding_dict';
|
90
|
-
}
|
91
|
-
namespace UnionMember1 {
|
92
|
-
/**
|
93
|
-
* The encoded embedding data by encoding format.Returned, if more than one
|
94
|
-
* encoding format is used.
|
95
|
-
*/
|
96
|
-
interface Embedding {
|
97
|
-
float?: Array<number>;
|
98
|
-
int8?: Array<number>;
|
99
|
-
uint8?: Array<number>;
|
100
|
-
binary?: Array<number>;
|
101
|
-
ubinary?: Array<number>;
|
102
|
-
base64?: string;
|
103
|
-
}
|
104
|
-
}
|
13
|
+
create(body: EmbeddingCreateParams, options?: Core.RequestOptions): Core.APIPromise<TopLevelAPI.Em>;
|
105
14
|
}
|
106
15
|
export interface EmbeddingCreateParams {
|
107
16
|
/**
|
@@ -131,6 +40,6 @@ export interface EmbeddingCreateParams {
|
|
131
40
|
encoding_format?: 'float' | 'float16' | 'base64' | 'binary' | 'ubinary' | 'int8' | 'uint8' | Array<'float' | 'float16' | 'base64' | 'binary' | 'ubinary' | 'int8' | 'uint8'>;
|
132
41
|
}
|
133
42
|
export declare namespace Embeddings {
|
134
|
-
export { type
|
43
|
+
export { type EmbeddingCreateParams as EmbeddingCreateParams };
|
135
44
|
}
|
136
45
|
//# sourceMappingURL=embeddings.d.ts.map
|
@@ -1 +1 @@
|
|
1
|
-
{"version":3,"file":"embeddings.d.ts","sourceRoot":"","sources":["../src/resources/embeddings.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAC1C,OAAO,KAAK,IAAI,MAAM,SAAS,CAAC;
|
1
|
+
{"version":3,"file":"embeddings.d.ts","sourceRoot":"","sources":["../src/resources/embeddings.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAC1C,OAAO,KAAK,IAAI,MAAM,SAAS,CAAC;AAChC,OAAO,KAAK,WAAW,MAAM,aAAa,CAAC;AAE3C,qBAAa,UAAW,SAAQ,WAAW;IACzC;;;;;;;OAOG;IACH,MAAM,CAAC,IAAI,EAAE,qBAAqB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,EAAE,CAAC;CAGpG;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAErB;;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,CAAC,OAAO,WAAW,UAAU,CAAC;IAClC,OAAO,EAAE,KAAK,qBAAqB,IAAI,qBAAqB,EAAE,CAAC;CAChE"}
|
@@ -1 +1 @@
|
|
1
|
-
{"version":3,"file":"embeddings.js","sourceRoot":"","sources":["../src/resources/embeddings.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,6CAA0C;
|
1
|
+
{"version":3,"file":"embeddings.js","sourceRoot":"","sources":["../src/resources/embeddings.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,6CAA0C;AAI1C,MAAa,UAAW,SAAQ,sBAAW;IACzC;;;;;;;OAOG;IACH,MAAM,CAAC,IAA2B,EAAE,OAA6B;QAC/D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnE,CAAC;CACF;AAZD,gCAYC"}
|
@@ -1 +1 @@
|
|
1
|
-
{"version":3,"file":"embeddings.mjs","sourceRoot":"","sources":["../src/resources/embeddings.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;
|
1
|
+
{"version":3,"file":"embeddings.mjs","sourceRoot":"","sources":["../src/resources/embeddings.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAItB,MAAM,OAAO,UAAW,SAAQ,WAAW;IACzC;;;;;;;OAOG;IACH,MAAM,CAAC,IAA2B,EAAE,OAA6B;QAC/D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnE,CAAC;CACF"}
|