Vector Stores - Create Vector Store

참조

서비스:: AI Foundry

API 버전:: v1

벡터 저장소를 만듭니다.

POST {endpoint}/vector_stores?api-version=v1

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
endpoint	path	True	string (uri)	다음과 같은 형식의 프로젝트 엔드포인트: https://.services.ai.azure.com/api/projects/
api-version	query	True	string minLength: 1	이 작업에 사용할 API 버전입니다.

요청 본문

Name	형식	Description
chunking_strategy	VectorStoreChunkingStrategyRequest: VectorStoreAutoChunkingStrategyRequest VectorStoreStaticChunkingStrategyRequest	파일을 청크하는 데 사용되는 청크 전략입니다. 설정하지 않으면 자동 전략을 사용합니다. file_ids 비어있지 않은 경우에만 적용됩니다.
configuration	VectorStoreConfiguration	Azure 자산 URI에서 벡터 저장소를 만들 때 사용되는 벡터 저장소 구성입니다.
expires_after	VectorStoreExpirationPolicy	이 벡터 저장소가 만료되는 시기에 대한 세부 정보
file_ids	string[]	벡터 저장소에서 사용해야 하는 파일 ID 목록입니다. 파일에 액세스할 수 있는 `file_search`와 같은 도구에 유용합니다.
metadata	object	개체에 연결할 수 있는 최대 16개의 키/값 쌍 집합으로, 해당 개체에 대한 추가 정보를 구조화된 형식으로 저장하는 데 사용됩니다. 키의 길이는 최대 64자이고 값의 길이는 최대 512자일 수 있습니다.
name	string	벡터 저장소의 이름입니다.

응답

Name	형식	Description
200 OK	VectorStore	요청이 성공했습니다.
Other Status Codes	AgentV1Error	예기치 않은 오류 응답입니다.

보안

OAuth2Auth

형식: oauth2
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

범위

Name	Description
https://ai.azure.com/.default

예제

VectorStores_CreateVectorStore_MaximumSet

VectorStores_CreateVectorStore_MinimumSet

VectorStores_CreateVectorStore_MaximumSet

샘플 요청

HTTP

POST {endpoint}/vector_stores?api-version=v1

{
  "file_ids": [
    "ftbzgxmtythuxbhs",
    "ftbzgxmtythuxbhs",
    "ftbzgxmtythuxbhs",
    "ftbzgxmtythuxbhs",
    "ftbzgxmtythuxbhs",
    "ftbzgxmtythuxbhs",
    "ftbzgxmtythuxbhs",
    "ftbzgxmtythuxbhs",
    "ftbzgxmtythuxbhs",
    "ftbzgxmtythuxbhs",
    "ftbzgxmtythuxbhs",
    "ftbzgxmtythuxbhs",
    "ftbzgxmtythuxbhs",
    "ftbzgxmtythuxbhs",
    "ftbzgxmtythuxbhs",
    "ftbzgxmtythuxbhs",
    "ftbzgxmtythuxbhs",
    "ftbzgxmtythuxbhs",
    "ftbzgxmtythuxbhs",
    "ftbzgxmtythuxbhs",
    "ftbzgxmtythuxbhs",
    "ftbzgxmtythuxbhs",
    "ftbzgxmtythuxbhs",
    "ftbzgxmtythuxbhs",
    "ftbzgxmtythuxbhs",
    "ftbzgxmtythuxbhs",
    "ftbzgxmtythuxbhs",
    "ftbzgxmtythuxbhs",
    "ftbzgxmtythuxbhs",
    "ftbzgxmtythuxbhs",
    "ftbzgxmtythuxbhs",
    "ftbzgxmtythuxbhs"
  ],
  "name": "vidfcwh",
  "configuration": {
    "data_sources": [
      {
        "uri": "jtookuzhwojyylbips",
        "type": "uri_asset"
      }
    ]
  },
  "expires_after": {
    "anchor": "last_active_at",
    "days": 102
  },
  "chunking_strategy": {
    "type": "VectorStoreChunkingStrategyRequest"
  },
  "metadata": {
    "key3221": "kpsoqourrnirxgzrl"
  }
}

