Dokumentacja interfejsu API REST usługi Azure OpenAI w usłudze Microsoft Foundry Models

Ten artykuł zawiera szczegółowe informacje na temat punktów końcowych interfejsu API REST wnioskowania dla usługi Azure OpenAI.

Specyfikacje interfejsu API

Zarządzanie modelami i zasobami platformy Azure OpenAI i zarządzanie nimi jest podzielone na trzy podstawowe powierzchnie interfejsu API:

• Płaszczyzna sterowania
• Płaszczyzna danych — tworzenie
• Płaszczyzna danych — wnioskowanie

Każda powierzchnia/specyfikacja interfejsu API hermetyzuje inny zestaw funkcji usługi Azure OpenAI. Każdy interfejs API ma swój własny unikatowy zestaw wersji zapoznawczych i stabilne/ogólnie dostępne wersje interfejsu API. Obecnie wersje zapoznawcza mają tendencję do śledzenia miesięcznego tempa.

Ważne

Istnieje teraz nowy interfejs API wnioskowania w wersji zapoznawczej. Dowiedz się więcej w naszym przewodniku cyklu życia interfejsu API.

API	Najnowsza wersja zapoznawcza	Najnowsza wersja ogólnie dostępna	Specyfikacje	Opis
Płaszczyzna sterowania	2025-07-01-preview	2025-06-01	Pliki specyfikacji	Interfejs API płaszczyzny sterowania służy do wykonywania operacji, takich jak tworzenie zasobów, wdrażanie modelu i inne zadania zarządzania zasobami wyższego poziomu. Płaszczyzna sterowania zarządza również możliwościami, takimi jak azure Resource Manager, Bicep, Terraform i interfejs wiersza polecenia platformy Azure.
Płaszczyzna danych	v1 preview	v1	Pliki specyfikacji	Interfejs API płaszczyzny danych kontroluje operacje wnioskowania i tworzenia.

Uwierzytelniania

Usługa Azure OpenAI udostępnia dwie metody uwierzytelniania. Możesz użyć kluczy interfejsu API lub identyfikatora entra firmy Microsoft.

• Uwierzytelnianie klucza interfejsu API: w przypadku tego typu uwierzytelniania wszystkie żądania interfejsu API muszą zawierać klucz interfejsu API w nagłówku api-key HTTP. Przewodnik Szybki start zawiera wskazówki dotyczące wykonywania wywołań przy użyciu tego typu uwierzytelniania.

• Uwierzytelnianie identyfikatora Entra firmy Microsoft: możesz uwierzytelnić wywołanie interfejsu API przy użyciu tokenu Entra firmy Microsoft. Tokeny uwierzytelniania są dołączane do żądania jako nagłówka Authorization . Podany token musi być poprzedzony elementem Bearer, na przykład Bearer YOUR_AUTH_TOKEN. Możesz przeczytać nasz przewodnik z instrukcjami dotyczącymi uwierzytelniania za pomocą identyfikatora Entra firmy Microsoft.

Przechowywanie wersji interfejsu API REST

Interfejsy API usługi są wersjonowane przy użyciu parametru api-version zapytania. Wszystkie wersje są zgodne ze strukturą dat RRRR-MM-DD. Na przykład:

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

Wnioskowanie płaszczyzny danych

W pozostałej części artykułu omówiono 2025-04-01-preview wersję zapoznawczą specyfikacji wnioskowania płaszczyzny danych usługi Azure OpenAI.

Jeśli szukasz dokumentacji najnowszej wersji interfejsu API ga, zapoznaj się z najnowszym interfejsem API wnioskowania płaszczyzny danych ogólnie dostępnego

Uzupełnianie — tworzenie

POST https://{endpoint}/openai/deployments/{deployment-id}/completions?api-version=2025-04-01-preview

Tworzy uzupełnianie dla podanego monitu, parametrów i wybranego modelu.

Parametry identyfikatora URI

Nazwa	Cala	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	adres URL ciągu	Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, na przykład: https://aoairesource.openai.azure.com. Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI. https://{nazwa_zasobu}.openai.azure.com
identyfikator wdrożenia	ścieżka	Tak	ciąg
wersja interfejsu API	kwerenda	Tak	ciąg

Nagłówek żądania

Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.

Nazwa	Wymagane	Typ	Opis
Autoryzacji	True	ciąg	Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize Zakres: https://ai.azure.com/.default
api-key	True	ciąg	Tutaj podaj klucz interfejsu API usługi Azure OpenAI

Treść żądania

Typ zawartości: application/json

Nazwa	Typ	Opis	Wymagane	Domyślny
best_of	liczba całkowita	Generuje uzupełnianie best_of po stronie serwera i zwraca wartość "best" (jedyną z najwyższym prawdopodobieństwem dziennika na token). Nie można przesyłać strumieniowo wyników. W przypadku użycia z nprogramem best_of określa liczbę ukończonych kandydatów i n określa, ile należy zwrócić  ¢â "¬â € â best_of musi być większe niż n. Uwaga: Ponieważ ten parametr generuje wiele uzupełniania, może szybko korzystać z limitu przydziału tokenu. Należy ostrożnie używać i upewnić się, że masz odpowiednie ustawienia dla max_tokens i stop.	Nr	1
Echo	Boolean	Powtórz ponownie monit oprócz ukończenia	Nr	False
frequency_penalty	Numer	Liczba z zakresu od -2.0 do 2.0. Wartości dodatnie karzeją nowe tokeny na podstawie ich istniejącej częstotliwości w tekście do tej pory, zmniejszając prawdopodobieństwo powtórzeń tego samego wiersza.	Nr	0
logit_bias	obiekt	Zmodyfikuj prawdopodobieństwo wyświetlania określonych tokenów w zakończeniu. Akceptuje obiekt JSON, który mapuje tokeny (określone przez ich identyfikator tokenu w tokenizer GPT) do skojarzonej wartości stronniczej z -100 do 100. Matematycznie stronniczy jest dodawany do logitów wygenerowanych przez model przed próbkowaniem. Dokładny efekt różni się w zależności od modelu, ale wartości między -1 a 1 powinny zmniejszyć lub zwiększyć prawdopodobieństwo wyboru; wartości takie jak -100 lub 100 powinny spowodować zakaz lub wyłączny wybór odpowiedniego tokenu. Na przykład możesz przekazać polecenie {"50256": -100} , aby zapobiec wygenerowaniu tokenu <|endoftext|> .	Nr	Brak
logprobs	liczba całkowita	Uwzględnij prawdopodobieństwa dziennika dla logprobs najbardziej prawdopodobnych tokenów wyjściowych, a także wybrane tokeny. Na przykład jeśli logprobs wartość to 5, interfejs API zwraca listę 5 najbardziej prawdopodobnych tokenów. Interfejs API zawsze zwraca logprob przykładowy token, więc może istnieć maksymalnie logprobs+1 elementy w odpowiedzi. Maksymalna wartość parametru logprobs to 5.	Nr	Brak
max_tokens	liczba całkowita	Maksymalna liczba tokenów, które można wygenerować w zakończeniu. Liczba tokenów monitu plus max_tokens nie może przekraczać długości kontekstu modelu.	Nr	16
N	liczba całkowita	Ile uzupełniania ma być generowanych dla każdego monitu. Uwaga: Ponieważ ten parametr generuje wiele uzupełniania, może szybko korzystać z limitu przydziału tokenu. Należy ostrożnie używać i upewnić się, że masz odpowiednie ustawienia dla max_tokens i stop.	Nr	1
presence_penalty	Numer	Liczba z zakresu od -2.0 do 2.0. Wartości dodatnie karzą nowe tokeny na podstawie tego, czy są one wyświetlane w tekście do tej pory, zwiększając prawdopodobieństwo, że model będzie mówił o nowych tematach.	Nr	0
monit	ciąg lub tablica	Monit o wygenerowanie uzupełniania dla ciągów zakodowanych jako ciąg, tablica ciągów, tablica tokenów lub tablica tablicy tokenów. Należy pamiętać, że <|endoftext|> jest separatorem dokumentu, który widzi model podczas trenowania, więc jeśli monit nie zostanie określony, model generuje tak, jakby od początku nowego dokumentu.	Tak
Nasion	liczba całkowita	Jeśli zostanie określony, nasz system dokłada wszelkich starań, aby próbkować deterministycznie, tak aby powtarzające się żądania z tymi samymi seed parametrami i zwracały ten sam wynik. Determinizm nie jest gwarantowany i należy odwołać się do parametru system_fingerprint odpowiedzi w celu monitorowania zmian w zapleczu.	Nr
Zatrzymać	ciąg lub tablica	Maksymalnie cztery sekwencje, w których interfejs API przestaje generować kolejne tokeny. Zwrócony tekst nie będzie zawierać sekwencji zatrzymania.	Nr
odtwarzać strumieniowo	Boolean	Czy przesyłać strumieniowo częściowy postęp. W przypadku ustawienia tokeny są wysyłane jako zdarzenia wysyłane tylko do serwera, gdy staną się dostępne, a strumień zostanie zakończony komunikatem data: [DONE] . Przykładowy kod języka Python.	Nr	False
Sufiks	ciąg	Sufiks, który pojawia się po zakończeniu wstawionego tekstu. Ten parametr jest obsługiwany tylko dla programu gpt-3.5-turbo-instruct.	Nr	Brak
Temperatury	Numer	Jaka temperatura próbkowania ma być używana z zakresu od 0 do 2. Wyższe wartości, takie jak 0,8, sprawiają, że dane wyjściowe będą bardziej losowe, a niższe wartości, takie jak 0,2, sprawiają, że są bardziej skoncentrowane i deterministyczne. Ogólnie zalecamy zmianę tego lub top_p nie obu tych elementów.	Nr	1
top_p	Numer	Alternatywą dla próbkowania z temperaturą, nazywaną próbkowaniem jądra, gdzie model uwzględnia wyniki tokenów z top_p masą prawdopodobieństwa. Dlatego 0,1 oznacza, że uwzględniane są tylko tokeny składające się z 10 pierwszych% masy prawdopodobieństwa. Ogólnie zalecamy zmianę tego lub temperature nie obu tych elementów.	Nr	1
użytkownik	ciąg	Unikatowy identyfikator reprezentujący użytkownika końcowego, który może pomóc w monitorowaniu i wykrywaniu nadużyć.	Nr

Odpowiedzi

Kod stanu: 200

Opis: OK

Typ zawartości	Typu	Opis
application/json	createCompletionResponse

Kod stanu: wartość domyślna

Opis: Usługa niedostępna

Typ zawartości	Typu	Opis
application/json	errorResponse

Przykłady

Przykład

Tworzy uzupełnianie dla podanego monitu, parametrów i wybranego modelu.

POST https://{endpoint}/openai/deployments/{deployment-id}/completions?api-version=2025-04-01-preview

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

Odpowiedzi: Kod stanu: 200

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

Osadzanie — tworzenie

POST https://{endpoint}/openai/deployments/{deployment-id}/embeddings?api-version=2025-04-01-preview

Uzyskaj wektorową reprezentację danych wejściowych, które mogą być łatwo używane przez modele i algorytmy uczenia maszynowego.

Parametry identyfikatora URI

Nazwa	Cala	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	adres URL ciągu	Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, na przykład: https://aoairesource.openai.azure.com. Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI. https://{nazwa_zasobu}.openai.azure.com
identyfikator wdrożenia	ścieżka	Tak	ciąg	Identyfikator wdrożenia wdrożonego modelu.
wersja interfejsu API	kwerenda	Tak	ciąg

Nagłówek żądania

Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.

Nazwa	Wymagane	Typ	Opis
Autoryzacji	True	ciąg	Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize Zakres: https://ai.azure.com/.default
api-key	True	ciąg	Tutaj podaj klucz interfejsu API usługi Azure OpenAI

Treść żądania

Typ zawartości: application/json

Nazwa	Typ	Opis	Wymagane	Domyślny
Wymiary	liczba całkowita	Liczba wymiarów, które powinny mieć wynikowe osadzanie danych wyjściowych. Obsługiwane tylko w text-embedding-3 modelach i nowszych.	Nr
encoding_format	ciąg	Format umożliwiający zwrócenie osadzania. Może to być wartość float lub base64. Wartość domyślna to float.	Nr
dane wejściowe	ciąg lub tablica	Tekst wejściowy do osadzenia, zakodowany jako ciąg lub tablica tokenów. Aby osadzić wiele danych wejściowych w jednym żądaniu, przekaż tablicę ciągów lub tablicę tablic tokenów. Dane wejściowe nie mogą przekraczać maksymalnych tokenów wejściowych dla modelu (8192 tokenów dla text-embedding-ada-002), nie mogą być pustymi ciągami, a każda tablica musi mieć 2048 wymiarów lub mniej.	Tak
input_type	ciąg	typ danych wejściowych wyszukiwania osadzania do użycia	Nr
użytkownik	ciąg	Unikatowy identyfikator reprezentujący użytkownika końcowego, który może pomóc w monitorowaniu i wykrywaniu nadużyć.	Nr

Odpowiedzi

Kod stanu: 200

Opis: OK

Typ zawartości	Typu	Opis
application/json	obiekt

Przykłady

Przykład

Zwróć osadzanie dla danego monitu.

POST https://{endpoint}/openai/deployments/{deployment-id}/embeddings?api-version=2025-04-01-preview

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

Odpowiedzi: Kod stanu: 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.0020113448
        ]
      }
    ],
    "usage": {
      "prompt_tokens": 4,
      "total_tokens": 4
    }
  }
}

Ukończenie czatu — tworzenie

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-01-preview

Tworzy ukończenie wiadomości na czacie

Parametry identyfikatora URI

Nazwa	Cala	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	adres URL ciągu	Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, na przykład: https://aoairesource.openai.azure.com. Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI. https://{nazwa_zasobu}.openai.azure.com
identyfikator wdrożenia	ścieżka	Tak	ciąg
wersja interfejsu API	kwerenda	Tak	ciąg

Nagłówek żądania

Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.

Nazwa	Wymagane	Typ	Opis
Autoryzacji	True	ciąg	Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize Zakres: https://ai.azure.com/.default
api-key	True	ciąg	Tutaj podaj klucz interfejsu API usługi Azure OpenAI

Treść żądania

Typ zawartości: application/json

Nazwa	Typ	Opis	Wymagane	Domyślny
Audio	obiekt	Parametry dla danych wyjściowych dźwięku. Wymagane w przypadku żądania danych wyjściowych dźwięku za pomocą polecenia modalities: ["audio"].	Nr
Format └*	wyliczenie	Określa format dźwięku wyjściowego. Musi być jednym z wavelementów , mp3, flac, opuslub pcm16. Możliwe wartości: wav, , mp3flac, , opuspcm16	Nr
└* głos	wyliczenie	Określa typ głosu. Obsługiwane głosy to alloy, , echo, fableonyx, nova, i shimmer. Możliwe wartości: alloy, , echofable, onyx, , novashimmer	Nr
data_sources	macierz	Wpisy konfiguracji dla rozszerzeń czatu usługi Azure OpenAI, które ich używają. Ta dodatkowa specyfikacja jest zgodna tylko z usługą Azure OpenAI.	Nr
frequency_penalty	Numer	Liczba z zakresu od -2.0 do 2.0. Wartości dodatnie karzeją nowe tokeny na podstawie ich istniejącej częstotliwości w tekście do tej pory, zmniejszając prawdopodobieństwo powtórzeń tego samego wiersza.	Nr	0
function_call	ciąg lub czatCompletionFunctionCallOption	Przestarzałe na rzecz .tool_choice Określa, która (jeśli istnieje) funkcja jest wywoływana przez model. none oznacza, że model nie wywoła funkcji, a zamiast tego generuje komunikat. auto oznacza, że model może wybierać między generowaniem komunikatu lub wywoływaniem funkcji. Określenie określonej funkcji za pośrednictwem {"name": "my_function"} wymusza wywołanie tej funkcji przez model. none jest wartością domyślną, gdy nie ma żadnych funkcji. auto jest wartością domyślną, jeśli funkcje są obecne.	Nr
Funkcje	macierz	Przestarzałe na rzecz .tools Lista funkcji, dla których model może generować dane wejściowe JSON.	Nr
logit_bias	obiekt	Zmodyfikuj prawdopodobieństwo wyświetlania określonych tokenów w zakończeniu. Akceptuje obiekt JSON mapujący tokeny (określone przez ich identyfikator tokenu w tokenizatorze) na skojarzzoną wartość stronniczą z -100 do 100. Matematycznie stronniczy jest dodawany do logitów wygenerowanych przez model przed próbkowaniem. Dokładny efekt różni się w zależności od modelu, ale wartości między -1 a 1 powinny zmniejszyć lub zwiększyć prawdopodobieństwo wyboru; wartości takie jak -100 lub 100 powinny spowodować zakaz lub wyłączny wybór odpowiedniego tokenu.	Nr	Brak
logprobs	Boolean	Czy zwracać prawdopodobieństwo dziennika tokenów wyjściowych, czy nie. Jeśli wartość true, zwraca prawdopodobieństwo dziennika każdego tokenu wyjściowego zwróconego w elemecie contentmessage.	Nr	False
max_completion_tokens	liczba całkowita	Górna granica liczby tokenów, które można wygenerować na potrzeby ukończenia, w tym widoczne tokeny wyjściowe i tokeny rozumowania.	Nr
max_tokens	liczba całkowita	Maksymalna liczba tokenów, które można wygenerować podczas kończenia czatu. Łączna długość tokenów wejściowych i wygenerowanych tokenów jest ograniczona przez długość kontekstu modelu.	Nr
Wiadomości	macierz	Lista wiadomości składających się z konwersacji do tej pory. Przykładowy kod języka Python.	Tak
metadane	obiekt	Tagi i wartości zdefiniowane przez dewelopera używane do filtrowania uzupełniania na pulpicie nawigacyjnym przechowywanych uzupełniania.	Nr
Sposoby	ChatCompletionModalities	Typy danych wyjściowych, które mają być generowane przez model dla tego żądania. Większość modeli jest w stanie wygenerować tekst, co jest wartością domyślną: ["text"] Model gpt-4o-audio-preview może również służyć do generowania dźwięku. Aby zażądać, aby ten model wygenerował odpowiedzi tekstowe i audio, możesz użyć: ["text", "audio"]	Nr
N	liczba całkowita	Ile opcji ukończenia czatu ma być generowanych dla każdej wiadomości wejściowej. Opłaty będą naliczane na podstawie liczby wygenerowanych tokenów we wszystkich wyborach. Zachowaj n , 1 aby zminimalizować koszty.	Nr	1
parallel_tool_calls	ParallelToolCalls	Czy włączyć równoległe wywoływanie funkcji podczas używania narzędzia.	Nr	True
przewidywanie	PredictionContent	Konfiguracja przewidywanych danych wyjściowych, która może znacznie poprawić czas odpowiedzi, gdy duże części odpowiedzi modelu są znane z wyprzedzeniem. Jest to najbardziej typowe w przypadku ponownego generowania pliku z tylko drobnymi zmianami w większości zawartości.	Nr
presence_penalty	Numer	Liczba z zakresu od -2.0 do 2.0. Wartości dodatnie karzą nowe tokeny na podstawie tego, czy są one wyświetlane w tekście do tej pory, zwiększając prawdopodobieństwo, że model będzie mówił o nowych tematach.	Nr	0
reasoning_effort	wyliczenie	Tylko modele o1 Ogranicza nakład pracy na rozumowanie modeli rozumowania. Obecnie obsługiwane wartości to low, mediumi high. Zmniejszenie nakładu pracy w zakresie rozumowania może spowodować szybsze reagowanie i mniej tokenów używanych podczas rozumowania w odpowiedzi. Możliwe wartości: low, , mediumhigh	Nr
response_format	ResponseFormatText lub ResponseFormatJsonObject lub ResponseFormatJsonSchema	Obiekt określający format, który musi zostać wygenerowany przez model. Zgodność z GPT-4o, GPT-4o mini, GPT-4 Turbo i wszystkimi modelami GPT-3.5 Turbo nowszymi niż gpt-3.5-turbo-1106. Ustawienie w celu { "type": "json_schema", "json_schema": {...} } włączenia danych wyjściowych ze strukturą, które gwarantuje, że model jest zgodny z podanym schematem JSON. Ustawienie w celu { "type": "json_object" } włączenia trybu JSON, co gwarantuje, że komunikat generowany przez model jest prawidłowym kodem JSON. Ważne: w przypadku korzystania z trybu JSON należy również poinstruować model, aby samodzielnie wygenerował kod JSON za pośrednictwem komunikatu systemowego lub użytkownika. Bez tego model może wygenerować niekończący się strumień białych znaków, dopóki generowanie nie osiągnie limitu tokenu, co spowoduje długotrwałe i pozornie "zablokowane" żądanie. Należy również zauważyć, że zawartość wiadomości może być częściowo odcięta, jeśli finish_reason="length", co wskazuje, że generacja przekroczyła max_tokens lub konwersacja przekroczyła maksymalną długość kontekstu.	Nr
Nasion	liczba całkowita	Ta funkcja jest dostępna w wersji beta. Jeśli zostanie określony, nasz system dokłada wszelkich starań, aby próbkować deterministycznie, tak aby powtarzające się żądania z tymi samymi seed parametrami i zwracały ten sam wynik. Determinizm nie jest gwarantowany i należy odwołać się do parametru system_fingerprint odpowiedzi w celu monitorowania zmian w zapleczu.	Nr
Zatrzymać	ciąg lub tablica	Maksymalnie 4 sekwencje, w których interfejs API przestaje generować kolejne tokeny.	Nr
przechowywać	Boolean	Niezależnie od tego, czy dane wyjściowe tego żądania ukończenia czatu mają być używane w naszych produktach destylacyjnych lub ewaluacyjnych modelu.	Nr
odtwarzać strumieniowo	Boolean	W przypadku ustawienia są wysyłane częściowe różnice komunikatów, na przykład w module ChatGPT. Tokeny są wysyłane jako zdarzenia wysyłane tylko do serwera w miarę data: [DONE] ich dostępności, a strumień jest przerywany przez komunikat. Przykładowy kod języka Python.	Nr	False
stream_options	chatCompletionStreamOptions	Opcje odpowiedzi przesyłania strumieniowego. Ustaw tę wartość tylko po ustawieniu .stream: true	Nr	Brak
Temperatury	Numer	Jaka temperatura próbkowania ma być używana z zakresu od 0 do 2. Wyższe wartości, takie jak 0,8, sprawiają, że dane wyjściowe będą bardziej losowe, a niższe wartości, takie jak 0,2, sprawiają, że są bardziej skoncentrowane i deterministyczne. Ogólnie zalecamy zmianę tego lub top_p nie obu tych elementów.	Nr	1
tool_choice	chatCompletionToolChoiceOption	Określa, które narzędzie (jeśli istnieje) jest wywoływane przez model. none oznacza, że model nie wywoła żadnego narzędzia, a zamiast tego generuje komunikat. auto oznacza, że model może wybierać między generowaniem komunikatu lub wywoływaniem co najmniej jednego narzędzia. required oznacza, że model musi wywoływać co najmniej jedno narzędzie. Określenie określonego narzędzia za pośrednictwem {"type": "function", "function": {"name": "my_function"}} wymusza wywołanie tego narzędzia przez model. none jest ustawieniem domyślnym, gdy żadne narzędzia nie są obecne. auto jest wartością domyślną, jeśli istnieją narzędzia.	Nr
Narzędzia	macierz	Lista narzędzi, które może wywołać model. Obecnie tylko funkcje są obsługiwane jako narzędzie. Służy do udostępniania listy funkcji, dla których model może generować dane wejściowe JSON. Obsługiwane są maksymalnie 128 funkcji.	Nr
top_logprobs	liczba całkowita	Liczba całkowita z zakresu od 0 do 20 określająca liczbę najbardziej prawdopodobnych tokenów do zwrócenia na każdej pozycji tokenu, z których każde ma skojarzone prawdopodobieństwo dziennika. logprobs musi być ustawiona na true wartość , jeśli ten parametr jest używany.	Nr
top_p	Numer	Alternatywą dla próbkowania z temperaturą, nazywaną próbkowaniem jądra, gdzie model uwzględnia wyniki tokenów z top_p masą prawdopodobieństwa. Dlatego 0,1 oznacza, że uwzględniane są tylko tokeny składające się z 10 pierwszych% masy prawdopodobieństwa. Ogólnie zalecamy zmianę tego lub temperature nie obu tych elementów.	Nr	1
użytkownik	ciąg	Unikatowy identyfikator reprezentujący użytkownika końcowego, który może pomóc w monitorowaniu i wykrywaniu nadużyć.	Nr
user_security_context	userSecurityContext	Kontekst zabezpieczeń użytkownika zawiera kilka parametrów opisujących samą aplikację sztucznej inteligencji oraz użytkownika końcowego, który wchodzi w interakcję z aplikacją sztucznej inteligencji. Te pola ułatwiają zespołom ds. operacji zabezpieczeń badanie i eliminowanie zdarzeń zabezpieczeń, zapewniając kompleksowe podejście do ochrony aplikacji sztucznej inteligencji. Dowiedz się więcej na temat ochrony aplikacji sztucznej inteligencji przy użyciu usługi Microsoft Defender dla Chmury.	Nr

Odpowiedzi

Kod stanu: 200

Opis: OK

Typ zawartości	Typu	Opis
application/json	obiekt

Kod stanu: wartość domyślna

Opis: Usługa niedostępna

Typ zawartości	Typu	Opis
application/json	errorResponse

Przykłady

Przykład

Tworzy uzupełnianie dla podanego monitu, parametrów i wybranego modelu.

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-01-preview

{
 "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?"
  }
 ]
}

Odpowiedzi: Kod stanu: 200

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

Przykład

Tworzy uzupełnianie na podstawie danych usługi Azure Search i przypisanej przez system tożsamości zarządzanej.

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-01-preview

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

Odpowiedzi: Kod stanu: 200

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

Przykład

Tworzy uzupełnianie na podstawie danych wektorów obrazów usługi Azure Search.

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-01-preview

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

Odpowiedzi: Kod stanu: 200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion."
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Przykład

Tworzy uzupełnianie na podstawie danych wektora usługi Azure Search, poprzedniego komunikatu asystenta i tożsamości zarządzanej przypisanej przez użytkownika.

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-01-preview

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

Odpowiedzi: Kod stanu: 200

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

Przykład

Tworzy ukończenie dla podanej usługi Azure Cosmos DB.

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-01-preview

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

Odpowiedzi: Kod stanu: 200

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

Przykład

Tworzy ukończenie dla podanej bazy danych Mongo DB.

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-01-preview

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "mongo_db",
   "parameters": {
    "authentication": {
     "type": "username_and_password",
     "username": "<username>",
     "password": "<password>"
    },
    "endpoint": "<endpoint_name>",
    "app_name": "<application name>",
    "database_name": "sampledb",
    "collection_name": "samplecollection",
    "index_name": "sampleindex",
    "embedding_dependency": {
     "type": "deployment_name",
     "deployment_name": "{embedding deployment name}"
    },
    "fields_mapping": {
     "content_fields": [
      "content"
     ],
     "vector_fields": [
      "contentvector"
     ]
    }
   }
  }
 ]
}

Odpowiedzi: Kod stanu: 200

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

Przykład

Tworzy ukończenie dla podanego programu Elasticsearch.

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-01-preview

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "elasticsearch",
   "parameters": {
    "endpoint": "https://your-elasticsearch-endpoint.eastus.azurecontainer.io",
    "index_name": "{index name}",
    "authentication": {
     "type": "key_and_key_id",
     "key": "{key}",
     "key_id": "{key id}"
    }
   }
  }
 ]
}

Odpowiedzi: Kod stanu: 200

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

Przykład

Tworzy ukończenie dla podanego zasobu Pinecone.

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-01-preview

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "pinecone",
   "parameters": {
    "authentication": {
     "type": "api_key",
     "key": "{api key}"
    },
    "environment": "{environment name}",
    "index_name": "{index name}",
    "embedding_dependency": {
     "type": "deployment_name",
     "deployment_name": "{embedding deployment name}"
    },
    "fields_mapping": {
     "title_field": "title",
     "url_field": "url",
     "filepath_field": "filepath",
     "content_fields": [
      "content"
     ],
     "content_fields_separator": "\n"
    }
   }
  }
 ]
}

Odpowiedzi: Kod stanu: 200

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

Transkrypcje — tworzenie

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/transcriptions?api-version=2025-04-01-preview

Transkrybuje dźwięk w języku wejściowym.

Parametry identyfikatora URI

Nazwa	Cala	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	adres URL ciągu	Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, na przykład: https://aoairesource.openai.azure.com. Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI. https://{nazwa_zasobu}.openai.azure.com
identyfikator wdrożenia	ścieżka	Tak	ciąg
wersja interfejsu API	kwerenda	Tak	ciąg

Nagłówek żądania

Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.

Nazwa	Wymagane	Typ	Opis
Autoryzacji	True	ciąg	Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize Zakres: https://ai.azure.com/.default
api-key	True	ciąg	Tutaj podaj klucz interfejsu API usługi Azure OpenAI

Treść żądania

Typ zawartości: multipart/form-data

Nazwa	Typ	Opis	Wymagane	Domyślny
model	ciąg	Identyfikator modelu do użycia. Opcje to gpt-4o-transcribe, , gpt-4o-mini-transcribe, gpt-4o-mini-transcribe-2025-12-15whisper-1, i gpt-4o-transcribe-diarize.	Tak
plik	ciąg	Obiekt pliku audio do transkrypcji.	Tak
język	ciąg	Język wejściowego dźwięku. Dostarczanie języka wejściowego w formacie ISO-639-1 zwiększa dokładność i opóźnienie.	Nr
monit	ciąg	Opcjonalny tekst prowadzący do stylu modelu lub kontynuacji poprzedniego segmentu audio. Monit powinien być zgodny z językiem dźwięku.	Nr
response_format	audioResponseFormat	Definiuje format danych wyjściowych.	Nr
Temperatury	Numer	Temperatura próbkowania z zakresu od 0 do 1. Wyższe wartości, takie jak 0,8, sprawią, że dane wyjściowe będą bardziej losowe, a niższe wartości, takie jak 0,2, sprawią, że będzie bardziej skoncentrowany i deterministyczny. Jeśli ustawiono wartość 0, model używa prawdopodobieństwa dziennika, aby automatycznie zwiększyć temperaturę do momentu przekroczenia określonych progów.	Nr	0
timestamp_granularities[]	macierz	Stopień szczegółowości sygnatury czasowej do wypełnienia dla tej transkrypcji. response_format należy ustawić, verbose_json aby używać szczegółowości sygnatury czasowej. Obsługiwane są obie te opcje: word, lub segment. Uwaga: nie ma dodatkowego opóźnienia dla sygnatur czasowych segmentu, ale generowanie znaczników czasu wyrazów powoduje dodatkowe opóźnienie.	Nr	['segment']

Odpowiedzi

Kod stanu: 200

Opis: OK

Typ zawartości	Typu	Opis
application/json	obiekt
tekst/zwykły	ciąg	Transkrypcja tekstu w formacie danych wyjściowych (gdy response_format była jedną z textwartości lub vttsrt).

Przykłady

Przykład

Pobiera transkrypcja tekstu i skojarzonych metadanych z dostarczonych danych dźwiękowych mówionych.

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/transcriptions?api-version=2025-04-01-preview

Odpowiedzi: Kod stanu: 200

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

Przykład

Pobiera transkrypcja tekstu i skojarzonych metadanych z dostarczonych danych dźwiękowych mówionych.

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/transcriptions?api-version=2025-04-01-preview

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

Odpowiedzi: Kod stanu: 200

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

Tłumaczenia — tworzenie

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/translations?api-version=2025-04-01-preview

Transkrybuje i tłumaczy dźwięk wejściowy na tekst w języku angielskim.

Parametry identyfikatora URI

Nazwa	Cala	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	adres URL ciągu	Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, na przykład: https://aoairesource.openai.azure.com. Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI. https://{nazwa_zasobu}.openai.azure.com
identyfikator wdrożenia	ścieżka	Tak	ciąg
wersja interfejsu API	kwerenda	Tak	ciąg

Nagłówek żądania

Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.

Nazwa	Wymagane	Typ	Opis
Autoryzacji	True	ciąg	Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize Zakres: https://ai.azure.com/.default
api-key	True	ciąg	Tutaj podaj klucz interfejsu API usługi Azure OpenAI

Treść żądania

Typ zawartości: multipart/form-data

Nazwa	Typ	Opis	Wymagane	Domyślny
plik	ciąg	Plik audio do tłumaczenia.	Tak
monit	ciąg	Opcjonalny tekst prowadzący do stylu modelu lub kontynuacji poprzedniego segmentu audio. Monit powinien być w języku angielskim.	Nr
response_format	audioResponseFormat	Definiuje format danych wyjściowych.	Nr
Temperatury	Numer	Temperatura próbkowania z zakresu od 0 do 1. Wyższe wartości, takie jak 0,8, sprawią, że dane wyjściowe będą bardziej losowe, a niższe wartości, takie jak 0,2, sprawią, że będzie bardziej skoncentrowany i deterministyczny. Jeśli ustawiono wartość 0, model używa prawdopodobieństwa dziennika, aby automatycznie zwiększyć temperaturę do momentu przekroczenia określonych progów.	Nr	0

Odpowiedzi

Kod stanu: 200

Opis: OK

Typ zawartości	Typu	Opis
application/json	obiekt
tekst/zwykły	ciąg	Transkrypcja tekstu w formacie wyjściowym (gdy response_format był jednym z tekstu, vtt lub srt).

Przykłady

Przykład

Pobiera transkrybowany tekst w języku angielskim i skojarzone metadane z dostarczonych danych dźwiękowych mówionych.

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/translations?api-version=2025-04-01-preview

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

Odpowiedzi: Kod stanu: 200

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

Przykład

Pobiera transkrybowany tekst w języku angielskim i skojarzone metadane z dostarczonych danych dźwiękowych mówionych.

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/translations?api-version=2025-04-01-preview

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

Odpowiedzi: Kod stanu: 200

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

Mowa — tworzenie

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/speech?api-version=2025-04-01-preview

Generuje dźwięk z tekstu wejściowego.

Parametry identyfikatora URI

Nazwa	Cala	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	adres URL ciągu	Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, na przykład: https://aoairesource.openai.azure.com. Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI. https://{nazwa_zasobu}.openai.azure.com
identyfikator wdrożenia	ścieżka	Tak	ciąg
wersja interfejsu API	kwerenda	Tak	ciąg

Nagłówek żądania

Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.

Nazwa	Wymagane	Typ	Opis
Autoryzacji	True	ciąg	Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize Zakres: https://ai.azure.com/.default
api-key	True	ciąg	Tutaj podaj klucz interfejsu API usługi Azure OpenAI

Treść żądania

Typ zawartości: multipart/form-data

Nazwa	Typ	Opis	Wymagane	Domyślny
dane wejściowe	ciąg	Tekst do syntezowania dźwięku. Maksymalna długość to 4096 znaków.	Tak
response_format	wyliczenie	Format syntetyzowania dźwięku. Możliwe wartości: mp3, , opusaac, flac, , wavpcm	Nr
Prędkość	Numer	Szybkość syntetyzowanego dźwięku. Wybierz wartość z 0.25 do 4.0. 1.0 jest wartością domyślną.	Nr	1.0
głos	wyliczenie	Głos używany do syntezy mowy. Możliwe wartości: alloy, , echofable, onyx, , novashimmer	Tak

Odpowiedzi

Kod stanu: 200

Opis: OK

Typ zawartości	Typu	Opis
application/octet-stream	ciąg

Przykłady

Przykład

Syntetyzuje dźwięk z dostarczonego tekstu.

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/speech?api-version=2025-04-01-preview

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

Odpowiedzi: Kod stanu: 200

{
  "body": "101010101"
}

Generacje obrazów — tworzenie

POST https://{endpoint}/openai/deployments/{deployment-id}/images/generations?api-version=2025-04-01-preview

Generuje partię obrazów na podstawie podpisu tekstowego dla danego wdrożenia modelu generowania obrazów

Parametry identyfikatora URI

Nazwa	Cala	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	adres URL ciągu	Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, na przykład: https://aoairesource.openai.azure.com. Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI. https://{nazwa_zasobu}.openai.azure.com
identyfikator wdrożenia	ścieżka	Tak	ciąg
wersja interfejsu API	kwerenda	Tak	ciąg

Nagłówek żądania

Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.

Nazwa	Wymagane	Typ	Opis
Autoryzacji	True	ciąg	Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize Zakres: https://ai.azure.com/.default
api-key	True	ciąg	Tutaj podaj klucz interfejsu API usługi Azure OpenAI

Treść żądania

Typ zawartości: application/json

Nazwa	Typ	Opis	Wymagane	Domyślny
tło	imageBackground	Umożliwia ustawienie przezroczystości tła wygenerowanych obrazów. Ten parametr jest obsługiwany tylko w przypadku modeli serii gpt-image-1.	Nr	Automatycznie
N	liczba całkowita	Liczba obrazów do wygenerowania. W przypadku języka dall-e-3 obsługiwane jest tylko n=1.	Nr	1
output_compression	liczba całkowita	Poziom kompresji (0–100%) dla wygenerowanych obrazów. Ten parametr jest obsługiwany tylko w przypadku modeli serii gpt-image-1 z formatem danych wyjściowych jpeg.	Nr	100
output_format	imagesOutputFormat	Format pliku, w którym są zwracane wygenerowane obrazy. Obsługiwane tylko w przypadku modeli serii gpt-image-1.	Nr	Png
monit	ciąg	Opis tekstu żądanych obrazów. Maksymalna długość to 32000 znaków dla serii gpt-image-1 i 4000 znaków dla dall-e-3	Tak
partial_images	liczba całkowita	Liczba częściowych obrazów do wygenerowania. Ten parametr jest używany do przesyłania strumieniowego odpowiedzi, które zwracają częściowe obrazy. Wartość musi należeć do przedziału od 0 do 3. Po ustawieniu wartości 0 odpowiedź będzie pojedynczym obrazem wysłanym w jednym zdarzeń przesyłania strumieniowego. Należy pamiętać, że ostateczny obraz może zostać wysłany przed wygenerowaniem pełnej liczby obrazów częściowych, jeśli pełny obraz zostanie wygenerowany szybciej.	0
odtwarzać strumieniowo	Boolean	Edytuj obraz w trybie przesyłania strumieniowego.	Nr	false
Jakości	imageQuality	Jakość obrazu, który zostanie wygenerowany.	Nr	Automatycznie
response_format	imagesResponseFormat	Format, w którym są zwracane wygenerowane obrazy. Ten parametr nie jest obsługiwany w przypadku gpt-image-1modeli serii , które zawsze będą zwracać obrazy zakodowane w formacie base64. Możliwe wartości: url, b64_json.	Nr	Adres url
Rozmiar	Imagesize	Rozmiar wygenerowanych obrazów.	Nr	Automatycznie
styl	imageStyle	Styl wygenerowanych obrazów. Obsługiwane tylko dla dall-e-3.	Nr	Żywe
użytkownik	ciąg	Unikatowy identyfikator reprezentujący użytkownika końcowego, który może pomóc w monitorowaniu i wykrywaniu nadużyć.	Nr

Odpowiedzi

Kod stanu: 200

Opis: Ok

Typ zawartości	Typu	Opis
application/json	generateImagesResponse

Kod stanu: wartość domyślna

Opis: Wystąpił błąd.

Typ zawartości	Typu	Opis
application/json	dalleErrorResponse

Przykłady

Przykład

Tworzy obrazy z monitem.

POST https://{endpoint}/openai/deployments/{deployment-id}/images/generations?api-version=2025-04-01-preview

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

Odpowiedzi: Kod stanu: 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
          }
        }
      }
    ]
  }
}

Generacje obrazów — edycja

POST https://{endpoint}/openai/deployments/{deployment-id}/images/edits?api-version=2025-04-01-preview

Edytuje obraz z podpisu tekstowego dla danego wdrożenia modelu gpt-image-1

Parametry identyfikatora URI

Nazwa	Cala	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	adres URL ciągu	Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, na przykład: https://aoairesource.openai.azure.com. Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI. https://{nazwa_zasobu}.openai.azure.com
identyfikator wdrożenia	ścieżka	Tak	ciąg
wersja interfejsu API	kwerenda	Tak	ciąg

Nagłówek żądania

Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.

Nazwa	Wymagane	Typ	Opis
Autoryzacji	True	ciąg	Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize Zakres: https://ai.azure.com/.default
api-key	True	ciąg	Tutaj podaj klucz interfejsu API usługi Azure OpenAI

Treść żądania

Typ zawartości: multipart/form-data

Nazwa	Typ	Opis	Wymagane	Domyślny
obraz	ciąg lub tablica	Obrazy do edycji. Musi być obsługiwanym plikiem obrazu lub tablicą obrazów. Każdy obraz powinien być plikiem png lub jpg mniejszym niż 50 MB.	Tak
input_fidelity	ciąg	Kontrolowanie nakładu pracy, jaki będzie wywierać model, aby dopasować styl i cechy, zwłaszcza cechy twarzy, obrazów wejściowych. Ten parametr jest obsługiwany tylko w przypadku modeli serii gpt-image-1. Obsługuje i highlow.	Nr	low.
maska	ciąg	Dodatkowy obraz, którego w pełni przezroczyste obszary (np. alfa ma wartość zero) wskazują, gdzie ma być edytowany obraz. Jeśli dostępnych jest wiele obrazów, maska zostanie zastosowana do pierwszego obrazu. Musi być prawidłowym plikiem PNG, mniejszym niż 4 MB i mieć takie same wymiary jak obraz.	Nr
N	liczba całkowita	Liczba obrazów do wygenerowania. Musi należeć do zakresu od 1 do 10.	Nr	1
monit	ciąg	Opis tekstu żądanych obrazów. Maksymalna długość to 32000 znaków.	Tak
Jakości	imageQuality	Jakość obrazu, który zostanie wygenerowany.	Nr	Automatycznie
partial_images	Liczba częściowych obrazów do wygenerowania. Ten parametr jest używany do przesyłania strumieniowego odpowiedzi, które zwracają częściowe obrazy. Wartość musi należeć do przedziału od 0 do 3. Po ustawieniu wartości 0 odpowiedź będzie pojedynczym obrazem wysłanym w jednym zdarzeń przesyłania strumieniowego. Należy pamiętać, że ostateczny obraz może zostać wysłany przed wygenerowaniem pełnej liczby obrazów częściowych, jeśli pełny obraz zostanie wygenerowany szybciej.
odtwarzać strumieniowo	Boolean	Edytuj obraz w trybie przesyłania strumieniowego.	Nr	false
response_format	imagesResponseFormat	Format, w którym są zwracane wygenerowane obrazy.	Nr	Adres url
Rozmiar	Imagesize	Rozmiar wygenerowanych obrazów.	Nr	Automatycznie
użytkownik	ciąg	Unikatowy identyfikator reprezentujący użytkownika końcowego, który może pomóc w monitorowaniu i wykrywaniu nadużyć.	Nr

Odpowiedzi

Kod stanu: 200

Opis: Ok

Typ zawartości	Typu	Opis
application/json	generateImagesResponse

Kod stanu: wartość domyślna

Opis: Wystąpił błąd.

Typ zawartości	Typu	Opis
application/json	dalleErrorResponse

Lista — Asystenci

Uwaga

Interfejs API Asystentów jest przestarzały i zostanie wycofany 26 sierpnia 2026 r. Użyj ogólnie dostępnej usługi Microsoft Foundry Agents. Postępuj zgodnie z przewodnikiem migracji , aby zaktualizować obciążenia. Dowiedz się więcej.

GET https://{endpoint}/openai/assistants?api-version=2025-04-01-preview

Zwraca listę asystentów.

Parametry identyfikatora URI

Nazwa	Cala	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	adres URL ciągu	Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, na przykład: https://aoairesource.openai.azure.com. Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI. https://{nazwa_zasobu}.openai.azure.com
Limit	kwerenda	Nr	liczba całkowita	Limit liczby zwracanych obiektów. Limit może mieścić się w zakresie od 1 do 100, a wartość domyślna to 20.
porządek	kwerenda	Nr	ciąg Możliwe wartości: asc, desc	Sortuj kolejność według znacznika created_at czasu obiektów. asc w przypadku kolejności rosnącej i desc kolejności malejącej.
Po	kwerenda	Nr	ciąg	Kursor do użycia w stronicowaniu. after jest identyfikatorem obiektu definiującym miejsce na liście. Jeśli na przykład wykonasz żądanie listy i otrzymasz 100 obiektów, kończąc się obj_foo, kolejne wywołanie może obejmować polecenie after=obj_foo w celu pobrania następnej strony listy.
Przed	kwerenda	Nr	ciąg	Kursor do użycia w stronicowaniu. before jest identyfikatorem obiektu definiującym miejsce na liście. Jeśli na przykład wykonasz żądanie listy i otrzymasz 100 obiektów, począwszy od obj_foo, kolejne wywołanie może zawierać wartość before=obj_foo w celu pobrania poprzedniej strony listy.
wersja interfejsu API	kwerenda	Tak	ciąg

Nagłówek żądania

Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.

Nazwa	Wymagane	Typ	Opis
Autoryzacji	True	ciąg	Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize Zakres: https://ai.azure.com/.default
api-key	True	ciąg	Tutaj podaj klucz interfejsu API usługi Azure OpenAI

Odpowiedzi

Kod stanu: 200

Opis: OK

Typ zawartości	Typu	Opis
application/json	listAssistantsResponse

Przykłady

Przykład

Zwraca listę asystentów.

GET https://{endpoint}/openai/assistants?api-version=2025-04-01-preview

Odpowiedzi: Kod stanu: 200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "asst_abc123",
        "object": "assistant",
        "created_at": 1707257477,
        "name": "Stock Analyst",
        "description": null,
        "model": "gpt-4-1106-preview",
        "instructions": "You are a financial analyst that analyzes stock market prices and other financial data present on user uploaded files or by calling external APIs.",
        "tools": [
          {
            "type": "code_interpreter"
          }
        ],
        "tool_resources": {},
        "metadata": {},
        "top_p": 1.0,
        "temperature": 1.0,
        "response_format": "auto"
      },
      {
        "id": "asst_abc456",
        "object": "assistant",
        "created_at": 1698982718,
        "name": "My Assistant",
        "description": null,
        "model": "gpt-4-turbo",
        "instructions": "You are a helpful assistant designed to make me better at coding!",
        "tools": [],
        "tool_resources": {},
        "metadata": {},
        "top_p": 1.0,
        "temperature": 1.0,
        "response_format": "auto"
      },
      {
        "id": "asst_abc789",
        "object": "assistant",
        "created_at": 1698982643,
        "name": null,
        "description": null,
        "model": "gpt-4-turbo",
        "instructions": null,
        "tools": [],
        "tool_resources": {},
        "metadata": {},
        "top_p": 1.0,
        "temperature": 1.0,
        "response_format": "auto"
      }
    ],
    "first_id": "asst_abc123",
    "last_id": "asst_abc789",
    "has_more": false
  }
}

Tworzenie — Asystent

POST https://{endpoint}/openai/assistants?api-version=2025-04-01-preview

Utwórz asystenta przy użyciu modelu i instrukcji.

Parametry identyfikatora URI

Nazwa	Cala	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	adres URL ciągu	Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, na przykład: https://aoairesource.openai.azure.com. Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI. https://{nazwa_zasobu}.openai.azure.com
wersja interfejsu API	kwerenda	Tak	ciąg

Nagłówek żądania

Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.

Nazwa	Wymagane	Typ	Opis
Autoryzacji	True	ciąg	Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize Zakres: https://ai.azure.com/.default
api-key	True	ciąg	Tutaj podaj klucz interfejsu API usługi Azure OpenAI

Treść żądania

Typ zawartości: application/json

Nazwa	Typ	Opis	Wymagane	Domyślny
Opis	ciąg	Opis asystenta. Maksymalna długość to 512 znaków.	Nr
Instrukcje	ciąg	Instrukcje systemowe używane przez asystenta. Maksymalna długość to 256 000 znaków.	Nr
metadane	obiekt	Zestaw 16 par klucz-wartość, które można dołączyć do obiektu. Może to być przydatne do przechowywania dodatkowych informacji o obiekcie w formacie ustrukturyzowanym. Klucze mogą mieć długość maksymalnie 64 znaków, a wartości mogą mieć długość maksymalnie 512 znaków.	Nr
model	ciąg		Tak
Nazwa	ciąg	Nazwa asystenta. Maksymalna długość to 256 znaków.	Nr
response_format	assistantsApiResponseFormatOption	Określa format, który model musi wyświetlić. Zgodność z GPT-4o, GPT-4 Turbo i wszystkimi modelami GPT-3.5 Turbo od gpt-3.5-turbo-1106. Ustawienie umożliwia { "type": "json_schema", "json_schema": {...} } włączenie danych wyjściowych ze strukturą, które zapewniają, że model jest zgodny z podanym schematem JSON. Dowiedz się więcej w przewodniku Dotyczącym danych wyjściowych ze strukturą. Ustawienie w celu { "type": "json_object" } włączenia trybu JSON, co gwarantuje, że komunikat generowany przez model jest prawidłowym kodem JSON. Ważne: w przypadku korzystania z trybu JSON należy również poinstruować model, aby samodzielnie wygenerował kod JSON za pośrednictwem komunikatu systemowego lub użytkownika. Bez tego model może wygenerować niekończący się strumień białych znaków, dopóki generowanie nie osiągnie limitu tokenu, co spowoduje długotrwałe i pozornie "zablokowane" żądanie. Należy również zauważyć, że zawartość wiadomości może być częściowo odcięta, jeśli finish_reason="length", co wskazuje, że generacja przekroczyła max_tokens lub konwersacja przekroczyła maksymalną długość kontekstu.	Nr
Temperatury	Numer	Jaka temperatura próbkowania ma być używana z zakresu od 0 do 2. Wyższe wartości, takie jak 0,8, sprawią, że dane wyjściowe będą bardziej losowe, a niższe wartości, takie jak 0,2, sprawią, że będzie bardziej skoncentrowany i deterministyczny.	Nr	1
tool_resources	obiekt	Zestaw zasobów używanych przez narzędzia asystenta. Zasoby są specyficzne dla typu narzędzia. Na przykład code_interpreter narzędzie wymaga listy identyfikatorów plików, a file_search narzędzie wymaga listy identyfikatorów magazynów wektorów.	Nr
└code_interpreter	obiekt		Nr
└file_ids	macierz	Lista identyfikatorów plików udostępnionych narzędziu code_interpreter . Może istnieć maksymalnie 20 plików skojarzonych z narzędziem.	Nr	[]
└file_search	obiekt		Nr
└vector_store_ids	macierz	Magazyn wektorów dołączony do tego asystenta. Może istnieć maksymalnie 1 magazyn wektorów dołączony do asystenta.	Nr
└vector_stores	macierz	Pomocnik do tworzenia magazynu wektorów z file_ids i dołączania go do tego asystenta. Może istnieć maksymalnie 1 magazyn wektorów dołączony do asystenta.	Nr
Narzędzia	macierz	Lista narzędzi włączona w asystencie. Może istnieć maksymalnie 128 narzędzi na asystenta. Narzędzia mogą być typami code_interpreter, retrievallub function.	Nr	[]
top_p	Numer	Alternatywą dla próbkowania z temperaturą, nazywaną próbkowaniem jądra, gdzie model uwzględnia wyniki tokenów z top_p masą prawdopodobieństwa. Dlatego 0,1 oznacza, że uwzględniane są tylko tokeny składające się z 10 pierwszych% masy prawdopodobieństwa. Ogólnie zalecamy zmianę tej wartości lub temperatury, ale nie obu.	Nr	1

Odpowiedzi

Kod stanu: 200

Opis: OK

Typ zawartości	Typu	Opis
application/json	assistantObject

Przykłady

Przykład

Utwórz asystenta przy użyciu modelu i instrukcji.

POST https://{endpoint}/openai/assistants?api-version=2025-04-01-preview

{
 "name": "Math Tutor",
 "instructions": "When a customer asks about a specific math problem, use Python to evaluate their query.",
 "tools": [
  {
   "type": "code_interpreter"
  }
 ],
 "model": "gpt-4-1106-preview"
}

Odpowiedzi: Kod stanu: 200

{
  "body": {
    "id": "asst_4nsG2qgNzimRPE7MazXTXbU7",
    "object": "assistant",
    "created_at": 1707295707,
    "name": "Math Tutor",
    "description": null,
    "model": "gpt-4-1106-preview",
    "instructions": "When a customer asks about a specific math problem, use Python to evaluate their query.",
    "tools": [
      {
        "type": "code_interpreter"
      }
    ],
    "metadata": {},
    "top_p": 1.0,
    "temperature": 1.0,
    "response_format": "auto"
  }
}

Pobierz — Asystent

GET https://{endpoint}/openai/assistants/{assistant_id}?api-version=2025-04-01-preview

Pobiera asystenta.

Parametry identyfikatora URI

Nazwa	Cala	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	adres URL ciągu	Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, na przykład: https://aoairesource.openai.azure.com. Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI. https://{nazwa_zasobu}.openai.azure.com
assistant_id	ścieżka	Tak	ciąg	Identyfikator asystenta do pobrania.
wersja interfejsu API	kwerenda	Tak	ciąg

Nagłówek żądania

Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.

Nazwa	Wymagane	Typ	Opis
Autoryzacji	True	ciąg	Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize Zakres: https://ai.azure.com/.default
api-key	True	ciąg	Tutaj podaj klucz interfejsu API usługi Azure OpenAI

Odpowiedzi

Kod stanu: 200

Opis: OK

Typ zawartości	Typu	Opis
application/json	assistantObject

Przykłady

Przykład

Pobiera asystenta.

GET https://{endpoint}/openai/assistants/{assistant_id}?api-version=2025-04-01-preview

Odpowiedzi: Kod stanu: 200

{
  "body": {
    "id": "asst_abc123",
    "object": "assistant",
    "created_at": 1699009709,
    "name": "HR Helper",
    "description": null,
    "model": "gpt-4-turbo",
    "instructions": "You are an HR bot, and you have access to files to answer employee questions about company policies.",
    "tools": [
      {
        "type": "file_search"
      }
    ],
    "metadata": {},
    "top_p": 1.0,
    "temperature": 1.0,
    "response_format": "auto"
  }
}

Modyfikowanie — Asystent

POST https://{endpoint}/openai/assistants/{assistant_id}?api-version=2025-04-01-preview

Modyfikuje asystenta.

Parametry identyfikatora URI

Nazwa	Cala	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	adres URL ciągu	Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, na przykład: https://aoairesource.openai.azure.com. Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI. https://{nazwa_zasobu}.openai.azure.com
assistant_id	ścieżka	Tak	ciąg	Identyfikator asystenta do zmodyfikowania.
wersja interfejsu API	kwerenda	Tak	ciąg

Nagłówek żądania

Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.

Nazwa	Wymagane	Typ	Opis
Autoryzacji	True	ciąg	Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize Zakres: https://ai.azure.com/.default
api-key	True	ciąg	Tutaj podaj klucz interfejsu API usługi Azure OpenAI

Treść żądania

Typ zawartości: application/json

Nazwa	Typ	Opis	Wymagane	Domyślny
Opis	ciąg	Opis asystenta. Maksymalna długość to 512 znaków.	Nr
Instrukcje	ciąg	Instrukcje systemowe używane przez asystenta. Maksymalna długość to 32768 znaków.	Nr
metadane	obiekt	Zestaw 16 par klucz-wartość, które można dołączyć do obiektu. Może to być przydatne do przechowywania dodatkowych informacji o obiekcie w formacie ustrukturyzowanym. Klucze mogą mieć długość maksymalnie 64 znaków, a wartości mogą mieć długość maksymalnie 512 znaków.	Nr
model	ciąg		Nr
Nazwa	ciąg	Nazwa asystenta. Maksymalna długość to 256 znaków.	Nr
response_format	assistantsApiResponseFormatOption	Określa format, który model musi wyświetlić. Zgodność z GPT-4o, GPT-4 Turbo i wszystkimi modelami GPT-3.5 Turbo od gpt-3.5-turbo-1106. Ustawienie umożliwia { "type": "json_schema", "json_schema": {...} } włączenie danych wyjściowych ze strukturą, które zapewniają, że model jest zgodny z podanym schematem JSON. Dowiedz się więcej w przewodniku Dotyczącym danych wyjściowych ze strukturą. Ustawienie w celu { "type": "json_object" } włączenia trybu JSON, co gwarantuje, że komunikat generowany przez model jest prawidłowym kodem JSON. Ważne: w przypadku korzystania z trybu JSON należy również poinstruować model, aby samodzielnie wygenerował kod JSON za pośrednictwem komunikatu systemowego lub użytkownika. Bez tego model może wygenerować niekończący się strumień białych znaków, dopóki generowanie nie osiągnie limitu tokenu, co spowoduje długotrwałe i pozornie "zablokowane" żądanie. Należy również zauważyć, że zawartość wiadomości może być częściowo odcięta, jeśli finish_reason="length", co wskazuje, że generacja przekroczyła max_tokens lub konwersacja przekroczyła maksymalną długość kontekstu.	Nr
Temperatury	Numer	Jaka temperatura próbkowania ma być używana z zakresu od 0 do 2. Wyższe wartości, takie jak 0,8, sprawią, że dane wyjściowe będą bardziej losowe, a niższe wartości, takie jak 0,2, sprawią, że będzie bardziej skoncentrowany i deterministyczny.	Nr	1
tool_resources	obiekt	Zestaw zasobów używanych przez narzędzia asystenta. Zasoby są specyficzne dla typu narzędzia. Na przykład code_interpreter narzędzie wymaga listy identyfikatorów plików, a file_search narzędzie wymaga listy identyfikatorów magazynów wektorów.	Nr
└code_interpreter	obiekt		Nr
└file_ids	macierz	Zastępuje listę identyfikatorów plików udostępnionych narzędziu code_interpreter . Może istnieć maksymalnie 20 plików skojarzonych z narzędziem.	Nr	[]
└file_search	obiekt		Nr
└vector_store_ids	macierz	Zastępuje magazyn wektorów dołączony do tego asystenta. Może istnieć maksymalnie 1 magazyn wektorów dołączony do asystenta.	Nr
Narzędzia	macierz	Lista narzędzi włączona w asystencie. Może istnieć maksymalnie 128 narzędzi na asystenta. Narzędzia mogą być typami code_interpreter, retrievallub function.	Nr	[]
top_p	Numer	Alternatywą dla próbkowania z temperaturą, nazywaną próbkowaniem jądra, gdzie model uwzględnia wyniki tokenów z top_p masą prawdopodobieństwa. Dlatego 0,1 oznacza, że uwzględniane są tylko tokeny składające się z 10 pierwszych% masy prawdopodobieństwa. Ogólnie zalecamy zmianę tej wartości lub temperatury, ale nie obu.	Nr	1

Odpowiedzi

Kod stanu: 200

Opis: OK

Typ zawartości	Typu	Opis
application/json	assistantObject

Przykłady

Przykład

Modyfikuje asystenta.

POST https://{endpoint}/openai/assistants/{assistant_id}?api-version=2025-04-01-preview

{
 "instructions": "You are an HR bot, and you have access to files to answer employee questions about company policies. Always response with info from either of the files.",
 "tools": [
  {
   "type": "file_search"
  }
 ],
 "model": "gpt-4-turbo"
}

Odpowiedzi: Kod stanu: 200

{
  "body": {
    "id": "asst_123",
    "object": "assistant",
    "created_at": 1699009709,
    "name": "HR Helper",
    "description": null,
    "model": "gpt-4-turbo",
    "instructions": "You are an HR bot, and you have access to files to answer employee questions about company policies. Always response with info from either of the files.",
    "tools": [
      {
        "type": "file_search"
      }
    ],
    "tool_resources": {
      "file_search": {
        "vector_store_ids": []
      }
    },
    "metadata": {},
    "top_p": 1.0,
    "temperature": 1.0,
    "response_format": "auto"
  }
}

Usuwanie — Asystent

DELETE https://{endpoint}/openai/assistants/{assistant_id}?api-version=2025-04-01-preview

Usuń asystenta.

Parametry identyfikatora URI

Nazwa	Cala	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	adres URL ciągu	Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, na przykład: https://aoairesource.openai.azure.com. Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI. https://{nazwa_zasobu}.openai.azure.com
assistant_id	ścieżka	Tak	ciąg	Identyfikator asystenta do usunięcia.
wersja interfejsu API	kwerenda	Tak	ciąg

Nagłówek żądania

Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.

Nazwa	Wymagane	Typ	Opis
Autoryzacji	True	ciąg	Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize Zakres: https://ai.azure.com/.default
api-key	True	ciąg	Tutaj podaj klucz interfejsu API usługi Azure OpenAI

Odpowiedzi

Kod stanu: 200

Opis: OK

Typ zawartości	Typu	Opis
application/json	deleteAssistantResponse

Przykłady

Przykład

Usuwa asystenta.

DELETE https://{endpoint}/openai/assistants/{assistant_id}?api-version=2025-04-01-preview

Odpowiedzi: Kod stanu: 200

{
  "body": {
    "id": "asst_4nsG2qgNzimRPE7MazXTXbU7",
    "object": "assistant.deleted",
    "deleted": true
  }
}

Tworzenie — wątek

Uwaga

Interfejs API Asystentów jest przestarzały i zostanie wycofany 26 sierpnia 2026 r. Użyj ogólnie dostępnej usługi Microsoft Foundry Agents. Postępuj zgodnie z przewodnikiem migracji , aby zaktualizować obciążenia. Dowiedz się więcej.

POST https://{endpoint}/openai/threads?api-version=2025-04-01-preview

Utwórz wątek.

Parametry identyfikatora URI

Nazwa	Cala	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	adres URL ciągu	Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, na przykład: https://aoairesource.openai.azure.com. Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI. https://{nazwa_zasobu}.openai.azure.com
wersja interfejsu API	kwerenda	Tak	ciąg

Nagłówek żądania

Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.

Nazwa	Wymagane	Typ	Opis
Autoryzacji	True	ciąg	Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize Zakres: https://ai.azure.com/.default
api-key	True	ciąg	Tutaj podaj klucz interfejsu API usługi Azure OpenAI

Treść żądania

Typ zawartości: application/json

Nazwa	Typ	Opis	Wymagane	Domyślny
Wiadomości	macierz	Lista komunikatów, z których chcesz rozpocząć wątek.	Nr
metadane	obiekt	Zestaw 16 par klucz-wartość, które można dołączyć do obiektu. Może to być przydatne do przechowywania dodatkowych informacji o obiekcie w formacie ustrukturyzowanym. Klucze mogą mieć długość maksymalnie 64 znaków, a wartości mogą mieć długość maksymalnie 512 znaków.	Nr
tool_resources	obiekt	Zestaw zasobów udostępnianych narzędziom asystenta w tym wątku. Zasoby są specyficzne dla typu narzędzia. Na przykład code_interpreter narzędzie wymaga listy identyfikatorów plików, a file_search narzędzie wymaga listy identyfikatorów magazynów wektorów.	Nr
└code_interpreter	obiekt		Nr
└file_ids	macierz	Lista identyfikatorów plików udostępnionych narzędziu code_interpreter . Może istnieć maksymalnie 20 plików skojarzonych z narzędziem.	Nr	[]
└file_search	obiekt		Nr
└vector_store_ids	macierz	Magazyn wektorów dołączony do tego wątku. Może istnieć maksymalnie 1 magazyn wektorów dołączony do wątku.	Nr
└vector_stores	macierz	Pomocnik do tworzenia magazynu wektorów z file_ids i dołączania go do tego wątku. Może istnieć maksymalnie 1 magazyn wektorów dołączony do wątku.	Nr

Odpowiedzi

Kod stanu: 200

Opis: OK

Typ zawartości	Typu	Opis
application/json	threadObject

Przykłady

Przykład

Tworzy wątek.

POST https://{endpoint}/openai/threads?api-version=2025-04-01-preview

Odpowiedzi: Kod stanu: 200

{
  "body": {
    "id": "thread_v7V4csrNOxtNmgcwGg496Smx",
    "object": "thread",
    "created_at": 1707297136,
    "metadata": {}
  }
}

Pobierz — wątek

GET https://{endpoint}/openai/threads/{thread_id}?api-version=2025-04-01-preview

Pobiera wątek.

Parametry identyfikatora URI

Nazwa	Cala	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	adres URL ciągu	Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, na przykład: https://aoairesource.openai.azure.com. Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI. https://{nazwa_zasobu}.openai.azure.com
thread_id	ścieżka	Tak	ciąg	Identyfikator wątku do pobrania.
wersja interfejsu API	kwerenda	Tak	ciąg

Nagłówek żądania

Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.

Nazwa	Wymagane	Typ	Opis
Autoryzacji	True	ciąg	Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize Zakres: https://ai.azure.com/.default
api-key	True	ciąg	Tutaj podaj klucz interfejsu API usługi Azure OpenAI

Odpowiedzi

Kod stanu: 200

Opis: OK

Typ zawartości	Typu	Opis
application/json	threadObject

Przykłady

Przykład

Pobiera wątek.

GET https://{endpoint}/openai/threads/{thread_id}?api-version=2025-04-01-preview

Odpowiedzi: Kod stanu: 200

{
  "body": {
    "id": "thread_v7V4csrNOxtNmgcwGg496Smx",
    "object": "thread",
    "created_at": 1707297136,
    "metadata": {},
    "tool_resources": {
      "code_interpreter": {
        "file_ids": []
      }
    }
  }
}

Modyfikuj — wątek

POST https://{endpoint}/openai/threads/{thread_id}?api-version=2025-04-01-preview

Modyfikuje wątek.

Parametry identyfikatora URI

Nazwa	Cala	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	adres URL ciągu	Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, na przykład: https://aoairesource.openai.azure.com. Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI. https://{nazwa_zasobu}.openai.azure.com
thread_id	ścieżka	Tak	ciąg	Identyfikator wątku do zmodyfikowania. Można modyfikować tylko te metadata ć.
wersja interfejsu API	kwerenda	Tak	ciąg

Nagłówek żądania

Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.

Nazwa	Wymagane	Typ	Opis
Autoryzacji	True	ciąg	Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize Zakres: https://ai.azure.com/.default
api-key	True	ciąg	Tutaj podaj klucz interfejsu API usługi Azure OpenAI

Treść żądania

Typ zawartości: application/json

Nazwa	Typ	Opis	Wymagane	Domyślny
metadane	obiekt	Zestaw 16 par klucz-wartość, które można dołączyć do obiektu. Może to być przydatne do przechowywania dodatkowych informacji o obiekcie w formacie ustrukturyzowanym. Klucze mogą mieć długość maksymalnie 64 znaków, a wartości mogą mieć długość maksymalnie 512 znaków.	Nr
tool_resources	obiekt	Zestaw zasobów udostępnianych narzędziom asystenta w tym wątku. Zasoby są specyficzne dla typu narzędzia. Na przykład code_interpreter narzędzie wymaga listy identyfikatorów plików, a file_search narzędzie wymaga listy identyfikatorów magazynów wektorów.	Nr
└code_interpreter	obiekt		Nr
└file_ids	macierz	Lista identyfikatorów plików udostępnionych narzędziu code_interpreter . Może istnieć maksymalnie 20 plików skojarzonych z narzędziem.	Nr	[]
└file_search	obiekt		Nr
└vector_store_ids	macierz	Magazyn wektorów dołączony do tego wątku. Może istnieć maksymalnie 1 magazyn wektorów dołączony do wątku.	Nr

Odpowiedzi

Kod stanu: 200

Opis: OK

Typ zawartości	Typu	Opis
application/json	threadObject

Przykłady

Przykład

Modyfikuje wątek.

POST https://{endpoint}/openai/threads/{thread_id}?api-version=2025-04-01-preview

{
 "metadata": {
  "modified": "true",
  "user": "abc123"
 }
}

Odpowiedzi: Kod stanu: 200

{
  "body": {
    "id": "thread_v7V4csrNOxtNmgcwGg496Smx",
    "object": "thread",
    "created_at": 1707297136,
    "metadata": {
      "modified": "true",
      "user": "abc123"
    },
    "tool_resources": {}
  }
}

Usuwanie — wątek

DELETE https://{endpoint}/openai/threads/{thread_id}?api-version=2025-04-01-preview

Usuń wątek.

Parametry identyfikatora URI

Nazwa	Cala	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	adres URL ciągu	Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, na przykład: https://aoairesource.openai.azure.com. Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI. https://{nazwa_zasobu}.openai.azure.com
thread_id	ścieżka	Tak	ciąg	Identyfikator wątku do usunięcia.
wersja interfejsu API	kwerenda	Tak	ciąg

Nagłówek żądania

Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.

Nazwa	Wymagane	Typ	Opis
Autoryzacji	True	ciąg	Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize Zakres: https://ai.azure.com/.default
api-key	True	ciąg	Tutaj podaj klucz interfejsu API usługi Azure OpenAI

Odpowiedzi

Kod stanu: 200

Opis: OK

Typ zawartości	Typu	Opis
application/json	deleteThreadResponse

Przykłady

Przykład

Usuwa wątek.

DELETE https://{endpoint}/openai/threads/{thread_id}?api-version=2025-04-01-preview

Odpowiedzi: Kod stanu: 200

{
  "body": {
    "id": "thread_v7V4csrNOxtNmgcwGg496Smx",
    "object": "thread.deleted",
    "deleted": true
  }
}

Lista — komunikaty

Uwaga

Interfejs API Asystentów jest przestarzały i zostanie wycofany 26 sierpnia 2026 r. Użyj ogólnie dostępnej usługi Microsoft Foundry Agents. Postępuj zgodnie z przewodnikiem migracji , aby zaktualizować obciążenia. Dowiedz się więcej.

GET https://{endpoint}/openai/threads/{thread_id}/messages?api-version=2025-04-01-preview

Zwraca listę komunikatów dla danego wątku.

Parametry identyfikatora URI

Nazwa	Cala	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	adres URL ciągu	Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, na przykład: https://aoairesource.openai.azure.com. Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI. https://{nazwa_zasobu}.openai.azure.com
thread_id	ścieżka	Tak	ciąg	Identyfikator wątków, do których należą komunikaty.
Limit	kwerenda	Nr	liczba całkowita	Limit liczby zwracanych obiektów. Limit może mieścić się w zakresie od 1 do 100, a wartość domyślna to 20.
porządek	kwerenda	Nr	ciąg Możliwe wartości: asc, desc	Sortuj kolejność według znacznika created_at czasu obiektów. asc w przypadku kolejności rosnącej i desc kolejności malejącej.
Po	kwerenda	Nr	ciąg	Kursor do użycia w stronicowaniu. after jest identyfikatorem obiektu definiującym miejsce na liście. Jeśli na przykład wykonasz żądanie listy i otrzymasz 100 obiektów, kończąc się obj_foo, kolejne wywołanie może obejmować polecenie after=obj_foo w celu pobrania następnej strony listy.
Przed	kwerenda	Nr	ciąg	Kursor do użycia w stronicowaniu. before jest identyfikatorem obiektu definiującym miejsce na liście. Jeśli na przykład wykonasz żądanie listy i otrzymasz 100 obiektów, począwszy od obj_foo, kolejne wywołanie może zawierać wartość before=obj_foo w celu pobrania poprzedniej strony listy.
run_id	kwerenda	Nr	ciąg	Filtruj komunikaty według identyfikatora przebiegu, który je wygenerował.
wersja interfejsu API	kwerenda	Tak	ciąg

Nagłówek żądania

Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.

Nazwa	Wymagane	Typ	Opis
Autoryzacji	True	ciąg	Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize Zakres: https://ai.azure.com/.default
api-key	True	ciąg	Tutaj podaj klucz interfejsu API usługi Azure OpenAI

Odpowiedzi

Kod stanu: 200

Opis: OK

Typ zawartości	Typu	Opis
application/json	listMessagesResponse

Przykłady

Przykład

Wyświetlanie listy komunikatów

GET https://{endpoint}/openai/threads/{thread_id}/messages?api-version=2025-04-01-preview

Odpowiedzi: Kod stanu: 200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "msg_abc123",
        "object": "thread.message",
        "created_at": 1699016383,
        "assistant_id": null,
        "thread_id": "thread_abc123",
        "run_id": null,
        "role": "user",
        "content": [
          {
            "type": "text",
            "text": {
              "value": "How does AI work? Explain it in simple terms.",
              "annotations": []
            }
          }
        ],
        "attachments": [],
        "metadata": {}
      },
      {
        "id": "msg_abc456",
        "object": "thread.message",
        "created_at": 1699016383,
        "assistant_id": null,
        "thread_id": "thread_abc123",
        "run_id": null,
        "role": "user",
        "content": [
          {
            "type": "text",
            "text": {
              "value": "Hello, what is AI?",
              "annotations": []
            }
          }
        ],
        "attachments": [],
        "metadata": {}
      }
    ],
    "first_id": "msg_abc123",
    "last_id": "msg_abc456",
    "has_more": false
  }
}

Tworzenie — komunikat

POST https://{endpoint}/openai/threads/{thread_id}/messages?api-version=2025-04-01-preview

Utwórz komunikat.

Parametry identyfikatora URI

Nazwa	Cala	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	adres URL ciągu	Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, na przykład: https://aoairesource.openai.azure.com. Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI. https://{nazwa_zasobu}.openai.azure.com
thread_id	ścieżka	Tak	ciąg	Identyfikator wątków do utworzenia komunikatu.
wersja interfejsu API	kwerenda	Tak	ciąg

Nagłówek żądania

Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.

Nazwa	Wymagane	Typ	Opis
Autoryzacji	True	ciąg	Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize Zakres: https://ai.azure.com/.default
api-key	True	ciąg	Tutaj podaj klucz interfejsu API usługi Azure OpenAI

Treść żądania

Typ zawartości: application/json

Nazwa	Typ	Opis	Wymagane	Domyślny
Załączniki	macierz	Lista plików dołączonych do wiadomości oraz narzędzia, do których należy je dodać.	Nr
zawartość	ciąg	Zawartość wiadomości.	Tak
metadane	obiekt	Zestaw 16 par klucz-wartość, które można dołączyć do obiektu. Może to być przydatne do przechowywania dodatkowych informacji o obiekcie w formacie ustrukturyzowanym. Klucze mogą mieć długość maksymalnie 64 znaków, a wartości mogą mieć długość maksymalnie 512 znaków.	Nr
rola	ciąg	Rola jednostki tworzącej komunikat. Dozwolone wartości obejmują: - user: wskazuje, że komunikat jest wysyłany przez rzeczywistego użytkownika i powinien być używany w większości przypadków do reprezentowania komunikatów generowanych przez użytkownika. - assistant: wskazuje, że komunikat jest generowany przez asystenta. Użyj tej wartości, aby wstawić wiadomości z asystenta do konwersacji.	Tak

Odpowiedzi

Kod stanu: 200

Opis: OK

Typ zawartości	Typu	Opis
application/json	messageObject

Przykłady

Przykład

Utwórz komunikat.

POST https://{endpoint}/openai/threads/{thread_id}/messages?api-version=2025-04-01-preview

{
 "role": "user",
 "content": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces."
}

Odpowiedzi: Kod stanu: 200

{
  "body": {
    "id": "msg_as3XIk1tpVP3hdHjWBGg3uG4",
    "object": "thread.message",
    "created_at": 1707298421,
    "assistant_id": null,
    "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx",
    "run_id": null,
    "role": "user",
    "content": [
      {
        "type": "text",
        "text": {
          "value": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces.",
          "annotations": []
        }
      }
    ],
    "attachments": [],
    "metadata": {}
  }
}

Pobierz — komunikat

GET https://{endpoint}/openai/threads/{thread_id}/messages/{message_id}?api-version=2025-04-01-preview

Pobieranie komunikatu.

Parametry identyfikatora URI

Nazwa	Cala	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	adres URL ciągu	Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, na przykład: https://aoairesource.openai.azure.com. Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI. https://{nazwa_zasobu}.openai.azure.com
thread_id	ścieżka	Tak	ciąg	Identyfikator wątków, do których należy ten komunikat.
Message_id	ścieżka	Tak	ciąg	Identyfikator wiadomości do pobrania.
wersja interfejsu API	kwerenda	Tak	ciąg

Nagłówek żądania

Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.

Nazwa	Wymagane	Typ	Opis
Autoryzacji	True	ciąg	Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize Zakres: https://ai.azure.com/.default
api-key	True	ciąg	Tutaj podaj klucz interfejsu API usługi Azure OpenAI

Odpowiedzi

Kod stanu: 200

Opis: OK

Typ zawartości	Typu	Opis
application/json	messageObject

Przykłady

Przykład

Pobieranie komunikatu.

GET https://{endpoint}/openai/threads/{thread_id}/messages/{message_id}?api-version=2025-04-01-preview

Odpowiedzi: Kod stanu: 200

{
  "body": {
    "id": "msg_as3XIk1tpVP3hdHjWBGg3uG4",
    "object": "thread.message",
    "created_at": 1707298421,
    "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx",
    "role": "user",
    "content": [
      {
        "type": "text",
        "text": {
          "value": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces.",
          "annotations": []
        }
      }
    ],
    "file_ids": [],
    "assistant_id": null,
    "run_id": null,
    "metadata": {}
  }
}

Modyfikuj — komunikat

POST https://{endpoint}/openai/threads/{thread_id}/messages/{message_id}?api-version=2025-04-01-preview

Modyfikuje komunikat.

Parametry identyfikatora URI

Nazwa	Cala	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	adres URL ciągu	Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, na przykład: https://aoairesource.openai.azure.com. Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI. https://{nazwa_zasobu}.openai.azure.com
thread_id	ścieżka	Tak	ciąg	Identyfikator wątku, do którego należy ten komunikat.
Message_id	ścieżka	Tak	ciąg	Identyfikator wiadomości do zmodyfikowania.
wersja interfejsu API	kwerenda	Tak	ciąg

Nagłówek żądania

Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.

Nazwa	Wymagane	Typ	Opis
Autoryzacji	True	ciąg	Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize Zakres: https://ai.azure.com/.default
api-key	True	ciąg	Tutaj podaj klucz interfejsu API usługi Azure OpenAI

Treść żądania

Typ zawartości: application/json

Nazwa	Typ	Opis	Wymagane	Domyślny
metadane	obiekt	Zestaw 16 par klucz-wartość, które można dołączyć do obiektu. Może to być przydatne do przechowywania dodatkowych informacji o obiekcie w formacie ustrukturyzowanym. Klucze mogą mieć długość maksymalnie 64 znaków, a wartości mogą mieć długość maksymalnie 512 znaków.	Nr

Odpowiedzi

Kod stanu: 200

Opis: OK

Typ zawartości	Typu	Opis
application/json	messageObject

Przykłady

Przykład

Zmodyfikuj komunikat.

POST https://{endpoint}/openai/threads/{thread_id}/messages/{message_id}?api-version=2025-04-01-preview

{
 "metadata": {
  "modified": "true",
  "user": "abc123"
 }
}

Odpowiedzi: Kod stanu: 200

{
  "body": {
    "id": "msg_abc123",
    "object": "thread.message",
    "created_at": 1699017614,
    "assistant_id": null,
    "thread_id": "thread_abc123",
    "run_id": null,
    "role": "user",
    "content": [
      {
        "type": "text",
        "text": {
          "value": "How does AI work? Explain it in simple terms.",
          "annotations": []
        }
      }
    ],
    "file_ids": [],
    "metadata": {
      "modified": "true",
      "user": "abc123"
    }
  }
}

Tworzenie — wątek i uruchamianie

Uwaga

Interfejs API Asystentów jest przestarzały i zostanie wycofany 26 sierpnia 2026 r. Użyj ogólnie dostępnej usługi Microsoft Foundry Agents. Postępuj zgodnie z przewodnikiem migracji , aby zaktualizować obciążenia. Dowiedz się więcej.

POST https://{endpoint}/openai/threads/runs?api-version=2025-04-01-preview

Utwórz wątek i uruchom go w jednym żądaniu.

Parametry identyfikatora URI

Nazwa	Cala	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	adres URL ciągu	Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, na przykład: https://aoairesource.openai.azure.com. Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI. https://{nazwa_zasobu}.openai.azure.com
wersja interfejsu API	kwerenda	Tak	ciąg

Nagłówek żądania

Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.

Nazwa	Wymagane	Typ	Opis
Autoryzacji	True	ciąg	Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize Zakres: https://ai.azure.com/.default
api-key	True	ciąg	Tutaj podaj klucz interfejsu API usługi Azure OpenAI

Treść żądania

Typ zawartości: application/json

Nazwa	Typ	Opis	Wymagane	Domyślny
assistant_id	ciąg	Identyfikator asystenta do wykonania tego przebiegu.	Tak
Instrukcje	ciąg	Zastąpi domyślny komunikat systemowy asystenta. Jest to przydatne w przypadku modyfikowania zachowania dla poszczególnych przebiegów.	Nr
max_completion_tokens	liczba całkowita	Maksymalna liczba tokenów ukończenia, które mogą być używane w trakcie przebiegu. Przebieg najlepiej sprawdza się, jak używać tylko określonej liczby tokenów ukończenia w wielu zakrętach przebiegu. Jeśli przebieg przekroczy określoną liczbę tokenów ukończenia, przebieg zakończy się stanem incomplete. Zobacz incomplete_details , aby uzyskać więcej informacji.	Nr
max_prompt_tokens	liczba całkowita	Maksymalna liczba tokenów monitów, które mogą być używane w trakcie przebiegu. Przebieg najlepiej sprawdza się, jak używać tylko określonej liczby tokenów monitu w wielu zakrętach przebiegu. Jeśli przebieg przekroczy określoną liczbę tokenów monitu, przebieg zakończy się stanem incomplete. Zobacz incomplete_details , aby uzyskać więcej informacji.	Nr
metadane	obiekt	Zestaw 16 par klucz-wartość, które można dołączyć do obiektu. Może to być przydatne do przechowywania dodatkowych informacji o obiekcie w formacie ustrukturyzowanym. Klucze mogą mieć długość maksymalnie 64 znaków, a wartości mogą mieć długość maksymalnie 512 znaków.	Nr
model	ciąg	Identyfikator modeli, które mają być używane do wykonania tego przebiegu. Jeśli w tym miejscu zostanie podana wartość, zastąpi ona model skojarzony z asystentem. Jeśli nie, zostanie użyty model skojarzony z asystentem.	Nr
parallel_tool_calls	ParallelToolCalls	Czy włączyć równoległe wywoływanie funkcji podczas używania narzędzia.	Nr	True
response_format	assistantsApiResponseFormatOption	Określa format, który model musi wyświetlić. Zgodność z GPT-4o, GPT-4 Turbo i wszystkimi modelami GPT-3.5 Turbo od gpt-3.5-turbo-1106. Ustawienie umożliwia { "type": "json_schema", "json_schema": {...} } włączenie danych wyjściowych ze strukturą, które zapewniają, że model jest zgodny z podanym schematem JSON. Dowiedz się więcej w przewodniku Dotyczącym danych wyjściowych ze strukturą. Ustawienie w celu { "type": "json_object" } włączenia trybu JSON, co gwarantuje, że komunikat generowany przez model jest prawidłowym kodem JSON. Ważne: w przypadku korzystania z trybu JSON należy również poinstruować model, aby samodzielnie wygenerował kod JSON za pośrednictwem komunikatu systemowego lub użytkownika. Bez tego model może wygenerować niekończący się strumień białych znaków, dopóki generowanie nie osiągnie limitu tokenu, co spowoduje długotrwałe i pozornie "zablokowane" żądanie. Należy również zauważyć, że zawartość wiadomości może być częściowo odcięta, jeśli finish_reason="length", co wskazuje, że generacja przekroczyła max_tokens lub konwersacja przekroczyła maksymalną długość kontekstu.	Nr
odtwarzać strumieniowo	Boolean	Jeśli trueprogram zwraca strumień zdarzeń, które występują podczas zdarzeń Uruchom jako serwer, kończy się po wprowadzeniu stanu terminalu z komunikatem data: [DONE] .	Nr
stream_options	chatCompletionStreamOptions	Opcje odpowiedzi przesyłania strumieniowego. Ustaw tę wartość tylko po ustawieniu .stream: true	Nr	Brak
Temperatury	Numer	Jaka temperatura próbkowania ma być używana z zakresu od 0 do 2. Wyższe wartości, takie jak 0,8, sprawią, że dane wyjściowe będą bardziej losowe, a niższe wartości, takie jak 0,2, sprawią, że będzie bardziej skoncentrowany i deterministyczny.	Nr	1
konwersacja	createThreadRequest		Nr
tool_choice	assistantsApiToolChoiceOption	Określa, które narzędzie (jeśli istnieje) jest wywoływane przez model. none oznacza, że model nie wywołuje żadnych narzędzi, a zamiast tego generuje komunikat. auto jest wartością domyślną i oznacza, że model może wybierać między generowaniem komunikatu lub wywoływaniem narzędzia. Określenie określonego narzędzia, takiego jak {"type": "file_search"} lub {"type": "function", "function": {"name": "my_function"}} wymusza wywołanie tego narzędzia przez model.	Nr
tool_resources	obiekt	Zestaw zasobów używanych przez narzędzia asystenta. Zasoby są specyficzne dla typu narzędzia. Na przykład code_interpreter narzędzie wymaga listy identyfikatorów plików, a file_search narzędzie wymaga listy identyfikatorów magazynów wektorów.	Nr
└code_interpreter	obiekt		Nr
└file_ids	macierz	Lista identyfikatorów plików udostępnionych narzędziu code_interpreter . Może istnieć maksymalnie 20 plików skojarzonych z narzędziem.	Nr	[]
└file_search	obiekt		Nr
└vector_store_ids	macierz	Identyfikator magazynu wektorów dołączony do tego asystenta. Może istnieć maksymalnie 1 magazyn wektorów dołączony do asystenta.	Nr
Narzędzia	macierz	Zastąpić narzędzia, których asystent może użyć na potrzeby tego przebiegu. Jest to przydatne w przypadku modyfikowania zachowania dla poszczególnych przebiegów.	Nr
top_p	Numer	Alternatywą dla próbkowania z temperaturą, nazywaną próbkowaniem jądra, gdzie model uwzględnia wyniki tokenów z top_p masą prawdopodobieństwa. Dlatego 0,1 oznacza, że uwzględniane są tylko tokeny składające się z 10 pierwszych% masy prawdopodobieństwa. Ogólnie zalecamy zmianę tej wartości lub temperatury, ale nie obu.	Nr	1
truncation_strategy	obcięcie obiektuObject	Określa sposób obcinania wątku przed uruchomieniem. Służy do kontrolowania początkowego okna kontekstu przebiegu.	Nr

Odpowiedzi

Kod stanu: 200

Opis: OK

Typ zawartości	Typu	Opis
application/json	runObject

Przykłady

Przykład

Utwórz wątek i uruchom go w jednym żądaniu.

POST https://{endpoint}/openai/threads/runs?api-version=2025-04-01-preview

{
 "assistant_id": "asst_abc123",
 "thread": {
  "messages": [
   {
    "role": "user",
    "content": "Explain deep learning to a 5 year old."
   }
  ]
 }
}

Odpowiedzi: Kod stanu: 200

{
  "body": {
    "id": "run_abc123",
    "object": "thread.run",
    "created_at": 1699076792,
    "assistant_id": "asst_abc123",
    "thread_id": "thread_abc123",
    "status": "queued",
    "started_at": null,
    "expires_at": 1699077392,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": null,
    "required_action": null,
    "last_error": null,
    "model": "gpt-4-turbo",
    "instructions": "You are a helpful assistant.",
    "tools": [],
    "tool_resources": {},
    "metadata": {},
    "temperature": 1.0,
    "top_p": 1.0,
    "max_completion_tokens": null,
    "max_prompt_tokens": null,
    "truncation_strategy": {
      "type": "auto",
      "last_messages": null
    },
    "incomplete_details": null,
    "usage": null,
    "response_format": "auto",
    "tool_choice": "auto"
  }
}

Lista — uruchomienia

GET https://{endpoint}/openai/threads/{thread_id}/runs?api-version=2025-04-01-preview

Zwraca listę przebiegów należących do wątku.

Parametry identyfikatora URI

Nazwa	Cala	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	adres URL ciągu	Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, na przykład: https://aoairesource.openai.azure.com. Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI. https://{nazwa_zasobu}.openai.azure.com
thread_id	ścieżka	Tak	ciąg	Identyfikator wątku, do którego należy przebieg.
Limit	kwerenda	Nr	liczba całkowita	Limit liczby zwracanych obiektów. Limit może mieścić się w zakresie od 1 do 100, a wartość domyślna to 20.
porządek	kwerenda	Nr	ciąg Możliwe wartości: asc, desc	Sortuj kolejność według znacznika created_at czasu obiektów. asc w przypadku kolejności rosnącej i desc kolejności malejącej.
Po	kwerenda	Nr	ciąg	Kursor do użycia w stronicowaniu. after jest identyfikatorem obiektu definiującym miejsce na liście. Jeśli na przykład wykonasz żądanie listy i otrzymasz 100 obiektów, kończąc się obj_foo, kolejne wywołanie może obejmować polecenie after=obj_foo w celu pobrania następnej strony listy.
Przed	kwerenda	Nr	ciąg	Kursor do użycia w stronicowaniu. before jest identyfikatorem obiektu definiującym miejsce na liście. Jeśli na przykład wykonasz żądanie listy i otrzymasz 100 obiektów, począwszy od obj_foo, kolejne wywołanie może zawierać wartość before=obj_foo w celu pobrania poprzedniej strony listy.
wersja interfejsu API	kwerenda	Tak	ciąg

Nagłówek żądania

Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.

Nazwa	Wymagane	Typ	Opis
Autoryzacji	True	ciąg	Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize Zakres: https://ai.azure.com/.default
api-key	True	ciąg	Tutaj podaj klucz interfejsu API usługi Azure OpenAI

Odpowiedzi

Kod stanu: 200

Opis: OK

Typ zawartości	Typu	Opis
application/json	listRunsResponse

Przykłady

Przykład

Zwraca listę przebiegów należących do wątku.

GET https://{endpoint}/openai/threads/{thread_id}/runs?api-version=2025-04-01-preview

Odpowiedzi: Kod stanu: 200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "run_abc123",
        "object": "thread.run",
        "created_at": 1699075072,
        "assistant_id": "asst_abc123",
        "thread_id": "thread_abc123",
        "status": "completed",
        "started_at": 1699075072,
        "expires_at": null,
        "cancelled_at": null,
        "failed_at": null,
        "completed_at": 1699075073,
        "last_error": null,
        "model": "gpt-4-turbo",
        "instructions": null,
        "incomplete_details": null,
        "tools": [
          {
            "type": "code_interpreter"
          }
        ],
        "tool_resources": {
          "code_interpreter": {
            "file_ids": [
              "file-abc123",
              "file-abc456"
            ]
          }
        },
        "metadata": {},
        "usage": {
          "prompt_tokens": 123,
          "completion_tokens": 456,
          "total_tokens": 579
        },
        "temperature": 1.0,
        "top_p": 1.0,
        "max_prompt_tokens": 1000,
        "max_completion_tokens": 1000,
        "truncation_strategy": {
          "type": "auto",
          "last_messages": null
        },
        "response_format": "auto",
        "tool_choice": "auto"
      },
      {
        "id": "run_abc456",
        "object": "thread.run",
        "created_at": 1699063290,
        "assistant_id": "asst_abc123",
        "thread_id": "thread_abc123",
        "status": "completed",
        "started_at": 1699063290,
        "expires_at": null,
        "cancelled_at": null,
        "failed_at": null,
        "completed_at": 1699063291,
        "last_error": null,
        "model": "gpt-4-turbo",
        "instructions": null,
        "incomplete_details": null,
        "tools": [
          {
            "type": "code_interpreter"
          }
        ],
        "tool_resources": {
          "code_interpreter": {
            "file_ids": [
              "file-abc123",
              "file-abc456"
            ]
          }
        },
        "metadata": {},
        "usage": {
          "prompt_tokens": 123,
          "completion_tokens": 456,
          "total_tokens": 579
        },
        "temperature": 1.0,
        "top_p": 1.0,
        "max_prompt_tokens": 1000,
        "max_completion_tokens": 1000,
        "truncation_strategy": {
          "type": "auto",
          "last_messages": null
        },
        "response_format": "auto",
        "tool_choice": "auto"
      }
    ],
    "first_id": "run_abc123",
    "last_id": "run_abc456",
    "has_more": false
  }
}

Tworzenie — uruchamianie

POST https://{endpoint}/openai/threads/{thread_id}/runs?api-version=2025-04-01-preview

Utwórz przebieg.

Parametry identyfikatora URI

Nazwa	Cala	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	adres URL ciągu	Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, na przykład: https://aoairesource.openai.azure.com. Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI. https://{nazwa_zasobu}.openai.azure.com
thread_id	ścieżka	Tak	ciąg	Identyfikator wątku do uruchomienia.
include[]	kwerenda	Nr	macierz	Lista dodatkowych pól do uwzględnienia w odpowiedzi. Obecnie jedyną obsługiwaną wartością jest step_details.tool_calls[*].file_search.results[*].content pobranie zawartości wyników wyszukiwania pliku.
wersja interfejsu API	kwerenda	Tak	ciąg

Nagłówek żądania

Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.

Nazwa	Wymagane	Typ	Opis
Autoryzacji	True	ciąg	Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize Zakres: https://ai.azure.com/.default
api-key	True	ciąg	Tutaj podaj klucz interfejsu API usługi Azure OpenAI

Treść żądania

Typ zawartości: application/json

Nazwa	Typ	Opis	Wymagane	Domyślny
additional_instructions	ciąg	Dołącza dodatkowe instrukcje na końcu instrukcji dotyczących przebiegu. Jest to przydatne w przypadku modyfikowania zachowania dla poszczególnych przebiegów bez zastępowania innych instrukcji.	Nr
additional_messages	macierz	Dodaje dodatkowe komunikaty do wątku przed utworzeniem przebiegu.	Nr
assistant_id	ciąg	Identyfikator asystenta do wykonania tego przebiegu.	Tak
Instrukcje	ciąg	Zastąpi domyślny komunikat systemowy asystenta. Jest to przydatne w przypadku modyfikowania zachowania dla poszczególnych przebiegów.	Nr
max_completion_tokens	liczba całkowita	Maksymalna liczba tokenów ukończenia, które mogą być używane w trakcie przebiegu. Przebieg najlepiej sprawdza się, jak używać tylko określonej liczby tokenów ukończenia w wielu zakrętach przebiegu. Jeśli przebieg przekroczy określoną liczbę tokenów ukończenia, przebieg zakończy się stanem incomplete. Zobacz incomplete_details , aby uzyskać więcej informacji.	Nr
max_prompt_tokens	liczba całkowita	Maksymalna liczba tokenów monitów, które mogą być używane w trakcie przebiegu. Przebieg najlepiej sprawdza się, jak używać tylko określonej liczby tokenów monitu w wielu zakrętach przebiegu. Jeśli przebieg przekroczy określoną liczbę tokenów monitu, przebieg zakończy się stanem incomplete. Zobacz incomplete_details , aby uzyskać więcej informacji.	Nr
metadane	obiekt	Zestaw 16 par klucz-wartość, które można dołączyć do obiektu. Może to być przydatne do przechowywania dodatkowych informacji o obiekcie w formacie ustrukturyzowanym. Klucze mogą mieć długość maksymalnie 64 znaków, a wartości mogą mieć długość maksymalnie 512 znaków.	Nr
model	ciąg	Identyfikator modelu, który ma być używany do wykonania tego przebiegu. Jeśli w tym miejscu zostanie podana wartość, zastąpi ona model skojarzony z asystentem. Jeśli nie, zostanie użyty model skojarzony z asystentem.	Nr
parallel_tool_calls	ParallelToolCalls	Czy włączyć równoległe wywoływanie funkcji podczas używania narzędzia.	Nr	True
response_format	assistantsApiResponseFormatOption	Określa format, który model musi wyświetlić. Zgodność z GPT-4o, GPT-4 Turbo i wszystkimi modelami GPT-3.5 Turbo od gpt-3.5-turbo-1106. Ustawienie umożliwia { "type": "json_schema", "json_schema": {...} } włączenie danych wyjściowych ze strukturą, które zapewniają, że model jest zgodny z podanym schematem JSON. Dowiedz się więcej w przewodniku Dotyczącym danych wyjściowych ze strukturą. Ustawienie w celu { "type": "json_object" } włączenia trybu JSON, co gwarantuje, że komunikat generowany przez model jest prawidłowym kodem JSON. Ważne: w przypadku korzystania z trybu JSON należy również poinstruować model, aby samodzielnie wygenerował kod JSON za pośrednictwem komunikatu systemowego lub użytkownika. Bez tego model może wygenerować niekończący się strumień białych znaków, dopóki generowanie nie osiągnie limitu tokenu, co spowoduje długotrwałe i pozornie "zablokowane" żądanie. Należy również zauważyć, że zawartość wiadomości może być częściowo odcięta, jeśli finish_reason="length", co wskazuje, że generacja przekroczyła max_tokens lub konwersacja przekroczyła maksymalną długość kontekstu.	Nr
odtwarzać strumieniowo	Boolean	Jeśli trueprogram zwraca strumień zdarzeń, które występują podczas zdarzeń Uruchom jako serwer, kończy się po wprowadzeniu stanu terminalu z komunikatem data: [DONE] .	Nr
Temperatury	Numer	Jaka temperatura próbkowania ma być używana z zakresu od 0 do 2. Wyższe wartości, takie jak 0,8, sprawią, że dane wyjściowe będą bardziej losowe, a niższe wartości, takie jak 0,2, sprawią, że będzie bardziej skoncentrowany i deterministyczny.	Nr	1
tool_choice	assistantsApiToolChoiceOption	Określa, które narzędzie (jeśli istnieje) jest wywoływane przez model. none oznacza, że model nie wywołuje żadnych narzędzi, a zamiast tego generuje komunikat. auto jest wartością domyślną i oznacza, że model może wybierać między generowaniem komunikatu lub wywoływaniem narzędzia. Określenie określonego narzędzia, takiego jak {"type": "file_search"} lub {"type": "function", "function": {"name": "my_function"}} wymusza wywołanie tego narzędzia przez model.	Nr
Narzędzia	macierz	Zastąpić narzędzia, których asystent może użyć na potrzeby tego przebiegu. Jest to przydatne w przypadku modyfikowania zachowania dla poszczególnych przebiegów.	Nr
top_p	Numer	Alternatywą dla próbkowania z temperaturą, nazywaną próbkowaniem jądra, gdzie model uwzględnia wyniki tokenów z top_p masą prawdopodobieństwa. Dlatego 0,1 oznacza, że uwzględniane są tylko tokeny składające się z 10 pierwszych% masy prawdopodobieństwa. Ogólnie zalecamy zmianę tej wartości lub temperatury, ale nie obu.	Nr	1
truncation_strategy	obcięcie obiektuObject	Określa sposób obcinania wątku przed uruchomieniem. Służy do kontrolowania początkowego okna kontekstu przebiegu.	Nr

Odpowiedzi

Kod stanu: 200

Opis: OK

Typ zawartości	Typu	Opis
application/json	runObject

Przykłady

Przykład

Utwórz przebieg.

POST https://{endpoint}/openai/threads/{thread_id}/runs?api-version=2025-04-01-preview

{
 "assistant_id": "asst_abc123"
}

Odpowiedzi: Kod stanu: 200

{
  "body": {
    "id": "run_abc123",
    "object": "thread.run",
    "created_at": 1699063290,
    "assistant_id": "asst_abc123",
    "thread_id": "thread_abc123",
    "status": "queued",
    "started_at": 1699063290,
    "expires_at": null,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": 1699063291,
    "last_error": null,
    "model": "gpt-4-turbo",
    "instructions": null,
    "incomplete_details": null,
    "tools": [
      {
        "type": "code_interpreter"
      }
    ],
    "metadata": {},
    "usage": null,
    "temperature": 1.0,
    "top_p": 1.0,
    "max_prompt_tokens": 1000,
    "max_completion_tokens": 1000,
    "truncation_strategy": {
      "type": "auto",
      "last_messages": null
    },
    "response_format": "auto",
    "tool_choice": "auto"
  }
}

Pobierz — uruchamianie

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}?api-version=2025-04-01-preview

Pobiera przebieg.

Parametry identyfikatora URI

Nazwa	Cala	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	adres URL ciągu	Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, na przykład: https://aoairesource.openai.azure.com. Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI. https://{nazwa_zasobu}.openai.azure.com
thread_id	ścieżka	Tak	ciąg	Identyfikator uruchomionych wątków.
run_id	ścieżka	Tak	ciąg	Identyfikator przebiegu do pobrania.
wersja interfejsu API	kwerenda	Tak	ciąg

Nagłówek żądania

Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.

Nazwa	Wymagane	Typ	Opis
Autoryzacji	True	ciąg	Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize Zakres: https://ai.azure.com/.default
api-key	True	ciąg	Tutaj podaj klucz interfejsu API usługi Azure OpenAI

Odpowiedzi

Kod stanu: 200

Opis: OK

Typ zawartości	Typu	Opis
application/json	runObject

Przykłady

Przykład

Pobiera przebieg.

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}?api-version=2025-04-01-preview

Odpowiedzi: Kod stanu: 200

{
  "body": {
    "id": "run_HsO8tYM4K5AAMAHgK0J3om8Q",
    "object": "thread.run",
    "created_at": 1707303196,
    "assistant_id": "asst_JtTwHk28cIocgFXZPCBxhOzl",
    "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh",
    "status": "completed",
    "started_at": 1707303197,
    "expires_at": null,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": 1707303201,
    "last_error": null,
    "model": "gpt-4-1106-preview",
    "instructions": "You are an AI model that empowers every person and every organization on the planet to achieve more.",
    "tools": [],
    "file_ids": [],
    "metadata": {}
  }
}

Modyfikowanie — uruchamianie

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}?api-version=2025-04-01-preview

Modyfikuje przebieg.

Parametry identyfikatora URI

Nazwa	Cala	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	adres URL ciągu	Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, na przykład: https://aoairesource.openai.azure.com. Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI. https://{nazwa_zasobu}.openai.azure.com
thread_id	ścieżka	Tak	ciąg	Identyfikator uruchomionych wątków.
run_id	ścieżka	Tak	ciąg	Identyfikator przebiegu do zmodyfikowania.
wersja interfejsu API	kwerenda	Tak	ciąg

Nagłówek żądania

Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.

Nazwa	Wymagane	Typ	Opis
Autoryzacji	True	ciąg	Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize Zakres: https://ai.azure.com/.default
api-key	True	ciąg	Tutaj podaj klucz interfejsu API usługi Azure OpenAI

Treść żądania

Typ zawartości: application/json

Nazwa	Typ	Opis	Wymagane	Domyślny
metadane	obiekt	Zestaw 16 par klucz-wartość, które można dołączyć do obiektu. Może to być przydatne do przechowywania dodatkowych informacji o obiekcie w formacie ustrukturyzowanym. Klucze mogą mieć długość maksymalnie 64 znaków, a wartości mogą mieć długość maksymalnie 512 znaków.	Nr

Odpowiedzi

Kod stanu: 200

Opis: OK

Typ zawartości	Typu	Opis
application/json	runObject

Przykłady

Przykład

Modyfikuje przebieg.

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}?api-version=2025-04-01-preview

{
 "metadata": {
  "user_id": "user_abc123"
 }
}

Odpowiedzi: Kod stanu: 200

{
  "body": {
    "id": "run_abc123",
    "object": "thread.run",
    "created_at": 1699075072,
    "assistant_id": "asst_abc123",
    "thread_id": "thread_abc123",
    "status": "completed",
    "started_at": 1699075072,
    "expires_at": null,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": 1699075073,
    "last_error": null,
    "model": "gpt-4-turbo",
    "instructions": null,
    "incomplete_details": null,
    "tools": [
      {
        "type": "code_interpreter"
      }
    ],
    "tool_resources": {
      "code_interpreter": {
        "file_ids": [
          "file-abc123",
          "file-abc456"
        ]
      }
    },
    "metadata": {
      "user_id": "user_abc123"
    },
    "usage": {
      "prompt_tokens": 123,
      "completion_tokens": 456,
      "total_tokens": 579
    },
    "temperature": 1.0,
    "top_p": 1.0,
    "max_prompt_tokens": 1000,
    "max_completion_tokens": 1000,
    "truncation_strategy": {
      "type": "auto",
      "last_messages": null
    },
    "response_format": "auto",
    "tool_choice": "auto"
  }
}

Przesyłanie — dane wyjściowe narzędzia do uruchomienia

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/submit_tool_outputs?api-version=2025-04-01-preview

Gdy przebieg ma status: "requires_action" wartość i required_action.type to submit_tool_outputs, ten punkt końcowy może służyć do przesyłania danych wyjściowych z wywołań narzędzia po ich zakończeniu. Wszystkie dane wyjściowe muszą zostać przesłane w jednym żądaniu.

Parametry identyfikatora URI

Nazwa	Cala	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	adres URL ciągu	Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, na przykład: https://aoairesource.openai.azure.com. Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI. https://{nazwa_zasobu}.openai.azure.com
thread_id	ścieżka	Tak	ciąg	Identyfikator wątków, do których należy ten przebieg.
run_id	ścieżka	Tak	ciąg	Identyfikator przebiegu, który wymaga przesłania danych wyjściowych narzędzia.
wersja interfejsu API	kwerenda	Tak	ciąg

Nagłówek żądania

Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.

Nazwa	Wymagane	Typ	Opis
Autoryzacji	True	ciąg	Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize Zakres: https://ai.azure.com/.default
api-key	True	ciąg	Tutaj podaj klucz interfejsu API usługi Azure OpenAI

Treść żądania

Typ zawartości: application/json

Nazwa	Typ	Opis	Wymagane	Domyślny
odtwarzać strumieniowo	Boolean	Jeśli trueprogram zwraca strumień zdarzeń, które występują podczas zdarzeń Uruchom jako serwer, kończy się po wprowadzeniu stanu terminalu z komunikatem data: [DONE] .	Nr
tool_outputs	macierz	Lista narzędzi, dla których są przesyłane dane wyjściowe.	Tak

Odpowiedzi

Kod stanu: 200

Opis: OK

Typ zawartości	Typu	Opis
application/json	runObject

Przykłady

Przykład

Gdy przebieg ma status: "requires_action" wartość i required_action.type to submit_tool_outputs, ten punkt końcowy może służyć do przesyłania danych wyjściowych z wywołań narzędzia po ich zakończeniu. Wszystkie dane wyjściowe muszą zostać przesłane w jednym żądaniu.

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/submit_tool_outputs?api-version=2025-04-01-preview

{
 "tool_outputs": [
  {
   "tool_call_id": "call_001",
   "output": "70 degrees and sunny."
  }
 ]
}

Odpowiedzi: Kod stanu: 200

{
  "body": {
    "id": "run_123",
    "object": "thread.run",
    "created_at": 1699075592,
    "assistant_id": "asst_123",
    "thread_id": "thread_123",
    "status": "queued",
    "started_at": 1699075592,
    "expires_at": 1699076192,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": null,
    "last_error": null,
    "model": "gpt-4-turbo",
    "instructions": null,
    "tools": [
      {
        "type": "function",
        "function": {
          "name": "get_current_weather",
          "description": "Get the current weather in a given location",
          "parameters": {
            "type": "object",
            "properties": {
              "location": {
                "type": "string",
                "description": "The city and state, e.g. San Francisco, CA"
              },
              "unit": {
                "type": "string",
                "enum": [
                  "celsius",
                  "fahrenheit"
                ]
              }
            },
            "required": [
              "location"
            ]
          }
        }
      }
    ],
    "metadata": {},
    "usage": null,
    "temperature": 1.0,
    "top_p": 1.0,
    "max_prompt_tokens": 1000,
    "max_completion_tokens": 1000,
    "truncation_strategy": {
      "type": "auto",
      "last_messages": null
    },
    "response_format": "auto",
    "tool_choice": "auto"
  }
}

Anulowanie — uruchamianie

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/cancel?api-version=2025-04-01-preview

Anuluje przebieg, który ma wartość in_progress.

Parametry identyfikatora URI

Nazwa	Cala	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	adres URL ciągu	Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, na przykład: https://aoairesource.openai.azure.com. Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI. https://{nazwa_zasobu}.openai.azure.com
thread_id	ścieżka	Tak	ciąg	Identyfikator wątku, do którego należy ten przebieg.
run_id	ścieżka	Tak	ciąg	Identyfikator przebiegu do anulowania.
wersja interfejsu API	kwerenda	Tak	ciąg

Nagłówek żądania

Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.

Nazwa	Wymagane	Typ	Opis
Autoryzacji	True	ciąg	Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize Zakres: https://ai.azure.com/.default
api-key	True	ciąg	Tutaj podaj klucz interfejsu API usługi Azure OpenAI

Odpowiedzi

Kod stanu: 200

Opis: OK

Typ zawartości	Typu	Opis
application/json	runObject

Przykłady

Przykład

Anuluje przebieg, który ma wartość in_progress.

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/cancel?api-version=2025-04-01-preview

Odpowiedzi: Kod stanu: 200

{
  "body": {
    "id": "run_abc123",
    "object": "thread.run",
    "created_at": 1699076126,
    "assistant_id": "asst_abc123",
    "thread_id": "thread_abc123",
    "status": "cancelling",
    "started_at": 1699076126,
    "expires_at": 1699076726,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": null,
    "last_error": null,
    "model": "gpt-4-turbo",
    "instructions": "You summarize books.",
    "tools": [
      {
        "type": "file_search"
      }
    ],
    "tool_resources": {
      "file_search": {
        "vector_store_ids": [
          "vs_123"
        ]
      }
    },
    "metadata": {},
    "usage": null,
    "temperature": 1.0,
    "top_p": 1.0,
    "response_format": "auto"
  }
}

Lista — kroki uruchamiania

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/steps?api-version=2025-04-01-preview

Zwraca listę kroków uruchamiania należących do przebiegu.

Parametry identyfikatora URI

Nazwa	Cala	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	adres URL ciągu	Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, na przykład: https://aoairesource.openai.azure.com. Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI. https://{nazwa_zasobu}.openai.azure.com
thread_id	ścieżka	Tak	ciąg	Identyfikator wątku, do którego należy uruchomienie i kroki uruchamiania.
run_id	ścieżka	Tak	ciąg	Identyfikator przebiegu, do którego należą kroki uruchamiania.
Limit	kwerenda	Nr	liczba całkowita	Limit liczby zwracanych obiektów. Limit może mieścić się w zakresie od 1 do 100, a wartość domyślna to 20.
porządek	kwerenda	Nr	ciąg Możliwe wartości: asc, desc	Sortuj kolejność według znacznika created_at czasu obiektów. asc w przypadku kolejności rosnącej i desc kolejności malejącej.
Po	kwerenda	Nr	ciąg	Kursor do użycia w stronicowaniu. after jest identyfikatorem obiektu definiującym miejsce na liście. Jeśli na przykład wykonasz żądanie listy i otrzymasz 100 obiektów, kończąc się obj_foo, kolejne wywołanie może obejmować polecenie after=obj_foo w celu pobrania następnej strony listy.
Przed	kwerenda	Nr	ciąg	Kursor do użycia w stronicowaniu. before jest identyfikatorem obiektu definiującym miejsce na liście. Jeśli na przykład wykonasz żądanie listy i otrzymasz 100 obiektów, począwszy od obj_foo, kolejne wywołanie może zawierać wartość before=obj_foo w celu pobrania poprzedniej strony listy.
wersja interfejsu API	kwerenda	Tak	ciąg
include[]	kwerenda	Nr	macierz	Lista dodatkowych pól do uwzględnienia w odpowiedzi. Obecnie jedyną obsługiwaną wartością jest step_details.tool_calls[*].file_search.results[*].content pobranie zawartości wyników wyszukiwania pliku.

Nagłówek żądania

Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.

Nazwa	Wymagane	Typ	Opis
Autoryzacji	True	ciąg	Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize Zakres: https://ai.azure.com/.default
api-key	True	ciąg	Tutaj podaj klucz interfejsu API usługi Azure OpenAI

Odpowiedzi

Kod stanu: 200

Opis: OK

Typ zawartości	Typu	Opis
application/json	listRunStepsResponse

Przykłady

Przykład

Zwraca listę kroków uruchamiania należących do przebiegu.

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/steps?api-version=2025-04-01-preview

Odpowiedzi: Kod stanu: 200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "step_abc123",
        "object": "thread.run.step",
        "created_at": 1699063291,
        "run_id": "run_abc123",
        "assistant_id": "asst_abc123",
        "thread_id": "thread_abc123",
        "type": "message_creation",
        "status": "completed",
        "cancelled_at": null,
        "completed_at": 1699063291,
        "expired_at": null,
        "failed_at": null,
        "last_error": null,
        "step_details": {
          "type": "message_creation",
          "message_creation": {
            "message_id": "msg_abc123"
          }
        },
        "usage": {
          "prompt_tokens": 123,
          "completion_tokens": 456,
          "total_tokens": 579
        }
      }
    ],
    "first_id": "step_abc123",
    "last_id": "step_abc456",
    "has_more": false
  }
}

Pobieranie — krok uruchamiania

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/steps/{step_id}?api-version=2025-04-01-preview

Pobiera krok uruchomienia.

Parametry identyfikatora URI

Nazwa	Cala	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	adres URL ciągu	Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, na przykład: https://aoairesource.openai.azure.com. Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI. https://{nazwa_zasobu}.openai.azure.com
thread_id	ścieżka	Tak	ciąg	Identyfikator wątku, do którego należy uruchomienie i krok uruchomienia.
run_id	ścieżka	Tak	ciąg	Identyfikator przebiegu, do którego należy krok uruchamiania.
step_id	ścieżka	Tak	ciąg	Identyfikator kroku uruchamiania do pobrania.
include[]	kwerenda	Nr	macierz	Lista dodatkowych pól do uwzględnienia w odpowiedzi. Obecnie jedyną obsługiwaną wartością jest step_details.tool_calls[*].file_search.results[*].content pobranie zawartości wyników wyszukiwania pliku.
wersja interfejsu API	kwerenda	Tak	ciąg

Nagłówek żądania

Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.

Nazwa	Wymagane	Typ	Opis
Autoryzacji	True	ciąg	Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize Zakres: https://ai.azure.com/.default
api-key	True	ciąg	Tutaj podaj klucz interfejsu API usługi Azure OpenAI

Odpowiedzi

Kod stanu: 200

Opis: OK

Typ zawartości	Typu	Opis
application/json	runStepObject

Przykłady

Przykład

Pobiera krok uruchomienia.

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/steps/{step_id}?api-version=2025-04-01-preview

Odpowiedzi: Kod stanu: 200

{
  "body": {
    "id": "step_abc123",
    "object": "thread.run.step",
    "created_at": 1699063291,
    "run_id": "run_abc123",
    "assistant_id": "asst_abc123",
    "thread_id": "thread_abc123",
    "type": "message_creation",
    "status": "completed",
    "cancelled_at": null,
    "completed_at": 1699063291,
    "expired_at": null,
    "failed_at": null,
    "last_error": null,
    "step_details": {
      "type": "message_creation",
      "message_creation": {
        "message_id": "msg_abc123"
      }
    },
    "usage": {
      "prompt_tokens": 123,
      "completion_tokens": 456,
      "total_tokens": 579
    }
  }
}

Lista — magazyny wektorowe

GET https://{endpoint}/openai/vector_stores?api-version=2025-04-01-preview

Zwraca listę magazynów wektorów.

Parametry identyfikatora URI

Nazwa	Cala	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	adres URL ciągu	Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, na przykład: https://aoairesource.openai.azure.com. Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI. https://{nazwa_zasobu}.openai.azure.com
Limit	kwerenda	Nr	liczba całkowita	Limit liczby zwracanych obiektów. Limit może mieścić się w zakresie od 1 do 100, a wartość domyślna to 20.
porządek	kwerenda	Nr	ciąg Możliwe wartości: asc, desc	Sortuj kolejność według znacznika created_at czasu obiektów. asc w przypadku kolejności rosnącej i desc kolejności malejącej.
Po	kwerenda	Nr	ciąg	Kursor do użycia w stronicowaniu. after jest identyfikatorem obiektu definiującym miejsce na liście. Jeśli na przykład wykonasz żądanie listy i otrzymasz 100 obiektów, kończąc się obj_foo, kolejne wywołanie może obejmować polecenie after=obj_foo w celu pobrania następnej strony listy.
Przed	kwerenda	Nr	ciąg	Kursor do użycia w stronicowaniu. before jest identyfikatorem obiektu definiującym miejsce na liście. Jeśli na przykład wykonasz żądanie listy i otrzymasz 100 obiektów, począwszy od obj_foo, kolejne wywołanie może zawierać wartość before=obj_foo w celu pobrania poprzedniej strony listy.
wersja interfejsu API	kwerenda	Tak	ciąg	wersja interfejsu API

Nagłówek żądania

Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.

Nazwa	Wymagane	Typ	Opis
Autoryzacji	True	ciąg	Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize Zakres: https://ai.azure.com/.default
api-key	True	ciąg	Tutaj podaj klucz interfejsu API usługi Azure OpenAI

Odpowiedzi

Kod stanu: 200

Opis: OK

Typ zawartości	Typu	Opis
application/json	listVectorStoresResponse

Przykłady

Przykład

Zwraca listę magazynów wektorów.

GET https://{endpoint}/openai/vector_stores?api-version=2025-04-01-preview

Odpowiedzi: Kod stanu: 200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "vs_abc123",
        "object": "vector_store",
        "created_at": 1699061776,
        "name": "Support FAQ",
        "bytes": 139920,
        "file_counts": {
          "in_progress": 0,
          "completed": 3,
          "failed": 0,
          "cancelled": 0,
          "total": 3
        }
      },
      {
        "id": "vs_abc456",
        "object": "vector_store",
        "created_at": 1699061776,
        "name": "Support FAQ v2",
        "bytes": 139920,
        "file_counts": {
          "in_progress": 0,
          "completed": 3,
          "failed": 0,
          "cancelled": 0,
          "total": 3
        }
      }
    ],
    "first_id": "vs_abc123",
    "last_id": "vs_abc456",
    "has_more": false
  }
}

Tworzenie — magazyn wektorów

POST https://{endpoint}/openai/vector_stores?api-version=2025-04-01-preview

Utwórz magazyn wektorów.

Parametry identyfikatora URI

Nazwa	Cala	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	adres URL ciągu	Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, na przykład: https://aoairesource.openai.azure.com. Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI. https://{nazwa_zasobu}.openai.azure.com
wersja interfejsu API	kwerenda	Tak	ciąg	wersja interfejsu API

Nagłówek żądania

Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.

Nazwa	Wymagane	Typ	Opis
Autoryzacji	True	ciąg	Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize Zakres: https://ai.azure.com/.default
api-key	True	ciąg	Tutaj podaj klucz interfejsu API usługi Azure OpenAI

Treść żądania

Typ zawartości: application/json

Nazwa	Typ	Opis	Wymagane	Domyślny
chunking_strategy	autoChunkingStrategyRequestParam lub staticChunkingStrategyRequestParam	Strategia fragmentowania używana do fragmentowania plików. Jeśli nie zostanie ustawiona, użyje auto strategii. Dotyczy tylko wtedy, gdy file_ids nie jest pusty.	Nr
expires_after	vectorStoreExpirationAfter	Zasady wygasania magazynu wektorów.	Nr
file_ids	macierz	Lista identyfikatorów plików, których powinien używać magazyn wektorów. Przydatne w przypadku narzędzi, takich jak file_search te, które mogą uzyskiwać dostęp do plików.	Nr
metadane	obiekt	Zestaw 16 par klucz-wartość, które można dołączyć do obiektu. Może to być przydatne do przechowywania dodatkowych informacji o obiekcie w formacie ustrukturyzowanym. Klucze mogą mieć długość maksymalnie 64 znaków, a wartości mogą mieć długość maksymalnie 512 znaków.	Nr
Nazwa	ciąg	Nazwa magazynu wektorów.	Nr

Odpowiedzi

Kod stanu: 200

Opis: OK

Typ zawartości	Typu	Opis
application/json	vectorStoreObject

Przykłady

Przykład

Tworzy magazyn wektorów.

POST https://{endpoint}/openai/vector_stores?api-version=2025-04-01-preview

Odpowiedzi: Kod stanu: 200

{
  "body": {
    "id": "vs_abc123",
    "object": "vector_store",
    "created_at": 1699061776,
    "name": "Support FAQ",
    "bytes": 139920,
    "file_counts": {
      "in_progress": 0,
      "completed": 3,
      "failed": 0,
      "cancelled": 0,
      "total": 3
    }
  }
}

Pobieranie — magazyn wektorów

GET https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2025-04-01-preview

Pobiera magazyn wektorów.

Parametry identyfikatora URI

Nazwa	Cala	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	adres URL ciągu	Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, na przykład: https://aoairesource.openai.azure.com. Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI. https://{nazwa_zasobu}.openai.azure.com
vector_store_id	ścieżka	Tak	ciąg	Identyfikator magazynu wektorów do pobrania.
wersja interfejsu API	kwerenda	Tak	ciąg	wersja interfejsu API

Nagłówek żądania

Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.

Nazwa	Wymagane	Typ	Opis
Autoryzacji	True	ciąg	Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize Zakres: https://ai.azure.com/.default
api-key	True	ciąg	Tutaj podaj klucz interfejsu API usługi Azure OpenAI

Odpowiedzi

Kod stanu: 200

Opis: OK

Typ zawartości	Typu	Opis
application/json	vectorStoreObject

Przykłady

Przykład

Pobiera magazyn wektorów.

GET https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2025-04-01-preview

Odpowiedzi: Kod stanu: 200

{
  "body": {
    "id": "vs_abc123",
    "object": "vector_store",
    "created_at": 1699061776
  }
}

Modyfikuj — magazyn wektorów

POST https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2025-04-01-preview

Modyfikuje magazyn wektorów.

Parametry identyfikatora URI

Nazwa	Cala	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	adres URL ciągu	Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, na przykład: https://aoairesource.openai.azure.com. Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI. https://{nazwa_zasobu}.openai.azure.com
vector_store_id	ścieżka	Tak	ciąg	Identyfikator magazynu wektorów do zmodyfikowania.
wersja interfejsu API	kwerenda	Tak	ciąg	wersja interfejsu API

Nagłówek żądania

Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.

Nazwa	Wymagane	Typ	Opis
Autoryzacji	True	ciąg	Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize Zakres: https://ai.azure.com/.default
api-key	True	ciąg	Tutaj podaj klucz interfejsu API usługi Azure OpenAI

Treść żądania

Typ zawartości: application/json

Nazwa	Typ	Opis	Wymagane	Domyślny
expires_after	vectorStoreExpirationAfter	Zasady wygasania magazynu wektorów.	Nr
metadane	obiekt	Zestaw 16 par klucz-wartość, które można dołączyć do obiektu. Może to być przydatne do przechowywania dodatkowych informacji o obiekcie w formacie ustrukturyzowanym. Klucze mogą mieć długość maksymalnie 64 znaków, a wartości mogą mieć długość maksymalnie 512 znaków.	Nr
Nazwa	ciąg	Nazwa magazynu wektorów.	Nr

Odpowiedzi

Kod stanu: 200

Opis: OK

Typ zawartości	Typu	Opis
application/json	vectorStoreObject

Przykłady

Przykład

Modyfikuje magazyn wektorów.

POST https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2025-04-01-preview

{
 "name": "Support FAQ"
}

Odpowiedzi: Kod stanu: 200

{
  "body": {
    "id": "vs_abc123",
    "object": "vector_store",
    "created_at": 1699061776,
    "name": "Support FAQ",
    "bytes": 139920,
    "file_counts": {
      "in_progress": 0,
      "completed": 3,
      "failed": 0,
      "cancelled": 0,
      "total": 3
    }
  }
}

Usuwanie — magazyn wektorów

DELETE https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2025-04-01-preview

Usuń magazyn wektorów.

Parametry identyfikatora URI

Nazwa	Cala	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	adres URL ciągu	Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, na przykład: https://aoairesource.openai.azure.com. Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI. https://{nazwa_zasobu}.openai.azure.com
vector_store_id	ścieżka	Tak	ciąg	Identyfikator magazynu wektorów do usunięcia.
wersja interfejsu API	kwerenda	Tak	ciąg	wersja interfejsu API

Nagłówek żądania

Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.

Nazwa	Wymagane	Typ	Opis
Autoryzacji	True	ciąg	Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize Zakres: https://ai.azure.com/.default
api-key	True	ciąg	Tutaj podaj klucz interfejsu API usługi Azure OpenAI

Odpowiedzi

Kod stanu: 200

Opis: OK

Typ zawartości	Typu	Opis
application/json	deleteVectorStoreResponse

Przykłady

Przykład

Usuwa magazyn wektorów.

DELETE https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2025-04-01-preview

Odpowiedzi: Kod stanu: 200

{
  "body": {
    "id": "vs_abc123",
    "object": "vector_store.deleted",
    "deleted": true
  }
}

Lista — pliki magazynu wektorowego

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/files?api-version=2025-04-01-preview

Zwraca listę plików magazynu wektorowego.

Parametry identyfikatora URI

Nazwa	Cala	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	adres URL ciągu	Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, na przykład: https://aoairesource.openai.azure.com. Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI. https://{nazwa_zasobu}.openai.azure.com
vector_store_id	ścieżka	Tak	ciąg	Identyfikator magazynu wektorów, do którego należą pliki.
Limit	kwerenda	Nr	liczba całkowita	Limit liczby zwracanych obiektów. Limit może mieścić się w zakresie od 1 do 100, a wartość domyślna to 20.
porządek	kwerenda	Nr	ciąg Możliwe wartości: asc, desc	Sortuj kolejność według znacznika created_at czasu obiektów. asc w przypadku kolejności rosnącej i desc kolejności malejącej.
Po	kwerenda	Nr	ciąg	Kursor do użycia w stronicowaniu. after jest identyfikatorem obiektu definiującym miejsce na liście. Jeśli na przykład wykonasz żądanie listy i otrzymasz 100 obiektów, kończąc się obj_foo, kolejne wywołanie może obejmować polecenie after=obj_foo w celu pobrania następnej strony listy.
Przed	kwerenda	Nr	ciąg	Kursor do użycia w stronicowaniu. before jest identyfikatorem obiektu definiującym miejsce na liście. Jeśli na przykład wykonasz żądanie listy i otrzymasz 100 obiektów, począwszy od obj_foo, kolejne wywołanie może zawierać wartość before=obj_foo w celu pobrania poprzedniej strony listy.
filtr	kwerenda	Nr	ciąg Możliwe wartości: in_progress, , completed, failedcancelled	Filtruj według stanu pliku. Jeden z in_progress, , completedfailed, cancelled.
wersja interfejsu API	kwerenda	Tak	ciąg	wersja interfejsu API

Nagłówek żądania

Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.

Nazwa	Wymagane	Typ	Opis
Autoryzacji	True	ciąg	Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize Zakres: https://ai.azure.com/.default
api-key	True	ciąg	Tutaj podaj klucz interfejsu API usługi Azure OpenAI

Odpowiedzi

Kod stanu: 200

Opis: OK

Typ zawartości	Typu	Opis
application/json	listVectorStoreFilesResponse

Przykłady

Przykład

Zwraca listę plików magazynu wektorowego.

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/files?api-version=2025-04-01-preview

Odpowiedzi: Kod stanu: 200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "file-abc123",
        "object": "vector_store.file",
        "created_at": 1699061776,
        "vector_store_id": "vs_abc123"
      },
      {
        "id": "file-abc456",
        "object": "vector_store.file",
        "created_at": 1699061776,
        "vector_store_id": "vs_abc123"
      }
    ],
    "first_id": "file-abc123",
    "last_id": "file-abc456",
    "has_more": false
  }
}

Tworzenie — plik magazynu wektorów

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/files?api-version=2025-04-01-preview

Utwórz plik magazynu wektorów, dołączając plik do magazynu wektorów.

Parametry identyfikatora URI

Nazwa	Cala	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	adres URL ciągu	Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, na przykład: https://aoairesource.openai.azure.com. Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI. https://{nazwa_zasobu}.openai.azure.com
vector_store_id	ścieżka	Tak	ciąg	Identyfikator magazynu wektorów, dla którego ma zostać utworzony plik.
wersja interfejsu API	kwerenda	Tak	ciąg	wersja interfejsu API

Nagłówek żądania

Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.

Nazwa	Wymagane	Typ	Opis
Autoryzacji	True	ciąg	Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize Zakres: https://ai.azure.com/.default
api-key	True	ciąg	Tutaj podaj klucz interfejsu API usługi Azure OpenAI

Treść żądania

Typ zawartości: application/json

Nazwa	Typ	Opis	Wymagane	Domyślny
chunking_strategy	fragmentingStrategyRequestParam	Strategia fragmentowania używana do fragmentowania plików. Jeśli nie zostanie ustawiona, użyje auto strategii.	Nr
File_id	ciąg	Identyfikator pliku, którego powinien używać magazyn wektorów. Przydatne w przypadku narzędzi, takich jak file_search te, które mogą uzyskiwać dostęp do plików.	Tak

Odpowiedzi

Kod stanu: 200

Opis: OK

Typ zawartości	Typu	Opis
application/json	vectorStoreFileObject

Przykłady

Przykład

Utwórz plik magazynu wektorów, dołączając plik do magazynu wektorów.

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/files?api-version=2025-04-01-preview

{
 "file_id": "file-abc123"
}

Odpowiedzi: Kod stanu: 200

{
  "body": {
    "id": "file-abc123",
    "object": "vector_store.file",
    "created_at": 1699061776,
    "usage_bytes": 1234,
    "vector_store_id": "vs_abcd",
    "status": "completed",
    "last_error": null
  }
}

Get — plik magazynu wektorów

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}?api-version=2025-04-01-preview

Pobiera plik magazynu wektorów.

Parametry identyfikatora URI

Nazwa	Cala	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	adres URL ciągu	Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, na przykład: https://aoairesource.openai.azure.com. Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI. https://{nazwa_zasobu}.openai.azure.com
vector_store_id	ścieżka	Tak	ciąg	Identyfikator magazynu wektorów, do którego należy plik.
File_id	ścieżka	Tak	ciąg	Identyfikator pobieranego pliku.
wersja interfejsu API	kwerenda	Tak	ciąg	wersja interfejsu API

Nagłówek żądania

Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.

Nazwa	Wymagane	Typ	Opis
Autoryzacji	True	ciąg	Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize Zakres: https://ai.azure.com/.default
api-key	True	ciąg	Tutaj podaj klucz interfejsu API usługi Azure OpenAI

Odpowiedzi

Kod stanu: 200

Opis: OK

Typ zawartości	Typu	Opis
application/json	vectorStoreFileObject

Przykłady

Przykład

Pobiera plik magazynu wektorów.

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}?api-version=2025-04-01-preview

Odpowiedzi: Kod stanu: 200

{
  "body": {
    "id": "file-abc123",
    "object": "vector_store.file",
    "created_at": 1699061776,
    "vector_store_id": "vs_abcd",
    "status": "completed",
    "last_error": null
  }
}

Usuwanie — plik magazynu wektorowego

DELETE https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}?api-version=2025-04-01-preview

Usuń plik magazynu wektorów. Spowoduje to usunięcie pliku z magazynu wektorów, ale sam plik nie zostanie usunięty. Aby usunąć plik, użyj punktu końcowego usuwania pliku.

Parametry identyfikatora URI

Nazwa	Cala	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	adres URL ciągu	Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, na przykład: https://aoairesource.openai.azure.com. Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI. https://{nazwa_zasobu}.openai.azure.com
vector_store_id	ścieżka	Tak	ciąg	Identyfikator magazynu wektorów, do którego należy plik.
File_id	ścieżka	Tak	ciąg	Identyfikator pliku do usunięcia.
wersja interfejsu API	kwerenda	Tak	ciąg	wersja interfejsu API

Nagłówek żądania

Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.

Nazwa	Wymagane	Typ	Opis
Autoryzacji	True	ciąg	Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize Zakres: https://ai.azure.com/.default
api-key	True	ciąg	Tutaj podaj klucz interfejsu API usługi Azure OpenAI

Odpowiedzi

Kod stanu: 200

Opis: OK

Typ zawartości	Typu	Opis
application/json	deleteVectorStoreFileResponse

Przykłady

Przykład

Usuń plik magazynu wektorów. Spowoduje to usunięcie pliku z magazynu wektorów, ale sam plik nie zostanie usunięty. Aby usunąć plik, użyj punktu końcowego usuwania pliku.

DELETE https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}?api-version=2025-04-01-preview

Odpowiedzi: Kod stanu: 200

{
  "body": {
    "id": "file_abc123",
    "object": "vector_store.file.deleted",
    "deleted": true
  }
}

Updatevectorstorefileattributes

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}?api-version=2025-04-01-preview

Aktualizowanie atrybutów w pliku magazynu wektorów.

Parametry identyfikatora URI

Nazwa	Cala	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	adres URL ciągu	Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, na przykład: https://aoairesource.openai.azure.com. Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI. https://{nazwa_zasobu}.openai.azure.com
vector_store_id	ścieżka	Tak	ciąg	Identyfikator magazynu wektorów, do którego należy plik.
File_id	ścieżka	Tak	ciąg	Identyfikator pliku do zaktualizowania atrybutów.

Nagłówek żądania

Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.

Nazwa	Wymagane	Typ	Opis
Autoryzacji	True	ciąg	Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize Zakres: https://ai.azure.com/.default
api-key	True	ciąg	Tutaj podaj klucz interfejsu API usługi Azure OpenAI

Treść żądania

Typ zawartości: application/json

Nazwa	Typ	Opis	Wymagane	Domyślny
Atrybuty	VectorStoreFileAttributes	Zestaw 16 par klucz-wartość, które można dołączyć do obiektu. Może to być przydatne do przechowywania dodatkowych informacji o obiekcie w formacie ustrukturyzowanym i wykonywania zapytań dotyczących obiektów za pośrednictwem interfejsu API lub pulpitu nawigacyjnego. Klucze to ciągi o maksymalnej długości 64 znaków. Wartości to ciągi o maksymalnej długości 512 znaków, wartości logicznych lub liczb.	Tak

Odpowiedzi

Kod stanu: 200

Opis: OK

Typ zawartości	Typu	Opis
application/json	vectorStoreFileObject

Pobieranie zawartości pliku magazynu wektorów

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}/content?api-version=2025-04-01-preview

Pobierz przeanalizowaną zawartość pliku magazynu wektorów.

Parametry identyfikatora URI

Nazwa	Cala	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	adres URL ciągu	Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, na przykład: https://aoairesource.openai.azure.com. Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI. https://{nazwa_zasobu}.openai.azure.com
vector_store_id	ścieżka	Tak	ciąg	Identyfikator magazynu wektorów.
File_id	ścieżka	Tak	ciąg	Identyfikator pliku w magazynie wektorów.

Nagłówek żądania

Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.

Nazwa	Wymagane	Typ	Opis
Autoryzacji	True	ciąg	Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize Zakres: https://ai.azure.com/.default
api-key	True	ciąg	Tutaj podaj klucz interfejsu API usługi Azure OpenAI

Odpowiedzi

Kod stanu: 200

Opis: OK

Typ zawartości	Typu	Opis
application/json	VectorStoreFileContentResponse

Magazyn wektorów wyszukiwania

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/search?api-version=2025-04-01-preview

Przeszukaj magazyn wektorów pod kątem odpowiednich fragmentów na podstawie filtru atrybutów zapytania i pliku.

Parametry identyfikatora URI

Nazwa	Cala	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	adres URL ciągu	Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, na przykład: https://aoairesource.openai.azure.com. Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI. https://{nazwa_zasobu}.openai.azure.com
vector_store_id	ścieżka	Tak	ciąg	Identyfikator magazynu wektorów do wyszukiwania.

Nagłówek żądania

Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.

Nazwa	Wymagane	Typ	Opis
Autoryzacji	True	ciąg	Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize Zakres: https://ai.azure.com/.default
api-key	True	ciąg	Tutaj podaj klucz interfejsu API usługi Azure OpenAI

Treść żądania

Typ zawartości: application/json

Nazwa	Typ	Opis	Wymagane	Domyślny
Filtry	Filtr porównawczy lub filtr złożony	Filtr do zastosowania na podstawie atrybutów pliku.	Nr
max_num_results	liczba całkowita	Maksymalna liczba wyników do zwrócenia. Ta liczba powinna należeć do zakresu od 1 do 50 włącznie.	Nr	10
kwerenda	ciąg lub tablica	Ciąg zapytania dla wyszukiwania	Tak
ranking_options	obiekt	Opcje klasyfikacji wyszukiwania.	Nr
└} ranker	wyliczenie	Możliwe wartości: auto, default-2024-11-15	Nr
└score_threshold	Numer		Nr	0
rewrite_query	Boolean	Określa, czy należy ponownie napisać zapytanie języka naturalnego na potrzeby wyszukiwania wektorów.	Nr	False

Odpowiedzi

Kod stanu: 200

Opis: OK

Typ zawartości	Typu	Opis
application/json	VectorStoreSearchResultsPage

Tworzenie — wektorowa partia plików magazynu

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches?api-version=2025-04-01-preview

Utwórz wektorową partię plików magazynu.

Parametry identyfikatora URI

Nazwa	Cala	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	adres URL ciągu	Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, na przykład: https://aoairesource.openai.azure.com. Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI. https://{nazwa_zasobu}.openai.azure.com
vector_store_id	ścieżka	Tak	ciąg	Identyfikator magazynu wektorów, dla którego ma zostać utworzona partia plików.
wersja interfejsu API	kwerenda	Tak	ciąg	wersja interfejsu API

Nagłówek żądania

Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.

Nazwa	Wymagane	Typ	Opis
Autoryzacji	True	ciąg	Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize Zakres: https://ai.azure.com/.default
api-key	True	ciąg	Tutaj podaj klucz interfejsu API usługi Azure OpenAI

Treść żądania

Typ zawartości: application/json

Nazwa	Typ	Opis	Wymagane	Domyślny
chunking_strategy	fragmentingStrategyRequestParam	Strategia fragmentowania używana do fragmentowania plików. Jeśli nie zostanie ustawiona, użyje auto strategii.	Nr
file_ids	macierz	Lista identyfikatorów plików, których powinien używać magazyn wektorów. Przydatne w przypadku narzędzi, takich jak file_search te, które mogą uzyskiwać dostęp do plików.	Tak

Odpowiedzi

Kod stanu: 200

Opis: OK

Typ zawartości	Typu	Opis
application/json	vectorStoreFileBatchObject

Przykłady

Przykład

Utwórz wektorową partię plików magazynu.

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches?api-version=2025-04-01-preview

{
 "file_ids": [
  "file-abc123",
  "file-abc456"
 ]
}

Odpowiedzi: Kod stanu: 200

{
  "id": "vsfb_abc123",
  "object": "vector_store.file_batch",
  "created_at": 1699061776,
  "vector_store_id": "vs_abc123",
  "status": "in_progress",
  "file_counts": {
    "in_progress": 1,
    "completed": 1,
    "failed": 0,
    "cancelled": 0,
    "total": 0
  }
}

Get — wektorowa partia plików magazynu

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}?api-version=2025-04-01-preview

Pobiera wektorową partię plików magazynu.

Parametry identyfikatora URI

Nazwa	Cala	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	adres URL ciągu	Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, na przykład: https://aoairesource.openai.azure.com. Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI. https://{nazwa_zasobu}.openai.azure.com
vector_store_id	ścieżka	Tak	ciąg	Identyfikator magazynu wektorów, do którego należy partia plików.
batch_id	ścieżka	Tak	ciąg	Identyfikator pobieranej partii plików.
wersja interfejsu API	kwerenda	Tak	ciąg	wersja interfejsu API

Nagłówek żądania

Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.

Nazwa	Wymagane	Typ	Opis
Autoryzacji	True	ciąg	Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize Zakres: https://ai.azure.com/.default
api-key	True	ciąg	Tutaj podaj klucz interfejsu API usługi Azure OpenAI

Odpowiedzi

Kod stanu: 200

Opis: OK

Typ zawartości	Typu	Opis
application/json	vectorStoreFileBatchObject

Przykłady

Przykład

Pobiera wektorową partię plików magazynu.

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}?api-version=2025-04-01-preview

Odpowiedzi: Kod stanu: 200

{
  "body": {
    "id": "vsfb_abc123",
    "object": "vector_store.file_batch",
    "created_at": 1699061776,
    "vector_store_id": "vs_abc123",
    "status": "in_progress",
    "file_counts": {
      "in_progress": 1,
      "completed": 1,
      "failed": 0,
      "cancelled": 0,
      "total": 0
    }
  }
}

Anulowanie — wektorowy magazyn plików wsadowy

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel?api-version=2025-04-01-preview

Anuluj partię plików magazynu wektorów. Spowoduje to jak najszybsze anulowanie przetwarzania plików w tej partii.

Parametry identyfikatora URI

Nazwa	Cala	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	adres URL ciągu	Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, na przykład: https://aoairesource.openai.azure.com. Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI. https://{nazwa_zasobu}.openai.azure.com
vector_store_id	ścieżka	Tak	ciąg	Identyfikator magazynu wektorów, do którego należy partia plików.
batch_id	ścieżka	Tak	ciąg	Identyfikator partii plików do anulowania.
wersja interfejsu API	kwerenda	Tak	ciąg	wersja interfejsu API

Nagłówek żądania

Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.

Nazwa	Wymagane	Typ	Opis
Autoryzacji	True	ciąg	Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize Zakres: https://ai.azure.com/.default
api-key	True	ciąg	Tutaj podaj klucz interfejsu API usługi Azure OpenAI

Odpowiedzi

Kod stanu: 200

Opis: OK

Typ zawartości	Typu	Opis
application/json	vectorStoreFileBatchObject

Przykłady

Przykład

Anuluj partię plików magazynu wektorów. Spowoduje to jak najszybsze anulowanie przetwarzania plików w tej partii.

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel?api-version=2025-04-01-preview

Odpowiedzi: Kod stanu: 200

{
  "body": {
    "id": "vsfb_abc123",
    "object": "vector_store.file_batch",
    "created_at": 1699061776,
    "vector_store_id": "vs_abc123",
    "status": "cancelling",
    "file_counts": {
      "in_progress": 12,
      "completed": 3,
      "failed": 0,
      "cancelled": 0,
      "total": 15
    }
  }
}

Lista — pliki wsadowe magazynu wektorów

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}/files?api-version=2025-04-01-preview

Zwraca listę plików magazynu wektorów w partii.

Parametry identyfikatora URI

Nazwa	Cala	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	adres URL ciągu	Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, na przykład: https://aoairesource.openai.azure.com. Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI. https://{nazwa_zasobu}.openai.azure.com
vector_store_id	ścieżka	Tak	ciąg	Identyfikator magazynu wektorów, do którego należą pliki.
batch_id	ścieżka	Tak	ciąg	Identyfikator partii plików, do którego należą pliki.
Limit	kwerenda	Nr	liczba całkowita	Limit liczby zwracanych obiektów. Limit może mieścić się w zakresie od 1 do 100, a wartość domyślna to 20.
porządek	kwerenda	Nr	ciąg Możliwe wartości: asc, desc	Sortuj kolejność według znacznika created_at czasu obiektów. asc w przypadku kolejności rosnącej i desc kolejności malejącej.
Po	kwerenda	Nr	ciąg	Kursor do użycia w stronicowaniu. after jest identyfikatorem obiektu definiującym miejsce na liście. Jeśli na przykład wykonasz żądanie listy i otrzymasz 100 obiektów, kończąc się obj_foo, kolejne wywołanie może obejmować polecenie after=obj_foo w celu pobrania następnej strony listy.
Przed	kwerenda	Nr	ciąg	Kursor do użycia w stronicowaniu. before jest identyfikatorem obiektu definiującym miejsce na liście. Jeśli na przykład wykonasz żądanie listy i otrzymasz 100 obiektów, począwszy od obj_foo, kolejne wywołanie może zawierać wartość before=obj_foo w celu pobrania poprzedniej strony listy.
filtr	kwerenda	Nr	ciąg Możliwe wartości: in_progress, , completed, failedcancelled	Filtruj według stanu pliku. Jeden z in_progress, , completedfailed, cancelled.
wersja interfejsu API	kwerenda	Tak	ciąg	wersja interfejsu API

Nagłówek żądania

Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.

Nazwa	Wymagane	Typ	Opis
Autoryzacji	True	ciąg	Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize Zakres: https://ai.azure.com/.default
api-key	True	ciąg	Tutaj podaj klucz interfejsu API usługi Azure OpenAI

Odpowiedzi

Kod stanu: 200

Opis: OK

Typ zawartości	Typu	Opis
application/json	listVectorStoreFilesResponse

Przykłady

Przykład

Zwraca listę plików magazynu wektorowego.

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}/files?api-version=2025-04-01-preview

Odpowiedzi: Kod stanu: 200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "file-abc123",
        "object": "vector_store.file",
        "created_at": 1699061776,
        "vector_store_id": "vs_abc123"
      },
      {
        "id": "file-abc456",
        "object": "vector_store.file",
        "created_at": 1699061776,
        "vector_store_id": "vs_abc123"
      }
    ],
    "first_id": "file-abc123",
    "last_id": "file-abc456",
    "has_more": false
  }
}

Tworzenie — realtimesession

POST https://{endpoint}/openai/realtimeapi/sessions?api-version=2025-04-01-preview

Utwórz efemeryczny token interfejsu API do użycia w aplikacjach po stronie klienta przy użyciu interfejsu API czasu rzeczywistego. Można skonfigurować przy użyciu tych samych parametrów sesji co session.update zdarzenie klienta. Odpowiada za pomocą obiektu sesji oraz client_secret klucza, który zawiera użyteczny token interfejsu API efemerycznego, który może służyć do uwierzytelniania klientów przeglądarki dla interfejsu API czasu rzeczywistego.

Treść żądania

Typ zawartości: application/json

Nazwa	Typ	Opis	Wymagane	Domyślny
input_audio_format	wyliczenie	Format wejściowego dźwięku. Opcje to pcm16, g711_ulawlub g711_alaw. W przypadku pcm16systemu dźwięk wejściowy musi być 16-bitowy PCM z częstotliwością próbkowania 24kHz, pojedynczym kanałem (mono) i małą kolejnością bajtów endian. Możliwe wartości: pcm16, , g711_ulawg711_alaw	Nr
input_audio_noise_reduction	obiekt	Konfiguracja redukcji szumu dźwięku wejściowego. Można to ustawić tak, null aby wyłączyć. Redukcja szumu filtruje dźwięk dodany do wejściowego buforu audio przed wysłaniem go do usługi VAD i modelu. Filtrowanie dźwięku może poprawić dokładność wykrywania vaD i włączania (zmniejszenie wyników fałszywie dodatnich) i wydajność modelu, poprawiając postrzeganie dźwięku wejściowego.	Nr
└typ	wyliczenie	Typ redukcji szumu. near_field jest przeznaczony dla mikrofonów z bliska, takich jak słuchawki, jest przeznaczony dla mikrofonów dalekiego pola, far_field takich jak laptop lub mikrofony sali konferencyjnej. Możliwe wartości: near_field, far_field	Nr
input_audio_transcription	obiekt	Konfiguracja transkrypcji audio wejściowego, domyślnie wyłączona i może być ustawiona tak, aby null wyłączyć raz. Transkrypcja audio wejściowego nie jest natywna dla modelu, ponieważ model korzysta bezpośrednio z dźwięku. Transkrypcja jest uruchamiana asynchronicznie za pośrednictwem punktu końcowego transkrypcji i powinna być traktowana jako wskazówki dotyczące wejściowej zawartości audio, a nie dokładnie tego, co usłyszał model. Klient może opcjonalnie ustawić język i monitować o transkrypcję. Oferują one dodatkowe wskazówki dotyczące usługi transkrypcji.	Nr
└* język	ciąg	Język wejściowego dźwięku. Dostarczanie języka wejściowego w formacie ISO-639-1 (np. en) zwiększa dokładność i opóźnienie.	Nr
Model └*	ciąg	Model używany do transkrypcji, bieżące opcje to gpt-4o-transcribe, , gpt-4o-transcribe-diarizegpt-4o-mini-transcribe, gpt-4o-mini-transcribe-2025-12-15i whisper-1.	Nr
Monit └*	ciąg	Opcjonalny tekst prowadzący do stylu modelu lub kontynuacji poprzedniego segmentu audio. W przypadku whisper-1polecenia jest to lista słów kluczowych. W przypadku gpt-4o-transcribe modeli monit jest wolnym ciągiem tekstowym, na przykład "oczekiwano słów związanych z technologią".	Nr
Instrukcje	ciąg	Domyślne instrukcje systemowe (tj. komunikat systemowy) są poprzedzane wywołaniami modelu. To pole umożliwia klientowi poprowadzenie modelu w żądanych odpowiedziach. Model może być poinstruowany na temat zawartości i formatu odpowiedzi (np. "być bardzo zwięzły", "działać przyjazny", "oto przykłady dobrych odpowiedzi") i zachowania audio (np. "szybko rozmawiać", "wstrzykiwanie emocji do głosu", "śmiać się często"). Instrukcje nie mają gwarancji, że są zgodne z modelem, ale zapewniają wskazówki dotyczące modelu w żądanym zachowaniu. Należy pamiętać, że serwer ustawia domyślne instrukcje, które będą używane, jeśli to pole nie jest ustawione i są widoczne w session.created zdarzeniu na początku sesji.	Nr
max_response_output_tokens	liczba całkowita lub ciąg	Maksymalna liczba tokenów wyjściowych dla pojedynczej odpowiedzi asystenta, w tym wywołań narzędzi. Podaj liczbę całkowitą z zakresu od 1 do 4096, aby ograniczyć tokeny wyjściowe lub inf maksymalnie dostępne tokeny dla danego modelu. Wartość domyślna to inf.	Nr
Sposoby		Zestaw modalności, za pomocą których model może reagować. Aby wyłączyć dźwięk, ustaw wartość ["text"].	Nr
model	ciąg	Nazwa wdrożenia używanego na potrzeby tej sesji.	Nr
output_audio_format	wyliczenie	Format dźwięku wyjściowego. Opcje to pcm16, g711_ulawlub g711_alaw. W przypadku pcm16parametru dźwięk wyjściowy jest próbkowany z szybkością 24kHz. Możliwe wartości: pcm16, , g711_ulawg711_alaw	Nr
Temperatury	Numer	Temperatura próbkowania dla modelu ograniczona do [0.6, 1.2]. W przypadku modeli audio temperatura 0,8 jest zdecydowanie zalecana w celu uzyskania najlepszej wydajności.	Nr	0.8
tool_choice	ciąg	W jaki sposób model wybiera narzędzia. Opcje to auto, none, requiredlub określają funkcję.	Nr	Automatycznie
Narzędzia	macierz	Narzędzia (funkcje) dostępne dla modelu.	Nr
turn_detection	obiekt	Konfiguracja wykrywania kolei, eter Server VAD lub Semantic VAD. Można to ustawić tak, aby null wyłączyć, w takim przypadku klient musi ręcznie wyzwolić odpowiedź modelu. Funkcja VAD serwera oznacza, że model wykryje początek i koniec mowy na podstawie głośności audio i odpowie na końcu mowy użytkownika. Semantyczna funkcja VAD jest bardziej zaawansowana i używa modelu wykrywania obrotu (w połączeniu z vaD), aby semantycznie oszacować, czy użytkownik zakończył mówić, a następnie dynamicznie ustawia limit czasu na podstawie tego prawdopodobieństwa. Jeśli na przykład użytkownik wybiegnie ścieżki audio z uhhmużyciem metody , model będzie oceniać niskie prawdopodobieństwo włączenia i poczekać dłużej na kontynuowanie mówienia przez użytkownika. Może to być przydatne w przypadku bardziej naturalnych rozmów, ale może mieć większe opóźnienie.	Nr
└create_response	Boolean	Określa, czy ma być automatycznie generowany odpowiedź po wystąpieniu zdarzenia zatrzymania vaD.	Nr	True
└* gotowość	wyliczenie	Używane tylko w semantic_vad trybie. Gotowość modelu do reagowania. low będzie czekać dłużej, aż użytkownik będzie nadal mówić, high będzie reagować szybciej. auto jest wartością domyślną i jest odpowiednikiem medium. Możliwe wartości: low, , medium, highauto	Nr
└interrupt_response	Boolean	Określa, czy automatycznie przerywać bieżącą odpowiedź z danymi wyjściowymi domyślnej konwersacji (tj. conversation ) po wystąpieniu autozdarzenia rozpoczęcia vaD.	Nr	True
└prefix_padding_ms	liczba całkowita	Używane tylko w server_vad trybie. Ilość dźwięku do uwzględnienia przed wykryciem mowy vaD (w milisekundach). Wartość domyślna to 300 ms.	Nr
└silence_duration_ms	liczba całkowita	Używane tylko w server_vad trybie. Czas trwania ciszy wykrywania zatrzymania mowy (w milisekundach). Wartość domyślna to 500 ms. Dzięki krótszym wartościom model będzie reagować szybciej, ale może wskoczyć na krótkie przerwy od użytkownika.	Nr
└* próg	Numer	Używane tylko w server_vad trybie. Próg aktywacji dla usługi VAD (od 0.0 do 1.0) domyślnie wynosi 0,5. Wyższy próg będzie wymagać głośniejszego dźwięku do aktywowania modelu, a tym samym może działać lepiej w hałaśliwych środowiskach.	Nr
└typ	wyliczenie	Typ wykrywania kolei. Możliwe wartości: server_vad, semantic_vad	Nr
głos	VoiceIdsShared		Nr

Odpowiedzi

Kod stanu: 200

Opis: Sesja została pomyślnie utworzona.

Typ zawartości	Typu	Opis
application/json	RealtimeSessionCreateResponse

Tworzenie — Transkrypcjarealtimesession

POST https://{endpoint}/openai/realtimeapi/transcription_sessions?api-version=2025-04-01-preview

Utwórz efemeryczny token interfejsu API do użycia w aplikacjach po stronie klienta z interfejsem API czasu rzeczywistego przeznaczonym specjalnie dla transkrypcji w czasie rzeczywistym. Można skonfigurować przy użyciu tych samych parametrów sesji co transcription_session.update zdarzenie klienta. Odpowiada za pomocą obiektu sesji oraz client_secret klucza, który zawiera użyteczny token interfejsu API efemerycznego, który może służyć do uwierzytelniania klientów przeglądarki dla interfejsu API czasu rzeczywistego.

Treść żądania

Typ zawartości: application/json

Nazwa	Typ	Opis	Wymagane	Domyślny
Obejmują	macierz	Zestaw elementów do uwzględnienia w transkrypcji. Bieżące dostępne elementy to: - item.input_audio_transcription.logprobs	Nr
input_audio_format	wyliczenie	Format wejściowego dźwięku. Opcje to pcm16, g711_ulawlub g711_alaw. W przypadku pcm16systemu dźwięk wejściowy musi być 16-bitowy PCM z częstotliwością próbkowania 24kHz, pojedynczym kanałem (mono) i małą kolejnością bajtów endian. Możliwe wartości: pcm16, , g711_ulawg711_alaw	Nr
input_audio_noise_reduction	obiekt	Konfiguracja redukcji szumu dźwięku wejściowego. Można to ustawić tak, null aby wyłączyć. Redukcja szumu filtruje dźwięk dodany do wejściowego buforu audio przed wysłaniem go do usługi VAD i modelu. Filtrowanie dźwięku może poprawić dokładność wykrywania vaD i włączania (zmniejszenie wyników fałszywie dodatnich) i wydajność modelu, poprawiając postrzeganie dźwięku wejściowego.	Nr
└typ	wyliczenie	Typ redukcji szumu. near_field jest przeznaczony dla mikrofonów z bliska, takich jak słuchawki, jest przeznaczony dla mikrofonów dalekiego pola, far_field takich jak laptop lub mikrofony sali konferencyjnej. Możliwe wartości: near_field, far_field	Nr
input_audio_transcription	obiekt	Konfiguracja transkrypcji dźwięku wejściowego. Klient może opcjonalnie ustawić język i monitować o transkrypcję. Oferują one dodatkowe wskazówki dotyczące usługi transkrypcji.	Nr
└* język	ciąg	Język wejściowego dźwięku. Dostarczanie języka wejściowego w formacie ISO-639-1 (np. en) zwiększa dokładność i opóźnienie.	Nr
Model └*	wyliczenie	Model używany do transkrypcji, bieżące opcje to gpt-4o-transcribe, gpt-4o-mini-transcribe, gpt-4o-mini-transcribe-2025-12-15i whisper-1. Możliwe wartości: gpt-4o-transcribe, , gpt-4o-mini-transcribe, gpt-4o-mini-transcribe-2025-12-15whisper-1	Nr
Monit └*	ciąg	Opcjonalny tekst prowadzący do stylu modelu lub kontynuacji poprzedniego segmentu audio. W przypadku whisper-1polecenia jest to lista słów kluczowych. W przypadku gpt-4o-transcribe modeli monit jest wolnym ciągiem tekstowym, na przykład "oczekiwano słów związanych z technologią".	Nr
Sposoby		Zestaw modalności, za pomocą których model może reagować. Aby wyłączyć dźwięk, ustaw wartość ["text"].	Nr
turn_detection	obiekt	Konfiguracja wykrywania kolei, eter Server VAD lub Semantic VAD. Można to ustawić tak, aby null wyłączyć, w takim przypadku klient musi ręcznie wyzwolić odpowiedź modelu. Funkcja VAD serwera oznacza, że model wykryje początek i koniec mowy na podstawie głośności audio i odpowie na końcu mowy użytkownika. Semantyczna funkcja VAD jest bardziej zaawansowana i używa modelu wykrywania obrotu (w połączeniu z vaD), aby semantycznie oszacować, czy użytkownik zakończył mówić, a następnie dynamicznie ustawia limit czasu na podstawie tego prawdopodobieństwa. Jeśli na przykład użytkownik wybiegnie ścieżki audio z uhhmużyciem metody , model będzie oceniać niskie prawdopodobieństwo włączenia i poczekać dłużej na kontynuowanie mówienia przez użytkownika. Może to być przydatne w przypadku bardziej naturalnych rozmów, ale może mieć większe opóźnienie.	Nr
└create_response	Boolean	Określa, czy ma być automatycznie generowany odpowiedź po wystąpieniu zdarzenia zatrzymania vaD. Niedostępne dla sesji transkrypcji.	Nr	True
└* gotowość	wyliczenie	Używane tylko w semantic_vad trybie. Gotowość modelu do reagowania. low będzie czekać dłużej, aż użytkownik będzie nadal mówić, high będzie reagować szybciej. auto jest wartością domyślną i jest odpowiednikiem medium. Możliwe wartości: low, , medium, highauto	Nr
└interrupt_response	Boolean	Określa, czy automatycznie przerywać bieżącą odpowiedź z danymi wyjściowymi domyślnej konwersacji (tj. conversation ) po wystąpieniu autozdarzenia rozpoczęcia vaD. Niedostępne dla sesji transkrypcji.	Nr	True
└prefix_padding_ms	liczba całkowita	Używane tylko w server_vad trybie. Ilość dźwięku do uwzględnienia przed wykryciem mowy vaD (w milisekundach). Wartość domyślna to 300 ms.	Nr
└silence_duration_ms	liczba całkowita	Używane tylko w server_vad trybie. Czas trwania ciszy wykrywania zatrzymania mowy (w milisekundach). Wartość domyślna to 500 ms. Dzięki krótszym wartościom model będzie reagować szybciej, ale może wskoczyć na krótkie przerwy od użytkownika.	Nr
└* próg	Numer	Używane tylko w server_vad trybie. Próg aktywacji dla usługi VAD (od 0.0 do 1.0) domyślnie wynosi 0,5. Wyższy próg będzie wymagać głośniejszego dźwięku do aktywowania modelu, a tym samym może działać lepiej w hałaśliwych środowiskach.	Nr
└typ	wyliczenie	Typ wykrywania kolei. Możliwe wartości: server_vad, semantic_vad	Nr

Odpowiedzi

Kod stanu: 200

Opis: Sesja została pomyślnie utworzona.

Typ zawartości	Typu	Opis
application/json	RealtimeTranscriptionSessionCreateResponse

Odpowiedzi

POST https://{endpoint}/openai/responses?api-version=2025-04-01-preview

Tworzy odpowiedź modelu.

Treść żądania

Typ zawartości: application/json

Nazwa	Typ	Opis	Wymagane	Domyślny
Obejmują	macierz		Nr
dane wejściowe	ciąg lub tablica	Dane wejściowe modelu	Tak
Instrukcje	ciąg	Wstawia komunikat systemu (lub dewelopera) jako pierwszy element w kontekście modelu. W przypadku używania polecenia wraz z instrukcjami previous_response_idz poprzedniej odpowiedzi nie zostaną przeniesione do następnej odpowiedzi. Ułatwia to zamianę komunikatów systemowych (lub deweloperów) w nowych odpowiedziach.	Nr
max_output_tokens	liczba całkowita	Górna granica liczby tokenów, które można wygenerować dla odpowiedzi, w tym widoczne tokeny wyjściowe i stan konwersacji.	Nr
parallel_tool_calls	Boolean	Czy zezwolić modelowi na równoległe uruchamianie wywołań narzędzi.	Nr	True
previous_response_id	ciąg	Unikatowy identyfikator poprzedniej odpowiedzi na model. Użyj tej funkcji, aby utworzyć konwersacje wieloetowe. Dowiedz się więcej o stanie konwersacji.	Nr
Rozumowanie	Rozumowanie	Opcje konfiguracji dla modeli rozumowania.	Nr
przechowywać	Boolean	Określa, czy przechowywać wygenerowaną odpowiedź modelu na potrzeby późniejszego pobierania za pośrednictwem interfejsu API.	Nr	True
odtwarzać strumieniowo	Boolean	W przypadku ustawienia wartości true dane odpowiedzi modelu będą przesyłane strumieniowo do klienta, ponieważ są generowane przy użyciu zdarzeń wysyłanych przez serwer. Aby uzyskać więcej informacji, zobacz sekcję Przesyłanie strumieniowe poniżej.	Nr	False
SMS	obiekt	Opcje konfiguracji odpowiedzi tekstowej z modelu. Może to być zwykły tekst lub dane JSON ze strukturą. Dowiedz się więcej: - Wprowadzanie tekstu i dane wyjściowe - Dane wyjściowe ze strukturą	Nr
Format └*	TextResponseFormatConfiguration	Obiekt określający format, który musi zostać wygenerowany przez model. Konfigurowanie { "type": "json_schema" } umożliwia korzystanie ze strukturowych danych wyjściowych, co zapewnia, że model jest zgodny ze podanym schematem JSON. Format domyślny nie ma { "type": "text" } żadnych dodatkowych opcji. Niezalecane w przypadku modeli gpt-4o i nowszych: Ustawienie w celu { "type": "json_object" } włączenia starszego trybu JSON, co gwarantuje, że komunikat generowany przez model jest prawidłowym kodem JSON. Użycie json_schema jest preferowane w przypadku modeli, które go obsługują.	Nr
tool_choice	ToolChoiceOptions lub ToolChoiceTypes lub ToolChoiceFunction	W jaki sposób model powinien wybrać narzędzie (lub narzędzia), które ma być używane podczas generowania odpowiedzi. Zobacz parametr , tools aby zobaczyć, jak określić narzędzia, które może wywołać model.	Nr
Narzędzia	macierz	Tablica narzędzi, które model może wywołać podczas generowania odpowiedzi. Możesz określić, którego narzędzia użyć, ustawiając tool_choice parametr . Dwie kategorie narzędzi, które można podać, to: - Wbudowane narzędzia: narzędzia dostarczane przez usługę OpenAI, które rozszerzają możliwości modelu	Nr
Obcinania	wyliczenie	Strategia obcinania do użycia dla odpowiedzi modelu. - auto: Jeśli kontekst tej odpowiedzi i poprzednich przekroczy rozmiar okna kontekstu modelu, model obcina odpowiedź, aby dopasować okno kontekstu, upuszczając elementy wejściowe w środku konwersacji. - disabled (ustawienie domyślne): Jeśli odpowiedź modelu przekroczy rozmiar okna kontekstu dla modelu, żądanie zakończy się niepowodzeniem z powodu błędu 400. Możliwe wartości: auto, disabled	Nr

Odpowiedzi

Kod stanu: 200

Opis: OK

Typ zawartości	Typu	Opis
application/json	Odpowiedzi
tekst/strumień zdarzeń	responseStreamEvent

Kod stanu: wartość domyślna

Opis: Usługa niedostępna

Typ zawartości	Typu	Opis
application/json	errorResponse

Interfejs API odpowiedzi — elementy wejściowe

GET https://{endpoint}/openai/responses/{response_id}?api-version=2025-04-01-preview

Pobiera odpowiedź modelu z danym identyfikatorem.

Parametry identyfikatora URI

Nazwa	Cala	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	adres URL ciągu	Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, na przykład: https://aoairesource.openai.azure.com. Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI. https://{nazwa_zasobu}.openai.azure.com
response_id	ścieżka	Tak	ciąg	Identyfikator odpowiedzi do pobrania.
Obejmują	kwerenda	Nr	macierz	Dodatkowe pola do uwzględnienia w odpowiedzi. include Aby uzyskać więcej informacji, zobacz parametr tworzenia odpowiedzi powyżej.

Nagłówek żądania

Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.

Nazwa	Wymagane	Typ	Opis
Autoryzacji	True	ciąg	Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize Zakres: https://ai.azure.com/.default
api-key	True	ciąg	Tutaj podaj klucz interfejsu API usługi Azure OpenAI

Odpowiedzi

Kod stanu: 200

Opis: OK

Typ zawartości	Typu	Opis
application/json	Odpowiedzi

Kod stanu: wartość domyślna

Opis: Usługa niedostępna

Typ zawartości	Typu	Opis
application/json	errorResponse

Usuń odpowiedź

DELETE https://{endpoint}/openai/responses/{response_id}?api-version=2025-04-01-preview

Usuwa odpowiedź modelu z danym identyfikatorem.

Parametry identyfikatora URI

Nazwa	Cala	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	adres URL ciągu	Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, na przykład: https://aoairesource.openai.azure.com. Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI. https://{nazwa_zasobu}.openai.azure.com
response_id	ścieżka	Tak	ciąg	Identyfikator odpowiedzi do usunięcia.

Nagłówek żądania

Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.

Nazwa	Wymagane	Typ	Opis
Autoryzacji	True	ciąg	Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize Zakres: https://ai.azure.com/.default
api-key	True	ciąg	Tutaj podaj klucz interfejsu API usługi Azure OpenAI

Odpowiedzi

Kod stanu: 200

Opis: OK

Kod stanu: 404

Opis: Nie znaleziono

Typ zawartości	Typu	Opis
application/json	Błąd

Kod stanu: wartość domyślna

Opis: Usługa niedostępna

Typ zawartości	Typu	Opis
application/json	errorResponse

Interfejs API odpowiedzi — lista elementów odpowiedzi

GET https://{endpoint}/openai/responses/{response_id}/input_items?api-version=2025-04-01-preview

Zwraca listę elementów wejściowych dla danej odpowiedzi.

Parametry identyfikatora URI

Nazwa	Cala	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	adres URL ciągu	Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, na przykład: https://aoairesource.openai.azure.com. Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI. https://{nazwa_zasobu}.openai.azure.com
response_id	ścieżka	Tak	ciąg	Identyfikator odpowiedzi na pobieranie elementów wejściowych.
Limit	kwerenda	Nr	liczba całkowita	Limit liczby zwracanych obiektów. Limit może mieścić się w zakresie od 1 do 100, a wartość domyślna to 20.
porządek	kwerenda	Nr	ciąg Możliwe wartości: asc, desc	Kolejność zwracania elementów wejściowych. Wartość domyślna to asc. - asc: Zwraca elementy wejściowe w kolejności rosnącej. - desc: Zwraca elementy wejściowe w kolejności malejącej.
Po	kwerenda	Nr	ciąg	Identyfikator elementu do wyświetlania listy elementów po, używany w stronicowaniu.
Przed	kwerenda	Nr	ciąg	Identyfikator elementu do wyświetlania listy elementów wcześniej używany w stronicowaniu.

Nagłówek żądania

Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.

Nazwa	Wymagane	Typ	Opis
Autoryzacji	True	ciąg	Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize Zakres: https://ai.azure.com/.default
api-key	True	ciąg	Tutaj podaj klucz interfejsu API usługi Azure OpenAI

Odpowiedzi

Kod stanu: 200

Opis: OK

Typ zawartości	Typu	Opis
application/json	responseItemList

Składniki

errorResponse

Nazwa	Typ	Opis	Wymagane	Domyślny
błąd	Błąd		Nr

errorBase

Nazwa	Typ	Opis	Wymagane	Domyślny
kod	ciąg		Nr
komunikat	ciąg		Nr

błąd

Nazwa	Typ	Opis	Wymagane	Domyślny
inner_error	innerError	Wewnętrzny błąd z dodatkowymi szczegółami.	Nr
Param	ciąg		Nr
typ	ciąg		Nr

innerError

Wewnętrzny błąd z dodatkowymi szczegółami.

Nazwa	Typ	Opis	Wymagane	Domyślny
kod	innerErrorCode	Kody błędów dla obiektu błędu wewnętrznego.	Nr
content_filter_results	contentFilterPromptResults	Informacje o kategorii filtrowania zawartości (nienawiść, przemoc seksualna, przemoc, self_harm), jeśli została wykryta, a także poziom ważności (very_low, niski, średni, wysoki, który określa intensywność i poziom ryzyka szkodliwej zawartości) i czy został przefiltrowany, czy nie. Informacje o zawartości jailbreaku i wulgaryzmach, jeśli zostały wykryte i czy zostały odfiltrowane, czy nie. Informacje o liście zablokowanych klientów, jeśli zostały odfiltrowane i jej identyfikator.	Nr

innerErrorCode

Kody błędów dla obiektu błędu wewnętrznego.

Właściwość	Wartość
Opis	Kody błędów dla obiektu błędu wewnętrznego.
Typu	ciąg
Wartości	ResponsibleAIPolicyViolation

dalleErrorResponse

Nazwa	Typ	Opis	Wymagane	Domyślny
błąd	dalleError		Nr

dalleError

Nazwa	Typ	Opis	Wymagane	Domyślny
inner_error	dalleInnerError	Wewnętrzny błąd z dodatkowymi szczegółami.	Nr
Param	ciąg		Nr
typ	ciąg		Nr

dalleInnerError

Wewnętrzny błąd z dodatkowymi szczegółami.

Nazwa	Typ	Opis	Wymagane	Domyślny
kod	innerErrorCode	Kody błędów dla obiektu błędu wewnętrznego.	Nr
content_filter_results	dalleFilterResults	Informacje o kategorii filtrowania zawartości (nienawiść, przemoc seksualna, przemoc, self_harm), jeśli została wykryta, a także poziom ważności (very_low, niski, średni, wysoki, który określa intensywność i poziom ryzyka szkodliwej zawartości) i czy został przefiltrowany, czy nie. Informacje o zawartości jailbreaku i wulgaryzmach, jeśli zostały wykryte i czy zostały odfiltrowane, czy nie. Informacje o liście zablokowanych klientów, jeśli zostały odfiltrowane i jej identyfikator.	Nr
revised_prompt	ciąg	Monit, który został użyty do wygenerowania obrazu, jeśli wystąpiła jakakolwiek poprawka do monitu.	Nr

contentFilterCompletionTextSpan

Opisuje zakres w wygenerowanym tekście uzupełniania. Przesunięcie 0 jest pierwszym punktem kodu UTF32 tekstu ukończenia.

Nazwa	Typ	Opis	Wymagane	Domyślny
completion_end_offset	liczba całkowita	Przesunięcie pierwszego punktu kodu UTF32, który jest wykluczony z zakresu. To pole jest zawsze równe completion_start_offset dla pustych zakresów. To pole jest zawsze większe niż completion_start_offset dla niepustych zakresów.	Tak
completion_start_offset	liczba całkowita	Przesunięcie punktu kodu UTF32, który rozpoczyna zakres.	Tak

contentFilterResultBase

Nazwa	Typ	Opis	Wymagane	Domyślny
Filtrowane	Boolean		Tak

contentFilterSeverityResult

Nazwa	Typ	Opis	Wymagane	Domyślny
Filtrowane	Boolean		Tak
Ważności	ciąg		Nr

contentFilterDetectedResult

Nazwa	Typ	Opis	Wymagane	Domyślny
Wykryte	Boolean		Nr
Filtrowane	Boolean		Tak

contentFilterDetectedWithCitationResult

Nazwa	Typ	Opis	Wymagane	Domyślny
Cytat	obiekt		Nr
└* adres URL	ciąg		Nr
Licencja └*	ciąg		Nr

contentFilterDetectedWithCompletionTextSpansResult

Nazwa	Typ	Opis	Wymagane	Domyślny
Szczegóły	macierz		Nr

contentFilterIdResult

Nazwa	Typ	Opis	Wymagane	Domyślny
Filtrowane	Boolean		Tak
Identyfikator	ciąg		Nr

contentFilterResultsBase

Informacje o wynikach filtrowania zawartości.

Nazwa	Typ	Opis	Wymagane	Domyślny
custom_blocklists	contentFilterDetailedResults	Wyniki filtrowania zawartości ze szczegółowymi identyfikatorami filtrów zawartości dla filtrowanych segmentów.	Nr
błąd	errorBase		Nr
Nienawidzić	contentFilterSeverityResult		Nr
Wulgaryzmów	contentFilterDetectedResult		Nr
self_harm	contentFilterSeverityResult		Nr
Seksualne	contentFilterSeverityResult		Nr
Przemocy	contentFilterSeverityResult		Nr

contentFilterPromptResults

Informacje o kategorii filtrowania zawartości (nienawiść, przemoc seksualna, przemoc, self_harm), jeśli została wykryta, a także poziom ważności (very_low, niski, średni, wysoki, który określa intensywność i poziom ryzyka szkodliwej zawartości) i czy został przefiltrowany, czy nie. Informacje o zawartości jailbreaku i wulgaryzmach, jeśli zostały wykryte i czy zostały odfiltrowane, czy nie. Informacje o liście zablokowanych klientów, jeśli zostały odfiltrowane i jej identyfikator.

Nazwa	Typ	Opis	Wymagane	Domyślny
custom_blocklists	contentFilterDetailedResults	Wyniki filtrowania zawartości ze szczegółowymi identyfikatorami filtrów zawartości dla filtrowanych segmentów.	Nr
błąd	errorBase		Nr
Nienawidzić	contentFilterSeverityResult		Nr
indirect_attack	contentFilterDetectedResult		Nr
Jailbreak	contentFilterDetectedResult		Nr
Wulgaryzmów	contentFilterDetectedResult		Nr
self_harm	contentFilterSeverityResult		Nr
Seksualne	contentFilterSeverityResult		Nr
Przemocy	contentFilterSeverityResult		Nr

contentFilterChoiceResults

Informacje o kategorii filtrowania zawartości (nienawiść, przemoc seksualna, przemoc, self_harm), jeśli została wykryta, a także poziom ważności (very_low, niski, średni, wysoki, który określa intensywność i poziom ryzyka szkodliwej zawartości) i czy został przefiltrowany, czy nie. Informacje o tekście i wulgaryzmach innych firm, jeśli zostały wykryte i czy zostały odfiltrowane, czy nie. Informacje o liście zablokowanych klientów, jeśli zostały odfiltrowane i jej identyfikator.

Nazwa	Typ	Opis	Wymagane	Domyślny
custom_blocklists	contentFilterDetailedResults	Wyniki filtrowania zawartości ze szczegółowymi identyfikatorami filtrów zawartości dla filtrowanych segmentów.	Nr
błąd	errorBase		Nr
Nienawidzić	contentFilterSeverityResult		Nr
Wulgaryzmów	contentFilterDetectedResult		Nr
protected_material_code	contentFilterDetectedWithCitationResult		Nr
protected_material_text	contentFilterDetectedResult		Nr
self_harm	contentFilterSeverityResult		Nr
Seksualne	contentFilterSeverityResult		Nr
ungrounded_material	contentFilterDetectedWithCompletionTextSpansResult		Nr
Przemocy	contentFilterSeverityResult		Nr

contentFilterDetailedResults

Wyniki filtrowania zawartości ze szczegółowymi identyfikatorami filtrów zawartości dla filtrowanych segmentów.

Nazwa	Typ	Opis	Wymagane	Domyślny
Szczegóły	macierz		Nr
Filtrowane	Boolean		Tak

promptFilterResult

Wyniki filtrowania zawartości dla pojedynczego monitu w żądaniu.

Nazwa	Typ	Opis	Wymagane	Domyślny
content_filter_results	contentFilterPromptResults	Informacje o kategorii filtrowania zawartości (nienawiść, przemoc seksualna, przemoc, self_harm), jeśli została wykryta, a także poziom ważności (very_low, niski, średni, wysoki, który określa intensywność i poziom ryzyka szkodliwej zawartości) i czy został przefiltrowany, czy nie. Informacje o zawartości jailbreaku i wulgaryzmach, jeśli zostały wykryte i czy zostały odfiltrowane, czy nie. Informacje o liście zablokowanych klientów, jeśli zostały odfiltrowane i jej identyfikator.	Nr
prompt_index	liczba całkowita		Nr

promptFilterResults

Wyniki filtrowania zawartości dla zera lub większej liczby monitów w żądaniu. W żądaniu przesyłania strumieniowego wyniki dla różnych monitów mogą pojawiać się w różnych porach lub w różnych zamówieniach.

Brak zdefiniowanych właściwości dla tego składnika.

dalleContentFilterResults

Informacje o wynikach filtrowania zawartości.

Nazwa	Typ	Opis	Wymagane	Domyślny
Nienawidzić	contentFilterSeverityResult		Nr
self_harm	contentFilterSeverityResult		Nr
Seksualne	contentFilterSeverityResult		Nr
Przemocy	contentFilterSeverityResult		Nr

dalleFilterResults

Informacje o kategorii filtrowania zawartości (nienawiść, przemoc seksualna, przemoc, self_harm), jeśli została wykryta, a także poziom ważności (very_low, niski, średni, wysoki, który określa intensywność i poziom ryzyka szkodliwej zawartości) i czy został przefiltrowany, czy nie. Informacje o zawartości jailbreaku i wulgaryzmach, jeśli zostały wykryte i czy zostały odfiltrowane, czy nie. Informacje o liście zablokowanych klientów, jeśli zostały odfiltrowane i jej identyfikator.

Nazwa	Typ	Opis	Wymagane	Domyślny
custom_blocklists	contentFilterDetailedResults	Wyniki filtrowania zawartości ze szczegółowymi identyfikatorami filtrów zawartości dla filtrowanych segmentów.	Nr
Nienawidzić	contentFilterSeverityResult		Nr
Jailbreak	contentFilterDetectedResult		Nr
Wulgaryzmów	contentFilterDetectedResult		Nr
self_harm	contentFilterSeverityResult		Nr
Seksualne	contentFilterSeverityResult		Nr
Przemocy	contentFilterSeverityResult		Nr

chatCompletionsRequestCommon

Nazwa	Typ	Opis	Wymagane	Domyślny
frequency_penalty	Numer	Liczba z zakresu od -2.0 do 2.0. Wartości dodatnie karzeją nowe tokeny na podstawie ich istniejącej częstotliwości w tekście do tej pory, zmniejszając prawdopodobieństwo powtórzeń tego samego wiersza.	Nr	0
logit_bias	obiekt	Zmodyfikuj prawdopodobieństwo wyświetlania określonych tokenów w zakończeniu. Akceptuje obiekt JSON mapujący tokeny (określone przez ich identyfikator tokenu w tokenizatorze) na skojarzzoną wartość stronniczą z -100 do 100. Matematycznie stronniczy jest dodawany do logitów wygenerowanych przez model przed próbkowaniem. Dokładny efekt różni się w zależności od modelu, ale wartości między -1 a 1 powinny zmniejszyć lub zwiększyć prawdopodobieństwo wyboru; wartości takie jak -100 lub 100 powinny spowodować zakaz lub wyłączny wybór odpowiedniego tokenu.	Nr
max_completion_tokens	liczba całkowita	Górna granica liczby tokenów, które można wygenerować na potrzeby ukończenia, w tym widoczne tokeny wyjściowe i tokeny rozumowania.	Nr
max_tokens	liczba całkowita	Maksymalna liczba tokenów dozwolonych dla wygenerowanej odpowiedzi. Domyślnie liczba tokenów, które może zwrócić model, to (4096 — tokeny monitu). Nie jest to zgodne z modelami serii o1.	Nr	4096
metadane	obiekt	Tagi i wartości zdefiniowane przez dewelopera używane do filtrowania uzupełniania na pulpicie nawigacyjnym przechowywanych uzupełniania.	Nr
presence_penalty	Numer	Liczba z zakresu od -2.0 do 2.0. Wartości dodatnie karzą nowe tokeny na podstawie tego, czy są one wyświetlane w tekście do tej pory, zwiększając prawdopodobieństwo, że model będzie mówił o nowych tematach.	Nr	0
Zatrzymać	ciąg lub tablica	Maksymalnie 4 sekwencje, w których interfejs API przestaje generować kolejne tokeny.	Nr
przechowywać	Boolean	Niezależnie od tego, czy dane wyjściowe tego żądania ukończenia czatu mają być używane w naszych produktach destylacyjnych lub ewaluacyjnych modelu.	Nr
odtwarzać strumieniowo	Boolean	W przypadku ustawienia są wysyłane częściowe różnice komunikatów, na przykład w module ChatGPT. Tokeny są wysyłane jako zdarzenia wysyłane tylko do serwera w miarę data: [DONE] ich dostępności, a strumień jest przerywany przez komunikat.	Nr	False
Temperatury	Numer	Jaka temperatura próbkowania ma być używana z zakresu od 0 do 2. Wyższe wartości, takie jak 0,8, sprawią, że dane wyjściowe będą bardziej losowe, a niższe wartości, takie jak 0,2, sprawią, że będzie bardziej skoncentrowany i deterministyczny. Ogólnie zalecamy zmianę tego lub top_p nie obu tych elementów.	Nr	1
top_p	Numer	Alternatywą dla próbkowania z temperaturą, nazywaną próbkowaniem jądra, gdzie model uwzględnia wyniki tokenów z top_p masą prawdopodobieństwa. Dlatego 0,1 oznacza, że uwzględniane są tylko tokeny składające się z 10 pierwszych% masy prawdopodobieństwa. Ogólnie zalecamy zmianę tego lub temperature nie obu tych elementów.	Nr	1
użytkownik	ciąg	Unikatowy identyfikator reprezentujący użytkownika końcowego, który może pomóc usłudze Azure OpenAI w monitorowaniu i wykrywaniu nadużyć.	Nr

createCompletionRequest

Nazwa	Typ	Opis	Wymagane	Domyślny
best_of	liczba całkowita	Generuje uzupełnianie best_of po stronie serwera i zwraca wartość "best" (jedyną z najwyższym prawdopodobieństwem dziennika na token). Nie można przesyłać strumieniowo wyników. W przypadku użycia z nprogramem best_of określa liczbę ukończonych kandydatów i n określa liczbę zwracanych elementów. best_of wartość musi być większa niż n. Uwaga: Ponieważ ten parametr generuje wiele uzupełniania, może szybko korzystać z limitu przydziału tokenu. Należy ostrożnie używać i upewnić się, że masz odpowiednie ustawienia dla max_tokens i stop.	Nr	1
Echo	Boolean	Powtórz ponownie monit oprócz ukończenia	Nr	False
frequency_penalty	Numer	Liczba z zakresu od -2.0 do 2.0. Wartości dodatnie karzeją nowe tokeny na podstawie ich istniejącej częstotliwości w tekście do tej pory, zmniejszając prawdopodobieństwo powtórzeń tego samego wiersza.	Nr	0
logit_bias	obiekt	Zmodyfikuj prawdopodobieństwo wyświetlania określonych tokenów w zakończeniu. Akceptuje obiekt JSON, który mapuje tokeny (określone przez ich identyfikator tokenu w tokenizer GPT) do skojarzonej wartości stronniczej z -100 do 100. Matematycznie stronniczy jest dodawany do logitów wygenerowanych przez model przed próbkowaniem. Dokładny efekt różni się w zależności od modelu, ale wartości między -1 a 1 powinny zmniejszyć lub zwiększyć prawdopodobieństwo wyboru; wartości takie jak -100 lub 100 powinny spowodować zakaz lub wyłączny wybór odpowiedniego tokenu. Na przykład możesz przekazać polecenie {"50256": -100} , aby zapobiec wygenerowaniu tokenu <|endoftext|> .	Nr	Brak
logprobs	liczba całkowita	Uwzględnij prawdopodobieństwa dziennika dla logprobs najbardziej prawdopodobnych tokenów wyjściowych, a także wybrane tokeny. Na przykład jeśli logprobs ma wartość 5, interfejs API zwróci listę 5 najbardziej prawdopodobnych tokenów. Interfejs API zawsze zwraca logprob przykładowy token, więc może istnieć maksymalnie logprobs+1 elementy w odpowiedzi. Maksymalna wartość parametru logprobs to 5.	Nr	Brak
max_tokens	liczba całkowita	Maksymalna liczba tokenów, które można wygenerować w zakończeniu. Liczba tokenów monitu plus max_tokens nie może przekraczać długości kontekstu modelu.	Nr	16
N	liczba całkowita	Ile uzupełniania ma być generowanych dla każdego monitu. Uwaga: Ponieważ ten parametr generuje wiele uzupełniania, może szybko korzystać z limitu przydziału tokenu. Należy ostrożnie używać i upewnić się, że masz odpowiednie ustawienia dla max_tokens i stop.	Nr	1
presence_penalty	Numer	Liczba z zakresu od -2.0 do 2.0. Wartości dodatnie karzą nowe tokeny na podstawie tego, czy są one wyświetlane w tekście do tej pory, zwiększając prawdopodobieństwo, że model będzie mówił o nowych tematach.	Nr	0
monit	ciąg lub tablica	Monity dotyczące generowania uzupełniania dla ciągów, tablicy ciągów, tablicy tokenów, tablicy tokenów lub tablicy tablicy tokenów. Należy pamiętać, że <|endoftext|> jest separatorem dokumentu, który widzi model podczas trenowania, więc jeśli monit nie zostanie określony, model zostanie wygenerowany tak, jakby od początku nowego dokumentu.	Tak
Nasion	liczba całkowita	Jeśli zostanie określony, nasz system dokłada wszelkich starań, aby próbkować deterministycznie, tak aby powtarzające się żądania z tymi samymi seed parametrami i zwracały ten sam wynik. Determinizm nie jest gwarantowany i należy odwołać się do parametru system_fingerprint odpowiedzi w celu monitorowania zmian w zapleczu.	Nr
Zatrzymać	ciąg lub tablica	Maksymalnie 4 sekwencje, w których interfejs API przestaje generować kolejne tokeny. Zwrócony tekst nie będzie zawierać sekwencji zatrzymania.	Nr
odtwarzać strumieniowo	Boolean	Czy przesyłać strumieniowo częściowy postęp. W przypadku ustawienia tokeny są wysyłane jako zdarzenia wysyłane tylko do serwera, gdy staną się dostępne, a strumień zostanie zakończony komunikatem data: [DONE] . Przykładowy kod języka Python.	Nr	False
Sufiks	ciąg	Sufiks, który pojawia się po zakończeniu wstawionego tekstu. Ten parametr jest obsługiwany tylko dla programu gpt-3.5-turbo-instruct.	Nr	Brak
Temperatury	Numer	Jaka temperatura próbkowania ma być używana z zakresu od 0 do 2. Wyższe wartości, takie jak 0,8, sprawią, że dane wyjściowe będą bardziej losowe, a niższe wartości, takie jak 0,2, sprawią, że będzie bardziej skoncentrowany i deterministyczny. Ogólnie zalecamy zmianę tego lub top_p nie obu tych elementów.	Nr	1
top_p	Numer	Alternatywą dla próbkowania z temperaturą, nazywaną próbkowaniem jądra, gdzie model uwzględnia wyniki tokenów z top_p masą prawdopodobieństwa. Dlatego 0,1 oznacza, że uwzględniane są tylko tokeny składające się z 10 pierwszych% masy prawdopodobieństwa. Ogólnie zalecamy zmianę tego lub temperature nie obu tych elementów.	Nr	1
użytkownik	ciąg	Unikatowy identyfikator reprezentujący użytkownika końcowego, który może pomóc w monitorowaniu i wykrywaniu nadużyć.	Nr

createCompletionResponse

Reprezentuje odpowiedź ukończenia z interfejsu API. Uwaga: zarówno przesyłane strumieniowo, jak i nie przesyłane strumieniowo obiekty odpowiedzi mają ten sam kształt (w przeciwieństwie do punktu końcowego czatu).

Nazwa	Typ	Opis	Wymagane	Domyślny
Wyborów	macierz	Lista opcji uzupełniania dla modelu wygenerowanego dla monitu wejściowego.	Tak
Utworzone	liczba całkowita	Sygnatura czasowa systemu Unix (w sekundach) czasu utworzenia ukończenia.	Tak
Identyfikator	ciąg	Unikatowy identyfikator ukończenia.	Tak
model	ciąg	Model używany do ukończenia.	Tak
obiekt	wyliczenie	Typ obiektu, który jest zawsze "text_completion" Możliwe wartości: text_completion	Tak
prompt_filter_results	promptFilterResults	Wyniki filtrowania zawartości dla zera lub większej liczby monitów w żądaniu. W żądaniu przesyłania strumieniowego wyniki dla różnych monitów mogą pojawiać się w różnych porach lub w różnych zamówieniach.	Nr
system_fingerprint	ciąg	Ten odcisk palca reprezentuje konfigurację zaplecza, z którą działa model. Można użyć w połączeniu z parametrem seed żądania, aby zrozumieć, kiedy wprowadzono zmiany zaplecza, które mogą mieć wpływ na determinizm.	Nr
użycie	completionUsage	Statystyki użycia dla żądania ukończenia.	Nr

createChatCompletionRequest

Nazwa	Typ	Opis	Wymagane	Domyślny
Audio	obiekt	Parametry dla danych wyjściowych dźwięku. Wymagane w przypadku żądania danych wyjściowych dźwięku za pomocą polecenia modalities: ["audio"].	Nr
Format └*	wyliczenie	Określa format dźwięku wyjściowego. Musi być jednym z wavelementów , mp3, flac, opuslub pcm16. Możliwe wartości: wav, , mp3flac, , opuspcm16	Nr
└* głos	wyliczenie	Określa typ głosu. Obsługiwane głosy to alloy, , echo, fableonyx, nova, i shimmer. Możliwe wartości: alloy, , echofable, onyx, , novashimmer	Nr
data_sources	macierz	Wpisy konfiguracji dla rozszerzeń czatu usługi Azure OpenAI, które ich używają. Ta dodatkowa specyfikacja jest zgodna tylko z usługą Azure OpenAI.	Nr
frequency_penalty	Numer	Liczba z zakresu od -2.0 do 2.0. Wartości dodatnie karzeją nowe tokeny na podstawie ich istniejącej częstotliwości w tekście do tej pory, zmniejszając prawdopodobieństwo powtórzeń tego samego wiersza.	Nr	0
function_call	ciąg lub czatCompletionFunctionCallOption	Przestarzałe na rzecz .tool_choice Określa, która (jeśli istnieje) funkcja jest wywoływana przez model. none oznacza, że model nie wywoła funkcji, a zamiast tego generuje komunikat. auto oznacza, że model może wybierać między generowaniem komunikatu lub wywoływaniem funkcji. Określenie określonej funkcji za pośrednictwem {"name": "my_function"} wymusza wywołanie tej funkcji przez model. none jest wartością domyślną, gdy nie ma żadnych funkcji. auto jest wartością domyślną, jeśli funkcje są obecne.	Nr
Funkcje	macierz	Przestarzałe na rzecz .tools Lista funkcji, dla których model może generować dane wejściowe JSON.	Nr
logit_bias	obiekt	Zmodyfikuj prawdopodobieństwo wyświetlania określonych tokenów w zakończeniu. Akceptuje obiekt JSON mapujący tokeny (określone przez ich identyfikator tokenu w tokenizatorze) na skojarzzoną wartość stronniczą z -100 do 100. Matematycznie stronniczy jest dodawany do logitów wygenerowanych przez model przed próbkowaniem. Dokładny efekt różni się w zależności od modelu, ale wartości między -1 a 1 powinny zmniejszyć lub zwiększyć prawdopodobieństwo wyboru; wartości takie jak -100 lub 100 powinny spowodować zakaz lub wyłączny wybór odpowiedniego tokenu.	Nr	Brak
logprobs	Boolean	Czy zwracać prawdopodobieństwo dziennika tokenów wyjściowych, czy nie. Jeśli wartość true, zwraca prawdopodobieństwo dziennika każdego tokenu wyjściowego zwróconego w elemecie contentmessage.	Nr	False
max_completion_tokens	liczba całkowita	Górna granica liczby tokenów, które można wygenerować na potrzeby ukończenia, w tym widoczne tokeny wyjściowe i tokeny rozumowania.	Nr
max_tokens	liczba całkowita	Maksymalna liczba tokenów, które można wygenerować podczas kończenia czatu. Łączna długość tokenów wejściowych i wygenerowanych tokenów jest ograniczona przez długość kontekstu modelu.	Nr
Wiadomości	macierz	Lista wiadomości składających się z konwersacji do tej pory. Przykładowy kod języka Python.	Tak
metadane	obiekt	Tagi i wartości zdefiniowane przez dewelopera używane do filtrowania uzupełniania na pulpicie nawigacyjnym przechowywanych uzupełniania.	Nr
Sposoby	ChatCompletionModalities	Typy danych wyjściowych, które mają być generowane przez model dla tego żądania. Większość modeli jest w stanie wygenerować tekst, co jest wartością domyślną: ["text"] Model gpt-4o-audio-preview może również służyć do generowania dźwięku. Aby zażądać, aby ten model wygenerował odpowiedzi tekstowe i audio, możesz użyć: ["text", "audio"]	Nr
N	liczba całkowita	Ile opcji ukończenia czatu ma być generowanych dla każdej wiadomości wejściowej. Pamiętaj, że opłaty będą naliczane na podstawie liczby wygenerowanych tokenów we wszystkich opcjach. Zachowaj n , 1 aby zminimalizować koszty.	Nr	1
parallel_tool_calls	ParallelToolCalls	Czy włączyć równoległe wywoływanie funkcji podczas używania narzędzia.	Nr	True
przewidywanie	PredictionContent	Konfiguracja przewidywanych danych wyjściowych, która może znacznie poprawić czas odpowiedzi, gdy duże części odpowiedzi modelu są znane z wyprzedzeniem. Jest to najbardziej typowe w przypadku ponownego generowania pliku z tylko drobnymi zmianami w większości zawartości.	Nr
presence_penalty	Numer	Liczba z zakresu od -2.0 do 2.0. Wartości dodatnie karzą nowe tokeny na podstawie tego, czy są one wyświetlane w tekście do tej pory, zwiększając prawdopodobieństwo, że model będzie mówił o nowych tematach.	Nr	0
reasoning_effort	wyliczenie	Tylko modele o1 Ogranicza nakład pracy na rozumowanie modeli rozumowania. Obecnie obsługiwane wartości to low, mediumi high. Zmniejszenie nakładu pracy w zakresie rozumowania może spowodować szybsze reagowanie i mniej tokenów używanych podczas rozumowania w odpowiedzi. Możliwe wartości: low, , mediumhigh	Nr
response_format	ResponseFormatText lub ResponseFormatJsonObject lub ResponseFormatJsonSchema	Obiekt określający format, który musi zostać wygenerowany przez model. Zgodność z GPT-4o, GPT-4o mini, GPT-4 Turbo i wszystkimi modelami GPT-3.5 Turbo nowszymi niż gpt-3.5-turbo-1106. Ustawienie umożliwia { "type": "json_schema", "json_schema": {...} } włączenie danych wyjściowych ze strukturą, które gwarantują, że model jest zgodny z podanym schematem JSON. Ustawienie w celu { "type": "json_object" } włączenia trybu JSON, co gwarantuje, że komunikat generowany przez model jest prawidłowym kodem JSON. Ważne: w przypadku korzystania z trybu JSON należy również poinstruować model, aby samodzielnie wygenerował kod JSON za pośrednictwem komunikatu systemowego lub użytkownika. Bez tego model może wygenerować niekończący się strumień białych znaków, dopóki generowanie nie osiągnie limitu tokenu, co spowoduje długotrwałe i pozornie "zablokowane" żądanie. Należy również zauważyć, że zawartość wiadomości może być częściowo odcięta, jeśli finish_reason="length", co wskazuje, że generacja przekroczyła max_tokens lub konwersacja przekroczyła maksymalną długość kontekstu.	Nr
Nasion	liczba całkowita	Ta funkcja jest dostępna w wersji beta. Jeśli zostanie określony, nasz system dokłada wszelkich starań, aby próbkować deterministycznie, tak aby powtarzające się żądania z tymi samymi seed parametrami i zwracały ten sam wynik. Determinizm nie jest gwarantowany i należy odwołać się do parametru system_fingerprint odpowiedzi w celu monitorowania zmian w zapleczu.	Nr
Zatrzymać	ciąg lub tablica	Maksymalnie 4 sekwencje, w których interfejs API przestaje generować kolejne tokeny.	Nr
przechowywać	Boolean	Niezależnie od tego, czy dane wyjściowe tego żądania ukończenia czatu mają być używane w naszych produktach destylacyjnych lub ewaluacyjnych modelu.	Nr
odtwarzać strumieniowo	Boolean	W przypadku ustawienia są wysyłane częściowe różnice komunikatów, na przykład w module ChatGPT. Tokeny są wysyłane jako zdarzenia wysyłane tylko do serwera w miarę data: [DONE] ich dostępności, a strumień jest przerywany przez komunikat. Przykładowy kod języka Python.	Nr	False
stream_options	chatCompletionStreamOptions	Opcje odpowiedzi przesyłania strumieniowego. Ustaw tę wartość tylko po ustawieniu .stream: true	Nr	Brak
Temperatury	Numer	Jaka temperatura próbkowania ma być używana z zakresu od 0 do 2. Wyższe wartości, takie jak 0,8, sprawią, że dane wyjściowe będą bardziej losowe, a niższe wartości, takie jak 0,2, sprawią, że będzie bardziej skoncentrowany i deterministyczny. Ogólnie zalecamy zmianę tego lub top_p nie obu tych elementów.	Nr	1
tool_choice	chatCompletionToolChoiceOption	Określa, które narzędzie (jeśli istnieje) jest wywoływane przez model. none oznacza, że model nie wywoła żadnego narzędzia i zamiast tego generuje komunikat. auto oznacza, że model może wybierać między generowaniem komunikatu lub wywoływaniem co najmniej jednego narzędzia. required oznacza, że model musi wywoływać co najmniej jedno narzędzie. Określenie określonego narzędzia za pośrednictwem {"type": "function", "function": {"name": "my_function"}} wymusza wywołanie tego narzędzia przez model. none jest ustawieniem domyślnym, gdy żadne narzędzia nie są obecne. auto jest wartością domyślną, jeśli istnieją narzędzia.	Nr
Narzędzia	macierz	Lista narzędzi, które może wywołać model. Obecnie tylko funkcje są obsługiwane jako narzędzie. Służy do udostępniania listy funkcji, dla których model może generować dane wejściowe JSON. Obsługiwane są maksymalnie 128 funkcji.	Nr
top_logprobs	liczba całkowita	Liczba całkowita z zakresu od 0 do 20 określająca liczbę najbardziej prawdopodobnych tokenów do zwrócenia na każdej pozycji tokenu, z których każde ma skojarzone prawdopodobieństwo dziennika. logprobs musi być ustawiona na true wartość , jeśli ten parametr jest używany.	Nr
top_p	Numer	Alternatywą dla próbkowania z temperaturą, nazywaną próbkowaniem jądra, gdzie model uwzględnia wyniki tokenów z top_p masą prawdopodobieństwa. Dlatego 0,1 oznacza, że uwzględniane są tylko tokeny składające się z 10 pierwszych% masy prawdopodobieństwa. Ogólnie zalecamy zmianę tego lub temperature nie obu tych elementów.	Nr	1
użytkownik	ciąg	Unikatowy identyfikator reprezentujący użytkownika końcowego, który może pomóc w monitorowaniu i wykrywaniu nadużyć.	Nr
user_security_context	userSecurityContext	Kontekst zabezpieczeń użytkownika zawiera kilka parametrów opisujących samą aplikację sztucznej inteligencji oraz użytkownika końcowego, który wchodzi w interakcję z aplikacją sztucznej inteligencji. Te pola ułatwiają zespołom ds. operacji zabezpieczeń badanie i eliminowanie zdarzeń zabezpieczeń, zapewniając kompleksowe podejście do ochrony aplikacji sztucznej inteligencji. Dowiedz się więcej na temat ochrony aplikacji sztucznej inteligencji przy użyciu usługi Microsoft Defender dla Chmury.	Nr

userSecurityContext

Kontekst zabezpieczeń użytkownika zawiera kilka parametrów opisujących samą aplikację sztucznej inteligencji oraz użytkownika końcowego, który wchodzi w interakcję z aplikacją sztucznej inteligencji. Te pola ułatwiają zespołom ds. operacji zabezpieczeń badanie i eliminowanie zdarzeń zabezpieczeń, zapewniając kompleksowe podejście do ochrony aplikacji sztucznej inteligencji. Dowiedz się więcej na temat ochrony aplikacji sztucznej inteligencji przy użyciu usługi Microsoft Defender dla Chmury.

Nazwa	Typ	Opis	Wymagane	Domyślny
Nazwa_aplikacji	ciąg	Nazwa aplikacji. Poufne dane osobowe nie powinny być uwzględniane w tym polu.	Nr
end_user_id	ciąg	Ten identyfikator jest identyfikatorem obiektu użytkownika Entra ID firmy Microsoft (dawniej Azure Active Directory) używanym do uwierzytelniania użytkowników końcowych w aplikacji generującej sztuczną inteligencję. Poufne dane osobowe nie powinny być uwzględniane w tym polu.	Nr
end_user_tenant_id	ciąg	Identyfikator dzierżawy platformy Microsoft 365, do którego należy użytkownik końcowy. Jest to wymagane, gdy aplikacja generacyjna sztucznej inteligencji jest wielodostępna.	Nr
source_ip	ciąg	Przechwytuje adres IP oryginalnego klienta, akceptując zarówno formatY IPv4, jak i IPv6.	Nr

chatCompletionFunctions

Nazwa	Typ	Opis	Wymagane	Domyślny
Opis	ciąg	Opis działania funkcji używanej przez model do wyboru, kiedy i jak wywołać funkcję.	Nr
Nazwa	ciąg	Nazwa funkcji do wywołania. Musi być a-z, A-Z, 0-9 lub zawierać podkreślenia i kreski o maksymalnej długości 64.	Tak
Parametry	Parametry funkcji	Parametry akceptowane przez funkcje, opisane jako obiekt schematu JSON. Zapoznaj się z przewodnikiem , aby zapoznać się z przykładami i dokumentacją dotyczącą schematu JSON , aby uzyskać dokumentację dotyczącą formatu. Pominięcie parameters definiuje funkcję z pustą listą parametrów.	Nr

chatCompletionFunctionCallOption

Określenie określonej funkcji za pośrednictwem {"name": "my_function"} wymusza wywołanie tej funkcji przez model.

Nazwa	Typ	Opis	Wymagane	Domyślny
Nazwa	ciąg	Nazwa funkcji do wywołania.	Tak

chatCompletionFunctionParameters

Parametry akceptowane przez funkcje, opisane jako obiekt schematu JSON. Zapoznaj się z przewodnikiem/ , aby zapoznać się z przykładami, oraz dokumentacją dotyczącą schematu JSON , aby uzyskać dokumentację dotyczącą formatu.

Brak zdefiniowanych właściwości dla tego składnika.

chatCompletionRequestMessage

Ten składnik może być jednym z następujących elementów:

• ChatCompletionRequestDeveloperMessage
• chatCompletionRequestSystemMessage
• chatCompletionRequestUserMessage
• chatCompletionRequestAssistantMessage
• chatCompletionRequestToolMessage
• chatCompletionRequestFunctionMessage

ChatCompletionRequestDeveloperMessage

Instrukcje podane przez dewelopera, które powinny być zgodne z modelem, niezależnie od komunikatów wysyłanych przez użytkownika. W przypadku modeli o1 i nowszych developer komunikaty zastępują poprzednie system komunikaty.

Nazwa	Typ	Opis	Wymagane	Domyślny
zawartość	ciąg lub tablica	Zawartość komunikatu dla deweloperów.	Tak
Nazwa	ciąg	Opcjonalna nazwa uczestnika. Zawiera informacje o modelu umożliwiające rozróżnienie między uczestnikami tej samej roli.	Nr
rola	wyliczenie	Rola autora komunikatów, w tym przypadku developer. Możliwe wartości: developer	Tak

chatCompletionRequestSystemMessage

Nazwa	Typ	Opis	Wymagane	Domyślny
zawartość	ciąg lub tablica	Zawartość komunikatu systemowego.	Tak
Nazwa	ciąg	Opcjonalna nazwa uczestnika. Zawiera informacje o modelu umożliwiające rozróżnienie między uczestnikami tej samej roli.	Nr
rola	wyliczenie	Rola autora komunikatów, w tym przypadku system. Możliwe wartości: system	Tak

chatCompletionRequestUserMessage

Nazwa	Typ	Opis	Wymagane	Domyślny
zawartość	ciąg lub tablica	Zawartość wiadomości użytkownika.	Tak
Nazwa	ciąg	Opcjonalna nazwa uczestnika. Zawiera informacje o modelu umożliwiające rozróżnienie między uczestnikami tej samej roli.	Nr
rola	wyliczenie	Rola autora komunikatów, w tym przypadku user. Możliwe wartości: user	Tak

chatCompletionRequestAssistantMessage

Nazwa	Typ	Opis	Wymagane	Domyślny
zawartość	ciąg lub tablica	Zawartość komunikatu asystenta. Wymagane, chyba że tool_calls określono wartość lub function_call .	Nr
function_call	obiekt	Przestarzałe i zastąpione przez tool_calls. Nazwa i argumenty funkcji, które powinny być wywoływane, generowane przez model.	Nr
Argumenty └*	ciąg	Argumenty do wywołania funkcji za pomocą , wygenerowane przez model w formacie JSON. Należy pamiętać, że model nie zawsze generuje prawidłowy kod JSON i może mieć niezdefiniowane parametry niezdefiniowane przez schemat funkcji. Przed wywołaniem funkcji zweryfikuj argumenty w kodzie.	Nr
└* nazwa	ciąg	Nazwa funkcji do wywołania.	Nr
Nazwa	ciąg	Opcjonalna nazwa uczestnika. Zawiera informacje o modelu umożliwiające rozróżnienie między uczestnikami tej samej roli.	Nr
Odmowy	ciąg	Wiadomość o odmowie asystenta.	Nr
rola	wyliczenie	Rola autora komunikatów, w tym przypadku assistant. Możliwe wartości: assistant	Tak
tool_calls	chatCompletionMessageToolCalls	Wywołania narzędzia generowane przez model, takie jak wywołania funkcji.	Nr

chatCompletionRequestToolMessage

Nazwa	Typ	Opis	Wymagane	Domyślny
zawartość	ciąg lub tablica	Zawartość komunikatu narzędzia.	Tak
rola	wyliczenie	Rola autora komunikatów, w tym przypadku tool. Możliwe wartości: tool	Tak
tool_call_id	ciąg	Wywołanie narzędzia, na które odpowiada ten komunikat.	Tak

chatCompletionRequestFunctionMessage

Nazwa	Typ	Opis	Wymagane	Domyślny
zawartość	ciąg	Zawartość komunikatu funkcji.	Tak
Nazwa	ciąg	Nazwa funkcji do wywołania.	Tak
rola	wyliczenie	Rola autora komunikatów, w tym przypadku function. Możliwe wartości: function	Tak

chatCompletionRequestDeveloperMessageContentPart

Ten składnik może być jednym z następujących elementów:

• chatCompletionRequestMessageContentPartText

chatCompletionRequestSystemMessageContentPart

Ten składnik może być jednym z następujących elementów:

• chatCompletionRequestMessageContentPartText

chatCompletionRequestUserMessageContentPart

Ten składnik może być jednym z następujących elementów:

• chatCompletionRequestMessageContentPartText
• chatCompletionRequestMessageContentPartImage
• chatCompletionRequestMessageContentPartAudio

chatCompletionRequestAssistantMessageContentPart

Ten składnik może być jednym z następujących elementów:

• chatCompletionRequestMessageContentPartText
• chatCompletionRequestMessageContentPartRefusal

chatCompletionRequestToolMessageContentPart

Ten składnik może być jednym z następujących elementów:

• chatCompletionRequestMessageContentPartText

chatCompletionRequestMessageContentPartText

Nazwa	Typ	Opis	Wymagane	Domyślny
SMS	ciąg	Zawartość tekstowa.	Tak
typ	wyliczenie	Typ części zawartości. Możliwe wartości: text	Tak

chatCompletionRequestMessageContentPartAudio

Nazwa	Typ	Opis	Wymagane	Domyślny
input_audio	obiekt		Tak
└* dane	ciąg	Dane audio zakodowane w formacie Base64.	Nr
Format └*	wyliczenie	Format zakodowanych danych dźwiękowych. Obecnie obsługuje "wav" i "mp3". Możliwe wartości: wav, mp3	Nr
typ	wyliczenie	Typ części zawartości. Zawsze input_audio. Możliwe wartości: input_audio	Tak

chatCompletionRequestMessageContentPartImage

Nazwa	Typ	Opis	Wymagane	Domyślny
image_url	obiekt		Tak
└* szczegóły	wyliczenie	Określa poziom szczegółowości obrazu. Dowiedz się więcej w przewodniku dotyczącym przetwarzania obrazów. Możliwe wartości: auto, , lowhigh	Nr
└} adres URL	ciąg	Adres URL obrazu lub zakodowane w formacie base64 dane obrazu.	Nr
typ	wyliczenie	Typ części zawartości. Możliwe wartości: image_url	Tak

chatCompletionRequestMessageContentPartRefusal

Nazwa	Typ	Opis	Wymagane	Domyślny
Odmowy	ciąg	Komunikat o odmowie wygenerowany przez model.	Tak
typ	wyliczenie	Typ części zawartości. Możliwe wartości: refusal	Tak

azureChatExtensionConfiguration

Reprezentacja danych konfiguracji dla pojedynczego rozszerzenia czatu usługi Azure OpenAI. Będzie to używane przez żądanie ukończenia czatu, które powinno używać rozszerzeń czatu usługi Azure OpenAI w celu rozszerzenia zachowania odpowiedzi. Użycie tej konfiguracji jest zgodne tylko z usługą Azure OpenAI.

###Discriminator dla polecenia azureChatExtensionConfiguration

Ten składnik używa właściwości type do rozróżniania różnych typów:

Wartość typu	Schematu
azure_search	azureSearchChatExtensionConfiguration
azure_cosmos_db	azureCosmosDBChatExtensionConfiguration
elasticsearch	elasticsearchChatExtensionConfiguration
mongo_db	mongoDBChatExtensionConfiguration
pinecone	pineconeChatExtensionConfiguration

Nazwa	Typ	Opis	Wymagane	Domyślny
typ	azureChatExtensionType	Reprezentacja danych konfiguracji dla pojedynczego rozszerzenia czatu usługi Azure OpenAI. Będzie to używane przez żądanie ukończenia czatu, które powinno używać rozszerzeń czatu usługi Azure OpenAI w celu rozszerzenia zachowania odpowiedzi. Użycie tej konfiguracji jest zgodne tylko z usługą Azure OpenAI.	Tak

azureChatExtensionType

Reprezentacja danych konfiguracji dla pojedynczego rozszerzenia czatu usługi Azure OpenAI. Będzie to używane przez żądanie ukończenia czatu, które powinno używać rozszerzeń czatu usługi Azure OpenAI w celu rozszerzenia zachowania odpowiedzi. Użycie tej konfiguracji jest zgodne tylko z usługą Azure OpenAI.

Właściwość	Wartość
Opis	Reprezentacja danych konfiguracji dla pojedynczego rozszerzenia czatu usługi Azure OpenAI. Będzie to używane przez żądanie ukończenia czatu, które powinno używać rozszerzeń czatu usługi Azure OpenAI w celu rozszerzenia zachowania odpowiedzi. Użycie tej konfiguracji jest zgodne tylko z usługą Azure OpenAI.
Typu	ciąg
Wartości	azure_search azure_cosmos_db elasticsearch mongo_db pinecone

azureSearchChatExtensionConfiguration

Konkretna reprezentacja konfigurowalnych opcji usługi Azure Search podczas korzystania z niej jako rozszerzenia czatu usługi Azure OpenAI.

Nazwa	Typ	Opis	Wymagane	Domyślny
Parametry	azureSearchChatExtensionParameters	Parametry usługi Azure Search, gdy są używane jako rozszerzenie czatu usługi Azure OpenAI.	Nr
typ	azureChatExtensionType	Reprezentacja danych konfiguracji dla pojedynczego rozszerzenia czatu usługi Azure OpenAI. Będzie to używane przez żądanie ukończenia czatu, które powinno używać rozszerzeń czatu usługi Azure OpenAI w celu rozszerzenia zachowania odpowiedzi. Użycie tej konfiguracji jest zgodne tylko z usługą Azure OpenAI.	Tak

azureSearchChatExtensionParameters

Parametry usługi Azure Search, gdy są używane jako rozszerzenie czatu usługi Azure OpenAI.

Nazwa	Typ	Opis	Wymagane	Domyślny
allow_partial_result	Boolean	Jeśli określono wartość true, system zezwoli na użycie częściowych wyników wyszukiwania, a żądanie zakończy się niepowodzeniem, jeśli wszystkie zapytania kończą się niepowodzeniem. Jeśli nie zostanie określony lub określony jako false, żądanie zakończy się niepowodzeniem, jeśli jakiekolwiek zapytanie wyszukiwania zakończy się niepowodzeniem.	Nr	False
uwierzytelnianie	onYourDataApiKeyAuthenticationOptions lub onYourDataSystemAssignedManagedIdentityAuthenticationOptions lub onYourDataUserAssignedManagedIdentityAuthenticationOptions lub onYourDataAccessTokenAuthenticationOptions		Tak
embedding_dependency	onYourDataEndpointVectorizationSource lub onYourDataDeploymentNameVectorizationSource lub onYourDataIntegratedVectorizationSource		Nr
punkt końcowy	ciąg	Bezwzględna ścieżka punktu końcowego zasobu usługi Azure Search do użycia.	Tak
fields_mapping	azureSearchIndexFieldMappingOptions	Opcjonalne ustawienia umożliwiające kontrolowanie sposobu przetwarzania pól podczas korzystania ze skonfigurowanego zasobu usługi Azure Search.	Nr
filtr	ciąg	Filtr wyszukiwania.	Nr
in_scope	Boolean	Czy zapytania powinny być ograniczone do używania indeksowanych danych.	Nr
include_contexts	macierz	Uwzględnione właściwości kontekstu wyjściowego. Jeśli nie zostanie określony, wartość domyślna to citations i intent.	Nr
Index_name	ciąg	Nazwa indeksu, który ma być używany jako dostępny w przywoływowanym zasobie usługi Azure Search.	Tak
max_search_queries	liczba całkowita	Maksymalna liczba przepisanych zapytań powinna być wysyłana do dostawcy wyszukiwania dla jednego komunikatu użytkownika. Jeśli nie zostanie określony, system zdecyduje o liczbie zapytań do wysłania.	Nr
query_type	azureSearchQueryType	Typ zapytania pobierania usługi Azure Search, który należy wykonać podczas korzystania z niego jako rozszerzenie czatu usługi Azure OpenAI.	Nr
semantic_configuration	ciąg	Dodatkowa konfiguracja semantyczna zapytania.	Nr
ścisłość	liczba całkowita	Skonfigurowana ścisłość filtrowania istotności wyszukiwania. Im większa surowość, większa precyzja, ale niższa kompletność odpowiedzi.	Nr
top_n_documents	liczba całkowita	Skonfigurowano maksymalną liczbę dokumentów do funkcji dla skonfigurowanego zapytania.	Nr

azureSearchIndexFieldMappingOptions

Opcjonalne ustawienia umożliwiające kontrolowanie sposobu przetwarzania pól podczas korzystania ze skonfigurowanego zasobu usługi Azure Search.

Nazwa	Typ	Opis	Wymagane	Domyślny
content_fields	macierz	Nazwy pól indeksu, które powinny być traktowane jako zawartość.	Nr
content_fields_separator	ciąg	Wzorzec separatora, którego powinny używać pola zawartości.	Nr
filepath_field	ciąg	Nazwa pola indeksu do użycia jako ścieżka pliku.	Nr
image_vector_fields	macierz	Nazwy pól reprezentujących dane wektorów obrazów.	Nr
title_field	ciąg	Nazwa pola indeksu, które ma być używane jako tytuł.	Nr
url_field	ciąg	Nazwa pola indeksu, które ma być używane jako adres URL.	Nr
vector_fields	macierz	Nazwy pól reprezentujących dane wektorowe.	Nr

azureSearchQueryType

Typ zapytania pobierania usługi Azure Search, który należy wykonać podczas korzystania z niego jako rozszerzenie czatu usługi Azure OpenAI.

Właściwość	Wartość
Opis	Typ zapytania pobierania usługi Azure Search, który należy wykonać podczas korzystania z niego jako rozszerzenie czatu usługi Azure OpenAI.
Typu	ciąg
Wartości	simple semantic vector vector_simple_hybrid vector_semantic_hybrid

azureCosmosDBChatExtensionConfiguration

Konkretna reprezentacja konfigurowalnych opcji dla usługi Azure Cosmos DB w przypadku korzystania z niej jako rozszerzenia czatu usługi Azure OpenAI.

Nazwa	Typ	Opis	Wymagane	Domyślny
Parametry	azureCosmosDBChatExtensionParameters	Parametry do użycia podczas konfigurowania rozszerzenia czatu usługi Azure OpenAI na czacie danych podczas korzystania z usługi Azure Cosmos DB dla rdzeni wirtualnych bazy danych MongoDB.	Nr
typ	azureChatExtensionType	Reprezentacja danych konfiguracji dla pojedynczego rozszerzenia czatu usługi Azure OpenAI. Będzie to używane przez żądanie ukończenia czatu, które powinno używać rozszerzeń czatu usługi Azure OpenAI w celu rozszerzenia zachowania odpowiedzi. Użycie tej konfiguracji jest zgodne tylko z usługą Azure OpenAI.	Tak

azureCosmosDBChatExtensionParameters

Parametry do użycia podczas konfigurowania rozszerzenia czatu usługi Azure OpenAI na czacie danych podczas korzystania z usługi Azure Cosmos DB dla rdzeni wirtualnych bazy danych MongoDB.

Nazwa	Typ	Opis	Wymagane	Domyślny
allow_partial_result	Boolean	Jeśli określono wartość true, system zezwoli na użycie częściowych wyników wyszukiwania, a żądanie zakończy się niepowodzeniem, jeśli wszystkie zapytania kończą się niepowodzeniem. Jeśli nie zostanie określony lub określony jako false, żądanie zakończy się niepowodzeniem, jeśli jakiekolwiek zapytanie wyszukiwania zakończy się niepowodzeniem.	Nr	False
uwierzytelnianie	onYourDataConnectionStringAuthenticationOptions	Opcje uwierzytelniania dla usługi Azure OpenAI Na danych podczas korzystania z parametrów połączenia.	Tak
container_name	ciąg	Nazwa kontenera zasobów usługi Azure Cosmos DB.	Tak
Nazwa_bazy_danych	ciąg	Nazwa bazy danych mongoDB z rdzeniami wirtualnymi do użycia z usługą Azure Cosmos DB.	Tak
embedding_dependency	onYourDataEndpointVectorizationSource lub onYourDataDeploymentNameVectorizationSource		Tak
fields_mapping	azureCosmosDBFieldMappingOptions	Opcjonalne ustawienia umożliwiające kontrolowanie sposobu przetwarzania pól przy użyciu skonfigurowanego zasobu usługi Azure Cosmos DB.	Tak
in_scope	Boolean	Czy zapytania powinny być ograniczone do używania indeksowanych danych.	Nr
include_contexts	macierz	Uwzględnione właściwości kontekstu wyjściowego. Jeśli nie zostanie określony, wartość domyślna to citations i intent.	Nr
Index_name	ciąg	Nazwa indeksu rdzeni wirtualnych bazy danych MongoDB do użycia z usługą Azure Cosmos DB.	Tak
max_search_queries	liczba całkowita	Maksymalna liczba przepisanych zapytań powinna być wysyłana do dostawcy wyszukiwania dla jednego komunikatu użytkownika. Jeśli nie zostanie określony, system zdecyduje o liczbie zapytań do wysłania.	Nr
ścisłość	liczba całkowita	Skonfigurowana ścisłość filtrowania istotności wyszukiwania. Im większa surowość, większa precyzja, ale niższa kompletność odpowiedzi.	Nr
top_n_documents	liczba całkowita	Skonfigurowano maksymalną liczbę dokumentów do funkcji dla skonfigurowanego zapytania.	Nr

azureCosmosDBFieldMappingOptions

Opcjonalne ustawienia umożliwiające kontrolowanie sposobu przetwarzania pól przy użyciu skonfigurowanego zasobu usługi Azure Cosmos DB.

Nazwa	Typ	Opis	Wymagane	Domyślny
content_fields	macierz	Nazwy pól indeksu, które powinny być traktowane jako zawartość.	Tak
content_fields_separator	ciąg	Wzorzec separatora, którego powinny używać pola zawartości.	Nr
filepath_field	ciąg	Nazwa pola indeksu do użycia jako ścieżka pliku.	Nr
title_field	ciąg	Nazwa pola indeksu, które ma być używane jako tytuł.	Nr
url_field	ciąg	Nazwa pola indeksu, które ma być używane jako adres URL.	Nr
vector_fields	macierz	Nazwy pól reprezentujących dane wektorowe.	Tak

elasticsearchChatExtensionConfiguration

Konkretna reprezentacja konfigurowalnych opcji usługi Elasticsearch podczas korzystania z niej jako rozszerzenia czatu usługi Azure OpenAI.

Nazwa	Typ	Opis	Wymagane	Domyślny
Parametry	elasticsearchChatExtensionParameters	Parametry do użycia podczas konfigurowania elasticsearchâ® jako rozszerzenia czatu usługi Azure OpenAI.	Nr
typ	azureChatExtensionType	Reprezentacja danych konfiguracji dla pojedynczego rozszerzenia czatu usługi Azure OpenAI. Będzie to używane przez żądanie ukończenia czatu, które powinno używać rozszerzeń czatu usługi Azure OpenAI w celu rozszerzenia zachowania odpowiedzi. Użycie tej konfiguracji jest zgodne tylko z usługą Azure OpenAI.	Tak

elasticsearchChatExtensionParameters

Parametry do użycia podczas konfigurowania elasticsearchâ® jako rozszerzenia czatu usługi Azure OpenAI.

Nazwa	Typ	Opis	Wymagane	Domyślny
allow_partial_result	Boolean	Jeśli określono wartość true, system zezwoli na użycie częściowych wyników wyszukiwania, a żądanie zakończy się niepowodzeniem, jeśli wszystkie zapytania kończą się niepowodzeniem. Jeśli nie zostanie określony lub określony jako false, żądanie zakończy się niepowodzeniem, jeśli jakiekolwiek zapytanie wyszukiwania zakończy się niepowodzeniem.	Nr	False
uwierzytelnianie	onYourDataKeyAndKeyIdAuthenticationOptions lub onYourDataEncodedApiKeyAuthenticationOptions		Tak
embedding_dependency	onYourDataEndpointVectorizationSource lub onYourDataDeploymentNameVectorizationSource lub onYourDataModelIdVectorizationSource		Nr
punkt końcowy	ciąg	Punkt końcowy elasticsearchâ®.	Tak
fields_mapping	elasticsearchIndexFieldMappingOptions	Opcjonalne ustawienia umożliwiające kontrolowanie sposobu przetwarzania pól przy użyciu skonfigurowanego zasobu Elasticsearch®.	Nr
in_scope	Boolean	Czy zapytania powinny być ograniczone do używania indeksowanych danych.	Nr
include_contexts	macierz	Uwzględnione właściwości kontekstu wyjściowego. Jeśli nie zostanie określony, wartość domyślna to citations i intent.	Nr
Index_name	ciąg	Nazwa indeksu elasticsearchâ®.	Tak
max_search_queries	liczba całkowita	Maksymalna liczba przepisanych zapytań powinna być wysyłana do dostawcy wyszukiwania dla jednego komunikatu użytkownika. Jeśli nie zostanie określony, system zdecyduje o liczbie zapytań do wysłania.	Nr
query_type	elasticsearchQueryType	Typ zapytania pobierania elasticsearchâ®, które należy wykonać podczas korzystania z niego jako rozszerzenie czatu Usługi Azure OpenAI.	Nr
ścisłość	liczba całkowita	Skonfigurowana ścisłość filtrowania istotności wyszukiwania. Im większa surowość, większa precyzja, ale niższa kompletność odpowiedzi.	Nr
top_n_documents	liczba całkowita	Skonfigurowano maksymalną liczbę dokumentów do funkcji dla skonfigurowanego zapytania.	Nr

elasticsearchIndexFieldMappingOptions

Opcjonalne ustawienia umożliwiające kontrolowanie sposobu przetwarzania pól przy użyciu skonfigurowanego zasobu Elasticsearch®.

Nazwa	Typ	Opis	Wymagane	Domyślny
content_fields	macierz	Nazwy pól indeksu, które powinny być traktowane jako zawartość.	Nr
content_fields_separator	ciąg	Wzorzec separatora, którego powinny używać pola zawartości.	Nr
filepath_field	ciąg	Nazwa pola indeksu do użycia jako ścieżka pliku.	Nr
title_field	ciąg	Nazwa pola indeksu, które ma być używane jako tytuł.	Nr
url_field	ciąg	Nazwa pola indeksu, które ma być używane jako adres URL.	Nr
vector_fields	macierz	Nazwy pól reprezentujących dane wektorowe.	Nr

elasticsearchQueryType

Typ zapytania pobierania elasticsearchâ®, które należy wykonać podczas korzystania z niego jako rozszerzenie czatu Usługi Azure OpenAI.

Właściwość	Wartość
Opis	Typ zapytania pobierania elasticsearchâ®, które należy wykonać podczas korzystania z niego jako rozszerzenie czatu Usługi Azure OpenAI.
Typu	ciąg
Wartości	simple vector

mongoDBChatExtensionConfiguration

Konkretna reprezentacja konfigurowalnych opcji bazy danych Mongo DB podczas korzystania z niej jako rozszerzenia czatu usługi Azure OpenAI.

Nazwa	Typ	Opis	Wymagane	Domyślny
Parametry	mongoDBChatExtensionParameters	Parametry do użycia podczas konfigurowania rozszerzenia czatu usługi Azure OpenAI na czacie danych podczas korzystania z bazy danych Mongo DB.	Nr
typ	azureChatExtensionType	Reprezentacja danych konfiguracji dla pojedynczego rozszerzenia czatu usługi Azure OpenAI. Będzie to używane przez żądanie ukończenia czatu, które powinno używać rozszerzeń czatu usługi Azure OpenAI w celu rozszerzenia zachowania odpowiedzi. Użycie tej konfiguracji jest zgodne tylko z usługą Azure OpenAI.	Tak

mongoDBChatExtensionParameters

Parametry do użycia podczas konfigurowania rozszerzenia czatu usługi Azure OpenAI na czacie danych podczas korzystania z bazy danych Mongo DB.

Nazwa	Typ	Opis	Wymagane	Domyślny
allow_partial_result	Boolean	Jeśli określono wartość true, system zezwoli na użycie częściowych wyników wyszukiwania, a żądanie zakończy się niepowodzeniem, jeśli wszystkie zapytania kończą się niepowodzeniem. Jeśli nie zostanie określony lub określony jako false, żądanie zakończy się niepowodzeniem, jeśli jakiekolwiek zapytanie wyszukiwania zakończy się niepowodzeniem.	Nr	False
app_name	ciąg	Nazwa aplikacji mongo DB.	Tak
uwierzytelnianie	onYourDataUsernameAndPasswordAuthenticationOptions	Opcje uwierzytelniania dla usługi Azure OpenAI On Your Data podczas korzystania z nazwy użytkownika i hasła.	Tak
Nazwa_kolekcji	ciąg	Nazwa kolekcji mongo DB.	Tak
Nazwa_bazy_danych	ciąg	Nazwa bazy danych Mongo DB.	Tak
embedding_dependency	onYourDataEndpointVectorizationSource lub onYourDataDeploymentNameVectorizationSource		Tak
punkt końcowy	ciąg	Nazwa punktu końcowego klastra bazy danych Mongo DB.	Tak
fields_mapping	mongoDBFieldMappingOptions	Opcjonalne ustawienia umożliwiające kontrolowanie sposobu przetwarzania pól podczas korzystania ze skonfigurowanego zasobu bazy danych Mongo DB.	Tak
in_scope	Boolean	Czy zapytania powinny być ograniczone do używania indeksowanych danych.	Nr
include_contexts	macierz	Uwzględnione właściwości kontekstu wyjściowego. Jeśli nie zostanie określony, wartość domyślna to citations i intent.	Nr
Index_name	ciąg	Nazwa indeksu bazy danych Mongo DB.	Tak
max_search_queries	liczba całkowita	Maksymalna liczba przepisanych zapytań powinna być wysyłana do dostawcy wyszukiwania dla jednego komunikatu użytkownika. Jeśli nie zostanie określony, system zdecyduje o liczbie zapytań do wysłania.	Nr
ścisłość	liczba całkowita	Skonfigurowana ścisłość filtrowania istotności wyszukiwania. Im większa surowość, większa precyzja, ale niższa kompletność odpowiedzi.	Nr
top_n_documents	liczba całkowita	Skonfigurowano maksymalną liczbę dokumentów do funkcji dla skonfigurowanego zapytania.	Nr

mongoDBFieldMappingOptions

Opcjonalne ustawienia umożliwiające kontrolowanie sposobu przetwarzania pól podczas korzystania ze skonfigurowanego zasobu bazy danych Mongo DB.

Nazwa	Typ	Opis	Wymagane	Domyślny
content_fields	macierz	Nazwy pól indeksu, które powinny być traktowane jako zawartość.	Tak
content_fields_separator	ciąg	Wzorzec separatora, którego powinny używać pola zawartości.	Nr
filepath_field	ciąg	Nazwa pola indeksu do użycia jako ścieżka pliku.	Nr
title_field	ciąg	Nazwa pola indeksu, które ma być używane jako tytuł.	Nr
url_field	ciąg	Nazwa pola indeksu, które ma być używane jako adres URL.	Nr
vector_fields	macierz	Nazwy pól reprezentujących dane wektorowe.	Tak

pineconeChatExtensionConfiguration

Konkretna reprezentacja konfigurowalnych opcji pinecone podczas korzystania z niej jako rozszerzenia czatu Usługi Azure OpenAI.

Nazwa	Typ	Opis	Wymagane	Domyślny
Parametry	pineconeChatExtensionParameters	Parametry konfigurowania rozszerzeń czatu Pinecone w usłudze Azure OpenAI.	Nr
typ	azureChatExtensionType	Reprezentacja danych konfiguracji dla pojedynczego rozszerzenia czatu usługi Azure OpenAI. Będzie to używane przez żądanie ukończenia czatu, które powinno używać rozszerzeń czatu usługi Azure OpenAI w celu rozszerzenia zachowania odpowiedzi. Użycie tej konfiguracji jest zgodne tylko z usługą Azure OpenAI.	Tak

pineconeChatExtensionParameters

Parametry konfigurowania rozszerzeń czatu Pinecone w usłudze Azure OpenAI.

Nazwa	Typ	Opis	Wymagane	Domyślny
allow_partial_result	Boolean	Jeśli określono wartość true, system zezwoli na użycie częściowych wyników wyszukiwania, a żądanie zakończy się niepowodzeniem, jeśli wszystkie zapytania kończą się niepowodzeniem. Jeśli nie zostanie określony lub określony jako false, żądanie zakończy się niepowodzeniem, jeśli jakiekolwiek zapytanie wyszukiwania zakończy się niepowodzeniem.	Nr	False
uwierzytelnianie	onYourDataApiKeyAuthenticationOptions	Opcje uwierzytelniania usługi Azure OpenAI na danych podczas korzystania z klucza interfejsu API.	Tak
embedding_dependency	onYourDataDeploymentNameVectorizationSource	Szczegóły źródła wektoryzacji używanego przez usługę Azure OpenAI On Your Data podczas stosowania wyszukiwania wektorowego opartego na wewnętrznej nazwie wdrożenia modelu osadzania w tym samym zasobie usługi Azure OpenAI.	Tak
środowisko	ciąg	Nazwa środowiska Pinecone.	Tak
fields_mapping	pineconeFieldMappingOptions	Opcjonalne ustawienia umożliwiające kontrolowanie sposobu przetwarzania pól podczas korzystania ze skonfigurowanego zasobu Pinecone.	Tak
in_scope	Boolean	Czy zapytania powinny być ograniczone do używania indeksowanych danych.	Nr
include_contexts	macierz	Uwzględnione właściwości kontekstu wyjściowego. Jeśli nie zostanie określony, wartość domyślna to citations i intent.	Nr
Index_name	ciąg	Nazwa indeksu bazy danych Pinecone.	Tak
max_search_queries	liczba całkowita	Maksymalna liczba przepisanych zapytań powinna być wysyłana do dostawcy wyszukiwania dla jednego komunikatu użytkownika. Jeśli nie zostanie określony, system zdecyduje o liczbie zapytań do wysłania.	Nr
ścisłość	liczba całkowita	Skonfigurowana ścisłość filtrowania istotności wyszukiwania. Im większa surowość, większa precyzja, ale niższa kompletność odpowiedzi.	Nr
top_n_documents	liczba całkowita	Skonfigurowano maksymalną liczbę dokumentów do funkcji dla skonfigurowanego zapytania.	Nr

pineconeFieldMappingOptions

Opcjonalne ustawienia umożliwiające kontrolowanie sposobu przetwarzania pól podczas korzystania ze skonfigurowanego zasobu Pinecone.

Nazwa	Typ	Opis	Wymagane	Domyślny
content_fields	macierz	Nazwy pól indeksu, które powinny być traktowane jako zawartość.	Tak
content_fields_separator	ciąg	Wzorzec separatora, którego powinny używać pola zawartości.	Nr
filepath_field	ciąg	Nazwa pola indeksu do użycia jako ścieżka pliku.	Nr
title_field	ciąg	Nazwa pola indeksu, które ma być używane jako tytuł.	Nr
url_field	ciąg	Nazwa pola indeksu, które ma być używane jako adres URL.	Nr

onYourDataAuthenticationOptions

Opcje uwierzytelniania dla usługi Azure OpenAI On Your Data.

Dyskryminujące dla polecenia onYourDataAuthenticationOptions

Ten składnik używa właściwości type do rozróżniania różnych typów:

Wartość typu	Schematu
api_key	onYourDataApiKeyAuthenticationOptions
connection_string	onYourDataConnectionStringAuthenticationOptions
key_and_key_id	onYourDataKeyAndKeyIdAuthenticationOptions
encoded_api_key	onYourDataEncodedApiKeyAuthenticationOptions
access_token	onYourDataAccessTokenAuthenticationOptions
system_assigned_managed_identity	onYourDataSystemAssignedManagedIdentityAuthenticationOptions
user_assigned_managed_identity	onYourDataUserAssignedManagedIdentityAuthenticationOptions
username_and_password	onYourDataUsernameAndPasswordAuthenticationOptions

Nazwa	Typ	Opis	Wymagane	Domyślny
typ	onYourDataAuthenticationType	Typy uwierzytelniania obsługiwane w usłudze Azure OpenAI na danych.	Tak

onYourDataContextProperty

Właściwość kontekstu.

Właściwość	Wartość
Opis	Właściwość kontekstu.
Typu	ciąg
Wartości	citations intent all_retrieved_documents

onYourDataAuthenticationType

Typy uwierzytelniania obsługiwane w usłudze Azure OpenAI na danych.

Właściwość	Wartość
Opis	Typy uwierzytelniania obsługiwane w usłudze Azure OpenAI na danych.
Typu	ciąg
Wartości	api_key connection_string key_and_key_id encoded_api_key access_token system_assigned_managed_identity user_assigned_managed_identity username_and_password

onYourDataApiKeyAuthenticationOptions

Opcje uwierzytelniania usługi Azure OpenAI na danych podczas korzystania z klucza interfejsu API.

Nazwa	Typ	Opis	Wymagane	Domyślny
klucz	ciąg	Klucz interfejsu API do użycia do uwierzytelniania.	Nr
typ	onYourDataAuthenticationType	Typy uwierzytelniania obsługiwane w usłudze Azure OpenAI na danych.	Tak

onYourDataConnectionStringAuthenticationOptions

Opcje uwierzytelniania dla usługi Azure OpenAI Na danych podczas korzystania z parametrów połączenia.

Nazwa	Typ	Opis	Wymagane	Domyślny
connection_string	ciąg	Parametry połączenia do użycia do uwierzytelniania.	Nr
typ	onYourDataAuthenticationType	Typy uwierzytelniania obsługiwane w usłudze Azure OpenAI na danych.	Tak

onYourDataKeyAndKeyIdAuthenticationOptions

Opcje uwierzytelniania dla usługi Azure OpenAI Na danych podczas korzystania z pary kluczy Elasticsearch i identyfikatora klucza.

Nazwa	Typ	Opis	Wymagane	Domyślny
klucz	ciąg	Klucz elasticsearch do użycia do uwierzytelniania.	Nr
Key_id	ciąg	Identyfikator klucza elasticsearch do użycia do uwierzytelniania.	Nr
typ	onYourDataAuthenticationType	Typy uwierzytelniania obsługiwane w usłudze Azure OpenAI na danych.	Tak

onYourDataEncodedApiKeyAuthenticationOptions

Opcje uwierzytelniania usługi Azure OpenAI na danych podczas korzystania z klucza interfejsu API zakodowanego w usłudze Elasticsearch.

Nazwa	Typ	Opis	Wymagane	Domyślny
encoded_api_key	ciąg	Klucz interfejsu API zakodowanego w usłudze Elasticsearch do użycia na potrzeby uwierzytelniania.	Nr
typ	onYourDataAuthenticationType	Typy uwierzytelniania obsługiwane w usłudze Azure OpenAI na danych.	Tak

onYourDataAccessTokenAuthenticationOptions

Opcje uwierzytelniania dla usługi Azure OpenAI Na danych podczas korzystania z tokenu dostępu.

Nazwa	Typ	Opis	Wymagane	Domyślny
access_token	ciąg	Token dostępu do użycia do uwierzytelniania.	Nr
typ	onYourDataAuthenticationType	Typy uwierzytelniania obsługiwane w usłudze Azure OpenAI na danych.	Tak

onYourDataSystemAssignedManagedIdentityAuthenticationOptions

Opcje uwierzytelniania usługi Azure OpenAI na danych podczas korzystania z tożsamości zarządzanej przypisanej przez system.

Nazwa	Typ	Opis	Wymagane	Domyślny
typ	onYourDataAuthenticationType	Typy uwierzytelniania obsługiwane w usłudze Azure OpenAI na danych.	Tak

onYourDataUserAssignedManagedIdentityAuthenticationOptions

Opcje uwierzytelniania usługi Azure OpenAI na danych podczas korzystania z tożsamości zarządzanej przypisanej przez użytkownika.

Nazwa	Typ	Opis	Wymagane	Domyślny
managed_identity_resource_id	ciąg	Identyfikator zasobu tożsamości zarządzanej przypisanej przez użytkownika do użycia do uwierzytelniania.	Nr
typ	onYourDataAuthenticationType	Typy uwierzytelniania obsługiwane w usłudze Azure OpenAI na danych.	Tak

onYourDataUsernameAndPasswordAuthenticationOptions

Opcje uwierzytelniania dla usługi Azure OpenAI On Your Data podczas korzystania z nazwy użytkownika i hasła.

Nazwa	Typ	Opis	Wymagane	Domyślny
hasło	ciąg	Hasło. do użycia do uwierzytelniania.	Nr
typ	onYourDataAuthenticationType	Typy uwierzytelniania obsługiwane w usłudze Azure OpenAI na danych.	Tak
nazwa użytkownika	ciąg	Nazwa użytkownika używana do uwierzytelniania.	Nr

onYourDataVectorizationSource

Abstrakcyjna reprezentacja źródła wektoryzacji dla usługi Azure OpenAI On Your Data z wyszukiwaniem wektorowym.

Ten składnik używa właściwości type do rozróżniania różnych typów:

Wartość typu	Schematu
endpoint	onYourDataEndpointVectorizationSource
deployment_name	onYourDataDeploymentNameVectorizationSource
integrated	onYourDataIntegratedVectorizationSource
model_id	onYourDataModelIdVectorizationSource

Nazwa	Typ	Opis	Wymagane	Domyślny
typ	onYourDataVectorizationSourceType	Reprezentuje dostępne źródła usługi Azure OpenAI On Your Data może służyć do konfigurowania wektoryzacji danych do użycia z wyszukiwaniem wektorowym.	Tak

onYourDataVectorizationSourceType

Reprezentuje dostępne źródła usługi Azure OpenAI On Your Data może służyć do konfigurowania wektoryzacji danych do użycia z wyszukiwaniem wektorowym.

Właściwość	Wartość
Opis	Reprezentuje dostępne źródła usługi Azure OpenAI On Your Data może służyć do konfigurowania wektoryzacji danych do użycia z wyszukiwaniem wektorowym.
Typu	ciąg
Wartości	endpoint deployment_name integrated model_id

onYourDataEndpointVectorizationSource

Szczegóły źródła wektoryzacji używanego przez usługę Azure OpenAI On Your Data podczas stosowania wyszukiwania wektorowego opartego na publicznym wywołaniu punktu końcowego usługi Azure OpenAI na potrzeby osadzania.

Nazwa	Typ	Opis	Wymagane	Domyślny
uwierzytelnianie	onYourDataApiKeyAuthenticationOptions lub onYourDataAccessTokenAuthenticationOptions		Nr
Wymiary	liczba całkowita	Liczba wymiarów osadzania powinna mieć wartość . Obsługiwane tylko w text-embedding-3 modelach i nowszych.	Nr
punkt końcowy	ciąg	Określa adres URL punktu końcowego zasobu, z którego mają zostać pobrane osadzanie. Powinien mieć format https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/embeddings. Parametr zapytania w wersji interfejsu API nie jest dozwolony.	Nr
typ	onYourDataVectorizationSourceType	Reprezentuje dostępne źródła usługi Azure OpenAI On Your Data może służyć do konfigurowania wektoryzacji danych do użycia z wyszukiwaniem wektorowym.	Tak

onYourDataDeploymentNameVectorizationSource

Szczegóły źródła wektoryzacji używanego przez usługę Azure OpenAI On Your Data podczas stosowania wyszukiwania wektorowego opartego na wewnętrznej nazwie wdrożenia modelu osadzania w tym samym zasobie usługi Azure OpenAI.

Nazwa	Typ	Opis	Wymagane	Domyślny
deployment_name	ciąg	Określa nazwę wdrożenia modelu do użycia na potrzeby wektoryzacji. To wdrożenie modelu musi znajdować się w tym samym zasobie usługi Azure OpenAI, ale w danych będzie używać tego wdrożenia modelu za pośrednictwem wywołania wewnętrznego, a nie publicznego, co umożliwia wyszukiwanie wektorów nawet w sieciach prywatnych.	Nr
Wymiary	liczba całkowita	Liczba wymiarów osadzania powinna mieć wartość . Obsługiwane tylko w text-embedding-3 modelach i nowszych.	Nr
typ	onYourDataVectorizationSourceType	Reprezentuje dostępne źródła usługi Azure OpenAI On Your Data może służyć do konfigurowania wektoryzacji danych do użycia z wyszukiwaniem wektorowym.	Tak

onYourDataIntegratedVectorizationSource

Reprezentuje zintegrowany wektoryzator zdefiniowany w ramach zasobu wyszukiwania.

Nazwa	Typ	Opis	Wymagane	Domyślny
typ	onYourDataVectorizationSourceType	Reprezentuje dostępne źródła usługi Azure OpenAI On Your Data może służyć do konfigurowania wektoryzacji danych do użycia z wyszukiwaniem wektorowym.	Tak

onYourDataModelIdVectorizationSource

Szczegóły źródła wektoryzacji używanego przez usługę Azure OpenAI On Your Data podczas stosowania wyszukiwania wektorowego opartego na identyfikatorze modelu usługi wyszukiwania. Obecnie obsługiwane tylko przez elasticsearchâ®.

Nazwa	Typ	Opis	Wymagane	Domyślny
model_id	ciąg	Określa identyfikator modelu, który ma być używany do wektoryzacji. Ten identyfikator modelu musi być zdefiniowany w usłudze wyszukiwania.	Nr
typ	onYourDataVectorizationSourceType	Reprezentuje dostępne źródła usługi Azure OpenAI On Your Data może służyć do konfigurowania wektoryzacji danych do użycia z wyszukiwaniem wektorowym.	Tak

azureChatExtensionsMessageContext

Reprezentacja dodatkowych informacji kontekstowych dostępnych, gdy rozszerzenia czatu usługi Azure OpenAI są zaangażowane w generowanie odpowiedniej odpowiedzi na czat. Te informacje kontekstowe są wypełniane tylko w przypadku używania żądania usługi Azure OpenAI skonfigurowanego do używania zgodnego rozszerzenia.

Nazwa	Typ	Opis	Wymagane	Domyślny
all_retrieved_documents	macierz	Wszystkie pobrane dokumenty.	Nr
Cytatów	macierz	Wynik pobierania źródła danych używany do generowania komunikatu asystenta w odpowiedzi.	Nr
intencja	ciąg	Wykryta intencja z historii czatu użyta do przekazania do następnego kroku w celu przeniesienia kontekstu.	Nr

Cytat

informacje o cytatach dla komunikatu odpowiedzi zakończenia czatu.

Nazwa	Typ	Opis	Wymagane	Domyślny
chunk_id	ciąg	Identyfikator fragmentu cytatu.	Nr
zawartość	ciąg	Zawartość cytatu.	Tak
Filepath	ciąg	Ścieżka pliku cytatu.	Nr
rerank_score	Numer	Wynik ponownego generowania pobranego dokumentu.	Nr
Tytuł	ciąg	Tytuł cytatu.	Nr
Adres url	ciąg	Adres URL cytatu.	Nr

retrievedDocument

Pobrany dokument.

Nazwa	Typ	Opis	Wymagane	Domyślny
chunk_id	ciąg	Identyfikator fragmentu cytatu.	Nr
zawartość	ciąg	Zawartość cytatu.	Tak
data_source_index	liczba całkowita	Indeks źródła danych.	Nr
Filepath	ciąg	Ścieżka pliku cytatu.	Nr
filter_reason	filterReason	Przyczyna filtrowania pobranego dokumentu.	Nr
original_search_score	Numer	Oryginalny wynik wyszukiwania pobranego dokumentu.	Nr
rerank_score	Numer	Wynik ponownego generowania pobranego dokumentu.	Nr
search_queries	macierz	Zapytania wyszukiwania używane do pobierania dokumentu.	Nr
Tytuł	ciąg	Tytuł cytatu.	Nr
Adres url	ciąg	Adres URL cytatu.	Nr

filterReason

Przyczyna filtrowania pobranego dokumentu.

Właściwość	Wartość
Opis	Przyczyna filtrowania pobranego dokumentu.
Typu	ciąg
Wartości	score rerank

chatCompletionMessageToolCall

Nazwa	Typ	Opis	Wymagane	Domyślny
funkcja	obiekt	Funkcja wywoływana przez model.	Tak
Argumenty └*	ciąg	Argumenty do wywołania funkcji za pomocą , wygenerowane przez model w formacie JSON. Należy pamiętać, że model nie zawsze generuje prawidłowy kod JSON i może mieć niezdefiniowane parametry niezdefiniowane przez schemat funkcji. Przed wywołaniem funkcji zweryfikuj argumenty w kodzie.	Nr
└* nazwa	ciąg	Nazwa funkcji do wywołania.	Nr
Identyfikator	ciąg	Identyfikator wywołania narzędzia.	Tak
typ	toolCallType	W tym przypadku functiontyp wywołania narzędzia .	Tak

toolCallType

W tym przypadku functiontyp wywołania narzędzia .

Właściwość	Wartość
Opis	W tym przypadku functiontyp wywołania narzędzia .
Typu	ciąg
Wartości	function

chatCompletionRequestMessageTool

Nazwa	Typ	Opis	Wymagane	Domyślny
zawartość	ciąg	Zawartość wiadomości.	Nr
tool_call_id	ciąg	Wywołanie narzędzia, na które odpowiada ten komunikat.	Nr

chatCompletionRequestMessageFunction

Nazwa	Typ	Opis	Wymagane	Domyślny
zawartość	ciąg	Zawartość wiadomości.	Nr
Nazwa	ciąg	Zawartość wiadomości.	Nr
rola	wyliczenie	Rola autora komunikatów, w tym przypadku function. Możliwe wartości: function	Nr

createChatCompletionResponse

Reprezentuje odpowiedź ukończenia czatu zwróconą przez model na podstawie podanych danych wejściowych.

Nazwa	Typ	Opis	Wymagane	Domyślny
Wyborów	macierz	Lista opcji ukończenia czatu. Może być więcej niż jeden, jeśli n jest większy niż 1.	Tak
Utworzone	liczba całkowita	Sygnatura czasowa systemu Unix (w sekundach) czasu utworzenia czatu.	Tak
Identyfikator	ciąg	Unikatowy identyfikator ukończenia czatu.	Tak
model	ciąg	Model używany do ukończenia czatu.	Tak
obiekt	wyliczenie	Typ obiektu, który jest zawsze chat.completion. Możliwe wartości: chat.completion	Tak
prompt_filter_results	promptFilterResults	Wyniki filtrowania zawartości dla zera lub większej liczby monitów w żądaniu. W żądaniu przesyłania strumieniowego wyniki dla różnych monitów mogą pojawiać się w różnych porach lub w różnych zamówieniach.	Nr
system_fingerprint	ciąg	Ten odcisk palca reprezentuje konfigurację zaplecza, z którą działa model. Można użyć w połączeniu z parametrem seed żądania, aby zrozumieć, kiedy wprowadzono zmiany zaplecza, które mogą mieć wpływ na determinizm.	Nr
użycie	completionUsage	Statystyki użycia dla żądania ukończenia.	Nr

createChatCompletionStreamResponse

Reprezentuje strumień fragmentu odpowiedzi ukończenia czatu zwróconej przez model na podstawie podanych danych wejściowych.

Nazwa	Typ	Opis	Wymagane	Domyślny
Wyborów	macierz	Lista opcji ukończenia czatu. Może zawierać więcej niż jeden element, jeśli n jest większy niż 1.	Tak
Utworzone	liczba całkowita	Sygnatura czasowa systemu Unix (w sekundach) czasu utworzenia czatu. Każdy fragment ma ten sam znacznik czasu.	Tak
Identyfikator	ciąg	Unikatowy identyfikator ukończenia czatu. Każdy fragment ma ten sam identyfikator.	Tak
model	ciąg	Model do wygenerowania ukończenia.	Tak
obiekt	wyliczenie	Typ obiektu, który jest zawsze chat.completion.chunk. Możliwe wartości: chat.completion.chunk	Tak
system_fingerprint	ciąg	Ten odcisk palca reprezentuje konfigurację zaplecza, z którą działa model. Można użyć w połączeniu z parametrem seed żądania, aby zrozumieć, kiedy wprowadzono zmiany zaplecza, które mogą mieć wpływ na determinizm.	Nr

chatCompletionStreamResponseDelta

Delta ukończenia czatu wygenerowana przez przesyłane strumieniowo odpowiedzi modelu.

Nazwa	Typ	Opis	Wymagane	Domyślny
zawartość	ciąg	Zawartość komunikatu fragmentu.	Nr
function_call	obiekt	Przestarzałe i zastąpione przez tool_calls. Nazwa i argumenty funkcji, które powinny być wywoływane, generowane przez model.	Nr
Argumenty └*	ciąg	Argumenty do wywołania funkcji za pomocą , wygenerowane przez model w formacie JSON. Należy pamiętać, że model nie zawsze generuje prawidłowy kod JSON i może mieć niezdefiniowane parametry niezdefiniowane przez schemat funkcji. Przed wywołaniem funkcji zweryfikuj argumenty w kodzie.	Nr
└* nazwa	ciąg	Nazwa funkcji do wywołania.	Nr
Odmowy	ciąg	Komunikat o odmowie wygenerowany przez model.	Nr
rola	wyliczenie	Rola autora tej wiadomości. Możliwe wartości: system, , user, assistanttool	Nr
tool_calls	macierz		Nr

chatCompletionMessageToolCallChunk

Nazwa	Typ	Opis	Wymagane	Domyślny
funkcja	obiekt		Nr
Argumenty └*	ciąg	Argumenty do wywołania funkcji za pomocą , wygenerowane przez model w formacie JSON. Należy pamiętać, że model nie zawsze generuje prawidłowy kod JSON i może mieć niezdefiniowane parametry niezdefiniowane przez schemat funkcji. Przed wywołaniem funkcji zweryfikuj argumenty w kodzie.	Nr
└* nazwa	ciąg	Nazwa funkcji do wywołania.	Nr
Identyfikator	ciąg	Identyfikator wywołania narzędzia.	Nr
indeks	liczba całkowita		Tak
typ	wyliczenie	Typ narzędzia. Obecnie obsługiwane są tylko function te elementy. Możliwe wartości: function	Nr

chatCompletionStreamOptions

Opcje odpowiedzi przesyłania strumieniowego. Ustaw tę wartość tylko po ustawieniu .stream: true

Nazwa	Typ	Opis	Wymagane	Domyślny
include_usage	Boolean	W przypadku ustawienia przed komunikatem data: [DONE] zostanie przesłany strumień dodatkowy fragment. Pole usage w tym fragmentzie pokazuje statystyki użycia tokenu dla całego żądania, a choices pole zawsze będzie pustą tablicą. Wszystkie inne fragmenty będą również zawierać usage pole, ale z wartością null.	Nr

chatCompletionChoiceLogProbs

Informacje o prawdopodobieństwie rejestrowania dla wybranego elementu.

Nazwa	Typ	Opis	Wymagane	Domyślny
zawartość	macierz	Lista tokenów zawartości komunikatów z informacjami o prawdopodobieństwa dziennika.	Tak
Odmowy	macierz	Lista tokenów odmowy wiadomości z informacjami o prawdopodobieństwa dziennika.	Nr

chatCompletionTokenLogprob

Nazwa	Typ	Opis	Wymagane	Domyślny
Bajtów	macierz	Lista liczb całkowitych reprezentujących reprezentację tokenu w bajtach UTF-8. Przydatne w wystąpieniach, w których znaki są reprezentowane przez wiele tokenów, a ich reprezentacje bajtów muszą być łączone, aby wygenerować poprawną reprezentację tekstu. Może to być null , jeśli nie ma reprezentacji bajtów dla tokenu.	Tak
logprob	Numer	Prawdopodobieństwo dziennika tego tokenu.	Tak
kod przedpłaty	ciąg	Token.	Tak
top_logprobs	macierz	Lista najbardziej prawdopodobnych tokenów i ich prawdopodobieństwa dziennika na tej pozycji tokenu. W rzadkich przypadkach może być mniej niż liczba zwróconych żądań top_logprobs .	Tak

chatCompletionResponseMessage

Komunikat ukończenia czatu wygenerowany przez model.

Nazwa	Typ	Opis	Wymagane	Domyślny
Audio	obiekt	Jeśli zażądano modalności danych wyjściowych dźwięku, ten obiekt zawiera dane dotyczące odpowiedzi audio z modelu.	Nr
└* dane	ciąg	Zakodowane w formacie Base64 bajty audio generowane przez model w formacie określonym w żądaniu.	Nr
└expires_at	liczba całkowita	Sygnatura czasowa systemu Unix (w sekundach) w przypadku, gdy ta odpowiedź dźwiękowa nie będzie już dostępna na serwerze do użycia w konwersacjach wieloetrowych.	Nr
└identyfikator	ciąg	Unikatowy identyfikator tej odpowiedzi audio.	Nr
└* transkrypcja	ciąg	Transkrypcja dźwięku wygenerowanego przez model.	Nr
zawartość	ciąg	Zawartość wiadomości.	Tak
kontekst	azureChatExtensionsMessageContext	Reprezentacja dodatkowych informacji kontekstowych dostępnych, gdy rozszerzenia czatu usługi Azure OpenAI są zaangażowane w generowanie odpowiedniej odpowiedzi na czat. Te informacje kontekstowe są wypełniane tylko w przypadku używania żądania usługi Azure OpenAI skonfigurowanego do używania zgodnego rozszerzenia.	Nr
function_call	chatCompletionFunctionCall	Przestarzałe i zastąpione przez tool_calls. Nazwa i argumenty funkcji, które powinny być wywoływane, generowane przez model.	Nr
Odmowy	ciąg	Komunikat o odmowie wygenerowany przez model.	Tak
rola	chatCompletionResponseMessageRole	Rola autora komunikatu odpowiedzi.	Tak
tool_calls	macierz	Wywołania narzędzia generowane przez model, takie jak wywołania funkcji.	Nr

chatCompletionResponseMessageRole

Rola autora komunikatu odpowiedzi.

Właściwość	Wartość
Opis	Rola autora komunikatu odpowiedzi.
Typu	ciąg
Wartości	assistant

chatCompletionToolChoiceOption

Określa, które narzędzie (jeśli istnieje) jest wywoływane przez model. none oznacza, że model nie wywoła żadnego narzędzia i zamiast tego generuje komunikat. auto oznacza, że model może wybierać między generowaniem komunikatu lub wywoływaniem co najmniej jednego narzędzia. required oznacza, że model musi wywoływać co najmniej jedno narzędzie. Określenie określonego narzędzia za pośrednictwem {"type": "function", "function": {"name": "my_function"}} wymusza wywołanie tego narzędzia przez model. none jest ustawieniem domyślnym, gdy żadne narzędzia nie są obecne. auto jest wartością domyślną, jeśli istnieją narzędzia.

Ten składnik może być jednym z następujących elementów:

• chatCompletionNamedToolChoice

chatCompletionNamedToolChoice

Określa narzędzie, które ma być używane przez model. Użyj polecenia , aby wymusić wywołanie określonej funkcji przez model.

Nazwa	Typ	Opis	Wymagane	Domyślny
funkcja	obiekt		Tak
└* nazwa	ciąg	Nazwa funkcji do wywołania.	Nr
typ	wyliczenie	Typ narzędzia. Obecnie obsługiwane są tylko function te elementy. Możliwe wartości: function	Tak

ParallelToolCalls

Czy włączyć równoległe wywoływanie funkcji podczas używania narzędzia.

Brak zdefiniowanych właściwości dla tego składnika.

PredictionContent

Statyczna przewidywana zawartość wyjściowa, taka jak zawartość pliku tekstowego, który jest ponownie wygenerowany.

Nazwa	Typ	Opis	Wymagane	Domyślny
zawartość	ciąg lub tablica	Zawartość, która powinna być dopasowana podczas generowania odpowiedzi modelu. Jeśli wygenerowane tokeny pasują do tej zawartości, cała odpowiedź modelu może zostać zwrócona znacznie szybciej.	Tak
typ	wyliczenie	Typ przewidywanej zawartości, którą chcesz podać. Ten typ jest obecnie zawsze content. Możliwe wartości: content	Tak

chatCompletionMessageToolCalls

Wywołania narzędzia generowane przez model, takie jak wywołania funkcji.

Brak zdefiniowanych właściwości dla tego składnika.

ChatCompletionModalities

Typy danych wyjściowych, które mają być generowane przez model dla tego żądania. Większość modeli jest w stanie wygenerować tekst, co jest wartością domyślną:

["text"]

Model gpt-4o-audio-preview może również służyć do generowania dźwięku. Aby zażądać, aby ten model wygenerował odpowiedzi tekstowe i audio, możesz użyć:

["text", "audio"]

Brak zdefiniowanych właściwości dla tego składnika.

chatCompletionFunctionCall

Przestarzałe i zastąpione przez tool_calls. Nazwa i argumenty funkcji, które powinny być wywoływane, generowane przez model.

Nazwa	Typ	Opis	Wymagane	Domyślny
Argumenty	ciąg	Argumenty do wywołania funkcji za pomocą , wygenerowane przez model w formacie JSON. Należy pamiętać, że model nie zawsze generuje prawidłowy kod JSON i może mieć niezdefiniowane parametry niezdefiniowane przez schemat funkcji. Przed wywołaniem funkcji zweryfikuj argumenty w kodzie.	Tak
Nazwa	ciąg	Nazwa funkcji do wywołania.	Tak

completionUsage

Statystyki użycia dla żądania ukończenia.

Nazwa	Typ	Opis	Wymagane	Domyślny
completion_tokens	liczba całkowita	Liczba tokenów w wygenerowanych ukończeniu.	Tak
completion_tokens_details	obiekt	Podział tokenów używanych w zakończeniu.	Nr
└accepted_prediction_tokens	liczba całkowita	W przypadku korzystania z przewidywanych danych wyjściowych liczba tokenów w przewidywaniu, które pojawiło się w zakończeniu.	Nr
└audio_tokens	liczba całkowita	Tokeny wejściowe audio generowane przez model.	Nr
└reasoning_tokens	liczba całkowita	Tokeny generowane przez model z powodów.	Nr
└rejected_prediction_tokens	liczba całkowita	W przypadku korzystania z przewidywanych danych wyjściowych liczba tokenów w przewidywaniu, które nie zostały wyświetlone w zakończeniu. Jednak podobnie jak tokeny rozumowania, te tokeny są nadal liczone w łącznych tokenach ukończenia na potrzeby rozliczeń, danych wyjściowych i limitów okien kontekstowych.	Nr
prompt_tokens	liczba całkowita	Liczba tokenów w wierszu polecenia.	Tak
prompt_tokens_details	obiekt	Szczegóły tokenów monitu.	Nr
└audio_tokens	liczba całkowita	Tokeny wejściowe audio obecne w wierszu polecenia.	Nr
└cached_tokens	liczba całkowita	Liczba buforowanych tokenów monitów.	Nr
total_tokens	liczba całkowita	Łączna liczba tokenów używanych w żądaniu (monit + ukończenie).	Tak

chatCompletionTool

Nazwa	Typ	Opis	Wymagane	Domyślny
funkcja	FunctionObject		Tak
typ	wyliczenie	Typ narzędzia. Obecnie obsługiwane są tylko function te elementy. Możliwe wartości: function	Tak

Parametry funkcji

Parametry akceptowane przez funkcje, opisane jako obiekt schematu JSON. Zapoznaj się z przewodnikiem , aby zapoznać się z przykładami i dokumentacją dotyczącą schematu JSON , aby uzyskać dokumentację dotyczącą formatu.

Pominięcie parameters definiuje funkcję z pustą listą parametrów.

Brak zdefiniowanych właściwości dla tego składnika.

FunctionObject

Nazwa	Typ	Opis	Wymagane	Domyślny
Opis	ciąg	Opis działania funkcji używanej przez model do wyboru, kiedy i jak wywołać funkcję.	Nr
Nazwa	ciąg	Nazwa funkcji do wywołania. Musi być a-z, A-Z, 0-9 lub zawierać podkreślenia i kreski o maksymalnej długości 64.	Tak
Parametry	Parametry funkcji	Parametry akceptowane przez funkcje, opisane jako obiekt schematu JSON. Zapoznaj się z przewodnikiem , aby zapoznać się z przykładami i dokumentacją dotyczącą schematu JSON , aby uzyskać dokumentację dotyczącą formatu. Pominięcie parameters definiuje funkcję z pustą listą parametrów.	Nr
Ścisłe	Boolean	Czy włączyć ścisłe przestrzeganie schematu podczas generowania wywołania funkcji. Jeśli ustawiono wartość true, model będzie postępować zgodnie z dokładnym schematem zdefiniowanym parameters w polu. Tylko podzbiór schematu JSON jest obsługiwany, gdy strict ma wartość true.	Nr	False

ResponseFormatText

Nazwa	Typ	Opis	Wymagane	Domyślny
typ	wyliczenie	Typ zdefiniowanego formatu odpowiedzi: text Możliwe wartości: text	Tak

ResponseFormatJsonObject

Nazwa	Typ	Opis	Wymagane	Domyślny
typ	wyliczenie	Typ zdefiniowanego formatu odpowiedzi: json_object Możliwe wartości: json_object	Tak

ResponseFormatJsonSchemaSchema

Schemat formatu odpowiedzi, opisany jako obiekt schematu JSON.

Brak zdefiniowanych właściwości dla tego składnika.

ResponseFormatJsonSchema

Nazwa	Typ	Opis	Wymagane	Domyślny
json_schema	obiekt		Tak
Opis └*	ciąg	Opis formatu odpowiedzi używany przez model do określenia sposobu reagowania w formacie.	Nr
└* nazwa	ciąg	Nazwa formatu odpowiedzi. Musi być a-z, A-Z, 0-9 lub zawierać podkreślenia i kreski o maksymalnej długości 64.	Nr
Schemat └*	ResponseFormatJsonSchemaSchema	Schemat formatu odpowiedzi, opisany jako obiekt schematu JSON.	Nr
└* ścisłe	Boolean	Czy włączyć ścisłe przestrzeganie schematu podczas generowania danych wyjściowych. W przypadku ustawienia wartości true model będzie zawsze przestrzegał dokładnego schematu zdefiniowanego schema w polu. Tylko podzbiór schematu JSON jest obsługiwany, gdy strict ma wartość true.	Nr	False
typ	wyliczenie	Typ zdefiniowanego formatu odpowiedzi: json_schema Możliwe wartości: json_schema	Tak

chatCompletionChoiceCommon

Nazwa	Typ	Opis	Wymagane	Domyślny
finish_reason	ciąg		Nr
indeks	liczba całkowita		Nr

createTranslationRequest

Żądanie tłumaczenia.

Nazwa	Typ	Opis	Wymagane	Domyślny
plik	ciąg	Plik audio do tłumaczenia.	Tak
monit	ciąg	Opcjonalny tekst prowadzący do stylu modelu lub kontynuacji poprzedniego segmentu audio. Monit powinien być w języku angielskim.	Nr
response_format	audioResponseFormat	Definiuje format danych wyjściowych.	Nr
Temperatury	Numer	Temperatura próbkowania z zakresu od 0 do 1. Wyższe wartości, takie jak 0,8, sprawią, że dane wyjściowe będą bardziej losowe, a niższe wartości, takie jak 0,2, sprawią, że będzie bardziej skoncentrowany i deterministyczny. Jeśli ustawiono wartość 0, model używa prawdopodobieństwa dziennika, aby automatycznie zwiększyć temperaturę do momentu przekroczenia określonych progów.	Nr	0

audioResponse

Odpowiedź tłumaczenia lub transkrypcji, gdy response_format był w formacie JSON

Nazwa	Typ	Opis	Wymagane	Domyślny
SMS	ciąg	Przetłumaczony lub transkrypowany tekst.	Tak

audioVerboseResponse

Odpowiedź tłumaczenia lub transkrypcji, gdy response_format była verbose_json

Nazwa	Typ	Opis	Wymagane	Domyślny
Długość	Numer	Długość.	Nr
język	ciąg	Język.	Nr
Segmenty	macierz		Nr
zadanie	ciąg	Typ zadania audio.	Nr
SMS	ciąg	Przetłumaczony lub transkrypowany tekst.	Tak
Słowy	macierz		Nr

audioResponseFormat

Definiuje format danych wyjściowych.

Właściwość	Wartość
Opis	Definiuje format danych wyjściowych.
Typu	ciąg
Wartości	json text srt verbose_json vtt

createTranscriptionRequest

Żądanie transkrypcji.

Nazwa	Typ	Opis	Wymagane	Domyślny
plik	ciąg	Obiekt pliku audio do transkrypcji.	Tak
język	ciąg	Język wejściowego dźwięku. Dostarczanie języka wejściowego w formacie ISO-639-1 zwiększa dokładność i opóźnienie.	Nr
monit	ciąg	Opcjonalny tekst prowadzący do stylu modelu lub kontynuacji poprzedniego segmentu audio. Monit powinien być zgodny z językiem dźwięku.	Nr
response_format	audioResponseFormat	Definiuje format danych wyjściowych.	Nr
Temperatury	Numer	Temperatura próbkowania z zakresu od 0 do 1. Wyższe wartości, takie jak 0,8, sprawią, że dane wyjściowe będą bardziej losowe, a niższe wartości, takie jak 0,2, sprawią, że będzie bardziej skoncentrowany i deterministyczny. Jeśli ustawiono wartość 0, model używa prawdopodobieństwa dziennika, aby automatycznie zwiększyć temperaturę do momentu przekroczenia określonych progów.	Nr	0
timestamp_granularities[]	macierz	Stopień szczegółowości sygnatury czasowej do wypełnienia dla tej transkrypcji. response_format należy ustawić, verbose_json aby używać szczegółowości sygnatury czasowej. Obsługiwane są obie te opcje: word, lub segment. Uwaga: nie ma dodatkowego opóźnienia dla sygnatur czasowych segmentu, ale generowanie znaczników czasu wyrazów powoduje dodatkowe opóźnienie.	Nr	['segment']

audioSegment

Transkrypcja lub segment tłumaczenia.

Nazwa	Typ	Opis	Wymagane	Domyślny
avg_logprob	Numer	Średnie prawdopodobieństwo dziennika.	Nr
compression_ratio	Numer	Sprężania.	Nr
Końcu	Numer	Przesunięcie końcowe segmentu.	Nr
Identyfikator	liczba całkowita	Identyfikator segmentu.	Nr
no_speech_prob	Numer	Prawdopodobieństwo braku mowy.	Nr
Szukać	Numer	Przesunięcie segmentu.	Nr
Uruchomić	Numer	Przesunięcie rozpoczęcia segmentu.	Nr
Temperatury	Numer	Temperatury.	Nr
SMS	ciąg	Tekst segmentu.	Nr
Tokeny	macierz	Tokeny tekstu.	Nr

audioWord

Transkrypcja lub słowo translacji.

Nazwa	Typ	Opis	Wymagane	Domyślny
Końcu	Numer	Przesunięcie końcowe programu Word.	Nr
Uruchomić	Numer	Przesunięcie rozpoczęcia programu Word.	Nr
słowo	ciąg	Word	Nr

createSpeechRequest

Żądanie mowy.

Nazwa	Typ	Opis	Wymagane	Domyślny
dane wejściowe	ciąg	Tekst do syntezowania dźwięku. Maksymalna długość to 4096 znaków.	Tak
response_format	wyliczenie	Format syntetyzowania dźwięku. Możliwe wartości: mp3, , opusaac, flac, , wavpcm	Nr
Prędkość	Numer	Szybkość syntetyzowanego dźwięku. Wybierz wartość z 0.25 do 4.0. 1.0 jest wartością domyślną.	Nr	1.0
głos	wyliczenie	Głos używany do syntezy mowy. Możliwe wartości: alloy, , echofable, onyx, , novashimmer	Tak

imageQuality

Jakość obrazu, który zostanie wygenerowany.

Właściwość	Wartość
Opis	Jakość obrazu, który zostanie wygenerowany.
Typu	ciąg
Domyślny	Automatycznie
Wartości	auto high medium low hd standard

imagesResponseFormat

Format, w którym są zwracane wygenerowane obrazy.

Właściwość	Wartość
Opis	Format, w którym są zwracane wygenerowane obrazy.
Typu	ciąg
Domyślny	Adres url
Wartości	url b64_json

imagesOutputFormat

Format pliku, w którym są zwracane wygenerowane obrazy. Obsługiwane tylko w przypadku modeli serii.

Właściwość	Wartość
Opis	Format pliku, w którym są zwracane wygenerowane obrazy. Obsługiwane tylko w przypadku modeli serii gpt-image-1.
Typu	ciąg
Domyślny	Png
Wartości	png jpeg

Imagesize

Rozmiar wygenerowanych obrazów.

Właściwość	Wartość
Opis	Rozmiar wygenerowanych obrazów.
Typu	ciąg
Domyślny	Automatycznie
Wartości	auto 1792x1024 1024x1792 1024x1024 1024x1536 1536x1024

imageStyle

Styl wygenerowanych obrazów. Obsługiwane tylko dla dall-e-3.

Właściwość	Wartość
Opis	Styl wygenerowanych obrazów. Obsługiwane tylko dla dall-e-3.
Typu	ciąg
Domyślny	Żywe
Wartości	vivid natural

imageBackground

Umożliwia ustawienie przezroczystości tła wygenerowanych obrazów. Ten parametr jest obsługiwany tylko w przypadku modeli serii gpt-image-1.

Właściwość	Wartość
Opis	Umożliwia ustawienie przezroczystości tła wygenerowanych obrazów. Ten parametr jest obsługiwany tylko w przypadku modeli serii gpt-image-1.
Typu	ciąg
Domyślny	Automatycznie
Wartości	transparent opaque auto

imageGenerationsRequest

Nazwa	Typ	Opis	Wymagane	Domyślny
tło	imageBackground	Umożliwia ustawienie przezroczystości tła wygenerowanych obrazów. Ten parametr jest obsługiwany tylko w przypadku modeli serii gpt-image-1.	Nr	Automatycznie
N	liczba całkowita	Liczba obrazów do wygenerowania. W przypadku języka dall-e-3 obsługiwane jest tylko n=1.	Nr	1
output_compression	liczba całkowita	Poziom kompresji (0–100%) dla wygenerowanych obrazów. Ten parametr jest obsługiwany tylko w przypadku modeli serii gpt-image-1 z formatem danych wyjściowych jpeg.	Nr	100
output_format	imagesOutputFormat	Format pliku, w którym są zwracane wygenerowane obrazy. Obsługiwane tylko w przypadku modeli serii gpt-image-1.	Nr	Png
monit	ciąg	Opis tekstu żądanych obrazów. Maksymalna długość to 32000 znaków dla modeli serii gpt-image-1 i 4000 znaków dla dall-e-3	Tak
Jakości	imageQuality	Jakość obrazu, który zostanie wygenerowany.	Nr	Automatycznie
response_format	imagesResponseFormat	Format, w którym są zwracane wygenerowane obrazy. Obsługiwane tylko dla dall-e-3.	Nr	Adres url
Rozmiar	Imagesize	Rozmiar wygenerowanych obrazów.	Nr	Automatycznie
styl	imageStyle	Styl wygenerowanych obrazów. Obsługiwane tylko dla dall-e-3.	Nr	Żywe
użytkownik	ciąg	Unikatowy identyfikator reprezentujący użytkownika końcowego, który może pomóc w monitorowaniu i wykrywaniu nadużyć.	Nr

imageEditsRequest

Nazwa	Typ	Opis	Wymagane	Domyślny
obraz	ciąg lub tablica	Obrazy do edycji. Musi być obsługiwanym plikiem obrazu lub tablicą obrazów. Każdy obraz powinien być plikiem png lub jpg mniejszym niż 25 MB.	Tak
maska	ciąg	Dodatkowy obraz, którego w pełni przezroczyste obszary (np. alfa ma wartość zero) wskazują, gdzie ma być edytowany obraz. Jeśli dostępnych jest wiele obrazów, maska zostanie zastosowana do pierwszego obrazu. Musi być prawidłowym plikiem PNG, mniejszym niż 4 MB i mieć takie same wymiary jak obraz.	Nr
N	liczba całkowita	Liczba obrazów do wygenerowania.	Nr	1
monit	ciąg	Opis tekstu żądanych obrazów. Maksymalna długość to 32000 znaków.	Tak
Jakości	imageQuality	Jakość obrazu, który zostanie wygenerowany.	Nr	Automatycznie
response_format	imagesResponseFormat	Format, w którym są zwracane wygenerowane obrazy.	Nr	Adres url
Rozmiar	Imagesize	Rozmiar wygenerowanych obrazów.	Nr	Automatycznie
użytkownik	ciąg	Unikatowy identyfikator reprezentujący użytkownika końcowego, który może pomóc w monitorowaniu i wykrywaniu nadużyć.	Nr

generateImagesResponse

Nazwa	Typ	Opis	Wymagane	Domyślny
Utworzone	liczba całkowita	Sygnatura czasowa systemu unix podczas tworzenia operacji.	Tak
dane	macierz	Dane wynikowe operacji, jeśli operacja zakończyła się pomyślnie	Tak
użycie	imageGenerationsUsage	Reprezentuje szczegóły użycia tokenu dla żądań generowania obrazów. Tylko w przypadku modeli serii gpt-image-1.	Nr

imageResult

Adres URL obrazu lub zakodowany obraz, jeśli się powiedzie, i błąd w przeciwnym razie.

Nazwa	Typ	Opis	Wymagane	Domyślny
b64_json	ciąg	Obraz zakodowany w formacie base64	Nr
content_filter_results	dalleContentFilterResults	Informacje o wynikach filtrowania zawartości.	Nr
prompt_filter_results	dalleFilterResults	Informacje o kategorii filtrowania zawartości (nienawiść, przemoc seksualna, przemoc, self_harm), jeśli została wykryta, a także poziom ważności (very_low, niski, średni, wysoki, który określa intensywność i poziom ryzyka szkodliwej zawartości) i czy został przefiltrowany, czy nie. Informacje o zawartości jailbreaku i wulgaryzmach, jeśli zostały wykryte i czy zostały odfiltrowane, czy nie. Informacje o liście zablokowanych klientów, jeśli zostały odfiltrowane i jej identyfikator.	Nr
revised_prompt	ciąg	Monit, który został użyty do wygenerowania obrazu, jeśli wystąpiła jakakolwiek poprawka do monitu.	Nr
Adres url	ciąg	Adres URL obrazu.	Nr

imageGenerationsUsage

Reprezentuje szczegóły użycia tokenu dla żądań generowania obrazów. Tylko w przypadku modeli serii gpt-image-1.

Nazwa	Typ	Opis	Wymagane	Domyślny
input_tokens	liczba całkowita	Liczba tokenów wejściowych.	Nr
input_tokens_details	obiekt	Szczegółowy podział tokenów wejściowych.	Nr
└image_tokens	liczba całkowita	Liczba tokenów obrazu.	Nr
└text_tokens	liczba całkowita	Liczba tokenów tekstowych.	Nr
output_tokens	liczba całkowita	Liczba tokenów wyjściowych.	Nr
total_tokens	liczba całkowita	Całkowita liczba użytych tokenów.	Nr

linia

Obiekt wiersza zawartości składający się z sąsiedniej sekwencji elementów zawartości, takich jak wyrazy i znaczniki zaznaczenia.

Nazwa	Typ	Opis	Wymagane	Domyślny
Obejmuje	macierz	Tablica zakresów reprezentujących wykryte obiekty i informacje o polu ograniczenia.	Tak
SMS	ciąg		Tak

Span

Obiekt span reprezentujący wykryty obiekt i informacje o polu ograniczenia.

Nazwa	Typ	Opis	Wymagane	Domyślny
Długość	liczba całkowita	Długość zakresu w znakach mierzona w punktach kodu Unicode.	Tak
przesunąć	liczba całkowita	Przesunięcie znaku w tekście, na którym rozpoczyna się zakres. To przesunięcie jest definiowane jako pozycja pierwszego znaku zakresu, licząc od początku tekstu jako punkty kodowe Unicode.	Tak
Wielokąt	macierz	Tablica obiektów reprezentujących punkty w wielokącie, który otacza wykryty obiekt.	Tak
SMS	ciąg	Zawartość tekstowa zakresu reprezentująca wykryty obiekt.	Tak

runCompletionUsage

Statystyki użycia związane z uruchomieniem. Ta wartość będzie taka null , jeśli przebieg nie znajduje się w stanie terminalu (np. in_progress, queueditp.).

Nazwa	Typ	Opis	Wymagane	Domyślny
completion_tokens	liczba całkowita	Liczba tokenów ukończenia używanych w trakcie przebiegu.	Tak
prompt_tokens	liczba całkowita	Liczba tokenów monitu używanych w trakcie przebiegu.	Tak
total_tokens	liczba całkowita	Łączna liczba użytych tokenów (monit i ukończenie).	Tak

runStepCompletionUsage

Statystyki użycia związane z krokiem uruchamiania. Ta wartość będzie mieć null stan , gdy stan kroku uruchomienia to in_progress.

Nazwa	Typ	Opis	Wymagane	Domyślny
completion_tokens	liczba całkowita	Liczba tokenów ukończenia używanych w trakcie kroku uruchamiania.	Tak
prompt_tokens	liczba całkowita	Liczba tokenów monitu używanych w trakcie kroku uruchamiania.	Tak
total_tokens	liczba całkowita	Łączna liczba użytych tokenów (monit i ukończenie).	Tak

assistantsApiResponseFormatOption

Określa format, który model musi wyświetlić. Zgodność z GPT-4o, GPT-4 Turbo i wszystkimi modelami GPT-3.5 Turbo od gpt-3.5-turbo-1106.

Ustawienie umożliwia { "type": "json_schema", "json_schema": {...} } włączenie danych wyjściowych ze strukturą, które zapewniają, że model jest zgodny z podanym schematem JSON. Dowiedz się więcej w przewodniku Dotyczącym danych wyjściowych ze strukturą.

Ustawienie w celu { "type": "json_object" } włączenia trybu JSON, co gwarantuje, że komunikat generowany przez model jest prawidłowym kodem JSON.

Ważne: w przypadku korzystania z trybu JSON należy również poinstruować model, aby samodzielnie wygenerował kod JSON za pośrednictwem komunikatu systemowego lub użytkownika. Bez tego model może wygenerować niekończący się strumień białych znaków, dopóki generowanie nie osiągnie limitu tokenu, co spowoduje długotrwałe i pozornie "zablokowane" żądanie. Należy również zauważyć, że zawartość wiadomości może być częściowo odcięta, jeśli finish_reason="length", co wskazuje, że generacja przekroczyła max_tokens lub konwersacja przekroczyła maksymalną długość kontekstu.

Ten składnik może być jednym z następujących elementów:

• ResponseFormatText
• ResponseFormatJsonObject
• ResponseFormatJsonSchema

assistantsApiResponseFormat

Obiekt opisujący oczekiwane dane wyjściowe modelu. Jeśli json_object tylko typ function może zostać przekazany do tools przebiegu. Jeśli text model może zwrócić tekst lub dowolną wymaganą wartość.

Nazwa	Typ	Opis	Wymagane	Domyślny
typ	ciąg	Musi być jednym z text elementów lub json_object.	Nr	SMS

typ Enum: AssistantsApiResponseFormat

Wartość	Opis
SMS
json_object

assistantObject

Reprezentuje element assistant , który może wywoływać model i używać narzędzi.

Nazwa	Typ	Opis	Wymagane	Domyślny
created_at	liczba całkowita	Sygnatura czasowa systemu Unix (w sekundach) dla momentu utworzenia asystenta.	Tak
Opis	ciąg	Opis asystenta. Maksymalna długość to 512 znaków.	Tak
Identyfikator	ciąg	Identyfikator, do którego można odwoływać się w punktach końcowych interfejsu API.	Tak
Instrukcje	ciąg	Instrukcje systemowe używane przez asystenta. Maksymalna długość to 256 000 znaków.	Tak
metadane	obiekt	Zestaw 16 par klucz-wartość, które można dołączyć do obiektu. Może to być przydatne do przechowywania dodatkowych informacji o obiekcie w formacie ustrukturyzowanym. Klucze mogą mieć długość maksymalnie 64 znaków, a wartości mogą mieć długość maksymalnie 512 znaków.	Tak
model	ciąg	Identyfikator modelu do użycia.	Tak
Nazwa	ciąg	Nazwa asystenta. Maksymalna długość to 256 znaków.	Tak
obiekt	ciąg	Typ obiektu, który jest zawsze assistant.	Tak
response_format	assistantsApiResponseFormatOption	Określa format, który model musi wyświetlić. Zgodność z GPT-4o, GPT-4 Turbo i wszystkimi modelami GPT-3.5 Turbo od gpt-3.5-turbo-1106. Ustawienie umożliwia { "type": "json_schema", "json_schema": {...} } włączenie danych wyjściowych ze strukturą, które zapewniają, że model jest zgodny z podanym schematem JSON. Dowiedz się więcej w przewodniku Dotyczącym danych wyjściowych ze strukturą. Ustawienie w celu { "type": "json_object" } włączenia trybu JSON, co gwarantuje, że komunikat generowany przez model jest prawidłowym kodem JSON. Ważne: w przypadku korzystania z trybu JSON należy również poinstruować model, aby samodzielnie wygenerował kod JSON za pośrednictwem komunikatu systemowego lub użytkownika. Bez tego model może wygenerować niekończący się strumień białych znaków, dopóki generowanie nie osiągnie limitu tokenu, co spowoduje długotrwałe i pozornie "zablokowane" żądanie. Należy również zauważyć, że zawartość wiadomości może być częściowo odcięta, jeśli finish_reason="length", co wskazuje, że generacja przekroczyła max_tokens lub konwersacja przekroczyła maksymalną długość kontekstu.	Nr
Temperatury	Numer	Jaka temperatura próbkowania ma być używana z zakresu od 0 do 2. Wyższe wartości, takie jak 0,8, sprawią, że dane wyjściowe będą bardziej losowe, a niższe wartości, takie jak 0,2, sprawią, że będzie bardziej skoncentrowany i deterministyczny.	Nr	1
tool_resources	obiekt	Zestaw zasobów używanych przez narzędzia asystenta. Zasoby są specyficzne dla typu narzędzia. Na przykład code_interpreter narzędzie wymaga listy identyfikatorów plików, a file_search narzędzie wymaga listy identyfikatorów magazynów wektorów.	Nr
└code_interpreter	obiekt		Nr
└file_ids	macierz	Lista identyfikatorów plików udostępnionych narzędziu code_interpreter . Może istnieć maksymalnie 20 plików skojarzonych z narzędziem.	Nr	[]
└file_search	obiekt		Nr
└vector_store_ids	macierz	Identyfikator magazynu wektorów dołączony do tego asystenta. Może istnieć maksymalnie 1 magazyn wektorów dołączony do asystenta.	Nr
Narzędzia	macierz	Lista narzędzi włączona w asystencie. Może istnieć maksymalnie 128 narzędzi na asystenta. Narzędzia mogą być typami code_interpreter, file_searchlub function.	Tak	[]
top_p	Numer	Alternatywą dla próbkowania z temperaturą, nazywaną próbkowaniem jądra, gdzie model uwzględnia wyniki tokenów z top_p masą prawdopodobieństwa. Dlatego 0,1 oznacza, że uwzględniane są tylko tokeny składające się z 10 pierwszych% masy prawdopodobieństwa. Ogólnie zalecamy zmianę tej wartości lub temperatury, ale nie obu.	Nr	1

object Enum: AssistantObjectType

Wartość	Opis
asystent	Typ obiektu, który jest zawsze asystentem

createAssistantRequest

Nazwa	Typ	Opis	Wymagane	Domyślny
Opis	ciąg	Opis asystenta. Maksymalna długość to 512 znaków.	Nr
Instrukcje	ciąg	Instrukcje systemowe używane przez asystenta. Maksymalna długość to 256 000 znaków.	Nr
metadane	obiekt	Zestaw 16 par klucz-wartość, które można dołączyć do obiektu. Może to być przydatne do przechowywania dodatkowych informacji o obiekcie w formacie ustrukturyzowanym. Klucze mogą mieć długość maksymalnie 64 znaków, a wartości mogą mieć długość maksymalnie 512 znaków.	Nr
model	ciąg		Tak
Nazwa	ciąg	Nazwa asystenta. Maksymalna długość to 256 znaków.	Nr
response_format	assistantsApiResponseFormatOption	Określa format, który model musi wyświetlić. Zgodność z GPT-4o, GPT-4 Turbo i wszystkimi modelami GPT-3.5 Turbo od gpt-3.5-turbo-1106. Ustawienie umożliwia { "type": "json_schema", "json_schema": {...} } włączenie danych wyjściowych ze strukturą, które zapewniają, że model jest zgodny z podanym schematem JSON. Dowiedz się więcej w przewodniku Dotyczącym danych wyjściowych ze strukturą. Ustawienie w celu { "type": "json_object" } włączenia trybu JSON, co gwarantuje, że komunikat generowany przez model jest prawidłowym kodem JSON. Ważne: w przypadku korzystania z trybu JSON należy również poinstruować model, aby samodzielnie wygenerował kod JSON za pośrednictwem komunikatu systemowego lub użytkownika. Bez tego model może wygenerować niekończący się strumień białych znaków, dopóki generowanie nie osiągnie limitu tokenu, co spowoduje długotrwałe i pozornie "zablokowane" żądanie. Należy również zauważyć, że zawartość wiadomości może być częściowo odcięta, jeśli finish_reason="length", co wskazuje, że generacja przekroczyła max_tokens lub konwersacja przekroczyła maksymalną długość kontekstu.	Nr
Temperatury	Numer	Jaka temperatura próbkowania ma być używana z zakresu od 0 do 2. Wyższe wartości, takie jak 0,8, sprawią, że dane wyjściowe będą bardziej losowe, a niższe wartości, takie jak 0,2, sprawią, że będzie bardziej skoncentrowany i deterministyczny.	Nr	1
tool_resources	obiekt	Zestaw zasobów używanych przez narzędzia asystenta. Zasoby są specyficzne dla typu narzędzia. Na przykład code_interpreter narzędzie wymaga listy identyfikatorów plików, a file_search narzędzie wymaga listy identyfikatorów magazynów wektorów.	Nr
└code_interpreter	obiekt		Nr
└file_ids	macierz	Lista identyfikatorów plików udostępnionych narzędziu code_interpreter . Może istnieć maksymalnie 20 plików skojarzonych z narzędziem.	Nr	[]
└file_search	obiekt		Nr
└vector_store_ids	macierz	Magazyn wektorów dołączony do tego asystenta. Może istnieć maksymalnie 1 magazyn wektorów dołączony do asystenta.	Nr
└vector_stores	macierz	Pomocnik do tworzenia magazynu wektorów z file_ids i dołączania go do tego asystenta. Może istnieć maksymalnie 1 magazyn wektorów dołączony do asystenta.	Nr
Narzędzia	macierz	Lista narzędzi włączona w asystencie. Może istnieć maksymalnie 128 narzędzi na asystenta. Narzędzia mogą być typami code_interpreter, retrievallub function.	Nr	[]
top_p	Numer	Alternatywą dla próbkowania z temperaturą, nazywaną próbkowaniem jądra, gdzie model uwzględnia wyniki tokenów z top_p masą prawdopodobieństwa. Dlatego 0,1 oznacza, że uwzględniane są tylko tokeny składające się z 10 pierwszych% masy prawdopodobieństwa. Ogólnie zalecamy zmianę tej wartości lub temperatury, ale nie obu.	Nr	1

modifyAssistantRequest

Nazwa	Typ	Opis	Wymagane	Domyślny
Opis	ciąg	Opis asystenta. Maksymalna długość to 512 znaków.	Nr
Instrukcje	ciąg	Instrukcje systemowe używane przez asystenta. Maksymalna długość to 32768 znaków.	Nr
metadane	obiekt	Zestaw 16 par klucz-wartość, które można dołączyć do obiektu. Może to być przydatne do przechowywania dodatkowych informacji o obiekcie w formacie ustrukturyzowanym. Klucze mogą mieć długość maksymalnie 64 znaków, a wartości mogą mieć długość maksymalnie 512 znaków.	Nr
model	ciąg		Nr
Nazwa	ciąg	Nazwa asystenta. Maksymalna długość to 256 znaków.	Nr
response_format	assistantsApiResponseFormatOption	Określa format, który model musi wyświetlić. Zgodność z GPT-4o, GPT-4 Turbo i wszystkimi modelami GPT-3.5 Turbo od gpt-3.5-turbo-1106. Ustawienie umożliwia { "type": "json_schema", "json_schema": {...} } włączenie danych wyjściowych ze strukturą, które zapewniają, że model jest zgodny z podanym schematem JSON. Dowiedz się więcej w przewodniku Dotyczącym danych wyjściowych ze strukturą. Ustawienie w celu { "type": "json_object" } włączenia trybu JSON, co gwarantuje, że komunikat generowany przez model jest prawidłowym kodem JSON. Ważne: w przypadku korzystania z trybu JSON należy również poinstruować model, aby samodzielnie wygenerował kod JSON za pośrednictwem komunikatu systemowego lub użytkownika. Bez tego model może wygenerować niekończący się strumień białych znaków, dopóki generowanie nie osiągnie limitu tokenu, co spowoduje długotrwałe i pozornie "zablokowane" żądanie. Należy również zauważyć, że zawartość wiadomości może być częściowo odcięta, jeśli finish_reason="length", co wskazuje, że generacja przekroczyła max_tokens lub konwersacja przekroczyła maksymalną długość kontekstu.	Nr
Temperatury	Numer	Jaka temperatura próbkowania ma być używana z zakresu od 0 do 2. Wyższe wartości, takie jak 0,8, sprawią, że dane wyjściowe będą bardziej losowe, a niższe wartości, takie jak 0,2, sprawią, że będzie bardziej skoncentrowany i deterministyczny.	Nr	1
tool_resources	obiekt	Zestaw zasobów używanych przez narzędzia asystenta. Zasoby są specyficzne dla typu narzędzia. Na przykład code_interpreter narzędzie wymaga listy identyfikatorów plików, a file_search narzędzie wymaga listy identyfikatorów magazynów wektorów.	Nr
└code_interpreter	obiekt		Nr
└file_ids	macierz	Zastępuje listę identyfikatorów plików udostępnionych narzędziu code_interpreter . Może istnieć maksymalnie 20 plików skojarzonych z narzędziem.	Nr	[]
└file_search	obiekt		Nr
└vector_store_ids	macierz	Zastępuje magazyn wektorów dołączony do tego asystenta. Może istnieć maksymalnie 1 magazyn wektorów dołączony do asystenta.	Nr
Narzędzia	macierz	Lista narzędzi włączona w asystencie. Może istnieć maksymalnie 128 narzędzi na asystenta. Narzędzia mogą być typami code_interpreter, retrievallub function.	Nr	[]
top_p	Numer	Alternatywą dla próbkowania z temperaturą, nazywaną próbkowaniem jądra, gdzie model uwzględnia wyniki tokenów z top_p masą prawdopodobieństwa. Dlatego 0,1 oznacza, że uwzględniane są tylko tokeny składające się z 10 pierwszych% masy prawdopodobieństwa. Ogólnie zalecamy zmianę tej wartości lub temperatury, ale nie obu.	Nr	1

deleteAssistantResponse

Nazwa	Typ	Opis	Wymagane	Domyślny
Usunięte	Boolean		Tak
Identyfikator	ciąg		Tak
obiekt	ciąg		Tak

object Enum: DeleteAssistantResponseState

Wartość	Opis
assistant.deleted

listAssistantsResponse

Nazwa	Typ	Opis	Wymagane	Domyślny
dane	macierz		Tak
first_id	ciąg		Tak
has_more	Boolean		Tak
last_id	ciąg		Tak
obiekt	ciąg		Tak

assistantToolsCode

Nazwa	Typ	Opis	Wymagane	Domyślny
typ	ciąg	Typ zdefiniowanego narzędzia: code_interpreter	Tak

typ Enum: assistantToolsCodeType

Wartość	Opis
code_interpreter

assistantToolsFileSearch

Nazwa	Typ	Opis	Wymagane	Domyślny
file_search	obiekt	Zastępuje narzędzie do wyszukiwania plików.	Nr
└max_num_results	liczba całkowita	Maksymalna liczba wyników, które narzędzie wyszukiwania plików powinno wyświetlić. Wartość domyślna to 20 dla modeli gpt-4* i 5 dla gpt-3,5-turbo. Ta liczba powinna należeć do zakresu od 1 do 50 włącznie. Należy pamiętać, że narzędzie wyszukiwania plików może zwracać mniej niż max_num_results wyniki.	Nr
typ	ciąg	Typ zdefiniowanego narzędzia: file_search	Tak

type Enum: typWyszukiwaniaPlikówNarzędziAsystenta

Wartość	Opis
file_search

assistantToolsFileSearchTypeOnly

Nazwa	Typ	Opis	Wymagane	Domyślny
typ	ciąg	Typ zdefiniowanego narzędzia: file_search	Tak

type Enum: typWyszukiwaniaPlikówNarzędziAsystenta

Wartość	Opis
file_search

assistantToolsFunction

Nazwa	Typ	Opis	Wymagane	Domyślny
funkcja	obiekt	Definicja funkcji.	Tak
Opis └*	ciąg	Opis działania funkcji używanej przez model do wyboru, kiedy i jak wywołać funkcję.	Nr
└* nazwa	ciąg	Nazwa funkcji do wywołania. Musi być a-z, A-Z, 0-9 lub zawierać podkreślenia i kreski o maksymalnej długości 64.	Nr
Parametry └*	chatCompletionFunctionParameters	Parametry akceptowane przez funkcje, opisane jako obiekt schematu JSON. Zapoznaj się z przewodnikiem/ , aby zapoznać się z przykładami, oraz dokumentacją dotyczącą schematu JSON , aby uzyskać dokumentację dotyczącą formatu.	Nr
typ	ciąg	Typ zdefiniowanego narzędzia: function	Tak

type Enum: assistantToolsFunction

Wartość	Opis
funkcja

obcięcie obiektuObject

Określa sposób obcinania wątku przed uruchomieniem. Służy do kontrolowania początkowego okna kontekstu przebiegu.

Nazwa	Typ	Opis	Wymagane	Domyślny
last_messages	liczba całkowita	Liczba najnowszych komunikatów z wątku podczas konstruowania kontekstu przebiegu.	Nr
typ	ciąg	Strategia obcinania do użycia dla wątku. Wartość domyślna to auto. Jeśli ustawiono wartość last_messages, wątek zostanie obcięty do n najnowszych komunikatów w wątku. Po ustawieniu autowartości na wartość komunikaty w środku wątku zostaną porzucone w celu dopasowania do długości kontekstu modelu . max_prompt_tokens	Tak

typ Enum: TruncationType

Wartość	Opis
Automatycznie
last_messages

assistantsApiToolChoiceOption

Określa, które narzędzie (jeśli istnieje) jest wywoływane przez model. none oznacza, że model nie będzie wywoływać żadnych narzędzi i zamiast tego generuje komunikat. auto jest wartością domyślną i oznacza, że model może wybierać między generowaniem komunikatu lub wywoływaniem narzędzia. Określenie określonego narzędzia, takiego jak {"type": "file_search"} lub {"type": "function", "function": {"name": "my_function"}} wymusza wywołanie tego narzędzia przez model.

Ten składnik może być jednym z następujących elementów:

• assistantsNamedToolChoice

assistantsNamedToolChoice

Określa narzędzie, które ma być używane przez model. Użyj polecenia , aby wymusić wywołanie określonego narzędzia przez model.

Nazwa	Typ	Opis	Wymagane	Domyślny
funkcja	obiekt		Nr
└* nazwa	ciąg	Nazwa funkcji do wywołania.	Nr
typ	ciąg	Typ narzędzia. Jeśli typ to function, należy ustawić nazwę funkcji	Tak

typ Enumowy: AssistantsNamedToolChoiceType

Wartość	Opis
funkcja
code_interpreter
file_search

runObject

Reprezentuje przebieg wykonywania w wątkach.

Nazwa	Typ	Opis	Wymagane	Domyślny
assistant_id	ciąg	Identyfikator asystenta używanego do wykonywania tego przebiegu.	Tak
cancelled_at	liczba całkowita	Sygnatura czasowa systemu Unix (w sekundach) dla momentu anulowania przebiegu.	Tak
completed_at	liczba całkowita	Sygnatura czasowa systemu Unix (w sekundach) dla momentu ukończenia przebiegu.	Tak
created_at	liczba całkowita	Sygnatura czasowa systemu Unix (w sekundach) dla momentu utworzenia przebiegu.	Tak
expires_at	liczba całkowita	Sygnatura czasowa systemu Unix (w sekundach) dla czasu wygaśnięcia przebiegu.	Tak
failed_at	liczba całkowita	Sygnatura czasowa systemu Unix (w sekundach) dla czasu niepowodzenia uruchomienia.	Tak
Identyfikator	ciąg	Identyfikator, do którego można odwoływać się w punktach końcowych interfejsu API.	Tak
incomplete_details	obiekt	Szczegółowe informacje o tym, dlaczego przebieg jest niekompletny. Będzie to null , jeśli przebieg nie jest niekompletny.	Tak
└* przyczyna	ciąg	Powód, dla którego przebieg jest niekompletny. Będzie to wskazywać, który limit tokenów został osiągnięty w trakcie przebiegu.	Nr
Instrukcje	ciąg	Instrukcje używane przez asystenta do tego przebiegu.	Tak
last_error	obiekt	Ostatni błąd skojarzony z tym przebiegiem. Jeśli nie ma żadnych błędów, będzie występować null błąd.	Tak
└* kod	ciąg	Jeden z server_error lub rate_limit_exceeded.	Nr
Komunikat └*	ciąg	Czytelny dla człowieka opis błędu.	Nr
max_completion_tokens	liczba całkowita	Maksymalna liczba tokenów ukończenia określonych do użycia w trakcie przebiegu.	Tak
max_prompt_tokens	liczba całkowita	Maksymalna liczba tokenów monitów określonych do użycia w trakcie przebiegu.	Tak
metadane	obiekt	Zestaw 16 par klucz-wartość, które można dołączyć do obiektu. Może to być przydatne do przechowywania dodatkowych informacji o obiekcie w formacie ustrukturyzowanym. Klucze mogą mieć długość maksymalnie 64 znaków, a wartości mogą mieć długość maksymalnie 512 znaków.	Tak
model	ciąg	Model używany przez asystenta na potrzeby tego przebiegu.	Tak
obiekt	ciąg	Typ obiektu, który jest zawsze thread.run.	Tak
parallel_tool_calls	ParallelToolCalls	Czy włączyć równoległe wywoływanie funkcji podczas używania narzędzia.	Nr	True
required_action	obiekt	Szczegółowe informacje na temat akcji wymaganej do kontynuowania przebiegu. Będzie to null , jeśli nie jest wymagana żadna akcja.	Tak
└submit_tool_outputs	obiekt	Szczegółowe informacje na temat danych wyjściowych narzędzia potrzebnych do kontynuowania tego przebiegu.	Nr
└tool_calls	macierz	Lista odpowiednich wywołań narzędzi.	Nr
└typ	wyliczenie	Na razie jest to zawsze submit_tool_outputs. Możliwe wartości: submit_tool_outputs	Nr
response_format	assistantsApiResponseFormatOption	Określa format, który model musi wyświetlić. Zgodność z GPT-4o, GPT-4 Turbo i wszystkimi modelami GPT-3.5 Turbo od gpt-3.5-turbo-1106. Ustawienie umożliwia { "type": "json_schema", "json_schema": {...} } włączenie danych wyjściowych ze strukturą, które zapewniają, że model jest zgodny z podanym schematem JSON. Dowiedz się więcej w przewodniku Dotyczącym danych wyjściowych ze strukturą. Ustawienie w celu { "type": "json_object" } włączenia trybu JSON, co gwarantuje, że komunikat generowany przez model jest prawidłowym kodem JSON. Ważne: w przypadku korzystania z trybu JSON należy również poinstruować model, aby samodzielnie wygenerował kod JSON za pośrednictwem komunikatu systemowego lub użytkownika. Bez tego model może wygenerować niekończący się strumień białych znaków, dopóki generowanie nie osiągnie limitu tokenu, co spowoduje długotrwałe i pozornie "zablokowane" żądanie. Należy również zauważyć, że zawartość wiadomości może być częściowo odcięta, jeśli finish_reason="length", co wskazuje, że generacja przekroczyła max_tokens lub konwersacja przekroczyła maksymalną długość kontekstu.	Tak
started_at	liczba całkowita	Sygnatura czasowa systemu Unix (w sekundach) dla momentu uruchomienia przebiegu.	Tak
stan	ciąg	Stan przebiegu, który może mieć queuedwartość , , in_progress, requires_actioncancellingcancelledfailed, completedlub .expired	Tak
Temperatury	Numer	Temperatura próbkowania używana na potrzeby tego przebiegu. Jeśli nie zostanie ustawiona, wartość domyślna to 1.	Nr
thread_id	ciąg	Identyfikator wątków, które zostały wykonane w ramach tego przebiegu.	Tak
tool_choice	assistantsApiToolChoiceOption	Określa, które narzędzie (jeśli istnieje) jest wywoływane przez model. none oznacza, że model nie będzie wywoływać żadnych narzędzi i zamiast tego generuje komunikat. auto jest wartością domyślną i oznacza, że model może wybierać między generowaniem komunikatu lub wywoływaniem narzędzia. Określenie określonego narzędzia, takiego jak {"type": "file_search"} lub {"type": "function", "function": {"name": "my_function"}} wymusza wywołanie tego narzędzia przez model.	Tak
Narzędzia	macierz	Lista narzędzi używanych przez asystenta do tego przebiegu.	Tak	[]
top_p	Numer	Wartość próbkowania jądra użyta na potrzeby tego przebiegu. Jeśli nie zostanie ustawiona, wartość domyślna to 1.	Nr
truncation_strategy	obcięcie obiektuObject	Określa sposób obcinania wątku przed uruchomieniem. Służy do kontrolowania początkowego okna kontekstu przebiegu.	Tak
użycie	runCompletionUsage	Statystyki użycia związane z uruchomieniem. Ta wartość będzie taka null , jeśli przebieg nie znajduje się w stanie terminalu (np. in_progress, queueditp.).	Tak

object Enum: runObjectType

Wartość	Opis
thread.run	Typ obiektu przebiegu, który jest zawsze thread.run

status Enum: StatusUruchomieniaObiektu

Wartość	Opis
w kolejce	Stan w kolejce
in_progress	Stan in_progress
requires_action	Stan required_action
Anulowanie	Stan anulowania
Anulowane	Stan anulowany
Nie powiodło się	Stan niepowodzenia
Zakończone	Stan ukończony
Wygasłe	Stan wygasły

createRunRequest

Nazwa	Typ	Opis	Wymagane	Domyślny
additional_instructions	ciąg	Dołącza dodatkowe instrukcje na końcu instrukcji dotyczących przebiegu. Jest to przydatne w przypadku modyfikowania zachowania dla poszczególnych przebiegów bez zastępowania innych instrukcji.	Nr
additional_messages	macierz	Dodaje dodatkowe komunikaty do wątku przed utworzeniem przebiegu.	Nr
assistant_id	ciąg	Identyfikator asystenta do wykonania tego przebiegu.	Tak
Instrukcje	ciąg	Zastąpi domyślny komunikat systemowy asystenta. Jest to przydatne w przypadku modyfikowania zachowania dla poszczególnych przebiegów.	Nr
max_completion_tokens	liczba całkowita	Maksymalna liczba tokenów ukończenia, które mogą być używane w trakcie przebiegu. Przebieg najlepiej sprawdza się, jak używać tylko określonej liczby tokenów ukończenia w wielu zakrętach przebiegu. Jeśli przebieg przekroczy określoną liczbę tokenów ukończenia, przebieg zakończy się stanem incomplete. Zobacz incomplete_details , aby uzyskać więcej informacji.	Nr
max_prompt_tokens	liczba całkowita	Maksymalna liczba tokenów monitów, które mogą być używane w trakcie przebiegu. Przebieg najlepiej sprawdza się, jak używać tylko określonej liczby tokenów monitu w wielu zakrętach przebiegu. Jeśli przebieg przekroczy określoną liczbę tokenów monitu, przebieg zakończy się stanem incomplete. Zobacz incomplete_details , aby uzyskać więcej informacji.	Nr
metadane	obiekt	Zestaw 16 par klucz-wartość, które można dołączyć do obiektu. Może to być przydatne do przechowywania dodatkowych informacji o obiekcie w formacie ustrukturyzowanym. Klucze mogą mieć długość maksymalnie 64 znaków, a wartości mogą mieć długość maksymalnie 512 znaków.	Nr
model	ciąg	Identyfikator modelu, który ma być używany do wykonania tego przebiegu. Jeśli w tym miejscu zostanie podana wartość, zastąpi ona model skojarzony z asystentem. Jeśli nie, zostanie użyty model skojarzony z asystentem.	Nr
parallel_tool_calls	ParallelToolCalls	Czy włączyć równoległe wywoływanie funkcji podczas używania narzędzia.	Nr	True
response_format	assistantsApiResponseFormatOption	Określa format, który model musi wyświetlić. Zgodność z GPT-4o, GPT-4 Turbo i wszystkimi modelami GPT-3.5 Turbo od gpt-3.5-turbo-1106. Ustawienie umożliwia { "type": "json_schema", "json_schema": {...} } włączenie danych wyjściowych ze strukturą, które zapewniają, że model jest zgodny z podanym schematem JSON. Dowiedz się więcej w przewodniku Dotyczącym danych wyjściowych ze strukturą. Ustawienie w celu { "type": "json_object" } włączenia trybu JSON, co gwarantuje, że komunikat generowany przez model jest prawidłowym kodem JSON. Ważne: w przypadku korzystania z trybu JSON należy również poinstruować model, aby samodzielnie wygenerował kod JSON za pośrednictwem komunikatu systemowego lub użytkownika. Bez tego model może wygenerować niekończący się strumień białych znaków, dopóki generowanie nie osiągnie limitu tokenu, co spowoduje długotrwałe i pozornie "zablokowane" żądanie. Należy również zauważyć, że zawartość wiadomości może być częściowo odcięta, jeśli finish_reason="length", co wskazuje, że generacja przekroczyła max_tokens lub konwersacja przekroczyła maksymalną długość kontekstu.	Nr
odtwarzać strumieniowo	Boolean	Jeśli trueprogram zwraca strumień zdarzeń, które występują podczas zdarzeń Uruchom jako serwer, kończy się po wprowadzeniu stanu terminalu z komunikatem data: [DONE] .	Nr
Temperatury	Numer	Jaka temperatura próbkowania ma być używana z zakresu od 0 do 2. Wyższe wartości, takie jak 0,8, sprawią, że dane wyjściowe będą bardziej losowe, a niższe wartości, takie jak 0,2, sprawią, że będzie bardziej skoncentrowany i deterministyczny.	Nr	1
tool_choice	assistantsApiToolChoiceOption	Określa, które narzędzie (jeśli istnieje) jest wywoływane przez model. none oznacza, że model nie będzie wywoływać żadnych narzędzi i zamiast tego generuje komunikat. auto jest wartością domyślną i oznacza, że model może wybierać między generowaniem komunikatu lub wywoływaniem narzędzia. Określenie określonego narzędzia, takiego jak {"type": "file_search"} lub {"type": "function", "function": {"name": "my_function"}} wymusza wywołanie tego narzędzia przez model.	Nr
Narzędzia	macierz	Zastąpić narzędzia, których asystent może użyć na potrzeby tego przebiegu. Jest to przydatne w przypadku modyfikowania zachowania dla poszczególnych przebiegów.	Nr
top_p	Numer	Alternatywą dla próbkowania z temperaturą, nazywaną próbkowaniem jądra, gdzie model uwzględnia wyniki tokenów z top_p masą prawdopodobieństwa. Dlatego 0,1 oznacza, że uwzględniane są tylko tokeny składające się z 10 pierwszych% masy prawdopodobieństwa. Ogólnie zalecamy zmianę tej wartości lub temperatury, ale nie obu.	Nr	1
truncation_strategy	obcięcie obiektuObject	Określa sposób obcinania wątku przed uruchomieniem. Służy do kontrolowania początkowego okna kontekstu przebiegu.	Nr

listRunsResponse

Nazwa	Typ	Opis	Wymagane	Domyślny
dane	macierz		Tak
first_id	ciąg		Tak
has_more	Boolean		Tak
last_id	ciąg		Tak
obiekt	ciąg		Tak

modifyRunRequest

Nazwa	Typ	Opis	Wymagane	Domyślny
metadane	obiekt	Zestaw 16 par klucz-wartość, które można dołączyć do obiektu. Może to być przydatne do przechowywania dodatkowych informacji o obiekcie w formacie ustrukturyzowanym. Klucze mogą mieć długość maksymalnie 64 znaków, a wartości mogą mieć długość maksymalnie 512 znaków.	Nr

submitToolOutputsRunRequest

Nazwa	Typ	Opis	Wymagane	Domyślny
odtwarzać strumieniowo	Boolean	Jeśli trueprogram zwraca strumień zdarzeń, które występują podczas zdarzeń Uruchom jako serwer, kończy się po wprowadzeniu stanu terminalu z komunikatem data: [DONE] .	Nr
tool_outputs	macierz	Lista narzędzi, dla których są przesyłane dane wyjściowe.	Tak

runToolCallObject

Obiekty wywołania narzędzi

Nazwa	Typ	Opis	Wymagane	Domyślny
funkcja	obiekt	Definicja funkcji.	Tak
Argumenty └*	ciąg	Argumenty, które model oczekuje przekazania do funkcji.	Nr
└* nazwa	ciąg	Nazwa funkcji.	Nr
Identyfikator	ciąg	Identyfikator wywołania narzędzia. Ten identyfikator należy przywoływać podczas przesyłania danych wyjściowych narzędzia przy użyciu danych wyjściowych narzędzia przesyłania w celu uruchomienia punktu końcowego.	Tak
typ	ciąg	Typ narzędzia wywołującego dane wyjściowe jest wymagany. Na razie jest to zawsze function.	Tak

Typ Enum: RunToolCallObjectType

Wartość	Opis
funkcja

createThreadAndRunRequest

Nazwa	Typ	Opis	Wymagane	Domyślny
assistant_id	ciąg	Identyfikator asystenta do wykonania tego przebiegu.	Tak
Instrukcje	ciąg	Zastąpi domyślny komunikat systemowy asystenta. Jest to przydatne w przypadku modyfikowania zachowania dla poszczególnych przebiegów.	Nr
max_completion_tokens	liczba całkowita	Maksymalna liczba tokenów ukończenia, które mogą być używane w trakcie przebiegu. Przebieg najlepiej sprawdza się, jak używać tylko określonej liczby tokenów ukończenia w wielu zakrętach przebiegu. Jeśli przebieg przekroczy określoną liczbę tokenów ukończenia, przebieg zakończy się stanem incomplete. Zobacz incomplete_details , aby uzyskać więcej informacji.	Nr
max_prompt_tokens	liczba całkowita	Maksymalna liczba tokenów monitów, które mogą być używane w trakcie przebiegu. Przebieg najlepiej sprawdza się, jak używać tylko określonej liczby tokenów monitu w wielu zakrętach przebiegu. Jeśli przebieg przekroczy określoną liczbę tokenów monitu, przebieg zakończy się stanem incomplete. Zobacz incomplete_details , aby uzyskać więcej informacji.	Nr
metadane	obiekt	Zestaw 16 par klucz-wartość, które można dołączyć do obiektu. Może to być przydatne do przechowywania dodatkowych informacji o obiekcie w formacie ustrukturyzowanym. Klucze mogą mieć długość maksymalnie 64 znaków, a wartości mogą mieć długość maksymalnie 512 znaków.	Nr
model	ciąg	Identyfikator modeli, które mają być używane do wykonania tego przebiegu. Jeśli w tym miejscu zostanie podana wartość, zastąpi ona model skojarzony z asystentem. Jeśli nie, zostanie użyty model skojarzony z asystentem.	Nr
parallel_tool_calls	ParallelToolCalls	Czy włączyć równoległe wywoływanie funkcji podczas używania narzędzia.	Nr	True
response_format	assistantsApiResponseFormatOption	Określa format, który model musi wyświetlić. Zgodność z GPT-4o, GPT-4 Turbo i wszystkimi modelami GPT-3.5 Turbo od gpt-3.5-turbo-1106. Ustawienie umożliwia { "type": "json_schema", "json_schema": {...} } włączenie danych wyjściowych ze strukturą, które zapewniają, że model jest zgodny z podanym schematem JSON. Dowiedz się więcej w przewodniku Dotyczącym danych wyjściowych ze strukturą. Ustawienie w celu { "type": "json_object" } włączenia trybu JSON, co gwarantuje, że komunikat generowany przez model jest prawidłowym kodem JSON. Ważne: w przypadku korzystania z trybu JSON należy również poinstruować model, aby samodzielnie wygenerował kod JSON za pośrednictwem komunikatu systemowego lub użytkownika. Bez tego model może wygenerować niekończący się strumień białych znaków, dopóki generowanie nie osiągnie limitu tokenu, co spowoduje długotrwałe i pozornie "zablokowane" żądanie. Należy również zauważyć, że zawartość wiadomości może być częściowo odcięta, jeśli finish_reason="length", co wskazuje, że generacja przekroczyła max_tokens lub konwersacja przekroczyła maksymalną długość kontekstu.	Nr
odtwarzać strumieniowo	Boolean	Jeśli trueprogram zwraca strumień zdarzeń, które występują podczas zdarzeń Uruchom jako serwer, kończy się po wprowadzeniu stanu terminalu z komunikatem data: [DONE] .	Nr
stream_options	chatCompletionStreamOptions	Opcje odpowiedzi przesyłania strumieniowego. Ustaw tę wartość tylko po ustawieniu .stream: true	Nr	Brak
Temperatury	Numer	Jaka temperatura próbkowania ma być używana z zakresu od 0 do 2. Wyższe wartości, takie jak 0,8, sprawią, że dane wyjściowe będą bardziej losowe, a niższe wartości, takie jak 0,2, sprawią, że będzie bardziej skoncentrowany i deterministyczny.	Nr	1
konwersacja	createThreadRequest		Nr
tool_choice	assistantsApiToolChoiceOption	Określa, które narzędzie (jeśli istnieje) jest wywoływane przez model. none oznacza, że model nie będzie wywoływać żadnych narzędzi i zamiast tego generuje komunikat. auto jest wartością domyślną i oznacza, że model może wybierać między generowaniem komunikatu lub wywoływaniem narzędzia. Określenie określonego narzędzia, takiego jak {"type": "file_search"} lub {"type": "function", "function": {"name": "my_function"}} wymusza wywołanie tego narzędzia przez model.	Nr
tool_resources	obiekt	Zestaw zasobów używanych przez narzędzia asystenta. Zasoby są specyficzne dla typu narzędzia. Na przykład code_interpreter narzędzie wymaga listy identyfikatorów plików, a file_search narzędzie wymaga listy identyfikatorów magazynów wektorów.	Nr
└code_interpreter	obiekt		Nr
└file_ids	macierz	Lista identyfikatorów plików udostępnionych narzędziu code_interpreter . Może istnieć maksymalnie 20 plików skojarzonych z narzędziem.	Nr	[]
└file_search	obiekt		Nr
└vector_store_ids	macierz	Identyfikator magazynu wektorów dołączony do tego asystenta. Może istnieć maksymalnie 1 magazyn wektorów dołączony do asystenta.	Nr
Narzędzia	macierz	Zastąpić narzędzia, których asystent może użyć na potrzeby tego przebiegu. Jest to przydatne w przypadku modyfikowania zachowania dla poszczególnych przebiegów.	Nr
top_p	Numer	Alternatywą dla próbkowania z temperaturą, nazywaną próbkowaniem jądra, gdzie model uwzględnia wyniki tokenów z top_p masą prawdopodobieństwa. Dlatego 0,1 oznacza, że uwzględniane są tylko tokeny składające się z 10 pierwszych% masy prawdopodobieństwa. Ogólnie zalecamy zmianę tej wartości lub temperatury, ale nie obu.	Nr	1
truncation_strategy	obcięcie obiektuObject	Określa sposób obcinania wątku przed uruchomieniem. Służy do kontrolowania początkowego okna kontekstu przebiegu.	Nr

threadObject

Reprezentuje wątek zawierający komunikaty.

Nazwa	Typ	Opis	Wymagane	Domyślny
created_at	liczba całkowita	Sygnatura czasowa systemu Unix (w sekundach) dla momentu utworzenia wątku.	Tak
Identyfikator	ciąg	Identyfikator, do którego można odwoływać się w punktach końcowych interfejsu API.	Tak
metadane	obiekt	Zestaw 16 par klucz-wartość, które można dołączyć do obiektu. Może to być przydatne do przechowywania dodatkowych informacji o obiekcie w formacie ustrukturyzowanym. Klucze mogą mieć długość maksymalnie 64 znaków, a wartości mogą mieć długość maksymalnie 512 znaków.	Tak
obiekt	ciąg	Typ obiektu, który jest zawsze thread.	Tak
tool_resources	obiekt	Zestaw zasobów udostępnianych narzędziom asystenta w tym wątku. Zasoby są specyficzne dla typu narzędzia. Na przykład code_interpreter narzędzie wymaga listy identyfikatorów plików, a file_search narzędzie wymaga listy identyfikatorów magazynów wektorów.	Tak
└code_interpreter	obiekt		Nr
└file_ids	macierz	Lista identyfikatorów plików udostępnionych narzędziu code_interpreter . Może istnieć maksymalnie 20 plików skojarzonych z narzędziem.	Nr	[]
└file_search	obiekt		Nr
└vector_store_ids	macierz	Magazyn wektorów dołączony do tego wątku. Może istnieć maksymalnie 1 magazyn wektorów dołączony do wątku.	Nr

object Enum: ThreadObjectType

Wartość	Opis
konwersacja	Typ obiektu wątku, który jest zawsze thread

createThreadRequest

Nazwa	Typ	Opis	Wymagane	Domyślny
Wiadomości	macierz	Lista komunikatów, z których chcesz rozpocząć wątek.	Nr
metadane	obiekt	Zestaw 16 par klucz-wartość, które można dołączyć do obiektu. Może to być przydatne do przechowywania dodatkowych informacji o obiekcie w formacie ustrukturyzowanym. Klucze mogą mieć długość maksymalnie 64 znaków, a wartości mogą mieć długość maksymalnie 512 znaków.	Nr
tool_resources	obiekt	Zestaw zasobów udostępnianych narzędziom asystenta w tym wątku. Zasoby są specyficzne dla typu narzędzia. Na przykład code_interpreter narzędzie wymaga listy identyfikatorów plików, a file_search narzędzie wymaga listy identyfikatorów magazynów wektorów.	Nr
└code_interpreter	obiekt		Nr
└file_ids	macierz	Lista identyfikatorów plików udostępnionych narzędziu code_interpreter . Może istnieć maksymalnie 20 plików skojarzonych z narzędziem.	Nr	[]
└file_search	obiekt		Nr
└vector_store_ids	macierz	Magazyn wektorów dołączony do tego wątku. Może istnieć maksymalnie 1 magazyn wektorów dołączony do wątku.	Nr
└vector_stores	macierz	Pomocnik do tworzenia magazynu wektorów z file_ids i dołączania go do tego wątku. Może istnieć maksymalnie 1 magazyn wektorów dołączony do wątku.	Nr

modifyThreadRequest

Nazwa	Typ	Opis	Wymagane	Domyślny
metadane	obiekt	Zestaw 16 par klucz-wartość, które można dołączyć do obiektu. Może to być przydatne do przechowywania dodatkowych informacji o obiekcie w formacie ustrukturyzowanym. Klucze mogą mieć długość maksymalnie 64 znaków, a wartości mogą mieć długość maksymalnie 512 znaków.	Nr
tool_resources	obiekt	Zestaw zasobów udostępnianych narzędziom asystenta w tym wątku. Zasoby są specyficzne dla typu narzędzia. Na przykład code_interpreter narzędzie wymaga listy identyfikatorów plików, a file_search narzędzie wymaga listy identyfikatorów magazynów wektorów.	Nr
└code_interpreter	obiekt		Nr
└file_ids	macierz	Lista identyfikatorów plików udostępnionych narzędziu code_interpreter . Może istnieć maksymalnie 20 plików skojarzonych z narzędziem.	Nr	[]
└file_search	obiekt		Nr
└vector_store_ids	macierz	Magazyn wektorów dołączony do tego wątku. Może istnieć maksymalnie 1 magazyn wektorów dołączony do wątku.	Nr

deleteThreadResponse

Nazwa	Typ	Opis	Wymagane	Domyślny
Usunięte	Boolean		Tak
Identyfikator	ciąg		Tak
obiekt	ciąg		Tak

object Enum: DeleteThreadResponseObjectState

Wartość	Opis
thread.deleted	Stan obiektu odpowiedzi usuwania wątku, który jest thread.deleted

listThreadsResponse

Nazwa	Typ	Opis	Wymagane	Domyślny
dane	macierz		Tak
first_id	ciąg		Tak
has_more	Boolean		Tak
last_id	ciąg		Tak
obiekt	ciąg		Tak

messageObject

Reprezentuje komunikat w wątkach.

Nazwa	Typ	Opis	Wymagane	Domyślny
assistant_id	ciąg	Jeśli ma to zastosowanie, identyfikator asystenta, który napisał tę wiadomość.	Tak
Załączniki	macierz	Lista plików dołączonych do wiadomości i narzędzi, do których zostały dodane.	Tak
completed_at	liczba całkowita	Sygnatura czasowa systemu Unix (w sekundach) dla momentu zakończenia komunikatu.	Tak
zawartość	macierz	Zawartość wiadomości w tablicy tekstu i/lub obrazów.	Tak
created_at	liczba całkowita	Sygnatura czasowa systemu Unix (w sekundach) dla momentu utworzenia komunikatu.	Tak
Identyfikator	ciąg	Identyfikator, do którego można odwoływać się w punktach końcowych interfejsu API.	Tak
incomplete_at	liczba całkowita	Sygnatura czasowa systemu Unix (w sekundach) dla momentu, gdy komunikat został oznaczony jako niekompletny.	Tak
incomplete_details	obiekt	W niekompletnej wiadomości szczegółowe informacje o tym, dlaczego wiadomość jest niekompletna.	Tak
└* przyczyna	ciąg	Przyczyna, dla którego komunikat jest niekompletny.	Nr
metadane	obiekt	Zestaw 16 par klucz-wartość, które można dołączyć do obiektu. Może to być przydatne do przechowywania dodatkowych informacji o obiekcie w formacie ustrukturyzowanym. Klucze mogą mieć długość maksymalnie 64 znaków, a wartości mogą mieć długość maksymalnie 512 znaków.	Tak
obiekt	ciąg	Typ obiektu, który jest zawsze thread.message.	Tak
rola	ciąg	Jednostka, która wygenerowała komunikat. Jeden z user lub assistant.	Tak
run_id	ciąg	Jeśli ma to zastosowanie, identyfikator przebiegu skojarzonego z tworzeniem tego komunikatu.	Tak
stan	ciąg	Stan komunikatu, który może mieć in_progresswartość , incompletelub completed.	Tak
thread_id	ciąg	Identyfikator wątków, do którego należy ten komunikat.	Tak

object Enum: TypObiektuWiadomości

Wartość	Opis
thread.message	Typ obiektu komunikatu, który jest thread.message

Enum statusu: Status obiektu wiadomości

Wartość	Opis
in_progress
Niekompletna
Zakończone

rola Enum: RolaObiektuWiadomości

Wartość	Opis
użytkownik
asystent

messageDeltaObject

Reprezentuje różnicę komunikatów, tj. wszystkie zmienione pola w wiadomości podczas przesyłania strumieniowego.

Nazwa	Typ	Opis	Wymagane	Domyślny
Delta	obiekt	Delta zawierająca pola, które uległy zmianie w komunikacie.	Tak
└* zawartość	macierz	Zawartość wiadomości w tablicy tekstu i/lub obrazów.	Nr
Rola └*	ciąg	Jednostka, która wygenerowała komunikat. Jeden z user lub assistant.	Nr
Identyfikator	ciąg	Identyfikator komunikatu, do którego można się odwoływać w punktach końcowych interfejsu API.	Tak
obiekt	ciąg	Typ obiektu, który jest zawsze thread.message.delta.	Tak

obiekt Enum: MessageDeltaObjectType

Wartość	Opis
thread.message.delta

createMessageRequest

Nazwa	Typ	Opis	Wymagane	Domyślny
Załączniki	macierz	Lista plików dołączonych do wiadomości oraz narzędzia, do których należy je dodać.	Nr
zawartość	ciąg	Zawartość wiadomości.	Tak
metadane	obiekt	Zestaw 16 par klucz-wartość, które można dołączyć do obiektu. Może to być przydatne do przechowywania dodatkowych informacji o obiekcie w formacie ustrukturyzowanym. Klucze mogą mieć długość maksymalnie 64 znaków, a wartości mogą mieć długość maksymalnie 512 znaków.	Nr
rola	ciąg	Rola jednostki tworzącej komunikat. Dozwolone wartości obejmują: - user: wskazuje, że komunikat jest wysyłany przez rzeczywistego użytkownika i powinien być używany w większości przypadków do reprezentowania komunikatów generowanych przez użytkownika. - assistant: wskazuje, że komunikat jest generowany przez asystenta. Użyj tej wartości, aby wstawić wiadomości z asystenta do konwersacji.	Tak

role Enum: CreateMessageRequestRole

Wartość	Opis
użytkownik
asystent

modifyMessageRequest

Nazwa	Typ	Opis	Wymagane	Domyślny
metadane	obiekt	Zestaw 16 par klucz-wartość, które można dołączyć do obiektu. Może to być przydatne do przechowywania dodatkowych informacji o obiekcie w formacie ustrukturyzowanym. Klucze mogą mieć długość maksymalnie 64 znaków, a wartości mogą mieć długość maksymalnie 512 znaków.	Nr

deleteMessageResponse

Nazwa	Typ	Opis	Wymagane	Domyślny
Usunięte	Boolean		Tak
Identyfikator	ciąg		Tak
obiekt	ciąg		Tak

object Enum: DeleteMessageResponseObject

Wartość	Opis
thread.message.deleted	Stan obiektu odpowiedzi komunikatu usuwania

listMessagesResponse

Nazwa	Typ	Opis	Wymagane	Domyślny
dane	macierz		Tak
first_id	ciąg		Tak
has_more	Boolean		Tak
last_id	ciąg		Tak
obiekt	ciąg		Tak

messageContentImageFileObject

Odwołuje się do pliku obrazu w zawartości komunikatu.

Nazwa	Typ	Opis	Wymagane	Domyślny
image_file	obiekt		Tak
└file_id	ciąg	Identyfikator pliku obrazu w zawartości wiadomości.	Nr
typ	ciąg	Zawsze image_file.	Tak

type Enum: MessageContentImageFileObjectType

Wartość	Opis
image_file	Typ pliku obrazu zawartości wiadomości

messageContentTextObject

Zawartość tekstowa, która jest częścią wiadomości.

Nazwa	Typ	Opis	Wymagane	Domyślny
SMS	obiekt		Tak
└* adnotacje	macierz		Nr
└* wartość	ciąg	Dane tworzące tekst.	Nr
typ	ciąg	Zawsze text.	Tak

type Enum: TypObiektuTekstowegoTreściWiadomości

Wartość	Opis
SMS	Typ obiektu zawartości wiadomości

messageContentTextAnnotationsFileCitationObject

Cytat w komunikacie wskazujący określony cudzysłów z określonego pliku skojarzonego z asystentem lub komunikatem. Generowane, gdy asystent używa narzędzia "pobieranie" do wyszukiwania plików.

Nazwa	Typ	Opis	Wymagane	Domyślny
end_index	liczba całkowita		Tak
file_citation	obiekt		Tak
└file_id	ciąg	Identyfikator określonego pliku, z których pochodzi cytat.	Nr
start_index	liczba całkowita		Tak
SMS	ciąg	Tekst w zawartości wiadomości, który musi zostać zastąpiony.	Tak
typ	ciąg	Zawsze file_citation.	Tak

typ Enum: FileCitationObjectType

Wartość	Opis
file_citation	Typ obiektu cytatu pliku

messageContentTextAnnotationsFilePathObject

Adres URL pliku, który jest generowany, gdy asystent użył code_interpreter narzędzia do wygenerowania pliku.

Nazwa	Typ	Opis	Wymagane	Domyślny
end_index	liczba całkowita		Tak
file_path	obiekt		Tak
└file_id	ciąg	Identyfikator wygenerowanego pliku.	Nr
start_index	liczba całkowita		Tak
SMS	ciąg	Tekst w zawartości wiadomości, który musi zostać zastąpiony.	Tak
typ	ciąg	Zawsze file_path.	Tak

typ Enum: FilePathObjectType

Wartość	Opis
file_path	Typ obiektu ścieżki pliku

messageDeltaContentImageFileObject

Odwołuje się do pliku obrazu w zawartości komunikatu.

Nazwa	Typ	Opis	Wymagane	Domyślny
image_file	obiekt		Nr
└file_id	ciąg	Identyfikator pliku obrazu w zawartości wiadomości.	Nr
indeks	liczba całkowita	Indeks części zawartości w komunikacie.	Tak
typ	ciąg	Zawsze image_file.	Tak

type Enum: MessageDeltaContentImageFileObjectType

Wartość	Opis
image_file

messageDeltaContentTextObject

Zawartość tekstowa, która jest częścią wiadomości.

Nazwa	Typ	Opis	Wymagane	Domyślny
indeks	liczba całkowita	Indeks części zawartości w komunikacie.	Tak
SMS	obiekt		Nr
└* adnotacje	macierz		Nr
└* wartość	ciąg	Dane tworzące tekst.	Nr
typ	ciąg	Zawsze text.	Tak

type Enum: MessageDeltaContentTextObjectType

Wartość	Opis
SMS

messageDeltaContentTextAnnotationsFileCitationObject

Cytat w komunikacie wskazujący określony cudzysłów z określonego pliku skojarzonego z asystentem lub komunikatem. Generowane, gdy asystent używa narzędzia "file_search" do wyszukiwania plików.

Nazwa	Typ	Opis	Wymagane	Domyślny
end_index	liczba całkowita		Nr
file_citation	obiekt		Nr
└file_id	ciąg	Identyfikator określonego pliku, z których pochodzi cytat.	Nr
└cudzysłów	ciąg	Konkretny cudzysłów w pliku.	Nr
indeks	liczba całkowita	Indeks adnotacji w części zawartości tekstowej.	Tak
start_index	liczba całkowita		Nr
SMS	ciąg	Tekst w zawartości wiadomości, który musi zostać zastąpiony.	Nr
typ	ciąg	Zawsze file_citation.	Tak

type Enum: MessageDeltaContentTextAnnotationsFileCitationObjectType

Wartość	Opis
file_citation

messageDeltaContentTextAnnotationsFilePathObject

Adres URL pliku, który jest generowany, gdy asystent użył code_interpreter narzędzia do wygenerowania pliku.

Nazwa	Typ	Opis	Wymagane	Domyślny
end_index	liczba całkowita		Nr
file_path	obiekt		Nr
└file_id	ciąg	Identyfikator wygenerowanego pliku.	Nr
indeks	liczba całkowita	Indeks adnotacji w części zawartości tekstowej.	Tak
start_index	liczba całkowita		Nr
SMS	ciąg	Tekst w zawartości wiadomości, który musi zostać zastąpiony.	Nr
typ	ciąg	Zawsze file_path.	Tak

type Enum: MessageDeltaContentTextAnnotationsFilePathObjectType

Wartość	Opis
file_path

runStepObject

Reprezentuje krok wykonywania przebiegu.

Nazwa	Typ	Opis	Wymagane	Domyślny
assistant_id	ciąg	Identyfikator asystenta skojarzonego z krokiem uruchamiania.	Tak
cancelled_at	liczba całkowita	Sygnatura czasowa systemu Unix (w sekundach) dla momentu anulowania kroku uruchamiania.	Tak
completed_at	liczba całkowita	Sygnatura czasowa systemu Unix (w sekundach) dla momentu ukończenia kroku uruchamiania.	Tak
created_at	liczba całkowita	Sygnatura czasowa systemu Unix (w sekundach) dla momentu utworzenia kroku uruchamiania.	Tak
expired_at	liczba całkowita	Sygnatura czasowa systemu Unix (w sekundach) dla czasu wygaśnięcia kroku uruchamiania. Krok jest uznawany za wygasły, jeśli uruchomienie nadrzędne wygasło.	Tak
failed_at	liczba całkowita	Sygnatura czasowa systemu Unix (w sekundach) dla momentu niepowodzenia kroku uruchamiania.	Tak
Identyfikator	ciąg	Identyfikator kroku uruchamiania, do którego można odwoływać się w punktach końcowych interfejsu API.	Tak
last_error	obiekt	Ostatni błąd skojarzony z tym krokiem przebiegu. Jeśli nie ma żadnych błędów, będzie występować null błąd.	Tak
└* kod	ciąg	Jeden z server_error lub rate_limit_exceeded.	Nr
Komunikat └*	ciąg	Czytelny dla człowieka opis błędu.	Nr
metadane	obiekt	Zestaw 16 par klucz-wartość, które można dołączyć do obiektu. Może to być przydatne do przechowywania dodatkowych informacji o obiekcie w formacie ustrukturyzowanym. Klucze mogą mieć długość maksymalnie 64 znaków, a wartości mogą mieć długość maksymalnie 512 znaków.	Tak
obiekt	ciąg	Typ obiektu, który jest zawsze assistant.run.step.	Tak
run_id	ciąg	Identyfikator przebiegu, którego dotyczy ten krok przebiegu, jest częścią.	Tak
stan	ciąg	Stan przebiegu, który może mieć wartość in_progress, , cancelledfailed, completedlub expired.	Tak
step_details	runStepDetailsMessageCreationObject lub runStepDetailsToolCallsObject	Szczegóły kroku uruchamiania.	Tak
thread_id	ciąg	Identyfikator uruchomionych wątków.	Tak
typ	ciąg	Typ kroku uruchamiania, który może mieć message_creation wartość lub tool_calls.	Tak

object Enum: RunStepObjectType

Wartość	Opis
assistant.run.step	Typ obiektu, który jest zawsze assistant.run.step

type Enum: RunStepObjectType

Wartość	Opis
message_creation	Krok uruchamiania message_creation
tool_calls	Krok uruchamiania tool_calls

Status Enum: RunStepObjectStatus

Wartość	Opis
in_progress	Stan uruchomienia in_progress
Anulowane	Stan anulowanego uruchomienia
Nie powiodło się	Stan anulowanego uruchomienia
Zakończone	Stan anulowanego uruchomienia
Wygasłe	Stan anulowanego uruchomienia

runStepDeltaObject

Reprezentuje różnicę kroku uruchamiania, tj. wszelkie zmienione pola w kroku uruchamiania podczas przesyłania strumieniowego.

Nazwa	Typ	Opis	Wymagane	Domyślny
Delta	obiekt	Delta zawierająca pola, które zostały zmienione w kroku uruchamiania.	Tak
└step_details	runStepDeltaStepDetailsMessageCreationObject lub runStepDeltaStepDetailsToolCallsObject	Szczegóły kroku uruchamiania.	Nr
Identyfikator	ciąg	Identyfikator kroku uruchamiania, do którego można odwoływać się w punktach końcowych interfejsu API.	Tak
obiekt	ciąg	Typ obiektu, który jest zawsze thread.run.step.delta.	Tak

object Enum: RunStepDeltaObjectType

Wartość	Opis
thread.run.step.delta

listRunStepsResponse

Nazwa	Typ	Opis	Wymagane	Domyślny
dane	macierz		Tak
first_id	ciąg		Tak
has_more	Boolean		Tak
last_id	ciąg		Tak
obiekt	ciąg		Tak

runStepDetailsMessageCreationObject

Szczegółowe informacje o tworzeniu komunikatu w kroku uruchamiania.

Nazwa	Typ	Opis	Wymagane	Domyślny
message_creation	obiekt		Tak
└message_id	ciąg	Identyfikator komunikatu, który został utworzony przez ten krok przebiegu.	Nr
typ	ciąg	Zawsze message_creation.	Tak

type Enum: Typ obiektu tworzenia wiadomości szczegółów kroku wykonania

Wartość	Opis
message_creation

runStepDeltaStepDetailsMessageCreationObject

Szczegółowe informacje o tworzeniu komunikatu w kroku uruchamiania.

Nazwa	Typ	Opis	Wymagane	Domyślny
message_creation	obiekt		Nr
└message_id	ciąg	Identyfikator komunikatu, który został utworzony przez ten krok przebiegu.	Nr
typ	ciąg	Zawsze message_creation.	Tak

typ Enum: RunStepDeltaStepDetailsMessageCreationObjectType

Wartość	Opis
message_creation

runStepDetailsToolCallsObject

Szczegóły wywołania narzędzia.

Nazwa	Typ	Opis	Wymagane	Domyślny
tool_calls	macierz	Tablica narzędzi wywołuje krok uruchamiania. Mogą one być skojarzone z jednym z trzech typów narzędzi: code_interpreter, retrieval lub function.	Tak
typ	ciąg	Zawsze tool_calls.	Tak

type Enum: RunStepDetailsToolCallsObjectType

Wartość	Opis
tool_calls

runStepDeltaStepDetailsToolCallsObject

Szczegóły wywołania narzędzia.

Nazwa	Typ	Opis	Wymagane	Domyślny
tool_calls	macierz	Tablica narzędzi wywołuje krok uruchamiania. Mogą one być skojarzone z jednym z trzech typów narzędzi: code_interpreter, file_search lub function.	Nr
typ	ciąg	Zawsze tool_calls.	Tak

type Enum: RunStepDeltaStepDetailsToolCallsObjectType

Wartość	Opis
tool_calls

runStepDetailsToolCallsCodeObject

Szczegóły narzędzia interpretera kodu, w ramach którego był zaangażowany krok uruchamiania.

Nazwa	Typ	Opis	Wymagane	Domyślny
code_interpreter	obiekt	Definicja wywołania narzędzia Interpreter kodu.	Tak
Wejście └*	ciąg	Dane wejściowe wywołania narzędzia Interpreter kodu.	Nr
Dane wyjściowe └}	macierz	Dane wyjściowe wywołania narzędzia Interpreter kodu. Interpreter kodu może wyświetlać co najmniej jeden element, w tym tekst (logs) lub obrazy (image). Każdy z nich jest reprezentowany przez inny typ obiektu.	Nr
Identyfikator	ciąg	Identyfikator wywołania narzędzia.	Tak
typ	ciąg	Typ wywołania narzędzia. To zawsze będzie code_interpreter dotyczyć tego typu wywołania narzędzia.	Tak

type Enum: RunStepDetailsToolCallsCodeObjectType

Wartość	Opis
code_interpreter

runStepDeltaStepDetailsToolCallsCodeObject

Szczegóły narzędzia interpretera kodu, w ramach którego był zaangażowany krok uruchamiania.

Nazwa	Typ	Opis	Wymagane	Domyślny
code_interpreter	obiekt	Definicja wywołania narzędzia Interpreter kodu.	Nr
Wejście └*	ciąg	Dane wejściowe wywołania narzędzia Interpreter kodu.	Nr
Dane wyjściowe └}	macierz	Dane wyjściowe wywołania narzędzia Interpreter kodu. Interpreter kodu może wyświetlać co najmniej jeden element, w tym tekst (logs) lub obrazy (image). Każdy z nich jest reprezentowany przez inny typ obiektu.	Nr
Identyfikator	ciąg	Identyfikator wywołania narzędzia.	Nr
indeks	liczba całkowita	Indeks wywołania narzędzia w narzędziu wywołuje tablicę.	Tak
typ	ciąg	Typ wywołania narzędzia. To zawsze będzie code_interpreter dotyczyć tego typu wywołania narzędzia.	Tak

typ wyliczeniowy Enum: RunStepDeltaStepDetailsToolCallsCodeObjectType

Wartość	Opis
code_interpreter

runStepDetailsToolCallsCodeOutputLogsObject

Dane wyjściowe tekstu z wywołania narzędzia Interpreter kodu w ramach kroku uruchamiania.

Nazwa	Typ	Opis	Wymagane	Domyślny
dzienniki	ciąg	Dane wyjściowe tekstu z wywołania narzędzia Interpreter kodu.	Tak
typ	ciąg	Zawsze logs.	Tak

Typ Enum: RunStepDetailsToolCallsCodeOutputLogsObjectType

Wartość	Opis
dzienniki

runStepDeltaStepDetailsToolCallsCodeOutputLogsObject

Dane wyjściowe tekstu z wywołania narzędzia Interpreter kodu w ramach kroku uruchamiania.

Nazwa	Typ	Opis	Wymagane	Domyślny
indeks	liczba całkowita	Indeks danych wyjściowych w tablicy danych wyjściowych.	Tak
dzienniki	ciąg	Dane wyjściowe tekstu z wywołania narzędzia Interpreter kodu.	Nr
typ	ciąg	Zawsze logs.	Tak

Step 2: Typ wyliczeniowy: Obiekt typu RunStepDeltaStepDetailsToolCallsCodeOutputLogs

Wartość	Opis
dzienniki

runStepDetailsToolCallsCodeOutputImageObject

Nazwa	Typ	Opis	Wymagane	Domyślny
obraz	obiekt		Tak
└file_id	ciąg	Identyfikator pliku obrazu.	Nr
typ	ciąg	Zawsze image.	Tak

type Enum: RunStepDetailsToolCallsCodeOutputImageObjectType

Wartość	Opis
obraz

runStepDeltaStepDetailsToolCallsCodeOutputImageObject

Nazwa	Typ	Opis	Wymagane	Domyślny
obraz	obiekt		Nr
└file_id	ciąg	Identyfikator pliku obrazu.	Nr
indeks	liczba całkowita	Indeks danych wyjściowych w tablicy danych wyjściowych.	Tak
typ	ciąg	Zawsze image.	Tak

typ Enum: RunStepDeltaStepDetailsNarzędziaWywołaniaKodWynikowyObiektGraficzny

Wartość	Opis
obraz

runStepDetailsToolCallsFileSearchObject

Nazwa	Typ	Opis	Wymagane	Domyślny
file_search	obiekt	Na razie zawsze będzie to pusty obiekt.	Tak
Wyniki └}	macierz	Wyniki wyszukiwania plików.	Nr
Identyfikator	ciąg	Identyfikator obiektu wywołania narzędzia.	Tak
typ	ciąg	Typ wywołania narzędzia. To zawsze będzie file_search dotyczyć tego typu wywołania narzędzia.	Tak

type Enum: RunStepDetailsToolCallsFileSearchObjectType

Wartość	Opis
file_search

runStepDetailsToolCallsFileSearchResultObject

Wystąpienie wyników wyszukiwania plików.

Nazwa	Typ	Opis	Wymagane	Domyślny
zawartość	macierz	Zawartość znalezionego wyniku. Zawartość jest dołączana tylko w przypadku żądania za pośrednictwem parametru include zapytania.	Nr
File_id	ciąg	Identyfikator pliku, w ramach którego znaleziono wynik.	Tak
Nazwa_pliku	ciąg	Nazwa pliku, w ramach którego znaleziono wynik.	Tak
wynik	Numer	Wynik. Wszystkie wartości muszą być liczbą zmiennoprzecinkową z zakresu od 0 do 1.	Tak

runStepDeltaStepDetailsToolCallsFileSearchObject

Nazwa	Typ	Opis	Wymagane	Domyślny
file_search	obiekt	Na razie zawsze będzie to pusty obiekt.	Tak
Identyfikator	ciąg	Identyfikator obiektu wywołania narzędzia.	Nr
indeks	liczba całkowita	Indeks wywołania narzędzia w narzędziu wywołuje tablicę.	Tak
typ	ciąg	Typ wywołania narzędzia. To zawsze będzie retrieval dotyczyć tego typu wywołania narzędzia.	Tak

type Enum: Typ obiektu wyszukiwania plików w narzędziu wywołań RunStepDeltaStepDetails

Wartość	Opis
file_search

runStepDetailsToolCallsFunctionObject

Nazwa	Typ	Opis	Wymagane	Domyślny
funkcja	obiekt	Definicja funkcji, która została wywołana.	Tak
Argumenty └*	ciąg	Argumenty przekazane do funkcji.	Nr
└* nazwa	ciąg	Nazwa funkcji.	Nr
Dane wyjściowe └}	ciąg	Dane wyjściowe funkcji. Będzie to miało wartość null , jeśli dane wyjściowe nie zostały jeszcze przesłane.	Nr
Identyfikator	ciąg	Identyfikator obiektu wywołania narzędzia.	Tak
typ	ciąg	Typ wywołania narzędzia. To zawsze będzie function dotyczyć tego typu wywołania narzędzia.	Tak

type Enum: RunStepDetailsToolCallsFunctionObjectType

Wartość	Opis
funkcja

runStepDeltaStepDetailsToolCallsFunctionObject

Nazwa	Typ	Opis	Wymagane	Domyślny
funkcja	obiekt	Definicja funkcji, która została wywołana.	Nr
Argumenty └*	ciąg	Argumenty przekazane do funkcji.	Nr
└* nazwa	ciąg	Nazwa funkcji.	Nr
Dane wyjściowe └}	ciąg	Dane wyjściowe funkcji. Będzie to miało wartość null , jeśli dane wyjściowe nie zostały jeszcze przesłane.	Nr
Identyfikator	ciąg	Identyfikator obiektu wywołania narzędzia.	Nr
indeks	liczba całkowita	Indeks wywołania narzędzia w narzędziu wywołuje tablicę.	Tak
typ	ciąg	Typ wywołania narzędzia. To zawsze będzie function dotyczyć tego typu wywołania narzędzia.	Tak

type Enum: RunStepDetailsToolCallsFunctionObjectType

Wartość	Opis
funkcja

vectorStoreExpirationAfter

Zasady wygasania magazynu wektorów.

Nazwa	Typ	Opis	Wymagane	Domyślny
kotwica	ciąg	Znacznik czasu zakotwiczenia, po którym mają zastosowanie zasady wygasania. Obsługiwane kotwice: last_active_at.	Tak
Dni	liczba całkowita	Liczba dni po upływie czasu zakotwiczenia, przez który magazyn wektorów wygaśnie.	Tak

anchor Enum: VectorStoreExpirationAfterAnchor

Wartość	Opis
last_active_at	Znacznik czasu zakotwiczenia, po którym mają zastosowanie zasady wygasania.

vectorStoreObject

Magazyn wektorów to kolekcja przetworzonych plików może być używana przez file_search narzędzie.

Nazwa	Typ	Opis	Wymagane	Domyślny
created_at	liczba całkowita	Sygnatura czasowa systemu Unix (w sekundach) dla momentu utworzenia magazynu wektorów.	Tak
expires_after	vectorStoreExpirationAfter	Zasady wygasania magazynu wektorów.	Nr
expires_at	liczba całkowita	Sygnatura czasowa systemu Unix (w sekundach) dla czasu wygaśnięcia magazynu wektorów.	Nr
file_counts	obiekt		Tak
└* anulowano	liczba całkowita	Liczba anulowanych plików.	Nr
Ukończono └*	liczba całkowita	Liczba plików, które zostały pomyślnie przetworzone.	Nr
└* nie powiodło się	liczba całkowita	Liczba plików, które nie mogły przetworzyć.	Nr
└in_progress	liczba całkowita	Liczba obecnie przetwarzanych plików.	Nr
└* suma	liczba całkowita	Całkowita liczba plików.	Nr
Identyfikator	ciąg	Identyfikator, do którego można odwoływać się w punktach końcowych interfejsu API.	Tak
last_active_at	liczba całkowita	Sygnatura czasowa systemu Unix (w sekundach) dla czasu ostatniego aktywnego magazynu wektorów.	Tak
metadane	obiekt	Zestaw 16 par klucz-wartość, które można dołączyć do obiektu. Może to być przydatne do przechowywania dodatkowych informacji o obiekcie w formacie ustrukturyzowanym. Klucze mogą mieć długość maksymalnie 64 znaków, a wartości mogą mieć długość maksymalnie 512 znaków.	Tak
Nazwa	ciąg	Nazwa magazynu wektorów.	Tak
obiekt	wyliczenie	Typ obiektu, który jest zawsze vector_store. Możliwe wartości: vector_store	Tak
stan	ciąg	Stan magazynu wektorów, który może mieć expiredwartość , in_progresslub completed. Stan completed wskazuje, że magazyn wektorów jest gotowy do użycia.	Tak
usage_bytes	liczba całkowita	Całkowita liczba bajtów używanych przez pliki w magazynie wektorów.	Tak

status Enum: VectorStoreObjectStatus

Wartość	Opis
Wygasłe
in_progress
Zakończone

createVectorStoreRequest

Nazwa	Typ	Opis	Wymagane	Domyślny
chunking_strategy	autoChunkingStrategyRequestParam lub staticChunkingStrategyRequestParam	Strategia fragmentowania używana do fragmentowania plików. Jeśli nie zostanie ustawiona, użyje auto strategii. Dotyczy tylko wtedy, gdy file_ids nie jest pusty.	Nr
expires_after	vectorStoreExpirationAfter	Zasady wygasania magazynu wektorów.	Nr
file_ids	macierz	Lista identyfikatorów plików, których powinien używać magazyn wektorów. Przydatne w przypadku narzędzi, takich jak file_search te, które mogą uzyskiwać dostęp do plików.	Nr
metadane	obiekt	Zestaw 16 par klucz-wartość, które można dołączyć do obiektu. Może to być przydatne do przechowywania dodatkowych informacji o obiekcie w formacie ustrukturyzowanym. Klucze mogą mieć długość maksymalnie 64 znaków, a wartości mogą mieć długość maksymalnie 512 znaków.	Nr
Nazwa	ciąg	Nazwa magazynu wektorów.	Nr

updateVectorStoreRequest

Nazwa	Typ	Opis	Wymagane	Domyślny
expires_after	vectorStoreExpirationAfter	Zasady wygasania magazynu wektorów.	Nr
metadane	obiekt	Zestaw 16 par klucz-wartość, które można dołączyć do obiektu. Może to być przydatne do przechowywania dodatkowych informacji o obiekcie w formacie ustrukturyzowanym. Klucze mogą mieć długość maksymalnie 64 znaków, a wartości mogą mieć długość maksymalnie 512 znaków.	Nr
Nazwa	ciąg	Nazwa magazynu wektorów.	Nr

listVectorStoresResponse

Nazwa	Typ	Opis	Wymagane	Domyślny
dane	macierz		Tak
first_id	ciąg		Tak
has_more	Boolean		Tak
last_id	ciąg		Tak
obiekt	ciąg		Tak

deleteVectorStoreResponse

Nazwa	Typ	Opis	Wymagane	Domyślny
Usunięte	Boolean		Tak
Identyfikator	ciąg		Tak
obiekt	ciąg		Tak

object Enum: DeleteVectorStoreResponseObject

Wartość	Opis
vector_store.deleted	Stan obiektu odpowiedzi magazynu wektorów usuwania

vectorStoreFileObject

Lista plików dołączonych do magazynu wektorów.

Nazwa	Typ	Opis	Wymagane	Domyślny
chunking_strategy	autoChunkingStrategyRequestParam lub staticChunkingStrategyRequestParam	Strategia fragmentowania używana do fragmentowania plików. Jeśli nie zostanie ustawiona, użyje auto strategii. Dotyczy tylko wtedy, gdy file_ids nie jest pusty.	Nr
created_at	liczba całkowita	Sygnatura czasowa systemu Unix (w sekundach) dla momentu utworzenia pliku magazynu wektorów.	Tak
Identyfikator	ciąg	Identyfikator, do którego można odwoływać się w punktach końcowych interfejsu API.	Tak
last_error	obiekt	Ostatni błąd skojarzony z tym plikiem magazynu wektorów. Jeśli nie ma żadnych błędów, będzie występować null błąd.	Tak
└* kod	ciąg	Jeden z server_error lub lub invalid_fileunsupported_file .	Nr
Komunikat └*	ciąg	Czytelny dla człowieka opis błędu.	Nr
obiekt	ciąg	Typ obiektu, który jest zawsze vector_store.file.	Tak
stan	ciąg	Stan pliku magazynu wektorów, który może mieć in_progresswartość , , completedcancelledlub failed. Stan completed wskazuje, że plik magazynu wektorów jest gotowy do użycia.	Tak
usage_bytes	liczba całkowita	Łączne użycie magazynu wektorów w bajtach. Należy pamiętać, że może się to różnić od oryginalnego rozmiaru pliku.	Tak
vector_store_id	ciąg	Identyfikator magazynu wektorów, do którego jest dołączony plik.	Tak

obiekt Enum: VectorStoreFileObjectType

Wartość	Opis
vector_store.file

Status Enum: VectorStoreFileObjectStatus

Wartość	Opis
in_progress
Zakończone
Anulowane
Nie powiodło się

otherChunkingStrategyResponseParam

Jest to zwracane, gdy strategia fragmentowania jest nieznana. Zazwyczaj jest to spowodowane tym, że plik został zaindeksowany przed wprowadzeniem chunking_strategy koncepcji w interfejsie API.

Nazwa	Typ	Opis	Wymagane	Domyślny
typ	ciąg	Zawsze other.	Tak

typ Enum: OtherChunkingStrategyResponseParamType

Wartość	Opis
Innych

staticChunkingStrategyResponseParam

Nazwa	Typ	Opis	Wymagane	Domyślny
statyczny	staticChunkingStrategy		Tak
typ	ciąg	Zawsze static.	Tak

typ Enum: StaticChunkingStrategyResponseParamType

Wartość	Opis
statyczny

staticChunkingStrategy

Nazwa	Typ	Opis	Wymagane	Domyślny
chunk_overlap_tokens	liczba całkowita	Liczba tokenów nakładających się między fragmentami. Wartość domyślna to 400. Należy pamiętać, że nakładanie się nie może przekraczać połowy wartości max_chunk_size_tokens.	Tak
max_chunk_size_tokens	liczba całkowita	Maksymalna liczba tokenów w każdym kawałku. Wartość domyślna to 800. Wartość minimalna to 100 , a wartość maksymalna to 4096.	Tak

autoChunkingStrategyRequestParam

Strategia domyślna. Ta strategia używa obecnie wartości max_chunk_size_tokens800 i chunk_overlap_tokens .400

Nazwa	Typ	Opis	Wymagane	Domyślny
typ	wyliczenie	Zawsze auto. Możliwe wartości: auto	Tak

staticChunkingStrategyRequestParam

Nazwa	Typ	Opis	Wymagane	Domyślny
statyczny	staticChunkingStrategy		Tak
typ	wyliczenie	Zawsze static. Możliwe wartości: static	Tak

fragmentingStrategyRequestParam

Strategia fragmentowania używana do fragmentowania plików. Jeśli nie zostanie ustawiona, użyje auto strategii.

Ten składnik może być jednym z następujących elementów:

• autoChunkingStrategyRequestParam
• staticChunkingStrategyRequestParam

createVectorStoreFileRequest

Nazwa	Typ	Opis	Wymagane	Domyślny
chunking_strategy	fragmentingStrategyRequestParam	Strategia fragmentowania używana do fragmentowania plików. Jeśli nie zostanie ustawiona, użyje auto strategii.	Nr
File_id	ciąg	Identyfikator pliku, którego powinien używać magazyn wektorów. Przydatne w przypadku narzędzi, takich jak file_search te, które mogą uzyskiwać dostęp do plików.	Tak

listVectorStoreFilesResponse

Nazwa	Typ	Opis	Wymagane	Domyślny
dane	macierz		Tak
first_id	ciąg		Tak
has_more	Boolean		Tak
last_id	ciąg		Tak
obiekt	ciąg		Tak

deleteVectorStoreFileResponse

Nazwa	Typ	Opis	Wymagane	Domyślny
Usunięte	Boolean		Tak
Identyfikator	ciąg		Tak
obiekt	ciąg		Tak

object Enum: DeleteVectorStoreFileResponseObject

Wartość	Opis
vector_store.file.deleted

vectorStoreFileBatchObject

Partia plików dołączonych do magazynu wektorów.

Nazwa	Typ	Opis	Wymagane	Domyślny
created_at	liczba całkowita	Sygnatura czasowa systemu Unix (w sekundach) dla momentu utworzenia partii plików magazynu wektorów.	Tak
file_counts	obiekt		Tak
└* anulowano	liczba całkowita	Liczba anulowanych plików.	Nr
Ukończono └*	liczba całkowita	Liczba przetworzonych plików.	Nr
└* nie powiodło się	liczba całkowita	Liczba plików, które nie mogły przetworzyć.	Nr
└in_progress	liczba całkowita	Liczba obecnie przetwarzanych plików.	Nr
└* suma	liczba całkowita	Całkowita liczba plików.	Nr
Identyfikator	ciąg	Identyfikator, do którego można odwoływać się w punktach końcowych interfejsu API.	Tak
obiekt	ciąg	Typ obiektu, który jest zawsze vector_store.file_batch.	Tak
stan	ciąg	Stan partii plików magazynu wektorów, który może mieć in_progresswartość , completedcancelled lub failed.	Tak
vector_store_id	ciąg	Identyfikator magazynu wektorów, do którego jest dołączony plik.	Tak

obiekt Enum: VectorStoreFileBatchObjectType

Wartość	Opis
vector_store.files_batch

status Enum: VectorStoreFileBatchObjectStatus

Wartość	Opis
in_progress
Zakończone
Anulowane
Nie powiodło się

createVectorStoreFileBatchRequest

Nazwa	Typ	Opis	Wymagane	Domyślny
chunking_strategy	fragmentingStrategyRequestParam	Strategia fragmentowania używana do fragmentowania plików. Jeśli nie zostanie ustawiona, użyje auto strategii.	Nr
file_ids	macierz	Lista identyfikatorów plików, których powinien używać magazyn wektorów. Przydatne w przypadku narzędzi, takich jak file_search te, które mogą uzyskiwać dostęp do plików.	Tak

assistantStreamEvent

Reprezentuje zdarzenie emitowane podczas przesyłania strumieniowego przebiegu.

Każde zdarzenie w strumieniu zdarzeń wysyłanych przez serwer ma event właściwość i :data

event: thread.created
data: {"id": "thread_123", "object": "thread", ...}

Emitujemy zdarzenia za każdym razem, gdy tworzony jest nowy obiekt, przechodzi do nowego stanu lub jest przesyłany strumieniowo w częściach (różnice). Na przykład emitujemy thread.run.created po utworzeniu nowego przebiegu, thread.run.completed po zakończeniu przebiegu itd. Gdy Asystent zdecyduje się utworzyć komunikat podczas przebiegu, emitujemy thread.message.created eventzdarzenie , thread.message.in_progress wiele thread.message.delta zdarzeń i na thread.message.completed koniec zdarzenie.

Możemy dodać dodatkowe zdarzenia w czasie, dlatego zalecamy bezproblemowe obsługę nieznanych zdarzeń w kodzie.

Ten składnik może być jednym z następujących elementów:

• threadStreamEvent
• runStreamEvent
• runStepStreamEvent
• messageStreamEvent
• errorEvent
• doneEvent

threadStreamEvent

Ten składnik może być jednym z następujących elementów:

thread.created

Występuje po utworzeniu nowego wątku.

Nazwa	Typ	Opis	Wymagane	Domyślny
dane	threadObject	Reprezentuje wątek zawierający komunikaty.	Tak
wydarzenie	ciąg		Tak

Dane: threadObject

Wyliczenie zdarzeń: ThreadStreamEventEnum

Wartość	Opis
thread.created	Zdarzenie utworzone przez wątek

---

runStreamEvent

Ten składnik może być jednym z następujących elementów:

thread.run.created

Występuje po utworzeniu nowego przebiegu.

Nazwa	Typ	Opis	Wymagane	Domyślny
dane	runObject	Reprezentuje przebieg wykonywania w wątkach.	Tak
wydarzenie	ciąg		Tak

Dane: runObject

Wyliczenie zdarzeń: RunStreamEventCreated

Wartość	Opis
thread.run.created

---

thread.run.queued

Występuje, gdy przebieg przechodzi do queued stanu.

Nazwa	Typ	Opis	Wymagane	Domyślny
dane	runObject	Reprezentuje przebieg wykonywania w wątkach.	Tak
wydarzenie	ciąg		Tak

Dane: runObject

Wyliczenie zdarzeń: RunStreamEventQueued

Wartość	Opis
thread.run.queued

---

thread.run.in_progress

Występuje, gdy przebieg przechodzi do in_progress stanu.

Nazwa	Typ	Opis	Wymagane	Domyślny
dane	runObject	Reprezentuje przebieg wykonywania w wątkach.	Tak
wydarzenie	ciąg		Tak

Dane: runObject

Wyliczenie zdarzeń: RunStreamEventInProgress

Wartość	Opis
thread.run.in_progress

---

thread.run.requires_action

Występuje, gdy przebieg przechodzi do requires_action stanu.

Nazwa	Typ	Opis	Wymagane	Domyślny
dane	runObject	Reprezentuje przebieg wykonywania w wątkach.	Tak
wydarzenie	ciąg		Tak

Dane: runObject

Wyliczenie zdarzeń: RunStreamEventRequiresAction

Wartość	Opis
thread.run.requires_action

---

thread.run.completed

Występuje po zakończeniu przebiegu.

Nazwa	Typ	Opis	Wymagane	Domyślny
dane	runObject	Reprezentuje przebieg wykonywania w wątkach.	Tak
wydarzenie	ciąg		Tak

Dane: runObject

Wyliczenie zdarzeń: RunStreamEventCompleted

Wartość	Opis
thread.run.completed

---

thread.run.failed

Występuje, gdy uruchomienie zakończy się niepowodzeniem.

Nazwa	Typ	Opis	Wymagane	Domyślny
dane	runObject	Reprezentuje przebieg wykonywania w wątkach.	Tak
wydarzenie	ciąg		Tak

Dane: runObject

Wyliczenie zdarzeń: RunStreamEventFailed

Wartość	Opis
thread.run.failed

---

thread.run.cancelling

Występuje, gdy przebieg przechodzi do cancelling stanu.

Nazwa	Typ	Opis	Wymagane	Domyślny
dane	runObject	Reprezentuje przebieg wykonywania w wątkach.	Tak
wydarzenie	ciąg		Tak

Dane: runObject

Wyliczenie zdarzeń: RunStreamEventCancelling

Wartość	Opis
thread.run.cancelling

---

thread.run.cancelled

Występuje po anulowaniu przebiegu.

Nazwa	Typ	Opis	Wymagane	Domyślny
dane	runObject	Reprezentuje przebieg wykonywania w wątkach.	Tak
wydarzenie	ciąg		Tak

Dane: runObject

Wyliczenie zdarzeń: RunStreamEventCancelled

Wartość	Opis
thread.run.cancelled

---

thread.run.expired

Występuje po wygaśnięciu przebiegu.

Nazwa	Typ	Opis	Wymagane	Domyślny
dane	runObject	Reprezentuje przebieg wykonywania w wątkach.	Tak
wydarzenie	ciąg		Tak

Dane: runObject

Wyliczenie zdarzeń: RunStreamEventExpired

Wartość	Opis
thread.run.expired

---

runStepStreamEvent

Ten składnik może być jednym z następujących elementów:

thread.run.step.created

Występuje po utworzeniu kroku uruchamiania.

Nazwa	Typ	Opis	Wymagane	Domyślny
dane	runStepObject	Reprezentuje krok wykonywania przebiegu.	Tak
wydarzenie	ciąg		Tak

Dane: runStepObject

Wyliczenie zdarzeń: RunStepStreamEventCreated

Wartość	Opis
thread.run.step.created

---

thread.run.step.in_progress

Występuje, gdy krok uruchomienia przechodzi do in_progress stanu.

Nazwa	Typ	Opis	Wymagane	Domyślny
dane	runStepObject	Reprezentuje krok wykonywania przebiegu.	Tak
wydarzenie	ciąg		Tak

Dane: runStepObject

Wyliczenie zdarzeń: RunStepStreamEventInProgress

Wartość	Opis
thread.run.step.in_progress

---

thread.run.step.delta

Występuje, gdy są przesyłane strumieniowo części kroku uruchamiania.

Nazwa	Typ	Opis	Wymagane	Domyślny
dane	runStepDeltaObject	Reprezentuje różnicę kroku uruchamiania, tj. wszelkie zmienione pola w kroku uruchamiania podczas przesyłania strumieniowego.	Tak
wydarzenie	ciąg		Tak

Dane: runStepDeltaObject

Wyliczenie zdarzeń: RunStepStreamEventDelta

Wartość	Opis
thread.run.step.delta

---

thread.run.step.completed

Występuje po zakończeniu kroku uruchamiania.

Nazwa	Typ	Opis	Wymagane	Domyślny
dane	runStepObject	Reprezentuje krok wykonywania przebiegu.	Tak
wydarzenie	ciąg		Tak

Dane: runStepObject

Wyliczenie zdarzeń: RunStepStreamEventCompleted

Wartość	Opis
thread.run.step.completed

---

thread.run.step.failed

Występuje, gdy krok uruchomienia zakończy się niepowodzeniem.

Nazwa	Typ	Opis	Wymagane	Domyślny
dane	runStepObject	Reprezentuje krok wykonywania przebiegu.	Tak
wydarzenie	ciąg		Tak

Dane: runStepObject

Wyliczenie zdarzenia: RunStepStreamEventFailed

Wartość	Opis
thread.run.step.failed

---

thread.run.step.cancelled

Występuje, gdy krok uruchomienia zostanie anulowany.

Nazwa	Typ	Opis	Wymagane	Domyślny
dane	runStepObject	Reprezentuje krok wykonywania przebiegu.	Tak
wydarzenie	ciąg		Tak

Dane: runStepObject

Wyliczenie zdarzeń: RunStepStreamEventCancelled

Wartość	Opis
thread.run.step.cancelled

---

thread.run.step.expired

Występuje, gdy krok uruchomienia wygaśnie.

Nazwa	Typ	Opis	Wymagane	Domyślny
dane	runStepObject	Reprezentuje krok wykonywania przebiegu.	Tak
wydarzenie	ciąg		Tak

Dane: runStepObject

Wyliczenie zdarzeń: RunStepStreamEventExpired

Wartość	Opis
thread.run.step.expired

---

messageStreamEvent

Ten składnik może być jednym z następujących elementów:

thread.message.created

Występuje po utworzeniu komunikatu.

Nazwa	Typ	Opis	Wymagane	Domyślny
dane	messageObject	Reprezentuje komunikat w wątkach.	Tak
wydarzenie	ciąg		Tak

Dane: messageObject

Wyliczenie zdarzeń: MessageStreamEventCreated

Wartość	Opis
thread.message.created

---

thread.message.in_progress

Występuje, gdy komunikat przechodzi do in_progress stanu.

Nazwa	Typ	Opis	Wymagane	Domyślny
dane	messageObject	Reprezentuje komunikat w wątkach.	Tak
wydarzenie	ciąg		Tak

Dane: messageObject

Wyliczenie zdarzeń: MessageStreamEventInProgress

Wartość	Opis
thread.message.in_progress

---

thread.message.delta

Występuje, gdy są przesyłane strumieniowo części komunikatu.

Nazwa	Typ	Opis	Wymagane	Domyślny
dane	messageDeltaObject	Reprezentuje różnicę komunikatów, tj. wszystkie zmienione pola w wiadomości podczas przesyłania strumieniowego.	Tak
wydarzenie	ciąg		Tak

Dane: messageDeltaObject

Wyliczenie zdarzeń: MessageStreamEventDelta

Wartość	Opis
thread.message.delta

---

thread.message.completed

Występuje po zakończeniu komunikatu.

Nazwa	Typ	Opis	Wymagane	Domyślny
dane	messageObject	Reprezentuje komunikat w wątkach.	Tak
wydarzenie	ciąg		Tak

Dane: messageObject

Wyliczenie zdarzeń: MessageStreamEventCompleted

Wartość	Opis
thread.message.completed

---

thread.message.incomplete

Występuje, gdy komunikat kończy się przed jego ukończeniem.

Nazwa	Typ	Opis	Wymagane	Domyślny
dane	messageObject	Reprezentuje komunikat w wątkach.	Tak
wydarzenie	ciąg		Tak

Dane: messageObject

Wyliczenie zdarzeń: MessageStreamEventIncomplete

Wartość	Opis
thread.message.incomplete

---

Adnotacji

Ten składnik może być jednym z następujących elementów:

• PlikCitation
• Adres URLCitation
• Filepath

Kliknij

Akcja kliknięcia.

Nazwa	Typ	Opis	Wymagane	Domyślny
Przycisk	wyliczenie	Wskazuje, który przycisk myszy został naciśnięty podczas kliknięcia. leftJeden z , right, wheel, back, lub forward. Możliwe wartości: left, , rightwheel, , backforward	Tak
typ	wyliczenie	Określa typ zdarzenia. W przypadku akcji kliknięcia ta właściwość jest zawsze ustawiona na clickwartość . Możliwe wartości: click	Tak
X	liczba całkowita	Współrzędna x, w której wystąpiło kliknięcie.	Tak
Y	liczba całkowita	Współrzędna y, w której wystąpiło kliknięcie.	Tak

CodeInterpreterFileOutput

Dane wyjściowe wywołania narzędzia interpretera kodu, które jest plikiem.

Nazwa	Typ	Opis	Wymagane	Domyślny
Pliki	macierz		Tak
typ	wyliczenie	Typ danych wyjściowych pliku interpretera kodu. Zawsze files. Możliwe wartości: files	Tak

CodeInterpreterTextOutput

Dane wyjściowe wywołania narzędzia interpretera kodu, które jest tekstem.

Nazwa	Typ	Opis	Wymagane	Domyślny
dzienniki	ciąg	Dzienniki wywołania narzędzia interpretera kodu.	Tak
typ	wyliczenie	Typ danych wyjściowych tekstu interpretera kodu. Zawsze logs. Możliwe wartości: logs	Tak

CodeInterpreterTool

Narzędzie, które uruchamia kod.

Nazwa	Typ	Opis	Wymagane	Domyślny
file_ids	macierz	Identyfikatory plików do uruchomienia kodu.	Tak
typ	wyliczenie	Typ narzędzia interpretera kodu. Zawsze code_interpreter. Możliwe wartości: code_interpreter	Tak

CodeInterpreterToolCall

Wywołanie narzędzia w celu uruchomienia kodu.

Nazwa	Typ	Opis	Wymagane	Domyślny
kod	ciąg	Kod do uruchomienia.	Tak
Identyfikator	ciąg	Unikatowy identyfikator wywołania narzędzia interpretera kodu.	Tak
Wyniki	macierz	Wyniki wywołania narzędzia interpretera kodu.	Tak
stan	wyliczenie	Stan wywołania narzędzia interpretera kodu. Możliwe wartości: in_progress, , interpretingcompleted	Tak
typ	wyliczenie	Typ wywołania narzędzia interpretera kodu. Zawsze code_interpreter_call. Możliwe wartości: code_interpreter_call	Tak

CodeInterpreterToolOutput

Ten składnik może być jednym z następujących elementów:

• CodeInterpreterTextOutput
• CodeInterpreterFileOutput

Filtr porównawczy

Filtr używany do porównywania określonego klucza atrybutu z daną wartością przy użyciu zdefiniowanej operacji porównania.

Nazwa	Typ	Opis	Wymagane	Domyślny
klucz	ciąg	Klucz do porównania z wartością.	Tak
typ	wyliczenie	Określa operator porównania: eq, , ne, gtgte, lt, . lte - eq:Równa - ne: nie równa się - gt: większe niż - gte: większe niż lub równe - lt: mniejsze niż - lte: mniejsze niż lub równe Możliwe wartości: eq, , negt, gte, , ltlte	Tak
Wartość	ciąg lub liczba lub wartość logiczna	Wartość do porównania z kluczem atrybutu; obsługuje typy ciągów, liczb lub wartości logicznych.	Tak

Filtr złożony

Połącz wiele filtrów przy użyciu polecenia and lub or.

Nazwa	Typ	Opis	Wymagane	Domyślny
Filtry	macierz	Tablica filtrów do połączenia. Elementy mogą mieć wartość ComparisonFilter lub CompoundFilter.	Tak
typ	wyliczenie	Typ operacji: and lub or. Możliwe wartości: and, or	Tak

ComputerAction

Ten składnik może być jednym z następujących elementów:

• Kliknij
• Doubleclick
• Przeciągnij
• Keypress
• Przenieść
• Zrzut ekranu
• Przewiń
• Typu
• Czekać

ComputerScreenshotImage

Obraz zrzutu ekranu komputera używany z narzędziem do korzystania z komputera.

Nazwa	Typ	Opis	Wymagane	Domyślny
File_id	ciąg	Identyfikator przekazanego pliku zawierającego zrzut ekranu.	Nr
image_url	ciąg	Adres URL obrazu zrzutu ekranu.	Nr
typ	wyliczenie	Określa typ zdarzenia. W przypadku zrzutu ekranu komputera ta właściwość jest zawsze ustawiona na computer_screenshotwartość . Możliwe wartości: computer_screenshot	Tak

ComputerTool

Narzędzie kontrolujące komputer wirtualny.

Nazwa	Typ	Opis	Wymagane	Domyślny
display_height	Numer	Wysokość wyświetlanego komputera.	Tak
display_width	Numer	Szerokość ekranu komputera.	Tak
środowisko	wyliczenie	Typ środowiska komputera do sterowania. Możliwe wartości: mac, , windows, ubuntubrowser	Tak
typ	wyliczenie	Typ narzędzia do użycia komputera. Zawsze computer_use_preview. Możliwe wartości: computer-use-preview	Tak

ComputerToolCall

Narzędzie wywołujące narzędzie do korzystania z komputera.

Nazwa	Typ	Opis	Wymagane	Domyślny
akcja	ComputerAction		Tak
call_id	ciąg	Identyfikator używany podczas odpowiadania na wywołanie narzędzia przy użyciu danych wyjściowych.	Tak
Identyfikator	ciąg	Unikatowy identyfikator wywołania komputera.	Tak
pending_safety_checks	macierz	Oczekujące kontrole bezpieczeństwa dla wywołania komputera.	Tak
stan	wyliczenie	Stan elementu. in_progressJeden z , completedlub incomplete. Wypełniane, gdy elementy są zwracane za pośrednictwem interfejsu API. Możliwe wartości: in_progress, , completedincomplete	Tak
typ	wyliczenie	Typ wywołania komputera. Zawsze computer_call. Możliwe wartości: computer_call	Tak

ComputerToolCallOutput

Dane wyjściowe wywołania narzędzia komputerowego.

Nazwa	Typ	Opis	Wymagane	Domyślny
acknowledged_safety_checks	macierz	Kontrole bezpieczeństwa zgłoszone przez interfejs API, które zostały potwierdzone przez dewelopera.	Nr
call_id	ciąg	Identyfikator wywołania narzędzia komputerowego, które wygenerowało dane wyjściowe.	Tak
Identyfikator	ciąg	Identyfikator danych wyjściowych wywołania narzędzia komputerowego.	Nr
We/Wy	ComputerScreenshotImage	Obraz zrzutu ekranu komputera używany z narzędziem do korzystania z komputera.	Tak
stan	wyliczenie	Stan danych wejściowych komunikatu. in_progressJeden z , completedlub incomplete. Wypełniane, gdy elementy wejściowe są zwracane za pośrednictwem interfejsu API. Możliwe wartości: in_progress, , completedincomplete	Nr
typ	wyliczenie	Typ danych wyjściowych wywołania narzędzia komputerowego. Zawsze computer_call_output. Możliwe wartości: computer_call_output	Tak

ComputerToolCallOutputResource

Nazwa	Typ	Opis	Wymagane	Domyślny
acknowledged_safety_checks	macierz	Kontrole bezpieczeństwa zgłoszone przez interfejs API, które zostały potwierdzone przez dewelopera.	Nr
call_id	ciąg	Identyfikator wywołania narzędzia komputerowego, które wygenerowało dane wyjściowe.	Tak
Identyfikator	ciąg	Unikatowy identyfikator danych wyjściowych narzędzia wywołania komputera.	Tak
We/Wy	ComputerScreenshotImage	Obraz zrzutu ekranu komputera używany z narzędziem do korzystania z komputera.	Tak
stan	wyliczenie	Stan danych wejściowych komunikatu. in_progressJeden z , completedlub incomplete. Wypełniane, gdy elementy wejściowe są zwracane za pośrednictwem interfejsu API. Możliwe wartości: in_progress, , completedincomplete	Nr
typ	wyliczenie	Typ danych wyjściowych wywołania narzędzia komputerowego. Zawsze computer_call_output. Możliwe wartości: computer_call_output	Tak

ComputerToolCallSafetyCheck

Oczekująca kontrola bezpieczeństwa dla wywołania komputera.

Nazwa	Typ	Opis	Wymagane	Domyślny
kod	ciąg	Typ oczekującego sprawdzenia bezpieczeństwa.	Tak
Identyfikator	ciąg	Identyfikator oczekującego sprawdzenia bezpieczeństwa.	Tak
komunikat	ciąg	Szczegółowe informacje na temat oczekujących kontroli bezpieczeństwa.	Tak

Zawartości

Zawartość danych wejściowych i wyjściowych wielomodalnych.

Ten składnik może być jednym z następujących elementów:

• InputContent
• OutputContent

Współrzędnych

Para współrzędnych x/y, np. { x: 100, y: 200 }.

Nazwa	Typ	Opis	Wymagane	Domyślny
X	liczba całkowita	Współrzędna x.	Tak
Y	liczba całkowita	Współrzędna y.	Tak

CreateModelResponseProperties

Nazwa	Typ	Opis	Wymagane	Domyślny
metadane	Metadanych	Zestaw 16 par klucz-wartość, które można dołączyć do obiektu. Może to być przydatne do przechowywania dodatkowych informacji o obiekcie w formacie ustrukturyzowanym i wykonywania zapytań dotyczących obiektów za pośrednictwem interfejsu API lub pulpitu nawigacyjnego. Klucze to ciągi o maksymalnej długości 64 znaków. Wartości to ciągi o maksymalnej długości 512 znaków.	Nr
model	ciąg	Model używany do generowania odpowiedzi.	Nr
Temperatury	Numer	Jaka temperatura próbkowania ma być używana z zakresu od 0 do 2. Wyższe wartości, takie jak 0,8, sprawią, że dane wyjściowe będą bardziej losowe, a niższe wartości, takie jak 0,2, sprawią, że będzie bardziej skoncentrowany i deterministyczny. Ogólnie zalecamy zmianę tego lub top_p nie obu tych elementów.	Nr	1
top_p	Numer	Alternatywą dla próbkowania z temperaturą, nazywaną próbkowaniem jądra, gdzie model uwzględnia wyniki tokenów z top_p masą prawdopodobieństwa. Dlatego 0,1 oznacza, że uwzględniane są tylko tokeny składające się z 10 pierwszych% masy prawdopodobieństwa. Ogólnie zalecamy zmianę tego lub temperature nie obu tych elementów.	Nr	1
użytkownik	ciąg	Unikatowy identyfikator reprezentujący użytkownika końcowego, który może pomóc usłudze OpenAI w monitorowaniu i wykrywaniu nadużyć. .	Nr

createResponse

Nazwa	Typ	Opis	Wymagane	Domyślny
Obejmują	macierz	{"$ref": "#/components/schemas/includable/description"}	Nr
dane wejściowe	ciąg lub tablica	Dane wejściowe tekstu, obrazu lub pliku w modelu używane do generowania odpowiedzi.	Tak
Instrukcje	ciąg	Wstawia komunikat systemu (lub dewelopera) jako pierwszy element w kontekście modelu. W przypadku używania polecenia wraz z instrukcjami previous_response_idz poprzedniej odpowiedzi nie zostaną przeniesione do następnej odpowiedzi. Ułatwia to zamianę komunikatów systemowych (lub deweloperów) w nowych odpowiedziach.	Nr
max_output_tokens	liczba całkowita	Górna granica liczby tokenów, które można wygenerować dla odpowiedzi, w tym widoczne tokeny wyjściowe i tokeny rozumowania.	Nr
parallel_tool_calls	Boolean	Czy zezwolić modelowi na równoległe uruchamianie wywołań narzędzi.	Nr	True
previous_response_id	ciąg	Unikatowy identyfikator poprzedniej odpowiedzi na model. Użyj tej funkcji, aby utworzyć konwersacje wieloetowe.	Nr
Rozumowanie	Rozumowanie	Opcje konfiguracji dla modeli rozumowania.	Nr
przechowywać	Boolean	Określa, czy przechowywać wygenerowaną odpowiedź modelu na potrzeby późniejszego pobierania za pośrednictwem interfejsu API.	Nr	True
odtwarzać strumieniowo	Boolean	W przypadku ustawienia wartości true dane odpowiedzi modelu będą przesyłane strumieniowo do klienta, ponieważ są generowane przy użyciu zdarzeń wysyłanych przez serwer.	Nr	False
SMS	obiekt	Opcje konfiguracji odpowiedzi tekstowej z modelu. Może to być zwykły tekst lub dane JSON ze strukturą. Dowiedz się więcej: - wprowadzanie tekstu i dane wyjściowe - Dane wyjściowe ze strukturą	Nr
Format └*	TextResponseFormatConfiguration	Obiekt określający format, który musi zostać wygenerowany przez model. Konfigurowanie { "type": "json_schema" } umożliwia korzystanie ze strukturowych danych wyjściowych, co zapewnia, że model jest zgodny ze podanym schematem JSON. Format domyślny nie ma { "type": "text" } żadnych dodatkowych opcji. Niezalecane w przypadku modeli gpt-4o i nowszych: Ustawienie w celu { "type": "json_object" } włączenia starszego trybu JSON, co gwarantuje, że komunikat generowany przez model jest prawidłowym kodem JSON. Użycie json_schema jest preferowane w przypadku modeli, które go obsługują.	Nr
tool_choice	ToolChoiceOptions lub ToolChoiceTypes lub ToolChoiceFunction	W jaki sposób model powinien wybrać narzędzie (lub narzędzia), które ma być używane podczas generowania odpowiedzi. Zobacz parametr , tools aby zobaczyć, jak określić narzędzia, które może wywołać model.	Nr
Narzędzia	macierz	Tablica narzędzi, które model może wywołać podczas generowania odpowiedzi. Możesz określić, którego narzędzia użyć, ustawiając tool_choice parametr . Dwie kategorie narzędzi, które można podać, to: - Wbudowane narzędzia	Nr
Obcinania	wyliczenie	Strategia obcinania do użycia dla odpowiedzi modelu. - auto: Jeśli kontekst tej odpowiedzi i poprzednich przekroczy rozmiar okna kontekstu modelu, model zostanie obcięty odpowiedź na dopasowanie okna kontekstu przez usunięcie elementów wejściowych w środku konwersacji. - disabled (ustawienie domyślne): Jeśli odpowiedź modelu przekroczy rozmiar okna kontekstu dla modelu, żądanie zakończy się niepowodzeniem z powodu błędu 400. Możliwe wartości: auto, disabled	Nr

Doubleclick

Dwukrotne kliknięcie akcji.

Nazwa	Typ	Opis	Wymagane	Domyślny
typ	wyliczenie	Określa typ zdarzenia. W przypadku akcji dwukrotnego kliknięcia ta właściwość jest zawsze ustawiona na double_clickwartość . Możliwe wartości: double_click	Tak
X	liczba całkowita	Współrzędna x, w której wystąpiło dwukrotne kliknięcie.	Tak
Y	liczba całkowita	Współrzędna y, w której wystąpiło dwukrotne kliknięcie.	Tak

Przeciągnij

Akcja przeciągania.

Nazwa	Typ	Opis	Wymagane	Domyślny
ścieżka	macierz	Tablica współrzędnych reprezentujących ścieżkę akcji przeciągania. Współrzędne będą wyświetlane jako tablica obiektów, np.[{ x: 100, y: 200 }, { x: 200, y: 300 }]	Tak
typ	wyliczenie	Określa typ zdarzenia. W przypadku akcji przeciągania ta właściwość jest zawsze ustawiona na dragwartość . Możliwe wartości: drag	Tak

EasyInputMessage

Dane wejściowe komunikatu do modelu z rolą wskazującą instrukcję po hierarchii. Instrukcje podane z developer rolą lub system mają pierwszeństwo przed instrukcjami podanymi w user roli. Przyjmuje się, że komunikaty z rolą assistant zostały wygenerowane przez model w poprzednich interakcjach.

Nazwa	Typ	Opis	Wymagane	Domyślny
zawartość	string lub InputMessageContentList	Tekst, obraz lub dane wejściowe audio w modelu używane do generowania odpowiedzi. Może również zawierać poprzednie odpowiedzi asystenta.	Tak
rola	wyliczenie	Rola danych wejściowych komunikatu. userJeden z , assistant, systemlub developer. Możliwe wartości: user, , assistant, systemdeveloper	Tak
typ	wyliczenie	Typ danych wejściowych komunikatu. Zawsze message. Możliwe wartości: message	Nr

PlikCitation

Cytat do pliku.

Nazwa	Typ	Opis	Wymagane	Domyślny
File_id	ciąg	Identyfikator pliku.	Tak
indeks	liczba całkowita	Indeks pliku na liście plików.	Tak
typ	wyliczenie	Typ cytatu pliku. Zawsze file_citation. Możliwe wartości: file_citation	Tak

Filepath

Ścieżka do pliku.

Nazwa	Typ	Opis	Wymagane	Domyślny
File_id	ciąg	Identyfikator pliku.	Tak
indeks	liczba całkowita	Indeks pliku na liście plików.	Tak
typ	wyliczenie	Typ ścieżki pliku. Zawsze file_path. Możliwe wartości: file_path	Tak

FileSearchRanker

Klasyfikator używany do wyszukiwania plików. Jeśli nie zostanie określony, użyje klasyfikatora auto .

Właściwość	Wartość
Opis	Klasyfikator używany do wyszukiwania plików. Jeśli nie zostanie określony, użyje klasyfikatora auto .
Typu	ciąg
Wartości	auto default_2024_08_21

FileSearchTool

Narzędzie wyszukujące odpowiednią zawartość z przekazanych plików.

Nazwa	Typ	Opis	Wymagane	Domyślny
Filtry	Filtr porównawczy lub filtr złożony	Filtr do zastosowania na podstawie atrybutów pliku.	Nr
max_num_results	liczba całkowita	Maksymalna liczba wyników do zwrócenia. Ta liczba powinna należeć do zakresu od 1 do 50 włącznie.	Nr
ranking_options	obiekt	Opcje klasyfikacji wyszukiwania.	Nr
└} ranker	wyliczenie	Klasyfikator używany do wyszukiwania plików. Możliwe wartości: auto, default-2024-11-15	Nr
└score_threshold	Numer	Próg oceny dla wyszukiwania plików, liczba z zakresu od 0 do 1. Liczby bliżej 1 będą próbować zwracać tylko najbardziej odpowiednie wyniki, ale mogą zwracać mniej wyników.	Nr	0
typ	wyliczenie	Typ narzędzia wyszukiwania plików. Zawsze file_search. Możliwe wartości: file_search	Tak
vector_store_ids	macierz	Identyfikatory wektorów są przechowywane do wyszukiwania.	Tak

FileSearchToolCall

Wyniki wywołania narzędzia wyszukiwania plików.

Nazwa	Typ	Opis	Wymagane	Domyślny
Identyfikator	ciąg	Unikatowy identyfikator wywołania narzędzia wyszukiwania plików.	Tak
Kwerendy	macierz	Zapytania używane do wyszukiwania plików.	Tak
Wyniki	macierz	Wyniki wywołania narzędzia wyszukiwania plików.	Nr
stan	wyliczenie	Stan wywołania narzędzia wyszukiwania plików. in_progressJeden z , searchinglub incompletefailed, Możliwe wartości: in_progress, , searchingcompleted, , incompletefailed	Tak
typ	wyliczenie	Typ wywołania narzędzia wyszukiwania plików. Zawsze file_search_call. Możliwe wartości: file_search_call	Tak

FunctionTool

Definiuje funkcję we własnym kodzie, która może być wywoływana przez model.

Nazwa	Typ	Opis	Wymagane	Domyślny
Opis	ciąg	Opis funkcji. Używany przez model do określania, czy wywołać funkcję.	Nr
Nazwa	ciąg	Nazwa funkcji do wywołania.	Tak
Parametry	obiekt	Obiekt schematu JSON opisujący parametry funkcji.	Tak
Ścisłe	Boolean	Czy wymusić ścisłą walidację parametrów. Wartość domyślna true.	Tak
typ	wyliczenie	Typ narzędzia funkcji. Zawsze function. Możliwe wartości: function	Tak

FunctionToolCall

Wywołanie narzędzia w celu uruchomienia funkcji.

Nazwa	Typ	Opis	Wymagane	Domyślny
Argumenty	ciąg	Ciąg JSON argumentów do przekazania do funkcji.	Tak
call_id	ciąg	Unikatowy identyfikator wywołania narzędzia funkcji wygenerowanego przez model.	Tak
Identyfikator	ciąg	Unikatowy identyfikator wywołania narzędzia funkcji.	Tak
Nazwa	ciąg	Nazwa funkcji do uruchomienia.	Tak
stan	wyliczenie	Stan elementu. in_progressJeden z , completedlub incomplete. Wypełniane, gdy elementy są zwracane za pośrednictwem interfejsu API. Możliwe wartości: in_progress, , completedincomplete	Nr
typ	wyliczenie	Typ wywołania narzędzia funkcji. Zawsze function_call. Możliwe wartości: function_call	Tak

FunctionToolCallOutput

Dane wyjściowe wywołania narzędzia funkcji.

Nazwa	Typ	Opis	Wymagane	Domyślny
call_id	ciąg	Unikatowy identyfikator wywołania narzędzia funkcji wygenerowanego przez model.	Tak
Identyfikator	ciąg	Unikatowy identyfikator danych wyjściowych wywołania narzędzia funkcji. Wypełniane, gdy ten element jest zwracany za pośrednictwem interfejsu API.	Nr
We/Wy	ciąg	Ciąg JSON danych wyjściowych wywołania narzędzia funkcji.	Tak
stan	wyliczenie	Stan elementu. in_progressJeden z , completedlub incomplete. Wypełniane, gdy elementy są zwracane za pośrednictwem interfejsu API. Możliwe wartości: in_progress, , completedincomplete	Nr
typ	wyliczenie	Typ danych wyjściowych wywołania narzędzia funkcji. Zawsze function_call_output. Możliwe wartości: function_call_output	Tak

FunctionToolCallOutputResource

Nazwa	Typ	Opis	Wymagane	Domyślny
call_id	ciąg	Unikatowy identyfikator wywołania narzędzia funkcji wygenerowanego przez model.	Tak
Identyfikator	ciąg	Unikatowy identyfikator danych wyjściowych narzędzia wywołania funkcji.	Tak
We/Wy	ciąg	Ciąg JSON danych wyjściowych wywołania narzędzia funkcji.	Tak
stan	wyliczenie	Stan elementu. in_progressJeden z , completedlub incomplete. Wypełniane, gdy elementy są zwracane za pośrednictwem interfejsu API. Możliwe wartości: in_progress, , completedincomplete	Nr
typ	wyliczenie	Typ danych wyjściowych wywołania narzędzia funkcji. Zawsze function_call_output. Możliwe wartości: function_call_output	Tak

includable

Określ dodatkowe dane wyjściowe do uwzględnienia w odpowiedzi modelu. Obecnie obsługiwane wartości to:

• file_search_call.results: dołącz wyniki wyszukiwania wywołania narzędzia wyszukiwania plików.
• message.input_image.image_url: dołącz adresy URL obrazów z komunikatu wejściowego.
• computer_call_output.output.image_url: dołącz adresy URL obrazów z danych wyjściowych wywołania komputera.

Właściwość	Wartość
Opis	Określ dodatkowe dane wyjściowe do uwzględnienia w odpowiedzi modelu. Obecnie obsługiwane wartości to: - file_search_call.results: dołącz wyniki wyszukiwania wywołania narzędzia wyszukiwania plików. - message.input_image.image_url: dołącz adresy URL obrazów z komunikatu wejściowego. - computer_call_output.output.image_url: dołącz adresy URL obrazów z danych wyjściowych wywołania komputera.
Typu	ciąg
Wartości	file_search_call.results message.input_image.image_url computer_call_output.output.image_url

InputAudio

Dane wejściowe audio do modelu.

Nazwa	Typ	Opis	Wymagane	Domyślny
dane	ciąg	Dane audio zakodowane w formacie Base64.	Tak
Formacie	wyliczenie	Format danych audio. Obecnie obsługiwane formaty to mp3 i wav. Możliwe wartości: mp3, wav	Tak
typ	wyliczenie	Typ elementu wejściowego. Zawsze input_audio. Możliwe wartości: input_audio	Tak

InputContent

Ten składnik może być jednym z następujących elementów:

• Tekst wejściowy
• InputImage
• InputFile

InputFile

Dane wejściowe pliku do modelu.

Nazwa	Typ	Opis	Wymagane	Domyślny
file_data	ciąg	Zawartość pliku, który ma zostać wysłany do modelu.	Nr
File_id	ciąg	Identyfikator pliku, który ma zostać wysłany do modelu.	Nr
Pod nazwą	ciąg	Nazwa pliku, który ma zostać wysłany do modelu.	Nr
typ	wyliczenie	Typ elementu wejściowego. Zawsze input_file. Możliwe wartości: input_file	Tak

InputImage

Dane wejściowe obrazu do modelu.

Nazwa	Typ	Opis	Wymagane	Domyślny
Szczegółów	wyliczenie	Poziom szczegółowości obrazu, który ma zostać wysłany do modelu. highJeden z , lowlub auto. Wartość domyślna to auto. Możliwe wartości: high, , lowauto	Tak
File_id	ciąg	Identyfikator pliku, który ma zostać wysłany do modelu.	Nr
image_url	ciąg	Adres URL obrazu, który ma zostać wysłany do modelu. W pełni kwalifikowany adres URL lub obraz zakodowany w formacie base64 w adresie URL danych.	Nr
typ	wyliczenie	Typ elementu wejściowego. Zawsze input_image. Możliwe wartości: input_image	Tak

InputItem

Ten składnik może być jednym z następujących elementów:

• EasyInputMessage
• Element
• Itemreference

InputMessage

Dane wejściowe komunikatu do modelu z rolą wskazującą instrukcję po hierarchii. Instrukcje podane z developer rolą lub system mają pierwszeństwo przed instrukcjami podanymi w user roli.

Nazwa	Typ	Opis	Wymagane	Domyślny
zawartość	InputMessageContentList	Lista jednego lub wielu elementów wejściowych do modelu zawierająca inną zawartość Typy.	Tak
rola	wyliczenie	Rola danych wejściowych komunikatu. userJeden z , systemlub developer. Możliwe wartości: user, , systemdeveloper	Tak
stan	wyliczenie	Stan elementu. in_progressJeden z , completedlub incomplete. Wypełniane, gdy elementy są zwracane za pośrednictwem interfejsu API. Możliwe wartości: in_progress, , completedincomplete	Nr
typ	wyliczenie	Typ danych wejściowych komunikatu. Zawsze ustaw wartość message. Możliwe wartości: message	Nr

InputMessageContentList

Lista jednego lub wielu elementów wejściowych do modelu zawierająca różne typy zawartości.

Brak zdefiniowanych właściwości dla tego składnika.

InputMessageResource

Nazwa	Typ	Opis	Wymagane	Domyślny
zawartość	InputMessageContentList	Lista jednego lub wielu elementów wejściowych do modelu zawierająca inną zawartość Typy.	Tak
Identyfikator	ciąg	Unikatowy identyfikator danych wejściowych wiadomości.	Tak
rola	wyliczenie	Rola danych wejściowych komunikatu. userJeden z , systemlub developer. Możliwe wartości: user, , systemdeveloper	Tak
stan	wyliczenie	Stan elementu. in_progressJeden z , completedlub incomplete. Wypełniane, gdy elementy są zwracane za pośrednictwem interfejsu API. Możliwe wartości: in_progress, , completedincomplete	Nr
typ	wyliczenie	Typ danych wejściowych komunikatu. Zawsze ustaw wartość message. Możliwe wartości: message	Nr

Tekst wejściowy

Wprowadzanie tekstu do modelu.

Nazwa	Typ	Opis	Wymagane	Domyślny
SMS	ciąg	Wprowadzanie tekstu do modelu.	Tak
typ	wyliczenie	Typ elementu wejściowego. Zawsze input_text. Możliwe wartości: input_text	Tak

Element

Element zawartości używany do generowania odpowiedzi.

Ten składnik może być jednym z następujących elementów:

• InputMessage
• OutputMessage
• FileSearchToolCall
• ComputerToolCall
• ComputerToolCallOutput
• FunctionToolCall
• FunctionToolCallOutput
• ReasoningItem

Itemreference

Wewnętrzny identyfikator elementu do odwołania.

Nazwa	Typ	Opis	Wymagane	Domyślny
Identyfikator	ciąg	Identyfikator elementu do odwołania.	Tak
typ	wyliczenie	Typ elementu do odwołania. Zawsze item_reference. Możliwe wartości: item_reference	Tak

ItemResource

Element zawartości używany do generowania odpowiedzi.

Ten składnik może być jednym z następujących elementów:

• InputMessageResource
• OutputMessage
• FileSearchToolCall
• ComputerToolCall
• ComputerToolCallOutputResource
• FunctionToolCall
• FunctionToolCallOutputResource

Keypress

Kolekcja kluczy, które model chce wykonać.

Nazwa	Typ	Opis	Wymagane	Domyślny
Klucze	macierz	Kombinacja klawiszy, które model żąda naciśnięcia. Jest to tablica ciągów, z których każdy reprezentuje klucz.	Tak
typ	wyliczenie	Określa typ zdarzenia. W przypadku akcji keypress ta właściwość jest zawsze ustawiona na keypresswartość . Możliwe wartości: keypress	Tak

Metadanych

Zestaw 16 par klucz-wartość, które można dołączyć do obiektu. Może to być przydatne do przechowywania dodatkowych informacji o obiekcie w formacie ustrukturyzowanym i wykonywania zapytań dotyczących obiektów za pośrednictwem interfejsu API lub pulpitu nawigacyjnego.

Klucze to ciągi o maksymalnej długości 64 znaków. Wartości to ciągi o maksymalnej długości 512 znaków.

Brak zdefiniowanych właściwości dla tego składnika.

ModelResponseProperties

Nazwa	Typ	Opis	Wymagane	Domyślny
metadane	Metadanych	Zestaw 16 par klucz-wartość, które można dołączyć do obiektu. Może to być przydatne do przechowywania dodatkowych informacji o obiekcie w formacie ustrukturyzowanym i wykonywania zapytań dotyczących obiektów za pośrednictwem interfejsu API lub pulpitu nawigacyjnego. Klucze to ciągi o maksymalnej długości 64 znaków. Wartości to ciągi o maksymalnej długości 512 znaków.	Nr
model	ciąg	Model używany do generowania odpowiedzi.	Nr
Temperatury	Numer	Jaka temperatura próbkowania ma być używana z zakresu od 0 do 2. Wyższe wartości, takie jak 0,8, sprawią, że dane wyjściowe będą bardziej losowe, a niższe wartości, takie jak 0,2, sprawią, że będzie bardziej skoncentrowany i deterministyczny. Ogólnie zalecamy zmianę tego lub top_p nie obu tych elementów.	Nr	1
top_p	Numer	Alternatywą dla próbkowania z temperaturą, nazywaną próbkowaniem jądra, gdzie model uwzględnia wyniki tokenów z top_p masą prawdopodobieństwa. Dlatego 0,1 oznacza, że uwzględniane są tylko tokeny składające się z 10 pierwszych% masy prawdopodobieństwa. Ogólnie zalecamy zmianę tego lub temperature nie obu tych elementów.	Nr	1
użytkownik	ciąg	Unikatowy identyfikator reprezentujący użytkownika końcowego, który może pomóc usłudze OpenAI w monitorowaniu i wykrywaniu nadużyć. .	Nr

Przenieść

Akcja przenoszenia myszy.

Nazwa	Typ	Opis	Wymagane	Domyślny
typ	wyliczenie	Określa typ zdarzenia. W przypadku akcji przenoszenia ta właściwość jest zawsze ustawiona na movewartość . Możliwe wartości: move	Tak
X	liczba całkowita	Współrzędna x do przejścia.	Tak
Y	liczba całkowita	Współrzędna y do przejścia.	Tak

OutputAudio

Dane wyjściowe audio z modelu.

Nazwa	Typ	Opis	Wymagane	Domyślny
dane	ciąg	Dane audio zakodowane w formacie Base64 z modelu.	Tak
transkrypcja	ciąg	Transkrypcja danych audio z modelu.	Tak
typ	wyliczenie	Typ dźwięku wyjściowego. Zawsze output_audio. Możliwe wartości: output_audio	Tak

OutputContent

Ten składnik może być jednym z następujących elementów:

• Tekst wyjściowy
• Odmowy

OutputItem

Nazwa	Typ	Opis	Wymagane	Domyślny
akcja	ComputerAction		Tak
Argumenty	ciąg	Ciąg JSON argumentów do przekazania do funkcji.	Tak
call_id	ciąg	Identyfikator używany podczas odpowiadania na wywołanie narzędzia przy użyciu danych wyjściowych.	Tak
zawartość	macierz	Rozumowanie zawartości tekstowej.	Tak
Identyfikator	ciąg	Unikatowy identyfikator zawartości rozumowania.	Tak
Nazwa	ciąg	Nazwa funkcji do uruchomienia.	Tak
pending_safety_checks	macierz	Oczekujące kontrole bezpieczeństwa dla wywołania komputera.	Tak
Kwerendy	macierz	Zapytania używane do wyszukiwania plików.	Tak
Wyniki	macierz	Wyniki wywołania narzędzia wyszukiwania plików.	Nr
rola	wyliczenie	Rola komunikatu wyjściowego. Zawsze assistant. Możliwe wartości: assistant	Tak
stan	wyliczenie	Stan elementu. in_progressJeden z , completedlub incomplete. Wypełniane, gdy elementy są zwracane za pośrednictwem interfejsu API. Możliwe wartości: in_progress, , completedincomplete	Tak
typ	wyliczenie	Typ obiektu. Zawsze reasoning. Możliwe wartości: reasoning	Tak

OutputMessage

Komunikat wyjściowy z modelu.

Nazwa	Typ	Opis	Wymagane	Domyślny
zawartość	macierz	Zawartość komunikatu wyjściowego.	Tak
Identyfikator	ciąg	Unikatowy identyfikator komunikatu wyjściowego.	Tak
rola	wyliczenie	Rola komunikatu wyjściowego. Zawsze assistant. Możliwe wartości: assistant	Tak
stan	wyliczenie	Stan danych wejściowych komunikatu. in_progressJeden z , completedlub incomplete. Wypełniane, gdy elementy wejściowe są zwracane za pośrednictwem interfejsu API. Możliwe wartości: in_progress, , completedincomplete	Tak
typ	wyliczenie	Typ komunikatu wyjściowego. Zawsze message. Możliwe wartości: message	Tak

Tekst wyjściowy

Dane wyjściowe tekstowe z modelu.

Nazwa	Typ	Opis	Wymagane	Domyślny
Adnotacje	macierz	Adnotacje danych wyjściowych tekstu.	Tak
SMS	ciąg	Dane wyjściowe tekstu z modelu.	Tak
typ	wyliczenie	Typ tekstu wyjściowego. Zawsze output_text. Możliwe wartości: output_text	Tak

RealtimeSessionCreateRequest

Konfiguracja obiektu sesji w czasie rzeczywistym.

Nazwa	Typ	Opis	Wymagane	Domyślny
input_audio_format	wyliczenie	Format wejściowego dźwięku. Opcje to pcm16, g711_ulawlub g711_alaw. W przypadku pcm16systemu dźwięk wejściowy musi być 16-bitowy PCM z częstotliwością próbkowania 24kHz, pojedynczym kanałem (mono) i małą kolejnością bajtów endian. Możliwe wartości: pcm16, , g711_ulawg711_alaw	Nr
input_audio_noise_reduction	obiekt	Konfiguracja redukcji szumu dźwięku wejściowego. Można to ustawić tak, null aby wyłączyć. Redukcja szumu filtruje dźwięk dodany do wejściowego buforu audio przed wysłaniem go do usługi VAD i modelu. Filtrowanie dźwięku może poprawić dokładność wykrywania vaD i włączania (zmniejszenie wyników fałszywie dodatnich) i wydajność modelu, poprawiając postrzeganie dźwięku wejściowego.	Nr
└typ	wyliczenie	Typ redukcji szumu. near_field jest przeznaczony dla mikrofonów z bliska, takich jak słuchawki, jest przeznaczony dla mikrofonów dalekiego pola, far_field takich jak laptop lub mikrofony sali konferencyjnej. Możliwe wartości: near_field, far_field	Nr
input_audio_transcription	obiekt	Konfiguracja transkrypcji audio wejściowego, domyślnie wyłączona i może być ustawiona tak, aby null wyłączyć raz. Transkrypcja audio wejściowego nie jest natywna dla modelu, ponieważ model korzysta bezpośrednio z dźwięku. Transkrypcja jest uruchamiana asynchronicznie za pośrednictwem punktu końcowego transkrypcji i powinna być traktowana jako wskazówki dotyczące wejściowej zawartości audio, a nie dokładnie tego, co usłyszał model. Klient może opcjonalnie ustawić język i monitować o transkrypcję. Oferują one dodatkowe wskazówki dotyczące usługi transkrypcji.	Nr
└* język	ciąg	Język wejściowego dźwięku. Dostarczanie języka wejściowego w formacie ISO-639-1 (np. en) zwiększa dokładność i opóźnienie.	Nr
Model └*	ciąg	Model używany do transkrypcji, bieżące opcje to gpt-4o-transcribe, gpt-4o-mini-transcribe, gpt-4o-mini-transcribe-2025-12-15i whisper-1.	Nr
Monit └*	ciąg	Opcjonalny tekst prowadzący do stylu modelu lub kontynuacji poprzedniego segmentu audio. W przypadku whisper-1polecenia jest to lista słów kluczowych. W przypadku gpt-4o-transcribe modeli monit jest wolnym ciągiem tekstowym, na przykład "oczekiwano słów związanych z technologią".	Nr
Instrukcje	ciąg	Domyślne instrukcje systemowe (tj. komunikat systemowy) są poprzedzane wywołaniami modelu. To pole umożliwia klientowi poprowadzenie modelu w żądanych odpowiedziach. Model może być poinstruowany na temat zawartości i formatu odpowiedzi (np. "być bardzo zwięzły", "działać przyjazny", "oto przykłady dobrych odpowiedzi") i zachowania audio (np. "szybko rozmawiać", "wstrzykiwanie emocji do głosu", "śmiać się często"). Instrukcje nie mają gwarancji, że są zgodne z modelem, ale zapewniają wskazówki dotyczące modelu w żądanym zachowaniu. Należy pamiętać, że serwer ustawia domyślne instrukcje, które będą używane, jeśli to pole nie jest ustawione i są widoczne w session.created zdarzeniu na początku sesji.	Nr
max_response_output_tokens	liczba całkowita lub ciąg	Maksymalna liczba tokenów wyjściowych dla pojedynczej odpowiedzi asystenta, w tym wywołań narzędzi. Podaj liczbę całkowitą z zakresu od 1 do 4096, aby ograniczyć tokeny wyjściowe lub inf maksymalnie dostępne tokeny dla danego modelu. Wartość domyślna to inf.	Nr
Sposoby		Zestaw modalności, za pomocą których model może reagować. Aby wyłączyć dźwięk, ustaw wartość ["text"].	Nr
model	ciąg	Nazwa wdrożenia używanego na potrzeby tej sesji.	Nr
output_audio_format	wyliczenie	Format dźwięku wyjściowego. Opcje to pcm16, g711_ulawlub g711_alaw. W przypadku pcm16parametru dźwięk wyjściowy jest próbkowany z szybkością 24kHz. Możliwe wartości: pcm16, , g711_ulawg711_alaw	Nr
Temperatury	Numer	Temperatura próbkowania dla modelu ograniczona do [0.6, 1.2]. W przypadku modeli audio temperatura 0,8 jest zdecydowanie zalecana w celu uzyskania najlepszej wydajności.	Nr	0.8
tool_choice	ciąg	W jaki sposób model wybiera narzędzia. Opcje to auto, none, requiredlub określają funkcję.	Nr	Automatycznie
Narzędzia	macierz	Narzędzia (funkcje) dostępne dla modelu.	Nr
turn_detection	obiekt	Konfiguracja wykrywania kolei, eter Server VAD lub Semantic VAD. Można to ustawić tak, aby null wyłączyć, w takim przypadku klient musi ręcznie wyzwolić odpowiedź modelu. Funkcja VAD serwera oznacza, że model wykryje początek i koniec mowy na podstawie głośności audio i odpowie na końcu mowy użytkownika. Semantyczna funkcja VAD jest bardziej zaawansowana i używa modelu wykrywania obrotu (w połączeniu z vaD), aby semantycznie oszacować, czy użytkownik zakończył mówić, a następnie dynamicznie ustawia limit czasu na podstawie tego prawdopodobieństwa. Jeśli na przykład użytkownik wybiegnie ścieżki audio z uhhmużyciem metody , model będzie oceniać niskie prawdopodobieństwo włączenia i poczekać dłużej na kontynuowanie mówienia przez użytkownika. Może to być przydatne w przypadku bardziej naturalnych rozmów, ale może mieć większe opóźnienie.	Nr
└create_response	Boolean	Określa, czy ma być automatycznie generowany odpowiedź po wystąpieniu zdarzenia zatrzymania vaD.	Nr	True
└* gotowość	wyliczenie	Używane tylko w semantic_vad trybie. Gotowość modelu do reagowania. low będzie czekać dłużej, aż użytkownik będzie nadal mówić, high będzie reagować szybciej. auto jest wartością domyślną i jest odpowiednikiem medium. Możliwe wartości: low, , medium, highauto	Nr
└interrupt_response	Boolean	Określa, czy automatycznie przerywać bieżącą odpowiedź z danymi wyjściowymi domyślnej konwersacji (tj. conversation ) po wystąpieniu autozdarzenia rozpoczęcia vaD.	Nr	True
└prefix_padding_ms	liczba całkowita	Używane tylko w server_vad trybie. Ilość dźwięku do uwzględnienia przed wykryciem mowy vaD (w milisekundach). Wartość domyślna to 300 ms.	Nr
└silence_duration_ms	liczba całkowita	Używane tylko w server_vad trybie. Czas trwania ciszy wykrywania zatrzymania mowy (w milisekundach). Wartość domyślna to 500 ms. Dzięki krótszym wartościom model będzie reagować szybciej, ale może wskoczyć na krótkie przerwy od użytkownika.	Nr
└* próg	Numer	Używane tylko w server_vad trybie. Próg aktywacji dla usługi VAD (od 0.0 do 1.0) domyślnie wynosi 0,5. Wyższy próg będzie wymagać głośniejszego dźwięku do aktywowania modelu, a tym samym może działać lepiej w hałaśliwych środowiskach.	Nr
└typ	wyliczenie	Typ wykrywania kolei. Możliwe wartości: server_vad, semantic_vad	Nr
głos	VoiceIdsShared		Nr

RealtimeSessionCreateResponse

Nowa konfiguracja sesji w czasie rzeczywistym z kluczem efemerycznym. Domyślny czas wygaśnięcia kluczy to jedna minuta.

Nazwa	Typ	Opis	Wymagane	Domyślny
client_secret	obiekt	Klucz efemeryczny zwrócony przez interfejs API.	Tak
└expires_at	liczba całkowita	Sygnatura czasowa dla czasu wygaśnięcia tokenu. Obecnie wszystkie tokeny wygasają po jednej minucie.	Nr
└* wartość	ciąg	Klucz efemeryczny używany w środowiskach klienckich do uwierzytelniania połączeń z interfejsem API czasu rzeczywistego. Użyj tego w środowiskach po stronie klienta, a nie w standardowym tokenie interfejsu API, który powinien być używany tylko po stronie serwera.	Nr
input_audio_format	ciąg	Format wejściowego dźwięku. Opcje to pcm16, g711_ulawlub g711_alaw.	Nr
input_audio_transcription	obiekt	Konfiguracja transkrypcji audio wejściowego, domyślnie wyłączona i może być ustawiona tak, aby null wyłączyć raz. Transkrypcja audio wejściowego nie jest natywna dla modelu, ponieważ model korzysta bezpośrednio z dźwięku. Transkrypcja jest uruchamiana asynchronicznie przez szept i powinna być traktowana jako szorstka wskazówka, a nie reprezentacja rozumiana przez model.	Nr
Model └*	ciąg	Model używany do transkrypcji whisper-1 jest jedynym obecnie obsługiwanym modelem.	Nr
Instrukcje	ciąg	Domyślne instrukcje systemowe (tj. komunikat systemowy) są poprzedzane wywołaniami modelu. To pole umożliwia klientowi poprowadzenie modelu w żądanych odpowiedziach. Model może być poinstruowany na temat zawartości i formatu odpowiedzi (np. "być bardzo zwięzły", "act friendly", "here are examples of good responses") i na zachowanie audio (np. "rozmowa szybko", "wstrzykiwanie emocji do głosu", "śmiej się często"). Instrukcje nie mają gwarancji, że są zgodne z modelem, ale zapewniają wskazówki dotyczące modelu w żądanym zachowaniu. Należy pamiętać, że serwer ustawia domyślne instrukcje, które będą używane, jeśli to pole nie jest ustawione i są widoczne w session.created zdarzeniu na początku sesji.	Nr
max_response_output_tokens	liczba całkowita lub ciąg	Maksymalna liczba tokenów wyjściowych dla pojedynczej odpowiedzi asystenta, w tym wywołań narzędzi. Podaj liczbę całkowitą z zakresu od 1 do 4096, aby ograniczyć tokeny wyjściowe lub inf maksymalnie dostępne tokeny dla danego modelu. Wartość domyślna to inf.	Nr
Sposoby		Zestaw modalności, za pomocą których model może reagować. Aby wyłączyć dźwięk, ustaw wartość ["text"].	Nr
output_audio_format	ciąg	Format dźwięku wyjściowego. Opcje to pcm16, g711_ulawlub g711_alaw.	Nr
Temperatury	Numer	Temperatura próbkowania dla modelu ograniczona do [0.6, 1.2]. Wartość domyślna to 0.8.	Nr
tool_choice	ciąg	W jaki sposób model wybiera narzędzia. Opcje to auto, none, requiredlub określają funkcję.	Nr
Narzędzia	macierz	Narzędzia (funkcje) dostępne dla modelu.	Nr
turn_detection	obiekt	Konfiguracja wykrywania obrotu. Można ustawić na wartość , aby null wyłączyć. Funkcja VAD serwera oznacza, że model wykryje początek i koniec mowy na podstawie głośności audio i odpowie na końcu mowy użytkownika.	Nr
└prefix_padding_ms	liczba całkowita	Ilość dźwięku do uwzględnienia przed wykryciem mowy vaD (w milisekundach). Wartość domyślna to 300 ms.	Nr
└silence_duration_ms	liczba całkowita	Czas trwania ciszy wykrywania zatrzymania mowy (w milisekundach). Wartość domyślna to 500 ms. Dzięki krótszym wartościom model będzie reagować szybciej, ale może wskoczyć na krótkie przerwy od użytkownika.	Nr
└* próg	Numer	Próg aktywacji dla usługi VAD (od 0.0 do 1.0) domyślnie wynosi 0,5. Wyższy próg będzie wymagać głośniejszego dźwięku do aktywowania modelu, a tym samym może działać lepiej w hałaśliwych środowiskach.	Nr
└typ	ciąg	Typ wykrywania kolei, jest obecnie obsługiwany tylko server_vad .	Nr
głos	VoiceIdsShared		Nr

RealtimeTranscriptionSessionCreateRequest

Konfiguracja obiektu sesji transkrypcji w czasie rzeczywistym.

Nazwa	Typ	Opis	Wymagane	Domyślny
Obejmują	macierz	Zestaw elementów do uwzględnienia w transkrypcji. Bieżące dostępne elementy to: - item.input_audio_transcription.logprobs	Nr
input_audio_format	wyliczenie	Format wejściowego dźwięku. Opcje to pcm16, g711_ulawlub g711_alaw. W przypadku pcm16systemu dźwięk wejściowy musi być 16-bitowy PCM z częstotliwością próbkowania 24kHz, pojedynczym kanałem (mono) i małą kolejnością bajtów endian. Możliwe wartości: pcm16, , g711_ulawg711_alaw	Nr
input_audio_noise_reduction	obiekt	Konfiguracja redukcji szumu dźwięku wejściowego. Można to ustawić tak, null aby wyłączyć. Redukcja szumu filtruje dźwięk dodany do wejściowego buforu audio przed wysłaniem go do usługi VAD i modelu. Filtrowanie dźwięku może poprawić dokładność wykrywania vaD i włączania (zmniejszenie wyników fałszywie dodatnich) i wydajność modelu, poprawiając postrzeganie dźwięku wejściowego.	Nr
└typ	wyliczenie	Typ redukcji szumu. near_field jest przeznaczony dla mikrofonów z bliska, takich jak słuchawki, jest przeznaczony dla mikrofonów dalekiego pola, far_field takich jak laptop lub mikrofony sali konferencyjnej. Możliwe wartości: near_field, far_field	Nr
input_audio_transcription	obiekt	Konfiguracja transkrypcji dźwięku wejściowego. Klient może opcjonalnie ustawić język i monitować o transkrypcję. Oferują one dodatkowe wskazówki dotyczące usługi transkrypcji.	Nr
└* język	ciąg	Język wejściowego dźwięku. Dostarczanie języka wejściowego w formacie ISO-639-1 (np. en) zwiększa dokładność i opóźnienie.	Nr
Model └*	wyliczenie	Model używany do transkrypcji, bieżące opcje to gpt-4o-transcribe, , gpt-4o-transcribe-diarizegpt-4o-mini-transcribe, gpt-4o-mini-transcribe-2025-12-15i whisper-1. Możliwe wartości: gpt-4o-transcribe, , gpt-4o-transcribe-diarizegpt-4o-mini-transcribe, , gpt-4o-mini-transcribe-2025-12-15whisper-1	Nr
Monit └*	ciąg	Opcjonalny tekst prowadzący do stylu modelu lub kontynuacji poprzedniego segmentu audio. W przypadku whisper-1polecenia jest to lista słów kluczowych. W przypadku gpt-4o-transcribe modeli monit jest wolnym ciągiem tekstowym, na przykład "oczekiwano słów związanych z technologią".	Nr
Sposoby		Zestaw modalności, za pomocą których model może reagować. Aby wyłączyć dźwięk, ustaw wartość ["text"].	Nr
turn_detection	obiekt	Konfiguracja wykrywania kolei, eter Server VAD lub Semantic VAD. Można to ustawić tak, aby null wyłączyć, w takim przypadku klient musi ręcznie wyzwolić odpowiedź modelu. Funkcja VAD serwera oznacza, że model wykryje początek i koniec mowy na podstawie głośności audio i odpowie na końcu mowy użytkownika. Semantyczna funkcja VAD jest bardziej zaawansowana i używa modelu wykrywania obrotu (w połączeniu z vaD), aby semantycznie oszacować, czy użytkownik zakończył mówić, a następnie dynamicznie ustawia limit czasu na podstawie tego prawdopodobieństwa. Jeśli na przykład użytkownik wybiegnie ścieżki audio z uhhmużyciem metody , model będzie oceniać niskie prawdopodobieństwo włączenia i poczekać dłużej na kontynuowanie mówienia przez użytkownika. Może to być przydatne w przypadku bardziej naturalnych rozmów, ale może mieć większe opóźnienie.	Nr
└create_response	Boolean	Określa, czy ma być automatycznie generowany odpowiedź po wystąpieniu zdarzenia zatrzymania vaD. Niedostępne dla sesji transkrypcji.	Nr	True
└* gotowość	wyliczenie	Używane tylko w semantic_vad trybie. Gotowość modelu do reagowania. low będzie czekać dłużej, aż użytkownik będzie nadal mówić, high będzie reagować szybciej. auto jest wartością domyślną i jest odpowiednikiem medium. Możliwe wartości: low, , medium, highauto	Nr
└interrupt_response	Boolean	Określa, czy automatycznie przerywać bieżącą odpowiedź z danymi wyjściowymi domyślnej konwersacji (tj. conversation ) po wystąpieniu autozdarzenia rozpoczęcia vaD. Niedostępne dla sesji transkrypcji.	Nr	True
└prefix_padding_ms	liczba całkowita	Używane tylko w server_vad trybie. Ilość dźwięku do uwzględnienia przed wykryciem mowy vaD (w milisekundach). Wartość domyślna to 300 ms.	Nr
└silence_duration_ms	liczba całkowita	Używane tylko w server_vad trybie. Czas trwania ciszy wykrywania zatrzymania mowy (w milisekundach). Wartość domyślna to 500 ms. Dzięki krótszym wartościom model będzie reagować szybciej, ale może wskoczyć na krótkie przerwy od użytkownika.	Nr
└* próg	Numer	Używane tylko w server_vad trybie. Próg aktywacji dla usługi VAD (od 0.0 do 1.0) domyślnie wynosi 0,5. Wyższy próg będzie wymagać głośniejszego dźwięku do aktywowania modelu, a tym samym może działać lepiej w hałaśliwych środowiskach.	Nr
└typ	wyliczenie	Typ wykrywania kolei. Możliwe wartości: server_vad, semantic_vad	Nr

RealtimeTranscriptionSessionCreateResponse

Nowa konfiguracja sesji transkrypcji w czasie rzeczywistym.

Po utworzeniu sesji na serwerze za pośrednictwem interfejsu API REST obiekt sesji zawiera również klucz efemeryczny. Domyślny czas wygaśnięcia kluczy to jedna minuta. Ta właściwość nie jest obecna, gdy sesja jest aktualizowana za pośrednictwem interfejsu API protokołu WebSocket.

Nazwa	Typ	Opis	Wymagane	Domyślny
client_secret	obiekt	Klucz efemeryczny zwrócony przez interfejs API. Występuje tylko wtedy, gdy sesja jest tworzona na serwerze za pośrednictwem interfejsu API REST.	Tak
└expires_at	liczba całkowita	Sygnatura czasowa dla czasu wygaśnięcia tokenu. Obecnie wszystkie tokeny wygasają po jednej minucie.	Nr
└* wartość	ciąg	Klucz efemeryczny używany w środowiskach klienckich do uwierzytelniania połączeń z interfejsem API czasu rzeczywistego. Użyj tego w środowiskach po stronie klienta, a nie w standardowym tokenie interfejsu API, który powinien być używany tylko po stronie serwera.	Nr
input_audio_format	ciąg	Format wejściowego dźwięku. Opcje to pcm16, g711_ulawlub g711_alaw.	Nr
input_audio_transcription	obiekt	Konfiguracja modelu transkrypcji.	Nr
└* język	ciąg	Język wejściowego dźwięku. Dostarczanie języka wejściowego w formacie ISO-639-1 (np. en) zwiększa dokładność i opóźnienie.	Nr
Model └*	wyliczenie	Model do użycia do transkrypcji. Może to być gpt-4o-transcribe, gpt-4o-mini-transcribe, gpt-4o-mini-transcribe-2025-12-15lub whisper-1. Możliwe wartości: gpt-4o-transcribe, , gpt-4o-mini-transcribe, gpt-4o-mini-transcribe-2025-12-15whisper-1	Nr
Monit └*	ciąg	Opcjonalny tekst prowadzący do stylu modelu lub kontynuacji poprzedniego segmentu audio. Monit powinien być zgodny z językiem dźwięku.	Nr
Sposoby		Zestaw modalności, za pomocą których model może reagować. Aby wyłączyć dźwięk, ustaw wartość ["text"].	Nr
turn_detection	obiekt	Konfiguracja wykrywania obrotu. Można ustawić na wartość , aby null wyłączyć. Funkcja VAD serwera oznacza, że model wykryje początek i koniec mowy na podstawie głośności audio i odpowie na końcu mowy użytkownika.	Nr
└prefix_padding_ms	liczba całkowita	Ilość dźwięku do uwzględnienia przed wykryciem mowy vaD (w milisekundach). Wartość domyślna to 300 ms.	Nr
└silence_duration_ms	liczba całkowita	Czas trwania ciszy wykrywania zatrzymania mowy (w milisekundach). Wartość domyślna to 500 ms. Dzięki krótszym wartościom model będzie reagować szybciej, ale może wskoczyć na krótkie przerwy od użytkownika.	Nr
└* próg	Numer	Próg aktywacji dla usługi VAD (od 0.0 do 1.0) domyślnie wynosi 0,5. Wyższy próg będzie wymagać głośniejszego dźwięku do aktywowania modelu, a tym samym może działać lepiej w hałaśliwych środowiskach.	Nr
└typ	ciąg	Typ wykrywania kolei, jest obecnie obsługiwany tylko server_vad .	Nr

Rozumowanie

Opcje konfiguracji dla modeli rozumowania.

Nazwa	Typ	Opis	Wymagane	Domyślny
nakład pracy	RozumowanieEffort	Ogranicza nakład pracy na rozumowanie modeli rozumowania. Obecnie obsługiwane wartości to low, mediumi high. Zmniejszenie nakładu pracy w zakresie rozumowania może spowodować szybsze reagowanie i mniej tokenów używanych podczas rozumowania w odpowiedzi.	Tak	nośnik
podsumowanie	wyliczenie	Podsumowanie rozumowania wykonywanego przez model. Może to być przydatne do debugowania i zrozumienia procesu rozumowania modelu. Jeden z concise lub detailed. Możliwe wartości: concise, detailed	Nr

ReasoningItem

Opis łańcucha myśli używanego przez model rozumowania podczas generowania odpowiedzi.

Nazwa	Typ	Opis	Wymagane	Domyślny
zawartość	macierz	Rozumowanie zawartości tekstowej.	Tak
Identyfikator	ciąg	Unikatowy identyfikator zawartości rozumowania.	Tak
stan	wyliczenie	Stan elementu. in_progressJeden z , completedlub incomplete. Wypełniane, gdy elementy są zwracane za pośrednictwem interfejsu API. Możliwe wartości: in_progress, , completedincomplete	Nr
typ	wyliczenie	Typ obiektu. Zawsze reasoning. Możliwe wartości: reasoning	Tak

Odmowy

Odmowa od modelu.

Nazwa	Typ	Opis	Wymagane	Domyślny
Odmowy	ciąg	Wyjaśnienie odmowy z modelu.	Tak
typ	wyliczenie	Rodzaj odmowy. Zawsze refusal. Możliwe wartości: refusal	Tak

Odpowiedzi

Nazwa	Typ	Opis	Wymagane	Domyślny
created_at	Numer	Sygnatura czasowa systemu Unix (w sekundach) czasu utworzenia tej odpowiedzi.	Tak
błąd	ResponseError	Obiekt błędu zwracany, gdy model nie może wygenerować odpowiedzi.	Tak
Identyfikator	ciąg	Unikatowy identyfikator tej odpowiedzi.	Tak
incomplete_details	obiekt	Szczegółowe informacje o tym, dlaczego odpowiedź jest niekompletna.	Tak
└* przyczyna	wyliczenie	Powód, dla którego odpowiedź jest niekompletna. Możliwe wartości: max_output_tokens, content_filter	Nr
Instrukcje	ciąg	Wstawia komunikat systemu (lub dewelopera) jako pierwszy element w kontekście modelu. W przypadku używania polecenia wraz z instrukcjami previous_response_idz poprzedniej odpowiedzi nie zostaną przeniesione do następnej odpowiedzi. Ułatwia to zamianę komunikatów systemowych (lub deweloperów) w nowych odpowiedziach.	Tak
max_output_tokens	liczba całkowita	Górna granica liczby tokenów, które można wygenerować dla odpowiedzi, w tym widoczne tokeny wyjściowe i stan konwersacji.	Nr
metadane	Metadanych	Zestaw 16 par klucz-wartość, które można dołączyć do obiektu. Może to być przydatne do przechowywania dodatkowych informacji o obiekcie w formacie ustrukturyzowanym i wykonywania zapytań dotyczących obiektów za pośrednictwem interfejsu API lub pulpitu nawigacyjnego. Klucze to ciągi o maksymalnej długości 64 znaków. Wartości to ciągi o maksymalnej długości 512 znaków.	Tak
model	ciąg	Model używany do generowania odpowiedzi.	Tak
obiekt	wyliczenie	Typ obiektu tego zasobu — zawsze ustawiony na responsewartość . Możliwe wartości: response	Tak
We/Wy	macierz	Tablica elementów zawartości wygenerowanych przez model. — Długość i kolejność elementów w output tablicy zależy od odpowiedzi modelu. — Zamiast uzyskiwać dostęp do pierwszego elementu w output tablicy i zakładając, że jest to komunikat z zawartością wygenerowaną assistant przez model, możesz rozważyć użycie output_text właściwości, która jest obsługiwana w zestawach SDK.	Tak
output_text	ciąg	Właściwość wygody tylko dla zestawu SDK, która zawiera zagregowane dane wyjściowe tekstu ze wszystkich output_text elementów tablicy output , jeśli istnieją. Obsługiwane w zestawach SDK python i JavaScript.	Nr
parallel_tool_calls	Boolean	Czy zezwolić modelowi na równoległe uruchamianie wywołań narzędzi.	Tak	True
previous_response_id	ciąg	Unikatowy identyfikator poprzedniej odpowiedzi na model. Użyj tej funkcji, aby utworzyć konwersacje wieloetowe.	Nr
Rozumowanie	Rozumowanie	Opcje konfiguracji dla modeli rozumowania.	Nr
stan	wyliczenie	Stan generowania odpowiedzi. completedJeden z , failed, in_progresslub incomplete. Możliwe wartości: completed, , failed, in_progressincomplete	Nr
Temperatury	Numer	Jaka temperatura próbkowania ma być używana z zakresu od 0 do 2. Wyższe wartości, takie jak 0,8, sprawią, że dane wyjściowe będą bardziej losowe, a niższe wartości, takie jak 0,2, sprawią, że będzie bardziej skoncentrowany i deterministyczny. Ogólnie zalecamy zmianę tego lub top_p nie obu tych elementów.	Tak	1
SMS	obiekt	Opcje konfiguracji odpowiedzi tekstowej z modelu. Może to być zwykły tekst lub dane JSON ze strukturą. Dowiedz się więcej: - wprowadzanie tekstu i dane wyjściowe - Dane wyjściowe ze strukturą	Nr
Format └*	TextResponseFormatConfiguration	Obiekt określający format, który musi zostać wygenerowany przez model. Konfigurowanie { "type": "json_schema" } umożliwia korzystanie ze strukturowych danych wyjściowych, co zapewnia, że model jest zgodny ze podanym schematem JSON. Format domyślny nie ma { "type": "text" } żadnych dodatkowych opcji. Niezalecane w przypadku modeli gpt-4o i nowszych: Ustawienie w celu { "type": "json_object" } włączenia starszego trybu JSON, co gwarantuje, że komunikat generowany przez model jest prawidłowym kodem JSON. Użycie json_schema jest preferowane w przypadku modeli, które go obsługują.	Nr
tool_choice	ToolChoiceOptions lub ToolChoiceTypes lub ToolChoiceFunction	W jaki sposób model powinien wybrać narzędzie (lub narzędzia), które ma być używane podczas generowania odpowiedzi. Zobacz parametr , tools aby zobaczyć, jak określić narzędzia, które może wywołać model.	Tak
Narzędzia	macierz	Tablica narzędzi, które model może wywołać podczas generowania odpowiedzi. Możesz określić, którego narzędzia użyć, ustawiając tool_choice parametr . Dwie kategorie narzędzi, które można podać, to: - Wbudowane narzędzia	Tak
top_p	Numer	Alternatywą dla próbkowania z temperaturą, nazywaną próbkowaniem jądra, gdzie model uwzględnia wyniki tokenów z top_p masą prawdopodobieństwa. Dlatego 0,1 oznacza, że uwzględniane są tylko tokeny składające się z 10 pierwszych% masy prawdopodobieństwa. Ogólnie zalecamy zmianę tego lub temperature nie obu tych elementów.	Tak	1
Obcinania	wyliczenie	Strategia obcinania do użycia dla odpowiedzi modelu. - auto: Jeśli kontekst tej odpowiedzi i poprzednich przekroczy rozmiar okna kontekstu modelu, model obcina odpowiedź, aby dopasować okno kontekstu, upuszczając elementy wejściowe w środku konwersacji. - disabled (ustawienie domyślne): Jeśli odpowiedź modelu przekroczy rozmiar okna kontekstu dla modelu, żądanie zakończy się niepowodzeniem z powodu błędu 400. Możliwe wartości: auto, disabled	Nr
użycie	OdpowiedźUsage	Reprezentuje szczegóły użycia tokenu, w tym tokeny wejściowe, tokeny wyjściowe, podział tokenów wyjściowych i łączną liczbę użytych tokenów.	Nr
użytkownik	ciąg	Unikatowy identyfikator reprezentujący użytkownika końcowego, który może pomóc usłudze OpenAI w monitorowaniu i wykrywaniu nadużyć. .	Nr

ResponseAudioDeltaEvent

Emitowane w przypadku częściowej odpowiedzi audio.

Nazwa	Typ	Opis	Wymagane	Domyślny
Delta	ciąg	Fragment bajtów audio odpowiedzi zakodowanych w formacie Base64.	Tak
typ	wyliczenie	Typ zdarzenia. Zawsze response.audio.delta. Możliwe wartości: response.audio.delta	Tak

ResponseAudioDoneEvent

Emitowane po zakończeniu odpowiedzi audio.

Nazwa	Typ	Opis	Wymagane	Domyślny
typ	wyliczenie	Typ zdarzenia. Zawsze response.audio.done. Możliwe wartości: response.audio.done	Tak

ResponseAudioTranscriptDeltaEvent

Emitowane w przypadku częściowej transkrypcji dźwięku.

Nazwa	Typ	Opis	Wymagane	Domyślny
Delta	ciąg	Częściowa transkrypcja odpowiedzi audio.	Tak
typ	wyliczenie	Typ zdarzenia. Zawsze response.audio.transcript.delta. Możliwe wartości: response.audio.transcript.delta	Tak

ResponseAudioTranscriptDoneEvent

Emitowany po zakończeniu pełnej transkrypcji audio.

Nazwa	Typ	Opis	Wymagane	Domyślny
typ	wyliczenie	Typ zdarzenia. Zawsze response.audio.transcript.done. Możliwe wartości: response.audio.transcript.done	Tak

ResponseCodeInterpreterCallCodeDeltaEvent

Emitowane, gdy fragment kodu jest dodawany przez interpreter kodu.

Nazwa	Typ	Opis	Wymagane	Domyślny
Delta	ciąg	Fragment kodu dodany przez interpreter kodu.	Tak
output_index	liczba całkowita	Indeks elementu wyjściowego, który jest w toku wywołania interpretera kodu.	Tak
typ	wyliczenie	Typ zdarzenia. Zawsze response.code_interpreter_call.code.delta. Możliwe wartości: response.code_interpreter_call.code.delta	Tak

ResponseCodeInterpreterCallCodeDoneEvent

Emitowane, gdy dane wyjściowe fragmentu kodu są finalizowane przez interpreter kodu.

Nazwa	Typ	Opis	Wymagane	Domyślny
kod	ciąg	Końcowe dane wyjściowe fragmentu kodu przez interpreter kodu.	Tak
output_index	liczba całkowita	Indeks elementu wyjściowego, który jest w toku wywołania interpretera kodu.	Tak
typ	wyliczenie	Typ zdarzenia. Zawsze response.code_interpreter_call.code.done. Możliwe wartości: response.code_interpreter_call.code.done	Tak

ResponseCodeInterpreterCallCompletedEvent

Emitowane po zakończeniu wywołania interpretera kodu.

Nazwa	Typ	Opis	Wymagane	Domyślny
code_interpreter_call	CodeInterpreterToolCall	Wywołanie narzędzia w celu uruchomienia kodu.	Tak
output_index	liczba całkowita	Indeks elementu wyjściowego, który jest w toku wywołania interpretera kodu.	Tak
typ	wyliczenie	Typ zdarzenia. Zawsze response.code_interpreter_call.completed. Możliwe wartości: response.code_interpreter_call.completed	Tak

ResponseCodeInterpreterCallInProgressEvent

Emitowane, gdy trwa wywołanie interpretera kodu.

Nazwa	Typ	Opis	Wymagane	Domyślny
code_interpreter_call	CodeInterpreterToolCall	Wywołanie narzędzia w celu uruchomienia kodu.	Tak
output_index	liczba całkowita	Indeks elementu wyjściowego, który jest w toku wywołania interpretera kodu.	Tak
typ	wyliczenie	Typ zdarzenia. Zawsze response.code_interpreter_call.in_progress. Możliwe wartości: response.code_interpreter_call.in_progress	Tak

ResponseCodeInterpreterCallInterpretingEvent

Emitowane, gdy interpreter kodu aktywnie interpretuje fragment kodu.

Nazwa	Typ	Opis	Wymagane	Domyślny
code_interpreter_call	CodeInterpreterToolCall	Wywołanie narzędzia w celu uruchomienia kodu.	Tak
output_index	liczba całkowita	Indeks elementu wyjściowego, który jest w toku wywołania interpretera kodu.	Tak
typ	wyliczenie	Typ zdarzenia. Zawsze response.code_interpreter_call.interpreting. Możliwe wartości: response.code_interpreter_call.interpreting	Tak

ResponseCompletedEvent

Emitowane po zakończeniu odpowiedzi modelu.

Nazwa	Typ	Opis	Wymagane	Domyślny
Odpowiedzi	Odpowiedzi		Tak
typ	wyliczenie	Typ zdarzenia. Zawsze response.completed. Możliwe wartości: response.completed	Tak

ResponseContentPartAddedEvent

Emitowane po dodaniu nowej części zawartości.

Nazwa	Typ	Opis	Wymagane	Domyślny
content_index	liczba całkowita	Indeks dodanej części zawartości.	Tak
item_id	ciąg	Identyfikator elementu wyjściowego, do którego została dodana część zawartości.	Tak
output_index	liczba całkowita	Indeks elementu wyjściowego, do którego została dodana część zawartości.	Tak
Części	OutputContent		Tak
typ	wyliczenie	Typ zdarzenia. Zawsze response.content_part.added. Możliwe wartości: response.content_part.added	Tak

ResponseContentPartDoneEvent

Emitowane po zakończeniu części zawartości.

Nazwa	Typ	Opis	Wymagane	Domyślny
content_index	liczba całkowita	Indeks części zawartości, która jest wykonywana.	Tak
item_id	ciąg	Identyfikator elementu wyjściowego, do którego została dodana część zawartości.	Tak
output_index	liczba całkowita	Indeks elementu wyjściowego, do którego została dodana część zawartości.	Tak
Części	OutputContent		Tak
typ	wyliczenie	Typ zdarzenia. Zawsze response.content_part.done. Możliwe wartości: response.content_part.done	Tak

ResponseCreatedEvent

Zdarzenie emitowane podczas tworzenia odpowiedzi.

Nazwa	Typ	Opis	Wymagane	Domyślny
Odpowiedzi	Odpowiedzi		Tak
typ	wyliczenie	Typ zdarzenia. Zawsze response.created. Możliwe wartości: response.created	Tak

ResponseError

Obiekt błędu zwracany, gdy model nie może wygenerować odpowiedzi.

Nazwa	Typ	Opis	Wymagane	Domyślny
kod	ResponseErrorCode	Kod błędu odpowiedzi.	Tak
komunikat	ciąg	Czytelny dla człowieka opis błędu.	Tak

ResponseErrorCode

Kod błędu odpowiedzi.

Właściwość	Wartość
Opis	Kod błędu odpowiedzi.
Typu	ciąg
Wartości	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

ResponseErrorEvent

Emitowane w przypadku wystąpienia błędu.

Nazwa	Typ	Opis	Wymagane	Domyślny
kod	ciąg	Kod błędu.	Tak
komunikat	ciąg	Komunikat o błędzie.	Tak
Param	ciąg	Parametr błędu.	Tak
typ	wyliczenie	Typ zdarzenia. Zawsze error. Możliwe wartości: error	Tak

ResponseFailedEvent

Zdarzenie emitowane w przypadku niepowodzenia odpowiedzi.

Nazwa	Typ	Opis	Wymagane	Domyślny
Odpowiedzi	Odpowiedzi		Tak
typ	wyliczenie	Typ zdarzenia. Zawsze response.failed. Możliwe wartości: response.failed	Tak

ResponseFileSearchCallCompletedEvent

Emitowane po zakończeniu wywołania wyszukiwania plików (znaleziono wyniki).

Nazwa	Typ	Opis	Wymagane	Domyślny
item_id	ciąg	Identyfikator elementu wyjściowego zainicjowanego przez wywołanie wyszukiwania plików.	Tak
output_index	liczba całkowita	Indeks elementu wyjściowego zainicjowanego przez wywołanie wyszukiwania plików.	Tak
typ	wyliczenie	Typ zdarzenia. Zawsze response.file_search_call.completed. Możliwe wartości: response.file_search_call.completed	Tak

ResponseFileSearchCallInProgressEvent

Emitowane po zainicjowaniu wywołania wyszukiwania plików.

Nazwa	Typ	Opis	Wymagane	Domyślny
item_id	ciąg	Identyfikator elementu wyjściowego zainicjowanego przez wywołanie wyszukiwania plików.	Tak
output_index	liczba całkowita	Indeks elementu wyjściowego zainicjowanego przez wywołanie wyszukiwania plików.	Tak
typ	wyliczenie	Typ zdarzenia. Zawsze response.file_search_call.in_progress. Możliwe wartości: response.file_search_call.in_progress	Tak

ResponseFileSearchCallSearchingEvent

Emitowane, gdy wyszukiwanie plików jest obecnie przeszukiwane.

Nazwa	Typ	Opis	Wymagane	Domyślny
item_id	ciąg	Identyfikator elementu wyjściowego zainicjowanego przez wywołanie wyszukiwania plików.	Tak
output_index	liczba całkowita	Indeks elementu wyjściowego przeszukiwanego przez wywołanie wyszukiwania plików.	Tak
typ	wyliczenie	Typ zdarzenia. Zawsze response.file_search_call.searching. Możliwe wartości: response.file_search_call.searching	Tak

ResponseFunctionCallArgumentsDeltaEvent

Emitowane w przypadku różnicowego wywołania funkcji częściowego.

Nazwa	Typ	Opis	Wymagane	Domyślny
Delta	ciąg	Dodano różnicę argumentów wywołania funkcji.	Tak
item_id	ciąg	Identyfikator elementu wyjściowego, do którego dodano różnicę argumentów wywołania funkcji.	Tak
output_index	liczba całkowita	Indeks elementu wyjściowego, do którego dodano różnicę argumentów wywołania funkcji.	Tak
typ	wyliczenie	Typ zdarzenia. Zawsze response.function_call_arguments.delta. Możliwe wartości: response.function_call_arguments.delta	Tak

ResponseFunctionCallArgumentsDoneEvent

Emitowane, gdy argumenty wywołania funkcji są finalizowane.

Nazwa	Typ	Opis	Wymagane	Domyślny
Argumenty	ciąg	Argumenty wywołania funkcji.	Tak
item_id	ciąg	Identyfikator elementu.	Tak
output_index	liczba całkowita	Indeks elementu wyjściowego.	Tak
typ	wyliczenie	Możliwe wartości: response.function_call_arguments.done	Tak

ResponseInProgressEvent

Emitowane, gdy odpowiedź jest w toku.

Nazwa	Typ	Opis	Wymagane	Domyślny
Odpowiedzi	Odpowiedzi		Tak
typ	wyliczenie	Typ zdarzenia. Zawsze response.in_progress. Możliwe wartości: response.in_progress	Tak

ResponseIncompleteEvent

Zdarzenie emitowane po zakończeniu odpowiedzi jako niekompletne.

Nazwa	Typ	Opis	Wymagane	Domyślny
Odpowiedzi	Odpowiedzi		Tak
typ	wyliczenie	Typ zdarzenia. Zawsze response.incomplete. Możliwe wartości: response.incomplete	Tak

responseItemList

Lista elementów odpowiedzi.

Nazwa	Typ	Opis	Wymagane	Domyślny
dane	macierz	Lista elementów używanych do wygenerowania tej odpowiedzi.	Tak
first_id	ciąg	Identyfikator pierwszego elementu na liście.	Tak
has_more	Boolean	Niezależnie od tego, czy jest dostępnych więcej elementów.	Tak
last_id	ciąg	Identyfikator ostatniego elementu na liście.	Tak
obiekt	wyliczenie	Zwracany typ obiektu musi mieć wartość list. Możliwe wartości: list	Tak

OdpowiedźModalności

Typy danych wyjściowych, które mają być generowane przez model. Większość modeli jest w stanie wygenerować tekst, co jest wartością domyślną:

["text"]

Model gpt-4o-audio-preview może również służyć do generowania dźwięku. Aby zażądać, aby ten model wygenerował odpowiedzi tekstowe i audio, możesz użyć:

["text", "audio"]

Brak zdefiniowanych właściwości dla tego składnika.

ResponseModalitiesTextOnly

Typy danych wyjściowych, które mają być generowane przez model. Większość modeli jest w stanie wygenerować tekst, co jest wartością domyślną:

["text"]

Ten interfejs API wkrótce będzie obsługiwał inne modalności danych wyjściowych, w tym audio i obrazy.

Brak zdefiniowanych właściwości dla tego składnika.

ResponseOutputItemAddedEvent

Emitowane po dodaniu nowego elementu wyjściowego.

Nazwa	Typ	Opis	Wymagane	Domyślny
element	OutputItem		Tak
output_index	liczba całkowita	Indeks dodanego elementu wyjściowego.	Tak
typ	wyliczenie	Typ zdarzenia. Zawsze response.output_item.added. Możliwe wartości: response.output_item.added	Tak

ResponseOutputItemDoneEvent

Emitowane po oznaczeniu elementu wyjściowego.

Nazwa	Typ	Opis	Wymagane	Domyślny
element	OutputItem		Tak
output_index	liczba całkowita	Indeks elementu wyjściowego, który został oznaczony jako wykonany.	Tak
typ	wyliczenie	Typ zdarzenia. Zawsze response.output_item.done. Możliwe wartości: response.output_item.done	Tak

Właściwości odpowiedzi

Nazwa	Typ	Opis	Wymagane	Domyślny
Instrukcje	ciąg	Wstawia komunikat systemu (lub dewelopera) jako pierwszy element w kontekście modelu. W przypadku używania polecenia wraz z instrukcjami previous_response_idz poprzedniej odpowiedzi nie zostaną przeniesione do następnej odpowiedzi. Ułatwia to zamianę komunikatów systemowych (lub deweloperów) w nowych odpowiedziach.	Nr
max_output_tokens	liczba całkowita	Górna granica liczby tokenów, które można wygenerować dla odpowiedzi, w tym widoczne tokeny wyjściowe i stan konwersacji.	Nr
previous_response_id	ciąg	Unikatowy identyfikator poprzedniej odpowiedzi na model. Użyj tej funkcji, aby utworzyć konwersacje wieloetowe.	Nr
Rozumowanie	Rozumowanie	Opcje konfiguracji dla modeli rozumowania.	Nr
SMS	obiekt	Opcje konfiguracji odpowiedzi tekstowej z modelu. Może to być zwykły tekst lub dane JSON ze strukturą. Dowiedz się więcej: - wprowadzanie tekstu i dane wyjściowe - Dane wyjściowe ze strukturą	Nr
Format └*	TextResponseFormatConfiguration	Obiekt określający format, który musi zostać wygenerowany przez model. Konfigurowanie { "type": "json_schema" } umożliwia korzystanie ze strukturowych danych wyjściowych, co zapewnia, że model jest zgodny ze podanym schematem JSON. Format domyślny nie ma { "type": "text" } żadnych dodatkowych opcji. Niezalecane w przypadku modeli gpt-4o i nowszych: Ustawienie w celu { "type": "json_object" } włączenia starszego trybu JSON, co gwarantuje, że komunikat generowany przez model jest prawidłowym kodem JSON. Użycie json_schema jest preferowane w przypadku modeli, które go obsługują.	Nr
tool_choice	ToolChoiceOptions lub ToolChoiceTypes lub ToolChoiceFunction	W jaki sposób model powinien wybrać narzędzie (lub narzędzia), które ma być używane podczas generowania odpowiedzi. Zobacz parametr , tools aby zobaczyć, jak określić narzędzia, które może wywołać model.	Nr
Narzędzia	macierz	Tablica narzędzi, które model może wywołać podczas generowania odpowiedzi. Możesz określić, którego narzędzia użyć, ustawiając tool_choice parametr . Dwie kategorie narzędzi, które można podać, to: - Wbudowane narzędzia	Nr
Obcinania	wyliczenie	Strategia obcinania do użycia dla odpowiedzi modelu. - auto: Jeśli kontekst tej odpowiedzi i poprzednich przekroczy rozmiar okna kontekstu modelu, model obcina odpowiedź, aby dopasować okno kontekstu, upuszczając elementy wejściowe w środku konwersacji. - disabled (ustawienie domyślne): Jeśli odpowiedź modelu przekroczy rozmiar okna kontekstu dla modelu, żądanie zakończy się niepowodzeniem z powodu błędu 400. Możliwe wartości: auto, disabled	Nr

ResponseRefusalDeltaEvent

Emitowane w przypadku częściowego tekstu odmowy.

Nazwa	Typ	Opis	Wymagane	Domyślny
content_index	liczba całkowita	Indeks części zawartości, do którego jest dodawany tekst odmowy.	Tak
Delta	ciąg	Dodany tekst odmowy.	Tak
item_id	ciąg	Identyfikator elementu wyjściowego, do którego jest dodawany tekst odmowy.	Tak
output_index	liczba całkowita	Indeks elementu wyjściowego, do którego jest dodawany tekst odmowy.	Tak
typ	wyliczenie	Typ zdarzenia. Zawsze response.refusal.delta. Możliwe wartości: response.refusal.delta	Tak

ResponseRefusalDoneEvent

Emitowane, gdy tekst odmowy jest sfinalizowany.

Nazwa	Typ	Opis	Wymagane	Domyślny
content_index	liczba całkowita	Indeks części zawartości, że tekst odmowy jest sfinalizowany.	Tak
item_id	ciąg	Identyfikator elementu wyjściowego, który tekst odmowy jest sfinalizowany.	Tak
output_index	liczba całkowita	Indeks elementu wyjściowego, który tekst odmowy jest sfinalizowany.	Tak
Odmowy	ciąg	Tekst odmowy, który jest sfinalizowany.	Tak
typ	wyliczenie	Typ zdarzenia. Zawsze response.refusal.done. Możliwe wartości: response.refusal.done	Tak

responseStreamEvent

Nazwa	Typ	Opis	Wymagane	Domyślny
adnotacja	Adnotacji		Tak
annotation_index	liczba całkowita	Indeks dodanej adnotacji.	Tak
Argumenty	ciąg	Argumenty wywołania funkcji.	Tak
kod	ciąg	Kod błędu.	Tak
code_interpreter_call	CodeInterpreterToolCall	Wywołanie narzędzia w celu uruchomienia kodu.	Tak
content_index	liczba całkowita	Indeks części zawartości, którą sfinalizowana jest zawartość tekstowa.	Tak
Delta	ciąg	Dodano różnicę tekstu.	Tak
element	OutputItem	Element wyjściowy, który został oznaczony jako wykonany.	Tak
item_id	ciąg	Identyfikator elementu wyjściowego, który jest sfinalizowany.	Tak
komunikat	ciąg	Komunikat o błędzie.	Tak
output_index	liczba całkowita	Indeks elementu wyjściowego, który jest sfinalizowany.	Tak
Param	ciąg	Parametr błędu.	Tak
Części	OutputContent	Część zawartości, która jest wykonywana.	Tak
Odmowy	ciąg	Tekst odmowy, który jest sfinalizowany.	Tak
Odpowiedzi	Odpowiedzi	Odpowiedź, która była niekompletna.	Tak
SMS	ciąg	Zawartość tekstowa, która jest sfinalizowana.	Tak
typ	wyliczenie	Typ zdarzenia. Zawsze response.output_text.done. Możliwe wartości: response.output_text.done	Tak

ResponseTextAnnotationDeltaEvent

Emitowane po dodaniu adnotacji tekstowej.

Nazwa	Typ	Opis	Wymagane	Domyślny
adnotacja	Adnotacji		Tak
annotation_index	liczba całkowita	Indeks dodanej adnotacji.	Tak
content_index	liczba całkowita	Indeks części zawartości, do którego dodano adnotację tekstową.	Tak
item_id	ciąg	Identyfikator elementu wyjściowego, do którego dodano adnotację tekstową.	Tak
output_index	liczba całkowita	Indeks elementu wyjściowego, do którego dodano adnotację tekstową.	Tak
typ	wyliczenie	Typ zdarzenia. Zawsze response.output_text.annotation.added. Możliwe wartości: response.output_text.annotation.added	Tak

ResponseTextDeltaEvent

Emitowane w przypadku dodatkowej różnicy tekstu.

Nazwa	Typ	Opis	Wymagane	Domyślny
content_index	liczba całkowita	Indeks części zawartości, do którego dodano różnicę tekstu.	Tak
Delta	ciąg	Dodano różnicę tekstu.	Tak
item_id	ciąg	Identyfikator elementu wyjściowego, do którego dodano różnicę tekstu.	Tak
output_index	liczba całkowita	Indeks elementu wyjściowego, do którego dodano różnicę tekstu.	Tak
typ	wyliczenie	Typ zdarzenia. Zawsze response.output_text.delta. Możliwe wartości: response.output_text.delta	Tak

ResponseTextDoneEvent

Emitowane po sfinalizowaniu zawartości tekstowej.

Nazwa	Typ	Opis	Wymagane	Domyślny
content_index	liczba całkowita	Indeks części zawartości, którą sfinalizowana jest zawartość tekstowa.	Tak
item_id	ciąg	Identyfikator elementu wyjściowego, który jest sfinalizowany.	Tak
output_index	liczba całkowita	Indeks elementu wyjściowego, który jest sfinalizowany.	Tak
SMS	ciąg	Zawartość tekstowa, która jest sfinalizowana.	Tak
typ	wyliczenie	Typ zdarzenia. Zawsze response.output_text.done. Możliwe wartości: response.output_text.done	Tak

OdpowiedźUsage

Reprezentuje szczegóły użycia tokenu, w tym tokeny wejściowe, tokeny wyjściowe, podział tokenów wyjściowych i łączną liczbę użytych tokenów.

Nazwa	Typ	Opis	Wymagane	Domyślny
input_tokens	liczba całkowita	Liczba tokenów wejściowych.	Tak
output_tokens	liczba całkowita	Liczba tokenów wyjściowych.	Tak
output_tokens_details	obiekt	Szczegółowy podział tokenów wyjściowych.	Tak
└reasoning_tokens	liczba całkowita	Liczba tokenów rozumowania.	Nr
total_tokens	liczba całkowita	Całkowita liczba użytych tokenów.	Tak

Zrzut ekranu

Akcja zrzutu ekranu.

Nazwa	Typ	Opis	Wymagane	Domyślny
typ	wyliczenie	Określa typ zdarzenia. W przypadku akcji zrzutu ekranu ta właściwość jest zawsze ustawiona na screenshotwartość . Możliwe wartości: screenshot	Tak

Przewiń

Akcja przewijania.

Nazwa	Typ	Opis	Wymagane	Domyślny
scroll_x	liczba całkowita	Odległość przewijania poziomego.	Tak
scroll_y	liczba całkowita	Odległość przewijania w pionie.	Tak
typ	wyliczenie	Określa typ zdarzenia. W przypadku akcji przewijania ta właściwość jest zawsze ustawiona na scrollwartość . Możliwe wartości: scroll	Tak
X	liczba całkowita	Współrzędna x, w której wystąpiło przewijanie.	Tak
Y	liczba całkowita	Współrzędna y, w której wystąpiło przewijanie.	Tak

StopConfiguration

Maksymalnie 4 sekwencje, w których interfejs API przestaje generować kolejne tokeny. Zwrócony tekst nie będzie zawierać sekwencji zatrzymania.

Ten składnik może być jednym z następujących elementów:

TextResponseFormatConfiguration

Obiekt określający format, który musi zostać wygenerowany przez model.

Konfigurowanie { "type": "json_schema" } umożliwia korzystanie ze strukturowych danych wyjściowych, które zapewniają, że model jest zgodny z podanym schematem JSON.

Format domyślny nie ma { "type": "text" } żadnych dodatkowych opcji.

Niezalecane w przypadku modeli gpt-4o i nowszych:

Ustawienie w celu { "type": "json_object" } włączenia starszego trybu JSON, co gwarantuje, że komunikat generowany przez model jest prawidłowym kodem JSON. Użycie json_schema jest preferowane w przypadku modeli, które go obsługują.

Ten składnik może być jednym z następujących elementów:

• ResponseFormatText
• TextResponseFormatJsonSchema
• ResponseFormatJsonObject

TextResponseFormatJsonSchema

Format odpowiedzi schematu JSON. Służy do generowania ustrukturyzowanych odpowiedzi JSON. Dowiedz się więcej o danych wyjściowych ze strukturą.

Nazwa	Typ	Opis	Wymagane	Domyślny
Opis	ciąg	Opis formatu odpowiedzi używany przez model do określenia sposobu reagowania w formacie.	Nr
Nazwa	ciąg	Nazwa formatu odpowiedzi. Musi być a-z, A-Z, 0-9 lub zawierać podkreślenia i kreski o maksymalnej długości 64.	Nr
schemat	ResponseFormatJsonSchemaSchema	Schemat formatu odpowiedzi, opisany jako obiekt schematu JSON.	Tak
Ścisłe	Boolean	Czy włączyć ścisłe przestrzeganie schematu podczas generowania danych wyjściowych. W przypadku ustawienia wartości true model będzie zawsze przestrzegał dokładnego schematu zdefiniowanego schema w polu. Tylko podzbiór schematu JSON jest obsługiwany, gdy strict ma wartość true.	Nr	False
typ	wyliczenie	Typ zdefiniowanego formatu odpowiedzi. Zawsze json_schema. Możliwe wartości: json_schema	Tak

Narzędzie

Ten składnik może być jednym z następujących elementów:

• FileSearchTool
• FunctionTool
• ComputerTool

ToolChoiceFunction

Użyj tej opcji, aby wymusić wywołanie określonej funkcji przez model.

Nazwa	Typ	Opis	Wymagane	Domyślny
Nazwa	ciąg	Nazwa funkcji do wywołania.	Tak
typ	wyliczenie	W przypadku wywoływania funkcji typ to zawsze function. Możliwe wartości: function	Tak

ToolChoiceOptions

Określa, które narzędzie (jeśli istnieje) jest wywoływane przez model.

none oznacza, że model nie wywoła żadnego narzędzia i zamiast tego generuje komunikat.

auto oznacza, że model może wybierać między generowaniem komunikatu lub wywoływaniem co najmniej jednego narzędzia.

required oznacza, że model musi wywoływać co najmniej jedno narzędzie.

Właściwość	Wartość
Opis	Określa, które narzędzie (jeśli istnieje) jest wywoływane przez model. none oznacza, że model nie wywoła żadnego narzędzia i zamiast tego generuje komunikat. auto oznacza, że model może wybierać między generowaniem komunikatu lub wywoływaniem co najmniej jednego narzędzia. required oznacza, że model musi wywoływać co najmniej jedno narzędzie.
Typu	ciąg
Wartości	none auto required

ToolChoiceTypes

Wskazuje, że model powinien używać wbudowanego narzędzia do generowania odpowiedzi.

Nazwa	Typ	Opis	Wymagane	Domyślny
typ	wyliczenie	Typ hostowanego narzędzia, którego powinien używać model. Dozwolone wartości to: - file_search - computer_use_preview Możliwe wartości: file_search, computer_use_preview	Tak

Typ

Akcja wpisywania tekstu.

Nazwa	Typ	Opis	Wymagane	Domyślny
SMS	ciąg	Tekst do wpisania.	Tak
typ	wyliczenie	Określa typ zdarzenia. W przypadku akcji typu ta właściwość jest zawsze ustawiona na typewartość . Możliwe wartości: type	Tak

UpdateVectorStoreFileAttributesRequest

Nazwa	Typ	Opis	Wymagane	Domyślny
Atrybuty	VectorStoreFileAttributes	Zestaw 16 par klucz-wartość, które można dołączyć do obiektu. Może to być przydatne do przechowywania dodatkowych informacji o obiekcie w formacie ustrukturyzowanym i wykonywania zapytań dotyczących obiektów za pośrednictwem interfejsu API lub pulpitu nawigacyjnego. Klucze to ciągi o maksymalnej długości 64 znaków. Wartości to ciągi o maksymalnej długości 512 znaków, wartości logicznych lub liczb.	Tak

Adres URLCitation

Cytat dotyczący zasobu internetowego używanego do generowania odpowiedzi modelu.

Nazwa	Typ	Opis	Wymagane	Domyślny
end_index	liczba całkowita	Indeks ostatniego znaku cytatu adresu URL w komunikacie.	Tak
start_index	liczba całkowita	Indeks pierwszego znaku cytatu adresu URL w komunikacie.	Tak
Tytuł	ciąg	Tytuł zasobu internetowego.	Tak
typ	wyliczenie	Typ cytatu adresu URL. Zawsze url_citation. Możliwe wartości: url_citation	Tak
Adres url	ciąg	Adres URL zasobu internetowego.	Tak

VectorStoreFileAttributes

Zestaw 16 par klucz-wartość, które można dołączyć do obiektu. Może to być przydatne do przechowywania dodatkowych informacji o obiekcie w formacie ustrukturyzowanym i wykonywania zapytań dotyczących obiektów za pośrednictwem interfejsu API lub pulpitu nawigacyjnego. Klucze to ciągi o maksymalnej długości 64 znaków. Wartości to ciągi o maksymalnej długości 512 znaków, wartości logicznych lub liczb.

Brak zdefiniowanych właściwości dla tego składnika.

VectorStoreFileContentResponse

Reprezentuje przeanalizowaną zawartość pliku magazynu wektorów.

Nazwa	Typ	Opis	Wymagane	Domyślny
dane	macierz	Przeanalizowana zawartość pliku.	Tak
has_more	Boolean	Wskazuje, czy do pobrania jest więcej stron zawartości.	Tak
next_page	ciąg	Token następnej strony, jeśli istnieje.	Tak
obiekt	wyliczenie	Typ obiektu, który jest zawsze vector_store.file_content.page Możliwe wartości: vector_store.file_content.page	Tak

VectorStoreSearchRequest

Nazwa	Typ	Opis	Wymagane	Domyślny
Filtry	Filtr porównawczy lub filtr złożony	Filtr do zastosowania na podstawie atrybutów pliku.	Nr
max_num_results	liczba całkowita	Maksymalna liczba wyników do zwrócenia. Ta liczba powinna należeć do zakresu od 1 do 50 włącznie.	Nr	10
kwerenda	ciąg lub tablica	Ciąg zapytania dla wyszukiwania	Tak
ranking_options	obiekt	Opcje klasyfikacji wyszukiwania.	Nr
└} ranker	wyliczenie	Możliwe wartości: auto, default-2024-11-15	Nr
└score_threshold	Numer		Nr	0
rewrite_query	Boolean	Określa, czy należy ponownie napisać zapytanie języka naturalnego na potrzeby wyszukiwania wektorów.	Nr	False

VectorStoreSearchResultContentObject

Nazwa	Typ	Opis	Wymagane	Domyślny
SMS	ciąg	Zawartość tekstowa zwrócona z wyszukiwania.	Tak
typ	wyliczenie	Typ zawartości. Możliwe wartości: text	Tak

VectorStoreSearchResultItem

Nazwa	Typ	Opis	Wymagane	Domyślny
Atrybuty	VectorStoreFileAttributes	Zestaw 16 par klucz-wartość, które można dołączyć do obiektu. Może to być przydatne do przechowywania dodatkowych informacji o obiekcie w formacie ustrukturyzowanym i wykonywania zapytań dotyczących obiektów za pośrednictwem interfejsu API lub pulpitu nawigacyjnego. Klucze to ciągi o maksymalnej długości 64 znaków. Wartości to ciągi o maksymalnej długości 512 znaków, wartości logicznych lub liczb.	Tak
zawartość	macierz	Fragmenty zawartości z pliku.	Tak
File_id	ciąg	Identyfikator pliku magazynu wektorów.	Tak
Pod nazwą	ciąg	Nazwa pliku magazynu wektorów.	Tak
wynik	Numer	Wynik podobieństwa.	Tak

VectorStoreSearchResultsPage

Nazwa	Typ	Opis	Wymagane	Domyślny
dane	macierz	Lista elementów wyników wyszukiwania.	Tak
has_more	Boolean	Wskazuje, czy istnieje więcej wyników do pobrania.	Tak
next_page	ciąg	Token następnej strony, jeśli istnieje.	Tak
obiekt	wyliczenie	Typ obiektu, który jest zawsze vector_store.search_results.page Możliwe wartości: vector_store.search_results.page	Tak
search_query	macierz		Tak

VoiceIdsShared

Brak zdefiniowanych właściwości dla tego składnika.

Czekać

Akcja oczekiwania.

Nazwa	Typ	Opis	Wymagane	Domyślny
typ	wyliczenie	Określa typ zdarzenia. W przypadku akcji oczekiwania ta właściwość jest zawsze ustawiona na waitwartość . Możliwe wartości: wait	Tak

RozumowanieEffort

Ogranicza nakład pracy na rozumowanie modeli rozumowania. Obecnie obsługiwane wartości to low, mediumi high. Zmniejszenie nakładu pracy w zakresie rozumowania może spowodować szybsze reagowanie i mniej tokenów używanych podczas rozumowania w odpowiedzi.

Właściwość	Wartość
Opis	Ogranicza nakład pracy na rozumowanie modeli rozumowania. Obecnie obsługiwane wartości to low, mediumi high. Zmniejszenie nakładu pracy w zakresie rozumowania może spowodować szybsze reagowanie i mniej tokenów używanych podczas rozumowania w odpowiedzi.
Typu	ciąg
Domyślny	nośnik
Wartości	low medium high

errorEvent

Występuje, gdy wystąpi błąd. Może się to zdarzyć z powodu wewnętrznego błędu serwera lub przekroczenia limitu czasu.

Nazwa	Typ	Opis	Wymagane	Domyślny
dane	Błąd		Tak
wydarzenie	ciąg		Tak

event Enum: ErrorEventEnum

Wartość	Opis
błąd

doneEvent

Występuje po zakończeniu strumienia.

Nazwa	Typ	Opis	Wymagane	Domyślny
dane	ciąg		Tak
wydarzenie	ciąg		Tak

event Enum: DoneEventEnum

Wartość	Opis
Zrobić

data Enum: DoneEventDataEnum

Wartość	Opis
[GOTOWE]

Następne kroki

Dowiedz się więcej o modelach i dostrajaniu za pomocą interfejsu API REST. Dowiedz się więcej o modelach bazowych, które zasilają usługę Azure OpenAI.