Groupdocs API References – GroupDocs.Search

Net: Extractor

Mon, 01 Jan 0001 00:00:00 +0000

Extractor class

Stellt ein Tool zur vorläufigen Datenextraktion aus Dokumenten dar, um die Phase der anschließenden schnellen Indizierung zu trennen.

public class Extractor

Konstrukteure

Name	Beschreibung
Extractor()	Initialisiert eine neue Instanz von`Extractor` Klasse.

Eigenschaften

Name	Beschreibung
Settings { get; }	Ruft die Extraktoreinstellungen ab.

Methoden

Name	Beschreibung
Extract(Document, ExtractionOptions)	Extrahiert Daten aus einem Dokument.

Veranstaltungen

Name	Beschreibung
event ErrorOccurred	Tritt auf, wenn während eines Extraktionsvorgangs ein Fehler auftritt.
event ImagePreparing	Tritt auf, wenn ein Bild für die Indizierung vorbereitet wird.
event PasswordRequired	Tritt auf, wenn ein Dokument zum Öffnen ein Passwort erfordert.

Siehe auch

namensraum GroupDocs.Search
Montage GroupDocs.Search

Net: Index

Mon, 01 Jan 0001 00:00:00 +0000

Index class

Stellt die Hauptklasse dar, um Dokumente zu indizieren und zu durchsuchen.

public class Index : IDisposable

Konstrukteure

Name	Beschreibung
Index()	Initialisiert eine neue Instanz von`Index` Klasse im Gedächtnis.
Index(IndexSettings)	Initialisiert eine neue Instanz von`Index` Klasse im Speicher mit bestimmten Indexeinstellungen.
Index(string)	Initialisiert eine neue Instanz von`Index` class. Erstellt einen neuen oder öffnet einen vorhandenen Index auf der Festplatte.
Index(string, bool)	Initialisiert eine neue Instanz von`Index` class. Lädt einen vorhandenen Index von der Festplatte, wennoverwriteIfExists Ist`FALSCH`; erstellt andernfalls einen neuen Index auf der Festplatte.
Index(string, IndexSettings)	Initialisiert eine neue Instanz von`Index` class. Erstellt einen neuen Index mit bestimmten Einstellungen oder öffnet einen bestehenden Index auf der Festplatte.
Index(string, IndexSettings, bool)	Initialisiert eine neue Instanz von`Index` class. Lädt einen vorhandenen Index von der Festplatte, wennoverwriteIfExists Ist`FALSCH` ; erstellt andernfalls einen neuen Index auf der Festplatte mit bestimmten Indexeinstellungen.

Eigenschaften

Name	Beschreibung
Dictionaries { get; }	Ruft das Wörterbuch-Repository ab.
Events { get; }	Ruft den Event Hub zum Abonnieren von Ereignissen ab.
IndexInfo { get; }	Ruft die grundlegenden Informationen zum Index ab.
IndexSettings { get; }	Ruft die Indexeinstellungen ab.
Repository { get; }	Ruft das Index-Repository-Objekt ab, wenn der Index darin enthalten ist.

Methoden

