julee.api.routers.knowledge_service_queries
===========================================

.. py:module:: julee.api.routers.knowledge_service_queries

.. autoapi-nested-parse::

   Knowledge Service Queries API router for the julee CEAP system.

   This module provides the API endpoints for knowledge service queries,
   which define how to extract specific data using external knowledge services
   during the assembly process.

   Routes defined at root level:
   - GET / - List knowledge service queries (paginated)
   - GET /{query_id} - Get individual query details
   - POST / - Create new knowledge service query

   These routes are mounted at /knowledge_service_queries in the main app.



Attributes
----------

.. autoapisummary::

   julee.api.routers.knowledge_service_queries.logger
   julee.api.routers.knowledge_service_queries.router


Functions
---------

.. autoapisummary::

   julee.api.routers.knowledge_service_queries.create_knowledge_service_query
   julee.api.routers.knowledge_service_queries.get_knowledge_service_queries
   julee.api.routers.knowledge_service_queries.get_knowledge_service_query


Module Contents
---------------

.. py:function:: create_knowledge_service_query(request, repository = Depends(get_knowledge_service_query_repository))
   :async:


   Create a new knowledge service query.

   This endpoint creates a new knowledge service query configuration that
   defines how to extract specific data using external knowledge services
   during the assembly process.

   :param request: The knowledge service query creation request
   :param repository: Injected repository for persistence

   :returns:

             The created query with generated ID and
                 timestamps
   :rtype: KnowledgeServiceQuery


.. py:function:: get_knowledge_service_queries(ids = Query(None, description='Comma-separated list of query IDs for bulk retrieval', openapi_examples={'bulk_query': {'summary': 'Bulk retrieval example', 'value': 'query-123,query-456,query-789'}}), repository = Depends(get_knowledge_service_query_repository))
   :async:


   Get knowledge service queries by IDs or list all with pagination.

   This endpoint supports two modes:
   1. Bulk retrieval: Pass comma-separated IDs to get specific queries
   2. List all: Without IDs parameter, returns paginated list of all queries

   Each query contains the configuration needed to extract specific data
   using external knowledge services.

   :param ids: Optional comma-separated list of query IDs for bulk retrieval

   :returns:

             List of queries (bulk) or paginated
                 list (all)
   :rtype: Page[KnowledgeServiceQuery]


.. py:function:: get_knowledge_service_query(query_id, repository = Depends(get_knowledge_service_query_repository))
   :async:


   Get a specific knowledge service query by ID.

   :param query_id: The ID of the query to retrieve
   :param repository: Injected repository for data access

   :returns: The requested query
   :rtype: KnowledgeServiceQuery

   :raises HTTPException: 404 if query not found, 500 for internal errors


.. py:data:: logger

.. py:data:: router