# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for OpenAI Vector stores API
  version: 1.0.0
extends: openapi/openai-vector-stores-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 16
- target: $.paths['/vector_stores'].get
  update:
    x-apievangelist-phrasing:
      intent: List my vector stores
      effect: read
      questions:
      - Which vector stores have I created for file search?
      - Can I page through all my vector stores in ascending order?
      instructions:
      - text: List all of my vector stores.
      - text: Show the {limit} newest vector stores in my account.
        slots:
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/vector_stores'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a vector store
      effect: write
      questions:
      - How do I set up a new vector store so my assistant can search my documents?
      - Can I make a vector store expire automatically after it goes unused?
      - Is it possible to choose a chunking strategy when creating a vector store?
      instructions:
      - text: Create a vector store named {name}.
        slots:
          name: requestBody.name
      - text: Create a new vector store called {name} seeded with files {file_ids}.
        slots:
          name: requestBody.name
          file_ids: requestBody.file_ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/vector_stores/{vector_store_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a vector store
      effect: read
      questions:
      - How many files are in a vector store and are they done processing?
      - What's the current status and size of one of my vector stores?
      instructions:
      - text: Get vector store {vector_store_id}.
        slots:
          vector_store_id: path.vector_store_id
      - text: Show the file counts and status of vector store {vector_store_id}.
        slots:
          vector_store_id: path.vector_store_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/vector_stores/{vector_store_id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Rename or update a vector store
      effect: write
      questions:
      - Can I rename a vector store after creating it?
      - Can I change the expiration policy on an existing vector store?
      instructions:
      - text: Rename vector store {vector_store_id} to {name}.
        slots:
          vector_store_id: path.vector_store_id
          name: requestBody.name
      - text: Change the expiration policy of existing vector store {vector_store_id} to {expires_after}.
        slots:
          vector_store_id: path.vector_store_id
          expires_after: requestBody.expires_after
      method: generated
      generated: '2026-09-26'
- target: $.paths['/vector_stores/{vector_store_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a vector store
      effect: destructive
      questions:
      - How do I get rid of a vector store I'm done with?
      - What happens when I delete an entire vector store?
      instructions:
      - text: Delete vector store {vector_store_id}.
        slots:
          vector_store_id: path.vector_store_id
      - text: Permanently remove the whole vector store {vector_store_id}.
        slots:
          vector_store_id: path.vector_store_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/vector_stores/{vector_store_id}/file_batches'].post
  update:
    x-apievangelist-phrasing:
      intent: Add many files to a vector store at once
      effect: write
      questions:
      - What's the most efficient way to add hundreds of files to a vector store in one go?
      - How many files can I put in a single vector store file batch?
      instructions:
      - text: Add files {file_ids} to vector store {vector_store_id} as one batch.
        slots:
          file_ids: requestBody.file_ids
          vector_store_id: path.vector_store_id
      - text: Start a file batch on vector store {vector_store_id} with files {file_ids} using chunking strategy {chunking_strategy}.
        slots:
          vector_store_id: path.vector_store_id
          file_ids: requestBody.file_ids
          chunking_strategy: requestBody.chunking_strategy
      method: generated
      generated: '2026-09-26'
- target: $.paths['/vector_stores/{vector_store_id}/file_batches/{batch_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a vector store file batch
      effect: read
      questions:
      - Has my batch of files finished indexing into the vector store?
      - Can I see how many files in a batch completed or failed?
      instructions:
      - text: Get file batch {batch_id} on vector store {vector_store_id}.
        slots:
          batch_id: path.batch_id
          vector_store_id: path.vector_store_id
      - text: Check the progress of batch {batch_id} in vector store {vector_store_id}.
        slots:
          batch_id: path.batch_id
          vector_store_id: path.vector_store_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel a vector store file batch
      effect: destructive
      questions:
      - Can I stop a file batch that's still being processed into a vector store?
      - How do I cancel a batch upload I started by mistake?
      instructions:
      - text: Cancel file batch {batch_id} on vector store {vector_store_id}.
        slots:
          batch_id: path.batch_id
          vector_store_id: path.vector_store_id
      - text: Stop processing the files in batch {batch_id} for vector store {vector_store_id}.
        slots:
          batch_id: path.batch_id
          vector_store_id: path.vector_store_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/vector_stores/{vector_store_id}/file_batches/{batch_id}/files'].get
  update:
    x-apievangelist-phrasing:
      intent: List the files in a file batch
      effect: read
      questions:
      - Which files were part of a particular vector store batch?
      - Can I see only the files from a batch that failed to process?
      instructions:
      - text: List the files in batch {batch_id} of vector store {vector_store_id}.
        slots:
          batch_id: path.batch_id
          vector_store_id: path.vector_store_id
      - text: Show files with status {filter} in batch {batch_id} on vector store {vector_store_id}.
        slots:
          filter: query.filter
          batch_id: path.batch_id
          vector_store_id: path.vector_store_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/vector_stores/{vector_store_id}/files'].get
  update:
    x-apievangelist-phrasing:
      intent: List files in a vector store
      effect: read
      questions:
      - What files are currently indexed in my vector store?
      - Can I filter a vector store's files to only those still in progress?
      instructions:
      - text: List every file in vector store {vector_store_id}.
        slots:
          vector_store_id: path.vector_store_id
      - text: Show the {filter} files across all of vector store {vector_store_id}.
        slots:
          filter: query.filter
          vector_store_id: path.vector_store_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/vector_stores/{vector_store_id}/files'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a single file to a vector store
      effect: write
      questions:
      - How do I add one uploaded file to an existing vector store?
      - Can I tag a file with attributes as I add it to a vector store?
      instructions:
      - text: Add file {file_id} to vector store {vector_store_id}.
        slots:
          file_id: requestBody.file_id
          vector_store_id: path.vector_store_id
      - text: Attach file {file_id} to vector store {vector_store_id} with attributes {attributes}.
        slots:
          file_id: requestBody.file_id
          vector_store_id: path.vector_store_id
          attributes: requestBody.attributes
      method: generated
      generated: '2026-09-26'
- target: $.paths['/vector_stores/{vector_store_id}/files/{file_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a file in a vector store
      effect: read
      questions:
      - Did a particular file finish indexing in my vector store?
      - Why did one vector store file fail to process?
      instructions:
      - text: Get vector store file {file_id} in {vector_store_id}.
        slots:
          file_id: path.file_id
          vector_store_id: path.vector_store_id
      - text: Check the indexing status of file {file_id} in vector store {vector_store_id}.
        slots:
          file_id: path.file_id
          vector_store_id: path.vector_store_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/vector_stores/{vector_store_id}/files/{file_id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update attributes on a vector store file
      effect: write
      questions:
      - Can I change the filterable attributes on a file that's already in a vector store?
      - How do I re-tag an indexed file so search filters pick it up?
      instructions:
      - text: Set attributes {attributes} on file {file_id} in vector store {vector_store_id}.
        slots:
          attributes: requestBody.attributes
          file_id: path.file_id
          vector_store_id: path.vector_store_id
      - text: Replace the attributes of already-indexed file {file_id} in {vector_store_id} with {attributes}.
        slots:
          file_id: path.file_id
          vector_store_id: path.vector_store_id
          attributes: requestBody.attributes
      method: generated
      generated: '2026-09-26'
- target: $.paths['/vector_stores/{vector_store_id}/files/{file_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a file from a vector store
      effect: destructive
      questions:
      - Can I take a file out of a vector store without deleting the file itself?
      - Does removing a file from a vector store also delete the uploaded file?
      instructions:
      - text: Remove file {file_id} from vector store {vector_store_id}.
        slots:
          file_id: path.file_id
          vector_store_id: path.vector_store_id
      - text: Drop file {file_id} out of vector store {vector_store_id} but keep the original upload.
        slots:
          file_id: path.file_id
          vector_store_id: path.vector_store_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/vector_stores/{vector_store_id}/files/{file_id}/content'].get
  update:
    x-apievangelist-phrasing:
      intent: Read the parsed contents of a vector store file
      effect: read
      questions:
      - What text did the vector store actually extract from my file?
      - Can I see the parsed content of a file after it was indexed?
      instructions:
      - text: Show the parsed content of file {file_id} in vector store {vector_store_id}.
        slots:
          file_id: path.file_id
          vector_store_id: path.vector_store_id
      - text: Get the extracted text for vector store file {file_id} from {vector_store_id}.
        slots:
          file_id: path.file_id
          vector_store_id: path.vector_store_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/vector_stores/{vector_store_id}/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search a vector store
      effect: read
      questions:
      - How do I find the most relevant chunks in my vector store for a question?
      - Can I limit a vector store search to files with certain attributes?
      - Is there a cap on how many results a vector store search returns?
      instructions:
      - text: Search vector store {vector_store_id} for {query}.
        slots:
          vector_store_id: path.vector_store_id
          query: requestBody.query
      - text: Find the top {max_num_results} chunks matching {query} in vector store {vector_store_id}.
        slots:
          max_num_results: requestBody.max_num_results
          query: requestBody.query
          vector_store_id: path.vector_store_id
      - text: Search {vector_store_id} for {query} only in files matching {filters}.
        slots:
          vector_store_id: path.vector_store_id
          query: requestBody.query
          filters: requestBody.filters
      method: generated
      generated: '2026-09-26'