Api Overview
SearchBlackBox SDK provides you with an API for indexing and searching.
| API | Description |
| SearchDocument |
SearchDocument is the unit of indexing and search. It is your data in a searchable form. A document is a set of fields (Field). |
| FieldAttributes |
FieldAttributes are the common attributes of a field. The attributes determine the method of using and processing field values. |
| SearchEngine |
SearchEngine is the core of SearchBlackBox SDK responsible for the indexing and searching. It contains two main functions: Add for adding the document to the index and ExecuteSearch for searching. |
| SearchResults |
SearchResults represents search results. It is a set of SearchResults - documents sorted by relevance. |
| SearchResult |
SearchResult is a single result. It is a SearchDocument with some additional information - its Score, Index and Highlight - highlighted source text. |
| HighlightingSettings |
HighlightingSettings represents the highlighting settings of search results. You can use various settings to show highlighted text as html/rtf or other types. |
| ISourceTextProvider |
ISourceTextProvider is an additional interface for specifying the method of getting the source text for highlighting search results. |
Summary
Actually, all in all the black box is just three classes: SearchDocument, SearchEngine and SearchResults - that add full-featured text search capabilities to your applications.
Questions? Need assistance before or after purchasing? Click here for customer support.