Sdílet prostřednictvím

Služba agenta Azure AI Foundry (Preview)

Snadno integrovat funkce služby agenta Azure AI Foundry do vašich pracovních postupů.

Tento konektor je dostupný v následujících produktech a oblastech:

Service Class Regions
Copilot Studio Premium Všechny oblasti Power Automate s výjimkou následujících:
     – státní správa USA (GCC)
     – státní správa USA (GCC High)
     - China Cloud provozovaný společností 21Vianet
     - Ministerstvo obrany USA (DoD)
Logic Apps Standard Všechny oblasti Logic Apps s výjimkou následujících:
     – Oblasti Azure Government
     – Oblasti Azure China
     - Ministerstvo obrany USA (DoD)
Power Apps Premium Všechny oblasti Power Apps s výjimkou následujících:
     – státní správa USA (GCC)
     – státní správa USA (GCC High)
     - China Cloud provozovaný společností 21Vianet
     - Ministerstvo obrany USA (DoD)
Power Automate Premium Všechny oblasti Power Automate s výjimkou následujících:
     – státní správa USA (GCC)
     – státní správa USA (GCC High)
     - China Cloud provozovaný společností 21Vianet
     - Ministerstvo obrany USA (DoD)
Kontakt
Název Microsoft
URL https://support.microsoft.com
Metadata konektoru
Vydavatel Microsoft
Internetová stránka https://learn.microsoft.com/en-us/azure/ai-services/agents/
Zásady ochrany osobních údajů https://learn.microsoft.com/en-us/legal/cognitive-services/agents/data-privacy-security
Kategorie Umělá inteligence; Business Intelligence

Vytvoření připojení

Konektor podporuje následující typy ověřování:
Spravovaná identita Logic Apps Vytvoření připojení pomocí spravované identity LogicApps Pouze LOGICAPPS Sdíletelný
Přihlášení uživatele Microsoft Entra ID Přihlášení pomocí přihlašovacích údajů Microsoft Entra ID Všechny oblasti Nesdílitelné
Výchozí [ZASTARALÉ] Tato možnost je určená pouze pro starší připojení bez explicitního typu ověřování a poskytuje se pouze pro zpětnou kompatibilitu. Všechny oblasti Nesdílitelné

Spravovaná identita Logic Apps

ID ověřování: managedIdentityAuth

Použitelné: Pouze LOGICAPPS

Vytvoření připojení pomocí spravované identity LogicApps

Toto připojení je možné sdílet. Pokud se power app sdílí s jiným uživatelem, sdílí se i připojení. Další informace najdete v přehledu konektorů pro aplikace plátna – Power Apps | Microsoft Docs

Název Typ Description Povinné
Spravovaná identita LogicApps managedIdentity Přihlášení pomocí spravované identity Logic Apps Pravdivé
Koncový bod projektu Azure AI řetězec Název koncového bodu projektu Azure AI, například https://{název_účtu}.services.ai.azure.com/api/projects/{název_projektu} Pravdivé

Přihlášení uživatele Microsoft Entra ID

ID ověřování: entraIDUserLogin

Použitelné: Všechny oblasti

Přihlášení pomocí přihlašovacích údajů Microsoft Entra ID

Toto připojení není možné sdílet. Pokud se power app sdílí s jiným uživatelem, zobrazí se výzva k explicitní vytvoření nového připojení.

Název Typ Description Povinné
Koncový bod projektu Azure AI řetězec Název koncového bodu projektu Azure AI, například https://{název_účtu}.services.ai.azure.com/api/projects/{název_projektu} Pravdivé

Výchozí [ZASTARALÉ]

Použitelné: Všechny oblasti

Tato možnost je určená pouze pro starší připojení bez explicitního typu ověřování a poskytuje se pouze pro zpětnou kompatibilitu.

Toto připojení není možné sdílet. Pokud se power app sdílí s jiným uživatelem, zobrazí se výzva k explicitní vytvoření nového připojení.

Limity omezování

Name Volání Období obnovení
Volání rozhraní API na připojení 1000 60 sekund

Akce

Protokol aktivity externího agenta založený na aplikaci

Protokol aktivity externího agenta založený na aplikaci
Protokol aktivity externího agenta založený na identifikátoru agenta

Protokol aktivity externího agenta založený na identifikátoru agenta
Seznam agentů

Seznam agentů
Spustit

Spustit
Vytvořit běh

Vytvořit běh
Vytvořit vlákno

Vytvořit vlákno
Vyvolání agenta

Vyvolání agenta
Výpis zpráv

Výpis zpráv

Protokol aktivity externího agenta založený na aplikaci

ID operace:
SendActivityApplication

Protokol aktivity externího agenta založený na aplikaci

Parametry

Name Klíč Vyžadováno Typ Description
Aplikace agenta.
 MyApplication True string

Aplikace agenta.
object

Návraty

response
object

Protokol aktivity externího agenta založený na identifikátoru agenta

ID operace:
SendActivity

Protokol aktivity externího agenta založený na identifikátoru agenta

Parametry

Name Klíč Vyžadováno Typ Description
ID agenta pro odeslání zprávy.
 AgentId True string

ID agenta pro odeslání zprávy.
object

