Documents - Autocomplete Get

Referencia

Service:: Search Service

API Version:: 2023-11-01

Autocompleta los términos de consulta incompletos en función del texto de entrada y los términos coincidentes en el índice.

GET {endpoint}/indexes('{indexName}')/docs/search.autocomplete?api-version=2023-11-01&search={search}&suggesterName={suggesterName}

With optional parameters:

GET {endpoint}/indexes('{indexName}')/docs/search.autocomplete?api-version=2023-11-01&search={search}&suggesterName={suggesterName}&autocompleteMode={autocompleteMode}&$filter={$filter}&fuzzy={fuzzy}&highlightPostTag={highlightPostTag}&highlightPreTag={highlightPreTag}&minimumCoverage={minimumCoverage}&searchFields={searchFields}&$top={$top}

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
endpoint	path	True	string	Dirección URL del punto de conexión del servicio de búsqueda.
indexName	path	True	string	El nombre del índice.
api-version	query	True	string	Versión de api de cliente.
search	query	True	string	El término incompleto que debe completarse automáticamente.
suggesterName	query	True	string	Nombre del proveedor de sugerencias tal y como se especifica en la colección suggesters que forma parte de la definición del índice.
$filter	query		string	Expresión OData que filtra los documentos usados para generar términos completados para el resultado autocompletar.
$top	query		integer int32	Número de términos completados automáticamente que se van a recuperar. Debe ser un valor entre 1 y 100. El valor predeterminado es 5.
autocompleteMode	query		AutocompleteMode	Especifica el modo de Autocompletar. El valor predeterminado es "oneTerm". Use "twoTerms" para obtener shingles y "oneTermWithContext" para usar el contexto actual mientras se generan términos autocompletados.
fuzzy	query		boolean	Valor que indica si se debe usar la coincidencia aproximada para la consulta de autocompletar. El valor predeterminado es False. Cuando se establece en true, la consulta encontrará términos incluso si hay un carácter sustituido o que falta en el texto de búsqueda. Aunque esto proporciona una mejor experiencia en algunos escenarios, se produce un costo de rendimiento, ya que las consultas de autocompletar aproximadas son más lentas y consumen más recursos.
highlightPostTag	query		string	Etiqueta de cadena que se anexa a los resaltados de aciertos. Debe establecerse con highlightPreTag. Si se omite, el resaltado de referencias está deshabilitado.
highlightPreTag	query		string	Una etiqueta de cadena que se antepone para alcanzar los resaltados. Debe establecerse con highlightPostTag. Si se omite, el resaltado de referencias está deshabilitado.
minimumCoverage	query		number double	Número comprendido entre 0 y 100 que indica el porcentaje del índice que debe estar cubierto por una consulta de autocompletar para que la consulta se notifique como correcta. Este parámetro puede ser útil para garantizar la disponibilidad de búsqueda incluso para los servicios con una sola réplica. El valor predeterminado es 80.
searchFields	query		string[]	Lista de nombres de campo que se deben tener en cuenta al consultar los términos autocompletados. Los campos de destino deben incluirse en el proveedor de sugerencias especificado.

Encabezado de la solicitud

Nombre	Requerido	Tipo	Description
x-ms-client-request-id		string uuid	Identificador de seguimiento enviado con la solicitud para ayudar con la depuración.

Respuestas

Nombre	Tipo	Description
200 OK	AutocompleteResult	Respuesta que contiene los términos de consulta sugeridos que completan la entrada parcial.
Other Status Codes	SearchError	Respuesta de error.

Ejemplos

SearchIndexAutocompleteDocumentsGet

Sample Request

HTTP

GET https://myservice.search.windows.net/indexes('myindex')/docs/search.autocomplete?api-version=2023-11-01&search=washington medic&suggesterName=sg&autocompleteMode=oneTerm&fuzzy=False&highlightPostTag=</em>&highlightPreTag=<em>&minimumCoverage=80&searchFields=title,description

Sample Response

Status code:: 200

[
  {
    "text": "medicaid",
    "queryPlusText": "washington medicaid"
  },
  {
    "text": "medicare",
    "queryPlusText": "washington medicare"
  },
  {
    "text": "medicine",
    "queryPlusText": "washington medicine"
  }
]

Definiciones

Nombre	Description
AutocompleteItem	Resultado de las solicitudes de Autocompletar.
AutocompleteMode	Especifica el modo de Autocompletar. El valor predeterminado es "oneTerm". Use "twoTerms" para obtener shingles y "oneTermWithContext" para usar el contexto actual en la generación de términos de autocompletar.
AutocompleteResult	Resultado de la consulta Autocompletar.
SearchError	Describe una condición de error para la API.

AutocompleteItem

Resultado de las solicitudes de Autocompletar.

Nombre	Tipo	Description
queryPlusText	string	Consulta junto con el término completado.
text	string	El término completado.

AutocompleteMode

Especifica el modo de Autocompletar. El valor predeterminado es "oneTerm". Use "twoTerms" para obtener shingles y "oneTermWithContext" para usar el contexto actual en la generación de términos de autocompletar.

Nombre	Tipo	Description
oneTerm	string	Solo se sugiere un término. Si la consulta tiene dos términos, solo se completa el último término. Por ejemplo, si la entrada es "washington medic", los términos sugeridos podrían incluir "medicaid", "medicare" y "medicine".
oneTermWithContext	string	Completa el último término de una consulta con dos o más términos, donde los dos últimos términos son una frase que existe en el índice. Por ejemplo, si la entrada es "washington medic", los términos sugeridos podrían incluir "washington medicaid" y "washington medical".
twoTerms	string	Se sugerirá la coincidencia de frases de dos términos en el índice. Por ejemplo, si la entrada es "medic", los términos sugeridos podrían incluir "cobertura de medicare" y "asistente médica".

AutocompleteResult

Resultado de la consulta Autocompletar.

Nombre	Tipo	Description
@search.coverage	number	Valor que indica el porcentaje del índice considerado por la solicitud de autocompletar, o null si minimumCoverage no se especificó en la solicitud.
value	AutocompleteItem[]	Lista de elementos autocompletados devueltos.

SearchError

Describe una condición de error para la API.

Nombre	Tipo	Description
code	string	Uno de los conjuntos de códigos de error definidos por el servidor.
details	SearchError[]	Matriz de detalles sobre errores específicos que llevaron a este error notificado.
message	string	Representación legible del error.

Share via