Name	Beschreibung
Add(string)	Führt einen Indizierungsvorgang durch. Fügt eine Datei oder einen Ordner über einen absoluten oder relativen Pfad hinzu. Dokumente aus allen Unterordnern werden indiziert.
Add(string[])	Führt einen Indizierungsvorgang durch. Fügt Dateien oder Ordner über einen absoluten oder relativen Pfad hinzu. Dokumente aus allen Unterordnern werden indiziert.
Add(Document[], IndexingOptions)	Führt Indizierungsoperationen durch. Fügt Dokumente aus Dateisystem, Stream oder Struktur hinzu.
Add(ExtractedData[], IndexingOptions)	Führt den Indexierungsvorgang durch. Fügt die extrahierten Daten dem Index hinzu.
Add(string, IndexingOptions)	Führt einen Indizierungsvorgang durch. Fügt eine Datei oder einen Ordner über einen absoluten oder relativen Pfad hinzu. Dokumente aus allen Unterordnern werden indiziert.
Add(string[], IndexingOptions)	Führt einen Indizierungsvorgang durch. Fügt Dateien oder Ordner über einen absoluten oder relativen Pfad hinzu. Dokumente aus allen Unterordnern werden indiziert.
ChangeAttributes(AttributeChangeBatch)	Wendet den angegebenen Stapel von Attributänderungen auf indizierte Dokumente an, ohne während des Aktualisierungsvorgangs neu zu indizieren.
Delete(string[], UpdateOptions)	Löscht indizierte Dateien oder Ordner aus dem Index. Aktualisiert dann den Index ohne gelöschte Pfade. Beachten Sie, dass ein einzelnes Dokument nicht aus dem Index gelöscht werden kann, wenn es dem Index als Teil eines Ordners hinzugefügt wurde.
Delete(UpdateOptions, string[])	Löscht indizierte Dokumente aus Streams oder Strukturen. Aktualisiert dann den Index ohne gelöschte Dokumente.
Dispose()	Gibt alle Ressourcen frei, die von verwendet werden`Index` .
GetAttributes(string)	Ruft alle Attribute ab, die dem angegebenen indizierten Dokument zugeordnet sind.
GetDocumentText(DocumentInfo, OutputAdapter)	Generiert HTML-formatierten Text für das indizierte Dokument und überträgt ihn über den Ausgabeadapter.
GetDocumentText(DocumentInfo, OutputAdapter, TextOptions)	Generiert HTML-formatierten Text für das indizierte Dokument und überträgt ihn über den Ausgabeadapter.
GetIndexedDocumentItems(DocumentInfo)	Ruft ein Array verschachtelter Elemente des angegebenen Dokuments ab (für Containerdokumente wie ZIP, OST, PST).
GetIndexedDocuments()	Ruft ein Array aller indizierten Dokumente ab.
GetIndexedPaths()	Ruft ein Array von indizierten Pfaden ab – Dokumente oder Ordner.
GetIndexingReports()	Ruft die Berichte zu Indizierungsvorgängen ab.
GetSearchReports()	Ruft die Berichte zu Suchvorgängen ab.
Highlight(FoundDocument, Highlighter)	Erzeugt HTML-formatierten Text mit hervorgehobenen gefundenen Begriffen.
Highlight(FoundDocument, Highlighter, HighlightOptions)	Erzeugt HTML-formatierten Text mit hervorgehobenen gefundenen Begriffen.
Merge(Index, MergeOptions)	Führt den angegebenen Index mit dem aktuellen Index zusammen. Beachten Sie, dass der andere Index nicht geändert wird.
Merge(IndexRepository, MergeOptions)	Führt Indizes aus dem angegebenen Index-Repository in den aktuellen Index zusammen. Beachten Sie, dass Indizes im Repository nicht geändert werden.
Notify(Notification)	Übergibt das angegebene Benachrichtigungsobjekt an den Index, um die Benachrichtigung auszuführen.
Optimize()	Minimiert die Anzahl der Indexsegmente, indem sie miteinander verbunden werden. Dieser Vorgang verbessert die Suchleistung.
Optimize(MergeOptions)	Minimiert die Anzahl der Indexsegmente, indem sie miteinander verbunden werden. Dieser Vorgang verbessert die Suchleistung.
Search(SearchQuery)	Sucht im Index.
Search(string)	Sucht im Index.
Search(SearchImage, ImageSearchOptions)	Führt eine umgekehrte Bildsuche im Index durch.
Search(SearchQuery, SearchOptions)	Sucht im Index.
Search(string, SearchOptions)	Sucht im Index.
SearchNext(ChunkSearchToken)	Setzt die Chunk-Suche fort, die mit der Methode Search gestartet wurde.
SearchNext(ChunkSearchToken, Cancellation)	Setzt die Chunk-Suche fort, die mit der Methode Search gestartet wurde.
Update()	Indiziert Dokumente neu, die seit der letzten Aktualisierung geändert oder gelöscht wurden. Fügt neue Dateien hinzu, die zu den indizierten Ordnern hinzugefügt wurden.
Update(UpdateOptions)	Indiziert Dokumente neu, die seit der letzten Aktualisierung geändert oder gelöscht wurden. Fügt neue Dateien hinzu, die zu den indizierten Ordnern hinzugefügt wurden.

