Method: projects.locations.collections.engines.sessions.addContextFile

Lädt eine Kontextdatei hoch, die als Quelle für die Assist-Aufrufe in der Sitzung verwendet werden soll.

HTTP-Anfrage

POST https://discoveryengine.googleapis.com/v1alpha/{name=projects/*/locations/*/collections/*/engines/*/sessions/*}:addContextFile

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
name

string

Erforderlich. Der Ressourcenname der Sitzung. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}

Wenn - als Sitzungs-ID angegeben wird, wird eine neue Sitzung mit einer automatisch generierten ID erstellt.

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

JSON-Darstellung 
{
  "fileName": string,
  "mimeType": string,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "fileContents": string,
  "document": string
  // End of mutually exclusive fields.
}
Felder
fileName

string

Erforderlich. Der Name der Datei.
mimeType

string

Optional. Der Inhaltstyp der Datei. Weitere Informationen finden Sie unter https://www.iana.org/assignments/media-types/media-types.xhtml.

Dieses Feld ist erforderlich, wenn der Inhaltstyp nicht in der Datenquelle angegeben wird.
Der Inhalt der Datei. Im Folgenden finden Sie eine Liste von sich gegenseitig ausschließenden Feldern. In einer Antwort wird höchstens eines der Felder festgelegt:
fileContents

string (bytes format)

Der Dateiinhalt wird inline bereitgestellt.

Ein base64-codierter String.
document

string

Ressourcenname von Document. Der Aufrufer muss die Berechtigung haben, auf die Document zuzugreifen. Andernfalls wird ein PERMISSION_DENIED-Fehler zurückgegeben.

Format: projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/branches/{branch}/documents/{document}
Ende der sich gegenseitig ausschließenden Felder.

Antworttext

Antwort für die Methode AssistantService.AddContextFile.

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

JSON-Darstellung 
{
  "session": string,
  "fileId": string,
  "tokenCount": string,
  "mimeType": string,
  "byteCount": string,
  "fileName": string
}
Felder
session

string

Der Name der Sitzung, entweder der angegebene oder der neu erstellte.

Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}
fileId

string

Die ID der hochgeladenen Datei
tokenCount
(deprecated)

string (int64 format)

Verworfen: Dieses Feld wird nicht für alle Dateitypen festgelegt und wird demnächst entfernt.

Die Länge der Datei in Tokens
mimeType

string

Nur Ausgabe. Der aufgelöste Inhaltstyp der hochgeladenen Datei. Weitere Informationen finden Sie unter https://www.iana.org/assignments/media-types/media-types.xhtml.

Im Gegensatz zu AddContextFileRequest.mime_type, das optional vom Aufrufer angegeben wird, ist dies der Inhaltstyp, den der Dienst tatsächlich für die Datei aufgelöst hat.
byteCount

string (int64 format)

Nur Ausgabe. Die Größe der hochgeladenen Datei in Byte.
fileName

string

Nur Ausgabe. Der aufgelöste Name der hochgeladenen Datei, einschließlich der Dateierweiterung.

Im Gegensatz zu AddContextFileRequest.file_name, das vom Aufrufer angegeben wird, fügt der Dienst die Erweiterung hinzu, die dem aufgelösten mimeType entspricht, wenn der vom Aufrufer angegebene Name keine Erweiterung enthält. So wird in den Audit-Logs zur Nutzung der Dateityp auch für generisch benannte KI-generierte Dateien erfasst.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.assist.readwrite
  • https://www.googleapis.com/auth/discoveryengine.readwrite
  • https://www.googleapis.com/auth/discoveryengine.serving.readwrite

Weitere Informationen finden Sie unter Authentication Overview.

IAM-Berechtigungen

Erfordert die folgende IAM-Berechtigung für die Ressource name:

  • discoveryengine.sessions.addContextFile

Weitere Informationen finden Sie in der IAM-Dokumentation.