# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Appwrite Vectors DB API
  version: 1.0.0
extends: openapi/appwrite-vectorsdb-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: 35
- target: $.paths['/vectorsdb'].get
  update:
    x-apievangelist-phrasing:
      intent: List vector databases in the project
      effect: read
      questions:
      - Which vector databases exist in my Appwrite project?
      - Can I filter my vector databases with queries and get a total count?
      instructions:
      - text: List all my vector databases.
      - text: List vector databases matching {queries}.
        slots:
          queries: query.queries
      method: generated
      generated: '2026-09-26'
- target: $.paths['/vectorsdb'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a vector database
      effect: write
      questions:
      - How do I create a new database for storing embeddings?
      - Can I provision a vector database on dedicated hardware with high-availability replicas?
      - What is the default specification when I create a vector database?
      instructions:
      - text: Create vector database {databaseId} named {name}.
        slots:
          databaseId: requestBody.databaseId
          name: requestBody.name
      - text: Create dedicated vector database {databaseId} named {name} on specification {specification} with {replicas} replicas.
        slots:
          databaseId: requestBody.databaseId
          name: requestBody.name
          specification: requestBody.specification
          replicas: requestBody.replicas
      method: generated
      generated: '2026-09-26'
- target: $.paths['/vectorsdb/specifications'].get
  update:
    x-apievangelist-phrasing:
      intent: List dedicated vector database plans and prices
      effect: read
      questions:
      - What dedicated database specifications can I choose from on my current plan?
      - How much does each dedicated vector database size cost, including overage rates?
      instructions:
      - text: List the dedicated database specifications available to me.
      - text: Show the resource limits and prices of each dedicated vector database specification.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/vectorsdb/transactions'].get
  update:
    x-apievangelist-phrasing:
      intent: List transactions across vector databases
      effect: read
      questions:
      - Which transactions are open across my vector databases?
      - Can I filter vector database transactions with queries?
      instructions:
      - text: List all vector database transactions.
      - text: List vector database transactions matching {queries}.
        slots:
          queries: query.queries
      method: generated
      generated: '2026-09-26'
- target: $.paths['/vectorsdb/transactions'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a vector database transaction
      effect: write
      questions:
      - How do I group several vector document writes into one atomic transaction?
      - Can I set how long a vector database transaction stays open?
      instructions:
      - text: Start a new vector database transaction.
      - text: Open a vector database transaction with a time-to-live of {ttl} seconds.
        slots:
          ttl: requestBody.ttl
      method: generated
      generated: '2026-09-26'
- target: $.paths['/vectorsdb/transactions/{transactionId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a vector database transaction
      effect: read
      questions:
      - What is the current state of a specific vector database transaction?
      - Can I look up one vector transaction by its ID?
      instructions:
      - text: Get vector database transaction {transactionId}.
        slots:
          transactionId: path.transactionId
      - text: Show the status of vector transaction {transactionId}.
        slots:
          transactionId: path.transactionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/vectorsdb/transactions/{transactionId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a vector database transaction
      effect: destructive
      questions:
      - How do I discard a vector database transaction record entirely?
      - Can I delete a vector transaction by its ID?
      instructions:
      - text: Delete vector database transaction {transactionId}.
        slots:
          transactionId: path.transactionId
      - text: Remove vector transaction {transactionId}.
        slots:
          transactionId: path.transactionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/vectorsdb/transactions/{transactionId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Commit or roll back a vector database transaction
      effect: write
      questions:
      - How do I commit the staged operations in a vector database transaction?
      - Can I roll back a vector transaction instead of committing it?
      instructions:
      - text: Commit vector database transaction {transactionId}.
        slots:
          transactionId: path.transactionId
      - text: Roll back vector transaction {transactionId} by setting rollback to {rollback}.
        slots:
          transactionId: path.transactionId
          rollback: requestBody.rollback
      method: generated
      generated: '2026-09-26'
- target: $.paths['/vectorsdb/transactions/{transactionId}/operations'].post
  update:
    x-apievangelist-phrasing:
      intent: Stage operations in a vector database transaction
      effect: write
      questions:
      - Can I add several vector document operations to an open transaction in one call?
      - How do I queue writes inside a vector database transaction before committing?
      instructions:
      - text: Add operations {operations} to vector transaction {transactionId}.
        slots:
          operations: requestBody.operations
          transactionId: path.transactionId
      - text: 'Stage these operations in vector database transaction {transactionId}: {operations}.'
        slots:
          transactionId: path.transactionId
          operations: requestBody.operations
      method: generated
      generated: '2026-09-26'
- target: $.paths['/vectorsdb/{databaseId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a vector database's metadata
      effect: read
      questions:
      - What specification and settings does one of my vector databases use?
      - Can I fetch a single vector database by its ID?
      instructions:
      - text: Get vector database {databaseId}.
        slots:
          databaseId: path.databaseId
      - text: Show the metadata of vector database {databaseId}.
        slots:
          databaseId: path.databaseId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/vectorsdb/{databaseId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a vector database's settings
      effect: write
      questions:
      - Can I resize a vector database by changing its specification?
      - How do I change the replica count or sync mode on an existing vector database?
      instructions:
      - text: Rename vector database {databaseId} to {name}.
        slots:
          databaseId: path.databaseId
          name: requestBody.name
      - text: Move vector database {databaseId} named {name} to specification {specification}.
        slots:
          databaseId: path.databaseId
          name: requestBody.name
          specification: requestBody.specification
      - text: Set vector database {databaseId} ({name}) to {replicas} replicas using sync mode {syncMode}.
        slots:
          databaseId: path.databaseId
          name: requestBody.name
          replicas: requestBody.replicas
          syncMode: requestBody.syncMode
      method: generated
      generated: '2026-09-26'
- target: $.paths['/vectorsdb/{databaseId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a vector database
      effect: destructive
      questions:
      - How do I permanently delete a vector database and everything in it?
      - What API key scope is needed to delete a vector database?
      instructions:
      - text: Delete vector database {databaseId}.
        slots:
          databaseId: path.databaseId
      - text: Permanently remove vector database {databaseId}.
        slots:
          databaseId: path.databaseId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/vectorsdb/{databaseId}/collections'].get
  update:
    x-apievangelist-phrasing:
      intent: List collections in a vector database
      effect: read
      questions:
      - Which embedding collections live in a vector database?
      - Can I search a vector database's collections by name?
      instructions:
      - text: List collections in vector database {databaseId}.
        slots:
          databaseId: path.databaseId
      - text: Search vector database {databaseId} for collections named {search}.
        slots:
          databaseId: path.databaseId
          search: query.search
      method: generated
      generated: '2026-09-26'
- target: $.paths['/vectorsdb/{databaseId}/collections'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a vector collection with a set dimension
      effect: write
      questions:
      - How do I create a collection sized for my embedding model's vector dimension?
      - Can I turn on document-level security when creating a vector collection?
      instructions:
      - text: Create collection {collectionId} named {name} in vector database {databaseId} with dimension {dimension}.
        slots:
          collectionId: requestBody.collectionId
          name: requestBody.name
          databaseId: path.databaseId
          dimension: requestBody.dimension
      - text: Add a {dimension}-dimension vector collection {collectionId} called {name} to {databaseId} with permissions {permissions}.
        slots:
          dimension: requestBody.dimension
          collectionId: requestBody.collectionId
          name: requestBody.name
          databaseId: path.databaseId
          permissions: requestBody.permissions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/vectorsdb/{databaseId}/collections/{collectionId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a vector collection's metadata
      effect: read
      questions:
      - What dimension and permissions does a vector collection have?
      - Can I look up one vector collection by its ID?
      instructions:
      - text: Get vector collection {collectionId} in database {databaseId}.
        slots:
          collectionId: path.collectionId
          databaseId: path.databaseId
      - text: Show the settings of collection {collectionId} in vector database {databaseId}.
        slots:
          collectionId: path.collectionId
          databaseId: path.databaseId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/vectorsdb/{databaseId}/collections/{collectionId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a vector collection's settings
      effect: write
      questions:
      - Can I change the dimension or permissions of an existing vector collection?
      - How do I disable a vector collection without deleting it?
      instructions:
      - text: Rename vector collection {collectionId} in {databaseId} to {name}.
        slots:
          collectionId: path.collectionId
          databaseId: path.databaseId
          name: requestBody.name
      - text: Set the dimension of vector collection {collectionId} ({name}) in {databaseId} to {dimension}.
        slots:
          collectionId: path.collectionId
          name: requestBody.name
          databaseId: path.databaseId
          dimension: requestBody.dimension
      method: generated
      generated: '2026-09-26'
- target: $.paths['/vectorsdb/{databaseId}/collections/{collectionId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a vector collection
      effect: destructive
      questions:
      - How do I delete a whole vector collection and its embeddings?
      - Who is allowed to delete a vector collection?
      instructions:
      - text: Delete vector collection {collectionId} from database {databaseId}.
        slots:
          collectionId: path.collectionId
          databaseId: path.databaseId
      - text: Drop collection {collectionId} in vector database {databaseId}.
        slots:
          collectionId: path.collectionId
          databaseId: path.databaseId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/vectorsdb/{databaseId}/collections/{collectionId}/documents'].get
  update:
    x-apievangelist-phrasing:
      intent: List documents in a vector collection
      effect: read
      questions:
      - Which embedding documents are stored in a vector collection?
      - Can I read vector documents as they appear inside an uncommitted transaction?
      instructions:
      - text: List documents in vector collection {collectionId} of database {databaseId}.
        slots:
          collectionId: path.collectionId
          databaseId: path.databaseId
      - text: List vector documents in {collectionId} of {databaseId} filtered by {queries} in the URL.
        slots:
          collectionId: path.collectionId
          databaseId: path.databaseId
          queries: query.queries
      method: generated
      generated: '2026-09-26'
- target: $.paths['/vectorsdb/{databaseId}/collections/{collectionId}/documents'].put
  update:
    x-apievangelist-phrasing:
      intent: Bulk create or update vector documents
      effect: write
      questions:
      - How do I insert or update many embedding documents in one request?
      - Can a bulk vector upsert run inside a transaction?
      instructions:
      - text: Upsert documents {documents} into vector collection {collectionId} of {databaseId}.
        slots:
          documents: requestBody.documents
          collectionId: path.collectionId
          databaseId: path.databaseId
      - text: Bulk upsert {documents} into vector collection {collectionId} in {databaseId} within transaction {transactionId}.
        slots:
          documents: requestBody.documents
          collectionId: path.collectionId
          databaseId: path.databaseId
          transactionId: requestBody.transactionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/vectorsdb/{databaseId}/collections/{collectionId}/documents'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a document in a vector collection
      effect: write
      questions:
      - How do I store a new embedding as a document in a vector collection?
      - Can I set permissions on a vector document when I create it?
      instructions:
      - text: Create document {documentId} in vector collection {collectionId} of {databaseId} with data {data}.
        slots:
          documentId: requestBody.documentId
          collectionId: path.collectionId
          databaseId: path.databaseId
          data: requestBody.data
      - text: Add vector document {documentId} with {data} and permissions {permissions} to {collectionId} in {databaseId}.
        slots:
          documentId: requestBody.documentId
          data: requestBody.data
          permissions: requestBody.permissions
          collectionId: path.collectionId
          databaseId: path.databaseId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/vectorsdb/{databaseId}/collections/{collectionId}/documents'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete vector documents by query
      effect: destructive
      questions:
      - How do I delete every vector document that matches a filter?
      - What happens if I bulk delete vector documents without passing any queries?
      instructions:
      - text: Delete vector documents in {collectionId} of {databaseId} matching {queries}.
        slots:
          collectionId: path.collectionId
          databaseId: path.databaseId
          queries: query.queries
      - text: Clear all documents from vector collection {collectionId} in database {databaseId}.
        slots:
          collectionId: path.collectionId
          databaseId: path.databaseId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/vectorsdb/{databaseId}/collections/{collectionId}/documents'].patch
  update:
    x-apievangelist-phrasing:
      intent: Bulk update vector documents matching a query
      effect: write
      questions:
      - Can I change a field on every vector document that matches a filter?
      - What happens if I bulk update vector documents with no queries?
      instructions:
      - text: Set {data} on all vector documents in {collectionId} of {databaseId} matching {queries}.
        slots:
          data: requestBody.data
          collectionId: path.collectionId
          databaseId: path.databaseId
          queries: requestBody.queries
      - text: Apply {data} to every document in vector collection {collectionId} of {databaseId}.
        slots:
          data: requestBody.data
          collectionId: path.collectionId
          databaseId: path.databaseId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/vectorsdb/{databaseId}/collections/{collectionId}/documents/query'].post
  update:
    x-apievangelist-phrasing:
      intent: Query vector documents with filters in the body
      effect: read
      questions:
      - How do I send very large vector queries that don't fit in a URL?
      - Can I query a vector collection with a POST body instead of query parameters?
      instructions:
      - text: Query vector collection {collectionId} in {databaseId} with body queries {queries}.
        slots:
          collectionId: path.collectionId
          databaseId: path.databaseId
          queries: requestBody.queries
      - text: Run a POST query {queries} against {collectionId} in vector database {databaseId} inside transaction {transactionId}.
        slots:
          queries: requestBody.queries
          collectionId: path.collectionId
          databaseId: path.databaseId
          transactionId: requestBody.transactionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/vectorsdb/{databaseId}/collections/{collectionId}/documents/{documentId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one document from a vector collection
      effect: read
      questions:
      - How can I fetch a single embedding document by its ID?
      - Can I read one vector document as it looks inside a pending transaction?
      instructions:
      - text: Get vector document {documentId} from {collectionId} in {databaseId}.
        slots:
          documentId: path.documentId
          collectionId: path.collectionId
          databaseId: path.databaseId
      - text: Read vector document {documentId} in {collectionId} of {databaseId} within transaction {transactionId}.
        slots:
          documentId: path.documentId
          collectionId: path.collectionId
          databaseId: path.databaseId
          transactionId: query.transactionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/vectorsdb/{databaseId}/collections/{collectionId}/documents/{documentId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or replace a single vector document
      effect: write
      questions:
      - Can I write a vector document by ID whether or not it already exists?
      - What's the way to upsert just one embedding document?
      instructions:
      - text: Upsert vector document {documentId} in {collectionId} of {databaseId} with {data}.
        slots:
          documentId: path.documentId
          collectionId: path.collectionId
          databaseId: path.databaseId
          data: requestBody.data
      - text: Create or overwrite vector document {documentId} in {collectionId} ({databaseId}) with {data}.
        slots:
          documentId: path.documentId
          collectionId: path.collectionId
          databaseId: path.databaseId
          data: requestBody.data
      method: generated
      generated: '2026-09-26'
- target: $.paths['/vectorsdb/{databaseId}/collections/{collectionId}/documents/{documentId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete one vector document
      effect: destructive
      questions:
      - How do I remove a single embedding document by its ID?
      - Can deleting one vector document be part of a transaction?
      instructions:
      - text: Delete vector document {documentId} from {collectionId} in {databaseId}.
        slots:
          documentId: path.documentId
          collectionId: path.collectionId
          databaseId: path.databaseId
      - text: Remove vector document {documentId} in {collectionId} of {databaseId} as part of transaction {transactionId}.
        slots:
          documentId: path.documentId
          collectionId: path.collectionId
          databaseId: path.databaseId
          transactionId: query.transactionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/vectorsdb/{databaseId}/collections/{collectionId}/documents/{documentId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Partially update one vector document
      effect: write
      questions:
      - Can I change only some fields of an existing embedding document?
      - How do I update the permissions on one vector document?
      instructions:
      - text: Update vector document {documentId} in {collectionId} of {databaseId} with {data}.
        slots:
          documentId: path.documentId
          collectionId: path.collectionId
          databaseId: path.databaseId
          data: requestBody.data
      - text: Set permissions {permissions} on vector document {documentId} in {collectionId} ({databaseId}).
        slots:
          permissions: requestBody.permissions
          documentId: path.documentId
          collectionId: path.collectionId
          databaseId: path.databaseId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/vectorsdb/{databaseId}/collections/{collectionId}/indexes'].get
  update:
    x-apievangelist-phrasing:
      intent: List indexes on a vector collection
      effect: read
      questions:
      - Which indexes are defined on my vector collection?
      - Can I filter a vector collection's indexes with queries?
      instructions:
      - text: List indexes on vector collection {collectionId} in {databaseId}.
        slots:
          collectionId: path.collectionId
          databaseId: path.databaseId
      - text: Show vector indexes in {collectionId} of {databaseId} matching {queries}.
        slots:
          collectionId: path.collectionId
          databaseId: path.databaseId
          queries: query.queries
      method: generated
      generated: '2026-09-26'
- target: $.paths['/vectorsdb/{databaseId}/collections/{collectionId}/indexes'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an index on a vector collection
      effect: write
      questions:
      - How do I add an index to speed up queries on a vector collection?
      - What index types can I create on vector collection attributes?
      instructions:
      - text: Create index {key} of type {type} on attributes {attributes} in vector collection {collectionId} of {databaseId}.
        slots:
          key: requestBody.key
          type: requestBody.type
          attributes: requestBody.attributes
          collectionId: path.collectionId
          databaseId: path.databaseId
      - text: Add a {type} vector index {key} over {attributes} to {collectionId} in {databaseId}.
        slots:
          type: requestBody.type
          key: requestBody.key
          attributes: requestBody.attributes
          collectionId: path.collectionId
          databaseId: path.databaseId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/vectorsdb/{databaseId}/collections/{collectionId}/indexes/{key}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one index on a vector collection
      effect: read
      questions:
      - What attributes and type does a specific vector index cover?
      - Can I check whether a vector index has finished building?
      instructions:
      - text: Get vector index {key} on {collectionId} in {databaseId}.
        slots:
          key: path.key
          collectionId: path.collectionId
          databaseId: path.databaseId
      - text: Show details of index {key} in vector collection {collectionId} of {databaseId}.
        slots:
          key: path.key
          collectionId: path.collectionId
          databaseId: path.databaseId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/vectorsdb/{databaseId}/collections/{collectionId}/indexes/{key}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an index from a vector collection
      effect: destructive
      questions:
      - How do I drop an index I no longer need on a vector collection?
      - Can I remove a vector index by its key?
      instructions:
      - text: Delete vector index {key} from {collectionId} in {databaseId}.
        slots:
          key: path.key
          collectionId: path.collectionId
          databaseId: path.databaseId
      - text: Drop index {key} on vector collection {collectionId} of {databaseId}.
        slots:
          key: path.key
          collectionId: path.collectionId
          databaseId: path.databaseId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/vectorsdb/{databaseId}/failovers'].post
  update:
    x-apievangelist-phrasing:
      intent: Fail over a dedicated vector database to a replica
      effect: write
      questions:
      - How do I manually promote a replica to primary on a high-availability vector database?
      - Can I choose which replica gets promoted during a failover?
      - Is a manual failover also a way to repair a database stuck mid-operation?
      instructions:
      - text: Trigger a failover for vector database {databaseId}.
        slots:
          databaseId: path.databaseId
      - text: Fail over vector database {databaseId} and promote replica {targetReplicaId} to primary.
        slots:
          databaseId: path.databaseId
          targetReplicaId: requestBody.targetReplicaId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/vectorsdb/{databaseId}/operations'].get
  update:
    x-apievangelist-phrasing:
      intent: List lifecycle operations of a dedicated vector database
      effect: read
      questions:
      - What provisioning, backup and restore actions have run on my dedicated vector database?
      - Can I see only the failed lifecycle operations for a database?
      instructions:
      - text: List lifecycle operations for vector database {databaseId}.
        slots:
          databaseId: path.databaseId
      - text: Show the last {limit} operations on vector database {databaseId} with status {status}.
        slots:
          limit: query.limit
          databaseId: path.databaseId
          status: query.status
      method: generated
      generated: '2026-09-26'
- target: $.paths['/vectorsdb/{databaseId}/replicas'].get
  update:
    x-apievangelist-phrasing:
      intent: Check replica health and replication lag
      effect: read
      questions:
      - How far behind are the replicas of my dedicated vector database?
      - Which sync mode is my high-availability vector database running in?
      instructions:
      - text: Get the replica status of vector database {databaseId}.
        slots:
          databaseId: path.databaseId
      - text: Show replication lag for each replica of {databaseId}.
        slots:
          databaseId: path.databaseId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/vectorsdb/{databaseId}/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check real-time health of a dedicated vector database
      effect: read
      questions:
      - Is my dedicated vector database healthy and ready to accept connections?
      - What uptime, connection info and volume usage does my vector database report?
      instructions:
      - text: Get the health status of vector database {databaseId}.
        slots:
          databaseId: path.databaseId
      - text: Check whether vector database {databaseId} is up and ready.
        slots:
          databaseId: path.databaseId
      method: generated
      generated: '2026-09-26'