SimpleField interface

Paquete:

@azure/search-documents

Representa un campo en 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 que se va a usar para el campo. Esta opción solo se puede usar con campos que se pueden buscar y no se puede establecer junto con searchAnalyzer o indexAnalyzer. Una vez elegido el analizador, no se puede cambiar para el campo.
facetable	Valor que indica si se debe hacer referencia al campo en las consultas de facetas. Normalmente se usa en una presentación de los resultados de búsqueda que incluye el recuento de visitas 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.
filterable	Valor que indica si se debe hacer referencia al campo en $filter consultas. filterable 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 "día soleado", $filter=f eq "sunny" no encontrará coincidencias, pero $filter=f eq "sunny day". El valor predeterminado es false.
hidden	Valor que indica si el campo se puede devolver en un resultado de búsqueda. Puede deshabilitar 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. La habilitación de esta propiedad no provoca ningún aumento en los requisitos de almacenamiento de índices. El valor predeterminado es true para los campos vectoriales; de lo contrario, false.
indexAnalyzerName	Nombre del analizador que se usa en el momento de la 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 analizador. Esta propiedad no se puede establecer en el nombre de un analizador de lenguaje; Use la propiedad analyzer en su lugar si necesita un analizador de lenguaje. Una vez elegido el analizador, no se puede cambiar para el campo.
key	Valor que indica si el campo identifica de forma única documentos en el í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 del campo primario.
searchable	Valor que indica si el campo es de texto completo que se puede buscar. Esto significa que se somete a un análisis como la separación de palabras durante la indexación. Si establece un campo que se puede buscar en un valor como "día soleado", se dividirá internamente en los tokens individuales "soleado" y "día". Esto permite búsquedas de texto completo para estos términos. Los campos de tipo Edm.String o Collection(Edm.String) se pueden buscar de forma predeterminada. 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 para dar cabida a versiones tokenizadas adicionales del valor del campo para las búsquedas de texto completo. Si desea ahorrar espacio en el índice y no necesita incluir un campo en las búsquedas, establezca searchable en false. El valor predeterminado es false.
searchAnalyzerName	Nombre del analizador usado en tiempo de búsqueda para el campo. Esta opción solo se puede usar con campos que se pueden buscar. Debe establecerse junto con indexAnalyzerName y no se puede establecer junto con la opción analyzerName. Esta propiedad no se puede establecer en el nombre de un analizador de lenguaje; Use la propiedad analyzerName en su lugar si necesita un analizador de lenguaje. Este analizador se puede actualizar en un campo existente.
sortable	Valor que indica si se debe hacer referencia al campo en $orderby expresiones. De forma predeterminada, el motor de búsqueda ordena los resultados por puntuación, pero en muchas experiencias los usuarios querrán ordenar por campos de los documentos. Solo se puede ordenar un campo simple si se trata de un solo valor (tiene un único valor 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 son multivalor y, por tanto, no se pueden ordenar. Esto es cierto si es un campo primario inmediato o un campo antecesor, que es la colección compleja. El valor predeterminado es false.
stored	Valor inmutable que indica si el campo se conservará por separado en el disco que se devolverá en un resultado de búsqueda. Puede deshabilitar esta opción si no tiene previsto devolver el contenido del campo en una respuesta de búsqueda para ahorrar en la sobrecarga de almacenamiento. Esto solo se puede establecer durante la creación del índice y solo para campos vectoriales. Esta propiedad no se puede cambiar para los campos existentes ni establecerse como false para los nuevos campos. Si esta propiedad se establece como false, la propiedad 'hidden' debe establecerse en 'true'. Esta propiedad debe ser false o no establecer para los campos de clave, para los nuevos campos y para los campos no vectoriales. Deshabilitar esta propiedad reducirá los requisitos de almacenamiento de índices.
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 campos existentes.
type	Tipo de datos del campo.
vectorEncodingFormat	Formato de codificación para interpretar el contenido del campo.
vectorSearchDimensions	Dimensionalidad del campo vectorial.
vectorSearchProfileName	Nombre del perfil de búsqueda vectorial que especifica el algoritmo y el vectorizador que se va a usar al buscar en el campo vectorial.

Detalles de las propiedades

analyzerName

Nombre del analizador que se va a usar para el campo. Esta opción solo se puede usar con campos que se pueden buscar y no se puede establecer junto con searchAnalyzer o indexAnalyzer. Una vez elegido el analizador, no se puede cambiar para el campo.

analyzerName?: string

Valor de propiedad

string

facetable

Valor que indica si se debe hacer referencia al campo en las consultas de facetas. Normalmente se usa en una presentación de los resultados de búsqueda que incluye el recuento de visitas 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.

facetable?: boolean

Valor de propiedad

boolean

filterable

Valor que indica si se debe hacer referencia al campo en $filter consultas. filterable 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 "día soleado", $filter=f eq "sunny" no encontrará coincidencias, pero $filter=f eq "sunny day". 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 deshabilitar 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. La habilitación de esta propiedad no provoca ningún aumento en los requisitos de almacenamiento de índices. El valor predeterminado es true para los campos vectoriales; de lo contrario, false.

hidden?: boolean

Valor de propiedad

boolean

indexAnalyzerName

Nombre del analizador que se usa en el momento de la 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 analizador. Esta propiedad no se puede establecer en el nombre de un analizador de lenguaje; Use la propiedad analyzer en su lugar si necesita un analizador de lenguaje. Una vez elegido el analizador, no se puede cambiar para el campo.

indexAnalyzerName?: string

Valor de propiedad

string

key

Valor que indica si el campo identifica de forma única documentos en el í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 del campo primario.

name: string

Valor de propiedad

string

searchable

Valor que indica si el campo es de texto completo que se puede buscar. Esto significa que se somete a un análisis como la separación de palabras durante la indexación. Si establece un campo que se puede buscar en un valor como "día soleado", se dividirá internamente en los tokens individuales "soleado" y "día". Esto permite búsquedas de texto completo para estos términos. Los campos de tipo Edm.String o Collection(Edm.String) se pueden buscar de forma predeterminada. 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 para dar cabida a versiones tokenizadas adicionales del valor del campo para las búsquedas de texto completo. Si desea ahorrar espacio en el índice y no necesita incluir un campo en las búsquedas, establezca searchable en false. El valor predeterminado es false.

searchable?: boolean

Valor de propiedad

boolean

searchAnalyzerName

Nombre del analizador usado en tiempo de búsqueda para el campo. Esta opción solo se puede usar con campos que se pueden buscar. Debe establecerse junto con indexAnalyzerName y no se puede establecer junto con la opción analyzerName. Esta propiedad no se puede establecer en el nombre de un analizador de lenguaje; Use la propiedad analyzerName en su lugar si necesita un analizador de lenguaje. Este analizador se puede actualizar en un campo existente.

searchAnalyzerName?: string

Valor de propiedad

string

sortable

Valor que indica si se debe hacer referencia al campo en $orderby expresiones. De forma predeterminada, el motor de búsqueda ordena los resultados por puntuación, pero en muchas experiencias los usuarios querrán ordenar por campos de los documentos. Solo se puede ordenar un campo simple si se trata de un solo valor (tiene un único valor 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 son multivalor y, por tanto, no se pueden ordenar. Esto es cierto si es un campo primario inmediato o un campo antecesor, que es la colección compleja. El valor predeterminado es false.

sortable?: boolean

Valor de propiedad

boolean

stored

Valor inmutable que indica si el campo se conservará por separado en el disco que se devolverá en un resultado de búsqueda. Puede deshabilitar esta opción si no tiene previsto devolver el contenido del campo en una respuesta de búsqueda para ahorrar en la sobrecarga de almacenamiento. Esto solo se puede establecer durante la creación del índice y solo para campos vectoriales. Esta propiedad no se puede cambiar para los campos existentes ni establecerse como false para los nuevos campos. Si esta propiedad se establece como false, la propiedad 'hidden' debe establecerse en 'true'. Esta propiedad debe ser false o no establecer para los campos de clave, para los nuevos campos y para los campos no vectoriales. Deshabilitar esta propiedad reducirá los requisitos de almacenamiento de índices.

stored?: 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 campos existentes.

synonymMapNames?: string[]

Valor de propiedad

string[]

type

Tipo de datos del campo.

type: SearchFieldDataType

Valor de propiedad

SearchFieldDataType

vectorEncodingFormat

Formato de codificación para interpretar el contenido del campo.

vectorEncodingFormat?: string

Valor de propiedad

string

vectorSearchDimensions

Dimensionalidad del campo vectorial.

vectorSearchDimensions?: number

Valor de propiedad

number

vectorSearchProfileName

Nombre del perfil de búsqueda vectorial que especifica el algoritmo y el vectorizador que se va a usar al buscar en el campo vectorial.

vectorSearchProfileName?: string

Valor de propiedad

string