QueryRequest (pinecone-java-client 3.1.0 API)

java.lang.Object
- org.openapitools.db_data.client.model.QueryRequest

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

The request for the `query` operation.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class QueryRequest.CustomTypeAdapterFactory

Nested Classes
Modifier and Type	Class and Description
`static class`	`QueryRequest.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_FILTER`
`static java.lang.String`	`SERIALIZED_NAME_ID`
`static java.lang.String`	`SERIALIZED_NAME_INCLUDE_METADATA`
`static java.lang.String`	`SERIALIZED_NAME_INCLUDE_VALUES`
`static java.lang.String`	`SERIALIZED_NAME_NAMESPACE`
`static java.lang.String`	`SERIALIZED_NAME_QUERIES`
`static java.lang.String`	`SERIALIZED_NAME_SPARSE_VECTOR`
`static java.lang.String`	`SERIALIZED_NAME_TOP_K`
`static java.lang.String`	`SERIALIZED_NAME_VECTOR`

Constructor Summary

Constructors
Constructor and Description

QueryRequest()

Constructors
Constructor and Description
`QueryRequest()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`QueryRequest`	`addQueriesItem(QueryVector queriesItem)`
`QueryRequest`	`addVectorItem(java.lang.Float vectorItem)`
`boolean`	`equals(java.lang.Object o)`
`QueryRequest`	`filter(java.lang.Object filter)`
`static QueryRequest`	`fromJson(java.lang.String jsonString)` Create an instance of QueryRequest 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.lang.Object`	`getFilter()` The filter to apply.
`java.lang.String`	`getId()` The unique ID of the vector to be used as a query vector.
`java.lang.Boolean`	`getIncludeMetadata()` Indicates whether metadata is included in the response as well as the ids.
`java.lang.Boolean`	`getIncludeValues()` Indicates whether vector values are included in the response.
`java.lang.String`	`getNamespace()` The namespace to query.
`java.util.List<QueryVector>`	`getQueries()` Deprecated.
`SparseValues`	`getSparseVector()` Get sparseVector
`java.lang.Long`	`getTopK()` The number of results to return for each query.
`java.util.List<java.lang.Float>`	`getVector()` The query vector.
`int`	`hashCode()`
`QueryRequest`	`id(java.lang.String id)`
`QueryRequest`	`includeMetadata(java.lang.Boolean includeMetadata)`
`QueryRequest`	`includeValues(java.lang.Boolean includeValues)`
`QueryRequest`	`namespace(java.lang.String namespace)`
`QueryRequest`	`putAdditionalProperty(java.lang.String key, java.lang.Object value)` Set the additional (undeclared) property with the specified name and value.
`QueryRequest`	`queries(java.util.List<QueryVector> queries)` Deprecated.
`void`	`setFilter(java.lang.Object filter)`
`void`	`setId(java.lang.String id)`
`void`	`setIncludeMetadata(java.lang.Boolean includeMetadata)`
`void`	`setIncludeValues(java.lang.Boolean includeValues)`
`void`	`setNamespace(java.lang.String namespace)`
`void`	`setQueries(java.util.List<QueryVector> queries)` Deprecated.
`void`	`setSparseVector(SparseValues sparseVector)`
`void`	`setTopK(java.lang.Long topK)`
`void`	`setVector(java.util.List<java.lang.Float> vector)`
`QueryRequest`	`sparseVector(SparseValues sparseVector)`
`java.lang.String`	`toJson()` Convert an instance of QueryRequest to an JSON string
`QueryRequest`	`topK(java.lang.Long topK)`
`java.lang.String`	`toString()`
`static void`	`validateJsonElement(com.google.gson.JsonElement jsonElement)` Validates the JSON Element and throws an exception if issues found
`QueryRequest`	`vector(java.util.List<java.lang.Float> vector)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

SERIALIZED_NAME_NAMESPACE

public static final java.lang.String SERIALIZED_NAME_NAMESPACE

See Also:: Constant Field Values

SERIALIZED_NAME_TOP_K

public static final java.lang.String SERIALIZED_NAME_TOP_K

See Also:: Constant Field Values

SERIALIZED_NAME_FILTER

public static final java.lang.String SERIALIZED_NAME_FILTER

See Also:: Constant Field Values

SERIALIZED_NAME_INCLUDE_VALUES

public static final java.lang.String SERIALIZED_NAME_INCLUDE_VALUES

See Also:: Constant Field Values

SERIALIZED_NAME_INCLUDE_METADATA

public static final java.lang.String SERIALIZED_NAME_INCLUDE_METADATA

See Also:: Constant Field Values

SERIALIZED_NAME_QUERIES

public static final java.lang.String SERIALIZED_NAME_QUERIES

See Also:: Constant Field Values

SERIALIZED_NAME_VECTOR

public static final java.lang.String SERIALIZED_NAME_VECTOR

See Also:: Constant Field Values

SERIALIZED_NAME_SPARSE_VECTOR

public static final java.lang.String SERIALIZED_NAME_SPARSE_VECTOR

See Also:: Constant Field Values

SERIALIZED_NAME_ID

public static final java.lang.String SERIALIZED_NAME_ID

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
- QueryRequest
```
public QueryRequest()
```

Method Detail
- namespace
```
public QueryRequest namespace(java.lang.String namespace)
```
- getNamespace
```
@Nullable
public java.lang.String getNamespace()
```
  The namespace to query.
  
  Returns:
  
  namespace
- setNamespace
```
public void setNamespace(java.lang.String namespace)
```
- topK
```
public QueryRequest topK(java.lang.Long topK)
```
- getTopK
```
@Nonnull
public java.lang.Long getTopK()
```
  The number of results to return for each query. minimum: 1 maximum: 10000
  
  Returns:
  
  topK
- setTopK
```
public void setTopK(java.lang.Long topK)
```
- filter
```
public QueryRequest filter(java.lang.Object filter)
```
- getFilter
```
@Nullable
public java.lang.Object getFilter()
```
  The filter to apply. You can use vector metadata to limit your search. See [Filter with metadata](https://docs.pinecone.io/guides/data/filter-with-metadata).
  
  Returns:
  
  filter
- setFilter
```
public void setFilter(java.lang.Object filter)
```
- includeValues
```
public QueryRequest includeValues(java.lang.Boolean includeValues)
```
- getIncludeValues
```
@Nullable
public java.lang.Boolean getIncludeValues()
```
  Indicates whether vector values are included in the response.
  
  Returns:
  
  includeValues
- setIncludeValues
```
public void setIncludeValues(java.lang.Boolean includeValues)
```
- includeMetadata
```
public QueryRequest includeMetadata(java.lang.Boolean includeMetadata)
```
- getIncludeMetadata
```
@Nullable
public java.lang.Boolean getIncludeMetadata()
```
  Indicates whether metadata is included in the response as well as the ids.
  
  Returns:
  
  includeMetadata
- setIncludeMetadata
```
public void setIncludeMetadata(java.lang.Boolean includeMetadata)
```
- queries
```
@Deprecated
public QueryRequest queries(java.util.List<QueryVector> queries)
```
  Deprecated.
- addQueriesItem
```
public QueryRequest addQueriesItem(QueryVector queriesItem)
```
- getQueries
```
@Deprecated
 @Nullable
