Skip to content

Command

Command for asking questions about the codebase using RAG.

logger module-attribute

logger = getLogger(__name__)

AskResult

Bases: TypedDict

Structured result for the ask command.

Source code in src/codemap/llm/rag/ask/command.py
22
23
24
25
26
class AskResult(TypedDict):
	"""Structured result for the ask command."""

	answer: str | None
	context: list[dict[str, Any]]

answer instance-attribute

answer: str | None

context instance-attribute

context: list[dict[str, Any]]

AskCommand

Handles the logic for the codemap ask command.

Interacts with the ProcessingPipeline, DatabaseClient, and an LLM to answer questions about the codebase using RAG. Maintains conversation history for interactive sessions.

Source code in src/codemap/llm/rag/ask/command.py
 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
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
class AskCommand:
	"""
	Handles the logic for the `codemap ask` command.

	Interacts with the ProcessingPipeline, DatabaseClient, and an LLM to
	answer questions about the codebase using RAG. Maintains conversation
	history for interactive sessions.

	"""

	def __init__(self) -> None:
		"""Initializes the AskCommand, setting up clients and pipeline."""
		self.session_id = str(uuid.uuid4())  # Unique session ID for DB logging
		self.config_loader = ConfigLoader.get_instance()
		self.ui = RagUI()
		self._db_client = None
		self._llm_client = None
		self._pipeline = None

	@property
	def db_client(self) -> DatabaseClient:
		"""Lazily initialize and return a DatabaseClient instance."""
		if self._db_client is None:
			self._db_client = DatabaseClient()
		return self._db_client

	@property
	def llm_client(self) -> LLMClient:
		"""Lazily initialize and return an LLMClient instance."""
		if self._llm_client is None:
			self._llm_client = LLMClient(config_loader=self.config_loader)
		return self._llm_client

	@property
	def pipeline(self) -> ProcessingPipeline | None:
		"""Lazily initialize and return a ProcessingPipeline instance, or None if initialization fails."""
		if self._pipeline is None:
			try:
				with progress_indicator(message="Initializing processing pipeline...", style="spinner", transient=True):
					self._pipeline = ProcessingPipeline(config_loader=self.config_loader)
				logger.info("ProcessingPipeline initialization complete.")
			except Exception:
				logger.exception("Failed to initialize ProcessingPipeline")

		return self._pipeline

	@property
	def max_context_length(self) -> int:
		"""Return the maximum context length for RAG, using config or default."""
		cached = getattr(self, "_max_context_length", None)
		if cached is not None:
			return cached
		try:
			rag_config = self.config_loader.get.rag
			value = getattr(rag_config, "max_context_length", None)
			if value is not None:
				self._max_context_length = value
				return value
		except (AttributeError, TypeError) as e:
			logger.debug("Error reading max_context_length from config: %s", e)
		return self._max_context_length

	@property
	def max_context_results(self) -> int:
		"""Return the maximum number of context results for RAG, using config or default."""
		cached = getattr(self, "_max_context_results", None)
		if cached is not None:
			return cached
		try:
			rag_config = self.config_loader.get.rag
			value = getattr(rag_config, "max_context_results", None)
			if value is not None:
				self._max_context_results = value
				return value
		except (AttributeError, TypeError) as e:
			logger.debug("Error reading max_context_results from config: %s", e)
		return self._max_context_results

	async def initialize(self) -> None:
		"""Perform asynchronous initialization for the command, especially the pipeline."""
		if self.pipeline and not self.pipeline.is_async_initialized:
			try:
				# Show a spinner while initializing the pipeline asynchronously
				with progress_indicator(
					message="Initializing async components (pipeline)...", style="spinner", transient=True
				):
					await self.pipeline.async_init(sync_on_init=True)
				logger.info("ProcessingPipeline async initialization complete.")
			except Exception:
				logger.exception("Failed during async initialization of ProcessingPipeline")
				# Optionally set pipeline to None or handle the error appropriately
				self._pipeline = None
		elif not self.pipeline:
			logger.error("Cannot perform async initialization: ProcessingPipeline failed to initialize earlier.")
		else:
			logger.info("AskCommand async components already initialized.")

	async def _retrieve_context(self, query: str, limit: int | None = None) -> list[dict[str, Any]]:
		"""Retrieve relevant code chunks based on the query."""
		if not self.pipeline:
			logger.warning("ProcessingPipeline not available, no context will be retrieved.")
			return []

		# Use configured limit or default
		actual_limit = limit or self.max_context_results

		try:
			logger.info(f"Retrieving context for query: '{query}', limit: {actual_limit}")
			# Use synchronous method to get results (pipeline.semantic_search is async)
			# Now call await directly as this method is async
			# import asyncio
			# results = asyncio.run(self.pipeline.semantic_search(query, k=actual_limit))
			results = await self.pipeline.semantic_search(query, k=actual_limit)

			# Format results for the LLM
			formatted_results = []
			if results:  # Check if results is not None and has items
				for r in results:
					# Extract relevant fields from payload
					payload = r.get("payload", {})

					# Get file content from repo using file_path, start_line, and end_line
					file_path = payload.get("file_path", "N/A")
					start_line = payload.get("start_line", -1)
					end_line = payload.get("end_line", -1)

					# Get content from repository if needed and build a content representation
					# For now, we'll use a simple representation that includes metadata
					entity_type = payload.get("entity_type", "")
					entity_name = payload.get("entity_name", "")
					language = payload.get("language", "")

					# Build a content representation from the metadata
					content_parts = []
					content_parts.append(f"Type: {entity_type}")
					if entity_name:
						content_parts.append(f"Name: {entity_name}")

					# Get the file content from the repo
					try:
						if (
							self.config_loader.get.repo_root
							and file_path
							and file_path != "N/A"
							and start_line > 0
							and end_line > 0
						):
							repo_file_path = self.config_loader.get.repo_root / file_path
							if await asyncio.to_thread(repo_file_path.exists):
								async with aiofiles.open(repo_file_path, encoding="utf-8") as f:
									file_content = await f.read()
								lines = file_content.splitlines()
								if start_line <= len(lines) and end_line <= len(lines) and start_line <= end_line:
									code_content = "\n".join(lines[start_line - 1 : end_line])
									if language:
										content_parts.append(f"```{language}\n{code_content}\n```")
									else:
										content_parts.append(f"```\n{code_content}\n```")
								else:
									logger.warning(
										f"Invalid line numbers for file {file_path}: "
										f"start={start_line}, end={end_line}, total_lines={len(lines)}. "
										"Skipping code content for this chunk."
									)
							else:
								logger.warning(f"File path does not exist for chunk context: {repo_file_path}")
						elif file_path == "N/A":
							logger.warning("File path is 'N/A' for a chunk, cannot retrieve content.")
							# Add other conditions leading to this path if necessary for logging
					except Exception:
						logger.exception(f"Error reading or processing file content for {file_path}")
						# Optionally, append a placeholder or error message to content_parts
						# content_parts.append("[Error retrieving code content]")

					content = "\n\n".join(content_parts)

					formatted_results.append(
						{
							"file_path": file_path,
							"start_line": start_line,
							"end_line": end_line,
							"content": content,
							"score": r.get("score", -1.0),
						}
					)

			logger.debug(f"Semantic search returned {len(formatted_results)} results.")
			return formatted_results
		except Exception:
			logger.exception("Error retrieving context")
			return []

	async def run(self, question: str) -> AskResult:
		"""Executes one turn of the ask command, returning the answer and context."""
		logger.info(f"Processing question for session {self.session_id}: '{question}'")

		# Ensure async initialization happened (idempotent check inside)
		await self.initialize()

		if not self.pipeline:
			return AskResult(answer="Processing pipeline not available.", context=[])

		# Retrieve relevant context first
		context = await self._retrieve_context(question)

		# Format context for inclusion in prompt
		context_text = self.ui.format_content_for_context(context)
		if len(context_text) > self.max_context_length:
			logger.warning(f"Context too long ({len(context_text)} chars), truncating.")
			context_text = context_text[: self.max_context_length] + "... [truncated]"

		# Construct prompt text from the context and question
		prompt = (
			f"System: {SYSTEM_PROMPT}\n\n"
			f"User: Here's my question about the codebase: {question}\n\n"
			f"Relevant context from the codebase:\n{context_text}"
		)

		# Store user query in DB
		db_entry_id = None
		try:
			db_entry = self.db_client.add_chat_message(session_id=self.session_id, user_query=question)
			db_entry_id = db_entry.id if db_entry else None
			if db_entry_id:
				logger.debug(f"Stored current query turn with DB ID: {db_entry_id}")
			else:
				logger.warning("Failed to get DB entry ID for current query turn.")
		except Exception:
			logger.exception("Failed to store current query turn in DB")

		# Call LLM with context
		try:
			with progress_indicator("Waiting for LLM response..."):
				answer = self.llm_client.completion(
					messages=[{"role": "user", "content": prompt}],
				)
			logger.debug(f"LLM response: {answer}")

			# Update DB with answer using the dedicated client method
			if db_entry_id and answer:
				# The update_chat_response method handles its own exceptions and returns success/failure
				success = self.db_client.update_chat_response(message_id=db_entry_id, ai_response=answer)
				if not success:
					logger.warning(f"Failed to update DB entry {db_entry_id} via client method.")

			return AskResult(answer=answer, context=context)
		except Exception as e:  # Keep the outer exception for LLM call errors
			logger.exception("Error during LLM completion")
			return AskResult(answer=f"Error: {e!s}", context=context)

