chroma go

Chroma Go

一个简单的Chroma矢量数据库客户端

与Chroma版本合作：V0.4.3 -V0.5.x

我们邀请用户访问文档网站以获取图书馆以获取更多深度信息：Chroma Go Docs

与Chromadb API的功能奇偶校验

• ✅创建房客
• ✅找租户
• ✅创建数据库
• ✅获取数据库
• ✅重置
• ✅心跳
• ✅列表集合
• ✅计数收集
• ✅获取版本
• ✅创建集合
• ✅删除集合
• ✅收集添加
• ✅集合获取（部分没有其他参数）
• ✅集合数
• ✅收集查询
• ✅收集修改嵌入
• ✅收集更新
• ✅收集量
• ✅集合删除 - 删除收集中的文档
• ✅身份验证（基本，带有授权标头的令牌，带有X-Chroma-Toke标头的令牌）
• ✅私人PKI和自签名证书支持

嵌入API和模型支持

• ✅默认嵌入支持 - 由于0.2.0 +，我们还支持在ONNX Runtime（ORT）上运行的默认all-MiniLM-L6-v2模型。
• ✅OpenAI嵌入支持
• ✅共同（包括多语言支持）
• ✅句子变形金刚（HuggingFace推理API和HFEI本地服务器）
• ✅GoogleGemini嵌入支持
• 自定义嵌入功能
• ✅拥抱面嵌入推理服务器支持
• ✅Ollama嵌入支持
• ✅Cloudflare工人AI嵌入支持
• ✅一起AI嵌入支持
• ✅航行AI嵌入支持
• ✅MISTRAL AI API嵌入支持
• ✅通用AI嵌入支持
• ✅jina ai嵌入支持

重读功能

从版本0.2.0发行版Chroma GO客户端还支持重新脉动功能。支持以下内容：

• ✅共同
• ✅Jina ai
• ✅拥抱面嵌入推理服务器reranker

安装

重要的

如下所述，有许多新的变化导致v0.2.0 。如果您想使用它们，请安装客户的最新版本。

go get github.com/amikos-tech/chroma-go@main

go get github.com/amikos-tech/chroma-go

进口：

 import (
chroma "github.com/amikos-tech/chroma-go"
)

用法

确保您有一个Chroma运行的实例。我们建议以下两个选项之一：

• 官方文件
• 如果您是Kubernetes的粉丝，则可以使用Helm图表（注意：您需要安装Docker ， minikube和kubectl ）

设置（云国）：

minikube start --profile chromago
minikube profile chromago
helm repo add chroma https://amikos-tech.github.io/chromadb-chart/
helm repo update
helm install chroma chroma/chromadb --set chromadb.allowReset=true,chromadb.apiVersion=0.4.5

|注意：要删除Minikube群集： minikube delete --profile chromago

入门

考虑以下示例：

• 我们创建一个新集合
• 使用默认嵌入功能添加文档
• 使用相同的嵌入功能查询集合

 package main

import (
	"context"
	"fmt"
	"log"
	"os"

	chroma "github.com/amikos-tech/chroma-go"
	"github.com/amikos-tech/chroma-go/collection"
	openai "github.com/amikos-tech/chroma-go/pkg/embeddings/openai"
	"github.com/amikos-tech/chroma-go/types"
)

func main () {
	// Create a new Chroma client
	client , err := chroma . NewClient ( chroma . WithBasePath ( "http://localhost:8000" ))
	if err != nil {
        log . Fatalf ( "Error creating client: %s n " , err )
		return
    }
	// Close the client to release any resources such as local embedding functions
	defer func () {
		err = client . Close ()
		if err != nil {
			log . Fatalf ( "Error closing client: %s n " , err )
        }
    }()
	

	// Create a new collection with options. We don't provide an embedding function here, so the default embedding function will be used
	newCollection , err := client . NewCollection (
		context . TODO (),
        "test-collection" ,
		collection . WithMetadata ( "key1" , "value1" ),
		collection . WithHNSWDistanceFunction ( types . L2 ),
	)
	if err != nil {
		log . Fatalf ( "Error creating collection: %s n " , err )
	}

	// Create a new record set with to hold the records to insert
	rs , err := types . NewRecordSet (
		types . WithEmbeddingFunction ( newCollection . EmbeddingFunction ), // we pass the embedding function from the collection
		types . WithIDGenerator ( types . NewULIDGenerator ()),
	)
	if err != nil {
		log . Fatalf ( "Error creating record set: %s n " , err )
	}
	// Add a few records to the record set
	rs . WithRecord ( types . WithDocument ( "My name is John. And I have two dogs." ), types . WithMetadata ( "key1" , "value1" ))
	rs . WithRecord ( types . WithDocument ( "My name is Jane. I am a data scientist." ), types . WithMetadata ( "key2" , "value2" ))

	// Build and validate the record set (this will create embeddings if not already present)
	_ , err = rs . BuildAndValidate ( context . TODO ())
	if err != nil {
		log . Fatalf ( "Error validating record set: %s n " , err )
	}

	// Add the records to the collection
	_ , err = newCollection . AddRecords ( context . Background (), rs )
	if err != nil {
		log . Fatalf ( "Error adding documents: %s n " , err )
	}

	// Count the number of documents in the collection
	countDocs , qrerr := newCollection . Count ( context . TODO ())
	if qrerr != nil {
		log . Fatalf ( "Error counting documents: %s n " , qrerr )
	}

	// Query the collection
	fmt . Printf ( "countDocs: %v n " , countDocs ) //this should result in 2
	qr , qrerr := newCollection . Query ( context . TODO (), [] string { "I love dogs" }, 5 , nil , nil , nil )
	if qrerr != nil {
		log . Fatalf ( "Error querying documents: %s n " , qrerr )
	}
	fmt . Printf ( "qr: %v n " , qr . Documents [ 0 ][ 0 ]) //this should result in the document about dogs
}

发展

建造

make build

测试

make test

生成Chromadb API客户端

make generate 

皮棉

make lint-fix

本地服务器

注意：必须安装Docker

make server

参考

• 官方色度文档
• 云原始部署的色度舵图
• Chroma食谱以示例和食谱