Comece a usar a integração Semantic Kernel Python

Instalar e importar dependências.

1. Execute o seguinte comando no seu bloco de anotações para instalar o kernel semântica no seu ambiente.

   pip install --quiet --upgrade semantic-kernel openai motor

2. Execute o seguinte código para importar os pacotes necessários:

   import getpass, openai
   import semantic_kernel as sk
   from semantic_kernel.connectors.ai.open_ai import (OpenAIChatCompletion, OpenAITextEmbedding)
   from semantic_kernel.connectors.memory.mongodb_atlas import MongoDBAtlasMemoryStore
   from semantic_kernel.core_plugins.text_memory_plugin import TextMemoryPlugin
   from semantic_kernel.memory.semantic_text_memory import SemanticTextMemory
   from semantic_kernel.prompt_template.input_variable import InputVariable
   from semantic_kernel.prompt_template.prompt_template_config import PromptTemplateConfig
   from pymongo import MongoClient
   from pymongo.operations import SearchIndexModel

Definir variáveis ambientais.

Execute o código a seguir e forneça o seguinte quando solicitado:

• Sua chave de API da OpenAI.

• A connection string SRVdo seu Atlas cluster.

OPENAI_API_KEY = getpass.getpass("OpenAI API Key:")
ATLAS_CONNECTION_STRING = getpass.getpass("MongoDB Atlas SRV Connection String:")

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

Inicialize o kernel.

Execute o seguinte código para inicializar o kernel.

kernel = sk.Kernel()

Adicione os serviços de IA ao kernel.

Execute o código a seguir para configurar o modelo de incorporação OpenAI e o modelo de chat usados neste tutorial e adicionar esses serviços ao kernel. Este código especifica o seguinte:

• text-embedding-ada-002 da OpenAI como o modelo de incorporação usado para converter texto em incorporações vetoriais.

• gpt-3.5-turbo do OpenAI como o modelo de chat usado para gerar respostas.

chat_service = OpenAIChatCompletion(
   service_id="chat",
   ai_model_id="gpt-3.5-turbo",
   api_key=OPENAI_API_KEY
)
embedding_service = OpenAITextEmbedding(
   ai_model_id="text-embedding-ada-002",
   api_key=OPENAI_API_KEY
)
kernel.add_service(chat_service)
kernel.add_service(embedding_service)

Instanciar o Atlas como um armazenamento de memória.

Execute o seguinte código para instanciar o Atlas como um armazenamento de memória e adicioná-lo ao kernel. Este código estabelece uma conexão com seu cluster Atlas e especifica o seguinte:

• semantic_kernel_db como o banco de dados Atlas usado para armazenar os documentos.

• vector_index como o índice usado para executar queries semânticas Atlas Search .

Ele também importa um plugin chamado TextMemoryPlugin, que fornece um grupo de funções nativas para ajudá-lo a armazenar e recuperar texto na memória.

mongodb_atlas_memory_store = MongoDBAtlasMemoryStore(
   connection_string=ATLAS_CONNECTION_STRING,
   database_name="semantic_kernel_db",
   index_name="vector_index"
)
memory = SemanticTextMemory(
   storage=mongodb_atlas_memory_store,
   embeddings_generator=embedding_service
)
kernel.add_plugin(TextMemoryPlugin(memory), "TextMemoryPlugin")

Carregue dados de amostra em seu cluster Atlas.

Este código define e executa uma função para preencher a coleção semantic_kernel_db.test com alguns documentos de amostra. Esses documentos contêm dados personalizados aos quais o LLM originalmente não tinha acesso.

 async def populate_memory(kernel: sk.Kernel) -> None:
    await memory.save_information(
       collection="test", id="1", text="I am a developer"
    )
    await memory.save_information(
       collection="test", id="2", text="I started using MongoDB two years ago"
    )
    await memory.save_information(
       collection="test", id="3", text="I'm using MongoDB Vector Search with Semantic Kernel to implement RAG"
    )
    await memory.save_information(
       collection="test", id="4", text="I like coffee"
    )
 print("Populating memory...")
 await populate_memory(kernel)
 print(kernel)

