Summarize with Azure OpenAI Service API

Pipedream makes it easy to connect APIs for Azure OpenAI Service and 2,400+ other apps remarkably fast.

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Summarize with the Azure OpenAI Service API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

Create a workflow to Summarize with the Azure OpenAI Service API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the Summarize action
1. Connect your Azure OpenAI Service account
2. Configure Text
3. Optional- Select a Summary Length
4. Optional- Configure Temperature
5. Optional- Configure N
6. Optional- Configure Stream
7. Optional- Configure Stop
8. Optional- Configure Max Tokens
9. Optional- Configure Presence Penalty
10. Optional- Configure Frequency Penalty
11. Optional- Configure User
Select a trigger to run your workflow on HTTP requests, schedules or app events
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Integrations#

Summarize with Azure OpenAI Service API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + Azure OpenAI Service

Try it

Summarize with Azure OpenAI Service API on New Submission from Typeform API

Typeform + Azure OpenAI Service

Try it

Summarize with Azure OpenAI Service API on Custom Events from Zoom API

Zoom + Azure OpenAI Service

Try it

Summarize with Azure OpenAI Service API on New Submission (Instant) from Jotform API

Jotform + Azure OpenAI Service

Try it

Summarize with Azure OpenAI Service API on New Scheduled Tasks from Pipedream API

Pipedream + Azure OpenAI Service

Try it

Details#

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Summarize on Azure OpenAI Service

Description:Summarizes a text message with the GPT-35-Turbo and GPT-4 models. [See the documentation](https://learn.microsoft.com/en-us/azure/ai-services/openai/reference#chat-completions)

Version:0.0.1

Key:azure_openai_service-summarize

View on GitHub

Code#

import azureOpenAI from "../../azure_openai_service.app.mjs";
import common from "../common/common-helper.mjs";

export default {
  ...common,
  key: "azure_openai_service-summarize",
  name: "Summarize",
  description: "Summarizes a text message with the GPT-35-Turbo and GPT-4 models. [See the documentation](https://learn.microsoft.com/en-us/azure/ai-services/openai/reference#chat-completions)",
  version: "0.0.1",
  type: "action",
  props: {
    azureOpenAI,
    text: {
      label: "Text",
      description: "The text to summarize",
      type: "string",
    },
    length: {
      label: "Summary Length",
      description: "The length of the summary",
      type: "string",
      optional: true,
      options: [
        "word",
        "sentence",
        "paragraph",
        "page",
      ],
    },
    ...common.props,
  },
  methods: {
    ...common.methods,
    systemInstructions() {
      return "Your goal is to summarize the text the user provides. Please follow the length guidelines presented in the prompt.";
    },
    maxLength() {
      return this.length
        ? ` in one ${this.length}`
        : "";
    },
    userMessage() {
      return `Summarize the following text${this.maxLength()}: ${this.text}`;
    },
    summary(response) {
      return `Successfully created summary response with ID ${response.id}.`;
    },
    formatOutput({
      messages, response,
    }) {
      if (!messages || !response) {
        throw new Error("Invalid API output, please reach out to https://pipedream.com/support");
      }
      return {
        summary: response.choices?.[0]?.message?.content,
        messages,
      };
    },
  },
};

Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
Azure OpenAI Service	`azureOpenAI`	`app`	This component uses the Azure OpenAI Service app.
Text	`text`	`string`	The text to summarize
Summary Length	`length`	`string`	Select a value from the drop down menu:`wordsentenceparagraphpage`
Temperature	`temperature`	`string`	What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.
N	`n`	`integer`	How many completions to generate
Stream	`stream`	`boolean`	If set, partial message deltas will be sent, like in ChatGPT. Tokens will be sent as data-only server-sent events as they become available, with the stream terminated by a data: [DONE] message.
Stop	`stop`	`string`	Up to 4 sequences where the API will stop generating further tokens.
Max Tokens	`maxTokens`	`integer`	The maximum number of tokens allowed for the generated answer. By default, the number of tokens the model can return will be (4096 - prompt tokens).
Presence Penalty	`presencePenalty`	`string`	Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics.
Frequency Penalty	`frequencyPenalty`	`string`	Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim.
User	`user`	`string`	A unique identifier representing your end-user, which can help Azure OpenAI to monitor and detect abuse.

Authentication#

Azure OpenAI Service uses API keys for authentication. When you connect your Azure OpenAI Service account, Pipedream securely stores the keys so you can easily authenticate to Azure OpenAI Service APIs in both code and no-code steps.

Before you start, you'll need to deploy a model in the Azure OpenAI Service.

Once that's done, enter the name of your Azure OpenAI resource, the deployment name you chose when you deployed the model, and your Azure OpenAI key below.