pyobvector Python SDKインターフェースの説明|V4.4.2|OceanBaseデータベース|OceanBaseデータベースドキュメント|分散データベース

pyobvectorは、OceanBaseのベクトルストレージ機能を利用するためのPython SDKであり、以下の2つのモードを提供しています：

pymilvus互換モード：MilvusLikeClientオブジェクトを使用してデータベースを操作し、軽量級のMilvusClientと互換性のある一般的なインターフェースを提供します。
SQLAlchemy拡張モード：ObVecClientオブジェクトを使用してデータベースを操作し、リレーショナルデータベース用のPython SDK拡張機能を提供します。

本記事では、それぞれのモードにおけるインターフェースと使用例について説明します。

MilvusLikeClient

コンストラクタ


def __init__(
    self,
    uri: str = "127.0.0.1:2881",
    user: str = "root@test",
    password: str = "",
    db_name: str = "test",
    **kwargs,
)

collection関連インターフェース

API	パラメータの説明	例
`def create_schema(self, **kwargs) -> CollectionSchema:`	CollectionSchemaオブジェクトを構築します。パラメータを指定しない場合、空のスキーマ定義が初期化されます。オプションパラメータは以下のとおりです： fields：FieldSchemaのリスト（詳細は後述のadd_schemaインターフェースを参照） partitions：パーティションルール（詳細はObPartitionを使用したパーティションルールの定義を参照） description：Milvusとの互換性のために使用され、OceanBaseでは現在実際の役割はありません。
`def create_collection(self,collection_name: str,dimension: Optional[int] = None,primary_field_name: str = "id",id_type: Union[DataType, str] = DataType.INT64,vector_field_name: str = "vector",metric_type: str = "l2",auto_id: bool = False,timeout: Optional[float] = None,schema: Optional[CollectionSchema] = None, # Used for custom setupindex_params: Optional[IndexParams] = None, # Used for custom setupmax_length: int = 16384,**kwargs,)`	テーブルの作成： collection_name : テーブル名 dimension : ベクトルデータの次元 primary_field_name: 主キーの名前 id_type: 主キーのデータ型（VARCHARとINTのみサポートされています） vector_field_name : ベクトルフィールド名 metric_type: OceanBaseでは使用されていませんが、インターフェースの互換性を保つために残されています（主テーブルの定義ではベクトル距離関数を指定する必要がないため） auto_id：主キーが自動インクリメントかどうか timeout : OceanBaseでは使用されていませんが、インターフェースの互換性を保つために残されています schema : カスタムコレクションアーキテクチャ。`schema`がNoneでない場合、dimensionからmetric_typeまでのパラメータは無視されます index_params: カスタムベクトルインデックスパラメータ max_length: 主キーのデータ型がVARCHARで`schema`がNoneでない場合、最大varchar長は`max_length`となります	`client.create_collection(collection_name=test_collection_name,schema=schema,index_params=idx_params,)`
`def get_collection_stats(self, collection_name: str, timeout: Optional[float] = None # pylint: disable=unused-argument) -> Dict:`	テーブルのレコード数の取得。 collection_name：テーブル名 timeout : OceanBaseでは使用されていませんが、インターフェースの互換性を保つために残されています
`def has_collection(self, collection_name: str, timeout: Optional[float] = None) -> bool`	テーブルが存在するかどうかを判断します。 collection_name：テーブル名 timeout : OceanBaseでは未使用ですが、インターフェースの互換性を保つために含まれています。
`def drop_collection(self, collection_name: str) -> None`	テーブルの名前を変更します。 old_name：テーブルの元の名前 new_name：新しいテーブル名
`def load_table(self, collection_name: str,)`	テーブルのメタデータをSQLAlchemyメタデータキャッシュに読み込みます。 collection_name：テーブル名

CollectionSchema & FieldSchema

MilvusLikeClientは、CollectionSchemaを使用してテーブルのスキーマ定義を記述します。1つのCollectionSchemaには複数のFieldSchemaが含まれ、FieldSchemaはテーブルの列スキーマを記述します。

MilvusLikeClientのcreate_schemaを使用したCollectionSchemaの作成

def __init__(
    self,
    fields: Optional[List[FieldSchema]] = None,
    partitions: Optional[ObPartition] = None,
    description: str = "",  # ignored in oceanbase
    **kwargs,
)

パラメータの説明は以下のとおりです：

fields：オプションのFieldSchemaのセット。
partitions：パーティションルール（詳細はObPartitionを使用したパーティションルールの定義の章を参照）。
description：Milvusとの互換性のために使用され、OceanBaseでは現在実際の役割はありません。

FieldSchemaの作成とCollectionSchemaへの登録

def add_field(self, field_name: str, datatype: DataType, **kwargs)

field_name：列名。
datatype：列のデータ型（サポートされているデータ型については、互換性の説明を参照）。
kwargs：その他のパラメータは列の属性を設定するために使用されます。例：
```
def __init__(
self,
name: str,
dtype: DataType,
description: str = "",
is_primary: bool = False,
auto_id: bool = False,
nullable: bool = False,
**kwargs,
)
```
パラメータの説明は以下のとおりです：
- is_primary：主キーかどうか。
- auto_id：自動インクリメント列かどうか。
- nullable：NULLを許容するかどうか。

使用例

schema = self.client.create_schema()
schema.add_field(field_name="id", datatype=DataType.INT64, is_primary=True)
schema.add_field(field_name="title", datatype=DataType.VARCHAR, max_length=512)
schema.add_field(
    field_name="title_vector", datatype=DataType.FLOAT_VECTOR, dim=768
)
schema.add_field(field_name="link", datatype=DataType.VARCHAR, max_length=512)
schema.add_field(field_name="reading_time", datatype=DataType.INT64)
schema.add_field(
    field_name="publication", datatype=DataType.VARCHAR, max_length=512
)
schema.add_field(field_name="claps", datatype=DataType.INT64)
schema.add_field(field_name="responses", datatype=DataType.INT64)

self.client.create_collection(
    collection_name="medium_articles_2020", schema=schema
)

インデックス関連

