Aufforderungen verwalten

Auf dieser Seite wird eine einheitliche Reihe von Funktionen zum Definieren, Speichern, Abrufen und Verwalten von Prompts in Ihrem Google Cloud -Projekt mit dem Vertex AI SDK-Modul für die Prompt-Verwaltung vorgestellt.

Übersicht

Vertex AI bietet Tools zum Verwalten von Prompt-Vorlagen und Prompt-Daten. Promptvorlagen können versioniert und mit generativen Modellen in Vertex AI verwendet werden. Jeder Prompt kann in Vertex AI Studio oder im Vertex AI SDK zusammengestellt und versioniert werden.

Die Prompt-Verwaltung im Vertex AI SDK bietet vollständigen Unternehmenssupport, einschließlich Unterstützung für vom Kunden verwaltete Verschlüsselungsschlüssel (Customer-Managed Encryption Keys, CMEK) und VPC Service Controls (VPCSC).

Funktionen zur Prompt-Verwaltung

Wenn Sie generative KI-Funktionen aus dem Vertex AI SDK verwenden möchten, gehen Sie so vor:

  1. Installieren Sie die neueste Version des Vertex AI SDK.

    pip install --upgrade google-cloud-aiplatform

  2. Erstellen Sie mit dem folgenden Python-Codebeispiel einen Client für generative KI:

        import vertexai
    from vertexai import types

    # Instantiate GenAI client from Vertex SDK
    # Replace with your project ID and location
    client = vertexai.Client(project='my-project', location='my-location')

Nachdem Sie einen Client für generative KI erstellt haben, können Sie die folgenden Funktionen zur Prompt-Verwaltung im Vertex AI SDK verwenden:

Lokalen Prompt erstellen

In diesem Abschnitt wird ein Beispiel dafür gezeigt, wie Sie eine types.Prompt-Variable definieren, die auf dieser Seite verwendet wird.

Die Klasse Prompt wird zum Definieren, Zusammenstellen und Verwenden von Prompts verwendet. Das Attribut prompt_data ist für die Klasse Prompt definiert und umfasst Folgendes:

Attribut

model

Erforderlich: Der Modellname.

contents

Erforderlich: Der Inhalt der Unterhaltung mit dem Modell. Es werden nur Prompts mit einem einzelnen Turn unterstützt.

generation_config

Optional: Generierungskonfiguration

tool_config

Optional: Diese Konfiguration wird für alle in der Anfrage bereitgestellten Tools freigegeben.

tools

Optional: Eine Liste von Tools, die das Modell möglicherweise verwendet, um die nächste Antwort zu generieren. Ein Tool ist ein Code, der es dem System ermöglicht, mit externen Systemen zu interagieren, um eine Aktion oder eine Reihe von Aktionen außerhalb des Wissens und Umfangs des Modells auszuführen.

safety_settings

Optional: Die Anfrageeinstellungen zum Blockieren unsicherer Inhalte, die für GenerateContentResponse.candidates erzwungen werden.

system_instruction

Optional: Die vom Nutzer bereitgestellten Systemanweisungen für das Modell.

variables

Optional: Wenn Ihr Prompt eine Vorlagenvariable enthält, geben Sie die Werte an, die für diese Variable verwendet werden sollen. Wenn der Aufforderungstext beispielsweise „Hallo, {name}“ lautet, Ihre Variablenliste sollte ein Dictionary mit allen möglichen Werten für die Variable „{name}“ enthalten. Beispiel:

        "variables": [
            {"name": {"text": "Alice"}},
            {"name": {"text": "Bob"}},
        ],

In diesem Codebeispiel wird gezeigt, wie Sie eine types.Prompt-Variable definieren.

  import vertexai
  from vertexai import types
  from google.genai import types

  prompt = types.Prompt(
      prompt_data=types.PromptData(
        contents=[genai_types.Content(parts=[genai_types.Part(text="Hello, {name}! How are you?")])],
        variables=[
          {"name": genai_types.Part(text="Alice")},
          {"name": genai_types.Part(text="Bob")},
        ],
        model="your-model",
      ),
  )

Prompt in einem Google Cloud -Projekt speichern

In diesem Abschnitt werden die Parameter und ein Beispiel dafür beschrieben, wie Sie einen Prompt in einem Google Cloud Projekt speichern.

Parameter

In dieser Tabelle werden die Parameter beschrieben, die von der Methode create verwendet werden:

Parameter

prompt

