Documentation Changelog
This changelog tracks changes to Vectara's documentation — new and updated guides, context-engineering material, and API reference updates. For product and feature releases, see the Release Notes.
September 2026Latest
Documentation Updates
- #UpdatedDocumented streamed tool tests on the Composable lambda tools page, covering
stream_response, theheartbeatand terminalresultevents, and that a budget above 300 seconds requires streaming. - #UpdatedDocumented the raised execution ceiling of 21600 seconds on the Custom tools, Lambda tools, and Composable lambda tools pages, along with the 300-second default a lambda that declares
tool_configurationsnow resolves to whenexecution_configurationis omitted.
Docs Platform Updates
- #Removed the Agent Playground and its walkthrough page. The interactive page at
/playground/and the/docs/platform-architecture/playgroundguide are gone, and the Platform architecture and Application layer pages no longer point at them. To drive an agent live, use the Console or the io CLI.
August 2026
New Documentation
- #Added Wolken Tickets pipeline source documentation covering incident and service request ingestion from a Wolken ServiceDesk instance, one document per ticket with its subject, description, and conversation notes, the
backfill_windowlookback bound, and therequest_types,status_ids, andnote_response_type_idsfilters. - #Added Docebo pipeline source documentation covering course catalog ingestion from a Docebo LMS instance through the Learn REST API, one document per course with a curriculum outline of its training materials, the
published_onlyflag and the language and category include/exclude filters, and the full-catalog re-enumeration incremental sync performs because Docebo exposes no modified-since filter. - #Added Confluence tools for agents documentation covering all nineteen Confluence Cloud agent tools — space and content discovery, page and attachment reading, content creation, whole-page and in-place editing, and comments and labels — along with the API-token authentication the tools resolve from agent metadata and secrets by default, the markdown-to-storage-format conversion, and the version-based edit model. The page also flags that each tool name carries a date suffix (four different ones across the family) and cross-links the Confluence pipeline source.
- #Added Box tools for agents documentation covering all seventeen Box agent tools — search and reading, content changes, and collaboration — along with developer-token and Client Credentials Grant authentication, including the complete per-mode
argument_overrideeach one needs and why naming only the arguments for your chosen mode is required rather than optional. - #Added Post to Google Chat from an agent documentation covering the
gchat_post_messagetool: thespace_name,text,cards, andthread_nameparameters, theok,message_name,thread_name, anderrorresponse, card sections and link buttons, and credentials from either an attached Google Chat connector or thegchat_service_account_keyagent secret. - #Added Google Drive tools for agents documentation covering all fifteen Drive agent tools — finding and reading files, organizing them, managing access, and comments — along with the four-step credential precedence every Google-backed tool shares, the
subject_emailimpersonation argument, and that Drive tool names carry no version suffix unlike Box and Confluence. The page also documents two behaviors that are easy to hit and hard to diagnose: aconnector_idresolving to a non-Google connector is ignored rather than rejected, so a Slack- or Zoom-triggered session can still reach Drive, while one resolving to nothing is an error; and a bare service account owns no Drive storage, so creating or copying a file fails unless the destination is a Shared Drive it can write to. - #Added Google Chat connectors documentation covering how the connector works, creating one and configuring the Google Chat app against it, the credentials the Google Chat tools resolve from it, listing, updating, and deleting connectors, and troubleshooting a webhook that returns 401, is rejected, or succeeds without the agent replying.
- #Added Zoom connectors documentation covering how the connector works, creating one and configuring Zoom Contact Center against it, listing, updating, and deleting connectors, and troubleshooting a webhook that returns 401, the misconfiguration message Zoom receives, and an undelivered agent response.
Documentation Updates
- #UpdatedDocumented the
mapscontent scope on the Fluid Topics pipeline source page, covering whole-publication enumeration, the ignoredquery, and the reservedidfilter key that restricts a run to a single publication. - #UpdatedDocumented the
max_body_bytesparameter on the Wrap a REST API with web_get page, covering the UTF-8 byte ceiling it places on the requestbody, its 1 KB to 4 MB range, its 64 KB default, and the rejection of an oversized body before the request is sent. - #FixedCorrected the Confluence agent tool identifiers in the Release Notes, where nine tools were listed by their
lineagefamily name (such asconfluence_fetch) rather than the versionednameyou pass when configuring a tool (such asconfluence_fetch_20260622). - #Repointed the Google Drive tool entries in the Release Notes at the new Google Drive tools page. The August entry had linked to Connector authentication, which documents per-user OAuth for custom
web_gettools rather than the service-account credentials these built-in tools actually use. - #FixedFixed a broken link in the Release Notes entry for the document conversion tool, which pointed at a relative path (
docs/agent/sessions#document-upload-and-conversion) with no leading slash, a singularagentsegment, and an anchor that does not exist. It now points at the document conversion tool section. - #UpdatedDocumented per-pipeline
processing_optionson the Pipeline concepts page, coveringrecord_timeout_minutes(1–180, overriding the 30-minute service default for one attempt) andmax_concurrent_records(1–64), that a record's total budget across all retries is twicerecord_timeout_minutes, and that an update replaces the object wholesale rather than merging it field by field. - #UpdatedDocumented the new fetch-then-process model on the Web pipeline source page, covering
max_concurrent_fetches(1–4, default 2), the deprecated and now-ignoredmax_concurrent, therequests_per_secondceiling raised from 20 to 50, that the rate applies to each concurrent fetch independently so the worst case against a host is the product of the two, and the fallback to a live fetch for a page too large to stage. - #UpdatedDocumented the
artifactslibrary on the Lambda tools page, coveringartifacts.download(artifact_id, dest_path=None), that it is available without an import inside an agent session, thatdest_pathis relative to the sandbox scratch directory and defaults to the artifact id, and theArtifactErrorraised for an unknown id or a path outside the scratch directory. - #FixedCorrected the set of Python modules a lambda tool can use, on the Lambda tools and Create a lambda tool pages: code can import the Python standard library plus the preinstalled
numpyandpandas, replacing the eleven-module list both pages had presented as the complete set. - #UpdatedDocumented parallel tool calls on the Composable lambda tools page, covering
tool.<name>.submit(param=value, ...), the handle it returns,handle.result()waiting for that call and re-raisingtool.ToolError, and the limit of eight calls running concurrently; also summarized on the Lambda tools page. - #UpdatedDocumented LLM discovery and model capabilities on the Bring your own LLM page, covering the
POST /v2/llms/discoverrequest and candidate response, theimage_support,context_limit,tool_calling,structured_outputs, andrequires_role_alternationcapability fields, and therequests_per_secondper-model rate limit with its differing create and update semantics. - #UpdatedDocumented what a read of an LLM configuration returns, on the Bring your own LLM page: the
authvariant the model was created with, every secret replaced by****, the non-secret identifiers around it preserved so you can still recognize the credential, and that rotating a credential means submitting a newauthobject with aPATCHwhile omittingauthkeeps the existing one. - #UpdatedDocumented the
slack_join_channeltool on the Slack connectors page, covering thechannel_idargument, the channel fields andalready_in_channelin the response, the Slack error codes returned inerror, and thechannels:joinscope it needs. - #UpdatedDocumented the
gchat_dm_usertool on the Post to Google Chat from an agent page, covering theuserandtextarguments, email resolution through the Workspace directory versus ausers/USER_IDresource name, and theok,space_name,message_name, andreachableresponse — wherereachablefalse means the person has never installed the Chat app and a retry will not help. - #UpdatedDocumented incremental sync on the Fluid Topics pipeline source page, covering the switch to reading dataflow reports since the previous watermark, the administration scope the
api_keynow requires, the 1000-report window bound that forces a full refresh, and that metadata-only changes are now detected while deletions are still not propagated. - #EnhancedExpanded the Build agents with io page into full io CLI documentation, covering installation and
io login, scoping the CLI API key, reviewing proposed changes and answering clarifying questions, running unattended in print mode, the workspace directory with/readand/pasteuploads,io designfor web applications — including joining agent keys with+for one application spanning several agents, the local proxy that keeps your API key out of the browser page, and that the bring-your-own LLM registration it creates is tenant-wide rather than personal —io previewfor an existing agent, and the deployment and LLM requirements for self-managed environments.
API Reference Updates
- #Corrected Evaluate factual consistency: the default and recommended model is
hhem_v2.3;languageis not a request field and the examples no longer show one; the response carriesscorerather than thep_consistentandp_inconsistentfields the examples had shown; the422response for an unsupported language is gone, because text in an untrained language is scored rather than rejected — onlyeng,deu,fra,spa,por,ara,kor,zho,rus,jpn, andhinshould be treated as reliable; and an unrecognized model name returns400againstbody.model_parameters.model_name. - #Documented the optional
external_idon an agent text input, up to 255 characters, which makes submitting an input idempotent within a session — a repeat of an id the session already holds adds nothing and returns no error — and is returned on the input's event inInputMessageEvent.messages. See Interact with an agent. - #Documented that reading a configured LLM returns the
authvariant it was created with, secrets replaced by****and non-secret identifiers such as an AWS access key id, a GCP project and region, or a header name preserved, on both Get an LLM and List LLMs.
Deprecations
- #Documented the deprecation of
max_concurrenton the Web pipeline source, which is no longer read; move any value you set tomax_concurrent_fetches, whose ceiling is 4. - #Documented the deprecation of
max_memory_mbon a lambda tool's execution configuration, which is now ignored because memory is fixed by the execution environment. See Create a lambda tool.
Docs Platform Updates
- #Removed the year filter from the Release Notes and Changelog browsers. Both already group by month and support search, so the filter added a control without adding a way to find anything.
- #Fixed broken and outdated links across the documentation, including the API reference, the security and authentication pages, the retrieval tuning guide, and the version 1.0 archive, and updated the redirect table so the old URLs still resolve.
July 2026
New Documentation
- #Added Wolken Forms pipeline source documentation covering ingestion of a Wolken ServiceDesk end-user service catalog (incident and service request forms), one document per form, and the optional
include_form_detailsenrichment. - #Added End user sessions documentation covering the dedicated
/v2/agent_aliases/{alias_key}/end_user_sessionssurface, theagent_end_userrole, per-caller session isolation, the messages-only event projection, streaming, and session limits, and cross-linked it from the Sessions page - #Added pipeline source documentation for Box, Confluence, Web, and Wolken KB, refreshed the S3, SharePoint, and Google Drive source pages, and updated the pipeline sources index and session metadata page.
- #Documented the
slack_get_filetool and bot-token-only credentials (theslack_bot_tokenagent secret) on the Slack Connectors page. - #Added Fluid Topics pipeline source documentation covering ingestion from a Fluid Topics tenant through the Knowledge Hub REST API and the
content_scopecontent layer selection. - #Added Alias workflows and best practices and a Canary a new agent version tutorial covering putting a stable alias in front of your agents and rolling out a new agent version behind it.
- #Added SCIM pipeline source documentation covering user profile ingestion from any SCIM 2.0 service provider through the Users endpoint, directory attributes as filterable metadata, and the
incremental_strategysync options.
Documentation Updates
- #FixedFixed the authentication code examples on the API key management and Transport Layer Security pages, where the request host rendered as a literal template placeholder instead of
api.vectara.io.
API Reference Updates
- #Documented the per-tool
tool_output_offloadingoverride on Create tool, which overrides the agent's output-offloading behavior for that tool's outputs. - #Documented the
metadata_filterquery parameter and the artifactmetadatafield on List session artifacts, for narrowing the list to artifacts whose metadata matches. - #Documented the per-tool
max_execution_time_secondstimeout on Create tool, the maximum wall-clock time before a tool call is aborted. - #Documented the A2A Protocol endpoints (v0.3 and v1) for agent discovery, message send and stream, and task lifecycle.
June 2026
New Documentation
- #Added Build with io documentation, introducing the io assistant in the Vectara Console as a conversational way to create and edit platform resources (such as agents, pipelines, and API keys), inspect your account, debug performance, and explore how Vectara works, with the confirmation flow and how to review the generated draft before saving and testing the agent.
- #Added Agent Aliases documentation: a concept page covering the
routedpolicy model (ordered rules,singleandweightedtargets,partition_byhashing, resolution fixed at session creation, and the independent alias and agent key namespaces) and a how-to covering direct aliases, canary rollouts, tenant routing, and policy replacement via/v2/agent_aliases - #Added Call other tools from lambda tools documentation covering the in-sandbox
toolmodule,$refresolution against the hosting agent's secrets and session metadata, and the privacy of composed tools (no agent-surface exposure, no session events) - #Added Visual data documentation for ingesting image-heavy content, with links to the related chunking, tables, and data-ingestion build guides
- #Added SharePoint pipeline source documentation covering Azure AD OAuth configuration and site scoping
- #Added Google Drive pipeline source documentation and a pipeline session metadata page
- #Documented the
glossary_put_entriesandglossary_delete_entriesagent tools on the Glossaries page - #Documented
PATCHsupport on the web_get tool page - #Added Enable SSO with OpenID Connect (OIDC) documentation for the Vectara SaaS deployment, covering registering an OIDC application with any provider (Okta, Microsoft Entra ID, Google Workspace, Ping Identity, OneLogin, and Keycloak), the parameters you exchange with Vectara, the callback URL, email-domain routing, group-to-access-level mapping, the permission model, and connection verification, alongside a new SaaS deployment guides index
- #Documented tool server authentication and credential wiring on the Tool Servers page, covering Bearer token, custom header, and OAuth 2.0 client-credentials authentication, service-account (shared) versus per-user (session-scoped) credentials, and synchronizing, updating, and deleting tool servers
Documentation Updates
- #FixedCorrected retrieval access-control claims and contrasted the ingest path with the agent-tools path
- #UpdatedDocumented how to quote filter field names that contain special characters
- #RemovedRemoved the fabricated "SmartChunk" term from the platform-architecture pages
- #FixedFixed the Slack connector create example by dropping the top-level
typefield
May 2026
New Documentation
- #Added a standalone UserFn language reference covering the shared expression language used by UDF rerankers, agent step transitions, and pipeline verification. Adds documentation for
extract_datetime_partand theknee(sensitivity, early_bias)form, clarifies thatseconds/minutes/hoursare bidirectional, calls out the lack ofthen/ternary syntax, and summarizes each caller's context schema in one place - #Added Agent Secrets documentation covering the
/v2/agents/{agent_key}/secretsresource, the{"$ref": "agent.secrets.<name>"}pattern inargument_override, masking on read and intool_inputevents, and migrating credentials offagent.metadata - #Added Slack Connectors documentation
- #Added chunking strategies guide and related docs links
Documentation Updates
- #UpdatedDocumented
fire_everyandskip_firston templated reminders, including the late-conversation reminding pattern for combating context rot and the post-compaction counter reset - #UpdatedAdded a Tool Output Transform section covering jq projection of tool responses, with real
web_search/web_getshapes and a search → fetch pairing example - #UpdatedPromoted tool-output gate pattern in agents/steps docs
- #UpdatedAdded 'The platform' section explaining architecture, agents, and how to build
- #UpdatedAdded integration-points concept doc and
web_gethow-to - #ChangedMoved Integrations documentation under Agents and cross-linked
- #Documentation updates for agents, security, and evaluation
- #ClarificationRefined onboarding pages and removed edit page links
April 2026
New Documentation
- #Added Glossaries documentation covering term-to-expansion mappings, matching behavior, and attaching glossaries to agent steps via
glossary_expansionreminders - #Added Pipelines documentation (quickstart, concepts, sources, verification, dead letters) for automated bulk processing of external data through agents
- #Added Multi-Client Steering documentation covering multi-device session consumption,
behavior: steervsfollow_up, and mid-turn interrupts - #Added Agent Skills for coding agents docs page
- #Added Python SDK Agents documentation
- #Added a dedicated Context Engineering section with an opinionated overview and deep-dive pages for Compaction, Reminders, Skills, Tool-Output Offloading, and Steps
- #Overview covers the pillars of a well-engineered agent: retrieval, instructions, tool configuration, sub-agent delegation, long-session management, tool-output protection, and monitoring
API Reference Updates
- #Updated the API Reference spec with all features released January–April 2026
- #Replaced
x-supported-api-key-typeannotations withx-required-roleson all 133 endpoints, showing exactly which API roles, corpus roles, and agent roles grant access - #Each endpoint page now shows role badges in the authorization section
Documentation Updates
- #UpdatedReorganized API Reference sidebar into grouped sections (Agents, Data, Search and Retrieval, Access Control, Analytics, Platform, Quality and Evaluation)
- #UpdatedRewrote Role-Based Access Control documentation to cover all four role tiers: API roles (13 account-level roles), corpus roles (viewer/editor/administrator/owner), agent roles (agent_user/agent_viewer/agent_developer/agent_administrator), and platform roles
- #UpdatedAdded API conventions and authentication documentation to the API Reference introduction page
- #UpdatedAdded retrieval tuning guides and cleaned up search-and-retrieval docs
- #UpdatedAdded llms.txt support for docs site
- #UpdatedAdded structured output usage guide
March 2026
New Documentation
- #Added Context Compaction documentation covering automatic context summarization, session forking, and token limit management
- #Added Tool Versioning and Metadata documentation covering category, lineage, version, tool group metadata, and experimental tool marking
- #Added Tool-Output Offloading documentation covering configurable thresholds, session artifacts, and
artifact_read/artifact_grep/artifact_jqtools
February 2026
New Documentation
- #Added Agent Reminders documentation covering re-injection of instructions into user inputs and tool outputs for long-session context management
- #Added Multi-Step Agent Workflows documentation covering named steps, step-specific instructions, tools, reminders, and configurable transition conditions
- #Added Agent Schedules documentation covering scheduled agent execution at specified intervals, session creation, and execution history
- #Added Agent Skills documentation covering named skills for explicit capability invocation and deterministic tool control
- #Added Concurrent Agent Sessions documentation covering multi-client interaction, interrupt handling, and collaborative workflows
January 2026
Documentation Updates
- #EnhancedEnhance Agents content with updated quickstart, concepts, instructions, and tools
December 2025
New Documentation
Documentation Updates
November 2025
API Reference Updates
Documentation Updates
- #EnhancedEnhance search and retrieval section
Docs Platform Updates
October 2025
New Documentation
- #Enhance Agents with Retry LLM Configuration
API Reference Updates
- #Add Agent LLM Retry Configuration to API Reference
Documentation Updates
September 2025
New Documentation
API Reference Updates
Documentation Updates
August 2025
New Documentation
API Reference Updates
- #Add Metadata Query API to API Reference
Documentation Updates
July 2025
New Documentation
Documentation Updates
- #FixedFix body request render in API Reference
- #EnhancedEnhance API Reference usability with automated API key type badges
- #UpdatedAdd detailed mapping of endpoints to required API key types
- #UpdatedUpdate Query History and Configure Queries sections, enhancing descriptions and screenshots
- #EnhancedEnhance chatbot tutorial with production readiness guidance
- #UpdatedAdd guidance on using expected value formats with Intelligent Query Rewriting
Docs Platform Updates
June 2025
New Documentation
Documentation Updates
Example Updates
- #Enhance API Documentation with Production-Ready Examples for Query, Upload, Index, and Chat Endpoints
Docs Platform Updates
- #Create new CodePanel component for customizable code samples with language selection, annotations, and layout configuration
May 2025
New Documentation
API Reference Updates
Documentation Updates
Example Updates
- #Update Hallucination Corrector model example
Docs Platform Updates
- #Update Docusaurus configuration to show last date a topic was updated
April 2025
New Documentation
API Reference Updates
- #Add the Evaluate Factual Consistency API and the Chat Completions API to the API Reference
Documentation Updates
- #EnhancedExpand Authentication section with new guides on enterprise access patterns, organizational role scoping, and authorization workflows
Docs Platform Updates
March 2025
New Documentation
API Reference Updates
Documentation Updates
Example Updates
- #Update Encoder examples
February 2025
New Documentation
API Reference Updates
- #Add the Summarize Document API, Create LLM API, and Compute Corpus Size API to the API Reference
Documentation Updates
- #UpdatedUpdate UI steps on how to reset or delete the corpus
January 2025
New Documentation
Documentation Updates
- #EnhancedImprove Getting Started section layout
- #FixedFix broken links in generative prompts
- #UpdatedAdd documentation changelog workflow
- #FixedFix OAuth2 URL and update screenshot
- #UpdatedAdd a dedicated changelog for documentation updates, API enhancements and bug fixes
- #UpdatedAdd HHEM 2.2 enhancements to Release Notes
Example Updates
- #Fix encoder example with correct value
Deprecations
- #Uploading JSON in API v2
Docs Platform Updates
- #Update Doc Changelog workflow action
December 2024
New Documentation
API Reference Updates
- #Add API Reference updates for the new tabular data extraction feature
Documentation Updates
Example Updates
- #Userfn example supports traditional if statement
Deprecations
- #Add API v1 deprecation notices
November 2024
New Documentation
- #Add chunking strategy and update descriptions
Documentation Updates
October 2024
New Documentation
API Reference Updates
Documentation Updates
Example Updates
September 2024
New Documentation
- #Add Chain Reranker content
API Reference Updates
Documentation Updates
Example Updates
- #Add more UDF examples
August 2024
New Documentation
- #Add User Defined Functions Reranker content
API Reference Updates
- #Update query order and labels
Documentation Updates
- #UpdatedUpdate introductions to topics in Getting Started and Capabilities
Example Updates
- #Improve grpc example for UDF
July 2024
New Documentation
API Reference Updates
- #Wrap tabs in API reference so they don't get clipped.
Documentation Updates
Example Updates
- #Update part.is_title field description
June 2024
New Documentation
- #Add new REST API v2 specifications to the documentation
API Reference Updates
Documentation Updates
Example Updates
- #Fix oauth examples.
May 2024
New Documentation
Documentation Updates
- #FixedFix query body request
- #ClarificationPoint ReactSearch to updated reranker
- #UpdatedUpdate citation section
- #FixedFix reranking link
- #UpdatedAdd examples for functions and operations
- #UpdatedAdd summarized search
- #UpdatedUpdate Information Architecture with new sections for Capabilities and Use Cases
April 2024
New Documentation
API Reference Updates
Example Updates
- #Add context configuration to Query and Highlighting topics
March 2024
New Documentation
API Reference Updates
Documentation Updates
Example Updates
February 2024
New Documentation
API Reference Updates
Documentation Updates
- #UpdatedUpdate console and corpus content around account and corpus creation
January 2024
New Documentation
API Reference Updates
Documentation Updates
Example Updates
- #Update List Documents response example
December 2023
New Documentation
Documentation Updates
- #FixedFix Q&A redirect
- #Indexing documentation is out of date.
- #ChangedMigrate from data store term to corpus.
- #UpdatedAdd API Keys topics to API Reference
- #UpdatedAdd MMR to the Reranking topic
- #UpdatedAdd content about Data Ingestion
- #UpdatedAdd content about the Index Request Headers
- #UpdatedUpdated content about the English and MMR rerankers
Example Updates
- #Improve Information Architecture and update several examples
Docs Platform Updates
November 2023
New Documentation
- #Add update filter attributes and list jobs to the OpenAPI spec
Documentation Updates
Example Updates
- #Update Code Samples with specific category for Query Operations