File size: 6,457 Bytes
dfc4131
 
 
8bc7dc5
 
dfc4131
 
 
 
8bc7dc5
dfc4131
8bc7dc5
 
 
 
dfc4131
8bc7dc5
 
 
 
 
 
 
dfc4131
 
 
 
8bc7dc5
 
 
 
 
 
dfc4131
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
8bc7dc5
dfc4131
 
 
 
 
 
 
 
 
 
 
8bc7dc5
 
 
 
 
 
 
dfc4131
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
8bc7dc5
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
dfc4131
8bc7dc5
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
import re
from typing import List

from langchain.prompts import PromptTemplate
from langchain.chains import LLMChain
from langchain.llms import OpenAI

from load_model import call_palm
from calling_apis import google_api_key, openai_api_key

def keywords_generator(topic : str,num_keywords=10, language='En', creativity='Original', model_name='Google Palm 2') -> str:
    
    '''
    Description: 
    
        Generates a list of short-tail keywords for a given topic using a large language model (LLM).
    '''
    
    '''
    Parameters:
    
        topic (str): Required Parameter -> The topic for which to generate keywords.
        num_keywords (int): Optional Parameter -> The number of keywords to generate. Default Value is 10
        language (str): Opitonal Parameter -> The language of the model.
        creativity (str): Optional Parameter -> Controling the randomness of the model. Default value is Original
        model_name (str): Optional Parameter -> select the LLM model. Default Value is Google Palm 2
        
    '''
    
    '''
    Returns:
        Keywords (str): A Text of list of keywords numbered with roman numerals for the given topic -> str datatype.
    '''
    temp = 0

    if creativity == 'Original':
        temp = 0
    elif creativity == 'Balanced':
        temp = 0.25
    elif creativity == 'Creative':
        temp = 0.5
    elif creativity == 'Spirited':
        temp = 0.75
    elif creativity == 'Visionary':
        temp = 1


    if model_name == 'Google Palm 2':
        llm = call_palm(google_api_key, temperature=temp)

    elif model_name == 'GPT-3.5':
        llm = OpenAI(model_name='gpt-3.5-turbo', openai_api_key=openai_api_key, temperature=temp)

    elif model_name == 'GPT-4':
        llm = OpenAI(model_name='gpt-4', openai_api_key=openai_api_key, temperature=temp)


    if language == 'En':

        keywords_prompt = f"Generate {num_keywords} SEO keywords related to '{topic}'."

        keywords_promptTemp = PromptTemplate(
        input_variables=["text_input"],
        template="You are a professional content creator and SEO Keywords Generator:\n\n{text_input}\n\nKeywords (number them with roman numerals):")

    elif language == 'Ar':

        keywords_prompt = f"قم بإنشاء {num_keywords} كلمة أساسية SEO متعلقة بـ '{topic}'."

        keywords_promptTemp = PromptTemplate(
            input_variables=["text_input"],
            template="أنت منشئ محتوى محترف ومولد كلمات أساسية SEO:\n\n{text_input}\n\nالكلمات الأساسية (قم بترقيمها بالأرقام الرومانية):")

    keywords_extraction_chain = LLMChain(llm=llm, prompt=keywords_promptTemp)
    keywords = keywords_extraction_chain.run(keywords_prompt)

    return keywords


def keywords_generator_long_tail(topic : str, num_keywords=10, language='En', creativity='Original', model_name='Google Palm 2') -> str:
    
    '''
    Description: 
    
        Generates a list of long-tail keywords for a given topic using a large language model (LLM).
    '''
    
    '''
    Parameters:
    
        topic (str): Required Parameter -> The topic for which to generate keywords.
        num_keywords (int): Optional Parameter -> The number of keywords to generate. Default Value is 10
        language (str): Opitonal Parameter -> The language of the model.
        creativity (str): Optional Parameter -> Controling the randomness of the model. Default value is Original
        model_name (str): Optional Parameter -> select the LLM model. Default Value is Google Palm 2
        
    '''
    
    '''
    Returns:
        Keywords (str): A Text of list of keywords numbered with roman numerals for the given topic -> str datatype.
    '''
    
    temp = 0

    if creativity == 'Original':
        temp = 0
    elif creativity == 'Balanced':
        temp = 0.25
    elif creativity == 'Creative':
        temp = 0.5
    elif creativity == 'Spirited':
        temp = 0.75
    elif creativity == 'Visionary':
        temp = 1


    if model_name == 'Google Palm 2':
        llm = call_palm(google_api_key, temperature=temp)

    elif model_name == 'GPT-3.5':
        llm = OpenAI(model_name='gpt-3.5-turbo', openai_api_key=openai_api_key, temperature=temp)

    elif model_name == 'GPT-4':
        llm = OpenAI(model_name='gpt-4', openai_api_key=openai_api_key, temperature=temp)

    if language == 'En':
        
        keywords_prompt = f"Generate {num_keywords} long-tail SEO keywords related to '{topic}'."

        keywords_promptTemp = PromptTemplate(
        input_variables=["text_input"],
        template="You are a professional content creator and SEO Keywords Generator:\n\n{text_input}\n\nKeywords (number them with roman numerals):")
    
    elif language == 'Ar':
        
        keywords_prompt = f"قم بإنشاء {num_keywords} كلمة أساسية SEO طويلة الذيل متعلقة بـ '{topic}'."

        keywords_promptTemp = PromptTemplate(
        input_variables=["text_input"],
        template="أنت منشئ محتوى محترف ومولد كلمات أساسية SEO:\n\n{text_input}\n\nالكلمات الأساسية (قم بترقيمها بالأرقام الرومانية):")

    keywords_extraction_chain = LLMChain(llm=llm, prompt=keywords_promptTemp)
    keywords = keywords_extraction_chain.run(keywords_prompt)

    return keywords

def filter_keywords(keywords : str) -> List[str]:
    '''
    Description: 
    
        Filters keywords to extract the keywords that numbered with roman numerals using regx
    '''
    
    '''
    Parameters:

        keywords (str): Required Parameter -> A Text of keywords Numbered with roman numerals to filter.
    '''
    
    '''
    Returns:
    
        filtered_keywords(list): A filtered list of keywords.
    '''
    
    pattern = r'\b[IVXLCDM]+\.\s*(.*?)(?:\n|$)'
    filtered_keywords = re.findall(pattern, keywords)
    
    return filtered_keywords


def process_keywords(list_keywords : List[str]) -> str:
    
    '''
    Description: 
        Formats a list of keywords into a comma-separated string.
    '''
    
    '''
    Parameters:

        list_keywords (list):Required Parameters -> A list of keywords to format.    
    '''
    
    '''
    Returns:
    
        formatted_keywords (str): A comma-separated string of keywords.
    '''
    formatted_keywords = ", ".join(list_keywords)
    return formatted_keywords