Corpora

REST-Ressource: corpora

Ressource: Korpus

Eine Corpus ist eine Sammlung von Documents. Mit einem Projekt können bis zu 5 Korpora erstellt werden.

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

Nicht veränderbar. Kennung. Der Ressourcenname Corpus. Die ID (Name ohne das Präfix „corpora/“) kann bis zu 40 Zeichen enthalten, also kleingeschriebene alphanumerische Zeichen oder Bindestriche (-). Die ID darf nicht mit einem Bindestrich beginnen oder enden. Wenn der Name beim Erstellen leer ist, wird ein eindeutiger Name aus displayName mit einem zufälligen 12-Zeichen-Suffix abgeleitet. Beispiel: corpora/my-awesome-corpora-123a456b789c

displayName string

Optional. Der visuell lesbare Anzeigename für die Corpus. Der Anzeigename darf höchstens 512 Zeichen (einschließlich Leerzeichen) lang sein. Beispiel: „Dokumente im Semantic Retriever“

createTime string (Timestamp format)

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

Ein Zeitstempel im Format RFC3339 UTC "Zulu" mit einer Auflösung im Nanosekundenbereich und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".

updateTime string (Timestamp format)

Nur Ausgabe. Der Zeitstempel der letzten Aktualisierung von Corpus.

Ein Zeitstempel im Format RFC3339 UTC "Zulu" mit einer Auflösung im Nanosekundenbereich und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".

Methode: corpora.create

Erstellt eine leere Corpus.

Endpunkt

<ph type="x-smartling-placeholder"></ph> Beitrag https://generativelanguage.googleapis.com/v1beta/corpora
.

Anfragetext

Der Anfragetext enthält eine Instanz von Corpus.

Antworttext

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

Methode: corpora.list

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

Endpunkt

<ph type="x-smartling-placeholder"></ph> erhalten 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 höchstens 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 sind nach aufsteigendem corpus.create_time sortiert.

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

Felder
corpora[] object (Corpus)

Die zurückgegebene Korpora.

nextPageToken string

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

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

Methode: corpora.query

Führt eine semantische Suche über ein Corpus durch.

Endpunkt

<ph type="x-smartling-placeholder"></ph> Beitrag 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:

<ph type="x-smartling-placeholder">
</ph> Felder
query string

Erforderlich. Abfragestring für die semantische Suche

metadataFilters[] object (MetadataFilter)

Optional. Filtern Sie nach den Metadaten Chunk und Document. Jedes MetadataFilter-Objekt sollte einem eindeutigen Schlüssel entsprechen. Mehrere MetadataFilter-Objekte werden durch ein logisches AND verbunden.

Beispielabfrage auf Dokumentebene: (Jahr >= 2020 OR Jahr < 2010) AND (Genre = Drama OR Genre = Action)

MetadataFilter-Objektliste: metadataFilters = [ {key = "document.custom_metadata.year" Bedingungen = [{int_value = 2020, Vorgang = GREATER_EQUAL}, {int_value = 2010, Vorgang = WENIGER}]}, {key = "document.custom_metadata.year" Bedingungen = [{int_value = 2020, Vorgang = GREATER_EQUAL}, {int_value = 2010, Vorgang = WENIGER}]}, {key = "document.custom_metadata.genre" Bedingungen = [{stringValue = "drama", Operation = EQUAL}, {stringValue = "Aktion", Vorgang = EQUAL}]}]

Beispielabfrage auf Chunk-Ebene für einen numerischen Wertebereich: (Jahr > 2015 UND Jahr <= 2020)

MetadataFilter-Objektliste: metadataFilters = [ {key = "chunk.custom_metadata.year" conditions = [{int_value = 2015, operation = GREATER}]}, {key = &quot;chunk.custom_metadata.year&quot; Bedingungen = [{int_value = 2020, Vorgang = LESS_EQUAL}]}]

Hinweis: UND-Zeichen für denselben Schlüssel werden nur bei numerischen Werten unterstützt. Bei Stringwerten wird für denselben Schlüssel nur „OR“ unterstützt.

resultsCount integer

Optional. Die maximale Anzahl von Chunks, die zurückgegeben werden sollen. Der Dienst gibt möglicherweise weniger Chunks zurück.

Wenn nicht angegeben, werden höchstens 10 Chunks zurückgegeben. Es sind maximal 100 Ergebnisse angegeben.

Antworttext

Antwort von corpora.query mit einer Liste relevanter Blöcke.

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

Felder
relevantChunks[] object (RelevantChunk)

Die relevanten Blöcke.

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

Methode: corpora.get

Ruft Informationen zu einer bestimmten Corpus ab.

Endpunkt

<ph type="x-smartling-placeholder"></ph> erhalten 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 eine Corpus.

Endpunkt

<ph type="x-smartling-placeholder"></ph> 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. Kennung. Der Ressourcenname Corpus. Die ID (Name ohne das Präfix „corpora/“) kann bis zu 40 Zeichen enthalten, also kleingeschriebene alphanumerische Zeichen oder Bindestriche (-). Die ID darf nicht mit einem Bindestrich beginnen oder enden. Wenn der Name beim Erstellen leer ist, wird ein eindeutiger Name aus displayName mit einem zufälligen 12-Zeichen-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 unterstützt dies nur die Aktualisierung von displayName.

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

Anfragetext

Der Anfragetext enthält eine Instanz von Corpus.

Antworttext

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

Methode: corpora.delete

Löscht ein Corpus.

Endpunkt

<ph type="x-smartling-placeholder"></ph> Löschen https://generativelanguage.googleapis.com/v1beta/{name=corpora/*}
.

Pfadparameter

name string

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

Abfrageparameter

force boolean

Optional. Wenn die Richtlinie auf „true“ gesetzt ist, werden alle Documents und Objekte im Zusammenhang mit dieser Corpus ebenfalls gelöscht.

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

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Wenn der Vorgang erfolgreich ist, ist der Antworttext leer.

REST-Ressource: corpora.permissions

Ressource: Berechtigung

Die Berechtigungsressource gewährt Nutzern, Gruppen oder dem Rest der Welt Zugriff auf die PaLM API-Ressource (z.B. ein abgestimmtes Modell, Korpus).

Eine Rolle ist eine Sammlung zulässiger Vorgänge, mit denen Nutzer bestimmte Aktionen für PaLM API-Ressourcen ausführen können. Weisen Sie Rollen zu, um sie Nutzern, Gruppen oder Dienstkonten zur Verfügung zu stellen. Wenn Sie eine Rolle zuweisen, gewähren Sie damit die Berechtigungen, die in der Rolle enthalten sind.

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

  • Leser können die Ressource (z.B. abgestimmtes Modell, Korpus) für Inferenz verwenden
  • Autor verfügt über Leseberechtigungen und kann zusätzlich bearbeiten und freigeben.
  • Eigentümer verfügt über Schreibberechtigungen und kann zusätzlich löschen
JSON-Darstellung 
{
  "name": string,
  "granteeType": enum (GranteeType),
  "emailAddress": string,
  "role": enum (Role)
}
Felder
name string

Nur Ausgabe. Kennung. Der Name der Berechtigung. Bei der Erstellung 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 Empfängers einer Förderung.

emailAddress string

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

role enum (Role)

Erforderlich. Die durch diese Berechtigung gewährte Rolle.

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 dies festgelegt ist, müssen Sie emailAddress für den Nutzer angeben.
GROUP Stellt eine Gruppe dar. Wenn dies festgelegt ist, müssen Sie emailAddress für die Gruppe angeben.
EVERYONE Stellt Zugriff für alle Nutzer dar. Es sind keine zusätzlichen Informationen erforderlich.

Rolle

Definiert die durch diese Berechtigung gewährte Rolle.

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 freigeben.
READER Leser können die Ressource verwenden.

MetadataFilter

Vom Nutzer bereitgestellter Filter, um den Abruf auf Basis der Metadatenwerte der Ebene Chunk oder Document zu beschränken. Beispiel (Genre = Drama ODER Genre = Aktion): key = "document.custom_metadata.genre" Bedingungen = [{stringValue = "drama", Operation = EQUAL}, {stringValue = "Aktion", Vorgang = EQUAL}]

JSON-Darstellung 
{
  "key": string,
  "conditions": [
    {
      object (Condition)
    }
  ]
}
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 Conditions werden durch logische ODERs verbunden.

Bedingung

Filterbedingung für einen einzelnen Schlüssel.

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

  // Union field value can be only one of the following:
  "stringValue": string,
  "numericValue": number
  // End of list of possible types for union field value.
}
Felder
operation enum (Operator)

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

Union-Feld value. Der Werttyp muss mit dem Werttyp übereinstimmen, der im Feld für den entsprechenden Schlüssel definiert wurde. Wenn die Werttypen nicht konsistent sind, ist das Ergebnis ein leerer Satz. Wenn CustomMetadata einen StringList-Werttyp hat, sollte für die Filterbedingung string_value in Kombination mit einem INCLUDES/EXCLUDES-Vorgang verwendet werden. Andernfalls ist das Ergebnis ebenfalls ein leerer Satz. 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.

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 Unterstützt durch numerische Werte.
LESS_EQUAL Unterstützt durch numerische Werte.
EQUAL Unterstützt von numerischem & .
GREATER_EQUAL Unterstützt durch numerische Werte.
GREATER Unterstützt durch numerische Werte.
NOT_EQUAL Unterstützt von numerischem & .
INCLUDES Wird nur von einem String unterstützt, wenn der Werttyp CustomMetadata für den angegebenen Schlüssel den Wert stringListValue hat.
EXCLUDES Wird nur von einem String unterstützt, wenn der Werttyp CustomMetadata für den angegebenen Schlüssel den Wert stringListValue hat.

RelevantChunk

Die Informationen zu einem Block, der für eine Abfrage relevant ist.

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

Chunk-Relevanz für die Abfrage.

chunk object (Chunk)

Chunk, die der Abfrage zugeordnet sind.