Schema

string

Es el nombre del objeto, que luego define su tipo. Las solicitudes de indexación de artículos deben establecer el campo objectType igual a este valor. Por ejemplo, si name es Document, las solicitudes de indexación de elementos de tipo Document deben establecer objectType igual a Document. Cada definición de objeto debe tener un nombre único dentro de un esquema. El nombre debe comenzar con una letra y solo puede contener letras (A-Z, a-z) o números (0-9). La longitud máxima es de 256 caracteres.

object (ObjectOptions)

Las opciones opcionales específicas del objeto.

object (PropertyDefinition)

Las definiciones de propiedades del objeto. La cantidad máxima de elementos es 1,000.

object (ObjectOptions.FreshnessOptions)

Son las opciones de actualización de un objeto.

object (ObjectDisplayOptions)

Son las opciones que determinan cómo se muestra el objeto en la página de resultados de Cloud Search.

string

Operadores que se pueden usar para filtrar sugerencias. En el caso de la API de query.suggest, solo se respetarán los operadores mencionados aquí en FilterOptions. Solo se admiten los operadores TEXT y ENUM.

NOTA: Ya se admiten "objecttype", "type" y "mimetype". Esta propiedad se usa para configurar operadores específicos del esquema.

Aunque se trata de un array, solo se puede especificar un operador. Este es un array para la extensibilidad futura.

No se admiten operadores que se asignan a varias propiedades dentro del mismo objeto. Si el operador abarca diferentes tipos de objetos, esta opción se debe establecer una vez para cada definición de objeto.

string

Esta propiedad indica el nivel de actualización del objeto en el índice. Si se establece, esta propiedad debe ser de nivel superior dentro de property definitions y debe ser timestamp type o date type. De lo contrario, la API de Indexing usa updateTime como indicador de actualización. La longitud máxima es de 256 caracteres.

Cuando se usa una propiedad para calcular la actualización, el valor predeterminado es de 2 años a partir de la hora actual.

string (Duration format)

Es la duración después de la cual se debe considerar inactivo un objeto. El valor predeterminado es de 180 días (en segundos).

Una duración en segundos con hasta nueve dígitos decimales, que terminan en “s”. Ejemplo: "3.5s".

string

Es la etiqueta fácil de usar que se muestra en el resultado de la búsqueda para indicar el tipo de elemento. Este campo es OPCIONAL. Si no se proporciona, no se mostrará una etiqueta de objeto en la línea de contexto de los resultados de la búsqueda. La longitud máxima es de 64 caracteres.

object (ObjectDisplayOptions.Metaline)

Define las propiedades que se muestran en las líneas de metadatos de los resultados de la búsqueda. Los valores de la propiedad se muestran en el orden que se indica aquí. Si una propiedad contiene varios valores, todos se muestran antes de las siguientes propiedades. Por este motivo, se recomienda especificar las propiedades singulares antes que las repetidas en esta lista. Todas las propiedades deben establecer isReturnable como verdadero. La cantidad máxima de metalíneas es 3.

object (ObjectDisplayOptions.DisplayedProperty)

Es la lista de propiedades que se muestran para la metalínea. La cantidad máxima de propiedades es 5.

string

Es el nombre de la propiedad de nivel superior, tal como se define en una definición de propiedad para el objeto. Si el nombre no es una propiedad definida en el esquema, se muestra un error cuando se intenta actualizar el esquema.

string

Es el nombre de la propiedad. Las solicitudes de indexación de artículos que se envían a la API de Indexing deben establecer property name igual a este valor. Por ejemplo, si el nombre es subject_line, las solicitudes de indexación de elementos de documentos con campos de asunto deben establecer el name de ese campo igual a subject_line. Usa el nombre como identificador de la propiedad del objeto. Una vez que se registra como una propiedad de un objeto, no puedes volver a usar este nombre para otra propiedad dentro de ese objeto. El nombre debe comenzar con una letra y solo puede contener letras (A-Z, a-z) o números (0-9). La longitud máxima es de 256 caracteres.

boolean

Indica que la propiedad identifica datos que se deben mostrar en los resultados de la búsqueda mediante la API de consulta. Si se establece en true, indica que los usuarios de la API de Query pueden usar campos de propiedades coincidentes en los resultados. Sin embargo, el almacenamiento de campos requiere más asignación de espacio y usa más ancho de banda para las consultas de búsqueda, lo que afecta el rendimiento en conjuntos de datos grandes. Establece este valor como true solo si el campo es necesario para los resultados de la búsqueda. No puede ser verdadero para las propiedades cuyo tipo es un objeto.

boolean

Indica que se permiten varios valores para la propiedad. Por ejemplo, un documento solo tiene una descripción, pero puede tener varios comentarios. No puede ser verdadero para las propiedades cuyo tipo es un valor booleano. Si se establece como "false", las propiedades que contienen más de un valor hacen que se rechace la solicitud de indexación de ese elemento.

