SimpleField interface

Pacote:

@azure/search-documents

Representa um campo em uma 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 a ser usado para o campo. Essa opção pode ser usada apenas com campos pesquisáveis e não pode ser definida junto com searchAnalyzer ou indexAnalyzer. Uma vez que o analisador é escolhido, ele não pode ser alterado para o campo.
facetable	Um valor que indica se o campo deve ser referenciado em consultas de facetas. Normalmente usado em uma apresentação de resultados de pesquisa que inclui contagem de visitas por categoria (por exemplo, pesquisar câmeras digitais e ver acessos por marca, por megapixels, por preço e assim por diante). Os campos do tipo Edm.GeographyPoint ou Collection(Edm.GeographyPoint) não podem ser facial. O padrão é false.
filterable	Um valor que indica se o campo deve ser referenciado em consultas $filter. Filtrável difere de pesquisável em como as cadeias de caracteres são manipuladas. Os campos do tipo Edm.String ou Collection(Edm.String) que podem ser filtrados não sofrem quebra de palavras, portanto, as comparações são apenas para correspondências exatas. Por exemplo, se você definir tal campo f como "dia ensolarado", $filter=f eq 'ensolarado' não encontrará correspondências, mas $filter=f eq 'dia ensolarado' irá. O padrão é false.
hidden	Um valor que indica se o campo pode ser retornado em um resultado de pesquisa. Você pode desabilitar essa opção se quiser usar um campo (por exemplo, margem) como filtro, classificação ou mecanismo de pontuação, mas não quiser que o campo fique visível para o usuário final. Esta propriedade deve ser false para campos chave. Esta propriedade pode ser alterada em campos existentes. A habilitação dessa propriedade não causa nenhum aumento nos requisitos de armazenamento de índice. O padrão é true para campos vetoriais, false caso contrário.
indexAnalyzerName	O nome do analisador usado no momento da indexação para o campo. Esta opção só pode ser usada com campos pesquisáveis. Ele deve ser definido junto com searchAnalyzer e não pode ser definido junto com a opção do analisador. Esta propriedade não pode ser definida como o nome de um analisador de linguagem; Em vez disso, use a propriedade Analyzer se precisar de um analisador de linguagem. Uma vez que o analisador é escolhido, ele não pode ser alterado para o campo.
key	Um valor que indica se o campo identifica exclusivamente documentos no índice. Exatamente um campo de nível superior em cada índice deve ser escolhido como o campo chave e deve ser do tipo Edm.String. Os campos-chave podem ser usados para pesquisar documentos diretamente e atualizar ou excluir documentos específicos. O padrão é false.
name	O nome do campo, que deve ser exclusivo dentro da coleção de campos do campo de índice ou pai.
searchable	Um valor que indica se o campo pode ser pesquisado em texto completo. Isso significa que ele passará por análises, como quebra de palavras durante a indexação. Se você definir um campo pesquisável para um valor como "dia ensolarado", internamente ele será dividido nos tokens individuais "ensolarado" e "dia". Isso permite pesquisas de texto completo para esses termos. Os campos do tipo Edm.String ou Collection(Edm.String) são pesquisáveis por padrão. Essa propriedade deve ser false para campos simples de outros tipos de dados que não sejam de cadeia de caracteres. Nota: os campos pesquisáveis consomem espaço extra no índice para acomodar versões tokenizadas adicionais do valor do campo para pesquisas de texto completo. Se quiser economizar espaço no índice e não precisar de um campo para ser incluído nas pesquisas, defina pesquisável como false. O padrão é false.
searchAnalyzerName	O nome do analisador usado no momento da pesquisa para o campo. Esta opção só pode ser usada com campos pesquisáveis. Deve ser definido em conjunto com indexAnalyzerName e não pode ser definido em conjunto com a opção analyzerName. Esta propriedade não pode ser definida como o nome de um analisador de linguagem; Em vez disso, use a propriedade analyzerName se precisar de um analisador de idiomas. Este analisador pode ser atualizado em um campo existente.
sortable	Um valor que indica se o campo deve ser referenciado em expressões $orderby. Por padrão, o mecanismo de pesquisa classifica os resultados por pontuação, mas em muitas experiências os usuários vão querer classificar por campos nos documentos. Um campo simples só pode ser classificado se tiver um único valor (tem um único valor no âmbito do documento principal). Os campos de recolha simples não podem ser ordenados, uma vez que têm vários valores. Subcampos simples de coleções complexas também são multivalorados e, portanto, não podem ser classificados. Isso é verdade se é um campo pai imediato, ou um campo ancestral, essa é a coleção complexa. O padrão é false.
stored	Um valor imutável que indica se o campo será persistido separadamente no disco para ser retornado em um resultado de pesquisa. Você pode desativar essa opção se não planeja retornar o conteúdo do campo em uma resposta de pesquisa para economizar na sobrecarga de armazenamento. Isso só pode ser definido durante a criação do índice e somente para campos vetoriais. Esta propriedade não pode ser alterada para campos existentes ou definida como false para novos campos. Se essa propriedade for definida como false, a propriedade 'hidden' deve ser definida como 'true'. Essa propriedade deve ser false ou unset para campos chave, para novos campos e para campos não vetoriais. A desativação dessa propriedade reduzirá os requisitos de armazenamento do índice.
synonymMapNames	Uma lista dos nomes dos mapas de sinónimos a associar a este campo. Esta opção só pode ser usada com campos pesquisáveis. Atualmente, apenas um mapa de sinônimo por campo é suportado. A atribuição de um mapa de sinônimo a um campo garante que os termos de consulta direcionados a esse campo sejam expandidos no momento da consulta usando as regras no mapa de sinônimos. Este atributo pode ser alterado em campos existentes.
type	O tipo de dados do campo.
vectorEncodingFormat	O formato de codificação para interpretar o conteúdo do campo.
vectorSearchDimensions	A dimensionalidade do campo vetorial.
vectorSearchProfileName	O nome do perfil de pesquisa vetorial que especifica o algoritmo e o vetorizador a serem usados ao pesquisar o campo vetorial.

