Retornar todos os analisadores definidos pelo usuário para um cluster

OBTER /api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/fts/analyzers
Contas de serviço DigestAuth

Retorna todos os analisadores personalizados do Atlas Search que o cluster especificado utiliza no projeto especificado. Os analisadores personalizados definem as operações a serem executadas para indexar um campo. Para usar esse recurso, a conta de serviço ou a chave de API solicitante deve ter a role de leitura e gravação do projeto de acesso a dados.

Analisadores personalizados

parâmetros de caminho

  • groupId string Obrigatório

    Sequência única 24de dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso.

    AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID do seu projeto. Para grupos existentes, o ID do grupo/projeto permanece o mesmo. O recurso e os endpoints correspondentes usam o termo grupos.

    O formato deve corresponder ao seguinte padrão: ^([a-f0-9]{24})$.

  • clusterName string Obrigatório

    Nome do cluster que contém a coleção com um ou mais índices do Atlas Search.

    O formato deve corresponder ao seguinte padrão: ^[a-zA-Z0-9][a-zA-Z0-9-]*$.

parâmetros de query

  • envelope booleano

    Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON envelope. Alguns clientes de API não podem acessar os cabeçalhos de resposta HTTP ou o código de status. Para corrigir isso, defina envelope=true na consulta. Os endpoints que retornam uma lista de resultados usam o objeto de resultados como um envelope. O aplicativo adiciona o parâmetro de status ao corpo da resposta.

    O valor padrão é false.

  • pretty booleano

    Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint.

    O valor padrão é false.

    Prettyprint

Respostas

  • 200 aplicação/json

    OK

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • caracteresFilters array[objeto]

      Filtros que examinam o texto de um caractere de cada vez e executam operações de filtragem.

      Um dos seguintes:
      objeto chartFilterhtmlStrip objeto chartFiltericuNormalize objeto de mapeamento do filtro objeto chartFilterpersian
    • name string Obrigatório

      Nome legível por humanos que identifica o analisador personalizado. Os nomes devem ser únicos dentro de um índice e não devem começar com nenhuma das seguintes strings:

      • lucene.
      • builtin.
      • mongodb.
    • Filtros de token array[objeto]

      Filtro que executa operações como:

      • Stemming, que reduz palavras relacionadas, como "falar", "falou" e "fala" à sua palavra raiz "falar".

      • Redação, remoção de informações confidenciais de documentos públicos.

      Qualquer um dos seguintes:
      objeto tokenFilterasciiFolding objeto tokenFilterdaitchMokotoffSoundex objeto tokenFilteredgeGram TokenFilter objeto objeto TokenFilterFlattenGraph objeto tokenFiltericuFolding objeto tokenFiltericuNormalizer TokenFilterkStemming object objeto de comprimento tokenFilter objeto tokenFilter lowercase objeto tokenFilternGram objeto TokenFilterPorterStemming objeto tokenFilterregex objeto tokenFilterreverse objeto tokenFiltershingle objeto tokenFiltersknowballStemming objeto TokenFilterSpanishPluralStemming TokenFilterStempel object objeto tokenFilterstopword objeto tokenFiltertrim objeto TokenFilterWordelimiterGraph

    • Tokenizador objeto Obrigatório

      Tokenizador que você deseja utilizar para criar tokens. Os tokens determinam como o Atlas Search faz a divisão do texto em partes para indexação.

      Um dos seguintes:
      objeto edgeGram objeto de palavra-chave objeto nGram objeto regexCaptureGroup objeto regexSplit objeto padrão objeto uaxUrlEmail objeto de espaço em branco
  • 404 aplicação/json

    Não encontrado.

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • badRequestDetail objeto

      Detalhes da solicitação inválida.

      Ocultar atributo ruimRequestDetail Mostrar atributo ruimRequestDetail objeto
      • Campos array[objeto]

        Descreve todas as violações em uma solicitação do cliente .

        Ocultar atributos de campos Mostrar atributos dos campos objeto
        • Descrição string Obrigatório

          Uma descrição do motivo pelo qual o elemento de solicitação é incorreto.

        • Campo string Obrigatório

          Um caminho que leva a um campo no corpo da solicitação.

    • detalhe string

      Descreve as condições ou os motivos específicos que causam cada tipo de erro.

    • Erro integer(int32) Obrigatório

      O código de status HTTP retornado com este erro.

      Documentação externa
    • Código de erro string Obrigatório

      Código de erro do aplicativo retornado com esse erro.

    • Parâmetros array[objeto]

      Parâmetros usados para fornecer mais informações sobre o erro.

    • Razão string

      Mensagens de erro de aplicativo retornadas com este erro.
  • 500 aplicação/json

    Erro interno do servidor.

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • badRequestDetail objeto

      Detalhes da solicitação inválida.

      Ocultar atributo ruimRequestDetail Mostrar atributo ruimRequestDetail objeto
      • Campos array[objeto]

        Descreve todas as violações em uma solicitação do cliente .

        Ocultar atributos de campos Mostrar atributos dos campos objeto
        • Descrição string Obrigatório

          Uma descrição do motivo pelo qual o elemento de solicitação é incorreto.

        • Campo string Obrigatório

          Um caminho que leva a um campo no corpo da solicitação.

    • detalhe string

      Descreve as condições ou os motivos específicos que causam cada tipo de erro.

    • Erro integer(int32) Obrigatório

      O código de status HTTP retornado com este erro.

      Documentação externa
    • Código de erro string Obrigatório

      Código de erro do aplicativo retornado com esse erro.

    • Parâmetros array[objeto]

      Parâmetros usados para fornecer mais informações sobre o erro.

    • Razão string

      Mensagens de erro de aplicativo retornadas com este erro.
GET /API/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/fts/analyzers 
curl \
 --request GET 'https://cloud.mongodb.com/api/atlas/v1.0/groups/32b6e34b3d91647abb20e7b8/clusters/{clusterName}/fts/analyzers' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Exemplos de resposta (200) 
[
  {
    "charFilters": [
      {
        "ignoredTags": [
          "string"
        ],
        "type": "htmlStrip"
      }
    ],
    "name": "string",
    "tokenFilters": [
      {
        "originalTokens": "omit",
        "type": "asciiFolding"
      }
    ],
    "tokenizer": {
      "maxGram": 42,
      "minGram": 42,
      "type": "edgeGram"
    }
  }
]
Exemplos de resposta (404) 
{
  "error": 404,
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
  "reason": "Not Found",
  "errorCode": "RESOURCE_NOT_FOUND"
}
Exemplos de resposta (500) 
{
  "error": 500,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Internal Server Error",
  "errorCode": "UNEXPECTED_ERROR"
}