- Recurso: SearchApplication
- DataSourceRestriction
- Fuente
- Source.PredefinedSource
- FilterOptions
- Filtrar
- Filter.ValueFilter
- Valor
- Filter.CompositeFilter
- Filter.CompositeFilter.LogicOperator
- SourceConfig
- SourceScoringConfig
- SourceScoringConfig.SourceImportance
- SourceCrowdingConfig
- ScoringConfig
- SortOptions
- SortOptions.SortOrder
- FacetOptions
- IntegerFacetingOptions
- QueryInterpretationConfig
- Métodos
Recurso: SearchApplication
SearchApplication
Representación JSON |
---|
{ "name": string, "displayName": string, "dataSourceRestrictions": [ { object ( |
Campos | |
---|---|
name |
Es el nombre de la aplicación de búsqueda. Formato: searchapplications/{applicationId}. |
displayName |
Es el nombre visible de la aplicación de búsqueda. La longitud máxima es de 300 caracteres. |
dataSourceRestrictions[] |
Las restricciones aplicadas a la configuración. La cantidad máxima de elementos es 10. |
sourceConfig[] |
Configuración para una fuente especificada en dataSourceRestrictions. |
scoringConfig |
Configuración de los resultados de clasificación. |
defaultSortOptions |
Las opciones predeterminadas para ordenar los resultados de la búsqueda |
defaultFacetOptions[] |
Los campos predeterminados para mostrar los resultados de la faceta. Las fuentes que se especifican aquí también se incluyeron en |
returnResultThumbnailUrls |
Con cada resultado, debemos mostrar el URI de su miniatura (si corresponde). |
operationIds[] |
Solo salida. Los IDs de las operaciones de larga duración (LRO) que se ejecutan actualmente para este esquema. Es el campo de solo salida. |
enableAuditLog |
Indica si el registro de auditoría está activado o desactivado para las solicitudes realizadas para la aplicación de búsqueda en las APIs de consulta. |
queryInterpretationConfig |
Opciones predeterminadas para la interpretación de consultas |
DataSourceRestriction
Restricción en la fuente de datos.
Representación JSON |
---|
{ "source": { object ( |
Campos | |
---|---|
source |
Es la fuente de la restricción. |
filterOptions[] |
Opciones de filtro que restringen los resultados. Si hay varios filtros, se agrupan por tipo de objeto antes de unirse. Los filtros con el mismo tipo de objeto se unen de forma conjuntiva y, luego, las expresiones resultantes se unen de forma disyuntiva. La cantidad máxima de elementos es 20. NOTA: Por el momento, la API de sugerencias solo admite algunos filtros: "objecttype", "type" y "mimetype". Por ahora, no se pueden usar filtros específicos de esquema para filtrar sugerencias. |
Origen
Define las fuentes para las APIs de sugerencia y búsqueda.
Representación JSON |
---|
{ // Union field |
Campos | |
---|---|
Campo de unión
|
|
name |
Nombre de la fuente del contenido indexado por |
predefinedSource |
Fuente de contenido predefinido para Google Apps. |
Source.PredefinedSource
Fuentes predefinidas:
Enumeradores | |
---|---|
NONE |
|
QUERY_HISTORY |
Sugiere consultas emitidas por el usuario en el pasado. Solo es válido cuando se usa con la API de Sugerir. Se ignora cuando se usa en la API de consulta. |
PERSON |
Sugiere personas en la organización. Solo es válido cuando se usa con la API de Sugerir. Genera un error cuando se usa en la API de consulta. |
GOOGLE_DRIVE |
|
GOOGLE_GMAIL |
|
GOOGLE_SITES |
|
GOOGLE_GROUPS |
|
GOOGLE_CALENDAR |
|
GOOGLE_KEEP |
FilterOptions
Opciones de filtro que se aplicarán en la consulta.
Representación JSON |
---|
{
"objectType": string,
"filter": {
object ( |
Campos | |
---|---|
objectType |
Si se establece objectType, solo se muestran los objetos de ese tipo. Debe corresponder al nombre del objeto que se registró en la definición del esquema. La longitud máxima es de 256 caracteres. |
filter |
Filtro genérico para restringir la búsqueda, como |
Filtro
Una forma genérica de expresar filtros en una consulta, que admite dos enfoques:
1. Establecer un ValueFilter. El nombre debe coincidir con un operadorName definido en el esquema de tu fuente de datos.
2. Configuración de un composeFilter. Los filtros se evalúan mediante el operador lógico. Los operadores de nivel superior solo pueden ser AND o NOT. Y solo puede aparecer en el nivel superior. El operador O solo puede aparecer bajo un operador Y de nivel superior.
Representación JSON |
---|
{ // Union field |
Campos | |
---|---|
Campo de unión
|
|
valueFilter |
|
compositeFilter |
|
Filter.ValueFilter
Representación JSON |
---|
{
"operatorName": string,
"value": {
object ( |
Campos | |
---|---|
operatorName |
El
|
value |
Valor con el que se va a comparar. |
Valor
Definición de un valor único con un tipo genérico.
Representación JSON |
---|
{ // Union field |
Campos | |
---|---|
Campo de unión value . El valor de la propiedad nombrada. Las direcciones (value ) solo pueden ser una de las siguientes opciones: |
|
stringValue |
|
integerValue |
|
doubleValue |
|
timestampValue |
Una marca de tiempo en formato RFC3339 UTC "Zulú", con resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: |
booleanValue |
|
dateValue |
|
Filter.CompositeFilter
Representación JSON |
---|
{ "logicOperator": enum ( |
Campos | |
---|---|
logicOperator |
El operador lógico del subfiltro. |
subFilters[] |
Subfiltros. |
Filter.CompositeFilter.LogicOperator
Enumeradores | |
---|---|
AND |
Operadores lógicos, que solo se pueden aplicar a subfiltros. |
OR |
|
NOT |
NO solo se puede aplicar en un único filtro secundario. |
SourceConfig
Configuraciones para una fuente mientras se procesa una solicitud query.search
o query.suggest
.
Representación JSON |
---|
{ "source": { object ( |
Campos | |
---|---|
source |
La fuente para la que se usará esta configuración. |
scoringConfig |
La configuración de puntuación para la fuente. |
crowdingConfig |
Es la configuración de multiplicidad para la fuente. |
SourceScoringConfig
Establece la configuración de la puntuación. Esto permite modificar la clasificación de resultados de una fuente.
Representación JSON |
---|
{
"sourceImportance": enum ( |
Campos | |
---|---|
sourceImportance |
Importancia de la fuente |
SourceScoringConfig.SourceImportance
La importancia de una fuente que se puede usar para indicar si una fuente debe tener más prioridad en la clasificación en comparación con otra.
Enumeradores | |
---|---|
DEFAULT |
|
LOW |
|
HIGH |
SourceCrowdingConfig
Establece límites de multiplicidad en los resultados de la búsqueda. La acumulación es una situación en la que varios resultados de la misma fuente o del mismo host "colocan" otros resultados, lo que disminuye la calidad de la búsqueda para los usuarios. Para fomentar una mejor calidad de búsqueda y una diversidad de fuentes en los resultados de la búsqueda, puedes establecer una condición para reducir los resultados repetitivos por fuente.
Representación JSON |
---|
{ "numResults": integer, "numSuggestions": integer } |
Campos | |
---|---|
numResults |
La cantidad máxima de resultados permitidos de una fuente de datos en una página de resultados, siempre que no se agoten los resultados de otras fuentes. El valor especificado no debe ser negativo. Si el valor es igual a 0, se usa un valor predeterminado. Para inhabilitar la acumulación, establece el valor superior a 100. |
numSuggestions |
Cantidad máxima de sugerencias permitidas desde una fuente. No se establecerá ningún límite en los resultados si este valor es menor o igual que 0. |
ScoringConfig
Configuraciones de puntuación para una fuente mientras se procesa una solicitud query.search
o query.suggest
Representación JSON |
---|
{ "disableFreshness": boolean, "disablePersonalization": boolean } |
Campos | |
---|---|
disableFreshness |
Indica si se debe usar la actualidad como indicador de clasificación. De forma predeterminada, la actualidad se usa como indicador de clasificación. Ten en cuenta que este parámetro de configuración no está disponible en la IU para administrar. |
disablePersonalization |
Determina si se deben personalizar los resultados. De forma predeterminada, los indicadores personales se utilizarán para optimizar los resultados. |
SortOptions
Representación JSON |
---|
{
"operatorName": string,
"sortOrder": enum ( |
Campos | |
---|---|
operatorName |
El nombre del operador correspondiente al campo en el que se va a ordenar. La propiedad correspondiente debe marcarse como |
sortOrder |
Orden de clasificación predeterminado |
SortOptions.SortOrder
Enumeradores | |
---|---|
ASCENDING |
|
DESCENDING |
FacetOptions
Especifica los operadores para los que se mostrarán resultados de faceta. Habrá un FacetResult para cada combinación sourceName/objectType/operatorName.
Representación JSON |
---|
{
"sourceName": string,
"objectType": string,
"operatorName": string,
"numFacetBuckets": integer,
"integerFacetingOptions": {
object ( |
Campos | |
---|---|
sourceName |
Nombre de la fuente a la faceta activada. Formato: datastores/{sourceId} Si está vacío, se usarán todas las fuentes de datos. |
objectType |
Si se establece objectType, solo se usarán los objetos de ese tipo para calcular facetas. Si está vacío, todos los objetos se usarán para calcular las facetas. |
operatorName |
El nombre del operador elegido para la faceta. @see cloudsearch.SchemaPropertyOptions |
numFacetBuckets |
Cantidad máxima de buckets de faceta que se deben mostrar para esta faceta. La configuración predeterminada es 10. El valor máximo es 100. |
integerFacetingOptions |
Si se establece, describe las opciones de faceta de números enteros para la propiedad de número entero determinada. La propiedad de número entero correspondiente en el esquema debe marcarse como isFacetable. La cantidad de buckets que se muestra sería la mínima de este y numFacetBuckets. |
IntegerFacetingOptions
Se usa para especificar opciones de facetas de números enteros.
Representación JSON |
---|
{ "integerBuckets": [ string ] } |
Campos | |
---|---|
integerBuckets[] |
Los buckets para los valores de números enteros especificados deben estar en orden ascendente estrictamente. Por ejemplo, si los valores proporcionados son (1,5,10,100), los siguientes buckets de facetas se formarán: {<1, [1,5), [5-10), [10-100), >=100}. |
QueryInterpretationConfig
Opciones predeterminadas para interpretar la consulta del usuario.
Representación JSON |
---|
{ "forceVerbatimMode": boolean, "forceDisableSupplementalResults": boolean } |
Campos | |
---|---|
forceVerbatimMode |
Habilita esta marca para desactivar todas las optimizaciones internas, como la interpretación de consultas en lenguaje natural (NL), la recuperación de resultados complementarios y el uso de sinónimos, incluidos los personalizados. Si se establece esta marca como verdadera, tendrá prioridad sobre la opción establecida en el nivel de la consulta. En el caso del valor predeterminado Falso, la marca a nivel de la consulta establecerá la interpretación correcta del modo literal. |
forceDisableSupplementalResults |
Establece esta marca para inhabilitar la recuperación de resultados complementarios. Si estableces una marca aquí, no se recuperarán los resultados complementarios de las consultas asociadas con una aplicación de búsqueda determinada. Si se establece esta marca como verdadera, tendrá prioridad sobre la opción establecida en el nivel de la consulta. En el valor predeterminado Falso, la marca a nivel de la consulta establecerá la interpretación correcta de los resultados complementarios. |
Métodos |
|
---|---|
|
Crea una aplicación de búsqueda. |
|
Borra una aplicación de búsqueda. |
|
Obtiene la aplicación de búsqueda especificada. |
|
Muestra una lista de todas las aplicaciones de búsqueda. |
|
Actualiza una aplicación de búsqueda. |
|
Restablece una aplicación de búsqueda a la configuración predeterminada. |
|
Actualiza una aplicación de búsqueda. |