Create Vector Store

Go to Product

Create a vector store.

Options

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

Request body which must comply to the following JSON Schema:

{
  "type" : "object",
  "properties" : {
    "file_ids" : {
      "maxItems" : 500,
      "type" : "array",
      "description" : "A list of [File](/docs/api-reference/files) IDs that the vector store should use. Useful for tools like `file_search` that can access files.",
      "items" : {
        "type" : "string"
      }
    },
    "name" : {
      "type" : "string",
      "description" : "The name of the vector store."
    },
    "expires_after" : {
      "title" : "Vector store expiration policy",
      "required" : [ "anchor", "days" ],
      "type" : "object",
      "properties" : {
        "anchor" : {
          "type" : "string",
          "description" : "Anchor timestamp after which the expiration policy applies. Supported anchors: `last_active_at`.",
          "enum" : [ "last_active_at" ]
        },
        "days" : {
          "maximum" : 365,
          "minimum" : 1,
          "type" : "integer",
          "description" : "The number of days after the anchor time that the vector store will expire."
        }
      },
      "description" : "The expiration policy for a vector store."
    },
    "chunking_strategy" : {
      "type" : "object",
      "description" : "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.",
      "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
    },
    "metadata" : {
      "type" : "object",
      "description" : "metadata_description",
      "nullable" : true,
      "x-oaiTypeLabel" : "map"
    }
  },
  "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

Input Ports

Icon
Configuration data.

Output Ports

Icon
Result of the request depending on the selected Result Format.
Icon
Configuration data (this is the same as the input port; it is provided as passthrough for sequentially chaining nodes to declutter your workflow connections).

Popular Predecessors

  • No recommendations found

Popular Successors

  • No recommendations found

Views

This node has no views

Workflows

  • No workflows found

Links

Developers

You want to see the source code for this node? Click the following button and we’ll use our super-powers to find it for you.