Snowflake

Snowflake cortex search service API

The cortex search service API from Snowflake — 5 operation(s) for cortex search service.

GitHub OpenAPI

Operations 9

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

DELETE /api/v2/databases/{database}/schemas/{schema}/cortex-search-services/{name} Delete a Cortex Search service · Delete a cortex search service #
Ask an LLM
“How do I drop a Cortex Search service I no longer use?”
“Will deleting a search service fail if it doesn't exist?”
Tell an agent destructive · confirm first
Delete Cortex Search service {database}.{schema}.{name}.
Drop the search service permanently.
GET /api/v2/databases/{database}/schemas/{schema}/cortex-search-services/{name} Get the details of a Cortex Search service · Fetch a cortex search service #
Ask an LLM
“What search column, target lag and indexing state does my Cortex Search service have?”
“Where can I read one search service's definition?”
Tell an agent
Show me the details of Cortex Search service {database}.{schema}.{name}.
Fetch the search service's definition and serving state.
GET /api/v2/databases/{database}/schemas/{schema}/cortex-search-services List Cortex Search services in a schema · List cortex search services #
Ask an LLM
“Which Cortex Search services exist in this schema?”
“Can I list all search services under a database and schema?”
Tell an agent
List the Cortex Search services in schema {schema} of database {database}.
Show me every search service defined here.
POST /api/v2/databases/{database}/schemas/{schema}/cortex-search-services Create a Cortex Search service · Create a cortex search service #
Ask an LLM
“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?”
Tell an agent
Create search service {name} in {database}.{schema} on column {search_column} from query {definition}.
Create search service {name} using warehouse {warehouse} with target lag {lag}.
POST /api/v2/databases/{database}/schemas/{schema}/cortex-search-services/{service_name}:query Run a search query against a Cortex Search service · Query a Cortex Search Service #
Ask an LLM
“How do I get ranked search results from my Cortex Search service?”
“Can I filter results and cap how many come back?”
Tell an agent
Search {database}.{schema}.{service_name} for {query}.
Query {service_name} for {query} and return the top {limit} results.
POST /api/v2/databases/{database}/schemas/{schema}/cortex-search-services/{service_name}:suggest Get autocomplete suggestions from a search service · Suggest from a Cortex Search Service #
Ask an LLM
“Can Cortex Search give me type-ahead suggestions for a partial query?”
“How do I power an autocomplete box from a search service?”
Tell an agent
Get autocomplete suggestions from {database}.{schema}.{service_name} for {query}.
Suggest up to {limit} completions for {query} using {service_name}.
POST /api/v2/databases/{database}/schemas/{schema}/cortex-search-services/{name}:suspend Suspend indexing or serving on a search service · Suspend a cortex search service #
Ask an LLM
“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?”
Tell an agent
Suspend Cortex Search service {database}.{schema}.{name}.
Suspend the {target} target of this search service.
POST /api/v2/databases/{database}/schemas/{schema}/cortex-search-services/{name}:resume Resume indexing or serving on a search service · Resume the cortex search service #
Ask an LLM
“How do I turn a suspended Cortex Search service back on?”
“Can I resume just the serving side of a search service?”
Tell an agent
Resume Cortex Search service {database}.{schema}.{name}.
Resume the {target} target of the search service.
POST /api/v2/databases/{database}/schemas/{schema}/cortex-search-services/{name}:feedback Send feedback on a search result · Send feedback #
Ask an LLM
“Can I tell Cortex Search whether a result was helpful?”
“How do I record thumbs-up or thumbs-down feedback for a search request?”
Tell an agent
Mark request {request_id} on search service {database}.{schema}.{name} as helpful: {positive}.
Send feedback {positive} on request {request_id} with the note {message}.

Documentation