Die Daten für einen bestimmten Prompt.

config

Optional: Ein types.CreatePromptConfig-Objekt, das die Konfiguration zum Erstellen eines Prompts darstellt.

In dieser Tabelle werden die Parameter beschrieben, die von der Methode create_version verwendet werden:

Parameter

prompt

Erforderlich: Die Daten für einen bestimmten Prompt.

config

Optional: Ein types.CreatePromptConfig-Objekt, das die Konfiguration zum Erstellen einer Prompt-Version darstellt.

Ein Prompt wird von der Methode create_version zurückgegeben.

Beispiel

Wenn Sie einen Prompt in einem Google Cloud -Projekt speichern möchten, verwenden Sie die Methoden client.prompts.create und client.prompts.create_version.

Mit der Methode client.prompts.create wird eine Prompt-Ressource in einemGoogle Cloud -Projekt erstellt. Mit der Methode client.prompts.create_version wird eine Prompt-Version in dieser Ressource erstellt. Sie können in derGoogle Cloud -Konsole auf die Ressource zugreifen.

Die client.prompts.create-Methode verwendet ein Prompt-Objekt als Eingabe und erstellt einen Prompt im Google Cloud -Projekt. Für die Methode client.prompts.create_version muss auch prompt_id übergeben werden. Das ist die ID der Prompt-Ressource, unter der die Version erstellt werden soll. Es wird ein neues Prompt-Objekt zurückgegeben, das dem Google Cloud Projekt zugeordnet ist. Alle Aktualisierungen, die an einem Prompt-Objekt vorgenommen werden, sind lokal, bis create oder create_version aufgerufen wird.

Im folgenden Codebeispiel wird gezeigt, wie Sie einen Prompt und eine Prompt-Version speichern:

  # Save `Prompt` to a Google Cloud project.
  # Returns a new `Prompt` object associated with the saved prompt resource.
  prompt_resource = client.prompts.create(prompt=prompt)
  prompt_version_resource = client.prompts.create_version(prompt=prompt, prompt_id=prompt_resource.prompt_id)

Gespeicherten Prompt abrufen

In diesem Abschnitt werden die Parameter und ein Beispiel dafür beschrieben, wie Sie einen Prompt und eine Prompt-Version abrufen.

Dazu gibt es zwei Methoden: client.prompts.get und client.prompts.get_version.

Parameter

In dieser Tabelle werden die Parameter beschrieben, die von der Methode client.prompts.get verwendet werden:

Parameter

prompt_id

Erforderlich: Die ID des abzurufenden Prompts.

config

Optional: Ein types.GetPromptConfig-Objekt, das die Konfiguration zum Abrufen eines Prompts darstellt.

In dieser Tabelle werden die Parameter beschrieben, die von der Methode client.prompts.get_version verwendet werden:

Parameter

prompt_id

Erforderlich: Die ID des abzurufenden Prompts.

version_id

Erforderlich: Die ID der Prompt-Version, die Sie abrufen möchten.

config

Optional: Ein types.GetPromptConfig-Objekt, das die Konfiguration zum Abrufen eines Prompts darstellt.

Ein Prompt wird von den Methoden get und get_version zurückgegeben.

Beispiele

Verwenden Sie die Methode client.prompts.get, um einen Prompt abzurufen (zu laden), der im Google Cloud -Projekt gespeichert wurde. Diese Methode nimmt die Prompt-ID als Eingabe und gibt das entsprechende Prompt-Objekt zurück. In diesem Codebeispiel wird gezeigt, wie Sie einen gespeicherten Prompt laden:

  # Get prompt
  retrieved_prompt = client.prompts.get(prompt_id=prompt_resource.prompt_id)

Das folgende Codebeispiel zeigt, wie Sie eine Version eines Prompts abrufen.

  retrieved_prompt_version = client.prompts.get_version(prompt_id='your-prompt-id', version_id='your-prompt-version-id')

Der folgende Code zeigt, wie Sie Ihren Prompt so umwandeln, dass generate_content im generativen KI SDK aufgerufen wird.

  from google import genai
  from google.genai import types as genai_types

  genai_client = genai.Client(vertexai=True, project="my-project", location="my-location")

  response = genai_client.models.generate_content(
      model=retrieved_prompt.prompt_data.model,
      contents=retrieved_prompt.assemble_contents(),
  )

Prompts und Versionen auflisten

