mixpeek 0.81.25 → 0.81.26
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/dist/api/features-api.d.ts +4 -4
- package/dist/api/pricing-api.d.ts +4 -4
- package/dist/lib/lib/lib/lib/lib/lib/lib/lib/lib/lib/lib/lib/lib/lib/lib/lib/lib/lib/lib/lib/lib/client.d.ts +132 -0
- package/dist/lib/lib/lib/lib/lib/lib/lib/lib/lib/lib/lib/lib/lib/lib/lib/lib/lib/lib/lib/lib/lib/client.d.ts.map +1 -0
- package/dist/lib/lib/lib/lib/lib/lib/lib/lib/lib/lib/lib/lib/lib/lib/lib/lib/lib/lib/lib/lib/lib/index.d.ts +7 -0
- package/dist/lib/lib/lib/lib/lib/lib/lib/lib/lib/lib/lib/lib/lib/lib/lib/lib/lib/lib/lib/lib/lib/index.d.ts.map +1 -0
- package/dist/models/create-collection-request.d.ts +1 -1
- package/dist/models/feature-discovery-response.d.ts +1 -1
- package/dist/models/pricing-config-response.d.ts +1 -1
- package/package.json +1 -1
|
@@ -19,7 +19,7 @@ import type { FeatureDiscoveryResponse } from '../models';
|
|
|
19
19
|
*/
|
|
20
20
|
export declare const FeaturesApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
21
21
|
/**
|
|
22
|
-
* The
|
|
22
|
+
* The menu of what you can search by: each file type (modality), its billing unit, and the search features available on it (with rates). Feature keys are the values accepted by collection config `features: [...]`. No authentication required.
|
|
23
23
|
* @summary Discover Features
|
|
24
24
|
* @param {*} [options] Override http request option.
|
|
25
25
|
* @throws {RequiredError}
|
|
@@ -32,7 +32,7 @@ export declare const FeaturesApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
32
32
|
*/
|
|
33
33
|
export declare const FeaturesApiFp: (configuration?: Configuration) => {
|
|
34
34
|
/**
|
|
35
|
-
* The
|
|
35
|
+
* The menu of what you can search by: each file type (modality), its billing unit, and the search features available on it (with rates). Feature keys are the values accepted by collection config `features: [...]`. No authentication required.
|
|
36
36
|
* @summary Discover Features
|
|
37
37
|
* @param {*} [options] Override http request option.
|
|
38
38
|
* @throws {RequiredError}
|
|
@@ -45,7 +45,7 @@ export declare const FeaturesApiFp: (configuration?: Configuration) => {
|
|
|
45
45
|
*/
|
|
46
46
|
export declare const FeaturesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
47
47
|
/**
|
|
48
|
-
* The
|
|
48
|
+
* The menu of what you can search by: each file type (modality), its billing unit, and the search features available on it (with rates). Feature keys are the values accepted by collection config `features: [...]`. No authentication required.
|
|
49
49
|
* @summary Discover Features
|
|
50
50
|
* @param {*} [options] Override http request option.
|
|
51
51
|
* @throws {RequiredError}
|
|
@@ -60,7 +60,7 @@ export declare const FeaturesApiFactory: (configuration?: Configuration, basePat
|
|
|
60
60
|
*/
|
|
61
61
|
export declare class FeaturesApi extends BaseAPI {
|
|
62
62
|
/**
|
|
63
|
-
* The
|
|
63
|
+
* The menu of what you can search by: each file type (modality), its billing unit, and the search features available on it (with rates). Feature keys are the values accepted by collection config `features: [...]`. No authentication required.
|
|
64
64
|
* @summary Discover Features
|
|
65
65
|
* @param {*} [options] Override http request option.
|
|
66
66
|
* @throws {RequiredError}
|
|
@@ -19,7 +19,7 @@ import type { PricingConfigResponse } from '../models';
|
|
|
19
19
|
*/
|
|
20
20
|
export declare const PricingApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
21
21
|
/**
|
|
22
|
-
* Public pricing
|
|
22
|
+
* Public pricing rate card. Price = how much content of each file type × (base rate + the search-by features enabled). Returns per-modality rates, tier usage pools, and plan definitions. No authentication required.
|
|
23
23
|
* @summary Get Pricing Configuration
|
|
24
24
|
* @param {*} [options] Override http request option.
|
|
25
25
|
* @throws {RequiredError}
|
|
@@ -32,7 +32,7 @@ export declare const PricingApiAxiosParamCreator: (configuration?: Configuration
|
|
|
32
32
|
*/
|
|
33
33
|
export declare const PricingApiFp: (configuration?: Configuration) => {
|
|
34
34
|
/**
|
|
35
|
-
* Public pricing
|
|
35
|
+
* Public pricing rate card. Price = how much content of each file type × (base rate + the search-by features enabled). Returns per-modality rates, tier usage pools, and plan definitions. No authentication required.
|
|
36
36
|
* @summary Get Pricing Configuration
|
|
37
37
|
* @param {*} [options] Override http request option.
|
|
38
38
|
* @throws {RequiredError}
|
|
@@ -45,7 +45,7 @@ export declare const PricingApiFp: (configuration?: Configuration) => {
|
|
|
45
45
|
*/
|
|
46
46
|
export declare const PricingApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
47
47
|
/**
|
|
48
|
-
* Public pricing
|
|
48
|
+
* Public pricing rate card. Price = how much content of each file type × (base rate + the search-by features enabled). Returns per-modality rates, tier usage pools, and plan definitions. No authentication required.
|
|
49
49
|
* @summary Get Pricing Configuration
|
|
50
50
|
* @param {*} [options] Override http request option.
|
|
51
51
|
* @throws {RequiredError}
|
|
@@ -60,7 +60,7 @@ export declare const PricingApiFactory: (configuration?: Configuration, basePath
|
|
|
60
60
|
*/
|
|
61
61
|
export declare class PricingApi extends BaseAPI {
|
|
62
62
|
/**
|
|
63
|
-
* Public pricing
|
|
63
|
+
* Public pricing rate card. Price = how much content of each file type × (base rate + the search-by features enabled). Returns per-modality rates, tier usage pools, and plan definitions. No authentication required.
|
|
64
64
|
* @summary Get Pricing Configuration
|
|
65
65
|
* @param {*} [options] Override http request option.
|
|
66
66
|
* @throws {RequiredError}
|
|
@@ -0,0 +1,132 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Mixpeek TypeScript/JavaScript SDK
|
|
3
|
+
*
|
|
4
|
+
* A modern, type-safe client for the Mixpeek multimodal data processing and retrieval platform.
|
|
5
|
+
* This wrapper class provides a developer-friendly interface to the auto-generated API clients.
|
|
6
|
+
*
|
|
7
|
+
* @example
|
|
8
|
+
* ```typescript
|
|
9
|
+
* import { Mixpeek } from 'mixpeek';
|
|
10
|
+
*
|
|
11
|
+
* const client = new Mixpeek({
|
|
12
|
+
* apiKey: process.env.MIXPEEK_API_KEY,
|
|
13
|
+
* namespace: 'my-namespace'
|
|
14
|
+
* });
|
|
15
|
+
*
|
|
16
|
+
* // Use the client — all sub-clients are fully typed
|
|
17
|
+
* const collections = await client.collections.listCollectionsV1CollectionsListPost();
|
|
18
|
+
* ```
|
|
19
|
+
*/
|
|
20
|
+
import { AxiosRequestConfig } from 'axios';
|
|
21
|
+
import { CollectionsApi, CollectionDocumentsApi, CollectionSchemaApi, CollectionLifecycleApi, CollectionTaxonomiesApi, RetrieversApi, RetrieverStagesApi, RetrieverInteractionsApi, PublishedRetrieversApi, AdhocRetrieversApi, DocumentsApi, BucketsApi, BucketObjectsApi, BucketUploadsApi, BucketSyncsApi, BucketBatchesApi, BatchesApi, NamespacesApi, OrganizationsApi, OrganizationAPIKeysApi, TaxonomiesApi, ClustersApi, ClusterExecutionsApi, AlertsApi, AgentSessionsApi, AppsApi, FeatureExtractorsApi, WebhooksApi, TasksApi, HealthApi, AnalyticsApi } from '../api';
|
|
22
|
+
export interface MixpeekOptions {
|
|
23
|
+
/**
|
|
24
|
+
* Mixpeek API key (required).
|
|
25
|
+
* Can also be set via MIXPEEK_API_KEY environment variable.
|
|
26
|
+
*/
|
|
27
|
+
apiKey?: string;
|
|
28
|
+
/**
|
|
29
|
+
* Base URL for the Mixpeek API.
|
|
30
|
+
* @default 'https://api.mixpeek.com'
|
|
31
|
+
*/
|
|
32
|
+
baseUrl?: string;
|
|
33
|
+
/**
|
|
34
|
+
* Namespace for multi-tenant isolation.
|
|
35
|
+
* @default 'default'
|
|
36
|
+
*/
|
|
37
|
+
namespace?: string;
|
|
38
|
+
/**
|
|
39
|
+
* Request timeout in milliseconds.
|
|
40
|
+
* @default 30000 (30 seconds)
|
|
41
|
+
*/
|
|
42
|
+
timeout?: number;
|
|
43
|
+
/**
|
|
44
|
+
* Additional axios configuration options.
|
|
45
|
+
*/
|
|
46
|
+
axiosConfig?: AxiosRequestConfig;
|
|
47
|
+
}
|
|
48
|
+
/**
|
|
49
|
+
* Main Mixpeek SDK client.
|
|
50
|
+
*
|
|
51
|
+
* Provides a developer-friendly interface to all Mixpeek APIs with:
|
|
52
|
+
* - Automatic authentication via Bearer token
|
|
53
|
+
* - Fully typed sub-clients for every API group
|
|
54
|
+
* - Namespace header injection
|
|
55
|
+
* - Error handling with human-readable messages
|
|
56
|
+
*
|
|
57
|
+
* @example
|
|
58
|
+
* ```typescript
|
|
59
|
+
* const client = new Mixpeek({ apiKey: 'mxp_sk_...' });
|
|
60
|
+
*
|
|
61
|
+
* // All sub-clients are typed — IDE autocompletion works
|
|
62
|
+
* const result = await client.collections.listCollectionsV1CollectionsListPost();
|
|
63
|
+
* const docs = await client.documents.listDocumentsV1DocumentsPost();
|
|
64
|
+
* ```
|
|
65
|
+
*/
|
|
66
|
+
export declare class Mixpeek {
|
|
67
|
+
private axiosInstance;
|
|
68
|
+
private apiKey;
|
|
69
|
+
private baseUrl;
|
|
70
|
+
private namespace;
|
|
71
|
+
readonly collections: CollectionsApi;
|
|
72
|
+
readonly collectionDocuments: CollectionDocumentsApi;
|
|
73
|
+
readonly collectionSchema: CollectionSchemaApi;
|
|
74
|
+
readonly collectionLifecycle: CollectionLifecycleApi;
|
|
75
|
+
readonly collectionTaxonomies: CollectionTaxonomiesApi;
|
|
76
|
+
readonly retrievers: RetrieversApi;
|
|
77
|
+
readonly retrieverStages: RetrieverStagesApi;
|
|
78
|
+
readonly retrieverInteractions: RetrieverInteractionsApi;
|
|
79
|
+
readonly publishedRetrievers: PublishedRetrieversApi;
|
|
80
|
+
readonly adhocRetrievers: AdhocRetrieversApi;
|
|
81
|
+
readonly documents: DocumentsApi;
|
|
82
|
+
readonly buckets: BucketsApi;
|
|
83
|
+
readonly bucketObjects: BucketObjectsApi;
|
|
84
|
+
readonly bucketUploads: BucketUploadsApi;
|
|
85
|
+
readonly bucketSyncs: BucketSyncsApi;
|
|
86
|
+
readonly bucketBatches: BucketBatchesApi;
|
|
87
|
+
readonly batches: BatchesApi;
|
|
88
|
+
readonly namespaces: NamespacesApi;
|
|
89
|
+
readonly organizations: OrganizationsApi;
|
|
90
|
+
readonly organizationApiKeys: OrganizationAPIKeysApi;
|
|
91
|
+
readonly taxonomies: TaxonomiesApi;
|
|
92
|
+
readonly clusters: ClustersApi;
|
|
93
|
+
readonly clusterExecutions: ClusterExecutionsApi;
|
|
94
|
+
readonly alerts: AlertsApi;
|
|
95
|
+
readonly agents: AgentSessionsApi;
|
|
96
|
+
readonly apps: AppsApi;
|
|
97
|
+
readonly featureExtractors: FeatureExtractorsApi;
|
|
98
|
+
readonly webhooks: WebhooksApi;
|
|
99
|
+
readonly tasks: TasksApi;
|
|
100
|
+
readonly health: HealthApi;
|
|
101
|
+
readonly analytics: AnalyticsApi;
|
|
102
|
+
/**
|
|
103
|
+
* Create a new Mixpeek client.
|
|
104
|
+
*
|
|
105
|
+
* @param options - Configuration options
|
|
106
|
+
* @throws {Error} If API key is not provided
|
|
107
|
+
*/
|
|
108
|
+
constructor(options?: MixpeekOptions);
|
|
109
|
+
/**
|
|
110
|
+
* Update the API key (useful for re-authentication).
|
|
111
|
+
*/
|
|
112
|
+
setApiKey(apiKey: string): void;
|
|
113
|
+
/**
|
|
114
|
+
* Update the namespace.
|
|
115
|
+
*/
|
|
116
|
+
setNamespace(namespace: string): void;
|
|
117
|
+
/**
|
|
118
|
+
* Get current configuration (API key is masked).
|
|
119
|
+
*/
|
|
120
|
+
getConfig(): {
|
|
121
|
+
apiKey: string;
|
|
122
|
+
baseUrl: string;
|
|
123
|
+
namespace: string;
|
|
124
|
+
};
|
|
125
|
+
/**
|
|
126
|
+
* Make a raw HTTP request using the configured axios instance.
|
|
127
|
+
* Useful for calling endpoints not yet covered by the SDK.
|
|
128
|
+
*/
|
|
129
|
+
request<T = any>(config: AxiosRequestConfig): Promise<T>;
|
|
130
|
+
}
|
|
131
|
+
export default Mixpeek;
|
|
132
|
+
//# sourceMappingURL=client.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../../../../../../../../../../../../../../../../../../../../../lib/lib/lib/lib/lib/lib/lib/lib/lib/lib/lib/lib/lib/lib/lib/lib/lib/lib/lib/lib/lib/client.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AAEH,OAAc,EAAiB,kBAAkB,EAAE,MAAM,OAAO,CAAC;AAIjE,OAAO,EACL,cAAc,EACd,sBAAsB,EACtB,mBAAmB,EACnB,sBAAsB,EACtB,uBAAuB,EACvB,aAAa,EACb,kBAAkB,EAClB,wBAAwB,EACxB,sBAAsB,EACtB,kBAAkB,EAClB,YAAY,EACZ,UAAU,EACV,gBAAgB,EAChB,gBAAgB,EAChB,cAAc,EACd,gBAAgB,EAChB,UAAU,EACV,aAAa,EACb,gBAAgB,EAChB,sBAAsB,EACtB,aAAa,EACb,WAAW,EACX,oBAAoB,EACpB,SAAS,EACT,gBAAgB,EAChB,OAAO,EACP,oBAAoB,EACpB,WAAW,EACX,QAAQ,EACR,SAAS,EACT,YAAY,EACb,MAAM,QAAQ,CAAC;AAEhB,MAAM,WAAW,cAAc;IAC7B;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,WAAW,CAAC,EAAE,kBAAkB,CAAC;CAClC;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,qBAAa,OAAO;IAClB,OAAO,CAAC,aAAa,CAAgB;IACrC,OAAO,CAAC,MAAM,CAAS;IACvB,OAAO,CAAC,OAAO,CAAS;IACxB,OAAO,CAAC,SAAS,CAAS;IAG1B,SAAgB,WAAW,EAAE,cAAc,CAAC;IAC5C,SAAgB,mBAAmB,EAAE,sBAAsB,CAAC;IAC5D,SAAgB,gBAAgB,EAAE,mBAAmB,CAAC;IACtD,SAAgB,mBAAmB,EAAE,sBAAsB,CAAC;IAC5D,SAAgB,oBAAoB,EAAE,uBAAuB,CAAC;IAC9D,SAAgB,UAAU,EAAE,aAAa,CAAC;IAC1C,SAAgB,eAAe,EAAE,kBAAkB,CAAC;IACpD,SAAgB,qBAAqB,EAAE,wBAAwB,CAAC;IAChE,SAAgB,mBAAmB,EAAE,sBAAsB,CAAC;IAC5D,SAAgB,eAAe,EAAE,kBAAkB,CAAC;IACpD,SAAgB,SAAS,EAAE,YAAY,CAAC;IACxC,SAAgB,OAAO,EAAE,UAAU,CAAC;IACpC,SAAgB,aAAa,EAAE,gBAAgB,CAAC;IAChD,SAAgB,aAAa,EAAE,gBAAgB,CAAC;IAChD,SAAgB,WAAW,EAAE,cAAc,CAAC;IAC5C,SAAgB,aAAa,EAAE,gBAAgB,CAAC;IAChD,SAAgB,OAAO,EAAE,UAAU,CAAC;IACpC,SAAgB,UAAU,EAAE,aAAa,CAAC;IAC1C,SAAgB,aAAa,EAAE,gBAAgB,CAAC;IAChD,SAAgB,mBAAmB,EAAE,sBAAsB,CAAC;IAC5D,SAAgB,UAAU,EAAE,aAAa,CAAC;IAC1C,SAAgB,QAAQ,EAAE,WAAW,CAAC;IACtC,SAAgB,iBAAiB,EAAE,oBAAoB,CAAC;IACxD,SAAgB,MAAM,EAAE,SAAS,CAAC;IAClC,SAAgB,MAAM,EAAE,gBAAgB,CAAC;IACzC,SAAgB,IAAI,EAAE,OAAO,CAAC;IAC9B,SAAgB,iBAAiB,EAAE,oBAAoB,CAAC;IACxD,SAAgB,QAAQ,EAAE,WAAW,CAAC;IACtC,SAAgB,KAAK,EAAE,QAAQ,CAAC;IAChC,SAAgB,MAAM,EAAE,SAAS,CAAC;IAClC,SAAgB,SAAS,EAAE,YAAY,CAAC;IAExC;;;;;OAKG;gBACS,OAAO,GAAE,cAAmB;IA8FxC;;OAEG;IACI,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAKtC;;OAEG;IACI,YAAY,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI;IAK5C;;OAEG;IACI,SAAS,IAAI;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,MAAM,CAAA;KAAE;IAQ1E;;;OAGG;IACU,OAAO,CAAC,CAAC,GAAG,GAAG,EAAE,MAAM,EAAE,kBAAkB,GAAG,OAAO,CAAC,CAAC,CAAC;CAItE;AAED,eAAe,OAAO,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../../../../../../../../../../../../../../../../../lib/lib/lib/lib/lib/lib/lib/lib/lib/lib/lib/lib/lib/lib/lib/lib/lib/lib/lib/lib/lib/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,OAAO,EAAE,MAAM,UAAU,CAAC;AACnC,YAAY,EAAE,cAAc,EAAE,MAAM,UAAU,CAAC"}
|
|
@@ -54,7 +54,7 @@ export interface CreateCollectionRequest {
|
|
|
54
54
|
*/
|
|
55
55
|
'feature_extractor': SharedCollectionFeaturesExtractorsModelsFeatureExtractorConfigInput;
|
|
56
56
|
/**
|
|
57
|
-
*
|
|
57
|
+
* What you want to search by: feature keys from GET /v1/collections/features (e.g. [\'faces\'] or [\'custom:<plugin>\']). Resolved to the processing pipeline server-side — the preferred alternative to `feature_extractor`. Provide one or the other.
|
|
58
58
|
* @type {Array<string>}
|
|
59
59
|
* @memberof CreateCollectionRequest
|
|
60
60
|
*/
|
|
@@ -16,7 +16,7 @@
|
|
|
16
16
|
*/
|
|
17
17
|
export interface FeatureDiscoveryResponse {
|
|
18
18
|
/**
|
|
19
|
-
* Per
|
|
19
|
+
* Per file type (modality): its billing unit, base search feature, and the add-on search-by features available, with rates
|
|
20
20
|
* @type {Array<{ [key: string]: any; }>}
|
|
21
21
|
* @memberof FeatureDiscoveryResponse
|
|
22
22
|
*/
|
|
@@ -79,7 +79,7 @@ export interface PricingConfigResponse {
|
|
|
79
79
|
*/
|
|
80
80
|
'placeholder_rates'?: boolean;
|
|
81
81
|
/**
|
|
82
|
-
* Per
|
|
82
|
+
* Per file type (modality): its billing unit, base rate, and the search-by features you can add (D9: the public vocabulary — render these, never extractors).
|
|
83
83
|
* @type {Array<any>}
|
|
84
84
|
* @memberof PricingConfigResponse
|
|
85
85
|
*/
|
package/package.json
CHANGED