Add enterprise license check to inference action for semantic text fields #122293

dan-rubinstein · 2025-02-11T19:37:27Z

Description

The inference API feature is only available to those with at least an enterprise level license. As of 8.18/9.0 we are enforcing this license requirement on all direct interactions with the inference API but we did not add a block for semantic text related inference usage. This change adds a block to the semantic text field inference action so that users are unable to ingest documents into a semantic text field if they do not have the correct license. The cases that we need to block against are:

A user has never had an enterprise license and attempts to use a semantic text field and attempts to create an index with one that utilizes the default inference endpoints. (Note: The user can not use non-default endpoints as creating endpoints will be blocked for them).
A user previously had an enterprise license and created semantic text fields using default or non-default inference endpoints, but their license has since expired.

Testing

Unit tests
Ran ES locally with a trial license and confirmed that text fields are still usable both with default and non-default inference endpoints..
Ran ES locally with a basic license and confirmed that the exception is thrown when ingesting a document into a semantic text field linked to a default inference endpoint.

…elds

elasticsearchmachine · 2025-02-11T19:37:53Z

Hi @dan-rubinstein, I've created a changelog YAML for you.

elasticsearchmachine · 2025-02-11T21:43:14Z

Pinging @elastic/ml-core (Team:ML)

jimczi

Thanks for tackling this @dan-rubinstein . Can we add a rest test that checks that we fail the bulk request entirely if the license is not compliant?

...ain/java/org/elasticsearch/xpack/inference/action/filter/ShardBulkInferenceActionFilter.java

…ference call

...ain/java/org/elasticsearch/xpack/inference/action/filter/ShardBulkInferenceActionFilter.java

...lasticsearch/xpack/inference/action/filter/ShardBulkInferenceActionFilterBasicLicenseIT.java

...ava/org/elasticsearch/xpack/inference/action/filter/ShardBulkInferenceActionFilterTests.java

...ain/java/org/elasticsearch/xpack/inference/action/filter/ShardBulkInferenceActionFilter.java

...lasticsearch/xpack/inference/action/filter/ShardBulkInferenceActionFilterBasicLicenseIT.java

…ionFilterBasicLicenseIT

Mikep86 · 2025-02-18T16:29:41Z

@elasticmachine merge upstream

Mikep86

LGTM, thanks for the iterations and sorry for the delay in the follow-up review!

prwhelan · 2025-02-20T17:18:44Z

...ava/org/elasticsearch/xpack/inference/action/filter/ShardBulkInferenceActionFilterTests.java

