Groupdocs API References – GroupDocs.Search

Net: Extractor

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

Extractor class

Representa una herramienta para la extracción preliminar de datos de documentos para separar la etapa de indexación rápida posterior.

public class Extractor

Constructores

Nombre	Descripción
Extractor()	Inicializa una nueva instancia del`Extractor` clase.

Propiedades

Nombre	Descripción
Settings { get; }	Obtiene la configuración del extractor.

Métodos

Nombre	Descripción
Extract(Document, ExtractionOptions)	Extrae datos de un documento.

Eventos

Nombre	Descripción
event ErrorOccurred	Ocurre cuando ocurre un error durante una operación de extracción.
event ImagePreparing	Ocurre cuando se va a preparar una imagen para la indexación.
event PasswordRequired	Ocurre cuando un documento requiere contraseña para abrirlo.

Ver también

espacio de nombres GroupDocs.Search
asamblea GroupDocs.Search

Net: Index

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

Index class

Representa la clase principal para indexar documentos y buscar en ellos.

public class Index : IDisposable

Constructores

Nombre	Descripción
Index()	Inicializa una nueva instancia del`Index` clase en memoria.
Index(IndexSettings)	Inicializa una nueva instancia del`Index` clase en memoria con configuración de índice particular.
Index(string)	Inicializa una nueva instancia del`Index` class. Crea un índice nuevo o abre uno existente en el disco.
Index(string, bool)	Inicializa una nueva instancia del`Index` class. Carga un índice existente desde el disco sioverwriteIfExists es`FALSO`; crea un nuevo índice en el disco de lo contrario.
Index(string, IndexSettings)	Inicializa una nueva instancia del`Index` class. Crea un nuevo índice con una configuración particular o abre un índice existente en el disco.
Index(string, IndexSettings, bool)	Inicializa una nueva instancia del`Index` class. Carga un índice existente desde el disco sioverwriteIfExists es`FALSO` ; crea un nuevo índice en el disco con una configuración de índice particular de lo contrario.

Propiedades

Nombre	Descripción
Dictionaries { get; }	Obtiene el repositorio de diccionarios.
Events { get; }	Obtiene el centro de eventos para suscribirse a eventos.
IndexInfo { get; }	Obtiene la información básica sobre el índice.
IndexSettings { get; }	Obtiene la configuración del índice.
Repository { get; }	Obtiene el objeto del repositorio de índices si el índice está contenido en él.

Métodos

Nombre	Descripción
Add(string)	Realiza la operación de indexación. Agrega un archivo o carpeta por una ruta absoluta o relativa. Se indexarán los documentos de todas las subcarpetas.
Add(string[])	Realiza la operación de indexación. Agrega archivos o carpetas por una ruta absoluta o relativa. Se indexarán los documentos de todas las subcarpetas.
Add(Document[], IndexingOptions)	Realiza la operación de indexación. Agrega documentos del sistema de archivos, flujo o estructura.
Add(ExtractedData[], IndexingOptions)	Realiza la operación de indexación. Agrega los datos extraídos al índice.
Add(string, IndexingOptions)	Realiza la operación de indexación. Agrega un archivo o carpeta por una ruta absoluta o relativa. Se indexarán los documentos de todas las subcarpetas.
Add(string[], IndexingOptions)	Realiza la operación de indexación. Agrega archivos o carpetas por una ruta absoluta o relativa. Se indexarán los documentos de todas las subcarpetas.
ChangeAttributes(AttributeChangeBatch)	Aplica el lote especificado de cambios de atributos a los documentos indexados sin volver a indexarlos durante la operación de actualización.
Delete(string[], UpdateOptions)	Elimina archivos o carpetas indexados del índice. Luego actualiza el índice sin rutas eliminadas. Tenga en cuenta que un documento individual no se puede eliminar del índice si se agregó al índice como parte de una carpeta.
Delete(UpdateOptions, string[])	Elimina documentos indexados de flujos o estructuras. Luego actualiza el índice sin documentos eliminados.
Dispose()	Libera todos los recursos utilizados por el`Index` .
GetAttributes(string)	Obtiene todos los atributos asociados con el documento indexado especificado.
GetDocumentText(DocumentInfo, OutputAdapter)	Genera texto con formato HTML para el documento indexado y lo transfiere a través del adaptador de salida.
GetDocumentText(DocumentInfo, OutputAdapter, TextOptions)	Genera texto con formato HTML para el documento indexado y lo transfiere a través del adaptador de salida.
GetIndexedDocumentItems(DocumentInfo)	Obtiene una matriz de elementos anidados del documento especificado (para documentos contenedores como ZIP, OST, PST).
GetIndexedDocuments()	Obtiene una matriz de todos los documentos indexados.
GetIndexedPaths()	Obtiene una matriz de rutas indexadas: documentos o carpetas.
GetIndexingReports()	Obtiene los informes sobre las operaciones de indexación.
GetSearchReports()	Obtiene los informes sobre las operaciones de búsqueda.
Highlight(FoundDocument, Highlighter)	Genera texto en formato HTML con los términos encontrados resaltados.
Highlight(FoundDocument, Highlighter, HighlightOptions)	Genera texto en formato HTML con los términos encontrados resaltados.
Merge(Index, MergeOptions)	Fusiona el índice especificado con el índice actual. Tenga en cuenta que el otro índice no cambiará.
Merge(IndexRepository, MergeOptions)	Fusiona índices del repositorio de índices especificado en el índice actual. Tenga en cuenta que los índices del repositorio no cambiarán.
Notify(Notification)	Pasa el objeto de notificación especificado al índice para realizar la notificación.
Optimize()	Minimiza el número de segmentos de índice fusionándolos uno con otro. Esta operación mejora el rendimiento de la búsqueda.
Optimize(MergeOptions)	Minimiza el número de segmentos de índice fusionándolos uno con otro. Esta operación mejora el rendimiento de la búsqueda.
Search(SearchQuery)	Búsquedas en index.
Search(string)	Búsquedas en index.
Search(SearchImage, ImageSearchOptions)	Realiza una búsqueda inversa de imágenes en el índice.
Search(SearchQuery, SearchOptions)	Búsquedas en index.
Search(string, SearchOptions)	Búsquedas en index.
SearchNext(ChunkSearchToken)	Continúa la búsqueda de fragmentos iniciada con el método Buscar.
SearchNext(ChunkSearchToken, Cancellation)	Continúa la búsqueda de fragmentos iniciada con el método Buscar.
Update()	Vuelve a indexar documentos que se han modificado o eliminado desde la última actualización. Agrega nuevos archivos que se han agregado a las carpetas indexadas.
Update(UpdateOptions)	Vuelve a indexar documentos que se han modificado o eliminado desde la última actualización. Agrega nuevos archivos que se han agregado a las carpetas indexadas.

