SimpleField interface

Pacote:

@azure/search-documents

Representa um campo numa definição de índice, que descreve o nome, o tipo de dados e o comportamento de pesquisa de um campo.

Propriedades

analyzerName	O nome do analisador de idiomas a utilizar para o campo. Esta opção só pode ser utilizada com campos pesquisáveis e não pode ser definida em conjunto com searchAnalyzer ou indexAnalyzer. Uma vez escolhido o analisador, não pode ser alterado para o campo. KnownAnalyzerNames é um número que contém nomes de analisadores incorporados.
facetable	Um valor que indica se pretende ativar o campo para ser referenciado em consultas facetas. Normalmente utilizado numa apresentação de resultados de pesquisa que inclui a contagem de resultados por categoria (por exemplo, procure câmaras digitais e veja acessos por marca, por megapixéis, por preço e assim por diante). Os campos do tipo Edm.GeographyPoint ou Collection(Edm.GeographyPoint) não podem ser facetáveis. A predefinição é falsa para todos os outros campos simples.
filterable	Um valor que indica se pretende ativar o campo para ser referenciado em consultas $filter. Filtráveis difere do pesquisável na forma como as cadeias são processadas. Os campos do tipo Edm.String ou Collection(Edm.String) que são filtráveis não são submetidos a quebra de palavras, pelo que as comparações destinam-se apenas a correspondências exatas. Por exemplo, se definir tal campo f como "dia ensolarado", $filter=f eq 'sunny' não encontrará correspondências, mas $filter=f eq 'dia ensolarado' irá. A predefinição é falso.
hidden	Um valor que indica se o campo pode ser devolvido num resultado de pesquisa. Pode ativar esta opção se quiser utilizar um campo (por exemplo, margem) como um filtro, ordenação ou mecanismo de classificação, mas não quiser que o campo seja visível para o utilizador final. Esta propriedade tem de ser falsa para campos de chave. Esta propriedade pode ser alterada em campos existentes. A desativação desta propriedade não causa qualquer aumento nos requisitos de armazenamento de índices. A predefinição é falso.
indexAnalyzerName	O nome do analisador utilizado no momento da indexação do campo. Esta opção só pode ser utilizada com campos pesquisáveis. Tem de ser definido em conjunto com searchAnalyzer e não pode ser definido em conjunto com a opção analisador. Uma vez escolhido o analisador, não pode ser alterado para o campo. KnownAnalyzerNames é um número que contém nomes de analisadores incorporados.
key	Um valor que indica se o campo identifica exclusivamente documentos no índice. Exatamente um campo de nível superior em cada índice tem de ser escolhido como o campo de chave e tem de ser do tipo Edm.String. Os campos-chave podem ser utilizados para procurar documentos diretamente e atualizar ou eliminar documentos específicos. A predefinição é falso.
name	O nome do campo, que tem de ser exclusivo na coleção de campos do campo principal ou índice.
searchable	Um valor que indica se o campo é pesquisável em texto completo. Isto significa que será submetido a análises como quebra de palavras durante a indexação. Se definir um campo pesquisável para um valor como "sunny day", será dividido internamente nos tokens individuais "sunny" e "day". Isto permite pesquisas em texto completo para estes termos. Esta propriedade tem de ser falsa para campos simples de outros tipos de dados que não sejam cadeias de carateres. Nota: os campos pesquisáveis consomem espaço extra no índice, uma vez que Azure Cognitive Search irá armazenar uma versão token adicional do valor do campo para pesquisas de texto completo. A predefinição é falsa para campos simples.
searchAnalyzerName	O nome do analisador utilizado no momento da pesquisa para o campo. Esta opção só pode ser utilizada com campos pesquisáveis. Tem de ser definido em conjunto com indexAnalyzer e não pode ser definido em conjunto com a opção analisador. Este analisador pode ser atualizado num campo existente. KnownAnalyzerNames é um número que contém nomes de analisadores incorporados.
sortable	Um valor que indica se pretende ativar o campo para ser referenciado em expressões $orderby. Por predefinição, Azure Cognitive Search ordena os resultados por classificação, mas em muitas experiências os utilizadores vão querer ordenar por campos nos documentos. Um campo simples só pode ser ordenado se for de valor único (tem um único valor no âmbito do documento principal). Os campos de coleção simples não podem ser ordenados, uma vez que têm valores múltiplos. Os sub-campos simples de coleções complexas também têm valores múltiplos e, por conseguinte, não podem ser ordenados. Isto é verdade, quer seja um campo principal imediato, ou um campo ancestral, essa é a coleção complexa. A predefinição para o sortable é falsa.
synonymMapNames	Uma lista dos nomes dos mapas de sinónimos a associar a este campo. Esta opção só pode ser utilizada com campos pesquisáveis. Atualmente, apenas é suportado um mapa de sinónimos por campo. Atribuir um mapa de sinónimos a um campo garante que os termos de consulta direcionados para esse campo são expandidos no momento da consulta com as regras no mapa de sinónimos. Este atributo pode ser alterado em campos existentes.
type	O tipo de dados do campo. Os valores possíveis incluem: "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	A dimensionalidade do campo de vetor.
vectorSearchProfileName	O nome da configuração do algoritmo de pesquisa de vetores que especifica o algoritmo e os parâmetros opcionais para procurar no campo de vetor.

Detalhes de Propriedade

analyzerName

O nome do analisador de idiomas a utilizar para o campo. Esta opção só pode ser utilizada com campos pesquisáveis e não pode ser definida em conjunto com searchAnalyzer ou indexAnalyzer. Uma vez escolhido o analisador, não pode ser alterado para o campo. KnownAnalyzerNames é um número que contém nomes de analisadores incorporados.

