SimpleField interface

Paquete:

@azure/search-documents

Representa un campo de una definición de índice, que describe el nombre, el tipo de datos y el comportamiento de búsqueda de un campo.

Propiedades

analyzerName	Nombre del analizador de idioma que se va a usar para el campo. Esta opción puede utilizarse solo con campos habilitados para la búsqueda y no se puede establecer junto con searchAnalyzer ni indexAnalyzer. Una vez que se elige el analizador, no se podrá cambiar para el campo. KnownAnalyzerNames es una enumeración que contiene nombres de analizador integrados.
facetable	Valor que indica si se va a permitir que se haga referencia al campo en las consultas de faceta. Normalmente se usa en una presentación de resultados de búsqueda que incluye el número de llamadas por categoría (por ejemplo, buscar cámaras digitales y ver visitas por marca, por megapíxeles, por precio, etc.). Los campos de tipo Edm.GeographyPoint o Collection(Edm.GeographyPoint) no pueden ser facetables. El valor predeterminado es false para todos los demás campos simples.
filterable	Valor que indica si se debe hacer referencia al campo en $filter consultas. El filtrado difiere de lo que se puede buscar en la forma en que se controlan las cadenas. Los campos de tipo Edm.String o Collection(Edm.String) que se pueden filtrar no se someten a separación de palabras, por lo que las comparaciones son solo para coincidencias exactas. Por ejemplo, si establece este campo f en "sunny day", $filter=f eq 'sunny' no encontrará coincidencias, pero $filter=f eq 'sunny day' will. El valor predeterminado es False.
hidden	Valor que indica si el campo se puede devolver en un resultado de búsqueda. Puede habilitar esta opción si desea usar un campo (por ejemplo, margen) como filtro, ordenación o mecanismo de puntuación, pero no desea que el campo sea visible para el usuario final. Esta propiedad debe ser false para los campos de clave. Esta propiedad se puede cambiar en campos existentes. Deshabilitar esta propiedad no provoca ningún aumento en los requisitos de almacenamiento de índices. El valor predeterminado es False.
indexAnalyzerName	Nombre del analizador utilizado en el tiempo de indexación del campo. Esta opción solo se puede usar con campos que se pueden buscar. Debe establecerse junto con searchAnalyzer y no se puede establecer junto con la opción del analizador. Una vez que se elige el analizador, no se podrá cambiar para el campo. KnownAnalyzerNames es una enumeración que contiene nombres de analizador integrados.
key	Valor que indica si el campo identifica de forma única los documentos del índice. Se debe elegir exactamente un campo de nivel superior en cada índice como campo clave y debe ser de tipo Edm.String. Los campos clave se pueden usar para buscar documentos directamente y actualizar o eliminar documentos específicos. El valor predeterminado es False.
name	Nombre del campo, que debe ser único dentro de la colección fields del índice o campo primario.
searchable	Valor que indica si el campo es buscable de texto completo. Esto significa que se someterá a análisis como la separación de palabras durante la indexación. Si establece un campo buscable en un valor como "día soleado", internamente se dividirá en los tokens individuales "soleado" y "día". Esto permite realizar búsquedas de texto completo de estos términos. Esta propiedad debe ser false para campos simples de otros tipos de datos que no son de cadena. Nota: Los campos que se pueden buscar consumen espacio adicional en el índice, ya que Azure Cognitive Search almacenará una versión tokenizada adicional del valor del campo para las búsquedas de texto completo. El valor predeterminado es false para los campos simples.
searchAnalyzerName	Nombre del analizador utilizado en el momento de la búsqueda del campo. Esta opción solo se puede usar con campos que se pueden buscar. Debe establecerse junto con indexAnalyzer y no se puede establecer junto con la opción analizador. Este analizador se puede actualizar en un campo existente. KnownAnalyzerNames es una enumeración que contiene nombres de analizador integrados.
sortable	Valor que indica si se debe hacer referencia al campo en $orderby expresiones. De forma predeterminada, Azure Cognitive Search ordena los resultados por puntuación, pero en muchas experiencias los usuarios querrán ordenar por campos de los documentos. Un campo simple solo se puede ordenar si es de un solo valor (tiene un valor único en el ámbito del documento primario). Los campos de colección simples no se pueden ordenar, ya que son multivalor. Los subprocesos simples de colecciones complejas también tienen varios valores y, por tanto, no se pueden ordenar. Esto es cierto si es un campo primario inmediato o un campo antecesor, es la colección compleja. El valor predeterminado para ordenar es false.
synonymMapNames	Lista de los nombres de los mapas de sinónimos que se van a asociar a este campo. Esta opción solo se puede usar con campos que se pueden buscar. Actualmente solo se admite un mapa de sinónimos por campo. La asignación de un mapa de sinónimos a un campo garantiza que los términos de consulta destinados a ese campo se expanden en tiempo de consulta mediante las reglas del mapa de sinónimos. Este atributo se puede cambiar en los campos existentes.
type	Tipo de datos del campo. Entre los valores posibles se incluyen: 'Edm.String', 'Edm.Int32', 'Edm.Int64', 'Edm.Double', 'Edm.Boolean', 'Edm.DateTimeOffset', 'Edm.GeographyPoint', 'Collection(Edm.String)', 'Collection(Edm.Int32)', 'Collection(Edm.Int64)', 'Collection(Edm.Double)', 'Collection(Edm.Boolean)', 'Collection(Edm.DateTimeOffset)', 'Collection(Edm.GeographyPoint)', 'Collection(Edm.Single)'
vectorSearchDimensions	Dimensionalidad del campo vectorial.
vectorSearchProfileName	Nombre de la configuración del algoritmo de búsqueda vectorial que especifica el algoritmo y los parámetros opcionales para buscar en el campo vectorial.

Detalles de las propiedades

analyzerName

Nombre del analizador de idioma que se va a usar para el campo. Esta opción puede utilizarse solo con campos habilitados para la búsqueda y no se puede establecer junto con searchAnalyzer ni indexAnalyzer. Una vez que se elige el analizador, no se podrá cambiar para el campo. KnownAnalyzerNames es una enumeración que contiene nombres de analizador integrados.

analyzerName?: string

Valor de propiedad

string

facetable

Valor que indica si se va a permitir que se haga referencia al campo en las consultas de faceta. Normalmente se usa en una presentación de resultados de búsqueda que incluye el número de llamadas por categoría (por ejemplo, buscar cámaras digitales y ver visitas por marca, por megapíxeles, por precio, etc.). Los campos de tipo Edm.GeographyPoint o Collection(Edm.GeographyPoint) no pueden ser facetables. El valor predeterminado es false para todos los demás campos simples.

facetable?: boolean

Valor de propiedad

boolean

filterable

Valor que indica si se debe hacer referencia al campo en $filter consultas. El filtrado difiere de lo que se puede buscar en la forma en que se controlan las cadenas. Los campos de tipo Edm.String o Collection(Edm.String) que se pueden filtrar no se someten a separación de palabras, por lo que las comparaciones son solo para coincidencias exactas. Por ejemplo, si establece este campo f en "sunny day", $filter=f eq 'sunny' no encontrará coincidencias, pero $filter=f eq 'sunny day' will. El valor predeterminado es False.

filterable?: boolean

Valor de propiedad

boolean

hidden

Valor que indica si el campo se puede devolver en un resultado de búsqueda. Puede habilitar esta opción si desea usar un campo (por ejemplo, margen) como filtro, ordenación o mecanismo de puntuación, pero no desea que el campo sea visible para el usuario final. Esta propiedad debe ser false para los campos de clave. Esta propiedad se puede cambiar en campos existentes. Deshabilitar esta propiedad no provoca ningún aumento en los requisitos de almacenamiento de índices. El valor predeterminado es False.

hidden?: boolean

Valor de propiedad

boolean

indexAnalyzerName

Nombre del analizador utilizado en el tiempo de indexación del campo. Esta opción solo se puede usar con campos que se pueden buscar. Debe establecerse junto con searchAnalyzer y no se puede establecer junto con la opción del analizador. Una vez que se elige el analizador, no se podrá cambiar para el campo. KnownAnalyzerNames es una enumeración que contiene nombres de analizador integrados.

indexAnalyzerName?: string

Valor de propiedad

string

key

Valor que indica si el campo identifica de forma única los documentos del índice. Se debe elegir exactamente un campo de nivel superior en cada índice como campo clave y debe ser de tipo Edm.String. Los campos clave se pueden usar para buscar documentos directamente y actualizar o eliminar documentos específicos. El valor predeterminado es False.

key?: boolean

Valor de propiedad

boolean

name

Nombre del campo, que debe ser único dentro de la colección fields del índice o campo primario.

name: string

Valor de propiedad

string

searchable

Valor que indica si el campo es buscable de texto completo. Esto significa que se someterá a análisis como la separación de palabras durante la indexación. Si establece un campo buscable en un valor como "día soleado", internamente se dividirá en los tokens individuales "soleado" y "día". Esto permite realizar búsquedas de texto completo de estos términos. Esta propiedad debe ser false para campos simples de otros tipos de datos que no son de cadena. Nota: Los campos que se pueden buscar consumen espacio adicional en el índice, ya que Azure Cognitive Search almacenará una versión tokenizada adicional del valor del campo para las búsquedas de texto completo. El valor predeterminado es false para los campos simples.

searchable?: boolean

Valor de propiedad

boolean

searchAnalyzerName

Nombre del analizador utilizado en el momento de la búsqueda del campo. Esta opción solo se puede usar con campos que se pueden buscar. Debe establecerse junto con indexAnalyzer y no se puede establecer junto con la opción analizador. Este analizador se puede actualizar en un campo existente. KnownAnalyzerNames es una enumeración que contiene nombres de analizador integrados.

searchAnalyzerName?: string

Valor de propiedad

string

sortable

Valor que indica si se debe hacer referencia al campo en $orderby expresiones. De forma predeterminada, Azure Cognitive Search ordena los resultados por puntuación, pero en muchas experiencias los usuarios querrán ordenar por campos de los documentos. Un campo simple solo se puede ordenar si es de un solo valor (tiene un valor único en el ámbito del documento primario). Los campos de colección simples no se pueden ordenar, ya que son multivalor. Los subprocesos simples de colecciones complejas también tienen varios valores y, por tanto, no se pueden ordenar. Esto es cierto si es un campo primario inmediato o un campo antecesor, es la colección compleja. El valor predeterminado para ordenar es false.

sortable?: boolean

Valor de propiedad

boolean

synonymMapNames

Lista de los nombres de los mapas de sinónimos que se van a asociar a este campo. Esta opción solo se puede usar con campos que se pueden buscar. Actualmente solo se admite un mapa de sinónimos por campo. La asignación de un mapa de sinónimos a un campo garantiza que los términos de consulta destinados a ese campo se expanden en tiempo de consulta mediante las reglas del mapa de sinónimos. Este atributo se puede cambiar en los campos existentes.

synonymMapNames?: string[]

Valor de propiedad

string[]

type

Tipo de datos del campo. Entre los valores posibles se incluyen: 'Edm.String', 'Edm.Int32', 'Edm.Int64', 'Edm.Double', 'Edm.Boolean', 'Edm.DateTimeOffset', 'Edm.GeographyPoint', 'Collection(Edm.String)', 'Collection(Edm.Int32)', 'Collection(Edm.Int64)', 'Collection(Edm.Double)', 'Collection(Edm.Boolean)', 'Collection(Edm.DateTimeOffset)', 'Collection(Edm.GeographyPoint)', 'Collection(Edm.Single)'

type: SearchFieldDataType

Valor de propiedad

SearchFieldDataType

vectorSearchDimensions

Dimensionalidad del campo vectorial.

vectorSearchDimensions?: number

Valor de propiedad

number

vectorSearchProfileName

Nombre de la configuración del algoritmo de búsqueda vectorial que especifica el algoritmo y los parámetros opcionales para buscar en el campo vectorial.

vectorSearchProfileName?: string

Valor de propiedad

string