Schema

string

O nome do objeto, que define o tipo dele. As solicitações de indexação de itens precisam definir o campo objectType como igual a esse valor. Por exemplo, se name for Document, as solicitações de indexação para itens do tipo Document precisarão definir objectType como Document. Cada definição de objeto precisa ter um nome exclusivo em um esquema. O nome precisa começar com uma letra e só pode conter letras (A-Z, a-z) ou números (0-9). O tamanho máximo é de 256 caracteres.

object (ObjectOptions)

As opções opcionais específicas do objeto.

object (PropertyDefinition)

As definições de propriedade do objeto. O número máximo de elementos é 1.000.

object (ObjectOptions.FreshnessOptions)

As opções de atualização de um objeto.

object (ObjectDisplayOptions)

As opções que determinam como o objeto é exibido na página de resultados do Cloud Search.

string

Operadores que podem ser usados para filtrar sugestões. Para a API query.suggest, apenas os operadores mencionados aqui serão aceitos no FilterOptions. Somente os operadores TEXT e ENUM são compatíveis.

OBSERVAÇÃO: "objecttype", "type" e "mimetype" já têm suporte. Essa propriedade é usada para configurar operadores específicos do esquema.

Mesmo que seja uma matriz, apenas um operador pode ser especificado. Esta é uma matriz para extensibilidade futura.

Não é possível mapear operadores para várias propriedades no mesmo objeto. Se o operador abranger diferentes tipos de objetos, essa opção precisará ser definida uma vez para cada definição de objeto.

string

Essa propriedade indica o nível de atualidade do objeto no índice. Se definida, essa propriedade precisa ser uma propriedade de nível superior no property definitions e precisa ser timestamp type ou date type. Caso contrário, a API Indexing usa updateTime como o indicador de atualidade. O tamanho máximo é de 256 caracteres.

Quando uma propriedade é usada para calcular a atualização, o valor padrão é de dois anos a partir do momento atual.

string (Duration format)

A duração após a qual um objeto será considerado desatualizado. O valor padrão é de 180 dias (em segundos).

Duração em segundos com até nove dígitos fracionários, terminando em "s". Exemplo: "3.5s".

string

O rótulo amigável ao usuário que será exibido no resultado da pesquisa para indicar o tipo do item. Isso é OPCIONAL. Se não for fornecido, um rótulo de objeto não será exibido na linha de contexto dos resultados da pesquisa. O comprimento máximo é de 64 caracteres.

object (ObjectDisplayOptions.Metaline)

Define as propriedades que aparecem nas metalinhas dos resultados da pesquisa. Os valores da propriedade são mostrados na ordem indicada aqui. Se uma propriedade tiver vários valores, todos eles serão mostrados antes das próximas propriedades. Por esse motivo, é recomendável especificar propriedades singulares antes das propriedades repetidas nesta lista. Todas as propriedades precisam definir isReturnable como verdadeiro. O número máximo de metalinhas é 3.

object (ObjectDisplayOptions.DisplayedProperty)

A lista de propriedades exibidas para a metalinha. O número máximo de propriedades é 5.

string

O nome da propriedade de nível superior, conforme definido em uma definição de propriedade do objeto. Se o nome não for uma propriedade definida no esquema, um erro será exibido ao tentar atualizar o esquema.

string

O nome da propriedade. As solicitações de indexação de itens enviadas para a API Indexing precisam definir property name como igual a esse valor. Por exemplo, se o nome for assunto, as solicitações de indexação para itens de documento com campos de assunto precisarão definir o name desse campo como assunto. Use o nome como identificador da propriedade do objeto. Depois de registrado como uma propriedade de um objeto, não é possível reutilizar esse nome para outra propriedade nesse objeto. O nome precisa começar com uma letra e só pode conter letras (A-Z, a-z) ou números (0-9). O tamanho máximo é de 256 caracteres.

boolean

Indica que a propriedade identifica os dados a serem retornados nos resultados da pesquisa pela API Query. Se definido como true, indica que os usuários da API Query podem usar campos de propriedade correspondentes nos resultados. No entanto, o armazenamento de campos exige mais alocação de espaço e usa mais largura de banda para consultas de pesquisa, o que afeta a performance em grandes conjuntos de dados. Defina como true somente se o campo for necessário para os resultados da pesquisa. Não pode ser verdadeiro para propriedades com o tipo de objeto.

boolean

Indica que vários valores são permitidos para a propriedade. Por exemplo, um documento tem apenas uma descrição, mas pode ter vários comentários. Não pode ser verdadeiro para propriedades com tipo booleano. Se definido como "false", as propriedades que contêm mais de um valor fazem com que a solicitação de indexação desse item seja rejeitada.

