Conversation
This release finalizes a breaking constructor naming migration and synchronizes code, tests, and documentation around the new query-first API shape. API and naming changes: - Rename endpoint constructors to query_<endpoint> for improved discoverability: - search_query() -> query_search() - enrich_web_query() -> query_enrich_web() - enrich_news_query() -> query_enrich_news() - summarize_query() -> query_summarize() - fastgpt_query() -> query_fastgpt() - Remove legacy constructor exports (hard break; no compatibility wrappers). - Keep non-constructor public APIs stable: - kagi_connection() - kagi_request() - kagi_request_parquet() Request/dispatch and classes: - Migrate request validation/dispatch to the kagi_query_* class family. - Keep endpoint routing behavior unchanged for search/enrich/summarize/fastgpt execution. Parquet and abstract augmentation: - Add endpoint-prefixed deterministic IDs in parquet conversion: - SEARCH_, ENRICH_WEB_, ENRICH_NEWS_, SUMMARIZE_, FASTGPT_ - Add add_abstract argument to kagi_request_parquet() to trigger abstract augmentation for supported endpoints. - Keep warning behavior for unsupported endpoints when add_abstract = TRUE. Bridge/helper and docs generation: - Add add_sbstract_to_parquet() helper and corresponding Rd. - Regenerate docs/NAMESPACE/man pages for renamed constructors and new helper. Tests and fixtures: - Update test suite to new constructor names/classes. - Extend tests for endpoint-prefixed IDs and add_abstract behavior. - Refresh vcr cassettes to align with current request paths and names. Documentation and project guidance: - Update README, all endpoint vignettes, quickstart, pkgdown config, and skills content to new constructor naming. - Update PROJECT_DESIGN.md and NEWS.md for v0.4.0 release narrative and explicit breaking-change mapping. - Bump package version to 0.4.0 in DESCRIPTION. - Add zenodo.csl for citation workflow support.
…nc docs/skills Core refactor (hard break): - Remove legacy add_sbstract_to_parquet() API and delete R/add_sbstract_to_parquet.R - Make kagi_request_parquet() JSON->parquet only; remove abstract-augmentation arguments/branches - Add modular corpus pipeline functions: - download_content() - content_markdown() - markdown_abstract() - summarize_with_openai() / summarize_with_kagi() - read_corpus(..., abstracts = TRUE) with id+query linking - Add supporting internals and IO utilities: - content_pipeline_jobs - parquet_io_utils - summarize_text_records - clean_request() and kagi_update_query() integration updates - Keep per-query metadata model and query-partition refresh behavior Workflow/documentation updates: - Add new end-to-end vignette: vignettes/corpus-workflow.qmd - Update quickstart and summarize endpoint vignette for current workflow - Update README for project-folder workflow + modular corpus enrichment - Update NEWS.md and PROJECT_DESIGN.md to reflect current architecture and breaking changes Skills expansion and alignment: - Add user-corpus-workflow skill with references/examples - Add maintainer-corpus-pipeline skill (contracts + testing) - Add maintainer-release-sync skill (release consistency checklist) - Update inst/skills/README.md and maintainer workflow routing Generated artifacts/tests: - Regenerate NAMESPACE/man pages for new/removed APIs - Remove obsolete man/add_sbstract_to_parquet.Rd - Update tests for removed legacy flow and new corpus pipeline behavior
Quality and documentation cleanup:
- Fix NOTE 'no visible global function definition for setNames' by using stats::setNames in kagi_update_query().
- Fix NOTE 'no visible binding for global variable id/query/abstract' in read_corpus() by switching to rlang::.data pronoun in dplyr verbs.
- Add roxygen import for rlang::.data and regenerate NAMESPACE accordingly.
- Add missing retry_max_tries documentation for summarize_with_openai() and summarize_with_kagi().
- Shorten summarize_with_openai() default system_prompt string to eliminate Rd usage line-width NOTE.
- Regenerate Rd pages for summarizer providers and refresh generated docs.
Dependency/metadata alignment:
- Add rlang to DESCRIPTION Imports to satisfy new namespace import requirements.
- Keep runtime behavior unchanged except for documentation/default prompt text normalization.
Validation performed:
- Ran devtools::document().
- Ran devtools::check(document = FALSE, run_dont_test = FALSE, error_on = "never").
- Confirmed requested notes are resolved:
- R code possible problems: OK
- Rd line widths: OK
- Remaining NOTE is environment-related only ('unable to verify current time').
Behavior/config updates: - Add corpus-workflow vignette to _pkgdown.yml articles index to resolve pkgdown build error (missing vignette in index). Skills/process updates: - Update maintainer-workflow skill to require pre-commit review/sync of NEWS.md, PROJECT_DESIGN.md, README.md, and relevant vignettes for behavior changes. - Update maintainer-release-sync skill with explicit pre-commit/merge sync checks for the same documentation set. - Add explicit detailed commit-message requirement in maintainer skills (behavior changes, docs/skills sync, validation outcomes). Validation context: - pkgdown articles build now includes corpus-workflow and completes without missing-index vignette error.
rkrug
changed the title
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
v0.4.0 Release PR
This PR consolidates the
kagiProv0.4.0 release scope and is ready for merge.Summary
kagiPromoved from endpoint-constructor migration into a full corpus-oriented workflow release:query_<endpoint>)kagi_fetch()Key Changes
API + workflow
query_search(),query_enrich_web(),query_enrich_news(),query_summarize(),query_fastgpt()kagi_fetch()kagi_update_query()clean_request()kagi_request_parquet()is now JSON -> parquet only (no inline abstract augmentation)Corpus pipeline (new canonical path)
download_content()content_markdown()markdown_abstract()summarize_with_openai()summarize_with_kagi()read_corpus(..., abstracts = TRUE)forid + queryabstract linkingDocumentation + site + skills
vignettes/corpus-workflow.qmdNEWS.mdandPROJECT_DESIGN.mdto current architectureuser-corpus-workflowmaintainer-corpus-pipelinemaintainer-release-synccorpus-workflowQuality fixes after check feedback
stats::setNamesinkagi_update_query().datapronoun usage inread_corpus()rlangimport alignment in DESCRIPTION/NAMESPACEretry_max_triesin both summarizer providersBreaking Changes (explicit)
add_sbstract_to_parquet()kagi_request_parquet()Validation
devtools::document()regenerated docs/NAMESPACEdevtools::check(document = FALSE, run_dont_test = FALSE, error_on = "never")Recent commits included
22dd663release: v0.4.0 constructor rename + docs/testing alignmente811159refactor corpus pipeline + remove legacy abstract API70a6355fix check notes (namespace/Rd)3d2ebc2fix pkgdown index + strengthen maintainer skill gates