Skip to content
Nappai Documentation

Azure OpenAI

This component lets you generate text using the power of Azure OpenAI’s language models within Nappai. It simplifies the process of getting creative text outputs from Azure OpenAI, making it easy to integrate into your automated workflows.

Relationship with Azure OpenAI

This component connects directly to the Azure OpenAI API. It allows Nappai to send requests to Azure OpenAI’s powerful language models and receive generated text as a result. You don’t need to know anything about the API itself; this component handles all the technical details.

Inputs

  • Azure Endpoint: The web address of your Azure OpenAI resource. Nappai will provide an example. This is essential for the component to connect to your Azure service.
  • Deployment Name: The name of your specific deployment within Azure OpenAI. This identifies which language model you want to use.
  • API Version: Choose the version of the Azure OpenAI API you want to use. The latest version will be selected by default.
  • Temperature: This controls how creative the generated text is. A higher number (e.g., 1.0) makes the text more random and unpredictable, while a lower number (e.g., 0.0) makes it more focused and deterministic. The default is 0.7.
  • Max Tokens: This sets a limit on the length of the generated text. Leave it at 0 for unlimited length (advanced users).
  • Credential: Your Azure OpenAI API key. This is how Nappai authenticates with your Azure account to access the language models. Keep this credential secure!

Outputs

The component doesn’t have explicit outputs in the way some other components do. Instead, it generates text based on your inputs. This generated text can then be used by other components in your Nappai workflow (e.g., to send an email, update a document, or populate a database).

Usage Example

Imagine you want to automatically generate product descriptions for your online store. You could use the Azure OpenAI component to take product information (name, features, etc.) as input, and generate compelling descriptions. The generated descriptions could then be automatically added to your store’s database.

Templates

[List of templates where the component can be seen and its configuration - This section needs to be populated with actual template information.]

  • Explain SQL results: Use this to understand the results of database queries. You could use Azure OpenAI to summarize these results in plain language.
  • Summarizer: Summarize long texts. Azure OpenAI can be used to create concise summaries of lengthy documents.
  • Natural Language to SQL: Translate natural language into SQL queries. Azure OpenAI can help generate the natural language input for this component. [Add links and descriptions for other relevant components as needed.]

Tips and Best Practices

  • Start with the default settings: Experiment with the temperature setting to find the best balance between creativity and accuracy.
  • Keep your API key secret: Never share your Azure OpenAI credential with anyone.
  • Test your configuration: Always test your settings with a small amount of data before running the component on a large scale.

Security Considerations

  • Protect your API key: Treat your Azure OpenAI credential like a password. Do not expose it in your code or share it publicly.
  • Be mindful of the data you process: Avoid sending sensitive information to the Azure OpenAI API. The generated text might reflect the input data, so be cautious about what you provide.