org.openapitools.db_data.client.model

Class QueryResponse

java.lang.Object

org.openapitools.db_data.client.model.QueryResponse

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2024-10-23T20:47:12.659110Z[Etc/UTC]")
public class QueryResponse
extends java.lang.Object

The response for the `query` operation. These are the matches found for a particular query vector. The matches are ordered from most similar to least similar.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	QueryResponse.CustomTypeAdapterFactory

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.HashSet<java.lang.String>	openapiFields
static java.util.HashSet<java.lang.String>	openapiRequiredFields
static java.lang.String	SERIALIZED_NAME_MATCHES
static java.lang.String	SERIALIZED_NAME_NAMESPACE
static java.lang.String	SERIALIZED_NAME_RESULTS
static java.lang.String	SERIALIZED_NAME_USAGE

Constructor Summary

Constructors

Constructor and Description
QueryResponse()

Method Summary

Modifier and Type	Method and Description
QueryResponse	addMatchesItem(ScoredVector matchesItem)
QueryResponse	addResultsItem(SingleQueryResults resultsItem)
boolean	equals(java.lang.Object o)
static QueryResponse	fromJson(java.lang.String jsonString) Create an instance of QueryResponse given an JSON string
java.util.Map<java.lang.String,java.lang.Object>	getAdditionalProperties() Return the additional (undeclared) property.
java.lang.Object	getAdditionalProperty(java.lang.String key) Return the additional (undeclared) property with the specified name.
java.util.List<ScoredVector>	getMatches() The matches for the vectors.
java.lang.String	getNamespace() The namespace for the vectors.
java.util.List<SingleQueryResults>	getResults() Deprecated.
Usage	getUsage() Get usage
int	hashCode()
QueryResponse	matches(java.util.List<ScoredVector> matches)
QueryResponse	namespace(java.lang.String namespace)
QueryResponse	putAdditionalProperty(java.lang.String key, java.lang.Object value) Set the additional (undeclared) property with the specified name and value.
QueryResponse	results(java.util.List<SingleQueryResults> results) Deprecated.
void	setMatches(java.util.List<ScoredVector> matches)
void	setNamespace(java.lang.String namespace)
void	setResults(java.util.List<SingleQueryResults> results) Deprecated.
void	setUsage(Usage usage)
java.lang.String	toJson() Convert an instance of QueryResponse to an JSON string
java.lang.String	toString()
QueryResponse	usage(Usage usage)
static void	validateJsonElement(com.google.gson.JsonElement jsonElement) Validates the JSON Element and throws an exception if issues found

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

SERIALIZED_NAME_RESULTS

public static final java.lang.String SERIALIZED_NAME_RESULTS

See Also:

Constant Field Values

SERIALIZED_NAME_MATCHES

public static final java.lang.String SERIALIZED_NAME_MATCHES

See Also:

Constant Field Values

SERIALIZED_NAME_NAMESPACE

public static final java.lang.String SERIALIZED_NAME_NAMESPACE

See Also:

Constant Field Values

SERIALIZED_NAME_USAGE

public static final java.lang.String SERIALIZED_NAME_USAGE

See Also:

Constant Field Values

openapiFields

public static java.util.HashSet<java.lang.String> openapiFields

openapiRequiredFields

public static java.util.HashSet<java.lang.String> openapiRequiredFields

Constructor Detail

QueryResponse

public QueryResponse()

Method Detail

results

@Deprecated
public QueryResponse results(java.util.List<SingleQueryResults> results)

Deprecated.

addResultsItem

public QueryResponse addResultsItem(SingleQueryResults resultsItem)

getResults

@Deprecated
 @Nullable
public java.util.List<SingleQueryResults> getResults()

Deprecated.

DEPRECATED. The results of each query. The order is the same as `QueryRequest.queries`.

Returns:

results

setResults

@Deprecated
public void setResults(java.util.List<SingleQueryResults> results)

Deprecated.

matches

public QueryResponse matches(java.util.List<ScoredVector> matches)

addMatchesItem

public QueryResponse addMatchesItem(ScoredVector matchesItem)

getMatches

@Nullable
public java.util.List<ScoredVector> getMatches()

The matches for the vectors.

Returns:

matches

setMatches

public void setMatches(java.util.List<ScoredVector> matches)

namespace

public QueryResponse namespace(java.lang.String namespace)

getNamespace

@Nullable
public java.lang.String getNamespace()

The namespace for the vectors.

Returns:

namespace

setNamespace

public void setNamespace(java.lang.String namespace)

usage

public QueryResponse usage(Usage usage)

getUsage

@Nullable
public Usage getUsage()

Get usage

Returns:

usage

setUsage

public void setUsage(Usage usage)

putAdditionalProperty

public QueryResponse putAdditionalProperty(java.lang.String key,
                                           java.lang.Object value)

Set the additional (undeclared) property with the specified name and value. If the property does not already exist, create it otherwise replace it.

Parameters:

key - name of the property

value - value of the property

Returns:

the QueryResponse instance itself

getAdditionalProperties

public java.util.Map<java.lang.String,java.lang.Object> getAdditionalProperties()

Return the additional (undeclared) property.

Returns:

a map of objects

getAdditionalProperty

public java.lang.Object getAdditionalProperty(java.lang.String key)

Return the additional (undeclared) property with the specified name.

Parameters:

key - name of the property

Returns:

an object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

validateJsonElement

public static void validateJsonElement(com.google.gson.JsonElement jsonElement)
                                throws java.io.IOException

Validates the JSON Element and throws an exception if issues found

Parameters:

jsonElement - JSON Element

Throws:

java.io.IOException - if the JSON Element is invalid with respect to QueryResponse

fromJson

public static QueryResponse fromJson(java.lang.String jsonString)
                              throws java.io.IOException

Create an instance of QueryResponse given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of QueryResponse

Throws:

java.io.IOException - if the JSON string is invalid with respect to QueryResponse

toJson

public java.lang.String toJson()

Convert an instance of QueryResponse to an JSON string

Returns:

JSON string