Documents

In der File Search API werden Ihre Rohquelldateien oder ‑dokumente als temporäre Datei-Objekte referenziert.

Methode: fileSearchStores.documents.delete

Löscht eine Document.

Endpunkt

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

Pfadparameter

name string

Erforderlich. Der Ressourcenname der zu löschenden Document. Beispiel: fileSearchStores/my-file-search-store-123/documents/the-doc-abc Sie nimmt die Form fileSearchStores/{filesearchstore}/documents/{document} an.

Anfrageparameter

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.

Methode: fileSearchStores.documents.get

Ruft Informationen zu einer bestimmten Document ab.

Endpunkt

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

Pfadparameter

name string

Erforderlich. Der Name des abzurufenden Document. Beispiel: fileSearchStores/my-file-search-store-123/documents/the-doc-abc Sie nimmt die Form fileSearchStores/{filesearchstore}/documents/{document} an.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

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

Methode: fileSearchStores.documents.list

Listet alle Document in einem Corpus auf.

Endpunkt

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

Pfadparameter

parent string

Erforderlich. Der Name der FileSearchStore, die Document enthält. Beispiel: fileSearchStores/my-file-search-store-123 Sie nimmt die Form fileSearchStores/{filesearchstore} an.

Anfrageparameter

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

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: fileSearchStores.documents.query

Führt eine semantische Suche in einem Document durch.

Endpunkt

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

Pfadparameter

name string

Erforderlich. Der Name des abzufragenden Document. Beispiel: fileSearchStores/my-file-search-store-123/documents/the-doc-abc Sie nimmt die Form fileSearchStores/{filesearchstore}/documents/{document} an.

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

Felder
query string

Erforderlich. Suchanfrage 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 object list: 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 object list: 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. Für Stringwerte 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)
    }
  ]
}

REST-Ressource: fileSearchStores.documents

Ressource: Document

Eine Document ist eine Sammlung von Chunks.

Felder
name string

Nicht veränderbar. ID. Der Name der Document-Ressource. Die ID (Name ohne das Präfix „fileSearchStores/*/documents/“) kann 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 mit einem zufälligen 12‑stelligen Suffix abgeleitet. Beispiel: fileSearchStores/{file_search_store_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: „Dokumentation zu Semantic Retriever“

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, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. 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, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. 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".

state enum (State)

Nur Ausgabe. Aktueller Status von Document.

sizeBytes string (int64 format)

Nur Ausgabe. Die Größe der in das Dokument aufgenommenen Rohbytes.

mimeType string

Nur Ausgabe. Der MIME-Typ des Dokuments.

JSON-Darstellung 
{
  "name": string,
  "displayName": string,
  "customMetadata": [
    {
      object (CustomMetadata)
    }
  ],
  "updateTime": string,
  "createTime": string,
  "state": enum (State),
  "sizeBytes": string,
  "mimeType": string
}

Bundesland

Status für den Lebenszyklus einer Document.

Enums
STATE_UNSPECIFIED Der Standardwert. Dieser Wert wird verwendet, wenn der Bundesstaat weggelassen wird.
STATE_PENDING Einige Chunks der Document werden verarbeitet (Einbettung und Vektorspeicherung).
STATE_ACTIVE Alle Chunks des Document werden verarbeitet und können abgefragt werden.
STATE_FAILED Einige Chunks der Document konnten nicht verarbeitet werden.