refactor: make backend helpers pep8 compliant (#871)

code/backend/batch/AddURLEmbeddings.py

@@ -5,9 +5,9 @@
 import azure.functions as func
 import requests
 from bs4 import BeautifulSoup
-from utilities.helpers.EnvHelper import EnvHelper
-from utilities.helpers.AzureBlobStorageClient import AzureBlobStorageClient
-from utilities.helpers.embedders.EmbedderFactory import EmbedderFactory
+from utilities.helpers.env_helper import EnvHelper
+from utilities.helpers.azure_blob_storage_client import AzureBlobStorageClient
+from utilities.helpers.embedders.embedder_factory import EmbedderFactory
 
 bp_add_url_embeddings = func.Blueprint()
 logger = logging.getLogger(__name__)

code/backend/batch/BatchPushResults.py

@@ -4,9 +4,9 @@
 import azure.functions as func
 from urllib.parse import urlparse
 
-from utilities.helpers.AzureBlobStorageClient import AzureBlobStorageClient
-from utilities.helpers.EnvHelper import EnvHelper
-from utilities.helpers.embedders.EmbedderFactory import EmbedderFactory
+from utilities.helpers.azure_blob_storage_client import AzureBlobStorageClient
+from utilities.helpers.env_helper import EnvHelper
+from utilities.helpers.embedders.embedder_factory import EmbedderFactory
 
 bp_batch_push_results = func.Blueprint()
 logger = logging.getLogger(__name__)

code/backend/batch/BatchStartProcessing.py

@@ -3,7 +3,7 @@
 import json
 import azure.functions as func
 
-from utilities.helpers.AzureBlobStorageClient import (
+from utilities.helpers.azure_blob_storage_client import (
     AzureBlobStorageClient,
     create_queue_client,
 )

code/backend/batch/GetConversationResponse.py

@@ -3,9 +3,9 @@
 import logging
 import json
 
-from utilities.helpers.EnvHelper import EnvHelper
-from utilities.helpers.OrchestratorHelper import Orchestrator
-from utilities.helpers.config.ConfigHelper import ConfigHelper
+from utilities.helpers.env_helper import EnvHelper
+from utilities.helpers.orchestrator_helper import Orchestrator
+from utilities.helpers.config.config_helper import ConfigHelper
 
 
 bp_get_conversation_response = func.Blueprint()

code/backend/batch/utilities/common/SourceDocument.py

@@ -2,7 +2,7 @@
 import hashlib
 import json
 from urllib.parse import urlparse, quote
-from ..helpers.AzureBlobStorageClient import AzureBlobStorageClient
+from ..helpers.azure_blob_storage_client import AzureBlobStorageClient
 
 
 class SourceDocument:

code/backend/batch/utilities/document_loading/layout.py

@@ -1,6 +1,6 @@
 from typing import List
 from .document_loading_base import DocumentLoadingBase
-from ..helpers.AzureFormRecognizerHelper import AzureFormRecognizerClient
+from ..helpers.azure_form_recognizer_helper import AzureFormRecognizerClient
 from ..common.SourceDocument import SourceDocument
 
 

code/backend/batch/utilities/document_loading/read.py

@@ -1,6 +1,6 @@
 from typing import List
 from .document_loading_base import DocumentLoadingBase
-from ..helpers.AzureFormRecognizerHelper import AzureFormRecognizerClient
+from ..helpers.azure_form_recognizer_helper import AzureFormRecognizerClient
 from ..common.SourceDocument import SourceDocument
 
 

code/backend/batch/utilities/helpers/AzureBlobStorageClient.py → code/backend/batch/utilities/helpers/azure_blob_storage_client.py

@@ -10,7 +10,7 @@
 )
 from azure.storage.queue import QueueClient, BinaryBase64EncodePolicy
 import chardet
-from .EnvHelper import EnvHelper
+from .env_helper import EnvHelper
 from azure.identity import DefaultAzureCredential
 
 

code/backend/batch/utilities/helpers/AzureFormRecognizerHelper.py → code/backend/batch/utilities/helpers/azure_form_recognizer_helper.py

@@ -3,7 +3,7 @@
 from azure.identity import DefaultAzureCredential
 import html
 import traceback
-from .EnvHelper import EnvHelper
+from .env_helper import EnvHelper
 
 
 class AzureFormRecognizerClient:

code/backend/batch/utilities/helpers/AzureSearchHelper.py → code/backend/batch/utilities/helpers/azure_search_helper.py

@@ -24,8 +24,8 @@
     VectorSearchAlgorithmMetric,
     VectorSearchProfile,
 )
-from .LLMHelper import LLMHelper
-from .EnvHelper import EnvHelper
+from .llm_helper import LLMHelper
+from .env_helper import EnvHelper
 
 logger = logging.getLogger(__name__)
 

code/backend/batch/utilities/helpers/config/ConfigHelper.py → code/backend/batch/utilities/helpers/config/config_helper.py

@@ -3,13 +3,13 @@
 import logging
 from string import Template
 
-from ..AzureBlobStorageClient import AzureBlobStorageClient
+from ..azure_blob_storage_client import AzureBlobStorageClient
 from ...document_chunking.chunking_strategy import ChunkingStrategy, ChunkingSettings
 from ...document_loading import LoadingSettings, LoadingStrategy
-from .EmbeddingConfig import EmbeddingConfig
+from .embedding_config import EmbeddingConfig
 from ...orchestrator.OrchestrationStrategy import OrchestrationStrategy
 from ...orchestrator import OrchestrationSettings
-from ..EnvHelper import EnvHelper
+from ..env_helper import EnvHelper
 
 CONFIG_CONTAINER_NAME = "config"
 CONFIG_FILE_NAME = "active.json"

code/backend/batch/utilities/helpers/config/EmbeddingConfig.py → code/backend/batch/utilities/helpers/config/embedding_config.py

@@ -1,5 +1,5 @@
-from ..DocumentLoadingHelper import LoadingSettings
-from ..DocumentChunkingHelper import ChunkingSettings
+from ..document_loading_helper import LoadingSettings
+from ..document_chunking_helper import ChunkingSettings
 
 
 class EmbeddingConfig(ChunkingSettings, LoadingSettings):

code/backend/batch/utilities/helpers/embedders/EmbedderFactory.py → code/backend/batch/utilities/helpers/embedders/embedder_factory.py

