Skip to content

Commit

Permalink
Adds missing documentation. Added changelog
Browse files Browse the repository at this point in the history
Signed-off-by: uri.nudelman <uriel.nudelman@offerup.com>
  • Loading branch information
uriofferup committed Aug 13, 2024
1 parent 4f2b98d commit 31309c8
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 28 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ This section is for maintaining a changelog for all breaking changes for the cli
## [Unreleased 2.x]

### Added
- Adds `queryImage` (query_image) field to `NeuralQuery`, following definition in ([Neural Query](https://opensearch.org/docs/latest/query-dsl/specialized/neural/)) ([#1137](https://github.com/opensearch-project/opensearch-java/pull/1138))

### Dependencies

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,8 @@ public final String field() {
}

/**
* Required - Search query text.
* Required - The query_text if query_image is not set.
* Optional - The query_text if query_image is set.
*
* @return Search query text.
*/
Expand All @@ -79,7 +80,8 @@ public final String queryText() {
}

/**
* Required - Search query image.
* Required - The query_image if query_text is not set.
* Optional - The query_image if query_text is set.
*
* @return Search query image.
*/
Expand Down Expand Up @@ -178,7 +180,8 @@ public NeuralQuery.Builder field(@Nullable String field) {
}

/**
* Required - Search query text.
* Required - The query_text if query_image is not set.
* Optional - The query_text if query_image is set.
*
* @param queryText Search query text.
* @return This builder.
Expand All @@ -189,7 +192,8 @@ public NeuralQuery.Builder queryText(@Nullable String queryText) {
}

/**
* Required - Search query image.
* Required - The query_image if query_text is not set.
* Optional - The query_image if query_text is set.
*
* @param queryImage Search query image.
* @return This builder.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,30 +6,6 @@
* compatible open source license.
*/

/*
* Licensed to Elasticsearch B.V. under one or more contributor
* license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright
* ownership. Elasticsearch B.V. licenses this file to you under
* the Apache License, Version 2.0 (the "License"); you may
* not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/

/*
* Modifications Copyright OpenSearch Contributors. See
* GitHub history for details.
*/

package org.opensearch.client.util;

import java.util.StringJoiner;
Expand Down

0 comments on commit 31309c8

Please sign in to comment.