샘플 응답

상태 코드:: 200

{
  "id": "bxcw",
  "object": "vector_store",
  "created_at": 6,
  "name": "nhjsetafmqp",
  "usage_bytes": 9,
  "file_counts": {
    "in_progress": 14,
    "completed": 21,
    "failed": 12,
    "cancelled": 1,
    "total": 25
  },
  "status": "expired",
  "expires_after": {
    "anchor": "last_active_at",
    "days": 102
  },
  "expires_at": 22,
  "last_active_at": 14,
  "metadata": {
    "key1986": "qlxm"
  }
}

VectorStores_CreateVectorStore_MinimumSet

샘플 요청

HTTP

POST {endpoint}/vector_stores?api-version=v1

{}

샘플 응답

상태 코드:: 200

{
  "id": "bxcw",
  "object": "vector_store",
  "created_at": 6,
  "name": "nhjsetafmqp",
  "usage_bytes": 9,
  "file_counts": {
    "in_progress": 14,
    "completed": 21,
    "failed": 12,
    "cancelled": 1,
    "total": 25
  },
  "status": "expired",
  "last_active_at": 14,
  "metadata": {}
}

정의

Name	Description
AgentErrorDetail	에이전트 API에서 반환된 오류 정보를 설명합니다.
AgentV1Error	에이전트 API에서 반환된 오류 페이로드입니다.
VectorStore	벡터 저장소는 `file_search` 도구에서 사용할 수 있는 처리된 파일의 컬렉션입니다.
VectorStoreAutoChunkingStrategyRequest	기본 전략. 이 전략은 현재 800의 max_chunk_size_tokens 사용하고 400의 chunk_overlap_tokens 사용합니다.
VectorStoreChunkingStrategyRequestType	청크 전략의 유형
VectorStoreConfiguration	벡터 스토리지 구성은 엔터프라이즈 파일 검색에 여러 파일을 사용할 수 있는 경우 사용되는 데이터 원본 목록입니다.
VectorStoreDataSource	Azure 자산 URI 경로 및 엔터프라이즈 파일 검색을 위한 데이터 원본으로 사용되는 파일의 자산 형식을 포함하는 구조입니다.
VectorStoreDataSourceAssetType	벡터 스토리지 자산의 유형입니다. 자산 유형은 uri_asset일 수 있으며, 이 경우 자산 URI ID를 포함해야 하고, id_asset 경우 데이터 ID를 포함해야 합니다.
VectorStoreExpirationPolicy	벡터 저장소에 대한 만료 정책입니다.
VectorStoreExpirationPolicyAnchor	이 벡터 저장소의 일과 만료 사이의 관계를 설명합니다
VectorStoreFileCount	상태별로 그룹화된 이 벡터 저장소에서 처리되거나 처리되는 파일의 수입니다.
VectorStoreOptions	벡터 저장소를 만들기 위한 요청 개체입니다.
VectorStoreStaticChunkingStrategyOptions	벡터 저장소 정적 청크 전략을 구성하는 옵션입니다.
VectorStoreStaticChunkingStrategyRequest	정적으로 구성된 청크 분할 전략입니다.
VectorStoreStatus	벡터 저장 가능 상태

AgentErrorDetail

Object

에이전트 API에서 반환된 오류 정보를 설명합니다.

Name	형식	Description
code	string	기계가 읽을 수 있는 오류 코드입니다.
message	string	사람이 읽을 수 있는 오류에 대한 설명입니다.
param	string	오류를 일으킨 매개 변수의 이름입니다(해당하는 경우).
type	string	오류 유형 식별자(예 `invalid_request_error`: ).

AgentV1Error

Object

