Skip to content

Latest commit

 

History

History
518 lines (361 loc) · 14.3 KB

DocCHANGELOG.md

File metadata and controls

518 lines (361 loc) · 14.3 KB
id slug title sidebar_label
changelog
/changelog
Vectara Documentation Changelog
Documentation Changelog

import { Config } from "./definitions.md"; import { Grid } from "@site/ui/Grid"; import { Spacer } from "@site/ui/Spacer"; import { TopicButton } from "@site/ui/TopicButton";

January 2025

✨ New Features

  • Update HHEM documentation for HHME-2.2 (#379)
  • Add documentation for the new Knee Reranking feature (#378)
  • Add new HHEM supported languages and some content enhancements (#352)

📚 API Changes

  • No changes

📝 Documentation or Feature Enhancements

  • Add a dedicated changelog for documentation updates, API enhancements and bug fixes (#383)
  • Add HHEM 2.2 enhancements to Release Notes (#381)
  • Add new HHEM supported languages and some content enhancements (#352)

📐 Information Architecture Changes

  • Add a dedicated changelog for documentation updates, API enhancements and bug fixes (#383)

🐛 Documentation Fixes

  • Add documentation changelog workflow (#385)
  • Fix OAuth2 URL and update screenshot (#384)

🗑 Deprecated

  • No changes

📋 Example Updates

  • No changes

🛠 Documentation Platform Updates

  • Update Doc Changelog workflow action (#386)

December 2024

✨ New Features

  • Add documentation for the new Update and Replace Metadata API Definitions (#371)
  • Add documentation for the querying table data feature (#365)
  • Add query observability feature to docs (#362)
  • Add documentation for new chunking strategy parameter (#361)

📚 API Changes

  • Add documentation for the new Update and Replace Metadata API Definitions (#371)
  • Add API Reference updates for the new tabular data extraction feature (#366)
  • Add documentation for the querying table data feature (#365)
  • Add query observability feature to docs (#362)

📝 Documentation or Feature Enhancements

  • Improve information architecture of the Capabilities section and metadata content (#374)
  • Update table extract details (#370)
  • Add documentation for the querying table data feature (#365)
  • Add documentation for new chunking strategy parameter (#361)

📐 Information Architecture Changes

  • Improve information architecture of the Capabilities section and metadata content (#374)

🐛 Documentation Fixes

  • Update table_extraction_config parameter (#369)
  • Fix link to the table data blog in release notes (#368)
  • fixed to traditional if statement (#367)

🗑 Deprecated

  • Add API v1 deprecation notices (#375)

📋 Example Updates

  • No changes

🛠 Documentation Platform Updates

  • No changes

November 2024

✨ New Features

  • Add chunking strategy and update descriptions (#351)

📚 API Changes

  • Add chunking strategy and update descriptions (#351)

📝 Documentation or Feature Enhancements

  • Update how metadata structuring is handled in API v2 (#358)
  • Update descriptions for Pro and Enterprise (#356)
  • Enhance the list of Vectara demos and applications (#354)

📐 Information Architecture Changes

  • Move Reranking subsection (#353)

🐛 Documentation Fixes

  • update fern.config.json and generators.yml to use latest version. (#355)
  • Add chunking strategy and update descriptions (#351)

🗑 Deprecated

  • No changes

📋 Example Updates

  • No changes

🛠 Documentation Platform Updates

  • No changes

October 2024

✨ New Features

  • Reflect product transition to free trial across documentation (#350)
  • Add new Integrations section that highlights community collaborations and partnerships (#346)

📚 API Changes

  • Reflect product transition to free trial across documentation (#350)
  • updated introduction with proper links (#338)
  • Get number of documents and document parts (#332)
  • Add search cutoffs, null handing, and refresh API reference (#331)

📝 Documentation or Feature Enhancements

  • Reflect product transition to free trial across documentation (#350)
  • Update docs for handling filenames with non-ASCII characters in API v2 (#345)
  • Upgrade OpenAPI docs theme. (#340)
  • Get number of documents and document parts (#332)
  • Add search cutoffs, null handing, and refresh API reference (#331)
  • Update Chain Reranker topic about the array and examples (#330)

📐 Information Architecture Changes

  • Add new Integrations section that highlights community collaborations and partnerships (#346)
  • Add Release Notes to the docs (#344)
  • Add Video Tutorials section. (#334)

🐛 Documentation Fixes

  • Incorrect syntax in the null score usage chain example (#349)
  • Correct udf page misspelling. (#348)

🗑 Deprecated

  • No changes

📋 Example Updates

  • Incorrect syntax in the null score usage chain example (#349)
  • ✨ Add query snippet example (#342)
  • Update Chain Reranker topic about the array and examples (#330)

🛠 Documentation Platform Updates

  • No changes

September 2024

✨ New Features

  • Add Chain Reranker content (#320)

📚 API Changes

  • Add request timeouts in docs (#326)
  • Update corpus API documentation (#324)
  • Add Chain Reranker content (#320)
  • Add Generation Presets content to docs (#318)

📝 Documentation or Feature Enhancements

  • Update corpus API documentation (#324)
  • Add more UDF examples (#323)
  • Update Quick Start (#322)
  • Add name and description to Update Corpus (#319)
  • Add Generation Presets content to docs (#318)
  • Update metadata filter topics (#312)
  • Update prompt syntax (#283)
  • Update custom prompt topics with Query endpoint details and links (#276)

📐 Information Architecture Changes

  • No changes

🐛 Documentation Fixes

  • No changes

🗑 Deprecated

  • No changes

📋 Example Updates

  • Add more UDF examples (#323)

🛠 Documentation Platform Updates

  • No changes

August 2024

✨ New Features

  • Add User Defined Functions Reranker content (#314)

📚 API Changes

  • Update query order and labels (#310)

📝 Documentation or Feature Enhancements

  • Update introductions to topics in Getting Started and Capabilities (#313)
  • Update query order and labels (#310)

📐 Information Architecture Changes

  • Add User Defined Functions Reranker content (#314)

🐛 Documentation Fixes

  • Improve grpc example for UDF (#317)

🗑 Deprecated

  • No changes

📋 Example Updates

  • Improve grpc example for UDF (#317)

🛠 Documentation Platform Updates

  • No changes

July 2024

✨ New Features

  • Add and update topics for Mockingbird (#308)
  • Add GPT 4o to list of summarizers (#303)

📚 API Changes

  • Wrap tabs in API reference so they don't get clipped. (#301)

📝 Documentation or Feature Enhancements

  • Add note about original BM25 (#309)
  • Update corpus key and file upload content (#306)
  • Fix typos and update screenshots (#299)
  • Update part.is_title field description (#216)

📐 Information Architecture Changes

  • No changes

🐛 Documentation Fixes

  • Wrap tabs in API reference so they don't get clipped. (#301)
  • Fix typos and update screenshots (#299)

🗑 Deprecated

  • No changes

📋 Example Updates

  • Update part.is_title field description (#216)

🛠 Documentation Platform Updates

  • No changes

June 2024

✨ New Features

  • Add new REST API v2 specifications to the documentation (#250)

📚 API Changes

  • Rename API Playground references to API Reference. (#295)
  • Update API v2 migration guide (#294)
  • Put generation_end into the reference. (#291)
  • Re-enable accordion transition in API playground, to fix bug in which content height wasn't updated correctly (#287)

📝 Documentation or Feature Enhancements

  • Add new REST API v2 specifications to the documentation (#250)

📐 Information Architecture Changes

  • Rename API Playground references to API Reference. (#295)
  • Change nav from API Playground -> API Reference. (#293)
  • Add new REST API v2 specifications to the documentation (#250)

🐛 Documentation Fixes

  • Fix oauth examples. (#300)
  • Update API v2 download URL (#298)
  • Fix typos in spec. (#296)
  • Change nav from API Playground -> API Reference. (#293)
  • Fix tips in query endpoint (#288)
  • Re-enable accordion transition in API playground, to fix bug in which content height wasn't updated correctly (#287)
  • Fix link to Reranking blog (#286)

🗑 Deprecated

  • No changes

📋 Example Updates

  • Fix oauth examples. (#300)

🛠 Documentation Platform Updates

  • No changes

May 2024

✨ New Features

  • Update Reranker topic with the new Vectara Multilingual Reranker v1 (#281)
  • Add citation summary feature content (#277)

📚 API Changes

  • No changes

📝 Documentation or Feature Enhancements

  • Point ReactSearch to updated reranker (#280)
  • Update citation section (#279)
  • Add examples for functions and operations (#275)
  • Add summarized search (#274)

📐 Information Architecture Changes

  • Update Information Architecture with new sections for Capabilities and Use Cases (#259)

🐛 Documentation Fixes

  • Fix query body request (#285)
  • Fix reranking link (#278)
  • Add summarized search (#274)

🗑 Deprecated

  • No changes

📋 Example Updates

  • No changes

🛠 Documentation Platform Updates

  • No changes

April 2024

✨ New Features

  • Add docs for stream concatenation, React-Chatbot, and Stream-Query-Client (#260)
  • Add Stream Query to the API Playground (#257)
  • Add new Stream Query API Definition content (#256)

📚 API Changes

  • Improve List Conversations API parameter descriptions (#266)
  • Improve prompt examples in query, and update the enable api key and file upload endpoints (#265)
  • Update prompts to use single-quote in examples (#264)
  • Update Create Corpus default example (#262)
  • Fix values in the query body endpoint (#258)
  • Add Stream Query to the API Playground (#257)

📝 Documentation or Feature Enhancements

  • Add context configuration to Query and Highlighting topics (#261)

📐 Information Architecture Changes

  • No changes

🐛 Documentation Fixes

  • Improve List Conversations API parameter descriptions (#266)
  • Improve prompt examples in query, and update the enable api key and file upload endpoints (#265)
  • Fix values in the query body endpoint (#258)

🗑 Deprecated

  • No changes

📋 Example Updates

  • Improve prompt examples in query, and update the enable api key and file upload endpoints (#265)
  • Update prompts to use single-quote in examples (#264)
  • Update Create Corpus default example (#262)
  • Add context configuration to Query and Highlighting topics (#261)
  • Fix values in the query body endpoint (#258)

🛠 Documentation Platform Updates

  • No changes

March 2024

✨ New Features

  • Update the API Playground with Factual Consistency Score (#254)
  • Add content about the new Factual Consistency Score (#252)

📚 API Changes

  • Update Playground example for FCS (#255)
  • Update the API Playground with Factual Consistency Score (#254)
  • Update API References examples for Query, Indexing, and API Keys (#251)
  • Update Query example in API Playground (#247)
  • Update API Reference examples for consistency (#240)

📝 Documentation or Feature Enhancements

  • Update file formats and document structuring (#253)
  • Update API Reference examples for consistency (#240)
  • Update Chat APIs overview (#237)
  • Update API Reference section with improved structure and flow (#231)
  • Add Content-Disposition header to set the Document ID (#214)

📐 Information Architecture Changes

  • Update API Reference section with improved structure and flow (#231)

🐛 Documentation Fixes

  • No changes

🗑 Deprecated

  • No changes

📋 Example Updates

  • Update Playground example for FCS (#255)
  • Update file formats and document structuring (#253)
  • Add content about the new Factual Consistency Score (#252)
  • Update API References examples for Query, Indexing, and API Keys (#251)
  • Update Query example in API Playground (#247)
  • Update API Reference examples for consistency (#240)
  • Add Content-Disposition header to set the Document ID (#214)

🛠 Documentation Platform Updates

  • No changes

February 2024

✨ New Features

  • Add Generative Prompts section (#238)
  • Add documentation for the new Vectara Chat (#235)
  • Add documentation for the Personal API Key, Index, and Query Keys (#233)

📚 API Changes

  • Add custom prompts to Query (#239)
  • Update the API Playground for Chat APIs (#236)
  • Add documentation for the new Vectara Chat (#235)
  • Update API Playground for the Personal API Keys (#234)

📝 Documentation or Feature Enhancements

  • Update the API Playground for Chat APIs (#236)
  • Add documentation for the Personal API Key, Index, and Query Keys (#233)
  • Update console and corpus content around account and corpus creation (#224)

📐 Information Architecture Changes

  • Add Generative Prompts section (#238)

🐛 Documentation Fixes

  • No changes

🗑 Deprecated

  • No changes

📋 Example Updates

  • Add custom prompts to Query (#239)
  • Add documentation for the new Vectara Chat (#235)

🛠 Documentation Platform Updates

  • No changes

January 2024

✨ New Features

  • Add Create-UI and refine copy and layout of Build Apps landing page (#230)
  • Add Get Usage Metrics to API Playground (#226)
  • Add List Documents content to Console and API Reference (#218)
  • Add Account and Corpus Management APIs to Playground (#217)
  • Add Read Corpus and Update Corpus Enablement topics (#211)

📚 API Changes

  • Add Get Usage Metrics to API Playground (#226)
  • Update File Upload API specs (#220)
  • Add List Documents to API Playground (#219)
  • Add List Documents content to Console and API Reference (#218)
  • Add Account and Corpus Management APIs to Playground (#217)
  • Add Read Corpus and Update Corpus Enablement topics (#211)

📝 Documentation or Feature Enhancements

  • Add Build Applications section (#229)
  • Update File Upload API specs (#220)
  • Fix reranker URL and update search topic with new formatting (#213)

📐 Information Architecture Changes

  • Add Create-UI and refine copy and layout of Build Apps landing page (#230)
  • Add Build Applications section (#229)

🐛 Documentation Fixes

  • Update File Upload API specs (#220)
  • Fix reranker URL and update search topic with new formatting (#213)
  • Improve the Index API Definition content (#208)

🗑 Deprecated

  • No changes

📋 Example Updates

  • Update List Documents response example (#221)
  • Add Read Corpus and Update Corpus Enablement topics (#211)

🛠 Documentation Platform Updates

  • No changes