Spring AI with Open Ai

Integrating OpenAI ChatGPT with Spring AI

With the advent of AI-driven technologies, Spring AI now supports OpenAI's ChatGPT, a powerful language model that has significantly advanced the capabilities of text generation in software applications. In this blog, we will delve into the process of integrating ChatGPT with Spring AI, explaining key concepts and providing practical examples to help you get started.

Getting Started: Obtaining an OpenAI API Key

The first step towards integrating ChatGPT into your Spring application is obtaining an API key from OpenAI, which serves as your secret key for accessing the API. Here’s how to do it:

  1. Visit the OpenAI website and sign up for an account.
  2. Once your account is set up, navigate to the API section and select the 'API Keys' page.
  3. Click on 'Create new key'. This will generate a new API key that you can use in your application.
  4. Copy this key and secure it. You will need to add this key to your Spring application’s environment variables.

Prerequisites

Before integrating ChatGPT into your Spring application, you must first set up an OpenAI API account. Start by creating an account on the OpenAI signup page and generate an API key on the API Keys page. This key will be used in your application to authenticate API requests.

Setting Up Your Environment

Configure your Spring AI project by exporting the API key as an environment variable:

export SPRING_AI_OPENAI_API_KEY=<INSERT KEY HERE>

Dependency Management

To manage dependencies effectively, add the Spring AI Bill of Materials (BOM) and relevant repositories to your build system. This ensures consistent versions across your project.

Enabling Auto-configuration

Spring Boot simplifies the integration of OpenAI ChatGPT through auto-configuration. Add the spring-ai-openai-spring-boot-starter dependency to your Maven or Gradle configuration:


// Maven
<dependency>
    <groupId>org.springframework.ai</groupId>
    <artifactId>spring-ai-openai-spring-boot-starter</artifactId>
</dependency>

// Gradle
dependencies {
    implementation 'org.springframework.ai:spring-ai-openai-spring-boot-starter'
}

Configuration and Usage

Several properties can be configured to customize the behavior of the ChatGPT client. For instance, you can set retry policies, connection settings, and chat-specific options like model choice and response format.

You can write either application.properties or, application.yml as per your choice. Here are some examples of how to configure these settings:

application.properties


# OpenAI API key
openai.api.key=your-api-key-here

# Model choice (e.g., gpt-3.5-turbo, gpt-4)
openai.model=gpt-3.5-turbo

# Maximum number of tokens in the response
openai.max-tokens=2048

# Temperature setting for response creativity (0.0 to 1.0)
openai.temperature=0.7

# Retry policies
openai.retry.max-attempts=3
openai.retry.backoff-period=2000

# Connection settings
openai.connection.timeout=5000
openai.read-timeout=5000

# Proxy settings (if needed)
openai.proxy.host=proxy.example.com
openai.proxy.port=8080

# Custom headers (if needed)
openai.headers.X-Custom-Header=custom-value

application.yml


openai:
  api:
    key: your-api-key-here
  model: gpt-3.5-turbo
  max-tokens: 2048
  temperature: 0.7
  retry:
    max-attempts: 3
    backoff-period: 2000
  connection:
    timeout: 5000
    read-timeout: 5000
  proxy:
    host: proxy.example.com
    port: 8080
  headers:
    X-Custom-Header: custom-value

Advanced Features: Function Calling with Example

OpenAI ChatGPT also supports function calling, allowing the model to generate JSON outputs that can invoke registered Java functions. This bridges the gap between the AI's text generation capabilities and practical application functionalities.

Example Implementation

Below is an example of how to set up a simple Spring Boot controller to utilise the ChatGPT client:


@RestController
public class ChatController {
    private final OpenAiChatClient chatClient;

    @Autowired
    public ChatController(OpenAiChatClient chatClient) {
        this.chatClient = chatClient;
    }

    @GetMapping("/ai/generate")
    public Map generate(@RequestParam(value = "message", defaultValue = "Tell me a joke") String message) {
        return Map.of("generation", chatClient.call(message));
    }
}

Conclusion

Integrating OpenAI's ChatGPT with Spring AI enhances your applications by enabling sophisticated AI-driven text generation capabilities. By following the steps outlined above, you can successfully set up and customise the OpenAI Chat client within your Spring AI environment, paving the way for innovative applications that leverage cutting-edge AI technology.

