Console
    Start free

    Google Cloud Vector Search V1 Client - Class Index (0.3.0)

    Reference documentation and code samples for the Google Cloud Vector Search V1 Client class Index.

    Message describing Index object

    Generated from protobuf message google.cloud.vectorsearch.v1.Index

    Namespace

    Google \ Cloud \ VectorSearch \ V1

    Methods

    __construct

    Constructor.

    Parameters
    Name
    Description
    data
    array

    Optional. Data for populating the Message object.

    ↳ dedicated_infrastructure
    DedicatedInfrastructure

    Optional. Dedicated infrastructure for the index.

    ↳ dense_scann
    DenseScannIndex

    Optional. Dense ScaNN index.

    ↳ name
    string

    Identifier. name of resource

    ↳ display_name
    string

    Optional. User-specified display name of the index

    ↳ description
    string

    Optional. User-specified description of the index

    ↳ labels
    array| Google\Protobuf\Internal\MapField

    Optional. Labels as key value pairs.

    ↳ create_time
    Google\Protobuf\Timestamp

    Output only. [Output only] Create time stamp

    ↳ update_time
    Google\Protobuf\Timestamp

    Output only. [Output only] Update time stamp

    ↳ distance_metric
    int

    Optional. Distance metric used for indexing. If not specified, will default to DOT_PRODUCT.

    ↳ index_field
    string

    Required. The collection schema field to index.

    ↳ filter_fields
    string[]

    Optional. The fields to push into the index to enable fast ANN inline filtering.

    ↳ store_fields
    string[]

    Optional. The fields to push into the index to enable inline data retrieval.

    getDedicatedInfrastructure

    Optional. Dedicated infrastructure for the index.

    Returns
    Type
    Description
    DedicatedInfrastructure |null

    hasDedicatedInfrastructure

    setDedicatedInfrastructure

    Optional. Dedicated infrastructure for the index.

    Parameter
    Name
    Description
    var
    DedicatedInfrastructure
    Returns
    Type
    Description
    $this

    getDenseScann

    Optional. Dense ScaNN index.

    Returns
    Type
    Description
    DenseScannIndex |null

    hasDenseScann

    setDenseScann

    Optional. Dense ScaNN index.

    Parameter
    Name
    Description
    var
    DenseScannIndex
    Returns
    Type
    Description
    $this

    getName

    Identifier. name of resource

    Returns
    Type
    Description
    string

    setName

    Identifier. name of resource

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getDisplayName

    Optional. User-specified display name of the index

    Returns
    Type
    Description
    string

    setDisplayName

    Optional. User-specified display name of the index

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getDescription

    Optional. User-specified description of the index

    Returns
    Type
    Description
    string

    setDescription

    Optional. User-specified description of the index

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getLabels

    Optional. Labels as key value pairs.

    Returns
    Type
    Description
    Google\Protobuf\Internal\MapField

    setLabels

    Optional. Labels as key value pairs.

    Parameter
    Name
    Description
    var
    array| Google\Protobuf\Internal\MapField
    Returns
    Type
    Description
    $this

    getCreateTime

    Output only. [Output only] Create time stamp

    Returns
    Type
    Description
    Google\Protobuf\Timestamp |null

    hasCreateTime

    clearCreateTime

    setCreateTime

    Output only. [Output only] Create time stamp

    Parameter
    Name
    Description
    var
    Google\Protobuf\Timestamp
    Returns
    Type
    Description
    $this

    getUpdateTime

    Output only. [Output only] Update time stamp

    Returns
    Type
    Description
    Google\Protobuf\Timestamp |null

    hasUpdateTime

    clearUpdateTime

    setUpdateTime

    Output only. [Output only] Update time stamp

    Parameter
    Name
    Description
    var
    Google\Protobuf\Timestamp
    Returns
    Type
    Description
    $this

    getDistanceMetric

    Optional. Distance metric used for indexing. If not specified, will default to DOT_PRODUCT.

    Returns
    Type
    Description
    int
    Enum of type DistanceMetric .

    setDistanceMetric

    Optional. Distance metric used for indexing. If not specified, will default to DOT_PRODUCT.

    Parameter
    Name
    Description
    var
    int

    Enum of type DistanceMetric .

    Returns
    Type
    Description
    $this

    getIndexField

    Required. The collection schema field to index.

    Returns
    Type
    Description
    string

    setIndexField

    Required. The collection schema field to index.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getFilterFields

    Optional. The fields to push into the index to enable fast ANN inline filtering.

    Returns
    Type
    Description
    Google\Protobuf\RepeatedField < string >

    setFilterFields

    Optional. The fields to push into the index to enable fast ANN inline filtering.

    Parameter
    Name
    Description
    var
    string[]
    Returns
    Type
    Description
    $this

    getStoreFields

    Optional. The fields to push into the index to enable inline data retrieval.

    Returns
    Type
    Description
    Google\Protobuf\RepeatedField < string >

    setStoreFields

    Optional. The fields to push into the index to enable inline data retrieval.

    Parameter
    Name
    Description
    var
    string[]
    Returns
    Type
    Description
    $this

    getInfraType

    Returns
    Type
    Description
    string

    getIndexType

    Returns
    Type
    Description
    string
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: