텍스트 분석(Azure AI Search REST API)

  • 아티클

분석 API 는 분석기가 텍스트를 토큰으로 구분하는 방법을 보여 줍니다. 지정된 분석기가 문자열 입력을 토큰화하는 방법을 확인할 수 있도록 대화형 테스트를 위한 것입니다.

POST https://[service name].search.windows.net/indexes/[index name]/analyze?api-version=[api-version]
    Content-Type: application/json
    api-key: [admin key]

인덱싱 및 쿼리 실행 중에 사용되는 분석기를 지정하려면 인덱스에서 문자열 필드에 분석기 속성을 설정합니다.

URI 매개 변수

매개 변수 Description
서비스 이름 필수 사항입니다. 검색 서비스의 고유한 사용자 정의 이름으로 설정합니다.
인덱스 이름 필수 사항입니다. 요청 URI는 분석하려는 필드가 포함된 인덱스의 이름을 지정합니다.
api-version 필수 사항입니다. 현재 안정적인 버전은 입니다 api-version=2020-06-30. 더 많은 버전은 API 버전을 참조하세요.

요청 헤더

다음 표에서는 필수 요청 헤더와 선택적 요청 헤더에 대해 설명합니다.

필드 Description
콘텐츠 형식 필수 사항입니다. application/json
api-key Azure 역할을 사용하고 요청에 전달자 토큰이 제공된 경우 선택 사항이며, 그렇지 않으면 키가 필요합니다. api-key는 검색 서비스에 대한 요청을 인증하는 고유한 시스템 생성 문자열입니다. 분석기 요청에는 쿼리 키가 아닌 관리자 키로 설정된 헤더가 포함되어 api-key 야 합니다. 자세한 내용은 키 인증을 사용하여 Azure AI Search에 연결을 참조하세요.

요청 본문

{
  "text": "Text to analyze",
  "analyzer": "analyzer_name"
}

또는

{
  "text": "Text to analyze",
  "tokenizer": "tokenizer_name",
  "tokenFilters": (optional) [ "token_filter_name" ],
  "charFilters": (optional) [ "char_filter_name" ]
}

, tokenizer_name및 token_filter_namechar_filter_name 는 analyzer_name인덱스에 대해 미리 정의된 또는 사용자 지정 분석기, 토큰 변환기, 토큰 필터 및 char 필터의 유효한 이름이어야 합니다. 어휘 분석 프로세스에 대한 자세한 내용은 Azure AI Search의 분석을 참조하세요.

응답

상태 코드: 응답에 성공하면 ‘200 OK’가 반환됩니다.

응답 본문의 형식은 다음과 같습니다.

    {
      "tokens": [
        {
          "token": string (token),
          "startOffset": number (index of the first character of the token),
          "endOffset": number (index of the last character of the token),
          "position": number (position of the token in the input text)
        },
        ...
      ]
    }

예제

요청 본문에는 사용하려는 문자열 및 분석기가 포함됩니다.

     {
       "text": "The quick brown fox",
       "analyzer": "standard"
     }

응답은 사용자가 제공한 문자열에 대해 분석기에서 내보낸 토큰을 보여 줍니다.

{
    "tokens": [
        {
            "token": "the",
            "startOffset": 0,
            "endOffset": 3,
            "position": 0
        },
        {
            "token": "quick",
            "startOffset": 4,
            "endOffset": 9,
            "position": 1
        },
        {
            "token": "brown",
            "startOffset": 10,
            "endOffset": 15,
            "position": 2
        },
        {
            "token": "fox",
            "startOffset": 16,
            "endOffset": 19,
            "position": 3
        }
    ]
}

추가 정보