Methode: corpora.create
Erstellt eine leere Corpus
.
Endpunkt
Beitrag
https://generativelanguage.googleapis.com/v1beta/corpora
Anfragetext
Der Anfragetext enthält eine Instanz von Corpus
.
name
string
Nicht veränderbar. Kennung. Der Ressourcenname Corpus
. Die ID (Name ohne Präfix „corpora/“) kann bis zu 40 Zeichen enthalten, die alphanumerisch in Kleinschreibung oder Bindestriche (-) sind. 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 für Menschen lesbare Anzeigename für Corpus
. Der Anzeigename darf höchstens 512 Zeichen (einschließlich Leerzeichen) lang sein. 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
Beitrag
https://generativelanguage.googleapis.com/v1beta/{name=corpora/*}:query
Pfadparameter
name
string
Erforderlich. Der Name der abzufragenden Corpus
. Beispiel: corpora/my-corpus-123
. Sie hat das Format corpora/{corpora}
.
Anfragetext
Der Anfragetext enthält Daten mit folgender Struktur:
query
string
Erforderlich. Suchstring für die semantische Suche.
metadataFilters[]
object (MetadataFilter
)
Optional. Filtern Sie nach Chunk
- und Document
-Metadaten. Jedes MetadataFilter
-Objekt sollte einem eindeutigen Schlüssel entsprechen. Mehrere MetadataFilter
-Objekte werden durch ein logisches AND verbunden.
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 Chunk-Ebene für einen numerischen Wertebereich: (Jahr > 2015 UND Jahr <= 2020)
MetadataFilter
object list: metadataFilters = [ {key = "chunk.custom_metadata.year" condition = [{int_value = 2015, Vorgangs = GREATER}]}, {key = "chunk.custom_metadata.year" 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 Chunk
s, die zurückgegeben werden sollen. Der Dienst gibt möglicherweise weniger Chunk
s zurück.
Wenn nicht angegeben, werden maximal 10 Chunk
zurückgegeben. Die maximale Anzahl der angegebenen Ergebnisse ist 100.
Antworttext
Antwort von corpora.query
mit einer Liste relevanter Chunks
Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:
relevantChunks[]
object (RelevantChunk
)
Die relevanten Blöcke.
JSON-Darstellung |
---|
{
"relevantChunks": [
{
object ( |
Methode: corpora.list
Listet alle Corpora
auf, die dem Nutzer gehören.
Endpunkt
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.
Gib den in der Antwort zurückgegebenen Wert 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:
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 ( |
Methode: corpora.get
Ruft Informationen zu einer bestimmten Corpus
ab.
Endpunkt
erhalten
https://generativelanguage.googleapis.com/v1beta/{name=corpora/*}
Pfadparameter
name
string
Erforderlich. Der Name der Corpus
. Beispiel: corpora/my-corpus-123
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
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 Präfix „corpora/“) kann bis zu 40 Zeichen enthalten, die alphanumerisch in Kleinschreibung oder Bindestriche (-) sind. Die ID darf nicht mit einem Bindestrich beginnen oder enden. Wenn der Name beim Erstellen leer ist, wird ein eindeutiger Name aus displayName
und einem zufälligen Suffix mit 12 Zeichen abgeleitet. Beispiel: corpora/my-awesome-corpora-123a456b789c
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
.
displayName
string
Optional. Der für Menschen lesbare Anzeigename für Corpus
. Der Anzeigename darf höchstens 512 Zeichen (einschließlich Leerzeichen) lang sein. Beispiel: „Dokumente im 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 des Corpus
. Beispiel: corpora/my-corpus-123
hat das Format corpora/{corpora}
.
Abfrageparameter
force
boolean
Optional. Wenn die Richtlinie auf „true“ gesetzt ist, werden alle Document
-Objekte und Objekte im Zusammenhang mit dieser Corpus
ebenfalls gelöscht.
Bei „false“ (Standardeinstellung) wird ein FAILED_PRECONDITION
-Fehler zurückgegeben, wenn Corpus
Document
s 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. Wenn Sie sie Nutzern, Gruppen oder Dienstkonten zur Verfügung stellen möchten, müssen Sie ihnen Rollen zuweisen. 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 Übermenge 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.
- Inhaber hat Schreibberechtigungen und kann zusätzlich löschen
name
string
Nur Ausgabe. Kennung. 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 Begünstigten.
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 Rolle, die durch diese Berechtigung gewährt wird.
JSON-Darstellung |
---|
{ "name": string, "granteeType": enum ( |
GranteeType
Definiert die Typen der Begünstigten 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 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 freigeben. |
READER |
Leser können 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}]
key
string
Erforderlich. Der Schlüssel der Metadaten, nach denen gefiltert werden soll.
conditions[]
object (Condition
)
Erforderlich. Die Condition
s für den angegebenen Schlüssel, die diesen Filter auslösen. Mehrere Condition
s werden durch logische ODERs verbunden.
JSON-Darstellung |
---|
{
"key": string,
"conditions": [
{
object ( |
Bedingung
Filterbedingung für einen einzelnen Schlüssel.
operation
enum (Operator
)
Erforderlich. Operator, der auf das angegebene Schlüssel/Wert-Paar angewendet wird, um die Bedingung auszulösen.
value
. Der Werttyp muss mit dem Werttyp übereinstimmen, der im Feld für den entsprechenden Schlüssel definiert ist. Wenn die Werttypen nicht konsistent sind, ist das Ergebnis ein leerer Satz. Wenn CustomMetadata
den Werttyp StringList
hat, sollte in der Filterbedingung string_value
mit einem INCLUDES-/EXCLUDES-Vorgang kombiniert 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
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 von „numeric“. |
LESS_EQUAL |
Unterstützt durch numerische Werte. |
EQUAL |
Unterstützt von numerischen und String-Werten. |
GREATER_EQUAL |
Unterstützt von „numeric“. |
GREATER |
Unterstützt durch numerische Werte. |
NOT_EQUAL |
Unterstützt von numerischen und String-Werten. |
INCLUDES |
Wird nur als String unterstützt, wenn der CustomMetadata -Werttyp für den angegebenen Schlüssel einen stringListValue hat. |
EXCLUDES |
Wird nur als String unterstützt, wenn der CustomMetadata -Werttyp für den angegebenen Schlüssel einen stringListValue hat. |
REST-Ressource: corpora
Ressource: Korpus
Eine Corpus
ist eine Sammlung von Document
s. Mit einem Projekt können bis zu 5 Korpora erstellt werden.
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 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 der 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"
.
JSON-Darstellung |
---|
{ "name": string, "displayName": string, "createTime": string, "updateTime": string } |