Indexes - Analyze

Servicio:
Search Service
Versión de la API:
2023-11-01

Muestra cómo un analizador divide el texto en tokens.

POST {endpoint}/indexes('{indexName}')/search.analyze?api-version=2023-11-01

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

Nombre del índice para el que se va a probar un analizador.
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)

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

Cuerpo de la solicitud

Nombre Requerido Tipo Description
text True

string

Texto que se va a dividir en tokens.
analyzer

LexicalAnalyzerName

Nombre del analizador que se va a usar para interrumpir el texto especificado. Si no se especifica este parámetro, debe especificar un tokenizador en su lugar. Los parámetros de tokenizador y analizador son mutuamente excluyentes.
charFilters

CharFilterName[]

Lista opcional de filtros de caracteres que se usarán al interrumpir el texto especificado. Este parámetro solo se puede establecer cuando se usa el parámetro tokenizer.
tokenFilters

TokenFilterName[]

Una lista opcional de filtros de token que se usarán al interrumpir el texto especificado. Este parámetro solo se puede establecer cuando se usa el parámetro tokenizer.
tokenizer

LexicalTokenizerName

Nombre del tokenizador que se va a usar para interrumpir el texto especificado. Si no se especifica este parámetro, debe especificar un analizador en su lugar. Los parámetros de tokenizador y analizador son mutuamente excluyentes.

Respuestas

Nombre Tipo Description
200 OK

AnalyzeResult

Other Status Codes

SearchError

Respuesta de error.

Ejemplos

SearchServiceIndexAnalyze

Solicitud de ejemplo

POST https://myservice.search.windows.net/indexes('hotels')/search.analyze?api-version=2023-11-01

{
  "text": "Text to analyze",
  "analyzer": "standard.lucene"
}

Respuesta de muestra

status code:
200 
{
  "tokens": [
    {
      "token": "text",
      "startOffset": 0,
      "endOffset": 4,
      "position": 0
    },
    {
      "token": "to",
      "startOffset": 5,
      "endOffset": 7,
      "position": 1
    },
    {
      "token": "analyze",
      "startOffset": 8,
      "endOffset": 15,
      "position": 2
    }
  ]
}

Definiciones

Nombre Description
AnalyzedTokenInfo

Información sobre un token devuelto por un analizador.
AnalyzeRequest

Especifica algunos componentes de texto y análisis que se usan para dividir ese texto en tokens.
AnalyzeResult

Resultado de probar un analizador en el texto.
CharFilterName

Define los nombres de todos los filtros de caracteres admitidos por el motor de búsqueda.
LexicalAnalyzerName

Define los nombres de todos los analizadores de texto admitidos por el motor de búsqueda.
LexicalTokenizerName

Define los nombres de todos los tokenizadores admitidos por el motor de búsqueda.
SearchError

Describe una condición de error para la API.
TokenFilterName

Define los nombres de todos los filtros de token admitidos por el motor de búsqueda.

AnalyzedTokenInfo

Objeto

Información sobre un token devuelto por un analizador.

Nombre Tipo Description
endOffset

integer (int32)

Índice del último carácter del token en el texto de entrada.
position

integer (int32)

Posición del token en el texto de entrada en relación con otros tokens. El primer token del texto de entrada tiene la posición 0, la siguiente tiene la posición 1, etc. Dependiendo del analizador usado, algunos tokens podrían tener la misma posición, por ejemplo, si son sinónimos entre sí.
startOffset

integer (int32)

Índice del primer carácter del token en el texto de entrada.
token

string

Token devuelto por el analizador.

AnalyzeRequest

Objeto

Especifica algunos componentes de texto y análisis que se usan para dividir ese texto en tokens.

Nombre Tipo Description
analyzer

LexicalAnalyzerName

Nombre del analizador que se va a usar para interrumpir el texto especificado. Si no se especifica este parámetro, debe especificar un tokenizador en su lugar. Los parámetros de tokenizador y analizador son mutuamente excluyentes.
charFilters

CharFilterName[]

Lista opcional de filtros de caracteres que se usarán al interrumpir el texto especificado. Este parámetro solo se puede establecer cuando se usa el parámetro tokenizer.
text

string

Texto que se va a dividir en tokens.
tokenFilters

TokenFilterName[]

Una lista opcional de filtros de token que se usarán al interrumpir el texto especificado. Este parámetro solo se puede establecer cuando se usa el parámetro tokenizer.
tokenizer

LexicalTokenizerName

Nombre del tokenizador que se va a usar para interrumpir el texto especificado. Si no se especifica este parámetro, debe especificar un analizador en su lugar. Los parámetros de tokenizador y analizador son mutuamente excluyentes.