📖
Documentation
https://docs.snowflake.com/en/developer-guide/snowflake-rest-api/reference/account
📖
Documentation
https://docs.snowflake.com/en/developer-guide/snowflake-rest-api/reference/alert
📖
Documentation
https://docs.snowflake.com/en/developer-guide/snowflake-rest-api/reference/api-integration
📖
Documentation
https://docs.snowflake.com/en/developer-guide/snowflake-rest-api/reference/catalog-integration
📖
Documentation
https://docs.snowflake.com/en/developer-guide/snowflake-rest-api/reference/compute-pool
📖
Documentation
https://docs.snowflake.com/en/user-guide/snowflake-cortex/cortex-analyst/rest-api
📖
Documentation
https://docs.snowflake.com/en/developer-guide/snowflake-rest-api/reference/cortex-inference
📖
Documentation
https://docs.snowflake.com/en/developer-guide/snowflake-rest-api/reference/cortex-search-service
📖
Documentation
https://docs.snowflake.com/en/developer-guide/snowflake-rest-api/reference/database-role
📖
Documentation
https://docs.snowflake.com/en/developer-guide/snowflake-rest-api/reference/database
📖
Documentation
https://docs.snowflake.com/en/developer-guide/snowflake-rest-api/reference/dynamic-table
📖
Documentation
https://docs.snowflake.com/en/developer-guide/snowflake-rest-api/reference/event-table
📖
Documentation
https://docs.snowflake.com/en/developer-guide/snowflake-rest-api/reference/external-volume
📖
Documentation
https://docs.snowflake.com/en/developer-guide/snowflake-rest-api/reference/function
📖
Documentation
https://docs.snowflake.com/en/developer-guide/snowflake-rest-api/reference/grant
📖
Documentation
https://docs.snowflake.com/en/developer-guide/snowflake-rest-api/reference/iceberg-table
📖
Documentation
https://docs.snowflake.com/en/developer-guide/snowflake-rest-api/reference/image-repository
📖
Documentation
https://docs.snowflake.com/en/developer-guide/snowflake-rest-api/reference/managed-account
📖
Documentation
https://docs.snowflake.com/en/developer-guide/snowflake-rest-api/reference/network-policy
📖
Documentation
https://docs.snowflake.com/en/developer-guide/snowflake-rest-api/reference/notebook
📖
Documentation
https://docs.snowflake.com/en/developer-guide/snowflake-rest-api/reference/notification-integration
📖
Documentation
https://docs.snowflake.com/en/developer-guide/snowflake-rest-api/reference/pipe
📖
Documentation
https://docs.snowflake.com/en/developer-guide/snowflake-rest-api/reference/procedure
📖
Documentation
https://docs.snowflake.com/en/developer-guide/snowflake-rest-api/reference/result
📖
Documentation
https://docs.snowflake.com/en/developer-guide/snowflake-rest-api/reference/role
📖
Documentation
https://docs.snowflake.com/en/developer-guide/snowflake-rest-api/reference/schema
📖
Documentation
https://docs.snowflake.com/en/developer-guide/snowflake-rest-api/reference/service
📖
Documentation
https://docs.snowflake.com/en/developer-guide/sql-api/index
📖
Documentation
https://docs.snowflake.com/en/developer-guide/snowflake-rest-api/reference/stage
📖
Documentation
https://docs.snowflake.com/en/developer-guide/snowflake-rest-api/reference/stream
📖
Documentation
https://docs.snowflake.com/en/developer-guide/snowflake-rest-api/reference/table
📖
Documentation
https://docs.snowflake.com/en/developer-guide/snowflake-rest-api/reference/task
📖
Documentation
https://docs.snowflake.com/en/developer-guide/snowflake-rest-api/reference/user-defined-function
📖
Documentation
https://docs.snowflake.com/en/developer-guide/snowflake-rest-api/reference/user
📖
Documentation
https://docs.snowflake.com/en/developer-guide/snowflake-rest-api/reference/view
📖
Documentation
https://docs.snowflake.com/en/developer-guide/snowflake-rest-api/reference/warehouse

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/snowflake/refs/heads/main/openapi/snowflake-cortex-search-service-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/snowflake/refs/heads/main/json-schema/snowflake-database-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/snowflake/refs/heads/main/json-schema/snowflake-warehouse-schema.json

Other Resources

🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/snowflake/refs/heads/main/json-ld/account-context.jsonld
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/snowflake/refs/heads/main/json-ld/alert-context.jsonld
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/snowflake/refs/heads/main/json-ld/api-integration-context.jsonld
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/snowflake/refs/heads/main/json-ld/catalog-integration-context.jsonld
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/snowflake/refs/heads/main/json-ld/compute-pool-context.jsonld
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/snowflake/refs/heads/main/json-ld/cortex-analyst-context.jsonld
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/snowflake/refs/heads/main/json-ld/cortex-inference-context.jsonld
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/snowflake/refs/heads/main/json-ld/cortex-search-service-context.jsonld
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/snowflake/refs/heads/main/json-ld/database-role-context.jsonld
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/snowflake/refs/heads/main/json-ld/database-context.jsonld
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/snowflake/refs/heads/main/json-ld/dynamic-table-context.jsonld
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/snowflake/refs/heads/main/json-ld/event-table-context.jsonld
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/snowflake/refs/heads/main/json-ld/external-volume-context.jsonld
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/snowflake/refs/heads/main/json-ld/function-context.jsonld
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/snowflake/refs/heads/main/json-ld/grant-context.jsonld
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/snowflake/refs/heads/main/json-ld/iceberg-table-context.jsonld
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/snowflake/refs/heads/main/json-ld/image-repository-context.jsonld
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/snowflake/refs/heads/main/json-ld/managed-account-context.jsonld
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/snowflake/refs/heads/main/json-ld/network-policy-context.jsonld
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/snowflake/refs/heads/main/json-ld/notebook-context.jsonld
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/snowflake/refs/heads/main/json-ld/notification-integration-context.jsonld
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/snowflake/refs/heads/main/json-ld/pipe-context.jsonld
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/snowflake/refs/heads/main/json-ld/procedure-context.jsonld
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/snowflake/refs/heads/main/json-ld/role-context.jsonld
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/snowflake/refs/heads/main/json-ld/schema-context.jsonld
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/snowflake/refs/heads/main/json-ld/service-context.jsonld
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/snowflake/refs/heads/main/json-ld/sqlapi-context.jsonld
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/snowflake/refs/heads/main/json-ld/snowflake-sql-rest-context.jsonld
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/snowflake/refs/heads/main/json-ld/stage-context.jsonld
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/snowflake/refs/heads/main/json-ld/stream-context.jsonld
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/snowflake/refs/heads/main/json-ld/table-context.jsonld
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/snowflake/refs/heads/main/json-ld/task-context.jsonld
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/snowflake/refs/heads/main/json-ld/user-defined-function-context.jsonld
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/snowflake/refs/heads/main/json-ld/user-context.jsonld
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/snowflake/refs/heads/main/json-ld/view-context.jsonld
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/snowflake/refs/heads/main/json-ld/warehouse-context.jsonld
🔗
Overlay
https://raw.githubusercontent.com/api-evangelist/snowflake/refs/heads/main/overlays/snowflake-cortex-search-service-overlay.yaml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/snowflake:snowflake-cortex-search-service-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

snowflake-cortex-search-service-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Cortex Search REST cortex search service API
  description: OpenAPI 3.0 specification for the Cortex Search REST API
  version: 0.1.0
  contact:
    name: Snowflake, Inc.
    url: https://snowflake.com
    email: support@snowflake.com
