1개의 cluster에 대해 모든 사용자 정의 분석기 업데이트

PUT /api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/fts/analyzers
서비스 계정 DigestAuth

지정된 클러스터 에서 하나 이상의 Atlas Search 사용자 지정 분석기를 업데이트합니다. 사용자 지정 분석기는 필드 인덱스 위해 수행할 작업을 정의합니다. 이 리소스 사용하려면 요청하는 서비스 계정 또는 API 키에 프로젝트 데이터 액세스 관리자 역할 있어야 합니다.

사용자 지정 분석기

경로 매개변수

  • groupId 문자열 필수 사항

    프로젝트 식별하는 고유한 24-16진수 문자열입니다. 인증된 사용자가 액세스 할 수 있는 모든 프로젝트를 조회 하려면 /groups 엔드포인트를 사용합니다.

    참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

    형식은 ^([a-f0-9]{24})$ 패턴 과 일치해야 합니다.

  • clusterName 문자열 필수 사항

    하나 이상의 Atlas Search 인덱스가 있는 컬렉션을 포함하는 클러스터의 이름입니다.

    형식은 ^[a-zA-Z0-9][a-zA-Z0-9-]*$ 패턴 과 일치해야 합니다.

쿼리 매개변수

  • envelope 부울

    애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

    기본값은 false 입니다.

  • pretty 부울

    응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

    기본값은 false 입니다.

    Prettyprint
application/json

body 필수 사항

지정된 cluster에서 하나 이상의 Atlas Search 사용자 지정 분석기를 업데이트합니다.

  • charFilters 배열[객체]

    텍스트를 한 번에 한 문자씩 검사하고 필터링 작업을 수행하는 필터입니다.

    다음 중 하나입니다.
    charFilterhtmlStrip 객체 charFiltericuNormalize 객체 charFiltermapping 객체 charFilterpersian 객체
  • 이름 문자열 필수 사항

    사용자 지정 분석기를 식별하는 사람이 읽을 수 있는 이름입니다. 이름은 인덱스 내에서 고유해야 하며 다음 문자열로 시작하지 않아야 합니다.

    • lucene.
    • builtin.
    • mongodb.
  • 토큰 필터 배열[객체]

    다음과 같은 작업을 수행하는 필터입니다.

    • 어간 처리: "talking", "talked", "talks"와 같은 관련 단어를 어근인 "talk"로 줄입니다.

    • 편집: 공개 문서에서 민감한 정보를 제거합니다.

    다음 중 하나:
    tokenFilterasciiFolding 객체 tokenFilterdaitchMokotoffSoundex 객체 tokenFilteredgeGram 객체 TokenFilterEnglishPossessive 객체 TokenFilterFlattenGraph 객체 tokenFiltericuFolding 객체 tokenFiltericuNormalizer 객체 TokenFilterkStemming object tokenFilterLength 객체 tokenFilterlowercase 객체 tokenFilternGram 객체 TokenFilterPorterStemming 객체 tokenFilterregex 객체 tokenFilterreverse 객체 tokenFiltershingle 객체 tokenFiltersnowballStemming 객체 TokenFilterSpanishPluralStemming 객체 TokenFilterStempel object tokenFilterstopword 객체 tokenFiltertrim 객체 TokenFilterWordDelimiterGraph 객체

  • 토크나이저 객체 필수 사항

    토큰 생성에 사용할 토크나이저입니다. 토큰은 Atlas Search가 인덱싱을 위해 텍스트를 개별 청크로 분할하는 방법을 결정합니다.

    다음 중 하나입니다.
    edgeGram 객체 키워드 객체 nGram 객체 regexCaptureGroup 객체 regexSplit 객체 표준 객체 uaxUrlEmail 객체 공백 객체

