> Discover all available pages from the documentation index: https://mastra.zisheng.pro/ko/llms.txt

# OpenSearch 벡터 저장소

OpenSearchVector 클래스는 다음을 사용하여 벡터 검색을 제공합니다.[OpenSearch](https://opensearch.org/), 오픈 소스 검색 및 분석 엔진입니다. OpenSearch의 k-NN 기능을 사용하여 벡터 유사성 검색을 수행합니다.

## 생성자 옵션

생성자는 필수 `id` 필드와 함께 모든 [OpenSearch ClientOptions](https://opensearch.org/docs/latest/clients/javascript/index/)를 허용합니다.

**id** (`string`): 이 벡터 저장소 인스턴스의 고유 식별자

**node** (`string | string[] | NodeOptions | NodeOptions[]`): OpenSearch 노드 URL(예: 'http\://localhost:9200')

**auth** (`BasicAuth | BearerAuth | AwsSigv4Auth`): 인증 구성

**ssl** (`ConnectionOptions`): SSL/TLS 구성

**compression** (`'gzip'`): gzip 압축 활성화

## 행동 양식

### `createIndex()`

지정된 구성으로 새 인덱스를 생성합니다.

**indexName** (`string`): 생성할 인덱스의 이름

**dimension** (`number`): 인덱스에 저장할 벡터의 차원

**metric** (`'cosine' | 'euclidean' | 'dotproduct'`): 벡터 유사도에 사용할 거리 메트릭 (Default: `'cosine'`)

### `listIndexes()`

OpenSearch 인스턴스의 모든 인덱스를 나열합니다.

보고:`Promise<string[]>`

### `describeIndex()`

인덱스에 대한 정보를 가져옵니다.

**indexName** (`string`): 설명을 조회할 인덱스의 이름

### `deleteIndex()`

**indexName** (`string`): 삭제할 인덱스의 이름

### `upsert()`

**indexName** (`string`): 벡터를 업서트할 인덱스의 이름

**vectors** (`number[][]`): 삽입할 벡터 임베딩 배열

**metadata** (`Record<string, any>[]`): 각 벡터에 대응하는 메타데이터 객체 배열

**ids** (`string[]`): 벡터의 선택적 ID 배열입니다. 제공하지 않으면 임의의 ID가 생성됩니다.

### `query()`

**indexName** (`string`): 쿼리할 인덱스의 이름

**queryVector** (`number[]`): 유사한 벡터를 찾는 데 사용할 쿼리 벡터

**topK** (`number`): 반환할 결과 수 (Default: `10`)

**filter** (`VectorFilter`): 쿼리에 적용할 선택적 필터(MongoDB 스타일 쿼리 구문)

### `updateVector()`

ID 또는 메타데이터 필터를 기준으로 단일 벡터를 업데이트합니다. `id` 또는 `filter` 중 하나만 제공해야 합니다.

**indexName** (`string`): 벡터를 업데이트할 인덱스의 이름

**id** (`string`): 업데이트할 벡터의 ID(filter와 함께 사용할 수 없음)

**filter** (`Record<string, any>`): 업데이트할 벡터를 식별하는 메타데이터 필터(id와 함께 사용할 수 없음)

**update** (`{ vector?: number[]; metadata?: Record<string, any>; }`): 업데이트할 벡터 및/또는 메타데이터를 포함하는 객체

### `deleteVector()`

인덱스에서 ID로 단일 벡터를 삭제합니다.

**indexName** (`string`): 벡터를 삭제할 인덱스의 이름

**id** (`string`): 삭제할 벡터의 ID

### `deleteVectors()`

ID 또는 메타데이터 필터를 기준으로 여러 벡터를 삭제합니다. `ids` 또는 `filter` 중 하나만 제공해야 합니다.

**indexName** (`string`): 삭제할 벡터가 포함된 인덱스의 이름

**ids** (`string[]`): 삭제할 벡터 ID 배열(filter와 함께 사용할 수 없음)

**filter** (`Record<string, any>`): 삭제할 벡터를 식별하는 메타데이터 필터(ids와 함께 사용할 수 없음)

## 관련된

- [메타데이터 필터](https://mastra.zisheng.pro/ko/reference/rag/metadata-filters)