Retrieve vector store file

VectorStoreFile vectorStores().files().retrieve(, )

GET/vector_stores/{vector_store_id}/files/{file_id}

Retrieves a vector store file.

ParametersExpand Collapse

FileRetrieveParams params

String vectorStoreId

Optional<String> fileId

ReturnsExpand Collapse

class VectorStoreFile:

A list of files attached to a vector store.

String id

The identifier, which can be referenced in API endpoints.

long createdAt

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

Optional<LastError> lastError

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

Code code

One of server_error, unsupported_file, or invalid_file.

Accepts one of the following:

SERVER_ERROR("server_error")

UNSUPPORTED_FILE("unsupported_file")

INVALID_FILE("invalid_file")

String message

A human-readable description of the error.

JsonValue; object_

The object type, which is always vector_store.file.

Status status

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:

IN_PROGRESS("in_progress")

COMPLETED("completed")

CANCELLED("cancelled")

FAILED("failed")

long usageBytes

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

String vectorStoreId

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

Optional<Attributes> attributes

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

double

boolean

Optional<FileChunkingStrategy> chunkingStrategy

The strategy used to chunk the file.

Accepts one of the following:

class StaticFileChunkingStrategyObject:

StaticFileChunkingStrategy static_

long chunkOverlapTokens

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.

long maxChunkSizeTokens

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

JsonValue; type

Always static.

class OtherFileChunkingStrategyObject:

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.

JsonValue; type

Always other.

Retrieve vector store file

package com.openai.example;

import com.openai.client.OpenAIClient;
import com.openai.client.okhttp.OpenAIOkHttpClient;
import com.openai.models.vectorstores.files.FileRetrieveParams;
import com.openai.models.vectorstores.files.VectorStoreFile;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        OpenAIClient client = OpenAIOkHttpClient.fromEnv();

        FileRetrieveParams params = FileRetrieveParams.builder()
            .vectorStoreId("vs_abc123")
            .fileId("file-abc123")
            .build();
        VectorStoreFile vectorStoreFile = client.vectorStores().files().retrieve(params);
    }
}

{
  "id": "file-abc123",
  "object": "vector_store.file",
  "created_at": 1699061776,
  "vector_store_id": "vs_abcd",
  "status": "completed",
  "last_error": null
}

Returns Examples

{
  "id": "file-abc123",
  "object": "vector_store.file",
  "created_at": 1699061776,
  "vector_store_id": "vs_abcd",
  "status": "completed",
  "last_error": null
}