Represents a Vector.
Package
@google-cloud/vectorsearchConstructors
(constructor)(properties)
constructor(properties?: google.cloud.vectorsearch.v1beta.IVector);Constructs a new Vector.
| Parameter | |
|---|---|
| Name | Description |
properties |
IVector
Properties to set |
Properties
dense
public dense?: (google.cloud.vectorsearch.v1beta.IDenseVector|null);Vector dense.
sparse
public sparse?: (google.cloud.vectorsearch.v1beta.ISparseVector|null);Vector sparse.
values
public values: number[];Vector values.
vectorType
public vectorType?: ("dense"|"sparse");Vector vectorType.
Methods
create(properties)
public static create(properties?: google.cloud.vectorsearch.v1beta.IVector): google.cloud.vectorsearch.v1beta.Vector;Creates a new Vector instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IVector
Properties to set |
| Returns | |
|---|---|
| Type | Description |
Vector |
Vector instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.vectorsearch.v1beta.Vector;Decodes a Vector message from the specified reader or buffer.
| Parameters | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
Vector |
Vector |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.vectorsearch.v1beta.Vector;Decodes a Vector message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
Vector |
Vector |
encode(message, writer)
public static encode(message: google.cloud.vectorsearch.v1beta.IVector, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Vector message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IVector
Vector message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer |
Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: google.cloud.vectorsearch.v1beta.IVector, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Vector message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IVector
Vector message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer |
Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.cloud.vectorsearch.v1beta.Vector;Creates a Vector message from a plain object. Also converts values to their respective internal types.
| Parameter | |
|---|---|
| Name | Description |
object |
{ [k: string]: any }
Plain object |
| Returns | |
|---|---|
| Type | Description |
Vector |
Vector |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for Vector
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string |
The default type url |
toJSON()
public toJSON(): { [k: string]: any };Converts this Vector to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: google.cloud.vectorsearch.v1beta.Vector, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a Vector message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
Vector
Vector |
options |
$protobuf.IConversionOptions
Conversion options |
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);Verifies a Vector message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|