Compartir a través de

Documents - Autocomplete Post

Servicio:
Search Service
Versión de la API:
2025-09-01

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

POST {endpoint}/indexes('{indexName}')/docs/search.post.autocomplete?api-version=2025-09-01

Parámetros de identificador URI

Nombre En Requerido Tipo Description
endpoint
 path True

string

La 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.

Encabezado de la solicitud

Nombre Requerido Tipo Description
x-ms-client-request-id

string (uuid)

El identificador de seguimiento enviado con la solicitud para ayudar con la depuración.

Cuerpo de la solicitud

Nombre Requerido Tipo Description
search True

string

El texto de búsqueda en el que basar los resultados de autocompletar.
suggesterName True

string

El nombre del proveedor de sugerencias especificado en la colección de sugerencias que forma parte de la definición del índice.
autocompleteMode

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.
filter

string

Expresión de OData que filtra los documentos utilizados para generar términos completados para el resultado de Autocompletar.
fuzzy

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 completará automáticamente los 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

string

Una etiqueta de cadena que se anexa a los resaltados de golpes. Debe establecerse con highlightPreTag. Si se omite, el resaltado de golpes está desactivado.
highlightPreTag

string

Una etiqueta de cadena que se antepone a los aspectos más destacados. Debe establecerse con highlightPostTag. Si se omite, el resaltado de golpes está desactivado.
minimumCoverage

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 servicios con una sola réplica. El valor predeterminado es 80.
searchFields

string

La lista separada por comas 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.
top

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.

Respuestas

Nombre Tipo Description
200 OK

AutocompleteResult

Respuesta que contiene términos de consulta sugeridos que completan la entrada parcial.
Other Status Codes

ErrorResponse

Respuesta de error.

Ejemplos

SearchIndexAutocompleteDocumentsPost

Solicitud de ejemplo

POST https://stableexampleservice.search.windows.net/indexes('stable-test')/docs/search.post.autocomplete?api-version=2025-09-01


{
  "search": "p",
  "autocompleteMode": "oneTerm",
  "filter": "ownerId ne '1'",
  "fuzzy": true,
  "highlightPostTag": "</em>",
  "highlightPreTag": "<em>",
  "minimumCoverage": 80,
  "searchFields": "category, ownerId",
  "suggesterName": "sg",
  "top": 10
}

Respuesta de muestra

status code:
200 
{
  "@search.coverage": 100,
  "value": [
    {
      "text": "purple",
      "queryPlusText": "<em>purple</em>"
    },
    {
      "text": "pink",
      "queryPlusText": "<em>pink</em>"
    }
  ]
}

Definiciones

Nombre Description
AutocompleteItem

El resultado de las solicitudes de 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.
AutocompleteRequest

Parámetros para coincidencias aproximadas y otros comportamientos de consulta de autocompletar.
AutocompleteResult

El resultado de la consulta de Autocompletar.
ErrorAdditionalInfo

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

Detalle del error.
ErrorResponse

Respuesta de error

AutocompleteItem

Object

El resultado de las solicitudes de autocompletar.

Nombre Tipo Description
queryPlusText

string

La consulta junto con el término completado.
text

string

El 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'.

AutocompleteRequest

Object

Parámetros para coincidencias aproximadas y otros comportamientos de consulta de autocompletar.

Nombre Tipo Description
autocompleteMode

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.
filter

string

Expresión de OData que filtra los documentos utilizados para generar términos completados para el resultado de Autocompletar.
fuzzy

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 completará automáticamente los 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

string

Una etiqueta de cadena que se anexa a los resaltados de golpes. Debe establecerse con highlightPreTag. Si se omite, el resaltado de golpes está desactivado.
highlightPreTag

string

Una etiqueta de cadena que se antepone a los aspectos más destacados. Debe establecerse con highlightPostTag. Si se omite, el resaltado de golpes está desactivado.
minimumCoverage

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 servicios con una sola réplica. El valor predeterminado es 80.
search

string

El texto de búsqueda en el que basar los resultados de autocompletar.
searchFields

string

La lista separada por comas 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.
suggesterName

string

El nombre del proveedor de sugerencias especificado en la colección de sugerencias que forma parte de la definición del índice.
top

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.

AutocompleteResult

Object

El resultado de la consulta de Autocompletar.

Nombre Tipo Description
@search.coverage

number (double)

Valor que indica el porcentaje del índice que tuvo en cuenta la solicitud de autocompletar, o null si minimumCoverage no se especificó en la solicitud.
value

AutocompleteItem[]

La lista de elementos autocompletados devueltos.

ErrorAdditionalInfo

Object

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

Nombre Tipo Description
info

object

Información adicional.
type

string

Tipo de información adicional.

ErrorDetail

Object

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

Object

Respuesta de error

Nombre Tipo Description
error

ErrorDetail

Objeto de error.