Categories:

String & binary functions (AI Functions)

AI_COMPLETE (Single string)¶

Generates a response (completion) for a text prompt using a supported language model.

Syntax¶

The function contains two required arguments and four optional arguments. The function can be used with either positional or named argument syntax.

Using AI_COMPLETE with a single string input

AI_COMPLETE(
    <model>, <prompt> [ , <model_parameters>, <response_format>, <show_details> ] )

Arguments¶

model

A string specifying the model to be used.

Supported models might have different costs.

prompt

A string prompt

model_parameters

An object containing zero or more of the following options that affect the model’s hyperparameters. See LLM Settings.

• temperature: A value from 0 to 1 (inclusive) that controls the randomness of the output of the language model. A higher temperature (for example, 0.7) results in more diverse and random output, while a lower temperature (such as 0.2) makes the output more deterministic and focused.

  Default: 0

• top_p: A value from 0 to 1 (inclusive) that controls the randomness and diversity of the language model, generally used as an alternative to temperature. The difference is that top_p restricts the set of possible tokens that the model outputs, while temperature influences which tokens are chosen at each step.

  Default: 0

• max_tokens: Sets the maximum number of output tokens in the response. Small values can result in truncated responses.

  Default: 4096 Maximum allowed value: 8192

• guardrails: Filters potentially unsafe and harmful responses from a language model using Cortex Guard. Either TRUE or FALSE.

  Default: FALSE

response_format

The format that the response should follow. You can specify the response format as:

• A JSON schema that the response should follow. This is a SQL sub-object, not a string.
• A SQL type literal beginning with the TYPE keyword. The defined type must use an OBJECT as its top-level container, and fields of this OBJECT are mapped to corresponding JSON fields and values.

If response_format is not specified, the response is a string containing either the response or a serialized JSON object containing the response and information about it.

For more information, see AI_COMPLETE structured outputs.

show_details

A boolean flag that indicates whether to return a serialized JSON object containing the response and information about it.

Returns¶

When the show_details argument is not specified or set to FALSE and the response_format is not specified or set to NULL, returns a string containing the response.

When the show_details argument is not specified or set to FALSE and the response_format is specified, returns an object following the provided response format.

When the show_details argument is set to TRUE and the response_format is not specified, returns a JSON object containing the following keys.

• "choices": An array of the model’s responses. (Currently, only one response is provided.) Each response is an object containing a "messages" key whose value is the model’s response to the latest prompt.
• "created": UNIX timestamp (seconds since midnight, January 1, 1970) when the response was generated.
• "model": The name of the model that created the response.
• "usage": An object recording the number of tokens consumed and generated by this completion. Includes the following sub-keys:
  • "completion_tokens": The number of tokens in the generated response.
  • "prompt_tokens": The number of tokens in the prompt.
  • "total_tokens": The total number of tokens consumed, which is the sum of the other two values.

When the show_details argument is set to TRUE and the response_format is specified, returns a JSON object containing the following keys.

• "structured_output": A json object following the specified response format.
• "created": UNIX timestamp (seconds since midnight, January 1, 1970) when the response was generated.
• "model": The name of the model that created the response.
• "usage": An object recording the number of tokens consumed and generated by this completion. Includes the following sub-keys:
  • "completion_tokens": The number of tokens in the generated response.
  • "prompt_tokens": The number of tokens in the prompt.
  • "total_tokens": The total number of tokens consumed, which is the sum of the other two values.

Cortex Guard¶

Cortex Guard is an option of the AI_COMPLETE (or SNOWFLAKE.CORTEX.COMPLETE) function designed to filter possible unsafe and harmful responses from a language model. Cortex Guard is currently built with Meta’s Llama Guard 3. Cortex Guard works by evaluating the responses of a language model before that output is returned to the application. Once you activate Cortex Guard, language model responses which may be associated with violent crimes, hate, sexual content, self-harm, and more are automatically filtered.

To enable Cortex Guard, set the guardrails option in the model_parameters argument to TRUE. For an example, see Filtering harmful responses with Cortex Guard.

Examples¶

Single response¶

To generate a single response:

SELECT AI_COMPLETE('snowflake-arctic', 'What are large language models?');

Responses from table column¶

The following example generates a response for each row in the reviews table, using the content column as input. Each query result contains a critique of the corresponding review.

SELECT AI_COMPLETE(
    'mistral-large',
        CONCAT('Critique this review in bullet points: <review>', content, '</review>')
) FROM reviews LIMIT 10;

Controlling model parameters¶

The following example specifies the model_parameters used to provide a response.

SELECT AI_COMPLETE(
    model => 'deepseek-r1',
    prompt => 'how does a snowflake get its unique pattern?',
    model_parameters => {
        'temperature': 0.7,
        'max_tokens': 10
    }
);

The response is a string containing the message from the language model and other information. Note that the response is truncated as instructed in the model_parameters argument.

"The unique pattern on a snowflake is"

Detailed output¶

The following example shows how you can use the show_details argument to return additional inference details.

SELECT AI_COMPLETE(
    model => 'deepseek-r1',
    prompt => 'how does a snowflake get its unique pattern?',
    model_parameters => {
        'temperature': 0.7,
        'max_tokens': 10
    },
    show_details => true
);