Návraty

response
object

Seznam agentů

ID operace:
ListAgents

Seznam agentů

Parametry

Name Klíč Vyžadováno Typ Description
Verze rozhraní API
 api-version True string

Verze rozhraní API

Návraty

Body
listAgentsResponse

Spustit

ID operace:
GetRun

Spustit

Parametry

Name Klíč Vyžadováno Typ Description
Verze rozhraní API
 api-version True string

Verze rozhraní API
ID vlákna pro vytvoření zprávy.
 ThreadId True string

ID vlákna pro vytvoření zprávy.
ID spuštění.
 RunId True string

ID spuštění.

Návraty

Body
getRunResponse

Vytvořit běh

ID operace:
CreateRun

Vytvořit běh

Parametry

Name Klíč Vyžadováno Typ Description
Verze rozhraní API
 api-version True string

Verze rozhraní API
ID vlákna pro vytvoření zprávy.
 ThreadId True string

ID vlákna pro vytvoření zprávy.
assistant_id
 assistant_id True string

ID pomocníka, který se má použít ke spuštění tohoto spuštění.
model
 model string

Název nasazení modelu, který se má použít ke spuštění tohoto spuštění. V případě potřeby přepíše název nasazení modelu asistenta.
instructions
 instructions string

Přepíše pokyny asistenta. Užitečné pro úpravu chování na základě jednotlivých spuštění.
additional_instructions
 additional_instructions string

Připojí další pokyny na konec pokynů pro spuštění.
role
 role string

Role entity, která vytváří zprávu. Může to být uživatel nebo asistent. Uživatel označuje, že zpráva je odeslána skutečným uživatelem a měla by být použita ve většině případů k reprezentaci uživatelem generovaných zpráv. "asistent" označuje, že je zpráva vygenerována asistentem. Tato hodnota slouží k vložení zpráv z asistenta do konverzace.
obsah
 content string

Obsah zprávy.
název
 name string

Seznam ID souborů nebo zpráv, které lze použít při spuštění.
metadata
 metadata object

Sada 16 párů klíč-hodnota, které lze připojit k objektu. To může být užitečné pro ukládání dalších informací o objektu ve strukturovaném formátu. Klíče můžou mít maximálně 64 znaků a hodnoty můžou mít maximálně 512 znaků.
název
 name string

Seznam nástrojů, které lze použít při spuštění
metadata
 metadata object

Sada 16 párů klíč-hodnota připojených k objektu. Maximální délka klíče: 64 znaků, maximální délka hodnot: 512 znaků.
Teplota
 temperature number

Vzorkovací teplota (0-2). Vyšší hodnoty (např. 0,8) zvyšují náhodnost, nižší hodnoty (např. 0,2), aby byl výstup deterministický.
top_p
 top_p number

Alternativou vzorkování vzorků k teplotě. 0,1 znamená, že se považuje 10% pravděpodobnostní hmotnost.
datový proud
 stream boolean

Pokud je hodnota true, vrátí stream událostí během spuštění jako události odesílané serverem a ukončuje se zprávou "data: [DONE]".
max_prompt_tokens
 max_prompt_tokens integer

Maximální počet tokenů dokončení, které se můžou použít při spuštění. Pokud dojde k překročení, spuštění skončí jako neúplné.
max_completion_tokens
 max_completion_tokens integer

Maximální počet tokenů dokončení, které se můžou použít při spuštění. Pokud dojde k překročení, spuštění skončí jako neúplné.
truncation_strategy
 truncation_strategy object

Určuje, jak je vlákno zkráceno před spuštěním pro správu počátečního kontextového okna.
tool_choice
 tool_choice object

Určuje, který nástroj model volá. Ve výchozím nastavení se model automaticky rozhodne. Pokud chcete zakázat používání nástrojů, můžete ho nastavit na žádné.
formát_odpovědi
 response_format object

Určuje výstupní formát. Nastavení { 'type': 'json_object' } povoluje režim JSON pro platné odpovědi JSON.

Návraty

Body
createRunResponse

Vytvořit vlákno

ID operace:
CreateThread

Vytvořit vlákno

Parametry

Name Klíč Vyžadováno Typ Description
Verze rozhraní API
 api-version True string

Verze rozhraní API
role
 role string

Role entity, která vytváří zprávu. Může to být uživatel nebo asistent. Uživatel označuje, že zpráva je odeslána skutečným uživatelem a měla by být použita ve většině případů k reprezentaci uživatelem generovaných zpráv. "asistent" označuje, že je zpráva vygenerována asistentem. Tato hodnota slouží k vložení zpráv z asistenta do konverzace.
obsah
 content string

Obsah zprávy.
název
 name string

Seznam ID souborů nebo zpráv, které lze použít při spuštění.
metadata
 metadata object

Sada 16 párů klíč-hodnota, které lze připojit k objektu. To může být užitečné pro ukládání dalších informací o objektu ve strukturovaném formátu. Klíče můžou mít maximálně 64 znaků a hodnoty můžou mít maximálně 512 znaků.
metadata
 metadata object

