Field Classe

Definição

Namespace:

Microsoft.Azure.Search.Models

Assembly:

Microsoft.Azure.Search.Service.dll

Pacote:

Microsoft.Azure.Search.Service v10.1.0

Origem:

Field.cs

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. https://docs.microsoft.com/rest/api/searchservice/Create-Index

public class Field

type Field = class

Public Class Field

Herança

Object

Field

Construtores

Field(String, AnalyzerName)	Inicializa um novo campo de cadeia de caracteres pesquisável com argumentos necessários.
Field(String, DataType)	Inicializa um novo Campo simples com argumentos necessários.
Field(String, DataType, AnalyzerName)	Inicializa um novo Campo simples pesquisável com argumentos necessários.
Field(String, DataType, IList<Field>)	Inicializa um novo Campo complexo com argumentos necessários.

Propriedades

Analyzer	Obtém ou define o nome do analisador de idioma a ser usado para o campo. Essa opção pode ser usada somente com campos pesquisáveis e não pode ser definida com searchAnalyzer ou indexAnalyzer. Depois que o analisador for escolhido, ele não poderá ser alterado para o campo. Deve ser nulo para campos complexos. Os valores possíveis incluem: 'ar.microsoft', 'ar.lucene', 'hy.lucene', 'bn.microsoft', 'eu.lucene', 'bg.microsoft', 'bg.lucene', 'ca.microsoft', 'ca.lucene', 'zh-Hans.microsoft', 'zh-Hans.lucene', 'zh-Hant.microsoft', 'zh-Hant.lucene', 'hr.microsoft', 'cs.microsoft', 'cs.lucene', 'da.microsoft', 'da.lucene', 'nl.microsoft', 'nl.lucene', 'en.microsoft', 'en.lucene', 'et.microsoft', 'fi.microsoft', 'fi.lucene', 'fr.microsoft', 'fr.lucene', 'gl.lucene', 'de.microsoft', 'de.lucene', ' el.microsoft', 'el.lucene', 'gu.microsoft', 'he.microsoft', 'hi.microsoft', 'hi.lucene', 'hu.microsoft', 'hu.lucene', 'is.microsoft', 'id.microsoft', 'id.lucene', 'ga.lucene', 'it.microsoft', 'it.lucene', 'ja.microsoft', 'ja.lucene', 'kn.microsoft', 'kn.microsoft', 'ko.microsoft', 'ko.lucene', 'lv.microsoft', 'lv.lucene', 'lt.microsoft', 'ml.microsoft', 'ms.microsoft', 'mr.microsoft', 'nb.microsoft', 'no.lucene', 'fa.lucene', 'pl.microsoft', 'pl.lucene', 'pt-BR.microsoft', 'pt-BR.lucene', ' pt-PT.microsoft', 'pt-PT.lucene', 'pa.microsoft', 'ro.microsoft', 'ro.lucene', 'ru.microsoft', 'ru.lucene', 'sr-cyrillic.microsoft', 'sr-latin.microsoft', 'sk.microsoft', 'sl.microsoft', 'es.microsoft', 'es.lucene', 'sv.microsoft', 'sv.lucene', 'ta.microsoft', 'te.microsoft', 'th.microsoft', 'th.lucene', 'tr.microsoft', 'tr.lucene', 'uk.microsoft', 'your.microsoft', 'vi.microsoft', 'standard.lucene', 'standardasciifolding.lucene', 'palavra-chave ', 'pattern', 'simple', 'stop', 'whitespace'
Fields	Obtém ou define uma lista de subcampos se este for um campo do tipo Edm.ComplexType ou Collection(Edm.ComplexType). Deve ser nulo ou vazio para campos simples.
IndexAnalyzer	Obtém ou define 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 do analisador. Depois que o analisador for escolhido, ele não poderá ser alterado para o campo. Deve ser nulo para campos complexos. Os valores possíveis incluem: 'ar.microsoft', 'ar.lucene', 'hy.lucene', 'bn.microsoft', 'eu.lucene', 'bg.microsoft', 'bg.lucene', 'ca.microsoft', 'ca.lucene', 'zh-Hans.microsoft', 'zh-Hans.lucene', 'zh-Hant.microsoft', 'zh-Hant.lucene', 'hr.microsoft', 'cs.microsoft', 'cs.lucene', 'da.microsoft', 'da.lucene', 'nl.microsoft', 'nl.lucene', 'en.microsoft', 'en.lucene', 'et.microsoft', 'fi.microsoft', 'fi.lucene', 'fr.microsoft', 'fr.lucene', 'gl.lucene', 'de.microsoft', 'de.lucene', ' el.microsoft', 'el.lucene', 'gu.microsoft', 'he.microsoft', 'hi.microsoft', 'hi.lucene', 'hu.microsoft', 'hu.lucene', 'is.microsoft', 'id.microsoft', 'id.lucene', 'ga.lucene', 'it.microsoft', 'it.lucene', 'ja.microsoft', 'ja.lucene', 'kn.microsoft', 'kn.microsoft', 'ko.microsoft', 'ko.lucene', 'lv.microsoft', 'lv.lucene', 'lt.microsoft', 'ml.microsoft', 'ms.microsoft', 'mr.microsoft', 'nb.microsoft', 'no.lucene', 'fa.lucene', 'pl.microsoft', 'pl.lucene', 'pt-BR.microsoft', 'pt-BR.lucene', ' pt-PT.microsoft', 'pt-PT.lucene', 'pa.microsoft', 'ro.microsoft', 'ro.lucene', 'ru.microsoft', 'ru.lucene', 'sr-cyrillic.microsoft', 'sr-latin.microsoft', 'sk.microsoft', 'sl.microsoft', 'es.microsoft', 'es.lucene', 'sv.microsoft', 'sv.lucene', 'ta.microsoft', 'te.microsoft', 'th.microsoft', 'th.lucene', 'tr.microsoft', 'tr.lucene', 'uk.microsoft', 'your.microsoft', 'vi.microsoft', 'standard.lucene', 'standardasciifolding.lucene', 'palavra-chave ', 'pattern', 'simple', 'stop', 'whitespace'
IsFacetable	Obtém ou define 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). Essa propriedade deve ser nula para campos complexos. Os campos do tipo Edm.GeographyPoint ou Collection(Edm.GeographyPoint) não podem ser facetáveis. Todos os outros campos simples podem ser facetáveis. O padrão é false para campos simples e nulo para campos complexos.
IsFilterable	Obtém ou define 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 filtráveis 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' vai. Essa propriedade deve ser nula para campos complexos. O padrão é false para campos simples e nulo para campos complexos.
IsKey	Obtém ou define 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 de chave podem ser usados para pesquisar documentos diretamente e atualizar ou excluir documentos específicos. O padrão é false para campos simples e nulo para campos complexos.
IsRetrievable	Obtém ou define 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 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 verdadeira para campos de chave e deve ser nula para campos complexos. 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 é true para campos simples e nulos para campos complexos.
IsSearchable	Obtém ou define um valor que indica se o campo é pesquisável por texto completo. Isso significa que ele será submetido a análise, como separação de palavras, durante a indexação. Se você definir um campo pesquisável com um valor como “dia ensolarado”, internamente, ele será dividido nos tokens individuais “dia” e “ensolarado”. Isso habilita pesquisas de texto completo para esses termos. Essa propriedade pode ser definida como true somente para campos do tipo Edm.String ou Collection(Edm.String) e deve ser nula para campos complexos. O padrão é false para campos simples e nulo para campos complexos. Observação: os campos pesquisáveis consomem espaço extra em seu índice, pois Azure Cognitive Search armazenará uma versão com token adicional 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.
IsSortable	Obtém ou define um valor que indica se o campo deve ser referenciado em expressões $orderby. Por padrão, Azure Cognitive Search 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. Subcampos simples de coleções complexas também têm vários valores e, portanto, não podem ser classificados. Isso é verdade, seja um campo pai imediato ou um campo ancestral, que é a coleção complexa. Campos complexos não podem ser classificáveis e a propriedade classificável deve ser nula para esses campos. O padrão para classificável é false para campos simples e nulo para campos complexos.
Name	Obtém ou define o nome do campo , que deve ser exclusivo dentro da coleção de campos do índice ou campo pai.
SearchAnalyzer	Obtém ou define o nome do analisador usado no momento da pesquisa para o campo. Essa opção só pode ser usada com campos pesquisáveis. Ele deve ser definido junto com indexAnalyzer e não pode ser definido junto com a opção do analisador. Esse analisador pode ser atualizado em um campo existente. Deve ser nulo para campos complexos. Os valores possíveis incluem: 'ar.microsoft', 'ar.lucene', 'hy.lucene', 'bn.microsoft', 'eu.lucene', 'bg.microsoft', 'bg.lucene', 'ca.microsoft', 'ca.lucene', 'zh-Hans.microsoft', 'zh-Hans.lucene', 'zh-Hant.microsoft', 'zh-Hant.lucene', 'hr.microsoft', 'cs.microsoft', 'cs.lucene', 'da.microsoft', 'da.lucene', 'nl.microsoft', 'nl.lucene', 'en.microsoft', 'en.lucene', 'et.microsoft', 'fi.microsoft', 'fi.lucene', 'fr.microsoft', 'fr.lucene', 'gl.lucene', 'de.microsoft', 'de.lucene', ' el.microsoft', 'el.lucene', 'gu.microsoft', 'he.microsoft', 'hi.microsoft', 'hi.lucene', 'hu.microsoft', 'hu.lucene', 'is.microsoft', 'id.microsoft', 'id.lucene', 'ga.lucene', 'it.microsoft', 'it.lucene', 'ja.microsoft', 'ja.lucene', 'kn.microsoft', 'kn.microsoft', 'ko.microsoft', 'ko.lucene', 'lv.microsoft', 'lv.lucene', 'lt.microsoft', 'ml.microsoft', 'ms.microsoft', 'mr.microsoft', 'nb.microsoft', 'no.lucene', 'fa.lucene', 'pl.microsoft', 'pl.lucene', 'pt-BR.microsoft', 'pt-BR.lucene', ' pt-PT.microsoft', 'pt-PT.lucene', 'pa.microsoft', 'ro.microsoft', 'ro.lucene', 'ru.microsoft', 'ru.lucene', 'sr-cyrillic.microsoft', 'sr-latin.microsoft', 'sk.microsoft', 'sl.microsoft', 'es.microsoft', 'es.lucene', 'sv.microsoft', 'sv.lucene', 'ta.microsoft', 'te.microsoft', 'th.microsoft', 'th.lucene', 'tr.microsoft', 'tr.lucene', 'uk.microsoft', 'your.microsoft', 'vi.microsoft', 'standard.lucene', 'standardasciifolding.lucene', 'palavra-chave ', 'pattern', 'simple', 'stop', 'whitespace'
SynonymMaps	Obtém ou define 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. Deve ser nulo ou uma coleção vazia para campos complexos.
Type	Obtém ou define 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', 'Edm.ComplexType'

Métodos

New(String, DataType, Boolean, Boolean, Boolean, Boolean, Boolean, Boolean, Nullable<AnalyzerName>, Nullable<AnalyzerName>, Nullable<AnalyzerName>, IList<String>)	Cria um campo simples com argumentos necessários.
NewComplex(String, Boolean, IList<Field>)	Cria um campo complexo com argumentos necessários.
NewSearchableCollection(String, AnalyzerName, Boolean, Boolean, Boolean, Boolean, IList<String>)	Cria uma nova coleção de cadeias de caracteres pesquisável Field com os argumentos necessários.
NewSearchableString(String, AnalyzerName, Boolean, Boolean, Boolean, Boolean, Boolean, IList<String>)	Cria um campo de cadeia de caracteres pesquisável com argumentos necessários.
Validate()	Valide o objeto .