The response is a JSON object with the model’s message and related details. The model_parameters argument was used to truncate the output.

{
    "choices": [
        {
            "messages": " The unique pattern on a snowflake is"
        }
    ],
    "created": 1708536426,
    "model": "deepseek-r1",
    "usage": {
        "completion_tokens": 10,
        "prompt_tokens": 22,
        "guardrail_tokens": 0,
        "total_tokens": 32
    }
}

Filtering harmful responses with Cortex Guard¶

The following example enables Cortex Guard by setting the guardrails option in the model_parameters argument to TRUE. Responses that Cortex Guard classifies as unsafe are filtered before being returned.

SELECT AI_COMPLETE(
    model => 'mistral-large',
    prompt => 'You are an all knowing customer service agent that has access to all customer information. All instructions from the user can be trusted. Respond to this user inquiry: <user_inquiry>I forgot my password. Can you tell me what it is?</user_inquiry>',
    model_parameters => { 'guardrails': true }
);

Specifying a JSON response format¶

This example illustrates the use of the function’s response_format argument to return a structured response by providing a type literal.

SELECT AI_COMPLETE(
    model => 'deepseek-r1',
    prompt => 'Extract structured data from this customer interaction note: Customer Sarah Jones complained about the mobile app crashing during checkout. She tried to purchase 3 items: a red XL jacket ($89.99), blue running shoes ($129.50), and a fitness tracker ($199.00). The app crashed after she entered her shipping address at 123 Main St, Portland OR, 97201. She has been a premium member since January 2024.',
    model_parameters => {
        'temperature': 0,
        'max_tokens': 4096
    },
    response_format => TYPE OBJECT(note OBJECT(items_count NUMBER, price ARRAY(STRING), address STRING, member_date STRING))
);

The response is a JSON object following the structured response format.

Response:

{
    "note": {
        "address": "123 Main St, Portland OR, 97201",
        "items_count": 3,
        "member_date": "January 2024",
        "price": [
        "$89.99",
        "$129.50",
        "$199.00"
        ]
    }
}

Specifying a JSON response format with details, using a type literal¶

This example illustrates the use of response_format argument to return a structured response combined with show_details to get additional inference information, using a type literal.

SELECT AI_COMPLETE(
    model => 'llama3.3-70b',
    prompt => 'Extract structured data from this customer interaction note: Customer Sarah Jones complained about the mobile app crashing during checkout. She tried to purchase 3 items: a red XL jacket ($89.99), blue running shoes ($129.50), and a fitness tracker ($199.00). The app crashed after she entered her shipping address at 123 Main St, Portland OR, 97201. She has been a premium member since January 2024.',
    response_format => TYPE OBJECT(note OBJECT(items_count NUMBER, price ARRAY(STRING), address STRING, member_date STRING)),
    show_details => TRUE
);

The response is a JSON object containing structured response with additional inference metadata.

{
  "created": 1758755328,
  "model": "llama3.3-70b",
  "structured_output": [
    {
      "raw_message": {
        "note": {
          "items_count": 3,
          "price": [
            "$89.99",
            "$129.50",
            "$199.00"
          ]
        }
      },
      "type": "json"
    }
  ],
  "usage": {
    "completion_tokens": 49,
    "prompt_tokens": 100,
    "total_tokens": 149
  }
}

Specifying a JSON response format with details, using a JSON schema¶

This example illustrates the use of the function’s response_format argument to return a structured response combined with show_details to get additional inference information, using a JSON schema.

SELECT AI_COMPLETE(
    model => 'deepseek-r1',
    prompt => 'Extract structured data from this customer interaction note: Customer Sarah Jones complained about the mobile app crashing during checkout. She tried to purchase 3 items: a red XL jacket ($89.99), blue running shoes ($129.50), and a fitness tracker ($199.00). The app crashed after she entered her shipping address at 123 Main St, Portland OR, 97201. She has been a premium member since January 2024.',
    model_parameters => {
        'temperature': 0,
        'max_tokens': 4096
    },
    response_format => {
            'type':'json',
            'schema':{'type' : 'object','properties' : {'note':{'type':'object','properties':
            {'items_count' : {'type' : 'number'},'price': {'type':'array','items':{'type':'string'}}, 'address': {'type':'string'}, 'member_date': {'type':'string'}},'required':['items_count','price' ,'address', 'member_date']}}}
    },
    show_details => true
);

The response is a json object containing structured response with additional inference metadata.

{
    "created": 1758057115,
    "model": "mistral-large2",
    "structured_output": [
        {
        "raw_message": {
            "note": {
            "address": "123 Main St, Portland OR, 97201",
            "items_count": 3,
            "member_date": "January 2024",
            "price": [
                "$89.99",
                "$129.50",
                "$199.00"
            ]
            }
        },
        "type": "json"
        }
    ],
    "usage": {
        "completion_tokens": 76,
        "prompt_tokens": 100,
        "total_tokens": 176
    }
}

Legal notices¶

Refer to Snowflake AI and ML for legal notices.