boolean

Indica que a propriedade pode ser usada para classificação. Não pode ser verdadeiro para propriedades que são repetíveis. Não pode ser verdadeiro para propriedades com o tipo "objeto". IsReturnable precisa ser verdadeiro para definir essa opção. Somente compatível com propriedades booleanas, de data, double, integer e carimbo de data/hora.

boolean

Indica que a propriedade pode ser usada para gerar atributos. Não pode ser verdadeiro para propriedades com o tipo "objeto". IsReturnable precisa ser verdadeiro para definir essa opção. Somente compatível com propriedades booleanas, de enumeração, inteiras e de texto.

boolean

Indica que a propriedade pode ser usada para gerar sugestões de consulta.

boolean

Indica que os usuários podem fazer pesquisas com curinga para essa propriedade. Suporte apenas para propriedades de texto. IsReturnable precisa ser verdadeiro para definir essa opção. Em uma determinada fonte de dados, no máximo cinco propriedades podem ser marcadas como "isWildcardSearchable". Para mais detalhes, consulte Definir propriedades de objetos.

object (PropertyDisplayOptions)

As opções que determinam como a propriedade é exibida na página de resultados da Pesquisa do Cloud se ela for especificada para aparecer no display options do objeto.

object (IntegerPropertyOptions)

object (DoublePropertyOptions)

object (TimestampPropertyOptions)

object (BooleanPropertyOptions)

object (ObjectPropertyOptions)

object (EnumPropertyOptions)

object (DatePropertyOptions)

object (TextPropertyOptions)

object (HtmlPropertyOptions)

enum (IntegerPropertyOptions.OrderedRanking)

Usado para especificar a classificação ordenada do número inteiro. Só poderá ser usado se isRepeatable for falso.

string (Int64Value format)

O valor mínimo da propriedade. Os valores mínimo e máximo da propriedade são usados para classificar os resultados de acordo com o ordered ranking. As solicitações de indexação com valores menores que o mínimo são aceitas e classificadas com o mesmo peso dos itens indexados com o valor mínimo.

string (Int64Value format)

O valor máximo da propriedade. Os valores mínimo e máximo da propriedade são usados para classificar os resultados de acordo com o ordered ranking. As solicitações de indexação com valores maiores que o máximo são aceitas e classificadas com o mesmo peso dos itens indexados com o valor máximo.

object (IntegerPropertyOptions.IntegerOperatorOptions)

Se definido, descreve como o inteiro deve ser usado como um operador de pesquisa.

object (IntegerFacetingOptions)

Se definido, descreve as opções de facetação de números inteiros para a propriedade de número inteiro especificada. A propriedade de número inteiro correspondente precisa ser marcada como isFacetable.

string

Indica o nome do operador necessário na consulta para isolar a propriedade de número inteiro. Por exemplo, se operatorName for priority e o nome da propriedade for priorityVal, consultas como priority:<value> vão mostrar resultados apenas quando o valor da propriedade priorityVal corresponder a <value>. Por outro lado, uma pesquisa que usa o mesmo <value> sem um operador retorna todos os itens em que <value> corresponde ao valor de qualquer propriedade String ou texto no campo de conteúdo do item. O nome do operador só pode conter letras minúsculas (a-z). O tamanho máximo é de 32 caracteres.

string

Indica o nome do operador necessário na consulta para isolar a propriedade de número inteiro usando o operador "menor que". Por exemplo, se lessThanOperatorName for prioritybelow e o nome da propriedade for priorityVal, consultas como prioritybelow:<value> vão mostrar resultados apenas quando o valor da propriedade priorityVal for menor que <value>. O nome do operador só pode conter letras minúsculas (a-z). O tamanho máximo é de 32 caracteres.

string

Indica o nome do operador necessário na consulta para isolar a propriedade de número inteiro usando o operador "maior que". Por exemplo, se greaterThanOperatorName for priorityabove e o nome da propriedade for priorityVal, consultas como priorityabove:<value> vão mostrar resultados apenas quando o valor da propriedade priorityVal for maior que <value>. O nome do operador só pode conter letras minúsculas (a-z). O tamanho máximo é de 32 caracteres.

object (DoublePropertyOptions.DoubleOperatorOptions)

Se definido, descreve como o número duplo deve ser usado como um operador de pesquisa.

string

Indica o nome do operador necessário na consulta para usar a propriedade dupla na ordenação ou como uma faceta. O nome do operador só pode conter letras minúsculas (a-z). O tamanho máximo é de 32 caracteres.

object (TimestampPropertyOptions.TimestampOperatorOptions)

Se definido, descreve como o carimbo de data/hora deve ser usado como um operador de pesquisa.