에이전트 API에서 반환된 오류 페이로드입니다.

Name	형식	Description
error	AgentErrorDetail	오류를 나타냅니다.

VectorStore

Object

벡터 저장소는 file_search 도구에서 사용할 수 있는 처리된 파일의 컬렉션입니다.

Name	형식	Description
created_at	integer (unixtime)	벡터 저장소가 만들어진 시점의 Unix 타임스탬프(초)입니다.
expires_after	VectorStoreExpirationPolicy	이 벡터 저장소가 만료되는 시기에 대한 세부 정보
expires_at	integer (unixtime)	벡터 저장소가 만료될 시점의 Unix 타임스탬프(초)입니다.
file_counts	VectorStoreFileCount	이 벡터 저장소에서 처리되거나 처리되는 상태별로 그룹화된 파일 수입니다.
id	string	API 엔드포인트에서 참조할 수 있는 식별자입니다.
last_active_at	integer (unixtime)	벡터 저장소가 마지막으로 활성 상태였던 시점의 Unix 타임스탬프(초)입니다.
metadata	object	개체에 연결할 수 있는 최대 16개의 키/값 쌍 집합으로, 해당 개체에 대한 추가 정보를 구조화된 형식으로 저장하는 데 사용됩니다. 키의 길이는 최대 64자이고 값의 길이는 최대 512자일 수 있습니다.
name	string	벡터 저장소의 이름입니다.
object	enum: vector_store	항상 `vector_store`인 개체 형식입니다.
status	VectorStoreStatus	벡터 저장소의 상태로, `expired`, `in_progress` 또는 `completed`일 수 있습니다. `completed`의 상태는 벡터 저장소를 사용할 준비가 되었음을 나타냅니다.
usage_bytes	integer (int32)	벡터 저장소의 파일에 사용되는 총 바이트 수입니다.

VectorStoreAutoChunkingStrategyRequest

Object

기본 전략. 이 전략은 현재 800의 max_chunk_size_tokens 사용하고 400의 chunk_overlap_tokens 사용합니다.

Name	형식	Description
type	string: auto	개체 유형

VectorStoreChunkingStrategyRequestType

열거형

청크 전략의 유형

값	Description
auto
static

VectorStoreConfiguration

Object

벡터 스토리지 구성은 엔터프라이즈 파일 검색에 여러 파일을 사용할 수 있는 경우 사용되는 데이터 원본 목록입니다.

Name	형식	Description
data_sources	VectorStoreDataSource[]	데이터 원본

VectorStoreDataSource

Object

Azure 자산 URI 경로 및 엔터프라이즈 파일 검색을 위한 데이터 원본으로 사용되는 파일의 자산 형식을 포함하는 구조입니다.

Name	형식	Description
type	VectorStoreDataSourceAssetType	자산 유형
uri	string	자산 URI.

VectorStoreDataSourceAssetType

열거형

벡터 스토리지 자산의 유형입니다. 자산 유형은 uri_asset일 수 있으며, 이 경우 자산 URI ID를 포함해야 하고, id_asset 경우 데이터 ID를 포함해야 합니다.

값	Description
id_asset	데이터 ID
uri_asset	Azure URI

VectorStoreExpirationPolicy

Object

벡터 저장소에 대한 만료 정책입니다.

Name	형식	Description
anchor	VectorStoreExpirationPolicyAnchor	만료 정책이 적용되는 앵커 타임스탬프입니다. 지원되는 앵커: `last_active_at`.
days	integer (int32) minimum: 1 maximum: 365	만료 정책이 적용되는 앵커 타임스탬프입니다.

VectorStoreExpirationPolicyAnchor

열거형

이 벡터 저장소의 일과 만료 사이의 관계를 설명합니다

값	Description
last_active_at	만료 정책은 벡터 저장소가 마지막으로 활성화된 시간을 기반으로 합니다.

VectorStoreFileCount

Object