Sada 16 párů klíč-hodnota, které lze připojit k objektu. To může být užitečné pro ukládání dalších informací o objektu ve strukturovaném formátu. Klíče můžou mít maximálně 64 znaků a hodnoty můžou mít maximálně 512 znaků.
tool_resources
 tool_resources object

Sada prostředků, které jsou zpřístupněny nástrojům asistenta v tomto vlákně. Prostředky jsou specifické pro typ nástroje. Nástroj code_interpreter například vyžaduje seznam ID souborů, zatímco nástroj file_search vyžaduje seznam ID vektorového úložiště.

Návraty

Body
createThreadResponse

Vyvolání agenta

ID operace:
InvokeAgent

Vyvolání agenta

Parametry

Name Klíč Vyžadováno Typ Description
Verze rozhraní API
 api-version True string

Verze rozhraní API
metadata
 metadata object

Sada 16 párů klíč-hodnota, které lze připojit k objektu. To může být užitečné pro ukládání dalších informací o objektu ve strukturovaném formátu a dotazování na objekty prostřednictvím rozhraní API nebo řídicího panelu.

Klíče jsou řetězce s maximální délkou 64 znaků. Hodnoty jsou řetězce s maximální délkou 512 znaků.
uživatel
 user string

Jedinečný identifikátor představující koncového uživatele, který může pomoct OpenAI monitorovat a zjišťovat zneužití. Další informace.
top_logprobs
 top_logprobs integer

Celé číslo v rozmezí od 0 do 20 určující počet nejpravděpodobnějších tokenů, které se mají vrátit na každé pozici tokenu, každý s přidruženou pravděpodobností protokolu.
previous_response_id
 previous_response_id string

Jedinečné ID předchozí odpovědi na model. Pomocí této možnosti můžete vytvářet konverzace s více interakcemi. Přečtěte si další informace o stavu konverzace.
na pozadí
 background boolean

Určuje, jestli chcete spustit odpověď modelu na pozadí. Další informace.
max_output_tokens
 max_output_tokens integer

Horní mez počtu tokenů, které lze vygenerovat pro odpověď, včetně viditelných výstupních tokenů a zdůvodnění tokenů.
max_tool_calls
 max_tool_calls integer

Maximální počet volání integrovaných nástrojů, které je možné zpracovat v odpovědi. Toto maximální číslo platí pro všechna integrovaná volání nástrojů, ne pro jednotlivé nástroje. Všechny další pokusy o volání nástroje modelem budou ignorovány.
typ
 type True string

Objekt určující formát, který musí model vypíše.

Konfigurace { "type": "json_schema" } umožňuje strukturované výstupy, které zajistí, že model bude odpovídat zadanému schématu JSON. Další informace najdete v průvodci strukturovanými výstupy.

Výchozí formát je { "type": "text" } bez dalších možností.

Nedoporučuje se pro gpt-4o a novější modely:

Nastavení { "type": "json_object" } umožní původní režim JSON, což zajišťuje, že zpráva vygenerovaná modelem je platný JSON. Použití json_schema je upřednostňované pro modely, které ho podporují.
typ
 type True string

Nástroj, který lze použít k vygenerování odpovědi.
tool_choice
 tool_choice

Způsob, jakým má model vybrat nástroj (nebo nástroje), který se má použít při generování odpovědi V parametru tools se dozvíte, jak určit nástroje, které model může volat.
identifikační číslo
 id True string

Jedinečný identifikátor šablony výzvy, která se má použít.
verze
 version string

Volitelná verze šablony výzvy
variables
 variables object

Volitelné mapování hodnot, které se mají nahradit proměnnými ve výzvě Hodnoty nahrazení můžou být řetězce nebo jiné typy vstupu odpovědi, jako jsou obrázky nebo soubory.
truncation
 truncation string

Strategie zkrácení, která se má použít pro odpověď modelu.

  • auto: Pokud kontext této odpovědi a předchozích odpovědí překročí velikost kontextového okna modelu, model zkrátí odpověď tak, aby se vešel do kontextového okna tak, že vyřazuje vstupní položky uprostřed konverzace.
  • disabled (výchozí): Pokud odpověď modelu překročí velikost kontextového okna modelu, požadavek selže s chybou 400.
vstup
 input

Textové, obrázkové nebo souborové vstupy do modelu, které se používají k vygenerování odpovědi.

Další informace:
include
 include string

Zadejte další výstupní data, která se mají zahrnout do odpovědi modelu. Aktuálně podporované hodnoty jsou:

  • code_interpreter_call.outputs: Zahrnuje výstupy spuštění kódu Pythonu v nástroji pro interpret kódu volání položek.
  • computer_call_output.output.image_url: Zahrňte adresy URL obrázků z výsledku počítačového volání.
  • file_search_call.results: Zahrňte výsledky vyhledávání nástroje pro hledání souborů.
  • message.input_image.image_url: Zahrňte adresy URL obrázků ze vstupní zprávy.
  • message.output_text.logprobs: Zahrňte protokoly se zprávami pomocníka.
  • reasoning.encrypted_content: Zahrnuje zašifrovanou verzi tokenů odůvodnění ve výstupech zdůvodnění položek. To umožňuje, aby byly položky pro uvažování použity v konverzacích na více otočení při použití stateless Responses API (například když je parametr nastaven na store, nebo když je organizace zaregistrována v programu nulového uchovávání dat).
