CreateMessageOptions interface

Paket:

@azure/openai-assistants

Die Details, die zum Erstellen einer Nachricht verwendet werden.

Extends

OperationOptions

Eigenschaften

fileIds	Eine Liste von bis zu 10 Datei-IDs, die der Nachricht zugeordnet werden sollen, wie sie von Tools wie "code_interpreter" oder "Abruf" verwendet werden, die Dateien lesen können.
metadata	Ein Satz von bis zu 16 Schlüssel-Wert-Paaren, die an ein Objekt angefügt werden können, zum Speichern zusätzlicher Informationen zu diesem Objekt in einem strukturierten Format. Schlüssel können bis zu 64 Zeichen lang sein, und die Werte können bis zu 512 Zeichen lang sein.

Geerbte Eigenschaften

abortSignal	Das Signal, das zum Abbrechen von Anforderungen verwendet werden kann.
onResponse	Eine Funktion, die jedes Mal aufgerufen werden soll, wenn beim Ausführen des angeforderten Vorgangs eine Antwort vom Server empfangen wird. Kann mehrmals aufgerufen werden.
requestOptions	Optionen, die beim Erstellen und Senden von HTTP-Anforderungen für diesen Vorgang verwendet werden.
tracingOptions	Optionen, die verwendet werden, wenn die Ablaufverfolgung aktiviert ist.

Details zur Eigenschaft

fileIds

Eine Liste von bis zu 10 Datei-IDs, die der Nachricht zugeordnet werden sollen, wie sie von Tools wie "code_interpreter" oder "Abruf" verwendet werden, die Dateien lesen können.

fileIds?: string[]

Eigenschaftswert

string[]

metadata

Ein Satz von bis zu 16 Schlüssel-Wert-Paaren, die an ein Objekt angefügt werden können, zum Speichern zusätzlicher Informationen zu diesem Objekt in einem strukturierten Format. Schlüssel können bis zu 64 Zeichen lang sein, und die Werte können bis zu 512 Zeichen lang sein.

metadata?: Record<string, string>

Eigenschaftswert

Record<string, string>

Geerbte Eigenschaftsdetails

abortSignal

Das Signal, das zum Abbrechen von Anforderungen verwendet werden kann.

abortSignal?: AbortSignalLike

Eigenschaftswert

AbortSignalLike

Geerbt von OperationOptions.abortSignal

onResponse

Eine Funktion, die jedes Mal aufgerufen werden soll, wenn beim Ausführen des angeforderten Vorgangs eine Antwort vom Server empfangen wird. Kann mehrmals aufgerufen werden.

onResponse?: RawResponseCallback

Eigenschaftswert

RawResponseCallback

Geerbt von OperationOptions.onResponse

requestOptions

Optionen, die beim Erstellen und Senden von HTTP-Anforderungen für diesen Vorgang verwendet werden.

requestOptions?: OperationRequestOptions

Eigenschaftswert

OperationRequestOptions

Geerbt von OperationOptions.requestOptions

tracingOptions

Optionen, die verwendet werden, wenn die Ablaufverfolgung aktiviert ist.

tracingOptions?: OperationTracingOptions

Eigenschaftswert

OperationTracingOptions

Geerbt von OperationOptions.tracingOptions