CohereCompatible with Milvus 2.6.x

Dieses Thema beschreibt, wie Sie die Cohere-Einbettungsfunktionen in Milvus konfigurieren und verwenden.

Wählen Sie ein Einbettungsmodell

Milvus unterstützt die von Cohere bereitgestellten Einbettungsmodelle. Nachfolgend finden Sie die derzeit verfügbaren Einbettungsmodelle zur schnellen Orientierung:

Modell Name	Abmessungen	Max. Token	Beschreibung
einbetten-englisch-v3.0	1,024	512	Ein Modell, mit dem Text klassifiziert oder in Einbettungen umgewandelt werden kann. Nur Englisch.
einbetten-mehrsprachig-v3.0	1,024	512	Bietet Unterstützung für mehrsprachige Klassifizierung und Einbettung. Siehe unterstützte Sprachen hier.
embed-english-light-v3.0	384	512	Eine kleinere, schnellere Version von embed-english-v3.0. Fast genauso leistungsfähig, aber viel schneller. Nur Englisch.
einbetten-mehrsprachig-leicht-v3.0	384	512	Eine kleinere, schnellere Version von embed-multilingual-v3.0. Fast genauso leistungsfähig, aber viel schneller. Unterstützt mehrere Sprachen.
embed-englisch-v2.0	4,096	512	Älteres Einbettungsmodell, mit dem Text klassifiziert oder in Einbettungen umgewandelt werden kann. Nur Englisch.
einbetten-englisch-leicht-v2.0	1,024	512	Eine kleinere, schnellere Version von embed-english-v2.0. Fast genauso leistungsfähig, aber viel schneller. Nur Englisch.
einbetten-mehrsprachig-v2.0	768	256	Bietet Unterstützung für mehrsprachige Klassifizierung und Einbettung. Siehe unterstützte Sprachen hier.

Details finden Sie in Cohere's Embed Models.

Anmeldeinformationen konfigurieren

Milvus muss Ihren Cohere API-Schlüssel kennen, bevor es Einbettungen anfordern kann. Milvus bietet zwei Methoden zur Konfiguration von Anmeldeinformationen:

• Konfigurationsdatei (empfohlen): Speichern Sie den API-Schlüssel in milvus.yaml, damit er bei jedem Neustart und Knoten automatisch übernommen wird.

• Umgebungsvariablen: Injizieren Sie den Schlüssel zum Zeitpunkt der Bereitstellung - ideal für Docker Compose.

Entscheiden Sie sich für eine der beiden Methoden: Die Konfigurationsdatei ist auf Bare-Metal- und VM-Systemen einfacher zu verwalten, während die Umgebungsvariablen-Route für Container-Workflows geeignet ist.

Option 1: Konfigurationsdatei (empfohlen & höhere Priorität)

Bewahren Sie Ihre API-Schlüssel in milvus.yaml auf; Milvus liest sie beim Start und setzt jede Umgebungsvariable für denselben Anbieter außer Kraft.

1. **Deklarieren Sie Ihre Schlüssel unter credential:

   Sie können einen oder mehrere API-Schlüssel auflisten - geben Sie jedem einen Namen, den Sie erfinden und später referenzieren werden.

   # milvus.yaml
   credential:
     apikey_dev:            # dev environment
       apikey: <YOUR_DEV_KEY>
     apikey_prod:           # production environment
       apikey: <YOUR_PROD_KEY>    
   

   Wenn Sie die API-Schlüssel hier angeben, bleiben sie über Neustarts hinweg bestehen und Sie können die Schlüssel einfach durch Ändern einer Bezeichnung wechseln.

2. Teilen Sie Milvus mit, welchen Schlüssel es für OpenAI-Aufrufe verwenden soll

   In der gleichen Datei verweisen Sie den Cohere-Anbieter auf das Label, das er verwenden soll.

   function:
     textEmbedding:
       providers:
         cohere:
           credential: apikey_dev      # ← choose any label you defined above
           # url: https://api.cohere.com/v2/embed   # (optional) custom url
   

   Dies bindet einen bestimmten Schlüssel an jede Anfrage, die Milvus an den Cohere-Embedding-Endpunkt sendet.

Option 2: Umgebungsvariable

Verwenden Sie diese Methode, wenn Sie Milvus mit Docker Compose ausführen und es vorziehen, Geheimnisse aus Dateien und Images herauszuhalten.

Milvus greift nur dann auf die Umgebungsvariable zurück, wenn unter milvus.yaml kein Schlüssel für den Anbieter gefunden wird.

Variable	Erforderlich	Beschreibung
MILVUSAI_COHERE_API_KEY	Ja	Ihr gültiger Cohere-API-Schlüssel.