For a deeper dive into more advanced configurations and features, refer to the full documentation provided by Spring AI and OpenAI.

Also Read:  Spring Boot with Ollama

Related categories:

Comments

Post a Comment

Popular Posts on Code Katha

Java Interview Questions for 10 Years Experience

Image
Welcome to the comprehensive guide on "Java Interview Questions for 10 Years Experience." Java has been one of the most popular programming languages for decades, and its widespread adoption means that the demand for skilled Java developers has never been higher. If you are someone who has been working with Java for the last decade, you have accumulated a wealth of experience and knowledge that you can showcase during interviews. Recommended  to read and brush up for your interview: Must know interview questions and concept for any Java Interview Spring boot interview Questions for 10 years experiance These simple and short articles help you to add AI to your resume and enhance the chance of selection: Java Spring Boot AI with Ollama Java Spring Boot AI with Open AI (Chat GPT) This blog post will provide you with a list of commonly asked interview questions for 10 years experienced Java developers. It will also include detailed answers to each question, with explanat
Read more

Sql Interview Questions for 10 Years Experience

Image
As an experienced SQL professional, you might encounter challenging questions during a job interview. In this blog post, we will explore 10 common SQL interview questions and provide in-depth explanations along with relevant examples. Let's dive in! Contents [ hide ] What is SQL Injection, and how can you prevent it? SQL Injection is a malicious attack where an attacker manipulates input data to execute unintended SQL statements. It can lead to unauthorized access, data breaches, and data manipulation. To prevent SQL Injection, follow these best practices: 1.1. Use Prepared Statements: Prepared statements or parameterized queries separate SQL code from data input, preventing attackers from injecting malicious SQL code. Here's an example in PHP: $stmt = $pdo->prepare('SELECT * FROM users WHERE username = :username'); $stmt->bindParam(':username', $username); $stmt->execute(); 1.2. Sanitize User Input: Validate and sanitize user input
Read more

Spring Boot Interview Questions for 10 Years Experience

Image
Welcome to the comprehensive guide on "Spring Boot Interview Questions for 10 Years Experience". Spring Boot has become one of the most popular frameworks for developing enterprise-grade applications, and its widespread adoption means that the demand for skilled Spring Boot developers has never been higher. If you are someone who has been working with Spring Boot for the last decade, you have accumulated a wealth of experience and knowledge that you can showcase during interviews. Recommended  to read and brush up for your interview: Must know interview questions and concept for any Java Interview Java Interview Questions for 10 Years Experience These simple and short articles help you to add AI to your resume and enhance the chance of selection: Spring Boot AI with Ollama Spring Boot AI with Open AI (Chat GPT) This blog post will provide you with a list of commonly asked interview questions for 10 years expe
Read more

Java interview questions - Must to know concepts

Contents [ hide ] How does Java achieve platform independence, and what is the underlying principle? Java programs can run on diverse operating systems and hardware setups without requiring modification. This feat is primarily achieved through the concept of the Java Virtual Machine (JVM). The Java Virtual Machine (JVM) The JVM acts as a bridge between the Java code you write and the underlying hardware and operating system . When you compile your Java code, it is translated into an intermediate form called bytecode, which is not tied to any specific platform. The JVM then comes into play. It takes this bytecode and dynamically translates it into machine-specific instructions that the host system can execute. This means that a Java program can be written once and executed on any system with the appropriate JVM for that system. Example: Running a Java Program on Different Platforms Consider a simple Java program that calculates the sum of two numbers: package codeKatha
Read more

Visual Studio Code setup for Java and Spring with GitHub Copilot

Image
Introduction- In this tutorial blog, we will explore the process of setting up and utilising Visual Studio Code for Java programming, as well as incorporating GitHub Copilot as a valuable coding tool. Visual Studio Code is a powerful and versatile code editor that offers a wide range of features and extensions for Java developers. By using Visual Studio Code for Java programming, developers can benefit from features such as code completion, debugging, and live coding. Additionally, with the integration of GitHub Copilot, developers can streamline their coding process with AI-assisted suggestions for code snippets and functions. This blog will provide a comprehensive guide for setting up and using these tools for Java development. Contents [ hide ] Setup Visual Studio Code for Java and Spring Visual Studio Code (VS Code) is an open-source code editor that supports a wide range of programming languages, including Java. It is a powerful tool
Read more

Spring Data JPA

Image
Introduction- We will learn here Spring Data JPA, perform CRUD operation, Clear concept of Relationship mapping like one-to-many, many-to-one with Example. Spring Data JPA is a powerful framework that simplifies the process of working with relational databases in Java applications. It provides an easy-to-use API for working with JPA, allowing developers to focus on their business logic instead of worrying about the details of how JPA works. With Spring Data JPA, you can easily define entities that map to database tables, and then use them to perform CRUD (create, read, update, delete) operations on those tables. In addition, Spring Data JPA provides support for more advanced features like querying and pagination, making it an excellent choice for both small and large projects. Contents [ hide ] In this blog, we will explore Spring Data JPA by building a sample application that uses it to manage users and packs. But, before let
Read more

Data Structures & Algorithms Tutorial with Coding Interview Questions

Image
About the Course This course offers comprehensive coverage of coding questions that serve as a solid foundation for understanding DSA concepts. These questions are frequently asked in coding interviews, either directly or with some variations, by many companies, including Adobe, Facebook (Meta), Paytm, Amazon, Google, and others. Our primary objective is to enhance your problem-solving skills and enable you to devise optimal solutions. The course includes a wide range of topics, such as Arrays, Strings, Searching and Sorting, Greedy Algorithms, Trees, Graphs, Dynamic Programming, and more. Upon completion, you will possess the necessary skills to ace DSA interviews for typical companies or excel in the initial rounds of product-based companies such as Google, Microsoft and similar others. We are started with Graph data Structure and add others soon. Contents [ hide ] Approach Our course is  organised into chapters that foll
Read more

Java interview questions for 5 years experience

Contents [ hide ] What is difference between Heap and Stack Memory in Java, and shed light on their utilization? In Java, memory management plays a crucial role in determining how objects are stored and accessed during program execution . Heap and Stack Memory are two distinct regions where different types of data are managed. Understanding their differences is essential for efficient memory utilisation and managing object lifecycles. Stack Memory Stack Memory is a region used for storing method calls, local variables, and references to objects . It operates in a Last-In-First-Out (LIFO) manner , resembling a stack of items. Each method call creates a new frame in the stack, containing variables specific to that method. Stack Memory is relatively fast for allocation and deallocation because it follows a strict order. However, it has limited space and is typically used for small, short-lived data. Primitive data types and references to objects are often stored here. Ex
Read more

Elasticsearch Java Spring Boot

Image
Introduction- In this blog, we will learned how to use Elasticsearch with Spring Boot to build a search application. We will created several classes as an example, including ElasticsearchConfig, Book, BookService, BookController, and BookRepository, to demonstrate how to use Elasticsearch with Spring Boot. After this tutorial, you can start building your own search application using Elasticsearch and Spring Boot. Elasticsearch is a powerful search and analytics engine that can be used to build highly scalable and fault-tolerant applications. In this blog, we will learn how to use Elasticsearch with Spring Boot to build a search application. First we will Set up a Spring Boot project with Elasticsearch after that we will see how to make connection with elasticsearch. Once connection setupt is done then we will add data then perform queries and searching on Elasticsearch. Contents [ hide ] Setting up a Spring Boot project with Elas
Read more

Spring AI with Ollama

Image
Introduction to Spring AI with Ollama Welcome to a comprehensive guide on leveraging Spring AI with Ollama to develop AI-driven applications using Java. This tutorial will cover everything from setting up Ollama locally, configuring your development environment, to creating an application that utilizes large language models for text generation. Contents [ hide ] Setting Up Ollama Installing Ollama To use Ollama locally, you must first install it on your machine. This involves downloading the Ollama software from the official repository and configuring it to run without Docker. Follow the installation instructions provided in the Ollama README file available on their official GitHub page . Ollama Download link Downloading the Mistral Model After setting up Ollama, you can download the Mistral model directly from the Ollama management interface. Mistral is designed for a broad range of applications, offering robust text generation capabilities. // Run this command in cl
Read more