@@ -1,7 +1,7 @@
-from ..EnvHelper import EnvHelper
-from ..AzureBlobStorageClient import AzureBlobStorageClient
-from .PushEmbedder import PushEmbedder
-from .IntegratedVectorizationEmbedder import (
+from ..env_helper import EnvHelper
+from ..azure_blob_storage_client import AzureBlobStorageClient
+from .push_embedder import PushEmbedder
+from .integrated_vectorization_embedder import (
     IntegratedVectorizationEmbedder,
 )
 

code/backend/batch/utilities/helpers/embedders/IntegratedVectorizationEmbedder.py → code/backend/batch/utilities/helpers/embedders/integrated_vectorization_embedder.py

@@ -1,11 +1,11 @@
-from .EmbedderBase import EmbedderBase
-from ..EnvHelper import EnvHelper
-from ..LLMHelper import LLMHelper
+from .embedder_base import EmbedderBase
+from ..env_helper import EnvHelper
+from ..llm_helper import LLMHelper
 from ...integrated_vectorization.AzureSearchIndex import AzureSearchIndex
 from ...integrated_vectorization.AzureSearchIndexer import AzureSearchIndexer
 from ...integrated_vectorization.AzureSearchDatasource import AzureSearchDatasource
 from ...integrated_vectorization.AzureSearchSkillset import AzureSearchSkillset
-from ..config.ConfigHelper import ConfigHelper
+from ..config.config_helper import ConfigHelper
 import logging
 
 logger = logging.getLogger(__name__)

code/backend/batch/utilities/helpers/embedders/PushEmbedder.py → code/backend/batch/utilities/helpers/embedders/push_embedder.py

@@ -2,17 +2,17 @@
 import logging
 from typing import List
 
-from ...helpers.LLMHelper import LLMHelper
+from ...helpers.llm_helper import LLMHelper
 
-from ..AzureBlobStorageClient import AzureBlobStorageClient
+from ..azure_blob_storage_client import AzureBlobStorageClient
 
-from ..config.EmbeddingConfig import EmbeddingConfig
-from ..config.ConfigHelper import ConfigHelper
+from ..config.embedding_config import EmbeddingConfig
+from ..config.config_helper import ConfigHelper
 
-from .EmbedderBase import EmbedderBase
-from ..AzureSearchHelper import AzureSearchHelper
-from ..DocumentLoadingHelper import DocumentLoading
-from ..DocumentChunkingHelper import DocumentChunking
+from .embedder_base import EmbedderBase
+from ..azure_search_helper import AzureSearchHelper
+from ..document_loading_helper import DocumentLoading
+from ..document_chunking_helper import DocumentChunking
 from ...common.SourceDocument import SourceDocument
 
 logger = logging.getLogger(__name__)

code/backend/batch/utilities/helpers/LLMHelper.py → code/backend/batch/utilities/helpers/llm_helper.py

@@ -6,7 +6,7 @@
 from semantic_kernel.connectors.ai.open_ai.prompt_execution_settings.azure_chat_prompt_execution_settings import (
     AzureChatPromptExecutionSettings,
 )
-from .EnvHelper import EnvHelper
+from .env_helper import EnvHelper
 
 
 class LLMHelper:

code/backend/batch/utilities/integrated_vectorization/AzureSearchDatasource.py

@@ -6,7 +6,7 @@
     NativeBlobSoftDeleteDeletionDetectionPolicy,
 )
 from azure.search.documents.indexes import SearchIndexerClient
-from ..helpers.EnvHelper import EnvHelper
+from ..helpers.env_helper import EnvHelper
 from azure.identity import DefaultAzureCredential
 from azure.core.credentials import AzureKeyCredential
 

code/backend/batch/utilities/integrated_vectorization/AzureSearchIndex.py

@@ -20,10 +20,10 @@
     SemanticField,
     SearchIndex,
 )
-from ..helpers.EnvHelper import EnvHelper
+from ..helpers.env_helper import EnvHelper
 from azure.identity import DefaultAzureCredential
 from azure.core.credentials import AzureKeyCredential
-from ..helpers.LLMHelper import LLMHelper
+from ..helpers.llm_helper import LLMHelper
 
 logger = logging.getLogger(__name__)
 

code/backend/batch/utilities/integrated_vectorization/AzureSearchIndexer.py

@@ -1,7 +1,7 @@
 import logging
 from azure.search.documents.indexes.models import SearchIndexer, FieldMapping
 from azure.search.documents.indexes import SearchIndexerClient
-from ..helpers.EnvHelper import EnvHelper
+from ..helpers.env_helper import EnvHelper
 from azure.identity import DefaultAzureCredential
 from azure.core.credentials import AzureKeyCredential
 

code/backend/batch/utilities/integrated_vectorization/AzureSearchSkillset.py

@@ -11,8 +11,8 @@
     SearchIndexerSkillset,
 )
 from azure.search.documents.indexes import SearchIndexerClient
-from ..helpers.config.ConfigHelper import IntegratedVectorizationConfig
-from ..helpers.EnvHelper import EnvHelper
+from ..helpers.config.config_helper import IntegratedVectorizationConfig
+from ..helpers.env_helper import EnvHelper
 from azure.identity import DefaultAzureCredential
 from azure.core.credentials import AzureKeyCredential
 

code/backend/batch/utilities/loggers/ConversationLogger.py

@@ -1,4 +1,4 @@
-from ..helpers.AzureSearchHelper import AzureSearchHelper
+from ..helpers.azure_search_helper import AzureSearchHelper
 from datetime import datetime
 import json
 