Populating memory...
plugins=KernelPluginCollection(plugins={'TextMemoryPlugin': KernelPlugin(name='TextMemoryPlugin', description=None, functions={'recall': KernelFunctionFromMethod(metadata=KernelFunctionMetadata(name='recall', plugin_name='TextMemoryPlugin', description='Recall a fact from the long term memory', parameters=[KernelParameterMetadata(name='ask', description='The information to retrieve', default_value=None, type_='str', is_required=True, type_object=<class 'str'>), KernelParameterMetadata(name='collection', description='The collection to search for information.', default_value='generic', type_='str', is_required=False, type_object=<class 'str'>), KernelParameterMetadata(name='relevance', description='The relevance score, from 0.0 to 1.0; 1.0 means perfect match', default_value=0.75, type_='float', is_required=False, type_object=<class 'float'>), KernelParameterMetadata(name='limit', description='The maximum number of relevant memories to recall.', default_value=1, type_='int', is_required=False, type_object=<class 'int'>)], is_prompt=False, is_asynchronous=True, return_parameter=KernelParameterMetadata(name='return', description='', default_value=None, type_='str', is_required=True, type_object=None)), method=<bound method TextMemoryPlugin.recall of TextMemoryPlugin(memory=SemanticTextMemory())>, stream_method=None), 'save': KernelFunctionFromMethod(metadata=KernelFunctionMetadata(name='save', plugin_name='TextMemoryPlugin', description='Save information to semantic memory', parameters=[KernelParameterMetadata(name='text', description='The information to save.', default_value=None, type_='str', is_required=True, type_object=<class 'str'>), KernelParameterMetadata(name='key', description='The unique key to associate with the information.', default_value=None, type_='str', is_required=True, type_object=<class 'str'>), KernelParameterMetadata(name='collection', description='The collection to save the information.', default_value='generic', type_='str', is_required=False, type_object=<class 'str'>)], is_prompt=False, is_asynchronous=True, return_parameter=KernelParameterMetadata(name='return', description='', default_value=None, type_='', is_required=True, type_object=None)), method=<bound method TextMemoryPlugin.save of TextMemoryPlugin(memory=SemanticTextMemory())>, stream_method=None)})}) services={'chat': OpenAIChatCompletion(ai_model_id='gpt-3.5-turbo', service_id='chat', client=<openai.AsyncOpenAI object at 0x7999971c8fa0>, ai_model_type=<OpenAIModelTypes.CHAT: 'chat'>, prompt_tokens=0, completion_tokens=0, total_tokens=0), 'text-embedding-ada-002': OpenAITextEmbedding(ai_model_id='text-embedding-ada-002', service_id='text-embedding-ada-002', client=<openai.AsyncOpenAI object at 0x7999971c8fd0>, ai_model_type=<OpenAIModelTypes.EMBEDDING: 'embedding'>, prompt_tokens=32, completion_tokens=0, total_tokens=32)} ai_service_selector=<semantic_kernel.services.ai_service_selector.AIServiceSelector object at 0x7999971cad70> retry_mechanism=PassThroughWithoutRetry() function_invoking_handlers={} function_invoked_handlers={}

No Atlas, VáGo para a Clusters página do seu projeto.

1. Se ainda não tiver sido exibido, selecione a organização que contém seu projeto no menu Organizations na barra de navegação.

2. Se ainda não estiver exibido, selecione o projeto desejado no menu Projects na barra de navegação.

3. Se ainda não estiver exibido, clique em Clusters na barra lateral.

   A página Clusters é exibida.

Acesse a página do Atlas Search do seu cluster.

Você pode acessar a página do Atlas Search pela barra lateral, pelo Data Explorer ou pela página de detalhes do cluster.

Defina o índice do Atlas Vector Search.

1. Clique em Create Search Index.

2. Em Atlas Vector Search, selecione JSON Editor e clique em Next.

3. Na seção Database and Collection, localize o banco de dados semantic_kernel_db e selecione a coleção test.

4. No campo Index Name, digite vector_index.

5. Substitua a definição padrão pela seguinte definição de índice e clique em Next.

   Essa definição de índice especifica a indexação dos seguintes campos em um índice do tipo vectorSearch:

   • embedding campo como o tipo de vetor . O campo embedding contém as incorporações criadas utilizando o modelo de incorporação text-embedding-ada-002 do OpenAI. A definição de índice especifica 1536 dimensões vetoriais e mede a similaridade usando cosine.

   1
   {
   2
      "fields": [
   3
         {
   4
            "type": "vector",
   5
            "path": "embedding",
   6
            "numDimensions": 1536,
   7
            "similarity": "cosine"
   8
         }
   9
      ]
   10
   }

Revise a definição do índice e clique em Create Search Index.

Uma janela modal é exibida para que você saiba que seu índice está construindo.

Clique em Close para fechar a janela modal You're All Set! e aguarde a conclusão da criação do índice.

O índice deve levar cerca de um minuto para ser criado. Enquanto é compilado, a coluna Status mostra Initial Sync. Quando a compilação terminar, a coluna Status mostrará Active.