Observaciones

Aprende más

Ejemplos

El ejemplo demuestra un uso típico de la clase.

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

Index index = new Index(indexFolder); // Creando índice en la carpeta especificada
index.Add(documentsFolder); // Indexación de documentos de la carpeta especificada

SearchResult result = index.Search(query); // Buscando en el índice

Ver también

espacio de nombres GroupDocs.Search
asamblea GroupDocs.Search

Net: IndexRepository

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

IndexRepository class

Representa un contenedor para combinar múltiples índices y realizar operaciones comunes en ellos.

public class IndexRepository : IDisposable

Constructores

Nombre	Descripción
IndexRepository()	Inicializa una nueva instancia del`IndexRepository` clase.

Propiedades

Nombre	Descripción
Events { get; }	Obtiene el centro de eventos para suscribirse a eventos.
Indexes { get; }	Obtiene los índices contenidos en este`IndexRepository` .

Métodos

Nombre	Descripción
AddToRepository(Index)	Agrega un índice al repositorio de índices.
AddToRepository(string)	Abre y agrega un índice al repositorio de índices.
Create()	Crea un nuevo índice en memoria.
Create(IndexSettings)	Crea un nuevo índice en memoria.
Create(string)	Crea un nuevo índice en el disco. La carpeta del índice se limpiará antes de la creación del índice.
Create(string, IndexSettings)	Crea un nuevo índice en el disco. La carpeta del índice se limpiará antes de la creación del índice.
Dispose()	Libera todos los recursos utilizados por el`IndexRepository` .
Search(SearchQuery)	Busca en todos los índices del repositorio.
Search(string)	Busca en todos los índices del repositorio.
Search(SearchQuery, SearchOptions)	Busca en todos los índices del repositorio.
Search(string, SearchOptions)	Busca en todos los índices del repositorio.
Update()	Actualiza todos los índices del repositorio.
Update(UpdateOptions)	Actualiza todos los índices del repositorio.

Observaciones

Aprende más

Repositorio de índice de búsqueda

Ejemplos

El ejemplo demuestra un uso típico de la clase.

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

IndexRepository repository = new IndexRepository();
repository.AddToRepository(indexFolder1); // Cargando un índice existente
repository.AddToRepository(indexFolder2); // Cargando otro índice existente

SearchResult result = repository.Search(query); // Buscando en índices del repositorio

Ver también

espacio de nombres GroupDocs.Search
asamblea GroupDocs.Search

