SearchResponse

Mensaje de respuesta del método SearchService.Search.

Representación JSON 
{
  "results": [
    {
      object (SearchResult)
    }
  ],
  "facets": [
    {
      object (Facet)
    }
  ],
  "guidedSearchResult": {
    object (GuidedSearchResult)
  },
  "totalSize": integer,
  "attributionToken": string,
  "redirectUri": string,
  "nextPageToken": string,
  "correctedQuery": string,
  "suggestedQuery": string,
  "summary": {
    object (Summary)
  },
  "appliedControls": [
    string
  ],
  "geoSearchDebugInfo": [
    {
      object (GeoSearchDebugInfo)
    }
  ],
  "queryExpansionInfo": {
    object (QueryExpansionInfo)
  },
  "naturalLanguageQueryUnderstandingInfo": {
    object (NaturalLanguageQueryUnderstandingInfo)
  },
  "sessionInfo": {
    object (SessionInfo)
  },
  "oneBoxResults": [
    {
      object (OneBoxResult)
    }
  ],
  "searchLinkPromotions": [
    {
      object (SearchLinkPromotion)
    }
  ]
}
Campos
results[]

object (SearchResult)

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

object (Facet)

Resultados de las facetas solicitadas por el usuario.
guidedSearchResult

object (GuidedSearchResult)

Resultado de búsqueda guiada.
totalSize

integer

El recuento total estimado de elementos coincidentes, independientemente de la paginación. El recuento de results devuelto por la paginación puede ser inferior al de totalSize que coincida.
attributionToken

string

Un token de búsqueda único. Esto debe incluirse en los UserEvent registros resultantes de esta búsqueda, lo que permite atribuir con precisión el rendimiento del modelo de búsqueda. Esto también ayuda a identificar una solicitud durante las situaciones de asistencia al cliente.
redirectUri

string

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

string

Token que se puede enviar como SearchRequest.page_token para obtener la siguiente página. Si se omite este campo, no hay páginas posteriores.
correctedQuery

string

Contiene la consulta con la ortografía corregida, si se ha encontrado. Si el tipo de corrección ortográfica es AUTOMATIC, los resultados de búsqueda se basan en correctedQuery. De lo contrario, se usa la consulta original para la búsqueda.
suggestedQuery

string

Consulta corregida con un nivel de confianza bajo, también conocida como consulta "¿Quisiste decir...?". En comparación con correctedQuery, este campo se define cuando SpellCorrector devuelve una respuesta, pero no se activa FPR(sustitución de página completa) porque la corrección tiene un nivel de confianza bajo(por ejemplo, se ha invertido porque hay coincidencias de la consulta original en el corpus del documento).
summary

object (Summary)

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

string

Controles aplicados como parte del servicio Control.
geoSearchDebugInfo[]

object (GeoSearchDebugInfo)
queryExpansionInfo

object (QueryExpansionInfo)

Información sobre la ampliación de la consulta de los resultados devueltos.
naturalLanguageQueryUnderstandingInfo

object (NaturalLanguageQueryUnderstandingInfo)

Información sobre la comprensión de las consultas en lenguaje natural de los resultados devueltos.
sessionInfo

object (SessionInfo)

Información de la sesión.

Solo se define si se proporciona SearchRequest.session. Consulta su descripción para obtener más información.
oneBoxResults[]

object (OneBoxResult)

Una lista de resultados de One Box. Puede haber varios resultados de One Box de diferentes tipos.

Faceta

Un resultado de faceta.

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

string

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

object (FacetValue)

Valores de las facetas de este campo.
dynamicFacet

boolean

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

FacetValue

Un valor de faceta que contiene nombres de valores y su recuento.

Representación JSON 
{
  "count": string,

  // Union field facet_value can be only one of the following:
  "value": string,
  "interval": {
    object (Interval)
  }
  // End of list of possible types for union field facet_value.
}
Campos
count

string (int64 format)

Número de elementos que tienen este valor de faceta.
Campo de unión facet_value. Un valor de facet que contiene valores. facet_value solo puede ser una de estas dos opciones:
value

string

Valor de texto de una faceta, como "Negro" para la faceta "Colores".
interval

object (Interval)

Valor del intervalo de una faceta, como [10, 20) para la faceta "price". Coincide con SearchRequest.FacetSpec.FacetKey.intervals.

GuidedSearchResult

Resultado de búsqueda guiada. La búsqueda guiada ayuda a los usuarios a acotar los resultados de búsqueda y a centrarse en lo que realmente necesitan a partir de resultados de búsqueda más amplios.

Representación JSON 
{
  "refinementAttributes": [
    {
      object (RefinementAttribute)
    }
  ],
  "followUpQuestions": [
    string
  ]
}
Campos
refinementAttributes[]

object (RefinementAttribute)

Lista de atributos de refinamiento clasificados.
followUpQuestions[]

string

Preguntas de seguimiento sugeridas.

RefinementAttribute

Atributo útil para acotar los resultados de búsqueda.

Representación JSON 
{
  "attributeKey": string,
  "attributeValue": string
}
Campos
attributeKey

string

Clave de atributo usada para acotar los resultados. Por ejemplo, "movie_type".
attributeValue

string

Valor del atributo que se usa para acotar los resultados. Por ejemplo, "drama".

GeoSearchDebugInfo

Información de depuración relacionada específicamente con problemas de geocodificación directa derivados de la búsqueda de geolocalización.

Representación JSON 
{
  "originalAddressQuery": string,
  "errorMessage": string
}
Campos
originalAddressQuery

string

La dirección desde la que la ingestión de geocodificación directa ha provocado problemas.
errorMessage

string

El error producido.

QueryExpansionInfo

Información que describe la ampliación de consultas, incluido si se ha producido o no.

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

boolean

Valor booleano que describe si se ha ampliado la consulta.
pinnedResultCount

string (int64 format)

Número de resultados fijados. Este campo solo se definirá cuando se produzca una expansión y SearchRequest.QueryExpansionSpec.pin_unexpanded_results tenga el valor true.

NaturalLanguageQueryUnderstandingInfo

Información que describe la comprensión del lenguaje natural que se ha aplicado a la consulta de entrada.

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

string

Los filtros que se han extraído de la consulta de entrada.
rewrittenQuery

string

Consulta de entrada reescrita menos los filtros extraídos.
classifiedIntents[]

string

Las intenciones clasificadas de la consulta de entrada.
structuredExtractedFilter

object (StructuredExtractedFilter)

Los filtros que se han extraído de la consulta de entrada representados de forma estructurada.

StructuredExtractedFilter

Los filtros que se han extraído de la consulta de entrada representados de forma estructurada.

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

object (Expression)

La expresión que denota el filtro que se ha extraído de la consulta de entrada en un formato estructurado. Puede ser una expresión sencilla que denote una sola restricción de cadena, numérica o de geolocalización, o una expresión compuesta que sea una combinación de varias expresiones conectadas mediante operadores lógicos (O e Y).

Expresión

Expresión que indica el filtro que se ha extraído de la consulta de entrada.

Representación JSON 
{

  // Union field expr can be only one of the following:
  "stringConstraint": {
    object (StringConstraint)
  },
  "numberConstraint": {
    object (NumberConstraint)
  },
  "geolocationConstraint": {
    object (GeolocationConstraint)
  },
  "andExpr": {
    object (AndExpression)
  },
  "orExpr": {
    object (OrExpression)
  }
  // End of list of possible types for union field expr.
}
Campos
Campo de unión expr. El tipo de expresión. expr solo puede ser una de estas dos opciones:
stringConstraint

object (StringConstraint)

Expresión de restricción de cadena.
numberConstraint

object (NumberConstraint)

Expresión de restricción numérica.
geolocationConstraint

object (GeolocationConstraint)

Expresión de restricción de geolocalización.
andExpr

object (AndExpression)

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

object (OrExpression)

Operador compuesto lógico "O" que conecta varias expresiones.

StringConstraint

Expresión de restricción de un campo de cadena.

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

string

Nombre del campo de cadena tal como se define en el esquema.
values[]

string

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 de la consulta de búsqueda que coinciden con un filtro.

NumberConstraint

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

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

enum (Comparison)

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

number

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

string

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

Comparación

La operación de comparación que se ha realizado.

Enumeraciones
COMPARISON_UNSPECIFIED Operador de comparación indefinido.
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 que o igual a >=.
GREATER_THAN Denota el operador "mayor que" >.

GeolocationConstraint

Restricción de un campo de geolocalización. Nombre del campo de geolocalización tal como se define en el esquema.

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

string

Nombre del campo de geolocalización tal como se define en el esquema.
address

string

La dirección de referencia que se ha inferido a partir 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

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

number

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

number

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

AndExpression

Operador lógico And.

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

object (Expression)

Las expresiones que se han combinado con el operador AND.

OrExpression

Operador lógico Or.

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

object (Expression)

Las expresiones que se han combinado con 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 usa el modo de sesión automática (cuando SearchRequest.session termina con "-"), este campo contiene el nombre de la sesión recién generada.
queryId

string

ID de consulta que corresponde a esta llamada a la API de búsqueda. Una sesión puede tener varias interacciones, cada una con un ID de consulta único.

Si especificas el nombre de la sesión y este ID de consulta en la llamada a la API Answer, la respuesta se generará en el contexto de los resultados de búsqueda de esta llamada de búsqueda.

OneBoxResult

OneBoxResult es un contenedor de todos los resultados de un tipo específico que queremos mostrar de forma diferente en la interfaz de usuario.

Representación JSON 
{
  "oneBoxType": enum (OneBoxType),
  "searchResults": [
    {
      object (SearchResult)
    }
  ]
}
Campos
oneBoxType

enum (OneBoxType)

El tipo de resultado de One Box.
searchResults[]

object (SearchResult)

Los resultados de búsqueda de este cuadro.

OneBoxType

El tipo de resultado de One Box.

Enumeraciones
ONE_BOX_TYPE_UNSPECIFIED Valor predeterminado. No se debe usar.
PEOPLE Un resultado de cuadro contiene resultados de personas.
ORGANIZATION Un recuadro de resultados contiene resultados de organizaciones.
SLACK Un resultado de caja contiene resultados de Slack.
KNOWLEDGE_GRAPH Un cuadro de resultados contiene respuestas de búsqueda del gráfico de conocimiento.