string

Indica o nome do operador necessário na consulta para isolar a propriedade de carimbo de data/hora. Por exemplo, se operatorName for closedon e o nome da propriedade for closeDate, consultas como closedon:<value> vão mostrar resultados apenas quando o valor da propriedade closeDate corresponder a <value>. Por outro lado, uma pesquisa que usa o mesmo <value> sem um operador retorna todos os itens em que <value> corresponde ao valor de qualquer propriedade String ou texto no campo de conteúdo do item. O nome do operador só pode conter letras minúsculas (a-z). O tamanho máximo é de 32 caracteres.

string

Indica o nome do operador necessário na consulta para isolar a propriedade de carimbo de data/hora usando o operador "menor que". Por exemplo, se lessThanOperatorName for closedbefore e o nome da propriedade for closeDate, consultas como closedbefore:<value> vão mostrar resultados apenas quando o valor da propriedade closeDate for anterior a <value>. O nome do operador só pode conter letras minúsculas (a-z). O tamanho máximo é de 32 caracteres.

string

Indica o nome do operador necessário na consulta para isolar a propriedade de carimbo de data/hora usando o operador "maior que". Por exemplo, se greaterThanOperatorName for closedafter e o nome da propriedade for closeDate, consultas como closedafter:<value> vão mostrar resultados apenas quando o valor da propriedade closeDate for posterior a <value>. O nome do operador só pode conter letras minúsculas (a-z). O tamanho máximo é de 32 caracteres.

object (BooleanPropertyOptions.BooleanOperatorOptions)

Se definido, descreve como o booleano deve ser usado como um operador de pesquisa.

string

Indica o nome do operador necessário na consulta para isolar a propriedade booleana. Por exemplo, se operatorName for closed e o nome da propriedade for isClosed, consultas como closed:<value> vão mostrar resultados apenas quando o valor da propriedade isClosed corresponder a <value>. Por outro lado, uma pesquisa que usa o mesmo <value> sem um operador retorna todos os itens em que <value> corresponde ao valor de qualquer propriedade String ou texto no campo de conteúdo do item. O nome do operador só pode conter letras minúsculas (a-z). O tamanho máximo é de 32 caracteres.

object (PropertyDefinition)

As propriedades do subobjeto. Essas propriedades representam um objeto aninhado. Por exemplo, se essa propriedade representar um endereço postal, as subobjectProperties podem ser nomeadas como street, city e state. O número máximo de elementos é 1.000.

object (EnumPropertyOptions.EnumValuePair)

A lista de valores possíveis para a propriedade de enumeração. Todos os EnumValuePairs precisam fornecer um valor de string. Se você especificar um valor inteiro para um EnumValuePair, todos os EnumValuePairs possíveis precisarão fornecer um valor inteiro. O valor de string e o valor inteiro precisam ser exclusivos em todos os valores possíveis. Depois de definidos, os valores possíveis não podem ser removidos nem modificados. Se você fornecer uma classificação ordenada e achar que pode inserir outros valores de tipo enumerado no futuro, deixe lacunas nos valores inteiros iniciais para permitir a adição de um valor entre os valores registrados anteriormente. O número máximo de elementos é 100.

enum (EnumPropertyOptions.OrderedRanking)

É usado para especificar a classificação ordenada da enumeração que determina como os valores inteiros fornecidos nos possíveis EnumValuePairs são usados para classificar os resultados. Se especificado, os valores inteiros precisam ser fornecidos para todos os valores possíveis de EnumValuePair fornecidos para essa propriedade. Só poderá ser usado se isRepeatable for falso.

object (EnumPropertyOptions.EnumOperatorOptions)

Se definido, descreve como o tipo enumerado deve ser usado como um operador de pesquisa.

string

O valor de string do EnumValuePair. O tamanho máximo é de 32 caracteres.

integer

O valor inteiro de EnumValuePair, que precisa ser não negativo. Opcional.

string

Indica o nome do operador necessário na consulta para isolar a propriedade de tipo enumerado. Por exemplo, se operatorName for priority e o nome da propriedade for priorityVal, consultas como priority:<value> vão mostrar resultados apenas quando o valor da propriedade priorityVal corresponder a <value>. Por outro lado, uma pesquisa que usa o mesmo <value> sem um operador retorna todos os itens em que <value> corresponde ao valor de qualquer propriedade String ou texto no campo de conteúdo do item. O nome do operador só pode conter letras minúsculas (a-z). O tamanho máximo é de 32 caracteres.

object (DatePropertyOptions.DateOperatorOptions)

Se definido, descreve como a data deve ser usada como um operador de pesquisa.

string

