@searchstack/public-api 1.0.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/LICENSE +15 -0
- package/README.md +200 -0
- package/dist/AccountService.d.ts +12 -0
- package/dist/AccountService.d.ts.map +1 -0
- package/dist/AccountService.js +19 -0
- package/dist/AccountService.js.map +1 -0
- package/dist/AnalyticsService.d.ts +12 -0
- package/dist/AnalyticsService.d.ts.map +1 -0
- package/dist/AnalyticsService.js +32 -0
- package/dist/AnalyticsService.js.map +1 -0
- package/dist/Client.d.ts +59 -0
- package/dist/Client.d.ts.map +1 -0
- package/dist/Client.js +78 -0
- package/dist/Client.js.map +1 -0
- package/dist/ContributorService.d.ts +12 -0
- package/dist/ContributorService.d.ts.map +1 -0
- package/dist/ContributorService.js +20 -0
- package/dist/ContributorService.js.map +1 -0
- package/dist/CoordinatesService.d.ts +12 -0
- package/dist/CoordinatesService.d.ts.map +1 -0
- package/dist/CoordinatesService.js +21 -0
- package/dist/CoordinatesService.js.map +1 -0
- package/dist/DiscoveryService.d.ts +13 -0
- package/dist/DiscoveryService.d.ts.map +1 -0
- package/dist/DiscoveryService.js +25 -0
- package/dist/DiscoveryService.js.map +1 -0
- package/dist/EvalService.d.ts +24 -0
- package/dist/EvalService.d.ts.map +1 -0
- package/dist/EvalService.js +55 -0
- package/dist/EvalService.js.map +1 -0
- package/dist/FacetService.d.ts +14 -0
- package/dist/FacetService.d.ts.map +1 -0
- package/dist/FacetService.js +26 -0
- package/dist/FacetService.js.map +1 -0
- package/dist/Fetch.d.ts +23 -0
- package/dist/Fetch.d.ts.map +1 -0
- package/dist/Fetch.js +74 -0
- package/dist/Fetch.js.map +1 -0
- package/dist/GroupService.d.ts +44 -0
- package/dist/GroupService.d.ts.map +1 -0
- package/dist/GroupService.js +100 -0
- package/dist/GroupService.js.map +1 -0
- package/dist/JudgeService.d.ts +22 -0
- package/dist/JudgeService.d.ts.map +1 -0
- package/dist/JudgeService.js +47 -0
- package/dist/JudgeService.js.map +1 -0
- package/dist/ListService.d.ts +18 -0
- package/dist/ListService.d.ts.map +1 -0
- package/dist/ListService.js +35 -0
- package/dist/ListService.js.map +1 -0
- package/dist/MediaStoreService.d.ts +10 -0
- package/dist/MediaStoreService.d.ts.map +1 -0
- package/dist/MediaStoreService.js +15 -0
- package/dist/MediaStoreService.js.map +1 -0
- package/dist/ResourceService.d.ts +14 -0
- package/dist/ResourceService.d.ts.map +1 -0
- package/dist/ResourceService.js +26 -0
- package/dist/ResourceService.js.map +1 -0
- package/dist/SearchResultService.d.ts +33 -0
- package/dist/SearchResultService.d.ts.map +1 -0
- package/dist/SearchResultService.js +67 -0
- package/dist/SearchResultService.js.map +1 -0
- package/dist/SearchService.d.ts +31 -0
- package/dist/SearchService.d.ts.map +1 -0
- package/dist/SearchService.js +75 -0
- package/dist/SearchService.js.map +1 -0
- package/dist/SearchableFieldService.d.ts +14 -0
- package/dist/SearchableFieldService.d.ts.map +1 -0
- package/dist/SearchableFieldService.js +26 -0
- package/dist/SearchableFieldService.js.map +1 -0
- package/dist/SuggestService.d.ts +12 -0
- package/dist/SuggestService.d.ts.map +1 -0
- package/dist/SuggestService.js +23 -0
- package/dist/SuggestService.js.map +1 -0
- package/dist/Types.d.ts +753 -0
- package/dist/Types.d.ts.map +1 -0
- package/dist/Types.js +38 -0
- package/dist/Types.js.map +1 -0
- package/dist/handleResponse.d.ts +4 -0
- package/dist/handleResponse.d.ts.map +1 -0
- package/dist/handleResponse.js +22 -0
- package/dist/handleResponse.js.map +1 -0
- package/dist/index.d.ts +4 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +3 -0
- package/dist/index.js.map +1 -0
- package/package.json +52 -0
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
import { handleResponse } from "./handleResponse.js";
|
|
2
|
+
export default class ResourceService {
|
|
3
|
+
fetch;
|
|
4
|
+
path = `resource`;
|
|
5
|
+
constructor(fetch) {
|
|
6
|
+
this.fetch = fetch;
|
|
7
|
+
}
|
|
8
|
+
/** Creates a Resource - a non-searchable, non-filterable field (commonly a URL). */
|
|
9
|
+
async create(request) {
|
|
10
|
+
const response = await this.fetch.post(this.path, request);
|
|
11
|
+
return handleResponse(response, async () => (await response.json()));
|
|
12
|
+
}
|
|
13
|
+
/** Renames a Resource. Breaking change - automatically updates the List version. */
|
|
14
|
+
async rename(account_name, list_name, resource_name, request) {
|
|
15
|
+
const path = `${this.path}/${encodeURIComponent(account_name)}/${encodeURIComponent(list_name)}/${encodeURIComponent(resource_name)}`;
|
|
16
|
+
const response = await this.fetch.put(path, request);
|
|
17
|
+
return handleResponse(response, async () => (await response.json()));
|
|
18
|
+
}
|
|
19
|
+
/** Removes a Resource. Breaking change - automatically updates the List version. */
|
|
20
|
+
async remove(account_name, list_name, resource_name) {
|
|
21
|
+
const path = `${this.path}/${encodeURIComponent(account_name)}/${encodeURIComponent(list_name)}/${encodeURIComponent(resource_name)}`;
|
|
22
|
+
const response = await this.fetch.delete(path);
|
|
23
|
+
return handleResponse(response, () => undefined);
|
|
24
|
+
}
|
|
25
|
+
}
|
|
26
|
+
//# sourceMappingURL=ResourceService.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"ResourceService.js","sourceRoot":"","sources":["../src/ResourceService.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAGrD,MAAM,CAAC,OAAO,OAAO,eAAe;IAEL;IADZ,IAAI,GAAG,UAAU,CAAC;IACnC,YAA6B,KAAY;QAAZ,UAAK,GAAL,KAAK,CAAO;IAAG,CAAC;IAE7C,oFAAoF;IACpF,KAAK,CAAC,MAAM,CAAC,OAA8B;QACzC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QAC3D,OAAO,cAAc,CAAC,QAAQ,EAAE,KAAK,IAAI,EAAE,CAAC,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAqB,CAAC,CAAC;IAC3F,CAAC;IAED,oFAAoF;IACpF,KAAK,CAAC,MAAM,CAAC,YAAoB,EAAE,SAAiB,EAAE,aAAqB,EAAE,OAA8B;QACzG,MAAM,IAAI,GAAG,GAAG,IAAI,CAAC,IAAI,IAAI,kBAAkB,CAAC,YAAY,CAAC,IAAI,kBAAkB,CAAC,SAAS,CAAC,IAAI,kBAAkB,CAAC,aAAa,CAAC,EAAE,CAAC;QACtI,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QACrD,OAAO,cAAc,CAAC,QAAQ,EAAE,KAAK,IAAI,EAAE,CAAC,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAqB,CAAC,CAAC;IAC3F,CAAC;IAED,oFAAoF;IACpF,KAAK,CAAC,MAAM,CAAC,YAAoB,EAAE,SAAiB,EAAE,aAAqB;QACzE,MAAM,IAAI,GAAG,GAAG,IAAI,CAAC,IAAI,IAAI,kBAAkB,CAAC,YAAY,CAAC,IAAI,kBAAkB,CAAC,SAAS,CAAC,IAAI,kBAAkB,CAAC,aAAa,CAAC,EAAE,CAAC;QACtI,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAC/C,OAAO,cAAc,CAAC,QAAQ,EAAE,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;IACnD,CAAC;CACF"}
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
import Fetch from "./Fetch.js";
|
|
2
|
+
import { Response, Problem, SearchHit, ListResponse, CreateSearchResultRequest, UpdateSearchResultRequest, UpdateSearchResultVectorRequest, DeleteByFilterRequest, DeleteByFilterResponse } from "./Types.js";
|
|
3
|
+
export default class SearchResultService {
|
|
4
|
+
private readonly fetch;
|
|
5
|
+
private readonly path;
|
|
6
|
+
constructor(fetch: Fetch);
|
|
7
|
+
/** Creates a single Search Result. */
|
|
8
|
+
create(request: CreateSearchResultRequest): Promise<Response<SearchHit, Problem>>;
|
|
9
|
+
/** Bulk inserts multiple Search Results into an existing List. */
|
|
10
|
+
bulkInsert(account_name: string, list_name: string, search_results: Record<string, unknown>[]): Promise<Response<ListResponse, Problem>>;
|
|
11
|
+
/** Creates fields as needed and bulk inserts multiple Search Results. */
|
|
12
|
+
bulkInsertWithFields(account_name: string, list_name: string, search_results: Record<string, unknown>[]): Promise<Response<ListResponse, Problem>>;
|
|
13
|
+
/** Edits the properties of an existing Search Result. */
|
|
14
|
+
edit(account_name: string, list_name: string, id: string, request: UpdateSearchResultRequest): Promise<Response<SearchHit, Problem>>;
|
|
15
|
+
/**
|
|
16
|
+
* Directly updates the text/image/document vectors of a Search Result. Vector
|
|
17
|
+
* dimensions are validated and the List must not be attached to a model.
|
|
18
|
+
*/
|
|
19
|
+
editVector(account_name: string, list_name: string, search_result_name: string, request: UpdateSearchResultVectorRequest): Promise<Response<SearchHit, Problem>>;
|
|
20
|
+
/** Permanently deletes a Search Result. */
|
|
21
|
+
remove(account_name: string, list_name: string, id: string): Promise<Response<void, Problem>>;
|
|
22
|
+
/**
|
|
23
|
+
* Permanently deletes every Search Result matching a filter. Runs asynchronously;
|
|
24
|
+
* resolves once the job is accepted (HTTP 202).
|
|
25
|
+
*/
|
|
26
|
+
deleteByFilter(account_name: string, list_name: string, request: DeleteByFilterRequest): Promise<Response<DeleteByFilterResponse, Problem>>;
|
|
27
|
+
/**
|
|
28
|
+
* Soft-deletes (deactivates) every Search Result matching a filter. Runs
|
|
29
|
+
* asynchronously; resolves once the job is accepted (HTTP 202).
|
|
30
|
+
*/
|
|
31
|
+
softDeleteByFilter(account_name: string, list_name: string, request: DeleteByFilterRequest): Promise<Response<DeleteByFilterResponse, Problem>>;
|
|
32
|
+
}
|
|
33
|
+
//# sourceMappingURL=SearchResultService.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"SearchResultService.d.ts","sourceRoot":"","sources":["../src/SearchResultService.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,YAAY,CAAC;AAE/B,OAAO,EACL,QAAQ,EAAE,OAAO,EAAE,SAAS,EAAE,YAAY,EAC1C,yBAAyB,EAAE,yBAAyB,EAAE,+BAA+B,EACrF,qBAAqB,EAAE,sBAAsB,EAC9C,MAAM,YAAY,CAAC;AAIpB,MAAM,CAAC,OAAO,OAAO,mBAAmB;IAE1B,OAAO,CAAC,QAAQ,CAAC,KAAK;IADlC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAmB;gBACX,KAAK,EAAE,KAAK;IAEzC,sCAAsC;IAChC,MAAM,CAAC,OAAO,EAAE,yBAAyB,GAAG,OAAO,CAAC,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;IAKvF,kEAAkE;IAC5D,UAAU,CAAC,YAAY,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,GAAG,OAAO,CAAC,QAAQ,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;IAM9I,yEAAyE;IACnE,oBAAoB,CAAC,YAAY,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,GAAG,OAAO,CAAC,QAAQ,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;IAMxJ,yDAAyD;IACnD,IAAI,CAAC,YAAY,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,yBAAyB,GAAG,OAAO,CAAC,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;IAM1I;;;OAGG;IACG,UAAU,CAAC,YAAY,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,kBAAkB,EAAE,MAAM,EAAE,OAAO,EAAE,+BAA+B,GAAG,OAAO,CAAC,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;IAMtK,2CAA2C;IACrC,MAAM,CAAC,YAAY,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IAMnG;;;OAGG;IACG,cAAc,CAAC,YAAY,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,qBAAqB,GAAG,OAAO,CAAC,QAAQ,CAAC,sBAAsB,EAAE,OAAO,CAAC,CAAC;IAMjJ;;;OAGG;IACG,kBAAkB,CAAC,YAAY,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,qBAAqB,GAAG,OAAO,CAAC,QAAQ,CAAC,sBAAsB,EAAE,OAAO,CAAC,CAAC;CAKtJ"}
|
|
@@ -0,0 +1,67 @@
|
|
|
1
|
+
import { handleResponse } from "./handleResponse.js";
|
|
2
|
+
// Write-side operations for Search Results (create, bulk-insert, edit, delete).
|
|
3
|
+
// Read / query operations live on SearchService.
|
|
4
|
+
export default class SearchResultService {
|
|
5
|
+
fetch;
|
|
6
|
+
path = `search-result`;
|
|
7
|
+
constructor(fetch) {
|
|
8
|
+
this.fetch = fetch;
|
|
9
|
+
}
|
|
10
|
+
/** Creates a single Search Result. */
|
|
11
|
+
async create(request) {
|
|
12
|
+
const response = await this.fetch.post(this.path, request);
|
|
13
|
+
return handleResponse(response, async () => (await response.json()));
|
|
14
|
+
}
|
|
15
|
+
/** Bulk inserts multiple Search Results into an existing List. */
|
|
16
|
+
async bulkInsert(account_name, list_name, search_results) {
|
|
17
|
+
const path = `${this.path}/${encodeURIComponent(account_name)}/${encodeURIComponent(list_name)}`;
|
|
18
|
+
const response = await this.fetch.post(path, search_results);
|
|
19
|
+
return handleResponse(response, async () => (await response.json()));
|
|
20
|
+
}
|
|
21
|
+
/** Creates fields as needed and bulk inserts multiple Search Results. */
|
|
22
|
+
async bulkInsertWithFields(account_name, list_name, search_results) {
|
|
23
|
+
const path = `${this.path}/${encodeURIComponent(account_name)}/${encodeURIComponent(list_name)}/with-fields`;
|
|
24
|
+
const response = await this.fetch.post(path, search_results);
|
|
25
|
+
return handleResponse(response, async () => (await response.json()));
|
|
26
|
+
}
|
|
27
|
+
/** Edits the properties of an existing Search Result. */
|
|
28
|
+
async edit(account_name, list_name, id, request) {
|
|
29
|
+
const path = `${this.path}/${encodeURIComponent(account_name)}/${encodeURIComponent(list_name)}/${encodeURIComponent(id)}`;
|
|
30
|
+
const response = await this.fetch.put(path, request);
|
|
31
|
+
return handleResponse(response, async () => (await response.json()));
|
|
32
|
+
}
|
|
33
|
+
/**
|
|
34
|
+
* Directly updates the text/image/document vectors of a Search Result. Vector
|
|
35
|
+
* dimensions are validated and the List must not be attached to a model.
|
|
36
|
+
*/
|
|
37
|
+
async editVector(account_name, list_name, search_result_name, request) {
|
|
38
|
+
const path = `${this.path}/${encodeURIComponent(account_name)}/${encodeURIComponent(list_name)}/${encodeURIComponent(search_result_name)}/vector`;
|
|
39
|
+
const response = await this.fetch.put(path, request);
|
|
40
|
+
return handleResponse(response, async () => (await response.json()));
|
|
41
|
+
}
|
|
42
|
+
/** Permanently deletes a Search Result. */
|
|
43
|
+
async remove(account_name, list_name, id) {
|
|
44
|
+
const path = `${this.path}/${encodeURIComponent(account_name)}/${encodeURIComponent(list_name)}/${encodeURIComponent(id)}`;
|
|
45
|
+
const response = await this.fetch.delete(path);
|
|
46
|
+
return handleResponse(response, () => undefined);
|
|
47
|
+
}
|
|
48
|
+
/**
|
|
49
|
+
* Permanently deletes every Search Result matching a filter. Runs asynchronously;
|
|
50
|
+
* resolves once the job is accepted (HTTP 202).
|
|
51
|
+
*/
|
|
52
|
+
async deleteByFilter(account_name, list_name, request) {
|
|
53
|
+
const path = `${this.path}/${encodeURIComponent(account_name)}/${encodeURIComponent(list_name)}/delete-by-filter`;
|
|
54
|
+
const response = await this.fetch.post(path, request);
|
|
55
|
+
return handleResponse(response, async () => (await response.json()));
|
|
56
|
+
}
|
|
57
|
+
/**
|
|
58
|
+
* Soft-deletes (deactivates) every Search Result matching a filter. Runs
|
|
59
|
+
* asynchronously; resolves once the job is accepted (HTTP 202).
|
|
60
|
+
*/
|
|
61
|
+
async softDeleteByFilter(account_name, list_name, request) {
|
|
62
|
+
const path = `${this.path}/${encodeURIComponent(account_name)}/${encodeURIComponent(list_name)}/soft-delete-by-filter`;
|
|
63
|
+
const response = await this.fetch.post(path, request);
|
|
64
|
+
return handleResponse(response, async () => (await response.json()));
|
|
65
|
+
}
|
|
66
|
+
}
|
|
67
|
+
//# sourceMappingURL=SearchResultService.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"SearchResultService.js","sourceRoot":"","sources":["../src/SearchResultService.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAOrD,gFAAgF;AAChF,iDAAiD;AACjD,MAAM,CAAC,OAAO,OAAO,mBAAmB;IAET;IADZ,IAAI,GAAG,eAAe,CAAC;IACxC,YAA6B,KAAY;QAAZ,UAAK,GAAL,KAAK,CAAO;IAAG,CAAC;IAE7C,sCAAsC;IACtC,KAAK,CAAC,MAAM,CAAC,OAAkC;QAC7C,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QAC3D,OAAO,cAAc,CAAC,QAAQ,EAAE,KAAK,IAAI,EAAE,CAAC,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAc,CAAC,CAAC;IACpF,CAAC;IAED,kEAAkE;IAClE,KAAK,CAAC,UAAU,CAAC,YAAoB,EAAE,SAAiB,EAAE,cAAyC;QACjG,MAAM,IAAI,GAAG,GAAG,IAAI,CAAC,IAAI,IAAI,kBAAkB,CAAC,YAAY,CAAC,IAAI,kBAAkB,CAAC,SAAS,CAAC,EAAE,CAAC;QACjG,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,cAAc,CAAC,CAAC;QAC7D,OAAO,cAAc,CAAC,QAAQ,EAAE,KAAK,IAAI,EAAE,CAAC,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAiB,CAAC,CAAC;IACvF,CAAC;IAED,yEAAyE;IACzE,KAAK,CAAC,oBAAoB,CAAC,YAAoB,EAAE,SAAiB,EAAE,cAAyC;QAC3G,MAAM,IAAI,GAAG,GAAG,IAAI,CAAC,IAAI,IAAI,kBAAkB,CAAC,YAAY,CAAC,IAAI,kBAAkB,CAAC,SAAS,CAAC,cAAc,CAAC;QAC7G,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,cAAc,CAAC,CAAC;QAC7D,OAAO,cAAc,CAAC,QAAQ,EAAE,KAAK,IAAI,EAAE,CAAC,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAiB,CAAC,CAAC;IACvF,CAAC;IAED,yDAAyD;IACzD,KAAK,CAAC,IAAI,CAAC,YAAoB,EAAE,SAAiB,EAAE,EAAU,EAAE,OAAkC;QAChG,MAAM,IAAI,GAAG,GAAG,IAAI,CAAC,IAAI,IAAI,kBAAkB,CAAC,YAAY,CAAC,IAAI,kBAAkB,CAAC,SAAS,CAAC,IAAI,kBAAkB,CAAC,EAAE,CAAC,EAAE,CAAC;QAC3H,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QACrD,OAAO,cAAc,CAAC,QAAQ,EAAE,KAAK,IAAI,EAAE,CAAC,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAc,CAAC,CAAC;IACpF,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,UAAU,CAAC,YAAoB,EAAE,SAAiB,EAAE,kBAA0B,EAAE,OAAwC;QAC5H,MAAM,IAAI,GAAG,GAAG,IAAI,CAAC,IAAI,IAAI,kBAAkB,CAAC,YAAY,CAAC,IAAI,kBAAkB,CAAC,SAAS,CAAC,IAAI,kBAAkB,CAAC,kBAAkB,CAAC,SAAS,CAAC;QAClJ,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QACrD,OAAO,cAAc,CAAC,QAAQ,EAAE,KAAK,IAAI,EAAE,CAAC,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAc,CAAC,CAAC;IACpF,CAAC;IAED,2CAA2C;IAC3C,KAAK,CAAC,MAAM,CAAC,YAAoB,EAAE,SAAiB,EAAE,EAAU;QAC9D,MAAM,IAAI,GAAG,GAAG,IAAI,CAAC,IAAI,IAAI,kBAAkB,CAAC,YAAY,CAAC,IAAI,kBAAkB,CAAC,SAAS,CAAC,IAAI,kBAAkB,CAAC,EAAE,CAAC,EAAE,CAAC;QAC3H,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAC/C,OAAO,cAAc,CAAC,QAAQ,EAAE,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;IACnD,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,cAAc,CAAC,YAAoB,EAAE,SAAiB,EAAE,OAA8B;QAC1F,MAAM,IAAI,GAAG,GAAG,IAAI,CAAC,IAAI,IAAI,kBAAkB,CAAC,YAAY,CAAC,IAAI,kBAAkB,CAAC,SAAS,CAAC,mBAAmB,CAAC;QAClH,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QACtD,OAAO,cAAc,CAAC,QAAQ,EAAE,KAAK,IAAI,EAAE,CAAC,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAA2B,CAAC,CAAC;IACjG,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,kBAAkB,CAAC,YAAoB,EAAE,SAAiB,EAAE,OAA8B;QAC9F,MAAM,IAAI,GAAG,GAAG,IAAI,CAAC,IAAI,IAAI,kBAAkB,CAAC,YAAY,CAAC,IAAI,kBAAkB,CAAC,SAAS,CAAC,wBAAwB,CAAC;QACvH,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QACtD,OAAO,cAAc,CAAC,QAAQ,EAAE,KAAK,IAAI,EAAE,CAAC,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAA2B,CAAC,CAAC;IACjG,CAAC;CACF"}
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
import Fetch from "./Fetch.js";
|
|
2
|
+
import { Response, Problem, SearchResponse, ExtractDocumentTextResponse, SearchOptions, RelatedOptions, SearchByImageRequest, SearchByImageBase64Request, RecordClickRequest } from "./Types.js";
|
|
3
|
+
export default class SearchService {
|
|
4
|
+
private readonly fetch;
|
|
5
|
+
private readonly path;
|
|
6
|
+
constructor(fetch: Fetch);
|
|
7
|
+
/** Free-text and/or vector search of a List version. */
|
|
8
|
+
searchList(account_name: string, list_name: string, version: number, options?: SearchOptions): Promise<Response<SearchResponse, Problem>>;
|
|
9
|
+
/** Free-text and/or vector search across a Group of Lists at a specific membership version (use the Group's current_version, or an older version to search a frozen set of records). */
|
|
10
|
+
searchGroup(account_name: string, group_name: string, version: number, options?: SearchOptions): Promise<Response<SearchResponse, Problem>>;
|
|
11
|
+
/** Finds Search Results within a List that are vector-similar to a seed result. */
|
|
12
|
+
related(account_name: string, list_name: string, search_result_name: string, options?: RelatedOptions): Promise<Response<SearchResponse, Problem>>;
|
|
13
|
+
/** Image-similarity search of a List using an absolute image URL. */
|
|
14
|
+
searchListByImage(account_name: string, list_name: string, version: number, request: SearchByImageRequest): Promise<Response<SearchResponse, Problem>>;
|
|
15
|
+
/** Image-similarity search of a Group at a specific membership version using an absolute image URL. */
|
|
16
|
+
searchGroupByImage(account_name: string, group_name: string, version: number, request: SearchByImageRequest): Promise<Response<SearchResponse, Problem>>;
|
|
17
|
+
/** Image-similarity search of a List using a base64-encoded image. */
|
|
18
|
+
searchListByImageBase64(account_name: string, list_name: string, version: number, request: SearchByImageBase64Request): Promise<Response<SearchResponse, Problem>>;
|
|
19
|
+
/** Image-similarity search of a Group at a specific membership version using a base64-encoded image. */
|
|
20
|
+
searchGroupByImageBase64(account_name: string, group_name: string, version: number, request: SearchByImageBase64Request): Promise<Response<SearchResponse, Problem>>;
|
|
21
|
+
/**
|
|
22
|
+
* Extracts text from PDF documents on a Search Result. Only available when the
|
|
23
|
+
* List's model declares a positive MaxDocumentPages limit.
|
|
24
|
+
*/
|
|
25
|
+
extractDocumentText(account_name: string, list_name: string, search_result_name: string): Promise<Response<ExtractDocumentTextResponse, Problem>>;
|
|
26
|
+
/** Records a click-through on a List search result, correlated by query_id. */
|
|
27
|
+
recordListClick(account_name: string, list_name: string, request: RecordClickRequest): Promise<Response<void, Problem>>;
|
|
28
|
+
/** Records a click-through on a Group search result, correlated by query_id. */
|
|
29
|
+
recordGroupClick(account_name: string, group_name: string, request: RecordClickRequest): Promise<Response<void, Problem>>;
|
|
30
|
+
}
|
|
31
|
+
//# sourceMappingURL=SearchService.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"SearchService.d.ts","sourceRoot":"","sources":["../src/SearchService.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,YAAY,CAAC;AAE/B,OAAO,EACL,QAAQ,EAAE,OAAO,EAAE,cAAc,EAAE,2BAA2B,EAC9D,aAAa,EAAE,cAAc,EAAE,oBAAoB,EAAE,0BAA0B,EAAE,kBAAkB,EACpG,MAAM,YAAY,CAAC;AAKpB,MAAM,CAAC,OAAO,OAAO,aAAa;IAEpB,OAAO,CAAC,QAAQ,CAAC,KAAK;IADlC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAmB;gBACX,KAAK,EAAE,KAAK;IAEzC,wDAAwD;IAClD,UAAU,CAAC,YAAY,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,GAAE,aAAkB,GAAG,OAAO,CAAC,QAAQ,CAAC,cAAc,EAAE,OAAO,CAAC,CAAC;IAMnJ,wLAAwL;IAClL,WAAW,CAAC,YAAY,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,GAAE,aAAkB,GAAG,OAAO,CAAC,QAAQ,CAAC,cAAc,EAAE,OAAO,CAAC,CAAC;IAMrJ,mFAAmF;IAC7E,OAAO,CAAC,YAAY,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,kBAAkB,EAAE,MAAM,EAAE,OAAO,GAAE,cAAmB,GAAG,OAAO,CAAC,QAAQ,CAAC,cAAc,EAAE,OAAO,CAAC,CAAC;IAM5J,qEAAqE;IAC/D,iBAAiB,CAAC,YAAY,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,oBAAoB,GAAG,OAAO,CAAC,QAAQ,CAAC,cAAc,EAAE,OAAO,CAAC,CAAC;IAM5J,uGAAuG;IACjG,kBAAkB,CAAC,YAAY,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,oBAAoB,GAAG,OAAO,CAAC,QAAQ,CAAC,cAAc,EAAE,OAAO,CAAC,CAAC;IAM9J,sEAAsE;IAChE,uBAAuB,CAAC,YAAY,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,0BAA0B,GAAG,OAAO,CAAC,QAAQ,CAAC,cAAc,EAAE,OAAO,CAAC,CAAC;IAMxK,wGAAwG;IAClG,wBAAwB,CAAC,YAAY,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,0BAA0B,GAAG,OAAO,CAAC,QAAQ,CAAC,cAAc,EAAE,OAAO,CAAC,CAAC;IAM1K;;;OAGG;IACG,mBAAmB,CAAC,YAAY,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,kBAAkB,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC,2BAA2B,EAAE,OAAO,CAAC,CAAC;IAMvJ,+EAA+E;IACzE,eAAe,CAAC,YAAY,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IAM7H,gFAAgF;IAC1E,gBAAgB,CAAC,YAAY,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;CAKhI"}
|
|
@@ -0,0 +1,75 @@
|
|
|
1
|
+
import { handleResponse } from "./handleResponse.js";
|
|
2
|
+
// Read / query operations against the search-result endpoints. Every method uses
|
|
3
|
+
// the POST variant so options are passed as a typed body rather than a query
|
|
4
|
+
// string. Searching requires the SearchResult.Read permission on the API key.
|
|
5
|
+
export default class SearchService {
|
|
6
|
+
fetch;
|
|
7
|
+
path = `search-result`;
|
|
8
|
+
constructor(fetch) {
|
|
9
|
+
this.fetch = fetch;
|
|
10
|
+
}
|
|
11
|
+
/** Free-text and/or vector search of a List version. */
|
|
12
|
+
async searchList(account_name, list_name, version, options = {}) {
|
|
13
|
+
const path = `${this.path}/${encodeURIComponent(account_name)}/${encodeURIComponent(list_name)}/${version}`;
|
|
14
|
+
const response = await this.fetch.post(path, options);
|
|
15
|
+
return handleResponse(response, async () => (await response.json()));
|
|
16
|
+
}
|
|
17
|
+
/** Free-text and/or vector search across a Group of Lists at a specific membership version (use the Group's current_version, or an older version to search a frozen set of records). */
|
|
18
|
+
async searchGroup(account_name, group_name, version, options = {}) {
|
|
19
|
+
const path = `${this.path}/group/${encodeURIComponent(account_name)}/${encodeURIComponent(group_name)}/${version}`;
|
|
20
|
+
const response = await this.fetch.post(path, options);
|
|
21
|
+
return handleResponse(response, async () => (await response.json()));
|
|
22
|
+
}
|
|
23
|
+
/** Finds Search Results within a List that are vector-similar to a seed result. */
|
|
24
|
+
async related(account_name, list_name, search_result_name, options = {}) {
|
|
25
|
+
const path = `related/${encodeURIComponent(account_name)}/${encodeURIComponent(list_name)}/${encodeURIComponent(search_result_name)}`;
|
|
26
|
+
const response = await this.fetch.post(path, options);
|
|
27
|
+
return handleResponse(response, async () => (await response.json()));
|
|
28
|
+
}
|
|
29
|
+
/** Image-similarity search of a List using an absolute image URL. */
|
|
30
|
+
async searchListByImage(account_name, list_name, version, request) {
|
|
31
|
+
const path = `images/${encodeURIComponent(account_name)}/${encodeURIComponent(list_name)}/${version}`;
|
|
32
|
+
const response = await this.fetch.post(path, request);
|
|
33
|
+
return handleResponse(response, async () => (await response.json()));
|
|
34
|
+
}
|
|
35
|
+
/** Image-similarity search of a Group at a specific membership version using an absolute image URL. */
|
|
36
|
+
async searchGroupByImage(account_name, group_name, version, request) {
|
|
37
|
+
const path = `images/group/${encodeURIComponent(account_name)}/${encodeURIComponent(group_name)}/${version}`;
|
|
38
|
+
const response = await this.fetch.post(path, request);
|
|
39
|
+
return handleResponse(response, async () => (await response.json()));
|
|
40
|
+
}
|
|
41
|
+
/** Image-similarity search of a List using a base64-encoded image. */
|
|
42
|
+
async searchListByImageBase64(account_name, list_name, version, request) {
|
|
43
|
+
const path = `images/base64/${encodeURIComponent(account_name)}/${encodeURIComponent(list_name)}/${version}`;
|
|
44
|
+
const response = await this.fetch.post(path, request);
|
|
45
|
+
return handleResponse(response, async () => (await response.json()));
|
|
46
|
+
}
|
|
47
|
+
/** Image-similarity search of a Group at a specific membership version using a base64-encoded image. */
|
|
48
|
+
async searchGroupByImageBase64(account_name, group_name, version, request) {
|
|
49
|
+
const path = `images/base64/group/${encodeURIComponent(account_name)}/${encodeURIComponent(group_name)}/${version}`;
|
|
50
|
+
const response = await this.fetch.post(path, request);
|
|
51
|
+
return handleResponse(response, async () => (await response.json()));
|
|
52
|
+
}
|
|
53
|
+
/**
|
|
54
|
+
* Extracts text from PDF documents on a Search Result. Only available when the
|
|
55
|
+
* List's model declares a positive MaxDocumentPages limit.
|
|
56
|
+
*/
|
|
57
|
+
async extractDocumentText(account_name, list_name, search_result_name) {
|
|
58
|
+
const path = `document-text/${encodeURIComponent(account_name)}/${encodeURIComponent(list_name)}/${encodeURIComponent(search_result_name)}`;
|
|
59
|
+
const response = await this.fetch.get(path);
|
|
60
|
+
return handleResponse(response, async () => (await response.json()));
|
|
61
|
+
}
|
|
62
|
+
/** Records a click-through on a List search result, correlated by query_id. */
|
|
63
|
+
async recordListClick(account_name, list_name, request) {
|
|
64
|
+
const path = `analytics/click/list/${encodeURIComponent(account_name)}/${encodeURIComponent(list_name)}`;
|
|
65
|
+
const response = await this.fetch.post(path, request);
|
|
66
|
+
return handleResponse(response, () => undefined);
|
|
67
|
+
}
|
|
68
|
+
/** Records a click-through on a Group search result, correlated by query_id. */
|
|
69
|
+
async recordGroupClick(account_name, group_name, request) {
|
|
70
|
+
const path = `analytics/click/group/${encodeURIComponent(account_name)}/${encodeURIComponent(group_name)}`;
|
|
71
|
+
const response = await this.fetch.post(path, request);
|
|
72
|
+
return handleResponse(response, () => undefined);
|
|
73
|
+
}
|
|
74
|
+
}
|
|
75
|
+
//# sourceMappingURL=SearchService.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"SearchService.js","sourceRoot":"","sources":["../src/SearchService.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAMrD,iFAAiF;AACjF,6EAA6E;AAC7E,8EAA8E;AAC9E,MAAM,CAAC,OAAO,OAAO,aAAa;IAEH;IADZ,IAAI,GAAG,eAAe,CAAC;IACxC,YAA6B,KAAY;QAAZ,UAAK,GAAL,KAAK,CAAO;IAAG,CAAC;IAE7C,wDAAwD;IACxD,KAAK,CAAC,UAAU,CAAC,YAAoB,EAAE,SAAiB,EAAE,OAAe,EAAE,UAAyB,EAAE;QACpG,MAAM,IAAI,GAAG,GAAG,IAAI,CAAC,IAAI,IAAI,kBAAkB,CAAC,YAAY,CAAC,IAAI,kBAAkB,CAAC,SAAS,CAAC,IAAI,OAAO,EAAE,CAAC;QAC5G,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QACtD,OAAO,cAAc,CAAC,QAAQ,EAAE,KAAK,IAAI,EAAE,CAAC,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAmB,CAAC,CAAC;IACzF,CAAC;IAED,wLAAwL;IACxL,KAAK,CAAC,WAAW,CAAC,YAAoB,EAAE,UAAkB,EAAE,OAAe,EAAE,UAAyB,EAAE;QACtG,MAAM,IAAI,GAAG,GAAG,IAAI,CAAC,IAAI,UAAU,kBAAkB,CAAC,YAAY,CAAC,IAAI,kBAAkB,CAAC,UAAU,CAAC,IAAI,OAAO,EAAE,CAAC;QACnH,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QACtD,OAAO,cAAc,CAAC,QAAQ,EAAE,KAAK,IAAI,EAAE,CAAC,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAmB,CAAC,CAAC;IACzF,CAAC;IAED,mFAAmF;IACnF,KAAK,CAAC,OAAO,CAAC,YAAoB,EAAE,SAAiB,EAAE,kBAA0B,EAAE,UAA0B,EAAE;QAC7G,MAAM,IAAI,GAAG,WAAW,kBAAkB,CAAC,YAAY,CAAC,IAAI,kBAAkB,CAAC,SAAS,CAAC,IAAI,kBAAkB,CAAC,kBAAkB,CAAC,EAAE,CAAC;QACtI,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QACtD,OAAO,cAAc,CAAC,QAAQ,EAAE,KAAK,IAAI,EAAE,CAAC,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAmB,CAAC,CAAC;IACzF,CAAC;IAED,qEAAqE;IACrE,KAAK,CAAC,iBAAiB,CAAC,YAAoB,EAAE,SAAiB,EAAE,OAAe,EAAE,OAA6B;QAC7G,MAAM,IAAI,GAAG,UAAU,kBAAkB,CAAC,YAAY,CAAC,IAAI,kBAAkB,CAAC,SAAS,CAAC,IAAI,OAAO,EAAE,CAAC;QACtG,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QACtD,OAAO,cAAc,CAAC,QAAQ,EAAE,KAAK,IAAI,EAAE,CAAC,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAmB,CAAC,CAAC;IACzF,CAAC;IAED,uGAAuG;IACvG,KAAK,CAAC,kBAAkB,CAAC,YAAoB,EAAE,UAAkB,EAAE,OAAe,EAAE,OAA6B;QAC/G,MAAM,IAAI,GAAG,gBAAgB,kBAAkB,CAAC,YAAY,CAAC,IAAI,kBAAkB,CAAC,UAAU,CAAC,IAAI,OAAO,EAAE,CAAC;QAC7G,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QACtD,OAAO,cAAc,CAAC,QAAQ,EAAE,KAAK,IAAI,EAAE,CAAC,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAmB,CAAC,CAAC;IACzF,CAAC;IAED,sEAAsE;IACtE,KAAK,CAAC,uBAAuB,CAAC,YAAoB,EAAE,SAAiB,EAAE,OAAe,EAAE,OAAmC;QACzH,MAAM,IAAI,GAAG,iBAAiB,kBAAkB,CAAC,YAAY,CAAC,IAAI,kBAAkB,CAAC,SAAS,CAAC,IAAI,OAAO,EAAE,CAAC;QAC7G,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QACtD,OAAO,cAAc,CAAC,QAAQ,EAAE,KAAK,IAAI,EAAE,CAAC,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAmB,CAAC,CAAC;IACzF,CAAC;IAED,wGAAwG;IACxG,KAAK,CAAC,wBAAwB,CAAC,YAAoB,EAAE,UAAkB,EAAE,OAAe,EAAE,OAAmC;QAC3H,MAAM,IAAI,GAAG,uBAAuB,kBAAkB,CAAC,YAAY,CAAC,IAAI,kBAAkB,CAAC,UAAU,CAAC,IAAI,OAAO,EAAE,CAAC;QACpH,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QACtD,OAAO,cAAc,CAAC,QAAQ,EAAE,KAAK,IAAI,EAAE,CAAC,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAmB,CAAC,CAAC;IACzF,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,mBAAmB,CAAC,YAAoB,EAAE,SAAiB,EAAE,kBAA0B;QAC3F,MAAM,IAAI,GAAG,iBAAiB,kBAAkB,CAAC,YAAY,CAAC,IAAI,kBAAkB,CAAC,SAAS,CAAC,IAAI,kBAAkB,CAAC,kBAAkB,CAAC,EAAE,CAAC;QAC5I,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAC5C,OAAO,cAAc,CAAC,QAAQ,EAAE,KAAK,IAAI,EAAE,CAAC,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAgC,CAAC,CAAC;IACtG,CAAC;IAED,+EAA+E;IAC/E,KAAK,CAAC,eAAe,CAAC,YAAoB,EAAE,SAAiB,EAAE,OAA2B;QACxF,MAAM,IAAI,GAAG,wBAAwB,kBAAkB,CAAC,YAAY,CAAC,IAAI,kBAAkB,CAAC,SAAS,CAAC,EAAE,CAAC;QACzG,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QACtD,OAAO,cAAc,CAAC,QAAQ,EAAE,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;IACnD,CAAC;IAED,gFAAgF;IAChF,KAAK,CAAC,gBAAgB,CAAC,YAAoB,EAAE,UAAkB,EAAE,OAA2B;QAC1F,MAAM,IAAI,GAAG,yBAAyB,kBAAkB,CAAC,YAAY,CAAC,IAAI,kBAAkB,CAAC,UAAU,CAAC,EAAE,CAAC;QAC3G,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QACtD,OAAO,cAAc,CAAC,QAAQ,EAAE,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;IACnD,CAAC;CACF"}
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
import Fetch from "./Fetch.js";
|
|
2
|
+
import { Response, Problem, SearchableFieldResponse, CreateSearchableFieldRequest, RenameSearchableFieldRequest } from "./Types.js";
|
|
3
|
+
export default class SearchableFieldService {
|
|
4
|
+
private readonly fetch;
|
|
5
|
+
private readonly path;
|
|
6
|
+
constructor(fetch: Fetch);
|
|
7
|
+
/** Creates a Searchable field. */
|
|
8
|
+
create(request: CreateSearchableFieldRequest): Promise<Response<SearchableFieldResponse, Problem>>;
|
|
9
|
+
/** Renames a Searchable. Breaking change - automatically updates the List version. */
|
|
10
|
+
rename(account_name: string, list_name: string, searchable_name: string, request: RenameSearchableFieldRequest): Promise<Response<SearchableFieldResponse, Problem>>;
|
|
11
|
+
/** Removes a Searchable. Breaking change - automatically updates the List version. */
|
|
12
|
+
remove(account_name: string, list_name: string, searchable_name: string): Promise<Response<void, Problem>>;
|
|
13
|
+
}
|
|
14
|
+
//# sourceMappingURL=SearchableFieldService.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"SearchableFieldService.d.ts","sourceRoot":"","sources":["../src/SearchableFieldService.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,YAAY,CAAC;AAE/B,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,uBAAuB,EAAE,4BAA4B,EAAE,4BAA4B,EAAE,MAAM,YAAY,CAAC;AAEpI,MAAM,CAAC,OAAO,OAAO,sBAAsB;IAE7B,OAAO,CAAC,QAAQ,CAAC,KAAK;IADlC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAgB;gBACR,KAAK,EAAE,KAAK;IAEzC,kCAAkC;IAC5B,MAAM,CAAC,OAAO,EAAE,4BAA4B,GAAG,OAAO,CAAC,QAAQ,CAAC,uBAAuB,EAAE,OAAO,CAAC,CAAC;IAKxG,sFAAsF;IAChF,MAAM,CAAC,YAAY,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,eAAe,EAAE,MAAM,EAAE,OAAO,EAAE,4BAA4B,GAAG,OAAO,CAAC,QAAQ,CAAC,uBAAuB,EAAE,OAAO,CAAC,CAAC;IAM1K,sFAAsF;IAChF,MAAM,CAAC,YAAY,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,eAAe,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;CAKjH"}
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
import { handleResponse } from "./handleResponse.js";
|
|
2
|
+
export default class SearchableFieldService {
|
|
3
|
+
fetch;
|
|
4
|
+
path = `searchable`;
|
|
5
|
+
constructor(fetch) {
|
|
6
|
+
this.fetch = fetch;
|
|
7
|
+
}
|
|
8
|
+
/** Creates a Searchable field. */
|
|
9
|
+
async create(request) {
|
|
10
|
+
const response = await this.fetch.post(this.path, request);
|
|
11
|
+
return handleResponse(response, async () => (await response.json()));
|
|
12
|
+
}
|
|
13
|
+
/** Renames a Searchable. Breaking change - automatically updates the List version. */
|
|
14
|
+
async rename(account_name, list_name, searchable_name, request) {
|
|
15
|
+
const path = `${this.path}/${encodeURIComponent(account_name)}/${encodeURIComponent(list_name)}/${encodeURIComponent(searchable_name)}`;
|
|
16
|
+
const response = await this.fetch.put(path, request);
|
|
17
|
+
return handleResponse(response, async () => (await response.json()));
|
|
18
|
+
}
|
|
19
|
+
/** Removes a Searchable. Breaking change - automatically updates the List version. */
|
|
20
|
+
async remove(account_name, list_name, searchable_name) {
|
|
21
|
+
const path = `${this.path}/${encodeURIComponent(account_name)}/${encodeURIComponent(list_name)}/${encodeURIComponent(searchable_name)}`;
|
|
22
|
+
const response = await this.fetch.delete(path);
|
|
23
|
+
return handleResponse(response, () => undefined);
|
|
24
|
+
}
|
|
25
|
+
}
|
|
26
|
+
//# sourceMappingURL=SearchableFieldService.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"SearchableFieldService.js","sourceRoot":"","sources":["../src/SearchableFieldService.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAGrD,MAAM,CAAC,OAAO,OAAO,sBAAsB;IAEZ;IADZ,IAAI,GAAG,YAAY,CAAC;IACrC,YAA6B,KAAY;QAAZ,UAAK,GAAL,KAAK,CAAO;IAAG,CAAC;IAE7C,kCAAkC;IAClC,KAAK,CAAC,MAAM,CAAC,OAAqC;QAChD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QAC3D,OAAO,cAAc,CAAC,QAAQ,EAAE,KAAK,IAAI,EAAE,CAAC,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAA4B,CAAC,CAAC;IAClG,CAAC;IAED,sFAAsF;IACtF,KAAK,CAAC,MAAM,CAAC,YAAoB,EAAE,SAAiB,EAAE,eAAuB,EAAE,OAAqC;QAClH,MAAM,IAAI,GAAG,GAAG,IAAI,CAAC,IAAI,IAAI,kBAAkB,CAAC,YAAY,CAAC,IAAI,kBAAkB,CAAC,SAAS,CAAC,IAAI,kBAAkB,CAAC,eAAe,CAAC,EAAE,CAAC;QACxI,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QACrD,OAAO,cAAc,CAAC,QAAQ,EAAE,KAAK,IAAI,EAAE,CAAC,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAA4B,CAAC,CAAC;IAClG,CAAC;IAED,sFAAsF;IACtF,KAAK,CAAC,MAAM,CAAC,YAAoB,EAAE,SAAiB,EAAE,eAAuB;QAC3E,MAAM,IAAI,GAAG,GAAG,IAAI,CAAC,IAAI,IAAI,kBAAkB,CAAC,YAAY,CAAC,IAAI,kBAAkB,CAAC,SAAS,CAAC,IAAI,kBAAkB,CAAC,eAAe,CAAC,EAAE,CAAC;QACxI,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAC/C,OAAO,cAAc,CAAC,QAAQ,EAAE,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;IACnD,CAAC;CACF"}
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import Fetch from "./Fetch.js";
|
|
2
|
+
import { Response, Problem, Suggestion, SuggestOptions } from "./Types.js";
|
|
3
|
+
export default class SuggestService {
|
|
4
|
+
private readonly fetch;
|
|
5
|
+
private readonly path;
|
|
6
|
+
constructor(fetch: Fetch);
|
|
7
|
+
/** Typeahead suggestions within a List version. */
|
|
8
|
+
list(account_name: string, list_name: string, version: number, query: string, options?: SuggestOptions): Promise<Response<Suggestion[], Problem>>;
|
|
9
|
+
/** Typeahead suggestions within a Group of Lists at a specific membership version (use the Group's current_version, or an older version to search a frozen set of records). */
|
|
10
|
+
group(account_name: string, group_name: string, version: number, query: string, options?: SuggestOptions): Promise<Response<Suggestion[], Problem>>;
|
|
11
|
+
}
|
|
12
|
+
//# sourceMappingURL=SuggestService.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"SuggestService.d.ts","sourceRoot":"","sources":["../src/SuggestService.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,YAAY,CAAC;AAE/B,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,UAAU,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAI3E,MAAM,CAAC,OAAO,OAAO,cAAc;IAErB,OAAO,CAAC,QAAQ,CAAC,KAAK;IADlC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAa;gBACL,KAAK,EAAE,KAAK;IAEzC,mDAAmD;IAC7C,IAAI,CAAC,YAAY,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,GAAE,cAAmB,GAAG,OAAO,CAAC,QAAQ,CAAC,UAAU,EAAE,EAAE,OAAO,CAAC,CAAC;IAM3J,+KAA+K;IACzK,KAAK,CAAC,YAAY,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,GAAE,cAAmB,GAAG,OAAO,CAAC,QAAQ,CAAC,UAAU,EAAE,EAAE,OAAO,CAAC,CAAC;CAK9J"}
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
import { handleResponse } from "./handleResponse.js";
|
|
2
|
+
// Typeahead suggestions. Uses the POST variants so options are passed as a typed
|
|
3
|
+
// body. The query text is part of the route, so it is encoded into the path.
|
|
4
|
+
export default class SuggestService {
|
|
5
|
+
fetch;
|
|
6
|
+
path = `suggest`;
|
|
7
|
+
constructor(fetch) {
|
|
8
|
+
this.fetch = fetch;
|
|
9
|
+
}
|
|
10
|
+
/** Typeahead suggestions within a List version. */
|
|
11
|
+
async list(account_name, list_name, version, query, options = {}) {
|
|
12
|
+
const path = `${this.path}/${encodeURIComponent(account_name)}/${encodeURIComponent(list_name)}/${version}/${encodeURIComponent(query)}`;
|
|
13
|
+
const response = await this.fetch.post(path, options);
|
|
14
|
+
return handleResponse(response, async () => (await response.json()));
|
|
15
|
+
}
|
|
16
|
+
/** Typeahead suggestions within a Group of Lists at a specific membership version (use the Group's current_version, or an older version to search a frozen set of records). */
|
|
17
|
+
async group(account_name, group_name, version, query, options = {}) {
|
|
18
|
+
const path = `${this.path}/group/${encodeURIComponent(account_name)}/${encodeURIComponent(group_name)}/${version}/${encodeURIComponent(query)}`;
|
|
19
|
+
const response = await this.fetch.post(path, options);
|
|
20
|
+
return handleResponse(response, async () => (await response.json()));
|
|
21
|
+
}
|
|
22
|
+
}
|
|
23
|
+
//# sourceMappingURL=SuggestService.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"SuggestService.js","sourceRoot":"","sources":["../src/SuggestService.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAGrD,iFAAiF;AACjF,6EAA6E;AAC7E,MAAM,CAAC,OAAO,OAAO,cAAc;IAEJ;IADZ,IAAI,GAAG,SAAS,CAAC;IAClC,YAA6B,KAAY;QAAZ,UAAK,GAAL,KAAK,CAAO;IAAG,CAAC;IAE7C,mDAAmD;IACnD,KAAK,CAAC,IAAI,CAAC,YAAoB,EAAE,SAAiB,EAAE,OAAe,EAAE,KAAa,EAAE,UAA0B,EAAE;QAC9G,MAAM,IAAI,GAAG,GAAG,IAAI,CAAC,IAAI,IAAI,kBAAkB,CAAC,YAAY,CAAC,IAAI,kBAAkB,CAAC,SAAS,CAAC,IAAI,OAAO,IAAI,kBAAkB,CAAC,KAAK,CAAC,EAAE,CAAC;QACzI,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QACtD,OAAO,cAAc,CAAC,QAAQ,EAAE,KAAK,IAAI,EAAE,CAAC,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAiB,CAAC,CAAC;IACvF,CAAC;IAED,+KAA+K;IAC/K,KAAK,CAAC,KAAK,CAAC,YAAoB,EAAE,UAAkB,EAAE,OAAe,EAAE,KAAa,EAAE,UAA0B,EAAE;QAChH,MAAM,IAAI,GAAG,GAAG,IAAI,CAAC,IAAI,UAAU,kBAAkB,CAAC,YAAY,CAAC,IAAI,kBAAkB,CAAC,UAAU,CAAC,IAAI,OAAO,IAAI,kBAAkB,CAAC,KAAK,CAAC,EAAE,CAAC;QAChJ,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QACtD,OAAO,cAAc,CAAC,QAAQ,EAAE,KAAK,IAAI,EAAE,CAAC,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAiB,CAAC,CAAC;IACvF,CAAC;CACF"}
|