QueryVector (pinecone-java-client 3.0.0 API)

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

Deprecated.

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

A single query vector within a `QueryRequest`.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class QueryVector.CustomTypeAdapterFactory
Deprecated.

Nested Classes
Modifier and Type	Class and Description
`static class`	`QueryVector.CustomTypeAdapterFactory` Deprecated.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.util.HashSet<java.lang.String>`	`openapiFields` Deprecated.
`static java.util.HashSet<java.lang.String>`	`openapiRequiredFields` Deprecated.
`static java.lang.String`	`SERIALIZED_NAME_FILTER` Deprecated.
`static java.lang.String`	`SERIALIZED_NAME_NAMESPACE` Deprecated.
`static java.lang.String`	`SERIALIZED_NAME_SPARSE_VALUES` Deprecated.
`static java.lang.String`	`SERIALIZED_NAME_TOP_K` Deprecated.
`static java.lang.String`	`SERIALIZED_NAME_VALUES` Deprecated.

Constructor Summary

Constructors
Constructor and Description

QueryVector()
Deprecated.

Constructors
Constructor and Description
`QueryVector()` Deprecated.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`QueryVector`	`addValuesItem(java.lang.Float valuesItem)` Deprecated.
`boolean`	`equals(java.lang.Object o)` Deprecated.
`QueryVector`	`filter(java.lang.Object filter)` Deprecated.
`static QueryVector`	`fromJson(java.lang.String jsonString)` Deprecated. Create an instance of QueryVector given an JSON string
`java.util.Map<java.lang.String,java.lang.Object>`	`getAdditionalProperties()` Deprecated. Return the additional (undeclared) property.
`java.lang.Object`	`getAdditionalProperty(java.lang.String key)` Deprecated. Return the additional (undeclared) property with the specified name.
`java.lang.Object`	`getFilter()` Deprecated. An override for the metadata filter to apply.
`java.lang.String`	`getNamespace()` Deprecated. An override the namespace to search.
`SparseValues`	`getSparseValues()` Deprecated. Get sparseValues
`java.lang.Long`	`getTopK()` Deprecated. An override for the number of results to return for this query vector.
`java.util.List<java.lang.Float>`	`getValues()` Deprecated. The query vector values.
`int`	`hashCode()` Deprecated.
`QueryVector`	`namespace(java.lang.String namespace)` Deprecated.
`QueryVector`	`putAdditionalProperty(java.lang.String key, java.lang.Object value)` Deprecated. Set the additional (undeclared) property with the specified name and value.
`void`	`setFilter(java.lang.Object filter)` Deprecated.
`void`	`setNamespace(java.lang.String namespace)` Deprecated.
`void`	`setSparseValues(SparseValues sparseValues)` Deprecated.
`void`	`setTopK(java.lang.Long topK)` Deprecated.
`void`	`setValues(java.util.List<java.lang.Float> values)` Deprecated.
`QueryVector`	`sparseValues(SparseValues sparseValues)` Deprecated.
`java.lang.String`	`toJson()` Deprecated. Convert an instance of QueryVector to an JSON string
`QueryVector`	`topK(java.lang.Long topK)` Deprecated.
`java.lang.String`	`toString()` Deprecated.
`static void`	`validateJsonElement(com.google.gson.JsonElement jsonElement)` Deprecated. Validates the JSON Element and throws an exception if issues found
`QueryVector`	`values(java.util.List<java.lang.Float> values)` Deprecated.

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

- Field Detail
  - SERIALIZED_NAME_VALUES
```
public static final java.lang.String SERIALIZED_NAME_VALUES
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_SPARSE_VALUES
```
public static final java.lang.String SERIALIZED_NAME_SPARSE_VALUES
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_TOP_K
```
public static final java.lang.String SERIALIZED_NAME_TOP_K
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_NAMESPACE
```
public static final java.lang.String SERIALIZED_NAME_NAMESPACE
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_FILTER
```
public static final java.lang.String SERIALIZED_NAME_FILTER
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - openapiFields
```
public static java.util.HashSet<java.lang.String> openapiFields
```
    Deprecated.
  - openapiRequiredFields
```
public static java.util.HashSet<java.lang.String> openapiRequiredFields
```
    Deprecated.
- Constructor Detail
  - QueryVector
```
public QueryVector()
```
    Deprecated.
