Skip to content

feat: suggest dataservice description - #924

Open
bolinocroustibat wants to merge 18 commits into
mainfrom
feat/suggest-dataservice-description
Open

feat: suggest dataservice description#924
bolinocroustibat wants to merge 18 commits into
mainfrom
feat/suggest-dataservice-description

Conversation

@bolinocroustibat

@bolinocroustibat bolinocroustibat commented Feb 5, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Add AI-powered description suggestion for dataservices (external APIs) via the Albert API.

When editing a dataservice, a "Suggérer une description" button generates a French description. The button is enabled only when:

  • title is filled
  • at least one of these is filled: technical documentation URL or machine documentation URL (OpenAPI/Swagger)

Changes:

  • DescribeDataservice.vue: suggestion button with loading/disabled states and tooltip; enabled when title + at least one doc URL are present
  • generate-dataservice-description.post.ts (new): Nitro endpoint that fetches documentation from the given URLs, inlines it into the prompt, and calls Albert API. Requires title and at least one of technicalDocumentationUrl or machineDocumentationUrl
  • fetch-documentation.ts (new): utility to fetch doc content from URLs (HTML stripped, JSON/YAML as-is; 15s timeout, 120k char cap)

EDIT (2026-02-17):

  • generate-dataservice-description.post.ts uses shared callAlbertAPI (albert-helpers), same pattern as other Albert endpoints.
  • Doc content is now fetched from the URLs and inlined into the prompt (new fetch-documentation.ts: HTML stripped, JSON/YAML as-is, 15s timeout, 120k char cap). Previously only the URLs were sent.
  • Fixed 422 "description too short" being rethrown as 500.
  • Removed redundant validateAlbertConfig from helper and all Albert endpoints.

@bolinocroustibat bolinocroustibat self-assigned this Feb 5, 2026
@bolinocroustibat
bolinocroustibat marked this pull request as draft February 5, 2026 16:30
@bolinocroustibat
bolinocroustibat force-pushed the feat/suggest-dataservice-description branch 2 times, most recently from 550dbdb to df4c507 Compare February 16, 2026 16:48
@bolinocroustibat
bolinocroustibat marked this pull request as ready for review February 16, 2026 16:49
ThibaudDauce
ThibaudDauce requested changes Feb 17, 2026
View reviewed changes
Comment thread server/routes/nuxt-api/albert/generate-dataservice-description.post.ts Outdated
Comment thread components/Dataservices/DescribeDataservice.vue Outdated
Comment thread server/routes/nuxt-api/albert/generate-dataservice-description.post.ts Outdated
Comment thread components/MarkdownEditor/InternalEditor.vue Outdated
Comment thread server/routes/nuxt-api/albert/generate-dataservice-description.post.ts Outdated
Comment thread server/routes/nuxt-api/albert/generate-dataservice-description.post.ts Outdated
@bolinocroustibat
bolinocroustibat force-pushed the feat/suggest-dataservice-description branch from 7c4bf25 to 3c20ce2 Compare February 17, 2026 12:51
@bolinocroustibat bolinocroustibat moved this from 🛠 Doing to 👀 Review in 🚀 Produit data.gouv.fr Feb 17, 2026
@bolinocroustibat
bolinocroustibat force-pushed the feat/suggest-dataservice-description branch 3 times, most recently from 494af3c to ba1f4fa Compare February 17, 2026 19:53
ThibaudDauce
ThibaudDauce requested changes Feb 18, 2026
View reviewed changes
Comment thread server/routes/nuxt-api/albert/utils/fetch-documentation.ts Outdated
Comment thread server/routes/nuxt-api/albert/utils/fetch-documentation.ts
Comment thread server/routes/nuxt-api/albert/utils/fetch-documentation.ts Outdated
Comment thread components/Dataservices/DescribeDataservice.vue
@bolinocroustibat
bolinocroustibat force-pushed the feat/suggest-dataservice-description branch from ba1f4fa to d99abad Compare February 23, 2026 14:17
bolinocroustibat and others added 7 commits April 14, 2026 22:18
@bolinocroustibat
feat: suggest dataservice description
e8e386a
@bolinocroustibat
docs: add help text
f4c512e
@bolinocroustibat @cursoragent
refactor(markdown-editor): remove unnecessary ref import
5ec0ff7 
Remove explicit ref import as it's auto-imported by Nuxt

Co-authored-by: Cursor <cursoragent@cursor.com>
@bolinocroustibat @cursoragent
refactor(albert): use shared helpers and remove duplicate config check
4066749 
- Use callAlbertAPI from albert-helpers in generate-dataservice-description
  (align with other Albert endpoints)
- Fix 422 for 'description too short' so it is returned to client instead of 500
- Remove validateAlbertConfig; useAlbertConfig() already throws when API key
  is missing
- Drop redundant error logging in dataservice-description handler

Co-authored-by: Cursor <cursoragent@cursor.com>
@bolinocroustibat @cursoragent
refactor(config): rename generateShortDescriptionFeedbackUrl to gener…
93c5c19 
…ateDescriptionFeedbackUrl

Co-authored-by: Cursor <cursoragent@cursor.com>
@bolinocroustibat
feat: fetch documentation URLs to build prompt to suggest description
92d279c
@bolinocroustibat
docs: add comments
86cfec4
@bolinocroustibat
bolinocroustibat force-pushed the feat/suggest-dataservice-description branch from d99abad to 86cfec4 Compare April 14, 2026 20:19
@bolinocroustibat
bolinocroustibat force-pushed the feat/suggest-dataservice-description branch from 98d8896 to f02323a Compare April 14, 2026 20:55
@bolinocroustibat
bolinocroustibat force-pushed the feat/suggest-dataservice-description branch from f02323a to 4ca3fb9 Compare April 14, 2026 20:57
ThibaudDauce
ThibaudDauce approved these changes Apr 22, 2026
View reviewed changes

@ThibaudDauce ThibaudDauce left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! Really sorry for the delay :-(

Comment thread server/routes/nuxt-api/albert/generate-dataservice-description.post.ts Outdated
@bolinocroustibat

bolinocroustibat commented May 6, 2026

Copy link
Copy Markdown
Contributor Author

Let's not merge that yet, I would first like to:

  • change the order of the form fields - URLS fields must be before description fields
  • see why we sometimes have foreign language words in the generated description

Samuelfaure
Samuelfaure reviewed Jun 15, 2026
View reviewed changes

@Samuelfaure Samuelfaure left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@Samuelfaure Samuelfaure Samuelfaure left review comments
@ThibaudDauce ThibaudDauce ThibaudDauce approved these changes
@maudetes maudetes Awaiting requested review from maudetes
@nicolaskempf57 nicolaskempf57 Awaiting requested review from nicolaskempf57

Assignees

@bolinocroustibat bolinocroustibat

Labels

None yet

Projects

🚀 Produit data.gouv.fr
Status: 👀 Review

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@bolinocroustibat @ThibaudDauce @Samuelfaure