AnalyzeResult

Objeto

Resultado de probar un analizador en el texto.

Nombre Tipo Description
tokens

AnalyzedTokenInfo[]

Lista de tokens devueltos por el analizador especificado en la solicitud.

CharFilterName

Enumeración

Define los nombres de todos los filtros de caracteres admitidos por el motor de búsqueda.

Valor Description
html_strip

Filtro de caracteres que intenta quitar construcciones HTML. Consulte https://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/charfilter/HTMLStripCharFilter.html

LexicalAnalyzerName

Enumeración

Define los nombres de todos los analizadores de texto admitidos por el motor de búsqueda.

Valor Description
ar.microsoft

Analizador de Microsoft para árabe.
ar.lucene

Analizador de Lucene para árabe.
hy.lucene

Analizador de Lucene para Armenio.
bn.microsoft

Analizador de Microsoft para Bangla.
eu.lucene

Analizador de Lucene para Euskera.
bg.microsoft

Analizador de Microsoft para búlgaro.
bg.lucene

Analizador de Lucene para Búlgaro.
ca.microsoft

Analizador de Microsoft para catalán.
ca.lucene

Analizador de Lucene para Catalán.
zh-Hans.microsoft

Analizador de Microsoft para chino (simplificado).
zh-Hans.lucene

Analizador de Lucene para chino (simplificado).
zh-Hant.microsoft

Analizador de Microsoft para chino (tradicional).
zh-Hant.lucene

Analizador de Lucene para chino (tradicional).
hr.microsoft

Analizador de Microsoft para croata.
cs.microsoft

Analizador de Microsoft para Checo.
cs.lucene

Analizador de Lucene para Checo.
da.microsoft

Analizador de Microsoft para danés.
da.lucene

Analizador de Lucene para danés.
nl.microsoft

Analizador de Microsoft para neerlandés.
nl.lucene

Analizador de Lucene para neerlandés.
en.microsoft

Analizador de Microsoft para inglés.
en.lucene

Analizador de Lucene para inglés.
et.microsoft

Analizador de Microsoft para Estonia.
fi.microsoft

Analizador de Microsoft para finés.
fi.lucene

Analizador de Lucene para finés.
fr.microsoft

Analizador de Microsoft para francés.
fr.lucene

Analizador de Lucene para francés.
gl.lucene

Analizador de Lucene para Gallega.
de.microsoft

Analizador de Microsoft para alemán.
de.lucene

Analizador de Lucene para alemán.
el.microsoft

Analizador de Microsoft para griego.
el.lucene

Analizador de Lucene para griego.
gu.microsoft

Analizador de Microsoft para Gujarati.
he.microsoft

Analizador de Microsoft para hebreo.
hi.microsoft

Analizador de Microsoft para hindi.
hi.lucene

Analizador de Lucene para hindi.
hu.microsoft

Analizador de Microsoft para húngaro.
hu.lucene

Analizador de Lucene para húngaro.
is.microsoft

Analizador de Microsoft para Islandés.
id.microsoft

Analizador de Microsoft para Indonesia (Bahasa).
id.lucene

Analizador de Lucene para Indonesia.
ga.lucene

Analizador de Lucene para irlandés.
it.microsoft

Analizador de Microsoft para italiano.
it.lucene

Analizador de Lucene para italiano.
ja.microsoft

Analizador de Microsoft para japonés.
ja.lucene

Analizador de Lucene para japonés.
kn.microsoft

Analizador de Microsoft para Kannada.
ko.microsoft

Analizador de Microsoft para coreano.
ko.lucene

Analizador de Lucene para coreano.
lv.microsoft

Analizador de Microsoft para Letonia.
lv.lucene

Analizador de Lucene para Letón.
lt.microsoft

Analizador de Microsoft para Lituano.
ml.microsoft

Analizador de Microsoft para Malayalam.
ms.microsoft

Analizador de Microsoft para malayo (latino).
mr.microsoft

Analizador de Microsoft para Marathi.
nb.microsoft

Analizador de Microsoft para noruego (Bokmål).
no.lucene

Analizador de Lucene para Noruego.
fa.lucene

Analizador de Lucene para persa.
pl.microsoft

Analizador de Microsoft para polaco.
pl.lucene

Analizador de Lucene para polaco.
pt-BR.microsoft

Analizador de Microsoft para portugués (Brasil).
pt-BR.lucene

Analizador de Lucene para portugués (Brasil).
pt-PT.microsoft

Analizador de Microsoft para portugués (Portugal).
pt-PT.lucene

Analizador de Lucene para portugués (Portugal).
pa.microsoft

Analizador de Microsoft para Punjabi.
ro.microsoft