Indica a string real necessária na consulta para isolar a propriedade de data. Por exemplo, suponha que um objeto de esquema de rastreamento de problemas tenha uma propriedade chamada closeDate que especifica um operador com um operadorName de closedon. Para pesquisas nesses dados, consultas como closedon:<value> mostram resultados apenas quando o valor da propriedade closeDate corresponde a <value>. Por outro lado, uma pesquisa que usa o mesmo <value> sem um operador retorna todos os itens em que <value> corresponde ao valor de qualquer propriedade String ou texto no campo de conteúdo da fonte de dados indexada. O nome do operador só pode conter letras minúsculas (a-z). O tamanho máximo é de 32 caracteres.

string

Indica o nome do operador necessário na consulta para isolar a propriedade de data usando o operador "menor que". Por exemplo, se lessThanOperatorName for closedbefore e o nome da propriedade for closeDate, consultas como closedbefore:<value> vão mostrar resultados apenas quando o valor da propriedade closeDate for anterior a <value>. O nome do operador só pode conter letras minúsculas (a-z). O tamanho máximo é de 32 caracteres.

string

Indica o nome do operador necessário na consulta para isolar a propriedade de data usando o operador "maior que". Por exemplo, se greaterThanOperatorName for closedafter e o nome da propriedade for closeDate, consultas como closedafter:<value> vão mostrar resultados apenas quando o valor da propriedade closeDate for posterior a <value>. O nome do operador só pode conter letras minúsculas (a-z). O tamanho máximo é de 32 caracteres.

object (RetrievalImportance)

Indica a importância da qualidade de pesquisa dos tokens no campo quando usados para recuperação.

object (TextPropertyOptions.TextOperatorOptions)

Se definido, descreve como a propriedade deve ser usada como um operador de pesquisa.

enum (RetrievalImportance.Importance)

Indica a importância da classificação atribuída à propriedade quando ela é correspondida durante a recuperação. Depois de definida, a importância do token de uma propriedade não pode ser alterada.

string

Indica o nome do operador necessário na consulta para isolar a propriedade de texto. Por exemplo, se operatorName for subject e o nome da propriedade for subjectLine, consultas como subject:<value> vão mostrar resultados apenas quando o valor da propriedade subjectLine corresponder a <value>. Por outro lado, uma pesquisa que usa o mesmo <value> sem um operador retorna todos os itens em que <value> corresponde ao valor de qualquer propriedade de texto ou texto no campo de conteúdo do item. O nome do operador só pode conter letras minúsculas (a-z). O tamanho máximo é de 32 caracteres.

boolean

Se verdadeiro, o valor de texto é tokenizado como um valor atômico nas pesquisas de operador e nas correspondências com atributos. Por exemplo, se o nome do operador for "genre" e o valor for "science-fiction", as restrições de consulta "genre:science" e "genre:fiction" não corresponderão ao item, mas "genre:science-fiction" vai. A correspondência de valores de texto diferencia maiúsculas de minúsculas e não remove caracteres especiais. Se for falso, o texto será tokenizado. Por exemplo, se o valor for "ficção científica", as consultas "genre:science" e "genre:fiction" vão corresponder ao item.

object (RetrievalImportance)

Indica a importância da qualidade de pesquisa dos tokens no campo quando usados para recuperação. Só pode ser definido como DEFAULT ou NONE.

object (HtmlPropertyOptions.HtmlOperatorOptions)

Se definido, descreve como a propriedade deve ser usada como um operador de pesquisa.

string

Indica o nome do operador necessário na consulta para isolar a propriedade html. Por exemplo, se operatorName for subject e o nome da propriedade for subjectLine, consultas como subject:<value> vão mostrar resultados apenas quando o valor da propriedade subjectLine corresponder a <value>. Por outro lado, uma pesquisa que usa o mesmo <value> sem um operador retorna todos os itens em que <value> corresponde ao valor de qualquer propriedade html ou texto no campo de conteúdo do item. O nome do operador só pode conter letras minúsculas (a-z). O tamanho máximo é de 32 caracteres.

string

O rótulo amigável para o usuário da propriedade que será usado se ela for especificada para aparecer em ObjectDisplayOptions. Se fornecido, o rótulo de exibição é mostrado na frente dos valores da propriedade quando ela faz parte das opções de exibição do objeto. Por exemplo, se o valor da propriedade for "1", ele sozinho não será um contexto útil para o usuário. Se o nome de exibição fornecido for "prioridade", o usuário vai ver "prioridade : 1" nos resultados da pesquisa, o que fornece um contexto claro para os usuários. Isso é OPCIONAL. Se não for fornecido, apenas os valores da propriedade serão exibidos. O comprimento máximo é de 64 caracteres.