Riferimento all'API REST del servizio Azure OpenAI

Articolo
11/02/2024

Questo articolo fornisce informazioni dettagliate sugli endpoint dell'API REST di inferenza per OpenAI di Azure.

Specifiche API

La gestione e l'interazione con i modelli e le risorse di Azure OpenAI sono suddivisi in tre superfici API principali:

Piano di controllo
Piano dati - Creazione
Piano dati - Inferenza

Ogni specifica/superficie dell'API incapsula un set diverso di funzionalità Azure OpenAI. Ogni API ha un proprio set univoco di versioni API di anteprima e stabili/disponibili a livello generale. Le versioni di anteprima attualmente tendono a seguire una cadenza mensile.

API	Ultima versione di anteprima	Ultima versione disponibile a livello generale	Specifiche	Descrizione
Piano di controllo	`2024-06-01-preview`	`2024-10-01`	File di specifiche	Azure OpenAI condivide un piano di controllo comune con tutti gli altri servizi di Azure AI. L'API del piano di controllo viene usata per operazioni come la creazione di risorse di Azure OpenAI, distribuzione modello e altre attività di gestione delle risorse di livello superiore. Il piano di controllo gestisce anche le operazioni possibili con funzionalità come Azure Resource Manager, Bicep, Terraform e l'interfaccia della riga di comando di Azure.
Piano dati - Creazione	`2024-10-01-preview`	`2024-10-21`	File di specifiche	L'API di creazione del piano dati controlla l'ottimizzazione, il caricamento file, i processi di inserimento, batch e determinate query a livello di modello
Piano dati - Inferenza	`2024-10-01-preview`	`2024-10-21`	File di specifiche	L'API di inferenza del piano dati fornisce le funzionalità di inferenza/endpoint per funzionalità come completamenti, completamenti chat, incorporamenti, comandi vocali/sussurro, su dati, Dall-e, assistenti e così via.

Autenticazione

OpenAI di Azure fornisce due metodi di autenticazione. È possibile usare chiavi API o Microsoft Entra ID.

Autenticazione con chiave API: per questo tipo di autenticazione, tutte le richieste API devono includere la chiave API nell'intestazione HTTP api-key. La guida di avvio rapido fornisce indicazioni su come effettuare chiamate con questo tipo di autenticazione.
Autenticazione di Microsoft Entra ID: è possibile autenticare una chiamata API usando un token Microsoft Entra. I token di autenticazione vengono inclusi in una richiesta come intestazione Authorization. Il token specificato deve essere preceduto da Bearer, ad esempio: Bearer YOUR_AUTH_TOKEN. È possibile leggere la guida pratica sull'autenticazione con Microsoft Entra ID.

Controllo delle versioni dell'API REST

Le API del servizio sono sottoposte al controllo delle versioni usando il parametro di query api-version. Tutte le versioni seguono la struttura di data AAAA-MM-GG. Ad esempio:

POST https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/chat/completions?api-version=2024-06-01

Inferenza del piano dati

Il resto dell'articolo illustra la versione disponibile a livello generale più recente della specifica di inferenza del piano dati di Azure OpenAI, 2024-10-21.

Se si sta cercando documentazione sull'ultima versione dell'API di anteprima, vedere l'API di inferenza del piano dati di anteprima più recente

Completamenti

POST https://{endpoint}/openai/deployments/{deployment-id}/completions?api-version=2024-10-21

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

Parametri dell'URI

Nome	Tra	Richiesto	Type	Descrizione
endpoint	path	Sì	string URL.	Endpoint di Azure OpenAI supportati (protocollo e nome host, ad esempio: `https://aoairesource.openai.azure.com`. Sostituire "aoairesource" con il nome della risorsa di Azure OpenAI). https://{your-resource-name}.openai.azure.com
deployment-id	path	Sì	string	ID distribuzione del modello distribuito.
api-version	query	Sì	string	Versione dell'API

Intestazione richiesta

Nome	Obbligatorio	Type	Descrizione
api-key	Vero	string	Fornire qui la chiave API di Azure OpenAI

Corpo della richiesta

Content-Type: application/json

Nome	Tipo	Descrizione	Richiesto	Valore predefinito
prompt	Stringa o matrice	Prompt per cui generare completamenti, codificati come stringhe, matrice di stringhe, matrice di token o matrice di matrici token. Si noti che <\|endoftext\|> è il separatore di documenti visualizzato dal modello durante il training, quindi se non viene specificato un prompt, il modello genererà come se fosse all'inizio di un nuovo documento.	Sì
best_of	integer	Genera completamenti `best_of` sul lato server e restituisce il valore "migliore" (quello con la probabilità di log più alta per token). I risultati non possono essere trasmessi in streaming. Se usato con `n`, `best_of` controlla il numero di completamenti candidati e `n` specifica il numero da restituire: `best_of` deve essere maggiore di `n`. Nota: poiché questo parametro genera molti completamenti, può utilizzare rapidamente la quota del token. Farne un uso accurato e assicurarsi di avere impostazioni ragionevoli per `max_tokens` e `stop`.	No	1
echo	boolean	Eco di ritorno del prompt oltre al completamento	No	Falso
frequency_penalty	number	Numero compreso tra -2.0 e 2.0. I valori positivi penalizzano i nuovi token in base alla frequenza esistente nel testo fino a quel momento, riducendo la probabilità che il modello ripeta testualmente la stessa riga.	No	0
logit_bias	oggetto	Modificare la probabilità che i token specificati vengano visualizzati nel completamento. Accetta un oggetto JSON che esegue il mapping dei token (specificato dal relativo ID token nel tokenizer GPT) con un valore di distorsione associato compreso tra -100 e 100. Matematicamente, la distorsione viene aggiunta ai logits generati dal modello prima del campionamento. L'effetto esatto varia per modello, ma i valori compresi tra -1 e 1 devono diminuire o aumentare la probabilità di selezione; i valori come -100 o 100 devono comportare un divieto o una selezione esclusiva del token pertinente. Ad esempio, è possibile passare `{"50256": -100}` per impedire la generazione del token <\|endoftext\|>.	No	None
logprobs	integer	Includere le probabilità di log nei token di output `logprobs` più probabili, nonché i token scelti. Ad esempio, se `logprobs` è 5, l'API restituirà un elenco dei cinque token più probabili. L'API restituirà sempre l'oggetto `logprob` del token campionato, quindi potrebbe essere presente fino a un massimo di `logprobs+1` elementi nella risposta. Il valore massimo per `logprobs` è 5.	No	None
max_tokens	integer	Numero massimo di token generabili nel completamento. Il numero di token della richiesta più `max_tokens` non può superare la lunghezza del contesto del modello.	No	16
n	integer	Il numero di completamenti da generare per ogni richiesta. Nota: poiché questo parametro genera molti completamenti, può utilizzare rapidamente la quota del token. Farne un uso accurato e assicurarsi di avere impostazioni ragionevoli per `max_tokens` e `stop`.	No	1
presence_penalty	number	Numero compreso tra -2.0 e 2.0. I valori positivi penalizzano i nuovi token in base al fatto che vengano visualizzati o meno nel testo fino a questo momento, aumentando la probabilità del modello di parlare di nuovi argomenti.	No	0
seed	integer	Se specificato, il sistema effettuerà tutti i tentativi possibili per eseguire il campionamento in modo deterministico, in modo che le richieste ripetute con gli stessi `seed` e parametri restituiscano lo stesso risultato. Il determinismo non è garantito ed è necessario fare riferimento al parametro di risposta `system_fingerprint` per monitorare le modifiche nel back-end.	No
stop	Stringa o matrice	Fino a quattro sequenze in cui l'API smetterà di generare altri token. Il testo restituito non conterrà la sequenza di interruzione.	No
stream	boolean	Indica se eseguire il flusso di avanzamento parziale. Se impostati, i token verranno inviati come eventi solo dati inviati dal server man mano che diventano disponibili, con il flusso terminato da un messaggio `data: [DONE]`.	No	Falso
suffix	string	Suffisso che segue un completamento del testo inserito. Questo parametro è supportato solo per `gpt-3.5-turbo-instruct`.	No	None
temperatura	number	Temperatura di campionamento da usare, compresa tra 0 e 2. Valori più elevati come 0.8 renderanno l'output più casuale, mentre valori più bassi come 0.2 lo renderanno più mirato e deterministico. In genere si consiglia di modificare questo valore o `top_p` ma non entrambi.	No	1
top_p	number	Un'alternativa al campionamento con temperatura, denominata campionamento del nucleo, in cui il modello considera i risultati dei token con massa di probabilità top_p. Quindi 0,1 significa che vengono considerati solo i token che comprendono la massa di probabilità superiore del 10%. In genere si consiglia di modificare questo valore o `temperature` ma non entrambi.	No	1
utente	string	Identificatore univoco che rappresenta l'utente finale, che consente di monitorare e rilevare gli abusi.	No

Risposte

Codice di stato: 200

Descrizione: OK

Content-Type	Type	Descrizione
application/json	createCompletionResponse	Rappresenta una risposta di completamento dall'API. Nota: sia gli oggetti risposta trasmessi che non trasmessi condividono la stessa forma (a differenza dell'endpoint della chat).

Codice di stato: predefinito

Descrizione: servizio non disponibile

Content-Type	Type	Descrizione
application/json	errorResponse

Esempi

Esempio

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

POST https://{endpoint}/openai/deployments/{deployment-id}/completions?api-version=2024-10-21

{
 "prompt": [
  "tell me a joke about mango"
 ],
 "max_tokens": 32,
 "temperature": 1.0,
 "n": 1
}

Risposte: Codice di stato: 200

{
  "body": {
    "id": "cmpl-7QmVI15qgYVllxK0FtxVGG6ywfzaq",
    "created": 1686617332,
    "choices": [
      {
        "text": "es\n\nWhat do you call a mango who's in charge?\n\nThe head mango.",
        "index": 0,
        "finish_reason": "stop",
        "logprobs": null
      }
    ],
    "usage": {
      "completion_tokens": 20,
      "prompt_tokens": 6,
      "total_tokens": 26
    }
  }
}

Incorporamenti

POST https://{endpoint}/openai/deployments/{deployment-id}/embeddings?api-version=2024-10-21

Ottenere una rappresentazione vettoriale di un determinato input che può essere facilmente utilizzato da algoritmi e modelli di apprendimento automatico.

Parametri dell'URI

Nome	Tra	Richiesto	Type	Descrizione
endpoint	path	Sì	string URL.	Endpoint di Azure OpenAI supportati (protocollo e nome host, ad esempio: `https://aoairesource.openai.azure.com`. Sostituire "aoairesource" con il nome della risorsa di Azure OpenAI). https://{your-resource-name}.openai.azure.com
deployment-id	path	Sì	string
api-version	query	Sì	string	Versione dell'API

Intestazione richiesta

Nome	Obbligatorio	Type	Descrizione
api-key	Vero	string	Fornire qui la chiave API di Azure OpenAI

Corpo della richiesta

Content-Type: application/json

Nome	Tipo	Descrizione	Richiesto
input	Stringa o matrice	Testo di input da incorporare, codificato come stringa o array di token. Per incorporare più input in una singola richiesta, passare un array di stringhe o una matrice di array di token. L'input non deve superare il numero massimo di token di input per il modello (8.192 token per `text-embedding-ada-002`), non può essere una stringa vuota e qualsiasi matrice deve avere dimensioni inferiori o inferiori a 2.048.	Sì
utente	string	Un identificatore univoco che rappresenta l'utente finale, che consente di monitorare e rilevare usi impropri.	No
input_type	string	tipo di input della ricerca di incorporamento da usare	No
encoding_format	string	Formato in cui restituire gli incorporamenti. Può essere `float` o `base64`. Il valore predefinito è `float`.	No
dimensioni	integer	Numero di dimensioni che devono essere presenti negli incorporamenti di output risultanti. Supportata solo in `text-embedding-3` e versioni successive.	No

Risposte

Nome	Tipo	Richiesto
oggetto	string	Sì
modello	string	Sì
data	array	Sì
attivamente	oggetto	Sì

Proprietà per l'utilizzo

prompt_tokens

Nome	Tipo	Descrizione	Default
prompt_tokens	integer

total_tokens

Nome	Tipo	Descrizione	Default
total_tokens	integer

Codice di stato: 200

Descrizione: OK

Content-Type	Type	Descrizione
application/json	oggetto

Esempi

Esempio

Restituisce gli incorporamenti per un prompt specificato.

POST https://{endpoint}/openai/deployments/{deployment-id}/embeddings?api-version=2024-10-21

{
 "input": [
  "this is a test"
 ]
}

Risposte: Codice di stato: 200

{
  "body": {
    "data": [
      {
        "index": 0,
        "embedding": [
          -0.012838088,
          -0.007421397,
          -0.017617522,
          -0.028278312,
          -0.018666342,
          0.01737855,
          -0.01821495,
          -0.006950092,
          -0.009937238,
          -0.038580645,
          0.010674067,
          0.02412286,
          -0.013647936,
          0.013189907,
          0.0021125758,
          0.012406612,
          0.020790534,
          0.00074595667,
          0.008397198,
          -0.00535031,
          0.008968075,
          0.014351576,
          -0.014086051,
          0.015055214,
          -0.022211088,
          -0.025198232,
          0.0065186154,
          -0.036350243,
          0.009180495,
          -0.009698266,
          0.009446018,
          -0.008463579,
          -0.0040426035,
          -0.03443847,
          -0.00091273896,
          -0.0019217303,
          0.002349888,
          -0.021560553,
          0.016515596,
          -0.015572986,
          0.0038666942,
          -8.432463e-05
        ]
      }
    ],
    "usage": {
      "prompt_tokens": 4,
      "total_tokens": 4
    }
  }
}

Completamenti della chat

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2024-10-21

Crea un completamento per il messaggio di chat

Parametri dell'URI

Nome	Tra	Richiesto	Type	Descrizione
endpoint	path	Sì	string URL.	Endpoint di Azure OpenAI supportati (protocollo e nome host, ad esempio: `https://aoairesource.openai.azure.com`. Sostituire "aoairesource" con il nome della risorsa di Azure OpenAI). https://{your-resource-name}.openai.azure.com
deployment-id	path	Sì	string	ID distribuzione del modello distribuito.
api-version	query	Sì	string	Versione dell'API

Intestazione richiesta

Nome	Obbligatorio	Type	Descrizione
api-key	Vero	string	Fornire qui la chiave API di Azure OpenAI

Corpo della richiesta

Content-Type: application/json

Nome	Tipo	Descrizione	Richiesto	Valore predefinito
temperatura	number	Temperatura di campionamento da usare, compresa tra 0 e 2. Valori più elevati come 0.8 renderanno l'output più casuale, mentre valori più bassi come 0.2 lo renderanno più mirato e deterministico. In genere si consiglia di modificare questo valore o `top_p` ma non entrambi.	No	1
top_p	number	Un'alternativa al campionamento con temperatura, denominata campionamento del nucleo, in cui il modello considera i risultati dei token con massa di probabilità top_p. Quindi 0,1 significa che vengono considerati solo i token che comprendono la massa di probabilità superiore del 10%. In genere si consiglia di modificare questo valore o `temperature` ma non entrambi.	No	1
stream	boolean	Se impostato, verranno inviati delta di messaggi parziali, come in ChatGPT. I token verranno inviati come eventi inviati dal server di soli dati man mano che diventano disponibili, con il flusso terminato da un messaggio `data: [DONE]`.	No	Falso
stop	Stringa o matrice	Fino a quattro sequenze in cui l'API smetterà di generare altri token.	No
max_tokens	integer	Numero massimo di token che possono essere generati al momento del completamento della chat. La lunghezza totale dei token di input e dei token generati è limitata dalla lunghezza del contesto del modello.	No
max_completion_tokens	integer	Limite superiore per il numero di token che possono essere generati per un completamento, inclusi i token di output visibili e i token di ragionamento.	No
presence_penalty	number	Numero compreso tra -2.0 e 2.0. I valori positivi penalizzano i nuovi token in base al fatto che vengano visualizzati o meno nel testo fino a questo momento, aumentando la probabilità del modello di parlare di nuovi argomenti.	No	0
frequency_penalty	number	Numero compreso tra -2.0 e 2.0. I valori positivi penalizzano i nuovi token in base alla frequenza esistente nel testo fino a quel momento, riducendo la probabilità che il modello ripeta testualmente la stessa riga.	No	0
logit_bias	oggetto	Modificare la probabilità che i token specificati vengano visualizzati nel completamento. Accetta un oggetto JSON che esegue il mapping dei token (specificato dal relativo ID token nel tokenizer) con un valore di distorsione associato compreso tra -100 e 100. Matematicamente, la distorsione viene aggiunta ai logits generati dal modello prima del campionamento. L'effetto esatto varia per modello, ma i valori compresi tra -1 e 1 devono diminuire o aumentare la probabilità di selezione; i valori come -100 o 100 devono comportare un divieto o una selezione esclusiva del token pertinente.	No	None
utente	string	Identificatore univoco che rappresenta l'utente finale, che consente di monitorare e rilevare gli abusi.	No
messages	array	Elenco di messaggi che comprendono la conversazione effettuata finora.	Sì
data_sources	array	Le voci di configurazione per le estensioni chat di Azure OpenAI che le usano. Questa specifica aggiuntiva è compatibile solo con Azure OpenAI.	No
logprobs	boolean	Indica se restituire o meno le probabilità di log dei token di output. Se vero, restituisce le probabilità di log di ogni token di output restituito nella `content` di `message`.	No	Falso
top_logprobs	integer	Numero intero compreso tra 0 e 20 che specifica il numero di token più probabili da restituire in ogni posizione del token, ognuno con una probabilità di log associata. `logprobs` deve essere impostato su `true` se viene usato questo parametro.	No
n	integer	Quante opzioni di completamento della chat generare per ogni messaggio di input. Tenere presente che verranno addebitati i costi in base al numero di token generati in tutte le scelte. Mantenere `n` come `1` per ridurre al minimo i costi.	No	1
parallel_tool_calls	ParallelToolCalls	Indica se abilitare la chiamata di funzioni parallele durante l'uso dello strumento.	No	Vero
response_format	ResponseFormatText o ResponseFormatJsonObject o ResponseFormatJsonSchema	Oggetto che specifica il formato che il modello deve restituire. Compatibile con GPT-4o, GPT-4o mini, GPT-4 Turbo e tutti i modelli GPT-3.5 Turbo più recenti di `gpt-3.5-turbo-1106`. L'impostazione su `{ "type": "json_schema", "json_schema": {...} }` consente gli output strutturati, che garantiscono che il modello corrisponda allo schema JSON fornito. L'impostazione su `{ "type": "json_object" }` abilita la modalità JSON, che garantisce che il messaggio generato dal modello sia JSON valido. Importante: quando si usa la modalità JSON, è necessario anche indicare al modello di produrre JSON manualmente tramite un messaggio di sistema o utente. Senza questo motivo, il modello può generare un flusso inutile di spazi vuoti fino a quando la generazione non raggiunge il limite di token, causando una richiesta a esecuzione prolungata e apparentemente "bloccata". Si noti anche che il contenuto del messaggio può essere parzialmente tagliato se `finish_reason="length"`, che indica che la generazione ha superato `max_tokens` o la conversazione ha superato la lunghezza massima del contesto.	No
seed	integer	Questa funzionalità è in versione beta. Se specificato, il sistema effettuerà tutti i tentativi possibili per eseguire il campionamento in modo deterministico, in modo che le richieste ripetute con gli stessi `seed` e parametri restituiscano lo stesso risultato. Il determinismo non è garantito ed è necessario fare riferimento al parametro di risposta `system_fingerprint` per monitorare le modifiche nel back-end.	No
tools	array	Elenco di strumenti che il modello può chiamare. Attualmente, solo le funzioni sono supportate come strumento. Usare questa opzione per fornire un elenco di funzioni per cui il modello può generare input JSON. Sono supportate al massimo 128 funzioni.	No
tool_choice	chatCompletionToolChoiceOption	Controlla quale strumento (se presente) viene chiamato dal modello. `none` indica che il modello non chiamerà nessuno strumento e genererà 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` indica che il modello deve chiamare uno o più strumenti. Se si specifica uno strumento specifico tramite `{"type": "function", "function": {"name": "my_function"}}` impone al modello di chiamare tale strumento. `none` è l'impostazione predefinita quando non sono presenti strumenti. `auto` è l'impostazione predefinita quando sono presenti strumenti.	No
function_call	string o chatCompletionFunctionCallOption	Deprecato e sostituito da `tool_choice`. Controlla quale funzione (se presente) viene chiamata dal modello. `none` indica che il modello non chiamerà una funzione e genererà invece un messaggio. `auto` indica che il modello può scegliere tra la generazione di un messaggio o la chiamata di una funzione. Se si specifica una funzione specifica tramite `{"name": "my_function"}`, impone al modello a chiamare tale funzione. `none` è l'impostazione predefinita quando non sono presenti funzioni. `auto` è l'impostazione predefinita se sono presenti funzioni.	No
functions	array	Deprecato e sostituito da `tools`. Un elenco di funzioni per cui il modello può generare input JSON.	No

Risposte

Codice di stato: 200

Descrizione: OK

Content-Type	Type	Descrizione
application/json	createChatCompletionResponse o createChatCompletionStreamResponse

Codice di stato: predefinito

Descrizione: servizio non disponibile

Content-Type	Type	Descrizione
application/json	errorResponse

Esempi

Esempio

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

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2024-10-21

{
 "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

{
  "body": {
    "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? Well, shiver me timbers, let ol' Cap'n Assistant share some wisdom with ye! Here be the steps to keepin' yer parrot happy 'n healthy:\n\n1. Secure a sturdy cage: Yer parrot be needin' a comfortable place to lay anchor! Be sure ye get a sturdy cage, at least double the size of the bird's wingspan, with enough space to spread their wings, yarrrr!\n\n2. Perches 'n toys: Aye, parrots need perches of different sizes, shapes, 'n textures to keep their feet healthy. Also, a few toys be helpin' to keep them entertained 'n their minds stimulated, arrrh!\n\n3. Proper grub: Feed yer feathered friend a balanced diet of high-quality pellets, fruits, 'n veggies to keep 'em strong 'n healthy. Give 'em fresh water every day, or ye\u00e2\u20ac\u2122ll have a scurvy bird on yer hands!\n\n4. Cleanliness: Swab their cage deck! Clean their cage on a regular basis: fresh water 'n food daily, the floor every couple of days, 'n a thorough scrubbing ev'ry few weeks, so the bird be livin' in a tidy haven, arrhh!\n\n5. Socialize 'n train: Parrots be a sociable lot, arrr! Exercise 'n interact with 'em daily to create a bond 'n maintain their mental 'n physical health. Train 'em with positive reinforcement, treat 'em kindly, yarrr!\n\n6. Proper rest: Yer parrot be needin' \u00e2\u20ac\u2122bout 10-12 hours o' sleep each night. Cover their cage 'n let them slumber in a dim, quiet quarter for a proper night's rest, ye scallywag!\n\n7. Keep a weather eye open for illness: Birds be hidin' their ailments, arrr! Be watchful for signs of sickness, such as lethargy, loss of appetite, puffin' up, or change in droppings, and make haste to a vet if need be.\n\n8. Provide fresh air 'n avoid toxins: Parrots be sensitive to draft and pollutants. Keep yer quarters well ventilated, but no drafts, arrr! Be mindful of toxins like Teflon fumes, candles, or air fresheners.\n\nSo there ye have it, me hearty! With proper care 'n commitment, yer parrot will be squawkin' \"Yo-ho-ho\" for many years to come! Good luck, sailor, and may the wind be at yer back!"
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Esempio

Crea un completamento basato sui dati di Ricerca di Azure e sull'identità gestita assegnata dal sistema.

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2024-10-21

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "azure_search",
   "parameters": {
    "endpoint": "https://your-search-endpoint.search.windows.net/",
    "index_name": "{index name}",
    "authentication": {
     "type": "system_assigned_managed_identity"
    }
   }
  }
 ]
}

Risposte: Codice di stato: 200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion [doc1].",
          "context": {
            "citations": [
              {
                "content": "Citation content.",
                "title": "Citation Title",
                "filepath": "contoso.txt",
                "url": "https://contoso.blob.windows.net/container/contoso.txt",
                "chunk_id": "0"
              }
            ],
            "intent": "dog care"
          }
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Esempio

Crea un completamento basato sui dati vettoriali di Ricerca di Azure, sul messaggio assistente precedente e sull'identità gestita assegnata dall'utente.

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2024-10-21

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a cat?"
  },
  {
   "role": "assistant",
   "content": "Content of the completion [doc1].",
   "context": {
    "intent": "cat care"
   }
  },
  {
   "role": "user",
   "content": "how about dog?"
  }
 ],
 "data_sources": [
  {
   "type": "azure_search",
   "parameters": {
    "endpoint": "https://your-search-endpoint.search.windows.net/",
    "authentication": {
     "type": "user_assigned_managed_identity",
     "managed_identity_resource_id": "/subscriptions/{subscription-id}/resourceGroups/{resource-group}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{resource-name}"
    },
    "index_name": "{index name}",
    "query_type": "vector",
    "embedding_dependency": {
     "type": "deployment_name",
     "deployment_name": "{embedding deployment name}"
    },
    "in_scope": true,
    "top_n_documents": 5,
    "strictness": 3,
    "role_information": "You are an AI assistant that helps people find information.",
    "fields_mapping": {
     "content_fields_separator": "\\n",
     "content_fields": [
      "content"
     ],
     "filepath_field": "filepath",
     "title_field": "title",
     "url_field": "url",
     "vector_fields": [
      "contentvector"
     ]
    }
   }
  }
 ]
}

Risposte: Codice di stato: 200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion [doc1].",
          "context": {
            "citations": [
              {
                "content": "Citation content 2.",
                "title": "Citation Title 2",
                "filepath": "contoso2.txt",
                "url": "https://contoso.blob.windows.net/container/contoso2.txt",
                "chunk_id": "0"
              }
            ],
            "intent": "dog care"
          }
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Esempio

Crea un completamento per l'Azure Cosmos DB fornito.

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2024-10-21

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "azure_cosmos_db",
   "parameters": {
    "authentication": {
     "type": "connection_string",
     "connection_string": "mongodb+srv://rawantest:{password}$@{cluster-name}.mongocluster.cosmos.azure.com/?tls=true&authMechanism=SCRAM-SHA-256&retrywrites=false&maxIdleTimeMS=120000"
    },
    "database_name": "vectordb",
    "container_name": "azuredocs",
    "index_name": "azuredocindex",
    "embedding_dependency": {
     "type": "deployment_name",
     "deployment_name": "{embedding deployment name}"
    },
    "fields_mapping": {
     "content_fields": [
      "content"
     ],
     "vector_fields": [
      "contentvector"
     ]
    }
   }
  }
 ]
}

Risposte: Codice di stato: 200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion [doc1].",
          "context": {
            "citations": [
              {
                "content": "Citation content.",
                "title": "Citation Title",
                "filepath": "contoso.txt",
                "url": "https://contoso.blob.windows.net/container/contoso.txt",
                "chunk_id": "0"
              }
            ],
            "intent": "dog care"
          }
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Trascrizioni - Creare

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/transcriptions?api-version=2024-10-21

Trascrive l'audio nella lingua di input.

Parametri dell'URI

Nome	Tra	Richiesto	Type	Descrizione
endpoint	path	Sì	string URL.	Endpoint di Azure OpenAI supportati (protocollo e nome host, ad esempio: `https://aoairesource.openai.azure.com`. Sostituire "aoairesource" con il nome della risorsa di Azure OpenAI). https://{your-resource-name}.openai.azure.com
deployment-id	path	Sì	string	ID distribuzione del modello sussurro.
api-version	query	Sì	string	Versione dell'API