Analizador de Microsoft para rumano.
ro.lucene

Analizador de Lucene para rumano.
ru.microsoft

Analizador de Microsoft para ruso.
ru.lucene

Analizador de Lucene para ruso.
sr-cyrillic.microsoft

Analizador de Microsoft para serbio (cirílico).
sr-latin.microsoft

Analizador de Microsoft para serbio (latino).
sk.microsoft

Analizador de Microsoft para Eslovaco.
sl.microsoft

Analizador de Microsoft para esloveno.
es.microsoft

Analizador de Microsoft para español.
es.lucene

Analizador de Lucene para español.
sv.microsoft

Analizador de Microsoft para sueco.
sv.lucene

Analizador de Lucene para sueco.
ta.microsoft

Analizador de Microsoft para Tamil.
te.microsoft

Analizador de Microsoft para Telugu.
th.microsoft

Analizador de Microsoft para tailandés.
th.lucene

Analizador de Lucene para Tailandés.
tr.microsoft

Analizador de Microsoft para turco.
tr.lucene

Analizador de Lucene para turco.
uk.microsoft

Analizador de Microsoft para Ucrania.
ur.microsoft

Analizador de Microsoft para Urdu.
vi.microsoft

Analizador de Microsoft para vietnamita.
standard.lucene

Analizador estándar de Lucene.
standardasciifolding.lucene

Analizador estándar de Lucene plegado ASCII. Consulte https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search#Analyzers
keyword

Trata todo el contenido de un campo como un solo token. Esto es útil para datos como códigos postales, identificadores y algunos nombres de producto. Consulte http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/KeywordAnalyzer.html
pattern

Separa de forma flexible el texto en términos a través de un patrón de expresión regular. Consulte http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/PatternAnalyzer.html
simple

Divide el texto en minúsculas y los convierte en minúsculas. Consulte http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/SimpleAnalyzer.html
stop

Divide el texto en letras no letras; Aplica los filtros de token en minúsculas y palabras irrelevantes. Consulte http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/StopAnalyzer.html
whitespace

Analizador que usa el tokenizador de espacio en blanco. Consulte http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/WhitespaceAnalyzer.html

LexicalTokenizerName

Enumeración

Define los nombres de todos los tokenizadores admitidos por el motor de búsqueda.

Valor Description
classic

Tokenizador basado en gramática que es adecuado para procesar la mayoría de los documentos de idioma europeo. Consulte http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/standard/ClassicTokenizer.html
edgeNGram

Tokeniza la entrada de un borde en n gramos de los tamaños especificados. Consulte https://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ngram/EdgeNGramTokenizer.html
keyword_v2

Emite toda la entrada como un solo token. Consulte http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/KeywordTokenizer.html
letter

Divide el texto en no letras. Consulte http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/LetterTokenizer.html
lowercase

Divide el texto en minúsculas y los convierte en minúsculas. Consulte http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/LowerCaseTokenizer.html
microsoft_language_tokenizer

Divide el texto mediante reglas específicas del idioma.
microsoft_language_stemming_tokenizer

Divide el texto mediante reglas específicas del idioma y reduce las palabras a sus formularios base.
nGram

Tokeniza la entrada en n-gramas de los tamaños especificados. Consulte http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ngram/NGramTokenizer.html
path_hierarchy_v2

Tokenizador para jerarquías similares a la ruta de acceso. Consulte http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/path/PathHierarchyTokenizer.html
pattern

Tokenizer que usa la coincidencia de patrones regex para construir tokens distintos. Consulte http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/pattern/PatternTokenizer.html
standard_v2

Analizador estándar de Lucene; Compuesto por el tokenizador estándar, el filtro en minúsculas y el filtro stop. Consulte http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/standard/StandardTokenizer.html
uax_url_email

Tokeniza las direcciones URL y los correos electrónicos como un token. Consulte http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/standard/UAX29URLEmailTokenizer.html
whitespace

Divide el texto en espacios en blanco. Consulte http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/WhitespaceTokenizer.html

SearchError

Objeto

Describe una condición de error para la API.

Nombre Tipo Description
code

string

Uno de un conjunto definido por el servidor de códigos de error.
details

SearchError[]

Matriz de detalles sobre errores específicos que llevaron a este error notificado.
message

string

Representación legible del error.

TokenFilterName

Enumeración

Define los nombres de todos los filtros de token admitidos por el motor de búsqueda.

Valor Description
arabic_normalization

Filtro de token que aplica el normalizador árabe para normalizar la ortografía. Consulte http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ar/ArabicNormalizationFilter.html
apostrophe

Tira todos los caracteres después de un apóstrofo (incluido el apóstrofo en sí). Consulte http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/tr/ApostropheFilter.html
asciifolding