Bemerkungen

Erfahren Sie mehr

Beispiele

Das Beispiel zeigt eine typische Verwendung der Klasse.

string indexFolder = @"c:\MyIndex\";
string documentsFolder = @"c:\MyDocuments\";
string query = "Einstein";

Index index = new Index(indexFolder); // Index im angegebenen Ordner erstellen
index.Add(documentsFolder); // Indizierung von Dokumenten aus dem angegebenen Ordner

SearchResult result = index.Search(query); // Suche im Index

Siehe auch

namensraum GroupDocs.Search
Montage GroupDocs.Search

Net: IndexRepository

Mon, 01 Jan 0001 00:00:00 +0000

IndexRepository class

Repräsentiert einen Container zum Kombinieren mehrerer Indizes und zum Ausführen gemeinsamer Operationen an ihnen.

public class IndexRepository : IDisposable

Konstrukteure

Name	Beschreibung
IndexRepository()	Initialisiert eine neue Instanz von`IndexRepository` Klasse.

Eigenschaften

Name	Beschreibung
Events { get; }	Ruft den Event Hub zum Abonnieren von Ereignissen ab.
Indexes { get; }	Ruft die darin enthaltenen Indizes ab`IndexRepository` .

Methoden

Name	Beschreibung
AddToRepository(Index)	Fügt einen Index zum Index-Repository hinzu.
AddToRepository(string)	Öffnet und fügt einen Index zum Index-Repository hinzu.
Create()	Erstellt einen neuen Index im Speicher.
Create(IndexSettings)	Erstellt einen neuen Index im Speicher.
Create(string)	Erstellt einen neuen Index auf der Festplatte. Der Indexordner wird vor der Indexerstellung bereinigt.
Create(string, IndexSettings)	Erstellt einen neuen Index auf der Festplatte. Der Indexordner wird vor der Indexerstellung bereinigt.
Dispose()	Gibt alle Ressourcen frei, die von verwendet werden`IndexRepository` .
Search(SearchQuery)	Sucht in allen Indizes des Repositorys.
Search(string)	Sucht in allen Indizes des Repositorys.
Search(SearchQuery, SearchOptions)	Sucht in allen Indizes des Repositorys.
Search(string, SearchOptions)	Sucht in allen Indizes des Repositorys.
Update()	Aktualisiert alle Indizes im Repository.
Update(UpdateOptions)	Aktualisiert alle Indizes im Repository.

Bemerkungen

Erfahren Sie mehr

Index-Repository durchsuchen

Beispiele

Das Beispiel zeigt eine typische Verwendung der Klasse.

string indexFolder1 = @"c:\MyIndex\";
string indexFolder2 = @"c:\MyIndex\";
string query = "Einstein";

IndexRepository repository = new IndexRepository();
repository.AddToRepository(indexFolder1); // Laden eines bestehenden Index
repository.AddToRepository(indexFolder2); // Einen weiteren bestehenden Index laden

SearchResult result = repository.Search(query); // Suchen in Indizes des Repositorys

Siehe auch

namensraum GroupDocs.Search
Montage GroupDocs.Search

Net: IndexSettings

Mon, 01 Jan 0001 00:00:00 +0000

IndexSettings class

Stellt die Indexeinstellungen dar, mit denen die Indizierungsvorgänge angepasst werden können.

public class IndexSettings

Konstrukteure

