Corpora

Methode: corpora.create

Erstellt eine leere Corpus.

Endpunkt

post https://generativelanguage.googleapis.com/v1beta/corpora >
>

Anfragetext

Der Anfragetext enthält eine Instanz von Corpus.

Felder
name string

Nicht veränderbar. ID. Der Name der Corpus-Ressource. Die ID (Name ohne das Präfix „corpora/“) darf bis zu 40 Zeichen enthalten, die alphanumerisch in Kleinschreibung oder Bindestriche (-) sein dürfen. Die ID darf nicht mit einem Bindestrich beginnen oder enden. Wenn der Name beim Erstellen leer ist, wird ein eindeutiger Name aus displayName zusammen mit einem zufälligen 12‑stelligen Suffix abgeleitet. Beispiel: corpora/my-awesome-corpora-123a456b789c

displayName string

Optional. Der für Menschen lesbare Anzeigename für Corpus. Der Anzeigename darf maximal 512 Zeichen lang sein, einschließlich Leerzeichen. Beispiel: „Docs on Semantic Retriever“

Antworttext

Bei Erfolg enthält der Antworttext eine neu erstellte Instanz von Corpus.

Methode: corpora.query

Führt eine semantische Suche in einem Corpus durch.

Endpunkt

post https://generativelanguage.googleapis.com/v1beta/{name=corpora/*}:query >
>

Pfadparameter

name string

Erforderlich. Der Name des abzufragenden Corpus. Beispiel: corpora/my-corpus-123 Sie hat das Format corpora/{corpora}.

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

Felder
query string

Erforderlich. Suchstring für die semantische Suche.

metadataFilters[] object (MetadataFilter)

Optional. Nach Chunk- und Document-Metadaten filtern Jedes MetadataFilter-Objekt sollte einem eindeutigen Schlüssel entsprechen. Mehrere MetadataFilter-Objekte werden durch logische AND-Anweisungen verknüpft.

Beispielabfrage auf Dokumentebene: (year >= 2020 OR year < 2010) AND (genre = drama OR genre = action)

MetadataFilter-Objektliste: metadataFilters = [ {key = "document.custom_metadata.year" conditions = [{int_value = 2020, operation = GREATER_EQUAL}, {int_value = 2010, operation = LESS}]}, {key = "document.custom_metadata.year" conditions = [{int_value = 2020, operation = GREATER_EQUAL}, {int_value = 2010, operation = LESS}]}, {key = "document.custom_metadata.genre" conditions = [{stringValue = "drama", operation = EQUAL}, {stringValue = "action", operation = EQUAL}]}]

Beispielabfrage auf Chunks-Ebene für einen numerischen Wertebereich: (year > 2015 AND year <= 2020)

MetadataFilter Objektliste: metadataFilters = [ {key = "chunk.custom_metadata.year" conditions = [{int_value = 2015, operation = GREATER}]}, {key = "chunk.custom_metadata.year" conditions = [{int_value = 2020, operation = LESS_EQUAL}]}]

Hinweis: „AND“-Bedingungen für denselben Schlüssel werden nur für numerische Werte unterstützt. Bei Stringwerten werden nur „OR“-Bedingungen für denselben Schlüssel unterstützt.

resultsCount integer

Optional. Die maximale Anzahl der zurückzugebenden Chunk. Der Dienst gibt möglicherweise weniger Chunk zurück.

Wenn nicht angegeben, werden maximal 10 Chunk zurückgegeben. Die maximal angegebene Anzahl von Ergebnissen beträgt 100.

Antworttext

Antwort von corpora.query mit einer Liste relevanter Chunks.

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

Felder
relevantChunks[] object (RelevantChunk)

Die relevanten Chunks.

JSON-Darstellung 
{
  "relevantChunks": [
    {
      object (RelevantChunk)
    }
  ]
}

Methode: corpora.list

Listet alle Corpora auf, die dem Nutzer gehören.

Endpunkt

get https://generativelanguage.googleapis.com/v1beta/corpora >
>

Abfrageparameter

pageSize integer

Optional. Die maximale Anzahl von Corpora, die (pro Seite) zurückgegeben werden sollen. Der Dienst gibt möglicherweise weniger Corpora zurück.