Setzen Sie in Ihrer Datei docker-compose.yaml die Umgebungsvariable MILVUSAI_COHERE_API_KEY.

# docker-compose.yaml (standalone service section)
standalone:
  # ... other configurations ...
  environment:
    # ... other environment variables ...
    # Set the environment variable pointing to the OpenAI API key inside the container
    MILVUSAI_COHERE_API_KEY: <MILVUSAI_COHERE_API_KEY>

Der Block environment: injiziert den Schlüssel nur in den Milvus-Container und lässt Ihr Host-Betriebssystem unberührt. Weitere Informationen finden Sie unter Konfigurieren von Milvus mit Docker Compose.

Einbettungsfunktion verwenden

Sobald die Anmeldeinformationen konfiguriert sind, folgen Sie diesen Schritten, um Einbettungsfunktionen zu definieren und zu verwenden.

Schritt 1: Definieren Sie Schemafelder

Um eine Einbettungsfunktion zu verwenden, erstellen Sie eine Sammlung mit einem bestimmten Schema. Dieses Schema muss mindestens drei notwendige Felder enthalten:

• Das Primärfeld, das jede Entität in einer Sammlung eindeutig identifiziert.

• Ein Skalarfeld, das die einzubettenden Rohdaten speichert.

• Ein Vektorfeld, das für die Speicherung von Vektoreinbettungen reserviert ist, die die Funktion für das Skalarfeld erzeugen wird.

Das folgende Beispiel definiert ein Schema mit einem Skalarfeld "document" zum Speichern von Textdaten und einem Vektorfeld "dense" zum Speichern von Einbettungen, die vom Funktionsmodul erzeugt werden. Denken Sie daran, die Vektordimension (dim) so einzustellen, dass sie der Ausgabe des von Ihnen gewählten Einbettungsmodells entspricht.

from pymilvus import MilvusClient, DataType, Function, FunctionType

# Initialize Milvus client
client = MilvusClient(
    uri="http://localhost:19530",
)

# Create a new schema for the collection
schema = client.create_schema()

# Add primary field "id"
schema.add_field("id", DataType.INT64, is_primary=True, auto_id=False)

# Add scalar field "document" for storing textual data
schema.add_field("document", DataType.VARCHAR, max_length=9000)

# Add vector field "dense" for storing embeddings.
# IMPORTANT: Set dim to match the exact output dimension of the embedding model.
schema.add_field("dense", DataType.FLOAT_VECTOR, dim=1024)

Schritt 2: Einbettungsfunktion zum Schema hinzufügen

Das Function-Modul in Milvus wandelt Rohdaten, die in einem Skalarfeld gespeichert sind, automatisch in Einbettungen um und speichert sie in dem explizit definierten Vektorfeld.

Das folgende Beispiel fügt ein Funktionsmodul (cohere_func) hinzu, das das Skalarfeld "document" in Einbettungen umwandelt und die resultierenden Vektoren in dem zuvor definierten Vektorfeld "dense" speichert.

Sobald Sie Ihre Einbettungsfunktion definiert haben, fügen Sie sie zu Ihrem Sammelschema hinzu. Dadurch wird Milvus angewiesen, die angegebene Einbettungsfunktion zur Verarbeitung und Speicherung von Einbettungen aus Ihren Textdaten zu verwenden.

# Define embedding function specifically for embedding model provider
text_embedding_function = Function(
    name="cohere_func",                                 # Unique identifier for this embedding function
    function_type=FunctionType.TEXTEMBEDDING,           # Indicates a text embedding function
    input_field_names=["document"],                     # Scalar field(s) containing text data to embed
    output_field_names=["dense"],                       # Vector field(s) for storing embeddings
    params={                                            # Provider-specific embedding parameters (function-level)
        "provider": "cohere",                           # Must be set to "cohere"
        "model_name": "embed-english-v3.0",             # Specifies the embedding model to use
        # Optional parameters:
        # "credential": "apikey_dev",               # Optional: Credential label specified in milvus.yaml
        # "url": "https://api.cohere.com/v2/embed",     # Defaults to the official endpoint if omitted
        # "truncate": "NONE",                           # Specifies how the API will handle inputs longer than the maximum token length.
    }
)

# Add the configured embedding function to your existing collection schema
schema.add_function(text_embedding_function)

Nächste Schritte

Nachdem Sie die Einbettungsfunktion konfiguriert haben, finden Sie in der Funktionsübersicht weitere Anleitungen zur Indexkonfiguration, Beispiele für das Einfügen von Daten und semantische Suchvorgänge.