REST Resource: settings.searchapplications

Recurso: SearchApplication

SearchApplication

Representación JSON 
{
  "name": string,
  "displayName": string,
  "dataSourceRestrictions": [
    {
      object (DataSourceRestriction)
    }
  ],
  "sourceConfig": [
    {
      object (SourceConfig)
    }
  ],
  "scoringConfig": {
    object (ScoringConfig)
  },
  "defaultSortOptions": {
    object (SortOptions)
  },
  "defaultFacetOptions": [
    {
      object (FacetOptions)
    }
  ],
  "returnResultThumbnailUrls": boolean,
  "operationIds": [
    string
  ],
  "enableAuditLog": boolean,
  "queryInterpretationConfig": {
    object (QueryInterpretationConfig)
  }
}
Campos
name

string

Es el nombre de la aplicación de búsqueda.

Formato: searchapplications/{applicationId}.
displayName

string

Es el nombre visible de la aplicación de búsqueda. La longitud máxima es de 300 caracteres.
dataSourceRestrictions[]

object (DataSourceRestriction)

Restricciones aplicadas a las configuraciones La cantidad máxima de elementos es 10.
sourceConfig[]

object (SourceConfig)

Configuración de una fuente especificada en dataSourceRestrictions.
scoringConfig

object (ScoringConfig)

Configuración para clasificar los resultados.
defaultSortOptions

object (SortOptions)

Las opciones predeterminadas para ordenar los resultados de la búsqueda
defaultFacetOptions[]

object (FacetOptions)

Los campos predeterminados para mostrar los resultados de las facetas. Las fuentes especificadas aquí también se incluyeron en dataSourceRestrictions anteriormente.
returnResultThumbnailUrls

boolean

Con cada resultado, debemos mostrar el URI de su miniatura (si corresponde).
operationIds[]

string

Solo salida. Son los IDs de las operaciones de larga duración (LRO) que se están ejecutando actualmente para este esquema. Es un campo de solo salida.
enableAuditLog

boolean

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

object (QueryInterpretationConfig)

Las opciones predeterminadas para la interpretación de consultas

DataSourceRestriction

Restricción en la fuente de datos.

Representación JSON 
{
  "source": {
    object (Source)
  },
  "filterOptions": [
    {
      object (FilterOptions)
    }
  ]
}
Campos
source

object (Source)

Es la fuente de la restricción.
filterOptions[]