Wenn nicht angegeben, werden maximal 10 Corpora zurückgegeben. Die maximale Größe beträgt 20 Corpora pro Seite.

pageToken string

Optional. Ein Seitentoken, das von einem vorherigen corpora.list-Aufruf empfangen wurde.

Geben Sie das in der Antwort zurückgegebene nextPageToken als Argument für die nächste Anfrage an, um die nächste Seite abzurufen.

Beim Paginieren müssen alle anderen für corpora.list bereitgestellten Parameter mit dem Aufruf übereinstimmen, der das Seitentoken bereitgestellt hat.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Antwort von corpora.list mit einer paginierten Liste von Corpora. Die Ergebnisse werden nach aufsteigendem corpus.create_time sortiert.

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

Felder
corpora[] object (Corpus)

Die zurückgegebenen Korpora.

nextPageToken string

Ein Token, das als pageToken gesendet werden kann, um die nächste Seite abzurufen. Wenn dieses Feld weggelassen wird, gibt es keine weiteren Seiten.

JSON-Darstellung 
{
  "corpora": [
    {
      object (Corpus)
    }
  ],
  "nextPageToken": string
}

Methode: corpora.get

Ruft Informationen zu einem bestimmten Corpus ab.

Endpunkt

get https://generativelanguage.googleapis.com/v1beta/{name=corpora/*} >
>

Pfadparameter

name string

Erforderlich. Der Name der Corpus. Beispiel: corpora/my-corpus-123 Sie hat das Format corpora/{corpora}.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Wenn der Vorgang erfolgreich abgeschlossen wurde, enthält der Antworttext eine Instanz von Corpus.

Methode: corpora.patch

Aktualisiert ein Corpus.

Endpunkt

patch https://generativelanguage.googleapis.com/v1beta/{corpus.name=corpora/*} > >

PATCH https://generativelanguage.googleapis.com/v1beta/{corpus.name=corpora/*}

Pfadparameter

corpus.name string

Nicht veränderbar. ID. Der Name der Corpus-Ressource. Die ID (Name ohne das Präfix „corpora/“) darf bis zu 40 Zeichen enthalten, die alphanumerisch in Kleinschreibung oder Bindestriche (-) sein dürfen. Die ID darf nicht mit einem Bindestrich beginnen oder enden. Wenn der Name beim Erstellen leer ist, wird ein eindeutiger Name aus displayName zusammen mit einem zufälligen 12‑stelligen Suffix abgeleitet. Beispiel: corpora/my-awesome-corpora-123a456b789c Sie hat das Format corpora/{corpora}.

Abfrageparameter

updateMask string (FieldMask format)

Erforderlich. Die Liste der zu aktualisierenden Felder. Derzeit wird nur die Aktualisierung von displayName unterstützt.

Dies ist eine durch Kommas getrennte Liste vollständig qualifizierter Feldnamen. Beispiel: "user.displayName,photo".

Anfragetext

Der Anfragetext enthält eine Instanz von Corpus.

Felder
displayName string

Optional. Der für Menschen lesbare Anzeigename für Corpus. Der Anzeigename darf maximal 512 Zeichen lang sein, einschließlich Leerzeichen. Beispiel: „Docs on Semantic Retriever“

Antworttext

Wenn der Vorgang erfolgreich abgeschlossen wurde, enthält der Antworttext eine Instanz von Corpus.

Methode: corpora.delete

Löscht einen Corpus.

Endpunkt

delete https://generativelanguage.googleapis.com/v1beta/{name=corpora/*}

Pfadparameter

name string

Erforderlich. Der Ressourcenname der Corpus. Beispiel: corpora/my-corpus-123 Sie hat das Format corpora/{corpora}.

Abfrageparameter

force boolean

Optional. Wenn auf „true“ gesetzt, werden auch alle Documents und Objekte, die mit diesem Corpus verknüpft sind, gelöscht.

Wenn „false“ (Standardeinstellung), wird ein FAILED_PRECONDITION-Fehler zurückgegeben, wenn Corpus Document enthält.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Wenn der Vorgang erfolgreich abgeschlossen wurde, ist der Antworttext ein leeres JSON-Objekt.