__init__

__init__() -> None

Initializes the AskCommand, setting up clients and pipeline.

Source code in src/codemap/llm/rag/ask/command.py
39
40
41
42
43
44
45
46
def __init__(self) -> None:
	"""Initializes the AskCommand, setting up clients and pipeline."""
	self.session_id = str(uuid.uuid4())  # Unique session ID for DB logging
	self.config_loader = ConfigLoader.get_instance()
	self.ui = RagUI()
	self._db_client = None
	self._llm_client = None
	self._pipeline = None

session_id instance-attribute

session_id = str(uuid4())

config_loader instance-attribute

config_loader = get_instance()

ui instance-attribute

ui = RagUI()

db_client property

db_client: DatabaseClient

Lazily initialize and return a DatabaseClient instance.

llm_client property

llm_client: LLMClient

Lazily initialize and return an LLMClient instance.

pipeline property

pipeline: ProcessingPipeline | None

Lazily initialize and return a ProcessingPipeline instance, or None if initialization fails.

max_context_length property

max_context_length: int

Return the maximum context length for RAG, using config or default.

max_context_results property

max_context_results: int

Return the maximum number of context results for RAG, using config or default.

initialize async

initialize() -> None

Perform asynchronous initialization for the command, especially the pipeline.

Source code in src/codemap/llm/rag/ask/command.py
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
async def initialize(self) -> None:
	"""Perform asynchronous initialization for the command, especially the pipeline."""
	if self.pipeline and not self.pipeline.is_async_initialized:
		try:
			# Show a spinner while initializing the pipeline asynchronously
			with progress_indicator(
				message="Initializing async components (pipeline)...", style="spinner", transient=True
			):
				await self.pipeline.async_init(sync_on_init=True)
			logger.info("ProcessingPipeline async initialization complete.")
		except Exception:
			logger.exception("Failed during async initialization of ProcessingPipeline")
			# Optionally set pipeline to None or handle the error appropriately
			self._pipeline = None
	elif not self.pipeline:
		logger.error("Cannot perform async initialization: ProcessingPipeline failed to initialize earlier.")
	else:
		logger.info("AskCommand async components already initialized.")

run async

run(question: str) -> AskResult

Executes one turn of the ask command, returning the answer and context.

Source code in src/codemap/llm/rag/ask/command.py
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
async def run(self, question: str) -> AskResult:
	"""Executes one turn of the ask command, returning the answer and context."""
	logger.info(f"Processing question for session {self.session_id}: '{question}'")

	# Ensure async initialization happened (idempotent check inside)
	await self.initialize()

	if not self.pipeline:
		return AskResult(answer="Processing pipeline not available.", context=[])

	# Retrieve relevant context first
	context = await self._retrieve_context(question)

	# Format context for inclusion in prompt
	context_text = self.ui.format_content_for_context(context)
	if len(context_text) > self.max_context_length:
		logger.warning(f"Context too long ({len(context_text)} chars), truncating.")
		context_text = context_text[: self.max_context_length] + "... [truncated]"

	# Construct prompt text from the context and question
	prompt = (
		f"System: {SYSTEM_PROMPT}\n\n"
		f"User: Here's my question about the codebase: {question}\n\n"
		f"Relevant context from the codebase:\n{context_text}"
	)

	# Store user query in DB
	db_entry_id = None
	try:
		db_entry = self.db_client.add_chat_message(session_id=self.session_id, user_query=question)
		db_entry_id = db_entry.id if db_entry else None
		if db_entry_id:
			logger.debug(f"Stored current query turn with DB ID: {db_entry_id}")
		else:
			logger.warning("Failed to get DB entry ID for current query turn.")
	except Exception:
		logger.exception("Failed to store current query turn in DB")

	# Call LLM with context
	try:
		with progress_indicator("Waiting for LLM response..."):
			answer = self.llm_client.completion(
				messages=[{"role": "user", "content": prompt}],
			)
		logger.debug(f"LLM response: {answer}")

		# Update DB with answer using the dedicated client method
		if db_entry_id and answer:
			# The update_chat_response method handles its own exceptions and returns success/failure
			success = self.db_client.update_chat_response(message_id=db_entry_id, ai_response=answer)
			if not success:
				logger.warning(f"Failed to update DB entry {db_entry_id} via client method.")

		return AskResult(answer=answer, context=context)
	except Exception as e:  # Keep the outer exception for LLM call errors
		logger.exception("Error during LLM completion")
		return AskResult(answer=f"Error: {e!s}", context=context)