snow cortex complete¶

Given a prompt, the command generates a response using your choice of language model. In the simplest use case, the prompt is a single string. You may also provide a JSON file with conversation history including multiple prompts and responses for interactive chat-style usage.

Syntax¶

snow cortex complete
  
  --model 
  --backend 
  --file 
  --connection 
  --host 
  --port 
  --account 
  --user 
  --password 
  --authenticator 
  --private-key-file 
  --token-file-path 
  --database 
  --schema 
  --role 
  --warehouse 
  --temporary-connection
  --mfa-passcode 
  --enable-diag
  --diag-log-path 
  --diag-allowlist-path 
  --oauth-client-id 
  --oauth-client-secret 
  --oauth-authorization-url 
  --oauth-token-request-url 
  --oauth-redirect-uri 
  --oauth-scope 
  --oauth-disable-pkce
  --oauth-enable-refresh-tokens
  --oauth-enable-single-use-refresh-tokens
  --client-store-temporary-credential
  --format 
  --verbose
  --debug
  --silent
  --enhanced-exit-codes

Copy

Arguments¶

text: Prompt to be used to generate a completion. Cannot be combined with –file option.

Options¶

--model TEXT: String specifying the model to be used. Default: llama3.1-70b.
--backend [sql|rest]: String specifying whether to use sql or rest backend. Default: rest.
--file FILE: JSON file containing conversation history to be used to generate a completion. Cannot be combined with TEXT argument.
--connection, -c, --environment TEXT: Name of the connection, as defined in your config.toml file. Default: default.
--host TEXT: Host address for the connection. Overrides the value specified for the connection.
--port INTEGER: Port for the connection. Overrides the value specified for the connection.
--account, --accountname TEXT: Name assigned to your Snowflake account. Overrides the value specified for the connection.
--user, --username TEXT: Username to connect to Snowflake. Overrides the value specified for the connection.
--password TEXT: Snowflake password. Overrides the value specified for the connection.
--authenticator TEXT: Snowflake authenticator. Overrides the value specified for the connection.
--private-key-file, --private-key-path TEXT: Snowflake private key file path. Overrides the value specified for the connection.
--token-file-path TEXT: Path to file with an OAuth token to use when connecting to Snowflake.
--database, --dbname TEXT: Database to use. Overrides the value specified for the connection.
--schema, --schemaname TEXT: Database schema to use. Overrides the value specified for the connection.
--role, --rolename TEXT: Role to use. Overrides the value specified for the connection.
--warehouse TEXT: Warehouse to use. Overrides the value specified for the connection.
--temporary-connection, -x: Uses a connection defined with command line parameters, instead of one defined in config. Default: False.
--mfa-passcode TEXT: Token to use for multi-factor authentication (MFA).
--enable-diag: Whether to generate a connection diagnostic report. Default: False.
--diag-log-path TEXT: Path for the generated report. Defaults to system temporary directory. Default: .
--diag-allowlist-path TEXT: Path to a JSON file that contains allowlist parameters.
--oauth-client-id TEXT: Value of client id provided by the Identity Provider for Snowflake integration.
--oauth-client-secret TEXT: Value of the client secret provided by the Identity Provider for Snowflake integration.
--oauth-authorization-url TEXT: Identity Provider endpoint supplying the authorization code to the driver.
--oauth-token-request-url TEXT: Identity Provider endpoint supplying the access tokens to the driver.
--oauth-redirect-uri TEXT: URI to use for authorization code redirection.
--oauth-scope TEXT: Scope requested in the Identity Provider authorization request.
--oauth-disable-pkce: Disables Proof Key for Code Exchange (PKCE). Default: False.
--oauth-enable-refresh-tokens: Enables a silent re-authentication when the actual access token becomes outdated. Default: False.
--oauth-enable-single-use-refresh-tokens: Whether to opt-in to single-use refresh token semantics. Default: False.
--client-store-temporary-credential: Store the temporary credential.
--format [TABLE|JSON]: Specifies the output format. Default: TABLE.
--verbose, -v: Displays log entries for log levels info and higher. Default: False.
--debug: Displays log entries for log levels debug and higher; debug logs contain additional information. Default: False.
--silent: Turns off intermediate output to console. Default: False.
--enhanced-exit-codes: Differentiate exit error codes based on failure type. Default: False.

--help: Displays the help text for this command.

Usage notes¶

In the simplest use case, the prompt is a single string. You can also provide a JSON file with conversation history, including multiple prompts and responses, for interactive chat-style conversation.

Examples¶

Ask a question using the default model.

snow cortex complete "Is 5 more than 4? Please answer using one word without a period." -c snowhouse

Copy

Yes

Ask a question using a specified model.

snow cortex complete "Is 5 more than 4? Please answer using one word without a period." -c snowhouse --model reka-flash

Copy

Yes