REST-Ressource: corpora.permissions

Ressource: Permission

Mit einer Berechtigungsressource wird Nutzern, Gruppen oder der ganzen Welt Zugriff auf die PaLM API-Ressource (z.B. ein optimiertes Modell, ein Korpus) gewährt.

Eine Rolle ist eine Sammlung von zulässigen Vorgängen, mit denen Nutzer bestimmte Aktionen für PaLM API-Ressourcen ausführen können. Damit sie für Nutzer, Gruppen oder Dienstkonten verfügbar sind, weisen Sie Rollen zu. Wenn Sie eine Rolle zuweisen, gewähren Sie die Berechtigungen, die diese Rolle enthält.

Es gibt drei konzentrische Rollen. Jede Rolle ist eine Obermenge der zulässigen Vorgänge der vorherigen Rolle:

  • Der Leser kann die Ressource (z. B. abgestimmtes Modell, Korpus) für die Inferenz verwenden.
  • Der Autor hat die Berechtigungen des Lesers und kann zusätzlich bearbeiten und freigeben.
  • Der Inhaber hat Schreibberechtigungen und kann die Datei außerdem löschen.
Felder
name string

Nur Ausgabe. ID. Der Name der Berechtigung. Beim Erstellen wird ein eindeutiger Name generiert. Beispiele: tunedModels/{tunedModel}/permissions/{permission} corpora/{corpus}/permissions/{permission} Nur Ausgabe.

granteeType enum (GranteeType)

Optional. Nicht veränderbar. Der Typ des Lizenznehmers.

emailAddress string

Optional. Nicht veränderbar. Die E-Mail-Adresse des Nutzers oder der Gruppe, auf die sich diese Berechtigung bezieht. Das Feld ist nicht festgelegt, wenn der Berechtigungsempfänger „JEDER“ ist.

role enum (Role)

Erforderlich. Die Rolle, die durch diese Berechtigung gewährt wird.

JSON-Darstellung 
{
  "name": string,
  "granteeType": enum (GranteeType),
  "emailAddress": string,
  "role": enum (Role)
}

GranteeType

Definiert die Typen des Empfängers dieser Berechtigung.

Enums
GRANTEE_TYPE_UNSPECIFIED Der Standardwert. Dieser Wert wird nicht verwendet.
USER Stellt einen Nutzer dar. Wenn diese Option festgelegt ist, müssen Sie die E-Mail-Adresse des Nutzers angeben.
GROUP Stellt eine Gruppe dar. Wenn diese Option festgelegt ist, müssen Sie die E-Mail-Adresse für die Gruppe angeben.
EVERYONE Steht für den Zugriff für alle. Es sind keine zusätzlichen Informationen erforderlich.

Rolle

Definiert die Rolle, die durch diese Berechtigung gewährt wird.

Enums
ROLE_UNSPECIFIED Der Standardwert. Dieser Wert wird nicht verwendet.
OWNER Der Inhaber kann die Ressource verwenden, aktualisieren, freigeben und löschen.
WRITER Der Autor kann die Ressource verwenden, aktualisieren und teilen.
READER Der Leser kann die Ressource verwenden.

MetadataFilter

Vom Nutzer bereitgestellter Filter, um den Abruf anhand von Metadatenwerten auf Chunk- oder Document-Ebene einzuschränken. Beispiel (genre = drama ODER genre = action): key = "document.custom_metadata.genre" conditions = [{stringValue = "drama", operation = EQUAL}, {stringValue = "action", operation = EQUAL}]

Felder
key string

Erforderlich. Der Schlüssel der Metadaten, nach denen gefiltert werden soll.

conditions[] object (Condition)

Erforderlich. Die Conditions für den angegebenen Schlüssel, die diesen Filter auslösen. Mehrere Condition werden durch logische OR-Operatoren verknüpft.

JSON-Darstellung 
{
  "key": string,
  "conditions": [
    {
      object (Condition)
    }
  ]
}

Bedingung

Filterbedingung, die auf einen einzelnen Schlüssel angewendet wird.

Felder
operation enum (Operator)

