@distilled.cloud/typesense 1.0.0-rc.1 → 1.0.0-rc.11
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 +201 -0
- package/lib/credentials.js +2 -2
- package/lib/errors.js +2 -2
- package/lib/errors.js.map +1 -1
- package/lib/services/typesense.d.ts +983 -971
- package/lib/services/typesense.d.ts.map +1 -1
- package/lib/services/typesense.js +823 -826
- package/lib/services/typesense.js.map +1 -1
- package/package.json +28 -12
- package/src/credentials.ts +2 -2
- package/src/errors.ts +2 -2
- package/src/services/typesense.ts +2902 -2917
|
@@ -1,26 +1,27 @@
|
|
|
1
1
|
// AUTO-GENERATED by scripts/generate.ts from .generated-specs. Do not edit.
|
|
2
2
|
import * as S from "@distilled.cloud/core/schema";
|
|
3
3
|
import * as API from "@distilled.cloud/core/api";
|
|
4
|
+
import * as C from "@distilled.cloud/core/category";
|
|
4
5
|
import * as T from "../traits.js";
|
|
5
6
|
import { TypesenseProtocol, } from "../protocol.js";
|
|
6
7
|
import * as Retry from "../retry.js";
|
|
7
8
|
export class BadRequest extends /*@__PURE__*/ /*@__PURE__*/ T.applyErrorMatchers(
|
|
8
|
-
/*@__PURE__*/ S.
|
|
9
|
+
/*@__PURE__*/ S.TaggedError()("BadRequest", {
|
|
9
10
|
code: S.Number,
|
|
10
11
|
message: S.String,
|
|
11
|
-
}), [{ status: 400 }]) {
|
|
12
|
+
}).pipe(C.withBadRequestError), [{ status: 400 }]) {
|
|
12
13
|
}
|
|
13
14
|
export class Conflict extends /*@__PURE__*/ /*@__PURE__*/ T.applyErrorMatchers(
|
|
14
|
-
/*@__PURE__*/ S.
|
|
15
|
+
/*@__PURE__*/ S.TaggedError()("Conflict", {
|
|
15
16
|
code: S.Number,
|
|
16
17
|
message: S.String,
|
|
17
|
-
}), [{ status: 409 }]) {
|
|
18
|
+
}).pipe(C.withConflictError), [{ status: 409 }]) {
|
|
18
19
|
}
|
|
19
20
|
export class NotFound extends /*@__PURE__*/ /*@__PURE__*/ T.applyErrorMatchers(
|
|
20
|
-
/*@__PURE__*/ S.
|
|
21
|
+
/*@__PURE__*/ S.TaggedError()("NotFound", {
|
|
21
22
|
code: S.Number,
|
|
22
23
|
message: S.String,
|
|
23
|
-
}), [{ status: 404 }]) {
|
|
24
|
+
}).pipe(C.withBadRequestError), [{ status: 404 }]) {
|
|
24
25
|
}
|
|
25
26
|
export const ClearCacheRequest = /*@__PURE__*/ S.suspend(() => S.Struct({}).pipe(T.Http({ method: "POST", uri: "/operations/cache/clear", code: 200 }))).annotate({
|
|
26
27
|
identifier: "ClearCacheRequest",
|
|
@@ -53,7 +54,7 @@ export const AnalyticsEventCreateResponse = /*@__PURE__*/ S.suspend(() => S.Stru
|
|
|
53
54
|
})).annotate({
|
|
54
55
|
identifier: "AnalyticsEventCreateResponse",
|
|
55
56
|
});
|
|
56
|
-
export const AnalyticsRuleType =
|
|
57
|
+
export const AnalyticsRuleType = S.String;
|
|
57
58
|
export const AnalyticsRuleCreateParamsMetaFieldsList = /*@__PURE__*/ S.Array(S.String);
|
|
58
59
|
export const AnalyticsRuleCreateParams = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
59
60
|
destination_collection: S.optional(S.String),
|
|
@@ -577,540 +578,8 @@ export const CollectionAliasesResponse = /*@__PURE__*/ S.suspend(() => S.Struct(
|
|
|
577
578
|
})).annotate({
|
|
578
579
|
identifier: "CollectionAliasesResponse",
|
|
579
580
|
});
|
|
580
|
-
export const
|
|
581
|
-
|
|
582
|
-
name: S.String.pipe(T.Query()),
|
|
583
|
-
n: S.Number.pipe(T.Query()),
|
|
584
|
-
}).pipe(T.Http({ method: "GET", uri: "/analytics/events", code: 200 }))).annotate({
|
|
585
|
-
identifier: "GetAnalyticsEventsRequest",
|
|
586
|
-
});
|
|
587
|
-
export const AnalyticsEventsResponseEventsItemDocIdsList =
|
|
588
|
-
/*@__PURE__*/ S.Array(S.String);
|
|
589
|
-
export const AnalyticsEventsResponseEventsItem = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
590
|
-
name: S.optional(S.String),
|
|
591
|
-
event_type: S.optional(S.String),
|
|
592
|
-
collection: S.optional(S.String),
|
|
593
|
-
timestamp: S.optional(S.Number),
|
|
594
|
-
user_id: S.optional(S.String),
|
|
595
|
-
doc_id: S.optional(S.String),
|
|
596
|
-
doc_ids: S.optional(AnalyticsEventsResponseEventsItemDocIdsList),
|
|
597
|
-
query: S.optional(S.String),
|
|
598
|
-
})).annotate({
|
|
599
|
-
identifier: "AnalyticsEventsResponseEventsItem",
|
|
600
|
-
});
|
|
601
|
-
export const AnalyticsEventsResponseEventsList = /*@__PURE__*/ S.Array(AnalyticsEventsResponseEventsItem);
|
|
602
|
-
export const AnalyticsEventsResponse = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
603
|
-
events: AnalyticsEventsResponseEventsList,
|
|
604
|
-
})).annotate({
|
|
605
|
-
identifier: "AnalyticsEventsResponse",
|
|
606
|
-
});
|
|
607
|
-
export const GetAnalyticsStatusRequest = /*@__PURE__*/ S.suspend(() => S.Struct({}).pipe(T.Http({ method: "GET", uri: "/analytics/status", code: 200 }))).annotate({
|
|
608
|
-
identifier: "GetAnalyticsStatusRequest",
|
|
609
|
-
});
|
|
610
|
-
export const AnalyticsStatus = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
611
|
-
popular_prefix_queries: S.optional(S.Number),
|
|
612
|
-
nohits_prefix_queries: S.optional(S.Number),
|
|
613
|
-
log_prefix_queries: S.optional(S.Number),
|
|
614
|
-
query_log_events: S.optional(S.Number),
|
|
615
|
-
query_counter_events: S.optional(S.Number),
|
|
616
|
-
doc_log_events: S.optional(S.Number),
|
|
617
|
-
doc_counter_events: S.optional(S.Number),
|
|
618
|
-
})).annotate({
|
|
619
|
-
identifier: "AnalyticsStatus",
|
|
620
|
-
});
|
|
621
|
-
export const GetCollectionRequest = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
622
|
-
collectionName: S.String.pipe(T.Label()),
|
|
623
|
-
}).pipe(T.Http({ method: "GET", uri: "/collections/{collectionName}", code: 200 }))).annotate({
|
|
624
|
-
identifier: "GetCollectionRequest",
|
|
625
|
-
});
|
|
626
|
-
export const GetCollectionResponseFieldsList = /*@__PURE__*/ S.Array(Field);
|
|
627
|
-
export const GetCollectionResponseTokenSeparatorsList = /*@__PURE__*/ S.Array(S.String);
|
|
628
|
-
export const GetCollectionResponseSynonymSetsList = /*@__PURE__*/ S.Array(S.String);
|
|
629
|
-
export const GetCollectionResponseSymbolsToIndexList = /*@__PURE__*/ S.Array(S.String);
|
|
630
|
-
export const GetCollectionResponse = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
631
|
-
name: S.String,
|
|
632
|
-
fields: GetCollectionResponseFieldsList,
|
|
633
|
-
default_sorting_field: S.optional(S.String),
|
|
634
|
-
token_separators: S.optional(GetCollectionResponseTokenSeparatorsList),
|
|
635
|
-
synonym_sets: S.optional(GetCollectionResponseSynonymSetsList),
|
|
636
|
-
enable_nested_fields: S.optional(S.Boolean),
|
|
637
|
-
symbols_to_index: S.optional(GetCollectionResponseSymbolsToIndexList),
|
|
638
|
-
voice_query_model: S.optional(VoiceQueryModelCollectionConfig),
|
|
639
|
-
metadata: S.optional(S.Unknown),
|
|
640
|
-
num_documents: S.Number,
|
|
641
|
-
created_at: S.Number,
|
|
642
|
-
})).annotate({
|
|
643
|
-
identifier: "GetCollectionResponse",
|
|
644
|
-
});
|
|
645
|
-
export const GetCollectionsRequestGetCollectionsParameters =
|
|
646
|
-
/*@__PURE__*/ S.suspend(() => S.Struct({
|
|
647
|
-
exclude_fields: S.optional(S.String),
|
|
648
|
-
limit: S.optional(S.Number),
|
|
649
|
-
offset: S.optional(S.Number),
|
|
650
|
-
})).annotate({
|
|
651
|
-
identifier: "GetCollectionsRequestGetCollectionsParameters",
|
|
652
|
-
});
|
|
653
|
-
export const GetCollectionsRequest = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
654
|
-
getCollectionsParameters: S.optional(GetCollectionsRequestGetCollectionsParameters.pipe(T.Query())),
|
|
655
|
-
}).pipe(T.Http({ method: "GET", uri: "/collections", code: 200 }))).annotate({
|
|
656
|
-
identifier: "GetCollectionsRequest",
|
|
657
|
-
});
|
|
658
|
-
export const CollectionResponseFieldsList = /*@__PURE__*/ S.Array(Field);
|
|
659
|
-
export const CollectionResponseTokenSeparatorsList = /*@__PURE__*/ S.Array(S.String);
|
|
660
|
-
export const CollectionResponseSynonymSetsList = /*@__PURE__*/ S.Array(S.String);
|
|
661
|
-
export const CollectionResponseSymbolsToIndexList = /*@__PURE__*/ S.Array(S.String);
|
|
662
|
-
export const CollectionResponse = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
663
|
-
name: S.String,
|
|
664
|
-
fields: CollectionResponseFieldsList,
|
|
665
|
-
default_sorting_field: S.optional(S.String),
|
|
666
|
-
token_separators: S.optional(CollectionResponseTokenSeparatorsList),
|
|
667
|
-
synonym_sets: S.optional(CollectionResponseSynonymSetsList),
|
|
668
|
-
enable_nested_fields: S.optional(S.Boolean),
|
|
669
|
-
symbols_to_index: S.optional(CollectionResponseSymbolsToIndexList),
|
|
670
|
-
voice_query_model: S.optional(VoiceQueryModelCollectionConfig),
|
|
671
|
-
metadata: S.optional(S.Unknown),
|
|
672
|
-
num_documents: S.Number,
|
|
673
|
-
created_at: S.Number,
|
|
674
|
-
})).annotate({
|
|
675
|
-
identifier: "CollectionResponse",
|
|
676
|
-
});
|
|
677
|
-
export const GetCollectionsResponseBodyList = /*@__PURE__*/ S.Array(CollectionResponse);
|
|
678
|
-
export const GetCollectionsResponse = /*@__PURE__*/ S.suspend(() => GetCollectionsResponseBodyList.pipe(T.RawResponseRoot())).annotate({
|
|
679
|
-
identifier: "GetCollectionsResponse",
|
|
680
|
-
});
|
|
681
|
-
export const GetDocumentRequest = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
682
|
-
collectionName: S.String.pipe(T.Label()),
|
|
683
|
-
documentId: S.String.pipe(T.Label()),
|
|
684
|
-
}).pipe(T.Http({
|
|
685
|
-
method: "GET",
|
|
686
|
-
uri: "/collections/{collectionName}/documents/{documentId}",
|
|
687
|
-
code: 200,
|
|
688
|
-
}))).annotate({
|
|
689
|
-
identifier: "GetDocumentRequest",
|
|
690
|
-
});
|
|
691
|
-
export const GetDocumentResponse = /*@__PURE__*/ S.suspend(() => S.Unknown.pipe(T.RawResponseRoot())).annotate({
|
|
692
|
-
identifier: "GetDocumentResponse",
|
|
693
|
-
});
|
|
694
|
-
export const GetKeyRequest = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
695
|
-
keyId: S.Number.pipe(T.Label()),
|
|
696
|
-
}).pipe(T.Http({ method: "GET", uri: "/keys/{keyId}", code: 200 }))).annotate({ identifier: "GetKeyRequest" });
|
|
697
|
-
export const GetKeyResponseActionsList = /*@__PURE__*/ S.Array(S.String);
|
|
698
|
-
export const GetKeyResponseCollectionsList = /*@__PURE__*/ S.Array(S.String);
|
|
699
|
-
export const GetKeyResponse = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
700
|
-
value: S.optional(S.String),
|
|
701
|
-
description: S.String,
|
|
702
|
-
actions: GetKeyResponseActionsList,
|
|
703
|
-
collections: GetKeyResponseCollectionsList,
|
|
704
|
-
expires_at: S.optional(S.Number),
|
|
705
|
-
id: S.optional(S.Number),
|
|
706
|
-
value_prefix: S.optional(S.String),
|
|
707
|
-
})).annotate({ identifier: "GetKeyResponse" });
|
|
708
|
-
export const GetKeysRequest = /*@__PURE__*/ S.suspend(() => S.Struct({}).pipe(T.Http({ method: "GET", uri: "/keys", code: 200 }))).annotate({ identifier: "GetKeysRequest" });
|
|
709
|
-
export const ApiKeyActionsList = /*@__PURE__*/ S.Array(S.String);
|
|
710
|
-
export const ApiKeyCollectionsList = /*@__PURE__*/ S.Array(S.String);
|
|
711
|
-
export const ApiKey = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
712
|
-
value: S.optional(S.String),
|
|
713
|
-
description: S.String,
|
|
714
|
-
actions: ApiKeyActionsList,
|
|
715
|
-
collections: ApiKeyCollectionsList,
|
|
716
|
-
expires_at: S.optional(S.Number),
|
|
717
|
-
id: S.optional(S.Number),
|
|
718
|
-
value_prefix: S.optional(S.String),
|
|
719
|
-
})).annotate({ identifier: "ApiKey" });
|
|
720
|
-
export const ApiKeysResponseKeysList = /*@__PURE__*/ S.Array(ApiKey);
|
|
721
|
-
export const ApiKeysResponse = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
722
|
-
keys: ApiKeysResponseKeysList,
|
|
723
|
-
})).annotate({
|
|
724
|
-
identifier: "ApiKeysResponse",
|
|
725
|
-
});
|
|
726
|
-
export const GetSchemaChangesRequest = /*@__PURE__*/ S.suspend(() => S.Struct({}).pipe(T.Http({ method: "GET", uri: "/operations/schema_changes", code: 200 }))).annotate({
|
|
727
|
-
identifier: "GetSchemaChangesRequest",
|
|
728
|
-
});
|
|
729
|
-
export const SchemaChangeStatus = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
730
|
-
collection: S.optional(S.String),
|
|
731
|
-
validated_docs: S.optional(S.Number),
|
|
732
|
-
altered_docs: S.optional(S.Number),
|
|
733
|
-
})).annotate({
|
|
734
|
-
identifier: "SchemaChangeStatus",
|
|
735
|
-
});
|
|
736
|
-
export const GetSchemaChangesResponseBodyList = /*@__PURE__*/ S.Array(SchemaChangeStatus);
|
|
737
|
-
export const GetSchemaChangesResponse = /*@__PURE__*/ S.suspend(() => GetSchemaChangesResponseBodyList.pipe(T.RawResponseRoot())).annotate({
|
|
738
|
-
identifier: "GetSchemaChangesResponse",
|
|
739
|
-
});
|
|
740
|
-
export const GetStemmingDictionaryRequest = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
741
|
-
dictionaryId: S.String.pipe(T.Label()),
|
|
742
|
-
}).pipe(T.Http({
|
|
743
|
-
method: "GET",
|
|
744
|
-
uri: "/stemming/dictionaries/{dictionaryId}",
|
|
745
|
-
code: 200,
|
|
746
|
-
}))).annotate({
|
|
747
|
-
identifier: "GetStemmingDictionaryRequest",
|
|
748
|
-
});
|
|
749
|
-
export const StemmingDictionaryWordsItem = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
750
|
-
word: S.String,
|
|
751
|
-
root: S.String,
|
|
752
|
-
})).annotate({
|
|
753
|
-
identifier: "StemmingDictionaryWordsItem",
|
|
754
|
-
});
|
|
755
|
-
export const StemmingDictionaryWordsList = /*@__PURE__*/ S.Array(StemmingDictionaryWordsItem);
|
|
756
|
-
export const StemmingDictionary = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
757
|
-
id: S.String,
|
|
758
|
-
words: StemmingDictionaryWordsList,
|
|
759
|
-
})).annotate({
|
|
760
|
-
identifier: "StemmingDictionary",
|
|
761
|
-
});
|
|
762
|
-
export const HealthRequest = /*@__PURE__*/ S.suspend(() => S.Struct({}).pipe(T.Http({ method: "GET", uri: "/health", code: 200 }))).annotate({ identifier: "HealthRequest" });
|
|
763
|
-
export const HealthStatus = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
764
|
-
ok: S.Boolean,
|
|
765
|
-
})).annotate({ identifier: "HealthStatus" });
|
|
766
|
-
export const IndexAction = /*@__PURE__*/ S.String;
|
|
767
|
-
export const DirtyValues = /*@__PURE__*/ S.String;
|
|
768
|
-
export const ImportDocumentsRequestImportDocumentsParameters =
|
|
769
|
-
/*@__PURE__*/ S.suspend(() => S.Struct({
|
|
770
|
-
batch_size: S.optional(S.Number),
|
|
771
|
-
return_id: S.optional(S.Boolean),
|
|
772
|
-
remote_embedding_batch_size: S.optional(S.Number),
|
|
773
|
-
return_doc: S.optional(S.Boolean),
|
|
774
|
-
action: S.optional(IndexAction),
|
|
775
|
-
dirty_values: S.optional(DirtyValues),
|
|
776
|
-
})).annotate({
|
|
777
|
-
identifier: "ImportDocumentsRequestImportDocumentsParameters",
|
|
778
|
-
});
|
|
779
|
-
export const ImportDocumentsRequest = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
780
|
-
collectionName: S.String.pipe(T.Label()),
|
|
781
|
-
importDocumentsParameters: S.optional(ImportDocumentsRequestImportDocumentsParameters.pipe(T.Query())),
|
|
782
|
-
}).pipe(T.Http({
|
|
783
|
-
method: "POST",
|
|
784
|
-
uri: "/collections/{collectionName}/documents/import",
|
|
785
|
-
code: 200,
|
|
786
|
-
}))).annotate({
|
|
787
|
-
identifier: "ImportDocumentsRequest",
|
|
788
|
-
});
|
|
789
|
-
export const ImportDocumentsResponse = /*@__PURE__*/ S.suspend(() => S.Struct({})).annotate({
|
|
790
|
-
identifier: "ImportDocumentsResponse",
|
|
791
|
-
});
|
|
792
|
-
export const ImportStemmingDictionaryRequest = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
793
|
-
id: S.String.pipe(T.Query()),
|
|
794
|
-
body: S.String.pipe(T.HttpBody()),
|
|
795
|
-
}).pipe(T.Http({ method: "POST", uri: "/stemming/dictionaries/import", code: 200 }))).annotate({
|
|
796
|
-
identifier: "ImportStemmingDictionaryRequest",
|
|
797
|
-
});
|
|
798
|
-
export const ImportStemmingDictionaryResponse = /*@__PURE__*/ S.suspend(() => S.Struct({})).annotate({
|
|
799
|
-
identifier: "ImportStemmingDictionaryResponse",
|
|
800
|
-
});
|
|
801
|
-
export const IndexDocumentRequest = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
802
|
-
collectionName: S.String.pipe(T.Label()),
|
|
803
|
-
action: S.optional(IndexAction.pipe(T.Query())),
|
|
804
|
-
dirty_values: S.optional(DirtyValues.pipe(T.Query())),
|
|
805
|
-
}).pipe(T.Http({
|
|
806
|
-
method: "POST",
|
|
807
|
-
uri: "/collections/{collectionName}/documents",
|
|
808
|
-
code: 200,
|
|
809
|
-
}))).annotate({
|
|
810
|
-
identifier: "IndexDocumentRequest",
|
|
811
|
-
});
|
|
812
|
-
export const IndexDocumentResponse = /*@__PURE__*/ S.suspend(() => S.Unknown.pipe(T.RawResponseRoot())).annotate({
|
|
813
|
-
identifier: "IndexDocumentResponse",
|
|
814
|
-
});
|
|
815
|
-
export const ListStemmingDictionariesRequest = /*@__PURE__*/ S.suspend(() => S.Struct({}).pipe(T.Http({ method: "GET", uri: "/stemming/dictionaries", code: 200 }))).annotate({
|
|
816
|
-
identifier: "ListStemmingDictionariesRequest",
|
|
817
|
-
});
|
|
818
|
-
export const ListStemmingDictionariesResponseDictionariesList =
|
|
819
|
-
/*@__PURE__*/ S.Array(S.String);
|
|
820
|
-
export const ListStemmingDictionariesResponse = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
821
|
-
dictionaries: S.optional(ListStemmingDictionariesResponseDictionariesList),
|
|
822
|
-
})).annotate({
|
|
823
|
-
identifier: "ListStemmingDictionariesResponse",
|
|
824
|
-
});
|
|
825
|
-
export const DropTokensMode = /*@__PURE__*/ S.String;
|
|
826
|
-
export const MultiSearchParameters = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
827
|
-
q: S.optional(S.String),
|
|
828
|
-
query_by: S.optional(S.String),
|
|
829
|
-
query_by_weights: S.optional(S.String),
|
|
830
|
-
text_match_type: S.optional(S.String),
|
|
831
|
-
prefix: S.optional(S.String),
|
|
832
|
-
infix: S.optional(S.String),
|
|
833
|
-
max_extra_prefix: S.optional(S.Number),
|
|
834
|
-
max_extra_suffix: S.optional(S.Number),
|
|
835
|
-
filter_by: S.optional(S.String),
|
|
836
|
-
sort_by: S.optional(S.String),
|
|
837
|
-
facet_by: S.optional(S.String),
|
|
838
|
-
max_facet_values: S.optional(S.Number),
|
|
839
|
-
facet_query: S.optional(S.String),
|
|
840
|
-
num_typos: S.optional(S.String),
|
|
841
|
-
page: S.optional(S.Number),
|
|
842
|
-
per_page: S.optional(S.Number),
|
|
843
|
-
limit: S.optional(S.Number),
|
|
844
|
-
offset: S.optional(S.Number),
|
|
845
|
-
group_by: S.optional(S.String),
|
|
846
|
-
group_limit: S.optional(S.Number),
|
|
847
|
-
group_missing_values: S.optional(S.Boolean),
|
|
848
|
-
include_fields: S.optional(S.String),
|
|
849
|
-
exclude_fields: S.optional(S.String),
|
|
850
|
-
highlight_full_fields: S.optional(S.String),
|
|
851
|
-
highlight_affix_num_tokens: S.optional(S.Number),
|
|
852
|
-
highlight_start_tag: S.optional(S.String),
|
|
853
|
-
highlight_end_tag: S.optional(S.String),
|
|
854
|
-
snippet_threshold: S.optional(S.Number),
|
|
855
|
-
drop_tokens_threshold: S.optional(S.Number),
|
|
856
|
-
drop_tokens_mode: S.optional(DropTokensMode),
|
|
857
|
-
typo_tokens_threshold: S.optional(S.Number),
|
|
858
|
-
enable_typos_for_alpha_numerical_tokens: S.optional(S.Boolean),
|
|
859
|
-
filter_curated_hits: S.optional(S.Boolean),
|
|
860
|
-
enable_synonyms: S.optional(S.Boolean),
|
|
861
|
-
enable_analytics: S.optional(S.Boolean),
|
|
862
|
-
synonym_prefix: S.optional(S.Boolean),
|
|
863
|
-
synonym_num_typos: S.optional(S.Number),
|
|
864
|
-
pinned_hits: S.optional(S.String),
|
|
865
|
-
hidden_hits: S.optional(S.String),
|
|
866
|
-
curation_tags: S.optional(S.String),
|
|
867
|
-
highlight_fields: S.optional(S.String),
|
|
868
|
-
pre_segmented_query: S.optional(S.Boolean),
|
|
869
|
-
preset: S.optional(S.String),
|
|
870
|
-
enable_curations: S.optional(S.Boolean),
|
|
871
|
-
prioritize_exact_match: S.optional(S.Boolean),
|
|
872
|
-
prioritize_token_position: S.optional(S.Boolean),
|
|
873
|
-
prioritize_num_matching_fields: S.optional(S.Boolean),
|
|
874
|
-
enable_typos_for_numerical_tokens: S.optional(S.Boolean),
|
|
875
|
-
exhaustive_search: S.optional(S.Boolean),
|
|
876
|
-
search_cutoff_ms: S.optional(S.Number),
|
|
877
|
-
use_cache: S.optional(S.Boolean),
|
|
878
|
-
cache_ttl: S.optional(S.Number),
|
|
879
|
-
min_len_1typo: S.optional(S.Number),
|
|
880
|
-
min_len_2typo: S.optional(S.Number),
|
|
881
|
-
vector_query: S.optional(S.String),
|
|
882
|
-
remote_embedding_timeout_ms: S.optional(S.Number),
|
|
883
|
-
remote_embedding_num_tries: S.optional(S.Number),
|
|
884
|
-
facet_strategy: S.optional(S.String),
|
|
885
|
-
stopwords: S.optional(S.String),
|
|
886
|
-
facet_return_parent: S.optional(S.String),
|
|
887
|
-
voice_query: S.optional(S.String),
|
|
888
|
-
conversation: S.optional(S.Boolean),
|
|
889
|
-
conversation_model_id: S.optional(S.String),
|
|
890
|
-
conversation_id: S.optional(S.String),
|
|
891
|
-
validate_field_names: S.optional(S.Boolean),
|
|
892
|
-
})).annotate({
|
|
893
|
-
identifier: "MultiSearchParameters",
|
|
894
|
-
});
|
|
895
|
-
export const MultiSearchCollectionParameters = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
896
|
-
q: S.optional(S.String),
|
|
897
|
-
query_by: S.optional(S.String),
|
|
898
|
-
query_by_weights: S.optional(S.String),
|
|
899
|
-
text_match_type: S.optional(S.String),
|
|
900
|
-
prefix: S.optional(S.String),
|
|
901
|
-
infix: S.optional(S.String),
|
|
902
|
-
max_extra_prefix: S.optional(S.Number),
|
|
903
|
-
max_extra_suffix: S.optional(S.Number),
|
|
904
|
-
filter_by: S.optional(S.String),
|
|
905
|
-
sort_by: S.optional(S.String),
|
|
906
|
-
facet_by: S.optional(S.String),
|
|
907
|
-
max_facet_values: S.optional(S.Number),
|
|
908
|
-
facet_query: S.optional(S.String),
|
|
909
|
-
num_typos: S.optional(S.String),
|
|
910
|
-
page: S.optional(S.Number),
|
|
911
|
-
per_page: S.optional(S.Number),
|
|
912
|
-
limit: S.optional(S.Number),
|
|
913
|
-
offset: S.optional(S.Number),
|
|
914
|
-
group_by: S.optional(S.String),
|
|
915
|
-
group_limit: S.optional(S.Number),
|
|
916
|
-
group_missing_values: S.optional(S.Boolean),
|
|
917
|
-
include_fields: S.optional(S.String),
|
|
918
|
-
exclude_fields: S.optional(S.String),
|
|
919
|
-
highlight_full_fields: S.optional(S.String),
|
|
920
|
-
highlight_affix_num_tokens: S.optional(S.Number),
|
|
921
|
-
highlight_start_tag: S.optional(S.String),
|
|
922
|
-
highlight_end_tag: S.optional(S.String),
|
|
923
|
-
snippet_threshold: S.optional(S.Number),
|
|
924
|
-
drop_tokens_threshold: S.optional(S.Number),
|
|
925
|
-
drop_tokens_mode: S.optional(DropTokensMode),
|
|
926
|
-
typo_tokens_threshold: S.optional(S.Number),
|
|
927
|
-
enable_typos_for_alpha_numerical_tokens: S.optional(S.Boolean),
|
|
928
|
-
filter_curated_hits: S.optional(S.Boolean),
|
|
929
|
-
enable_synonyms: S.optional(S.Boolean),
|
|
930
|
-
enable_analytics: S.optional(S.Boolean),
|
|
931
|
-
synonym_prefix: S.optional(S.Boolean),
|
|
932
|
-
synonym_num_typos: S.optional(S.Number),
|
|
933
|
-
pinned_hits: S.optional(S.String),
|
|
934
|
-
hidden_hits: S.optional(S.String),
|
|
935
|
-
curation_tags: S.optional(S.String),
|
|
936
|
-
highlight_fields: S.optional(S.String),
|
|
937
|
-
pre_segmented_query: S.optional(S.Boolean),
|
|
938
|
-
preset: S.optional(S.String),
|
|
939
|
-
enable_curations: S.optional(S.Boolean),
|
|
940
|
-
prioritize_exact_match: S.optional(S.Boolean),
|
|
941
|
-
prioritize_token_position: S.optional(S.Boolean),
|
|
942
|
-
prioritize_num_matching_fields: S.optional(S.Boolean),
|
|
943
|
-
enable_typos_for_numerical_tokens: S.optional(S.Boolean),
|
|
944
|
-
exhaustive_search: S.optional(S.Boolean),
|
|
945
|
-
search_cutoff_ms: S.optional(S.Number),
|
|
946
|
-
use_cache: S.optional(S.Boolean),
|
|
947
|
-
cache_ttl: S.optional(S.Number),
|
|
948
|
-
min_len_1typo: S.optional(S.Number),
|
|
949
|
-
min_len_2typo: S.optional(S.Number),
|
|
950
|
-
vector_query: S.optional(S.String),
|
|
951
|
-
remote_embedding_timeout_ms: S.optional(S.Number),
|
|
952
|
-
remote_embedding_num_tries: S.optional(S.Number),
|
|
953
|
-
facet_strategy: S.optional(S.String),
|
|
954
|
-
stopwords: S.optional(S.String),
|
|
955
|
-
facet_return_parent: S.optional(S.String),
|
|
956
|
-
voice_query: S.optional(S.String),
|
|
957
|
-
conversation: S.optional(S.Boolean),
|
|
958
|
-
conversation_model_id: S.optional(S.String),
|
|
959
|
-
conversation_id: S.optional(S.String),
|
|
960
|
-
validate_field_names: S.optional(S.Boolean),
|
|
961
|
-
collection: S.optional(S.String),
|
|
962
|
-
x_typesense_api_key: S.optional(S.String.pipe(T.Body("x-typesense-api-key"))),
|
|
963
|
-
rerank_hybrid_matches: S.optional(S.Boolean),
|
|
964
|
-
})).annotate({
|
|
965
|
-
identifier: "MultiSearchCollectionParameters",
|
|
966
|
-
});
|
|
967
|
-
export const MultiSearchRequestSearchesList = /*@__PURE__*/ S.Array(MultiSearchCollectionParameters);
|
|
968
|
-
export const MultiSearchRequest = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
969
|
-
multiSearchParameters: MultiSearchParameters.pipe(T.Query()),
|
|
970
|
-
union: S.optional(S.Boolean),
|
|
971
|
-
searches: MultiSearchRequestSearchesList,
|
|
972
|
-
}).pipe(T.Http({ method: "POST", uri: "/multi_search", code: 200 }))).annotate({
|
|
973
|
-
identifier: "MultiSearchRequest",
|
|
974
|
-
});
|
|
975
|
-
export const FacetCountsCountsItem = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
976
|
-
count: S.optional(S.Number),
|
|
977
|
-
highlighted: S.optional(S.String),
|
|
978
|
-
value: S.optional(S.String),
|
|
979
|
-
parent: S.optional(S.Unknown),
|
|
980
|
-
})).annotate({
|
|
981
|
-
identifier: "FacetCountsCountsItem",
|
|
982
|
-
});
|
|
983
|
-
export const FacetCountsCountsList = /*@__PURE__*/ S.Array(FacetCountsCountsItem);
|
|
984
|
-
export const FacetCountsStats = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
985
|
-
max: S.optional(S.Number),
|
|
986
|
-
min: S.optional(S.Number),
|
|
987
|
-
sum: S.optional(S.Number),
|
|
988
|
-
total_values: S.optional(S.Number),
|
|
989
|
-
avg: S.optional(S.Number),
|
|
990
|
-
})).annotate({
|
|
991
|
-
identifier: "FacetCountsStats",
|
|
992
|
-
});
|
|
993
|
-
export const FacetCounts = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
994
|
-
counts: S.optional(FacetCountsCountsList),
|
|
995
|
-
field_name: S.optional(S.String),
|
|
996
|
-
sampled: S.optional(S.Boolean),
|
|
997
|
-
stats: S.optional(FacetCountsStats),
|
|
998
|
-
})).annotate({ identifier: "FacetCounts" });
|
|
999
|
-
export const MultiSearchResultItemFacetCountsList = /*@__PURE__*/ S.Array(FacetCounts);
|
|
1000
|
-
export const SearchGroupedHitGroupKeyList = /*@__PURE__*/ S.Array(S.Unknown);
|
|
1001
|
-
export const SearchHighlightSnippetsList = /*@__PURE__*/ S.Array(S.String);
|
|
1002
|
-
export const SearchHighlightValuesList = /*@__PURE__*/ S.Array(S.String);
|
|
1003
|
-
export const SearchHighlightIndicesList = /*@__PURE__*/ S.Array(S.Number);
|
|
1004
|
-
export const SearchHighlightMatchedTokensList = /*@__PURE__*/ S.Array(S.Unknown);
|
|
1005
|
-
export const SearchHighlight = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
1006
|
-
field: S.optional(S.String),
|
|
1007
|
-
snippet: S.optional(S.String),
|
|
1008
|
-
snippets: S.optional(SearchHighlightSnippetsList),
|
|
1009
|
-
value: S.optional(S.String),
|
|
1010
|
-
values: S.optional(SearchHighlightValuesList),
|
|
1011
|
-
indices: S.optional(SearchHighlightIndicesList),
|
|
1012
|
-
matched_tokens: S.optional(SearchHighlightMatchedTokensList),
|
|
1013
|
-
})).annotate({
|
|
1014
|
-
identifier: "SearchHighlight",
|
|
1015
|
-
});
|
|
1016
|
-
export const SearchResultHitHighlightsList = /*@__PURE__*/ S.Array(SearchHighlight);
|
|
1017
|
-
export const SearchResultHitHighlightMap = /*@__PURE__*/ S.Record(S.String, S.Unknown);
|
|
1018
|
-
export const SearchResultHitDocumentMap = /*@__PURE__*/ S.Record(S.String, S.Unknown);
|
|
1019
|
-
export const SearchResultHitTextMatchInfo = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
1020
|
-
best_field_score: S.optional(S.String),
|
|
1021
|
-
best_field_weight: S.optional(S.Number),
|
|
1022
|
-
fields_matched: S.optional(S.Number),
|
|
1023
|
-
num_tokens_dropped: S.optional(S.Number),
|
|
1024
|
-
score: S.optional(S.String),
|
|
1025
|
-
tokens_matched: S.optional(S.Number),
|
|
1026
|
-
typo_prefix_score: S.optional(S.Number),
|
|
1027
|
-
})).annotate({
|
|
1028
|
-
identifier: "SearchResultHitTextMatchInfo",
|
|
1029
|
-
});
|
|
1030
|
-
export const SearchResultHitGeoDistanceMetersMap = /*@__PURE__*/ S.Record(S.String, S.Number);
|
|
1031
|
-
export const SearchResultHitHybridSearchInfo = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
1032
|
-
rank_fusion_score: S.optional(S.Number),
|
|
1033
|
-
})).annotate({
|
|
1034
|
-
identifier: "SearchResultHitHybridSearchInfo",
|
|
1035
|
-
});
|
|
1036
|
-
export const SearchResultHit = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
1037
|
-
highlights: S.optional(SearchResultHitHighlightsList),
|
|
1038
|
-
highlight: S.optional(SearchResultHitHighlightMap),
|
|
1039
|
-
document: S.optional(SearchResultHitDocumentMap),
|
|
1040
|
-
text_match: S.optional(S.Number),
|
|
1041
|
-
text_match_info: S.optional(SearchResultHitTextMatchInfo),
|
|
1042
|
-
geo_distance_meters: S.optional(SearchResultHitGeoDistanceMetersMap),
|
|
1043
|
-
vector_distance: S.optional(S.Number),
|
|
1044
|
-
hybrid_search_info: S.optional(SearchResultHitHybridSearchInfo),
|
|
1045
|
-
search_index: S.optional(S.Number),
|
|
1046
|
-
})).annotate({
|
|
1047
|
-
identifier: "SearchResultHit",
|
|
1048
|
-
});
|
|
1049
|
-
export const SearchGroupedHitHitsList = /*@__PURE__*/ S.Array(SearchResultHit);
|
|
1050
|
-
export const SearchGroupedHit = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
1051
|
-
found: S.optional(S.Number),
|
|
1052
|
-
group_key: SearchGroupedHitGroupKeyList,
|
|
1053
|
-
hits: SearchGroupedHitHitsList,
|
|
1054
|
-
})).annotate({
|
|
1055
|
-
identifier: "SearchGroupedHit",
|
|
1056
|
-
});
|
|
1057
|
-
export const MultiSearchResultItemGroupedHitsList = /*@__PURE__*/ S.Array(SearchGroupedHit);
|
|
1058
|
-
export const MultiSearchResultItemHitsList = /*@__PURE__*/ S.Array(SearchResultHit);
|
|
1059
|
-
export const SearchRequestParamsVoiceQuery = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
1060
|
-
transcribed_query: S.optional(S.String),
|
|
1061
|
-
})).annotate({
|
|
1062
|
-
identifier: "SearchRequestParamsVoiceQuery",
|
|
1063
|
-
});
|
|
1064
|
-
export const SearchRequestParams = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
1065
|
-
collection_name: S.String,
|
|
1066
|
-
first_q: S.optional(S.String),
|
|
1067
|
-
q: S.String,
|
|
1068
|
-
per_page: S.Number,
|
|
1069
|
-
voice_query: S.optional(SearchRequestParamsVoiceQuery),
|
|
1070
|
-
})).annotate({
|
|
1071
|
-
identifier: "SearchRequestParams",
|
|
1072
|
-
});
|
|
1073
|
-
export const SearchResultConversationConversationHistoryList =
|
|
1074
|
-
/*@__PURE__*/ S.Array(S.Unknown);
|
|
1075
|
-
export const SearchResultConversation = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
1076
|
-
answer: S.String,
|
|
1077
|
-
conversation_history: SearchResultConversationConversationHistoryList,
|
|
1078
|
-
conversation_id: S.String,
|
|
1079
|
-
query: S.String,
|
|
1080
|
-
})).annotate({
|
|
1081
|
-
identifier: "SearchResultConversation",
|
|
1082
|
-
});
|
|
1083
|
-
export const MultiSearchResultItemUnionRequestParamsList =
|
|
1084
|
-
/*@__PURE__*/ S.Array(SearchRequestParams);
|
|
1085
|
-
export const MultiSearchResultItemMetadataMap = /*@__PURE__*/ S.Record(S.String, S.Unknown);
|
|
1086
|
-
export const MultiSearchResultItem = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
1087
|
-
facet_counts: S.optional(MultiSearchResultItemFacetCountsList),
|
|
1088
|
-
found: S.optional(S.Number),
|
|
1089
|
-
found_docs: S.optional(S.Number),
|
|
1090
|
-
search_time_ms: S.optional(S.Number),
|
|
1091
|
-
out_of: S.optional(S.Number),
|
|
1092
|
-
search_cutoff: S.optional(S.Boolean),
|
|
1093
|
-
page: S.optional(S.Number),
|
|
1094
|
-
grouped_hits: S.optional(MultiSearchResultItemGroupedHitsList),
|
|
1095
|
-
hits: S.optional(MultiSearchResultItemHitsList),
|
|
1096
|
-
request_params: S.optional(SearchRequestParams),
|
|
1097
|
-
conversation: S.optional(SearchResultConversation),
|
|
1098
|
-
union_request_params: S.optional(MultiSearchResultItemUnionRequestParamsList),
|
|
1099
|
-
metadata: S.optional(MultiSearchResultItemMetadataMap),
|
|
1100
|
-
code: S.optional(S.Number),
|
|
1101
|
-
error: S.optional(S.String),
|
|
1102
|
-
})).annotate({
|
|
1103
|
-
identifier: "MultiSearchResultItem",
|
|
1104
|
-
});
|
|
1105
|
-
export const MultiSearchResultResultsList = /*@__PURE__*/ S.Array(MultiSearchResultItem);
|
|
1106
|
-
export const MultiSearchResult = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
1107
|
-
results: MultiSearchResultResultsList,
|
|
1108
|
-
conversation: S.optional(SearchResultConversation),
|
|
1109
|
-
})).annotate({
|
|
1110
|
-
identifier: "MultiSearchResult",
|
|
1111
|
-
});
|
|
1112
|
-
export const RetrieveAllConversationModelsRequest = /*@__PURE__*/ S.suspend(() => S.Struct({}).pipe(T.Http({ method: "GET", uri: "/conversations/models", code: 200 }))).annotate({
|
|
1113
|
-
identifier: "RetrieveAllConversationModelsRequest",
|
|
581
|
+
export const GetAllConversationModelsRequest = /*@__PURE__*/ S.suspend(() => S.Struct({}).pipe(T.Http({ method: "GET", uri: "/conversations/models", code: 200 }))).annotate({
|
|
582
|
+
identifier: "GetAllConversationModelsRequest",
|
|
1114
583
|
});
|
|
1115
584
|
export const ConversationModelSchema = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
1116
585
|
id: S.String,
|
|
@@ -1125,13 +594,12 @@ export const ConversationModelSchema = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
|
1125
594
|
})).annotate({
|
|
1126
595
|
identifier: "ConversationModelSchema",
|
|
1127
596
|
});
|
|
1128
|
-
export const
|
|
1129
|
-
/*@__PURE__*/ S.
|
|
1130
|
-
|
|
1131
|
-
identifier: "RetrieveAllConversationModelsResponse",
|
|
597
|
+
export const GetAllConversationModelsResponseBodyList = /*@__PURE__*/ S.Array(ConversationModelSchema);
|
|
598
|
+
export const GetAllConversationModelsResponse = /*@__PURE__*/ S.suspend(() => GetAllConversationModelsResponseBodyList.pipe(T.RawResponseRoot())).annotate({
|
|
599
|
+
identifier: "GetAllConversationModelsResponse",
|
|
1132
600
|
});
|
|
1133
|
-
export const
|
|
1134
|
-
identifier: "
|
|
601
|
+
export const GetAllNLSearchModelsRequest = /*@__PURE__*/ S.suspend(() => S.Struct({}).pipe(T.Http({ method: "GET", uri: "/nl_search_models", code: 200 }))).annotate({
|
|
602
|
+
identifier: "GetAllNLSearchModelsRequest",
|
|
1135
603
|
});
|
|
1136
604
|
export const NLSearchModelSchemaStopSequencesList = /*@__PURE__*/ S.Array(S.String);
|
|
1137
605
|
export const NLSearchModelSchema = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
@@ -1157,13 +625,14 @@ export const NLSearchModelSchema = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
|
1157
625
|
})).annotate({
|
|
1158
626
|
identifier: "NLSearchModelSchema",
|
|
1159
627
|
});
|
|
1160
|
-
export const
|
|
1161
|
-
export const
|
|
1162
|
-
identifier: "
|
|
628
|
+
export const GetAllNLSearchModelsResponseBodyList = /*@__PURE__*/ S.Array(NLSearchModelSchema);
|
|
629
|
+
export const GetAllNLSearchModelsResponse = /*@__PURE__*/ S.suspend(() => GetAllNLSearchModelsResponseBodyList.pipe(T.RawResponseRoot())).annotate({
|
|
630
|
+
identifier: "GetAllNLSearchModelsResponse",
|
|
1163
631
|
});
|
|
1164
|
-
export const
|
|
1165
|
-
identifier: "
|
|
632
|
+
export const GetAllPresetsRequest = /*@__PURE__*/ S.suspend(() => S.Struct({}).pipe(T.Http({ method: "GET", uri: "/presets", code: 200 }))).annotate({
|
|
633
|
+
identifier: "GetAllPresetsRequest",
|
|
1166
634
|
});
|
|
635
|
+
export const DropTokensMode = S.String;
|
|
1167
636
|
export const SearchParameters = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
1168
637
|
q: S.optional(S.String),
|
|
1169
638
|
query_by: S.optional(S.String),
|
|
@@ -1240,6 +709,78 @@ export const SearchParameters = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
|
1240
709
|
})).annotate({
|
|
1241
710
|
identifier: "SearchParameters",
|
|
1242
711
|
});
|
|
712
|
+
export const MultiSearchCollectionParameters = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
713
|
+
q: S.optional(S.String),
|
|
714
|
+
query_by: S.optional(S.String),
|
|
715
|
+
query_by_weights: S.optional(S.String),
|
|
716
|
+
text_match_type: S.optional(S.String),
|
|
717
|
+
prefix: S.optional(S.String),
|
|
718
|
+
infix: S.optional(S.String),
|
|
719
|
+
max_extra_prefix: S.optional(S.Number),
|
|
720
|
+
max_extra_suffix: S.optional(S.Number),
|
|
721
|
+
filter_by: S.optional(S.String),
|
|
722
|
+
sort_by: S.optional(S.String),
|
|
723
|
+
facet_by: S.optional(S.String),
|
|
724
|
+
max_facet_values: S.optional(S.Number),
|
|
725
|
+
facet_query: S.optional(S.String),
|
|
726
|
+
num_typos: S.optional(S.String),
|
|
727
|
+
page: S.optional(S.Number),
|
|
728
|
+
per_page: S.optional(S.Number),
|
|
729
|
+
limit: S.optional(S.Number),
|
|
730
|
+
offset: S.optional(S.Number),
|
|
731
|
+
group_by: S.optional(S.String),
|
|
732
|
+
group_limit: S.optional(S.Number),
|
|
733
|
+
group_missing_values: S.optional(S.Boolean),
|
|
734
|
+
include_fields: S.optional(S.String),
|
|
735
|
+
exclude_fields: S.optional(S.String),
|
|
736
|
+
highlight_full_fields: S.optional(S.String),
|
|
737
|
+
highlight_affix_num_tokens: S.optional(S.Number),
|
|
738
|
+
highlight_start_tag: S.optional(S.String),
|
|
739
|
+
highlight_end_tag: S.optional(S.String),
|
|
740
|
+
snippet_threshold: S.optional(S.Number),
|
|
741
|
+
drop_tokens_threshold: S.optional(S.Number),
|
|
742
|
+
drop_tokens_mode: S.optional(DropTokensMode),
|
|
743
|
+
typo_tokens_threshold: S.optional(S.Number),
|
|
744
|
+
enable_typos_for_alpha_numerical_tokens: S.optional(S.Boolean),
|
|
745
|
+
filter_curated_hits: S.optional(S.Boolean),
|
|
746
|
+
enable_synonyms: S.optional(S.Boolean),
|
|
747
|
+
enable_analytics: S.optional(S.Boolean),
|
|
748
|
+
synonym_prefix: S.optional(S.Boolean),
|
|
749
|
+
synonym_num_typos: S.optional(S.Number),
|
|
750
|
+
pinned_hits: S.optional(S.String),
|
|
751
|
+
hidden_hits: S.optional(S.String),
|
|
752
|
+
curation_tags: S.optional(S.String),
|
|
753
|
+
highlight_fields: S.optional(S.String),
|
|
754
|
+
pre_segmented_query: S.optional(S.Boolean),
|
|
755
|
+
preset: S.optional(S.String),
|
|
756
|
+
enable_curations: S.optional(S.Boolean),
|
|
757
|
+
prioritize_exact_match: S.optional(S.Boolean),
|
|
758
|
+
prioritize_token_position: S.optional(S.Boolean),
|
|
759
|
+
prioritize_num_matching_fields: S.optional(S.Boolean),
|
|
760
|
+
enable_typos_for_numerical_tokens: S.optional(S.Boolean),
|
|
761
|
+
exhaustive_search: S.optional(S.Boolean),
|
|
762
|
+
search_cutoff_ms: S.optional(S.Number),
|
|
763
|
+
use_cache: S.optional(S.Boolean),
|
|
764
|
+
cache_ttl: S.optional(S.Number),
|
|
765
|
+
min_len_1typo: S.optional(S.Number),
|
|
766
|
+
min_len_2typo: S.optional(S.Number),
|
|
767
|
+
vector_query: S.optional(S.String),
|
|
768
|
+
remote_embedding_timeout_ms: S.optional(S.Number),
|
|
769
|
+
remote_embedding_num_tries: S.optional(S.Number),
|
|
770
|
+
facet_strategy: S.optional(S.String),
|
|
771
|
+
stopwords: S.optional(S.String),
|
|
772
|
+
facet_return_parent: S.optional(S.String),
|
|
773
|
+
voice_query: S.optional(S.String),
|
|
774
|
+
conversation: S.optional(S.Boolean),
|
|
775
|
+
conversation_model_id: S.optional(S.String),
|
|
776
|
+
conversation_id: S.optional(S.String),
|
|
777
|
+
validate_field_names: S.optional(S.Boolean),
|
|
778
|
+
collection: S.optional(S.String),
|
|
779
|
+
x_typesense_api_key: S.optional(S.String.pipe(T.Body("x-typesense-api-key"))),
|
|
780
|
+
rerank_hybrid_matches: S.optional(S.Boolean),
|
|
781
|
+
})).annotate({
|
|
782
|
+
identifier: "MultiSearchCollectionParameters",
|
|
783
|
+
});
|
|
1243
784
|
export const MultiSearchSearchesParameterSearchesList = /*@__PURE__*/ S.Array(MultiSearchCollectionParameters);
|
|
1244
785
|
export const MultiSearchSearchesParameter = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
1245
786
|
union: S.optional(S.Boolean),
|
|
@@ -1334,45 +875,86 @@ export const PresetsRetrieveSchema = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
|
1334
875
|
})).annotate({
|
|
1335
876
|
identifier: "PresetsRetrieveSchema",
|
|
1336
877
|
});
|
|
1337
|
-
export const
|
|
878
|
+
export const GetAnalyticsEventsRequest = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
879
|
+
user_id: S.String.pipe(T.Query()),
|
|
880
|
+
name: S.String.pipe(T.Query()),
|
|
881
|
+
n: S.Number.pipe(T.Query()),
|
|
882
|
+
}).pipe(T.Http({ method: "GET", uri: "/analytics/events", code: 200 }))).annotate({
|
|
883
|
+
identifier: "GetAnalyticsEventsRequest",
|
|
884
|
+
});
|
|
885
|
+
export const AnalyticsEventsResponseEventsItemDocIdsList =
|
|
886
|
+
/*@__PURE__*/ S.Array(S.String);
|
|
887
|
+
export const AnalyticsEventsResponseEventsItem = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
888
|
+
name: S.optional(S.String),
|
|
889
|
+
event_type: S.optional(S.String),
|
|
890
|
+
collection: S.optional(S.String),
|
|
891
|
+
timestamp: S.optional(S.Number),
|
|
892
|
+
user_id: S.optional(S.String),
|
|
893
|
+
doc_id: S.optional(S.String),
|
|
894
|
+
doc_ids: S.optional(AnalyticsEventsResponseEventsItemDocIdsList),
|
|
895
|
+
query: S.optional(S.String),
|
|
896
|
+
})).annotate({
|
|
897
|
+
identifier: "AnalyticsEventsResponseEventsItem",
|
|
898
|
+
});
|
|
899
|
+
export const AnalyticsEventsResponseEventsList = /*@__PURE__*/ S.Array(AnalyticsEventsResponseEventsItem);
|
|
900
|
+
export const AnalyticsEventsResponse = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
901
|
+
events: AnalyticsEventsResponseEventsList,
|
|
902
|
+
})).annotate({
|
|
903
|
+
identifier: "AnalyticsEventsResponse",
|
|
904
|
+
});
|
|
905
|
+
export const GetAnalyticsRuleRequest = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
1338
906
|
ruleName: S.String.pipe(T.Label()),
|
|
1339
907
|
}).pipe(T.Http({ method: "GET", uri: "/analytics/rules/{ruleName}", code: 200 }))).annotate({
|
|
1340
|
-
identifier: "
|
|
908
|
+
identifier: "GetAnalyticsRuleRequest",
|
|
1341
909
|
});
|
|
1342
|
-
export const
|
|
910
|
+
export const GetAnalyticsRuleResponseParamsMetaFieldsList =
|
|
1343
911
|
/*@__PURE__*/ S.Array(S.String);
|
|
1344
|
-
export const
|
|
912
|
+
export const GetAnalyticsRuleResponseParams = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
1345
913
|
destination_collection: S.optional(S.String),
|
|
1346
914
|
limit: S.optional(S.Number),
|
|
1347
915
|
capture_search_requests: S.optional(S.Boolean),
|
|
1348
|
-
meta_fields: S.optional(
|
|
916
|
+
meta_fields: S.optional(GetAnalyticsRuleResponseParamsMetaFieldsList),
|
|
1349
917
|
expand_query: S.optional(S.Boolean),
|
|
1350
918
|
counter_field: S.optional(S.String),
|
|
1351
919
|
weight: S.optional(S.Number),
|
|
1352
920
|
})).annotate({
|
|
1353
|
-
identifier: "
|
|
921
|
+
identifier: "GetAnalyticsRuleResponseParams",
|
|
1354
922
|
});
|
|
1355
|
-
export const
|
|
923
|
+
export const GetAnalyticsRuleResponse = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
1356
924
|
name: S.String,
|
|
1357
925
|
type: AnalyticsRuleType,
|
|
1358
926
|
collection: S.String,
|
|
1359
927
|
event_type: S.String,
|
|
1360
928
|
rule_tag: S.optional(S.String),
|
|
1361
|
-
params: S.optional(
|
|
929
|
+
params: S.optional(GetAnalyticsRuleResponseParams),
|
|
1362
930
|
})).annotate({
|
|
1363
|
-
identifier: "
|
|
931
|
+
identifier: "GetAnalyticsRuleResponse",
|
|
1364
932
|
});
|
|
1365
|
-
export const
|
|
933
|
+
export const GetAnalyticsRulesRequest = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
1366
934
|
rule_tag: S.optional(S.String.pipe(T.Query())),
|
|
1367
935
|
}).pipe(T.Http({ method: "GET", uri: "/analytics/rules", code: 200 }))).annotate({
|
|
1368
|
-
identifier: "
|
|
936
|
+
identifier: "GetAnalyticsRulesRequest",
|
|
937
|
+
});
|
|
938
|
+
export const GetAnalyticsRulesResponseBodyList = /*@__PURE__*/ S.Array(AnalyticsRule);
|
|
939
|
+
export const GetAnalyticsRulesResponse = /*@__PURE__*/ S.suspend(() => GetAnalyticsRulesResponseBodyList.pipe(T.RawResponseRoot())).annotate({
|
|
940
|
+
identifier: "GetAnalyticsRulesResponse",
|
|
1369
941
|
});
|
|
1370
|
-
export const
|
|
1371
|
-
|
|
1372
|
-
|
|
942
|
+
export const GetAnalyticsStatusRequest = /*@__PURE__*/ S.suspend(() => S.Struct({}).pipe(T.Http({ method: "GET", uri: "/analytics/status", code: 200 }))).annotate({
|
|
943
|
+
identifier: "GetAnalyticsStatusRequest",
|
|
944
|
+
});
|
|
945
|
+
export const AnalyticsStatus = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
946
|
+
popular_prefix_queries: S.optional(S.Number),
|
|
947
|
+
nohits_prefix_queries: S.optional(S.Number),
|
|
948
|
+
log_prefix_queries: S.optional(S.Number),
|
|
949
|
+
query_log_events: S.optional(S.Number),
|
|
950
|
+
query_counter_events: S.optional(S.Number),
|
|
951
|
+
doc_log_events: S.optional(S.Number),
|
|
952
|
+
doc_counter_events: S.optional(S.Number),
|
|
953
|
+
})).annotate({
|
|
954
|
+
identifier: "AnalyticsStatus",
|
|
1373
955
|
});
|
|
1374
|
-
export const
|
|
1375
|
-
identifier: "
|
|
956
|
+
export const GetAPIStatsRequest = /*@__PURE__*/ S.suspend(() => S.Struct({}).pipe(T.Http({ method: "GET", uri: "/stats.json", code: 200 }))).annotate({
|
|
957
|
+
identifier: "GetAPIStatsRequest",
|
|
1376
958
|
});
|
|
1377
959
|
export const APIStatsResponse = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
1378
960
|
delete_latency_ms: S.optional(S.Number),
|
|
@@ -1391,16 +973,76 @@ export const APIStatsResponse = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
|
1391
973
|
})).annotate({
|
|
1392
974
|
identifier: "APIStatsResponse",
|
|
1393
975
|
});
|
|
1394
|
-
export const
|
|
976
|
+
export const GetCollectionRequest = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
977
|
+
collectionName: S.String.pipe(T.Label()),
|
|
978
|
+
}).pipe(T.Http({ method: "GET", uri: "/collections/{collectionName}", code: 200 }))).annotate({
|
|
979
|
+
identifier: "GetCollectionRequest",
|
|
980
|
+
});
|
|
981
|
+
export const GetCollectionResponseFieldsList = /*@__PURE__*/ S.Array(Field);
|
|
982
|
+
export const GetCollectionResponseTokenSeparatorsList = /*@__PURE__*/ S.Array(S.String);
|
|
983
|
+
export const GetCollectionResponseSynonymSetsList = /*@__PURE__*/ S.Array(S.String);
|
|
984
|
+
export const GetCollectionResponseSymbolsToIndexList = /*@__PURE__*/ S.Array(S.String);
|
|
985
|
+
export const GetCollectionResponse = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
986
|
+
name: S.String,
|
|
987
|
+
fields: GetCollectionResponseFieldsList,
|
|
988
|
+
default_sorting_field: S.optional(S.String),
|
|
989
|
+
token_separators: S.optional(GetCollectionResponseTokenSeparatorsList),
|
|
990
|
+
synonym_sets: S.optional(GetCollectionResponseSynonymSetsList),
|
|
991
|
+
enable_nested_fields: S.optional(S.Boolean),
|
|
992
|
+
symbols_to_index: S.optional(GetCollectionResponseSymbolsToIndexList),
|
|
993
|
+
voice_query_model: S.optional(VoiceQueryModelCollectionConfig),
|
|
994
|
+
metadata: S.optional(S.Unknown),
|
|
995
|
+
num_documents: S.Number,
|
|
996
|
+
created_at: S.Number,
|
|
997
|
+
})).annotate({
|
|
998
|
+
identifier: "GetCollectionResponse",
|
|
999
|
+
});
|
|
1000
|
+
export const GetCollectionsRequestGetCollectionsParameters =
|
|
1001
|
+
/*@__PURE__*/ S.suspend(() => S.Struct({
|
|
1002
|
+
exclude_fields: S.optional(S.String),
|
|
1003
|
+
limit: S.optional(S.Number),
|
|
1004
|
+
offset: S.optional(S.Number),
|
|
1005
|
+
})).annotate({
|
|
1006
|
+
identifier: "GetCollectionsRequestGetCollectionsParameters",
|
|
1007
|
+
});
|
|
1008
|
+
export const GetCollectionsRequest = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
1009
|
+
getCollectionsParameters: S.optional(GetCollectionsRequestGetCollectionsParameters.pipe(T.Query())),
|
|
1010
|
+
}).pipe(T.Http({ method: "GET", uri: "/collections", code: 200 }))).annotate({
|
|
1011
|
+
identifier: "GetCollectionsRequest",
|
|
1012
|
+
});
|
|
1013
|
+
export const CollectionResponseFieldsList = /*@__PURE__*/ S.Array(Field);
|
|
1014
|
+
export const CollectionResponseTokenSeparatorsList = /*@__PURE__*/ S.Array(S.String);
|
|
1015
|
+
export const CollectionResponseSynonymSetsList = /*@__PURE__*/ S.Array(S.String);
|
|
1016
|
+
export const CollectionResponseSymbolsToIndexList = /*@__PURE__*/ S.Array(S.String);
|
|
1017
|
+
export const CollectionResponse = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
1018
|
+
name: S.String,
|
|
1019
|
+
fields: CollectionResponseFieldsList,
|
|
1020
|
+
default_sorting_field: S.optional(S.String),
|
|
1021
|
+
token_separators: S.optional(CollectionResponseTokenSeparatorsList),
|
|
1022
|
+
synonym_sets: S.optional(CollectionResponseSynonymSetsList),
|
|
1023
|
+
enable_nested_fields: S.optional(S.Boolean),
|
|
1024
|
+
symbols_to_index: S.optional(CollectionResponseSymbolsToIndexList),
|
|
1025
|
+
voice_query_model: S.optional(VoiceQueryModelCollectionConfig),
|
|
1026
|
+
metadata: S.optional(S.Unknown),
|
|
1027
|
+
num_documents: S.Number,
|
|
1028
|
+
created_at: S.Number,
|
|
1029
|
+
})).annotate({
|
|
1030
|
+
identifier: "CollectionResponse",
|
|
1031
|
+
});
|
|
1032
|
+
export const GetCollectionsResponseBodyList = /*@__PURE__*/ S.Array(CollectionResponse);
|
|
1033
|
+
export const GetCollectionsResponse = /*@__PURE__*/ S.suspend(() => GetCollectionsResponseBodyList.pipe(T.RawResponseRoot())).annotate({
|
|
1034
|
+
identifier: "GetCollectionsResponse",
|
|
1035
|
+
});
|
|
1036
|
+
export const GetConversationModelRequest = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
1395
1037
|
modelId: S.String.pipe(T.Label()),
|
|
1396
1038
|
}).pipe(T.Http({
|
|
1397
1039
|
method: "GET",
|
|
1398
1040
|
uri: "/conversations/models/{modelId}",
|
|
1399
1041
|
code: 200,
|
|
1400
1042
|
}))).annotate({
|
|
1401
|
-
identifier: "
|
|
1043
|
+
identifier: "GetConversationModelRequest",
|
|
1402
1044
|
});
|
|
1403
|
-
export const
|
|
1045
|
+
export const GetConversationModelResponse = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
1404
1046
|
id: S.String,
|
|
1405
1047
|
model_name: S.String,
|
|
1406
1048
|
api_key: S.optional(S.String.pipe(T.SensitiveValue({}))),
|
|
@@ -1411,19 +1053,19 @@ export const RetrieveConversationModelResponse = /*@__PURE__*/ S.suspend(() => S
|
|
|
1411
1053
|
max_bytes: S.Number,
|
|
1412
1054
|
vllm_url: S.optional(S.String),
|
|
1413
1055
|
})).annotate({
|
|
1414
|
-
identifier: "
|
|
1056
|
+
identifier: "GetConversationModelResponse",
|
|
1415
1057
|
});
|
|
1416
|
-
export const
|
|
1058
|
+
export const GetCurationSetRequest = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
1417
1059
|
curationSetName: S.String.pipe(T.Label()),
|
|
1418
1060
|
}).pipe(T.Http({
|
|
1419
1061
|
method: "GET",
|
|
1420
1062
|
uri: "/curation_sets/{curationSetName}",
|
|
1421
1063
|
code: 200,
|
|
1422
1064
|
}))).annotate({
|
|
1423
|
-
identifier: "
|
|
1065
|
+
identifier: "GetCurationSetRequest",
|
|
1424
1066
|
});
|
|
1425
1067
|
export const CurationRuleTagsList = /*@__PURE__*/ S.Array(S.String);
|
|
1426
|
-
export const CurationRuleMatch =
|
|
1068
|
+
export const CurationRuleMatch = S.String;
|
|
1427
1069
|
export const CurationRule = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
1428
1070
|
tags: S.optional(CurationRuleTagsList),
|
|
1429
1071
|
query: S.optional(S.String),
|
|
@@ -1460,15 +1102,15 @@ export const CurationItemCreateSchema = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
|
1460
1102
|
})).annotate({
|
|
1461
1103
|
identifier: "CurationItemCreateSchema",
|
|
1462
1104
|
});
|
|
1463
|
-
export const
|
|
1464
|
-
export const
|
|
1465
|
-
items:
|
|
1105
|
+
export const GetCurationSetResponseItemsList = /*@__PURE__*/ S.Array(CurationItemCreateSchema);
|
|
1106
|
+
export const GetCurationSetResponse = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
1107
|
+
items: GetCurationSetResponseItemsList,
|
|
1466
1108
|
description: S.optional(S.String),
|
|
1467
1109
|
name: S.String,
|
|
1468
1110
|
})).annotate({
|
|
1469
|
-
identifier: "
|
|
1111
|
+
identifier: "GetCurationSetResponse",
|
|
1470
1112
|
});
|
|
1471
|
-
export const
|
|
1113
|
+
export const GetCurationSetItemRequest = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
1472
1114
|
curationSetName: S.String.pipe(T.Label()),
|
|
1473
1115
|
itemId: S.String.pipe(T.Label()),
|
|
1474
1116
|
}).pipe(T.Http({
|
|
@@ -1476,16 +1118,14 @@ export const RetrieveCurationSetItemRequest = /*@__PURE__*/ S.suspend(() => S.St
|
|
|
1476
1118
|
uri: "/curation_sets/{curationSetName}/items/{itemId}",
|
|
1477
1119
|
code: 200,
|
|
1478
1120
|
}))).annotate({
|
|
1479
|
-
identifier: "
|
|
1121
|
+
identifier: "GetCurationSetItemRequest",
|
|
1480
1122
|
});
|
|
1481
|
-
export const
|
|
1482
|
-
/*@__PURE__*/ S.Array(
|
|
1483
|
-
export const
|
|
1484
|
-
/*@__PURE__*/ S.Array(CurationExclude);
|
|
1485
|
-
export const RetrieveCurationSetItemResponse = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
1123
|
+
export const GetCurationSetItemResponseIncludesList = /*@__PURE__*/ S.Array(CurationInclude);
|
|
1124
|
+
export const GetCurationSetItemResponseExcludesList = /*@__PURE__*/ S.Array(CurationExclude);
|
|
1125
|
+
export const GetCurationSetItemResponse = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
1486
1126
|
rule: CurationRule,
|
|
1487
|
-
includes: S.optional(
|
|
1488
|
-
excludes: S.optional(
|
|
1127
|
+
includes: S.optional(GetCurationSetItemResponseIncludesList),
|
|
1128
|
+
excludes: S.optional(GetCurationSetItemResponseExcludesList),
|
|
1489
1129
|
filter_by: S.optional(S.String),
|
|
1490
1130
|
remove_matched_tokens: S.optional(S.Boolean),
|
|
1491
1131
|
metadata: S.optional(S.Unknown),
|
|
@@ -1497,16 +1137,16 @@ export const RetrieveCurationSetItemResponse = /*@__PURE__*/ S.suspend(() => S.S
|
|
|
1497
1137
|
stop_processing: S.optional(S.Boolean),
|
|
1498
1138
|
id: S.String,
|
|
1499
1139
|
})).annotate({
|
|
1500
|
-
identifier: "
|
|
1140
|
+
identifier: "GetCurationSetItemResponse",
|
|
1501
1141
|
});
|
|
1502
|
-
export const
|
|
1142
|
+
export const GetCurationSetItemsRequest = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
1503
1143
|
curationSetName: S.String.pipe(T.Label()),
|
|
1504
1144
|
}).pipe(T.Http({
|
|
1505
1145
|
method: "GET",
|
|
1506
1146
|
uri: "/curation_sets/{curationSetName}/items",
|
|
1507
1147
|
code: 200,
|
|
1508
1148
|
}))).annotate({
|
|
1509
|
-
identifier: "
|
|
1149
|
+
identifier: "GetCurationSetItemsRequest",
|
|
1510
1150
|
});
|
|
1511
1151
|
export const CurationItemSchemaIncludesList = /*@__PURE__*/ S.Array(CurationInclude);
|
|
1512
1152
|
export const CurationItemSchemaExcludesList = /*@__PURE__*/ S.Array(CurationExclude);
|
|
@@ -1527,12 +1167,12 @@ export const CurationItemSchema = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
|
1527
1167
|
})).annotate({
|
|
1528
1168
|
identifier: "CurationItemSchema",
|
|
1529
1169
|
});
|
|
1530
|
-
export const
|
|
1531
|
-
export const
|
|
1532
|
-
identifier: "
|
|
1170
|
+
export const GetCurationSetItemsResponseBodyList = /*@__PURE__*/ S.Array(CurationItemSchema);
|
|
1171
|
+
export const GetCurationSetItemsResponse = /*@__PURE__*/ S.suspend(() => GetCurationSetItemsResponseBodyList.pipe(T.RawResponseRoot())).annotate({
|
|
1172
|
+
identifier: "GetCurationSetItemsResponse",
|
|
1533
1173
|
});
|
|
1534
|
-
export const
|
|
1535
|
-
identifier: "
|
|
1174
|
+
export const GetCurationSetsRequest = /*@__PURE__*/ S.suspend(() => S.Struct({}).pipe(T.Http({ method: "GET", uri: "/curation_sets", code: 200 }))).annotate({
|
|
1175
|
+
identifier: "GetCurationSetsRequest",
|
|
1536
1176
|
});
|
|
1537
1177
|
export const CurationSetSchemaItemsList = /*@__PURE__*/ S.Array(CurationItemCreateSchema);
|
|
1538
1178
|
export const CurationSetSchema = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
@@ -1542,24 +1182,68 @@ export const CurationSetSchema = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
|
1542
1182
|
})).annotate({
|
|
1543
1183
|
identifier: "CurationSetSchema",
|
|
1544
1184
|
});
|
|
1545
|
-
export const
|
|
1546
|
-
export const
|
|
1547
|
-
identifier: "
|
|
1185
|
+
export const GetCurationSetsResponseBodyList = /*@__PURE__*/ S.Array(CurationSetSchema);
|
|
1186
|
+
export const GetCurationSetsResponse = /*@__PURE__*/ S.suspend(() => GetCurationSetsResponseBodyList.pipe(T.RawResponseRoot())).annotate({
|
|
1187
|
+
identifier: "GetCurationSetsResponse",
|
|
1188
|
+
});
|
|
1189
|
+
export const GetDocumentRequest = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
1190
|
+
collectionName: S.String.pipe(T.Label()),
|
|
1191
|
+
documentId: S.String.pipe(T.Label()),
|
|
1192
|
+
}).pipe(T.Http({
|
|
1193
|
+
method: "GET",
|
|
1194
|
+
uri: "/collections/{collectionName}/documents/{documentId}",
|
|
1195
|
+
code: 200,
|
|
1196
|
+
}))).annotate({
|
|
1197
|
+
identifier: "GetDocumentRequest",
|
|
1198
|
+
});
|
|
1199
|
+
export const GetDocumentResponse = /*@__PURE__*/ S.suspend(() => S.Unknown.pipe(T.RawResponseRoot())).annotate({
|
|
1200
|
+
identifier: "GetDocumentResponse",
|
|
1201
|
+
});
|
|
1202
|
+
export const GetKeyRequest = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
1203
|
+
keyId: S.Number.pipe(T.Label()),
|
|
1204
|
+
}).pipe(T.Http({ method: "GET", uri: "/keys/{keyId}", code: 200 }))).annotate({ identifier: "GetKeyRequest" });
|
|
1205
|
+
export const GetKeyResponseActionsList = /*@__PURE__*/ S.Array(S.String);
|
|
1206
|
+
export const GetKeyResponseCollectionsList = /*@__PURE__*/ S.Array(S.String);
|
|
1207
|
+
export const GetKeyResponse = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
1208
|
+
value: S.optional(S.String),
|
|
1209
|
+
description: S.String,
|
|
1210
|
+
actions: GetKeyResponseActionsList,
|
|
1211
|
+
collections: GetKeyResponseCollectionsList,
|
|
1212
|
+
expires_at: S.optional(S.Number),
|
|
1213
|
+
id: S.optional(S.Number),
|
|
1214
|
+
value_prefix: S.optional(S.String),
|
|
1215
|
+
})).annotate({ identifier: "GetKeyResponse" });
|
|
1216
|
+
export const GetKeysRequest = /*@__PURE__*/ S.suspend(() => S.Struct({}).pipe(T.Http({ method: "GET", uri: "/keys", code: 200 }))).annotate({ identifier: "GetKeysRequest" });
|
|
1217
|
+
export const ApiKeyActionsList = /*@__PURE__*/ S.Array(S.String);
|
|
1218
|
+
export const ApiKeyCollectionsList = /*@__PURE__*/ S.Array(S.String);
|
|
1219
|
+
export const ApiKey = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
1220
|
+
value: S.optional(S.String),
|
|
1221
|
+
description: S.String,
|
|
1222
|
+
actions: ApiKeyActionsList,
|
|
1223
|
+
collections: ApiKeyCollectionsList,
|
|
1224
|
+
expires_at: S.optional(S.Number),
|
|
1225
|
+
id: S.optional(S.Number),
|
|
1226
|
+
value_prefix: S.optional(S.String),
|
|
1227
|
+
})).annotate({ identifier: "ApiKey" });
|
|
1228
|
+
export const ApiKeysResponseKeysList = /*@__PURE__*/ S.Array(ApiKey);
|
|
1229
|
+
export const ApiKeysResponse = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
1230
|
+
keys: ApiKeysResponseKeysList,
|
|
1231
|
+
})).annotate({
|
|
1232
|
+
identifier: "ApiKeysResponse",
|
|
1548
1233
|
});
|
|
1549
|
-
export const
|
|
1550
|
-
identifier: "
|
|
1234
|
+
export const GetMetricsRequest = /*@__PURE__*/ S.suspend(() => S.Struct({}).pipe(T.Http({ method: "GET", uri: "/metrics.json", code: 200 }))).annotate({
|
|
1235
|
+
identifier: "GetMetricsRequest",
|
|
1551
1236
|
});
|
|
1552
|
-
export const
|
|
1553
|
-
identifier: "
|
|
1237
|
+
export const GetMetricsResponse = /*@__PURE__*/ S.suspend(() => S.Unknown.pipe(T.RawResponseRoot())).annotate({
|
|
1238
|
+
identifier: "GetMetricsResponse",
|
|
1554
1239
|
});
|
|
1555
|
-
export const
|
|
1240
|
+
export const GetNLSearchModelRequest = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
1556
1241
|
modelId: S.String.pipe(T.Label()),
|
|
1557
1242
|
}).pipe(T.Http({ method: "GET", uri: "/nl_search_models/{modelId}", code: 200 }))).annotate({
|
|
1558
|
-
identifier: "
|
|
1243
|
+
identifier: "GetNLSearchModelRequest",
|
|
1559
1244
|
});
|
|
1560
|
-
export const
|
|
1561
|
-
/*@__PURE__*/ S.
|
|
1562
|
-
export const RetrieveNLSearchModelResponse = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
1245
|
+
export const GetNLSearchModelResponseStopSequencesList = /*@__PURE__*/ S.Array(S.String);
|
|
1246
|
+
export const GetNLSearchModelResponse = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
1563
1247
|
model_name: S.optional(S.String),
|
|
1564
1248
|
api_key: S.optional(S.String.pipe(T.SensitiveValue({}))),
|
|
1565
1249
|
api_url: S.optional(S.String),
|
|
@@ -1568,7 +1252,7 @@ export const RetrieveNLSearchModelResponse = /*@__PURE__*/ S.suspend(() => S.Str
|
|
|
1568
1252
|
system_prompt: S.optional(S.String),
|
|
1569
1253
|
top_p: S.optional(S.Number),
|
|
1570
1254
|
top_k: S.optional(S.Number),
|
|
1571
|
-
stop_sequences: S.optional(
|
|
1255
|
+
stop_sequences: S.optional(GetNLSearchModelResponseStopSequencesList),
|
|
1572
1256
|
api_version: S.optional(S.String),
|
|
1573
1257
|
project_id: S.optional(S.String),
|
|
1574
1258
|
access_token: S.optional(S.String.pipe(T.SensitiveValue({}))),
|
|
@@ -1580,14 +1264,14 @@ export const RetrieveNLSearchModelResponse = /*@__PURE__*/ S.suspend(() => S.Str
|
|
|
1580
1264
|
account_id: S.optional(S.String),
|
|
1581
1265
|
id: S.String,
|
|
1582
1266
|
})).annotate({
|
|
1583
|
-
identifier: "
|
|
1267
|
+
identifier: "GetNLSearchModelResponse",
|
|
1584
1268
|
});
|
|
1585
|
-
export const
|
|
1269
|
+
export const GetPresetRequest = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
1586
1270
|
presetId: S.String.pipe(T.Label()),
|
|
1587
1271
|
}).pipe(T.Http({ method: "GET", uri: "/presets/{presetId}", code: 200 }))).annotate({
|
|
1588
|
-
identifier: "
|
|
1272
|
+
identifier: "GetPresetRequest",
|
|
1589
1273
|
});
|
|
1590
|
-
export const
|
|
1274
|
+
export const GetPresetResponseValue = /*@__PURE__*/ S.Unknown.pipe(T.UnionCases([
|
|
1591
1275
|
[
|
|
1592
1276
|
"q",
|
|
1593
1277
|
"query_by",
|
|
@@ -1664,16 +1348,52 @@ export const RetrievePresetResponseValue = /*@__PURE__*/ S.Unknown.pipe(T.UnionC
|
|
|
1664
1348
|
],
|
|
1665
1349
|
["union", "searches"],
|
|
1666
1350
|
]));
|
|
1667
|
-
export const
|
|
1668
|
-
value:
|
|
1351
|
+
export const GetPresetResponse = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
1352
|
+
value: GetPresetResponseValue,
|
|
1669
1353
|
name: S.String,
|
|
1670
1354
|
})).annotate({
|
|
1671
|
-
identifier: "
|
|
1355
|
+
identifier: "GetPresetResponse",
|
|
1356
|
+
});
|
|
1357
|
+
export const GetSchemaChangesRequest = /*@__PURE__*/ S.suspend(() => S.Struct({}).pipe(T.Http({ method: "GET", uri: "/operations/schema_changes", code: 200 }))).annotate({
|
|
1358
|
+
identifier: "GetSchemaChangesRequest",
|
|
1359
|
+
});
|
|
1360
|
+
export const SchemaChangeStatus = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
1361
|
+
collection: S.optional(S.String),
|
|
1362
|
+
validated_docs: S.optional(S.Number),
|
|
1363
|
+
altered_docs: S.optional(S.Number),
|
|
1364
|
+
})).annotate({
|
|
1365
|
+
identifier: "SchemaChangeStatus",
|
|
1366
|
+
});
|
|
1367
|
+
export const GetSchemaChangesResponseBodyList = /*@__PURE__*/ S.Array(SchemaChangeStatus);
|
|
1368
|
+
export const GetSchemaChangesResponse = /*@__PURE__*/ S.suspend(() => GetSchemaChangesResponseBodyList.pipe(T.RawResponseRoot())).annotate({
|
|
1369
|
+
identifier: "GetSchemaChangesResponse",
|
|
1370
|
+
});
|
|
1371
|
+
export const GetStemmingDictionaryRequest = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
1372
|
+
dictionaryId: S.String.pipe(T.Label()),
|
|
1373
|
+
}).pipe(T.Http({
|
|
1374
|
+
method: "GET",
|
|
1375
|
+
uri: "/stemming/dictionaries/{dictionaryId}",
|
|
1376
|
+
code: 200,
|
|
1377
|
+
}))).annotate({
|
|
1378
|
+
identifier: "GetStemmingDictionaryRequest",
|
|
1379
|
+
});
|
|
1380
|
+
export const StemmingDictionaryWordsItem = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
1381
|
+
word: S.String,
|
|
1382
|
+
root: S.String,
|
|
1383
|
+
})).annotate({
|
|
1384
|
+
identifier: "StemmingDictionaryWordsItem",
|
|
1385
|
+
});
|
|
1386
|
+
export const StemmingDictionaryWordsList = /*@__PURE__*/ S.Array(StemmingDictionaryWordsItem);
|
|
1387
|
+
export const StemmingDictionary = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
1388
|
+
id: S.String,
|
|
1389
|
+
words: StemmingDictionaryWordsList,
|
|
1390
|
+
})).annotate({
|
|
1391
|
+
identifier: "StemmingDictionary",
|
|
1672
1392
|
});
|
|
1673
|
-
export const
|
|
1393
|
+
export const GetStopwordsSetRequest = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
1674
1394
|
setId: S.String.pipe(T.Label()),
|
|
1675
1395
|
}).pipe(T.Http({ method: "GET", uri: "/stopwords/{setId}", code: 200 }))).annotate({
|
|
1676
|
-
identifier: "
|
|
1396
|
+
identifier: "GetStopwordsSetRequest",
|
|
1677
1397
|
});
|
|
1678
1398
|
export const StopwordsSetSchemaStopwordsList = /*@__PURE__*/ S.Array(S.String);
|
|
1679
1399
|
export const StopwordsSetSchema = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
@@ -1688,8 +1408,8 @@ export const StopwordsSetRetrieveSchema = /*@__PURE__*/ S.suspend(() => S.Struct
|
|
|
1688
1408
|
})).annotate({
|
|
1689
1409
|
identifier: "StopwordsSetRetrieveSchema",
|
|
1690
1410
|
});
|
|
1691
|
-
export const
|
|
1692
|
-
identifier: "
|
|
1411
|
+
export const GetStopwordsSetsRequest = /*@__PURE__*/ S.suspend(() => S.Struct({}).pipe(T.Http({ method: "GET", uri: "/stopwords", code: 200 }))).annotate({
|
|
1412
|
+
identifier: "GetStopwordsSetsRequest",
|
|
1693
1413
|
});
|
|
1694
1414
|
export const StopwordsSetsRetrieveAllSchemaStopwordsList =
|
|
1695
1415
|
/*@__PURE__*/ S.Array(StopwordsSetSchema);
|
|
@@ -1698,10 +1418,10 @@ export const StopwordsSetsRetrieveAllSchema = /*@__PURE__*/ S.suspend(() => S.St
|
|
|
1698
1418
|
})).annotate({
|
|
1699
1419
|
identifier: "StopwordsSetsRetrieveAllSchema",
|
|
1700
1420
|
});
|
|
1701
|
-
export const
|
|
1421
|
+
export const GetSynonymSetRequest = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
1702
1422
|
synonymSetName: S.String.pipe(T.Label()),
|
|
1703
1423
|
}).pipe(T.Http({ method: "GET", uri: "/synonym_sets/{synonymSetName}", code: 200 }))).annotate({
|
|
1704
|
-
identifier: "
|
|
1424
|
+
identifier: "GetSynonymSetRequest",
|
|
1705
1425
|
});
|
|
1706
1426
|
export const SynonymItemSchemaSynonymsList = /*@__PURE__*/ S.Array(S.String);
|
|
1707
1427
|
export const SynonymItemSchemaSymbolsToIndexList = /*@__PURE__*/ S.Array(S.String);
|
|
@@ -1714,14 +1434,14 @@ export const SynonymItemSchema = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
|
1714
1434
|
})).annotate({
|
|
1715
1435
|
identifier: "SynonymItemSchema",
|
|
1716
1436
|
});
|
|
1717
|
-
export const
|
|
1718
|
-
export const
|
|
1719
|
-
items:
|
|
1437
|
+
export const GetSynonymSetResponseItemsList = /*@__PURE__*/ S.Array(SynonymItemSchema);
|
|
1438
|
+
export const GetSynonymSetResponse = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
1439
|
+
items: GetSynonymSetResponseItemsList,
|
|
1720
1440
|
name: S.String,
|
|
1721
1441
|
})).annotate({
|
|
1722
|
-
identifier: "
|
|
1442
|
+
identifier: "GetSynonymSetResponse",
|
|
1723
1443
|
});
|
|
1724
|
-
export const
|
|
1444
|
+
export const GetSynonymSetItemRequest = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
1725
1445
|
synonymSetName: S.String.pipe(T.Label()),
|
|
1726
1446
|
itemId: S.String.pipe(T.Label()),
|
|
1727
1447
|
}).pipe(T.Http({
|
|
@@ -1729,77 +1449,354 @@ export const RetrieveSynonymSetItemRequest = /*@__PURE__*/ S.suspend(() => S.Str
|
|
|
1729
1449
|
uri: "/synonym_sets/{synonymSetName}/items/{itemId}",
|
|
1730
1450
|
code: 200,
|
|
1731
1451
|
}))).annotate({
|
|
1732
|
-
identifier: "
|
|
1452
|
+
identifier: "GetSynonymSetItemRequest",
|
|
1733
1453
|
});
|
|
1734
|
-
export const
|
|
1735
|
-
export const
|
|
1454
|
+
export const GetSynonymSetItemResponseSynonymsList = /*@__PURE__*/ S.Array(S.String);
|
|
1455
|
+
export const GetSynonymSetItemResponseSymbolsToIndexList =
|
|
1736
1456
|
/*@__PURE__*/ S.Array(S.String);
|
|
1737
|
-
export const
|
|
1457
|
+
export const GetSynonymSetItemResponse = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
1738
1458
|
id: S.String,
|
|
1739
|
-
synonyms:
|
|
1459
|
+
synonyms: GetSynonymSetItemResponseSynonymsList,
|
|
1740
1460
|
root: S.optional(S.String),
|
|
1741
1461
|
locale: S.optional(S.String),
|
|
1742
|
-
symbols_to_index: S.optional(
|
|
1462
|
+
symbols_to_index: S.optional(GetSynonymSetItemResponseSymbolsToIndexList),
|
|
1743
1463
|
})).annotate({
|
|
1744
|
-
identifier: "
|
|
1464
|
+
identifier: "GetSynonymSetItemResponse",
|
|
1745
1465
|
});
|
|
1746
|
-
export const
|
|
1466
|
+
export const GetSynonymSetItemsRequest = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
1747
1467
|
synonymSetName: S.String.pipe(T.Label()),
|
|
1748
1468
|
}).pipe(T.Http({
|
|
1749
1469
|
method: "GET",
|
|
1750
1470
|
uri: "/synonym_sets/{synonymSetName}/items",
|
|
1751
1471
|
code: 200,
|
|
1752
1472
|
}))).annotate({
|
|
1753
|
-
identifier: "
|
|
1473
|
+
identifier: "GetSynonymSetItemsRequest",
|
|
1754
1474
|
});
|
|
1755
|
-
export const
|
|
1756
|
-
export const
|
|
1757
|
-
identifier: "
|
|
1475
|
+
export const GetSynonymSetItemsResponseBodyList = /*@__PURE__*/ S.Array(SynonymItemSchema);
|
|
1476
|
+
export const GetSynonymSetItemsResponse = /*@__PURE__*/ S.suspend(() => GetSynonymSetItemsResponseBodyList.pipe(T.RawResponseRoot())).annotate({
|
|
1477
|
+
identifier: "GetSynonymSetItemsResponse",
|
|
1758
1478
|
});
|
|
1759
|
-
export const
|
|
1760
|
-
identifier: "
|
|
1479
|
+
export const GetSynonymSetsRequest = /*@__PURE__*/ S.suspend(() => S.Struct({}).pipe(T.Http({ method: "GET", uri: "/synonym_sets", code: 200 }))).annotate({
|
|
1480
|
+
identifier: "GetSynonymSetsRequest",
|
|
1761
1481
|
});
|
|
1762
1482
|
export const SynonymSetSchemaItemsList = /*@__PURE__*/ S.Array(SynonymItemSchema);
|
|
1763
1483
|
export const SynonymSetSchema = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
1764
1484
|
items: SynonymSetSchemaItemsList,
|
|
1765
1485
|
name: S.String,
|
|
1766
1486
|
})).annotate({
|
|
1767
|
-
identifier: "SynonymSetSchema",
|
|
1768
|
-
});
|
|
1769
|
-
export const
|
|
1770
|
-
export const
|
|
1771
|
-
identifier: "
|
|
1487
|
+
identifier: "SynonymSetSchema",
|
|
1488
|
+
});
|
|
1489
|
+
export const GetSynonymSetsResponseBodyList = /*@__PURE__*/ S.Array(SynonymSetSchema);
|
|
1490
|
+
export const GetSynonymSetsResponse = /*@__PURE__*/ S.suspend(() => GetSynonymSetsResponseBodyList.pipe(T.RawResponseRoot())).annotate({
|
|
1491
|
+
identifier: "GetSynonymSetsResponse",
|
|
1492
|
+
});
|
|
1493
|
+
export const HealthRequest = /*@__PURE__*/ S.suspend(() => S.Struct({}).pipe(T.Http({ method: "GET", uri: "/health", code: 200 }))).annotate({ identifier: "HealthRequest" });
|
|
1494
|
+
export const HealthStatus = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
1495
|
+
ok: S.Boolean,
|
|
1496
|
+
})).annotate({ identifier: "HealthStatus" });
|
|
1497
|
+
export const IndexAction = S.String;
|
|
1498
|
+
export const DirtyValues = S.String;
|
|
1499
|
+
export const ImportDocumentsRequestImportDocumentsParameters =
|
|
1500
|
+
/*@__PURE__*/ S.suspend(() => S.Struct({
|
|
1501
|
+
batch_size: S.optional(S.Number),
|
|
1502
|
+
return_id: S.optional(S.Boolean),
|
|
1503
|
+
remote_embedding_batch_size: S.optional(S.Number),
|
|
1504
|
+
return_doc: S.optional(S.Boolean),
|
|
1505
|
+
action: S.optional(IndexAction),
|
|
1506
|
+
dirty_values: S.optional(DirtyValues),
|
|
1507
|
+
})).annotate({
|
|
1508
|
+
identifier: "ImportDocumentsRequestImportDocumentsParameters",
|
|
1509
|
+
});
|
|
1510
|
+
export const ImportDocumentsRequest = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
1511
|
+
collectionName: S.String.pipe(T.Label()),
|
|
1512
|
+
importDocumentsParameters: S.optional(ImportDocumentsRequestImportDocumentsParameters.pipe(T.Query())),
|
|
1513
|
+
}).pipe(T.Http({
|
|
1514
|
+
method: "POST",
|
|
1515
|
+
uri: "/collections/{collectionName}/documents/import",
|
|
1516
|
+
code: 200,
|
|
1517
|
+
}))).annotate({
|
|
1518
|
+
identifier: "ImportDocumentsRequest",
|
|
1519
|
+
});
|
|
1520
|
+
export const ImportDocumentsResponse = /*@__PURE__*/ S.suspend(() => S.Struct({})).annotate({
|
|
1521
|
+
identifier: "ImportDocumentsResponse",
|
|
1522
|
+
});
|
|
1523
|
+
export const ImportStemmingDictionaryRequest = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
1524
|
+
id: S.String.pipe(T.Query()),
|
|
1525
|
+
body: S.String.pipe(T.HttpBody()),
|
|
1526
|
+
}).pipe(T.Http({ method: "POST", uri: "/stemming/dictionaries/import", code: 200 }))).annotate({
|
|
1527
|
+
identifier: "ImportStemmingDictionaryRequest",
|
|
1528
|
+
});
|
|
1529
|
+
export const ImportStemmingDictionaryResponse = /*@__PURE__*/ S.suspend(() => S.Struct({})).annotate({
|
|
1530
|
+
identifier: "ImportStemmingDictionaryResponse",
|
|
1531
|
+
});
|
|
1532
|
+
export const ListDocumentRequest = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
1533
|
+
collectionName: S.String.pipe(T.Label()),
|
|
1534
|
+
action: S.optional(IndexAction.pipe(T.Query())),
|
|
1535
|
+
dirty_values: S.optional(DirtyValues.pipe(T.Query())),
|
|
1536
|
+
}).pipe(T.Http({
|
|
1537
|
+
method: "POST",
|
|
1538
|
+
uri: "/collections/{collectionName}/documents",
|
|
1539
|
+
code: 200,
|
|
1540
|
+
}))).annotate({
|
|
1541
|
+
identifier: "ListDocumentRequest",
|
|
1542
|
+
});
|
|
1543
|
+
export const ListDocumentResponse = /*@__PURE__*/ S.suspend(() => S.Unknown.pipe(T.RawResponseRoot())).annotate({
|
|
1544
|
+
identifier: "ListDocumentResponse",
|
|
1545
|
+
});
|
|
1546
|
+
export const ListStemmingDictionariesRequest = /*@__PURE__*/ S.suspend(() => S.Struct({}).pipe(T.Http({ method: "GET", uri: "/stemming/dictionaries", code: 200 }))).annotate({
|
|
1547
|
+
identifier: "ListStemmingDictionariesRequest",
|
|
1548
|
+
});
|
|
1549
|
+
export const ListStemmingDictionariesResponseDictionariesList =
|
|
1550
|
+
/*@__PURE__*/ S.Array(S.String);
|
|
1551
|
+
export const ListStemmingDictionariesResponse = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
1552
|
+
dictionaries: S.optional(ListStemmingDictionariesResponseDictionariesList),
|
|
1553
|
+
})).annotate({
|
|
1554
|
+
identifier: "ListStemmingDictionariesResponse",
|
|
1555
|
+
});
|
|
1556
|
+
export const SearchCollectionRequest = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
1557
|
+
collectionName: S.String.pipe(T.Label()),
|
|
1558
|
+
searchParameters: SearchParameters.pipe(T.Query()),
|
|
1559
|
+
}).pipe(T.Http({
|
|
1560
|
+
method: "GET",
|
|
1561
|
+
uri: "/collections/{collectionName}/documents/search",
|
|
1562
|
+
code: 200,
|
|
1563
|
+
}))).annotate({
|
|
1564
|
+
identifier: "SearchCollectionRequest",
|
|
1565
|
+
});
|
|
1566
|
+
export const FacetCountsCountsItem = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
1567
|
+
count: S.optional(S.Number),
|
|
1568
|
+
highlighted: S.optional(S.String),
|
|
1569
|
+
value: S.optional(S.String),
|
|
1570
|
+
parent: S.optional(S.Unknown),
|
|
1571
|
+
})).annotate({
|
|
1572
|
+
identifier: "FacetCountsCountsItem",
|
|
1573
|
+
});
|
|
1574
|
+
export const FacetCountsCountsList = /*@__PURE__*/ S.Array(FacetCountsCountsItem);
|
|
1575
|
+
export const FacetCountsStats = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
1576
|
+
max: S.optional(S.Number),
|
|
1577
|
+
min: S.optional(S.Number),
|
|
1578
|
+
sum: S.optional(S.Number),
|
|
1579
|
+
total_values: S.optional(S.Number),
|
|
1580
|
+
avg: S.optional(S.Number),
|
|
1581
|
+
})).annotate({
|
|
1582
|
+
identifier: "FacetCountsStats",
|
|
1583
|
+
});
|
|
1584
|
+
export const FacetCounts = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
1585
|
+
counts: S.optional(FacetCountsCountsList),
|
|
1586
|
+
field_name: S.optional(S.String),
|
|
1587
|
+
sampled: S.optional(S.Boolean),
|
|
1588
|
+
stats: S.optional(FacetCountsStats),
|
|
1589
|
+
})).annotate({ identifier: "FacetCounts" });
|
|
1590
|
+
export const SearchResultFacetCountsList = /*@__PURE__*/ S.Array(FacetCounts);
|
|
1591
|
+
export const SearchGroupedHitGroupKeyList = /*@__PURE__*/ S.Array(S.Unknown);
|
|
1592
|
+
export const SearchHighlightSnippetsList = /*@__PURE__*/ S.Array(S.String);
|
|
1593
|
+
export const SearchHighlightValuesList = /*@__PURE__*/ S.Array(S.String);
|
|
1594
|
+
export const SearchHighlightIndicesList = /*@__PURE__*/ S.Array(S.Number);
|
|
1595
|
+
export const SearchHighlightMatchedTokensList = /*@__PURE__*/ S.Array(S.Unknown);
|
|
1596
|
+
export const SearchHighlight = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
1597
|
+
field: S.optional(S.String),
|
|
1598
|
+
snippet: S.optional(S.String),
|
|
1599
|
+
snippets: S.optional(SearchHighlightSnippetsList),
|
|
1600
|
+
value: S.optional(S.String),
|
|
1601
|
+
values: S.optional(SearchHighlightValuesList),
|
|
1602
|
+
indices: S.optional(SearchHighlightIndicesList),
|
|
1603
|
+
matched_tokens: S.optional(SearchHighlightMatchedTokensList),
|
|
1604
|
+
})).annotate({
|
|
1605
|
+
identifier: "SearchHighlight",
|
|
1606
|
+
});
|
|
1607
|
+
export const SearchResultHitHighlightsList = /*@__PURE__*/ S.Array(SearchHighlight);
|
|
1608
|
+
export const SearchResultHitHighlightMap = /*@__PURE__*/ S.Record(S.String, S.Unknown);
|
|
1609
|
+
export const SearchResultHitDocumentMap = /*@__PURE__*/ S.Record(S.String, S.Unknown);
|
|
1610
|
+
export const SearchResultHitTextMatchInfo = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
1611
|
+
best_field_score: S.optional(S.String),
|
|
1612
|
+
best_field_weight: S.optional(S.Number),
|
|
1613
|
+
fields_matched: S.optional(S.Number),
|
|
1614
|
+
num_tokens_dropped: S.optional(S.Number),
|
|
1615
|
+
score: S.optional(S.String),
|
|
1616
|
+
tokens_matched: S.optional(S.Number),
|
|
1617
|
+
typo_prefix_score: S.optional(S.Number),
|
|
1618
|
+
})).annotate({
|
|
1619
|
+
identifier: "SearchResultHitTextMatchInfo",
|
|
1620
|
+
});
|
|
1621
|
+
export const SearchResultHitGeoDistanceMetersMap = /*@__PURE__*/ S.Record(S.String, S.Number);
|
|
1622
|
+
export const SearchResultHitHybridSearchInfo = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
1623
|
+
rank_fusion_score: S.optional(S.Number),
|
|
1624
|
+
})).annotate({
|
|
1625
|
+
identifier: "SearchResultHitHybridSearchInfo",
|
|
1626
|
+
});
|
|
1627
|
+
export const SearchResultHit = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
1628
|
+
highlights: S.optional(SearchResultHitHighlightsList),
|
|
1629
|
+
highlight: S.optional(SearchResultHitHighlightMap),
|
|
1630
|
+
document: S.optional(SearchResultHitDocumentMap),
|
|
1631
|
+
text_match: S.optional(S.Number),
|
|
1632
|
+
text_match_info: S.optional(SearchResultHitTextMatchInfo),
|
|
1633
|
+
geo_distance_meters: S.optional(SearchResultHitGeoDistanceMetersMap),
|
|
1634
|
+
vector_distance: S.optional(S.Number),
|
|
1635
|
+
hybrid_search_info: S.optional(SearchResultHitHybridSearchInfo),
|
|
1636
|
+
search_index: S.optional(S.Number),
|
|
1637
|
+
})).annotate({
|
|
1638
|
+
identifier: "SearchResultHit",
|
|
1639
|
+
});
|
|
1640
|
+
export const SearchGroupedHitHitsList = /*@__PURE__*/ S.Array(SearchResultHit);
|
|
1641
|
+
export const SearchGroupedHit = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
1642
|
+
found: S.optional(S.Number),
|
|
1643
|
+
group_key: SearchGroupedHitGroupKeyList,
|
|
1644
|
+
hits: SearchGroupedHitHitsList,
|
|
1645
|
+
})).annotate({
|
|
1646
|
+
identifier: "SearchGroupedHit",
|
|
1647
|
+
});
|
|
1648
|
+
export const SearchResultGroupedHitsList = /*@__PURE__*/ S.Array(SearchGroupedHit);
|
|
1649
|
+
export const SearchResultHitsList = /*@__PURE__*/ S.Array(SearchResultHit);
|
|
1650
|
+
export const SearchRequestParamsVoiceQuery = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
1651
|
+
transcribed_query: S.optional(S.String),
|
|
1652
|
+
})).annotate({
|
|
1653
|
+
identifier: "SearchRequestParamsVoiceQuery",
|
|
1654
|
+
});
|
|
1655
|
+
export const SearchRequestParams = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
1656
|
+
collection_name: S.String,
|
|
1657
|
+
first_q: S.optional(S.String),
|
|
1658
|
+
q: S.String,
|
|
1659
|
+
per_page: S.Number,
|
|
1660
|
+
voice_query: S.optional(SearchRequestParamsVoiceQuery),
|
|
1661
|
+
})).annotate({
|
|
1662
|
+
identifier: "SearchRequestParams",
|
|
1663
|
+
});
|
|
1664
|
+
export const SearchResultConversationConversationHistoryList =
|
|
1665
|
+
/*@__PURE__*/ S.Array(S.Unknown);
|
|
1666
|
+
export const SearchResultConversation = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
1667
|
+
answer: S.String,
|
|
1668
|
+
conversation_history: SearchResultConversationConversationHistoryList,
|
|
1669
|
+
conversation_id: S.String,
|
|
1670
|
+
query: S.String,
|
|
1671
|
+
})).annotate({
|
|
1672
|
+
identifier: "SearchResultConversation",
|
|
1673
|
+
});
|
|
1674
|
+
export const SearchResultUnionRequestParamsList = /*@__PURE__*/ S.Array(SearchRequestParams);
|
|
1675
|
+
export const SearchResultMetadataMap = /*@__PURE__*/ S.Record(S.String, S.Unknown);
|
|
1676
|
+
export const SearchResult = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
1677
|
+
facet_counts: S.optional(SearchResultFacetCountsList),
|
|
1678
|
+
found: S.optional(S.Number),
|
|
1679
|
+
found_docs: S.optional(S.Number),
|
|
1680
|
+
search_time_ms: S.optional(S.Number),
|
|
1681
|
+
out_of: S.optional(S.Number),
|
|
1682
|
+
search_cutoff: S.optional(S.Boolean),
|
|
1683
|
+
page: S.optional(S.Number),
|
|
1684
|
+
grouped_hits: S.optional(SearchResultGroupedHitsList),
|
|
1685
|
+
hits: S.optional(SearchResultHitsList),
|
|
1686
|
+
request_params: S.optional(SearchRequestParams),
|
|
1687
|
+
conversation: S.optional(SearchResultConversation),
|
|
1688
|
+
union_request_params: S.optional(SearchResultUnionRequestParamsList),
|
|
1689
|
+
metadata: S.optional(SearchResultMetadataMap),
|
|
1690
|
+
})).annotate({ identifier: "SearchResult" });
|
|
1691
|
+
export const MultiSearchParameters = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
1692
|
+
q: S.optional(S.String),
|
|
1693
|
+
query_by: S.optional(S.String),
|
|
1694
|
+
query_by_weights: S.optional(S.String),
|
|
1695
|
+
text_match_type: S.optional(S.String),
|
|
1696
|
+
prefix: S.optional(S.String),
|
|
1697
|
+
infix: S.optional(S.String),
|
|
1698
|
+
max_extra_prefix: S.optional(S.Number),
|
|
1699
|
+
max_extra_suffix: S.optional(S.Number),
|
|
1700
|
+
filter_by: S.optional(S.String),
|
|
1701
|
+
sort_by: S.optional(S.String),
|
|
1702
|
+
facet_by: S.optional(S.String),
|
|
1703
|
+
max_facet_values: S.optional(S.Number),
|
|
1704
|
+
facet_query: S.optional(S.String),
|
|
1705
|
+
num_typos: S.optional(S.String),
|
|
1706
|
+
page: S.optional(S.Number),
|
|
1707
|
+
per_page: S.optional(S.Number),
|
|
1708
|
+
limit: S.optional(S.Number),
|
|
1709
|
+
offset: S.optional(S.Number),
|
|
1710
|
+
group_by: S.optional(S.String),
|
|
1711
|
+
group_limit: S.optional(S.Number),
|
|
1712
|
+
group_missing_values: S.optional(S.Boolean),
|
|
1713
|
+
include_fields: S.optional(S.String),
|
|
1714
|
+
exclude_fields: S.optional(S.String),
|
|
1715
|
+
highlight_full_fields: S.optional(S.String),
|
|
1716
|
+
highlight_affix_num_tokens: S.optional(S.Number),
|
|
1717
|
+
highlight_start_tag: S.optional(S.String),
|
|
1718
|
+
highlight_end_tag: S.optional(S.String),
|
|
1719
|
+
snippet_threshold: S.optional(S.Number),
|
|
1720
|
+
drop_tokens_threshold: S.optional(S.Number),
|
|
1721
|
+
drop_tokens_mode: S.optional(DropTokensMode),
|
|
1722
|
+
typo_tokens_threshold: S.optional(S.Number),
|
|
1723
|
+
enable_typos_for_alpha_numerical_tokens: S.optional(S.Boolean),
|
|
1724
|
+
filter_curated_hits: S.optional(S.Boolean),
|
|
1725
|
+
enable_synonyms: S.optional(S.Boolean),
|
|
1726
|
+
enable_analytics: S.optional(S.Boolean),
|
|
1727
|
+
synonym_prefix: S.optional(S.Boolean),
|
|
1728
|
+
synonym_num_typos: S.optional(S.Number),
|
|
1729
|
+
pinned_hits: S.optional(S.String),
|
|
1730
|
+
hidden_hits: S.optional(S.String),
|
|
1731
|
+
curation_tags: S.optional(S.String),
|
|
1732
|
+
highlight_fields: S.optional(S.String),
|
|
1733
|
+
pre_segmented_query: S.optional(S.Boolean),
|
|
1734
|
+
preset: S.optional(S.String),
|
|
1735
|
+
enable_curations: S.optional(S.Boolean),
|
|
1736
|
+
prioritize_exact_match: S.optional(S.Boolean),
|
|
1737
|
+
prioritize_token_position: S.optional(S.Boolean),
|
|
1738
|
+
prioritize_num_matching_fields: S.optional(S.Boolean),
|
|
1739
|
+
enable_typos_for_numerical_tokens: S.optional(S.Boolean),
|
|
1740
|
+
exhaustive_search: S.optional(S.Boolean),
|
|
1741
|
+
search_cutoff_ms: S.optional(S.Number),
|
|
1742
|
+
use_cache: S.optional(S.Boolean),
|
|
1743
|
+
cache_ttl: S.optional(S.Number),
|
|
1744
|
+
min_len_1typo: S.optional(S.Number),
|
|
1745
|
+
min_len_2typo: S.optional(S.Number),
|
|
1746
|
+
vector_query: S.optional(S.String),
|
|
1747
|
+
remote_embedding_timeout_ms: S.optional(S.Number),
|
|
1748
|
+
remote_embedding_num_tries: S.optional(S.Number),
|
|
1749
|
+
facet_strategy: S.optional(S.String),
|
|
1750
|
+
stopwords: S.optional(S.String),
|
|
1751
|
+
facet_return_parent: S.optional(S.String),
|
|
1752
|
+
voice_query: S.optional(S.String),
|
|
1753
|
+
conversation: S.optional(S.Boolean),
|
|
1754
|
+
conversation_model_id: S.optional(S.String),
|
|
1755
|
+
conversation_id: S.optional(S.String),
|
|
1756
|
+
validate_field_names: S.optional(S.Boolean),
|
|
1757
|
+
})).annotate({
|
|
1758
|
+
identifier: "MultiSearchParameters",
|
|
1772
1759
|
});
|
|
1773
|
-
export const
|
|
1774
|
-
|
|
1775
|
-
|
|
1776
|
-
|
|
1777
|
-
|
|
1778
|
-
|
|
1779
|
-
|
|
1780
|
-
}))).annotate({
|
|
1781
|
-
identifier: "SearchCollectionRequest",
|
|
1760
|
+
export const SearchMultiRequestSearchesList = /*@__PURE__*/ S.Array(MultiSearchCollectionParameters);
|
|
1761
|
+
export const SearchMultiRequest = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
1762
|
+
multiSearchParameters: MultiSearchParameters.pipe(T.Query()),
|
|
1763
|
+
union: S.optional(S.Boolean),
|
|
1764
|
+
searches: SearchMultiRequestSearchesList,
|
|
1765
|
+
}).pipe(T.Http({ method: "POST", uri: "/multi_search", code: 200 }))).annotate({
|
|
1766
|
+
identifier: "SearchMultiRequest",
|
|
1782
1767
|
});
|
|
1783
|
-
export const
|
|
1784
|
-
export const
|
|
1785
|
-
export const
|
|
1786
|
-
export const
|
|
1787
|
-
|
|
1788
|
-
export const
|
|
1789
|
-
|
|
1768
|
+
export const MultiSearchResultItemFacetCountsList = /*@__PURE__*/ S.Array(FacetCounts);
|
|
1769
|
+
export const MultiSearchResultItemGroupedHitsList = /*@__PURE__*/ S.Array(SearchGroupedHit);
|
|
1770
|
+
export const MultiSearchResultItemHitsList = /*@__PURE__*/ S.Array(SearchResultHit);
|
|
1771
|
+
export const MultiSearchResultItemUnionRequestParamsList =
|
|
1772
|
+
/*@__PURE__*/ S.Array(SearchRequestParams);
|
|
1773
|
+
export const MultiSearchResultItemMetadataMap = /*@__PURE__*/ S.Record(S.String, S.Unknown);
|
|
1774
|
+
export const MultiSearchResultItem = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
1775
|
+
facet_counts: S.optional(MultiSearchResultItemFacetCountsList),
|
|
1790
1776
|
found: S.optional(S.Number),
|
|
1791
1777
|
found_docs: S.optional(S.Number),
|
|
1792
1778
|
search_time_ms: S.optional(S.Number),
|
|
1793
1779
|
out_of: S.optional(S.Number),
|
|
1794
1780
|
search_cutoff: S.optional(S.Boolean),
|
|
1795
1781
|
page: S.optional(S.Number),
|
|
1796
|
-
grouped_hits: S.optional(
|
|
1797
|
-
hits: S.optional(
|
|
1782
|
+
grouped_hits: S.optional(MultiSearchResultItemGroupedHitsList),
|
|
1783
|
+
hits: S.optional(MultiSearchResultItemHitsList),
|
|
1798
1784
|
request_params: S.optional(SearchRequestParams),
|
|
1799
1785
|
conversation: S.optional(SearchResultConversation),
|
|
1800
|
-
union_request_params: S.optional(
|
|
1801
|
-
metadata: S.optional(
|
|
1802
|
-
|
|
1786
|
+
union_request_params: S.optional(MultiSearchResultItemUnionRequestParamsList),
|
|
1787
|
+
metadata: S.optional(MultiSearchResultItemMetadataMap),
|
|
1788
|
+
code: S.optional(S.Number),
|
|
1789
|
+
error: S.optional(S.String),
|
|
1790
|
+
})).annotate({
|
|
1791
|
+
identifier: "MultiSearchResultItem",
|
|
1792
|
+
});
|
|
1793
|
+
export const MultiSearchResultResultsList = /*@__PURE__*/ S.Array(MultiSearchResultItem);
|
|
1794
|
+
export const MultiSearchResult = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
1795
|
+
results: MultiSearchResultResultsList,
|
|
1796
|
+
conversation: S.optional(SearchResultConversation),
|
|
1797
|
+
})).annotate({
|
|
1798
|
+
identifier: "MultiSearchResult",
|
|
1799
|
+
});
|
|
1803
1800
|
export const TakeSnapshotRequest = /*@__PURE__*/ S.suspend(() => S.Struct({
|
|
1804
1801
|
snapshot_path: S.String.pipe(T.Query()),
|
|
1805
1802
|
}).pipe(T.Http({ method: "POST", uri: "/operations/snapshot", code: 200 }))).annotate({
|
|
@@ -2498,6 +2495,30 @@ export const getAliases = /*@__PURE__*/ API.make(() => ({
|
|
|
2498
2495
|
protocol: TypesenseProtocol,
|
|
2499
2496
|
retry: Retry.Retry,
|
|
2500
2497
|
}));
|
|
2498
|
+
/** List all conversation models Retrieve all conversation models */
|
|
2499
|
+
export const getAllConversationModels = /*@__PURE__*/ API.make(() => ({
|
|
2500
|
+
input: GetAllConversationModelsRequest,
|
|
2501
|
+
output: GetAllConversationModelsResponse,
|
|
2502
|
+
errors: [],
|
|
2503
|
+
protocol: TypesenseProtocol,
|
|
2504
|
+
retry: Retry.Retry,
|
|
2505
|
+
}));
|
|
2506
|
+
/** List all NL search models Retrieve all NL search models. */
|
|
2507
|
+
export const getAllNLSearchModels = /*@__PURE__*/ API.make(() => ({
|
|
2508
|
+
input: GetAllNLSearchModelsRequest,
|
|
2509
|
+
output: GetAllNLSearchModelsResponse,
|
|
2510
|
+
errors: [],
|
|
2511
|
+
protocol: TypesenseProtocol,
|
|
2512
|
+
retry: Retry.Retry,
|
|
2513
|
+
}));
|
|
2514
|
+
/** Retrieves all presets. Retrieve the details of all presets */
|
|
2515
|
+
export const getAllPresets = /*@__PURE__*/ API.make(() => ({
|
|
2516
|
+
input: GetAllPresetsRequest,
|
|
2517
|
+
output: PresetsRetrieveSchema,
|
|
2518
|
+
errors: [],
|
|
2519
|
+
protocol: TypesenseProtocol,
|
|
2520
|
+
retry: Retry.Retry,
|
|
2521
|
+
}));
|
|
2501
2522
|
/** Retrieve analytics events Retrieve the most recent events for a user and rule. */
|
|
2502
2523
|
export const getAnalyticsEvents = /*@__PURE__*/ API.make(() => ({
|
|
2503
2524
|
input: GetAnalyticsEventsRequest,
|
|
@@ -2506,6 +2527,22 @@ export const getAnalyticsEvents = /*@__PURE__*/ API.make(() => ({
|
|
|
2506
2527
|
protocol: TypesenseProtocol,
|
|
2507
2528
|
retry: Retry.Retry,
|
|
2508
2529
|
}));
|
|
2530
|
+
/** Retrieves an analytics rule Retrieve the details of an analytics rule, given it's name */
|
|
2531
|
+
export const getAnalyticsRule = /*@__PURE__*/ API.make(() => ({
|
|
2532
|
+
input: GetAnalyticsRuleRequest,
|
|
2533
|
+
output: GetAnalyticsRuleResponse,
|
|
2534
|
+
errors: [NotFound],
|
|
2535
|
+
protocol: TypesenseProtocol,
|
|
2536
|
+
retry: Retry.Retry,
|
|
2537
|
+
}));
|
|
2538
|
+
/** Retrieve analytics rules Retrieve all analytics rules. Use the optional rule_tag filter to narrow down results. */
|
|
2539
|
+
export const getAnalyticsRules = /*@__PURE__*/ API.make(() => ({
|
|
2540
|
+
input: GetAnalyticsRulesRequest,
|
|
2541
|
+
output: GetAnalyticsRulesResponse,
|
|
2542
|
+
errors: [],
|
|
2543
|
+
protocol: TypesenseProtocol,
|
|
2544
|
+
retry: Retry.Retry,
|
|
2545
|
+
}));
|
|
2509
2546
|
/** Get analytics subsystem status Returns sizes of internal analytics buffers and queues. */
|
|
2510
2547
|
export const getAnalyticsStatus = /*@__PURE__*/ API.make(() => ({
|
|
2511
2548
|
input: GetAnalyticsStatusRequest,
|
|
@@ -2514,6 +2551,14 @@ export const getAnalyticsStatus = /*@__PURE__*/ API.make(() => ({
|
|
|
2514
2551
|
protocol: TypesenseProtocol,
|
|
2515
2552
|
retry: Retry.Retry,
|
|
2516
2553
|
}));
|
|
2554
|
+
/** Get stats about API endpoints. Retrieve the stats about API endpoints. */
|
|
2555
|
+
export const getAPIStats = /*@__PURE__*/ API.make(() => ({
|
|
2556
|
+
input: GetAPIStatsRequest,
|
|
2557
|
+
output: APIStatsResponse,
|
|
2558
|
+
errors: [],
|
|
2559
|
+
protocol: TypesenseProtocol,
|
|
2560
|
+
retry: Retry.Retry,
|
|
2561
|
+
}));
|
|
2517
2562
|
/** Retrieve a single collection Retrieve the details of a collection, given its name. */
|
|
2518
2563
|
export const getCollection = /*@__PURE__*/ API.make(() => ({
|
|
2519
2564
|
input: GetCollectionRequest,
|
|
@@ -2530,250 +2575,194 @@ export const getCollections = /*@__PURE__*/ API.make(() => ({
|
|
|
2530
2575
|
protocol: TypesenseProtocol,
|
|
2531
2576
|
retry: Retry.Retry,
|
|
2532
2577
|
}));
|
|
2533
|
-
/** Retrieve a
|
|
2534
|
-
export const
|
|
2535
|
-
input:
|
|
2536
|
-
output:
|
|
2578
|
+
/** Retrieve a conversation model Retrieve a conversation model */
|
|
2579
|
+
export const getConversationModel = /*@__PURE__*/ API.make(() => ({
|
|
2580
|
+
input: GetConversationModelRequest,
|
|
2581
|
+
output: GetConversationModelResponse,
|
|
2537
2582
|
errors: [NotFound],
|
|
2538
2583
|
protocol: TypesenseProtocol,
|
|
2539
2584
|
retry: Retry.Retry,
|
|
2540
2585
|
}));
|
|
2541
|
-
/** Retrieve
|
|
2542
|
-
export const
|
|
2543
|
-
input:
|
|
2544
|
-
output:
|
|
2586
|
+
/** Retrieve a curation set Retrieve a specific curation set by its name */
|
|
2587
|
+
export const getCurationSet = /*@__PURE__*/ API.make(() => ({
|
|
2588
|
+
input: GetCurationSetRequest,
|
|
2589
|
+
output: GetCurationSetResponse,
|
|
2545
2590
|
errors: [NotFound],
|
|
2546
2591
|
protocol: TypesenseProtocol,
|
|
2547
2592
|
retry: Retry.Retry,
|
|
2548
2593
|
}));
|
|
2549
|
-
/** Retrieve
|
|
2550
|
-
export const
|
|
2551
|
-
input:
|
|
2552
|
-
output:
|
|
2553
|
-
errors: [],
|
|
2554
|
-
protocol: TypesenseProtocol,
|
|
2555
|
-
retry: Retry.Retry,
|
|
2556
|
-
}));
|
|
2557
|
-
/** Get the status of in-progress schema change operations Returns the status of any ongoing schema change operations. If no schema changes are in progress, returns an empty response. */
|
|
2558
|
-
export const getSchemaChanges = /*@__PURE__*/ API.make(() => ({
|
|
2559
|
-
input: GetSchemaChangesRequest,
|
|
2560
|
-
output: GetSchemaChangesResponse,
|
|
2561
|
-
errors: [],
|
|
2562
|
-
protocol: TypesenseProtocol,
|
|
2563
|
-
retry: Retry.Retry,
|
|
2564
|
-
}));
|
|
2565
|
-
/** Retrieve a stemming dictionary Fetch details of a specific stemming dictionary. */
|
|
2566
|
-
export const getStemmingDictionary = /*@__PURE__*/ API.make(() => ({
|
|
2567
|
-
input: GetStemmingDictionaryRequest,
|
|
2568
|
-
output: StemmingDictionary,
|
|
2594
|
+
/** Retrieve a curation set item Retrieve a specific curation item by its id */
|
|
2595
|
+
export const getCurationSetItem = /*@__PURE__*/ API.make(() => ({
|
|
2596
|
+
input: GetCurationSetItemRequest,
|
|
2597
|
+
output: GetCurationSetItemResponse,
|
|
2569
2598
|
errors: [NotFound],
|
|
2570
2599
|
protocol: TypesenseProtocol,
|
|
2571
2600
|
retry: Retry.Retry,
|
|
2572
2601
|
}));
|
|
2573
|
-
/**
|
|
2574
|
-
export const
|
|
2575
|
-
input:
|
|
2576
|
-
output:
|
|
2577
|
-
errors: [],
|
|
2578
|
-
protocol: TypesenseProtocol,
|
|
2579
|
-
retry: Retry.Retry,
|
|
2580
|
-
}));
|
|
2581
|
-
/** Import documents into a collection The documents to be imported must be formatted in a newline delimited JSON structure. You can feed the output file from a Typesense export operation directly as import. */
|
|
2582
|
-
export const importDocuments = /*@__PURE__*/ API.make(() => ({
|
|
2583
|
-
input: ImportDocumentsRequest,
|
|
2584
|
-
output: ImportDocumentsResponse,
|
|
2585
|
-
errors: [BadRequest, NotFound],
|
|
2586
|
-
protocol: TypesenseProtocol,
|
|
2587
|
-
retry: Retry.Retry,
|
|
2588
|
-
}));
|
|
2589
|
-
/** Import a stemming dictionary Upload a JSONL file containing word mappings to create or update a stemming dictionary. */
|
|
2590
|
-
export const importStemmingDictionary = /*@__PURE__*/ API.make(() => ({
|
|
2591
|
-
input: ImportStemmingDictionaryRequest,
|
|
2592
|
-
output: ImportStemmingDictionaryResponse,
|
|
2593
|
-
errors: [BadRequest],
|
|
2594
|
-
protocol: TypesenseProtocol,
|
|
2595
|
-
retry: Retry.Retry,
|
|
2596
|
-
}));
|
|
2597
|
-
/** Index a document A document to be indexed in a given collection must conform to the schema of the collection. */
|
|
2598
|
-
export const indexDocument = /*@__PURE__*/ API.make(() => ({
|
|
2599
|
-
input: IndexDocumentRequest,
|
|
2600
|
-
output: IndexDocumentResponse,
|
|
2602
|
+
/** List items in a curation set Retrieve all curation items in a set */
|
|
2603
|
+
export const getCurationSetItems = /*@__PURE__*/ API.make(() => ({
|
|
2604
|
+
input: GetCurationSetItemsRequest,
|
|
2605
|
+
output: GetCurationSetItemsResponse,
|
|
2601
2606
|
errors: [NotFound],
|
|
2602
2607
|
protocol: TypesenseProtocol,
|
|
2603
2608
|
retry: Retry.Retry,
|
|
2604
2609
|
}));
|
|
2605
|
-
/** List all
|
|
2606
|
-
export const
|
|
2607
|
-
input:
|
|
2608
|
-
output:
|
|
2610
|
+
/** List all curation sets Retrieve all curation sets */
|
|
2611
|
+
export const getCurationSets = /*@__PURE__*/ API.make(() => ({
|
|
2612
|
+
input: GetCurationSetsRequest,
|
|
2613
|
+
output: GetCurationSetsResponse,
|
|
2609
2614
|
errors: [],
|
|
2610
2615
|
protocol: TypesenseProtocol,
|
|
2611
2616
|
retry: Retry.Retry,
|
|
2612
2617
|
}));
|
|
2613
|
-
/**
|
|
2614
|
-
export const
|
|
2615
|
-
input:
|
|
2616
|
-
output:
|
|
2617
|
-
errors: [
|
|
2618
|
+
/** Retrieve a document Fetch an individual document from a collection by using its ID. */
|
|
2619
|
+
export const getDocument = /*@__PURE__*/ API.make(() => ({
|
|
2620
|
+
input: GetDocumentRequest,
|
|
2621
|
+
output: GetDocumentResponse,
|
|
2622
|
+
errors: [NotFound],
|
|
2618
2623
|
protocol: TypesenseProtocol,
|
|
2619
2624
|
retry: Retry.Retry,
|
|
2620
2625
|
}));
|
|
2621
|
-
/**
|
|
2622
|
-
export const
|
|
2623
|
-
input:
|
|
2624
|
-
output:
|
|
2625
|
-
errors: [],
|
|
2626
|
+
/** Retrieve (metadata about) a key Retrieve (metadata about) a key. Only the key prefix is returned when you retrieve a key. Due to security reasons, only the create endpoint returns the full API key. */
|
|
2627
|
+
export const getKey = /*@__PURE__*/ API.make(() => ({
|
|
2628
|
+
input: GetKeyRequest,
|
|
2629
|
+
output: GetKeyResponse,
|
|
2630
|
+
errors: [NotFound],
|
|
2626
2631
|
protocol: TypesenseProtocol,
|
|
2627
2632
|
retry: Retry.Retry,
|
|
2628
2633
|
}));
|
|
2629
|
-
/**
|
|
2630
|
-
export const
|
|
2631
|
-
input:
|
|
2632
|
-
output:
|
|
2634
|
+
/** Retrieve (metadata about) all keys. */
|
|
2635
|
+
export const getKeys = /*@__PURE__*/ API.make(() => ({
|
|
2636
|
+
input: GetKeysRequest,
|
|
2637
|
+
output: ApiKeysResponse,
|
|
2633
2638
|
errors: [],
|
|
2634
2639
|
protocol: TypesenseProtocol,
|
|
2635
2640
|
retry: Retry.Retry,
|
|
2636
2641
|
}));
|
|
2637
|
-
/**
|
|
2638
|
-
export const
|
|
2639
|
-
input:
|
|
2640
|
-
output:
|
|
2642
|
+
/** Get current RAM, CPU, Disk & Network usage metrics. Retrieve the metrics. */
|
|
2643
|
+
export const getMetrics = /*@__PURE__*/ API.make(() => ({
|
|
2644
|
+
input: GetMetricsRequest,
|
|
2645
|
+
output: GetMetricsResponse,
|
|
2641
2646
|
errors: [],
|
|
2642
2647
|
protocol: TypesenseProtocol,
|
|
2643
2648
|
retry: Retry.Retry,
|
|
2644
2649
|
}));
|
|
2645
|
-
/**
|
|
2646
|
-
export const
|
|
2647
|
-
input:
|
|
2648
|
-
output:
|
|
2650
|
+
/** Retrieve a NL search model Retrieve a specific NL search model by its ID. */
|
|
2651
|
+
export const getNLSearchModel = /*@__PURE__*/ API.make(() => ({
|
|
2652
|
+
input: GetNLSearchModelRequest,
|
|
2653
|
+
output: GetNLSearchModelResponse,
|
|
2649
2654
|
errors: [NotFound],
|
|
2650
2655
|
protocol: TypesenseProtocol,
|
|
2651
2656
|
retry: Retry.Retry,
|
|
2652
2657
|
}));
|
|
2653
|
-
/**
|
|
2654
|
-
export const
|
|
2655
|
-
input:
|
|
2656
|
-
output:
|
|
2657
|
-
errors: [],
|
|
2658
|
-
protocol: TypesenseProtocol,
|
|
2659
|
-
retry: Retry.Retry,
|
|
2660
|
-
}));
|
|
2661
|
-
/** Get stats about API endpoints. Retrieve the stats about API endpoints. */
|
|
2662
|
-
export const retrieveAPIStats = /*@__PURE__*/ API.make(() => ({
|
|
2663
|
-
input: RetrieveAPIStatsRequest,
|
|
2664
|
-
output: APIStatsResponse,
|
|
2665
|
-
errors: [],
|
|
2666
|
-
protocol: TypesenseProtocol,
|
|
2667
|
-
retry: Retry.Retry,
|
|
2668
|
-
}));
|
|
2669
|
-
/** Retrieve a conversation model Retrieve a conversation model */
|
|
2670
|
-
export const retrieveConversationModel = /*@__PURE__*/ API.make(() => ({
|
|
2671
|
-
input: RetrieveConversationModelRequest,
|
|
2672
|
-
output: RetrieveConversationModelResponse,
|
|
2658
|
+
/** Retrieves a preset. Retrieve the details of a preset, given it's name. */
|
|
2659
|
+
export const getPreset = /*@__PURE__*/ API.make(() => ({
|
|
2660
|
+
input: GetPresetRequest,
|
|
2661
|
+
output: GetPresetResponse,
|
|
2673
2662
|
errors: [NotFound],
|
|
2674
2663
|
protocol: TypesenseProtocol,
|
|
2675
2664
|
retry: Retry.Retry,
|
|
2676
2665
|
}));
|
|
2677
|
-
/**
|
|
2678
|
-
export const
|
|
2679
|
-
input:
|
|
2680
|
-
output:
|
|
2681
|
-
errors: [
|
|
2666
|
+
/** Get the status of in-progress schema change operations Returns the status of any ongoing schema change operations. If no schema changes are in progress, returns an empty response. */
|
|
2667
|
+
export const getSchemaChanges = /*@__PURE__*/ API.make(() => ({
|
|
2668
|
+
input: GetSchemaChangesRequest,
|
|
2669
|
+
output: GetSchemaChangesResponse,
|
|
2670
|
+
errors: [],
|
|
2682
2671
|
protocol: TypesenseProtocol,
|
|
2683
2672
|
retry: Retry.Retry,
|
|
2684
2673
|
}));
|
|
2685
|
-
/** Retrieve a
|
|
2686
|
-
export const
|
|
2687
|
-
input:
|
|
2688
|
-
output:
|
|
2674
|
+
/** Retrieve a stemming dictionary Fetch details of a specific stemming dictionary. */
|
|
2675
|
+
export const getStemmingDictionary = /*@__PURE__*/ API.make(() => ({
|
|
2676
|
+
input: GetStemmingDictionaryRequest,
|
|
2677
|
+
output: StemmingDictionary,
|
|
2689
2678
|
errors: [NotFound],
|
|
2690
2679
|
protocol: TypesenseProtocol,
|
|
2691
2680
|
retry: Retry.Retry,
|
|
2692
2681
|
}));
|
|
2693
|
-
/**
|
|
2694
|
-
export const
|
|
2695
|
-
input:
|
|
2696
|
-
output:
|
|
2682
|
+
/** Retrieves a stopwords set. Retrieve the details of a stopwords set, given it's name. */
|
|
2683
|
+
export const getStopwordsSet = /*@__PURE__*/ API.make(() => ({
|
|
2684
|
+
input: GetStopwordsSetRequest,
|
|
2685
|
+
output: StopwordsSetRetrieveSchema,
|
|
2697
2686
|
errors: [NotFound],
|
|
2698
2687
|
protocol: TypesenseProtocol,
|
|
2699
2688
|
retry: Retry.Retry,
|
|
2700
2689
|
}));
|
|
2701
|
-
/**
|
|
2702
|
-
export const
|
|
2703
|
-
input:
|
|
2704
|
-
output:
|
|
2690
|
+
/** Retrieves all stopwords sets. Retrieve the details of all stopwords sets */
|
|
2691
|
+
export const getStopwordsSets = /*@__PURE__*/ API.make(() => ({
|
|
2692
|
+
input: GetStopwordsSetsRequest,
|
|
2693
|
+
output: StopwordsSetsRetrieveAllSchema,
|
|
2705
2694
|
errors: [],
|
|
2706
2695
|
protocol: TypesenseProtocol,
|
|
2707
2696
|
retry: Retry.Retry,
|
|
2708
2697
|
}));
|
|
2709
|
-
/**
|
|
2710
|
-
export const
|
|
2711
|
-
input:
|
|
2712
|
-
output:
|
|
2713
|
-
errors: [],
|
|
2698
|
+
/** Retrieve a synonym set Retrieve a specific synonym set by its name */
|
|
2699
|
+
export const getSynonymSet = /*@__PURE__*/ API.make(() => ({
|
|
2700
|
+
input: GetSynonymSetRequest,
|
|
2701
|
+
output: GetSynonymSetResponse,
|
|
2702
|
+
errors: [NotFound],
|
|
2714
2703
|
protocol: TypesenseProtocol,
|
|
2715
2704
|
retry: Retry.Retry,
|
|
2716
2705
|
}));
|
|
2717
|
-
/** Retrieve a
|
|
2718
|
-
export const
|
|
2719
|
-
input:
|
|
2720
|
-
output:
|
|
2706
|
+
/** Retrieve a synonym set item Retrieve a specific synonym item by its id */
|
|
2707
|
+
export const getSynonymSetItem = /*@__PURE__*/ API.make(() => ({
|
|
2708
|
+
input: GetSynonymSetItemRequest,
|
|
2709
|
+
output: GetSynonymSetItemResponse,
|
|
2721
2710
|
errors: [NotFound],
|
|
2722
2711
|
protocol: TypesenseProtocol,
|
|
2723
2712
|
retry: Retry.Retry,
|
|
2724
2713
|
}));
|
|
2725
|
-
/**
|
|
2726
|
-
export const
|
|
2727
|
-
input:
|
|
2728
|
-
output:
|
|
2714
|
+
/** List items in a synonym set Retrieve all synonym items in a set */
|
|
2715
|
+
export const getSynonymSetItems = /*@__PURE__*/ API.make(() => ({
|
|
2716
|
+
input: GetSynonymSetItemsRequest,
|
|
2717
|
+
output: GetSynonymSetItemsResponse,
|
|
2729
2718
|
errors: [NotFound],
|
|
2730
2719
|
protocol: TypesenseProtocol,
|
|
2731
2720
|
retry: Retry.Retry,
|
|
2732
2721
|
}));
|
|
2733
|
-
/**
|
|
2734
|
-
export const
|
|
2735
|
-
input:
|
|
2736
|
-
output:
|
|
2737
|
-
errors: [
|
|
2722
|
+
/** List all synonym sets Retrieve all synonym sets */
|
|
2723
|
+
export const getSynonymSets = /*@__PURE__*/ API.make(() => ({
|
|
2724
|
+
input: GetSynonymSetsRequest,
|
|
2725
|
+
output: GetSynonymSetsResponse,
|
|
2726
|
+
errors: [],
|
|
2738
2727
|
protocol: TypesenseProtocol,
|
|
2739
2728
|
retry: Retry.Retry,
|
|
2740
2729
|
}));
|
|
2741
|
-
/**
|
|
2742
|
-
export const
|
|
2743
|
-
input:
|
|
2744
|
-
output:
|
|
2730
|
+
/** Checks if Typesense server is ready to accept requests. Checks if Typesense server is ready to accept requests. */
|
|
2731
|
+
export const health = /*@__PURE__*/ API.make(() => ({
|
|
2732
|
+
input: HealthRequest,
|
|
2733
|
+
output: HealthStatus,
|
|
2745
2734
|
errors: [],
|
|
2746
2735
|
protocol: TypesenseProtocol,
|
|
2747
2736
|
retry: Retry.Retry,
|
|
2748
2737
|
}));
|
|
2749
|
-
/**
|
|
2750
|
-
export const
|
|
2751
|
-
input:
|
|
2752
|
-
output:
|
|
2753
|
-
errors: [NotFound],
|
|
2738
|
+
/** Import documents into a collection The documents to be imported must be formatted in a newline delimited JSON structure. You can feed the output file from a Typesense export operation directly as import. */
|
|
2739
|
+
export const importDocuments = /*@__PURE__*/ API.make(() => ({
|
|
2740
|
+
input: ImportDocumentsRequest,
|
|
2741
|
+
output: ImportDocumentsResponse,
|
|
2742
|
+
errors: [BadRequest, NotFound],
|
|
2754
2743
|
protocol: TypesenseProtocol,
|
|
2755
2744
|
retry: Retry.Retry,
|
|
2756
2745
|
}));
|
|
2757
|
-
/**
|
|
2758
|
-
export const
|
|
2759
|
-
input:
|
|
2760
|
-
output:
|
|
2761
|
-
errors: [
|
|
2746
|
+
/** Import a stemming dictionary Upload a JSONL file containing word mappings to create or update a stemming dictionary. */
|
|
2747
|
+
export const importStemmingDictionary = /*@__PURE__*/ API.make(() => ({
|
|
2748
|
+
input: ImportStemmingDictionaryRequest,
|
|
2749
|
+
output: ImportStemmingDictionaryResponse,
|
|
2750
|
+
errors: [BadRequest],
|
|
2762
2751
|
protocol: TypesenseProtocol,
|
|
2763
2752
|
retry: Retry.Retry,
|
|
2764
2753
|
}));
|
|
2765
|
-
/**
|
|
2766
|
-
export const
|
|
2767
|
-
input:
|
|
2768
|
-
output:
|
|
2754
|
+
/** Index a document A document to be indexed in a given collection must conform to the schema of the collection. */
|
|
2755
|
+
export const listDocument = /*@__PURE__*/ API.make(() => ({
|
|
2756
|
+
input: ListDocumentRequest,
|
|
2757
|
+
output: ListDocumentResponse,
|
|
2769
2758
|
errors: [NotFound],
|
|
2770
2759
|
protocol: TypesenseProtocol,
|
|
2771
2760
|
retry: Retry.Retry,
|
|
2772
2761
|
}));
|
|
2773
|
-
/** List all
|
|
2774
|
-
export const
|
|
2775
|
-
input:
|
|
2776
|
-
output:
|
|
2762
|
+
/** List all stemming dictionaries Retrieve a list of all available stemming dictionaries. */
|
|
2763
|
+
export const listStemmingDictionaries = /*@__PURE__*/ API.make(() => ({
|
|
2764
|
+
input: ListStemmingDictionariesRequest,
|
|
2765
|
+
output: ListStemmingDictionariesResponse,
|
|
2777
2766
|
errors: [],
|
|
2778
2767
|
protocol: TypesenseProtocol,
|
|
2779
2768
|
retry: Retry.Retry,
|
|
@@ -2786,6 +2775,14 @@ export const searchCollection = /*@__PURE__*/ API.make(() => ({
|
|
|
2786
2775
|
protocol: TypesenseProtocol,
|
|
2787
2776
|
retry: Retry.Retry,
|
|
2788
2777
|
}));
|
|
2778
|
+
/** send multiple search requests in a single HTTP request This is especially useful to avoid round-trip network latencies incurred otherwise if each of these requests are sent in separate HTTP requests. You can also use this feature to do a federated search across multiple collections in a single HTTP request. */
|
|
2779
|
+
export const searchMulti = /*@__PURE__*/ API.make(() => ({
|
|
2780
|
+
input: SearchMultiRequest,
|
|
2781
|
+
output: MultiSearchResult,
|
|
2782
|
+
errors: [BadRequest],
|
|
2783
|
+
protocol: TypesenseProtocol,
|
|
2784
|
+
retry: Retry.Retry,
|
|
2785
|
+
}));
|
|
2789
2786
|
/** Creates a point-in-time snapshot of a Typesense node's state and data in the specified directory. Creates a point-in-time snapshot of a Typesense node's state and data in the specified directory. You can then backup the snapshot directory that gets created and later restore it as a data directory, as needed. */
|
|
2790
2787
|
export const takeSnapshot = /*@__PURE__*/ API.make(() => ({
|
|
2791
2788
|
input: TakeSnapshotRequest,
|