rag_tool

docs/_static/llama-stack-spec.yaml

@@ -1360,7 +1360,7 @@ paths:
       tags:
         - ToolRuntime
       description: >-
-        Index documents so they can be used by the RAG system
+        Index documents so they can be used by the RAG system.
       parameters: []
       requestBody:
         content:
@@ -3071,7 +3071,8 @@ paths:
     post:
       responses:
         '200':
-          description: OK
+          description: >-
+            RAGQueryResult containing the retrieved content and metadata
           content:
             application/json:
               schema:
@@ -3089,7 +3090,7 @@ paths:
       tags:
         - ToolRuntime
       description: >-
-        Query the RAG system for context; typically invoked by the agent
+        Query the RAG system for context; typically invoked by the agent.
       parameters: []
       requestBody:
         content:
@@ -8202,10 +8203,16 @@ components:
           type: array
           items:
             $ref: '#/components/schemas/RAGDocument'
+          description: >-
+            List of documents to index in the RAG system
         vector_db_id:
           type: string
+          description: >-
+            ID of the vector database to store the document embeddings
         chunk_size_in_tokens:
           type: integer
+          description: >-
+            (Optional) Size in tokens for document chunking during indexing
       additionalProperties: false
       required:
         - documents
@@ -10493,14 +10500,20 @@ components:
           type: string
           const: default
           default: default
+          description: >-
+            Type of query generator, always 'default'
         separator:
           type: string
           default: ' '
+          description: >-
+            String separator used to join query terms
       additionalProperties: false
       required:
         - type
         - separator
       title: DefaultRAGQueryGeneratorConfig
+      description: >-
+        Configuration for the default RAG query generator.
     LLMRAGQueryGeneratorConfig:
       type: object
       properties:
@@ -10508,16 +10521,23 @@ components:
           type: string
           const: llm
           default: llm
+          description: Type of query generator, always 'llm'
         model:
           type: string
+          description: >-
+            Name of the language model to use for query generation
         template:
           type: string
+          description: >-
+            Template string for formatting the query generation prompt
       additionalProperties: false
       required:
         - type
         - model
         - template
       title: LLMRAGQueryGeneratorConfig
+      description: >-
+        Configuration for the LLM-based RAG query generator.
     RAGQueryConfig:
       type: object
       properties:
@@ -10586,8 +10606,7 @@ components:
           default: 60.0
           description: >-
             The impact factor for RRF scoring. Higher values give more weight to higher-ranked
-            results. Must be greater than 0. Default of 60 is from the original RRF
-            paper (Cormack et al., 2009).
+            results. Must be greater than 0
       additionalProperties: false
       required:
         - type
@@ -10630,12 +10649,18 @@ components:
       properties:
         content:
           $ref: '#/components/schemas/InterleavedContent'
+          description: >-
+            The query content to search for in the indexed documents
         vector_db_ids:
           type: array
           items:
             type: string
+          description: >-
+            List of vector database IDs to search within
         query_config:
           $ref: '#/components/schemas/RAGQueryConfig'
+          description: >-
+            (Optional) Configuration parameters for the query operation
       additionalProperties: false
       required:
         - content
@@ -10646,6 +10671,8 @@ components:
       properties:
         content:
           $ref: '#/components/schemas/InterleavedContent'
+          description: >-
+            (Optional) The retrieved content from the query
         metadata:
           type: object
           additionalProperties:
@@ -10656,10 +10683,14 @@ components:
               - type: string
               - type: array
               - type: object
+          description: >-
+            Additional metadata about the query result
       additionalProperties: false
       required:
         - metadata
       title: RAGQueryResult
+      description: >-
+        Result of a RAG query containing retrieved content and metadata.
     QueryChunksRequest:
       type: object
       properties: