Better default API version

Created on 10 August 2024, 5 months ago
Updated 22 August 2024, 5 months ago

Problem/Motivation

The default Azure API version when creating a new index is '2020-06-30-Preview'.
With this indexing fails for me with:
- The request is invalid. Details: The parameter 'captions' in the request payload is not a valid parameter for the operation 'search'.

Version 2023-11-01 fails with:
The request is invalid. Details: The parameter 'featuresMode' in the request payload is not a valid parameter for the operation 'search'.

Cause

The captions parameter was not introduced until 2021-04-30-preview

The featuresMode parameter is not available in stable, only preview.

Proposed resolution

Suggest a more recent preview version as the default.

Additionally, on the index configuration page, in the description of the "Search captions" option document that it requires at least 2021-04-30-preview.

Remaining tasks

User interface changes

API changes

Data model changes

📌 Task
Status

Active

Version

1.0

Component

Code

Created by

🇬🇧United Kingdom jonathanshaw Stroud, UK

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Comments & Activities

  • Issue created by @jonathanshaw
  • 🇬🇧United Kingdom jonathanshaw Stroud, UK
  • 🇧🇪Belgium vodde83

    We definitely don't want people to get stuck using pretty much a somewhat default configuration, so you've raised some valid points.

    I'm not exactly sure yet what the best default API-version should be, so I'll have to look into that. I think if all the issues you raised are addressed, changing the default might not be needed anymore.

    I'll likely disable the 'Search captions' altogether if the API-version doesn't support it though, in addition to an updated description. This makes the whole thing somewhat more bulletproof.

  • 🇧🇪Belgium interx Flanders

    Hello Jonathan,

    This has been addressed in the dev branch of the module. When an older API version has been chosen, the semantic options have been disabled.

    This is testable in de the dev branch and will be inlcuded in the upcoming release.

  • Automatically closed - issue fixed for 2 weeks with no activity.

Production build 0.71.5 2024