GetChatCompletionsOptions interface

Pakket:

@azure/openai

Deze module bevat modellen die we naast de bijbehorende gegenereerde modellen willen gebruiken. Dit is handig voor het leveren van klantgerichte modellen met andere namen/typen dan de gegenereerde modellen.

Extends

OperationOptions

Eigenschappen

azureExtensionOptions	De configuratie-vermeldingen voor Azure OpenAI-chatextensies die deze gebruiken. Deze aanvullende specificatie is alleen compatibel met Azure OpenAI.
frequencyPenalty	Een waarde die van invloed is op de waarschijnlijkheid van gegenereerde tokens die worden weergegeven op basis van hun cumulatieve frequentie in gegenereerde tekst. Positieve waarden zorgen ervoor dat tokens minder snel worden weergegeven naarmate hun frequentie toeneemt en de kans dat het model dezelfde instructies letterlijk herhaalt.
functionCall	Hiermee bepaalt u hoe het model reageert op functie-aanroepen. 'geen' betekent dat het model geen functie aanroept en reageert op de eindgebruiker. 'auto' betekent dat het model kan kiezen tussen een eindgebruiker of het aanroepen van een functie. Het opgeven van een bepaalde functie via {"name": "my_function"} dwingt het model om die functie aan te roepen. 'none' is de standaardwaarde wanneer er geen functies aanwezig zijn. 'auto' is de standaardwaarde als er functies aanwezig zijn.
functions	Een lijst met functies waarvoor het model JSON-invoer kan genereren.
logitBias	Een toewijzing tussen GPT-token-id's en bias-scores die van invloed zijn op de waarschijnlijkheid van specifieke tokens die worden weergegeven in een voltooiingsreactie. Token-id's worden berekend via externe tokenizer-hulpprogramma's, terwijl biasscores zich respectievelijk in het bereik van -100 tot 100 bevinden met een minimum- en maximumwaarde die overeenkomt met een volledige ban of exclusieve selectie van een token. Het exacte gedrag van een bepaalde bias-score verschilt per model.
maxTokens	Het maximum aantal tokens dat moet worden gegenereerd.
n	Het aantal opties voor het voltooien van chats dat moet worden gegenereerd voor een antwoord op voltooiing van een chat. Omdat deze instelling veel voltooiingen kan genereren, kan het tokenquotum snel worden verbruikt. Gebruik zorgvuldig en zorg voor redelijke instellingen voor maxTokens en stop.
presencePenalty	Een waarde die van invloed is op de waarschijnlijkheid van gegenereerde tokens die worden weergegeven op basis van hun bestaande aanwezigheid in gegenereerde tekst. Positieve waarden zorgen ervoor dat tokens minder snel worden weergegeven wanneer ze al bestaan en vergroten de kans dat het model nieuwe onderwerpen uitvoert.
responseFormat	Een object dat de indeling aangeeft die het model moet uitvoeren. Wordt gebruikt om de JSON-modus in te schakelen.
seed	Indien opgegeven, zal het systeem proberen deterministisch steekproeven te nemen, zodat herhaalde aanvragen met dezelfde seed en parameters hetzelfde resultaat moeten retourneren. Determinisme wordt niet gegarandeerd en u moet verwijzen naar de parameter system_fingerprint antwoord om wijzigingen in de back-end te bewaken.
stop	Een verzameling tekstreeksen waarmee het genereren van voltooiingen wordt beëindigd.
temperature	De te gebruiken steekproeftemperatuur die de schijnbare creativiteit van gegenereerde voltooiingen bepaalt. Met hogere waarden wordt de uitvoer willekeuriger, terwijl lagere waarden de resultaten meer gericht en deterministisch maken. Het wordt niet aanbevolen om temperatuur en topP te wijzigen voor dezelfde voltooiingsaanvraag, omdat de interactie van deze twee instellingen moeilijk te voorspellen is.
toolChoice	Indien opgegeven, configureert het model welke van de opgegeven hulpprogramma's het kan gebruiken voor het antwoord op voltooiing van de chat.
tools	De beschikbare hulpprogrammadefinities die de chat-voltooiingsaanvraag kan gebruiken, inclusief door de beller gedefinieerde functies.
topP	Een alternatief voor monstername met temperatuur, ook wel kernmonsters genomen. Deze waarde zorgt ervoor dat het model rekening houdt met de resultaten van tokens met de opgegeven waarschijnlijkheidsmassa. Een waarde van 0,15 zorgt er bijvoorbeeld voor dat alleen de tokens die de bovenste 15% van de waarschijnlijkheidsmassa omvatten, in aanmerking worden genomen. Het wordt niet aanbevolen om temperatuur en topP te wijzigen voor dezelfde voltooiingsaanvraag, omdat de interactie van deze twee instellingen moeilijk te voorspellen is.
user	Een id voor de beller of eindgebruiker van de bewerking. Dit kan worden gebruikt voor tracerings- of snelheidsbeperkingsdoeleinden.

Overgenomen eigenschappen

abortSignal	Het signaal dat kan worden gebruikt om aanvragen af te breken.
onResponse	Een functie die telkens wordt aangeroepen wanneer er 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

azureExtensionOptions

De configuratie-vermeldingen voor Azure OpenAI-chatextensies die deze gebruiken. Deze aanvullende specificatie is alleen compatibel met Azure OpenAI.

azureExtensionOptions?: AzureExtensionsOptions

Waarde van eigenschap

AzureExtensionsOptions

frequencyPenalty

