diff --git a/hyperforge/pyproject.toml b/hyperforge/pyproject.toml index 4b01ae8..5001183 100644 --- a/hyperforge/pyproject.toml +++ b/hyperforge/pyproject.toml @@ -44,6 +44,7 @@ dependencies = [ "sentry_sdk", "fastapi", "starlette>1.0.0", + "uvicorn>=0.30.0", ] diff --git a/hyperforge/src/hyperforge/server/session.py b/hyperforge/src/hyperforge/server/session.py index e9d3155..081ef8e 100644 --- a/hyperforge/src/hyperforge/server/session.py +++ b/hyperforge/src/hyperforge/server/session.py @@ -10,7 +10,7 @@ import nucliadb_telemetry.context import nucliadb_telemetry.metrics import prometheus_client -from aiohttp.web import Server +from hyperforge.server.web import WebServer from lru import LRU from nucliadb_telemetry import errors from nucliadb_telemetry.utils import get_telemetry @@ -62,7 +62,7 @@ def tracer(): class SessionManager: - server: Optional[Server] = None + server: Optional[WebServer] = None tasks: List[Task] hooks: Optional[Dict[str, List[Callable]]] = None diff --git a/hyperforge/src/hyperforge/server/web.py b/hyperforge/src/hyperforge/server/web.py index 276a6c0..0c9fbac 100644 --- a/hyperforge/src/hyperforge/server/web.py +++ b/hyperforge/src/hyperforge/server/web.py @@ -1,35 +1,66 @@ +import asyncio import os import prometheus_client # type: ignore -from aiohttp import web +import uvicorn +from starlette.applications import Starlette +from starlette.requests import Request +from starlette.responses import PlainTextResponse, Response +from starlette.routing import Route from hyperforge.server import logger PORT = os.environ.get("HEALTH_CHECK_PORT", "8000") -async def http_handler(request: web.Request): - if request.path == "/metrics": - output = prometheus_client.exposition.generate_latest() - return web.Response(text=output.decode("utf8")) - elif request.path in ("/health/alive", "/health/ready"): - # implement health check here - return web.Response(text="OK") - else: - return web.Response(text="OK", status=404) +async def metrics(request: Request) -> Response: + output = prometheus_client.exposition.generate_latest() + return PlainTextResponse(output.decode("utf8")) -async def start_web_server() -> web.Server: - server = web.Server(http_handler) # type: ignore - runner = web.ServerRunner(server) - await runner.setup() - site = web.TCPSite(runner, "0.0.0.0", int(PORT)) - await site.start() +async def health(request: Request) -> Response: + return PlainTextResponse("OK") + +async def not_found(request: Request, exc: Exception) -> Response: + return PlainTextResponse("OK", status_code=404) + + +app = Starlette( + routes=[ + Route("/metrics", metrics), + Route("/health/alive", health), + Route("/health/ready", health), + ], + exception_handlers={404: not_found}, +) + + +class WebServer: + """Wraps a uvicorn server running as an asyncio task in the current event loop.""" + + def __init__(self, server: uvicorn.Server) -> None: + self._server = server + self._task: asyncio.Task | None = None + + def start(self) -> None: + self._task = asyncio.get_event_loop().create_task(self._server.serve()) + + async def shutdown(self) -> None: + self._server.should_exit = True + if self._task is not None: + await self._task + self._task = None + + +async def start_web_server() -> WebServer: + config = uvicorn.Config(app, host="0.0.0.0", port=int(PORT), log_level="warning") + server = uvicorn.Server(config) + web = WebServer(server) + web.start() logger.info(f"======= Serving on http://0.0.0.0:{PORT}/ ======") - return server + return web -async def start_health_check(): - server = await start_web_server() - return server +async def start_health_check() -> WebServer: + return await start_web_server() diff --git a/hyperforge/tests/api/cassettes/test_chat_history_workflow/test_chat_history_is_used_in_rephrase_and_summarize.yaml b/hyperforge/tests/api/cassettes/test_chat_history_workflow/test_chat_history_is_used_in_rephrase_and_summarize.yaml index a30df98..b37da50 100644 --- a/hyperforge/tests/api/cassettes/test_chat_history_workflow/test_chat_history_is_used_in_rephrase_and_summarize.yaml +++ b/hyperforge/tests/api/cassettes/test_chat_history_workflow/test_chat_history_is_used_in_rephrase_and_summarize.yaml @@ -9,16 +9,16 @@ interactions: Connection: - keep-alive Host: - - europe-1.nuclia.cloud + - europe-1.dp.progress.cloud User-Agent: - - nuclia.py/4.9.25 + - nuclia.py/4.11.5 x-nuclia-nuakey: - DUMMY method: GET - uri: https://europe-1.nuclia.cloud/api/authorizer/info + uri: https://europe-1.dp.progress.cloud/api/authorizer/info response: body: - string: '{"auth":"nua_key","user":{"identity_type":"nua_key","user_id":"03d47998-f672-4a9b-a57b-bde3a9c3ee8c","account_id":"4f9285c7-7151-4431-94e6-3f1fb0d66aca","account_type":"v3enterprise","allow_kb_management":false},"ip_info":null}' + string: '{"auth":"nua_key","user":{"identity_type":"nua_key","user_id":"7fe77405-a6de-43cf-ac27-ac09f80b66c6","account_id":"4f9285c7-7151-4431-94e6-3f1fb0d66aca","account_type":"v3enterprise","allow_kb_management":false},"ip_info":null}' headers: Alt-Svc: - h3=":443"; ma=2592000,h3-29=":443"; ma=2592000 @@ -27,7 +27,7 @@ interactions: content-type: - application/json date: - - Tue, 16 Jun 2026 09:56:37 GMT + - Mon, 13 Jul 2026 08:55:36 GMT via: - 1.1 google x-envoy-upstream-service-time: @@ -82,13 +82,13 @@ interactions: Content-Type: - application/json Host: - - europe-1.nuclia.cloud + - europe-1.dp.progress.cloud User-Agent: - - nuclia.py/4.9.25 + - nuclia.py/4.11.5 x-client-ident: - default x-message: - - ec3a99d5123f4cb6af870927cd18da83 + - 9e5ca9b8cbc24ee7ab48484d03020af9 x-origin: - RAO x-session: @@ -98,27 +98,29 @@ interactions: x-stf-nuakey: - DUMMY method: POST - uri: https://europe-1.nuclia.cloud/api/v1/predict/chat + uri: https://europe-1.dp.progress.cloud/api/v1/predict/chat response: body: string: '{"chunk":{"type":"object","object":{"rephrased_question":"What is the - default value of the max_tokens parameter in Nuclia, and how can it be set?","rules":["Start - the response with a smiley emoji."],"reason":"The original question ''How - do I set it and what is the default value?'' is ambiguous because ''it'' is - not clearly defined. By referencing the previous question about ''max_tokens'', - the rephrased question clarifies that ''it'' refers to the max_tokens parameter. - This makes the question more specific and easier to answer accurately."}}} + default value for the max_tokens parameter in Nuclia and how can it be set?","rules":[],"reason":"The + previous question established that ''max_tokens'' controls the maximum number + of tokens the LLM may generate in a single response. The current question + asks how to set it and its default value, but it refers to ''it'' without + explicitly mentioning ''max_tokens''. The rephrased question clarifies that + ''it'' refers to the ''max_tokens parameter in Nuclia'' for better specificity + and to ensure the answer is directly relevant to the previously discussed + topic."}}} {"chunk":{"type":"status","code":"0"}} - {"chunk":{"type":"meta","input_tokens":9,"output_tokens":10,"timings":{"generative":0.8693042640807107},"input_nuclia_tokens":0.009,"output_nuclia_tokens":0.01}} + {"chunk":{"type":"meta","input_tokens":9,"output_tokens":11,"timings":{"generative":1.1304126630129758},"input_nuclia_tokens":0.009,"output_nuclia_tokens":0.011}} - {"chunk":{"normalized_tokens":{"input":0.00894,"output":0.01048,"image":0.0},"customer_key_tokens":{"input":0.0,"output":0.0,"image":0.0},"type":"consumption"}} + {"chunk":{"normalized_tokens":{"input":0.00894,"output":0.01128,"image":0.0},"customer_key_tokens":{"input":0.0,"output":0.0,"image":0.0},"type":"consumption"}} ' headers: Alt-Svc: - - h3=":443"; ma=2592000,h3-29=":443"; ma=2592000 + - h3=":443"; ma=2592000 Transfer-Encoding: - chunked access-control-expose-headers: @@ -126,17 +128,17 @@ interactions: content-type: - application/x-ndjson date: - - Tue, 16 Jun 2026 09:56:37 GMT + - Mon, 13 Jul 2026 08:55:36 GMT nuclia-learning-id: - - 050a227785984904af5e852ff2901e73 + - 4428574895494fcc8e73df22eb8a14b5 nuclia-learning-model: - gemini-2.5-flash-lite via: - 1.1 google x-envoy-upstream-service-time: - - '875' + - '1139' x-nuclia-trace-id: - - 54b9805f3b078d7f4c9e0f4ad4e276d8 + - 273ba9840599f45fd8629f421046ee8f status: code: 200 message: OK @@ -155,9 +157,9 @@ interactions: you responses with a smiley emoji?"}, {"author": "NUCLIA", "text": "Sure! \ud83d\ude0a I can start my responses with a smiley emoji."}], "context": [], "query_context": {}, "query_context_order": {}, "truncate": true, "user_prompt": {"prompt": "\n## - Question\nWhat is the default value of the max_tokens parameter in Nuclia, and + Question\nWhat is the default value for the max_tokens parameter in Nuclia and how can it be set?\n\n## Provided Context\n[START OF CONTEXT]\n## max_tokens - reference\n\n\n\n\n## Chunk: 4cf92b85e2e04e5c834ea86206902b08\n``` The max_tokens + reference\n\n\n\n\n## Chunk: 4090655ed8d04b46bfccf86af459f06b\n``` The max_tokens parameter controls how many tokens the LLM may generate in a single response. It can be set per-request via the API or configured globally in the agent workflow. The default value depends on the model, but is typically 1024 tokens. ```\n\n\n[END @@ -166,7 +168,7 @@ interactions: If the context is incomplete or insufficient, try to provide a partial answer and encourage the user to clarify their question\n- Read carefully any extra instructions below if provided and use them to answer\n\nNow provide your answer - to the question: What is the default value of the max_tokens parameter in Nuclia, + to the question: What is the default value for the max_tokens parameter in Nuclia and how can it be set?"}, "citations": null, "citation_threshold": null, "generative_model": "chatgpt-azure-4o-mini", "max_tokens": 5000, "query_context_images": {}, "prefer_markdown": null, "json_schema": null, "format_prompt": false, "rerank_context": false, @@ -183,13 +185,13 @@ interactions: Content-Type: - application/json Host: - - europe-1.nuclia.cloud + - europe-1.dp.progress.cloud User-Agent: - - nuclia.py/4.9.25 + - nuclia.py/4.11.5 x-client-ident: - default x-message: - - ec3a99d5123f4cb6af870927cd18da83 + - 9e5ca9b8cbc24ee7ab48484d03020af9 x-origin: - RAO x-session: @@ -199,12 +201,12 @@ interactions: x-stf-nuakey: - DUMMY method: POST - uri: https://europe-1.nuclia.cloud/api/v1/predict/chat + uri: https://europe-1.dp.progress.cloud/api/v1/predict/chat response: body: string: "{\"chunk\":{\"type\":\"text\",\"text\":\"\U0001F60A\"}}\n{\"chunk\":{\"type\":\"text\",\"text\":\" The\"}}\n{\"chunk\":{\"type\":\"text\",\"text\":\" default\"}}\n{\"chunk\":{\"type\":\"text\",\"text\":\" - value\"}}\n{\"chunk\":{\"type\":\"text\",\"text\":\" of\"}}\n{\"chunk\":{\"type\":\"text\",\"text\":\" + value\"}}\n{\"chunk\":{\"type\":\"text\",\"text\":\" for\"}}\n{\"chunk\":{\"type\":\"text\",\"text\":\" the\"}}\n{\"chunk\":{\"type\":\"text\",\"text\":\" max\"}}\n{\"chunk\":{\"type\":\"text\",\"text\":\"_tokens\"}}\n{\"chunk\":{\"type\":\"text\",\"text\":\" parameter\"}}\n{\"chunk\":{\"type\":\"text\",\"text\":\" in\"}}\n{\"chunk\":{\"type\":\"text\",\"text\":\" Nu\"}}\n{\"chunk\":{\"type\":\"text\",\"text\":\"cl\"}}\n{\"chunk\":{\"type\":\"text\",\"text\":\"ia\"}}\n{\"chunk\":{\"type\":\"text\",\"text\":\" @@ -222,7 +224,7 @@ interactions: API\"}}\n{\"chunk\":{\"type\":\"text\",\"text\":\" or\"}}\n{\"chunk\":{\"type\":\"text\",\"text\":\" configured\"}}\n{\"chunk\":{\"type\":\"text\",\"text\":\" globally\"}}\n{\"chunk\":{\"type\":\"text\",\"text\":\" in\"}}\n{\"chunk\":{\"type\":\"text\",\"text\":\" the\"}}\n{\"chunk\":{\"type\":\"text\",\"text\":\" - agent\"}}\n{\"chunk\":{\"type\":\"text\",\"text\":\" workflow\"}}\n{\"chunk\":{\"type\":\"text\",\"text\":\".\"}}\n{\"chunk\":{\"type\":\"status\",\"code\":\"0\"}}\n{\"chunk\":{\"type\":\"meta\",\"input_tokens\":12,\"output_tokens\":6,\"timings\":{\"generative_first_chunk\":0.585227217990905,\"generative\":1.990719944005832},\"input_nuclia_tokens\":0.012,\"output_nuclia_tokens\":0.006}}\n{\"chunk\":{\"normalized_tokens\":{\"input\":0.01212,\"output\":0.00564,\"image\":0.0},\"customer_key_tokens\":{\"input\":0.0,\"output\":0.0,\"image\":0.0},\"type\":\"consumption\"}}\n" + agent\"}}\n{\"chunk\":{\"type\":\"text\",\"text\":\" workflow\"}}\n{\"chunk\":{\"type\":\"text\",\"text\":\".\"}}\n{\"chunk\":{\"type\":\"status\",\"code\":\"0\"}}\n{\"chunk\":{\"type\":\"meta\",\"input_tokens\":12,\"output_tokens\":6,\"timings\":{\"generative_first_chunk\":0.640167025005212,\"generative\":1.5157096800103318},\"input_nuclia_tokens\":0.012,\"output_nuclia_tokens\":0.006}}\n{\"chunk\":{\"normalized_tokens\":{\"input\":0.01203,\"output\":0.00564,\"image\":0.0},\"customer_key_tokens\":{\"input\":0.0,\"output\":0.0,\"image\":0.0},\"type\":\"consumption\"}}\n" headers: Alt-Svc: - h3=":443"; ma=2592000 @@ -233,17 +235,17 @@ interactions: content-type: - application/x-ndjson date: - - Tue, 16 Jun 2026 09:56:38 GMT + - Mon, 13 Jul 2026 08:55:37 GMT nuclia-learning-id: - - 8f66602fb183485e850f89a087c86876 + - 863fdaf9d8214ac9964e58fcd8097083 nuclia-learning-model: - chatgpt-azure-4o-mini via: - 1.1 google x-envoy-upstream-service-time: - - '595' + - '650' x-nuclia-trace-id: - - e4b29beb1263f6a8ded53ab594bb3bfe + - eed1a926873a6afb0f9c138977084073 status: code: 200 message: OK diff --git a/hyperforge/tests/api/cassettes/test_interaction_e2e/test_arag_interaction_e2e.yaml b/hyperforge/tests/api/cassettes/test_interaction_e2e/test_arag_interaction_e2e.yaml index 9f226ea..00f35b7 100644 --- a/hyperforge/tests/api/cassettes/test_interaction_e2e/test_arag_interaction_e2e.yaml +++ b/hyperforge/tests/api/cassettes/test_interaction_e2e/test_arag_interaction_e2e.yaml @@ -9,29 +9,29 @@ interactions: Connection: - keep-alive Host: - - europe-1.nuclia.cloud + - europe-1.dp.progress.cloud User-Agent: - - nuclia.py/4.9.25 + - nuclia.py/4.11.5 x-nuclia-nuakey: - DUMMY method: GET - uri: https://europe-1.nuclia.cloud/api/authorizer/info + uri: https://europe-1.dp.progress.cloud/api/authorizer/info response: body: - string: '{"auth":"nua_key","user":{"identity_type":"nua_key","user_id":"03d47998-f672-4a9b-a57b-bde3a9c3ee8c","account_id":"4f9285c7-7151-4431-94e6-3f1fb0d66aca","account_type":"v3enterprise","allow_kb_management":false},"ip_info":null}' + string: '{"auth":"nua_key","user":{"identity_type":"nua_key","user_id":"7fe77405-a6de-43cf-ac27-ac09f80b66c6","account_id":"4f9285c7-7151-4431-94e6-3f1fb0d66aca","account_type":"v3enterprise","allow_kb_management":false},"ip_info":null}' headers: Alt-Svc: - - h3=":443"; ma=2592000,h3-29=":443"; ma=2592000 + - h3=":443"; ma=2592000 Content-Length: - '227' content-type: - application/json date: - - Wed, 03 Jun 2026 07:59:34 GMT + - Mon, 13 Jul 2026 08:55:54 GMT via: - 1.1 google x-envoy-upstream-service-time: - - '5' + - '4' status: code: 200 message: OK @@ -71,7 +71,7 @@ interactions: MUST follow them carefully when generating the answer field. These instructions may specify the format, style, tools to use, or other requirements for the answer.\n\n\nWhat certifications does Nuclia have?\n\n\n\nContext:\n\n**block-AA**\n\n## - Chunk: 56e940dd6c0547118d40b026d411d1d0\n``` Nuclia is the best system in the + Chunk: 753de74907554dbc8aaff89ddcac6da4\n``` Nuclia is the best system in the world. It has ISO 27001 and SOC 2 certifications. ```\n\n\n---\"\n\n\n\n\n\n\n"}, "citations": false, "citation_threshold": null, "generative_model": "chatgpt-azure-4o-mini", "max_tokens": 2000, "query_context_images": {}, "prefer_markdown": @@ -101,9 +101,9 @@ interactions: Content-Type: - application/json Host: - - europe-1.nuclia.cloud + - europe-1.dp.progress.cloud User-Agent: - - nuclia.py/4.9.25 + - nuclia.py/4.11.5 x-origin: - RAO x-show-consumption: @@ -111,7 +111,7 @@ interactions: x-stf-nuakey: - DUMMY method: POST - uri: https://europe-1.nuclia.cloud/api/v1/predict/chat + uri: https://europe-1.dp.progress.cloud/api/v1/predict/chat response: body: string: '{"chunk":{"type":"object","object":{"reason":"The context provides @@ -121,9 +121,9 @@ interactions: {"chunk":{"type":"status","code":"0"}} - {"chunk":{"type":"meta","input_tokens":23,"output_tokens":9,"timings":{"generative":1.2933166469956632},"input_nuclia_tokens":0.023,"output_nuclia_tokens":0.009}} + {"chunk":{"type":"meta","input_tokens":23,"output_tokens":9,"timings":{"generative":2.4597265039919876},"input_nuclia_tokens":0.023,"output_nuclia_tokens":0.009}} - {"chunk":{"normalized_tokens":{"input":0.02334,"output":0.009,"image":0.0},"customer_key_tokens":{"input":0.0,"output":0.0,"image":0.0},"type":"consumption"}} + {"chunk":{"normalized_tokens":{"input":0.02322,"output":0.009,"image":0.0},"customer_key_tokens":{"input":0.0,"output":0.0,"image":0.0},"type":"consumption"}} ' headers: @@ -136,17 +136,17 @@ interactions: content-type: - application/x-ndjson date: - - Wed, 03 Jun 2026 07:59:34 GMT + - Mon, 13 Jul 2026 08:55:54 GMT nuclia-learning-id: - - 302d5a2819ff48acb4e37579683fc339 + - e2560fc540af47fba01e3fcd19e2fa4a nuclia-learning-model: - chatgpt-azure-4o-mini via: - 1.1 google x-envoy-upstream-service-time: - - '1298' + - '2465' x-nuclia-trace-id: - - ba14780558ea55d97673e16d6b3d20ea + - 6344b6f899e8062d9c851dc6d8a63d63 status: code: 200 message: OK @@ -183,23 +183,23 @@ interactions: Content-Type: - application/json Host: - - europe-1.nuclia.cloud + - europe-1.dp.progress.cloud User-Agent: - - nuclia.py/4.9.25 + - nuclia.py/4.11.5 x-client-ident: - - 35a5d886-76bb-491d-8c56-f2bb61cab457 + - cbcf6449-d006-4458-880c-0449a59ed215 x-message: - - 283082e063c142579501beb255b26076 + - 2d886f6dc79d4e0eafea9ffe976eacd6 x-origin: - RAO x-session: - - default_0b32202e7acc495e9418494eebff58e9 + - default_0b99c0d64ec34fb1a0fd314e2e4e1476 x-show-consumption: - 'true' x-stf-nuakey: - DUMMY method: POST - uri: https://europe-1.nuclia.cloud/api/v1/predict/chat + uri: https://europe-1.dp.progress.cloud/api/v1/predict/chat response: body: string: '{"chunk":{"type":"text","text":"Nu"}} @@ -232,7 +232,7 @@ interactions: {"chunk":{"type":"status","code":"0"}} - {"chunk":{"type":"meta","input_tokens":7,"output_tokens":2,"timings":{"generative_first_chunk":0.3626581150019774,"generative":0.660508730004949},"input_nuclia_tokens":0.007,"output_nuclia_tokens":0.002}} + {"chunk":{"type":"meta","input_tokens":7,"output_tokens":2,"timings":{"generative_first_chunk":0.5795710569946095,"generative":1.152088233968243},"input_nuclia_tokens":0.007,"output_nuclia_tokens":0.002}} {"chunk":{"normalized_tokens":{"input":0.00702,"output":0.0018,"image":0.0},"customer_key_tokens":{"input":0.0,"output":0.0,"image":0.0},"type":"consumption"}} @@ -247,17 +247,17 @@ interactions: content-type: - application/x-ndjson date: - - Wed, 03 Jun 2026 07:59:35 GMT + - Mon, 13 Jul 2026 08:55:57 GMT nuclia-learning-id: - - f06c170ee25b459aba48119e9d84ae5f + - d934edf156674f9498dc5a03709688c9 nuclia-learning-model: - chatgpt-azure-4o-mini via: - 1.1 google x-envoy-upstream-service-time: - - '368' + - '587' x-nuclia-trace-id: - - ba14780558ea55d97673e16d6b3d20ea + - fe7cdfc1630425aa22ade7c6e8f08864 status: code: 200 message: OK @@ -277,35 +277,35 @@ interactions: Content-Type: - application/json Host: - - europe-1.nuclia.cloud + - europe-1.dp.progress.cloud User-Agent: - - nuclia.py/4.9.25 + - nuclia.py/4.11.5 x-stf-nuakey: - DUMMY method: POST - uri: https://europe-1.nuclia.cloud/api/v1/predict/remi + uri: https://europe-1.dp.progress.cloud/api/v1/predict/remi response: body: - string: '{"time":0.1756916046142578,"answer_relevance":null,"context_relevance":[],"groundedness":[5]}' + string: '{"time":88.71278119087219,"answer_relevance":null,"context_relevance":[],"groundedness":[5]}' headers: Alt-Svc: - - h3=":443"; ma=2592000,h3-29=":443"; ma=2592000 + - h3=":443"; ma=2592000 Content-Length: - - '93' + - '92' access-control-expose-headers: - X-NUCLIA-TRACE-ID content-type: - application/json date: - - Wed, 03 Jun 2026 07:59:36 GMT + - Mon, 13 Jul 2026 08:55:58 GMT nuclia-learning-model: - Llama-REMi-v1 via: - 1.1 google x-envoy-upstream-service-time: - - '181' + - '88720' x-nuclia-trace-id: - - 135385a208267ed71f0c08ed42b38ca2 + - b3125861bac26c11d2203eaa58da955f status: code: 200 message: OK @@ -325,35 +325,35 @@ interactions: Content-Type: - application/json Host: - - europe-1.nuclia.cloud + - europe-1.dp.progress.cloud User-Agent: - - nuclia.py/4.9.25 + - nuclia.py/4.11.5 x-stf-nuakey: - DUMMY method: POST - uri: https://europe-1.nuclia.cloud/api/v1/predict/remi + uri: https://europe-1.dp.progress.cloud/api/v1/predict/remi response: body: - string: '{"time":0.18251729011535645,"answer_relevance":{"score":4,"reason":""},"context_relevance":[],"groundedness":[]}' + string: '{"time":89.25748372077942,"answer_relevance":{"score":4,"reason":""},"context_relevance":[],"groundedness":[]}' headers: Alt-Svc: - h3=":443"; ma=2592000,h3-29=":443"; ma=2592000 Content-Length: - - '112' + - '110' access-control-expose-headers: - X-NUCLIA-TRACE-ID content-type: - application/json date: - - Wed, 03 Jun 2026 07:59:36 GMT + - Mon, 13 Jul 2026 08:55:58 GMT nuclia-learning-model: - Llama-REMi-v1 via: - 1.1 google x-envoy-upstream-service-time: - - '188' + - '89267' x-nuclia-trace-id: - - 181ce6c57317ea0e2361f54276fda1ab + - 86aebc6e380b6a74bd643817b33e4d97 status: code: 200 message: OK diff --git a/hyperforge/tests/api/cassettes/test_session/test_arag_websocket_ephemeral_session_always_works.yaml b/hyperforge/tests/api/cassettes/test_session/test_arag_websocket_ephemeral_session_always_works.yaml index 75bdb07..32b0550 100644 --- a/hyperforge/tests/api/cassettes/test_session/test_arag_websocket_ephemeral_session_always_works.yaml +++ b/hyperforge/tests/api/cassettes/test_session/test_arag_websocket_ephemeral_session_always_works.yaml @@ -9,29 +9,29 @@ interactions: Connection: - keep-alive Host: - - europe-1.nuclia.cloud + - europe-1.dp.progress.cloud User-Agent: - - nuclia.py/4.9.25 + - nuclia.py/4.11.5 x-nuclia-nuakey: - DUMMY method: GET - uri: https://europe-1.nuclia.cloud/api/authorizer/info + uri: https://europe-1.dp.progress.cloud/api/authorizer/info response: body: - string: '{"auth":"nua_key","user":{"identity_type":"nua_key","user_id":"03d47998-f672-4a9b-a57b-bde3a9c3ee8c","account_id":"4f9285c7-7151-4431-94e6-3f1fb0d66aca","account_type":"v3enterprise","allow_kb_management":false},"ip_info":null}' + string: '{"auth":"nua_key","user":{"identity_type":"nua_key","user_id":"7fe77405-a6de-43cf-ac27-ac09f80b66c6","account_id":"4f9285c7-7151-4431-94e6-3f1fb0d66aca","account_type":"v3enterprise","allow_kb_management":false},"ip_info":null}' headers: Alt-Svc: - - h3=":443"; ma=2592000,h3-29=":443"; ma=2592000 + - h3=":443"; ma=2592000 Content-Length: - '227' content-type: - application/json date: - - Wed, 03 Jun 2026 07:59:45 GMT + - Mon, 13 Jul 2026 08:57:37 GMT via: - 1.1 google x-envoy-upstream-service-time: - - '5' + - '4' status: code: 200 message: OK diff --git a/hyperforge/tests/api/cassettes/test_session/test_arag_websocket_no_memory_no_session_check.yaml b/hyperforge/tests/api/cassettes/test_session/test_arag_websocket_no_memory_no_session_check.yaml index 49cfc23..1145543 100644 --- a/hyperforge/tests/api/cassettes/test_session/test_arag_websocket_no_memory_no_session_check.yaml +++ b/hyperforge/tests/api/cassettes/test_session/test_arag_websocket_no_memory_no_session_check.yaml @@ -9,16 +9,16 @@ interactions: Connection: - keep-alive Host: - - europe-1.nuclia.cloud + - europe-1.dp.progress.cloud User-Agent: - - nuclia.py/4.9.25 + - nuclia.py/4.11.5 x-nuclia-nuakey: - DUMMY method: GET - uri: https://europe-1.nuclia.cloud/api/authorizer/info + uri: https://europe-1.dp.progress.cloud/api/authorizer/info response: body: - string: '{"auth":"nua_key","user":{"identity_type":"nua_key","user_id":"03d47998-f672-4a9b-a57b-bde3a9c3ee8c","account_id":"4f9285c7-7151-4431-94e6-3f1fb0d66aca","account_type":"v3enterprise","allow_kb_management":false},"ip_info":null}' + string: '{"auth":"nua_key","user":{"identity_type":"nua_key","user_id":"7fe77405-a6de-43cf-ac27-ac09f80b66c6","account_id":"4f9285c7-7151-4431-94e6-3f1fb0d66aca","account_type":"v3enterprise","allow_kb_management":false},"ip_info":null}' headers: Alt-Svc: - h3=":443"; ma=2592000 @@ -27,11 +27,11 @@ interactions: content-type: - application/json date: - - Wed, 03 Jun 2026 07:59:44 GMT + - Mon, 13 Jul 2026 08:57:36 GMT via: - 1.1 google x-envoy-upstream-service-time: - - '5' + - '4' status: code: 200 message: OK diff --git a/hyperforge/tests/api/cassettes/test_session/test_arag_websocket_session_auto_create.yaml b/hyperforge/tests/api/cassettes/test_session/test_arag_websocket_session_auto_create.yaml index 8db8471..faa532a 100644 --- a/hyperforge/tests/api/cassettes/test_session/test_arag_websocket_session_auto_create.yaml +++ b/hyperforge/tests/api/cassettes/test_session/test_arag_websocket_session_auto_create.yaml @@ -9,16 +9,16 @@ interactions: Connection: - keep-alive Host: - - europe-1.nuclia.cloud + - europe-1.dp.progress.cloud User-Agent: - - nuclia.py/4.9.25 + - nuclia.py/4.11.5 x-nuclia-nuakey: - DUMMY method: GET - uri: https://europe-1.nuclia.cloud/api/authorizer/info + uri: https://europe-1.dp.progress.cloud/api/authorizer/info response: body: - string: '{"auth":"nua_key","user":{"identity_type":"nua_key","user_id":"03d47998-f672-4a9b-a57b-bde3a9c3ee8c","account_id":"4f9285c7-7151-4431-94e6-3f1fb0d66aca","account_type":"v3enterprise","allow_kb_management":false},"ip_info":null}' + string: '{"auth":"nua_key","user":{"identity_type":"nua_key","user_id":"7fe77405-a6de-43cf-ac27-ac09f80b66c6","account_id":"4f9285c7-7151-4431-94e6-3f1fb0d66aca","account_type":"v3enterprise","allow_kb_management":false},"ip_info":null}' headers: Alt-Svc: - h3=":443"; ma=2592000 @@ -27,11 +27,11 @@ interactions: content-type: - application/json date: - - Wed, 03 Jun 2026 07:59:40 GMT + - Mon, 13 Jul 2026 08:57:32 GMT via: - 1.1 google x-envoy-upstream-service-time: - - '5' + - '4' status: code: 200 message: OK diff --git a/hyperforge/tests/api/cassettes/test_session/test_arag_websocket_session_no_auto_create_existing_session.yaml b/hyperforge/tests/api/cassettes/test_session/test_arag_websocket_session_no_auto_create_existing_session.yaml index e963772..5bd4652 100644 --- a/hyperforge/tests/api/cassettes/test_session/test_arag_websocket_session_no_auto_create_existing_session.yaml +++ b/hyperforge/tests/api/cassettes/test_session/test_arag_websocket_session_no_auto_create_existing_session.yaml @@ -9,16 +9,16 @@ interactions: Connection: - keep-alive Host: - - europe-1.nuclia.cloud + - europe-1.dp.progress.cloud User-Agent: - - nuclia.py/4.9.25 + - nuclia.py/4.11.5 x-nuclia-nuakey: - DUMMY method: GET - uri: https://europe-1.nuclia.cloud/api/authorizer/info + uri: https://europe-1.dp.progress.cloud/api/authorizer/info response: body: - string: '{"auth":"nua_key","user":{"identity_type":"nua_key","user_id":"03d47998-f672-4a9b-a57b-bde3a9c3ee8c","account_id":"4f9285c7-7151-4431-94e6-3f1fb0d66aca","account_type":"v3enterprise","allow_kb_management":false},"ip_info":null}' + string: '{"auth":"nua_key","user":{"identity_type":"nua_key","user_id":"7fe77405-a6de-43cf-ac27-ac09f80b66c6","account_id":"4f9285c7-7151-4431-94e6-3f1fb0d66aca","account_type":"v3enterprise","allow_kb_management":false},"ip_info":null}' headers: Alt-Svc: - h3=":443"; ma=2592000 @@ -27,11 +27,11 @@ interactions: content-type: - application/json date: - - Wed, 03 Jun 2026 07:59:42 GMT + - Mon, 13 Jul 2026 08:57:35 GMT via: - 1.1 google x-envoy-upstream-service-time: - - '5' + - '4' status: code: 200 message: OK diff --git a/hyperforge/tests/cassettes/test_next/test_nucliadb_next.yaml b/hyperforge/tests/cassettes/test_next/test_nucliadb_next.yaml index 54c4acb..59ef98f 100644 --- a/hyperforge/tests/cassettes/test_next/test_nucliadb_next.yaml +++ b/hyperforge/tests/cassettes/test_next/test_nucliadb_next.yaml @@ -9,29 +9,29 @@ interactions: Connection: - keep-alive Host: - - europe-1.nuclia.cloud + - europe-1.dp.progress.cloud User-Agent: - - nuclia.py/4.9.25 + - nuclia.py/4.11.5 x-nuclia-nuakey: - DUMMY method: GET - uri: https://europe-1.nuclia.cloud/api/authorizer/info + uri: https://europe-1.dp.progress.cloud/api/authorizer/info response: body: - string: '{"auth":"nua_key","user":{"identity_type":"nua_key","user_id":"03d47998-f672-4a9b-a57b-bde3a9c3ee8c","account_id":"4f9285c7-7151-4431-94e6-3f1fb0d66aca","account_type":"v3enterprise","allow_kb_management":false},"ip_info":null}' + string: '{"auth":"nua_key","user":{"identity_type":"nua_key","user_id":"7fe77405-a6de-43cf-ac27-ac09f80b66c6","account_id":"4f9285c7-7151-4431-94e6-3f1fb0d66aca","account_type":"v3enterprise","allow_kb_management":false},"ip_info":null}' headers: Alt-Svc: - - h3=":443"; ma=2592000 + - h3=":443"; ma=2592000,h3-29=":443"; ma=2592000 Content-Length: - '227' content-type: - application/json date: - - Wed, 03 Jun 2026 07:59:55 GMT + - Mon, 13 Jul 2026 08:57:49 GMT via: - 1.1 google x-envoy-upstream-service-time: - - '5' + - '4' status: code: 200 message: OK @@ -77,13 +77,13 @@ interactions: Content-Type: - application/json Host: - - europe-1.nuclia.cloud + - europe-1.dp.progress.cloud User-Agent: - - nuclia.py/4.9.25 + - nuclia.py/4.11.5 x-client-ident: - default x-message: - - 964d18282cf3423fb46939adc1e116d6 + - 7dec54e352084b60b49596da46939cb3 x-origin: - RAO x-session: @@ -93,27 +93,29 @@ interactions: x-stf-nuakey: - DUMMY method: POST - uri: https://europe-1.nuclia.cloud/api/v1/predict/chat + uri: https://europe-1.dp.progress.cloud/api/v1/predict/chat response: body: - string: '{"chunk":{"type":"object","object":{"rephrased_question":"What is the - purpose and usage of `max_tokens` in Nuclia, and what is a Cardamom bun?","rules":["Provide - a clear explanation of `max_tokens` within the context of Nuclia.","Define - what a Cardamom bun is."],"reason":"The original question combines two distinct - topics: a technical parameter in Nuclia and a culinary item. Rephrasing separates - these into a more direct query for each, improving clarity and ensuring both - parts of the original question are addressed distinctly."}}} + string: '{"chunk":{"type":"object","object":{"rephrased_question":"How is `max_tokens` + utilized within the Nuclia system, and what is a Cardamom bun?","rules":["Explain + the function and application of `max_tokens` specifically in the context of + Nuclia.","Provide a definition and description of a Cardamom bun."],"reason":"The + original question combines two distinct and unrelated queries. Rephrasing + separates them to ensure each part is addressed clearly and independently. + The first part is made more specific by explicitly mentioning ''within the + Nuclia system'' to guide the retrieval process towards relevant documentation + or information about Nuclia''s configuration or API."}}} {"chunk":{"type":"status","code":"0"}} - {"chunk":{"type":"meta","input_tokens":7,"output_tokens":10,"timings":{"generative":0.8410087140000542},"input_nuclia_tokens":0.007,"output_nuclia_tokens":0.01}} + {"chunk":{"type":"meta","input_tokens":7,"output_tokens":12,"timings":{"generative":1.195755454013124},"input_nuclia_tokens":0.007,"output_nuclia_tokens":0.012}} - {"chunk":{"normalized_tokens":{"input":0.00706,"output":0.01048,"image":0.0},"customer_key_tokens":{"input":0.0,"output":0.0,"image":0.0},"type":"consumption"}} + {"chunk":{"normalized_tokens":{"input":0.00706,"output":0.01192,"image":0.0},"customer_key_tokens":{"input":0.0,"output":0.0,"image":0.0},"type":"consumption"}} ' headers: Alt-Svc: - - h3=":443"; ma=2592000,h3-29=":443"; ma=2592000 + - h3=":443"; ma=2592000 Transfer-Encoding: - chunked access-control-expose-headers: @@ -121,63 +123,17 @@ interactions: content-type: - application/x-ndjson date: - - Wed, 03 Jun 2026 07:59:56 GMT + - Mon, 13 Jul 2026 08:57:49 GMT nuclia-learning-id: - - 0ea5449794ea449f9127813fd6b8eb25 + - e6c00660eb7d413cb70eb3849513e753 nuclia-learning-model: - gemini-2.5-flash-lite via: - 1.1 google x-envoy-upstream-service-time: - - '847' + - '1203' x-nuclia-trace-id: - - 83e268305c46ac3f0e32533423d38b9f - status: - code: 200 - message: OK -- request: - body: '' - headers: - Accept: - - '*/*' - Accept-Encoding: - - gzip, deflate - Connection: - - keep-alive - Host: - - europe-1.rag.progress.cloud - User-Agent: - - nucliadb-sdk/6.13.1.post6414 - content-type: - - application/json - x-stf-serviceaccount: - - DUMMY - method: GET - uri: https://europe-1.rag.progress.cloud/api/v1/kb/df8b4c24-2807-4888-ad6c-ae97357a638b/labelsets - response: - body: - string: '{"uuid":"df8b4c24-2807-4888-ad6c-ae97357a638b","labelsets":{"pmm":{"title":"pmm","color":"#DAF3E6","multiple":true,"kind":["RESOURCES"],"labels":[{"title":"Videos","related":"","text":"","uri":""},{"title":"Partner - Content","related":"","text":"","uri":""},{"title":"Softcat","related":"","text":"","uri":""},{"title":"Sales - Enablement Assets","related":"","text":"","uri":""},{"title":"KO 26","related":"","text":"","uri":""},{"title":"Data - Sheets","related":"","text":"","uri":""},{"title":"Progress Agentic RAG Training - Materials 2026","related":"","text":"","uri":""}]}}}' - headers: - Alt-Svc: - - h3=":443"; ma=2592000 - Content-Length: - - '575' - access-control-expose-headers: - - X-NUCLIA-TRACE-ID - content-type: - - application/json - date: - - Wed, 03 Jun 2026 07:59:57 GMT - via: - - 1.1 google - x-envoy-upstream-service-time: - - '11' - x-nuclia-trace-id: - - 2f847067d88986820ae6e18cfde1ec37 + - 1254533b4a45add290d5b1ea9a6e6c14 status: code: 200 message: OK @@ -206,7 +162,7 @@ interactions: Docs","description":"","learning_configuration":null,"external_index_provider":null,"configured_external_index_provider":{"type":"unset"},"similarity":null,"hidden_resources_enabled":false,"hidden_resources_hide_on_creation":false,"enforce_security":false},"model":null}' headers: Alt-Svc: - - h3=":443"; ma=2592000 + - h3=":443"; ma=2592000,h3-29=":443"; ma=2592000 Content-Length: - '434' access-control-expose-headers: @@ -214,18 +170,18 @@ interactions: content-type: - application/json date: - - Wed, 03 Jun 2026 07:59:56 GMT + - Mon, 13 Jul 2026 08:57:51 GMT via: - 1.1 google x-envoy-upstream-service-time: - - '6' + - '11' x-nuclia-trace-id: - - 902c42f4e990f21ec865277c82c407d8 + - 9b977c782a47742f93e10284cf1de492 status: code: 200 message: OK - request: - body: '{"prefixes": [{"prefix": "/n/i", "depth": 2}]}' + body: '{"prefixes": [{"prefix": "/s/p"}]}' headers: Accept: - '*/*' @@ -234,7 +190,7 @@ interactions: Connection: - keep-alive Content-Length: - - '42' + - '32' Host: - europe-1.rag.progress.cloud User-Agent: @@ -247,24 +203,24 @@ interactions: uri: https://europe-1.rag.progress.cloud/api/v1/kb/df8b4c24-2807-4888-ad6c-ae97357a638b/catalog/facets response: body: - string: '{"facets":{"/n/i":974,"/n/i/text":974,"/n/i/text/markdown":974}}' + string: '{"facets":{"/s/p":986,"/s/p/ca":3,"/s/p/cy":1,"/s/p/da":1,"/s/p/en":967,"/s/p/eo":4,"/s/p/la":7,"/s/p/nb":1,"/s/p/tl":1,"/s/p/yo":1}}' headers: Alt-Svc: - h3=":443"; ma=2592000,h3-29=":443"; ma=2592000 Content-Length: - - '64' + - '133' access-control-expose-headers: - X-NUCLIA-TRACE-ID content-type: - application/json date: - - Wed, 03 Jun 2026 07:59:57 GMT + - Mon, 13 Jul 2026 08:57:51 GMT via: - 1.1 google x-envoy-upstream-service-time: - - '15' + - '20' x-nuclia-trace-id: - - cd479d21f196593cb870f6980f45a5d5 + - e5123d2b482bc0d3c41c1196c338f9ba status: code: 200 message: OK @@ -295,7 +251,7 @@ interactions: your question. Please contact us at support@nuclia.com\". ","prompt":""},"palm":null,"anthropic":null,"claude3":null,"anthropic_vertex":null,"anthropic_bedrock":null,"text_generation":null,"mistral":null,"azure_mistral":null,"hf_llm":null,"openai_url":null,"vertex_llama":null,"deepseek":null,"openai_compat":null,"nova":null},"summary":"simple","summary_model":"claude-4-5-sonnet","summary_prompt":null,"prefer_markdown_generative_response":false,"allow_all_default_models":true,"semantic_model_configs":{"multilingual-2024-05-06":{"similarity":0,"size":1024,"threshold":0.4,"max_tokens":2048,"matryoshka_dims":[],"external":false}},"semantic_graph_node_model_configs":{},"semantic_graph_edge_model_configs":{}}' headers: Alt-Svc: - - h3=":443"; ma=2592000,h3-29=":443"; ma=2592000 + - h3=":443"; ma=2592000 Content-Length: - '1814' access-control-expose-headers: @@ -303,18 +259,18 @@ interactions: content-type: - application/json date: - - Wed, 03 Jun 2026 07:59:56 GMT,Wed, 03 Jun 2026 07:59:56 GMT + - Mon, 13 Jul 2026 08:57:50 GMT,Mon, 13 Jul 2026 08:57:51 GMT via: - 1.1 google x-envoy-upstream-service-time: - - '42' + - '44' x-nuclia-trace-id: - - 082ad98562c2f40966c0be84edfa7df7 + - 6e438c7300d00121d60aa6a4c00631b9 status: code: 200 message: OK - request: - body: '{"prefixes": [{"prefix": "/l", "depth": 2}]}' + body: '{"features": ["keyword"], "faceted": ["/classification.labels"]}' headers: Accept: - '*/*' @@ -323,7 +279,7 @@ interactions: Connection: - keep-alive Content-Length: - - '40' + - '61' Host: - europe-1.rag.progress.cloud User-Agent: @@ -333,32 +289,129 @@ interactions: x-stf-serviceaccount: - DUMMY method: POST - uri: https://europe-1.rag.progress.cloud/api/v1/kb/df8b4c24-2807-4888-ad6c-ae97357a638b/catalog/facets + uri: https://europe-1.rag.progress.cloud/api/v1/kb/df8b4c24-2807-4888-ad6c-ae97357a638b/search response: body: - string: '{"facets":{}}' + string: "{\"resources\":{\"b28e388104644fc5bba68c0cd44e01d4\":{\"id\":\"b28e388104644fc5bba68c0cd44e01d4\",\"slug\":\"docs-agentic-how-to-agentic-retrieval-md\",\"title\":\"docs + > agentic > how to > agentic retrieval\",\"summary\":\"\",\"icon\":\"text/markdown\",\"thumbnail\":\"\",\"metadata\":{\"metadata\":{},\"language\":\"en\",\"languages\":[\"en\"],\"status\":\"PROCESSED\"},\"usermetadata\":{\"classifications\":[]},\"fieldmetadata\":[],\"computedmetadata\":{\"field_classifications\":[]},\"created\":\"2026-06-29T13:39:03.379512\",\"modified\":\"2026-06-29T13:39:03.379525\",\"last_seqid\":0,\"last_account_seq\":null,\"queue\":\"private\",\"hidden\":false},\"2a0d73029ad24c599d6dc1e117a41897\":{\"id\":\"2a0d73029ad24c599d6dc1e117a41897\",\"slug\":\"docs-agentic-deploy-md\",\"title\":\"docs + > agentic > deploy\",\"summary\":\"\",\"icon\":\"text/markdown\",\"thumbnail\":\"\",\"metadata\":{\"metadata\":{},\"language\":\"en\",\"languages\":[\"en\"],\"status\":\"PROCESSED\"},\"usermetadata\":{\"classifications\":[]},\"fieldmetadata\":[],\"computedmetadata\":{\"field_classifications\":[]},\"created\":\"2026-06-29T13:39:02.557258\",\"modified\":\"2026-06-29T13:39:02.557276\",\"last_seqid\":0,\"last_account_seq\":null,\"queue\":\"private\",\"hidden\":false},\"007b445866574d7ca69891d388663cc6\":{\"id\":\"007b445866574d7ca69891d388663cc6\",\"slug\":\"docs-management-security-5-public-ips-md\",\"title\":\"docs + > management > security > 5 public ips\",\"summary\":\"\",\"icon\":\"text/markdown\",\"thumbnail\":\"\",\"metadata\":{\"metadata\":{},\"language\":\"en\",\"languages\":[\"en\"],\"status\":\"PROCESSED\"},\"usermetadata\":{\"classifications\":[]},\"fieldmetadata\":[],\"computedmetadata\":{\"field_classifications\":[]},\"created\":\"2026-07-03T09:28:57.937064\",\"modified\":\"2026-07-03T09:28:57.937076\",\"last_seqid\":0,\"last_account_seq\":null,\"queue\":\"private\",\"hidden\":false}},\"paragraphs\":{\"results\":[{\"score\":0.0,\"rid\":\"007b445866574d7ca69891d388663cc6\",\"field_type\":\"t\",\"field\":\"page\",\"text\":\" + Outbound \u2014 the source IP addresses that Progress Agentic RAG uses when + making connections to your systems (e.g., webhooks, sync agents, or other + integrations). Allowlist these if you restrict inbound traffic to your infrastructure. + \\n\",\"labels\":[],\"start_seconds\":null,\"end_seconds\":null,\"position\":{\"page_number\":0,\"index\":2,\"start\":418,\"end\":652},\"fuzzy_result\":false},{\"score\":0.0,\"rid\":\"007b445866574d7ca69891d388663cc6\",\"field_type\":\"t\",\"field\":\"page\",\"text\":\" + \\n :::note \\n The current list of IP addresses is also available in machine-readable + format: JSON | YAML. These lists may change over time, so we recommend periodically + fetching and applying updates to your firewall rules to ensure uninterrupted + service. \\n\",\"labels\":[],\"start_seconds\":null,\"end_seconds\":null,\"position\":{\"page_number\":0,\"index\":3,\"start\":652,\"end\":907},\"fuzzy_result\":false},{\"score\":0.0,\"rid\":\"007b445866574d7ca69891d388663cc6\",\"field_type\":\"t\",\"field\":\"page\",\"text\":\" + \\n id: public-ips \\n title: Public IP Addresses \\n \\n If your firewall + restricts network traffic, you may need to allowlist the following IP addresses. + They are grouped by region and split into two categories: \\n\",\"labels\":[],\"start_seconds\":null,\"end_seconds\":null,\"position\":{\"page_number\":0,\"index\":0,\"start\":0,\"end\":208},\"fuzzy_result\":false},{\"score\":0.0,\"rid\":\"007b445866574d7ca69891d388663cc6\",\"field_type\":\"t\",\"field\":\"page\",\"text\":\" + ::: \\n Europe (GCP) \\n | Inbound | Outbound | \\n | ------------------ | + --------------------- | \\n | 34.111.1.187/32 | 35.204.65.155/32 | \\n | 136.68.112.29/32 + | 34.91.38.151/32 | \\n | | 35.204.139.129/32 | \\n | | 35.204.108.221/32 + | \\n Australia (AWS) \\n | Inbound | Outbound | \\n | ------------------- + | --------------------- | \\n | 54.253.224.44/32 | 15.135.151.213/32 | \\n + | 3.25.20.9/32 | 3.24.144.83/32 | \\n | 52.64.202.159/32 | 3.24.81.206/32 + | \\n Europe (AWS) \\n | Inbound | Outbound | \\n | ------------------- | + --------------------- | \\n | 63.182.151.234/32 | 63.179.23.139/32 | \\n | + 35.159.36.135/32 | 3.78.13.149/32 | \\n | 52.57.40.91/32 | 3.66.123.24/32 + | \\n Israel (AWS) \\n | Inbound | Outbound | \\n | ------------------- | + --------------------- | \\n | 51.84.176.167/32 | 51.17.150.97/32 | \\n | 16.164.50.185/32 + | 51.84.112.203/32 | \\n | 16.164.85.69/32 | 51.17.212.226/32 | \\n United + States (AWS) \\n | Inbound | Outbound | \\n | -------------------- | -------------------- + | \\n | 18.225.228.199/32 | 3.137.28.168/32 | \\n | 18.119.145.185/32 | 18.225.104.91/32 + | \\n | 3.21.239.244/32 | 16.59.115.61/32 | \\n Private connectivity (AWS + PrivateLink) \\n For AWS-hosted regions, it is possible to expose access privately + through an AWS endpoint service (AWS PrivateLink) instead of over the public + internet, allowing connections to be established from your VPC without traversing + public IP addresses. This option is not available through self-service configuration. + Please reach out to your account manager for details.\",\"labels\":[],\"start_seconds\":null,\"end_seconds\":null,\"position\":{\"page_number\":0,\"index\":4,\"start\":907,\"end\":2402},\"fuzzy_result\":false},{\"score\":0.0,\"rid\":\"007b445866574d7ca69891d388663cc6\",\"field_type\":\"t\",\"field\":\"page\",\"text\":\" + \\n Inbound \u2014 the IP addresses that Progress Agentic RAG receives requests + on. Allowlist these if you restrict outbound traffic from your infrastructure + and need to reach our services (e.g., calling our APIs). \\n\",\"labels\":[],\"start_seconds\":null,\"end_seconds\":null,\"position\":{\"page_number\":0,\"index\":1,\"start\":208,\"end\":418},\"fuzzy_result\":false},{\"score\":0.0,\"rid\":\"007b445866574d7ca69891d388663cc6\",\"field_type\":\"a\",\"field\":\"title\",\"text\":\"docs + > management > security > 5 public ips\",\"labels\":[],\"start_seconds\":null,\"end_seconds\":null,\"position\":{\"page_number\":0,\"index\":0,\"start\":0,\"end\":43},\"fuzzy_result\":false},{\"score\":0.0,\"rid\":\"b28e388104644fc5bba68c0cd44e01d4\",\"field_type\":\"a\",\"field\":\"title\",\"text\":\"docs + > agentic > how to > agentic retrieval\",\"labels\":[],\"start_seconds\":null,\"end_seconds\":null,\"position\":{\"page_number\":0,\"index\":0,\"start\":0,\"end\":43},\"fuzzy_result\":false},{\"score\":0.0,\"rid\":\"b28e388104644fc5bba68c0cd44e01d4\",\"field_type\":\"t\",\"field\":\"page\",\"text\":\" + \\n id: agentic-retrieval \\n title: Agentic retrieval with the Smart agent + \\n \\n Agentic retrieval with the Smart agent \\n The Smart agent is a powerful + tool that enhances the capabilities of traditional retrieval-augmented generation + (RAG) systems. Regular RAG's fixed search-then-generate process is limiting + for complex questions that need intermediary steps and reasoning. \\n\",\"labels\":[],\"start_seconds\":null,\"end_seconds\":null,\"position\":{\"page_number\":0,\"index\":0,\"start\":0,\"end\":373},\"fuzzy_result\":false},{\"score\":0.0,\"rid\":\"b28e388104644fc5bba68c0cd44e01d4\",\"field_type\":\"t\",\"field\":\"page\",\"text\":\" + \\n Different models can be chosen for different tasks: \\n \\n Context validation + happens when the Prune context option is enabled (recommended), we recommend + using a fast model - planning or the execution model (depending on the planning + mode you have selected): we recommend using a more powerful model. \\n\",\"labels\":[],\"start_seconds\":null,\"end_seconds\":null,\"position\":{\"page_number\":0,\"index\":5,\"start\":1640,\"end\":1943},\"fuzzy_result\":false},{\"score\":0.0,\"rid\":\"b28e388104644fc5bba68c0cd44e01d4\",\"field_type\":\"t\",\"field\":\"page\",\"text\":\" + \\n Note: the rephrasing model is only used in more complex workflow, it can + be ignored in the present case. \\n Finally, add a Summarize agent in the + Generation step to generate a final answer from the retrieved information. + \\n\",\"labels\":[],\"start_seconds\":null,\"end_seconds\":null,\"position\":{\"page_number\":0,\"index\":6,\"start\":1943,\"end\":2167},\"fuzzy_result\":false},{\"score\":0.0,\"rid\":\"b28e388104644fc5bba68c0cd44e01d4\",\"field_type\":\"t\",\"field\":\"page\",\"text\":\" + The Smart Agent plans the answer: picks the most appropriate sources, splits + the question into sub-questions, evaluates relevancy, and iterates autonomously + until the information is sufficient. \\n Basic usage \\n To set up a Smart + Agent, declare all the sources you want to use (Knowledge Boxes, Perplexity, + etc.) in the Sources section of the left menu. Then, create a new workflow + in the Workflows section and add a Smart Agent in the Retrieval step. \\n\",\"labels\":[],\"start_seconds\":null,\"end_seconds\":null,\"position\":{\"page_number\":0,\"index\":1,\"start\":373,\"end\":825},\"fuzzy_result\":false},{\"score\":0.0,\"rid\":\"b28e388104644fc5bba68c0cd44e01d4\",\"field_type\":\"t\",\"field\":\"page\",\"text\":\" + Chat mode \\n If you want to use the Smart Agent in a chat interface, you + need the following: \\n \\n Enable the Session history option in the Smart + Agent configuration. This will allow the Smart Agent to take into account + the previous conversation when planning its next steps. \\n\",\"labels\":[],\"start_seconds\":null,\"end_seconds\":null,\"position\":{\"page_number\":0,\"index\":7,\"start\":2167,\"end\":2442},\"fuzzy_result\":false},{\"score\":0.0,\"rid\":\"b28e388104644fc5bba68c0cd44e01d4\",\"field_type\":\"t\",\"field\":\"page\",\"text\":\" + Then connect your sources as Registered Agents to the Smart Agent. It is very + important that you provide an extensive description of each registered agent, + so that the Smart Agent can understand what each source is about and when + to use it. \\n\",\"labels\":[],\"start_seconds\":null,\"end_seconds\":null,\"position\":{\"page_number\":0,\"index\":2,\"start\":825,\"end\":1068},\"fuzzy_result\":false},{\"score\":0.0,\"rid\":\"b28e388104644fc5bba68c0cd44e01d4\",\"field_type\":\"t\",\"field\":\"page\",\"text\":\" + \\n reactive: The Smart Agent will decide what to do first, and will plan + the next steps based on the information it retrieves. It is expected to be + faster. \\n plan_execute: The Smart Agent will plan all the steps in advance, + and will execute them. It will be slower but more accurate when processing + complex questions. \\n\",\"labels\":[],\"start_seconds\":null,\"end_seconds\":null,\"position\":{\"page_number\":0,\"index\":4,\"start\":1321,\"end\":1640},\"fuzzy_result\":false},{\"score\":0.0,\"rid\":\"b28e388104644fc5bba68c0cd44e01d4\",\"field_type\":\"t\",\"field\":\"page\",\"text\":\" + Also select the proper function for each registered agent, depending on the + type of source (MCP agents will not need one, the functions are provided dynamically + by the MCP server). \\n In the Smart Agent configuration, you can select the + planning mode: \\n\",\"labels\":[],\"start_seconds\":null,\"end_seconds\":null,\"position\":{\"page_number\":0,\"index\":3,\"start\":1068,\"end\":1321},\"fuzzy_result\":false},{\"score\":0.0,\"rid\":\"b28e388104644fc5bba68c0cd44e01d4\",\"field_type\":\"t\",\"field\":\"page\",\"text\":\" + In the Summarize Agent, enable the Conversational mode. This will allow the + Summarize Agent to generate a final answer that will not repeat the information + already provided in the previous conversation, and will be more natural for + a chat interface. \\n\",\"labels\":[],\"start_seconds\":null,\"end_seconds\":null,\"position\":{\"page_number\":0,\"index\":8,\"start\":2442,\"end\":2694},\"fuzzy_result\":false},{\"score\":0.0,\"rid\":\"2a0d73029ad24c599d6dc1e117a41897\",\"field_type\":\"t\",\"field\":\"page\",\"text\":\" + Custom frontend \\n You can also create a custom frontend for your Retrieval + Agent. This allows you to have full control over the user interface and user + experience. \\n You can directly implement the API calls to your Retrieval + Agent in your frontend code (see the Websocket API section for more details), + or you can use the JavaScript SDK provided by Agentic to simplify the integration. + \\n\",\"labels\":[],\"start_seconds\":null,\"end_seconds\":null,\"position\":{\"page_number\":0,\"index\":2,\"start\":617,\"end\":1005},\"fuzzy_result\":false},{\"score\":0.0,\"rid\":\"2a0d73029ad24c599d6dc1e117a41897\",\"field_type\":\"t\",\"field\":\"page\",\"text\":\" + MCP \\n If you want to integrate your Retrieval Agent with a broader AI-based + system (for example Claude Cowork or Copilot), it is reachable throught MCP. + \\n The MCP endpoint is visible on the agent home page on the dashboard.\",\"labels\":[],\"start_seconds\":null,\"end_seconds\":null,\"position\":{\"page_number\":0,\"index\":3,\"start\":1005,\"end\":1230},\"fuzzy_result\":false},{\"score\":0.0,\"rid\":\"2a0d73029ad24c599d6dc1e117a41897\",\"field_type\":\"t\",\"field\":\"page\",\"text\":\" + \\n id: deploy \\n title: Deploy \\n \\n Deploy \\n Your Agentic Retrieval + Agent can be deployed in different ways, depending on your needs and the environment + you are working in. \\n Ready-to-use widget \\n The easiest way to deploy + your Retrieval Agent is to use the ready-to-use widget. You can embed it in + your website or application, and it will provide a chat user interface for + interacting with the agent. \\n\",\"labels\":[],\"start_seconds\":null,\"end_seconds\":null,\"position\":{\"page_number\":0,\"index\":0,\"start\":0,\"end\":401},\"fuzzy_result\":false},{\"score\":0.0,\"rid\":\"2a0d73029ad24c599d6dc1e117a41897\",\"field_type\":\"t\",\"field\":\"page\",\"text\":\" + Go to the Widgets section in the left menu, and click on Create widget to + create a new widget. You can customize its appearance, and then copy the generated + code snippet to embed it in your website or application. \\n\",\"labels\":[],\"start_seconds\":null,\"end_seconds\":null,\"position\":{\"page_number\":0,\"index\":1,\"start\":401,\"end\":617},\"fuzzy_result\":false}],\"facets\":{},\"query\":\"\",\"total\":5294,\"page_number\":0,\"page_size\":20,\"next_page\":true,\"min_score\":0.0},\"shards\":[\"306cbabb-72a5-417c-827f-7874e205c858\"]}" headers: Alt-Svc: - - h3=":443"; ma=2592000,h3-29=":443"; ma=2592000 + - h3=":443"; ma=2592000 Content-Length: - - '13' + - '12993' access-control-expose-headers: - X-NUCLIA-TRACE-ID content-type: - application/json date: - - Wed, 03 Jun 2026 07:59:57 GMT + - Mon, 13 Jul 2026 08:57:51 GMT via: - 1.1 google x-envoy-upstream-service-time: - - '37' + - '57' x-nuclia-trace-id: - - 6213640a3a5d859ad7721e80e52adc78 + - 073aaf18ae2f2f4627dadcad223fe641 status: code: 200 message: OK - request: - body: '{"prefixes": [{"prefix": "/s/p", "depth": 2}]}' + body: '' headers: Accept: - '*/*' @@ -366,8 +419,6 @@ interactions: - gzip, deflate Connection: - keep-alive - Content-Length: - - '42' Host: - europe-1.rag.progress.cloud User-Agent: @@ -376,33 +427,37 @@ interactions: - application/json x-stf-serviceaccount: - DUMMY - method: POST - uri: https://europe-1.rag.progress.cloud/api/v1/kb/df8b4c24-2807-4888-ad6c-ae97357a638b/catalog/facets + method: GET + uri: https://europe-1.rag.progress.cloud/api/v1/kb/df8b4c24-2807-4888-ad6c-ae97357a638b/labelsets response: body: - string: '{"facets":{"/s/p":974,"/s/p/ca":3,"/s/p/cy":1,"/s/p/da":1,"/s/p/en":955,"/s/p/eo":4,"/s/p/la":7,"/s/p/nb":1,"/s/p/tl":1,"/s/p/yo":1}}' + string: '{"uuid":"df8b4c24-2807-4888-ad6c-ae97357a638b","labelsets":{"pmm":{"title":"pmm","color":"#DAF3E6","multiple":true,"kind":["RESOURCES"],"labels":[{"title":"Videos","related":"","text":"","uri":""},{"title":"Partner + Content","related":"","text":"","uri":""},{"title":"Softcat","related":"","text":"","uri":""},{"title":"Sales + Enablement Assets","related":"","text":"","uri":""},{"title":"KO 26","related":"","text":"","uri":""},{"title":"Data + Sheets","related":"","text":"","uri":""},{"title":"Progress Agentic RAG Training + Materials 2026","related":"","text":"","uri":""}]}}}' headers: Alt-Svc: - - h3=":443"; ma=2592000 + - h3=":443"; ma=2592000,h3-29=":443"; ma=2592000 Content-Length: - - '133' + - '575' access-control-expose-headers: - X-NUCLIA-TRACE-ID content-type: - application/json date: - - Wed, 03 Jun 2026 07:59:57 GMT + - Mon, 13 Jul 2026 08:57:51 GMT via: - 1.1 google x-envoy-upstream-service-time: - - '37' + - '18' x-nuclia-trace-id: - - f9ce452b6903cbebb3ec3dc27f29b11d + - 12724d050006127eaf70867fb05b532c status: code: 200 message: OK - request: - body: '' + body: '{"prefixes": [{"prefix": "/n/i"}]}' headers: Accept: - '*/*' @@ -410,6 +465,8 @@ interactions: - gzip, deflate Connection: - keep-alive + Content-Length: + - '32' Host: - europe-1.rag.progress.cloud User-Agent: @@ -418,37 +475,33 @@ interactions: - application/json x-stf-serviceaccount: - DUMMY - method: GET - uri: https://europe-1.rag.progress.cloud/api/v1/kb/df8b4c24-2807-4888-ad6c-ae97357a638b/labelset/pmm + method: POST + uri: https://europe-1.rag.progress.cloud/api/v1/kb/df8b4c24-2807-4888-ad6c-ae97357a638b/catalog/facets response: body: - string: '{"title":"pmm","color":"#DAF3E6","multiple":true,"kind":["RESOURCES"],"labels":[{"title":"Videos","related":"","text":"","uri":""},{"title":"Partner - Content","related":"","text":"","uri":""},{"title":"Softcat","related":"","text":"","uri":""},{"title":"Sales - Enablement Assets","related":"","text":"","uri":""},{"title":"KO 26","related":"","text":"","uri":""},{"title":"Data - Sheets","related":"","text":"","uri":""},{"title":"Progress Agentic RAG Training - Materials 2026","related":"","text":"","uri":""}]}' + string: '{"facets":{"/n/i":986,"/n/i/application":1,"/n/i/application/json":1,"/n/i/text":985,"/n/i/text/markdown":985}}' headers: Alt-Svc: - h3=":443"; ma=2592000,h3-29=":443"; ma=2592000 Content-Length: - - '507' + - '111' access-control-expose-headers: - X-NUCLIA-TRACE-ID content-type: - application/json date: - - Wed, 03 Jun 2026 07:59:57 GMT + - Mon, 13 Jul 2026 08:57:51 GMT via: - 1.1 google x-envoy-upstream-service-time: - - '10' + - '19' x-nuclia-trace-id: - - 8b35b3a39a8e64676578a0abbae6b8c3 + - a85cab51bb10c674c0afad91a952441e status: code: 200 message: OK - request: - body: '{"features": ["keyword"], "faceted": ["/classification.labels"]}' + body: '' headers: Accept: - '*/*' @@ -456,8 +509,6 @@ interactions: - gzip, deflate Connection: - keep-alive - Content-Length: - - '61' Host: - europe-1.rag.progress.cloud User-Agent: @@ -466,91 +517,32 @@ interactions: - application/json x-stf-serviceaccount: - DUMMY - method: POST - uri: https://europe-1.rag.progress.cloud/api/v1/kb/df8b4c24-2807-4888-ad6c-ae97357a638b/search + method: GET + uri: https://europe-1.rag.progress.cloud/api/v1/kb/df8b4c24-2807-4888-ad6c-ae97357a638b/labelset/pmm response: body: - string: "{\"resources\":{\"256f6b95e3fb476c8f47b6b057d02fa0\":{\"id\":\"256f6b95e3fb476c8f47b6b057d02fa0\",\"slug\":\"docs-management-security-5-outbound-ips-md\",\"title\":\"docs - > management > security > 5 outbound ips\",\"summary\":\"\",\"icon\":\"text/markdown\",\"thumbnail\":\"\",\"metadata\":{\"metadata\":{},\"language\":\"en\",\"languages\":[\"en\"],\"status\":\"PROCESSED\"},\"usermetadata\":{\"classifications\":[]},\"fieldmetadata\":[],\"computedmetadata\":{\"field_classifications\":[]},\"created\":\"2026-05-28T15:19:46.250570\",\"modified\":\"2026-05-28T15:25:35.444730\",\"last_seqid\":0,\"last_account_seq\":null,\"queue\":\"private\",\"hidden\":false},\"f539dfaa013a45d6a0e319bc7288ff07\":{\"id\":\"f539dfaa013a45d6a0e319bc7288ff07\",\"slug\":\"docs-develop-js-sdk-interfaces-SuggestOptions-md\",\"title\":\"docs - > develop > js sdk > interfaces > SuggestOptions\",\"summary\":\"\",\"icon\":\"text/markdown\",\"thumbnail\":\"\",\"metadata\":{\"metadata\":{},\"language\":\"en\",\"languages\":[\"en\"],\"status\":\"PROCESSED\"},\"usermetadata\":{\"classifications\":[]},\"fieldmetadata\":[],\"computedmetadata\":{\"field_classifications\":[]},\"created\":\"2026-05-28T15:15:28.795386\",\"modified\":\"2026-06-02T15:41:12.907729\",\"last_seqid\":0,\"last_account_seq\":null,\"queue\":\"private\",\"hidden\":false},\"af442e9be6484c44a4a1dbc396e38dca\":{\"id\":\"af442e9be6484c44a4a1dbc396e38dca\",\"slug\":\"docs-develop-js-sdk-interfaces-KBKVSchemas-md\",\"title\":\"docs - > develop > js sdk > interfaces > KBKVSchemas\",\"summary\":\"\",\"icon\":\"text/markdown\",\"thumbnail\":\"\",\"metadata\":{\"metadata\":{},\"language\":\"en\",\"languages\":[\"en\"],\"status\":\"PROCESSED\"},\"usermetadata\":{\"classifications\":[]},\"fieldmetadata\":[],\"computedmetadata\":{\"field_classifications\":[]},\"created\":\"2026-05-22T07:20:55.157941\",\"modified\":\"2026-06-02T15:39:32.412772\",\"last_seqid\":0,\"last_account_seq\":null,\"queue\":\"private\",\"hidden\":false},\"701e9133181a4002bc373eaa1254daf8\":{\"id\":\"701e9133181a4002bc373eaa1254daf8\",\"slug\":\"docs-develop-js-sdk-interfaces-KeyValueFieldData-md\",\"title\":\"docs - > develop > js sdk > interfaces > KeyValueFieldData\",\"summary\":\"\",\"icon\":\"text/markdown\",\"thumbnail\":\"\",\"metadata\":{\"metadata\":{},\"language\":\"en\",\"languages\":[\"en\"],\"status\":\"PROCESSED\"},\"usermetadata\":{\"classifications\":[]},\"fieldmetadata\":[],\"computedmetadata\":{\"field_classifications\":[]},\"created\":\"2026-05-22T07:20:34.954997\",\"modified\":\"2026-06-02T15:39:59.839882\",\"last_seqid\":0,\"last_account_seq\":null,\"queue\":\"private\",\"hidden\":false},\"e88f4784ecb144bf87be0b7e543cb7ef\":{\"id\":\"e88f4784ecb144bf87be0b7e543cb7ef\",\"slug\":\"docs-develop-js-sdk-interfaces-KVSchema-md\",\"title\":\"docs - > develop > js sdk > interfaces > KVSchema\",\"summary\":\"\",\"icon\":\"text/markdown\",\"thumbnail\":\"\",\"metadata\":{\"metadata\":{},\"language\":\"en\",\"languages\":[\"en\"],\"status\":\"PROCESSED\"},\"usermetadata\":{\"classifications\":[]},\"fieldmetadata\":[],\"computedmetadata\":{\"field_classifications\":[]},\"created\":\"2026-05-22T07:19:11.438434\",\"modified\":\"2026-06-02T15:41:23.157239\",\"last_seqid\":0,\"last_account_seq\":null,\"queue\":\"private\",\"hidden\":false},\"7d409453a7584981beaeb2944e4560f5\":{\"id\":\"7d409453a7584981beaeb2944e4560f5\",\"slug\":\"docs-develop-js-sdk-interfaces-KVSchemaField-md\",\"title\":\"docs - > develop > js sdk > interfaces > KVSchemaField\",\"summary\":\"\",\"icon\":\"text/markdown\",\"thumbnail\":\"\",\"metadata\":{\"metadata\":{},\"language\":\"en\",\"languages\":[\"en\"],\"status\":\"PROCESSED\"},\"usermetadata\":{\"classifications\":[]},\"fieldmetadata\":[],\"computedmetadata\":{\"field_classifications\":[]},\"created\":\"2026-05-22T07:19:07.225437\",\"modified\":\"2026-06-02T15:40:07.299545\",\"last_seqid\":0,\"last_account_seq\":null,\"queue\":\"private\",\"hidden\":false},\"97fa1944fdbe4e99a9e482179dc344ed\":{\"id\":\"97fa1944fdbe4e99a9e482179dc344ed\",\"slug\":\"docs-develop-js-sdk-type-aliases-KVValue-md\",\"title\":\"docs - > develop > js sdk > type aliases > KVValue\",\"summary\":\"\",\"icon\":\"text/markdown\",\"thumbnail\":\"\",\"metadata\":{\"metadata\":{},\"language\":\"en\",\"languages\":[\"en\"],\"status\":\"PROCESSED\"},\"usermetadata\":{\"classifications\":[]},\"fieldmetadata\":[],\"computedmetadata\":{\"field_classifications\":[]},\"created\":\"2026-05-22T07:16:23.940364\",\"modified\":\"2026-06-02T15:38:57.624998\",\"last_seqid\":0,\"last_account_seq\":null,\"queue\":\"private\",\"hidden\":false}},\"paragraphs\":{\"results\":[{\"score\":0.0,\"rid\":\"256f6b95e3fb476c8f47b6b057d02fa0\",\"field_type\":\"t\",\"field\":\"page\",\"text\":\" - Europe (AWS) \\n \\n 63.179.23.139/32 \\n 3.78.13.149/32 \\n 3.66.123.24/32 - \\n \\n Europe (GCP) \\n \\n 35.204.65.155/32 \\n 34.91.38.151/32 \\n 35.204.139.129/32 - \\n 35.204.108.221/32 \\n \\n Israel \\n \\n 51.17.150.97/32 \\n \\n United - States \\n \\n 3.137.28.168/32 \\n \",\"labels\":[],\"position\":{\"page_number\":0,\"index\":1,\"start\":341,\"end\":578},\"fuzzy_result\":false},{\"score\":0.0,\"rid\":\"256f6b95e3fb476c8f47b6b057d02fa0\",\"field_type\":\"t\",\"field\":\"page\",\"text\":\" - \\n id: outbound-ips \\n title: Outbound IP Addresses \\n \\n If your firewall - blocks inbound requests from the internet, you may need to allowlist the following - IP addresses. These are the source IPs that Progress Agentic RAG uses when - making outbound connections (e.g., webhooks, sync agents, or other integrations - calling your infrastructure). \\n\",\"labels\":[],\"position\":{\"page_number\":0,\"index\":0,\"start\":0,\"end\":341},\"fuzzy_result\":false},{\"score\":0.0,\"rid\":\"256f6b95e3fb476c8f47b6b057d02fa0\",\"field_type\":\"a\",\"field\":\"title\",\"text\":\"docs - > management > security > 5 outbound ips\",\"labels\":[],\"position\":{\"page_number\":0,\"index\":0,\"start\":0,\"end\":45},\"fuzzy_result\":false},{\"score\":0.0,\"rid\":\"f539dfaa013a45d6a0e319bc7288ff07\",\"field_type\":\"t\",\"field\":\"page\",\"text\":\" - \\n optional security: object \\n \\n groups \\n \\n groups: string[] \\n - \\n Defined in \\n libs/sdk-core/src/lib/db/search/search.models.ts:166 \\n - \\n show_hidden? \\n \\n optional show_hidden: boolean \\n \\n Defined in - \\n libs/sdk-core/src/lib/db/search/search.models.ts:165\",\"labels\":[],\"position\":{\"page_number\":0,\"index\":1,\"start\":225,\"end\":477},\"fuzzy_result\":false},{\"score\":0.0,\"rid\":\"f539dfaa013a45d6a0e319bc7288ff07\",\"field_type\":\"t\",\"field\":\"page\",\"text\":\"@nuclia/core - \u2022 Docs \\n \\n @nuclia/core / SuggestOptions \\n Interface: SuggestOptions - \\n Properties \\n highlight? \\n \\n optional highlight: boolean \\n \\n - Defined in \\n libs/sdk-core/src/lib/db/search/search.models.ts:164 \\n \\n - security? \\n\",\"labels\":[],\"position\":{\"page_number\":0,\"index\":0,\"start\":0,\"end\":225},\"fuzzy_result\":false},{\"score\":0.0,\"rid\":\"f539dfaa013a45d6a0e319bc7288ff07\",\"field_type\":\"a\",\"field\":\"title\",\"text\":\"docs - > develop > js sdk > interfaces > SuggestOptions\",\"labels\":[],\"position\":{\"page_number\":0,\"index\":0,\"start\":0,\"end\":53},\"fuzzy_result\":false},{\"score\":0.0,\"rid\":\"af442e9be6484c44a4a1dbc396e38dca\",\"field_type\":\"a\",\"field\":\"title\",\"text\":\"docs - > develop > js sdk > interfaces > KBKVSchemas\",\"labels\":[],\"position\":{\"page_number\":0,\"index\":0,\"start\":0,\"end\":50},\"fuzzy_result\":false},{\"score\":0.0,\"rid\":\"af442e9be6484c44a4a1dbc396e38dca\",\"field_type\":\"t\",\"field\":\"page\",\"text\":\"@nuclia/core - \u2022 Docs \\n \\n @nuclia/core / KBKVSchemas \\n Interface: KBKVSchemas - \\n Properties \\n schemas \\n \\n schemas: object \\n \\n Index Signature - \\n [name: string]: KVSchema \\n Defined in \\n libs/sdk-core/src/lib/db/resource/resource.models.ts:602\",\"labels\":[],\"position\":{\"page_number\":0,\"index\":0,\"start\":0,\"end\":238},\"fuzzy_result\":false},{\"score\":0.0,\"rid\":\"701e9133181a4002bc373eaa1254daf8\",\"field_type\":\"a\",\"field\":\"title\",\"text\":\"docs - > develop > js sdk > interfaces > KeyValueFieldData\",\"labels\":[],\"position\":{\"page_number\":0,\"index\":0,\"start\":0,\"end\":56},\"fuzzy_result\":false},{\"score\":0.0,\"rid\":\"701e9133181a4002bc373eaa1254daf8\",\"field_type\":\"t\",\"field\":\"page\",\"text\":\" - \\n optional errors: IError[] \\n \\n Inherited from \\n IFieldDataBase.errors - \\n Defined in \\n libs/sdk-core/src/lib/db/resource/resource.models.ts:150 - \\n \\n extracted? \\n \\n optional extracted: ExtractedData \\n \\n Inherited - from \\n IFieldDataBase.extracted \\n Defined in \\n libs/sdk-core/src/lib/db/resource/resource.models.ts:148 - \\n \\n status? \\n\",\"labels\":[],\"position\":{\"page_number\":0,\"index\":1,\"start\":295,\"end\":623},\"fuzzy_result\":false},{\"score\":0.0,\"rid\":\"701e9133181a4002bc373eaa1254daf8\",\"field_type\":\"t\",\"field\":\"page\",\"text\":\" - \\n optional status: null \\\\| string \\n \\n Inherited from \\n IFieldDataBase.status - \\n Defined in \\n libs/sdk-core/src/lib/db/resource/resource.models.ts:151 - \\n \\n value? \\n \\n optional value: object \\n \\n Index Signature \\n - [key: string]: KVValue \\n Defined in \\n libs/sdk-core/src/lib/db/resource/resource.models.ts:606\",\"labels\":[],\"position\":{\"page_number\":0,\"index\":2,\"start\":623,\"end\":928},\"fuzzy_result\":false},{\"score\":0.0,\"rid\":\"701e9133181a4002bc373eaa1254daf8\",\"field_type\":\"t\",\"field\":\"page\",\"text\":\"@nuclia/core - \u2022 Docs \\n \\n @nuclia/core / KeyValueFieldData \\n Interface: KeyValueFieldData - \\n Extends \\n \\n IFieldDataBase \\n \\n Properties \\n error? \\n \\n optional - error: IError \\n \\n Inherited from \\n IFieldDataBase.error \\n Defined - in \\n libs/sdk-core/src/lib/db/resource/resource.models.ts:149 \\n \\n errors? - \\n\",\"labels\":[],\"position\":{\"page_number\":0,\"index\":0,\"start\":0,\"end\":295},\"fuzzy_result\":false},{\"score\":0.0,\"rid\":\"e88f4784ecb144bf87be0b7e543cb7ef\",\"field_type\":\"a\",\"field\":\"title\",\"text\":\"docs - > develop > js sdk > interfaces > KVSchema\",\"labels\":[],\"position\":{\"page_number\":0,\"index\":0,\"start\":0,\"end\":47},\"fuzzy_result\":false},{\"score\":0.0,\"rid\":\"e88f4784ecb144bf87be0b7e543cb7ef\",\"field_type\":\"t\",\"field\":\"page\",\"text\":\"@nuclia/core - \u2022 Docs \\n \\n @nuclia/core / KVSchema \\n Interface: KVSchema \\n Properties - \\n description? \\n \\n optional description: string \\n \\n Defined in \\n - libs/sdk-core/src/lib/db/resource/resource.models.ts:597 \\n \\n fields \\n - \\n fields: KVSchemaField[] \\n \\n Defined in \\n libs/sdk-core/src/lib/db/resource/resource.models.ts:598 - \\n \\n name \\n \\n\",\"labels\":[],\"position\":{\"page_number\":0,\"index\":0,\"start\":0,\"end\":330},\"fuzzy_result\":false},{\"score\":0.0,\"rid\":\"e88f4784ecb144bf87be0b7e543cb7ef\",\"field_type\":\"t\",\"field\":\"page\",\"text\":\" - name: string \\n \\n Defined in \\n libs/sdk-core/src/lib/db/resource/resource.models.ts:596\",\"labels\":[],\"position\":{\"page_number\":0,\"index\":1,\"start\":330,\"end\":418},\"fuzzy_result\":false},{\"score\":0.0,\"rid\":\"7d409453a7584981beaeb2944e4560f5\",\"field_type\":\"a\",\"field\":\"title\",\"text\":\"docs - > develop > js sdk > interfaces > KVSchemaField\",\"labels\":[],\"position\":{\"page_number\":0,\"index\":0,\"start\":0,\"end\":52},\"fuzzy_result\":false},{\"score\":0.0,\"rid\":\"7d409453a7584981beaeb2944e4560f5\",\"field_type\":\"t\",\"field\":\"page\",\"text\":\" - key: string \\n \\n Defined in \\n libs/sdk-core/src/lib/db/resource/resource.models.ts:589 - \\n \\n required? \\n \\n optional required: boolean \\n \\n Defined in \\n - libs/sdk-core/src/lib/db/resource/resource.models.ts:592 \\n \\n type \\n - \\n\",\"labels\":[],\"position\":{\"page_number\":0,\"index\":1,\"start\":226,\"end\":444},\"fuzzy_result\":false},{\"score\":0.0,\"rid\":\"7d409453a7584981beaeb2944e4560f5\",\"field_type\":\"t\",\"field\":\"page\",\"text\":\" - type: KVFieldType \\n \\n Defined in \\n libs/sdk-core/src/lib/db/resource/resource.models.ts:590\",\"labels\":[],\"position\":{\"page_number\":0,\"index\":2,\"start\":444,\"end\":537},\"fuzzy_result\":false},{\"score\":0.0,\"rid\":\"7d409453a7584981beaeb2944e4560f5\",\"field_type\":\"t\",\"field\":\"page\",\"text\":\"@nuclia/core - \u2022 Docs \\n \\n @nuclia/core / KVSchemaField \\n Interface: KVSchemaField - \\n Properties \\n description? \\n \\n optional description: string \\n \\n - Defined in \\n libs/sdk-core/src/lib/db/resource/resource.models.ts:591 \\n - \\n key \\n \\n\",\"labels\":[],\"position\":{\"page_number\":0,\"index\":0,\"start\":0,\"end\":226},\"fuzzy_result\":false},{\"score\":0.0,\"rid\":\"97fa1944fdbe4e99a9e482179dc344ed\",\"field_type\":\"a\",\"field\":\"title\",\"text\":\"docs - > develop > js sdk > type aliases > KVValue\",\"labels\":[],\"position\":{\"page_number\":0,\"index\":0,\"start\":0,\"end\":48},\"fuzzy_result\":false}],\"facets\":{},\"query\":\"\",\"total\":4965,\"page_number\":0,\"page_size\":20,\"next_page\":true,\"min_score\":0.0},\"shards\":[\"0492d4f0-3034-4392-869f-f204c3865fa4\"]}" + string: '{"title":"pmm","color":"#DAF3E6","multiple":true,"kind":["RESOURCES"],"labels":[{"title":"Videos","related":"","text":"","uri":""},{"title":"Partner + Content","related":"","text":"","uri":""},{"title":"Softcat","related":"","text":"","uri":""},{"title":"Sales + Enablement Assets","related":"","text":"","uri":""},{"title":"KO 26","related":"","text":"","uri":""},{"title":"Data + Sheets","related":"","text":"","uri":""},{"title":"Progress Agentic RAG Training + Materials 2026","related":"","text":"","uri":""}]}' headers: Alt-Svc: - h3=":443"; ma=2592000,h3-29=":443"; ma=2592000 Content-Length: - - '11775' + - '507' access-control-expose-headers: - X-NUCLIA-TRACE-ID content-type: - application/json date: - - Wed, 03 Jun 2026 07:59:57 GMT + - Mon, 13 Jul 2026 08:57:51 GMT via: - 1.1 google x-envoy-upstream-service-time: - - '198' + - '11' x-nuclia-trace-id: - - 70058e123434e3e20c349867275c3a7c + - 6502280ef4429b6197e4b158ba220e20 status: code: 200 message: OK @@ -577,97 +569,129 @@ interactions: uri: https://europe-1.rag.progress.cloud/api/v1/kb/df8b4c24-2807-4888-ad6c-ae97357a638b/search response: body: - string: "{\"resources\":{\"256f6b95e3fb476c8f47b6b057d02fa0\":{\"id\":\"256f6b95e3fb476c8f47b6b057d02fa0\",\"slug\":\"docs-management-security-5-outbound-ips-md\",\"title\":\"docs - > management > security > 5 outbound ips\",\"summary\":\"\",\"icon\":\"text/markdown\",\"thumbnail\":\"\",\"metadata\":{\"metadata\":{},\"language\":\"en\",\"languages\":[\"en\"],\"status\":\"PROCESSED\"},\"usermetadata\":{\"classifications\":[]},\"fieldmetadata\":[],\"computedmetadata\":{\"field_classifications\":[]},\"created\":\"2026-05-28T15:19:46.250570\",\"modified\":\"2026-05-28T15:25:35.444730\",\"last_seqid\":0,\"last_account_seq\":null,\"queue\":\"private\",\"hidden\":false},\"f539dfaa013a45d6a0e319bc7288ff07\":{\"id\":\"f539dfaa013a45d6a0e319bc7288ff07\",\"slug\":\"docs-develop-js-sdk-interfaces-SuggestOptions-md\",\"title\":\"docs - > develop > js sdk > interfaces > SuggestOptions\",\"summary\":\"\",\"icon\":\"text/markdown\",\"thumbnail\":\"\",\"metadata\":{\"metadata\":{},\"language\":\"en\",\"languages\":[\"en\"],\"status\":\"PROCESSED\"},\"usermetadata\":{\"classifications\":[]},\"fieldmetadata\":[],\"computedmetadata\":{\"field_classifications\":[]},\"created\":\"2026-05-28T15:15:28.795386\",\"modified\":\"2026-06-02T15:41:12.907729\",\"last_seqid\":0,\"last_account_seq\":null,\"queue\":\"private\",\"hidden\":false},\"af442e9be6484c44a4a1dbc396e38dca\":{\"id\":\"af442e9be6484c44a4a1dbc396e38dca\",\"slug\":\"docs-develop-js-sdk-interfaces-KBKVSchemas-md\",\"title\":\"docs - > develop > js sdk > interfaces > KBKVSchemas\",\"summary\":\"\",\"icon\":\"text/markdown\",\"thumbnail\":\"\",\"metadata\":{\"metadata\":{},\"language\":\"en\",\"languages\":[\"en\"],\"status\":\"PROCESSED\"},\"usermetadata\":{\"classifications\":[]},\"fieldmetadata\":[],\"computedmetadata\":{\"field_classifications\":[]},\"created\":\"2026-05-22T07:20:55.157941\",\"modified\":\"2026-06-02T15:39:32.412772\",\"last_seqid\":0,\"last_account_seq\":null,\"queue\":\"private\",\"hidden\":false},\"701e9133181a4002bc373eaa1254daf8\":{\"id\":\"701e9133181a4002bc373eaa1254daf8\",\"slug\":\"docs-develop-js-sdk-interfaces-KeyValueFieldData-md\",\"title\":\"docs - > develop > js sdk > interfaces > KeyValueFieldData\",\"summary\":\"\",\"icon\":\"text/markdown\",\"thumbnail\":\"\",\"metadata\":{\"metadata\":{},\"language\":\"en\",\"languages\":[\"en\"],\"status\":\"PROCESSED\"},\"usermetadata\":{\"classifications\":[]},\"fieldmetadata\":[],\"computedmetadata\":{\"field_classifications\":[]},\"created\":\"2026-05-22T07:20:34.954997\",\"modified\":\"2026-06-02T15:39:59.839882\",\"last_seqid\":0,\"last_account_seq\":null,\"queue\":\"private\",\"hidden\":false},\"e88f4784ecb144bf87be0b7e543cb7ef\":{\"id\":\"e88f4784ecb144bf87be0b7e543cb7ef\",\"slug\":\"docs-develop-js-sdk-interfaces-KVSchema-md\",\"title\":\"docs - > develop > js sdk > interfaces > KVSchema\",\"summary\":\"\",\"icon\":\"text/markdown\",\"thumbnail\":\"\",\"metadata\":{\"metadata\":{},\"language\":\"en\",\"languages\":[\"en\"],\"status\":\"PROCESSED\"},\"usermetadata\":{\"classifications\":[]},\"fieldmetadata\":[],\"computedmetadata\":{\"field_classifications\":[]},\"created\":\"2026-05-22T07:19:11.438434\",\"modified\":\"2026-06-02T15:41:23.157239\",\"last_seqid\":0,\"last_account_seq\":null,\"queue\":\"private\",\"hidden\":false},\"7d409453a7584981beaeb2944e4560f5\":{\"id\":\"7d409453a7584981beaeb2944e4560f5\",\"slug\":\"docs-develop-js-sdk-interfaces-KVSchemaField-md\",\"title\":\"docs - > develop > js sdk > interfaces > KVSchemaField\",\"summary\":\"\",\"icon\":\"text/markdown\",\"thumbnail\":\"\",\"metadata\":{\"metadata\":{},\"language\":\"en\",\"languages\":[\"en\"],\"status\":\"PROCESSED\"},\"usermetadata\":{\"classifications\":[]},\"fieldmetadata\":[],\"computedmetadata\":{\"field_classifications\":[]},\"created\":\"2026-05-22T07:19:07.225437\",\"modified\":\"2026-06-02T15:40:07.299545\",\"last_seqid\":0,\"last_account_seq\":null,\"queue\":\"private\",\"hidden\":false},\"97fa1944fdbe4e99a9e482179dc344ed\":{\"id\":\"97fa1944fdbe4e99a9e482179dc344ed\",\"slug\":\"docs-develop-js-sdk-type-aliases-KVValue-md\",\"title\":\"docs - > develop > js sdk > type aliases > KVValue\",\"summary\":\"\",\"icon\":\"text/markdown\",\"thumbnail\":\"\",\"metadata\":{\"metadata\":{},\"language\":\"en\",\"languages\":[\"en\"],\"status\":\"PROCESSED\"},\"usermetadata\":{\"classifications\":[]},\"fieldmetadata\":[],\"computedmetadata\":{\"field_classifications\":[]},\"created\":\"2026-05-22T07:16:23.940364\",\"modified\":\"2026-06-02T15:38:57.624998\",\"last_seqid\":0,\"last_account_seq\":null,\"queue\":\"private\",\"hidden\":false},\"1ea50c5c8e1c43ba8dfc2afe8c5d94ee\":{\"id\":\"1ea50c5c8e1c43ba8dfc2afe8c5d94ee\",\"slug\":\"docs-develop-js-sdk-type-aliases-KVFieldType-md\",\"title\":\"docs - > develop > js sdk > type aliases > KVFieldType\",\"summary\":\"\",\"icon\":\"text/markdown\",\"thumbnail\":\"\",\"metadata\":{\"metadata\":{},\"language\":\"en\",\"languages\":[\"en\",\"sv\"],\"status\":\"PROCESSED\"},\"usermetadata\":{\"classifications\":[]},\"fieldmetadata\":[],\"computedmetadata\":{\"field_classifications\":[]},\"created\":\"2026-05-22T07:16:05.277807\",\"modified\":\"2026-06-02T15:38:27.367275\",\"last_seqid\":0,\"last_account_seq\":null,\"queue\":\"private\",\"hidden\":false},\"57864b149f254f4aba34905a895c1927\":{\"id\":\"57864b149f254f4aba34905a895c1927\",\"slug\":\"docs-develop-js-sdk-type-aliases-WorkflowType-md\",\"title\":\"docs - > develop > js sdk > type aliases > WorkflowType\",\"summary\":\"\",\"icon\":\"text/markdown\",\"thumbnail\":\"\",\"metadata\":{\"metadata\":{},\"language\":\"en\",\"languages\":[\"en\"],\"status\":\"PROCESSED\"},\"usermetadata\":{\"classifications\":[]},\"fieldmetadata\":[],\"computedmetadata\":{\"field_classifications\":[]},\"created\":\"2026-04-22T20:03:49.324172\",\"modified\":\"2026-06-02T15:38:22.886483\",\"last_seqid\":0,\"last_account_seq\":null,\"queue\":\"private\",\"hidden\":false},\"8798b24b72a74c63a79ec0e2f10a1423\":{\"id\":\"8798b24b72a74c63a79ec0e2f10a1423\",\"slug\":\"docs-ingestion-cloud-storage-sync-md\",\"title\":\"docs - > ingestion > cloud storage sync\",\"summary\":\"\",\"icon\":\"text/markdown\",\"thumbnail\":\"\",\"metadata\":{\"metadata\":{},\"language\":\"en\",\"languages\":[\"en\"],\"status\":\"PROCESSED\"},\"usermetadata\":{\"classifications\":[]},\"fieldmetadata\":[],\"computedmetadata\":{\"field_classifications\":[]},\"created\":\"2026-04-13T08:05:37.518460\",\"modified\":\"2026-05-05T14:56:07.367333\",\"last_seqid\":0,\"last_account_seq\":null,\"queue\":\"private\",\"hidden\":false}},\"paragraphs\":{\"results\":[{\"score\":0.0,\"rid\":\"256f6b95e3fb476c8f47b6b057d02fa0\",\"field_type\":\"t\",\"field\":\"page\",\"text\":\" - Europe (AWS) \\n \\n 63.179.23.139/32 \\n 3.78.13.149/32 \\n 3.66.123.24/32 - \\n \\n Europe (GCP) \\n \\n 35.204.65.155/32 \\n 34.91.38.151/32 \\n 35.204.139.129/32 - \\n 35.204.108.221/32 \\n \\n Israel \\n \\n 51.17.150.97/32 \\n \\n United - States \\n \\n 3.137.28.168/32 \\n \",\"labels\":[],\"position\":{\"page_number\":0,\"index\":1,\"start\":341,\"end\":578},\"fuzzy_result\":false},{\"score\":0.0,\"rid\":\"256f6b95e3fb476c8f47b6b057d02fa0\",\"field_type\":\"t\",\"field\":\"page\",\"text\":\" - \\n id: outbound-ips \\n title: Outbound IP Addresses \\n \\n If your firewall - blocks inbound requests from the internet, you may need to allowlist the following - IP addresses. These are the source IPs that Progress Agentic RAG uses when - making outbound connections (e.g., webhooks, sync agents, or other integrations - calling your infrastructure). \\n\",\"labels\":[],\"position\":{\"page_number\":0,\"index\":0,\"start\":0,\"end\":341},\"fuzzy_result\":false},{\"score\":0.0,\"rid\":\"256f6b95e3fb476c8f47b6b057d02fa0\",\"field_type\":\"a\",\"field\":\"title\",\"text\":\"docs - > management > security > 5 outbound ips\",\"labels\":[],\"position\":{\"page_number\":0,\"index\":0,\"start\":0,\"end\":45},\"fuzzy_result\":false},{\"score\":0.0,\"rid\":\"f539dfaa013a45d6a0e319bc7288ff07\",\"field_type\":\"t\",\"field\":\"page\",\"text\":\" - \\n optional security: object \\n \\n groups \\n \\n groups: string[] \\n - \\n Defined in \\n libs/sdk-core/src/lib/db/search/search.models.ts:166 \\n - \\n show_hidden? \\n \\n optional show_hidden: boolean \\n \\n Defined in - \\n libs/sdk-core/src/lib/db/search/search.models.ts:165\",\"labels\":[],\"position\":{\"page_number\":0,\"index\":1,\"start\":225,\"end\":477},\"fuzzy_result\":false},{\"score\":0.0,\"rid\":\"f539dfaa013a45d6a0e319bc7288ff07\",\"field_type\":\"t\",\"field\":\"page\",\"text\":\"@nuclia/core - \u2022 Docs \\n \\n @nuclia/core / SuggestOptions \\n Interface: SuggestOptions - \\n Properties \\n highlight? \\n \\n optional highlight: boolean \\n \\n - Defined in \\n libs/sdk-core/src/lib/db/search/search.models.ts:164 \\n \\n - security? \\n\",\"labels\":[],\"position\":{\"page_number\":0,\"index\":0,\"start\":0,\"end\":225},\"fuzzy_result\":false},{\"score\":0.0,\"rid\":\"f539dfaa013a45d6a0e319bc7288ff07\",\"field_type\":\"a\",\"field\":\"title\",\"text\":\"docs - > develop > js sdk > interfaces > SuggestOptions\",\"labels\":[],\"position\":{\"page_number\":0,\"index\":0,\"start\":0,\"end\":53},\"fuzzy_result\":false},{\"score\":0.0,\"rid\":\"af442e9be6484c44a4a1dbc396e38dca\",\"field_type\":\"a\",\"field\":\"title\",\"text\":\"docs - > develop > js sdk > interfaces > KBKVSchemas\",\"labels\":[],\"position\":{\"page_number\":0,\"index\":0,\"start\":0,\"end\":50},\"fuzzy_result\":false},{\"score\":0.0,\"rid\":\"af442e9be6484c44a4a1dbc396e38dca\",\"field_type\":\"t\",\"field\":\"page\",\"text\":\"@nuclia/core - \u2022 Docs \\n \\n @nuclia/core / KBKVSchemas \\n Interface: KBKVSchemas - \\n Properties \\n schemas \\n \\n schemas: object \\n \\n Index Signature - \\n [name: string]: KVSchema \\n Defined in \\n libs/sdk-core/src/lib/db/resource/resource.models.ts:602\",\"labels\":[],\"position\":{\"page_number\":0,\"index\":0,\"start\":0,\"end\":238},\"fuzzy_result\":false},{\"score\":0.0,\"rid\":\"701e9133181a4002bc373eaa1254daf8\",\"field_type\":\"a\",\"field\":\"title\",\"text\":\"docs - > develop > js sdk > interfaces > KeyValueFieldData\",\"labels\":[],\"position\":{\"page_number\":0,\"index\":0,\"start\":0,\"end\":56},\"fuzzy_result\":false},{\"score\":0.0,\"rid\":\"701e9133181a4002bc373eaa1254daf8\",\"field_type\":\"t\",\"field\":\"page\",\"text\":\" - \\n optional errors: IError[] \\n \\n Inherited from \\n IFieldDataBase.errors - \\n Defined in \\n libs/sdk-core/src/lib/db/resource/resource.models.ts:150 - \\n \\n extracted? \\n \\n optional extracted: ExtractedData \\n \\n Inherited - from \\n IFieldDataBase.extracted \\n Defined in \\n libs/sdk-core/src/lib/db/resource/resource.models.ts:148 - \\n \\n status? \\n\",\"labels\":[],\"position\":{\"page_number\":0,\"index\":1,\"start\":295,\"end\":623},\"fuzzy_result\":false},{\"score\":0.0,\"rid\":\"701e9133181a4002bc373eaa1254daf8\",\"field_type\":\"t\",\"field\":\"page\",\"text\":\" - \\n optional status: null \\\\| string \\n \\n Inherited from \\n IFieldDataBase.status - \\n Defined in \\n libs/sdk-core/src/lib/db/resource/resource.models.ts:151 - \\n \\n value? \\n \\n optional value: object \\n \\n Index Signature \\n - [key: string]: KVValue \\n Defined in \\n libs/sdk-core/src/lib/db/resource/resource.models.ts:606\",\"labels\":[],\"position\":{\"page_number\":0,\"index\":2,\"start\":623,\"end\":928},\"fuzzy_result\":false},{\"score\":0.0,\"rid\":\"701e9133181a4002bc373eaa1254daf8\",\"field_type\":\"t\",\"field\":\"page\",\"text\":\"@nuclia/core - \u2022 Docs \\n \\n @nuclia/core / KeyValueFieldData \\n Interface: KeyValueFieldData - \\n Extends \\n \\n IFieldDataBase \\n \\n Properties \\n error? \\n \\n optional - error: IError \\n \\n Inherited from \\n IFieldDataBase.error \\n Defined - in \\n libs/sdk-core/src/lib/db/resource/resource.models.ts:149 \\n \\n errors? - \\n\",\"labels\":[],\"position\":{\"page_number\":0,\"index\":0,\"start\":0,\"end\":295},\"fuzzy_result\":false},{\"score\":0.0,\"rid\":\"e88f4784ecb144bf87be0b7e543cb7ef\",\"field_type\":\"a\",\"field\":\"title\",\"text\":\"docs - > develop > js sdk > interfaces > KVSchema\",\"labels\":[],\"position\":{\"page_number\":0,\"index\":0,\"start\":0,\"end\":47},\"fuzzy_result\":false},{\"score\":0.0,\"rid\":\"e88f4784ecb144bf87be0b7e543cb7ef\",\"field_type\":\"t\",\"field\":\"page\",\"text\":\"@nuclia/core - \u2022 Docs \\n \\n @nuclia/core / KVSchema \\n Interface: KVSchema \\n Properties - \\n description? \\n \\n optional description: string \\n \\n Defined in \\n - libs/sdk-core/src/lib/db/resource/resource.models.ts:597 \\n \\n fields \\n - \\n fields: KVSchemaField[] \\n \\n Defined in \\n libs/sdk-core/src/lib/db/resource/resource.models.ts:598 - \\n \\n name \\n \\n\",\"labels\":[],\"position\":{\"page_number\":0,\"index\":0,\"start\":0,\"end\":330},\"fuzzy_result\":false},{\"score\":0.0,\"rid\":\"e88f4784ecb144bf87be0b7e543cb7ef\",\"field_type\":\"t\",\"field\":\"page\",\"text\":\" - name: string \\n \\n Defined in \\n libs/sdk-core/src/lib/db/resource/resource.models.ts:596\",\"labels\":[],\"position\":{\"page_number\":0,\"index\":1,\"start\":330,\"end\":418},\"fuzzy_result\":false},{\"score\":0.0,\"rid\":\"7d409453a7584981beaeb2944e4560f5\",\"field_type\":\"a\",\"field\":\"title\",\"text\":\"docs - > develop > js sdk > interfaces > KVSchemaField\",\"labels\":[],\"position\":{\"page_number\":0,\"index\":0,\"start\":0,\"end\":52},\"fuzzy_result\":false},{\"score\":0.0,\"rid\":\"7d409453a7584981beaeb2944e4560f5\",\"field_type\":\"t\",\"field\":\"page\",\"text\":\" - key: string \\n \\n Defined in \\n libs/sdk-core/src/lib/db/resource/resource.models.ts:589 - \\n \\n required? \\n \\n optional required: boolean \\n \\n Defined in \\n - libs/sdk-core/src/lib/db/resource/resource.models.ts:592 \\n \\n type \\n - \\n\",\"labels\":[],\"position\":{\"page_number\":0,\"index\":1,\"start\":226,\"end\":444},\"fuzzy_result\":false},{\"score\":0.0,\"rid\":\"7d409453a7584981beaeb2944e4560f5\",\"field_type\":\"t\",\"field\":\"page\",\"text\":\" - type: KVFieldType \\n \\n Defined in \\n libs/sdk-core/src/lib/db/resource/resource.models.ts:590\",\"labels\":[],\"position\":{\"page_number\":0,\"index\":2,\"start\":444,\"end\":537},\"fuzzy_result\":false},{\"score\":0.0,\"rid\":\"7d409453a7584981beaeb2944e4560f5\",\"field_type\":\"t\",\"field\":\"page\",\"text\":\"@nuclia/core - \u2022 Docs \\n \\n @nuclia/core / KVSchemaField \\n Interface: KVSchemaField - \\n Properties \\n description? \\n \\n optional description: string \\n \\n - Defined in \\n libs/sdk-core/src/lib/db/resource/resource.models.ts:591 \\n - \\n key \\n \\n\",\"labels\":[],\"position\":{\"page_number\":0,\"index\":0,\"start\":0,\"end\":226},\"fuzzy_result\":false},{\"score\":0.0,\"rid\":\"97fa1944fdbe4e99a9e482179dc344ed\",\"field_type\":\"a\",\"field\":\"title\",\"text\":\"docs - > develop > js sdk > type aliases > KVValue\",\"labels\":[],\"position\":{\"page_number\":0,\"index\":0,\"start\":0,\"end\":48},\"fuzzy_result\":false}],\"facets\":{\"/k\":{\"/k/text\":4965}},\"query\":\"\",\"total\":4965,\"page_number\":0,\"page_size\":20,\"next_page\":true,\"min_score\":0.0},\"fulltext\":{\"results\":[{\"score\":0.0,\"rid\":\"256f6b95e3fb476c8f47b6b057d02fa0\",\"field_type\":\"t\",\"field\":\"page\",\"labels\":[]},{\"score\":0.0,\"rid\":\"256f6b95e3fb476c8f47b6b057d02fa0\",\"field_type\":\"a\",\"field\":\"title\",\"labels\":[]},{\"score\":0.0,\"rid\":\"f539dfaa013a45d6a0e319bc7288ff07\",\"field_type\":\"t\",\"field\":\"page\",\"labels\":[]},{\"score\":0.0,\"rid\":\"f539dfaa013a45d6a0e319bc7288ff07\",\"field_type\":\"a\",\"field\":\"title\",\"labels\":[]},{\"score\":0.0,\"rid\":\"af442e9be6484c44a4a1dbc396e38dca\",\"field_type\":\"a\",\"field\":\"title\",\"labels\":[]},{\"score\":0.0,\"rid\":\"af442e9be6484c44a4a1dbc396e38dca\",\"field_type\":\"t\",\"field\":\"page\",\"labels\":[]},{\"score\":0.0,\"rid\":\"701e9133181a4002bc373eaa1254daf8\",\"field_type\":\"a\",\"field\":\"title\",\"labels\":[]},{\"score\":0.0,\"rid\":\"701e9133181a4002bc373eaa1254daf8\",\"field_type\":\"t\",\"field\":\"page\",\"labels\":[]},{\"score\":0.0,\"rid\":\"e88f4784ecb144bf87be0b7e543cb7ef\",\"field_type\":\"a\",\"field\":\"title\",\"labels\":[]},{\"score\":0.0,\"rid\":\"e88f4784ecb144bf87be0b7e543cb7ef\",\"field_type\":\"t\",\"field\":\"page\",\"labels\":[]},{\"score\":0.0,\"rid\":\"7d409453a7584981beaeb2944e4560f5\",\"field_type\":\"a\",\"field\":\"title\",\"labels\":[]},{\"score\":0.0,\"rid\":\"7d409453a7584981beaeb2944e4560f5\",\"field_type\":\"t\",\"field\":\"page\",\"labels\":[]},{\"score\":0.0,\"rid\":\"97fa1944fdbe4e99a9e482179dc344ed\",\"field_type\":\"a\",\"field\":\"title\",\"labels\":[]},{\"score\":0.0,\"rid\":\"97fa1944fdbe4e99a9e482179dc344ed\",\"field_type\":\"t\",\"field\":\"page\",\"labels\":[]},{\"score\":0.0,\"rid\":\"1ea50c5c8e1c43ba8dfc2afe8c5d94ee\",\"field_type\":\"a\",\"field\":\"title\",\"labels\":[]},{\"score\":0.0,\"rid\":\"1ea50c5c8e1c43ba8dfc2afe8c5d94ee\",\"field_type\":\"t\",\"field\":\"page\",\"labels\":[]},{\"score\":0.0,\"rid\":\"57864b149f254f4aba34905a895c1927\",\"field_type\":\"a\",\"field\":\"title\",\"labels\":[]},{\"score\":0.0,\"rid\":\"57864b149f254f4aba34905a895c1927\",\"field_type\":\"t\",\"field\":\"page\",\"labels\":[]},{\"score\":0.0,\"rid\":\"8798b24b72a74c63a79ec0e2f10a1423\",\"field_type\":\"t\",\"field\":\"page\",\"labels\":[]},{\"score\":0.0,\"rid\":\"8798b24b72a74c63a79ec0e2f10a1423\",\"field_type\":\"a\",\"field\":\"title\",\"labels\":[]}],\"facets\":{},\"query\":\"\",\"total\":1949,\"page_number\":0,\"page_size\":20,\"next_page\":true,\"min_score\":0.0},\"shards\":[\"0492d4f0-3034-4392-869f-f204c3865fa4\"]}" + string: "{\"resources\":{\"f13642b2862f4a1ea2144c9eb2abb2a3\":{\"id\":\"f13642b2862f4a1ea2144c9eb2abb2a3\",\"slug\":\"docs-develop-js-sdk-functions-normalizeGlobalBackendUrl-md\",\"title\":\"docs + > develop > js sdk > functions > normalizeGlobalBackendUrl\",\"summary\":\"\",\"icon\":\"text/markdown\",\"thumbnail\":\"\",\"metadata\":{\"metadata\":{},\"language\":\"en\",\"languages\":[\"en\"],\"status\":\"PROCESSED\"},\"usermetadata\":{\"classifications\":[]},\"fieldmetadata\":[],\"computedmetadata\":{\"field_classifications\":[]},\"created\":\"2026-06-26T08:38:33.060378\",\"modified\":\"2026-07-13T08:10:04.600554\",\"last_seqid\":0,\"last_account_seq\":null,\"queue\":\"private\",\"hidden\":false},\"007b445866574d7ca69891d388663cc6\":{\"id\":\"007b445866574d7ca69891d388663cc6\",\"slug\":\"docs-management-security-5-public-ips-md\",\"title\":\"docs + > management > security > 5 public ips\",\"summary\":\"\",\"icon\":\"text/markdown\",\"thumbnail\":\"\",\"metadata\":{\"metadata\":{},\"language\":\"en\",\"languages\":[\"en\"],\"status\":\"PROCESSED\"},\"usermetadata\":{\"classifications\":[]},\"fieldmetadata\":[],\"computedmetadata\":{\"field_classifications\":[]},\"created\":\"2026-07-03T09:28:57.937064\",\"modified\":\"2026-07-03T09:28:57.937076\",\"last_seqid\":0,\"last_account_seq\":null,\"queue\":\"private\",\"hidden\":false},\"2a0d73029ad24c599d6dc1e117a41897\":{\"id\":\"2a0d73029ad24c599d6dc1e117a41897\",\"slug\":\"docs-agentic-deploy-md\",\"title\":\"docs + > agentic > deploy\",\"summary\":\"\",\"icon\":\"text/markdown\",\"thumbnail\":\"\",\"metadata\":{\"metadata\":{},\"language\":\"en\",\"languages\":[\"en\"],\"status\":\"PROCESSED\"},\"usermetadata\":{\"classifications\":[]},\"fieldmetadata\":[],\"computedmetadata\":{\"field_classifications\":[]},\"created\":\"2026-06-29T13:39:02.557258\",\"modified\":\"2026-06-29T13:39:02.557276\",\"last_seqid\":0,\"last_account_seq\":null,\"queue\":\"private\",\"hidden\":false},\"a572ce0c7eb949e4a17babae21a03a4a\":{\"id\":\"a572ce0c7eb949e4a17babae21a03a4a\",\"slug\":\"navigation-pages\",\"title\":\"navigation-pages\",\"summary\":\"\",\"icon\":\"application/json\",\"thumbnail\":\"\",\"metadata\":{\"metadata\":{},\"language\":\"en\",\"languages\":[\"en\",\"fr\"],\"status\":\"PROCESSED\"},\"usermetadata\":{\"classifications\":[]},\"fieldmetadata\":[],\"computedmetadata\":{\"field_classifications\":[]},\"created\":\"2026-06-23T10:58:22.812220\",\"modified\":\"2026-06-23T10:58:22.812242\",\"last_seqid\":0,\"last_account_seq\":null,\"queue\":\"private\",\"hidden\":false},\"ed6fda7434aa43a3bd5138b95e7fe081\":{\"id\":\"ed6fda7434aa43a3bd5138b95e7fe081\",\"slug\":\"docs-develop-python-sdk-15-memory-md\",\"title\":\"docs + > develop > python sdk > 15 memory\",\"summary\":\"\",\"icon\":\"text/markdown\",\"thumbnail\":\"\",\"metadata\":{\"metadata\":{},\"language\":\"en\",\"languages\":[\"en\"],\"status\":\"PROCESSED\"},\"usermetadata\":{\"classifications\":[]},\"fieldmetadata\":[],\"computedmetadata\":{\"field_classifications\":[]},\"created\":\"2026-06-26T08:31:21.372271\",\"modified\":\"2026-06-26T08:59:38.187065\",\"last_seqid\":0,\"last_account_seq\":null,\"queue\":\"private\",\"hidden\":false},\"b28e388104644fc5bba68c0cd44e01d4\":{\"id\":\"b28e388104644fc5bba68c0cd44e01d4\",\"slug\":\"docs-agentic-how-to-agentic-retrieval-md\",\"title\":\"docs + > agentic > how to > agentic retrieval\",\"summary\":\"\",\"icon\":\"text/markdown\",\"thumbnail\":\"\",\"metadata\":{\"metadata\":{},\"language\":\"en\",\"languages\":[\"en\"],\"status\":\"PROCESSED\"},\"usermetadata\":{\"classifications\":[]},\"fieldmetadata\":[],\"computedmetadata\":{\"field_classifications\":[]},\"created\":\"2026-06-29T13:39:03.379512\",\"modified\":\"2026-06-29T13:39:03.379525\",\"last_seqid\":0,\"last_account_seq\":null,\"queue\":\"private\",\"hidden\":false}},\"paragraphs\":{\"results\":[{\"score\":0.0,\"rid\":\"007b445866574d7ca69891d388663cc6\",\"field_type\":\"t\",\"field\":\"page\",\"text\":\" + Outbound \u2014 the source IP addresses that Progress Agentic RAG uses when + making connections to your systems (e.g., webhooks, sync agents, or other + integrations). Allowlist these if you restrict inbound traffic to your infrastructure. + \\n\",\"labels\":[],\"start_seconds\":null,\"end_seconds\":null,\"position\":{\"page_number\":0,\"index\":2,\"start\":418,\"end\":652},\"fuzzy_result\":false},{\"score\":0.0,\"rid\":\"007b445866574d7ca69891d388663cc6\",\"field_type\":\"t\",\"field\":\"page\",\"text\":\" + \\n :::note \\n The current list of IP addresses is also available in machine-readable + format: JSON | YAML. These lists may change over time, so we recommend periodically + fetching and applying updates to your firewall rules to ensure uninterrupted + service. \\n\",\"labels\":[],\"start_seconds\":null,\"end_seconds\":null,\"position\":{\"page_number\":0,\"index\":3,\"start\":652,\"end\":907},\"fuzzy_result\":false},{\"score\":0.0,\"rid\":\"007b445866574d7ca69891d388663cc6\",\"field_type\":\"t\",\"field\":\"page\",\"text\":\" + \\n id: public-ips \\n title: Public IP Addresses \\n \\n If your firewall + restricts network traffic, you may need to allowlist the following IP addresses. + They are grouped by region and split into two categories: \\n\",\"labels\":[],\"start_seconds\":null,\"end_seconds\":null,\"position\":{\"page_number\":0,\"index\":0,\"start\":0,\"end\":208},\"fuzzy_result\":false},{\"score\":0.0,\"rid\":\"007b445866574d7ca69891d388663cc6\",\"field_type\":\"t\",\"field\":\"page\",\"text\":\" + ::: \\n Europe (GCP) \\n | Inbound | Outbound | \\n | ------------------ | + --------------------- | \\n | 34.111.1.187/32 | 35.204.65.155/32 | \\n | 136.68.112.29/32 + | 34.91.38.151/32 | \\n | | 35.204.139.129/32 | \\n | | 35.204.108.221/32 + | \\n Australia (AWS) \\n | Inbound | Outbound | \\n | ------------------- + | --------------------- | \\n | 54.253.224.44/32 | 15.135.151.213/32 | \\n + | 3.25.20.9/32 | 3.24.144.83/32 | \\n | 52.64.202.159/32 | 3.24.81.206/32 + | \\n Europe (AWS) \\n | Inbound | Outbound | \\n | ------------------- | + --------------------- | \\n | 63.182.151.234/32 | 63.179.23.139/32 | \\n | + 35.159.36.135/32 | 3.78.13.149/32 | \\n | 52.57.40.91/32 | 3.66.123.24/32 + | \\n Israel (AWS) \\n | Inbound | Outbound | \\n | ------------------- | + --------------------- | \\n | 51.84.176.167/32 | 51.17.150.97/32 | \\n | 16.164.50.185/32 + | 51.84.112.203/32 | \\n | 16.164.85.69/32 | 51.17.212.226/32 | \\n United + States (AWS) \\n | Inbound | Outbound | \\n | -------------------- | -------------------- + | \\n | 18.225.228.199/32 | 3.137.28.168/32 | \\n | 18.119.145.185/32 | 18.225.104.91/32 + | \\n | 3.21.239.244/32 | 16.59.115.61/32 | \\n Private connectivity (AWS + PrivateLink) \\n For AWS-hosted regions, it is possible to expose access privately + through an AWS endpoint service (AWS PrivateLink) instead of over the public + internet, allowing connections to be established from your VPC without traversing + public IP addresses. This option is not available through self-service configuration. + Please reach out to your account manager for details.\",\"labels\":[],\"start_seconds\":null,\"end_seconds\":null,\"position\":{\"page_number\":0,\"index\":4,\"start\":907,\"end\":2402},\"fuzzy_result\":false},{\"score\":0.0,\"rid\":\"007b445866574d7ca69891d388663cc6\",\"field_type\":\"t\",\"field\":\"page\",\"text\":\" + \\n Inbound \u2014 the IP addresses that Progress Agentic RAG receives requests + on. Allowlist these if you restrict outbound traffic from your infrastructure + and need to reach our services (e.g., calling our APIs). \\n\",\"labels\":[],\"start_seconds\":null,\"end_seconds\":null,\"position\":{\"page_number\":0,\"index\":1,\"start\":208,\"end\":418},\"fuzzy_result\":false},{\"score\":0.0,\"rid\":\"007b445866574d7ca69891d388663cc6\",\"field_type\":\"a\",\"field\":\"title\",\"text\":\"docs + > management > security > 5 public ips\",\"labels\":[],\"start_seconds\":null,\"end_seconds\":null,\"position\":{\"page_number\":0,\"index\":0,\"start\":0,\"end\":43},\"fuzzy_result\":false},{\"score\":0.0,\"rid\":\"b28e388104644fc5bba68c0cd44e01d4\",\"field_type\":\"a\",\"field\":\"title\",\"text\":\"docs + > agentic > how to > agentic retrieval\",\"labels\":[],\"start_seconds\":null,\"end_seconds\":null,\"position\":{\"page_number\":0,\"index\":0,\"start\":0,\"end\":43},\"fuzzy_result\":false},{\"score\":0.0,\"rid\":\"b28e388104644fc5bba68c0cd44e01d4\",\"field_type\":\"t\",\"field\":\"page\",\"text\":\" + \\n id: agentic-retrieval \\n title: Agentic retrieval with the Smart agent + \\n \\n Agentic retrieval with the Smart agent \\n The Smart agent is a powerful + tool that enhances the capabilities of traditional retrieval-augmented generation + (RAG) systems. Regular RAG's fixed search-then-generate process is limiting + for complex questions that need intermediary steps and reasoning. \\n\",\"labels\":[],\"start_seconds\":null,\"end_seconds\":null,\"position\":{\"page_number\":0,\"index\":0,\"start\":0,\"end\":373},\"fuzzy_result\":false},{\"score\":0.0,\"rid\":\"b28e388104644fc5bba68c0cd44e01d4\",\"field_type\":\"t\",\"field\":\"page\",\"text\":\" + \\n Different models can be chosen for different tasks: \\n \\n Context validation + happens when the Prune context option is enabled (recommended), we recommend + using a fast model - planning or the execution model (depending on the planning + mode you have selected): we recommend using a more powerful model. \\n\",\"labels\":[],\"start_seconds\":null,\"end_seconds\":null,\"position\":{\"page_number\":0,\"index\":5,\"start\":1640,\"end\":1943},\"fuzzy_result\":false},{\"score\":0.0,\"rid\":\"b28e388104644fc5bba68c0cd44e01d4\",\"field_type\":\"t\",\"field\":\"page\",\"text\":\" + \\n Note: the rephrasing model is only used in more complex workflow, it can + be ignored in the present case. \\n Finally, add a Summarize agent in the + Generation step to generate a final answer from the retrieved information. + \\n\",\"labels\":[],\"start_seconds\":null,\"end_seconds\":null,\"position\":{\"page_number\":0,\"index\":6,\"start\":1943,\"end\":2167},\"fuzzy_result\":false},{\"score\":0.0,\"rid\":\"b28e388104644fc5bba68c0cd44e01d4\",\"field_type\":\"t\",\"field\":\"page\",\"text\":\" + The Smart Agent plans the answer: picks the most appropriate sources, splits + the question into sub-questions, evaluates relevancy, and iterates autonomously + until the information is sufficient. \\n Basic usage \\n To set up a Smart + Agent, declare all the sources you want to use (Knowledge Boxes, Perplexity, + etc.) in the Sources section of the left menu. Then, create a new workflow + in the Workflows section and add a Smart Agent in the Retrieval step. \\n\",\"labels\":[],\"start_seconds\":null,\"end_seconds\":null,\"position\":{\"page_number\":0,\"index\":1,\"start\":373,\"end\":825},\"fuzzy_result\":false},{\"score\":0.0,\"rid\":\"b28e388104644fc5bba68c0cd44e01d4\",\"field_type\":\"t\",\"field\":\"page\",\"text\":\" + Chat mode \\n If you want to use the Smart Agent in a chat interface, you + need the following: \\n \\n Enable the Session history option in the Smart + Agent configuration. This will allow the Smart Agent to take into account + the previous conversation when planning its next steps. \\n\",\"labels\":[],\"start_seconds\":null,\"end_seconds\":null,\"position\":{\"page_number\":0,\"index\":7,\"start\":2167,\"end\":2442},\"fuzzy_result\":false},{\"score\":0.0,\"rid\":\"b28e388104644fc5bba68c0cd44e01d4\",\"field_type\":\"t\",\"field\":\"page\",\"text\":\" + Then connect your sources as Registered Agents to the Smart Agent. It is very + important that you provide an extensive description of each registered agent, + so that the Smart Agent can understand what each source is about and when + to use it. \\n\",\"labels\":[],\"start_seconds\":null,\"end_seconds\":null,\"position\":{\"page_number\":0,\"index\":2,\"start\":825,\"end\":1068},\"fuzzy_result\":false},{\"score\":0.0,\"rid\":\"b28e388104644fc5bba68c0cd44e01d4\",\"field_type\":\"t\",\"field\":\"page\",\"text\":\" + \\n reactive: The Smart Agent will decide what to do first, and will plan + the next steps based on the information it retrieves. It is expected to be + faster. \\n plan_execute: The Smart Agent will plan all the steps in advance, + and will execute them. It will be slower but more accurate when processing + complex questions. \\n\",\"labels\":[],\"start_seconds\":null,\"end_seconds\":null,\"position\":{\"page_number\":0,\"index\":4,\"start\":1321,\"end\":1640},\"fuzzy_result\":false},{\"score\":0.0,\"rid\":\"b28e388104644fc5bba68c0cd44e01d4\",\"field_type\":\"t\",\"field\":\"page\",\"text\":\" + Also select the proper function for each registered agent, depending on the + type of source (MCP agents will not need one, the functions are provided dynamically + by the MCP server). \\n In the Smart Agent configuration, you can select the + planning mode: \\n\",\"labels\":[],\"start_seconds\":null,\"end_seconds\":null,\"position\":{\"page_number\":0,\"index\":3,\"start\":1068,\"end\":1321},\"fuzzy_result\":false},{\"score\":0.0,\"rid\":\"b28e388104644fc5bba68c0cd44e01d4\",\"field_type\":\"t\",\"field\":\"page\",\"text\":\" + In the Summarize Agent, enable the Conversational mode. This will allow the + Summarize Agent to generate a final answer that will not repeat the information + already provided in the previous conversation, and will be more natural for + a chat interface. \\n\",\"labels\":[],\"start_seconds\":null,\"end_seconds\":null,\"position\":{\"page_number\":0,\"index\":8,\"start\":2442,\"end\":2694},\"fuzzy_result\":false},{\"score\":0.0,\"rid\":\"2a0d73029ad24c599d6dc1e117a41897\",\"field_type\":\"t\",\"field\":\"page\",\"text\":\" + Custom frontend \\n You can also create a custom frontend for your Retrieval + Agent. This allows you to have full control over the user interface and user + experience. \\n You can directly implement the API calls to your Retrieval + Agent in your frontend code (see the Websocket API section for more details), + or you can use the JavaScript SDK provided by Agentic to simplify the integration. + \\n\",\"labels\":[],\"start_seconds\":null,\"end_seconds\":null,\"position\":{\"page_number\":0,\"index\":2,\"start\":617,\"end\":1005},\"fuzzy_result\":false},{\"score\":0.0,\"rid\":\"2a0d73029ad24c599d6dc1e117a41897\",\"field_type\":\"t\",\"field\":\"page\",\"text\":\" + MCP \\n If you want to integrate your Retrieval Agent with a broader AI-based + system (for example Claude Cowork or Copilot), it is reachable throught MCP. + \\n The MCP endpoint is visible on the agent home page on the dashboard.\",\"labels\":[],\"start_seconds\":null,\"end_seconds\":null,\"position\":{\"page_number\":0,\"index\":3,\"start\":1005,\"end\":1230},\"fuzzy_result\":false},{\"score\":0.0,\"rid\":\"2a0d73029ad24c599d6dc1e117a41897\",\"field_type\":\"t\",\"field\":\"page\",\"text\":\" + \\n id: deploy \\n title: Deploy \\n \\n Deploy \\n Your Agentic Retrieval + Agent can be deployed in different ways, depending on your needs and the environment + you are working in. \\n Ready-to-use widget \\n The easiest way to deploy + your Retrieval Agent is to use the ready-to-use widget. You can embed it in + your website or application, and it will provide a chat user interface for + interacting with the agent. \\n\",\"labels\":[],\"start_seconds\":null,\"end_seconds\":null,\"position\":{\"page_number\":0,\"index\":0,\"start\":0,\"end\":401},\"fuzzy_result\":false},{\"score\":0.0,\"rid\":\"2a0d73029ad24c599d6dc1e117a41897\",\"field_type\":\"t\",\"field\":\"page\",\"text\":\" + Go to the Widgets section in the left menu, and click on Create widget to + create a new widget. You can customize its appearance, and then copy the generated + code snippet to embed it in your website or application. \\n\",\"labels\":[],\"start_seconds\":null,\"end_seconds\":null,\"position\":{\"page_number\":0,\"index\":1,\"start\":401,\"end\":617},\"fuzzy_result\":false}],\"facets\":{\"/k\":{\"/k/text\":5294}},\"query\":\"\",\"total\":5294,\"page_number\":0,\"page_size\":20,\"next_page\":true,\"min_score\":0.0},\"fulltext\":{\"results\":[{\"score\":0.0,\"rid\":\"007b445866574d7ca69891d388663cc6\",\"field_type\":\"t\",\"field\":\"page\",\"labels\":[]},{\"score\":0.0,\"rid\":\"007b445866574d7ca69891d388663cc6\",\"field_type\":\"a\",\"field\":\"title\",\"labels\":[]},{\"score\":0.0,\"rid\":\"b28e388104644fc5bba68c0cd44e01d4\",\"field_type\":\"a\",\"field\":\"title\",\"labels\":[]},{\"score\":0.0,\"rid\":\"b28e388104644fc5bba68c0cd44e01d4\",\"field_type\":\"t\",\"field\":\"page\",\"labels\":[]},{\"score\":0.0,\"rid\":\"2a0d73029ad24c599d6dc1e117a41897\",\"field_type\":\"t\",\"field\":\"page\",\"labels\":[]},{\"score\":0.0,\"rid\":\"2a0d73029ad24c599d6dc1e117a41897\",\"field_type\":\"a\",\"field\":\"title\",\"labels\":[]},{\"score\":0.0,\"rid\":\"f13642b2862f4a1ea2144c9eb2abb2a3\",\"field_type\":\"a\",\"field\":\"title\",\"labels\":[]},{\"score\":0.0,\"rid\":\"f13642b2862f4a1ea2144c9eb2abb2a3\",\"field_type\":\"t\",\"field\":\"page\",\"labels\":[]},{\"score\":0.0,\"rid\":\"ed6fda7434aa43a3bd5138b95e7fe081\",\"field_type\":\"t\",\"field\":\"page\",\"labels\":[]},{\"score\":0.0,\"rid\":\"ed6fda7434aa43a3bd5138b95e7fe081\",\"field_type\":\"a\",\"field\":\"title\",\"labels\":[]},{\"score\":0.0,\"rid\":\"a572ce0c7eb949e4a17babae21a03a4a\",\"field_type\":\"t\",\"field\":\"kb-resources\",\"labels\":[]},{\"score\":0.0,\"rid\":\"a572ce0c7eb949e4a17babae21a03a4a\",\"field_type\":\"t\",\"field\":\"kb-search\",\"labels\":[]},{\"score\":0.0,\"rid\":\"a572ce0c7eb949e4a17babae21a03a4a\",\"field_type\":\"t\",\"field\":\"kb-rag-lab\",\"labels\":[]},{\"score\":0.0,\"rid\":\"a572ce0c7eb949e4a17babae21a03a4a\",\"field_type\":\"t\",\"field\":\"account-arag\",\"labels\":[]},{\"score\":0.0,\"rid\":\"a572ce0c7eb949e4a17babae21a03a4a\",\"field_type\":\"t\",\"field\":\"kb-kv-schemas\",\"labels\":[]},{\"score\":0.0,\"rid\":\"a572ce0c7eb949e4a17babae21a03a4a\",\"field_type\":\"t\",\"field\":\"user-profile\",\"labels\":[]},{\"score\":0.0,\"rid\":\"a572ce0c7eb949e4a17babae21a03a4a\",\"field_type\":\"t\",\"field\":\"kb-users\",\"labels\":[]},{\"score\":0.0,\"rid\":\"a572ce0c7eb949e4a17babae21a03a4a\",\"field_type\":\"t\",\"field\":\"kb-widgets\",\"labels\":[]},{\"score\":0.0,\"rid\":\"a572ce0c7eb949e4a17babae21a03a4a\",\"field_type\":\"t\",\"field\":\"kb-remi-analytics\",\"labels\":[]},{\"score\":0.0,\"rid\":\"a572ce0c7eb949e4a17babae21a03a4a\",\"field_type\":\"t\",\"field\":\"agent-users\",\"labels\":[]}],\"facets\":{},\"query\":\"\",\"total\":2013,\"page_number\":0,\"page_size\":20,\"next_page\":true,\"min_score\":0.0},\"shards\":[\"306cbabb-72a5-417c-827f-7874e205c858\"]}" headers: Alt-Svc: - - h3=":443"; ma=2592000 + - h3=":443"; ma=2592000,h3-29=":443"; ma=2592000 Content-Length: - - '15653' + - '16898' access-control-expose-headers: - X-NUCLIA-TRACE-ID content-type: - application/json date: - - Wed, 03 Jun 2026 07:59:58 GMT + - Mon, 13 Jul 2026 08:57:51 GMT via: - 1.1 google x-envoy-upstream-service-time: - - '142' + - '69' x-nuclia-trace-id: - - 20dbd7c1c962db2927542741b7c5582d + - c330d27bc17b0cff24d5c0454978b71f status: code: 200 message: OK - request: - body: '{"query": "What is the purpose and usage of `max_tokens` in Nuclia, and - what is a Cardamom bun?", "filters": [], "citations": true, "generative_model": - "chatgpt-azure-4o-mini"}' + body: '{"query": "How is `max_tokens` utilized within the Nuclia system, and what + is a Cardamom bun?", "filters": [], "citations": true, "generative_model": "chatgpt-azure-4o-mini"}' headers: Accept: - '*/*' @@ -676,7 +700,7 @@ interactions: Connection: - keep-alive Content-Length: - - '169' + - '167' Host: - europe-1.rag.progress.cloud User-Agent: @@ -689,25 +713,26 @@ interactions: uri: https://europe-1.rag.progress.cloud/api/v1/kb/df8b4c24-2807-4888-ad6c-ae97357a638b/ask response: body: - string: "{\"item\":{\"type\":\"answer\",\"text\":\"The\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\" - `\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\"max\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\"_tokens\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\"`\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\" - parameter\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\" in\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\" + string: "{\"item\":{\"type\":\"answer\",\"text\":\"`\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\"max\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\"_tokens\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\"`\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\" + is\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\" utilized\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\" + within\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\" the\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\" Nu\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\"cl\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\"ia\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\" - is\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\" used\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\" - to\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\" set\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\" - hard\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\" limits\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\" - on\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\" context\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\" - size\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\" and\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\" + system\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\" to\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\" + set\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\" hard\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\" + limits\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\" on\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\" + both\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\" the\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\" + context\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\" size\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\" + and\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\" the\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\" answer\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\" length\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\" - when\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\" interacting\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\" - with\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\" the\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\" - /\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\"ask\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\" + when\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\" using\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\" + the\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\" `/\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\"ask\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\"`\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\" endpoint\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\".\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\" It\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\" defines\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\" the\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\" maximum\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\" number\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\" of\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\" input\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\" tokens\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\" - to\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\" include\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\" + that\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\" can\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\" + be\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\" included\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\" in\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\" the\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\" final\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\" context\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\",\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\" which\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\" encompasses\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\" @@ -715,144 +740,36 @@ interactions: retrieved\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\" results\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\",\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\" and\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\" the\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\" user\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\" question\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\".\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\" - This\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\" helps\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\" - manage\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\" the\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\" - amount\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\" of\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\" - information\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\" sent\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\" - to\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\" the\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\" - language\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\" model\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\" - (\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\"LL\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\"M\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\")\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\" - and\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\" controls\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\" + Additionally\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\",\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\" + it\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\" limits\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\" the\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\" length\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\" of\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\" the\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\" generated\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\" response\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\".\\n\\n\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\"Not\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\" enough\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\" data\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\" to\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\" answer\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\" - this\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\".\"}}\n{\"item\":{\"type\":\"retrieval\",\"results\":{\"resources\":{\"8b3e0ef630a346d1b591143309db87ec\":{\"id\":\"8b3e0ef630a346d1b591143309db87ec\",\"slug\":\"docs-develop-js-sdk-interfaces-NucliaTokensMetric-md\",\"title\":\"docs - > develop > js sdk > interfaces > NucliaTokensMetric\",\"summary\":\"\",\"icon\":\"text/markdown\",\"thumbnail\":\"\",\"metadata\":{\"metadata\":{},\"language\":\"en\",\"languages\":[\"la\",\"en\"],\"status\":\"PROCESSED\"},\"usermetadata\":{\"classifications\":[],\"relations\":[]},\"fieldmetadata\":[],\"computedmetadata\":{\"field_classifications\":[]},\"created\":\"2025-04-15T14:48:48.423622\",\"modified\":\"2026-06-02T15:41:27.179307\",\"last_seqid\":0,\"queue\":\"private\",\"hidden\":false,\"fields\":{\"/t/page\":{\"paragraphs\":{\"8b3e0ef630a346d1b591143309db87ec/t/page/281-511\":{\"score\":0.002540992572903633,\"score_type\":\"RERANKER\",\"order\":18,\"text\":\" - name: nuclia_tokens \\n \\n Overrides \\n UsageMetric.name \\n Defined in - \\n libs/sdk-core/src/lib/db/db.models.ts:183 \\n \\n value \\n \\n value: - number \\n \\n Overrides \\n UsageMetric.value \\n Defined in \\n libs/sdk-core/src/lib/db/db.models.ts:184\",\"id\":\"8b3e0ef630a346d1b591143309db87ec/t/page/281-511\",\"labels\":[\"/k/text\"],\"position\":{\"page_number\":0,\"index\":0,\"start\":281,\"end\":511,\"start_seconds\":[],\"end_seconds\":[]},\"fuzzy_result\":false,\"page_with_visual\":false,\"is_a_table\":false}}}}},\"9f7036a7a6694700b72d52eb58a8326c\":{\"id\":\"9f7036a7a6694700b72d52eb58a8326c\",\"slug\":\"docs-rag-advanced-widget-features-md\",\"title\":\"docs - > rag > advanced > widget > features\",\"summary\":\"\",\"icon\":\"text/markdown\",\"thumbnail\":\"\",\"metadata\":{\"metadata\":{},\"language\":\"en\",\"languages\":[\"en\"],\"status\":\"PROCESSED\"},\"usermetadata\":{\"classifications\":[],\"relations\":[]},\"fieldmetadata\":[],\"computedmetadata\":{\"field_classifications\":[]},\"created\":\"2024-07-18T14:32:26.204740\",\"modified\":\"2025-10-27T14:35:08.325400\",\"last_seqid\":0,\"queue\":\"private\",\"hidden\":false,\"fields\":{\"/t/page\":{\"paragraphs\":{\"9f7036a7a6694700b72d52eb58a8326c/t/page/5203-5412\":{\"score\":0.39729517698287964,\"score_type\":\"RERANKER\",\"order\":0,\"text\":\" - max_tokens: the maximum number of input tokens to put in the final context - (including the prompt, the retrieved results and the user question). \\n max_output_tokens: - the maximum number of tokens to generate. \\n\",\"id\":\"9f7036a7a6694700b72d52eb58a8326c/t/page/5203-5412\",\"labels\":[],\"position\":{\"page_number\":0,\"index\":0,\"start\":5203,\"end\":5412,\"start_seconds\":[],\"end_seconds\":[]},\"fuzzy_result\":false,\"page_with_visual\":false,\"is_a_table\":false}}}}},\"4039d76b0fff4962900836ab3fdec9f7\":{\"id\":\"4039d76b0fff4962900836ab3fdec9f7\",\"slug\":\"docs-rag-advanced-consumption-mdx\",\"title\":\"docs - > rag > advanced > consumption.\",\"summary\":\"\",\"icon\":\"text/markdown\",\"thumbnail\":\"\",\"metadata\":{\"metadata\":{},\"language\":\"en\",\"languages\":[\"en\"],\"status\":\"PROCESSED\"},\"usermetadata\":{\"classifications\":[],\"relations\":[]},\"fieldmetadata\":[],\"computedmetadata\":{\"field_classifications\":[]},\"created\":\"2025-10-03T08:32:26.341394\",\"modified\":\"2026-06-02T22:04:59.702465\",\"last_seqid\":0,\"queue\":\"private\",\"hidden\":false,\"fields\":{\"/t/page\":{\"paragraphs\":{\"4039d76b0fff4962900836ab3fdec9f7/t/page/3075-3340\":{\"score\":0.18417984247207642,\"score_type\":\"RERANKER\",\"order\":1,\"text\":\" - Use the max_tokens parameter on the /ask endpoint to set hard limits on: \\n - - Context size: Limits the amount of retrieved information sent to the LLM - \\n - Answer length: Limits the length of the generated response \\n Important - Considerations \\n Context Limitations: \\n\",\"id\":\"4039d76b0fff4962900836ab3fdec9f7/t/page/3075-3340\",\"labels\":[],\"position\":{\"page_number\":0,\"index\":0,\"start\":3075,\"end\":3340,\"start_seconds\":[],\"end_seconds\":[]},\"fuzzy_result\":false,\"page_with_visual\":false,\"is_a_table\":false}}}}},\"38ec4cc5c66e436a946ea7893b6662a3\":{\"id\":\"38ec4cc5c66e436a946ea7893b6662a3\",\"slug\":\"docs-changelog-updates-2024-10-md\",\"title\":\"docs - > changelog > updates > 2024 10\",\"summary\":\"\",\"icon\":\"text/markdown\",\"thumbnail\":\"\",\"metadata\":{\"metadata\":{},\"language\":\"en\",\"languages\":[\"en\"],\"status\":\"PROCESSED\"},\"usermetadata\":{\"classifications\":[],\"relations\":[]},\"fieldmetadata\":[],\"computedmetadata\":{\"field_classifications\":[]},\"created\":\"2025-04-15T14:51:49.934688\",\"modified\":\"2025-09-05T09:45:37.729522\",\"last_seqid\":0,\"queue\":\"private\",\"hidden\":false,\"fields\":{\"/t/page\":{\"paragraphs\":{\"38ec4cc5c66e436a946ea7893b6662a3/t/page/2462-2855\":{\"score\":0.004591683857142925,\"score_type\":\"RERANKER\",\"order\":16,\"text\":\" - \\n On the UI Front \U0001F485 \\n \\n Take Control of Your Budget \U0001F4B0 - Set smart spending limits with our new budget control feature. Get warnings - or automatic blocks based on your preferences. \\n Enhanced Usage Display - \U0001F4CA Track your Nuclia Token consumption, amounts of queries, and averaged - costs in the Nuclia Dashboard. Make informed decisions about your Nuclia Token - usage and better plan for the future. \\n\",\"id\":\"38ec4cc5c66e436a946ea7893b6662a3/t/page/2462-2855\",\"labels\":[\"/k/text\"],\"position\":{\"page_number\":0,\"index\":0,\"start\":2462,\"end\":2855,\"start_seconds\":[],\"end_seconds\":[]},\"fuzzy_result\":false,\"page_with_visual\":false,\"is_a_table\":false}}}}},\"44d05174f1954331b62f5e4026f2b01a\":{\"id\":\"44d05174f1954331b62f5e4026f2b01a\",\"slug\":\"docs-develop-python-sdk-14-rao-md\",\"title\":\"docs - > develop > python sdk > 14 rao\",\"summary\":\"\",\"icon\":\"text/markdown\",\"thumbnail\":\"\",\"metadata\":{\"metadata\":{},\"language\":\"en\",\"languages\":[\"en\"],\"status\":\"PROCESSED\"},\"usermetadata\":{\"classifications\":[],\"relations\":[]},\"fieldmetadata\":[],\"computedmetadata\":{\"field_classifications\":[]},\"created\":\"2025-12-22T13:38:09.919472\",\"modified\":\"2025-12-30T08:56:44.797830\",\"last_seqid\":0,\"queue\":\"private\",\"hidden\":false,\"fields\":{\"/t/page\":{\"paragraphs\":{\"44d05174f1954331b62f5e4026f2b01a/t/page/6346-6668\":{\"score\":0.002387409098446369,\"score_type\":\"RERANKER\",\"order\":19,\"text\":\" - \\n step: Information about the current processing step \\n module: The module - being executed (e.g., rephrase , basic_ask , remi ) \\n title: Display title - for the step \\n value: Result of the step \\n reason: Explanation for the - step \\n timeit: Time taken in seconds \\n \\n input_nuclia_tokens/output_nuclia_tokens: - Token usage \\n \\n \\n\",\"id\":\"44d05174f1954331b62f5e4026f2b01a/t/page/6346-6668\",\"labels\":[],\"position\":{\"page_number\":0,\"index\":0,\"start\":6346,\"end\":6668,\"start_seconds\":[],\"end_seconds\":[]},\"fuzzy_result\":false,\"page_with_visual\":false,\"is_a_table\":false}}}}},\"72cfaa1fb6674964807e055bd9d21ce5\":{\"id\":\"72cfaa1fb6674964807e055bd9d21ce5\",\"slug\":\"docs-ingestion-how-to-create-da-agents-md\",\"title\":\"docs - > ingestion > how to > create da agents\",\"summary\":\"\",\"icon\":\"text/markdown\",\"thumbnail\":\"\",\"metadata\":{\"metadata\":{},\"language\":\"en\",\"languages\":[\"en\"],\"status\":\"PROCESSED\"},\"usermetadata\":{\"classifications\":[],\"relations\":[]},\"fieldmetadata\":[],\"computedmetadata\":{\"field_classifications\":[]},\"created\":\"2025-04-15T14:52:07.016379\",\"modified\":\"2026-05-04T10:37:14.868688\",\"last_seqid\":0,\"queue\":\"private\",\"hidden\":false,\"fields\":{\"/t/page\":{\"paragraphs\":{\"72cfaa1fb6674964807e055bd9d21ce5/t/page/4164-4904\":{\"score\":0.011115013621747494,\"score_type\":\"RERANKER\",\"order\":12,\"text\":\" - ```python \\n from nuclia import sdk \\n from nuclia_models.worker.tasks import - TaskName, ApplyOptions, DataAugmentation \\n from nuclia_models.worker.proto - import ( \\n ApplyTo, \\n Filter, \\n LLMConfig, \\n Operation, \\n QAOperation, - \\n EntityDefinition, \\n ) \\n KNOWLEDGE_BOX_URL = ( \\n https://europe-1.rag.progress.cloud/api/v1/kb/ - \\n ) \\n sdk.NucliaAuth().kb(url=KNOWLEDGE_BOX_URL, token= ) \\n kb = sdk.NucliaKB() - \\n output = kb.task.start( \\n task_name=TaskName.SYNTHETIC_QUESTIONS, \\n - apply=ApplyOptions.NEW, \\n parameters=DataAugmentation( \\n name= my-q&a-task - , \\n on=ApplyTo.FIELD, \\n filter=Filter(), \\n operations=[Operation(qa=QAOperation(max_questions=10))], - \\n llm=LLMConfig(model= chatgpt-azure-4o-mini ), \\n ), \\n ) \\n print(output) - \\n ``` \\n ```bash \\n \\n \\n\",\"id\":\"72cfaa1fb6674964807e055bd9d21ce5/t/page/4164-4904\",\"labels\":[\"/k/text\"],\"position\":{\"page_number\":0,\"index\":0,\"start\":4164,\"end\":4904,\"start_seconds\":[],\"end_seconds\":[]},\"fuzzy_result\":false,\"page_with_visual\":false,\"is_a_table\":false}}}}},\"60f6caceef5045399ea22af5ce4f31a4\":{\"id\":\"60f6caceef5045399ea22af5ce4f31a4\",\"slug\":\"docs-develop-python-sdk-12-da-agents-md\",\"title\":\"docs - > develop > python sdk > 12 da agents\",\"summary\":\"\",\"icon\":\"text/markdown\",\"thumbnail\":\"\",\"metadata\":{\"metadata\":{},\"language\":\"en\",\"languages\":[\"en\"],\"status\":\"PROCESSED\"},\"usermetadata\":{\"classifications\":[],\"relations\":[]},\"fieldmetadata\":[],\"computedmetadata\":{\"field_classifications\":[]},\"created\":\"2025-04-15T14:48:37.143769\",\"modified\":\"2025-04-15T14:48:37.143778\",\"last_seqid\":0,\"queue\":\"private\",\"hidden\":false,\"fields\":{\"/t/page\":{\"paragraphs\":{\"60f6caceef5045399ea22af5ce4f31a4/t/page/962-2943\":{\"score\":0.023153411224484444,\"score_type\":\"RERANKER\",\"order\":9,\"text\":\" - Dashboard label: Content Safety \\n PROMPT_GUARD: Detect and label content - related to jailbreak attempts. \\n Dashboard label: LLM Security \\n \\n \\n - How to Use Tasks \\n Create a task \\n SDK Example \\n ```python \\n from - nuclia import sdk \\n from nuclia_models.worker.tasks import TaskName, ApplyOptions, - DataAugmentation \\n from nuclia_models.worker.proto import ApplyTo, Filter, - LLMConfig, Operation \\n kb = sdk.NucliaKB() \\n kb.task.start( \\n task_name=TaskName.LABELER, - \\n apply=ApplyOptions.EXISTING, \\n parameters=DataAugmentation( \\n name= - test , \\n on=ApplyTo.FIELD, \\n filter=Filter(), \\n operations=[Operation()], - \\n llm=LLMConfig(), \\n ), \\n ) \\n ``` \\n CLI Example \\n bash \\n nuclia - kb task start --task_name=labeler --apply=existing --parameters='{ \\n name - : test , \\n on : 1, \\n filter : {}, \\n operations : [ \\n {} \\n ], \\n - llm : {} \\n }' \\n List all tasks \\n SDK Example \\n ```python \\n from - nuclia import sdk \\n kb = sdk.NucliaKB() \\n kb.task.list() \\n ``` \\n CLI - Example \\n bash \\n nuclia kb task list \\n Get a task \\n SDK Example \\n - ```python \\n from nuclia import sdk \\n kb = sdk.NucliaKB() \\n kb.task.get(task_id= - 71018fb9-053e-4ca0-9d89-226ada9598e6 ) \\n ``` \\n CLI Example \\n bash \\n - nuclia kb task get --task_id=71018fb9-053e-4ca0-9d89-226ada9598e6 \\n Stop - a task \\n SDK Example \\n ```python \\n from nuclia import sdk \\n kb = sdk.NucliaKB() - \\n kb.task.stop(task_id= 71018fb9-053e-4ca0-9d89-226ada9598e6 ) \\n ``` \\n - CLI Example \\n bash \\n nuclia kb task stop --task_id=71018fb9-053e-4ca0-9d89-226ada9598e6 - \\n Restart a task \\n SDK Example \\n ```python \\n from nuclia import sdk - \\n kb = sdk.NucliaKB() \\n kb.task.restart(task_id= 71018fb9-053e-4ca0-9d89-226ada9598e6 - ) \\n ``` \\n CLI Example \\n bash \\n nuclia kb task restart --task_id=71018fb9-053e-4ca0-9d89-226ada9598e6 - \\n Delete a task \\n SDK Example \\n ```python \\n from nuclia import sdk - \\n kb = sdk.NucliaKB() \\n kb.task.delete(task_id= 71018fb9-053e-4ca0-9d89-226ada9598e6 - ) \\n ``` \\n CLI Example \\n bash \\n nuclia kb task delete --task_id=71018fb9-053e-4ca0-9d89-226ada9598e6 - \\n \\n Notes \\n \\n\",\"id\":\"60f6caceef5045399ea22af5ce4f31a4/t/page/962-2943\",\"labels\":[\"/k/text\"],\"position\":{\"page_number\":0,\"index\":0,\"start\":962,\"end\":2943,\"start_seconds\":[],\"end_seconds\":[]},\"fuzzy_result\":false,\"page_with_visual\":false,\"is_a_table\":false}}}}},\"e8525e64c5b44982b958d32cf6090613\":{\"id\":\"e8525e64c5b44982b958d32cf6090613\",\"slug\":\"docs-develop-js-sdk-interfaces-ChatOptions-md\",\"title\":\"docs - > develop > js sdk > interfaces > ChatOptions\",\"summary\":\"\",\"icon\":\"text/markdown\",\"thumbnail\":\"\",\"metadata\":{\"metadata\":{},\"language\":\"en\",\"languages\":[\"en\"],\"status\":\"PROCESSED\"},\"usermetadata\":{\"classifications\":[],\"relations\":[]},\"fieldmetadata\":[],\"computedmetadata\":{\"field_classifications\":[]},\"created\":\"2025-04-15T14:50:37.546010\",\"modified\":\"2026-06-02T15:40:39.731007\",\"last_seqid\":0,\"queue\":\"private\",\"hidden\":false,\"fields\":{\"/t/page\":{\"paragraphs\":{\"e8525e64c5b44982b958d32cf6090613/t/page/2450-2808\":{\"score\":0.015424552373588085,\"score_type\":\"RERANKER\",\"order\":10,\"text\":\" + this\"}}\n{\"item\":{\"type\":\"answer\",\"text\":\".\"}}\n{\"item\":{\"type\":\"retrieval\",\"results\":{\"resources\":{\"e8525e64c5b44982b958d32cf6090613\":{\"id\":\"e8525e64c5b44982b958d32cf6090613\",\"slug\":\"docs-develop-js-sdk-interfaces-ChatOptions-md\",\"title\":\"docs + > develop > js sdk > interfaces > ChatOptions\",\"summary\":\"\",\"icon\":\"text/markdown\",\"thumbnail\":\"\",\"metadata\":{\"metadata\":{},\"language\":\"en\",\"languages\":[\"en\"],\"status\":\"PROCESSED\"},\"usermetadata\":{\"classifications\":[],\"relations\":[]},\"fieldmetadata\":[],\"computedmetadata\":{\"field_classifications\":[]},\"created\":\"2025-04-15T14:50:37.546010\",\"modified\":\"2026-07-13T08:05:43.436778\",\"last_seqid\":0,\"queue\":\"private\",\"hidden\":false,\"fields\":{\"/t/page\":{\"paragraphs\":{\"e8525e64c5b44982b958d32cf6090613/t/page/2450-2808\":{\"score\":0.011508149094879627,\"score_type\":\"RERANKER\",\"order\":7,\"text\":\" \\n optional highlight: boolean \\n \\n Inherited from \\n BaseSearchOptions.highlight \\n Defined in \\n libs/sdk-core/src/lib/db/search/search.models.ts:76 \\n \\n keyword_filters? \\n \\n optional keyword_filters: string[] \\\\| Filter[] \\n \\n Inherited from \\n BaseSearchOptions.keyword_filters \\n Defined in \\n libs/sdk-core/src/lib/db/search/search.models.ts:65 \\n \\n max_tokens? - \\n\",\"id\":\"e8525e64c5b44982b958d32cf6090613/t/page/2450-2808\",\"labels\":[],\"position\":{\"page_number\":0,\"index\":0,\"start\":2450,\"end\":2808,\"start_seconds\":[],\"end_seconds\":[]},\"fuzzy_result\":false,\"page_with_visual\":false,\"is_a_table\":false},\"e8525e64c5b44982b958d32cf6090613/t/page/2808-3011\":{\"score\":0.009303949773311615,\"score_type\":\"RERANKER\",\"order\":13,\"text\":\" + \\n\",\"id\":\"e8525e64c5b44982b958d32cf6090613/t/page/2450-2808\",\"labels\":[],\"position\":{\"page_number\":0,\"index\":0,\"start\":2450,\"end\":2808,\"start_seconds\":[],\"end_seconds\":[]},\"fuzzy_result\":false,\"page_with_visual\":false,\"is_a_table\":false},\"e8525e64c5b44982b958d32cf6090613/t/page/2808-3011\":{\"score\":0.00682395463809371,\"score_type\":\"RERANKER\",\"order\":13,\"text\":\" \\n optional max_tokens: number \\\\| object \\n \\n Defines the maximum number of tokens that the model will take as context. \\n Defined in \\n libs/sdk-core/src/lib/db/search/search.models.ts:112 \\n \\n min_score? \\n\",\"id\":\"e8525e64c5b44982b958d32cf6090613/t/page/2808-3011\",\"labels\":[],\"position\":{\"page_number\":0,\"index\":0,\"start\":2808,\"end\":3011,\"start_seconds\":[],\"end_seconds\":[]},\"fuzzy_result\":false,\"page_with_visual\":false,\"is_a_table\":false}}}}},\"220eb37c167f4eb9bb8e9454e7ba8cf5\":{\"id\":\"220eb37c167f4eb9bb8e9454e7ba8cf5\",\"slug\":\"docs-develop-python-sdk-05-search-md\",\"title\":\"docs - > develop > python sdk > 05 search\",\"summary\":\"\",\"icon\":\"text/markdown\",\"thumbnail\":\"\",\"metadata\":{\"metadata\":{},\"language\":\"en\",\"languages\":[\"en\"],\"status\":\"PROCESSED\"},\"usermetadata\":{\"classifications\":[],\"relations\":[]},\"fieldmetadata\":[],\"computedmetadata\":{\"field_classifications\":[]},\"created\":\"2025-04-15T14:48:33.723913\",\"modified\":\"2025-09-18T11:01:18.918196\",\"last_seqid\":0,\"queue\":\"private\",\"hidden\":false,\"fields\":{\"/t/page\":{\"paragraphs\":{\"220eb37c167f4eb9bb8e9454e7ba8cf5/t/page/1790-2276\":{\"score\":0.10158944875001907,\"score_type\":\"RERANKER\",\"order\":4,\"text\":\" + > develop > python sdk > 05 search\",\"summary\":\"\",\"icon\":\"text/markdown\",\"thumbnail\":\"\",\"metadata\":{\"metadata\":{},\"language\":\"en\",\"languages\":[\"en\"],\"status\":\"PROCESSED\"},\"usermetadata\":{\"classifications\":[],\"relations\":[]},\"fieldmetadata\":[],\"computedmetadata\":{\"field_classifications\":[]},\"created\":\"2025-04-15T14:48:33.723913\",\"modified\":\"2026-06-09T08:08:04.866092\",\"last_seqid\":0,\"queue\":\"private\",\"hidden\":false,\"fields\":{\"/t/page\":{\"paragraphs\":{\"220eb37c167f4eb9bb8e9454e7ba8cf5/t/page/1790-2276\":{\"score\":0.0799255222082138,\"score_type\":\"RERANKER\",\"order\":1,\"text\":\" \\n SDK: \\n \\n ```python \\n from nuclia import sdk \\n from nucliadb_models.search import AskRequest, Reasoning \\n search = sdk.NucliaSearch() \\n query = AskRequest( \\n query= My question with extra reasoning effort , \\n max_tokens=5000, \\n reasoning=Reasoning( \\n display=True, # Show reasoning in the response \\n effort= low , # Can be low , medium , or high \\n budget_tokens=1024 # How many tokens reasoning can use \\n ), \\n ) \\n search.ask(query=query) - \\n ``` \\n Model Support for Reasoning Options: \\n\",\"id\":\"220eb37c167f4eb9bb8e9454e7ba8cf5/t/page/1790-2276\",\"labels\":[],\"position\":{\"page_number\":0,\"index\":0,\"start\":1790,\"end\":2276,\"start_seconds\":[],\"end_seconds\":[]},\"fuzzy_result\":false,\"page_with_visual\":false,\"is_a_table\":false},\"220eb37c167f4eb9bb8e9454e7ba8cf5/t/page/2505-2709\":{\"score\":0.05592617020010948,\"score_type\":\"RERANKER\",\"order\":7,\"text\":\" + \\n ``` \\n Model Support for Reasoning Options: \\n\",\"id\":\"220eb37c167f4eb9bb8e9454e7ba8cf5/t/page/1790-2276\",\"labels\":[],\"position\":{\"page_number\":0,\"index\":0,\"start\":1790,\"end\":2276,\"start_seconds\":[],\"end_seconds\":[]},\"fuzzy_result\":false,\"page_with_visual\":false,\"is_a_table\":false},\"220eb37c167f4eb9bb8e9454e7ba8cf5/t/page/2505-2709\":{\"score\":0.010529711842536926,\"score_type\":\"RERANKER\",\"order\":9,\"text\":\" ::: \\n :::warning \\n Enabling reasoning can use additional tokens, which may increase your usage costs. \\n You may need to increase max_tokens to - give the LLM enough room to reason and generate an answer. \\n\",\"id\":\"220eb37c167f4eb9bb8e9454e7ba8cf5/t/page/2505-2709\",\"labels\":[],\"position\":{\"page_number\":0,\"index\":0,\"start\":2505,\"end\":2709,\"start_seconds\":[],\"end_seconds\":[]},\"fuzzy_result\":false,\"page_with_visual\":false,\"is_a_table\":false}}}}},\"50aac6f34b6d47de8e3b01f8b2de6e9c\":{\"id\":\"50aac6f34b6d47de8e3b01f8b2de6e9c\",\"slug\":\"docs-develop-js-sdk-interfaces-PredictAnswerOptions-md\",\"title\":\"docs - > develop > js sdk > interfaces > PredictAnswerOptions\",\"summary\":\"\",\"icon\":\"text/markdown\",\"thumbnail\":\"\",\"metadata\":{\"metadata\":{},\"language\":\"en\",\"languages\":[\"en\"],\"status\":\"PROCESSED\"},\"usermetadata\":{\"classifications\":[],\"relations\":[]},\"fieldmetadata\":[],\"computedmetadata\":{\"field_classifications\":[]},\"created\":\"2025-08-26T10:03:11.443619\",\"modified\":\"2026-06-02T15:39:28.012340\",\"last_seqid\":0,\"queue\":\"private\",\"hidden\":false,\"fields\":{\"/t/page\":{\"paragraphs\":{\"50aac6f34b6d47de8e3b01f8b2de6e9c/t/page/977-1221\":{\"score\":0.013689477927982807,\"score_type\":\"RERANKER\",\"order\":11,\"text\":\" - \\n optional max_tokens: number \\n \\n Defined in \\n libs/sdk-core/src/lib/db/search/ask.models.ts:251 - \\n \\n prefer_markdown? \\n \\n optional prefer_markdown: boolean \\n \\n - Defined in \\n libs/sdk-core/src/lib/db/search/ask.models.ts:256 \\n \\n query_context? - \\n\",\"id\":\"50aac6f34b6d47de8e3b01f8b2de6e9c/t/page/977-1221\",\"labels\":[],\"position\":{\"page_number\":0,\"index\":0,\"start\":977,\"end\":1221,\"start_seconds\":[],\"end_seconds\":[]},\"fuzzy_result\":false,\"page_with_visual\":false,\"is_a_table\":false},\"50aac6f34b6d47de8e3b01f8b2de6e9c/t/page/739-977\":{\"score\":0.006641112733632326,\"score_type\":\"RERANKER\",\"order\":15,\"text\":\" - \\n optional generative_model: string \\n \\n Defined in \\n libs/sdk-core/src/lib/db/search/ask.models.ts:250 - \\n \\n json_schema? \\n \\n optional json_schema: object \\n \\n Defined - in \\n libs/sdk-core/src/lib/db/search/ask.models.ts:257 \\n \\n max_tokens? - \\n\",\"id\":\"50aac6f34b6d47de8e3b01f8b2de6e9c/t/page/739-977\",\"labels\":[],\"position\":{\"page_number\":0,\"index\":0,\"start\":739,\"end\":977,\"start_seconds\":[],\"end_seconds\":[]},\"fuzzy_result\":false,\"page_with_visual\":false,\"is_a_table\":false}}}}},\"666b3a9d01f74323b6ca6c9939834bec\":{\"id\":\"666b3a9d01f74323b6ca6c9939834bec\",\"slug\":\"docs-develop-js-sdk-enums-StatsType-md\",\"title\":\"docs - > develop > js sdk > enums > StatsType\",\"summary\":\"\",\"icon\":\"text/markdown\",\"thumbnail\":\"\",\"metadata\":{\"metadata\":{},\"language\":\"en\",\"languages\":[\"en\",\"sv\"],\"status\":\"PROCESSED\"},\"usermetadata\":{\"classifications\":[],\"relations\":[]},\"fieldmetadata\":[],\"computedmetadata\":{\"field_classifications\":[]},\"created\":\"2025-04-15T14:51:41.005040\",\"modified\":\"2025-04-15T14:51:41.005050\",\"last_seqid\":0,\"queue\":\"private\",\"hidden\":false,\"fields\":{\"/t/page\":{\"paragraphs\":{\"666b3a9d01f74323b6ca6c9939834bec/t/page/0-1386\":{\"score\":0.029479410499334335,\"score_type\":\"RERANKER\",\"order\":8,\"text\":\"@nuclia/core - / Exports / StatsType \\n Enumeration: StatsType \\n Deprecated \\n Table - of contents \\n Enumeration Members \\n \\n AI_TOKENS_USED \\n BYTES \\n CHARS - \\n DOCS_NO_MEDIA \\n MEDIA_SECONDS \\n PAGES \\n PROCESSING_TIME \\n RESOURCES - \\n SEARCHES \\n SUGGESTIONS \\n TRAIN_SECONDS \\n \\n Enumeration Members - \\n AI_TOKENS_USED \\n \u2022 AI_TOKENS_USED = ai_tokens_used \\n Defined - in \\n libs/sdk-core/src/lib/db/db.models.ts:206 \\n \\n BYTES \\n \u2022 - BYTES = bytes \\n Defined in \\n libs/sdk-core/src/lib/db/db.models.ts:200 - \\n \\n CHARS \\n \u2022 CHARS = chars \\n Defined in \\n libs/sdk-core/src/lib/db/db.models.ts:198 - \\n \\n DOCS_NO_MEDIA \\n \u2022 DOCS_NO_MEDIA = docs_no_media \\n Defined - in \\n libs/sdk-core/src/lib/db/db.models.ts:205 \\n \\n MEDIA_SECONDS \\n - \u2022 MEDIA_SECONDS = media_seconds \\n Defined in \\n libs/sdk-core/src/lib/db/db.models.ts:199 - \\n \\n PAGES \\n \u2022 PAGES = pages \\n Defined in \\n libs/sdk-core/src/lib/db/db.models.ts:202 - \\n \\n PROCESSING_TIME \\n \u2022 PROCESSING_TIME = processing_time \\n Defined - in \\n libs/sdk-core/src/lib/db/db.models.ts:196 \\n \\n RESOURCES \\n \u2022 - RESOURCES = resources \\n Defined in \\n libs/sdk-core/src/lib/db/db.models.ts:201 - \\n \\n SEARCHES \\n \u2022 SEARCHES = searches \\n Defined in \\n libs/sdk-core/src/lib/db/db.models.ts:197 - \\n \\n SUGGESTIONS \\n \u2022 SUGGESTIONS = suggestions \\n Defined in \\n - libs/sdk-core/src/lib/db/db.models.ts:204 \\n \\n TRAIN_SECONDS \\n \u2022 - TRAIN_SECONDS = train_seconds \\n Defined in \\n libs/sdk-core/src/lib/db/db.models.ts:203\",\"id\":\"666b3a9d01f74323b6ca6c9939834bec/t/page/0-1386\",\"labels\":[\"/k/text\"],\"position\":{\"page_number\":0,\"index\":0,\"start\":0,\"end\":1386,\"start_seconds\":[],\"end_seconds\":[]},\"fuzzy_result\":false,\"page_with_visual\":false,\"is_a_table\":false}}}}},\"6c56729cf0a44da3a4435094b8333ad5\":{\"id\":\"6c56729cf0a44da3a4435094b8333ad5\",\"slug\":\"docs-develop-js-sdk-interfaces-SamlConfig-md\",\"title\":\"docs - > develop > js sdk > interfaces > SamlConfig\",\"summary\":\"\",\"icon\":\"text/markdown\",\"thumbnail\":\"\",\"metadata\":{\"metadata\":{},\"language\":\"en\",\"languages\":[\"en\",\"eo\"],\"status\":\"PROCESSED\"},\"usermetadata\":{\"classifications\":[],\"relations\":[]},\"fieldmetadata\":[],\"computedmetadata\":{\"field_classifications\":[]},\"created\":\"2025-08-26T10:00:01.641788\",\"modified\":\"2026-06-02T15:39:56.176985\",\"last_seqid\":0,\"queue\":\"private\",\"hidden\":false,\"fields\":{\"/t/page\":{\"paragraphs\":{\"6c56729cf0a44da3a4435094b8333ad5/t/page/0-603\":{\"score\":0.008348054252564907,\"score_type\":\"RERANKER\",\"order\":14,\"text\":\"@nuclia/core - \u2022 Docs \\n \\n @nuclia/core / SamlConfig \\n Interface: SamlConfig \\n - Properties \\n authn_context? \\n \\n optional authn_context: exact \\\\| - minimum \\\\| better \\\\| maximum \\n \\n Defined in \\n libs/sdk-core/src/lib/db/db.models.ts:113 - \\n \\n domains \\n \\n domains: string[] \\n \\n Defined in \\n libs/sdk-core/src/lib/db/db.models.ts:109 - \\n \\n entity_id \\n \\n entity_id: string \\n \\n Defined in \\n libs/sdk-core/src/lib/db/db.models.ts:110 - \\n \\n sso_url \\n \\n sso_url: string \\n \\n Defined in \\n libs/sdk-core/src/lib/db/db.models.ts:111 - \\n \\n x509_cert \\n \\n x509_cert: string \\n \\n Defined in \\n libs/sdk-core/src/lib/db/db.models.ts:112\",\"id\":\"6c56729cf0a44da3a4435094b8333ad5/t/page/0-603\",\"labels\":[\"/k/text\"],\"position\":{\"page_number\":0,\"index\":0,\"start\":0,\"end\":603,\"start_seconds\":[],\"end_seconds\":[]},\"fuzzy_result\":false,\"page_with_visual\":false,\"is_a_table\":false}}}}},\"b14cf452a3434839a04c111f2ea4dc51\":{\"id\":\"b14cf452a3434839a04c111f2ea4dc51\",\"slug\":\"docs-develop-js-sdk-enums-UsageType-md\",\"title\":\"docs - > develop > js sdk > enums > UsageType\",\"summary\":\"\",\"icon\":\"text/markdown\",\"thumbnail\":\"\",\"metadata\":{\"metadata\":{},\"language\":\"en\",\"languages\":[\"en\",\"tn\"],\"status\":\"PROCESSED\"},\"usermetadata\":{\"classifications\":[],\"relations\":[]},\"fieldmetadata\":[],\"computedmetadata\":{\"field_classifications\":[]},\"created\":\"2025-04-15T14:51:41.582110\",\"modified\":\"2025-04-15T14:51:41.582119\",\"last_seqid\":0,\"queue\":\"private\",\"hidden\":false,\"fields\":{\"/t/page\":{\"paragraphs\":{\"b14cf452a3434839a04c111f2ea4dc51/t/page/0-2139\":{\"score\":0.1695433259010315,\"score_type\":\"RERANKER\",\"order\":2,\"text\":\"@nuclia/core + give the LLM enough room to reason and generate an answer. \\n\",\"id\":\"220eb37c167f4eb9bb8e9454e7ba8cf5/t/page/2505-2709\",\"labels\":[],\"position\":{\"page_number\":0,\"index\":0,\"start\":2505,\"end\":2709,\"start_seconds\":[],\"end_seconds\":[]},\"fuzzy_result\":false,\"page_with_visual\":false,\"is_a_table\":false}}}}},\"b14cf452a3434839a04c111f2ea4dc51\":{\"id\":\"b14cf452a3434839a04c111f2ea4dc51\",\"slug\":\"docs-develop-js-sdk-enums-UsageType-md\",\"title\":\"docs + > develop > js sdk > enums > UsageType\",\"summary\":\"\",\"icon\":\"text/markdown\",\"thumbnail\":\"\",\"metadata\":{\"metadata\":{},\"language\":\"en\",\"languages\":[\"en\",\"tn\"],\"status\":\"PROCESSED\"},\"usermetadata\":{\"classifications\":[],\"relations\":[]},\"fieldmetadata\":[],\"computedmetadata\":{\"field_classifications\":[]},\"created\":\"2025-04-15T14:51:41.582110\",\"modified\":\"2026-06-09T08:13:34.112208\",\"last_seqid\":0,\"queue\":\"private\",\"hidden\":false,\"fields\":{\"/t/page\":{\"paragraphs\":{\"b14cf452a3434839a04c111f2ea4dc51/t/page/0-2139\":{\"score\":0.06406543403863907,\"score_type\":\"RERANKER\",\"order\":2,\"text\":\"@nuclia/core / Exports / UsageType \\n Enumeration: UsageType \\n Table of contents \\n Enumeration Members \\n \\n AI_TOKENS_USED \\n BYTES_PROCESSED \\n CHARS_PROCESSED \\n MEDIA_FILES_PROCESSED \\n MEDIA_SECONDS_PROCESSED \\n NUCLIA_TOKENS \\n @@ -880,33 +797,220 @@ interactions: \\n Defined in \\n libs/sdk-core/src/lib/db/db.models.ts:179 \\n \\n SUGGESTIONS_PERFORMED \\n \u2022 SUGGESTIONS_PERFORMED = suggestions_performed \\n Defined in \\n libs/sdk-core/src/lib/db/db.models.ts:189 \\n \\n TRAIN_SECONDS \\n \u2022 - TRAIN_SECONDS = train_seconds \\n Defined in \\n libs/sdk-core/src/lib/db/db.models.ts:187\",\"id\":\"b14cf452a3434839a04c111f2ea4dc51/t/page/0-2139\",\"labels\":[\"/k/text\"],\"position\":{\"page_number\":0,\"index\":0,\"start\":0,\"end\":2139,\"start_seconds\":[],\"end_seconds\":[]},\"fuzzy_result\":false,\"page_with_visual\":false,\"is_a_table\":false}}}}},\"66b6f0dbd883413e98fbbf5b59f049b9\":{\"id\":\"66b6f0dbd883413e98fbbf5b59f049b9\",\"slug\":\"docs-develop-js-sdk-enumerations-UsageType-md\",\"title\":\"docs - > develop > js sdk > enumerations > UsageType\",\"summary\":\"\",\"icon\":\"text/markdown\",\"thumbnail\":\"\",\"metadata\":{\"metadata\":{},\"language\":\"en\",\"languages\":[\"en\",\"tl\"],\"status\":\"PROCESSED\"},\"usermetadata\":{\"classifications\":[],\"relations\":[]},\"fieldmetadata\":[],\"computedmetadata\":{\"field_classifications\":[]},\"created\":\"2025-08-26T09:59:02.349911\",\"modified\":\"2026-06-02T15:38:04.014988\",\"last_seqid\":0,\"queue\":\"private\",\"hidden\":false,\"fields\":{\"/t/page\":{\"paragraphs\":{\"66b6f0dbd883413e98fbbf5b59f049b9/t/page/0-1833\":{\"score\":0.14535783231258392,\"score_type\":\"RERANKER\",\"order\":3,\"text\":\"@nuclia/core - \u2022 Docs \\n \\n @nuclia/core / UsageType \\n Enumeration: UsageType \\n - Enumeration Members \\n AI_TOKENS_USED \\n \\n AI_TOKENS_USED: ai_tokens_used - \\n \\n Defined in \\n libs/sdk-core/src/lib/db/db.models.ts:206 \\n \\n BYTES_PROCESSED - \\n \\n BYTES_PROCESSED: bytes_processed \\n \\n Defined in \\n libs/sdk-core/src/lib/db/db.models.ts:197 - \\n \\n CHARS_PROCESSED \\n \\n CHARS_PROCESSED: chars_processed \\n \\n Defined - in \\n libs/sdk-core/src/lib/db/db.models.ts:198 \\n \\n MEDIA_FILES_PROCESSED - \\n \\n MEDIA_FILES_PROCESSED: media_files_processed \\n \\n Defined in \\n - libs/sdk-core/src/lib/db/db.models.ts:200 \\n \\n MEDIA_SECONDS_PROCESSED - \\n \\n MEDIA_SECONDS_PROCESSED: media_seconds_processed \\n \\n Defined in - \\n libs/sdk-core/src/lib/db/db.models.ts:199 \\n \\n NUCLIA_TOKENS \\n \\n - NUCLIA_TOKENS: nuclia_tokens_billed \\n \\n Defined in \\n libs/sdk-core/src/lib/db/db.models.ts:207 - \\n \\n PAGES_PROCESSED \\n \\n PAGES_PROCESSED: pages_processed \\n \\n Defined - in \\n libs/sdk-core/src/lib/db/db.models.ts:201 \\n \\n PARAGRAPHS_PROCESSED - \\n \\n PARAGRAPHS_PROCESSED: paragraphs_processed \\n \\n Defined in \\n - libs/sdk-core/src/lib/db/db.models.ts:202 \\n \\n PRE_PROCESSING_TIME \\n - \\n PRE_PROCESSING_TIME: pre_processing_time \\n \\n Defined in \\n libs/sdk-core/src/lib/db/db.models.ts:194 - \\n \\n RESOURCES_PROCESSED \\n \\n RESOURCES_PROCESSED: resources_processed - \\n \\n Defined in \\n libs/sdk-core/src/lib/db/db.models.ts:196 \\n \\n SEARCHES_PERFORMED - \\n \\n SEARCHES_PERFORMED: searches_performed \\n \\n Defined in \\n libs/sdk-core/src/lib/db/db.models.ts:204 - \\n \\n SLOW_PROCESSING_TIME \\n \\n SLOW_PROCESSING_TIME: slow_processing_time - \\n \\n Defined in \\n libs/sdk-core/src/lib/db/db.models.ts:195 \\n \\n SUGGESTIONS_PERFORMED - \\n \\n SUGGESTIONS_PERFORMED: suggestions_performed \\n \\n Defined in \\n - libs/sdk-core/src/lib/db/db.models.ts:205 \\n \\n TRAIN_SECONDS \\n \\n TRAIN_SECONDS: - train_seconds \\n \\n Defined in \\n libs/sdk-core/src/lib/db/db.models.ts:203\",\"id\":\"66b6f0dbd883413e98fbbf5b59f049b9/t/page/0-1833\",\"labels\":[\"/k/text\"],\"position\":{\"page_number\":0,\"index\":0,\"start\":0,\"end\":1833,\"start_seconds\":[],\"end_seconds\":[]},\"fuzzy_result\":false,\"page_with_visual\":false,\"is_a_table\":false}}}}},\"f66261eb1a5e492c9929bd2e761e0802\":{\"id\":\"f66261eb1a5e492c9929bd2e761e0802\",\"slug\":\"docs-develop-js-sdk-modules-md\",\"title\":\"docs - > develop > js sdk > modules\",\"summary\":\"\",\"icon\":\"text/markdown\",\"thumbnail\":\"\",\"metadata\":{\"metadata\":{},\"language\":\"en\",\"languages\":[\"en\"],\"status\":\"PROCESSED\"},\"usermetadata\":{\"classifications\":[],\"relations\":[]},\"fieldmetadata\":[],\"computedmetadata\":{\"field_classifications\":[]},\"created\":\"2025-04-15T14:48:41.071283\",\"modified\":\"2025-04-15T14:48:41.071291\",\"last_seqid\":0,\"queue\":\"private\",\"hidden\":false,\"fields\":{\"/t/page\":{\"paragraphs\":{\"f66261eb1a5e492c9929bd2e761e0802/t/page/12352-18509\":{\"score\":0.09268777817487717,\"score_type\":\"RERANKER\",\"order\":5,\"text\":\" + TRAIN_SECONDS = train_seconds \\n Defined in \\n libs/sdk-core/src/lib/db/db.models.ts:187\",\"id\":\"b14cf452a3434839a04c111f2ea4dc51/t/page/0-2139\",\"labels\":[\"/k/text\"],\"position\":{\"page_number\":0,\"index\":0,\"start\":0,\"end\":2139,\"start_seconds\":[],\"end_seconds\":[]},\"fuzzy_result\":false,\"page_with_visual\":false,\"is_a_table\":false}}}}},\"4039d76b0fff4962900836ab3fdec9f7\":{\"id\":\"4039d76b0fff4962900836ab3fdec9f7\",\"slug\":\"docs-rag-advanced-consumption-mdx\",\"title\":\"docs + > rag > advanced > consumption.\",\"summary\":\"\",\"icon\":\"text/markdown\",\"thumbnail\":\"\",\"metadata\":{\"metadata\":{},\"language\":\"en\",\"languages\":[\"en\"],\"status\":\"PROCESSED\"},\"usermetadata\":{\"classifications\":[],\"relations\":[]},\"fieldmetadata\":[],\"computedmetadata\":{\"field_classifications\":[]},\"created\":\"2025-10-03T08:32:26.341394\",\"modified\":\"2026-06-09T08:18:16.730959\",\"last_seqid\":0,\"queue\":\"private\",\"hidden\":false,\"fields\":{\"/t/page\":{\"paragraphs\":{\"4039d76b0fff4962900836ab3fdec9f7/t/page/3075-3340\":{\"score\":0.06075190007686615,\"score_type\":\"RERANKER\",\"order\":3,\"text\":\" + Use the max_tokens parameter on the /ask endpoint to set hard limits on: \\n + - Context size: Limits the amount of retrieved information sent to the LLM + \\n - Answer length: Limits the length of the generated response \\n Important + Considerations \\n Context Limitations: \\n\",\"id\":\"4039d76b0fff4962900836ab3fdec9f7/t/page/3075-3340\",\"labels\":[],\"position\":{\"page_number\":0,\"index\":0,\"start\":3075,\"end\":3340,\"start_seconds\":[],\"end_seconds\":[]},\"fuzzy_result\":false,\"page_with_visual\":false,\"is_a_table\":false}}}}},\"6c56729cf0a44da3a4435094b8333ad5\":{\"id\":\"6c56729cf0a44da3a4435094b8333ad5\",\"slug\":\"docs-develop-js-sdk-interfaces-SamlConfig-md\",\"title\":\"docs + > develop > js sdk > interfaces > SamlConfig\",\"summary\":\"\",\"icon\":\"text/markdown\",\"thumbnail\":\"\",\"metadata\":{\"metadata\":{},\"language\":\"en\",\"languages\":[\"en\",\"eo\"],\"status\":\"PROCESSED\"},\"usermetadata\":{\"classifications\":[],\"relations\":[]},\"fieldmetadata\":[],\"computedmetadata\":{\"field_classifications\":[]},\"created\":\"2025-08-26T10:00:01.641788\",\"modified\":\"2026-07-13T08:08:37.888085\",\"last_seqid\":0,\"queue\":\"private\",\"hidden\":false,\"fields\":{\"/t/page\":{\"paragraphs\":{\"6c56729cf0a44da3a4435094b8333ad5/t/page/0-603\":{\"score\":0.0032986511941999197,\"score_type\":\"RERANKER\",\"order\":15,\"text\":\"@nuclia/core + \u2022 Docs \\n \\n @nuclia/core / SamlConfig \\n Interface: SamlConfig \\n + Properties \\n authn_context? \\n \\n optional authn_context: exact \\\\| + minimum \\\\| better \\\\| maximum \\n \\n Defined in \\n libs/sdk-core/src/lib/db/db.models.ts:113 + \\n \\n domains \\n \\n domains: string[] \\n \\n Defined in \\n libs/sdk-core/src/lib/db/db.models.ts:109 + \\n \\n entity_id \\n \\n entity_id: string \\n \\n Defined in \\n libs/sdk-core/src/lib/db/db.models.ts:110 + \\n \\n sso_url \\n \\n sso_url: string \\n \\n Defined in \\n libs/sdk-core/src/lib/db/db.models.ts:111 + \\n \\n x509_cert \\n \\n x509_cert: string \\n \\n Defined in \\n libs/sdk-core/src/lib/db/db.models.ts:112\",\"id\":\"6c56729cf0a44da3a4435094b8333ad5/t/page/0-603\",\"labels\":[\"/k/text\"],\"position\":{\"page_number\":0,\"index\":0,\"start\":0,\"end\":603,\"start_seconds\":[],\"end_seconds\":[]},\"fuzzy_result\":false,\"page_with_visual\":false,\"is_a_table\":false}}}}},\"fdf3457fa750438d86d4dc95f5f2ac78\":{\"id\":\"fdf3457fa750438d86d4dc95f5f2ac78\",\"slug\":\"docs-develop-js-sdk-functions-TUSuploadFile-md\",\"title\":\"docs + > develop > js sdk > functions > TUSuploadFile\",\"summary\":\"\",\"icon\":\"text/markdown\",\"thumbnail\":\"\",\"metadata\":{\"metadata\":{},\"language\":\"en\",\"languages\":[\"en\"],\"status\":\"PROCESSED\"},\"usermetadata\":{\"classifications\":[],\"relations\":[]},\"fieldmetadata\":[],\"computedmetadata\":{\"field_classifications\":[]},\"created\":\"2025-08-26T09:58:57.704609\",\"modified\":\"2026-07-13T08:10:02.118989\",\"last_seqid\":0,\"queue\":\"private\",\"hidden\":false,\"fields\":{\"/t/page\":{\"paragraphs\":{\"fdf3457fa750438d86d4dc95f5f2ac78/t/page/0-432\":{\"score\":0.0011073389323428273,\"score_type\":\"RERANKER\",\"order\":18,\"text\":\"@nuclia/core + \u2022 Docs \\n \\n @nuclia/core / TUSuploadFile \\n Function: TUSuploadFile() + \\n \\n TUSuploadFile(nuclia, path, buffer, metadata?, creationPayload?, maxWaitOn429?): + Observable\\\\ \\n \\n Parameters \\n \u2022 nuclia: INuclia \\n \u2022 path: + string \\n \u2022 buffer: ArrayBuffer \\n \u2022 metadata?: FileMetadata \\n + \u2022 creationPayload?: ICreateResource \\n \u2022 maxWaitOn429?: number + = 30000 \\n Returns \\n Observable\\\\ \\n Defined in \\n libs/sdk-core/src/lib/db/upload.ts:163\",\"id\":\"fdf3457fa750438d86d4dc95f5f2ac78/t/page/0-432\",\"labels\":[\"/k/text\"],\"position\":{\"page_number\":0,\"index\":0,\"start\":0,\"end\":432,\"start_seconds\":[],\"end_seconds\":[]},\"fuzzy_result\":false,\"page_with_visual\":false,\"is_a_table\":false}}}}},\"9f7036a7a6694700b72d52eb58a8326c\":{\"id\":\"9f7036a7a6694700b72d52eb58a8326c\",\"slug\":\"docs-rag-advanced-widget-features-md\",\"title\":\"docs + > rag > advanced > widget > features\",\"summary\":\"\",\"icon\":\"text/markdown\",\"thumbnail\":\"\",\"metadata\":{\"metadata\":{},\"language\":\"en\",\"languages\":[\"en\"],\"status\":\"PROCESSED\"},\"usermetadata\":{\"classifications\":[],\"relations\":[]},\"fieldmetadata\":[],\"computedmetadata\":{\"field_classifications\":[]},\"created\":\"2024-07-18T14:32:26.204740\",\"modified\":\"2026-06-09T08:07:51.648767\",\"last_seqid\":0,\"queue\":\"private\",\"hidden\":false,\"fields\":{\"/t/page\":{\"paragraphs\":{\"9f7036a7a6694700b72d52eb58a8326c/t/page/5203-5412\":{\"score\":0.2820972800254822,\"score_type\":\"RERANKER\",\"order\":0,\"text\":\" + max_tokens: the maximum number of input tokens to put in the final context + (including the prompt, the retrieved results and the user question). \\n max_output_tokens: + the maximum number of tokens to generate. \\n\",\"id\":\"9f7036a7a6694700b72d52eb58a8326c/t/page/5203-5412\",\"labels\":[],\"position\":{\"page_number\":0,\"index\":0,\"start\":5203,\"end\":5412,\"start_seconds\":[],\"end_seconds\":[]},\"fuzzy_result\":false,\"page_with_visual\":false,\"is_a_table\":false}}}}},\"43004f553e534ffe9c9e735856bd9b23\":{\"id\":\"43004f553e534ffe9c9e735856bd9b23\",\"slug\":\"docs-develop-js-sdk-interfaces-ModelConfig-md\",\"title\":\"docs + > develop > js sdk > interfaces > ModelConfig\",\"summary\":\"\",\"icon\":\"text/markdown\",\"thumbnail\":\"\",\"metadata\":{\"metadata\":{},\"language\":\"en\",\"languages\":[\"en\"],\"status\":\"PROCESSED\"},\"usermetadata\":{\"classifications\":[],\"relations\":[]},\"fieldmetadata\":[],\"computedmetadata\":{\"field_classifications\":[]},\"created\":\"2026-01-08T16:32:44.621593\",\"modified\":\"2026-07-13T08:05:25.656406\",\"last_seqid\":0,\"queue\":\"private\",\"hidden\":false,\"fields\":{\"/t/page\":{\"paragraphs\":{\"43004f553e534ffe9c9e735856bd9b23/t/page/212-480\":{\"score\":0.004117917735129595,\"score_type\":\"RERANKER\",\"order\":14,\"text\":\" + \\n optional driver: string \\n \\n Defined in \\n libs/sdk-core/src/lib/db/kb/kb.models.ts:590 + \\n \\n input_tokens \\n \\n input_tokens: object \\n \\n max \\n \\n max: + number \\n \\n min? \\n \\n optional min: number \\n \\n Defined in \\n libs/sdk-core/src/lib/db/kb/kb.models.ts:587 + \\n \\n max_images? \\n\",\"id\":\"43004f553e534ffe9c9e735856bd9b23/t/page/212-480\",\"labels\":[],\"position\":{\"page_number\":0,\"index\":0,\"start\":212,\"end\":480,\"start_seconds\":[],\"end_seconds\":[]},\"fuzzy_result\":false,\"page_with_visual\":false,\"is_a_table\":false},\"43004f553e534ffe9c9e735856bd9b23/t/page/480-703\":{\"score\":0.001356401713564992,\"score_type\":\"RERANKER\",\"order\":17,\"text\":\" + \\n optional max_images: string \\n \\n Defined in \\n libs/sdk-core/src/lib/db/kb/kb.models.ts:591 + \\n \\n output_tokens \\n \\n output_tokens: object \\n \\n default_max? \\n + \\n optional default_max: number \\n \\n max \\n \\n max: number \\n \\n min? + \\n \\n\",\"id\":\"43004f553e534ffe9c9e735856bd9b23/t/page/480-703\",\"labels\":[],\"position\":{\"page_number\":0,\"index\":0,\"start\":480,\"end\":703,\"start_seconds\":[],\"end_seconds\":[]},\"fuzzy_result\":false,\"page_with_visual\":false,\"is_a_table\":false}}}}},\"6e8250e6b5264156988657a221fd5e94\":{\"id\":\"6e8250e6b5264156988657a221fd5e94\",\"slug\":\"docs-develop-js-sdk-namespaces-Ask-interfaces-ConsumptionAskResponseItem-md\",\"title\":\"docs + > develop > js sdk > namespaces > Ask > interfaces > ConsumptionAskResponseItem\",\"summary\":\"\",\"icon\":\"text/markdown\",\"thumbnail\":\"\",\"metadata\":{\"metadata\":{},\"language\":\"en\",\"languages\":[\"en\"],\"status\":\"PROCESSED\"},\"usermetadata\":{\"classifications\":[],\"relations\":[]},\"fieldmetadata\":[],\"computedmetadata\":{\"field_classifications\":[]},\"created\":\"2025-12-09T11:47:37.548412\",\"modified\":\"2026-07-13T08:09:20.576829\",\"last_seqid\":0,\"queue\":\"private\",\"hidden\":false,\"fields\":{\"/t/page\":{\"paragraphs\":{\"6e8250e6b5264156988657a221fd5e94/t/page/0-397\":{\"score\":0.0015548133524134755,\"score_type\":\"RERANKER\",\"order\":16,\"text\":\"@nuclia/core + \u2022 Docs \\n \\n @nuclia/core / Ask / ConsumptionAskResponseItem \\n Interface: + ConsumptionAskResponseItem \\n Properties \\n customer_key_tokens \\n \\n + customer_key_tokens: TokenConsumption \\n \\n Defined in \\n libs/sdk-core/src/lib/db/search/ask.models.ts:127 + \\n \\n normalized_tokens \\n \\n normalized_tokens: TokenConsumption \\n + \\n Defined in \\n libs/sdk-core/src/lib/db/search/ask.models.ts:126 \\n \\n + type \\n \\n\",\"id\":\"6e8250e6b5264156988657a221fd5e94/t/page/0-397\",\"labels\":[\"/k/text\"],\"position\":{\"page_number\":0,\"index\":0,\"start\":0,\"end\":397,\"start_seconds\":[],\"end_seconds\":[]},\"fuzzy_result\":false,\"page_with_visual\":false,\"is_a_table\":false}}}}},\"50aac6f34b6d47de8e3b01f8b2de6e9c\":{\"id\":\"50aac6f34b6d47de8e3b01f8b2de6e9c\",\"slug\":\"docs-develop-js-sdk-interfaces-PredictAnswerOptions-md\",\"title\":\"docs + > develop > js sdk > interfaces > PredictAnswerOptions\",\"summary\":\"\",\"icon\":\"text/markdown\",\"thumbnail\":\"\",\"metadata\":{\"metadata\":{},\"language\":\"en\",\"languages\":[\"en\"],\"status\":\"PROCESSED\"},\"usermetadata\":{\"classifications\":[],\"relations\":[]},\"fieldmetadata\":[],\"computedmetadata\":{\"field_classifications\":[]},\"created\":\"2025-08-26T10:03:11.443619\",\"modified\":\"2026-07-13T08:07:00.470062\",\"last_seqid\":0,\"queue\":\"private\",\"hidden\":false,\"fields\":{\"/t/page\":{\"paragraphs\":{\"50aac6f34b6d47de8e3b01f8b2de6e9c/t/page/977-1221\":{\"score\":0.013121271505951881,\"score_type\":\"RERANKER\",\"order\":6,\"text\":\" + \\n optional max_tokens: number \\n \\n Defined in \\n libs/sdk-core/src/lib/db/search/ask.models.ts:251 + \\n \\n prefer_markdown? \\n \\n optional prefer_markdown: boolean \\n \\n + Defined in \\n libs/sdk-core/src/lib/db/search/ask.models.ts:256 \\n \\n query_context? + \\n\",\"id\":\"50aac6f34b6d47de8e3b01f8b2de6e9c/t/page/977-1221\",\"labels\":[],\"position\":{\"page_number\":0,\"index\":0,\"start\":977,\"end\":1221,\"start_seconds\":[],\"end_seconds\":[]},\"fuzzy_result\":false,\"page_with_visual\":false,\"is_a_table\":false},\"50aac6f34b6d47de8e3b01f8b2de6e9c/t/page/739-977\":{\"score\":0.007460643537342548,\"score_type\":\"RERANKER\",\"order\":11,\"text\":\" + \\n optional generative_model: string \\n \\n Defined in \\n libs/sdk-core/src/lib/db/search/ask.models.ts:250 + \\n \\n json_schema? \\n \\n optional json_schema: object \\n \\n Defined + in \\n libs/sdk-core/src/lib/db/search/ask.models.ts:257 \\n \\n max_tokens? + \\n\",\"id\":\"50aac6f34b6d47de8e3b01f8b2de6e9c/t/page/739-977\",\"labels\":[],\"position\":{\"page_number\":0,\"index\":0,\"start\":739,\"end\":977,\"start_seconds\":[],\"end_seconds\":[]},\"fuzzy_result\":false,\"page_with_visual\":false,\"is_a_table\":false}}}}},\"079ee3dc13a34f45a722937440b08020\":{\"id\":\"079ee3dc13a34f45a722937440b08020\",\"slug\":\"docs-develop-js-sdk-globals-md\",\"title\":\"docs + > develop > js sdk > globals\",\"summary\":\"\",\"icon\":\"text/markdown\",\"thumbnail\":\"\",\"metadata\":{\"metadata\":{},\"language\":\"en\",\"languages\":[\"en\"],\"status\":\"PROCESSED\"},\"usermetadata\":{\"classifications\":[],\"relations\":[]},\"fieldmetadata\":[],\"computedmetadata\":{\"field_classifications\":[]},\"created\":\"2025-08-26T09:57:26.792711\",\"modified\":\"2026-06-26T09:05:45.732884\",\"last_seqid\":0,\"queue\":\"private\",\"hidden\":false,\"fields\":{\"/t/page\":{\"paragraphs\":{\"079ee3dc13a34f45a722937440b08020/t/page/0-6155\":{\"score\":0.01065251138061285,\"score_type\":\"RERANKER\",\"order\":8,\"text\":\"@nuclia/core + \u2022 Docs \\n \\n @nuclia/core \\n Namespaces \\n \\n Agentic \\n Ask \\n + Memory \\n Search \\n Widget \\n \\n Enumerations \\n \\n AccountBlockingState + \\n AnswerOperation \\n AssumeRole \\n BlockedFeature \\n CustomSplitStrategy + \\n DataResidencyStatus \\n EventType \\n ExtractedDataTypes \\n FIELD_TYPE + \\n FilterOperator \\n InteractionOperation \\n LabelSetKind \\n ModelStability + \\n ModelType \\n NumericReasoningEffort \\n RAG_METADATAS \\n RagImageStrategyName + \\n RagStrategyName \\n ReasoningEffort \\n Reranker \\n RESOURCE_STATUS \\n + ResourceFieldProperties \\n ResourceProperties \\n SEVERITY \\n SHORT_FIELD_TYPE + \\n SortField \\n TaskApplyTo \\n TrainingExecutionStatus \\n TrainingStatus + \\n TrainingType \\n UsageType \\n \\n Classes \\n \\n ActivityMonitor \\n + Authentication \\n ConversationFieldData \\n Db \\n FileFieldData \\n JwtHelper + \\n KnowledgeBox \\n LinkFieldData \\n Nuclia \\n ReadableResource \\n ReadableSession + \\n Resource \\n Rest \\n RetrievalAgent \\n Session \\n SyncManager \\n TaskManager + \\n TextFieldData \\n Training \\n WritableKnowledgeBox \\n \\n Interfaces + \\n \\n Account \\n AccountConfig \\n AccountCreation \\n AccountLimits \\n + AccountLimitsPatchPayload \\n AccountModification \\n AccountStatus \\n AccountUser + \\n AccountUsersPayload \\n ActivityLogAskFilters \\n ActivityLogChatFilters + \\n ActivityLogDownload \\n ActivityLogDownloadQuery \\n ActivityLogFilter + \\n ActivityLogFilters \\n ActivityLogPagination \\n ActivityLogQueryBase + \\n ActivityLogResponseAskItem \\n ActivityLogResponseChatItem \\n ActivityLogResponseItem + \\n ActivityLogResponseSearchItem \\n ActivityLogSearchFilters \\n ActivityLogStringFilter + \\n AliniaConfig \\n AliniaDriver \\n And \\n AppliedDataAugmentation \\n + ARAGAgent \\n AragAnswer \\n ARAGDriver \\n ARAGException \\n AragResponse + \\n ARAGSchemas \\n AskAgent \\n AskAgentCreation \\n AskConfig \\n AskOperation + \\n AssumeRoleInfo \\n AuditMetadataFilter \\n AugmentedField \\n AuthInfo + \\n AuthTokens \\n AWSS3AccessKeysCredentials \\n AzureCertificateCredentials + \\n BaseAgent \\n BaseAliniaAgentCreation \\n BaseConditionalAgentCreation + \\n BaseContextAgent \\n BaseEntitiesGroup \\n BaseGenerationAgent \\n BaseNotificationData + \\n BasePostprocessAgent \\n BasePreprocessAgent \\n BaseSearchOptions \\n + BasicAskAgent \\n BasicAskAgentCreation \\n BraveAgent \\n BraveAgentCreation + \\n BraveConfig \\n BraveDriver \\n BrowseCapabilities \\n BrowseOptions \\n + CatalogOptions \\n CatalogQuery \\n ChatOptions \\n CitationFootnotes \\n + Citations \\n Classification \\n CloudLink \\n CommonMetricDetails \\n ComputedMetadata + \\n Consumption \\n ContextAgent \\n ContextConditionalAgent \\n ContextConditionalAgentCreation + \\n ConversationalStrategy \\n ConversationField \\n ConversationFieldPages + \\n Counters \\n CustomModel \\n CustomModelItem \\n CypherAgent \\n CypherAgentCreation + \\n CypherConfig \\n CypherDriver \\n DataAugmentationParameters \\n DateCreatedFilter + \\n DateModifiedFilter \\n DownloadOptions \\n DownloadStatus \\n Entities + \\n EntitiesGroup \\n Entity \\n EntityDefinition \\n EntityExample \\n EntityFilter + \\n EntityPosition \\n EntityPositions \\n EventList \\n ExportOptions \\n + ExternalAgent \\n ExternalAgentCreation \\n ExternalConnection \\n ExtractConfig + \\n ExtractedData \\n ExtractedText \\n ExtractLLMConfig \\n ExtractVLLMConfig + \\n ExtraMetadata \\n Feedback \\n FieldClassification \\n FieldComputedMetadata + \\n FieldEntities \\n FieldEntity \\n FieldExtensionStrategy \\n FieldFilter + \\n FieldFullId \\n FieldId \\n FieldMetadata \\n FieldMimetypeFilter \\n + FileB64 \\n FileExtractedData \\n FileField \\n FileFieldExtractedData \\n + FileFilter \\n FileMetadata \\n FilePages \\n FileUploadStatus \\n FileWithMetadata + \\n FilterExpression \\n FindConfig \\n FullAccountUser \\n FullKbUser \\n + FullResourceStrategy \\n GenerateAgent \\n GenerateAgentCreation \\n GeneratedFilter + \\n GenerationAgent \\n GenerativeProvider \\n GenerativeProviders \\n GenericFieldData + \\n GoogleAgent \\n GoogleAgentCreation \\n GoogleConfig \\n GoogleDriver + \\n GraphExtractionExample \\n GraphOperation \\n GraphStrategy \\n GuardOperation + \\n HierarchyStrategy \\n HistoricalAgent \\n HistoricalAgentCreation \\n + IAuthentication \\n ICreateResource \\n IDb \\n IDriver \\n IError \\n IErrorResponse + \\n IEvents \\n IFieldData \\n IFieldDataBase \\n IKnowledgeBox \\n IKnowledgeBoxBase + \\n IKnowledgeBoxItem \\n IKnowledgeBoxStandalone \\n ImportOptions \\n InspectTaskResponse + \\n InteractionOptions \\n InteractionRequest \\n InternetConfig \\n INuclia + \\n InviteAccountUserPayload \\n InviteKbData \\n IPAddressInfo \\n IResource + \\n IRest \\n IRetrievalAgent \\n IStandaloneKb \\n ISyncManager \\n IWritableKnowledgeBox + \\n Job \\n JobLog \\n JobLogsPage \\n JobPagination \\n JobsPage \\n JwtUser + \\n KbIndex \\n KbInvite \\n KBKVSchemas \\n KbUser \\n KbUserPayload \\n + KeyValueField \\n KeyValueFieldData \\n KeywordFilter \\n KindFilter \\n KnowledgeBoxCreation + \\n KVRange \\n KVSchema \\n KVSchemaField \\n Label \\n LabelFilter \\n LabelOperation + \\n LabelSet \\n LabelSets \\n LanguageFilter \\n LearningConfiguration \\n + LearningConfigurationOption \\n LearningConfigurationProperty \\n LearningConfigurations + \\n LearningConfigurationSchema \\n LearningConfigurationUserKeys \\n LinkExtractedData + \\n LinkField \\n LinkFieldExtractedData \\n LLMConfig \\n LogFilters \\n + MagicAction \\n McpAgent \\n McpAgentCreation \\n McpHttpConfig \\n McpHttpDriver + \\n McpSseConfig \\n McpSseDriver \\n McpStdioConfig \\n McpStdioDriver \\n + Message \\n MessageAttachment \\n MessageContent \\n Metadata \\n MetadatasStrategy + \\n Metric \\n MinScore \\n ModelConfig \\n ModelConfiguration \\n ModelConfigurationItem + \\n ModelFeatures \\n ModelInfo \\n ModelMetadata \\n ModifiedTimeRange \\n + NeighbouringParagraphsStrategy \\n Ner \\n NestedPosition \\n Not \\n NotificationMessage + \\n NUAClient \\n NUAClientPayload \\n NucliaDBConfig \\n NucliaDBDriver \\n + NucliaOptions \\n NucliaTokensDetails \\n NucliaTokensMetric \\n OAuthCredentials + \\n OAuthRedirection \\n OAuthUrl \\n Operation \\n Or \\n Origin \\n OriginCollaboratorFilter + \\n OriginMetadataFilter \\n OriginPathFilter \\n OriginSourceFilter \\n OriginTagFilter + \\n PageImageStrategy \\n PagePositions \\n PageSelections \\n PageStructure + \\n PageToken \\n Paragraph \\n ParagraphClassification \\n ParagraphImageStrategy + \\n PendingInvitation \\n PerplexityAgent \\n PerplexityAgentCreation \\n + PerplexityDriver \\n PositionedNER \\n PostConditionalAgent \\n PostConditionalAgentCreation + \\n PostprocessAgent \\n PostprocessAliniaAgent \\n PostprocessAliniaCreation + \\n PreConditionalAgent \\n PreConditionalAgentCreation \\n PredictAnswerOptions + \\n PredictedToken \\n PreprocessAgent \\n PreprocessAliniaAgent \\n PreprocessAliniaCreation + \\n PrequeriesStrategy \\n Prequery \\n\",\"id\":\"079ee3dc13a34f45a722937440b08020/t/page/0-6155\",\"labels\":[\"/k/text\"],\"position\":{\"page_number\":0,\"index\":0,\"start\":0,\"end\":6155,\"start_seconds\":[],\"end_seconds\":[]},\"fuzzy_result\":false,\"page_with_visual\":false,\"is_a_table\":false}}}}},\"666b3a9d01f74323b6ca6c9939834bec\":{\"id\":\"666b3a9d01f74323b6ca6c9939834bec\",\"slug\":\"docs-develop-js-sdk-enums-StatsType-md\",\"title\":\"docs + > develop > js sdk > enums > StatsType\",\"summary\":\"\",\"icon\":\"text/markdown\",\"thumbnail\":\"\",\"metadata\":{\"metadata\":{},\"language\":\"en\",\"languages\":[\"sv\",\"en\"],\"status\":\"PROCESSED\"},\"usermetadata\":{\"classifications\":[],\"relations\":[]},\"fieldmetadata\":[],\"computedmetadata\":{\"field_classifications\":[]},\"created\":\"2025-04-15T14:51:41.005040\",\"modified\":\"2026-06-09T08:13:37.365717\",\"last_seqid\":0,\"queue\":\"private\",\"hidden\":false,\"fields\":{\"/t/page\":{\"paragraphs\":{\"666b3a9d01f74323b6ca6c9939834bec/t/page/0-1386\":{\"score\":0.008745182305574417,\"score_type\":\"RERANKER\",\"order\":10,\"text\":\"@nuclia/core + / Exports / StatsType \\n Enumeration: StatsType \\n Deprecated \\n Table + of contents \\n Enumeration Members \\n \\n AI_TOKENS_USED \\n BYTES \\n CHARS + \\n DOCS_NO_MEDIA \\n MEDIA_SECONDS \\n PAGES \\n PROCESSING_TIME \\n RESOURCES + \\n SEARCHES \\n SUGGESTIONS \\n TRAIN_SECONDS \\n \\n Enumeration Members + \\n AI_TOKENS_USED \\n \u2022 AI_TOKENS_USED = ai_tokens_used \\n Defined + in \\n libs/sdk-core/src/lib/db/db.models.ts:206 \\n \\n BYTES \\n \u2022 + BYTES = bytes \\n Defined in \\n libs/sdk-core/src/lib/db/db.models.ts:200 + \\n \\n CHARS \\n \u2022 CHARS = chars \\n Defined in \\n libs/sdk-core/src/lib/db/db.models.ts:198 + \\n \\n DOCS_NO_MEDIA \\n \u2022 DOCS_NO_MEDIA = docs_no_media \\n Defined + in \\n libs/sdk-core/src/lib/db/db.models.ts:205 \\n \\n MEDIA_SECONDS \\n + \u2022 MEDIA_SECONDS = media_seconds \\n Defined in \\n libs/sdk-core/src/lib/db/db.models.ts:199 + \\n \\n PAGES \\n \u2022 PAGES = pages \\n Defined in \\n libs/sdk-core/src/lib/db/db.models.ts:202 + \\n \\n PROCESSING_TIME \\n \u2022 PROCESSING_TIME = processing_time \\n Defined + in \\n libs/sdk-core/src/lib/db/db.models.ts:196 \\n \\n RESOURCES \\n \u2022 + RESOURCES = resources \\n Defined in \\n libs/sdk-core/src/lib/db/db.models.ts:201 + \\n \\n SEARCHES \\n \u2022 SEARCHES = searches \\n Defined in \\n libs/sdk-core/src/lib/db/db.models.ts:197 + \\n \\n SUGGESTIONS \\n \u2022 SUGGESTIONS = suggestions \\n Defined in \\n + libs/sdk-core/src/lib/db/db.models.ts:204 \\n \\n TRAIN_SECONDS \\n \u2022 + TRAIN_SECONDS = train_seconds \\n Defined in \\n libs/sdk-core/src/lib/db/db.models.ts:203\",\"id\":\"666b3a9d01f74323b6ca6c9939834bec/t/page/0-1386\",\"labels\":[\"/k/text\"],\"position\":{\"page_number\":0,\"index\":0,\"start\":0,\"end\":1386,\"start_seconds\":[],\"end_seconds\":[]},\"fuzzy_result\":false,\"page_with_visual\":false,\"is_a_table\":false}}}}},\"aa2a2d122a4d404986a77b79aa10e8cf\":{\"id\":\"aa2a2d122a4d404986a77b79aa10e8cf\",\"slug\":\"docs-develop-js-sdk-classes-Db-md\",\"title\":\"docs + > develop > js sdk > classes > Db\",\"summary\":\"\",\"icon\":\"text/markdown\",\"thumbnail\":\"\",\"metadata\":{\"metadata\":{},\"language\":\"en\",\"languages\":[\"en\"],\"status\":\"PROCESSED\"},\"usermetadata\":{\"classifications\":[],\"relations\":[]},\"fieldmetadata\":[],\"computedmetadata\":{\"field_classifications\":[]},\"created\":\"2025-04-15T14:51:28.062220\",\"modified\":\"2026-07-13T08:10:31.209045\",\"last_seqid\":0,\"queue\":\"private\",\"hidden\":false,\"fields\":{\"/t/page\":{\"paragraphs\":{\"aa2a2d122a4d404986a77b79aa10e8cf/t/page/9545-13087\":{\"score\":0.006903837900608778,\"score_type\":\"RERANKER\",\"order\":12,\"text\":\" + When used on Cloud account, this method is requiring account id and zone parameters. + \\n When used on standalone, this method doesn't take any parameter \\n Returns + \\n Observable\\\\ \\n Implementation of \\n IDb.getLearningSchema \\n Defined + in \\n libs/sdk-core/src/lib/db/db.ts:659 \\n getLearningSchema(accountId, + zone) \\n \\n getLearningSchema(accountId, zone): Observable\\\\ \\n \\n Parameters + \\n \u2022 accountId: string \\n \u2022 zone: string \\n Returns \\n Observable\\\\ + \\n Implementation of \\n IDb.getLearningSchema \\n Defined in \\n libs/sdk-core/src/lib/db/db.ts:660 + \\n \\n getModel() \\n \\n getModel(modelId, accountId, zone): Observable\\\\ + \\n \\n Get a custom models \\n Parameters \\n \u2022 modelId: string \\n + \u2022 accountId: string \\n \u2022 zone: string \\n Returns \\n Observable\\\\ + \\n Implementation of \\n IDb.getModel \\n Defined in \\n libs/sdk-core/src/lib/db/db.ts:845 + \\n \\n getModelConfiguration() \\n \\n getModelConfiguration(modelId, accountId, + zone): Observable\\\\ \\n \\n Get a model configuration \\n Parameters \\n + \u2022 modelId: string \\n \u2022 accountId: string \\n \u2022 zone: string + \\n Returns \\n Observable\\\\ \\n Implementation of \\n IDb.getModelConfiguration + \\n Defined in \\n libs/sdk-core/src/lib/db/db.ts:885 \\n \\n getModelConfigurations() + \\n \\n getModelConfigurations(accountId, zone): Observable\\\\ \\n \\n Get + the list of model configurations of an account \\n Parameters \\n \u2022 accountId: + string \\n \u2022 zone: string \\n Returns \\n Observable\\\\ \\n Implementation + of \\n IDb.getModelConfigurations \\n Defined in \\n libs/sdk-core/src/lib/db/db.ts:873 + \\n \\n getModels() \\n \\n getModels(accountId, zone): Observable\\\\ \\n + \\n Get the list of custom models of an account \\n Parameters \\n \u2022 + accountId: string \\n \u2022 zone: string \\n Returns \\n Observable\\\\ \\n + Implementation of \\n IDb.getModels \\n Defined in \\n libs/sdk-core/src/lib/db/db.ts:838 + \\n \\n getNUAActivity() \\n \\n getNUAActivity(accountId, client_id, zoneSlug, + pageIndex): Observable\\\\ \\n \\n Parameters \\n \u2022 accountId: string + \\n \u2022 client_id: string \\n \u2022 zoneSlug: string \\n \u2022 pageIndex: + number = 0 \\n Returns \\n Observable\\\\ \\n Implementation of \\n IDb.getNUAActivity + \\n Defined in \\n libs/sdk-core/src/lib/db/db.ts:529 \\n \\n getNUAClient() + \\n \\n getNUAClient(accountId, client_id, zone): Observable\\\\ \\n \\n Parameters + \\n \u2022 accountId: string \\n \u2022 client_id: string \\n \u2022 zone: + string \\n Returns \\n Observable\\\\ \\n Implementation of \\n IDb.getNUAClient + \\n Defined in \\n libs/sdk-core/src/lib/db/db.ts:560 \\n \\n getNUAClients() + \\n \\n getNUAClients(accountId): Observable\\\\ \\n \\n Parameters \\n \u2022 + accountId: string \\n Returns \\n Observable\\\\ \\n Implementation of \\n + IDb.getNUAClients \\n Defined in \\n libs/sdk-core/src/lib/db/db.ts:538 \\n + \\n getNUAHeader() \\n \\n getNUAHeader(): object \\n \\n Returns \\n object + \\n x-nuclia-nuakey \\n \\n x-nuclia-nuakey: string \\n \\n Defined in \\n + libs/sdk-core/src/lib/db/db.ts:572 \\n \\n getNUAKey() \\n \\n getNUAKey(): + string \\n \\n Returns \\n string \\n Defined in \\n libs/sdk-core/src/lib/db/db.ts:568 + \\n \\n getRetrievalAgent() \\n getRetrievalAgent() \\n \\n getRetrievalAgent(): + Observable\\\\ \\n \\n Returns \\n Observable\\\\ \\n Implementation of \\n + IDb.getRetrievalAgent \\n Defined in \\n libs/sdk-core/src/lib/db/db.ts:345 + \\n getRetrievalAgent(accountId, retrievalAgentId, zone) \\n \\n getRetrievalAgent(accountId, + retrievalAgentId, zone?): Observable\\\\ \\n \\n Parameters \\n \u2022 accountId: + string \\n \u2022 retrievalAgentId: string \\n \u2022 zone?: string \\n Returns + \\n Observable\\\\ \\n Implementation of \\n IDb.getRetrievalAgent \\n Defined + in \\n libs/sdk-core/src/lib/db/db.ts:346 \\n \\n getRetrievalAgents() \\n + getRetrievalAgents() \\n \\n getRetrievalAgents(): Observable\\\\ \\n \\n + Returns a list of all the Retrieval Agents for the given account. Account + slug and id can be provided in the Nuclia options or as parameters. \\n\",\"id\":\"aa2a2d122a4d404986a77b79aa10e8cf/t/page/9545-13087\",\"labels\":[\"/k/text\"],\"position\":{\"page_number\":0,\"index\":0,\"start\":9545,\"end\":13087,\"start_seconds\":[],\"end_seconds\":[]},\"fuzzy_result\":false,\"page_with_visual\":false,\"is_a_table\":false}}}}},\"1cf976a5ca5947cd89a2f2a047b71ce9\":{\"id\":\"1cf976a5ca5947cd89a2f2a047b71ce9\",\"slug\":\"docs-ingestion-how-to-split-strategies-md\",\"title\":\"docs + > ingestion > how to > split strategies\",\"summary\":\"\",\"icon\":\"text/markdown\",\"thumbnail\":\"\",\"metadata\":{\"metadata\":{},\"language\":\"en\",\"languages\":[\"en\"],\"status\":\"PROCESSED\"},\"usermetadata\":{\"classifications\":[],\"relations\":[]},\"fieldmetadata\":[],\"computedmetadata\":{\"field_classifications\":[]},\"created\":\"2025-09-12T08:39:42.634556\",\"modified\":\"2026-06-09T08:18:07.009807\",\"last_seqid\":0,\"queue\":\"private\",\"hidden\":false,\"fields\":{\"/t/page\":{\"paragraphs\":{\"1cf976a5ca5947cd89a2f2a047b71ce9/t/page/963-1239\":{\"score\":0.0009927261853590608,\"score_type\":\"RERANKER\",\"order\":19,\"text\":\" + Key components of a split strategy include: \\n \\n Max paragraph size: Sets + the maximum size (in characters or tokens) for each chunk. \\n Custom split: + Determines the method used for splitting: \\n Manual splitting: Splits content + based on a specified delimiter (default is \\\\n ). \\n\",\"id\":\"1cf976a5ca5947cd89a2f2a047b71ce9/t/page/963-1239\",\"labels\":[],\"position\":{\"page_number\":0,\"index\":0,\"start\":963,\"end\":1239,\"start_seconds\":[],\"end_seconds\":[]},\"fuzzy_result\":false,\"page_with_visual\":false,\"is_a_table\":false}}}}},\"f66261eb1a5e492c9929bd2e761e0802\":{\"id\":\"f66261eb1a5e492c9929bd2e761e0802\",\"slug\":\"docs-develop-js-sdk-modules-md\",\"title\":\"docs + > develop > js sdk > modules\",\"summary\":\"\",\"icon\":\"text/markdown\",\"thumbnail\":\"\",\"metadata\":{\"metadata\":{},\"language\":\"en\",\"languages\":[\"en\"],\"status\":\"PROCESSED\"},\"usermetadata\":{\"classifications\":[],\"relations\":[]},\"fieldmetadata\":[],\"computedmetadata\":{\"field_classifications\":[]},\"created\":\"2025-04-15T14:48:41.071283\",\"modified\":\"2026-06-09T08:08:09.396202\",\"last_seqid\":0,\"queue\":\"private\",\"hidden\":false,\"fields\":{\"/t/page\":{\"paragraphs\":{\"f66261eb1a5e492c9929bd2e761e0802/t/page/12352-18509\":{\"score\":0.04336579889059067,\"score_type\":\"RERANKER\",\"order\":5,\"text\":\" \\n LABEL_FILTER_PREFIX \\n \u2022 Const LABEL_FILTER_PREFIX: classification.labels \\n Defined in \\n libs/sdk-core/src/lib/db/search/filter.ts:3 \\n \\n NER_FILTER_PREFIX \\n \u2022 Const NER_FILTER_PREFIX: entities \\n Defined in \\n libs/sdk-core/src/lib/db/search/filter.ts:4 @@ -991,100 +1095,34 @@ interactions: | \\n Returns \\n string \\n Defined in \\n libs/sdk-core/src/lib/db/search/filter.ts:6 \\n \\n getFilterFromLabelSet \\n \u25B8 getFilterFromLabelSet(labelSet): string \\n Parameters \\n | Name | Type | \\n | :------ | :------ | \\n | - labelSet | string | \\n Returns \\n string \\n Defined in \\n\",\"id\":\"f66261eb1a5e492c9929bd2e761e0802/t/page/12352-18509\",\"labels\":[\"/k/text\"],\"position\":{\"page_number\":0,\"index\":0,\"start\":12352,\"end\":18509,\"start_seconds\":[],\"end_seconds\":[]},\"fuzzy_result\":false,\"page_with_visual\":false,\"is_a_table\":false},\"f66261eb1a5e492c9929bd2e761e0802/t/page/0-6150\":{\"score\":0.06255973130464554,\"score_type\":\"RERANKER\",\"order\":6,\"text\":\"@nuclia/core - / Exports \\n @nuclia/core \\n Table of contents \\n Namespaces \\n \\n Agentic - \\n Ask \\n Search \\n \\n Enumerations \\n \\n AccountBlockingState \\n BlockedFeature - \\n EventType \\n ExtractedDataTypes \\n FIELD_TYPE \\n FilterOperator \\n - LabelSetKind \\n RAG_METADATAS \\n RESOURCE_STATUS \\n RagImageStrategyName - \\n RagStrategyName \\n Reranker \\n ResourceFieldProperties \\n ResourceProperties - \\n SHORT_FIELD_TYPE \\n SortField \\n TaskApplyTo \\n TrainingExecutionStatus - \\n TrainingStatus \\n TrainingType \\n UsageType \\n \\n Classes \\n \\n - ActivityMonitor \\n Authentication \\n ConversationFieldData \\n Db \\n FileFieldData - \\n JwtHelper \\n KnowledgeBox \\n LinkFieldData \\n Nuclia \\n ReadableResource - \\n Resource \\n Rest \\n TaskManager \\n TextFieldData \\n Training \\n WritableKnowledgeBox - \\n \\n Interfaces \\n \\n Account \\n AccountConfig \\n AccountCreation \\n - AccountLimits \\n AccountLimitsPatchPayload \\n AccountModification \\n AccountStatus - \\n AccountUser \\n AccountUsersPayload \\n ActivityLogChatFilters \\n ActivityLogDownload - \\n ActivityLogDownloadQuery \\n ActivityLogFilter \\n ActivityLogFilters - \\n ActivityLogSearchFilters \\n ActivityLogStringFilter \\n AskOperation - \\n AuditMetadataFilter \\n AuthTokens \\n BaseEntitiesGroup \\n BaseNotificationData - \\n BaseSearchOptions \\n CatalogOptions \\n ChatOptions \\n Citations \\n - Classification \\n CloudLink \\n CommonMetricDetails \\n ComputedMetadata - \\n ConversationField \\n ConversationFieldPages \\n ConversationalStrategy - \\n Counters \\n Entities \\n EntitiesGroup \\n Entity \\n EntityDefinition - \\n EntityExample \\n EntityPosition \\n EntityPositions \\n EventList \\n - ExternalIndexProvider \\n ExtraMetadata \\n ExtractedData \\n ExtractedText - \\n FieldClassification \\n FieldComputedMetadata \\n FieldEntities \\n FieldEntity - \\n FieldExtensionStrategy \\n FieldFullId \\n FieldId \\n FieldMetadata \\n - FileB64 \\n FileExtractedData \\n FileField \\n FileFieldExtractedData \\n - FileMetadata \\n FilePages \\n FileUploadStatus \\n FileWithMetadata \\n FullAccountUser - \\n FullKbUser \\n FullResourceStrategy \\n GraphOperation \\n HierarchyStrategy - \\n IAuthentication \\n ICreateResource \\n IDb \\n IError \\n IErrorResponse - \\n IEvents \\n IFieldData \\n IKnowledgeBox \\n IKnowledgeBoxCreation \\n - IKnowledgeBoxItem \\n IKnowledgeBoxStandalone \\n INuclia \\n IResource \\n - IRest \\n IStandaloneKb \\n IWritableKnowledgeBox \\n InspectTaskResponse - \\n InviteAccountUserPayload \\n InviteKbData \\n JwtUser \\n KbIndex \\n - KbInvite \\n KbUser \\n KbUserPayload \\n KnowledgeBoxCreation \\n LLMConfig - \\n Label \\n LabelOperation \\n LabelSet \\n LabelSets \\n LearningConfiguration - \\n LearningConfigurationOption \\n LearningConfigurationProperty \\n LearningConfigurationSchema - \\n LearningConfigurationUserKeys \\n LearningConfigurations \\n LinkExtractedData - \\n LinkField \\n LinkFieldExtractedData \\n Message \\n MessageAttachment - \\n MessageContent \\n Metadata \\n MetadatasStrategy \\n Metric \\n NUAClient - \\n NUAClientPayload \\n NeighbouringParagraphsStrategy \\n Ner \\n NestedPosition - \\n NotificationMessage \\n NucliaOptions \\n NucliaTokensDetails \\n NucliaTokensMetric - \\n Operation \\n Origin \\n PageImageStrategy \\n PagePositions \\n PageSelections - \\n PageStructure \\n PageToken \\n Paragraph \\n ParagraphClassification - \\n ParagraphImageStrategy \\n PendingInvitation \\n PositionedNER \\n PredictedToken - \\n PrequeriesStrategy \\n Prequery \\n ProcessingPullResponse \\n ProcessingPushResponse - \\n ProcessingStatus \\n Prompts \\n QAOperation \\n QueryInfo \\n Question - \\n QuestionAnswer \\n QuestionAnswers \\n Relation \\n RelationEntity \\n - RelationExample \\n RemiQueryCriteria \\n RemiQueryResponse \\n RemiQueryResponseContextDetails - \\n RemiQueryResponseItem \\n RemiScore \\n RemiScoresResponseItem \\n ResourceBaseNotification - \\n ResourceField \\n ResourceList \\n ResourceOperationNotification \\n ResourcePagination - \\n ResourceProcessedData \\n ResourceWrittenData \\n Row \\n RowsPreview - \\n SearchOptions \\n Security \\n Sentence \\n SentenceSearch \\n SentenceToken - \\n ServiceAccount \\n ServiceAccountCreation \\n ServiceAccountKey \\n Sheet - \\n SortOption \\n StartStopTaskResponse \\n Synonyms \\n SynonymsPayload - \\n TaskDefinition \\n TaskFullDefinition \\n TaskListResponse \\n TaskOnBatch - \\n TaskOnGoing \\n TaskParameters \\n TaskStatus \\n TextField \\n TokenAnnotation - \\n TokenSearch \\n TrainingExecution \\n TrainingExecutionWithDuration \\n - TrainingExecutions \\n TrainingLastExecution \\n TrainingTask \\n UploadResponse - \\n UploadStatus \\n UsageMetric \\n UsagePoint \\n UserClassification \\n - UserFieldMetadata \\n UserMetadata \\n VisualSelection \\n Welcome \\n WelcomeUser - \\n WidgetFeatures \\n WriteFileField \\n \\n Type Aliases \\n \\n AccountRoles - \\n AccountTypes \\n Answer \\n ApplyOption \\n DownloadFormat \\n Event \\n - Filter \\n KBRoles \\n KBStates \\n Language \\n LearningConfigurationSet - \\n NotificationOperation \\n NotificationType \\n NucliaDBRole \\n NullableUploadLimits - \\n NullableUsageLimits \\n PINECONE_REGIONS \\n PromiseMapper \\n RAGImageStrategy - \\n RAGStrategy \\n RelationEntityType \\n RelationType \\n RemiAnswerStatus - \\n ResourceData \\n ResourceProcessingNotification \\n ResourceStatus \\n - SortOrder \\n TaskName \\n TextFieldFormat \\n TextFormat \\n TypeParagraph - \\n UploadLimits \\n UploadLimitsEntries \\n UsageAggregation \\n UsageLimits - \\n UsageLimitsEntries \\n UserType \\n WidgetFeedback \\n \\n Variables \\n - \\n ABORT_STREAMING_REASON \\n DEFAULT_NER_KEY \\n LABEL_FILTER_PREFIX \\n - NER_FILTER_PREFIX \\n NUA_KEY \\n SUMMARY_PROMPT \\n USER_PROMPTS \\n \\n - Functions \\n \\n TUSuploadFile \\n ask \\n batchUpload \\n catalog \\n deDuplicateList - \\n evaluateExpression \\n find \\n format \\n formatObject \\n getAllNotifications - \\n getDataKeyFromFieldType \\n getEntityFromFilter \\n getFieldTypeFromString - \\n getFileMetadata \\n getFilterFromEntity \\n getFilterFromLabel \\n getFilterFromLabelSet - \\n getLabelFromFilter \\n getLabelSetFromFilter \\n getObjectValue \\n getRAGImageStrategies - \\n getRAGStrategies \\n lengthUnicode \\n longToShortFieldType \\n normalizeSchemaProperty - \\n retry429Config \\n search \\n setLabels \\n shortToLongFieldType \\n sliceUnicode - \\n suggest \\n upload \\n uploadFile \\n uploadToProcess \\n \\n Type Aliases - \\n AccountRoles \\n \u01AC AccountRoles: AOWNER \\\\| AMEMBER \\n Defined - in \\n libs/sdk-core/src/lib/models.ts:256 \\n \\n AccountTypes \\n \u01AC - AccountTypes: stash-trial \\\\| v3starter \\\\| v3fly \\\\| v3growth \\\\| - v3enterprise \\\\| stash-basic \\\\| stash-team \\\\| stash-startup \\\\| - stash-starter \\\\| stash-growth \\\\| stash-enterprise \\\\| stash-developer - \\\\| stash-business \\n Defined in \\n libs/sdk-core/src/lib/db/db.models.ts:1 - \\n \\n Answer \\n \u01AC Answer: Question \\n Defined in \\n\",\"id\":\"f66261eb1a5e492c9929bd2e761e0802/t/page/0-6150\",\"labels\":[\"/k/text\"],\"position\":{\"page_number\":0,\"index\":0,\"start\":0,\"end\":6150,\"start_seconds\":[],\"end_seconds\":[]},\"fuzzy_result\":false,\"page_with_visual\":false,\"is_a_table\":false}}}}},\"43004f553e534ffe9c9e735856bd9b23\":{\"id\":\"43004f553e534ffe9c9e735856bd9b23\",\"slug\":\"docs-develop-js-sdk-interfaces-ModelConfig-md\",\"title\":\"docs - > develop > js sdk > interfaces > ModelConfig\",\"summary\":\"\",\"icon\":\"text/markdown\",\"thumbnail\":\"\",\"metadata\":{\"metadata\":{},\"language\":\"en\",\"languages\":[\"en\"],\"status\":\"PROCESSED\"},\"usermetadata\":{\"classifications\":[],\"relations\":[]},\"fieldmetadata\":[],\"computedmetadata\":{\"field_classifications\":[]},\"created\":\"2026-01-08T16:32:44.621593\",\"modified\":\"2026-06-02T15:43:13.632521\",\"last_seqid\":0,\"queue\":\"private\",\"hidden\":false,\"fields\":{\"/t/page\":{\"paragraphs\":{\"43004f553e534ffe9c9e735856bd9b23/t/page/212-480\":{\"score\":0.0026419467758387327,\"score_type\":\"RERANKER\",\"order\":17,\"text\":\" - \\n optional driver: string \\n \\n Defined in \\n libs/sdk-core/src/lib/db/kb/kb.models.ts:589 - \\n \\n input_tokens \\n \\n input_tokens: object \\n \\n max \\n \\n max: - number \\n \\n min? \\n \\n optional min: number \\n \\n Defined in \\n libs/sdk-core/src/lib/db/kb/kb.models.ts:586 - \\n \\n max_images? \\n\",\"id\":\"43004f553e534ffe9c9e735856bd9b23/t/page/212-480\",\"labels\":[],\"position\":{\"page_number\":0,\"index\":0,\"start\":212,\"end\":480,\"start_seconds\":[],\"end_seconds\":[]},\"fuzzy_result\":false,\"page_with_visual\":false,\"is_a_table\":false}}}}}},\"query\":\"What - is the purpose and usage of `max_tokens` in Nuclia, and what is a Cardamom - bun?\",\"total\":20,\"page_number\":0,\"page_size\":20,\"next_page\":false,\"autofilters\":[],\"min_score\":{\"bm25\":0.0},\"best_matches\":[\"9f7036a7a6694700b72d52eb58a8326c/t/page/5203-5412\",\"4039d76b0fff4962900836ab3fdec9f7/t/page/3075-3340\",\"b14cf452a3434839a04c111f2ea4dc51/t/page/0-2139\",\"66b6f0dbd883413e98fbbf5b59f049b9/t/page/0-1833\",\"220eb37c167f4eb9bb8e9454e7ba8cf5/t/page/1790-2276\",\"f66261eb1a5e492c9929bd2e761e0802/t/page/12352-18509\",\"f66261eb1a5e492c9929bd2e761e0802/t/page/0-6150\",\"220eb37c167f4eb9bb8e9454e7ba8cf5/t/page/2505-2709\",\"666b3a9d01f74323b6ca6c9939834bec/t/page/0-1386\",\"60f6caceef5045399ea22af5ce4f31a4/t/page/962-2943\",\"e8525e64c5b44982b958d32cf6090613/t/page/2450-2808\",\"50aac6f34b6d47de8e3b01f8b2de6e9c/t/page/977-1221\",\"72cfaa1fb6674964807e055bd9d21ce5/t/page/4164-4904\",\"e8525e64c5b44982b958d32cf6090613/t/page/2808-3011\",\"6c56729cf0a44da3a4435094b8333ad5/t/page/0-603\",\"50aac6f34b6d47de8e3b01f8b2de6e9c/t/page/739-977\",\"38ec4cc5c66e436a946ea7893b6662a3/t/page/2462-2855\",\"43004f553e534ffe9c9e735856bd9b23/t/page/212-480\",\"8b3e0ef630a346d1b591143309db87ec/t/page/281-511\",\"44d05174f1954331b62f5e4026f2b01a/t/page/6346-6668\"]},\"best_matches\":[{\"id\":\"9f7036a7a6694700b72d52eb58a8326c/t/page/5203-5412\"},{\"id\":\"4039d76b0fff4962900836ab3fdec9f7/t/page/3075-3340\"},{\"id\":\"b14cf452a3434839a04c111f2ea4dc51/t/page/0-2139\"},{\"id\":\"66b6f0dbd883413e98fbbf5b59f049b9/t/page/0-1833\"},{\"id\":\"220eb37c167f4eb9bb8e9454e7ba8cf5/t/page/1790-2276\"},{\"id\":\"f66261eb1a5e492c9929bd2e761e0802/t/page/12352-18509\"},{\"id\":\"f66261eb1a5e492c9929bd2e761e0802/t/page/0-6150\"},{\"id\":\"220eb37c167f4eb9bb8e9454e7ba8cf5/t/page/2505-2709\"},{\"id\":\"666b3a9d01f74323b6ca6c9939834bec/t/page/0-1386\"},{\"id\":\"60f6caceef5045399ea22af5ce4f31a4/t/page/962-2943\"},{\"id\":\"e8525e64c5b44982b958d32cf6090613/t/page/2450-2808\"},{\"id\":\"50aac6f34b6d47de8e3b01f8b2de6e9c/t/page/977-1221\"},{\"id\":\"72cfaa1fb6674964807e055bd9d21ce5/t/page/4164-4904\"},{\"id\":\"e8525e64c5b44982b958d32cf6090613/t/page/2808-3011\"},{\"id\":\"6c56729cf0a44da3a4435094b8333ad5/t/page/0-603\"},{\"id\":\"50aac6f34b6d47de8e3b01f8b2de6e9c/t/page/739-977\"},{\"id\":\"38ec4cc5c66e436a946ea7893b6662a3/t/page/2462-2855\"},{\"id\":\"43004f553e534ffe9c9e735856bd9b23/t/page/212-480\"},{\"id\":\"8b3e0ef630a346d1b591143309db87ec/t/page/281-511\"},{\"id\":\"44d05174f1954331b62f5e4026f2b01a/t/page/6346-6668\"}]}}\n{\"item\":{\"type\":\"status\",\"code\":\"0\",\"status\":\"success\"}}\n{\"item\":{\"type\":\"augmented_context\",\"augmented\":{\"paragraphs\":{},\"fields\":{}}}}\n{\"item\":{\"type\":\"citations\",\"citations\":{\"4039d76b0fff4962900836ab3fdec9f7/t/page/3075-3340\":[[0,450]],\"9f7036a7a6694700b72d52eb58a8326c/t/page/5203-5412\":[[0,450]],\"50aac6f34b6d47de8e3b01f8b2de6e9c/t/page/977-1221\":[[0,450]],\"f66261eb1a5e492c9929bd2e761e0802/t/page/0-6150\":[[0,450]],\"b14cf452a3434839a04c111f2ea4dc51/t/page/0-2139\":[[0,450]],\"66b6f0dbd883413e98fbbf5b59f049b9/t/page/0-1833\":[[0,450]],\"e8525e64c5b44982b958d32cf6090613/t/page/2808-3011\":[[0,450]],\"50aac6f34b6d47de8e3b01f8b2de6e9c/t/page/739-977\":[[0,450]],\"6c56729cf0a44da3a4435094b8333ad5/t/page/0-603\":[[0,450]]}}}\n{\"item\":{\"type\":\"metadata\",\"tokens\":{\"input\":188,\"output\":11,\"input_nuclia\":0.188,\"output_nuclia\":0.011},\"timings\":{\"generative_first_chunk\":0.8461297329995432,\"generative_total\":1.811805455996364}}}\n" + labelSet | string | \\n Returns \\n string \\n Defined in \\n\",\"id\":\"f66261eb1a5e492c9929bd2e761e0802/t/page/12352-18509\",\"labels\":[\"/k/text\"],\"position\":{\"page_number\":0,\"index\":0,\"start\":12352,\"end\":18509,\"start_seconds\":[],\"end_seconds\":[]},\"fuzzy_result\":false,\"page_with_visual\":false,\"is_a_table\":false}}}}},\"66b6f0dbd883413e98fbbf5b59f049b9\":{\"id\":\"66b6f0dbd883413e98fbbf5b59f049b9\",\"slug\":\"docs-develop-js-sdk-enumerations-UsageType-md\",\"title\":\"docs + > develop > js sdk > enumerations > UsageType\",\"summary\":\"\",\"icon\":\"text/markdown\",\"thumbnail\":\"\",\"metadata\":{\"metadata\":{},\"language\":\"en\",\"languages\":[\"en\",\"tl\"],\"status\":\"PROCESSED\"},\"usermetadata\":{\"classifications\":[],\"relations\":[]},\"fieldmetadata\":[],\"computedmetadata\":{\"field_classifications\":[]},\"created\":\"2025-08-26T09:59:02.349911\",\"modified\":\"2026-07-13T08:04:12.758718\",\"last_seqid\":0,\"queue\":\"private\",\"hidden\":false,\"fields\":{\"/t/page\":{\"paragraphs\":{\"66b6f0dbd883413e98fbbf5b59f049b9/t/page/0-1833\":{\"score\":0.0497734472155571,\"score_type\":\"RERANKER\",\"order\":4,\"text\":\"@nuclia/core + \u2022 Docs \\n \\n @nuclia/core / UsageType \\n Enumeration: UsageType \\n + Enumeration Members \\n AI_TOKENS_USED \\n \\n AI_TOKENS_USED: ai_tokens_used + \\n \\n Defined in \\n libs/sdk-core/src/lib/db/db.models.ts:206 \\n \\n BYTES_PROCESSED + \\n \\n BYTES_PROCESSED: bytes_processed \\n \\n Defined in \\n libs/sdk-core/src/lib/db/db.models.ts:197 + \\n \\n CHARS_PROCESSED \\n \\n CHARS_PROCESSED: chars_processed \\n \\n Defined + in \\n libs/sdk-core/src/lib/db/db.models.ts:198 \\n \\n MEDIA_FILES_PROCESSED + \\n \\n MEDIA_FILES_PROCESSED: media_files_processed \\n \\n Defined in \\n + libs/sdk-core/src/lib/db/db.models.ts:200 \\n \\n MEDIA_SECONDS_PROCESSED + \\n \\n MEDIA_SECONDS_PROCESSED: media_seconds_processed \\n \\n Defined in + \\n libs/sdk-core/src/lib/db/db.models.ts:199 \\n \\n NUCLIA_TOKENS \\n \\n + NUCLIA_TOKENS: nuclia_tokens_billed \\n \\n Defined in \\n libs/sdk-core/src/lib/db/db.models.ts:207 + \\n \\n PAGES_PROCESSED \\n \\n PAGES_PROCESSED: pages_processed \\n \\n Defined + in \\n libs/sdk-core/src/lib/db/db.models.ts:201 \\n \\n PARAGRAPHS_PROCESSED + \\n \\n PARAGRAPHS_PROCESSED: paragraphs_processed \\n \\n Defined in \\n + libs/sdk-core/src/lib/db/db.models.ts:202 \\n \\n PRE_PROCESSING_TIME \\n + \\n PRE_PROCESSING_TIME: pre_processing_time \\n \\n Defined in \\n libs/sdk-core/src/lib/db/db.models.ts:194 + \\n \\n RESOURCES_PROCESSED \\n \\n RESOURCES_PROCESSED: resources_processed + \\n \\n Defined in \\n libs/sdk-core/src/lib/db/db.models.ts:196 \\n \\n SEARCHES_PERFORMED + \\n \\n SEARCHES_PERFORMED: searches_performed \\n \\n Defined in \\n libs/sdk-core/src/lib/db/db.models.ts:204 + \\n \\n SLOW_PROCESSING_TIME \\n \\n SLOW_PROCESSING_TIME: slow_processing_time + \\n \\n Defined in \\n libs/sdk-core/src/lib/db/db.models.ts:195 \\n \\n SUGGESTIONS_PERFORMED + \\n \\n SUGGESTIONS_PERFORMED: suggestions_performed \\n \\n Defined in \\n + libs/sdk-core/src/lib/db/db.models.ts:205 \\n \\n TRAIN_SECONDS \\n \\n TRAIN_SECONDS: + train_seconds \\n \\n Defined in \\n libs/sdk-core/src/lib/db/db.models.ts:203\",\"id\":\"66b6f0dbd883413e98fbbf5b59f049b9/t/page/0-1833\",\"labels\":[\"/k/text\"],\"position\":{\"page_number\":0,\"index\":0,\"start\":0,\"end\":1833,\"start_seconds\":[],\"end_seconds\":[]},\"fuzzy_result\":false,\"page_with_visual\":false,\"is_a_table\":false}}}}}},\"query\":\"How + is `max_tokens` utilized within the Nuclia system, and what is a Cardamom + bun?\",\"total\":20,\"page_number\":0,\"page_size\":20,\"next_page\":false,\"autofilters\":[],\"min_score\":{\"bm25\":0.0},\"best_matches\":[\"9f7036a7a6694700b72d52eb58a8326c/t/page/5203-5412\",\"220eb37c167f4eb9bb8e9454e7ba8cf5/t/page/1790-2276\",\"b14cf452a3434839a04c111f2ea4dc51/t/page/0-2139\",\"4039d76b0fff4962900836ab3fdec9f7/t/page/3075-3340\",\"66b6f0dbd883413e98fbbf5b59f049b9/t/page/0-1833\",\"f66261eb1a5e492c9929bd2e761e0802/t/page/12352-18509\",\"50aac6f34b6d47de8e3b01f8b2de6e9c/t/page/977-1221\",\"e8525e64c5b44982b958d32cf6090613/t/page/2450-2808\",\"079ee3dc13a34f45a722937440b08020/t/page/0-6155\",\"220eb37c167f4eb9bb8e9454e7ba8cf5/t/page/2505-2709\",\"666b3a9d01f74323b6ca6c9939834bec/t/page/0-1386\",\"50aac6f34b6d47de8e3b01f8b2de6e9c/t/page/739-977\",\"aa2a2d122a4d404986a77b79aa10e8cf/t/page/9545-13087\",\"e8525e64c5b44982b958d32cf6090613/t/page/2808-3011\",\"43004f553e534ffe9c9e735856bd9b23/t/page/212-480\",\"6c56729cf0a44da3a4435094b8333ad5/t/page/0-603\",\"6e8250e6b5264156988657a221fd5e94/t/page/0-397\",\"43004f553e534ffe9c9e735856bd9b23/t/page/480-703\",\"fdf3457fa750438d86d4dc95f5f2ac78/t/page/0-432\",\"1cf976a5ca5947cd89a2f2a047b71ce9/t/page/963-1239\"]},\"best_matches\":[{\"id\":\"9f7036a7a6694700b72d52eb58a8326c/t/page/5203-5412\"},{\"id\":\"220eb37c167f4eb9bb8e9454e7ba8cf5/t/page/1790-2276\"},{\"id\":\"b14cf452a3434839a04c111f2ea4dc51/t/page/0-2139\"},{\"id\":\"4039d76b0fff4962900836ab3fdec9f7/t/page/3075-3340\"},{\"id\":\"66b6f0dbd883413e98fbbf5b59f049b9/t/page/0-1833\"},{\"id\":\"f66261eb1a5e492c9929bd2e761e0802/t/page/12352-18509\"},{\"id\":\"50aac6f34b6d47de8e3b01f8b2de6e9c/t/page/977-1221\"},{\"id\":\"e8525e64c5b44982b958d32cf6090613/t/page/2450-2808\"},{\"id\":\"079ee3dc13a34f45a722937440b08020/t/page/0-6155\"},{\"id\":\"220eb37c167f4eb9bb8e9454e7ba8cf5/t/page/2505-2709\"},{\"id\":\"666b3a9d01f74323b6ca6c9939834bec/t/page/0-1386\"},{\"id\":\"50aac6f34b6d47de8e3b01f8b2de6e9c/t/page/739-977\"},{\"id\":\"aa2a2d122a4d404986a77b79aa10e8cf/t/page/9545-13087\"},{\"id\":\"e8525e64c5b44982b958d32cf6090613/t/page/2808-3011\"},{\"id\":\"43004f553e534ffe9c9e735856bd9b23/t/page/212-480\"},{\"id\":\"6c56729cf0a44da3a4435094b8333ad5/t/page/0-603\"},{\"id\":\"6e8250e6b5264156988657a221fd5e94/t/page/0-397\"},{\"id\":\"43004f553e534ffe9c9e735856bd9b23/t/page/480-703\"},{\"id\":\"fdf3457fa750438d86d4dc95f5f2ac78/t/page/0-432\"},{\"id\":\"1cf976a5ca5947cd89a2f2a047b71ce9/t/page/963-1239\"}]}}\n{\"item\":{\"type\":\"status\",\"code\":\"0\",\"status\":\"success\"}}\n{\"item\":{\"type\":\"augmented_context\",\"augmented\":{\"paragraphs\":{},\"fields\":{}}}}\n{\"item\":{\"type\":\"citations\",\"citations\":{\"4039d76b0fff4962900836ab3fdec9f7/t/page/3075-3340\":[[0,403]],\"9f7036a7a6694700b72d52eb58a8326c/t/page/5203-5412\":[[0,403]],\"50aac6f34b6d47de8e3b01f8b2de6e9c/t/page/977-1221\":[[0,403]],\"66b6f0dbd883413e98fbbf5b59f049b9/t/page/0-1833\":[[0,403]],\"079ee3dc13a34f45a722937440b08020/t/page/0-6155\":[[0,403]],\"b14cf452a3434839a04c111f2ea4dc51/t/page/0-2139\":[[0,403]],\"e8525e64c5b44982b958d32cf6090613/t/page/2808-3011\":[[0,403]],\"50aac6f34b6d47de8e3b01f8b2de6e9c/t/page/739-977\":[[0,403]]}}}\n{\"item\":{\"type\":\"metadata\",\"tokens\":{\"input\":190,\"output\":10,\"input_nuclia\":0.19,\"output_nuclia\":0.01},\"timings\":{\"generative_first_chunk\":1.030884565989254,\"generative_total\":2.4495896179869305}}}\n" headers: Alt-Svc: - h3=":443"; ma=2592000,h3-29=":443"; ma=2592000 @@ -1095,15 +1133,15 @@ interactions: content-type: - application/x-ndjson date: - - Wed, 03 Jun 2026 07:59:57 GMT + - Mon, 13 Jul 2026 08:57:51 GMT nuclia-learning-id: - - f24074c924d14d1e8a4c3cf770fbe167 + - 1f8feec2b38b4560b6a0fdaaa472e393 via: - 1.1 google x-envoy-upstream-service-time: - - '1532' + - '1908' x-nuclia-trace-id: - - c8f3917afb32eb48686ce176f8b58a1b + - fc4522c6d01a4504553d942460236c62 status: code: 200 message: OK @@ -1141,8 +1179,8 @@ interactions: List the IDs of the blocks relevant to the answer, if any (e.g., [\"block-AB\", \"block-CD\"]).\n11. **IMPORTANT** If any extra instructions are provided, you MUST follow them carefully when generating the answer field. These instructions - may specify the format, style, tools to use, or other requirements for the answer.\n\n\nWhat - is the purpose and usage of `max_tokens` in Nuclia, and what is a Cardamom bun?\n\n\nHow + is `max_tokens` utilized within the Nuclia system, and what is a Cardamom bun?\n\n\n\nContext:\n\n**block-AA**\n\n## Chunk: docs > rag > advanced > consumption.\n``` Use the max_tokens parameter on the /ask endpoint to set hard limits on: \n - Context size: Limits the amount of retrieved information @@ -1156,115 +1194,7 @@ interactions: max_tokens: number \n \n Defined in \n libs/sdk-core/src/lib/db/search/ask.models.ts:251 \n \n prefer_markdown? \n \n optional prefer_markdown: boolean \n \n Defined in \n libs/sdk-core/src/lib/db/search/ask.models.ts:256 \n \n query_context? - \n ```\n\n\n---\"\n\n\n**block-AD**\n\n## Chunk: docs > develop > js sdk > modules\n``` - @nuclia/core / Exports \n @nuclia/core \n Table of contents \n Namespaces \n - \n Agentic \n Ask \n Search \n \n Enumerations \n \n AccountBlockingState \n - BlockedFeature \n EventType \n ExtractedDataTypes \n FIELD_TYPE \n FilterOperator - \n LabelSetKind \n RAG_METADATAS \n RESOURCE_STATUS \n RagImageStrategyName - \n RagStrategyName \n Reranker \n ResourceFieldProperties \n ResourceProperties - \n SHORT_FIELD_TYPE \n SortField \n TaskApplyTo \n TrainingExecutionStatus \n - TrainingStatus \n TrainingType \n UsageType \n \n Classes \n \n ActivityMonitor - \n Authentication \n ConversationFieldData \n Db \n FileFieldData \n JwtHelper - \n KnowledgeBox \n LinkFieldData \n Nuclia \n ReadableResource \n Resource \n - Rest \n TaskManager \n TextFieldData \n Training \n WritableKnowledgeBox \n - \n Interfaces \n \n Account \n AccountConfig \n AccountCreation \n AccountLimits - \n AccountLimitsPatchPayload \n AccountModification \n AccountStatus \n AccountUser - \n AccountUsersPayload \n ActivityLogChatFilters \n ActivityLogDownload \n ActivityLogDownloadQuery - \n ActivityLogFilter \n ActivityLogFilters \n ActivityLogSearchFilters \n ActivityLogStringFilter - \n AskOperation \n AuditMetadataFilter \n AuthTokens \n BaseEntitiesGroup \n - BaseNotificationData \n BaseSearchOptions \n CatalogOptions \n ChatOptions \n - Citations \n Classification \n CloudLink \n CommonMetricDetails \n ComputedMetadata - \n ConversationField \n ConversationFieldPages \n ConversationalStrategy \n - Counters \n Entities \n EntitiesGroup \n Entity \n EntityDefinition \n EntityExample - \n EntityPosition \n EntityPositions \n EventList \n ExternalIndexProvider \n - ExtraMetadata \n ExtractedData \n ExtractedText \n FieldClassification \n FieldComputedMetadata - \n FieldEntities \n FieldEntity \n FieldExtensionStrategy \n FieldFullId \n - FieldId \n FieldMetadata \n FileB64 \n FileExtractedData \n FileField \n FileFieldExtractedData - \n FileMetadata \n FilePages \n FileUploadStatus \n FileWithMetadata \n FullAccountUser - \n FullKbUser \n FullResourceStrategy \n GraphOperation \n HierarchyStrategy - \n IAuthentication \n ICreateResource \n IDb \n IError \n IErrorResponse \n - IEvents \n IFieldData \n IKnowledgeBox \n IKnowledgeBoxCreation \n IKnowledgeBoxItem - \n IKnowledgeBoxStandalone \n INuclia \n IResource \n IRest \n IStandaloneKb - \n IWritableKnowledgeBox \n InspectTaskResponse \n InviteAccountUserPayload - \n InviteKbData \n JwtUser \n KbIndex \n KbInvite \n KbUser \n KbUserPayload - \n KnowledgeBoxCreation \n LLMConfig \n Label \n LabelOperation \n LabelSet - \n LabelSets \n LearningConfiguration \n LearningConfigurationOption \n LearningConfigurationProperty - \n LearningConfigurationSchema \n LearningConfigurationUserKeys \n LearningConfigurations - \n LinkExtractedData \n LinkField \n LinkFieldExtractedData \n Message \n MessageAttachment - \n MessageContent \n Metadata \n MetadatasStrategy \n Metric \n NUAClient \n - NUAClientPayload \n NeighbouringParagraphsStrategy \n Ner \n NestedPosition - \n NotificationMessage \n NucliaOptions \n NucliaTokensDetails \n NucliaTokensMetric - \n Operation \n Origin \n PageImageStrategy \n PagePositions \n PageSelections - \n PageStructure \n PageToken \n Paragraph \n ParagraphClassification \n ParagraphImageStrategy - \n PendingInvitation \n PositionedNER \n PredictedToken \n PrequeriesStrategy - \n Prequery \n ProcessingPullResponse \n ProcessingPushResponse \n ProcessingStatus - \n Prompts \n QAOperation \n QueryInfo \n Question \n QuestionAnswer \n QuestionAnswers - \n Relation \n RelationEntity \n RelationExample \n RemiQueryCriteria \n RemiQueryResponse - \n RemiQueryResponseContextDetails \n RemiQueryResponseItem \n RemiScore \n - RemiScoresResponseItem \n ResourceBaseNotification \n ResourceField \n ResourceList - \n ResourceOperationNotification \n ResourcePagination \n ResourceProcessedData - \n ResourceWrittenData \n Row \n RowsPreview \n SearchOptions \n Security \n - Sentence \n SentenceSearch \n SentenceToken \n ServiceAccount \n ServiceAccountCreation - \n ServiceAccountKey \n Sheet \n SortOption \n StartStopTaskResponse \n Synonyms - \n SynonymsPayload \n TaskDefinition \n TaskFullDefinition \n TaskListResponse - \n TaskOnBatch \n TaskOnGoing \n TaskParameters \n TaskStatus \n TextField \n - TokenAnnotation \n TokenSearch \n TrainingExecution \n TrainingExecutionWithDuration - \n TrainingExecutions \n TrainingLastExecution \n TrainingTask \n UploadResponse - \n UploadStatus \n UsageMetric \n UsagePoint \n UserClassification \n UserFieldMetadata - \n UserMetadata \n VisualSelection \n Welcome \n WelcomeUser \n WidgetFeatures - \n WriteFileField \n \n Type Aliases \n \n AccountRoles \n AccountTypes \n Answer - \n ApplyOption \n DownloadFormat \n Event \n Filter \n KBRoles \n KBStates \n - Language \n LearningConfigurationSet \n NotificationOperation \n NotificationType - \n NucliaDBRole \n NullableUploadLimits \n NullableUsageLimits \n PINECONE_REGIONS - \n PromiseMapper \n RAGImageStrategy \n RAGStrategy \n RelationEntityType \n - RelationType \n RemiAnswerStatus \n ResourceData \n ResourceProcessingNotification - \n ResourceStatus \n SortOrder \n TaskName \n TextFieldFormat \n TextFormat - \n TypeParagraph \n UploadLimits \n UploadLimitsEntries \n UsageAggregation - \n UsageLimits \n UsageLimitsEntries \n UserType \n WidgetFeedback \n \n Variables - \n \n ABORT_STREAMING_REASON \n DEFAULT_NER_KEY \n LABEL_FILTER_PREFIX \n NER_FILTER_PREFIX - \n NUA_KEY \n SUMMARY_PROMPT \n USER_PROMPTS \n \n Functions \n \n TUSuploadFile - \n ask \n batchUpload \n catalog \n deDuplicateList \n evaluateExpression \n - find \n format \n formatObject \n getAllNotifications \n getDataKeyFromFieldType - \n getEntityFromFilter \n getFieldTypeFromString \n getFileMetadata \n getFilterFromEntity - \n getFilterFromLabel \n getFilterFromLabelSet \n getLabelFromFilter \n getLabelSetFromFilter - \n getObjectValue \n getRAGImageStrategies \n getRAGStrategies \n lengthUnicode - \n longToShortFieldType \n normalizeSchemaProperty \n retry429Config \n search - \n setLabels \n shortToLongFieldType \n sliceUnicode \n suggest \n upload \n - uploadFile \n uploadToProcess \n \n Type Aliases \n AccountRoles \n \u01ac AccountRoles: - AOWNER \\| AMEMBER \n Defined in \n libs/sdk-core/src/lib/models.ts:256 \n \n - AccountTypes \n \u01ac AccountTypes: stash-trial \\| v3starter \\| v3fly \\| - v3growth \\| v3enterprise \\| stash-basic \\| stash-team \\| stash-startup \\| - stash-starter \\| stash-growth \\| stash-enterprise \\| stash-developer \\| - stash-business \n Defined in \n libs/sdk-core/src/lib/db/db.models.ts:1 \n \n - Answer \n \u01ac Answer: Question \n Defined in \n ```\n\n\n---\"\n\n\n**block-AE**\n\n## - Chunk: docs > develop > js sdk > enums > UsageType\n``` @nuclia/core / Exports - / UsageType \n Enumeration: UsageType \n Table of contents \n Enumeration Members - \n \n AI_TOKENS_USED \n BYTES_PROCESSED \n CHARS_PROCESSED \n MEDIA_FILES_PROCESSED - \n MEDIA_SECONDS_PROCESSED \n NUCLIA_TOKENS \n PAGES_PROCESSED \n PARAGRAPHS_PROCESSED - \n PRE_PROCESSING_TIME \n RESOURCES_PROCESSED \n SEARCHES_PERFORMED \n SLOW_PROCESSING_TIME - \n SUGGESTIONS_PERFORMED \n TRAIN_SECONDS \n \n Enumeration Members \n AI_TOKENS_USED - \n \u2022 AI_TOKENS_USED = ai_tokens_used \n Defined in \n libs/sdk-core/src/lib/db/db.models.ts:190 - \n \n BYTES_PROCESSED \n \u2022 BYTES_PROCESSED = bytes_processed \n Defined - in \n libs/sdk-core/src/lib/db/db.models.ts:181 \n \n CHARS_PROCESSED \n \u2022 - CHARS_PROCESSED = chars_processed \n Defined in \n libs/sdk-core/src/lib/db/db.models.ts:182 - \n \n MEDIA_FILES_PROCESSED \n \u2022 MEDIA_FILES_PROCESSED = media_files_processed - \n Defined in \n libs/sdk-core/src/lib/db/db.models.ts:184 \n \n MEDIA_SECONDS_PROCESSED - \n \u2022 MEDIA_SECONDS_PROCESSED = media_seconds_processed \n Defined in \n - libs/sdk-core/src/lib/db/db.models.ts:183 \n \n NUCLIA_TOKENS \n \u2022 NUCLIA_TOKENS - = nuclia_tokens_billed \n Defined in \n libs/sdk-core/src/lib/db/db.models.ts:191 - \n \n PAGES_PROCESSED \n \u2022 PAGES_PROCESSED = pages_processed \n Defined - in \n libs/sdk-core/src/lib/db/db.models.ts:185 \n \n PARAGRAPHS_PROCESSED \n - \u2022 PARAGRAPHS_PROCESSED = paragraphs_processed \n Defined in \n libs/sdk-core/src/lib/db/db.models.ts:186 - \n \n PRE_PROCESSING_TIME \n \u2022 PRE_PROCESSING_TIME = pre_processing_time - \n Defined in \n libs/sdk-core/src/lib/db/db.models.ts:178 \n \n RESOURCES_PROCESSED - \n \u2022 RESOURCES_PROCESSED = resources_processed \n Defined in \n libs/sdk-core/src/lib/db/db.models.ts:180 - \n \n SEARCHES_PERFORMED \n \u2022 SEARCHES_PERFORMED = searches_performed \n - Defined in \n libs/sdk-core/src/lib/db/db.models.ts:188 \n \n SLOW_PROCESSING_TIME - \n \u2022 SLOW_PROCESSING_TIME = slow_processing_time \n Defined in \n libs/sdk-core/src/lib/db/db.models.ts:179 - \n \n SUGGESTIONS_PERFORMED \n \u2022 SUGGESTIONS_PERFORMED = suggestions_performed - \n Defined in \n libs/sdk-core/src/lib/db/db.models.ts:189 \n \n TRAIN_SECONDS - \n \u2022 TRAIN_SECONDS = train_seconds \n Defined in \n libs/sdk-core/src/lib/db/db.models.ts:187 - ```\n\n\n---\"\n\n\n**block-AF**\n\n## Chunk: docs > develop > js sdk > enumerations + \n ```\n\n\n---\"\n\n\n**block-AD**\n\n## Chunk: docs > develop > js sdk > enumerations > UsageType\n``` @nuclia/core \u2022 Docs \n \n @nuclia/core / UsageType \n Enumeration: UsageType \n Enumeration Members \n AI_TOKENS_USED \n \n AI_TOKENS_USED: ai_tokens_used \n \n Defined in \n libs/sdk-core/src/lib/db/db.models.ts:206 @@ -1287,6 +1217,113 @@ interactions: \n \n Defined in \n libs/sdk-core/src/lib/db/db.models.ts:195 \n \n SUGGESTIONS_PERFORMED \n \n SUGGESTIONS_PERFORMED: suggestions_performed \n \n Defined in \n libs/sdk-core/src/lib/db/db.models.ts:205 \n \n TRAIN_SECONDS \n \n TRAIN_SECONDS: train_seconds \n \n Defined in \n libs/sdk-core/src/lib/db/db.models.ts:203 + ```\n\n\n---\"\n\n\n**block-AE**\n\n## Chunk: docs > develop > js sdk > globals\n``` + @nuclia/core \u2022 Docs \n \n @nuclia/core \n Namespaces \n \n Agentic \n Ask + \n Memory \n Search \n Widget \n \n Enumerations \n \n AccountBlockingState + \n AnswerOperation \n AssumeRole \n BlockedFeature \n CustomSplitStrategy \n + DataResidencyStatus \n EventType \n ExtractedDataTypes \n FIELD_TYPE \n FilterOperator + \n InteractionOperation \n LabelSetKind \n ModelStability \n ModelType \n NumericReasoningEffort + \n RAG_METADATAS \n RagImageStrategyName \n RagStrategyName \n ReasoningEffort + \n Reranker \n RESOURCE_STATUS \n ResourceFieldProperties \n ResourceProperties + \n SEVERITY \n SHORT_FIELD_TYPE \n SortField \n TaskApplyTo \n TrainingExecutionStatus + \n TrainingStatus \n TrainingType \n UsageType \n \n Classes \n \n ActivityMonitor + \n Authentication \n ConversationFieldData \n Db \n FileFieldData \n JwtHelper + \n KnowledgeBox \n LinkFieldData \n Nuclia \n ReadableResource \n ReadableSession + \n Resource \n Rest \n RetrievalAgent \n Session \n SyncManager \n TaskManager + \n TextFieldData \n Training \n WritableKnowledgeBox \n \n Interfaces \n \n + Account \n AccountConfig \n AccountCreation \n AccountLimits \n AccountLimitsPatchPayload + \n AccountModification \n AccountStatus \n AccountUser \n AccountUsersPayload + \n ActivityLogAskFilters \n ActivityLogChatFilters \n ActivityLogDownload \n + ActivityLogDownloadQuery \n ActivityLogFilter \n ActivityLogFilters \n ActivityLogPagination + \n ActivityLogQueryBase \n ActivityLogResponseAskItem \n ActivityLogResponseChatItem + \n ActivityLogResponseItem \n ActivityLogResponseSearchItem \n ActivityLogSearchFilters + \n ActivityLogStringFilter \n AliniaConfig \n AliniaDriver \n And \n AppliedDataAugmentation + \n ARAGAgent \n AragAnswer \n ARAGDriver \n ARAGException \n AragResponse \n + ARAGSchemas \n AskAgent \n AskAgentCreation \n AskConfig \n AskOperation \n + AssumeRoleInfo \n AuditMetadataFilter \n AugmentedField \n AuthInfo \n AuthTokens + \n AWSS3AccessKeysCredentials \n AzureCertificateCredentials \n BaseAgent \n + BaseAliniaAgentCreation \n BaseConditionalAgentCreation \n BaseContextAgent + \n BaseEntitiesGroup \n BaseGenerationAgent \n BaseNotificationData \n BasePostprocessAgent + \n BasePreprocessAgent \n BaseSearchOptions \n BasicAskAgent \n BasicAskAgentCreation + \n BraveAgent \n BraveAgentCreation \n BraveConfig \n BraveDriver \n BrowseCapabilities + \n BrowseOptions \n CatalogOptions \n CatalogQuery \n ChatOptions \n CitationFootnotes + \n Citations \n Classification \n CloudLink \n CommonMetricDetails \n ComputedMetadata + \n Consumption \n ContextAgent \n ContextConditionalAgent \n ContextConditionalAgentCreation + \n ConversationalStrategy \n ConversationField \n ConversationFieldPages \n + Counters \n CustomModel \n CustomModelItem \n CypherAgent \n CypherAgentCreation + \n CypherConfig \n CypherDriver \n DataAugmentationParameters \n DateCreatedFilter + \n DateModifiedFilter \n DownloadOptions \n DownloadStatus \n Entities \n EntitiesGroup + \n Entity \n EntityDefinition \n EntityExample \n EntityFilter \n EntityPosition + \n EntityPositions \n EventList \n ExportOptions \n ExternalAgent \n ExternalAgentCreation + \n ExternalConnection \n ExtractConfig \n ExtractedData \n ExtractedText \n + ExtractLLMConfig \n ExtractVLLMConfig \n ExtraMetadata \n Feedback \n FieldClassification + \n FieldComputedMetadata \n FieldEntities \n FieldEntity \n FieldExtensionStrategy + \n FieldFilter \n FieldFullId \n FieldId \n FieldMetadata \n FieldMimetypeFilter + \n FileB64 \n FileExtractedData \n FileField \n FileFieldExtractedData \n FileFilter + \n FileMetadata \n FilePages \n FileUploadStatus \n FileWithMetadata \n FilterExpression + \n FindConfig \n FullAccountUser \n FullKbUser \n FullResourceStrategy \n GenerateAgent + \n GenerateAgentCreation \n GeneratedFilter \n GenerationAgent \n GenerativeProvider + \n GenerativeProviders \n GenericFieldData \n GoogleAgent \n GoogleAgentCreation + \n GoogleConfig \n GoogleDriver \n GraphExtractionExample \n GraphOperation + \n GraphStrategy \n GuardOperation \n HierarchyStrategy \n HistoricalAgent \n + HistoricalAgentCreation \n IAuthentication \n ICreateResource \n IDb \n IDriver + \n IError \n IErrorResponse \n IEvents \n IFieldData \n IFieldDataBase \n IKnowledgeBox + \n IKnowledgeBoxBase \n IKnowledgeBoxItem \n IKnowledgeBoxStandalone \n ImportOptions + \n InspectTaskResponse \n InteractionOptions \n InteractionRequest \n InternetConfig + \n INuclia \n InviteAccountUserPayload \n InviteKbData \n IPAddressInfo \n IResource + \n IRest \n IRetrievalAgent \n IStandaloneKb \n ISyncManager \n IWritableKnowledgeBox + \n Job \n JobLog \n JobLogsPage \n JobPagination \n JobsPage \n JwtUser \n KbIndex + \n KbInvite \n KBKVSchemas \n KbUser \n KbUserPayload \n KeyValueField \n KeyValueFieldData + \n KeywordFilter \n KindFilter \n KnowledgeBoxCreation \n KVRange \n KVSchema + \n KVSchemaField \n Label \n LabelFilter \n LabelOperation \n LabelSet \n LabelSets + \n LanguageFilter \n LearningConfiguration \n LearningConfigurationOption \n + LearningConfigurationProperty \n LearningConfigurations \n LearningConfigurationSchema + \n LearningConfigurationUserKeys \n LinkExtractedData \n LinkField \n LinkFieldExtractedData + \n LLMConfig \n LogFilters \n MagicAction \n McpAgent \n McpAgentCreation \n + McpHttpConfig \n McpHttpDriver \n McpSseConfig \n McpSseDriver \n McpStdioConfig + \n McpStdioDriver \n Message \n MessageAttachment \n MessageContent \n Metadata + \n MetadatasStrategy \n Metric \n MinScore \n ModelConfig \n ModelConfiguration + \n ModelConfigurationItem \n ModelFeatures \n ModelInfo \n ModelMetadata \n + ModifiedTimeRange \n NeighbouringParagraphsStrategy \n Ner \n NestedPosition + \n Not \n NotificationMessage \n NUAClient \n NUAClientPayload \n NucliaDBConfig + \n NucliaDBDriver \n NucliaOptions \n NucliaTokensDetails \n NucliaTokensMetric + \n OAuthCredentials \n OAuthRedirection \n OAuthUrl \n Operation \n Or \n Origin + \n OriginCollaboratorFilter \n OriginMetadataFilter \n OriginPathFilter \n OriginSourceFilter + \n OriginTagFilter \n PageImageStrategy \n PagePositions \n PageSelections \n + PageStructure \n PageToken \n Paragraph \n ParagraphClassification \n ParagraphImageStrategy + \n PendingInvitation \n PerplexityAgent \n PerplexityAgentCreation \n PerplexityDriver + \n PositionedNER \n PostConditionalAgent \n PostConditionalAgentCreation \n + PostprocessAgent \n PostprocessAliniaAgent \n PostprocessAliniaCreation \n PreConditionalAgent + \n PreConditionalAgentCreation \n PredictAnswerOptions \n PredictedToken \n + PreprocessAgent \n PreprocessAliniaAgent \n PreprocessAliniaCreation \n PrequeriesStrategy + \n Prequery \n ```\n\n\n---\"\n\n\n**block-AF**\n\n## Chunk: docs > develop + > js sdk > enums > UsageType\n``` @nuclia/core / Exports / UsageType \n Enumeration: + UsageType \n Table of contents \n Enumeration Members \n \n AI_TOKENS_USED \n + BYTES_PROCESSED \n CHARS_PROCESSED \n MEDIA_FILES_PROCESSED \n MEDIA_SECONDS_PROCESSED + \n NUCLIA_TOKENS \n PAGES_PROCESSED \n PARAGRAPHS_PROCESSED \n PRE_PROCESSING_TIME + \n RESOURCES_PROCESSED \n SEARCHES_PERFORMED \n SLOW_PROCESSING_TIME \n SUGGESTIONS_PERFORMED + \n TRAIN_SECONDS \n \n Enumeration Members \n AI_TOKENS_USED \n \u2022 AI_TOKENS_USED + = ai_tokens_used \n Defined in \n libs/sdk-core/src/lib/db/db.models.ts:190 + \n \n BYTES_PROCESSED \n \u2022 BYTES_PROCESSED = bytes_processed \n Defined + in \n libs/sdk-core/src/lib/db/db.models.ts:181 \n \n CHARS_PROCESSED \n \u2022 + CHARS_PROCESSED = chars_processed \n Defined in \n libs/sdk-core/src/lib/db/db.models.ts:182 + \n \n MEDIA_FILES_PROCESSED \n \u2022 MEDIA_FILES_PROCESSED = media_files_processed + \n Defined in \n libs/sdk-core/src/lib/db/db.models.ts:184 \n \n MEDIA_SECONDS_PROCESSED + \n \u2022 MEDIA_SECONDS_PROCESSED = media_seconds_processed \n Defined in \n + libs/sdk-core/src/lib/db/db.models.ts:183 \n \n NUCLIA_TOKENS \n \u2022 NUCLIA_TOKENS + = nuclia_tokens_billed \n Defined in \n libs/sdk-core/src/lib/db/db.models.ts:191 + \n \n PAGES_PROCESSED \n \u2022 PAGES_PROCESSED = pages_processed \n Defined + in \n libs/sdk-core/src/lib/db/db.models.ts:185 \n \n PARAGRAPHS_PROCESSED \n + \u2022 PARAGRAPHS_PROCESSED = paragraphs_processed \n Defined in \n libs/sdk-core/src/lib/db/db.models.ts:186 + \n \n PRE_PROCESSING_TIME \n \u2022 PRE_PROCESSING_TIME = pre_processing_time + \n Defined in \n libs/sdk-core/src/lib/db/db.models.ts:178 \n \n RESOURCES_PROCESSED + \n \u2022 RESOURCES_PROCESSED = resources_processed \n Defined in \n libs/sdk-core/src/lib/db/db.models.ts:180 + \n \n SEARCHES_PERFORMED \n \u2022 SEARCHES_PERFORMED = searches_performed \n + Defined in \n libs/sdk-core/src/lib/db/db.models.ts:188 \n \n SLOW_PROCESSING_TIME + \n \u2022 SLOW_PROCESSING_TIME = slow_processing_time \n Defined in \n libs/sdk-core/src/lib/db/db.models.ts:179 + \n \n SUGGESTIONS_PERFORMED \n \u2022 SUGGESTIONS_PERFORMED = suggestions_performed + \n Defined in \n libs/sdk-core/src/lib/db/db.models.ts:189 \n \n TRAIN_SECONDS + \n \u2022 TRAIN_SECONDS = train_seconds \n Defined in \n libs/sdk-core/src/lib/db/db.models.ts:187 ```\n\n\n---\"\n\n\n**block-AG**\n\n## Chunk: docs > develop > js sdk > interfaces > ChatOptions\n``` \n optional max_tokens: number \\| object \n \n Defines the maximum number of tokens that the model will take as context. \n Defined @@ -1295,32 +1332,23 @@ interactions: > PredictAnswerOptions\n``` \n optional generative_model: string \n \n Defined in \n libs/sdk-core/src/lib/db/search/ask.models.ts:250 \n \n json_schema? \n \n optional json_schema: object \n \n Defined in \n libs/sdk-core/src/lib/db/search/ask.models.ts:257 - \n \n max_tokens? \n ```\n\n\n---\"\n\n\n**block-AI**\n\n## Chunk: docs > develop - > js sdk > interfaces > SamlConfig\n``` @nuclia/core \u2022 Docs \n \n @nuclia/core - / SamlConfig \n Interface: SamlConfig \n Properties \n authn_context? \n \n - optional authn_context: exact \\| minimum \\| better \\| maximum \n \n Defined - in \n libs/sdk-core/src/lib/db/db.models.ts:113 \n \n domains \n \n domains: - string[] \n \n Defined in \n libs/sdk-core/src/lib/db/db.models.ts:109 \n \n - entity_id \n \n entity_id: string \n \n Defined in \n libs/sdk-core/src/lib/db/db.models.ts:110 - \n \n sso_url \n \n sso_url: string \n \n Defined in \n libs/sdk-core/src/lib/db/db.models.ts:111 - \n \n x509_cert \n \n x509_cert: string \n \n Defined in \n libs/sdk-core/src/lib/db/db.models.ts:112 - ```\n\n\n---\"\n\n\n\n\n\n\n"}, "citations": false, "citation_threshold": - null, "generative_model": "chatgpt-azure-4o-mini", "max_tokens": 2000, "query_context_images": - {}, "prefer_markdown": null, "json_schema": {"title": "validate_or_answer", - "description": "Validate or answer", "parameters": {"type": "object", "properties": - {"reason": {"type": "string", "description": "Reasoning for the answer or validation"}, - "answer": {"type": "string", "description": "Partial or complete answer to the - user query from the information in the context."}, "missing_info_query": {"type": - "string", "description": "Query needed to retrieve the missing information in - case the context is not enough to answer the question. If the context does not - answer the question at all, just return the original question."}, "useful": - {"type": "string", "description": "Is the context useful to answer the question?", - "enum": ["yes", "no"]}, "citations": {"type": "array", "items": {"type": "string", - "description": "Block ID cited in the answer, e.g. block-AB"}, "description": - "List of block IDs cited in the answer, if any"}}, "required": ["reason", "answer", - "missing_info_query", "useful", "citations"]}}, "format_prompt": false, "rerank_context": - false, "tools": [], "tool_choice": {"type": "required"}, "reasoning": false, - "seed": null}' + \n \n max_tokens? \n ```\n\n\n---\"\n\n\n\n\n\n\n"}, "citations": + false, "citation_threshold": null, "generative_model": "chatgpt-azure-4o-mini", + "max_tokens": 2000, "query_context_images": {}, "prefer_markdown": null, "json_schema": + {"title": "validate_or_answer", "description": "Validate or answer", "parameters": + {"type": "object", "properties": {"reason": {"type": "string", "description": + "Reasoning for the answer or validation"}, "answer": {"type": "string", "description": + "Partial or complete answer to the user query from the information in the context."}, + "missing_info_query": {"type": "string", "description": "Query needed to retrieve + the missing information in case the context is not enough to answer the question. + If the context does not answer the question at all, just return the original + question."}, "useful": {"type": "string", "description": "Is the context useful + to answer the question?", "enum": ["yes", "no"]}, "citations": {"type": "array", + "items": {"type": "string", "description": "Block ID cited in the answer, e.g. + block-AB"}, "description": "List of block IDs cited in the answer, if any"}}, + "required": ["reason", "answer", "missing_info_query", "useful", "citations"]}}, + "format_prompt": false, "rerank_context": false, "tools": [], "tool_choice": + {"type": "required"}, "reasoning": false, "seed": null}' headers: Accept: - application/x-ndjson @@ -1329,13 +1357,13 @@ interactions: Connection: - keep-alive Content-Length: - - '17514' + - '16756' Content-Type: - application/json Host: - - europe-1.nuclia.cloud + - europe-1.dp.progress.cloud User-Agent: - - nuclia.py/4.9.25 + - nuclia.py/4.11.5 x-origin: - RAO x-show-consumption: @@ -1343,33 +1371,31 @@ interactions: x-stf-nuakey: - DUMMY method: POST - uri: https://europe-1.nuclia.cloud/api/v1/predict/chat + uri: https://europe-1.dp.progress.cloud/api/v1/predict/chat response: body: string: '{"chunk":{"type":"object","object":{"reason":"The context provides - detailed information about the purpose and usage of the `max_tokens` parameter - in Nuclia, including its role in setting limits on context size and answer - length. However, the context does not contain any information about what a - Cardamom bun is. Therefore, the answer is partially complete, and additional - information is needed regarding Cardamom buns.","answer":"The `max_tokens` - parameter in Nuclia is used on the /ask endpoint to set hard limits on context - size and answer length. Specifically, it limits the amount of retrieved information - sent to the LLM and the length of the generated response. The `max_tokens` - parameter defines the maximum number of input tokens to include in the final - context, which encompasses the prompt, the retrieved results, and the user - question. Additionally, `max_output_tokens` specifies the maximum number of - tokens to generate.","missing_info_query":"What is a Cardamom bun?","useful":"yes","citations":["block-AA","block-AB"]}}} + detailed information about how the `max_tokens` parameter is utilized within + the Nuclia system, specifically regarding its role in setting limits on context + size and answer length. However, the context does not provide any information + about what a Cardamom bun is. Therefore, the answer is partially complete, + as it addresses the first part of the question but lacks information on the + second part.","answer":"The `max_tokens` parameter is utilized within the + Nuclia system to set hard limits on two aspects: 1. Context size: It limits + the amount of retrieved information sent to the language model (LLM). 2. Answer + length: It limits the length of the generated response.","missing_info_query":"What + is a Cardamom bun?","useful":"yes","citations":["block-AA","block-AB"]}}} {"chunk":{"type":"status","code":"0"}} - {"chunk":{"type":"meta","input_tokens":111,"output_tokens":25,"timings":{"generative":3.0113384569995105},"input_nuclia_tokens":0.111,"output_nuclia_tokens":0.025}} + {"chunk":{"type":"meta","input_tokens":105,"output_tokens":21,"timings":{"generative":3.1928687740000896},"input_nuclia_tokens":0.105,"output_nuclia_tokens":0.021}} - {"chunk":{"normalized_tokens":{"input":0.11109,"output":0.02484,"image":0.0},"customer_key_tokens":{"input":0.0,"output":0.0,"image":0.0},"type":"consumption"}} + {"chunk":{"normalized_tokens":{"input":0.10539,"output":0.02076,"image":0.0},"customer_key_tokens":{"input":0.0,"output":0.0,"image":0.0},"type":"consumption"}} ' headers: Alt-Svc: - - h3=":443"; ma=2592000 + - h3=":443"; ma=2592000,h3-29=":443"; ma=2592000 Transfer-Encoding: - chunked access-control-expose-headers: @@ -1377,17 +1403,17 @@ interactions: content-type: - application/x-ndjson date: - - Wed, 03 Jun 2026 08:00:00 GMT + - Mon, 13 Jul 2026 08:57:55 GMT nuclia-learning-id: - - be669c43b07348ffa45da3e3df0640a7 + - 73084437d0f646f2bc8137b85d0a8fc3 nuclia-learning-model: - chatgpt-azure-4o-mini via: - 1.1 google x-envoy-upstream-service-time: - - '3014' + - '3196' x-nuclia-trace-id: - - 4addf2a9c7305de596467b2bfdcdef0e + - 0c8759823e8672cb9e12d68135471826 status: code: 200 message: OK @@ -1410,14 +1436,11 @@ interactions: your reasoning for rephrasing or not the question.\n\nHere you have the question, the contexts from previous agents and the description of the current agent:\n\n\n\nAgent that provides context to answer questions.\n\n\n\n\n\n\nContext:\n\n- The `max_tokens` parameter in Nuclia is used on the - /ask endpoint to set hard limits on context size and answer length. Specifically, - it limits the amount of retrieved information sent to the LLM and the length - of the generated response. The `max_tokens` parameter defines the maximum number - of input tokens to include in the final context, which encompasses the prompt, - the retrieved results, and the user question. Additionally, `max_output_tokens` - specifies the maximum number of tokens to generate.\n\n\n\n\nWhat - is the purpose and usage of `max_tokens` in Nuclia, and what is a Cardamom bun?\n"}, + CONTEXTS>\n\nContext:\n\n- The `max_tokens` parameter is utilized within the + Nuclia system to set hard limits on two aspects: 1. Context size: It limits + the amount of retrieved information sent to the language model (LLM). 2. Answer + length: It limits the length of the generated response.\n\n\n\n\nHow + is `max_tokens` utilized within the Nuclia system, and what is a Cardamom bun?\n"}, "citations": false, "citation_threshold": null, "generative_model": "chatgpt-azure-4o-mini", "max_tokens": 2000, "query_context_images": {}, "prefer_markdown": null, "json_schema": {"title": "next_rephrase", "description": "Rephrase the question if needed given @@ -1437,13 +1460,13 @@ interactions: Connection: - keep-alive Content-Length: - - '2916' + - '2673' Content-Type: - application/json Host: - - europe-1.nuclia.cloud + - europe-1.dp.progress.cloud User-Agent: - - nuclia.py/4.9.25 + - nuclia.py/4.11.5 x-origin: - RAO x-show-consumption: @@ -1451,21 +1474,21 @@ interactions: x-stf-nuakey: - DUMMY method: POST - uri: https://europe-1.nuclia.cloud/api/v1/predict/chat + uri: https://europe-1.dp.progress.cloud/api/v1/predict/chat response: body: string: '{"chunk":{"type":"object","object":{"rephrased_question":"What is the - purpose and usage of `max_tokens` in Nuclia? Also, can you explain what a - Cardamom bun is?","needed":true,"reason":"The original question combines two - unrelated topics: the usage of `max_tokens` in Nuclia and the definition of - a Cardamom bun. The current agent can only provide context for the first part, - so rephrasing is necessary to separate the two topics."}}} + role of `max_tokens` in the Nuclia system, and can you explain what a Cardamom + bun is?","needed":true,"reason":"The question contains two distinct parts: + one about `max_tokens` and another about Cardamom buns. The current agent + can provide context on `max_tokens`, but it may not have the necessary information + about Cardamom buns. Rephrasing separates the two topics for clarity."}}} {"chunk":{"type":"status","code":"0"}} - {"chunk":{"type":"meta","input_tokens":16,"output_tokens":12,"timings":{"generative":1.4932863530048053},"input_nuclia_tokens":0.016,"output_nuclia_tokens":0.012}} + {"chunk":{"type":"meta","input_tokens":14,"output_tokens":12,"timings":{"generative":2.1235276730149053},"input_nuclia_tokens":0.014,"output_nuclia_tokens":0.012}} - {"chunk":{"normalized_tokens":{"input":0.01554,"output":0.01164,"image":0.0},"customer_key_tokens":{"input":0.0,"output":0.0,"image":0.0},"type":"consumption"}} + {"chunk":{"normalized_tokens":{"input":0.01425,"output":0.01188,"image":0.0},"customer_key_tokens":{"input":0.0,"output":0.0,"image":0.0},"type":"consumption"}} ' headers: @@ -1478,17 +1501,17 @@ interactions: content-type: - application/x-ndjson date: - - Wed, 03 Jun 2026 08:00:03 GMT + - Mon, 13 Jul 2026 08:57:58 GMT nuclia-learning-id: - - e33544419db7468bb01c3b7e476fb7d2 + - 543018b7f3b24897900b52763c0e03f1 nuclia-learning-model: - chatgpt-azure-4o-mini via: - 1.1 google x-envoy-upstream-service-time: - - '1498' + - '2128' x-nuclia-trace-id: - - 030449358414ed74a243bf211b90ef79 + - 0c8759823e8672cb9e12d68135471826 status: code: 200 message: OK @@ -1527,9 +1550,9 @@ interactions: \"block-CD\"]).\n11. **IMPORTANT** If any extra instructions are provided, you MUST follow them carefully when generating the answer field. These instructions may specify the format, style, tools to use, or other requirements for the answer.\n\n\nWhat - is the purpose and usage of `max_tokens` in Nuclia? Also, can you explain what - a Cardamom bun is?\n\n\n\nContext:\n\n**block-AA**\n\n## Chunk: - 971fc5ac435c4cd7b2e6154266ed8161\n``` Cardamom bun is a pastry ```\n\n\n---\"\n\n\n\n\n\n\nContext:\n\n**block-AA**\n\n## Chunk: + 859b5a47fafc49c69a3e1bd4356fbe1d\n``` Cardamom bun is a pastry ```\n\n\n---\"\n\n\n\n\n\n\n"}, "citations": false, "citation_threshold": null, "generative_model": "chatgpt-azure-4o-mini", "max_tokens": 2000, "query_context_images": {}, "prefer_markdown": null, "json_schema": {"title": "validate_or_answer", "description": "Validate @@ -1554,13 +1577,13 @@ interactions: Connection: - keep-alive Content-Length: - - '4178' + - '4174' Content-Type: - application/json Host: - - europe-1.nuclia.cloud + - europe-1.dp.progress.cloud User-Agent: - - nuclia.py/4.9.25 + - nuclia.py/4.11.5 x-origin: - RAO x-show-consumption: @@ -1568,25 +1591,25 @@ interactions: x-stf-nuakey: - DUMMY method: POST - uri: https://europe-1.nuclia.cloud/api/v1/predict/chat + uri: https://europe-1.dp.progress.cloud/api/v1/predict/chat response: body: string: '{"chunk":{"type":"object","object":{"reason":"The context provides information about Cardamom bun as a pastry but does not mention anything about - `max_tokens` in Nuclia. Therefore, the context is only partially useful for - answering the question.","answer":"Cardamom bun is a pastry.","missing_info_query":"What - is the purpose and usage of `max_tokens` in Nuclia?","useful":"yes","citations":["block-AA"]}}} + `max_tokens` in the Nuclia system. Therefore, the context is only partially + useful for answering the question.","answer":"Cardamom bun is a pastry.","missing_info_query":"What + is the role of `max_tokens` in the Nuclia system?","useful":"yes","citations":["block-AA"]}}} {"chunk":{"type":"status","code":"0"}} - {"chunk":{"type":"meta","input_tokens":23,"output_tokens":10,"timings":{"generative":1.497064290997514},"input_nuclia_tokens":0.023,"output_nuclia_tokens":0.01}} + {"chunk":{"type":"meta","input_tokens":24,"output_tokens":11,"timings":{"generative":1.6521781800256576},"input_nuclia_tokens":0.024,"output_nuclia_tokens":0.011}} - {"chunk":{"normalized_tokens":{"input":0.02346,"output":0.01044,"image":0.0},"customer_key_tokens":{"input":0.0,"output":0.0,"image":0.0},"type":"consumption"}} + {"chunk":{"normalized_tokens":{"input":0.02352,"output":0.01068,"image":0.0},"customer_key_tokens":{"input":0.0,"output":0.0,"image":0.0},"type":"consumption"}} ' headers: Alt-Svc: - - h3=":443"; ma=2592000,h3-29=":443"; ma=2592000 + - h3=":443"; ma=2592000 Transfer-Encoding: - chunked access-control-expose-headers: @@ -1594,17 +1617,17 @@ interactions: content-type: - application/x-ndjson date: - - Wed, 03 Jun 2026 08:00:05 GMT + - Mon, 13 Jul 2026 08:58:01 GMT nuclia-learning-id: - - 842276f1eb4b4a718412e9bde76729ee + - 2bf1ca6a72bd4b4b8847fe6bdd74d3c4 nuclia-learning-model: - chatgpt-azure-4o-mini via: - 1.1 google x-envoy-upstream-service-time: - - '1502' + - '1657' x-nuclia-trace-id: - - 9ab6bb208256eb3368981c0d93706c49 + - 0c8759823e8672cb9e12d68135471826 status: code: 200 message: OK @@ -1618,26 +1641,24 @@ interactions: this clearly\n\nAlways follow any additional instructions provided about format, style, or domain-specific behavior.", "chat_history": [], "context": [], "query_context": {}, "query_context_order": {}, "truncate": true, "user_prompt": {"prompt": "\n## - Question\nWhat is the purpose and usage of `max_tokens` in Nuclia, and what - is a Cardamom bun?\n\n## Provided Context\n[START OF CONTEXT]\n## Retrieval - on nuclia-docs Knowledge Box\n\n# What is the purpose and usage of `max_tokens` - in Nuclia, and what is a Cardamom bun?\n\n The `max_tokens` parameter in Nuclia - is used on the /ask endpoint to set hard limits on context size and answer length. - Specifically, it limits the amount of retrieved information sent to the LLM - and the length of the generated response. The `max_tokens` parameter defines - the maximum number of input tokens to include in the final context, which encompasses - the prompt, the retrieved results, and the user question. Additionally, `max_output_tokens` - specifies the maximum number of tokens to generate.\n\n## Static Context\n\n# - \n\n Cardamom bun is a pastry.\n[END OF CONTEXT]\n\n## Answering Guidelines\n- - Carefully read all context; it may be lengthy or detailed\n- Do not omit or - overlook any relevant information\n- If the context is incomplete or insufficient, - state: \"Not enough data to answer this.\"\n- Read carefully any extra instructions - below if provided and use them to answer\n\nNow provide your answer to the question: - What is the purpose and usage of `max_tokens` in Nuclia, and what is a Cardamom - bun?"}, "citations": null, "citation_threshold": null, "generative_model": "chatgpt-azure-4o-mini", - "max_tokens": 5000, "query_context_images": {}, "prefer_markdown": null, "json_schema": - null, "format_prompt": false, "rerank_context": false, "tools": [], "tool_choice": - {"type": "auto"}, "reasoning": false, "seed": null}' + Question\nHow is `max_tokens` utilized within the Nuclia system, and what is + a Cardamom bun?\n\n## Provided Context\n[START OF CONTEXT]\n## Retrieval on + nuclia-docs Knowledge Box\n\n# How is `max_tokens` utilized within the Nuclia + system, and what is a Cardamom bun?\n\n The `max_tokens` parameter is utilized + within the Nuclia system to set hard limits on two aspects: 1. Context size: + It limits the amount of retrieved information sent to the language model (LLM). + 2. Answer length: It limits the length of the generated response.\n\n## Static + Context\n\n# \n\n Cardamom bun is a pastry.\n[END OF CONTEXT]\n\n## Answering + Guidelines\n- Carefully read all context; it may be lengthy or detailed\n- Do + not omit or overlook any relevant information\n- If the context is incomplete + or insufficient, state: \"Not enough data to answer this.\"\n- Read carefully + any extra instructions below if provided and use them to answer\n\nNow provide + your answer to the question: How is `max_tokens` utilized within the Nuclia + system, and what is a Cardamom bun?"}, "citations": null, "citation_threshold": + null, "generative_model": "chatgpt-azure-4o-mini", "max_tokens": 5000, "query_context_images": + {}, "prefer_markdown": null, "json_schema": null, "format_prompt": false, "rerank_context": + false, "tools": [], "tool_choice": {"type": "auto"}, "reasoning": false, "seed": + null}' headers: Accept: - application/x-ndjson @@ -1646,17 +1667,17 @@ interactions: Connection: - keep-alive Content-Length: - - '2308' + - '2061' Content-Type: - application/json Host: - - europe-1.nuclia.cloud + - europe-1.dp.progress.cloud User-Agent: - - nuclia.py/4.9.25 + - nuclia.py/4.11.5 x-client-ident: - default x-message: - - 964d18282cf3423fb46939adc1e116d6 + - 7dec54e352084b60b49596da46939cb3 x-origin: - RAO x-session: @@ -1666,7 +1687,7 @@ interactions: x-stf-nuakey: - DUMMY method: POST - uri: https://europe-1.nuclia.cloud/api/v1/predict/chat + uri: https://europe-1.dp.progress.cloud/api/v1/predict/chat response: body: string: '{"chunk":{"type":"text","text":"The"}} @@ -1681,7 +1702,9 @@ interactions: {"chunk":{"type":"text","text":" parameter"}} - {"chunk":{"type":"text","text":" in"}} + {"chunk":{"type":"text","text":" within"}} + + {"chunk":{"type":"text","text":" the"}} {"chunk":{"type":"text","text":" Nu"}} @@ -1689,45 +1712,47 @@ interactions: {"chunk":{"type":"text","text":"ia"}} - {"chunk":{"type":"text","text":" is"}} - - {"chunk":{"type":"text","text":" used"}} - - {"chunk":{"type":"text","text":" on"}} - - {"chunk":{"type":"text","text":" the"}} + {"chunk":{"type":"text","text":" system"}} - {"chunk":{"type":"text","text":" /"}} - - {"chunk":{"type":"text","text":"ask"}} + {"chunk":{"type":"text","text":" is"}} - {"chunk":{"type":"text","text":" endpoint"}} + {"chunk":{"type":"text","text":" utilized"}} {"chunk":{"type":"text","text":" to"}} {"chunk":{"type":"text","text":" set"}} + {"chunk":{"type":"text","text":" hard"}} + {"chunk":{"type":"text","text":" limits"}} {"chunk":{"type":"text","text":" on"}} - {"chunk":{"type":"text","text":" context"}} + {"chunk":{"type":"text","text":" two"}} - {"chunk":{"type":"text","text":" size"}} + {"chunk":{"type":"text","text":" aspects"}} - {"chunk":{"type":"text","text":" and"}} + {"chunk":{"type":"text","text":":"}} - {"chunk":{"type":"text","text":" answer"}} + {"chunk":{"type":"text","text":" \n\n"}} - {"chunk":{"type":"text","text":" length"}} + {"chunk":{"type":"text","text":"1"}} {"chunk":{"type":"text","text":"."}} - {"chunk":{"type":"text","text":" It"}} + {"chunk":{"type":"text","text":" **"}} - {"chunk":{"type":"text","text":" restrict"}} + {"chunk":{"type":"text","text":"Context"}} - {"chunk":{"type":"text","text":"s"}} + {"chunk":{"type":"text","text":" size"}} + + {"chunk":{"type":"text","text":"**"}} + + {"chunk":{"type":"text","text":":"}} + + {"chunk":{"type":"text","text":" It"}} + + {"chunk":{"type":"text","text":" limits"}} {"chunk":{"type":"text","text":" the"}} @@ -1745,121 +1770,45 @@ interactions: {"chunk":{"type":"text","text":" the"}} - {"chunk":{"type":"text","text":" L"}} + {"chunk":{"type":"text","text":" language"}} - {"chunk":{"type":"text","text":"LM"}} + {"chunk":{"type":"text","text":" model"}} - {"chunk":{"type":"text","text":" and"}} + {"chunk":{"type":"text","text":" ("}} - {"chunk":{"type":"text","text":" the"}} + {"chunk":{"type":"text","text":"LL"}} - {"chunk":{"type":"text","text":" length"}} + {"chunk":{"type":"text","text":"M"}} - {"chunk":{"type":"text","text":" of"}} + {"chunk":{"type":"text","text":").\n"}} - {"chunk":{"type":"text","text":" the"}} - - {"chunk":{"type":"text","text":" generated"}} - - {"chunk":{"type":"text","text":" response"}} + {"chunk":{"type":"text","text":"2"}} {"chunk":{"type":"text","text":"."}} - {"chunk":{"type":"text","text":" Specifically"}} - - {"chunk":{"type":"text","text":","}} + {"chunk":{"type":"text","text":" **"}} - {"chunk":{"type":"text","text":" it"}} + {"chunk":{"type":"text","text":"Answer"}} - {"chunk":{"type":"text","text":" defines"}} - - {"chunk":{"type":"text","text":" the"}} - - {"chunk":{"type":"text","text":" maximum"}} - - {"chunk":{"type":"text","text":" number"}} - - {"chunk":{"type":"text","text":" of"}} - - {"chunk":{"type":"text","text":" input"}} + {"chunk":{"type":"text","text":" length"}} - {"chunk":{"type":"text","text":" tokens"}} + {"chunk":{"type":"text","text":"**"}} - {"chunk":{"type":"text","text":" to"}} + {"chunk":{"type":"text","text":":"}} - {"chunk":{"type":"text","text":" include"}} + {"chunk":{"type":"text","text":" It"}} - {"chunk":{"type":"text","text":" in"}} + {"chunk":{"type":"text","text":" limits"}} {"chunk":{"type":"text","text":" the"}} - {"chunk":{"type":"text","text":" final"}} - - {"chunk":{"type":"text","text":" context"}} - - {"chunk":{"type":"text","text":","}} - - {"chunk":{"type":"text","text":" which"}} - - {"chunk":{"type":"text","text":" consists"}} + {"chunk":{"type":"text","text":" length"}} {"chunk":{"type":"text","text":" of"}} {"chunk":{"type":"text","text":" the"}} - {"chunk":{"type":"text","text":" prompt"}} - - {"chunk":{"type":"text","text":","}} - - {"chunk":{"type":"text","text":" retrieved"}} - - {"chunk":{"type":"text","text":" results"}} - - {"chunk":{"type":"text","text":","}} - - {"chunk":{"type":"text","text":" and"}} - - {"chunk":{"type":"text","text":" the"}} - - {"chunk":{"type":"text","text":" user"}} - - {"chunk":{"type":"text","text":" question"}} - - {"chunk":{"type":"text","text":"."}} - - {"chunk":{"type":"text","text":" Additionally"}} - - {"chunk":{"type":"text","text":","}} - - {"chunk":{"type":"text","text":" `"}} - - {"chunk":{"type":"text","text":"max"}} - - {"chunk":{"type":"text","text":"_output"}} - - {"chunk":{"type":"text","text":"_tokens"}} - - {"chunk":{"type":"text","text":"`"}} - - {"chunk":{"type":"text","text":" specifies"}} - - {"chunk":{"type":"text","text":" the"}} - - {"chunk":{"type":"text","text":" maximum"}} - - {"chunk":{"type":"text","text":" number"}} - - {"chunk":{"type":"text","text":" of"}} - - {"chunk":{"type":"text","text":" tokens"}} - - {"chunk":{"type":"text","text":" to"}} - - {"chunk":{"type":"text","text":" generate"}} - - {"chunk":{"type":"text","text":" in"}} - - {"chunk":{"type":"text","text":" the"}} + {"chunk":{"type":"text","text":" generated"}} {"chunk":{"type":"text","text":" response"}} @@ -1885,14 +1834,14 @@ interactions: {"chunk":{"type":"status","code":"0"}} - {"chunk":{"type":"meta","input_tokens":12,"output_tokens":13,"timings":{"generative_first_chunk":0.3647183969951584,"generative":1.519737331997021},"input_nuclia_tokens":0.012,"output_nuclia_tokens":0.013}} + {"chunk":{"type":"meta","input_tokens":11,"output_tokens":9,"timings":{"generative_first_chunk":1.0968778440146707,"generative":2.382443748007063},"input_nuclia_tokens":0.011,"output_nuclia_tokens":0.009}} - {"chunk":{"normalized_tokens":{"input":0.01197,"output":0.01296,"image":0.0},"customer_key_tokens":{"input":0.0,"output":0.0,"image":0.0},"type":"consumption"}} + {"chunk":{"normalized_tokens":{"input":0.01056,"output":0.00864,"image":0.0},"customer_key_tokens":{"input":0.0,"output":0.0,"image":0.0},"type":"consumption"}} ' headers: Alt-Svc: - - h3=":443"; ma=2592000,h3-29=":443"; ma=2592000 + - h3=":443"; ma=2592000 Transfer-Encoding: - chunked access-control-expose-headers: @@ -1900,17 +1849,17 @@ interactions: content-type: - application/x-ndjson date: - - Wed, 03 Jun 2026 08:00:07 GMT + - Mon, 13 Jul 2026 08:58:02 GMT nuclia-learning-id: - - 8dbd012a33b14b2089d52e2baa85100f + - 5ee95e844f24444f83b6f31d1eabfb78 nuclia-learning-model: - chatgpt-azure-4o-mini via: - 1.1 google x-envoy-upstream-service-time: - - '375' + - '1114' x-nuclia-trace-id: - - b0e6a200ba072f6eee37ac4ca06f5cdd + - 3d1f2cc4049467796ec8060dc2a2e92c status: code: 200 message: OK diff --git a/uv.lock b/uv.lock index 845a65d..f792df9 100644 --- a/uv.lock +++ b/uv.lock @@ -1273,6 +1273,7 @@ dependencies = [ { name = "starlette" }, { name = "tenacity" }, { name = "types-redis" }, + { name = "uvicorn" }, { name = "websockets" }, ] @@ -1321,6 +1322,7 @@ requires-dist = [ { name = "starlette", specifier = ">1.0.0" }, { name = "tenacity" }, { name = "types-redis", specifier = ">=4.6.0.20241004" }, + { name = "uvicorn", specifier = ">=0.30.0" }, { name = "websockets" }, ]