VectorStoreFile | /resources/beta/vector-stores/files.ts | openai@v4.56.0

namespace VectorStoreFile

import { VectorStoreFile } from "https://deno.land/x/openai@v4.56.0/resources/beta/vector-stores/files.ts";

Namespaces

VectorStoreFile.Static

Interfaces

I VectorStoreFile.LastError	The last error associated with this vector store file. Will be `null` if there are no errors.
I VectorStoreFile.Other	This is returned when the chunking strategy is unknown. Typically, this is because the file was indexed before the `chunking_strategy` concept was introduced in the API.
I VectorStoreFile.Static
I VectorStoreFile.Static.Static

interface VectorStoreFile

import { type VectorStoreFile } from "https://deno.land/x/openai@v4.56.0/resources/beta/vector-stores/files.ts";

A list of files attached to a vector store.

Properties

id: string

The identifier, which can be referenced in API endpoints.

created_at: number

The Unix timestamp (in seconds) for when the vector store file was created.

last_error: VectorStoreFile.LastError | null

The last error associated with this vector store file. Will be null if there are no errors.

object: "vector_store.file"

The object type, which is always vector_store.file.

status:

| "in_progress"

| "completed"

| "cancelled"

| "failed"

The status of the vector store file, which can be either in_progress, completed, cancelled, or failed. The status completed indicates that the vector store file is ready for use.

usage_bytes: number

The total vector store usage in bytes. Note that this may be different from the original file size.

vector_store_id: string

The ID of the vector store that the File is attached to.

optional

chunking_strategy: VectorStoreFile.Static | VectorStoreFile.Other

The strategy used to chunk the file.