Een waarde die van invloed is op de waarschijnlijkheid van gegenereerde tokens die worden weergegeven op basis van hun cumulatieve frequentie in gegenereerde tekst. Positieve waarden zorgen ervoor dat tokens minder snel worden weergegeven naarmate hun frequentie toeneemt en de kans dat het model dezelfde instructies letterlijk herhaalt.

frequencyPenalty?: number

Waarde van eigenschap

number

functionCall

Hiermee bepaalt u hoe het model reageert op functie-aanroepen. 'geen' betekent dat het model geen functie aanroept en reageert op de eindgebruiker. 'auto' betekent dat het model kan kiezen tussen een eindgebruiker of het aanroepen van een functie. Het opgeven van een bepaalde functie via {"name": "my_function"} dwingt het model om die functie aan te roepen. 'none' is de standaardwaarde wanneer er geen functies aanwezig zijn. 'auto' is de standaardwaarde als er functies aanwezig zijn.

functionCall?: string | FunctionName

Waarde van eigenschap

string | FunctionName

functions

Een lijst met functies waarvoor het model JSON-invoer kan genereren.

functions?: FunctionDefinition[]

Waarde van eigenschap

FunctionDefinition[]

logitBias

Een toewijzing tussen GPT-token-id's en bias-scores die van invloed zijn op de waarschijnlijkheid van specifieke tokens die worden weergegeven in een voltooiingsreactie. Token-id's worden berekend via externe tokenizer-hulpprogramma's, terwijl biasscores zich respectievelijk in het bereik van -100 tot 100 bevinden met een minimum- en maximumwaarde die overeenkomt met een volledige ban of exclusieve selectie van een token. Het exacte gedrag van een bepaalde bias-score verschilt per model.

logitBias?: Record<string, number>

Waarde van eigenschap

Record<string, number>

maxTokens

Het maximum aantal tokens dat moet worden gegenereerd.

maxTokens?: number

Waarde van eigenschap

number

n

Het aantal opties voor het voltooien van chats dat moet worden gegenereerd voor een antwoord op voltooiing van een chat. Omdat deze instelling veel voltooiingen kan genereren, kan het tokenquotum snel worden verbruikt. Gebruik zorgvuldig en zorg voor redelijke instellingen voor maxTokens en stop.

n?: number

Waarde van eigenschap

number

presencePenalty

Een waarde die van invloed is op de waarschijnlijkheid van gegenereerde tokens die worden weergegeven op basis van hun bestaande aanwezigheid in gegenereerde tekst. Positieve waarden zorgen ervoor dat tokens minder snel worden weergegeven wanneer ze al bestaan en vergroten de kans dat het model nieuwe onderwerpen uitvoert.

presencePenalty?: number

Waarde van eigenschap

number

responseFormat

Een object dat de indeling aangeeft die het model moet uitvoeren. Wordt gebruikt om de JSON-modus in te schakelen.

responseFormat?: ChatCompletionsResponseFormat

Waarde van eigenschap

ChatCompletionsResponseFormat

seed

Indien opgegeven, zal het systeem proberen deterministisch steekproeven te nemen, zodat herhaalde aanvragen met dezelfde seed en parameters hetzelfde resultaat moeten retourneren. Determinisme wordt niet gegarandeerd en u moet verwijzen naar de parameter system_fingerprint antwoord om wijzigingen in de back-end te bewaken.

seed?: number

Waarde van eigenschap

number

stop

Een verzameling tekstreeksen waarmee het genereren van voltooiingen wordt beëindigd.

stop?: string[]

Waarde van eigenschap

string[]

temperature

De te gebruiken steekproeftemperatuur die de schijnbare creativiteit van gegenereerde voltooiingen bepaalt. Met hogere waarden wordt de uitvoer willekeuriger, terwijl lagere waarden de resultaten meer gericht en deterministisch maken. Het wordt niet aanbevolen om temperatuur en topP te wijzigen voor dezelfde voltooiingsaanvraag, omdat de interactie van deze twee instellingen moeilijk te voorspellen is.

temperature?: number

Waarde van eigenschap

number

toolChoice

Indien opgegeven, configureert het model welke van de opgegeven hulpprogramma's het kan gebruiken voor het antwoord op voltooiing van de chat.

toolChoice?: ChatCompletionsNamedToolSelectionUnion

Waarde van eigenschap

ChatCompletionsNamedToolSelectionUnion

tools

De beschikbare hulpprogrammadefinities die de chat-voltooiingsaanvraag kan gebruiken, inclusief door de beller gedefinieerde functies.

tools?: ChatCompletionsToolDefinitionUnion[]

Waarde van eigenschap

ChatCompletionsToolDefinitionUnion[]

topP

Een alternatief voor monstername met temperatuur, ook wel kernmonsters genomen. Deze waarde zorgt ervoor dat het model rekening houdt met de resultaten van tokens met de opgegeven waarschijnlijkheidsmassa. Een waarde van 0,15 zorgt er bijvoorbeeld voor dat alleen de tokens die de bovenste 15% van de waarschijnlijkheidsmassa omvatten, in aanmerking worden genomen. Het wordt niet aanbevolen om temperatuur en topP te wijzigen voor dezelfde voltooiingsaanvraag, omdat de interactie van deze twee instellingen moeilijk te voorspellen is.

topP?: number

Waarde van eigenschap

number

user

Een id voor de beller of eindgebruiker van de bewerking. Dit kan worden gebruikt voor tracerings- of snelheidsbeperkingsdoeleinden.

user?: string

Waarde van eigenschap

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 er 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