Convierte caracteres alfabéticos, numéricos y simbólicos Unicode que no están en los primeros 127 caracteres ASCII (el bloque Unicode "Básico latino") en sus equivalentes ASCII, si existen dichos equivalentes. Consulte http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/ASCIIFoldingFilter.html
cjk_bigram

Forma bigrams de términos de CJK que se generan a partir del tokenizador estándar. Consulte http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/cjk/CJKBigramFilter.html
cjk_width

Normaliza las diferencias de ancho de CJK. Plega las variantes ASCII de fullwidth en el latino básico equivalente y las variantes katakana de ancho medio en el kana equivalente. Consulte http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/cjk/CJKWidthFilter.html
classic

Quita los posesivos en inglés y los puntos de los acrónimos. Consulte http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/standard/ClassicFilter.html
common_grams

Construya bigrams para términos que se producen con frecuencia durante la indexación. Los términos únicos todavía se indexan también, con bigrams superpuestos. Consulte http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/commongrams/CommonGramsFilter.html
edgeNGram_v2

Genera n-gramas de los tamaños especificados a partir de la parte delantera o posterior de un token de entrada. Consulte http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ngram/EdgeNGramTokenFilter.html
elision

Quita las elisiones. Por ejemplo, "l'avion" (el plano) se convertirá en "avion" (plano). Consulte http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/util/ElisionFilter.html
german_normalization

Normaliza los caracteres alemanes según la heurística del algoritmo de bola de nieve alemán2. Consulte http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/de/GermanNormalizationFilter.html
hindi_normalization

Normaliza el texto en hindi para eliminar algunas diferencias en las variaciones ortográficas. Consulte http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/hi/HindiNormalizationFilter.html
indic_normalization

Normaliza la representación Unicode del texto en idiomas indios. Consulte http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/in/IndicNormalizationFilter.html
keyword_repeat

Emite cada token entrante dos veces, una como palabra clave y una vez como palabra clave no clave. Consulte http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/KeywordRepeatFilter.html
kstem

Filtro kstem de alto rendimiento para inglés. Consulte http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/en/KStemFilter.html
length

Quita las palabras que son demasiado largas o demasiado cortas. Consulte http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/LengthFilter.html
limit

Limita el número de tokens durante la indexación. Consulte http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/LimitTokenCountFilter.html
lowercase

Normaliza el texto del token en minúsculas. Consulte http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/LowerCaseFilter.htm
nGram_v2

Genera n-gramas de los tamaños especificados. Consulte http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ngram/NGramTokenFilter.html
persian_normalization

Aplica la normalización para persa. Consulte http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/fa/PersianNormalizationFilter.html
phonetic

Cree tokens para coincidencias fonéticas. Consulte https://lucene.apache.org/core/4_10_3/analyzers-phonetic/org/apache/lucene/analysis/phonetic/package-tree.html
porter_stem

Usa el algoritmo de lematización porter para transformar la secuencia de tokens. Consulte http://tartarus.org/~martin/PorterStemmer
reverse

Invierte la cadena del token. Consulte http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/reverse/ReverseStringFilter.html
scandinavian_normalization

Normaliza el uso de los caracteres escandinavos intercambiables. Consulte http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/ScandinavianNormalizationFilter.html
scandinavian_folding

Dobla caracteres escandinavos åÅäæÄÆ->a y öÖøØ->o. También discrimina el uso de vocales dobles aa, ae, ao, oe y oo, dejando solo el primero. Consulte http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/ScandinavianFoldingFilter.html
shingle

Crea combinaciones de tokens como un único token. Consulte http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/shingle/ShingleFilter.html
snowball

Filtro que deriva las palabras mediante un lematizador generado por Snowball. Consulte http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/snowball/SnowballFilter.html
sorani_normalization

Normaliza la representación Unicode del texto Sorani. Consulte http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ckb/SoraniNormalizationFilter.html
stemmer

Filtro de lematización específico del idioma. Consulte https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search#TokenFilters
stopwords

Quita las palabras irrelevantes de una secuencia de tokens. Consulte http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/StopFilter.html
trim

Recorta el espacio en blanco inicial y final de los tokens. Consulte http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/TrimFilter.html
truncate

Trunca los términos a una longitud específica. Consulte http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/TruncateTokenFilter.html
unique

Filtra los tokens con el mismo texto que el token anterior. Consulte http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/RemoveDuplicatesTokenFilter.html
uppercase

Normaliza el texto del token en mayúsculas. Consulte http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/UpperCaseFilter.html
word_delimiter

Divide palabras en subpalabras y realiza transformaciones opcionales en grupos de subwords.