LLM Service

osa_tool.operations.docs.readme_generation.models.llm_service

LLMClient

get_getting_started()

Attempting to generate Getting Started section using information from README, examples and docs directories

get_key_files()

Identifies key files from the project repository using model analysis.

get_responses()

Extracts core features, overview, and optionally a Getting Started section from the repository.

This method processes key files to extract core features and a general overview of the project. If example files are detected (e.g., scripts or notebooks demonstrating usage), it also generates a Getting Started section. Each part is generated by sending prompts to the model and cleaned before returning.

Returns:

Type	Description
tuple[str, str, str]	tuple[str, str, str]: A tuple containing: - core_features: Main functionalities and capabilities of the project. - overview: General description and project context. - getting_started: (Optional) Setup or usage guide if examples are available.

get_responses_article(article)

Generates an article-style summary of the repository based on key files and associated PDF documentation.

Parameters:

Name	Type	Description	Default
article	str	Path to a research or descriptive PDF document associated with the project.	required

Returns:

Type	Description
tuple[str, str, str, str]	tuple[str, str, str]: A tuple containing: - overview: General description and project context. - content: Content section based on key files and documentation. - algorithms: Description of algorithms used.