+                assertThat(failure.getCause(), instanceOf(ElasticsearchSecurityException.class));
+                assertThat(
+                    failure.getMessage(),
+                    containsString(org.elasticsearch.core.Strings.format("current license is non-compliant for [%s]", XPackField.INFERENCE))


Weird, why didn't IntelliJ want to use the already-imported org.elasticsearch.common.Strings?

dan-rubinstein · 2025-02-20T17:35:07Z

@elasticmachine merge upstream

…elds (elastic#122293) * Add enterprise license check to inference action for semantic text fields * Update docs/changelog/122293.yaml * Set license to trial in ShardBulkInferenceActionFilterIT * Move license check to only block semantic_text fields that require inference call * Cleaning up tests * Add parameterization on useLegacyFormat back in ShardBulkInferenceActionFilterBasicLicenseIT --------- Co-authored-by: Elastic Machine <[email protected]>

elasticsearchmachine · 2025-02-20T19:08:33Z

💚 Backport successful

Status	Branch	Result
✅	9.0
✅	8.18
✅	8.x

…elds (elastic#122293) * Add enterprise license check to inference action for semantic text fields * Update docs/changelog/122293.yaml * Set license to trial in ShardBulkInferenceActionFilterIT * Move license check to only block semantic_text fields that require inference call * Cleaning up tests * Add parameterization on useLegacyFormat back in ShardBulkInferenceActionFilterBasicLicenseIT --------- Co-authored-by: Elastic Machine <[email protected]>

…elds (#122293) (#123065) * Add enterprise license check to inference action for semantic text fields * Update docs/changelog/122293.yaml * Set license to trial in ShardBulkInferenceActionFilterIT * Move license check to only block semantic_text fields that require inference call * Cleaning up tests * Add parameterization on useLegacyFormat back in ShardBulkInferenceActionFilterBasicLicenseIT --------- Co-authored-by: Elastic Machine <[email protected]>

…elds (#122293) (#123066) * Add enterprise license check to inference action for semantic text fields * Update docs/changelog/122293.yaml * Set license to trial in ShardBulkInferenceActionFilterIT * Move license check to only block semantic_text fields that require inference call * Cleaning up tests * Add parameterization on useLegacyFormat back in ShardBulkInferenceActionFilterBasicLicenseIT --------- Co-authored-by: Elastic Machine <[email protected]>

…elds (elastic#122293) * Add enterprise license check to inference action for semantic text fields * Update docs/changelog/122293.yaml * Set license to trial in ShardBulkInferenceActionFilterIT * Move license check to only block semantic_text fields that require inference call * Cleaning up tests * Add parameterization on useLegacyFormat back in ShardBulkInferenceActionFilterBasicLicenseIT --------- Co-authored-by: Elastic Machine <[email protected]>

…elds (#122293) (#123064) * Add enterprise license check to inference action for semantic text fields * Update docs/changelog/122293.yaml * Set license to trial in ShardBulkInferenceActionFilterIT * Move license check to only block semantic_text fields that require inference call * Cleaning up tests * Add parameterization on useLegacyFormat back in ShardBulkInferenceActionFilterBasicLicenseIT --------- Co-authored-by: Elastic Machine <[email protected]>

Add enterprise license check to inference action for semantic text fi…

31af555

…elds

dan-rubinstein added >bug :ml Machine learning Team:ML Meta label for the ML team v9.0.0 v8.18.0 v8.19.0 v9.1.0 labels Feb 11, 2025

Update docs/changelog/122293.yaml

b207231

Set license to trial in ShardBulkInferenceActionFilterIT

5ce7e42

dan-rubinstein marked this pull request as ready for review February 11, 2025 21:42

jimczi reviewed Feb 12, 2025

View reviewed changes

...ain/java/org/elasticsearch/xpack/inference/action/filter/ShardBulkInferenceActionFilter.java Outdated Show resolved Hide resolved

Move license check to only block semantic_text fields that require in…

7604667

…ference call

Mikep86 reviewed Feb 13, 2025

View reviewed changes

Cleaning up tests

af3f1e9

Mikep86 reviewed Feb 13, 2025

View reviewed changes

...ain/java/org/elasticsearch/xpack/inference/action/filter/ShardBulkInferenceActionFilter.java Show resolved Hide resolved

...lasticsearch/xpack/inference/action/filter/ShardBulkInferenceActionFilterBasicLicenseIT.java Outdated Show resolved Hide resolved

Add parameterization on useLegacyFormat back in ShardBulkInferenceAct…

0473574

…ionFilterBasicLicenseIT

Merge branch 'main' into semantic-text-license-check

2eda011

Mikep86 approved these changes Feb 19, 2025

View reviewed changes

prwhelan approved these changes Feb 20, 2025

View reviewed changes

Merge branch 'main' into semantic-text-license-check

e0e8c0c

dan-rubinstein added the auto-backport Automatically create backport pull requests when merged label Feb 20, 2025

dan-rubinstein merged commit 99897b1 into elastic:main Feb 20, 2025
17 checks passed

This was referenced Feb 20, 2025

[9.0] Add enterprise license check to inference action for semantic text fields (#122293) #123064

Merged

[8.18] Add enterprise license check to inference action for semantic text fields (#122293) #123065

Merged

dan-rubinstein mentioned this pull request Feb 20, 2025

[8.x] Add enterprise license check to inference action for semantic text fields (#122293) #123066

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add enterprise license check to inference action for semantic text fields #122293

Add enterprise license check to inference action for semantic text fields #122293

Uh oh!

dan-rubinstein commented Feb 11, 2025 •

edited by davidkyle

Loading

Uh oh!

elasticsearchmachine commented Feb 11, 2025

Uh oh!

elasticsearchmachine commented Feb 11, 2025

Uh oh!

jimczi left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Mikep86 commented Feb 18, 2025

Uh oh!

Mikep86 left a comment

Uh oh!

prwhelan Feb 20, 2025

Uh oh!

dan-rubinstein commented Feb 20, 2025

Uh oh!

Uh oh!

elasticsearchmachine commented Feb 20, 2025

Uh oh!

Uh oh!

Add enterprise license check to inference action for semantic text fields #122293

Add enterprise license check to inference action for semantic text fields #122293

Uh oh!

Conversation

dan-rubinstein commented Feb 11, 2025 • edited by davidkyle Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Testing

Uh oh!

elasticsearchmachine commented Feb 11, 2025

Uh oh!

elasticsearchmachine commented Feb 11, 2025

Uh oh!

jimczi left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Mikep86 commented Feb 18, 2025

Uh oh!

Mikep86 left a comment

Choose a reason for hiding this comment

Uh oh!

prwhelan Feb 20, 2025

Choose a reason for hiding this comment

Uh oh!

dan-rubinstein commented Feb 20, 2025

Uh oh!

Uh oh!

elasticsearchmachine commented Feb 20, 2025

💚 Backport successful

Uh oh!

Uh oh!

dan-rubinstein commented Feb 11, 2025 •

edited by davidkyle

Loading