# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Cloudflare Vectorize Vectors API
  version: 1.0.0
extends: openapi/cloudflare-vectors-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: 5
- target: $.paths['/accounts/{account_id}/vectorize/v2/indexes/{index_name}/insert'].post
  update:
    x-apievangelist-phrasing:
      intent: Insert new vectors into an index
      effect: write
      questions:
      - How do I add new embeddings to a Vectorize index?
      - What happens if I insert a vector whose ID already exists?
      instructions:
      - text: Insert new vectors into index {index_name} in account {account_id}, failing on duplicate IDs.
        slots:
          index_name: path.index_name
          account_id: path.account_id
      - text: Add these brand-new embeddings to Vectorize index {index_name}.
        slots:
          index_name: path.index_name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounts/{account_id}/vectorize/v2/indexes/{index_name}/upsert'].post
  update:
    x-apievangelist-phrasing:
      intent: Insert or replace vectors in an index
      effect: write
      questions:
      - Can I overwrite vectors that already exist in my index?
      - Which call lets me add or replace embeddings in one go?
      instructions:
      - text: Upsert vectors into index {index_name} in account {account_id}, replacing any with matching IDs.
        slots:
          index_name: path.index_name
          account_id: path.account_id
      - text: Insert or update these embeddings in {index_name}.
        slots:
          index_name: path.index_name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounts/{account_id}/vectorize/v2/indexes/{index_name}/query'].post
  update:
    x-apievangelist-phrasing:
      intent: Find the nearest vectors to a query vector
      effect: read
      questions:
      - How do I run a similarity search against a Vectorize index?
      - Can I filter nearest-neighbor results by metadata?
      - Is it possible to return metadata along with the matched vectors?
      instructions:
      - text: Find the {topK} nearest vectors to {vector} in index {index_name}.
        slots:
          topK: requestBody.topK
          vector: requestBody.vector
          index_name: path.index_name
      - text: Run a similarity search in {index_name} for account {account_id} using {vector}, filtered by {filter}.
        slots:
          index_name: path.index_name
          account_id: path.account_id
          vector: requestBody.vector
          filter: requestBody.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounts/{account_id}/vectorize/v2/indexes/{index_name}/get_by_ids'].post
  update:
    x-apievangelist-phrasing:
      intent: Fetch specific vectors by their IDs
      effect: read
      questions:
      - Can I fetch particular vectors if I know their IDs?
      - What does a stored vector look like when I retrieve it by ID?
      instructions:
      - text: Get vectors {ids} from index {index_name}.
        slots:
          ids: requestBody.ids
          index_name: path.index_name
      - text: 'Retrieve vectors by ID from index {index_name} in account {account_id}: {ids}.'
        slots:
          index_name: path.index_name
          account_id: path.account_id
          ids: requestBody.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounts/{account_id}/vectorize/v2/indexes/{index_name}/delete_by_ids'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete specific vectors by their IDs
      effect: destructive
      questions:
      - How do I remove particular vectors from an index?
      - Can I delete embeddings by ID without dropping the whole index?
      instructions:
      - text: Delete vectors {ids} from index {index_name}.
        slots:
          ids: requestBody.ids
          index_name: path.index_name
      - text: 'Remove these vector IDs from {index_name} in account {account_id}: {ids}.'
        slots:
          index_name: path.index_name
          account_id: path.account_id
          ids: requestBody.ids
      method: generated
      generated: '2026-09-26'