Net: IndexSettings

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

IndexSettings class

Representa la configuración del índice que permite personalizar las operaciones de indexación.

public class IndexSettings

Constructores

Nombre	Descripción
IndexSettings()	Inicializa una nueva instancia del`IndexSettings` clase.

Propiedades

Nombre	Descripción
AutoDetectEncoding { get; set; }	Obtiene o establece un valor que indica si se detecta la codificación automáticamente o no. El valor predeterminado es`FALSO` .
CustomExtractors { get; }	Obtiene la colección de extractores personalizados.
DocumentFilter { get; set; }	Obtiene o establece un filtro de documentos. El`DocumentFilter` funciona en la lógica de inclusión. Use el`DocumentFilter` clase para la creación de instancias de un filtro de documentos. El valor predeterminado es`nulo` , lo que significa que todos los documentos agregados están indexados.
IndexType { get; set; }	Obtiene o establece el tipo de índice. El valor predeterminado esNormalIndex .
InMemoryIndex { get; }	Obtiene un valor que indica si el índice está almacenado en memoria o en disco.
Logger { get; set; }	Obtiene o establece un registrador que se usa para registrar eventos y errores en el índice. Tenga en cuenta que el registrador no se guarda y debe crearse y asignarse cada vez que se crea o carga el índice.
MaxIndexingReportCount { get; set; }	Obtiene o establece el número máximo de informes de indexación. El valor predeterminado es`5` .
MaxSearchReportCount { get; set; }	Obtiene o establece el número máximo de informes de búsqueda. El valor predeterminado es`10` .
SearchThreads { get; set; }	Obtiene o establece el número de subprocesos utilizados para la búsqueda. El valor predeterminado esDefault , lo que significa que la búsqueda se realizará utilizando el número de subprocesos igual al número de núcleos del procesador.
TextStorageSettings { get; set; }	Obtiene o establece la configuración de almacenamiento de texto. El valor predeterminado es`nulo` , lo que significa que los textos de los documentos no se almacenan.
UseCharacterReplacements { get; set; }	Obtiene o establece un valor que indica si se deben usar reemplazos de caracteres o no. El valor predeterminado es`FALSO` .
UseRawTextExtraction { get; set; }	Obtiene o establece un valor que indica si el modo sin formato se usa para la extracción de texto, si es posible. El valor predeterminado es`verdadero` . El modo sin procesar puede aumentar significativamente la velocidad de indexación, pero el modo normal mejora el formato del texto extraído.
UseStopWords { get; set; }	Obtiene o establece un valor que indica si se deben usar palabras vacías o no. El valor predeterminado es`verdadero` .

Observaciones

Aprende más

Configuración del índice de búsqueda

Ejemplos

El ejemplo demuestra un uso típico de la clase.

string indexFolder = @"c:\MyIndex\";
IndexSettings settings = new IndexSettings();
settings.IndexType = IndexType.CompactIndex; // Establecer el tipo de índice

Index index = new Index(indexFolder, settings); // Creando un índice

Ver también

espacio de nombres GroupDocs.Search
asamblea GroupDocs.Search

Net: IndexUpdater

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

IndexUpdater class

Representa un actualizador de índice. Esta clase realiza la reindexación de documentos en un índice de una versión anterior.

public class IndexUpdater

Constructores

Nombre	Descripción
IndexUpdater()	Inicializa una nueva instancia del`IndexUpdater` clase.

Métodos

Nombre	Descripción
CanUpdateVersion(string)	Comprueba si un índice en el directorio especificado se puede actualizar a la última versión.
IsLatestVersion(string)	Comprueba si el directorio especificado contiene un índice de la última versión.
UpdateVersion(string, string)	Realiza la reindexación de documentos en un índice de una versión antigua. El índice actualizado se colocará en elnewIndexPath directorio. El índice en elindexPath el directorio no se cambiará.

Observaciones

Aprende más

Actualizar índice

Ejemplos

El ejemplo demuestra un uso típico de la clase.

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

IndexUpdater updater = new IndexUpdater();

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

Ver también

espacio de nombres GroupDocs.Search
asamblea GroupDocs.Search

Net: License

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

License class

Proporciona métodos para aplicar la licencia.

public sealed class License

Constructores

Nombre	Descripción
License()	Inicializa una nueva instancia del`License` clase.

Métodos

Nombre	Descripción
SetLicense(Stream)	Licencia el componente.
SetLicense(string)	Licencia el componente.

Observaciones

Aprende más

Limitaciones de evaluación y licencias

Ejemplos

El ejemplo muestra cómo configurar la licencia.

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

Ver también

espacio de nombres GroupDocs.Search
asamblea GroupDocs.Search