paralelní volání nástrojů
 parallel_tool_calls boolean

Jestli chcete modelu povolit paralelní spouštění volání nástrojů.
uložit
 store boolean

Zda se má vygenerovaná odpověď modelu uložit pro pozdější načtení prostřednictvím rozhraní API.
instructions
 instructions string

Zpráva systému (nebo vývojáře) vložená do kontextu modelu.

Při použití společně previous_response_idse pokyny z předchozí odpovědi nepřenesou do další odpovědi. Díky tomu je snadné prohodit systémové zprávy (nebo zprávy vývojářů) v nových odpovědích.
typ
 type True string
název
 name True string

Název agenta.
verze
 version True string

Identifikátor verze agenta.

Návraty

Body
OpenAI.Response

Výpis zpráv

ID operace:
ListMessages

Výpis zpráv

Parametry

Name Klíč Vyžadováno Typ Description
Verze rozhraní API
 api-version True string

Verze rozhraní API
ID vlákna pro vytvoření zprávy.
 ThreadId True string

ID vlákna pro vytvoření zprávy.

Návraty

Body
listMessageResponse

Definice

listAgentsResponse

Name Cesta Typ Description
objekt
 object string

Podrobnosti o typu objektu odpovědi
data
 data array of Data

Seznam zpráv vrácených službou
first_id
 first_id string

Podrobnosti o prvním ID
last_id
 last_id string

Podrobnosti o posledním ID
má více
 has_more boolean

Určuje, jestli tam jsou další agenti.

createThreadResponse

Name Cesta Typ Description
identifikační číslo
 id string

Identifikátor, na který se dá odkazovat v koncových bodech rozhraní API.
objekt
 object string

Typ objektu, který je vždy vlákno.
datum_vytvoření
 created_at integer

Časové razítko unixu (v sekundách) pro vytvoření vlákna.
metadata
 metadata object

Sada 16 párů klíč-hodnota, které lze připojit k objektu. To může být užitečné pro ukládání dalších informací o objektu ve strukturovaném formátu. Klíče můžou mít maximálně 64 znaků a hodnoty můžou mít maximálně 512 znaků.

createRunResponse

Name Cesta Typ Description
identifikační číslo
 id string

Identifikátor, na který se dá odkazovat v koncových bodech rozhraní API.
objekt
 object string

Typ objektu, který je vždy thread.run.
datum_vytvoření
 created_at integer

Časové razítko unixu (v sekundách) pro vytvoření spuštění.
thread_id
 thread_id string

ID vlákna, na které bylo spuštěno jako součást tohoto spuštění.
assistant_id
 assistant_id string

ID asistenta použitého ke spuštění tohoto spuštění.
stav
 status string

Stav spuštění, který může být zařazen do fronty, in_progress, requires_action, zrušení, zrušení, selhání, dokončení nebo vypršení platnosti.
required_action
 required_action object

Podrobnosti o akci potřebné k pokračování ve spuštění Pokud není vyžadována žádná akce, bude mít hodnotu null.
poslední chyba
 last_error object

Poslední chyba přidružená k tomuto spuštění. Pokud nedojde k žádným chybám, bude mít hodnotu null.
datum vypršení
 expires_at integer

Časové razítko unixu (v sekundách) pro vypršení platnosti spuštění.
started_at
 started_at integer

Časové razítko unixu (v sekundách) pro spuštění spuštění.
zrušeno_v
 cancelled_at integer

Časové razítko unixu (v sekundách) po zrušení spuštění.
selháno_při
 failed_at integer

Časové razítko unixu (v sekundách) pro dobu, kdy se spuštění nezdařilo.
dokončeno v
 completed_at integer

Časové razítko unixu (v sekundách) pro dokončení spuštění.
model
 model string

Název nasazení modelu, který pomocník použil pro toto spuštění.
instructions
 instructions string

Pokyny, které pomocník použil pro toto spuštění.
nářadí
 tools array of tools

Seznam nástrojů, které pomocník použil pro toto spuštění.
identifikátory_souborů
 file_ids array of fileIds

Seznam IDsouborůch
metadata
 metadata object

Sada 16 párů klíč-hodnota, které lze připojit k objektu. Klíče můžou mít maximálně 64 znaků a hodnoty můžou mít maximálně 512 znaků.
tool_choice
 tool_choice object

Určuje, který (pokud existuje) nástroj, který model volá. "none" znamená, že model nebude volat žádné nástroje a místo toho vygeneruje zprávu. "automatickým" rozumí model, který si může vybrat mezi generováním zprávy nebo voláním nástroje. Určení nástroje jako {'type': 'file_search'} nebo {'type': 'function', 'function': {'name': 'my_function'}} vynutí, aby model volal.
max_prompt_tokens
 max_prompt_tokens number

Maximální počet výzev tokenů zadaných k použití v průběhu spuštění.
max_completion_tokens
 max_completion_tokens number

Maximální počet tokenů dokončení určených k použití v průběhu spuštění.
využití
 usage object

Statistiky využití související se spuštěním Tato hodnota bude null, pokud spuštění není ve stavu terminálu (např. in_progress, ve frontě).
truncation_strategy
 truncation_strategy object

