Package-level declarations

Types

Link copied to clipboard
@Serializable
data class ChunkingStrategy(val type: String = "auto", val static: StaticChunking? = null)

File chunking strategy. Omit static for automatic chunking.

Link copied to clipboard
@Serializable
data class ExpirationPolicy(val anchor: String, val days: Long)

The expiration policy for a vector store.

Link copied to clipboard
@Serializable
data class FileBatchRequest(val fileIds: List<FileId>)

A batch file request.

Link copied to clipboard
@Serializable
data class FileCounts(val inProgress: Long, val completed: Long, val failed: Long, val cancelled: Long, val total: Long)

The number of files that are currently being processed.

Link copied to clipboard
@Serializable
data class FilesBatch(val id: BatchId, val createdAt: Long, val vectorStoreId: VectorStoreId, val status: Status, val fileCounts: FileCounts)

A batch of files attached to a vector store.

Link copied to clipboard
@Serializable
data class StaticChunking(val maxChunkSizeTokens: Int, val chunkOverlapTokens: Int)

Sizes used when splitting a file into overlapping chunks.

Link copied to clipboard
@Serializable
data class VectorStore(val id: VectorStoreId, val createdAt: Long, val name: String? = null, val usageBytes: Long, val fileCounts: FileCounts, val status: Status, val expiresAfter: ExpirationPolicy? = null, val expiresAt: Long? = null, val lastActiveAt: Long? = null, val metadata: Map<String, String>? = null)

The vector store object.

Link copied to clipboard
@Serializable
data class VectorStoreContent(val type: String? = null, val text: String? = null)

Text extracted from an indexed file.

Link copied to clipboard
@Serializable
data class VectorStoreContentPage(val data: List<VectorStoreContent>, val hasMore: Boolean, val nextPage: String? = null)

A page of parsed file content.

Link copied to clipboard
@Serializable
class VectorStoreCreateRequest(val fileIds: List<FileId>? = null, val name: String? = null, val expiresAfter: ExpirationPolicy? = null, val metadata: Map<String, String>? = null, val description: String? = null, val chunkingStrategy: ChunkingStrategy? = null)

A request to create a new vector store.

Link copied to clipboard
@Serializable
data class VectorStoreFile(val id: FileId, val usageBytes: Long? = null, val createdAt: Long, val vectorStoreId: VectorStoreId, val status: Status, val lastError: LastError? = null)

A list of files attached to a vector store.

Link copied to clipboard
@Serializable
data class VectorStoreFileBatchRequest(val fileIds: List<FileId>? = null, val files: List<VectorStoreFileCreateRequest>? = null, val attributes: Map<String, JsonPrimitive>? = null, val chunkingStrategy: ChunkingStrategy? = null)

Creates a batch using shared configuration or a separate configuration for each attachment.

Link copied to clipboard
@Serializable
class VectorStoreFileCreateRequest(val fileId: FileId? = null, val attributes: Map<String, JsonPrimitive>? = null, val chunkingStrategy: ChunkingStrategy? = null)

A request to create a vector store file by attaching a File to a vector store.

Link copied to clipboard
@Serializable
class VectorStoreFileRequest(val fileId: FileId? = null)

A request to create a vector store file by attaching a File to a vector store.

Link copied to clipboard
@Serializable
data class VectorStoreFileResource(val id: FileId, val usageBytes: Long? = null, val createdAt: Long, val vectorStoreId: VectorStoreId, val status: Status, val lastError: LastError? = null, val attributes: Map<String, JsonPrimitive>? = null, val chunkingStrategy: ChunkingStrategy? = null)

A list of files attached to a vector store.

Link copied to clipboard
@Serializable
data class VectorStoreFilter(val type: String, val key: String? = null, val value: JsonElement? = null, val filters: List<VectorStoreFilter>? = null)

Attribute filter. Comparisons use key/value; and and or use nested filters.

Link copied to clipboard
@Serializable
value class VectorStoreId(val id: String)

The identifier of a vector store.

Link copied to clipboard
@Serializable
data class VectorStoreRankingOptions(val ranker: String? = null, val scoreThreshold: Double? = null)

Re-ranking configuration for vector search.

Link copied to clipboard
@Serializable
class VectorStoreRequest(val fileIds: List<FileId>? = null, val name: String? = null, val expiresAfter: ExpirationPolicy? = null, val metadata: Map<String, String>? = null)

A request to create a new vector store.

Link copied to clipboard
@Serializable
data class VectorStoreResource(val id: VectorStoreId, val createdAt: Long, val name: String? = null, val usageBytes: Long, val fileCounts: FileCounts, val status: Status, val expiresAfter: ExpirationPolicy? = null, val expiresAt: Long? = null, val lastActiveAt: Long? = null, val metadata: Map<String, String>? = null, val description: String? = null)

The vector store object.

Link copied to clipboard
@Serializable
data class VectorStoreSearchPage(val data: List<VectorStoreSearchResult>, val hasMore: Boolean, val nextPage: String? = null, val searchQuery: List<String> = emptyList())

Search results and the queries used by the server.

Link copied to clipboard
@Serializable
data class VectorStoreSearchRequest(val query: List<String>, val filters: VectorStoreFilter? = null, val maxNumResults: Int? = null, val rankingOptions: VectorStoreRankingOptions? = null, val rewriteQuery: Boolean? = null)

Searches indexed files using one or more natural-language queries.

Link copied to clipboard
@Serializable
data class VectorStoreSearchResult(val fileId: FileId, val filename: String, val score: Double, val content: List<VectorStoreContent>, val attributes: Map<String, JsonPrimitive>? = null)

A relevant file and the matched chunks.

Link copied to clipboard
data class VectorStoreUpdateRequest(val name: String? = null, val metadata: Map<String, String>? = null, val expiresAfter: ExpirationPolicy? = null, val clearName: Boolean = false, val clearMetadata: Boolean = false, val clearExpiresAfter: Boolean = false)

Updates only supplied fields. Use clearName, clearMetadata or clearExpiresAfter to send explicit nulls.