Introdução à integração do Spring AI

Crie um aplicativo Spring Java.

1. Navegue até o Spring Initializr e configure seu projeto com as seguintes configurações:

   • Projeto: Maven

   • Linguagem: Java

   • Spring Boot: você pode usar a versão padrão selecionada.

   • Metadados do projeto:

   • Java: 21

   • Você pode usar valores padrão para todos os outros campos.

2. No lado direito do Spring Initializr, clique em ADD DEPENDENCIES e, em seguida, pesquise e adicione as seguintes dependências:

   • MongoDB Atlas Vector Database

   • Spring Data MongoDB

3. Clique em GENERATE para baixar uma versão compactada do seu projeto Spring. Descompacte o arquivo e abra-o no seu IDE.

Adicione dependências.

1. O Spring AI fornece configuração automática do Spring Boot para o Atlas Vector Search.

   Adicione as seguintes dependências ao array dependencies no arquivo pom.xml do seu projeto. Essas dependências adicionam o Spring AI e a biblioteca de configuração automática ao seu aplicativo:

   pom.xml

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

2. Em seguida, assegure que seu arquivo pom.xml contenha uma entrada dependencyManagement para a Lista de Materiais (BOM) do Spring AI.

   Importante

   Defina a constante spring-ai.version usada para a BDM do Spring AI como 1.0.0-SNAPSHOT para implementar os recursos mais recentes do Spring AI em seu aplicação.

   Para saber mais sobre o BOM do Spring AI, consulte a seção Gerenciamento de dependências da documentação do Spring AI.

3. Por fim, adicione o repositório do Spring AI snapshot à entrada repositories no arquivo pom.xml :

   pom.xml

   <repository>
     <id>spring-snapshots</id>
     <name>Spring Snapshots</name>
     <url>https://repo.spring.io/snapshot</url>
     <releases>
       <enabled>false</enabled>
     </releases>
   </repository>

   Para saber mais sobre esses repositórios, consulte a seção Adicionar repositórios de marcos e instantâneos da documentação do Spring AI.

   Depois de terminar de editar o arquivo pom.xml, recarregue o projeto para garantir que as dependências estejam instaladas.

Definir propriedades do aplicativo.

Localize o arquivo src/main/resources/application.properties e substitua o conteúdo desse arquivo pelas seguintes propriedades. Substitua os espaços reservados pela sua chave de API do OpenAI e sua string de conexão do Atlas:

spring.application.name=springai-mongodb
spring.ai.openai.api-key=<OpenAI API Key>
spring.ai.openai.embedding.options.model=text-embedding-ada-002
spring.data.mongodb.uri=<connection string>
spring.data.mongodb.database=springai_test
spring.ai.vectorstore.mongodb.indexName=vector_index
spring.ai.vectorstore.mongodb.collection-name=vector_store

mongodb+srv://<db_username>:<db_password>@<clusterName>.<hostname>.mongodb.net/?<settings>

Habilitar inicialização de esquema.

Quando você configura o Atlas como o armazenamento vetorial no seu aplicativo, o Spring AI pode inicializar o esquema de back-end automaticamente. Essa inicialização inclui a criação de um índice do Atlas Vector Search na coleção que contém seus embeddings vetoriais.

Para permitir a inicialização do esquema, adicione a seguinte configuração ao seu arquivo application.properties:

spring.ai.vectorstore.mongodb.initialize-schema=true

Especificar initialize-schema=true faz com que o Spring AI crie de forma programática um índice Atlas Vector Search no seu cluster. Para saber mais, consulte Criar um índice do Atlas Vector Search.

Adicione instruções de importação.

Cole o código a seguir no arquivo Config.java para importar as classes necessárias:

import org.springframework.ai.embedding.EmbeddingModel;
import org.springframework.ai.openai.OpenAiEmbeddingModel;
import org.springframework.ai.openai.api.OpenAiApi;
import org.springframework.ai.vectorstore.MongoDBAtlasVectorStore;
import org.springframework.ai.vectorstore.VectorStore;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.SpringBootConfiguration;
import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.data.mongodb.core.MongoTemplate;

propriedades do aplicativo de referência.

Cole o código a seguir no arquivo Config.java para fazer referência aos valores que você definiu no arquivo de propriedades do aplicativo:

@Configuration
@SpringBootConfiguration
@EnableAutoConfiguration
public class Config {
    @Value("${spring.ai.openai.api-key}")
    private String openAiKey;
    @Value("${spring.data.mongodb.database}")
    private String databaseName;
    @Value("${spring.ai.vectorstore.mongodb.collection-name:vector_store}")
    private String collectionName;
    @Value("${spring.ai.vectorstore.mongodb.indexName:vector_index}")
    private String indexName;
    @Value("${spring.data.mongodb.uri}")
    private String mongoUri;
    @Value("${spring.ai.vectorstore.mongodb.initialize-schema}")
    private Boolean initSchema;
    // Add beans here...
}

Crie o Spring bean EmbeddingModel.

Em seguida, cole o seguinte código para gerar a instância OpenAiEmbeddingModel que usa a API OpenAI para criar incorporações vetoriais:

@Bean
public EmbeddingModel embeddingModel() {
    return new OpenAiEmbeddingModel(new OpenAiApi(openAiKey));
}

Crie o Spring bean VectorStore.

Por fim, cole o código a seguir para criar um bean que retorne uma instância VectorStore. A instância VectorStore usa o MongoTemplate que corresponde à sua implantação e o OpenAiEmbeddingModel criado na etapa anterior.

@Bean
public VectorStore mongodbVectorStore(MongoTemplate mongoTemplate, EmbeddingModel embeddingModel) {
    return new MongoDBAtlasVectorStore(mongoTemplate, embeddingModel,
            MongoDBAtlasVectorStore.MongoDBVectorStoreConfig.builder().build(), initSchema);
}