Documents

Methode: corpora.documents.create

Erstellt eine leere Document.

Endpunkt

Beitrag https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*}/documents

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

parent string

Erforderlich. Der Name des Corpus, in dem diese Document erstellt werden soll. Beispiel: corpora/my-corpus-123 hat das Format corpora/{corpora}.

Anfragetext

Der Anfragetext enthält eine Instanz von Document.

Felder
name string

Nicht veränderbar. Kennung. Der Name der Document-Ressource. Die ID (Name ohne Präfix „corpora/*/documents/“) kann bis zu 40 Zeichen enthalten, die aus Kleinbuchstaben, alphanumerischen Zeichen oder Bindestrichen (-) bestehen. 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/{corpus_id}/documents/my-awesome-doc-123a456b789c

displayName string

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

customMetadata[] object (CustomMetadata)

Optional. Von Nutzern bereitgestellte benutzerdefinierte Metadaten, die als Schlüssel/Wert-Paare gespeichert und für Abfragen verwendet werden. Ein Document kann maximal 20 CustomMetadata haben.

Antworttext

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

Methode: corpora.documents.query

Führt eine semantische Suche in einem Document durch.

Endpunkt

Beitrag https://generativelanguage.googleapis.com/v1beta/{name=corpora/*/documents/*}:query

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

name string

Erforderlich. Der Name der abzufragenden Document. Beispiel: corpora/my-corpus-123/documents/the-doc-abc hat das Format corpora/{corpora}/documents/{document}.

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

Felder
query string

Erforderlich. Suchstring für die semantische Suche.

resultsCount integer

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

Wenn nicht angegeben, werden maximal 10 Chunk zurückgegeben. Die maximale Anzahl der angegebenen Ergebnisse ist 100.

metadataFilters[] object (MetadataFilter)

Optional. Filtern Sie nach Chunk-Metadaten. Jedem MetadataFilter-Objekt sollte ein eindeutiger Schlüssel entsprechen. Mehrere MetadataFilter-Objekte werden durch logische UND-Verknüpfungen zusammengeführt.

Hinweis: Das Filtern auf Document-Ebene wird für diese Anfrage nicht unterstützt, da bereits ein Document-Name angegeben ist.

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

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

Beispielabfrage 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 wird nur „ODER“ für denselben Schlüssel unterstützt.

Antworttext

Antwort von documents.query mit einer Liste relevanter Chunks

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

Felder
relevantChunks[] object (RelevantChunk)

Die zurückgegebenen relevanten Chunks.

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

Methode: corpora.documents.list

Listet alle Documents in einem Corpus auf.

Endpunkt

get https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*}/documents

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

parent string

Erforderlich. Der Name der Corpus, die Documents enthält. Beispiel: corpora/my-corpus-123 hat das Format corpora/{corpora}.

Abfrageparameter

pageSize integer

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

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

pageToken string

Optional. Ein Seitentoken, das von einem vorherigen documents.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 documents.list bereitgestellten Parameter mit dem Aufruf übereinstimmen, der das Seitentoken bereitgestellt hat.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Antwort von documents.list mit einer paginierten Liste von Documents. Die Documents sind nach aufsteigendem document.create_time sortiert.

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

Felder
documents[] object (Document)

Die zurückgegebenen Documents.

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 
{
  "documents": [
    {
      object (Document)
    }
  ],
  "nextPageToken": string
}

Methode: corpora.documents.get

Ruft Informationen zu einer bestimmten Document ab.

Endpunkt

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

name string

Erforderlich. Der Name des abzurufenden Document. Beispiel: corpora/my-corpus-123/documents/the-doc-abc hat das Format corpora/{corpora}/documents/{document}.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

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

Methode: corpora.documents.patch

Aktualisiert einen Document.

Endpunkt

patch https://generativelanguage.googleapis.com/v1beta/{document.name=corpora/*/documents/*}

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

document.name string

Nicht veränderbar. Kennung. Der Name der Document-Ressource. Die ID (Name ohne Präfix „corpora/*/documents/“) kann bis zu 40 Zeichen enthalten, die aus Kleinbuchstaben, alphanumerischen Zeichen oder Bindestrichen (-) bestehen. 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/{corpus_id}/documents/my-awesome-doc-123a456b789c hat das Format corpora/{corpora}/documents/{document}.

Abfrageparameter

updateMask string (FieldMask format)

Erforderlich. Die Liste der zu aktualisierenden Felder. Derzeit wird nur die Aktualisierung von displayName und customMetadata 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 Document.

Felder
displayName string

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

customMetadata[] object (CustomMetadata)

Optional. Von Nutzern bereitgestellte benutzerdefinierte Metadaten, die als Schlüssel/Wert-Paare gespeichert und für Abfragen verwendet werden. Ein Document kann maximal 20 CustomMetadata haben.

Antworttext

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

Methode: corpora.documents.delete

Löscht einen Document.

Endpunkt

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

name string

Erforderlich. Der Ressourcenname der zu löschenden Document. Beispiel: corpora/my-corpus-123/documents/the-doc-abc hat das Format corpora/{corpora}/documents/{document}.

Abfrageparameter

force boolean

Optional. Wenn dieser Wert auf „wahr“ gesetzt ist, werden auch alle Chunks und Objekte gelöscht, die mit dieser Document verknüpft sind.

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

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Wenn der Vorgang erfolgreich ist, ist der Antworttext leer.

REST-Ressource: corpora.documents

Ressource: Document

Eine Document ist eine Sammlung von Chunks. Ein Corpus kann maximal 10.000 Documents haben.

Felder
name string

Nicht veränderbar. Kennung. Der Name der Document-Ressource. Die ID (Name ohne Präfix „corpora/*/documents/“) kann bis zu 40 Zeichen enthalten, die aus Kleinbuchstaben, alphanumerischen Zeichen oder Bindestrichen (-) bestehen. 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/{corpus_id}/documents/my-awesome-doc-123a456b789c

displayName string

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

customMetadata[] object (CustomMetadata)

Optional. Von Nutzern bereitgestellte benutzerdefinierte Metadaten, die als Schlüssel/Wert-Paare gespeichert und für Abfragen verwendet werden. Ein Document kann maximal 20 CustomMetadata haben.

updateTime string (Timestamp format)

Nur Ausgabe. Der Zeitstempel, der angibt, wann die Document zuletzt aktualisiert wurde.

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".

createTime string (Timestamp format)

Nur Ausgabe. Der Zeitstempel für die Erstellung der Document.

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,
  "customMetadata": [
    {
      object (CustomMetadata)
    }
  ],
  "updateTime": string,
  "createTime": string
}

CustomMetadata

Vom Nutzer bereitgestellte Metadaten, die als Schlüssel/Wert-Paare gespeichert werden.

Felder
key string

Erforderlich. Der Schlüssel der zu speichernden Metadaten.

value Union type
Für value ist nur einer der folgenden Werte zulässig:
stringValue string

Der Stringwert der zu speichernden Metadaten.

stringListValue object (StringList)

Der StringList-Wert der zu speichernden Metadaten.

numericValue number

Der numerische Wert der zu speichernden Metadaten.

JSON-Darstellung 
{
  "key": string,

  // value
  "stringValue": string,
  "stringListValue": {
    object (StringList)
  },
  "numericValue": number
  // Union type
}

StringList

Vom Nutzer bereitgestellte Stringwerte, die einem einzelnen Metadatenschlüssel zugewiesen sind.

Felder
values[] string

Die Stringwerte der zu speichernden Metadaten.

JSON-Darstellung 
{
  "values": [
    string
  ]
}