Docuents

REST-Ressource: corpora.documents

Ressource: Document

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

JSON-Darstellung 
{
  "name": string,
  "displayName": string,
  "customMetadata": [
    {
      object (CustomMetadata)
    }
  ],
  "updateTime": string,
  "createTime": string
}
Felder
name string

Nicht veränderbar. Kennung. Der Ressourcenname Document. Die ID (Name ohne das Präfix „corpora/*/documents/“) 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/{corpus_id}/documents/my-awesome-doc-123a456b789c

displayName string

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

customMetadata[] object (CustomMetadata)

Optional. Vom Nutzer bereitgestellte benutzerdefinierte Metadaten, die als Schlüssel/Wert-Paare für Abfragen gespeichert sind. Ein Document kann maximal 20 CustomMetadata haben.

updateTime string (Timestamp format)

Nur Ausgabe. Der Zeitstempel der letzten Aktualisierung von 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".

createTime string (Timestamp format)

Nur Ausgabe. Der Zeitstempel für die Erstellung des 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".

Methode: corpora.documents.create

Erstellt eine leere Document.

Endpunkt

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

Pfadparameter

parent string

Erforderlich. Der Name von 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.

Antworttext

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

Methode: corpora.documents.list

Listet alle Documents in einem Corpus auf.

Endpunkt

<ph type="x-smartling-placeholder"></ph> erhalten https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*}/documents
.

Pfadparameter

parent string

Erforderlich. Der Name des Corpus, der Documents enthält. Beispiel: corpora/my-corpus-123. Sie 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 höchstens 10 Documents zurückgegeben. Die maximale Größe beträgt 20 Documents 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-Werte sind nach aufsteigender 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, sind keine Seiten mehr vorhanden.

JSON-Darstellung 
{
  "documents": [
    {
      object (Document)
    }
  ],
  "nextPageToken": string
}

Methode: corpora.documents.query

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

Endpunkt

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

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

Erforderlich. Abfragestring für die semantische Suche

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.

metadataFilters[] object (MetadataFilter)

Optional. Nach Chunk-Metadaten filtern. Jedes MetadataFilter-Objekt sollte einem eindeutigen Schlüssel entsprechen. Mehrere MetadataFilter-Objekte werden durch ein logisches AND verbunden.

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

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

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

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

Antworttext

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

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

Felder
relevantChunks[] object (RelevantChunk)

Die zurückgegebenen relevanten Blöcke.

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

Methode: corpora.documents.get

Ruft Informationen zu einer bestimmten Document ab.

Endpunkt

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

Pfadparameter

name string

Erforderlich. Der Name des abzurufenden Document-Objekts. 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 eine Document.

Endpunkt

<ph type="x-smartling-placeholder"></ph> 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. Kennung. Der Ressourcenname Document. Die ID (Name ohne das Präfix „corpora/*/documents/“) 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/{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 displayName und customMetadata aktualisiert.

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

Anfragetext

Der Anfragetext enthält eine Instanz von Document.

Antworttext

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

Methode: corpora.documents.delete

Löscht ein Document.

Endpunkt

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

Pfadparameter

name string

Erforderlich. Der Ressourcenname des 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 die Richtlinie auf „true“ gesetzt ist, werden alle Chunk-Objekte und Objekte im Zusammenhang mit dieser Document ebenfalls gelöscht.

Bei „false“ (Standardeinstellung) 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.

CustomMetadata

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

JSON-Darstellung 
{
  "key": string,

  // Union field value can be only one of the following:
  "stringValue": string,
  "stringListValue": {
    object (StringList)
  },
  "numericValue": number
  // End of list of possible types for union field value.
}
Felder
key string

Erforderlich. Der Schlüssel der zu speichernden Metadaten.

Union-Feld value.

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.

StringList

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

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

Die Stringwerte der zu speichernden Metadaten.