Určuje, jak se vlákno před spuštěním zkrátí.
formát_odpovědi
 response_format string

Formát, který musí model vypíše. Kompatibilní s GPT-4 Turbo a všemi modely GPT-3.5 Turbo od gpt-3.5-turbo-1106.

getRunResponse

Name Cesta Typ Description
identifikační číslo
 id string

Identifikátor, na který se dá odkazovat v koncových bodech rozhraní API.
objekt
 object string

Typ objektu, který je vždy thread.run.
datum_vytvoření
 created_at integer

Časové razítko unixu (v sekundách) pro vytvoření spuštění.
thread_id
 thread_id string

ID vlákna, na které bylo spuštěno jako součást tohoto spuštění.
assistant_id
 assistant_id string

ID asistenta použitého ke spuštění tohoto spuštění.
stav
 status string

Stav spuštění, který může být zařazen do fronty, in_progress, requires_action, zrušení, zrušení, selhání, dokončení nebo vypršení platnosti.
required_action
 required_action object

Podrobnosti o akci potřebné k pokračování ve spuštění Pokud není vyžadována žádná akce, bude mít hodnotu null.
poslední chyba
 last_error object

Poslední chyba přidružená k tomuto spuštění. Pokud nedojde k žádným chybám, bude mít hodnotu null.
datum vypršení
 expires_at integer

Časové razítko unixu (v sekundách) pro vypršení platnosti spuštění.
started_at
 started_at integer

Časové razítko unixu (v sekundách) pro spuštění spuštění.
zrušeno_v
 cancelled_at integer

Časové razítko unixu (v sekundách) po zrušení spuštění.
selháno_při
 failed_at integer

Časové razítko unixu (v sekundách) pro dobu, kdy se spuštění nezdařilo.
dokončeno v
 completed_at integer

Časové razítko unixu (v sekundách) pro dokončení spuštění.
model
 model string

Název nasazení modelu, který pomocník použil pro toto spuštění.
instructions
 instructions string

Pokyny, které pomocník použil pro toto spuštění.
nářadí
 tools array of tools

Seznam nástrojů, které pomocník použil pro toto spuštění.
identifikátory_souborů
 file_ids array of fileIds

Seznam IDsouborůch
metadata
 metadata object

Sada 16 párů klíč-hodnota, které lze připojit k objektu. Klíče můžou mít maximálně 64 znaků a hodnoty můžou mít maximálně 512 znaků.
tool_choice
 tool_choice object

Určuje, který (pokud existuje) nástroj, který model volá. "none" znamená, že model nebude volat žádné nástroje a místo toho vygeneruje zprávu. "automatickým" rozumí model, který si může vybrat mezi generováním zprávy nebo voláním nástroje. Určení nástroje jako {'type': 'file_search'} nebo {'type': 'function', 'function': {'name': 'my_function'}} vynutí, aby model volal.
max_prompt_tokens
 max_prompt_tokens number

Maximální počet výzev tokenů zadaných k použití v průběhu spuštění.
max_completion_tokens
 max_completion_tokens number

Maximální počet tokenů dokončení určených k použití v průběhu spuštění.
využití
 usage object

Statistiky využití související se spuštěním Tato hodnota bude null, pokud spuštění není ve stavu terminálu (např. in_progress, ve frontě).
truncation_strategy
 truncation_strategy object

Určuje, jak se vlákno před spuštěním zkrátí.
formát_odpovědi
 response_format string

Formát, který musí model vypíše. Kompatibilní s GPT-4 Turbo a všemi modely GPT-3.5 Turbo od gpt-3.5-turbo-1106.

listMessageResponse

Name Cesta Typ Description
objekt
 object string

Podrobnosti o typu objektu odpovědi
data
 data array of Data

Seznam zpráv vrácených službou
first_id
 first_id string

Podrobnosti o prvním ID
last_id
 last_id string

Podrobnosti o posledním ID
má více
 has_more boolean

Udává, jestli je k dispozici více agentů.

Data

Name Cesta Typ Description
identifikační číslo
 id string

Identifikátor, na který se dá odkazovat v koncových bodech rozhraní API.
objekt
 object string

Typ objektu, který je vždy pomocníkem.
datum_vytvoření
 created_at integer

Časové razítko unixu (v sekundách) pro vytvoření asistenta.
název
 name string

Jméno asistenta. Maximální délka je 256 znaků.
popis
 description string

Popis asistenta. Maximální délka je 512 znaků.
model
 model string

Název názvu nasazení modelu, který se má použít.
instructions
 instructions string

Systémové pokyny, které asistent používá. Maximální délka je 32768 znaků.
nářadí
 tools array of tools

Seznam nástrojů povolených v asistentovi. Na asistenta může být maximálně 128 nástrojů. Nástroje můžou být typu code_interpreter nebo funkce. Popis funkce může být maximálně 1 024 znaků.
metadata
 metadata object

Sada 16 párů klíč-hodnota, které lze připojit k objektu. Užitečné pro ukládání dalších informací ve strukturovaném formátu. Klíče můžou mít maximálně 64 znaků a hodnoty můžou mít maximálně 512 znaků.
Teplota
 temperature number

