Snowflake · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Cortex Analyst API
10 actions
10 updates
phrasing
extends
openapi/snowflake-cortex-analyst-api-openapi.yml
Generated by API Evangelist
Written by API Evangelist tooling for Snowflake's API. It is a proposal applied on top of the contract, not a document Snowflake publishes.
What the actions change
x-apievangelist-phrasing
Targets 10
$.info
$.paths['/api/v2/cortex/analyst/feedback'].post
$.paths['/api/v2/cortex/analyst/message'].post
$.paths['/api/v2/cortex/analyst/verified-query-suggestions'].post
$.paths['/api/v2/cortex/analyst/fast-generation'].post
$.paths['/api/v2/cortex/analyst/pre-selection'].post
$.paths['/api/v2/cortex/analyst/filters-and-metrics-suggestions'].post
$.paths['/api/v2/cortex/analyst/agentic-optimizations'].post
$.paths['/api/v2/cortex/analyst/agentic-optimization'].get
$.paths['/api/v2/cortex/analyst/token'].get
OpenAPI Overlay
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Cortex Analyst API
version: 1.0.0
extends: openapi/snowflake-cortex-analyst-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-10-02'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 9
- target: $.paths['/api/v2/cortex/analyst/feedback'].post
update:
x-apievangelist-phrasing:
intent: Rate a Cortex Analyst response
effect: write
questions:
- How do I tell Cortex Analyst an answer was wrong?
- Can I attach a written comment when giving thumbs up or down on an Analyst reply?
instructions:
- text: 'Mark Cortex Analyst request {request_id} as helpful: {positive}.'
slots:
request_id: requestBody.request_id
positive: requestBody.positive
- text: Send feedback {positive} on request {request_id} with the note {feedback_message}.
slots:
positive: requestBody.positive
request_id: requestBody.request_id
feedback_message: requestBody.feedback_message
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v2/cortex/analyst/message'].post
update:
x-apievangelist-phrasing:
intent: Ask Cortex Analyst a data question
effect: read
questions:
- Can I ask a plain-English question about my data and get SQL back?
- How does Cortex Analyst turn a business question into an answer over a semantic model?
instructions:
- text: Ask Cortex Analyst what our revenue was last quarter.
- text: Send this data question to Cortex Analyst using our semantic model.
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v2/cortex/analyst/verified-query-suggestions'].post
update:
x-apievangelist-phrasing:
intent: Suggest verified queries for a semantic model
effect: read
questions:
- Can Cortex Analyst propose verified queries to add to my semantic model?
- How many verified query suggestions can I page through at a time?
instructions:
- text: Generate verified query suggestions for {semantic_model} using warehouse {warehouse}.
slots:
semantic_model: requestBody.semantic_model
warehouse: requestBody.warehouse
- text: Suggest up to {limit} verified queries for the model, running on warehouse {warehouse}.
slots:
limit: requestBody.limit
warehouse: requestBody.warehouse
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v2/cortex/analyst/fast-generation'].post
update:
x-apievangelist-phrasing:
intent: Generate or improve a semantic model quickly
effect: read
questions:
- Can I get real-time suggestions to improve a semantic model?
- Is there a fast way to draft a semantic model from source material?
instructions:
- text: Rapidly generate a semantic model from {json_proto}.
slots:
json_proto: requestBody.json_proto
- text: Run fast generation to stream real-time improvement suggestions for my semantic model.
method: generated
generated: '2026-10-02'
- target: $.paths['/api/v2/cortex/analyst/pre-selection'].post
update:
x-apievangelist-phrasing:
intent: Pick relevant tables for semantic model generation
effect: read
questions:
- Which tables should go into a new semantic model given my source data?
- Can Cortex Analyst pre-select tables from a Tableau data source?
instructions:
- text: Pre-select relevant tables from {tds_source} using warehouse {warehouse}.
slots:
tds_source: requestBody.tds_source
warehouse: requestBody.warehouse
- text: Find the tables worth modelling from {tds_source} and SQL {sql_source} on warehouse {warehouse}.
slots:
tds_source: requestBody.tds_source
sql_source: requestBody.sql_source
warehouse: requestBody.warehouse
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v2/cortex/analyst/filters-and-metrics-suggestions'].post
update:
x-apievangelist-phrasing:
intent: Suggest filters, facts and metrics for a model
effect: read
questions:
- What metrics and filters could I add to my semantic view?
- Can I page separately through suggested facts, filters and metrics?
instructions:
- text: Suggest filters, facts and metrics for semantic model {semantic_model}.
slots:
semantic_model: requestBody.semantic_model
- text: Give me up to {metrics_limit} metric suggestions for tables {tables}.
slots:
metrics_limit: requestBody.metrics_limit
tables: requestBody.tables
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v2/cortex/analyst/agentic-optimizations'].post
update:
x-apievangelist-phrasing:
intent: List agentic optimization runs for a model
effect: read
questions:
- Which agentic optimization runs have been done on my semantic model?
- Can I see the optimization history for a base model?
instructions:
- text: List all agentic optimization runs for semantic model {semantic_model}.
slots:
semantic_model: requestBody.semantic_model
- text: Show every optimization run started on base model {semantic_model}.
slots:
semantic_model: requestBody.semantic_model
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v2/cortex/analyst/agentic-optimization'].get
update:
x-apievangelist-phrasing:
intent: Check an agentic optimization run's status
effect: read
questions:
- Is my agentic optimization run finished yet?
- What state is a specific semantic model optimization run in?
instructions:
- text: Get the status of agentic optimization {optimization_name}.
slots:
optimization_name: query.optimization_name
- text: Check whether optimization run {optimization_name} has completed.
slots:
optimization_name: query.optimization_name
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v2/cortex/analyst/token'].get
update:
x-apievangelist-phrasing:
intent: Exchange a Cortex Analyst OAuth token
effect: read
questions:
- How is a Cortex Analyst OAuth token exchanged for a scoped token?
- What does the internal Cortex Analyst token endpoint return?
instructions:
- text: Exchange my Cortex Analyst OAuth token for a scoped token.
- text: Get a scoped Cortex Analyst token for this session.
method: generated
generated: '2026-10-01'