code/backend/batch/utilities/orchestrator/LangChainAgent.py

@@ -7,7 +7,7 @@
 from langchain_community.callbacks import get_openai_callback
 
 from .OrchestratorBase import OrchestratorBase
-from ..helpers.LLMHelper import LLMHelper
+from ..helpers.llm_helper import LLMHelper
 from ..tools.PostPromptTool import PostPromptTool
 from ..tools.QuestionAnswerTool import QuestionAnswerTool
 from ..tools.TextProcessingTool import TextProcessingTool

code/backend/batch/utilities/orchestrator/OpenAIFunctions.py

@@ -3,7 +3,7 @@
 import json
 
 from .OrchestratorBase import OrchestratorBase
-from ..helpers.LLMHelper import LLMHelper
+from ..helpers.llm_helper import LLMHelper
 from ..tools.PostPromptTool import PostPromptTool
 from ..tools.QuestionAnswerTool import QuestionAnswerTool
 from ..tools.TextProcessingTool import TextProcessingTool

code/backend/batch/utilities/orchestrator/OrchestratorBase.py

@@ -3,7 +3,7 @@
 from typing import List, Optional
 from abc import ABC, abstractmethod
 from ..loggers.ConversationLogger import ConversationLogger
-from ..helpers.config.ConfigHelper import ConfigHelper
+from ..helpers.config.config_helper import ConfigHelper
 from ..parser.OutputParserTool import OutputParserTool
 from ..tools.ContentSafetyChecker import ContentSafetyChecker
 

code/backend/batch/utilities/orchestrator/SemanticKernel.py

@@ -8,7 +8,7 @@
 from semantic_kernel.contents.chat_message_content import ChatMessageContent
 
 from ..common.Answer import Answer
-from ..helpers.LLMHelper import LLMHelper
+from ..helpers.llm_helper import LLMHelper
 from ..plugins.ChatPlugin import ChatPlugin
 from ..plugins.PostAnsweringPlugin import PostAnsweringPlugin
 from .OrchestratorBase import OrchestratorBase

code/backend/batch/utilities/search/AzureSearchHandler.py

@@ -1,7 +1,7 @@
 from typing import List
 from .SearchHandlerBase import SearchHandlerBase
-from ..helpers.LLMHelper import LLMHelper
-from ..helpers.AzureSearchHelper import AzureSearchHelper
+from ..helpers.llm_helper import LLMHelper
+from ..helpers.azure_search_helper import AzureSearchHelper
 from ..common.SourceDocument import SourceDocument
 import json
 from azure.search.documents.models import VectorizedQuery

code/backend/batch/utilities/search/Search.py

@@ -3,7 +3,7 @@
     IntegratedVectorizationSearchHandler,
 )
 from ..common.SourceDocument import SourceDocument
-from ..helpers.EnvHelper import EnvHelper
+from ..helpers.env_helper import EnvHelper
 
 
 class Search:

code/backend/batch/utilities/search/SearchHandlerBase.py

@@ -1,5 +1,5 @@
 from abc import ABC, abstractmethod
-from ..helpers.EnvHelper import EnvHelper
+from ..helpers.env_helper import EnvHelper
 
 from ..common.SourceDocument import SourceDocument
 

code/backend/batch/utilities/tools/ContentSafetyChecker.py

@@ -4,7 +4,7 @@
 from azure.identity import DefaultAzureCredential
 from azure.core.exceptions import HttpResponseError
 from azure.ai.contentsafety.models import AnalyzeTextOptions
-from ..helpers.EnvHelper import EnvHelper
+from ..helpers.env_helper import EnvHelper
 from .AnswerProcessingBase import AnswerProcessingBase
 from ..common.Answer import Answer
 

code/backend/batch/utilities/tools/PostPromptTool.py

@@ -2,8 +2,8 @@
 from langchain.prompts import PromptTemplate
 from langchain_community.callbacks import get_openai_callback
 from ..common.Answer import Answer