Výchozí hodnota je 1. Určuje, jakou teplotu vzorkování se má použít, mezi 0 a 2. Vyšší hodnoty jako 0,8 způsobí, že výstup bude náhodnější, zatímco nižší hodnoty, jako je 0,2, zajistí větší zaměření a deterministiku.
top_p
 top_p number

Výchozí hodnota je 1. Alternativou k odběru vzorků s teplotou, označovanou jako vzorkování jádra, kde model bere v úvahu výsledky tokenů s top_p hmotností pravděpodobnosti. Hodnota 0,1 tedy znamená, že se považují pouze tokeny, které tvoří 10% hmotnost pravděpodobnosti.
formát_odpovědi
 response_format object

Určuje formát, který musí model vypíše. Nastavením tohoto parametru na { 'type': 'json_object' } povolí režim JSON, čímž se zajistí, že zpráva bude platná ve formátu JSON.
tool_resources
 tool_resources object

Sada prostředků, které používají nástroje asistenta. Prostředky jsou specifické pro typ nástroje. Nástroj code_interpreter například vyžaduje seznam ID souborů, zatímco nástroj file_search vyžaduje seznam ID vektorového úložiště.

OpenAI.ServiceTier

Určuje typ zpracování použitý pro obsluhu požadavku.

  • Pokud je nastavená hodnota auto, požadavek se zpracuje s úrovní služby nakonfigurovanou v nastavení projektu. Pokud není nakonfigurovaný jinak, project použije výchozí hodnotu.
  • Pokud je nastavená na výchozí, požadavek se zpracuje se standardními cenami a výkonem vybraného modelu.
  • Pokud je nastavená hodnota "flex" nebo "priority", požadavek se zpracuje s odpovídající úrovní služby. Kontaktujte sales a získejte další informace o zpracování priority.
  • Pokud není nastavené, výchozí chování je "auto".

Při nastavení parametru service_tier bude text odpovědi obsahovat service_tier hodnotu založenou na režimu zpracování, který se skutečně používá k obsluhování požadavku. Tato hodnota odpovědi se může lišit od hodnoty nastavené v parametru.

Určuje typ zpracování použitý pro obsluhu požadavku.

  • Pokud je nastavená hodnota auto, požadavek se zpracuje s úrovní služby nakonfigurovanou v nastavení projektu. Pokud není nakonfigurovaný jinak, project použije výchozí hodnotu.
  • Pokud je nastavená na výchozí, požadavek se zpracuje se standardními cenami a výkonem vybraného modelu.
  • Pokud je nastavená hodnota "flex" nebo "priority", požadavek se zpracuje s odpovídající úrovní služby. Kontaktujte sales a získejte další informace o zpracování priority.
  • Pokud není nastavené, výchozí chování je "auto".

Při nastavení parametru service_tier bude text odpovědi obsahovat service_tier hodnotu založenou na režimu zpracování, který se skutečně používá k obsluhování požadavku. Tato hodnota odpovědi se může lišit od hodnoty nastavené v parametru.

string

OpenAI.Reasoning

Modely řady o-series pouze

Možnosti konfigurace pro zdůvodnění modelů

Name Cesta Typ Description
úsilí
 effort string
souhrn
 summary string

Souhrn důvodů provedených modelem To může být užitečné pro ladění a pochopení procesu odůvodnění modelu. Jeden z auto, concisenebo detailed.
generate_summary
 generate_summary string

Zastaralé: použijte summary místo toho.

Souhrn důvodů provedených modelem To může být užitečné pro ladění a pochopení procesu odůvodnění modelu. Jeden z auto, concisenebo detailed.

OpenAI.ResponseTextFormatConfiguration

Name Cesta Typ Description
typ
 type OpenAI.ResponseTextFormatConfigurationType

Objekt určující formát, který musí model vypíše.

Konfigurace { "type": "json_schema" } umožňuje strukturované výstupy, které zajistí, že model bude odpovídat zadanému schématu JSON. Další informace najdete v průvodci strukturovanými výstupy.

Výchozí formát je { "type": "text" } bez dalších možností.

Nedoporučuje se pro gpt-4o a novější modely:

Nastavení { "type": "json_object" } umožní původní režim JSON, což zajišťuje, že zpráva vygenerovaná modelem je platný JSON. Použití json_schema je upřednostňované pro modely, které ho podporují.

OpenAI.ResponseTextFormatKonfiguraceTyp

Objekt určující formát, který musí model vypíše.

Konfigurace { "type": "json_schema" } umožňuje strukturované výstupy, které zajistí, že model bude odpovídat zadanému schématu JSON. Další informace najdete v průvodci strukturovanými výstupy.

Výchozí formát je { "type": "text" } bez dalších možností.

Nedoporučuje se pro gpt-4o a novější modely:

Nastavení { "type": "json_object" } umožní původní režim JSON, což zajišťuje, že zpráva vygenerovaná modelem je platný JSON. Použití json_schema je upřednostňované pro modely, které ho podporují.

Objekt určující formát, který musí model vypíše.