object (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 Suggest solo admite algunos filtros: "objecttype", "type" y "mimetype". Por ahora, no se pueden usar filtros específicos del esquema para filtrar sugerencias.

Fuente

Define las fuentes para las APIs de sugerencias o búsquedas.

Representación JSON 
{

  // Union field source can be only one of the following:
  "name": string,
  "predefinedSource": enum (Source.PredefinedSource)
  // End of list of possible types for union field source.
}
Campos

Campo de unión source.

source puede ser una de las siguientes opciones:
name

string

Es el nombre de la fuente para el contenido indexado por Indexing API.
predefinedSource

enum (Source.PredefinedSource)

Fuente de contenido predefinida para las apps de Google.

Source.PredefinedSource

Fuentes predefinidas:

Enumeraciones
NONE
QUERY_HISTORY Sugiere consultas que el usuario realizó en el pasado. Solo es válido cuando se usa con la API de sugerencias. Se ignora cuando se usa en la API de consulta.
PERSON Sugiere personas de la organización. Solo es válido cuando se usa con la API de sugerencias. Genera un error cuando se usa en la API de consulta.
GOOGLE_DRIVE
GOOGLE_GMAIL
GOOGLE_SITES
GOOGLE_GROUPS
GOOGLE_CALENDAR
GOOGLE_KEEP

FilterOptions

Son las opciones de filtro que se aplicarán a la consulta.

Representación JSON 
{
  "objectType": string,
  "filter": {
    object (Filter)
  }
}
Campos
objectType

string

Si se establece objectType, solo se muestran objetos de ese tipo. Debe corresponder al nombre del objeto que se registró dentro de la definición del esquema. La longitud máxima es de 256 caracteres.
filter

object (Filter)

Filtro genérico para restringir la búsqueda, como lang:en, site:xyz.

Filtrar

Es una forma genérica de expresar filtros en una consulta, que admite dos enfoques:

1. Configura un ValueFilter. El nombre debe coincidir con un operatorName definido en el esquema de tu fuente de datos.

2. Configura un CompositeFilter. Los filtros se evalúan con el operador lógico. Los operadores de nivel superior solo pueden ser un operador Y o un operador O. Y solo puede aparecer en el nivel superior. O solo puede aparecer debajo de un Y de nivel superior.

Representación JSON 
{

  // Union field filter can be only one of the following:
  "valueFilter": {
    object (Filter.ValueFilter)
  },
  "compositeFilter": {
    object (Filter.CompositeFilter)
  }
  // End of list of possible types for union field filter.
}
Campos

Campo de unión filter.

filter puede ser una de las siguientes opciones:
valueFilter

object (Filter.ValueFilter)
compositeFilter

object (Filter.CompositeFilter)

Filter.ValueFilter

Representación JSON 
{
  "operatorName": string,
  "value": {
    object (Value)
  }
}
Campos
operatorName

string

El operatorName aplicado a la consulta, como price_greater_than El filtro puede funcionar con ambos tipos de filtros definidos en el esquema de tu fuente de datos:

  1. operatorName, en la que la consulta filtra los resultados por la propiedad que coincide con el valor.

  2. greaterThanOperatorName o lessThanOperatorName en tu esquema. La consulta filtra los resultados de los valores de propiedad que son mayores o menores que el valor proporcionado en la consulta.
value

object (Value)

El valor con el que se realizará la comparación.

Valor

Definición de un solo valor con tipo genérico.

Representación JSON 
{

  // Union field value can be only one of the following:
  "stringValue": string,
  "integerValue": string,
  "doubleValue": number,
  "timestampValue": string,
  "booleanValue": boolean,
  "dateValue": {
    object (Date)
  }
  // End of list of possible types for union field value.
}
Campos
Campo de unión value. Es el valor de la propiedad nombrada. Las direcciones (value) solo pueden ser una de las siguientes opciones:
stringValue

string
integerValue

string (int64 format)
doubleValue

number
timestampValue

string (Timestamp format)

Una marca de tiempo en formato RFC3339 UTC “Zulú”, con una resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".
booleanValue

boolean
dateValue

object (Date)

Filter.CompositeFilter

Representación JSON 
{
  "logicOperator": enum (Filter.CompositeFilter.LogicOperator),
  "subFilters": [
    {
      object (Filter)
    }
  ]
}
Campos
logicOperator

enum (Filter.CompositeFilter.LogicOperator)

Es el operador lógico del filtro secundario.
subFilters[]

object (Filter)

Subfiltros

Filter.CompositeFilter.LogicOperator

Enumeraciones
AND Operadores lógicos, que solo se pueden aplicar a subfiltros.
OR
NOT NO solo se puede aplicar a un subfiltro.

SourceConfig

Parámetros de configuración de una fuente mientras se procesa una solicitud query.search o query.suggest

Representación JSON 
{
  "source": {
    object (Source)
  },
  "scoringConfig": {
    object (SourceScoringConfig)
  },
  "crowdingConfig": {
    object (SourceCrowdingConfig)
  }
}
Campos
source

object (Source)

Es la fuente para la que se usará esta configuración.
scoringConfig

object (SourceScoringConfig)

Es la configuración de puntuación de la fuente.
crowdingConfig

object (SourceCrowdingConfig)

Es la configuración de agrupamiento de la fuente.

SourceScoringConfig

Establece la configuración de la puntuación. Esto permite modificar la clasificación de los resultados de una fuente.

Representación JSON 
{
  "sourceImportance": enum (SourceScoringConfig.SourceImportance)
}
Campos
sourceImportance

enum (SourceScoringConfig.SourceImportance)

Importancia de la fuente

SourceScoringConfig.SourceImportance

Es la importancia de una fuente que se puede usar para indicar si se debe dar más prioridad a una fuente en la clasificación en comparación con otra.

Enumeraciones
DEFAULT
LOW
HIGH

SourceCrowdingConfig

Establece límites de agrupación de resultados de la búsqueda. La saturación ocurre cuando varios resultados de la misma fuente o host "superan" a otros, lo que disminuye la calidad de la búsqueda para los usuarios. Para fomentar una mejor calidad de la búsqueda y 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

integer

Es la cantidad máxima de resultados permitidos de una fuente de datos en una página de resultados, siempre y cuando no se agoten los resultados de otras fuentes. El valor especificado no debe ser negativo. Se usa un valor predeterminado si este valor es igual a 0. Para inhabilitar la acumulación, establece el valor en un número mayor que 100.
numSuggestions

integer

Es la cantidad máxima de sugerencias permitidas desde una fuente. No se establecerán límites en los resultados si este valor es menor o igual que 0.

ScoringConfig

Parámetros de configuración de puntuación para una fuente mientras se procesa una solicitud de query.search o query.suggest

Representación JSON 
{
  "disableFreshness": boolean,
  "disablePersonalization": boolean
}
Campos
disableFreshness

boolean

Indica si se debe usar la actualización como indicador de clasificación. De forma predeterminada, la actualización se usa como un indicador de clasificación. Ten en cuenta que este parámetro de configuración no está disponible en la IU de administrador.
disablePersonalization

boolean

Si se deben personalizar los resultados. De forma predeterminada, se usarán los indicadores personales para mejorar los resultados.

SortOptions

Representación JSON 
{
  "operatorName": string,
  "sortOrder": enum (SortOptions.SortOrder)
}
Campos
operatorName

string

Es el nombre del operador que corresponde al campo por el que se ordenará. La propiedad correspondiente debe estar marcada como sortable.
sortOrder

enum (SortOptions.SortOrder)

El orden ascendente es el orden de clasificación predeterminado.

SortOptions.SortOrder

Enumeraciones
ASCENDING
DESCENDING

FacetOptions

Especifica los operadores para los que se deben mostrar los resultados de las facetas. Habrá un FacetResult para cada combinación de sourceName/objectType/operatorName.

Representación JSON 
{
  "sourceName": string,
  "objectType": string,
  "operatorName": string,
  "numFacetBuckets": integer,
  "integerFacetingOptions": {
    object (IntegerFacetingOptions)
  }
}
Campos
sourceName

string

Es el nombre de la fuente en la que se aplicará la faceta. Formato: datasources/{sourceId}. Si está vacío, se usarán todas las fuentes de datos.
objectType

string

Si se establece objectType, solo se usarán esos objetos de ese tipo para calcular las facetas. Si está vacío, se usarán todos los objetos para calcular los componentes.
operatorName

string

Es el nombre del operador elegido para la división en facetas. @see cloudsearch.SchemaPropertyOptions
numFacetBuckets

integer

Es la cantidad máxima de buckets de facetas que se deben mostrar para esta faceta. La configuración predeterminada es 10. El valor máximo es 100.
integerFacetingOptions

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 en el esquema debe estar marcada como isFacetable. La cantidad de buckets que se devuelven sería el mínimo de este y numFacetBuckets.

IntegerFacetingOptions

Se usa para especificar opciones de facetas de números enteros.

Representación JSON 
{
  "integerBuckets": [
    string
  ]
}
Campos
integerBuckets[]

string (Int64Value format)

Los buckets para valores enteros determinados deben estar en orden estrictamente ascendente. Por ejemplo, si los valores proporcionados son (1,5,10,100), se formarán los siguientes buckets de facetas {<1, [1,5), [5-10), [10-100), >=100}.

QueryInterpretationConfig

Son las opciones predeterminadas para interpretar la consulta del usuario.

Representación JSON 
{
  "forceVerbatimMode": boolean,
  "forceDisableSupplementalResults": boolean
}
Campos
forceVerbatimMode

boolean

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 esta marca se establece como verdadera, tendrá prioridad sobre la opción establecida a nivel de la consulta. Para el valor predeterminado de "False", la marca a nivel de la consulta establecerá la interpretación correcta para el modo de texto exacto.
forceDisableSupplementalResults

boolean

Establece esta marca para inhabilitar la recuperación de resultados complementarios. Si estableces una marca aquí, no se recuperarán resultados complementarios para las consultas asociadas con una aplicación de búsqueda determinada. Si esta marca se establece como verdadera, tendrá prioridad sobre la opción establecida a nivel de la consulta. Para el valor predeterminado de "False", la marca a nivel de la consulta establecerá la interpretación correcta para los resultados complementarios.

Métodos

create

 Crea una aplicación de búsqueda.

delete

 Borra una aplicación de búsqueda.

get

 Obtiene la aplicación de búsqueda especificada.

list

 Muestra una lista de todas las aplicaciones de búsqueda.

patch

 Actualiza una aplicación de búsqueda.

reset

 Restablece la configuración predeterminada de una aplicación de búsqueda.

update

 Actualiza una aplicación de búsqueda.