Azure OpenAI Chat

Versione API: v1

Server:{endpoint}/openai/v1 — API Azure AI Foundry modelli

Variabili del server:

Variabile	Predefinito	Description
endpoint		Un endpoint supportato per le API di Azure AI Foundry Models, inclusi protocollo e nome host. Per esempio: https://westus.api.cognitive.microsoft.com).

Autenticazione

ApiKeyAuth (API Key)

Passa la chiave API nell'intestare api-key .

ApiKeyAuth_ (Chiave API)

Passa la chiave API nell'intestare authorization .

OAuth2Auth (OAuth 2.0)

Flusso: implicito

URL autorizzazione:https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Ambiti:

https://cognitiveservices.azure.com/.default

Requisiti di sicurezza

Gli endpoint accettano uno qualsiasi dei seguenti metodi di autenticazione:

ApiKeyAuth
ApiKeyAuth_
OAuth2Auth (ambitivi: https://cognitiveservices.azure.com/.default)

Creare il completamento della chat

POST {endpoint}/openai/v1/chat/completions

Crea un completamento della chat.

Parametri dell'URI

Name	In	Obbligatorio	Type	Description
endpoint	server	Sì	string	Un endpoint supportato per le API di Azure AI Foundry Models, inclusi protocollo e nome host. Per esempio: https://westus.api.cognitive.microsoft.com).
api-version	query	No	string Valori possibili: `v1`, `preview`	Versione esplicita dell'API Azure AI Foundry Models da usare per questa richiesta. `v1` se non specificato diversamente.

Corpo della richiesta

Content-Type: application/json

Name	Type	Description	Obbligatorio
Audio	OpenAI.CreateChatCompletionRequestAudio o null	Parametri per l'uscita audio. Obbligatorio quando viene richiesto l'output audio con `modalities: ["audio"]`.	No
penalità_di_frequenza	number o null	Numero tra -2.0 e 2.0. I valori positivi penalizzano i nuovi token in base a la loro frequenza esistente nel testo fino a ora, riducendo l'efficienza del modello. probabilità di ripetere la stessa riga verbatim. Vincoli: minimo: -2, massimo: 2	No
function_call	stringa o OpenAI.ChatCompletionFunctionCallOption (deprecato)	Deprecato a favore di `tool_choice`. Controlla la funzione (se presente) chiamata dal modello. `none` indica che il modello non chiamerà una funzione e genera invece un messaggio. `auto` indica che il modello può scegliere tra la generazione di un messaggio o la chiamata di un Funzione. Specifica di una funzione specifica tramite `{"name": "my_function"}` forza modello per chiamare tale funzione. `none` è il valore predefinito quando non sono presenti funzioni. `auto` è il valore predefinito se sono presenti funzioni.	No
functions	array di OpenAI.ChatCompletionFunctions (deprecato)	Deprecato a favore di `tools`. Un elenco delle funzioni per cui il modello può generare input JSON. Vincoli: minOggetti: 1, maxOggetti: 128	No
logit_bias	oggetto o null	Modifica la probabilità che i token specificati compaiano nel completamento. Accetta un oggetto JSON che esegue il mapping dei token (specificato dall'ID del token in tokenizer) a un valore di bias associato da -100 a 100. Matematicamente la distorsione viene aggiunta ai logits generati dal modello prima del campionamento. L'effetto esatto varia in base al modello, ma i valori tra -1 e 1 devono diminuire o aumentare la probabilità di selezione; valori come -100 o 100 deve comportare un divieto o una selezione esclusiva del token pertinente.	No
logprobs	booleano o null	Se restituire o meno logaritamiche probabilità dei token di output. Se true, restituisce le probabilità di log di ogni token di output restituito in `content` di `message`.	No
max_completion_tokens	integer o null	Limite superiore per il numero di token che possono essere generati per un oggetto completamento, inclusi i token visibili di output e i token di ragionamento.	No
numero massimo di token	intero o nullo (obsoleto)	Il numero massimo di token che possono essere generati nel completamento della chat. Questo valore può essere usato per controllare i costi per il testo generato tramite API. Questo valore è ora deprecato a favore di `max_completion_tokens`e è non compatibile con i modelli serie o1.	No
messages	matrice di OpenAI.ChatCompletionRequestMessage	Un elenco dei messaggi che compongono la conversazione finora. A seconda del modello usato, tipi di messaggio diversi (modalità) supportati, come testo, immagini e audio. Vincoli: minOggetti: 1	Sì
metadata	OpenAI.Metadata o Null		No
modalities	OpenAI.ResponseModalities	Tipi di output che si desidera generare il modello. La maggior parte dei modelli è in grado di generare testo, ovvero l'impostazione predefinita: `["text"]` Il `gpt-4o-audio-preview` modello può essere usato anche per generare audio. Per richiedere che questo modello generi sia risposte di testo che audio, è possibile usare: `["text", "audio"]`	No
model	string	ID modello usato per generare la risposta, ad esempio `gpt-4o` o `o3`. OpenAI offre un'ampia gamma di modelli con diverse funzionalità, prestazioni caratteristiche e punti di prezzo. Fare riferimento alla guida al modello per esplorare e confrontare i modelli disponibili.	Sì
n	integer o null	Quante opzioni di completamento della chat generare per ogni messaggio di input. Nota che ti verrà addebitato in base al numero di gettoni generati in tutte le scelte. Tieni `n` in modo `1` di minimizzare i costi. Vincoli: minimo: 1, massimo: 128	No
chiamate_parallele_agli_strumenti	OpenAI.ParallelToolCalls	Indica se abilitare la chiamata di funzioni parallele durante l'uso dello strumento.	No
Previsione	OpenAI.PredictionContent	Contenuto di output stimato statico, ad esempio il contenuto di un file di testo rigenerato.	No
└> contenuto	stringa o matrice di OpenAI.ChatCompletionRequestMessageContentPartText	Il contenuto che dovrebbe essere abbinato quando si genera una risposta al modello. Se i token generati corrispondono a questo contenuto, l'intera risposta del modello può essere restituito molto più rapidamente.	Sì
└─ Tipo	enum	Il tipo di contenuto previsto che vuoi fornire. Questo tipo è attualmente sempre `content`. Valori possibili: `content`	Sì
penalità_di_presenza	number o null	Numero tra -2.0 e 2.0. I valori positivi penalizzano i nuovi token in base a se appaiono nel testo fino a questo momento, aumentando la probabilità del modello per parlare di nuovi argomenti. Vincoli: minimo: -2, massimo: 2	No
prompt_cache_key	string	Usato da OpenAI per memorizzare nella cache le risposte per richieste simili per ottimizzare la frequenza di riscontri nella cache. Sostituisce il `user` campo. Scopri di più.	No
prompt_cache_retention	stringa o null		No
sforzo di ragionamento	Sforzo di Ragionamento OpenAI	Vincola lo sforzo sul ragionamento per ragionamento dei modelli. I valori attualmente supportati sono `none`, `minimal`, `lowmedium`, , `high`e `xhigh`. Ridurre l'impegno di ragionamento può comportare risposte più veloci e meno token usati sul ragionamento in una risposta. - `gpt-5.1` il valore predefinito è `none`, che non esegue il ragionamento. I valori di ragionamento supportati per `gpt-5.1` sono `none`, `low`, `medium`e `high`. Le chiamate agli strumenti sono supportate per tutti i valori di ragionamento in gpt-5.1. - Tutti i modelli prima `gpt-5.1` di eseguire il ragionamento per impostazione predefinita `medium` e non supportano `none`. - Il `gpt-5-pro` modello usa per impostazione predefinita (e supporta solo) `high` il ragionamento. - `xhigh` è supportato per tutti i modelli dopo `gpt-5.1-codex-max`.	No
formato_risposta	OpenAI.CreateChatCompletionRequestResponseFormat	Oggetto che specifica il formato che il modello deve restituire. Impostazione di per abilitare `{ "type": "json_schema", "json_schema": {...} }` Output strutturati che garantiscono che il modello corrisponda al JSON fornito Schema. Altre informazioni negli output strutturati guida. L'impostazione su `{ "type": "json_object" }` abilita la modalità JSON precedente, che garantisce che il messaggio generato dal modello sia JSON valido. Utilizzo di `json_schema` è preferibile per i modelli che lo supportano.	No
└─ Tipo	OpenAI.CreateChatCompletionRequestResponseFormatType		Sì
safety_identifier	string	Identificatore stabile usato per rilevare gli utenti dell'applicazione che potrebbero violare i criteri di utilizzo di OpenAI. Gli ID devono essere una stringa che identifica in modo univoco ogni utente. È consigliabile eseguire l'hashing del nome utente o dell'indirizzo di posta elettronica per evitare di inviare informazioni di identificazione. Scopri di più.	No
seed	intero o nullo (obsoleto)	Questa funzione è in fase Beta. Se specificato, il sistema eseguirà un'operazione ottimale per campionare in modo deterministico, in modo che le richieste ripetute con gli stessi `seed` parametri e restituisca lo stesso risultato. Il determinismo non è garantito ed è necessario fare riferimento al `system_fingerprint` parametro di risposta per monitorare le modifiche nel back-end.	No
fermare	OpenAI.StopConfiguration	Non supportato con i modelli `o3` di ragionamento più recenti e `o4-mini`. Fino a 4 sequenze in cui l'API smetterà di generare altri token. Il il testo restituito non conterrà la sequenza di interruzione.	No
store	booleano o null	Decidere se salvare o meno l'output della richiesta di completamento della chat per utilizzare nella distillazione del modello o nei prodotti di valutazione.	No
stream	booleano o null	Se impostato su true, i dati di risposta del modello verranno trasmessi al client generato tramite eventi inviati dal server.	No
stream_options	OpenAI.ChatCompletionStreamOptions o null		No
Temperatura	number o null		No
tool_choice	OpenAI.ChatCompletionToolChoiceOption	Controlla quale (se presente) strumento viene chiamato dal modello. `none` indica che il modello non chiamerà alcuno strumento e genera invece un messaggio. `auto` indica che il modello può scegliere tra la generazione di un messaggio o la chiamata di uno o più strumenti. `required` significa che il modello deve chiamare uno o più strumenti. Specificare uno strumento specifico tramite `{"type": "function", "function": {"name": "my_function"}}` forza il modello a chiamare tale strumento. `none` è l'impostazione predefinita quando non sono presenti strumenti. `auto` è l'impostazione predefinita se sono presenti strumenti.	No
Strumenti	matrice di OpenAI.ChatCompletionTool o OpenAI.CustomToolChatCompletions	Un elenco di strumenti che il modello può chiamare. È possibile fornire uno dei due strumenti personalizzati o strumenti per le funzioni.	No
top_logprobs	integer o null		No
top_p	number o null		No
user	stringa (deprecata)	Identificatore univoco che rappresenta l'utente finale, che può essere utile monitorare e rilevare abusi.	No
user_security_context	AzureUserSecurityContext	Il contesto di sicurezza utente contiene diversi parametri che descrivono l'applicazione stessa e l'utente finale che interagisce con l'applicazione. Questi settori aiutano i team delle operazioni di sicurezza a indagare e mitigare gli incidenti di sicurezza fornendo un approccio completo alla protezione delle applicazioni IA. Altre informazioni sulla protezione delle applicazioni di intelligenza artificiale tramite Microsoft Defender per il cloud.	No
Dettaglio	OpenAI.Verbosity	Vincola il livello di dettaglio della risposta del modello. I valori inferiori genereranno risposte più concise, mentre valori più elevati generano risposte più dettagliate. I valori attualmente supportati sono `low`, `medium`, e `high`.	No

Risposte

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto	Type	Descrizione
application/json	oggetto o oggetto

Intestazioni di risposta:

Intestazione	Type	Description
apim-request-id	string	ID richiesta usato per la risoluzione dei problemi.

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	object

Name	Type	Obbligatorio
codice	stringa o null	Sì
inner_error		No
message	string	Sì
param	stringa o null	Sì
type	string	Sì

Intestazioni di risposta:

Intestazione	Type	Description
apim-request-id	string	ID richiesta usato per la risoluzione dei problemi.

Examples

Example

Crea un completamento per il prompt, i parametri e il modello scelto specificati.

POST {endpoint}/openai/v1/chat/completions?api-version=latest&azure-beta=v1=preview

{
  "model": "gpt-4o-mini",
  "messages": [
    {
      "role": "system",
      "content": "you are a helpful assistant that talks like a pirate"
    },
    {
      "role": "user",
      "content": "can you tell me how to care for a parrot?"
    }
  ]
}

Risposte:

Codice di stato: 200

{
  "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
  "created": 1686676106,
  "choices": [
    {
      "index": 0,
      "finish_reason": "stop",
      "message": {
        "role": "assistant",
        "content": "Ahoy matey! So ye be wantin' to care for a fine squawkin' parrot, eh? ..."
      }
    }
  ],
  "usage": {
    "completion_tokens": 557,
    "prompt_tokens": 33,
    "total_tokens": 590
  }
}

Components

AzureAIFoundryModelsApiVersion

Proprietà	Value
Type	string
Valori	`v1` `preview`

AzureContentFilterBlocklistResult

Raccolta di risultati di filtro true/false per gli elenchi di blocchi personalizzati configurati.

Name	Type	Description	Obbligatorio	Predefinito
details	matrice di oggetti	Coppie di ID elenco di blocchi singoli e se hanno generato un'azione di filtro.	No
filtered	boolean	Valore che indica se uno degli elenchi di blocchi dettagliati ha generato un'azione di filtro.	Sì

AzureContentFilterCompletionTextSpan

Rappresentazione di uno spezzone di testo completato utilizzata nei risultati del filtro dei contenuti di Azure OpenAI.

Name	Type	Description	Obbligatorio	Predefinito
completion_end_offset	intero (int32)	Offset del primo punto di codice UTF32 escluso dall'intervallo. Questo campo è sempre uguale a completion_start_offset per le campate vuote. Questo campo è sempre più grande di completion_start_offset per intervalli non vuoti.	Sì
completion_start_offset	intero (int32)	Offset rispetto al punto di codice UTF32 che inizia la campata.	Sì

AzureContentFilterCompletionTextSpanDetectionResult

Name	Type	Description	Obbligatorio
details	matrice di AzureContentFilterCompletionTextSpan	Informazioni dettagliate sugli intervalli di testo di completamento rilevati.	Sì
detected	boolean	Indica se la categoria di contenuto etichettata è stata rilevata nel contenuto.	Sì
filtered	boolean	Indica se il rilevamento del contenuto ha generato un'azione di filtro del contenuto.	Sì

AzureContentFilterCustomTopicResult

Raccolta di risultati di filtro true/false per gli argomenti personalizzati configurati.

Name	Type	Description	Obbligatorio	Predefinito
details	matrice di oggetti	Coppie di ID singoli argomenti e se vengono rilevate.	No
filtered	boolean	Valore che indica se uno degli argomenti dettagliati ha generato un'azione di filtro.	Sì

AzureContentFilterDetectionResult

Elemento del risultato del filtro contenuto con etichetta che indica se il contenuto è stato rilevato e se il contenuto è stato filtrato.

Name	Type	Description	Obbligatorio	Predefinito
detected	boolean	Indica se la categoria di contenuto etichettata è stata rilevata nel contenuto.	Sì
filtered	boolean	Indica se il rilevamento del contenuto ha generato un'azione di filtro del contenuto.	Sì

AzureContentFilterPersonallyIdentifiableInformationResult

Risultato del rilevamento del filtro del contenuto per informazioni personali che includono estensioni dannose.

Name	Type	Description	Obbligatorio
detected	boolean	Indica se la categoria di contenuto etichettata è stata rilevata nel contenuto.	Sì
filtered	boolean	Indica se il rilevamento del contenuto ha generato un'azione di filtro del contenuto.	Sì
redacted_text	string	Testo scritto con informazioni personali rimosse o mascherate.	No
sub_categories	matrice di AzurePiiSubCategoryResult	Risultati dettagliati per singoli PIIHarmSubCategory.	No

AzureContentFilterResultForChoice

Risultato di un filtro contenuto per un singolo elemento di risposta prodotto da un sistema di intelligenza artificiale generativo.

Name	Type	Description	Obbligatorio
custom_blocklists	AzureContentFilterBlocklistResult	Raccolta di risultati di filtro true/false per gli elenchi di blocchi personalizzati configurati.	No
└* dettagli	matrice di oggetti	Coppie di ID elenco di blocchi singoli e se hanno generato un'azione di filtro.	No
└* filtrato	boolean	Valore che indica se l'elenco di blocchi ha generato un'azione di filtro.	Sì
└* id	string	ID dell'elenco di blocchi personalizzato valutato.	Sì
└* filtrato	boolean	Valore che indica se uno degli elenchi di blocchi dettagliati ha generato un'azione di filtro.	Sì
custom_topics	AzureContentFilterCustomTopicResult	Raccolta di risultati di filtro true/false per gli argomenti personalizzati configurati.	No
└* dettagli	matrice di oggetti	Coppie di ID singoli argomenti e se vengono rilevate.	No
└> rilevato	boolean	Valore che indica se l'argomento viene rilevato.	Sì
└* id	string	ID dell'argomento personalizzato valutato.	Sì
└* filtrato	boolean	Valore che indica se uno degli argomenti dettagliati ha generato un'azione di filtro.	Sì
error	object	Se presente, vengono fornite informazioni dettagliate su un errore che impediva il completamento della valutazione del filtro del contenuto.	No
└─ codice	intero (int32)	Codice distinto e leggibile dal computer associato all'errore.	Sì
└* messaggio	string	Messaggio leggibile associato all'errore.	Sì
hate	AzureContentFilterSeverityResult	Elemento risultato filtro contenuto etichettato che indica se il contenuto è stato filtrato e quali sono i valori qualitativi il livello di gravità del contenuto è stato valutato in base alla configurazione del filtro contenuto per la categoria.	No
└* filtrato	boolean	Indica se la gravità del contenuto ha generato un'azione di filtro del contenuto.	Sì
└> gravità	enum	La gravità etichettata del contenuto. Valori possibili: `safe`, `low`, `medium`, `high`	Sì
personally_identifiable_information	AzureContentFilterPersonallyIdentifiableInformationResult	Risultato del rilevamento del filtro del contenuto per informazioni personali che includono estensioni dannose.	No
└ redacted_text	string	Testo scritto con informazioni personali rimosse o mascherate.	No
└ sotto_categorie	matrice di AzurePiiSubCategoryResult	Risultati dettagliati per singoli PIIHarmSubCategory.	No
profanity	AzureContentFilterDetectionResult	Elemento del risultato del filtro contenuto etichettato che indica se il contenuto è stato rilevato e se è presente. Filtrata.	No
└> rilevato	boolean	Indica se la categoria di contenuto etichettata è stata rilevata nel contenuto.	Sì
└* filtrato	boolean	Indica se il rilevamento del contenuto ha generato un'azione di filtro del contenuto.	Sì
protected_material_code	object	Risultato del rilevamento che descrive una corrispondenza rispetto al codice concesso in licenza o ad altri materiali di origine protetti.	No
└─ Citazione	object	Se disponibile, i dettagli della citazione che descrivono la licenza associata e la relativa posizione.	No
└─ URL	stringa (uri)	URL associato alla licenza.	No
└─ licenza	string	Nome o identificatore della licenza associata al rilevamento.	No
└> rilevato	boolean	Indica se la categoria di contenuto etichettata è stata rilevata nel contenuto.	Sì
└* filtrato	boolean	Indica se il rilevamento del contenuto ha generato un'azione di filtro del contenuto.	Sì
protected_material_text	AzureContentFilterDetectionResult	Elemento del risultato del filtro contenuto etichettato che indica se il contenuto è stato rilevato e se è presente. Filtrata.	No
└> rilevato	boolean	Indica se la categoria di contenuto etichettata è stata rilevata nel contenuto.	Sì
└* filtrato	boolean	Indica se il rilevamento del contenuto ha generato un'azione di filtro del contenuto.	Sì
self_harm	AzureContentFilterSeverityResult	Elemento risultato filtro contenuto etichettato che indica se il contenuto è stato filtrato e quali sono i valori qualitativi il livello di gravità del contenuto è stato valutato in base alla configurazione del filtro contenuto per la categoria.	No
└* filtrato	boolean	Indica se la gravità del contenuto ha generato un'azione di filtro del contenuto.	Sì
└> gravità	enum	La gravità etichettata del contenuto. Valori possibili: `safe`, `low`, `medium`, `high`	Sì
sexual	AzureContentFilterSeverityResult	Elemento risultato filtro contenuto etichettato che indica se il contenuto è stato filtrato e quali sono i valori qualitativi il livello di gravità del contenuto è stato valutato in base alla configurazione del filtro contenuto per la categoria.	No
└* filtrato	boolean	Indica se la gravità del contenuto ha generato un'azione di filtro del contenuto.	Sì
└> gravità	enum	La gravità etichettata del contenuto. Valori possibili: `safe`, `low`, `medium`, `high`	Sì
ungrounded_material	AzureContentFilterCompletionTextSpanDetectionResult		No
violence	AzureContentFilterSeverityResult	Elemento risultato filtro contenuto etichettato che indica se il contenuto è stato filtrato e quali sono i valori qualitativi il livello di gravità del contenuto è stato valutato in base alla configurazione del filtro contenuto per la categoria.	No
└* filtrato	boolean	Indica se la gravità del contenuto ha generato un'azione di filtro del contenuto.	Sì
└> gravità	enum	La gravità etichettata del contenuto. Valori possibili: `safe`, `low`, `medium`, `high`	Sì

AzureContentFilterResultForPrompt

Risultato di un filtro contenuto associato a un singolo elemento del prompt di input in un sistema di intelligenza artificiale generativo.

Name	Type	Description	Obbligatorio
content_filter_results	object	Dettagli della categoria del filtro contenuto per il risultato.	No
└─ liste_blocchi_personalizzate	AzureContentFilterBlocklistResult	Raccolta di risultati di filtro true/false per gli elenchi di blocchi personalizzati configurati.	No
└* dettagli	matrice di oggetti	Coppie di ID elenco di blocchi singoli e se hanno generato un'azione di filtro.	No
└* filtrato	boolean	Valore che indica se l'elenco di blocchi ha generato un'azione di filtro.	Sì
└* id	string	ID dell'elenco di blocchi personalizzato valutato.	Sì
└* filtrato	boolean	Valore che indica se uno degli elenchi di blocchi dettagliati ha generato un'azione di filtro.	Sì
└custom_topics	AzureContentFilterCustomTopicResult	Raccolta di risultati di filtro true/false per gli argomenti personalizzati configurati.	No
└* dettagli	matrice di oggetti	Coppie di ID singoli argomenti e se vengono rilevate.	No
└> rilevato	boolean	Valore che indica se l'argomento viene rilevato.	Sì
└* id	string	ID dell'argomento personalizzato valutato.	Sì
└* filtrato	boolean	Valore che indica se uno degli argomenti dettagliati ha generato un'azione di filtro.	Sì
└─ Errore	object	Se presente, vengono fornite informazioni dettagliate su un errore che impediva il completamento della valutazione del filtro del contenuto.	No
└─ codice	intero (int32)	Codice distinto e leggibile dal computer associato all'errore.	Sì
└* messaggio	string	Messaggio leggibile associato all'errore.	Sì
└> odio	AzureContentFilterSeverityResult	Elemento risultato filtro contenuto etichettato che indica se il contenuto è stato filtrato e quali sono i valori qualitativi il livello di gravità del contenuto è stato valutato in base alla configurazione del filtro contenuto per la categoria.	No
└* filtrato	boolean	Indica se la gravità del contenuto ha generato un'azione di filtro del contenuto.	Sì
└> gravità	enum	La gravità etichettata del contenuto. Valori possibili: `safe`, `low`, `medium`, `high`	Sì
└attacco indiretto	AzureContentFilterDetectionResult	Elemento del risultato del filtro contenuto etichettato che indica se il contenuto è stato rilevato e se è presente. Filtrata.	Sì
└> rilevato	boolean	Indica se la categoria di contenuto etichettata è stata rilevata nel contenuto.	Sì
└* filtrato	boolean	Indica se il rilevamento del contenuto ha generato un'azione di filtro del contenuto.	Sì
└* jailbreak	AzureContentFilterDetectionResult	Elemento del risultato del filtro contenuto etichettato che indica se il contenuto è stato rilevato e se è presente. Filtrata.	Sì
└> rilevato	boolean	Indica se la categoria di contenuto etichettata è stata rilevata nel contenuto.	Sì
└* filtrato	boolean	Indica se il rilevamento del contenuto ha generato un'azione di filtro del contenuto.	Sì
└* volgarità	AzureContentFilterDetectionResult	Elemento del risultato del filtro contenuto etichettato che indica se il contenuto è stato rilevato e se è presente. Filtrata.	No
└> rilevato	boolean	Indica se la categoria di contenuto etichettata è stata rilevata nel contenuto.	Sì
└* filtrato	boolean	Indica se il rilevamento del contenuto ha generato un'azione di filtro del contenuto.	Sì
└─ autolesionismo	AzureContentFilterSeverityResult	Elemento risultato filtro contenuto etichettato che indica se il contenuto è stato filtrato e quali sono i valori qualitativi il livello di gravità del contenuto è stato valutato in base alla configurazione del filtro contenuto per la categoria.	No
└* filtrato	boolean	Indica se la gravità del contenuto ha generato un'azione di filtro del contenuto.	Sì
└> gravità	enum	La gravità etichettata del contenuto. Valori possibili: `safe`, `low`, `medium`, `high`	Sì
└─ sessuale	AzureContentFilterSeverityResult	Elemento risultato filtro contenuto etichettato che indica se il contenuto è stato filtrato e quali sono i valori qualitativi il livello di gravità del contenuto è stato valutato in base alla configurazione del filtro contenuto per la categoria.	No
└* filtrato	boolean	Indica se la gravità del contenuto ha generato un'azione di filtro del contenuto.	Sì
└> gravità	enum	La gravità etichettata del contenuto. Valori possibili: `safe`, `low`, `medium`, `high`	Sì
└* violenza	AzureContentFilterSeverityResult	Elemento risultato filtro contenuto etichettato che indica se il contenuto è stato filtrato e quali sono i valori qualitativi il livello di gravità del contenuto è stato valutato in base alla configurazione del filtro contenuto per la categoria.	No
└* filtrato	boolean	Indica se la gravità del contenuto ha generato un'azione di filtro del contenuto.	Sì
└> gravità	enum	La gravità etichettata del contenuto. Valori possibili: `safe`, `low`, `medium`, `high`	Sì
prompt_index	intero (int32)	Indice del prompt di input associato alle categorie di risultati del filtro contenuto associato.	No

AzureContentFilterSeverityResult

Elemento del risultato del filtro contenuto etichettato che indica se il contenuto è stato filtrato e quale livello di gravità qualitativo del contenuto è stato valutato in base alla configurazione del filtro contenuto per la categoria.

Name	Type	Description	Obbligatorio	Predefinito
filtered	boolean	Indica se la gravità del contenuto ha generato un'azione di filtro del contenuto.	Sì
Gravità	enum	La gravità etichettata del contenuto. Valori possibili: `safe`, `low`, `medium`, `high`	Sì

AzurePiiSubCategoryResult

Dettagli dei risultati per singoli PIIHarmSubCategory.Result details for individual PIIHarmSubCategory(s).

Name	Type	Description	Obbligatorio
detected	boolean	Indica se la sottocategoria contenuto etichettata è stata rilevata nel contenuto.	Sì
filtered	boolean	Indica se il rilevamento del contenuto ha generato un'azione di filtro del contenuto per questa sottocategoria.	Sì
Redatto	boolean	Indica se il contenuto è stato redatto per questa sottocategoria.	Sì
sub_category	string	PIIHarmSubCategory valutato.	Sì

AzureUserSecurityContext

Il contesto di sicurezza utente contiene diversi parametri che descrivono l'applicazione stessa e l'utente finale che interagisce con l'applicazione. Questi settori aiutano i team delle operazioni di sicurezza a indagare e mitigare gli incidenti di sicurezza fornendo un approccio completo alla protezione delle applicazioni IA. Altre informazioni sulla protezione delle applicazioni di intelligenza artificiale tramite Microsoft Defender per il cloud.

Name	Type	Description	Obbligatorio
application_name	string	Nome dell'applicazione. Informazioni personali sensibili non dovrebbero essere incluse in questo campo.	No
end_user_id	string	Questo identificatore è l'ID oggetto utente Microsoft Entra ID (in precedenza Azure Active Directory) usato per autenticare gli utenti finali all'interno dell'applicazione di intelligenza artificiale generativa. Informazioni personali sensibili non dovrebbero essere incluse in questo campo.	No
end_user_tenant_id	string	ID tenant Microsoft 365 cui appartiene l'utente finale. È necessario quando l'applicazione di intelligenza artificiale generativa è multi-tenant.	No
source_ip	string	Acquisisce l'indirizzo IP del client originale.	No

OpenAI.ChatCompletionAllowedTools

Strumenti consentiti

Vincola gli strumenti disponibili al modello a un set predefinito.

Name	Type	Description	Obbligatorio	Predefinito
mode	enum	Vincola gli strumenti disponibili al modello a un set predefinito. `auto` consente al modello di scegliere tra gli strumenti consentiti e generare un messaggio. `required` richiede al modello di chiamare uno o più degli strumenti consentiti. Valori possibili: `auto`, `required`	Sì
Strumenti	matrice di oggetti	Elenco di definizioni degli strumenti che il modello deve essere autorizzato a chiamare. Per l'API Completamento chat, l'elenco delle definizioni degli strumenti potrebbe essere simile al seguente: `json<br> [<br> { "type": "function", "function": { "name": "get_weather" } },<br> { "type": "function", "function": { "name": "get_time" } }<br> ]<br>`	Sì

OpenAI.ChatCompletionAllowedToolsChoice

Strumenti consentiti

Vincola gli strumenti disponibili al modello a un set predefinito.

Name	Type	Description	Obbligatorio	Predefinito
strumenti consentiti	OpenAI.ChatCompletionAllowedTools	Vincola gli strumenti disponibili al modello a un set predefinito.	Sì
type	enum	Tipo di configurazione dello strumento consentito. Sempre `allowed_tools`. Valori possibili: `allowed_tools`	Sì

OpenAI.ChatCompletionFunctionCallOption

Specificare una particolare funzione via {"name": "my_function"} obbliga il modello a chiamare quella funzione.

Name	Type	Description	Obbligatorio	Predefinito
nome	string	Il nome della funzione da chiamare.	Sì

OpenAI.ChatCompletionFunctions

Name	Type	Description	Obbligatorio
descrizione	string	Una descrizione di ciò che fa la funzione, usata dal modello per scegliere quando e come chiamarla.	No
nome	string	Nome della funzione che deve essere chiamata. Devono essere dalla a-z, dalla A-Z, da 0 a 9, oppure contenere sottolineamenti e trattini, con una lunghezza massima di 64.	Sì
parameters	OpenAI.FunctionParameters	I parametri che le funzioni accettano, descritti come un oggetto JSON Schema. Consulta la guida per esempi e il riferimento allo schema JSON per la documentazione sul formato. Omettere `parameters` definisce una funzione con una lista di parametri vuota.	No

OpenAI.ChatCompletionMessageCustomToolCall

Chiamata di uno strumento personalizzato

Chiamata a uno strumento personalizzato creato dal modello.

Name	Type	Description	Obbligatorio
custom	OpenAI.ChatCompletionMessageCustomToolCallCustom		Sì
└ Input	string		Sì
└> nome	string		Sì
id	string	ID della chiamata allo strumento.	Sì
type	enum	Tipo dello strumento. Sempre `custom`. Valori possibili: `custom`	Sì

OpenAI.ChatCompletionMessageCustomToolCallCustom

Name	Type	Description	Obbligatorio	Predefinito
input	string		Sì
nome	string		Sì

OpenAI.ChatCompletionMessageToolCall

Chiamata dello strumento funzionale

Chiamata a uno strumento di funzione creato dal modello.

Name	Type	Description	Obbligatorio
funzione	OpenAI.ChatCompletionMessageToolCallFunction		Sì
└─ Argomenti	string		Sì
└> nome	string		Sì
id	string	ID della chiamata allo strumento.	Sì
type	enum	Tipo dello strumento. Attualmente è supportato solo `function`. Valori possibili: `function`	Sì

OpenAI.ChatCompletionMessageToolCallChunk

Name	Type	Description	Obbligatorio
funzione	OpenAI.ChatCompletionMessageToolCallChunkFunction		No
id	string	ID della chiamata allo strumento.	No
index	integer		Sì
type	enum	Tipo dello strumento. Attualmente è supportato solo `function`. Valori possibili: `function`	No

OpenAI.ChatCompletionMessageToolCallChunkFunction

Name	Type	Description	Obbligatorio	Predefinito
arguments	string		No
nome	string		No

OpenAI.ChatCompletionMessageToolCallFunction

Name	Type	Description	Obbligatorio	Predefinito
arguments	string		Sì
nome	string		Sì

OpenAI.ChatCompletionMessageToolCalls

Le chiamate degli strumenti generate dal modello, come le chiamate di funzione.

OpenAI.ChatCompletionMessageToolCallsItem

Le chiamate degli strumenti generate dal modello, come le chiamate di funzione.

OpenAI.ChatCompletionNamedToolChoice

Scelta dello strumento funzionale

Specifica uno strumento che il modello deve usare. Usa per forzare il modello a chiamare una funzione specifica.

Name	Type	Description	Obbligatorio	Predefinito
funzione	OpenAI.ChatCompletionNamedToolChoiceFunction		Sì
type	enum	Per la chiamata di funzione, il tipo è sempre `function`. Valori possibili: `function`	Sì

OpenAI.ChatCompletionNamedToolChoiceCustom

Scelta dello strumento personalizzato

Specifica uno strumento che il modello deve usare. Usare per forzare il modello a chiamare uno strumento personalizzato specifico.

Name	Type	Description	Obbligatorio	Predefinito
custom	OpenAI.ChatCompletionNamedToolChoiceCustomCustom		Sì
type	enum	Per la chiamata a uno strumento personalizzato, il tipo è sempre `custom`. Valori possibili: `custom`	Sì

OpenAI.ChatCompletionNamedToolChoiceCustomCustom

Name	Type	Description	Obbligatorio	Predefinito
nome	string		Sì

OpenAI.ChatCompletionNamedToolChoiceFunction

Name	Type	Description	Obbligatorio	Predefinito
nome	string		Sì

OpenAI.ChatCompletionRequestAssistantMessage

Messaggio dell'assistente

Messaggi inviati dal modello in risposta ai messaggi utente.

Name	Type	Description	Obbligatorio
Audio	OpenAI.ChatCompletionRequestAssistantMessageAudio o null	Dati relativi a una risposta audio precedente dal modello.	No
contenuto	stringa o matrice di OpenAI.ChatCompletionRequestAssistantMessageContentPart o null		No
function_call	OpenAI.ChatCompletionRequestAssistantMessageFunctionCall o null		No
nome	string	Un nome opzionale per il partecipante. Fornisce le informazioni sul modello per distinguere i partecipanti dello stesso ruolo.	No
refusal	stringa o null		No
Ruolo	enum	Ruolo dell'autore dei messaggi, in questo caso `assistant`. Valori possibili: `assistant`	Sì
tool_calls	OpenAI.ChatCompletionMessageToolCalls	Le chiamate degli strumenti generate dal modello, come le chiamate di funzione.	No

OpenAI.ChatCompletionRequestAssistantMessageAudio

Name	Type	Description	Obbligatorio	Predefinito
id	string		Sì

OpenAI.ChatCompletionRequestAssistantMessageContentPart

Discriminatorio per OpenAI.ChatCompletionRequestAssistantMessageContentPart

Questo componente usa la proprietà type per distinguere tra tipi diversi:

Valore del tipo	Schema
`refusal`	OpenAI.ChatCompletionRequestMessageContentPartRefusal
`text`	OpenAI.ChatCompletionRequestAssistantMessageContentPartChatCompletionRequestMessageContentPartText

Name	Type	Description	Obbligatorio	Predefinito
type	OpenAI.ChatCompletionRequestAssistantMessageContentPartType		Sì

OpenAI.ChatCompletionRequestAssistantMessageContentPartChatCompletionRequestMessageContentPartText

Parte del contenuto testuale

Informazioni sugli input di testo.

Name	Type	Description	Obbligatorio	Predefinito
text	string	Contenuto di testo.	Sì
type	enum	Tipo della parte di contenuto. Valori possibili: `text`	Sì

OpenAI.ChatCompletionRequestAssistantMessageContentPartType

Proprietà	Value
Type	string
Valori	`text` `refusal`

OpenAI.ChatCompletionRequestAssistantMessageFunctionCall

Name	Type	Description	Obbligatorio	Predefinito
arguments	string		Sì
nome	string		Sì

OpenAI.ChatCompletionRequestDeveloperMessage

Messaggio dello sviluppatore

Istruzioni fornite dagli sviluppatori che il modello dovrebbe seguire, indipendentemente dai messaggi inviati dall'utente. Con i modelli O1 e quelli più recenti, developer i messaggi sostituiscono quelli precedenti system .

Name	Type	Description	Obbligatorio
contenuto	stringa o matrice di OpenAI.ChatCompletionRequestMessageContentPartText	Il contenuto del messaggio dello sviluppatore.	Sì
nome	string	Un nome opzionale per il partecipante. Fornisce le informazioni sul modello per distinguere i partecipanti dello stesso ruolo.	No
Ruolo	enum	Ruolo dell'autore dei messaggi, in questo caso `developer`. Valori possibili: `developer`	Sì

OpenAI.ChatCompletionRequestFunctionMessage

Messaggio funzionale

Name	Type	Description	Obbligatorio
contenuto	stringa o null		Sì
nome	string	Il nome della funzione da chiamare.	Sì
Ruolo	enum	Ruolo dell'autore dei messaggi, in questo caso `function`. Valori possibili: `function`	Sì

OpenAI.ChatCompletionRequestMessage

Discriminare per OpenAI.ChatCompletionRequestMessage

Questo componente usa la proprietà role per distinguere tra tipi diversi:

Valore del tipo	Schema
`assistant`	OpenAI.ChatCompletionRequestAssistantMessage
`developer`	OpenAI.ChatCompletionRequestDeveloperMessage
`function`	OpenAI.ChatCompletionRequestFunctionMessage
`system`	OpenAI.ChatCompletionRequestSystemMessage
`user`	OpenAI.ChatCompletionRequestUserMessage
`tool`	OpenAI.ChatCompletionRequestToolMessage

Name	Type	Description	Obbligatorio	Predefinito
Ruolo	OpenAI.ChatCompletionRequestMessageType		Sì

OpenAI.ChatCompletionRequestMessageContentPartAudio

Parte dei contenuti audio

Name	Type	Description	Obbligatorio	Predefinito
input_audio	OpenAI.ChatCompletionRequestMessageContentPartAudioInputAudio		Sì
type	enum	Tipo della parte di contenuto. Sempre `input_audio`. Valori possibili: `input_audio`	Sì

OpenAI.ChatCompletionRequestMessageContentPartAudioInputAudio

Name	Type	Description	Obbligatorio	Predefinito
data	string		Sì
format	enum	Valori possibili: `wav`, `mp3`	Sì

OpenAI.ChatCompletionRequestMessageContentPartFile

Parte del contenuto del file

Informazioni sugli input di file per la generazione di testo.

Name	Type	Description	Obbligatorio
file	OpenAI.ChatCompletionRequestMessageContentPartFileFile		Sì
└─ file_data	string		No
└ file_id	string		No
└─ nome file	string		No
type	enum	Tipo della parte di contenuto. Sempre `file`. Valori possibili: `file`	Sì

OpenAI.ChatCompletionRequestMessageContentPartFileFile

Name	Type	Obbligatorio
file_data	string	No
ID del file	string	No
filename	string	No

OpenAI.ChatCompletionRequestMessageContentPartImage

Parte del contenuto dell'immagine

Name	Type	Description	Obbligatorio	Predefinito
image_url	OpenAI.ChatCompletionRequestMessageContentPartImageUrl		Sì
type	enum	Tipo della parte di contenuto. Valori possibili: `image_url`	Sì

OpenAI.ChatCompletionRequestMessageContentPartImageUrl

Name	Type	Description	Obbligatorio	Predefinito
Dettaglio	enum	Valori possibili: `auto`, `low`, `high`	No	auto
url	stringa (uri)		Sì

OpenAI.ChatCompletionRequestMessageContentPartRefusal

Parte del rifiuto del contenuto

Name	Type	Description	Obbligatorio	Predefinito
refusal	string	Il messaggio di rifiuto generato dal modello.	Sì
type	enum	Tipo della parte di contenuto. Valori possibili: `refusal`	Sì

OpenAI.ChatCompletionRequestMessageContentPartText

Parte del contenuto testuale

Name	Type	Description	Obbligatorio	Predefinito
text	string	Contenuto di testo.	Sì
type	enum	Tipo della parte di contenuto. Valori possibili: `text`	Sì

OpenAI.ChatCompletionRequestMessageType

Proprietà	Value
Type	string
Valori	`developer` `system` `user` `assistant` `tool` `function`

OpenAI.ChatCompletionRequestSystemMessage

Messaggio di sistema

Istruzioni fornite dagli sviluppatori che il modello dovrebbe seguire, indipendentemente dai messaggi inviati dall'utente. Con i modelli o1 e versioni successive, usare i messaggi developer invece per questo scopo.

Name	Type	Description	Obbligatorio
contenuto	stringa o matrice di OpenAI.ChatCompletionRequestSystemMessageContentPart	Il contenuto del messaggio di sistema.	Sì
nome	string	Un nome opzionale per il partecipante. Fornisce le informazioni sul modello per distinguere i partecipanti dello stesso ruolo.	No
Ruolo	enum	Ruolo dell'autore dei messaggi, in questo caso `system`. Valori possibili: `system`	Sì

OpenAI.ChatCompletionRequestSystemMessageContentPart

Riferimenti: OpenAI.ChatCompletionRequestMessageContentPartText

OpenAI.ChatCompletionRequestToolMessage

Messaggio dello strumento

Name	Type	Description	Obbligatorio
contenuto	stringa o matrice di OpenAI.ChatCompletionRequestToolMessageContentPart	Il contenuto del messaggio dello strumento.	Sì
Ruolo	enum	Ruolo dell'autore dei messaggi, in questo caso `tool`. Valori possibili: `tool`	Sì
tool_call_id	string	Chiamare lo strumento a cui risponde questo messaggio.	Sì

OpenAI.ChatCompletionRequestToolMessageContentPart

Riferimenti: OpenAI.ChatCompletionRequestMessageContentPartText

OpenAI.ChatCompletionRequestUserMessage

Messaggio utente

Messaggi inviati da un utente finale, contenenti richieste o informazioni di contesto aggiuntive.

Name	Type	Description	Obbligatorio
contenuto	stringa o matrice di OpenAI.ChatCompletionRequestUserMessageContentPart	Contenuto del messaggio utente.	Sì
nome	string	Un nome opzionale per il partecipante. Fornisce le informazioni sul modello per distinguere i partecipanti dello stesso ruolo.	No
Ruolo	enum	Ruolo dell'autore dei messaggi, in questo caso `user`. Valori possibili: `user`	Sì

OpenAI.ChatCompletionRequestUserMessageContentPart

Discriminare per OpenAI.ChatCompletionRequestUserMessageContentPart

Questo componente usa la proprietà type per distinguere tra tipi diversi:

Valore del tipo	Schema
`image_url`	OpenAI.ChatCompletionRequestMessageContentPartImage
`input_audio`	OpenAI.ChatCompletionRequestMessageContentPartAudio
`file`	OpenAI.ChatCompletionRequestMessageContentPartFile
`text`	OpenAI.ChatCompletionRequestUserMessageContentPartChatCompletionRequestMessageContentPartText

Name	Type	Description	Obbligatorio	Predefinito
type	OpenAI.ChatCompletionRequestUserMessageContentPartType		Sì

OpenAI.ChatCompletionRequestUserMessageContentPartChatCompletionRequestMessageContentPartText

Parte del contenuto testuale

Informazioni sugli input di testo.

Name	Type	Description	Obbligatorio	Predefinito
text	string	Contenuto di testo.	Sì
type	enum	Tipo della parte di contenuto. Valori possibili: `text`	Sì

OpenAI.ChatCompletionRequestUserMessageContentPartType

Proprietà	Value
Type	string
Valori	`text` `image_url` `input_audio` `file`

OpenAI.ChatCompletionResponseMessage

Se viene richiesta la modalità di output audio, questo oggetto contiene dati sulla risposta audio del modello.

Name	Type	Description	Obbligatorio
annotations	matrice di OpenAI.ChatCompletionResponseMessageAnnotations	Annotazioni per il messaggio, se applicabile, ad esempio quando viene utilizzato strumento di ricerca Web.	No
Audio	OpenAI.ChatCompletionResponseMessageAudio o null		No
contenuto	stringa o null		Sì
function_call	OpenAI.ChatCompletionResponseMessageFunctionCall (deprecato)		No
└─ Argomenti	string		Sì
└> nome	string		Sì
reasoning_content	string	Proprietà di estensione specifica di Azure contenente contenuto di ragionamento generato dai modelli supportati.	No
refusal	stringa o null		Sì
Ruolo	enum	Ruolo dell'autore del messaggio. Valori possibili: `assistant`	Sì
tool_calls	OpenAI.ChatCompletionMessageToolCallsItem	Le chiamate degli strumenti generate dal modello, come le chiamate di funzione.	No

OpenAI.ChatCompletionResponseMessageAnnotations

Name	Type	Description	Obbligatorio	Predefinito
type	enum	Valori possibili: `url_citation`	Sì
url_citation	OpenAI.ChatCompletionResponseMessageAnnotationsUrlCitation		Sì

OpenAI.ChatCompletionResponseMessageAnnotationsUrlCitation

Name	Type	Obbligatorio
end_index	integer	Sì
start_index	integer	Sì
Titolo	string	Sì
url	string	Sì

OpenAI.ChatCompletionResponseMessageAudio

Name	Type	Obbligatorio
data	string	Sì
scade_il	intero (unixtime)	Sì
id	string	Sì
Trascrizione	string	Sì

OpenAI.ChatCompletionResponseMessageFunctionCall

Name	Type	Description	Obbligatorio	Predefinito
arguments	string		Sì
nome	string		Sì

OpenAI.ChatCompletionStreamOptions

Opzioni per la risposta allo streaming. Impostare questa impostazione solo quando si imposta stream: true.

Name	Type	Description	Obbligatorio	Predefinito
include_obfuscation	boolean	Se true, l'offuscamento del flusso verrà abilitato. Aggiunta dell'offuscamento del flusso caratteri casuali in un `obfuscation` campo sugli eventi delta di streaming a normalizzare le dimensioni del payload come mitigazione per determinati attacchi sul canale laterale. Questi campi offuscamento sono inclusi per impostazione predefinita, ma aggiungono una piccola quantità sovraccarico per il flusso di dati. È possibile impostare su `include_obfuscation` false per ottimizzare la larghezza di banda se si considera attendibile il collegamento di rete tra l'applicazione e l'API OpenAI.	No
include_usage	boolean	Se impostato, un blocco aggiuntivo verrà trasmesso prima del `data: [DONE]` messaggio. Il `usage` campo in questo blocco mostra le statistiche di utilizzo dei token per l'intera richiesta e il `choices` campo sarà sempre vuoto array Tutti gli altri blocchi includeranno anche un `usage` campo, ma con un valore Null Valore. NOTA: Se il flusso viene interrotto, è possibile che non venga ricevuto blocco di utilizzo finale che contiene l'utilizzo totale dei token per la richiesta.	No

OpenAI.ChatCompletionStreamResponseDelta

Un delta di completamento della chat generato dalle risposte del modello in streaming.

Name	Type	Description	Obbligatorio
contenuto	stringa o null		No
function_call	OpenAI.ChatCompletionStreamResponseDeltaFunctionCall (deprecato)		No
└─ Argomenti	string		No
└> nome	string		No
reasoning_content	string	Proprietà di estensione specifica di Azure contenente contenuto di ragionamento generato dai modelli supportati.	No
refusal	stringa o null		No
Ruolo	enum	Ruolo dell'autore del messaggio. Valori possibili: `developer`, `systemuser`, , `assistant`,`tool`	No
tool_calls	matrice di OpenAI.ChatCompletionMessageToolCallChunk		No

OpenAI.ChatCompletionStreamResponseDeltaFunctionCall

Name	Type	Description	Obbligatorio	Predefinito
arguments	string		No
nome	string		No

OpenAI.ChatCompletionTokenLogprob

Name	Type	Description	Obbligatorio
bytes	matrice di numeri interi o null		Sì
logprob	Numero	La probabilità logaritmica di questo token, se si trova tra i primi 20 token più probabili. Altrimenti, il valore `-9999.0` viene usato per indicare che il token è molto improbabile.	Sì
token	string	Token.	Sì
top_logprobs	matrice di OpenAI.ChatCompletionTokenLogprobTopLogprobs	Elenco dei token più probabili e della loro probabilità logarithmita, in questa posizione del token. In rari casi, può essere presente un numero inferiore al numero di richieste restituite `top_logprobs` .	Sì

OpenAI.ChatCompletionTokenLogprobTopLogprobs

Name	Type	Obbligatorio
bytes	matrice di numeri interi o null	Sì
logprob	Numero	Sì
token	string	Sì

OpenAI.ChatCompletionTool

Strumento funzionale

Strumento di funzione che può essere usato per generare una risposta.

Name	Type	Description	Obbligatorio	Predefinito
funzione	OpenAI.FunctionObject		Sì
type	enum	Tipo dello strumento. Attualmente è supportato solo `function`. Valori possibili: `function`	Sì

OpenAI.ChatCompletionToolChoiceOption

Controlla quale (se presente) strumento viene chiamato dal modello. none indica che il modello non chiamerà alcuno strumento e genera invece un messaggio. auto indica che il modello può scegliere tra la generazione di un messaggio o la chiamata di uno o più strumenti. required significa che il modello deve chiamare uno o più strumenti. Specificare uno strumento specifico tramite {"type": "function", "function": {"name": "my_function"}} forza il modello a chiamare tale strumento. none è l'impostazione predefinita quando non sono presenti strumenti. auto è l'impostazione predefinita se sono presenti strumenti.

Tipo: string o OpenAI.ChatCompletionAllowedToolsChoice o OpenAI.ChatCompletionNamedToolChoice o OpenAI.ChatCompletionNamedToolChoiceCustom

OpenAI.CompletionUsage

Statistiche di utilizzo per la richiesta di completamento.

Name	Type	Description	Obbligatorio
completion_tokens	integer	Numero di gettoni nel completamento generato.	Sì
completion_tokens_details	OpenAI.CompletionUsageCompletionTokensDetails		No
└─ token_di_predizione_accettati	integer		No
└audio_tokens	integer		No
└─ token_di_ragionamento	integer		No
└rejected_prediction_tokens	integer		No
prompt_tokens	integer	Numero di token nel prompt.	Sì
prompt_tokens_details	OpenAI.CompletionUsagePromptTokensDetails		No
└audio_tokens	integer		No
└cached_tokens	integer		No
total_tokens	integer	Numero totale di token utilizzati nella richiesta (prompt + completamento).	Sì

OpenAI.CompletionUsageCompletionTokensDetails

Name	Type	Obbligatorio
accepted_prediction_tokens	integer	No
audio_tokens	integer	No
reasoning_tokens	integer	No
rejected_prediction_tokens	integer	No

OpenAI.CompletionUsagePromptTokensDetails

Name	Type	Description	Obbligatorio	Predefinito
audio_tokens	integer		No
cached_tokens	integer		No

OpenAI.CreateChatCompletionRequestAudio

Name	Type	Description	Obbligatorio	Predefinito
format	enum	Valori possibili: `wav`, `aacmp3`, `flac`, , `opuspcm16`	Sì
Voce	OpenAI.VoiceIdsShared		Sì

OpenAI.CreateChatCompletionRequestResponseFormat

Oggetto che specifica il formato che il modello deve restituire. L'impostazione su { "type": "json_schema", "json_schema": {...} } abilita gli output strutturati che garantisce che il modello corrisponda allo schema JSON fornito. Per altre informazioni, vedere la Guida agli output strutturati. L'impostazione su { "type": "json_object" } abilita la modalità JSON precedente, che garantisce che il messaggio generato dal modello sia JSON valido. L'uso json_schema è preferibile per i modelli che lo supportano.

Discriminare per OpenAI.CreateChatCompletionRequestResponseFormat

Questo componente usa la proprietà type per distinguere tra tipi diversi:

Valore del tipo	Schema
`json_schema`	OpenAI.ResponseFormatJsonSchema
`text`	OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatText
`json_object`	OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatJsonObject

Name	Type	Description	Obbligatorio	Predefinito
type	OpenAI.CreateChatCompletionRequestResponseFormatType		Sì

OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatJsonObject

Oggetto JSON

Formato della risposta dell'oggetto JSON. Metodo precedente di generazione di risposte JSON. Si consiglia di utilizzare json_schema per i modelli che lo supportano. Si noti che il modello non genererà JSON senza un messaggio di sistema o utente che lo istruisca a farlo.

Name	Type	Description	Obbligatorio	Predefinito
type	enum	Tipo di formato di risposta definito. Sempre `json_object`. Valori possibili: `json_object`	Sì

OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatText

Testo

Formato di risposta predefinito. Usato per generare risposte di testo.

Name	Type	Description	Obbligatorio	Predefinito
type	enum	Tipo di formato di risposta definito. Sempre `text`. Valori possibili: `text`	Sì

OpenAI.CreateChatCompletionRequestResponseFormatType

Proprietà	Value
Type	string
Valori	`text` `json_schema` `json_object`

OpenAI.CreateChatCompletionResponseChoices

Name	Type	Description	Obbligatorio
content_filter_results	AzureContentFilterResultForChoice	Risultato di un filtro contenuto per un singolo elemento di risposta prodotto da un sistema di intelligenza artificiale generativo.	No
finish_reason	enum	Valori possibili: `stop`, `lengthtool_calls`, , `content_filter`,`function_call`	Sì
index	integer		Sì
logprobs	OpenAI.CreateChatCompletionResponseChoicesLogprobs o null		Sì
message	OpenAI.ChatCompletionResponseMessage	Se viene richiesta la modalità di output audio, questo oggetto contiene dati sulla risposta audio del modello.	Sì

OpenAI.CreateChatCompletionResponseChoicesLogprobs

Name	Type	Description	Obbligatorio	Predefinito
contenuto	matrice di OpenAI.ChatCompletionTokenLogprob o null		Sì
refusal	matrice di OpenAI.ChatCompletionTokenLogprob o null		Sì

OpenAI.CreateChatCompletionStreamResponseChoices

Name	Type	Description	Obbligatorio
delta	OpenAI.ChatCompletionStreamResponseDelta	Un delta di completamento della chat generato dalle risposte del modello in streaming.	Sì
finish_reason	stringa o null		Sì
index	integer		Sì
logprobs	OpenAI.CreateChatCompletionStreamResponseChoicesLogprobs o null		No

OpenAI.CreateChatCompletionStreamResponseChoicesLogprobs

Name	Type	Description	Obbligatorio	Predefinito
contenuto	matrice di OpenAI.ChatCompletionTokenLogprob o null		Sì
refusal	matrice di OpenAI.ChatCompletionTokenLogprob o null		Sì

OpenAI.CustomToolChatCompletions

Strumento personalizzato

Strumento personalizzato che elabora l'input usando un formato specificato.

Name	Type	Description	Obbligatorio
custom	OpenAI.CustomToolChatCompletionsCustom		Sì
└* descrizione	string		No
└* formato	OpenAI.CustomToolChatCompletionsCustomFormatText o OpenAI.CustomToolChatCompletionsCustomFormatGrammar		No
└> nome	string		Sì
type	enum	Tipo dello strumento personalizzato. Sempre `custom`. Valori possibili: `custom`	Sì

OpenAI.CustomToolChatCompletionsCustom

Name	Type	Obbligatorio
descrizione	string	No
format	OpenAI.CustomToolChatCompletionsCustomFormatText o OpenAI.CustomToolChatCompletionsCustomFormatGrammar	No
nome	string	Sì

OpenAI.CustomToolChatCompletionsCustomFormatGrammar

Name	Type	Description	Obbligatorio
Grammatica	OpenAI.CustomToolChatCompletionsCustomFormatGrammarGrammar		Sì
Definizione └*	string		Sì
Sintassi └++	enum	Valori possibili: `lark`, `regex`	Sì
type	enum	Valori possibili: `grammar`	Sì

OpenAI.CustomToolChatCompletionsCustomFormatGrammarGrammar

Name	Type	Description	Obbligatorio	Predefinito
Definizione	string		Sì
Sintassi	enum	Valori possibili: `lark`, `regex`	Sì

OpenAI.CustomToolChatCompletionsCustomFormatText

Name	Type	Description	Obbligatorio	Predefinito
type	enum	Valori possibili: `text`	Sì

OpenAI.FunctionObject

Name	Type	Description	Obbligatorio
descrizione	string	Una descrizione di ciò che fa la funzione, usata dal modello per scegliere quando e come chiamarla.	No
nome	string	Nome della funzione che deve essere chiamata. Devono essere dalla a-z, dalla A-Z, da 0 a 9, oppure contenere sottolineamenti e trattini, con una lunghezza massima di 64.	Sì
parameters	OpenAI.FunctionParameters	I parametri che le funzioni accettano, descritti come un oggetto JSON Schema. Consulta la guida per esempi e il riferimento allo schema JSON per la documentazione sul formato. Omettere `parameters` definisce una funzione con una lista di parametri vuota.	No
rigido	booleano o null		No

OpenAI.FunctionParameters

I parametri che le funzioni accettano, descritti come un oggetto JSON Schema. Consulta la guida per esempi e il riferimento allo schema JSON per la documentazione sul formato. Omettere parameters definisce una funzione con una lista di parametri vuota.

Tipo: oggetto

OpenAI.Metadata

Set di 16 coppie chiave-valore che possono essere collegate a un oggetto . Ciò può essere utile per archiviare informazioni aggiuntive sull'oggetto in un formato strutturato ed eseguire query sugli oggetti tramite API o il dashboard. Le chiavi sono stringhe con una lunghezza massima di 64 caratteri. I valori sono stringhe con una lunghezza massima di 512 caratteri.

Tipo: oggetto

OpenAI.ParallelToolCalls

Indica se abilitare la chiamata di funzioni parallele durante l'uso dello strumento.

Tipo: booleano

OpenAI.PredictionContent

Contenuto statico

Contenuto statico previsto in output, come il contenuto di un file di testo che viene rigenerato.

Name	Type	Description	Obbligatorio	Predefinito
contenuto	stringa o matrice di OpenAI.ChatCompletionRequestMessageContentPartText	Il contenuto che dovrebbe essere abbinato quando si genera una risposta al modello. Se i token generati corrispondono a questo contenuto, l'intera risposta del modello può essere restituito molto più rapidamente.	Sì
type	enum	Il tipo di contenuto previsto che vuoi fornire. Questo tipo è attualmente sempre `content`. Valori possibili: `content`	Sì

Sforzo di Ragionamento OpenAI

Vincola il lavoro sul ragionamento per i modelli di ragionamento. I valori attualmente supportati sono none, minimal, lowmedium, , highe xhigh. Ridurre lo sforzo di ragionamento può portare a risposte più rapide e a meno token utilizzati per ragionare in una risposta.

gpt-5.1 il valore predefinito è none, che non esegue il ragionamento. I valori di ragionamento supportati per gpt-5.1 sono none, low, mediume high. Le chiamate agli strumenti sono supportate per tutti i valori di ragionamento in gpt-5.1.
Tutti i modelli prima gpt-5.1 del medium ragionamento predefinito e non supportano none.
Il gpt-5-pro modello usa per impostazione predefinita (e supporta solo) high il ragionamento.
xhigh è supportato per tutti i modelli dopo gpt-5.1-codex-max.

Proprietà	Value
Descrizione	Vincola il lavoro sul ragionamento per i modelli di ragionamento. I valori attualmente supportati sono `none`, `minimal`, `lowmedium`, , `high`e `xhigh`. Ridurre lo sforzo di ragionamento può portare a risposte più rapide e a meno token utilizzati per ragionare in una risposta. - `gpt-5.1` il valore predefinito è `none`, che non esegue il ragionamento. I valori di ragionamento supportati per `gpt-5.1` sono `none`, `low`, `medium`e `high`. Le chiamate agli strumenti sono supportate per tutti i valori di ragionamento in gpt-5.1. - Tutti i modelli prima `gpt-5.1` di eseguire il ragionamento per impostazione predefinita `medium` e non supportano `none`. - Il `gpt-5-pro` modello usa per impostazione predefinita (e supporta solo) `high` il ragionamento. - `xhigh` è supportato per tutti i modelli dopo `gpt-5.1-codex-max`.
Type	string
Valori	`none` `minimal` `low` `medium` `high` `xhigh`

OpenAI.ResponseFormatJsonSchema

Schema JSON

Formato di risposta dello schema JSON. Usato per generare risposte JSON strutturate. Scopri di più sugli output strutturati.

Name	Type	Description	Obbligatorio
json_schema	OpenAI.ResponseFormatJsonSchemaJsonSchema		Sì
└* descrizione	string		No
└> nome	string		Sì
└─ Schema	OpenAI.ResponseFormatJsonSchemaSchema	Schema per il formato di risposta, descritto come oggetto Schema JSON. Informazioni su come creare schemi JSON qui.	No
└─ rigoroso	booleano o null		No
type	enum	Tipo di formato di risposta definito. Sempre `json_schema`. Valori possibili: `json_schema`	Sì

OpenAI.ResponseFormatJsonSchemaJsonSchema

Name	Type	Description	Obbligatorio
descrizione	string		No
nome	string		Sì
schema	OpenAI.ResponseFormatJsonSchemaSchema	Schema per il formato di risposta, descritto come oggetto Schema JSON. Informazioni su come creare schemi JSON qui.	No
rigido	booleano o null		No

OpenAI.ResponseFormatJsonSchemaSchema

Schema JSON

Schema per il formato di risposta, descritto come oggetto Schema JSON. Informazioni su come creare schemi JSON qui.

Tipo: oggetto

OpenAI.ResponseModalities

Tipi di output che si desidera generare il modello. La maggior parte dei modelli è in grado di generare testo, ovvero l'impostazione predefinita: ["text"] Il gpt-4o-audio-preview modello può essere usato anche per generare audio. Per richiedere che questo modello generi risposte sia di testo che audio, è possibile usare: ["text", "audio"]

Questo schema accetta uno dei tipi seguenti:

array
Null

OpenAI.StopConfiguration

Non supportato con i modelli o3 di ragionamento più recenti e o4-mini. Fino a 4 sequenze in cui l'API smetterà di generare altri token. Il testo restituito non conterrà la sequenza di interruzione.

Questo schema accetta uno dei tipi seguenti:

array
Null

OpenAI.Verbosity

Vincola il livello di dettaglio della risposta del modello. I valori inferiori generano risposte più concise, mentre i valori più elevati generano risposte più dettagliate. I valori attualmente supportati sono low, medium, e high.

Proprietà	Value
Descrizione	Vincola il livello di dettaglio della risposta del modello. I valori inferiori generano risposte più concise, mentre i valori più elevati generano risposte più dettagliate. I valori attualmente supportati sono `low`, `medium`, e `high`.
Type	string
Valori	`low` `medium` `high`

OpenAI.VoiceIdsShared

Proprietà	Value
Type	string
Valori	`alloy` `ash` `ballad` `coral` `echo` `sage` `shimmer` `verse` `marin` `cedar`

Last updated on 2026-06-12