Detalhes de Propriedade

analyzerName

O nome do analisador a ser usado para o campo. Essa opção pode ser usada apenas com campos pesquisáveis e não pode ser definida junto com searchAnalyzer ou indexAnalyzer. Uma vez que o analisador é escolhido, ele não pode ser alterado para o campo.

analyzerName?: string

Valor de Propriedade

string

facetable

Um valor que indica se o campo deve ser referenciado em consultas de facetas. Normalmente usado em uma apresentação de resultados de pesquisa que inclui contagem de visitas por categoria (por exemplo, pesquisar câmeras digitais e ver acessos por marca, por megapixels, por preço e assim por diante). Os campos do tipo Edm.GeographyPoint ou Collection(Edm.GeographyPoint) não podem ser facial. O padrão é false.

facetable?: boolean

Valor de Propriedade

boolean

filterable

Um valor que indica se o campo deve ser referenciado em consultas $filter. Filtrável difere de pesquisável em como as cadeias de caracteres são manipuladas. Os campos do tipo Edm.String ou Collection(Edm.String) que podem ser filtrados não sofrem quebra de palavras, portanto, as comparações são apenas para correspondências exatas. Por exemplo, se você definir tal campo f como "dia ensolarado", $filter=f eq 'ensolarado' não encontrará correspondências, mas $filter=f eq 'dia ensolarado' irá. O padrão é false.

filterable?: boolean

Valor de Propriedade

boolean

hidden

Um valor que indica se o campo pode ser retornado em um resultado de pesquisa. Você pode desabilitar essa opção se quiser usar um campo (por exemplo, margem) como filtro, classificação ou mecanismo de pontuação, mas não quiser que o campo fique visível para o usuário final. Esta propriedade deve ser false para campos chave. Esta propriedade pode ser alterada em campos existentes. A habilitação dessa propriedade não causa nenhum aumento nos requisitos de armazenamento de índice. O padrão é true para campos vetoriais, false caso contrário.

hidden?: boolean

Valor de Propriedade

boolean

indexAnalyzerName

