SQL Server

AI: Diagnosing an Ask Failure

See more AI Examples

Demonstrates how to get information about why a request to the AI provider failed. SQL Server

-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
    DECLARE @hr int
    DECLARE @iTmp0 int
    -- Important: Do not use nvarchar(max).  See the warning about using nvarchar(max).
    DECLARE @sTmp0 nvarchar(4000)
    DECLARE @success int
    SELECT @success = 0

    -- This example assumes the Chilkat API to have been previously unlocked.
    -- See Global Unlock Sample for sample code.

    DECLARE @ai int
    EXEC @hr = sp_OACreate 'Chilkat.Ai', @ai OUT
    IF @hr <> 0
    BEGIN
        PRINT 'Failed to create ActiveX component'
        RETURN
    END

    -- The provider can be "openai", "google", "claude", "deepseek", "xai", or "perplexity".
    -- Support for additional providers will be added in future versions of Chilkat.
    EXEC sp_OASetProperty @ai, 'Provider', 'openai'

    -- In this case, we're going to cause an intentional failure by using an invalid API key.
    EXEC sp_OASetProperty @ai, 'ApiKey', 'sk-11111111111111111111111111111111111111111111111k'

    -- Choose a model.
    EXEC sp_OASetProperty @ai, 'Model', 'gpt-4o'

    -- Add a text input.
    EXEC sp_OAMethod @ai, 'InputAddText', @success OUT, 'Say Hello.'

    -- Ask the AI for text output.
    EXEC sp_OAMethod @ai, 'Ask', @success OUT, 'text'
    IF @success = 0
      BEGIN
        -- If the response status code equals 0, it means the error occurred before receiving the HTTP response.
        -- For this case look at the LastErrorText.
        EXEC sp_OAGetProperty @ai, 'ResponseStatusCode', @iTmp0 OUT
        IF @iTmp0 = 0
          BEGIN
            EXEC sp_OAGetProperty @ai, 'LastErrorText', @sTmp0 OUT
            PRINT @sTmp0
          END
        ELSE
          BEGIN
            -- If we received an error response, the status code will be >= 400.
            -- (Ask would've returned 1 if the response status code was 200.)

            EXEC sp_OAGetProperty @ai, 'ResponseStatusCode', @iTmp0 OUT
            PRINT 'Response status code: ' + @iTmp0

            -- The error response (JSON) is available in the LastJsonData.
            DECLARE @json int
            EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @json OUT

            EXEC sp_OASetProperty @json, 'EmitCompact', 0
            EXEC sp_OAMethod @ai, 'GetLastJsonData', NULL, @json
            EXEC sp_OAMethod @json, 'Emit', @sTmp0 OUT
            PRINT @sTmp0

            -- Sample output:
            -- {
            --   "error": {
            --     "message": "Incorrect API key provided: sk-11111***************************************111k. You can find your API key at https://platform.openai.com/account/api-keys.",
            --     "type": "invalid_request_error",
            --     "param": null,
            --     "code": "invalid_api_key"
            --   }
            -- }
          END
        EXEC @hr = sp_OADestroy @ai
        EXEC @hr = sp_OADestroy @json
        RETURN
      END

    -- Get the text response.
    DECLARE @sbResponse int
    EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbResponse OUT

    EXEC sp_OAMethod @ai, 'GetOutputTextSb', @success OUT, @sbResponse
    EXEC sp_OAMethod @sbResponse, 'GetAsString', @sTmp0 OUT
    PRINT @sTmp0

    EXEC @hr = sp_OADestroy @ai
    EXEC @hr = sp_OADestroy @json
    EXEC @hr = sp_OADestroy @sbResponse


END
GO