REST: Create vector store file

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

HTTP request

POST https://ai.api.cloud.yandex.net/v1/vector_stores/{vector_store_id}/files

Path parameters

Field

Description

vector_store_id

string

Required field. The ID of the vector store for which to create a File.

Body parameters

Request schema: application/json

{
          "file_id": "string",
          "chunking_strategy": {
            "<anyOf>": [
              {
                "description": "string",
                "name": "string",
                "parameters": "object"
              },
              {
                "type": "string",
                "static": {
                  "max_chunk_size_tokens": "integer",
                  "chunk_overlap_tokens": "integer"
                }
              }
            ]
          },
          "attributes": "unknown"
        }

Field

Description

file_id

string

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

chunking_strategy

Any of AutoChunkingStrategyRequestParam | StaticChunkingStrategyRequestParam

attributes

Any of object (map<string, string>) | null

AutoChunkingStrategyRequestParam

Schema reference for server-to-client Realtime events. Servers emit JSON messages where the type field selects the event schema.

Field

Description

description

string

A description of what the function does, used by the model to choose when and how to call the function.

name

string

Required field. The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.

parameters

object

The parameters the functions accepts, described as a JSON Schema object.

StaticChunkingStrategyRequestParam

Customize your own chunking strategy by setting chunk size and chunk overlap.

Field

Description

type

enum

Required field. Always static.

  • static

static

StaticChunkingStrategy

Required field.

StaticChunkingStrategy

Field

Description

max_chunk_size_tokens

integer

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

chunk_overlap_tokens

integer

Required field. 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.

Response

HTTP Code: 200

OK

Response schema: application/json

{
          "id": "string",
          "object": "string",
          "usage_bytes": "integer",
          "created_at": "integer",
          "vector_store_id": "string",
          "status": "string",
          "last_error": "unknown",
          "chunking_strategy": {
            "<anyOf>": [
              {
                "type": "string",
                "static": {
                  "max_chunk_size_tokens": "integer",
                  "chunk_overlap_tokens": "integer"
                }
              },
              {
                "type": "string"
              }
            ]
          },
          "attributes": "unknown"
        }

A list of files attached to a vector store.

Field

Description

id

string

Required field. The identifier, which can be referenced in API endpoints.

object

enum

Required field. The object type, which is always vector_store.file.

  • vector_store.file

usage_bytes

integer

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

created_at

integer

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

vector_store_id

string

Required field. The ID of the vector store that the file is attached to.

status

enum

Required field. 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.

  • in_progress
  • completed
  • cancelled
  • failed

last_error

Any of LastError0 | null

chunking_strategy

Any of StaticChunkingStrategyResponseParam | OtherChunkingStrategyResponseParam

attributes

Any of object (map<string, string>) | null

LastError0

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

Field

Description

code

enum

Required field. One of server_error, unsupported_file, or invalid_file.

  • server_error
  • unsupported_file
  • invalid_file

message

string

Required field. A human-readable description of the error.

StaticChunkingStrategyResponseParam

Field

Description

type

enum

Required field. Always static.

  • static

static

StaticChunkingStrategy

Required field.

StaticChunkingStrategy

Field

Description

max_chunk_size_tokens

integer

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

chunk_overlap_tokens

integer

Required field. 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.

OtherChunkingStrategyResponseParam

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.

Field

Description

type

enum

Required field. Always other.

  • other
Previous
listVectorStoreFiles
Next
getVectorStoreFile