analyzerName?: string

Valor de Propriedade

string

facetable

Um valor que indica se pretende ativar o campo para ser referenciado em consultas facetas. Normalmente utilizado numa apresentação de resultados de pesquisa que inclui a contagem de resultados por categoria (por exemplo, procure câmaras digitais e veja acessos por marca, por megapixéis, por preço e assim por diante). Os campos do tipo Edm.GeographyPoint ou Collection(Edm.GeographyPoint) não podem ser facetáveis. A predefinição é falsa para todos os outros campos simples.

facetable?: boolean

Valor de Propriedade

boolean

filterable

Um valor que indica se pretende ativar o campo para ser referenciado em consultas $filter. Filtráveis difere do pesquisável na forma como as cadeias são processadas. Os campos do tipo Edm.String ou Collection(Edm.String) que são filtráveis não são submetidos a quebra de palavras, pelo que as comparações destinam-se apenas a correspondências exatas. Por exemplo, se definir tal campo f como "dia ensolarado", $filter=f eq 'sunny' não encontrará correspondências, mas $filter=f eq 'dia ensolarado' irá. A predefinição é falso.

filterable?: boolean

Valor de Propriedade

boolean

hidden

Um valor que indica se o campo pode ser devolvido num resultado de pesquisa. Pode ativar esta opção se quiser utilizar um campo (por exemplo, margem) como um filtro, ordenação ou mecanismo de classificação, mas não quiser que o campo seja visível para o utilizador final. Esta propriedade tem de ser falsa para campos de chave. Esta propriedade pode ser alterada em campos existentes. A desativação desta propriedade não causa qualquer aumento nos requisitos de armazenamento de índices. A predefinição é falso.

hidden?: boolean

Valor de Propriedade

boolean

indexAnalyzerName

O nome do analisador utilizado no momento da indexação do campo. Esta opção só pode ser utilizada com campos pesquisáveis. Tem de ser definido em conjunto com searchAnalyzer e não pode ser definido em conjunto com a opção analisador. Uma vez escolhido o analisador, não pode ser alterado para o campo. KnownAnalyzerNames é um número que contém nomes de analisadores incorporados.

indexAnalyzerName?: string

Valor de Propriedade

string

key

Um valor que indica se o campo identifica exclusivamente documentos no índice. Exatamente um campo de nível superior em cada índice tem de ser escolhido como o campo de chave e tem de ser do tipo Edm.String. Os campos-chave podem ser utilizados para procurar documentos diretamente e atualizar ou eliminar documentos específicos. A predefinição é falso.

key?: boolean

Valor de Propriedade

boolean

name

O nome do campo, que tem de ser exclusivo na coleção de campos do campo principal ou índice.

name: string

Valor de Propriedade

string

searchable

Um valor que indica se o campo é pesquisável em texto completo. Isto significa que será submetido a análises como quebra de palavras durante a indexação. Se definir um campo pesquisável para um valor como "sunny day", será dividido internamente nos tokens individuais "sunny" e "day". Isto permite pesquisas em texto completo para estes termos. Esta propriedade tem de ser falsa para campos simples de outros tipos de dados que não sejam cadeias de carateres. Nota: os campos pesquisáveis consomem espaço extra no índice, uma vez que Azure Cognitive Search irá armazenar uma versão token adicional do valor do campo para pesquisas de texto completo. A predefinição é falsa para campos simples.

searchable?: boolean

Valor de Propriedade

boolean

searchAnalyzerName

O nome do analisador utilizado no momento da pesquisa para o campo. Esta opção só pode ser utilizada com campos pesquisáveis. Tem de ser definido em conjunto com indexAnalyzer e não pode ser definido em conjunto com a opção analisador. Este analisador pode ser atualizado num campo existente. KnownAnalyzerNames é um número que contém nomes de analisadores incorporados.

searchAnalyzerName?: string

Valor de Propriedade

string

sortable

Um valor que indica se pretende ativar o campo para ser referenciado em expressões $orderby. Por predefinição, Azure Cognitive Search ordena os resultados por classificação, mas em muitas experiências os utilizadores vão querer ordenar por campos nos documentos. Um campo simples só pode ser ordenado se for de valor único (tem um único valor no âmbito do documento principal). Os campos de coleção simples não podem ser ordenados, uma vez que têm valores múltiplos. Os sub-campos simples de coleções complexas também têm valores múltiplos e, por conseguinte, não podem ser ordenados. Isto é verdade, quer seja um campo principal imediato, ou um campo ancestral, essa é a coleção complexa. A predefinição para o sortable é falsa.

sortable?: boolean

Valor de Propriedade

boolean

synonymMapNames

Uma lista dos nomes dos mapas de sinónimos a associar a este campo. Esta opção só pode ser utilizada com campos pesquisáveis. Atualmente, apenas é suportado um mapa de sinónimos por campo. Atribuir um mapa de sinónimos a um campo garante que os termos de consulta direcionados para esse campo são expandidos no momento da consulta com as regras no mapa de sinónimos. Este atributo pode ser alterado em campos existentes.

synonymMapNames?: string[]

Valor de Propriedade

string[]

type

O tipo de dados do campo. Os valores possíveis incluem: "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 Propriedade

SearchFieldDataType

vectorSearchDimensions

A dimensionalidade do campo de vetor.

vectorSearchDimensions?: number

Valor de Propriedade

number

vectorSearchProfileName

O nome da configuração do algoritmo de pesquisa de vetores que especifica o algoritmo e os parâmetros opcionais para procurar no campo de vetor.

vectorSearchProfileName?: string

Valor de Propriedade

string