---
title: "Index"
slug: "common-apidatatype-csindex"
tags: ["Classic"]
updated: 2026-04-23T08:55:23Z
published: 2026-04-23T09:02:10Z
---

> ## Documentation Index
> Fetch the complete documentation index at: https://api.ncloud-docs.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Index

<p class="platform-info type-classic-vpc">Classic/VPC 환경에서 이용 가능합니다.</p>

검색하고자 하는 대상의 색인 정보입니다.
:::(Info) (참고)
현재는 색인 설정 기능이 제공되지 않으므로, 색인으로 생성할 섹션과 색인 이름만 설정이 가능합니다.
:::

## 구문 <a name="구문"></a>
구문은 다음과 같습니다.

```JAVA
private String name = "idx1";
private boolean createTermLoc = false;
private String documentTermWeight = "sum_wgt";
private List<BuildInfo> buildInfos = new ArrayList<BuildInfo>();
```

## 필드 <a name="필드"></a>
필드에 대한 설명은 다음과 같습니다. 

| 필드            | 타입 | 필수 여부            | 설명                  |
|------------------------|-----------------------|-----------------|-----------------------|
| `name` | String | Required | 색인 이름<ul><li>영문자, 숫자, 특수 문자 '_'만 허용</li></ul> |
| `createTermLoc` | Boolean | Required |색인된 텀의 위치 정보를 기록할지 여부<ul><li>`true` \| `false`</li></ul> |
| `documentTermWeight`  | String       | Required | Document 값 저장 시 사용하는 표현식<ul><li>추후 색인 설정 추가 예정</li><li>`sum_wgt` (기본값)</li></ul> |
| buildInfos  | List<[BuildInfo](/docs/common-apidatatype-csbuildinfo)> | Required | 색인 생성 정보 목록|