Name	Beschreibung
IndexSettings()	Initialisiert eine neue Instanz von`IndexSettings` Klasse.

Eigenschaften

Name	Beschreibung
AutoDetectEncoding { get; set; }	Ruft einen Wert ab oder legt einen Wert fest, der angibt, ob die Codierung automatisch erkannt werden soll oder nicht. Der Standardwert ist`FALSCH` .
CustomExtractors { get; }	Ruft die benutzerdefinierte Extraktorsammlung ab.
DocumentFilter { get; set; }	Ruft einen Dokumentfilter ab oder legt ihn fest. Die`DocumentFilter` arbeitet an der Inklusionslogik. Verwenden Sie die`DocumentFilter` Klasse zum Erstellen von Dokumentfilterinstanzen. Der Standardwert ist`Null` , was bedeutet, dass alle hinzugefügten Dokumente indiziert werden.
IndexType { get; set; }	Ruft den Indextyp ab oder legt ihn fest. Der Standardwert istNormalIndex .
InMemoryIndex { get; }	Ruft einen Wert ab, der angibt, ob der Index im Arbeitsspeicher oder auf der Festplatte gespeichert ist.
Logger { get; set; }	Ruft einen Logger ab oder legt ihn fest, der zum Protokollieren von Ereignissen und Fehlern im Index verwendet wird. Beachten Sie, dass der Logger nicht gespeichert wird und jedes Mal erstellt und zugewiesen werden muss, wenn der Index erstellt oder geladen wird.
MaxIndexingReportCount { get; set; }	Ruft die maximale Anzahl von Indizierungsberichten ab oder legt sie fest. Der Standardwert ist`5` .
MaxSearchReportCount { get; set; }	Ruft die maximale Anzahl von Suchberichten ab oder legt sie fest. Der Standardwert ist`10` .
SearchThreads { get; set; }	Ruft die Anzahl der für die Suche verwendeten Threads ab oder legt sie fest. Der Standardwert istDefault , , was bedeutet, dass die Suche mit der Anzahl der Threads durchgeführt wird, die der Anzahl der Prozessorkerne entspricht.
TextStorageSettings { get; set; }	Ruft die Textspeichereinstellungen ab oder legt sie fest. Der Standardwert ist`Null` , was bedeutet, dass Dokumenttexte nicht gespeichert werden.
UseCharacterReplacements { get; set; }	Ruft einen Wert ab oder legt einen Wert fest, der angibt, ob Zeichenersetzungen verwendet werden sollen oder nicht. Der Standardwert ist`FALSCH` .
UseRawTextExtraction { get; set; }	Ruft einen Wert ab oder legt einen Wert fest, der angibt, ob der Rohmodus für die Textextraktion verwendet wird, falls möglich. Der Standardwert ist`WAHR` . Der Rohmodus kann die Indizierungsgeschwindigkeit erheblich erhöhen, aber der Normalmodus verbessert die Formatierung des extrahierten Textes.
UseStopWords { get; set; }	Ruft einen Wert ab oder legt einen Wert fest, der angibt, ob Stoppwörter verwendet werden sollen oder nicht. Der Standardwert ist`WAHR` .

Bemerkungen

Erfahren Sie mehr

Suchindexeinstellungen

Beispiele

Das Beispiel zeigt eine typische Verwendung der Klasse.

string indexFolder = @"c:\MyIndex\";
IndexSettings settings = new IndexSettings();
settings.IndexType = IndexType.CompactIndex; // Setzen des Indextyps

Index index = new Index(indexFolder, settings); // Index erstellen

Siehe auch

namensraum GroupDocs.Search
Montage GroupDocs.Search

Net: IndexUpdater

Mon, 01 Jan 0001 00:00:00 +0000

IndexUpdater class

Repräsentiert einen Index-Updater. Diese Klasse führt eine Neuindizierung von Dokumenten in einem Index einer alten Version durch.

public class IndexUpdater

Konstrukteure

Name	Beschreibung
IndexUpdater()	Initialisiert eine neue Instanz von`IndexUpdater` Klasse.

Methoden

Name	Beschreibung
CanUpdateVersion(string)	Überprüft, ob ein Index im angegebenen Verzeichnis auf die neueste Version aktualisiert werden kann.
IsLatestVersion(string)	Überprüft, ob das angegebene Verzeichnis einen Index der neuesten Version enthält.
UpdateVersion(string, string)	Führt eine Neuindizierung von Dokumenten in einem Index einer alten Version durch. Der aktualisierte Index wird in die abgelegtnewIndexPath Verzeichnis. Der Index in derindexPath Verzeichnis wird nicht geändert.

Bemerkungen

Erfahren Sie mehr

Index aktualisieren

Beispiele

Das Beispiel zeigt eine typische Verwendung der Klasse.

string sourceIndexFolder = @"c:\MyOldIndex\";
string targetIndexFolder = @"c:\MyNewIndex\";

IndexUpdater updater = new IndexUpdater();

if (updater.CanUpdateVersion(sourceIndexFolder))
{
    VersionUpdateResult result = updater.UpdateVersion(sourceIndexFolder, targetIndexFolder);
}

Siehe auch

namensraum GroupDocs.Search
Montage GroupDocs.Search

Net: License

Mon, 01 Jan 0001 00:00:00 +0000

License class

Bietet Methoden zum Anwenden von Lizenzen.

public sealed class License

Konstrukteure

Name	Beschreibung
License()	Initialisiert eine neue Instanz von`License` Klasse.

Methoden

Name	Beschreibung
SetLicense(Stream)	Lizenziert die Komponente.
SetLicense(string)	Lizenziert die Komponente.

Bemerkungen

Erfahren Sie mehr

Bewertungsbeschränkungen und Lizenzierung

Beispiele

Das Beispiel zeigt, wie eine Lizenz eingerichtet wird.

License license = new License();
license.SetLicense("C:\\GroupDocs.Search.lic");

Siehe auch

namensraum GroupDocs.Search
Montage GroupDocs.Search

Net: Metered

Mon, 01 Jan 0001 00:00:00 +0000

Metered class

Bietet Methoden, die es ermöglichen, ein Produkt mit einer gebührenpflichtigen Lizenz zu aktivieren und die verarbeitete MB-Menge abzurufen. Erfahren Sie mehr über gebührenpflichtige LizenzenHier .

public class Metered

Konstrukteure

Name	Beschreibung
Metered()	Initialisiert eine neue Instanz von`Metered` Klasse.

Methoden

Name	Beschreibung
SetMeteredKey(string, string)	Legt gemessene öffentliche und private Schlüssel fest.
static GetConsumptionCredit()	Ruft die Verbrauchsgutschrift ab.
static GetConsumptionQuantity()	Ruft die Verbrauchsmenge ab.

Bemerkungen

Erfahren Sie mehr

Bewertungsbeschränkungen und Lizenzierung

Beispiele

Das Beispiel zeigt, wie gemessene öffentliche und private Schlüssel festgelegt werden.

Metered metered = new Metered();
metered.SetMeteredKey("PublicKey", "PrivateKey");

Siehe auch

namensraum GroupDocs.Search
Montage GroupDocs.Search

Net: SearchQuery

Mon, 01 Jan 0001 00:00:00 +0000

SearchQuery class

Stellt eine Suchanfrage in Objektform dar.

public abstract class SearchQuery

Eigenschaften

Name	Beschreibung
virtual ChildCount { get; }	Ruft die Anzahl der untergeordneten Abfragen ab.
virtual FieldName { get; }	Ruft den Feldnamen ab.
virtual FirstChild { get; }	Ruft die erste untergeordnete Abfrage ab.
SearchOptions { get; set; }	Ruft die Suchoptionen dieser Suchanfrage ab oder setzt sie.
virtual SecondChild { get; }	Ruft die zweite untergeordnete Abfrage ab.

Methoden

Name	Beschreibung
static CreateAndQuery(SearchQuery, SearchQuery)	Erstellt eine kombinierte Abfrage, die nur Dokumente findet, die für jede ursprüngliche Abfrage gefunden werden.
static CreateDateRangeQuery(DateTime, DateTime)	Erstellt eine Datumsbereichsabfrage.
static CreateFieldQuery(string, SearchQuery)	Fügt der angegebenen Abfrage ein Feld hinzu.
static CreateNotQuery(SearchQuery)	Erstellt eine invertierte Abfrage, die die restlichen Dokumente in einem Index gegen diejenigen findet, die für die ursprüngliche Abfrage gefunden werden.
static CreateNumericRangeQuery(long, long)	Erstellt eine numerische Bereichsabfrage.
static CreateOrQuery(SearchQuery, SearchQuery)	Erstellt eine kombinierte Abfrage, die alle Dokumente findet, die mindestens für eine der ursprünglichen Abfragen gefunden werden.
static CreatePhraseSearchQuery(params SearchQuery[])	Erstellt eine Wortgruppensuchabfrage.
static CreateRegexQuery(string)	Erstellt eine Abfrage mit regulären Ausdrücken.
static CreateRegexQuery(string, RegexOptions)	Erstellt eine Abfrage mit regulären Ausdrücken.
static CreateWildcardQuery(int)	Erstellt einen Platzhalter für die Phrasensuche.
static CreateWildcardQuery(int, int)	Erstellt einen Platzhalter für die Phrasensuche.
static CreateWordPatternQuery(WordPattern)	Erstellt eine Wortmusterabfrage.
static CreateWordQuery(string)	Erstellt eine einfache Wortabfrage.
abstract GetChild(int)	Ruft eine untergeordnete Abfrage durch einen Index ab.
abstract ToString()	Gibt a zurückString das repräsentiert den Strom`SearchQuery` Instanz.

Bemerkungen

Erfahren Sie mehr

Beispiele

Das Beispiel zeigt eine typische Verwendung der Klasse.

string indexFolder = @"c:\MyIndex\";
string documentsFolder = @"c:\MyDocuments\";

Index index = new Index(indexFolder); // Index im angegebenen Ordner erstellen
index.Add(documentsFolder); // Indizierung von Dokumenten aus dem angegebenen Ordner

// Unterabfrage der Datumsbereichssuche erstellen
SearchQuery subquery1 = SearchQuery.CreateDateRangeQuery(new DateTime(2011, 6, 17), new DateTime(2013, 1, 1));

// Erstellen einer Unterabfrage des Platzhalters mit der Anzahl der fehlenden Wörter von 0 bis 2
SearchQuery subquery2 = SearchQuery.CreateWildcardQuery(0, 2);

// Unterabfrage eines einfachen Wortes erstellen
SearchQuery subquery3 = SearchQuery.CreateWordQuery("birth");
subquery3.SearchOptions = new SearchOptions(); // Suchoptionen nur für Unterabfrage 3 setzen
subquery3.SearchOptions.FuzzySearch.Enabled = true;
subquery3.SearchOptions.FuzzySearch.FuzzyAlgorithm = new TableDiscreteFunction(1);

// Kombinieren von Unterabfragen zu einer Abfrage
SearchQuery query = SearchQuery.CreatePhraseSearchQuery(subquery1, subquery2, subquery3);

// Suchoptionsobjekt mit erhöhter Kapazität gefundener Vorkommen erstellen
SearchOptions options = new SearchOptions(); // Allgemeine Suchoptionen
options.MaxOccurrenceCountPerTerm = 1000000;
options.MaxTotalOccurrenceCount = 10000000;

SearchResult result = index.Search(query, options); // Suchen

Siehe auch

namensraum GroupDocs.Search
Montage GroupDocs.Search