Konfigurace { "type": "json_schema" } umožňuje strukturované výstupy, které zajistí, že model bude odpovídat zadanému schématu JSON. Další informace najdete v průvodci strukturovanými výstupy.

Výchozí formát je { "type": "text" } bez dalších možností.

Nedoporučuje se pro gpt-4o a novější modely:

Nastavení { "type": "json_object" } umožní původní režim JSON, což zajišťuje, že zpráva vygenerovaná modelem je platný JSON. Použití json_schema je upřednostňované pro modely, které ho podporují.

string

OpenAI.Tool

Name Cesta Typ Description
typ
 type OpenAI.ToolType

Nástroj, který lze použít k vygenerování odpovědi.

OpenAI.ToolType

Nástroj, který lze použít k vygenerování odpovědi.

Nástroj, který lze použít k vygenerování odpovědi.

string

OpenAI.Prompt

Odkaz na šablonu výzvy a její proměnné Další informace.

Name Cesta Typ Description
identifikační číslo
 id string

Jedinečný identifikátor šablony výzvy, která se má použít.
verze
 version string

Volitelná verze šablony výzvy
variables
 variables OpenAI.ResponsePromptVariables

Volitelné mapování hodnot, které se mají nahradit proměnnými ve výzvě Hodnoty nahrazení můžou být řetězce nebo jiné typy vstupu odpovědi, jako jsou obrázky nebo soubory.

OpenAI.Response

Name Cesta Typ Description
metadata
 metadata object

Sada 16 párů klíč-hodnota, které lze připojit k objektu. To může být užitečné pro ukládání dalších informací o objektu ve strukturovaném formátu a dotazování na objekty prostřednictvím rozhraní API nebo řídicího panelu.

Klíče jsou řetězce s maximální délkou 64 znaků. Hodnoty jsou řetězce s maximální délkou 512 znaků.
Teplota
 temperature float

Jakou teplotu vzorkování použít, mezi 0 a 2. Vyšší hodnoty jako 0,8 způsobí, že výstup bude náhodnější, zatímco nižší hodnoty, jako je 0,2, zajistí větší zaměření a deterministiku. Obecně doporučujeme tuto změnu změnit, top_p ale ne obojí.
top_p
 top_p float

Alternativou k odběru vzorků s teplotou, označovanou jako vzorkování jádra, kde model bere v úvahu výsledky tokenů s top_p hmotností pravděpodobnosti. Hodnota 0,1 tedy znamená, že se považují pouze tokeny, které tvoří 10% hmotnost pravděpodobnosti.

Obecně doporučujeme tuto změnu změnit, temperature ale ne obojí.
uživatel
 user string

Jedinečný identifikátor představující koncového uživatele, který může pomoct OpenAI monitorovat a zjišťovat zneužití. Další informace.
úroveň služby
 service_tier OpenAI.ServiceTier

Určuje typ zpracování použitý pro obsluhu požadavku.

  • Pokud je nastavená hodnota auto, požadavek se zpracuje s úrovní služby nakonfigurovanou v nastavení projektu. Pokud není nakonfigurovaný jinak, project použije výchozí hodnotu.
  • Pokud je nastavená na výchozí, požadavek se zpracuje se standardními cenami a výkonem vybraného modelu.
  • Pokud je nastavená hodnota "flex" nebo "priority", požadavek se zpracuje s odpovídající úrovní služby. Kontaktujte sales a získejte další informace o zpracování priority.
  • Pokud není nastavené, výchozí chování je "auto".

Při nastavení parametru service_tier bude text odpovědi obsahovat service_tier hodnotu založenou na režimu zpracování, který se skutečně používá k obsluhování požadavku. Tato hodnota odpovědi se může lišit od hodnoty nastavené v parametru.
top_logprobs
 top_logprobs integer

Celé číslo v rozmezí od 0 do 20 určující počet nejpravděpodobnějších tokenů, které se mají vrátit na každé pozici tokenu, každý s přidruženou pravděpodobností protokolu.
previous_response_id
 previous_response_id string

Jedinečné ID předchozí odpovědi na model. Pomocí této možnosti můžete vytvářet konverzace s více interakcemi. Přečtěte si další informace o stavu konverzace.
model
 model string

Nasazení modelu, které se použije k vytvoření této odpovědi.
reasoning
 reasoning OpenAI.Reasoning

Modely řady o-series pouze

Možnosti konfigurace pro zdůvodnění modelů
na pozadí
 background boolean

Určuje, jestli chcete spustit odpověď modelu na pozadí. Další informace.
max_output_tokens
 max_output_tokens integer

Horní mez počtu tokenů, které lze vygenerovat pro odpověď, včetně viditelných výstupních tokenů a zdůvodnění tokenů.
max_tool_calls
 max_tool_calls integer

Maximální počet volání integrovaných nástrojů, které je možné zpracovat v odpovědi. Toto maximální číslo platí pro všechna integrovaná volání nástrojů, ne pro jednotlivé nástroje. Všechny další pokusy o volání nástroje modelem budou ignorovány.
format
 text.format OpenAI.ResponseTextFormatConfiguration
nářadí
 tools array of OpenAI.Tool

Pole nástrojů, které může model volat při generování odpovědi. Pomocí nastavení parametru tool_choice můžete určit, který nástroj chcete použít.