In diesem Abschnitt werden die Parameter und ein Beispiel für das Auflisten von Prompts und Prompt-Versionen vorgestellt.

Dazu gibt es zwei Methoden: client.prompts.list und client.prompts.list_versions.

Parameter

In dieser Tabelle werden die Parameter beschrieben, die von der Methode list verwendet werden:

Parameter

config

Optional: Ein types.ListPromptsConfig-Objekt, das die Konfiguration für das Auflisten von Prompts darstellt.

In dieser Tabelle werden die Parameter beschrieben, die von der Methode list_versions verwendet werden:

Parameter

prompt_id

Erforderlich: Die ID des Prompts, für den Versionen aufgeführt werden sollen.

config

Optional: Ein types.ListPromptsConfig-Objekt, das die Konfiguration für das Auflisten von Prompt-Versionen darstellt.

Sowohl die Methode list als auch die Methode list_versions geben ein Iterator von types.PromptRef-Objekten zurück. Der PromptRef enthält einen Verweis auf einen Prompt.

Beispiel

Wenn Sie die Prompt-ID und das Modell für alle in Ihrem Google Cloud Projekt gespeicherten Prompts aufrufen möchten, verwenden Sie die Methode list.

Das folgende Codebeispiel zeigt, wie Sie ein PromptRef für alle gespeicherten Prompts im aktuellen Projekt abrufen:

  prompt_refs = list(client.prompts.list())

  # Get a prompt from the list
  prompt1 = client.prompts.get(prompt_id=prompt_refs[0].prompt_id)

Im folgenden Codebeispiel wird gezeigt, wie Sie die Prompt- und Versions-IDs für alle im Prompt gespeicherten Prompt-Versionen auflisten:

  prompt_versions_metadata = client.prompts.list_versions(prompt_id="123456789")

  # Get a specific prompt version from the versions metadata list
  prompt1 = client.prompts.get_version(
      prompt_id=prompt_versions_metadata[0].prompt_id,
      version_id=prompt_versions_metadata[0].version_id
  )

Prompt löschen

In diesem Abschnitt werden die Parameter und ein Beispiel für das Löschen eines Prompts vorgestellt.

Dazu gibt es zwei Methoden: delete und delete_version.

Parameter

In dieser Tabelle werden die Parameter beschrieben, die von der Methode delete verwendet werden:

Parameter

prompt_id

Die ID des zu löschenden Prompts.

config

Optional: Ein types.DeletePromptConfig-Objekt, das die Konfiguration zum Löschen eines Prompts darstellt.

In dieser Tabelle werden die Parameter beschrieben, die von der Methode delete_version verwendet werden:

Parameter

prompt_id

Die ID des Prompts, aus dem eine Version gelöscht werden soll.

version_id

Die Version des Prompts, die gelöscht werden soll.

config

Optional: Ein types.DeletePromptConfig-Objekt, das die Konfiguration zum Löschen einer Prompt-Version darstellt.

Beispiele

Wenn Sie einen Prompt und alle seine Versionen löschen möchten, verwenden Sie die Methode delete.

  client.prompts.delete(prompt_id=retrieved_prompt.prompt_id)

Wenn Sie eine bestimmte Version aus einer Prompt-Ressource löschen möchten, verwenden Sie die Methode delete_version.

  client.prompts.delete_version(prompt_id=retrieved_prompt.prompt_id, version_id='your-version-id')

Prompt-Version wiederherstellen

In diesem Abschnitt werden die Parameter und ein Beispiel für die Wiederherstellung einer Prompt-Version vorgestellt.

Parameter

In dieser Tabelle werden die Parameter beschrieben, die von der Methode restore_version verwendet werden:

Parameter

prompt_id

Die ID für einen bestimmten Prompt.

version_id

Die Version des Prompts, die wiederhergestellt werden soll.

config

Die Konfiguration zum Wiederherstellen einer Prompt-Version.

Ein Prompt-Objekt wird von der Methode restore_version zurückgegeben.

Beispiel

Eine Prompt-Ressource enthält auch einen Versionsverlauf, in dem zuvor gespeicherte Versionen des Prompts gespeichert werden. Mit der Methode restore_version() können Sie eine ältere Version als die neueste Version des Prompts wiederherstellen. Dadurch wird ein Prompt-Objekt zurückgegeben.

  # Restore to prompt version id 1
  restored_prompt = client.prompts.restore_version(prompt_id=retrieved_prompt.prompt_id, version_id='1')

Nächste Schritte