Configure AI Account

Sets up an AI account to use by name, given a model provider (or endpoint) and an API key.

See also 

Options 

  • Account Name assigns a name to this AI account, which is used to reference this account in other AI script steps and functions. The name is unrelated to the model provider and can be any calculated text expression. If you set up more than one account in the current file, each account name must be unique.

  • Model Provider specifies a predefined or a custom model provider. For Custom, you must also specify a URL for the Endpoint option.

  • API key is the key that authorizes you to use the model provider's service. See the website for the model provider for how to get an API key or how to generate a PKI token. Or, if you're using the open source model server provided separately with FileMaker Pro or installed with FileMaker Server, see the Claris Engineering Blog.

Options available only when Model Provider is Custom:

  • Endpoint is the URL for the API endpoint to use. Specify the endpoint as a text expression that ends with a slash (/)—for example, "https://localhost:8080/".

  • Verify SSL Certificates verifies the SSL certificate of the server specified by Endpoint. If the certificate cannot be verified in the script step that uses this AI account, users can choose to connect anyway or cancel to skip the script step. If the certificate cannot be verified and the Set Error Capture script step is set to On, the script step that uses this AI account behaves as if the server were unavailable.

Compatibility 

Product Supported
FileMaker Pro Yes
FileMaker Go Yes
FileMaker WebDirect Yes
FileMaker Server Yes
FileMaker Cloud Yes
FileMaker Data API Yes
Custom Web Publishing Yes

Originated in version 

21.0

Description 

This script step sets up an AI account that is available only in the current file. When the file is closed, the AI account configuration is cleared. Other AI script steps and functions reference the specified account name to use this account.

Notes 

  • When you set Model Provider to Custom to use an open source model, the URL you specify for Endpoint and the format of the response returned by the model must be compatible with the OpenAI API. For more information, see the OpenAI API documentation.

Example 1 

Sets up an OpenAI account named my_account with the specified API key.

Copy 
Configure AI Account [ Account Name: "my-account" ; Model Provider: OpenAI ; API key: "sk-RZCtpWT..." ]

Example 2 

Sets up an account named my_account for a custom model provider at the specified endpoint with an API key stored in a global field.

Copy 
Configure AI Account [ Account Name: "my-account" ; Model Provider: Custom ; 
Endpoint: "https://myserver.example.com:8080/" ; Verify SSL Certificates ; API key: Global::API_Key ]

Related topics