Crea una conversazione

Corpo della richiesta · application/json

Tipo

object

Campi obbligatori

modelmessages

Corpo della richiesta obbligatorio

• modelstringObbligatorio

  ID del modello

• messagesarrayObbligatorio

  Elenco dei messaggi della conversazione

  Campi figli di messages (1)

  • []objectFacoltativo
    Campi figli di [] (6)

    • rolestringObbligatorio

      Ruolo del messaggio

      Enumerazione

      ["system","user","assistant","tool","developer"]

    • contentunionObbligatorio

      Contenuto del messaggio

      Ramo oneOf 1

      Tipo: string
      Ramo oneOf 2

      Tipo: array

      • []objectFacoltativo
        Campi figli di [] (6)

        • typestringFacoltativo

          Enumerazione

          ["text","image_url","input_audio","file","video_url"]

        • textstringFacoltativo

        • image_urlunionFacoltativo

          Accetta due formati wire: stringa URL/Base64 oppure oggetto {url, detail}. Solo per modelli con input immagine; non garantisce capacità visive su tutti i modelli.

          Ramo oneOf 1

          URL immagine o data URL Base64.

          Tipo: string
          Ramo oneOf 2

          L'oggetto deve fornire almeno url; Message.ParseContent normalizza detail a high per impostazione predefinita. Il supporto dipende dal modello visivo scelto.

          Tipo: object

          Obbligatorio in questo ramo: url

          • urlstringObbligatorio

            URL immagine o base64

          • detailstringFacoltativo

            Enumerazione

            ["low","high","auto"]

        • input_audioobjectFacoltativo
          Campi figli di input_audio (2)

          • datastringFacoltativo

            Dati audio codificati in Base64

          • formatstringFacoltativo

            Enumerazione

            ["wav","mp3"]

        • fileobjectFacoltativo
          Campi figli di file (3)

          • filenamestringFacoltativo

          • file_datastringFacoltativo

          • file_idstringFacoltativo

        • video_urlstringFacoltativo

          L'input wire letto effettivamente da Message.ParseContent è una stringa URL video, solo per modelli con input video. L'oggetto {url: ...} non entra nei risultati di contenuto/misurazione del parser e non è pubblicato come contratto utilizzabile.

    • namestringFacoltativo

      Nome del mittente

    • tool_callsarrayFacoltativo
      Campi figli di tool_calls (1)

      • []objectFacoltativo
        Campi figli di [] (3)

        • idstringFacoltativo

        • typestringFacoltativo

        • functionobjectFacoltativo
          Campi figli di function (2)

          • namestringFacoltativo

          • argumentsstringFacoltativo

    • tool_call_idstringFacoltativo

      ID chiamata strumento (per messaggi con ruolo tool)

    • reasoning_contentstringFacoltativo

      Contenuto del ragionamento

• temperaturenumberFacoltativo

  Temperatura di campionamento. Supporto e limiti secondo modello; nessun valore predefinito uniforme garantito.

• top_pnumberFacoltativo

  Parametro di campionamento nucleus. Supporto e limiti secondo modello; nessun valore predefinito uniforme garantito.

• nintegerFacoltativo

  Numero di generazioni. Supporto e limiti secondo modello; nessun valore predefinito uniforme garantito.

• streambooleanFacoltativo

  Risposta in streaming o meno

  Valore predefinito

  false

• stream_optionsobjectFacoltativo

  Opzioni di utilizzo nel flusso Chat; supporto e restituzione dei dati di utilizzo dipendono dal modello scelto.

  Campi figli di stream_options (1)

  • include_usagebooleanFacoltativo

• stopunionFacoltativo

  Sequenze di arresto

  Ramo oneOf 1

  Tipo: string
  Ramo oneOf 2

  Tipo: array

  • []stringFacoltativo

• max_tokensintegerFacoltativo

  Numero massimo di token generati. Supporto e limiti secondo modello; nessun valore predefinito uniforme garantito.

• max_completion_tokensintegerFacoltativo

  Numero massimo di token di completamento. Supporto e limiti secondo modello; nessun valore predefinito uniforme garantito.

• presence_penaltynumberFacoltativo

  Supporto e limiti dipendono dal modello scelto; non sono garantiti valori predefiniti uniformi.

• frequency_penaltynumberFacoltativo

  Supporto e limiti dipendono dal modello scelto; non sono garantiti valori predefiniti uniformi.

• logit_biasobjectFacoltativo
  Campi figli di logit_bias (1)

  • [key]numberFacoltativo

• userstringFacoltativo

• toolsarrayFacoltativo
  Campi figli di tools (1)

  • []objectFacoltativo
    Campi figli di [] (2)

    • typestringFacoltativo

    • functionobjectFacoltativo
      Campi figli di function (3)

      • namestringFacoltativo

      • descriptionstringFacoltativo

      • parametersobjectFacoltativo

        Parametri definiti in formato JSON Schema

• tool_choiceunionFacoltativo
  Ramo oneOf 1

  Tipo: string

  Enumerazione: ["none","auto","required"]
  Ramo oneOf 2

  Tipo: object

  • typestringFacoltativo

  • functionobjectFacoltativo
    Campi figli di function (1)

    • namestringFacoltativo

• response_formatobjectFacoltativo
  Campi figli di response_format (2)

  • typestringFacoltativo

    Enumerazione

    ["text","json_object","json_schema"]

  • json_schemaobjectFacoltativo

    Definizione JSON Schema

• seedintegerFacoltativo

  Supporto e limiti dipendono dal modello scelto; non sono garantiti valori predefiniti uniformi.

• reasoning_effortstringFacoltativo

  Intensità del ragionamento (modelli compatibili). Supporto e limiti secondo modello; nessun valore predefinito uniforme garantito.

• modalitiesarrayFacoltativo
  Campi figli di modalities (1)

  • []stringFacoltativo

    Enumerazione

    ["text","audio"]

• audioobjectFacoltativo
  Campi figli di audio (2)

  • voicestringFacoltativo

  • formatstringFacoltativo

• parallel_tool_callsbooleanFacoltativo

  Le chiamate parallele agli strumenti dipendono dal modello scelto. Chat accetta un booleano; Responses accetta valori JSON del protocollo compatibile.

• storebooleanFacoltativo

  La possibilità di salvare richieste e risposte dipende dal modello scelto e dalle funzionalità supportate dal servizio. Non offre un'API generale per archiviare conversazioni.

• prompt_cache_keystringFacoltativo

  Identificatore della cache dei prompt , secondo modello, senza garanzia di riscontro o supporto. Chat accetta stringhe; Responses valori JSON del protocollo del servizio.

• prompt_cache_retentionunknownFacoltativo

  Valore JSON per la conservazione della cache dei prompt , secondo modello. Nessuna enumerazione, valore predefinito o garanzia uniforme della piattaforma.

• service_tierunknownFacoltativo

  Livello di servizio richiesto, che può incidere sul costo. Ignorato per impostazione predefinita e applicato solo se supportato. I valori ammessi dipendono dal modello scelto.

HTTP 200

{
  "type": "string",
  "description": "SSE 事件流，协议事件/用量/结束符取当前接口，错误可能在流内。"
}

HTTP 400

HTTP 401

HTTP 403

HTTP 429

HTTP 500