Skip to content

Commit

Permalink
Tweak llm.md docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Winston-503 committed Jan 16, 2025
1 parent 58bbde4 commit 5db8e6d
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion docs/source/reference/llm.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,10 @@ for consumption in result.consumptions:

For information about enabling Anthropic prompt caching, refer to {class}`~council.llm.LLMCacheControlData`.

### Prompt Management

Store your prompts as YAML files as unstructured text ({class}`~council.prompt.LLMPromptConfigObject`) or structured objects ({class}`~council.prompt.LLMStructuredPromptConfigObject`) with automatic selection of the prompt based on the LLM used.

### LLM Functions

LLM Functions provide structured ways to interact with LLMs including built-in response parsing, error handling and retries.
Expand All @@ -88,6 +92,8 @@ Response parsers help automate the parsing of common response formats to use LLM
- {class}`~council.llm.YAMLBlockResponseParser` and {class}`~council.llm.YAMLResponseParser` for YAML
- {class}`~council.llm.JSONBlockResponseParser` and {class}`~council.llm.JSONResponseParser` for JSON

Code block, YAML and JSON response parsers also support `to_response_template()` method to convert the structured object into a natural language response template description.

### LLM Middleware

Middleware components allow you to enhance LLM interactions by modifying requests and responses introducing custom logic, such as logging, caching, configuration updates, etc.
Expand All @@ -97,7 +103,9 @@ Core middlewares:
- Caching: {class}`~council.llm.LLMCachingMiddleware`
- Logging:
- Context logger: {class}`~council.llm.LLMLoggingMiddleware`
- Files: {class}`~council.llm.LLMFileLoggingMiddleware` and {class}`~council.llm.LLMTimestampFileLoggingMiddleware`
- File logging:
- {class}`~council.llm.LLMFileLoggingMiddleware`
- {class}`~council.llm.LLMTimestampFileLoggingMiddleware` for single file per request

Middleware management:

Expand Down

0 comments on commit 5db8e6d

Please sign in to comment.