-from ..helpers.LLMHelper import LLMHelper
-from ..helpers.config.ConfigHelper import ConfigHelper
+from ..helpers.llm_helper import LLMHelper
+from ..helpers.config.config_helper import ConfigHelper
 
 
 class PostPromptTool:

code/backend/batch/utilities/tools/QuestionAnswerTool.py

@@ -18,9 +18,9 @@
 from langchain_community.callbacks import get_openai_callback
 from langchain_core.messages import SystemMessage
 
-from ..helpers.config.ConfigHelper import ConfigHelper
-from ..helpers.LLMHelper import LLMHelper
-from ..helpers.EnvHelper import EnvHelper
+from ..helpers.config.config_helper import ConfigHelper
+from ..helpers.llm_helper import LLMHelper
+from ..helpers.env_helper import EnvHelper
 from ..common.Answer import Answer
 
 logger = logging.getLogger(__name__)

code/backend/batch/utilities/tools/TextProcessingTool.py

@@ -1,5 +1,5 @@
 from typing import List
-from ..helpers.LLMHelper import LLMHelper
+from ..helpers.llm_helper import LLMHelper
 from .AnsweringToolBase import AnsweringToolBase
 from ..common.Answer import Answer
 

code/backend/pages/01_Ingest_Data.py

@@ -5,9 +5,9 @@
 import urllib.parse
 import sys
 import logging
-from batch.utilities.helpers.config.ConfigHelper import ConfigHelper
-from batch.utilities.helpers.EnvHelper import EnvHelper
-from batch.utilities.helpers.AzureBlobStorageClient import AzureBlobStorageClient
+from batch.utilities.helpers.config.config_helper import ConfigHelper
+from batch.utilities.helpers.env_helper import EnvHelper
+from batch.utilities.helpers.azure_blob_storage_client import AzureBlobStorageClient
 
 sys.path.append(path.join(path.dirname(__file__), ".."))
 env_helper: EnvHelper = EnvHelper()

code/backend/pages/02_Explore_Data.py

@@ -3,7 +3,7 @@
 import traceback
 import sys
 import pandas as pd
-from batch.utilities.helpers.EnvHelper import EnvHelper
+from batch.utilities.helpers.env_helper import EnvHelper
 from batch.utilities.search.Search import Search
 
 sys.path.append(os.path.join(os.path.dirname(__file__), ".."))

code/backend/pages/03_Delete_Data.py

@@ -3,7 +3,7 @@
 import traceback
 import sys
 import logging
-from batch.utilities.helpers.EnvHelper import EnvHelper
+from batch.utilities.helpers.env_helper import EnvHelper
 from batch.utilities.search.Search import Search
 
 sys.path.append(os.path.join(os.path.dirname(__file__), ".."))

code/backend/pages/04_Configuration.py

@@ -4,8 +4,8 @@
 import os
 import traceback
 import sys
-from batch.utilities.helpers.EnvHelper import EnvHelper
-from batch.utilities.helpers.config.ConfigHelper import ConfigHelper
+from batch.utilities.helpers.env_helper import EnvHelper
+from batch.utilities.helpers.config.config_helper import ConfigHelper
 from azure.core.exceptions import ResourceNotFoundError
 
 sys.path.append(os.path.join(os.path.dirname(__file__), ".."))

code/create_app.py

@@ -9,9 +9,9 @@
 from dotenv import load_dotenv
 import sys
 import functools
-from backend.batch.utilities.helpers.EnvHelper import EnvHelper
-from backend.batch.utilities.helpers.OrchestratorHelper import Orchestrator
-from backend.batch.utilities.helpers.config.ConfigHelper import ConfigHelper
+from backend.batch.utilities.helpers.env_helper import EnvHelper
+from backend.batch.utilities.helpers.orchestrator_helper import Orchestrator
+from backend.batch.utilities.helpers.config.config_helper import ConfigHelper
 from azure.mgmt.cognitiveservices import CognitiveServicesManagementClient
 from azure.identity import DefaultAzureCredential