응답

  • 200 application/json

    확인

    응답 속성 숨기기 응답 속성 표시 객체
    • charFilters 배열[객체]

      텍스트를 한 번에 한 문자씩 검사하고 필터링 작업을 수행하는 필터입니다.

      다음 중 하나입니다.
      charFilterhtmlStrip 객체 charFiltericuNormalize 객체 charFiltermapping 객체 charFilterpersian 객체
    • 이름 문자열 필수 사항

      사용자 지정 분석기를 식별하는 사람이 읽을 수 있는 이름입니다. 이름은 인덱스 내에서 고유해야 하며 다음 문자열로 시작하지 않아야 합니다.

      • lucene.
      • builtin.
      • mongodb.
    • 토큰 필터 배열[객체]

      다음과 같은 작업을 수행하는 필터입니다.

      • 어간 처리: "talking", "talked", "talks"와 같은 관련 단어를 어근인 "talk"로 줄입니다.

      • 편집: 공개 문서에서 민감한 정보를 제거합니다.

      다음 중 하나:
      tokenFilterasciiFolding 객체 tokenFilterdaitchMokotoffSoundex 객체 tokenFilteredgeGram 객체 TokenFilterEnglishPossessive 객체 TokenFilterFlattenGraph 객체 tokenFiltericuFolding 객체 tokenFiltericuNormalizer 객체 TokenFilterkStemming object tokenFilterLength 객체 tokenFilterlowercase 객체 tokenFilternGram 객체 TokenFilterPorterStemming 객체 tokenFilterregex 객체 tokenFilterreverse 객체 tokenFiltershingle 객체 tokenFiltersnowballStemming 객체 TokenFilterSpanishPluralStemming 객체 TokenFilterStempel object tokenFilterstopword 객체 tokenFiltertrim 객체 TokenFilterWordDelimiterGraph 객체

    • 토크나이저 객체 필수 사항

      토큰 생성에 사용할 토크나이저입니다. 토큰은 Atlas Search가 인덱싱을 위해 텍스트를 개별 청크로 분할하는 방법을 결정합니다.

      다음 중 하나입니다.
      edgeGram 객체 키워드 객체 nGram 객체 regexCaptureGroup 객체 regexSplit 객체 표준 객체 uaxUrlEmail 객체 공백 객체
  • 400 application/json

    잘못된 요청입니다.

    응답 속성 숨기기 응답 속성 표시 객체
    • badRequestDetail 객체

      요청 세부 정보가 잘못되었습니다.

      badRequestDetail 속성 숨기기 badRequestDetail 속성 표시 객체
      • 필드 배열[객체]

        클라이언트 요청 의 모든 위반 사항을 설명합니다.

        필드 속성 숨기기 필드 속성 표시 객체
        • description 문자열 필수 사항

          요청 요소가 잘못된 이유에 대한 설명입니다.

        • 필드 문자열 필수 사항

          요청 본문의 필드 로 연결되는 경로입니다.

    • 세부 정보 문자열

      각 오류 유형을 유발하는 특정 조건 또는 이유를 설명합니다.

    • 오류 integer(int32) 필수 사항

      이 오류와 함께 HTTP 상태 코드가 반환되었습니다.

      외부 문서
    • 오류 코드 문자열 필수 사항

      이 오류와 함께 반환된 애플리케이션 오류 코드입니다.

    • 매개변수 배열[객체]

      오류에 대한 자세한 정보를 제공하는 데 사용된 매개변수입니다.

    • 이유 문자열

      이 오류와 함께 반환된 애플리케이션 오류 메시지입니다.
  • 404 application/json

    찾을 수 없습니다.

    응답 속성 숨기기 응답 속성 표시 객체
    • badRequestDetail 객체

      요청 세부 정보가 잘못되었습니다.

      badRequestDetail 속성 숨기기 badRequestDetail 속성 표시 객체
      • 필드 배열[객체]

        클라이언트 요청 의 모든 위반 사항을 설명합니다.

        필드 속성 숨기기 필드 속성 표시 객체
        • description 문자열 필수 사항

          요청 요소가 잘못된 이유에 대한 설명입니다.

        • 필드 문자열 필수 사항

          요청 본문의 필드 로 연결되는 경로입니다.

    • 세부 정보 문자열

      각 오류 유형을 유발하는 특정 조건 또는 이유를 설명합니다.

    • 오류 integer(int32) 필수 사항

      이 오류와 함께 HTTP 상태 코드가 반환되었습니다.

      외부 문서
    • 오류 코드 문자열 필수 사항

      이 오류와 함께 반환된 애플리케이션 오류 코드입니다.

    • 매개변수 배열[객체]

      오류에 대한 자세한 정보를 제공하는 데 사용된 매개변수입니다.

    • 이유 문자열

      이 오류와 함께 반환된 애플리케이션 오류 메시지입니다.
  • 500 application/json

    내부 서버 오류입니다.

    응답 속성 숨기기 응답 속성 표시 객체
    • badRequestDetail 객체

      요청 세부 정보가 잘못되었습니다.

      badRequestDetail 속성 숨기기 badRequestDetail 속성 표시 객체
      • 필드 배열[객체]

        클라이언트 요청 의 모든 위반 사항을 설명합니다.

        필드 속성 숨기기 필드 속성 표시 객체
        • description 문자열 필수 사항

          요청 요소가 잘못된 이유에 대한 설명입니다.

        • 필드 문자열 필수 사항

          요청 본문의 필드 로 연결되는 경로입니다.

    • 세부 정보 문자열

      각 오류 유형을 유발하는 특정 조건 또는 이유를 설명합니다.

    • 오류 integer(int32) 필수 사항

      이 오류와 함께 HTTP 상태 코드가 반환되었습니다.

      외부 문서
    • 오류 코드 문자열 필수 사항

      이 오류와 함께 반환된 애플리케이션 오류 코드입니다.

    • 매개변수 배열[객체]

      오류에 대한 자세한 정보를 제공하는 데 사용된 매개변수입니다.

    • 이유 문자열

      이 오류와 함께 반환된 애플리케이션 오류 메시지입니다.
PUT /API/Atlas/v1.0/groups/{groupId}/clusters/{clusterName}/fts/analyzers 
curl \
 --request PUT 'https://cloud.mongodb.com/api/atlas/v1.0/groups/32b6e34b3d91647abb20e7b8/clusters/{clusterName}/fts/analyzers' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '[{"charFilters":[{"ignoredTags":["string"],"type":"htmlStrip"}],"name":"string","tokenFilters":[{"originalTokens":"omit","type":"asciiFolding"}],"tokenizer":{"maxGram":42,"minGram":42,"type":"edgeGram"}}]'
요청 예시 
[
  {
    "charFilters": [
      {
        "ignoredTags": [
          "string"
        ],
        "type": "htmlStrip"
      }
    ],
    "name": "string",
    "tokenFilters": [
      {
        "originalTokens": "omit",
        "type": "asciiFolding"
      }
    ],
    "tokenizer": {
      "maxGram": 42,
      "minGram": 42,
      "type": "edgeGram"
    }
  }
]
응답 예시(200) 
[
  {
    "charFilters": [
      {
        "ignoredTags": [
          "string"
        ],
        "type": "htmlStrip"
      }
    ],
    "name": "string",
    "tokenFilters": [
      {
        "originalTokens": "omit",
        "type": "asciiFolding"
      }
    ],
    "tokenizer": {
      "maxGram": 42,
      "minGram": 42,
      "type": "edgeGram"
    }
  }
]
응답 예시(400) 
{
  "error": 400,
  "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  "reason": "Bad Request",
  "errorCode": "VALIDATION_ERROR"
}
응답 예시(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"
}
응답 예시(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"
}