Installation of the component

To install Aleph Alpha Connector and use it in your project, you just need to follow the steps below:

1. Install the component from the OutSystems Forge.
2. Add a dependency to the module called “AlephAlpha_IS”.
   
3. Check all Server Actions you want to use.
4. Click on “Apply”.

Aleph Alpha API Token

For all Server Actions except “AlephAlpha_GetVersion” you need to authenticate with your API token passed in the input parameter “AuthToken”.

Sign up for an account

If you already have an account you can skip this paragraph and just log into your account. Otherwise, please first sign up for an account:

1. Go to https://app.aleph-alpha.com and click on “Sign up” in the top right corner.
2. Enter your e-mail address, check the boxes according to your preferences and click on “Sign up”.

Create an API token

After you have logged into your account you can manage your API tokens:

1. Click on the user profile icon in the top right corner.
   
2. Click on “Profile”.
3. In section “API Tokens” click on “Create Token”.
4. Enter a description for the new token. This is just for you to differentiate tokens easier.
5. After the token has been created successfully, it will be displayed only once. So please make sure, you copy and save it in a secure place.

Demo App

If you want to see the Aleph Alpha Connector in action and learn more on how to use the integration service’s server actions, you can also install the demo app from the forge. This demo app needs your API token, so please make sure to configure the Site Property “AlephAlphaAPIToken” accordingly.

Server Actions

The Integration Service provides the following Server Actions which connect to the API and return the received results. Please have in mind, that the actions directly call the API and Alph Alpha will charge you a certain amount of credits on those calls.

Models

• AlephAlpha_GetAvailableModels
  returns all currently available models.

Tasks

• AlephAlpha_CompleteMultimodal
  completes a multimodal prompt using a specific model.
• AlephAlpha_CompleteTextPrompt
  completes a text prompt using a specific model.
• AlephAlpha_Detokenize
  converts a list of tokens into a string.
• AlephAlpha_GetRecentRequests
  returns a list of the ten most recent successful tasks with statistics, including duration of execution and cost in credits.
• AlephAlpha_QA
  answers a question about text given in a prompt.
• AlephAlpha_Summarize
  summarizes a document using a specific model.
• AlephAlpha_Tokenize
  converts a prompt into tokens for a specific model.

Tokens

• AlephAlpha_CreateAPIToken
  creates a new token to authenticate against the API.
• AlephAlpha_DeleteAPIToken
  deletes an API token.
• AlephAlpha_GetAPIToken
  returns a list of issued API tokens.

Users

• AlephAlpha_GetUser
  returns settings and details for the own user.
• AlephAlpha_UpdateUser
  changes settings for the own user.

Version

• AlephAlpha_GetVersion
  returns the current API version.