Intestazione richiesta

Nome	Obbligatorio	Type	Descrizione
api-key	Vero	string	Fornire qui la chiave API di Azure OpenAI

Corpo della richiesta

Content-Type: multipart/form-data

Nome	Tipo	Descrizione	Richiesto	Valore predefinito
file	string	L'oggetto file audio da trascrivere.	Sì
prompt	string	Testo facoltativo per guidare lo stile del modello o continuare un segmento audio precedente. Il prompt deve corrispondere alla lingua audio.	No
response_format	audioResponseFormat	Definisce il formato dell'output.	No
temperatura	number	La temperatura di campionamento, compresa tra 0 e 1. Valori più elevati come 0.8 renderanno l'output più casuale, mentre valori più bassi come 0.2 lo renderanno più mirato e deterministico. Se impostato su 0, il modello usa la probabilità di log per aumentare automaticamente la temperatura fino a raggiungere determinate soglie.	No	0
lingua	string	La lingua dell'audio di input. Fornire la lingua di input in formato ISO-639-1 migliora l'accuratezza e la latenza.	No

Risposte

Codice di stato: 200

Descrizione: OK

Content-Type	Type	Descrizione
application/json	audioResponse o audioVerboseResponse
text/plain	string	Testo trascritto nel formato di output (quando response_format era testo, vtt o srt).

Esempi

Esempio

Ottiene il testo trascritto e i metadati associati dai dati dell'audio parlato forniti.

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/transcriptions?api-version=2024-10-21

Risposte: Codice di stato: 200

{
  "body": {
    "text": "A structured object when requesting json or verbose_json"
  }
}

Esempio

Ottiene il testo trascritto e i metadati associati dai dati dell'audio parlato forniti.

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/transcriptions?api-version=2024-10-21

"---multipart-boundary\nContent-Disposition: form-data; name=\"file\"; filename=\"file.wav\"\nContent-Type: application/octet-stream\n\nRIFF..audio.data.omitted\n---multipart-boundary--"

Risposte: Codice di stato: 200

{
  "type": "string",
  "example": "plain text when requesting text, srt, or vtt"
}

Traduzioni - Creare

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/translations?api-version=2024-10-21

Trascrive e converte l'audio di input in testo inglese.

Parametri dell'URI

Nome	Tra	Richiesto	Type	Descrizione
endpoint	path	Sì	string URL.	Endpoint di Azure OpenAI supportati (protocollo e nome host, ad esempio: `https://aoairesource.openai.azure.com`. Sostituire "aoairesource" con il nome della risorsa di Azure OpenAI). https://{your-resource-name}.openai.azure.com
deployment-id	path	Sì	string	ID distribuzione del modello sussurro distribuito.
api-version	query	Sì	string	Versione dell'API

Intestazione richiesta

Nome	Obbligatorio	Type	Descrizione
api-key	Vero	string	Fornire qui la chiave API di Azure OpenAI

Corpo della richiesta

Content-Type: multipart/form-data

Nome	Tipo	Descrizione	Richiesto	Valore predefinito
file	string	Il file audio da convertire.	Sì
prompt	string	Testo facoltativo per guidare lo stile del modello o continuare un segmento audio precedente. Il prompt deve essere in inglese.	No
response_format	audioResponseFormat	Definisce il formato dell'output.	No
temperatura	number	La temperatura di campionamento, compresa tra 0 e 1. Valori più elevati come 0.8 renderanno l'output più casuale, mentre valori più bassi come 0.2 lo renderanno più mirato e deterministico. Se impostato su 0, il modello usa la probabilità di log per aumentare automaticamente la temperatura fino a raggiungere determinate soglie.	No	0

Risposte

Codice di stato: 200

Descrizione: OK

Content-Type	Type	Descrizione
application/json	audioResponse o audioVerboseResponse
text/plain	string	Testo trascritto nel formato di output (quando response_format era testo, vtt o srt).

Esempi

Esempio

Ottiene il testo trascritto in lingua inglese e i metadati associati dai dati dell'audio parlato forniti.

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/translations?api-version=2024-10-21

"---multipart-boundary\nContent-Disposition: form-data; name=\"file\"; filename=\"file.wav\"\nContent-Type: application/octet-stream\n\nRIFF..audio.data.omitted\n---multipart-boundary--"

Risposte: Codice di stato: 200

{
  "body": {
    "text": "A structured object when requesting json or verbose_json"
  }
}

Esempio

Ottiene il testo trascritto in lingua inglese e i metadati associati dai dati dell'audio parlato forniti.

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/translations?api-version=2024-10-21

"---multipart-boundary\nContent-Disposition: form-data; name=\"file\"; filename=\"file.wav\"\nContent-Type: application/octet-stream\n\nRIFF..audio.data.omitted\n---multipart-boundary--"

Risposte: Codice di stato: 200

{
  "type": "string",
  "example": "plain text when requesting text, srt, or vtt"
}

Creazione di immagini

POST https://{endpoint}/openai/deployments/{deployment-id}/images/generations?api-version=2024-10-21

Genera un batch di immagini da una didascalia di testo in una determinata distribuzione del modello dall-e

Parametri dell'URI

Nome	Tra	Richiesto	Type	Descrizione
endpoint	path	Sì	string URL.	Endpoint di Azure OpenAI supportati (protocollo e nome host, ad esempio: `https://aoairesource.openai.azure.com`. Sostituire "aoairesource" con il nome della risorsa di Azure OpenAI). https://{your-resource-name}.openai.azure.com
deployment-id	path	Sì	string	ID distribuzione del modello dall-e distribuito.
api-version	query	Sì	string	Versione dell'API

Intestazione richiesta

Nome	Obbligatorio	Type	Descrizione
api-key	Vero	string	Fornire qui la chiave API di Azure OpenAI

Corpo della richiesta

Content-Type: application/json

Nome	Tipo	Descrizione	Richiesto	Valore predefinito
prompt	string	Descrizione testuale delle immagini desiderate. La lunghezza massima è di 4,000 caratteri.	Sì
n	integer	Numero di immagini da generare.	No	1
size	imageSize	Dimensioni delle immagini generate.	No	1024x1024
response_format	imagesResponseFormat	Formato in cui vengono restituite le immagini generate.	No	URL.
utente	string	Identificatore univoco che rappresenta l'utente finale, che consente di monitorare e rilevare gli abusi.	No
quality	imageQuality	La qualità dell'immagine che verrà generata.	No	standard
style	imageStyle	Stile delle immagini generate.	No	vivid

Risposte

Codice di stato: 200

Descrizione: Ok

Content-Type	Type	Descrizione
application/json	generateImagesResponse

Codice di stato: predefinito

Descrizione: si è verificato un errore.

Content-Type	Type	Descrizione
application/json	dalleErrorResponse

Esempi

Esempio

Crea immagini in base a un prompt.

POST https://{endpoint}/openai/deployments/{deployment-id}/images/generations?api-version=2024-10-21

{
 "prompt": "In the style of WordArt, Microsoft Clippy wearing a cowboy hat.",
 "n": 1,
 "style": "natural",
 "quality": "standard"
}

Risposte: Codice di stato: 200

{
  "body": {
    "created": 1698342300,
    "data": [
      {
        "revised_prompt": "A vivid, natural representation of Microsoft Clippy wearing a cowboy hat.",
        "prompt_filter_results": {
          "sexual": {
            "severity": "safe",
            "filtered": false
          },
          "violence": {
            "severity": "safe",
            "filtered": false
          },
          "hate": {
            "severity": "safe",
            "filtered": false
          },
          "self_harm": {
            "severity": "safe",
            "filtered": false
          },
          "profanity": {
            "detected": false,
            "filtered": false
          }
        },
        "url": "https://dalletipusw2.blob.core.windows.net/private/images/e5451cc6-b1ad-4747-bd46-b89a3a3b8bc3/generated_00.png?se=2023-10-27T17%3A45%3A09Z&...",
        "content_filter_results": {
          "sexual": {
            "severity": "safe",
            "filtered": false
          },
          "violence": {
            "severity": "safe",
            "filtered": false
          },
          "hate": {
            "severity": "safe",
            "filtered": false
          },
          "self_harm": {
            "severity": "safe",
            "filtered": false
          }
        }
      }
    ]
  }
}

Componenti

errorResponse

Nome	Tipo	Descrizione	Richiesto	Valore predefinito
Errore	error		No

errorBase

Nome	Tipo	Descrizione	Richiesto	Valore predefinito
codice	string		No
messaggio	string		No

Errore

Nome	Tipo	Descrizione	Richiesto
param	string		No
type	string		No
inner_error	innerError	Errore interno con dettagli aggiuntivi.	No

innerError

Errore interno con dettagli aggiuntivi.

