SearchResponse

Mensaje de respuesta para el método SearchService.Search.

Representación JSON 
{
  "results": [
    {
      object (SearchResult)
    }
  ],
  "facets": [
    {
      object (Facet)
    }
  ],
  "totalSize": integer,
  "attributionToken": string,
  "redirectUri": string,
  "nextPageToken": string,
  "correctedQuery": string,
  "summary": {
    object (Summary)
  },
  "appliedControls": [
    string
  ],
  "queryExpansionInfo": {
    object (QueryExpansionInfo)
  },
  "naturalLanguageQueryUnderstandingInfo": {
    object (NaturalLanguageQueryUnderstandingInfo)
  },
  "sessionInfo": {
    object (SessionInfo)
  },
  "searchLinkPromotions": [
    {
      object (SearchLinkPromotion)
    }
  ],
  "semanticState": enum (SemanticState)
}
Campos
results[]

object (SearchResult)

Una lista de documentos coincidentes. El orden representa la clasificación.
facets[]

object (Facet)

Son los resultados de las facetas solicitadas por el usuario.
totalSize

integer

El número total estimado de elementos coincidentes, independientemente de la paginación. El recuento de results devuelto por la paginación puede ser menor que el totalSize que coincide.
attributionToken

string

Es un token de búsqueda único. Esto se debe incluir en los registros de UserEvent que resulten de esta búsqueda, lo que permite una atribución precisa del rendimiento del modelo de búsqueda. Esto también ayuda a identificar una solicitud durante las situaciones de asistencia al cliente.
redirectUri

string

La URI de una página de redireccionamiento definida por el cliente. Si se activa la acción de redireccionamiento, no se realiza ninguna búsqueda y solo se configuran redirectUri y attributionToken en la respuesta.
nextPageToken

string

Un token que se puede enviar como SearchRequest.page_token para recuperar la página siguiente. Si se omite este campo, no habrá páginas siguientes.
correctedQuery

string

Contiene la consulta corregida ortográficamente, si se encuentra. Si el tipo de corrección ortográfica es AUTOMATIC, los resultados de la búsqueda se basan en correctedQuery. De lo contrario, se usará la búsqueda original.
summary

object (Summary)

Un resumen como parte de los resultados de la búsqueda. Este campo solo se devuelve si se configura SearchRequest.ContentSearchSpec.summary_spec.
appliedControls[]

string

Es opcional. Son los controles que se aplican como parte del servicio de Control.
queryExpansionInfo

object (QueryExpansionInfo)

Es la información de búsqueda expandida para los resultados devueltos.
naturalLanguageQueryUnderstandingInfo

object (NaturalLanguageQueryUnderstandingInfo)

Solo salida. Es la información de comprensión de la consulta en lenguaje natural para los resultados devueltos.
sessionInfo

object (SessionInfo)

Es la información de la sesión.

Solo se establece si se proporciona SearchRequest.session. Consulta la descripción para obtener más detalles.
semanticState

enum (SemanticState)

Solo salida. Indica el estado semántico de la respuesta de búsqueda.

Faceta

Es un resultado de faceta.

Representación JSON 
{
  "key": string,
  "values": [
    {
      object (FacetValue)
    }
  ],
  "dynamicFacet": boolean
}
Campos
key

string

Es la clave de esta faceta. Por ejemplo, "colors" o "price". Coincide con SearchRequest.FacetSpec.FacetKey.key.
values[]

object (FacetValue)

Son los valores de faceta para este campo.
dynamicFacet

boolean

Indica si la faceta se genera de forma dinámica.

FacetValue

Es un valor de faceta que contiene nombres de valores y su recuento.

Representación JSON 
{
  "count": string,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "value": string,
  "interval": {
    object (Interval)
  }
  // End of mutually exclusive fields.
}
Campos
count

string (int64 format)

Cantidad de elementos que tienen este valor de faceta.
Es un valor de faceta que contiene valores. A continuación, se incluye una lista de campos mutuamente excluyentes. En una respuesta, se establecerá, como máximo, uno de los siguientes campos:
value

string

Es el valor de texto de una faceta, como "Negro" para la faceta "colores".
interval

object (Interval)

Es el valor del intervalo para una faceta, como [10, 20) para la faceta "precio". Coincide con SearchRequest.FacetSpec.FacetKey.intervals.
Fin de los campos mutuamente exclusivos.

QueryExpansionInfo

Es información que describe la búsqueda expandida, incluido si se produjo la expansión.

Representación JSON 
{
  "expandedQuery": boolean,
  "pinnedResultCount": string
}
Campos
expandedQuery

boolean

Es un valor booleano que describe si se produjo la búsqueda expandida.
pinnedResultCount

string (int64 format)

Es la cantidad de resultados fijados. Este campo solo se establecerá cuando se produzca la expansión y SearchRequest.QueryExpansionSpec.pin_unexpanded_results se establezca como verdadero.

NaturalLanguageQueryUnderstandingInfo

Es información que describe qué comprensión del lenguaje natural se realizó en la búsqueda de entrada.

Representación JSON 
{
  "extractedFilters": string,
  "rewrittenQuery": string,
  "classifiedIntents": [
    string
  ],
  "structuredExtractedFilter": {
    object (StructuredExtractedFilter)
  }
}
Campos
extractedFilters

string

Son los filtros que se extrajeron de la búsqueda de entrada.
rewrittenQuery

string

Es la consulta de entrada reescrita sin los filtros extraídos.
classifiedIntents[]

string

Son las intenciones clasificadas de la búsqueda de entrada.
structuredExtractedFilter

object (StructuredExtractedFilter)