security:
- KeyPair: []
- ExternalOAuth: []
- SnowflakeOAuth: []
- ProgrammaticAccessToken: []
tags:
- name: cortex search service
paths:
  /api/v2/databases/{database}/schemas/{schema}/cortex-search-services/{name}:
    delete:
      operationId: deleteCortexSearchService
      summary: Delete a cortex search service
      description: Delete a cortex search service with the given name. If ifExists is used, the operation will succeed even if the object does not exist. Otherwise, there will be a failure if the drop is unsuccessful.
      tags:
      - cortex search service
      parameters:
      - $ref: common.yaml#/components/parameters/database
      - $ref: common.yaml#/components/parameters/schema
      - $ref: common.yaml#/components/parameters/name
      - $ref: common.yaml#/components/parameters/ifExists
      responses:
        '200':
          $ref: common.yaml#/components/responses/200SuccessResponse
        '202':
          $ref: common.yaml#/components/responses/202SuccessAcceptedResponse
        '400':
          $ref: common.yaml#/components/responses/400BadRequest
        '401':
          $ref: common.yaml#/components/responses/401Unauthorized
        '403':
          $ref: common.yaml#/components/responses/403Forbidden
        '404':
          $ref: common.yaml#/components/responses/404NotFound
        '405':
          $ref: common.yaml#/components/responses/405MethodNotAllowed
        '408':
          $ref: common.yaml#/components/responses/408RequestTimeout
        '409':
          $ref: common.yaml#/components/responses/409Conflict
        '410':
          $ref: common.yaml#/components/responses/410Gone
        '429':
          $ref: common.yaml#/components/responses/429LimitExceeded
        '500':
          $ref: common.yaml#/components/responses/500InternalServerError
        '503':
          $ref: common.yaml#/components/responses/503ServiceUnavailable
        '504':
          $ref: common.yaml#/components/responses/504GatewayTimeout
    get:
      operationId: fetchCortexSearchService
      summary: Fetch a cortex search service
      description: Fetch a Cortex Search Service.
      tags:
      - cortex search service
      parameters:
      - $ref: common.yaml#/components/parameters/database
      - $ref: common.yaml#/components/parameters/schema
      - $ref: common.yaml#/components/parameters/name
      responses:
        '200':
          description: successful
          headers:
            X-Snowflake-Request-ID:
              $ref: common.yaml#/components/headers/X-Snowflake-Request-ID
            Link:
              $ref: common.yaml#/components/headers/Link
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CortexSearchService'
        '202':
          $ref: common.yaml#/components/responses/202SuccessAcceptedResponse
        '400':
          $ref: common.yaml#/components/responses/400BadRequest
        '401':
          $ref: common.yaml#/components/responses/401Unauthorized
        '403':
          $ref: common.yaml#/components/responses/403Forbidden
        '404':
          $ref: common.yaml#/components/responses/404NotFound
        '405':
          $ref: common.yaml#/components/responses/405MethodNotAllowed
        '408':
          $ref: common.yaml#/components/responses/408RequestTimeout
        '409':
          $ref: common.yaml#/components/responses/409Conflict
        '410':
          $ref: common.yaml#/components/responses/410Gone
        '429':
          $ref: common.yaml#/components/responses/429LimitExceeded
        '500':
          $ref: common.yaml#/components/responses/500InternalServerError
        '503':
          $ref: common.yaml#/components/responses/503ServiceUnavailable
        '504':
          $ref: common.yaml#/components/responses/504GatewayTimeout
  /api/v2/databases/{database}/schemas/{schema}/cortex-search-services:
    get:
      operationId: listCortexSearchServices
      summary: List cortex search services
      description: Lists the cortex search services under the database and schema.
      tags:
      - cortex search service
      parameters:
      - $ref: common.yaml#/components/parameters/database
      - $ref: common.yaml#/components/parameters/schema
      - $ref: common.yaml#/components/parameters/like
      - $ref: common.yaml#/components/parameters/fromName
      - $ref: common.yaml#/components/parameters/showLimit
      responses:
        '200':
          description: successful
          headers:
            X-Snowflake-Request-ID:
              $ref: common.yaml#/components/headers/X-Snowflake-Request-ID
            Link:
              $ref: common.yaml#/components/headers/Link
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CortexSearchService'
        '202':
          $ref: common.yaml#/components/responses/202SuccessAcceptedResponse
        '400':
          $ref: common.yaml#/components/responses/400BadRequest
        '401':
          $ref: common.yaml#/components/responses/401Unauthorized
        '403':
          $ref: common.yaml#/components/responses/403Forbidden
        '404':
          $ref: common.yaml#/components/responses/404NotFound
        '405':
          $ref: common.yaml#/components/responses/405MethodNotAllowed
        '408':
          $ref: common.yaml#/components/responses/408RequestTimeout
        '409':
          $ref: common.yaml#/components/responses/409Conflict
        '410':
          $ref: common.yaml#/components/responses/410Gone
        '429':
          $ref: common.yaml#/components/responses/429LimitExceeded
        '500':
          $ref: common.yaml#/components/responses/500InternalServerError
        '503':
          $ref: common.yaml#/components/responses/503ServiceUnavailable
        '504':
          $ref: common.yaml#/components/responses/504GatewayTimeout
    post:
      operationId: createCortexSearchService
      summary: Create a cortex search service
      description: Create a cortex search service, with standard create modifiers as query parameters. See the Cortex Search Service component definition for what is required to be provided in the request body.
      tags:
      - cortex search service
      parameters:
      - $ref: common.yaml#/components/parameters/database
      - $ref: common.yaml#/components/parameters/schema
      - $ref: common.yaml#/components/parameters/createMode
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              allOf:
              - $ref: '#/components/schemas/CortexSearchService'
              - type: object
              - required:
                - name
                - search_column
                - target_lag
                - warehouse
                - definition
      responses:
        '200':
          $ref: common.yaml#/components/responses/200SuccessResponse
        '202':
          $ref: common.yaml#/components/responses/202SuccessAcceptedResponse
        '400':
          $ref: common.yaml#/components/responses/400BadRequest
        '401':
          $ref: common.yaml#/components/responses/401Unauthorized
        '403':
          $ref: common.yaml#/components/responses/403Forbidden
        '404':
          $ref: common.yaml#/components/responses/404NotFound
        '405':
          $ref: common.yaml#/components/responses/405MethodNotAllowed
        '408':
          $ref: common.yaml#/components/responses/408RequestTimeout
        '409':
          $ref: common.yaml#/components/responses/409Conflict
        '410':
          $ref: common.yaml#/components/responses/410Gone
        '429':
          $ref: common.yaml#/components/responses/429LimitExceeded
        '500':
          $ref: common.yaml#/components/responses/500InternalServerError
        '503':
          $ref: common.yaml#/components/responses/503ServiceUnavailable
        '504':
          $ref: common.yaml#/components/responses/504GatewayTimeout
  /api/v2/databases/{database}/schemas/{schema}/cortex-search-services/{service_name}:query:
    post:
      operationId: queryCortexSearchService
      summary: Query a Cortex Search Service
      description: Query a Cortex Search Service to get search results.
      tags:
      - cortex search service
      parameters:
      - $ref: common.yaml#/components/parameters/database
      - $ref: common.yaml#/components/parameters/schema
      - in: path
        name: service_name
        required: true
        schema:
          type: string
        description: The name of the Cortex Search Service.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/QueryRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryResponse'
        '400':
          $ref: common.yaml#/components/responses/400BadRequest
        '401':
          $ref: common.yaml#/components/responses/401Unauthorized
        '403':
          $ref: common.yaml#/components/responses/403Forbidden
        '404':
          $ref: common.yaml#/components/responses/404NotFound
        '405':
          $ref: common.yaml#/components/responses/405MethodNotAllowed
        '408':
          $ref: common.yaml#/components/responses/408RequestTimeout
        '409':
          $ref: common.yaml#/components/responses/409Conflict
        '500':
          $ref: common.yaml#/components/responses/500InternalServerError
        '503':
          $ref: common.yaml#/components/responses/503ServiceUnavailable
        '504':
          $ref: common.yaml#/components/responses/504GatewayTimeout
  /api/v2/databases/{database}/schemas/{schema}/cortex-search-services/{service_name}:suggest:
    post:
      operationId: suggestCortexSearchService
      summary: Suggest from a Cortex Search Service
      description: Suggest from a Cortex Search Service to get auto-complete or contextual suggestions
      tags:
      - cortex search service
      parameters:
      - $ref: common.yaml#/components/parameters/database
      - $ref: common.yaml#/components/parameters/schema
      - in: path
        name: service_name
        required: true
        schema:
          type: string
        description: The name of the Cortex Search Service
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SuggestQueryRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuggestQueryResponse'
        '400':
          $ref: common.yaml#/components/responses/400BadRequest
        '401':
          $ref: common.yaml#/components/responses/401Unauthorized
        '403':
          $ref: common.yaml#/components/responses/403Forbidden
        '404':
          $ref: common.yaml#/components/responses/404NotFound
        '405':
          $ref: common.yaml#/components/responses/405MethodNotAllowed
        '408':
          $ref: common.yaml#/components/responses/408RequestTimeout
        '409':
          $ref: common.yaml#/components/responses/409Conflict
        '500':
          $ref: common.yaml#/components/responses/500InternalServerError
        '503':
          $ref: common.yaml#/components/responses/503ServiceUnavailable
        '504':
          $ref: common.yaml#/components/responses/504GatewayTimeout
  /api/v2/databases/{database}/schemas/{schema}/cortex-search-services/{name}:suspend:
    post:
      operationId: suspendCortexSearchService
      summary: Suspend a cortex search service
      description: Suspends one or both of the indexing or serving targets of a cortex search service.
      tags:
      - cortex search service
      parameters:
      - $ref: common.yaml#/components/parameters/database
      - $ref: common.yaml#/components/parameters/schema
      - $ref: common.yaml#/components/parameters/name
      - $ref: common.yaml#/components/parameters/ifExists
      - $ref: '#/components/parameters/suspendResumeTarget'
      responses:
        '200':
          $ref: common.yaml#/components/responses/200SuccessResponse
        '202':
          $ref: common.yaml#/components/responses/202SuccessAcceptedResponse
        '400':
          $ref: common.yaml#/components/responses/400BadRequest
        '401':
          $ref: common.yaml#/components/responses/401Unauthorized
        '403':
          $ref: common.yaml#/components/responses/403Forbidden
        '404':
          $ref: common.yaml#/components/responses/404NotFound
        '405':
          $ref: common.yaml#/components/responses/405MethodNotAllowed
        '408':
          $ref: common.yaml#/components/responses/408RequestTimeout
        '409':
          $ref: common.yaml#/components/responses/409Conflict
        '410':
          $ref: common.yaml#/components/responses/410Gone
        '429':
          $ref: common.yaml#/components/responses/429LimitExceeded
        '500':
          $ref: common.yaml#/components/responses/500InternalServerError
        '503':
          $ref: common.yaml#/components/responses/503ServiceUnavailable
        '504':
          $ref: common.yaml#/components/responses/504GatewayTimeout
  /api/v2/databases/{database}/schemas/{schema}/cortex-search-services/{name}:resume:
    post:
      operationId: resumeCortexSearchService
      summary: Resume the cortex search service
      tags:
      - cortex search service
      parameters:
      - $ref: common.yaml#/components/parameters/database
      - $ref: common.yaml#/components/parameters/schema
      - $ref: common.yaml#/components/parameters/name
      - $ref: common.yaml#/components/parameters/ifExists
      - $ref: '#/components/parameters/suspendResumeTarget'
      responses:
        '200':
          $ref: common.yaml#/components/responses/200SuccessResponse
        '202':
          $ref: common.yaml#/components/responses/202SuccessAcceptedResponse
        '400':
          $ref: common.yaml#/components/responses/400BadRequest
        '401':
          $ref: common.yaml#/components/responses/401Unauthorized
        '403':
          $ref: common.yaml#/components/responses/403Forbidden
        '404':
          $ref: common.yaml#/components/responses/404NotFound
        '405':
          $ref: common.yaml#/components/responses/405MethodNotAllowed
        '408':
          $ref: common.yaml#/components/responses/408RequestTimeout
        '409':
          $ref: common.yaml#/components/responses/409Conflict
        '410':
          $ref: common.yaml#/components/responses/410Gone
        '429':
          $ref: common.yaml#/components/responses/429LimitExceeded
        '500':
          $ref: common.yaml#/components/responses/500InternalServerError
        '503':
          $ref: common.yaml#/components/responses/503ServiceUnavailable
        '504':
          $ref: common.yaml#/components/responses/504GatewayTimeout
  /api/v2/databases/{database}/schemas/{schema}/cortex-search-services/{name}:feedback:
    summary: Create a feedback event for a Cortex Search query result.
    description: Create a feedback event for a Cortex Search result.
    post:
      operationId: sendFeedback
      tags:
      - cortex search service
      description: Send user feedback for a Cortex Search result
      parameters:
      - $ref: common.yaml#/components/parameters/database
      - $ref: common.yaml#/components/parameters/schema
      - $ref: common.yaml#/components/parameters/name
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SendFeedbackRequest'
      responses:
        '200':
          $ref: common.yaml#/components/responses/200SuccessResponse
        '400':
          $ref: common.yaml#/components/responses/400BadRequest
        '401':
          $ref: common.yaml#/components/responses/401Unauthorized
        '403':
          $ref: common.yaml#/components/responses/403Forbidden
        '404':
          $ref: common.yaml#/components/responses/404NotFound
        '405':
          $ref: common.yaml#/components/responses/405MethodNotAllowed
        '429':
          $ref: common.yaml#/components/responses/429LimitExceeded
        '500':
          $ref: common.yaml#/components/responses/500InternalServerError
        '503':
          $ref: common.yaml#/components/responses/503ServiceUnavailable
        '504':
          $ref: common.yaml#/components/responses/504GatewayTimeout
      summary: Send feedback
      x-summary-source: derived
