API

`#github.com/xulang-org/packages/milvus`

import: milvus #github.com/xulang-org/packages/milvus

counts: 4 fns, 16 methods, 6 types, 0 consts, 0 ifaces

External package `milvus #github.com/xulang-org/packages/milvus`, provided by github.com/xulang-org/packages.

github.com/xulang-org/packages · 0.1.1 · Install and use

`client`

XuAPI

pub fn client(endpoint string) MilvusClient

Purpose

client; returns MilvusClient.

Parameters

endpoint string: endpoint (string)

Returns

MilvusClient — a value of this type

`pool`

XuAPI

pub fn pool(endpoint string, max_conns int) MilvusPool

Purpose

pool; returns MilvusPool.

Parameters

endpoint string: endpoint (string)
max_conns int: max_conns (int)

Returns

MilvusPool — a value of this type

`struct MilvusClient`

XuAPI

pub struct MilvusClient {
    pub host string
    pub port int
    pub token string
}

Purpose

Public struct `MilvusClient`.

Parameters

host string: host
port int: port
token string: field (string)

`new_client`

XuAPI

pub fn new_client(endpoint string) MilvusClient

Purpose

Construct client.

Parameters

endpoint string: endpoint (string)

Returns

MilvusClient — a value of this type

`(MilvusClient) connect`

XuAPI

pub fn (c MilvusClient) connect() int

Purpose

Call `connect` on `MilvusClient`. Throws on failure.

Parameters

c MilvusClient: receiver MilvusClient (value receiver)

Returns

int — a value of this type

`(MilvusClient) do_request_on_fd`

XuAPI

pub fn (c MilvusClient) do_request_on_fd(fd int, method string, path string, body string) string

Purpose

Executes HTTP/1.1 REST v2 request on an established socket Throws on failure.

Parameters

c MilvusClient: receiver MilvusClient (value receiver)
fd int: file descriptor (int)
method string: method (string)
path string: filesystem path (string)
body string: body (string)

Returns

string — result string

`(MilvusClient) do_request`

XuAPI

pub fn (c MilvusClient) do_request(method string, path string, body string) string

Purpose

Method on `MilvusClient`: do request. Throws on failure.

Parameters

c MilvusClient: receiver MilvusClient (value receiver)
method string: method (string)
path string: filesystem path (string)
body string: body (string)

Returns

string — result string

`(MilvusClient) create_collection`

XuAPI

pub fn (c MilvusClient) create_collection(cfg CollectionConfig) bool

Purpose

Method on `MilvusClient`: create collection. Throws on failure.

Parameters

c MilvusClient: receiver MilvusClient (value receiver)
cfg CollectionConfig: cfg (CollectionConfig)

Returns

bool — true or false

`(MilvusClient) drop_collection`

XuAPI

pub fn (c MilvusClient) drop_collection(name string) bool

Purpose

Method on `MilvusClient`: drop collection. Throws on failure.

Parameters

c MilvusClient: receiver MilvusClient (value receiver)
name string: name (string)

Returns

bool — true or false

`(MilvusClient) insert`

XuAPI

pub fn (c MilvusClient) insert(collection string, entities []VectorEntity) bool

Purpose

Call `insert` on `MilvusClient`. Throws on failure.

Parameters

c MilvusClient: receiver MilvusClient (value receiver)
collection string: collection (string)
entities []VectorEntity: entities ([]VectorEntity)

Returns

bool — true or false

`(MilvusClient) search`

XuAPI

pub fn (c MilvusClient) search(collection string, query_vec []string, limit int) SearchResult

Purpose

Method on `MilvusClient`: binary search. Throws on failure.

Parameters

c MilvusClient: receiver MilvusClient (value receiver)
collection string: collection (string)
query_vec []string: query_vec ([]string)
limit int: limit (int)

Returns

SearchResult — a value of this type

`struct MilvusPool`

XuAPI

pub struct MilvusPool {
    pub client MilvusClient
    pub state chan pool.State
    pub max_idle int
}

Purpose

Public struct `MilvusPool`.

Parameters

client MilvusClient: field (MilvusClient)
state chan pool.State: field (channel; type chan pool.State)
max_idle int: field (int)

`open_pool`

XuAPI

