Devuelve todos los índices de Atlas Search en la colección especificada. Los índices de Atlas Search contienen los campos indexados y los analizadores utilizados para crear los índices.
string única de 24dígitos hexadecimales que identifica tu proyecto. Usa el endpoint /groups para recuperar todos los proyectos a los que el usuario autenticado tiene acceso.
NOTA: Grupos y proyectos son términos sinónimos. El id de tu grupo es el mismo que el id de tu proyecto. Para los grupos ya existentes, el id de su grupo/proyecto sigue siendo el mismo. El recurso y los endpoints correspondientes utilizan el término grupos.
El formato debe coincidir con el siguiente patrón: ^([a-f0-9]{24})$.
Nombre del clúster que contiene la colección con uno o más índices de Atlas Search.
El formato debe coincidir con el siguiente patrón: ^[a-zA-Z0-9][a-zA-Z0-9-]*$.
Nombre de la colección que contiene uno o más índices de búsqueda de Atlas.
Etiqueta legible por humanos que identifica la base de datos que contiene la colección con uno o más índices de búsqueda de Atlas.
Bandera que indica si la aplicación envuelve la respuesta en un objeto JSON envelope. Algunos clientes de la API no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para remediar esto, establece envelope=true en la query. Los endpoints que devuelven una lista de resultados utilizan el objeto de resultados como un sobre. La aplicación agrega el parámetro de estado al cuerpo de la respuesta.
El valor por defecto es false.
Bandera que indica si el cuerpo de la respuesta debe estar en el formato prettyprint.
El valor por defecto es false.
OK
Etiqueta legible por humanos que identifica la colección que contiene uno o más índices de búsqueda de Atlas.
Etiqueta legible por humanos que identifica la base de datos que contiene la colección con uno o más índices de búsqueda de Atlas.
Etiqueta legible por humanos que identifica este índice. Dentro de cada namespace, los nombres de todos los índices en ese namespace deben ser únicos.
Número de particiones de índices. Los valores permitidos son [1, 2, 4].
El valor por defecto es 1.
Indicador que indica si se deben almacenar todos los campos (true) en Atlas Search. Por defecto, Atlas no almacena (false) los campos en Atlas Search. Alternativamente, puedes especificar un objeto que solo contenga la lista de campos que se deben almacenar (incluir) o que no se deben almacenar (excluir) en Atlas Search. Tenga en cuenta que no se permite almacenar todos los campos (verdadero) para los índices de búsqueda vectorial. Para aprender más, consulte la documentación.
Tipo de índice. El tipo por defecto es búsqueda.
El valor es search.
Método predefinido específico elegido para convertir el texto del campo de la base de datos en palabras que se puedan buscar. Esta conversión reduce el texto de los campos a las unidades más pequeñas de texto. Estas unidades se denominan un término o token. Este proceso, conocido como tokenización, implica una variedad de cambios realizados en el texto dentro de los campos:
Los valores son lucene.standard, lucene.simple, lucene.whitespace, lucene.keyword, lucene.arabic, lucene.armenian, lucene.basque, lucene.bengali, lucene.brazilian, lucene.bulgarian, lucene.catalan, lucene.chinese, lucene.cjk, lucene.czech, lucene.danish, lucene.dutch, lucene.english, lucene.finnish, lucene.french, lucene.galician, lucene.german, lucene.greek, lucene.hindi, lucene.hungarian, lucene.indonesian, lucene.irish, lucene.italian, lucene.japanese, lucene.korean, lucene.kuromoji, lucene.latvian, lucene.lithuanian, lucene.morfologik, lucene.nori, lucene.norwegian, lucene.persian, lucene.portuguese, lucene.romanian, lucene.russian, lucene.smartcn, lucene.sorani, lucene.spanish, lucene.swedish, lucene.thai, lucene.turkish o lucene.ukrainian. El valor por defecto es lucene.standard.
Lista de métodos definidos por el usuario para convertir el texto de los campos de base de datos en palabras que se pueden buscar.
Configuraciones que describen un analizador personalizado de Atlas Search.
Filtros que examinan texto un carácter a la vez y realizan operaciones de filtrado.
Filtro que elimina los elementos HTML.
Filtro que procesa texto normalizado con el Normalizador ICU. Se basa en ICUNormalizer2CharFilter de Lucene.
Filtro que aplica asignaciones de normalización que se especifican a los caracteres.
Lista de mapeos separados por comas. Una asignación indica que un carácter o grupo de caracteres debe ser sustituido por otro, utilizando el siguiente formato:
<original> : <replacement>.
Etiqueta legible por humanos que identifica este tipo de filtro de caracteres.
El valor es mapping.
Un filtro que reemplaza las instancias de un separador de ancho cero por un espacio ordinario. Está basado en el filtro PersianCharFilter de Lucene.
Nombre legible por humanos que identifica el analizador personalizado. Los nombres deben ser únicos dentro de un índice y no deben comenzar con ninguna de las siguientes cadenas:
lucene.builtin.mongodb.Filtro que realiza operaciones tales como:
Stemming, que reduce palabras relacionadas, como "talking", "talked" y "talks", a su palabra raíz "talk".
La restricción, la eliminación de información sensible de documentos públicos.
Filtro que convierte los caracteres Unicode alfabéticos, numéricos y simbólicos que no se encuentran en el bloque Unicode latino básico en sus equivalentes ASCII, si están disponibles.
Valor que indica si se debe incluir u omitir los tokens originales en la salida del filtro de tokens.
Elige include si quieres admitir consultas tanto en los tokens originales como en las formas convertidas.
Elija omit si desea query solo las formas convertidas de los tokens originales.
Los valores son omit o include. El valor por defecto es omit.
Etiqueta legible por humanos que identifica este tipo de filtro de token.
El valor es asciiFolding.
Filtro que crea tokens para palabras que suenan igual basado en el algoritmo fonético Daitch-Mokotoff Soundex. Este filtro puede generar varias codificaciones para cada entrada, donde cada token codificado es un número de 6 dígitos.
NOTA: No utilices el filtro de tokens de daitchMokotoffSoundex en:
-Definiciones de sinónimos o mapeo de autocompletar
Valor que indica si se debe incluir u omitir los tokens originales en la salida del filtro de tokens.
Elige include si quieres admitir consultas tanto en los tokens originales como en las formas convertidas.
Elija omit si desea query solo las formas convertidas de los tokens originales.
Los valores son omit o include. El valor por defecto es include.
Etiqueta legible por humanos que identifica este tipo de filtro de token.
El valor es daitchMokotoffSoundex.
Filtro que divide la entrada desde el lado izquierdo, o «borde», de una entrada de texto en n-gramas de tamaños configurados. No se puede utilizar este filtro de tokens en las definiciones de mapeo de sinónimos o de autocompletado.
Valor que especifica la longitud máxima de los n-grams generados. Este valor debe ser mayor o igual a minGram.
Valor que especifica la longitud mínima de los n-gramas generados. Este valor debe ser menor o igual a maxGram.
Valor que indica si se deben indexar tokens más cortos que minGram o más largos que maxGram.
Los valores son omit o include. El valor por defecto es omit.
Etiqueta legible por humanos que identifica este tipo de filtro de token.
El valor es edgeGram.
Filtro que remueve posesivos (finales 's) de las palabras.
Filtro que transforma un grafo de filtro de tokens, como el grafo de filtro de tokens que produce el filtro de tokens wordDelimiterGraph, en una forma plana adecuada para la indexación.
Filtro que aplica la conversión de caracteres del Informe Técnico de Unicode n.º30.
Filtro que normaliza los tokens usando un modo estándar de normalización Unicode.
Filtro que combina la derivación algorítmica con un diccionario incorporado para el lenguaje inglés para obtener la raíz de las palabras.
Filtro que remueve los tokens que son demasiado cortos o demasiado largos.
Número que especifica la longitud máxima de un token. El valor debe ser mayor o igual a min.
El valor por defecto es 255.
Número que especifica la longitud mínima de un token. Este valor debe ser menor o igual al máximo.
El valor por defecto es 0.
Etiqueta legible por humanos que identifica este tipo de filtro de token.
El valor es length.
Filtro que normaliza el texto del token a minúsculas.
Filtro que tokeniza la entrada en n-gramas de tamaños configurados. No se puede utilizar este filtro de tokens en las definiciones de mapeo de sinónimos o de autocompletado.
Valor que especifica la longitud máxima de los n-grams generados. Este valor debe ser mayor o igual a minGram.
Valor que especifica la longitud mínima de los n-gramas generados. Este valor debe ser menor o igual a maxGram.
Valor que indica si se deben indexar tokens más cortos que minGram o más largos que maxGram.
Los valores son omit o include. El valor por defecto es omit.
Etiqueta legible por humanos que identifica este tipo de filtro de token.
El valor es nGram.
Filtro que utiliza el algoritmo de stemming porter para remover los sufijos morfológicos e inflexionales comunes de las palabras en inglés. Espera texto en minúscula y no funciona como se espera para texto en mayúscula.
Filtro que aplica una expresión regular a cada token, reemplazando las coincidencias por una string especificada.
Valor que indica si se debe reemplazar únicamente el primer patrón coincidente o todos los patrones coincidentes.
Los valores son all o first.
Patrón de expresión regular que se aplicará a cada token.
string de reemplazo para sustituir dondequiera que ocurra un patrón coincidente.
Etiqueta legible por humanos que identifica este tipo de filtro de token.
El valor es regex.
Filtro que invierte cada token de string.
Filtro que construye "shingles" (n-gramas de tokens) a partir de una serie de tokens. No se puede utilizar este filtro de tokens en las definiciones de mapeo de sinónimos o de autocompletado.
Valor que especifica el número máximo de fichas por tejuelo. Este valor debe ser mayor o igual a minShingleSize.
Valor que especifica el número mínimo de tokens por fragmento. Este valor debe ser menor o igual a maxShingleSize.
Etiqueta legible por humanos que identifica este tipo de filtro de token.
El valor es shingle.
Filtro que deriva tokens utilizando un stemmer generado por Snowball.
Stemmer generado por Snowball para usar.
Los valores son arabic, armenian, basque, catalan, danish, dutch, english, finnish, french, german, german2, hungarian, irish, italian, kp, lithuanian, lovins, norwegian, porter, portuguese, romanian, russian, spanish, swedish o turkish.
Etiqueta legible por humanos que identifica este tipo de filtro de token.
El valor es snowballStemming.
Filtro que elimina la raíz de las palabras pluralizadas en español. Espera texto en minúsculas.
filtro que utiliza la tabla por defecto del stemmer de Polaco de Lucene para identificar la raíz de la palabra en lenguaje. Espera texto en minúsculas.
Filtro que remueve los tokens que corresponden a las palabras irrelevantes especificadas. Este filtro de token no analiza las stop words que se especifiquen.
Bandera que indica si se debe ignorar el caso de las palabras de detención al filtrar los tokens a remover.
El valor por defecto es true.
Las palabras vacías que corresponden a los tokens a remover. El valor debe ser una o más palabras vacías.
Etiqueta legible por humanos que identifica este tipo de filtro de token.
El valor es stopword.
Filtro que recorta los espacios en blanco al principio y al final de los tokens.
Filtro que divide los tokens en sub-tokens en función de reglas configuradas.
Objeto que contiene las reglas que determinan cómo dividir palabras en subpalabras.
Indicador que indica si se deben concatenar ejecuciones.
El valor por defecto es false.
Indicador que señala si se deben concatenar secuencias de sub-números.
El valor por defecto es false.
Indicador que indica si se deben concatenar series de subpalabras.
El valor por defecto es false.
Indicador que indica si se deben dividir los tokens en función de subnúmeros. Por ejemplo, si true, esta opción divide 100-2 en 100 y 2.
El valor por defecto es true.
Indicador que señala si se deben dividir los tokens en función de subpalabras.
El valor por defecto es true.
Indicador que señala si se omiten los tokens que tienen el atributo keyword establecido como true.
El valor por defecto es false.
Indicador que indica si se deben generar tokens de las palabras originales.
El valor por defecto es true.
Indicador que indica si se deben dividir los tokens según las transiciones de mayúsculas y minúsculas.
El valor por defecto es true.
Indicador que determina si se debe realizar la división de tokens en función de las transiciones entre letras y números.
El valor por defecto es true.
Marca que indica si se deben remover los posesivos finales de cada subpalabra.
El valor por defecto es true.
Objeto que contiene opciones para palabras protegidas.
Etiqueta legible por humanos que identifica este tipo de filtro de token.
El valor es wordDelimiterGraph.
El tokenizador que desea utilizar para crear tokens. Los tokens determinan cómo Atlas Search divide el texto en fragmentos independientes para su indexación.
Tokenizador que divide la entrada desde el lado izquierdo o "borde" de una entrada de texto en n-gramas de tamaños dados. No puedes utilizar el tokenizador edgeGram en las definiciones de mapeo de sinónimos o autocompletado.
Caracteres que se incluirán en el token más largo que crea Atlas Search.
Caracteres que se deben incluir en el token más corto que crea Atlas Search.
etiqueta legible por humanos que identifica este tipo de tokenizador.
El valor es edgeGram.
Tokenizador que combina toda la entrada en un único token.
tokenizador que divide la entrada en fragmentos de texto, o "n-grams", de los tamaños dados. No se puede utilizar el tokenizador nGram en la definición de sinonimia o autocompletado.
Caracteres que se incluirán en el token más largo que crea Atlas Search.
Caracteres que se deben incluir en el token más corto que crea Atlas Search.
etiqueta legible por humanos que identifica este tipo de tokenizador.
Tokenizador que utiliza un patrón de expresión regular para extraer fichas.
Índice del grupo de caracteres dentro de la expresión coincidente que se van a extraer en tokens. Utilice 0 para extraer todos los grupos de caracteres.
Expresión regular para coincidir.
etiqueta legible por humanos que identifica este tipo de tokenizador.
El valor es regexCaptureGroup.
Tokenizador que divide los tokens utilizando un delimitador basado en expresiones regulares.
Tokenizador que divide tokens en función de las reglas de corte de palabras del algoritmo de segmentación de texto Unicode.
Número máximo de caracteres en un solo token. Los tokens que excedan esta longitud se dividirán en varios tokens en esa longitud.
El valor por defecto es 255.
etiqueta legible por humanos que identifica este tipo de tokenizador.
El valor es standard.
Tokenizador que crea tokens a partir de URLs y direcciones de correo electrónico. Aunque este tokenizador utiliza reglas de separación de palabras del algoritmo de Segmentación de texto Unicode, recomendamos usarlo únicamente cuando el valor del campo indexado incluya URLs y direcciones de correo electrónico. Para los campos que no incluyen URLs ni direcciones de correo electrónico, utiliza el tokenizador estándar para crear tokens basados en reglas de separación de palabras.
Número máximo de caracteres en un solo token. Los tokens que excedan esta longitud se dividirán en varios tokens en esa longitud.
El valor por defecto es 255.
etiqueta legible por humanos que identifica este tipo de tokenizador.
El valor es uaxUrlEmail.
Tokenizador que crea tokens en función de la aparición de espacios en blanco entre palabras.
Número máximo de caracteres en un solo token. Los tokens que excedan esta longitud se dividirán en varios tokens en esa longitud.
El valor por defecto es 255.
etiqueta legible por humanos que identifica este tipo de tokenizador.
El valor es whitespace.
Especificaciones del índice para los campos de la colección.
Bandera que indica si el índice utiliza asignaciones dinámicas o estáticas. Requerido si se omite mappings.campos.
El valor por defecto es false.
Una o más especificaciones de campo para el índice Atlas Search. Obligatorio si mappings.dynamic se omite o se establece en false.
Método aplicado para identificar palabras al buscar en este índice.
Los valores son lucene.standard, lucene.simple, lucene.whitespace, lucene.keyword, lucene.arabic, lucene.armenian, lucene.basque, lucene.bengali, lucene.brazilian, lucene.bulgarian, lucene.catalan, lucene.chinese, lucene.cjk, lucene.czech, lucene.danish, lucene.dutch, lucene.english, lucene.finnish, lucene.french, lucene.galician, lucene.german, lucene.greek, lucene.hindi, lucene.hungarian, lucene.indonesian, lucene.irish, lucene.italian, lucene.japanese, lucene.korean, lucene.kuromoji, lucene.latvian, lucene.lithuanian, lucene.morfologik, lucene.nori, lucene.norwegian, lucene.persian, lucene.portuguese, lucene.romanian, lucene.russian, lucene.smartcn, lucene.sorani, lucene.spanish, lucene.swedish, lucene.thai, lucene.turkish o lucene.ukrainian. El valor por defecto es lucene.standard.
Conjuntos de reglas que mapean palabras a sus sinónimos en este índice.
Sinónimos utilizados para este índice de texto completo.
Método específico predefinido elegido para aplicar a los sinónimos que se van a buscar.
Los valores son lucene.standard, lucene.simple, lucene.whitespace, lucene.keyword, lucene.arabic, lucene.armenian, lucene.basque, lucene.bengali, lucene.brazilian, lucene.bulgarian, lucene.catalan, lucene.chinese, lucene.cjk, lucene.czech, lucene.danish, lucene.dutch, lucene.english, lucene.finnish, lucene.french, lucene.galician, lucene.german, lucene.greek, lucene.hindi, lucene.hungarian, lucene.indonesian, lucene.irish, lucene.italian, lucene.japanese, lucene.korean, lucene.kuromoji, lucene.latvian, lucene.lithuanian, lucene.morfologik, lucene.nori, lucene.norwegian, lucene.persian, lucene.portuguese, lucene.romanian, lucene.russian, lucene.smartcn, lucene.sorani, lucene.spanish, lucene.swedish, lucene.thai, lucene.turkish o lucene.ukrainian.
Etiqueta legible por humanos que identifica la definición del sinónimo. Cada synonym.name debe ser único dentro de la misma definición de índice.
Conjunto de datos que almacena la asignación de una o más palabras a uno o más sinónimos de esas palabras.
Etiqueta legible por humanos que identifica la colección que contiene uno o más índices de búsqueda de Atlas.
Etiqueta legible por humanos que identifica la base de datos que contiene la colección con uno o más índices de búsqueda de Atlas.
Etiqueta legible por humanos que identifica este índice. Dentro de cada namespace, los nombres de todos los índices en ese namespace deben ser únicos.
Número de particiones de índices. Los valores permitidos son [1, 2, 4].
El valor por defecto es 1.
Indicador que indica si se deben almacenar todos los campos (true) en Atlas Search. Por defecto, Atlas no almacena (false) los campos en Atlas Search. Alternativamente, puedes especificar un objeto que solo contenga la lista de campos que se deben almacenar (incluir) o que no se deben almacenar (excluir) en Atlas Search. Tenga en cuenta que no se permite almacenar todos los campos (verdadero) para los índices de búsqueda vectorial. Para aprender más, consulte la documentación.
Tipo de índice. El tipo por defecto es búsqueda.
El valor es vectorSearch.
Configuración que determina los campos, uno por objeto, para indexar. Debes definir al menos un campo de tipo "vector". También puede definir opcionalmente campos de tipo "filtro".
Ruta de nivel superior al arreglo que contiene campos vectoriales. Cuando se proporcionan, los campos de vectores bajo esta ruta se consideran anidados.
No autorizado.
Detalle de solicitud incorrecta.
Describe todas las infracciones en una solicitud de cliente.
Describe las condiciones o razones específicas que causan cada tipo de error.
Código de estado HTTP devuelto con este error.
El código de error de la aplicación se devuelve con este error.
Parámetros utilizados para proporcionar más información sobre el error.
El mensaje de error de la aplicación se devuelve con este error.
Forbidden.
Detalle de solicitud incorrecta.
Describe todas las infracciones en una solicitud de cliente.
Describe las condiciones o razones específicas que causan cada tipo de error.
Código de estado HTTP devuelto con este error.
El código de error de la aplicación se devuelve con este error.
Parámetros utilizados para proporcionar más información sobre el error.
El mensaje de error de la aplicación se devuelve con este error.
No se ha encontrado.
Detalle de solicitud incorrecta.
Describe todas las infracciones en una solicitud de cliente.
Describe las condiciones o razones específicas que causan cada tipo de error.
Código de estado HTTP devuelto con este error.
El código de error de la aplicación se devuelve con este error.
Parámetros utilizados para proporcionar más información sobre el error.
El mensaje de error de la aplicación se devuelve con este error.
Error interno del servidor.
Detalle de solicitud incorrecta.
Describe todas las infracciones en una solicitud de cliente.
Describe las condiciones o razones específicas que causan cada tipo de error.
Código de estado HTTP devuelto con este error.
El código de error de la aplicación se devuelve con este error.
Parámetros utilizados para proporcionar más información sobre el error.
El mensaje de error de la aplicación se devuelve con este error.
curl \
--request GET 'https://cloud.mongodb.com/api/atlas/v1.0/groups/32b6e34b3d91647abb20e7b8/clusters/{clusterName}/fts/indexes/{databaseName}/{collectionName}' \
--header "Authorization: Bearer $ACCESS_TOKEN"[
{
"collectionName": "string",
"database": "string",
"name": "string",
"numPartitions": 1,
"storedSource": {
"include | exclude": [
"field1",
"field2"
]
},
"type": "search",
"analyzer": "lucene.standard",
"analyzers": [
{
"charFilters": [
{
"ignoredTags": [
"string"
],
"type": "htmlStrip"
}
],
"name": "string",
"tokenFilters": [
{
"originalTokens": "omit",
"type": "asciiFolding"
}
],
"tokenizer": {
"maxGram": 42,
"minGram": 42,
"type": "edgeGram"
}
}
],
"mappings": {
"dynamic": false,
"fields": {
"additionalProperty1": {},
"additionalProperty2": {}
}
},
"searchAnalyzer": "lucene.standard",
"synonyms": [
{
"analyzer": "lucene.standard",
"name": "string",
"source": {
"collection": "string"
}
}
]
}
]{
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"error": 401,
"errorCode": "NOT_ORG_GROUP_CREATOR",
"reason": "Unauthorized"
}{
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"error": 403,
"errorCode": "CANNOT_CHANGE_GROUP_NAME",
"reason": "Forbidden"
}{
"detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
"error": 404,
"errorCode": "RESOURCE_NOT_FOUND",
"reason": "Not Found"
}{
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"error": 500,
"errorCode": "UNEXPECTED_ERROR",
"reason": "Internal Server Error"
}