API	パラメータ説明	例または備考
`def create_index(self,collection_name: str,index_params: IndexParams,timeout: Optional[float] = None,**kwargs,)`	既に構築されたIndexParamsに基づいてベクトルインデックステーブルを作成します（このAPIにおけるIndexParamsの使用方法の詳細は、prepare_index_paramsおよびadd_index APIを参照してください）。 collection_name：テーブル名 index_params：インデックスパラメータ timeout：OceanBaseでは未使用ですが、APIの互換性を保っています kwargs：その他のパラメータ。現在は使用されていませんが、互換性を保っています
`def drop_index(self,collection_name: str,index_name: str,timeout: Optional[float] = None,**kwargs,)`	インデックステーブルを削除します。 collection_name：テーブル名 index_name：インデックス名
`def refresh_index(self,collection_name: str,index_name: str,trigger_threshold: int = 10000,)`	ベクトルインデックステーブルをリフレッシュして読み取り性能を向上させます。これは、増分データの移行と理解できます。 collection_name：テーブル名 index_name：インデックス名 trigger_threshold：リフレッシュアクションのトリガーしきい値です。インデックステーブルのデータ量がこのしきい値を超えた場合にリフレッシュが実行されます。	OceanBase独自の追加インターフェースです。 Milvusとは互換性ありません
`def rebuild_index(self,collection_name: str,index_name: str,trigger_threshold: float = 0.2,)`	ベクトルインデックステーブルを再構築して読み取り性能を向上させます。これは、増分データをベースラインインデックスデータにマージすることと理解できます。 collection_name：テーブル名 index_name：インデックス名 trigger_threshold：再構築アクションのトリガーしきい値です。値域は0から1で、増分データが全体に占める割合がこのしきい値に達したときに再構築がトリガーされます。	OceanBase独自の追加インターフェースです。 Milvusとは互換性ありません
`def search(self,collection_name: str,data: list,anns_field: str,with_dist: bool = False,filter=None,limit: int = 10,output_fields: Optional[List[str]] = None,search_params: Optional[dict] = None,timeout: Optional[float] = None,partition_names: Optional[List[str]] = None,**kwargs,) -> List[dict]`	ベクトル近似近傍探索の実行 collection_name：テーブル名 data：検索対象のベクトルデータ anns_field: 検索対象のベクトル列名 with_dist: ベクトル距離を含む結果を返すかどうか filter : フィルター条件を使用したベクトル近似近傍探索 limit ：上位K件 output_fields: 出力列（またはプロジェクション列とも呼ばれる） search_params : `metric_type` の値が `l2`/`neg_ip` のみサポートされます（例：search_params = {"metric_type": "neg_ip"} ） timeout : OceanBaseでは未使用、互換性のためのみ存在します partition_names : クエリを特定のパーティションに制限する戻り値：レコードのリスト。各レコードは、column_nameから列値へのマッピングを表す辞書です。	`res = self.client.search(collection_name=test_collection_name,data=[0, 0, 1],anns_field="embedding",limit=5,output_fields=["id"],search_params={"metric_type": "neg_ip"})self.assertEqual( set([r['id'] for r in res]), set([12, 111, 11, 112, 10]))`
`def query(self,collection_name: str,flter=None,output_fields: Optional[List[str]] = None,timeout: Optional[float] = None,partition_names: Optional[List[str]] = None,**kwargs,) -> List[dict]`	指定されたフィルター条件を使用してデータレコードを読み取る collection_name：テーブル名 flter : フィルター条件を使用したベクトル近似近傍探索 output_fields: 出力列（またはプロジェクション列とも呼ばれる） timeout : OceanBaseでは未使用、互換性のためのみ存在します partition_names : クエリを特定のパーティションに制限する戻り値：レコードのリスト。各レコードは、column_nameから列値へのマッピングを表す辞書です。	`table = self.client.load_table(collection_name=test_collection_name)where_clause = [table.c["id"] < 100]res = self.client.query( collection_name=test_collection_name, output_fields=["id"], flter=where_clause,)`
`def get(self,collection_name: str,ids: Union[list, str, int],output_fields: Optional[List[str]] = None,timeout: Optional[float] = None,partition_names: Optional[List[str]] = None,**kwargs,) -> List[dict]`	指定された主キー `ids` のレコードを取得します： collection_name：テーブル名 ids：特定のIDまたは一連のIDリスト。注意：MilvusLikeClientのgetインターフェースのidsパラメータは、ObVecClientのgetとは異なります。詳細については、ObVecClient getを参照してください。 output_fields: 出力列（または投影列） timeout : OceanBaseでは使用されておらず、互換性のみを持ちます partition_names : クエリを特定のパーティションに制限します戻り値：レコードのリストで、各レコードはdictです column_nameから列値へのマッピングを表します。	`res = self.client.get( collection_name=test_collection_name, output_fields=["id", "meta"], ids=[80, 12, 112],)`
`def delete(self,collection_name: str,ids: Optional[Union[list, str, int]] = None,timeout: Optional[float] = None, # pylint: disable=unused-argumentflter=None,partition_name: Optional[str] = "",**kwargs, # pylint: disable=unused-argument)`	コレクション内のデータを削除します。 collection_name：テーブル名 ids：特定のIDまたは一連のIDリスト timeout : OceanBaseでは使用されておらず、互換性のみを持ちます flter : フィルタ条件を持つベクトルを使用した近似近傍検索を実行します partition_name : 削除操作を特定のパーティションに制限します	`self.client.delete( collection_name=test_collection_name, ids=[12, 112], partition_name="p0")`
`def insert( self, collection_name: str, data: Union[Dict, List[Dict]], timeout: Optional[float] = None, partition_name: Optional[str] = "")`	テーブルにデータを挿入します。 collection_name：テーブル名 data：キーと値の形式で記述された挿入対象のデータ timeout : OceanBaseでは使用されていません。互換性のみです。 partition_name : 挿入操作を特定のパーティションに制限します。	`data = [ {"id": 12, "embedding": [1, 2, 3], "meta": {"doc": "oceanbase document 1"}}, { "id": 90, "embedding": [0.13, 0.123, 1.213], "meta": {"doc": "oceanbase document 1"}, }, {"id": 112, "embedding": [1, 2, 3], "meta": None}, {"id": 190, "embedding": [0.13, 0.123, 1.213], "meta": None},]self.client.insert(collection_name=test_collection_name, data=data)`
`def upsert(self,collection_name: str,data: Union[Dict, List[Dict]],timeout: Optional[float] = None, # pylint: disable=unused-argumentpartition_name: Optional[str] = "",) -> List[Union[str, int]]`	テーブル内のデータを更新します。主キーが既に存在する場合は、該当するレコードを更新します。不存在の場合は、新規レコードを挿入します。 collection_name：テーブル名 data：挿入または更新対象のデータ。formatはinsertインターフェースと同じです。 timeout : OceanBaseでは使用されていません。互換性のみです。 partition_name : 操作を指定したパーティションに制限します。	`data = [ {"id": 112, "embedding": [1, 2, 3], "meta": {'doc':'hhh1'}}, {"id": 190, "embedding": [0.13, 0.123, 1.213], "meta": {'doc':'hhh2'}},]self.client.upsert(collection_name=test_collection_name, data=data)`
`def perform_raw_text_sql(self, text_sql: str): return super().perform_raw_text_sql(text_sql)`	SQLステートメントを直接実行します。 text_sql: 実行するSQL 戻り値： SQLAlchemyが提供する結果セットイテレータを返します。

ObVecClient

コンストラクタ

def __init__(
    self,
    uri: str = "127.0.0.1:2881",
    user: str = "root@test",
    password: str = "",
    db_name: str = "test",
    **kwargs,
)

テーブルモード関連操作

