Documents

Methode: corpora.documents.create

Erstellt eine leere Document.

Endpunkt

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

Pfadparameter

parent string

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

Anfragetext

Der Anfragetext enthält eine Instanz von Document.

Felder
name string

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

displayName string

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

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

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

Pfadparameter

name string

Erforderlich. Der Name des abzufragenden Document. Beispiel: corpora/my-corpus-123/documents/the-doc-abc Sie 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 Chunk zurück.

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

metadataFilters[] object (MetadataFilter)

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

Hinweis: Die Filterung 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 werden nur „OR“-Bedingungen 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 >
>

Pfadparameter

parent string

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

Abfrageparameter

pageSize integer

Optional. Die maximale Anzahl der zurückzugebenden Documents (pro Seite). Der Dienst gibt möglicherweise weniger Document zurück.

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

pageToken string

Optional. Ein Seitentoken, das von einem vorherigen documents.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 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 Document werden in aufsteigender Reihenfolge nach 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 einem bestimmten Document ab.

Endpunkt

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

Pfadparameter

name string

Erforderlich. Der Name des abzurufenden Document. Beispiel: corpora/my-corpus-123/documents/the-doc-abc Sie 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 ein Document.

Endpunkt

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

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

Pfadparameter

document.name string

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

Abfrageparameter

updateMask string (FieldMask format)

Erforderlich. Die Liste der zu aktualisierenden Felder. Derzeit werden nur Aktualisierungen 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 für Document. Der Anzeigename darf maximal 512 Zeichen lang sein, einschließlich Leerzeichen. Beispiel: „Semantic Retriever-Dokumentation“

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/*}

Pfadparameter

name string

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

Abfrageparameter

force boolean

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

Wenn „false“ (Standardeinstellung), wird ein FAILED_PRECONDITION-Fehler zurückgegeben, wenn Document Chunk 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.documents

Ressource: Document

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

Felder
name string

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

displayName string

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

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 letzten Aktualisierung von Document.

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

createTime string (Timestamp format)

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

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,
  "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
  ]
}