용어 벡터 API

용어 벡터 API (Term Vectors API)

1.0에서 도입되었어요. _termvectors API는 단일 문서의 용어 벡터(term vector) 정보를 가져와요. 용어 벡터는 문서 안의 용어(단어)에 대한 자세한 정보를 제공하는데, 용어 빈도(term frequency), 위치(position), 오프셋(offset), 페이로드(payload)가 포함돼요. 이는 관련성 점수 계산, 하이라이팅, 유사도 계산 같은 애플리케이션에 유용해요. 자세한 내용은 Term vector parameter를 참고하세요.

출처: 문서

본문

엔드포인트 (Endpoints)

GET  /{index}/_termvectors
POST /{index}/_termvectors
GET  /{index}/_termvectors/{id}
POST /{index}/_termvectors/{id}

경로 파라미터 (Path parameters)

다음 표는 사용 가능한 경로 파라미터를 보여줘요.

쿼리 파라미터 (Query parameters)

다음 표는 사용 가능한 쿼리 파라미터를 보여줘요. 모든 쿼리 파라미터는 선택 사항이에요.

요청 본문 필드 (Request body fields)

다음 표는 요청 본문에 지정할 수 있는 필드를 보여줘요.

용어 필터링 (Filtering terms)

요청 본문의 filter 객체로 용어 벡터 응답에 포함할 토큰을 필터링할 수 있어요. filter 객체는 다음 필드를 지원해요.

예제 요청 (Example requests)

인덱스를 만들어요.

PUT /my-index
{
  "mappings": {
    "properties": {
      "text": {
        "type": "text",
        "term_vector": "with_positions_offsets_payloads"
      }
    }
  }
}

문서를 인덱싱해요.

예제 요청 (Example request)

용어 벡터를 가져와요.

또는 fields와 term_statistics를 쿼리 파라미터로 제공할 수도 있어요.

예제 응답 (Example response)

응답은 용어 벡터 정보를 보여줘요.

{
  "_index": "my-index",
  "_id": "1",
  "_version": 1,
  "found": true,
  "took": 1,
  "term_vectors": {
    "text": {
      "field_statistics": {
        "sum_doc_freq": 5,
        "doc_count": 1,
        "sum_ttf": 5
      },
      "terms": {
        "a": {
          "doc_freq": 1,
          "ttf": 1,
          "term_freq": 1,
          "tokens": [
            {
              "position": 2,
              "start_offset": 14,
              "end_offset": 15
            }
          ]
        },
        "engine": {
          "doc_freq": 1,
          "ttf": 1,
          "term_freq": 1,
          "tokens": [
            {
              "position": 4,
              "start_offset": 23,
              "end_offset": 29
            }
          ]
        },
        "is": {
          "doc_freq": 1,
          "ttf": 1,
          "term_freq": 1,
          "tokens": [
            {
              "position": 1,
              "start_offset": 11,
              "end_offset": 13
            }
          ]
        },
        "opensearch": {
          "doc_freq": 1,
          "ttf": 1,
          "term_freq": 1,
          "tokens": [
            {
              "position": 0,
              "start_offset": 0,
              "end_offset": 10
            }
          ]
        },
        "search": {
          "doc_freq": 1,
          "ttf": 1,
          "term_freq": 1,
          "tokens": [
            {
              "position": 3,
              "start_offset": 16,
              "end_offset": 22
            }
          ]
        }
      }
    }
  }
}

응답 본문 필드 (Response body fields)

다음 표는 모든 응답 본문 필드를 보여줘요.

필요한 권한 (Required permissions)

Security plugin을 사용한다면 indices:data/read/tv 권한이 있는지 확인하세요.

더 알아보기 (Learn more)

• OpenSearch 공식 문서