List vector store files

client.VectorStores.Files.List(ctx, vectorStoreID, query) (*CursorPage[VectorStoreFile], error)

GET/vector_stores/{vector_store_id}/files

Returns a list of vector store files.

ParametersExpand Collapse

vectorStoreID string

query VectorStoreFileListParams

After param.Field[string]optional

A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.

Before param.Field[string]optional

A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.

Filter param.Field[VectorStoreFileListParamsFilter]optional

Filter by file status. One of in_progress, completed, failed, cancelled.

const VectorStoreFileListParamsFilterInProgress VectorStoreFileListParamsFilter = "in_progress"

const VectorStoreFileListParamsFilterCompleted VectorStoreFileListParamsFilter = "completed"

const VectorStoreFileListParamsFilterFailed VectorStoreFileListParamsFilter = "failed"

const VectorStoreFileListParamsFilterCancelled VectorStoreFileListParamsFilter = "cancelled"

Limit param.Field[int64]optional

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.

Order param.Field[VectorStoreFileListParamsOrder]optional

Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order.

const VectorStoreFileListParamsOrderAsc VectorStoreFileListParamsOrder = "asc"

const VectorStoreFileListParamsOrderDesc VectorStoreFileListParamsOrder = "desc"

ReturnsExpand Collapse

type VectorStoreFile struct{…}

A list of files attached to a vector store.

ID string

The identifier, which can be referenced in API endpoints.

CreatedAt int64

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

LastError VectorStoreFileLastError

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

Code string

One of server_error, unsupported_file, or invalid_file.

Accepts one of the following:

const VectorStoreFileLastErrorCodeServerError VectorStoreFileLastErrorCode = "server_error"

const VectorStoreFileLastErrorCodeUnsupportedFile VectorStoreFileLastErrorCode = "unsupported_file"

const VectorStoreFileLastErrorCodeInvalidFile VectorStoreFileLastErrorCode = "invalid_file"

Message string

A human-readable description of the error.

Object VectorStoreFile

The object type, which is always vector_store.file.

Status VectorStoreFileStatus

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.

Accepts one of the following:

const VectorStoreFileStatusInProgress VectorStoreFileStatus = "in_progress"

const VectorStoreFileStatusCompleted VectorStoreFileStatus = "completed"

const VectorStoreFileStatusCancelled VectorStoreFileStatus = "cancelled"

const VectorStoreFileStatusFailed VectorStoreFileStatus = "failed"

UsageBytes int64

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

VectorStoreID string

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

Attributes map[string, VectorStoreFileAttributeUnion]optional

Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters, booleans, or numbers.

Accepts one of the following:

string

float64

bool

ChunkingStrategy FileChunkingStrategyUnionoptional

The strategy used to chunk the file.

Accepts one of the following:

type StaticFileChunkingStrategyObject struct{…}

Static StaticFileChunkingStrategy

ChunkOverlapTokens int64

The number of tokens that overlap between chunks. The default value is 400.

Note that the overlap must not exceed half of max_chunk_size_tokens.

MaxChunkSizeTokens int64

The maximum number of tokens in each chunk. The default value is 800. The minimum value is 100 and the maximum value is 4096.

minimum100

maximum4096

Type Static

Always static.

type OtherFileChunkingStrategyObject struct{…}

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.

Type Other

Always other.

List vector store files

package main

import (
  "context"
  "fmt"

  "github.com/openai/openai-go"
  "github.com/openai/openai-go/option"
)

func main() {
  client := openai.NewClient(
    option.WithAPIKey("My API Key"),
  )
  page, err := client.VectorStores.Files.List(
    context.TODO(),
    "vector_store_id",
    openai.VectorStoreFileListParams{

    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", page)
}

{
  "object": "list",
  "data": [
    {
      "id": "file-abc123",
      "object": "vector_store.file",
      "created_at": 1699061776,
      "vector_store_id": "vs_abc123"
    },
    {
      "id": "file-abc456",
      "object": "vector_store.file",
      "created_at": 1699061776,
      "vector_store_id": "vs_abc123"
    }
  ],
  "first_id": "file-abc123",
  "last_id": "file-abc456",
  "has_more": false
}

Returns Examples

{
  "object": "list",
  "data": [
    {
      "id": "file-abc123",
      "object": "vector_store.file",
      "created_at": 1699061776,
      "vector_store_id": "vs_abc123"
    },
    {
      "id": "file-abc456",
      "object": "vector_store.file",
      "created_at": 1699061776,
      "vector_store_id": "vs_abc123"
    }
  ],
  "first_id": "file-abc123",
  "last_id": "file-abc456",
  "has_more": false
}