DashVector:DashVector のデータ型の定義

Python

@dataclass(frozen=True)
class Doc(object):
    id: str                                            # プライマリキー。
    vector: Union[List[int], List[float], np.ndarray]  # ベクター。
    sparse_vector: Optional[Dict[int, float]] = None   # 疎ベクトル。
    fields: Optional[FieldDataDict] = None             # ドキュメント内のカスタムフィールド。
    score: float = 0.0                                 # ベクター間の類似性。

Java

@Data
@Builder
public class Doc {
  // プライマリキー。
  @NonNull private String id;
  // ベクター。
  @NonNull private Vector vector;
  // 疎ベクトル。
  private TreeMap<Integer, Float> sparseVector;
  // ドキュメント内のカスタムフィールド。
  @Builder.Default private Map<String, Object> fields = new HashMap<>();
  // ベクター間の類似性。
  private float score;

  public void addField(String key, String value) {
    this.fields.put(key, value);
  }

  public void addField(String key, Integer value) {
    this.fields.put(key, value);
  }

  public void addField(String key, Float value) {
    this.fields.put(key, value);
  }

  public void addField(String key, Boolean value) {
    this.fields.put(key, value);
  }
}

フィールドリファレンス

サポートされているフィールドデータ型

Python

@dataclass(frozen=True)
class CollectionMeta(object):
    name: str                      # コレクションの名前。
    dimension: int                 # ベクターのディメンション数。
    dtype: str                     # ベクターのデータ型。有効な値： float および int。
    metric: str                    # 距離メトリック。有効な値： euclidean、dotproduct、cosine。
    status: Status                 # コレクションのステータス。
    fields: Dict[str, str]         # コレクション内のフィールド。サポートされているフィールドのデータ型： float、bool、int、str。
    partitions: Dict[str, Status]  # コレクション内のパーティションに関する情報。

Java

@Getter
public class CollectionMeta {
  // コレクションの名前。
  private final String name;
  // ベクターのディメンション数。
  private final int dimension;
  // ベクターのデータ型。有効な値： float および int。
  private final CollectionInfo.DataType dataType;
  // 距離メトリック。有効な値： euclidean、dotproduct、cosine。
  private final CollectionInfo.Metric metric;
  // コレクションのステータス。
  private final String status;
  // コレクション内のフィールド。サポートされているフィールドのデータ型： float、bool、int、str。
  private final Map<String, FieldType> fieldsSchema;
  // コレクション内のパーティションに関する情報。
  private final Map<String, Status> partitionStatus;

  public CollectionMeta(CollectionInfo collectionInfo) {
    this.name = collectionInfo.getName();
    this.dimension = collectionInfo.getDimension();
    this.dataType = collectionInfo.getDtype();
    this.metric = collectionInfo.getMetric();
    this.status = collectionInfo.getStatus().name();
    this.fieldsSchema = collectionInfo.getFieldsSchemaMap();
    this.partitionStatus = collectionInfo.getPartitionsMap();
  }
}

フィールドリファレンス

距離メトリック

ベクターのデータ型

Python

@dataclass(frozen=True)
class CollectionStats(object):
    total_doc_count: int                    # コレクションに挿入されたドキュメントの総数。
    index_completeness: float               # コレクションへのデータ挿入の完全性。
    partitions: Dict[str, PartitionStats]   # コレクション内のパーティションに関する情報。

Java

@Getter
public class CollectionStats {
  // コレクションに挿入されたドキュメントの総数。
  private final long totalDocCount;
  // コレクションへのデータ挿入の完全性。
  private final float indexCompleteness;
  // コレクション内のパーティションに関する情報。
  private final Map<String, PartitionStats> partitions;

  public CollectionStats(StatsCollectionResponse.CollectionStats collectionStats) {
    this.totalDocCount = collectionStats.getTotalDocCount();
    this.indexCompleteness = collectionStats.getIndexCompleteness();
    this.partitions = new HashMap<>();
    collectionStats
        .getPartitionsMap()
        .forEach((key, value) -> this.partitions.put(key, new PartitionStats(value)));
  }
}

フィールドリファレンス

Python

@dataclass(frozen=True)
class PartitionStats(object):
    total_doc_count: int                    # パーティション内のドキュメントの総数。

Java

@Getter
public class PartitionStats {
  // パーティション内のドキュメントの総数。
  private final long totalDocCount;

  public PartitionStats(com.aliyun.dashvector.proto.PartitionStats partitionStats) {
    this.totalDocCount = partitionStats.getTotalDocCount();
  }
}

フィールドリファレンス