O nome do analisador usado no momento da indexação para o campo. Esta opção só pode ser usada com campos pesquisáveis. Ele deve ser definido junto com searchAnalyzer e não pode ser definido junto com a opção do analisador. Esta propriedade não pode ser definida como o nome de um analisador de linguagem; Em vez disso, use a propriedade Analyzer se precisar de um analisador de linguagem. Uma vez que o analisador é escolhido, ele não pode ser alterado para o campo.

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 deve ser escolhido como o campo chave e deve ser do tipo Edm.String. Os campos-chave podem ser usados para pesquisar documentos diretamente e atualizar ou excluir documentos específicos. O padrão é false.

key?: boolean

Valor de Propriedade

boolean

name

O nome do campo, que deve ser exclusivo dentro da coleção de campos do campo de índice ou pai.

name: string

Valor de Propriedade

string

searchable

Um valor que indica se o campo pode ser pesquisado em texto completo. Isso significa que ele passará por análises, como quebra de palavras durante a indexação. Se você definir um campo pesquisável para um valor como "dia ensolarado", internamente ele será dividido nos tokens individuais "ensolarado" e "dia". Isso permite pesquisas de texto completo para esses termos. Os campos do tipo Edm.String ou Collection(Edm.String) são pesquisáveis por padrão. Essa propriedade deve ser false para campos simples de outros tipos de dados que não sejam de cadeia de caracteres. Nota: os campos pesquisáveis consomem espaço extra no índice para acomodar versões tokenizadas adicionais do valor do campo para pesquisas de texto completo. Se quiser economizar espaço no índice e não precisar de um campo para ser incluído nas pesquisas, defina pesquisável como false. O padrão é false.

searchable?: boolean

Valor de Propriedade

boolean

searchAnalyzerName

O nome do analisador usado no momento da pesquisa para o campo. Esta opção só pode ser usada com campos pesquisáveis. Deve ser definido em conjunto com indexAnalyzerName e não pode ser definido em conjunto com a opção analyzerName. Esta propriedade não pode ser definida como o nome de um analisador de linguagem; Em vez disso, use a propriedade analyzerName se precisar de um analisador de idiomas. Este analisador pode ser atualizado em um campo existente.

searchAnalyzerName?: string

Valor de Propriedade

string

sortable

Um valor que indica se o campo deve ser referenciado em expressões $orderby. Por padrão, o mecanismo de pesquisa classifica os resultados por pontuação, mas em muitas experiências os usuários vão querer classificar por campos nos documentos. Um campo simples só pode ser classificado se tiver um único valor (tem um único valor no âmbito do documento principal). Os campos de recolha simples não podem ser ordenados, uma vez que têm vários valores. Subcampos simples de coleções complexas também são multivalorados e, portanto, não podem ser classificados. Isso é verdade se é um campo pai imediato, ou um campo ancestral, essa é a coleção complexa. O padrão é false.

sortable?: boolean

Valor de Propriedade

boolean

stored

Um valor imutável que indica se o campo será persistido separadamente no disco para ser retornado em um resultado de pesquisa. Você pode desativar essa opção se não planeja retornar o conteúdo do campo em uma resposta de pesquisa para economizar na sobrecarga de armazenamento. Isso só pode ser definido durante a criação do índice e somente para campos vetoriais. Esta propriedade não pode ser alterada para campos existentes ou definida como false para novos campos. Se essa propriedade for definida como false, a propriedade 'hidden' deve ser definida como 'true'. Essa propriedade deve ser false ou unset para campos chave, para novos campos e para campos não vetoriais. A desativação dessa propriedade reduzirá os requisitos de armazenamento do índice.

stored?: 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 usada com campos pesquisáveis. Atualmente, apenas um mapa de sinônimo por campo é suportado. A atribuição de um mapa de sinônimo a um campo garante que os termos de consulta direcionados a esse campo sejam expandidos no momento da consulta usando 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.

type: SearchFieldDataType

Valor de Propriedade

SearchFieldDataType

vectorEncodingFormat

O formato de codificação para interpretar o conteúdo do campo.

vectorEncodingFormat?: string

Valor de Propriedade

string

vectorSearchDimensions

A dimensionalidade do campo vetorial.

vectorSearchDimensions?: number

Valor de Propriedade

number

vectorSearchProfileName

O nome do perfil de pesquisa vetorial que especifica o algoritmo e o vetorizador a serem usados ao pesquisar o campo vetorial.

vectorSearchProfileName?: string

Valor de Propriedade

string