API	パラメータ説明	例または備考
`def check_table_exists(self, table_name: str)`	テーブルの存在を確認する。 table_name：テーブル名
`def create_table(self,table_name: str,columns: List[Column],indexes: Optional[List[Index]] = None,partitions: Optional[ObPartition] = None,)`	テーブルを作成する。 table_name：テーブル名 columns：SQLAlchemyを使用して定義したテーブルの列スキーマ indexes：SQLAlchemyを使用して定義した一連のインデックステーブルスキーマ partitions：オプションのパーティションルール（詳細は、ObPartitionを使用したパーティションルールの定義を参照）。
`@classmethoddef prepare_index_params(cls)`	IndexParamsオブジェクトを作成し、ベクトルインデックステーブルのスキーマ定義を記録します。 `class IndexParams: """Vector index parameters for MilvusLikeClient" def init(self): self._indexes = {}` IndexParamsの定義は非常にシンプルで、内部には単一の辞書型メンバーがあり、(列名、インデックス名) のタプルをIndexParam構造へマッピングしています。 IndexParamクラスのコンストラクタは次のとおりです。 `def init( self, index_name: str, field_name: str, index_type: Union[VecIndexType, str], kwargs)` index_name：ベクトルインデックステーブル名 field_name：ベクトル列名 index_type：ベクトルインデックスアルゴリズムタイプの列挙クラス。現在はHNSWのみサポートしています。 `prepare_index_params`でIndexParamsを取得した後、`add_index`インターフェースを使用してIndexParamを登録できます： `def add_index( self, field_name: str, index_type: VecIndexType, index_name: str, kwargs)` パラメータの意味はIndexParamのコンストラクタと同じです。	ベクトルインデックスの作成例を示します： `idx_params = self.client.prepare_index_params()idx_params.add_index( field_name="title_vector", index_type="HNSW", index_name="vidx_title_vector", metric_type="L2", params={"M": 16, "efConstruction": 256},)self.client.create_collection( collection_name=test_collection_name, schema=schema, index_params=idx_params,)` 注意点として、`prepare_index_params`関数はMilvusLikeClientでの使用を推奨し、ObVecClientでの使用は推奨されません。ObVecClientモードでは、`create_index`インターフェースを使用してベクトルインデックステーブルを定義する必要があります。（詳細はcreate_indexインターフェースを参照）
`def create_table_with_index_params(self,table_name: str,columns: List[Column],indexes: Optional[List[Index]] = None,vidxs: Optional[IndexParams] = None,partitions: Optional[ObPartition] = None,)`	オプションのindex_paramsを使用して、テーブル作成と同時にベクトルインデックスを作成します。 table_name：テーブル名 columns：SQLAlchemyを使用して定義されたテーブルの列スキーマ indexes：SQLAlchemyを使用して定義された一連のインデックステーブルスキーマ vidxs：IndexParamsを使用して指定されたベクトルインデックステーブルスキーマ partitions：オプションのパーティションルール（詳細は「ObPartitionを使用したパーティションルールの定義」を参照）	MilvusLikeClientでの使用を推奨します。ObVecClientでの使用は推奨されません。
`def create_index(self,table_name: str,is_vec_index: bool,index_name: str,column_names: List[str],vidx_params: Optional[str] = None,**kw,)`	通常インデックスとベクトルインデックスの2種類のモードをサポートしています。 table_name：テーブル名 is_vec_index：インデックスが通常インデックスかベクトルインデックスか index_name：インデックス名 column_names ：インデックスを作成する列 vidx_params：ベクトルインデックスのパラメータ。例：`“distance=l2, type=hnsw, lib=vsag”` 現在、OceanBaseは`type=hnsw`と`lib=vsag`のみをサポートしています。これら2つの設定は維持してください。distanceは`l2`または`inner_product`に設定できます。	`self.client.create_index( test_collection_name, is_vec_index=True, index_name="vidx", column_names=["embedding"], vidx_params="distance=l2, type=hnsw, lib=vsag",)`
`def create_vidx_with_vec_index_param(self,table_name: str,vidx_param: IndexParam,)`	ベクトルインデックスパラメータを使用してベクトルインデックスを作成します。 table_name：テーブル名 vidx_param：IndexParamで構築されたベクトルインデックスパラメータ
`def drop_table_if_exist(self, table_name: str)`	テーブルを削除します。 table_name：テーブル名
`def drop_index(self, table_name: str, index_name: str)`	インデックスを削除します。 table_name：テーブル名 index_name：インデックス名
`def refresh_index(self,table_name: str,index_name: str,trigger_threshold: int = 10000,)`	ベクトルインデックステーブルをリフレッシュして読み取りパフォーマンスを向上させる。増分データの移動と理解できる。 table_name：テーブル名 index_name：インデックス名 trigger_threshold：リフレッシュアクションのトリガーしきい値。インデックステーブルのデータ量がこのしきい値を超えた場合にリフレッシュを実行する。
`def rebuild_index(self,table_name: str,index_name: str,trigger_threshold: float = 0.2,)`	ベクトルインデックステーブルを再構築して読み取りパフォーマンスを向上させる。増分データをベースラインインデックスデータにマージすると理解できる。 table_name：テーブル名 index_name：インデックス名 trigger_threshold：再構築アクションのトリガーしきい値。値域は0から1で、増分データが全量データに占める割合がこのしきい値に達したときに再構築をトリガーする。

DML操作

API	パラメータの説明	例または備考
`def insert(self,table_name: str,data: Union[Dict, List[Dict]],partition_name: Optional[str] = "",)`	テーブルにデータを挿入します。 table_name：テーブル名 data：キーと値の形式で記述された、挿入するデータ partition_name：挿入操作を特定のパーティションに制限する	`vector_value1 = [0.748479, 0.276979, 0.555195]vector_value2 = [0, 0, 0]data1 = [{"id": i, "embedding": vector_value1} for i in range(10)]data1.extend([{"id": i, "embedding": vector_value2} for i in range(10, 13)])data1.extend([{"id": i, "embedding": vector_value2} for i in range(111, 113)])self.client.insert(test_collection_name, data=data1)`
`def upsert(self,table_name: str,data: Union[Dict, List[Dict]],partition_name: Optional[str] = "",)`	テーブルのデータを挿入または更新します。主キーが既に存在する場合は、対応するレコードを更新します。不存在の場合は、新規レコードを挿入します。 table_name：テーブル名 data：挿入または更新するデータ（キーと値の形式） partition_name：操作を指定したパーティションに制限する
`def update(self,table_name: str,values_clause,where_clause=None,partition_name: Optional[str] = "",)`	テーブルのデータを更新します。主キーが重複する場合は、それを置き換えます。 table_name：テーブル名 values_clause：更新する列の値 where_clause：更新条件 partition_name：更新操作を特定のパーティションに制限する	`data = [ {"id": 112, "embedding": [1, 2, 3], "meta": {'doc':'hhh1'}}, {"id": 190, "embedding": [0.13, 0.123, 1.213], "meta": {'doc':'hhh2'}},]client.insert(collection_name=test_collection_name, data=data)client.update( table_name=test_collection_name, values_clause=[{'meta':{'doc':'HHH'}}], where_clause=[text("id=112")])`
`def delete(self,table_name: str,ids: Optional[Union[list, str, int]] = None,where_clause=None,partition_name: Optional[str] = "",)`	テーブル内のデータを削除。 table_name：テーブル名 ids：特定のIDまたは一連のIDリスト where_clause：削除条件 partition_name：削除操作を特定のパーティションに制限する	`self.client.delete(test_collection_name, ids=["bcd", "def"])`
`def get(self,table_name: str,ids: Optional[Union[list, str, int]],where_clause = None,output_column_name: Optional[List[str]] = None,partition_names: Optional[List[str]] = None,)`	指定された主キー`ids`のレコードを取得します。 table_name：テーブル名 ids：特定のIDまたは一連のIDリスト。オプションパラメータで、指定しない場合は`ids=None`とします。ObVecClientのgetインターフェースのidsパラメータはMilvusLikeClientのgetとは異なります。詳細はMilvusLikeClient getを参照してください。 where_clause：取得条件 output_column_name：出力列または投影列名のリスト partition_names：取得操作を特定のパーティションに制限する戻り値： MilvusLikeClientとは異なり、ObVecClientの戻り値はtuple listです。各tupleは1行のレコードを表します。	`res = self.client.get( test_collection_name, ids=["abc", "bcd", "cde", "def"], where_clause=[text("meta->'$.page' > 1")], output_column_name=['id'])`
`def set_ob_hnsw_ef_search(self, ob_hnsw_ef_search: int)`	HNSWインデックスのefSearchパラメータを設定します。セッションレベル変数の設定で、ef_searchが大きいほど再現率は高くなりますが、クエリのパフォーマンスは低下します。 ob_hnsw_ef_search：HNSWインデックスのefSearchパラメータ
`def get_ob_hnsw_ef_search(self) -> int`	HNSWインデックスのefSearchパラメータを取得します。
`def ann_search(self,table_name: str,vec_data: list,vec_column_name: str,distance_func,with_dist: bool = False,topk: int = 10,output_column_names: Optional[List[str]] = None,extra_output_cols: Optional[List] = None,where_clause=None,partition_names: Optional[List[str]] = None,**kwargs,)`	ベクトル近似近傍探索の実行。 table_name：テーブル名 vec_data：検索対象のベクトルデータ vec_column_name：検索対象のベクトル列名 distance_func：距離関数。SQLAlchemyのfuncを拡張しており、`func.l2_distance`/`func.cosine_distance`/`func.inner_product`/`func.negative_inner_product`が指定可能で、それぞれl2距離関数、コサイン距離関数、内積距離関数、内積距離の負値を表す with_dist：ベクトル距離を含む結果を返すかどうか topk：最も近いベクトルの個数 output_column_names：出力列または投影列の名前のリスト extra_output_cols：追加の出力列。より複雑な出力式を指定できる where_clause：フィルター条件 partition_names：クエリを特定のパーティションに制限する戻り値： MilvusLikeClientとは異なり、ObVecClientの戻り値はtuple listであり、各tupleは1行のレコードを表す。	`res = self.client.ann_search( test_collection_name, vec_data=[0, 0, 0], vec_column_name="embedding", distance_func=func.l2_distance, with_dist=True, topk=5, output_column_names=["id"],)`
`def precise_search(self,table_name: str,vec_data: list,vec_column_name: str,distance_func,topk: int = 10,output_column_names: Optional[List[str]] = None,where_clause=None,**kwargs,)`	厳密近傍探索アルゴリズムの実行。 table_name：テーブル名 vec_data：クエリのベクトル vec_column_name：ベクトル列名 distance_func：ベクトル距離関数。SQLAlchemyのfuncを拡張しており、func.l2_distance/func.cosine_distance/func.inner_product/func.negative_inner_productが指定可能で、それぞれl2距離関数、コサイン距離関数、内積距離関数、内積距離の負値を表す topk：最も近いベクトルの個数 output_column_names：出力列または投影列の名前のリスト where_clause：フィルター条件戻り値： MilvusLikeClientとは異なり、ObVecClientの戻り値はtuple listであり、各tupleは1行のレコードを表す。
`def perform_raw_text_sql(self, text_sql: str)`	SQLステートメントを直接実行します。 text_sql: 実行するSQL 戻り値： SQLAlchemyが提供する結果セットイテレータを返します。

ObPartitionを使用したパーティションルールの定義

pyobvectorは、range/range columns、list/list columns、hash、key、およびサブパーティションをサポートするために以下のタイプを提供しています：

ObRangePartition：rangeパーティション。構築時にis_range_columns = Trueを設定することで、range columnsパーティションを作成します。
ObListPartition：listパーティション。構築時にis_list_columns = Trueを設定することで、list columnsパーティションを作成します。
ObHashPartition：hashパーティション。
ObKeyPartition：keyパーティション。
ObSubRangePartition：サブrangeパーティション。構築時にis_range_columns = Trueを設定することで、range columnsサブパーティションを作成します。
ObSubListPartition：listサブパーティション。構築時にis_list_columns = Trueを設定することで、list columnsサブパーティションを作成します。
ObSubHashPartition：hashサブパーティション。
ObSubKeyPartition：keyサブパーティション。

rangeパーティションの例

range_part = ObRangePartition(
    False,
    range_part_infos=[
        RangeListPartInfo("p0", 100),
        RangeListPartInfo("p1", "maxvalue"),
    ],
    range_expr="id",
)

listパーティションの例

list_part = ObListPartition(
    False,
    list_part_infos=[
        RangeListPartInfo("p0", [1, 2, 3]),
        RangeListPartInfo("p1", [5, 6]),
        RangeListPartInfo("p2", "DEFAULT"),
    ],
    list_expr="col1",
)

hashパーティションの例

hash_part = ObHashPartition("col1", part_count=60)

複数レベルパーティションの例

# パーティションrange
range_columns_part = ObRangePartition(
    True,
    range_partInfos=[
        RangeListPartInfo("p0", 100),
        RangeListPartInfo("p1", 200),
        RangeListPartInfo("p2", 300),
    ],
    col_name_list=["col1"],
)
# サブパーティションrange
range_sub_part = ObSubRangePartition(
    False,
    range_partInfos=[
        RangeListPartInfo("mp0", 1000),
        RangeListPartInfo("mp1", 2000),
        RangeListPartInfo("mp2", 3000),
    ],
    range_expr="col3",
)
range_columns_part.add_subpartition(range_sub_part)

純粋なSQLAlchemy APIモード

OceanBaseデータベースのベクトル検索機能で純粋なSQLAlchemy APIを使用したい場合は、以下の2つの方法で同期されたデータベースエンジンを取得できます。

方法1：ObVecClientを使用してデータベースエンジンを作成する

from pyobvector import ObVecClient

client = ObVecClient(uri="127.0.0.1:2881", user="test@test")
engine = client.engine
# その後、通常どおりSQLAlchemyを使用してsessionを作成し、SQLAlchemyのAPIを使用できます。

方法2：ObVecClientのcreate_engineインターフェースを使用してデータベースエンジンを作成する

import pyobvector
from sqlalchemy.dialects import registry
from sqlalchemy import create_engine

uri: str = "127.0.0.1:2881"
user: str = "root@test"
password: str = ""
db_name: str = "test"
registry.register("mysql.oceanbase", "pyobvector.schema.dialect", "OceanBaseDialect")
connection_str = (
    # mysql+oceanbase は、MySQL標準を選択し、OceanBaseデータベースの同期ドライバーを使用することを意味します。
    f"mysql+oceanbase://{user}:{password}@{uri}/{db_name}?charset=utf8mb4"
)
engine = create_engine(connection_str, **kwargs)
# その後、通常どおりSQLAlchemyを使用してsessionを作成し、SQLAlchemyのAPIを使用できます。

SQLAlchemyの非同期インターフェースを使用したい場合は、OceanBaseデータベースの非同期ドライバーを使用できます。

import pyobvector
from sqlalchemy.dialects import registry
from sqlalchemy.ext.asyncio import create_async_engine

uri: str = "127.0.0.1:2881"
user: str = "root@test"
password: str = ""
db_name: str = "test"
registry.register("mysql.aoceanbase", "pyobvector", "AsyncOceanBaseDialect")
connection_str = (
    # mysql+aoceanbase は、MySQL標準を選択し、OceanBaseデータベースの非同期ドライバーを使用することを意味します。
    f"mysql+aoceanbase://{user}:{password}@{uri}/{db_name}?charset=utf8mb4"
)
engine = create_async_engine(connection_str)
# その後、通常どおりSQLAlchemyを使用してsessionを作成し、SQLAlchemyのAPIを使用できます。

詳細な例

pyobvectorコードリポジトリにアクセスして、詳細な例を入手してください。

pyobvectorは、OceanBaseのベクトルストレージ機能を利用するためのPython SDKであり、以下の2つのモードを提供しています：

pymilvus互換モード：MilvusLikeClientオブジェクトを使用してデータベースを操作し、軽量級のMilvusClientと互換性のある一般的なインターフェースを提供します。
SQLAlchemy拡張モード：ObVecClientオブジェクトを使用してデータベースを操作し、リレーショナルデータベース用のPython SDK拡張機能を提供します。

本記事では、それぞれのモードにおけるインターフェースと使用例について説明します。

MilvusLikeClient

コンストラクタ


def __init__(
    self,
    uri: str = "127.0.0.1:2881",
    user: str = "root@test",
    password: str = "",
    db_name: str = "test",
    **kwargs,
)

collection関連インターフェース

API	パラメータの説明	例
`def create_schema(self, **kwargs) -> CollectionSchema:`	CollectionSchemaオブジェクトを構築します。パラメータを指定しない場合、空のスキーマ定義が初期化されます。オプションパラメータは以下のとおりです： fields：FieldSchemaのリスト（詳細は後述のadd_schemaインターフェースを参照） partitions：パーティションルール（詳細はObPartitionを使用したパーティションルールの定義を参照） description：Milvusとの互換性のために使用され、OceanBaseでは現在実際の役割はありません。
`def create_collection(self,collection_name: str,dimension: Optional[int] = None,primary_field_name: str = "id",id_type: Union[DataType, str] = DataType.INT64,vector_field_name: str = "vector",metric_type: str = "l2",auto_id: bool = False,timeout: Optional[float] = None,schema: Optional[CollectionSchema] = None, # Used for custom setupindex_params: Optional[IndexParams] = None, # Used for custom setupmax_length: int = 16384,**kwargs,)`	テーブルの作成： collection_name : テーブル名 dimension : ベクトルデータの次元 primary_field_name: 主キーの名前 id_type: 主キーのデータ型（VARCHARとINTのみサポートされています） vector_field_name : ベクトルフィールド名 metric_type: OceanBaseでは使用されていませんが、インターフェースの互換性を保つために残されています（主テーブルの定義ではベクトル距離関数を指定する必要がないため） auto_id：主キーが自動インクリメントかどうか timeout : OceanBaseでは使用されていませんが、インターフェースの互換性を保つために残されています schema : カスタムコレクションアーキテクチャ。`schema`がNoneでない場合、dimensionからmetric_typeまでのパラメータは無視されます index_params: カスタムベクトルインデックスパラメータ max_length: 主キーのデータ型がVARCHARで`schema`がNoneでない場合、最大varchar長は`max_length`となります	`client.create_collection(collection_name=test_collection_name,schema=schema,index_params=idx_params,)`
`def get_collection_stats(self, collection_name: str, timeout: Optional[float] = None # pylint: disable=unused-argument) -> Dict:`	テーブルのレコード数の取得。 collection_name：テーブル名 timeout : OceanBaseでは使用されていませんが、インターフェースの互換性を保つために残されています
`def has_collection(self, collection_name: str, timeout: Optional[float] = None) -> bool`	テーブルが存在するかどうかを判断します。 collection_name：テーブル名 timeout : OceanBaseでは未使用ですが、インターフェースの互換性を保つために含まれています。
`def drop_collection(self, collection_name: str) -> None`	テーブルの名前を変更します。 old_name：テーブルの元の名前 new_name：新しいテーブル名
`def load_table(self, collection_name: str,)`	テーブルのメタデータをSQLAlchemyメタデータキャッシュに読み込みます。 collection_name：テーブル名

CollectionSchema & FieldSchema

MilvusLikeClientのcreate_schemaを使用したCollectionSchemaの作成

def __init__(
    self,
    fields: Optional[List[FieldSchema]] = None,
    partitions: Optional[ObPartition] = None,
    description: str = "",  # ignored in oceanbase
    **kwargs,
)

パラメータの説明は以下のとおりです：

fields：オプションのFieldSchemaのセット。
partitions：パーティションルール（詳細はObPartitionを使用したパーティションルールの定義の章を参照）。
description：Milvusとの互換性のために使用され、OceanBaseでは現在実際の役割はありません。

FieldSchemaの作成とCollectionSchemaへの登録

def add_field(self, field_name: str, datatype: DataType, **kwargs)

field_name：列名。
datatype：列のデータ型（サポートされているデータ型については、互換性の説明を参照）。
kwargs：その他のパラメータは列の属性を設定するために使用されます。例：
```
def __init__(
self,
name: str,
dtype: DataType,
description: str = "",
is_primary: bool = False,
auto_id: bool = False,
nullable: bool = False,
**kwargs,
)
```
パラメータの説明は以下のとおりです：
- is_primary：主キーかどうか。
- auto_id：自動インクリメント列かどうか。
- nullable：NULLを許容するかどうか。

使用例

schema = self.client.create_schema()
schema.add_field(field_name="id", datatype=DataType.INT64, is_primary=True)
schema.add_field(field_name="title", datatype=DataType.VARCHAR, max_length=512)
schema.add_field(
    field_name="title_vector", datatype=DataType.FLOAT_VECTOR, dim=768
)
schema.add_field(field_name="link", datatype=DataType.VARCHAR, max_length=512)
schema.add_field(field_name="reading_time", datatype=DataType.INT64)
schema.add_field(
    field_name="publication", datatype=DataType.VARCHAR, max_length=512
)
schema.add_field(field_name="claps", datatype=DataType.INT64)
schema.add_field(field_name="responses", datatype=DataType.INT64)

self.client.create_collection(
    collection_name="medium_articles_2020", schema=schema
)

インデックス関連

API	パラメータ説明	例または備考
`def create_index(self,collection_name: str,index_params: IndexParams,timeout: Optional[float] = None,**kwargs,)`	既に構築されたIndexParamsに基づいてベクトルインデックステーブルを作成します（このAPIにおけるIndexParamsの使用方法の詳細は、prepare_index_paramsおよびadd_index APIを参照してください）。 collection_name：テーブル名 index_params：インデックスパラメータ timeout：OceanBaseでは未使用ですが、APIの互換性を保っています kwargs：その他のパラメータ。現在は使用されていませんが、互換性を保っています
`def drop_index(self,collection_name: str,index_name: str,timeout: Optional[float] = None,**kwargs,)`	インデックステーブルを削除します。 collection_name：テーブル名 index_name：インデックス名
`def refresh_index(self,collection_name: str,index_name: str,trigger_threshold: int = 10000,)`	ベクトルインデックステーブルをリフレッシュして読み取り性能を向上させます。これは、増分データの移行と理解できます。 collection_name：テーブル名 index_name：インデックス名 trigger_threshold：リフレッシュアクションのトリガーしきい値です。インデックステーブルのデータ量がこのしきい値を超えた場合にリフレッシュが実行されます。	OceanBase独自の追加インターフェースです。 Milvusとは互換性ありません
`def rebuild_index(self,collection_name: str,index_name: str,trigger_threshold: float = 0.2,)`	ベクトルインデックステーブルを再構築して読み取り性能を向上させます。これは、増分データをベースラインインデックスデータにマージすることと理解できます。 collection_name：テーブル名 index_name：インデックス名 trigger_threshold：再構築アクションのトリガーしきい値です。値域は0から1で、増分データが全体に占める割合がこのしきい値に達したときに再構築がトリガーされます。	OceanBase独自の追加インターフェースです。 Milvusとは互換性ありません
`def search(self,collection_name: str,data: list,anns_field: str,with_dist: bool = False,filter=None,limit: int = 10,output_fields: Optional[List[str]] = None,search_params: Optional[dict] = None,timeout: Optional[float] = None,partition_names: Optional[List[str]] = None,**kwargs,) -> List[dict]`	ベクトル近似近傍探索の実行 collection_name：テーブル名 data：検索対象のベクトルデータ anns_field: 検索対象のベクトル列名 with_dist: ベクトル距離を含む結果を返すかどうか filter : フィルター条件を使用したベクトル近似近傍探索 limit ：上位K件 output_fields: 出力列（またはプロジェクション列とも呼ばれる） search_params : `metric_type` の値が `l2`/`neg_ip` のみサポートされます（例：search_params = {"metric_type": "neg_ip"} ） timeout : OceanBaseでは未使用、互換性のためのみ存在します partition_names : クエリを特定のパーティションに制限する戻り値：レコードのリスト。各レコードは、column_nameから列値へのマッピングを表す辞書です。	`res = self.client.search(collection_name=test_collection_name,data=[0, 0, 1],anns_field="embedding",limit=5,output_fields=["id"],search_params={"metric_type": "neg_ip"})self.assertEqual( set([r['id'] for r in res]), set([12, 111, 11, 112, 10]))`
`def query(self,collection_name: str,flter=None,output_fields: Optional[List[str]] = None,timeout: Optional[float] = None,partition_names: Optional[List[str]] = None,**kwargs,) -> List[dict]`	指定されたフィルター条件を使用してデータレコードを読み取る collection_name：テーブル名 flter : フィルター条件を使用したベクトル近似近傍探索 output_fields: 出力列（またはプロジェクション列とも呼ばれる） timeout : OceanBaseでは未使用、互換性のためのみ存在します partition_names : クエリを特定のパーティションに制限する戻り値：レコードのリスト。各レコードは、column_nameから列値へのマッピングを表す辞書です。	`table = self.client.load_table(collection_name=test_collection_name)where_clause = [table.c["id"] < 100]res = self.client.query( collection_name=test_collection_name, output_fields=["id"], flter=where_clause,)`
`def get(self,collection_name: str,ids: Union[list, str, int],output_fields: Optional[List[str]] = None,timeout: Optional[float] = None,partition_names: Optional[List[str]] = None,**kwargs,) -> List[dict]`	指定された主キー `ids` のレコードを取得します： collection_name：テーブル名 ids：特定のIDまたは一連のIDリスト。注意：MilvusLikeClientのgetインターフェースのidsパラメータは、ObVecClientのgetとは異なります。詳細については、ObVecClient getを参照してください。 output_fields: 出力列（または投影列） timeout : OceanBaseでは使用されておらず、互換性のみを持ちます partition_names : クエリを特定のパーティションに制限します戻り値：レコードのリストで、各レコードはdictです column_nameから列値へのマッピングを表します。	`res = self.client.get( collection_name=test_collection_name, output_fields=["id", "meta"], ids=[80, 12, 112],)`
`def delete(self,collection_name: str,ids: Optional[Union[list, str, int]] = None,timeout: Optional[float] = None, # pylint: disable=unused-argumentflter=None,partition_name: Optional[str] = "",**kwargs, # pylint: disable=unused-argument)`	コレクション内のデータを削除します。 collection_name：テーブル名 ids：特定のIDまたは一連のIDリスト timeout : OceanBaseでは使用されておらず、互換性のみを持ちます flter : フィルタ条件を持つベクトルを使用した近似近傍検索を実行します partition_name : 削除操作を特定のパーティションに制限します	`self.client.delete( collection_name=test_collection_name, ids=[12, 112], partition_name="p0")`
`def insert( self, collection_name: str, data: Union[Dict, List[Dict]], timeout: Optional[float] = None, partition_name: Optional[str] = "")`	テーブルにデータを挿入します。 collection_name：テーブル名 data：キーと値の形式で記述された挿入対象のデータ timeout : OceanBaseでは使用されていません。互換性のみです。 partition_name : 挿入操作を特定のパーティションに制限します。	`data = [ {"id": 12, "embedding": [1, 2, 3], "meta": {"doc": "oceanbase document 1"}}, { "id": 90, "embedding": [0.13, 0.123, 1.213], "meta": {"doc": "oceanbase document 1"}, }, {"id": 112, "embedding": [1, 2, 3], "meta": None}, {"id": 190, "embedding": [0.13, 0.123, 1.213], "meta": None},]self.client.insert(collection_name=test_collection_name, data=data)`
`def upsert(self,collection_name: str,data: Union[Dict, List[Dict]],timeout: Optional[float] = None, # pylint: disable=unused-argumentpartition_name: Optional[str] = "",) -> List[Union[str, int]]`	テーブル内のデータを更新します。主キーが既に存在する場合は、該当するレコードを更新します。不存在の場合は、新規レコードを挿入します。 collection_name：テーブル名 data：挿入または更新対象のデータ。formatはinsertインターフェースと同じです。 timeout : OceanBaseでは使用されていません。互換性のみです。 partition_name : 操作を指定したパーティションに制限します。	`data = [ {"id": 112, "embedding": [1, 2, 3], "meta": {'doc':'hhh1'}}, {"id": 190, "embedding": [0.13, 0.123, 1.213], "meta": {'doc':'hhh2'}},]self.client.upsert(collection_name=test_collection_name, data=data)`
`def perform_raw_text_sql(self, text_sql: str): return super().perform_raw_text_sql(text_sql)`	SQLステートメントを直接実行します。 text_sql: 実行するSQL 戻り値： SQLAlchemyが提供する結果セットイテレータを返します。

ObVecClient

コンストラクタ

def __init__(
    self,
    uri: str = "127.0.0.1:2881",
    user: str = "root@test",
    password: str = "",
    db_name: str = "test",
    **kwargs,
)

テーブルモード関連操作

API	パラメータ説明	例または備考
`def check_table_exists(self, table_name: str)`	テーブルの存在を確認する。 table_name：テーブル名
`def create_table(self,table_name: str,columns: List[Column],indexes: Optional[List[Index]] = None,partitions: Optional[ObPartition] = None,)`	テーブルを作成する。 table_name：テーブル名 columns：SQLAlchemyを使用して定義したテーブルの列スキーマ indexes：SQLAlchemyを使用して定義した一連のインデックステーブルスキーマ partitions：オプションのパーティションルール（詳細は、ObPartitionを使用したパーティションルールの定義を参照）。
`@classmethoddef prepare_index_params(cls)`	IndexParamsオブジェクトを作成し、ベクトルインデックステーブルのスキーマ定義を記録します。 `class IndexParams: """Vector index parameters for MilvusLikeClient" def init(self): self._indexes = {}` IndexParamsの定義は非常にシンプルで、内部には単一の辞書型メンバーがあり、(列名、インデックス名) のタプルをIndexParam構造へマッピングしています。 IndexParamクラスのコンストラクタは次のとおりです。 `def init( self, index_name: str, field_name: str, index_type: Union[VecIndexType, str], kwargs)` index_name：ベクトルインデックステーブル名 field_name：ベクトル列名 index_type：ベクトルインデックスアルゴリズムタイプの列挙クラス。現在はHNSWのみサポートしています。 `prepare_index_params`でIndexParamsを取得した後、`add_index`インターフェースを使用してIndexParamを登録できます： `def add_index( self, field_name: str, index_type: VecIndexType, index_name: str, kwargs)` パラメータの意味はIndexParamのコンストラクタと同じです。	ベクトルインデックスの作成例を示します： `idx_params = self.client.prepare_index_params()idx_params.add_index( field_name="title_vector", index_type="HNSW", index_name="vidx_title_vector", metric_type="L2", params={"M": 16, "efConstruction": 256},)self.client.create_collection( collection_name=test_collection_name, schema=schema, index_params=idx_params,)` 注意点として、`prepare_index_params`関数はMilvusLikeClientでの使用を推奨し、ObVecClientでの使用は推奨されません。ObVecClientモードでは、`create_index`インターフェースを使用してベクトルインデックステーブルを定義する必要があります。（詳細はcreate_indexインターフェースを参照）
`def create_table_with_index_params(self,table_name: str,columns: List[Column],indexes: Optional[List[Index]] = None,vidxs: Optional[IndexParams] = None,partitions: Optional[ObPartition] = None,)`	オプションのindex_paramsを使用して、テーブル作成と同時にベクトルインデックスを作成します。 table_name：テーブル名 columns：SQLAlchemyを使用して定義されたテーブルの列スキーマ indexes：SQLAlchemyを使用して定義された一連のインデックステーブルスキーマ vidxs：IndexParamsを使用して指定されたベクトルインデックステーブルスキーマ partitions：オプションのパーティションルール（詳細は「ObPartitionを使用したパーティションルールの定義」を参照）	MilvusLikeClientでの使用を推奨します。ObVecClientでの使用は推奨されません。
`def create_index(self,table_name: str,is_vec_index: bool,index_name: str,column_names: List[str],vidx_params: Optional[str] = None,**kw,)`	通常インデックスとベクトルインデックスの2種類のモードをサポートしています。 table_name：テーブル名 is_vec_index：インデックスが通常インデックスかベクトルインデックスか index_name：インデックス名 column_names ：インデックスを作成する列 vidx_params：ベクトルインデックスのパラメータ。例：`“distance=l2, type=hnsw, lib=vsag”` 現在、OceanBaseは`type=hnsw`と`lib=vsag`のみをサポートしています。これら2つの設定は維持してください。distanceは`l2`または`inner_product`に設定できます。	`self.client.create_index( test_collection_name, is_vec_index=True, index_name="vidx", column_names=["embedding"], vidx_params="distance=l2, type=hnsw, lib=vsag",)`
`def create_vidx_with_vec_index_param(self,table_name: str,vidx_param: IndexParam,)`	ベクトルインデックスパラメータを使用してベクトルインデックスを作成します。 table_name：テーブル名 vidx_param：IndexParamで構築されたベクトルインデックスパラメータ
`def drop_table_if_exist(self, table_name: str)`	テーブルを削除します。 table_name：テーブル名
`def drop_index(self, table_name: str, index_name: str)`	インデックスを削除します。 table_name：テーブル名 index_name：インデックス名
`def refresh_index(self,table_name: str,index_name: str,trigger_threshold: int = 10000,)`	ベクトルインデックステーブルをリフレッシュして読み取りパフォーマンスを向上させる。増分データの移動と理解できる。 table_name：テーブル名 index_name：インデックス名 trigger_threshold：リフレッシュアクションのトリガーしきい値。インデックステーブルのデータ量がこのしきい値を超えた場合にリフレッシュを実行する。
`def rebuild_index(self,table_name: str,index_name: str,trigger_threshold: float = 0.2,)`	ベクトルインデックステーブルを再構築して読み取りパフォーマンスを向上させる。増分データをベースラインインデックスデータにマージすると理解できる。 table_name：テーブル名 index_name：インデックス名 trigger_threshold：再構築アクションのトリガーしきい値。値域は0から1で、増分データが全量データに占める割合がこのしきい値に達したときに再構築をトリガーする。

DML操作

API	パラメータの説明	例または備考
`def insert(self,table_name: str,data: Union[Dict, List[Dict]],partition_name: Optional[str] = "",)`	テーブルにデータを挿入します。 table_name：テーブル名 data：キーと値の形式で記述された、挿入するデータ partition_name：挿入操作を特定のパーティションに制限する	`vector_value1 = [0.748479, 0.276979, 0.555195]vector_value2 = [0, 0, 0]data1 = [{"id": i, "embedding": vector_value1} for i in range(10)]data1.extend([{"id": i, "embedding": vector_value2} for i in range(10, 13)])data1.extend([{"id": i, "embedding": vector_value2} for i in range(111, 113)])self.client.insert(test_collection_name, data=data1)`
`def upsert(self,table_name: str,data: Union[Dict, List[Dict]],partition_name: Optional[str] = "",)`	テーブルのデータを挿入または更新します。主キーが既に存在する場合は、対応するレコードを更新します。不存在の場合は、新規レコードを挿入します。 table_name：テーブル名 data：挿入または更新するデータ（キーと値の形式） partition_name：操作を指定したパーティションに制限する
`def update(self,table_name: str,values_clause,where_clause=None,partition_name: Optional[str] = "",)`	テーブルのデータを更新します。主キーが重複する場合は、それを置き換えます。 table_name：テーブル名 values_clause：更新する列の値 where_clause：更新条件 partition_name：更新操作を特定のパーティションに制限する	`data = [ {"id": 112, "embedding": [1, 2, 3], "meta": {'doc':'hhh1'}}, {"id": 190, "embedding": [0.13, 0.123, 1.213], "meta": {'doc':'hhh2'}},]client.insert(collection_name=test_collection_name, data=data)client.update( table_name=test_collection_name, values_clause=[{'meta':{'doc':'HHH'}}], where_clause=[text("id=112")])`
`def delete(self,table_name: str,ids: Optional[Union[list, str, int]] = None,where_clause=None,partition_name: Optional[str] = "",)`	テーブル内のデータを削除。 table_name：テーブル名 ids：特定のIDまたは一連のIDリスト where_clause：削除条件 partition_name：削除操作を特定のパーティションに制限する	`self.client.delete(test_collection_name, ids=["bcd", "def"])`
`def get(self,table_name: str,ids: Optional[Union[list, str, int]],where_clause = None,output_column_name: Optional[List[str]] = None,partition_names: Optional[List[str]] = None,)`	指定された主キー`ids`のレコードを取得します。 table_name：テーブル名 ids：特定のIDまたは一連のIDリスト。オプションパラメータで、指定しない場合は`ids=None`とします。ObVecClientのgetインターフェースのidsパラメータはMilvusLikeClientのgetとは異なります。詳細はMilvusLikeClient getを参照してください。 where_clause：取得条件 output_column_name：出力列または投影列名のリスト partition_names：取得操作を特定のパーティションに制限する戻り値： MilvusLikeClientとは異なり、ObVecClientの戻り値はtuple listです。各tupleは1行のレコードを表します。	`res = self.client.get( test_collection_name, ids=["abc", "bcd", "cde", "def"], where_clause=[text("meta->'$.page' > 1")], output_column_name=['id'])`
`def set_ob_hnsw_ef_search(self, ob_hnsw_ef_search: int)`	HNSWインデックスのefSearchパラメータを設定します。セッションレベル変数の設定で、ef_searchが大きいほど再現率は高くなりますが、クエリのパフォーマンスは低下します。 ob_hnsw_ef_search：HNSWインデックスのefSearchパラメータ
`def get_ob_hnsw_ef_search(self) -> int`	HNSWインデックスのefSearchパラメータを取得します。
`def ann_search(self,table_name: str,vec_data: list,vec_column_name: str,distance_func,with_dist: bool = False,topk: int = 10,output_column_names: Optional[List[str]] = None,extra_output_cols: Optional[List] = None,where_clause=None,partition_names: Optional[List[str]] = None,**kwargs,)`	ベクトル近似近傍探索の実行。 table_name：テーブル名 vec_data：検索対象のベクトルデータ vec_column_name：検索対象のベクトル列名 distance_func：距離関数。SQLAlchemyのfuncを拡張しており、`func.l2_distance`/`func.cosine_distance`/`func.inner_product`/`func.negative_inner_product`が指定可能で、それぞれl2距離関数、コサイン距離関数、内積距離関数、内積距離の負値を表す with_dist：ベクトル距離を含む結果を返すかどうか topk：最も近いベクトルの個数 output_column_names：出力列または投影列の名前のリスト extra_output_cols：追加の出力列。より複雑な出力式を指定できる where_clause：フィルター条件 partition_names：クエリを特定のパーティションに制限する戻り値： MilvusLikeClientとは異なり、ObVecClientの戻り値はtuple listであり、各tupleは1行のレコードを表す。	`res = self.client.ann_search( test_collection_name, vec_data=[0, 0, 0], vec_column_name="embedding", distance_func=func.l2_distance, with_dist=True, topk=5, output_column_names=["id"],)`
`def precise_search(self,table_name: str,vec_data: list,vec_column_name: str,distance_func,topk: int = 10,output_column_names: Optional[List[str]] = None,where_clause=None,**kwargs,)`	厳密近傍探索アルゴリズムの実行。 table_name：テーブル名 vec_data：クエリのベクトル vec_column_name：ベクトル列名 distance_func：ベクトル距離関数。SQLAlchemyのfuncを拡張しており、func.l2_distance/func.cosine_distance/func.inner_product/func.negative_inner_productが指定可能で、それぞれl2距離関数、コサイン距離関数、内積距離関数、内積距離の負値を表す topk：最も近いベクトルの個数 output_column_names：出力列または投影列の名前のリスト where_clause：フィルター条件戻り値： MilvusLikeClientとは異なり、ObVecClientの戻り値はtuple listであり、各tupleは1行のレコードを表す。
`def perform_raw_text_sql(self, text_sql: str)`	SQLステートメントを直接実行します。 text_sql: 実行するSQL 戻り値： SQLAlchemyが提供する結果セットイテレータを返します。

ObPartitionを使用したパーティションルールの定義

pyobvectorは、range/range columns、list/list columns、hash、key、およびサブパーティションをサポートするために以下のタイプを提供しています：

ObRangePartition：rangeパーティション。構築時にis_range_columns = Trueを設定することで、range columnsパーティションを作成します。
ObListPartition：listパーティション。構築時にis_list_columns = Trueを設定することで、list columnsパーティションを作成します。
ObHashPartition：hashパーティション。
ObKeyPartition：keyパーティション。
ObSubRangePartition：サブrangeパーティション。構築時にis_range_columns = Trueを設定することで、range columnsサブパーティションを作成します。
ObSubListPartition：listサブパーティション。構築時にis_list_columns = Trueを設定することで、list columnsサブパーティションを作成します。
ObSubHashPartition：hashサブパーティション。
ObSubKeyPartition：keyサブパーティション。

rangeパーティションの例

range_part = ObRangePartition(
    False,
    range_part_infos=[
        RangeListPartInfo("p0", 100),
        RangeListPartInfo("p1", "maxvalue"),
    ],
    range_expr="id",
)

listパーティションの例

list_part = ObListPartition(
    False,
    list_part_infos=[
        RangeListPartInfo("p0", [1, 2, 3]),
        RangeListPartInfo("p1", [5, 6]),
        RangeListPartInfo("p2", "DEFAULT"),
    ],
    list_expr="col1",
)

hashパーティションの例

hash_part = ObHashPartition("col1", part_count=60)

複数レベルパーティションの例

# パーティションrange
range_columns_part = ObRangePartition(
    True,
    range_partInfos=[
        RangeListPartInfo("p0", 100),
        RangeListPartInfo("p1", 200),
        RangeListPartInfo("p2", 300),
    ],
    col_name_list=["col1"],
)
# サブパーティションrange
range_sub_part = ObSubRangePartition(
    False,
    range_partInfos=[
        RangeListPartInfo("mp0", 1000),
        RangeListPartInfo("mp1", 2000),
        RangeListPartInfo("mp2", 3000),
    ],
    range_expr="col3",
)
range_columns_part.add_subpartition(range_sub_part)

純粋なSQLAlchemy APIモード

方法1：ObVecClientを使用してデータベースエンジンを作成する

from pyobvector import ObVecClient

client = ObVecClient(uri="127.0.0.1:2881", user="test@test")
engine = client.engine
# その後、通常どおりSQLAlchemyを使用してsessionを作成し、SQLAlchemyのAPIを使用できます。

方法2：ObVecClientのcreate_engineインターフェースを使用してデータベースエンジンを作成する

import pyobvector
from sqlalchemy.dialects import registry
from sqlalchemy import create_engine

uri: str = "127.0.0.1:2881"
user: str = "root@test"
password: str = ""
db_name: str = "test"
registry.register("mysql.oceanbase", "pyobvector.schema.dialect", "OceanBaseDialect")
connection_str = (
    # mysql+oceanbase は、MySQL標準を選択し、OceanBaseデータベースの同期ドライバーを使用することを意味します。
    f"mysql+oceanbase://{user}:{password}@{uri}/{db_name}?charset=utf8mb4"
)
engine = create_engine(connection_str, **kwargs)
# その後、通常どおりSQLAlchemyを使用してsessionを作成し、SQLAlchemyのAPIを使用できます。

SQLAlchemyの非同期インターフェースを使用したい場合は、OceanBaseデータベースの非同期ドライバーを使用できます。

import pyobvector
from sqlalchemy.dialects import registry
from sqlalchemy.ext.asyncio import create_async_engine

uri: str = "127.0.0.1:2881"
user: str = "root@test"
password: str = ""
db_name: str = "test"
registry.register("mysql.aoceanbase", "pyobvector", "AsyncOceanBaseDialect")
connection_str = (
    # mysql+aoceanbase は、MySQL標準を選択し、OceanBaseデータベースの非同期ドライバーを使用することを意味します。
    f"mysql+aoceanbase://{user}:{password}@{uri}/{db_name}?charset=utf8mb4"
)
engine = create_async_engine(connection_str)
# その後、通常どおりSQLAlchemyを使用してsessionを作成し、SQLAlchemyのAPIを使用できます。

詳細な例

pyobvectorコードリポジトリにアクセスして、詳細な例を入手してください。

OceanBase

顧客事例

pyobvector Python SDKインターフェースの説明

MilvusLikeClient

コンストラクタ

collection関連インターフェース

CollectionSchema & FieldSchema

MilvusLikeClientのcreate_schemaを使用したCollectionSchemaの作成

FieldSchemaの作成とCollectionSchemaへの登録

使用例

インデックス関連

ObVecClient

コンストラクタ

テーブルモード関連操作

DML操作

ObPartitionを使用したパーティションルールの定義

rangeパーティションの例

listパーティションの例

hashパーティションの例

複数レベルパーティションの例

純粋なSQLAlchemy APIモード

詳細な例

pyobvector Python SDKインターフェースの説明

MilvusLikeClient

コンストラクタ

collection関連インターフェース

CollectionSchema & FieldSchema

MilvusLikeClientのcreate_schemaを使用したCollectionSchemaの作成

FieldSchemaの作成とCollectionSchemaへの登録

使用例

インデックス関連

ObVecClient

コンストラクタ

テーブルモード関連操作

DML操作

ObPartitionを使用したパーティションルールの定義

rangeパーティションの例

listパーティションの例

hashパーティションの例

複数レベルパーティションの例

純粋なSQLAlchemy APIモード

詳細な例