phoenix-oss/llama-stack-mirror
0
0
Fork 1
mirror of https://github.com/meta-llama/llama-stack.git synced 2025-08-03 09:21:45 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

adding comment into docstring with default value example

Browse source 
Signed-off-by: Francisco Javier Arceo <farceo@redhat.com>
This commit is contained in:
Francisco Javier Arceo 2025-05-14 21:45:24 -04:00
parent 3faaeb0bba
commit 38f6b6ff9e
4 changed files with 7 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

2
docs/_static/llama-stack-spec.html vendored
View file

@ -11310,7 +11310,7 @@
"chunk_template": { "chunk_template": {
"type": "string", "type": "string",
"default": "Result {index}\nContent: {chunk.content}\nMetadata: {metadata}\n", "default": "Result {index}\nContent: {chunk.content}\nMetadata: {metadata}\n",
"description": "Template for formatting each retrieved chunk in the context." "description": "Template for formatting each retrieved chunk in the context. Available placeholders: {index} (1-based chunk ordinal), {chunk.content} (chunk content string), {metadata} (chunk metadata dict). Default: \"Result {index}\\nContent: {chunk.content}\\nMetadata: {metadata}\\n\""
} }
}, },
"additionalProperties": false, "additionalProperties": false,

5
docs/_static/llama-stack-spec.yaml vendored
View file

@ -7812,7 +7812,10 @@ components:
Metadata: {metadata} Metadata: {metadata}
description: >- description: >-
Template for formatting each retrieved chunk in the context. Template for formatting each retrieved chunk in the context. Available
placeholders: {index} (1-based chunk ordinal), {chunk.content} (chunk
content string), {metadata} (chunk metadata dict). Default: "Result {index}\nContent:
{chunk.content}\nMetadata: {metadata}\n"
additionalProperties: false additionalProperties: false
required: required:
- query_generator_config - query_generator_config

4
llama_stack/apis/tools/rag_tool.py
View file

@ -74,6 +74,8 @@ class RAGQueryConfig(BaseModel):
:param max_tokens_in_context: Maximum number of tokens in the context. :param max_tokens_in_context: Maximum number of tokens in the context.
:param max_chunks: Maximum number of chunks to retrieve. :param max_chunks: Maximum number of chunks to retrieve.
:param chunk_template: Template for formatting each retrieved chunk in the context. :param chunk_template: Template for formatting each retrieved chunk in the context.
Available placeholders: {index} (1-based chunk ordinal), {chunk.content} (chunk content string), {metadata} (chunk metadata dict).
Default: "Result {index}\\nContent: {chunk.content}\\nMetadata: {metadata}\\n"
""" """
# This config defines how a query is generated using the messages # This config defines how a query is generated using the messages
@ -81,8 +83,6 @@ class RAGQueryConfig(BaseModel):
query_generator_config: RAGQueryGeneratorConfig = Field(default=DefaultRAGQueryGeneratorConfig()) query_generator_config: RAGQueryGeneratorConfig = Field(default=DefaultRAGQueryGeneratorConfig())
max_tokens_in_context: int = 4096 max_tokens_in_context: int = 4096
max_chunks: int = 5 max_chunks: int = 5
# Optional template for formatting each retrieved chunk in the context.
# Available placeholders: {index} (1-based chunk ordinal), {metadata} (chunk metadata dict), {chunk.content} (chunk content string).
chunk_template: str = "Result {index}\nContent: {chunk.content}\nMetadata: {metadata}\n" chunk_template: str = "Result {index}\nContent: {chunk.content}\nMetadata: {metadata}\n"
@field_validator("chunk_template") @field_validator("chunk_template")

1
tests/unit/rag/test_vector_store.py
View file

@ -93,7 +93,6 @@ class TestVectorStore:
chunks = make_overlapped_chunks(document_id, text, window_len, overlap_len, original_metadata) chunks = make_overlapped_chunks(document_id, text, window_len, overlap_len, original_metadata)
assert len(chunks) == expected_chunks assert len(chunks) == expected_chunks
print(len(chunks), expected_chunks)
# Check that each chunk has the right metadata # Check that each chunk has the right metadata
for chunk in chunks: for chunk in chunks: