Dokumentacja wersji zapoznawczej interfejsu API REST usługi Azure OpenAI w ramach modeli Azure AI Foundry

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 Azure OpenAI oraz interakcja z nimi są podzielone na trzy podstawowe elementy 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 zapoznawcze zwykle podążają za miesięcznym harmonogramem.

Ważne

Teraz dostępny jest nowy interfejs API do 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	2024-06-01-preview	2024-10-01	Pliki specyfikacji	Usługa Azure OpenAI dzieli wspólną płaszczyznę zarządzania ze wszystkimi innymi usługami. Interfejs API płaszczyzny sterowania służy do tworzenia zasobów usługi Azure OpenAI, wdrażania modelu i innych zadań zarządzania zasobami wyższego poziomu. Płaszczyzna sterowania decyduje również o możliwościach wykorzystania takich narzędzi, jak Azure Resource Manager, Bicep, Terraform i Azure CLI.
Płaszczyzna danych — tworzenie	2025-04-01-preview	2024-10-21	Pliki specyfikacji	Interfejs API tworzenia płaszczyzny danych steruje dostrajaniem, przesyłaniem plików, przetwarzaniem danych, procesami wsadowymi i określonymi zapytaniami na poziomie modelu.
Płaszczyzna danych — wnioskowanie	2025-04-01-preview	2024-10-21	Pliki specyfikacji	Interfejs API wnioskowania w płaszczyźnie danych zapewnia możliwości wnioskowania oraz punkty końcowe dla funkcji takich jak kompletności, ukończenie czatu, osadzanie, dźwięk, Twoje dane, DALL-E, asystenci itp.

Uwierzytelnianie

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

• 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 za pomocą parametru api-version zapytania. Wszystkie wersje są zgodne ze strukturą dat RRRR-MM-DD. 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	W	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg znaków URL	Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, np. "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 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
Autoryzacja	Prawda	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://cognitiveservices.azure.com/.default
klucz API	Prawda	ciąg	Tutaj podaj klucz interfejsu API usługi Azure OpenAI

Treść żądania

Typ zawartości: aplikacja/json

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
najlepsze z	liczba całkowita	Generuje uzupełnienia best_of po stronie serwera i zwraca najlepszą (tę z najwyższym logarytmicznym prawdopodobieństwem na token). Nie można przesyłać strumieniowo wyników. W przypadku użycia z n, best_of kontroluje liczbę możliwych uzupełnień, a n określa, ile należy zwrócić – best_of musi być większe niż n. Uwaga: ponieważ ten parametr generuje wiele uzupełnień, może szybko wyczerpać przydział tokenów. Należy ostrożnie używać i upewnić się, że masz odpowiednie ustawienia dla max_tokens i stop.	Nie.	1
echo	typ logiczny (boolowski)	Powtórz ponownie monit oprócz ukończenia	Nie.	Nieprawda
kara za częstotliwość	Liczba	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.	Nie.	0
odchylenie logistyczne	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 tokenizatorze GPT) do odpowiadającej wartości uprzedzenia od -100 do 100. Matematycznie, przesunięcie jest dodawane do logitów wygenerowanych przez model przed próbkowaniem. Dokładny efekt będzie się różnić w zależności od modelu, ale wartości z zakresu od -1 do 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|> .	Nie.	Żaden
logprobs	liczba całkowita	Uwzględnij logarytmiczne prawdopodobieństwa dla logprobs najbardziej prawdopodobnych tokenów wyjściowych oraz wybranych tokenów. Na przykład jeśli logprobs ma wartość 5, interfejs API zwróci listę 5 najbardziej prawdopodobnych tokenów. Interfejs API zawsze zwraca logprob próbkowanego tokenu, więc w odpowiedzi może być maksymalnie logprobs+1 elementów. Maksymalna wartość parametru logprobs to 5.	Nie.	Żaden
maks_tokenów	liczba całkowita	Maksymalna liczba tokenów, które można wygenerować w zakończeniu. Liczba tokenów zapytania plus max_tokens nie może przekraczać długości kontekstu modelu.	Nie.	16
n	liczba całkowita	Ile uzupełnień ma zostać wygenerowanych dla każdego polecenia. Uwaga: ponieważ ten parametr generuje wiele uzupełnień, może szybko wyczerpać przydział tokenów. Należy ostrożnie używać i upewnić się, że masz odpowiednie ustawienia dla max_tokens i stop.	Nie.	1
kara_obecności	Liczba	Liczba z zakresu od -2.0 do 2.0. Dodatnie wartości nakładają karę na nowe tokeny na podstawie tego, czy pojawiają się one w tekście do tej pory, zwiększając prawdopodobieństwo, że model zacznie poruszać nowe tematy.	Nie.	0
monit	ciąg lub tablica	Monity do generowania uzupełnień, zakodowane jako ciąg znaków, tablica ciągów znaków, tablica tokenów lub tablica tablic 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
nasienie	liczba całkowita	Jeśli zostanie określony, nasz system podejmie najlepsze wysiłki, aby próbkować deterministycznie, tak aby powtarzające się żądania z tymi samymi seed parametrami zwracały ten sam wynik. Determinizm nie jest gwarantowany i należy odwołać się do parametru odpowiedzi system_fingerprint w celu monitorowania zmian na serwerze.	Nie.
zatrzymaj	ciąg lub tablica	Maksymalnie 4 sekwencje, w których interfejs API przestanie generować kolejne tokeny. Zwrócony tekst nie będzie zawierać sekwencji zatrzymania.	Nie.
odtwarzać strumieniowo	typ logiczny (boolowski)	Czy należy przesyłać strumieniowo częściowy postęp. W przypadku ustawienia tokeny będą wysyłane jako zdarzenia wysyłane tylko Przykładowy kod języka Python.	Nie.	Nieprawda
przyrostek	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.	Nie.	Żaden
temperatura	Liczba	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ędą bardziej skoncentrowane i deterministyczne. Ogólnie zalecamy zmienić to lub top_p, ale nie obu jednocześnie.	Nie.	1
top_p	Liczba	Alternatywa dla próbkowania z temperaturą, zwana próbkowaniem jądra, gdzie model uwzględnia wyniki tokenów z masą prawdopodobieństwa top_p. Dlatego 0,1 oznacza, że uwzględniane są tylko tokeny znajdujące się w górnych 10% masy prawdopodobieństwa. Ogólnie zalecamy zmienić to lub temperature, ale nie obu jednocześnie.	Nie.	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ć.	Nie.

Odpowiedzi

Kod stanu: 200

Opis: OK

Typ zawartości	Typ	Opis
aplikacja/json	createCompletionResponse

Kod stanu: wartość domyślna

Opis: Usługa niedostępna

Typ zawartości	Typ	Opis
aplikacja/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	W	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg znaków URL	Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, np. "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 modelu, który został wdrożony.
wersja 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
Autoryzacja	Prawda	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://cognitiveservices.azure.com/.default
klucz API	Prawda	ciąg	Tutaj podaj klucz interfejsu API usługi Azure OpenAI

Treść żądania

Typ zawartości: aplikacja/json

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
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.	Nie.
format_kodowania	ciąg	Format, w jakim można zwrócić osadzenia. Może to być wartość float lub base64. Wartość domyślna to float.	Nie.
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 (tokeny 8192 dla text-embedding-ada-002), nie mogą być pustymi ciągami, a każda tablica musi mieć wymiary 2048 lub mniej.	Tak
typ_wprowadzenia	ciąg	typ wyszukiwania osadzania, którego chcesz użyć	Nie.
użytkownik	ciąg	Unikatowy identyfikator reprezentujący użytkownika końcowego, który może pomóc w monitorowaniu i wykrywaniu nadużyć.	Nie.

Odpowiedzi

Kod stanu: 200

Opis: OK

Typ zawartości	Typ	Opis
aplikacja/json	obiekt

Przykłady

Przykład

Zwróć wektory osadzeń dla danego zapytania.

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 uzupełnienie wiadomości na czacie

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg znaków URL	Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, np. "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 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
Autoryzacja	Prawda	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://cognitiveservices.azure.com/.default
klucz API	Prawda	ciąg	Tutaj podaj klucz interfejsu API usługi Azure OpenAI

Treść żądania

Typ zawartości: aplikacja/json

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
dźwięk	obiekt	Parametry dla danych wyjściowych dźwięku. Wymagane przy żądaniu wyjścia audio za użyciem modalities: ["audio"].	Nie.
Format └─	wyliczenie	Określa format dźwięku wyjściowego. Musi być jednym z wav, mp3, flac, opus lub pcm16. Możliwe wartości: wav, , mp3flac, , opuspcm16	Nie.
└─ głos	wyliczenie	Określa typ głosu. Obsługiwane głosy to alloy, echo, fable, onyx, nova i shimmer. Możliwe wartości: alloy, , echofable, onyx, , novashimmer	Nie.
źródła danych	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.	Nie.
kara za częstotliwość	Liczba	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.	Nie.	0
wywołanie_funkcji	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.	Nie.
— funkcje	macierz	Przestarzałe na rzecz tools. Lista funkcji, dla których model może generować dane wejściowe JSON.	Nie.
odchylenie logistyczne	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 skojarzoną wartość stronniczą z zakresu od -100 do 100. Matematycznie, przesunięcie jest dodawane do logitów wygenerowanych przez model przed próbkowaniem. Dokładny efekt będzie się różnić w zależności od modelu, ale wartości z zakresu od -1 do 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.	Nie.	Żaden
logprobs	typ logiczny (boolowski)	Czy zwracać logarytmiczne prawdopodobieństwa dla tokenów wyjściowych, czy nie. Jeśli true, zwraca logarytmiczne prawdopodobieństwa każdego tokenu wyjściowego zwróconego w content elementu message.	Nie.	Nieprawda
max_completion_tokens (maksymalna liczba tokenów zakończenia)	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. Jest to obsługiwane tylko w modelach serii o1. Rozszerzy obsługę innych modeli w przyszłej wersji interfejsu API.	Nie.
maks_tokenów	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.	Nie.
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.	Nie.
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"]	Nie.
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 jako 1 aby zminimalizować koszty.	Nie.	1
wywołania_narzędzia_równoległe	ParallelToolCalls	Czy włączyć równoległe wywoływanie funkcji podczas używania narzędzia.	Nie.	Prawda
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.	Nie.
kara_obecności	Liczba	Liczba z zakresu od -2.0 do 2.0. Dodatnie wartości nakładają karę na nowe tokeny na podstawie tego, czy pojawiają się one w tekście do tej pory, zwiększając prawdopodobieństwo, że model zacznie poruszać nowe tematy.	Nie.	0
wysiłek rozumowania	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	Nie.
format_odpowiedzi	ResponseFormatText lub ResponseFormatJsonObject lub ResponseFormatJsonSchema	Obiekt określający format, który musi zostać wygenerowany przez model. Zgodny z GPT-4o, GPT-4o mini, GPT-4 Turbo oraz wszystkimi modelami GPT-3.5 Turbo nowszymi niż gpt-3.5-turbo-1106. Ustawienie opcji { "type": "json_schema", "json_schema": {...} } aktywuje dane wyjściowe ze struktury, co gwarantuje zgodność modelu z podanym schematem JSON. Ustawienie { "type": "json_object" } włącza tryb JSON, co gwarantuje, że komunikat generowany przez model jest poprawnym 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 oznacza, że generacja przekroczyła max_tokens lub jeśli rozmowa przekroczyła maksymalną długość kontekstu.	Nie.
nasienie	liczba całkowita	Ta funkcja jest dostępna w wersji beta. Jeśli zostanie określony, nasz system podejmie najlepsze wysiłki, aby próbkować deterministycznie, tak aby powtarzające się żądania z tymi samymi seed parametrami zwracały ten sam wynik. Determinizm nie jest gwarantowany i należy odwołać się do parametru odpowiedzi system_fingerprint w celu monitorowania zmian na serwerze.	Nie.
zatrzymaj	ciąg lub tablica	Maksymalnie 4 sekwencje, w których interfejs API przestanie generować kolejne tokeny.	Nie.
przechowywać	typ logiczny (boolowski)	Niezależnie od tego, czy dane wyjściowe tego żądania ukończenia czatu mają być używane w naszych produktach destylacyjnych lub ewaluacyjnych modelu.	Nie.
odtwarzać strumieniowo	typ logiczny (boolowski)	W przypadku ustawienia zostaną wysłane częściowe różnice komunikatów, na przykład w module ChatGPT. Tokeny będą wysyłane jako zdarzenia wysyłane przez serwer, gdy staną się dostępne, a strumień zostanie zakończony komunikatem data: [DONE]. Przykładowy kod języka Python.	Nie.	Nieprawda
opcje transmisji	chatCompletionStreamOptions	Opcje strumieniowania odpowiedzi. Ustaw tę wartość tylko po ustawieniu stream: true.	Nie.	Żaden
temperatura	Liczba	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ędą bardziej skoncentrowane i deterministyczne. Ogólnie zalecamy zmienić to lub top_p, ale nie obu jednocześnie.	Nie.	1
wybór narzędzia	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.	Nie.
narzędzia	macierz	Lista narzędzi, które model może wywołać. 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.	Nie.
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, z których każdy ma skojarzone logarytmiczne prawdopodobieństwo. logprobs musi być ustawione na true, jeśli ten parametr jest używany.	Nie.
top_p	Liczba	Alternatywa dla próbkowania z temperaturą, zwana próbkowaniem jądra, gdzie model uwzględnia wyniki tokenów z masą prawdopodobieństwa top_p. Dlatego 0,1 oznacza, że uwzględniane są tylko tokeny znajdujące się w górnych 10% masy prawdopodobieństwa. Ogólnie zalecamy zmienić to lub temperature, ale nie obu jednocześnie.	Nie.	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ć.	Nie.
kontekst bezpieczeństwa użytkownika	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 o ochronie aplikacji sztucznej inteligencji przy użyciu Microsoft Defender dla Chmury.	Nie.

Odpowiedzi

Kod stanu: 200

Opis: OK

Typ zawartości	Typ	Opis
aplikacja/json	obiekt

Kod stanu: wartość domyślna

Opis: Usługa niedostępna

Typ zawartości	Typ	Opis
aplikacja/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łnienie w oparciu o dane z Azure Search oraz zarządzaną tożsamość przypisaną przez system.

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	W	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg znaków URL	Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, np. "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 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
Autoryzacja	Prawda	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://cognitiveservices.azure.com/.default
klucz API	Prawda	ciąg	Tutaj podaj klucz interfejsu API usługi Azure OpenAI

Treść żądania

Typ zawartości: dane wielu części/formularzu

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
plik	ciąg	Obiekt pliku audio do transkrypcji.	Tak
język	ciąg	Język wejściowego dźwięku. Podanie języka wejściowego w formacie ISO-639-1 poprawi dokładność i opóźnienie.	Nie.
monit	ciąg	Opcjonalny tekst wskazujący styl modelu lub jako kontynuacja poprzedniego segmentu audio. Komunikat powinien być zgodny z językiem dźwięku.	Nie.
format_odpowiedzi	audioResponseFormat	Definiuje format danych wyjściowych.	Nie.
temperatura	Liczba	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ędą bardziej skoncentrowane i deterministyczne. Jeśli ustawiono wartość 0, model użyje logarytmu prawdopodobieństwa, aby automatycznie zwiększyć temperaturę, aż zostaną osiągnięte określone progi.	Nie.	0
granularności_znaczników_czasu[]	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 znaczników czasu segmentu, ale generowanie znaczników czasu dla wyrazów powoduje dodatkowe opóźnienie.	Nie.	odcinek

Odpowiedzi

Kod stanu: 200

Opis: OK

Typ zawartości	Typ	Opis
aplikacja/json	obiekt
tekst/zwykły	ciąg	Transkrybowany tekst w formacie wyjściowym (gdy response_format była jedną z wartości text, vtt lub srt).

Przykłady

Przykład

Pobiera transkrybowany tekst i powiązane metadane z dostarczonych danych dźwiękowych.

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 transkrybowany tekst i powiązane metadane z dostarczonych danych dźwiękowych.

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	W	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg znaków URL	Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, np. "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 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
Autoryzacja	Prawda	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://cognitiveservices.azure.com/.default
klucz API	Prawda	ciąg	Tutaj podaj klucz interfejsu API usługi Azure OpenAI

Treść żądania

Typ zawartości: dane wielu części/formularzu

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
plik	ciąg	Plik audio do tłumaczenia.	Tak
monit	ciąg	Opcjonalny tekst wskazujący styl modelu lub jako kontynuacja poprzedniego segmentu audio. Monit powinien być w języku angielskim.	Nie.
format_odpowiedzi	audioResponseFormat	Definiuje format danych wyjściowych.	Nie.
temperatura	Liczba	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ędą bardziej skoncentrowane i deterministyczne. Jeśli ustawiono wartość 0, model użyje logarytmu prawdopodobieństwa, aby automatycznie zwiększyć temperaturę, aż zostaną osiągnięte określone progi.	Nie.	0

Odpowiedzi

Kod stanu: 200

Opis: OK

Typ zawartości	Typ	Opis
aplikacja/json	obiekt
tekst/zwykły	ciąg	Transkrypcja tekstu w formacie wyjściowym (kiedy response_format był jednym z tekst, 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	W	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg znaków URL	Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, np. "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 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
Autoryzacja	Prawda	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://cognitiveservices.azure.com/.default
klucz API	Prawda	ciąg	Tutaj podaj klucz interfejsu API usługi Azure OpenAI

Treść żądania

Typ zawartości: dane wielu części/formularzu

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
dane wejściowe	ciąg	Tekst do syntezowania dźwięku. Maksymalna długość to 4096 znaków.	Tak
format_odpowiedzi	wyliczenie	Format syntetyzowania dźwięku. Możliwe wartości: mp3, , opusaac, flac, , wavpcm	Nie.
szybkość	Liczba	Szybkość syntetyzowanego dźwięku. Wybierz wartość z 0.25 do 4.0. 1.0 jest wartością domyślną.	Nie.	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	Typ	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 serię obrazów na podstawie opisu tekstowego dla danego wdrożenia modelu DALLE lub gpt-image-1

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg znaków URL	Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, np. "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 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
Autoryzacja	Prawda	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://cognitiveservices.azure.com/.default
klucz API	Prawda	ciąg	Tutaj podaj klucz interfejsu API usługi Azure OpenAI

Treść żądania

Typ zawartości: aplikacja/json

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
tło	imageBackground	Umożliwia ustawienie przezroczystości tła wygenerowanych obrazów. Ten parametr jest obsługiwany tylko w przypadku biblioteki gpt-image-1.	Nie.	samochód
n	liczba całkowita	Liczba obrazów do wygenerowania. Obsługiwane jest tylko n=1 dla dall-e-3.	Nie.	1
kompresja wyjściowa	liczba całkowita	Poziom kompresji (0–100%) dla wygenerowanych obrazów. Ten parametr jest obsługiwany tylko w przypadku biblioteki gpt-image-1 z formatem danych wyjściowych jpeg.	Nie.	100
format_wyjściowy	imagesOutputFormat	Format pliku, w którym są zwracane wygenerowane obrazy. Obsługiwane tylko dla gpt-image-1.	Nie.	png
monit	ciąg	Opis tekstu żądanych obrazów. Maksymalna długość to 32000 znaków dla gpt-image-1 i 4000 znaków dla dall-e-3.	Tak
jakość	imageQuality	Jakość obrazu, który zostanie wygenerowany.	Nie.	samochód
format_odpowiedzi	imagesResponseFormat	Format, w którym są zwracane wygenerowane obrazy.	Nie.	URL
rozmiar	imageSize	Rozmiar wygenerowanych obrazów.	Nie.	samochód
styl	imageStyle	Styl wygenerowanych obrazów. Obsługiwane tylko dla dall-e-3.	Nie.	żywy
użytkownik	ciąg	Unikatowy identyfikator reprezentujący użytkownika końcowego, który może pomóc w monitorowaniu i wykrywaniu nadużyć.	Nie.

Odpowiedzi

Kod stanu: 200

Opis: Ok

Typ zawartości	Typ	Opis
aplikacja/json	generateImagesResponse

Kod stanu: wartość domyślna

Opis: Wystąpił błąd.

Typ zawartości	Typ	Opis
aplikacja/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 tekstowego podpisu w ramach danego wdrożenia modelu gpt-image-1

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg znaków URL	Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, np. "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 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
Autoryzacja	Prawda	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://cognitiveservices.azure.com/.default
klucz API	Prawda	ciąg	Tutaj podaj klucz interfejsu API usługi Azure OpenAI

Treść żądania

Typ zawartości: dane wielu części/formularzu

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
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.	Nie.
n	liczba całkowita	Liczba obrazów do wygenerowania.	Nie.	1
monit	ciąg	Opis tekstu żądanych obrazów. Maksymalna długość to 32000 znaków.	Tak
jakość	imageQuality	Jakość obrazu, który zostanie wygenerowany.	Nie.	samochód
format_odpowiedzi	imagesResponseFormat	Format, w którym są zwracane wygenerowane obrazy.	Nie.	URL
rozmiar	imageSize	Rozmiar wygenerowanych obrazów.	Nie.	samochód
użytkownik	ciąg	Unikatowy identyfikator reprezentujący użytkownika końcowego, który może pomóc w monitorowaniu i wykrywaniu nadużyć.	Nie.

Odpowiedzi

Kod stanu: 200

Opis: Ok

Typ zawartości	Typ	Opis
aplikacja/json	generateImagesResponse

Kod stanu: wartość domyślna

Opis: Wystąpił błąd.

Typ zawartości	Typ	Opis
aplikacja/json	dalleErrorResponse

Lista — Asystenci

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

Zwraca listę asystentów.

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg znaków URL	Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, np. "https://aoairesource.openai.azure.com". Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI). https://{nazwa_zasobu}.openai.azure.com
limit / ograniczenie	kwerenda	Nie.	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	Nie.	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	Nie.	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	Nie.	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 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
Autoryzacja	Prawda	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://cognitiveservices.azure.com/.default
klucz API	Prawda	ciąg	Tutaj podaj klucz interfejsu API usługi Azure OpenAI

Odpowiedzi

Kod stanu: 200

Opis: OK

Typ zawartości	Typ	Opis
aplikacja/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	W	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg znaków URL	Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, np. "https://aoairesource.openai.azure.com". Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI). https://{nazwa_zasobu}.openai.azure.com
wersja 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
Autoryzacja	Prawda	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://cognitiveservices.azure.com/.default
klucz API	Prawda	ciąg	Tutaj podaj klucz interfejsu API usługi Azure OpenAI

Treść żądania

Typ zawartości: aplikacja/json

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
opis	ciąg	Opis asystenta. Maksymalna długość to 512 znaków.	Nie.
instrukcje	ciąg	Instrukcje systemowe używane przez asystenta. Maksymalna długość to 256 000 znaków.	Nie.
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.	Nie.
model	ciąg		Tak
nazwa	ciąg	Nazwa asystenta. Maksymalna długość to 256 znaków.	Nie.
format_odpowiedzi	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 opcji { "type": "json_schema", "json_schema": {...} } umożliwia dane wyjściowe w strukturze, które zapewniają zgodność modelu 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 oznacza, że generacja przekroczyła max_tokens lub jeśli rozmowa przekroczyła maksymalną długość kontekstu.	Nie.
temperatura	Liczba	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ędą bardziej skoncentrowane i deterministyczne.	Nie.	1
zasoby narzędziowe	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.	Nie.
└ code_interpreter	obiekt		Nie.
└ 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.	Nie.	[]
└─ file_search	obiekt		Nie.
└vector_store_ids	macierz	Magazyn wektorów dołączony do tego asystenta. Może istnieć maksymalnie 1 magazyn wektorów dołączony do asystenta.	Nie.
└─ przechowalnie_wektorów	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.	Nie.
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.	Nie.	[]
top_p	Liczba	Alternatywa dla próbkowania z temperaturą, zwana próbkowaniem jądra, gdzie model uwzględnia wyniki tokenów z masą prawdopodobieństwa top_p. Dlatego 0,1 oznacza, że uwzględniane są tylko tokeny znajdujące się w górnych 10% masy prawdopodobieństwa. Ogólnie zalecamy zmianę tej wartości lub temperatury, ale nie obu.	Nie.	1

Odpowiedzi

Kod stanu: 200

Opis: OK

Typ zawartości	Typ	Opis
aplikacja/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	W	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg znaków URL	Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, np. "https://aoairesource.openai.azure.com". Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI). https://{nazwa_zasobu}.openai.azure.com
identyfikator_assistenta	ścieżka	Tak	ciąg	Identyfikator asystenta do pobrania.
wersja 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
Autoryzacja	Prawda	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://cognitiveservices.azure.com/.default
klucz API	Prawda	ciąg	Tutaj podaj klucz interfejsu API usługi Azure OpenAI

Odpowiedzi

Kod stanu: 200

Opis: OK

Typ zawartości	Typ	Opis
aplikacja/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	W	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg znaków URL	Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, np. "https://aoairesource.openai.azure.com". Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI). https://{nazwa_zasobu}.openai.azure.com
identyfikator_assistenta	ścieżka	Tak	ciąg	Identyfikator asystenta, który należy zmodyfikować.
wersja 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
Autoryzacja	Prawda	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://cognitiveservices.azure.com/.default
klucz API	Prawda	ciąg	Tutaj podaj klucz interfejsu API usługi Azure OpenAI

Treść żądania

Typ zawartości: aplikacja/json

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
opis	ciąg	Opis asystenta. Maksymalna długość to 512 znaków.	Nie.
instrukcje	ciąg	Instrukcje systemowe używane przez asystenta. Maksymalna długość to 32768 znaków.	Nie.
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.	Nie.
model	ciąg		Nie.
nazwa	ciąg	Nazwa asystenta. Maksymalna długość to 256 znaków.	Nie.
format_odpowiedzi	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 opcji { "type": "json_schema", "json_schema": {...} } umożliwia dane wyjściowe w strukturze, które zapewniają zgodność modelu 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 oznacza, że generacja przekroczyła max_tokens lub jeśli rozmowa przekroczyła maksymalną długość kontekstu.	Nie.
temperatura	Liczba	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ędą bardziej skoncentrowane i deterministyczne.	Nie.	1
zasoby narzędziowe	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.	Nie.
└ code_interpreter	obiekt		Nie.
└ 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.	Nie.	[]
└─ file_search	obiekt		Nie.
└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.	Nie.
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.	Nie.	[]
top_p	Liczba	Alternatywa dla próbkowania z temperaturą, zwana próbkowaniem jądra, gdzie model uwzględnia wyniki tokenów z masą prawdopodobieństwa top_p. Dlatego 0,1 oznacza, że uwzględniane są tylko tokeny znajdujące się w górnych 10% masy prawdopodobieństwa. Ogólnie zalecamy zmianę tej wartości lub temperatury, ale nie obu.	Nie.	1

Odpowiedzi

Kod stanu: 200

Opis: OK

Typ zawartości	Typ	Opis
aplikacja/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	W	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg znaków URL	Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, np. "https://aoairesource.openai.azure.com". Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI). https://{nazwa_zasobu}.openai.azure.com
identyfikator_assistenta	ścieżka	Tak	ciąg	Identyfikator asystenta do usunięcia.
wersja 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
Autoryzacja	Prawda	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://cognitiveservices.azure.com/.default
klucz API	Prawda	ciąg	Tutaj podaj klucz interfejsu API usługi Azure OpenAI

Odpowiedzi

Kod stanu: 200

Opis: OK

Typ zawartości	Typ	Opis
aplikacja/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

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

Utwórz wątek.

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg znaków URL	Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, np. "https://aoairesource.openai.azure.com". Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI). https://{nazwa_zasobu}.openai.azure.com
wersja 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
Autoryzacja	Prawda	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://cognitiveservices.azure.com/.default
klucz API	Prawda	ciąg	Tutaj podaj klucz interfejsu API usługi Azure OpenAI

Treść żądania

Typ zawartości: aplikacja/json

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
wiadomości	macierz	Lista komunikatów, z których chcesz rozpocząć wątek.	Nie.
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.	Nie.
zasoby narzędziowe	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.	Nie.
└ code_interpreter	obiekt		Nie.
└ 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.	Nie.	[]
└─ file_search	obiekt		Nie.
└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.	Nie.
└─ przechowalnie_wektorów	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.	Nie.

Odpowiedzi

Kod stanu: 200

Opis: OK

Typ zawartości	Typ	Opis
aplikacja/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	W	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg znaków URL	Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, np. "https://aoairesource.openai.azure.com". Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI). https://{nazwa_zasobu}.openai.azure.com
identyfikator_wątku	ścieżka	Tak	ciąg	Identyfikator wątku do pobrania.
wersja 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
Autoryzacja	Prawda	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://cognitiveservices.azure.com/.default
klucz API	Prawda	ciąg	Tutaj podaj klucz interfejsu API usługi Azure OpenAI

Odpowiedzi

Kod stanu: 200

Opis: OK

Typ zawartości	Typ	Opis
aplikacja/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	W	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg znaków URL	Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, np. "https://aoairesource.openai.azure.com". Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI). https://{nazwa_zasobu}.openai.azure.com
identyfikator_wątku	ścieżka	Tak	ciąg	Identyfikator wątku do zmodyfikowania. Można modyfikować tylko metadata.
wersja 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
Autoryzacja	Prawda	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://cognitiveservices.azure.com/.default
klucz API	Prawda	ciąg	Tutaj podaj klucz interfejsu API usługi Azure OpenAI

Treść żądania

Typ zawartości: aplikacja/json

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
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.	Nie.
zasoby narzędziowe	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.	Nie.
└ code_interpreter	obiekt		Nie.
└ 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.	Nie.	[]
└─ file_search	obiekt		Nie.
└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.	Nie.

Odpowiedzi

Kod stanu: 200

Opis: OK

Typ zawartości	Typ	Opis
aplikacja/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	W	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg znaków URL	Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, np. "https://aoairesource.openai.azure.com". Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI). https://{nazwa_zasobu}.openai.azure.com
identyfikator_wątku	ścieżka	Tak	ciąg	Identyfikator wątku do usunięcia.
wersja 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
Autoryzacja	Prawda	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://cognitiveservices.azure.com/.default
klucz API	Prawda	ciąg	Tutaj podaj klucz interfejsu API usługi Azure OpenAI

Odpowiedzi

Kod stanu: 200

Opis: OK

Typ zawartości	Typ	Opis
aplikacja/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

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	W	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg znaków URL	Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, np. "https://aoairesource.openai.azure.com". Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI). https://{nazwa_zasobu}.openai.azure.com
identyfikator_wątku	ścieżka	Tak	ciąg	Identyfikator wątków, do których należą komunikaty.
limit / ograniczenie	kwerenda	Nie.	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	Nie.	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	Nie.	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	Nie.	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.
identyfikator_uruchomienia	kwerenda	Nie.	ciąg	Filtruj komunikaty według identyfikatora przebiegu, który je wygenerował.
wersja 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
Autoryzacja	Prawda	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://cognitiveservices.azure.com/.default
klucz API	Prawda	ciąg	Tutaj podaj klucz interfejsu API usługi Azure OpenAI

Odpowiedzi

Kod stanu: 200

Opis: OK

Typ zawartości	Typ	Opis
aplikacja/json	odpowiedźNaListęWiadomości

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 wiadomość.

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg znaków URL	Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, np. "https://aoairesource.openai.azure.com". Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI). https://{nazwa_zasobu}.openai.azure.com
identyfikator_wątku	ścieżka	Tak	ciąg	Identyfikator wątków, dla których należy utworzyć wiadomość.
wersja 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
Autoryzacja	Prawda	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://cognitiveservices.azure.com/.default
klucz API	Prawda	ciąg	Tutaj podaj klucz interfejsu API usługi Azure OpenAI

Treść żądania

Typ zawartości: aplikacja/json

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
Załączniki	macierz	Lista plików dołączonych do wiadomości oraz narzędzia, do których należy je dodać.	Nie.
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.	Nie.
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	Typ	Opis
aplikacja/json	messageObject

Przykłady

Przykład

Utwórz wiadomość.

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	W	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg znaków URL	Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, np. "https://aoairesource.openai.azure.com". Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI). https://{nazwa_zasobu}.openai.azure.com
identyfikator_wątku	ścieżka	Tak	ciąg	Identyfikator wątków, do których należy ten komunikat.
identyfikator_wiadomości	ścieżka	Tak	ciąg	Identyfikator wiadomości do pobrania.
wersja 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
Autoryzacja	Prawda	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://cognitiveservices.azure.com/.default
klucz API	Prawda	ciąg	Tutaj podaj klucz interfejsu API usługi Azure OpenAI

Odpowiedzi

Kod stanu: 200

Opis: OK

Typ zawartości	Typ	Opis
aplikacja/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	W	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg znaków URL	Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, np. "https://aoairesource.openai.azure.com". Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI). https://{nazwa_zasobu}.openai.azure.com
identyfikator_wątku	ścieżka	Tak	ciąg	Identyfikator wątku, do którego należy ten komunikat.
identyfikator_wiadomości	ścieżka	Tak	ciąg	Identyfikator wiadomości do zmodyfikowania.
wersja 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
Autoryzacja	Prawda	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://cognitiveservices.azure.com/.default
klucz API	Prawda	ciąg	Tutaj podaj klucz interfejsu API usługi Azure OpenAI

Treść żądania

Typ zawartości: aplikacja/json

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
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.	Nie.

Odpowiedzi

Kod stanu: 200

Opis: OK

Typ zawartości	Typ	Opis
aplikacja/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

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	W	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg znaków URL	Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, np. "https://aoairesource.openai.azure.com". Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI). https://{nazwa_zasobu}.openai.azure.com
wersja 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
Autoryzacja	Prawda	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://cognitiveservices.azure.com/.default
klucz API	Prawda	ciąg	Tutaj podaj klucz interfejsu API usługi Azure OpenAI

Treść żądania

Typ zawartości: aplikacja/json

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
identyfikator_assistenta	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.	Nie.
max_completion_tokens (maksymalna liczba tokenów zakończenia)	liczba całkowita	Maksymalna liczba tokenów ukończenia, które mogą być używane w trakcie przebiegu. Uruchomienie zapewni najlepsze wysiłki, aby użyć 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. Aby uzyskać więcej informacji, zobacz incomplete_details.	Nie.
maksymalna liczba tokenów monitu	liczba całkowita	Maksymalna liczba tokenów monitów, które mogą być używane w trakcie przebiegu. Uruchomienie zapewni najlepsze wysiłki, aby użyć tylko liczby określonych tokenów monitu w wielu zakrętach przebiegu. Jeśli przebieg przekroczy określoną liczbę tokenów monitu, przebieg zakończy się stanem incomplete. Aby uzyskać więcej informacji, zobacz incomplete_details.	Nie.
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.	Nie.
model	ciąg	Identyfikator modeli, które mają być wykorzystane do wykonania tego zadania. 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.	Nie.
wywołania_narzędzia_równoległe	ParallelToolCalls	Czy włączyć równoległe wywoływanie funkcji podczas używania narzędzia.	Nie.	Prawda
format_odpowiedzi	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 opcji { "type": "json_schema", "json_schema": {...} } umożliwia dane wyjściowe w strukturze, które zapewniają zgodność modelu 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 oznacza, że generacja przekroczyła max_tokens lub jeśli rozmowa przekroczyła maksymalną długość kontekstu.	Nie.
odtwarzać strumieniowo	typ logiczny (boolowski)	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] .	Nie.
opcje transmisji	chatCompletionStreamOptions	Opcje strumieniowania odpowiedzi. Ustaw tę wartość tylko po ustawieniu stream: true.	Nie.	Żaden
temperatura	Liczba	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ędą bardziej skoncentrowane i deterministyczne.	Nie.	1
konwersacja	createThreadRequest		Nie.
wybór narzędzia	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.	Nie.
zasoby narzędziowe	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.	Nie.
└ code_interpreter	obiekt		Nie.
└ 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.	Nie.	[]
└─ file_search	obiekt		Nie.
└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.	Nie.
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.	Nie.
top_p	Liczba	Alternatywa dla próbkowania z temperaturą, zwana próbkowaniem jądra, gdzie model uwzględnia wyniki tokenów z masą prawdopodobieństwa top_p. Dlatego 0,1 oznacza, że uwzględniane są tylko tokeny znajdujące się w górnych 10% masy prawdopodobieństwa. Ogólnie zalecamy zmianę tej wartości lub temperatury, ale nie obu.	Nie.	1
strategia obcięcia	obcięcie obiektuObject	Określa sposób obcinania wątku przed uruchomieniem. Służy do kontrolowania początkowego okna kontekstu przebiegu.	Nie.

Odpowiedzi

Kod stanu: 200

Opis: OK

Typ zawartości	Typ	Opis
aplikacja/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	W	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg znaków URL	Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, np. "https://aoairesource.openai.azure.com". Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI). https://{nazwa_zasobu}.openai.azure.com
identyfikator_wątku	ścieżka	Tak	ciąg	Identyfikator wątku, do którego należy przebieg.
limit / ograniczenie	kwerenda	Nie.	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	Nie.	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	Nie.	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	Nie.	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 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
Autoryzacja	Prawda	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://cognitiveservices.azure.com/.default
klucz API	Prawda	ciąg	Tutaj podaj klucz interfejsu API usługi Azure OpenAI

Odpowiedzi

Kod stanu: 200

Opis: OK

Typ zawartości	Typ	Opis
aplikacja/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	W	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg znaków URL	Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, np. "https://aoairesource.openai.azure.com". Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI). https://{nazwa_zasobu}.openai.azure.com
identyfikator_wątku	ścieżka	Tak	ciąg	Identyfikator wątku do uruchomienia.
dołącz[]	kwerenda	Nie.	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, aby pobrać zawartość wyników wyszukiwania pliku.
wersja 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
Autoryzacja	Prawda	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://cognitiveservices.azure.com/.default
klucz API	Prawda	ciąg	Tutaj podaj klucz interfejsu API usługi Azure OpenAI

Treść żądania

Typ zawartości: aplikacja/json

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
dodatkowe_instrukcje	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.	Nie.
dodatkowe_wiadomości	macierz	Dodaje dodatkowe komunikaty do wątku przed utworzeniem przebiegu.	Nie.
identyfikator_assistenta	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.	Nie.
max_completion_tokens (maksymalna liczba tokenów zakończenia)	liczba całkowita	Maksymalna liczba tokenów ukończenia, które mogą być używane w trakcie przebiegu. Uruchomienie zapewni najlepsze wysiłki, aby użyć 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. Aby uzyskać więcej informacji, zobacz incomplete_details.	Nie.
maksymalna liczba tokenów monitu	liczba całkowita	Maksymalna liczba tokenów monitów, które mogą być używane w trakcie przebiegu. Uruchomienie zapewni najlepsze wysiłki, aby użyć tylko liczby określonych tokenów monitu w wielu zakrętach przebiegu. Jeśli przebieg przekroczy określoną liczbę tokenów monitu, przebieg zakończy się stanem incomplete. Aby uzyskać więcej informacji, zobacz incomplete_details.	Nie.
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.	Nie.
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.	Nie.
wywołania_narzędzia_równoległe	ParallelToolCalls	Czy włączyć równoległe wywoływanie funkcji podczas używania narzędzia.	Nie.	Prawda
format_odpowiedzi	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 opcji { "type": "json_schema", "json_schema": {...} } umożliwia dane wyjściowe w strukturze, które zapewniają zgodność modelu 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 oznacza, że generacja przekroczyła max_tokens lub jeśli rozmowa przekroczyła maksymalną długość kontekstu.	Nie.
odtwarzać strumieniowo	typ logiczny (boolowski)	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] .	Nie.
temperatura	Liczba	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ędą bardziej skoncentrowane i deterministyczne.	Nie.	1
wybór narzędzia	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.	Nie.
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.	Nie.
top_p	Liczba	Alternatywa dla próbkowania z temperaturą, zwana próbkowaniem jądra, gdzie model uwzględnia wyniki tokenów z masą prawdopodobieństwa top_p. Dlatego 0,1 oznacza, że uwzględniane są tylko tokeny znajdujące się w górnych 10% masy prawdopodobieństwa. Ogólnie zalecamy zmianę tej wartości lub temperatury, ale nie obu.	Nie.	1
strategia obcięcia	obcięcie obiektuObject	Określa sposób obcinania wątku przed uruchomieniem. Służy do kontrolowania początkowego okna kontekstu przebiegu.	Nie.

Odpowiedzi

Kod stanu: 200

Opis: OK

Typ zawartości	Typ	Opis
aplikacja/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	W	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg znaków URL	Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, np. "https://aoairesource.openai.azure.com". Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI). https://{nazwa_zasobu}.openai.azure.com
identyfikator_wątku	ścieżka	Tak	ciąg	Identyfikator uruchomionych wątków.
identyfikator_uruchomienia	ścieżka	Tak	ciąg	Identyfikator przebiegu do pobrania.
wersja 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
Autoryzacja	Prawda	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://cognitiveservices.azure.com/.default
klucz API	Prawda	ciąg	Tutaj podaj klucz interfejsu API usługi Azure OpenAI

Odpowiedzi

Kod stanu: 200

Opis: OK

Typ zawartości	Typ	Opis
aplikacja/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	W	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg znaków URL	Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, np. "https://aoairesource.openai.azure.com". Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI). https://{nazwa_zasobu}.openai.azure.com
identyfikator_wątku	ścieżka	Tak	ciąg	Identyfikator uruchomionych wątków.
identyfikator_uruchomienia	ścieżka	Tak	ciąg	Identyfikator uruchomienia do zmodyfikowania.
wersja 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
Autoryzacja	Prawda	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://cognitiveservices.azure.com/.default
klucz API	Prawda	ciąg	Tutaj podaj klucz interfejsu API usługi Azure OpenAI

Treść żądania

Typ zawartości: aplikacja/json

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
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.	Nie.

Odpowiedzi

Kod stanu: 200

Opis: OK

Typ zawartości	Typ	Opis
aplikacja/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	W	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg znaków URL	Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, np. "https://aoairesource.openai.azure.com". Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI). https://{nazwa_zasobu}.openai.azure.com
identyfikator_wątku	ścieżka	Tak	ciąg	Identyfikator wątków, do których należy to uruchomienie.
identyfikator_uruchomienia	ścieżka	Tak	ciąg	Identyfikator przebiegu, który wymaga przesłania raportu z działania narzędzia.
wersja 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
Autoryzacja	Prawda	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://cognitiveservices.azure.com/.default
klucz API	Prawda	ciąg	Tutaj podaj klucz interfejsu API usługi Azure OpenAI

Treść żądania

Typ zawartości: aplikacja/json

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
odtwarzać strumieniowo	typ logiczny (boolowski)	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] .	Nie.
wyniki_narzędzia	macierz	Lista narzędzi, dla których są przesyłane dane wyjściowe.	Tak

Odpowiedzi

Kod stanu: 200

Opis: OK

Typ zawartości	Typ	Opis
aplikacja/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	W	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg znaków URL	Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, np. "https://aoairesource.openai.azure.com". Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI). https://{nazwa_zasobu}.openai.azure.com
identyfikator_wątku	ścieżka	Tak	ciąg	Identyfikator wątku, do którego należy to uruchomienie.
identyfikator_uruchomienia	ścieżka	Tak	ciąg	Identyfikator uruchomienia do anulowania.
wersja 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
Autoryzacja	Prawda	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://cognitiveservices.azure.com/.default
klucz API	Prawda	ciąg	Tutaj podaj klucz interfejsu API usługi Azure OpenAI

Odpowiedzi

Kod stanu: 200

Opis: OK

Typ zawartości	Typ	Opis
aplikacja/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	W	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg znaków URL	Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, np. "https://aoairesource.openai.azure.com". Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI). https://{nazwa_zasobu}.openai.azure.com
identyfikator_wątku	ścieżka	Tak	ciąg	Identyfikator wątku, do którego należy uruchomienie i kroki uruchamiania.
identyfikator_uruchomienia	ścieżka	Tak	ciąg	Identyfikator przebiegu, do którego należą kroki uruchamiania.
limit / ograniczenie	kwerenda	Nie.	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	Nie.	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	Nie.	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	Nie.	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 API	kwerenda	Tak	ciąg
dołącz[]	kwerenda	Nie.	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, aby pobrać zawartość 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
Autoryzacja	Prawda	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://cognitiveservices.azure.com/.default
klucz API	Prawda	ciąg	Tutaj podaj klucz interfejsu API usługi Azure OpenAI

Odpowiedzi

Kod stanu: 200

Opis: OK

Typ zawartości	Typ	Opis
aplikacja/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	W	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg znaków URL	Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, np. "https://aoairesource.openai.azure.com". Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI). https://{nazwa_zasobu}.openai.azure.com
identyfikator_wątku	ścieżka	Tak	ciąg	Identyfikator wątku, do którego należy uruchomienie i krok uruchomienia.
identyfikator_uruchomienia	ścieżka	Tak	ciąg	Identyfikator przebiegu, do którego należy krok uruchamiania.
step_id	ścieżka	Tak	ciąg	Identyfikator etapu procesu do pobrania.
dołącz[]	kwerenda	Nie.	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, aby pobrać zawartość wyników wyszukiwania pliku.
wersja 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
Autoryzacja	Prawda	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://cognitiveservices.azure.com/.default
klucz API	Prawda	ciąg	Tutaj podaj klucz interfejsu API usługi Azure OpenAI

Odpowiedzi

Kod stanu: 200

Opis: OK

Typ zawartości	Typ	Opis
aplikacja/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	W	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg znaków URL	Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, np. "https://aoairesource.openai.azure.com". Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI). https://{nazwa_zasobu}.openai.azure.com
limit / ograniczenie	kwerenda	Nie.	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	Nie.	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	Nie.	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	Nie.	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 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
Autoryzacja	Prawda	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://cognitiveservices.azure.com/.default
klucz API	Prawda	ciąg	Tutaj podaj klucz interfejsu API usługi Azure OpenAI

Odpowiedzi

Kod stanu: 200

Opis: OK

Typ zawartości	Typ	Opis
aplikacja/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	W	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg znaków URL	Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, np. "https://aoairesource.openai.azure.com". Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI). https://{nazwa_zasobu}.openai.azure.com
wersja 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
Autoryzacja	Prawda	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://cognitiveservices.azure.com/.default
klucz API	Prawda	ciąg	Tutaj podaj klucz interfejsu API usługi Azure OpenAI

Treść żądania

Typ zawartości: aplikacja/json

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
strategia segmentacji	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.	Nie.
wygasa po	vectorStoreExpirationAfter	Zasady wygasania magazynu wektorów.	Nie.
identyfikatory_plików	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.	Nie.
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.	Nie.
nazwa	ciąg	Nazwa magazynu wektorów.	Nie.

Odpowiedzi

Kod stanu: 200

Opis: OK

Typ zawartości	Typ	Opis
aplikacja/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	W	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg znaków URL	Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, np. "https://aoairesource.openai.azure.com". Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI). https://{nazwa_zasobu}.openai.azure.com
identyfikator_magazynu_wektorów	ścieżka	Tak	ciąg	Identyfikator magazynu wektorów do pobrania.
wersja 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
Autoryzacja	Prawda	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://cognitiveservices.azure.com/.default
klucz API	Prawda	ciąg	Tutaj podaj klucz interfejsu API usługi Azure OpenAI

Odpowiedzi

Kod stanu: 200

Opis: OK

Typ zawartości	Typ	Opis
aplikacja/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	W	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg znaków URL	Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, np. "https://aoairesource.openai.azure.com". Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI). https://{nazwa_zasobu}.openai.azure.com
identyfikator_magazynu_wektorów	ścieżka	Tak	ciąg	Identyfikator magazynu wektorów do zmodyfikowania.
wersja 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
Autoryzacja	Prawda	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://cognitiveservices.azure.com/.default
klucz API	Prawda	ciąg	Tutaj podaj klucz interfejsu API usługi Azure OpenAI

Treść żądania

Typ zawartości: aplikacja/json

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
wygasa po	vectorStoreExpirationAfter	Zasady wygasania magazynu wektorów.	Nie.
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.	Nie.
nazwa	ciąg	Nazwa magazynu wektorów.	Nie.

Odpowiedzi

Kod stanu: 200

Opis: OK

Typ zawartości	Typ	Opis
aplikacja/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	W	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg znaków URL	Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, np. "https://aoairesource.openai.azure.com". Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI). https://{nazwa_zasobu}.openai.azure.com
identyfikator_magazynu_wektorów	ścieżka	Tak	ciąg	Identyfikator magazynu wektorów do usunięcia.
wersja 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
Autoryzacja	Prawda	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://cognitiveservices.azure.com/.default
klucz API	Prawda	ciąg	Tutaj podaj klucz interfejsu API usługi Azure OpenAI

Odpowiedzi

Kod stanu: 200

Opis: OK

Typ zawartości	Typ	Opis
aplikacja/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	W	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg znaków URL	Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, np. "https://aoairesource.openai.azure.com". Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI). https://{nazwa_zasobu}.openai.azure.com
identyfikator_magazynu_wektorów	ścieżka	Tak	ciąg	Identyfikator magazynu wektorów, do którego należą pliki.
limit / ograniczenie	kwerenda	Nie.	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	Nie.	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	Nie.	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	Nie.	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	Nie.	ciąg Możliwe wartości: in_progress, , completed, failedcancelled	Filtruj według stanu pliku. Jeden z in_progress, completed, failed, cancelled.
wersja 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
Autoryzacja	Prawda	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://cognitiveservices.azure.com/.default
klucz API	Prawda	ciąg	Tutaj podaj klucz interfejsu API usługi Azure OpenAI

Odpowiedzi

Kod stanu: 200

Opis: OK

Typ zawartości	Typ	Opis
aplikacja/json	odpowiedź listVectorStoreFiles

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	W	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg znaków URL	Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, np. "https://aoairesource.openai.azure.com". Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI). https://{nazwa_zasobu}.openai.azure.com
identyfikator_magazynu_wektorów	ścieżka	Tak	ciąg	Identyfikator magazynu wektorów, dla którego ma zostać utworzony plik.
wersja 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
Autoryzacja	Prawda	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://cognitiveservices.azure.com/.default
klucz API	Prawda	ciąg	Tutaj podaj klucz interfejsu API usługi Azure OpenAI

Treść żądania

Typ zawartości: aplikacja/json

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
strategia segmentacji	fragmentingStrategyRequestParam	Strategia fragmentowania używana do fragmentowania plików. Jeśli nie zostanie ustawiona, użyje auto strategii.	Nie.
identyfikator_pliku	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	Typ	Opis
aplikacja/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	W	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg znaków URL	Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, np. "https://aoairesource.openai.azure.com". Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI). https://{nazwa_zasobu}.openai.azure.com
identyfikator_magazynu_wektorów	ścieżka	Tak	ciąg	Identyfikator magazynu wektorów, do którego należy plik.
identyfikator_pliku	ścieżka	Tak	ciąg	Identyfikator pobieranego pliku.
wersja 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
Autoryzacja	Prawda	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://cognitiveservices.azure.com/.default
klucz API	Prawda	ciąg	Tutaj podaj klucz interfejsu API usługi Azure OpenAI

Odpowiedzi

Kod stanu: 200

Opis: OK

Typ zawartości	Typ	Opis
aplikacja/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	W	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg znaków URL	Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, np. "https://aoairesource.openai.azure.com". Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI). https://{nazwa_zasobu}.openai.azure.com
identyfikator_magazynu_wektorów	ścieżka	Tak	ciąg	Identyfikator magazynu wektorów, do którego należy plik.
identyfikator_pliku	ścieżka	Tak	ciąg	Identyfikator pliku do usunięcia.
wersja 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
Autoryzacja	Prawda	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://cognitiveservices.azure.com/.default
klucz API	Prawda	ciąg	Tutaj podaj klucz interfejsu API usługi Azure OpenAI

Odpowiedzi

Kod stanu: 200

Opis: OK

Typ zawartości	Typ	Opis
aplikacja/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
  }
}

Zaktualizuj atrybuty pliku wektora

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

Zaktualizuj atrybuty w pliku wektorowym.

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg znaków URL	Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, np. "https://aoairesource.openai.azure.com". Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI). https://{nazwa_zasobu}.openai.azure.com
identyfikator_magazynu_wektorów	ścieżka	Tak	ciąg	Identyfikator magazynu wektorów, do którego należy plik.
identyfikator_pliku	ś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
Autoryzacja	Prawda	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://cognitiveservices.azure.com/.default
klucz API	Prawda	ciąg	Tutaj podaj klucz interfejsu API usługi Azure OpenAI

Treść żądania

Typ zawartości: aplikacja/json

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
" is not needed as the current translation is already satisfactory.)	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 logiczne lub liczby.	Tak

Odpowiedzi

Kod stanu: 200

Opis: OK

Typ zawartości	Typ	Opis
aplikacja/json	vectorStoreFileObject

Pobierz zawartość 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 repozytorium wektorów.

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg znaków URL	Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, np. "https://aoairesource.openai.azure.com". Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI). https://{nazwa_zasobu}.openai.azure.com
identyfikator_magazynu_wektorów	ścieżka	Tak	ciąg	Identyfikator magazynu wektorów.
identyfikator_pliku	ścieżka	Tak	ciąg	ID 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
Autoryzacja	Prawda	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://cognitiveservices.azure.com/.default
klucz API	Prawda	ciąg	Tutaj podaj klucz interfejsu API usługi Azure OpenAI

Odpowiedzi

Kod stanu: 200

Opis: OK

Typ zawartości	Typ	Opis
aplikacja/json	VectorStoreFileContentResponse

Repozytorium 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	W	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg znaków URL	Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, np. "https://aoairesource.openai.azure.com". Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI). https://{nazwa_zasobu}.openai.azure.com
identyfikator_magazynu_wektorów	ś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
Autoryzacja	Prawda	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://cognitiveservices.azure.com/.default
klucz API	Prawda	ciąg	Tutaj podaj klucz interfejsu API usługi Azure OpenAI

Treść żądania

Typ zawartości: aplikacja/json

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
filtry	Filtr porównawczy lub filtr złożony	Filtr do zastosowania na podstawie atrybutów pliku.	Nie.
maks_liczba_wyników	liczba całkowita	Maksymalna liczba wyników do zwrócenia. Ta liczba powinna należeć do zakresu od 1 do 50 włącznie.	Nie.	10
kwerenda	ciąg lub tablica	Ciąg zapytania dla wyszukiwania	Tak
opcje rankingu	obiekt	Opcje klasyfikacji wyszukiwania.	Nie.
└─ ranker	wyliczenie	Możliwe wartości: auto, default-2024-11-15	Nie.
└─ próg_punktowy	Liczba		Nie.	0
przepisz_zapytanie	typ logiczny (boolowski)	Określa, czy należy ponownie napisać zapytanie języka naturalnego na potrzeby wyszukiwania wektorów.	Nie.	Nieprawda

Odpowiedzi

Kod stanu: 200

Opis: OK

Typ zawartości	Typ	Opis
aplikacja/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	W	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg znaków URL	Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, np. "https://aoairesource.openai.azure.com". Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI). https://{nazwa_zasobu}.openai.azure.com
identyfikator_magazynu_wektorów	ścieżka	Tak	ciąg	Identyfikator magazynu wektorów, dla którego ma zostać utworzona partia plików.
wersja 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
Autoryzacja	Prawda	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://cognitiveservices.azure.com/.default
klucz API	Prawda	ciąg	Tutaj podaj klucz interfejsu API usługi Azure OpenAI

Treść żądania

Typ zawartości: aplikacja/json

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
strategia segmentacji	fragmentingStrategyRequestParam	Strategia fragmentowania używana do fragmentowania plików. Jeśli nie zostanie ustawiona, użyje auto strategii.	Nie.
identyfikatory_plików	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	Typ	Opis
aplikacja/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	W	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg znaków URL	Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, np. "https://aoairesource.openai.azure.com". Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI). https://{nazwa_zasobu}.openai.azure.com
identyfikator_magazynu_wektorów	ś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 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
Autoryzacja	Prawda	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://cognitiveservices.azure.com/.default
klucz API	Prawda	ciąg	Tutaj podaj klucz interfejsu API usługi Azure OpenAI

Odpowiedzi

Kod stanu: 200

Opis: OK

Typ zawartości	Typ	Opis
aplikacja/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	W	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg znaków URL	Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, np. "https://aoairesource.openai.azure.com". Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI). https://{nazwa_zasobu}.openai.azure.com
identyfikator_magazynu_wektorów	ś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, którą należy anulować.
wersja 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
Autoryzacja	Prawda	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://cognitiveservices.azure.com/.default
klucz API	Prawda	ciąg	Tutaj podaj klucz interfejsu API usługi Azure OpenAI

Odpowiedzi

Kod stanu: 200

Opis: OK

Typ zawartości	Typ	Opis
aplikacja/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	W	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg znaków URL	Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, np. "https://aoairesource.openai.azure.com". Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI). https://{nazwa_zasobu}.openai.azure.com
identyfikator_magazynu_wektorów	ś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 / ograniczenie	kwerenda	Nie.	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	Nie.	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	Nie.	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	Nie.	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	Nie.	ciąg Możliwe wartości: in_progress, , completed, failedcancelled	Filtruj według stanu pliku. Jeden z in_progress, completed, failed, cancelled.
wersja 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
Autoryzacja	Prawda	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://cognitiveservices.azure.com/.default
klucz API	Prawda	ciąg	Tutaj podaj klucz interfejsu API usługi Azure OpenAI

Odpowiedzi

Kod stanu: 200

Opis: OK

Typ zawartości	Typ	Opis
aplikacja/json	odpowiedź listVectorStoreFiles

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 tymczasowy token API do użycia na stronie klienta korzystając z API w czasie rzeczywistym. Można skonfigurować z takimi samymi parametrami sesji, co zdarzenie klienta session.update. Odpowiada obiektem sesji oraz kluczem client_secret, który zawiera tymczasowy token API, umożliwiający uwierzytelnianie klientów przeglądarki w interfejsie API czasu rzeczywistego.

Treść żądania

Typ zawartości: aplikacja/json

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
format_dźwięku_wejściowego	wyliczenie	Format wejściowego dźwięku. Opcje to pcm16, g711_ulawlub g711_alaw. W przypadku pcm16 dźwięk wejściowy musi być w formacie 16-bitowego PCM z częstotliwością próbkowania 24 kHz, z pojedynczym kanałem (mono) i w kolejności bajtów małobitowej. Możliwe wartości: pcm16, , g711_ulawg711_alaw	Nie.
redukcja szumów w sygnale wejściowym audio	obiekt	Konfiguracja redukcji szumu dźwięku wejściowego. Można to ustawić tak, null aby wyłączyć. Filtry redukcji szumów przetwarzają dźwięk dodany do wejściowego bufora audio, zanim zostanie on wysłany do usługi VAD i modelu. Filtrowanie dźwięku może poprawić dokładność wykrywania VAD i zmian (zmniejszając liczbę fałszywie dodatnich wyników) oraz poprawić wydajność modelu poprzez polepszenie postrzegania dźwięku wejściowego.	Nie.
└typ	wyliczenie	Typ redukcji szumu. near_field jest przeznaczony dla mikrofonów kierunkowych, takich jak te w słuchawkach, podczas gdy far_field jest przeznaczony dla mikrofonów dalekiego pola, takich jak te w laptopie lub w salach konferencyjnych. Możliwe wartości: near_field, far_field	Nie.
transkrypcja_audio_wejściowa	obiekt	Konfiguracja transkrypcji dźwięku wejściowego, domyślnie wyłączona i może być ustawiona na null, aby wyłączyć po włączeniu. 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 ma możliwość ustawienia języka oraz wybrania opcji monitowania o transkrypcję, co zapewnia dodatkowe wskazówki dla usługi transkrypcyjnej.	Nie.
└* język	ciąg	Język wejściowego dźwięku. Podanie języka wejściowego w formacie ISO-639-1 (np. en) poprawi dokładność i opóźnienie.	Nie.
└─ model	ciąg	Model do użycia do transkrypcji, bieżące opcje to gpt-4o-transcribe, gpt-4o-mini-transcribei whisper-1.	Nie.
Zachęta └*	ciąg	Opcjonalny tekst wskazujący styl modelu lub jako kontynuacja poprzedniego segmentu audio. W przypadku whisper-1 polecenie to lista słów kluczowych. W przypadku gpt-4o-transcribe modeli instrukcja jest wolnym ciągiem tekstowym, na przykład "oczekuj słów związanych z technologią".	Nie.
instrukcje	ciąg	Domyślne instrukcje systemowe (tj. komunikat systemowy) są poprzedzane wywołaniami modelu. To pole umożliwia klientowi kierowanie odpowiedziami modelu w pożądany sposób. 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 gwarantują, że będą przestrzegane przez model, ale zapewniają przewodnictwo dotyczące pożądanego zachowania modelu. 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.	Nie.
maksymalna_liczba_tokenów_odpowiedzi	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ć liczbę tokenów wyjściowych, lub użyj inf dla maksymalnej liczby dostępnych tokenów dla danego modelu. Wartość domyślna to inf.	Nie.
Sposoby		Zestaw modalności, za pomocą których model może reagować. Aby wyłączyć dźwięk, ustaw wartość ["text"].	Nie.
model	ciąg	Nazwa wdrożenia używanego na potrzeby tej sesji.	Nie.
format_wyjściowy_dźwięku	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	Nie.
temperatura	Liczba	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.	Nie.	0,8
wybór narzędzia	ciąg	W jaki sposób model wybiera narzędzia. Opcje to auto, none, requiredlub określają funkcję.	Nie.	samochód
narzędzia	macierz	Narzędzia (funkcje) dostępne dla modelu.	Nie.
wykrywanie zakrętów	obiekt	Konfiguracja wykrywania zmian, albo Server VAD lub Semantic VAD. Można ustawić to na null aby wyłączyć, co spowoduje, że klient będzie musiał 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 zmiany mówcy (w połączeniu z VAD), aby semantycznie oszacować, czy użytkownik skończył mówić, a następnie dynamicznie określa limit czasu na podstawie tego prawdopodobieństwa. Na przykład, jeśli dźwięk użytkownika zacznie zanikać uhhm, model oceni niskie prawdopodobieństwo zakończenia wypowiedzi i poczeka dłużej na to, aby użytkownik kontynuował mowę. Może to być przydatne w przypadku bardziej naturalnych rozmów, ale może mieć większe opóźnienie.	Nie.
└─ create_response	typ logiczny (boolowski)	Określenie, czy odpowiedź powinna być automatycznie generowana po wystąpieniu zdarzenia zatrzymania VAD.	Nie.	Prawda
└* 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	Nie.
└reakcja_na_przerwanie	typ logiczny (boolowski)	Określa, czy automatycznie przerywać bieżącą odpowiedź na rzecz wyjścia do domyślnej konwersacji (tj. conversation) po wystąpieniu zdarzenia rozpoczęcia VAD (tj. auto).	Nie.	Prawda
└─prefix_padding_ms	liczba całkowita	Używane tylko w server_vad trybie. Ilość dźwięku do uwzględnienia przed wykryciem mowy przez VAD (w milisekundach). Wartość domyślna to 300 ms.	Nie.
└czas_trwania_ciszy_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.	Nie.
└* próg	Liczba	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.	Nie.
└typ	wyliczenie	Typ wykrywania zakrętów. Możliwe wartości: server_vad, semantic_vad	Nie.
głos	VoiceIdsShared		Nie.

Odpowiedzi

Kod stanu: 200

Opis: Sesja została pomyślnie utworzona.

Typ zawartości	Typ	Opis
aplikacja/json	RealtimeSessionCreateResponse

Utwórz — Transkrypcja sesji w czasie rzeczywistym

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

Utwórz tymczasowy token API do używania w aplikacjach klienckich z API czasu rzeczywistego dedykowanym transkrypcjom w czasie rzeczywistym. Można skonfigurować z takimi samymi parametrami sesji, co zdarzenie klienta transcription_session.update. Odpowiada obiektem sesji oraz kluczem client_secret, który zawiera tymczasowy token API, umożliwiający uwierzytelnianie klientów przeglądarki w interfejsie API czasu rzeczywistego.

Treść żądania

Typ zawartości: aplikacja/json

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
zawierać	macierz	Zestaw elementów do uwzględnienia w transkrypcji. Bieżące dostępne elementy to: - item.input_audio_transcription.logprobs	Nie.
format_dźwięku_wejściowego	wyliczenie	Format wejściowego dźwięku. Opcje to pcm16, g711_ulawlub g711_alaw. W przypadku pcm16 dźwięk wejściowy musi być w formacie 16-bitowego PCM z częstotliwością próbkowania 24 kHz, z pojedynczym kanałem (mono) i w kolejności bajtów małobitowej. Możliwe wartości: pcm16, , g711_ulawg711_alaw	Nie.
redukcja szumów w sygnale wejściowym audio	obiekt	Konfiguracja redukcji szumu dźwięku wejściowego. Można to ustawić tak, null aby wyłączyć. Filtry redukcji szumów przetwarzają dźwięk dodany do wejściowego bufora audio, zanim zostanie on wysłany do usługi VAD i modelu. Filtrowanie dźwięku może poprawić dokładność wykrywania VAD i zmian (zmniejszając liczbę fałszywie dodatnich wyników) oraz poprawić wydajność modelu poprzez polepszenie postrzegania dźwięku wejściowego.	Nie.
└typ	wyliczenie	Typ redukcji szumu. near_field jest przeznaczony dla mikrofonów kierunkowych, takich jak te w słuchawkach, podczas gdy far_field jest przeznaczony dla mikrofonów dalekiego pola, takich jak te w laptopie lub w salach konferencyjnych. Możliwe wartości: near_field, far_field	Nie.
transkrypcja_audio_wejściowa	obiekt	Konfiguracja transkrypcji dźwięku wejściowego. Klient ma możliwość ustawienia języka oraz wybrania opcji monitowania o transkrypcję, co zapewnia dodatkowe wskazówki dla usługi transkrypcyjnej.	Nie.
└* język	ciąg	Język wejściowego dźwięku. Podanie języka wejściowego w formacie ISO-639-1 (np. en) poprawi dokładność i opóźnienie.	Nie.
└─ model	wyliczenie	Model do użycia do transkrypcji, bieżące opcje to gpt-4o-transcribe, gpt-4o-mini-transcribei whisper-1. Możliwe wartości: gpt-4o-transcribe, , gpt-4o-mini-transcribewhisper-1	Nie.
Zachęta └*	ciąg	Opcjonalny tekst wskazujący styl modelu lub jako kontynuacja poprzedniego segmentu audio. W przypadku whisper-1 polecenie to lista słów kluczowych. W przypadku gpt-4o-transcribe modeli instrukcja jest wolnym ciągiem tekstowym, na przykład "oczekuj słów związanych z technologią".	Nie.
Sposoby		Zestaw modalności, za pomocą których model może reagować. Aby wyłączyć dźwięk, ustaw wartość ["text"].	Nie.
wykrywanie zakrętów	obiekt	Konfiguracja wykrywania zmian, albo Server VAD lub Semantic VAD. Można ustawić to na null aby wyłączyć, co spowoduje, że klient będzie musiał 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 zmiany mówcy (w połączeniu z VAD), aby semantycznie oszacować, czy użytkownik skończył mówić, a następnie dynamicznie określa limit czasu na podstawie tego prawdopodobieństwa. Na przykład, jeśli dźwięk użytkownika zacznie zanikać uhhm, model oceni niskie prawdopodobieństwo zakończenia wypowiedzi i poczeka dłużej na to, aby użytkownik kontynuował mowę. Może to być przydatne w przypadku bardziej naturalnych rozmów, ale może mieć większe opóźnienie.	Nie.
└─ create_response	typ logiczny (boolowski)	Określenie, czy odpowiedź powinna być automatycznie generowana po wystąpieniu zdarzenia zatrzymania VAD. Niedostępne dla sesji transkrypcji.	Nie.	Prawda
└* 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	Nie.
└reakcja_na_przerwanie	typ logiczny (boolowski)	Określa, czy automatycznie przerywać bieżącą odpowiedź na rzecz wyjścia do domyślnej konwersacji (tj. conversation) po wystąpieniu zdarzenia rozpoczęcia VAD (tj. auto). Niedostępne dla sesji transkrypcji.	Nie.	Prawda
└─prefix_padding_ms	liczba całkowita	Używane tylko w server_vad trybie. Ilość dźwięku do uwzględnienia przed wykryciem mowy przez VAD (w milisekundach). Wartość domyślna to 300 ms.	Nie.
└czas_trwania_ciszy_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.	Nie.
└* próg	Liczba	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.	Nie.
└typ	wyliczenie	Typ wykrywania zakrętów. Możliwe wartości: server_vad, semantic_vad	Nie.

Odpowiedzi

Kod stanu: 200

Opis: Sesja została pomyślnie utworzona.

Typ zawartości	Typ	Opis
aplikacja/json	RealtimeTranscriptionSessionCreateResponse

Odpowiedzi

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

Tworzy odpowiedź modelu.

Treść żądania

Typ zawartości: aplikacja/json

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
zawierać	macierz		Nie.
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. Podczas używania previous_response_id, instrukcje z poprzedniej odpowiedzi nie zostaną przeniesione do następnej odpowiedzi. Ułatwia proste wymienianie komunikatów systemowych lub komunikatów od deweloperów w nowych odpowiedziach.	Nie.
max_output_tokens (maksymalna liczba tokenów wyjściowych)	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.	Nie.
wywołania_narzędzia_równoległe	typ logiczny (boolowski)	Czy zezwolić modelowi na równoległe uruchamianie wywołań narzędzi.	Nie.	Prawda
previous_response_id (identyfikator_poprzedniej_odpowiedzi)	ciąg	Unikatowy identyfikator poprzedniej odpowiedzi na model. Użyj tego, aby utworzyć wielokrotne konwersacje. Dowiedz się więcej o stanie konwersacji.	Nie.
Rozumowanie	Rozumowanie	Tylko modele serii o Opcje konfiguracji dla modeli rozumowania.	Nie.
przechowywać	typ logiczny (boolowski)	Określa, czy przechowywać wygenerowaną odpowiedź modelu na potrzeby późniejszego pobierania za pośrednictwem interfejsu API.	Nie.	Prawda
odtwarzać strumieniowo	typ logiczny (boolowski)	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.	Nie.	Nieprawda
SMS	obiekt	Opcje konfiguracji generowania odpowiedzi tekstowej przez model. Może to być zwykły tekst lub dane JSON ze strukturą. Więcej informacji: - Wprowadzanie tekstu i dane wyjściowe - Ustrukturyzowane wyniki	Nie.
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 będzie zgodny z podanym schematem JSON. Domyślny format to { "type": "text" } bez żadnych dodatkowych opcji. Niezalecane w przypadku modeli gpt-4o i nowszych: Włączenie trybu { "type": "json_object" } aktywuje starszy tryb 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ą.	Nie.
wybór narzędzia	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.	Nie.
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 modelowi podać, to: - Wbudowane narzędzia: narzędzia dostarczane przez firmę OpenAI, które rozszerzają możliwości modelu	Nie.
Obcięcie	wyliczenie	Strategia obcinania, która ma być użyta 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	Nie.

Odpowiedzi

Kod stanu: 200

Opis: OK

Typ zawartości	Typ	Opis
aplikacja/json	odpowiedź
tekst/strumień zdarzeń	responseStreamEvent

Kod stanu: wartość domyślna

Opis: Usługa niedostępna

Typ zawartości	Typ	Opis
aplikacja/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	W	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg znaków URL	Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, np. "https://aoairesource.openai.azure.com". Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI). https://{nazwa_zasobu}.openai.azure.com
identyfikator_reakcji	ścieżka	Tak	ciąg	Identyfikator odpowiedzi do pobrania.
zawierać	kwerenda	Nie.	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
Autoryzacja	Prawda	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://cognitiveservices.azure.com/.default
klucz API	Prawda	ciąg	Tutaj podaj klucz interfejsu API usługi Azure OpenAI

Odpowiedzi

Kod stanu: 200

Opis: OK

Typ zawartości	Typ	Opis
aplikacja/json	odpowiedź

Kod stanu: wartość domyślna

Opis: Usługa niedostępna

Typ zawartości	Typ	Opis
aplikacja/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	W	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg znaków URL	Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, np. "https://aoairesource.openai.azure.com". Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI). https://{nazwa_zasobu}.openai.azure.com
identyfikator_reakcji	ś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
Autoryzacja	Prawda	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://cognitiveservices.azure.com/.default
klucz API	Prawda	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	Typ	Opis
aplikacja/json	błąd

Kod stanu: wartość domyślna

Opis: Usługa niedostępna

Typ zawartości	Typ	Opis
aplikacja/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	W	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg znaków URL	Obsługiwane punkty końcowe usługi Azure OpenAI (protokół i nazwa hosta, np. "https://aoairesource.openai.azure.com". Zastąp ciąg "aoairesource" nazwą zasobu Azure OpenAI). https://{nazwa_zasobu}.openai.azure.com
identyfikator_reakcji	ścieżka	Tak	ciąg	Identyfikator odpowiedzi, dla której należy pobrać elementy wejściowe.
limit / ograniczenie	kwerenda	Nie.	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	Nie.	ciąg Możliwe wartości: asc, desc	Kolejność przywracania 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	Nie.	ciąg	Identyfikator elementu, po którym wyświetlane są kolejne elementy na liście, używany w stronicowaniu.
przed	kwerenda	Nie.	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
Autoryzacja	Prawda	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://cognitiveservices.azure.com/.default
klucz API	Prawda	ciąg	Tutaj podaj klucz interfejsu API usługi Azure OpenAI

Odpowiedzi

Kod stanu: 200

Opis: OK

Typ zawartości	Typ	Opis
aplikacja/json	responseItemList

Komponenty

odpowiedź na błąd

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
błąd	błąd		Nie.

errorBase

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
kod	ciąg		Nie.
komunikat	ciąg		Nie.

błąd

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
wewnętrzny_błąd	innerError	Wewnętrzny błąd z dodatkowymi szczegółami.	Nie.
Param	ciąg		Nie.
typ	ciąg		Nie.

błąd wewnętrzny

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

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
kod	innerErrorCode	Kody błędów dla obiektu błędu wewnętrznego.	Nie.
wyniki_filtra_treści	contentFilterPromptResults	Informacje o kategorii filtrowania treści (nienawiść, treści seksualne, przemoc, samookaleczenia), jeśli zostały wykryte, a także o poziomie ważności (bardzo niski, niski, średni, wysoki, które określają intensywność i poziom ryzyka szkodliwej zawartości) oraz czy zostały przefiltrowane, 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.	Nie.

kod błędu wewnętrznego

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

Majątek	Wartość
Opis	Kody błędów dla obiektu błędu wewnętrznego.
Typ	ciąg
Wartości	ResponsibleAIPolicyViolation

dalleErrorResponse

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
błąd	dalleError		Nie.

dalleError

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
wewnętrzny_błąd	dalleInnerError	Wewnętrzny błąd z dodatkowymi szczegółami.	Nie.
Param	ciąg		Nie.
typ	ciąg		Nie.

dalleInnerError

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

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
kod	innerErrorCode	Kody błędów dla obiektu błędu wewnętrznego.	Nie.
wyniki_filtra_treści	dalleFilterResults	Informacje o kategorii filtrowania treści (nienawiść, treści seksualne, przemoc, samookaleczenia), jeśli zostały wykryte, a także o poziomie ważności (bardzo niski, niski, średni, wysoki, które określają intensywność i poziom ryzyka szkodliwej zawartości) oraz czy zostały przefiltrowane, 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.	Nie.
(revised_prompt remains unchanged, assuming it is a placeholder requiring no translation or adaptation)	ciąg	Polecenie, które zostało użyte do wygenerowania obrazu, jeśli dokonano jakiejkolwiek poprawki do podpowiedzi.	Nie.

Zakres tekstu ukończenia filtra treści

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

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
przesunięcie_zakończenia_wypełnienia	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 w przypadku niepustych zakresów.	Tak
przesunięcie_początku_ukończenia	liczba całkowita	Przesunięcie punktu kodu UTF32, który rozpoczyna zakres.	Tak

podstawaWynikuFiltraZawartości

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
Filtrowane	typ logiczny (boolowski)		Tak

WynikPoziomuSurowościFiltraTreści

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
Filtrowane	typ logiczny (boolowski)		Tak
dotkliwość	ciąg		Nie.

WykrytoWynikFiltruTreści

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
Wykryte	typ logiczny (boolowski)		Nie.
Filtrowane	typ logiczny (boolowski)		Tak

Filtr treści wykryty z wynikiem cytowania

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
cytat	obiekt		Nie.
└* adres URL	ciąg		Nie.
└─ Licencja	ciąg		Nie.

Wykrycie Filtra Treści z Wynikiem Zakresów Tekstu

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
Szczegóły	macierz		Nie.

wynikIdFiltraTreści

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
Filtrowane	typ logiczny (boolowski)		Tak
id	ciąg		Nie.

PodstawaWynikówFiltraZawartości

Informacje o wynikach filtrowania zawartości.

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
niestandardowe listy blokowania	szczegółoweWynikiFiltruTreści	Wyniki filtrowania zawartości ze szczegółowymi identyfikatorami filtrów zawartości dla filtrowanych segmentów.	Nie.
błąd	errorBase		Nie.
nienawiść	WynikFiltrowaniaZawartościWedługNasilenia		Nie.
wulgaryzm	wynikWykrywaniaFiltruZawartości		Nie.
samookaleczenie	WynikFiltrowaniaZawartościWedługNasilenia		Nie.
seksualny	WynikFiltrowaniaZawartościWedługNasilenia		Nie.
przemoc	WynikFiltrowaniaZawartościWedługNasilenia		Nie.

WynikiMonituFiltracjiTreści

Informacje o kategorii filtrowania treści (nienawiść, treści seksualne, przemoc, samookaleczenia), jeśli zostały wykryte, a także o poziomie ważności (bardzo niski, niski, średni, wysoki, które określają intensywność i poziom ryzyka szkodliwej zawartości) oraz czy zostały przefiltrowane, 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	Wartość domyślna
niestandardowe listy blokowania	szczegółoweWynikiFiltruTreści	Wyniki filtrowania zawartości ze szczegółowymi identyfikatorami filtrów zawartości dla filtrowanych segmentów.	Nie.
błąd	errorBase		Nie.
nienawiść	WynikFiltrowaniaZawartościWedługNasilenia		Nie.
atak pośredni	wynikWykrywaniaFiltruZawartości		Nie.
odblokowanie	wynikWykrywaniaFiltruZawartości		Nie.
wulgaryzm	wynikWykrywaniaFiltruZawartości		Nie.
samookaleczenie	WynikFiltrowaniaZawartościWedługNasilenia		Nie.
seksualny	WynikFiltrowaniaZawartościWedługNasilenia		Nie.
przemoc	WynikFiltrowaniaZawartościWedługNasilenia		Nie.

wynikiWyboruFiltruZawartości

Informacje o kategorii filtrowania treści (nienawiść, treści seksualne, przemoc, samookaleczenia), jeśli zostały wykryte, a także o poziomie ważności (bardzo niski, niski, średni, wysoki, które określają intensywność i poziom ryzyka szkodliwej zawartości) oraz czy zostały przefiltrowane, czy nie. Informacje o tekście pochodzącym od podmiotów trzecich oraz o wulgaryzmach, czy 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	Wartość domyślna
niestandardowe listy blokowania	szczegółoweWynikiFiltruTreści	Wyniki filtrowania zawartości ze szczegółowymi identyfikatorami filtrów zawartości dla filtrowanych segmentów.	Nie.
błąd	errorBase		Nie.
nienawiść	WynikFiltrowaniaZawartościWedługNasilenia		Nie.
wulgaryzm	wynikWykrywaniaFiltruZawartości		Nie.
kod_materiały_chronione	wykryto filtr treści z wynikiem cytowania		Nie.
chroniony_materiał_tekst	wynikWykrywaniaFiltruZawartości		Nie.
samookaleczenie	WynikFiltrowaniaZawartościWedługNasilenia		Nie.
seksualny	WynikFiltrowaniaZawartościWedługNasilenia		Nie.
nieuziemiony materiał	FiltrowanieTreściWykryteZRezultatemFragmentówTekstu		Nie.
przemoc	WynikFiltrowaniaZawartościWedługNasilenia		Nie.

szczegółowe wyniki filtru treści

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

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
Szczegóły	macierz		Nie.
Filtrowane	typ logiczny (boolowski)		Tak

WynikFiltrowaniaPromptu

Wyniki filtrowania treści dla pojedynczego polecenia w żądaniu.

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
wyniki_filtra_treści	contentFilterPromptResults	Informacje o kategorii filtrowania treści (nienawiść, treści seksualne, przemoc, samookaleczenia), jeśli zostały wykryte, a także o poziomie ważności (bardzo niski, niski, średni, wysoki, które określają intensywność i poziom ryzyka szkodliwej zawartości) oraz czy zostały przefiltrowane, 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.	Nie.
indeks_monitu	liczba całkowita		Nie.

pokażWynikiFiltru

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

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

Wyniki Filtra Treści DALL-E

Informacje o wynikach filtrowania zawartości.

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
nienawiść	WynikFiltrowaniaZawartościWedługNasilenia		Nie.
samookaleczenie	WynikFiltrowaniaZawartościWedługNasilenia		Nie.
seksualny	WynikFiltrowaniaZawartościWedługNasilenia		Nie.
przemoc	WynikFiltrowaniaZawartościWedługNasilenia		Nie.

wyniki filtra DALLE

Informacje o kategorii filtrowania treści (nienawiść, treści seksualne, przemoc, samookaleczenia), jeśli zostały wykryte, a także o poziomie ważności (bardzo niski, niski, średni, wysoki, które określają intensywność i poziom ryzyka szkodliwej zawartości) oraz czy zostały przefiltrowane, 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	Wartość domyślna
niestandardowe listy blokowania	szczegółoweWynikiFiltruTreści	Wyniki filtrowania zawartości ze szczegółowymi identyfikatorami filtrów zawartości dla filtrowanych segmentów.	Nie.
nienawiść	WynikFiltrowaniaZawartościWedługNasilenia		Nie.
odblokowanie	wynikWykrywaniaFiltruZawartości		Nie.
wulgaryzm	wynikWykrywaniaFiltruZawartości		Nie.
samookaleczenie	WynikFiltrowaniaZawartościWedługNasilenia		Nie.
seksualny	WynikFiltrowaniaZawartościWedługNasilenia		Nie.
przemoc	WynikFiltrowaniaZawartościWedługNasilenia		Nie.

ŻądanieKończeniaCzatuWspólne

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
kara za częstotliwość	Liczba	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.	Nie.	0
odchylenie logistyczne	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, przesunięcie jest dodawane do logitów wygenerowanych przez model przed próbkowaniem. Dokładny efekt będzie się różnić w zależności od modelu, ale wartości z zakresu od -1 do 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.	Nie.
max_completion_tokens (maksymalna liczba tokenów zakończenia)	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. Jest to obsługiwane tylko w modelach serii o1. Rozszerzy obsługę innych modeli w przyszłej wersji interfejsu API.	Nie.
maks_tokenów	liczba całkowita	Maksymalna liczba tokenów dozwolonych dla wygenerowanej odpowiedzi. Domyślnie liczba tokenów, które model może zwrócić, wynosi (4096 - tokeny podpowiedzi). Nie jest to zgodne z modelami serii o1.	Nie.	4096
metadane	obiekt	Tagi i wartości zdefiniowane przez dewelopera używane do filtrowania uzupełniania na pulpicie nawigacyjnym przechowywanych uzupełniania.	Nie.
kara_obecności	Liczba	Liczba z zakresu od -2.0 do 2.0. Dodatnie wartości nakładają karę na nowe tokeny na podstawie tego, czy pojawiają się one w tekście do tej pory, zwiększając prawdopodobieństwo, że model zacznie poruszać nowe tematy.	Nie.	0
zatrzymaj	ciąg lub tablica	Maksymalnie 4 sekwencje, w których interfejs API przestanie generować kolejne tokeny.	Nie.
przechowywać	typ logiczny (boolowski)	Niezależnie od tego, czy dane wyjściowe tego żądania ukończenia czatu mają być używane w naszych produktach destylacyjnych lub ewaluacyjnych modelu.	Nie.
odtwarzać strumieniowo	typ logiczny (boolowski)	W przypadku ustawienia zostaną wysłane częściowe różnice komunikatów, na przykład w module ChatGPT. Tokeny będą wysyłane jako zdarzenia jednokierunkowe przesyłane do serwera w miarę ich dostępności, a strumień zostanie zakończony komunikatem data: [DONE].	Nie.	Nieprawda
temperatura	Liczba	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ędą bardziej skoncentrowane i deterministyczne. Ogólnie zalecamy zmienić to lub top_p, ale nie obu jednocześnie.	Nie.	1
top_p	Liczba	Alternatywa dla próbkowania z temperaturą, zwana próbkowaniem jądra, gdzie model uwzględnia wyniki tokenów z masą prawdopodobieństwa top_p. Dlatego 0,1 oznacza, że uwzględniane są tylko tokeny znajdujące się w górnych 10% masy prawdopodobieństwa. Ogólnie zalecamy zmienić to lub temperature, ale nie obu jednocześnie.	Nie.	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ć.	Nie.

utwórzŻądanieZakończenia

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
najlepsze z	liczba całkowita	Generuje uzupełnienia best_of po stronie serwera i zwraca najlepszą (tę z najwyższym logarytmicznym prawdopodobieństwem na token). Nie można przesyłać strumieniowo wyników. W przypadku użycia z n, best_of kontroluje liczbę potencjalnych kandydatów do zakończenia, a n określa, ile z nich należy zwrócić. best_of wartość musi być większa niż n. Uwaga: ponieważ ten parametr generuje wiele uzupełnień, może szybko wyczerpać przydział tokenów. Należy ostrożnie używać i upewnić się, że masz odpowiednie ustawienia dla max_tokens i stop.	Nie.	1
echo	typ logiczny (boolowski)	Powtórz ponownie monit oprócz ukończenia	Nie.	Nieprawda
kara za częstotliwość	Liczba	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.	Nie.	0
odchylenie logistyczne	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 tokenizatorze GPT) do odpowiadającej wartości uprzedzenia od -100 do 100. Matematycznie, przesunięcie jest dodawane do logitów wygenerowanych przez model przed próbkowaniem. Dokładny efekt będzie się różnić w zależności od modelu, ale wartości z zakresu od -1 do 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|> .	Nie.	Żaden
logprobs	liczba całkowita	Uwzględnij logarytmiczne prawdopodobieństwa dla logprobs najbardziej prawdopodobnych tokenów wyjściowych oraz wybranych tokenów. Na przykład jeśli logprobs ma wartość 5, interfejs API zwróci listę 5 najbardziej prawdopodobnych tokenów. Interfejs API zawsze zwraca logprob próbkowanego tokenu, więc w odpowiedzi może być maksymalnie logprobs+1 elementów. Maksymalna wartość parametru logprobs to 5.	Nie.	Żaden
maks_tokenów	liczba całkowita	Maksymalna liczba tokenów, które można wygenerować w zakończeniu. Liczba tokenów zapytania plus max_tokens nie może przekraczać długości kontekstu modelu.	Nie.	16
n	liczba całkowita	Ile uzupełnień ma zostać wygenerowanych dla każdego polecenia. Uwaga: ponieważ ten parametr generuje wiele uzupełnień, może szybko wyczerpać przydział tokenów. Należy ostrożnie używać i upewnić się, że masz odpowiednie ustawienia dla max_tokens i stop.	Nie.	1
kara_obecności	Liczba	Liczba z zakresu od -2.0 do 2.0. Dodatnie wartości nakładają karę na nowe tokeny na podstawie tego, czy pojawiają się one w tekście do tej pory, zwiększając prawdopodobieństwo, że model zacznie poruszać nowe tematy.	Nie.	0
monit	ciąg lub tablica	Monity do generowania uzupełnień, zakodowane jako ciąg znaków, tablica ciągów znaków, tablica tokenów lub tablica tablic 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
nasienie	liczba całkowita	Jeśli zostanie określony, nasz system podejmie najlepsze wysiłki, aby próbkować deterministycznie, tak aby powtarzające się żądania z tymi samymi seed parametrami zwracały ten sam wynik. Determinizm nie jest gwarantowany i należy odwołać się do parametru odpowiedzi system_fingerprint w celu monitorowania zmian na serwerze.	Nie.
zatrzymaj	ciąg lub tablica	Maksymalnie 4 sekwencje, w których interfejs API przestanie generować kolejne tokeny. Zwrócony tekst nie będzie zawierać sekwencji zatrzymania.	Nie.
odtwarzać strumieniowo	typ logiczny (boolowski)	Czy należy przesyłać strumieniowo częściowy postęp. W przypadku ustawienia tokeny będą wysyłane jako zdarzenia wysyłane tylko Przykładowy kod języka Python.	Nie.	Nieprawda
przyrostek	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.	Nie.	Żaden
temperatura	Liczba	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ędą bardziej skoncentrowane i deterministyczne. Ogólnie zalecamy zmienić to lub top_p, ale nie obu jednocześnie.	Nie.	1
top_p	Liczba	Alternatywa dla próbkowania z temperaturą, zwana próbkowaniem jądra, gdzie model uwzględnia wyniki tokenów z masą prawdopodobieństwa top_p. Dlatego 0,1 oznacza, że uwzględniane są tylko tokeny znajdujące się w górnych 10% masy prawdopodobieństwa. Ogólnie zalecamy zmienić to lub temperature, ale nie obu jednocześnie.	Nie.	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ć.	Nie.

utwórzOdpowiedźNaUkończenie

Reprezentuje odpowiedź końcową 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	Wartość domyślna
Wyborów	macierz	Lista opcji uzupełniania, które model wygenerował dla promptu wejściowego.	Tak
utworzone	liczba całkowita	Sygnatura czasowa systemu Unix (w sekundach) czasu utworzenia ukończenia.	Tak
id	ciąg	Unikalny identyfikator ukończenia.	Tak
model	ciąg	Model używany do ukończenia.	Tak
obiekt	wyliczenie	Typ obiektu, który jest zawsze „ukończenie_tekstu” Możliwe wartości: text_completion	Tak
wyniki_filtru_poleceń	promptFilterResults	Wyniki filtrowania zawartości dla zera lub większej liczby monitów w żądaniu. W żądaniu przesyłania strumieniowego wyniki dla różnych poleceń mogą pojawiać się o różnych porach lub w różnej kolejności.	Nie.
systemowy odcisk palca	ciąg	Ten odcisk palca reprezentuje zaplecze systemowe, z którym działa model. Można użyć w połączeniu z parametrem żądania seed, aby zrozumieć, kiedy wprowadzono zmiany w back-endzie, które mogą wpływać na deterministyczne działanie.	Nie.
użycie	completionUsage	Statystyki użycia dotyczące żądania zakończenia.	Nie.

UtwórzŻądanieZakończeniaCzatu

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
dźwięk	obiekt	Parametry dla danych wyjściowych dźwięku. Wymagane przy żądaniu wyjścia audio za użyciem modalities: ["audio"].	Nie.
Format └─	wyliczenie	Określa format dźwięku wyjściowego. Musi być jednym z wav, mp3, flac, opus lub pcm16. Możliwe wartości: wav, , mp3flac, , opuspcm16	Nie.
└─ głos	wyliczenie	Określa typ głosu. Obsługiwane głosy to alloy, echo, fable, onyx, nova i shimmer. Możliwe wartości: alloy, , echofable, onyx, , novashimmer	Nie.
źródła danych	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.	Nie.
kara za częstotliwość	Liczba	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.	Nie.	0
wywołanie_funkcji	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.	Nie.
— funkcje	macierz	Przestarzałe na rzecz tools. Lista funkcji, dla których model może generować dane wejściowe JSON.	Nie.
odchylenie logistyczne	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 skojarzoną wartość stronniczą z zakresu od -100 do 100. Matematycznie, przesunięcie jest dodawane do logitów wygenerowanych przez model przed próbkowaniem. Dokładny efekt będzie się różnić w zależności od modelu, ale wartości z zakresu od -1 do 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.	Nie.	Żaden
logprobs	typ logiczny (boolowski)	Czy zwracać logarytmiczne prawdopodobieństwa dla tokenów wyjściowych, czy nie. Jeśli true, zwraca logarytmiczne prawdopodobieństwa każdego tokenu wyjściowego zwróconego w content elementu message.	Nie.	Nieprawda
max_completion_tokens (maksymalna liczba tokenów zakończenia)	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. Jest to obsługiwane tylko w modelach serii o1. Rozszerzy obsługę innych modeli w przyszłej wersji interfejsu API.	Nie.
maks_tokenów	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.	Nie.
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.	Nie.
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"]	Nie.
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 jako 1 aby zminimalizować koszty.	Nie.	1
wywołania_narzędzia_równoległe	ParallelToolCalls	Czy włączyć równoległe wywoływanie funkcji podczas używania narzędzia.	Nie.	Prawda
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.	Nie.
kara_obecności	Liczba	Liczba z zakresu od -2.0 do 2.0. Dodatnie wartości nakładają karę na nowe tokeny na podstawie tego, czy pojawiają się one w tekście do tej pory, zwiększając prawdopodobieństwo, że model zacznie poruszać nowe tematy.	Nie.	0
wysiłek rozumowania	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	Nie.
format_odpowiedzi	ResponseFormatText lub ResponseFormatJsonObject lub ResponseFormatJsonSchema	Obiekt określający format, który musi zostać wygenerowany przez model. Zgodny z GPT-4o, GPT-4o mini, GPT-4 Turbo oraz wszystkimi modelami GPT-3.5 Turbo nowszymi niż gpt-3.5-turbo-1106. Ustawienie opcji { "type": "json_schema", "json_schema": {...} } aktywuje dane wyjściowe ze struktury, co gwarantuje zgodność modelu z podanym schematem JSON. Ustawienie { "type": "json_object" } włącza tryb JSON, co gwarantuje, że komunikat generowany przez model jest poprawnym 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 oznacza, że generacja przekroczyła max_tokens lub jeśli rozmowa przekroczyła maksymalną długość kontekstu.	Nie.
nasienie	liczba całkowita	Ta funkcja jest dostępna w wersji beta. Jeśli zostanie określony, nasz system podejmie najlepsze wysiłki, aby próbkować deterministycznie, tak aby powtarzające się żądania z tymi samymi seed parametrami zwracały ten sam wynik. Determinizm nie jest gwarantowany i należy odwołać się do parametru odpowiedzi system_fingerprint w celu monitorowania zmian na serwerze.	Nie.
zatrzymaj	ciąg lub tablica	Maksymalnie 4 sekwencje, w których interfejs API przestanie generować kolejne tokeny.	Nie.
przechowywać	typ logiczny (boolowski)	Niezależnie od tego, czy dane wyjściowe tego żądania ukończenia czatu mają być używane w naszych produktach destylacyjnych lub ewaluacyjnych modelu.	Nie.
odtwarzać strumieniowo	typ logiczny (boolowski)	W przypadku ustawienia zostaną wysłane częściowe różnice komunikatów, na przykład w module ChatGPT. Tokeny będą wysyłane jako zdarzenia wysyłane przez serwer, gdy staną się dostępne, a strumień zostanie zakończony komunikatem data: [DONE]. Przykładowy kod języka Python.	Nie.	Nieprawda
opcje transmisji	chatCompletionStreamOptions	Opcje strumieniowania odpowiedzi. Ustaw tę wartość tylko po ustawieniu stream: true.	Nie.	Żaden
temperatura	Liczba	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ędą bardziej skoncentrowane i deterministyczne. Ogólnie zalecamy zmienić to lub top_p, ale nie obu jednocześnie.	Nie.	1
wybór narzędzia	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.	Nie.
narzędzia	macierz	Lista narzędzi, które model może wywołać. 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.	Nie.
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, z których każdy ma skojarzone logarytmiczne prawdopodobieństwo. logprobs musi być ustawione na true, jeśli ten parametr jest używany.	Nie.
top_p	Liczba	Alternatywa dla próbkowania z temperaturą, zwana próbkowaniem jądra, gdzie model uwzględnia wyniki tokenów z masą prawdopodobieństwa top_p. Dlatego 0,1 oznacza, że uwzględniane są tylko tokeny znajdujące się w górnych 10% masy prawdopodobieństwa. Ogólnie zalecamy zmienić to lub temperature, ale nie obu jednocześnie.	Nie.	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ć.	Nie.
kontekst bezpieczeństwa użytkownika	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 o ochronie aplikacji sztucznej inteligencji przy użyciu Microsoft Defender dla Chmury.	Nie.

kontekstBezpieczeństwaUżytkownika

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 o ochronie aplikacji sztucznej inteligencji przy użyciu Microsoft Defender dla Chmury.

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
nazwa_aplikacji	ciąg	Nazwa aplikacji. Poufne dane osobowe nie powinny być uwzględniane w tym polu.	Nie.
id_użytkownika_końcowego	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.	Nie.
identyfikator_najemcy_użytkownika_końcowego	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.	Nie.
adres IP źródła	ciąg	Przechwytuje adres IP oryginalnego klienta, akceptując zarówno formatY IPv4, jak i IPv6.	Nie.

funkcjeUkończeniaChatu

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
opis	ciąg	Opis działania funkcji używanej przez model do wyboru, kiedy i jak wywołać funkcję.	Nie.
nazwa	ciąg	Nazwa funkcji do wywołania. Musi składać się z a-z, A-Z, 0-9 lub zawierać podkreślniki i kreski, z maksymalną długością 64 znaków.	Tak
Parametry	Parametry funkcji	Parametry akceptowane przez funkcje, opisane jako obiekt schematu JSON. Zapoznaj się z przewodnikiem w celu poznania przykładów oraz z odniesieniem do schematu JSON dla dokumentacji dotyczącej formatu. Pominięcie parameters definiuje funkcję z pustą listą parametrów.	Nie.

Opcja wywołania funkcji czatu zakończeniowego

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

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
nazwa	ciąg	Nazwa funkcji do wywołania.	Tak

parametryFunkcjiUkończeniaCzatu

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

WiadomośćDeweloperaZapytaniaChatCompletion

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	Wartość domyślna
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.	Nie.
rola	wyliczenie	Rola autora komunikatów, w tym przypadku developer. Możliwe wartości: developer	Tak

Wiadomość systemowa żądania ukończenia czatu

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
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.	Nie.
rola	wyliczenie	Rola autora komunikatów, w tym przypadku system. Możliwe wartości: system	Tak

wiadomośćUżytkownikaŻądaniaZakończeniaCzatu

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
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.	Nie.
rola	wyliczenie	Rola autora komunikatów, w tym przypadku user. Możliwe wartości: user	Tak

wiadomośćAsystentaZwiązanaZProśbąOukończenieCzatu

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
zawartość	ciąg lub tablica	Zawartość komunikatu asystenta. Wymagane, chyba że określono tool_calls lub function_call.	Nie.
wywołanie_funkcji	obiekt	Przestarzałe i zastąpione przez tool_calls. Nazwa i argumenty funkcji, które powinny być wywoływane, generowane przez model.	Nie.
└─ 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.	Nie.
└─ nazwa	ciąg	Nazwa funkcji do wywołania.	Nie.
nazwa	ciąg	Opcjonalna nazwa uczestnika. Zawiera informacje o modelu umożliwiające rozróżnienie między uczestnikami tej samej roli.	Nie.
odmowa	ciąg	Wiadomość o odmowie asystenta.	Nie.
rola	wyliczenie	Rola autora komunikatów, w tym przypadku assistant. Możliwe wartości: assistant	Tak
wywołania_narzędzi	chatCompletionMessageToolCalls	Wywołania narzędzi generowane przez model, takie jak wywołania funkcji.	Nie.

chatCompletionRequestToolMessage

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
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	Wartość domyślna
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

ElementTreściWiadomościDeweloperaŻądaniaUkończeniaCzatu

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

• chatCompletionRequestMessageContentPartText

Żądanie czatuUzupełnienieSystemKomunikatTreśćCzęść

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

• chatCompletionRequestMessageContentPartText

częśćZawartościWiadomościUżytkownikaChatCompletionRequest

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

• chatCompletionRequestMessageContentPartText
• chatCompletionRequestMessageContentPartImage
• chatCompletionRequestMessageContentPartAudio

CzęśćTreściWiadomościAsystentaŻądaniaUkończeniaCzatu

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

• chatCompletionRequestMessageContentPartText
• OdmowaCzęściZawartościŻądaniaChatCompletion

TreśćWiadomościNarzędziaŻądaniaUkończeniaCzatu

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

• chatCompletionRequestMessageContentPartText

zawartośćCzęściWiadomościŻądaniaUkończeniaCzatu

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

zawartośćCzęściWiadomościKomplecjiCzatuAudio

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
wejście_audio	obiekt		Tak
└─ dane	ciąg	Dane audio zakodowane w formacie Base64.	Nie.
Format └─	wyliczenie	Format zakodowanych danych dźwiękowych. Obecnie obsługuje "wav" i "mp3". Możliwe wartości: wav, mp3	Nie.
typ	wyliczenie	Typ części zawartości. Zawsze input_audio. Możliwe wartości: input_audio	Tak

zawartośćObrazuCzęściWiadomościŻądaniaUkończeniaCzatu

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
image_url	obiekt		Tak
└* szczegóły	wyliczenie	Określa poziom szczegółowości obrazu. Dowiedz się więcej w przewodniku Vision. Możliwe wartości: auto, , lowhigh	Nie.
└─ adres URL	ciąg	Adres URL obrazu lub zakodowane w formacie base64 dane obrazu.	Nie.
typ	wyliczenie	Typ części zawartości. Możliwe wartości: image_url	Tak

OdmowaCzęściTreściWiadomościZapytańOCzat

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
odmowa	ciąg	Komunikat o odmowie wygenerowany przez model.	Tak
typ	wyliczenie	Typ części zawartości. Możliwe wartości: refusal	Tak

KonfiguracjaAzureChatExtension

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ń do czatu Azure OpenAI w celu poprawy zachowania odpowiedzi. Użycie tej konfiguracji jest zgodne tylko z usługą Azure OpenAI.

###Discriminator dla azureChatExtensionConfiguration

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

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

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
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ń do czatu Azure OpenAI w celu poprawy zachowania odpowiedzi. Użycie tej konfiguracji jest zgodne tylko z usługą Azure OpenAI.	Tak

Typ rozszerzenia czatu Azure

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ń do czatu Azure OpenAI w celu poprawy zachowania odpowiedzi. Użycie tej konfiguracji jest zgodne tylko z usługą Azure OpenAI.

Majątek	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ń do czatu Azure OpenAI w celu poprawy zachowania odpowiedzi. Użycie tej konfiguracji jest zgodne tylko z usługą Azure OpenAI.
Typ	ciąg
Wartości	azure_search azure_cosmos_db elasticsearch mongo_db pinecone

Konfiguracja rozszerzenia czatu AzureSearch (azureSearchChatExtensionConfiguration)

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

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
Parametry	azureSearchChatExtensionParameters	Parametry usługi Azure Search, gdy są używane jako rozszerzenie czatu usługi Azure OpenAI.	Nie.
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ń do czatu Azure OpenAI w celu poprawy zachowania odpowiedzi. Użycie tej konfiguracji jest zgodne tylko z usługą Azure OpenAI.	Tak

azureSearchChatExtensionParametry

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

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
zezwalaj_na_częściowy_wynik	typ logiczny (boolowski)	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.	Nie.	Nieprawda
uwierzytelnianie	onYourDataApiKeyAuthenticationOptions lub onYourDataSystemAssignedManagedIdentityAuthenticationOptions lub onYourDataUserAssignedManagedIdentityAuthenticationOptions lub onYourDataAccessTokenAuthenticationOptions		Tak
zależność osadzenia	onYourDataEndpointVectorizationSource lub onYourDataDeploymentNameVectorizationSource lub onYourDataIntegratedVectorizationSource		Nie.
punkt końcowy	ciąg	Bezwzględna ścieżka punktu końcowego zasobu usługi Azure Search do użycia.	Tak
mapowanie pól	Opcje Mapowania Pola Indeksu Wyszukiwania Azure	Opcjonalne ustawienia umożliwiające kontrolowanie sposobu przetwarzania pól podczas korzystania ze skonfigurowanego zasobu usługi Azure Search.	Nie.
filtr	ciąg	Filtr wyszukiwania.	Nie.
w zakresie	typ logiczny (boolowski)	Czy zapytania powinny być ograniczone do używania indeksowanych danych.	Nie.
uwzględnij_konteksty	macierz	Uwzględnione właściwości kontekstu wyjściowego. Jeśli nie zostanie określony, wartość domyślna to citations i intent.	Nie.
nazwa_indeksu	ciąg	Nazwa indeksu, który ma być używany jako dostępny w przywoływowanym zasobie usługi Azure Search.	Tak
maks_zapytania_wyszukiwania	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.	Nie.
typ_zapytania	azureSearchQueryType	Typ zapytania wyszukiwania w usłudze Azure Search, który należy wykonać podczas korzystania z niej jako rozszerzenia czatu w usłudze Azure OpenAI.	Nie.
konfiguracja semantyczna	ciąg	Dodatkowa konfiguracja semantyczna zapytania.	Nie.
ścisłość	liczba całkowita	Skonfigurowana dokładność filtrowania istotności wyszukiwania. Im większa jest surowość, tym większa precyzja, ale niższa kompletność odpowiedzi.	Nie.
top_n_documents	liczba całkowita	Skonfigurowana maksymalna liczba dokumentów do wyświetlenia dla skonfigurowanego zapytania.	Nie.

opcjeMapowaniaPólIndeksuAzureSearch

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

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
pola_treści	macierz	Nazwy pól indeksu, które powinny być traktowane jako zawartość.	Nie.
separator_pól_treści	ciąg	Wzorzec separatora, którego powinny używać pola zawartości.	Nie.
pole ścieżki pliku	ciąg	Nazwa pola indeksu do użycia jako ścieżka pliku.	Nie.
pola_wektorowe_obrazu	macierz	Nazwy pól reprezentujących dane wektorów obrazów.	Nie.
pole_tytułu	ciąg	Nazwa pola indeksu, które ma być używane jako tytuł.	Nie.
url_field	ciąg	Nazwa pola indeksu, które ma być używane jako adres URL.	Nie.
pola wektorowe	macierz	Nazwy pól reprezentujących dane wektorowe.	Nie.

azureSearchQueryType

Typ zapytania wyszukiwania w usłudze Azure Search, który należy wykonać podczas korzystania z niej jako rozszerzenia czatu w usłudze Azure OpenAI.

Majątek	Wartość
Opis	Typ zapytania wyszukiwania w usłudze Azure Search, który należy wykonać podczas korzystania z niej jako rozszerzenia czatu w usłudze Azure OpenAI.
Typ	ciąg
Wartości	simple semantic vector vector_simple_hybrid vector_semantic_hybrid

konfiguracjaAzureCosmosDBChatExtension

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	Wartość domyślna
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.	Nie.
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ń do czatu Azure OpenAI w celu poprawy zachowania odpowiedzi. Użycie tej konfiguracji jest zgodne tylko z usługą Azure OpenAI.	Tak

Azure Cosmos DB Chat Extension Parameters

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	Wartość domyślna
zezwalaj_na_częściowy_wynik	typ logiczny (boolowski)	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.	Nie.	Nieprawda
uwierzytelnianie	onYourDataConnectionStringOpcjeUwierzytelniania	Opcje uwierzytelniania dla Azure OpenAI na Twoich danych przy użyciu ciągu połączenia.	Tak
nazwa_kontenera	ciąg	Nazwa kontenera zasobów usługi Azure Cosmos DB.	Tak
nazwa_bazy_danych	ciąg	Nazwa bazy danych MongoDB vCore do użycia z Azure Cosmos DB.	Tak
zależność osadzenia	onYourDataEndpointVectorizationSource lub onYourDataDeploymentNameVectorizationSource		Tak
mapowanie pól	azureCosmosDBFieldMappingOptions	Opcjonalne ustawienia umożliwiające kontrolowanie sposobu przetwarzania pól przy użyciu skonfigurowanego zasobu usługi Azure Cosmos DB.	Tak
w zakresie	typ logiczny (boolowski)	Czy zapytania powinny być ograniczone do używania indeksowanych danych.	Nie.
uwzględnij_konteksty	macierz	Uwzględnione właściwości kontekstu wyjściowego. Jeśli nie zostanie określony, wartość domyślna to citations i intent.	Nie.
nazwa_indeksu	ciąg	Nazwa indeksu vCore MongoDB do użycia z Azure Cosmos DB.	Tak
maks_zapytania_wyszukiwania	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.	Nie.
ścisłość	liczba całkowita	Skonfigurowana dokładność filtrowania istotności wyszukiwania. Im większa jest surowość, tym większa precyzja, ale niższa kompletność odpowiedzi.	Nie.
top_n_documents	liczba całkowita	Skonfigurowana maksymalna liczba dokumentów do wyświetlenia dla skonfigurowanego zapytania.	Nie.

azureCosmosDBOpcjeMapowaniaPól

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

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
pola_treści	macierz	Nazwy pól indeksu, które powinny być traktowane jako zawartość.	Tak
separator_pól_treści	ciąg	Wzorzec separatora, którego powinny używać pola zawartości.	Nie.
pole ścieżki pliku	ciąg	Nazwa pola indeksu do użycia jako ścieżka pliku.	Nie.
pole_tytułu	ciąg	Nazwa pola indeksu, które ma być używane jako tytuł.	Nie.
url_field	ciąg	Nazwa pola indeksu, które ma być używane jako adres URL.	Nie.
pola wektorowe	macierz	Nazwy pól reprezentujących dane wektorowe.	Tak

KonfiguracjaRozszerzeniaElasticSearchChat

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

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
Parametry	elasticsearchChatExtensionParameters	Parametry do użycia podczas konfigurowania elasticsearchâ® jako rozszerzenia czatu usługi Azure OpenAI.	Nie.
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ń do czatu Azure OpenAI w celu poprawy zachowania odpowiedzi. Użycie tej konfiguracji jest zgodne tylko z usługą Azure OpenAI.	Tak

Parametry rozszerzenia czatu Elasticsearch

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

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
zezwalaj_na_częściowy_wynik	typ logiczny (boolowski)	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.	Nie.	Nieprawda
uwierzytelnianie	onYourDataKeyAndKeyIdAuthenticationOptions lub onYourDataEncodedApiKeyAuthenticationOptions		Tak
zależność osadzenia	onYourDataEndpointVectorizationSource lub onYourDataDeploymentNameVectorizationSource lub onYourDataModelIdVectorizationSource		Nie.
punkt końcowy	ciąg	Punkt końcowy usługi Elasticsearch®.	Tak
mapowanie pól	elasticsearchIndexFieldMappingOptions	Opcjonalne ustawienia umożliwiające kontrolowanie sposobu przetwarzania pól przy użyciu skonfigurowanego zasobu Elasticsearch®.	Nie.
w zakresie	typ logiczny (boolowski)	Czy zapytania powinny być ograniczone do używania indeksowanych danych.	Nie.
uwzględnij_konteksty	macierz	Uwzględnione właściwości kontekstu wyjściowego. Jeśli nie zostanie określony, wartość domyślna to citations i intent.	Nie.
nazwa_indeksu	ciąg	Nazwa indeksu Elasticsearch®.	Tak
maks_zapytania_wyszukiwania	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.	Nie.
typ_zapytania	elasticsearchQueryType	Typ zapytania pobierania Elasticsearch®, które należy wykonać podczas korzystania z Elasticsearch jako rozszerzenia czatu usługi Azure OpenAI.	Nie.
ścisłość	liczba całkowita	Skonfigurowana dokładność filtrowania istotności wyszukiwania. Im większa jest surowość, tym większa precyzja, ale niższa kompletność odpowiedzi.	Nie.
top_n_documents	liczba całkowita	Skonfigurowana maksymalna liczba dokumentów do wyświetlenia dla skonfigurowanego zapytania.	Nie.

Opcje mapowania pola indeksu Elasticsearch

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

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
pola_treści	macierz	Nazwy pól indeksu, które powinny być traktowane jako zawartość.	Nie.
separator_pól_treści	ciąg	Wzorzec separatora, którego powinny używać pola zawartości.	Nie.
pole ścieżki pliku	ciąg	Nazwa pola indeksu do użycia jako ścieżka pliku.	Nie.
pole_tytułu	ciąg	Nazwa pola indeksu, które ma być używane jako tytuł.	Nie.
url_field	ciąg	Nazwa pola indeksu, które ma być używane jako adres URL.	Nie.
pola wektorowe	macierz	Nazwy pól reprezentujących dane wektorowe.	Nie.

TypZapytaniaElasticsearch

Typ zapytania pobierania Elasticsearch®, które należy wykonać podczas korzystania z Elasticsearch jako rozszerzenia czatu usługi Azure OpenAI.

Majątek	Wartość
Opis	Typ zapytania pobierania Elasticsearch®, które należy wykonać podczas korzystania z Elasticsearch jako rozszerzenia czatu usługi Azure OpenAI.
Typ	ciąg
Wartości	simple vector

Konfiguracja rozszerzenia czatu MongoDB

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

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
Parametry	mongoDBChatExtensionParameters	Parametry do użycia podczas konfigurowania rozszerzenia czatu usługi Azure OpenAI na czacie danych podczas korzystania z bazy danych Mongo DB.	Nie.
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ń do czatu Azure OpenAI w celu poprawy zachowania odpowiedzi. Użycie tej konfiguracji jest zgodne tylko z usługą Azure OpenAI.	Tak

ParametryRozszerzeniaCzatuMongoDB

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	Wartość domyślna
zezwalaj_na_częściowy_wynik	typ logiczny (boolowski)	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.	Nie.	Nieprawda
app_name	ciąg	Nazwa aplikacji mongo DB.	Tak
uwierzytelnianie	opcjaUwierzytelnianiaNazwyUżytkownikaIHasłaDanych	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
zależność osadzenia	onYourDataEndpointVectorizationSource lub onYourDataDeploymentNameVectorizationSource		Tak
punkt końcowy	ciąg	Nazwa punktu końcowego klastra bazy danych Mongo DB.	Tak
mapowanie pól	mongoDBFieldMappingOptions	Opcjonalne ustawienia umożliwiające kontrolowanie sposobu przetwarzania pól podczas korzystania ze skonfigurowanego zasobu bazy danych Mongo DB.	Tak
w zakresie	typ logiczny (boolowski)	Czy zapytania powinny być ograniczone do używania indeksowanych danych.	Nie.
uwzględnij_konteksty	macierz	Uwzględnione właściwości kontekstu wyjściowego. Jeśli nie zostanie określony, wartość domyślna to citations i intent.	Nie.
nazwa_indeksu	ciąg	Nazwa indeksu bazy danych Mongo DB.	Tak
maks_zapytania_wyszukiwania	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.	Nie.
ścisłość	liczba całkowita	Skonfigurowana dokładność filtrowania istotności wyszukiwania. Im większa jest surowość, tym większa precyzja, ale niższa kompletność odpowiedzi.	Nie.
top_n_documents	liczba całkowita	Skonfigurowana maksymalna liczba dokumentów do wyświetlenia dla skonfigurowanego zapytania.	Nie.

mongoDBOpcjeMapowaniaPól

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

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
pola_treści	macierz	Nazwy pól indeksu, które powinny być traktowane jako zawartość.	Tak
separator_pól_treści	ciąg	Wzorzec separatora, którego powinny używać pola zawartości.	Nie.
pole ścieżki pliku	ciąg	Nazwa pola indeksu do użycia jako ścieżka pliku.	Nie.
pole_tytułu	ciąg	Nazwa pola indeksu, które ma być używane jako tytuł.	Nie.
url_field	ciąg	Nazwa pola indeksu, które ma być używane jako adres URL.	Nie.
pola wektorowe	macierz	Nazwy pól reprezentujących dane wektorowe.	Tak

konfiguracja rozszerzenia PineconeChat

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

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
Parametry	pineconeChatExtensionParameters	Parametry konfigurowania rozszerzeń czatu Pinecone w usłudze Azure OpenAI.	Nie.
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ń do czatu Azure OpenAI w celu poprawy 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	Wartość domyślna
zezwalaj_na_częściowy_wynik	typ logiczny (boolowski)	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.	Nie.	Nieprawda
uwierzytelnianie	Opcje uwierzytelniania klucza API Twoje Dane	Opcje uwierzytelniania dla usługi Azure OpenAI On Your Data przy użyciu klucza API.	Tak
zależność osadzenia	WdrożenieTwojeDaneNazwaWektoryzacjaŹródło	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
mapowanie pól	pineconeFieldMappingOptions	Opcjonalne ustawienia umożliwiające kontrolowanie sposobu przetwarzania pól podczas korzystania ze skonfigurowanego zasobu Pinecone.	Tak
w zakresie	typ logiczny (boolowski)	Czy zapytania powinny być ograniczone do używania indeksowanych danych.	Nie.
uwzględnij_konteksty	macierz	Uwzględnione właściwości kontekstu wyjściowego. Jeśli nie zostanie określony, wartość domyślna to citations i intent.	Nie.
nazwa_indeksu	ciąg	Nazwa indeksu bazy danych Pinecone.	Tak
maks_zapytania_wyszukiwania	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.	Nie.
ścisłość	liczba całkowita	Skonfigurowana dokładność filtrowania istotności wyszukiwania. Im większa jest surowość, tym większa precyzja, ale niższa kompletność odpowiedzi.	Nie.
top_n_documents	liczba całkowita	Skonfigurowana maksymalna liczba dokumentów do wyświetlenia dla skonfigurowanego zapytania.	Nie.

Opcje Mapowania Pola Pinecone

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

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
pola_treści	macierz	Nazwy pól indeksu, które powinny być traktowane jako zawartość.	Tak
separator_pól_treści	ciąg	Wzorzec separatora, którego powinny używać pola zawartości.	Nie.
pole ścieżki pliku	ciąg	Nazwa pola indeksu do użycia jako ścieżka pliku.	Nie.
pole_tytułu	ciąg	Nazwa pola indeksu, które ma być używane jako tytuł.	Nie.
url_field	ciąg	Nazwa pola indeksu, które ma być używane jako adres URL.	Nie.

OpcjeUwierzytelnianiaTwoichDanych

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

Dyskryminator dla opcji uwierzytelniania onYourData

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

Wartość typu	Schemat
api_key	Opcje uwierzytelniania klucza API Twoje Dane
connection_string	onYourDataConnectionStringOpcjeUwierzytelniania
key_and_key_id	Opcje uwierzytelniania na kluczach danych i identyfikatorach kluczy
encoded_api_key	OpcjeUwierzytelnianiaKluczaAPIZakodowanychDanych
access_token	OpcjeUwierzytelnianiaTokenemDostępuDoTwoichDanych
system_assigned_managed_identity	OpcjeUwierzytelnianiaZarządzanejTożsamościSystemowoPrzypisanejODanych
user_assigned_managed_identity	OpcjeUwierzytelnianiaZarządzanejTożsamościUżytkownikaWTwoichDanych
username_and_password	opcjaUwierzytelnianiaNazwyUżytkownikaIHasłaDanych

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
typ	typUwierzytelnieniaTwoichDanych	Typy uwierzytelniania obsługiwane przez Azure OpenAI z użyciem Twoich danych.	Tak

onYourDataContextProperty

Właściwość kontekstu.

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

typUwierzytelnianiaTwoichDanych

Typy uwierzytelniania obsługiwane przez Azure OpenAI z użyciem Twoich danych.

Majątek	Wartość
Opis	Typy uwierzytelniania obsługiwane przez Azure OpenAI z użyciem Twoich danych.
Typ	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 dla usługi Azure OpenAI On Your Data przy użyciu klucza API.

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
klucz	ciąg	Klucz interfejsu API do użycia do uwierzytelniania.	Nie.
typ	typUwierzytelnieniaTwoichDanych	Typy uwierzytelniania obsługiwane przez Azure OpenAI z użyciem Twoich danych.	Tak

opcjeUwierzytelnianiaTwojegoPołączeniaDanych

Opcje uwierzytelniania dla Azure OpenAI na Twoich danych przy użyciu ciągu połączenia.

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
ciąg znaków połączenia	ciąg	Parametry połączenia do użycia do uwierzytelniania.	Nie.
typ	typUwierzytelnieniaTwoichDanych	Typy uwierzytelniania obsługiwane przez Azure OpenAI z użyciem Twoich danych.	Tak

opcjeUwierzytelnianiaDlaKluczaTwoichDanychOrazIdKlucza

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

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
klucz	ciąg	Klucz elasticsearch do użycia do uwierzytelniania.	Nie.
identyfikator_klucza	ciąg	Identyfikator klucza elasticsearch do użycia do uwierzytelniania.	Nie.
typ	typUwierzytelnieniaTwoichDanych	Typy uwierzytelniania obsługiwane przez Azure OpenAI z użyciem Twoich danych.	Tak

Opcje uwierzytelniania za pomocą zaszyfrowanego klucza API dla danych

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

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
zaszyfrowany_klucz_api	ciąg	Klucz interfejsu API zakodowanego w usłudze Elasticsearch do użycia na potrzeby uwierzytelniania.	Nie.
typ	typUwierzytelnieniaTwoichDanych	Typy uwierzytelniania obsługiwane przez Azure OpenAI z użyciem Twoich danych.	Tak

OpcjeUwierzytelnianiaTokenówDostępuDoDanych

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

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
token dostępu	ciąg	Token dostępu do użycia do uwierzytelniania.	Nie.
typ	typUwierzytelnieniaTwoichDanych	Typy uwierzytelniania obsługiwane przez Azure OpenAI z użyciem Twoich danych.	Tak

opcjeUwierzytelnianiaTożsamościZarządzanejPrzydzielonejPrzezTwójSystemDanych

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

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
typ	typUwierzytelnieniaTwoichDanych	Typy uwierzytelniania obsługiwane przez Azure OpenAI z użyciem Twoich danych.	Tak

Opcje uwierzytelniania przy użyciu przypisanej tożsamości zarządzanej dla użytkownika na platformie YourData

Opcje uwierzytelniania dla Azure OpenAI w odniesieniu do Twoich danych, korzystając z przypisanej przez użytkownika tożsamości zarządzanej.

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
Identyfikator_zasobu_zarządzanej_tożsamości	ciąg	Identyfikator zasobu tożsamości zarządzanej przypisanej przez użytkownika do użycia do uwierzytelniania.	Nie.
typ	typUwierzytelnieniaTwoichDanych	Typy uwierzytelniania obsługiwane przez Azure OpenAI z użyciem Twoich danych.	Tak

opcjeUwierzytelnianiaUsernameIPasswordDaneTwoje

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

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
hasło	ciąg	Hasło. do użycia do uwierzytelniania.	Nie.
typ	typUwierzytelnieniaTwoichDanych	Typy uwierzytelniania obsługiwane przez Azure OpenAI z użyciem Twoich danych.	Tak
nazwa użytkownika	ciąg	Nazwa użytkownika używana do uwierzytelniania.	Nie.

ŹródłoWeWektorzeDanych

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	Schemat
endpoint	onYourDataEndpointŹródłoWektoryzacji
deployment_name	WdrożenieTwojeDaneNazwaWektoryzacjaŹródło
integrated	Źródło Zintegrowanej Wektoryzacji Twoich Danych
model_id	onYourDataModelIdŹródłoWektoryzacji

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
typ	naTwójTypŹródłaWeektoryzacjiDanych	Reprezentuje dostępne źródła, które usługa Azure OpenAI On Your Data może wykorzystać do konfigurowania wektoryzacji danych do użycia z wyszukiwaniem wektorowym.	Tak

Typ źródła wektoryzacji Twoich danych

Reprezentuje dostępne źródła, które usługa Azure OpenAI On Your Data może wykorzystać do konfigurowania wektoryzacji danych do użycia z wyszukiwaniem wektorowym.

Majątek	Wartość
Opis	Reprezentuje dostępne źródła, które usługa Azure OpenAI On Your Data może wykorzystać do konfigurowania wektoryzacji danych do użycia z wyszukiwaniem wektorowym.
Typ	ciąg
Wartości	endpoint deployment_name integrated model_id

NaTwoimŹródleWektoryzacjiDanychPunktKońcowy

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	Wartość domyślna
uwierzytelnianie	onYourDataApiKeyAuthenticationOptions lub onYourDataAccessTokenAuthenticationOptions		Nie.
wymiary	liczba całkowita	Liczba wymiarów osadzania powinna mieć wartość . Obsługiwane tylko w text-embedding-3 modelach i nowszych.	Nie.
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.	Nie.
typ	naTwójTypŹródłaWeektoryzacjiDanych	Reprezentuje dostępne źródła, które usługa Azure OpenAI On Your Data może wykorzystać do konfigurowania wektoryzacji danych do użycia z wyszukiwaniem wektorowym.	Tak

onYourDataDeploymentNameWektoryzacjaŹródło

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	Wartość domyślna
nazwa wdrożenia	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 funkcja "On Your Data" będzie korzystać z tego wdrożenia modelu za pośrednictwem wywołania wewnętrznego zamiast publicznego, co umożliwia wyszukiwanie wektorów nawet w sieciach prywatnych.	Nie.
wymiary	liczba całkowita	Liczba wymiarów osadzania powinna mieć wartość . Obsługiwane tylko w text-embedding-3 modelach i nowszych.	Nie.
typ	naTwójTypŹródłaWeektoryzacjiDanych	Reprezentuje dostępne źródła, które usługa Azure OpenAI On Your Data może wykorzystać do konfigurowania wektoryzacji danych do użycia z wyszukiwaniem wektorowym.	Tak

źródło zintegrowanej wektoryzacji Twoich danych

Reprezentuje zintegrowany wektoryzator zdefiniowany w ramach zasobu wyszukiwania.

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
typ	naTwójTypŹródłaWeektoryzacjiDanych	Reprezentuje dostępne źródła, które usługa Azure OpenAI On Your Data może wykorzystać do konfigurowania wektoryzacji danych do użycia z wyszukiwaniem wektorowym.	Tak

naTwójModelDanychIdźńŹródłoWektoryzacji

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	Wartość domyślna
identyfikator_modelu	ciąg	Określa identyfikator modelu, który ma być używany do wektoryzacji. Ten identyfikator modelu musi być zdefiniowany w usłudze wyszukiwania.	Nie.
typ	naTwójTypŹródłaWeektoryzacjiDanych	Reprezentuje dostępne źródła, które usługa Azure OpenAI On Your Data może wykorzystać do konfigurowania wektoryzacji danych do użycia z wyszukiwaniem wektorowym.	Tak

kontekstWiadomościRozszerzeńAzureChat

Reprezentacja dodatkowych informacji kontekstowych dostępnych, gdy w generowanie odpowiedzi na czat są zaangażowane rozszerzenia czatu Azure OpenAI. 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	Wartość domyślna
wszystkie_pobrane_dokumenty	macierz	Wszystkie pobrane dokumenty.	Nie.
Cytatów	macierz	Wynik pobierania źródła danych używany do generowania komunikatu asystenta w odpowiedzi.	Nie.
intencja	ciąg	Wykryta intencja z historii czatu, używana przy przejściu do następnego kroku, by przenieść kontekst.	Nie.

cytat

informacje o cytatach dla komunikatu odpowiedzi zakończenia czatu.

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
identyfikator_kawałka	ciąg	Identyfikator fragmentu cytatu.	Nie.
zawartość	ciąg	Zawartość cytatu.	Tak
ścieżka pliku	ciąg	Ścieżka pliku cytatu.	Nie.
wynik ponownego rankingu	Liczba	Wynik ponownego generowania pobranego dokumentu.	Nie.
tytuł	ciąg	Tytuł cytatu.	Nie.
URL	ciąg	Adres URL cytatu.	Nie.

pobranyDokument

Pobrany dokument.

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
identyfikator_kawałka	ciąg	Identyfikator fragmentu cytatu.	Nie.
zawartość	ciąg	Zawartość cytatu.	Tak
indeks_źródła_danych	liczba całkowita	Indeks źródła danych.	Nie.
ścieżka pliku	ciąg	Ścieżka pliku cytatu.	Nie.
powod_filtra	filterReason	Przyczyna filtrowania pobranego dokumentu.	Nie.
wynik_pierwotnego_wyszukiwania	Liczba	Oryginalny wynik wyszukiwania pobranego dokumentu.	Nie.
wynik ponownego rankingu	Liczba	Wynik ponownego generowania pobranego dokumentu.	Nie.
zapytania_wyszukiwania	macierz	Zapytania wyszukiwania używane do pobierania dokumentu.	Nie.
tytuł	ciąg	Tytuł cytatu.	Nie.
URL	ciąg	Adres URL cytatu.	Nie.

powód filtrowania

Przyczyna filtrowania pobranego dokumentu.

Majątek	Wartość
Opis	Przyczyna filtrowania pobranego dokumentu.
Typ	ciąg
Wartości	score rerank

KomunikatZakończeniaRozmowyNarzędziaCall

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
funkcja	obiekt	Funkcja, którą wywołał 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.	Nie.
└─ nazwa	ciąg	Nazwa funkcji do wywołania.	Nie.
id	ciąg	Identyfikator wywołania narzędzia.	Tak
typ	toolCallType	Typ wywołania narzędzia, w tym przypadku function.	Tak

typWywołaniaNarzędzia

Typ wywołania narzędzia, w tym przypadku function.

Majątek	Wartość
Opis	Typ wywołania narzędzia, w tym przypadku function.
Typ	ciąg
Wartości	function

Narzędzie do wysyłania wiadomości z prośbą o zakończenie czatu

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

chatCompletionRequestMessageFunction

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
zawartość	ciąg	Zawartość wiadomości.	Nie.
nazwa	ciąg	Zawartość wiadomości.	Nie.
rola	wyliczenie	Rola autora komunikatów, w tym przypadku function. Możliwe wartości: function	Nie.

utwórzOdpowiedźNaZakończenieCzatu

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

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
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) wskazująca moment utworzenia zakończenia czatu.	Tak
id	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
wyniki_filtru_poleceń	promptFilterResults	Wyniki filtrowania zawartości dla zera lub większej liczby monitów w żądaniu. W żądaniu przesyłania strumieniowego wyniki dla różnych poleceń mogą pojawiać się o różnych porach lub w różnej kolejności.	Nie.
systemowy odcisk palca	ciąg	Ten odcisk palca reprezentuje zaplecze systemowe, z którym działa model. Można użyć w połączeniu z parametrem żądania seed, aby zrozumieć, kiedy wprowadzono zmiany w back-endzie, które mogą wpływać na deterministyczne działanie.	Nie.
użycie	completionUsage	Statystyki użycia dotyczące żądania zakończenia.	Nie.

utwórzOdpowiedźNaKompletacjęStrumieniaCzatu

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

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
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) wskazująca moment utworzenia zakończenia czatu. Każdy fragment ma ten sam znacznik czasu.	Tak
id	ciąg	Unikatowy identyfikator ukończenia czatu. Każdy fragment ma ten sam identyfikator.	Tak
model	ciąg	Model do generowania dokończeń.	Tak
obiekt	wyliczenie	Typ obiektu, który jest zawsze chat.completion.chunk. Możliwe wartości: chat.completion.chunk	Tak
systemowy odcisk palca	ciąg	Ten odcisk palca reprezentuje zaplecze systemowe, z którym działa model. Można użyć w połączeniu z parametrem żądania seed, aby zrozumieć, kiedy wprowadzono zmiany w back-endzie, które mogą wpływać na deterministyczne działanie.	Nie.

chatCompletionStreamResponseDelta

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

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
zawartość	ciąg	Zawartość sekcji wiadomości.	Nie.
wywołanie_funkcji	obiekt	Przestarzałe i zastąpione przez tool_calls. Nazwa i argumenty funkcji, które powinny być wywoływane, generowane przez model.	Nie.
└─ 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.	Nie.
└─ nazwa	ciąg	Nazwa funkcji do wywołania.	Nie.
odmowa	ciąg	Komunikat o odmowie wygenerowany przez model.	Nie.
rola	wyliczenie	Rola autora tej wiadomości. Możliwe wartości: system, , user, assistanttool	Nie.
wywołania_narzędzi	macierz		Nie.

Segment wywołania narzędzia wiadomości chatCompletion

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
funkcja	obiekt		Nie.
└─ 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.	Nie.
└─ nazwa	ciąg	Nazwa funkcji do wywołania.	Nie.
id	ciąg	Identyfikator wywołania narzędzia.	Nie.
indeks	liczba całkowita		Tak
typ	wyliczenie	Typ narzędzia. Obecnie obsługiwany jest tylko function. Możliwe wartości: function	Nie.

Opcje strumienia ukończenia czatu

Opcje strumieniowania odpowiedzi. Ustaw tę wartość tylko po ustawieniu stream: true.

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
zawierać_użycie	typ logiczny (boolowski)	W przypadku ustawienia przed komunikatem data: [DONE] dodatkowy fragment zostanie przesłany strumieniem. 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.	Nie.

chatCompletionChoiceLogPrawdopodobieństwa

Informacje o logarytmicznym prawdopodobieństwie dla wybranej opcji.

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
zawartość	macierz	Lista tokenów zawartości komunikatów z informacjami o prawdopodobieństwie logarytmicznym.	Tak
odmowa	macierz	Lista tokenów odmowy w wiadomościach z informacjami o prawdopodobieństwach logarytmicznych.	Nie.

chatCompletionTokenLogprob

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
B	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	Liczba	Logarytm prawdopodobieństwa tego tokenu.	Tak
kod przedpłaty	ciąg	Znacznik.	Tak
top_logprobs	macierz	Lista najbardziej prawdopodobnych tokenów i ich logarytmicznych prawdopodobieństw na tej pozycji tokenu. W rzadkich przypadkach może zostać zwróconych mniej elementów top_logprobs niż liczba żądanych.	Tak

WiadomośćOdpowiedziNaZakończenieCzatu

Komunikat ukończenia czatu wygenerowany przez model.

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

rolaOdpowiedziChatUkończenieWiadomości

Rola autora komunikatu odpowiedzi.

Majątek	Wartość
Opis	Rola autora komunikatu odpowiedzi.
Typ	ciąg
Wartości	assistant

Opcja wyboru narzędzia zakończenia rozmowy

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

WybórNazwyNarzędziaUkończeniaCzatu

Określa narzędzie, które ma być używane przez model. Użyj, aby wymusić, że model wywoła określoną funkcję.

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
funkcja	obiekt		Tak
└─ nazwa	ciąg	Nazwa funkcji do wywołania.	Nie.
typ	wyliczenie	Typ narzędzia. Obecnie obsługiwany jest tylko function. 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.

Zawartość Prognozy

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

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
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

narzędziePołączeńWiadomościZakończeniaCzatu

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

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

ModalnościZakończeniaCzatu

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 - wywołanie funkcji zakończenia czatu

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	Wartość domyślna
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

użycie ukończenia

Statystyki użycia dotyczące żądania zakończenia.

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
tokeny_zakończenia	liczba całkowita	Liczba tokenów w wygenerowanym zakończeniu.	Tak
szczegóły_tokenów_uzupełnienia	obiekt	Podział tokenów używanych w uzupełnieniu.	Nie.
└zaakceptowane_tokeny_predykcji	liczba całkowita	W przypadku korzystania z przewidywanych danych wyjściowych liczba tokenów w przewidywaniu, które pojawiło się w zakończeniu.	Nie.
└audio_tokens	liczba całkowita	Tokeny wejściowe audio generowane przez model.	Nie.
└─ tokeny_rozumowania	liczba całkowita	Tokeny generowane przez model do rozumowania.	Nie.
└─ odrzucone_żetony_predykcji	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.	Nie.
tokeny_wywołania	liczba całkowita	Liczba tokenów w prompt.	Tak
szczegóły_tokenów_promptu	obiekt	Szczegóły tokenów monitu.	Nie.
└audio_tokens	liczba całkowita	Tokeny wejściowe audio obecne w wierszu polecenia.	Nie.
└cached_tokens	liczba całkowita	Liczba buforowanych tokenów monitów.	Nie.
suma_znaczniki	liczba całkowita	Łączna liczba tokenów użytych w żądaniu (zapytanie + ukończenie).	Tak

narzędzie do zakończenia czatu

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
funkcja	FunctionObject		Tak
typ	wyliczenie	Typ narzędzia. Obecnie obsługiwany jest tylko function. Możliwe wartości: function	Tak

Parametry funkcji

Parametry akceptowane przez funkcje, opisane jako obiekt schematu JSON. Zapoznaj się z przewodnikiem w celu poznania przykładów oraz z odniesieniem do schematu JSON dla dokumentacji dotyczącej 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	Wartość domyślna
opis	ciąg	Opis działania funkcji używanej przez model do wyboru, kiedy i jak wywołać funkcję.	Nie.
nazwa	ciąg	Nazwa funkcji do wywołania. Musi składać się z a-z, A-Z, 0-9 lub zawierać podkreślniki i kreski, z maksymalną długością 64 znaków.	Tak
Parametry	Parametry funkcji	Parametry akceptowane przez funkcje, opisane jako obiekt schematu JSON. Zapoznaj się z przewodnikiem w celu poznania przykładów oraz z odniesieniem do schematu JSON dla dokumentacji dotyczącej formatu. Pominięcie parameters definiuje funkcję z pustą listą parametrów.	Nie.
surowy	typ logiczny (boolowski)	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.	Nie.	Nieprawda

FormatTekstuOdpowiedzi

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
typ	wyliczenie	Typ zdefiniowanego formatu odpowiedzi: text Możliwe wartości: text	Tak

FormatOdpowiedziJsonObiekt

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
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.

FormatOdpowiedziJsonSchema

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
json_schema	obiekt		Tak
Opis └*	ciąg	Opis celu formatu odpowiedzi, który jest używany przez model do określenia, jak odpowiedzieć w tym formacie.	Nie.
└─ nazwa	ciąg	Nazwa formatu odpowiedzi. Musi składać się z a-z, A-Z, 0-9 lub zawierać podkreślniki i kreski, z maksymalną długością 64 znaków.	Nie.
Schemat └*	ResponseFormatJsonSchemaSchema	Schemat formatu odpowiedzi, opisany jako obiekt schematu JSON.	Nie.
└* ścisłe	typ logiczny (boolowski)	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.	Nie.	Nieprawda
typ	wyliczenie	Typ zdefiniowanego formatu odpowiedzi: json_schema Możliwe wartości: json_schema	Tak

Opcja ukończenia rozmowy wspólna

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
powód zakończenia	ciąg		Nie.
indeks	liczba całkowita		Nie.

utwórzŻądanieTłumaczenia

Żądanie tłumaczenia.

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
plik	ciąg	Plik audio do tłumaczenia.	Tak
monit	ciąg	Opcjonalny tekst wskazujący styl modelu lub jako kontynuacja poprzedniego segmentu audio. Monit powinien być w języku angielskim.	Nie.
format_odpowiedzi	audioResponseFormat	Definiuje format danych wyjściowych.	Nie.
temperatura	Liczba	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ędą bardziej skoncentrowane i deterministyczne. Jeśli ustawiono wartość 0, model użyje logarytmu prawdopodobieństwa, aby automatycznie zwiększyć temperaturę, aż zostaną osiągnięte określone progi.	Nie.	0

odpowiedź dźwiękowa

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

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
SMS	ciąg	Przetłumaczony lub transkrypowany tekst.	Tak

audioVerboseResponse

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

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
czas trwania	Liczba	Czas trwania.	Nie.
język	ciąg	Język.	Nie.
segmenty	macierz		Nie.
zadanie	ciąg	Typ zadania audio.	Nie.
SMS	ciąg	Przetłumaczony lub transkrypowany tekst.	Tak
słowa	macierz		Nie.

Format odpowiedzi audio

Definiuje format danych wyjściowych.

Majątek	Wartość
Opis	Definiuje format danych wyjściowych.
Typ	ciąg
Wartości	json text srt verbose_json vtt

utwórzŻądanieTranskrypcji

Żądanie transkrypcji.

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
plik	ciąg	Obiekt pliku audio do transkrypcji.	Tak
język	ciąg	Język wejściowego dźwięku. Podanie języka wejściowego w formacie ISO-639-1 poprawi dokładność i opóźnienie.	Nie.
monit	ciąg	Opcjonalny tekst wskazujący styl modelu lub jako kontynuacja poprzedniego segmentu audio. Komunikat powinien być zgodny z językiem dźwięku.	Nie.
format_odpowiedzi	audioResponseFormat	Definiuje format danych wyjściowych.	Nie.
temperatura	Liczba	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ędą bardziej skoncentrowane i deterministyczne. Jeśli ustawiono wartość 0, model użyje logarytmu prawdopodobieństwa, aby automatycznie zwiększyć temperaturę, aż zostaną osiągnięte określone progi.	Nie.	0
granularności_znaczników_czasu[]	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 znaczników czasu segmentu, ale generowanie znaczników czasu dla wyrazów powoduje dodatkowe opóźnienie.	Nie.	odcinek

Fragment dźwiękowy

Transkrypcja lub część tłumaczenia.

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
avg_logprob	Liczba	Średnie logarytmiczne prawdopodobieństwo.	Nie.
współczynnik kompresji	Liczba	Współczynnik sprężania.	Nie.
koniec	Liczba	Przesunięcie końcowe segmentu.	Nie.
id	liczba całkowita	Identyfikator segmentu.	Nie.
brak_prob_rozmowy	Liczba	Prawdopodobieństwo braku mowy.	Nie.
szukać	Liczba	Przesunięcie segmentu.	Nie.
początek	Liczba	Przesunięcie rozpoczęcia segmentu.	Nie.
temperatura	Liczba	Temperatura.	Nie.
SMS	ciąg	Tekst segmentu.	Nie.
Tokeny	macierz	Tokeny tekstu.	Nie.

audioWord

Transkrypcja lub słowo translacji.

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
koniec	Liczba	Przesunięcie końcowe programu Word.	Nie.
początek	Liczba	Przesunięcie rozpoczęcia programu Word.	Nie.
słowo	ciąg	Słowo	Nie.

utwórzŻądanieMowy

Żądanie mowy.

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

jakość obrazu

Jakość obrazu, który zostanie wygenerowany.

Majątek	Wartość
Opis	Jakość obrazu, który zostanie wygenerowany.
Typ	ciąg
Wartość domyślna	samochód
Wartości	auto high medium low hd standard

imagesResponseFormat

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

Majątek	Wartość
Opis	Format, w którym są zwracane wygenerowane obrazy.
Typ	ciąg
Wartość domyślna	URL
Wartości	url b64_json

imagesOutputFormat (format wyjściowy obrazów)

Format pliku, w którym są zwracane wygenerowane obrazy. Obsługiwane tylko dla gpt-image-1.

Majątek	Wartość
Opis	Format pliku, w którym są zwracane wygenerowane obrazy. Obsługiwane tylko dla gpt-image-1.
Typ	ciąg
Wartość domyślna	png
Wartości	png jpeg

rozmiarObrazu

Rozmiar wygenerowanych obrazów.

Majątek	Wartość
Opis	Rozmiar wygenerowanych obrazów.
Typ	ciąg
Wartość domyślna	samochód
Wartości	auto 1792x1024 1024x1792 1024x1024 1024x1536 1536x1024

styl obrazu

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

Majątek	Wartość
Opis	Styl wygenerowanych obrazów. Obsługiwane tylko dla dall-e-3.
Typ	ciąg
Wartość domyślna	żywy
Wartości	vivid natural

tło obrazu

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

Majątek	Wartość
Opis	Umożliwia ustawienie przezroczystości tła wygenerowanych obrazów. Ten parametr jest obsługiwany tylko w przypadku biblioteki gpt-image-1.
Typ	ciąg
Wartość domyślna	samochód
Wartości	transparent opaque auto

żądanieGeneracjiObrazów

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
tło	imageBackground	Umożliwia ustawienie przezroczystości tła wygenerowanych obrazów. Ten parametr jest obsługiwany tylko w przypadku biblioteki gpt-image-1.	Nie.	samochód
n	liczba całkowita	Liczba obrazów do wygenerowania. Obsługiwane jest tylko n=1 dla dall-e-3.	Nie.	1
kompresja wyjściowa	liczba całkowita	Poziom kompresji (0–100%) dla wygenerowanych obrazów. Ten parametr jest obsługiwany tylko w przypadku biblioteki gpt-image-1 z formatem danych wyjściowych jpeg.	Nie.	100
format_wyjściowy	imagesOutputFormat	Format pliku, w którym są zwracane wygenerowane obrazy. Obsługiwane tylko dla gpt-image-1.	Nie.	png
monit	ciąg	Opis tekstu żądanych obrazów. Maksymalna długość to 32000 znaków dla gpt-image-1 i 4000 znaków dla dall-e-3.	Tak
jakość	imageQuality	Jakość obrazu, który zostanie wygenerowany.	Nie.	samochód
format_odpowiedzi	imagesResponseFormat	Format, w którym są zwracane wygenerowane obrazy.	Nie.	URL
rozmiar	imageSize	Rozmiar wygenerowanych obrazów.	Nie.	samochód
styl	imageStyle	Styl wygenerowanych obrazów. Obsługiwane tylko dla dall-e-3.	Nie.	żywy
użytkownik	ciąg	Unikatowy identyfikator reprezentujący użytkownika końcowego, który może pomóc w monitorowaniu i wykrywaniu nadużyć.	Nie.

żądanieEdycjiObrazu

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
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.	Nie.
n	liczba całkowita	Liczba obrazów do wygenerowania.	Nie.	1
monit	ciąg	Opis tekstu żądanych obrazów. Maksymalna długość to 32000 znaków.	Tak
jakość	imageQuality	Jakość obrazu, który zostanie wygenerowany.	Nie.	samochód
format_odpowiedzi	imagesResponseFormat	Format, w którym są zwracane wygenerowane obrazy.	Nie.	URL
rozmiar	imageSize	Rozmiar wygenerowanych obrazów.	Nie.	samochód
użytkownik	ciąg	Unikatowy identyfikator reprezentujący użytkownika końcowego, który może pomóc w monitorowaniu i wykrywaniu nadużyć.	Nie.

generateImagesResponse

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
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 dla gpt-image-1.	Nie.

wynikObrazu

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

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
b64_json	ciąg	Obraz zakodowany w formacie base64	Nie.
wyniki_filtra_treści	Wyniki filtru treści DALL-E	Informacje o wynikach filtrowania zawartości.	Nie.
wyniki_filtru_poleceń	dalleFilterResults	Informacje o kategorii filtrowania treści (nienawiść, treści seksualne, przemoc, samookaleczenia), jeśli zostały wykryte, a także o poziomie ważności (bardzo niski, niski, średni, wysoki, które określają intensywność i poziom ryzyka szkodliwej zawartości) oraz czy zostały przefiltrowane, 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.	Nie.
(revised_prompt remains unchanged, assuming it is a placeholder requiring no translation or adaptation)	ciąg	Polecenie, które zostało użyte do wygenerowania obrazu, jeśli dokonano jakiejkolwiek poprawki do podpowiedzi.	Nie.
URL	ciąg	Adres URL obrazu.	Nie.

Użycie Generacji Obrazów

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

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
input_tokens	liczba całkowita	Liczba tokenów wejściowych.	Nie.
szczegóły_znaczniki_wejściowe	obiekt	Szczegółowy podział tokenów wejściowych.	Nie.
└image_tokens	liczba całkowita	Liczba tokenów obrazu.	Nie.
└ text_tokens	liczba całkowita	Liczba tokenów tekstowych.	Nie.
tokeny_wyjsciowe	liczba całkowita	Liczba tokenów wyjściowych.	Nie.
suma_znaczniki	liczba całkowita	Całkowita liczba użytych tokenów.	Nie.

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	Wartość domyślna
Obejmuje	macierz	Tablica zakresów reprezentujących wykryte obiekty i informacje o polu ograniczenia.	Tak
SMS	ciąg		Tak

piędź

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

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
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	Wartość domyślna
tokeny_zakończenia	liczba całkowita	Liczba tokenów ukończenia używanych w trakcie przebiegu.	Tak
tokeny_wywołania	liczba całkowita	Liczba tokenów monitu używanych w trakcie przebiegu.	Tak
suma_znaczniki	liczba całkowita	Łączna liczba użytych tokenów (monit i ukończenie).	Tak

uruchomZastosowanieZakończeniaKroku

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	Wartość domyślna
tokeny_zakończenia	liczba całkowita	Liczba tokenów ukończenia używanych w trakcie kroku uruchamiania.	Tak
tokeny_wywołania	liczba całkowita	Liczba tokenów monitu używanych w trakcie kroku uruchamiania.	Tak
suma_znaczniki	liczba całkowita	Łączna liczba użytych tokenów (monit i ukończenie).	Tak

formatOpcjiApiOdpowiedziAsystentów

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 opcji { "type": "json_schema", "json_schema": {...} } umożliwia dane wyjściowe w strukturze, które zapewniają zgodność modelu 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 oznacza, że generacja przekroczyła max_tokens lub jeśli rozmowa przekroczyła maksymalną długość kontekstu.

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

• ResponseFormatText
• ResponseFormatJsonObject
• ResponseFormatJsonSchema

FormatOdpowiedziApiAsystentów (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	Wartość domyślna
typ	ciąg	Musi być jednym z text lub json_object.	Nie.	SMS

typ Enum: AssistantsApiResponseFormat

Wartość	Opis
SMS
obiekt JSON

obiekt asystenta

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

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
utworzono_o	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
id	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
format_odpowiedzi	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 opcji { "type": "json_schema", "json_schema": {...} } umożliwia dane wyjściowe w strukturze, które zapewniają zgodność modelu 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 oznacza, że generacja przekroczyła max_tokens lub jeśli rozmowa przekroczyła maksymalną długość kontekstu.	Nie.
temperatura	Liczba	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ędą bardziej skoncentrowane i deterministyczne.	Nie.	1
zasoby narzędziowe	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.	Nie.
└ code_interpreter	obiekt		Nie.
└ 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.	Nie.	[]
└─ file_search	obiekt		Nie.
└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.	Nie.
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	Liczba	Alternatywa dla próbkowania z temperaturą, zwana próbkowaniem jądra, gdzie model uwzględnia wyniki tokenów z masą prawdopodobieństwa top_p. Dlatego 0,1 oznacza, że uwzględniane są tylko tokeny znajdujące się w górnych 10% masy prawdopodobieństwa. Ogólnie zalecamy zmianę tej wartości lub temperatury, ale nie obu.	Nie.	1

object Enum: AssistantObjectType

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

stwórzZadanieAsystenta

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
opis	ciąg	Opis asystenta. Maksymalna długość to 512 znaków.	Nie.
instrukcje	ciąg	Instrukcje systemowe używane przez asystenta. Maksymalna długość to 256 000 znaków.	Nie.
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.	Nie.
model	ciąg		Tak
nazwa	ciąg	Nazwa asystenta. Maksymalna długość to 256 znaków.	Nie.
format_odpowiedzi	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 opcji { "type": "json_schema", "json_schema": {...} } umożliwia dane wyjściowe w strukturze, które zapewniają zgodność modelu 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 oznacza, że generacja przekroczyła max_tokens lub jeśli rozmowa przekroczyła maksymalną długość kontekstu.	Nie.
temperatura	Liczba	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ędą bardziej skoncentrowane i deterministyczne.	Nie.	1
zasoby narzędziowe	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.	Nie.
└ code_interpreter	obiekt		Nie.
└ 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.	Nie.	[]
└─ file_search	obiekt		Nie.
└vector_store_ids	macierz	Magazyn wektorów dołączony do tego asystenta. Może istnieć maksymalnie 1 magazyn wektorów dołączony do asystenta.	Nie.
└─ przechowalnie_wektorów	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.	Nie.
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.	Nie.	[]
top_p	Liczba	Alternatywa dla próbkowania z temperaturą, zwana próbkowaniem jądra, gdzie model uwzględnia wyniki tokenów z masą prawdopodobieństwa top_p. Dlatego 0,1 oznacza, że uwzględniane są tylko tokeny znajdujące się w górnych 10% masy prawdopodobieństwa. Ogólnie zalecamy zmianę tej wartości lub temperatury, ale nie obu.	Nie.	1

zmieńŻądanieAsystenta

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
opis	ciąg	Opis asystenta. Maksymalna długość to 512 znaków.	Nie.
instrukcje	ciąg	Instrukcje systemowe używane przez asystenta. Maksymalna długość to 32768 znaków.	Nie.
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.	Nie.
model	ciąg		Nie.
nazwa	ciąg	Nazwa asystenta. Maksymalna długość to 256 znaków.	Nie.
format_odpowiedzi	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 opcji { "type": "json_schema", "json_schema": {...} } umożliwia dane wyjściowe w strukturze, które zapewniają zgodność modelu 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 oznacza, że generacja przekroczyła max_tokens lub jeśli rozmowa przekroczyła maksymalną długość kontekstu.	Nie.
temperatura	Liczba	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ędą bardziej skoncentrowane i deterministyczne.	Nie.	1
zasoby narzędziowe	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.	Nie.
└ code_interpreter	obiekt		Nie.
└ 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.	Nie.	[]
└─ file_search	obiekt		Nie.
└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.	Nie.
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.	Nie.	[]
top_p	Liczba	Alternatywa dla próbkowania z temperaturą, zwana próbkowaniem jądra, gdzie model uwzględnia wyniki tokenów z masą prawdopodobieństwa top_p. Dlatego 0,1 oznacza, że uwzględniane są tylko tokeny znajdujące się w górnych 10% masy prawdopodobieństwa. Ogólnie zalecamy zmianę tej wartości lub temperatury, ale nie obu.	Nie.	1

usuńOdpowiedźAsystenta

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
usunięta	typ logiczny (boolowski)		Tak
id	ciąg		Tak
obiekt	ciąg		Tak

object Enum: DeleteAssistantResponseState

Wartość	Opis
zostało usunięte przez asystenta

odpowiedźListaAsystentów

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
dane	macierz		Tak
first_id	ciąg		Tak
zawiera_więcej	typ logiczny (boolowski)		Tak
last_id	ciąg		Tak
obiekt	ciąg		Tak

KodNarzędziAsystenta

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
typ	ciąg	Typ zdefiniowanego narzędzia: code_interpreter	Tak

typ Enum: assistantToolsCodeType

Wartość	Opis
code_interpreter

asystentNarzędziaPlikWyszukiwanie

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
wyszukiwanie plików	obiekt	Zastępuje narzędzie do wyszukiwania plików.	Nie.
└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.	Nie.
typ	ciąg	Typ zdefiniowanego narzędzia: file_search	Tak

type Enum: assistantToolsFileSearchType

Wartość	Opis
wyszukiwanie plików

assistantToolsFileSearchTypeOnly

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
typ	ciąg	Typ zdefiniowanego narzędzia: file_search	Tak

type Enum: assistantToolsFileSearchType

Wartość	Opis
wyszukiwanie plików

funkcjaNarzędziAsystenta

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
funkcja	obiekt	Definicja funkcji.	Tak
Opis └*	ciąg	Opis działania funkcji używanej przez model do wyboru, kiedy i jak wywołać funkcję.	Nie.
└─ nazwa	ciąg	Nazwa funkcji do wywołania. Musi składać się z a-z, A-Z, 0-9 lub zawierać podkreślniki i kreski, z maksymalną długością 64 znaków.	Nie.
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.	Nie.
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	Wartość domyślna
ostatnie_wiadomości	liczba całkowita	Liczba najnowszych komunikatów z wątku podczas konstruowania kontekstu przebiegu.	Nie.
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
samochód
ostatnie_wiadomości

opcjaWyboruNarzędziaAPIAsystentów

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:

• NarzędzieWyboruNazwDlaAsystentów

asystenciNazwanegoNarzędziaWybór

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	Wartość domyślna
funkcja	obiekt		Nie.
└─ nazwa	ciąg	Nazwa funkcji do wywołania.	Nie.
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
wyszukiwanie plików

runObject

Reprezentuje przebieg wykonywania w wątkach.

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
identyfikator_assistenta	ciąg	Identyfikator asystenta używanego do wykonywania tego przebiegu.	Tak
anulowano_o	liczba całkowita	Sygnatura czasowa systemu Unix (w sekundach) dla momentu anulowania przebiegu.	Tak
zakończono_o	liczba całkowita	Sygnatura czasowa systemu Unix (w sekundach) dla momentu ukończenia przebiegu.	Tak
utworzono_o	liczba całkowita	Sygnatura czasowa systemu Unix (w sekundach) dla momentu utworzenia przebiegu.	Tak
wygasa_o	liczba całkowita	Sygnatura czasowa systemu Unix (w sekundach) dla czasu wygaśnięcia przebiegu.	Tak
nie powiodło się o	liczba całkowita	Sygnatura czasowa systemu Unix (w sekundach) dla czasu niepowodzenia uruchomienia.	Tak
id	ciąg	Identyfikator, do którego można odwoływać się w punktach końcowych interfejsu API.	Tak
niepełne szczegóły	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.	Nie.
instrukcje	ciąg	Instrukcje używane przez asystenta do tego przebiegu.	Tak
ostatni błąd	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.	Nie.
└─ Komunikat	ciąg	Czytelny dla człowieka opis błędu.	Nie.
max_completion_tokens (maksymalna liczba tokenów zakończenia)	liczba całkowita	Maksymalna liczba tokenów ukończenia określonych do użycia w trakcie przebiegu.	Tak
maksymalna liczba tokenów monitu	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
wywołania_narzędzia_równoległe	ParallelToolCalls	Czy włączyć równoległe wywoływanie funkcji podczas używania narzędzia.	Nie.	Prawda
wymagana_akcja	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.	Nie.
└tool_calls	macierz	Lista odpowiednich wywołań narzędzi.	Nie.
└typ	wyliczenie	Na razie jest to zawsze submit_tool_outputs. Możliwe wartości: submit_tool_outputs	Nie.
format_odpowiedzi	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 opcji { "type": "json_schema", "json_schema": {...} } umożliwia dane wyjściowe w strukturze, które zapewniają zgodność modelu 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 oznacza, że generacja przekroczyła max_tokens lub jeśli rozmowa przekroczyła maksymalną długość kontekstu.	Tak
rozpoczęto_o	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
temperatura	Liczba	Temperatura próbkowania używana na potrzeby tego przebiegu. Jeśli nie zostanie ustawiona, wartość domyślna to 1.	Nie.
identyfikator_wątku	ciąg	Identyfikator wątków, na których zostało wykonane to uruchomienie.	Tak
wybór narzędzia	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	Liczba	Wartość próbkowania jądra użyta na potrzeby tego przebiegu. Jeśli nie zostanie ustawiona, wartość domyślna to 1.	Nie.
strategia obcięcia	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
uruchomienie wątku	Typ obiektu przebiegu, który jest zawsze thread.run

status Enum: StatusUruchomieniaObiektu

Wartość	Opis
w kolejce	Stan w kolejce
w trakcie	Stan in_progress
wymaga_działania	Stan required_action
Anulowanie	Stan anulowania
Anulowane	Stan anulowany
niepowodzenie	Stan niepowodzenia
zakończono	Stan ukończony
Wygasłe	Stan wygasły

createRunRequest

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
dodatkowe_instrukcje	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.	Nie.
dodatkowe_wiadomości	macierz	Dodaje dodatkowe komunikaty do wątku przed utworzeniem przebiegu.	Nie.
identyfikator_assistenta	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.	Nie.
max_completion_tokens (maksymalna liczba tokenów zakończenia)	liczba całkowita	Maksymalna liczba tokenów ukończenia, które mogą być używane w trakcie przebiegu. Uruchomienie zapewni najlepsze wysiłki, aby użyć 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. Aby uzyskać więcej informacji, zobacz incomplete_details.	Nie.
maksymalna liczba tokenów monitu	liczba całkowita	Maksymalna liczba tokenów monitów, które mogą być używane w trakcie przebiegu. Uruchomienie zapewni najlepsze wysiłki, aby użyć tylko liczby określonych tokenów monitu w wielu zakrętach przebiegu. Jeśli przebieg przekroczy określoną liczbę tokenów monitu, przebieg zakończy się stanem incomplete. Aby uzyskać więcej informacji, zobacz incomplete_details.	Nie.
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.	Nie.
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.	Nie.
wywołania_narzędzia_równoległe	ParallelToolCalls	Czy włączyć równoległe wywoływanie funkcji podczas używania narzędzia.	Nie.	Prawda
format_odpowiedzi	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 opcji { "type": "json_schema", "json_schema": {...} } umożliwia dane wyjściowe w strukturze, które zapewniają zgodność modelu 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 oznacza, że generacja przekroczyła max_tokens lub jeśli rozmowa przekroczyła maksymalną długość kontekstu.	Nie.
odtwarzać strumieniowo	typ logiczny (boolowski)	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] .	Nie.
temperatura	Liczba	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ędą bardziej skoncentrowane i deterministyczne.	Nie.	1
wybór narzędzia	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.	Nie.
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.	Nie.
top_p	Liczba	Alternatywa dla próbkowania z temperaturą, zwana próbkowaniem jądra, gdzie model uwzględnia wyniki tokenów z masą prawdopodobieństwa top_p. Dlatego 0,1 oznacza, że uwzględniane są tylko tokeny znajdujące się w górnych 10% masy prawdopodobieństwa. Ogólnie zalecamy zmianę tej wartości lub temperatury, ale nie obu.	Nie.	1
strategia obcięcia	obcięcie obiektuObject	Określa sposób obcinania wątku przed uruchomieniem. Służy do kontrolowania początkowego okna kontekstu przebiegu.	Nie.

listRunsResponse

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
dane	macierz		Tak
first_id	ciąg		Tak
zawiera_więcej	typ logiczny (boolowski)		Tak
last_id	ciąg		Tak
obiekt	ciąg		Tak

modifyRunRequest

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
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.	Nie.

przesłać wyniki działania narzędzia żądanie uruchomienia

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
odtwarzać strumieniowo	typ logiczny (boolowski)	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] .	Nie.
wyniki_narzędzia	macierz	Lista narzędzi, dla których są przesyłane dane wyjściowe.	Tak

runToolCallObject

Obiekty wywołania narzędzi

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
funkcja	obiekt	Definicja funkcji.	Tak
└─ Argumenty	ciąg	Argumenty, które model oczekuje przekazania do funkcji.	Nie.
└─ nazwa	ciąg	Nazwa funkcji.	Nie.
id	ciąg	Identyfikator wywołania narzędzia. Ten identyfikator należy przywoływać podczas przesyłania wyników narzędzia przy użyciu funkcji przesyłania wyników do 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

type Enum: RunToolCallObjectType

Wartość	Opis
funkcja

utwórzWątekIWykonajZapytanie

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
identyfikator_assistenta	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.	Nie.
max_completion_tokens (maksymalna liczba tokenów zakończenia)	liczba całkowita	Maksymalna liczba tokenów ukończenia, które mogą być używane w trakcie przebiegu. Uruchomienie zapewni najlepsze wysiłki, aby użyć 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. Aby uzyskać więcej informacji, zobacz incomplete_details.	Nie.
maksymalna liczba tokenów monitu	liczba całkowita	Maksymalna liczba tokenów monitów, które mogą być używane w trakcie przebiegu. Uruchomienie zapewni najlepsze wysiłki, aby użyć tylko liczby określonych tokenów monitu w wielu zakrętach przebiegu. Jeśli przebieg przekroczy określoną liczbę tokenów monitu, przebieg zakończy się stanem incomplete. Aby uzyskać więcej informacji, zobacz incomplete_details.	Nie.
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.	Nie.
model	ciąg	Identyfikator modeli, które mają być wykorzystane do wykonania tego zadania. 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.	Nie.
wywołania_narzędzia_równoległe	ParallelToolCalls	Czy włączyć równoległe wywoływanie funkcji podczas używania narzędzia.	Nie.	Prawda
format_odpowiedzi	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 opcji { "type": "json_schema", "json_schema": {...} } umożliwia dane wyjściowe w strukturze, które zapewniają zgodność modelu 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 oznacza, że generacja przekroczyła max_tokens lub jeśli rozmowa przekroczyła maksymalną długość kontekstu.	Nie.
odtwarzać strumieniowo	typ logiczny (boolowski)	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] .	Nie.
opcje transmisji	chatCompletionStreamOptions	Opcje strumieniowania odpowiedzi. Ustaw tę wartość tylko po ustawieniu stream: true.	Nie.	Żaden
temperatura	Liczba	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ędą bardziej skoncentrowane i deterministyczne.	Nie.	1
konwersacja	createThreadRequest		Nie.
wybór narzędzia	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.	Nie.
zasoby narzędziowe	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.	Nie.
└ code_interpreter	obiekt		Nie.
└ 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.	Nie.	[]
└─ file_search	obiekt		Nie.
└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.	Nie.
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.	Nie.
top_p	Liczba	Alternatywa dla próbkowania z temperaturą, zwana próbkowaniem jądra, gdzie model uwzględnia wyniki tokenów z masą prawdopodobieństwa top_p. Dlatego 0,1 oznacza, że uwzględniane są tylko tokeny znajdujące się w górnych 10% masy prawdopodobieństwa. Ogólnie zalecamy zmianę tej wartości lub temperatury, ale nie obu.	Nie.	1
strategia obcięcia	obcięcie obiektuObject	Określa sposób obcinania wątku przed uruchomieniem. Służy do kontrolowania początkowego okna kontekstu przebiegu.	Nie.

threadObject

Reprezentuje wątek zawierający komunikaty.

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
utworzono_o	liczba całkowita	Sygnatura czasowa systemu Unix (w sekundach) dla momentu utworzenia wątku.	Tak
id	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
zasoby narzędziowe	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		Nie.
└ 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.	Nie.	[]
└─ file_search	obiekt		Nie.
└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.	Nie.

object Enum: ThreadObjectType

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

utwórzŻądanieWątku

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
wiadomości	macierz	Lista komunikatów, z których chcesz rozpocząć wątek.	Nie.
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.	Nie.
zasoby narzędziowe	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.	Nie.
└ code_interpreter	obiekt		Nie.
└ 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.	Nie.	[]
└─ file_search	obiekt		Nie.
└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.	Nie.
└─ przechowalnie_wektorów	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.	Nie.

żądanie modyfikacji wątku

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
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.	Nie.
zasoby narzędziowe	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.	Nie.
└ code_interpreter	obiekt		Nie.
└ 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.	Nie.	[]
└─ file_search	obiekt		Nie.
└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.	Nie.

usuńOdpowiedźNaWątek

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
usunięta	typ logiczny (boolowski)		Tak
id	ciąg		Tak
obiekt	ciąg		Tak

object Enum: DeleteThreadResponseObjectState

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

listaWątkówOdpowiedź

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
dane	macierz		Tak
first_id	ciąg		Tak
zawiera_więcej	typ logiczny (boolowski)		Tak
last_id	ciąg		Tak
obiekt	ciąg		Tak

obiektWiadomości

Reprezentuje wiadomość w ramach wątków.

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
identyfikator_assistenta	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
zakończono_o	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
utworzono_o	liczba całkowita	Sygnatura czasowa systemu Unix (w sekundach) dla momentu utworzenia komunikatu.	Tak
id	ciąg	Identyfikator, do którego można odwoływać się w punktach końcowych interfejsu API.	Tak
niekompletne_o	liczba całkowita	Sygnatura czasowa systemu Unix (w sekundach) dla momentu, gdy komunikat został oznaczony jako niekompletny.	Tak
niepełne szczegóły	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.	Nie.
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
identyfikator_uruchomienia	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
identyfikator_wątku	ciąg	Identyfikator wątków, do którego należy ten komunikat.	Tak

object Enum: TypObiektuWiadomości

Wartość	Opis
wiadomość wątku	Typ obiektu komunikatu, który jest thread.message

Enum statusu: Status obiektu wiadomości

Wartość	Opis
w trakcie
Niekompletna
zakończono

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	Wartość domyślna
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.	Nie.
└─ Rola	ciąg	Jednostka, która wygenerowała komunikat. Jeden z user lub assistant.	Nie.
id	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
wątek.wiadomość.delta

utwórzŻądanieWiadomości

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
Załączniki	macierz	Lista plików dołączonych do wiadomości oraz narzędzia, do których należy je dodać.	Nie.
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.	Nie.
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

zmodyfikujWiadomoscZadanie

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
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.	Nie.

odpowiedź na usunięcie wiadomości

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
usunięta	typ logiczny (boolowski)		Tak
id	ciąg		Tak
obiekt	ciąg		Tak

object Enum: DeleteMessageResponseObject

Wartość	Opis
wątek.wiadomość.usunięta	Stan obiektu odpowiedzi komunikatu usuwania

odpowiedźNaListęWiadomości

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
dane	macierz		Tak
first_id	ciąg		Tak
zawiera_więcej	typ logiczny (boolowski)		Tak
last_id	ciąg		Tak
obiekt	ciąg		Tak

zawartośćWiadomościPlikObrazuObiekt

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

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
plik graficzny	obiekt		Tak
└ file_id	ciąg	Identyfikator pliku obrazu w zawartości wiadomości.	Nie.
typ	ciąg	Zawsze image_file.	Tak

type Enum: MessageContentImageFileObjectType

Wartość	Opis
plik graficzny	Typ pliku obrazu zawartości wiadomości

ObiektTekstuTreściWiadomości

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

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
SMS	obiekt		Tak
└* adnotacje	macierz		Nie.
└─ wartość	ciąg	Dane tworzące tekst.	Nie.
typ	ciąg	Zawsze text.	Tak

type Enum: TypObiektuTekstowegoTreściWiadomości

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

ObiektCytowaniaPlikuAdnotacjeTreściWiadomości

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	Wartość domyślna
koniec_indeksu	liczba całkowita		Tak
cytowanie pliku	obiekt		Tak
└─ file_id	ciąg	Identyfikator określonego pliku, z których pochodzi cytat.	Nie.
indeks_startowy	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
cytowanie pliku	Typ obiektu cytatu pliku

treśćWiadomościAdnotacjeTekstoweObiektŚcieżkiPliku

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

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
koniec_indeksu	liczba całkowita		Tak
ścieżka pliku	obiekt		Tak
└file_id	ciąg	Identyfikator wygenerowanego pliku.	Nie.
indeks_startowy	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
ścieżka pliku	Typ obiektu ścieżki pliku

messageDeltaContentImageFileObject

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

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
plik graficzny	obiekt		Nie.
└─ file_id	ciąg	Identyfikator pliku obrazu w zawartości wiadomości.	Nie.
indeks	liczba całkowita	Indeks części zawartości w komunikacie.	Tak
typ	ciąg	Zawsze image_file.	Tak

type Enum: MessageDeltaContentImageFileObjectType

Wartość	Opis
plik graficzny

messageDeltaContentTextObject

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

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

type Enum: MessageDeltaContentTextObjectType

Wartość	Opis
SMS

tekstWidomośćDeltaZawartośćAdnotacjePlikuObiektCytowania

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	Wartość domyślna
koniec_indeksu	liczba całkowita		Nie.
cytowanie pliku	obiekt		Nie.
└─file_id	ciąg	Identyfikator określonego pliku, z których pochodzi cytat.	Nie.
└cudzysłów	ciąg	Konkretny cudzysłów w pliku.	Nie.
indeks	liczba całkowita	Indeks adnotacji w części zawartości tekstowej.	Tak
indeks_startowy	liczba całkowita		Nie.
SMS	ciąg	Tekst w zawartości wiadomości, który musi zostać zastąpiony.	Nie.
typ	ciąg	Zawsze file_citation.	Tak

type Enum: MessageDeltaContentTextAnnotationsFileCitationObjectType

Wartość	Opis
cytowanie pliku

messageDeltaZawartośćTekstAdnotacjeŚcieżkaPlikuObiekt

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

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
koniec_indeksu	liczba całkowita		Nie.
ścieżka pliku	obiekt		Nie.
└file_id	ciąg	Identyfikator wygenerowanego pliku.	Nie.
indeks	liczba całkowita	Indeks adnotacji w części zawartości tekstowej.	Tak
indeks_startowy	liczba całkowita		Nie.
SMS	ciąg	Tekst w zawartości wiadomości, który musi zostać zastąpiony.	Nie.
typ	ciąg	Zawsze file_path.	Tak

type Enum: MessageDeltaContentTextAnnotationsFilePathObjectType

Wartość	Opis
ścieżka pliku

runStepObject

Reprezentuje krok wykonywania przebiegu.

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
identyfikator_assistenta	ciąg	Identyfikator asystenta skojarzonego z krokiem uruchamiania.	Tak
anulowano_o	liczba całkowita	Sygnatura czasowa systemu Unix (w sekundach) dla momentu anulowania kroku uruchamiania.	Tak
zakończono_o	liczba całkowita	Sygnatura czasowa systemu Unix (w sekundach) dla momentu ukończenia kroku uruchamiania.	Tak
utworzono_o	liczba całkowita	Sygnatura czasowa systemu Unix (w sekundach) dla momentu utworzenia kroku uruchamiania.	Tak
wygasło_o	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
nie powiodło się o	liczba całkowita	Sygnatura czasowa systemu Unix (w sekundach) dla momentu niepowodzenia kroku uruchamiania.	Tak
id	ciąg	Identyfikator kroku uruchamiania, do którego można odwoływać się w punktach końcowych interfejsu API.	Tak
ostatni błąd	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.	Nie.
└─ Komunikat	ciąg	Czytelny dla człowieka opis błędu.	Nie.
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
identyfikator_uruchomienia	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
szczegóły kroku	runStepDetailsMessageCreationObject lub runStepDetailsToolCallsObject	Szczegóły kroku uruchamiania.	Tak
identyfikator_wątku	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
tworzenie_wiadomości	Krok uruchamiania message_creation
wywołania_narzędzi	Krok uruchamiania tool_calls

status Enum: RunStepObjectStatus

Wartość	Opis
w trakcie	Stan uruchomienia in_progress
Anulowane	Stan anulowanego uruchomienia
niepowodzenie	Stan anulowanego uruchomienia
zakończono	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	Wartość domyślna
delta	obiekt	Delta zawierająca pola, które zostały zmienione w kroku uruchamiania.	Tak
└─ szczegóły kroku	runStepDeltaStepDetailsMessageCreationObject lub runStepDeltaStepDetailsToolCallsObject	Szczegóły kroku uruchamiania.	Nie.
id	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	Wartość domyślna
dane	macierz		Tak
first_id	ciąg		Tak
zawiera_więcej	typ logiczny (boolowski)		Tak
last_id	ciąg		Tak
obiekt	ciąg		Tak

UruchomienieSzczegółówTworzeniaKomunikatuObiektu

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

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
tworzenie_wiadomości	obiekt		Tak
└ message_id	ciąg	Identyfikator komunikatu, który został utworzony przez ten krok przebiegu.	Nie.
typ	ciąg	Zawsze message_creation.	Tak

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

Wartość	Opis
tworzenie_wiadomości

uruchomKrokDeltaSzczegółyTworzeniaObiektuWiadomości

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

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
tworzenie_wiadomości	obiekt		Nie.
└─ message_id	ciąg	Identyfikator komunikatu, który został utworzony przez ten krok przebiegu.	Nie.
typ	ciąg	Zawsze message_creation.	Tak

type Enum: RunStepDeltaStepDetailsMessageCreationObjectType

Wartość	Opis
tworzenie_wiadomości

runStepDetailsToolCallsObject

Szczegóły wywołania narzędzia.

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
wywołania_narzędzi	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
wywołania_narzędzi

UruchomKrokDeltaSzczegółyKrokuWywołaniaNarzędziaObiekt

Szczegóły wywołania narzędzia.

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
wywołania_narzędzi	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.	Nie.
typ	ciąg	Zawsze tool_calls.	Tak

type Enum: RunStepDeltaStepDetailsToolCallsObjectType

Wartość	Opis
wywołania_narzędzi

SzczegółyKrokuNarzędziaWywołujeObiektKodu

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

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
code_interpreter	obiekt	Definicja wywołania narzędzia Interpreter kodu.	Tak
└─ Wejście	ciąg	Dane wejściowe wywołania narzędzia Interpreter kodu.	Nie.
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.	Nie.
id	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

runStepDeltaKrokDetalNarzędzieWywołaniaObiektKodu

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

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
code_interpreter	obiekt	Definicja wywołania narzędzia Interpreter kodu.	Nie.
└─ Wejście	ciąg	Dane wejściowe wywołania narzędzia Interpreter kodu.	Nie.
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.	Nie.
id	ciąg	Identyfikator wywołania narzędzia.	Nie.
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

type Enum: RunStepDeltaStepDetailsToolCallsCodeObjectType

Wartość	Opis
code_interpreter

uruchomSzczegółyKrokiNarzędziaWywołaniaKodWyjścieDziennikiObiekt

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

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
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

uruchomKrokSzczegółyKrokuDeltaWywołaniaKoduNarzędziaObiektLogówWyjściowych

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

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
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.	Nie.
typ	ciąg	Zawsze logs.	Tak

Step 2: Typ wyliczeniowy: Obiekt typu RunStepDeltaStepDetailsToolCallsCodeOutputLogs

Wartość	Opis
dzienniki

UruchomienieSzczegółyNarzędziaWywołaniaKoduObrazWyjściowyObiekt

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
obraz	obiekt		Tak
└file_id	ciąg	Identyfikator pliku obrazu.	Nie.
typ	ciąg	Zawsze image.	Tak

type Enum: RunStepDetailsToolCallsCodeOutputImageObjectType

Wartość	Opis
obraz

ProcesUruchomieniaKrokSzczegółyNarzędziaWywołaniaKodWyjściowyObrazObiekt

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
obraz	obiekt		Nie.
└file_id	ciąg	Identyfikator pliku obrazu.	Nie.
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 (obiekt wyszukiwania plików)

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
wyszukiwanie plików	obiekt	Na razie zawsze będzie to pusty obiekt.	Tak
Wyniki └}	macierz	Wyniki wyszukiwania plików.	Nie.
id	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
wyszukiwanie plików

runStepDetailsNarzędzieWołaPlikWynikSzukaniaObiektu

Wystąpienie wyników wyszukiwania plików.

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
zawartość	macierz	Zawartość znalezionego wyniku. Zawartość jest dołączana tylko w przypadku żądania za pośrednictwem parametru include zapytania.	Nie.
identyfikator_pliku	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	Liczba	Wynik. Wszystkie wartości muszą być liczbą zmiennoprzecinkową z zakresu od 0 do 1.	Tak

UruchomKrokDeltaSzczegółyKrokuNarzędziaWywołaniaObiektuWyszukiwaniaPliku

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
wyszukiwanie plików	obiekt	Na razie zawsze będzie to pusty obiekt.	Tak
id	ciąg	Identyfikator obiektu wywołania narzędzia.	Nie.
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: RunStepDeltaStepDetailsToolCallsFileSearchObjectType

Wartość	Opis
wyszukiwanie plików

Wywołanie funkcji obiektu przez narzędzie runStepDetails

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
funkcja	obiekt	Definicja funkcji, która została wywołana.	Tak
└─ Argumenty	ciąg	Argumenty przekazane do funkcji.	Nie.
└─ nazwa	ciąg	Nazwa funkcji.	Nie.
└─ 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.	Nie.
id	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

uruchomKrokDetaleKrokuDeltaNarzędzieWywołaniaFunkcjiObiekt

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
funkcja	obiekt	Definicja funkcji, która została wywołana.	Nie.
└─ Argumenty	ciąg	Argumenty przekazane do funkcji.	Nie.
└─ nazwa	ciąg	Nazwa funkcji.	Nie.
└─ 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.	Nie.
id	ciąg	Identyfikator obiektu wywołania narzędzia.	Nie.
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	Wartość domyślna
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
ostatnia_aktywność_w	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	Wartość domyślna
utworzono_o	liczba całkowita	Sygnatura czasowa systemu Unix (w sekundach) dla momentu utworzenia magazynu wektorów.	Tak
wygasa po	vectorStoreExpirationAfter	Zasady wygasania magazynu wektorów.	Nie.
wygasa_o	liczba całkowita	Sygnatura czasowa systemu Unix (w sekundach) dla czasu wygaśnięcia magazynu wektorów.	Nie.
liczba_plików	obiekt		Tak
└* anulowano	liczba całkowita	Liczba anulowanych plików.	Nie.
└─ Ukończono	liczba całkowita	Liczba plików, które zostały pomyślnie przetworzone.	Nie.
└* nie powiodło się	liczba całkowita	Liczba plików, które nie mogły przetworzyć.	Nie.
└─ w_toku	liczba całkowita	Liczba obecnie przetwarzanych plików.	Nie.
└─ suma	liczba całkowita	Całkowita liczba plików.	Nie.
id	ciąg	Identyfikator, do którego można odwoływać się w punktach końcowych interfejsu API.	Tak
ostatnia_aktywność_w	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
użycie_bajtów	liczba całkowita	Całkowita liczba bajtów używanych przez pliki w magazynie wektorów.	Tak

status Enum: VectorStoreObjectStatus

Wartość	Opis
Wygasłe
w trakcie
zakończono

createVectorStoreRequest

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
strategia segmentacji	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.	Nie.
wygasa po	vectorStoreExpirationAfter	Zasady wygasania magazynu wektorów.	Nie.
identyfikatory_plików	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.	Nie.
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.	Nie.
nazwa	ciąg	Nazwa magazynu wektorów.	Nie.

aktualizujZleceniePrzechowywaniaWektorów

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
wygasa po	vectorStoreExpirationAfter	Zasady wygasania magazynu wektorów.	Nie.
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.	Nie.
nazwa	ciąg	Nazwa magazynu wektorów.	Nie.

listaSklepówWektorowychOdpowiedź

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
dane	macierz		Tak
first_id	ciąg		Tak
zawiera_więcej	typ logiczny (boolowski)		Tak
last_id	ciąg		Tak
obiekt	ciąg		Tak

deleteVectorStoreResponse

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
usunięta	typ logiczny (boolowski)		Tak
id	ciąg		Tak
obiekt	ciąg		Tak

object Enum: DeleteVectorStoreResponseObject

Wartość	Opis
vector_store.usunięty	Stan obiektu odpowiedzi magazynu wektorów usuwania

vectorStoreFileObject

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

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
strategia segmentacji	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.	Nie.
utworzono_o	liczba całkowita	Sygnatura czasowa systemu Unix (w sekundach) dla momentu utworzenia pliku magazynu wektorów.	Tak
id	ciąg	Identyfikator, do którego można odwoływać się w punktach końcowych interfejsu API.	Tak
ostatni błąd	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 .	Nie.
└─ Komunikat	ciąg	Czytelny dla człowieka opis błędu.	Nie.
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
użycie_bajtów	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
identyfikator_magazynu_wektorów	ciąg	Identyfikator magazynu wektorów, do którego jest dołączony plik.	Tak

object Enum: VectorStoreFileObjectType

Wartość	Opis
vector_store.file

Status Enum: VectorStoreFileObjectStatus

Wartość	Opis
w trakcie
zakończono
Anulowane
niepowodzenie

ParametrOdpowiedziStrategiiInnegoDzieleniaNaCzęści

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	Wartość domyślna
typ	ciąg	Zawsze other.	Tak

typ Enum: OtherChunkingStrategyResponseParamType

Wartość	Opis
alternatywny

staticChunkingStrategyResponseParam

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
statyczny	staticChunkingStrategy		Tak
typ	ciąg	Zawsze static.	Tak

typ Enum: StaticChunkingStrategyResponseParamType

Wartość	Opis
statyczny

Statyczna strategia chunkingu

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
nakładanie się tokenów segmentu	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
maksymalna_liczba_tokenów_w_kawałku	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

autoChunkingStrategiaParametrŻądania

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

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
typ	wyliczenie	Zawsze auto. Możliwe wartości: auto	Tak

Statyczna strategia podziału - parametry żądania

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
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	Wartość domyślna
strategia segmentacji	fragmentingStrategyRequestParam	Strategia fragmentowania używana do fragmentowania plików. Jeśli nie zostanie ustawiona, użyje auto strategii.	Nie.
identyfikator_pliku	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	Wartość domyślna
dane	macierz		Tak
first_id	ciąg		Tak
zawiera_więcej	typ logiczny (boolowski)		Tak
last_id	ciąg		Tak
obiekt	ciąg		Tak

deleteVectorStoreFileResponse

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
usunięta	typ logiczny (boolowski)		Tak
id	ciąg		Tak
obiekt	ciąg		Tak

object Enum: DeleteVectorStoreFileResponseObject

Wartość	Opis
vector_store.plik.usunięty

vectorStoreFileBatchObject

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

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
utworzono_o	liczba całkowita	Sygnatura czasowa systemu Unix (w sekundach) dla momentu utworzenia partii plików magazynu wektorów.	Tak
liczba_plików	obiekt		Tak
└* anulowano	liczba całkowita	Liczba anulowanych plików.	Nie.
└─ Ukończono	liczba całkowita	Liczba przetworzonych plików.	Nie.
└* nie powiodło się	liczba całkowita	Liczba plików, które nie mogły przetworzyć.	Nie.
└─ w_toku	liczba całkowita	Liczba obecnie przetwarzanych plików.	Nie.
└─ suma	liczba całkowita	Całkowita liczba plików.	Nie.
id	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
identyfikator_magazynu_wektorów	ciąg	Identyfikator magazynu wektorów, do którego jest dołączony plik.	Tak

object Enum: VectorStoreFileBatchObjectType

Wartość	Opis
partia_plików_magazynu_wektorów

status Enum: VectorStoreFileBatchObjectStatus

Wartość	Opis
w trakcie
zakończono
Anulowane
niepowodzenie

createVectorStoreFileBatchRequest

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
strategia segmentacji	fragmentingStrategyRequestParam	Strategia fragmentowania używana do fragmentowania plików. Jeśli nie zostanie ustawiona, użyje auto strategii.	Nie.
identyfikatory_plików	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

asystentStreamEvent

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:

wątek.utworzony

Występuje po utworzeniu nowego wątku.

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
dane	threadObject	Reprezentuje wątek zawierający komunikaty.	Tak
wydarzenie	ciąg		Tak

Dane: threadObject

Wyliczenie zdarzeń: ThreadStreamEventEnum

Wartość	Opis
wątek.utworzony	Zdarzenie utworzone przez wątek

---

runStreamEvent

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

wątek.uruchomiony.utworzony

Występuje po utworzeniu nowego przebiegu.

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
dane	runObject	Reprezentuje przebieg wykonywania w wątkach.	Tak
wydarzenie	ciąg		Tak

Dane: runObject

Wyliczenie zdarzeń: RunStreamEventCreated

Wartość	Opis
wątek.uruchomiony.utworzony

---

thread.run.queued

Występuje, gdy przebieg przechodzi do queued stanu.

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
dane	runObject	Reprezentuje przebieg wykonywania w wątkach.	Tak
wydarzenie	ciąg		Tak

Dane: runObject

Wyliczenie zdarzeń: RunStreamEventQueued

Wartość	Opis
thread.run.queued

---

wątek.uruchom.w_toku

Występuje, gdy przebieg przechodzi do in_progress stanu.

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
dane	runObject	Reprezentuje przebieg wykonywania w wątkach.	Tak
wydarzenie	ciąg		Tak

Dane: runObject

Wyliczenie zdarzeń: RunStreamEventInProgress

Wartość	Opis
wątek.uruchom.w_toku

---

wątek.działa.wymaga_działania

Występuje, gdy przebieg przechodzi do requires_action stanu.

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
dane	runObject	Reprezentuje przebieg wykonywania w wątkach.	Tak
wydarzenie	ciąg		Tak

Dane: runObject

Wyliczenie zdarzeń: RunStreamEventRequiresAction

Wartość	Opis
wątek.działa.wymaga_działania

---

wątek.uruchamianie.zakończone

Występuje po zakończeniu przebiegu.

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
dane	runObject	Reprezentuje przebieg wykonywania w wątkach.	Tak
wydarzenie	ciąg		Tak

Dane: runObject

Wyliczenie zdarzeń: RunStreamEventCompleted

Wartość	Opis
wątek.uruchamianie.zakończone

---

błąd uruchomienia wątku

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

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
dane	runObject	Reprezentuje przebieg wykonywania w wątkach.	Tak
wydarzenie	ciąg		Tak

Dane: runObject

Wyliczenie zdarzeń: RunStreamEventFailed

Wartość	Opis
błąd uruchomienia wątku

---

wątek.uruchomienie.anulowanie

Występuje, gdy przebieg przechodzi do cancelling stanu.

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
dane	runObject	Reprezentuje przebieg wykonywania w wątkach.	Tak
wydarzenie	ciąg		Tak

Dane: runObject

Wyliczenie zdarzeń: RunStreamEventCancelling

Wartość	Opis
wątek.uruchomienie.anulowanie

---

wątek.uruchomienie.anulowane

Występuje po anulowaniu przebiegu.

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
dane	runObject	Reprezentuje przebieg wykonywania w wątkach.	Tak
wydarzenie	ciąg		Tak

Dane: runObject

Wyliczenie zdarzeń: RunStreamEventCancelled

Wartość	Opis
wątek.uruchomienie.anulowane

---

wątek.wygasł

Występuje po wygaśnięciu przebiegu.

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
dane	runObject	Reprezentuje przebieg wykonywania w wątkach.	Tak
wydarzenie	ciąg		Tak

Dane: runObject

Wyliczenie zdarzeń: RunStreamEventExpired

Wartość	Opis
wątek.wygasł

---

runStepStreamEvent

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

wątek.uruchom.krok.utworzony

Występuje po utworzeniu kroku uruchamiania.

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
dane	runStepObject	Reprezentuje krok wykonywania przebiegu.	Tak
wydarzenie	ciąg		Tak

Dane: runStepObject

Wyliczenie zdarzeń: RunStepStreamEventCreated

Wartość	Opis
wątek.uruchom.krok.utworzony

---

wątek.uruchom.krok.w_trakcie

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

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
dane	runStepObject	Reprezentuje krok wykonywania przebiegu.	Tak
wydarzenie	ciąg		Tak

Dane: runStepObject

Wyliczenie zdarzeń: RunStepStreamEventInProgress

Wartość	Opis
wątek.uruchom.krok.w_trakcie

---

thread.run.step.delta

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

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
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

---

wątek.uruchom.krok.zakończony

Występuje po zakończeniu kroku uruchamiania.

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
dane	runStepObject	Reprezentuje krok wykonywania przebiegu.	Tak
wydarzenie	ciąg		Tak

Dane: runStepObject

Wyliczenie zdarzeń: RunStepStreamEventCompleted

Wartość	Opis
wątek.uruchom.krok.zakończony

---

wątek.uruchom.krok.niepowodzenie

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

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
dane	runStepObject	Reprezentuje krok wykonywania przebiegu.	Tak
wydarzenie	ciąg		Tak

Dane: runStepObject

Wyliczenie zdarzenia: RunStepStreamEventFailed

Wartość	Opis
wątek.uruchom.krok.niepowodzenie

---

wątek.uruchom.krok.anulowany

Występuje, gdy krok uruchomienia zostanie anulowany.

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
dane	runStepObject	Reprezentuje krok wykonywania przebiegu.	Tak
wydarzenie	ciąg		Tak

Dane: runStepObject

Wyliczenie zdarzeń: RunStepStreamEventCancelled

Wartość	Opis
wątek.uruchom.krok.anulowany

---

wątek.uruchom.krok.wygasł

Występuje, gdy krok uruchomienia wygaśnie.

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
dane	runStepObject	Reprezentuje krok wykonywania przebiegu.	Tak
wydarzenie	ciąg		Tak

Dane: runStepObject

Wyliczenie zdarzeń: RunStepStreamEventExpired

Wartość	Opis
wątek.uruchom.krok.wygasł

---

messageStreamEvent

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

wiadomość w wątku utworzona

Występuje po utworzeniu komunikatu.

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
dane	messageObject	Reprezentuje wiadomość w ramach wątków.	Tak
wydarzenie	ciąg		Tak

Dane: messageObject

Wyliczenie zdarzeń: MessageStreamEventCreated

Wartość	Opis
wiadomość w wątku utworzona

---

wiadomość wątku w toku

Występuje, gdy komunikat przechodzi do in_progress stanu.

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
dane	messageObject	Reprezentuje wiadomość w ramach wątków.	Tak
wydarzenie	ciąg		Tak

Dane: messageObject

Wyliczenie zdarzeń: MessageStreamEventInProgress

Wartość	Opis
wiadomość wątku w toku

---

wątek.wiadomość.delta

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

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
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
wątek.wiadomość.delta

---

wątek.wiadomość.zakończona

Występuje po zakończeniu komunikatu.

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
dane	messageObject	Reprezentuje wiadomość w ramach wątków.	Tak
wydarzenie	ciąg		Tak

Dane: messageObject

Wyliczenie zdarzeń: MessageStreamEventCompleted

Wartość	Opis
wątek.wiadomość.zakończona

---

wiadomość.wątek.niekompletny

Występuje, gdy komunikat kończy się przed jego ukończeniem.

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
dane	messageObject	Reprezentuje wiadomość w ramach wątków.	Tak
wydarzenie	ciąg		Tak

Dane: messageObject

Wyliczenie zdarzeń: MessageStreamEventIncomplete

Wartość	Opis
wiadomość.wątek.niekompletny

---

Adnotacja

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

• FileCitation
• Adres URL Cytowanie
• FilePath

Kliknij

Akcja kliknięcia.

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
guzik	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 click. 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	Wartość domyślna
Pliki	macierz		Tak
typ	wyliczenie	Typ danych wyjściowych pliku interpretera kodu. Zawsze files. Możliwe wartości: files	Tak

CodeInterpreterWynikTekstowy

Dane wyjściowe wywołania narzędzia interpretera kodu, które jest tekstem.

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
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	Wartość domyślna
identyfikatory_plików	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	Wartość domyślna
kod	ciąg	Kod do uruchomienia.	Tak
id	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

WynikNarzędziaInterpretacjiKodów

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	Wartość domyślna
klucz	ciąg	Klucz do porównania z wartością.	Tak
typ	wyliczenie	Określa operator porównania: eq, , ne, gtgte, lt, . lte - eq:Equals - 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	Wartość domyślna
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
• Przesuń
• Zrzut ekranu
• Przewijanie
• Typ
• Czekaj

ZdjęcieZrzutuEkranuKomputera

Obraz zrzutu ekranu komputera używany w narzędziu do obsługi komputera.

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
identyfikator_pliku	ciąg	Identyfikator przekazanego pliku zawierającego zrzut ekranu.	Nie.
image_url	ciąg	Adres URL obrazu zrzutu ekranu.	Nie.
typ	wyliczenie	Określa typ zdarzenia. W przypadku zrzutu ekranu komputera ta właściwość jest zawsze ustawiona na computer_screenshot. Możliwe wartości: computer_screenshot	Tak

ComputerTool

Narzędzie kontrolujące komputer wirtualny.

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
wysokość ekranu	Liczba	Wysokość wyświetlacza komputera.	Tak
szerokość_wyświetlacza	Liczba	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	Wartość domyślna
akcja	ComputerAction		Tak
identyfikator_rozmowy	ciąg	Identyfikator używany podczas odpowiadania na wywołanie narzędzia z danymi wyjściowymi.	Tak
id	ciąg	Unikatowy identyfikator wywołania komputera.	Tak
oczekujące_kontrole_bezpieczeństwa	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

WynikWywołaniaNarzędziaKomputerowego

Dane wyjściowe z wywołania narzędzia komputerowego.

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
uznane kontrole bezpieczeństwa	macierz	Kontrole bezpieczeństwa, które zostały zgłoszone przez interfejs API i potwierdzone przez dewelopera.	Nie.
identyfikator_rozmowy	ciąg	Identyfikator wywołania narzędzia komputerowego, które wygenerowało dane wyjściowe.	Tak
id	ciąg	Identyfikator wyniku wywołania komputerowego narzędzia.	Nie.
We/Wy	ComputerScreenshotImage	Obraz zrzutu ekranu komputera używany w narzędziu do obsługi 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	Nie.
typ	wyliczenie	Typ danych wyjściowych wywołania narzędzia komputerowego. Zawsze computer_call_output. Możliwe wartości: computer_call_output	Tak

ZasóbWyjściowyWywołaniaNarzędziaKomputerowego

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
uznane kontrole bezpieczeństwa	macierz	Kontrole bezpieczeństwa, które zostały zgłoszone przez interfejs API i potwierdzone przez dewelopera.	Nie.
identyfikator_rozmowy	ciąg	Identyfikator wywołania narzędzia komputerowego, które wygenerowało dane wyjściowe.	Tak
id	ciąg	Unikatowy identyfikator danych wyjściowych narzędzia do wywołań komputerowych.	Tak
We/Wy	ComputerScreenshotImage	Obraz zrzutu ekranu komputera używany w narzędziu do obsługi 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	Nie.
typ	wyliczenie	Typ danych wyjściowych wywołania narzędzia komputerowego. Zawsze computer_call_output. Możliwe wartości: computer_call_output	Tak

KomputeroweNarzędzieKontrolaBezpieczeństwa

Zaplanowana kontrola bezpieczeństwa dla komputerowego wezwania.

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
kod	ciąg	Typ oczekującego sprawdzenia bezpieczeństwa.	Tak
id	ciąg	Identyfikator oczekującego sprawdzenia bezpieczeństwa.	Tak
komunikat	ciąg	Szczegółowe informacje na temat nadchodzących kontroli bezpieczeństwa.	Tak

Zawartość

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ędna

Para współrzędnych x/y, np. { x: 100, y: 200 }.

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
x	liczba całkowita	Współrzędna x.	Tak
y	liczba całkowita	Współrzędna y.	Tak

UtwórzModelWłaściwościOdpowiedzi

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
metadane	Metadane	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.	Nie.
model	ciąg	Model używany do generowania odpowiedzi.	Nie.
temperatura	Liczba	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ędą bardziej skoncentrowane i deterministyczne. Ogólnie zalecamy zmienić to lub top_p, ale nie obu jednocześnie.	Nie.	1
top_p	Liczba	Alternatywa dla próbkowania z temperaturą, zwana próbkowaniem jądra, gdzie model uwzględnia wyniki tokenów z masą prawdopodobieństwa top_p. Dlatego 0,1 oznacza, że uwzględniane są tylko tokeny znajdujące się w górnych 10% masy prawdopodobieństwa. Ogólnie zalecamy zmienić to lub temperature, ale nie obu jednocześnie.	Nie.	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ć. .	Nie.

createResponse

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
zawierać	macierz	{"$ref": "#/components/schemas/includable/description"}	Nie.
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. Podczas używania previous_response_id, instrukcje z poprzedniej odpowiedzi nie zostaną przeniesione do następnej odpowiedzi. Ułatwia proste wymienianie komunikatów systemowych lub komunikatów od deweloperów w nowych odpowiedziach.	Nie.
max_output_tokens (maksymalna liczba tokenów wyjściowych)	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.	Nie.
wywołania_narzędzia_równoległe	typ logiczny (boolowski)	Czy zezwolić modelowi na równoległe uruchamianie wywołań narzędzi.	Nie.	Prawda
previous_response_id (identyfikator_poprzedniej_odpowiedzi)	ciąg	Unikatowy identyfikator poprzedniej odpowiedzi na model. Użyj tego, aby utworzyć wielokrotne konwersacje.	Nie.
Rozumowanie	Rozumowanie	Tylko modele serii o Opcje konfiguracji dla modeli rozumowania.	Nie.
przechowywać	typ logiczny (boolowski)	Określa, czy przechowywać wygenerowaną odpowiedź modelu na potrzeby późniejszego pobierania za pośrednictwem interfejsu API.	Nie.	Prawda
odtwarzać strumieniowo	typ logiczny (boolowski)	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.	Nie.	Nieprawda
SMS	obiekt	Opcje konfiguracji generowania odpowiedzi tekstowej przez model. Może to być zwykły tekst lub dane JSON ze strukturą. Więcej informacji: - wprowadzanie tekstu i dane wyjściowe - Ustrukturyzowane wyniki	Nie.
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 będzie zgodny z podanym schematem JSON. Domyślny format to { "type": "text" } bez żadnych dodatkowych opcji. Niezalecane w przypadku modeli gpt-4o i nowszych: Włączenie trybu { "type": "json_object" } aktywuje starszy tryb 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ą.	Nie.
wybór narzędzia	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.	Nie.
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 modelowi podać, to: - Wbudowane narzędzia	Nie.
Obcięcie	wyliczenie	Strategia obcinania, która ma być użyta dla odpowiedzi modelu. - auto: Jeśli kontekst tej odpowiedzi i poprzednich przekroczy rozmiar okna kontekstu modelu, model zostanie obcięty odpowiedź mająca na celu dostosowanie się do okna kontekstu poprzez pominięcie elementów wejściowych w środku rozmowy. - 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	Nie.

DoubleClick

Dwukrotne kliknięcie myszy.

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
typ	wyliczenie	Określa typ zdarzenia. W przypadku akcji dwukrotnego kliknięcia ta właściwość jest zawsze ustawiana jako double_click. 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

Czynność przeciągania.

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
ścieżka	macierz	Tablica współrzędnych reprezentujących ścieżkę operacji 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 ustawiana na drag. Możliwe wartości: drag	Tak

EasyInputMessage

Wiadomość jako wejście do modelu z rolą wskazującą przestrzeganie hierarchii instrukcji. Instrukcje przypisane do roli developer lub system mają pierwszeństwo przed instrukcjami przypisanymi do roli user. Przyjmuje się, że komunikaty z rolą assistant zostały wygenerowane przez model w poprzednich interakcjach.

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
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 wejścia 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	Nie.

Plik Cytowanie

Cytat do pliku.

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
identyfikator_pliku	ciąg	Identyfikator pliku.	Tak
indeks	liczba całkowita	Indeks pliku na liście plików.	Tak
typ	wyliczenie	Typ cytowania pliku. Zawsze file_citation. Możliwe wartości: file_citation	Tak

FilePath

Ścieżka do pliku.

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
identyfikator_pliku	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, system użyje klasyfikatora auto.

Majątek	Wartość
Opis	Klasyfikator używany do wyszukiwania plików. Jeśli nie zostanie określony, system użyje klasyfikatora auto.
Typ	ciąg
Wartości	auto default_2024_08_21

NarzędzieWyszukiwaniaPlików

Narzędzie wyszukujące odpowiednią zawartość z przekazanych plików.

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
filtry	Filtr porównawczy lub filtr złożony	Filtr do zastosowania na podstawie atrybutów pliku.	Nie.
maks_liczba_wyników	liczba całkowita	Maksymalna liczba wyników do zwrócenia. Ta liczba powinna należeć do zakresu od 1 do 50 włącznie.	Nie.
opcje rankingu	obiekt	Opcje klasyfikacji wyszukiwania.	Nie.
└─ ranker	wyliczenie	Klasyfikator używany do wyszukiwania plików. Możliwe wartości: auto, default-2024-11-15	Nie.
└─ próg_punktowy	Liczba	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.	Nie.	0
typ	wyliczenie	Typ narzędzia wyszukiwania plików. Zawsze file_search. Możliwe wartości: file_search	Tak
identyfikatory_sklepu_wektorów	macierz	Identyfikatory wektorów są przechowywane do wyszukiwania.	Tak

FileSearchToolCall

Wyniki wywołania narzędzia wyszukiwania plików.

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
id	ciąg	Unikatowy identyfikator wywołania narzędzia wyszukiwania plików.	Tak
— zapytania	macierz	Zapytania używane do wyszukiwania plików.	Tak
Wyniki	macierz	Wyniki wywołania narzędzia wyszukiwania plików.	Nie.
stan	wyliczenie	Stan wywołania narzędzia do 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ę w swoim kodzie, którą model może wywołać.

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
opis	ciąg	Opis funkcji. Używany przez model do określania, czy wywołać funkcję.	Nie.
nazwa	ciąg	Nazwa funkcji do wywołania.	Tak
Parametry	obiekt	Obiekt schematu JSON opisujący parametry funkcji.	Tak
surowy	typ logiczny (boolowski)	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	Wartość domyślna
Argumenty	ciąg	Łańcuch JSON zawierający argumenty do przekazania do funkcji.	Tak
identyfikator_rozmowy	ciąg	Unikalny identyfikator wywołania funkcji narzędzia wygenerowany przez model.	Tak
id	ciąg	Unikatowy identyfikator wywołania narzędzia funkcjonalnego.	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	Nie.
typ	wyliczenie	Typ wywołania funkcji narzędziowej. Zawsze function_call. Możliwe wartości: function_call	Tak

FunctionToolCallOutput

Dane wyjściowe wywołania narzędzia funkcji.

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
identyfikator_rozmowy	ciąg	Unikalny identyfikator wywołania funkcji narzędzia wygenerowany przez model.	Tak
id	ciąg	Unikatowy identyfikator danych wyjściowych wywołania narzędzia funkcji. Wypełniane, gdy ten element jest zwracany za pośrednictwem interfejsu API.	Nie.
We/Wy	ciąg	Ciąg JSON zawierający dane wyjściowe z 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	Nie.
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	Wartość domyślna
identyfikator_rozmowy	ciąg	Unikalny identyfikator wywołania funkcji narzędzia wygenerowany przez model.	Tak
id	ciąg	Unikatowy identyfikator danych wyjściowych narzędzia wywołania funkcji.	Tak
We/Wy	ciąg	Ciąg JSON zawierający dane wyjściowe z 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	Nie.
typ	wyliczenie	Typ danych wyjściowych wywołania narzędzia funkcji. Zawsze function_call_output. Możliwe wartości: function_call_output	Tak

możliwy do włączenia

Określ dodatkowe dane wyjściowe do uwzględnienia w odpowiedzi modelu. Obecnie obsługiwane wartości to:

• file_search_call.results: uwzględnij wyniki operacji narzędzia do 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 wyniku wywołania komputera.

Majątek	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 uzyskane z wezwania narzędzia do 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 wyników procesu komputerowego.
Typ	ciąg
Wartości	file_search_call.results message.input_image.image_url computer_call_output.output.image_url

Dźwięk wejściowy

Dane audio jako wejście do modelu.

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
dane	ciąg	Dane audio zakodowane w formacie Base64.	Tak
formatowanie	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

Zawartość wejściowa

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

• Tekst wejściowy
• InputImage
• InputFile

Plik wejściowy

Plik wejściowy do modelu.

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
dane_pliku	ciąg	Zawartość pliku, który ma zostać wysłany do modelu.	Nie.
identyfikator_pliku	ciąg	Identyfikator pliku, który ma zostać wysłany do modelu.	Nie.
nazwa pliku	ciąg	Nazwa pliku, który ma zostać wysłany do modelu.	Nie.
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	Wartość domyślna
szczegóły	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
identyfikator_pliku	ciąg	Identyfikator pliku, który ma zostać wysłany do modelu.	Nie.
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.	Nie.
typ	wyliczenie	Typ elementu wejściowego. Zawsze input_image. Możliwe wartości: input_image	Tak

ElementWejściowy

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

• EasyInputMessage
• Produkt
• ItemReference

WiadomośćWejściowa

Wiadomość jako wejście do modelu z rolą wskazującą przestrzeganie hierarchii instrukcji. Instrukcje przypisane do roli developer lub system mają pierwszeństwo przed instrukcjami przypisanymi do roli user.

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
zawartość	ListaTreściWiadomościWejściowych	Lista jednego lub wielu elementów wejściowych do modelu zawierająca inną zawartość Typy.	Tak
rola	wyliczenie	Rola wejścia 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	Nie.
typ	wyliczenie	Typ danych wejściowych komunikatu. Zawsze ustaw na message. Możliwe wartości: message	Nie.

Lista Zawartości Wejściowej Wiadomości

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.

ZasóbWiadomościWejściowej

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
zawartość	ListaTreściWiadomościWejściowych	Lista jednego lub wielu elementów wejściowych do modelu zawierająca inną zawartość Typy.	Tak
id	ciąg	Unikatowy identyfikator wejściowy wiadomości.	Tak
rola	wyliczenie	Rola wejścia 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	Nie.
typ	wyliczenie	Typ danych wejściowych komunikatu. Zawsze ustaw na message. Możliwe wartości: message	Nie.

Tekst wejściowy

Wprowadzanie tekstu do modelu.

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
SMS	ciąg	Wprowadzanie tekstu do modelu.	Tak
typ	wyliczenie	Typ elementu wejściowego. Zawsze input_text. Możliwe wartości: input_text	Tak

Przedmiot

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
• Element uzasadnienia

Odwołanie do artykułu

Wewnętrzny identyfikator elementu do celów odniesienia.

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
id	ciąg	Identyfikator elementu referencyjnego.	Tak
typ	wyliczenie	Typ elementu referencyjnego. Zawsze item_reference. Możliwe wartości: item_reference	Tak

ZasóbElement

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 naciśnięć klawiszy, które model chciałby wykonać.

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
klucze	macierz	Kombinacja klawiszy, którą 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 wartość keypress. Możliwe wartości: keypress	Tak

Metadane

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.

WłaściwościModeluOdpowiedzi

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
metadane	Metadane	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.	Nie.
model	ciąg	Model używany do generowania odpowiedzi.	Nie.
temperatura	Liczba	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ędą bardziej skoncentrowane i deterministyczne. Ogólnie zalecamy zmienić to lub top_p, ale nie obu jednocześnie.	Nie.	1
top_p	Liczba	Alternatywa dla próbkowania z temperaturą, zwana próbkowaniem jądra, gdzie model uwzględnia wyniki tokenów z masą prawdopodobieństwa top_p. Dlatego 0,1 oznacza, że uwzględniane są tylko tokeny znajdujące się w górnych 10% masy prawdopodobieństwa. Ogólnie zalecamy zmienić to lub temperature, ale nie obu jednocześnie.	Nie.	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ć. .	Nie.

Poruszaj

Akcja ruchu myszy.

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
typ	wyliczenie	Określa typ zdarzenia. W przypadku akcji przenoszenia ta właściwość jest zawsze ustawiona na move. Możliwe wartości: move	Tak
x	liczba całkowita	Współrzędna x, do której należy się przesunąć.	Tak
y	liczba całkowita	Współrzędna y, do której należy się przesunąć.	Tak

Wyjściowy dźwięk

Sygnał wyjściowy audio z modelu.

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
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

ZawartośćWyniku

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

• Tekst wyjściowy
• Odmowa

Element Wyjścia

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
akcja	ComputerAction		Tak
Argumenty	ciąg	Łańcuch JSON zawierający argumenty do przekazania do funkcji.	Tak
identyfikator_rozmowy	ciąg	Identyfikator używany podczas odpowiadania na wywołanie narzędzia z danymi wyjściowymi.	Tak
zawartość	macierz	Analiza zawartości tekstu.	Tak
id	ciąg	Unikatowy identyfikator zawartości rozumowania.	Tak
nazwa	ciąg	Nazwa funkcji do uruchomienia.	Tak
oczekujące_kontrole_bezpieczeństwa	macierz	Oczekujące kontrole bezpieczeństwa dla wywołania komputera.	Tak
— zapytania	macierz	Zapytania używane do wyszukiwania plików.	Tak
Wyniki	macierz	Wyniki wywołania narzędzia wyszukiwania plików.	Nie.
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

WiadomośćWyjściowa

Komunikat wyjściowy z modelu.

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
zawartość	macierz	Zawartość komunikatu wyjściowego.	Tak
id	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	Wartość domyślna
Adnotacje	macierz	Adnotacje tekstu wyjściowego.	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

Żądanie utworzenia sesji w czasie rzeczywistym (RealtimeSessionCreateRequest)

Konfiguracja obiektu sesji w czasie rzeczywistym.

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
format_dźwięku_wejściowego	wyliczenie	Format wejściowego dźwięku. Opcje to pcm16, g711_ulawlub g711_alaw. W przypadku pcm16 dźwięk wejściowy musi być w formacie 16-bitowego PCM z częstotliwością próbkowania 24 kHz, z pojedynczym kanałem (mono) i w kolejności bajtów małobitowej. Możliwe wartości: pcm16, , g711_ulawg711_alaw	Nie.
redukcja szumów w sygnale wejściowym audio	obiekt	Konfiguracja redukcji szumu dźwięku wejściowego. Można to ustawić tak, null aby wyłączyć. Filtry redukcji szumów przetwarzają dźwięk dodany do wejściowego bufora audio, zanim zostanie on wysłany do usługi VAD i modelu. Filtrowanie dźwięku może poprawić dokładność wykrywania VAD i zmian (zmniejszając liczbę fałszywie dodatnich wyników) oraz poprawić wydajność modelu poprzez polepszenie postrzegania dźwięku wejściowego.	Nie.
└typ	wyliczenie	Typ redukcji szumu. near_field jest przeznaczony dla mikrofonów kierunkowych, takich jak te w słuchawkach, podczas gdy far_field jest przeznaczony dla mikrofonów dalekiego pola, takich jak te w laptopie lub w salach konferencyjnych. Możliwe wartości: near_field, far_field	Nie.
transkrypcja_audio_wejściowa	obiekt	Konfiguracja transkrypcji dźwięku wejściowego, domyślnie wyłączona i może być ustawiona na null, aby wyłączyć po włączeniu. 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 ma możliwość ustawienia języka oraz wybrania opcji monitowania o transkrypcję, co zapewnia dodatkowe wskazówki dla usługi transkrypcyjnej.	Nie.
└* język	ciąg	Język wejściowego dźwięku. Podanie języka wejściowego w formacie ISO-639-1 (np. en) poprawi dokładność i opóźnienie.	Nie.
└─ model	ciąg	Model do użycia do transkrypcji, bieżące opcje to gpt-4o-transcribe, gpt-4o-mini-transcribei whisper-1.	Nie.
Zachęta └*	ciąg	Opcjonalny tekst wskazujący styl modelu lub jako kontynuacja poprzedniego segmentu audio. W przypadku whisper-1 polecenie to lista słów kluczowych. W przypadku gpt-4o-transcribe modeli instrukcja jest wolnym ciągiem tekstowym, na przykład "oczekuj słów związanych z technologią".	Nie.
instrukcje	ciąg	Domyślne instrukcje systemowe (tj. komunikat systemowy) są poprzedzane wywołaniami modelu. To pole umożliwia klientowi kierowanie odpowiedziami modelu w pożądany sposób. 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 gwarantują, że będą przestrzegane przez model, ale zapewniają przewodnictwo dotyczące pożądanego zachowania modelu. 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.	Nie.
maksymalna_liczba_tokenów_odpowiedzi	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ć liczbę tokenów wyjściowych, lub użyj inf dla maksymalnej liczby dostępnych tokenów dla danego modelu. Wartość domyślna to inf.	Nie.
Sposoby		Zestaw modalności, za pomocą których model może reagować. Aby wyłączyć dźwięk, ustaw wartość ["text"].	Nie.
model	ciąg	Nazwa wdrożenia używanego na potrzeby tej sesji.	Nie.
format_wyjściowy_dźwięku	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	Nie.
temperatura	Liczba	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.	Nie.	0,8
wybór narzędzia	ciąg	W jaki sposób model wybiera narzędzia. Opcje to auto, none, requiredlub określają funkcję.	Nie.	samochód
narzędzia	macierz	Narzędzia (funkcje) dostępne dla modelu.	Nie.
wykrywanie zakrętów	obiekt	Konfiguracja wykrywania zmian, albo Server VAD lub Semantic VAD. Można ustawić to na null aby wyłączyć, co spowoduje, że klient będzie musiał 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 zmiany mówcy (w połączeniu z VAD), aby semantycznie oszacować, czy użytkownik skończył mówić, a następnie dynamicznie określa limit czasu na podstawie tego prawdopodobieństwa. Na przykład, jeśli dźwięk użytkownika zacznie zanikać uhhm, model oceni niskie prawdopodobieństwo zakończenia wypowiedzi i poczeka dłużej na to, aby użytkownik kontynuował mowę. Może to być przydatne w przypadku bardziej naturalnych rozmów, ale może mieć większe opóźnienie.	Nie.
└─ create_response	typ logiczny (boolowski)	Określenie, czy odpowiedź powinna być automatycznie generowana po wystąpieniu zdarzenia zatrzymania VAD.	Nie.	Prawda
└* 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	Nie.
└reakcja_na_przerwanie	typ logiczny (boolowski)	Określa, czy automatycznie przerywać bieżącą odpowiedź na rzecz wyjścia do domyślnej konwersacji (tj. conversation) po wystąpieniu zdarzenia rozpoczęcia VAD (tj. auto).	Nie.	Prawda
└─prefix_padding_ms	liczba całkowita	Używane tylko w server_vad trybie. Ilość dźwięku do uwzględnienia przed wykryciem mowy przez VAD (w milisekundach). Wartość domyślna to 300 ms.	Nie.
└czas_trwania_ciszy_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.	Nie.
└* próg	Liczba	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.	Nie.
└typ	wyliczenie	Typ wykrywania zakrętów. Możliwe wartości: server_vad, semantic_vad	Nie.
głos	VoiceIdsShared		Nie.

RealtimeSessionCreateResponse

Nowa konfiguracja sesji w czasie rzeczywistym z kluczem efemerycznym. Domyślny czas wygaśnięcia kluczy to jedna minuta.

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
tajemnica klienta	obiekt	Klucz efemeryczny zwrócony przez API.	Tak
└─ wygasa_o	liczba całkowita	Sygnatura czasowa dla czasu wygaśnięcia tokenu. Obecnie wszystkie tokeny wygasają po jednej minucie.	Nie.
└─ 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, zamiast standardowego tokena interfejsu API, którego należy używać tylko po stronie serwera.	Nie.
format_dźwięku_wejściowego	ciąg	Format wejściowego dźwięku. Opcje to pcm16, g711_ulawlub g711_alaw.	Nie.
transkrypcja_audio_wejściowa	obiekt	Konfiguracja transkrypcji dźwięku wejściowego, domyślnie wyłączona i może być ustawiona na null, aby wyłączyć po włączeniu. Transkrypcja audio wejściowego nie jest natywna dla modelu, ponieważ model korzysta bezpośrednio z dźwięku. Transkrypcja jest uruchamiana asynchronicznie przez Whisper i powinna być traktowana jako orientacyjna wskazówka, a nie reprezentacja rozumiana przez model.	Nie.
└─ model	ciąg	Model używany do transkrypcji whisper-1 jest jedynym obecnie obsługiwanym modelem.	Nie.
instrukcje	ciąg	Domyślne instrukcje systemowe (tj. komunikat systemowy) są poprzedzane wywołaniami modelu. To pole umożliwia klientowi kierowanie odpowiedziami modelu w pożądany sposób. Model może być poinstruowany na temat zawartości i formatu odpowiedzi (np. "bądź bardzo zwięzły", "bądź przyjazny", "oto przykłady dobrych odpowiedzi") oraz dotyczące zachowania audio (np. "mów szybko", "wkładaj emocje w swój głos", "śmiej się często"). Instrukcje nie gwarantują, że będą przestrzegane przez model, ale zapewniają przewodnictwo dotyczące pożądanego zachowania modelu. 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.	Nie.
maksymalna_liczba_tokenów_odpowiedzi	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ć liczbę tokenów wyjściowych, lub użyj inf dla maksymalnej liczby dostępnych tokenów dla danego modelu. Wartość domyślna to inf.	Nie.
Sposoby		Zestaw modalności, za pomocą których model może reagować. Aby wyłączyć dźwięk, ustaw wartość ["text"].	Nie.
format_wyjściowy_dźwięku	ciąg	Format dźwięku wyjściowego. Opcje to pcm16, g711_ulawlub g711_alaw.	Nie.
temperatura	Liczba	Temperatura próbkowania dla modelu ograniczona do [0.6, 1.2]. Wartość domyślna to 0.8.	Nie.
wybór narzędzia	ciąg	W jaki sposób model wybiera narzędzia. Opcje to auto, none, requiredlub określają funkcję.	Nie.
narzędzia	macierz	Narzędzia (funkcje) dostępne dla modelu.	Nie.
wykrywanie zakrętów	obiekt	Konfiguracja wykrywania obrotu. null można ustawić, aby 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.	Nie.
└─prefix_padding_ms	liczba całkowita	Ilość dźwięku do uwzględnienia przed wykryciem mowy przez VAD (w milisekundach). Wartość domyślna to 300 ms.	Nie.
└czas_trwania_ciszy_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.	Nie.
└* próg	Liczba	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.	Nie.
└typ	ciąg	Typ wykrywania skrętu, obecnie obsługiwany jest tylko server_vad.	Nie.
głos	VoiceIdsShared		Nie.

ŻądanieUtworzeniaSesjiTranskrypcjiW czasieRzeczywistym

Konfiguracja obiektu sesji transkrypcji w czasie rzeczywistym.

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
zawierać	macierz	Zestaw elementów do uwzględnienia w transkrypcji. Bieżące dostępne elementy to: - item.input_audio_transcription.logprobs	Nie.
format_dźwięku_wejściowego	wyliczenie	Format wejściowego dźwięku. Opcje to pcm16, g711_ulawlub g711_alaw. W przypadku pcm16 dźwięk wejściowy musi być w formacie 16-bitowego PCM z częstotliwością próbkowania 24 kHz, z pojedynczym kanałem (mono) i w kolejności bajtów małobitowej. Możliwe wartości: pcm16, , g711_ulawg711_alaw	Nie.
redukcja szumów w sygnale wejściowym audio	obiekt	Konfiguracja redukcji szumu dźwięku wejściowego. Można to ustawić tak, null aby wyłączyć. Filtry redukcji szumów przetwarzają dźwięk dodany do wejściowego bufora audio, zanim zostanie on wysłany do usługi VAD i modelu. Filtrowanie dźwięku może poprawić dokładność wykrywania VAD i zmian (zmniejszając liczbę fałszywie dodatnich wyników) oraz poprawić wydajność modelu poprzez polepszenie postrzegania dźwięku wejściowego.	Nie.
└typ	wyliczenie	Typ redukcji szumu. near_field jest przeznaczony dla mikrofonów kierunkowych, takich jak te w słuchawkach, podczas gdy far_field jest przeznaczony dla mikrofonów dalekiego pola, takich jak te w laptopie lub w salach konferencyjnych. Możliwe wartości: near_field, far_field	Nie.
transkrypcja_audio_wejściowa	obiekt	Konfiguracja transkrypcji dźwięku wejściowego. Klient ma możliwość ustawienia języka oraz wybrania opcji monitowania o transkrypcję, co zapewnia dodatkowe wskazówki dla usługi transkrypcyjnej.	Nie.
└* język	ciąg	Język wejściowego dźwięku. Podanie języka wejściowego w formacie ISO-639-1 (np. en) poprawi dokładność i opóźnienie.	Nie.
└─ model	wyliczenie	Model do użycia do transkrypcji, bieżące opcje to gpt-4o-transcribe, gpt-4o-mini-transcribei whisper-1. Możliwe wartości: gpt-4o-transcribe, , gpt-4o-mini-transcribewhisper-1	Nie.
Zachęta └*	ciąg	Opcjonalny tekst wskazujący styl modelu lub jako kontynuacja poprzedniego segmentu audio. W przypadku whisper-1 polecenie to lista słów kluczowych. W przypadku gpt-4o-transcribe modeli instrukcja jest wolnym ciągiem tekstowym, na przykład "oczekuj słów związanych z technologią".	Nie.
Sposoby		Zestaw modalności, za pomocą których model może reagować. Aby wyłączyć dźwięk, ustaw wartość ["text"].	Nie.
wykrywanie zakrętów	obiekt	Konfiguracja wykrywania zmian, albo Server VAD lub Semantic VAD. Można ustawić to na null aby wyłączyć, co spowoduje, że klient będzie musiał 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 zmiany mówcy (w połączeniu z VAD), aby semantycznie oszacować, czy użytkownik skończył mówić, a następnie dynamicznie określa limit czasu na podstawie tego prawdopodobieństwa. Na przykład, jeśli dźwięk użytkownika zacznie zanikać uhhm, model oceni niskie prawdopodobieństwo zakończenia wypowiedzi i poczeka dłużej na to, aby użytkownik kontynuował mowę. Może to być przydatne w przypadku bardziej naturalnych rozmów, ale może mieć większe opóźnienie.	Nie.
└─ create_response	typ logiczny (boolowski)	Określenie, czy odpowiedź powinna być automatycznie generowana po wystąpieniu zdarzenia zatrzymania VAD. Niedostępne dla sesji transkrypcji.	Nie.	Prawda
└* 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	Nie.
└reakcja_na_przerwanie	typ logiczny (boolowski)	Określa, czy automatycznie przerywać bieżącą odpowiedź na rzecz wyjścia do domyślnej konwersacji (tj. conversation) po wystąpieniu zdarzenia rozpoczęcia VAD (tj. auto). Niedostępne dla sesji transkrypcji.	Nie.	Prawda
└─prefix_padding_ms	liczba całkowita	Używane tylko w server_vad trybie. Ilość dźwięku do uwzględnienia przed wykryciem mowy przez VAD (w milisekundach). Wartość domyślna to 300 ms.	Nie.
└czas_trwania_ciszy_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.	Nie.
└* próg	Liczba	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.	Nie.
└typ	wyliczenie	Typ wykrywania zakrętów. Możliwe wartości: server_vad, semantic_vad	Nie.

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	Wartość domyślna
tajemnica klienta	obiekt	Klucz efemeryczny zwrócony przez API. Występuje tylko wtedy, gdy sesja jest tworzona na serwerze za pośrednictwem interfejsu API REST.	Tak
└─ wygasa_o	liczba całkowita	Sygnatura czasowa dla czasu wygaśnięcia tokenu. Obecnie wszystkie tokeny wygasają po jednej minucie.	Nie.
└─ 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, zamiast standardowego tokena interfejsu API, którego należy używać tylko po stronie serwera.	Nie.
format_dźwięku_wejściowego	ciąg	Format wejściowego dźwięku. Opcje to pcm16, g711_ulawlub g711_alaw.	Nie.
transkrypcja_audio_wejściowa	obiekt	Konfiguracja modelu transkrypcji.	Nie.
└* język	ciąg	Język wejściowego dźwięku. Podanie języka wejściowego w formacie ISO-639-1 (np. en) poprawi dokładność i opóźnienie.	Nie.
└─ model	wyliczenie	Model używany do transkrypcji. Może to być gpt-4o-transcribe, gpt-4o-mini-transcribelub whisper-1. Możliwe wartości: gpt-4o-transcribe, , gpt-4o-mini-transcribewhisper-1	Nie.
Zachęta └*	ciąg	Opcjonalny tekst wskazujący styl modelu lub jako kontynuacja poprzedniego segmentu audio. Komunikat powinien być zgodny z językiem dźwięku.	Nie.
Sposoby		Zestaw modalności, za pomocą których model może reagować. Aby wyłączyć dźwięk, ustaw wartość ["text"].	Nie.
wykrywanie zakrętów	obiekt	Konfiguracja wykrywania obrotu. null można ustawić, aby 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.	Nie.
└─prefix_padding_ms	liczba całkowita	Ilość dźwięku do uwzględnienia przed wykryciem mowy przez VAD (w milisekundach). Wartość domyślna to 300 ms.	Nie.
└czas_trwania_ciszy_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.	Nie.
└* próg	Liczba	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.	Nie.
└typ	ciąg	Typ wykrywania skrętu, obecnie obsługiwany jest tylko server_vad.	Nie.

Rozumowanie

Tylko modele serii o

Opcje konfiguracji dla modeli rozumowania.

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
nakład pracy	WysiłekRozumowania	Tylko modele serii o 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	Tylko modele serii o 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	Nie.

Element Rozumowania

Opis łańcucha myśli używanego przez model rozumowania podczas generowania odpowiedzi.

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
zawartość	macierz	Analiza zawartości tekstu.	Tak
id	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	Nie.
typ	wyliczenie	Typ obiektu. Zawsze reasoning. Możliwe wartości: reasoning	Tak

Odmowa

Odmowa ze strony modelu.

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
odmowa	ciąg	Wyjaśnienie odmowy dostarczone przez model.	Tak
typ	wyliczenie	Rodzaj odmowy. Zawsze refusal. Możliwe wartości: refusal	Tak

odpowiedź

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
utworzono_o	Liczba	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
id	ciąg	Unikatowy identyfikator tej odpowiedzi.	Tak
niepełne szczegóły	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	Nie.
instrukcje	ciąg	Wstawia komunikat systemu (lub dewelopera) jako pierwszy element w kontekście modelu. Podczas używania previous_response_id, instrukcje z poprzedniej odpowiedzi nie zostaną przeniesione do następnej odpowiedzi. Ułatwia proste wymienianie komunikatów systemowych lub komunikatów od deweloperów w nowych odpowiedziach.	Tak
max_output_tokens (maksymalna liczba tokenów wyjściowych)	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.	Nie.
metadane	Metadane	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 response. 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
tekst wyjściowy	ciąg	Właściwość przeznaczona tylko dla zestawu SDK, która zawiera zagregowane dane wyjściowe tekstu ze wszystkich elementów w tablicy output_text, jeśli takowe istnieją. Obsługiwane w zestawach SDK python i JavaScript.	Nie.
wywołania_narzędzia_równoległe	typ logiczny (boolowski)	Czy zezwolić modelowi na równoległe uruchamianie wywołań narzędzi.	Tak	Prawda
previous_response_id (identyfikator_poprzedniej_odpowiedzi)	ciąg	Unikatowy identyfikator poprzedniej odpowiedzi na model. Użyj tego, aby utworzyć wielokrotne konwersacje.	Nie.
Rozumowanie	Rozumowanie	Tylko modele serii o Opcje konfiguracji dla modeli rozumowania.	Nie.
stan	wyliczenie	Stan generowania odpowiedzi. completedJeden z , failed, in_progresslub incomplete. Możliwe wartości: completed, , failed, in_progressincomplete	Nie.
temperatura	Liczba	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ędą bardziej skoncentrowane i deterministyczne. Ogólnie zalecamy zmienić to lub top_p, ale nie obu jednocześnie.	Tak	1
SMS	obiekt	Opcje konfiguracji generowania odpowiedzi tekstowej przez model. Może to być zwykły tekst lub dane JSON ze strukturą. Więcej informacji: - wprowadzanie tekstu i dane wyjściowe - Ustrukturyzowane wyniki	Nie.
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 będzie zgodny z podanym schematem JSON. Domyślny format to { "type": "text" } bez żadnych dodatkowych opcji. Niezalecane w przypadku modeli gpt-4o i nowszych: Włączenie trybu { "type": "json_object" } aktywuje starszy tryb 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ą.	Nie.
wybór narzędzia	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 modelowi podać, to: - Wbudowane narzędzia	Tak
top_p	Liczba	Alternatywa dla próbkowania z temperaturą, zwana próbkowaniem jądra, gdzie model uwzględnia wyniki tokenów z masą prawdopodobieństwa top_p. Dlatego 0,1 oznacza, że uwzględniane są tylko tokeny znajdujące się w górnych 10% masy prawdopodobieństwa. Ogólnie zalecamy zmienić to lub temperature, ale nie obu jednocześnie.	Tak	1
Obcięcie	wyliczenie	Strategia obcinania, która ma być użyta 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	Nie.
użycie	Użycie odpowiedzi	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.	Nie.
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ć. .	Nie.

ResponseAudioDeltaEvent

Występuje w przypadku częściowej odpowiedzi głosowej.

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
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

ZdarzenieZakończeniaOdtwarzaniaDźwięku

Emitowane po zakończeniu odpowiedzi audio.

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
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	Wartość domyślna
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

ZdarzenieTranskrypcjiDźwiękowejGotoweOdpowiedzi

Emitowany po zakończeniu pełnej transkrypcji audio.

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
typ	wyliczenie	Typ zdarzenia. Zawsze response.audio.transcript.done. Możliwe wartości: response.audio.transcript.done	Tak

Tłumaczenie kodu odpowiedzi Wywołanie interpretera zdarzenia Delta kodu

Emitowane, gdy częściowy fragment kodu jest dodawany przez interpreter kodu.

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
delta	ciąg	Fragment kodu dodany przez interpreter kodu.	Tak
indeks_wyjściowy	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

Zdarzenie zakończenia kodu w interpretorze kodu odpowiedzi

Emitowane, gdy dane wyjściowe fragmentu kodu są finalizowane przez interpreter kodu.

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
kod	ciąg	Ostateczny wynik fragmentu kodu generowany przez interpretatora kodu.	Tak
indeks_wyjściowy	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	Wartość domyślna
wywołanie interpretera kodu	CodeInterpreterToolCall	Wywołanie narzędzia w celu uruchomienia kodu.	Tak
indeks_wyjściowy	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	Wartość domyślna
wywołanie interpretera kodu	CodeInterpreterToolCall	Wywołanie narzędzia w celu uruchomienia kodu.	Tak
indeks_wyjściowy	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

KodOdpowiedziInterpreterWezwanieTłumaczeniaWydarzenie

Emitowane, gdy interpreter kodu aktywnie interpretuje fragment kodu.

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
wywołanie interpretera kodu	CodeInterpreterToolCall	Wywołanie narzędzia w celu uruchomienia kodu.	Tak
indeks_wyjściowy	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

ZdarzenieZakończeniaOdpowiedzi

Emitowane po zakończeniu odpowiedzi modelu.

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
odpowiedź	odpowiedź		Tak
typ	wyliczenie	Typ zdarzenia. Zawsze response.completed. Możliwe wartości: response.completed	Tak

ZdarzenieDodanoCzęśćTreściOdpowiedzi

Emitowane po dodaniu nowej części zawartości.

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
indeks_treści	liczba całkowita	Indeks dodanej części zawartości.	Tak
Identyfikator przedmiotu	ciąg	Identyfikator elementu wyjściowego, do którego została dodana część zawartości.	Tak
indeks_wyjściowy	liczba całkowita	Indeks elementu wyjściowego, do którego została dodana część zawartości.	Tak
część	OutputContent		Tak
typ	wyliczenie	Typ zdarzenia. Zawsze response.content_part.added. Możliwe wartości: response.content_part.added	Tak

ZdarzenieZakończeniaCzęściTreściOdpowiedzi (ResponseContentPartDoneEvent)

Emitowane po zakończeniu części zawartości.

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
indeks_treści	liczba całkowita	Indeks części zawartości, która jest ukończona.	Tak
Identyfikator przedmiotu	ciąg	Identyfikator elementu wyjściowego, do którego została dodana część zawartości.	Tak
indeks_wyjściowy	liczba całkowita	Indeks elementu wyjściowego, do którego została dodana część zawartości.	Tak
część	OutputContent		Tak
typ	wyliczenie	Typ zdarzenia. Zawsze response.content_part.done. Możliwe wartości: response.content_part.done	Tak

ZdarzenieOdpowiedziUtworzone

Zdarzenie emitowane podczas tworzenia odpowiedzi.

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
odpowiedź	odpowiedź		Tak
typ	wyliczenie	Typ zdarzenia. Zawsze response.created. Możliwe wartości: response.created	Tak

Błąd odpowiedzi

Obiekt błędu zwracany, gdy model nie może wygenerować odpowiedzi.

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
kod	ResponseErrorCode	Kod błędu odpowiedzi.	Tak
komunikat	ciąg	Czytelny dla człowieka opis błędu.	Tak

KodBłęduOdpowiedzi

Kod błędu odpowiedzi.

Majątek	Wartość
Opis	Kod błędu odpowiedzi.
Typ	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

ZdarzenieBłęduOdpowiedzi

Emitowane w przypadku wystąpienia błędu.

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
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

ZdarzenieNiepowodzeniaOdpowiedzi

Zdarzenie emitowane w przypadku niepowodzenia odpowiedzi.

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
odpowiedź	odpowiedź		Tak
typ	wyliczenie	Typ zdarzenia. Zawsze response.failed. Możliwe wartości: response.failed	Tak

ZdarzenieZakończeniaWyszukiwaniaPlikuPołączenia

Emitowane po zakończeniu wywołania wyszukiwania plików (znaleziono wyniki).

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
Identyfikator przedmiotu	ciąg	Identyfikator elementu wyjściowego, dla którego zainicjowano wywołanie wyszukiwania plików.	Tak
indeks_wyjściowy	liczba całkowita	Indeks elementu wyjściowego, dla którego zainicjowano 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	Wartość domyślna
Identyfikator przedmiotu	ciąg	Identyfikator elementu wyjściowego, dla którego zainicjowano wywołanie wyszukiwania plików.	Tak
indeks_wyjściowy	liczba całkowita	Indeks elementu wyjściowego, dla którego zainicjowano 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

ZdarzenieWyszukiwaniaPlikuOdpowiedziCallSearching

Emitowane, gdy wyszukiwanie plików jest obecnie przeszukiwane.

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
Identyfikator przedmiotu	ciąg	Identyfikator elementu wyjściowego, dla którego zainicjowano wywołanie wyszukiwania plików.	Tak
indeks_wyjściowy	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, gdy występuje różnica w argumentach wywołania funkcji częściowej.

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
delta	ciąg	Dodano argument delta w wywołaniu funkcji.	Tak
Identyfikator przedmiotu	ciąg	Identyfikator elementu wyjściowego, do którego dodano różnicę argumentów wywołania funkcji.	Tak
indeks_wyjściowy	liczba całkowita	Indeks elementu wyjściowego do którego zostanie dodana różnica w argumentach wywołania funkcji.	Tak
typ	wyliczenie	Typ zdarzenia. Zawsze response.function_call_arguments.delta. Możliwe wartości: response.function_call_arguments.delta	Tak

ZdarzenieZakończeniaArgumentówWywołaniaFunkcjiOdpowiedzi

Emitowane, gdy argumenty wywołania funkcji są finalizowane.

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
Argumenty	ciąg	Argumenty wywołania funkcji.	Tak
Identyfikator przedmiotu	ciąg	Identyfikator elementu.	Tak
indeks_wyjściowy	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	Wartość domyślna
odpowiedź	odpowiedź		Tak
typ	wyliczenie	Typ zdarzenia. Zawsze response.in_progress. Możliwe wartości: response.in_progress	Tak

NiekompletneZdarzenieOdpowiedzi

Zdarzenie emitowane, gdy odpowiedź jest zakończona jako niekompletna.

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
odpowiedź	odpowiedź		Tak
typ	wyliczenie	Typ zdarzenia. Zawsze response.incomplete. Możliwe wartości: response.incomplete	Tak

listaElementówOdpowiedzi

Lista elementów odpowiedzi.

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
dane	macierz	Lista elementów używanych do wygenerowania tej odpowiedzi.	Tak
first_id	ciąg	Identyfikator pierwszego elementu na liście.	Tak
zawiera_więcej	typ logiczny (boolowski)	Czy dostępnych jest 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

Modalności odpowiedzi

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.

TylkoTekstoweModalnościOdpowiedzi

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.

ZdarzenieDodaniaElementuWynikuOdpowiedzi

Emitowane po dodaniu nowego elementu wyjściowego.

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
element	OutputItem		Tak
indeks_wyjściowy	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

ZdarzenieUkończeniaElementuWynikuOdpowiedzi

Emitowane, gdy element wyjściowy jest oznaczony jako zakończony.

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
element	OutputItem		Tak
indeks_wyjściowy	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	Wartość domyślna
instrukcje	ciąg	Wstawia komunikat systemu (lub dewelopera) jako pierwszy element w kontekście modelu. Podczas używania previous_response_id, instrukcje z poprzedniej odpowiedzi nie zostaną przeniesione do następnej odpowiedzi. Ułatwia proste wymienianie komunikatów systemowych lub komunikatów od deweloperów w nowych odpowiedziach.	Nie.
max_output_tokens (maksymalna liczba tokenów wyjściowych)	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.	Nie.
previous_response_id (identyfikator_poprzedniej_odpowiedzi)	ciąg	Unikatowy identyfikator poprzedniej odpowiedzi na model. Użyj tego, aby utworzyć wielokrotne konwersacje.	Nie.
Rozumowanie	Rozumowanie	Tylko modele serii o Opcje konfiguracji dla modeli rozumowania.	Nie.
SMS	obiekt	Opcje konfiguracji generowania odpowiedzi tekstowej przez model. Może to być zwykły tekst lub dane JSON ze strukturą. Więcej informacji: - wprowadzanie tekstu i dane wyjściowe - Ustrukturyzowane wyniki	Nie.
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 będzie zgodny z podanym schematem JSON. Domyślny format to { "type": "text" } bez żadnych dodatkowych opcji. Niezalecane w przypadku modeli gpt-4o i nowszych: Włączenie trybu { "type": "json_object" } aktywuje starszy tryb 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ą.	Nie.
wybór narzędzia	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.	Nie.
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 modelowi podać, to: - Wbudowane narzędzia	Nie.
Obcięcie	wyliczenie	Strategia obcinania, która ma być użyta 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	Nie.

ZdarzenieZmianyOdmowyOdpowiedzi

Emitowane w przypadku częściowego tekstu odmowy.

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
indeks_treści	liczba całkowita	Indeks części zawartości, do którego jest dodawany tekst odmowy.	Tak
delta	ciąg	Tekst odmowy, który został dodany.	Tak
Identyfikator przedmiotu	ciąg	Identyfikator elementu wyjściowego, do którego jest dodawany tekst odmowy.	Tak
indeks_wyjściowy	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

ZdarzenieZakończeniaOdmowyOdpowiedzi

Emitowane, gdy tekst odmowy jest sfinalizowany.

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
indeks_treści	liczba całkowita	Indeks części treści, w której tekst odmowy jest sfinalizowany.	Tak
Identyfikator przedmiotu	ciąg	Identyfikator elementu wyjściowego, dla którego tekst odmowy jest finalizowany.	Tak
indeks_wyjściowy	liczba całkowita	Indeks elementu wyjściowego, w którym tekst odmowy został sfinalizowany.	Tak
odmowa	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	Wartość domyślna
adnotacja	adnotacji		Tak
indeks_annotacji	liczba całkowita	Indeks dodanej adnotacji.	Tak
Argumenty	ciąg	Argumenty wywołania funkcji.	Tak
kod	ciąg	Kod błędu.	Tak
wywołanie interpretera kodu	CodeInterpreterToolCall	Wywołanie narzędzia w celu uruchomienia kodu.	Tak
indeks_treści	liczba całkowita	Indeks części zawartości, w której treść tekstowa jest sfinalizowana.	Tak
delta	ciąg	Dodano zmianę tekstu.	Tak
element	OutputItem	Element wyjściowy, który został oznaczony jako wykonany.	Tak
Identyfikator przedmiotu	ciąg	Identyfikator elementu wyjściowego, którego zawartość tekstowa jest finalizowana.	Tak
komunikat	ciąg	Komunikat o błędzie.	Tak
indeks_wyjściowy	liczba całkowita	Indeks elementu wyjściowego, którego treść tekstowa jest sfinalizowana.	Tak
Param	ciąg	Parametr błędu.	Tak
część	OutputContent	Część zawartości, która jest wykonywana.	Tak
odmowa	ciąg	Tekst odmowy, który jest sfinalizowany.	Tak
odpowiedź	odpowiedź	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	Wartość domyślna
adnotacja	adnotacji		Tak
indeks_annotacji	liczba całkowita	Indeks dodanej adnotacji.	Tak
indeks_treści	liczba całkowita	Indeks części zawartości, do którego dodano adnotację tekstową.	Tak
Identyfikator przedmiotu	ciąg	Identyfikator elementu wyjściowego, do którego dodano adnotację tekstową.	Tak
indeks_wyjściowy	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 zmiany tekstu.

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
indeks_treści	liczba całkowita	Indeks części zawartości, do której dodano zmianę tekstową.	Tak
delta	ciąg	Dodano zmianę tekstu.	Tak
Identyfikator przedmiotu	ciąg	Identyfikator elementu wyjściowego, do którego dodano różnicę tekstu.	Tak
indeks_wyjściowy	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

WydarzenieZakończeniaTekstuOdpowiedzi (ResponseTextDoneEvent)

Emitowane po sfinalizowaniu zawartości tekstowej.

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
indeks_treści	liczba całkowita	Indeks części zawartości, w której treść tekstowa jest sfinalizowana.	Tak
Identyfikator przedmiotu	ciąg	Identyfikator elementu wyjściowego, którego zawartość tekstowa jest finalizowana.	Tak
indeks_wyjściowy	liczba całkowita	Indeks elementu wyjściowego, którego treść tekstowa jest sfinalizowana.	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

Zastosowanie Odpowiedzi

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	Wartość domyślna
input_tokens	liczba całkowita	Liczba tokenów wejściowych.	Tak
tokeny_wyjsciowe	liczba całkowita	Liczba tokenów wyjściowych.	Tak
szczegóły_tokenów_wyjściowych	obiekt	Szczegółowy podział tokenów wyjściowych.	Tak
└─ tokeny_rozumowania	liczba całkowita	Liczba tokenów rozumowania.	Nie.
suma_znaczniki	liczba całkowita	Całkowita liczba użytych tokenów.	Tak

Zrzut ekranu

Akcja zrzutu ekranu.

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
typ	wyliczenie	Określa typ zdarzenia. W przypadku akcji zrzutu ekranu ta właściwość jest zawsze ustawiona na screenshot. Możliwe wartości: screenshot	Tak

Przewijać

Akcja przewijania.

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
przewijanie_x (scroll_x)	liczba całkowita	Odległość przewijania poziomego.	Tak
przewijanie_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 scroll. 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

Konfiguracja Zatrzymania

Maksymalnie 4 sekwencje, w których interfejs API przestanie 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:

KonfiguracjaFormatuOdpowiedziTekstowej

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 będzie zgodny z podanym schematem JSON.

Domyślny format to { "type": "text" } bez żadnych dodatkowych opcji.

Niezalecane w przypadku modeli gpt-4o i nowszych:

Włączenie trybu { "type": "json_object" } aktywuje starszy tryb 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

FormatOdpowiedziTekstowejJsonSchema

Format odpowiedzi schematu JSON. Służy do generowania ustrukturyzowanych odpowiedzi JSON. Dowiedz się więcej o strukturach danych wyjściowych.

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
opis	ciąg	Opis celu formatu odpowiedzi, który jest używany przez model do określenia, jak odpowiedzieć w tym formacie.	Nie.
nazwa	ciąg	Nazwa formatu odpowiedzi. Musi składać się z a-z, A-Z, 0-9 lub zawierać podkreślniki i kreski, z maksymalną długością 64 znaków.	Nie.
schemat	ResponseFormatJsonSchemaSchema	Schemat formatu odpowiedzi, opisany jako obiekt schematu JSON.	Tak
surowy	typ logiczny (boolowski)	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.	Nie.	Nieprawda
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

Funkcja wyboru narzędzia

Użyj tej opcji, aby wymusić wywołanie określonej funkcji przez model.

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
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

Opcje wyboru narzędzi

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.

Majątek	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.
Typ	ciąg
Wartości	none auto required

RodzajeWyboruNarzędzi

Wskazuje, że model powinien używać wbudowanego narzędzia do generowania odpowiedzi.

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
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	Wartość domyślna
SMS	ciąg	Tekst do wpisania.	Tak
typ	wyliczenie	Określa typ zdarzenia. Dla akcji typu, ten atrybut jest zawsze ustawiony na type. Możliwe wartości: type	Tak

Prośba o aktualizację atrybutów plików w VectorStore

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
" is not needed as the current translation is already satisfactory.)	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 logiczne lub liczby.	Tak

Adres URLCitation

Cytat dotyczący zasobu internetowego używanego do generowania odpowiedzi modelu.

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
koniec_indeksu	liczba całkowita	Indeks ostatniego znaku cytatu adresu URL w komunikacie.	Tak
indeks_startowy	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
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 logiczne lub liczby.

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

VectorStoreFileContentResponse

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

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
dane	macierz	Przeanalizowana zawartość pliku.	Tak
zawiera_więcej	typ logiczny (boolowski)	Wskazuje, czy do pobrania jest więcej stron zawartości.	Tak
następna_strona	ciąg	Znacznik 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

Żądanie wyszukiwania VectorStore

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
filtry	Filtr porównawczy lub filtr złożony	Filtr do zastosowania na podstawie atrybutów pliku.	Nie.
maks_liczba_wyników	liczba całkowita	Maksymalna liczba wyników do zwrócenia. Ta liczba powinna należeć do zakresu od 1 do 50 włącznie.	Nie.	10
kwerenda	ciąg lub tablica	Ciąg zapytania dla wyszukiwania	Tak
opcje rankingu	obiekt	Opcje klasyfikacji wyszukiwania.	Nie.
└─ ranker	wyliczenie	Możliwe wartości: auto, default-2024-11-15	Nie.
└─ próg_punktowy	Liczba		Nie.	0
przepisz_zapytanie	typ logiczny (boolowski)	Określa, czy należy ponownie napisać zapytanie języka naturalnego na potrzeby wyszukiwania wektorów.	Nie.	Nieprawda

ObiektZawartościWynikówWyszukiwaniaMagazynuWektora

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
SMS	ciąg	Zawartość tekstowa z wyników wyszukiwania.	Tak
typ	wyliczenie	Typ zawartości. Możliwe wartości: text	Tak

ElementWynikuWyszukiwaniaSklepuWektorowego

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
" is not needed as the current translation is already satisfactory.)	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 logiczne lub liczby.	Tak
zawartość	macierz	Fragmenty zawartości z pliku.	Tak
identyfikator_pliku	ciąg	Identyfikator pliku magazynu wektorów.	Tak
nazwa pliku	ciąg	Nazwa pliku przechowującego wektory.	Tak
wynik	Liczba	Wynik oceny podobieństwa.	Tak

StronaWynikówWyszukiwaniaVectorStore

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
dane	macierz	Lista elementów wyników wyszukiwania.	Tak
zawiera_więcej	typ logiczny (boolowski)	Wskazuje, czy istnieje więcej wyników do pobrania.	Tak
następna_strona	ciąg	Znacznik 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
zapytanie wyszukiwania	macierz		Tak

VoiceIdsShared

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

Czekać

Akcja oczekiwania.

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
typ	wyliczenie	Określa typ zdarzenia. W przypadku akcji oczekiwania ta właściwość jest zawsze ustawiona na wait. Możliwe wartości: wait	Tak

RozumowanieWysiłek

Tylko modele serii o

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.

Majątek	Wartość
Opis	Tylko modele serii o 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.
Typ	ciąg
Wartość domyślna	nośnik
Wartości	low medium high

wydarzenie błędu

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	Wartość domyślna
dane	błąd		Tak
wydarzenie	ciąg		Tak

event Enum: ErrorEventEnum

Wartość	Opis
błąd

zakończoneZdarzenie

Występuje po zakończeniu strumienia.

Nazwa	Typ	Opis	Wymagane	Wartość domyślna
dane	ciąg		Tak
wydarzenie	ciąg		Tak

event Enum: DoneEventEnum

Wartość	Opis
Gotowe

data Enum: DoneEventDataEnum

Wartość	Opis
[GOTOWE]

Dalsze 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.