Skip to main content

Setting up the AI Integrations

How to connect Planhat to your choice of AI provider

Carly Hammond avatar
Written by Carly Hammond
Updated over 2 weeks ago

Summary

  • Planhat has Integrations for OpenAI, Microsoft Azure OpenAI Service, and Google PaLM 2

  • You can use your choice of Integration to link Planhat to your own AI account, entering an API token from your AI provider into Planhat

  • You then use Planhat Automations to send prompts to your Generative AI provider (by making API calls), receive the responses and carry out actions in Planhat

Who is this article for?

  • Planhat users who are setting up an AI integration (e.g. Tech/Ops)

Article contents


Introduction

This is a technical deep-dive article

Read on if you're an Admin / CS Ops / Tech Specialist etc. will be connecting your AI account to Planhat.

If instead you'd like an overview of AI in Planhat, including the full range of features, use cases and security considerations, please refer to our main article for a summary.

While Planhat includes the native AI features "Writing Assistant" and "Account Summary", which work via Planhat's connection to Azure OpenAI Service, with Planhat's AI Integrations it's also possible for you to connect Planhat to your choice of AI provider (OpenAI, Microsoft Azure OpenAI Service, or Google PaLM 2), via your own business license.

Rather than having to choose from pre-set prompts and actions, using Planhat Automations you have free rein to prompt your choice of AI connection how you wish, potentially referring to both public data the LLM has been trained on, and your own Planhat data, and then you can decide what happens to the response in Planhat, e.g. whether it's saved as a specific custom Conversation Type or sent as a notification.

This is incredibly flexible! Check out the use case examples in our "AI in Planhat" overview article to give you some inspiration.

The setup process in Planhat has two main parts:

  1. You connect up your chosen Integration using your credentials from the relevant AI provider

  2. Then, you set up Automations using your AI connection

This article covers step 1 of the process.

Security considerations

Using your choice of AI Integration has the advantage that the AI account is yours - your choice of AI provider, and your connection. This means you have control over it, as opposed to using Planhat's connection to an AI provider. You can conduct your own internal security review, and choose the AI provider (LLM) that best meets your needs, and then connect your account to Planhat. If you have any questions about data location and AI training etc., those would be answered by your AI provider.

Once you set up the connection in a Planhat AI Integration, Planhat then has access to the AI provider, and can send your choice of prompts to it via its API. Your AI provider does not have access to Planhat data and can't request data from Planhat, although you can fetch any Planhat data within a Planhat Automation and then include it in a prompt to your AI provider.


How to set up an AI Integration

πŸ“Œ Important to note

At time of writing, in upgraded Planhat (ws.planhat.com), the AI Integrations have moved to the separate "Connections" section rather than being in "Integrations" (under "Apps").

  1. Go to the App Center, and click on "Connections" in the bottom left.

    Click the image to view it enlarged

  2. Click "+ Connection" in the top right, and select your choice of AI provider from the list

  3. Enter your API token in the "API Token" box

  4. Follow the instructions for your specific provider/Integration below:

    If you're setting up the OpenAI Integration, enter the "organization ID", which you can find in OpenAI, into the box shown annotated below:

    If you're setting up the Azure OpenAI Service Integration:

    • In the "API Base URL with Base Path:" box, you will see https://[[resourceName]].openai.azure.com/

      • Enter your own "resourceName" in place of [[resourceName]] - so you will end up with a URL of the format https://myopenairesource.openai.azure.com/

      • The "resourceName" is the name of the specific Azure OpenAI resource that you've created in your Azure portal. It uniquely identifies your instance of the OpenAI Service in Azure.

      • To find the resourceName, go to the Azure portal, navigate to your OpenAI resource, and use the name assigned to that resource.

    • You don't need to enter anything in the "Auth Headers" section of the Integration. You will see values for "api-key" and "Content-Type" prefilled for you; leave these as-is.

    If you're setting up the PaLM 2 Integration, you won't see anything prefilled here, and you don't need to add anything.

  5. Click "Save"

Just leave everything else as-is - e.g. leave the toggle switch(es) under the "Endpoints" section turned on.

  • These endpoints will be selected when you set up your Automations.

  • "Prompt" is the main endpoint you will be using in your Automations in the vast majority of cases (and it's the only option for PaLM 2). This is used for one-time input without maintaining an interactive conversation flow.

  • "Chat" is for multi-turn interactions, maintaining context over several exchanges.


Next steps - Automations

Once you've connected your AI account to Planhat, initially you'll see the message:

"No apps yet

Explore App library"

Click the image to view it enlarged

In order to use your AI connection, you'll need to set up Automations, which you also do in the App Center. You click "+ New app" in the top right of the App Center, and then either create a custom Automation, or select one of the templated Automations for OpenAI that, at time of writing, are located in the "Integrations" (rather than "Automations") part of the Apps Library.

Click the image to view it enlarged

As a quick overview, your Automation will include:

  1. The trigger - the change in data in Planhat (or schedule) that prompts the Automation to run

  2. The prompt that Planhat sends to your AI provider (OpenAI, Azure or PaLM 2)

  3. The action(s) you want to happen when Planhat receives the response back

Note that this is a simplification. For example, your Automation may contain additional steps, such as gathering information from Planhat before using it in the prompt sent to your AI provider.

You can learn more about Automations in our article series here.

When you've set up Automations using your AI connection, you will see them listed in the Connections list, similar to this:

Click the image to view it enlarged

You can click into each of these Automation titles to open up the Automation.


Further reading

  • Once you've connected your AI Integration, as described in this article, the next stage is to set up Automations using it - to learn more, see here.

  • To read an overview of all of Planhat's different AI features - AI Integrations, built-in native AI features, and functionality that uses Machine Learning (ML) - with information on use cases and security, see here.

Did this answer your question?