Son los filtros que se extrajeron de la búsqueda de entrada y que se representan de forma estructurada.

StructuredExtractedFilter

Son los filtros que se extrajeron de la búsqueda de entrada y que se representan de forma estructurada.

Representación JSON 
{
  "expression": {
    object (Expression)
  }
}
Campos
expression

object (Expression)

Es la expresión que denota el filtro que se extrajo de la búsqueda de entrada en un formato estructurado. Puede ser una expresión simple que denote una sola cadena, una restricción numérica o de ubicación geográfica, o una expresión compuesta que sea una combinación de varias expresiones conectadas con operadores lógicos (OR y AND).

Expresión

Es la expresión que denota el filtro que se extrajo de la búsqueda de entrada.

Representación JSON 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "stringConstraint": {
    object (StringConstraint)
  },
  "numberConstraint": {
    object (NumberConstraint)
  },
  "geolocationConstraint": {
    object (GeolocationConstraint)
  },
  "andExpr": {
    object (AndExpression)
  },
  "orExpr": {
    object (OrExpression)
  }
  // End of mutually exclusive fields.
}
Campos
Es el tipo de expresión. A continuación, se incluye una lista de campos mutuamente excluyentes. En una respuesta, se establecerá, como máximo, uno de los siguientes campos:
stringConstraint

object (StringConstraint)

Es la expresión de restricción de cadena.
numberConstraint

object (NumberConstraint)

Es una expresión de restricción numérica.
geolocationConstraint

object (GeolocationConstraint)

Es la expresión de restricción de ubicación geográfica.
andExpr

object (AndExpression)

Operador compuesto "Y" lógico que conecta varias expresiones.
orExpr

object (OrExpression)

Operador compuesto "Or" lógico que conecta varias expresiones.
Fin de los campos mutuamente exclusivos.

StringConstraint

Es la expresión de restricción de un campo de cadena.

Representación JSON 
{
  "fieldName": string,
  "values": [
    string
  ],
  "querySegment": string
}
Campos
fieldName

string

Es el nombre del campo de cadena, tal como se define en el esquema.
values[]

string

Son los valores del campo de cadena. El registro solo se devolverá si el valor del campo coincide con uno de los valores especificados aquí.
querySegment

string

Identifica las palabras clave dentro de la búsqueda que coinciden con un filtro.

NumberConstraint

Es la expresión de restricción de un campo numérico. Ejemplo: price < 100.

Representación JSON 
{
  "fieldName": string,
  "comparison": enum (Comparison),
  "value": number,
  "querySegment": string
}
Campos
fieldName

string

Es el nombre del campo numérico tal como se define en el esquema.
comparison

enum (Comparison)

Operación de comparación que se realiza entre el valor del campo y el valor especificado en la restricción.
value

number

Es el valor especificado en la restricción numérica.
querySegment

string

Identifica las palabras clave dentro de la búsqueda que coinciden con un filtro.

Comparación

Operación de comparación que se realizó.

Enums
COMPARISON_UNSPECIFIED Operador de comparación no definido.
EQUALS Denota el operador de igualdad =.
LESS_THAN_EQUALS Denota el operador menor o igual que <=.
LESS_THAN Denota el operador menor que <.
GREATER_THAN_EQUALS Denota el operador mayor o igual que >=.
GREATER_THAN Denota el operador mayor que >.

GeolocationConstraint

Es la restricción de un campo de ubicación geográfica. Es el nombre del campo de ubicación geográfica tal como se define en el esquema.

Representación JSON 
{
  "fieldName": string,
  "address": string,
  "latitude": number,
  "longitude": number,
  "radiusInMeters": number
}
Campos
fieldName

string

Es el nombre del campo de ubicación geográfica tal como se define en el esquema.
address

string

La dirección de referencia que se dedujo de la consulta de entrada. La proximidad de la dirección de referencia al campo de geolocalización se usará para filtrar los resultados.
latitude

number

La latitud de la geolocalización inferida a partir de la consulta de entrada.
longitude

number

La longitud de la geolocalización inferida a partir de la consulta de entrada.
radiusInMeters

number

Radio en metros alrededor de la dirección. El registro se devuelve si la ubicación del campo de geolocalización se encuentra dentro del radio.

AndExpression

Operador lógico And.

Representación JSON 
{
  "expressions": [
    {
      object (Expression)
    }
  ]
}
Campos
expressions[]

object (Expression)

Las expresiones que se combinaron mediante la operación AND.

OrExpression

Operador lógico Or.

Representación JSON 
{
  "expressions": [
    {
      object (Expression)
    }
  ]
}
Campos
expressions[]

object (Expression)

Las expresiones que se combinaron mediante la operación OR.

SessionInfo

Información sobre la sesión.

Representación JSON 
{
  "name": string,
  "queryId": string
}
Campos
name

string

Nombre de la sesión. Si se utiliza el modo de sesión automática (cuando SearchRequest.session termina con "-"), este campo contiene el nombre de sesión recién generado.
queryId

string

Es el ID de la búsqueda que corresponde a esta llamada a la API de Search. Una sesión puede tener varios turnos, cada uno con un ID de búsqueda único.

Al especificar el nombre de la sesión y este ID de consulta en la llamada a la API de respuestas, la generación de la respuesta se produce en el contexto de los resultados de búsqueda de esta llamada.

SemanticState

Es el estado semántico de la respuesta de búsqueda.

Enums
SEMANTIC_STATE_UNSPECIFIED Valor predeterminado. No se debe usar.
DISABLED Se inhabilitó la búsqueda semántica para esta respuesta de búsqueda.
ENABLED Se habilitó la búsqueda semántica para esta respuesta de búsqueda.