@distilled.cloud/typesense 1.0.0-rc.8 → 1.0.0-rc.9
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/services/typesense.d.ts +968 -968
- package/lib/services/typesense.d.ts.map +1 -1
- package/lib/services/typesense.js +814 -818
- package/lib/services/typesense.js.map +1 -1
- package/package.json +5 -3
- package/src/services/typesense.ts +2894 -2910
|
@@ -674,760 +674,9 @@ export interface CollectionAliasesResponse {
|
|
|
674
674
|
aliases: CollectionAliasesResponseAliasesList;
|
|
675
675
|
}
|
|
676
676
|
export declare const CollectionAliasesResponse: S.Schema<CollectionAliasesResponse>;
|
|
677
|
-
export interface
|
|
678
|
-
user_id: string;
|
|
679
|
-
/** Analytics rule name */
|
|
680
|
-
name: string;
|
|
681
|
-
/** Number of events to return (max 1000) */
|
|
682
|
-
n: number;
|
|
683
|
-
}
|
|
684
|
-
export declare const GetAnalyticsEventsRequest: S.Schema<GetAnalyticsEventsRequest>;
|
|
685
|
-
export type AnalyticsEventsResponseEventsItemDocIdsList = Array<string>;
|
|
686
|
-
export declare const AnalyticsEventsResponseEventsItemDocIdsList: S.Schema<AnalyticsEventsResponseEventsItemDocIdsList>;
|
|
687
|
-
export interface AnalyticsEventsResponseEventsItem {
|
|
688
|
-
name?: string;
|
|
689
|
-
event_type?: string;
|
|
690
|
-
collection?: string;
|
|
691
|
-
timestamp?: number;
|
|
692
|
-
user_id?: string;
|
|
693
|
-
doc_id?: string;
|
|
694
|
-
doc_ids?: AnalyticsEventsResponseEventsItemDocIdsList;
|
|
695
|
-
query?: string;
|
|
696
|
-
}
|
|
697
|
-
export declare const AnalyticsEventsResponseEventsItem: S.Schema<AnalyticsEventsResponseEventsItem>;
|
|
698
|
-
export type AnalyticsEventsResponseEventsList = Array<AnalyticsEventsResponseEventsItem>;
|
|
699
|
-
export declare const AnalyticsEventsResponseEventsList: S.Schema<AnalyticsEventsResponseEventsList>;
|
|
700
|
-
export interface AnalyticsEventsResponse {
|
|
701
|
-
events: AnalyticsEventsResponseEventsList;
|
|
702
|
-
}
|
|
703
|
-
export declare const AnalyticsEventsResponse: S.Schema<AnalyticsEventsResponse>;
|
|
704
|
-
export interface GetAnalyticsStatusRequest {
|
|
705
|
-
}
|
|
706
|
-
export declare const GetAnalyticsStatusRequest: S.Schema<GetAnalyticsStatusRequest>;
|
|
707
|
-
export interface AnalyticsStatus {
|
|
708
|
-
popular_prefix_queries?: number;
|
|
709
|
-
nohits_prefix_queries?: number;
|
|
710
|
-
log_prefix_queries?: number;
|
|
711
|
-
query_log_events?: number;
|
|
712
|
-
query_counter_events?: number;
|
|
713
|
-
doc_log_events?: number;
|
|
714
|
-
doc_counter_events?: number;
|
|
715
|
-
}
|
|
716
|
-
export declare const AnalyticsStatus: S.Schema<AnalyticsStatus>;
|
|
717
|
-
export interface GetCollectionRequest {
|
|
718
|
-
/** The name of the collection to retrieve */
|
|
719
|
-
collectionName: string;
|
|
720
|
-
}
|
|
721
|
-
export declare const GetCollectionRequest: S.Schema<GetCollectionRequest>;
|
|
722
|
-
/** A list of fields for querying, filtering and faceting */
|
|
723
|
-
export type GetCollectionResponseFieldsList = Array<Field>;
|
|
724
|
-
export declare const GetCollectionResponseFieldsList: S.Schema<GetCollectionResponseFieldsList>;
|
|
725
|
-
/** List of symbols or special characters to be used for splitting the text into individual words in addition to space and new-line characters. */
|
|
726
|
-
export type GetCollectionResponseTokenSeparatorsList = Array<string>;
|
|
727
|
-
export declare const GetCollectionResponseTokenSeparatorsList: S.Schema<GetCollectionResponseTokenSeparatorsList>;
|
|
728
|
-
/** List of synonym set names to associate with this collection */
|
|
729
|
-
export type GetCollectionResponseSynonymSetsList = Array<string>;
|
|
730
|
-
export declare const GetCollectionResponseSynonymSetsList: S.Schema<GetCollectionResponseSynonymSetsList>;
|
|
731
|
-
/** List of symbols or special characters to be indexed. */
|
|
732
|
-
export type GetCollectionResponseSymbolsToIndexList = Array<string>;
|
|
733
|
-
export declare const GetCollectionResponseSymbolsToIndexList: S.Schema<GetCollectionResponseSymbolsToIndexList>;
|
|
734
|
-
export interface GetCollectionResponse {
|
|
735
|
-
/** Name of the collection */
|
|
736
|
-
name: string;
|
|
737
|
-
/** A list of fields for querying, filtering and faceting */
|
|
738
|
-
fields: GetCollectionResponseFieldsList;
|
|
739
|
-
/** The name of an int32 / float field that determines the order in which the search results are ranked when a sort_by clause is not provided during searching. This field must indicate some kind of popularity. */
|
|
740
|
-
default_sorting_field?: string;
|
|
741
|
-
/** List of symbols or special characters to be used for splitting the text into individual words in addition to space and new-line characters. */
|
|
742
|
-
token_separators?: GetCollectionResponseTokenSeparatorsList;
|
|
743
|
-
/** List of synonym set names to associate with this collection */
|
|
744
|
-
synonym_sets?: GetCollectionResponseSynonymSetsList;
|
|
745
|
-
/** Enables experimental support at a collection level for nested object or object array fields. This field is only available if the Typesense server is version `0.24.0.rcn34` or later. */
|
|
746
|
-
enable_nested_fields?: boolean;
|
|
747
|
-
/** List of symbols or special characters to be indexed. */
|
|
748
|
-
symbols_to_index?: GetCollectionResponseSymbolsToIndexList;
|
|
749
|
-
voice_query_model?: VoiceQueryModelCollectionConfig;
|
|
750
|
-
/** Optional details about the collection, e.g., when it was created, who created it etc. */
|
|
751
|
-
metadata?: unknown;
|
|
752
|
-
/** Number of documents in the collection */
|
|
753
|
-
num_documents: number;
|
|
754
|
-
/** Timestamp of when the collection was created (Unix epoch in seconds) */
|
|
755
|
-
created_at: number;
|
|
756
|
-
}
|
|
757
|
-
export declare const GetCollectionResponse: S.Schema<GetCollectionResponse>;
|
|
758
|
-
export interface GetCollectionsRequestGetCollectionsParameters {
|
|
759
|
-
/** Comma-separated list of fields from the collection to exclude from the response */
|
|
760
|
-
exclude_fields?: string;
|
|
761
|
-
/** Number of collections to fetch. Default: returns all collections. */
|
|
762
|
-
limit?: number;
|
|
763
|
-
/** Identifies the starting point to return collections when paginating. */
|
|
764
|
-
offset?: number;
|
|
765
|
-
}
|
|
766
|
-
export declare const GetCollectionsRequestGetCollectionsParameters: S.Schema<GetCollectionsRequestGetCollectionsParameters>;
|
|
767
|
-
export interface GetCollectionsRequest {
|
|
768
|
-
getCollectionsParameters?: GetCollectionsRequestGetCollectionsParameters;
|
|
769
|
-
}
|
|
770
|
-
export declare const GetCollectionsRequest: S.Schema<GetCollectionsRequest>;
|
|
771
|
-
/** A list of fields for querying, filtering and faceting */
|
|
772
|
-
export type CollectionResponseFieldsList = Array<Field>;
|
|
773
|
-
export declare const CollectionResponseFieldsList: S.Schema<CollectionResponseFieldsList>;
|
|
774
|
-
/** List of symbols or special characters to be used for splitting the text into individual words in addition to space and new-line characters. */
|
|
775
|
-
export type CollectionResponseTokenSeparatorsList = Array<string>;
|
|
776
|
-
export declare const CollectionResponseTokenSeparatorsList: S.Schema<CollectionResponseTokenSeparatorsList>;
|
|
777
|
-
/** List of synonym set names to associate with this collection */
|
|
778
|
-
export type CollectionResponseSynonymSetsList = Array<string>;
|
|
779
|
-
export declare const CollectionResponseSynonymSetsList: S.Schema<CollectionResponseSynonymSetsList>;
|
|
780
|
-
/** List of symbols or special characters to be indexed. */
|
|
781
|
-
export type CollectionResponseSymbolsToIndexList = Array<string>;
|
|
782
|
-
export declare const CollectionResponseSymbolsToIndexList: S.Schema<CollectionResponseSymbolsToIndexList>;
|
|
783
|
-
export interface CollectionResponse {
|
|
784
|
-
/** Name of the collection */
|
|
785
|
-
name: string;
|
|
786
|
-
/** A list of fields for querying, filtering and faceting */
|
|
787
|
-
fields: CollectionResponseFieldsList;
|
|
788
|
-
/** The name of an int32 / float field that determines the order in which the search results are ranked when a sort_by clause is not provided during searching. This field must indicate some kind of popularity. */
|
|
789
|
-
default_sorting_field?: string;
|
|
790
|
-
/** List of symbols or special characters to be used for splitting the text into individual words in addition to space and new-line characters. */
|
|
791
|
-
token_separators?: CollectionResponseTokenSeparatorsList;
|
|
792
|
-
/** List of synonym set names to associate with this collection */
|
|
793
|
-
synonym_sets?: CollectionResponseSynonymSetsList;
|
|
794
|
-
/** Enables experimental support at a collection level for nested object or object array fields. This field is only available if the Typesense server is version `0.24.0.rcn34` or later. */
|
|
795
|
-
enable_nested_fields?: boolean;
|
|
796
|
-
/** List of symbols or special characters to be indexed. */
|
|
797
|
-
symbols_to_index?: CollectionResponseSymbolsToIndexList;
|
|
798
|
-
voice_query_model?: VoiceQueryModelCollectionConfig;
|
|
799
|
-
/** Optional details about the collection, e.g., when it was created, who created it etc. */
|
|
800
|
-
metadata?: unknown;
|
|
801
|
-
/** Number of documents in the collection */
|
|
802
|
-
num_documents: number;
|
|
803
|
-
/** Timestamp of when the collection was created (Unix epoch in seconds) */
|
|
804
|
-
created_at: number;
|
|
805
|
-
}
|
|
806
|
-
export declare const CollectionResponse: S.Schema<CollectionResponse>;
|
|
807
|
-
export type GetCollectionsResponseBodyList = Array<CollectionResponse>;
|
|
808
|
-
export declare const GetCollectionsResponseBodyList: S.Schema<GetCollectionsResponseBodyList>;
|
|
809
|
-
export type GetCollectionsResponse = GetCollectionsResponseBodyList;
|
|
810
|
-
export declare const GetCollectionsResponse: S.Schema<GetCollectionsResponse>;
|
|
811
|
-
export interface GetDocumentRequest {
|
|
812
|
-
/** The name of the collection to search for the document under */
|
|
813
|
-
collectionName: string;
|
|
814
|
-
/** The Document ID */
|
|
815
|
-
documentId: string;
|
|
816
|
-
}
|
|
817
|
-
export declare const GetDocumentRequest: S.Schema<GetDocumentRequest>;
|
|
818
|
-
export type GetDocumentResponse = unknown;
|
|
819
|
-
export declare const GetDocumentResponse: S.Schema<GetDocumentResponse>;
|
|
820
|
-
export interface GetKeyRequest {
|
|
821
|
-
/** The ID of the key to retrieve */
|
|
822
|
-
keyId: number;
|
|
823
|
-
}
|
|
824
|
-
export declare const GetKeyRequest: S.Schema<GetKeyRequest>;
|
|
825
|
-
export type GetKeyResponseActionsList = Array<string>;
|
|
826
|
-
export declare const GetKeyResponseActionsList: S.Schema<GetKeyResponseActionsList>;
|
|
827
|
-
export type GetKeyResponseCollectionsList = Array<string>;
|
|
828
|
-
export declare const GetKeyResponseCollectionsList: S.Schema<GetKeyResponseCollectionsList>;
|
|
829
|
-
export interface GetKeyResponse {
|
|
830
|
-
value?: string;
|
|
831
|
-
description: string;
|
|
832
|
-
actions: GetKeyResponseActionsList;
|
|
833
|
-
collections: GetKeyResponseCollectionsList;
|
|
834
|
-
expires_at?: number;
|
|
835
|
-
id?: number;
|
|
836
|
-
value_prefix?: string;
|
|
837
|
-
}
|
|
838
|
-
export declare const GetKeyResponse: S.Schema<GetKeyResponse>;
|
|
839
|
-
export interface GetKeysRequest {
|
|
840
|
-
}
|
|
841
|
-
export declare const GetKeysRequest: S.Schema<GetKeysRequest>;
|
|
842
|
-
export type ApiKeyActionsList = Array<string>;
|
|
843
|
-
export declare const ApiKeyActionsList: S.Schema<ApiKeyActionsList>;
|
|
844
|
-
export type ApiKeyCollectionsList = Array<string>;
|
|
845
|
-
export declare const ApiKeyCollectionsList: S.Schema<ApiKeyCollectionsList>;
|
|
846
|
-
export interface ApiKey {
|
|
847
|
-
value?: string;
|
|
848
|
-
description: string;
|
|
849
|
-
actions: ApiKeyActionsList;
|
|
850
|
-
collections: ApiKeyCollectionsList;
|
|
851
|
-
expires_at?: number;
|
|
852
|
-
id?: number;
|
|
853
|
-
value_prefix?: string;
|
|
854
|
-
}
|
|
855
|
-
export declare const ApiKey: S.Schema<ApiKey>;
|
|
856
|
-
export type ApiKeysResponseKeysList = Array<ApiKey>;
|
|
857
|
-
export declare const ApiKeysResponseKeysList: S.Schema<ApiKeysResponseKeysList>;
|
|
858
|
-
export interface ApiKeysResponse {
|
|
859
|
-
keys: ApiKeysResponseKeysList;
|
|
860
|
-
}
|
|
861
|
-
export declare const ApiKeysResponse: S.Schema<ApiKeysResponse>;
|
|
862
|
-
export interface GetSchemaChangesRequest {
|
|
863
|
-
}
|
|
864
|
-
export declare const GetSchemaChangesRequest: S.Schema<GetSchemaChangesRequest>;
|
|
865
|
-
export interface SchemaChangeStatus {
|
|
866
|
-
/** Name of the collection being modified */
|
|
867
|
-
collection?: string;
|
|
868
|
-
/** Number of documents that have been validated */
|
|
869
|
-
validated_docs?: number;
|
|
870
|
-
/** Number of documents that have been altered */
|
|
871
|
-
altered_docs?: number;
|
|
872
|
-
}
|
|
873
|
-
export declare const SchemaChangeStatus: S.Schema<SchemaChangeStatus>;
|
|
874
|
-
export type GetSchemaChangesResponseBodyList = Array<SchemaChangeStatus>;
|
|
875
|
-
export declare const GetSchemaChangesResponseBodyList: S.Schema<GetSchemaChangesResponseBodyList>;
|
|
876
|
-
export type GetSchemaChangesResponse = GetSchemaChangesResponseBodyList;
|
|
877
|
-
export declare const GetSchemaChangesResponse: S.Schema<GetSchemaChangesResponse>;
|
|
878
|
-
export interface GetStemmingDictionaryRequest {
|
|
879
|
-
/** The ID of the dictionary to retrieve */
|
|
880
|
-
dictionaryId: string;
|
|
881
|
-
}
|
|
882
|
-
export declare const GetStemmingDictionaryRequest: S.Schema<GetStemmingDictionaryRequest>;
|
|
883
|
-
export interface StemmingDictionaryWordsItem {
|
|
884
|
-
/** The word form to be stemmed */
|
|
885
|
-
word: string;
|
|
886
|
-
/** The root form of the word */
|
|
887
|
-
root: string;
|
|
888
|
-
}
|
|
889
|
-
export declare const StemmingDictionaryWordsItem: S.Schema<StemmingDictionaryWordsItem>;
|
|
890
|
-
/** List of word mappings in the dictionary */
|
|
891
|
-
export type StemmingDictionaryWordsList = Array<StemmingDictionaryWordsItem>;
|
|
892
|
-
export declare const StemmingDictionaryWordsList: S.Schema<StemmingDictionaryWordsList>;
|
|
893
|
-
export interface StemmingDictionary {
|
|
894
|
-
/** Unique identifier for the dictionary */
|
|
895
|
-
id: string;
|
|
896
|
-
/** List of word mappings in the dictionary */
|
|
897
|
-
words: StemmingDictionaryWordsList;
|
|
898
|
-
}
|
|
899
|
-
export declare const StemmingDictionary: S.Schema<StemmingDictionary>;
|
|
900
|
-
export interface HealthRequest {
|
|
901
|
-
}
|
|
902
|
-
export declare const HealthRequest: S.Schema<HealthRequest>;
|
|
903
|
-
export interface HealthStatus {
|
|
904
|
-
ok: boolean;
|
|
905
|
-
}
|
|
906
|
-
export declare const HealthStatus: S.Schema<HealthStatus>;
|
|
907
|
-
export type IndexAction = "create" | "update" | "upsert" | "emplace";
|
|
908
|
-
export declare const IndexAction: any;
|
|
909
|
-
export type DirtyValues = "coerce_or_reject" | "coerce_or_drop" | "drop" | "reject";
|
|
910
|
-
export declare const DirtyValues: any;
|
|
911
|
-
export interface ImportDocumentsRequestImportDocumentsParameters {
|
|
912
|
-
batch_size?: number;
|
|
913
|
-
/** Returning the id of the imported documents. If you want the import response to return the ingested document's id in the response, you can use the return_id parameter. */
|
|
914
|
-
return_id?: boolean;
|
|
915
|
-
remote_embedding_batch_size?: number;
|
|
916
|
-
return_doc?: boolean;
|
|
917
|
-
action?: IndexAction | (string & {});
|
|
918
|
-
dirty_values?: DirtyValues | (string & {});
|
|
919
|
-
}
|
|
920
|
-
export declare const ImportDocumentsRequestImportDocumentsParameters: S.Schema<ImportDocumentsRequestImportDocumentsParameters>;
|
|
921
|
-
export interface ImportDocumentsRequest {
|
|
922
|
-
/** The name of the collection */
|
|
923
|
-
collectionName: string;
|
|
924
|
-
importDocumentsParameters?: ImportDocumentsRequestImportDocumentsParameters;
|
|
925
|
-
}
|
|
926
|
-
export declare const ImportDocumentsRequest: S.Schema<ImportDocumentsRequest>;
|
|
927
|
-
export interface ImportDocumentsResponse {
|
|
928
|
-
}
|
|
929
|
-
export declare const ImportDocumentsResponse: S.Schema<ImportDocumentsResponse>;
|
|
930
|
-
export interface ImportStemmingDictionaryRequest {
|
|
931
|
-
/** The ID to assign to the dictionary */
|
|
932
|
-
id: string;
|
|
933
|
-
body: string;
|
|
934
|
-
}
|
|
935
|
-
export declare const ImportStemmingDictionaryRequest: S.Schema<ImportStemmingDictionaryRequest>;
|
|
936
|
-
export interface ImportStemmingDictionaryResponse {
|
|
937
|
-
}
|
|
938
|
-
export declare const ImportStemmingDictionaryResponse: S.Schema<ImportStemmingDictionaryResponse>;
|
|
939
|
-
export interface IndexDocumentRequest {
|
|
940
|
-
/** The name of the collection to add the document to */
|
|
941
|
-
collectionName: string;
|
|
942
|
-
/** Additional action to perform */
|
|
943
|
-
action?: IndexAction | (string & {});
|
|
944
|
-
/** Dealing with Dirty Data */
|
|
945
|
-
dirty_values?: DirtyValues | (string & {});
|
|
946
|
-
}
|
|
947
|
-
export declare const IndexDocumentRequest: S.Schema<IndexDocumentRequest>;
|
|
948
|
-
export type IndexDocumentResponse = unknown;
|
|
949
|
-
export declare const IndexDocumentResponse: S.Schema<IndexDocumentResponse>;
|
|
950
|
-
export interface ListStemmingDictionariesRequest {
|
|
951
|
-
}
|
|
952
|
-
export declare const ListStemmingDictionariesRequest: S.Schema<ListStemmingDictionariesRequest>;
|
|
953
|
-
export type ListStemmingDictionariesResponseDictionariesList = Array<string>;
|
|
954
|
-
export declare const ListStemmingDictionariesResponseDictionariesList: S.Schema<ListStemmingDictionariesResponseDictionariesList>;
|
|
955
|
-
export interface ListStemmingDictionariesResponse {
|
|
956
|
-
dictionaries?: ListStemmingDictionariesResponseDictionariesList;
|
|
957
|
-
}
|
|
958
|
-
export declare const ListStemmingDictionariesResponse: S.Schema<ListStemmingDictionariesResponse>;
|
|
959
|
-
/** Dictates the direction in which the words in the query must be dropped when the original words in the query do not appear in any document. Values: right_to_left (default), left_to_right, both_sides:3 A note on both_sides:3 - for queries up to 3 tokens (words) in length, this mode will drop tokens from both sides and exhaustively rank all matching results. If query length is greater than 3 words, Typesense will just fallback to default behavior of right_to_left */
|
|
960
|
-
export type DropTokensMode = "right_to_left" | "left_to_right" | "both_sides:3";
|
|
961
|
-
export declare const DropTokensMode: any;
|
|
962
|
-
/** Parameters for the multi search API. */
|
|
963
|
-
export interface MultiSearchParameters {
|
|
964
|
-
/** The query text to search for in the collection. Use * as the search string to return all documents. This is typically useful when used in conjunction with filter_by. */
|
|
965
|
-
q?: string;
|
|
966
|
-
/** A list of `string` fields that should be queried against. Multiple fields are separated with a comma. */
|
|
967
|
-
query_by?: string;
|
|
968
|
-
/** The relative weight to give each `query_by` field when ranking results. This can be used to boost fields in priority, when looking for matches. Multiple fields are separated with a comma. */
|
|
969
|
-
query_by_weights?: string;
|
|
970
|
-
/** In a multi-field matching context, this parameter determines how the representative text match score of a record is calculated. Possible values are max_score (default) or max_weight. */
|
|
971
|
-
text_match_type?: string;
|
|
972
|
-
/** Boolean field to indicate that the last word in the query should be treated as a prefix, and not as a whole word. This is used for building autocomplete and instant search interfaces. Defaults to true. */
|
|
973
|
-
prefix?: string;
|
|
974
|
-
/** If infix index is enabled for this field, infix searching can be done on a per-field basis by sending a comma separated string parameter called infix to the search query. This parameter can have 3 values; `off` infix search is disabled, which is default `always` infix search is performed along with regular search `fallback` infix search is performed if regular search does not produce results */
|
|
975
|
-
infix?: string;
|
|
976
|
-
/** There are also 2 parameters that allow you to control the extent of infix searching max_extra_prefix and max_extra_suffix which specify the maximum number of symbols before or after the query that can be present in the token. For example query "K2100" has 2 extra symbols in "6PK2100". By default, any number of prefixes/suffixes can be present for a match. */
|
|
977
|
-
max_extra_prefix?: number;
|
|
978
|
-
/** There are also 2 parameters that allow you to control the extent of infix searching max_extra_prefix and max_extra_suffix which specify the maximum number of symbols before or after the query that can be present in the token. For example query "K2100" has 2 extra symbols in "6PK2100". By default, any number of prefixes/suffixes can be present for a match. */
|
|
979
|
-
max_extra_suffix?: number;
|
|
980
|
-
/** Filter conditions for refining youropen api validator search results. Separate multiple conditions with &&. */
|
|
981
|
-
filter_by?: string;
|
|
982
|
-
/** A list of numerical fields and their corresponding sort orders that will be used for ordering your results. Up to 3 sort fields can be specified. The text similarity score is exposed as a special `_text_match` field that you can use in the list of sorting fields. If no `sort_by` parameter is specified, results are sorted by `_text_match:desc,default_sorting_field:desc` */
|
|
983
|
-
sort_by?: string;
|
|
984
|
-
/** A list of fields that will be used for faceting your results on. Separate multiple fields with a comma. */
|
|
985
|
-
facet_by?: string;
|
|
986
|
-
/** Maximum number of facet values to be returned. */
|
|
987
|
-
max_facet_values?: number;
|
|
988
|
-
/** Facet values that are returned can now be filtered via this parameter. The matching facet text is also highlighted. For example, when faceting by `category`, you can set `facet_query=category:shoe` to return only facet values that contain the prefix "shoe". */
|
|
989
|
-
facet_query?: string;
|
|
990
|
-
/** The number of typographical errors (1 or 2) that would be tolerated. Default: 2 */
|
|
991
|
-
num_typos?: string;
|
|
992
|
-
/** Results from this specific page number would be fetched. */
|
|
993
|
-
page?: number;
|
|
994
|
-
/** Number of results to fetch per page. Default: 10 */
|
|
995
|
-
per_page?: number;
|
|
996
|
-
/** Number of hits to fetch. Can be used as an alternative to the per_page parameter. Default: 10. */
|
|
997
|
-
limit?: number;
|
|
998
|
-
/** Identifies the starting point to return hits from a result set. Can be used as an alternative to the page parameter. */
|
|
999
|
-
offset?: number;
|
|
1000
|
-
/** You can aggregate search results into groups or buckets by specify one or more `group_by` fields. Separate multiple fields with a comma. To group on a particular field, it must be a faceted field. */
|
|
1001
|
-
group_by?: string;
|
|
1002
|
-
/** Maximum number of hits to be returned for every group. If the `group_limit` is set as `K` then only the top K hits in each group are returned in the response. Default: 3 */
|
|
1003
|
-
group_limit?: number;
|
|
1004
|
-
/** Setting this parameter to true will place all documents that have a null value in the group_by field, into a single group. Setting this parameter to false, will cause each document with a null value in the group_by field to not be grouped with other documents. Default: true */
|
|
1005
|
-
group_missing_values?: boolean;
|
|
1006
|
-
/** List of fields from the document to include in the search result */
|
|
1007
|
-
include_fields?: string;
|
|
1008
|
-
/** List of fields from the document to exclude in the search result */
|
|
1009
|
-
exclude_fields?: string;
|
|
1010
|
-
/** List of fields which should be highlighted fully without snippeting */
|
|
1011
|
-
highlight_full_fields?: string;
|
|
1012
|
-
/** The number of tokens that should surround the highlighted text on each side. Default: 4 */
|
|
1013
|
-
highlight_affix_num_tokens?: number;
|
|
1014
|
-
/** The start tag used for the highlighted snippets. Default: `<mark>` */
|
|
1015
|
-
highlight_start_tag?: string;
|
|
1016
|
-
/** The end tag used for the highlighted snippets. Default: `</mark>` */
|
|
1017
|
-
highlight_end_tag?: string;
|
|
1018
|
-
/** Field values under this length will be fully highlighted, instead of showing a snippet of relevant portion. Default: 30 */
|
|
1019
|
-
snippet_threshold?: number;
|
|
1020
|
-
/** If the number of results found for a specific query is less than this number, Typesense will attempt to drop the tokens in the query until enough results are found. Tokens that have the least individual hits are dropped first. Set to 0 to disable. Default: 10 */
|
|
1021
|
-
drop_tokens_threshold?: number;
|
|
1022
|
-
drop_tokens_mode?: DropTokensMode | (string & {});
|
|
1023
|
-
/** If the number of results found for a specific query is less than this number, Typesense will attempt to look for tokens with more typos until enough results are found. Default: 100 */
|
|
1024
|
-
typo_tokens_threshold?: number;
|
|
1025
|
-
/** Set this parameter to false to disable typos on alphanumerical query tokens. Default: true. */
|
|
1026
|
-
enable_typos_for_alpha_numerical_tokens?: boolean;
|
|
1027
|
-
/** Whether the filter_by condition of the search query should be applicable to curated results (curation definitions, pinned hits, hidden hits, etc.). Default: false */
|
|
1028
|
-
filter_curated_hits?: boolean;
|
|
1029
|
-
/** If you have some synonyms defined but want to disable all of them for a particular search query, set enable_synonyms to false. Default: true */
|
|
1030
|
-
enable_synonyms?: boolean;
|
|
1031
|
-
/** Flag for enabling/disabling analytics aggregation for specific search queries (for e.g. those originating from a test script). */
|
|
1032
|
-
enable_analytics?: boolean;
|
|
1033
|
-
/** Allow synonym resolution on word prefixes in the query. Default: false */
|
|
1034
|
-
synonym_prefix?: boolean;
|
|
1035
|
-
/** Allow synonym resolution on typo-corrected words in the query. Default: 0 */
|
|
1036
|
-
synonym_num_typos?: number;
|
|
1037
|
-
/** A list of records to unconditionally include in the search results at specific positions. An example use case would be to feature or promote certain items on the top of search results. A list of `record_id:hit_position`. Eg: to include a record with ID 123 at Position 1 and another record with ID 456 at Position 5, you'd specify `123:1,456:5`. You could also use the Curation feature to override search results based on rules. Curations are applied first, followed by `pinned_hits` and finally `hidden_hits`. */
|
|
1038
|
-
pinned_hits?: string;
|
|
1039
|
-
/** A list of records to unconditionally hide from search results. A list of `record_id`s to hide. Eg: to hide records with IDs 123 and 456, you'd specify `123,456`. You could also use the Curation feature to override search results based on rules. Curations are applied first, followed by `pinned_hits` and finally `hidden_hits`. */
|
|
1040
|
-
hidden_hits?: string;
|
|
1041
|
-
/** Comma separated list of tags to trigger the curations rules that match the tags. */
|
|
1042
|
-
curation_tags?: string;
|
|
1043
|
-
/** A list of custom fields that must be highlighted even if you don't query for them */
|
|
1044
|
-
highlight_fields?: string;
|
|
1045
|
-
/** You can index content from any logographic language into Typesense if you are able to segment / split the text into space-separated words yourself before indexing and querying. Set this parameter to true to do the same */
|
|
1046
|
-
pre_segmented_query?: boolean;
|
|
1047
|
-
/** Search using a bunch of search parameters by setting this parameter to the name of the existing Preset. */
|
|
1048
|
-
preset?: string;
|
|
1049
|
-
/** If you have some curation sets defined but want to disable all of them during query time, you can do that by setting this parameter to false */
|
|
1050
|
-
enable_curations?: boolean;
|
|
1051
|
-
/** Set this parameter to true to ensure that an exact match is ranked above the others */
|
|
1052
|
-
prioritize_exact_match?: boolean;
|
|
1053
|
-
/** Make Typesense prioritize documents where the query words appear earlier in the text. */
|
|
1054
|
-
prioritize_token_position?: boolean;
|
|
1055
|
-
/** Make Typesense prioritize documents where the query words appear in more number of fields. */
|
|
1056
|
-
prioritize_num_matching_fields?: boolean;
|
|
1057
|
-
/** Make Typesense disable typos for numerical tokens. */
|
|
1058
|
-
enable_typos_for_numerical_tokens?: boolean;
|
|
1059
|
-
/** Setting this to true will make Typesense consider all prefixes and typo corrections of the words in the query without stopping early when enough results are found (drop_tokens_threshold and typo_tokens_threshold configurations are ignored). */
|
|
1060
|
-
exhaustive_search?: boolean;
|
|
1061
|
-
/** Typesense will attempt to return results early if the cutoff time has elapsed. This is not a strict guarantee and facet computation is not bound by this parameter. */
|
|
1062
|
-
search_cutoff_ms?: number;
|
|
1063
|
-
/** Enable server side caching of search query results. By default, caching is disabled. */
|
|
1064
|
-
use_cache?: boolean;
|
|
1065
|
-
/** The duration (in seconds) that determines how long the search query is cached. This value can be set on a per-query basis. Default: 60. */
|
|
1066
|
-
cache_ttl?: number;
|
|
1067
|
-
/** Minimum word length for 1-typo correction to be applied. The value of num_typos is still treated as the maximum allowed typos. */
|
|
1068
|
-
min_len_1typo?: number;
|
|
1069
|
-
/** Minimum word length for 2-typo correction to be applied. The value of num_typos is still treated as the maximum allowed typos. */
|
|
1070
|
-
min_len_2typo?: number;
|
|
1071
|
-
/** Vector query expression for fetching documents "closest" to a given query/document vector. */
|
|
1072
|
-
vector_query?: string;
|
|
1073
|
-
/** Timeout (in milliseconds) for fetching remote embeddings. */
|
|
1074
|
-
remote_embedding_timeout_ms?: number;
|
|
1075
|
-
/** Number of times to retry fetching remote embeddings. */
|
|
1076
|
-
remote_embedding_num_tries?: number;
|
|
1077
|
-
/** Choose the underlying faceting strategy used. Comma separated string of allows values: exhaustive, top_values or automatic (default). */
|
|
1078
|
-
facet_strategy?: string;
|
|
1079
|
-
/** Name of the stopwords set to apply for this search, the keywords present in the set will be removed from the search query. */
|
|
1080
|
-
stopwords?: string;
|
|
1081
|
-
/** Comma separated string of nested facet fields whose parent object should be returned in facet response. */
|
|
1082
|
-
facet_return_parent?: string;
|
|
1083
|
-
/** The base64 encoded audio file in 16 khz 16-bit WAV format. */
|
|
1084
|
-
voice_query?: string;
|
|
1085
|
-
/** Enable conversational search. */
|
|
1086
|
-
conversation?: boolean;
|
|
1087
|
-
/** The Id of Conversation Model to be used. */
|
|
1088
|
-
conversation_model_id?: string;
|
|
1089
|
-
/** The Id of a previous conversation to continue, this tells Typesense to include prior context when communicating with the LLM. */
|
|
1090
|
-
conversation_id?: string;
|
|
1091
|
-
/** Controls whether Typesense should validate if the fields exist in the schema. When set to false, Typesense will not throw an error if a field is missing. This is useful for programmatic grouping where not all fields may exist. */
|
|
1092
|
-
validate_field_names?: boolean;
|
|
1093
|
-
}
|
|
1094
|
-
export declare const MultiSearchParameters: S.Schema<MultiSearchParameters>;
|
|
1095
|
-
export interface MultiSearchCollectionParameters {
|
|
1096
|
-
/** The query text to search for in the collection. Use * as the search string to return all documents. This is typically useful when used in conjunction with filter_by. */
|
|
1097
|
-
q?: string;
|
|
1098
|
-
/** A list of `string` fields that should be queried against. Multiple fields are separated with a comma. */
|
|
1099
|
-
query_by?: string;
|
|
1100
|
-
/** The relative weight to give each `query_by` field when ranking results. This can be used to boost fields in priority, when looking for matches. Multiple fields are separated with a comma. */
|
|
1101
|
-
query_by_weights?: string;
|
|
1102
|
-
/** In a multi-field matching context, this parameter determines how the representative text match score of a record is calculated. Possible values are max_score (default) or max_weight. */
|
|
1103
|
-
text_match_type?: string;
|
|
1104
|
-
/** Boolean field to indicate that the last word in the query should be treated as a prefix, and not as a whole word. This is used for building autocomplete and instant search interfaces. Defaults to true. */
|
|
1105
|
-
prefix?: string;
|
|
1106
|
-
/** If infix index is enabled for this field, infix searching can be done on a per-field basis by sending a comma separated string parameter called infix to the search query. This parameter can have 3 values; `off` infix search is disabled, which is default `always` infix search is performed along with regular search `fallback` infix search is performed if regular search does not produce results */
|
|
1107
|
-
infix?: string;
|
|
1108
|
-
/** There are also 2 parameters that allow you to control the extent of infix searching max_extra_prefix and max_extra_suffix which specify the maximum number of symbols before or after the query that can be present in the token. For example query "K2100" has 2 extra symbols in "6PK2100". By default, any number of prefixes/suffixes can be present for a match. */
|
|
1109
|
-
max_extra_prefix?: number;
|
|
1110
|
-
/** There are also 2 parameters that allow you to control the extent of infix searching max_extra_prefix and max_extra_suffix which specify the maximum number of symbols before or after the query that can be present in the token. For example query "K2100" has 2 extra symbols in "6PK2100". By default, any number of prefixes/suffixes can be present for a match. */
|
|
1111
|
-
max_extra_suffix?: number;
|
|
1112
|
-
/** Filter conditions for refining youropen api validator search results. Separate multiple conditions with &&. */
|
|
1113
|
-
filter_by?: string;
|
|
1114
|
-
/** A list of numerical fields and their corresponding sort orders that will be used for ordering your results. Up to 3 sort fields can be specified. The text similarity score is exposed as a special `_text_match` field that you can use in the list of sorting fields. If no `sort_by` parameter is specified, results are sorted by `_text_match:desc,default_sorting_field:desc` */
|
|
1115
|
-
sort_by?: string;
|
|
1116
|
-
/** A list of fields that will be used for faceting your results on. Separate multiple fields with a comma. */
|
|
1117
|
-
facet_by?: string;
|
|
1118
|
-
/** Maximum number of facet values to be returned. */
|
|
1119
|
-
max_facet_values?: number;
|
|
1120
|
-
/** Facet values that are returned can now be filtered via this parameter. The matching facet text is also highlighted. For example, when faceting by `category`, you can set `facet_query=category:shoe` to return only facet values that contain the prefix "shoe". */
|
|
1121
|
-
facet_query?: string;
|
|
1122
|
-
/** The number of typographical errors (1 or 2) that would be tolerated. Default: 2 */
|
|
1123
|
-
num_typos?: string;
|
|
1124
|
-
/** Results from this specific page number would be fetched. */
|
|
1125
|
-
page?: number;
|
|
1126
|
-
/** Number of results to fetch per page. Default: 10 */
|
|
1127
|
-
per_page?: number;
|
|
1128
|
-
/** Number of hits to fetch. Can be used as an alternative to the per_page parameter. Default: 10. */
|
|
1129
|
-
limit?: number;
|
|
1130
|
-
/** Identifies the starting point to return hits from a result set. Can be used as an alternative to the page parameter. */
|
|
1131
|
-
offset?: number;
|
|
1132
|
-
/** You can aggregate search results into groups or buckets by specify one or more `group_by` fields. Separate multiple fields with a comma. To group on a particular field, it must be a faceted field. */
|
|
1133
|
-
group_by?: string;
|
|
1134
|
-
/** Maximum number of hits to be returned for every group. If the `group_limit` is set as `K` then only the top K hits in each group are returned in the response. Default: 3 */
|
|
1135
|
-
group_limit?: number;
|
|
1136
|
-
/** Setting this parameter to true will place all documents that have a null value in the group_by field, into a single group. Setting this parameter to false, will cause each document with a null value in the group_by field to not be grouped with other documents. Default: true */
|
|
1137
|
-
group_missing_values?: boolean;
|
|
1138
|
-
/** List of fields from the document to include in the search result */
|
|
1139
|
-
include_fields?: string;
|
|
1140
|
-
/** List of fields from the document to exclude in the search result */
|
|
1141
|
-
exclude_fields?: string;
|
|
1142
|
-
/** List of fields which should be highlighted fully without snippeting */
|
|
1143
|
-
highlight_full_fields?: string;
|
|
1144
|
-
/** The number of tokens that should surround the highlighted text on each side. Default: 4 */
|
|
1145
|
-
highlight_affix_num_tokens?: number;
|
|
1146
|
-
/** The start tag used for the highlighted snippets. Default: `<mark>` */
|
|
1147
|
-
highlight_start_tag?: string;
|
|
1148
|
-
/** The end tag used for the highlighted snippets. Default: `</mark>` */
|
|
1149
|
-
highlight_end_tag?: string;
|
|
1150
|
-
/** Field values under this length will be fully highlighted, instead of showing a snippet of relevant portion. Default: 30 */
|
|
1151
|
-
snippet_threshold?: number;
|
|
1152
|
-
/** If the number of results found for a specific query is less than this number, Typesense will attempt to drop the tokens in the query until enough results are found. Tokens that have the least individual hits are dropped first. Set to 0 to disable. Default: 10 */
|
|
1153
|
-
drop_tokens_threshold?: number;
|
|
1154
|
-
drop_tokens_mode?: DropTokensMode | (string & {});
|
|
1155
|
-
/** If the number of results found for a specific query is less than this number, Typesense will attempt to look for tokens with more typos until enough results are found. Default: 100 */
|
|
1156
|
-
typo_tokens_threshold?: number;
|
|
1157
|
-
/** Set this parameter to false to disable typos on alphanumerical query tokens. Default: true. */
|
|
1158
|
-
enable_typos_for_alpha_numerical_tokens?: boolean;
|
|
1159
|
-
/** Whether the filter_by condition of the search query should be applicable to curated results (curation definitions, pinned hits, hidden hits, etc.). Default: false */
|
|
1160
|
-
filter_curated_hits?: boolean;
|
|
1161
|
-
/** If you have some synonyms defined but want to disable all of them for a particular search query, set enable_synonyms to false. Default: true */
|
|
1162
|
-
enable_synonyms?: boolean;
|
|
1163
|
-
/** Flag for enabling/disabling analytics aggregation for specific search queries (for e.g. those originating from a test script). */
|
|
1164
|
-
enable_analytics?: boolean;
|
|
1165
|
-
/** Allow synonym resolution on word prefixes in the query. Default: false */
|
|
1166
|
-
synonym_prefix?: boolean;
|
|
1167
|
-
/** Allow synonym resolution on typo-corrected words in the query. Default: 0 */
|
|
1168
|
-
synonym_num_typos?: number;
|
|
1169
|
-
/** A list of records to unconditionally include in the search results at specific positions. An example use case would be to feature or promote certain items on the top of search results. A list of `record_id:hit_position`. Eg: to include a record with ID 123 at Position 1 and another record with ID 456 at Position 5, you'd specify `123:1,456:5`. You could also use the Curation feature to override search results based on rules. Curations are applied first, followed by `pinned_hits` and finally `hidden_hits`. */
|
|
1170
|
-
pinned_hits?: string;
|
|
1171
|
-
/** A list of records to unconditionally hide from search results. A list of `record_id`s to hide. Eg: to hide records with IDs 123 and 456, you'd specify `123,456`. You could also use the Curation feature to override search results based on rules. Curations are applied first, followed by `pinned_hits` and finally `hidden_hits`. */
|
|
1172
|
-
hidden_hits?: string;
|
|
1173
|
-
/** Comma separated list of tags to trigger the curations rules that match the tags. */
|
|
1174
|
-
curation_tags?: string;
|
|
1175
|
-
/** A list of custom fields that must be highlighted even if you don't query for them */
|
|
1176
|
-
highlight_fields?: string;
|
|
1177
|
-
/** You can index content from any logographic language into Typesense if you are able to segment / split the text into space-separated words yourself before indexing and querying. Set this parameter to true to do the same */
|
|
1178
|
-
pre_segmented_query?: boolean;
|
|
1179
|
-
/** Search using a bunch of search parameters by setting this parameter to the name of the existing Preset. */
|
|
1180
|
-
preset?: string;
|
|
1181
|
-
/** If you have some curation sets defined but want to disable all of them during query time, you can do that by setting this parameter to false */
|
|
1182
|
-
enable_curations?: boolean;
|
|
1183
|
-
/** Set this parameter to true to ensure that an exact match is ranked above the others */
|
|
1184
|
-
prioritize_exact_match?: boolean;
|
|
1185
|
-
/** Make Typesense prioritize documents where the query words appear earlier in the text. */
|
|
1186
|
-
prioritize_token_position?: boolean;
|
|
1187
|
-
/** Make Typesense prioritize documents where the query words appear in more number of fields. */
|
|
1188
|
-
prioritize_num_matching_fields?: boolean;
|
|
1189
|
-
/** Make Typesense disable typos for numerical tokens. */
|
|
1190
|
-
enable_typos_for_numerical_tokens?: boolean;
|
|
1191
|
-
/** Setting this to true will make Typesense consider all prefixes and typo corrections of the words in the query without stopping early when enough results are found (drop_tokens_threshold and typo_tokens_threshold configurations are ignored). */
|
|
1192
|
-
exhaustive_search?: boolean;
|
|
1193
|
-
/** Typesense will attempt to return results early if the cutoff time has elapsed. This is not a strict guarantee and facet computation is not bound by this parameter. */
|
|
1194
|
-
search_cutoff_ms?: number;
|
|
1195
|
-
/** Enable server side caching of search query results. By default, caching is disabled. */
|
|
1196
|
-
use_cache?: boolean;
|
|
1197
|
-
/** The duration (in seconds) that determines how long the search query is cached. This value can be set on a per-query basis. Default: 60. */
|
|
1198
|
-
cache_ttl?: number;
|
|
1199
|
-
/** Minimum word length for 1-typo correction to be applied. The value of num_typos is still treated as the maximum allowed typos. */
|
|
1200
|
-
min_len_1typo?: number;
|
|
1201
|
-
/** Minimum word length for 2-typo correction to be applied. The value of num_typos is still treated as the maximum allowed typos. */
|
|
1202
|
-
min_len_2typo?: number;
|
|
1203
|
-
/** Vector query expression for fetching documents "closest" to a given query/document vector. */
|
|
1204
|
-
vector_query?: string;
|
|
1205
|
-
/** Timeout (in milliseconds) for fetching remote embeddings. */
|
|
1206
|
-
remote_embedding_timeout_ms?: number;
|
|
1207
|
-
/** Number of times to retry fetching remote embeddings. */
|
|
1208
|
-
remote_embedding_num_tries?: number;
|
|
1209
|
-
/** Choose the underlying faceting strategy used. Comma separated string of allows values: exhaustive, top_values or automatic (default). */
|
|
1210
|
-
facet_strategy?: string;
|
|
1211
|
-
/** Name of the stopwords set to apply for this search, the keywords present in the set will be removed from the search query. */
|
|
1212
|
-
stopwords?: string;
|
|
1213
|
-
/** Comma separated string of nested facet fields whose parent object should be returned in facet response. */
|
|
1214
|
-
facet_return_parent?: string;
|
|
1215
|
-
/** The base64 encoded audio file in 16 khz 16-bit WAV format. */
|
|
1216
|
-
voice_query?: string;
|
|
1217
|
-
/** Enable conversational search. */
|
|
1218
|
-
conversation?: boolean;
|
|
1219
|
-
/** The Id of Conversation Model to be used. */
|
|
1220
|
-
conversation_model_id?: string;
|
|
1221
|
-
/** The Id of a previous conversation to continue, this tells Typesense to include prior context when communicating with the LLM. */
|
|
1222
|
-
conversation_id?: string;
|
|
1223
|
-
/** Controls whether Typesense should validate if the fields exist in the schema. When set to false, Typesense will not throw an error if a field is missing. This is useful for programmatic grouping where not all fields may exist. */
|
|
1224
|
-
validate_field_names?: boolean;
|
|
1225
|
-
/** The collection to search in. */
|
|
1226
|
-
collection?: string;
|
|
1227
|
-
/** A separate search API key for each search within a multi_search request */
|
|
1228
|
-
x_typesense_api_key?: string;
|
|
1229
|
-
/** When true, computes both text match and vector distance scores for all matches in hybrid search. Documents found only through keyword search will get a vector distance score, and documents found only through vector search will get a text match score. */
|
|
1230
|
-
rerank_hybrid_matches?: boolean;
|
|
1231
|
-
}
|
|
1232
|
-
export declare const MultiSearchCollectionParameters: S.Schema<MultiSearchCollectionParameters>;
|
|
1233
|
-
export type MultiSearchRequestSearchesList = Array<MultiSearchCollectionParameters>;
|
|
1234
|
-
export declare const MultiSearchRequestSearchesList: S.Schema<MultiSearchRequestSearchesList>;
|
|
1235
|
-
export interface MultiSearchRequest {
|
|
1236
|
-
multiSearchParameters: MultiSearchParameters;
|
|
1237
|
-
/** When true, merges the search results from each search query into a single ordered set of hits. */
|
|
1238
|
-
union?: boolean;
|
|
1239
|
-
searches: MultiSearchRequestSearchesList;
|
|
1240
|
-
}
|
|
1241
|
-
export declare const MultiSearchRequest: S.Schema<MultiSearchRequest>;
|
|
1242
|
-
export interface FacetCountsCountsItem {
|
|
1243
|
-
count?: number;
|
|
1244
|
-
highlighted?: string;
|
|
1245
|
-
value?: string;
|
|
1246
|
-
parent?: unknown;
|
|
1247
|
-
}
|
|
1248
|
-
export declare const FacetCountsCountsItem: S.Schema<FacetCountsCountsItem>;
|
|
1249
|
-
export type FacetCountsCountsList = Array<FacetCountsCountsItem>;
|
|
1250
|
-
export declare const FacetCountsCountsList: S.Schema<FacetCountsCountsList>;
|
|
1251
|
-
export interface FacetCountsStats {
|
|
1252
|
-
max?: number;
|
|
1253
|
-
min?: number;
|
|
1254
|
-
sum?: number;
|
|
1255
|
-
total_values?: number;
|
|
1256
|
-
avg?: number;
|
|
1257
|
-
}
|
|
1258
|
-
export declare const FacetCountsStats: S.Schema<FacetCountsStats>;
|
|
1259
|
-
export interface FacetCounts {
|
|
1260
|
-
counts?: FacetCountsCountsList;
|
|
1261
|
-
field_name?: string;
|
|
1262
|
-
sampled?: boolean;
|
|
1263
|
-
stats?: FacetCountsStats;
|
|
1264
|
-
}
|
|
1265
|
-
export declare const FacetCounts: S.Schema<FacetCounts>;
|
|
1266
|
-
export type MultiSearchResultItemFacetCountsList = Array<FacetCounts>;
|
|
1267
|
-
export declare const MultiSearchResultItemFacetCountsList: S.Schema<MultiSearchResultItemFacetCountsList>;
|
|
1268
|
-
export type SearchGroupedHitGroupKeyList = Array<unknown>;
|
|
1269
|
-
export declare const SearchGroupedHitGroupKeyList: S.Schema<SearchGroupedHitGroupKeyList>;
|
|
1270
|
-
/** Present only for (array) string[] fields */
|
|
1271
|
-
export type SearchHighlightSnippetsList = Array<string>;
|
|
1272
|
-
export declare const SearchHighlightSnippetsList: S.Schema<SearchHighlightSnippetsList>;
|
|
1273
|
-
/** Full field value with highlighting, present only for (array) string[] fields */
|
|
1274
|
-
export type SearchHighlightValuesList = Array<string>;
|
|
1275
|
-
export declare const SearchHighlightValuesList: S.Schema<SearchHighlightValuesList>;
|
|
1276
|
-
/** The indices property will be present only for string[] fields and will contain the corresponding indices of the snippets in the search field */
|
|
1277
|
-
export type SearchHighlightIndicesList = Array<number>;
|
|
1278
|
-
export declare const SearchHighlightIndicesList: S.Schema<SearchHighlightIndicesList>;
|
|
1279
|
-
export type SearchHighlightMatchedTokensList = Array<unknown>;
|
|
1280
|
-
export declare const SearchHighlightMatchedTokensList: S.Schema<SearchHighlightMatchedTokensList>;
|
|
1281
|
-
export interface SearchHighlight {
|
|
1282
|
-
field?: string;
|
|
1283
|
-
/** Present only for (non-array) string fields */
|
|
1284
|
-
snippet?: string;
|
|
1285
|
-
/** Present only for (array) string[] fields */
|
|
1286
|
-
snippets?: SearchHighlightSnippetsList;
|
|
1287
|
-
/** Full field value with highlighting, present only for (non-array) string fields */
|
|
1288
|
-
value?: string;
|
|
1289
|
-
/** Full field value with highlighting, present only for (array) string[] fields */
|
|
1290
|
-
values?: SearchHighlightValuesList;
|
|
1291
|
-
/** The indices property will be present only for string[] fields and will contain the corresponding indices of the snippets in the search field */
|
|
1292
|
-
indices?: SearchHighlightIndicesList;
|
|
1293
|
-
matched_tokens?: SearchHighlightMatchedTokensList;
|
|
1294
|
-
}
|
|
1295
|
-
export declare const SearchHighlight: S.Schema<SearchHighlight>;
|
|
1296
|
-
/** (Deprecated) Contains highlighted portions of the search fields */
|
|
1297
|
-
export type SearchResultHitHighlightsList = Array<SearchHighlight>;
|
|
1298
|
-
export declare const SearchResultHitHighlightsList: S.Schema<SearchResultHitHighlightsList>;
|
|
1299
|
-
/** Highlighted version of the matching document */
|
|
1300
|
-
export type SearchResultHitHighlightMap = {
|
|
1301
|
-
[key: string]: unknown | undefined;
|
|
1302
|
-
};
|
|
1303
|
-
export declare const SearchResultHitHighlightMap: S.Schema<SearchResultHitHighlightMap>;
|
|
1304
|
-
/** Can be any key-value pair */
|
|
1305
|
-
export type SearchResultHitDocumentMap = {
|
|
1306
|
-
[key: string]: unknown | undefined;
|
|
1307
|
-
};
|
|
1308
|
-
export declare const SearchResultHitDocumentMap: S.Schema<SearchResultHitDocumentMap>;
|
|
1309
|
-
export interface SearchResultHitTextMatchInfo {
|
|
1310
|
-
best_field_score?: string;
|
|
1311
|
-
best_field_weight?: number;
|
|
1312
|
-
fields_matched?: number;
|
|
1313
|
-
num_tokens_dropped?: number;
|
|
1314
|
-
score?: string;
|
|
1315
|
-
tokens_matched?: number;
|
|
1316
|
-
typo_prefix_score?: number;
|
|
1317
|
-
}
|
|
1318
|
-
export declare const SearchResultHitTextMatchInfo: S.Schema<SearchResultHitTextMatchInfo>;
|
|
1319
|
-
/** Can be any key-value pair */
|
|
1320
|
-
export type SearchResultHitGeoDistanceMetersMap = {
|
|
1321
|
-
[key: string]: number | undefined;
|
|
1322
|
-
};
|
|
1323
|
-
export declare const SearchResultHitGeoDistanceMetersMap: S.Schema<SearchResultHitGeoDistanceMetersMap>;
|
|
1324
|
-
/** Information about hybrid search scoring */
|
|
1325
|
-
export interface SearchResultHitHybridSearchInfo {
|
|
1326
|
-
/** Combined score from rank fusion of text and vector search */
|
|
1327
|
-
rank_fusion_score?: number;
|
|
1328
|
-
}
|
|
1329
|
-
export declare const SearchResultHitHybridSearchInfo: S.Schema<SearchResultHitHybridSearchInfo>;
|
|
1330
|
-
export interface SearchResultHit {
|
|
1331
|
-
/** (Deprecated) Contains highlighted portions of the search fields */
|
|
1332
|
-
highlights?: SearchResultHitHighlightsList;
|
|
1333
|
-
/** Highlighted version of the matching document */
|
|
1334
|
-
highlight?: SearchResultHitHighlightMap;
|
|
1335
|
-
/** Can be any key-value pair */
|
|
1336
|
-
document?: SearchResultHitDocumentMap;
|
|
1337
|
-
text_match?: number;
|
|
1338
|
-
text_match_info?: SearchResultHitTextMatchInfo;
|
|
1339
|
-
/** Can be any key-value pair */
|
|
1340
|
-
geo_distance_meters?: SearchResultHitGeoDistanceMetersMap;
|
|
1341
|
-
/** Distance between the query vector and matching document's vector value */
|
|
1342
|
-
vector_distance?: number;
|
|
1343
|
-
/** Information about hybrid search scoring */
|
|
1344
|
-
hybrid_search_info?: SearchResultHitHybridSearchInfo;
|
|
1345
|
-
/** Returned only for union query response. Indicates the index of the query which this document matched to. */
|
|
1346
|
-
search_index?: number;
|
|
1347
|
-
}
|
|
1348
|
-
export declare const SearchResultHit: S.Schema<SearchResultHit>;
|
|
1349
|
-
/** The documents that matched the search query */
|
|
1350
|
-
export type SearchGroupedHitHitsList = Array<SearchResultHit>;
|
|
1351
|
-
export declare const SearchGroupedHitHitsList: S.Schema<SearchGroupedHitHitsList>;
|
|
1352
|
-
export interface SearchGroupedHit {
|
|
1353
|
-
found?: number;
|
|
1354
|
-
group_key: SearchGroupedHitGroupKeyList;
|
|
1355
|
-
/** The documents that matched the search query */
|
|
1356
|
-
hits: SearchGroupedHitHitsList;
|
|
1357
|
-
}
|
|
1358
|
-
export declare const SearchGroupedHit: S.Schema<SearchGroupedHit>;
|
|
1359
|
-
export type MultiSearchResultItemGroupedHitsList = Array<SearchGroupedHit>;
|
|
1360
|
-
export declare const MultiSearchResultItemGroupedHitsList: S.Schema<MultiSearchResultItemGroupedHitsList>;
|
|
1361
|
-
/** The documents that matched the search query */
|
|
1362
|
-
export type MultiSearchResultItemHitsList = Array<SearchResultHit>;
|
|
1363
|
-
export declare const MultiSearchResultItemHitsList: S.Schema<MultiSearchResultItemHitsList>;
|
|
1364
|
-
export interface SearchRequestParamsVoiceQuery {
|
|
1365
|
-
transcribed_query?: string;
|
|
1366
|
-
}
|
|
1367
|
-
export declare const SearchRequestParamsVoiceQuery: S.Schema<SearchRequestParamsVoiceQuery>;
|
|
1368
|
-
export interface SearchRequestParams {
|
|
1369
|
-
collection_name: string;
|
|
1370
|
-
first_q?: string;
|
|
1371
|
-
q: string;
|
|
1372
|
-
per_page: number;
|
|
1373
|
-
voice_query?: SearchRequestParamsVoiceQuery;
|
|
1374
|
-
}
|
|
1375
|
-
export declare const SearchRequestParams: S.Schema<SearchRequestParams>;
|
|
1376
|
-
export type SearchResultConversationConversationHistoryList = Array<unknown>;
|
|
1377
|
-
export declare const SearchResultConversationConversationHistoryList: S.Schema<SearchResultConversationConversationHistoryList>;
|
|
1378
|
-
export interface SearchResultConversation {
|
|
1379
|
-
answer: string;
|
|
1380
|
-
conversation_history: SearchResultConversationConversationHistoryList;
|
|
1381
|
-
conversation_id: string;
|
|
1382
|
-
query: string;
|
|
1383
|
-
}
|
|
1384
|
-
export declare const SearchResultConversation: S.Schema<SearchResultConversation>;
|
|
1385
|
-
/** Returned only for union query response. */
|
|
1386
|
-
export type MultiSearchResultItemUnionRequestParamsList = Array<SearchRequestParams>;
|
|
1387
|
-
export declare const MultiSearchResultItemUnionRequestParamsList: S.Schema<MultiSearchResultItemUnionRequestParamsList>;
|
|
1388
|
-
/** Custom JSON object that can be returned in the search response */
|
|
1389
|
-
export type MultiSearchResultItemMetadataMap = {
|
|
1390
|
-
[key: string]: unknown | undefined;
|
|
1391
|
-
};
|
|
1392
|
-
export declare const MultiSearchResultItemMetadataMap: S.Schema<MultiSearchResultItemMetadataMap>;
|
|
1393
|
-
export interface MultiSearchResultItem {
|
|
1394
|
-
facet_counts?: MultiSearchResultItemFacetCountsList;
|
|
1395
|
-
/** The number of documents found */
|
|
1396
|
-
found?: number;
|
|
1397
|
-
found_docs?: number;
|
|
1398
|
-
/** The number of milliseconds the search took */
|
|
1399
|
-
search_time_ms?: number;
|
|
1400
|
-
/** The total number of documents in the collection */
|
|
1401
|
-
out_of?: number;
|
|
1402
|
-
/** Whether the search was cut off */
|
|
1403
|
-
search_cutoff?: boolean;
|
|
1404
|
-
/** The search result page number */
|
|
1405
|
-
page?: number;
|
|
1406
|
-
grouped_hits?: MultiSearchResultItemGroupedHitsList;
|
|
1407
|
-
/** The documents that matched the search query */
|
|
1408
|
-
hits?: MultiSearchResultItemHitsList;
|
|
1409
|
-
request_params?: SearchRequestParams;
|
|
1410
|
-
conversation?: SearchResultConversation;
|
|
1411
|
-
/** Returned only for union query response. */
|
|
1412
|
-
union_request_params?: MultiSearchResultItemUnionRequestParamsList;
|
|
1413
|
-
/** Custom JSON object that can be returned in the search response */
|
|
1414
|
-
metadata?: MultiSearchResultItemMetadataMap;
|
|
1415
|
-
/** HTTP error code */
|
|
1416
|
-
code?: number;
|
|
1417
|
-
/** Error description */
|
|
1418
|
-
error?: string;
|
|
677
|
+
export interface GetAllConversationModelsRequest {
|
|
1419
678
|
}
|
|
1420
|
-
export declare const
|
|
1421
|
-
export type MultiSearchResultResultsList = Array<MultiSearchResultItem>;
|
|
1422
|
-
export declare const MultiSearchResultResultsList: S.Schema<MultiSearchResultResultsList>;
|
|
1423
|
-
export interface MultiSearchResult {
|
|
1424
|
-
results: MultiSearchResultResultsList;
|
|
1425
|
-
conversation?: SearchResultConversation;
|
|
1426
|
-
}
|
|
1427
|
-
export declare const MultiSearchResult: S.Schema<MultiSearchResult>;
|
|
1428
|
-
export interface RetrieveAllConversationModelsRequest {
|
|
1429
|
-
}
|
|
1430
|
-
export declare const RetrieveAllConversationModelsRequest: S.Schema<RetrieveAllConversationModelsRequest>;
|
|
679
|
+
export declare const GetAllConversationModelsRequest: S.Schema<GetAllConversationModelsRequest>;
|
|
1431
680
|
export interface ConversationModelSchema {
|
|
1432
681
|
/** An explicit id for the model, otherwise the API will return a response with an auto-generated conversation model id. */
|
|
1433
682
|
id: string;
|
|
@@ -1449,13 +698,13 @@ export interface ConversationModelSchema {
|
|
|
1449
698
|
vllm_url?: string;
|
|
1450
699
|
}
|
|
1451
700
|
export declare const ConversationModelSchema: S.Schema<ConversationModelSchema>;
|
|
1452
|
-
export type
|
|
1453
|
-
export declare const
|
|
1454
|
-
export type
|
|
1455
|
-
export declare const
|
|
1456
|
-
export interface
|
|
701
|
+
export type GetAllConversationModelsResponseBodyList = Array<ConversationModelSchema>;
|
|
702
|
+
export declare const GetAllConversationModelsResponseBodyList: S.Schema<GetAllConversationModelsResponseBodyList>;
|
|
703
|
+
export type GetAllConversationModelsResponse = GetAllConversationModelsResponseBodyList;
|
|
704
|
+
export declare const GetAllConversationModelsResponse: S.Schema<GetAllConversationModelsResponse>;
|
|
705
|
+
export interface GetAllNLSearchModelsRequest {
|
|
1457
706
|
}
|
|
1458
|
-
export declare const
|
|
707
|
+
export declare const GetAllNLSearchModelsRequest: S.Schema<GetAllNLSearchModelsRequest>;
|
|
1459
708
|
/** Stop sequences for the NL model (Google-specific) */
|
|
1460
709
|
export type NLSearchModelSchemaStopSequencesList = Array<string>;
|
|
1461
710
|
export declare const NLSearchModelSchemaStopSequencesList: S.Schema<NLSearchModelSchemaStopSequencesList>;
|
|
@@ -1500,24 +749,167 @@ export interface NLSearchModelSchema {
|
|
|
1500
749
|
id: string;
|
|
1501
750
|
}
|
|
1502
751
|
export declare const NLSearchModelSchema: S.Schema<NLSearchModelSchema>;
|
|
1503
|
-
export type
|
|
1504
|
-
export declare const
|
|
1505
|
-
export type
|
|
1506
|
-
export declare const
|
|
1507
|
-
export interface
|
|
752
|
+
export type GetAllNLSearchModelsResponseBodyList = Array<NLSearchModelSchema>;
|
|
753
|
+
export declare const GetAllNLSearchModelsResponseBodyList: S.Schema<GetAllNLSearchModelsResponseBodyList>;
|
|
754
|
+
export type GetAllNLSearchModelsResponse = GetAllNLSearchModelsResponseBodyList;
|
|
755
|
+
export declare const GetAllNLSearchModelsResponse: S.Schema<GetAllNLSearchModelsResponse>;
|
|
756
|
+
export interface GetAllPresetsRequest {
|
|
757
|
+
}
|
|
758
|
+
export declare const GetAllPresetsRequest: S.Schema<GetAllPresetsRequest>;
|
|
759
|
+
/** Dictates the direction in which the words in the query must be dropped when the original words in the query do not appear in any document. Values: right_to_left (default), left_to_right, both_sides:3 A note on both_sides:3 - for queries up to 3 tokens (words) in length, this mode will drop tokens from both sides and exhaustively rank all matching results. If query length is greater than 3 words, Typesense will just fallback to default behavior of right_to_left */
|
|
760
|
+
export type DropTokensMode = "right_to_left" | "left_to_right" | "both_sides:3";
|
|
761
|
+
export declare const DropTokensMode: any;
|
|
762
|
+
export interface SearchParameters {
|
|
763
|
+
/** The query text to search for in the collection. Use * as the search string to return all documents. This is typically useful when used in conjunction with filter_by. */
|
|
764
|
+
q?: string;
|
|
765
|
+
/** A list of `string` fields that should be queried against. Multiple fields are separated with a comma. */
|
|
766
|
+
query_by?: string;
|
|
767
|
+
/** Controls whether Typesense should validate if the fields exist in the schema. When set to false, Typesense will not throw an error if a field is missing. This is useful for programmatic grouping where not all fields may exist. */
|
|
768
|
+
validate_field_names?: boolean;
|
|
769
|
+
/** Whether to use natural language processing to parse the query. */
|
|
770
|
+
nl_query?: boolean;
|
|
771
|
+
/** The ID of the natural language model to use. */
|
|
772
|
+
nl_model_id?: string;
|
|
773
|
+
/** The relative weight to give each `query_by` field when ranking results. This can be used to boost fields in priority, when looking for matches. Multiple fields are separated with a comma. */
|
|
774
|
+
query_by_weights?: string;
|
|
775
|
+
/** In a multi-field matching context, this parameter determines how the representative text match score of a record is calculated. Possible values are max_score (default) or max_weight. */
|
|
776
|
+
text_match_type?: string;
|
|
777
|
+
/** Boolean field to indicate that the last word in the query should be treated as a prefix, and not as a whole word. This is used for building autocomplete and instant search interfaces. Defaults to true. */
|
|
778
|
+
prefix?: string;
|
|
779
|
+
/** If infix index is enabled for this field, infix searching can be done on a per-field basis by sending a comma separated string parameter called infix to the search query. This parameter can have 3 values; `off` infix search is disabled, which is default `always` infix search is performed along with regular search `fallback` infix search is performed if regular search does not produce results */
|
|
780
|
+
infix?: string;
|
|
781
|
+
/** There are also 2 parameters that allow you to control the extent of infix searching max_extra_prefix and max_extra_suffix which specify the maximum number of symbols before or after the query that can be present in the token. For example query "K2100" has 2 extra symbols in "6PK2100". By default, any number of prefixes/suffixes can be present for a match. */
|
|
782
|
+
max_extra_prefix?: number;
|
|
783
|
+
/** There are also 2 parameters that allow you to control the extent of infix searching max_extra_prefix and max_extra_suffix which specify the maximum number of symbols before or after the query that can be present in the token. For example query "K2100" has 2 extra symbols in "6PK2100". By default, any number of prefixes/suffixes can be present for a match. */
|
|
784
|
+
max_extra_suffix?: number;
|
|
785
|
+
/** Filter conditions for refining your open api validator search results. Separate multiple conditions with &&. */
|
|
786
|
+
filter_by?: string;
|
|
787
|
+
/** Controls the number of similar words that Typesense considers during fuzzy search on filter_by values. Useful for controlling prefix matches like company_name:Acm*. */
|
|
788
|
+
max_filter_by_candidates?: number;
|
|
789
|
+
/** A list of numerical fields and their corresponding sort orders that will be used for ordering your results. Up to 3 sort fields can be specified. The text similarity score is exposed as a special `_text_match` field that you can use in the list of sorting fields. If no `sort_by` parameter is specified, results are sorted by `_text_match:desc,default_sorting_field:desc` */
|
|
790
|
+
sort_by?: string;
|
|
791
|
+
/** A list of fields that will be used for faceting your results on. Separate multiple fields with a comma. */
|
|
792
|
+
facet_by?: string;
|
|
793
|
+
/** Maximum number of facet values to be returned. */
|
|
794
|
+
max_facet_values?: number;
|
|
795
|
+
/** Facet values that are returned can now be filtered via this parameter. The matching facet text is also highlighted. For example, when faceting by `category`, you can set `facet_query=category:shoe` to return only facet values that contain the prefix "shoe". */
|
|
796
|
+
facet_query?: string;
|
|
797
|
+
/** The number of typographical errors (1 or 2) that would be tolerated. Default: 2 */
|
|
798
|
+
num_typos?: string;
|
|
799
|
+
/** Results from this specific page number would be fetched. */
|
|
800
|
+
page?: number;
|
|
801
|
+
/** Number of results to fetch per page. Default: 10 */
|
|
802
|
+
per_page?: number;
|
|
803
|
+
/** Number of hits to fetch. Can be used as an alternative to the per_page parameter. Default: 10. */
|
|
804
|
+
limit?: number;
|
|
805
|
+
/** Identifies the starting point to return hits from a result set. Can be used as an alternative to the page parameter. */
|
|
806
|
+
offset?: number;
|
|
807
|
+
/** You can aggregate search results into groups or buckets by specify one or more `group_by` fields. Separate multiple fields with a comma. To group on a particular field, it must be a faceted field. */
|
|
808
|
+
group_by?: string;
|
|
809
|
+
/** Maximum number of hits to be returned for every group. If the `group_limit` is set as `K` then only the top K hits in each group are returned in the response. Default: 3 */
|
|
810
|
+
group_limit?: number;
|
|
811
|
+
/** Setting this parameter to true will place all documents that have a null value in the group_by field, into a single group. Setting this parameter to false, will cause each document with a null value in the group_by field to not be grouped with other documents. Default: true */
|
|
812
|
+
group_missing_values?: boolean;
|
|
813
|
+
/** List of fields from the document to include in the search result */
|
|
814
|
+
include_fields?: string;
|
|
815
|
+
/** List of fields from the document to exclude in the search result */
|
|
816
|
+
exclude_fields?: string;
|
|
817
|
+
/** List of fields which should be highlighted fully without snippeting */
|
|
818
|
+
highlight_full_fields?: string;
|
|
819
|
+
/** The number of tokens that should surround the highlighted text on each side. Default: 4 */
|
|
820
|
+
highlight_affix_num_tokens?: number;
|
|
821
|
+
/** The start tag used for the highlighted snippets. Default: `<mark>` */
|
|
822
|
+
highlight_start_tag?: string;
|
|
823
|
+
/** The end tag used for the highlighted snippets. Default: `</mark>` */
|
|
824
|
+
highlight_end_tag?: string;
|
|
825
|
+
/** Flag for enabling/disabling the deprecated, old highlight structure in the response. Default: true */
|
|
826
|
+
enable_highlight_v1?: boolean;
|
|
827
|
+
/** Flag for enabling/disabling analytics aggregation for specific search queries (for e.g. those originating from a test script). */
|
|
828
|
+
enable_analytics?: boolean;
|
|
829
|
+
/** Field values under this length will be fully highlighted, instead of showing a snippet of relevant portion. Default: 30 */
|
|
830
|
+
snippet_threshold?: number;
|
|
831
|
+
/** List of synonym set names to associate with this search query */
|
|
832
|
+
synonym_sets?: string;
|
|
833
|
+
/** If the number of results found for a specific query is less than this number, Typesense will attempt to drop the tokens in the query until enough results are found. Tokens that have the least individual hits are dropped first. Set to 0 to disable. Default: 10 */
|
|
834
|
+
drop_tokens_threshold?: number;
|
|
835
|
+
drop_tokens_mode?: DropTokensMode | (string & {});
|
|
836
|
+
/** If the number of results found for a specific query is less than this number, Typesense will attempt to look for tokens with more typos until enough results are found. Default: 100 */
|
|
837
|
+
typo_tokens_threshold?: number;
|
|
838
|
+
/** Set this parameter to false to disable typos on alphanumerical query tokens. Default: true. */
|
|
839
|
+
enable_typos_for_alpha_numerical_tokens?: boolean;
|
|
840
|
+
/** Whether the filter_by condition of the search query should be applicable to curated results (curation definitions, pinned hits, hidden hits, etc.). Default: false */
|
|
841
|
+
filter_curated_hits?: boolean;
|
|
842
|
+
/** If you have some synonyms defined but want to disable all of them for a particular search query, set enable_synonyms to false. Default: true */
|
|
843
|
+
enable_synonyms?: boolean;
|
|
844
|
+
/** Allow synonym resolution on word prefixes in the query. Default: false */
|
|
845
|
+
synonym_prefix?: boolean;
|
|
846
|
+
/** Allow synonym resolution on typo-corrected words in the query. Default: 0 */
|
|
847
|
+
synonym_num_typos?: number;
|
|
848
|
+
/** A list of records to unconditionally include in the search results at specific positions. An example use case would be to feature or promote certain items on the top of search results. A list of `record_id:hit_position`. Eg: to include a record with ID 123 at Position 1 and another record with ID 456 at Position 5, you'd specify `123:1,456:5`. You could also use the Curation feature to override search results based on rules. Curations are applied first, followed by `pinned_hits` and finally `hidden_hits`. */
|
|
849
|
+
pinned_hits?: string;
|
|
850
|
+
/** A list of records to unconditionally hide from search results. A list of `record_id`s to hide. Eg: to hide records with IDs 123 and 456, you'd specify `123,456`. You could also use the Curation feature to override search results based on rules. Curations are applied first, followed by `pinned_hits` and finally `hidden_hits`. */
|
|
851
|
+
hidden_hits?: string;
|
|
852
|
+
/** Comma separated list of tags to trigger the curations rules that match the tags. */
|
|
853
|
+
curation_tags?: string;
|
|
854
|
+
/** A list of custom fields that must be highlighted even if you don't query for them */
|
|
855
|
+
highlight_fields?: string;
|
|
856
|
+
/** Treat space as typo: search for q=basket ball if q=basketball is not found or vice-versa. Splitting/joining of tokens will only be attempted if the original query produces no results. To always trigger this behavior, set value to `always``. To disable, set value to `off`. Default is `fallback`. */
|
|
857
|
+
split_join_tokens?: string;
|
|
858
|
+
/** You can index content from any logographic language into Typesense if you are able to segment / split the text into space-separated words yourself before indexing and querying. Set this parameter to true to do the same */
|
|
859
|
+
pre_segmented_query?: boolean;
|
|
860
|
+
/** Search using a bunch of search parameters by setting this parameter to the name of the existing Preset. */
|
|
861
|
+
preset?: string;
|
|
862
|
+
/** If you have some curation sets defined but want to disable all of them during query time, you can do that by setting this parameter to false */
|
|
863
|
+
enable_curations?: boolean;
|
|
864
|
+
/** Set this parameter to true to ensure that an exact match is ranked above the others */
|
|
865
|
+
prioritize_exact_match?: boolean;
|
|
866
|
+
/** Control the number of words that Typesense considers for typo and prefix searching. */
|
|
867
|
+
max_candidates?: number;
|
|
868
|
+
/** Make Typesense prioritize documents where the query words appear earlier in the text. */
|
|
869
|
+
prioritize_token_position?: boolean;
|
|
870
|
+
/** Make Typesense prioritize documents where the query words appear in more number of fields. */
|
|
871
|
+
prioritize_num_matching_fields?: boolean;
|
|
872
|
+
/** Make Typesense disable typos for numerical tokens. */
|
|
873
|
+
enable_typos_for_numerical_tokens?: boolean;
|
|
874
|
+
/** Setting this to true will make Typesense consider all prefixes and typo corrections of the words in the query without stopping early when enough results are found (drop_tokens_threshold and typo_tokens_threshold configurations are ignored). */
|
|
875
|
+
exhaustive_search?: boolean;
|
|
876
|
+
/** Typesense will attempt to return results early if the cutoff time has elapsed. This is not a strict guarantee and facet computation is not bound by this parameter. */
|
|
877
|
+
search_cutoff_ms?: number;
|
|
878
|
+
/** Enable server side caching of search query results. By default, caching is disabled. */
|
|
879
|
+
use_cache?: boolean;
|
|
880
|
+
/** The duration (in seconds) that determines how long the search query is cached. This value can be set on a per-query basis. Default: 60. */
|
|
881
|
+
cache_ttl?: number;
|
|
882
|
+
/** Minimum word length for 1-typo correction to be applied. The value of num_typos is still treated as the maximum allowed typos. */
|
|
883
|
+
min_len_1typo?: number;
|
|
884
|
+
/** Minimum word length for 2-typo correction to be applied. The value of num_typos is still treated as the maximum allowed typos. */
|
|
885
|
+
min_len_2typo?: number;
|
|
886
|
+
/** Vector query expression for fetching documents "closest" to a given query/document vector. */
|
|
887
|
+
vector_query?: string;
|
|
888
|
+
/** Timeout (in milliseconds) for fetching remote embeddings. */
|
|
889
|
+
remote_embedding_timeout_ms?: number;
|
|
890
|
+
/** Number of times to retry fetching remote embeddings. */
|
|
891
|
+
remote_embedding_num_tries?: number;
|
|
892
|
+
/** Choose the underlying faceting strategy used. Comma separated string of allows values: exhaustive, top_values or automatic (default). */
|
|
893
|
+
facet_strategy?: string;
|
|
894
|
+
/** Name of the stopwords set to apply for this search, the keywords present in the set will be removed from the search query. */
|
|
895
|
+
stopwords?: string;
|
|
896
|
+
/** Comma separated string of nested facet fields whose parent object should be returned in facet response. */
|
|
897
|
+
facet_return_parent?: string;
|
|
898
|
+
/** The base64 encoded audio file in 16 khz 16-bit WAV format. */
|
|
899
|
+
voice_query?: string;
|
|
900
|
+
/** Enable conversational search. */
|
|
901
|
+
conversation?: boolean;
|
|
902
|
+
/** The Id of Conversation Model to be used. */
|
|
903
|
+
conversation_model_id?: string;
|
|
904
|
+
/** The Id of a previous conversation to continue, this tells Typesense to include prior context when communicating with the LLM. */
|
|
905
|
+
conversation_id?: string;
|
|
1508
906
|
}
|
|
1509
|
-
export declare const
|
|
1510
|
-
export interface
|
|
907
|
+
export declare const SearchParameters: S.Schema<SearchParameters>;
|
|
908
|
+
export interface MultiSearchCollectionParameters {
|
|
1511
909
|
/** The query text to search for in the collection. Use * as the search string to return all documents. This is typically useful when used in conjunction with filter_by. */
|
|
1512
910
|
q?: string;
|
|
1513
911
|
/** A list of `string` fields that should be queried against. Multiple fields are separated with a comma. */
|
|
1514
912
|
query_by?: string;
|
|
1515
|
-
/** Controls whether Typesense should validate if the fields exist in the schema. When set to false, Typesense will not throw an error if a field is missing. This is useful for programmatic grouping where not all fields may exist. */
|
|
1516
|
-
validate_field_names?: boolean;
|
|
1517
|
-
/** Whether to use natural language processing to parse the query. */
|
|
1518
|
-
nl_query?: boolean;
|
|
1519
|
-
/** The ID of the natural language model to use. */
|
|
1520
|
-
nl_model_id?: string;
|
|
1521
913
|
/** The relative weight to give each `query_by` field when ranking results. This can be used to boost fields in priority, when looking for matches. Multiple fields are separated with a comma. */
|
|
1522
914
|
query_by_weights?: string;
|
|
1523
915
|
/** In a multi-field matching context, this parameter determines how the representative text match score of a record is calculated. Possible values are max_score (default) or max_weight. */
|
|
@@ -1530,10 +922,8 @@ export interface SearchParameters {
|
|
|
1530
922
|
max_extra_prefix?: number;
|
|
1531
923
|
/** There are also 2 parameters that allow you to control the extent of infix searching max_extra_prefix and max_extra_suffix which specify the maximum number of symbols before or after the query that can be present in the token. For example query "K2100" has 2 extra symbols in "6PK2100". By default, any number of prefixes/suffixes can be present for a match. */
|
|
1532
924
|
max_extra_suffix?: number;
|
|
1533
|
-
/** Filter conditions for refining
|
|
925
|
+
/** Filter conditions for refining youropen api validator search results. Separate multiple conditions with &&. */
|
|
1534
926
|
filter_by?: string;
|
|
1535
|
-
/** Controls the number of similar words that Typesense considers during fuzzy search on filter_by values. Useful for controlling prefix matches like company_name:Acm*. */
|
|
1536
|
-
max_filter_by_candidates?: number;
|
|
1537
927
|
/** A list of numerical fields and their corresponding sort orders that will be used for ordering your results. Up to 3 sort fields can be specified. The text similarity score is exposed as a special `_text_match` field that you can use in the list of sorting fields. If no `sort_by` parameter is specified, results are sorted by `_text_match:desc,default_sorting_field:desc` */
|
|
1538
928
|
sort_by?: string;
|
|
1539
929
|
/** A list of fields that will be used for faceting your results on. Separate multiple fields with a comma. */
|
|
@@ -1570,14 +960,8 @@ export interface SearchParameters {
|
|
|
1570
960
|
highlight_start_tag?: string;
|
|
1571
961
|
/** The end tag used for the highlighted snippets. Default: `</mark>` */
|
|
1572
962
|
highlight_end_tag?: string;
|
|
1573
|
-
/** Flag for enabling/disabling the deprecated, old highlight structure in the response. Default: true */
|
|
1574
|
-
enable_highlight_v1?: boolean;
|
|
1575
|
-
/** Flag for enabling/disabling analytics aggregation for specific search queries (for e.g. those originating from a test script). */
|
|
1576
|
-
enable_analytics?: boolean;
|
|
1577
963
|
/** Field values under this length will be fully highlighted, instead of showing a snippet of relevant portion. Default: 30 */
|
|
1578
964
|
snippet_threshold?: number;
|
|
1579
|
-
/** List of synonym set names to associate with this search query */
|
|
1580
|
-
synonym_sets?: string;
|
|
1581
965
|
/** If the number of results found for a specific query is less than this number, Typesense will attempt to drop the tokens in the query until enough results are found. Tokens that have the least individual hits are dropped first. Set to 0 to disable. Default: 10 */
|
|
1582
966
|
drop_tokens_threshold?: number;
|
|
1583
967
|
drop_tokens_mode?: DropTokensMode | (string & {});
|
|
@@ -1589,6 +973,8 @@ export interface SearchParameters {
|
|
|
1589
973
|
filter_curated_hits?: boolean;
|
|
1590
974
|
/** If you have some synonyms defined but want to disable all of them for a particular search query, set enable_synonyms to false. Default: true */
|
|
1591
975
|
enable_synonyms?: boolean;
|
|
976
|
+
/** Flag for enabling/disabling analytics aggregation for specific search queries (for e.g. those originating from a test script). */
|
|
977
|
+
enable_analytics?: boolean;
|
|
1592
978
|
/** Allow synonym resolution on word prefixes in the query. Default: false */
|
|
1593
979
|
synonym_prefix?: boolean;
|
|
1594
980
|
/** Allow synonym resolution on typo-corrected words in the query. Default: 0 */
|
|
@@ -1601,8 +987,6 @@ export interface SearchParameters {
|
|
|
1601
987
|
curation_tags?: string;
|
|
1602
988
|
/** A list of custom fields that must be highlighted even if you don't query for them */
|
|
1603
989
|
highlight_fields?: string;
|
|
1604
|
-
/** Treat space as typo: search for q=basket ball if q=basketball is not found or vice-versa. Splitting/joining of tokens will only be attempted if the original query produces no results. To always trigger this behavior, set value to `always``. To disable, set value to `off`. Default is `fallback`. */
|
|
1605
|
-
split_join_tokens?: string;
|
|
1606
990
|
/** You can index content from any logographic language into Typesense if you are able to segment / split the text into space-separated words yourself before indexing and querying. Set this parameter to true to do the same */
|
|
1607
991
|
pre_segmented_query?: boolean;
|
|
1608
992
|
/** Search using a bunch of search parameters by setting this parameter to the name of the existing Preset. */
|
|
@@ -1611,8 +995,6 @@ export interface SearchParameters {
|
|
|
1611
995
|
enable_curations?: boolean;
|
|
1612
996
|
/** Set this parameter to true to ensure that an exact match is ranked above the others */
|
|
1613
997
|
prioritize_exact_match?: boolean;
|
|
1614
|
-
/** Control the number of words that Typesense considers for typo and prefix searching. */
|
|
1615
|
-
max_candidates?: number;
|
|
1616
998
|
/** Make Typesense prioritize documents where the query words appear earlier in the text. */
|
|
1617
999
|
prioritize_token_position?: boolean;
|
|
1618
1000
|
/** Make Typesense prioritize documents where the query words appear in more number of fields. */
|
|
@@ -1651,8 +1033,16 @@ export interface SearchParameters {
|
|
|
1651
1033
|
conversation_model_id?: string;
|
|
1652
1034
|
/** The Id of a previous conversation to continue, this tells Typesense to include prior context when communicating with the LLM. */
|
|
1653
1035
|
conversation_id?: string;
|
|
1036
|
+
/** Controls whether Typesense should validate if the fields exist in the schema. When set to false, Typesense will not throw an error if a field is missing. This is useful for programmatic grouping where not all fields may exist. */
|
|
1037
|
+
validate_field_names?: boolean;
|
|
1038
|
+
/** The collection to search in. */
|
|
1039
|
+
collection?: string;
|
|
1040
|
+
/** A separate search API key for each search within a multi_search request */
|
|
1041
|
+
x_typesense_api_key?: string;
|
|
1042
|
+
/** When true, computes both text match and vector distance scores for all matches in hybrid search. Documents found only through keyword search will get a vector distance score, and documents found only through vector search will get a text match score. */
|
|
1043
|
+
rerank_hybrid_matches?: boolean;
|
|
1654
1044
|
}
|
|
1655
|
-
export declare const
|
|
1045
|
+
export declare const MultiSearchCollectionParameters: S.Schema<MultiSearchCollectionParameters>;
|
|
1656
1046
|
export type MultiSearchSearchesParameterSearchesList = Array<MultiSearchCollectionParameters>;
|
|
1657
1047
|
export declare const MultiSearchSearchesParameterSearchesList: S.Schema<MultiSearchSearchesParameterSearchesList>;
|
|
1658
1048
|
export interface MultiSearchSearchesParameter {
|
|
@@ -1674,44 +1064,84 @@ export interface PresetsRetrieveSchema {
|
|
|
1674
1064
|
presets: PresetsRetrieveSchemaPresetsList;
|
|
1675
1065
|
}
|
|
1676
1066
|
export declare const PresetsRetrieveSchema: S.Schema<PresetsRetrieveSchema>;
|
|
1677
|
-
export interface
|
|
1067
|
+
export interface GetAnalyticsEventsRequest {
|
|
1068
|
+
user_id: string;
|
|
1069
|
+
/** Analytics rule name */
|
|
1070
|
+
name: string;
|
|
1071
|
+
/** Number of events to return (max 1000) */
|
|
1072
|
+
n: number;
|
|
1073
|
+
}
|
|
1074
|
+
export declare const GetAnalyticsEventsRequest: S.Schema<GetAnalyticsEventsRequest>;
|
|
1075
|
+
export type AnalyticsEventsResponseEventsItemDocIdsList = Array<string>;
|
|
1076
|
+
export declare const AnalyticsEventsResponseEventsItemDocIdsList: S.Schema<AnalyticsEventsResponseEventsItemDocIdsList>;
|
|
1077
|
+
export interface AnalyticsEventsResponseEventsItem {
|
|
1078
|
+
name?: string;
|
|
1079
|
+
event_type?: string;
|
|
1080
|
+
collection?: string;
|
|
1081
|
+
timestamp?: number;
|
|
1082
|
+
user_id?: string;
|
|
1083
|
+
doc_id?: string;
|
|
1084
|
+
doc_ids?: AnalyticsEventsResponseEventsItemDocIdsList;
|
|
1085
|
+
query?: string;
|
|
1086
|
+
}
|
|
1087
|
+
export declare const AnalyticsEventsResponseEventsItem: S.Schema<AnalyticsEventsResponseEventsItem>;
|
|
1088
|
+
export type AnalyticsEventsResponseEventsList = Array<AnalyticsEventsResponseEventsItem>;
|
|
1089
|
+
export declare const AnalyticsEventsResponseEventsList: S.Schema<AnalyticsEventsResponseEventsList>;
|
|
1090
|
+
export interface AnalyticsEventsResponse {
|
|
1091
|
+
events: AnalyticsEventsResponseEventsList;
|
|
1092
|
+
}
|
|
1093
|
+
export declare const AnalyticsEventsResponse: S.Schema<AnalyticsEventsResponse>;
|
|
1094
|
+
export interface GetAnalyticsRuleRequest {
|
|
1678
1095
|
/** The name of the analytics rule to retrieve */
|
|
1679
1096
|
ruleName: string;
|
|
1680
1097
|
}
|
|
1681
|
-
export declare const
|
|
1682
|
-
export type
|
|
1683
|
-
export declare const
|
|
1684
|
-
export interface
|
|
1098
|
+
export declare const GetAnalyticsRuleRequest: S.Schema<GetAnalyticsRuleRequest>;
|
|
1099
|
+
export type GetAnalyticsRuleResponseParamsMetaFieldsList = Array<string>;
|
|
1100
|
+
export declare const GetAnalyticsRuleResponseParamsMetaFieldsList: S.Schema<GetAnalyticsRuleResponseParamsMetaFieldsList>;
|
|
1101
|
+
export interface GetAnalyticsRuleResponseParams {
|
|
1685
1102
|
destination_collection?: string;
|
|
1686
1103
|
limit?: number;
|
|
1687
1104
|
capture_search_requests?: boolean;
|
|
1688
|
-
meta_fields?:
|
|
1105
|
+
meta_fields?: GetAnalyticsRuleResponseParamsMetaFieldsList;
|
|
1689
1106
|
expand_query?: boolean;
|
|
1690
1107
|
counter_field?: string;
|
|
1691
1108
|
weight?: number;
|
|
1692
1109
|
}
|
|
1693
|
-
export declare const
|
|
1694
|
-
export interface
|
|
1110
|
+
export declare const GetAnalyticsRuleResponseParams: S.Schema<GetAnalyticsRuleResponseParams>;
|
|
1111
|
+
export interface GetAnalyticsRuleResponse {
|
|
1695
1112
|
name: string;
|
|
1696
1113
|
type: AnalyticsRuleType;
|
|
1697
1114
|
collection: string;
|
|
1698
1115
|
event_type: string;
|
|
1699
1116
|
rule_tag?: string;
|
|
1700
|
-
params?:
|
|
1117
|
+
params?: GetAnalyticsRuleResponseParams;
|
|
1701
1118
|
}
|
|
1702
|
-
export declare const
|
|
1703
|
-
export interface
|
|
1119
|
+
export declare const GetAnalyticsRuleResponse: S.Schema<GetAnalyticsRuleResponse>;
|
|
1120
|
+
export interface GetAnalyticsRulesRequest {
|
|
1704
1121
|
/** Filter rules by rule_tag */
|
|
1705
1122
|
rule_tag?: string;
|
|
1706
1123
|
}
|
|
1707
|
-
export declare const
|
|
1708
|
-
export type
|
|
1709
|
-
export declare const
|
|
1710
|
-
export type
|
|
1711
|
-
export declare const
|
|
1712
|
-
export interface
|
|
1124
|
+
export declare const GetAnalyticsRulesRequest: S.Schema<GetAnalyticsRulesRequest>;
|
|
1125
|
+
export type GetAnalyticsRulesResponseBodyList = Array<AnalyticsRule>;
|
|
1126
|
+
export declare const GetAnalyticsRulesResponseBodyList: S.Schema<GetAnalyticsRulesResponseBodyList>;
|
|
1127
|
+
export type GetAnalyticsRulesResponse = GetAnalyticsRulesResponseBodyList;
|
|
1128
|
+
export declare const GetAnalyticsRulesResponse: S.Schema<GetAnalyticsRulesResponse>;
|
|
1129
|
+
export interface GetAnalyticsStatusRequest {
|
|
1130
|
+
}
|
|
1131
|
+
export declare const GetAnalyticsStatusRequest: S.Schema<GetAnalyticsStatusRequest>;
|
|
1132
|
+
export interface AnalyticsStatus {
|
|
1133
|
+
popular_prefix_queries?: number;
|
|
1134
|
+
nohits_prefix_queries?: number;
|
|
1135
|
+
log_prefix_queries?: number;
|
|
1136
|
+
query_log_events?: number;
|
|
1137
|
+
query_counter_events?: number;
|
|
1138
|
+
doc_log_events?: number;
|
|
1139
|
+
doc_counter_events?: number;
|
|
1140
|
+
}
|
|
1141
|
+
export declare const AnalyticsStatus: S.Schema<AnalyticsStatus>;
|
|
1142
|
+
export interface GetAPIStatsRequest {
|
|
1713
1143
|
}
|
|
1714
|
-
export declare const
|
|
1144
|
+
export declare const GetAPIStatsRequest: S.Schema<GetAPIStatsRequest>;
|
|
1715
1145
|
export interface APIStatsResponse {
|
|
1716
1146
|
delete_latency_ms?: number;
|
|
1717
1147
|
delete_requests_per_second?: number;
|
|
@@ -1728,12 +1158,106 @@ export interface APIStatsResponse {
|
|
|
1728
1158
|
write_requests_per_second?: number;
|
|
1729
1159
|
}
|
|
1730
1160
|
export declare const APIStatsResponse: S.Schema<APIStatsResponse>;
|
|
1731
|
-
export interface
|
|
1161
|
+
export interface GetCollectionRequest {
|
|
1162
|
+
/** The name of the collection to retrieve */
|
|
1163
|
+
collectionName: string;
|
|
1164
|
+
}
|
|
1165
|
+
export declare const GetCollectionRequest: S.Schema<GetCollectionRequest>;
|
|
1166
|
+
/** A list of fields for querying, filtering and faceting */
|
|
1167
|
+
export type GetCollectionResponseFieldsList = Array<Field>;
|
|
1168
|
+
export declare const GetCollectionResponseFieldsList: S.Schema<GetCollectionResponseFieldsList>;
|
|
1169
|
+
/** List of symbols or special characters to be used for splitting the text into individual words in addition to space and new-line characters. */
|
|
1170
|
+
export type GetCollectionResponseTokenSeparatorsList = Array<string>;
|
|
1171
|
+
export declare const GetCollectionResponseTokenSeparatorsList: S.Schema<GetCollectionResponseTokenSeparatorsList>;
|
|
1172
|
+
/** List of synonym set names to associate with this collection */
|
|
1173
|
+
export type GetCollectionResponseSynonymSetsList = Array<string>;
|
|
1174
|
+
export declare const GetCollectionResponseSynonymSetsList: S.Schema<GetCollectionResponseSynonymSetsList>;
|
|
1175
|
+
/** List of symbols or special characters to be indexed. */
|
|
1176
|
+
export type GetCollectionResponseSymbolsToIndexList = Array<string>;
|
|
1177
|
+
export declare const GetCollectionResponseSymbolsToIndexList: S.Schema<GetCollectionResponseSymbolsToIndexList>;
|
|
1178
|
+
export interface GetCollectionResponse {
|
|
1179
|
+
/** Name of the collection */
|
|
1180
|
+
name: string;
|
|
1181
|
+
/** A list of fields for querying, filtering and faceting */
|
|
1182
|
+
fields: GetCollectionResponseFieldsList;
|
|
1183
|
+
/** The name of an int32 / float field that determines the order in which the search results are ranked when a sort_by clause is not provided during searching. This field must indicate some kind of popularity. */
|
|
1184
|
+
default_sorting_field?: string;
|
|
1185
|
+
/** List of symbols or special characters to be used for splitting the text into individual words in addition to space and new-line characters. */
|
|
1186
|
+
token_separators?: GetCollectionResponseTokenSeparatorsList;
|
|
1187
|
+
/** List of synonym set names to associate with this collection */
|
|
1188
|
+
synonym_sets?: GetCollectionResponseSynonymSetsList;
|
|
1189
|
+
/** Enables experimental support at a collection level for nested object or object array fields. This field is only available if the Typesense server is version `0.24.0.rcn34` or later. */
|
|
1190
|
+
enable_nested_fields?: boolean;
|
|
1191
|
+
/** List of symbols or special characters to be indexed. */
|
|
1192
|
+
symbols_to_index?: GetCollectionResponseSymbolsToIndexList;
|
|
1193
|
+
voice_query_model?: VoiceQueryModelCollectionConfig;
|
|
1194
|
+
/** Optional details about the collection, e.g., when it was created, who created it etc. */
|
|
1195
|
+
metadata?: unknown;
|
|
1196
|
+
/** Number of documents in the collection */
|
|
1197
|
+
num_documents: number;
|
|
1198
|
+
/** Timestamp of when the collection was created (Unix epoch in seconds) */
|
|
1199
|
+
created_at: number;
|
|
1200
|
+
}
|
|
1201
|
+
export declare const GetCollectionResponse: S.Schema<GetCollectionResponse>;
|
|
1202
|
+
export interface GetCollectionsRequestGetCollectionsParameters {
|
|
1203
|
+
/** Comma-separated list of fields from the collection to exclude from the response */
|
|
1204
|
+
exclude_fields?: string;
|
|
1205
|
+
/** Number of collections to fetch. Default: returns all collections. */
|
|
1206
|
+
limit?: number;
|
|
1207
|
+
/** Identifies the starting point to return collections when paginating. */
|
|
1208
|
+
offset?: number;
|
|
1209
|
+
}
|
|
1210
|
+
export declare const GetCollectionsRequestGetCollectionsParameters: S.Schema<GetCollectionsRequestGetCollectionsParameters>;
|
|
1211
|
+
export interface GetCollectionsRequest {
|
|
1212
|
+
getCollectionsParameters?: GetCollectionsRequestGetCollectionsParameters;
|
|
1213
|
+
}
|
|
1214
|
+
export declare const GetCollectionsRequest: S.Schema<GetCollectionsRequest>;
|
|
1215
|
+
/** A list of fields for querying, filtering and faceting */
|
|
1216
|
+
export type CollectionResponseFieldsList = Array<Field>;
|
|
1217
|
+
export declare const CollectionResponseFieldsList: S.Schema<CollectionResponseFieldsList>;
|
|
1218
|
+
/** List of symbols or special characters to be used for splitting the text into individual words in addition to space and new-line characters. */
|
|
1219
|
+
export type CollectionResponseTokenSeparatorsList = Array<string>;
|
|
1220
|
+
export declare const CollectionResponseTokenSeparatorsList: S.Schema<CollectionResponseTokenSeparatorsList>;
|
|
1221
|
+
/** List of synonym set names to associate with this collection */
|
|
1222
|
+
export type CollectionResponseSynonymSetsList = Array<string>;
|
|
1223
|
+
export declare const CollectionResponseSynonymSetsList: S.Schema<CollectionResponseSynonymSetsList>;
|
|
1224
|
+
/** List of symbols or special characters to be indexed. */
|
|
1225
|
+
export type CollectionResponseSymbolsToIndexList = Array<string>;
|
|
1226
|
+
export declare const CollectionResponseSymbolsToIndexList: S.Schema<CollectionResponseSymbolsToIndexList>;
|
|
1227
|
+
export interface CollectionResponse {
|
|
1228
|
+
/** Name of the collection */
|
|
1229
|
+
name: string;
|
|
1230
|
+
/** A list of fields for querying, filtering and faceting */
|
|
1231
|
+
fields: CollectionResponseFieldsList;
|
|
1232
|
+
/** The name of an int32 / float field that determines the order in which the search results are ranked when a sort_by clause is not provided during searching. This field must indicate some kind of popularity. */
|
|
1233
|
+
default_sorting_field?: string;
|
|
1234
|
+
/** List of symbols or special characters to be used for splitting the text into individual words in addition to space and new-line characters. */
|
|
1235
|
+
token_separators?: CollectionResponseTokenSeparatorsList;
|
|
1236
|
+
/** List of synonym set names to associate with this collection */
|
|
1237
|
+
synonym_sets?: CollectionResponseSynonymSetsList;
|
|
1238
|
+
/** Enables experimental support at a collection level for nested object or object array fields. This field is only available if the Typesense server is version `0.24.0.rcn34` or later. */
|
|
1239
|
+
enable_nested_fields?: boolean;
|
|
1240
|
+
/** List of symbols or special characters to be indexed. */
|
|
1241
|
+
symbols_to_index?: CollectionResponseSymbolsToIndexList;
|
|
1242
|
+
voice_query_model?: VoiceQueryModelCollectionConfig;
|
|
1243
|
+
/** Optional details about the collection, e.g., when it was created, who created it etc. */
|
|
1244
|
+
metadata?: unknown;
|
|
1245
|
+
/** Number of documents in the collection */
|
|
1246
|
+
num_documents: number;
|
|
1247
|
+
/** Timestamp of when the collection was created (Unix epoch in seconds) */
|
|
1248
|
+
created_at: number;
|
|
1249
|
+
}
|
|
1250
|
+
export declare const CollectionResponse: S.Schema<CollectionResponse>;
|
|
1251
|
+
export type GetCollectionsResponseBodyList = Array<CollectionResponse>;
|
|
1252
|
+
export declare const GetCollectionsResponseBodyList: S.Schema<GetCollectionsResponseBodyList>;
|
|
1253
|
+
export type GetCollectionsResponse = GetCollectionsResponseBodyList;
|
|
1254
|
+
export declare const GetCollectionsResponse: S.Schema<GetCollectionsResponse>;
|
|
1255
|
+
export interface GetConversationModelRequest {
|
|
1732
1256
|
/** The id of the conversation model to retrieve */
|
|
1733
1257
|
modelId: string;
|
|
1734
1258
|
}
|
|
1735
|
-
export declare const
|
|
1736
|
-
export interface
|
|
1259
|
+
export declare const GetConversationModelRequest: S.Schema<GetConversationModelRequest>;
|
|
1260
|
+
export interface GetConversationModelResponse {
|
|
1737
1261
|
/** An explicit id for the model, otherwise the API will return a response with an auto-generated conversation model id. */
|
|
1738
1262
|
id: string;
|
|
1739
1263
|
/** Name of the LLM model offered by OpenAI, Cloudflare or vLLM */
|
|
@@ -1753,12 +1277,12 @@ export interface RetrieveConversationModelResponse {
|
|
|
1753
1277
|
/** URL of vLLM service */
|
|
1754
1278
|
vllm_url?: string;
|
|
1755
1279
|
}
|
|
1756
|
-
export declare const
|
|
1757
|
-
export interface
|
|
1280
|
+
export declare const GetConversationModelResponse: S.Schema<GetConversationModelResponse>;
|
|
1281
|
+
export interface GetCurationSetRequest {
|
|
1758
1282
|
/** The name of the curation set to retrieve */
|
|
1759
1283
|
curationSetName: string;
|
|
1760
1284
|
}
|
|
1761
|
-
export declare const
|
|
1285
|
+
export declare const GetCurationSetRequest: S.Schema<GetCurationSetRequest>;
|
|
1762
1286
|
/** List of tag values to associate with this curation rule. */
|
|
1763
1287
|
export type CurationRuleTagsList = Array<string>;
|
|
1764
1288
|
export declare const CurationRuleTagsList: S.Schema<CurationRuleTagsList>;
|
|
@@ -1823,35 +1347,35 @@ export interface CurationItemCreateSchema {
|
|
|
1823
1347
|
}
|
|
1824
1348
|
export declare const CurationItemCreateSchema: S.Schema<CurationItemCreateSchema>;
|
|
1825
1349
|
/** Array of curation items */
|
|
1826
|
-
export type
|
|
1827
|
-
export declare const
|
|
1828
|
-
export interface
|
|
1350
|
+
export type GetCurationSetResponseItemsList = Array<CurationItemCreateSchema>;
|
|
1351
|
+
export declare const GetCurationSetResponseItemsList: S.Schema<GetCurationSetResponseItemsList>;
|
|
1352
|
+
export interface GetCurationSetResponse {
|
|
1829
1353
|
/** Array of curation items */
|
|
1830
|
-
items:
|
|
1354
|
+
items: GetCurationSetResponseItemsList;
|
|
1831
1355
|
/** Optional description for the curation set */
|
|
1832
1356
|
description?: string;
|
|
1833
1357
|
name: string;
|
|
1834
1358
|
}
|
|
1835
|
-
export declare const
|
|
1836
|
-
export interface
|
|
1359
|
+
export declare const GetCurationSetResponse: S.Schema<GetCurationSetResponse>;
|
|
1360
|
+
export interface GetCurationSetItemRequest {
|
|
1837
1361
|
/** The name of the curation set */
|
|
1838
1362
|
curationSetName: string;
|
|
1839
1363
|
/** The id of the curation item to retrieve */
|
|
1840
1364
|
itemId: string;
|
|
1841
1365
|
}
|
|
1842
|
-
export declare const
|
|
1366
|
+
export declare const GetCurationSetItemRequest: S.Schema<GetCurationSetItemRequest>;
|
|
1843
1367
|
/** List of document `id`s that should be included in the search results with their corresponding `position`s. */
|
|
1844
|
-
export type
|
|
1845
|
-
export declare const
|
|
1368
|
+
export type GetCurationSetItemResponseIncludesList = Array<CurationInclude>;
|
|
1369
|
+
export declare const GetCurationSetItemResponseIncludesList: S.Schema<GetCurationSetItemResponseIncludesList>;
|
|
1846
1370
|
/** List of document `id`s that should be excluded from the search results. */
|
|
1847
|
-
export type
|
|
1848
|
-
export declare const
|
|
1849
|
-
export interface
|
|
1371
|
+
export type GetCurationSetItemResponseExcludesList = Array<CurationExclude>;
|
|
1372
|
+
export declare const GetCurationSetItemResponseExcludesList: S.Schema<GetCurationSetItemResponseExcludesList>;
|
|
1373
|
+
export interface GetCurationSetItemResponse {
|
|
1850
1374
|
rule: CurationRule;
|
|
1851
1375
|
/** List of document `id`s that should be included in the search results with their corresponding `position`s. */
|
|
1852
|
-
includes?:
|
|
1376
|
+
includes?: GetCurationSetItemResponseIncludesList;
|
|
1853
1377
|
/** List of document `id`s that should be excluded from the search results. */
|
|
1854
|
-
excludes?:
|
|
1378
|
+
excludes?: GetCurationSetItemResponseExcludesList;
|
|
1855
1379
|
/** A filter by clause that is applied to any search query that matches the curation rule. */
|
|
1856
1380
|
filter_by?: string;
|
|
1857
1381
|
/** Indicates whether search query tokens that exist in the curation's rule should be removed from the search query. */
|
|
@@ -1873,12 +1397,12 @@ export interface RetrieveCurationSetItemResponse {
|
|
|
1873
1397
|
/** ID of the curation item */
|
|
1874
1398
|
id: string;
|
|
1875
1399
|
}
|
|
1876
|
-
export declare const
|
|
1877
|
-
export interface
|
|
1400
|
+
export declare const GetCurationSetItemResponse: S.Schema<GetCurationSetItemResponse>;
|
|
1401
|
+
export interface GetCurationSetItemsRequest {
|
|
1878
1402
|
/** The name of the curation set to retrieve items for */
|
|
1879
1403
|
curationSetName: string;
|
|
1880
1404
|
}
|
|
1881
|
-
export declare const
|
|
1405
|
+
export declare const GetCurationSetItemsRequest: S.Schema<GetCurationSetItemsRequest>;
|
|
1882
1406
|
/** List of document `id`s that should be included in the search results with their corresponding `position`s. */
|
|
1883
1407
|
export type CurationItemSchemaIncludesList = Array<CurationInclude>;
|
|
1884
1408
|
export declare const CurationItemSchemaIncludesList: S.Schema<CurationItemSchemaIncludesList>;
|
|
@@ -1912,43 +1436,94 @@ export interface CurationItemSchema {
|
|
|
1912
1436
|
/** ID of the curation item */
|
|
1913
1437
|
id: string;
|
|
1914
1438
|
}
|
|
1915
|
-
export declare const CurationItemSchema: S.Schema<CurationItemSchema>;
|
|
1916
|
-
export type
|
|
1917
|
-
export declare const
|
|
1918
|
-
export type
|
|
1919
|
-
export declare const
|
|
1920
|
-
export interface
|
|
1439
|
+
export declare const CurationItemSchema: S.Schema<CurationItemSchema>;
|
|
1440
|
+
export type GetCurationSetItemsResponseBodyList = Array<CurationItemSchema>;
|
|
1441
|
+
export declare const GetCurationSetItemsResponseBodyList: S.Schema<GetCurationSetItemsResponseBodyList>;
|
|
1442
|
+
export type GetCurationSetItemsResponse = GetCurationSetItemsResponseBodyList;
|
|
1443
|
+
export declare const GetCurationSetItemsResponse: S.Schema<GetCurationSetItemsResponse>;
|
|
1444
|
+
export interface GetCurationSetsRequest {
|
|
1445
|
+
}
|
|
1446
|
+
export declare const GetCurationSetsRequest: S.Schema<GetCurationSetsRequest>;
|
|
1447
|
+
/** Array of curation items */
|
|
1448
|
+
export type CurationSetSchemaItemsList = Array<CurationItemCreateSchema>;
|
|
1449
|
+
export declare const CurationSetSchemaItemsList: S.Schema<CurationSetSchemaItemsList>;
|
|
1450
|
+
export interface CurationSetSchema {
|
|
1451
|
+
/** Array of curation items */
|
|
1452
|
+
items: CurationSetSchemaItemsList;
|
|
1453
|
+
/** Optional description for the curation set */
|
|
1454
|
+
description?: string;
|
|
1455
|
+
name: string;
|
|
1456
|
+
}
|
|
1457
|
+
export declare const CurationSetSchema: S.Schema<CurationSetSchema>;
|
|
1458
|
+
export type GetCurationSetsResponseBodyList = Array<CurationSetSchema>;
|
|
1459
|
+
export declare const GetCurationSetsResponseBodyList: S.Schema<GetCurationSetsResponseBodyList>;
|
|
1460
|
+
export type GetCurationSetsResponse = GetCurationSetsResponseBodyList;
|
|
1461
|
+
export declare const GetCurationSetsResponse: S.Schema<GetCurationSetsResponse>;
|
|
1462
|
+
export interface GetDocumentRequest {
|
|
1463
|
+
/** The name of the collection to search for the document under */
|
|
1464
|
+
collectionName: string;
|
|
1465
|
+
/** The Document ID */
|
|
1466
|
+
documentId: string;
|
|
1467
|
+
}
|
|
1468
|
+
export declare const GetDocumentRequest: S.Schema<GetDocumentRequest>;
|
|
1469
|
+
export type GetDocumentResponse = unknown;
|
|
1470
|
+
export declare const GetDocumentResponse: S.Schema<GetDocumentResponse>;
|
|
1471
|
+
export interface GetKeyRequest {
|
|
1472
|
+
/** The ID of the key to retrieve */
|
|
1473
|
+
keyId: number;
|
|
1474
|
+
}
|
|
1475
|
+
export declare const GetKeyRequest: S.Schema<GetKeyRequest>;
|
|
1476
|
+
export type GetKeyResponseActionsList = Array<string>;
|
|
1477
|
+
export declare const GetKeyResponseActionsList: S.Schema<GetKeyResponseActionsList>;
|
|
1478
|
+
export type GetKeyResponseCollectionsList = Array<string>;
|
|
1479
|
+
export declare const GetKeyResponseCollectionsList: S.Schema<GetKeyResponseCollectionsList>;
|
|
1480
|
+
export interface GetKeyResponse {
|
|
1481
|
+
value?: string;
|
|
1482
|
+
description: string;
|
|
1483
|
+
actions: GetKeyResponseActionsList;
|
|
1484
|
+
collections: GetKeyResponseCollectionsList;
|
|
1485
|
+
expires_at?: number;
|
|
1486
|
+
id?: number;
|
|
1487
|
+
value_prefix?: string;
|
|
1921
1488
|
}
|
|
1922
|
-
export declare const
|
|
1923
|
-
|
|
1924
|
-
export type CurationSetSchemaItemsList = Array<CurationItemCreateSchema>;
|
|
1925
|
-
export declare const CurationSetSchemaItemsList: S.Schema<CurationSetSchemaItemsList>;
|
|
1926
|
-
export interface CurationSetSchema {
|
|
1927
|
-
/** Array of curation items */
|
|
1928
|
-
items: CurationSetSchemaItemsList;
|
|
1929
|
-
/** Optional description for the curation set */
|
|
1930
|
-
description?: string;
|
|
1931
|
-
name: string;
|
|
1489
|
+
export declare const GetKeyResponse: S.Schema<GetKeyResponse>;
|
|
1490
|
+
export interface GetKeysRequest {
|
|
1932
1491
|
}
|
|
1933
|
-
export declare const
|
|
1934
|
-
export type
|
|
1935
|
-
export declare const
|
|
1936
|
-
export type
|
|
1937
|
-
export declare const
|
|
1938
|
-
export interface
|
|
1939
|
-
|
|
1940
|
-
|
|
1941
|
-
|
|
1942
|
-
|
|
1943
|
-
|
|
1492
|
+
export declare const GetKeysRequest: S.Schema<GetKeysRequest>;
|
|
1493
|
+
export type ApiKeyActionsList = Array<string>;
|
|
1494
|
+
export declare const ApiKeyActionsList: S.Schema<ApiKeyActionsList>;
|
|
1495
|
+
export type ApiKeyCollectionsList = Array<string>;
|
|
1496
|
+
export declare const ApiKeyCollectionsList: S.Schema<ApiKeyCollectionsList>;
|
|
1497
|
+
export interface ApiKey {
|
|
1498
|
+
value?: string;
|
|
1499
|
+
description: string;
|
|
1500
|
+
actions: ApiKeyActionsList;
|
|
1501
|
+
collections: ApiKeyCollectionsList;
|
|
1502
|
+
expires_at?: number;
|
|
1503
|
+
id?: number;
|
|
1504
|
+
value_prefix?: string;
|
|
1505
|
+
}
|
|
1506
|
+
export declare const ApiKey: S.Schema<ApiKey>;
|
|
1507
|
+
export type ApiKeysResponseKeysList = Array<ApiKey>;
|
|
1508
|
+
export declare const ApiKeysResponseKeysList: S.Schema<ApiKeysResponseKeysList>;
|
|
1509
|
+
export interface ApiKeysResponse {
|
|
1510
|
+
keys: ApiKeysResponseKeysList;
|
|
1511
|
+
}
|
|
1512
|
+
export declare const ApiKeysResponse: S.Schema<ApiKeysResponse>;
|
|
1513
|
+
export interface GetMetricsRequest {
|
|
1514
|
+
}
|
|
1515
|
+
export declare const GetMetricsRequest: S.Schema<GetMetricsRequest>;
|
|
1516
|
+
export type GetMetricsResponse = unknown;
|
|
1517
|
+
export declare const GetMetricsResponse: S.Schema<GetMetricsResponse>;
|
|
1518
|
+
export interface GetNLSearchModelRequest {
|
|
1944
1519
|
/** The ID of the NL search model to retrieve */
|
|
1945
1520
|
modelId: string;
|
|
1946
1521
|
}
|
|
1947
|
-
export declare const
|
|
1522
|
+
export declare const GetNLSearchModelRequest: S.Schema<GetNLSearchModelRequest>;
|
|
1948
1523
|
/** Stop sequences for the NL model (Google-specific) */
|
|
1949
|
-
export type
|
|
1950
|
-
export declare const
|
|
1951
|
-
export interface
|
|
1524
|
+
export type GetNLSearchModelResponseStopSequencesList = Array<string>;
|
|
1525
|
+
export declare const GetNLSearchModelResponseStopSequencesList: S.Schema<GetNLSearchModelResponseStopSequencesList>;
|
|
1526
|
+
export interface GetNLSearchModelResponse {
|
|
1952
1527
|
/** Name of the NL model to use */
|
|
1953
1528
|
model_name?: string;
|
|
1954
1529
|
/** API key for the NL model service */
|
|
@@ -1966,7 +1541,7 @@ export interface RetrieveNLSearchModelResponse {
|
|
|
1966
1541
|
/** Top-k parameter for the NL model (Google-specific) */
|
|
1967
1542
|
top_k?: number;
|
|
1968
1543
|
/** Stop sequences for the NL model (Google-specific) */
|
|
1969
|
-
stop_sequences?:
|
|
1544
|
+
stop_sequences?: GetNLSearchModelResponseStopSequencesList;
|
|
1970
1545
|
/** API version for the NL model service */
|
|
1971
1546
|
api_version?: string;
|
|
1972
1547
|
/** Project ID for GCP Vertex AI */
|
|
@@ -1988,24 +1563,62 @@ export interface RetrieveNLSearchModelResponse {
|
|
|
1988
1563
|
/** Optional ID for the NL search model */
|
|
1989
1564
|
id: string;
|
|
1990
1565
|
}
|
|
1991
|
-
export declare const
|
|
1992
|
-
export interface
|
|
1566
|
+
export declare const GetNLSearchModelResponse: S.Schema<GetNLSearchModelResponse>;
|
|
1567
|
+
export interface GetPresetRequest {
|
|
1993
1568
|
/** The ID of the preset to retrieve. */
|
|
1994
1569
|
presetId: string;
|
|
1995
1570
|
}
|
|
1996
|
-
export declare const
|
|
1997
|
-
export type
|
|
1998
|
-
export declare const
|
|
1999
|
-
export interface
|
|
2000
|
-
value:
|
|
1571
|
+
export declare const GetPresetRequest: S.Schema<GetPresetRequest>;
|
|
1572
|
+
export type GetPresetResponseValue = SearchParameters | MultiSearchSearchesParameter;
|
|
1573
|
+
export declare const GetPresetResponseValue: any;
|
|
1574
|
+
export interface GetPresetResponse {
|
|
1575
|
+
value: GetPresetResponseValue;
|
|
2001
1576
|
name: string;
|
|
2002
1577
|
}
|
|
2003
|
-
export declare const
|
|
2004
|
-
export interface
|
|
1578
|
+
export declare const GetPresetResponse: S.Schema<GetPresetResponse>;
|
|
1579
|
+
export interface GetSchemaChangesRequest {
|
|
1580
|
+
}
|
|
1581
|
+
export declare const GetSchemaChangesRequest: S.Schema<GetSchemaChangesRequest>;
|
|
1582
|
+
export interface SchemaChangeStatus {
|
|
1583
|
+
/** Name of the collection being modified */
|
|
1584
|
+
collection?: string;
|
|
1585
|
+
/** Number of documents that have been validated */
|
|
1586
|
+
validated_docs?: number;
|
|
1587
|
+
/** Number of documents that have been altered */
|
|
1588
|
+
altered_docs?: number;
|
|
1589
|
+
}
|
|
1590
|
+
export declare const SchemaChangeStatus: S.Schema<SchemaChangeStatus>;
|
|
1591
|
+
export type GetSchemaChangesResponseBodyList = Array<SchemaChangeStatus>;
|
|
1592
|
+
export declare const GetSchemaChangesResponseBodyList: S.Schema<GetSchemaChangesResponseBodyList>;
|
|
1593
|
+
export type GetSchemaChangesResponse = GetSchemaChangesResponseBodyList;
|
|
1594
|
+
export declare const GetSchemaChangesResponse: S.Schema<GetSchemaChangesResponse>;
|
|
1595
|
+
export interface GetStemmingDictionaryRequest {
|
|
1596
|
+
/** The ID of the dictionary to retrieve */
|
|
1597
|
+
dictionaryId: string;
|
|
1598
|
+
}
|
|
1599
|
+
export declare const GetStemmingDictionaryRequest: S.Schema<GetStemmingDictionaryRequest>;
|
|
1600
|
+
export interface StemmingDictionaryWordsItem {
|
|
1601
|
+
/** The word form to be stemmed */
|
|
1602
|
+
word: string;
|
|
1603
|
+
/** The root form of the word */
|
|
1604
|
+
root: string;
|
|
1605
|
+
}
|
|
1606
|
+
export declare const StemmingDictionaryWordsItem: S.Schema<StemmingDictionaryWordsItem>;
|
|
1607
|
+
/** List of word mappings in the dictionary */
|
|
1608
|
+
export type StemmingDictionaryWordsList = Array<StemmingDictionaryWordsItem>;
|
|
1609
|
+
export declare const StemmingDictionaryWordsList: S.Schema<StemmingDictionaryWordsList>;
|
|
1610
|
+
export interface StemmingDictionary {
|
|
1611
|
+
/** Unique identifier for the dictionary */
|
|
1612
|
+
id: string;
|
|
1613
|
+
/** List of word mappings in the dictionary */
|
|
1614
|
+
words: StemmingDictionaryWordsList;
|
|
1615
|
+
}
|
|
1616
|
+
export declare const StemmingDictionary: S.Schema<StemmingDictionary>;
|
|
1617
|
+
export interface GetStopwordsSetRequest {
|
|
2005
1618
|
/** The ID of the stopwords set to retrieve. */
|
|
2006
1619
|
setId: string;
|
|
2007
1620
|
}
|
|
2008
|
-
export declare const
|
|
1621
|
+
export declare const GetStopwordsSetRequest: S.Schema<GetStopwordsSetRequest>;
|
|
2009
1622
|
export type StopwordsSetSchemaStopwordsList = Array<string>;
|
|
2010
1623
|
export declare const StopwordsSetSchemaStopwordsList: S.Schema<StopwordsSetSchemaStopwordsList>;
|
|
2011
1624
|
export interface StopwordsSetSchema {
|
|
@@ -2018,20 +1631,20 @@ export interface StopwordsSetRetrieveSchema {
|
|
|
2018
1631
|
stopwords: StopwordsSetSchema;
|
|
2019
1632
|
}
|
|
2020
1633
|
export declare const StopwordsSetRetrieveSchema: S.Schema<StopwordsSetRetrieveSchema>;
|
|
2021
|
-
export interface
|
|
1634
|
+
export interface GetStopwordsSetsRequest {
|
|
2022
1635
|
}
|
|
2023
|
-
export declare const
|
|
1636
|
+
export declare const GetStopwordsSetsRequest: S.Schema<GetStopwordsSetsRequest>;
|
|
2024
1637
|
export type StopwordsSetsRetrieveAllSchemaStopwordsList = Array<StopwordsSetSchema>;
|
|
2025
1638
|
export declare const StopwordsSetsRetrieveAllSchemaStopwordsList: S.Schema<StopwordsSetsRetrieveAllSchemaStopwordsList>;
|
|
2026
1639
|
export interface StopwordsSetsRetrieveAllSchema {
|
|
2027
1640
|
stopwords: StopwordsSetsRetrieveAllSchemaStopwordsList;
|
|
2028
1641
|
}
|
|
2029
1642
|
export declare const StopwordsSetsRetrieveAllSchema: S.Schema<StopwordsSetsRetrieveAllSchema>;
|
|
2030
|
-
export interface
|
|
1643
|
+
export interface GetSynonymSetRequest {
|
|
2031
1644
|
/** The name of the synonym set to retrieve */
|
|
2032
1645
|
synonymSetName: string;
|
|
2033
1646
|
}
|
|
2034
|
-
export declare const
|
|
1647
|
+
export declare const GetSynonymSetRequest: S.Schema<GetSynonymSetRequest>;
|
|
2035
1648
|
/** Array of words that should be considered as synonyms */
|
|
2036
1649
|
export type SynonymItemSchemaSynonymsList = Array<string>;
|
|
2037
1650
|
export declare const SynonymItemSchemaSynonymsList: S.Schema<SynonymItemSchemaSynonymsList>;
|
|
@@ -2052,53 +1665,53 @@ export interface SynonymItemSchema {
|
|
|
2052
1665
|
}
|
|
2053
1666
|
export declare const SynonymItemSchema: S.Schema<SynonymItemSchema>;
|
|
2054
1667
|
/** Array of synonym items */
|
|
2055
|
-
export type
|
|
2056
|
-
export declare const
|
|
2057
|
-
export interface
|
|
1668
|
+
export type GetSynonymSetResponseItemsList = Array<SynonymItemSchema>;
|
|
1669
|
+
export declare const GetSynonymSetResponseItemsList: S.Schema<GetSynonymSetResponseItemsList>;
|
|
1670
|
+
export interface GetSynonymSetResponse {
|
|
2058
1671
|
/** Array of synonym items */
|
|
2059
|
-
items:
|
|
1672
|
+
items: GetSynonymSetResponseItemsList;
|
|
2060
1673
|
/** Name of the synonym set */
|
|
2061
1674
|
name: string;
|
|
2062
1675
|
}
|
|
2063
|
-
export declare const
|
|
2064
|
-
export interface
|
|
1676
|
+
export declare const GetSynonymSetResponse: S.Schema<GetSynonymSetResponse>;
|
|
1677
|
+
export interface GetSynonymSetItemRequest {
|
|
2065
1678
|
/** The name of the synonym set */
|
|
2066
1679
|
synonymSetName: string;
|
|
2067
1680
|
/** The id of the synonym item to retrieve */
|
|
2068
1681
|
itemId: string;
|
|
2069
1682
|
}
|
|
2070
|
-
export declare const
|
|
1683
|
+
export declare const GetSynonymSetItemRequest: S.Schema<GetSynonymSetItemRequest>;
|
|
2071
1684
|
/** Array of words that should be considered as synonyms */
|
|
2072
|
-
export type
|
|
2073
|
-
export declare const
|
|
1685
|
+
export type GetSynonymSetItemResponseSynonymsList = Array<string>;
|
|
1686
|
+
export declare const GetSynonymSetItemResponseSynonymsList: S.Schema<GetSynonymSetItemResponseSynonymsList>;
|
|
2074
1687
|
/** By default, special characters are dropped from synonyms. Use this attribute to specify which special characters should be indexed as is */
|
|
2075
|
-
export type
|
|
2076
|
-
export declare const
|
|
2077
|
-
export interface
|
|
1688
|
+
export type GetSynonymSetItemResponseSymbolsToIndexList = Array<string>;
|
|
1689
|
+
export declare const GetSynonymSetItemResponseSymbolsToIndexList: S.Schema<GetSynonymSetItemResponseSymbolsToIndexList>;
|
|
1690
|
+
export interface GetSynonymSetItemResponse {
|
|
2078
1691
|
/** Unique identifier for the synonym item */
|
|
2079
1692
|
id: string;
|
|
2080
1693
|
/** Array of words that should be considered as synonyms */
|
|
2081
|
-
synonyms:
|
|
1694
|
+
synonyms: GetSynonymSetItemResponseSynonymsList;
|
|
2082
1695
|
/** For 1-way synonyms, indicates the root word that words in the synonyms parameter map to */
|
|
2083
1696
|
root?: string;
|
|
2084
1697
|
/** Locale for the synonym, leave blank to use the standard tokenizer */
|
|
2085
1698
|
locale?: string;
|
|
2086
1699
|
/** By default, special characters are dropped from synonyms. Use this attribute to specify which special characters should be indexed as is */
|
|
2087
|
-
symbols_to_index?:
|
|
1700
|
+
symbols_to_index?: GetSynonymSetItemResponseSymbolsToIndexList;
|
|
2088
1701
|
}
|
|
2089
|
-
export declare const
|
|
2090
|
-
export interface
|
|
1702
|
+
export declare const GetSynonymSetItemResponse: S.Schema<GetSynonymSetItemResponse>;
|
|
1703
|
+
export interface GetSynonymSetItemsRequest {
|
|
2091
1704
|
/** The name of the synonym set to retrieve items for */
|
|
2092
1705
|
synonymSetName: string;
|
|
2093
1706
|
}
|
|
2094
|
-
export declare const
|
|
2095
|
-
export type
|
|
2096
|
-
export declare const
|
|
2097
|
-
export type
|
|
2098
|
-
export declare const
|
|
2099
|
-
export interface
|
|
1707
|
+
export declare const GetSynonymSetItemsRequest: S.Schema<GetSynonymSetItemsRequest>;
|
|
1708
|
+
export type GetSynonymSetItemsResponseBodyList = Array<SynonymItemSchema>;
|
|
1709
|
+
export declare const GetSynonymSetItemsResponseBodyList: S.Schema<GetSynonymSetItemsResponseBodyList>;
|
|
1710
|
+
export type GetSynonymSetItemsResponse = GetSynonymSetItemsResponseBodyList;
|
|
1711
|
+
export declare const GetSynonymSetItemsResponse: S.Schema<GetSynonymSetItemsResponse>;
|
|
1712
|
+
export interface GetSynonymSetsRequest {
|
|
2100
1713
|
}
|
|
2101
|
-
export declare const
|
|
1714
|
+
export declare const GetSynonymSetsRequest: S.Schema<GetSynonymSetsRequest>;
|
|
2102
1715
|
/** Array of synonym items */
|
|
2103
1716
|
export type SynonymSetSchemaItemsList = Array<SynonymItemSchema>;
|
|
2104
1717
|
export declare const SynonymSetSchemaItemsList: S.Schema<SynonymSetSchemaItemsList>;
|
|
@@ -2109,23 +1722,218 @@ export interface SynonymSetSchema {
|
|
|
2109
1722
|
name: string;
|
|
2110
1723
|
}
|
|
2111
1724
|
export declare const SynonymSetSchema: S.Schema<SynonymSetSchema>;
|
|
2112
|
-
export type
|
|
2113
|
-
export declare const
|
|
2114
|
-
export type
|
|
2115
|
-
export declare const
|
|
1725
|
+
export type GetSynonymSetsResponseBodyList = Array<SynonymSetSchema>;
|
|
1726
|
+
export declare const GetSynonymSetsResponseBodyList: S.Schema<GetSynonymSetsResponseBodyList>;
|
|
1727
|
+
export type GetSynonymSetsResponse = GetSynonymSetsResponseBodyList;
|
|
1728
|
+
export declare const GetSynonymSetsResponse: S.Schema<GetSynonymSetsResponse>;
|
|
1729
|
+
export interface HealthRequest {
|
|
1730
|
+
}
|
|
1731
|
+
export declare const HealthRequest: S.Schema<HealthRequest>;
|
|
1732
|
+
export interface HealthStatus {
|
|
1733
|
+
ok: boolean;
|
|
1734
|
+
}
|
|
1735
|
+
export declare const HealthStatus: S.Schema<HealthStatus>;
|
|
1736
|
+
export type IndexAction = "create" | "update" | "upsert" | "emplace";
|
|
1737
|
+
export declare const IndexAction: any;
|
|
1738
|
+
export type DirtyValues = "coerce_or_reject" | "coerce_or_drop" | "drop" | "reject";
|
|
1739
|
+
export declare const DirtyValues: any;
|
|
1740
|
+
export interface ImportDocumentsRequestImportDocumentsParameters {
|
|
1741
|
+
batch_size?: number;
|
|
1742
|
+
/** Returning the id of the imported documents. If you want the import response to return the ingested document's id in the response, you can use the return_id parameter. */
|
|
1743
|
+
return_id?: boolean;
|
|
1744
|
+
remote_embedding_batch_size?: number;
|
|
1745
|
+
return_doc?: boolean;
|
|
1746
|
+
action?: IndexAction | (string & {});
|
|
1747
|
+
dirty_values?: DirtyValues | (string & {});
|
|
1748
|
+
}
|
|
1749
|
+
export declare const ImportDocumentsRequestImportDocumentsParameters: S.Schema<ImportDocumentsRequestImportDocumentsParameters>;
|
|
1750
|
+
export interface ImportDocumentsRequest {
|
|
1751
|
+
/** The name of the collection */
|
|
1752
|
+
collectionName: string;
|
|
1753
|
+
importDocumentsParameters?: ImportDocumentsRequestImportDocumentsParameters;
|
|
1754
|
+
}
|
|
1755
|
+
export declare const ImportDocumentsRequest: S.Schema<ImportDocumentsRequest>;
|
|
1756
|
+
export interface ImportDocumentsResponse {
|
|
1757
|
+
}
|
|
1758
|
+
export declare const ImportDocumentsResponse: S.Schema<ImportDocumentsResponse>;
|
|
1759
|
+
export interface ImportStemmingDictionaryRequest {
|
|
1760
|
+
/** The ID to assign to the dictionary */
|
|
1761
|
+
id: string;
|
|
1762
|
+
body: string;
|
|
1763
|
+
}
|
|
1764
|
+
export declare const ImportStemmingDictionaryRequest: S.Schema<ImportStemmingDictionaryRequest>;
|
|
1765
|
+
export interface ImportStemmingDictionaryResponse {
|
|
1766
|
+
}
|
|
1767
|
+
export declare const ImportStemmingDictionaryResponse: S.Schema<ImportStemmingDictionaryResponse>;
|
|
1768
|
+
export interface ListDocumentRequest {
|
|
1769
|
+
/** The name of the collection to add the document to */
|
|
1770
|
+
collectionName: string;
|
|
1771
|
+
/** Additional action to perform */
|
|
1772
|
+
action?: IndexAction | (string & {});
|
|
1773
|
+
/** Dealing with Dirty Data */
|
|
1774
|
+
dirty_values?: DirtyValues | (string & {});
|
|
1775
|
+
}
|
|
1776
|
+
export declare const ListDocumentRequest: S.Schema<ListDocumentRequest>;
|
|
1777
|
+
export type ListDocumentResponse = unknown;
|
|
1778
|
+
export declare const ListDocumentResponse: S.Schema<ListDocumentResponse>;
|
|
1779
|
+
export interface ListStemmingDictionariesRequest {
|
|
1780
|
+
}
|
|
1781
|
+
export declare const ListStemmingDictionariesRequest: S.Schema<ListStemmingDictionariesRequest>;
|
|
1782
|
+
export type ListStemmingDictionariesResponseDictionariesList = Array<string>;
|
|
1783
|
+
export declare const ListStemmingDictionariesResponseDictionariesList: S.Schema<ListStemmingDictionariesResponseDictionariesList>;
|
|
1784
|
+
export interface ListStemmingDictionariesResponse {
|
|
1785
|
+
dictionaries?: ListStemmingDictionariesResponseDictionariesList;
|
|
1786
|
+
}
|
|
1787
|
+
export declare const ListStemmingDictionariesResponse: S.Schema<ListStemmingDictionariesResponse>;
|
|
2116
1788
|
export interface SearchCollectionRequest {
|
|
2117
1789
|
/** The name of the collection to search for the document under */
|
|
2118
1790
|
collectionName: string;
|
|
2119
1791
|
searchParameters: SearchParameters;
|
|
2120
1792
|
}
|
|
2121
|
-
export declare const SearchCollectionRequest: S.Schema<SearchCollectionRequest>;
|
|
2122
|
-
export
|
|
2123
|
-
|
|
1793
|
+
export declare const SearchCollectionRequest: S.Schema<SearchCollectionRequest>;
|
|
1794
|
+
export interface FacetCountsCountsItem {
|
|
1795
|
+
count?: number;
|
|
1796
|
+
highlighted?: string;
|
|
1797
|
+
value?: string;
|
|
1798
|
+
parent?: unknown;
|
|
1799
|
+
}
|
|
1800
|
+
export declare const FacetCountsCountsItem: S.Schema<FacetCountsCountsItem>;
|
|
1801
|
+
export type FacetCountsCountsList = Array<FacetCountsCountsItem>;
|
|
1802
|
+
export declare const FacetCountsCountsList: S.Schema<FacetCountsCountsList>;
|
|
1803
|
+
export interface FacetCountsStats {
|
|
1804
|
+
max?: number;
|
|
1805
|
+
min?: number;
|
|
1806
|
+
sum?: number;
|
|
1807
|
+
total_values?: number;
|
|
1808
|
+
avg?: number;
|
|
1809
|
+
}
|
|
1810
|
+
export declare const FacetCountsStats: S.Schema<FacetCountsStats>;
|
|
1811
|
+
export interface FacetCounts {
|
|
1812
|
+
counts?: FacetCountsCountsList;
|
|
1813
|
+
field_name?: string;
|
|
1814
|
+
sampled?: boolean;
|
|
1815
|
+
stats?: FacetCountsStats;
|
|
1816
|
+
}
|
|
1817
|
+
export declare const FacetCounts: S.Schema<FacetCounts>;
|
|
1818
|
+
export type SearchResultFacetCountsList = Array<FacetCounts>;
|
|
1819
|
+
export declare const SearchResultFacetCountsList: S.Schema<SearchResultFacetCountsList>;
|
|
1820
|
+
export type SearchGroupedHitGroupKeyList = Array<unknown>;
|
|
1821
|
+
export declare const SearchGroupedHitGroupKeyList: S.Schema<SearchGroupedHitGroupKeyList>;
|
|
1822
|
+
/** Present only for (array) string[] fields */
|
|
1823
|
+
export type SearchHighlightSnippetsList = Array<string>;
|
|
1824
|
+
export declare const SearchHighlightSnippetsList: S.Schema<SearchHighlightSnippetsList>;
|
|
1825
|
+
/** Full field value with highlighting, present only for (array) string[] fields */
|
|
1826
|
+
export type SearchHighlightValuesList = Array<string>;
|
|
1827
|
+
export declare const SearchHighlightValuesList: S.Schema<SearchHighlightValuesList>;
|
|
1828
|
+
/** The indices property will be present only for string[] fields and will contain the corresponding indices of the snippets in the search field */
|
|
1829
|
+
export type SearchHighlightIndicesList = Array<number>;
|
|
1830
|
+
export declare const SearchHighlightIndicesList: S.Schema<SearchHighlightIndicesList>;
|
|
1831
|
+
export type SearchHighlightMatchedTokensList = Array<unknown>;
|
|
1832
|
+
export declare const SearchHighlightMatchedTokensList: S.Schema<SearchHighlightMatchedTokensList>;
|
|
1833
|
+
export interface SearchHighlight {
|
|
1834
|
+
field?: string;
|
|
1835
|
+
/** Present only for (non-array) string fields */
|
|
1836
|
+
snippet?: string;
|
|
1837
|
+
/** Present only for (array) string[] fields */
|
|
1838
|
+
snippets?: SearchHighlightSnippetsList;
|
|
1839
|
+
/** Full field value with highlighting, present only for (non-array) string fields */
|
|
1840
|
+
value?: string;
|
|
1841
|
+
/** Full field value with highlighting, present only for (array) string[] fields */
|
|
1842
|
+
values?: SearchHighlightValuesList;
|
|
1843
|
+
/** The indices property will be present only for string[] fields and will contain the corresponding indices of the snippets in the search field */
|
|
1844
|
+
indices?: SearchHighlightIndicesList;
|
|
1845
|
+
matched_tokens?: SearchHighlightMatchedTokensList;
|
|
1846
|
+
}
|
|
1847
|
+
export declare const SearchHighlight: S.Schema<SearchHighlight>;
|
|
1848
|
+
/** (Deprecated) Contains highlighted portions of the search fields */
|
|
1849
|
+
export type SearchResultHitHighlightsList = Array<SearchHighlight>;
|
|
1850
|
+
export declare const SearchResultHitHighlightsList: S.Schema<SearchResultHitHighlightsList>;
|
|
1851
|
+
/** Highlighted version of the matching document */
|
|
1852
|
+
export type SearchResultHitHighlightMap = {
|
|
1853
|
+
[key: string]: unknown | undefined;
|
|
1854
|
+
};
|
|
1855
|
+
export declare const SearchResultHitHighlightMap: S.Schema<SearchResultHitHighlightMap>;
|
|
1856
|
+
/** Can be any key-value pair */
|
|
1857
|
+
export type SearchResultHitDocumentMap = {
|
|
1858
|
+
[key: string]: unknown | undefined;
|
|
1859
|
+
};
|
|
1860
|
+
export declare const SearchResultHitDocumentMap: S.Schema<SearchResultHitDocumentMap>;
|
|
1861
|
+
export interface SearchResultHitTextMatchInfo {
|
|
1862
|
+
best_field_score?: string;
|
|
1863
|
+
best_field_weight?: number;
|
|
1864
|
+
fields_matched?: number;
|
|
1865
|
+
num_tokens_dropped?: number;
|
|
1866
|
+
score?: string;
|
|
1867
|
+
tokens_matched?: number;
|
|
1868
|
+
typo_prefix_score?: number;
|
|
1869
|
+
}
|
|
1870
|
+
export declare const SearchResultHitTextMatchInfo: S.Schema<SearchResultHitTextMatchInfo>;
|
|
1871
|
+
/** Can be any key-value pair */
|
|
1872
|
+
export type SearchResultHitGeoDistanceMetersMap = {
|
|
1873
|
+
[key: string]: number | undefined;
|
|
1874
|
+
};
|
|
1875
|
+
export declare const SearchResultHitGeoDistanceMetersMap: S.Schema<SearchResultHitGeoDistanceMetersMap>;
|
|
1876
|
+
/** Information about hybrid search scoring */
|
|
1877
|
+
export interface SearchResultHitHybridSearchInfo {
|
|
1878
|
+
/** Combined score from rank fusion of text and vector search */
|
|
1879
|
+
rank_fusion_score?: number;
|
|
1880
|
+
}
|
|
1881
|
+
export declare const SearchResultHitHybridSearchInfo: S.Schema<SearchResultHitHybridSearchInfo>;
|
|
1882
|
+
export interface SearchResultHit {
|
|
1883
|
+
/** (Deprecated) Contains highlighted portions of the search fields */
|
|
1884
|
+
highlights?: SearchResultHitHighlightsList;
|
|
1885
|
+
/** Highlighted version of the matching document */
|
|
1886
|
+
highlight?: SearchResultHitHighlightMap;
|
|
1887
|
+
/** Can be any key-value pair */
|
|
1888
|
+
document?: SearchResultHitDocumentMap;
|
|
1889
|
+
text_match?: number;
|
|
1890
|
+
text_match_info?: SearchResultHitTextMatchInfo;
|
|
1891
|
+
/** Can be any key-value pair */
|
|
1892
|
+
geo_distance_meters?: SearchResultHitGeoDistanceMetersMap;
|
|
1893
|
+
/** Distance between the query vector and matching document's vector value */
|
|
1894
|
+
vector_distance?: number;
|
|
1895
|
+
/** Information about hybrid search scoring */
|
|
1896
|
+
hybrid_search_info?: SearchResultHitHybridSearchInfo;
|
|
1897
|
+
/** Returned only for union query response. Indicates the index of the query which this document matched to. */
|
|
1898
|
+
search_index?: number;
|
|
1899
|
+
}
|
|
1900
|
+
export declare const SearchResultHit: S.Schema<SearchResultHit>;
|
|
1901
|
+
/** The documents that matched the search query */
|
|
1902
|
+
export type SearchGroupedHitHitsList = Array<SearchResultHit>;
|
|
1903
|
+
export declare const SearchGroupedHitHitsList: S.Schema<SearchGroupedHitHitsList>;
|
|
1904
|
+
export interface SearchGroupedHit {
|
|
1905
|
+
found?: number;
|
|
1906
|
+
group_key: SearchGroupedHitGroupKeyList;
|
|
1907
|
+
/** The documents that matched the search query */
|
|
1908
|
+
hits: SearchGroupedHitHitsList;
|
|
1909
|
+
}
|
|
1910
|
+
export declare const SearchGroupedHit: S.Schema<SearchGroupedHit>;
|
|
2124
1911
|
export type SearchResultGroupedHitsList = Array<SearchGroupedHit>;
|
|
2125
1912
|
export declare const SearchResultGroupedHitsList: S.Schema<SearchResultGroupedHitsList>;
|
|
2126
1913
|
/** The documents that matched the search query */
|
|
2127
1914
|
export type SearchResultHitsList = Array<SearchResultHit>;
|
|
2128
1915
|
export declare const SearchResultHitsList: S.Schema<SearchResultHitsList>;
|
|
1916
|
+
export interface SearchRequestParamsVoiceQuery {
|
|
1917
|
+
transcribed_query?: string;
|
|
1918
|
+
}
|
|
1919
|
+
export declare const SearchRequestParamsVoiceQuery: S.Schema<SearchRequestParamsVoiceQuery>;
|
|
1920
|
+
export interface SearchRequestParams {
|
|
1921
|
+
collection_name: string;
|
|
1922
|
+
first_q?: string;
|
|
1923
|
+
q: string;
|
|
1924
|
+
per_page: number;
|
|
1925
|
+
voice_query?: SearchRequestParamsVoiceQuery;
|
|
1926
|
+
}
|
|
1927
|
+
export declare const SearchRequestParams: S.Schema<SearchRequestParams>;
|
|
1928
|
+
export type SearchResultConversationConversationHistoryList = Array<unknown>;
|
|
1929
|
+
export declare const SearchResultConversationConversationHistoryList: S.Schema<SearchResultConversationConversationHistoryList>;
|
|
1930
|
+
export interface SearchResultConversation {
|
|
1931
|
+
answer: string;
|
|
1932
|
+
conversation_history: SearchResultConversationConversationHistoryList;
|
|
1933
|
+
conversation_id: string;
|
|
1934
|
+
query: string;
|
|
1935
|
+
}
|
|
1936
|
+
export declare const SearchResultConversation: S.Schema<SearchResultConversation>;
|
|
2129
1937
|
/** Returned only for union query response. */
|
|
2130
1938
|
export type SearchResultUnionRequestParamsList = Array<SearchRequestParams>;
|
|
2131
1939
|
export declare const SearchResultUnionRequestParamsList: S.Schema<SearchResultUnionRequestParamsList>;
|
|
@@ -2158,6 +1966,198 @@ export interface SearchResult {
|
|
|
2158
1966
|
metadata?: SearchResultMetadataMap;
|
|
2159
1967
|
}
|
|
2160
1968
|
export declare const SearchResult: S.Schema<SearchResult>;
|
|
1969
|
+
/** Parameters for the multi search API. */
|
|
1970
|
+
export interface MultiSearchParameters {
|
|
1971
|
+
/** The query text to search for in the collection. Use * as the search string to return all documents. This is typically useful when used in conjunction with filter_by. */
|
|
1972
|
+
q?: string;
|
|
1973
|
+
/** A list of `string` fields that should be queried against. Multiple fields are separated with a comma. */
|
|
1974
|
+
query_by?: string;
|
|
1975
|
+
/** The relative weight to give each `query_by` field when ranking results. This can be used to boost fields in priority, when looking for matches. Multiple fields are separated with a comma. */
|
|
1976
|
+
query_by_weights?: string;
|
|
1977
|
+
/** In a multi-field matching context, this parameter determines how the representative text match score of a record is calculated. Possible values are max_score (default) or max_weight. */
|
|
1978
|
+
text_match_type?: string;
|
|
1979
|
+
/** Boolean field to indicate that the last word in the query should be treated as a prefix, and not as a whole word. This is used for building autocomplete and instant search interfaces. Defaults to true. */
|
|
1980
|
+
prefix?: string;
|
|
1981
|
+
/** If infix index is enabled for this field, infix searching can be done on a per-field basis by sending a comma separated string parameter called infix to the search query. This parameter can have 3 values; `off` infix search is disabled, which is default `always` infix search is performed along with regular search `fallback` infix search is performed if regular search does not produce results */
|
|
1982
|
+
infix?: string;
|
|
1983
|
+
/** There are also 2 parameters that allow you to control the extent of infix searching max_extra_prefix and max_extra_suffix which specify the maximum number of symbols before or after the query that can be present in the token. For example query "K2100" has 2 extra symbols in "6PK2100". By default, any number of prefixes/suffixes can be present for a match. */
|
|
1984
|
+
max_extra_prefix?: number;
|
|
1985
|
+
/** There are also 2 parameters that allow you to control the extent of infix searching max_extra_prefix and max_extra_suffix which specify the maximum number of symbols before or after the query that can be present in the token. For example query "K2100" has 2 extra symbols in "6PK2100". By default, any number of prefixes/suffixes can be present for a match. */
|
|
1986
|
+
max_extra_suffix?: number;
|
|
1987
|
+
/** Filter conditions for refining youropen api validator search results. Separate multiple conditions with &&. */
|
|
1988
|
+
filter_by?: string;
|
|
1989
|
+
/** A list of numerical fields and their corresponding sort orders that will be used for ordering your results. Up to 3 sort fields can be specified. The text similarity score is exposed as a special `_text_match` field that you can use in the list of sorting fields. If no `sort_by` parameter is specified, results are sorted by `_text_match:desc,default_sorting_field:desc` */
|
|
1990
|
+
sort_by?: string;
|
|
1991
|
+
/** A list of fields that will be used for faceting your results on. Separate multiple fields with a comma. */
|
|
1992
|
+
facet_by?: string;
|
|
1993
|
+
/** Maximum number of facet values to be returned. */
|
|
1994
|
+
max_facet_values?: number;
|
|
1995
|
+
/** Facet values that are returned can now be filtered via this parameter. The matching facet text is also highlighted. For example, when faceting by `category`, you can set `facet_query=category:shoe` to return only facet values that contain the prefix "shoe". */
|
|
1996
|
+
facet_query?: string;
|
|
1997
|
+
/** The number of typographical errors (1 or 2) that would be tolerated. Default: 2 */
|
|
1998
|
+
num_typos?: string;
|
|
1999
|
+
/** Results from this specific page number would be fetched. */
|
|
2000
|
+
page?: number;
|
|
2001
|
+
/** Number of results to fetch per page. Default: 10 */
|
|
2002
|
+
per_page?: number;
|
|
2003
|
+
/** Number of hits to fetch. Can be used as an alternative to the per_page parameter. Default: 10. */
|
|
2004
|
+
limit?: number;
|
|
2005
|
+
/** Identifies the starting point to return hits from a result set. Can be used as an alternative to the page parameter. */
|
|
2006
|
+
offset?: number;
|
|
2007
|
+
/** You can aggregate search results into groups or buckets by specify one or more `group_by` fields. Separate multiple fields with a comma. To group on a particular field, it must be a faceted field. */
|
|
2008
|
+
group_by?: string;
|
|
2009
|
+
/** Maximum number of hits to be returned for every group. If the `group_limit` is set as `K` then only the top K hits in each group are returned in the response. Default: 3 */
|
|
2010
|
+
group_limit?: number;
|
|
2011
|
+
/** Setting this parameter to true will place all documents that have a null value in the group_by field, into a single group. Setting this parameter to false, will cause each document with a null value in the group_by field to not be grouped with other documents. Default: true */
|
|
2012
|
+
group_missing_values?: boolean;
|
|
2013
|
+
/** List of fields from the document to include in the search result */
|
|
2014
|
+
include_fields?: string;
|
|
2015
|
+
/** List of fields from the document to exclude in the search result */
|
|
2016
|
+
exclude_fields?: string;
|
|
2017
|
+
/** List of fields which should be highlighted fully without snippeting */
|
|
2018
|
+
highlight_full_fields?: string;
|
|
2019
|
+
/** The number of tokens that should surround the highlighted text on each side. Default: 4 */
|
|
2020
|
+
highlight_affix_num_tokens?: number;
|
|
2021
|
+
/** The start tag used for the highlighted snippets. Default: `<mark>` */
|
|
2022
|
+
highlight_start_tag?: string;
|
|
2023
|
+
/** The end tag used for the highlighted snippets. Default: `</mark>` */
|
|
2024
|
+
highlight_end_tag?: string;
|
|
2025
|
+
/** Field values under this length will be fully highlighted, instead of showing a snippet of relevant portion. Default: 30 */
|
|
2026
|
+
snippet_threshold?: number;
|
|
2027
|
+
/** If the number of results found for a specific query is less than this number, Typesense will attempt to drop the tokens in the query until enough results are found. Tokens that have the least individual hits are dropped first. Set to 0 to disable. Default: 10 */
|
|
2028
|
+
drop_tokens_threshold?: number;
|
|
2029
|
+
drop_tokens_mode?: DropTokensMode | (string & {});
|
|
2030
|
+
/** If the number of results found for a specific query is less than this number, Typesense will attempt to look for tokens with more typos until enough results are found. Default: 100 */
|
|
2031
|
+
typo_tokens_threshold?: number;
|
|
2032
|
+
/** Set this parameter to false to disable typos on alphanumerical query tokens. Default: true. */
|
|
2033
|
+
enable_typos_for_alpha_numerical_tokens?: boolean;
|
|
2034
|
+
/** Whether the filter_by condition of the search query should be applicable to curated results (curation definitions, pinned hits, hidden hits, etc.). Default: false */
|
|
2035
|
+
filter_curated_hits?: boolean;
|
|
2036
|
+
/** If you have some synonyms defined but want to disable all of them for a particular search query, set enable_synonyms to false. Default: true */
|
|
2037
|
+
enable_synonyms?: boolean;
|
|
2038
|
+
/** Flag for enabling/disabling analytics aggregation for specific search queries (for e.g. those originating from a test script). */
|
|
2039
|
+
enable_analytics?: boolean;
|
|
2040
|
+
/** Allow synonym resolution on word prefixes in the query. Default: false */
|
|
2041
|
+
synonym_prefix?: boolean;
|
|
2042
|
+
/** Allow synonym resolution on typo-corrected words in the query. Default: 0 */
|
|
2043
|
+
synonym_num_typos?: number;
|
|
2044
|
+
/** A list of records to unconditionally include in the search results at specific positions. An example use case would be to feature or promote certain items on the top of search results. A list of `record_id:hit_position`. Eg: to include a record with ID 123 at Position 1 and another record with ID 456 at Position 5, you'd specify `123:1,456:5`. You could also use the Curation feature to override search results based on rules. Curations are applied first, followed by `pinned_hits` and finally `hidden_hits`. */
|
|
2045
|
+
pinned_hits?: string;
|
|
2046
|
+
/** A list of records to unconditionally hide from search results. A list of `record_id`s to hide. Eg: to hide records with IDs 123 and 456, you'd specify `123,456`. You could also use the Curation feature to override search results based on rules. Curations are applied first, followed by `pinned_hits` and finally `hidden_hits`. */
|
|
2047
|
+
hidden_hits?: string;
|
|
2048
|
+
/** Comma separated list of tags to trigger the curations rules that match the tags. */
|
|
2049
|
+
curation_tags?: string;
|
|
2050
|
+
/** A list of custom fields that must be highlighted even if you don't query for them */
|
|
2051
|
+
highlight_fields?: string;
|
|
2052
|
+
/** You can index content from any logographic language into Typesense if you are able to segment / split the text into space-separated words yourself before indexing and querying. Set this parameter to true to do the same */
|
|
2053
|
+
pre_segmented_query?: boolean;
|
|
2054
|
+
/** Search using a bunch of search parameters by setting this parameter to the name of the existing Preset. */
|
|
2055
|
+
preset?: string;
|
|
2056
|
+
/** If you have some curation sets defined but want to disable all of them during query time, you can do that by setting this parameter to false */
|
|
2057
|
+
enable_curations?: boolean;
|
|
2058
|
+
/** Set this parameter to true to ensure that an exact match is ranked above the others */
|
|
2059
|
+
prioritize_exact_match?: boolean;
|
|
2060
|
+
/** Make Typesense prioritize documents where the query words appear earlier in the text. */
|
|
2061
|
+
prioritize_token_position?: boolean;
|
|
2062
|
+
/** Make Typesense prioritize documents where the query words appear in more number of fields. */
|
|
2063
|
+
prioritize_num_matching_fields?: boolean;
|
|
2064
|
+
/** Make Typesense disable typos for numerical tokens. */
|
|
2065
|
+
enable_typos_for_numerical_tokens?: boolean;
|
|
2066
|
+
/** Setting this to true will make Typesense consider all prefixes and typo corrections of the words in the query without stopping early when enough results are found (drop_tokens_threshold and typo_tokens_threshold configurations are ignored). */
|
|
2067
|
+
exhaustive_search?: boolean;
|
|
2068
|
+
/** Typesense will attempt to return results early if the cutoff time has elapsed. This is not a strict guarantee and facet computation is not bound by this parameter. */
|
|
2069
|
+
search_cutoff_ms?: number;
|
|
2070
|
+
/** Enable server side caching of search query results. By default, caching is disabled. */
|
|
2071
|
+
use_cache?: boolean;
|
|
2072
|
+
/** The duration (in seconds) that determines how long the search query is cached. This value can be set on a per-query basis. Default: 60. */
|
|
2073
|
+
cache_ttl?: number;
|
|
2074
|
+
/** Minimum word length for 1-typo correction to be applied. The value of num_typos is still treated as the maximum allowed typos. */
|
|
2075
|
+
min_len_1typo?: number;
|
|
2076
|
+
/** Minimum word length for 2-typo correction to be applied. The value of num_typos is still treated as the maximum allowed typos. */
|
|
2077
|
+
min_len_2typo?: number;
|
|
2078
|
+
/** Vector query expression for fetching documents "closest" to a given query/document vector. */
|
|
2079
|
+
vector_query?: string;
|
|
2080
|
+
/** Timeout (in milliseconds) for fetching remote embeddings. */
|
|
2081
|
+
remote_embedding_timeout_ms?: number;
|
|
2082
|
+
/** Number of times to retry fetching remote embeddings. */
|
|
2083
|
+
remote_embedding_num_tries?: number;
|
|
2084
|
+
/** Choose the underlying faceting strategy used. Comma separated string of allows values: exhaustive, top_values or automatic (default). */
|
|
2085
|
+
facet_strategy?: string;
|
|
2086
|
+
/** Name of the stopwords set to apply for this search, the keywords present in the set will be removed from the search query. */
|
|
2087
|
+
stopwords?: string;
|
|
2088
|
+
/** Comma separated string of nested facet fields whose parent object should be returned in facet response. */
|
|
2089
|
+
facet_return_parent?: string;
|
|
2090
|
+
/** The base64 encoded audio file in 16 khz 16-bit WAV format. */
|
|
2091
|
+
voice_query?: string;
|
|
2092
|
+
/** Enable conversational search. */
|
|
2093
|
+
conversation?: boolean;
|
|
2094
|
+
/** The Id of Conversation Model to be used. */
|
|
2095
|
+
conversation_model_id?: string;
|
|
2096
|
+
/** The Id of a previous conversation to continue, this tells Typesense to include prior context when communicating with the LLM. */
|
|
2097
|
+
conversation_id?: string;
|
|
2098
|
+
/** Controls whether Typesense should validate if the fields exist in the schema. When set to false, Typesense will not throw an error if a field is missing. This is useful for programmatic grouping where not all fields may exist. */
|
|
2099
|
+
validate_field_names?: boolean;
|
|
2100
|
+
}
|
|
2101
|
+
export declare const MultiSearchParameters: S.Schema<MultiSearchParameters>;
|
|
2102
|
+
export type SearchMultiRequestSearchesList = Array<MultiSearchCollectionParameters>;
|
|
2103
|
+
export declare const SearchMultiRequestSearchesList: S.Schema<SearchMultiRequestSearchesList>;
|
|
2104
|
+
export interface SearchMultiRequest {
|
|
2105
|
+
multiSearchParameters: MultiSearchParameters;
|
|
2106
|
+
/** When true, merges the search results from each search query into a single ordered set of hits. */
|
|
2107
|
+
union?: boolean;
|
|
2108
|
+
searches: SearchMultiRequestSearchesList;
|
|
2109
|
+
}
|
|
2110
|
+
export declare const SearchMultiRequest: S.Schema<SearchMultiRequest>;
|
|
2111
|
+
export type MultiSearchResultItemFacetCountsList = Array<FacetCounts>;
|
|
2112
|
+
export declare const MultiSearchResultItemFacetCountsList: S.Schema<MultiSearchResultItemFacetCountsList>;
|
|
2113
|
+
export type MultiSearchResultItemGroupedHitsList = Array<SearchGroupedHit>;
|
|
2114
|
+
export declare const MultiSearchResultItemGroupedHitsList: S.Schema<MultiSearchResultItemGroupedHitsList>;
|
|
2115
|
+
/** The documents that matched the search query */
|
|
2116
|
+
export type MultiSearchResultItemHitsList = Array<SearchResultHit>;
|
|
2117
|
+
export declare const MultiSearchResultItemHitsList: S.Schema<MultiSearchResultItemHitsList>;
|
|
2118
|
+
/** Returned only for union query response. */
|
|
2119
|
+
export type MultiSearchResultItemUnionRequestParamsList = Array<SearchRequestParams>;
|
|
2120
|
+
export declare const MultiSearchResultItemUnionRequestParamsList: S.Schema<MultiSearchResultItemUnionRequestParamsList>;
|
|
2121
|
+
/** Custom JSON object that can be returned in the search response */
|
|
2122
|
+
export type MultiSearchResultItemMetadataMap = {
|
|
2123
|
+
[key: string]: unknown | undefined;
|
|
2124
|
+
};
|
|
2125
|
+
export declare const MultiSearchResultItemMetadataMap: S.Schema<MultiSearchResultItemMetadataMap>;
|
|
2126
|
+
export interface MultiSearchResultItem {
|
|
2127
|
+
facet_counts?: MultiSearchResultItemFacetCountsList;
|
|
2128
|
+
/** The number of documents found */
|
|
2129
|
+
found?: number;
|
|
2130
|
+
found_docs?: number;
|
|
2131
|
+
/** The number of milliseconds the search took */
|
|
2132
|
+
search_time_ms?: number;
|
|
2133
|
+
/** The total number of documents in the collection */
|
|
2134
|
+
out_of?: number;
|
|
2135
|
+
/** Whether the search was cut off */
|
|
2136
|
+
search_cutoff?: boolean;
|
|
2137
|
+
/** The search result page number */
|
|
2138
|
+
page?: number;
|
|
2139
|
+
grouped_hits?: MultiSearchResultItemGroupedHitsList;
|
|
2140
|
+
/** The documents that matched the search query */
|
|
2141
|
+
hits?: MultiSearchResultItemHitsList;
|
|
2142
|
+
request_params?: SearchRequestParams;
|
|
2143
|
+
conversation?: SearchResultConversation;
|
|
2144
|
+
/** Returned only for union query response. */
|
|
2145
|
+
union_request_params?: MultiSearchResultItemUnionRequestParamsList;
|
|
2146
|
+
/** Custom JSON object that can be returned in the search response */
|
|
2147
|
+
metadata?: MultiSearchResultItemMetadataMap;
|
|
2148
|
+
/** HTTP error code */
|
|
2149
|
+
code?: number;
|
|
2150
|
+
/** Error description */
|
|
2151
|
+
error?: string;
|
|
2152
|
+
}
|
|
2153
|
+
export declare const MultiSearchResultItem: S.Schema<MultiSearchResultItem>;
|
|
2154
|
+
export type MultiSearchResultResultsList = Array<MultiSearchResultItem>;
|
|
2155
|
+
export declare const MultiSearchResultResultsList: S.Schema<MultiSearchResultResultsList>;
|
|
2156
|
+
export interface MultiSearchResult {
|
|
2157
|
+
results: MultiSearchResultResultsList;
|
|
2158
|
+
conversation?: SearchResultConversation;
|
|
2159
|
+
}
|
|
2160
|
+
export declare const MultiSearchResult: S.Schema<MultiSearchResult>;
|
|
2161
2161
|
export interface TakeSnapshotRequest {
|
|
2162
2162
|
/** The directory on the server where the snapshot should be saved. */
|
|
2163
2163
|
snapshot_path: string;
|
|
@@ -2670,18 +2670,51 @@ export declare const getAlias: API.OperationMethod<GetAliasRequest, CollectionAl
|
|
|
2670
2670
|
export type GetAliasesError = TypesenseOpError;
|
|
2671
2671
|
/** List all aliases List all aliases and the corresponding collections that they map to. */
|
|
2672
2672
|
export declare const getAliases: API.OperationMethod<GetAliasesRequest, CollectionAliasesResponse, GetAliasesError, TypesenseOpContext>;
|
|
2673
|
+
export type GetAllConversationModelsError = TypesenseOpError;
|
|
2674
|
+
/** List all conversation models Retrieve all conversation models */
|
|
2675
|
+
export declare const getAllConversationModels: API.OperationMethod<GetAllConversationModelsRequest, GetAllConversationModelsResponse, GetAllConversationModelsError, TypesenseOpContext>;
|
|
2676
|
+
export type GetAllNLSearchModelsError = TypesenseOpError;
|
|
2677
|
+
/** List all NL search models Retrieve all NL search models. */
|
|
2678
|
+
export declare const getAllNLSearchModels: API.OperationMethod<GetAllNLSearchModelsRequest, GetAllNLSearchModelsResponse, GetAllNLSearchModelsError, TypesenseOpContext>;
|
|
2679
|
+
export type GetAllPresetsError = TypesenseOpError;
|
|
2680
|
+
/** Retrieves all presets. Retrieve the details of all presets */
|
|
2681
|
+
export declare const getAllPresets: API.OperationMethod<GetAllPresetsRequest, PresetsRetrieveSchema, GetAllPresetsError, TypesenseOpContext>;
|
|
2673
2682
|
export type GetAnalyticsEventsError = BadRequest | TypesenseOpError;
|
|
2674
2683
|
/** Retrieve analytics events Retrieve the most recent events for a user and rule. */
|
|
2675
2684
|
export declare const getAnalyticsEvents: API.OperationMethod<GetAnalyticsEventsRequest, AnalyticsEventsResponse, GetAnalyticsEventsError, TypesenseOpContext>;
|
|
2685
|
+
export type GetAnalyticsRuleError = NotFound | TypesenseOpError;
|
|
2686
|
+
/** Retrieves an analytics rule Retrieve the details of an analytics rule, given it's name */
|
|
2687
|
+
export declare const getAnalyticsRule: API.OperationMethod<GetAnalyticsRuleRequest, GetAnalyticsRuleResponse, GetAnalyticsRuleError, TypesenseOpContext>;
|
|
2688
|
+
export type GetAnalyticsRulesError = TypesenseOpError;
|
|
2689
|
+
/** Retrieve analytics rules Retrieve all analytics rules. Use the optional rule_tag filter to narrow down results. */
|
|
2690
|
+
export declare const getAnalyticsRules: API.OperationMethod<GetAnalyticsRulesRequest, GetAnalyticsRulesResponse, GetAnalyticsRulesError, TypesenseOpContext>;
|
|
2676
2691
|
export type GetAnalyticsStatusError = TypesenseOpError;
|
|
2677
2692
|
/** Get analytics subsystem status Returns sizes of internal analytics buffers and queues. */
|
|
2678
2693
|
export declare const getAnalyticsStatus: API.OperationMethod<GetAnalyticsStatusRequest, AnalyticsStatus, GetAnalyticsStatusError, TypesenseOpContext>;
|
|
2694
|
+
export type GetAPIStatsError = TypesenseOpError;
|
|
2695
|
+
/** Get stats about API endpoints. Retrieve the stats about API endpoints. */
|
|
2696
|
+
export declare const getAPIStats: API.OperationMethod<GetAPIStatsRequest, APIStatsResponse, GetAPIStatsError, TypesenseOpContext>;
|
|
2679
2697
|
export type GetCollectionError = NotFound | TypesenseOpError;
|
|
2680
2698
|
/** Retrieve a single collection Retrieve the details of a collection, given its name. */
|
|
2681
2699
|
export declare const getCollection: API.OperationMethod<GetCollectionRequest, GetCollectionResponse, GetCollectionError, TypesenseOpContext>;
|
|
2682
2700
|
export type GetCollectionsError = TypesenseOpError;
|
|
2683
2701
|
/** List all collections Returns a summary of all your collections. The collections are returned sorted by creation date, with the most recent collections appearing first. */
|
|
2684
2702
|
export declare const getCollections: API.OperationMethod<GetCollectionsRequest, GetCollectionsResponse, GetCollectionsError, TypesenseOpContext>;
|
|
2703
|
+
export type GetConversationModelError = NotFound | TypesenseOpError;
|
|
2704
|
+
/** Retrieve a conversation model Retrieve a conversation model */
|
|
2705
|
+
export declare const getConversationModel: API.OperationMethod<GetConversationModelRequest, GetConversationModelResponse, GetConversationModelError, TypesenseOpContext>;
|
|
2706
|
+
export type GetCurationSetError = NotFound | TypesenseOpError;
|
|
2707
|
+
/** Retrieve a curation set Retrieve a specific curation set by its name */
|
|
2708
|
+
export declare const getCurationSet: API.OperationMethod<GetCurationSetRequest, GetCurationSetResponse, GetCurationSetError, TypesenseOpContext>;
|
|
2709
|
+
export type GetCurationSetItemError = NotFound | TypesenseOpError;
|
|
2710
|
+
/** Retrieve a curation set item Retrieve a specific curation item by its id */
|
|
2711
|
+
export declare const getCurationSetItem: API.OperationMethod<GetCurationSetItemRequest, GetCurationSetItemResponse, GetCurationSetItemError, TypesenseOpContext>;
|
|
2712
|
+
export type GetCurationSetItemsError = NotFound | TypesenseOpError;
|
|
2713
|
+
/** List items in a curation set Retrieve all curation items in a set */
|
|
2714
|
+
export declare const getCurationSetItems: API.OperationMethod<GetCurationSetItemsRequest, GetCurationSetItemsResponse, GetCurationSetItemsError, TypesenseOpContext>;
|
|
2715
|
+
export type GetCurationSetsError = TypesenseOpError;
|
|
2716
|
+
/** List all curation sets Retrieve all curation sets */
|
|
2717
|
+
export declare const getCurationSets: API.OperationMethod<GetCurationSetsRequest, GetCurationSetsResponse, GetCurationSetsError, TypesenseOpContext>;
|
|
2685
2718
|
export type GetDocumentError = NotFound | TypesenseOpError;
|
|
2686
2719
|
/** Retrieve a document Fetch an individual document from a collection by using its ID. */
|
|
2687
2720
|
export declare const getDocument: API.OperationMethod<GetDocumentRequest, GetDocumentResponse, GetDocumentError, TypesenseOpContext>;
|
|
@@ -2691,12 +2724,39 @@ export declare const getKey: API.OperationMethod<GetKeyRequest, GetKeyResponse,
|
|
|
2691
2724
|
export type GetKeysError = TypesenseOpError;
|
|
2692
2725
|
/** Retrieve (metadata about) all keys. */
|
|
2693
2726
|
export declare const getKeys: API.OperationMethod<GetKeysRequest, ApiKeysResponse, GetKeysError, TypesenseOpContext>;
|
|
2727
|
+
export type GetMetricsError = TypesenseOpError;
|
|
2728
|
+
/** Get current RAM, CPU, Disk & Network usage metrics. Retrieve the metrics. */
|
|
2729
|
+
export declare const getMetrics: API.OperationMethod<GetMetricsRequest, GetMetricsResponse, GetMetricsError, TypesenseOpContext>;
|
|
2730
|
+
export type GetNLSearchModelError = NotFound | TypesenseOpError;
|
|
2731
|
+
/** Retrieve a NL search model Retrieve a specific NL search model by its ID. */
|
|
2732
|
+
export declare const getNLSearchModel: API.OperationMethod<GetNLSearchModelRequest, GetNLSearchModelResponse, GetNLSearchModelError, TypesenseOpContext>;
|
|
2733
|
+
export type GetPresetError = NotFound | TypesenseOpError;
|
|
2734
|
+
/** Retrieves a preset. Retrieve the details of a preset, given it's name. */
|
|
2735
|
+
export declare const getPreset: API.OperationMethod<GetPresetRequest, GetPresetResponse, GetPresetError, TypesenseOpContext>;
|
|
2694
2736
|
export type GetSchemaChangesError = TypesenseOpError;
|
|
2695
2737
|
/** 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. */
|
|
2696
2738
|
export declare const getSchemaChanges: API.OperationMethod<GetSchemaChangesRequest, GetSchemaChangesResponse, GetSchemaChangesError, TypesenseOpContext>;
|
|
2697
2739
|
export type GetStemmingDictionaryError = NotFound | TypesenseOpError;
|
|
2698
2740
|
/** Retrieve a stemming dictionary Fetch details of a specific stemming dictionary. */
|
|
2699
2741
|
export declare const getStemmingDictionary: API.OperationMethod<GetStemmingDictionaryRequest, StemmingDictionary, GetStemmingDictionaryError, TypesenseOpContext>;
|
|
2742
|
+
export type GetStopwordsSetError = NotFound | TypesenseOpError;
|
|
2743
|
+
/** Retrieves a stopwords set. Retrieve the details of a stopwords set, given it's name. */
|
|
2744
|
+
export declare const getStopwordsSet: API.OperationMethod<GetStopwordsSetRequest, StopwordsSetRetrieveSchema, GetStopwordsSetError, TypesenseOpContext>;
|
|
2745
|
+
export type GetStopwordsSetsError = TypesenseOpError;
|
|
2746
|
+
/** Retrieves all stopwords sets. Retrieve the details of all stopwords sets */
|
|
2747
|
+
export declare const getStopwordsSets: API.OperationMethod<GetStopwordsSetsRequest, StopwordsSetsRetrieveAllSchema, GetStopwordsSetsError, TypesenseOpContext>;
|
|
2748
|
+
export type GetSynonymSetError = NotFound | TypesenseOpError;
|
|
2749
|
+
/** Retrieve a synonym set Retrieve a specific synonym set by its name */
|
|
2750
|
+
export declare const getSynonymSet: API.OperationMethod<GetSynonymSetRequest, GetSynonymSetResponse, GetSynonymSetError, TypesenseOpContext>;
|
|
2751
|
+
export type GetSynonymSetItemError = NotFound | TypesenseOpError;
|
|
2752
|
+
/** Retrieve a synonym set item Retrieve a specific synonym item by its id */
|
|
2753
|
+
export declare const getSynonymSetItem: API.OperationMethod<GetSynonymSetItemRequest, GetSynonymSetItemResponse, GetSynonymSetItemError, TypesenseOpContext>;
|
|
2754
|
+
export type GetSynonymSetItemsError = NotFound | TypesenseOpError;
|
|
2755
|
+
/** List items in a synonym set Retrieve all synonym items in a set */
|
|
2756
|
+
export declare const getSynonymSetItems: API.OperationMethod<GetSynonymSetItemsRequest, GetSynonymSetItemsResponse, GetSynonymSetItemsError, TypesenseOpContext>;
|
|
2757
|
+
export type GetSynonymSetsError = TypesenseOpError;
|
|
2758
|
+
/** List all synonym sets Retrieve all synonym sets */
|
|
2759
|
+
export declare const getSynonymSets: API.OperationMethod<GetSynonymSetsRequest, GetSynonymSetsResponse, GetSynonymSetsError, TypesenseOpContext>;
|
|
2700
2760
|
export type HealthError = TypesenseOpError;
|
|
2701
2761
|
/** Checks if Typesense server is ready to accept requests. Checks if Typesense server is ready to accept requests. */
|
|
2702
2762
|
export declare const health: API.OperationMethod<HealthRequest, HealthStatus, HealthError, TypesenseOpContext>;
|
|
@@ -2706,78 +2766,18 @@ export declare const importDocuments: API.OperationMethod<ImportDocumentsRequest
|
|
|
2706
2766
|
export type ImportStemmingDictionaryError = BadRequest | TypesenseOpError;
|
|
2707
2767
|
/** Import a stemming dictionary Upload a JSONL file containing word mappings to create or update a stemming dictionary. */
|
|
2708
2768
|
export declare const importStemmingDictionary: API.OperationMethod<ImportStemmingDictionaryRequest, ImportStemmingDictionaryResponse, ImportStemmingDictionaryError, TypesenseOpContext>;
|
|
2709
|
-
export type
|
|
2769
|
+
export type ListDocumentError = NotFound | TypesenseOpError;
|
|
2710
2770
|
/** Index a document A document to be indexed in a given collection must conform to the schema of the collection. */
|
|
2711
|
-
export declare const
|
|
2771
|
+
export declare const listDocument: API.OperationMethod<ListDocumentRequest, ListDocumentResponse, ListDocumentError, TypesenseOpContext>;
|
|
2712
2772
|
export type ListStemmingDictionariesError = TypesenseOpError;
|
|
2713
2773
|
/** List all stemming dictionaries Retrieve a list of all available stemming dictionaries. */
|
|
2714
2774
|
export declare const listStemmingDictionaries: API.OperationMethod<ListStemmingDictionariesRequest, ListStemmingDictionariesResponse, ListStemmingDictionariesError, TypesenseOpContext>;
|
|
2715
|
-
export type MultiSearchError = BadRequest | TypesenseOpError;
|
|
2716
|
-
/** 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. */
|
|
2717
|
-
export declare const multiSearch: API.OperationMethod<MultiSearchRequest, MultiSearchResult, MultiSearchError, TypesenseOpContext>;
|
|
2718
|
-
export type RetrieveAllConversationModelsError = TypesenseOpError;
|
|
2719
|
-
/** List all conversation models Retrieve all conversation models */
|
|
2720
|
-
export declare const retrieveAllConversationModels: API.OperationMethod<RetrieveAllConversationModelsRequest, RetrieveAllConversationModelsResponse, RetrieveAllConversationModelsError, TypesenseOpContext>;
|
|
2721
|
-
export type RetrieveAllNLSearchModelsError = TypesenseOpError;
|
|
2722
|
-
/** List all NL search models Retrieve all NL search models. */
|
|
2723
|
-
export declare const retrieveAllNLSearchModels: API.OperationMethod<RetrieveAllNLSearchModelsRequest, RetrieveAllNLSearchModelsResponse, RetrieveAllNLSearchModelsError, TypesenseOpContext>;
|
|
2724
|
-
export type RetrieveAllPresetsError = TypesenseOpError;
|
|
2725
|
-
/** Retrieves all presets. Retrieve the details of all presets */
|
|
2726
|
-
export declare const retrieveAllPresets: API.OperationMethod<RetrieveAllPresetsRequest, PresetsRetrieveSchema, RetrieveAllPresetsError, TypesenseOpContext>;
|
|
2727
|
-
export type RetrieveAnalyticsRuleError = NotFound | TypesenseOpError;
|
|
2728
|
-
/** Retrieves an analytics rule Retrieve the details of an analytics rule, given it's name */
|
|
2729
|
-
export declare const retrieveAnalyticsRule: API.OperationMethod<RetrieveAnalyticsRuleRequest, RetrieveAnalyticsRuleResponse, RetrieveAnalyticsRuleError, TypesenseOpContext>;
|
|
2730
|
-
export type RetrieveAnalyticsRulesError = TypesenseOpError;
|
|
2731
|
-
/** Retrieve analytics rules Retrieve all analytics rules. Use the optional rule_tag filter to narrow down results. */
|
|
2732
|
-
export declare const retrieveAnalyticsRules: API.OperationMethod<RetrieveAnalyticsRulesRequest, RetrieveAnalyticsRulesResponse, RetrieveAnalyticsRulesError, TypesenseOpContext>;
|
|
2733
|
-
export type RetrieveAPIStatsError = TypesenseOpError;
|
|
2734
|
-
/** Get stats about API endpoints. Retrieve the stats about API endpoints. */
|
|
2735
|
-
export declare const retrieveAPIStats: API.OperationMethod<RetrieveAPIStatsRequest, APIStatsResponse, RetrieveAPIStatsError, TypesenseOpContext>;
|
|
2736
|
-
export type RetrieveConversationModelError = NotFound | TypesenseOpError;
|
|
2737
|
-
/** Retrieve a conversation model Retrieve a conversation model */
|
|
2738
|
-
export declare const retrieveConversationModel: API.OperationMethod<RetrieveConversationModelRequest, RetrieveConversationModelResponse, RetrieveConversationModelError, TypesenseOpContext>;
|
|
2739
|
-
export type RetrieveCurationSetError = NotFound | TypesenseOpError;
|
|
2740
|
-
/** Retrieve a curation set Retrieve a specific curation set by its name */
|
|
2741
|
-
export declare const retrieveCurationSet: API.OperationMethod<RetrieveCurationSetRequest, RetrieveCurationSetResponse, RetrieveCurationSetError, TypesenseOpContext>;
|
|
2742
|
-
export type RetrieveCurationSetItemError = NotFound | TypesenseOpError;
|
|
2743
|
-
/** Retrieve a curation set item Retrieve a specific curation item by its id */
|
|
2744
|
-
export declare const retrieveCurationSetItem: API.OperationMethod<RetrieveCurationSetItemRequest, RetrieveCurationSetItemResponse, RetrieveCurationSetItemError, TypesenseOpContext>;
|
|
2745
|
-
export type RetrieveCurationSetItemsError = NotFound | TypesenseOpError;
|
|
2746
|
-
/** List items in a curation set Retrieve all curation items in a set */
|
|
2747
|
-
export declare const retrieveCurationSetItems: API.OperationMethod<RetrieveCurationSetItemsRequest, RetrieveCurationSetItemsResponse, RetrieveCurationSetItemsError, TypesenseOpContext>;
|
|
2748
|
-
export type RetrieveCurationSetsError = TypesenseOpError;
|
|
2749
|
-
/** List all curation sets Retrieve all curation sets */
|
|
2750
|
-
export declare const retrieveCurationSets: API.OperationMethod<RetrieveCurationSetsRequest, RetrieveCurationSetsResponse, RetrieveCurationSetsError, TypesenseOpContext>;
|
|
2751
|
-
export type RetrieveMetricsError = TypesenseOpError;
|
|
2752
|
-
/** Get current RAM, CPU, Disk & Network usage metrics. Retrieve the metrics. */
|
|
2753
|
-
export declare const retrieveMetrics: API.OperationMethod<RetrieveMetricsRequest, RetrieveMetricsResponse, RetrieveMetricsError, TypesenseOpContext>;
|
|
2754
|
-
export type RetrieveNLSearchModelError = NotFound | TypesenseOpError;
|
|
2755
|
-
/** Retrieve a NL search model Retrieve a specific NL search model by its ID. */
|
|
2756
|
-
export declare const retrieveNLSearchModel: API.OperationMethod<RetrieveNLSearchModelRequest, RetrieveNLSearchModelResponse, RetrieveNLSearchModelError, TypesenseOpContext>;
|
|
2757
|
-
export type RetrievePresetError = NotFound | TypesenseOpError;
|
|
2758
|
-
/** Retrieves a preset. Retrieve the details of a preset, given it's name. */
|
|
2759
|
-
export declare const retrievePreset: API.OperationMethod<RetrievePresetRequest, RetrievePresetResponse, RetrievePresetError, TypesenseOpContext>;
|
|
2760
|
-
export type RetrieveStopwordsSetError = NotFound | TypesenseOpError;
|
|
2761
|
-
/** Retrieves a stopwords set. Retrieve the details of a stopwords set, given it's name. */
|
|
2762
|
-
export declare const retrieveStopwordsSet: API.OperationMethod<RetrieveStopwordsSetRequest, StopwordsSetRetrieveSchema, RetrieveStopwordsSetError, TypesenseOpContext>;
|
|
2763
|
-
export type RetrieveStopwordsSetsError = TypesenseOpError;
|
|
2764
|
-
/** Retrieves all stopwords sets. Retrieve the details of all stopwords sets */
|
|
2765
|
-
export declare const retrieveStopwordsSets: API.OperationMethod<RetrieveStopwordsSetsRequest, StopwordsSetsRetrieveAllSchema, RetrieveStopwordsSetsError, TypesenseOpContext>;
|
|
2766
|
-
export type RetrieveSynonymSetError = NotFound | TypesenseOpError;
|
|
2767
|
-
/** Retrieve a synonym set Retrieve a specific synonym set by its name */
|
|
2768
|
-
export declare const retrieveSynonymSet: API.OperationMethod<RetrieveSynonymSetRequest, RetrieveSynonymSetResponse, RetrieveSynonymSetError, TypesenseOpContext>;
|
|
2769
|
-
export type RetrieveSynonymSetItemError = NotFound | TypesenseOpError;
|
|
2770
|
-
/** Retrieve a synonym set item Retrieve a specific synonym item by its id */
|
|
2771
|
-
export declare const retrieveSynonymSetItem: API.OperationMethod<RetrieveSynonymSetItemRequest, RetrieveSynonymSetItemResponse, RetrieveSynonymSetItemError, TypesenseOpContext>;
|
|
2772
|
-
export type RetrieveSynonymSetItemsError = NotFound | TypesenseOpError;
|
|
2773
|
-
/** List items in a synonym set Retrieve all synonym items in a set */
|
|
2774
|
-
export declare const retrieveSynonymSetItems: API.OperationMethod<RetrieveSynonymSetItemsRequest, RetrieveSynonymSetItemsResponse, RetrieveSynonymSetItemsError, TypesenseOpContext>;
|
|
2775
|
-
export type RetrieveSynonymSetsError = TypesenseOpError;
|
|
2776
|
-
/** List all synonym sets Retrieve all synonym sets */
|
|
2777
|
-
export declare const retrieveSynonymSets: API.OperationMethod<RetrieveSynonymSetsRequest, RetrieveSynonymSetsResponse, RetrieveSynonymSetsError, TypesenseOpContext>;
|
|
2778
2775
|
export type SearchCollectionError = BadRequest | NotFound | TypesenseOpError;
|
|
2779
2776
|
/** Search for documents in a collection Search for documents in a collection that match the search criteria. */
|
|
2780
2777
|
export declare const searchCollection: API.OperationMethod<SearchCollectionRequest, SearchResult, SearchCollectionError, TypesenseOpContext>;
|
|
2778
|
+
export type SearchMultiError = BadRequest | TypesenseOpError;
|
|
2779
|
+
/** 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. */
|
|
2780
|
+
export declare const searchMulti: API.OperationMethod<SearchMultiRequest, MultiSearchResult, SearchMultiError, TypesenseOpContext>;
|
|
2781
2781
|
export type TakeSnapshotError = TypesenseOpError;
|
|
2782
2782
|
/** 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. */
|
|
2783
2783
|
export declare const takeSnapshot: API.OperationMethod<TakeSnapshotRequest, SuccessStatus, TakeSnapshotError, TypesenseOpContext>;
|