- Method Detail
  - values
```
public QueryVector values(java.util.List<java.lang.Float> values)
```
    Deprecated.
  - addValuesItem
```
public QueryVector addValuesItem(java.lang.Float valuesItem)
```
    Deprecated.
  - getValues
```
@Nonnull
public java.util.List<java.lang.Float> getValues()
```
    Deprecated.
    
    The query vector values. This should be the same length as the dimension of the index being queried.
    
    Returns:
    
    values
  - setValues
```
public void setValues(java.util.List<java.lang.Float> values)
```
    Deprecated.
  - sparseValues
```
public QueryVector sparseValues(SparseValues sparseValues)
```
    Deprecated.
  - getSparseValues
```
@Nullable
public SparseValues getSparseValues()
```
    Deprecated.
    
    Get sparseValues
    
    Returns:
    
    sparseValues
  - setSparseValues
```
public void setSparseValues(SparseValues sparseValues)
```
    Deprecated.
  - topK
```
public QueryVector topK(java.lang.Long topK)
```
    Deprecated.
  - getTopK
```
@Nullable
public java.lang.Long getTopK()
```
    Deprecated.
    
    An override for the number of results to return for this query vector. minimum: 1 maximum: 10000
    
    Returns:
    
    topK
  - setTopK
```
public void setTopK(java.lang.Long topK)
```
    Deprecated.
  - namespace
```
public QueryVector namespace(java.lang.String namespace)
```
    Deprecated.
  - getNamespace
```
@Nullable
public java.lang.String getNamespace()
```
    Deprecated.
    
    An override the namespace to search.
    
    Returns:
    
    namespace
  - setNamespace
```
public void setNamespace(java.lang.String namespace)
```
    Deprecated.
  - filter
```
public QueryVector filter(java.lang.Object filter)
```
    Deprecated.
  - getFilter
```
@Nullable
public java.lang.Object getFilter()
```
    Deprecated.
    
    An override for the metadata filter to apply. This replaces the request-level filter.
    
    Returns:
    
    filter
  - setFilter
```
public void setFilter(java.lang.Object filter)
```
    Deprecated.
  - putAdditionalProperty
```
public QueryVector putAdditionalProperty(java.lang.String key,
                                         java.lang.Object value)
```
    Deprecated.
    
    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 QueryVector instance itself
  - getAdditionalProperties
```
public java.util.Map<java.lang.String,java.lang.Object> getAdditionalProperties()
```
    Deprecated.
    
    Return the additional (undeclared) property.
    
    Returns:
    
    a map of objects
  - getAdditionalProperty
```
public java.lang.Object getAdditionalProperty(java.lang.String key)
```
    Deprecated.
    
    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)
```
    Deprecated.
    
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Deprecated.
    
    Overrides:
    
    hashCode in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Deprecated.
    
    Overrides:
    
    toString in class java.lang.Object
  - validateJsonElement
```
public static void validateJsonElement(com.google.gson.JsonElement jsonElement)
                                throws java.io.IOException
```
    Deprecated.
    
    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 QueryVector
  - fromJson
```
public static QueryVector fromJson(java.lang.String jsonString)
                            throws java.io.IOException
```
    Deprecated.
    
    Create an instance of QueryVector given an JSON string
    
    Parameters:
    
    jsonString - JSON string
    
    Returns:
    
    An instance of QueryVector
    
    Throws:
    
    java.io.IOException - if the JSON string is invalid with respect to QueryVector
  - toJson
```
public java.lang.String toJson()
```
    Deprecated.
    
    Convert an instance of QueryVector to an JSON string
    
    Returns:
    
    JSON string

Class QueryVector

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERIALIZED_NAME_VALUES

SERIALIZED_NAME_SPARSE_VALUES

SERIALIZED_NAME_TOP_K

SERIALIZED_NAME_NAMESPACE

SERIALIZED_NAME_FILTER

openapiFields

openapiRequiredFields

Constructor Detail

QueryVector

Method Detail

values

addValuesItem

getValues

setValues

sparseValues

getSparseValues

setSparseValues

topK

getTopK

setTopK

namespace

getNamespace

setNamespace

filter

getFilter

setFilter

putAdditionalProperty

getAdditionalProperties

getAdditionalProperty

equals

hashCode

toString

validateJsonElement

fromJson

toJson