Machine Learning 기반의 코드 생성 툴을 이용하면, 기업의 생산성 향상에 도움이 됩니다. 하지만, 기업의 자산인 소스 코드를 이러한 툴과 함께 활용하기 위하여 Fine Tunining을 하려면 비용도 고려해야 하고, 소스 코드들이 계속 업데이트 될 경우에 Fine Tuning 주기에 대한 부담이 있을 수 있습니다. 반면에 RAG (Retrieval Augmented Generation)은 Amazon OpenSearch와 같은 검색 엔진을 활용하여 Fine Tuning과 유사한 기능을 제공할 수 있고, 일반적으로 업데이트나 비용면에서 Fine tuning 보다 유용하게 사용할 수 있습니다.
본 게시글은 LLM(Large Language Models과 OpenSearch로 RAG를 구성한 후에 한국어로 된 질문(Query)을 이용하여 코드를 생성하는 방법을 설명합니다. 한국어로 코드를 검색할 수 있도록 LLM을 이용하여 함수 단위의 요약을 수행하고, 한글 요약과 원본 코드를 RAG에 등록하면 사용자의 질문에 맞는 코드를 생성할 수 있습니다. 소스 코드를 요약할 때에는 Multi-Region LLM과 Multi Thread를 활용하여 지연속도를 개선합니다.
전체적인 Architecture는 아래와 같습니다. 사용자는 WebSocket 방식의 API Gateway를 이용하여 메시지를 주고 받습니다. 서버리스(Serverless)인 AWS Lambda를 이용하여 RAG의 Knowledge Store로 부터 관련된 코드를 검색하고, Prompt를 이용해 질문(Query)에 맞는 코드를 생성합니다. Amazon OpenSearch는 빠르고 성능이 좋은 검색 엔진으로서, 관련된 코드를 빠르고 효과적으로 검색할 수 있습니다. 여기서는 검색의 정확도를 높이기 위해 OpenSearch의 Vector 검색과 함께 한국어를 지원하는 Nori 분석기를 이용하여 Lexical 검색을 수행합니다. 검색된 결과들은 관련도에 따라 정렬할 필요가 있으므로 Faiss의 similarity search를 이용하여 Priority Search를 수행합니다. 여기서 사용하는 Faiss는 Lambda의 process와 memory를 공유하므로 별도로 비용이 발생하지 않으며 정량적인 관련도를 얻을 수 있습니다. 잘문과 관련된 코드를 한국어로 검색하기 위하여 RAG에 저장되는 소스 코드들은 함수(Function) 단위로 Chunking 된 후에 LLM을 이용하여 요약(Summarization)됩니다. 하나의 소스 파일은 여러 개의 함수들로 구성될 수 있으므로 동시에 다수의 함수를 요약하기 위하여 Multi Thread와 Multi-Region LLM을 이용하여 요약에 필요한 지연 속도를 개선합니다. 또한, 인프라를 배포하고 관리하는 것은 AWS CDK을 이용합니다.
전체적인 동작을 위한 Sequence Diagram은 아래와 같습니다.
단계 1: 사용자가 파일을 업로드하려고 하면 Presigned URL을 이용하여 Amazon S3에 업로드합니다.
단계 2: 파일 업로드 후에 type이 Document인 메시지를 Amazon API Gateway를 경유하여 Lambda로 보냅니다. Lambda는 S3에서 소스 파일을 로드(Load)한 후에, 함수 단위로 Chunking을 수행합니다.
단계 3: 각 함수(Function)의 기능을 한국어로 설명할 수 있도록 LLM을 이용하여 코드를 요약(Summarization)합니다. 이때, 요약하는 속도를 향상시키기 위하여 아래처럼 AWS 4개 리전(Region)의 LLM을 활용하여 요약 작업을 수행합니다.
단계 4: 각 함수에 대한 요약과 원본 코드, 파일 경로를 메타 데이터로 가지는 Document를 만들어서 OpenSearch에 저장하고, 채팅창에는 소스 코드에 대한 요약 결과를 보여줍니다.
단계 5: 사용자가 코드를 생성하기 위하여 질문(Query)을 입력하면, OpenSearch로 Vector와 Lexical 검색을 수행하여 관련된 코드들(Relevant Codes)을 수집합니다.
단계 6: 관련된 코드들은 Priority Search를 이용하여 관련도가 높은 순서로 정렬한 다음에 일정 수준의 관련도를 가지는 관련 코드로 LLM에서 활용할 수 있는 Context를 만듭니다.
단계 7: 관련된 코드들의 조합인 Context와 사용자의 질문(Query)을 LLM에 전달하여 코드를 생성합니다.
본 게시글에서는 함수 단위로 코드를 요약하여 RAG에서 활용하고자 합니다. 하나의 소스 파일은 여러 개의 함수(Function)을 가질 수 있으므로, S3로 부터 소스 파일을 읽어 들인 후에 함수 단위로 분리하기 위하여 Chunking을 수행합니다. 여기서는 chunk_size를 50으로 하고, seperator로 "\ndef "로 설정하였으므로, 50자 이상의 함수를 하나의 Chunk로 분리 할 수 있습니다.
def load_code(file_type, s3_file_name):
s3r = boto3.resource("s3")
doc = s3r.Object(s3_bucket, s3_prefix+'/'+s3_file_name)
if file_type == 'py':
contents = doc.get()['Body'].read().decode('utf-8')
text_splitter = RecursiveCharacterTextSplitter(
chunk_size=50,
chunk_overlap=0,
separators=["\ndef "],
length_function = len,
)
texts = text_splitter.split_text(contents)
return texts함수별로 Chunk 되었으므로 LLM을 이용하여 요약을 수행합니다. 이때 수행 속도를 위해 Multi Thread와 Multi-LLM을 활용합니다. 여러 리전의 LLM을 활용하기 위해 LLM profile으로 여러 리전에 대한 LLM 모델을 설정합니다. 아래와 같이 Chunk된 문서는 파일 이름(name), 다운로드 경로(uri), 원본 코드(code)와 각 함수의 이름(function_name)을 metadata로 가지고 있습니다.
def summarize_relevant_codes_using_parallel_processing(codes, object, file_type):
selected_LLM = 0
relevant_codes = []
processes = []
parent_connections = []
for code in codes:
parent_conn, child_conn = Pipe()
parent_connections.append(parent_conn)
chat = get_chat(profile_of_LLMs, selected_LLM)
bedrock_region = profile_of_LLMs[selected_LLM]['bedrock_region']
process = Process(target=summarize_process_for_relevent_code, args=(child_conn, chat, code, object, file_type, bedrock_region))
processes.append(process)
selected_LLM = selected_LLM + 1
if selected_LLM == len(profile_of_LLMs):
selected_LLM = 0
for process in processes:
process.start()
for parent_conn in parent_connections:
doc = parent_conn.recv()
if doc:
relevant_codes.append(doc)
for process in processes:
process.join()
return relevant_codes
def summarize_process_for_relevent_code(conn, chat, code, object, file_type, bedrock_region):
try:
if code.find('\ndef ') != -1:
start = code.find('\ndef ')
end = code.find(':')
elif code.find('\nfunction ') != -1:
start = code.find('\nfunction ')
end = code.find('(')
elif code.find('\nexports.') != -1:
start = code.find('\nexports.')
end = code.find(' =')
else:
start = -1
end = -1
print('code: ', code)
print(f'start: {start}, end: {end}')
doc = ""
if start != -1:
function_name = code[start+1:end]
summary = summary_of_code(chat, code, file_type)
print(f"summary ({bedrock_region}): {summary}")
if summary[:len(function_name)]==function_name:
summary = summary[summary.find('\n')+1:len(summary)]
doc = Document(
page_content=summary,
metadata={
'name': object,
'uri': path+doc_prefix+parse.quote(object),
'code': code,
'function_name': function_name
}
)
except Exception:
err_msg = traceback.format_exc()
print('error message: ', err_msg)
conn.send(doc)
conn.close()코드를 요약하기 위해 Prompt를 활용합니다.
def summary_of_code(chat, code, mode):
if mode == 'py':
system = (
"다음의 <article> tag에는 python code가 있습니다. code의 전반적인 목적에 대해 설명하고, 각 함수의 기능과 역할을 자세하게 한국어 500자 이내로 설명하세요."
)
elif mode == 'js':
system = (
"다음의 <article> tag에는 node.js code가 있습니다. code의 전반적인 목적에 대해 설명하고, 각 함수의 기능과 역할을 자세하게 한국어 500자 이내로 설명하세요."
)
else:
system = (
"다음의 <article> tag에는 code가 있습니다. code의 전반적인 목적에 대해 설명하고, 각 함수의 기능과 역할을 자세하게 한국어 500자 이내로 설명하세요."
)
human = "<article>{code}</article>"
prompt = ChatPromptTemplate.from_messages([("system", system), ("human", human)])
print('prompt: ', prompt)
chain = prompt | chat
try:
result = chain.invoke(
{
"code": code
}
)
summary = result.content
print('result of code summarization: ', summary)
except Exception:
err_msg = traceback.format_exc()
print('error message: ', err_msg)
raise Exception ("Not able to request to LLM")
return summaryRAG의 Knowledge Store로 OpenSearch를 이용합니다. 2023년 10월에 한국어, 일본어, 중국어에 대한 새로운 언어 분석기 플러그인이 OpenSearch에 추가 되었으므로, 본 게시글에서는 Nori 분석기를 이용하여 Lexical 검색을 이용합니다. S3에 저장된 코드를 삭제하면 OpenSearch의 Document도 같이 삭제합니다.
if enableNoriPlugin == 'true':
create_nori_index(category='py')
create_nori_index(category='js')
def create_nori_index(category):
index_body = {
'settings': {
'analysis': {
'analyzer': {
'my_analyzer': {
'char_filter': ['html_strip'],
'tokenizer': 'nori',
'filter': ['nori_number','lowercase','trim','my_nori_part_of_speech'],
'type': 'custom'
}
},
'tokenizer': {
'nori': {
'decompound_mode': 'mixed',
'discard_punctuation': 'true',
'type': 'nori_tokenizer'
}
},
"filter": {
"my_nori_part_of_speech": {
"type": "nori_part_of_speech",
"stoptags": [
"E", "IC", "J", "MAG", "MAJ",
"MM", "SP", "SSC", "SSO", "SC",
"SE", "XPN", "XSA", "XSN", "XSV",
"UNA", "NA", "VSV"
]
}
}
},
'index': {
'knn': True,
'knn.space_type': 'cosinesimil' # Example space type
}
},
'mappings': {
'properties': {
'metadata': {
'properties': {
'source' : {'type': 'keyword'},
'last_updated': {'type': 'date'},
'project': {'type': 'keyword'},
'seq_num': {'type': 'long'},
'title': {'type': 'text'}, # For full-text search
'url': {'type': 'text'}, # For full-text search
}
},
'text': {
'analyzer': 'my_analyzer',
'search_analyzer': 'my_analyzer',
'type': 'text'
},
'vector_field': {
'type': 'knn_vector',
'dimension': 1536 # Replace with your vector dimension
}
}
}
}
index_name = 'idx-rag-'+category
if(is_not_exist(index_name)):
try: # create index
response = os_client.indices.create(
index_name,
body=index_body
)
print('index was created with nori plugin:', response)
except Exception:
err_msg = traceback.format_exc()
print('error message: ', err_msg)
def store_document_for_opensearch(bedrock_embedding, docs, key, category):
index_name = 'idx-rag-'+category
vectorstore = OpenSearchVectorSearch(
index_name=index_name,
is_aoss = False,
#engine="faiss", # default: nmslib
embedding_function = bedrock_embedding,
opensearch_url = opensearch_url,
http_auth=(opensearch_account, opensearch_passwd),
)
objectName = (key[key.find(s3_prefix)+len(s3_prefix)+1:len(key)])
print('objectName: ', objectName)
metadata_key = meta_prefix+objectName+'.metadata.json'
print('meta file name: ', metadata_key)
delete_document_if_exist(vectorstore, metadata_key)
try:
response = vectorstore.add_documents(docs, bulk_size = 2000)
print('response of adding documents: ', response)
except Exception:
err_msg = traceback.format_exc()
print('error message: ', err_msg)사용자가 질문(Query)를 입력하면, RAG의 Knowledge Store로 부터 관련된 코드를 조회합니다. 이때, OpenSearch로 vector와 lexical search를 하여 얻어진 결과들을 병합한 후에, priority search를 이용하여, 관련도에 따라 정렬합니다. 본 게시글에서는 관련된 코드를 검색할 때 Zero shot을 이용하므로, 구현하려는 코드에 대한 명확한 지시를 내려야 정확한 결과를 얻을 수 있습니다. 만약, 대화이력(message history)까지 고려하여 코드를 생성하고자 한다면, 한영 동시 검색 및 인터넷 검색을 활용하여 RAG를 편리하게 활용하기와 같이 Prompt를 이용하여 새로운 질문(Revised Question)을 생성할 수 있습니다.
def retrieve_from_vectorstore(query, top_k, rag_type):
relevant_codes = []
# Vector Search
if rag_type == 'opensearch':
relevant_documents = vectorstore_opensearch.similarity_search_with_score(
query = query,
k = top_k,
)
for i, document in enumerate(relevant_documents):
name = document[0].metadata['name']
uri = document[0].metadata['uri']
excerpt = document[0].page_content
confidence = str(document[1])
assessed_score = str(document[1])
code = document[0].metadata['code']
function_name = document[0].metadata['function_name']
doc_info = {
"rag_type": 'opensearch-vector',
"confidence": confidence,
"metadata": {
"source": uri,
"title": name,
"excerpt": excerpt,
"code": code,
"function_name": function_name
},
"assessed_score": assessed_score,
}
relevant_codes.append(doc_info)
# Lexical search (keyword)
min_match = 0
if enableNoriPlugin == 'true':
query = {
"query": {
"bool": {
"must": [
{
"match": {
"text": {
"query": query,
"minimum_should_match": f'{min_match}%',
"operator": "or",
}
}
},
],
"filter": [
]
}
}
}
response = os_client.search(
body=query,
index="idx-*", # all
)
for i, document in enumerate(response['hits']['hits']):
if i>top_k:
break
excerpt = document['_source']['text']
name = document['_source']['metadata']['name']
uri = document['_source']['metadata']['uri']
confidence = str(document['_score'])
assessed_score = ""
code = document['_source']['metadata']['code']
function_name = document['_source']['metadata']['function_name']
doc_info = {
"rag_type": 'opensearch-keyward',
"confidence": confidence,
"metadata": {
"source": uri,
"title": name,
"excerpt": excerpt,
"code": code,
"function_name": function_name
},
"assessed_score": assessed_score,
}
if checkDupulication(relevant_codes, doc_info) == False:
relevant_codes.append(doc_info)
return relevant_codes관련된 코드들를 모아서 Context를 만든 후에, 아래와 같이 prompt를 이용하여 질문에 맞는 코드를 생성합니다.
selected_relevant_codes = []
if len(relevant_codes) >= 1:
selected_relevant_codes = priority_search(text, relevant_codes, bedrock_embeddings)
relevant_code = ""
for document in selected_relevant_codes:
if document['metadata']['code']:
code = document['metadata']['code']
relevant_code = relevant_code + code + "\n\n"
msg = generate_code(connectionId, requestId, chat, text, relevant_code, code_type)
def generate_code(connectionId, requestId, chat, text, context, mode):
if mode == 'py':
system = (
"""다음의 <context> tag안에는 질문과 관련된 python code가 있습니다. 주어진 예제를 참조하여 질문과 관련된 python 코드를 생성합니다. Assistant의 이름은 서연입니다.
<context>
{context}
</context>"""
)
elif mode == 'js':
system = (
"""다음의 <context> tag안에는 질문과 관련된 node.js code가 있습니다. 주어진 예제를 참조하여 질문과 관련된 node.js 코드를 생성합니다. Assistant의 이름은 서연입니다.
<context>
{context}
</context>"""
)
human = "<context>{text}</context>"
prompt = ChatPromptTemplate.from_messages([("system", system), ("human", human)])
print('prompt: ', prompt)
chain = prompt | chat
try:
isTyping(connectionId, requestId)
stream = chain.invoke(
{
"context": context,
"text": text
}
)
geenerated_code = readStreamMsg(connectionId, requestId, stream.content)
geenerated_code = stream.content
except Exception:
err_msg = traceback.format_exc()
print('error message: ', err_msg)
raise Exception ("Not able to request to LLM")
return geenerated_codeFaiss의 Similarity Search를 이용하여 관련도 기준으로 정렬합니다. 여기서는 300이상의 관련도(assessed_score)를 가지는 코드들을 RAG에서 활용하고 있습니다. 이 값은 RAG에 저장되는 소스 코드의 형태에 따라 적절하게 조정하여 사용합니다.
def priority_search(query, relevant_codes, bedrock_embeddings):
excerpts = []
for i, doc in enumerate(relevant_codes):
content = doc['metadata']['excerpt']
excerpts.append(
Document(
page_content=content,
metadata={
'name': doc['metadata']['title'],
'order':i,
}
)
)
embeddings = bedrock_embeddings
vectorstore_confidence = FAISS.from_documents(
excerpts, # documents
embeddings # embeddings
)
rel_documents = vectorstore_confidence.similarity_search_with_score(
query=query,
k=top_k
)
docs = []
for i, document in enumerate(rel_documents):
order = document[0].metadata['order']
name = document[0].metadata['name']
assessed_score = document[1]
relevant_codes[order]['assessed_score'] = int(assessed_score)
if assessed_score < 300:
docs.append(relevant_codes[order])
return docs생성된 코드가 참고한 코드 설명 및 관련 코드를 함께 보여주면, 생성된 코드를 활용할 때 유용하게 사용할 수 있습니다. 따라서 아래와 같이 원본 코드에 대한 링크, 관련도, 코드 설명, 관련 코드를 레퍼런스로 보여줍니다.
def get_reference(docs):
reference = "\n\nFrom\n"
for i, doc in enumerate(docs):
excerpt = doc['metadata']['excerpt'].replace('"','')
code = doc['metadata']['code'].replace('"','')
excerpt = excerpt.replace('\n','\\n')
code = code.replace('\n','\\n')
print('reference_doc: ', json.dumps(doc))
if doc['rag_type'][:10] == 'opensearch':
print(f'## Document(get_reference) {i+1}: {doc}')
page = ""
if "document_attributes" in doc['metadata']:
if "_excerpt_page_number" in doc['metadata']['document_attributes']:
page = doc['metadata']['document_attributes']['_excerpt_page_number']
uri = doc['metadata']['source']
name = doc['metadata']['title']
name = name[name.rfind('/')+1:len(name)]
if page:
reference = reference + f"{i+1}. {page}page in <a href={uri} target=_blank>{name}</a>, {doc['rag_type']} ({doc['assessed_score']}), <a href=\"#\" onClick=\"alert(`{excerpt}`)\">코드설명</a>, <a href=\"#\" onClick=\"alert(`{code}`)\">관련코드</a>\n"
else:
reference = reference + f"{i+1}. <a href={uri} target=_blank>{name}</a>, {doc['rag_type']} ({doc['assessed_score']}), <a href=\"#\" onClick=\"alert(`{excerpt}`)\">코드설명</a>, <a href=\"#\" onClick=\"alert(`{code}`)\">관련코드</a>\n"
return reference이 솔루션을 사용하기 위해서는 사전에 아래와 같은 준비가 되어야 합니다.
- AWS Account 생성에 따라 계정을 준비합니다.
본 실습에서는 Seoul 리전 (ap-northeast-2)을 사용합니다. 인프라 설치에 따라 CDK로 인프라 설치를 진행합니다. CDK 구현 코드에서는 Typescript로 인프라를 정의하는 방법에 대해 상세히 설명하고 있습니다.
lambda_function.py을 다운로드 후에 채팅창 아래의 파일 아이콘을 선택하여 업로드합니다. lambda_function.py가 가지고 있는 함수들에 대한 요약을 보여줍니다.
채팅창에 아래와 같이 "OpenSearch에서 Knowledge Store 생성하기"라고 입력하고 결과를 확인합니다. 아래와 같이 질문과 관련된 코드를 생성할 수 있으며, 생성된 코드에 대한 설명과 함께 레퍼런스에 대한 정보를 함께 제공하여 사용자가 생성된 코드를 이해하는데 도움을 줍니다.
더이상 인프라를 사용하지 않는 경우에 아래처럼 모든 리소스를 삭제할 수 있습니다.
-
API Gateway Console로 접속하여 "api-chatbot-for-rag-code-generation", "api-rag-code-generation"을 삭제합니다.
-
Cloud9 Console에 접속하여 아래의 명령어로 전체 삭제를 합니다.
cd ~/environment/rag-code-generation/cdk-rag-code-generation/ && cdk destroy --all
RAG를 이용하여 코드를 생성하면 Fine Tuning 대비 비용뿐 아니라 업데이트된 소스 코드를 참조하여 새로운 코드를 생성할 수 있습니다. 여기에서는 소스 코드를 함수(Function) 단위로 요약하고, OpenSearch에 문서를 등록하여 관련된 코드를 검색할 수 있었습니다. 검색의 정확도를 높이기 위하여 Vector 검색뿐 아니라 Lexical 검색을 이용하였고, Faiss를 이용하여 관련도 기준으로 정렬하여 RAG의 정확도를 향상 시켰습니다. 관련된 코드들로 Context를 생성하여 Prompt를 이용하여 질문(Query)에 맞는 코드를 생성할 수 있었습니다. RAG를 활용하면 기업의 자신인 소스 파일을 이용하여 손쉽게 코드를 생성할 수 있으므로 기업의 활동에 필요한 코드를 쉽고 편리하게 검색하여 활용할 수 있습니다.
아래의 링크에서 실습 소스 파일 및 기계 학습(ML)과 관련된 자료를 확인하실 수 있습니다.
- Amazon SageMaker JumpStart를 이용하여 Falcon Foundation Model기반의 Chatbot 만들기
- Amazon SageMaker JumpStart와 Vector Store를 이용하여 Llama 2로 Chatbot 만들기
- VARCO LLM과 Amazon OpenSearch를 이용하여 한국어 Chatbot 만들기
- Amazon Bedrock을 이용하여 Stream 방식의 한국어 Chatbot 구현하기
- Multi-RAG와 Multi-Region LLM로 한국어 Chatbot 만들기
- 한영 동시 검색 및 인터넷 검색을 활용하여 RAG를 편리하게 활용하기
- Amazon Bedrock의 Claude와 Amazon Kendra로 향상된 RAG 사용하기