Existují dvě kategorie nástrojů, které můžete poskytnout modelu:
tool_choice
 tool_choice

Způsob, jakým má model vybrat nástroj (nebo nástroje), který se má použít při generování odpovědi V parametru tools se dozvíte, jak určit nástroje, které model může volat.
požádat
 prompt OpenAI.Prompt

Odkaz na šablonu výzvy a její proměnné Další informace.
truncation
 truncation string

Strategie zkrácení, která se má použít pro odpověď modelu.

  • auto: Pokud kontext této odpovědi a předchozích odpovědí překročí velikost kontextového okna modelu, model zkrátí odpověď tak, aby se vešel do kontextového okna tak, že vyřazuje vstupní položky uprostřed konverzace.
  • disabled (výchozí): Pokud odpověď modelu překročí velikost kontextového okna modelu, požadavek selže s chybou 400.
identifikační číslo
 id string

Jedinečný identifikátor pro tuto odpověď.
objekt
 object string

Typ objektu tohoto prostředku – vždy nastaven na response.
stav
 status string

Stav generování odpovědi. Jeden z completed, , failedin_progress, cancelled, , queuednebo incomplete.
datum_vytvoření
 created_at unixtime

Časové razítko unixu (v sekundách) doby vytvoření této odpovědi
chyba
 error OpenAI.ResponseError

Objekt chyby vrácený v případě, že se modelu nepodaří vygenerovat odpověď.
důvod
 incomplete_details.reason string

Důvod, proč je odpověď neúplná.
výstup
 output array of OpenAI.ItemResource

Pole položek obsahu vygenerovaných modelem

  • Délka a pořadí položek v output poli závisí na odpovědi modelu.
  • Místo přístupu k první položce v poli a za předpokladu output , že se jedná o assistant zprávu s obsahem vygenerovaným modelem, můžete zvážit použití output_text vlastnosti, ve které jsou podporovány v sadách SDK.
instructions
 instructions

Zpráva systému (nebo vývojáře) vložená do kontextu modelu.

Při použití společně previous_response_idse pokyny z předchozí odpovědi nepřenesou do další odpovědi. Díky tomu je snadné prohodit systémové zprávy (nebo zprávy vývojářů) v nových odpovědích.
output_text
 output_text string

Vlastnost určená pouze pro SDK, která obsahuje souhrnný textový výstup ze všech položek output_text v poli output, pokud jsou přítomny. Podporováno v SDK pro Python a JavaScript.
využití
 usage OpenAI.ResponseUsage

Představuje podrobnosti o využití tokenů, včetně vstupních tokenů, výstupních tokenů, rozpisu výstupních tokenů a celkových použitých tokenů.
paralelní volání nástrojů
 parallel_tool_calls boolean

Jestli chcete modelu povolit paralelní spouštění volání nástrojů.
identifikační číslo
 conversation.id string
agent
 agent AgentId

OpenAI.ResponseError

Objekt chyby vrácený v případě, že se modelu nepodaří vygenerovat odpověď.

Name Cesta Typ Description
kód
 code OpenAI.ResponseErrorCode

Kód chyby pro odpověď.
zpráva
 message string

Popis chyby čitelný člověkem.

OpenAI.ResponseErrorCode

Kód chyby pro odpověď.

Kód chyby pro odpověď.

string

OpenAI.ItemResource

Položka obsahu použitá k vygenerování odpovědi

Name Cesta Typ Description
typ
 type OpenAI.ItemType
identifikační číslo
 id string

OpenAI.ItemType

string

OpenAI.ResponseUsage

Představuje podrobnosti o využití tokenů, včetně vstupních tokenů, výstupních tokenů, rozpisu výstupních tokenů a celkových použitých tokenů.

Name Cesta Typ Description
input_tokens
 input_tokens integer

Počet vstupních tokenů.
cached_tokens
 input_tokens_details.cached_tokens integer

Počet tokenů, které byly načteny z mezipaměti. Další informace o ukládání do mezipaměti výzvy
output_tokens
 output_tokens integer

Počet výstupních tokenů
důvodové_tokeny
 output_tokens_details.reasoning_tokens integer

Počet tokenů pro logické uvažování.
total_tokens
 total_tokens integer

Celkový počet použitých tokenů

AgentId

Name Cesta Typ Description
typ
 type string
název
 name string

Název agenta.
verze
 version string

Identifikátor verze agenta.

OpenAI.ResponsePromptVariables

Volitelné mapování hodnot, které se mají nahradit proměnnými ve výzvě Hodnoty nahrazení můžou být řetězce nebo jiné typy vstupu odpovědi, jako jsou obrázky nebo soubory.

Name Cesta Typ Description
object

Volitelné mapování hodnot, které se mají nahradit proměnnými ve výzvě Hodnoty nahrazení můžou být řetězce nebo jiné typy vstupu odpovědi, jako jsou obrázky nebo soubory.

nářadí

Name Cesta Typ Description
název
 name string

Seznam nástrojů, které lze použít při spuštění

fileIds

Name Cesta Typ Description
název
 name string

Seznam ID souborů, které lze použít při spuštění

objekt

Toto je typ "object".