boolean

Indica que la propiedad se puede usar para el ordenamiento. Esto no sucede con las propiedades repetibles. No puede ser verdadero para las propiedades cuyo tipo es un objeto. IsReturnable debe ser verdadero para establecer esta opción. Solo se admite para propiedades booleanas, de fecha, dobles, de número entero y de marca de tiempo.

boolean

Indica que la propiedad se puede usar para generar facetas. No puede ser verdadero para las propiedades cuyo tipo es un objeto. IsReturnable debe ser verdadero para establecer esta opción. Solo se admite para propiedades booleanas, de enumeración, de número entero y de texto.

boolean

Indica que la propiedad se puede usar para generar sugerencias de búsqueda.

boolean

Indica que los usuarios pueden realizar una búsqueda con comodines para esta propiedad. Solo se admite para propiedades de texto. IsReturnable debe ser verdadero para establecer esta opción. En un origen de datos determinado, se puede marcar un máximo de 5 propiedades como isWildcardSearchable. Para obtener más información, consulta Cómo definir propiedades de objetos.

object (PropertyDisplayOptions)

Son las opciones que determinan cómo se muestra la propiedad en la página de resultados de la Búsqueda en la nube si se especifica que se debe mostrar en el display options del objeto.

object (IntegerPropertyOptions)

object (DoublePropertyOptions)

object (TimestampPropertyOptions)

object (BooleanPropertyOptions)

object (ObjectPropertyOptions)

object (EnumPropertyOptions)

object (DatePropertyOptions)

object (TextPropertyOptions)

object (HtmlPropertyOptions)

enum (IntegerPropertyOptions.OrderedRanking)

Se usa para especificar la clasificación ordenada del número entero. Solo se puede usar si isRepeatable es falso.

string (Int64Value format)

Es el valor mínimo de la propiedad. Los valores mínimo y máximo de la propiedad se usan para clasificar los resultados según ordered ranking. Se aceptan las solicitudes de indexación con valores inferiores al mínimo y se clasifican con el mismo peso que los elementos indexados con el valor mínimo.

string (Int64Value format)

Es el valor máximo de la propiedad. Los valores mínimo y máximo de la propiedad se usan para clasificar los resultados según ordered ranking. Las solicitudes de indexación con valores superiores al máximo se aceptan y se clasifican con la misma ponderación que los elementos indexados con el valor máximo.

object (IntegerPropertyOptions.IntegerOperatorOptions)

Si se establece, describe cómo se debe usar el número entero como operador de búsqueda.

object (IntegerFacetingOptions)

Si se establece, describe las opciones de facetas de números enteros para la propiedad de número entero determinada. La propiedad de número entero correspondiente debe estar marcada como isFacetable.

string

Indica el nombre del operador requerido en la consulta para aislar la propiedad de número entero. Por ejemplo, si operatorName es priority y el nombre de la propiedad es priorityVal, las consultas como priority:<value> muestran resultados solo cuando el valor de la propiedad llamada priorityVal coincide con <value>. Por el contrario, una búsqueda que usa el mismo <value> sin un operador muestra todos los elementos en los que <value> coincide con el valor de cualquier propiedad de String o texto dentro del campo de contenido del elemento. El nombre del operador solo puede contener letras minúsculas (a-z). La longitud máxima es de 32 caracteres.

string

Indica el nombre del operador requerido en la consulta para aislar la propiedad de número entero con el operador menor que. Por ejemplo, si lessThanOperatorName es prioritybelow y el nombre de la propiedad es priorityVal, las consultas como prioritybelow:<value> muestran resultados solo cuando el valor de la propiedad llamada priorityVal es menor que <value>. El nombre del operador solo puede contener letras minúsculas (a-z). La longitud máxima es de 32 caracteres.

string

Indica el nombre del operador requerido en la consulta para aislar la propiedad de número entero con el operador mayor que. Por ejemplo, si greaterThanOperatorName es priorityabove y el nombre de la propiedad es priorityVal, las consultas como priorityabove:<value> muestran resultados solo cuando el valor de la propiedad llamada priorityVal es mayor que <value>. El nombre del operador solo puede contener letras minúsculas (a-z). La longitud máxima es de 32 caracteres.

object (DoublePropertyOptions.DoubleOperatorOptions)

Si se establece, describe cómo se debe usar el doble como operador de búsqueda.

string

Indica el nombre del operador requerido en la consulta para usar la propiedad doble en la ordenación o como una faceta. El nombre del operador solo puede contener letras minúsculas (a-z). La longitud máxima es de 32 caracteres.

object (TimestampPropertyOptions.TimestampOperatorOptions)

Si se establece, describe cómo se debe usar la marca de tiempo como operador de búsqueda.

string