Nome	Tipo	Descrizione	Richiesto	Valore predefinito
codice	innerErrorCode	Codici di errore per l'oggetto errore interno.	No
content_filter_results	contentFilterPromptResults	Informazioni sulla categoria di filtro dei contenuti (hate, sexual, violence, self_harm), se sono stati rilevati, nonché sul livello di gravità (molto basso, basso, medio, su larga scala che determina l'intensità e il livello di rischio di contenuti dannosi) e se sono stati filtrati o meno. Informazioni su contenuti jailbreak e profanity, se sono stati rilevati, e se sono stati filtrati o meno. Informazioni sull'elenco elementi bloccati dal cliente, se è stato filtrato, e il relativo ID.	No

innerErrorCode

Codici di errore per l'oggetto errore interno.

Descrizione: codici di errore per l'oggetto errore interno.

Tipo: string

Impostazione predefinita:

Nome enumerazione: innerErrorCode

Valori enumerazione:

valore	Descrizione
ResponsibleAIPolicyViolation	Il prompt ha violato una o più regole di filtro dei contenuti.

dalleErrorResponse

Nome	Tipo	Descrizione	Richiesto	Valore predefinito
Errore	dalleError		No

dalleError

Nome	Tipo	Descrizione	Richiesto
param	string		No
type	string		No
inner_error	dalleInnerError	Errore interno con dettagli aggiuntivi.	No

dalleInnerError

Errore interno con dettagli aggiuntivi.

Nome	Tipo	Descrizione	Richiesto
codice	innerErrorCode	Codici di errore per l'oggetto errore interno.	No
content_filter_results	dalleFilterResults	Informazioni sulla categoria di filtro dei contenuti (hate, sexual, violence, self_harm), se sono stati rilevati, nonché sul livello di gravità (molto basso, basso, medio, su larga scala che determina l'intensità e il livello di rischio di contenuti dannosi) e se sono stati filtrati o meno. Informazioni su contenuti jailbreak e profanity, se sono stati rilevati, e se sono stati filtrati o meno. Informazioni sull'elenco elementi bloccati dal cliente, se è stato filtrato, e il relativo ID.	No
revised_prompt	string	Il prompt che è stato usato per generare l'immagine, se era presente una revisione del prompt.	No

contentFilterResultBase

Nome	Tipo	Descrizione	Richiesto	Valore predefinito
filtered	boolean		Sì

contentFilterSeverityResult

Nome	Tipo	Descrizione	Richiesto	Valore predefinito
filtered	boolean		Sì
severity	string		No

contentFilterDetectedResult

Nome	Tipo	Descrizione	Richiesto	Valore predefinito
filtered	boolean		Sì
rilevato	boolean		No

contentFilterDetectedWithCitationResult

Nome	Tipo	Descrizione	Richiesto	Valore predefinito
citation	object		No

Proprietà per la citazione

URL

Nome	Tipo	Descrizione	Default
URL	string

Licenza

Nome	Tipo	Descrizione	Default
Licenza	string

contentFilterResultsBase

Informazioni sui risultati del filtro dei contenuti.

Nome	Tipo	Richiesto
sexual	contentFilterSeverityResult	No
violence	contentFilterSeverityResult	No
hate	contentFilterSeverityResult	No
self_harm	contentFilterSeverityResult	No
profanity	contentFilterDetectedResult	No
Errore	errorBase	No

contentFilterPromptResults

Informazioni sulla categoria di filtro dei contenuti (hate, sexual, violence, self_harm), se sono stati rilevati, nonché sul livello di gravità (molto basso, basso, medio, su larga scala che determina l'intensità e il livello di rischio di contenuti dannosi) e se sono stati filtrati o meno. Informazioni su contenuti jailbreak e profanity, se sono stati rilevati, e se sono stati filtrati o meno. Informazioni sull'elenco elementi bloccati dal cliente, se è stato filtrato, e il relativo ID.

Nome	Tipo	Richiesto
sexual	contentFilterSeverityResult	No
violence	contentFilterSeverityResult	No
hate	contentFilterSeverityResult	No
self_harm	contentFilterSeverityResult	No
profanity	contentFilterDetectedResult	No
Errore	errorBase	No
jailbreak	contentFilterDetectedResult	No

contentFilterChoiceResults

Informazioni sulla categoria di filtro dei contenuti (odio, violenza, self_harm), se è stato rilevato, nonché sul livello di gravità (very_low, basso, medio, su larga scala che determina l'intensità e il livello di rischio di contenuti dannosi) e se è stato filtrato o meno. Informazioni sul testo di terze parti e sul contenuto volgare, se è stato rilevato, e se è stato filtrato o meno. E informazioni sull'elenco di blocchi dei clienti, se è stato filtrato e il relativo ID.

Nome	Tipo	Richiesto
sexual	contentFilterSeverityResult	No
violence	contentFilterSeverityResult	No
hate	contentFilterSeverityResult	No
self_harm	contentFilterSeverityResult	No
profanity	contentFilterDetectedResult	No
Errore	errorBase	No
protected_material_text	contentFilterDetectedResult	No
protected_material_code	contentFilterDetectedWithCitationResult	No

promptFilterResult

Risultati del filtro dei contenuti per un singolo prompt nella richiesta.

Nome	Tipo	Descrizione	Richiesto	Valore predefinito
prompt_index	integer		No
content_filter_results	contentFilterPromptResults	Informazioni sulla categoria di filtro dei contenuti (hate, sexual, violence, self_harm), se sono stati rilevati, nonché sul livello di gravità (molto basso, basso, medio, su larga scala che determina l'intensità e il livello di rischio di contenuti dannosi) e se sono stati filtrati o meno. Informazioni su contenuti jailbreak e profanity, se sono stati rilevati, e se sono stati filtrati o meno. Informazioni sull'elenco elementi bloccati dal cliente, se è stato filtrato, e il relativo ID.	No

promptFilterResults

Risultati del filtro del contenuto per zero o più prompt nella richiesta. In una richiesta di streaming, i risultati per prompt diversi potrebbero arrivare in momenti diversi o in ordini diversi.

Nessuna proprietà definita per questo componente.

dalleContentFilterResults

Informazioni sui risultati del filtro dei contenuti.

Nome	Tipo	Richiesto
sexual	contentFilterSeverityResult	No
violence	contentFilterSeverityResult	No
hate	contentFilterSeverityResult	No
self_harm	contentFilterSeverityResult	No

dalleFilterResults

Nome	Tipo	Richiesto
sexual	contentFilterSeverityResult	No
violence	contentFilterSeverityResult	No
hate	contentFilterSeverityResult	No
self_harm	contentFilterSeverityResult	No
profanity	contentFilterDetectedResult	No
jailbreak	contentFilterDetectedResult	No

chatCompletionsRequestCommon

Nome	Tipo	Descrizione	Richiesto	Valore predefinito
temperatura	number	Temperatura di campionamento da usare, compresa tra 0 e 2. Valori più elevati come 0.8 renderanno l'output più casuale, mentre valori più bassi come 0.2 lo renderanno più mirato e deterministico. In genere si consiglia di modificare questo valore o `top_p` ma non entrambi.	No	1
top_p	number	Un'alternativa al campionamento con temperatura, denominata campionamento del nucleo, in cui il modello considera i risultati dei token con massa di probabilità top_p. Quindi 0,1 significa che vengono considerati solo i token che comprendono la massa di probabilità superiore del 10%. In genere si consiglia di modificare questo valore o `temperature` ma non entrambi.	No	1
stream	boolean	Se impostato, verranno inviati delta di messaggi parziali, come in ChatGPT. I token verranno inviati come eventi inviati dal server di soli dati mano a mano che diventano disponibili, con il flusso terminato da un messaggio `data: [DONE]`.	No	Falso
stop	Stringa o matrice	Fino a quattro sequenze in cui l'API smetterà di generare altri token.	No
max_tokens	integer	Numero massimo di token consentiti per la risposta generata. Per impostazione predefinita, il numero di token che il modello può restituire sarà (4096 - token di richiesta). Questo valore è ora deprecato a favore di `max_completion_tokens`e non è compatibile con i modelli di serie o1.	No	4096
max_completion_tokens	integer	Limite superiore per il numero di token che possono essere generati per un completamento, inclusi i token di output visibili e i token di ragionamento.	No
presence_penalty	number	Numero compreso tra -2.0 e 2.0. I valori positivi penalizzano i nuovi token in base al fatto che vengano visualizzati o meno nel testo fino a questo momento, aumentando la probabilità del modello di parlare di nuovi argomenti.	No	0
frequency_penalty	number	Numero compreso tra -2.0 e 2.0. I valori positivi penalizzano i nuovi token in base alla frequenza esistente nel testo fino a quel momento, riducendo la probabilità che il modello ripeta testualmente la stessa riga.	No	0
logit_bias	oggetto	Modificare la probabilità che i token specificati vengano visualizzati nel completamento. Accetta un oggetto JSON che esegue il mapping dei token (specificato dal relativo ID token nel tokenizer) con un valore di distorsione associato compreso tra -100 e 100. Matematicamente, la distorsione viene aggiunta ai logits generati dal modello prima del campionamento. L'effetto esatto varia per modello, ma i valori compresi tra -1 e 1 devono diminuire o aumentare la probabilità di selezione; i valori come -100 o 100 devono comportare un divieto o una selezione esclusiva del token pertinente.	No
utente	string	Identificatore univoco che rappresenta l'utente finale, che consente a OpenAI di Azure di monitorare e rilevare gli abusi.	No

createCompletionRequest

Nome	Tipo	Descrizione	Richiesto	Valore predefinito
prompt	Stringa o matrice	Prompt per cui generare completamenti, codificati come stringhe, matrice di stringhe, matrice di token o matrice di matrici token. Si noti che <\|endoftext\|> è il separatore di documenti visualizzato dal modello durante il training, quindi se non viene specificato un prompt, il modello genererà come se fosse all'inizio di un nuovo documento.	Sì
best_of	integer	Genera completamenti `best_of` sul lato server e restituisce il valore "migliore" (quello con la probabilità di log più alta per token). I risultati non possono essere trasmessi in streaming. Se usato con `n`, `best_of` controlla il numero di completamenti candidati e `n` specifica il numero da restituire: `best_of` deve essere maggiore di `n`. Nota: poiché questo parametro genera molti completamenti, può utilizzare rapidamente la quota del token. Farne un uso accurato e assicurarsi di avere impostazioni ragionevoli per `max_tokens` e `stop`.	No	1
echo	boolean	Eco di ritorno del prompt oltre al completamento	No	Falso
frequency_penalty	number	Numero compreso tra -2.0 e 2.0. I valori positivi penalizzano i nuovi token in base alla frequenza esistente nel testo fino a quel momento, riducendo la probabilità che il modello ripeta testualmente la stessa riga.	No	0
logit_bias	oggetto	Modificare la probabilità che i token specificati vengano visualizzati nel completamento. Accetta un oggetto JSON che esegue il mapping dei token (specificato dal relativo ID token nel tokenizer GPT) con un valore di distorsione associato compreso tra -100 e 100. Matematicamente, la distorsione viene aggiunta ai logits generati dal modello prima del campionamento. L'effetto esatto varia per modello, ma i valori compresi tra -1 e 1 devono diminuire o aumentare la probabilità di selezione; i valori come -100 o 100 devono comportare un divieto o una selezione esclusiva del token pertinente. Ad esempio, è possibile passare `{"50256": -100}` per impedire la generazione del token <\|endoftext\|>.	No	None
logprobs	integer	Includere le probabilità di log nei token di output `logprobs` più probabili, nonché i token scelti. Ad esempio, se `logprobs` è 5, l'API restituirà un elenco dei cinque token più probabili. L'API restituirà sempre l'oggetto `logprob` del token campionato, quindi potrebbe essere presente fino a un massimo di `logprobs+1` elementi nella risposta. Il valore massimo per `logprobs` è 5.	No	None
max_tokens	integer	Numero massimo di token generabili nel completamento. Il numero di token della richiesta più `max_tokens` non può superare la lunghezza del contesto del modello.	No	16
n	integer	Il numero di completamenti da generare per ogni richiesta. Nota: poiché questo parametro genera molti completamenti, può utilizzare rapidamente la quota del token. Farne un uso accurato e assicurarsi di avere impostazioni ragionevoli per `max_tokens` e `stop`.	No	1
presence_penalty	number	Numero compreso tra -2.0 e 2.0. I valori positivi penalizzano i nuovi token in base al fatto che vengano visualizzati o meno nel testo fino a questo momento, aumentando la probabilità del modello di parlare di nuovi argomenti.	No	0
seed	integer	Se specificato, il sistema effettuerà tutti i tentativi possibili per eseguire il campionamento in modo deterministico, in modo che le richieste ripetute con gli stessi `seed` e parametri restituiscano lo stesso risultato. Il determinismo non è garantito ed è necessario fare riferimento al parametro di risposta `system_fingerprint` per monitorare le modifiche nel back-end.	No
stop	Stringa o matrice	Fino a quattro sequenze in cui l'API smetterà di generare altri token. Il testo restituito non conterrà la sequenza di interruzione.	No
stream	boolean	Indica se eseguire il flusso di avanzamento parziale. Se impostati, i token verranno inviati come eventi solo dati inviati dal server man mano che diventano disponibili, con il flusso terminato da un messaggio `data: [DONE]`.	No	Falso
suffix	string	Suffisso che segue un completamento del testo inserito. Questo parametro è supportato solo per `gpt-3.5-turbo-instruct`.	No	None
temperatura	number	Temperatura di campionamento da usare, compresa tra 0 e 2. Valori più elevati come 0.8 renderanno l'output più casuale, mentre valori più bassi come 0.2 lo renderanno più mirato e deterministico. In genere si consiglia di modificare questo valore o `top_p` ma non entrambi.	No	1
top_p	number	Un'alternativa al campionamento con temperatura, denominata campionamento del nucleo, in cui il modello considera i risultati dei token con massa di probabilità top_p. Quindi 0,1 significa che vengono considerati solo i token che comprendono la massa di probabilità superiore del 10%. In genere si consiglia di modificare questo valore o `temperature` ma non entrambi.	No	1
utente	string	Identificatore univoco che rappresenta l'utente finale, che consente di monitorare e rilevare gli abusi.	No

createCompletionResponse

Rappresenta una risposta di completamento dall'API. Nota: sia gli oggetti risposta trasmessi che non trasmessi condividono la stessa forma (a differenza dell'endpoint della chat).

Nome	Tipo	Descrizione	Richiesto
id	string	Identificatore univoco per il completamento.	Sì
choices	array	L'elenco delle scelte di completamento che il modello ha generato per il prompt di input.	Sì
created	integer	Timestamp Unix (in secondi) di quando è stato creato il completamento.	Sì
modello	string	Modello usato per il completamento.	Sì
prompt_filter_results	promptFilterResults	Risultati del filtro del contenuto per zero o più prompt nella richiesta. In una richiesta di streaming, i risultati per prompt diversi potrebbero arrivare in momenti diversi o in ordini diversi.	No
system_fingerprint	string	Questa impronta digitale rappresenta la configurazione back-end con cui viene eseguito il modello. Può essere usata insieme al parametro di richiesta `seed` per comprendere quando sono state apportate modifiche back-end che potrebbero influire sul determinismo.	No
oggetto	enum	Tipo di oggetto, che è sempre "text_completion" Valori possibili: text_completion	Sì
attivamente	completionUsage	Statistiche di utilizzo per la richiesta di completamento.	No

createChatCompletionRequest

Nome	Tipo	Descrizione	Richiesto	Valore predefinito
temperatura	number	Temperatura di campionamento da usare, compresa tra 0 e 2. Valori più elevati come 0.8 renderanno l'output più casuale, mentre valori più bassi come 0.2 lo renderanno più mirato e deterministico. In genere si consiglia di modificare questo valore o `top_p` ma non entrambi.	No	1
top_p	number	Un'alternativa al campionamento con temperatura, denominata campionamento del nucleo, in cui il modello considera i risultati dei token con massa di probabilità top_p. Quindi 0,1 significa che vengono considerati solo i token che comprendono la massa di probabilità superiore del 10%. In genere si consiglia di modificare questo valore o `temperature` ma non entrambi.	No	1
stream	boolean	Se impostato, verranno inviati delta di messaggi parziali, come in ChatGPT. I token verranno inviati come eventi inviati dal server di soli dati man mano che diventano disponibili, con il flusso terminato da un messaggio `data: [DONE]`.	No	Falso
stop	Stringa o matrice	Fino a quattro sequenze in cui l'API smetterà di generare altri token.	No
max_tokens	integer	Numero massimo di token che possono essere generati al momento del completamento della chat. La lunghezza totale dei token di input e dei token generati è limitata dalla lunghezza del contesto del modello.	No
max_completion_tokens	integer	Limite superiore per il numero di token che possono essere generati per un completamento, inclusi i token di output visibili e i token di ragionamento.	No
presence_penalty	number	Numero compreso tra -2.0 e 2.0. I valori positivi penalizzano i nuovi token in base al fatto che vengano visualizzati o meno nel testo fino a questo momento, aumentando la probabilità del modello di parlare di nuovi argomenti.	No	0
frequency_penalty	number	Numero compreso tra -2.0 e 2.0. I valori positivi penalizzano i nuovi token in base alla frequenza esistente nel testo fino a quel momento, riducendo la probabilità che il modello ripeta testualmente la stessa riga.	No	0
logit_bias	oggetto	Modificare la probabilità che i token specificati vengano visualizzati nel completamento. Accetta un oggetto JSON che esegue il mapping dei token (specificato dal relativo ID token nel tokenizer) con un valore di distorsione associato compreso tra -100 e 100. Matematicamente, la distorsione viene aggiunta ai logits generati dal modello prima del campionamento. L'effetto esatto varia per modello, ma i valori compresi tra -1 e 1 devono diminuire o aumentare la probabilità di selezione; i valori come -100 o 100 devono comportare un divieto o una selezione esclusiva del token pertinente.	No	None
utente	string	Identificatore univoco che rappresenta l'utente finale, che consente di monitorare e rilevare gli abusi.	No
messages	array	Elenco di messaggi che comprendono la conversazione effettuata finora.	Sì
data_sources	array	Le voci di configurazione per le estensioni chat di Azure OpenAI che le usano. Questa specifica aggiuntiva è compatibile solo con Azure OpenAI.	No
logprobs	boolean	Indica se restituire o meno le probabilità di log dei token di output. Se vero, restituisce le probabilità di log di ogni token di output restituito nella `content` di `message`.	No	Falso
top_logprobs	integer	Numero intero compreso tra 0 e 20 che specifica il numero di token più probabili da restituire in ogni posizione del token, ognuno con una probabilità di log associata. `logprobs` deve essere impostato su `true` se viene usato questo parametro.	No
n	integer	Quante opzioni di completamento della chat generare per ogni messaggio di input. Tenere presente che verranno addebitati i costi in base al numero di token generati in tutte le scelte. Mantenere `n` come `1` per ridurre al minimo i costi.	No	1
parallel_tool_calls	ParallelToolCalls	Indica se abilitare la chiamata di funzioni parallele durante l'uso dello strumento.	No	Vero
response_format	ResponseFormatText o ResponseFormatJsonObject o ResponseFormatJsonSchema	Oggetto che specifica il formato che il modello deve restituire. Compatibile con GPT-4o, GPT-4o mini, GPT-4 Turbo e tutti i modelli GPT-3.5 Turbo più recenti di `gpt-3.5-turbo-1106`. L'impostazione su `{ "type": "json_schema", "json_schema": {...} }` consente gli output strutturati, che garantiscono che il modello corrisponda allo schema JSON fornito. L'impostazione su `{ "type": "json_object" }` abilita la modalità JSON, che garantisce che il messaggio generato dal modello sia JSON valido. Importante: quando si usa la modalità JSON, è necessario anche indicare al modello di produrre JSON manualmente tramite un messaggio di sistema o utente. Senza questo motivo, il modello può generare un flusso inutile di spazi vuoti fino a quando la generazione non raggiunge il limite di token, causando una richiesta a esecuzione prolungata e apparentemente "bloccata". Si noti anche che il contenuto del messaggio può essere parzialmente tagliato se `finish_reason="length"`, che indica che la generazione ha superato `max_tokens` o la conversazione ha superato la lunghezza massima del contesto.	No
seed	integer	Questa funzionalità è in versione beta. Se specificato, il sistema effettuerà tutti i tentativi possibili per eseguire il campionamento in modo deterministico, in modo che le richieste ripetute con gli stessi `seed` e parametri restituiscano lo stesso risultato. Il determinismo non è garantito ed è necessario fare riferimento al parametro di risposta `system_fingerprint` per monitorare le modifiche nel back-end.	No
tools	array	Elenco di strumenti che il modello può chiamare. Attualmente, solo le funzioni sono supportate come strumento. Usare questa opzione per fornire un elenco di funzioni per cui il modello può generare input JSON. Sono supportate al massimo 128 funzioni.	No
tool_choice	chatCompletionToolChoiceOption	Controlla quale strumento (se presente) viene chiamato dal modello. `none` indica che il modello non chiamerà nessuno strumento e genererà 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` indica che il modello deve chiamare uno o più strumenti. Se si specifica uno strumento specifico tramite `{"type": "function", "function": {"name": "my_function"}}` impone al modello di chiamare tale strumento. `none` è l'impostazione predefinita quando non sono presenti strumenti. `auto` è l'impostazione predefinita quando sono presenti strumenti.	No
function_call	string o chatCompletionFunctionCallOption	Deprecato e sostituito da `tool_choice`. Controlla quale funzione (se presente) viene chiamata dal modello. `none` indica che il modello non chiamerà una funzione e genererà invece un messaggio. `auto` indica che il modello può scegliere tra la generazione di un messaggio o la chiamata di una funzione. Se si specifica una funzione specifica tramite `{"name": "my_function"}`, impone al modello a chiamare tale funzione. `none` è l'impostazione predefinita quando non sono presenti funzioni. `auto` è l'impostazione predefinita se sono presenti funzioni.	No
functions	array	Deprecato e sostituito da `tools`. Un elenco di funzioni per cui il modello può generare input JSON.	No

chatCompletionFunctions

Nome	Tipo	Descrizione	Richiesto
description	stringa	Descrizione delle operazioni della funzione, usate dal modello per scegliere quando e come chiamare la funzione.	No
name	string	Nome della funzione che deve essere chiamata. Deve essere a-z, A-Z, 0-9 o contenere caratteri di sottolineatura e trattini, con una lunghezza massima di 64 caratteri.	Sì
parameters	FunctionParameters	I parametri accettati dalle funzioni, descritti come oggetto Schema JSON. Vedere la guida per esempi e le informazioni di riferimento sullo schema JSON per la documentazione sul formato. L'omissione di `parameters` definisce una funzione con un elenco di parametri vuoto.	No

chatCompletionFunctionCallOption

Se si specifica una funzione specifica tramite {"name": "my_function"}, impone al modello a chiamare tale funzione.

Nome	Tipo	Descrizione	Richiesto	Valore predefinito
name	string	Nome della funzione da chiamare.	Sì

chatCompletionRequestMessage

Questo componente può essere uno dei seguenti:

chatCompletionRequestSystemMessage

Nome	Tipo	Descrizione	Richiesto
content	Stringa o matrice	Contenuto del messaggio di sistema.	Sì
ruolo	enum	Il ruolo dell'autore dei messaggi, in questo caso `system`. Valori possibili: sistema	Sì
nome	string	Nome facoltativo per il partecipante. Fornisce le informazioni sul modello per distinguere i partecipanti con lo stesso ruolo.	No

chatCompletionRequestUserMessage

Nome	Tipo	Descrizione	Richiesto
content	Stringa o matrice	Contenuto del messaggio utente.	Sì
ruolo	enum	Il ruolo dell'autore dei messaggi, in questo caso `user`. Valori possibili: utente	Sì
nome	string	Nome facoltativo per il partecipante. Fornisce le informazioni sul modello per distinguere i partecipanti con lo stesso ruolo.	No

chatCompletionRequestAssistantMessage

Nome	Tipo	Descrizione	Richiesto
content	Stringa o matrice	Contenuto del messaggio dell'assistente. Obbligatorio, a meno che `tool_calls` o `function_call` non siano specificati.	No
rifiuto	string	Messaggio di rifiuto dell'assistente.	No
ruolo	enum	Il ruolo dell'autore dei messaggi, in questo caso `assistant`. Valori possibili: assistente	Sì
nome	string	Nome facoltativo per il partecipante. Fornisce le informazioni sul modello per distinguere i partecipanti con lo stesso ruolo.	No
tool_calls	chatCompletionMessageToolCalls	Le chiamate degli strumenti generate dal modello, ad esempio le chiamate di funzioni.	No
function_call	oggetto	Deprecato e sostituito da `tool_calls`. Nome e argomenti di una funzione che deve essere chiamata, come generato dal modello.	No

Proprietà per function_call

argomenti

Nome	Tipo	Descrizione	Default
argomenti	string	Argomenti con cui chiamare la funzione, come generato dal modello in formato JSON. Si noti che il modello non genera sempre codice JSON valido e può generare parametri non definiti dallo schema della funzione. Convalidare gli argomenti nel codice prima di chiamare la funzione.

name

Nome	Tipo	Descrizione	Default
name	string	Nome della funzione da chiamare.

chatCompletionRequestToolMessage

Nome	Tipo	Descrizione	Richiesto
ruolo	enum	Il ruolo dell'autore dei messaggi, in questo caso `tool`. Valori possibili: strumento	Sì
content	Stringa o matrice	Contenuto del messaggio dello strumento.	Sì
tool_call_id	string	Chiamata dello strumento a cui risponde questo messaggio.	Sì

chatCompletionRequestFunctionMessage

Nome	Tipo	Descrizione	Richiesto
ruolo	enum	Il ruolo dell'autore dei messaggi, in questo caso `function`. Valori possibili: funzione	Sì
content	string	Contenuto del messaggio della funzione.	Sì
nome	string	Nome della funzione da chiamare.	Sì

chatCompletionRequestSystemMessageContentPart

Questo componente può essere uno dei seguenti:

chatCompletionRequestUserMessageContentPart

Questo componente può essere uno dei seguenti:

chatCompletionRequestAssistantMessageContentPart

Questo componente può essere uno dei seguenti:

chatCompletionRequestToolMessageContentPart

Questo componente può essere uno dei seguenti:

chatCompletionRequestMessageContentPartText

Nome	Tipo	Descrizione	Richiesto	Valore predefinito
type	enum	Tipo della parte di contenuto. Valori possibili: testo	Sì
Testo	string	Contenuto di testo.	Sì

chatCompletionRequestMessageContentPartImage

Nome	Tipo	Descrizione	Richiesto	Valore predefinito
type	enum	Tipo della parte di contenuto. Valori possibili: image_url	Sì
image_url	oggetto		Sì

Proprietà per image_url

URL.

Nome	Tipo	Descrizione	Default
URL.	string	URL dell'immagine o dati dell'immagine con codifica base64.

detail

Nome	Tipo	Descrizione	Default
detail	string	Specifica il livello di dettaglio dell'immagine. Per altre informazioni, vedere la Guida alla visione.	auto

chatCompletionRequestMessageContentPartRefusal

Nome	Tipo	Descrizione	Richiesto	Valore predefinito
type	enum	Tipo della parte di contenuto. Valori possibili: rifiuto	Sì
rifiuto	string	Messaggio di rifiuto generato dal modello.	Sì

azureChatExtensionConfiguration

Una rappresentazione dei dati di configurazione per una singola estensione chat di Azure OpenAI. Verrà usata da una richiesta di completamento chat che deve usare estensioni chat di Azure OpenAI per aumentare il comportamento della risposta. L'uso di questa configurazione è compatibile solo con Azure OpenAI.

Nome	Tipo	Descrizione	Richiesto	Valore predefinito
type	azureChatExtensionType	Una rappresentazione dei dati di configurazione per una singola estensione chat di Azure OpenAI. Verrà usata da una richiesta di completamento chat che deve usare estensioni chat di Azure OpenAI per aumentare il comportamento della risposta. L'uso di questa configurazione è compatibile solo con Azure OpenAI.	Sì

azureChatExtensionType

Descrizione: una rappresentazione dei dati di configurazione per una singola estensione chat di Azure OpenAI. Verrà usata da una richiesta di completamento chat che deve usare estensioni chat di Azure OpenAI per aumentare il comportamento della risposta. L'uso di questa configurazione è compatibile solo con Azure OpenAI.

Tipo: string

Impostazione predefinita:

Nome enumerazione: azureChatExtensionType

Valori enumerazione:

valore	Descrizione
azure_search	Rappresenta l'uso di Ricerca di Azure come un'estensione chat di Azure OpenAI.
azure_cosmos_db	Rappresenta l'uso di Azure Cosmos DB come un'estensione chat di Azure OpenAI.

azureSearchChatExtensionConfiguration

Una specifica rappresentazione di opzioni configurabili per Ricerca di Azure quando viene usata come estensione chat di Azure OpenAI.

Nome	Tipo	Descrizione	Richiesto	Valore predefinito
type	azureChatExtensionType	Una rappresentazione dei dati di configurazione per una singola estensione chat di Azure OpenAI. Verrà usata da una richiesta di completamento chat che deve usare estensioni chat di Azure OpenAI per aumentare il comportamento della risposta. L'uso di questa configurazione è compatibile solo con Azure OpenAI.	Sì
parameters	azureSearchChatExtensionParameters	I parametri per Ricerca di Azure quando viene usato come estensione chat di Azure OpenAI.	No

azureSearchChatExtensionParameters

I parametri per Ricerca di Azure quando viene usato come estensione chat di Azure OpenAI.

Nome	Tipo	Descrizione	Richiesto
autenticazione	onYourDataApiKeyAuthenticationOptions o onYourDataSystemAssignedManagedIdentityAuthenticationOptions o onYourDataUserAssignedManagedIdentityAuthenticationOptions		Sì
top_n_documents	integer	Numero massimo di documenti configurato per la funzionalità per la query configurata.	No
in_scope	boolean	Indica se le query devono essere limitate all'uso di dati indicizzati.	No
strictness	integer	La rigidità configurata del filtro di pertinenza della ricerca. Maggiore è la rigidità, maggiore sarà la precisione, ma minore il richiamo della risposta.	No
role_information	string	Fornire al modello le istruzioni sul comportamento e su qualsiasi contesto a cui deve fare riferimento durante la generazione di una risposta. È possibile descrivere la personalità dell'assistente e indicargli come formattare le risposte. Esiste un limite di 100 token e viene conteggiato rispetto al limite di token complessivo.	No
endpoint	string	Percorso assoluto dell'endpoint per la risorsa di Ricerca di Azure da usare.	Sì
index_name	string	Il nome dell'indice da usare come disponibile nella risorsa di Ricerca di Azure a cui si è fatto riferimento.	Sì
fields_mapping	azureSearchIndexFieldMappingOptions	Impostazioni opzionali per controllare il modo in cui i campi vengono elaborati quando si usa una risorsa di Ricerca di Azure configurata.	No
query_type	azureSearchQueryType	Il tipo di query di recupero di Ricerca di Azure che deve essere eseguita quando viene usata come estensione chat di Azure OpenAI.	No
semantic_configuration	string	La configurazione semantica aggiuntiva per la query.	No
filter	string	Filtro di ricerca.	No
embedding_dependency	onYourDataEndpointVectorizationSource o onYourDataDeploymentNameVectorizationSource		No

azureSearchIndexFieldMappingOptions

Impostazioni opzionali per controllare il modo in cui i campi vengono elaborati quando si usa una risorsa di Ricerca di Azure configurata.

Nome	Tipo	Descrizione	Richiesto
title_field	string	Il nome del campo indice da usare come titolo.	No
url_field	string	Nome del campo di indice da usare come URL.	No
filepath_field	string	Il nome del campo di indice da usare come percorso file.	No
content_fields	array	I nomi dei campi di indice che devono essere gestiti come contenuto.	No
content_fields_separator	string	Il modello separatore che devono usare i campi di contenuto.	No
vector_fields	array	Nomi dei campi che rappresentano dati vettoriali.	No

azureSearchQueryType

Il tipo di query di recupero di Ricerca di Azure che deve essere eseguita quando viene usata come estensione chat di Azure OpenAI.

Descrizione: il tipo di richiesta di recupero di Ricerca di Azure che deve essere eseguita quando viene usata come estensione chat di Azure OpenAI.

Tipo: string

Impostazione predefinita:

Nome enumerazione: AzureSearchQueryType

Valori enumerazione:

valore	Descrizione
simple	Rappresenta il parser di query semplice predefinito.
semantico	Rappresenta il parser di query semantico per la modellazione semantica avanzata.
vector	Rappresenta la ricerca vettoriale sui dati calcolati.
vector_simple_hybrid	Rappresenta una combinazione della strategia di query semplice con dati vettoriali.
vector_semantic_hybrid	Rappresenta una combinazione di query di ricerca semantica e dati vettoriali.

azureCosmosDBChatExtensionConfiguration

Una specifica rappresentazione di opzioni configurabili per Azure Cosmos DB quando viene usato come estensione chat di Azure OpenAI.

Nome	Tipo	Descrizione	Richiesto	Valore predefinito
type	azureChatExtensionType	Una rappresentazione dei dati di configurazione per una singola estensione chat di Azure OpenAI. Verrà usata da una richiesta di completamento chat che deve usare estensioni chat di Azure OpenAI per aumentare il comportamento della risposta. L'uso di questa configurazione è compatibile solo con Azure OpenAI.	Sì
parameters	azureCosmosDBChatExtensionParameters	Parametri da usare quando vengono configurate estensioni chat di Azure OpenAI On Your Data mentre si usa Azure Cosmos DB for MongoDB vCore.	No

azureCosmosDBChatExtensionParameters

Parametri da usare quando si configurano estensioni chat di Azure OpenAI On Your Data mentre si usa Azure Cosmos DB for MongoDB vCore.

Nome	Tipo	Descrizione	Richiesto
autenticazione	onYourDataConnectionStringAuthenticationOptions	Le opzioni di autenticazione per Azure OpenAI On Your Data quando si usa una stringa di connessione.	Sì
top_n_documents	integer	Numero massimo di documenti configurato per la funzionalità per la query configurata.	No
in_scope	boolean	Indica se le query devono essere limitate all'uso di dati indicizzati.	No
strictness	integer	La rigidità configurata del filtro di pertinenza della ricerca. Maggiore è la rigidità, maggiore sarà la precisione, ma minore il richiamo della risposta.	No
role_information	string	Fornire al modello le istruzioni sul comportamento e su qualsiasi contesto a cui deve fare riferimento durante la generazione di una risposta. È possibile descrivere la personalità dell'assistente e indicargli come formattare le risposte. Esiste un limite di 100 token e viene conteggiato rispetto al limite di token complessivo.	No
database_name	string	Il nome del database MongoDB vCore da usare con Azure Cosmos DB.	Sì
container_name	string	Il nome del contenitore della risorsa di Azure Cosmos DB.	Sì
index_name	string	Nome dell'indice MongoDB vCore da usare con Azure Cosmos DB.	Sì
fields_mapping	azureCosmosDBFieldMappingOptions	Impostazioni opzionali per controllare il modo in cui i campi vengono elaborati quando si usa una risorsa di Azure Cosmos DB configurata.	Sì
embedding_dependency	onYourDataEndpointVectorizationSource o onYourDataDeploymentNameVectorizationSource		Sì

azureCosmosDBFieldMappingOptions

Impostazioni opzionali per controllare il modo in cui i campi vengono elaborati quando si usa una risorsa di Azure Cosmos DB configurata.

Nome	Tipo	Descrizione	Richiesto
title_field	string	Il nome del campo indice da usare come titolo.	No
url_field	string	Nome del campo di indice da usare come URL.	No
filepath_field	string	Il nome del campo di indice da usare come percorso file.	No
content_fields	array	I nomi dei campi di indice che devono essere gestiti come contenuto.	Sì
content_fields_separator	string	Il modello separatore che devono usare i campi di contenuto.	No
vector_fields	array	Nomi dei campi che rappresentano dati vettoriali.	Sì

onYourDataAuthenticationOptions

Le opzioni di autenticazione per Azure OpenAI On Your Data.

Nome	Tipo	Descrizione	Richiesto	Valore predefinito
type	onYourDataAuthenticationType	I tipi di autenticazione supportati con Azure OpenAI On Your Data.	Sì

onYourDataAuthenticationType

I tipi di autenticazione supportati con Azure OpenAI On Your Data.

Descrizione: i tipi di autenticazione supportati con Azure OpenAI On Your Data.

Tipo: string

Impostazione predefinita:

Nome enumerazione: onYourDataAuthenticationType

Valori enumerazione:

valore	Descrizione
api_key	Autenticazione tramite chiave API.
connection_string	Autenticazione tramite stringa di connessione.
system_assigned_managed_identity	Autenticazione tramite identità gestita assegnata dal sistema.
user_assigned_managed_identity	Autenticazione tramite identità gestita assegnata dall'utente.

onYourDataApiKeyAuthenticationOptions

Le opzioni di autenticazione per Azure OpenAI On Your Data quando si usa una chiave API.

Nome	Tipo	Descrizione	Richiesto	Valore predefinito
type	onYourDataAuthenticationType	I tipi di autenticazione supportati con Azure OpenAI On Your Data.	Sì
chiave	string	La chiave API da usare per l’autenticazione.	No

onYourDataConnectionStringAuthenticationOptions

Le opzioni di autenticazione per Azure OpenAI On Your Data quando si usa una stringa di connessione.

Nome	Tipo	Descrizione	Richiesto	Valore predefinito
type	onYourDataAuthenticationType	I tipi di autenticazione supportati con Azure OpenAI On Your Data.	Sì
connection_string	string	La stringa di connessione da usare per l'autenticazione.	No

onYourDataSystemAssignedManagedIdentityAuthenticationOptions

Le opzioni di autenticazione per Azure OpenAI On Your Data quando si usa un'identità gestita assegnata dal sistema.

Nome	Tipo	Descrizione	Richiesto	Valore predefinito
type	onYourDataAuthenticationType	I tipi di autenticazione supportati con Azure OpenAI On Your Data.	Sì

onYourDataUserAssignedManagedIdentityAuthenticationOptions

Le opzioni di autenticazione per Azure OpenAI On Your Data quando si usa un'identità gestita assegnata dall'utente.

Nome	Tipo	Descrizione	Richiesto	Valore predefinito
type	onYourDataAuthenticationType	I tipi di autenticazione supportati con Azure OpenAI On Your Data.	Sì
managed_identity_resource_id	string	L'ID risorsa dell'identità gestita assegnata dall'utente da usare per l'autenticazione.	No

onYourDataVectorizationSource

Una rappresentazione astratta di un'origine di vettorizzazione per Azure OpenAI On Your Data con ricerca vettoriale.

Nome	Tipo	Descrizione	Richiesto	Valore predefinito
type	onYourDataVectorizationSourceType	Rappresenta le origini disponibili che Azure OpenAI On Your Data può usare per configurare la vettorizzazione dei dati per l'uso con la ricerca vettoriale.	Sì

onYourDataVectorizationSourceType

Rappresenta le origini disponibili che Azure OpenAI On Your Data può usare per configurare la vettorizzazione dei dati per l'uso con la ricerca vettoriale.

Descrizione: rappresenta le origini disponibili che Azure OpenAI On Your Data può usare per configurare la vettorizzazione dei dati da usare con
la ricerca vettoriale.

Tipo: string

Impostazione predefinita:

Nome enumerazione: onYourDataVectorizationSourceType

Valori enumerazione:

valore	Descrizione
endpoint	Rappresenta la vettorizzazione eseguita dalle chiamate del servizio pubblico a un modello di incorporamento di Azure OpenAI.
deployment_name	Rappresenta un nome distribuzione del modello Ada da usare. Questa distribuzione del modello deve trovarsi nella stessa risorsa Azure OpenAI, ma On Your Data userà questa distribuzione del modello tramite una chiamata interna anziché una pubblica, che abilita la ricerca vettoriale anche nelle reti private.

onYourDataDeploymentNameVectorizationSource

I dettagli di un'origine di vettorizzazione, usati da Azure OpenAI on Your Data quando si applica la ricerca vettoriale, che si basa su un nome distribuzione del modello di incorporamento interno nella stessa risorsa di Azure OpenAI.

Nome	Tipo	Descrizione	Richiesto	Valore predefinito
type	onYourDataVectorizationSourceType	Rappresenta le origini disponibili che Azure OpenAI On Your Data può usare per configurare la vettorizzazione dei dati per l'uso con la ricerca vettoriale.	Sì
deployment_name	string	Specifica il nome della distribuzione del modello da usare per la vettorializzazione. Questa distribuzione del modello deve trovarsi nella stessa risorsa di Azure OpenAI, ma On Your Data userà questa distribuzione del modello tramite una chiamata interna anziché una chiamata pubblica, che consente la ricerca vettoriale anche in reti private.	No

onYourDataEndpointVectorizationSource

Dettagli di un'origine di vettorizzazione, usata da Azure OpenAI On Your Data quando si applica la ricerca vettoriale, basata su una chiamata a un endpoint pubblico Azure OpenAI per gli incorporamenti.

Nome	Tipo	Descrizione	Richiesto
type	onYourDataVectorizationSourceType	Rappresenta le origini disponibili che Azure OpenAI On Your Data può usare per configurare la vettorizzazione dei dati per l'uso con la ricerca vettoriale.	Sì
autenticazione	onYourDataApiKeyAuthenticationOptions	Le opzioni di autenticazione per Azure OpenAI On Your Data quando si usa una chiave API.	No
endpoint	string	Specifica l'endpoint da usare per la vettorializzazione. Questo endpoint deve trovarsi nella stessa risorsa di Azure OpenAI, ma On Your Data userà questo endpoint tramite una chiamata interna anziché una chiamata pubblica, che consente la ricerca vettoriale anche in reti private.	No

azureChatExtensionsMessageContext

Una rappresentazione delle informazioni contestuali aggiuntive disponibili quando sono coinvolte le estensioni chat di Azure OpenAI nella generazione di una risposta di completamento chat corrispondente. Queste informazioni contestuali vengono popolate solo quando si usa una richiesta di Azure OpenAI configurata per l'uso di un'estensione corrispondente.

Nome	Tipo	Descrizione	Richiesto	Valore predefinito
citations	array	Ili risultato del recupero dell'origine dati, usato per generare il messaggio dell'assistente nella risposta.	No
finalità	string	L'intento rilevato dalla cronologia della chat, usato per passare al turno successivo per trasferire il contesto.	No

citation

Informazioni sulla citazione per un messaggio di risposta di completamento chat.

Nome	Tipo	Descrizione	Richiesto
content	string	Il contenuto della citazione.	Sì
title	string	Il titolo della citazione.	No
URL.	string	L'URL della citazione.	No
filepath	string	Il percorso del file della citazione.	No
chunk_id	string	L'ID blocco della citazione.	No

chatCompletionMessageToolCall

Nome	Tipo	Descrizione	Richiesto
id	string	ID della chiamata allo strumento.	Sì
type	toolCallType	Il tipo di chiamata allo strumento, in questo caso `function`.	Sì
function	oggetto	Funzione chiamata dal modello.	Sì

Proprietà per la funzione

name

Nome	Tipo	Descrizione	Default
name	string	Nome della funzione da chiamare.

argomenti

Nome	Tipo	Descrizione	Default
argomenti	string	Argomenti con cui chiamare la funzione, come generato dal modello in formato JSON. Si noti che il modello non genera sempre codice JSON valido e può generare parametri non definiti dallo schema della funzione. Convalidare gli argomenti nel codice prima di chiamare la funzione.

toolCallType

Il tipo di chiamata allo strumento, in questo caso function.

Descrizione: il tipo di chiamata dello strumento, in questo caso function.

Tipo: string

Impostazione predefinita:

Nome enumerazione: toolCallType

Valori enumerazione:

valore	Descrizione
function	Il tipo di chiamata dello strumento è funzione.

chatCompletionRequestMessageTool

Nome	Tipo	Descrizione	Richiesto	Valore predefinito
tool_call_id	string	Chiamata dello strumento a cui risponde questo messaggio.	No
content	string	Contenuto del messaggio.	No

chatCompletionRequestMessageFunction

Nome	Tipo	Descrizione	Richiesto
ruolo	enum	Il ruolo dell'autore dei messaggi, in questo caso `function`. Valori possibili: funzione	No
name	string	Contenuto del messaggio.	No
content	string	Contenuto del messaggio.	No

createChatCompletionResponse

Rappresenta una risposta di completamento della chat restituita dal modello, in base all'input fornito.

Nome	Tipo	Descrizione	Richiesto
id	string	Identificatore univoco per il completamento della chat.	Sì
prompt_filter_results	promptFilterResults	Risultati del filtro del contenuto per zero o più prompt nella richiesta. In una richiesta di streaming, i risultati per prompt diversi potrebbero arrivare in momenti diversi o in ordini diversi.	No
choices	array	Elenco di scelte di completamento della chat. Può essere maggiore di uno se `n` è maggiore di 1.	Sì
created	integer	Timestamp Unix (in secondi) di quando è stato creato il completamento della chat.	Sì
modello	string	Modello usato per il completamento della chat.	Sì
system_fingerprint	string	Questa impronta digitale rappresenta la configurazione back-end con cui viene eseguito il modello. Può essere usata insieme al parametro di richiesta `seed` per comprendere quando sono state apportate modifiche back-end che potrebbero influire sul determinismo.	No
oggetto	enum	Il tipo di oggetto, che è sempre `chat.completion`. Valori possibili: chat.completion	Sì
attivamente	completionUsage	Statistiche di utilizzo per la richiesta di completamento.	No

createChatCompletionStreamResponse

Rappresenta un blocco trasmesso di una risposta di completamento della chat restituita dal modello, in base all'input fornito.

Nome	Tipo	Descrizione	Richiesto
id	string	Identificatore univoco per il completamento della chat. Ogni blocco ha lo stesso ID.	Sì
choices	array	Elenco di scelte di completamento della chat. Può contenere più elementi se `n` è maggiore di 1.	Sì
created	integer	Timestamp Unix (in secondi) di quando è stato creato il completamento della chat. Ogni blocco ha lo stesso timestamp.	Sì
modello	string	Modello per generare il completamento.	Sì
system_fingerprint	string	Questa impronta digitale rappresenta la configurazione back-end con cui viene eseguito il modello. Può essere usata insieme al parametro di richiesta `seed` per comprendere quando sono state apportate modifiche back-end che potrebbero influire sul determinismo.	No
oggetto	enum	Il tipo di oggetto, che è sempre `chat.completion.chunk`. Valori possibili: chat.completion.chunk	Sì

chatCompletionStreamResponseDelta

Delta di completamento della chat generato dalle risposte del modello trasmesso.

Nome	Tipo	Descrizione	Richiesto
content	string	Contenuto del messaggio del blocco.	No
function_call	oggetto	Deprecato e sostituito da `tool_calls`. Nome e argomenti di una funzione che deve essere chiamata, come generato dal modello.	No
tool_calls	matrice		No
ruolo	enum	Ruolo dell'autore del messaggio. Valori possibili: sistema, utente, assistente, strumento	No
rifiuto	string	Messaggio di rifiuto generato dal modello.	No

Proprietà per function_call

argomenti

Nome	Tipo	Descrizione	Default
argomenti	string	Argomenti con cui chiamare la funzione, come generato dal modello in formato JSON. Si noti che il modello non genera sempre codice JSON valido e può generare parametri non definiti dallo schema della funzione. Convalidare gli argomenti nel codice prima di chiamare la funzione.

name

Nome	Tipo	Descrizione	Default
name	string	Nome della funzione da chiamare.

chatCompletionMessageToolCallChunk

Nome	Tipo	Descrizione	Richiesto
index	integer		Sì
id	string	ID della chiamata allo strumento.	No
type	enum	Tipo dello strumento. Attualmente è supportato solo `function`. Valori possibili: funzione	No
function	object		No

Proprietà per la funzione

name

Nome	Tipo	Descrizione	Default
name	string	Nome della funzione da chiamare.

argomenti

Nome	Tipo	Descrizione	Default
argomenti	string	Argomenti con cui chiamare la funzione, come generato dal modello in formato JSON. Si noti che il modello non genera sempre codice JSON valido e può generare parametri non definiti dallo schema della funzione. Convalidare gli argomenti nel codice prima di chiamare la funzione.

chatCompletionStreamOptions

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

Nome	Tipo	Descrizione	Richiesto	Valore predefinito
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 una matrice vuota. Tutti gli altri blocchi includeranno anche un `usage` campo, ma con un valore Null.	No

chatCompletionChoiceLogProbs

Informazioni sulla probabilità di log per la scelta.

Nome	Tipo	Descrizione	Richiesto	Valore predefinito
content	array	Un elenco di token di contenuto del messaggio con informazioni sulla probabilità di log.	Sì
rifiuto	array	Un elenco di token di rifiuto del messaggio con informazioni sulla probabilità di log.	No

chatCompletionTokenLogprob

Nome	Tipo	Descrizione	Richiesto
token	string	Il token.	Sì
logprob	number	La probabilità di log di questo token.	Sì
bytes	array	Un elenco di numeri interi che rappresentano la rappresentazione in byte UTF-8 del token. Utile nei casi in cui i caratteri sono rappresentati da più token e le relative rappresentazioni in byte devono essere combinate per generare la rappresentazione di testo corretta. Può essere `null` se non è presente alcuna rappresentazione in byte per il token.	Sì
top_logprobs	array	Elenco dei token più probabili e della loro probabilità di log, in questa posizione del token. In rari casi, potrebbe venire restituito un numero di `top_logprobs` inferiore a quelli richiesti.	Sì

chatCompletionResponseMessage

Messaggio di completamento della chat generato dal modello.

Nome	Tipo	Descrizione	Richiesto
ruolo	chatCompletionResponseMessageRole	Il ruolo dell'autore del messaggio di risposta.	Sì
rifiuto	string	Messaggio di rifiuto generato dal modello.	Sì
content	string	Contenuto del messaggio.	Sì
tool_calls	array	Le chiamate degli strumenti generate dal modello, ad esempio le chiamate di funzioni.	No
function_call	chatCompletionFunctionCall	Deprecato e sostituito da `tool_calls`. Nome e argomenti di una funzione che deve essere chiamata, come generato dal modello.	No
context	azureChatExtensionsMessageContext	Una rappresentazione delle informazioni contestuali aggiuntive disponibili quando sono coinvolte estensioni chat di Azure OpenAI nella generazione di una risposta di completamento chat corrispondente. Queste informazioni contestuali vengono popolate solo quando si usa una richiesta di Azure OpenAI configurata per l'uso di un'estensione corrispondente.	No

chatCompletionResponseMessageRole

Il ruolo dell'autore del messaggio di risposta.

Descrizione: il ruolo dell'autore del messaggio di risposta.

Tipo: string

Impostazione predefinita:

Valori enumerazione:

assistant

chatCompletionToolChoiceOption

Controlla quale strumento (se presente) viene chiamato dal modello. none indica che il modello non chiamerà nessuno strumento e genererà 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 indica che il modello deve chiamare uno o più strumenti. Se si specifica uno strumento specifico tramite {"type": "function", "function": {"name": "my_function"}} impone al modello di chiamare tale strumento. none è l'impostazione predefinita quando non sono presenti strumenti. auto è l'impostazione predefinita quando sono presenti strumenti.

Questo componente può essere uno dei seguenti:

chatCompletionNamedToolChoice

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

Nome	Tipo	Descrizione	Richiesto	Valore predefinito
type	enum	Tipo dello strumento. Attualmente è supportato solo `function`. Valori possibili: funzione	Sì
function	oggetto		Sì

Proprietà per la funzione

name

Nome	Tipo	Descrizione	Default
name	string	Nome della funzione da chiamare.

ParallelToolCalls

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

Nessuna proprietà definita per questo componente.

chatCompletionMessageToolCalls

Le chiamate degli strumenti generate dal modello, ad esempio le chiamate di funzioni.

Nessuna proprietà definita per questo componente.

chatCompletionFunctionCall

Deprecato e sostituito da tool_calls. Nome e argomenti di una funzione che deve essere chiamata, come generato dal modello.

Nome	Tipo	Descrizione	Richiesto	Valore predefinito
name	string	Nome della funzione da chiamare.	Sì
argomenti	string	Argomenti con cui chiamare la funzione, come generato dal modello in formato JSON. Si noti che il modello non genera sempre codice JSON valido e può generare parametri non definiti dallo schema della funzione. Convalidare gli argomenti nel codice prima di chiamare la funzione.	Sì

completionUsage

Statistiche di utilizzo per la richiesta di completamento.

Nome	Tipo	Descrizione	Richiesto
prompt_tokens	integer	Numero di token nel prompt.	Sì
completion_tokens	integer	Numero di token nel completamento generato.	Sì
total_tokens	integer	Numero totale di token usati nella richiesta (prompt + completamento).	Sì
completion_tokens_details	oggetto	Suddivisione dei token usati in un completamento.	No

Proprietà per completion_tokens_details

reasoning_tokens

Nome	Tipo	Descrizione	Default
reasoning_tokens	integer	Token generati dal modello per il ragionamento.

chatCompletionTool

Nome	Tipo	Descrizione	Richiesto	Valore predefinito
type	enum	Tipo dello strumento. Attualmente è supportato solo `function`. Valori possibili: funzione	Sì
function	FunctionObject		Sì

FunctionParameters

I parametri accettati dalle funzioni, descritti come oggetto Schema JSON. Vedere la guida per esempi e le informazioni di riferimento sullo schema JSON per la documentazione sul formato.

L'omissione di parameters definisce una funzione con un elenco di parametri vuoto.

Nessuna proprietà definita per questo componente.

FunctionObject

Nome	Tipo	Descrizione	Richiesto	Default
description	stringa	Descrizione delle operazioni della funzione, usate dal modello per scegliere quando e come chiamare la funzione.	No
name	string	Nome della funzione che deve essere chiamata. Deve essere a-z, A-Z, 0-9 o contenere caratteri di sottolineatura e trattini, con una lunghezza massima di 64 caratteri.	Sì
parameters	FunctionParameters	I parametri accettati dalle funzioni, descritti come oggetto Schema JSON. Vedere la guida per esempi e le informazioni di riferimento sullo schema JSON per la documentazione sul formato. L'omissione di `parameters` definisce una funzione con un elenco di parametri vuoto.	No
strict	boolean	Indica se abilitare una rigorosa conformità allo schema durante la generazione della chiamata di funzione. Se impostato su true, il modello seguirà lo schema esatto definito nel campo `parameters`. Solo un subset di schema JSON è supportato quando `strict` è `true`.	No	Falso

ResponseFormatText

Nome	Tipo	Descrizione	Richiesto	Valore predefinito
type	enum	Tipo di formato di risposta definito: `text` Valori possibili: testo	Sì

ResponseFormatJsonObject

Nome	Tipo	Descrizione	Richiesto	Valore predefinito
type	enum	Tipo di formato di risposta definito: `json_object` Valori possibili: json_object	Sì

ResponseFormatJsonSchemaSchema

Schema per il formato di risposta, descritto come oggetto Schema JSON.

Nessuna proprietà definita per questo componente.

ResponseFormatJsonSchema

Nome	Tipo	Descrizione	Richiesto	Valore predefinito
type	enum	Tipo di formato di risposta definito: `json_schema` Valori possibili: json_schema	Sì
json_schema	oggetto		Sì

Proprietà per json_schema

description

Name	Tipo	Descrizione	Default
description	stringa	Descrizione del formato di risposta, usato dal modello per determinare come rispondere nel formato.

name

Nome	Tipo	Descrizione	Default
name	string	Nome del formato della risposta. Deve essere a-z, A-Z, 0-9 o contenere caratteri di sottolineatura e trattini, con una lunghezza massima di 64 caratteri.

schema

Nome	Tipo	Descrizione	Default
schema	ResponseFormatJsonSchemaSchema	Schema per il formato di risposta, descritto come oggetto Schema JSON.

strict

Nome	Tipo	Descrizione	Default
strict	boolean	Indica se abilitare una rigorosa conformità allo schema durante la generazione dell'output. Se impostato su true, il modello seguirà sempre lo schema esatto definito nel campo `schema`. Solo un subset di schema JSON è supportato quando `strict` è `true`.	Falso

chatCompletionChoiceCommon

Nome	Tipo	Descrizione	Richiesto	Valore predefinito
index	integer		No
finish_reason	string		No

createTranslationRequest

Richiesta di conversione.

Nome	Tipo	Descrizione	Richiesto	Valore predefinito
file	string	Il file audio da convertire.	Sì
prompt	string	Testo facoltativo per guidare lo stile del modello o continuare un segmento audio precedente. Il prompt deve essere in inglese.	No
response_format	audioResponseFormat	Definisce il formato dell'output.	No
temperatura	number	La temperatura di campionamento, compresa tra 0 e 1. Valori più elevati come 0.8 renderanno l'output più casuale, mentre valori più bassi come 0.2 lo renderanno più mirato e deterministico. Se impostato su 0, il modello usa la probabilità di log per aumentare automaticamente la temperatura fino a raggiungere determinate soglie.	No	0

audioResponse

Risposta di conversione o trascrizione quando response_format era json

Nome	Tipo	Descrizione	Richiesto	Valore predefinito
Testo	string	Testo convertito o trascritto.	Sì

audioVerboseResponse

Risposta di conversione o trascrizione quando response_format era verbose_json

Nome	Tipo	Descrizione	Richiesto
Testo	string	Testo convertito o trascritto.	Sì
attività	string	Tipo di attività audio.	No
lingua	string	Lingua.	No
duration	number	Durata.	No
segmenti	matrice		No

audioResponseFormat

Definisce il formato dell'output.

Descrizione: definisce il formato dell'output.

Tipo: string

Impostazione predefinita:

Valori enumerazione:

JSON
Testo
srt
verbose_json
vtt

createTranscriptionRequest

Richiesta di trascrizione.

Nome	Tipo	Descrizione	Richiesto	Valore predefinito
file	string	L'oggetto file audio da trascrivere.	Sì
prompt	string	Testo facoltativo per guidare lo stile del modello o continuare un segmento audio precedente. Il prompt deve corrispondere alla lingua audio.	No
response_format	audioResponseFormat	Definisce il formato dell'output.	No
temperatura	number	La temperatura di campionamento, compresa tra 0 e 1. Valori più elevati come 0.8 renderanno l'output più casuale, mentre valori più bassi come 0.2 lo renderanno più mirato e deterministico. Se impostato su 0, il modello usa la probabilità di log per aumentare automaticamente la temperatura fino a raggiungere determinate soglie.	No	0
lingua	string	La lingua dell'audio di input. Fornire la lingua di input in formato ISO-639-1 migliora l'accuratezza e la latenza.	No

audioSegment

Segmento di trascrizione o conversione.

Nome	Tipo	Descrizione	Richiesto
id	integer	Identificatore del segmento.	No
seek	number	Offset del segmento.	No
Avvio	number	Offset iniziale del segmento.	No
end	number	Offset finale del segmento.	No
Testo	string	Testo del segmento.	No
tokens	array	Token del testo.	No
temperatura	number	Temperatura.	No
avg_logprob	number	Probabilità media di log.	No
compression_ratio	number	Rapporto di compressione.	No
no_speech_prob	number	Probabilità di `no speech`.	No

imageQuality

La qualità dell'immagine che verrà generata.

Descrizione: la qualità dell'immagine che verrà generata.

Tipo: string

Impostazione predefinita: standard

Nome enumerazione: quality

Valori enumerazione:

valore	Descrizione
standard	Qualità standard crea immagini di qualità standard.
hd	Qualità HD crea immagini con dettagli più definiti e maggiore coerenza nell'immagine.

imagesResponseFormat

Formato in cui vengono restituite le immagini generate.

Descrizione: il formato in cui vengono restituite le immagini generate.

Tipo: string

Impostazione predefinita: url

Nome enumerazione: imagesResponseFormat

Valori enumerazione:

valore	Descrizione
URL.	L'URL che fornisce l'accesso temporaneo per scaricare le immagini generate.
b64_json	Le immagini generate vengono restituite come stringa con codifica Base64.

imageSize

Dimensioni delle immagini generate.

Descrizione: le dimensioni delle immagini generate.

Tipo: string

Impostazione predefinita: 1024×1024

Nome enumerazione: size

Valori enumerazione:

valore	Descrizione
1792×1024	Le dimensioni desiderate dell'immagine generata sono 1792×1024 pixel.
1024×1792	Le dimensioni desiderate dell'immagine generata sono 1024×1792 pixel.
1024x1024	Le dimensioni desiderate dell'immagine generata sono 1024×1024 pixel.

imageStyle

Stile delle immagini generate.

Descrizione: lo stile delle immagini generate.

Tipo: string

Impostazione predefinita: vivid

Nome enumerazione: style

Valori enumerazione:

valore	Descrizione
vivid	Vivid crea immagini iperrealistiche e drammatiche.
natural	Natural crea immagini più naturali e meno iperrealistiche.

imageGenerationsRequest

Nome	Tipo	Descrizione	Richiesto	Valore predefinito
prompt	string	Descrizione testuale delle immagini desiderate. La lunghezza massima è di 4,000 caratteri.	Sì
n	integer	Numero di immagini da generare.	No	1
size	imageSize	Dimensioni delle immagini generate.	No	1024x1024
response_format	imagesResponseFormat	Formato in cui vengono restituite le immagini generate.	No	URL.
utente	string	Identificatore univoco che rappresenta l'utente finale, che consente di monitorare e rilevare gli abusi.	No
quality	imageQuality	La qualità dell'immagine che verrà generata.	No	standard
style	imageStyle	Stile delle immagini generate.	No	vivid

generateImagesResponse

Nome	Tipo	Descrizione	Richiesto	Valore predefinito
created	integer	Il timestamp unix al momento della creazione dell'operazione.	Sì
data	array	I dati del risultato dell'operazione, se l'operazione riesce	Sì

imageResult

L'URL dell'immagine o l'immagine codificata in caso di esito positivo e un errore in caso contrario.

Nome	Tipo	Descrizione	Richiesto
URL.	string	L'URL dell'immagine.	No
b64_json	string	L'immagine con codifica Base64	No
content_filter_results	dalleContentFilterResults	Informazioni sui risultati del filtro dei contenuti.	No
revised_prompt	string	Il prompt che è stato usato per generare l'immagine, se era presente una revisione del prompt.	No
prompt_filter_results	dalleFilterResults	Informazioni sulla categoria di filtro dei contenuti (hate, sexual, violence, self_harm), se sono stati rilevati, nonché sul livello di gravità (molto basso, basso, medio, su larga scala che determina l'intensità e il livello di rischio di contenuti dannosi) e se sono stati filtrati o meno. Informazioni su contenuti jailbreak e profanity, se sono stati rilevati, e se sono stati filtrati o meno. Informazioni sull'elenco elementi bloccati dal cliente, se è stato filtrato, e il relativo ID.	No

Estensioni di completamento

Le estensioni di completamento non fanno parte dell'ultima versione disponibile a livello generale della specifica di inferenza del piano dati di OpenAI di Azure.

Chatmessage

L'oggetto del messaggio della chat non fa parte dell'ultima versione disponibile a livello generale della specifica di inferenza del piano dati di OpenAI di Azure.

Sintesi vocale

Non fa parte dell'ultima versione disponibile a livello generale della specifica di inferenza del piano dati di OpenAI di Azure. Per questa funzionalità, fare riferimento alla versione di anteprima più recente.

Passaggi successivi

Informazioni su Modelli e ottimizzazione con l'API REST. Altre informazioni sui modelli sottostanti che alimentano OpenAI di Azure.

Condividi tramite

Riferimento all'API REST del servizio Azure OpenAI

Specifiche API

Autenticazione

Controllo delle versioni dell'API REST

Inferenza del piano dati

Completamenti

Parametri dell'URI

Intestazione richiesta

Corpo della richiesta

Risposte

Esempi

Esempio

Incorporamenti

Parametri dell'URI

Intestazione richiesta

Corpo della richiesta

Risposte

Proprietà per l'utilizzo

prompt_tokens

total_tokens

Esempi

Esempio

Completamenti della chat

Parametri dell'URI

Intestazione richiesta

Corpo della richiesta

Risposte

Esempi

Esempio

Esempio

Esempio

Esempio

Trascrizioni - Creare

Parametri dell'URI

Intestazione richiesta

Corpo della richiesta

Risposte

Esempi

Esempio

Esempio

Traduzioni - Creare

Parametri dell'URI

Intestazione richiesta

Corpo della richiesta

Risposte

Esempi

Esempio

Esempio

Creazione di immagini

Parametri dell'URI

Intestazione richiesta

Corpo della richiesta

Risposte

Esempi

Esempio

Componenti

errorResponse

errorBase

Errore

innerError

innerErrorCode

dalleErrorResponse

dalleError

dalleInnerError

contentFilterResultBase

contentFilterSeverityResult

contentFilterDetectedResult

contentFilterDetectedWithCitationResult

Proprietà per la citazione

URL

Licenza

contentFilterResultsBase

contentFilterPromptResults

contentFilterChoiceResults

promptFilterResult

promptFilterResults

dalleContentFilterResults

dalleFilterResults

chatCompletionsRequestCommon