public java.util.List<QueryVector> getQueries()
```
  Deprecated.
  
  DEPRECATED. The query vectors. Each `query()` request can contain only one of the parameters `queries`, `vector`, or `id`.
  
  Returns:
  
  queries
- setQueries
```
@Deprecated
public void setQueries(java.util.List<QueryVector> queries)
```
  Deprecated.
- vector
```
public QueryRequest vector(java.util.List<java.lang.Float> vector)
```
- addVectorItem
```
public QueryRequest addVectorItem(java.lang.Float vectorItem)
```
- getVector
```
@Nullable
public java.util.List<java.lang.Float> getVector()
```
  The query vector. This should be the same length as the dimension of the index being queried. Each `query` request can contain only one of the parameters `id` or `vector`.
  
  Returns:
  
  vector
- setVector
```
public void setVector(java.util.List<java.lang.Float> vector)
```
- sparseVector
```
public QueryRequest sparseVector(SparseValues sparseVector)
```
- getSparseVector
```
@Nullable
public SparseValues getSparseVector()
```
  Get sparseVector
  
  Returns:
  
  sparseVector
- setSparseVector
```
public void setSparseVector(SparseValues sparseVector)
```
- id
```
public QueryRequest id(java.lang.String id)
```
- getId
```
@Nullable
public java.lang.String getId()
```
  The unique ID of the vector to be used as a query vector. Each `query` request can contain only one of the parameters `queries`, `vector`, or `id`.
  
  Returns:
  
  id
- setId
```
public void setId(java.lang.String id)
```
- putAdditionalProperty
```
public QueryRequest 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 QueryRequest 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 QueryRequest
- fromJson
```
public static QueryRequest fromJson(java.lang.String jsonString)
                             throws java.io.IOException
```
  Create an instance of QueryRequest given an JSON string
  
  Parameters:
  
  jsonString - JSON string
  
  Returns:
  
  An instance of QueryRequest
  
  Throws:
  
  java.io.IOException - if the JSON string is invalid with respect to QueryRequest
- toJson
```
public java.lang.String toJson()
```
  Convert an instance of QueryRequest to an JSON string
  
  Returns:
  
  JSON string

Class QueryRequest

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERIALIZED_NAME_NAMESPACE

SERIALIZED_NAME_TOP_K

SERIALIZED_NAME_FILTER

SERIALIZED_NAME_INCLUDE_VALUES

SERIALIZED_NAME_INCLUDE_METADATA

SERIALIZED_NAME_QUERIES

SERIALIZED_NAME_VECTOR

SERIALIZED_NAME_SPARSE_VECTOR

SERIALIZED_NAME_ID

openapiFields

openapiRequiredFields

Constructor Detail

QueryRequest

Method Detail

namespace

getNamespace

setNamespace

topK

getTopK

setTopK

filter

getFilter

setFilter

includeValues

getIncludeValues

setIncludeValues

includeMetadata

getIncludeMetadata

setIncludeMetadata

queries

addQueriesItem

getQueries

setQueries

vector

addVectorItem

getVector

setVector

sparseVector

getSparseVector

setSparseVector

id

getId

setId

putAdditionalProperty

getAdditionalProperties

getAdditionalProperty

equals

hashCode

toString

validateJsonElement

fromJson

toJson