Indica el nombre del operador requerido en la consulta para aislar la propiedad de marca de tiempo. Por ejemplo, si operatorName es closedon y el nombre de la propiedad es closeDate, las consultas como closedon:<value> muestran resultados solo cuando el valor de la propiedad llamada closeDate coincide con <value>. Por el contrario, una búsqueda que usa el mismo <value> sin un operador muestra todos los elementos en los que <value> coincide con el valor de cualquier propiedad de String o texto dentro del campo de contenido del elemento. El nombre del operador solo puede contener letras minúsculas (a-z). La longitud máxima es de 32 caracteres.

string

Indica el nombre del operador requerido en la consulta para aislar la propiedad de marca de tiempo con el operador menor que. Por ejemplo, si lessThanOperatorName es closedbefore y el nombre de la propiedad es closeDate, las consultas como closedbefore:<value> muestran resultados solo cuando el valor de la propiedad closeDate es anterior a <value>. El nombre del operador solo puede contener letras en minúsculas (a-z). La longitud máxima es de 32 caracteres.

string

Indica el nombre del operador requerido en la consulta para aislar la propiedad de marca de tiempo con el operador mayor que. Por ejemplo, si greaterThanOperatorName es closedafter y el nombre de la propiedad es closeDate, las consultas como closedafter:<value> muestran resultados solo cuando el valor de la propiedad closeDate es posterior a <value>. El nombre del operador solo puede contener letras en minúsculas (a-z). La longitud máxima es de 32 caracteres.

object (BooleanPropertyOptions.BooleanOperatorOptions)

Si se establece, describe cómo se debe usar el valor booleano como operador de búsqueda.

string

Indica el nombre del operador requerido en la consulta para aislar la propiedad booleana. Por ejemplo, si operatorName es closed y el nombre de la propiedad es isClosed, las consultas como closed:<value> muestran resultados solo cuando el valor de la propiedad llamada isClosed coincide con <value>. Por el contrario, una búsqueda que usa el mismo <value> sin un operador muestra todos los elementos en los que <value> coincide con el valor de cualquier propiedad de String o texto dentro del campo de contenido del elemento. El nombre del operador solo puede contener letras minúsculas (a-z). La longitud máxima es de 32 caracteres.

object (PropertyDefinition)

Las propiedades del subobjeto Estas propiedades representan un objeto anidado. Por ejemplo, si esta propiedad representa una dirección postal, los subobjetosProperties podrían llamarse calle, ciudad y estado. La cantidad máxima de elementos es 1,000.

object (EnumPropertyOptions.EnumValuePair)

Es la lista de valores posibles para la propiedad de enumeración. Todos los EnumValuePairs deben proporcionar un valor de cadena. Si especificas un valor entero para un EnumValuePair, todos los EnumValuePairs posibles deben proporcionar un valor entero. Tanto el valor de cadena como el valor de número entero deben ser únicos en todos los valores posibles. Una vez establecidos, no se pueden quitar ni modificar los valores posibles. Si proporcionas una clasificación ordenada y crees que podrías insertar valores de enumeración adicionales en el futuro, deja espacios en los valores de número entero iniciales para permitir agregar un valor entre los valores registrados anteriormente. La cantidad máxima de elementos es 100.

enum (EnumPropertyOptions.OrderedRanking)

Se usa para especificar la clasificación ordenada de la enumeración que determina cómo se usan los valores de números enteros proporcionados en los EnumValuePairs posibles para clasificar los resultados. Si se especifica, se deben proporcionar valores enteros para todos los valores posibles de EnumValuePair que se proporcionan para esta propiedad. Solo se puede usar si isRepeatable es falso.

object (EnumPropertyOptions.EnumOperatorOptions)

Si se establece, describe cómo se debe usar la enumeración como operador de búsqueda.

string

El valor de cadena de EnumValuePair. La longitud máxima es de 32 caracteres.

integer

Es el valor entero de EnumValuePair, que debe ser no negativo. Opcional.

string

Indica el nombre del operador requerido en la consulta para aislar la propiedad enum. Por ejemplo, si operatorName es priority y el nombre de la propiedad es priorityVal, las consultas como priority:<value> muestran resultados solo cuando el valor de la propiedad llamada priorityVal coincide con <value>. Por el contrario, una búsqueda que usa el mismo <value> sin un operador muestra todos los elementos en los que <value> coincide con el valor de cualquier propiedad de String o texto dentro del campo de contenido del elemento. El nombre del operador solo puede contener letras minúsculas (a-z). La longitud máxima es de 32 caracteres.

object (DatePropertyOptions.DateOperatorOptions)

Si se establece, describe cómo se debe usar la fecha como operador de búsqueda.

string