Erforderlich. Operator, der auf das angegebene Schlüssel/Wert-Paar angewendet wird, um die Bedingung auszulösen.

value Union type
Der Werttyp muss mit dem Werttyp übereinstimmen, der im Feld für den entsprechenden Schlüssel definiert ist. Wenn die Wertetypen nicht übereinstimmen, ist das Ergebnis eine leere Menge. Wenn der CustomMetadata den Werttyp StringList hat, sollte für die Filterbedingung string_value in Kombination mit einem INCLUDES- oder EXCLUDES-Vorgang verwendet werden. Andernfalls ist das Ergebnis ebenfalls eine leere Menge. Für value ist nur einer der folgenden Werte zulässig:
stringValue string

Der Stringwert, nach dem die Metadaten gefiltert werden sollen.

numericValue number

Der numerische Wert, nach dem die Metadaten gefiltert werden sollen.

JSON-Darstellung 
{
  "operation": enum (Operator),

  // value
  "stringValue": string,
  "numericValue": number
  // Union type
}

Operator

Definiert die gültigen Operatoren, die auf ein Schlüssel/Wert-Paar angewendet werden können.

Enums
OPERATOR_UNSPECIFIED Der Standardwert. Dieser Wert wird nicht verwendet.
LESS Wird von „numeric“ unterstützt.
LESS_EQUAL Wird von „numeric“ unterstützt.
EQUAL Wird von numerischen und String-Typen unterstützt.
GREATER_EQUAL Wird von „numeric“ unterstützt.
GREATER Wird von „numeric“ unterstützt.
NOT_EQUAL Wird von numerischen und String-Typen unterstützt.
INCLUDES Wird nur von String unterstützt, wenn der CustomMetadata-Werttyp für den angegebenen Schlüssel ein stringListValue hat.
EXCLUDES Wird nur von String unterstützt, wenn der CustomMetadata-Werttyp für den angegebenen Schlüssel ein stringListValue hat.

RelevantChunk

Die Informationen für einen Chunk, die für eine Anfrage relevant sind.

Felder
chunkRelevanceScore number

Chunk Relevanz für die Anfrage.

chunk object (Chunk)

Chunk, die der Anfrage zugeordnet sind.

document object (Document)

Document, die dem Chunk zugeordnet ist.

JSON-Darstellung 
{
  "chunkRelevanceScore": number,
  "chunk": {
    object (Chunk)
  },
  "document": {
    object (Document)
  }
}

REST-Ressource: corpora

Ressource: Korpus

Eine Corpus ist eine Sammlung von Documents. In einem Projekt können bis zu fünf Korpora erstellt werden.

Felder
name string

Nicht veränderbar. ID. Der Name der Corpus-Ressource. Die ID (Name ohne das Präfix „corpora/“) darf bis zu 40 Zeichen enthalten, die alphanumerisch in Kleinschreibung oder Bindestriche (-) sein dürfen. Die ID darf nicht mit einem Bindestrich beginnen oder enden. Wenn der Name beim Erstellen leer ist, wird ein eindeutiger Name aus displayName zusammen mit einem zufälligen 12‑stelligen Suffix abgeleitet. Beispiel: corpora/my-awesome-corpora-123a456b789c

displayName string

Optional. Der für Menschen lesbare Anzeigename für Corpus. Der Anzeigename darf maximal 512 Zeichen lang sein, einschließlich Leerzeichen. Beispiel: „Docs on Semantic Retriever“

createTime string (Timestamp format)

Nur Ausgabe. Der Zeitstempel für die Erstellung von Corpus.

Verwendet RFC 3339. Die generierte Ausgabe wird immer Z-normalisiert und verwendet 0, 3, 6 oder 9 Nachkommastellen. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".

updateTime string (Timestamp format)

Nur Ausgabe. Der Zeitstempel der letzten Aktualisierung von Corpus.

Verwendet RFC 3339. Die generierte Ausgabe wird immer Z-normalisiert und verwendet 0, 3, 6 oder 9 Nachkommastellen. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".

JSON-Darstellung 
{
  "name": string,
  "displayName": string,
  "createTime": string,
  "updateTime": string
}