SimpleField interface
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
| analyzer |
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 em conjunto com searchAnalyzer ou indexAnalyzer. Depois que o analisador for escolhido, ele não poderá ser alterado para o campo. |
| facetable | Um valor que indica se o campo deve ser referenciado em consultas de faceta. Normalmente usado em uma apresentação de resultados de pesquisa que inclui contagem de ocorrências por categoria (por exemplo, pesquise câmeras digitais e veja ocorrências por marca, por megapixels, por preço e assim por diante). Campos do tipo Edm.GeographyPoint ou Collection(Edm.GeographyPoint) não podem ser facetas. O padrão é false. |
| filterable | Um valor que indica se o campo deve ser referenciado em consultas $filter. filterable difere do pesquisável em como as cadeias de caracteres são tratadas. Os campos do tipo Edm.String ou Collection(Edm.String) que são filtrados não passam por quebra de palavras, portanto, as comparações são apenas para correspondências exatas. Por exemplo, se você definir esse campo f como "dia ensolarado", $filter=f eq 'sunny' não encontrará correspondências, mas $filter=f eq 'sunny day' irá. O padrão é false. |
| hidden | Um valor que indica se o campo pode ser retornado em um resultado de pesquisa. Você poderá desabilitar essa opção se quiser usar um campo (por exemplo, margem) como um filtro, classificação ou mecanismo de pontuação, mas não quiser que o campo fique visível para o usuário final. Essa propriedade deve ser falsa para campos de chave. Essa propriedade pode ser alterada em campos existentes. Habilitar essa propriedade não causa nenhum aumento nos requisitos de armazenamento de índice. O padrão é verdadeiro para campos de vetor, caso contrário, false. |
| index |
O nome do analisador usado no momento da indexação do campo. Essa 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 analisador. Essa propriedade não pode ser definida como o nome de um analisador de idiomas; use a propriedade do analisador se precisar de um analisador de idiomas. Depois que o analisador for escolhido, ele não poderá 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 de 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 na coleção de campos do índice ou do campo pai. |
| normalizer |
O nome do normalizador a ser usado para o campo. Essa opção pode ser usada somente com campos com filtrável, classificável ou facetável ativado. Uma vez escolhido o normalizador, ele não pode ser alterado para o campo. Deve ser nulo para campos complexos. |
| searchable | Um valor que indica se o campo é pesquisável por 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. Campos do tipo Edm.String ou Collection(Edm.String) são pesquisáveis por padrão. Essa propriedade deve ser falsa para campos simples de outros tipos de dados que não são de cadeia de caracteres. Observação: os campos pesquisáveis consomem espaço extra em seu índice para acomodar versões tokenizadas adicionais do valor do campo para pesquisas de texto completo. Se você quiser economizar espaço em seu índice e não precisar que um campo seja incluído nas pesquisas, defina pesquisável como false. O padrão é false. |
| search |
O nome do analisador usado no tempo de pesquisa do campo. Essa opção só pode ser usada com campos pesquisáveis. Ele deve ser definido junto com |
| 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 desejarão classificar por campos nos documentos. Um campo simples só poderá ser classificado se for de valor único (ele tem um único valor no escopo do documento pai). Campos de coleção simples não podem ser classificados, pois são de vários valores. Sub-campos simples de coleções complexas também são de vários valores e, portanto, não podem ser classificados. Isso é verdade se é um campo pai imediato, ou um campo ancestral, que é a coleção complexa. O padrão é false. |
| stored | Um valor imutável que indica se o campo será mantido separadamente no disco a ser retornado em um resultado de pesquisa. Você poderá desabilitar 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 de vetor. Essa 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' deverá ser definida como 'true'. Essa propriedade deve ser verdadeira ou não definida para campos-chave, para novos campos e para campos não vetoriais. Desabilitar essa propriedade reduzirá os requisitos de armazenamento de índice. O padrão é verdadeiro para campos de vetor. |
| synonym |
Uma lista dos nomes dos mapas de sinônimos a serem associados a esse campo. Essa opção só pode ser usada com campos pesquisáveis. Atualmente, há suporte para apenas um mapa de sinônimos por campo. Atribuir um mapa de sinônimos a um campo garante que os termos de consulta direcionados a esse campo sejam expandidos em tempo de consulta usando as regras no mapa de sinônimos. Esse atributo pode ser alterado em campos existentes. |
| type | O tipo de dados do campo. |
| vector |
O formato de codificação para interpretar o conteúdo do campo. |
| vector |
A dimensionalidade do campo de vetor. |
| vector |
O nome do perfil de pesquisa de vetor que especifica o algoritmo e o vetor a ser usado ao pesquisar o campo de vetor. |
Detalhes da 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 em conjunto com searchAnalyzer ou indexAnalyzer. Depois que o analisador for escolhido, ele não poderá ser alterado para o campo.
analyzerName?: string
Valor da propriedade
string
facetable
Um valor que indica se o campo deve ser referenciado em consultas de faceta. Normalmente usado em uma apresentação de resultados de pesquisa que inclui contagem de ocorrências por categoria (por exemplo, pesquise câmeras digitais e veja ocorrências por marca, por megapixels, por preço e assim por diante). Campos do tipo Edm.GeographyPoint ou Collection(Edm.GeographyPoint) não podem ser facetas. O padrão é false.
facetable?: boolean
Valor da propriedade
boolean
filterable
Um valor que indica se o campo deve ser referenciado em consultas $filter. filterable difere do pesquisável em como as cadeias de caracteres são tratadas. Os campos do tipo Edm.String ou Collection(Edm.String) que são filtrados não passam por quebra de palavras, portanto, as comparações são apenas para correspondências exatas. Por exemplo, se você definir esse campo f como "dia ensolarado", $filter=f eq 'sunny' não encontrará correspondências, mas $filter=f eq 'sunny day' irá. O padrão é false.
filterable?: boolean
Valor da propriedade
boolean
hidden
Um valor que indica se o campo pode ser retornado em um resultado de pesquisa. Você poderá desabilitar essa opção se quiser usar um campo (por exemplo, margem) como um filtro, classificação ou mecanismo de pontuação, mas não quiser que o campo fique visível para o usuário final. Essa propriedade deve ser falsa para campos de chave. Essa propriedade pode ser alterada em campos existentes. Habilitar essa propriedade não causa nenhum aumento nos requisitos de armazenamento de índice. O padrão é verdadeiro para campos de vetor, caso contrário, false.
hidden?: boolean
Valor da propriedade
boolean
indexAnalyzerName
O nome do analisador usado no momento da indexação do campo. Essa 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 analisador. Essa propriedade não pode ser definida como o nome de um analisador de idiomas; use a propriedade do analisador se precisar de um analisador de idiomas. Depois que o analisador for escolhido, ele não poderá ser alterado para o campo.
indexAnalyzerName?: string
Valor da 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 de 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 da propriedade
boolean
name
O nome do campo, que deve ser exclusivo na coleção de campos do índice ou do campo pai.
name: string
Valor da propriedade
string
normalizerName
O nome do normalizador a ser usado para o campo. Essa opção pode ser usada somente com campos com filtrável, classificável ou facetável ativado. Uma vez escolhido o normalizador, ele não pode ser alterado para o campo. Deve ser nulo para campos complexos.
normalizerName?: string
Valor da propriedade
string
searchable
Um valor que indica se o campo é pesquisável por 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. Campos do tipo Edm.String ou Collection(Edm.String) são pesquisáveis por padrão. Essa propriedade deve ser falsa para campos simples de outros tipos de dados que não são de cadeia de caracteres. Observação: os campos pesquisáveis consomem espaço extra em seu índice para acomodar versões tokenizadas adicionais do valor do campo para pesquisas de texto completo. Se você quiser economizar espaço em seu índice e não precisar que um campo seja incluído nas pesquisas, defina pesquisável como false. O padrão é false.
searchable?: boolean
Valor da propriedade
boolean
searchAnalyzerName
O nome do analisador usado no tempo de pesquisa do campo. Essa opção só pode ser usada com campos pesquisáveis. Ele deve ser definido junto com indexAnalyzerName e não pode ser definido junto com a opção analyzerName. Essa propriedade não pode ser definida como o nome de um analisador de idiomas; use a propriedade analyzerName se precisar de um analisador de idioma. Esse analisador pode ser atualizado em um campo existente.
searchAnalyzerName?: string
Valor da 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 desejarão classificar por campos nos documentos. Um campo simples só poderá ser classificado se for de valor único (ele tem um único valor no escopo do documento pai). Campos de coleção simples não podem ser classificados, pois são de vários valores. Sub-campos simples de coleções complexas também são de vários valores e, portanto, não podem ser classificados. Isso é verdade se é um campo pai imediato, ou um campo ancestral, que é a coleção complexa. O padrão é false.
sortable?: boolean
Valor da propriedade
boolean
stored
Um valor imutável que indica se o campo será mantido separadamente no disco a ser retornado em um resultado de pesquisa. Você poderá desabilitar 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 de vetor. Essa 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' deverá ser definida como 'true'. Essa propriedade deve ser verdadeira ou não definida para campos-chave, para novos campos e para campos não vetoriais. Desabilitar essa propriedade reduzirá os requisitos de armazenamento de índice. O padrão é verdadeiro para campos de vetor.
stored?: boolean
Valor da propriedade
boolean
synonymMapNames
Uma lista dos nomes dos mapas de sinônimos a serem associados a esse campo. Essa opção só pode ser usada com campos pesquisáveis. Atualmente, há suporte para apenas um mapa de sinônimos por campo. Atribuir um mapa de sinônimos a um campo garante que os termos de consulta direcionados a esse campo sejam expandidos em tempo de consulta usando as regras no mapa de sinônimos. Esse atributo pode ser alterado em campos existentes.
synonymMapNames?: string[]
Valor da propriedade
string[]
type
vectorEncodingFormat
O formato de codificação para interpretar o conteúdo do campo.
vectorEncodingFormat?: string
Valor da propriedade
string
vectorSearchDimensions
A dimensionalidade do campo de vetor.
vectorSearchDimensions?: number
Valor da propriedade
number
vectorSearchProfileName
O nome do perfil de pesquisa de vetor que especifica o algoritmo e o vetor a ser usado ao pesquisar o campo de vetor.
vectorSearchProfileName?: string
Valor da propriedade
string