components:
  schemas:
    VectorBoost:
      type: object
      properties:
        column:
          $ref: '#/components/schemas/Column'
        weight:
          description: Weight to apply for boosting this vector column.
          type: number
          example: 0.5
        disable_vector_embedding_query_prefix:
          description: Whether to disable the embedding query prefix
          type: boolean
          default: false
    TimeDecay:
      type: object
      properties:
        column:
          $ref: '#/components/schemas/Column'
        weight:
          type: number
          description: Weight to apply for decaying this timestamp column. Normalized across all scored columns in the scoring config so that all weights sum to 1. If a weight is not provided, the weight defaults to 1 pre-normalization.
          example: 0.5
        limit_hours:
          type: number
          description: Optional limit in hours after which the decay does not apply.
          example: 24
        now:
          type: string
          format: date-time
          description: Optional reference timestamp to calculate decay from.
          example: '2022-01-01T00:00:00Z'
      required:
      - column
    CortexSearchService:
      type: object
      description: A Snowflake cortex search service object.
      properties:
        name:
          type: string
          description: Specifies the name for the cortex search service, must be unique for the schema in which the cortex search service is created
        search_column:
          type: string
          description: Specifies the name of the search column for the cortex search service.
        columns:
          type: array
          items:
            type: string
          description: Specifies all columns included in the cortex search service and that can be returned in search queries.
        attribute_columns:
          type: array
          items:
            type: string
          description: Specifies the attribute columns, which can be referenced in filters in search queries to the cortex search service.
        target_lag:
          $ref: common.yaml#/components/schemas/TargetLag
          description: Specifies the schedule for periodically refreshing the cortex search service.
        warehouse:
          type: string
          description: Specifies the name of the warehouse that provides the compute resources for refreshing the cortex search service
          example: test_wh
        definition:
          type: string
          description: Specifies the definition (source query) used to create the cortex search service
          example: SELECT col1, col2 FROM foo
        comment:
          type: string
          description: Specifies a comment for the cortex search service
        created_on:
          type: string
          format: date-time
          readOnly: true
          description: Date and time when the cortex search service was created.
        database_name:
          type: string
          readOnly: true
          description: Database in which the cortex search service is stored
        schema_name:
          type: string
          readOnly: true
          description: Schema in which the cortex search service is stored
        source_data_num_rows:
          type: integer
          format: int64
          readOnly: true
          description: Number of rows in the materialized source data feeding into the cortex search service.
        data_timestamp:
          type: string
          format: date-time
          readOnly: true
          description: Date and time as of which data existent in base tables is now serving.
        indexing_state:
          $ref: '#/components/schemas/SchedulingState'
          description: Current state of the indexing pipeline for the cortex search service; one of 'SUSPENDED' or 'ACTIVE'.
        serving_state:
          $ref: '#/components/schemas/SchedulingState'
          description: Whether the cortex search service is currently actively serving; one of 'SUSPENDED' or 'ACTIVE'.
        indexing_error:
          type: string
          readOnly: true
          description: Error encountered during the latest indexing pipeline of the cortex search service, if any.
        serving_data_bytes:
          type: integer
          format: int64
          readOnly: true
          description: Size of the serving index, in bytes.
    Column:
      type: string
      description: Column to apply this function to.
    Weights:
      type: object
      description: Weights to apply to each scoring component.
      properties:
        texts:
          description: Weight to apply to all text-specific columns.
          type: number
          example: 0.5
        vectors:
          description: Weight to apply to all vector-specific columns.
          type: number
          example: 0.5
        reranker:
          description: Weight to apply to reranker-specific scoring component.
          type: number
          example: 0.5
    SuggestQueryResponse:
      type: object
      description: Suggest results.
      properties:
        results:
          type: array
          description: List of result rows.
          items:
            $ref: '#/components/schemas/SuggestResult'
        request_id:
          type: string
          description: ID of the request.
      required:
      - results
      - request_id
    RetrievalWeights:
      type: object
      description: Weights to apply to retrieval stage components.
      properties:
        texts:
          description: Multiplier for text-based scoring in retrieval.
          type: number
          example: 1.0
        vectors:
          description: Multiplier for vector-based scoring in retrieval.
          type: number
          example: 1.0
    SchedulingState:
      type: string
      enum:
      - ACTIVE
      - SUSPENDED
      - INITIALIZING
    ResultRow:
      type: object
      description: Map of column names to values.
      properties:
        columns:
          type: object
    Functions:
      type: object
      description: Functions to apply for scoring this request.
      properties:
        numeric_boosts:
          type: array
          items:
            $ref: '#/components/schemas/NumericBoost'
        time_decays:
          type: array
          items:
            $ref: '#/components/schemas/TimeDecay'
        text_boosts:
          type: array
          items:
            $ref: '#/components/schemas/TextBoost'
        vector_boosts:
          type: array
          items:
            $ref: '#/components/schemas/VectorBoost'
        query_similarity_boosts:
          type: array
          items:
            $ref: '#/components/schemas/QuerySimilarityBoost'
    QuerySimilarityBoost:
      type: object
      properties:
        cortex_search_service:
          description: Fully-qualified name of a Cortex Search Service through which to find similar previous queries.
          type: string
          example: MY_DB.MY_SCHEMA.MY_SEARCH_SERVICE
        previous_query_column:
          description: Name of a TEXT column indexed in the specified previous queries search service that contains the previous query strings.
          type: string
        documents_column:
          description: Name of an ARRAY column indexed in the specified previous queries search service that contains a list of documents that matched the corresponding previous query. Each document is represented as an OBJECT mapping all primary key columns to their corresponding values.
          type: string
    NumericBoost:
      type: object
      properties:
        column:
          $ref: '#/components/schemas/Column'
        weight:
          type: number
          description: Weight to apply for boosting this numerical column. It will be normalized across all scored columns specified in the scoring config so that all weights sum to 1. If a weight is not provided, the weight defaults to 1 pre-normalization.
          example: 0.5
      required:
      - column
    QueryResponse:
      type: object
      description: Search results.
      properties:
        results:
          type: array
          description: List of result rows.
          items:
            type: object
            additionalProperties: true
            description: Map of column names to values (as bytes).
        request_id:
          type: string
          description: ID of the request.
      required:
      - results
      - request_id
    ScoringConfig:
      type: object
      description: reserved
      properties:
        functions:
          $ref: '#/components/schemas/Functions'
        reranker:
          $ref: '#/components/schemas/Reranker'
        weights:
          $ref: '#/components/schemas/Weights'
        retrieval_weights:
          $ref: '#/components/schemas/RetrievalWeights'
        ranking_weights:
          $ref: '#/components/schemas/RankingWeights'
        disable_vector_embedding_query_prefix:
          type: boolean
          description: whether to disable query prefix for embedding while searching
          default: false
        diversity:
          $ref: '#/components/schemas/Diversity'
    Reranker:
      type: string
      description: Model to use for the reranker, or "none" if the reranker should be turned off. If excluded or null, the default reranker is used.
      example: none
    SuggestResult:
      type: object
      description: Suggest results.
      properties:
        rows:
          type: array
          description: List of result rows.
          items:
            $ref: '#/components/schemas/ResultRow'
    Diversity:
      type: object
      description: Configuration to control result diversity with respect to one or more metadata columns.
      properties:
        group_by:
          description: Columns to group by.
          type: array
          items:
            type: string
        max_results:
          description: Maximum number of results per group to return.
          type: integer
    SendFeedbackRequest:
      type: object
      description: The request object for sending user feedback on Cortex Search results
      properties:
        request_id:
          type: string
          description: Request id associated with the feedback
        positive:
          type: boolean
          description: Whether the results were good (true) or bad (false)
        feedback_message:
          type: string
          description: The text for the detailed feedback message
      required:
      - request_id
      - positive
    SuggestQueryRequest:
      type: object
      description: A Suggest request.
      properties:
        query:
          description: The text query on which to suggest.
          type: string
        columns:
          description: List of columns to return.
          type: array
          items:
            type: string
        limit:
          description: Max number of results to return.
          type: integer
          default: 5
      required:
      - query
    TextBoost:
      type: object
      properties:
        column:
          $ref: '#/components/schemas/Column'
        weight:
          description: Weight to apply for boosting this text column.
          type: number
          example: 0.5
    RankingWeights:
      type: object
      description: Weights to apply to ranking stage components.
      properties:
        texts:
          description: Multiplier for text-based scoring in ranking.
          type: number
          example: 1.0
        vectors:
          description: Multiplier for vector-based scoring in ranking.
          type: number
          example: 1.0
        reranker:
          description: Multiplier for reranker score in ranking.
          type: number
          example: 1.0
    QueryRequest:
      type: object
      description: A search query and additional parameters for search.
      properties:
        query:
          description: Unstructured text query.  Exactly one of 'query' or 'multi_index_query' must be specified.
          type: string
        multi_index_query:
          description: A search query expressed as a collection of multiple column-level queries.  Exactly one of 'query' or 'multi_index_query' must be specified. A column/index can be queried with multiple queries.
          type: object
          additionalProperties: true
        columns:
          description: List of columns to return.
          type: array
          items:
            type: string
        filter:
          description: Filter query.
          type: object
        limit:
          description: Max number of results to return.
          type: integer
          default: 10
        scoring_config:
          $ref: '#/components/schemas/ScoringConfig'
        scoring_profile:
          description: Mutually exclusive with scoring_config. Specifies the pre-defined name of a profile on the cortex search service that resolves to scoring_config.
          type: string
        experimental:
          description: reserved
          type: object
          additionalProperties: true
  parameters:
    suspendResumeTarget:
      name: target
      description: Query parameter that identifies the target to which suspension or resumption of the cortex search service should be applied.
      in: query
      schema:
        type: string
        enum:
        - indexing
        - INDEXING
        - serving
        - SERVING
        example: indexing
  securitySchemes:
    KeyPair:
      $ref: common.yaml#/components/securitySchemes/KeyPair
    ExternalOAuth:
      $ref: common.yaml#/components/securitySchemes/ExternalOAuth
    SnowflakeOAuth:
      $ref: common.yaml#/components/securitySchemes/SnowflakeOAuth
    ProgrammaticAccessToken:
      $ref: common.yaml#/components/securitySchemes/ProgrammaticAccessToken