Net: Metered

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

Metered class

Proporciona métodos que permiten activar el producto con una licencia medida y recuperar la cantidad de MB procesados. Más información sobre las licencias medidasaquí .

public class Metered

Constructores

Nombre	Descripción
Metered()	Inicializa una nueva instancia de`Metered` clase.

Métodos

Nombre	Descripción
SetMeteredKey(string, string)	Establece la clave pública y privada medidas.
static GetConsumptionCredit()	Obtiene el crédito de consumo.
static GetConsumptionQuantity()	Obtiene la cantidad de consumo.

Observaciones

Aprende más

Limitaciones de evaluación y licencias

Ejemplos

El ejemplo muestra cómo establecer claves públicas y privadas medidas.

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

Ver también

espacio de nombres GroupDocs.Search
asamblea GroupDocs.Search

Net: SearchQuery

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

SearchQuery class

Representa una consulta de búsqueda en forma de objeto.

public abstract class SearchQuery

Propiedades

Nombre	Descripción
virtual ChildCount { get; }	Obtiene el número de consultas secundarias.
virtual FieldName { get; }	Obtiene el nombre del campo.
virtual FirstChild { get; }	Obtiene la primera consulta secundaria.
SearchOptions { get; set; }	Obtiene o establece las opciones de búsqueda de esta consulta de búsqueda.
virtual SecondChild { get; }	Obtiene la segunda consulta secundaria.

Métodos

Nombre	Descripción
static CreateAndQuery(SearchQuery, SearchQuery)	Crea una consulta combinada que encontrará solo los documentos que se encontrarán para cada consulta original.
static CreateDateRangeQuery(DateTime, DateTime)	Crea una consulta de intervalo de fechas.
static CreateFieldQuery(string, SearchQuery)	Agrega un campo a la consulta especificada.
static CreateNotQuery(SearchQuery)	Crea una consulta invertida que encontrará el resto de documentos en un índice contra los que se encontrarán para la consulta original.
static CreateNumericRangeQuery(long, long)	Crea una consulta de rango numérico.
static CreateOrQuery(SearchQuery, SearchQuery)	Crea una consulta combinada que encontrará todos los documentos que se encontrarán al menos para una de las consultas originales.
static CreatePhraseSearchQuery(params SearchQuery[])	Crea una consulta de búsqueda de frase.
static CreateRegexQuery(string)	Crea una consulta de expresión regular.
static CreateRegexQuery(string, RegexOptions)	Crea una consulta de expresión regular.
static CreateWildcardQuery(int)	Crea un comodín para la búsqueda de frase.
static CreateWildcardQuery(int, int)	Crea un comodín para la búsqueda de frase.
static CreateWordPatternQuery(WordPattern)	Crea una consulta de patrón de palabras.
static CreateWordQuery(string)	Crea una consulta de palabra simple.
abstract GetChild(int)	Obtiene una consulta secundaria por un índice.
abstract ToString()	Devuelve unString que representa la corriente`SearchQuery` instancia.

Observaciones

Aprende más

Ejemplos

El ejemplo demuestra un uso típico de la clase.

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

Index index = new Index(indexFolder); // Creando índice en la carpeta especificada
index.Add(documentsFolder); // Indexación de documentos de la carpeta especificada

// Creando una subconsulta de búsqueda de rango de fechas
SearchQuery subquery1 = SearchQuery.CreateDateRangeQuery(new DateTime(2011, 6, 17), new DateTime(2013, 1, 1));

// Creando subconsulta de comodín con número de palabras perdidas de 0 a 2
SearchQuery subquery2 = SearchQuery.CreateWildcardQuery(0, 2);

// Creando una subconsulta de una palabra simple
SearchQuery subquery3 = SearchQuery.CreateWordQuery("birth");
subquery3.SearchOptions = new SearchOptions(); // Configuración de opciones de búsqueda solo para la subconsulta 3
subquery3.SearchOptions.FuzzySearch.Enabled = true;
subquery3.SearchOptions.FuzzySearch.FuzzyAlgorithm = new TableDiscreteFunction(1);

// Combinando subconsultas en una sola consulta
SearchQuery query = SearchQuery.CreatePhraseSearchQuery(subquery1, subquery2, subquery3);

// Creación de objeto de opciones de búsqueda con mayor capacidad de ocurrencias encontradas
SearchOptions options = new SearchOptions(); // Opciones generales de búsqueda
options.MaxOccurrenceCountPerTerm = 1000000;
options.MaxTotalOccurrenceCount = 10000000;

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

Ver también

espacio de nombres GroupDocs.Search
asamblea GroupDocs.Search