Documents - Autocomplete Get

Servicio:: Search Service

Versión de la API:: 2026-04-01

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

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

Con parámetros opcionales:

GET {endpoint}/indexes('{indexName}')/docs/search.autocomplete?api-version=2026-04-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 (uri)	La dirección URL del punto de conexión del servicio de búsqueda.
indexName	path	True	string	Nombre del índice.
api-version	query	True	string minLength: 1	Versión de la API que se va a usar para esta operación.
search	query	True	string	El término incompleto que debe completarse automáticamente.
suggesterName	query	True	string	Nombre del proveedor de sugerencias tal como se especifica en la colección suggesters que forma parte de la definición de índice.
$filter	query		string	Expresión de OData que filtra los documentos utilizados para generar términos completados para el resultado de Autocompletar.
$top	query		integer (int32)	El número de términos autocompletados 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 herpes zóster y 'oneTermWithContext' para usar el contexto actual mientras produce 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 falso. Cuando se establece en true, la consulta encontrará términos incluso si hay un carácter sustituido o faltante en el texto de búsqueda. Aunque esto proporciona una mejor experiencia en algunos escenarios, tiene un costo de rendimiento, ya que las consultas de autocompletado aproximado 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 golpes está desactivado.
highlightPreTag	query		string	Etiqueta de cadena que se antepone para alcanzar los resaltados. Debe establecerse con highlightPostTag. Si se omite, el resaltado de golpes está desactivado.
minimumCoverage	query		number (double)	Un número entre 0 y 100 que indica el porcentaje del índice que debe cubrir 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[]	La lista de nombres de campo que se deben tener en cuenta al consultar términos autocompletados. Los campos de destino deben incluirse en el sugeridor especificado.

Encabezado de la solicitud

Nombre	Requerido	Tipo	Description
Accept		Accept	El encabezado Aceptar.
x-ms-client-request-id		string (uuid)	Identificador de cadena globalmente único y generado por el cliente para la solicitud.

Respuestas

Nombre	Tipo	Description
200 OK	AutocompleteResult	La solicitud se ha realizado correctamente.
Other Status Codes	ErrorResponse	Una respuesta de error inesperada.

Seguridad

api-key

Tipo: apiKey
En: header

OAuth2Auth

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Ámbitos

Nombre	Description
https://search.azure.com/.default

Ejemplos

SearchIndexAutocompleteDocumentsGet

Solicitud de ejemplo

HTTP

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

Respuesta de muestra

status code:: 200

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

Definiciones

Nombre	Description
Accept	El encabezado Aceptar.
AutocompleteItem	Resultado de las solicitudes autocompletar.
AutocompleteMode	Especifica el modo de Autocompletar. El valor predeterminado es 'oneTerm'. Use 'twoTerms' para obtener herpes zóster y 'oneTermWithContext' para usar el contexto actual en la producción de términos de autocompletar.
AutocompleteResult	Resultado de la consulta Autocompletar.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta común a errores para todas las APIs de Azure Resource Manager para devolver detalles de error por operaciones fallidas. (Esto también sigue el formato de respuesta de error de OData).

Accept

Enumeración

El encabezado Aceptar.

Valor	Description
application/json;odata.metadata=none

AutocompleteItem

Objeto

Resultado de las solicitudes autocompletar.

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

AutocompleteMode

Enumeración

Especifica el modo de Autocompletar. El valor predeterminado es 'oneTerm'. Use 'twoTerms' para obtener herpes zóster y 'oneTermWithContext' para usar el contexto actual en la producción de términos de autocompletar.

Valor	Description
oneTerm	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'.
twoTerms	Se sugerirá hacer coincidir frases de dos términos en el índice. Por ejemplo, si la entrada es 'médico', los términos sugeridos podrían incluir 'cobertura de Medicare' y 'asistente médico'.
oneTermWithContext	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'.

AutocompleteResult

Objeto

Resultado de la consulta Autocompletar.

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

ErrorAdditionalInfo

Objeto

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info		Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Objeto

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Detalles del error.
message	string	El mensaje de error.
target	string	Destino del error.

ErrorResponse

Objeto

Respuesta común a errores para todas las APIs de Azure Resource Manager para devolver detalles de error por operaciones fallidas. (Esto también sigue el formato de respuesta de error de OData).

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.