Create Vector Store File

Options

OpenAI Beta

Calls to the Assistants API require that you pass a beta HTTP header.

Vector Store Id

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

Body

Request body which must comply to the following JSON Schema:

{
  "required" : [ "file_id" ],
  "type" : "object",
  "properties" : {
    "file_id" : {
      "type" : "string",
      "description" : "A [File](/docs/api-reference/files) ID that the vector store should use. Useful for tools like `file_search` that can access files."
    },
    "chunking_strategy" : {
      "type" : "object",
      "description" : "The chunking strategy used to chunk the file(s). If not set, will use the `auto` strategy.",
      "oneOf" : [ {
        "title" : "Auto Chunking Strategy",
        "required" : [ "type" ],
        "type" : "object",
        "properties" : {
          "type" : {
            "type" : "string",
            "description" : "Always `auto`.",
            "enum" : [ "auto" ]
          }
        },
        "additionalProperties" : false,
        "description" : "The default strategy. This strategy currently uses a `max_chunk_size_tokens` of `800` and `chunk_overlap_tokens` of `400`."
      }, {
        "title" : "Static Chunking Strategy",
        "required" : [ "static", "type" ],
        "type" : "object",
        "properties" : {
          "type" : {
            "type" : "string",
            "description" : "Always `static`.",
            "enum" : [ "static" ]
          },
          "static" : {
            "required" : [ "chunk_overlap_tokens", "max_chunk_size_tokens" ],
            "type" : "object",
            "properties" : {
              "max_chunk_size_tokens" : {
                "maximum" : 4096,
                "minimum" : 100,
                "type" : "integer",
                "description" : "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" : {
                "type" : "integer",
                "description" : "The number of tokens that overlap between chunks. The default value is `400`.\n\nNote that the overlap must not exceed half of `max_chunk_size_tokens`.\n"
              }
            },
            "additionalProperties" : false
          }
        },
        "additionalProperties" : false
      } ],
      "x-oaiExpandable" : true
    }
  },
  "additionalProperties" : false
}

Result Format

Specify how the response should be mapped to the table output. The following formats are available:

Raw Response: Returns the raw response in a single row with the following columns:

• body: Response body
• status: HTTP status code

Views

This node has no views

Workflows

• No workflows found

Links

• No links available

Developers