pub fn open_pool(endpoint string, max_idle int) MilvusPool

Purpose

Open pool.

Parameters

endpoint string: endpoint (string)
max_idle int: max_idle (int)

Returns

MilvusPool — a value of this type

`(&MilvusPool) dup`

XuAPI

pub fn (p &MilvusPool) dup() MilvusPool

Purpose

Copies configuration while sharing the connection and close lifecycle.

Parameters

p &MilvusPool: receiver &MilvusPool (borrow)

Returns

MilvusPool — a value of this type

`(&MilvusPool) get_conn`

XuAPI

pub fn (p &MilvusPool) get_conn() int

Purpose

Method on `&MilvusPool`: read conn.

Parameters

p &MilvusPool: receiver &MilvusPool (borrow)

Returns

int — a value of this type

`(&MilvusPool) put_conn`

XuAPI

pub fn (p &MilvusPool) put_conn(fd int)

Purpose

Method on `&MilvusPool`: put connection.

Parameters

p &MilvusPool: receiver &MilvusPool (borrow)
fd int: file descriptor (int)

`(&MilvusPool) discard_conn`

XuAPI

pub fn (p &MilvusPool) discard_conn(fd int)

Purpose

Method on `&MilvusPool`: discard connection.

Parameters

p &MilvusPool: receiver &MilvusPool (borrow)
fd int: file descriptor (int)

`(&MilvusPool) create_collection`

XuAPI

pub fn (p &MilvusPool) create_collection(cfg CollectionConfig) bool

Purpose

Method on `&MilvusPool`: create collection. Throws on failure.

Parameters

p &MilvusPool: receiver &MilvusPool (borrow)
cfg CollectionConfig: cfg (CollectionConfig)

Returns

bool — true or false

`(&MilvusPool) drop_collection`

XuAPI

pub fn (p &MilvusPool) drop_collection(name string) bool

Purpose

Method on `&MilvusPool`: drop collection. Throws on failure.

Parameters

p &MilvusPool: receiver &MilvusPool (borrow)
name string: name (string)

Returns

bool — true or false

`(&MilvusPool) insert`

XuAPI

pub fn (p &MilvusPool) insert(collection string, entities []VectorEntity) bool

Purpose

Call `insert` on `&MilvusPool`. Throws on failure.

Parameters

p &MilvusPool: receiver &MilvusPool (borrow)
collection string: collection (string)
entities []VectorEntity: entities ([]VectorEntity)

Returns

bool — true or false

`(&MilvusPool) search`

XuAPI

pub fn (p &MilvusPool) search(collection string, query_vec []string, limit int) SearchResult

Purpose

Method on `&MilvusPool`: binary search. Throws on failure.

Parameters

p &MilvusPool: receiver &MilvusPool (borrow)
collection string: collection (string)
query_vec []string: query_vec ([]string)
limit int: limit (int)

Returns

SearchResult — a value of this type

`(&MilvusPool) close`

XuAPI

pub fn (p &MilvusPool) close()

Purpose

Method on `&MilvusPool`: close the resource.

Parameters

p &MilvusPool: receiver &MilvusPool (borrow)

`struct CollectionConfig`

XuAPI

pub struct CollectionConfig {
    pub name string
    pub dimension int
    pub metric_type string "syn-cmt">// "COSINE", "L2", "IP"
}

Purpose

Public struct `CollectionConfig`.

Parameters

name string: name
dimension int: field (int)
metric_type string // "COSINE", "L2", "IP": field (string // "COSINE", "L2", "IP")

`struct VectorEntity`

XuAPI

pub struct VectorEntity {
    pub id int
    pub vector []string
    pub text string
}

Purpose

Public struct `VectorEntity`.

Parameters

id int: field (int)
vector []string: field ([]string)
text string: text

`struct SearchHit`

XuAPI

pub struct SearchHit {
    pub id int
    pub distance string
    pub text string
}

Purpose

Public struct `SearchHit`.

Parameters

id int: field (int)
distance string: field (string)
text string: text

`struct SearchResult`

XuAPI

pub struct SearchResult {
    pub hits []SearchHit
}

Purpose

Public struct `SearchResult`.

Parameters

hits []SearchHit: field ([]SearchHit)