CreateMessageOptions interface

Pakket:

@azure/openai-assistants

De gegevens die worden gebruikt om een bericht te maken.

Uitbreiding

OperationOptions

Eigenschappen

fileIds	Een lijst met maximaal 10 bestands-ID's die aan het bericht kunnen worden gekoppeld, zoals gebruikt door tools zoals 'code_interpreter' of 'retrieval' die bestanden kunnen lezen.
metadata	Een set van maximaal 16 sleutel-/waardeparen die aan een object kunnen worden gekoppeld, die wordt gebruikt voor het opslaan van aanvullende informatie over dat object in een gestructureerde indeling. Sleutels mogen maximaal 64 tekens lang zijn en waarden mogen maximaal 512 tekens lang zijn.

Overgenomen eigenschappen

abortSignal	Het signaal dat kan worden gebruikt om aanvragen af te breken.
onResponse	Een functie die telkens wordt aangeroepen wanneer een antwoord van de server wordt ontvangen tijdens het uitvoeren van de aangevraagde bewerking. Kan meerdere keren worden aangeroepen.
requestOptions	Opties die worden gebruikt bij het maken en verzenden van HTTP-aanvragen voor deze bewerking.
tracingOptions	Opties die worden gebruikt wanneer tracering is ingeschakeld.

Eigenschapdetails

fileIds

Een lijst met maximaal 10 bestands-ID's die aan het bericht kunnen worden gekoppeld, zoals gebruikt door tools zoals 'code_interpreter' of 'retrieval' die bestanden kunnen lezen.

fileIds?: string[]

Waarde van eigenschap

string[]

metadata

Een set van maximaal 16 sleutel-/waardeparen die aan een object kunnen worden gekoppeld, die wordt gebruikt voor het opslaan van aanvullende informatie over dat object in een gestructureerde indeling. Sleutels mogen maximaal 64 tekens lang zijn en waarden mogen maximaal 512 tekens lang zijn.

metadata?: Record<string, string>

Waarde van eigenschap

Record<string, string>

Details van overgenomen eigenschap

abortSignal

Het signaal dat kan worden gebruikt om aanvragen af te breken.

abortSignal?: AbortSignalLike

Waarde van eigenschap

AbortSignalLike

overgenomen van OperationOptions.abortSignal

onResponse

Een functie die telkens wordt aangeroepen wanneer een antwoord van de server wordt ontvangen tijdens het uitvoeren van de aangevraagde bewerking. Kan meerdere keren worden aangeroepen.

onResponse?: RawResponseCallback

Waarde van eigenschap

RawResponseCallback

overgenomen van OperationOptions.onResponse

requestOptions

Opties die worden gebruikt bij het maken en verzenden van HTTP-aanvragen voor deze bewerking.

requestOptions?: OperationRequestOptions

Waarde van eigenschap

OperationRequestOptions

overgenomen van OperationOptions.requestOptions

tracingOptions

Opties die worden gebruikt wanneer tracering is ingeschakeld.

tracingOptions?: OperationTracingOptions

Waarde van eigenschap

OperationTracingOptions

overgenomen van OperationOptions.tracingOptions