# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Cortex Search REST cortex search service API
  version: 1.0.0
extends: openapi/snowflake-cortex-search-service-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 9
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/cortex-search-services/{name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the details of a Cortex Search service
      effect: read
      questions:
      - What search column, target lag and indexing state does my Cortex Search service have?
      - Where can I read one search service's definition?
      instructions:
      - text: Show me the details of Cortex Search service {database}.{schema}.{name}.
        slots:
          database: path.database
          schema: path.schema
          name: path.name
      - text: Fetch the search service's definition and serving state.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/cortex-search-services/{name}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Cortex Search service
      effect: destructive
      questions:
      - How do I drop a Cortex Search service I no longer use?
      - Will deleting a search service fail if it doesn't exist?
      instructions:
      - text: Delete Cortex Search service {database}.{schema}.{name}.
        slots:
          database: path.database
          schema: path.schema
          name: path.name
      - text: Drop the search service permanently.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/cortex-search-services'].get
  update:
    x-apievangelist-phrasing:
      intent: List Cortex Search services in a schema
      effect: read
      questions:
      - Which Cortex Search services exist in this schema?
      - Can I list all search services under a database and schema?
      instructions:
      - text: List the Cortex Search services in schema {schema} of database {database}.
        slots:
          schema: path.schema
          database: path.database
      - text: Show me every search service defined here.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/cortex-search-services'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a Cortex Search service
      effect: write
      questions:
      - How do I build a Cortex Search service over a table's text column?
      - Can I add attribute columns so search results can be filtered?
      - What warehouse and target lag does a new search service need?
      instructions:
      - text: Create search service {name} in {database}.{schema} on column {search_column} from query {definition}.
        slots:
          name: requestBody.name
          database: path.database
          schema: path.schema
          search_column: requestBody.search_column
          definition: requestBody.definition
      - text: Create search service {name} using warehouse {warehouse} with target lag {lag}.
        slots:
          name: requestBody.name
          warehouse: requestBody.warehouse
          lag: requestBody.target_lag
      - text: Create search service {name} with filterable attribute columns {attributes}.
        slots:
          name: requestBody.name
          attributes: requestBody.attribute_columns
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/cortex-search-services/{service_name}:query'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a search query against a Cortex Search service
      effect: read
      questions:
      - How do I get ranked search results from my Cortex Search service?
      - Can I filter results and cap how many come back?
      - Which columns can I ask the search results to return?
      instructions:
      - text: Search {database}.{schema}.{service_name} for {query}.
        slots:
          database: path.database
          schema: path.schema
          service_name: path.service_name
          query: requestBody.query
      - text: Query {service_name} for {query} and return the top {limit} results.
        slots:
          service_name: path.service_name
          query: requestBody.query
          limit: requestBody.limit
      - text: Search {service_name} for {query} with filter {filter}, returning columns {columns}.
        slots:
          service_name: path.service_name
          query: requestBody.query
          filter: requestBody.filter
          columns: requestBody.columns
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/cortex-search-services/{service_name}:suggest'].post
  update:
    x-apievangelist-phrasing:
      intent: Get autocomplete suggestions from a search service
      effect: read
      questions:
      - Can Cortex Search give me type-ahead suggestions for a partial query?
      - How do I power an autocomplete box from a search service?
      instructions:
      - text: Get autocomplete suggestions from {database}.{schema}.{service_name} for {query}.
        slots:
          database: path.database
          schema: path.schema
          service_name: path.service_name
          query: requestBody.query
      - text: Suggest up to {limit} completions for {query} using {service_name}.
        slots:
          limit: requestBody.limit
          query: requestBody.query
          service_name: path.service_name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/cortex-search-services/{name}:suspend'].post
  update:
    x-apievangelist-phrasing:
      intent: Suspend indexing or serving on a search service
      effect: write
      questions:
      - Can I pause indexing on a Cortex Search service but keep serving queries?
      - How do I suspend a search service to stop it using credits?
      instructions:
      - text: Suspend Cortex Search service {database}.{schema}.{name}.
        slots:
          database: path.database
          schema: path.schema
          name: path.name
      - text: Suspend the {target} target of this search service.
        slots:
          target: query.target
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/cortex-search-services/{name}:resume'].post
  update:
    x-apievangelist-phrasing:
      intent: Resume indexing or serving on a search service
      effect: write
      questions:
      - How do I turn a suspended Cortex Search service back on?
      - Can I resume just the serving side of a search service?
      instructions:
      - text: Resume Cortex Search service {database}.{schema}.{name}.
        slots:
          database: path.database
          schema: path.schema
          name: path.name
      - text: Resume the {target} target of the search service.
        slots:
          target: query.target
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/cortex-search-services/{name}:feedback'].post
  update:
    x-apievangelist-phrasing:
      intent: Send feedback on a search result
      effect: write
      questions:
      - Can I tell Cortex Search whether a result was helpful?
      - How do I record thumbs-up or thumbs-down feedback for a search request?
      instructions:
      - text: 'Mark request {request_id} on search service {database}.{schema}.{name} as helpful: {positive}.'
        slots:
          request_id: requestBody.request_id
          database: path.database
          schema: path.schema
          name: path.name
          positive: requestBody.positive
      - text: Send feedback {positive} on request {request_id} with the note {message}.
        slots:
          positive: requestBody.positive
          request_id: requestBody.request_id
          message: requestBody.feedback_message
      method: generated
      generated: '2026-10-01'