Azure OpenAI nell'anteprima dell'API REST Microsoft Foundry Models v1

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

Inferenza del piano dati

Il resto dell'articolo illustra la nuova versione dell'API di anteprima v1 della specifica di inferenza del piano dati OpenAI Azure. Per altre informazioni, vedere la guida al ciclo di vita dell'API.

Se si sta cercando la documentazione sulla versione più recente dell'API GA v1, vedere l'API di inferenza del piano dati ga più recente.

Creare il riconoscimento vocale

POST {endpoint}/openai/v1/audio/speech?api-version=preview

Genera l'audio sintesi vocale dal testo di input.

Parametri dell'URI

Name In Obbligatorio Tipo Description
endpoint path Sì corda
Url		 Azure endpoint OpenAI supportati (protocollo e nome host, ad esempio: https://aoairesource.openai.azure.com. Sostituire "aoairesource" con il Azure nome della risorsa OpenAI. https://{nome-risorsa}.openai.azure.com
api-version quesito No Versione esplicita dell'API foundry models Microsoft da usare per questa richiesta.
v1 se non specificato diversamente.

Intestazione della richiesta

Usare l'autenticazione basata su token o la chiave API. L'autenticazione con l'autenticazione basata su token è consigliata e più sicura.

Name Obbligatorio Tipo Description
Autorizzazione Vero corda Esempio:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Per generare un token di autenticazione usando interfaccia della riga di comando di Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Tipo: oauth2
URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Ambito: https://ai.azure.com/.default
api-key Vero corda Specificare Azure chiave API OpenAI qui

Corpo della richiesta

Tipo di contenuto: multipart/form-data

Name Tipo Description Obbligatorio Predefinito
input corda Testo per cui generare l'audio. La lunghezza massima è di 4096 caratteri. Sì
instructions corda Controllare la voce dell'audio generato con istruzioni aggiuntive. Non funziona con tts-1 o tts-1-hd. No
model corda Modello da usare per questa richiesta di sintesi vocale. Sì
formato_risposta object Formati di output audio supportati per la sintesi vocale. No
speed number Velocità del parlato per l'audio generato. I valori sono validi nell'intervallo compreso tra 0,25 e 4.0, con 1.0 i valori predefiniti e superiori corrispondenti alla voce più veloce. No 1
stream_format enum Formato in cui trasmettere l'audio. I formati supportati sono sse e audio. sse non è supportato per tts-1 o tts-1-hd.
Valori possibili: sse, audio		 No
Voce object Sì

Responses

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto Type Descrizione
application/octet-stream corda

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto Type Descrizione
application/json AzureErrorResponse

Esempi

Example

Sintetizza l'audio dal testo fornito.

POST {endpoint}/openai/v1/audio/speech?api-version=preview

{
 "input": "Hi! What are you going to make?",
 "voice": "fable",
 "response_format": "mp3",
 "model": "tts-1"
}

Risposte: Codice di stato: 200

{
  "body": "101010101"
}

Creare la trascrizione

POST {endpoint}/openai/v1/audio/transcriptions?api-version=preview

Trascrive l'audio nella lingua di input.

Parametri dell'URI

Name In Obbligatorio Tipo Description
endpoint path Sì corda
Url		 Azure endpoint OpenAI supportati (protocollo e nome host, ad esempio: https://aoairesource.openai.azure.com. Sostituire "aoairesource" con il Azure nome della risorsa OpenAI. https://{nome-risorsa}.openai.azure.com
api-version quesito No Versione esplicita dell'API Foundry Models da usare per questa richiesta.
v1 se non specificato diversamente.

Intestazione della richiesta

Usare l'autenticazione basata su token o la chiave API. L'autenticazione con l'autenticazione basata su token è consigliata e più sicura.

Name Obbligatorio Tipo Description
Autorizzazione Vero corda Esempio:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Per generare un token di autenticazione usando interfaccia della riga di comando di Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Tipo: oauth2
URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Ambito: https://ai.azure.com/.default
api-key Vero corda Specificare Azure chiave API OpenAI qui

Corpo della richiesta

Tipo di contenuto: multipart/form-data

Name Tipo Description Obbligatorio Predefinito
chunking_strategy object No
└prefix_padding_ms Intero Quantità di audio da includere prima del riconoscimento vocale rilevato da VAD (in millisecondi). No 300
└durata_silenzio_ms Intero Durata del silenzio per rilevare l'arresto vocale (in millisecondi). Con valori più brevi il modello risponderà più rapidamente, ma può passare a brevi pause dall'utente. No 200
└* soglia number Soglia di riservatezza (da 0,0 a 1,0) per il rilevamento delle attività vocali. Una soglia più elevata richiederà un audio più forte per attivare il modello e quindi potrebbe offrire prestazioni migliori in ambienti rumorosi. No 0,5
└─ Tipo enum Deve essere impostato su server_vad per abilitare la suddivisione in blocchi manuale tramite VAD sul lato server.
Valori possibili: server_vad		 No
file corda Sì
filename corda Nome file facoltativo o identificatore descrittivo da associare ai dati audio. No
include[] array Informazioni aggiuntive da includere nella risposta di trascrizione. logprobs restituirà le probabilità di log dei token nella risposta per comprendere la fiducia del modello nella trascrizione. logprobs funziona solo con response_format impostato su json e solo con i modelli gpt-4o-transcribe, gpt-4o-transcribe-diarize, gpt-4o-mini-transcribee gpt-4o-mini-transcribe-2025-12-15. No
Lingua corda Lingua dell'audio di input. Specificare il linguaggio di input nel formato ISO-639-1 (ad esempio en) migliorerà l'accuratezza e la latenza. No
model corda Modello da usare per questa richiesta di trascrizione. No
prompt corda Testo facoltativo per guidare lo stile del modello o continuare un segmento audio precedente. Il prompt deve corrispondere alla lingua audio. No
formato_risposta object No
stream Boolean Se impostato su true, i dati di risposta del modello verranno trasmessi al client durante la generazione tramite eventi inviati dal server. Nota: lo streaming non è supportato per il whisper-1 modello e verrà ignorato. No Falso
Temperatura number Temperatura di campionamento, compresa tra 0 e 1. Valori più alti come 0,8 renderanno l'output più casuale, mentre i valori inferiori come 0,2 lo renderanno più incentrato e deterministico. Se impostato su 0, il modello userà la probabilità di log per aumentare automaticamente la temperatura fino a raggiungere determinate soglie. No 0
timestamp_granularities[] array Granularità del timestamp da popolare per questa trascrizione. response_format deve essere impostato verbose_json per usare le granularità del timestamp. Sono supportate entrambe o entrambe le opzioni seguenti: wordo segment. Nota: non esiste una latenza aggiuntiva per i timestamp dei segmenti, ma la generazione di timestamp delle parole comporta una latenza aggiuntiva. No ['segment']

Responses

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto Type Descrizione
application/json AzureAudioTranscriptionResponse
testo/puro corda

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto Type Descrizione
application/json AzureErrorResponse

Esempi

Example

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

POST {endpoint}/openai/v1/audio/transcriptions?api-version=preview

{
 "file": "<binary audio data>",
 "model": "whisper-1",
 "response_format": "text"
}

Risposte: Codice di stato: 200

{
  "body": "plain text when requesting text, srt, or vtt"
}

Creare la traduzione

POST {endpoint}/openai/v1/audio/translations?api-version=preview

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

Parametri dell'URI

Name In Obbligatorio Tipo Description
endpoint path Sì corda
Url		 Azure endpoint OpenAI supportati (protocollo e nome host, ad esempio: https://aoairesource.openai.azure.com. Sostituire "aoairesource" con il Azure nome della risorsa OpenAI. https://{nome-risorsa}.openai.azure.com
api-version quesito No Versione esplicita dell'API Foundry Models da usare per questa richiesta.
v1 se non specificato diversamente.

Intestazione della richiesta

Usare l'autenticazione basata su token o la chiave API. L'autenticazione con l'autenticazione basata su token è consigliata e più sicura.

Name Obbligatorio Tipo Description
Autorizzazione Vero corda Esempio:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Per generare un token di autenticazione usando interfaccia della riga di comando di Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Tipo: oauth2
URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Ambito: https://ai.azure.com/.default
api-key Vero corda Specificare Azure chiave API OpenAI qui

Corpo della richiesta

Tipo di contenuto: multipart/form-data

Name Tipo Description Obbligatorio Predefinito
file corda Sì
filename corda Nome file facoltativo o identificatore descrittivo da associare ai dati audio No
model corda Modello da utilizzare per questa richiesta di traduzione. No
prompt corda Testo facoltativo per guidare lo stile del modello o continuare un segmento audio precedente. Il prompt deve essere in inglese. No
formato_risposta object No
Temperatura number Temperatura di campionamento, compresa tra 0 e 1. Valori più alti come 0,8 renderanno l'output più casuale, mentre i valori inferiori come 0,2 lo renderanno più incentrato e deterministico. Se impostato su 0, il modello userà la probabilità di log per aumentare automaticamente la temperatura fino a raggiungere determinate soglie. No 0

Responses

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto Type Descrizione
application/json AzureAudioTranslationResponse
testo/puro corda

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto Type Descrizione
application/json AzureErrorResponse

Esempi

Example

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

POST {endpoint}/openai/v1/audio/translations?api-version=preview

{
 "file": "<binary audio data>",
 "model": "whisper-1",
 "response_format": "text"
}

Risposte: Codice di stato: 200

{
  "body": "plain text when requesting text, srt, or vtt"
}

Creare il completamento della chat

POST {endpoint}/openai/v1/chat/completions?api-version=preview

Crea un completamento della chat.

Parametri dell'URI

Name In Obbligatorio Tipo Description
endpoint path Sì corda
Url		 Azure endpoint OpenAI supportati (protocollo e nome host, ad esempio: https://aoairesource.openai.azure.com. Sostituire "aoairesource" con il Azure nome della risorsa OpenAI. https://{nome-risorsa}.openai.azure.com
api-version quesito No Versione esplicita dell'API Foundry Models da usare per questa richiesta.
v1 se non specificato diversamente.

Intestazione della richiesta

Usare l'autenticazione basata su token o la chiave API. L'autenticazione con l'autenticazione basata su token è consigliata e più sicura.

Name Obbligatorio Tipo Description
Autorizzazione Vero corda Esempio:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Per generare un token di autenticazione usando interfaccia della riga di comando di Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Tipo: oauth2
URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Ambito: https://ai.azure.com/.default
api-key Vero corda Specificare Azure chiave API OpenAI qui

Corpo della richiesta

Content-Type: application/json

Name Tipo Description Obbligatorio Predefinito
Audio object Parametri per l'output audio. Obbligatorio quando viene richiesto l'output audio con modalities: ["audio"]. No
└* formato enum Specifica il formato audio di output. Deve essere uno di wav, mp3flac, ,opus o pcm16.
Valori possibili: wav, aacmp3, flac, , opuspcm16		 No
└─ voce object No
data_sources array Origini dati da usare per la funzionalità On Your Data, esclusiva per Azure OpenAI. No
penalità_di_frequenza 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 questo momento, riducendo la probabilità che il modello ripeta la stessa riga verbatim. No 0
function_call enum Specificando una funzione specifica tramite {"name": "my_function"} forza il modello a chiamare tale funzione.
Valori possibili: none, auto		 No
functions array Deprecato a favore di tools.
Un elenco di funzioni per cui il modello può generare input JSON.		 No
logit_bias object Modificare la probabilità che i token specificati vengano visualizzati nel completamento. Accetta un oggetto JSON che esegue il mapping dei token (specificati dal relativo ID token nel tokenizer) a un valore di distorsione associato da -100 a 100. Matematicamente, la distorsione viene aggiunta ai logits generati dal modello prima del campionamento. L'effetto esatto varia per modello, ma i valori tra -1 e 1 devono diminuire o aumentare la probabilità di selezione; valori come -100 o 100 devono comportare un divieto o una selezione esclusiva del token pertinente. No Nessuno
logprobs Boolean Indica se restituire o meno le probabilità di log dei token di output. Se true, restituisce le probabilità di log di ogni token di output restituito in content di message. No Falso
max_completion_tokens Intero 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
numero massimo di token Intero Numero massimo di token che possono essere generati nel completamento della chat.
Questo valore può essere usato per controllare i costi per il testo generato tramite API.
Questo valore è ora deprecato a favore di max_completion_tokense non è compatibile con i modelli di serie o1.		 No
messages array Elenco di messaggi che comprendono la conversazione finora. A seconda del modello usato, sono supportati diversi tipi di messaggio (modalità), ad esempio testo, immagini e audio. Sì
metadata object Set di 16 coppie chiave-valore che possono essere collegate a un oggetto . Ciò può essere utile per archiviare informazioni aggiuntive sull'oggetto in un formato strutturato ed eseguire query sugli oggetti tramite API o il dashboard.
Le chiavi sono stringhe con una lunghezza massima di 64 caratteri. I valori sono stringhe con una lunghezza massima di 512 caratteri.		 No
modalities object Tipi di output che si desidera generare il modello.
La maggior parte dei modelli è in grado di generare testo, ovvero l'impostazione predefinita:

["text"]

Il gpt-4o-audio-preview modello può essere usato anche per generare audio. Per richiedere che questo modello generi risposte sia di testo che audio, è possibile usare:

["text", "audio"]		 No
model corda Identificatore di distribuzione del modello da usare per la richiesta di completamento della chat. Sì
n Intero Quante opzioni di completamento della chat generare per ogni messaggio di input. Si noti 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
chiamate_parallele_agli_strumenti object Indica se abilitare la chiamata di funzioni parallele durante l'uso dello strumento. No
Previsione object Rappresentazione di base dell'output stimato da un modello. No
└─ Tipo OpenAI.ChatOutputPredictionType No
penalità_di_presenza number Numero compreso tra -2,0 e 2,0. I valori positivi penalizzano i nuovi token in base al fatto che vengano visualizzati nel testo fino a questo momento, aumentando la probabilità del modello di parlare di nuovi argomenti. No 0
sforzo di ragionamento object Solo modelli di serie o

Vincola lo sforzo sul ragionamento per i modelli di ragionamento.
I valori attualmente supportati sono low, mediume high. La riduzione del lavoro di ragionamento può comportare risposte più veloci e un minor numero di token usati per il ragionamento in una risposta.		 No
formato_risposta object No
└─ Tipo enum
Valori possibili: text, json_object, json_schema		 No
seed Intero Questa funzionalità è in versione beta.
Se specificato, il sistema eseguirà un'operazione ottimale per campionare in modo deterministico, in modo che le richieste ripetute con gli stessi seed parametri e restituisca lo stesso risultato.
Il determinismo non è garantito ed è necessario fare riferimento al system_fingerprint parametro di risposta per monitorare le modifiche nel back-end.		 No
stop object Non supportato con i modelli o3 di ragionamento più recenti e o4-mini.

Fino a 4 sequenze in cui l'API smetterà di generare altri token. Il testo restituito non conterrà la sequenza di interruzione.		 No
store Boolean Indica se archiviare o meno l'output di questa richiesta di completamento della chat per l'uso nei prodotti di valutazione o di modellazione del modello. No Falso
stream Boolean Se impostato su true, i dati di risposta del modello verranno trasmessi al client durante la generazione tramite eventi inviati dal server. No Falso
stream_options object Opzioni per la risposta in streaming. Impostare questa impostazione solo quando si imposta stream: true. No
└─ uso_includi 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. NOTA: Se il flusso viene interrotto, è possibile che non si riceva il blocco di utilizzo finale che contiene l'utilizzo totale del token per la richiesta.		 No
Temperatura number Temperatura di campionamento da usare, compresa tra 0 e 2. Valori più alti come 0,8 renderanno l'output più casuale, mentre i valori inferiori come 0,2 lo renderanno più incentrato e deterministico.
In genere è consigliabile modificare questa impostazione o top_p non entrambe.		 No 1
tool_choice OpenAI.ChatCompletionToolChoiceOption Controlla quale strumento (se presente) viene chiamato dal modello.
none indica che il modello non chiamerà alcuno strumento e genera invece un messaggio.
auto indica che il modello può scegliere tra la generazione di un messaggio o la chiamata di uno o più strumenti.
required significa che il modello deve chiamare uno o più strumenti.
Specificare uno strumento specifico tramite {"type": "function", "function": {"name": "my_function"}} forza il modello a chiamare tale strumento.

none è l'impostazione predefinita quando non sono presenti strumenti. auto è l'impostazione predefinita se sono presenti strumenti.		 No
Strumenti array Un 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
top_logprobs Intero 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. No
top_p number Un'alternativa al campionamento con temperatura, denominata campionamento del nucleo, in cui il modello considera i risultati dei token con top_p massa di probabilità. Quindi 0,1 significa che vengono considerati solo i token che comprendono i primi 10% massa di probabilità.

In genere è consigliabile modificare questa impostazione o temperature non entrambe.		 No 1
user corda Identificatore univoco che rappresenta l'utente finale, che consente di monitorare e rilevare l'abuso. No
user_security_context AzureUserSecurityContext Il contesto di sicurezza utente contiene diversi parametri che descrivono l'applicazione stessa e l'utente finale che interagisce con l'applicazione. Questi campi aiutano i team delle operazioni di sicurezza a analizzare e mitigare gli eventi imprevisti di sicurezza fornendo un approccio completo alla protezione delle applicazioni di intelligenza artificiale. Altre informazioni sulla protezione delle applicazioni di intelligenza artificiale tramite Microsoft Defender per il cloud. No

Responses

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto Type Descrizione
application/json AzureCreateChatCompletionResponse
text/event-stream AzureCreateChatCompletionStreamResponse

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto Type Descrizione
application/json AzureErrorResponse

Esempi

Example

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

POST {endpoint}/openai/v1/chat/completions?api-version=preview

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

Risposte: Codice di stato: 200

{
  "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?..."
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Creare incorporazione

POST {endpoint}/openai/v1/embeddings?api-version=preview

Crea un vettore di incorporamento che rappresenta il testo di input.

Parametri dell'URI

Name In Obbligatorio Tipo Description
endpoint path Sì corda
Url		 Azure endpoint OpenAI supportati (protocollo e nome host, ad esempio: https://aoairesource.openai.azure.com. Sostituire "aoairesource" con il Azure nome della risorsa OpenAI. https://{nome-risorsa}.openai.azure.com
api-version quesito No Versione esplicita dell'API Foundry Models da usare per questa richiesta.
v1 se non specificato diversamente.

Intestazione della richiesta

Usare l'autenticazione basata su token o la chiave API. L'autenticazione con l'autenticazione basata su token è consigliata e più sicura.

Name Obbligatorio Tipo Description
Autorizzazione Vero corda Esempio:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Per generare un token di autenticazione usando interfaccia della riga di comando di Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Tipo: oauth2
URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Ambito: https://ai.azure.com/.default
api-key Vero corda Specificare Azure chiave API OpenAI qui

Corpo della richiesta

Content-Type: application/json

Name Tipo Description Obbligatorio Predefinito
dimensions Intero Numero di dimensioni che devono essere presenti gli incorporamenti di output risultanti. Supportato solo nei text-embedding-3 modelli e versioni successive. No
encoding_format enum Formato in cui restituire gli incorporamenti. Può essere float o base64.
Valori possibili: float, base64		 No
input stringa o matrice Sì
model corda Modello da usare per la richiesta di incorporamento. Sì
user corda Identificatore univoco che rappresenta l'utente finale, che consente a OpenAI di monitorare e rilevare gli abusi. No

Responses

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto Type Descrizione
application/json OpenAI.CreateEmbeddingResponse

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto Type Descrizione
application/json AzureErrorResponse

Esempi

Example

Restituisce gli incorporamenti per un determinato prompt.

POST {endpoint}/openai/v1/embeddings?api-version=preview

{
 "model": "text-embedding-ada-002",
 "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,
          0.0032178196,
          -0.020365695,
          -0.009631885,
          -0.007647093,
          0.0033837722,
          -0.026764825,
          -0.010501476,
          0.020219658,
          0.024640633,
          -0.0066912062,
          -0.036456455,
          -0.0040923897,
          -0.013966565,
          0.017816665,
          0.005366905,
          0.022835068,
          0.0103488,
          -0.0010811808,
          -0.028942121,
          0.0074280356,
          -0.017033368,
          0.0074877786,
          0.021640211,
          0.002499245,
          0.013316032,
          0.0021524043,
          0.010129742,
          0.0054731146,
          0.03143805,
          0.014856071,
          0.0023366117,
          -0.0008243692,
          0.022781964,
          0.003038591,
          -0.017617522,
          0.0013309394,
          0.0022154662,
          0.00097414135,
          0.012041516,
          -0.027906578,
          -0.023817508,
          0.013302756,
          -0.003003741,
          -0.006890349,
          0.0016744611
        ]
      }
    ],
    "usage": {
      "prompt_tokens": 4,
      "total_tokens": 4
    }
  }
}

Elenco valutazioni

GET {endpoint}/openai/v1/evals?api-version=preview

Elencare le valutazioni per un progetto.

Parametri dell'URI

Name In Obbligatorio Tipo Description
endpoint path Sì corda
Url		 Azure endpoint OpenAI supportati (protocollo e nome host, ad esempio: https://aoairesource.openai.azure.com. Sostituire "aoairesource" con il Azure nome della risorsa OpenAI. https://{nome-risorsa}.openai.azure.com
api-version quesito No Versione esplicita dell'API Foundry Models da usare per questa richiesta.
v1 se non specificato diversamente.
aoai-evals intestazione Sì corda
Valori possibili: preview		 Consente l'accesso a AOAI Evals, una funzionalità di anteprima.
Questa funzionalità richiede che l'intestazione 'aoai-evals' sia impostata su 'preview'.
dopo quesito No corda Identificatore per l'ultima valutazione della richiesta di paginazione precedente.
limit quesito No Intero Limite al numero di valori da restituire in una singola risposta impaginazione.
order quesito No corda
Valori possibili: asc, desc		 Ordinare l'ordine per le evals in base al timestamp. Usare asc per l'ordine crescente o desc per l'ordine decrescente.
ordina per quesito No corda
Valori possibili: created_at, updated_at		 Le eval possono essere ordinate in base all'ora di creazione o all'ora dell'ultimo aggiornamento. Usare created_at per l'ora di creazione o updated_at per l'ora dell'ultimo aggiornamento.

Intestazione della richiesta

Usare l'autenticazione basata su token o la chiave API. L'autenticazione con l'autenticazione basata su token è consigliata e più sicura.

Name Obbligatorio Tipo Description
Autorizzazione Vero corda Esempio:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Per generare un token di autenticazione usando interfaccia della riga di comando di Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Tipo: oauth2
URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Ambito: https://ai.azure.com/.default
api-key Vero corda Specificare Azure chiave API OpenAI qui

Responses

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto Type Descrizione
application/json OpenAI.EvalList

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto Type Descrizione
application/json AzureErrorResponse

Creaval

POST {endpoint}/openai/v1/evals?api-version=preview

Creare la struttura di una valutazione che può essere usata per testare le prestazioni di un modello.

Una valutazione è un set di criteri di test e un'origine dati. Dopo aver creato una valutazione, è possibile eseguirla in modelli e parametri del modello diversi. Sono supportati diversi tipi di classificatori e origini dati.

NOTA: questa Azure'API OpenAI è in anteprima e soggetta a modifiche.

Parametri dell'URI

Name In Obbligatorio Tipo Description
endpoint path Sì corda
Url		 Azure endpoint OpenAI supportati (protocollo e nome host, ad esempio: https://aoairesource.openai.azure.com. Sostituire "aoairesource" con il Azure nome della risorsa OpenAI. https://{nome-risorsa}.openai.azure.com
api-version quesito No Versione esplicita dell'API Foundry Models da usare per questa richiesta.
v1 se non specificato diversamente.
aoai-evals intestazione Sì corda
Valori possibili: preview		 Consente l'accesso a AOAI Evals, una funzionalità di anteprima.
Questa funzionalità richiede che l'intestazione 'aoai-evals' sia impostata su 'preview'.

Intestazione della richiesta

Usare l'autenticazione basata su token o la chiave API. L'autenticazione con l'autenticazione basata su token è consigliata e più sicura.

Name Obbligatorio Tipo Description
Autorizzazione Vero corda Esempio:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Per generare un token di autenticazione usando interfaccia della riga di comando di Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Tipo: oauth2
URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Ambito: https://ai.azure.com/.default
api-key Vero corda Specificare Azure chiave API OpenAI qui

Corpo della richiesta

Content-Type: application/json

Name Tipo Description Obbligatorio Predefinito
configurazione_sorgente_dati object Sì
└─ Tipo OpenAI.EvalDataSourceConfigType No
metadata object Set di 16 coppie chiave-valore che possono essere collegate a un oggetto . Ciò può essere utile per archiviare informazioni aggiuntive sull'oggetto in un formato strutturato ed eseguire query sugli oggetti tramite API o il dashboard.

Le chiavi sono stringhe con una lunghezza massima di 64 caratteri. I valori sono stringhe con una lunghezza massima di 512 caratteri.		 No
name corda Nome della valutazione. No
Statuscode enum
Valori possibili: 201		 Sì
criteri_di_test array Elenco di classificatori per tutte le esecuzioni di eval in questo gruppo. I classificatori possono fare riferimento a variabili nell'origine dati usando la notazione con parentesi graffe doppie, ad esempio {{item.variable_name}}. Per fare riferimento all'output del modello, usare lo sample spazio dei nomi (ad esempio, {{sample.output_text}}). Sì

Responses

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto Type Descrizione
application/json OpenAI.Eval

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto Type Descrizione
application/json AzureErrorResponse

Ottenere l'eval

GET {endpoint}/openai/v1/evals/{eval_id}?api-version=preview

Recuperare una valutazione in base al relativo ID. Recupera una valutazione in base al relativo ID.

NOTA: questa Azure'API OpenAI è in anteprima e soggetta a modifiche.

Parametri dell'URI

Name In Obbligatorio Tipo Description
endpoint path Sì corda
Url		 Azure endpoint OpenAI supportati (protocollo e nome host, ad esempio: https://aoairesource.openai.azure.com. Sostituire "aoairesource" con il Azure nome della risorsa OpenAI. https://{nome-risorsa}.openai.azure.com
api-version quesito No Versione esplicita dell'API Foundry Models da usare per questa richiesta.
v1 se non specificato diversamente.
aoai-evals intestazione Sì corda
Valori possibili: preview		 Consente l'accesso a AOAI Evals, una funzionalità di anteprima.
Questa funzionalità richiede che l'intestazione 'aoai-evals' sia impostata su 'preview'.
eval_id path Sì corda

Intestazione della richiesta

Usare l'autenticazione basata su token o la chiave API. L'autenticazione con l'autenticazione basata su token è consigliata e più sicura.

Name Obbligatorio Tipo Description
Autorizzazione Vero corda Esempio:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Per generare un token di autenticazione usando interfaccia della riga di comando di Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Tipo: oauth2
URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Ambito: https://ai.azure.com/.default
api-key Vero corda Specificare Azure chiave API OpenAI qui

Responses

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto Type Descrizione
application/json OpenAI.Eval

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto Type Descrizione
application/json AzureErrorResponse

Aggiornare eval

POST {endpoint}/openai/v1/evals/{eval_id}?api-version=preview

Aggiornare le proprietà select, modificabili di una valutazione specificata.

NOTA: questa Azure'API OpenAI è in anteprima e soggetta a modifiche.

Parametri dell'URI

Name In Obbligatorio Tipo Description
endpoint path Sì corda
Url		 Azure endpoint OpenAI supportati (protocollo e nome host, ad esempio: https://aoairesource.openai.azure.com. Sostituire "aoairesource" con il Azure nome della risorsa OpenAI. https://{nome-risorsa}.openai.azure.com
api-version quesito No Versione esplicita dell'API Foundry Models da usare per questa richiesta.
v1 se non specificato diversamente.
aoai-evals intestazione Sì corda
Valori possibili: preview		 Consente l'accesso a AOAI Evals, una funzionalità di anteprima.
Questa funzionalità richiede che l'intestazione 'aoai-evals' sia impostata su 'preview'.
eval_id path Sì corda

Intestazione della richiesta

Usare l'autenticazione basata su token o la chiave API. L'autenticazione con l'autenticazione basata su token è consigliata e più sicura.

Name Obbligatorio Tipo Description
Autorizzazione Vero corda Esempio:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Per generare un token di autenticazione usando interfaccia della riga di comando di Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Tipo: oauth2
URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Ambito: https://ai.azure.com/.default
api-key Vero corda Specificare Azure chiave API OpenAI qui

Corpo della richiesta

Content-Type: application/json

Name Tipo Description Obbligatorio Predefinito
metadata OpenAI.MetadataPropertyForRequest Set di 16 coppie chiave-valore che possono essere collegate a un oggetto . Ciò può essere utile per archiviare informazioni aggiuntive sull'oggetto in un formato strutturato ed eseguire query sugli oggetti tramite API o il dashboard.

Le chiavi sono stringhe con una lunghezza massima di 64 caratteri. I valori sono stringhe con una lunghezza massima di 512 caratteri.		 No
name corda No

Responses

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto Type Descrizione
application/json OpenAI.Eval

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto Type Descrizione
application/json AzureErrorResponse

Elimina eval

DELETE {endpoint}/openai/v1/evals/{eval_id}?api-version=preview

Eliminare una valutazione specificata.

NOTA: questa Azure'API OpenAI è in anteprima e soggetta a modifiche.

Parametri dell'URI

Name In Obbligatorio Tipo Description
endpoint path Sì corda
Url		 Azure endpoint OpenAI supportati (protocollo e nome host, ad esempio: https://aoairesource.openai.azure.com. Sostituire "aoairesource" con il Azure nome della risorsa OpenAI. https://{nome-risorsa}.openai.azure.com
api-version quesito No Versione esplicita dell'API Foundry Models da usare per questa richiesta.
v1 se non specificato diversamente.
aoai-evals intestazione Sì corda
Valori possibili: preview		 Consente l'accesso a AOAI Evals, una funzionalità di anteprima.
Questa funzionalità richiede che l'intestazione 'aoai-evals' sia impostata su 'preview'.
eval_id path Sì corda

Intestazione della richiesta

Usare l'autenticazione basata su token o la chiave API. L'autenticazione con l'autenticazione basata su token è consigliata e più sicura.

Name Obbligatorio Tipo Description
Autorizzazione Vero corda Esempio:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Per generare un token di autenticazione usando interfaccia della riga di comando di Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Tipo: oauth2
URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Ambito: https://ai.azure.com/.default
api-key Vero corda Specificare Azure chiave API OpenAI qui

Responses

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto Type Descrizione
application/json object

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto Type Descrizione
application/json AzureErrorResponse

Ottenere le esecuzioni di eval

GET {endpoint}/openai/v1/evals/{eval_id}/runs?api-version=preview

Recuperare un elenco di esecuzioni per una valutazione specificata.

NOTA: questa Azure'API OpenAI è in anteprima e soggetta a modifiche.

Parametri dell'URI

Name In Obbligatorio Tipo Description
endpoint path Sì corda
Url		 Azure endpoint OpenAI supportati (protocollo e nome host, ad esempio: https://aoairesource.openai.azure.com. Sostituire "aoairesource" con il Azure nome della risorsa OpenAI. https://{nome-risorsa}.openai.azure.com
api-version quesito No Versione esplicita dell'API Foundry Models da usare per questa richiesta.
v1 se non specificato diversamente.
aoai-evals intestazione Sì corda
Valori possibili: preview		 Consente l'accesso a AOAI Evals, una funzionalità di anteprima.
Questa funzionalità richiede che l'intestazione 'aoai-evals' sia impostata su 'preview'.
eval_id path Sì corda
dopo quesito No corda
limit quesito No Intero
order quesito No corda
Valori possibili: asc, desc
stato quesito No corda
Valori possibili: queued, in_progresscompleted, , canceled,failed

Intestazione della richiesta

Usare l'autenticazione basata su token o la chiave API. L'autenticazione con l'autenticazione basata su token è consigliata e più sicura.

Name Obbligatorio Tipo Description
Autorizzazione Vero corda Esempio:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Per generare un token di autenticazione usando interfaccia della riga di comando di Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Tipo: oauth2
URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Ambito: https://ai.azure.com/.default
api-key Vero corda Specificare Azure chiave API OpenAI qui

Responses

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto Type Descrizione
application/json OpenAI.EvalRunList

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto Type Descrizione
application/json AzureErrorResponse

Creare l'esecuzione di eval

POST {endpoint}/openai/v1/evals/{eval_id}/runs?api-version=preview

Creare una nuova esecuzione di valutazione, iniziando il processo di valutazione.

NOTA: questa Azure'API OpenAI è in anteprima e soggetta a modifiche.

Parametri dell'URI

Name In Obbligatorio Tipo Description
endpoint path Sì corda
Url		 Azure endpoint OpenAI supportati (protocollo e nome host, ad esempio: https://aoairesource.openai.azure.com. Sostituire "aoairesource" con il Azure nome della risorsa OpenAI. https://{nome-risorsa}.openai.azure.com
api-version quesito No Versione esplicita dell'API Foundry Models da usare per questa richiesta.
v1 se non specificato diversamente.
aoai-evals intestazione Sì corda
Valori possibili: preview		 Consente l'accesso a AOAI Evals, una funzionalità di anteprima.
Questa funzionalità richiede che l'intestazione 'aoai-evals' sia impostata su 'preview'.
eval_id path Sì corda

Intestazione della richiesta

Usare l'autenticazione basata su token o la chiave API. L'autenticazione con l'autenticazione basata su token è consigliata e più sicura.

Name Obbligatorio Tipo Description
Autorizzazione Vero corda Esempio:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Per generare un token di autenticazione usando interfaccia della riga di comando di Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Tipo: oauth2
URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Ambito: https://ai.azure.com/.default
api-key Vero corda Specificare Azure chiave API OpenAI qui

Corpo della richiesta

Content-Type: application/json

Name Tipo Description Obbligatorio Predefinito
fonte_dati object Sì
└─ Tipo OpenAI.EvalRunDataSourceType No
metadata object Set di 16 coppie chiave-valore che possono essere collegate a un oggetto . Ciò può essere utile per archiviare informazioni aggiuntive sull'oggetto in un formato strutturato ed eseguire query sugli oggetti tramite API o il dashboard.

Le chiavi sono stringhe con una lunghezza massima di 64 caratteri. I valori sono stringhe con una lunghezza massima di 512 caratteri.		 No
name corda Nome dell'esecuzione. No

Responses

Codice di stato: 201

Descrizione: la richiesta ha avuto esito positivo e una nuova risorsa è stata creata di conseguenza.

Tipo di contenuto Type Descrizione
application/json OpenAI.EvalRun

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto Type Descrizione
application/json AzureErrorResponse

Ottenere l'esecuzione di eval

GET {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}?api-version=preview

Recuperare un'esecuzione di valutazione specifica in base al relativo ID.

NOTA: questa Azure'API OpenAI è in anteprima e soggetta a modifiche.

Parametri dell'URI

Name In Obbligatorio Tipo Description
endpoint path Sì corda
Url		 Azure endpoint OpenAI supportati (protocollo e nome host, ad esempio: https://aoairesource.openai.azure.com. Sostituire "aoairesource" con il Azure nome della risorsa OpenAI. https://{nome-risorsa}.openai.azure.com
api-version quesito No Versione esplicita dell'API Foundry Models da usare per questa richiesta.
v1 se non specificato diversamente.
aoai-evals intestazione Sì corda
Valori possibili: preview		 Consente l'accesso a AOAI Evals, una funzionalità di anteprima.
Questa funzionalità richiede che l'intestazione 'aoai-evals' sia impostata su 'preview'.
eval_id path Sì corda
run_id path Sì corda

Intestazione della richiesta

Usare l'autenticazione basata su token o la chiave API. L'autenticazione con l'autenticazione basata su token è consigliata e più sicura.

Name Obbligatorio Tipo Description
Autorizzazione Vero corda Esempio:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Per generare un token di autenticazione usando interfaccia della riga di comando di Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Tipo: oauth2
URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Ambito: https://ai.azure.com/.default
api-key Vero corda Specificare Azure chiave API OpenAI qui

Responses

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto Type Descrizione
application/json OpenAI.EvalRun

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto Type Descrizione
application/json AzureErrorResponse

Annullare l'esecuzione di eval

POST {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}?api-version=preview

Annullare un'esecuzione di valutazione specifica in base al relativo ID.

NOTA: questa Azure'API OpenAI è in anteprima e soggetta a modifiche.

Parametri dell'URI

Name In Obbligatorio Tipo Description
endpoint path Sì corda
Url		 Azure endpoint OpenAI supportati (protocollo e nome host, ad esempio: https://aoairesource.openai.azure.com. Sostituire "aoairesource" con il Azure nome della risorsa OpenAI. https://{nome-risorsa}.openai.azure.com
api-version quesito No Versione esplicita dell'API Foundry Models da usare per questa richiesta.
v1 se non specificato diversamente.
aoai-evals intestazione Sì corda
Valori possibili: preview		 Consente l'accesso a AOAI Evals, una funzionalità di anteprima.
Questa funzionalità richiede che l'intestazione 'aoai-evals' sia impostata su 'preview'.
eval_id path Sì corda
run_id path Sì corda

Intestazione della richiesta

Usare l'autenticazione basata su token o la chiave API. L'autenticazione con l'autenticazione basata su token è consigliata e più sicura.

Name Obbligatorio Tipo Description
Autorizzazione Vero corda Esempio:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Per generare un token di autenticazione usando interfaccia della riga di comando di Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Tipo: oauth2
URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Ambito: https://ai.azure.com/.default
api-key Vero corda Specificare Azure chiave API OpenAI qui

Responses

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto Type Descrizione
application/json OpenAI.EvalRun

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto Type Descrizione
application/json AzureErrorResponse

Deleteevalrun

DELETE {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}?api-version=preview

Eliminare una valutazione specifica eseguita dal relativo ID.

NOTA: questa Azure'API OpenAI è in anteprima e soggetta a modifiche.

Parametri dell'URI

Name In Obbligatorio Tipo Description
endpoint path Sì corda
Url		 Azure endpoint OpenAI supportati (protocollo e nome host, ad esempio: https://aoairesource.openai.azure.com. Sostituire "aoairesource" con il Azure nome della risorsa OpenAI. https://{nome-risorsa}.openai.azure.com
api-version quesito No Versione esplicita dell'API Foundry Models da usare per questa richiesta.
v1 se non specificato diversamente.
aoai-evals intestazione Sì corda
Valori possibili: preview		 Consente l'accesso a AOAI Evals, una funzionalità di anteprima.
Questa funzionalità richiede che l'intestazione 'aoai-evals' sia impostata su 'preview'.
eval_id path Sì corda
run_id path Sì corda

Intestazione della richiesta

Usare l'autenticazione basata su token o la chiave API. L'autenticazione con l'autenticazione basata su token è consigliata e più sicura.

Name Obbligatorio Tipo Description
Autorizzazione Vero corda Esempio:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Per generare un token di autenticazione usando interfaccia della riga di comando di Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Tipo: oauth2
URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Ambito: https://ai.azure.com/.default
api-key Vero corda Specificare Azure chiave API OpenAI qui

Responses

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto Type Descrizione
application/json object

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto Type Descrizione
application/json AzureErrorResponse

Ottenere gli elementi di output dell'esecuzione di eval

GET {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}/output_items?api-version=preview

Ottenere un elenco di elementi di output per un'esecuzione di valutazione specificata.

NOTA: questa Azure'API OpenAI è in anteprima e soggetta a modifiche.

Parametri dell'URI

Name In Obbligatorio Tipo Description
endpoint path Sì corda
Url		 Azure endpoint OpenAI supportati (protocollo e nome host, ad esempio: https://aoairesource.openai.azure.com. Sostituire "aoairesource" con il Azure nome della risorsa OpenAI. https://{nome-risorsa}.openai.azure.com
api-version quesito No Versione esplicita dell'API Foundry Models da usare per questa richiesta.
v1 se non specificato diversamente.
aoai-evals intestazione Sì corda
Valori possibili: preview		 Consente l'accesso a AOAI Evals, una funzionalità di anteprima.
Questa funzionalità richiede che l'intestazione 'aoai-evals' sia impostata su 'preview'.
eval_id path Sì corda
run_id path Sì corda
dopo quesito No corda
limit quesito No Intero
stato quesito No corda
Valori possibili: fail, pass
order quesito No corda
Valori possibili: asc, desc

Intestazione della richiesta

Usare l'autenticazione basata su token o la chiave API. L'autenticazione con l'autenticazione basata su token è consigliata e più sicura.

Name Obbligatorio Tipo Description
Autorizzazione Vero corda Esempio:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Per generare un token di autenticazione usando interfaccia della riga di comando di Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Tipo: oauth2
URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Ambito: https://ai.azure.com/.default
api-key Vero corda Specificare Azure chiave API OpenAI qui

Responses

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto Type Descrizione
application/json OpenAI.EvalRunOutputItemList

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto Type Descrizione
application/json AzureErrorResponse

Ottenere l'elemento di output dell'esecuzione di eval

GET {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}/output_items/{output_item_id}?api-version=preview

Recuperare un elemento di output specifico da un'esecuzione di valutazione in base al relativo ID.

NOTA: questa Azure'API OpenAI è in anteprima e soggetta a modifiche.

Parametri dell'URI

Name In Obbligatorio Tipo Description
endpoint path Sì corda
Url		 Azure endpoint OpenAI supportati (protocollo e nome host, ad esempio: https://aoairesource.openai.azure.com. Sostituire "aoairesource" con il Azure nome della risorsa OpenAI. https://{nome-risorsa}.openai.azure.com
api-version quesito No Versione esplicita dell'API Foundry Models da usare per questa richiesta.
v1 se non specificato diversamente.
aoai-evals intestazione Sì corda
Valori possibili: preview		 Consente l'accesso a AOAI Evals, una funzionalità di anteprima.
Questa funzionalità richiede che l'intestazione 'aoai-evals' sia impostata su 'preview'.
eval_id path Sì corda
run_id path Sì corda
output_item_id path Sì corda

Intestazione della richiesta

Usare l'autenticazione basata su token o la chiave API. L'autenticazione con l'autenticazione basata su token è consigliata e più sicura.

Name Obbligatorio Tipo Description
Autorizzazione Vero corda Esempio:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Per generare un token di autenticazione usando interfaccia della riga di comando di Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Tipo: oauth2
URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Ambito: https://ai.azure.com/.default
api-key Vero corda Specificare Azure chiave API OpenAI qui

Responses

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto Type Descrizione
application/json OpenAI.EvalRunOutputItem

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto Type Descrizione
application/json AzureErrorResponse

Crea un file

POST {endpoint}/openai/v1/files?api-version=preview

Parametri dell'URI

Name In Obbligatorio Tipo Description
endpoint path Sì corda
Url		 Azure endpoint OpenAI supportati (protocollo e nome host, ad esempio: https://aoairesource.openai.azure.com. Sostituire "aoairesource" con il Azure nome della risorsa OpenAI. https://{nome-risorsa}.openai.azure.com
api-version quesito No Versione esplicita dell'API Foundry Models da usare per questa richiesta.
v1 se non specificato diversamente.

Intestazione della richiesta

Usare l'autenticazione basata su token o la chiave API. L'autenticazione con l'autenticazione basata su token è consigliata e più sicura.

Name Obbligatorio Tipo Description
Autorizzazione Vero corda Esempio:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Per generare un token di autenticazione usando interfaccia della riga di comando di Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Tipo: oauth2
URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Ambito: https://ai.azure.com/.default
api-key Vero corda Specificare Azure chiave API OpenAI qui

Corpo della richiesta

Tipo di contenuto: multipart/form-data

Name Tipo Description Obbligatorio Predefinito
scade dopo object Sì
Ancoraggio └* AzureFileExpiryAnchor No
└─ secondi Intero No
file corda Sì
purpose enum Scopo previsto del file caricato. Uno di: - assistants: usato nell'API Assistants - batch: Usato nell'API Batch - fine-tune: usato per l'ottimizzazione- evals: usato per set di dati eval
Valori possibili: assistants, batch, fine-tune, evals		 Sì

Responses

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto Type Descrizione
application/json AzureOpenAIFile

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto Type Descrizione
application/json AzureErrorResponse

Esempi

Example

POST {endpoint}/openai/v1/files?api-version=preview

Elencare file

GET {endpoint}/openai/v1/files?api-version=preview

Parametri dell'URI

Name In Obbligatorio Tipo Description
endpoint path Sì corda
Url		 Azure endpoint OpenAI supportati (protocollo e nome host, ad esempio: https://aoairesource.openai.azure.com. Sostituire "aoairesource" con il Azure nome della risorsa OpenAI. https://{nome-risorsa}.openai.azure.com
api-version quesito No Versione esplicita dell'API Foundry Models da usare per questa richiesta.
v1 se non specificato diversamente.
purpose quesito No corda

Intestazione della richiesta

Usare l'autenticazione basata su token o la chiave API. L'autenticazione con l'autenticazione basata su token è consigliata e più sicura.

Name Obbligatorio Tipo Description
Autorizzazione Vero corda Esempio:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Per generare un token di autenticazione usando interfaccia della riga di comando di Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Tipo: oauth2
URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Ambito: https://ai.azure.com/.default
api-key Vero corda Specificare Azure chiave API OpenAI qui

Responses

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto Type Descrizione
application/json AzureListFilesResponse

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto Type Descrizione
application/json AzureErrorResponse

Recuperare il file

GET {endpoint}/openai/v1/files/{file_id}?api-version=preview

Parametri dell'URI

Name In Obbligatorio Tipo Description
endpoint path Sì corda
Url		 Azure endpoint OpenAI supportati (protocollo e nome host, ad esempio: https://aoairesource.openai.azure.com. Sostituire "aoairesource" con il Azure nome della risorsa OpenAI. https://{nome-risorsa}.openai.azure.com
api-version quesito No Versione esplicita dell'API Foundry Models da usare per questa richiesta.
v1 se non specificato diversamente.
ID del file path Sì corda ID del file da utilizzare per questa richiesta.

Intestazione della richiesta

Usare l'autenticazione basata su token o la chiave API. L'autenticazione con l'autenticazione basata su token è consigliata e più sicura.

Name Obbligatorio Tipo Description
Autorizzazione Vero corda Esempio:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Per generare un token di autenticazione usando interfaccia della riga di comando di Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Tipo: oauth2
URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Ambito: https://ai.azure.com/.default
api-key Vero corda Specificare Azure chiave API OpenAI qui

Responses

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto Type Descrizione
application/json AzureOpenAIFile

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto Type Descrizione
application/json AzureErrorResponse

Elimina file

DELETE {endpoint}/openai/v1/files/{file_id}?api-version=preview

Parametri dell'URI

Name In Obbligatorio Tipo Description
endpoint path Sì corda
Url		 Azure endpoint OpenAI supportati (protocollo e nome host, ad esempio: https://aoairesource.openai.azure.com. Sostituire "aoairesource" con il Azure nome della risorsa OpenAI. https://{nome-risorsa}.openai.azure.com
api-version quesito No Versione esplicita dell'API Foundry Models da usare per questa richiesta.
v1 se non specificato diversamente.
ID del file path Sì corda ID del file da utilizzare per questa richiesta.

Intestazione della richiesta

Usare l'autenticazione basata su token o la chiave API. L'autenticazione con l'autenticazione basata su token è consigliata e più sicura.

Name Obbligatorio Tipo Description
Autorizzazione Vero corda Esempio:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Per generare un token di autenticazione usando interfaccia della riga di comando di Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Tipo: oauth2
URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Ambito: https://ai.azure.com/.default
api-key Vero corda Specificare Azure chiave API OpenAI qui

Responses

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto Type Descrizione
application/json OpenAI.DeleteFileResponse

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto Type Descrizione
application/json AzureErrorResponse

Scarica il file

GET {endpoint}/openai/v1/files/{file_id}/content?api-version=preview

Parametri dell'URI

Name In Obbligatorio Tipo Description
endpoint path Sì corda
Url		 Azure endpoint OpenAI supportati (protocollo e nome host, ad esempio: https://aoairesource.openai.azure.com. Sostituire "aoairesource" con il Azure nome della risorsa OpenAI. https://{nome-risorsa}.openai.azure.com
api-version quesito No Versione esplicita dell'API Foundry Models da usare per questa richiesta.
v1 se non specificato diversamente.
ID del file path Sì corda ID del file da utilizzare per questa richiesta.

Intestazione della richiesta

Usare l'autenticazione basata su token o la chiave API. L'autenticazione con l'autenticazione basata su token è consigliata e più sicura.

Name Obbligatorio Tipo Description
Autorizzazione Vero corda Esempio:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Per generare un token di autenticazione usando interfaccia della riga di comando di Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Tipo: oauth2
URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Ambito: https://ai.azure.com/.default
api-key Vero corda Specificare Azure chiave API OpenAI qui

Responses

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto Type Descrizione
application/octet-stream corda

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto Type Descrizione
application/json AzureErrorResponse

Rungrader

POST {endpoint}/openai/v1/fine_tuning/alpha/graders/run?api-version=preview

Eseguire un grader.

Parametri dell'URI

Name In Obbligatorio Tipo Description
endpoint path Sì corda
Url		 Azure endpoint OpenAI supportati (protocollo e nome host, ad esempio: https://aoairesource.openai.azure.com. Sostituire "aoairesource" con il Azure nome della risorsa OpenAI. https://{nome-risorsa}.openai.azure.com
api-version quesito No Versione esplicita dell'API Foundry Models da usare per questa richiesta.
v1 se non specificato diversamente.

Intestazione della richiesta

Usare l'autenticazione basata su token o la chiave API. L'autenticazione con l'autenticazione basata su token è consigliata e più sicura.

Name Obbligatorio Tipo Description
Autorizzazione Vero corda Esempio:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Per generare un token di autenticazione usando interfaccia della riga di comando di Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Tipo: oauth2
URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Ambito: https://ai.azure.com/.default
api-key Vero corda Specificare Azure chiave API OpenAI qui

Corpo della richiesta

Content-Type: application/json

Name Tipo Description Obbligatorio Predefinito
Selezionatore object Oggetto StringCheckGrader che esegue un confronto di stringhe tra input e riferimento usando un'operazione specificata. Sì
└' calculate_output corda Formula per calcolare l'output in base ai risultati del grader. No
└' evaluation_metric enum Metrica di valutazione da usare. Uno di fuzzy_match, bleugleu, meteor, rouge_1, rouge_2, rouge_3, rouge_4, , rouge_5o rouge_l.
Valori possibili: fuzzy_match, bleu, gleumeteor, rouge_1, rouge_2, rouge_3, rouge_4, rouge_5rouge_l		 No
└️ voti object No
└' image_tag corda Tag immagine da usare per lo script Python. No
└ Input array Testo di input. Ciò può includere stringhe di modello. No
└─ Modello corda Modello da utilizzare per la valutazione. No
└> nome corda Nome del grader. No
└─ Operazione enum Operazione di controllo della stringa da eseguire. Uno di eq, ne, likeo ilike.
Valori possibili: eq, ne, like, ilike		 No
└* intervallo array Intervallo del punteggio. Il valore predefinito è [0, 1]. No
Riferimento corda Testo a cui viene eseguito il voto. No
└sampling_params Parametri di campionamento per il modello. No
└─ sorgente corda Codice sorgente dello script Python. No
└─ Tipo enum Tipo di oggetto, che è sempre multi.
Valori possibili: multi		 No
oggetto Elemento del set di dati fornito al grader. Verrà usato per popolare lo item spazio dei nomi. No
model_sample corda Esempio di modello da valutare. Questo valore verrà usato per popolare lo spazio dei sample nomi.
La output_json variabile verrà popolata se l'esempio di modello è una stringa JSON valida.		 Sì

Responses

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto Type Descrizione
application/json OpenAI.RunGraderResponse

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto Type Descrizione
application/json AzureErrorResponse

Convalidare il classificatore

POST {endpoint}/openai/v1/fine_tuning/alpha/graders/validate?api-version=preview

Convalidare un classificatore.

Parametri dell'URI

Name In Obbligatorio Tipo Description
endpoint path Sì corda
Url		 Azure endpoint OpenAI supportati (protocollo e nome host, ad esempio: https://aoairesource.openai.azure.com. Sostituire "aoairesource" con il Azure nome della risorsa OpenAI. https://{nome-risorsa}.openai.azure.com
api-version quesito No Versione esplicita dell'API Foundry Models da usare per questa richiesta.
v1 se non specificato diversamente.

Intestazione della richiesta

Usare l'autenticazione basata su token o la chiave API. L'autenticazione con l'autenticazione basata su token è consigliata e più sicura.

Name Obbligatorio Tipo Description
Autorizzazione Vero corda Esempio:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Per generare un token di autenticazione usando interfaccia della riga di comando di Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Tipo: oauth2
URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Ambito: https://ai.azure.com/.default
api-key Vero corda Specificare Azure chiave API OpenAI qui

Corpo della richiesta

Content-Type: application/json

Name Tipo Description Obbligatorio Predefinito
Selezionatore object Oggetto StringCheckGrader che esegue un confronto di stringhe tra input e riferimento usando un'operazione specificata. Sì
└' calculate_output corda Formula per calcolare l'output in base ai risultati del grader. No
└' evaluation_metric enum Metrica di valutazione da usare. Uno di fuzzy_match, bleugleu, meteor, rouge_1, rouge_2, rouge_3, rouge_4, , rouge_5o rouge_l.
Valori possibili: fuzzy_match, bleu, gleumeteor, rouge_1, rouge_2, rouge_3, rouge_4, rouge_5rouge_l		 No
└️ voti object No
└' image_tag corda Tag immagine da usare per lo script Python. No
└ Input array Testo di input. Ciò può includere stringhe di modello. No
└─ Modello corda Modello da utilizzare per la valutazione. No
└> nome corda Nome del grader. No
└─ Operazione enum Operazione di controllo della stringa da eseguire. Uno di eq, ne, likeo ilike.
Valori possibili: eq, ne, like, ilike		 No
└* intervallo array Intervallo del punteggio. Il valore predefinito è [0, 1]. No
Riferimento corda Testo a cui viene eseguito il voto. No
└sampling_params Parametri di campionamento per il modello. No
└─ sorgente corda Codice sorgente dello script Python. No
└─ Tipo enum Tipo di oggetto, che è sempre multi.
Valori possibili: multi		 No

Responses

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto Type Descrizione
application/json OpenAI.ValidateGraderResponse

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto Type Descrizione
application/json AzureErrorResponse

Creare un processo di ottimizzazione

POST {endpoint}/openai/v1/fine_tuning/jobs?api-version=preview

Crea un processo di ottimizzazione che inizia il processo di creazione di un nuovo modello da un determinato set di dati.

La risposta include i dettagli del processo accodato, inclusi lo stato del processo e il nome dei modelli ottimizzati al termine.

Parametri dell'URI

Name In Obbligatorio Tipo Description
endpoint path Sì corda
Url		 Azure endpoint OpenAI supportati (protocollo e nome host, ad esempio: https://aoairesource.openai.azure.com. Sostituire "aoairesource" con il Azure nome della risorsa OpenAI. https://{nome-risorsa}.openai.azure.com
api-version quesito No Versione esplicita dell'API Foundry Models da usare per questa richiesta.
v1 se non specificato diversamente.

Intestazione della richiesta

Usare l'autenticazione basata su token o la chiave API. L'autenticazione con l'autenticazione basata su token è consigliata e più sicura.

Name Obbligatorio Tipo Description
Autorizzazione Vero corda Esempio:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Per generare un token di autenticazione usando interfaccia della riga di comando di Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Tipo: oauth2
URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Ambito: https://ai.azure.com/.default
api-key Vero corda Specificare Azure chiave API OpenAI qui

Corpo della richiesta

Content-Type: application/json

Name Tipo Description Obbligatorio Predefinito
iperparametri object Iperparametri usati per il processo di ottimizzazione.
Questo valore è ora deprecato a favore di methode deve essere passato nel method parametro .		 No
└batch_size enum
Valori possibili: auto		 No
└learning_rate_multiplier enum
Valori possibili: auto		 No
└n_epochs enum
Valori possibili: auto		 No
integrazioni array Elenco di integrazioni da abilitare per il processo di ottimizzazione. No
metadata object Set di 16 coppie chiave-valore che possono essere collegate a un oggetto . Ciò può essere utile per archiviare informazioni aggiuntive sull'oggetto in un formato strutturato ed eseguire query sugli oggetti tramite API o il dashboard.

Le chiavi sono stringhe con una lunghezza massima di 64 caratteri. I valori sono stringhe con una lunghezza massima di 512 caratteri.		 No
method OpenAI.FineTuneMethod Metodo utilizzato per l'ottimizzazione. No
model string (vedere modelli validi di seguito) Nome del modello da ottimizzare. Sì
seed Intero Il valore di inizializzazione controlla la riproducibilità del processo. Il passaggio degli stessi parametri di inizializzazione e processo dovrebbe produrre gli stessi risultati, ma può differire in rari casi.
Se non viene specificato un valore di inizializzazione, ne verrà generato uno automaticamente.		 No
Suffisso corda Stringa di un massimo di 64 caratteri che verrà aggiunta al nome del modello ottimizzato.

Ad esempio, un suffix valore di "custom-model-name" produce un nome di modello come ft:gpt-4o-mini:openai:custom-model-name:7p4lURel.		 No Nessuno
file di allenamento corda ID di un file caricato che contiene i dati di training. Il set di dati deve essere formattato come file JSONL. Inoltre, è necessario caricare il file con lo scopo fine-tune.

Il contenuto del file deve variare a seconda che il modello usi la chat, il formato dei completamenti o se il metodo di ottimizzazione usa il formato preferenza.		 Sì
file_di_validazione corda ID di un file caricato che contiene i dati di convalida.

Se si specifica questo file, i dati vengono usati per generare periodicamente le metriche di convalida durante l'ottimizzazione. Queste metriche possono essere visualizzate nel file dei risultati di ottimizzazione.
Gli stessi dati non devono essere presenti sia nei file di training che in quello di convalida.

Il set di dati deve essere formattato come file JSONL. È necessario caricare il file con lo scopo fine-tune.		 No

Responses

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto Type Descrizione
application/json OpenAI.FineTuningJob

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto Type Descrizione
application/json AzureErrorResponse

Elencare processi di ottimizzazione impaginati

GET {endpoint}/openai/v1/fine_tuning/jobs?api-version=preview

Elencare i processi di ottimizzazione dell'organizzazione

Parametri dell'URI

Name In Obbligatorio Tipo Description
endpoint path Sì corda
Url		 Azure endpoint OpenAI supportati (protocollo e nome host, ad esempio: https://aoairesource.openai.azure.com. Sostituire "aoairesource" con il Azure nome della risorsa OpenAI. https://{nome-risorsa}.openai.azure.com
api-version quesito No Versione esplicita dell'API Foundry Models da usare per questa richiesta.
v1 se non specificato diversamente.
dopo quesito No corda Identificatore per l'ultimo processo della richiesta di impaginazione precedente.
limit quesito No Intero Numero di processi di ottimizzazione da recuperare.

Intestazione della richiesta

Usare l'autenticazione basata su token o la chiave API. L'autenticazione con l'autenticazione basata su token è consigliata e più sicura.

Name Obbligatorio Tipo Description
Autorizzazione Vero corda Esempio:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Per generare un token di autenticazione usando interfaccia della riga di comando di Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Tipo: oauth2
URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Ambito: https://ai.azure.com/.default
api-key Vero corda Specificare Azure chiave API OpenAI qui

Responses

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto Type Descrizione
application/json OpenAI.ListPaginatedFineTuningJobsResponse

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto Type Descrizione
application/json AzureErrorResponse

Recuperare un processo di ottimizzazione

GET {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}?api-version=preview

Ottenere informazioni su un processo di ottimizzazione.

Parametri dell'URI

Name In Obbligatorio Tipo Description
endpoint path Sì corda
Url		 Azure endpoint OpenAI supportati (protocollo e nome host, ad esempio: https://aoairesource.openai.azure.com. Sostituire "aoairesource" con il Azure nome della risorsa OpenAI. https://{nome-risorsa}.openai.azure.com
api-version quesito No Versione esplicita dell'API Foundry Models da usare per questa richiesta.
v1 se non specificato diversamente.
id_lavoro_affinamento path Sì corda ID del processo di ottimizzazione.

Intestazione della richiesta

Usare l'autenticazione basata su token o la chiave API. L'autenticazione con l'autenticazione basata su token è consigliata e più sicura.

Name Obbligatorio Tipo Description
Autorizzazione Vero corda Esempio:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Per generare un token di autenticazione usando interfaccia della riga di comando di Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Tipo: oauth2
URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Ambito: https://ai.azure.com/.default
api-key Vero corda Specificare Azure chiave API OpenAI qui

Responses

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto Type Descrizione
application/json OpenAI.FineTuningJob

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto Type Descrizione
application/json AzureErrorResponse

Annullare il processo di ottimizzazione

POST {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/cancel?api-version=preview

Annullare immediatamente un processo di ottimizzazione.

Parametri dell'URI

Name In Obbligatorio Tipo Description
endpoint path Sì corda
Url		 Azure endpoint OpenAI supportati (protocollo e nome host, ad esempio: https://aoairesource.openai.azure.com. Sostituire "aoairesource" con il Azure nome della risorsa OpenAI. https://{nome-risorsa}.openai.azure.com
api-version quesito No Versione esplicita dell'API Foundry Models da usare per questa richiesta.
v1 se non specificato diversamente.
id_lavoro_affinamento path Sì corda ID del processo di ottimizzazione da annullare.

Intestazione della richiesta

Usare l'autenticazione basata su token o la chiave API. L'autenticazione con l'autenticazione basata su token è consigliata e più sicura.

Name Obbligatorio Tipo Description
Autorizzazione Vero corda Esempio:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Per generare un token di autenticazione usando interfaccia della riga di comando di Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Tipo: oauth2
URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Ambito: https://ai.azure.com/.default
api-key Vero corda Specificare Azure chiave API OpenAI qui

Responses

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto Type Descrizione
application/json OpenAI.FineTuningJob

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto Type Descrizione
application/json AzureErrorResponse

Elencare i checkpoint dei processi di ottimizzazione

GET {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/checkpoints?api-version=preview

Elencare i checkpoint per un processo di ottimizzazione.

Parametri dell'URI

Name In Obbligatorio Tipo Description
endpoint path Sì corda
Url		 Azure endpoint OpenAI supportati (protocollo e nome host, ad esempio: https://aoairesource.openai.azure.com. Sostituire "aoairesource" con il Azure nome della risorsa OpenAI. https://{nome-risorsa}.openai.azure.com
api-version quesito No Versione esplicita dell'API Foundry Models da usare per questa richiesta.
v1 se non specificato diversamente.
id_lavoro_affinamento path Sì corda ID del processo di ottimizzazione per cui ottenere i checkpoint.
dopo quesito No corda Identificatore dell'ultimo ID del checkpoint della richiesta di impaginazione precedente.
limit quesito No Intero Numero di checkpoint da recuperare.

Intestazione della richiesta

Usare l'autenticazione basata su token o la chiave API. L'autenticazione con l'autenticazione basata su token è consigliata e più sicura.

Name Obbligatorio Tipo Description
Autorizzazione Vero corda Esempio:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Per generare un token di autenticazione usando interfaccia della riga di comando di Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Tipo: oauth2
URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Ambito: https://ai.azure.com/.default
api-key Vero corda Specificare Azure chiave API OpenAI qui

Responses

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto Type Descrizione
application/json OpenAI.ListFineTuningJobCheckpointsResponse

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto Type Descrizione
application/json AzureErrorResponse

Elencare gli eventi di ottimizzazione

GET {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/events?api-version=preview

Ottenere gli aggiornamenti dello stato per un processo di ottimizzazione.

Parametri dell'URI

Name In Obbligatorio Tipo Description
endpoint path Sì corda
Url		 Azure endpoint OpenAI supportati (protocollo e nome host, ad esempio: https://aoairesource.openai.azure.com. Sostituire "aoairesource" con il Azure nome della risorsa OpenAI. https://{nome-risorsa}.openai.azure.com
api-version quesito No Versione esplicita dell'API Foundry Models da usare per questa richiesta.
v1 se non specificato diversamente.
id_lavoro_affinamento path Sì corda ID del processo di ottimizzazione per cui ottenere gli eventi.
dopo quesito No corda Identificatore per l'ultimo evento della richiesta di paginazione precedente.
limit quesito No Intero Numero di eventi da recuperare.

Intestazione della richiesta

Usare l'autenticazione basata su token o la chiave API. L'autenticazione con l'autenticazione basata su token è consigliata e più sicura.

Name Obbligatorio Tipo Description
Autorizzazione Vero corda Esempio:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Per generare un token di autenticazione usando interfaccia della riga di comando di Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Tipo: oauth2
URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Ambito: https://ai.azure.com/.default
api-key Vero corda Specificare Azure chiave API OpenAI qui

Responses

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto Type Descrizione
application/json OpenAI.ListFineTuningJobEventsResponse

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto Type Descrizione
application/json AzureErrorResponse

Sospendere il processo di ottimizzazione

POST {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/pause?api-version=preview

Sospendere un processo di ottimizzazione.

Parametri dell'URI

Name In Obbligatorio Tipo Description
endpoint path Sì corda
Url		 Azure endpoint OpenAI supportati (protocollo e nome host, ad esempio: https://aoairesource.openai.azure.com. Sostituire "aoairesource" con il Azure nome della risorsa OpenAI. https://{nome-risorsa}.openai.azure.com
api-version quesito No Versione esplicita dell'API Foundry Models da usare per questa richiesta.
v1 se non specificato diversamente.
id_lavoro_affinamento path Sì corda ID del processo di ottimizzazione da sospendere.

Intestazione della richiesta

Usare l'autenticazione basata su token o la chiave API. L'autenticazione con l'autenticazione basata su token è consigliata e più sicura.

Name Obbligatorio Tipo Description
Autorizzazione Vero corda Esempio:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Per generare un token di autenticazione usando interfaccia della riga di comando di Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Tipo: oauth2
URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Ambito: https://ai.azure.com/.default
api-key Vero corda Specificare Azure chiave API OpenAI qui

Responses

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto Type Descrizione
application/json OpenAI.FineTuningJob

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto Type Descrizione
application/json AzureErrorResponse

Riprendere il processo di ottimizzazione

POST {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/resume?api-version=preview

Riprendere un processo di ottimizzazione sospeso.

Parametri dell'URI

Name In Obbligatorio Tipo Description
endpoint path Sì corda
Url		 Azure endpoint OpenAI supportati (protocollo e nome host, ad esempio: https://aoairesource.openai.azure.com. Sostituire "aoairesource" con il Azure nome della risorsa OpenAI. https://{nome-risorsa}.openai.azure.com
api-version quesito No Versione esplicita dell'API Foundry Models da usare per questa richiesta.
v1 se non specificato diversamente.
id_lavoro_affinamento path Sì corda ID del processo di ottimizzazione da riprendere.

Intestazione della richiesta

Usare l'autenticazione basata su token o la chiave API. L'autenticazione con l'autenticazione basata su token è consigliata e più sicura.

Name Obbligatorio Tipo Description
Autorizzazione Vero corda Esempio:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Per generare un token di autenticazione usando interfaccia della riga di comando di Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Tipo: oauth2
URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Ambito: https://ai.azure.com/.default
api-key Vero corda Specificare Azure chiave API OpenAI qui

Responses

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto Type Descrizione
application/json OpenAI.FineTuningJob

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto Type Descrizione
application/json AzureErrorResponse

Creare la modifica dell'immagine

POST {endpoint}/openai/v1/images/edits?api-version=preview

Parametri dell'URI

Name In Obbligatorio Tipo Description
endpoint path Sì corda
Url		 Azure endpoint OpenAI supportati (protocollo e nome host, ad esempio: https://aoairesource.openai.azure.com. Sostituire "aoairesource" con il Azure nome della risorsa OpenAI. https://{nome-risorsa}.openai.azure.com
api-version quesito No Versione esplicita dell'API Foundry Models da usare per questa richiesta.
v1 se non specificato diversamente.

Intestazione della richiesta

Usare l'autenticazione basata su token o la chiave API. L'autenticazione con l'autenticazione basata su token è consigliata e più sicura.

Name Obbligatorio Tipo Description
Autorizzazione Vero corda Esempio:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Per generare un token di autenticazione usando interfaccia della riga di comando di Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Tipo: oauth2
URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Ambito: https://ai.azure.com/.default
api-key Vero corda Specificare Azure chiave API OpenAI qui

Corpo della richiesta

Tipo di contenuto: multipart/form-data

Name Tipo Description Obbligatorio Predefinito
sfondo enum Consente di impostare la trasparenza per lo sfondo delle immagini generate.
Questo parametro è supportato solo per gpt-image-1 i modelli. Deve essere uno di transparento opaqueauto (valore predefinito). Quando auto viene usato, il modello determinerà automaticamente lo sfondo migliore per l'immagine.

Se transparent, il formato di output deve supportare la trasparenza, quindi deve essere impostato su png (valore predefinito) o webp.
Valori possibili: transparent, opaque, auto		 No
immagine stringa o matrice Sì
mask corda No
model corda Distribuzione del modello da usare per l'operazione di modifica dell'immagine. Sì
n Intero Numero di immagini da generare. Deve essere compreso tra 1 e 10. No 1
Compressione dell'output Intero Livello di compressione (0-100%) per le immagini generate. Questo parametro è supportato solo per gpt-image-1i modelli -series con i webp formati di output o jpeg e il valore predefinito è 100. No 100
formato_di_output enum Formato in cui vengono restituite le immagini generate. Questo parametro è supportato solo per gpt-image-1i modelli -series. Deve essere uno di png, jpego webp.
Il valore predefinito è png.
Valori possibili: png, jpeg, webp		 No
prompt corda Descrizione testuale delle immagini desiderate. La lunghezza massima è di 1000 caratteri per dall-e-2i modelli di serie e 32000 caratteri gpt-image-1. Sì
qualità enum Qualità dell'immagine che verrà generata. highe mediumlow sono supportati solo per gpt-image-1i modelli -series. dall-e-2 supporta standard solo la qualità. Il valore predefinito è auto.
Valori possibili: standard, lowmedium, , high,auto		 No
formato_risposta enum Formato in cui vengono restituite le immagini generate. Deve essere uno di url o b64_json. Gli URL sono validi solo per 60 minuti dopo la generazione dell'immagine. Questo parametro è supportato solo per dall-e-2, perché gpt-image-1i modelli -series restituiscono sempre immagini con codifica Base64.
Valori possibili: url, b64_json		 No
size enum Dimensioni delle immagini generate. Deve essere uno di 1024x1024, 1536x1024 (orizzontale), 1024x1536 (verticale) o auto (valore predefinito) per gpt-image-1i modelli -series e uno di 256x256, 512x512o 1024x1024 per dall-e-2.
Valori possibili: 256x256, 512x5121024x1024, 1536x1024, , 1024x1536auto		 No
user corda Identificatore univoco che rappresenta l'utente finale, che consente a OpenAI di monitorare e rilevare gli abusi. No

Responses

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto Type Descrizione
application/json AzureImagesResponse

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto Type Descrizione
application/json AzureErrorResponse

Creare un'immagine

POST {endpoint}/openai/v1/images/generations?api-version=preview

Parametri dell'URI

Name In Obbligatorio Tipo Description
endpoint path Sì corda
Url		 Azure endpoint OpenAI supportati (protocollo e nome host, ad esempio: https://aoairesource.openai.azure.com. Sostituire "aoairesource" con il Azure nome della risorsa OpenAI. https://{nome-risorsa}.openai.azure.com
api-version quesito No Versione esplicita dell'API Foundry Models da usare per questa richiesta.
v1 se non specificato diversamente.

Intestazione della richiesta

Usare l'autenticazione basata su token o la chiave API. L'autenticazione con l'autenticazione basata su token è consigliata e più sicura.

Name Obbligatorio Tipo Description
Autorizzazione Vero corda Esempio:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Per generare un token di autenticazione usando interfaccia della riga di comando di Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Tipo: oauth2
URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Ambito: https://ai.azure.com/.default
api-key Vero corda Specificare Azure chiave API OpenAI qui

Corpo della richiesta

Content-Type: application/json

Name Tipo Description Obbligatorio Predefinito
sfondo enum Consente di impostare la trasparenza per lo sfondo delle immagini generate.
Questo parametro è supportato solo per gpt-image-1 i modelli. Deve essere uno di transparento opaqueauto (valore predefinito). Quando auto viene usato, il modello determinerà automaticamente lo sfondo migliore per l'immagine.

Se transparent, il formato di output deve supportare la trasparenza, quindi deve essere impostato su png (valore predefinito) o webp.
Valori possibili: transparent, opaque, auto		 No
model corda Distribuzione del modello da usare per la generazione di immagini. Sì
Moderazione enum Controllare il livello di moderazione del contenuto per le immagini generate dai gpt-image-1modelli di serie. Deve essere per un low filtro meno restrittivo o auto (valore predefinito).
Valori possibili: low, auto		 No
n Intero Numero di immagini da generare. Deve essere compreso tra 1 e 10. Solo per dall-e-3, n=1 è supportato. No 1
Compressione dell'output Intero Livello di compressione (0-100%) per le immagini generate. Questo parametro è supportato solo per gpt-image-1i modelli -series con i webp formati di output o jpeg e il valore predefinito è 100. No 100
formato_di_output enum Formato in cui vengono restituite le immagini generate. Questo parametro è supportato solo per gpt-image-1i modelli -series. Deve essere uno di png, jpego webp.
Valori possibili: png, jpeg, webp		 No
prompt corda Descrizione testuale delle immagini desiderate. La lunghezza massima è di 32000 caratteri per gpt-image-1i modelli di serie, 1000 caratteri per dall-e-2 e 4000 caratteri per dall-e-3. Sì
qualità enum Qualità dell'immagine che verrà generata.

- auto (valore predefinito) selezionerà automaticamente la migliore qualità per il modello specificato.
- highe mediumlow sono supportati per gpt-image-1i modelli -series.
- hd e standard sono supportati per dall-e-3.
- standard è l'unica opzione per dall-e-2.
Valori possibili: standard, hdlow, medium, , highauto		 No
formato_risposta enum Formato in cui vengono restituite le immagini generate con dall-e-2 e dall-e-3 . Deve essere uno di url o b64_json. Gli URL sono validi solo per 60 minuti dopo la generazione dell'immagine. Questo parametro non è supportato per gpt-image-1i modelli di serie che restituiranno sempre immagini con codifica Base64.
Valori possibili: url, b64_json		 No
size enum Dimensioni delle immagini generate. Deve essere uno di 1024x1024, 1536x1024 (orizzontale), (verticale) 1024x1536 o auto (valore predefinito) per gpt-image-1i modelli -series, uno di 256x256, 512x512o 1024x1024 per dall-e-2e uno di 1024x1024, 1792x1024o 1024x1792 per dall-e-3.
Valori possibili: auto, 1024x1024, 1536x10241024x1536, 256x256, 512x512, , 1792x10241024x1792		 No
Stile enum Stile delle immagini generate. Questo parametro è supportato solo per dall-e-3. Deve essere uno di vivid o natural. Vivid fa sì che il modello si appoggi verso la generazione di immagini iper-reali e drammatiche. Naturale fa sì che il modello producano immagini più naturali e meno iper-reali.
Valori possibili: vivid, natural		 No
user corda Identificatore univoco che rappresenta l'utente finale, che consente a OpenAI di monitorare e rilevare gli abusi. No

Responses

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto Type Descrizione
application/json AzureImagesResponse

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto Type Descrizione
application/json AzureErrorResponse

Esempi

Example

Crea immagini in base a un prompt.

POST {endpoint}/openai/v1/images/generations?api-version=preview

{
 "model": "dall-e-3",
 "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
          },
          "custom_blocklists": {
            "filtered": false,
            "details": []
          }
        },
        "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
          }
        }
      }
    ]
  }
}

Ottenere l'elenco dei modelli

GET {endpoint}/openai/v1/models?api-version=preview

Elenca i modelli attualmente disponibili e fornisce informazioni di base su ognuna, ad esempio il proprietario e la disponibilità.

Parametri dell'URI

Name In Obbligatorio Tipo Description
endpoint path Sì corda
Url		 Azure endpoint OpenAI supportati (protocollo e nome host, ad esempio: https://aoairesource.openai.azure.com. Sostituire "aoairesource" con il Azure nome della risorsa OpenAI. https://{nome-risorsa}.openai.azure.com
api-version quesito No Versione esplicita dell'API Foundry Models da usare per questa richiesta.
v1 se non specificato diversamente.

Intestazione della richiesta

Usare l'autenticazione basata su token o la chiave API. L'autenticazione con l'autenticazione basata su token è consigliata e più sicura.

Name Obbligatorio Tipo Description
Autorizzazione Vero corda Esempio:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Per generare un token di autenticazione usando interfaccia della riga di comando di Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Tipo: oauth2
URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Ambito: https://ai.azure.com/.default
api-key Vero corda Specificare Azure chiave API OpenAI qui

Responses

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto Type Descrizione
application/json OpenAI.ListModelsResponse

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto Type Descrizione
application/json AzureErrorResponse

Recuperare il modello

GET {endpoint}/openai/v1/models/{model}?api-version=preview

Recupera un'istanza del modello, fornendo informazioni di base sul modello, ad esempio il proprietario e l'autorizzazione.

Parametri dell'URI

Name In Obbligatorio Tipo Description
endpoint path Sì corda
Url		 Azure endpoint OpenAI supportati (protocollo e nome host, ad esempio: https://aoairesource.openai.azure.com. Sostituire "aoairesource" con il Azure nome della risorsa OpenAI. https://{nome-risorsa}.openai.azure.com
api-version quesito No Versione esplicita dell'API Foundry Models da usare per questa richiesta.
v1 se non specificato diversamente.
model path Sì corda ID del modello da utilizzare per questa richiesta.

Intestazione della richiesta

Usare l'autenticazione basata su token o la chiave API. L'autenticazione con l'autenticazione basata su token è consigliata e più sicura.

Name Obbligatorio Tipo Description
Autorizzazione Vero corda Esempio:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Per generare un token di autenticazione usando interfaccia della riga di comando di Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Tipo: oauth2
URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Ambito: https://ai.azure.com/.default
api-key Vero corda Specificare Azure chiave API OpenAI qui

Responses

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto Type Descrizione
application/json OpenAI.Model

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto Type Descrizione
application/json AzureErrorResponse

Creare una risposta

POST {endpoint}/openai/v1/responses?api-version=preview

Crea una risposta del modello.

Parametri dell'URI

Name In Obbligatorio Tipo Description
endpoint path Sì corda
Url		 Azure endpoint OpenAI supportati (protocollo e nome host, ad esempio: https://aoairesource.openai.azure.com. Sostituire "aoairesource" con il Azure nome della risorsa OpenAI. https://{nome-risorsa}.openai.azure.com
api-version quesito No Versione esplicita dell'API Foundry Models da usare per questa richiesta.
v1 se non specificato diversamente.

Intestazione della richiesta

Usare l'autenticazione basata su token o la chiave API. L'autenticazione con l'autenticazione basata su token è consigliata e più sicura.

Name Obbligatorio Tipo Description
Autorizzazione Vero corda Esempio:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Per generare un token di autenticazione usando interfaccia della riga di comando di Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Tipo: oauth2
URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Ambito: https://ai.azure.com/.default
api-key Vero corda Specificare Azure chiave API OpenAI qui

Corpo della richiesta

Content-Type: application/json

Name Tipo Description Obbligatorio Predefinito
sfondo Boolean Indica se eseguire la risposta del modello in background. No Falso
include array Specificare dati di output aggiuntivi da includere nella risposta del modello. I valori attualmente supportati sono:
- code_interpreter_call.outputs: include gli output dell'esecuzione del codice Python negli elementi di chiamata dello strumento dell'interprete del codice.
- computer_call_output.output.image_url: includere gli URL dell'immagine dall'output delle chiamate al computer.
- file_search_call.results: includere i risultati della ricerca della chiamata allo strumento di ricerca file.
- message.input_image.image_url: includere gli URL dell'immagine dal messaggio di input.
- message.output_text.logprobs: includere logprobs con messaggi di assistente.
- reasoning.encrypted_content: include una versione crittografata dei token di ragionamento negli output degli elementi di ragionamento. Ciò consente di usare gli elementi di ragionamento nelle conversazioni a più turni quando si usa l'API Risposte senza stato (ad esempio quando il store parametro è impostato su falseo quando un'organizzazione viene registrata nel programma di conservazione dei dati zero).		 No
input stringa o matrice No
instructions corda Messaggio di sistema (o sviluppatore) inserito nel contesto del modello.

Quando si usa insieme previous_response_ida , le istruzioni di una risposta precedente non verranno trasportate alla risposta successiva. In questo modo è semplice scambiare messaggi di sistema (o sviluppatore) in nuove risposte.		 No
max_output_tokens Intero Limite superiore per il numero di token che possono essere generati per una risposta, inclusi i token di output visibili e i token di ragionamento No
max_tool_calls Intero Numero massimo di chiamate totali agli strumenti predefiniti che possono essere elaborati in una risposta. Questo numero massimo si applica a tutte le chiamate predefinite degli strumenti, non per singolo strumento. Eventuali ulteriori tentativi di chiamare uno strumento dal modello verranno ignorati. No
metadata object Set di 16 coppie chiave-valore che possono essere collegate a un oggetto . Ciò può essere utile per archiviare informazioni aggiuntive sull'oggetto in un formato strutturato ed eseguire query sugli oggetti tramite API o il dashboard.

Le chiavi sono stringhe con una lunghezza massima di 64 caratteri. I valori sono stringhe con una lunghezza massima di 512 caratteri.		 No
model corda Distribuzione del modello da usare per la creazione di questa risposta. Sì
chiamate_parallele_agli_strumenti Boolean Indica se consentire al modello di eseguire chiamate degli strumenti in parallelo. No Vero
previous_response_id corda ID univoco della risposta precedente al modello. Usare questa opzione per creare conversazioni a più turni. No
prompt object Riferimento a un modello di richiesta e alle relative variabili. No
└* id corda Identificatore univoco del modello di richiesta da usare. No
** └─ Variabili OpenAI.ResponsePromptVariables Mapping facoltativo dei valori da sostituire con le variabili nel prompt. I valori di sostituzione possono essere stringhe o altri tipi di input di risposta, ad esempio immagini o file. No
└─ versione corda Versione facoltativa del modello di richiesta. No
reasoning object Solo modelli di serie o

Opzioni di configurazione per i modelli di ragionamento.		 No
└* sforzo Sforzo di Ragionamento OpenAI Solo modelli di serie o

Vincola lo sforzo sul ragionamento per i modelli di ragionamento.
I valori attualmente supportati sono low, mediume high. La riduzione del lavoro di ragionamento può comportare risposte più veloci e un minor numero di token usati per il ragionamento in una risposta.		 No
└─ genera_sommario enum Deprecato: usare summary invece.

Riepilogo del ragionamento eseguito dal modello. Ciò può essere utile per eseguire il debug e comprendere il processo di ragionamento del modello.
Uno di auto, conciseo detailed.
Valori possibili: auto, concise, detailed		 No
└─ Riepilogo enum Riepilogo del ragionamento eseguito dal modello. Ciò può essere utile per eseguire il debug e comprendere il processo di ragionamento del modello.
Uno di auto, conciseo detailed.
Valori possibili: auto, concise, detailed		 No
store Boolean Indica se archiviare la risposta del modello generata per il recupero successivo tramite API. No Vero
stream Boolean Se impostato su true, i dati di risposta del modello verranno trasmessi al client durante la generazione tramite eventi inviati dal server. No Falso
Temperatura number Temperatura di campionamento da usare, compresa tra 0 e 2. Valori più alti come 0,8 renderanno l'output più casuale, mentre i valori inferiori come 0,2 lo renderanno più incentrato e deterministico.
In genere è consigliabile modificare questa impostazione o top_p non entrambe.		 No 1
text object Opzioni di configurazione per una risposta di testo dal modello. Può essere un testo normale o dati JSON strutturati. No
└* formato OpenAI.ResponseTextFormatConfiguration No
tool_choice object Controlla quale strumento (se presente) viene chiamato dal modello.

none indica che il modello non chiamerà alcuno strumento e genera invece un messaggio.

auto indica che il modello può scegliere tra la generazione di un messaggio o la chiamata di uno o più strumenti.

required significa che il modello deve chiamare uno o più strumenti.		 No
└─ Tipo OpenAI.ToolChoiceObjectType Indica che il modello deve usare uno strumento predefinito per generare una risposta. No
Strumenti array Una matrice di strumenti che il modello può chiamare durante la generazione di una risposta. Tu
può specificare quale strumento usare impostando il tool_choice parametro .

Le due categorie di strumenti che è possibile fornire il modello sono:

- Strumenti predefiniti: strumenti forniti da OpenAI che estendono le funzionalità del modello, ad esempio la ricerca di file.
- Chiamate di funzione (strumenti personalizzati): funzioni definite dall'utente, consentendo al modello di chiamare il proprio codice.		 No
top_logprobs Intero 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. No
top_p number Un'alternativa al campionamento con temperatura, denominata campionamento del nucleo, in cui il modello considera i risultati dei token con top_p massa di probabilità. Quindi 0,1 significa che vengono considerati solo i token che comprendono i primi 10% massa di probabilità.

In genere è consigliabile modificare questa impostazione o temperature non entrambe.		 No 1
truncation enum Strategia di troncamento da usare per la risposta del modello.
- auto: se il contesto di questa risposta e quelli precedenti supera le dimensioni della finestra di contesto del modello, il modello tronca la risposta per adattarsi alla finestra di contesto eliminando gli elementi di input al centro della conversazione.
- disabled (impostazione predefinita): se una risposta del modello supererà le dimensioni della finestra di contesto per un modello, la richiesta avrà esito negativo con un errore 400.
Valori possibili: auto, disabled		 No
user corda Identificatore univoco che rappresenta l'utente finale, che consente a OpenAI di monitorare e rilevare gli abusi. No

Responses

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto Type Descrizione
application/json AzureResponse
text/event-stream OpenAI.ResponseStreamEvent

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto Type Descrizione
application/json AzureErrorResponse

Esempi

Example

Creare una risposta al modello

POST {endpoint}/openai/v1/responses?api-version=preview

Ottenere la risposta

GET {endpoint}/openai/v1/responses/{response_id}?api-version=preview

Recupera una risposta del modello con l'ID specificato.

Parametri dell'URI

Name In Obbligatorio Tipo Description
endpoint path Sì corda
Url		 Azure endpoint OpenAI supportati (protocollo e nome host, ad esempio: https://aoairesource.openai.azure.com. Sostituire "aoairesource" con il Azure nome della risorsa OpenAI. https://{nome-risorsa}.openai.azure.com
api-version quesito No Versione esplicita dell'API Foundry Models da usare per questa richiesta.
v1 se non specificato diversamente.
response_id path Sì corda
include[] quesito No array

Intestazione della richiesta

Usare l'autenticazione basata su token o la chiave API. L'autenticazione con l'autenticazione basata su token è consigliata e più sicura.

Name Obbligatorio Tipo Description
Autorizzazione Vero corda Esempio:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Per generare un token di autenticazione usando interfaccia della riga di comando di Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Tipo: oauth2
URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Ambito: https://ai.azure.com/.default
api-key Vero corda Specificare Azure chiave API OpenAI qui

Responses

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto Type Descrizione
application/json AzureResponse

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto Type Descrizione
application/json AzureErrorResponse

Eliminare la risposta

DELETE {endpoint}/openai/v1/responses/{response_id}?api-version=preview

Elimina una risposta in base all'ID.

Parametri dell'URI

Name In Obbligatorio Tipo Description
endpoint path Sì corda
Url		 Azure endpoint OpenAI supportati (protocollo e nome host, ad esempio: https://aoairesource.openai.azure.com. Sostituire "aoairesource" con il Azure nome della risorsa OpenAI. https://{nome-risorsa}.openai.azure.com
api-version quesito No Versione esplicita dell'API Foundry Models da usare per questa richiesta.
v1 se non specificato diversamente.
response_id path Sì corda

Intestazione della richiesta

Usare l'autenticazione basata su token o la chiave API. L'autenticazione con l'autenticazione basata su token è consigliata e più sicura.

Name Obbligatorio Tipo Description
Autorizzazione Vero corda Esempio:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Per generare un token di autenticazione usando interfaccia della riga di comando di Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Tipo: oauth2
URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Ambito: https://ai.azure.com/.default
api-key Vero corda Specificare Azure chiave API OpenAI qui

Responses

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto Type Descrizione
application/json object

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto Type Descrizione
application/json AzureErrorResponse

Elencare gli elementi di input

GET {endpoint}/openai/v1/responses/{response_id}/input_items?api-version=preview

Restituisce un elenco di elementi di input per una determinata risposta.

Parametri dell'URI

Name In Obbligatorio Tipo Description
endpoint path Sì corda
Url		 Azure endpoint OpenAI supportati (protocollo e nome host, ad esempio: https://aoairesource.openai.azure.com. Sostituire "aoairesource" con il Azure nome della risorsa OpenAI. https://{nome-risorsa}.openai.azure.com
api-version quesito No Versione esplicita dell'API Foundry Models da usare per questa richiesta.
v1 se non specificato diversamente.
response_id path Sì corda
limit quesito No Intero Limite al numero di oggetti da restituire. Il limite può variare tra 1 e 100 e il valore predefinito è 20.
order quesito No corda
Valori possibili: asc, desc		 Ordinare l'ordinamento in base al created_at timestamp degli oggetti. asc per l'ordine crescente edesc per l'ordine decrescente.
dopo quesito No corda Cursore da usare nella paginazione. after è un ID oggetto che definisce la posizione nell'elenco.
Ad esempio, se si effettua una richiesta di elenco e si ricevono 100 oggetti, terminando con obj_foo, la chiamata successiva può includere after=obj_foo per recuperare la pagina successiva dell'elenco.
before quesito No corda Cursore da usare nella paginazione. before è un ID oggetto che definisce la posizione nell'elenco.
Ad esempio, se si effettua una richiesta di elenco e si ricevono 100 oggetti, terminando con obj_foo, la chiamata successiva può includere before=obj_foo per recuperare la pagina precedente dell'elenco.

Intestazione della richiesta

Usare l'autenticazione basata su token o la chiave API. L'autenticazione con l'autenticazione basata su token è consigliata e più sicura.

Name Obbligatorio Tipo Description
Autorizzazione Vero corda Esempio:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Per generare un token di autenticazione usando interfaccia della riga di comando di Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Tipo: oauth2
URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Ambito: https://ai.azure.com/.default
api-key Vero corda Specificare Azure chiave API OpenAI qui

Responses

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto Type Descrizione
application/json OpenAI.ResponseItemList

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto Type Descrizione
application/json AzureErrorResponse

Elencare gli archivi vettoriali

GET {endpoint}/openai/v1/vector_stores?api-version=preview

Restituisce un elenco di archivi vettoriali.

Parametri dell'URI

Name In Obbligatorio Tipo Description
endpoint path Sì corda
Url		 Azure endpoint OpenAI supportati (protocollo e nome host, ad esempio: https://aoairesource.openai.azure.com. Sostituire "aoairesource" con il Azure nome della risorsa OpenAI. https://{nome-risorsa}.openai.azure.com
api-version quesito No Versione esplicita dell'API Foundry Models da usare per questa richiesta.
v1 se non specificato diversamente.
limit quesito No Intero Limite al numero di oggetti da restituire. Il limite può variare tra 1 e 100 e il valore predefinito è 20.
order quesito No corda
Valori possibili: asc, desc		 Ordinare l'ordinamento in base al created_at timestamp degli oggetti. asc per l'ordine crescente edesc per l'ordine decrescente.
dopo quesito No corda Cursore da usare nella paginazione. after è un ID oggetto che definisce la posizione nell'elenco.
Ad esempio, se si effettua una richiesta di elenco e si ricevono 100 oggetti, terminando con obj_foo, la chiamata successiva può includere after=obj_foo per recuperare la pagina successiva dell'elenco.
before quesito No corda Cursore da usare nella paginazione. before è un ID oggetto che definisce la posizione nell'elenco.
Ad esempio, se si effettua una richiesta di elenco e si ricevono 100 oggetti, terminando con obj_foo, la chiamata successiva può includere before=obj_foo per recuperare la pagina precedente dell'elenco.

Intestazione della richiesta

Usare l'autenticazione basata su token o la chiave API. L'autenticazione con l'autenticazione basata su token è consigliata e più sicura.

Name Obbligatorio Tipo Description
Autorizzazione Vero corda Esempio:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Per generare un token di autenticazione usando interfaccia della riga di comando di Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Tipo: oauth2
URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Ambito: https://ai.azure.com/.default
api-key Vero corda Specificare Azure chiave API OpenAI qui

Responses

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto Type Descrizione
application/json OpenAI.ListVectorStoresResponse

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto Type Descrizione
application/json AzureErrorResponse

Creare un archivio vettoriale

POST {endpoint}/openai/v1/vector_stores?api-version=preview

Crea un archivio vettoriale.

Parametri dell'URI

Name In Obbligatorio Tipo Description
endpoint path Sì corda
Url		 Azure endpoint OpenAI supportati (protocollo e nome host, ad esempio: https://aoairesource.openai.azure.com. Sostituire "aoairesource" con il Azure nome della risorsa OpenAI. https://{nome-risorsa}.openai.azure.com
api-version quesito No Versione esplicita dell'API Foundry Models da usare per questa richiesta.
v1 se non specificato diversamente.

Intestazione della richiesta

Usare l'autenticazione basata su token o la chiave API. L'autenticazione con l'autenticazione basata su token è consigliata e più sicura.

Name Obbligatorio Tipo Description
Autorizzazione Vero corda Esempio:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Per generare un token di autenticazione usando interfaccia della riga di comando di Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Tipo: oauth2
URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Ambito: https://ai.azure.com/.default
api-key Vero corda Specificare Azure chiave API OpenAI qui

Corpo della richiesta

Content-Type: application/json

Name Tipo Description Obbligatorio Predefinito
chunking_strategy object Strategia predefinita. Questa strategia usa attualmente un max_chunk_size_tokens oggetto di 800 e chunk_overlap_tokens di 400. No
└─ statico OpenAI.StaticChunkingStrategy No
└─ Tipo enum Sempre static.
Valori possibili: static		 No
scade dopo OpenAI.VectorStoreExpirationAfter Criteri di scadenza per un archivio vettoriale. No
identificatori_di_file array Elenco di ID file che devono essere usati dall'archivio vettoriale. Utile per strumenti come file_search questo possono accedere ai file. No
metadata object Set di 16 coppie chiave-valore che possono essere collegate a un oggetto . Ciò può essere utile per archiviare informazioni aggiuntive sull'oggetto in un formato strutturato ed eseguire query sugli oggetti tramite API o il dashboard.

Le chiavi sono stringhe con una lunghezza massima di 64 caratteri. I valori sono stringhe con una lunghezza massima di 512 caratteri.		 No
name corda Nome dell'archivio vettoriale. No

Responses

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto Type Descrizione
application/json OpenAI.VectorStoreObject

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto Type Descrizione
application/json AzureErrorResponse

Esempi

File di esempio non trovato: ./examples/vector_stores.json

Ottenere l'archivio vettoriale

GET {endpoint}/openai/v1/vector_stores/{vector_store_id}?api-version=preview

Recupera un archivio vettoriale.

Parametri dell'URI

Name In Obbligatorio Tipo Description
endpoint path Sì corda
Url		 Azure endpoint OpenAI supportati (protocollo e nome host, ad esempio: https://aoairesource.openai.azure.com. Sostituire "aoairesource" con il Azure nome della risorsa OpenAI. https://{nome-risorsa}.openai.azure.com
api-version quesito No Versione esplicita dell'API Foundry Models da usare per questa richiesta.
v1 se non specificato diversamente.
ID del negozio vettoriale path Sì corda ID dell'archivio vettoriale da recuperare.

Intestazione della richiesta

Usare l'autenticazione basata su token o la chiave API. L'autenticazione con l'autenticazione basata su token è consigliata e più sicura.

Name Obbligatorio Tipo Description
Autorizzazione Vero corda Esempio:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Per generare un token di autenticazione usando interfaccia della riga di comando di Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Tipo: oauth2
URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Ambito: https://ai.azure.com/.default
api-key Vero corda Specificare Azure chiave API OpenAI qui

Responses

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto Type Descrizione
application/json OpenAI.VectorStoreObject

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto Type Descrizione
application/json AzureErrorResponse

Modificare l'archivio vettoriale

POST {endpoint}/openai/v1/vector_stores/{vector_store_id}?api-version=preview

Modifica un archivio vettoriale.

Parametri dell'URI

Name In Obbligatorio Tipo Description
endpoint path Sì corda
Url		 Azure endpoint OpenAI supportati (protocollo e nome host, ad esempio: https://aoairesource.openai.azure.com. Sostituire "aoairesource" con il Azure nome della risorsa OpenAI. https://{nome-risorsa}.openai.azure.com
api-version quesito No Versione esplicita dell'API Foundry Models da usare per questa richiesta.
v1 se non specificato diversamente.
ID del negozio vettoriale path Sì corda ID dell'archivio vettoriale da modificare.

Intestazione della richiesta

Usare l'autenticazione basata su token o la chiave API. L'autenticazione con l'autenticazione basata su token è consigliata e più sicura.

Name Obbligatorio Tipo Description
Autorizzazione Vero corda Esempio:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Per generare un token di autenticazione usando interfaccia della riga di comando di Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Tipo: oauth2
URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Ambito: https://ai.azure.com/.default
api-key Vero corda Specificare Azure chiave API OpenAI qui

Corpo della richiesta

Content-Type: application/json

Name Tipo Description Obbligatorio Predefinito
scade dopo object Criteri di scadenza per un archivio vettoriale. No
Ancoraggio └* enum Timestamp di ancoraggio dopo il quale si applicano i criteri di scadenza. Ancoraggi supportati: last_active_at.
Valori possibili: last_active_at		 No
└* giorni Intero Numero di giorni dopo l'ora di ancoraggio che l'archivio vettoriale scadrà. No
metadata object Set di 16 coppie chiave-valore che possono essere collegate a un oggetto . Ciò può essere utile per archiviare informazioni aggiuntive sull'oggetto in un formato strutturato ed eseguire query sugli oggetti tramite API o il dashboard.

Le chiavi sono stringhe con una lunghezza massima di 64 caratteri. I valori sono stringhe con una lunghezza massima di 512 caratteri.		 No
name corda Nome dell'archivio vettoriale. No

Responses

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto Type Descrizione
application/json OpenAI.VectorStoreObject

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto Type Descrizione
application/json AzureErrorResponse

Eliminare l'archivio vettoriale

DELETE {endpoint}/openai/v1/vector_stores/{vector_store_id}?api-version=preview

Eliminare un archivio vettoriale.

Parametri dell'URI

Name In Obbligatorio Tipo Description
endpoint path Sì corda
Url		 Azure endpoint OpenAI supportati (protocollo e nome host, ad esempio: https://aoairesource.openai.azure.com. Sostituire "aoairesource" con il Azure nome della risorsa OpenAI. https://{nome-risorsa}.openai.azure.com
api-version quesito No Versione esplicita dell'API Foundry Models da usare per questa richiesta.
v1 se non specificato diversamente.
ID del negozio vettoriale path Sì corda ID dell'archivio vettoriale da eliminare.

Intestazione della richiesta

Usare l'autenticazione basata su token o la chiave API. L'autenticazione con l'autenticazione basata su token è consigliata e più sicura.

Name Obbligatorio Tipo Description
Autorizzazione Vero corda Esempio:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Per generare un token di autenticazione usando interfaccia della riga di comando di Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Tipo: oauth2
URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Ambito: https://ai.azure.com/.default
api-key Vero corda Specificare Azure chiave API OpenAI qui

Responses

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto Type Descrizione
application/json OpenAI.DeleteVectorStoreResponse

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto Type Descrizione
application/json AzureErrorResponse

Creare un batch di file dell'archivio vettoriale

POST {endpoint}/openai/v1/vector_stores/{vector_store_id}/file_batches?api-version=preview

Creare un batch di file di archivio vettoriale.

Parametri dell'URI

Name In Obbligatorio Tipo Description
endpoint path Sì corda
Url		 Azure endpoint OpenAI supportati (protocollo e nome host, ad esempio: https://aoairesource.openai.azure.com. Sostituire "aoairesource" con il Azure nome della risorsa OpenAI. https://{nome-risorsa}.openai.azure.com
api-version quesito No Versione esplicita dell'API Foundry Models da usare per questa richiesta.
v1 se non specificato diversamente.
ID del negozio vettoriale path Sì corda ID dell'archivio vettoriale per il quale creare un batch di file.

Intestazione della richiesta

Usare l'autenticazione basata su token o la chiave API. L'autenticazione con l'autenticazione basata su token è consigliata e più sicura.

Name Obbligatorio Tipo Description
Autorizzazione Vero corda Esempio:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Per generare un token di autenticazione usando interfaccia della riga di comando di Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Tipo: oauth2
URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Ambito: https://ai.azure.com/.default
api-key Vero corda Specificare Azure chiave API OpenAI qui

Corpo della richiesta

Content-Type: application/json

Name Tipo Description Obbligatorio Predefinito
attributes object Set di 16 coppie chiave-valore che possono essere collegate a un oggetto . Ciò può essere utile per archiviare informazioni aggiuntive sull'oggetto in un formato strutturato ed eseguire query sugli oggetti tramite API o il dashboard. Le chiavi sono stringhe con una lunghezza massima di 64 caratteri. I valori sono stringhe con una lunghezza massima di 512 caratteri, valori booleani o numeri. No
chunking_strategy OpenAI.ChunkingStrategyRequestParam Strategia di suddivisione in blocchi usata per suddividere i file. Se non impostato, userà la auto strategia. No
identificatori_di_file array Elenco di ID file che devono essere usati dall'archivio vettoriale. Utile per strumenti come file_search questo possono accedere ai file. Sì

Responses

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto Type Descrizione
application/json OpenAI.VectorStoreFileBatchObject

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto Type Descrizione
application/json AzureErrorResponse

Ottenere un batch di file dell'archivio vettoriale

GET {endpoint}/openai/v1/vector_stores/{vector_store_id}/file_batches/{batch_id}?api-version=preview

Recupera un batch di file dell'archivio vettoriale.

Parametri dell'URI

Name In Obbligatorio Tipo Description
endpoint path Sì corda
Url		 Azure endpoint OpenAI supportati (protocollo e nome host, ad esempio: https://aoairesource.openai.azure.com. Sostituire "aoairesource" con il Azure nome della risorsa OpenAI. https://{nome-risorsa}.openai.azure.com
api-version quesito No Versione esplicita dell'API Foundry Models da usare per questa richiesta.
v1 se non specificato diversamente.
ID del negozio vettoriale path Sì corda ID dell'archivio vettoriale a cui appartiene il batch di file.
batch_id path Sì corda ID del batch di file recuperato.

Intestazione della richiesta

Usare l'autenticazione basata su token o la chiave API. L'autenticazione con l'autenticazione basata su token è consigliata e più sicura.

Name Obbligatorio Tipo Description
Autorizzazione Vero corda Esempio:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Per generare un token di autenticazione usando interfaccia della riga di comando di Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Tipo: oauth2
URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Ambito: https://ai.azure.com/.default
api-key Vero corda Specificare Azure chiave API OpenAI qui

Responses

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto Type Descrizione
application/json OpenAI.VectorStoreFileBatchObject

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto Type Descrizione
application/json AzureErrorResponse

Annullare il batch di file dell'archivio vettoriale

POST {endpoint}/openai/v1/vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel?api-version=preview

Annullare un batch di file dell'archivio vettoriale. In questo modo si tenta di annullare il prima possibile l'elaborazione dei file in questo batch.

Parametri dell'URI

Name In Obbligatorio Tipo Description
endpoint path Sì corda
Url		 Azure endpoint OpenAI supportati (protocollo e nome host, ad esempio: https://aoairesource.openai.azure.com. Sostituire "aoairesource" con il Azure nome della risorsa OpenAI. https://{nome-risorsa}.openai.azure.com
api-version quesito No Versione esplicita dell'API Foundry Models da usare per questa richiesta.
v1 se non specificato diversamente.
ID del negozio vettoriale path Sì corda ID dell'archivio vettoriale a cui appartiene il batch di file.
batch_id path Sì corda ID del batch di file da annullare.

Intestazione della richiesta

Usare l'autenticazione basata su token o la chiave API. L'autenticazione con l'autenticazione basata su token è consigliata e più sicura.

Name Obbligatorio Tipo Description
Autorizzazione Vero corda Esempio:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Per generare un token di autenticazione usando interfaccia della riga di comando di Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Tipo: oauth2
URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Ambito: https://ai.azure.com/.default
api-key Vero corda Specificare Azure chiave API OpenAI qui

Responses

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto Type Descrizione
application/json OpenAI.VectorStoreFileBatchObject

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto Type Descrizione
application/json AzureErrorResponse

Elencare i file nel batch dell'archivio vettoriale

GET {endpoint}/openai/v1/vector_stores/{vector_store_id}/file_batches/{batch_id}/files?api-version=preview

Restituisce un elenco di file dell'archivio vettoriale in un batch.

Parametri dell'URI

Name In Obbligatorio Tipo Description
endpoint path Sì corda
Url		 Azure endpoint OpenAI supportati (protocollo e nome host, ad esempio: https://aoairesource.openai.azure.com. Sostituire "aoairesource" con il Azure nome della risorsa OpenAI. https://{nome-risorsa}.openai.azure.com
api-version quesito No Versione esplicita dell'API Foundry Models da usare per questa richiesta.
v1 se non specificato diversamente.
ID del negozio vettoriale path Sì corda ID dell'archivio vettoriale a cui appartiene il batch di file.
batch_id path Sì corda ID del batch di file a cui appartengono i file.
limit quesito No Intero Limite al numero di oggetti da restituire. Il limite può variare tra 1 e 100 e il valore predefinito è 20.
order quesito No corda
Valori possibili: asc, desc		 Ordinare l'ordinamento in base al created_at timestamp degli oggetti. asc per l'ordine crescente edesc per l'ordine decrescente.
dopo quesito No corda Cursore da usare nella paginazione. after è un ID oggetto che definisce la posizione nell'elenco.
Ad esempio, se si effettua una richiesta di elenco e si ricevono 100 oggetti, terminando con obj_foo, la chiamata successiva può includere after=obj_foo per recuperare la pagina successiva dell'elenco.
before quesito No corda Cursore da usare nella paginazione. before è un ID oggetto che definisce la posizione nell'elenco.
Ad esempio, se si effettua una richiesta di elenco e si ricevono 100 oggetti, terminando con obj_foo, la chiamata successiva può includere before=obj_foo per recuperare la pagina precedente dell'elenco.
filter quesito No Filtrare in base allo stato del file. Uno di in_progress, completed, failed, cancelled.

Intestazione della richiesta

Usare l'autenticazione basata su token o la chiave API. L'autenticazione con l'autenticazione basata su token è consigliata e più sicura.

Name Obbligatorio Tipo Description
Autorizzazione Vero corda Esempio:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Per generare un token di autenticazione usando interfaccia della riga di comando di Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Tipo: oauth2
URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Ambito: https://ai.azure.com/.default
api-key Vero corda Specificare Azure chiave API OpenAI qui

Responses

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto Type Descrizione
application/json OpenAI.ListVectorStoreFilesResponse

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto Type Descrizione
application/json AzureErrorResponse

Elencare i file dell'archivio vettoriale

GET {endpoint}/openai/v1/vector_stores/{vector_store_id}/files?api-version=preview

Restituisce un elenco di file dell'archivio vettoriale.

Parametri dell'URI

Name In Obbligatorio Tipo Description
endpoint path Sì corda
Url		 Azure endpoint OpenAI supportati (protocollo e nome host, ad esempio: https://aoairesource.openai.azure.com. Sostituire "aoairesource" con il Azure nome della risorsa OpenAI. https://{nome-risorsa}.openai.azure.com
api-version quesito No Versione esplicita dell'API Foundry Models da usare per questa richiesta.
v1 se non specificato diversamente.
ID del negozio vettoriale path Sì corda ID dell'archivio vettoriale a cui appartengono i file.
limit quesito No Intero Limite al numero di oggetti da restituire. Il limite può variare tra 1 e 100 e il valore predefinito è 20.
order quesito No corda
Valori possibili: asc, desc		 Ordinare l'ordinamento in base al created_at timestamp degli oggetti. asc per l'ordine crescente edesc per l'ordine decrescente.
dopo quesito No corda Cursore da usare nella paginazione. after è un ID oggetto che definisce la posizione nell'elenco.
Ad esempio, se si effettua una richiesta di elenco e si ricevono 100 oggetti, terminando con obj_foo, la chiamata successiva può includere after=obj_foo per recuperare la pagina successiva dell'elenco.
before quesito No corda Cursore da usare nella paginazione. before è un ID oggetto che definisce la posizione nell'elenco.
Ad esempio, se si effettua una richiesta di elenco e si ricevono 100 oggetti, terminando con obj_foo, la chiamata successiva può includere before=obj_foo per recuperare la pagina precedente dell'elenco.
filter quesito No Filtrare in base allo stato del file. Uno di in_progress, completed, failed, cancelled.

Intestazione della richiesta

Usare l'autenticazione basata su token o la chiave API. L'autenticazione con l'autenticazione basata su token è consigliata e più sicura.

Name Obbligatorio Tipo Description
Autorizzazione Vero corda Esempio:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Per generare un token di autenticazione usando interfaccia della riga di comando di Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Tipo: oauth2
URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Ambito: https://ai.azure.com/.default
api-key Vero corda Specificare Azure chiave API OpenAI qui

Responses

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto Type Descrizione
application/json OpenAI.ListVectorStoreFilesResponse

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto Type Descrizione
application/json AzureErrorResponse

Creare un file dell'archivio vettoriale

POST {endpoint}/openai/v1/vector_stores/{vector_store_id}/files?api-version=preview

Creare un file dell'archivio vettoriale allegando un file a un archivio vettoriale.

Parametri dell'URI

Name In Obbligatorio Tipo Description
endpoint path Sì corda
Url		 Azure endpoint OpenAI supportati (protocollo e nome host, ad esempio: https://aoairesource.openai.azure.com. Sostituire "aoairesource" con il Azure nome della risorsa OpenAI. https://{nome-risorsa}.openai.azure.com
api-version quesito No Versione esplicita dell'API Foundry Models da usare per questa richiesta.
v1 se non specificato diversamente.
ID del negozio vettoriale path Sì corda ID dell'archivio vettoriale per il quale creare un file.

Intestazione della richiesta

Usare l'autenticazione basata su token o la chiave API. L'autenticazione con l'autenticazione basata su token è consigliata e più sicura.

Name Obbligatorio Tipo Description
Autorizzazione Vero corda Esempio:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Per generare un token di autenticazione usando interfaccia della riga di comando di Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Tipo: oauth2
URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Ambito: https://ai.azure.com/.default
api-key Vero corda Specificare Azure chiave API OpenAI qui

Corpo della richiesta

Content-Type: application/json

Name Tipo Description Obbligatorio Predefinito
attributes object Set di 16 coppie chiave-valore che possono essere collegate a un oggetto . Ciò può essere utile per archiviare informazioni aggiuntive sull'oggetto in un formato strutturato ed eseguire query sugli oggetti tramite API o il dashboard. Le chiavi sono stringhe con una lunghezza massima di 64 caratteri. I valori sono stringhe con una lunghezza massima di 512 caratteri, valori booleani o numeri. No
chunking_strategy OpenAI.ChunkingStrategyRequestParam Strategia di suddivisione in blocchi usata per suddividere i file. Se non impostato, userà la auto strategia. No
ID del file corda ID file che deve essere usato dall'archivio vettoriale. Utile per strumenti come file_search questo possono accedere ai file. Sì

Responses

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto Type Descrizione
application/json OpenAI.VectorStoreFileObject

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto Type Descrizione
application/json AzureErrorResponse

Ottenere il file dell'archivio vettoriale

GET {endpoint}/openai/v1/vector_stores/{vector_store_id}/files/{file_id}?api-version=preview

Recupera un file di archivio vettoriale.

Parametri dell'URI

Name In Obbligatorio Tipo Description
endpoint path Sì corda
Url		 Azure endpoint OpenAI supportati (protocollo e nome host, ad esempio: https://aoairesource.openai.azure.com. Sostituire "aoairesource" con il Azure nome della risorsa OpenAI. https://{nome-risorsa}.openai.azure.com
api-version quesito No Versione esplicita dell'API Foundry Models da usare per questa richiesta.
v1 se non specificato diversamente.
ID del negozio vettoriale path Sì corda ID dell'archivio vettoriale a cui appartiene il file.
ID del file path Sì corda ID del file da recuperare.

Intestazione della richiesta

Usare l'autenticazione basata su token o la chiave API. L'autenticazione con l'autenticazione basata su token è consigliata e più sicura.

Name Obbligatorio Tipo Description
Autorizzazione Vero corda Esempio:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Per generare un token di autenticazione usando interfaccia della riga di comando di Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Tipo: oauth2
URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Ambito: https://ai.azure.com/.default
api-key Vero corda Specificare Azure chiave API OpenAI qui

Responses

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto Type Descrizione
application/json OpenAI.VectorStoreFileObject

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto Type Descrizione
application/json AzureErrorResponse

Aggiornare gli attributi del file dell'archivio vettoriale

POST {endpoint}/openai/v1/vector_stores/{vector_store_id}/files/{file_id}?api-version=preview

Parametri dell'URI

Name In Obbligatorio Tipo Description
endpoint path Sì corda
Url		 Azure endpoint OpenAI supportati (protocollo e nome host, ad esempio: https://aoairesource.openai.azure.com. Sostituire "aoairesource" con il Azure nome della risorsa OpenAI. https://{nome-risorsa}.openai.azure.com
api-version quesito No Versione esplicita dell'API Foundry Models da usare per questa richiesta.
v1 se non specificato diversamente.
ID del negozio vettoriale path Sì corda
ID del file path Sì corda

Intestazione della richiesta

Usare l'autenticazione basata su token o la chiave API. L'autenticazione con l'autenticazione basata su token è consigliata e più sicura.

Name Obbligatorio Tipo Description
Autorizzazione Vero corda Esempio:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Per generare un token di autenticazione usando interfaccia della riga di comando di Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Tipo: oauth2
URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Ambito: https://ai.azure.com/.default
api-key Vero corda Specificare Azure chiave API OpenAI qui

Corpo della richiesta

Content-Type: application/json

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

Responses

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto Type Descrizione
application/json OpenAI.VectorStoreFileObject

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto Type Descrizione
application/json AzureErrorResponse

Eliminare il file dell'archivio vettoriale

DELETE {endpoint}/openai/v1/vector_stores/{vector_store_id}/files/{file_id}?api-version=preview

Eliminare un file dell'archivio vettoriale. Il file verrà rimosso dall'archivio vettoriale, ma il file stesso non verrà eliminato. Per eliminare il file, usare l'endpoint del file di eliminazione.

Parametri dell'URI

Name In Obbligatorio Tipo Description
endpoint path Sì corda
Url		 Azure endpoint OpenAI supportati (protocollo e nome host, ad esempio: https://aoairesource.openai.azure.com. Sostituire "aoairesource" con il Azure nome della risorsa OpenAI. https://{nome-risorsa}.openai.azure.com
api-version quesito No Versione esplicita dell'API Foundry Models da usare per questa richiesta.
v1 se non specificato diversamente.
ID del negozio vettoriale path Sì corda ID dell'archivio vettoriale a cui appartiene il file.
ID del file path Sì corda ID del file da eliminare.

Intestazione della richiesta

Usare l'autenticazione basata su token o la chiave API. L'autenticazione con l'autenticazione basata su token è consigliata e più sicura.

Name Obbligatorio Tipo Description
Autorizzazione Vero corda Esempio:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Per generare un token di autenticazione usando interfaccia della riga di comando di Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Tipo: oauth2
URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Ambito: https://ai.azure.com/.default
api-key Vero corda Specificare Azure chiave API OpenAI qui

Responses

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto Type Descrizione
application/json OpenAI.DeleteVectorStoreFileResponse

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto Type Descrizione
application/json AzureErrorResponse

Processi di generazione di video - Creare

POST {endpoint}/openai/v1/video/generations/jobs?api-version=preview

Crea un nuovo processo di generazione di video.

Parametri dell'URI

Name In Obbligatorio Tipo Description
endpoint path Sì corda
Url		 Azure endpoint OpenAI supportati (protocollo e nome host, ad esempio: https://aoairesource.openai.azure.com. Sostituire "aoairesource" con il Azure nome della risorsa OpenAI. https://{nome-risorsa}.openai.azure.com
api-version quesito No Versione esplicita dell'API Foundry Models da usare per questa richiesta.
v1 se non specificato diversamente.

Intestazione della richiesta

Usare l'autenticazione basata su token o la chiave API. L'autenticazione con l'autenticazione basata su token è consigliata e più sicura.

Name Obbligatorio Tipo Description
Autorizzazione Vero corda Esempio:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Per generare un token di autenticazione usando interfaccia della riga di comando di Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Tipo: oauth2
URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Ambito: https://ai.azure.com/.default
api-key Vero corda Specificare Azure chiave API OpenAI qui

Corpo della richiesta

Content-Type: application/json

Name Tipo Description Obbligatorio Predefinito
height Intero Altezza del video. Sono supportate le dimensioni seguenti: 480x480, 854x480, 720x720, 1280x720, 1080x1080 e 1920x1080 sia in orientamento orizzontale che verticale. Sì
model corda Nome della distribuzione da usare per questa richiesta. Sì
n_seconds Intero Durata del processo di generazione video. Deve essere compreso tra 1 e 20 secondi. No 5
n_variants Intero Numero di video da creare come varianti per questo processo. Deve essere compreso tra 1 e 5. Le dimensioni più piccole consentono più varianti. No 1
prompt corda Richiesta di questo processo di generazione video. Sì
width Intero Larghezza del video. Sono supportate le dimensioni seguenti: 480x480, 854x480, 720x720, 1280x720, 1080x1080 e 1920x1080 sia in orientamento orizzontale che verticale. Sì

Corpo della richiesta

Tipo di contenuto: multipart/form-data

Name Tipo Description Obbligatorio Predefinito
File array Sì
height Intero Altezza del video. Sono supportate le dimensioni seguenti: 480x480, 854x480, 720x720, 1280x720, 1080x1080 e 1920x1080 sia in orientamento orizzontale che verticale. Sì
inpaint_items array Elementi facoltativi per questo processo di generazione di video. No
model corda Nome della distribuzione da usare per questa richiesta. Sì
n_seconds Intero Durata del processo di generazione video. Deve essere compreso tra 1 e 20 secondi. No 5
n_variants Intero Numero di video da creare come varianti per questo processo. Deve essere compreso tra 1 e 5. Le dimensioni più piccole consentono più varianti. No 1
prompt corda Richiesta di questo processo di generazione video. Sì
width Intero Larghezza del video. Sono supportate le dimensioni seguenti: 480x480, 854x480, 720x720, 1280x720, 1080x1080 e 1920x1080 sia in orientamento orizzontale che verticale. Sì

Responses

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto Type Descrizione
application/json VideoGenerationJob

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto Type Descrizione
application/json AzureOpenAIVideoGenerationErrorResponse

Esempi

File di esempio non trovato: ./examples/create_video_generation_job_simple.json

Processi di generazione di video - Elenco

GET {endpoint}/openai/v1/video/generations/jobs?api-version=preview

Elenca i processi di generazione di video.

Parametri dell'URI

Name In Obbligatorio Tipo Description
endpoint path Sì corda
Url		 Azure endpoint OpenAI supportati (protocollo e nome host, ad esempio: https://aoairesource.openai.azure.com. Sostituire "aoairesource" con il Azure nome della risorsa OpenAI. https://{nome-risorsa}.openai.azure.com
api-version quesito No Versione esplicita dell'API Foundry Models da usare per questa richiesta.
v1 se non specificato diversamente.
before quesito No corda
dopo quesito No corda
limit quesito Sì Intero
statuses quesito No array

Intestazione della richiesta

Usare l'autenticazione basata su token o la chiave API. L'autenticazione con l'autenticazione basata su token è consigliata e più sicura.

Name Obbligatorio Tipo Description
Autorizzazione Vero corda Esempio:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Per generare un token di autenticazione usando interfaccia della riga di comando di Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Tipo: oauth2
URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Ambito: https://ai.azure.com/.default
api-key Vero corda Specificare Azure chiave API OpenAI qui

Responses

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto Type Descrizione
application/json VideoGenerationJobList

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto Type Descrizione
application/json AzureOpenAIVideoGenerationErrorResponse

Esempi

File di esempio non trovato: ./examples/get_video_generation_job_list.json

Processi di generazione di video - Ottenere

GET {endpoint}/openai/v1/video/generations/jobs/{job-id}?api-version=preview

Recupera le proprietà di un processo di generazione di video.

Parametri dell'URI

Name In Obbligatorio Tipo Description
endpoint path Sì corda
Url		 Azure endpoint OpenAI supportati (protocollo e nome host, ad esempio: https://aoairesource.openai.azure.com. Sostituire "aoairesource" con il Azure nome della risorsa OpenAI. https://{nome-risorsa}.openai.azure.com
api-version quesito No Versione esplicita dell'API Foundry Models da usare per questa richiesta.
v1 se non specificato diversamente.
job-id path Sì corda ID del processo di generazione video da usare per la richiesta OpenAI Azure.

Intestazione della richiesta

Usare l'autenticazione basata su token o la chiave API. L'autenticazione con l'autenticazione basata su token è consigliata e più sicura.

Name Obbligatorio Tipo Description
Autorizzazione Vero corda Esempio:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Per generare un token di autenticazione usando interfaccia della riga di comando di Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Tipo: oauth2
URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Ambito: https://ai.azure.com/.default
api-key Vero corda Specificare Azure chiave API OpenAI qui

Responses

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto Type Descrizione
application/json VideoGenerationJob

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto Type Descrizione
application/json AzureOpenAIVideoGenerationErrorResponse

Esempi

File di esempio non trovato: ./examples/get_video_generation_job.json

Processi di generazione di video - Elimina

DELETE {endpoint}/openai/v1/video/generations/jobs/{job-id}?api-version=preview

Elimina un processo di generazione di video.

Parametri dell'URI

Name In Obbligatorio Tipo Description
endpoint path Sì corda
Url		 Azure endpoint OpenAI supportati (protocollo e nome host, ad esempio: https://aoairesource.openai.azure.com. Sostituire "aoairesource" con il Azure nome della risorsa OpenAI. https://{nome-risorsa}.openai.azure.com
api-version quesito No Versione esplicita dell'API Foundry Models da usare per questa richiesta.
v1 se non specificato diversamente.
job-id path Sì corda ID del processo di generazione video da usare per la richiesta OpenAI Azure.

Intestazione della richiesta

Usare l'autenticazione basata su token o la chiave API. L'autenticazione con l'autenticazione basata su token è consigliata e più sicura.

Name Obbligatorio Tipo Description
Autorizzazione Vero corda Esempio:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Per generare un token di autenticazione usando interfaccia della riga di comando di Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Tipo: oauth2
URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Ambito: https://ai.azure.com/.default
api-key Vero corda Specificare Azure chiave API OpenAI qui

Responses

Codice di stato: 204

Descrizione: nessun contenuto da inviare per questa richiesta, ma le intestazioni potrebbero essere utili.

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto Type Descrizione
application/json AzureOpenAIVideoGenerationErrorResponse

Generazioni di video - Ottenere

GET {endpoint}/openai/v1/video/generations/{generation-id}?api-version=preview

Recupera una generazione di video in base all'ID.

Parametri dell'URI

Name In Obbligatorio Tipo Description
endpoint path Sì corda
Url		 Azure endpoint OpenAI supportati (protocollo e nome host, ad esempio: https://aoairesource.openai.azure.com. Sostituire "aoairesource" con il Azure nome della risorsa OpenAI. https://{nome-risorsa}.openai.azure.com
api-version quesito No Versione esplicita dell'API Foundry Models da usare per questa richiesta.
v1 se non specificato diversamente.
generation-id path Sì corda ID della generazione di video da usare per la richiesta OpenAI Azure.

Intestazione della richiesta

Usare l'autenticazione basata su token o la chiave API. L'autenticazione con l'autenticazione basata su token è consigliata e più sicura.

Name Obbligatorio Tipo Description
Autorizzazione Vero corda Esempio:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Per generare un token di autenticazione usando interfaccia della riga di comando di Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Tipo: oauth2
URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Ambito: https://ai.azure.com/.default
api-key Vero corda Specificare Azure chiave API OpenAI qui

Responses

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto Type Descrizione
application/json VideoGeneration

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto Type Descrizione
application/json AzureOpenAIVideoGenerationErrorResponse

Esempi

File di esempio non trovato: ./examples/get_video_generation.json

Generazioni di video - Recuperare l'anteprima

GET {endpoint}/openai/v1/video/generations/{generation-id}/content/thumbnail?api-version=preview

Recupera un'anteprima del contenuto video generato.

Parametri dell'URI

Name In Obbligatorio Tipo Description
endpoint path Sì corda
Url		 Azure endpoint OpenAI supportati (protocollo e nome host, ad esempio: https://aoairesource.openai.azure.com. Sostituire "aoairesource" con il Azure nome della risorsa OpenAI. https://{nome-risorsa}.openai.azure.com
api-version quesito No Versione esplicita dell'API Foundry Models da usare per questa richiesta.
v1 se non specificato diversamente.
generation-id path Sì corda ID della generazione di video da usare per la richiesta OpenAI Azure.

Intestazione della richiesta

Usare l'autenticazione basata su token o la chiave API. L'autenticazione con l'autenticazione basata su token è consigliata e più sicura.

Name Obbligatorio Tipo Description
Autorizzazione Vero corda Esempio:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Per generare un token di autenticazione usando interfaccia della riga di comando di Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Tipo: oauth2
URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Ambito: https://ai.azure.com/.default
api-key Vero corda Specificare Azure chiave API OpenAI qui

Responses

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto Type Descrizione
image/jpg corda

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto Type Descrizione
application/json AzureOpenAIVideoGenerationErrorResponse

Generazioni di video - Recuperare il contenuto video

GET {endpoint}/openai/v1/video/generations/{generation-id}/content/video?api-version=preview

Recupera il contenuto video generato.

Parametri dell'URI

Name In Obbligatorio Tipo Description
endpoint path Sì corda
Url		 Azure endpoint OpenAI supportati (protocollo e nome host, ad esempio: https://aoairesource.openai.azure.com. Sostituire "aoairesource" con il Azure nome della risorsa OpenAI. https://{nome-risorsa}.openai.azure.com
api-version quesito No Versione esplicita dell'API Foundry Models da usare per questa richiesta.
v1 se non specificato diversamente.
generation-id path Sì corda ID della generazione di video da usare per la richiesta OpenAI Azure.
qualità quesito No

Intestazione della richiesta

Usare l'autenticazione basata su token o la chiave API. L'autenticazione con l'autenticazione basata su token è consigliata e più sicura.

Name Obbligatorio Tipo Description
Autorizzazione Vero corda Esempio:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Per generare un token di autenticazione usando interfaccia della riga di comando di Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Tipo: oauth2
URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Ambito: https://ai.azure.com/.default
api-key Vero corda Specificare Azure chiave API OpenAI qui

Responses

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto Type Descrizione
video/mp4 corda

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto Type Descrizione
application/json AzureOpenAIVideoGenerationErrorResponse

Generazioni di video - Recuperare solo le intestazioni videocontent

HEAD {endpoint}/openai/v1/video/generations/{generation-id}/content/video?api-version=preview

Recupera le intestazioni per il contenuto video generato.

Parametri dell'URI

Name In Obbligatorio Tipo Description
endpoint path Sì corda
Url		 Azure endpoint OpenAI supportati (protocollo e nome host, ad esempio: https://aoairesource.openai.azure.com. Sostituire "aoairesource" con il Azure nome della risorsa OpenAI. https://{nome-risorsa}.openai.azure.com
api-version quesito No Versione esplicita dell'API Foundry Models da usare per questa richiesta.
v1 se non specificato diversamente.
generation-id path Sì corda ID della generazione di video da usare per la richiesta OpenAI Azure.
qualità quesito No

Intestazione della richiesta

Usare l'autenticazione basata su token o la chiave API. L'autenticazione con l'autenticazione basata su token è consigliata e più sicura.

Name Obbligatorio Tipo Description
Autorizzazione Vero corda Esempio:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Per generare un token di autenticazione usando interfaccia della riga di comando di Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Tipo: oauth2
URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Ambito: https://ai.azure.com/.default
api-key Vero corda Specificare Azure chiave API OpenAI qui

Responses

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto Type Descrizione
application/json AzureOpenAIVideoGenerationErrorResponse

Components

AudioTaskLabel

Definisce i descrittori possibili per le risposte alle operazioni audio disponibili.

Proprietà Value
Descrizione Definisce i descrittori possibili per le risposte alle operazioni audio disponibili.
Type corda
Valori transcribe
translate

AudioTranslationSegment

Informazioni estese su un singolo segmento di dati audio tradotti. I segmenti rappresentano in genere circa 5-10 secondi di parlato. I limiti dei segmenti si verificano in genere tra parole, ma non necessariamente frasi.

Name Tipo Description Obbligatorio Predefinito
avg_logprob number Probabilità di log media associata a questo segmento audio. Sì
compression_ratio number Rapporto di compressione di questo segmento audio. Sì
fine number Ora in cui questo segmento è terminato rispetto all'inizio dell'audio tradotto. Sì
id Intero Indice in base 0 di questo segmento all'interno di una traduzione. Sì
no_speech_prob number Probabilità di nessun rilevamento vocale all'interno di questo segmento audio. Sì
seek Intero Posizione di ricerca associata all'elaborazione di questo segmento audio.
Le posizioni di ricerca vengono espresse come centesimi di secondi.
Il modello può elaborare diversi segmenti da una singola posizione di ricerca, quindi mentre la posizione di ricerca non rappresenterà mai un'ora successiva rispetto all'inizio del segmento, l'inizio del segmento può rappresentare un tempo significativamente successivo rispetto alla posizione di ricerca associata del segmento.		 Sì
start number Ora in cui questo segmento è iniziato rispetto all'inizio dell'audio tradotto. Sì
Temperatura number Punteggio di temperatura associato a questo segmento audio. Sì
text corda Testo tradotto che faceva parte di questo segmento audio. Sì
tokens array ID token corrispondenti al testo tradotto in questo segmento audio. Sì

AzureAIFoundryModelsApiVersion

Proprietà Value
Type corda
Valori v1
preview

AzureAudioTranscriptionResponse

Informazioni sui risultati per un'operazione che trascrive l'audio parlato in testo scritto.

Name Tipo Description Obbligatorio Predefinito
duration number Durata totale dell'audio elaborato per produrre informazioni di trascrizione a corredo. No
Lingua corda Lingua parlata rilevata nei dati audio trascritti.
Questo valore viene espresso come codice di lingua ISO-639-1 di due lettere, ad esempio 'en' o 'fr'.		 No
Segmenti array Raccolta di informazioni sulla tempistica, le probabilità e altri dettagli di ogni segmento audio elaborato. No
compito object Definisce i descrittori possibili per le risposte alle operazioni audio disponibili. No
text corda Testo trascritto per i dati audio forniti. Sì
words array Raccolta di informazioni sulla tempistica di ogni parola elaborata. No

AzureAudioTranslationResponse

Informazioni sui risultati per un'operazione che ha tradotto l'audio parlato in testo scritto.

Name Tipo Description Obbligatorio Predefinito
duration number Durata totale dell'audio elaborato per produrre informazioni di traduzione accompagnate. No
Lingua corda Lingua parlata rilevata nei dati audio tradotti.
Questo valore viene espresso come codice di lingua ISO-639-1 di due lettere, ad esempio 'en' o 'fr'.		 No
Segmenti array Raccolta di informazioni sulla tempistica, le probabilità e altri dettagli di ogni segmento audio elaborato. No
compito object Definisce i descrittori possibili per le risposte alle operazioni audio disponibili. No
text corda Testo tradotto per i dati audio forniti. Sì

AzureChatCompletionResponseMessage

Componente del modello di risposta esteso per i messaggi di risposta di completamento della chat nel servizio OpenAI Azure. Questo modello aggiunge il supporto per il contesto dei messaggi di chat, usato dalla funzionalità On Your Data per finalità, citazioni e altre informazioni correlate alla generazione aumentata di recupero eseguita.

Name Tipo Description Obbligatorio Predefinito
annotations array Annotazioni per il messaggio, se applicabile, come quando si usa lo strumento di ricerca Web. No
Audio object Se viene richiesta la modalità di output audio, questo oggetto contiene dati sulla risposta audio del modello. No
└* dati corda Byte audio con codifica Base64 generati dal modello, nel formato specificato nella richiesta. No
└─ scadenza_a Intero Timestamp Unix (in secondi) per quando questa risposta audio non sarà più accessibile nel server per l'uso nelle conversazioni a più turni. No
└* id corda Identificatore univoco per questa risposta audio. No
└─ trascrizione corda Trascrizione dell'audio generato dal modello. No
contenuto corda Contenuto del messaggio. Sì
context object Proprietà aggiuntiva, aggiunta ai messaggi di risposta di completamento della chat, prodotta dal servizio OpenAI Azure quando si usa il comportamento dell'estensione. Sono incluse informazioni sulla finalità e sulla citazione della funzionalità Dati personali. No
└all_retrieved_documents object Informazioni di riepilogo sui documenti recuperati dall'operazione di recupero dei dati. No
└chunk_id corda ID blocco per la citazione. No
└> contenuto corda Contenuto della citazione. No
└indice_sorgente_dati Intero Indice dell'origine dati utilizzata per il recupero. No
└─ percorso del file corda Percorso del file per la citazione. No
└─ motivo_filtro enum Se applicabile, indica il motivo per cui il documento è stato filtrato.
Valori possibili: score, rerank		 No
└ original_search_score number Punteggio di ricerca originale per il recupero. No
└─ punteggio_riordino number Punteggio di rerank per il recupero. No
└search_queries array Query di ricerca eseguite per recuperare i documenti. No
└> titolo corda Titolo della citazione. No
└─ URL corda URL della citazione. No
└─ citazioni array Citazioni prodotte dal recupero dei dati. No
└─ finalità corda Finalità rilevata dalla cronologia delle chat, usata per trasportare il contesto di conversazione tra le interazioni No
function_call object Deprecato e sostituito da tool_calls. Nome e argomenti di una funzione che deve essere chiamata, come generato dal modello. No
└─ Argomenti corda No
└> nome corda No
reasoning_content corda Proprietà di estensione Azure specifica contenente contenuto di ragionamento generato dai modelli supportati. No
refusal corda Messaggio di rifiuto generato dal modello. Sì
Ruolo enum Ruolo dell'autore del messaggio.
Valori possibili: assistant		 Sì
tool_calls ChatCompletionMessageToolCallsItem Lo strumento chiama generato dal modello, ad esempio le chiamate di funzione. No

AzureChatCompletionStreamResponseDelta

Modello di risposta esteso per un messaggio di risposta di chat in streaming nel servizio OpenAI Azure. Questo modello aggiunge il supporto per il contesto dei messaggi di chat, usato dalla funzionalità On Your Data per finalità, citazioni e altre informazioni correlate alla generazione aumentata di recupero eseguita.

Name Tipo Description Obbligatorio Predefinito
Audio object No
└* dati corda No
└─ scadenza_a Intero No
└* id corda No
└─ trascrizione corda No
contenuto corda Contenuto del messaggio di blocco. No
context object Proprietà aggiuntiva, aggiunta ai messaggi di risposta di completamento della chat, prodotta dal servizio OpenAI Azure quando si usa il comportamento dell'estensione. Sono incluse informazioni sulla finalità e sulla citazione della funzionalità Dati personali. No
└all_retrieved_documents object Informazioni di riepilogo sui documenti recuperati dall'operazione di recupero dei dati. No
└chunk_id corda ID blocco per la citazione. No
└> contenuto corda Contenuto della citazione. No
└indice_sorgente_dati Intero Indice dell'origine dati utilizzata per il recupero. No
└─ percorso del file corda Percorso del file per la citazione. No
└─ motivo_filtro enum Se applicabile, indica il motivo per cui il documento è stato filtrato.
Valori possibili: score, rerank		 No
└ original_search_score number Punteggio di ricerca originale per il recupero. No
└─ punteggio_riordino number Punteggio di rerank per il recupero. No
└search_queries array Query di ricerca eseguite per recuperare i documenti. No
└> titolo corda Titolo della citazione. No
└─ URL corda URL della citazione. No
└─ citazioni array Citazioni prodotte dal recupero dei dati. No
└─ finalità corda Finalità rilevata dalla cronologia delle chat, usata per trasportare il contesto di conversazione tra le interazioni No
function_call object Deprecato e sostituito da tool_calls. Nome e argomenti di una funzione che deve essere chiamata, come generato dal modello. No
└─ Argomenti corda No
└> nome corda No
reasoning_content corda Proprietà di estensione Azure specifica contenente contenuto di ragionamento generato dai modelli supportati. No
refusal corda Messaggio di rifiuto generato dal modello. No
Ruolo object Ruolo dell'autore di un messaggio No
tool_calls array No

AzureChatDataSource

Rappresentazione dei dati di configurazione per una singola origine dati di chat OpenAI Azure. Questa operazione verrà usata da una richiesta di completamento della chat che deve usare Azure estensioni della chat OpenAI per aumentare il comportamento della risposta. L'uso di questa configurazione è compatibile solo con Azure OpenAI.

Discriminare per AzureChatDataSource

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

Valore del tipo Schema
azure_search AzureSearchChatDataSource
azure_cosmos_db AzureCosmosDBChatDataSource
elasticsearch ElasticsearchChatDataSource
pinecone PineconeChatDataSource
mongo_db MongoDBChatDataSource
Name Tipo Description Obbligatorio Predefinito
type object Sì

AzureChatDataSourceAccessTokenAuthenticationOptions

Name Tipo Description Obbligatorio Predefinito
access_token corda Sì
type enum
Valori possibili: access_token		 Sì

AzureChatDataSourceApiKeyAuthenticationOptions

Name Tipo Description Obbligatorio Predefinito
chiave corda Sì
type enum
Valori possibili: api_key		 Sì

AzureChatDataSourceAuthenticationOptions

Discriminare per AzureChatDataSourceAuthenticationOptions

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

Valore del tipo Schema
system_assigned_managed_identity AzureChatDataSourceSystemAssignedManagedIdentityAuthenticationOptions
user_assigned_managed_identity AzureChatDataSourceUserAssignedManagedIdentityAuthenticationOptions
access_token AzureChatDataSourceAccessTokenAuthenticationOptions
connection_string AzureChatDataSourceConnectionStringAuthenticationOptions
key_and_key_id AzureChatDataSourceKeyAndKeyIdAuthenticationOptions
encoded_api_key AzureChatDataSourceEncodedApiKeyAuthenticationOptions
username_and_password AzureChatDataSourceUsernameAndPasswordAuthenticationOptions
Name Tipo Description Obbligatorio Predefinito
type AzureChatDataSourceAuthenticationOptionsType Sì

AzureChatDataSourceAuthenticationOptionsType

Proprietà Value
Type corda
Valori api_key
username_and_password
connection_string
key_and_key_id
encoded_api_key
access_token
system_assigned_managed_identity
user_assigned_managed_identity

AzureChatDataSourceConnectionStringAuthenticationOptions

Name Tipo Description Obbligatorio Predefinito
connection_string corda Sì
type enum
Valori possibili: connection_string		 Sì

AzureChatDataSourceDeploymentNameVectorizationSource

Rappresenta un'origine di vettorizzazione che effettua chiamate interne al servizio rispetto a una distribuzione del modello di incorporamento OpenAI Azure. A differenza dell'origine di vettorizzazione basata su endpoint, un'origine vettorializzazione basata su nome distribuzione deve far parte della stessa risorsa openAI Azure, ma può essere usata anche nelle reti private.

Name Tipo Description Obbligatorio Predefinito
nome_di_distribuzione corda Distribuzione del modello di incorporamento da usare per la vettorializzazione. Questa distribuzione deve esistere all'interno della stessa risorsa OpenAI Azure della distribuzione del modello usata per i completamenti della chat. Sì
dimensions Intero Numero di dimensioni da richiedere per gli incorporamenti.
Supportato solo nei modelli "text-embedding-3" e versioni successive.		 No
type enum Identificatore del tipo, sempre "deployment_name" per questo tipo di origine di vettorizzazione.
Valori possibili: deployment_name		 Sì

AzureChatDataSourceEncodedApiKeyAuthenticationOptions

Name Tipo Description Obbligatorio Predefinito
encoded_api_key corda Sì
type enum
Valori possibili: encoded_api_key		 Sì

AzureChatDataSourceEndpointVectorizationSource

Rappresenta un'origine di vettorizzazione che effettua chiamate al servizio pubblico su una distribuzione del modello di incorporamento OpenAI Azure.

Name Tipo Description Obbligatorio Predefinito
autenticazione object Sì
└access_token corda No
└─ tasto corda No
└─ Tipo enum
Valori possibili: access_token		 No
dimensions Intero Numero di dimensioni da richiedere per gli incorporamenti.
Supportato solo nei modelli "text-embedding-3" e versioni successive.		 No
endpoint corda Specifica l'URL dell'endpoint della risorsa da cui recuperare gli incorporamenti.
Deve essere nel formato di:
https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/embeddings.
Il parametro di query api-version non è consentito.		 Sì
type enum Identificatore del tipo, sempre "endpoint" per questo tipo di origine di vettorializzazione.
Valori possibili: endpoint		 Sì

AzureChatDataSourceIntegratedVectorizationSource

Rappresenta un'origine di vettorizzazione integrata definita all'interno della risorsa di ricerca di supporto.

Name Tipo Description Obbligatorio Predefinito
type enum Identificatore del tipo, sempre "integrato" per questo tipo di origine di vettorizzazione.
Valori possibili: integrated		 Sì

AzureChatDataSourceKeyAndKeyIdAuthenticationOptions

Name Tipo Description Obbligatorio Predefinito
chiave corda Sì
key_id corda Sì
type enum
Valori possibili: key_and_key_id		 Sì

AzureChatDataSourceModelIdVectorizationSource

Rappresenta un'origine di vettorizzazione che effettua chiamate di servizio in base a un ID modello del servizio di ricerca. Questo tipo di origine è attualmente supportato solo da Elasticsearch.

Name Tipo Description Obbligatorio Predefinito
model_id corda ID di compilazione del modello di incorporamento da usare per la vettorializzazione. Sì
type enum Identificatore del tipo, sempre "model_id" per questo tipo di origine di vettorializzazione.
Valori possibili: model_id		 Sì

AzureChatDataSourceSystemAssignedManagedIdentityAuthenticationOptions

Name Tipo Description Obbligatorio Predefinito
type enum
Valori possibili: system_assigned_managed_identity		 Sì

AzureChatDataSourceType

Proprietà Value
Type corda
Valori azure_search
azure_cosmos_db
elasticsearch
pinecone
mongo_db

AzureChatDataSourceUserAssignedManagedIdentityAuthenticationOptions

Name Tipo Description Obbligatorio Predefinito
managed_identity_resource_id corda Sì
type enum
Valori possibili: user_assigned_managed_identity		 Sì

AzureChatDataSourceUsernameAndPasswordAuthenticationOptions

Name Tipo Description Obbligatorio Predefinito
parola d’ordine corda Sì
type enum
Valori possibili: username_and_password		 Sì
username corda Sì

AzureChatDataSourceVectorizationSource

Rappresentazione di un'origine di vettorizzazione dei dati utilizzabile come risorsa di incorporamento con un'origine dati.

Discriminare per AzureChatDataSourceVectorizationSource

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

Valore del tipo Schema
deployment_name AzureChatDataSourceDeploymentNameVectorizationSource
integrated AzureChatDataSourceIntegratedVectorizationSource
model_id AzureChatDataSourceModelIdVectorizationSource
Name Tipo Description Obbligatorio Predefinito
type object Sì

AzureChatDataSourceVectorizationSourceType

Proprietà Value
Type corda
Valori endpoint
deployment_name
model_id
integrated

AzureChatMessageContext

Proprietà aggiuntiva, aggiunta ai messaggi di risposta di completamento della chat, prodotta dal servizio OpenAI Azure quando si usa il comportamento dell'estensione. Sono incluse informazioni sulla finalità e sulla citazione della funzionalità Dati personali.

Name Tipo Description Obbligatorio Predefinito
all_retrieved_documents object Informazioni di riepilogo sui documenti recuperati dall'operazione di recupero dei dati. No
└chunk_id corda ID blocco per la citazione. No
└> contenuto corda Contenuto della citazione. No
└indice_sorgente_dati Intero Indice dell'origine dati utilizzata per il recupero. No
└─ percorso del file corda Percorso del file per la citazione. No
└─ motivo_filtro enum Se applicabile, indica il motivo per cui il documento è stato filtrato.
Valori possibili: score, rerank		 No
└ original_search_score number Punteggio di ricerca originale per il recupero. No
└─ punteggio_riordino number Punteggio di rerank per il recupero. No
└search_queries array Query di ricerca eseguite per recuperare i documenti. No
└> titolo corda Titolo della citazione. No
└─ URL corda URL della citazione. No
citations array Citazioni prodotte dal recupero dei dati. No
intent corda Finalità rilevata dalla cronologia delle chat, usata per trasportare il contesto di conversazione tra le interazioni No

AzureContentFilterBlocklistResult

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

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

AzureContentFilterCompletionTextSpan

Rappresentazione di un intervallo di testo di completamento usato da Azure risultati del filtro del contenuto OpenAI.

Name Tipo Description Obbligatorio Predefinito
completion_end_offset Intero Offset del primo punto di codice UTF32 escluso dall'intervallo. Questo campo è sempre uguale a completion_start_offset per intervalli vuoti. Questo campo è sempre più grande di completion_start_offset per intervalli non vuoti. Sì
completion_start_offset Intero Offset del punto di codice UTF32 che inizia l'intervallo. Sì

AzureContentFilterCompletionTextSpanDetectionResult

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

AzureContentFilterCustomTopicResult

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

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

AzureContentFilterDetectionResult

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

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

AzureContentFilterImagePromptResults

Risultato di un filtro contenuto per il contenuto della richiesta di input di un'operazione di generazione di immagini.

Name Tipo Description Obbligatorio Predefinito
custom_blocklists object Raccolta di risultati di filtro true/false per gli elenchi di blocchi personalizzati configurati. No
└* dettagli array Coppie di ID elenco di blocchi singoli e se hanno generato un'azione di filtro. No
└* filtrato Boolean Valore che indica se uno degli elenchi di blocchi dettagliati ha generato un'azione di filtro. No
custom_topics object Raccolta di risultati di filtro true/false per gli argomenti personalizzati configurati. No
└* dettagli array Coppie di ID singoli argomenti e se vengono rilevate. No
└* filtrato Boolean Valore che indica se uno degli argomenti dettagliati ha generato un'azione di filtro. No
jailbreak object Elemento del risultato del filtro contenuto con etichetta che indica se il contenuto è stato rilevato e se il contenuto è stato filtrato. Sì
└> rilevato Boolean Indica se la categoria di contenuto etichettata è stata rilevata nel contenuto. No
└* filtrato Boolean Indica se il rilevamento del contenuto ha generato un'azione di filtro del contenuto. No
profanity object Elemento del risultato del filtro contenuto con etichetta che indica se il contenuto è stato rilevato e se il contenuto è stato filtrato. No
└> rilevato Boolean Indica se la categoria di contenuto etichettata è stata rilevata nel contenuto. No
└* filtrato Boolean Indica se il rilevamento del contenuto ha generato un'azione di filtro del contenuto. No

AzureContentFilterImageResponseResults

Risultato di un filtro contenuto per il contenuto della risposta di output di un'operazione di generazione di immagini.

Name Tipo Description Obbligatorio Predefinito
hate object Elemento del risultato del filtro contenuto etichettato che indica se il contenuto è stato filtrato e quale livello di gravità qualitativo del contenuto è stato valutato in base alla configurazione del filtro contenuto per la categoria. No
└* filtrato Boolean Indica se la gravità del contenuto ha generato un'azione di filtro del contenuto. No
└> gravità enum Gravità etichettata del contenuto.
Valori possibili: safe, low, medium, high		 No
self_harm object Elemento del risultato del filtro contenuto etichettato che indica se il contenuto è stato filtrato e quale livello di gravità qualitativo del contenuto è stato valutato in base alla configurazione del filtro contenuto per la categoria. No
└* filtrato Boolean Indica se la gravità del contenuto ha generato un'azione di filtro del contenuto. No
└> gravità enum Gravità etichettata del contenuto.
Valori possibili: safe, low, medium, high		 No
sexual object Elemento del risultato del filtro contenuto etichettato che indica se il contenuto è stato filtrato e quale livello di gravità qualitativo del contenuto è stato valutato in base alla configurazione del filtro contenuto per la categoria. No
└* filtrato Boolean Indica se la gravità del contenuto ha generato un'azione di filtro del contenuto. No
└> gravità enum Gravità etichettata del contenuto.
Valori possibili: safe, low, medium, high		 No
violence object Elemento del risultato del filtro contenuto etichettato che indica se il contenuto è stato filtrato e quale livello di gravità qualitativo del contenuto è stato valutato in base alla configurazione del filtro contenuto per la categoria. No
└* filtrato Boolean Indica se la gravità del contenuto ha generato un'azione di filtro del contenuto. No
└> gravità enum Gravità etichettata del contenuto.
Valori possibili: safe, low, medium, high		 No

AzureContentFilterResultForChoice

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

Name Tipo Description Obbligatorio Predefinito
custom_blocklists object Raccolta di risultati di filtro true/false per gli elenchi di blocchi personalizzati configurati. No
└* dettagli array Coppie di ID elenco di blocchi singoli e se hanno generato un'azione di filtro. No
└* filtrato Boolean Valore che indica se uno degli elenchi di blocchi dettagliati ha generato un'azione di filtro. No
custom_topics object Raccolta di risultati di filtro true/false per gli argomenti personalizzati configurati. No
└* dettagli array Coppie di ID singoli argomenti e se vengono rilevate. No
└* filtrato Boolean Valore che indica se uno degli argomenti dettagliati ha generato un'azione di filtro. No
Errore object Se presente, vengono fornite informazioni dettagliate su un errore che impediva il completamento della valutazione del filtro del contenuto. No
└─ codice Intero Codice distinto e leggibile dal computer associato all'errore. No
└* messaggio corda Messaggio leggibile associato all'errore. No
hate object Elemento del risultato del filtro contenuto etichettato che indica se il contenuto è stato filtrato e quale livello di gravità qualitativo del contenuto è stato valutato in base alla configurazione del filtro contenuto per la categoria. No
└* filtrato Boolean Indica se la gravità del contenuto ha generato un'azione di filtro del contenuto. No
└> gravità enum Gravità etichettata del contenuto.
Valori possibili: safe, low, medium, high		 No
profanity object Elemento del risultato del filtro contenuto con etichetta che indica se il contenuto è stato rilevato e se il contenuto è stato filtrato. No
└> rilevato Boolean Indica se la categoria di contenuto etichettata è stata rilevata nel contenuto. No
└* filtrato Boolean Indica se il rilevamento del contenuto ha generato un'azione di filtro del contenuto. No
protected_material_code object Risultato del rilevamento che descrive una corrispondenza rispetto al codice concesso in licenza o ad altri materiali di origine protetti. No
└─ Citazione object Se disponibile, i dettagli della citazione che descrivono la licenza associata e la relativa posizione. No
└* URL corda URL associato alla licenza. No
└─ licenza corda Nome o identificatore della licenza associata al rilevamento. No
└> rilevato Boolean Indica se la categoria di contenuto etichettata è stata rilevata nel contenuto. No
└* filtrato Boolean Indica se il rilevamento del contenuto ha generato un'azione di filtro del contenuto. No
protected_material_text object Elemento del risultato del filtro contenuto con etichetta che indica se il contenuto è stato rilevato e se il contenuto è stato filtrato. No
└> rilevato Boolean Indica se la categoria di contenuto etichettata è stata rilevata nel contenuto. No
└* filtrato Boolean Indica se il rilevamento del contenuto ha generato un'azione di filtro del contenuto. No
self_harm object Elemento del risultato del filtro contenuto etichettato che indica se il contenuto è stato filtrato e quale livello di gravità qualitativo del contenuto è stato valutato in base alla configurazione del filtro contenuto per la categoria. No
└* filtrato Boolean Indica se la gravità del contenuto ha generato un'azione di filtro del contenuto. No
└> gravità enum Gravità etichettata del contenuto.
Valori possibili: safe, low, medium, high		 No
sexual object Elemento del risultato del filtro contenuto etichettato che indica se il contenuto è stato filtrato e quale livello di gravità qualitativo del contenuto è stato valutato in base alla configurazione del filtro contenuto per la categoria. No
└* filtrato Boolean Indica se la gravità del contenuto ha generato un'azione di filtro del contenuto. No
└> gravità enum Gravità etichettata del contenuto.
Valori possibili: safe, low, medium, high		 No
ungrounded_material AzureContentFilterCompletionTextSpanDetectionResult No
violence object Elemento del risultato del filtro contenuto etichettato che indica se il contenuto è stato filtrato e quale livello di gravità qualitativo del contenuto è stato valutato in base alla configurazione del filtro contenuto per la categoria. No
└* filtrato Boolean Indica se la gravità del contenuto ha generato un'azione di filtro del contenuto. No
└> gravità enum Gravità etichettata del contenuto.
Valori possibili: safe, low, medium, high		 No

AzureContentFilterResultForPrompt

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

Name Tipo Description Obbligatorio Predefinito
content_filter_results object Dettagli della categoria del filtro contenuto per il risultato. No
└─ liste_blocchi_personalizzate object Raccolta di risultati di filtro true/false per gli elenchi di blocchi personalizzati configurati. No
└* dettagli array Coppie di ID elenco di blocchi singoli e se hanno generato un'azione di filtro. No
└* filtrato Boolean Valore che indica se uno degli elenchi di blocchi dettagliati ha generato un'azione di filtro. No
└custom_topics object Raccolta di risultati di filtro true/false per gli argomenti personalizzati configurati. No
└* dettagli array Coppie di ID singoli argomenti e se vengono rilevate. No
└* filtrato Boolean Valore che indica se uno degli argomenti dettagliati ha generato un'azione di filtro. No
└─ Errore object Se presente, vengono fornite informazioni dettagliate su un errore che impediva il completamento della valutazione del filtro del contenuto. No
└─ codice Intero Codice distinto e leggibile dal computer associato all'errore. No
└* messaggio corda Messaggio leggibile associato all'errore. No
└> odio object Elemento del risultato del filtro contenuto etichettato che indica se il contenuto è stato filtrato e quale livello di gravità qualitativo del contenuto è stato valutato in base alla configurazione del filtro contenuto per la categoria. No
└* filtrato Boolean Indica se la gravità del contenuto ha generato un'azione di filtro del contenuto. No
└> gravità enum Gravità etichettata del contenuto.
Valori possibili: safe, low, medium, high		 No
└attacco indiretto object Elemento del risultato del filtro contenuto con etichetta che indica se il contenuto è stato rilevato e se il contenuto è stato filtrato. No
└> rilevato Boolean Indica se la categoria di contenuto etichettata è stata rilevata nel contenuto. No
└* filtrato Boolean Indica se il rilevamento del contenuto ha generato un'azione di filtro del contenuto. No
└* jailbreak object Elemento del risultato del filtro contenuto con etichetta che indica se il contenuto è stato rilevato e se il contenuto è stato filtrato. No
└> rilevato Boolean Indica se la categoria di contenuto etichettata è stata rilevata nel contenuto. No
└* filtrato Boolean Indica se il rilevamento del contenuto ha generato un'azione di filtro del contenuto. No
└* volgarità object Elemento del risultato del filtro contenuto con etichetta che indica se il contenuto è stato rilevato e se il contenuto è stato filtrato. No
└> rilevato Boolean Indica se la categoria di contenuto etichettata è stata rilevata nel contenuto. No
└* filtrato Boolean Indica se il rilevamento del contenuto ha generato un'azione di filtro del contenuto. No
└─ autolesionismo object Elemento del risultato del filtro contenuto etichettato che indica se il contenuto è stato filtrato e quale livello di gravità qualitativo del contenuto è stato valutato in base alla configurazione del filtro contenuto per la categoria. No
└* filtrato Boolean Indica se la gravità del contenuto ha generato un'azione di filtro del contenuto. No
└> gravità enum Gravità etichettata del contenuto.
Valori possibili: safe, low, medium, high		 No
└─ sessuale object Elemento del risultato del filtro contenuto etichettato che indica se il contenuto è stato filtrato e quale livello di gravità qualitativo del contenuto è stato valutato in base alla configurazione del filtro contenuto per la categoria. No
└* filtrato Boolean Indica se la gravità del contenuto ha generato un'azione di filtro del contenuto. No
└> gravità enum Gravità etichettata del contenuto.
Valori possibili: safe, low, medium, high		 No
└* violenza object Elemento del risultato del filtro contenuto etichettato che indica se il contenuto è stato filtrato e quale livello di gravità qualitativo del contenuto è stato valutato in base alla configurazione del filtro contenuto per la categoria. No
└* filtrato Boolean Indica se la gravità del contenuto ha generato un'azione di filtro del contenuto. No
└> gravità enum Gravità etichettata del contenuto.
Valori possibili: safe, low, medium, high		 No
prompt_index Intero Indice del prompt di input associato alle categorie di risultati del filtro contenuto associato. No

AzureContentFilterSeverityResult

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

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

AzureCosmosDBChatDataSource

Rappresenta una configurazione dell'origine dati che userà una risorsa Azure CosmosDB.

Name Tipo Description Obbligatorio Predefinito
parameters object Informazioni sui parametri per controllare l'uso dell'origine dati Azure CosmosDB. Sì
└─ consenti_risultato_parziale Boolean Se impostato su true, il sistema consentirà l'uso di risultati parziali della ricerca e la richiesta avrà esito negativo se tutte le query parziali hanno esito negativo. Se non specificato o specificato come false, la richiesta avrà esito negativo se una query di ricerca ha esito negativo. No Falso
Autenticazione AzureChatDataSourceConnectionStringAuthenticationOptions No
└container_name corda No
└─database_name corda No
└─ dipendenza_embedded AzureChatDataSourceVectorizationSource Rappresentazione di un'origine di vettorizzazione dei dati utilizzabile come risorsa di incorporamento con un'origine dati. No
└ fields_mapping object No
└content_fields array No
└─content_fields_separator corda No
└filepath_field corda No
└─ campo_titolo corda No
└url_field corda No
└vector_fields array No
└ in_scope Boolean Indica se le query devono essere limitate all'uso dei dati indicizzati. No
└include_contexts array Proprietà del contesto di output da includere nella risposta.
Per impostazione predefinita, verranno richieste citazioni e finalità.		 No ['citazioni', 'intento']
└ index_name corda No
└max_search_queries Intero Numero massimo di query riscritte che devono essere inviate al provider di ricerca per un singolo messaggio utente.
Per impostazione predefinita, il sistema effettuerà una determinazione automatica.		 No
└* rigidità Intero La rigidità configurata del filtro per pertinenza della ricerca.
Maggiore rigidità aumenterà la precisione, ma un richiamo inferiore della risposta.		 No
└top_n_documents Intero Numero configurato di documenti da funzionalità nella query. No
type enum Identificatore di tipo discriminato, che è sempre "azure_cosmos_db".
Valori possibili: azure_cosmos_db		 Sì

AzureCreateChatCompletionRequest

Modello di richiesta estesa per i completamenti della chat rispetto al servizio OpenAI Azure. In questo modo è possibile fornire origini dati per la funzionalità On Your Data .

Name Tipo Description Obbligatorio Predefinito
Audio object Parametri per l'output audio. Obbligatorio quando viene richiesto l'output audio con modalities: ["audio"]. No
└* formato enum Specifica il formato audio di output. Deve essere uno di wav, mp3, flacopus, o pcm16.
Valori possibili: wav, aacmp3, flac, , opuspcm16		 No
└─ voce object No
data_sources array Origini dati da usare per la funzionalità On Your Data, esclusiva per Azure OpenAI. No
penalità_di_frequenza 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 questo momento, riducendo la probabilità che il modello ripeta la stessa riga verbatim. No 0
function_call enum Specificando una funzione specifica tramite {"name": "my_function"} forza il modello a chiamare tale funzione.
Valori possibili: none, auto		 No
functions array Deprecato a favore di tools.

Un elenco di funzioni per cui il modello può generare input JSON.		 No
logit_bias object Modificare la probabilità che i token specificati vengano visualizzati nel completamento.

Accetta un oggetto JSON che esegue il mapping dei token (specificati dal relativo ID token nel tokenizer) a un valore di distorsione associato da -100 a 100. Matematicamente, la distorsione viene aggiunta ai logits generati dal modello prima del campionamento.
L'effetto esatto varia per modello, ma i valori tra -1 e 1 devono diminuire o aumentare la probabilità di selezione; valori come -100 o 100 devono comportare un divieto o una selezione esclusiva del token pertinente.		 No Nessuno
logprobs Boolean Indica se restituire o meno le probabilità di log dei token di output. Se true, restituisce le probabilità di log di ogni token di output restituito in content di message. No Falso
max_completion_tokens Intero 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
numero massimo di token Intero Numero massimo di token che possono essere generati nel completamento della chat.
Questo valore può essere usato per controllare i costi per il testo generato tramite API.

Questo valore è ora deprecato a favore di max_completion_tokense non è compatibile con i modelli di serie o1.		 No
messages array Elenco di messaggi che comprendono la conversazione finora. A seconda del modello usato, sono supportati diversi tipi di messaggio (modalità), ad esempio testo, immagini e audio. Sì
metadata object Set di 16 coppie chiave-valore che possono essere collegate a un oggetto . Ciò può essere utile per archiviare informazioni aggiuntive sull'oggetto in un formato strutturato ed eseguire query sugli oggetti tramite API o il dashboard.

Le chiavi sono stringhe con una lunghezza massima di 64 caratteri. I valori sono stringhe con una lunghezza massima di 512 caratteri.		 No
modalities object Tipi di output che si desidera generare il modello.
La maggior parte dei modelli è in grado di generare testo, ovvero l'impostazione predefinita:

["text"]

Il gpt-4o-audio-preview modello può essere usato anche per generare audio. Per richiedere che questo modello generi risposte sia di testo che audio, è possibile usare:

["text", "audio"]		 No
model corda Identificatore di distribuzione del modello da usare per la richiesta di completamento della chat. Sì
n Intero Quante opzioni di completamento della chat generare per ogni messaggio di input. Si noti 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
chiamate_parallele_agli_strumenti object Indica se abilitare la chiamata di funzioni parallele durante l'uso dello strumento. No
Previsione object Rappresentazione di base dell'output stimato da un modello. No
└─ Tipo OpenAI.ChatOutputPredictionType No
penalità_di_presenza number Numero compreso tra -2,0 e 2,0. I valori positivi penalizzano i nuovi token in base al fatto che vengano visualizzati nel testo fino a questo momento, aumentando la probabilità del modello di parlare di nuovi argomenti. No 0
sforzo di ragionamento object Solo modelli di serie o

Vincola lo sforzo sul ragionamento per i modelli di ragionamento.
I valori attualmente supportati sono low, mediume high. La riduzione del lavoro di ragionamento può comportare risposte più veloci e un minor numero di token usati per il ragionamento in una risposta.		 No
formato_risposta object No
└─ Tipo enum
Valori possibili: text, json_object, json_schema		 No
seed Intero Questa funzionalità è in versione beta.
Se specificato, il sistema eseguirà un'operazione ottimale per campionare in modo deterministico, in modo che le richieste ripetute con gli stessi seed parametri e restituisca lo stesso risultato.
Il determinismo non è garantito ed è necessario fare riferimento al system_fingerprint parametro di risposta per monitorare le modifiche nel back-end.		 No
stop object Non supportato con i modelli o3 di ragionamento più recenti e o4-mini.

Fino a 4 sequenze in cui l'API smetterà di generare altri token. Il testo restituito non conterrà la sequenza di interruzione.		 No
store Boolean Indica se archiviare o meno l'output di questa richiesta di completamento della chat per l'uso nei prodotti di modellazione o di valutazione. No Falso
stream Boolean Se impostato su true, i dati di risposta del modello verranno trasmessi al client durante la generazione tramite eventi inviati dal server. No Falso
stream_options object Opzioni per la risposta in streaming. Impostare questa impostazione solo quando si imposta stream: true. No
└─ uso_includi 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. NOTA: Se il flusso viene interrotto, è possibile che non si riceva il blocco di utilizzo finale che contiene l'utilizzo totale del token per la richiesta.		 No
Temperatura number Temperatura di campionamento da usare, compresa tra 0 e 2. Valori più alti come 0,8 renderanno l'output più casuale, mentre i valori inferiori come 0,2 lo renderanno più incentrato e deterministico.
In genere è consigliabile modificare questa impostazione o top_p non entrambe.		 No 1
tool_choice OpenAI.ChatCompletionToolChoiceOption Controlla quale strumento (se presente) viene chiamato dal modello.
none indica che il modello non chiamerà alcuno strumento e genera invece un messaggio.
auto indica che il modello può scegliere tra la generazione di un messaggio o la chiamata di uno o più strumenti.
required significa che il modello deve chiamare uno o più strumenti.
Specificare uno strumento specifico tramite {"type": "function", "function": {"name": "my_function"}} forza il modello a chiamare tale strumento.

none è l'impostazione predefinita quando non sono presenti strumenti. auto è l'impostazione predefinita se sono presenti strumenti.		 No
Strumenti array Un 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
top_logprobs Intero 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. No
top_p number Un'alternativa al campionamento con temperatura, denominata campionamento del nucleo, in cui il modello considera i risultati dei token con top_p massa di probabilità. Quindi 0,1 significa che vengono considerati solo i token che comprendono i primi 10% massa di probabilità.

In genere è consigliabile modificare questa impostazione o temperature non entrambe.		 No 1
user corda Identificatore univoco che rappresenta l'utente finale, che consente di monitorare e rilevare l'abuso. No
user_security_context AzureUserSecurityContext Il contesto di sicurezza utente contiene diversi parametri che descrivono l'applicazione stessa e l'utente finale che interagisce con l'applicazione. Questi campi aiutano i team delle operazioni di sicurezza a analizzare e mitigare gli eventi imprevisti di sicurezza fornendo un approccio completo alla protezione delle applicazioni di intelligenza artificiale. Altre informazioni sulla protezione delle applicazioni di intelligenza artificiale tramite Microsoft Defender per il cloud. No

AzureCreateChatCompletionResponse

Modello di risposta di completamento della chat di primo livello esteso per il servizio OpenAI Azure. Questo modello aggiunge annotazioni di filtro del contenuto di intelligenza artificiale responsabile per l'input della richiesta.

Name Tipo Description Obbligatorio Predefinito
choices array Sì
creato Intero Timestamp Unix (in secondi) di quando è stato creato il completamento della chat. Sì
id corda Identificatore univoco per il completamento della chat. Sì
model corda Modello usato per il completamento della chat. Sì
object enum Tipo di oggetto, che è sempre chat.completion.
Valori possibili: chat.completion		 Sì
prompt_filter_results array Annotazioni del filtro del contenuto di intelligenza artificiale responsabile associate agli input delle richieste nei completamenti della chat. No
system_fingerprint corda Questa impronta digitale rappresenta la configurazione back-end con cui viene eseguito il modello.

Può essere usato insieme al seed parametro di richiesta per comprendere quando sono state apportate modifiche back-end che potrebbero influire sul determinismo.		 No
uso OpenAI.CompletionUsage Statistiche di utilizzo per la richiesta di completamento. No

AzureCreateChatCompletionStreamResponse

Name Tipo Description Obbligatorio Predefinito
choices array Elenco di scelte di completamento della chat. Può contenere più elementi se n è maggiore di 1. Può anche essere vuoto per l'ultimo blocco se si imposta stream_options: {"include_usage": true}. Sì
content_filter_results AzureContentFilterResultForChoice Risultato di un filtro contenuto per un singolo elemento di risposta prodotto da un sistema di intelligenza artificiale generativo. No
creato Intero Timestamp Unix (in secondi) di quando è stato creato il completamento della chat. Ogni blocco ha lo stesso timestamp. Sì
delta AzureChatCompletionStreamResponseDelta Modello di risposta esteso per un messaggio di risposta di chat in streaming nel servizio OpenAI Azure.
Questo modello aggiunge il supporto per il contesto dei messaggi di chat, usato dalla funzionalità On Your Data per finalità, citazioni e altre informazioni correlate alla generazione aumentata di recupero eseguita.		 No
id corda Identificatore univoco per il completamento della chat. Ogni blocco ha lo stesso ID. Sì
model corda Modello per generare il completamento. Sì
object enum Tipo di oggetto, che è sempre chat.completion.chunk.
Valori possibili: chat.completion.chunk		 Sì
system_fingerprint corda Questa impronta digitale rappresenta la configurazione back-end con cui viene eseguito il modello.
Può essere usato insieme al seed parametro di richiesta per comprendere quando sono state apportate modifiche back-end che potrebbero influire sul determinismo.		 No
uso object Statistiche di utilizzo per la richiesta di completamento. No
└completion_tokens Intero Numero di token nel completamento generato. No 0
└─ dettagli_token_completamento object Suddivisione dei token usati in un completamento. No
└─ token_di_predizione_accettati Intero Quando si usano output stimati, il numero di token nella stima visualizzata nel completamento. No 0
└audio_tokens Intero Token di input audio generati dal modello. No 0
└─ token_di_ragionamento Intero Token generati dal modello per il ragionamento. No 0
└rejected_prediction_tokens Intero Quando si usano output stimati, il numero di token nella stima che non sono stati visualizzati nel completamento. Tuttavia, come i token di ragionamento, questi token vengono ancora conteggiati nei token di completamento totali ai fini della fatturazione, dell'output e dei limiti della finestra di contesto. No 0
└prompt_tokens Intero Numero di token nel prompt. No 0
└prompt_tokens_details object Suddivisione dei token usati nel prompt. No
└audio_tokens Intero Token di input audio presenti nel prompt. No 0
└cached_tokens Intero Token memorizzati nella cache presenti nel prompt. No 0
└total_tokens Intero Numero totale di token usati nella richiesta (richiesta + completamento). No 0

AzureCreateEmbeddingRequest

Name Tipo Description Obbligatorio Predefinito
dimensions Intero Numero di dimensioni che devono essere presenti gli incorporamenti di output risultanti. Supportato solo nei text-embedding-3 modelli e versioni successive. No
encoding_format enum Formato in cui restituire gli incorporamenti. Può essere float o base64.
Valori possibili: float, base64		 No
input stringa o matrice Sì
model corda Modello da usare per la richiesta di incorporamento. Sì
user corda Identificatore univoco che rappresenta l'utente finale, che consente a OpenAI di monitorare e rilevare gli abusi. No

AzureCreateFileRequestMultiPart

Name Tipo Description Obbligatorio Predefinito
scade dopo object Sì
Ancoraggio └* AzureFileExpiryAnchor No
└─ secondi Intero No
file corda Sì
purpose enum Scopo previsto del file caricato. Uno di: - assistants: usato nell'API Assistants - batch: usato nell'API Batch - fine-tune: usato per l'ottimizzazione fine - evals: usato per i set di dati eval.
Valori possibili: assistants, batch, fine-tune, evals		 Sì

AzureCreateImageEditRequestMultiPart

Name Tipo Description Obbligatorio Predefinito
sfondo enum Consente di impostare la trasparenza per lo sfondo delle immagini generate.
Questo parametro è supportato solo per gpt-image-1 i modelli. Deve essere uno di transparento opaqueauto (valore predefinito). Quando auto viene usato, il modello determinerà automaticamente lo sfondo migliore per l'immagine.

Se transparent, il formato di output deve supportare la trasparenza, quindi deve essere impostato su png (valore predefinito) o webp.
Valori possibili: transparent, opaque, auto		 No
immagine stringa o matrice Sì
mask corda No
model corda Distribuzione del modello da usare per l'operazione di modifica dell'immagine. Sì
n Intero Numero di immagini da generare. Deve essere compreso tra 1 e 10. No 1
Compressione dell'output Intero Livello di compressione (0-100%) per le immagini generate. Questo parametro è supportato solo per gpt-image-1i modelli -series con i webp formati di output o jpeg e il valore predefinito è 100. No 100
formato_di_output enum Formato in cui vengono restituite le immagini generate. Questo parametro è supportato solo per gpt-image-1i modelli -series. Deve essere uno di png, jpego webp.
Il valore predefinito è png.
Valori possibili: png, jpeg, webp		 No
prompt corda Descrizione testuale delle immagini desiderate. La lunghezza massima è di 1000 caratteri per dall-e-2i modelli di serie e 32000 caratteri gpt-image-1. Sì
qualità enum Qualità dell'immagine che verrà generata. highe mediumlow sono supportati solo per gpt-image-1i modelli -series. dall-e-2 supporta standard solo la qualità. Il valore predefinito è auto.
Valori possibili: standard, lowmedium, , high,auto		 No
formato_risposta enum Formato in cui vengono restituite le immagini generate. Deve essere uno di url o b64_json. Gli URL sono validi solo per 60 minuti dopo la generazione dell'immagine. Questo parametro è supportato solo per dall-e-2, perché gpt-image-1i modelli -series restituiscono sempre immagini con codifica Base64.
Valori possibili: url, b64_json		 No
size enum Dimensioni delle immagini generate. Deve essere uno di 1024x1024, 1536x1024 (orizzontale), 1024x1536 (verticale) o auto (valore predefinito) per gpt-image-1i modelli -series e uno di 256x256, 512x512o 1024x1024 per dall-e-2.
Valori possibili: 256x256, 512x5121024x1024, 1536x1024, , 1024x1536auto		 No
user corda Identificatore univoco che rappresenta l'utente finale, che consente a OpenAI di monitorare e rilevare gli abusi. No

AzureCreateImageRequest

Name Tipo Description Obbligatorio Predefinito
sfondo enum Consente di impostare la trasparenza per lo sfondo delle immagini generate.
Questo parametro è supportato solo per gpt-image-1 i modelli. Deve essere uno di transparento opaqueauto (valore predefinito). Quando auto viene usato, il modello determinerà automaticamente lo sfondo migliore per l'immagine.

Se transparent, il formato di output deve supportare la trasparenza, quindi deve essere impostato su png (valore predefinito) o webp.
Valori possibili: transparent, opaque, auto		 No
model corda Distribuzione del modello da usare per la generazione di immagini. Sì
Moderazione enum Controllare il livello di moderazione del contenuto per le immagini generate dai gpt-image-1modelli di serie. Deve essere per un low filtro meno restrittivo o auto (valore predefinito).
Valori possibili: low, auto		 No
n Intero Numero di immagini da generare. Deve essere compreso tra 1 e 10. Solo per dall-e-3, n=1 è supportato. No 1
Compressione dell'output Intero Livello di compressione (0-100%) per le immagini generate. Questo parametro è supportato solo per gpt-image-1i modelli -series con i webp formati di output o jpeg e il valore predefinito è 100. No 100
formato_di_output enum Formato in cui vengono restituite le immagini generate. Questo parametro è supportato solo per gpt-image-1i modelli -series. Deve essere uno di png, jpego webp.
Valori possibili: png, jpeg, webp		 No
prompt corda Descrizione testuale delle immagini desiderate. Sì
qualità enum Qualità dell'immagine che verrà generata.

- auto (valore predefinito) selezionerà automaticamente la migliore qualità per il modello specificato.
- highe mediumlow sono supportati per gpt-image-1i modelli -series.
- hd e standard sono supportati per dall-e-3.
- standard è l'unica opzione per dall-e-2.
Valori possibili: standard, hdlow, medium, , highauto		 No
formato_risposta enum Formato in cui vengono restituite le immagini generate con dall-e-2 e dall-e-3 . Deve essere uno di url o b64_json. Gli URL sono validi solo per 60 minuti dopo la generazione dell'immagine. Questo parametro non è supportato per gpt-image-1i modelli di serie che restituiranno sempre immagini con codifica Base64.
Valori possibili: url, b64_json		 No
size enum Dimensioni delle immagini generate. Deve essere uno di 1024x1024, 1536x1024 (orizzontale), (verticale) 1024x1536 o auto (valore predefinito) per gpt-image-1i modelli -series, uno di 256x256, 512x512o 1024x1024 per dall-e-2e uno di 1024x1024, 1792x1024o 1024x1792 per dall-e-3.
Valori possibili: auto, 1024x1024, 1536x10241024x1536, 256x256, 512x512, , 1792x10241024x1792		 No
Stile enum Stile delle immagini generate. Questo parametro è supportato solo per dall-e-3. Deve essere uno di vivid o natural. Vivid fa sì che il modello si appoggi verso la generazione di immagini iper-reali e drammatiche. Naturale fa sì che il modello producano immagini più naturali e meno iper-reali.
Valori possibili: vivid, natural		 No
user corda Identificatore univoco che rappresenta l'utente finale, che consente a OpenAI di monitorare e rilevare gli abusi. No

AzureCreateResponse

Name Tipo Description Obbligatorio Predefinito
sfondo Boolean Indica se eseguire la risposta del modello in background. No Falso
include array Specificare dati di output aggiuntivi da includere nella risposta del modello. I valori attualmente supportati sono:
- code_interpreter_call.outputs: include gli output dell'esecuzione del codice Python negli elementi di chiamata dello strumento dell'interprete del codice.
- computer_call_output.output.image_url: includere gli URL dell'immagine dall'output delle chiamate al computer.
- file_search_call.results: includere i risultati della ricerca della chiamata allo strumento di ricerca file.
- message.input_image.image_url: includere gli URL dell'immagine dal messaggio di input.
- message.output_text.logprobs: includere logprobs con messaggi di assistente.
- reasoning.encrypted_content: include una versione crittografata dei token di ragionamento negli output degli elementi di ragionamento. Ciò consente di usare gli elementi di ragionamento nelle conversazioni a più turni quando si usa l'API Risposte senza stato (ad esempio quando il store parametro è impostato su falseo quando un'organizzazione viene registrata nel programma di conservazione dei dati zero).		 No
input stringa o matrice No
instructions corda Messaggio di sistema (o sviluppatore) inserito nel contesto del modello.

Quando si usa insieme previous_response_ida , le istruzioni di una risposta precedente non verranno trasportate alla risposta successiva. In questo modo è semplice scambiare messaggi di sistema (o sviluppatore) in nuove risposte.		 No
max_output_tokens Intero Limite superiore per il numero di token che possono essere generati per una risposta, inclusi i token di output visibili e i token di ragionamento No
max_tool_calls Intero Numero massimo di chiamate totali agli strumenti predefiniti che possono essere elaborati in una risposta. Questo numero massimo si applica a tutte le chiamate predefinite degli strumenti, non per singolo strumento. Eventuali ulteriori tentativi di chiamare uno strumento dal modello verranno ignorati. No
metadata object Set di 16 coppie chiave-valore che possono essere collegate a un oggetto . Ciò può essere utile per archiviare informazioni aggiuntive sull'oggetto in un formato strutturato ed eseguire query sugli oggetti tramite API o il dashboard.

Le chiavi sono stringhe con una lunghezza massima di 64 caratteri. I valori sono stringhe con una lunghezza massima di 512 caratteri.		 No
model corda Distribuzione del modello da usare per la creazione di questa risposta. Sì
chiamate_parallele_agli_strumenti Boolean Indica se consentire al modello di eseguire chiamate degli strumenti in parallelo. No Vero
previous_response_id corda ID univoco della risposta precedente al modello. Usare questa opzione per creare conversazioni a più turni. No
prompt object Riferimento a un modello di richiesta e alle relative variabili. No
└* id corda Identificatore univoco del modello di richiesta da usare. No
** └─ Variabili OpenAI.ResponsePromptVariables Mapping facoltativo dei valori da sostituire con le variabili nel prompt. I valori di sostituzione possono essere stringhe o altri tipi di input response, ad esempio immagini o file. No
└─ versione corda Versione facoltativa del modello di richiesta. No
reasoning object Solo modelli di serie o

Opzioni di configurazione per i modelli di ragionamento.		 No
└* sforzo Sforzo di Ragionamento OpenAI Solo modelli di serie o

Vincola lo sforzo sul ragionamento per i modelli di ragionamento.
I valori attualmente supportati sono low, mediume high. La riduzione del lavoro di ragionamento può comportare risposte più veloci e un minor numero di token usati per il ragionamento in una risposta.		 No
└─ genera_sommario enum Deprecato: usare summary invece.

Riepilogo del ragionamento eseguito dal modello. Ciò può essere utile per eseguire il debug e comprendere il processo di ragionamento del modello.
Uno di auto, conciseo detailed.
Valori possibili: auto, concise, detailed		 No
└─ Riepilogo enum Riepilogo del ragionamento eseguito dal modello. Ciò può essere utile per eseguire il debug e comprendere il processo di ragionamento del modello.
Uno di auto, conciseo detailed.
Valori possibili: auto, concise, detailed		 No
store Boolean Indica se archiviare la risposta del modello generata per il recupero successivo tramite API. No Vero
stream Boolean Se impostato su true, i dati di risposta del modello verranno trasmessi al client durante la generazione tramite eventi inviati dal server. No Falso
Temperatura number Temperatura di campionamento da usare, compresa tra 0 e 2. Valori più alti come 0,8 renderanno l'output più casuale, mentre i valori inferiori come 0,2 lo renderanno più incentrato e deterministico.
In genere è consigliabile modificare questa impostazione o top_p non entrambe.		 No 1
text object Opzioni di configurazione per una risposta di testo dal modello. Può essere un testo normale o dati JSON strutturati. No
└* formato OpenAI.ResponseTextFormatConfiguration No
tool_choice object Controlla quale strumento (se presente) viene chiamato dal modello.

none indica che il modello non chiamerà alcuno strumento e genera invece un messaggio.

auto indica che il modello può scegliere tra la generazione di un messaggio o la chiamata di uno o più strumenti.

required significa che il modello deve chiamare uno o più strumenti.		 No
└─ Tipo OpenAI.ToolChoiceObjectType Indica che il modello deve usare uno strumento predefinito per generare una risposta. No
Strumenti array Una matrice di strumenti che il modello può chiamare durante la generazione di una risposta. È possibile specificare lo strumento da usare impostando il tool_choice parametro .

Le due categorie di strumenti che è possibile fornire il modello sono:

- Strumenti predefiniti: strumenti forniti da OpenAI che estendono le funzionalità del modello, ad esempio la ricerca di file.
- Chiamate di funzione (strumenti personalizzati): funzioni definite dall'utente, consentendo al modello di chiamare il proprio codice.		 No
top_logprobs Intero 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. No
top_p number Un'alternativa al campionamento con temperatura, denominata campionamento del nucleo, in cui il modello considera i risultati dei token con top_p massa di probabilità. Quindi 0,1 significa che vengono considerati solo i token che comprendono i primi 10% massa di probabilità.

In genere è consigliabile modificare questa impostazione o temperature non entrambe.		 No 1
truncation enum Strategia di troncamento da usare per la risposta del modello.
- auto: se il contesto di questa risposta e quelli precedenti supera le dimensioni della finestra di contesto del modello, il modello tronca la risposta per adattarsi alla finestra di contesto eliminando gli elementi di input al centro della conversazione.
- disabled (impostazione predefinita): se una risposta del modello supererà le dimensioni della finestra di contesto per un modello, la richiesta avrà esito negativo con un errore 400.
Valori possibili: auto, disabled		 No
user corda Identificatore univoco che rappresenta l'utente finale, che consente a OpenAI di monitorare e rilevare gli abusi. No

AzureCreateSpeechRequestMultiPart

Rappresentazione delle opzioni di richiesta che controllano il comportamento di un'operazione di sintesi vocale.

Name Tipo Description Obbligatorio Predefinito
input corda Testo per cui generare l'audio. La lunghezza massima è di 4096 caratteri. Sì
instructions corda Controllare la voce dell'audio generato con istruzioni aggiuntive. Non funziona con tts-1 o tts-1-hd. No
model corda Modello da usare per questa richiesta di sintesi vocale. Sì
formato_risposta object Formati di output audio supportati per la sintesi vocale. No
speed number Velocità del parlato per l'audio generato. I valori sono validi nell'intervallo compreso tra 0,25 e 4.0, con 1.0 i valori predefiniti e superiori corrispondenti alla voce più veloce. No 1
stream_format enum Formato in cui trasmettere l'audio. I formati supportati sono sse e audio. sse non è supportato per tts-1 o tts-1-hd.
Valori possibili: sse, audio		 No
Voce object Sì

AzureCreateTranscriptionRequestMultiPart

Informazioni di configurazione per una richiesta di trascrizione audio.

Name Tipo Description Obbligatorio Predefinito
chunking_strategy object No
└prefix_padding_ms Intero Quantità di audio da includere prima del riconoscimento vocale rilevato da VAD (in millisecondi). No 300
└durata_silenzio_ms Intero Durata del silenzio per rilevare l'arresto vocale (in millisecondi).
Con valori più brevi il modello risponderà più rapidamente, ma può passare a brevi pause dall'utente.		 No 200
└* soglia number Soglia di riservatezza (da 0,0 a 1,0) per il rilevamento delle attività vocali. Una soglia più elevata richiederà un audio più forte per attivare il modello e quindi potrebbe offrire prestazioni migliori in ambienti rumorosi. No 0,5
└─ Tipo enum Deve essere impostato su server_vad per abilitare la suddivisione in blocchi manuale tramite VAD sul lato server.
Valori possibili: server_vad		 No
file corda Sì
filename corda Nome file facoltativo o identificatore descrittivo da associare ai dati audio. No
include[] array Informazioni aggiuntive da includere nella risposta di trascrizione.
logprobs restituirà le probabilità di log dei token nella risposta per comprendere la fiducia del modello nella trascrizione.
logprobs funziona solo con response_format impostato su json e solo con i modelli gpt-4o-transcribe, gpt-4o-transcribe-diarize, gpt-4o-mini-transcribee gpt-4o-mini-transcribe-2025-12-15.		 No
Lingua corda Lingua dell'audio di input. Specificare il linguaggio di input nel formato ISO-639-1 (ad esempio en) migliorerà l'accuratezza e la latenza. No
model corda Modello da usare per questa richiesta di trascrizione. No
prompt corda Testo facoltativo per guidare lo stile del modello o continuare un segmento audio precedente. Il prompt deve corrispondere alla lingua audio. No
formato_risposta object No
stream Boolean Se impostato su true, i dati di risposta del modello verranno trasmessi al client durante la generazione tramite eventi inviati dal server. Nota: lo streaming non è supportato per il whisper-1 modello e verrà ignorato. No Falso
Temperatura number Temperatura di campionamento, compresa tra 0 e 1. Valori più alti come 0,8 renderanno l'output più casuale, mentre i valori inferiori come 0,2 lo renderanno più incentrato e deterministico. Se impostato su 0, il modello userà la probabilità di log per aumentare automaticamente la temperatura fino a raggiungere determinate soglie. No 0
timestamp_granularities[] array Granularità del timestamp da popolare per questa trascrizione. response_format deve essere impostato verbose_json per usare le granularità del timestamp. Sono supportate entrambe o entrambe le opzioni seguenti: wordo segment. Nota: non esiste una latenza aggiuntiva per i timestamp dei segmenti, ma la generazione di timestamp delle parole comporta una latenza aggiuntiva. No ['segment']

AzureCreateTranslationRequestMultiPart

Informazioni di configurazione per una richiesta di trascrizione audio.

Name Tipo Description Obbligatorio Predefinito
file corda Sì
filename corda Nome file facoltativo o identificatore descrittivo da associare ai dati audio No
model corda Modello da utilizzare per questa richiesta di traduzione. No
prompt corda Testo facoltativo per guidare lo stile del modello o continuare un segmento audio precedente. Il prompt deve essere in inglese. No
formato_risposta object No
Temperatura number Temperatura di campionamento, compresa tra 0 e 1. Valori più alti come 0,8 renderanno l'output più casuale, mentre i valori inferiori come 0,2 lo renderanno più incentrato e deterministico. Se impostato su 0, il modello userà la probabilità di log per aumentare automaticamente la temperatura fino a raggiungere determinate soglie. No 0

AzureErrorResponse

Name Tipo Description Obbligatorio Predefinito
Errore object Dettagli dell'errore. No
└─ codice corda Identificatore distinto generato dal computer per l'errore. No
└─ errore_interno No
└* messaggio corda Messaggio leggibile associato all'errore. No
└* param corda Se applicabile, il parametro di input della richiesta associato all'errore No
└─ Tipo enum Tipo di oggetto, sempre 'error'.
Valori possibili: error		 No

AzureEvalAPICompletionsSamplingParams

Name Tipo Description Obbligatorio Predefinito
chiamate_parallele_agli_strumenti Boolean No
formato_risposta OpenAI.ResponseTextFormatConfiguration No
Strumenti array No

AzureEvalAPIModelSamplingParams

Name Tipo Description Obbligatorio Predefinito
numero massimo di token Intero Numero massimo di token nell'output generato. No
sforzo di ragionamento enum Controlla il livello di sforzo di ragionamento applicato durante la generazione.
Valori possibili: low, medium, high		 No
seed Intero Valore di inizializzazione per inizializzare la casualità durante il campionamento. No
Temperatura number Una temperatura più elevata aumenta la casualità negli output. No
top_p number Un'alternativa alla temperatura per il campionamento del nucleo; 1.0 include tutti i token. No

AzureEvalAPIResponseSamplingParams

Name Tipo Description Obbligatorio Predefinito
chiamate_parallele_agli_strumenti Boolean No
formato_risposta OpenAI.ResponseTextFormatConfiguration No
Strumenti array No

AzureFileExpiryAnchor

Proprietà Value
Type corda
Valori created_at

AzureFineTuneReinforcementMethod

Name Tipo Description Obbligatorio Predefinito
Selezionatore object Oggetto StringCheckGrader che esegue un confronto di stringhe tra input e riferimento usando un'operazione specificata. Sì
└' calculate_output corda Formula per calcolare l'output in base ai risultati del grader. No
└' evaluation_metric enum Metrica di valutazione da usare. Uno di fuzzy_match, bleugleu, meteor, rouge_1, rouge_2, rouge_3, rouge_4, , rouge_5o rouge_l.
Valori possibili: fuzzy_match, bleu, gleumeteor, rouge_1, rouge_2, rouge_3, rouge_4, rouge_5rouge_l		 No
└️ voti object No
└ Input array Testo di input. Ciò può includere stringhe di modello. No
└─ Modello corda Modello da utilizzare per la valutazione. No
└> nome corda Nome del grader. No
└─ Operazione enum Operazione di controllo della stringa da eseguire. Uno di eq, ne, likeo ilike.
Valori possibili: eq, ne, like, ilike		 No
└* intervallo array Intervallo del punteggio. Il valore predefinito è [0, 1]. No
Riferimento corda Testo a cui viene eseguito il voto. No
└sampling_params Parametri di campionamento per il modello. No
└─ Tipo enum Tipo di oggetto, che è sempre multi.
Valori possibili: multi		 No
iperparametri OpenAI.FineTuneReinforcementHyperparameters Iperparametri usati per il processo di ottimizzazione dell'ottimizzazione per rinforzo. No
formato_risposta object No
└ json_schema object Schema JSON per il formato di risposta No
└─ Tipo enum Tipo di formato di risposta.
Valori possibili: json_schema		 No

AzureImage

Name Tipo Description Obbligatorio Predefinito
b64_json corda JSON con codifica base64 dell'immagine generata. Valore predefinito per gpt-image-1i modelli -series e presente solo se response_format è impostato su b64_json per dall-e-2 e dall-e-3. No
content_filter_results AzureContentFilterImageResponseResults Risultato di un filtro contenuto per il contenuto della risposta di output di un'operazione di generazione di immagini. Sì
prompt_filter_results AzureContentFilterImagePromptResults Risultato di un filtro contenuto per il contenuto della richiesta di input di un'operazione di generazione di immagini. Sì
testo_rivisto corda Solo dall-e-3 il prompt modificato usato per generare l'immagine. No
Url corda Quando si usa dall-e-2 o dall-e-3, l'URL dell'immagine generata se response_format è impostato su url (valore predefinito). Non supportato per gpt-image-1i modelli -series. No

AzureImagesResponse

Name Tipo Description Obbligatorio Predefinito
sfondo enum Solo GPT-image-1: parametro di sfondo usato per la generazione dell'immagine. transparentO opaque .
Valori possibili: transparent, opaque		 No
creato Intero Timestamp Unix (in secondi) di quando è stata creata l'immagine. Sì
Dati array No
formato_di_output enum Formato di output della generazione dell'immagine. , pngwebpo jpeg.
Valori possibili: png, webp, jpeg		 No
qualità enum Qualità dell'immagine generata. , lowmediumo high.
Valori possibili: low, medium, high		 No
size enum Dimensioni dell'immagine generata. , 1024x10241024x1536o 1536x1024.
Valori possibili: 1024x1024, 1024x1536, 1536x1024		 No
uso object Solo per gpt-image-1i modelli -series, le informazioni sull'utilizzo del token per la generazione dell'immagine. No
└ input_tokens Intero Numero di token (immagini e testo) nel prompt di input. No
└input_tokens_details object I token di input contengono informazioni dettagliate per la generazione di immagini. No
└ image_tokens Intero Numero di token di immagine nel prompt di input. No
└ text_tokens Intero Numero di token di testo nel prompt di input. No
└output_tokens Intero Numero di token di immagine nell'immagine di output. No
└total_tokens Intero Numero totale di token (immagini e testo) usati per la generazione di immagini. No

AzureListFilesResponse

Name Tipo Description Obbligatorio Predefinito
Dati array Sì
first_id corda Sì
ha_di_piu Boolean Sì
last_id corda Sì
object enum
Valori possibili: list		 Sì

AzureOpenAIFile

Name Tipo Description Obbligatorio Predefinito
bytes Intero Dimensioni del file, in byte. Sì
creato_il Intero Timestamp Unix (in secondi) per il momento in cui è stato creato il file. Sì
scade_il Intero Timestamp Unix (in secondi) per la scadenza del file. No
filename corda Nome del file. Sì
id corda Identificatore di file a cui è possibile fare riferimento negli endpoint API. Sì
object enum Tipo di oggetto, che è sempre file.
Valori possibili: file		 Sì
purpose enum Scopo previsto del file. I valori supportati sono assistants, assistants_output, batchbatch_output, fine-tune e fine-tune-results.
Valori possibili: assistants, assistants_output, batchbatch_output, fine-tune, , fine-tune-resultsevals		 Sì
stato enum
Valori possibili: uploaded, pending, runningprocessed, error, , deletingdeleted		 Sì
dettagli dello stato corda Deprecated. Per informazioni dettagliate sul motivo per cui una convalida del file di training di ottimizzazione non è riuscita, vedere il error campo in fine_tuning.job. No

AzureOpenAIVideoGenerationErrorResponse

Name Tipo Description Obbligatorio Predefinito
codice corda Identificatore distinto generato dal computer per l'errore. No
inner_error object Se applicabile, un errore upstream che ha generato questo errore. No
└─ codice enum Codice associato all'errore interno.
Valori possibili: ResponsibleAIPolicyViolation		 No
└─ dettagli_errore Dettagli del risultato del filtro contenuto associati all'errore interno. No
└ revised_prompt corda Se applicabile, il prompt modificato usato per la generazione. No
message corda Messaggio leggibile associato all'errore. No
param corda Se applicabile, il parametro di input della richiesta associato all'errore No
type corda Se applicabile, il numero di riga di input associato all'errore. No

AzureResponse

Name Tipo Description Obbligatorio Predefinito
sfondo Boolean Indica se eseguire la risposta del modello in background. No Falso
creato_il Intero Timestamp Unix (in secondi) di quando è stata creata questa risposta. Sì
Errore object Oggetto di errore restituito quando il modello non riesce a generare una risposta. Sì
└─ codice OpenAI.ResponseErrorCode Codice di errore per la risposta. No
└* messaggio corda Descrizione leggibile dell'errore. No
id corda Identificatore univoco per questa risposta. Sì
incomplete_details object Informazioni dettagliate sul motivo per cui la risposta è incompleta. Sì
└* motivo enum Motivo per cui la risposta è incompleta.
Valori possibili: max_output_tokens, content_filter		 No
instructions stringa o matrice Sì
max_output_tokens Intero Limite superiore per il numero di token che possono essere generati per una risposta, inclusi i token di output visibili e i token di ragionamento No
max_tool_calls Intero Numero massimo di chiamate totali agli strumenti predefiniti che possono essere elaborati in una risposta. Questo numero massimo si applica a tutte le chiamate predefinite degli strumenti, non per singolo strumento. Eventuali ulteriori tentativi di chiamare uno strumento dal modello verranno ignorati. No
metadata object Set di 16 coppie chiave-valore che possono essere collegate a un oggetto . Ciò può essere utile per archiviare informazioni aggiuntive sull'oggetto in un formato strutturato ed eseguire query sugli oggetti tramite API o il dashboard.

Le chiavi sono stringhe con una lunghezza massima di 64 caratteri. I valori sono stringhe con una lunghezza massima di 512 caratteri.		 Sì
model corda Modello usato per generare questa risposta. Sì
object enum Tipo di oggetto di questa risorsa: sempre impostato su response.
Valori possibili: response		 Sì
output array Matrice di elementi di contenuto generati dal modello.

- La lunghezza e l'ordine degli elementi nella output matrice dipendono dalla risposta del modello.
- Anziché accedere al primo elemento nella output matrice e presupponendo che si tratti di un assistant messaggio con il contenuto generato dal modello, è consigliabile usare la output_text proprietà in cui è supportato negli SDK.		 Sì
output_text corda Proprietà utile solo SDK che contiene l'output di testo aggregato di tutti gli output_text elementi della output matrice, se presenti.
Supportato negli SDK Python e JavaScript.		 No
chiamate_parallele_agli_strumenti Boolean Indica se consentire al modello di eseguire chiamate degli strumenti in parallelo. Sì Vero
previous_response_id corda ID univoco della risposta precedente al modello. Usare questa opzione per creare conversazioni a più turni. No
prompt object Riferimento a un modello di richiesta e alle relative variabili. No
└* id corda Identificatore univoco del modello di richiesta da usare. No
** └─ Variabili OpenAI.ResponsePromptVariables Mapping facoltativo dei valori da sostituire con le variabili nel prompt. I valori di sostituzione possono essere stringhe o altri tipi di input response, ad esempio immagini o file. No
└─ versione corda Versione facoltativa del modello di richiesta. No
reasoning object Solo modelli di serie o

Opzioni di configurazione per i modelli di ragionamento.		 No
└* sforzo Sforzo di Ragionamento OpenAI Solo modelli di serie o

Vincola lo sforzo sul ragionamento per i modelli di ragionamento.
I valori attualmente supportati sono low, mediume high. La riduzione del lavoro di ragionamento può comportare risposte più veloci e un minor numero di token usati per il ragionamento in una risposta.		 No
└─ genera_sommario enum Deprecato: usare summary invece.

Riepilogo del ragionamento eseguito dal modello. Ciò può essere utile per eseguire il debug e comprendere il processo di ragionamento del modello.
Uno di auto, conciseo detailed.
Valori possibili: auto, concise, detailed		 No
└─ Riepilogo enum Riepilogo del ragionamento eseguito dal modello. Ciò può essere utile per eseguire il debug e comprendere il processo di ragionamento del modello.
Uno di auto, conciseo detailed.
Valori possibili: auto, concise, detailed		 No
stato enum Stato della generazione della risposta. Uno di completed, failed, in_progresscancelled, queued, o incomplete.
Valori possibili: completed, failedin_progress, cancelled, , queuedincomplete		 No
Temperatura number Temperatura di campionamento da usare, compresa tra 0 e 2. Valori più alti come 0,8 renderanno l'output più casuale, mentre i valori inferiori come 0,2 lo renderanno più incentrato e deterministico.
In genere è consigliabile modificare questa impostazione o top_p non entrambe.		 Sì
text object Opzioni di configurazione per una risposta di testo dal modello. Può essere un testo normale o dati JSON strutturati. No
└* formato OpenAI.ResponseTextFormatConfiguration No
tool_choice object Controlla quale strumento (se presente) viene chiamato dal modello.

none indica che il modello non chiamerà alcuno strumento e genera invece un messaggio.

auto indica che il modello può scegliere tra la generazione di un messaggio o la chiamata di uno o più strumenti.

required significa che il modello deve chiamare uno o più strumenti.		 No
└─ Tipo OpenAI.ToolChoiceObjectType Indica che il modello deve usare uno strumento predefinito per generare una risposta. No
Strumenti array Una matrice di strumenti che il modello può chiamare durante la generazione di una risposta. È possibile specificare lo strumento da usare impostando il tool_choice parametro .

Le due categorie di strumenti che è possibile fornire il modello sono:

- Strumenti predefiniti: strumenti forniti da OpenAI che estendono le funzionalità del modello.		 No
top_logprobs Intero 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. No
top_p number Un'alternativa al campionamento con temperatura, denominata campionamento del nucleo, in cui il modello considera i risultati dei token con top_p massa di probabilità. Quindi 0,1 significa che vengono considerati solo i token che comprendono i primi 10% massa di probabilità.

In genere è consigliabile modificare questa impostazione o temperature non entrambe.		 Sì
truncation enum Strategia di troncamento da usare per la risposta del modello.
- auto: se il contesto di questa risposta e quelli precedenti supera le dimensioni della finestra di contesto del modello, il modello tronca la risposta per adattarsi alla finestra di contesto eliminando gli elementi di input al centro della conversazione.
- disabled (impostazione predefinita): se una risposta del modello supererà le dimensioni della finestra di contesto per un modello, la richiesta avrà esito negativo con un errore 400.
Valori possibili: auto, disabled		 No
uso OpenAI.ResponseUsage Rappresenta i dettagli di utilizzo dei token, inclusi i token di input, i token di output, la suddivisione dei token di output e i token totali usati. No
user corda Identificatore univoco che rappresenta l'utente finale, che consente a OpenAI di monitorare e rilevare gli abusi. Sì

AzureSearchChatDataSource

Rappresenta una configurazione dell'origine dati che userà una risorsa di ricerca Azure.

Name Tipo Description Obbligatorio Predefinito
parameters object Informazioni sui parametri per controllare l'uso dell'origine dati di ricerca Azure. Sì
└─ consenti_risultato_parziale Boolean Se impostato su true, il sistema consentirà l'uso di risultati parziali della ricerca e la richiesta avrà esito negativo se tutte le query parziali hanno esito negativo. Se non specificato o specificato come false, la richiesta avrà esito negativo se una query di ricerca ha esito negativo. No Falso
Autenticazione object No
└access_token corda No
└─ tasto corda No
└managed_identity_resource_id corda No
└─ Tipo enum
Valori possibili: access_token		 No
└─ dipendenza_embedded object Rappresenta un'origine di vettorizzazione che effettua chiamate al servizio pubblico su una distribuzione del modello di incorporamento OpenAI Azure. No
Autenticazione AzureChatDataSourceApiKeyAuthenticationOptions o AzureChatDataSourceAccessTokenAuthenticationOptions Meccanismo di autenticazione da usare con l'origine vettorializzazione basata su endpoint.
L'autenticazione degli endpoint supporta meccanismi di chiave API e token di accesso.		 No
└─ nome_distribuzione corda Distribuzione del modello di incorporamento da usare per la vettorializzazione. Questa distribuzione deve esistere all'interno della stessa risorsa OpenAI Azure della distribuzione del modello usata per i completamenti della chat. No
└─ dimensioni Intero Numero di dimensioni da richiedere per gli incorporamenti.
Supportato solo nei modelli "text-embedding-3" e versioni successive.		 No
Endpoint └* corda Specifica l'URL dell'endpoint della risorsa da cui recuperare gli incorporamenti.
Deve essere nel formato di:
https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/embeddings.
Il parametro di query api-version non è consentito.		 No
└─ Tipo enum Identificatore del tipo, sempre "integrato" per questo tipo di origine di vettorizzazione.
Valori possibili: integrated		 No
Endpoint └* corda Percorso endpoint assoluto da usare per la risorsa di ricerca Azure. No
└ fields_mapping object Mapping dei campi da usare con la risorsa di ricerca Azure. No
└content_fields array Nomi dei campi di indice che devono essere considerati come contenuto. No
└─content_fields_separator corda Modello separatore che i campi di contenuto devono usare. No
└filepath_field corda Nome del campo di indice da utilizzare come percorso file. No
└─ campi_di_vettore_immagine array Nomi di campi che rappresentano i dati del vettore di immagine. No
└─ campo_titolo corda Nome del campo di indice da utilizzare come titolo. No
└url_field corda Nome del campo di indice da usare come URL. No
└vector_fields array Nomi dei campi che rappresentano i dati vettoriali. No
└─ Filtro corda Filtro da applicare alla ricerca. No
└ in_scope Boolean Indica se le query devono essere limitate all'uso dei dati indicizzati. No
└include_contexts array Proprietà del contesto di output da includere nella risposta.
Per impostazione predefinita, verranno richieste citazioni e finalità.		 No ['citazioni', 'intento']
└ index_name corda Nome dell'indice da usare, come specificato nella risorsa di ricerca Azure. No
└max_search_queries Intero Numero massimo di query riscritte che devono essere inviate al provider di ricerca per un singolo messaggio utente.
Per impostazione predefinita, il sistema effettuerà una determinazione automatica.		 No
└query_type enum Tipo di query da usare per la risorsa di ricerca Azure.
Valori possibili: simple, semanticvector, , vector_simple_hybrid,vector_semantic_hybrid		 No
└─ configurazione_semantica corda Configurazione semantica aggiuntiva per la query. No
└* rigidità Intero La rigidità configurata del filtro per pertinenza della ricerca.
Maggiore rigidità aumenterà la precisione, ma un richiamo inferiore della risposta.		 No
└top_n_documents Intero Numero configurato di documenti da funzionalità nella query. No
type enum Identificatore di tipo discriminato, che è sempre "azure_search".
Valori possibili: azure_search		 Sì

AzureUserSecurityContext

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

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

ChatCompletionMessageToolCallsItem

Lo strumento chiama generato dal modello, ad esempio le chiamate di funzione.

Matrice di: OpenAI.ChatCompletionMessageToolCall

CreateVideoGenerationRequest

Name Tipo Description Obbligatorio Predefinito
height Intero Altezza del video. Sono supportate le dimensioni seguenti: 480x480, 854x480, 720x720, 1280x720, 1080x1080 e 1920x1080 sia in orientamento orizzontale che verticale. Sì
model corda Nome della distribuzione da usare per questa richiesta. Sì
n_seconds Intero Durata del processo di generazione video. Deve essere compreso tra 1 e 20 secondi. No 5
n_variants Intero Numero di video da creare come varianti per questo processo. Deve essere compreso tra 1 e 5. Le dimensioni più piccole consentono più varianti. No 1
prompt corda Richiesta di questo processo di generazione video. Sì
width Intero Larghezza del video. Sono supportate le dimensioni seguenti: 480x480, 854x480, 720x720, 1280x720, 1080x1080 e 1920x1080 sia in orientamento orizzontale che verticale. Sì

CreateVideoGenerationWithMediaRequestMultiPart

Proprietà di una richiesta di processo di generazione video con file multimediali.

Name Tipo Description Obbligatorio Predefinito
File array Sì
height Intero Altezza del video. Sono supportate le dimensioni seguenti: 480x480, 854x480, 720x720, 1280x720, 1080x1080 e 1920x1080 sia in orientamento orizzontale che verticale. Sì
inpaint_items array Elementi facoltativi per questo processo di generazione di video. No
model corda Nome della distribuzione da usare per questa richiesta. Sì
n_seconds Intero Durata del processo di generazione video. Deve essere compreso tra 1 e 20 secondi. No 5
n_variants Intero Numero di video da creare come varianti per questo processo. Deve essere compreso tra 1 e 5. Le dimensioni più piccole consentono più varianti. No 1
prompt corda Richiesta di questo processo di generazione video. Sì
width Intero Larghezza del video. Sono supportate le dimensioni seguenti: 480x480, 854x480, 720x720, 1280x720, 1080x1080 e 1920x1080 sia in orientamento orizzontale che verticale. Sì

CropBounds

Limiti di ritaglio per un elemento di inpainting. Specifica l'area dell'elemento multimediale da utilizzare per l'inpainting.

Name Tipo Description Obbligatorio Predefinito
bottom_fraction number Limite inferiore della casella di ritaglio specificata come frazione dell'altezza dell'elemento multimediale originale. Deve essere compreso tra 0,0 e 1,0. Usare ad esempio 0,5 per metà dell'altezza dell'elemento multimediale originale. No 1
left_fraction number Limite sinistro della casella di ritaglio specificata come frazione della larghezza dell'elemento multimediale originale. Deve essere compreso tra 0,0 e 1,0. Usa ad esempio 0,5 per metà della larghezza dell'elemento multimediale originale. No 0
right_fraction number Limite destro della casella di ritaglio specificata come frazione della larghezza dell'elemento multimediale originale. Deve essere compreso tra 0,0 e 1,0. Usa ad esempio 0,5 per metà della larghezza dell'elemento multimediale originale. No 1
top_fraction number Limite superiore della casella di ritaglio specificata come frazione dell'altezza dell'elemento multimediale originale. Deve essere compreso tra 0,0 e 1,0. Usare ad esempio 0,5 per metà dell'altezza dell'elemento multimediale originale. No 0

ElasticsearchChatDataSource

Name Tipo Description Obbligatorio Predefinito
parameters object Informazioni sui parametri per controllare l'uso dell'origine dati Elasticsearch. Sì
└─ consenti_risultato_parziale Boolean Se impostato su true, il sistema consentirà l'uso di risultati parziali della ricerca e la richiesta avrà esito negativo se tutte le query parziali hanno esito negativo. Se non specificato o specificato come false, la richiesta avrà esito negativo se una query di ricerca ha esito negativo. No Falso
Autenticazione object No
└─ chiave_api_cifrata corda No
└─ tasto corda No
└─key_id corda No
└─ Tipo enum
Valori possibili: encoded_api_key		 No
└─ dipendenza_embedded AzureChatDataSourceVectorizationSource Rappresentazione di un'origine di vettorizzazione dei dati utilizzabile come risorsa di incorporamento con un'origine dati. No
Endpoint └* corda No
└ fields_mapping object No
└content_fields array No
└─content_fields_separator corda No
└filepath_field corda No
└─ campo_titolo corda No
└url_field corda No
└vector_fields array No
└ in_scope Boolean Indica se le query devono essere limitate all'uso dei dati indicizzati. No
└include_contexts array Proprietà del contesto di output da includere nella risposta.
Per impostazione predefinita, verranno richieste citazioni e finalità.		 No ['citazioni', 'intento']
└ index_name corda No
└max_search_queries Intero Numero massimo di query riscritte che devono essere inviate al provider di ricerca per un singolo messaggio utente.
Per impostazione predefinita, il sistema effettuerà una determinazione automatica.		 No
└query_type enum
Valori possibili: simple, vector		 No
└* rigidità Intero La rigidità configurata del filtro per pertinenza della ricerca.
Maggiore rigidità aumenterà la precisione, ma un richiamo inferiore della risposta.		 No
└top_n_documents Intero Numero configurato di documenti da funzionalità nella query. No
type enum Identificatore di tipo discriminato, che è sempre "elasticsearch".
Valori possibili: elasticsearch		 Sì

InpaintItem

Elemento di inpainting per un processo di generazione di video. Specifica l'elemento multimediale che deve essere usato per l'inserimento nella generazione di video.

Name Tipo Description Obbligatorio Predefinito
crop_bounds object Limiti di ritaglio per un elemento di inpainting.
Specifica l'area dell'elemento multimediale da utilizzare per l'inpainting.		 No
└bottom_fraction number Limite inferiore della casella di ritaglio specificata come frazione dell'altezza dell'elemento multimediale originale. Deve essere compreso tra 0,0 e 1,0. Usare ad esempio 0,5 per metà dell'altezza dell'elemento multimediale originale. No 1
└left_fraction number Limite sinistro della casella di ritaglio specificata come frazione della larghezza dell'elemento multimediale originale. Deve essere compreso tra 0,0 e 1,0. Usa ad esempio 0,5 per metà della larghezza dell'elemento multimediale originale. No 0
└right_fraction number Limite destro della casella di ritaglio specificata come frazione della larghezza dell'elemento multimediale originale. Deve essere compreso tra 0,0 e 1,0. Usa ad esempio 0,5 per metà della larghezza dell'elemento multimediale originale. No 1
└top_fraction number Limite superiore della casella di ritaglio specificata come frazione dell'altezza dell'elemento multimediale originale. Deve essere compreso tra 0,0 e 1,0. Usare ad esempio 0,5 per metà dell'altezza dell'elemento multimediale originale. No 0
file_name corda Nome file dell'elemento multimediale. Deve corrispondere al nome file di un allegato di file in questa richiesta. Sì
frame_index Intero Indice dei fotogrammi per questo elemento multimediale. Specifica il fotogramma iniziale nel video generato risultante per questo elemento di inpainting. Sì 0
type object Tipo dell'elemento di inpainting. Sì

JobStatus

Stato di un processo di generazione di video.

Proprietà Value
Descrizione Stato di un processo di generazione di video.
Type corda
Valori preprocessing
queued
running
processing
cancelled
succeeded
failed

MediaItemType

Tipo dell'elemento di inpainting.

Proprietà Value
Descrizione Tipo dell'elemento di inpainting.
Type corda
Valori image

MongoDBChatDataSource

Name Tipo Description Obbligatorio Predefinito
parameters object Informazioni sui parametri per controllare l'uso dell'origine dati MongoDB. Sì
└─ consenti_risultato_parziale Boolean Se impostato su true, il sistema consentirà l'uso di risultati parziali della ricerca e la richiesta avrà esito negativo se tutte le query parziali hanno esito negativo. Se non specificato o specificato come false, la richiesta avrà esito negativo se una query di ricerca ha esito negativo. No Falso
└ app_name corda Nome dell'applicazione MongoDB. No
Autenticazione object No
└ password corda No
└─ Tipo enum
Valori possibili: username_and_password		 No
└\ nome utente corda No
└collection_name corda Nome della raccolta MongoDB. No
└─database_name corda Nome del database MongoDB. No
└─ dipendenza_embedded object Rappresenta un'origine di vettorizzazione che effettua chiamate al servizio pubblico su una distribuzione del modello di incorporamento OpenAI Azure. No
Autenticazione AzureChatDataSourceApiKeyAuthenticationOptions o AzureChatDataSourceAccessTokenAuthenticationOptions Meccanismo di autenticazione da usare con l'origine vettorializzazione basata su endpoint.
L'autenticazione degli endpoint supporta meccanismi di chiave API e token di accesso.		 No
└─ nome_distribuzione corda Distribuzione del modello di incorporamento da usare per la vettorializzazione. Questa distribuzione deve esistere all'interno della stessa risorsa OpenAI Azure della distribuzione del modello usata per i completamenti della chat. No
└─ dimensioni Intero Numero di dimensioni da richiedere per gli incorporamenti.
Supportato solo nei modelli "text-embedding-3" e versioni successive.		 No
Endpoint └* corda Specifica l'URL dell'endpoint della risorsa da cui recuperare gli incorporamenti.
Deve essere nel formato di:
https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/embeddings.
Il parametro di query api-version non è consentito.		 No
└─ Tipo enum Identificatore del tipo, sempre "deployment_name" per questo tipo di origine di vettorizzazione.
Valori possibili: deployment_name		 No
Endpoint └* corda Nome dell'endpoint del cluster MongoDB. No
└ fields_mapping object Mapping dei campi da applicare ai dati usati dall'origine dati MongoDB.
Si noti che i mapping del contenuto e dei campi vettoriali sono necessari per MongoDB.		 No
└content_fields array No
└─content_fields_separator corda No
└filepath_field corda No
└─ campo_titolo corda No
└url_field corda No
└vector_fields array No
└ in_scope Boolean Indica se le query devono essere limitate all'uso dei dati indicizzati. No
└include_contexts array Proprietà del contesto di output da includere nella risposta.
Per impostazione predefinita, verranno richieste citazioni e finalità.		 No ['citazioni', 'intento']
└ index_name corda Nome dell'indice MongoDB. No
└max_search_queries Intero Numero massimo di query riscritte che devono essere inviate al provider di ricerca per un singolo messaggio utente.
Per impostazione predefinita, il sistema effettuerà una determinazione automatica.		 No
└* rigidità Intero La rigidità configurata del filtro per pertinenza della ricerca.
Maggiore rigidità aumenterà la precisione, ma un richiamo inferiore della risposta.		 No
└top_n_documents Intero Numero configurato di documenti da funzionalità nella query. No
type enum Identificatore di tipo discriminato, che è sempre "mongo_db".
Valori possibili: mongo_db		 Sì

OpenAI.Annotation

Discriminare per OpenAI.Annotation

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

Valore del tipo Schema
file_citation OpenAI.AnnotationFileCitation
url_citation OpenAI.AnnotationUrlCitation
file_path OpenAI.AnnotationFilePath
Name Tipo Description Obbligatorio Predefinito
type OpenAI.AnnotationType Sì

OpenAI.AnnotationFileCitation

Citazione in un file.

Name Tipo Description Obbligatorio Predefinito
ID del file corda ID del file. Sì
filename corda Nome file del file citato. Sì
index Intero Indice del file nell'elenco di file. Sì
type enum Tipo di citazione del file. Sempre file_citation.
Valori possibili: file_citation		 Sì

OpenAI.AnnotationFilePath

Percorso di un file.

Name Tipo Description Obbligatorio Predefinito
ID del file corda ID del file. Sì
index Intero Indice del file nell'elenco di file. Sì
type enum Tipo del percorso del file. Sempre file_path.
Valori possibili: file_path		 Sì

OpenAI.AnnotationType

Proprietà Value
Type corda
Valori file_citation
url_citation
file_path
container_file_citation

OpenAI.AnnotationUrlCitation

Citazione per una risorsa Web usata per generare una risposta del modello.

Name Tipo Description Obbligatorio Predefinito
end_index Intero Indice dell'ultimo carattere della citazione URL nel messaggio. Sì
start_index Intero Indice del primo carattere della citazione URL nel messaggio. Sì
Titolo corda Titolo della risorsa Web. Sì
type enum Tipo di citazione URL. Sempre url_citation.
Valori possibili: url_citation		 Sì
Url corda URL della risorsa Web. Sì

OpenAI.PosizioneApprossimativa

Name Tipo Description Obbligatorio Predefinito
city corda No
paese corda No
region corda No
timezone corda No
type enum
Valori possibili: approximate		 Sì

OpenAI.AudioResponseFormat

Formato dell'output, in una delle opzioni seguenti: json, text, srt, verbose_jsono vtt. Per gpt-4o-transcribe, gpt-4o-transcribe-diarize, gpt-4o-mini-transcribee gpt-4o-mini-transcribe-2025-12-15. L'unico formato supportato è json.

Proprietà Value
Descrizione Formato dell'output, in una delle opzioni seguenti: json, text, srt, verbose_jsono vtt. Per gpt-4o-transcribe, gpt-4o-transcribe-diarize, gpt-4o-mini-transcribee gpt-4o-mini-transcribe-2025-12-15. L'unico formato supportato è json.
Type corda
Valori json
text
srt
verbose_json
vtt

OpenAI.AutoChunkingStrategyRequestParam

Strategia predefinita. Questa strategia usa attualmente un max_chunk_size_tokens oggetto di 800 e chunk_overlap_tokens di 400.

Name Tipo Description Obbligatorio Predefinito
type enum Sempre auto.
Valori possibili: auto		 Sì

OpenAI.ChatCompletionFunctionCallOption

Specificando una funzione specifica tramite {"name": "my_function"} forza il modello a chiamare tale funzione.

Name Tipo Description Obbligatorio Predefinito
name corda Nome della funzione da chiamare. Sì

OpenAI.ChatCompletionFunctions

Name Tipo Description Obbligatorio Predefinito
description corda Descrizione delle operazioni della funzione, usate dal modello per scegliere quando e come chiamare la funzione. No
name corda Nome della funzione da chiamare. Deve essere a-z, A-Z, 0-9 o contenere caratteri di sottolineatura e trattini, con una lunghezza massima di 64. Sì
parameters I parametri accettati dalle funzioni, descritti come oggetto Schema JSON.
Vedere le informazioni di riferimento sullo schema JSON per la documentazione sul formato.

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

OpenAI.ChatCompletionMessageAudioChunk

Name Tipo Description Obbligatorio Predefinito
Dati corda No
scade_il Intero No
id corda No
Trascrizione corda No

OpenAI.ChatCompletionMessageToolCall

Name Tipo Description Obbligatorio Predefinito
funzione object Funzione chiamata dal modello. Sì
└─ Argomenti corda 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ò allucinare i parametri non definiti dallo schema della funzione. Convalidare gli argomenti nel codice prima di chiamare la funzione. No
└> nome corda Nome della funzione da chiamare. No
id corda ID della chiamata allo strumento. Sì
type enum Tipo dello strumento. Attualmente è supportato solo function .
Valori possibili: function		 Sì

OpenAI.ChatCompletionMessageToolCallChunk

Name Tipo Description Obbligatorio Predefinito
funzione object No
└─ Argomenti corda 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ò allucinare i parametri non definiti dallo schema della funzione. Convalidare gli argomenti nel codice prima di chiamare la funzione. No
└> nome corda Nome della funzione da chiamare. No
id corda ID della chiamata allo strumento. No
index Intero Sì
type enum Tipo dello strumento. Attualmente è supportato solo function .
Valori possibili: function		 No

OpenAI.ChatCompletionNamedToolChoice

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

Name Tipo Description Obbligatorio Predefinito
funzione object Sì
└> nome corda Nome della funzione da chiamare. No
type enum Tipo dello strumento. Attualmente è supportato solo function .
Valori possibili: function		 Sì

OpenAI.ChatCompletionRequestAssistantMessage

Messaggi inviati dal modello in risposta ai messaggi utente.

Name Tipo Description Obbligatorio Predefinito
Audio object Dati relativi a una risposta audio precedente dal modello. No
└* id corda Identificatore univoco per una risposta audio precedente dal modello. No
contenuto stringa o matrice No
function_call object Deprecato e sostituito da tool_calls. Nome e argomenti di una funzione che deve essere chiamata, come generato dal modello. No
└─ Argomenti corda No
└> nome corda No
name corda Nome facoltativo per il partecipante. Fornisce le informazioni sul modello per distinguere i partecipanti dello stesso ruolo. No
refusal corda Messaggio di rifiuto dell'assistente. No
Ruolo enum Ruolo dell'autore dei messaggi, in questo caso assistant.
Valori possibili: assistant		 Sì
tool_calls ChatCompletionMessageToolCallsItem Lo strumento chiama generato dal modello, ad esempio le chiamate di funzione. No

OpenAI.ChatCompletionRequestAssistantMessageContentPart

Name Tipo Description Obbligatorio Predefinito
refusal corda Messaggio di rifiuto generato dal modello. Sì
text corda Contenuto di testo. Sì
type enum Tipo della parte di contenuto.
Valori possibili: refusal		 Sì

OpenAI.ChatCompletionRequestDeveloperMessage

Istruzioni fornite dallo sviluppatore che il modello deve seguire, indipendentemente dai messaggi inviati dall'utente. Con i modelli o1 e versioni successive, developer i messaggi sostituiscono i messaggi precedenti system .

Name Tipo Description Obbligatorio Predefinito
contenuto stringa o matrice Sì
name corda Nome facoltativo per il partecipante. Fornisce le informazioni sul modello per distinguere i partecipanti dello stesso ruolo. No
Ruolo enum Ruolo dell'autore dei messaggi, in questo caso developer.
Valori possibili: developer		 Sì

OpenAI.ChatCompletionRequestFunctionMessage

Name Tipo Description Obbligatorio Predefinito
contenuto corda Contenuto del messaggio della funzione. Sì
name corda Nome della funzione da chiamare. Sì
Ruolo enum Ruolo dell'autore dei messaggi, in questo caso function.
Valori possibili: function		 Sì

OpenAI.ChatCompletionRequestMessage

Discriminare per OpenAI.ChatCompletionRequestMessage

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

Valore del tipo Schema
system OpenAI.ChatCompletionRequestSystemMessage
developer OpenAI.ChatCompletionRequestDeveloperMessage
user OpenAI.ChatCompletionRequestUserMessage
assistant OpenAI.ChatCompletionRequestAssistantMessage
tool OpenAI.ChatCompletionRequestToolMessage
function OpenAI.ChatCompletionRequestFunctionMessage
Name Tipo Description Obbligatorio Predefinito
contenuto stringa o matrice No
Ruolo object Ruolo dell'autore di un messaggio Sì

OpenAI.ChatCompletionRequestMessageContentPart

Discriminare per OpenAI.ChatCompletionRequestMessageContentPart

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

Valore del tipo Schema
text OpenAI.ChatCompletionRequestMessageContentPartText
image_url OpenAI.ChatCompletionRequestMessageContentPartImage
refusal OpenAI.ChatCompletionRequestMessageContentPartRefusal
file OpenAI.ChatCompletionRequestMessageContentPartFile
input_audio OpenAI.ChatCompletionRequestMessageContentPartAudio
Name Tipo Description Obbligatorio Predefinito
type OpenAI.ChatCompletionRequestMessageContentPartType Sì

OpenAI.ChatCompletionRequestMessageContentPartAudio

Name Tipo Description Obbligatorio Predefinito
input_audio object Sì
└* dati corda Dati audio con codifica Base64. No
└* formato enum Formato dei dati audio codificati. Attualmente supporta "wav" e "mp3".
Valori possibili: wav, mp3		 No
type enum Tipo della parte di contenuto. Sempre input_audio.
Valori possibili: input_audio		 Sì

OpenAI.ChatCompletionRequestMessageContentPartFile

Name Tipo Description Obbligatorio Predefinito
file object Sì
└file_data corda I dati del file con codifica Base64, usati per passare il file al modello come stringa. No
└ file_id corda ID di un file caricato da usare come input. No
└─ nome file corda Nome del file, utilizzato quando si passa il file al modello come stringa. No
type enum Tipo della parte di contenuto. Sempre file.
Valori possibili: file		 Sì

OpenAI.ChatCompletionRequestMessageContentPartImage

Name Tipo Description Obbligatorio Predefinito
image_url object Sì
└─ dettaglio enum Specifica il livello di dettaglio dell'immagine.
Valori possibili: auto, low, high		 No
└─ URL corda URL dell'immagine o dei dati dell'immagine con codifica base64. No
type enum Tipo della parte di contenuto.
Valori possibili: image_url		 Sì

OpenAI.ChatCompletionRequestMessageContentPartRefusal

Name Tipo Description Obbligatorio Predefinito
refusal corda Messaggio di rifiuto generato dal modello. Sì
type enum Tipo della parte di contenuto.
Valori possibili: refusal		 Sì

OpenAI.ChatCompletionRequestMessageContentPartText

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

OpenAI.ChatCompletionRequestMessageContentPartType

Proprietà Value
Type corda
Valori text
file
input_audio
image_url
refusal

OpenAI.ChatCompletionRequestSystemMessage

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

Name Tipo Description Obbligatorio Predefinito
contenuto stringa o matrice Sì
name corda Nome facoltativo per il partecipante. Fornisce le informazioni sul modello per distinguere i partecipanti dello stesso ruolo. No
Ruolo enum Ruolo dell'autore dei messaggi, in questo caso system.
Valori possibili: system		 Sì

OpenAI.ChatCompletionRequestSystemMessageContentPart

Riferimenti: OpenAI.ChatCompletionRequestMessageContentPartText

OpenAI.ChatCompletionRequestToolMessage

Name Tipo Description Obbligatorio Predefinito
contenuto stringa o matrice Sì
Ruolo enum Ruolo dell'autore dei messaggi, in questo caso tool.
Valori possibili: tool		 Sì
tool_call_id corda Chiamare lo strumento a cui risponde questo messaggio. Sì

OpenAI.ChatCompletionRequestToolMessageContentPart

Riferimenti: OpenAI.ChatCompletionRequestMessageContentPartText

OpenAI.ChatCompletionRequestUserMessage

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

Name Tipo Description Obbligatorio Predefinito
contenuto stringa o matrice Sì
name corda Nome facoltativo per il partecipante. Fornisce le informazioni sul modello per distinguere i partecipanti dello stesso ruolo. No
Ruolo enum Ruolo dell'autore dei messaggi, in questo caso user.
Valori possibili: user		 Sì

OpenAI.ChatCompletionRequestUserMessageContentPart

Name Tipo Description Obbligatorio Predefinito
file object Sì
└file_data corda I dati del file con codifica Base64, usati per passare il file al modello come stringa. No
└ file_id corda ID di un file caricato da usare come input. No
└─ nome file corda Nome del file, utilizzato quando si passa il file al modello come stringa. No
image_url object Sì
└─ dettaglio enum Specifica il livello di dettaglio dell'immagine.
Valori possibili: auto, low, high		 No
└─ URL corda URL dell'immagine o dei dati dell'immagine con codifica base64. No
input_audio object Sì
└* dati corda Dati audio con codifica Base64. No
└* formato enum Formato dei dati audio codificati. Attualmente supporta "wav" e "mp3".
Valori possibili: wav, mp3		 No
text corda Contenuto di testo. Sì
type enum Tipo della parte di contenuto. Sempre file.
Valori possibili: file		 Sì

OpenAI.ChatCompletionRole

Ruolo dell'autore di un messaggio

Proprietà Value
Descrizione Ruolo dell'autore di un messaggio
Type corda
Valori system
developer
user
assistant
tool
function

OpenAI.ChatCompletionStreamOptions

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

Name Tipo Description Obbligatorio 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. NOTA: Se il flusso viene interrotto, è possibile che non si riceva il blocco di utilizzo finale che contiene l'utilizzo totale del token per la richiesta.		 No

OpenAI.ChatCompletionStreamResponseDelta

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

Name Tipo Description Obbligatorio Predefinito
Audio object No
└* dati corda No
└─ scadenza_a Intero No
└* id corda No
└─ trascrizione corda No
contenuto corda Contenuto del messaggio di blocco. No
function_call object Deprecato e sostituito da tool_calls. Nome e argomenti di una funzione che deve essere chiamata, come generato dal modello. No
└─ Argomenti corda No
└> nome corda No
refusal corda Messaggio di rifiuto generato dal modello. No
Ruolo object Ruolo dell'autore di un messaggio No
tool_calls array No

OpenAI.ChatCompletionTokenLogprob

Name Tipo Description Obbligatorio Predefinito
bytes array 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 di byte devono essere combinati per generare la rappresentazione di testo corretta. Può essere null se non è presente alcuna rappresentazione in byte per il token. Sì
logprob number Probabilità di log di questo token, se si trova all'interno dei primi 20 token più probabili. In caso contrario, il valore -9999.0 viene usato per indicare che il token è molto improbabile. Sì
Token corda Token. Sì
top_logprobs array Elenco dei token più probabili e della probabilità di log, in questa posizione del token. In rari casi, può essere presente un numero inferiore al numero di richieste restituite top_logprobs . Sì

OpenAI.ChatCompletionTool

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

OpenAI.ChatCompletionToolChoiceOption

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

none è l'impostazione predefinita quando non sono presenti strumenti. auto è l'impostazione predefinita se sono presenti strumenti.

Name Tipo Description Obbligatorio Predefinito
funzione object Sì
└> nome corda Nome della funzione da chiamare. No
type enum Tipo dello strumento. Attualmente è supportato solo function .
Valori possibili: function		 Sì

OpenAI.ChatOutputPrediction

Rappresentazione di base dell'output stimato da un modello.

Discriminare per OpenAI.ChatOutputPrediction

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

Valore del tipo Schema
content OpenAI.ChatOutputPredictionContent
Name Tipo Description Obbligatorio Predefinito
type OpenAI.ChatOutputPredictionType Sì

OpenAI.ChatOutputPredictionContent

Contenuto di output stimato statico, ad esempio il contenuto di un file di testo che viene rigenerato.

Name Tipo Description Obbligatorio Predefinito
contenuto stringa o matrice Sì
type enum Tipo di contenuto previsto da fornire. Questo tipo è attualmente sempre content.
Valori possibili: content		 Sì

OpenAI.ChatOutputPredictionType

Proprietà Value
Type corda
Valori content

OpenAI.ChunkingStrategyRequestParam

Strategia di suddivisione in blocchi usata per suddividere i file. Se non impostato, userà la auto strategia.

Discriminante per OpenAI.ChunkingStrategyRequestParam

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

Valore del tipo Schema
static OpenAI.StaticChunkingStrategyRequestParam
Name Tipo Description Obbligatorio Predefinito
type enum Tipo di strategia di suddivisione in blocchi.
Valori possibili: auto, static		 Sì

OpenAI.ChunkingStrategyResponseParam

Discriminante per OpenAI.ChunkingStrategyResponseParam

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

Valore del tipo Schema
other OpenAI.OtherChunkingStrategyResponseParam
static OpenAI.StaticChunkingStrategyResponseParam
Name Tipo Description Obbligatorio Predefinito
type enum
Valori possibili: static, other		 Sì

OpenAI.CodeInterpreterOutput

Discriminante per OpenAI.CodeInterpreterOutput

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

Valore del tipo Schema
image OpenAI.CodeInterpreterOutputImage
logs OpenAI.CodeInterpreterOutputLogs
Name Tipo Description Obbligatorio Predefinito
type OpenAI.CodeInterpreterOutputType Sì

OpenAI.CodeInterpreterOutputImage

Output dell'immagine dell'interprete di codice.

Name Tipo Description Obbligatorio Predefinito
type enum Tipo dell'output. Sempre 'image'.
Valori possibili: image		 Sì
Url corda URL dell'output dell'immagine dall'interprete di codice. Sì

OpenAI.CodeInterpreterOutputLogs

Output dei log dall'interprete di codice.

Name Tipo Description Obbligatorio Predefinito
logs corda Output dei log dall'interprete di codice. Sì
type enum Tipo dell'output. Sempre 'logs'.
Valori possibili: logs		 Sì

OpenAI.CodeInterpreterOutputType

Proprietà Value
Type corda
Valori logs
image

OpenAI.CodeInterpreterTool

Strumento che esegue Python codice per generare una risposta a un prompt.

Name Tipo Description Obbligatorio Predefinito
container object Configurazione per un contenitore dell'interprete di codice. Facoltativamente, specificare gli ID dei file in cui eseguire il codice. Sì
└file_ids array Elenco facoltativo di file caricati da rendere disponibile per il codice. No
└─ Tipo enum Sempre auto.
Valori possibili: auto		 No
type enum Tipo dello strumento dell'interprete di codice. Sempre code_interpreter.
Valori possibili: code_interpreter		 Sì

OpenAI.CodeInterpreterToolAuto

Configurazione per un contenitore dell'interprete di codice. Facoltativamente, specificare gli ID dei file in cui eseguire il codice.

Name Tipo Description Obbligatorio Predefinito
identificatori_di_file array Elenco facoltativo di file caricati da rendere disponibile per il codice. No
type enum Sempre auto.
Valori possibili: auto		 Sì

OpenAI.CodeInterpreterToolCallItemParam

Chiamata dello strumento per eseguire il codice.

Name Tipo Description Obbligatorio Predefinito
codice corda Codice da eseguire o null, se non disponibile. Sì
container_id corda ID del contenitore usato per eseguire il codice. Sì
Risultati array Gli output generati dall'interprete di codice, ad esempio log o immagini.
Può essere Null se non sono disponibili output.		 Sì
type enum
Valori possibili: code_interpreter_call		 Sì

OpenAI.CodeInterpreterToolCallItemResource

Chiamata dello strumento per eseguire il codice.

Name Tipo Description Obbligatorio Predefinito
codice corda Codice da eseguire o null, se non disponibile. Sì
container_id corda ID del contenitore usato per eseguire il codice. Sì
Risultati array Gli output generati dall'interprete di codice, ad esempio log o immagini.
Può essere Null se non sono disponibili output.		 Sì
stato enum
Valori possibili: in_progress, completedincomplete, , interpreting,failed		 Sì
type enum
Valori possibili: code_interpreter_call		 Sì

OpenAI.ComparisonFilter

Filtro utilizzato per confrontare una chiave di attributo specificata con un determinato valore usando un'operazione di confronto definita.

Name Tipo Description Obbligatorio Predefinito
chiave corda Chiave da confrontare con il valore. Sì
type enum Specifica l'operatore di confronto: eq, ne, gt, gte, lt, lte.
- eq:Uguale
- ne: diverso da
- gt:Maggiore
- gte: maggiore o uguale a
- lt:Meno
- lte: minore o uguale.
Valori possibili: eq, negt, gte, , ltlte		 Sì
Valore stringa o numero o valore booleano Sì

OpenAI.CompletionUsage

Statistiche di utilizzo per la richiesta di completamento.

Name Tipo Description Obbligatorio Predefinito
completion_tokens Intero Numero di token nel completamento generato. Sì 0
completion_tokens_details object Suddivisione dei token usati in un completamento. No
└─ token_di_predizione_accettati Intero Quando si usano output stimati, il numero di token nella stima visualizzata nel completamento. No 0
└audio_tokens Intero Token di input audio generati dal modello. No 0
└─ token_di_ragionamento Intero Token generati dal modello per il ragionamento. No 0
└rejected_prediction_tokens Intero Quando si usano output stimati, il numero di token nella stima che non sono stati visualizzati nel completamento. Tuttavia, come i token di ragionamento, questi token vengono ancora conteggiati nei token di completamento totali ai fini della fatturazione, dell'output e dei limiti della finestra di contesto. No 0
prompt_tokens Intero Numero di token nel prompt. Sì 0
prompt_tokens_details object Suddivisione dei token usati nel prompt. No
└audio_tokens Intero Token di input audio presenti nel prompt. No 0
└cached_tokens Intero Token memorizzati nella cache presenti nel prompt. No 0
total_tokens Intero Numero totale di token usati nella richiesta (richiesta + completamento). Sì 0

OpenAI.CompoundFilter

Combinare più filtri usando and o or.

Name Tipo Description Obbligatorio Predefinito
filters array Matrice di filtri da combinare. Gli elementi possono essere ComparisonFilter o CompoundFilter. Sì
type enum Tipo di operazione: and o or.
Valori possibili: and, or		 Sì

OpenAI.ComputerAction

Discriminare per OpenAI.ComputerAction

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

Valore del tipo Schema
click OpenAI.ComputerActionClick
double_click OpenAI.ComputerActionDoubleClick
drag OpenAI.ComputerActionDrag
move OpenAI.ComputerActionMove
screenshot OpenAI.ComputerActionScreenshot
scroll OpenAI.ComputerActionScroll
type OpenAI.ComputerActionTypeKeys
wait OpenAI.ComputerActionWait
keypress OpenAI.ComputerActionKeyPress
Name Tipo Description Obbligatorio Predefinito
type OpenAI.ComputerActionType Sì

OpenAI.ComputerActionClick

Azione di clic.

Name Tipo Description Obbligatorio Predefinito
pulsante enum Indica il pulsante del mouse premuto durante il clic. Uno di left, rightwheel, back, o forward.
Valori possibili: left, rightwheel, , back,forward		 Sì
type enum Specifica il tipo di evento. Per un'azione di clic, questa proprietà è sempre impostata su click.
Valori possibili: click		 Sì
x Intero Coordinata x in cui si è verificato il clic. Sì
Y Intero Coordinata y in cui si è verificato il clic. Sì

OpenAI.ComputerActionDoubleClick

Azione di doppio clic.

Name Tipo Description Obbligatorio Predefinito
type enum Specifica il tipo di evento. Per un'azione di doppio clic, questa proprietà è sempre impostata su double_click.
Valori possibili: double_click		 Sì
x Intero Coordinata x in cui si è verificato il doppio clic. Sì
Y Intero Coordinata y in cui si è verificato il doppio clic. Sì

OpenAI.ComputerActionDrag

Azione di trascinamento.

Name Tipo Description Obbligatorio Predefinito
path array Matrice di coordinate che rappresentano il percorso dell'azione di trascinamento. Le coordinate verranno visualizzate come matrice di oggetti, ad esempio{ x: 100, y: 200 }, { x: 200, y: 300 } Sì
type enum Specifica il tipo di evento. Per un'azione di trascinamento, questa proprietà è sempre impostata su drag.
Valori possibili: drag		 Sì

OpenAI.ComputerActionKeyPress

Una raccolta di keypresse il modello desidera eseguire.

Name Tipo Description Obbligatorio Predefinito
keys array La combinazione di tasti che il modello richiede di premere. Si tratta di una matrice di stringhe, ognuna che rappresenta una chiave. Sì
type enum Specifica il tipo di evento. Per un'azione keypress, questa proprietà è sempre impostata su keypress.
Valori possibili: keypress		 Sì

OpenAI.ComputerActionMove

Azione di spostamento del mouse.

Name Tipo Description Obbligatorio Predefinito
type enum Specifica il tipo di evento. Per un'azione di spostamento, questa proprietà è sempre impostata su move.
Valori possibili: move		 Sì
x Intero Coordinata x in cui spostarsi. Sì
Y Intero Coordinata y in cui spostarsi. Sì

OpenAI.ComputerActionScreenshot

Azione screenshot.

Name Tipo Description Obbligatorio Predefinito
type enum Specifica il tipo di evento. Per un'azione screenshot, questa proprietà è sempre impostata su screenshot.
Valori possibili: screenshot		 Sì

OpenAI.ComputerActionScroll

Azione di scorrimento.

Name Tipo Description Obbligatorio Predefinito
scroll_x Intero Distanza di scorrimento orizzontale. Sì
scroll_y Intero Distanza di scorrimento verticale. Sì
type enum Specifica il tipo di evento. Per un'azione di scorrimento, questa proprietà è sempre impostata su scroll.
Valori possibili: scroll		 Sì
x Intero Coordinata x in cui si è verificato lo scorrimento. Sì
Y Intero Coordinata y in cui si è verificato lo scorrimento. Sì

OpenAI.ComputerActionType

Proprietà Value
Type corda
Valori screenshot
click
double_click
scroll
type
wait
keypress
drag
move

OpenAI.ComputerActionTypeKeys

Azione da digitare nel testo.

Name Tipo Description Obbligatorio Predefinito
text corda Testo da digitare. Sì
type enum Specifica il tipo di evento. Per un'azione di tipo, questa proprietà è sempre impostata su type.
Valori possibili: type		 Sì

OpenAI.ComputerActionWait

Azione di attesa.

Name Tipo Description Obbligatorio Predefinito
type enum Specifica il tipo di evento. Per un'azione di attesa, questa proprietà è sempre impostata su wait.
Valori possibili: wait		 Sì

OpenAI.ComputerToolCallItemParam

Una chiamata di strumento a uno strumento per l'uso di un computer.

Name Tipo Description Obbligatorio Predefinito
azione OpenAI.ComputerAction Sì
call_id corda Identificatore usato per rispondere alla chiamata dello strumento con output. Sì
pending_safety_checks array Controlli di sicurezza in sospeso per la chiamata al computer. Sì
type enum
Valori possibili: computer_call		 Sì

OpenAI.ComputerToolCallItemResource

Una chiamata di strumento a uno strumento per l'uso di un computer.

Name Tipo Description Obbligatorio Predefinito
azione OpenAI.ComputerAction Sì
call_id corda Identificatore usato per rispondere alla chiamata dello strumento con output. Sì
pending_safety_checks array Controlli di sicurezza in sospeso per la chiamata al computer. Sì
stato enum Stato dell'elemento. Uno di in_progress, completedo incomplete. Popolato quando gli elementi vengono restituiti tramite API.
Valori possibili: in_progress, completed, incomplete		 Sì
type enum
Valori possibili: computer_call		 Sì

OpenAI.ComputerToolCallOutputItemOutput

Discriminare per OpenAI.ComputerToolCallOutputItemOutput

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

Valore del tipo Schema
computer_screenshot OpenAI.ComputerToolCallOutputItemOutputComputerScreenshot
Name Tipo Description Obbligatorio Predefinito
type OpenAI.ComputerToolCallOutputItemOutputType Immagine di screenshot del computer usata con lo strumento per l'uso del computer. Sì

OpenAI.ComputerToolCallOutputItemOutputComputerScreenshot

Name Tipo Description Obbligatorio Predefinito
ID del file corda No
image_url corda No
type enum
Valori possibili: computer_screenshot		 Sì

OpenAI.ComputerToolCallOutputItemOutputType

Immagine di screenshot del computer usata con lo strumento per l'uso del computer.

Proprietà Value
Descrizione Immagine di screenshot del computer usata con lo strumento per l'uso del computer.
Type corda
Valori computer_screenshot

OpenAI.ComputerToolCallOutputItemParam

Output di una chiamata allo strumento del computer.

Name Tipo Description Obbligatorio Predefinito
acknowledged_safety_checks array I controlli di sicurezza segnalati dall'API che sono stati riconosciuti dallo sviluppatore. No
call_id corda ID della chiamata dello strumento del computer che ha prodotto l'output. Sì
output OpenAI.ComputerToolCallOutputItemOutput Sì
type enum
Valori possibili: computer_call_output		 Sì

OpenAI.ComputerToolCallOutputItemResource

Output di una chiamata allo strumento del computer.

Name Tipo Description Obbligatorio Predefinito
acknowledged_safety_checks array I controlli di sicurezza segnalati dall'API che sono stati riconosciuti dallo sviluppatore. No
call_id corda ID della chiamata dello strumento del computer che ha prodotto l'output. Sì
output OpenAI.ComputerToolCallOutputItemOutput Sì
stato enum Stato dell'elemento. Uno di in_progress, completedo incomplete. Popolato quando gli elementi vengono restituiti tramite API.
Valori possibili: in_progress, completed, incomplete		 Sì
type enum
Valori possibili: computer_call_output		 Sì

OpenAI.ComputerToolCallSafetyCheck

Controllo di sicurezza in sospeso per la chiamata al computer.

Name Tipo Description Obbligatorio Predefinito
codice corda Tipo del controllo di sicurezza in sospeso. Sì
id corda ID del controllo di sicurezza in sospeso. Sì
message corda Dettagli sul controllo di sicurezza in sospeso. Sì

OpenAI.ComputerUsePreviewTool

Strumento che controlla un computer virtuale.

Name Tipo Description Obbligatorio Predefinito
altezza_schermo Intero Altezza dello schermo del computer. Sì
larghezza_display Intero Larghezza della visualizzazione del computer. Sì
environment enum Tipo di ambiente del computer da controllare.
Valori possibili: windows, maclinux, , ubuntu,browser		 Sì
type enum Tipo dello strumento di utilizzo del computer. Sempre computer_use_preview.
Valori possibili: computer_use_preview		 Sì

OpenAI.Coordinate

Coppia di coordinate x/y, ad esempio { x: 100, y: 200 }.

Name Tipo Description Obbligatorio Predefinito
x Intero Coordinata x. Sì
Y Intero Coordinata y. Sì

OpenAI.CreateEmbeddingResponse

Name Tipo Description Obbligatorio Predefinito
Dati array Elenco di incorporamenti generati dal modello. Sì
model corda Nome del modello utilizzato per generare l'incorporamento. Sì
object enum Tipo di oggetto, che è sempre "list".
Valori possibili: list		 Sì
uso object Informazioni sull'utilizzo per la richiesta. Sì
└prompt_tokens Intero Numero di token usati dal prompt. No
└total_tokens Intero Numero totale di token usati dalla richiesta. No

OpenAI.CreateEvalItem

Messaggio di chat che costituisce il prompt o il contesto. Può includere riferimenti a variabili allo spazio dei item nomi, ad esempio {{item.name}}.

Name Tipo Description Obbligatorio Predefinito
contenuto string o OpenAI.EvalItemContent Input di testo per il modello: può contenere stringhe di modello. Sì
Ruolo enum Ruolo dell'input del messaggio. Uno di user, assistant, systemo developer.
Valori possibili: user, assistant, system, developer		 Sì
type enum Tipo di input del messaggio. Sempre message.
Valori possibili: message		 No

OpenAI.CreateEvalRunRequest

Name Tipo Description Obbligatorio Predefinito
fonte_dati object Sì
└─ Tipo OpenAI.EvalRunDataSourceType No
metadata object Set di 16 coppie chiave-valore che possono essere collegate a un oggetto . Ciò può essere utile per archiviare informazioni aggiuntive sull'oggetto in un formato strutturato ed eseguire query sugli oggetti tramite API o il dashboard.

Le chiavi sono stringhe con una lunghezza massima di 64 caratteri. I valori sono stringhe con una lunghezza massima di 512 caratteri.		 No
name corda Nome dell'esecuzione. No

OpenAI.CreateFineTuningJobRequest

Modelli validi:

babbage-002
davinci-002
gpt-3.5-turbo
gpt-4o-mini
Name Tipo Description Obbligatorio Predefinito
iperparametri object Iperparametri usati per il processo di ottimizzazione.
Questo valore è ora deprecato a favore di methode deve essere passato nel method parametro .		 No
└batch_size enum
Valori possibili: auto		 No
└learning_rate_multiplier enum
Valori possibili: auto		 No
└n_epochs enum
Valori possibili: auto		 No
integrazioni array Elenco di integrazioni da abilitare per il processo di ottimizzazione. No
metadata object Set di 16 coppie chiave-valore che possono essere collegate a un oggetto . Ciò può essere utile per archiviare informazioni aggiuntive sull'oggetto in un formato strutturato ed eseguire query sugli oggetti tramite API o il dashboard.

Le chiavi sono stringhe con una lunghezza massima di 64 caratteri. I valori sono stringhe con una lunghezza massima di 512 caratteri.		 No
method OpenAI.FineTuneMethod Metodo utilizzato per l'ottimizzazione. No
model string (vedere modelli validi di seguito) Nome del modello da ottimizzare. Sì
seed Intero Il valore di inizializzazione controlla la riproducibilità del processo. Il passaggio degli stessi parametri di inizializzazione e processo dovrebbe produrre gli stessi risultati, ma può differire in rari casi.
Se non viene specificato un valore di inizializzazione, ne verrà generato uno automaticamente.		 No
Suffisso corda Stringa di un massimo di 64 caratteri che verrà aggiunta al nome del modello ottimizzato.

Ad esempio, un suffix valore di "custom-model-name" produce un nome di modello come ft:gpt-4o-mini:openai:custom-model-name:7p4lURel.		 No Nessuno
file di allenamento corda ID di un file caricato che contiene i dati di training. Il set di dati deve essere formattato come file JSONL. Inoltre, è necessario caricare il file con lo scopo fine-tune.

Il contenuto del file deve variare a seconda che il modello usi la chat, il formato dei completamenti o se il metodo di ottimizzazione usa il formato preferenza.		 Sì
file_di_validazione corda ID di un file caricato che contiene i dati di convalida.

Se si specifica questo file, i dati vengono usati per generare periodicamente le metriche di convalida durante l'ottimizzazione. Queste metriche possono essere visualizzate nel file dei risultati di ottimizzazione.
Gli stessi dati non devono essere presenti sia nei file di training che in quello di convalida.

Il set di dati deve essere formattato come file JSONL. È necessario caricare il file con lo scopo fine-tune.		 No

OpenAI.CreateFineTuningJobRequestIntegration

Discriminante per OpenAI.CreateFineTuningJobRequestIntegration

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

Valore del tipo Schema
wandb OpenAI.CreateFineTuningJobRequestWandbIntegration
Name Tipo Description Obbligatorio Predefinito
type string (vedere modelli validi di seguito) Sì

OpenAI.CreateFineTuningJobRequestWandbIntegration

Name Tipo Description Obbligatorio Predefinito
type enum
Valori possibili: wandb		 Sì
wandb object Sì
└─ Entità corda No
└> nome corda No
└─ progetto corda No
└* tag array No

OpenAI.CreateVectorStoreFileBatchRequest

Name Tipo Description Obbligatorio Predefinito
attributes object Set di 16 coppie chiave-valore che possono essere collegate a un oggetto . Ciò può essere utile per archiviare informazioni aggiuntive sull'oggetto in un formato strutturato ed eseguire query sugli oggetti tramite API o il dashboard. Le chiavi sono stringhe con una lunghezza massima di 64 caratteri. I valori sono stringhe con una lunghezza massima di 512 caratteri, valori booleani o numeri. No
chunking_strategy OpenAI.ChunkingStrategyRequestParam Strategia di suddivisione in blocchi usata per suddividere i file. Se non impostato, userà la auto strategia. No
identificatori_di_file array Elenco di ID file che devono essere usati dall'archivio vettoriale. Utile per strumenti come file_search questo possono accedere ai file. Sì

OpenAI.CreateVectorStoreFileRequest

Name Tipo Description Obbligatorio Predefinito
attributes object Set di 16 coppie chiave-valore che possono essere collegate a un oggetto . Ciò può essere utile per archiviare informazioni aggiuntive sull'oggetto in un formato strutturato ed eseguire query sugli oggetti tramite API o il dashboard. Le chiavi sono stringhe con una lunghezza massima di 64 caratteri. I valori sono stringhe con una lunghezza massima di 512 caratteri, valori booleani o numeri. No
chunking_strategy OpenAI.ChunkingStrategyRequestParam Strategia di suddivisione in blocchi usata per suddividere i file. Se non impostato, userà la auto strategia. No
ID del file corda ID file che deve essere usato dall'archivio vettoriale. Utile per strumenti come file_search questo possono accedere ai file. Sì

OpenAI.CreateVectorStoreRequest

Name Tipo Description Obbligatorio Predefinito
chunking_strategy object Strategia predefinita. Questa strategia usa attualmente un max_chunk_size_tokens oggetto di 800 e chunk_overlap_tokens di 400. No
└─ statico OpenAI.StaticChunkingStrategy No
└─ Tipo enum Sempre static.
Valori possibili: static		 No
scade dopo OpenAI.VectorStoreExpirationAfter Criteri di scadenza per un archivio vettoriale. No
identificatori_di_file array Elenco di ID file che devono essere usati dall'archivio vettoriale. Utile per strumenti come file_search questo possono accedere ai file. No
metadata object Set di 16 coppie chiave-valore che possono essere collegate a un oggetto . Ciò può essere utile per archiviare informazioni aggiuntive sull'oggetto in un formato strutturato ed eseguire query sugli oggetti tramite API o il dashboard.

Le chiavi sono stringhe con una lunghezza massima di 64 caratteri. I valori sono stringhe con una lunghezza massima di 512 caratteri.		 No
name corda Nome dell'archivio vettoriale. No

OpenAI.DeleteFileResponse

Name Tipo Description Obbligatorio Predefinito
cancellato Boolean Sì
id corda Sì
object enum
Valori possibili: file		 Sì

OpenAI.DeleteVectorStoreFileResponse

Name Tipo Description Obbligatorio Predefinito
cancellato Boolean Sì
id corda Sì
object enum
Valori possibili: vector_store.file.deleted		 Sì

OpenAI.DeleteVectorStoreResponse

Name Tipo Description Obbligatorio Predefinito
cancellato Boolean Sì
id corda Sì
object enum
Valori possibili: vector_store.deleted		 Sì

OpenAI.Embedding

Rappresenta un vettore di incorporamento restituito dall'endpoint di incorporamento.

Name Tipo Description Obbligatorio Predefinito
embedding matrice o stringa Sì
index Intero Indice dell'incorporamento nell'elenco di incorporamenti. Sì
object enum Tipo di oggetto, che è sempre "incorporamento".
Valori possibili: embedding		 Sì

OpenAI.Eval

Oggetto Eval con criteri di configurazione e test dell'origine dati. Un Eval rappresenta un'attività da eseguire per l'integrazione LLM. Come:

  • Migliorare la qualità del chatbot
  • Scopri in che modo il mio chatbot gestisce il supporto clienti
  • Controllare se o4-mini è meglio nel mio caso d'uso rispetto a gpt-4o
Name Tipo Description Obbligatorio Predefinito
creato_il Intero Timestamp Unix (in secondi) per la creazione dell'eval. Sì
configurazione_sorgente_dati object Sì
└─ Tipo OpenAI.EvalDataSourceConfigType No
id corda Identificatore univoco per la valutazione. Sì
metadata object Set di 16 coppie chiave-valore che possono essere collegate a un oggetto . Ciò può essere utile per archiviare informazioni aggiuntive sull'oggetto in un formato strutturato ed eseguire query sugli oggetti tramite API o il dashboard.

Le chiavi sono stringhe con una lunghezza massima di 64 caratteri. I valori sono stringhe con una lunghezza massima di 512 caratteri.		 Sì
name corda Nome della valutazione. Sì
object enum Tipo di oggetto.
Valori possibili: eval		 Sì
criteri_di_test array Elenco dei criteri di test. Sì Nessuno

OpenAI.EvalApiError

Oggetto che rappresenta una risposta di errore dall'API Eval.

Name Tipo Description Obbligatorio Predefinito
codice corda Codice di errore. Sì
message corda Messaggio di errore. Sì

OpenAI.EvalCompletionsRunDataSourceParams

Oggetto CompletionsRunDataSource che descrive una configurazione di campionamento del modello.

Name Tipo Description Obbligatorio Predefinito
messaggi di input object No
└item_reference corda Riferimento a una variabile nello spazio dei item nomi . Ad esempio, "item.input_trajectory" No
Modello └─ array Elenco di messaggi di chat che formano il prompt o il contesto. Può includere riferimenti a variabili allo spazio dei item nomi, ad esempio {{item.name}}. No
└─ Tipo enum Tipo di messaggi di input. Sempre item_reference.
Valori possibili: item_reference		 No
model corda Nome del modello da usare per la generazione di completamenti (ad esempio"o3-mini"). No
sampling_params AzureEvalAPICompletionsSamplingParams No
source object Sì
└> contenuto array Contenuto del file jsonl. No
└─created_after Intero Timestamp Unix facoltativo per filtrare gli elementi creati dopo questa volta. No
└─ creato_prima Intero Timestamp Unix facoltativo per filtrare gli elementi creati prima di questa volta. No
└* id corda Identificatore del file. No
└* limite Intero Numero massimo facoltativo di elementi da restituire. No
└─ metadati object Set di 16 coppie chiave-valore che possono essere collegate a un oggetto . Ciò può essere utile per archiviare informazioni aggiuntive sull'oggetto in un formato strutturato ed eseguire query sugli oggetti tramite API o il dashboard.

Le chiavi sono stringhe con una lunghezza massima di 64 caratteri. I valori sono stringhe con una lunghezza massima di 512 caratteri.		 No
└─ Modello corda Modello facoltativo da filtrare in base a (ad esempio, 'gpt-4o'). No
└─ Tipo enum Tipo di origine. Sempre stored_completions.
Valori possibili: stored_completions		 No
type enum Tipo di origine dati di esecuzione. Sempre completions.
Valori possibili: completions		 Sì

OpenAI.EvalCustomDataSourceConfigParams

Oggetto CustomDataSourceConfig che definisce lo schema per l'origine dati utilizzata per le esecuzioni di valutazione. Questo schema viene usato per definire la forma dei dati che saranno:

  • Usato per definire i criteri di test e
  • Quali dati sono necessari durante la creazione di un'esecuzione
Name Tipo Description Obbligatorio Predefinito
includi_schema_esempio Boolean Indica se l'eval deve aspettarsi di popolare lo spazio dei nomi di esempio (ad esempio, generando risposte all'esterno dell'origine dati) No Falso
schema_elemento object Schema JSON per ogni riga nell'origine dati. Sì
type enum Tipo di origine dati. Sempre custom.
Valori possibili: custom		 Sì

OpenAI.EvalCustomDataSourceConfigResource

CustomDataSourceConfig che specifica lo schema degli item spazi dei nomi e facoltativamente sample . Lo schema di risposta definisce la forma dei dati che saranno:

  • Usato per definire i criteri di test e
  • Quali dati sono necessari durante la creazione di un'esecuzione
Name Tipo Description Obbligatorio Predefinito
schema object Schema json per gli elementi dell'origine dati di esecuzione.
Informazioni su come creare schemi JSON qui.		 Sì
type enum Tipo di origine dati. Sempre custom.
Valori possibili: custom		 Sì

OpenAI.EvalDataSourceConfigParams

Discriminatorio per OpenAI.EvalDataSourceConfigParams

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

Valore del tipo Schema
custom OpenAI.EvalCustomDataSourceConfigParams
logs OpenAI.EvalLogsDataSourceConfigParams
stored_completions OpenAI.EvalStoredCompletionsDataSourceConfigParams
Name Tipo Description Obbligatorio Predefinito
type OpenAI.EvalDataSourceConfigType Sì

OpenAI.EvalDataSourceConfigResource

Discriminatorio per OpenAI.EvalDataSourceConfigResourceResource

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

Valore del tipo Schema
custom OpenAI.EvalCustomDataSourceConfigResource
stored_completions OpenAI.EvalStoredCompletionsDataSourceConfigResource
logs OpenAI.EvalLogsDataSourceConfigResource
Name Tipo Description Obbligatorio Predefinito
type OpenAI.EvalDataSourceConfigType Sì

OpenAI.EvalDataSourceConfigType

Proprietà Value
Type corda
Valori custom
logs
stored_completions

OpenAI.EvalGraderLabelModelParams

Oggetto LabelModelGrader che usa un modello per assegnare etichette a ogni elemento della valutazione.

Name Tipo Description Obbligatorio Predefinito
input array Elenco di messaggi di chat che formano il prompt o il contesto. Può includere riferimenti a variabili allo spazio dei item nomi, ad esempio {{item.name}}. Sì
labels array Etichette da classificare in ogni elemento della valutazione. Sì
model corda Modello da utilizzare per la valutazione. Deve supportare output strutturati. Sì
name corda Nome del grader. Sì
etichette_di_passaggio array Etichette che indicano un risultato di passaggio. Deve essere un subset di etichette. Sì
type enum Tipo di oggetto, che è sempre label_model.
Valori possibili: label_model		 Sì

OpenAI.EvalGraderLabelModelResource

Name Tipo Description Obbligatorio Predefinito
input array Sì
labels array Etichette da assegnare a ogni elemento della valutazione. Sì
model corda Modello da utilizzare per la valutazione. Deve supportare output strutturati. Sì
name corda Nome del grader. Sì
etichette_di_passaggio array Etichette che indicano un risultato di passaggio. Deve essere un subset di etichette. Sì
type enum Tipo di oggetto, che è sempre label_model.
Valori possibili: label_model		 Sì

OpenAI.EvalGraderParams

Discriminante per OpenAI.EvalGraderParams

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

Valore del tipo Schema
label_model OpenAI.EvalGraderLabelModelParams
string_check OpenAI.EvalGraderStringCheckParams
text_similarity OpenAI.EvalGraderTextSimilarityParams
python OpenAI.EvalGraderPythonParams
score_model OpenAI.EvalGraderScoreModelParams
Name Tipo Description Obbligatorio Predefinito
type OpenAI.GraderType Sì

OpenAI.EvalGraderPythonParams

Name Tipo Description Obbligatorio Predefinito
image_tag corda Tag immagine da usare per lo script Python. No
name corda Nome del grader. Sì
soglia di superamento number Soglia per il punteggio. No
source corda Codice sorgente dello script Python. Sì
type enum Tipo di oggetto, che è sempre python.
Valori possibili: python		 Sì

OpenAI.EvalGraderPythonResource

Name Tipo Description Obbligatorio Predefinito
image_tag corda Tag immagine da usare per lo script Python. No
name corda Nome del grader. Sì
soglia di superamento number Soglia per il punteggio. No
source corda Codice sorgente dello script Python. Sì
type enum Tipo di oggetto, che è sempre python.
Valori possibili: python		 Sì

OpenAI.EvalGraderResource

Discriminante per OpenAI.EvalGraderResource

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

Valore del tipo Schema
label_model OpenAI.EvalGraderLabelModelResource
text_similarity OpenAI.EvalGraderTextSimilarityResource
python OpenAI.EvalGraderPythonResource
score_model OpenAI.EvalGraderScoreModelResource
Name Tipo Description Obbligatorio Predefinito
type OpenAI.GraderType Sì

OpenAI.EvalGraderScoreModelParams

Name Tipo Description Obbligatorio Predefinito
input array Testo di input. Ciò può includere stringhe di modello. Sì
model corda Modello da utilizzare per la valutazione. Sì
name corda Nome del grader. Sì
soglia di superamento number Soglia per il punteggio. No
intervallo array Intervallo del punteggio. Il valore predefinito è [0, 1]. No
sampling_params Parametri di campionamento per il modello. No
type enum Tipo di oggetto, che è sempre score_model.
Valori possibili: score_model		 Sì

OpenAI.EvalGraderScoreModelResource

Name Tipo Description Obbligatorio Predefinito
input array Testo di input. Ciò può includere stringhe di modello. Sì
model corda Modello da utilizzare per la valutazione. Sì
name corda Nome del grader. Sì
soglia di superamento number Soglia per il punteggio. No
intervallo array Intervallo del punteggio. Il valore predefinito è [0, 1]. No
sampling_params Parametri di campionamento per il modello. No
type enum Tipo di oggetto, che è sempre score_model.
Valori possibili: score_model		 Sì

OpenAI.EvalGraderStringCheckParams

Name Tipo Description Obbligatorio Predefinito
input corda Testo di input. Ciò può includere stringhe di modello. Sì
name corda Nome del grader. Sì
operazione enum Operazione di controllo della stringa da eseguire. Uno di eq, ne, likeo ilike.
Valori possibili: eq, ne, like, ilike		 Sì
riferimento corda Testo di riferimento. Ciò può includere stringhe di modello. Sì
type enum Tipo di oggetto, che è sempre string_check.
Valori possibili: string_check		 Sì

OpenAI.EvalGraderTextSimilarityParams

Name Tipo Description Obbligatorio Predefinito
metrica di valutazione enum Metrica di valutazione da usare. Uno di fuzzy_match, bleugleu, meteor, rouge_1, rouge_2, rouge_3, rouge_4, , rouge_5o rouge_l.
Valori possibili: fuzzy_match, bleu, gleumeteor, rouge_1, rouge_2, rouge_3, rouge_4, rouge_5rouge_l		 Sì
input corda Testo classificato. Sì
name corda Nome del grader. Sì
soglia di superamento number Soglia per il punteggio. Sì
riferimento corda Testo a cui viene eseguito il voto. Sì
type enum Tipo di grader.
Valori possibili: text_similarity		 Sì

OpenAI.EvalGraderTextSimilarityResource

Name Tipo Description Obbligatorio Predefinito
metrica di valutazione enum Metrica di valutazione da usare. Uno di fuzzy_match, bleugleu, meteor, rouge_1, rouge_2, rouge_3, rouge_4, , rouge_5o rouge_l.
Valori possibili: fuzzy_match, bleu, gleumeteor, rouge_1, rouge_2, rouge_3, rouge_4, rouge_5rouge_l		 Sì
input corda Testo classificato. Sì
name corda Nome del grader. Sì
soglia di superamento number Soglia per il punteggio. Sì
riferimento corda Testo a cui viene eseguito il voto. Sì
type enum Tipo di grader.
Valori possibili: text_similarity		 Sì

OpenAI.EvalItem

Input del messaggio per il modello con un ruolo che indica l'istruzione seguente gerarchia. Le istruzioni fornite con il ruolo o developer hanno la system precedenza sulle istruzioni fornite con il user ruolo . Si presuppone che i messaggi con il assistant ruolo siano stati generati dal modello nelle interazioni precedenti.

Name Tipo Description Obbligatorio Predefinito
contenuto object Sì
└─ Tipo OpenAI.EvalItemContentType No
Ruolo enum Ruolo dell'input del messaggio. Uno di user, assistant, systemo developer.
Valori possibili: user, assistant, system, developer		 Sì
type enum Tipo di input del messaggio. Sempre message.
Valori possibili: message		 No

OpenAI.EvalItemContent

Discriminatorio per OpenAI.EvalItemContent

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

Valore del tipo Schema
input_text OpenAI.EvalItemContentInputText
output_text OpenAI.EvalItemContentOutputText
Name Tipo Description Obbligatorio Predefinito
type OpenAI.EvalItemContentType Sì

OpenAI.EvalItemContentInputText

Name Tipo Description Obbligatorio Predefinito
text corda Sì
type enum
Valori possibili: input_text		 Sì

OpenAI.EvalItemContentOutputText

Name Tipo Description Obbligatorio Predefinito
text corda Sì
type enum
Valori possibili: output_text		 Sì

OpenAI.EvalItemContentType

Proprietà Value
Type corda
Valori input_text
output_text

OpenAI.EvalJsonlRunDataSourceParams

Oggetto JsonlRunDataSource con che specifica un file JSONL che corrisponde all'eval

Name Tipo Description Obbligatorio Predefinito
source object Sì
└> contenuto array Contenuto del file jsonl. No
└* id corda Identificatore del file. No
└─ Tipo enum Tipo di origine jsonl. Sempre file_id.
Valori possibili: file_id		 No
type enum Tipo di origine dati. Sempre jsonl.
Valori possibili: jsonl		 Sì

OpenAI.EvalList

Oggetto che rappresenta un elenco di valori.

Name Tipo Description Obbligatorio Predefinito
Dati array Matrice di oggetti eval. Sì
first_id corda Identificatore della prima eval nella matrice di dati. Sì
ha_di_piu Boolean Indica se sono disponibili più valutazioni. Sì
last_id corda Identificatore dell'ultima eval nella matrice di dati. Sì
object enum Tipo di questo oggetto. È sempre impostato su "list".
Valori possibili: list		 Sì

OpenAI.EvalLogsDataSourceConfigParams

Configurazione dell'origine dati che specifica la proprietà dei metadati della query di log. Si tratta in genere di metadati come usecase=chatbot o prompt-version=v2e così via.

Name Tipo Description Obbligatorio Predefinito
metadata object Set di 16 coppie chiave-valore che possono essere collegate a un oggetto . Ciò può essere utile per archiviare informazioni aggiuntive sull'oggetto in un formato strutturato ed eseguire query sugli oggetti tramite API o il dashboard.

Le chiavi sono stringhe con una lunghezza massima di 64 caratteri. I valori sono stringhe con una lunghezza massima di 512 caratteri.		 No
type enum Tipo di origine dati. Sempre logs.
Valori possibili: logs		 Sì

OpenAI.EvalLogsDataSourceConfigResource

LogsDataSourceConfig che specifica la proprietà dei metadati della query di log. Si tratta in genere di metadati come usecase=chatbot o prompt-version=v2e così via. Lo schema restituito da questa configurazione dell'origine dati viene usato per definire quali variabili sono disponibili nelle valutazioni. item e sample sono entrambi definiti quando si usa questa configurazione dell'origine dati.

Name Tipo Description Obbligatorio Predefinito
metadata object Set di 16 coppie chiave-valore che possono essere collegate a un oggetto . Ciò può essere utile per archiviare informazioni aggiuntive sull'oggetto in un formato strutturato ed eseguire query sugli oggetti tramite API o il dashboard.

Le chiavi sono stringhe con una lunghezza massima di 64 caratteri. I valori sono stringhe con una lunghezza massima di 512 caratteri.		 Sì
schema object Schema json per gli elementi dell'origine dati di esecuzione.
Informazioni su come creare schemi JSON qui.		 Sì
type enum Tipo di origine dati. Sempre logs.
Valori possibili: logs		 Sì

OpenAI.EvalResponsesRunDataSourceParams

Oggetto ResponsesRunDataSource che descrive una configurazione di campionamento del modello.

Name Tipo Description Obbligatorio Predefinito
messaggi di input object No
└item_reference corda Riferimento a una variabile nello spazio dei item nomi . cioè, "item.name" No
Modello └─ array Elenco di messaggi di chat che formano il prompt o il contesto. Può includere riferimenti a variabili allo spazio dei item nomi, ad esempio {{item.name}}. No
└─ Tipo enum Tipo di messaggi di input. Sempre item_reference.
Valori possibili: item_reference		 No
model corda Nome del modello da usare per la generazione di completamenti (ad esempio"o3-mini"). No
sampling_params AzureEvalAPIResponseSamplingParams No
source object Sì
└> contenuto array Contenuto del file jsonl. No
└─created_after Intero Includere solo gli elementi creati dopo questo timestamp (inclusi). Si tratta di un parametro di query usato per selezionare le risposte. No
└─ creato_prima Intero Includere solo gli elementi creati prima di questo timestamp (inclusi). Si tratta di un parametro di query usato per selezionare le risposte. No
└* id corda Identificatore del file. No
└instructions_search corda Stringa facoltativa per cercare il campo 'instructions'. Si tratta di un parametro di query usato per selezionare le risposte. No
└─ metadati object Set di 16 coppie chiave-valore che possono essere collegate a un oggetto . Ciò può essere utile per archiviare informazioni aggiuntive sull'oggetto in un formato strutturato ed eseguire query sugli oggetti tramite API o il dashboard.

Le chiavi sono stringhe con una lunghezza massima di 64 caratteri. I valori sono stringhe con una lunghezza massima di 512 caratteri.		 No
└─ Modello corda Nome del modello per cui trovare le risposte. Si tratta di un parametro di query usato per selezionare le risposte. No
└reasoning_effort Sforzo di Ragionamento OpenAI Parametro facoltativo del tentativo di ragionamento. Si tratta di un parametro di query usato per selezionare le risposte. No
└* temperatura number Temperatura di campionamento. Si tratta di un parametro di query usato per selezionare le risposte. No
Strumenti └* array Elenco dei nomi degli strumenti. Si tratta di un parametro di query usato per selezionare le risposte. No
└top_p number Parametro di campionamento del nucleo. Si tratta di un parametro di query usato per selezionare le risposte. No
└─ Tipo enum Tipo di origine dati di esecuzione. Sempre responses.
Valori possibili: responses		 No
└─ utenti array Elenco di identificatori utente. Si tratta di un parametro di query usato per selezionare le risposte. No
type enum Tipo di origine dati di esecuzione. Sempre responses.
Valori possibili: responses		 Sì

OpenAI.EvalRun

Schema che rappresenta un'esecuzione di valutazione.

Name Tipo Description Obbligatorio Predefinito
creato_il Intero Timestamp Unix (in secondi) quando è stata creata l'esecuzione della valutazione. Sì
fonte_dati object Sì
└─ Tipo OpenAI.EvalRunDataSourceType No
Errore OpenAI.EvalApiError Oggetto che rappresenta una risposta di errore dall'API Eval. Sì
eval_id corda Identificatore della valutazione associata. Sì
id corda Identificatore univoco per l'esecuzione della valutazione. Sì
metadata object Set di 16 coppie chiave-valore che possono essere collegate a un oggetto . Ciò può essere utile per archiviare informazioni aggiuntive sull'oggetto in un formato strutturato ed eseguire query sugli oggetti tramite API o il dashboard.

Le chiavi sono stringhe con una lunghezza massima di 64 caratteri. I valori sono stringhe con una lunghezza massima di 512 caratteri.		 Sì
model corda Modello valutato, se applicabile. Sì
name corda Nome dell'esecuzione della valutazione. Sì
object enum Tipo dell'oggetto. Sempre "eval.run".
Valori possibili: eval.run		 Sì
utilizzo_per_modello array Statistiche di utilizzo per ogni modello durante l'esecuzione della valutazione. Sì
risultati_per_criteri_di_test array Risultati in base ai criteri di test applicati durante l'esecuzione della valutazione. Sì
report_url corda URL del report di esecuzione della valutazione di cui è stato eseguito il rendering nel dashboard dell'interfaccia utente. Sì
conteggio_risultati object Contatori che riepilogano i risultati dell'esecuzione della valutazione. Sì
└* non riuscito Intero Numero di elementi di output che hanno generato un errore. No
└* non riuscito Intero Numero di elementi di output che non sono riusciti a superare la valutazione. No
└> superato Intero Numero di elementi di output che hanno superato la valutazione. No
└─ totale Intero Numero totale di elementi di output eseguiti. No
stato corda Stato dell'esecuzione della valutazione. Sì

OpenAI.EvalRunDataContentSource

Discriminatorio per OpenAI.EvalRunDataContentSource

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

Valore del tipo Schema
file_id OpenAI.EvalRunFileIdDataContentSource
stored_completions OpenAI.EvalRunStoredCompletionsDataContentSource
responses OpenAI.EvalRunResponsesDataContentSource
Name Tipo Description Obbligatorio Predefinito
type OpenAI.EvalRunDataContentSourceType Sì

OpenAI.EvalRunDataContentSourceType

Proprietà Value
Type corda
Valori file_id
file_content
stored_completions
responses

OpenAI.EvalRunDataSourceCompletionsResource

Name Tipo Description Obbligatorio Predefinito
type enum
Valori possibili: completions		 Sì

OpenAI.EvalRunDataSourceJsonlResource

Name Tipo Description Obbligatorio Predefinito
type enum
Valori possibili: jsonl		 Sì

OpenAI.EvalRunDataSourceParams

Discriminare per OpenAI.EvalRunDataSourceParams

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

Valore del tipo Schema
jsonl OpenAI.EvalJsonlRunDataSourceParams
completions OpenAI.EvalCompletionsRunDataSourceParams
responses OpenAI.EvalResponsesRunDataSourceParams
Name Tipo Description Obbligatorio Predefinito
type OpenAI.EvalRunDataSourceType Sì

OpenAI.EvalRunDataSourceResource

Name Tipo Description Obbligatorio Predefinito
type OpenAI.EvalRunDataSourceType Sì

OpenAI.EvalRunDataSourceResponsesResource

Name Tipo Description Obbligatorio Predefinito
type enum
Valori possibili: responses		 Sì

OpenAI.EvalRunDataSourceType

Proprietà Value
Type corda
Valori jsonl
completions
responses

OpenAI.EvalRunFileContentDataContentSource

Name Tipo Description Obbligatorio Predefinito
contenuto array Contenuto del file jsonl. Sì
type enum Tipo di origine jsonl. Sempre file_content.
Valori possibili: file_content		 Sì

OpenAI.EvalRunFileIdDataContentSource

Name Tipo Description Obbligatorio Predefinito
id corda Identificatore del file. Sì
type enum Tipo di origine jsonl. Sempre file_id.
Valori possibili: file_id		 Sì

OpenAI.EvalRunList

Oggetto che rappresenta un elenco di esecuzioni per una valutazione.

Name Tipo Description Obbligatorio Predefinito
Dati array Matrice di oggetti di esecuzione di eval. Sì
first_id corda Identificatore della prima esecuzione dell'eval nella matrice di dati. Sì
ha_di_piu Boolean Indica se sono disponibili più valutazioni. Sì
last_id corda Identificatore dell'ultima esecuzione dell'ultima eval nella matrice di dati. Sì
object enum Tipo di questo oggetto. È sempre impostato su "list".
Valori possibili: list		 Sì

OpenAI.EvalRunOutputItem

Schema che rappresenta un elemento di output dell'esecuzione della valutazione.

Name Tipo Description Obbligatorio Predefinito
creato_il Intero Timestamp Unix (in secondi) quando è stata creata l'esecuzione della valutazione. Sì
elemento_fonte_dati object Dettagli dell'elemento dell'origine dati di input. Sì
datasource_item_id (identificativo_elemento_fonte_dati) Intero Identificatore dell'elemento dell'origine dati. Sì
eval_id corda Identificatore del gruppo di valutazione. Sì
id corda Identificatore univoco per l'elemento di output dell'esecuzione della valutazione. Sì
object enum Tipo dell'oggetto. Sempre "eval.run.output_item".
Valori possibili: eval.run.output_item		 Sì
results array Elenco dei risultati dell'esecuzione della valutazione. Sì
run_id corda Identificatore dell'esecuzione di valutazione associata a questo elemento di output. Sì
campione object Esempio contenente l'input e l'output dell'esecuzione della valutazione. Sì
└─ Errore OpenAI.EvalApiError Oggetto che rappresenta una risposta di errore dall'API Eval. No
└─ motivo_fine corda Motivo per cui la generazione dell'esempio è stata completata. No
└ Input array Matrice di messaggi di input. No
└ max_completion_tokens Intero Numero massimo di token consentiti per il completamento. No
└─ Modello corda Modello utilizzato per generare l'esempio. No
└─ uscita array Matrice di messaggi di output. No
└* seed Intero Valore di inizializzazione utilizzato per generare l'esempio. No
└* temperatura number Temperatura di campionamento utilizzata. No
└top_p number Valore top_p utilizzato per il campionamento. No
└─ utilizzo object Dettagli sull'utilizzo dei token per l'esempio. No
└cached_tokens Intero Numero di token recuperati dalla cache. No
└completion_tokens Intero Numero di token di completamento generati. No
└prompt_tokens Intero Numero di token di richiesta usati. No
└total_tokens Intero Numero totale di token usati. No
stato corda Stato dell'esecuzione della valutazione. Sì

OpenAI.EvalRunOutputItemList

Oggetto che rappresenta un elenco di elementi di output per un'esecuzione di valutazione.

Name Tipo Description Obbligatorio Predefinito
Dati array Matrice di oggetti elemento di output di esecuzione eval. Sì
first_id corda Identificatore del primo elemento di output dell'esecuzione di eval nella matrice di dati. Sì
ha_di_piu Boolean Indica se sono disponibili più elementi di output dell'esecuzione di eval. Sì
last_id corda Identificatore dell'ultimo elemento di output dell'esecuzione di eval nella matrice di dati. Sì
object enum Tipo di questo oggetto. È sempre impostato su "list".
Valori possibili: list		 Sì

OpenAI.EvalRunResponsesDataContentSource

Oggetto EvalResponsesSource che descrive una configurazione dell'origine dati di esecuzione.

Name Tipo Description Obbligatorio Predefinito
creato_dopo Intero Includere solo gli elementi creati dopo questo timestamp (inclusi). Si tratta di un parametro di query usato per selezionare le risposte. No
creato_prima Intero Includere solo gli elementi creati prima di questo timestamp (inclusi). Si tratta di un parametro di query usato per selezionare le risposte. No
instructions_search corda Stringa facoltativa per cercare il campo 'instructions'. Si tratta di un parametro di query usato per selezionare le risposte. No
metadata object Set di 16 coppie chiave-valore che possono essere collegate a un oggetto . Ciò può essere utile per archiviare informazioni aggiuntive sull'oggetto in un formato strutturato ed eseguire query sugli oggetti tramite API o il dashboard.

Le chiavi sono stringhe con una lunghezza massima di 64 caratteri. I valori sono stringhe con una lunghezza massima di 512 caratteri.		 No
model corda Nome del modello per cui trovare le risposte. Si tratta di un parametro di query usato per selezionare le risposte. No
sforzo di ragionamento object Solo modelli di serie o

Vincola lo sforzo sul ragionamento per i modelli di ragionamento.
I valori attualmente supportati sono low, mediume high. La riduzione del lavoro di ragionamento può comportare risposte più veloci e un minor numero di token usati per il ragionamento in una risposta.		 No
Temperatura number Temperatura di campionamento. Si tratta di un parametro di query usato per selezionare le risposte. No
Strumenti array Elenco dei nomi degli strumenti. Si tratta di un parametro di query usato per selezionare le risposte. No
top_p number Parametro di campionamento del nucleo. Si tratta di un parametro di query usato per selezionare le risposte. No
type enum Tipo di origine dati di esecuzione. Sempre responses.
Valori possibili: responses		 Sì
users array Elenco di identificatori utente. Si tratta di un parametro di query usato per selezionare le risposte. No

OpenAI.EvalRunStoredCompletionsDataContentSource

Una configurazione StoredCompletionsRunDataSource che descrive un set di filtri

Name Tipo Description Obbligatorio Predefinito
creato_dopo Intero Timestamp Unix facoltativo per filtrare gli elementi creati dopo questa volta. No
creato_prima Intero Timestamp Unix facoltativo per filtrare gli elementi creati prima di questa volta. No
limit Intero Numero massimo facoltativo di elementi da restituire. No
metadata object Set di 16 coppie chiave-valore che possono essere collegate a un oggetto . Ciò può essere utile per archiviare informazioni aggiuntive sull'oggetto in un formato strutturato ed eseguire query sugli oggetti tramite API o il dashboard.

Le chiavi sono stringhe con una lunghezza massima di 64 caratteri. I valori sono stringhe con una lunghezza massima di 512 caratteri.		 Sì
model corda Modello facoltativo da filtrare in base a (ad esempio, 'gpt-4o'). No
type enum Tipo di origine. Sempre stored_completions.
Valori possibili: stored_completions		 Sì

OpenAI.EvalStoredCompletionsDataSourceConfigParams

Deprecato a favore di LogsDataSourceConfig.

Name Tipo Description Obbligatorio Predefinito
metadata object Filtri di metadati per l'origine dati di completamento archiviati. No
type enum Tipo di origine dati. Sempre stored_completions.
Valori possibili: stored_completions		 Sì

OpenAI.EvalStoredCompletionsDataSourceConfigResource

Deprecato a favore di LogsDataSourceConfig.

Name Tipo Description Obbligatorio Predefinito
metadata object Set di 16 coppie chiave-valore che possono essere collegate a un oggetto . Ciò può essere utile per archiviare informazioni aggiuntive sull'oggetto in un formato strutturato ed eseguire query sugli oggetti tramite API o il dashboard.

Le chiavi sono stringhe con una lunghezza massima di 64 caratteri. I valori sono stringhe con una lunghezza massima di 512 caratteri.		 Sì
schema object Schema json per gli elementi dell'origine dati di esecuzione.
Informazioni su come creare schemi JSON qui.		 Sì
type enum Tipo di origine dati. Sempre stored_completions.
Valori possibili: stored_completions		 Sì

OpenAI.FileSearchTool

Strumento che cerca il contenuto pertinente dai file caricati.

Name Tipo Description Obbligatorio Predefinito
filters object No
max_num_risultati Intero Numero massimo di risultati da restituire. Questo numero deve essere compreso tra 1 e 50 inclusi. No
opzioni_di_classifica object No
└* ranker enum Ranker da usare per la ricerca di file.
Valori possibili: auto, default-2024-11-15		 No
└─ soglia_punteggio number Soglia del punteggio per la ricerca di file, un numero compreso tra 0 e 1. I numeri più vicini a 1 tenteranno di restituire solo i risultati più rilevanti, ma potrebbero restituire meno risultati. No
type enum Tipo dello strumento di ricerca file. Sempre file_search.
Valori possibili: file_search		 Sì
vector_store_ids array ID degli archivi vettoriali da cercare. Sì

OpenAI.FileSearchToolCallItemParam

Risultati di una chiamata allo strumento di ricerca file.

Name Tipo Description Obbligatorio Predefinito
queries array Query usate per cercare i file. Sì
results array Risultati della chiamata allo strumento di ricerca file. No
type enum
Valori possibili: file_search_call		 Sì

OpenAI.FileSearchToolCallItemResource

Risultati di una chiamata allo strumento di ricerca file.

Name Tipo Description Obbligatorio Predefinito
queries array Query usate per cercare i file. Sì
results array Risultati della chiamata allo strumento di ricerca file. No
stato enum Stato della chiamata allo strumento di ricerca file. Uno di in_progress, searchingincomplete o failed.
Valori possibili: in_progress, searchingcompleted, , incomplete,failed		 Sì
type enum
Valori possibili: file_search_call		 Sì

OpenAI.Filters

Name Tipo Description Obbligatorio Predefinito
filters array Matrice di filtri da combinare. Gli elementi possono essere ComparisonFilter o CompoundFilter. Sì
chiave corda Chiave da confrontare con il valore. Sì
type enum Tipo di operazione: and o or.
Valori possibili: and, or		 Sì
Valore stringa o numero o valore booleano Valore da confrontare con la chiave dell'attributo; supporta tipi stringa, number o booleani. Sì

OpenAI.FineTuneDPOHyperparameters

Iperparametri usati per il processo di ottimizzazione del dpo.

Name Tipo Description Obbligatorio Predefinito
dimensione del batch enum
Valori possibili: auto		 No
beta enum
Valori possibili: auto		 No
moltiplicatore_tasso_apprendimento enum
Valori possibili: auto		 No
numero di epoche enum
Valori possibili: auto		 No

OpenAI.FineTuneDPOMethod

Configurazione per il metodo di ottimizzazione del dpo.

Name Tipo Description Obbligatorio Predefinito
iperparametri OpenAI.FineTuneDPOHyperparameters Iperparametri usati per il processo di ottimizzazione del dpo. No

OpenAI.FineTuneMethod

Metodo utilizzato per l'ottimizzazione.

Name Tipo Description Obbligatorio Predefinito
Dpo OpenAI.FineTuneDPOMethod Configurazione per il metodo di ottimizzazione del dpo. No
Rinforzo AzureFineTuneReinforcementMethod No
vigilato OpenAI.FineTuneSupervisedMethod Configurazione per il metodo di ottimizzazione con supervisione. No
type enum Tipo di metodo. supervisedÈ , dpoo reinforcement.
Valori possibili: supervised, dpo, reinforcement		 Sì

OpenAI.FineTuneReinforcementHyperparameters

Iperparametri usati per il processo di ottimizzazione dell'ottimizzazione per rinforzo.

Name Tipo Description Obbligatorio Predefinito
dimensione del batch enum
Valori possibili: auto		 No
compute_multiplier enum
Valori possibili: auto		 No
eval_interval enum
Valori possibili: auto		 No
eval_samples enum
Valori possibili: auto		 No
moltiplicatore_tasso_apprendimento enum
Valori possibili: auto		 No
numero di epoche enum
Valori possibili: auto		 No
sforzo di ragionamento enum Livello di sforzo di ragionamento.
Valori possibili: default, low, medium, high		 No

OpenAI.FineTuneSupervisedHyperparameters

Iperparametri usati per il processo di ottimizzazione.

Name Tipo Description Obbligatorio Predefinito
dimensione del batch enum
Valori possibili: auto		 No
moltiplicatore_tasso_apprendimento enum
Valori possibili: auto		 No
numero di epoche enum
Valori possibili: auto		 No

OpenAI.FineTuneSupervisedMethod

Configurazione per il metodo di ottimizzazione con supervisione.

Name Tipo Description Obbligatorio Predefinito
iperparametri OpenAI.FineTuneSupervisedHyperparameters Iperparametri usati per il processo di ottimizzazione. No

OpenAI.FineTuningIntegration

Discriminante per OpenAI.FineTuningIntegration

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

Valore del tipo Schema
wandb OpenAI.FineTuningIntegrationWandb
Name Tipo Description Obbligatorio Predefinito
type string (vedere modelli validi di seguito) Sì

OpenAI.FineTuningIntegrationWandb

Name Tipo Description Obbligatorio Predefinito
type enum Tipo dell'integrazione abilitata per il processo di ottimizzazione.
Valori possibili: wandb		 Sì
wandb object Le impostazioni per l'integrazione con Weights e Biases. Questo payload specifica il progetto a cui verranno inviate le metriche. Facoltativamente, è possibile impostare un nome visualizzato esplicito per l'esecuzione, aggiungere tag all'esecuzione e impostare un'entità predefinita (team, nome utente e così via) da associare all'esecuzione. Sì
└─ Entità corda Entità da usare per l'esecuzione. In questo modo è possibile impostare il team o il nome utente dell'utente WandB che si desidera associare all'esecuzione. Se non è impostata, viene usata l'entità predefinita per la chiave API WandB registrata. No
└> nome corda Nome visualizzato da impostare per l'esecuzione. Se non è impostato, verrà usato l'ID processo come nome. No
└─ progetto corda Nome del progetto in cui verrà creata la nuova esecuzione. No
└* tag array Elenco di tag da associare all'esecuzione appena creata. Questi tag vengono passati direttamente a WandB. Alcuni tag predefiniti vengono generati da OpenAI: "openai/finetune", "openai/{base-model}", "openai/{ftjob-abcdef}". No

OpenAI.FineTuningJob

L'oggetto fine_tuning.job rappresenta un processo di ottimizzazione che è stato creato tramite l'API.

Name Tipo Description Obbligatorio Predefinito
creato_il Intero Timestamp Unix (in secondi) per il momento in cui è stato creato il processo di ottimizzazione. Sì
Errore object Per i processi di ottimizzazione con failed, sono disponibili altre informazioni sulla causa dell'errore. Sì
└─ codice corda Codice di errore leggibile dal computer. No
└* messaggio corda Messaggio di errore leggibile. No
└* param corda Parametro non valido, in genere training_file o validation_file. Questo campo sarà Null se l'errore non era specifico del parametro. No
completamento stimato Intero Timestamp Unix (in secondi) per il completamento del processo di ottimizzazione. Il valore sarà Null se il processo di ottimizzazione non è in esecuzione. No
modello ottimizzato corda Nome del modello ottimizzato da creare. Il valore sarà Null se il processo di ottimizzazione è ancora in esecuzione. Sì
terminato_il Intero Timestamp Unix (in secondi) per il completamento del processo di ottimizzazione. Il valore sarà Null se il processo di ottimizzazione è ancora in esecuzione. Sì
iperparametri object Iperparametri usati per il processo di ottimizzazione. Questo valore verrà restituito solo durante l'esecuzione di supervised processi. Sì
└batch_size enum
Valori possibili: auto		 No
└learning_rate_multiplier enum
Valori possibili: auto		 No
└n_epochs enum
Valori possibili: auto		 No
id corda Identificatore dell'oggetto a cui è possibile fare riferimento negli endpoint API. Sì
integrazioni array Elenco di integrazioni da abilitare per questo processo di ottimizzazione. No
metadata object Set di 16 coppie chiave-valore che possono essere collegate a un oggetto . Ciò può essere utile per archiviare informazioni aggiuntive sull'oggetto in un formato strutturato ed eseguire query sugli oggetti tramite API o il dashboard.

Le chiavi sono stringhe con una lunghezza massima di 64 caratteri. I valori sono stringhe con una lunghezza massima di 512 caratteri.		 Sì
method OpenAI.FineTuneMethod Metodo utilizzato per l'ottimizzazione. No
model corda Modello di base ottimizzato. Sì
object enum Tipo di oggetto, che è sempre "fine_tuning.job".
Valori possibili: fine_tuning.job		 Sì
organization_id corda Organizzazione proprietaria del processo di ottimizzazione. Sì
file_di_risultato array ID file di risultati compilati per il processo di ottimizzazione. È possibile recuperare i risultati con l'API Files. Sì
seed Intero Valore di inizializzazione utilizzato per il processo di ottimizzazione. Sì
stato enum Stato corrente del processo di ottimizzazione, che può essere validating_files, queuedrunningsucceededfailedo .cancelled
Valori possibili: validating_files, queuedrunning, succeeded, , failedcancelled		 Sì
trained_tokens Intero Numero totale di token fatturabili elaborati da questo processo di ottimizzazione. Il valore sarà Null se il processo di ottimizzazione è ancora in esecuzione. Sì
file di allenamento corda ID file utilizzato per il training. È possibile recuperare i dati di training con l'API Files. Sì
user_provided_suffix corda Suffisso descrittivo applicato al processo, come specificato nella richiesta di creazione del processo. No
file_di_validazione corda ID file utilizzato per la convalida. È possibile recuperare i risultati della convalida con l'API Files. Sì

OpenAI.FineTuningJobCheckpoint

L'oggetto fine_tuning.job.checkpoint rappresenta un checkpoint del modello per un processo di ottimizzazione pronto per l'uso.

Name Tipo Description Obbligatorio Predefinito
creato_il Intero Timestamp Unix (in secondi) per il momento in cui è stato creato il checkpoint. Sì
punto_di_controllo_modello_ottimizzato corda Nome del modello di checkpoint ottimizzato creato. Sì
id_lavoro_affinamento corda Nome del processo di ottimizzazione da cui è stato creato il checkpoint. Sì
id corda Identificatore del checkpoint, a cui è possibile fare riferimento negli endpoint API. Sì
metrics object Metriche nel numero di passaggio durante il processo di ottimizzazione. Sì
└full_valid_loss number No
└full_valid_mean_token_accuracy number No
└* passaggio number No
└train_loss number No
└train_mean_token_accuracy number No
└valid_loss number No
└valid_mean_token_accuracy number No
object enum Tipo di oggetto, che è sempre "fine_tuning.job.checkpoint".
Valori possibili: fine_tuning.job.checkpoint		 Sì
numero_passaggio Intero Numero di passaggio in cui è stato creato il checkpoint. Sì

OpenAI.FineTuningJobEvent

Oggetto evento processo di ottimizzazione

Name Tipo Description Obbligatorio Predefinito
creato_il Intero Timestamp Unix (in secondi) per il momento in cui è stato creato il processo di ottimizzazione. Sì
Dati Dati associati all'evento. No
id corda Identificatore dell'oggetto. Sì
level enum Livello di log dell'evento.
Valori possibili: info, warn, error		 Sì
message corda Messaggio dell'evento. Sì
object enum Tipo di oggetto, che è sempre "fine_tuning.job.event".
Valori possibili: fine_tuning.job.event		 Sì
type enum Tipo di evento.
Valori possibili: message, metrics		 No

OpenAI.FunctionObject

Name Tipo Description Obbligatorio Predefinito
description corda Descrizione delle operazioni della funzione, usate dal modello per scegliere quando e come chiamare la funzione. No
name corda Nome della funzione da chiamare. Deve essere a-z, A-Z, 0-9 o contenere caratteri di sottolineatura e trattini, con una lunghezza massima di 64. Sì
parameters I parametri accettati dalle funzioni, descritti come oggetto Schema JSON. No
rigido 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 parameters campo . Solo un subset di schema JSON è supportato quando strict è true. No Falso

OpenAI.FunctionTool

Definisce una funzione nel codice personalizzato che il modello può scegliere di chiamare.

Name Tipo Description Obbligatorio Predefinito
description corda Descrizione della funzione. Utilizzato dal modello per determinare se chiamare o meno la funzione. No
name corda Nome della funzione da chiamare. Sì
parameters Oggetto schema JSON che descrive i parametri della funzione. Sì
rigido Boolean Indica se applicare la convalida rigorosa dei parametri. Valore predefinito true. Sì
type enum Tipo dello strumento funzione. Sempre function.
Valori possibili: function		 Sì

OpenAI.FunctionToolCallItemParam

Chiamata di uno strumento per eseguire una funzione.

Name Tipo Description Obbligatorio Predefinito
arguments corda Stringa JSON degli argomenti da passare alla funzione. Sì
call_id corda ID univoco della chiamata dello strumento di funzione generata dal modello. Sì
name corda Nome della funzione da eseguire. Sì
type enum
Valori possibili: function_call		 Sì

OpenAI.FunctionToolCallItemResource

Chiamata di uno strumento per eseguire una funzione.

Name Tipo Description Obbligatorio Predefinito
arguments corda Stringa JSON degli argomenti da passare alla funzione. Sì
call_id corda ID univoco della chiamata dello strumento di funzione generata dal modello. Sì
name corda Nome della funzione da eseguire. Sì
stato enum Stato dell'elemento. Uno di in_progress, completedo incomplete. Popolato quando gli elementi vengono restituiti tramite API.
Valori possibili: in_progress, completed, incomplete		 Sì
type enum
Valori possibili: function_call		 Sì

OpenAI.FunctionToolCallOutputItemParam

Output di una chiamata dello strumento di funzione.

Name Tipo Description Obbligatorio Predefinito
call_id corda ID univoco della chiamata dello strumento di funzione generata dal modello. Sì
output corda Stringa JSON dell'output della chiamata dello strumento di funzione. Sì
type enum
Valori possibili: function_call_output		 Sì

OpenAI.FunctionToolCallOutputItemResource

Output di una chiamata dello strumento di funzione.

Name Tipo Description Obbligatorio Predefinito
call_id corda ID univoco della chiamata dello strumento di funzione generata dal modello. Sì
output corda Stringa JSON dell'output della chiamata dello strumento di funzione. Sì
stato enum Stato dell'elemento. Uno di in_progress, completedo incomplete. Popolato quando gli elementi vengono restituiti tramite API.
Valori possibili: in_progress, completed, incomplete		 Sì
type enum
Valori possibili: function_call_output		 Sì

OpenAI.Grader

Discriminante per OpenAI.Grader

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

Valore del tipo Schema
label_model OpenAI.GraderLabelModel
text_similarity OpenAI.GraderTextSimilarity
python OpenAI.GraderPython
score_model OpenAI.GraderScoreModel
multi OpenAI.GraderMulti
Name Tipo Description Obbligatorio Predefinito
type OpenAI.GraderType Sì

OpenAI.GraderLabelModel

Oggetto LabelModelGrader che usa un modello per assegnare etichette a ogni elemento della valutazione.

Name Tipo Description Obbligatorio Predefinito
input array Sì
labels array Etichette da assegnare a ogni elemento della valutazione. Sì
model corda Modello da utilizzare per la valutazione. Deve supportare output strutturati. Sì
name corda Nome del grader. Sì
etichette_di_passaggio array Etichette che indicano un risultato di passaggio. Deve essere un subset di etichette. Sì
type enum Tipo di oggetto, che è sempre label_model.
Valori possibili: label_model		 Sì

OpenAI.GraderMulti

Un oggetto MultiGrader combina l'output di più classificatori per produrre un singolo punteggio.

Name Tipo Description Obbligatorio Predefinito
calculate_output corda Formula per calcolare l'output in base ai risultati del grader. Sì
Livellatrici object Sì
name corda Nome del grader. Sì
type enum Tipo di oggetto, che è sempre multi.
Valori possibili: multi		 Sì

OpenAI.GraderPython

Oggetto PythonGrader che esegue uno script Python nell'input.

Name Tipo Description Obbligatorio Predefinito
image_tag corda Tag immagine da usare per lo script Python. No
name corda Nome del grader. Sì
source corda Codice sorgente dello script Python. Sì
type enum Tipo di oggetto, che è sempre python.
Valori possibili: python		 Sì

OpenAI.GraderScoreModel

Oggetto ScoreModelGrader che usa un modello per assegnare un punteggio all'input.

Name Tipo Description Obbligatorio Predefinito
input array Testo di input. Ciò può includere stringhe di modello. Sì
model corda Modello da utilizzare per la valutazione. Sì
name corda Nome del grader. Sì
intervallo array Intervallo del punteggio. Il valore predefinito è [0, 1]. No
sampling_params Parametri di campionamento per il modello. No
type enum Tipo di oggetto, che è sempre score_model.
Valori possibili: score_model		 Sì

OpenAI.GraderStringCheck

Oggetto StringCheckGrader che esegue un confronto di stringhe tra input e riferimento usando un'operazione specificata.

Name Tipo Description Obbligatorio Predefinito
input corda Testo di input. Ciò può includere stringhe di modello. Sì
name corda Nome del grader. Sì
operazione enum Operazione di controllo della stringa da eseguire. Uno di eq, ne, likeo ilike.
Valori possibili: eq, ne, like, ilike		 Sì
riferimento corda Testo di riferimento. Ciò può includere stringhe di modello. Sì
type enum Tipo di oggetto, che è sempre string_check.
Valori possibili: string_check		 Sì

OpenAI.GraderTextSimilarity

Oggetto TextSimilarityGrader che assegna un grado al testo in base alle metriche di somiglianza.

Name Tipo Description Obbligatorio Predefinito
metrica di valutazione enum Metrica di valutazione da usare. Uno di fuzzy_match, bleugleu, meteor, rouge_1, rouge_2, rouge_3, rouge_4, , rouge_5o rouge_l.
Valori possibili: fuzzy_match, bleu, gleumeteor, rouge_1, rouge_2, rouge_3, rouge_4, rouge_5rouge_l		 Sì
input corda Testo classificato. Sì
name corda Nome del grader. Sì
riferimento corda Testo a cui viene eseguito il voto. Sì
type enum Tipo di grader.
Valori possibili: text_similarity		 Sì

OpenAI.GraderType

Proprietà Value
Type corda
Valori string_check
text_similarity
score_model
label_model
python
multi

OpenAI.ImageGenTool

Strumento che genera immagini usando un modello come gpt-image-1.5.

Name Tipo Description Obbligatorio Predefinito
sfondo enum Solo GPT-image-1: tipo di sfondo per l'immagine generata. Uno di transparent, opaqueo auto. Impostazione predefinita: auto.
Valori possibili: transparent, opaque, auto		 No
input_image_mask object Maschera facoltativa per l'inpainting. Contiene image_url (stringa, facoltativa) e file_id (stringa, facoltativa). No
└ file_id corda ID file per l'immagine della maschera. No
└ image_url corda Immagine maschera con codifica Base64. No
model enum Modello di generazione di immagini da usare. Impostazione predefinita: gpt-image-1.
Valori possibili: gpt-image-1, gpt-image-1.5, gpt-image-2		 No
Moderazione enum Livello di moderazione per l'immagine generata. Impostazione predefinita: auto.
Valori possibili: auto, low		 No
Compressione dell'output Intero Livello di compressione per l'immagine di output. Impostazione predefinita: 100. No 100
formato_di_output enum Formato di output dell'immagine generata. Uno di png, webpo jpeg. Impostazione predefinita: png.
Valori possibili: png, webp, jpeg		 No
immagini parziali Intero Numero di immagini parziali da generare in modalità di streaming, da 0 (valore predefinito) a 3. No 0
qualità enum Qualità dell'immagine generata. Uno di low, medium, higho auto. Impostazione predefinita: auto.
Valori possibili: low, medium, high, auto		 No
size enum Dimensioni dell'immagine generata. Uno di 1024x1024, 1024x1536, 1536x1024o auto. Impostazione predefinita: auto.
Valori possibili: 1024x1024, 1024x1536, 1536x1024, auto		 No
type enum Tipo dello strumento di generazione di immagini. Sempre image_generation.
Valori possibili: image_generation		 Sì

OpenAI.ImageGenToolCallItemParam

Richiesta di generazione di immagini effettuata dal modello.

Name Tipo Description Obbligatorio Predefinito
result corda Immagine generata codificata in base64. Sì
type enum
Valori possibili: image_generation_call		 Sì

OpenAI.ImageGenToolCallItemResource

Richiesta di generazione di immagini effettuata dal modello.

Name Tipo Description Obbligatorio Predefinito
result corda Immagine generata codificata in base64. Sì
stato enum
Valori possibili: in_progress, completed, generating, failed		 Sì
type enum
Valori possibili: image_generation_call		 Sì

OpenAI.ImplicitUserMessage

Name Tipo Description Obbligatorio Predefinito
contenuto stringa o matrice Sì

OpenAI.Includable

Specificare dati di output aggiuntivi da includere nella risposta del modello. I valori attualmente supportati sono:

  • code_interpreter_call.outputs: include gli output dell'esecuzione del codice Python negli elementi di chiamata dello strumento dell'interprete del codice.
  • computer_call_output.output.image_url: includere gli URL dell'immagine dall'output delle chiamate al computer.
  • file_search_call.results: includere i risultati della ricerca della chiamata allo strumento di ricerca file.
  • message.input_image.image_url: includere gli URL dell'immagine dal messaggio di input.
  • message.output_text.logprobs: includere logprobs con messaggi di assistente.
  • reasoning.encrypted_content: include una versione crittografata dei token di ragionamento negli output degli elementi di ragionamento. Ciò consente di usare gli elementi di ragionamento nelle conversazioni a più turni quando si usa l'API Risposte senza stato (ad esempio quando il store parametro è impostato su falseo quando un'organizzazione viene registrata nel programma di conservazione dei dati zero).
Proprietà Value
Descrizione Specificare dati di output aggiuntivi da includere nella risposta del modello. I valori attualmente supportati sono:
- code_interpreter_call.outputs: include gli output dell'esecuzione del codice Python negli elementi di chiamata dello strumento dell'interprete del codice.
- computer_call_output.output.image_url: includere gli URL dell'immagine dall'output delle chiamate al computer.
- file_search_call.results: includere i risultati della ricerca della chiamata allo strumento di ricerca file.
- message.input_image.image_url: includere gli URL dell'immagine dal messaggio di input.
- message.output_text.logprobs: includere logprobs con messaggi di assistente.
- reasoning.encrypted_content: include una versione crittografata dei token di ragionamento negli output degli elementi di ragionamento. Ciò consente di usare gli elementi di ragionamento nelle conversazioni a più turni quando si usa l'API Risposte senza stato (ad esempio quando il store parametro è impostato su falseo quando un'organizzazione viene registrata nel programma di conservazione dei dati zero).
Type corda
Valori code_interpreter_call.outputs
computer_call_output.output.image_url
file_search_call.results
message.input_image.image_url
message.output_text.logprobs
reasoning.encrypted_content

OpenAI.ItemContent

Discriminare per OpenAI.ItemContent

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

Valore del tipo Schema
input_audio OpenAI.ItemContentInputAudio
output_audio OpenAI.ItemContentOutputAudio
refusal OpenAI.ItemContentRefusal
input_text OpenAI.ItemContentInputText
input_image OpenAI.ItemContentInputImage
input_file OpenAI.ItemContentInputFile
output_text OpenAI.ItemContentOutputText
Name Tipo Description Obbligatorio Predefinito
type OpenAI.ItemContentType Contenuto di input e output multi modale. Sì

OpenAI.ItemContentInputAudio

Input audio per il modello.

Name Tipo Description Obbligatorio Predefinito
Dati corda Dati audio con codifica Base64. Sì
format enum Formato dei dati audio. I formati attualmente supportati sono mp3 e wav.
Valori possibili: mp3, wav		 Sì
type enum Tipo dell'elemento di input. Sempre input_audio.
Valori possibili: input_audio		 Sì

OpenAI.ItemContentInputFile

Input di file per il modello.

Name Tipo Description Obbligatorio Predefinito
file_data corda Contenuto del file da inviare al modello. No
ID del file corda ID del file da inviare al modello. No
filename corda Nome del file da inviare al modello. No
type enum Tipo dell'elemento di input. Sempre input_file.
Valori possibili: input_file		 Sì

OpenAI.ItemContentInputImage

Input dell'immagine per il modello.

Name Tipo Description Obbligatorio Predefinito
Dettaglio enum Livello di dettaglio dell'immagine da inviare al modello. Uno di high, lowo auto. Il valore predefinito è auto.
Valori possibili: low, high, auto		 No
ID del file corda ID del file da inviare al modello. No
image_url corda URL dell'immagine da inviare al modello. UN URL completo o un'immagine con codifica Base64 in un URL dati. No
type enum Tipo dell'elemento di input. Sempre input_image.
Valori possibili: input_image		 Sì

OpenAI.ItemContentInputText

Input di testo per il modello.

Name Tipo Description Obbligatorio Predefinito
text corda Input di testo per il modello. Sì
type enum Tipo dell'elemento di input. Sempre input_text.
Valori possibili: input_text		 Sì

OpenAI.ItemContentOutputAudio

Output audio del modello.

Name Tipo Description Obbligatorio Predefinito
Dati corda Dati audio con codifica Base64 dal modello. Sì
Trascrizione corda Trascrizione dei dati audio del modello. Sì
type enum Tipo di audio di output. Sempre output_audio.
Valori possibili: output_audio		 Sì

OpenAI.ItemContentOutputText

Output di testo del modello.

Name Tipo Description Obbligatorio Predefinito
annotations array Annotazioni dell'output di testo. Sì
logprobs array No
text corda Output di testo del modello. Sì
type enum Tipo del testo di output. Sempre output_text.
Valori possibili: output_text		 Sì

OpenAI.ItemContentRefusal

Rifiuto del modello.

Name Tipo Description Obbligatorio Predefinito
refusal corda Spiegazione del rifiuto dal modello. Sì
type enum Tipo di rifiuto. Sempre refusal.
Valori possibili: refusal		 Sì

OpenAI.ItemContentType

Contenuto di input e output multi modale.

Proprietà Value
Descrizione Contenuto di input e output multi modale.
Type corda
Valori input_text
input_audio
input_image
input_file
output_text
output_audio
refusal

OpenAI.ItemParam

Elemento di contenuto usato per generare una risposta.

Discriminare per OpenAI.ItemParam

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

Valore del tipo Schema
file_search_call OpenAI.FileSearchToolCallItemParam
computer_call OpenAI.ComputerToolCallItemParam
computer_call_output OpenAI.ComputerToolCallOutputItemParam
web_search_call OpenAI.WebSearchToolCallItemParam
function_call OpenAI.FunctionToolCallItemParam
function_call_output OpenAI.FunctionToolCallOutputItemParam
reasoning OpenAI.ReasoningItemParam
item_reference OpenAI.ItemReferenceItemParam
image_generation_call OpenAI.ImageGenToolCallItemParam
code_interpreter_call OpenAI.CodeInterpreterToolCallItemParam
local_shell_call OpenAI.LocalShellToolCallItemParam
local_shell_call_output OpenAI.LocalShellToolCallOutputItemParam
mcp_list_tools OpenAI.MCPListToolsItemParam
mcp_approval_request OpenAI.MCPApprovalRequestItemParam
mcp_approval_response OpenAI.MCPApprovalResponseItemParam
mcp_call OpenAI.MCPCallItemParam
message OpenAI.ResponsesMessageItemParam
Name Tipo Description Obbligatorio Predefinito
type OpenAI.ItemType Sì

OpenAI.ItemReferenceItemParam

Identificatore interno di un elemento a cui fare riferimento.

Name Tipo Description Obbligatorio Predefinito
id corda ID originato dal servizio dell'elemento di risposta generato in precedenza a cui viene fatto riferimento. Sì
type enum
Valori possibili: item_reference		 Sì

OpenAI.ItemResource

Elemento di contenuto usato per generare una risposta.

Discriminatorio per OpenAI.ItemResource

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

Valore del tipo Schema
file_search_call OpenAI.FileSearchToolCallItemResource
computer_call OpenAI.ComputerToolCallItemResource
computer_call_output OpenAI.ComputerToolCallOutputItemResource
web_search_call OpenAI.WebSearchToolCallItemResource
function_call OpenAI.FunctionToolCallItemResource
function_call_output OpenAI.FunctionToolCallOutputItemResource
reasoning OpenAI.ReasoningItemResource
image_generation_call OpenAI.ImageGenToolCallItemResource
code_interpreter_call OpenAI.CodeInterpreterToolCallItemResource
local_shell_call OpenAI.LocalShellToolCallItemResource
local_shell_call_output OpenAI.LocalShellToolCallOutputItemResource
mcp_list_tools OpenAI.MCPListToolsItemResource
mcp_approval_request OpenAI.MCPApprovalRequestItemResource
mcp_approval_response OpenAI.MCPApprovalResponseItemResource
mcp_call OpenAI.MCPCallItemResource
message OpenAI.ResponsesMessageItemResource
Name Tipo Description Obbligatorio Predefinito
id corda Sì
type OpenAI.ItemType Sì

OpenAI.ItemType

Proprietà Value
Type corda
Valori message
file_search_call
function_call
function_call_output
computer_call
computer_call_output
web_search_call
reasoning
item_reference
image_generation_call
code_interpreter_call
local_shell_call
local_shell_call_output
mcp_list_tools
mcp_approval_request
mcp_approval_response
mcp_call

OpenAI.ListFineTuningJobCheckpointsResponse

Name Tipo Description Obbligatorio Predefinito
Dati array Sì
first_id corda No
ha_di_piu Boolean Sì
last_id corda No
object enum
Valori possibili: list		 Sì

OpenAI.ListFineTuningJobEventsResponse

Name Tipo Description Obbligatorio Predefinito
Dati array Sì
ha_di_piu Boolean Sì
object enum
Valori possibili: list		 Sì

OpenAI.ListModelsResponse

Name Tipo Description Obbligatorio Predefinito
Dati array Sì
object enum
Valori possibili: list		 Sì

OpenAI.ListPaginatedFineTuningJobsResponse

Name Tipo Description Obbligatorio Predefinito
Dati array Sì
ha_di_piu Boolean Sì
object enum
Valori possibili: list		 Sì

OpenAI.ListVectorStoreFilesFilter

Proprietà Value
Type corda
Valori in_progress
completed
failed
cancelled

OpenAI.ListVectorStoreFilesResponse

Name Tipo Description Obbligatorio Predefinito
Dati array Sì
first_id corda Sì
ha_di_piu Boolean Sì
last_id corda Sì
object enum
Valori possibili: list		 Sì

OpenAI.ListVectorStoresResponse

Name Tipo Description Obbligatorio Predefinito
Dati array Sì
first_id corda Sì
ha_di_piu Boolean Sì
last_id corda Sì
object enum
Valori possibili: list		 Sì

OpenAI.LocalShellExecAction

Eseguire un comando shell nel server.

Name Tipo Description Obbligatorio Predefinito
Comando array Comando da eseguire. Sì
Env object Variabili di ambiente da impostare per il comando. Sì
timeout_ms Intero Timeout facoltativo in millisecondi per il comando. No
type enum Tipo dell'azione della shell locale. Sempre exec.
Valori possibili: exec		 Sì
user corda Utente facoltativo per eseguire il comando come. No
working_directory corda Directory di lavoro facoltativa in cui eseguire il comando. No

OpenAI.LocalShellTool

Strumento che consente al modello di eseguire comandi della shell in un ambiente locale.

Name Tipo Description Obbligatorio Predefinito
type enum Tipo dello strumento della shell locale. Sempre local_shell.
Valori possibili: local_shell		 Sì

OpenAI.LocalShellToolCallItemParam

Chiamata dello strumento per eseguire un comando nella shell locale.

Name Tipo Description Obbligatorio Predefinito
azione OpenAI.LocalShellExecAction Eseguire un comando shell nel server. Sì
call_id corda ID univoco della chiamata dello strumento shell locale generata dal modello. Sì
type enum
Valori possibili: local_shell_call		 Sì

OpenAI.LocalShellToolCallItemResource

Chiamata dello strumento per eseguire un comando nella shell locale.

Name Tipo Description Obbligatorio Predefinito
azione OpenAI.LocalShellExecAction Eseguire un comando shell nel server. Sì
call_id corda ID univoco della chiamata dello strumento shell locale generata dal modello. Sì
stato enum
Valori possibili: in_progress, completed, incomplete		 Sì
type enum
Valori possibili: local_shell_call		 Sì

OpenAI.LocalShellToolCallOutputItemParam

Output di una chiamata allo strumento shell locale.

Name Tipo Description Obbligatorio Predefinito
output corda Stringa JSON dell'output della chiamata allo strumento shell locale. Sì
type enum
Valori possibili: local_shell_call_output		 Sì

OpenAI.LocalShellToolCallOutputItemResource

Output di una chiamata allo strumento shell locale.

Name Tipo Description Obbligatorio Predefinito
output corda Stringa JSON dell'output della chiamata allo strumento shell locale. Sì
stato enum
Valori possibili: in_progress, completed, incomplete		 Sì
type enum
Valori possibili: local_shell_call_output		 Sì

OpenAI.Location

Discriminare per OpenAI.Location

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

Valore del tipo Schema
approximate OpenAI.ApproximateLocation
Name Tipo Description Obbligatorio Predefinito
type OpenAI.LocationType Sì

OpenAI.LocationType

Proprietà Value
Type corda
Valori approximate

OpenAI.LogProb

Probabilità del log di un token.

Name Tipo Description Obbligatorio Predefinito
bytes array Sì
logprob number Sì
Token corda Sì
top_logprobs array Sì

OpenAI.MCPApprovalRequestItemParam

Richiesta di approvazione umana di una chiamata a uno strumento.

Name Tipo Description Obbligatorio Predefinito
arguments corda Stringa JSON di argomenti per lo strumento. Sì
name corda Nome dello strumento da eseguire. Sì
etichetta del server corda Etichetta del server MCP che effettua la richiesta. Sì
type enum
Valori possibili: mcp_approval_request		 Sì

OpenAI.MCPApprovalRequestItemResource

Richiesta di approvazione umana di una chiamata a uno strumento.

Name Tipo Description Obbligatorio Predefinito
arguments corda Stringa JSON di argomenti per lo strumento. Sì
name corda Nome dello strumento da eseguire. Sì
etichetta del server corda Etichetta del server MCP che effettua la richiesta. Sì
type enum
Valori possibili: mcp_approval_request		 Sì

OpenAI.MCPApprovalResponseItemParam

Risposta a una richiesta di approvazione MCP.

Name Tipo Description Obbligatorio Predefinito
approval_request_id corda ID della richiesta di approvazione a cui viene inviata la risposta. Sì
approve Boolean Indica se la richiesta è stata approvata. Sì
reason corda Motivo facoltativo della decisione. No
type enum
Valori possibili: mcp_approval_response		 Sì

OpenAI.MCPApprovalResponseItemResource

Risposta a una richiesta di approvazione MCP.

Name Tipo Description Obbligatorio Predefinito
approval_request_id corda ID della richiesta di approvazione a cui viene inviata la risposta. Sì
approve Boolean Indica se la richiesta è stata approvata. Sì
reason corda Motivo facoltativo della decisione. No
type enum
Valori possibili: mcp_approval_response		 Sì

OpenAI.MCPCallItemParam

Chiamata di uno strumento in un server MCP.

Name Tipo Description Obbligatorio Predefinito
arguments corda Stringa JSON degli argomenti passati allo strumento. Sì
Errore corda Errore della chiamata allo strumento, se presente. No
name corda Nome dello strumento eseguito. Sì
output corda Output della chiamata allo strumento. No
etichetta del server corda Etichetta del server MCP che esegue lo strumento. Sì
type enum
Valori possibili: mcp_call		 Sì

OpenAI.MCPCallItemResource

Chiamata di uno strumento in un server MCP.

Name Tipo Description Obbligatorio Predefinito
arguments corda Stringa JSON degli argomenti passati allo strumento. Sì
Errore corda Errore della chiamata allo strumento, se presente. No
name corda Nome dello strumento eseguito. Sì
output corda Output della chiamata allo strumento. No
etichetta del server corda Etichetta del server MCP che esegue lo strumento. Sì
type enum
Valori possibili: mcp_call		 Sì

OpenAI.MCPListToolsItemParam

Elenco di strumenti disponibili in un server MCP.

Name Tipo Description Obbligatorio Predefinito
Errore corda Messaggio di errore se il server non è riuscito ad elencare gli strumenti. No
etichetta del server corda Etichetta del server MCP. Sì
Strumenti array Strumenti disponibili nel server. Sì
type enum
Valori possibili: mcp_list_tools		 Sì

OpenAI.MCPListToolsItemResource

Elenco di strumenti disponibili in un server MCP.

Name Tipo Description Obbligatorio Predefinito
Errore corda Messaggio di errore se il server non è riuscito ad elencare gli strumenti. No
etichetta del server corda Etichetta del server MCP. Sì
Strumenti array Strumenti disponibili nel server. Sì
type enum
Valori possibili: mcp_list_tools		 Sì

OpenAI.MCPListToolsTool

Strumento disponibile in un server MCP.

Name Tipo Description Obbligatorio Predefinito
annotations Annotazioni aggiuntive sullo strumento. No
description corda Descrizione dello strumento. No
input_schema Schema JSON che descrive l'input dello strumento. Sì
name corda Nome dello strumento. Sì

OpenAI.MCPTool

Concedere al modello l'accesso a strumenti aggiuntivi tramite server MCP (Model Context Protocol) remoti.

Name Tipo Description Obbligatorio Predefinito
strumenti consentiti object No
└tool_names array Elenco dei nomi degli strumenti consentiti. No
headers object Intestazioni HTTP facoltative da inviare al server MCP. Usare per l'autenticazione o altri scopi. No
richiedere_approvazione oggetto (vedere modelli validi di seguito) Specificare quale degli strumenti del server MCP richiede l'approvazione. No
etichetta del server corda Etichetta per questo server MCP, usata per identificarla nelle chiamate degli strumenti. Sì
URL del server corda URL del server MCP. Sì
type enum Tipo dello strumento MCP. Sempre mcp.
Valori possibili: mcp		 Sì

OpenAI.MetadataPropertyForRequest

Set di 16 coppie chiave-valore che possono essere collegate a un oggetto . Ciò può essere utile per archiviare informazioni aggiuntive sull'oggetto in un formato strutturato ed eseguire query sugli oggetti tramite API o il dashboard.

Le chiavi sono stringhe con una lunghezza massima di 64 caratteri. I valori sono stringhe con una lunghezza massima di 512 caratteri.

Name Tipo Description Obbligatorio Predefinito
metadata object Set di 16 coppie chiave-valore che possono essere collegate a un oggetto . Ciò può essere utile per archiviare informazioni aggiuntive sull'oggetto in un formato strutturato ed eseguire query sugli oggetti tramite API o il dashboard.

Le chiavi sono stringhe con una lunghezza massima di 64 caratteri. I valori sono stringhe con una lunghezza massima di 512 caratteri.		 No

OpenAI.Model

Descrive un'offerta di modello OpenAI che può essere usata con l'API.

Name Tipo Description Obbligatorio Predefinito
creato Intero Timestamp Unix (in secondi) al momento della creazione del modello. Sì
id corda Identificatore del modello, a cui è possibile fare riferimento negli endpoint API. Sì
object enum Tipo di oggetto, che è sempre "model".
Valori possibili: model		 Sì
owned_by corda Organizzazione proprietaria del modello. Sì

OpenAI.OtherChunkingStrategyResponseParam

Viene restituito quando la strategia di suddivisione in blocchi è sconosciuta. In genere, ciò è dovuto al fatto che il file è stato indicizzato prima dell'introduzione del chunking_strategy concetto nell'API.

Name Tipo Description Obbligatorio Predefinito
type enum Sempre other.
Valori possibili: other		 Sì

OpenAI.ParallelToolCalls

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

Tipo: booleano

OpenAI.Prompt

Riferimento a un modello di richiesta e alle relative variabili.

Name Tipo Description Obbligatorio Predefinito
id corda Identificatore univoco del modello di richiesta da usare. Sì
variables object Mapping facoltativo dei valori da sostituire con le variabili nel prompt. I valori di sostituzione possono essere stringhe o altri tipi di input response, ad esempio immagini o file. No
versione corda Versione facoltativa del modello di richiesta. No

OpenAI.OpzioniDiClassifica

Name Tipo Description Obbligatorio Predefinito
classificatore enum Ranker da usare per la ricerca di file.
Valori possibili: auto, default-2024-11-15		 No
soglia_punteggio number Soglia del punteggio per la ricerca di file, un numero compreso tra 0 e 1. I numeri più vicini a 1 tenteranno di restituire solo i risultati più rilevanti, ma potrebbero restituire meno risultati. No

OpenAI.Reasoning

Solo modelli di serie o

Name Tipo Description Obbligatorio Predefinito
effort object Solo modelli di serie o

Vincola lo sforzo sul ragionamento per i modelli di ragionamento.
I valori attualmente supportati sono low, mediume high. La riduzione del lavoro di ragionamento può comportare risposte più veloci e un minor numero di token usati per il ragionamento in una risposta.		 No
generate_summary enum Deprecato: usare summary invece.

Riepilogo del ragionamento eseguito dal modello. Ciò può essere utile per eseguire il debug e comprendere il processo di ragionamento del modello.
Uno di auto, conciseo detailed.
Valori possibili: auto, concise, detailed		 No
summary enum Riepilogo del ragionamento eseguito dal modello. Ciò può essere utile per eseguire il debug e comprendere il processo di ragionamento del modello.
Uno di auto, conciseo detailed.
Valori possibili: auto, concise, detailed		 No

Sforzo di Ragionamento OpenAI

Solo modelli di serie o

Vincola lo sforzo sul ragionamento per i modelli di ragionamento. I valori attualmente supportati sono low, mediume high. La riduzione del lavoro di ragionamento può comportare risposte più veloci e un minor numero di token usati per il ragionamento in una risposta.

Proprietà Value
Descrizione Solo modelli di serie o

Vincola lo sforzo sul ragionamento per i modelli di ragionamento.
I valori attualmente supportati sono low, mediume high. La riduzione del lavoro di ragionamento può comportare risposte più veloci e un minor numero di token usati per il ragionamento in una risposta.
Type corda
Valori low
medium
high

OpenAI.ReasoningItemParam

Descrizione della catena di pensiero usata da un modello di ragionamento durante la generazione di una risposta. Assicurarsi di includere questi elementi nell'API input Risposte per i turni successivi di una conversazione se si gestisce manualmente il contesto.

Name Tipo Description Obbligatorio Predefinito
encrypted_content corda Contenuto crittografato dell'elemento di ragionamento, popolato quando viene generata una risposta con reasoning.encrypted_content nel include parametro . No
summary array Ragionamento del contenuto del testo. Sì
type enum
Valori possibili: reasoning		 Sì

OpenAI.ReasoningItemResource

Descrizione della catena di pensiero usata da un modello di ragionamento durante la generazione di una risposta. Assicurarsi di includere questi elementi nell'API input Risposte per i turni successivi di una conversazione se si gestisce manualmente il contesto.

Name Tipo Description Obbligatorio Predefinito
encrypted_content corda Contenuto crittografato dell'elemento di ragionamento, popolato quando viene generata una risposta con reasoning.encrypted_content nel include parametro . No
summary array Ragionamento del contenuto del testo. Sì
type enum
Valori possibili: reasoning		 Sì

OpenAI.ReasoningItemSummaryPart

Discriminante per OpenAI.ReasoningItemSummaryPart

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

Valore del tipo Schema
summary_text OpenAI.ReasoningItemSummaryTextPart
Name Tipo Description Obbligatorio Predefinito
type OpenAI.ReasoningItemSummaryPartType Sì

OpenAI.ReasoningItemSummaryPartType

Proprietà Value
Type corda
Valori summary_text

OpenAI.ReasoningItemSummaryTextPart

Name Tipo Description Obbligatorio Predefinito
text corda Sì
type enum
Valori possibili: summary_text		 Sì

OpenAI.Response

Name Tipo Description Obbligatorio Predefinito
sfondo Boolean Indica se eseguire la risposta del modello in background. No Falso
creato_il Intero Timestamp Unix (in secondi) di quando è stata creata questa risposta. Sì
Errore object Oggetto di errore restituito quando il modello non riesce a generare una risposta. Sì
└─ codice OpenAI.ResponseErrorCode Codice di errore per la risposta. No
└* messaggio corda Descrizione leggibile dell'errore. No
id corda Identificatore univoco per questa risposta. Sì
incomplete_details object Informazioni dettagliate sul motivo per cui la risposta è incompleta. Sì
└* motivo enum Motivo per cui la risposta è incompleta.
Valori possibili: max_output_tokens, content_filter		 No
instructions stringa o matrice Sì
max_output_tokens Intero Limite superiore per il numero di token che possono essere generati per una risposta, inclusi i token di output visibili e i token di ragionamento No
max_tool_calls Intero Numero massimo di chiamate totali agli strumenti predefiniti che possono essere elaborati in una risposta. Questo numero massimo si applica a tutte le chiamate predefinite degli strumenti, non per singolo strumento. Eventuali ulteriori tentativi di chiamare uno strumento dal modello verranno ignorati. No
metadata object Set di 16 coppie chiave-valore che possono essere collegate a un oggetto . Ciò può essere utile per archiviare informazioni aggiuntive sull'oggetto in un formato strutturato ed eseguire query sugli oggetti tramite API o il dashboard.

Le chiavi sono stringhe con una lunghezza massima di 64 caratteri. I valori sono stringhe con una lunghezza massima di 512 caratteri.		 Sì
object enum Tipo di oggetto di questa risorsa: sempre impostato su response.
Valori possibili: response		 Sì
output array Matrice di elementi di contenuto generati dal modello.

- La lunghezza e l'ordine degli elementi nella output matrice dipendono dalla risposta del modello.
- Anziché accedere al primo elemento nella output matrice e presupponendo che si tratti di un assistant messaggio con il contenuto generato dal modello, è consigliabile usare la output_text proprietà in cui è supportato negli SDK.		 Sì
output_text corda Proprietà utile solo SDK che contiene l'output di testo aggregato di tutti gli output_text elementi della output matrice, se presenti.
Supportato negli SDK Python e JavaScript.		 No
chiamate_parallele_agli_strumenti Boolean Indica se consentire al modello di eseguire chiamate degli strumenti in parallelo. Sì Vero
previous_response_id corda ID univoco della risposta precedente al modello. Usare questa opzione per creare conversazioni a più turni. No
prompt object Riferimento a un modello di richiesta e alle relative variabili. No
└* id corda Identificatore univoco del modello di richiesta da usare. No
** └─ Variabili OpenAI.ResponsePromptVariables Mapping facoltativo dei valori da sostituire con le variabili nel prompt. I valori di sostituzione possono essere stringhe o altri tipi di input response, ad esempio immagini o file. No
└─ versione corda Versione facoltativa del modello di richiesta. No
reasoning object Solo modelli di serie o

Opzioni di configurazione per i modelli di ragionamento.		 No
└* sforzo Sforzo di Ragionamento OpenAI Solo modelli di serie o

Vincola lo sforzo sul ragionamento per i modelli di ragionamento.
I valori attualmente supportati sono low, mediume high. La riduzione del lavoro di ragionamento può comportare risposte più veloci e un minor numero di token usati per il ragionamento in una risposta.		 No
└─ genera_sommario enum Deprecato: usare summary invece.

Riepilogo del ragionamento eseguito dal modello. Ciò può essere utile per eseguire il debug e comprendere il processo di ragionamento del modello.
Uno di auto, conciseo detailed.
Valori possibili: auto, concise, detailed		 No
└─ Riepilogo enum Riepilogo del ragionamento eseguito dal modello. Ciò può essere utile per eseguire il debug e comprendere il processo di ragionamento del modello.
Uno di auto, conciseo detailed.
Valori possibili: auto, concise, detailed		 No
stato enum Stato della generazione della risposta. Uno di completed, failed, in_progresscancelled, queued, o incomplete.
Valori possibili: completed, failedin_progress, cancelled, , queuedincomplete		 No
Temperatura number Temperatura di campionamento da usare, compresa tra 0 e 2. Valori più alti come 0,8 renderanno l'output più casuale, mentre i valori inferiori come 0,2 lo renderanno più incentrato e deterministico.
In genere è consigliabile modificare questa impostazione o top_p non entrambe.		 Sì
text object Opzioni di configurazione per una risposta di testo dal modello. Può essere un testo normale o dati JSON strutturati. No
└* formato OpenAI.ResponseTextFormatConfiguration No
tool_choice object Controlla quale strumento (se presente) viene chiamato dal modello.

none indica che il modello non chiamerà alcuno strumento e genera invece un messaggio.

auto indica che il modello può scegliere tra la generazione di un messaggio o la chiamata di uno o più strumenti.

required significa che il modello deve chiamare uno o più strumenti.		 No
└─ Tipo OpenAI.ToolChoiceObjectType Indica che il modello deve usare uno strumento predefinito per generare una risposta. No
Strumenti array Una matrice di strumenti che il modello può chiamare durante la generazione di una risposta. È possibile specificare lo strumento da usare impostando il tool_choice parametro .

Le due categorie di strumenti che è possibile fornire il modello sono:

- Strumenti predefiniti: strumenti forniti da OpenAI che estendono le funzionalità del modello.		 No
top_logprobs Intero 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. No
top_p number Un'alternativa al campionamento con temperatura, denominata campionamento del nucleo, in cui il modello considera i risultati dei token con top_p massa di probabilità. Quindi 0,1 significa che vengono considerati solo i token che comprendono i primi 10% massa di probabilità.

In genere è consigliabile modificare questa impostazione o temperature non entrambe.		 Sì
truncation enum Strategia di troncamento da usare per la risposta del modello.
- auto: se il contesto di questa risposta e quelli precedenti supera le dimensioni della finestra di contesto del modello, il modello tronca la risposta per adattarsi alla finestra di contesto eliminando gli elementi di input al centro della conversazione.
- disabled (impostazione predefinita): se una risposta del modello supererà le dimensioni della finestra di contesto per un modello, la richiesta avrà esito negativo con un errore 400.
Valori possibili: auto, disabled		 No
uso OpenAI.ResponseUsage Rappresenta i dettagli di utilizzo dei token, inclusi i token di input, i token di output, la suddivisione dei token di output e i token totali usati. No
user corda Identificatore univoco che rappresenta l'utente finale, che consente a OpenAI di monitorare e rilevare gli abusi. Sì

OpenAI.ResponseCodeInterpreterCallCodeDeltaEvent

Generato quando un frammento di codice parziale viene trasmesso dall'interprete di codice.

Name Tipo Description Obbligatorio Predefinito
delta corda Frammento di codice parziale trasmesso dall'interprete di codice. Sì
item_id corda Identificatore univoco dell'elemento di chiamata dello strumento dell'interprete del codice. Sì
output_index Intero Indice dell'elemento di output nella risposta per cui viene trasmesso il codice. Sì
type enum Tipo dell'evento. Sempre response.code_interpreter_call_code.delta.
Valori possibili: response.code_interpreter_call_code.delta		 Sì

OpenAI.ResponseCodeInterpreterCallCodeDoneEvent

Generato quando il frammento di codice viene finalizzato dall'interprete di codice.

Name Tipo Description Obbligatorio Predefinito
codice corda Output del frammento di codice finale dell'interprete di codice. Sì
item_id corda Identificatore univoco dell'elemento di chiamata dello strumento dell'interprete del codice. Sì
output_index Intero Indice dell'elemento di output nella risposta per cui viene finalizzato il codice. Sì
type enum Tipo dell'evento. Sempre response.code_interpreter_call_code.done.
Valori possibili: response.code_interpreter_call_code.done		 Sì

OpenAI.ResponseCodeInterpreterCallCompletedEvent

Generato al termine della chiamata dell'interprete del codice.

Name Tipo Description Obbligatorio Predefinito
item_id corda Identificatore univoco dell'elemento di chiamata dello strumento dell'interprete del codice. Sì
output_index Intero Indice dell'elemento di output nella risposta per cui viene completata la chiamata dell'interprete del codice. Sì
type enum Tipo dell'evento. Sempre response.code_interpreter_call.completed.
Valori possibili: response.code_interpreter_call.completed		 Sì

OpenAI.ResponseCodeInterpreterCallInProgressEvent

Generato quando è in corso una chiamata a un interprete di codice.

Name Tipo Description Obbligatorio Predefinito
item_id corda Identificatore univoco dell'elemento di chiamata dello strumento dell'interprete del codice. Sì
output_index Intero Indice dell'elemento di output nella risposta per cui è in corso la chiamata dell'interprete del codice. Sì
type enum Tipo dell'evento. Sempre response.code_interpreter_call.in_progress.
Valori possibili: response.code_interpreter_call.in_progress		 Sì

OpenAI.ResponseCodeInterpreterCallInterpretingEvent

Generato quando l'interprete di codice interpreta attivamente il frammento di codice.

Name Tipo Description Obbligatorio Predefinito
item_id corda Identificatore univoco dell'elemento di chiamata dello strumento dell'interprete del codice. Sì
output_index Intero Indice dell'elemento di output nella risposta per cui l'interprete del codice interpreta il codice. Sì
type enum Tipo dell'evento. Sempre response.code_interpreter_call.interpreting.
Valori possibili: response.code_interpreter_call.interpreting		 Sì

OpenAI.ResponseCompletedEvent

Generato al termine della risposta del modello.

Name Tipo Description Obbligatorio Predefinito
response object Sì
└* sfondo Boolean Indica se eseguire la risposta del modello in background. No Falso
└created_at Intero Timestamp Unix (in secondi) di quando è stata creata questa risposta. No
└─ Errore OpenAI.ResponseError Oggetto di errore restituito quando il modello non riesce a generare una risposta. No
└* id corda Identificatore univoco per questa risposta. No
└dettagli_incompleti object Informazioni dettagliate sul motivo per cui la risposta è incompleta. No
└* motivo enum Motivo per cui la risposta è incompleta.
Valori possibili: max_output_tokens, content_filter		 No
└* istruzioni stringa o matrice Messaggio di sistema (o sviluppatore) inserito nel contesto del modello.

Quando si usa insieme previous_response_ida , le istruzioni di una risposta precedente non verranno trasportate alla risposta successiva. In questo modo è semplice scambiare messaggi di sistema (o sviluppatore) in nuove risposte.		 No
└ max_output_tokens Intero Limite superiore per il numero di token che possono essere generati per una risposta, inclusi i token di output visibili e i token di ragionamento No
└max_tool_calls Intero Numero massimo di chiamate totali agli strumenti predefiniti che possono essere elaborati in una risposta. Questo numero massimo si applica a tutte le chiamate predefinite degli strumenti, non per singolo strumento. Eventuali ulteriori tentativi di chiamare uno strumento dal modello verranno ignorati. No
└─ metadati object Set di 16 coppie chiave-valore che possono essere collegate a un oggetto . Ciò può essere utile per archiviare informazioni aggiuntive sull'oggetto in un formato strutturato ed eseguire query sugli oggetti tramite API o il dashboard.

Le chiavi sono stringhe con una lunghezza massima di 64 caratteri. I valori sono stringhe con una lunghezza massima di 512 caratteri.		 No
└─ oggetto enum Tipo di oggetto di questa risorsa: sempre impostato su response.
Valori possibili: response		 No
└─ uscita array Matrice di elementi di contenuto generati dal modello.

- La lunghezza e l'ordine degli elementi nella output matrice dipendono dalla risposta del modello.
- Anziché accedere al primo elemento nella output matrice e presupponendo che si tratti di un assistant messaggio con il contenuto generato dal modello, è consigliabile usare la output_text proprietà in cui è supportato negli SDK.		 No
└output_text corda Proprietà utile solo SDK che contiene l'output di testo aggregato di tutti gli output_text elementi della output matrice, se presenti.
Supportato negli SDK Python e JavaScript.		 No
└parallel_tool_calls Boolean Indica se consentire al modello di eseguire chiamate degli strumenti in parallelo. No Vero
└─previous_response_id corda ID univoco della risposta precedente al modello. Usare questa opzione per creare conversazioni a più turni. No
└* prompt OpenAI.Prompt Riferimento a un modello di richiesta e alle relative variabili. No
└* ragionamento OpenAI.Reasoning Solo modelli di serie o

Opzioni di configurazione per i modelli di ragionamento.		 No
└─ stato enum Stato della generazione della risposta. Uno di completed, failed, in_progresscancelled, queued, o incomplete.
Valori possibili: completed, failedin_progress, cancelled, , queuedincomplete		 No
└* temperatura number Temperatura di campionamento da usare, compresa tra 0 e 2. Valori più alti come 0,8 renderanno l'output più casuale, mentre i valori inferiori come 0,2 lo renderanno più incentrato e deterministico.
In genere è consigliabile modificare questa impostazione o top_p non entrambe.		 No
└─ testo object Opzioni di configurazione per una risposta di testo dal modello. Può essere un testo normale o dati JSON strutturati. No
└* formato OpenAI.ResponseTextFormatConfiguration No
└tool_choice OpenAI.ToolChoiceOptions o OpenAI.ToolChoiceObject Come il modello deve selezionare quale strumento (o strumenti) usare durante la generazione di una risposta. Vedere il tools parametro per informazioni su come specificare gli strumenti che il modello può chiamare. No
Strumenti └* array Una matrice di strumenti che il modello può chiamare durante la generazione di una risposta. È possibile specificare lo strumento da usare impostando il tool_choice parametro .

Le due categorie di strumenti che è possibile fornire il modello sono:

- Strumenti predefiniti: strumenti forniti da OpenAI che estendono le funzionalità del modello.		 No
└ top_logprobs Intero 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. No
└top_p number Un'alternativa al campionamento con temperatura, denominata campionamento del nucleo, in cui il modello considera i risultati dei token con top_p massa di probabilità. Quindi 0,1 significa che vengono considerati solo i token che comprendono i primi 10% massa di probabilità.

In genere è consigliabile modificare questa impostazione o temperature non entrambe.		 No
└─ troncamento enum Strategia di troncamento da usare per la risposta del modello.
- auto: se il contesto di questa risposta e quelli precedenti supera le dimensioni della finestra di contesto del modello, il modello tronca la risposta per adattarsi alla finestra di contesto eliminando gli elementi di input al centro della conversazione.
- disabled (impostazione predefinita): se una risposta del modello supererà le dimensioni della finestra di contesto per un modello, la richiesta avrà esito negativo con un errore 400.
Valori possibili: auto, disabled		 No
└─ utilizzo OpenAI.ResponseUsage Rappresenta i dettagli di utilizzo dei token, inclusi i token di input, i token di output, la suddivisione dei token di output e i token totali usati. No
└─ utente corda Identificatore univoco che rappresenta l'utente finale, che consente a OpenAI di monitorare e rilevare gli abusi. No
type enum Tipo dell'evento. Sempre response.completed.
Valori possibili: response.completed		 Sì

OpenAI.ResponseContentPartAddedEvent

Generato quando viene aggiunta una nuova parte di contenuto.

Name Tipo Description Obbligatorio Predefinito
content_index Intero Indice della parte di contenuto aggiunta. Sì
item_id corda ID dell'elemento di output a cui è stata aggiunta la parte di contenuto. Sì
output_index Intero Indice dell'elemento di output a cui è stata aggiunta la parte di contenuto. Sì
part object Sì
└─ Tipo OpenAI.ItemContentType Contenuto di input e output multi modale. No
type enum Tipo dell'evento. Sempre response.content_part.added.
Valori possibili: response.content_part.added		 Sì

OpenAI.ResponseContentPartDoneEvent

Generato al termine di una parte del contenuto.

Name Tipo Description Obbligatorio Predefinito
content_index Intero Indice della parte di contenuto eseguita. Sì
item_id corda ID dell'elemento di output a cui è stata aggiunta la parte di contenuto. Sì
output_index Intero Indice dell'elemento di output a cui è stata aggiunta la parte di contenuto. Sì
part object Sì
└─ Tipo OpenAI.ItemContentType Contenuto di input e output multi modale. No
type enum Tipo dell'evento. Sempre response.content_part.done.
Valori possibili: response.content_part.done		 Sì

OpenAI.ResponseCreatedEvent

Evento generato quando viene creata una risposta.

Name Tipo Description Obbligatorio Predefinito
response object Sì
└* sfondo Boolean Indica se eseguire la risposta del modello in background. No Falso
└created_at Intero Timestamp Unix (in secondi) di quando è stata creata questa risposta. No
└─ Errore OpenAI.ResponseError Oggetto di errore restituito quando il modello non riesce a generare una risposta. No
└* id corda Identificatore univoco per questa risposta. No
└dettagli_incompleti object Informazioni dettagliate sul motivo per cui la risposta è incompleta. No
└* motivo enum Motivo per cui la risposta è incompleta.
Valori possibili: max_output_tokens, content_filter		 No
└* istruzioni stringa o matrice Messaggio di sistema (o sviluppatore) inserito nel contesto del modello.

Quando si usa insieme previous_response_ida , le istruzioni di una risposta precedente non verranno trasportate alla risposta successiva. In questo modo è semplice scambiare messaggi di sistema (o sviluppatore) in nuove risposte.		 No
└ max_output_tokens Intero Limite superiore per il numero di token che possono essere generati per una risposta, inclusi i token di output visibili e i token di ragionamento No
└max_tool_calls Intero Numero massimo di chiamate totali agli strumenti predefiniti che possono essere elaborati in una risposta. Questo numero massimo si applica a tutte le chiamate predefinite degli strumenti, non per singolo strumento. Eventuali ulteriori tentativi di chiamare uno strumento dal modello verranno ignorati. No
└─ metadati object Set di 16 coppie chiave-valore che possono essere collegate a un oggetto . Ciò può essere utile per archiviare informazioni aggiuntive sull'oggetto in un formato strutturato ed eseguire query sugli oggetti tramite API o il dashboard.

Le chiavi sono stringhe con una lunghezza massima di 64 caratteri. I valori sono stringhe con una lunghezza massima di 512 caratteri.		 No
└─ oggetto enum Tipo di oggetto di questa risorsa: sempre impostato su response.
Valori possibili: response		 No
└─ uscita array Matrice di elementi di contenuto generati dal modello.

- La lunghezza e l'ordine degli elementi nella output matrice dipendono dalla risposta del modello.
- Anziché accedere al primo elemento nella output matrice e presupponendo che si tratti di un assistant messaggio con il contenuto generato dal modello, è consigliabile usare la output_text proprietà in cui è supportato negli SDK.		 No
└output_text corda Proprietà utile solo SDK che contiene l'output di testo aggregato di tutti gli output_text elementi della output matrice, se presenti.
Supportato negli SDK Python e JavaScript.		 No
└parallel_tool_calls Boolean Indica se consentire al modello di eseguire chiamate degli strumenti in parallelo. No Vero
└─previous_response_id corda ID univoco della risposta precedente al modello. Usare questa opzione per creare conversazioni a più turni. No
└* prompt OpenAI.Prompt Riferimento a un modello di richiesta e alle relative variabili. No
└* ragionamento OpenAI.Reasoning Solo modelli di serie o

Opzioni di configurazione per i modelli di ragionamento.		 No
└─ stato enum Stato della generazione della risposta. Uno di completed, failed,
in_progress cancelled, queued, o incomplete.
Valori possibili: completed, failedin_progress, cancelled, , queuedincomplete		 No
└* temperatura number Temperatura di campionamento da usare, compresa tra 0 e 2. Valori più alti come 0,8 renderanno l'output più casuale, mentre i valori inferiori come 0,2 lo renderanno più incentrato e deterministico.
In genere è consigliabile modificare questa impostazione o top_p non entrambe.		 No
└─ testo object Opzioni di configurazione per una risposta di testo dal modello. Può essere un testo normale o dati JSON strutturati. No
└* formato OpenAI.ResponseTextFormatConfiguration No
└tool_choice OpenAI.ToolChoiceOptions o OpenAI.ToolChoiceObject Come il modello deve selezionare quale strumento (o strumenti) usare durante la generazione di una risposta. Vedere il tools parametro per informazioni su come specificare gli strumenti che il modello può chiamare. No
Strumenti └* array Una matrice di strumenti che il modello può chiamare durante la generazione di una risposta. È possibile specificare lo strumento da usare impostando il tool_choice parametro .

Le due categorie di strumenti che è possibile fornire il modello sono:

- Strumenti predefiniti: strumenti forniti da OpenAI che estendono le funzionalità del modello.		 No
└ top_logprobs Intero 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. No
└top_p number Un'alternativa al campionamento con temperatura, denominata campionamento del nucleo, in cui il modello considera i risultati dei token con top_p massa di probabilità. Quindi 0,1 significa che vengono considerati solo i token che comprendono i primi 10% massa di probabilità.

In genere è consigliabile modificare questa impostazione o temperature non entrambe.		 No
└─ troncamento enum Strategia di troncamento da usare per la risposta del modello.
- auto: se il contesto di questa risposta e quelli precedenti supera le dimensioni della finestra di contesto del modello, il modello tronca la risposta per adattarsi alla finestra di contesto eliminando gli elementi di input al centro della conversazione.
- disabled (impostazione predefinita): se una risposta del modello supererà le dimensioni della finestra di contesto per un modello, la richiesta avrà esito negativo con un errore 400.
Valori possibili: auto, disabled		 No
└─ utilizzo OpenAI.ResponseUsage Rappresenta i dettagli di utilizzo dei token, inclusi i token di input, i token di output, la suddivisione dei token di output e i token totali usati. No
└─ utente corda Identificatore univoco che rappresenta l'utente finale, che consente a OpenAI di monitorare e rilevare gli abusi. No
type enum Tipo dell'evento. Sempre response.created.
Valori possibili: response.created		 Sì

OpenAI.ResponseError

Oggetto di errore restituito quando il modello non riesce a generare una risposta.

Name Tipo Description Obbligatorio Predefinito
codice OpenAI.ResponseErrorCode Codice di errore per la risposta. Sì
message corda Descrizione leggibile dell'errore. Sì

OpenAI.ResponseErrorCode

Codice di errore per la risposta.

Proprietà Value
Descrizione Codice di errore per la risposta.
Type corda
Valori server_error
rate_limit_exceeded
invalid_prompt
vector_store_timeout
invalid_image
invalid_image_format
invalid_base64_image
invalid_image_url
image_too_large
image_too_small
image_parse_error
image_content_policy_violation
invalid_image_mode
image_file_too_large
unsupported_image_media_type
empty_image_file
failed_to_download_image
image_file_not_found

OpenAI.ResponseErrorEvent

Generato quando si verifica un errore.

Name Tipo Description Obbligatorio Predefinito
codice corda Codice di errore. Sì
message corda Messaggio di errore. Sì
param corda Parametro di errore. Sì
type enum Tipo dell'evento. Sempre error.
Valori possibili: error		 Sì

OpenAI.ResponseFailedEvent

Evento generato quando una risposta ha esito negativo.

Name Tipo Description Obbligatorio Predefinito
response object Sì
└* sfondo Boolean Indica se eseguire la risposta del modello in background. No Falso
└created_at Intero Timestamp Unix (in secondi) di quando è stata creata questa risposta. No
└─ Errore OpenAI.ResponseError Oggetto di errore restituito quando il modello non riesce a generare una risposta. No
└* id corda Identificatore univoco per questa risposta. No
└dettagli_incompleti object Informazioni dettagliate sul motivo per cui la risposta è incompleta. No
└* motivo enum Motivo per cui la risposta è incompleta.
Valori possibili: max_output_tokens, content_filter		 No
└* istruzioni stringa o matrice Messaggio di sistema (o sviluppatore) inserito nel contesto del modello.

Quando si usa insieme previous_response_ida , le istruzioni di una risposta precedente non verranno trasportate alla risposta successiva. In questo modo è semplice scambiare messaggi di sistema (o sviluppatore) in nuove risposte.		 No
└ max_output_tokens Intero Limite superiore per il numero di token che possono essere generati per una risposta, inclusi i token di output visibili e i token di ragionamento No
└max_tool_calls Intero Numero massimo di chiamate totali agli strumenti predefiniti che possono essere elaborati in una risposta. Questo numero massimo si applica a tutte le chiamate predefinite degli strumenti, non per singolo strumento. Eventuali ulteriori tentativi di chiamare uno strumento dal modello verranno ignorati. No
└─ metadati object Set di 16 coppie chiave-valore che possono essere collegate a un oggetto . Ciò può essere utile per archiviare informazioni aggiuntive sull'oggetto in un formato strutturato ed eseguire query sugli oggetti tramite API o il dashboard.

Le chiavi sono stringhe con una lunghezza massima di 64 caratteri. I valori sono stringhe con una lunghezza massima di 512 caratteri.		 No
└─ oggetto enum Tipo di oggetto di questa risorsa: sempre impostato su response.
Valori possibili: response		 No
└─ uscita array Matrice di elementi di contenuto generati dal modello.

- La lunghezza e l'ordine degli elementi nella output matrice dipendono dalla risposta del modello.
- Anziché accedere al primo elemento nella output matrice e presupponendo che si tratti di un assistant messaggio con il contenuto generato dal modello, è consigliabile usare la output_text proprietà in cui è supportato negli SDK.		 No
└output_text corda Proprietà utile solo SDK che contiene l'output di testo aggregato di tutti gli output_text elementi della output matrice, se presenti.
Supportato negli SDK Python e JavaScript.		 No
└parallel_tool_calls Boolean Indica se consentire al modello di eseguire chiamate degli strumenti in parallelo. No Vero
└─previous_response_id corda ID univoco della risposta precedente al modello. Usare questa opzione per creare conversazioni a più turni. No
└* prompt OpenAI.Prompt Riferimento a un modello di richiesta e alle relative variabili. No
└* ragionamento OpenAI.Reasoning Solo modelli di serie o

Opzioni di configurazione per i modelli di ragionamento.		 No
└─ stato enum Stato della generazione della risposta. Uno di completed, failed, in_progresscancelled, queued, o incomplete.
Valori possibili: completed, failedin_progress, cancelled, , queuedincomplete		 No
└* temperatura number Temperatura di campionamento da usare, compresa tra 0 e 2. Valori più alti come 0,8 renderanno l'output più casuale, mentre i valori inferiori come 0,2 lo renderanno più incentrato e deterministico.
In genere è consigliabile modificare questa impostazione o top_p non entrambe.		 No
└─ testo object Opzioni di configurazione per una risposta di testo dal modello. Può essere un testo normale o dati JSON strutturati. No
└* formato OpenAI.ResponseTextFormatConfiguration No
└tool_choice OpenAI.ToolChoiceOptions o OpenAI.ToolChoiceObject Come il modello deve selezionare quale strumento (o strumenti) usare durante la generazione di una risposta. Vedere il tools parametro per informazioni su come specificare gli strumenti che il modello può chiamare. No
Strumenti └* array Una matrice di strumenti che il modello può chiamare durante la generazione di una risposta. È possibile specificare lo strumento da usare impostando il tool_choice parametro .

Le due categorie di strumenti che è possibile fornire il modello sono:

- Strumenti predefiniti: strumenti forniti da OpenAI che estendono le funzionalità del modello.		 No
└ top_logprobs Intero 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. No
└top_p number Un'alternativa al campionamento con temperatura, denominata campionamento del nucleo, in cui il modello considera i risultati dei token con top_p massa di probabilità. Quindi 0,1 significa che vengono considerati solo i token che comprendono i primi 10% massa di probabilità.

In genere è consigliabile modificare questa impostazione o temperature non entrambe.		 No
└─ troncamento enum Strategia di troncamento da usare per la risposta del modello.
- auto: se il contesto di questa risposta e quelli precedenti supera le dimensioni della finestra di contesto del modello, il modello tronca la risposta per adattarsi alla finestra di contesto eliminando gli elementi di input al centro della conversazione.
- disabled (impostazione predefinita): se una risposta del modello supererà le dimensioni della finestra di contesto per un modello, la richiesta avrà esito negativo con un errore 400.
Valori possibili: auto, disabled		 No
└─ utilizzo OpenAI.ResponseUsage Rappresenta i dettagli di utilizzo dei token, inclusi i token di input, i token di output, la suddivisione dei token di output e i token totali usati. No
└─ utente corda Identificatore univoco che rappresenta l'utente finale, che consente a OpenAI di monitorare e rilevare gli abusi. No
type enum Tipo dell'evento. Sempre response.failed.
Valori possibili: response.failed		 Sì

OpenAI.ResponseFileSearchCallCompletedEvent

Generato quando viene completata una chiamata di ricerca file (risultati trovati).

Name Tipo Description Obbligatorio Predefinito
item_id corda ID dell'elemento di output avviato dalla chiamata di ricerca file. Sì
output_index Intero Indice dell'elemento di output avviato dalla chiamata di ricerca file. Sì
type enum Tipo dell'evento. Sempre response.file_search_call.completed.
Valori possibili: response.file_search_call.completed		 Sì

OpenAI.ResponseFileSearchCallInProgressEvent

Generato quando viene avviata una chiamata di ricerca file.

Name Tipo Description Obbligatorio Predefinito
item_id corda ID dell'elemento di output avviato dalla chiamata di ricerca file. Sì
output_index Intero Indice dell'elemento di output avviato dalla chiamata di ricerca file. Sì
type enum Tipo dell'evento. Sempre response.file_search_call.in_progress.
Valori possibili: response.file_search_call.in_progress		 Sì

OpenAI.ResponseFileSearchCallSearchingEvent

Generato quando una ricerca di file è attualmente in corso di ricerca.

Name Tipo Description Obbligatorio Predefinito
item_id corda ID dell'elemento di output avviato dalla chiamata di ricerca file. Sì
output_index Intero Indice dell'elemento di output in cui viene eseguita la ricerca della chiamata di ricerca file. Sì
type enum Tipo dell'evento. Sempre response.file_search_call.searching.
Valori possibili: response.file_search_call.searching		 Sì

OpenAI.ResponseFormat

Discriminare per OpenAI.ResponseFormat

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

Valore del tipo Schema
text OpenAI.ResponseFormatText
json_object OpenAI.ResponseFormatJsonObject
json_schema OpenAI.ResponseFormatJsonSchema
Name Tipo Description Obbligatorio Predefinito
type enum
Valori possibili: text, json_object, json_schema		 Sì

OpenAI.ResponseFormatJsonObject

Formato della risposta dell'oggetto JSON. Metodo precedente di generazione di risposte JSON. L'uso json_schema di è consigliato per i modelli che lo supportano. Si noti che il modello non genererà JSON senza un messaggio di sistema o utente che indica a tale scopo.

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

OpenAI.ResponseFormatJsonSchema

Formato di risposta dello schema JSON. Usato per generare risposte JSON strutturate.

Name Tipo Description Obbligatorio Predefinito
json_schema object Opzioni di configurazione degli output strutturati, incluso uno schema JSON. Sì
└* descrizione corda Descrizione del formato di risposta, usato dal modello per determinare come rispondere nel formato. No
└> nome corda 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. No
└─ Schema OpenAI.ResponseFormatJsonSchemaSchema Schema per il formato di risposta, descritto come oggetto Schema JSON.
Informazioni su come creare schemi JSON qui.		 No
└─ rigoroso 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 schema campo. Solo un subset di schema JSON è supportato quando strict è true.		 No Falso
type enum Tipo di formato di risposta definito. Sempre json_schema.
Valori possibili: json_schema		 Sì

OpenAI.ResponseFormatJsonSchemaSchema

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

Tipo: oggetto

OpenAI.ResponseFormatText

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

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

OpenAI.ResponseFunctionCallArgumentsDeltaEvent

Generato quando è presente un delta degli argomenti di chiamata di funzione parziale.

Name Tipo Description Obbligatorio Predefinito
delta corda Delta degli argomenti di chiamata di funzione aggiunto. Sì
item_id corda ID dell'elemento di output a cui viene aggiunto il delta degli argomenti di chiamata di funzione. Sì
output_index Intero Indice dell'elemento di output a cui viene aggiunto il delta degli argomenti di chiamata di funzione. Sì
type enum Tipo dell'evento. Sempre response.function_call_arguments.delta.
Valori possibili: response.function_call_arguments.delta		 Sì

OpenAI.ResponseFunctionCallArgumentsDoneEvent

Generato quando gli argomenti della chiamata di funzione vengono finalizzati.

Name Tipo Description Obbligatorio Predefinito
arguments corda Argomenti di chiamata di funzione. Sì
item_id corda ID dell'elemento. Sì
output_index Intero Indice dell'elemento di output. Sì
type enum
Valori possibili: response.function_call_arguments.done		 Sì

OpenAI.ResponseImageGenCallCompletedEvent

Generato quando una chiamata dello strumento di generazione di immagini è stata completata e l'immagine finale è disponibile.

Name Tipo Description Obbligatorio Predefinito
item_id corda Identificatore univoco dell'elemento di generazione dell'immagine in fase di elaborazione. Sì
output_index Intero Indice dell'elemento di output nella matrice di output della risposta. Sì
type enum Tipo dell'evento. Sempre «response.image_generation_call.completed».
Valori possibili: response.image_generation_call.completed		 Sì

OpenAI.ResponseImageGenCallGeneratingEvent

Generato quando una chiamata dello strumento di generazione di immagini genera attivamente un'immagine (stato intermedio).

Name Tipo Description Obbligatorio Predefinito
item_id corda Identificatore univoco dell'elemento di generazione dell'immagine in fase di elaborazione. Sì
output_index Intero Indice dell'elemento di output nella matrice di output della risposta. Sì
type enum Tipo dell'evento. Sempre "response.image_generation_call.generating".
Valori possibili: response.image_generation_call.generating		 Sì

OpenAI.ResponseImageGenCallInProgressEvent

Generato quando è in corso una chiamata dello strumento di generazione di immagini.

Name Tipo Description Obbligatorio Predefinito
item_id corda Identificatore univoco dell'elemento di generazione dell'immagine in fase di elaborazione. Sì
output_index Intero Indice dell'elemento di output nella matrice di output della risposta. Sì
type enum Tipo dell'evento. Sempre 'response.image_generation_call.in_progress'.
Valori possibili: response.image_generation_call.in_progress		 Sì

OpenAI.ResponseImageGenCallPartialImageEvent

Generato quando un'immagine parziale è disponibile durante il flusso di generazione di immagini.

Name Tipo Description Obbligatorio Predefinito
item_id corda Identificatore univoco dell'elemento di generazione dell'immagine in fase di elaborazione. Sì
output_index Intero Indice dell'elemento di output nella matrice di output della risposta. Sì
partial_image_b64 corda Dati parziali con codifica Base64, adatti per il rendering come immagine. Sì
partial_image_index Intero Indice in base 0 per l'immagine parziale (il back-end è basato su 1, ma questo è basato su 0 per l'utente). Sì
type enum Tipo dell'evento. Sempre 'response.image_generation_call.partial_image'.
Valori possibili: response.image_generation_call.partial_image		 Sì

OpenAI.ResponseInProgressEvent

Generato quando la risposta è in corso.

Name Tipo Description Obbligatorio Predefinito
response object Sì
└* sfondo Boolean Indica se eseguire la risposta del modello in background. No Falso
└created_at Intero Timestamp Unix (in secondi) di quando è stata creata questa risposta. No
└─ Errore OpenAI.ResponseError Oggetto di errore restituito quando il modello non riesce a generare una risposta. No
└* id corda Identificatore univoco per questa risposta. No
└dettagli_incompleti object Informazioni dettagliate sul motivo per cui la risposta è incompleta. No
└* motivo enum Motivo per cui la risposta è incompleta.
Valori possibili: max_output_tokens, content_filter		 No
└* istruzioni stringa o matrice Messaggio di sistema (o sviluppatore) inserito nel contesto del modello.

Quando si usa insieme previous_response_ida , le istruzioni di una risposta precedente non verranno trasportate alla risposta successiva. In questo modo è semplice scambiare messaggi di sistema (o sviluppatore) in nuove risposte.		 No
└ max_output_tokens Intero Limite superiore per il numero di token che possono essere generati per una risposta, inclusi i token di output visibili e i token di ragionamento No
└max_tool_calls Intero Numero massimo di chiamate totali agli strumenti predefiniti che possono essere elaborati in una risposta. Questo numero massimo si applica a tutte le chiamate predefinite degli strumenti, non per singolo strumento. Eventuali ulteriori tentativi di chiamare uno strumento dal modello verranno ignorati. No
└─ metadati object Set di 16 coppie chiave-valore che possono essere collegate a un oggetto . Ciò può essere utile per archiviare informazioni aggiuntive sull'oggetto in un formato strutturato ed eseguire query sugli oggetti tramite API o il dashboard.

Le chiavi sono stringhe con una lunghezza massima di 64 caratteri. I valori sono stringhe con una lunghezza massima di 512 caratteri.		 No
└─ oggetto enum Tipo di oggetto di questa risorsa: sempre impostato su response.
Valori possibili: response		 No
└─ uscita array Matrice di elementi di contenuto generati dal modello.

- La lunghezza e l'ordine degli elementi nella output matrice dipendono dalla risposta del modello.
- Anziché accedere al primo elemento nella output matrice e presupponendo che si tratti di un assistant messaggio con il contenuto generato dal modello, è consigliabile usare la output_text proprietà in cui è supportato negli SDK.		 No
└output_text corda Proprietà utile solo SDK che contiene l'output di testo aggregato di tutti gli output_text elementi della output matrice, se presenti.
Supportato negli SDK Python e JavaScript.		 No
└parallel_tool_calls Boolean Indica se consentire al modello di eseguire chiamate degli strumenti in parallelo. No Vero
└─previous_response_id corda ID univoco della risposta precedente al modello. Usare questa opzione per creare conversazioni a più turni. No
└* prompt OpenAI.Prompt Riferimento a un modello di richiesta e alle relative variabili. No
└* ragionamento OpenAI.Reasoning Solo modelli di serie o

Opzioni di configurazione per i modelli di ragionamento.		 No
└─ stato enum Stato della generazione della risposta. Uno di completed, failed, in_progresscancelled, queued, o incomplete.
Valori possibili: completed, failedin_progress, cancelled, , queuedincomplete		 No
└* temperatura number Temperatura di campionamento da usare, compresa tra 0 e 2. Valori più alti come 0,8 renderanno l'output più casuale, mentre i valori inferiori come 0,2 lo renderanno più incentrato e deterministico.
In genere è consigliabile modificare questa impostazione o top_p non entrambe.		 No
└─ testo object Opzioni di configurazione per una risposta di testo dal modello. Può essere un testo normale o dati JSON strutturati. No
└* formato OpenAI.ResponseTextFormatConfiguration No
└tool_choice OpenAI.ToolChoiceOptions o OpenAI.ToolChoiceObject Come il modello deve selezionare quale strumento (o strumenti) usare durante la generazione di una risposta. Vedere il tools parametro per informazioni su come specificare gli strumenti che il modello può chiamare. No
Strumenti └* array Una matrice di strumenti che il modello può chiamare durante la generazione di una risposta. È possibile specificare lo strumento da usare impostando il tool_choice parametro .

Le due categorie di strumenti che è possibile fornire il modello sono:

- Strumenti predefiniti: strumenti forniti da OpenAI che estendono le funzionalità del modello.		 No
└ top_logprobs Intero 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. No
└top_p number Un'alternativa al campionamento con temperatura, denominata campionamento del nucleo, in cui il modello considera i risultati dei token con top_p massa di probabilità. Quindi 0,1 significa che vengono considerati solo i token che comprendono i primi 10% massa di probabilità.

In genere è consigliabile modificare questa impostazione o temperature non entrambe.		 No
└─ troncamento enum Strategia di troncamento da usare per la risposta del modello.
- auto: se il contesto di questa risposta e quelli precedenti supera le dimensioni della finestra di contesto del modello, il modello tronca la risposta per adattarsi alla finestra di contesto eliminando gli elementi di input al centro della conversazione.
- disabled (impostazione predefinita): se una risposta del modello supererà le dimensioni della finestra di contesto per un modello, la richiesta avrà esito negativo con un errore 400.
Valori possibili: auto, disabled		 No
└─ utilizzo OpenAI.ResponseUsage Rappresenta i dettagli di utilizzo dei token, inclusi i token di input, i token di output, la suddivisione dei token di output e i token totali usati. No
└─ utente corda Identificatore univoco che rappresenta l'utente finale, che consente a OpenAI di monitorare e rilevare gli abusi. No
type enum Tipo dell'evento. Sempre response.in_progress.
Valori possibili: response.in_progress		 Sì

OpenAI.ResponseIncompleteEvent

Evento generato al termine di una risposta come incompleto.

Name Tipo Description Obbligatorio Predefinito
response object Sì
└* sfondo Boolean Indica se eseguire la risposta del modello in background. No Falso
└created_at Intero Timestamp Unix (in secondi) di quando è stata creata questa risposta. No
└─ Errore OpenAI.ResponseError Oggetto di errore restituito quando il modello non riesce a generare una risposta. No
└* id corda Identificatore univoco per questa risposta. No
└dettagli_incompleti object Informazioni dettagliate sul motivo per cui la risposta è incompleta. No
└* motivo enum Motivo per cui la risposta è incompleta.
Valori possibili: max_output_tokens, content_filter		 No
└* istruzioni stringa o matrice Messaggio di sistema (o sviluppatore) inserito nel contesto del modello.

Quando si usa insieme previous_response_ida , le istruzioni di una risposta precedente non verranno trasportate alla risposta successiva. In questo modo è semplice scambiare messaggi di sistema (o sviluppatore) in nuove risposte.		 No
└ max_output_tokens Intero Limite superiore per il numero di token che possono essere generati per una risposta, inclusi i token di output visibili e i token di ragionamento No
└max_tool_calls Intero Numero massimo di chiamate totali agli strumenti predefiniti che possono essere elaborati in una risposta. Questo numero massimo si applica a tutte le chiamate predefinite degli strumenti, non per singolo strumento. Eventuali ulteriori tentativi di chiamare uno strumento dal modello verranno ignorati. No
└─ metadati object Set di 16 coppie chiave-valore che possono essere collegate a un oggetto . Ciò può essere utile per archiviare informazioni aggiuntive sull'oggetto in un formato strutturato ed eseguire query sugli oggetti tramite API o il dashboard.

Le chiavi sono stringhe con una lunghezza massima di 64 caratteri. I valori sono stringhe con una lunghezza massima di 512 caratteri.		 No
└─ oggetto enum Tipo di oggetto di questa risorsa: sempre impostato su response.
Valori possibili: response		 No
└─ uscita array Matrice di elementi di contenuto generati dal modello.

- La lunghezza e l'ordine degli elementi nella output matrice dipendono dalla risposta del modello.
- Anziché accedere al primo elemento nella output matrice e presupponendo che si tratti di un assistant messaggio con il contenuto generato dal modello, è consigliabile usare la output_text proprietà in cui è supportato negli SDK.		 No
└output_text corda Proprietà utile solo SDK che contiene l'output di testo aggregato di tutti gli output_text elementi della output matrice, se presenti.
Supportato negli SDK Python e JavaScript.		 No
└parallel_tool_calls Boolean Indica se consentire al modello di eseguire chiamate degli strumenti in parallelo. No Vero
└─previous_response_id corda ID univoco della risposta precedente al modello. Usare questa opzione per creare conversazioni a più turni. No
└* prompt OpenAI.Prompt Riferimento a un modello di richiesta e alle relative variabili. No
└* ragionamento OpenAI.Reasoning Solo modelli di serie o

Opzioni di configurazione per i modelli di ragionamento.		 No
└─ stato enum Stato della generazione della risposta. Uno di completed, failed, in_progresscancelled, queued, o incomplete.
Valori possibili: completed, failedin_progress, cancelled, , queuedincomplete		 No
└* temperatura number Temperatura di campionamento da usare, compresa tra 0 e 2. Valori più alti come 0,8 renderanno l'output più casuale, mentre i valori inferiori come 0,2 lo renderanno più incentrato e deterministico.
In genere è consigliabile modificare questa impostazione o top_p non entrambe.		 No
└─ testo object Opzioni di configurazione per una risposta di testo dal modello. Può essere un testo normale o dati JSON strutturati. No
└* formato OpenAI.ResponseTextFormatConfiguration No
└tool_choice OpenAI.ToolChoiceOptions o OpenAI.ToolChoiceObject Come il modello deve selezionare quale strumento (o strumenti) usare durante la generazione di una risposta. Vedere il tools parametro per informazioni su come specificare gli strumenti che il modello può chiamare. No
Strumenti └* array Una matrice di strumenti che il modello può chiamare durante la generazione di una risposta. È possibile specificare lo strumento da usare impostando il tool_choice parametro .

Le due categorie di strumenti che è possibile fornire il modello sono:

- Strumenti predefiniti: strumenti forniti da OpenAI che estendono le funzionalità del modello.		 No
└ top_logprobs Intero 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. No
└top_p number Un'alternativa al campionamento con temperatura, denominata campionamento del nucleo, in cui il modello considera i risultati dei token con top_p massa di probabilità. Quindi 0,1 significa che vengono considerati solo i token che comprendono i primi 10% massa di probabilità.

In genere è consigliabile modificare questa impostazione o temperature non entrambe.		 No
└─ troncamento enum Strategia di troncamento da usare per la risposta del modello.
- auto: se il contesto di questa risposta e quelli precedenti supera le dimensioni della finestra di contesto del modello, il modello tronca la risposta per adattarsi alla finestra di contesto eliminando gli elementi di input al centro della conversazione.
- disabled (impostazione predefinita): se una risposta del modello supererà le dimensioni della finestra di contesto per un modello, la richiesta avrà esito negativo con un errore 400.
Valori possibili: auto, disabled		 No
└─ utilizzo OpenAI.ResponseUsage Rappresenta i dettagli di utilizzo dei token, inclusi i token di input, i token di output, la suddivisione dei token di output e i token totali usati. No
└─ utente corda Identificatore univoco che rappresenta l'utente finale, che consente a OpenAI di monitorare e rilevare gli abusi. No
type enum Tipo dell'evento. Sempre response.incomplete.
Valori possibili: response.incomplete		 Sì

OpenAI.ResponseItemList

Elenco di elementi di risposta.

Name Tipo Description Obbligatorio Predefinito
Dati array Elenco di elementi utilizzati per generare questa risposta. Sì
first_id corda ID del primo elemento dell'elenco. Sì
ha_di_piu Boolean Indica se sono disponibili altri elementi. Sì
last_id corda ID dell'ultimo elemento nell'elenco. Sì
object enum Il tipo di oggetto restituito deve essere list.
Valori possibili: list		 Sì

OpenAI.ResponseMCPCallArgumentsDeltaEvent

Generato quando è presente un delta (aggiornamento parziale) agli argomenti di una chiamata allo strumento MCP.

Name Tipo Description Obbligatorio Predefinito
delta Aggiornamento parziale degli argomenti per la chiamata allo strumento MCP. Sì
item_id corda Identificatore univoco dell'elemento di chiamata dello strumento MCP in fase di elaborazione. Sì
output_index Intero Indice dell'elemento di output nella matrice di output della risposta. Sì
type enum Tipo dell'evento. Sempre 'response.mcp_call.arguments_delta'.
Valori possibili: response.mcp_call.arguments_delta		 Sì

OpenAI.ResponseMCPCallArgumentsDoneEvent

Generato quando gli argomenti per una chiamata allo strumento MCP vengono finalizzati.

Name Tipo Description Obbligatorio Predefinito
arguments Argomenti finali per la chiamata allo strumento MCP. Sì
item_id corda Identificatore univoco dell'elemento di chiamata dello strumento MCP in fase di elaborazione. Sì
output_index Intero Indice dell'elemento di output nella matrice di output della risposta. Sì
type enum Tipo dell'evento. Sempre 'response.mcp_call.arguments_done'.
Valori possibili: response.mcp_call.arguments_done		 Sì

OpenAI.ResponseMCPCallCompletedEvent

Generato quando una chiamata allo strumento MCP è stata completata correttamente.

Name Tipo Description Obbligatorio Predefinito
type enum Tipo dell'evento. Sempre "response.mcp_call.completed".
Valori possibili: response.mcp_call.completed		 Sì

OpenAI.ResponseMCPCallFailedEvent

Generato quando una chiamata allo strumento MCP non è riuscita.

Name Tipo Description Obbligatorio Predefinito
type enum Tipo dell'evento. Lasciare invariato 'response.mcp_call.failed'.
Valori possibili: response.mcp_call.failed		 Sì

OpenAI.ResponseMCPCallInProgressEvent

Generato quando è in corso una chiamata allo strumento MCP.

Name Tipo Description Obbligatorio Predefinito
item_id corda Identificatore univoco dell'elemento di chiamata dello strumento MCP in fase di elaborazione. Sì
output_index Intero Indice dell'elemento di output nella matrice di output della risposta. Sì
type enum Tipo dell'evento. Sempre 'response.mcp_call.in_progress'.
Valori possibili: response.mcp_call.in_progress		 Sì

OpenAI.ResponseMCPListToolsCompletedEvent

Generato quando l'elenco degli strumenti MCP disponibili è stato recuperato correttamente.

Name Tipo Description Obbligatorio Predefinito
type enum Tipo dell'evento. Sempre "response.mcp_list_tools.completed".
Valori possibili: response.mcp_list_tools.completed		 Sì

OpenAI.ResponseMCPListToolsFailedEvent

Generato quando il tentativo di elencare gli strumenti MCP disponibili non è riuscito.

Name Tipo Description Obbligatorio Predefinito
type enum Tipo dell'evento. Sempre 'response.mcp_list_tools.failed'.
Valori possibili: response.mcp_list_tools.failed		 Sì

OpenAI.ResponseMCPListToolsInProgressEvent

Generato quando il sistema è in corso di recupero dell'elenco degli strumenti MCP disponibili.

Name Tipo Description Obbligatorio Predefinito
type enum Tipo dell'evento. Sempre 'response.mcp_list_tools.in_progress'.
Valori possibili: response.mcp_list_tools.in_progress		 Sì

OpenAI.ResponseOutputItemAddedEvent

Generato quando viene aggiunto un nuovo elemento di output.

Name Tipo Description Obbligatorio Predefinito
oggetto object Elemento di contenuto usato per generare una risposta. Sì
└* id corda No
└─ Tipo OpenAI.ItemType No
output_index Intero Indice dell'elemento di output aggiunto. Sì
type enum Tipo dell'evento. Sempre response.output_item.added.
Valori possibili: response.output_item.added		 Sì

OpenAI.ResponseOutputItemDoneEvent

Generato quando un elemento di output viene contrassegnato come completato.

Name Tipo Description Obbligatorio Predefinito
oggetto object Elemento di contenuto usato per generare una risposta. Sì
└* id corda No
└─ Tipo OpenAI.ItemType No
output_index Intero Indice dell'elemento di output contrassegnato come completato. Sì
type enum Tipo dell'evento. Sempre response.output_item.done.
Valori possibili: response.output_item.done		 Sì

OpenAI.ResponsePromptVariables

Mapping facoltativo dei valori da sostituire con le variabili nel prompt. I valori di sostituzione possono essere stringhe o altri tipi di input response, ad esempio immagini o file.

Tipo: oggetto

OpenAI.ResponseQueuedEvent

Generato quando una risposta viene accodata e in attesa di essere elaborata.

Name Tipo Description Obbligatorio Predefinito
response object Sì
└* sfondo Boolean Indica se eseguire la risposta del modello in background. No Falso
└created_at Intero Timestamp Unix (in secondi) di quando è stata creata questa risposta. No
└─ Errore OpenAI.ResponseError Oggetto di errore restituito quando il modello non riesce a generare una risposta. No
└* id corda Identificatore univoco per questa risposta. No
└dettagli_incompleti object Informazioni dettagliate sul motivo per cui la risposta è incompleta. No
└* motivo enum Motivo per cui la risposta è incompleta.
Valori possibili: max_output_tokens, content_filter		 No
└* istruzioni stringa o matrice Messaggio di sistema (o sviluppatore) inserito nel contesto del modello.

Quando si usa insieme previous_response_ida , le istruzioni di una risposta precedente non verranno trasportate alla risposta successiva. In questo modo è semplice scambiare messaggi di sistema (o sviluppatore) in nuove risposte.		 No
└ max_output_tokens Intero Limite superiore per il numero di token che possono essere generati per una risposta, inclusi i token di output visibili e i token di ragionamento No
└max_tool_calls Intero Numero massimo di chiamate totali agli strumenti predefiniti che possono essere elaborati in una risposta. Questo numero massimo si applica a tutte le chiamate predefinite degli strumenti, non per singolo strumento. Eventuali ulteriori tentativi di chiamare uno strumento dal modello verranno ignorati. No
└─ metadati object Set di 16 coppie chiave-valore che possono essere collegate a un oggetto . Ciò può essere utile per archiviare informazioni aggiuntive sull'oggetto in un formato strutturato ed eseguire query sugli oggetti tramite API o il dashboard.

Le chiavi sono stringhe con una lunghezza massima di 64 caratteri. I valori sono stringhe con una lunghezza massima di 512 caratteri.		 No
└─ oggetto enum Tipo di oggetto di questa risorsa: sempre impostato su response.
Valori possibili: response		 No
└─ uscita array Matrice di elementi di contenuto generati dal modello.

- La lunghezza e l'ordine degli elementi nella output matrice dipendono dalla risposta del modello.
- Anziché accedere al primo elemento nella output matrice e presupponendo che si tratti di un assistant messaggio con il contenuto generato dal modello, è consigliabile usare la output_text proprietà in cui è supportato negli SDK.		 No
└output_text corda Proprietà utile solo SDK che contiene l'output di testo aggregato di tutti gli output_text elementi della output matrice, se presenti.
Supportato negli SDK Python e JavaScript.		 No
└parallel_tool_calls Boolean Indica se consentire al modello di eseguire chiamate degli strumenti in parallelo. No Vero
└─previous_response_id corda ID univoco della risposta precedente al modello. Usare questa opzione per creare conversazioni a più turni. No
└* prompt OpenAI.Prompt Riferimento a un modello di richiesta e alle relative variabili. No
└* ragionamento OpenAI.Reasoning Solo modelli di serie o

Opzioni di configurazione per i modelli di ragionamento.		 No
└─ stato enum Stato della generazione della risposta. Uno di completed, failed, in_progresscancelled, queued, o incomplete.
Valori possibili: completed, failedin_progress, cancelled, , queuedincomplete		 No
└* temperatura number Temperatura di campionamento da usare, compresa tra 0 e 2. Valori più alti come 0,8 renderanno l'output più casuale, mentre i valori inferiori come 0,2 lo renderanno più incentrato e deterministico.
In genere è consigliabile modificare questa impostazione o top_p non entrambe.		 No
└─ testo object Opzioni di configurazione per una risposta di testo dal modello. Può essere un testo normale o dati JSON strutturati. No
└* formato OpenAI.ResponseTextFormatConfiguration No
└tool_choice OpenAI.ToolChoiceOptions o OpenAI.ToolChoiceObject Come il modello deve selezionare quale strumento (o strumenti) usare durante la generazione di una risposta. Vedere il tools parametro per informazioni su come specificare gli strumenti che il modello può chiamare. No
Strumenti └* array Una matrice di strumenti che il modello può chiamare durante la generazione di una risposta. È possibile specificare lo strumento da usare impostando il tool_choice parametro .

Le due categorie di strumenti che è possibile fornire il modello sono:

- Strumenti predefiniti: strumenti forniti da OpenAI che estendono le funzionalità del modello.		 No
└ top_logprobs Intero 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. No
└top_p number Un'alternativa al campionamento con temperatura, denominata campionamento del nucleo, in cui il modello considera i risultati dei token con top_p massa di probabilità. Quindi 0,1 significa che vengono considerati solo i token che comprendono i primi 10% massa di probabilità.

In genere è consigliabile modificare questa impostazione o temperature non entrambe.		 No
└─ troncamento enum Strategia di troncamento da usare per la risposta del modello.
- auto: se il contesto di questa risposta e quelli precedenti supera le dimensioni della finestra di contesto del modello, il modello tronca la risposta per adattarsi alla finestra di contesto eliminando gli elementi di input al centro della conversazione.
- disabled (impostazione predefinita): se una risposta del modello supererà le dimensioni della finestra di contesto per un modello, la richiesta avrà esito negativo con un errore 400.
Valori possibili: auto, disabled		 No
└─ utilizzo OpenAI.ResponseUsage Rappresenta i dettagli di utilizzo dei token, inclusi i token di input, i token di output, la suddivisione dei token di output e i token totali usati. No
└─ utente corda Identificatore univoco che rappresenta l'utente finale, che consente a OpenAI di monitorare e rilevare gli abusi. No
type enum Tipo dell'evento. Sempre 'response.queued'.
Valori possibili: response.queued		 Sì

OpenAI.ResponseReasoningDeltaEvent

Generato quando è presente un delta (aggiornamento parziale) al contenuto di ragionamento.

Name Tipo Description Obbligatorio Predefinito
content_index Intero Indice della parte del contenuto di ragionamento all'interno dell'elemento di output. Sì
delta Aggiornamento parziale al contenuto di ragionamento. Sì
item_id corda Identificatore univoco dell'elemento per il quale viene aggiornato il motivo. Sì
output_index Intero Indice dell'elemento di output nella matrice di output della risposta. Sì
type enum Tipo dell'evento. Sempre 'response.reasoning.delta'.
Valori possibili: response.reasoning.delta		 Sì

OpenAI.ResponseReasoningDoneEvent

Generato quando il contenuto di ragionamento viene finalizzato per un elemento.

Name Tipo Description Obbligatorio Predefinito
content_index Intero Indice della parte del contenuto di ragionamento all'interno dell'elemento di output. Sì
item_id corda Identificatore univoco dell'elemento per il quale viene finalizzato il ragionamento. Sì
output_index Intero Indice dell'elemento di output nella matrice di output della risposta. Sì
text corda Testo di ragionamento finalizzato. Sì
type enum Tipo dell'evento. Sempre 'response.reasoning.done'.
Valori possibili: response.reasoning.done		 Sì

OpenAI.ResponseReasoningSummaryDeltaEvent

Generato quando è presente un delta (aggiornamento parziale) al contenuto di riepilogo del ragionamento.

Name Tipo Description Obbligatorio Predefinito
delta Aggiornamento parziale al contenuto di riepilogo del ragionamento. Sì
item_id corda Identificatore univoco dell'elemento per il quale viene aggiornato il riepilogo dei motivi. Sì
output_index Intero Indice dell'elemento di output nella matrice di output della risposta. Sì
summary_index Intero Indice della parte di riepilogo all'interno dell'elemento di output. Sì
type enum Tipo dell'evento. Sempre "response.reasoning_summary.delta".
Valori possibili: response.reasoning_summary.delta		 Sì

OpenAI.ResponseReasoningSummaryDoneEvent

Generato quando il contenuto di riepilogo del ragionamento viene finalizzato per un elemento.

Name Tipo Description Obbligatorio Predefinito
item_id corda Identificatore univoco dell'elemento per il quale viene finalizzato il riepilogo del ragionamento. Sì
output_index Intero Indice dell'elemento di output nella matrice di output della risposta. Sì
summary_index Intero Indice della parte di riepilogo all'interno dell'elemento di output. Sì
text corda Testo di riepilogo del ragionamento finalizzato. Sì
type enum Tipo dell'evento. Sempre 'response.reasoning_summary.done'.
Valori possibili: response.reasoning_summary.done		 Sì

OpenAI.ResponseReasoningSummaryPartAddedEvent

Generato quando viene aggiunta una nuova parte di riepilogo del ragionamento.

Name Tipo Description Obbligatorio Predefinito
item_id corda L'ID dell'elemento a cui è associata questa parte di riepilogo. Sì
output_index Intero L'indice dell'elemento di output a cui è associata questa parte di riepilogo. Sì
part object Sì
└─ Tipo OpenAI.ReasoningItemSummaryPartType No
summary_index Intero Indice della parte di riepilogo all'interno del riepilogo del ragionamento. Sì
type enum Tipo dell'evento. Sempre response.reasoning_summary_part.added.
Valori possibili: response.reasoning_summary_part.added		 Sì

OpenAI.ResponseReasoningSummaryPartDoneEvent

Generato quando viene completata una parte di riepilogo del ragionamento.

Name Tipo Description Obbligatorio Predefinito
item_id corda L'ID dell'elemento a cui è associata questa parte di riepilogo. Sì
output_index Intero L'indice dell'elemento di output a cui è associata questa parte di riepilogo. Sì
part object Sì
└─ Tipo OpenAI.ReasoningItemSummaryPartType No
summary_index Intero Indice della parte di riepilogo all'interno del riepilogo del ragionamento. Sì
type enum Tipo dell'evento. Sempre response.reasoning_summary_part.done.
Valori possibili: response.reasoning_summary_part.done		 Sì

OpenAI.ResponseReasoningSummaryTextDeltaEvent

Generato quando un delta viene aggiunto a un testo di riepilogo del ragionamento.

Name Tipo Description Obbligatorio Predefinito
delta corda Delta del testo aggiunto al riepilogo. Sì
item_id corda L'ID dell'elemento a cui è associato questo delta del testo di riepilogo. Sì
output_index Intero L'indice dell'elemento di output a cui è associato questo delta del testo di riepilogo. Sì
summary_index Intero Indice della parte di riepilogo all'interno del riepilogo del ragionamento. Sì
type enum Tipo dell'evento. Sempre response.reasoning_summary_text.delta.
Valori possibili: response.reasoning_summary_text.delta		 Sì

OpenAI.ResponseReasoningSummaryTextDoneEvent

Generato quando viene completato un testo di riepilogo del ragionamento.

Name Tipo Description Obbligatorio Predefinito
item_id corda L'ID dell'elemento a cui è associato questo testo di riepilogo. Sì
output_index Intero L'indice dell'elemento di output a cui è associato questo testo di riepilogo. Sì
summary_index Intero Indice della parte di riepilogo all'interno del riepilogo del ragionamento. Sì
text corda Testo completo del riepilogo del ragionamento completato. Sì
type enum Tipo dell'evento. Sempre response.reasoning_summary_text.done.
Valori possibili: response.reasoning_summary_text.done		 Sì

OpenAI.ResponseRefusalDeltaEvent

Emesso quando è presente un testo di rifiuto parziale.

Name Tipo Description Obbligatorio Predefinito
content_index Intero Indice della parte contenuto a cui viene aggiunto il testo di rifiuto. Sì
delta corda Testo di rifiuto aggiunto. Sì
item_id corda ID dell'elemento di output a cui viene aggiunto il testo di rifiuto. Sì
output_index Intero Indice dell'elemento di output a cui viene aggiunto il testo di rifiuto. Sì
type enum Tipo dell'evento. Sempre response.refusal.delta.
Valori possibili: response.refusal.delta		 Sì

OpenAI.ResponseRefusalDoneEvent

Emesso quando il testo del rifiuto viene finalizzato.

Name Tipo Description Obbligatorio Predefinito
content_index Intero Indice della parte contenuto che il testo di rifiuto viene finalizzato. Sì
item_id corda ID dell'elemento di output che il testo di rifiuto viene finalizzato. Sì
output_index Intero Indice dell'elemento di output che il testo di rifiuto viene finalizzato. Sì
refusal corda Testo di rifiuto finalizzato. Sì
type enum Tipo dell'evento. Sempre response.refusal.done.
Valori possibili: response.refusal.done		 Sì

OpenAI.ResponseStreamEvent

Discriminatorio per OpenAI.ResponseStreamEvent

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

Valore del tipo Schema
response.completed OpenAI.ResponseCompletedEvent
response.content_part.added OpenAI.ResponseContentPartAddedEvent
response.content_part.done OpenAI.ResponseContentPartDoneEvent
response.created OpenAI.ResponseCreatedEvent
error OpenAI.ResponseErrorEvent
response.file_search_call.completed OpenAI.ResponseFileSearchCallCompletedEvent
response.file_search_call.in_progress OpenAI.ResponseFileSearchCallInProgressEvent
response.file_search_call.searching OpenAI.ResponseFileSearchCallSearchingEvent
response.function_call_arguments.delta OpenAI.ResponseFunctionCallArgumentsDeltaEvent
response.function_call_arguments.done OpenAI.ResponseFunctionCallArgumentsDoneEvent
response.in_progress OpenAI.ResponseInProgressEvent
response.failed OpenAI.ResponseFailedEvent
response.incomplete OpenAI.ResponseIncompleteEvent
response.output_item.added OpenAI.ResponseOutputItemAddedEvent
response.output_item.done OpenAI.ResponseOutputItemDoneEvent
response.refusal.delta OpenAI.ResponseRefusalDeltaEvent
response.refusal.done OpenAI.ResponseRefusalDoneEvent
response.output_text.delta OpenAI.ResponseTextDeltaEvent
response.output_text.done OpenAI.ResponseTextDoneEvent
response.reasoning_summary_part.added OpenAI.ResponseReasoningSummaryPartAddedEvent
response.reasoning_summary_part.done OpenAI.ResponseReasoningSummaryPartDoneEvent
response.reasoning_summary_text.delta OpenAI.ResponseReasoningSummaryTextDeltaEvent
response.reasoning_summary_text.done OpenAI.ResponseReasoningSummaryTextDoneEvent
response.web_search_call.completed OpenAI.ResponseWebSearchCallCompletedEvent
response.web_search_call.in_progress OpenAI.ResponseWebSearchCallInProgressEvent
response.web_search_call.searching OpenAI.ResponseWebSearchCallSearchingEvent
response.image_generation_call.completed OpenAI.ResponseImageGenCallCompletedEvent
response.image_generation_call.generating OpenAI.ResponseImageGenCallGeneratingEvent
response.image_generation_call.in_progress OpenAI.ResponseImageGenCallInProgressEvent
response.image_generation_call.partial_image OpenAI.ResponseImageGenCallPartialImageEvent
response.mcp_call.arguments_delta OpenAI.ResponseMCPCallArgumentsDeltaEvent
response.mcp_call.arguments_done OpenAI.ResponseMCPCallArgumentsDoneEvent
response.mcp_call.completed OpenAI.ResponseMCPCallCompletedEvent
response.mcp_call.failed OpenAI.ResponseMCPCallFailedEvent
response.mcp_call.in_progress OpenAI.ResponseMCPCallInProgressEvent
response.mcp_list_tools.completed OpenAI.ResponseMCPListToolsCompletedEvent
response.mcp_list_tools.failed OpenAI.ResponseMCPListToolsFailedEvent
response.mcp_list_tools.in_progress OpenAI.ResponseMCPListToolsInProgressEvent
response.queued OpenAI.ResponseQueuedEvent
response.reasoning.delta OpenAI.ResponseReasoningDeltaEvent
response.reasoning.done OpenAI.ResponseReasoningDoneEvent
response.reasoning_summary.delta OpenAI.ResponseReasoningSummaryDeltaEvent
response.reasoning_summary.done OpenAI.ResponseReasoningSummaryDoneEvent
response.code_interpreter_call_code.delta OpenAI.ResponseCodeInterpreterCallCodeDeltaEvent
response.code_interpreter_call_code.done OpenAI.ResponseCodeInterpreterCallCodeDoneEvent
response.code_interpreter_call.completed OpenAI.ResponseCodeInterpreterCallCompletedEvent
response.code_interpreter_call.in_progress OpenAI.ResponseCodeInterpreterCallInProgressEvent
response.code_interpreter_call.interpreting OpenAI.ResponseCodeInterpreterCallInterpretingEvent
Name Tipo Description Obbligatorio Predefinito
sequence_number Intero Numero di sequenza per questo evento. Sì
type OpenAI.ResponseStreamEventType Sì

OpenAI.ResponseStreamEventType

Proprietà Value
Type corda
Valori response.audio.delta
response.audio.done
response.audio_transcript.delta
response.audio_transcript.done
response.code_interpreter_call_code.delta
response.code_interpreter_call_code.done
response.code_interpreter_call.completed
response.code_interpreter_call.in_progress
response.code_interpreter_call.interpreting
response.completed
response.content_part.added
response.content_part.done
response.created
error
response.file_search_call.completed
response.file_search_call.in_progress
response.file_search_call.searching
response.function_call_arguments.delta
response.function_call_arguments.done
response.in_progress
response.failed
response.incomplete
response.output_item.added
response.output_item.done
response.refusal.delta
response.refusal.done
response.output_text.annotation.added
response.output_text.delta
response.output_text.done
response.reasoning_summary_part.added
response.reasoning_summary_part.done
response.reasoning_summary_text.delta
response.reasoning_summary_text.done
response.web_search_call.completed
response.web_search_call.in_progress
response.web_search_call.searching
response.image_generation_call.completed
response.image_generation_call.generating
response.image_generation_call.in_progress
response.image_generation_call.partial_image
response.mcp_call.arguments_delta
response.mcp_call.arguments_done
response.mcp_call.completed
response.mcp_call.failed
response.mcp_call.in_progress
response.mcp_list_tools.completed
response.mcp_list_tools.failed
response.mcp_list_tools.in_progress
response.queued
response.reasoning.delta
response.reasoning.done
response.reasoning_summary.delta
response.reasoning_summary.done

OpenAI.ResponseTextDeltaEvent

Generato quando è presente un delta di testo aggiuntivo.

Name Tipo Description Obbligatorio Predefinito
content_index Intero Indice della parte di contenuto a cui è stato aggiunto il delta del testo. Sì
delta corda Delta del testo aggiunto. Sì
item_id corda ID dell'elemento di output a cui è stato aggiunto il delta del testo. Sì
output_index Intero Indice dell'elemento di output a cui è stato aggiunto il delta del testo. Sì
type enum Tipo dell'evento. Sempre response.output_text.delta.
Valori possibili: response.output_text.delta		 Sì

OpenAI.ResponseTextDoneEvent

Generato quando viene finalizzato il contenuto di testo.

Name Tipo Description Obbligatorio Predefinito
content_index Intero Indice della parte di contenuto che il contenuto del testo è finalizzato. Sì
item_id corda ID dell'elemento di output che il contenuto del testo viene finalizzato. Sì
output_index Intero Indice dell'elemento di output finalizzato al contenuto di testo. Sì
text corda Contenuto di testo finalizzato. Sì
type enum Tipo dell'evento. Sempre response.output_text.done.
Valori possibili: response.output_text.done		 Sì

OpenAI.ResponseTextFormatConfiguration

Discriminatorio per OpenAI.ResponseTextFormatConfiguration

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

Valore del tipo Schema
text OpenAI.ResponseTextFormatConfigurationText
json_object OpenAI.ResponseTextFormatConfigurationJsonObject
json_schema OpenAI.ResponseTextFormatConfigurationJsonSchema
Name Tipo Description Obbligatorio Predefinito
type OpenAI.ResponseTextFormatConfigurationType Oggetto che specifica il formato che il modello deve restituire.

La configurazione { "type": "json_schema" } abilita gli output strutturati, che garantisce che il modello corrisponda allo schema JSON fornito. Il formato predefinito non include { "type": "text" } opzioni aggiuntive.

Non consigliato per i modelli gpt-4o e versioni successive:

L'impostazione su { "type": "json_object" } abilita la modalità JSON precedente, che garantisce che il messaggio generato dal modello sia JSON valido. L'uso json_schema è preferibile per i modelli che lo supportano.		 Sì

OpenAI.ResponseTextFormatConfigurationJsonObject

Name Tipo Description Obbligatorio Predefinito
type enum
Valori possibili: json_object		 Sì

OpenAI.ResponseTextFormatConfigurationJsonSchema

Formato di risposta dello schema JSON. Usato per generare risposte JSON strutturate.

Name Tipo Description Obbligatorio Predefinito
description corda Descrizione del formato di risposta, usato dal modello per determinare come rispondere nel formato. No
name corda 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. Sì
schema OpenAI.ResponseFormatJsonSchemaSchema Schema per il formato di risposta, descritto come oggetto Schema JSON.
Informazioni su come creare schemi JSON qui.		 Sì
rigido 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 schema campo. Solo un subset di schema JSON è supportato quando strict è true.		 No Falso
type enum Tipo di formato di risposta definito. Sempre json_schema.
Valori possibili: json_schema		 Sì

OpenAI.ResponseTextFormatConfigurationText

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

OpenAI.ResponseTextFormatConfigurationType

Oggetto che specifica il formato che il modello deve restituire.

La configurazione { "type": "json_schema" } abilita gli output strutturati, che garantisce che il modello corrisponda allo schema JSON fornito.

Il formato predefinito non include { "type": "text" } opzioni aggiuntive.

Non consigliato per i modelli gpt-4o e versioni successive:

L'impostazione su { "type": "json_object" } abilita la modalità JSON precedente, che garantisce che il messaggio generato dal modello sia JSON valido. L'uso json_schema è preferibile per i modelli che lo supportano.

Proprietà Value
Descrizione Oggetto che specifica il formato che il modello deve restituire.

La configurazione { "type": "json_schema" } abilita gli output strutturati, che garantisce che il modello corrisponda allo schema JSON fornito.

Il formato predefinito non include { "type": "text" } opzioni aggiuntive.

Non consigliato per i modelli gpt-4o e versioni successive:

L'impostazione su { "type": "json_object" } abilita la modalità JSON precedente, che garantisce che il messaggio generato dal modello sia JSON valido. L'uso json_schemaè preferibile per i modelli che lo supportano.

OpenAI.ResponseUsage

Rappresenta i dettagli di utilizzo dei token, inclusi i token di input, i token di output, la suddivisione dei token di output e i token totali usati.

Name Tipo Description Obbligatorio Predefinito
input_tokens Intero Numero di token di input. Sì
input_tokens_details object Dettaglio dei token di input. Sì
└cached_tokens Intero Numero di token recuperati dalla cache. No
output_tokens Intero Numero di token di output. Sì
output_tokens_details object Dettaglio dei token di output. Sì
└─ token_di_ragionamento Intero Numero di token di ragionamento. No
total_tokens Intero Numero totale di token usati. Sì

OpenAI.ResponseWebSearchCallCompletedEvent

Nota: web_search non è ancora disponibile tramite Azure OpenAI.

Name Tipo Description Obbligatorio Predefinito
item_id corda ID univoco per l'elemento di output associato alla chiamata di ricerca Web. Sì
output_index Intero Indice dell'elemento di output a cui è associata la chiamata di ricerca Web. Sì
type enum Tipo dell'evento. Sempre response.web_search_call.completed.
Valori possibili: response.web_search_call.completed		 Sì

OpenAI.ResponseWebSearchCallInProgressEvent

Nota: web_search non è ancora disponibile tramite Azure OpenAI.

Name Tipo Description Obbligatorio Predefinito
item_id corda ID univoco per l'elemento di output associato alla chiamata di ricerca Web. Sì
output_index Intero Indice dell'elemento di output a cui è associata la chiamata di ricerca Web. Sì
type enum Tipo dell'evento. Sempre response.web_search_call.in_progress.
Valori possibili: response.web_search_call.in_progress		 Sì

OpenAI.ResponseWebSearchCallSearchingEvent

Nota: web_search non è ancora disponibile tramite Azure OpenAI.

Name Tipo Description Obbligatorio Predefinito
item_id corda ID univoco per l'elemento di output associato alla chiamata di ricerca Web. Sì
output_index Intero Indice dell'elemento di output a cui è associata la chiamata di ricerca Web. Sì
type enum Tipo dell'evento. Sempre response.web_search_call.searching.
Valori possibili: response.web_search_call.searching		 Sì

OpenAI.ResponsesAssistantMessageItemParam

Elemento del parametro del messaggio con il assistant ruolo .

Name Tipo Description Obbligatorio Predefinito
contenuto array Contenuto associato al messaggio. Sì
Ruolo enum Ruolo del messaggio, che è sempre assistant.
Valori possibili: assistant		 Sì

OpenAI.ResponsesAssistantMessageItemResource

Elemento della risorsa messaggio con il assistant ruolo .

Name Tipo Description Obbligatorio Predefinito
contenuto array Contenuto associato al messaggio. Sì
Ruolo enum Ruolo del messaggio, che è sempre assistant.
Valori possibili: assistant		 Sì

OpenAI.ResponsesDeveloperMessageItemParam

Elemento del parametro del messaggio con il developer ruolo .

Name Tipo Description Obbligatorio Predefinito
contenuto array Contenuto associato al messaggio. Sì
Ruolo enum Ruolo del messaggio, che è sempre developer.
Valori possibili: developer		 Sì

OpenAI.ResponsesDeveloperMessageItemResource

Elemento della risorsa messaggio con il developer ruolo .

Name Tipo Description Obbligatorio Predefinito
contenuto array Contenuto associato al messaggio. Sì
Ruolo enum Ruolo del messaggio, che è sempre developer.
Valori possibili: developer		 Sì

OpenAI.ResponsesMessageItemParam

Elemento del messaggio di risposta, che rappresenta un ruolo e un contenuto, come specificato come parametri di richiesta client.

Discriminatorio per OpenAI.ResponsesMessageItemParam

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

Valore del tipo Schema
user OpenAI.ResponsesUserMessageItemParam
system OpenAI.ResponsesSystemMessageItemParam
developer OpenAI.ResponsesDeveloperMessageItemParam
assistant OpenAI.ResponsesAssistantMessageItemParam
Name Tipo Description Obbligatorio Predefinito
Ruolo object Raccolta di ruoli validi per le risposte agli elementi del messaggio. Sì
type enum Tipo dell'elemento delle risposte, che è sempre "message".
Valori possibili: message		 Sì

OpenAI.ResponsesMessageItemResource

Elemento della risorsa del messaggio di risposta, che rappresenta un ruolo e un contenuto, come specificato nelle risposte del servizio.

Discriminare per OpenAI.ResponsesMessageItemResource

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

Valore del tipo Schema
user OpenAI.ResponsesUserMessageItemResource
system OpenAI.ResponsesSystemMessageItemResource
developer OpenAI.ResponsesDeveloperMessageItemResource
assistant OpenAI.ResponsesAssistantMessageItemResource
Name Tipo Description Obbligatorio Predefinito
Ruolo object Raccolta di ruoli validi per le risposte agli elementi del messaggio. Sì
stato enum Stato dell'elemento. Uno di in_progress, completedo incomplete. Popolato quando gli elementi vengono restituiti tramite API.
Valori possibili: in_progress, completed, incomplete		 Sì
type enum Tipo dell'elemento delle risposte, che è sempre "message".
Valori possibili: message		 Sì

OpenAI.ResponsesMessageRole

Raccolta di ruoli validi per le risposte agli elementi del messaggio.

Proprietà Value
Descrizione Raccolta di ruoli validi per le risposte agli elementi del messaggio.
Type corda
Valori system
developer
user
assistant

OpenAI.ResponsesSystemMessageItemParam

Elemento del parametro del messaggio con il system ruolo .

Name Tipo Description Obbligatorio Predefinito
contenuto array Contenuto associato al messaggio. Sì
Ruolo enum Ruolo del messaggio, che è sempre system.
Valori possibili: system		 Sì

OpenAI.ResponsesSystemMessageItemResource

Elemento della risorsa messaggio con il system ruolo .

Name Tipo Description Obbligatorio Predefinito
contenuto array Contenuto associato al messaggio. Sì
Ruolo enum Ruolo del messaggio, che è sempre system.
Valori possibili: system		 Sì

OpenAI.ResponsesUserMessageItemParam

Elemento del parametro del messaggio con il user ruolo .

Name Tipo Description Obbligatorio Predefinito
contenuto array Contenuto associato al messaggio. Sì
Ruolo enum Ruolo del messaggio, che è sempre user.
Valori possibili: user		 Sì

OpenAI.ResponsesUserMessageItemResource

Elemento della risorsa messaggio con il user ruolo .

Name Tipo Description Obbligatorio Predefinito
contenuto array Contenuto associato al messaggio. Sì
Ruolo enum Ruolo del messaggio, che è sempre user.
Valori possibili: user		 Sì

OpenAI.RunGraderRequest

Name Tipo Description Obbligatorio Predefinito
Selezionatore object Oggetto StringCheckGrader che esegue un confronto di stringhe tra input e riferimento usando un'operazione specificata. Sì
└' calculate_output corda Formula per calcolare l'output in base ai risultati del grader. No
└' evaluation_metric enum Metrica di valutazione da usare. Uno di fuzzy_match, bleugleu, meteor, rouge_1, rouge_2, rouge_3, rouge_4, , rouge_5o rouge_l.
Valori possibili: fuzzy_match, bleu, gleumeteor, rouge_1, rouge_2, rouge_3, rouge_4, rouge_5rouge_l		 No
└️ voti object No
└' image_tag corda Tag immagine da usare per lo script Python. No
└ Input array Testo di input. Ciò può includere stringhe di modello. No
└─ Modello corda Modello da utilizzare per la valutazione. No
└> nome corda Nome del grader. No
└─ Operazione enum Operazione di controllo della stringa da eseguire. Uno di eq, ne, likeo ilike.
Valori possibili: eq, ne, like, ilike		 No
└* intervallo array Intervallo del punteggio. Il valore predefinito è [0, 1]. No
Riferimento corda Testo a cui viene eseguito il voto. No
└sampling_params Parametri di campionamento per il modello. No
└─ sorgente corda Codice sorgente dello script Python. No
└─ Tipo enum Tipo di oggetto, che è sempre multi.
Valori possibili: multi		 No
oggetto Elemento del set di dati fornito al grader. Verrà usato per popolare lo item spazio dei nomi. No
model_sample corda Esempio di modello da valutare. Questo valore verrà usato per popolare lo spazio dei sample nomi.
La output_json variabile verrà popolata se l'esempio di modello è una stringa JSON valida.		 Sì

OpenAI.RunGraderResponse

Name Tipo Description Obbligatorio Predefinito
metadata object Sì
└─ errori object No
└• formula_parse_error Boolean No
└' invalid_variable_error Boolean No
└• model_grader_parse_error Boolean No
└' model_grader_refusal_error Boolean No
└• model_grader_server_error Boolean No
└' model_grader_server_error_details corda No
└' other_error Boolean No
└• python_grader_runtime_error Boolean No
└' python_grader_runtime_error_details corda No
└' python_grader_server_error Boolean No
└• python_grader_server_error_type corda No
└' sample_parse_error Boolean No
└' truncated_observation_error Boolean No
└' unresponsive_reward_error Boolean No
└' execution_time number No
└> nome corda No
└' sampled_model_name corda No
└* punteggi No
└' token_usage Intero No
└─ Tipo corda No
model_grader_token_usage_per_model Sì
Ricompensa number Sì
sub_rewards Sì

OpenAI.StaticChunkingStrategy

Name Tipo Description Obbligatorio Predefinito
sovrapposizione_segmento_token Intero Numero di token che si sovrappongono tra blocchi. Il valore predefinito è 400.

Si noti che la sovrapposizione non deve superare la metà di max_chunk_size_tokens.		 Sì
dimensione_massima_chunk_token Intero Numero massimo di token in ogni blocco. Il valore predefinito è 800. Il valore minimo è 100 e il valore massimo è 4096. Sì

OpenAI.StaticChunkingStrategyRequestParam

Personalizzare la strategia di suddivisione in blocchi impostando le dimensioni dei blocchi e la sovrapposizione dei blocchi.

Name Tipo Description Obbligatorio Predefinito
statico OpenAI.StaticChunkingStrategy Sì
type enum Sempre static.
Valori possibili: static		 Sì

OpenAI.StaticChunkingStrategyResponseParam

Name Tipo Description Obbligatorio Predefinito
statico OpenAI.StaticChunkingStrategy Sì
type enum Sempre static.
Valori possibili: static		 Sì

OpenAI.StopConfiguration

Non supportato con i modelli o3 di ragionamento più recenti e o4-mini.

Fino a 4 sequenze in cui l'API smetterà di generare altri token. Il testo restituito non conterrà la sequenza di interruzione.

Questo schema accetta uno dei tipi seguenti:

  • Stringa
  • array

OpenAI.Tool

Discriminare per OpenAI.Tool

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

Valore del tipo Schema
function OpenAI.FunctionTool
file_search OpenAI.FileSearchTool
computer_use_preview OpenAI.ComputerUsePreviewTool
web_search_preview OpenAI.WebSearchPreviewTool
code_interpreter OpenAI.CodeInterpreterTool
image_generation OpenAI.ImageGenTool
local_shell OpenAI.LocalShellTool
mcp OpenAI.MCPTool
Name Tipo Description Obbligatorio Predefinito
type OpenAI.ToolType Strumento che può essere usato per generare una risposta. Sì

OpenAI.ToolChoiceObject

Discriminante per OpenAI.ToolChoiceObject

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

Valore del tipo Schema
file_search OpenAI.ToolChoiceObjectFileSearch
computer_use_preview OpenAI.ToolChoiceObjectComputer
web_search_preview OpenAI.ToolChoiceObjectWebSearch
image_generation OpenAI.ToolChoiceObjectImageGen
code_interpreter OpenAI.ToolChoiceObjectCodeInterpreter
function OpenAI.ToolChoiceObjectFunction
mcp OpenAI.ToolChoiceObjectMCP
Name Tipo Description Obbligatorio Predefinito
type OpenAI.ToolChoiceObjectType Indica che il modello deve usare uno strumento predefinito per generare una risposta. Sì

OpenAI.ToolChoiceObjectCodeInterpreter

Name Tipo Description Obbligatorio Predefinito
type enum
Valori possibili: code_interpreter		 Sì

OpenAI.ToolChoiceObjectComputer

Name Tipo Description Obbligatorio Predefinito
type enum
Valori possibili: computer_use_preview		 Sì

OpenAI.ToolChoiceObjectFileSearch

Name Tipo Description Obbligatorio Predefinito
type enum
Valori possibili: file_search		 Sì

OpenAI.ToolChoiceObjectFunction

Usare questa opzione per forzare il modello a chiamare una funzione specifica.

Name Tipo Description Obbligatorio Predefinito
name corda Nome della funzione da chiamare. Sì
type enum Per la chiamata di funzione, il tipo è sempre function.
Valori possibili: function		 Sì

OpenAI.ToolChoiceObjectImageGen

Name Tipo Description Obbligatorio Predefinito
type enum
Valori possibili: image_generation		 Sì

OpenAI.ToolChoiceObjectMCP

Usare questa opzione per forzare il modello a chiamare uno strumento specifico in un server MCP remoto.

Name Tipo Description Obbligatorio Predefinito
name corda Nome dello strumento da chiamare sul server. No
etichetta del server corda Etichetta del server MCP da usare. Sì
type enum Per gli strumenti MCP, il tipo è sempre mcp.
Valori possibili: mcp		 Sì

OpenAI.ToolChoiceObjectType

Indica che il modello deve usare uno strumento predefinito per generare una risposta.

Proprietà Value
Descrizione Indica che il modello deve usare uno strumento predefinito per generare una risposta.
Type corda
Valori file_search
function
computer_use_preview
web_search_preview
image_generation
code_interpreter
mcp

OpenAI.ToolChoiceObjectWebSearch

Nota: web_search non è ancora disponibile tramite Azure OpenAI.

Name Tipo Description Obbligatorio Predefinito
type enum
Valori possibili: web_search_preview		 Sì

OpenAI.ToolChoiceOptions

Controlla quale strumento (se presente) viene chiamato dal modello.

none indica che il modello non chiamerà alcuno strumento e genera invece un messaggio.

auto indica che il modello può scegliere tra la generazione di un messaggio o la chiamata di uno o più strumenti.

required significa che il modello deve chiamare uno o più strumenti.

Proprietà Value
Descrizione Controlla quale strumento (se presente) viene chiamato dal modello.

none indica che il modello non chiamerà alcuno strumento e genera invece un messaggio.

auto indica che il modello può scegliere tra la generazione di un messaggio o la chiamata di uno o più strumenti.

required significa che il modello deve chiamare uno o più strumenti.
Type corda
Valori none
auto
required

OpenAI.ToolType

Strumento che può essere usato per generare una risposta.

Proprietà Value
Descrizione Strumento che può essere usato per generare una risposta.
Type corda
Valori file_search
function
computer_use_preview
web_search_preview
mcp
code_interpreter
image_generation
local_shell

OpenAI.TopLogProb

Probabilità di log principale di un token.

Name Tipo Description Obbligatorio Predefinito
bytes array Sì
logprob number Sì
Token corda Sì

OpenAI.TranscriptionAudioResponseFormat

Riferimenti: OpenAI.AudioResponseFormat

OpenAI.TranscriptionInclude

Proprietà Value
Type corda
Valori logprobs

OpenAI.TranscriptionSegment

Name Tipo Description Obbligatorio Predefinito
avg_logprob number Logprob medio del segmento. Se il valore è inferiore a -1, considerare che i logprobs non sono riusciti. Sì
compression_ratio number Rapporto di compressione del segmento. Se il valore è maggiore di 2,4, prendere in considerazione l'errore di compressione. Sì
fine number Ora di fine del segmento in secondi. Sì
id Intero Identificatore univoco del segmento. Sì
no_speech_prob number Probabilità di nessun parlato nel segmento. Se il valore è superiore a 1,0 e è inferiore a -1, prendere in considerazione questo segmento invisibile all'utente avg_logprob . Sì
seek Intero Offset di ricerca del segmento. Sì
start number Ora di inizio del segmento in secondi. Sì
Temperatura number Parametro Temperature usato per generare il segmento. Sì
text corda Contenuto di testo del segmento. Sì
tokens array Matrice di ID token per il contenuto di testo. Sì

OpenAI.TranscriptionWord

Name Tipo Description Obbligatorio Predefinito
fine number Ora di fine della parola in secondi. Sì
start number Ora di inizio della parola in secondi. Sì
word corda Contenuto di testo della parola. Sì

OpenAI.TranslationAudioResponseFormat

Riferimenti: OpenAI.AudioResponseFormat

OpenAI.UpdateVectorStoreFileAttributesRequest

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

OpenAI.UpdateVectorStoreRequest

Name Tipo Description Obbligatorio Predefinito
scade dopo object Criteri di scadenza per un archivio vettoriale. No
Ancoraggio └* enum Timestamp di ancoraggio dopo il quale si applicano i criteri di scadenza. Ancoraggi supportati: last_active_at.
Valori possibili: last_active_at		 No
└* giorni Intero Numero di giorni dopo l'ora di ancoraggio che l'archivio vettoriale scadrà. No
metadata object Set di 16 coppie chiave-valore che possono essere collegate a un oggetto . Ciò può essere utile per archiviare informazioni aggiuntive sull'oggetto in un formato strutturato ed eseguire query sugli oggetti tramite API o il dashboard.

Le chiavi sono stringhe con una lunghezza massima di 64 caratteri. I valori sono stringhe con una lunghezza massima di 512 caratteri.		 No
name corda Nome dell'archivio vettoriale. No

OpenAI.VadConfig

Name Tipo Description Obbligatorio Predefinito
prefix_padding_ms Intero Quantità di audio da includere prima del riconoscimento vocale rilevato da VAD (in millisecondi). No 300
silence_duration_ms Intero Durata del silenzio per rilevare l'arresto vocale (in millisecondi).
Con valori più brevi il modello risponderà più rapidamente, ma può passare a brevi pause dall'utente.		 No 200
threshold number Soglia di riservatezza (da 0,0 a 1,0) per il rilevamento delle attività vocali. Una soglia più elevata richiederà un audio più forte per attivare il modello e quindi potrebbe offrire prestazioni migliori in ambienti rumorosi. No 0,5
type enum Deve essere impostato su server_vad per abilitare la suddivisione in blocchi manuale tramite VAD sul lato server.
Valori possibili: server_vad		 Sì

OpenAI.ValidateGraderRequest

Name Tipo Description Obbligatorio Predefinito
Selezionatore object Oggetto StringCheckGrader che esegue un confronto di stringhe tra input e riferimento usando un'operazione specificata. Sì
└' calculate_output corda Formula per calcolare l'output in base ai risultati del grader. No
└' evaluation_metric enum Metrica di valutazione da usare. Uno di fuzzy_match, bleugleu, meteor, rouge_1, rouge_2, rouge_3, rouge_4, , rouge_5o rouge_l.
Valori possibili: fuzzy_match, bleu, gleumeteor, rouge_1, rouge_2, rouge_3, rouge_4, rouge_5rouge_l		 No
└️ voti object No
└' image_tag corda Tag immagine da usare per lo script Python. No
└ Input array Testo di input. Ciò può includere stringhe di modello. No
└─ Modello corda Modello da utilizzare per la valutazione. No
└> nome corda Nome del grader. No
└─ Operazione enum Operazione di controllo della stringa da eseguire. Uno di eq, ne, likeo ilike.
Valori possibili: eq, ne, like, ilike		 No
└* intervallo array Intervallo del punteggio. Il valore predefinito è [0, 1]. No
Riferimento corda Testo a cui viene eseguito il voto. No
└sampling_params Parametri di campionamento per il modello. No
└─ sorgente corda Codice sorgente dello script Python. No
└─ Tipo enum Tipo di oggetto, che è sempre multi.
Valori possibili: multi		 No

OpenAI.ValidateGraderResponse

Name Tipo Description Obbligatorio Predefinito
Selezionatore object Oggetto StringCheckGrader che esegue un confronto di stringhe tra input e riferimento usando un'operazione specificata. No
└' calculate_output corda Formula per calcolare l'output in base ai risultati del grader. No
└' evaluation_metric enum Metrica di valutazione da usare. Uno di fuzzy_match, bleugleu, meteor, rouge_1, rouge_2, rouge_3, rouge_4, , rouge_5o rouge_l.
Valori possibili: fuzzy_match, bleu, gleumeteor, rouge_1, rouge_2, rouge_3, rouge_4, rouge_5rouge_l		 No
└️ voti object No
└' image_tag corda Tag immagine da usare per lo script Python. No
└ Input array Testo di input. Ciò può includere stringhe di modello. No
└─ Modello corda Modello da utilizzare per la valutazione. No
└> nome corda Nome del grader. No
└─ Operazione enum Operazione di controllo della stringa da eseguire. Uno di eq, ne, likeo ilike.
Valori possibili: eq, ne, like, ilike		 No
└* intervallo array Intervallo del punteggio. Il valore predefinito è [0, 1]. No
Riferimento corda Testo a cui viene eseguito il voto. No
└sampling_params Parametri di campionamento per il modello. No
└─ sorgente corda Codice sorgente dello script Python. No
└─ Tipo enum Tipo di oggetto, che è sempre multi.
Valori possibili: multi		 No

OpenAI.VectorStoreExpirationAfter

Criteri di scadenza per un archivio vettoriale.

Name Tipo Description Obbligatorio Predefinito
ancora enum Timestamp di ancoraggio dopo il quale si applicano i criteri di scadenza. Ancoraggi supportati: last_active_at.
Valori possibili: last_active_at		 Sì
Giorni Intero Numero di giorni dopo l'ora di ancoraggio che l'archivio vettoriale scadrà. Sì

OpenAI.VectorStoreFileAttributes

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

Tipo: oggetto

OpenAI.VectorStoreFileBatchObject

Batch di file collegati a un archivio vettoriale.

Name Tipo Description Obbligatorio Predefinito
creato_il Intero Timestamp Unix (in secondi) per il momento in cui è stato creato il batch dei file dell'archivio vettoriale. Sì
file_counts object Sì
└* annullato Intero Numero di file in cui è stato annullato. No
└* completato Intero Numero di file elaborati. No
└* non riuscito Intero Numero di file che non sono stati elaborati. No
└─ in corso Intero Numero di file in corso di elaborazione. No
└─ totale Intero Numero totale di file. No
id corda Identificatore a cui è possibile fare riferimento negli endpoint API. Sì
object enum Tipo di oggetto, che è sempre vector_store.file_batch.
Valori possibili: vector_store.files_batch		 Sì
stato enum Stato del batch di file dell'archivio vettoriale, che può essere in_progress, completedcancelledo failed.
Valori possibili: in_progress, completed, cancelled, failed		 Sì
ID del negozio vettoriale corda ID dell'archivio vettoriale a cui è associato il file. Sì

OpenAI.VectorStoreFileObject

Elenco di file collegati a un archivio vettoriale.

Name Tipo Description Obbligatorio Predefinito
attributes object Set di 16 coppie chiave-valore che possono essere collegate a un oggetto . Ciò può essere utile per archiviare informazioni aggiuntive sull'oggetto in un formato strutturato ed eseguire query sugli oggetti tramite API o il dashboard. Le chiavi sono stringhe con una lunghezza massima di 64 caratteri. I valori sono stringhe con una lunghezza massima di 512 caratteri, valori booleani o numeri. No
chunking_strategy object No
└─ Tipo enum
Valori possibili: static, other		 No
creato_il Intero Timestamp Unix (in secondi) per il momento in cui è stato creato il file dell'archivio vettoriale. Sì
id corda Identificatore a cui è possibile fare riferimento negli endpoint API. Sì
errore_ultimo object Ultimo errore associato a questo file dell'archivio vettoriale. null Sarà se non sono presenti errori. Sì
└─ codice enum Uno di server_error o rate_limit_exceeded.
Valori possibili: server_error, unsupported_file, invalid_file		 No
└* messaggio corda Descrizione leggibile dell'errore. No
object enum Tipo di oggetto, che è sempre vector_store.file.
Valori possibili: vector_store.file		 Sì
stato enum Stato del file dell'archivio vettoriale, che può essere in_progress, completed, cancelledo failed. Lo stato completed indica che il file dell'archivio vettoriale è pronto per l'uso.
Valori possibili: in_progress, completed, cancelled, failed		 Sì
usage_bytes Intero Utilizzo totale dell'archivio vettoriale in byte. Si noti che questo può essere diverso dalle dimensioni del file originale. Sì
ID del negozio vettoriale corda ID dell'archivio vettoriale a cui è associato il file. Sì

OpenAI.VectorStoreObject

Un archivio vettoriale è una raccolta di file elaborati che può essere usato dallo file_search strumento.

Name Tipo Description Obbligatorio Predefinito
creato_il Intero Timestamp Unix (in secondi) per il momento in cui è stato creato l'archivio vettoriale. Sì
scade dopo OpenAI.VectorStoreExpirationAfter Criteri di scadenza per un archivio vettoriale. No
scade_il Intero Timestamp Unix (in secondi) per la scadenza dell'archivio vettoriale. No
file_counts object Sì
└* annullato Intero Numero di file annullati. No
└* completato Intero Numero di file elaborati correttamente. No
└* non riuscito Intero Numero di file che non sono stati elaborati. No
└─ in corso Intero Numero di file in corso di elaborazione. No
└─ totale Intero Numero totale di file. No
id corda Identificatore a cui è possibile fare riferimento negli endpoint API. Sì
ultima_attività_il Intero Timestamp Unix (in secondi) per l'ultima attività dell'archivio vettoriale. Sì
metadata object Set di 16 coppie chiave-valore che possono essere collegate a un oggetto . Ciò può essere utile per archiviare informazioni aggiuntive sull'oggetto in un formato strutturato ed eseguire query sugli oggetti tramite API o il dashboard.

Le chiavi sono stringhe con una lunghezza massima di 64 caratteri. I valori sono stringhe con una lunghezza massima di 512 caratteri.		 Sì
name corda Nome dell'archivio vettoriale. Sì
object enum Tipo di oggetto, che è sempre vector_store.
Valori possibili: vector_store		 Sì
stato enum Stato dell'archivio vettoriale, che può essere expired, in_progresso completed. Lo stato completed indica che l'archivio vettoriale è pronto per l'uso.
Valori possibili: expired, in_progress, completed		 Sì
usage_bytes Intero Numero totale di byte utilizzati dai file nell'archivio vettoriale. Sì

OpenAI.VoiceIdsShared

Proprietà Value
Type corda
Valori alloy
ash
ballad
coral
echo
fable
onyx
nova
sage
shimmer
verse

OpenAI.WebSearchAction

Discriminare per OpenAI.WebSearchAction

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

Valore del tipo Schema
find OpenAI.WebSearchActionFind
open_page OpenAI.WebSearchActionOpenPage
search OpenAI.WebSearchActionSearch
Name Tipo Description Obbligatorio Predefinito
type OpenAI.WebSearchActionType Sì

OpenAI.WebSearchActionFind

Tipo di azione "find": cerca un criterio all'interno di una pagina caricata.

Name Tipo Description Obbligatorio Predefinito
pattern corda Modello o testo da cercare all'interno della pagina. Sì
type enum Tipo di azione.
Valori possibili: find		 Sì
Url corda URL della pagina in cui è stato cercato il modello. Sì

OpenAI.WebSearchActionOpenPage

Tipo di azione "open_page" - Apre un URL specifico dai risultati della ricerca.

Name Tipo Description Obbligatorio Predefinito
type enum Tipo di azione.
Valori possibili: open_page		 Sì
Url corda URL aperto dal modello. Sì

OpenAI.WebSearchActionSearch

Tipo di azione "search" - Esegue una query di ricerca Web.

Name Tipo Description Obbligatorio Predefinito
quesito corda Query di ricerca. Sì
type enum Tipo di azione.
Valori possibili: search		 Sì

OpenAI.WebSearchActionType

Proprietà Value
Type corda
Valori search
open_page
find

OpenAI.WebSearchPreviewTool

Nota: web_search non è ancora disponibile tramite Azure OpenAI.

Name Tipo Description Obbligatorio Predefinito
dimensione_del_contesto_di_ricerca enum Linee guida generali per la quantità di spazio della finestra di contesto da usare per la ricerca. Uno di low, mediumo high. medium è l'impostazione predefinita.
Valori possibili: low, medium, high		 No
type enum Tipo dello strumento di ricerca Web. Uno di web_search_preview o web_search_preview_2025_03_11.
Valori possibili: web_search_preview		 Sì
posizione_utente object No
└─ Tipo OpenAI.LocationType No

OpenAI.WebSearchToolCallItemParam

Nota: web_search non è ancora disponibile tramite Azure OpenAI.

Name Tipo Description Obbligatorio Predefinito
azione object Sì
└─ Tipo OpenAI.WebSearchActionType No
type enum
Valori possibili: web_search_call		 Sì

OpenAI.WebSearchToolCallItemResource

Nota: web_search non è ancora disponibile tramite Azure OpenAI.

Name Tipo Description Obbligatorio Predefinito
azione object Sì
└─ Tipo OpenAI.WebSearchActionType No
stato enum Stato della chiamata dello strumento di ricerca Web.
Valori possibili: in_progress, searching, completed, failed		 Sì
type enum
Valori possibili: web_search_call		 Sì

PineconeChatDataSource

Name Tipo Description Obbligatorio Predefinito
parameters object Informazioni sui parametri per controllare l'uso dell'origine dati Pinecone. Sì
└─ consenti_risultato_parziale Boolean Se impostato su true, il sistema consentirà l'uso di risultati parziali della ricerca e la richiesta avrà esito negativo se tutte le query parziali hanno esito negativo. Se non specificato o specificato come false, la richiesta avrà esito negativo se una query di ricerca ha esito negativo. No Falso
Autenticazione object No
└─ tasto corda No
└─ Tipo enum
Valori possibili: api_key		 No
└─ dipendenza_embedded object Rappresentazione di un'origine di vettorizzazione dei dati utilizzabile come risorsa di incorporamento con un'origine dati. No
└─ Tipo AzureChatDataSourceVectorizationSourceType Identificatore di differenziazione per l'origine di vettorizzazione concreta. No
└─ Ambiente corda Nome dell'ambiente da usare con Pinecone. No
└ fields_mapping object Mapping dei campi da applicare ai dati usati dall'origine dati Pinecone.
Si noti che i mapping dei campi del contenuto sono necessari per Pinecone.		 No
└content_fields array No
└─content_fields_separator corda No
└filepath_field corda No
└─ campo_titolo corda No
└url_field corda No
└ in_scope Boolean Indica se le query devono essere limitate all'uso dei dati indicizzati. No
└include_contexts array Proprietà del contesto di output da includere nella risposta.
Per impostazione predefinita, verranno richieste citazioni e finalità.		 No ['citazioni', 'intento']
└ index_name corda Nome dell'indice di database Pinecone da utilizzare. No
└max_search_queries Intero Numero massimo di query riscritte che devono essere inviate al provider di ricerca per un singolo messaggio utente.
Per impostazione predefinita, il sistema effettuerà una determinazione automatica.		 No
└* rigidità Intero La rigidità configurata del filtro per pertinenza della ricerca.
Maggiore rigidità aumenterà la precisione, ma un richiamo inferiore della risposta.		 No
└top_n_documents Intero Numero configurato di documenti da funzionalità nella query. No
type enum Identificatore di tipo discriminato, che è sempre "pinecone".
Valori possibili: pinecone		 Sì

Quality

Qualità del contenuto video da recuperare. Specifica la qualità del contenuto video che deve essere restituito.

Proprietà Value
Descrizione Qualità del contenuto video da recuperare.
Specifica la qualità del contenuto video che deve essere restituito.
Type corda
Valori high
low

ResponseFormatJSONSchemaRequest

Name Tipo Description Obbligatorio Predefinito
json_schema object Schema JSON per il formato di risposta Sì
type enum Tipo di formato di risposta
Valori possibili: json_schema		 Sì

ResponseModalities

Tipi di output che si desidera generare il modello. La maggior parte dei modelli è in grado di generare testo, ovvero l'impostazione predefinita:

["text"]

Il gpt-4o-audio-preview modello può essere usato anche per generare audio. Per richiedere che questo modello generi risposte sia di testo che audio, è possibile usare:

["text", "audio"]

Matrice di: stringa

SpeechGenerationResponseFormat

Formati di output audio supportati per la sintesi vocale.

Questo componente può essere uno dei seguenti:

VideoGeneration

Risultato della generazione di video.

Name Tipo Description Obbligatorio Predefinito
creato_il Intero Ora in cui è stata creata la generazione di video. Sì
height Intero Altezza del video. Sì
id corda ID della generazione di video. Sì
job_id corda ID del processo di generazione video per questo video. Sì
n_seconds Intero Durata della generazione di video. Sì
object enum
Valori possibili: video.generation		 Sì
prompt corda Richiesta di generazione di video. Sì
width Intero Larghezza del video. Sì

VideoGenerationJob

Un processo di generazione di video.

Name Tipo Description Obbligatorio Predefinito
creato_il Intero Ora di creazione del processo. Sì
scade_il Intero Ora in cui il processo viene eliminato automaticamente dal servizio. Il contenuto video e i metadati del processo devono essere archiviati prima di questa data per evitare la perdita di dati. No
failure_reason string (vedere modelli validi di seguito) No
terminato_il Intero L'ora in cui il lavoro è terminato con tutte le generazioni di video. No
Generazioni array Video generati per questo processo. Il numero dipende dal n_variants specificato e dal successo della creazione delle generazioni. No
height Intero Altezza del video. Sì
id corda ID del processo. Sì
inpaint_items array Elementi facoltativi per questo processo di generazione di video. No
model corda Nome della distribuzione da usare per questo processo di generazione video. Sì
n_seconds Intero Durata del processo di generazione video. Sì
n_variants Intero Numero di video da creare come varianti per questo processo di generazione di video. Sì
object enum
Valori possibili: video.generation.job		 Sì
prompt corda Richiesta di questo processo di generazione video. Sì
stato object Stato di un processo di generazione di video. Sì
width Intero Altezza del video. Sì

VideoGenerationJobList

Elenco dei processi di generazione di video.

Name Tipo Description Obbligatorio Predefinito
Dati array Elenco dei processi di generazione di video. Sì
first_id corda ID del primo processo nella pagina corrente, se disponibile. No
ha_di_piu Boolean Flag che indica se sono disponibili più processi dopo l'elenco. Sì
last_id corda ID dell'ultimo processo nella pagina corrente, se disponibile. No
object enum
Valori possibili: list		 Sì

Passaggi successivi

Informazioni sui modelli e sull'ottimizzazione con l'API REST. Altre informazioni sui modelli informazioni che alimentano Azure OpenAI.

  • Last updated on