Indica la cadena real requerida en la consulta para aislar la propiedad de fecha. Por ejemplo, supongamos que un objeto de esquema de seguimiento de problemas tiene una propiedad llamada closeDate que especifica un operador con un operadorName de closedon. En el caso de las búsquedas en esos datos, las consultas como closedon:<value> muestran resultados solo cuando el valor de la propiedad closeDate coincide con <value>. Por el contrario, una búsqueda que usa el mismo <value> sin un operador muestra todos los elementos en los que <value> coincide con el valor de cualquier propiedad de String o texto dentro del campo de contenido del origen de datos indexado. El nombre del operador solo puede contener letras minúsculas (a-z). La longitud máxima es de 32 caracteres.

string

Indica el nombre del operador requerido en la consulta para aislar la propiedad de fecha con el operador menor que. Por ejemplo, si lessThanOperatorName es closedbefore y el nombre de la propiedad es closeDate, las consultas como closedbefore:<value> muestran resultados solo cuando el valor de la propiedad closeDate es anterior a <value>. El nombre del operador solo puede contener letras en minúsculas (a-z). La longitud máxima es de 32 caracteres.

string

Indica el nombre del operador requerido en la consulta para aislar la propiedad de fecha con el operador mayor que. Por ejemplo, si greaterThanOperatorName es closedafter y el nombre de la propiedad es closeDate, las consultas como closedafter:<value> muestran resultados solo cuando el valor de la propiedad closeDate es posterior a <value>. El nombre del operador solo puede contener letras en minúsculas (a-z). La longitud máxima es de 32 caracteres.

object (RetrievalImportance)

Indica la importancia de la calidad de la búsqueda de los tokens dentro del campo cuando se usan para la recuperación.

object (TextPropertyOptions.TextOperatorOptions)

Si se establece, describe cómo se debe usar la propiedad como un operador de búsqueda.

enum (RetrievalImportance.Importance)

Indica la importancia de clasificación que se le otorga a la propiedad cuando coincide durante la recuperación. Una vez establecida, no se puede cambiar la importancia del token de una propiedad.

string

Indica el nombre del operador requerido en la consulta para aislar la propiedad de texto. Por ejemplo, si operatorName es subject y el nombre de la propiedad es subjectLine, las consultas como subject:<value> muestran resultados solo cuando el valor de la propiedad llamada subjectLine coincide con <value>. Por el contrario, una búsqueda que usa el mismo <value> sin un operador muestra todos los elementos en los que <value> coincide con el valor de cualquier propiedad de texto o texto dentro del campo de contenido del elemento. El nombre del operador solo puede contener letras minúsculas (a-z). La longitud máxima es de 32 caracteres.

boolean

Si es verdadero, el valor de texto se segmenta como un valor atómico en las búsquedas de operadores y las coincidencias de facetas. Por ejemplo, si el nombre del operador es "género" y el valor es "ciencia ficción", las restricciones de búsqueda "género:ciencia" y "género:ficción" no coinciden con el artículo, pero "género:ciencia ficción" sí. La coincidencia de valores de texto distingue mayúsculas de minúsculas y no quita caracteres especiales. Si es falso, el texto se tokeniza. Por ejemplo, si el valor es “ciencia ficción”, las búsquedas “género:ciencia” y “género:ficción” coinciden con el artículo.

object (RetrievalImportance)

Indica la importancia de la calidad de la búsqueda de los tokens dentro del campo cuando se usan para la recuperación. Solo se puede establecer en DEFAULT o NONE.

object (HtmlPropertyOptions.HtmlOperatorOptions)

Si se establece, describe cómo se debe usar la propiedad como un operador de búsqueda.

string

Indica el nombre del operador requerido en la consulta para aislar la propiedad html. Por ejemplo, si operatorName es subject y el nombre de la propiedad es subjectLine, las consultas como subject:<value> muestran resultados solo cuando el valor de la propiedad llamada subjectLine coincide con <value>. Por el contrario, una búsqueda que usa el mismo <value> sin un operador muestra todos los elementos en los que <value> coincide con el valor de cualquier propiedad o texto HTML dentro del campo de contenido del elemento. El nombre del operador solo puede contener letras minúsculas (a-z). La longitud máxima es de 32 caracteres.

string

Es la etiqueta fácil de usar para la propiedad que se usa si se especifica que se debe mostrar en ObjectDisplayOptions. Si se proporciona, la etiqueta de visualización se muestra delante de los valores de la propiedad cuando esta forma parte de las opciones de visualización del objeto. Por ejemplo, si el valor de la propiedad es "1", es posible que el valor por sí solo no sea un contexto útil para el usuario. Si el nombre visible proporcionado fue "priority", el usuario verá "priority : 1" en los resultados de la búsqueda, lo que proporciona un contexto claro a los usuarios de la búsqueda. Este campo es OPCIONAL. Si no se proporciona, solo se mostrarán los valores de la propiedad. La longitud máxima es de 64 caracteres.