상태별로 그룹화된 이 벡터 저장소에서 처리되거나 처리되는 파일의 수입니다.

Name	형식	Description
cancelled	integer (int32)	취소된 파일 수입니다.
completed	integer (int32)	성공적으로 처리된 파일 수입니다.
failed	integer (int32)	처리하지 못한 파일 수입니다.
in_progress	integer (int32)	현재 처리 중인 파일 수입니다.
total	integer (int32)	총 파일 수입니다.

VectorStoreOptions

Object

벡터 저장소를 만들기 위한 요청 개체입니다.

Name	형식	Description
chunking_strategy	VectorStoreChunkingStrategyRequest: VectorStoreAutoChunkingStrategyRequest VectorStoreStaticChunkingStrategyRequest	파일을 청크하는 데 사용되는 청크 전략입니다. 설정하지 않으면 자동 전략을 사용합니다. file_ids 비어있지 않은 경우에만 적용됩니다.
configuration	VectorStoreConfiguration	Azure 자산 URI에서 벡터 저장소를 만들 때 사용되는 벡터 저장소 구성입니다.
expires_after	VectorStoreExpirationPolicy	이 벡터 저장소가 만료되는 시기에 대한 세부 정보
file_ids	string[]	벡터 저장소에서 사용해야 하는 파일 ID 목록입니다. 파일에 액세스할 수 있는 `file_search`와 같은 도구에 유용합니다.
metadata	object	개체에 연결할 수 있는 최대 16개의 키/값 쌍 집합으로, 해당 개체에 대한 추가 정보를 구조화된 형식으로 저장하는 데 사용됩니다. 키의 길이는 최대 64자이고 값의 길이는 최대 512자일 수 있습니다.
name	string	벡터 저장소의 이름입니다.

VectorStoreStaticChunkingStrategyOptions

Object

벡터 저장소 정적 청크 전략을 구성하는 옵션입니다.

Name	형식	Description
chunk_overlap_tokens	integer (int32)	청크 간에 겹치는 토큰 수입니다. 기본값은 400입니다. 중첩이 max_chunk_size_tokens 절반을 초과해서는 안 된다는 점에 유의하세요.
max_chunk_size_tokens	integer (int32) minimum: 100 maximum: 4096	각 청크의 최대 토큰 수입니다. 기본값은 800입니다. 최소값은 100이고 최대값은 4096입니다.

VectorStoreStaticChunkingStrategyRequest

Object

정적으로 구성된 청크 분할 전략입니다.

Name	형식	Description
static	VectorStoreStaticChunkingStrategyOptions	정적 청크 전략에 대한 옵션입니다.
type	string: static	개체 유형

VectorStoreStatus

열거형

벡터 저장 가능 상태

값	Description
completed	완료 상태는 이 벡터 저장소를 사용할 준비가 되었음을 나타냅니다.
expired	expired status는 이 벡터 저장소가 만료되어 더 이상 사용할 수 없음을 나타냅니다.
in_progress	in_progress 상태는 이 벡터 저장소가 여전히 파일을 처리하고 있음을 나타냅니다.

다음을 통해 공유

Vector Stores - Create Vector Store

URI 매개 변수

요청 본문

응답

보안

OAuth2Auth

범위

예제

VectorStores_CreateVectorStore_MaximumSet

샘플 요청

샘플 응답

VectorStores_CreateVectorStore_MinimumSet

샘플 요청

샘플 응답

정의

AgentErrorDetail

AgentV1Error

VectorStore

VectorStoreAutoChunkingStrategyRequest

VectorStoreChunkingStrategyRequestType

VectorStoreConfiguration

VectorStoreDataSource

VectorStoreDataSourceAssetType

VectorStoreExpirationPolicy

VectorStoreExpirationPolicyAnchor

VectorStoreFileCount

VectorStoreOptions

VectorStoreStaticChunkingStrategyOptions

VectorStoreStaticChunkingStrategyRequest

VectorStoreStatus