SearchResponse

Mensaje de respuesta para el 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)

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

object (Facet)

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

object (GuidedSearchResult)

Resultado de búsqueda guiado.
totalSize

integer

Es el recuento total estimado de artículos coincidentes, sin importar la paginación. El recuento de results que devuelve la paginación puede ser menor que el de 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

Es el 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

Es 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 usa la búsqueda original.
suggestedQuery

string

Es la consulta corregida con baja confianza, también conocida como consulta de sugerencia. En comparación con correctedQuery, este campo se establece cuando SpellCorrector devolvió una respuesta, pero no se activó FPR(reemplazo de página completa) porque la corrección tiene un nivel de confianza bajo(p. ej., se invirtió porque hay coincidencias de la búsqueda original en el corpus de documentos).
summary

object (Summary)

Es un resumen que forma parte de los resultados de la búsqueda. Este campo solo se devuelve si se configura SearchRequest.ContentSearchSpec.summary_spec.
appliedControls[]

string

Son los controles que se aplican como parte del servicio de Control.
geoSearchDebugInfo[]

object (GeoSearchDebugInfo)
queryExpansionInfo

object (QueryExpansionInfo)

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

object (NaturalLanguageQueryUnderstandingInfo)

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.
oneBoxResults[]

object (OneBoxResult)

Es una lista de resultados de la Caja única. Puede haber varios resultados de la Caja de respuesta de diferentes tipos.

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,

  // 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)

Es la cantidad de elementos que tienen este valor de faceta.
Campo de unión facet_value. Es un valor de faceta que contiene valores. facet_value puede ser solo uno de los siguientes:
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.

GuidedSearchResult

Resultado de búsqueda guiado. La búsqueda guiada ayuda al usuario a refinar los resultados de la búsqueda y a reducir la cantidad de resultados para encontrar lo que realmente necesita.

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

object (RefinementAttribute)

Es una lista de atributos de refinamiento clasificados.
followUpQuestions[]

string

Preguntas de seguimiento sugeridas

RefinementAttribute

Es un atributo útil para mejorar los resultados de la búsqueda.

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

string

Es la clave del atributo que se usa para definir mejor los resultados. Por ejemplo, "movie_type".
attributeValue

string

Es el valor del atributo que se usa para definir mejor los resultados. Por ejemplo, "drama".

GeoSearchDebugInfo

Es información de depuración relacionada específicamente con los problemas de geocodificación directa que surgen de la Búsqueda por ubicación.

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

string

Es la dirección desde la que la incorporación de la codificación geográfica directa produjo problemas.
errorMessage

string

Es el error que se produjo.

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)

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 la información que describe la comprensión del lenguaje natural que 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 se representan de forma estructurada.

StructuredExtractedFilter

Son los filtros que se extrajeron de la búsqueda de entrada y 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 
{

  // 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. Es el tipo de expresión. expr puede ser solo uno de los siguientes:
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.

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: precio < 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

Es la dirección de referencia que se infirió a partir de la búsqueda de entrada. La proximidad de la dirección de referencia al campo de geolocalización se usará para filtrar los resultados.
latitude

number

Es la latitud de la ubicación geográfica que se infiere a partir de la búsqueda de entrada.
longitude

number

Es la longitud de la ubicación geográfica que se infiere a partir de la búsqueda de entrada.
radiusInMeters

number

Es el radio en metros alrededor de la dirección. El registro se devuelve si la ubicación del campo de ubicación geográfica se encuentra dentro del radio.

AndExpression

Operador lógico And.

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

object (Expression)

Son las expresiones que se unieron con el operador AND.

OrExpression

Operador lógico Or.

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

object (Expression)

Son las expresiones que se combinaron con OR.

SessionInfo

Es 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

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.

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

OneBoxResult

OneBoxResult es un contenedor para todos los resultados de un tipo específico que queremos mostrar en la IU de manera diferente.

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

enum (OneBoxType)

Es el tipo de resultado de Onebox.
searchResults[]

object (SearchResult)

Son los resultados de la búsqueda de esta Caja única.

OneBoxType

Es el tipo de resultado de Onebox.

Enums
ONE_BOX_TYPE_UNSPECIFIED Valor predeterminado. No se debe usar.
PEOPLE Un resultado de caja contiene resultados de personas.
ORGANIZATION Un resultado de la caja contiene resultados de la organización.
SLACK Un resultado de caja contiene resultados de holgura.
KNOWLEDGE_GRAPH Un resultado de OneBox contiene respuestas de la Búsqueda del Gráfico de conocimiento.