Skip to content
API Reference
Vector Stores
Files

Create vector store file

client.VectorStores.Files.New(ctx, vectorStoreID, body) (*VectorStoreFile, error)
POST/vector_stores/{vector_store_id}/files

Create a vector store file by attaching a File to a vector store.

ParametersExpand Collapse
vectorStoreID string
body VectorStoreFileNewParams
FileID param.Field[string]

A File ID that the vector store should use. Useful for tools like file_search that can access files.

Attributes param.Field[map[string, VectorStoreFileNewParamsAttributeUnion]]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.

string
float64
bool
ChunkingStrategy param.Field[FileChunkingStrategyParamUnionResp]optional

The chunking strategy used to chunk the file(s). If not set, will use the auto strategy. Only applicable if file_ids is non-empty.

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{…}
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.

Create vector store file

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"),
  )
  vectorStoreFile, err := client.VectorStores.Files.New(
    context.TODO(),
    "vs_abc123",
    openai.VectorStoreFileNewParams{
      FileID: "file_id",
    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", vectorStoreFile.ID)
}

{
  "id": "id",
  "created_at": 0,
  "last_error": {
    "code": "server_error",
    "message": "message"
  },
  "object": "vector_store.file",
  "status": "in_progress",
  "usage_bytes": 0,
  "vector_store_id": "vector_store_id",
  "attributes": {
    "foo": "string"
  },
  "chunking_strategy": {
    "static": {
      "chunk_overlap_tokens": 0,
      "max_chunk_size_tokens": 100
    },
    "type": "static"
  }
}
Returns Examples
{
  "id": "id",
  "created_at": 0,
  "last_error": {
    "code": "server_error",
    "message": "message"
  },
  "object": "vector_store.file",
  "status": "in_progress",
  "usage_bytes": 0,
  "vector_store_id": "vector_store_id",
  "attributes": {
    "foo": "string"
  },
  "chunking_strategy": {
    "static": {
      "chunk_overlap_tokens": 0,
      "max_chunk_size_tokens": 100
    },
    "type": "static"
  }
}